implementing recommendations of scrutinizer

js/privatebin.js

@@ -179,7 +179,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          *
          * @name   Helper.urls2links
          * @function
-         * @param  {Object} element - a jQuery DOM element
+         * @param  {Object} $element - a jQuery DOM element
          */
         me.urls2links = function($element)
         {
@@ -675,7 +675,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          * @function
          * @return {string} func
          */
-        me.getSymmetricKey = function(func)
+        me.getSymmetricKey = function()
         {
             return sjcl.codec.base64.fromBits(sjcl.random.randomWords(8, 0), 0);
         }
@@ -903,8 +903,6 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         me.isVisible = function($element)
         {
             var elementTop = $element.offset().top;
-            var elementBottom = elementTop + $element.outerHeight();
-
             var viewportTop = $(window).scrollTop();
             var viewportBottom = viewportTop + $(window).height();
 
@@ -985,11 +983,9 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
      * Alert/error manager
      *
      * @name   Alert
-     * @param  {object} window
-     * @param  {object} document
      * @class
      */
-    var Alert = (function (window, document) {
+    var Alert = (function () {
         var me = {};
 
         var $errorMessage,
@@ -1249,17 +1245,16 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         }
 
         return me;
-    })(window, document);
+    })();
 
     /**
      * handles paste status/result
      *
      * @name   PasteStatus
      * @param  {object} window
-     * @param  {object} document
      * @class
      */
-    var PasteStatus = (function (window, document) {
+    var PasteStatus = (function (window) {
         var me = {};
 
         var $pasteSuccess,
@@ -1402,17 +1397,15 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         }
 
         return me;
-    })(window, document);
+    })(window);
 
     /**
      * password prompt
      *
      * @name Prompt
-     * @param  {object} window
-     * @param  {object} document
      * @class
      */
-    var Prompt = (function (window, document) {
+    var Prompt = (function () {
         var me = {};
 
         var $passwordDecrypt,
@@ -1512,7 +1505,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         }
 
         return me;
-    })(window, document);
+    })();
 
     /**
      * Manage paste/message input, and preview tab
@@ -1520,11 +1513,9 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
      * Note that the actual preview is handled by PasteViewer.
      *
      * @name   Editor
-     * @param  {object} window
-     * @param  {object} document
      * @class
      */
-    var Editor = (function (window, document) {
+    var Editor = (function () {
         var me = {};
 
         var $editorTabs,
@@ -1728,17 +1719,15 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         }
 
         return me;
-    })(window, document);
+    })();
 
     /**
      * (view) Parse and show paste.
      *
      * @name   PasteViewer
-     * @param  {object} window
-     * @param  {object} document
      * @class
      */
