Merge branch 'historyupdate'

js/privatebin.js

@@ -230,11 +230,14 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          * @return {string}
          */
         getCookie: function(cname) {
-            var name = cname + '=';
+            var name = cname + '=',
-            var ca = document.cookie.split(';');
+                ca = document.cookie.split(';');
             for (var i = 0; i < ca.length; ++i) {
                 var c = ca[i];
-                while (c.charAt(0) === ' ') c = c.substring(1);
+                while (c.charAt(0) === ' ')
+                {
+                    c = c.substring(1);
+                }
                 if (c.indexOf(name) === 0)
                 {
                     return c.substring(name.length, c.length);
@@ -243,6 +246,63 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             return '';
         },
 
+        /**
+         * get the current script location (without search or hash part of the URL),
+         * eg. http://example.com/path/?aaaa#bbbb --> http://example.com/path/
+         *
+         * @name   helper.scriptLocation
+         * @function
+         * @return {string} current script location
+         */
+        scriptLocation: function()
+        {
+            var scriptLocation = window.location.href.substring(
+                    0,
+                    window.location.href.length - window.location.search.length - window.location.hash.length
+                ),
+                hashIndex = scriptLocation.indexOf('?');
+            if (hashIndex !== -1)
+            {
+                scriptLocation = scriptLocation.substring(0, hashIndex);
+            }
+            return scriptLocation;
+        },
+
+        /**
+         * get the pastes unique identifier from the URL,
+         * eg. http://example.com/path/?c05354954c49a487#c05354954c49a487 returns c05354954c49a487
+         *
+         * @name   helper.pasteId
+         * @function
+         * @return {string} unique identifier
+         */
+        pasteId: function()
+        {
+            return window.location.search.substring(1);
+        },
+
+        /**
+         * return the deciphering key stored in anchor part of the URL
+         *
+         * @name   helper.pageKey
+         * @function
+         * @return {string} key
+         */
+        pageKey: function()
+        {
+            var key = window.location.hash.substring(1),
+                i = key.indexOf('&');
+
+            // Some web 2.0 services and redirectors add data AFTER the anchor
+            // (such as &utm_source=...). We will strip any additional data.
+            if (i > -1)
+            {
+                key = key.substring(0, i);
+            }
+
+            return key;
+        },
+
         /**
          * convert all applicable characters to HTML entities
          *
@@ -404,8 +464,11 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          */
         loadTranslations: function()
         {
-            var selectedLang = helper.getCookie('lang');
+            var language = helper.getCookie('lang');
-            var language = selectedLang.length > 0 ? selectedLang : (navigator.language || navigator.userLanguage).substring(0, 2);
+            if (language.length === 0)
+            {
+                language = (navigator.language || navigator.userLanguage).substring(0, 2);
+            }
             // note that 'en' is built in, so no translation is necessary
             if (i18n.supportedLanguages.indexOf(language) === -1)
             {
@@ -555,76 +618,6 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          */
         createdPasteUrl: '',
 
-        /**
-         * get the current script location (without search or hash part of the URL),
-         * eg. http://example.com/zero/?aaaa#bbbb --> http://example.com/zero/
-         *
-         * @name   controller.scriptLocation
-         * @function
-         * @return {string} current script location
-         */
-        scriptLocation: function()
-        {
-            var scriptLocation = window.location.href.substring(0,window.location.href.length
-                - window.location.search.length - window.location.hash.length),
-                hashIndex = scriptLocation.indexOf('#');
-            if (hashIndex !== -1)
-            {
-                scriptLocation = scriptLocation.substring(0, hashIndex);
-            }
-            return scriptLocation;
-        },
-
-        /**
-         * get the pastes unique identifier from the URL,
-         * eg. http://example.com/zero/?c05354954c49a487#c05354954c49a487 returns c05354954c49a487
-         *
-         * @name   controller.pasteID
-         * @function
-         * @return {string} unique identifier
-         */
-        pasteID: function()
-        {
-            return window.location.search.substring(1);
-        },
-
-        /**
-         * return the deciphering key stored in anchor part of the URL
-         *
-         * @name   controller.pageKey
-         * @function
-         * @return {string} key
-         */
-        pageKey: function()
-        {
-            // Some web 2.0 services and redirectors add data AFTER the anchor
-            // (such as &utm_source=...). We will strip any additional data.
-
-            var key = window.location.hash.substring(1),    // Get key
-                i = key.indexOf('=');
-
-            // First, strip everything after the equal sign (=) which signals end of base64 string.
-            if (i > -1)
-            {
-                key = key.substring(0, i + 1);
-            }
-
-            // If the equal sign was not present, some parameters may remain:
-            i = key.indexOf('&');
-            if (i > -1)
-            {
-                key = key.substring(0, i);
-            }
-
-            // Then add trailing equal sign if it's missing
-            if (key.charAt(key.length - 1) !== '=')
-            {
-                key += '=';
-            }
-
-            return key;
-        },
-
         /**
          * ask the user for the password and set it
          *
@@ -722,8 +715,8 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         displayMessages: function(paste)
         {
             paste = paste || $.parseJSON(this.cipherData.text());
-            var key = this.pageKey();
+            var key = helper.pageKey(),
-            var password = this.passwordInput.val();
+                password = this.passwordInput.val();
             if (!this.prettyPrint.hasClass('prettyprinted')) {
                 // Try to decrypt the paste.
                 try
@@ -813,7 +806,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
                 // unfortunately many web servers don't support DELETE (and PUT) out of the box
                 $.ajax({
                     type: 'POST',
-                    url: this.scriptLocation() + '?' + this.pasteID(),
+                    url: helper.scriptLocation() + '?' + helper.pasteId(),
                     data: {deletetoken: 'burnafterreading'},
                     dataType: 'json',
                     headers: this.headers
@@ -838,24 +831,27 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
                 // iterate over comments
                 for (var i = 0; i < paste.comments.length; ++i)
                 {
-                    var place = this.comments;
+                    var place = this.comments,
-                    var comment = paste.comments[i];
+                        comment = paste.comments[i],
-                    var commenttext = filter.decipher(key, password, comment.data);
+                        commenttext = filter.decipher(key, password, comment.data),
                         // if parent comment exists, display below (CSS will automatically shift it to the right)
-                    var cname = '#comment_' + comment.parentid;
+                        cname = '#comment_' + comment.parentid,
+                        divComment = $('<article><div class="comment" id="comment_' + comment.id
+                                   + '"><div class="commentmeta"><span class="nickname"></span>'
+                                   + '<span class="commentdate"></span></div>'
+                                   + '<div class="commentdata"></div>'
+                                   + '<button class="btn btn-default btn-sm">'
+                                   + i18n._('Reply') + '</button></div></article>'),
+                        divCommentData = divComment.find('div.commentdata');
 
                     // if the element exists in page
                     if ($(cname).length)
                     {
                         place = $(cname);
                     }
-                    var divComment = $('<article><div class="comment" id="comment_' + comment.id + '">'
-                                   + '<div class="commentmeta"><span class="nickname"></span><span class="commentdate"></span></div><div class="commentdata"></div>'
-                                   + '<button class="btn btn-default btn-sm">' + i18n._('Reply') + '</button>'
-                                   + '</div></article>');
                     divComment.find('button').click({commentid: comment.id}, $.proxy(this.openReply, this));
-                    helper.setElementText(divComment.find('div.commentdata'), commenttext);
+                    helper.setElementText(divCommentData, commenttext);
-                    helper.urls2links(divComment.find('div.commentdata'));
+                    helper.urls2links(divCommentData);
 
                     // try to get optional nickname
                     var nick = filter.decipher(key, password, comment.meta.nickname);
@@ -887,7 +883,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
                     '<div class="comment"><button class="btn btn-default btn-sm">' +
                     i18n._('Add comment') + '</button></div>'
                 );
-                divComment.find('button').click({commentid: this.pasteID()}, $.proxy(this.openReply, this));
+                divComment.find('button').click({commentid: helper.pasteId()}, $.proxy(this.openReply, this));
                 this.comments.append(divComment);
                 this.discussion.removeClass('hidden');
             }
@@ -903,20 +899,26 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         openReply: function(event)
         {
             event.preventDefault();
-            var source = $(event.target),
-                commentid = event.data.commentid,
-                hint = i18n._('Optional nickname...');
 
             // remove any other reply area
             $('div.reply').remove();
-            var reply = $(
+
-                '<div class="reply">' +
+            var source = $(event.target),
-                '<input type="text" id="nickname" class="form-control" title="' + hint + '" placeholder="' + hint + '" />' +
+                commentid = event.data.commentid,
-                '<textarea id="replymessage" class="replymessage form-control" cols="80" rows="7"></textarea>' +
+                hint = i18n._('Optional nickname...'),
-                '<br /><div id="replystatus"></div><button id="replybutton" class="btn btn-default btn-sm">' +
+                reply = $(
-                i18n._('Post comment') + '</button></div>'
+                    '<div class="reply"><input type="text" id="nickname" ' +
+                    'class="form-control" title="' + hint + '" placeholder="' +
+                    hint + '" /><textarea id="replymessage" class="replymessage ' +
+                    'form-control" cols="80" rows="7"></textarea><br />' +
+                    '<div id="replystatus"></div><button id="replybutton" ' +
+                    'class="btn btn-default btn-sm">' + i18n._('Post comment') +
+                    '</button></div>'
+                );
+            reply.find('button').click(
+                {parentid: commentid},
+                $.proxy(this.sendComment, this)
             );
-            reply.find('button').click({parentid: commentid}, $.proxy(this.sendComment, this));
             source.after(reply);
             this.replyStatus = $('#replystatus');
             $('#replymessage').focus();
@@ -941,24 +943,25 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             }
 
             this.showStatus(i18n._('Sending comment...'), true);
-            var parentid = event.data.parentid;
+            var parentid = event.data.parentid,
-            var cipherdata = filter.cipher(this.pageKey(), this.passwordInput.val(), replyMessage.val());
+                key = helper.pageKey(),
-            var ciphernickname = '';
+                cipherdata = filter.cipher(key, this.passwordInput.val(), replyMessage.val()),
-            var nick = $('#nickname').val();
+                ciphernickname = '',
-            if (nick !== '')
+                nick = $('#nickname').val();
+            if (nick.length > 0)
             {
-                ciphernickname = filter.cipher(this.pageKey(), this.passwordInput.val(), nick);
+                ciphernickname = filter.cipher(key, this.passwordInput.val(), nick);
             }
             var data_to_send = {
                 data:     cipherdata,
                 parentid: parentid,
-                pasteid:  this.pasteID(),
+                pasteid:  helper.pasteId(),
                 nickname: ciphernickname
             };
 
             $.ajax({
                 type: 'POST',
-                url: this.scriptLocation(),
+                url: helper.scriptLocation(),
                 data: data_to_send,
                 dataType: 'json',
                 headers: this.headers,
@@ -969,7 +972,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
                         controller.showStatus(i18n._('Comment posted.'));
                         $.ajax({
                             type: 'GET',
-                            url: controller.scriptLocation() + '?' + controller.pasteID(),
+                            url: helper.scriptLocation() + '?' + helper.pasteId(),
                             dataType: 'json',
                             headers: controller.headers,
                             success: function(data)
@@ -1040,8 +1043,8 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             this.password.addClass('hidden');
             this.showStatus(i18n._('Sending paste...'), true);
 
-            var randomkey = sjcl.codec.base64.fromBits(sjcl.random.randomWords(8, 0), 0);
+            var randomkey = sjcl.codec.base64.fromBits(sjcl.random.randomWords(8, 0), 0),
-            var password = this.passwordInput.val();
+                password = this.passwordInput.val();
             if(files && files[0])
             {
                 if(typeof FileReader === undefined)
@@ -1088,8 +1091,8 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          */
         sendDataContinue: function(randomkey, cipherdata_attachment, cipherdata_attachment_name)
         {
-            var cipherdata = filter.cipher(randomkey, this.passwordInput.val(), this.message.val());
+            var cipherdata = filter.cipher(randomkey, this.passwordInput.val(), this.message.val()),
-            var data_to_send = {
+                data_to_send = {
                     data:             cipherdata,
                     expire:           $('#pasteExpiration').val(),
                     formatter:        $('#pasteFormatter').val(),
@@ -1106,7 +1109,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             }
             $.ajax({
                 type: 'POST',
-                url: this.scriptLocation(),
+                url: helper.scriptLocation(),
                 data: data_to_send,
                 dataType: 'json',
                 headers: this.headers,
@@ -1114,10 +1117,11 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
                 {
                     if (data.status === 0) {
                         controller.stateExistingPaste();
-                        var url = controller.scriptLocation() + '?' + data.id + '#' + randomkey;
+                        var url = helper.scriptLocation() + '?' + data.id + '#' + randomkey,
-                        var deleteUrl = controller.scriptLocation() + '?pasteid=' + data.id + '&deletetoken=' + data.deletetoken;
+                            deleteUrl = helper.scriptLocation() + '?pasteid=' + data.id + '&deletetoken=' + data.deletetoken;
                         controller.showStatus('');
                         controller.errorMessage.addClass('hidden');
+                        history.pushState({type: 'newpaste'}, document.title, url);
 
                         $('#pastelink').html(
                             i18n._(
@@ -1304,7 +1308,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         reloadPage: function(event)
         {
             event.preventDefault();
-            window.location.href = this.scriptLocation();
+            window.location.href = helper.scriptLocation();
         },
 
         /**
@@ -1320,8 +1324,8 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             var paste = $('#pasteFormatter').val() === 'markdown' ?
                 this.prettyPrint.text() : this.clearText.text();
             history.pushState(
-                null, document.title, this.scriptLocation() + '?' +
+                null, document.title, helper.scriptLocation() + '?' +
-                this.pasteID() + '#' + this.pageKey()
+                helper.pasteId() + '#' + helper.pageKey()
             );
             // we use text/html instead of text/plain to avoid a bug when
             // reloading the raw text view (it reverts to type text/html)
@@ -1343,7 +1347,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             this.stateNewPaste();
 
             // erase the id and the key in url
-            history.replaceState(null, document.title, this.scriptLocation());
+            history.replaceState(null, document.title, helper.scriptLocation());
 
             this.showStatus('');
             if (this.attachmentLink.attr('href'))
@@ -1464,6 +1468,27 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             this.formatPaste($('#pasteFormatter').val(), this.message.val());
         },
 
+        /**
+         * handle history (pop) state changes
+         *
+         * currently this does only handle redirects to the home page.
+         *
+         * @name   controller.historyChange
+         * @function
+         * @param  {Event} event
+         */
+        historyChange: function(event)
+        {
+            var currentLocation = helper.scriptLocation();
+            if (event.originalEvent.state === null && // no state object passed
+                event.originalEvent.target.location.href === currentLocation && // target location is home page
+                window.location.href === currentLocation // and we are not already on the home page
+            ) {
+                // redirect to home page
+                window.location.href = currentLocation;
+            }
+        },
+
         /**
          * create a new paste
          *
@@ -1619,6 +1644,8 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             this.passwordModal.on('shown.bs.modal', $.proxy(this.passwordDecrypt.focus, this));
             this.passwordModal.on('hidden.bs.modal', $.proxy(this.decryptPasswordModal, this));
             this.passwordForm.submit($.proxy(this.submitPasswordModal, this));
+
+            $(window).on('popstate', $.proxy(this.historyChange, this));
         },
 
         /**

js/test.js

@@ -1,22 +1,31 @@
 'use strict';
-var jsc = require('jsverify');
+var jsc = require('jsverify'),
+    jsdom = require('jsdom-global'),
+    cleanup = jsdom(),
+
+    a2zString = ['a','b','c','d','e','f','g','h','i','j','k','l','m',
+                 'n','o','p','q','r','s','t','u','v','w','x','y','z'],
+    alnumString = a2zString.concat(['0','1','2','3','4','5','6','7','8','9']),
+    queryString = alnumString.concat(['+','%','&','.','*','-','_']),
+    base64String = alnumString.concat(['+','/','=']).concat(
+        a2zString.map(function(c) {
+            return c.toUpperCase();
+        })
+    );
 
-before(function () {
-    this.jsdom = require('jsdom-global')();
 global.$ = global.jQuery = require('./jquery-3.1.1');
 global.sjcl = require('./sjcl-1.0.6');
 global.Base64 = require('./base64-2.1.9');
 global.RawDeflate = require('./rawdeflate-0.5');
 require('./rawinflate-0.3');
 require('./privatebin');
-})
-
-after(function () {
-    this.jsdom();
-})
 
 describe('helper', function () {
     describe('secondsToHuman', function () {
+        after(function () {
+            cleanup();
+        });
+
         jsc.property('returns an array with a number and a word', 'integer', function (number) {
             var result = $.PrivateBin.helper.secondsToHuman(number);
             return Array.isArray(result) &&
@@ -56,5 +65,95 @@ describe('helper', function () {
             return $.PrivateBin.helper.secondsToHuman(number)[1] === 'month';
         });
     });
+
+    describe('scriptLocation', function () {
+        jsc.property(
+            'returns the URL without query & fragment',
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.array(jsc.elements(queryString)),
+            'string',
+            function (schema, address, query, fragment) {
+                var expected = schema.join('') + '://' + address.join('') + '/',
+                    clean = jsdom('', {url: expected + '?' + query.join('') + '#' + fragment}),
+                    result = $.PrivateBin.helper.scriptLocation();
+                clean();
+                return expected === result;
+            }
+        );
+    });
+
+    describe('pasteId', function () {
+        jsc.property(
+            'returns the query string without separator, if any',
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.array(jsc.elements(queryString)),
+            'string',
+            function (schema, address, query, fragment) {
+                var query = query.join(''),
+                    clean = jsdom('', {
+                        url: schema.join('') + '://' + address.join('') +
+                             '/?' + query + '#' + fragment
+                    }),
+                    result = $.PrivateBin.helper.pasteId();
+                clean();
+                return query === result;
+            }
+        );
+    });
+
+    describe('pageKey', function () {
+        jsc.property(
+            'returns the fragment of the URL',
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.array(jsc.elements(queryString)),
+            jsc.array(jsc.elements(base64String)),
+            function (schema, address, query, fragment) {
+                var fragment = fragment.join(''),
+                    clean = jsdom('', {
+                        url: schema.join('') + '://' + address.join('') +
+                             '/?' + query.join('') + '#' + fragment
+                    }),
+                    result = $.PrivateBin.helper.pageKey();
+                clean();
+                return fragment === result;
+            }
+        );
+        jsc.property(
+            'returns the fragment stripped of trailing query parts',
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.nearray(jsc.elements(a2zString)),
+            jsc.array(jsc.elements(queryString)),
+            jsc.array(jsc.elements(base64String)),
+            jsc.array(jsc.elements(queryString)),
+            function (schema, address, query, fragment, trail) {
+                var fragment = fragment.join(''),
+                    clean = jsdom('', {
+                        url: schema.join('') + '://' + address.join('') + '/?' +
+                             query.join('') + '#' + fragment + '&' + trail.join('')
+                    }),
+                    result = $.PrivateBin.helper.pageKey();
+                clean();
+                return fragment === result;
+            }
+        );
+    });
+
+    describe('htmlEntities', function () {
+        after(function () {
+            cleanup();
+        });
+
+        jsc.property(
+            'removes all HTML entities from any given string',
+            'string',
+            function (string) {
+                var result = $.PrivateBin.helper.htmlEntities(string);
+                return !(/[<>"'`=\/]/.test(result)) && !(string.indexOf('&') > -1 && !(/&amp;/.test(result)));
+            }
+        );
+    });
 });
 

tpl/bootstrap.php

@@ -69,7 +69,7 @@ if ($MARKDOWN):
 <?php
 endif;
 ?>
-		<script type="text/javascript" src="js/privatebin.js?<?php echo rawurlencode($VERSION); ?>" integrity="sha512-YW9b0ChcI/zuJwUZxdQW3zb/LO999he3fOtiio2MhickC7YyrzgvIcgvFMUYZjJ79tYiNzDLmMAZKRMvqoQoGw==" crossorigin="anonymous"></script>
+		<script type="text/javascript" src="js/privatebin.js?<?php echo rawurlencode($VERSION); ?>" integrity="sha512-bOZxf+ELU4lyYdlSIVM0z+GDBdeO1BZQvkr7HKPz89rmnw6x7w669QOsCOqLoNJ8vcIsFas288doubME9pSE4Q==" crossorigin="anonymous"></script>
 		<!--[if lt IE 10]>
 		<style type="text/css">body {padding-left:60px;padding-right:60px;} #ienotice {display:block;} #oldienotice {display:block;}</style>
 		<![endif]-->

tpl/page.php

@@ -47,7 +47,7 @@ if ($MARKDOWN):
 <?php
 endif;
 ?>
-		<script type="text/javascript" src="js/privatebin.js?<?php echo rawurlencode($VERSION); ?>" integrity="sha512-YW9b0ChcI/zuJwUZxdQW3zb/LO999he3fOtiio2MhickC7YyrzgvIcgvFMUYZjJ79tYiNzDLmMAZKRMvqoQoGw==" crossorigin="anonymous"></script>
+		<script type="text/javascript" src="js/privatebin.js?<?php echo rawurlencode($VERSION); ?>" integrity="sha512-bOZxf+ELU4lyYdlSIVM0z+GDBdeO1BZQvkr7HKPz89rmnw6x7w669QOsCOqLoNJ8vcIsFas288doubME9pSE4Q==" crossorigin="anonymous"></script>
 		<!--[if lt IE 10]>
 		<style type="text/css">body {padding-left:60px;padding-right:60px;} #ienotice {display:block;} #oldienotice {display:block;}</style>
 		<![endif]-->