Controller::_create() - Code Metrics - Inspection of "[WIP] Webcrypto, v2 paste format, zlib compression" - PrivateBin/PrivateBin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#431)

by El

created 2019-05-15 19:55 UTC

Controller::_create() B

↳ Parent: Controller

Complexity

Conditions	11
Paths	41

Size

Total Lines	60
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	37
CRAP Score	11.0022

Importance

Changes

Metric	Value
cc	11
eloc	40
nc	41
nop	0
dl	0
loc	60
ccs	37
cts	38
cp	0.9737
crap	11.0022
rs	7.3166
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * PrivateBin
 *
 * a zero-knowledge paste bin
 *
 * @link      https://github.com/PrivateBin/PrivateBin
 * @copyright 2012 Sébastien SAUVAGE (sebsauvage.net)
 * @license   https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
 * @version   1.2.1
 */

namespace PrivateBin;

use Exception;
use PrivateBin\Persistence\ServerSalt;
use PrivateBin\Persistence\TrafficLimiter;

/**
 * Controller
 *
 * Puts it all together.
 */
class Controller
{
    /**
     * version
     *
     * @const string
     */
    const VERSION = '1.2.1';

    /**
     * minimal required PHP version
     *
     * @const string
     */
    const MIN_PHP_VERSION = '5.4.0';

    /**
     * show the same error message if the paste expired or does not exist
     *
     * @const string
     */
    const GENERIC_ERROR = 'Paste does not exist, has expired or has been deleted.';

    /**
     * configuration
     *
     * @access private
     * @var    Configuration
     */
    private $_conf;

    /**
     * error message
     *
     * @access private
     * @var    string
     */
    private $_error = '';

    /**
     * status message
     *
     * @access private
     * @var    string
     */
    private $_status = '';

    /**
     * JSON message
     *
     * @access private
     * @var    string
     */
    private $_json = '';

    /**
     * Factory of instance models
     *
     * @access private
     * @var    model
     */
    private $_model;

    /**
     * request
     *
     * @access private
     * @var    request
     */
    private $_request;

    /**
     * URL base
     *
     * @access private
     * @var    string
     */
    private $_urlBase;

    /**
     * constructor
     *
     * initializes and runs PrivateBin
     *
     * @access public
     * @throws Exception
     */
    public function __construct()
    {
        if (version_compare(PHP_VERSION, self::MIN_PHP_VERSION) < 0) {
            throw new Exception(I18n::_('%s requires php %s or above to work. Sorry.', I18n::_('PrivateBin'), self::MIN_PHP_VERSION), 1);
        }
        if (strlen(PATH) < 0 && substr(PATH, -1) !== DIRECTORY_SEPARATOR) {
            throw new Exception(I18n::_('%s requires the PATH to end in a "%s". Please update the PATH in your index.php.', I18n::_('PrivateBin'), DIRECTORY_SEPARATOR), 5);
        }

        // load config from ini file, initialize required classes
        $this->_init();

        switch ($this->_request->getOperation()) {
            case 'create':
                $this->_create();
                break;
            case 'delete':
                $this->_delete(
                    $this->_request->getParam('pasteid'),
                    $this->_request->getParam('deletetoken')
                );
                break;
            case 'read':
                $this->_read($this->_request->getParam('pasteid'));
                break;
            case 'jsonld':
                $this->_jsonld($this->_request->getParam('jsonld'));
                return;
        }

        // output JSON or HTML
        if ($this->_request->isJsonApiCall()) {
            header('Content-type: ' . Request::MIME_JSON);
            header('Access-Control-Allow-Origin: *');
            header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE');
            header('Access-Control-Allow-Headers: X-Requested-With, Content-Type');
            echo $this->_json;
        } else {
            $this->_view();
        }
    }

    /**
     * initialize PrivateBin
     *
     * @access private
     * @throws Exception
     */
    private function _init()
    {
        $this->_conf    = new Configuration;
        $this->_model   = new Model($this->_conf);
        $this->_request = new Request;
        $this->_urlBase = $this->_request->getRequestUri();
        ServerSalt::setPath($this->_conf->getKey('dir', 'traffic'));

        // set default language
        $lang = $this->_conf->getKey('languagedefault');
        I18n::setLanguageFallback($lang);
        // force default language, if language selection is disabled and a default is set
        if (!$this->_conf->getKey('languageselection') && strlen($lang) == 2) {
            $_COOKIE['lang'] = $lang;
            setcookie('lang', $lang);
        }
    }

