OcSmarty::display() - Code Metrics - Inspection of "Merge pull request #789 from following5/patch-3" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — next ( 5f2bc0...cef70f )

by Thomas
created 2020-09-08 06:40 UTC
OcSmarty::display() F

↳ Parent: OcSmarty
Complexity

Conditions	27
Paths	> 20000
Size

Total Lines
222
Duplication

Lines	5
Ratio	2.25 %
Importance

Changes
Metric	Value
cc	27
nc	2073600
nop	3
dl	5
loc	222
rs	0
c	0
b	0
f	0
How to fix Long Method Complexity

<?php
/***************************************************************************
 * for license information see LICENSE.md
 *  Inherit Smarty-Class and extend it
 ***************************************************************************/

use Oc\GeoCache\Enum\GeoCacheType;
use Oc\Util\CBench;

require_once __DIR__ . '/../vendor/autoload.php';
require_once __DIR__ . '/db.inc.php';
require_once __DIR__ . '/logic/labels.inc.php';

/**
 * Class OcSmarty
 */
class OcSmarty extends Smarty
{
    public $name = 'sys_nothing';
    public $main_template = 'sys_main';
    public $bench = null;
    public $compile_id = null;
    public $cache_id = null;    // This is a smarty caching ID, not a caches.cache_id.
    public $title = '';
    public $menuitem = null;
    public $nowpsearch = false;
    public $change_country_inpage = false;

    // no header, menu or footer
    public $popup = false;

    // show a thin border when using popup
    // disable popupmargin to appear fullscreen
    public $popupmargin = true;

    // url to call if login is required
    public $target = '';

    public $header_javascript = [];
    public $body_load = [];
    public $body_unload = [];

    /**
     * OcSmarty constructor.
     */
    public function __construct()
    {
        global $opt;
        $this->bench = new CBench();
        $this->bench->start();

        // configuration
        $this->template_dir = $opt['stylepath'];
        $this->compile_dir = __DIR__ . '/../var/cache2/smarty/compiled/';
        $this->cache_dir = __DIR__ . '/../var/cache2/smarty/cache/';
        $this->plugins_dir = [
            'plugins',
            __DIR__ . '/../src/OcLegacy/SmartyPlugins',
        ];

        // disable caching ... if caching is enabled, 1 hour is default
        $this->caching = 0;
        $this->cache_lifetime = 3600; // default

        // register additional functions
        require_once __DIR__ . '/../src/OcLegacy/SmartyPlugins/block.nocache.php';
        $this->register_block('nocache', 'smarty_block_nocache', false);
        $this->load_filter('pre', 't');

        // cache control
        if (($opt['debug'] & DEBUG_TEMPLATES) == DEBUG_TEMPLATES) {
            $this->force_compile = true;
        }

        // site maintenance
        if (($opt['debug'] & DEBUG_OUTOFSERVICE) == DEBUG_OUTOFSERVICE) {
            $this->name = 'sys_outofservice';
            $this->display();
        }

        /* set login target
         */
        if (isset($_REQUEST['target'])) {
            $this->target = trim($_REQUEST['target']);
            if (preg_match('/^https?:/i', $this->target)) {
                $this->target = '';
            }
        } else {
            $target = basename($_SERVER['PHP_SELF']) . '?';

            // REQUEST-Variablen durchlaufen und an target anhaengen
            foreach ($_REQUEST as $varname => $varvalue) {
                if (in_array($varname, $opt['logic']['targetvars'])) {
                    $target .= urlencode($varname) . '=' . urlencode($varvalue) . '&';
                }
            }

            if (mb_substr($target, -1) == '?' || mb_substr($target, -1) == '&') {
                $target = mb_substr($target, 0, -1);
            }

            $this->target = $target;
        }
    }

