Build 18.x-2.4.6

changelog.txt

@@ -1,3 +1,8 @@
+Version 18.x-2.4.6
+-------------
+* Added developer documentation and Dockerfile #331
+* Fix lots of XSS due to missing escaping of HTML entities (CVE-2018-8831), thanks @pkerling #340
+
 Version 18.x-2.4.5
 -------------
 * Fixed issue with unable to view album page in Kodi Leia (v18) #327

dist/addon.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <addon
   id="webinterface.default"
-  version="18.x-2.4.5"
+  version="18.x-2.4.6"
   name="Kodi web interface - Chorus2"
   provider-name="jez500, Team Kodi">
   <requires>

dist/lang/en/app-changelog.html

@@ -1,3 +1,8 @@
+<h2 id="version-18-x-2-4-6">Version 18.x-2.4.6</h2>
+<ul>
+<li>Added developer documentation and Dockerfile #331</li>
+<li>Fix lots of XSS due to missing escaping of HTML entities (CVE-2018-8831), thanks @pkerling #340</li>
+</ul>
 <h2 id="version-18-x-2-4-5">Version 18.x-2.4.5</h2>
 <ul>
 <li>Fixed issue with unable to view album page in Kodi Leia (v18) #327</li>

dist/lang/en/app-readme.html

@@ -60,8 +60,9 @@ <h2 id="kodi-api-browser">Kodi API browser</h2>
 <h2 id="contributing">Contributing</h2>
 <p>If you would like to make this project better I would appreciate any help. There is a develop branch for each version of
 Kodi. Please do pull requests against the <code>dev</code> branch for the correct version (even better if you can do a PR for both).
-Leia (v18) dev branch is <code>18.x-dev</code>, Krypton (v17) dev branch is <code>17.x-dev</code>. I am happy to assist with getting an
-development environment up and running if you are happy to contribute.</p>
+Leia (v18) dev branch is <code>18.x-dev</code>, Krypton (v17) dev branch is <code>17.x-dev</code>. See the
+<a href="https://github.com/xbmc/chorus2/tree/master/src/lang/en/developers.md">developers documentation</a> for information about
+getting a dev environment up and running then compiling the project using docker.</p>
 <h3 id="translations">Translations</h3>
 <p>I only know English so definitely need help with this. I also don&#39;t know heaps about javascript multilingual stuff but
 thanks to <a href="https://github.com/mizaki">@mizaki</a> we have a structure ready to go. So it should be nice and easy to translate the UI.</p>
@@ -71,20 +72,6 @@ <h3 id="translations">Translations</h3>
 against <code>18.x-dev</code> and/or <code>17.x-dev</code>, or if you don&#39;t know git, a link to the language file.</p>
 <p>Language Files <a href="https://github.com/xbmc/chorus2/tree/master/src/lang">here</a>. 
 <em>English is the only real complete translation file so start with that as your base.</em></p>
-<h3 id="compiling">Compiling</h3>
-<p>Sass and Grunt are used to compile css and js in the dist folder.
-To get your environment setup first install <a href="http://bundler.io">Bundler</a> and <a href="https://www.npmjs.org/">npm</a>.</p>
-<ul>
-<li>Install required gems with <code>bundle install</code></li>
-<li>Install NodeJs packages with <code>npm install</code></li>
-<li>Run grunt <code>grunt</code></li>
-</ul>
-<p>If you are updating (eg. git pull), always do an <code>npm update</code> and <code>bundle update</code> to ensure all the tools are in the toolbox.</p>
-<h3 id="build">Build</h3>
-<p>A build will also include translation files.</p>
-<ul>
-<li>Run grunt <code>grunt build</code></li>
-</ul>
 <h2 id="donate">Donate</h2>
 <p>Are you a fan of Chorus? You can <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&amp;business=ZCGV976794JHE&amp;lc=AU&amp;item_name=Chorus%20Beer%20Fund&amp;currency_code=AUD&amp;bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted">buy Jeremy a beer</a> to say thanks :)</p>
 <h2 id="license">License</h2>

