Adding option to encode variables for JSON #303

Author: tomasbjerre

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 Changelog of Pull Request Notifier for Bitbucket.
 
+## Unreleased
+### GitHub [#303](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/issues/303) Post content encoding issue for single quote 
+  Adding option to encode variables for JSON
+  
+  [1f22177444553b7](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/commit/1f22177444553b7) Tomas Bjerre *2018-09-28 14:49:20*
+
+### No issue
+  Updating fmt-plugin
+  
+  [d8a31bd9402b106](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/commit/d8a31bd9402b106) Tomas Bjerre *2018-08-31 07:02:13*
+
 ## 3.22
 ### GitHub [#229](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/issues/229) PULL_REQUEST_{TO,FROM}_{HTTP,SSH}_CLONE_URL variables contains username
   Only stripping username from HTTP clone URL

build.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
 npm install
 grunt
+#atlas-mvn versions:update-properties
 atlas-mvn package verify

export_and_run.sh

@@ -1,2 +1,3 @@
 export MAVEN_OPTS=-Dplugin.resource.directories=`pwd`/src/main/resources
+#atlas-mvn versions:update-properties
 atlas-run || mvn bitbucket:run

pom.xml

@@ -141,7 +141,7 @@
    <plugin>
     <groupId>se.bjurr.gitchangelog</groupId>
     <artifactId>git-changelog-maven-plugin</artifactId>
-    <version>1.52</version>
+    <version>${changelog.version}</version>
     <executions>
      <execution>
       <id>GenerateGitChangelog</id>
@@ -243,7 +243,7 @@ Changelog of Pull Request Notifier for Bitbucket.
    <plugin>
     <groupId>com.coveo</groupId>
     <artifactId>fmt-maven-plugin</artifactId>
-    <version>2.5.1</version>
+    <version>${fmt.version}</version>
     <executions>
      <execution>
       <goals>
@@ -273,7 +273,7 @@ Changelog of Pull Request Notifier for Bitbucket.
    <plugin>
     <groupId>se.bjurr.violations</groupId>
     <artifactId>violations-maven-plugin</artifactId>
-    <version>1.3</version>
+    <version>${violations.version}</version>
     <configuration>
      <maxViolations>99999999</maxViolations>
      <minSeverity>INFO</minSeverity>
@@ -327,9 +327,12 @@ Changelog of Pull Request Notifier for Bitbucket.
  </profiles>
 
  <properties>
+  <changelog.version>1.54</changelog.version>
+  <fmt.version>2.5.1</fmt.version>
+  <violations.version>1.13</violations.version>
   <bitbucket.version>5.13.1</bitbucket.version>
   <bitbucket.data.version>${bitbucket.version}</bitbucket.data.version>
   <quick.reload.version>2.0.0</quick.reload.version>
   <amps.version>6.3.6</amps.version>
  </properties>
-</project>
+</project>

release.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+#atlas-mvn versions:update-properties
+atlas-mvn release:prepare release:perform -B || exit 1
+./build.sh
+git commit -a --amend --no-edit
+git push -f

src/main/java/se/bjurr/prnfb/service/JsonEscaper.java