    /* ATTENTION: copied from internal implementation!
     * @param string $resource_name
     * @param string $compile_id
     */
    public function compile($resource_name, $compile_id = null): void
    {
        if (!isset($compile_id)) {
            $compile_id = $this->compile_id;
        }

        $this->_compile_id = $compile_id;

        // load filters that are marked as autoload
        if (count($this->autoload_filters)) {
            foreach ($this->autoload_filters as $_filter_type => $_filters) {
                foreach ($_filters as $_filter) {
                    $this->load_filter($_filter_type, $_filter);
                }
            }
        }

        $_smarty_compile_path = $this->_get_compile_path($resource_name);

        // if we just need to display the results, don't perform output
        // buffering - for speed
        $_cache_including = $this->_cache_including;
        $this->_cache_including = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        // compile the resource
        if (!$this->_is_compiled($resource_name, $_smarty_compile_path)) {
            $this->_compile_resource($resource_name, $_smarty_compile_path);
        }

        $this->_cache_including = $_cache_including;
    }

    /**
     * @param null|mixed $dummy1
     * @param null|mixed $dummy2
     * @param null|mixed $dummy3
     */
    public function display($dummy1 = null, $dummy2 = null, $dummy3 = null): void
    {
        global $opt, $db, $cookie, $login, $menu, $sqldebugger, $translate, $useragent_msie;
        $cookie->close();

        // if the user is an admin, don't cache the content
        if (isset($login)) {
            if ($login->admin) {
                $this->caching = 0;
            }
        }

        //Give Smarty access to the whole options array.
        $this->assign('siteSettings', $opt);
        $this->assign('GeoCacheTypeEvent', GeoCacheType::EVENT);

        //Should we remove this whole block since we now have
        //access using the siteSettings above?
        // assign main template vars
        // ... and some of the $opt
        $locale = $opt['template']['locale'];

        $optn = [];
        $optn['debug'] = $opt['debug'];
        $optn['template']['locales'] = $opt['template']['locales'];
        $optn['template']['locale'] = $opt['template']['locale'];
        $optn['template']['style'] = $opt['template']['style'];
        $optn['template']['country'] = $login->getUserCountry();

        $optn['page']['subtitle1'] = isset($opt['locale'][$locale]['page']['subtitle1']) ? $opt['locale'][$locale]['page']['subtitle1'] : $opt['page']['subtitle1'];
        $optn['page']['subtitle2'] = isset($opt['locale'][$locale]['page']['subtitle2']) ? $opt['locale'][$locale]['page']['subtitle2'] : $opt['page']['subtitle2'];
        $optn['page']['sitename'] = $opt['page']['sitename'];
        $optn['page']['headimagepath'] = $opt['page']['headimagepath'];
        $optn['page']['headoverlay'] = $opt['page']['headoverlay'];
        $optn['page']['max_logins_per_hour'] = $opt['page']['max_logins_per_hour'];
        $optn['page']['absolute_url'] = $opt['page']['absolute_url'];
        $optn['page']['absolute_urlpath'] = parse_url($opt['page']['absolute_url'], PHP_URL_PATH);
        $optn['page']['absolute_http_url'] = $opt['page']['absolute_http_url'];
        $optn['page']['default_absolute_url'] = $opt['page']['default_absolute_url'];
        $optn['page']['login_url'] = ($opt['page']['https']['force_login'] ? $opt['page']['absolute_https_url'] : '') . 'login.php';
        $optn['page']['target'] = $this->target;
        $optn['page']['showdonations'] = $opt['page']['showdonations'];
        $optn['page']['title'] = $opt['page']['title'];
        $optn['page']['nowpsearch'] = $this->nowpsearch;
        $optn['page']['header_javascript'] = $this->header_javascript;
        $optn['page']['body_load'] = $this->body_load;
        $optn['page']['body_unload'] = $this->body_unload;
        $optn['page']['sponsor'] = $opt['page']['sponsor'];
        $optn['page']['showsocialmedia'] = $opt['page']['showsocialmedia'];
        $optn['page']['main_country'] = $opt['page']['main_country'];
        $optn['page']['main_locale'] = $opt['page']['main_locale'];
        $optn['page']['meta'] = $opt['page']['meta'];
        $optn['page']['teampic_url'] = $opt['page']['teampic_url'];
        $optn['page']['teammember_url'] = $opt['page']['teammember_url'];
        $optn['template']['title'] = $this->title;
        $optn['template']['caching'] = $this->caching;
        $optn['template']['popup'] = $this->popup;
        $optn['template']['popupmargin'] = $this->popupmargin;
        $optn['format'] = $opt['locale'][$opt['template']['locale']]['format'];
        $optn['mail'] = $opt['mail'];
        $optn['lib'] = $opt['lib'];
        $optn['tracking'] = $opt['tracking'];
        $optn['geokrety'] = $opt['geokrety'];
        $optn['template']['usercountrieslist'] = labels::getLabels('usercountrieslist');
        $optn['help']['oconly'] = helppagelink('oconly', 'OConly');

        $optn['msie'] = $useragent_msie;

        $loginn = [
            'username' => '',
            'userid' => '',
            'admin' => '',
        ];

        if (isset($login)) {
            $loginn['username'] = $login->username;
            $loginn['userid'] = $login->userid;
            $loginn['admin'] = $login->admin;
        }

        // build menu
        if ($this->menuitem == null) {
            $menu->SetSelectItem(MNU_ROOT);
        } else {
            $menu->SetSelectItem($this->menuitem);
        }

        $this->assign('topmenu', $menu->getTopMenu());
        $this->assign('submenu', $menu->getSubMenu());
        $this->assign('breadcrumb', $menu->getBreadcrumb());
        $this->assign('menucolor', $menu->getMenuColor());
        $this->assign('helplink', helppagelink($this->name));
        $this->assign('change_country_inpage', $this->change_country_inpage);

        if ($this->title == '') {
            $optn['template']['title'] = $menu->GetMenuTitle();
        }

        // build address for switching locales and countries
        $base_pageadr = $_SERVER['REQUEST_URI'];

        // workaround for http://redmine.opencaching.de/issues/703
        $strange_things_pos = strpos($base_pageadr, '.php/');
        if ($strange_things_pos) {
            $base_pageadr = substr($base_pageadr, 0, $strange_things_pos + 4);
        }
        $lpos = strpos($base_pageadr, 'locale=');
        if ($this->change_country_inpage) {
            if (!$lpos) {
                $lpos = strpos($base_pageadr, 'usercountry=');
            }
            if (!$lpos) {
                $lpos = strpos($base_pageadr, 'country=');
            }
        }
        if ($lpos) {
            $base_pageadr = substr($base_pageadr, 0, $lpos);
        } else {
            $urx = explode('#', $base_pageadr);
            $base_pageadr = $urx[0];
            if (strpos($base_pageadr, '?') == 0) {
                $base_pageadr .= '?';
            } else {
                $base_pageadr .= '&';
            }
        }
        $this->assign('base_pageadr', $base_pageadr);

        if ($opt['logic']['license']['disclaimer']) {
            if (isset($opt['locale'][$locale]['page']['license_url'])) {
                $lurl = $opt['locale'][$locale]['page']['license_url'];
            } else {
                $lurl = $opt['locale']['EN']['page']['license_url'];
            }

            if (isset($opt['locale'][$locale]['page']['license'])) {
                $ltext = mb_ereg_replace(
                    '{site}',
                    $opt['page']['sitename'],
                    $opt['locale'][$locale]['page']['license']
                );
            } else {
                $ltext = $opt['locale']['EN']['page']['license'];
            }

            $this->assign('license_disclaimer', mb_ereg_replace('%1', $lurl, $ltext));
        } else {
            $this->assign('license_disclaimer', '');
        }

        $this->assign('opt', $optn);
        $this->assign('login', $loginn);

        if ($db['connected'] == true) {
            $this->assign('sys_dbconnected', true);
        } else {
            $this->assign('sys_dbconnected', false);
        }
        $this->assign('sys_dbslave', ($db['slave_id'] != -1));

        if ($this->template_exists($this->name . '.tpl')) {
            $this->assign('template', $this->name);
        } elseif ($this->name != 'sys_error') {
            $this->error(ERROR_TEMPLATE_NOT_FOUND);
        }

        $this->bench->stop();
        $this->assign('sys_runtime', $this->bench->diff());

        $this->assign(
            'screen_css_time',
            filemtime(__DIR__ . '/../resource2/' . $opt['template']['style'] . '/css/style_screen.css')
        );
        $this->assign(
            'screen_msie_css_time',
            filemtime(__DIR__ . '/../resource2/' . $opt['template']['style'] . '/css/style_screen_msie.css')
        );
        $this->assign(
            'print_css_time',
            filemtime(__DIR__ . '/../resource2/' . $opt['template']['style'] . '/css/style_print.css')
        );

        // check if the template is compiled
        // if not, check if translation works correct
        $_smarty_compile_path = $this->_get_compile_path($this->name);
        if (!$this->_is_compiled($this->name, $_smarty_compile_path) && $this->name != 'error') {
            $internal_lang = $translate->t('INTERNAL_LANG', 'all', 'OcSmarty.class.php', '');
            if (($internal_lang != $opt['template']['locale']) && ($internal_lang != 'INTERNAL_LANG')) {
                $this->error(ERROR_COMPILATION_FAILED);
            }
        }

        if ($this->is_cached() == true) {
            $this->assign('sys_cached', true);
        } else {
            $this->assign('sys_cached', false);
        }

        if ($db['debug'] === true) {
            parent::fetch($this->main_template . '.tpl', $this->get_cache_id(), $this->get_compile_id());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

            $this->clear_all_assign();
            $this->main_template = 'sys_sqldebugger';
            $this->assign('commands', $sqldebugger->getCommands());
            $this->assign('cancel', $sqldebugger->getCancel());
            unset($sqldebugger);

            $this->assign('opt', $optn);
            $this->assign('login', $loginn);

            $this->caching = 0;

            // unset sqldebugger to allow proper translation of sqldebugger template
            $opt['debug'] = $opt['debug'] & ~DEBUG_SQLDEBUGGER;

            $this->header();
            parent::display($this->main_template . '.tpl');
        } else {
            $this->header();
            parent::display($this->main_template . '.tpl', $this->get_cache_id(), $this->get_compile_id());
        }

        exit;
    }