dist/lang/en/developers.html

@@ -0,0 +1,29 @@
+<h1 id="developers-information">Developers information</h1>
+<p>Do you want to help with making Chorus even better? Find help below...</p>
+<p>This page contains information about getting your dev environment up and running so you can build and test your 
+changes without the hassle of setting up all the required dependencies.</p>
+<h2 id="docker-dev-environment">Docker dev environment</h2>
+<p>Included in this repo is a <code>Dockerfile</code> which builds the Chorus 2 dev environment image. If you wanted to develop
+<em>without</em> using docker, this is a good reference as to what you need installed on your pc. </p>
+<p>If you want to make your live much easier, just install docker then grab the pre-built image from docker hub.</p>
+<pre><code>docker pull jez500/chorus2<span class="hljs-attribute">-dev</span>:latest
+</code></pre><h3 id="installing-dev-dependencies">Installing dev dependencies</h3>
+<p>Once you have the docker dev image, you can use this to do all your development related tasks. The first of these should
+be installing all the nodejs/ruby dependencies.</p>
+<pre><code>docker run <span class="hljs-attribute">-tiP</span> <span class="hljs-attribute">-v</span> <span class="hljs-string">`pwd`</span>:/app jez500/chorus2<span class="hljs-attribute">-dev</span>:latest <span class="hljs-built_in">.</span>/build<span class="hljs-built_in">.</span>sh install
+</code></pre><p>This will run <code>npm install</code> and <code>bundle install</code> inside the dev container.</p>
+<p>You should only need to do this once, unless... <code>package.json</code> or <code>Gemfile</code> are updated</p>
+<h3 id="building-compiling-the-project">Building/Compiling the project</h3>
+<p>If you have made changes to some coffee script or sass, you can build those changes via executing commands inside
+the dev container. To get a command line in the container:</p>
+<pre><code>docker run <span class="hljs-attribute">-tiP</span> <span class="hljs-attribute">-v</span> <span class="hljs-string">`pwd`</span>:/app jez500/chorus2<span class="hljs-attribute">-dev</span>:latest bash
+</code></pre><p>Once inside the dev container, you can do the following:</p>
+<h4 id="build">Build</h4>
+<p>This will build languages, documentation, js and css.</p>
+<pre><code>grunt build
+</code></pre><h4 id="watch-for-changes-continuously-build-">Watch for changes (continuously build)</h4>
+<p>This will only build js and css.</p>
+<pre><code>grunt
+</code></pre><h2 id="committing-your-changes">Committing your changes</h2>
+<p>As a rule of thumb, you should not commit any compiled files unless you are building a release. Eg. only commit files
+in the <code>src</code> folder.</p>

dist/lang/fr/lang-readme.html

@@ -26,7 +26,7 @@ <h2 id="rajoute-une-nouvelle-langue">Rajoute une nouvelle langue</h2>
 <h3 id="dites-le-l-application">Dites-le à l&#39;application</h3>
 <p>Vous devez aussi dire à l&#39;application de rajouter cette langue comme option. Pour cela il faut éditer
 ce fichier <code>/src/js/helpers/translate.js.coffee</code> et rajouter <code>fr: &quot;French&quot;</code> aux langues dans <code>getLanguages</code>.</p>
-<h3 id="dupliquez-la-structure-de-fichier-et-de-r-pertoire-de-en-">Dupliquez la structure de fichier et de répertoire de <code>en</code></h3>
+<h3 id="dupliquez-la-structure-de-fichier-et-de-r-pertoire-de-en">Dupliquez la structure de fichier et de répertoire de <code>en</code></h3>
 <p>Copiez les fichiers que vous voulez traduire:</p>
 <ul>
 <li><strong>Strings:</strong> Copiez <code>/src/_strings/en.po</code> dans <code>/src/_strings/fr.po</code></li>