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