XoopsGTicket::XoopsGTicket() - Code Metrics - Inspection of "cleanup" - XoopsModules25x/mylinks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Michael

created 2016-04-26 05:20 UTC

XoopsGTicket::XoopsGTicket() B

↳ Parent: XoopsGTicket

Complexity

Conditions	6
Paths	6

Size

Total Lines	23
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	23
rs	8.5906
cc	6
eloc	14
nc	6
nop	0

<?php

// GIJOE's Ticket Class (based on Marijuana's Oreteki XOOPS)
// nobunobu's suggestions are applied

if (!class_exists('XoopsGTicket')) {

class XoopsGTicket {
namespace YourVendor;

class YourClass { }

    var $_errors = array();
class A {
    var $property;
}
    var $_latest_token = '';
class A {
    var $property;
}
    var $messages = array();
class A {
    var $property;
}

    function __construct()

    {
        global $xoopsConfig;
function myFunction($a, $b) {
    // Do something
}

        // language file
        if (defined('XOOPS_ROOT_PATH') && !empty($xoopsConfig['language']) && !strstr($xoopsConfig['language'], '/')) {
            if (file_exists(dirname(__DIR__) . '/language/' . $xoopsConfig['language'] . '/gticket_messages.phtml')) {
                include dirname(__DIR__) . '/language/' . $xoopsConfig['language'] . '/gticket_messages.phtml';
            }
        }

        // default messages
        if(empty($this->messages)) $this->messages = array(
            'err_general' => 'GTicket Error' ,
            'err_nostubs' => 'No stubs found' ,
            'err_noticket' => 'No ticket found' ,
            'err_nopair' => 'No valid ticket-stub pair found' ,
            'err_timeout' => 'Time out' ,
            'err_areaorref' => 'Invalid area or referer' ,
            'fmt_prompt4repost' => 'error(s) found:<br><span style="background-color:red;font-weight:bold;color:white;">%s</span><br>Confirm it.<br>And do you want to post again?' ,
            'btn_repost' => 'repost' ,
        );
    }

    // render form as plain html
    function getTicketHtml($salt = '', $timeout = 1800, $area = '')

    {
        return '<input type="hidden" name="XOOPS_G_TICKET" value="' . $this->issue($salt, $timeout, $area) . '">';
    }

    // returns an object of XoopsFormHidden including theh ticket
    function getTicketXoopsForm($salt = '', $timeout = 1800, $area = '')

    {
        return new XoopsFormHidden('XOOPS_G_TICKET', $this->issue($salt, $timeout, $area));
    }

    // add a ticket as Hidden Element into XoopsForm
    function addTicketXoopsFormElement(&$form, $salt = '', $timeout = 1800, $area = '')

    {
        $form->addElement(new XoopsFormHidden('XOOPS_G_TICKET', $this->issue($salt, $timeout, $area)));
    }

    // returns an array for xoops_confirm();

    function getTicketArray($salt = '', $timeout = 1800, $area = '')

    {
        return array('XOOPS_G_TICKET' => $this->issue($salt, $timeout, $area));
    }

    // return GET parameter string.
    function getTicketParamString($salt = '', $noamp = false, $timeout=1800, $area = '')

    {
        return ($noamp ? '' : '&amp;') . 'XOOPS_G_TICKET=' . $this->issue($salt, $timeout, $area);
    }

    // issue a ticket
    function issue($salt = '', $timeout = 1800, $area = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}

        // create a token
        list($usec, $sec) = explode(' ', microtime());
        $appendix_salt = empty($_SERVER['PATH']) ? XOOPS_DB_NAME : $_SERVER['PATH'];
        $token = crypt( $salt . $usec . $appendix_salt . $sec );
        $this->_latest_token = $token;

        if (empty($_SESSION['XOOPS_G_STUBS'])) {
            $_SESSION['XOOPS_G_STUBS'] = array();
        }

        // limit max stubs 10
        if (sizeof($_SESSION['XOOPS_G_STUBS']) > 10) {
            $_SESSION['XOOPS_G_STUBS'] = array_slice( $_SESSION['XOOPS_G_STUBS'] , -10 );
        }

        // record referer if browser send it
        $referer = empty( $_SERVER['HTTP_REFERER'] ) ? '' : $_SERVER['REQUEST_URI'];

        // area as module's dirname
        if (!$area && is_object(@$xoopsModule)) {
            $area = $xoopsModule->getVar('dirname');
        }

        // store stub
        $_SESSION['XOOPS_G_STUBS'][] = array(
                                        'expire' => time() + $timeout ,
                                        'referer' => $referer ,
                                        'area' => $area ,
                                        'token' => $token
                                        );

        // paid md5ed token as a ticket
        return md5($token . XOOPS_DB_PREFIX);
    }

    // check a ticket
    function check($post = true, $area = '', $allow_repost = true)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}

        $this->_errors = array();

        // CHECK: stubs are not stored in session
        if (! is_array(@$_SESSION['XOOPS_G_STUBS'])) {
            $this->_errors[] = $this->messages['err_nostubs'];
            $_SESSION['XOOPS_G_STUBS'] = array();
        }

        // get key&val of the ticket from a user's query
        $ticket = $post ? @$_POST['XOOPS_G_TICKET'] : @$_GET['XOOPS_G_TICKET'];

        // CHECK: no tickets found
        if (empty($ticket)) {
            $this->_errors[] = $this->messages['err_noticket'];
        }

        // gargage collection & find a right stub
        $stubs_tmp = $_SESSION['XOOPS_G_STUBS'];
        $_SESSION['XOOPS_G_STUBS'] = array();
        foreach ($stubs_tmp as $stub) {
            // default lifetime 30min
            if ($stub['expire'] >= time()) {
                if (md5($stub['token'] . XOOPS_DB_PREFIX) === $ticket) {
                    $found_stub = $stub;
                } else {
                    // store the other valid stubs into session
                    $_SESSION['XOOPS_G_STUBS'][] = $stub;
                }
            } else {
                if (md5($stub['token'] . XOOPS_DB_PREFIX) === $ticket) {
                    // not CSRF but Time-Out
                    $timeout_flag = true;
                }
            }
        }

        // CHECK: the right stub found or not
        if (empty($found_stub)) {
            if (empty($timeout_flag)) {
                $this->_errors[] = $this->messages['err_nopair'];
            } else {
                $this->_errors[] = $this->messages['err_timeout'];
            }
        } else {

            // set area if necessary
            // area as module's dirname
            if (!$area && is_object(@$xoopsModule)) {
                $area = $xoopsModule->getVar('dirname');
            }

            // check area or referer
            if (@$found_stub['area'] == $area) {
                $area_check = true;
            }
            if (!empty($found_stub['referer'] ) && strstr(@$_SERVER['HTTP_REFERER'], $found_stub['referer'])) {
                $referer_check = true;
            }

            if (empty($area_check) && empty($referer_check)) { // loose
                $this->_errors[] = $this->messages['err_areaorref'];
            }
        }

        if (!empty($this->_errors)) {
            if ($allow_repost) {
                // repost form
                $this->draw_repost_form( $area );
                exit;

            } else {
                // failed
                $this->clear();
                return false;
            }
        } else {
            // all green
            return true;
        }
    }

    // draw form for repost
    function draw_repost_form($area = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // Notify which file is broken
        if (headers_sent()) {
            restore_error_handler();
            set_error_handler('GTicket_ErrorHandler4FindOutput');
            header('Dummy: for warning');
            restore_error_handler();
            exit;

        }

        error_reporting( 0 );
        while (ob_get_level()) {
            ob_end_clean();
        }

        $table = '<table>';
        $form = '<form action="?' . htmlspecialchars(@$_SERVER['QUERY_STRING'],ENT_QUOTES) . '" method="post" >';
        foreach ($_POST as $key => $val) {
            if ($key == 'XOOPS_G_TICKET') {
                continue;
            }
            if (get_magic_quotes_gpc()) {
                $key = stripslashes($key);
            }
            if (is_array($val)) {
                list($tmp_table, $tmp_form) = $this->extract_post_recursive( htmlspecialchars($key,ENT_QUOTES), $val);
                $table .= $tmp_table;
                $form .= $tmp_form;
            } else {
                if (get_magic_quotes_gpc()) {
                    $val = stripslashes($val);
                }
                $table .= '<tr><th>' . htmlspecialchars($key, ENT_QUOTES) . '</th><td>' . htmlspecialchars($val, ENT_QUOTES) . '</td></tr>'."\n";
                $form .= '<input type="hidden" name="' . htmlspecialchars($key, ENT_QUOTES) . '" value="'.htmlspecialchars($val, ENT_QUOTES) . '">'."\n";
            }
        }
        $table .= '</table>';
        $form .= $this->getTicketHtml(__LINE__, 300, $area) . '<input type="submit" value="' . $this->messages['btn_repost'] . '"></form>';

        echo '<html><head><title>' . $this->messages['err_general'] . '</title><style>table,td,th {border:solid black 1px; border-collapse:collapse;}</style></head><body>' . sprintf($this->messages['fmt_prompt4repost'], $this->getErrors()) . $table . $form . '</body></html>';
    }

    function extract_post_recursive($key_name, $tmp_array) {

        $table = '';
        $form = '';
        foreach ($tmp_array as $key => $val) {
            if (get_magic_quotes_gpc()) {
                $key = stripslashes($key);
            }
            if (is_array($val)) {
                list($tmp_table, $tmp_form) = $this->extract_post_recursive($key_name . '[' . htmlspecialchars($key, ENT_QUOTES) . ']', $val);
                $table .= $tmp_table;
                $form .= $tmp_form;
            } else {
                if (get_magic_quotes_gpc()) {
                    $val = stripslashes($val);
                }
                $table .= '<tr><th>' . $key_name . '[' . htmlspecialchars($key, ENT_QUOTES) . ']</th><td>' . htmlspecialchars($val, ENT_QUOTES) . '</td></tr>' . "\n";
                $form .= '<input type="hidden" name="'.$key_name.'['.htmlspecialchars($key,ENT_QUOTES).']" value="'.htmlspecialchars($val,ENT_QUOTES).'">'."\n";
            }
        }
        return array($table, $form);
    }


    // clear all stubs
    function clear()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $_SESSION['XOOPS_G_STUBS'] = array();
    }


    // Ticket Using
    function using()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!empty($_SESSION['XOOPS_G_STUBS'])) {
            return true;
        } else {
            return false;
        }
    }


    // return errors
    function getErrors($ashtml = true)

    {
        if ($ashtml) {
            $ret = '';
            foreach ($this->_errors as $msg) {
                $ret .= "{$msg}<br>\n";
            }
        } else {
            $ret = $this->_errors;
        }
        return $ret;
    }