    /**
     * show an error dialog
     *
     * @param int $id
     */
    public function error($id): void
    {
        $this->clear_all_assign();
        $this->caching = 0;

        $this->assign('page', $this->name);
        $this->assign('id', $id);

        if ($this->menuitem == null) {
            $this->menuitem = MNU_ERROR;
        }

        $args = func_get_args();
        unset($args[0]);
        for ($i = 1; isset($args[$i]); $i++) {
            $this->assign('p' . $i, $args[$i]);
        }

        $this->name = 'error';
        $this->display();
    }

    /**
     * check if this template is valid
     *
     * @param null|mixed $dummy1
     * @param null|mixed $dummy2
     * @param null|mixed $dummy3
     * @return bool|false|string
     */
    public function is_cached($dummy1 = null, $dummy2 = null, $dummy3 = null)
    {
        global $login;

        // if the user is an admin, dont cache the content
        if (isset($login)) {
            if ($login->admin) {
                return false;
            }
        }

        return parent::is_cached($this->main_template . '.tpl', $this->get_cache_id(), $this->get_compile_id());
    }

    /**
     * @return string
     */
    public function get_cache_id()
    {
        // $cache_id can be directly supplied from unverified user input (URL params).
        // Probably this is no safety or stability issue, but to be sure we restrict
        // the ID to a reasonable set of characters:

        return $this->name . '|' . mb_ereg_replace('/[^A-Za-z0-9_\|\-\.]/', '', $this->cache_id);
    }

