Theme::setupMenuContext() - Code Metrics - Inspection of "Theme" - elkarte/Elkarte - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — development (#2329)

by Joshua
created 2015-12-27 10:28 UTC
Theme::setupMenuContext() F

↳ Parent: Theme
Complexity

Conditions	65
Paths	> 20000
Size

Total Lines	386
Code Lines	262
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
dl	0
loc	386
rs	2
c	2
b	0
f	0
cc	65
eloc	262
nc	117969920
nop	0
How to fix Long Method Complexity

<?php


namespace Themes\DefaultTheme;

/**
 * The default theme
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * This software is a derived product, based on:
 *
 * Simple Machines Forum (SMF)
 * copyright:	2011 Simple Machines (http://www.simplemachines.org)
 * license:		BSD, See included LICENSE.TXT for terms and conditions.
 *
 * @version 1.1 dev
 *
 */

if (!defined('ELK'))
    die('No access...');

class Theme extends \Theme
{
    protected $id = 0;


    /**
     * This is the only template included in the sources.
     */
    function template_rawdata()

    {
        global $context;

        echo $context['raw_data'];
    }

    /**
     * The header template
     */
    function template_header()
// 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 $context, $settings;

        doSecurityChecks();

        $this->setupThemeContext();

        // Print stuff to prevent caching of pages (except on attachment errors, etc.)
        if (empty($context['no_last_modified']))
        {
            header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
            header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');

            // Are we debugging the template/html content?
            if ((!isset($_REQUEST['xml']) || !isset($_REQUEST['api'])) && isset($_GET['debug']) && !isBrowser('ie'))
                header('Content-Type: application/xhtml+xml');
            elseif (!isset($_REQUEST['xml']) || !isset($_REQUEST['api']))
                header('Content-Type: text/html; charset=UTF-8');
        }

        // Probably temporary ($_REQUEST['xml'] should be replaced by $_REQUEST['api'])

        if (isset($_REQUEST['api']) && $_REQUEST['api'] == 'json')
            header('Content-Type: application/json; charset=UTF-8');
        elseif (isset($_REQUEST['xml']) || isset($_REQUEST['api']))
            header('Content-Type: text/xml; charset=UTF-8');
        else
            header('Content-Type: text/html; charset=UTF-8');

        foreach (\Template_Layers::getInstance()->prepareContext() as $layer)
            loadSubTemplate($layer . '_above', 'ignore');

        if (isset($settings['use_default_images']) && $settings['use_default_images'] == 'defaults' && isset($settings['default_template']))
        {
            $settings['theme_url'] = $settings['default_theme_url'];
            $settings['images_url'] = $settings['default_images_url'];
            $settings['theme_dir'] = $settings['default_theme_dir'];
        }
    }

    /**
     * Show the copyright.
     */
    function theme_copyright()

    {
        global $forum_copyright;

        // Don't display copyright for things like SSI.
        if (!defined('FORUM_VERSION'))
            return;

        // Put in the version...
        $forum_copyright = replaceBasicActionUrl(sprintf($forum_copyright, FORUM_VERSION));

        echo '
					', $forum_copyright;
    }

    /**
     * The template footer
     */
    function template_footer()

    {
        global $context, $settings, $modSettings, $time_start;

        $db = database();

        // Show the load time?  (only makes sense for the footer.)
        $context['show_load_time'] = !empty($modSettings['timeLoadPageEnable']);
        $context['load_time'] = round(microtime(true) - $time_start, 3);
        $context['load_queries'] = $db->num_queries();

        if (isset($settings['use_default_images']) && $settings['use_default_images'] == 'defaults' && isset($settings['default_template']))
        {
            $settings['theme_url'] = $settings['actual_theme_url'];
            $settings['images_url'] = $settings['actual_images_url'];
            $settings['theme_dir'] = $settings['actual_theme_dir'];
        }

        foreach (\Template_Layers::getInstance()->reverseLayers() as $layer)
            loadSubTemplate($layer . '_below', 'ignore');

    }

    /**
     * Output the Javascript files
     *
     * What it does:
     * - tabbing in this function is to make the HTML source look proper
     * - outputs jQuery/jQueryUI from the proper source (local/CDN)
     * - if defered is set function will output all JS (source & inline) set to load at page end
     * - if the admin option to combine files is set, will use Combiner.class
     *
     * @param bool $do_defered = false
     */
    function template_javascript($do_defered = false)

    {
        global $context, $modSettings, $settings, $boardurl;

        // First up, load jQuery and jQuery UI
        if (isset($modSettings['jquery_source']) && !$do_defered)
        {
            // Using a specified version of jquery or what was shipped 2.1.4  / 1.11.4
            $jquery_version = (!empty($modSettings['jquery_default']) && !empty($modSettings['jquery_version'])) ? $modSettings['jquery_version'] : '2.1.4';
            $jqueryui_version = (!empty($modSettings['jqueryui_default']) && !empty($modSettings['jqueryui_version'])) ? $modSettings['jqueryui_version'] : '1.11.4';

            switch ($modSettings['jquery_source'])
            {
                // Only getting the files from the CDN?
                case 'cdn':
                    echo '
	<script src="https://ajax.googleapis.com/ajax/libs/jquery/' . $jquery_version . '/jquery.min.js" id="jquery"></script>',
                    (!empty($modSettings['jquery_include_ui']) ? '
	<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/' . $jqueryui_version . '/jquery-ui.min.js" id="jqueryui"></script>' : '');
                    break;
                // Just use the local file
                case 'local':
                    echo '
	<script src="', $settings['default_theme_url'], '/scripts/jquery-' . $jquery_version . '.min.js" id="jquery"></script>',
                    (!empty($modSettings['jquery_include_ui']) ? '
	<script src="' . $settings['default_theme_url'] . '/scripts/jquery-ui-' . $jqueryui_version . '.min.js" id="jqueryui"></script>' : '');
                    break;
                // CDN with local fallback
                case 'auto':
                    echo '
	<script src="https://ajax.googleapis.com/ajax/libs/jquery/' . $jquery_version . '/jquery.min.js" id="jquery"></script>',
                    (!empty($modSettings['jquery_include_ui']) ? '
	<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/' . $jqueryui_version . '/jquery-ui.min.js" id="jqueryui"></script>' : '');
                    echo '
	<script><!-- // --><![CDATA[
		window.jQuery || document.write(\'<script src="', $settings['default_theme_url'], '/scripts/jquery-' . $jquery_version . '.min.js"><\/script>\');',
                    (!empty($modSettings['jquery_include_ui']) ? '
		window.jQuery.ui || document.write(\'<script src="' . $settings['default_theme_url'] . '/scripts/jquery-ui-' . $jqueryui_version . '.min.js"><\/script>\')' : ''), '
	// ]]></script>';
                    break;
            }
        }

        // Use this hook to work with Javascript files and vars pre output
        call_integration_hook('pre_javascript_output');

        // Combine and minify javascript source files to save bandwidth and requests
        if (!empty($context['javascript_files']))
        {
            if (!empty($modSettings['minify_css_js']))
            {
                $combiner = new \Site_Combiner(CACHEDIR, $boardurl . '/cache');
                $combine_name = $combiner->site_js_combine($context['javascript_files'], $do_defered);

                call_integration_hook('post_javascript_combine', array(&$combine_name, $combiner));

                if (!empty($combine_name))
                    echo '
	<script src="', $combine_name, '" id="jscombined', $do_defered ? 'bottom' : 'top', '"></script>';
                // While we have Javascript files to place in the template
                foreach ($combiner->getSpares() as $id => $js_file)
                {
                    if ((!$do_defered && empty($js_file['options']['defer'])) || ($do_defered && !empty($js_file['options']['defer'])))
                        echo '
	<script src="', $js_file['filename'], '" id="', $id, '"', !empty($js_file['options']['async']) ? ' async="async"' : '', '></script>';
                }
            }
            else
            {
                // While we have Javascript files to place in the template
                foreach ($context['javascript_files'] as $id => $js_file)
                {
                    if ((!$do_defered && empty($js_file['options']['defer'])) || ($do_defered && !empty($js_file['options']['defer'])))
                        echo '
	<script src="', $js_file['filename'], '" id="', $id, '"', !empty($js_file['options']['async']) ? ' async="async"' : '', '></script>';
                }
            }
        }

        // Build the declared Javascript variables script
        $js_vars = array();
        if (!empty($context['javascript_vars']) && !$do_defered)
        {
            foreach ($context['javascript_vars'] as $var => $value)
                $js_vars[] = $var . ' = ' . $value;

            // nNewlines and tabs are here to make it look nice in the page source view, stripped if minimized though
            $context['javascript_inline']['standard'][] = 'var ' . implode(",\n\t\t\t", $js_vars) . ';';
        }

        // Inline JavaScript - Actually useful some times!
        if (!empty($context['javascript_inline']))
        {
            // Defered output waits until we are defering !
            if (!empty($context['javascript_inline']['defer']) && $do_defered)
            {
                // Combine them all in to one output
                $context['javascript_inline']['defer'] = array_map('trim', $context['javascript_inline']['defer']);
                $inline_defered_code = implode("\n\t\t", $context['javascript_inline']['defer']);

                // Output the defered script
                echo '
	<script><!-- // --><![CDATA[
		', $inline_defered_code, '
	// ]]></script>';
            }

            // Standard output, and our javascript vars, get output when we are not on a defered call
            if (!empty($context['javascript_inline']['standard']) && !$do_defered)
            {
                $context['javascript_inline']['standard'] = array_map('trim', $context['javascript_inline']['standard']);

                // And output the js vars and standard scripts to the page
                echo '
	<script><!-- // --><![CDATA[
		', implode("\n\t\t", $context['javascript_inline']['standard']), '
	// ]]></script>';
            }
        }
    }

    /**
     * Output the CSS files
     *
     * What it does:
     *  - If the admin option to combine files is set, will use Combiner.class
     */
    function template_css()

    {
        global $context, $modSettings, $boardurl;

        // Use this hook to work with CSS files pre output
        call_integration_hook('pre_css_output');

        // Combine and minify the CSS files to save bandwidth and requests?
        if (!empty($context['css_files']))
        {
            if (!empty($modSettings['minify_css_js']))
            {
                $combiner = new \Site_Combiner(CACHEDIR, $boardurl . '/cache');
                $combine_name = $combiner->site_css_combine($context['css_files']);

                call_integration_hook('post_css_combine', array(&$combine_name, $combiner));

                if (!empty($combine_name))
                    echo '
	<link rel="stylesheet" href="', $combine_name, '" id="csscombined" />';

                foreach ($combiner->getSpares() as $id => $file)
                    echo '
	<link rel="stylesheet" href="', $file['filename'], '" id="', $id,'" />';
            }
            else
            {
                foreach ($context['css_files'] as $id => $file)
                    echo '
	<link rel="stylesheet" href="', $file['filename'], '" id="', $id,'" />';
            }
        }
    }

    /**
     * Calls on template_show_error from index.template.php to show warnings
     * and security errors for admins
     */
    function template_admin_warning_above()

    {
        global $context, $txt;

        if (!empty($context['security_controls_files']))
        {
            $context['security_controls_files']['type'] = 'serious';
            template_show_error('security_controls_files');
        }

        if (!empty($context['security_controls_query']))
        {
            $context['security_controls_query']['type'] = 'serious';
            template_show_error('security_controls_query');
        }

        if (!empty($context['security_controls_ban']))
        {
            $context['security_controls_ban']['type'] = 'serious';
            template_show_error('security_controls_ban');
        }

        if (!empty($context['new_version_updates']))
        {
            template_show_error('new_version_updates');
        }

        // Any special notices to remind the admin about?
        if (!empty($context['warning_controls']))
        {
            $context['warning_controls']['errors'] = $context['warning_controls'];
            $context['warning_controls']['title'] = $txt['admin_warning_title'];
            $context['warning_controls']['type'] = 'warning';
            template_show_error('warning_controls');
        }
    }

    function addCodePrettify()

    {
        loadCSSFile('prettify.css');
        loadJavascriptFile('prettify.min.js', array('defer' => true));

        addInlineJavascript('
		$(document).ready(function(){
			prettyPrint();
		});', true);
    }

    function autoEmbedVideo()

    {
        global $txt;

        addInlineJavascript('
		var oEmbedtext = ({
			preview_image : ' . JavaScriptEscape($txt['preview_image']) . ',
			ctp_video : ' . JavaScriptEscape($txt['ctp_video']) . ',
			hide_video : ' . JavaScriptEscape($txt['hide_video']) . ',
			youtube : ' . JavaScriptEscape($txt['youtube']) . ',
			vimeo : ' . JavaScriptEscape($txt['vimeo']) . ',
			dailymotion : ' . JavaScriptEscape($txt['dailymotion']) . '
		});', true);

        loadJavascriptFile('elk_jquery_embed.js', array('defer' => true));
    }

    function doScheduledSendMail()

    {
        global $modSettings;

        if (isBrowser('possibly_robot'))
        {
            // @todo Maybe move this somewhere better?!
            $controller = new \ScheduledTasks_Controller();

            // What to do, what to do?!
            if (empty($modSettings['next_task_time']) || $modSettings['next_task_time'] < time())
                $controller->action_autotask();
            else
                $controller->action_reducemailqueue();
        }
        else
        {
            $type = empty($modSettings['next_task_time']) || $modSettings['next_task_time'] < time() ? 'task' : 'mailq';
            $ts = $type == 'mailq' ? $modSettings['mail_next_send'] : $modSettings['next_task_time'];

            addInlineJavascript('
		function elkAutoTask()
		{
			var tempImage = new Image();
			tempImage.src = elk_scripturl + "?scheduled=' . $type . ';ts=' . $ts . '";
		}
		window.setTimeout("elkAutoTask();", 1);', true);
        }
    }

    function relativeTimes()

    {
        global $modSettings, $context, $txt;

        // Relative times?
        if (!empty($modSettings['todayMod']) && $modSettings['todayMod'] > 2)
        {
            addInlineJavascript('
		var oRttime = ({
			referenceTime : ' . forum_time() * 1000 . ',
			now : ' . JavaScriptEscape($txt['rt_now']) . ',
			minute : ' . JavaScriptEscape($txt['rt_minute']) . ',
			minutes : ' . JavaScriptEscape($txt['rt_minutes']) . ',
			hour : ' . JavaScriptEscape($txt['rt_hour']) . ',
			hours : ' . JavaScriptEscape($txt['rt_hours']) . ',
			day : ' . JavaScriptEscape($txt['rt_day']) . ',
			days : ' . JavaScriptEscape($txt['rt_days']) . ',
			week : ' . JavaScriptEscape($txt['rt_week']) . ',
			weeks : ' . JavaScriptEscape($txt['rt_weeks']) . ',
			month : ' . JavaScriptEscape($txt['rt_month']) . ',
			months : ' . JavaScriptEscape($txt['rt_months']) . ',
			year : ' . JavaScriptEscape($txt['rt_year']) . ',
			years : ' . JavaScriptEscape($txt['rt_years']) . ',
		});
		updateRelativeTime();', true);
            $context['using_relative_time'] = true;
        }
    }

    /**
     * Sets up the basic theme context stuff.
     *
     * @param bool $forceload = false
     */
    function setupThemeContext($forceload = false)
// 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 $modSettings, $user_info, $scripturl, $context, $settings, $options, $txt;

        static $loaded = false;

        // Under SSI this function can be called more then once.  That can cause some problems.
        // So only run the function once unless we are forced to run it again.
        if ($loaded && !$forceload)
            return;

        $loaded = true;

        $context['current_time'] = standardTime(time(), false);
        $context['current_action'] = isset($_GET['action']) ? $_GET['action'] : '';
        $context['show_quick_login'] = !empty($modSettings['enableVBStyleLogin']) && $user_info['is_guest'];

        $bbc_parser = \BBC\ParserWrapper::getInstance();

        // Get some news...
        $context['news_lines'] = array_filter(explode("\n", str_replace("\r", '', trim(addslashes($modSettings['news'])))));
        for ($i = 0, $n = count($context['news_lines']); $i < $n; $i++)
        {
            if (trim($context['news_lines'][$i]) == '')
                continue;

            // Clean it up for presentation ;).
            $context['news_lines'][$i] = $bbc_parser->parseNews(stripslashes(trim($context['news_lines'][$i])));
        }

        if (!empty($context['news_lines']))
        {
            $context['random_news_line'] = $context['news_lines'][mt_rand(0, count($context['news_lines']) - 1)];
            $context['upper_content_callbacks'][] = 'news_fader';
        }

        if (!$user_info['is_guest'])
        {
            $context['user']['messages'] = &$user_info['messages'];
            $context['user']['unread_messages'] = &$user_info['unread_messages'];
            $context['user']['mentions'] = &$user_info['mentions'];

            // Personal message popup...
            if ($user_info['unread_messages'] > (isset($_SESSION['unread_messages']) ? $_SESSION['unread_messages'] : 0))
                $context['user']['popup_messages'] = true;
            else
                $context['user']['popup_messages'] = false;
            $_SESSION['unread_messages'] = $user_info['unread_messages'];

            $context['user']['avatar'] = array(
                'href' => !empty($user_info['avatar']['href']) ? $user_info['avatar']['href'] : '',
                'image' => !empty($user_info['avatar']['image']) ? $user_info['avatar']['image'] : '',
            );

            // @deprecated since 1.0.2
            if (!empty($modSettings['avatar_max_width']))
                $context['user']['avatar']['width'] = $modSettings['avatar_max_width'];

            // @deprecated since 1.0.2
            if (!empty($modSettings['avatar_max_height']))
                $context['user']['avatar']['height'] = $modSettings['avatar_max_height'];

            // Figure out how long they've been logged in.
            $context['user']['total_time_logged_in'] = array(
                'days' => floor($user_info['total_time_logged_in'] / 86400),
                'hours' => floor(($user_info['total_time_logged_in'] % 86400) / 3600),
                'minutes' => floor(($user_info['total_time_logged_in'] % 3600) / 60)
            );
        }
        else
        {
            $context['user']['messages'] = 0;
            $context['user']['unread_messages'] = 0;
            $context['user']['mentions'] = 0;
            $context['user']['avatar'] = array();
            $context['user']['total_time_logged_in'] = array('days' => 0, 'hours' => 0, 'minutes' => 0);
            $context['user']['popup_messages'] = false;

            if (!empty($modSettings['registration_method']) && $modSettings['registration_method'] == 1)
                $txt['welcome_guest'] .= $txt['welcome_guest_activate'];
            $txt['welcome_guest'] = replaceBasicActionUrl($txt['welcome_guest']);

            // If we've upgraded recently, go easy on the passwords.
            if (!empty($modSettings['enable_password_conversion']))
                $context['disable_login_hashing'] = true;
        }

        // Setup the main menu items.
        setupMenuContext();

        if (empty($settings['theme_version']))
            $context['show_vBlogin'] = $context['show_quick_login'];

        // This is here because old index templates might still use it.
        $context['show_news'] = !empty($settings['enable_news']);

        $context['additional_dropdown_search'] = prepareSearchEngines();

        // This is done to allow theme authors to customize it as they want.
        $context['show_pm_popup'] = $context['user']['popup_messages'] && !empty($options['popup_messages']) && (!isset($_REQUEST['action']) || $_REQUEST['action'] != 'pm');

        // Add the PM popup here instead. Theme authors can still override it simply by editing/removing the 'fPmPopup' in the array.
        if ($context['show_pm_popup'])
            addInlineJavascript('
		$(document).ready(function(){
			new smc_Popup({
				heading: ' . JavaScriptEscape($txt['show_personal_messages_heading']) . ',
				content: ' . JavaScriptEscape(sprintf($txt['show_personal_messages'], $context['user']['unread_messages'], $scripturl . '?action=pm')) . ',
				icon: elk_images_url + \'/im_sm_newmsg.png\'
			});
		});', true);

        // This looks weird, but it's because BoardIndex.controller.php references the variable.
        $context['common_stats']['latest_member'] = array(
            'id' => $modSettings['latestMember'],
            'name' => $modSettings['latestRealName'],
            'href' => $scripturl . '?action=profile;u=' . $modSettings['latestMember'],
            'link' => '<a href="' . $scripturl . '?action=profile;u=' . $modSettings['latestMember'] . '">' . $modSettings['latestRealName'] . '</a>',
        );
        $context['common_stats'] = array(
            'total_posts' => comma_format($modSettings['totalMessages']),
            'total_topics' => comma_format($modSettings['totalTopics']),
            'total_members' => comma_format($modSettings['totalMembers']),
            'latest_member' => $context['common_stats']['latest_member'],
        );
        $context['common_stats']['boardindex_total_posts'] = sprintf($txt['boardindex_total_posts'], $context['common_stats']['total_posts'], $context['common_stats']['total_topics'], $context['common_stats']['total_members']);

        if (empty($settings['theme_version']))
            addJavascriptVar(array('elk_scripturl' => '\'' . $scripturl . '\''));

        if (!isset($context['page_title']))
            $context['page_title'] = '';

        // Set some specific vars.
        $context['page_title_html_safe'] = \Util::htmlspecialchars(un_htmlspecialchars($context['page_title'])) . (!empty($context['current_page']) ? ' - ' . $txt['page'] . ' ' . ($context['current_page'] + 1) : '');

        // Load a custom CSS file?
        if (file_exists($settings['theme_dir'] . '/css/custom.css'))
            loadCSSFile('custom.css');
        if (!empty($context['theme_variant']) && file_exists($settings['theme_dir'] . '/css/' . $context['theme_variant'] . '/custom' . $context['theme_variant'] . '.css'))
            loadCSSFile($context['theme_variant'] . '/custom' . $context['theme_variant'] . '.css');
    }

    /**
     * Sets up all of the top menu buttons
     *
     * What it does:
     * - Defines every master item in the menu, as well as any sub-items
     * - Ensures the chosen action is set so the menu is highlighted
     * - Saves them in the cache if it is available and on
     * - Places the results in $context
     */
    function setupMenuContext()
// 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 $context, $modSettings, $user_info, $txt, $scripturl, $settings;

        // Set up the menu privileges.
        $context['allow_search'] = !empty($modSettings['allow_guestAccess']) ? allowedTo('search_posts') : (!$user_info['is_guest'] && allowedTo('search_posts'));
        $context['allow_admin'] = allowedTo(array('admin_forum', 'manage_boards', 'manage_permissions', 'moderate_forum', 'manage_membergroups', 'manage_bans', 'send_mail', 'edit_news', 'manage_attachments', 'manage_smileys'));
        $context['allow_edit_profile'] = !$user_info['is_guest'] && allowedTo(array('profile_view_own', 'profile_view_any', 'profile_identity_own', 'profile_identity_any', 'profile_extra_own', 'profile_extra_any', 'profile_remove_own', 'profile_remove_any', 'moderate_forum', 'manage_membergroups', 'profile_title_own', 'profile_title_any'));
        $context['allow_memberlist'] = allowedTo('view_mlist');
        $context['allow_calendar'] = allowedTo('calendar_view') && !empty($modSettings['cal_enabled']);
        $context['allow_moderation_center'] = $context['user']['can_mod'];
        $context['allow_pm'] = allowedTo('pm_read');

        if ($context['allow_search'])
            $context['theme_header_callbacks'] = elk_array_insert($context['theme_header_callbacks'], 'login_bar', array('search_bar'), 'after');

        $cacheTime = $modSettings['lastActive'] * 60;

        // Update the Moderation menu items with action item totals
        if ($context['allow_moderation_center'])
        {
            // Get the numbers for the menu ...
            require_once(SUBSDIR . '/Moderation.subs.php');
            $menu_count = loadModeratorMenuCounts();
        }

        $menu_count['unread_messages'] = $context['user']['unread_messages'];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $menu_count['mentions'] = $context['user']['mentions'];

        // All the buttons we can possible want and then some, try pulling the final list of buttons from cache first.
        if (($menu_buttons = cache_get_data('menu_buttons-' . implode('_', $user_info['groups']) . '-' . $user_info['language'], $cacheTime)) === null || time() - $cacheTime <= $modSettings['settings_updated'])
        {
            // Start things up: this is what we know by default
            require_once(SUBSDIR . '/Menu.subs.php');
            $buttons = array(
                'home' => array(
                    'title' => $txt['community'],
                    'href' => $scripturl,
                    'data-icon' => '&#xf015;',
                    'show' => true,
                    'sub_buttons' => array(
                        'help' => array(
                            'title' => $txt['help'],
                            'href' => $scripturl . '?action=help',
                            'show' => true,
                        ),
                        'search' => array(
                            'title' => $txt['search'],
                            'href' => $scripturl . '?action=search',
                            'show' => $context['allow_search'],
                        ),
                        'calendar' => array(
                            'title' => $txt['calendar'],
                            'href' => $scripturl . '?action=calendar',
                            'show' => $context['allow_calendar'],
                        ),
                        'memberlist' => array(
                            'title' => $txt['members_title'],
                            'href' => $scripturl . '?action=memberlist',
                            'show' => $context['allow_memberlist'],
                        ),
                        'recent' => array(
                            'title' => $txt['recent_posts'],
                            'href' => $scripturl . '?action=recent',
                            'show' => true,
                        ),
                    ),
                )
            );

            // Will change title correctly if user is either a mod or an admin.
            // Button highlighting works properly too (see current action stuffz).
            if ($context['allow_admin'])
            {
                $buttons['admin'] = array(
                    'title' => $context['current_action'] !== 'moderate' ? $txt['admin'] : $txt['moderate'],
                    'counter' => 'grand_total',
                    'href' => $scripturl . '?action=admin',
                    'data-icon' => '&#xf013;',
                    'show' => true,
                    'sub_buttons' => array(
                        'admin_center' => array(
                            'title' => $txt['admin_center'],
                            'href' => $scripturl . '?action=admin',
                            'show' => $context['allow_admin'],
                        ),
                        'featuresettings' => array(
                            'title' => $txt['modSettings_title'],
                            'href' => $scripturl . '?action=admin;area=featuresettings',
                            'show' => allowedTo('admin_forum'),
                        ),
                        'packages' => array(
                            'title' => $txt['package'],
                            'href' => $scripturl . '?action=admin;area=packages',
                            'show' => allowedTo('admin_forum'),
                        ),
                        'permissions' => array(
                            'title' => $txt['edit_permissions'],
                            'href' => $scripturl . '?action=admin;area=permissions',
                            'show' => allowedTo('manage_permissions'),
                        ),
                        'errorlog' => array(
                            'title' => $txt['errlog'],
                            'href' => $scripturl . '?action=admin;area=logs;sa=errorlog;desc',
                            'show' => allowedTo('admin_forum') && !empty($modSettings['enableErrorLogging']),
                        ),
                        'moderate_sub' => array(
                            'title' => $txt['moderate'],
                            'counter' => 'grand_total',
                            'href' => $scripturl . '?action=moderate',
                            'show' => $context['allow_moderation_center'],
                            'sub_buttons' => array(
                                'reports' => array(
                                    'title' => $txt['mc_reported_posts'],
                                    'counter' => 'reports',
                                    'href' => $scripturl . '?action=moderate;area=reports',
                                    'show' => !empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1',
                                ),
                                'modlog' => array(
                                    'title' => $txt['modlog_view'],
                                    'href' => $scripturl . '?action=moderate;area=modlog',
                                    'show' => !empty($modSettings['modlog_enabled']) && !empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1',
                                ),
                                'attachments' => array(
                                    'title' => $txt['mc_unapproved_attachments'],
                                    'counter' => 'attachments',
                                    'href' => $scripturl . '?action=moderate;area=attachmod;sa=attachments',
                                    'show' => $modSettings['postmod_active'] && !empty($user_info['mod_cache']['ap']),
                                ),
                                'poststopics' => array(
                                    'title' => $txt['mc_unapproved_poststopics'],
                                    'counter' => 'postmod',
                                    'href' => $scripturl . '?action=moderate;area=postmod;sa=posts',
                                    'show' => $modSettings['postmod_active'] && !empty($user_info['mod_cache']['ap']),
                                ),
                                'postbyemail' => array(
                                    'title' => $txt['mc_emailerror'],
                                    'counter' => 'emailmod',
                                    'href' => $scripturl . '?action=admin;area=maillist;sa=emaillist',
                                    'show' => !empty($modSettings['maillist_enabled']) && allowedTo('approve_emails'),
                                ),
                            ),
                        ),
                    ),
                );
            }
            else
            {
                $buttons['admin'] = array(
                    'title' => $txt['moderate'],
                    'counter' => 'grand_total',
                    'href' => $scripturl . '?action=moderate',
                    'data-icon' => '&#xf013;',
                    'show' => $context['allow_moderation_center'],
                    'sub_buttons' => array(
                        'reports' => array(
                            'title' => $txt['mc_reported_posts'],
                            'counter' => 'reports',
                            'href' => $scripturl . '?action=moderate;area=reports',
                            'show' => !empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1',
                        ),
                        'modlog' => array(
                            'title' => $txt['modlog_view'],
                            'href' => $scripturl . '?action=moderate;area=modlog',
                            'show' => !empty($modSettings['modlog_enabled']) && !empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1',
                        ),
                        'attachments' => array(
                            'title' => $txt['mc_unapproved_attachments'],
                            'counter' => 'attachments',
                            'href' => $scripturl . '?action=moderate;area=attachmod;sa=attachments',
                            'show' => $modSettings['postmod_active'] && !empty($user_info['mod_cache']['ap']),
                        ),
                        'poststopics' => array(
                            'title' => $txt['mc_unapproved_poststopics'],
                            'counter' => 'postmod',
                            'href' => $scripturl . '?action=moderate;area=postmod;sa=posts',
                            'show' => $modSettings['postmod_active'] && !empty($user_info['mod_cache']['ap']),
                        ),
                        'postbyemail' => array(
                            'title' => $txt['mc_emailerror'],
                            'counter' => 'emailmod',
                            'href' => $scripturl . '?action=admin;area=maillist;sa=emaillist',
                            'show' => !empty($modSettings['maillist_enabled']) && allowedTo('approve_emails'),
                        ),
                    ),
                );
            }

            $buttons += array(
                'profile' => array(
                    'title' => (!empty($user_info['avatar']['href']) ? '<img class="avatar" src="' . $user_info['avatar']['href'] . '" alt="" /> ' : '') . (!empty($modSettings['displayMemberNames']) ? $user_info['name'] : $txt['account_short']),
                    'href' => $scripturl . '?action=profile',
                    'data-icon' => '&#xf007;',
                    'show' => $context['allow_edit_profile'],
                    'sub_buttons' => array(
                        'account' => array(
                            'title' => $txt['account'],
                            'href' => $scripturl . '?action=profile;area=account',
                            'show' => allowedTo(array('profile_identity_any', 'profile_identity_own', 'manage_membergroups')),
                        ),
                        'forumprofile' => array(
                            'title' => $txt['forumprofile'],
                            'href' => $scripturl . '?action=profile;area=forumprofile',
                            'show' => allowedTo(array('profile_extra_any', 'profile_extra_own')),
                        ),
                        'theme' => array(
                            'title' => $txt['theme'],
                            'href' => $scripturl . '?action=profile;area=theme',
                            'show' => allowedTo(array('profile_extra_any', 'profile_extra_own', 'profile_extra_any')),
                        ),
                        'logout' => array(
                            'title' => $txt['logout'],
                            'href' => $scripturl . '?action=logout',
                            'show' => !$user_info['is_guest'],
                        ),
                    ),
                ),
                // @todo Look at doing something here, to provide instant access to inbox when using click menus.
                // @todo A small pop-up anchor seems like the obvious way to handle it. ;)
                'pm' => array(
                    'title' => $txt['pm_short'],
                    'counter' => 'unread_messages',
                    'href' => $scripturl . '?action=pm',
                    'data-icon' => '&#xf0e0;',
                    'show' => $context['allow_pm'],
                    'sub_buttons' => array(
                        'pm_read' => array(
                            'title' => $txt['pm_menu_read'],
                            'href' => $scripturl . '?action=pm',
                            'show' => allowedTo('pm_read'),
                        ),
                        'pm_send' => array(
                            'title' => $txt['pm_menu_send'],
                            'href' => $scripturl . '?action=pm;sa=send',
                            'show' => allowedTo('pm_send'),
                        ),
                    ),
                ),
                'mentions' => array(
                    'title' => $txt['mention'],
                    'counter' => 'mentions',
                    'href' => $scripturl . '?action=mentions',
                    'data-icon' => '&#xf0f3;',
                    'show' => !$user_info['is_guest'] && !empty($modSettings['mentions_enabled']),
                ),
                // The old language string made no sense, and was too long.
                // "New posts" is better, because there are probably a pile
                // of old unread posts, and they wont be reached from this button.
                'unread' => array(
                    'title' => $txt['view_unread_category'],
                    'href' => $scripturl . '?action=unread',
                    'data-icon' => '&#xf086;',
                    'show' => !$user_info['is_guest'],
                ),
                // The old language string made no sense, and was too long.
                // "New replies" is better, because there are "updated topics"
                // that the user has never posted in and doesn't care about.
                'unreadreplies' => array(
                    'title' => $txt['view_replies_category'],
                    'href' => $scripturl . '?action=unreadreplies',
                    'data-icon' => '&#xf0e6;',
                    'show' => !$user_info['is_guest'],
                ),
                'login' => array(
                    'title' => $txt['login'],
                    'href' => $scripturl . '?action=login',
                    'data-icon' => '&#xf023;',
                    'show' => $user_info['is_guest'],
                ),

                'register' => array(
                    'title' => $txt['register'],
                    'href' => $scripturl . '?action=register',
                    'data-icon' => '&#xf090;',
                    'show' => $user_info['is_guest'] && $context['can_register'],
                ),
                'like_stats' => array(
                    'title' => $txt['like_post_stats'],
                    'href' => $scripturl . '?action=likes;sa=likestats',
                    // 'data-icon' => '&#xf090;',

                    'show' => allowedTo('like_posts_stats'),
                ),
                'contact' => array(
                    'title' => $txt['contact'],
                    'href' => $scripturl . '?action=register;sa=contact',
                    'data-icon' => '&#xf095;',
                    'show' => $user_info['is_guest'] && !empty($modSettings['enable_contactform']) && $modSettings['enable_contactform'] == 'menu',
                ),
            );

            // Allow editing menu buttons easily.
            call_integration_hook('integrate_menu_buttons', array(&$buttons, &$menu_count));

            // Now we put the buttons in the context so the theme can use them.
            $menu_buttons = array();
            foreach ($buttons as $act => $button)
            {
                if (!empty($button['show']))
                {
                    $button['active_button'] = false;

                    // This button needs some action.
                    if (isset($button['action_hook']))
                        $needs_action_hook = true;

                    if (isset($button['counter']) && !empty($menu_count[$button['counter']]))
                    {
                        $button['alttitle'] = $button['title'] . ' [' . $menu_count[$button['counter']] . ']';
                        if (!empty($settings['menu_numeric_notice'][0]))
                        {
                            $button['title'] .= sprintf($settings['menu_numeric_notice'][0], $menu_count[$button['counter']]);
                            $button['indicator'] = true;
                        }
                    }

                    // Go through the sub buttons if there are any.
                    if (isset($button['sub_buttons']))
                    {
                        foreach ($button['sub_buttons'] as $key => $subbutton)
                        {
                            if (empty($subbutton['show']))
                                unset($button['sub_buttons'][$key]);
                            elseif (isset($subbutton['counter']) && !empty($menu_count[$subbutton['counter']]))
                            {
                                $button['sub_buttons'][$key]['alttitle'] = $subbutton['title'] . ' [' . $menu_count[$subbutton['counter']] . ']';
                                if (!empty($settings['menu_numeric_notice'][1]))
                                    $button['sub_buttons'][$key]['title'] .= sprintf($settings['menu_numeric_notice'][1], $menu_count[$subbutton['counter']]);

                                // 2nd level sub buttons next...
                                if (isset($subbutton['sub_buttons']))
                                {
                                    foreach ($subbutton['sub_buttons'] as $key2 => $subbutton2)
                                    {
                                        $button['sub_buttons'][$key]['sub_buttons'][$key2] = $subbutton2;
                                        if (empty($subbutton2['show']))
                                            unset($button['sub_buttons'][$key]['sub_buttons'][$key2]);
                                        elseif (isset($subbutton2['counter']) && !empty($menu_count[$subbutton2['counter']]))
                                        {
                                            $button['sub_buttons'][$key]['sub_buttons'][$key2]['alttitle'] = $subbutton2['title'] . ' [' . $menu_count[$subbutton2['counter']] . ']';
                                            if (!empty($settings['menu_numeric_notice'][2]))
                                                $button['sub_buttons'][$key]['sub_buttons'][$key2]['title'] .= sprintf($settings['menu_numeric_notice'][2], $menu_count[$subbutton2['counter']]);
                                            unset($menu_count[$subbutton2['counter']]);
                                        }
                                    }
                                }
                            }
                        }
                    }

                    $menu_buttons[$act] = $button;
                }
            }

            if (!empty($modSettings['cache_enable']) && $modSettings['cache_enable'] >= 2)
                cache_put_data('menu_buttons-' . implode('_', $user_info['groups']) . '-' . $user_info['language'], $menu_buttons, $cacheTime);
        }

        if (!empty($menu_buttons['profile']['sub_buttons']['logout']))
            $menu_buttons['profile']['sub_buttons']['logout']['href'] .= ';' . $context['session_var'] . '=' . $context['session_id'];

        $context['menu_buttons'] = $menu_buttons;

        // Figure out which action we are doing so we can set the active tab.
        // Default to home.
        $current_action = 'home';

        if (isset($context['menu_buttons'][$context['current_action']]))
            $current_action = $context['current_action'];
        elseif ($context['current_action'] == 'profile')
            $current_action = 'pm';
        elseif ($context['current_action'] == 'theme')
            $current_action = isset($_REQUEST['sa']) && $_REQUEST['sa'] == 'pick' ? 'profile' : 'admin';
        elseif ($context['current_action'] == 'login2' || ($user_info['is_guest'] && $context['current_action'] == 'reminder'))
            $current_action = 'login';
        elseif ($context['current_action'] == 'groups' && $context['allow_moderation_center'])
            $current_action = 'moderate';
        elseif ($context['current_action'] == 'moderate' && $context['allow_admin'])
            $current_action = 'admin';

        // Not all actions are simple.
        if (!empty($needs_action_hook))
            call_integration_hook('integrate_current_action', array(&$current_action));

        if (isset($context['menu_buttons'][$current_action]))
            $context['menu_buttons'][$current_action]['active_button'] = true;
    }

    function loadThemeJavascript()

    {
        global $settings, $context, $modSettings, $scripturl, $txt, $options;

        // Queue our Javascript
        loadJavascriptFile(array('elk_jquery_plugins.js', 'script.js', 'script_elk.js', 'theme.js'));

        // Default JS variables for use in every theme
        addJavascriptVar(array(
                'elk_theme_url' => JavaScriptEscape($settings['theme_url']),
                'elk_default_theme_url' => JavaScriptEscape($settings['default_theme_url']),
                'elk_images_url' => JavaScriptEscape($settings['images_url']),
                'elk_smiley_url' => JavaScriptEscape($modSettings['smileys_url']),
                'elk_scripturl' => '\'' . $scripturl . '\'',
                'elk_iso_case_folding' => $context['server']['iso_case_folding'] ? 'true' : 'false',
                'elk_charset' => '"UTF-8"',
                'elk_session_id' => JavaScriptEscape($context['session_id']),
                'elk_session_var' => JavaScriptEscape($context['session_var']),
                'elk_member_id' => $context['user']['id'],
                'ajax_notification_text' => JavaScriptEscape($txt['ajax_in_progress']),
                'ajax_notification_cancel_text' => JavaScriptEscape($txt['modify_cancel']),
                'help_popup_heading_text' => JavaScriptEscape($txt['help_popup']),
                'use_click_menu' => !empty($options['use_click_menu']) ? 'true' : 'false',
                'todayMod' => !empty($modSettings['todayMod']) ? (int) $modSettings['todayMod'] : 0)
        );

        // Auto video embedding enabled, then load the needed JS
        if (!empty($modSettings['enableVideoEmbeding']))
        {
            theme()->autoEmbedVideo();
        }

        // Prettify code tags? Load the needed JS and CSS.
        if (!empty($modSettings['enableCodePrettify']))
        {
            theme()->addCodePrettify();
        }

        theme()->relativeTimes();

        // If we think we have mail to send, let's offer up some possibilities... robots get pain (Now with scheduled task support!)
        if ((!empty($modSettings['mail_next_send']) && $modSettings['mail_next_send'] < time() && empty($modSettings['mail_queue_use_cron'])) || empty($modSettings['next_task_time']) || $modSettings['next_task_time'] < time())
        {
            theme()->doScheduledSendMail();
        }
    }

    public function loadDefaultLayers()
// 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 $settings;

        $simpleActions = array(
            'quickhelp',
            'printpage',
            'quotefast',
            'spellcheck',
        );

        call_integration_hook('integrate_simple_actions', array(&$simpleActions));

        // Output is fully XML, so no need for the index template.
        if (isset($_REQUEST['xml']))
        {
            loadLanguage('index+Addons');

            // @todo added because some $settings in template_init are necessary even in xml mode. Maybe move template_init to a settings file?
            loadTemplate('index');
            loadTemplate('Xml');
            \Template_Layers::getInstance()->removeAll();
        }
        // These actions don't require the index template at all.
        elseif (!empty($_REQUEST['action']) && in_array($_REQUEST['action'], $simpleActions))
        {
            loadLanguage('index+Addons');
            \Template_Layers::getInstance()->removeAll();
        }
        else
        {
            // Custom templates to load, or just default?
            if (isset($settings['theme_templates']))
                $templates = explode(',', $settings['theme_templates']);
            else
                $templates = array('index');

            // Load each template...
            foreach ($templates as $template)
                loadTemplate($template);

            // ...and attempt to load their associated language files.
            $required_files = implode('+', array_merge($templates, array('Addons')));
            loadLanguage($required_files, '', false);

            // Custom template layers?
            if (isset($settings['theme_layers']))
                $layers = explode(',', $settings['theme_layers']);
            else
                $layers = array('html', 'body');

            $template_layers = \Template_Layers::getInstance(true);
            foreach ($layers as $layer)
                $template_layers->addBegin($layer);
        }
    }

    public function loadThemeVariant()
// 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 $context, $settings, $options;

        // Overriding - for previews and that ilk.
        if (!empty($_REQUEST['variant']))
            $_SESSION['id_variant'] = $_REQUEST['variant'];

        // User selection?
        if (empty($settings['disable_user_variant']) || allowedTo('admin_forum'))
            $context['theme_variant'] = !empty($_SESSION['id_variant']) ? $_SESSION['id_variant'] : (!empty($options['theme_variant']) ? $options['theme_variant'] : '');

        // If not a user variant, select the default.
        if ($context['theme_variant'] == '' || !in_array($context['theme_variant'], $settings['theme_variants']))
            $context['theme_variant'] = !empty($settings['default_variant']) && in_array($settings['default_variant'], $settings['theme_variants']) ? $settings['default_variant'] : $settings['theme_variants'][0];

        // Do this to keep things easier in the templates.
        $context['theme_variant'] = '_' . $context['theme_variant'];
        $context['theme_variant_url'] = $context['theme_variant'] . '/';

        // The most efficient way of writing multi themes is to use a master index.css plus variant.css files.
        if (!empty($context['theme_variant']))
            loadCSSFile($context['theme_variant'] . '/index' . $context['theme_variant'] . '.css');
    }
}
elkarte / Elkarte

Pull Request — development (#2329)

Theme::setupMenuContext() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like
