bug fix: improve quality of URL encoder / sanitizer

with unit tests that illustrate the difficulty, which is a direct result of poor library support in Java
warren-bank · Dec 9, 2022 · a2ecd17 · a2ecd17
1 parent decb1be
commit a2ecd17
Show file tree

Hide file tree

Showing 62 changed files with 5,701 additions and 44 deletions.
diff --git a/...c/main/java/com/github/warren_bank/exoplayer_airplay_receiver/exoplayer2/VideoSource.java b/...c/main/java/com/github/warren_bank/exoplayer_airplay_receiver/exoplayer2/VideoSource.java
@@ -2,7 +2,7 @@
 
 import com.github.warren_bank.exoplayer_airplay_receiver.utils.ExternalStorageUtils;
 import com.github.warren_bank.exoplayer_airplay_receiver.utils.MediaTypeUtils;
-import com.github.warren_bank.exoplayer_airplay_receiver.utils.StringUtils;
+import com.github.warren_bank.exoplayer_airplay_receiver.utils.UriUtils;
 
 import com.google.android.exoplayer2.C;
 import com.google.android.exoplayer2.MediaItem;
@@ -82,11 +82,11 @@ private VideoSource(
   ) {
     // enforce that URLs are encoded and RFC 2396-compliant
     if (!TextUtils.isEmpty(uri))
-      uri = StringUtils.encodeURL(uri);
+      uri = UriUtils.encodeURI(uri);
     if (!TextUtils.isEmpty(caption))
-      caption = StringUtils.encodeURL(caption);
+      caption = UriUtils.encodeURI(caption);
     if (!TextUtils.isEmpty(referer))
-      referer = StringUtils.encodeURL(referer);
+      referer = UriUtils.encodeURI(referer);
 
     if (uri == null)
       uri = "";

diff --git a/...ank/exoplayer_airplay_receiver/service/playlist_extractors/HttpBasePlaylistExtractor.java b/...ank/exoplayer_airplay_receiver/service/playlist_extractors/HttpBasePlaylistExtractor.java
@@ -1,6 +1,6 @@
 package com.github.warren_bank.exoplayer_airplay_receiver.service.playlist_extractors;
 
-import com.github.warren_bank.exoplayer_airplay_receiver.utils.StringUtils;
+import com.github.warren_bank.exoplayer_airplay_receiver.utils.UrlUtils;
 
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
@@ -29,11 +29,11 @@ protected String resolveM3uPlaylistItem(URL context, String relative) {
 
     uri = resolveM3uPlaylistItem(
       ((context != null) ? context.toString() : ""),
-      StringUtils.decodeURL(relative)
+      UrlUtils.decodeURL(relative)
     );
 
     if (uri != null)
-      uri = StringUtils.encodeURL(uri);
+      uri = UrlUtils.encodeURL(uri);
 
     return uri;
   }
@@ -84,7 +84,7 @@ protected ArrayList<String> expandPlaylist(String strUrl, Charset cs) {
       in = new BufferedReader(new InputStreamReader(url.openStream(), cs));
 
       // remove ascii encoding
-      url = new URL(StringUtils.decodeURL(strUrl));
+      url = new URL(UrlUtils.decodeURL(strUrl));
 
       preParse(url);
       while ((line = in.readLine()) != null) {

diff --git a/...er/src/main/java/com/github/warren_bank/exoplayer_airplay_receiver/utils/StringUtils.java b/...er/src/main/java/com/github/warren_bank/exoplayer_airplay_receiver/utils/StringUtils.java
@@ -5,9 +5,6 @@
 import android.os.Bundle;
 import android.text.TextUtils;
 
-import java.net.URI;
-import java.net.URL;
-import java.net.URLDecoder;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -141,37 +138,6 @@ public static String convertEscapedLinefeeds(String requestBody) {
     return requestBody.replaceAll("\\\\n", "\n");
   }
 
-  public static String decodeURL(String strUrl) {
-    try {
-      return URLDecoder.decode(strUrl, "UTF-8");
-    }
-    catch(Exception e) {
-      return strUrl;
-    }
-  }
-
-  public static String encodeURL(String strUrl) {
-    try {
-      URL url = new URL(StringUtils.decodeURL(strUrl));
-
-      return StringUtils.encodeURL(url);
-    }
-    catch(Exception e) {
-      return strUrl;
-    }
-  }
-
-  public static String encodeURL(URL url) {
-    try {
-      URI uri = new URI(url.getProtocol(), url.getUserInfo(), url.getHost(), url.getPort(), url.getPath(), url.getQuery(), url.getRef());
-
-      return uri.toASCIIString();
-    }
-    catch(Exception e) {
-      return url.toExternalForm();
-    }
-  }
-
   public static String serializeURLs(ArrayList<String> list) {
     return StringUtils.convertArrayListToString(list, Constant.Delimiter.PLAYLIST_URLS);
   }

diff --git a/...eiver/src/main/java/com/github/warren_bank/exoplayer_airplay_receiver/utils/UriUtils.java b/...eiver/src/main/java/com/github/warren_bank/exoplayer_airplay_receiver/utils/UriUtils.java
@@ -1,12 +1,85 @@
 package com.github.warren_bank.exoplayer_airplay_receiver.utils;
 
+import android.net.Uri;
+
 import java.net.URI;
 
 public class UriUtils {
 
-  public static URI parseURI(String strUrl) {
+  public static String encodeURI(String strUri) {
     try {
-      return new URI(StringUtils.encodeURL(strUrl));
+      if ((strUri == null) || strUri.isEmpty())
+        throw new Exception("uri is empty");
+
+      StringBuilder builder = new StringBuilder();
+      Uri uri = Uri.parse(strUri);
+      String sVal;
+      int iVal;
+
+      sVal = uri.getScheme();
+      if (sVal == null)
+        throw new Exception("protocol is required");
+      builder.append(sVal);
+      builder.append("://");
+
+      sVal = uri.getEncodedUserInfo();
+      if (sVal != null) {
+        sVal = Uri.encode(sVal, "%:");
+        builder.append(sVal);
+        builder.append("@");
+      }
+
+      sVal = uri.getHost();
+      if (sVal == null)
+        throw new Exception("hostname is required");
+      builder.append(sVal);
+
+      iVal = uri.getPort();
+      if (iVal > 0) {
+        builder.append(":");
+        builder.append(iVal);
+      }
+
+      sVal = uri.getEncodedPath();
+      if (sVal == null)
+        throw new Exception("path is required");
+      sVal = Uri.encode(sVal, "%/");
+      builder.append(sVal);
+
+      sVal = uri.getEncodedQuery();
+      if (sVal != null) {
+        sVal = Uri.encode(sVal, "%=&[]");
+        builder.append("?");
+        builder.append(sVal);
+      }
+
+      sVal = uri.getEncodedFragment();
+      if (sVal != null) {
+        sVal = Uri.encode(sVal, "%/");
+        builder.append("#");
+        builder.append(sVal);
+      }
+
+      strUri = builder.toString();
+
+      if (strUri.isEmpty())
+        throw new Exception("uri is empty");
+
+      return strUri;
+    }
+    catch(Exception e) {
+      return null;
+    }
+  }
+
+  public static URI parseURI(String strUri) {
+    try {
+      strUri = UriUtils.encodeURI(strUri);
+
+      if (strUri == null)
+        throw new Exception("uri is empty");
+
+      return new URI(strUri);
     }
     catch(Exception e) {
       return null;

diff --git a/...eiver/src/main/java/com/github/warren_bank/exoplayer_airplay_receiver/utils/UrlUtils.java b/...eiver/src/main/java/com/github/warren_bank/exoplayer_airplay_receiver/utils/UrlUtils.java
@@ -0,0 +1,40 @@
+package com.github.warren_bank.exoplayer_airplay_receiver.utils;
+
+import java.net.URI;
+import java.net.URL;
+import java.net.URLDecoder;
+
+public class UrlUtils {
+
+  public static String decodeURL(String strUrl) {
+    try {
+      return URLDecoder.decode(strUrl, "UTF-8");
+    }
+    catch(Exception e) {
+      return strUrl;
+    }
+  }
+
+  public static String encodeURL(String strUrl) {
+    try {
+      URL url = new URL(strUrl);
+
+      return UrlUtils.encodeURL(url);
+    }
+    catch(Exception e) {
+      return strUrl;
+    }
+  }
+
+  public static String encodeURL(URL url) {
+    try {
+      URI uri = new URI(url.getProtocol(), url.getUserInfo(), url.getHost(), url.getPort(), url.getPath(), url.getQuery(), url.getRef());
+
+      return uri.toASCIIString();
+    }
+    catch(Exception e) {
+      return url.toExternalForm();
+    }
+  }
+
+}
diff --git a/tests/01.sh → ... - curl sender - examples in README/01.sh b/tests/01.sh → ... - curl sender - examples in README/01.sh
diff --git a/tests/02. AirPlay sender.es5.html → ...tml - SPA senders/airplay_sender.es5.html b/tests/02. AirPlay sender.es5.html → ...tml - SPA senders/airplay_sender.es5.html
diff --git a/tests/02. AirPlay sender.html → ...2. html - SPA senders/airplay_sender.html b/tests/02. AirPlay sender.html → ...2. html - SPA senders/airplay_sender.html
diff --git a/... sender - to receiver on same device.html → ..._playlist_to_receiver_on_same_device.html b/... sender - to receiver on same device.html → ..._playlist_to_receiver_on_same_device.html
diff --git a/tests/03. unit tests/.gitignore b/tests/03. unit tests/.gitignore
@@ -0,0 +1,4 @@
+!**/bin
+!**/lib
+!**/src
+!**/out
diff --git a/tests/03. unit tests/01. URL encoder/bin/0-env.bat b/tests/03. unit tests/01. URL encoder/bin/0-env.bat
@@ -0,0 +1,5 @@
+@echo off
+
+set JDK_HOME=C:\Android\android-studio-2021.3.1.17\jre
+set JRE_HOME=%JDK_HOME%\jre
+set PATH=%JRE_HOME%\bin;%JDK_HOME%\bin;%PATH%
diff --git a/tests/03. unit tests/01. URL encoder/bin/1-compile.bat b/tests/03. unit tests/01. URL encoder/bin/1-compile.bat
@@ -0,0 +1,21 @@
+@echo off
+
+call "%~dp0.\0-env.bat"
+
+set output_dir=%~dp0..\out\%~n0
+
+set options=
+set options=%options% --source-path "%~dp0..\lib"
+set options=%options% -d "%output_dir%"
+set options=%options% -encoding "UTF-8"
+set options=%options% -g:none
+
+set sourcefile="%~dp0..\src\Main.java"
+
+if exist "%output_dir%" rmdir /Q /S "%output_dir%"
+mkdir "%output_dir%"
+
+javac %options% %sourcefile%
+
+echo.
+pause
diff --git a/tests/03. unit tests/01. URL encoder/bin/2-run.bat b/tests/03. unit tests/01. URL encoder/bin/2-run.bat
@@ -0,0 +1,17 @@
+@echo off
+
+call "%~dp0.\0-env.bat"
+
+set output_dir=%~dp0..\out\%~n0
+set stdout_file="%output_dir%\stdout.txt"
+set stderr_file="%output_dir%\stderr.txt"
+
+set options=
+set options=%options% --class-path "%output_dir%\..\1-compile"
+
+set mainclass="Main"
+
+if exist "%output_dir%" rmdir /Q /S "%output_dir%"
+mkdir "%output_dir%"
+
+java %options% %mainclass% 1>%stdout_file% 2>%stderr_file%