XmppUri.java

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