@@ -0,0 +1,62 @@
+package se.bjurr.prnfb.service;
+
+import java.io.StringWriter;
+
+/** Copied from GSON JsonWriter */
+public class JsonEscaper {
+
+  private static final String[] REPLACEMENT_CHARS;
+  private static final String[] HTML_SAFE_REPLACEMENT_CHARS;
+
+  static {
+    REPLACEMENT_CHARS = new String[128];
+    for (int i = 0; i <= 0x1f; i++) {
+      REPLACEMENT_CHARS[i] = String.format("\\u%04x", (int) i);
+    }
+    REPLACEMENT_CHARS['"'] = "\\\"";
+    REPLACEMENT_CHARS['\\'] = "\\\\";
+    REPLACEMENT_CHARS['\t'] = "\\t";
+    REPLACEMENT_CHARS['\b'] = "\\b";
+    REPLACEMENT_CHARS['\n'] = "\\n";
+    REPLACEMENT_CHARS['\r'] = "\\r";
+    REPLACEMENT_CHARS['\f'] = "\\f";
+    HTML_SAFE_REPLACEMENT_CHARS = REPLACEMENT_CHARS.clone();
+    HTML_SAFE_REPLACEMENT_CHARS['<'] = "\\u003c";
+    HTML_SAFE_REPLACEMENT_CHARS['>'] = "\\u003e";
+    HTML_SAFE_REPLACEMENT_CHARS['&'] = "\\u0026";
+    HTML_SAFE_REPLACEMENT_CHARS['='] = "\\u003d";
+    HTML_SAFE_REPLACEMENT_CHARS['\''] = "\\u0027";
+  }
+
+  public static String jsonEscape(String value) {
+    final StringWriter out = new StringWriter();
+    String[] replacements = HTML_SAFE_REPLACEMENT_CHARS;
+    int last = 0;
+    int length = value.length();
+    for (int i = 0; i < length; i++) {
+      char c = value.charAt(i);
+      String replacement;
+      if (c < 128) {
+        replacement = replacements[c];
+        if (replacement == null) {
+          continue;
+        }
+      } else if (c == '\u2028') {
+        replacement = "\\u2028";
+      } else if (c == '\u2029') {
+        replacement = "\\u2029";
+      } else {
+        continue;
+      }
+      if (last < i) {
+        out.write(value, last, i - last);
+      }
+      out.write(replacement);
+      last = i + 1;
+    }
+    if (last < length) {
+      out.write(value, last, length - last);
+    }
+    return out.toString();
+  }
+}

src/main/java/se/bjurr/prnfb/service/PrnfbRenderer.java

@@ -5,7 +5,9 @@
 import static com.google.common.base.Throwables.propagate;
 import static java.net.URLEncoder.encode;
 import static org.slf4j.LoggerFactory.getLogger;
+import static se.bjurr.prnfb.service.JsonEscaper.jsonEscape;
 import static se.bjurr.prnfb.service.PrnfbRenderer.ENCODE_FOR.HTML;
+import static se.bjurr.prnfb.service.PrnfbRenderer.ENCODE_FOR.JSON;
 import static se.bjurr.prnfb.service.PrnfbRenderer.ENCODE_FOR.URL;
 import static se.bjurr.prnfb.service.PrnfbVariable.EVERYTHING_URL;
 
@@ -29,7 +31,8 @@ public class PrnfbRenderer {
   public enum ENCODE_FOR {
     NONE,
     URL,
-    HTML
+    HTML,
+    JSON
   }
 
   private static final Logger LOG = getLogger(PrnfbRenderer.class);
@@ -85,6 +88,8 @@ String getRenderedStringResolved(
       }
     } else if (encodeFor == HTML) {
       replaceWith = StringEscapeUtils.escapeHtml4(resolved).replaceAll("(\r\n|\n)", "<br />");
+    } else if (encodeFor == JSON) {
+      replaceWith = jsonEscape(resolved);
     } else {
       replaceWith = resolved;
     }

src/main/resources/admin.vm

@@ -619,6 +619,11 @@
       <input class="radio" type="radio" name="postContentEncoding" value="HTML"> Encode as HTML
      </label>
     </div>
+    <div class="radio">
+     <label>
+      <input class="radio" type="radio" name="postContentEncoding" value="JSON"> Encode as JSON
+     </label>
+    </div>
    </fieldset>
 
    <h4>Headers</h4>

src/main/resources/pr-triggerbutton.js

@@ -295,8 +295,8 @@ define('plugin/prnfb/pr-triggerbutton', [
  });
 });
 
-require(['bitbucket/util/events'], function(events) { 
+require(['bitbucket/util/events'], function(events) {
  events.on('bitbucket.internal.feature.repositories.recent.loaded', function() {
   require('plugin/prnfb/pr-triggerbutton');
- })
+ });
 });

src/test/java/se/bjurr/prnfb/service/JsonEscaperTest.java

@@ -0,0 +1,14 @@
+package se.bjurr.prnfb.service;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.Test;
+
+public class JsonEscaperTest {
+
+  @Test
+  public void testThatStringCanBeEscaped() {
+    assertThat(JsonEscaper.jsonEscape("some'string")) //
+        .isEqualTo("some\\u0027string");
+  }
+}