Merge pull request #2072 from shadowsocks/plugin-1.1.0

Plugin library 1.1.0
shadowsocks · Jan 15, 2019 · 56121d5 · 56121d5
2 parents e641625 + 9f037d2
commit 56121d5
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 4 deletions.
diff --git a/mobile/src/main/java/com/github/shadowsocks/ProfileConfigFragment.kt b/mobile/src/main/java/com/github/shadowsocks/ProfileConfigFragment.kt
@@ -149,7 +149,7 @@ class ProfileConfigFragment : PreferenceFragmentCompat(),
         DataStore.plugin = pluginConfiguration.toString()
         DataStore.dirty = true
         true
-    } catch (exc: IllegalArgumentException) {
+    } catch (exc: RuntimeException) {
         (activity as MainActivity).snackbar(exc.localizedMessage).show()
         false
     }

diff --git a/mobile/src/main/res/xml/pref_profile.xml b/mobile/src/main/res/xml/pref_profile.xml
@@ -84,6 +84,7 @@
                 android:key="plugin.configure"
                 android:icon="@drawable/ic_action_settings"
                 android:persistent="false"
+                android:singleLine="true"
                 app:pref_summaryHasText="%s"
                 android:title="@string/plugin_configure"/>
         <Preference

diff --git a/plugin/CHANGES.md b/plugin/CHANGES.md
@@ -1,3 +1,7 @@
+* 1.1.0:
+  * Having control characters in plugin options is no longer allowed.
+    If this breaks your plugin, you are doing it wrong.
+  * New helper method: `PluginOptions.putWithDefault`.
 * 1.0.0:
   * BREAKING CHANGE: Plugins developed using this version and forward require shadowsocks-android 4.6.5 or higher.
   * `PathProvider` now takes `Int` instead of `String` for file modes;

diff --git a/plugin/build.gradle b/plugin/build.gradle
@@ -10,8 +10,8 @@ android {
     defaultConfig {
         minSdkVersion rootProject.minSdkVersion
         targetSdkVersion rootProject.sdkVersion
-        versionCode 7
-        versionName "1.0.0"
+        versionCode 8
+        versionName "1.1.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }

diff --git a/plugin/src/main/java/com/github/shadowsocks/plugin/PluginOptions.kt b/plugin/src/main/java/com/github/shadowsocks/plugin/PluginOptions.kt
@@ -38,6 +38,7 @@ class PluginOptions : HashMap<String, String?> {
         @Suppress("NAME_SHADOWING")
         var parseId = parseId
         if (options.isNullOrEmpty()) return
+        check(options.all { !it.isISOControl() }) { "No control characters allowed." }
         val tokenizer = StringTokenizer("$options;", "\\=;", true)
         val current = StringBuilder()
         var key: String? = null
@@ -68,6 +69,14 @@ class PluginOptions : HashMap<String, String?> {
         this.id = id
     }
 
+    /**
+     * Put but if value is null or default, the entry is deleted.
+     *
+     * @return Old value before put.
+     */
+    fun putWithDefault(key: String, value: String?, default: String? = null) =
+            if (value == null || value == default) remove(key) else put(key, value)
+
     private fun append(result: StringBuilder, str: String) = (0 until str.length)
             .map { str[it] }
             .forEach {

diff --git a/plugin/src/test/java/com/github/shadowsocks/plugin/PluginOptionsTest.kt b/plugin/src/test/java/com/github/shadowsocks/plugin/PluginOptionsTest.kt
@@ -25,7 +25,7 @@ import org.junit.Test
 
 class PluginOptionsTest {
     @Test
-    fun equal() {
+    fun basic() {
         val o1 = PluginOptions("obfs-local;obfs=http;obfs-host=localhost")
         val o2 = PluginOptions("obfs-local", "obfs-host=localhost;obfs=http")
         Assert.assertEquals(o1.hashCode(), o2.hashCode())
@@ -35,4 +35,19 @@ class PluginOptionsTest {
         val o4 = PluginOptions(o2.id, o2.toString())
         Assert.assertEquals(true, o3 == o4)
     }
+
+    @Test
+    fun escape() {
+        val options = PluginOptions("escapeTest")
+        options["subject"] = "value;semicolon"
+        Assert.assertEquals(true, options == PluginOptions(options.toString(false)))
+        options["key;semicolon"] = "object"
+        Assert.assertEquals(true, options == PluginOptions(options.toString(false)))
+        options["subject"] = "value=equals"
+        Assert.assertEquals(true, options == PluginOptions(options.toString(false)))
+        options["key=equals"] = "object"
+        Assert.assertEquals(true, options == PluginOptions(options.toString(false)))
+        options["advanced\\=;test"] = "in;=\\progress"
+        Assert.assertEquals(true, options == PluginOptions(options.toString(false)))
+    }
 }