-    var PasteViewer = (function (window, document) {
+    var PasteViewer = (function () {
         var me = {};
 
         var $placeholder,
@@ -1904,7 +1893,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          * @function
          * @return {string}
          */
-        me.getText = function(newText)
+        me.getText = function()
         {
             return text;
         }
@@ -1981,7 +1970,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
         }
 
         return me;
-    })(window, document);
+    })();
 
     /**
      * (view) Show attachment and preview if possible
@@ -1998,8 +1987,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
             $attachmentPreview,
             $attachment;
 
-        var attachmentChanged = false,
-            attachmentHasPreview = false;
+        var attachmentHasPreview = false;
 
         /**
          * sets the attachment but does not yet show it
@@ -2027,8 +2015,6 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
                 );
                 attachmentHasPreview = true;
             }
-
-            attachmentChanged = true;
         }
 
         /**
@@ -3043,7 +3029,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          * @private
          * @function
          * @param {int} status
-         * @param {int} data - optional
+         * @param {int} result - optional
          */
         function success(status, result)
         {
@@ -3063,7 +3049,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          * @private
          * @function
          * @param {int} status - internal code
-         * @param {int} data - original error code
+         * @param {int} result - original error code
          */
         function fail(status, result)
         {
@@ -3107,7 +3093,7 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          *
          * @name   Uploader.setUrl
          * @function
-         * @param {function} func
+         * @param {function} newUrl
          */
         me.setUrl = function(newUrl)
         {
@@ -3236,17 +3222,18 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
          * @return {array}
          */
         me.parseUploadError = function(status, data, doThisThing) {
-            var errorArray = ['Error while parsing error message.'];
+            var errorArray;
 
             switch (status) {
-                case Uploader.error['custom']:
+                case me.error['custom']:
                     errorArray = ['Could not ' + doThisThing + ': %s', data.message];
                     break;
-                case Uploader.error['unknown']:
+                case me.error['unknown']:
                     errorArray = ['Could not ' + doThisThing + ': %s', I18n._('unknown status')];
                     break;
-                case Uploader.error['serverError']:
-                    errorArray = ['Could not ' + doThisThing + ': %s', I18n._('server error or not responding')];                        break;
+                case me.error['serverError']:
+                    errorArray = ['Could not ' + doThisThing + ': %s', I18n._('server error or not responding')];
+                    break;
                 default:
                     errorArray = ['Could not ' + doThisThing + ': %s', I18n._('unknown error')];
                     break;
@@ -3884,7 +3871,6 @@ jQuery.PrivateBin = function($, sjcl, Base64, RawDeflate) {
 
             // show proper elements on screen
             PasteDecrypter.run();
-            return;
         }
 
         /**

lib/Data/AbstractData.php

@@ -58,7 +58,7 @@ abstract class AbstractData
      * @access public
      * @static
      * @param  array $options
-     * @return privatebin_abstract
+     * @return AbstractData
      */
     public static function getInstance($options)
     {
@@ -88,7 +88,6 @@ abstract class AbstractData
      *
      * @access public
      * @param  string $pasteid
-     * @return void
      */
     abstract public function delete($pasteid);
 
@@ -147,7 +146,6 @@ abstract class AbstractData
      *
      * @access public
      * @param  int $batchsize
-     * @return void
      */
     public function purge($batchsize)
     {

lib/Data/Database.php

@@ -282,7 +282,6 @@ class Database extends AbstractData
      *
      * @access public
      * @param  string $pasteid
-     * @return void
      */
     public function delete($pasteid)
     {
@@ -375,11 +374,10 @@ class Database extends AbstractData
                 $comments[$i]->data           = $row['data'];
                 $comments[$i]->meta           = new stdClass;
                 $comments[$i]->meta->postdate = (int) $row['postdate'];
-                if (array_key_exists('nickname', $row) && !empty($row['nickname'])) {
-                    $comments[$i]->meta->nickname = $row['nickname'];
-                }
-                if (array_key_exists('vizhash', $row) && !empty($row['vizhash'])) {
-                    $comments[$i]->meta->vizhash = $row['vizhash'];
+                foreach (array('nickname', 'vizhash') as $key) {
+                    if (array_key_exists($key, $row) && !empty($row[$key])) {
+                        $comments[$i]->meta->$key = $row[$key];
+                    }
                 }
             }
             ksort($comments);
@@ -564,7 +562,6 @@ class Database extends AbstractData
      *
      * @access private
      * @static
-     * @return void
      */
     private static function _createPasteTable()
     {
@@ -589,7 +586,6 @@ class Database extends AbstractData
      *
      * @access private
      * @static
-     * @return void
      */
     private static function _createCommentTable()
     {
@@ -616,7 +612,6 @@ class Database extends AbstractData
      *
      * @access private
      * @static
-     * @return void
      */
     private static function _createConfigTable()
     {
@@ -651,7 +646,6 @@ class Database extends AbstractData
      * @access private
      * @static
      * @param  string $oldversion
-     * @return void
      */
     private static function _upgradeDatabase($oldversion)
     {

lib/Data/Filesystem.php

@@ -98,7 +98,6 @@ class Filesystem extends AbstractData
      *
      * @access public
      * @param  string $pasteid
-     * @return void
      */
     public function delete($pasteid)
     {

lib/I18n.php

@@ -135,15 +135,17 @@ class I18n
      *
      * @access public
      * @static
-     * @return void
      */
     public static function loadTranslations()
     {
         $availableLanguages = self::getAvailableLanguages();
 
         // check if the lang cookie was set and that language exists
-        if (array_key_exists('lang', $_COOKIE) && in_array($_COOKIE['lang'], $availableLanguages)) {
-            $match = $_COOKIE['lang'];
+        if (
+            array_key_exists('lang', $_COOKIE) &&
+            ($key = array_search($_COOKIE['lang'], $availableLanguages)) !== false
+        ) {
+            $match = $availableLanguages[$key];
         }
         // find a translation file matching the browsers language preferences
         else {
@@ -256,7 +258,6 @@ class I18n
      * @access public
      * @static
      * @param  string $lang
-     * @return void
      */
     public static function setLanguageFallback($lang)
     {

lib/Model.php

@@ -40,7 +40,6 @@ class Model
      * Factory constructor.
      *
      * @param configuration $conf
-     * @return void
      */
     public function __construct(Configuration $conf)
     {
@@ -64,8 +63,6 @@ class Model
 
     /**
      * Checks if a purge is necessary and triggers it if yes.
-     *
-     * @return void
      */
     public function purge()
     {

lib/Model/AbstractModel.php

@@ -63,7 +63,6 @@ abstract class AbstractModel
      * @access public
      * @param  Configuration $configuration
      * @param  AbstractData $storage
-     * @return void
      */
     public function __construct(Configuration $configuration, AbstractData $storage)
     {
@@ -90,7 +89,6 @@ abstract class AbstractModel
      * @access public
      * @param string $id
      * @throws Exception
-     * @return void
      */
     public function setId($id)
     {
@@ -106,7 +104,6 @@ abstract class AbstractModel
      * @access public
      * @param string $data
      * @throws Exception
-     * @return void
      */
     public function setData($data)
     {
@@ -133,7 +130,6 @@ abstract class AbstractModel
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     abstract public function store();
 
@@ -142,7 +138,6 @@ abstract class AbstractModel
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     abstract public function delete();
 

lib/Model/Comment.php

@@ -61,7 +61,6 @@ class Comment extends AbstractModel
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     public function store()
     {
@@ -101,7 +100,6 @@ class Comment extends AbstractModel
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     public function delete()
     {
@@ -129,7 +127,6 @@ class Comment extends AbstractModel
      * @access public
      * @param Paste $paste
      * @throws Exception
-     * @return void
      */
     public function setPaste(Paste $paste)
     {
@@ -154,7 +151,6 @@ class Comment extends AbstractModel
      * @access public
      * @param string $id
      * @throws Exception
-     * @return void
      */
     public function setParentId($id)
     {
@@ -184,7 +180,6 @@ class Comment extends AbstractModel
      * @access public
      * @param string $nickname
      * @throws Exception
-     * @return void
      */
     public function setNickname($nickname)
     {

lib/Model/Paste.php

@@ -75,7 +75,6 @@ class Paste extends AbstractModel
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     public function store()
     {
@@ -103,7 +102,6 @@ class Paste extends AbstractModel
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     public function delete()
     {
@@ -183,7 +181,6 @@ class Paste extends AbstractModel
      * @access public
      * @param string $attachment
      * @throws Exception
-     * @return void
      */
     public function setAttachment($attachment)
     {
@@ -199,7 +196,6 @@ class Paste extends AbstractModel
      * @access public
      * @param string $attachmentname
      * @throws Exception
-     * @return void
      */
     public function setAttachmentName($attachmentname)
     {
@@ -214,7 +210,6 @@ class Paste extends AbstractModel
      *
      * @access public
      * @param string $expiration
-     * @return void
      */
     public function setExpiration($expiration)
     {
@@ -236,7 +231,6 @@ class Paste extends AbstractModel
      * @access public
      * @param string $burnafterreading
      * @throws Exception
-     * @return void
      */
     public function setBurnafterreading($burnafterreading = '1')
     {
@@ -257,7 +251,6 @@ class Paste extends AbstractModel
      * @access public
      * @param string $opendiscussion
      * @throws Exception
-     * @return void
      */
     public function setOpendiscussion($opendiscussion = '1')
     {
@@ -281,7 +274,6 @@ class Paste extends AbstractModel
      * @access public
      * @param string $format
      * @throws Exception
-     * @return void
      */
     public function setFormatter($format)
     {

lib/Persistence/AbstractPersistence.php

@@ -36,7 +36,6 @@ abstract class AbstractPersistence
      * @access public
      * @static
      * @param  string $path
-     * @return void
      */
     public static function setPath($path)
     {
@@ -80,7 +79,6 @@ abstract class AbstractPersistence
      * @access protected
      * @static
      * @throws Exception
-     * @return void
      */
     protected static function _initialize()
     {

lib/Persistence/PurgeLimiter.php

@@ -36,7 +36,6 @@ class PurgeLimiter extends AbstractPersistence
      * @access public
      * @static
      * @param  int $limit
-     * @return void
      */
     public static function setLimit($limit)
     {
@@ -49,7 +48,6 @@ class PurgeLimiter extends AbstractPersistence
      * @access public
      * @static
      * @param Configuration $conf
-     * @return void
      */
     public static function setConfiguration(Configuration $conf)
     {

lib/Persistence/ServerSalt.php

@@ -95,7 +95,6 @@ class ServerSalt extends AbstractPersistence
      * @access public
      * @static
      * @param  string $path
-     * @return void
      */
     public static function setPath($path)
     {

lib/Persistence/TrafficLimiter.php

@@ -45,7 +45,6 @@ class TrafficLimiter extends AbstractPersistence
      * @access public
      * @static
      * @param  int $limit
-     * @return void
      */
     public static function setLimit($limit)
     {
@@ -58,7 +57,6 @@ class TrafficLimiter extends AbstractPersistence
      * @access public
      * @static
      * @param Configuration $conf
-     * @return void
      */
     public static function setConfiguration(Configuration $conf)
     {

lib/PrivateBin.php

@@ -123,7 +123,6 @@ class PrivateBin
      *
      * @access public
      * @throws Exception
-     * @return void
      */
     public function __construct()
     {
@@ -171,7 +170,6 @@ class PrivateBin
      * initialize privatebin
      *
      * @access private
-     * @return void
      */
     private function _init()
     {
@@ -320,7 +318,6 @@ class PrivateBin
      * @access private
      * @param  string $dataid
      * @param  string $deletetoken
-     * @return void
      */
     private function _delete($dataid, $deletetoken)
     {
@@ -364,7 +361,6 @@ class PrivateBin
      *
      * @access private
      * @param  string $dataid
-     * @return void
      */
     private function _read($dataid)
     {
@@ -397,7 +393,6 @@ class PrivateBin
      * Display PrivateBin frontend.
      *
      * @access private
-     * @return void
      */
     private function _view()
     {
@@ -461,7 +456,6 @@ class PrivateBin
      *
      * @access private
      * @param string $type
-     * @return void
      */
     private function _jsonld($type)
     {
@@ -494,7 +488,6 @@ class PrivateBin
      * @param  int $status
      * @param  string $message
      * @param  array $other
-     * @return void
      */
     private function _return_message($status, $message, $other = array())
     {

lib/Request.php

@@ -41,7 +41,7 @@ class Request
     const MIME_XHTML = 'application/xhtml+xml';
 
     /**
-     * Input stream to use for PUT parameter parsing.
+     * Input stream to use for PUT parameter parsing
      *
      * @access private
      * @var string
@@ -49,7 +49,7 @@ class Request
     private static $_inputStream = 'php://input';
 
     /**
-     * Operation to perform.
+     * Operation to perform
      *
      * @access private
      * @var string
@@ -57,7 +57,7 @@ class Request
     private $_operation = 'view';
 
     /**
-     * Request parameters.
+     * Request parameters
      *
      * @access private
      * @var array
@@ -65,7 +65,7 @@ class Request
     private $_params = array();
 
     /**
-     * If we are in a JSON API context.
+     * If we are in a JSON API context
      *
      * @access private
      * @var bool
@@ -73,10 +73,9 @@ class Request
     private $_isJsonApi = false;
 
     /**
-     * Constructor.
+     * Constructor
      *
      * @access public
-     * @return void
      */
     public function __construct()
     {
@@ -122,7 +121,7 @@ class Request
     }
 
     /**
-     * Get current operation.
+     * Get current operation
      *
      * @access public
      * @return string
@@ -133,7 +132,7 @@ class Request
     }
 
     /**
-     * Get a request parameter.
+     * Get a request parameter
      *
      * @access public
      * @param  string $param
@@ -146,7 +145,7 @@ class Request
     }
 
     /**
-     * If we are in a JSON API context.
+     * If we are in a JSON API context
      *
      * @access public
      * @return bool
@@ -157,7 +156,7 @@ class Request
     }
 
     /**
-     * Override the default input stream source, used for unit testing.
+     * Override the default input stream source, used for unit testing
      *
      * @param string $input
      */
@@ -167,7 +166,7 @@ class Request
     }
 
     /**
-     * detect the clients supported media type and decide if its a JSON API call or not
+     * Detect the clients supported media type and decide if its a JSON API call or not
      *
      * Adapted from: https://stackoverflow.com/questions/3770513/detect-browser-language-in-php#3771447
      *

lib/View.php

@@ -35,7 +35,6 @@ class View
      * @access public
      * @param  string $name
      * @param  mixed  $value
-     * @return void
      */
     public function assign($name, $value)
     {
@@ -48,7 +47,6 @@ class View
      * @access public
      * @param  string $template
      * @throws Exception
-     * @return void
      */
     public function draw($template)
     {

lib/Vizhash16x16.php

@@ -61,7 +61,6 @@ class Vizhash16x16
      * constructor
      *
      * @access public
-     * @return void
      */
     public function __construct()
     {
@@ -210,7 +209,6 @@ class Vizhash16x16
      * @param  resource $image
      * @param  int $action
      * @param  int $color
-     * @return void
      */
     private function drawshape($image, $action, $color)
     {

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-7/bLmiTErcH3lMJi1JxXk/lb20NUO7TCqasWeFybnNhnfOUnJ9GQGqPVJxPf+7fnw9dgLa1s18FXQuRanLD8Hw==" crossorigin="anonymous"></script>
+		<script type="text/javascript" src="js/privatebin.js?<?php echo rawurlencode($VERSION); ?>" integrity="sha512-LFVkwqqKQ1UWGc8TSC/YgsxhZGtJXG2hGChiBL7vM6v+MOPQsKyFMpNryAyR79d/7/hINgcjhrqBN2qkLwlxRA==" 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-7/bLmiTErcH3lMJi1JxXk/lb20NUO7TCqasWeFybnNhnfOUnJ9GQGqPVJxPf+7fnw9dgLa1s18FXQuRanLD8Hw==" crossorigin="anonymous"></script>
+		<script type="text/javascript" src="js/privatebin.js?<?php echo rawurlencode($VERSION); ?>" integrity="sha512-LFVkwqqKQ1UWGc8TSC/YgsxhZGtJXG2hGChiBL7vM6v+MOPQsKyFMpNryAyR79d/7/hINgcjhrqBN2qkLwlxRA==" 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]-->