// end of class
}

// create a instance in global scope
$GLOBALS['xoopsGTicket'] = new XoopsGTicket();

}

if (!function_exists('admin_refcheck')) {

    //Admin Referer Check By Marijuana(Rev.011)
    function admin_refcheck($chkref = '') {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
        if (empty($_SERVER['HTTP_REFERER'])) {
            return true;
        } else {
            $ref = $_SERVER['HTTP_REFERER'];
        }
        $cr = XOOPS_URL;
        if ($chkref != '') {
            $cr .= $chkref;
        }
        if (strpos($ref, $cr) !== 0) {
            return false;
        }
        return true;
    }
}

function GTicket_ErrorHandler4FindOutput($errNo, $errStr, $errFile, $errLine)

{
    if (preg_match('?' . preg_quote(XOOPS_ROOT_PATH) . '([^:]+)\:(\d+)?', $errStr, $regs)) {
        echo 'Irregular output! check the file ' . htmlspecialchars($regs[1]) . ' line ' . htmlspecialchars($regs[2]);
    } else {
        echo 'Irregular output! check language files etc.';
    }
    return;
}


Pull Request — master (#5)

XoopsGTicket::XoopsGTicket() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 7 and the first side effect is on line 295. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			// GIJOE's Ticket Class (based on Marijuana's Oreteki XOOPS)
3			// nobunobu's suggestions are applied
4
5			if (!class_exists('XoopsGTicket')) {
6
7			class XoopsGTicket {
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
8
9			var $_errors = array();
			0 ignored issues – show Coding Style introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$_errors`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
10			var $_latest_token = '';
			0 ignored issues – show Coding Style introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$_latest_token`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
11			var $messages = array();
			0 ignored issues – show Coding Style introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$messages`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
12
13			function __construct()
			0 ignored issues – show Best Practice introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
14			{
15			global $xoopsConfig;
			0 ignored issues – show Compatibility Best Practice introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
16
17			// language file
18			if (defined('XOOPS_ROOT_PATH') && !empty($xoopsConfig['language']) && !strstr($xoopsConfig['language'], '/')) {
19			if (file_exists(dirname(__DIR__) . '/language/' . $xoopsConfig['language'] . '/gticket_messages.phtml')) {
20			include dirname(__DIR__) . '/language/' . $xoopsConfig['language'] . '/gticket_messages.phtml';
21			}
22			}
23
24			// default messages
25			if(empty($this->messages)) $this->messages = array(
26			'err_general' => 'GTicket Error' ,
27			'err_nostubs' => 'No stubs found' ,
28			'err_noticket' => 'No ticket found' ,
29			'err_nopair' => 'No valid ticket-stub pair found' ,
30			'err_timeout' => 'Time out' ,
31			'err_areaorref' => 'Invalid area or referer' ,
32			'fmt_prompt4repost' => 'error(s) found:<br><span style="background-color:red;font-weight:bold;color:white;">%s</span><br>Confirm it.<br>And do you want to post again?' ,
33			'btn_repost' => 'repost' ,

XoopsModules25x / mylinks

Pull Request — master (#5)

XoopsGTicket::XoopsGTicket() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like