    /**
     * Store new paste or comment
     *
     * POST contains one or both:
     * data = json encoded FormatV2 encrypted text (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
     * attachment = json encoded FormatV2 encrypted text (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
     *
     * All optional data will go to meta information:
     * expire (optional) = expiration delay (never,5min,10min,1hour,1day,1week,1month,1year,burn) (default:never)
     * formatter (optional) = format to display the paste as (plaintext,syntaxhighlighting,markdown) (default:syntaxhighlighting)
     * burnafterreading (optional) = if this paste may only viewed once ? (0/1) (default:0)
     * opendiscusssion (optional) = is the discussion allowed on this paste ? (0/1) (default:0)
     * attachmentname = json encoded FormatV2 encrypted text (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
     * nickname (optional) = in discussion, encoded FormatV2 encrypted text nickname of author of comment (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
     * parentid (optional) = in discussion, which comment this comment replies to.
     * pasteid (optional) = in discussion, which paste this comment belongs to.
     *
     * @access private
     * @return string
     */
    private function _create()
    {
        // Ensure last paste from visitors IP address was more than configured amount of seconds ago.
        TrafficLimiter::setConfiguration($this->_conf);
        if (!TrafficLimiter::canPass()) {
            return $this->_return_message(
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                1, I18n::_(
                    'Please wait %d seconds between each post.',
                    $this->_conf->getKey('limit', 'traffic')
                )
            );
        }

        $data      = $this->_request->getData();
        $isComment = array_key_exists('pasteid', $data) &&
            !empty($data['pasteid']) &&
            array_key_exists('parentid', $data) &&
            !empty($data['parentid']);
        if (!FormatV2::isValid($data, $isComment)) {
            return $this->_return_message(1, I18n::_('Invalid data.'));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }
        $sizelimit = $this->_conf->getKey('sizelimit');
        // Ensure content is not too big.
        if (strlen($data['ct']) > $sizelimit) {
            return $this->_return_message(
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                1,
                I18n::_(
                    'Paste is limited to %s of encrypted data.',
                    Filter::formatHumanReadableSize($sizelimit)
                )
            );
        }

        // The user posts a comment.
        if ($isComment) {
            $paste = $this->_model->getPaste($data['pasteid']);
            if ($paste->exists()) {
                try {
                    $comment = $paste->getComment($data['parentid']);
                    $comment->setData($data);
                    $comment->store();
                } catch (Exception $e) {
                    return $this->_return_message(1, $e->getMessage());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                }
                $this->_return_message(0, $comment->getId());
            } else {
                $this->_return_message(1, I18n::_('Invalid data.'));
            }
        }
        // The user posts a standard paste.
        else {
            $this->_model->purge();
            $paste = $this->_model->getPaste();
            try {
                $paste->setData($data);
                $paste->store();
            } catch (Exception $e) {
                return $this->_return_message(1, $e->getMessage());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            }
            $this->_return_message(0, $paste->getId(), array('deletetoken' => $paste->getDeleteToken()));
        }
    }

    /**
     * Delete an existing paste
     *
     * @access private
     * @param  string $dataid
     * @param  string $deletetoken
     */
    private function _delete($dataid, $deletetoken)
    {
        try {
            $paste = $this->_model->getPaste($dataid);
            if ($paste->exists()) {
                // accessing this method ensures that the paste would be
                // deleted if it has already expired
                $paste->get();
                if (
                    Filter::slowEquals($deletetoken, $paste->getDeleteToken())
                ) {
                    // Paste exists and deletion token is valid: Delete the paste.
                    $paste->delete();
                    $this->_status = 'Paste was properly deleted.';
                } else {
                    $this->_error = 'Wrong deletion token. Paste was not deleted.';
                }
            } else {
                $this->_error = self::GENERIC_ERROR;
            }
        } catch (Exception $e) {
            $this->_error = $e->getMessage();
        }
        if ($this->_request->isJsonApiCall()) {
            if (strlen($this->_error)) {
                $this->_return_message(1, $this->_error);
            } else {
                $this->_return_message(0, $dataid);
            }
        }
    }