    /**
     * @return string
     */
    public function get_compile_id()
    {
        global $opt;

        return $opt['template']['style'] . '|' . $opt['template']['locale'] . '|' . $this->compile_id;
    }

    /**
     * @param string $page
     */
    public function redirect($page): void
    {
        global $cookie, $opt;
        $cookie->close();

        // close db-connection
        sql_disconnect();


        $this->header();

        if (strpos($page, "\n") !== false) {
            $page = substr($page, 0, strpos($page, "\n"));
        }

        // redirect
        if (!preg_match('/^https?:/i', $page)) {
            if (substr($page, 0, 1) == '/') {
                $page = substr($page, 1);
            }
            $page = $opt['page']['absolute_url'] . $page;
        }


        header('Location: ' . $page);
        exit;
    }

    /**
     * redirect login function
     */
    public function redirect_login(): void
    {
        global $opt;

        // we cannot redirect the POST-data
        if (count($_POST) > 0) {
            $this->error(ERROR_LOGIN_REQUIRED);
        }

        // ok ... redirect the get-data
        $target = ($opt['page']['https']['force_login'] ? 'https' : $opt['page']['protocol'])
            . '://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
        $this->redirect('login.php?target=' . urlencode($target));
    }

    /**
     * @param $name
     * @param $rs
     */
    public function assign_rs($name, $rs): void

