XmppUri.java

  1package eu.siacs.conversations.utils;
  2
  3import android.net.Uri;
  4
  5import androidx.annotation.NonNull;
  6
  7import com.google.common.base.CharMatcher;
  8import com.google.common.collect.Collections2;
  9import com.google.common.collect.ImmutableList;
 10import com.google.common.collect.ImmutableMap;
 11
 12import java.io.UnsupportedEncodingException;
 13import java.net.URLDecoder;
 14import java.util.ArrayList;
 15import java.util.Arrays;
 16import java.util.Collections;
 17import java.util.List;
 18import java.util.Locale;
 19import java.util.Map;
 20
 21import eu.siacs.conversations.xmpp.Jid;
 22
 23public class XmppUri {
 24
 25    public static final String ACTION_JOIN = "join";
 26    public static final String ACTION_MESSAGE = "message";
 27    public static final String ACTION_REGISTER = "register";
 28    public static final String ACTION_ROSTER = "roster";
 29    public static final String PARAMETER_PRE_AUTH = "preauth";
 30    public static final String PARAMETER_IBR = "ibr";
 31    private static final String OMEMO_URI_PARAM = "omemo-sid-";
 32    protected Uri uri;
 33    protected String jid;
 34    private List<Fingerprint> fingerprints = new ArrayList<>();
 35    private Map<String, String> parameters = Collections.emptyMap();
 36    private boolean safeSource = true;
 37
 38    public static final String INVITE_DOMAIN = "conversations.im";
 39
 40    public XmppUri(final String uri) {
 41        try {
 42            parse(Uri.parse(uri));
 43        } catch (IllegalArgumentException e) {
 44            try {
 45                jid = Jid.ofEscaped(uri).asBareJid().toEscapedString();
 46            } catch (IllegalArgumentException e2) {
 47                jid = null;
 48            }
 49        }
 50    }
 51
 52    public XmppUri(Uri uri) {
 53        parse(uri);
 54    }
 55
 56    public XmppUri(Uri uri, boolean safeSource) {
 57        this.safeSource = safeSource;
 58        parse(uri);
 59    }
 60
 61    private static Map<String, String> parseParameters(final String query, final char seperator) {
 62        final ImmutableMap.Builder<String, String> builder = new ImmutableMap.Builder<>();
 63        final String[] pairs = query == null ? new String[0] : query.split(String.valueOf(seperator));
 64        for (String pair : pairs) {
 65            final String[] parts = pair.split("=", 2);
 66            if (parts.length == 0) {
 67                continue;
 68            }
 69            final String key = parts[0].toLowerCase(Locale.US);
 70            final String value;
 71            if (parts.length == 2) {
 72                String decoded;
 73                try {
 74                    decoded = URLDecoder.decode(parts[1], "UTF-8");
 75                } catch (UnsupportedEncodingException e) {
 76                    decoded = "";
 77                }
 78                value = decoded;
 79            } else {
 80                value = "";
 81            }
 82            builder.put(key, value);
 83        }
 84        return builder.build();
 85    }
 86
 87    private static List<Fingerprint> parseFingerprints(Map<String, String> parameters) {
 88        ImmutableList.Builder<Fingerprint> builder = new ImmutableList.Builder<>();
 89        for (Map.Entry<String, String> parameter : parameters.entrySet()) {
 90            final String key = parameter.getKey();
 91            final String value = parameter.getValue().toLowerCase(Locale.US);
 92            if (key.startsWith(OMEMO_URI_PARAM)) {
 93                try {
 94                    final int id = Integer.parseInt(key.substring(OMEMO_URI_PARAM.length()));
 95                    builder.add(new Fingerprint(FingerprintType.OMEMO, value, id));
 96                } catch (Exception e) {
 97                    //ignoring invalid device id
 98                }
 99            } else if ("omemo".equals(key)) {
100                builder.add(new Fingerprint(FingerprintType.OMEMO, value, 0));
101            }
102        }
103        return builder.build();
104    }
105
106    public static String getFingerprintUri(final String base, final List<XmppUri.Fingerprint> fingerprints, char separator) {
107        final StringBuilder builder = new StringBuilder(base);
108        builder.append('?');
109        for (int i = 0; i < fingerprints.size(); ++i) {
110            XmppUri.FingerprintType type = fingerprints.get(i).type;
111            if (type == XmppUri.FingerprintType.OMEMO) {
112                builder.append(XmppUri.OMEMO_URI_PARAM);
113                builder.append(fingerprints.get(i).deviceId);
114            }
115            builder.append('=');
116            builder.append(fingerprints.get(i).fingerprint);
117            if (i != fingerprints.size() - 1) {
118                builder.append(separator);
119            }
120        }
121        return builder.toString();
122    }
123
124    private static String lameUrlDecode(String url) {
125        return url.replace("%23", "#").replace("%25", "%");
126    }
127
128    public static String lameUrlEncode(String url) {
129        return url.replace("%", "%25").replace("#", "%23");
130    }
131
132    public boolean isSafeSource() {
133        return safeSource;
134    }
135
136    protected void parse(final Uri uri) {
137        if (uri == null) {
138            return;
139        }
140        this.uri = uri;
141        final String scheme = uri.getScheme();
142        final String host = uri.getHost();
143        List<String> segments = uri.getPathSegments();
144        if ("https".equalsIgnoreCase(scheme) && INVITE_DOMAIN.equalsIgnoreCase(host)) {
145            if (segments.size() >= 2 && segments.get(1).contains("@")) {
146                // sample : https://conversations.im/i/foo@bar.com
147                try {
148                    jid = Jid.ofEscaped(lameUrlDecode(segments.get(1))).toEscapedString();
149                } catch (Exception e) {
150                    jid = null;
151                }
152            } else if (segments.size() >= 3) {
153                // sample : https://conversations.im/i/foo/bar.com
154                jid = segments.get(1) + "@" + segments.get(2);
155            }
156            if (segments.size() > 1 && "j".equalsIgnoreCase(segments.get(0))) {
157                this.parameters = ImmutableMap.of(ACTION_JOIN, "");
158            }
159            final Map<String, String> parameters = parseParameters(uri.getQuery(), '&');
160            this.fingerprints = parseFingerprints(parameters);
161        } else if ("xmpp".equalsIgnoreCase(scheme)) {
162            // sample: xmpp:foo@bar.com
163            this.parameters = parseParameters(uri.getQuery(), ';');
164            if (uri.getAuthority() != null) {
165                jid = uri.getAuthority();
166            } else {
167                final String[] parts = uri.getSchemeSpecificPart().split("\\?");
168                if (parts.length > 0) {
169                    jid = parts[0];
170                } else {
171                    return;
172                }
173            }
174            this.fingerprints = parseFingerprints(parameters);
175        } else if ("imto".equalsIgnoreCase(scheme) && Arrays.asList("xmpp", "jabber").contains(uri.getHost())) {
176            // sample: imto://xmpp/foo@bar.com
177            try {
178                jid = URLDecoder.decode(uri.getEncodedPath(), "UTF-8").split("/")[1].trim();
179            } catch (final UnsupportedEncodingException ignored) {
180                jid = null;
181            }
182        } else {
183            jid = null;
184        }
185    }
186
187    @Override
188    @NonNull
189    public String toString() {
190        if (uri != null) {
191            return uri.toString();
192        }
193        return "";
194    }
195
196    public boolean isAction(final String action) {
197        return Collections2.transform(
198                parameters.keySet(),
199                s -> CharMatcher.inRange('a', 'z').or(CharMatcher.inRange('A', 'Z')).retainFrom(s)
200        ).contains(action);
201    }
202
203    public Jid getJid() {
204        try {
205            return this.jid == null ? null : Jid.ofEscaped(this.jid);
206        } catch (IllegalArgumentException e) {
207            return null;
208        }
209    }
210
211    public boolean isValidJid() {
212        if (jid == null) {
213            return false;
214        }
215        try {
216            Jid.ofEscaped(jid);
217            return true;
218        } catch (IllegalArgumentException e) {
219            return false;
220        }
221    }
222
223    public String getBody() {
224        return parameters.get("body");
225    }
226
227    public String getName() {
228        return parameters.get("name");
229    }
230
231    public String getParameter(String key) {
232        return this.parameters.get(key);
233    }
234
235    public String parameterString() {
236        final StringBuilder s = new StringBuilder();
237        for (Map.Entry<String, String> param : parameters.entrySet()) {
238            if (param.getValue() == null || param.getValue().isEmpty()) continue;
239
240            s.append(";");
241            s.append(param.getKey());
242            s.append("=");
243            s.append(param.getValue());
244        }
245        return s.toString();
246    }
247
248    public List<Fingerprint> getFingerprints() {
249        return this.fingerprints;
250    }
251
252    public boolean hasFingerprints() {
253        return fingerprints.size() > 0;
254    }
255
256    public enum FingerprintType {
257        OMEMO
258    }
259
260    public static class Fingerprint {
261        public final FingerprintType type;
262        public final String fingerprint;
263        final int deviceId;
264
265        public Fingerprint(FingerprintType type, String fingerprint, int deviceId) {
266            this.type = type;
267            this.fingerprint = fingerprint;
268            this.deviceId = deviceId;
269        }
270
271        @NonNull
272        @Override
273        public String toString() {
274            return type.toString() + ": " + fingerprint + (deviceId != 0 ? " " + deviceId : "");
275        }
276    }
277}