    /**
     * Read an existing paste or comment, only allowed via a JSON API call
     *
     * @access private
     * @param  string $dataid
     */
    private function _read($dataid)
    {
        if (!$this->_request->isJsonApiCall()) {
            return;
        }

        try {
            $paste = $this->_model->getPaste($dataid);
            if ($paste->exists()) {
                $data = $paste->get();
                if (array_key_exists('salt', $data['meta'])) {
                    unset($data['meta']['salt']);
                }
                $this->_return_message(0, $dataid, (array) $data);
            } else {
                $this->_return_message(1, self::GENERIC_ERROR);
            }
        } catch (Exception $e) {
            $this->_return_message(1, $e->getMessage());
        }
    }

    /**
     * Display frontend.
     *
     * @access private
     */
    private function _view()
    {
        // set headers to disable caching
        $time = gmdate('D, d M Y H:i:s \G\M\T');
        header('Cache-Control: no-store, no-cache, no-transform, must-revalidate');
        header('Pragma: no-cache');
        header('Expires: ' . $time);
        header('Last-Modified: ' . $time);
        header('Vary: Accept');
        header('Content-Security-Policy: ' . $this->_conf->getKey('cspheader'));
        header('X-Xss-Protection: 1; mode=block');
        header('X-Frame-Options: DENY');
        header('X-Content-Type-Options: nosniff');

        // label all the expiration options
        $expire = array();
        foreach ($this->_conf->getSection('expire_options') as $time => $seconds) {
            $expire[$time] = ($seconds == 0) ? I18n::_(ucfirst($time)) : Filter::formatHumanReadableTime($time);
        }

        // translate all the formatter options
        $formatters = array_map('PrivateBin\\I18n::_', $this->_conf->getSection('formatter_options'));

        // set language cookie if that functionality was enabled
        $languageselection = '';
        if ($this->_conf->getKey('languageselection')) {
            $languageselection = I18n::getLanguage();
            setcookie('lang', $languageselection);
        }

        $page = new View;
        $page->assign('NAME', $this->_conf->getKey('name'));
        $page->assign('ERROR', I18n::_($this->_error));
        $page->assign('STATUS', I18n::_($this->_status));
        $page->assign('VERSION', self::VERSION);
        $page->assign('DISCUSSION', $this->_conf->getKey('discussion'));
        $page->assign('OPENDISCUSSION', $this->_conf->getKey('opendiscussion'));
        $page->assign('MARKDOWN', array_key_exists('markdown', $formatters));
        $page->assign('SYNTAXHIGHLIGHTING', array_key_exists('syntaxhighlighting', $formatters));
        $page->assign('SYNTAXHIGHLIGHTINGTHEME', $this->_conf->getKey('syntaxhighlightingtheme'));
        $page->assign('FORMATTER', $formatters);
        $page->assign('FORMATTERDEFAULT', $this->_conf->getKey('defaultformatter'));
        $page->assign('NOTICE', I18n::_($this->_conf->getKey('notice')));
        $page->assign('BURNAFTERREADINGSELECTED', $this->_conf->getKey('burnafterreadingselected'));
        $page->assign('PASSWORD', $this->_conf->getKey('password'));
        $page->assign('FILEUPLOAD', $this->_conf->getKey('fileupload'));
        $page->assign('ZEROBINCOMPATIBILITY', $this->_conf->getKey('zerobincompatibility'));
        $page->assign('LANGUAGESELECTION', $languageselection);
        $page->assign('LANGUAGES', I18n::getLanguageLabels(I18n::getAvailableLanguages()));
        $page->assign('EXPIRE', $expire);
        $page->assign('EXPIREDEFAULT', $this->_conf->getKey('default', 'expire'));
        $page->assign('URLSHORTENER', $this->_conf->getKey('urlshortener'));
        $page->assign('QRCODE', $this->_conf->getKey('qrcode'));
        $page->draw($this->_conf->getKey('template'));
    }

    /**
     * outputs requested JSON-LD context
     *
     * @access private
     * @param string $type
     */
    private function _jsonld($type)
    {
        if (
            $type !== 'paste' && $type !== 'comment' &&
            $type !== 'pastemeta' && $type !== 'commentmeta'
        ) {
            $type = '';
        }
        $content = '{}';
        $file    = PUBLIC_PATH . DIRECTORY_SEPARATOR . 'js' . DIRECTORY_SEPARATOR . $type . '.jsonld';
        if (is_readable($file)) {
            $content = str_replace(
                '?jsonld=',
                $this->_urlBase . '?jsonld=',
                file_get_contents($file)
            );
        }

        header('Content-type: application/ld+json');
        header('Access-Control-Allow-Origin: *');
        header('Access-Control-Allow-Methods: GET');
        echo $content;
    }