    {
        $items = [];
        while ($r = sql_fetch_assoc($rs)) {

            $items[] = $r;
        }
        $this->assign($name, $items);
    }

    /**
     * @param $src
     */
    public function add_header_javascript($src): void
    {
        $this->header_javascript[] = $src;
    }

    /**
     * @param $script
     */
    public function add_body_load($script): void
    {
        $this->body_load[] = $script;
    }

    /**
     * @param $script
     */
    public function add_body_unload($script): void
    {
        $this->body_unload[] = $script;
    }

    /**
     * setting http header
     */
    public function header(): void
    {
        global $opt;
        global $cookie;

        if ($opt['gui'] == GUI_HTML) {
            // charset setzen
            header('Content-type: text/html; charset=utf-8');

            // HTTP/1.1
            header('Cache-Control: no-store, no-cache, must-revalidate');
            header('Cache-Control: post-check=0, pre-check=0', false);
            // HTTP/1.0
            header('Pragma: no-cache');
            // Date in the past
            header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
            // always modified
            header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');

            // set the cookie
            $cookie->header();
        }
    }

    /**
     * - trim target and strip newlines
     * - use sDefault if sTarget is absolute and sDefault!=null
     *
     * @param $sTarget
     * @param null|mixed $sDefault
     * @return null|string
     */
    public function checkTarget($sTarget, $sDefault = null)
    {
        if (mb_strpos($sTarget, "\n") !== false) {
            $sTarget = mb_substr($sTarget, 0, mb_strpos($sTarget, "\n"));
        }

        $sTarget = mb_trim($sTarget);

        if (mb_strtolower(mb_substr($sTarget, 0, 7)) == 'http://' || $sTarget == '') {
            if ($sDefault != null) {
                return $sDefault;
            }
        }

        return $sTarget;
    }

    public function acceptsAndPurifiesHtmlInput(): void
    {
        // Prevent false XSS detection of harmless HTML code
        // see https://redmine.opencaching.de/issues/1137
        // see https://stackoverflow.com/questions/43249998/chrome-err-blocked-by-xss-auditor-details

        // XSS protection can be safely disabled if user-supplied content cannot inject JavaScript,
        // see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
        // This is ensured by HTMLpurifier in OC code.

        header('X-XSS-Protection: 0');
    }
}

OpencachingDeutschland / oc-server3

Push — next ( 5f2bc0...cef70f )

OcSmarty::display() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