    /**
     * prepares JSON encoded status message
     *
     * @access private
     * @param  int $status
     * @param  string $message
     * @param  array $other
     */
    private function _return_message($status, $message, $other = array())
    {
        $result = array('status' => $status);
        if ($status) {
            $result['message'] = I18n::_($message);
        } else {
            $result['id']  = $message;
            $result['url'] = $this->_urlBase . '?' . $message;
        }
        $result += $other;
        $this->_json = Json::encode($result);
    }
}


1		<?php
2		/**
3		* PrivateBin
4		*
5		* a zero-knowledge paste bin
6		*
7		* @link https://github.com/PrivateBin/PrivateBin
8		* @copyright 2012 Sébastien SAUVAGE (sebsauvage.net)
9		* @license https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
10		* @version 1.2.1
11		*/
12
13		namespace PrivateBin;
14
15		use Exception;
16		use PrivateBin\Persistence\ServerSalt;
17		use PrivateBin\Persistence\TrafficLimiter;
18
19		/**
20		* Controller
21		*
22		* Puts it all together.
23		*/
24		class Controller
25		{
26		/**
27		* version
28		*
29		* @const string
30		*/
31		const VERSION = '1.2.1';
32
33		/**
34		* minimal required PHP version
35		*
36		* @const string
37		*/
38		const MIN_PHP_VERSION = '5.4.0';
39
40		/**
41		* show the same error message if the paste expired or does not exist
42		*
43		* @const string
44		*/
45		const GENERIC_ERROR = 'Paste does not exist, has expired or has been deleted.';
46
47		/**
48		* configuration
49		*
50		* @access private
51		* @var Configuration
52		*/
53		private $_conf;
54
55		/**
56		* error message
57		*
58		* @access private
59		* @var string
60		*/
61		private $_error = '';
62
63		/**
64		* status message
65		*
66		* @access private
67		* @var string
68		*/
69		private $_status = '';
70
71		/**
72		* JSON message
73		*
74		* @access private
75		* @var string
76		*/
77		private $_json = '';
78
79		/**
80		* Factory of instance models
81		*
82		* @access private
83		* @var model
84		*/
85		private $_model;
86
87		/**
88		* request
89		*
90		* @access private
91		* @var request
92		*/
93		private $_request;
94
95		/**
96		* URL base
97		*
98		* @access private
99		* @var string
100		*/
101		private $_urlBase;
102
103		/**
104		* constructor
105		*
106		* initializes and runs PrivateBin
107		*
108		* @access public
109		* @throws Exception
110		*/
111	84	public function __construct()
112		{
113	84	if (version_compare(PHP_VERSION, self::MIN_PHP_VERSION) < 0) {
114		throw new Exception(I18n::_('%s requires php %s or above to work. Sorry.', I18n::_('PrivateBin'), self::MIN_PHP_VERSION), 1);
115		}
116	84	if (strlen(PATH) < 0 && substr(PATH, -1) !== DIRECTORY_SEPARATOR) {
117		throw new Exception(I18n::_('%s requires the PATH to end in a "%s". Please update the PATH in your index.php.', I18n::_('PrivateBin'), DIRECTORY_SEPARATOR), 5);
118		}
119
120		// load config from ini file, initialize required classes
121	84	$this->_init();
122
123	80	switch ($this->_request->getOperation()) {
124	80	case 'create':
125	36	$this->_create();
126	36	break;
127	44	case 'delete':
128	16	$this->_delete(
129	16	$this->_request->getParam('pasteid'),
130	16	$this->_request->getParam('deletetoken')
131		);
132	16	break;
133	28	case 'read':
134	15	$this->_read($this->_request->getParam('pasteid'));
135	15	break;
136	13	case 'jsonld':
137	5	$this->_jsonld($this->_request->getParam('jsonld'));
138	5	return;
139		}
140
141		// output JSON or HTML
142	75	if ($this->_request->isJsonApiCall()) {
143	55	header('Content-type: ' . Request::MIME_JSON);
144	55	header('Access-Control-Allow-Origin: *');
145	55	header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE');
146	55	header('Access-Control-Allow-Headers: X-Requested-With, Content-Type');
147	55	echo $this->_json;
148		} else {
149	20	$this->_view();
150		}
151	75	}
152
153		/**
154		* initialize PrivateBin
155		*
156		* @access private
157		* @throws Exception
158		*/
159	84	private function _init()
160		{
161	84	$this->_conf = new Configuration;
162	82	$this->_model = new Model($this->_conf);
163	82	$this->_request = new Request;
164	80	$this->_urlBase = $this->_request->getRequestUri();
165	80	ServerSalt::setPath($this->_conf->getKey('dir', 'traffic'));
166
167		// set default language
168	80	$lang = $this->_conf->getKey('languagedefault');
169	80	I18n::setLanguageFallback($lang);
170		// force default language, if language selection is disabled and a default is set
171	80	if (!$this->_conf->getKey('languageselection') && strlen($lang) == 2) {
172	2	$_COOKIE['lang'] = $lang;
173	2	setcookie('lang', $lang);
174		}
175	80	}
176
177		/**
178		* Store new paste or comment
179		*
180		* POST contains one or both:
181		* data = json encoded FormatV2 encrypted text (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
182		* attachment = json encoded FormatV2 encrypted text (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
183		*
184		* All optional data will go to meta information:
185		* expire (optional) = expiration delay (never,5min,10min,1hour,1day,1week,1month,1year,burn) (default:never)
186		* formatter (optional) = format to display the paste as (plaintext,syntaxhighlighting,markdown) (default:syntaxhighlighting)
187		* burnafterreading (optional) = if this paste may only viewed once ? (0/1) (default:0)
188		* opendiscusssion (optional) = is the discussion allowed on this paste ? (0/1) (default:0)
189		* attachmentname = json encoded FormatV2 encrypted text (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
190		* nickname (optional) = in discussion, encoded FormatV2 encrypted text nickname of author of comment (containing keys: iv,v,iter,ks,ts,mode,adata,cipher,salt,ct)
191		* parentid (optional) = in discussion, which comment this comment replies to.
192		* pasteid (optional) = in discussion, which paste this comment belongs to.
193		*
194		* @access private
195		* @return string
196		*/
197	36	private function _create()
198		{
199		// Ensure last paste from visitors IP address was more than configured amount of seconds ago.
200	36	TrafficLimiter::setConfiguration($this->_conf);
201	36	if (!TrafficLimiter::canPass()) {
202	2	return $this->_return_message(
		0 ignored issues – show Bug introduced 2018-07-29 14:15 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->_return_message(1...y('limit', 'traffic')))` targeting `PrivateBin\Controller::_return_message()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
203	2	1, I18n::_(
204	2	'Please wait %d seconds between each post.',
205	2	$this->_conf->getKey('limit', 'traffic')
206		)
207		);
208		}
209
210	36	$data = $this->_request->getData();
211	36	$isComment = array_key_exists('pasteid', $data) &&
212	36	!empty($data['pasteid']) &&
213	36	array_key_exists('parentid', $data) &&
214	36	!empty($data['parentid']);
215	36	if (!FormatV2::isValid($data, $isComment)) {
216		return $this->_return_message(1, I18n::_('Invalid data.'));
		0 ignored issues – show Bug introduced 2019-05-15 20:01 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->_return_message(1...8n::_('Invalid data.'))` targeting `PrivateBin\Controller::_return_message()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
217		}
218	36	$sizelimit = $this->_conf->getKey('sizelimit');
219		// Ensure content is not too big.
220	36	if (strlen($data['ct']) > $sizelimit) {
221	2	return $this->_return_message(
		0 ignored issues – show Bug introduced 2019-05-15 20:01 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->_return_message(1...dableSize($sizelimit)))` targeting `PrivateBin\Controller::_return_message()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
222	2	1,
223	2	I18n::_(
224	2	'Paste is limited to %s of encrypted data.',
225	2	Filter::formatHumanReadableSize($sizelimit)
226		)
227		);
228		}
229
230		// The user posts a comment.
231	34	if ($isComment) {
232	10	$paste = $this->_model->getPaste($data['pasteid']);
233	10	if ($paste->exists()) {
234		try {
235	8	$comment = $paste->getComment($data['parentid']);
236	6	$comment->setData($data);
237	6	$comment->store();
238	6	} catch (Exception $e) {
239	6	return $this->_return_message(1, $e->getMessage());
		0 ignored issues – show Bug introduced 2018-07-29 14:15 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->_return_message(1, $e->getMessage())` targeting `PrivateBin\Controller::_return_message()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
240		}
241	2	$this->_return_message(0, $comment->getId());
242		} else {
243	4	$this->_return_message(1, I18n::_('Invalid data.'));
244		}
245		}
246		// The user posts a standard paste.
247		else {
248	24	$this->_model->purge();
249	24	$paste = $this->_model->getPaste();
250		try {
251	24	$paste->setData($data);
252	20	$paste->store();
253	6	} catch (Exception $e) {
254	6	return $this->_return_message(1, $e->getMessage());
		0 ignored issues – show Bug introduced 2018-07-29 14:15 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->_return_message(1, $e->getMessage())` targeting `PrivateBin\Controller::_return_message()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
255		}
256	18	$this->_return_message(0, $paste->getId(), array('deletetoken' => $paste->getDeleteToken()));
257		}
258	22	}
259
260		/**
261		* Delete an existing paste
262		*
263		* @access private
264		* @param string $dataid
265		* @param string $deletetoken
266		*/
267	16	private function _delete($dataid, $deletetoken)
268		{
269		try {
270	16	$paste = $this->_model->getPaste($dataid);
271	14	if ($paste->exists()) {
272		// accessing this method ensures that the paste would be
273		// deleted if it has already expired
274	12	$paste->get();
275		if (
276	10	Filter::slowEquals($deletetoken, $paste->getDeleteToken())
277		) {
278		// Paste exists and deletion token is valid: Delete the paste.
279	6	$paste->delete();
280	6	$this->_status = 'Paste was properly deleted.';
281		} else {
282	10	$this->_error = 'Wrong deletion token. Paste was not deleted.';
283		}
284		} else {
285	12	$this->_error = self::GENERIC_ERROR;
286		}
287	4	} catch (Exception $e) {
288	4	$this->_error = $e->getMessage();
289		}
290	16	if ($this->_request->isJsonApiCall()) {
291	4	if (strlen($this->_error)) {
292	2	$this->_return_message(1, $this->_error);
293		} else {
294	2	$this->_return_message(0, $dataid);
295		}
296		}
297	16	}
298
299		/**
300		* Read an existing paste or comment, only allowed via a JSON API call
301		*
302		* @access private
303		* @param string $dataid
304		*/
305	15	private function _read($dataid)
306		{
307	15	if (!$this->_request->isJsonApiCall()) {
308		return;
309		}
310
311		try {
312	15	$paste = $this->_model->getPaste($dataid);
313	13	if ($paste->exists()) {
314	11	$data = $paste->get();
315	9	if (array_key_exists('salt', $data['meta'])) {
316	9	unset($data['meta']['salt']);
317		}
318	9	$this->_return_message(0, $dataid, (array) $data);
319		} else {
320	11	$this->_return_message(1, self::GENERIC_ERROR);
321		}
322	4	} catch (Exception $e) {
323	4	$this->_return_message(1, $e->getMessage());
324		}
325	15	}
326
327		/**
328		* Display frontend.
329		*
330		* @access private
331		*/
332	20	private function _view()
333		{
334		// set headers to disable caching
335	20	$time = gmdate('D, d M Y H:i:s \G\M\T');
336	20	header('Cache-Control: no-store, no-cache, no-transform, must-revalidate');
337	20	header('Pragma: no-cache');
338	20	header('Expires: ' . $time);
339	20	header('Last-Modified: ' . $time);
340	20	header('Vary: Accept');
341	20	header('Content-Security-Policy: ' . $this->_conf->getKey('cspheader'));
342	20	header('X-Xss-Protection: 1; mode=block');
343	20	header('X-Frame-Options: DENY');
344	20	header('X-Content-Type-Options: nosniff');
345
346		// label all the expiration options
347	20	$expire = array();
348	20	foreach ($this->_conf->getSection('expire_options') as $time => $seconds) {
349	20	$expire[$time] = ($seconds == 0) ? I18n::_(ucfirst($time)) : Filter::formatHumanReadableTime($time);
350		}
351
352		// translate all the formatter options
353	20	$formatters = array_map('PrivateBin\\I18n::_', $this->_conf->getSection('formatter_options'));
354
355		// set language cookie if that functionality was enabled
356	20	$languageselection = '';
357	20	if ($this->_conf->getKey('languageselection')) {
358	2	$languageselection = I18n::getLanguage();
359	2	setcookie('lang', $languageselection);
360		}
361
362	20	$page = new View;
363	20	$page->assign('NAME', $this->_conf->getKey('name'));
364	20	$page->assign('ERROR', I18n::_($this->_error));
365	20	$page->assign('STATUS', I18n::_($this->_status));
366	20	$page->assign('VERSION', self::VERSION);
367	20	$page->assign('DISCUSSION', $this->_conf->getKey('discussion'));
368	20	$page->assign('OPENDISCUSSION', $this->_conf->getKey('opendiscussion'));
369	20	$page->assign('MARKDOWN', array_key_exists('markdown', $formatters));
370	20	$page->assign('SYNTAXHIGHLIGHTING', array_key_exists('syntaxhighlighting', $formatters));
371	20	$page->assign('SYNTAXHIGHLIGHTINGTHEME', $this->_conf->getKey('syntaxhighlightingtheme'));
372	20	$page->assign('FORMATTER', $formatters);
373	20	$page->assign('FORMATTERDEFAULT', $this->_conf->getKey('defaultformatter'));
374	20	$page->assign('NOTICE', I18n::_($this->_conf->getKey('notice')));
375	20	$page->assign('BURNAFTERREADINGSELECTED', $this->_conf->getKey('burnafterreadingselected'));
376	20	$page->assign('PASSWORD', $this->_conf->getKey('password'));
377	20	$page->assign('FILEUPLOAD', $this->_conf->getKey('fileupload'));
378	20	$page->assign('ZEROBINCOMPATIBILITY', $this->_conf->getKey('zerobincompatibility'));
379	20	$page->assign('LANGUAGESELECTION', $languageselection);
380	20	$page->assign('LANGUAGES', I18n::getLanguageLabels(I18n::getAvailableLanguages()));
381	20	$page->assign('EXPIRE', $expire);
382	20	$page->assign('EXPIREDEFAULT', $this->_conf->getKey('default', 'expire'));
383	20	$page->assign('URLSHORTENER', $this->_conf->getKey('urlshortener'));
384	20	$page->assign('QRCODE', $this->_conf->getKey('qrcode'));
385	20	$page->draw($this->_conf->getKey('template'));
386	20	}
387
388		/**
389		* outputs requested JSON-LD context
390		*
391		* @access private
392		* @param string $type
393		*/
394	5	private function _jsonld($type)
395		{
396		if (
397	5	$type !== 'paste' && $type !== 'comment' &&
398	5	$type !== 'pastemeta' && $type !== 'commentmeta'
399		) {
400	1	$type = '';
401		}
402	5	$content = '{}';
403	5	$file = PUBLIC_PATH . DIRECTORY_SEPARATOR . 'js' . DIRECTORY_SEPARATOR . $type . '.jsonld';
404	5	if (is_readable($file)) {
405	4	$content = str_replace(
406	4	'?jsonld=',
407	4	$this->_urlBase . '?jsonld=',
408	4	file_get_contents($file)
409		);
410		}
411
412	5	header('Content-type: application/ld+json');
413	5	header('Access-Control-Allow-Origin: *');
414	5	header('Access-Control-Allow-Methods: GET');
415	5	echo $content;
416	5	}
417
418		/**
419		* prepares JSON encoded status message
420		*
421		* @access private
422		* @param int $status
423		* @param string $message
424		* @param array $other
425		*/
426	55	private function _return_message($status, $message, $other = array())
427		{
428	55	$result = array('status' => $status);
429	55	if ($status) {
430	26	$result['message'] = I18n::_($message);
431		} else {
432	31	$result['id'] = $message;
433	31	$result['url'] = $this->_urlBase . '?' . $message;
434		}
435	55	$result += $other;
436	55	$this->_json = Json::encode($result);
437	55	}
438		}
439

PrivateBin / PrivateBin

Pull Request — master (#431)

Controller::_create() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like