Classes

File phpboost/environment/SiteDisplayGraphicalEnvironment.class.php

File phpboost/environment/SiteDisplayGraphicalEnvironment.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 
<?php
/**
 * @package     PHPBoost
 * @subpackage  Environment
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2018 12 28
 * @since       PHPBoost 3.0 - 2009 10 01
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
 * @contributor Arnaud GENET <elenwii@phpboost.com>
 * @contributor Kevin MASSY <reidlos@phpboost.com>
*/

class SiteDisplayGraphicalEnvironment extends AbstractDisplayGraphicalEnvironment
{
    /**
     * @var BreadCrumb The page breadcrumb
     */
    private $breadcrumb = null;

    private static $main_lang;

    public function __construct()
    {
        parent::__construct();
        $this->load_langs();
        $this->set_breadcrumb(new BreadCrumb());
    }

    private function load_langs()
    {
        self::$main_lang = LangLoader::get('main');
    }

    /**
     * {@inheritdoc}
     */
    public function display($content)
    {
        $template = new FileTemplate('body.tpl');

        $header_logo_path = '';
        $theme = ThemesManager::get_theme(AppContext::get_current_user()->get_theme());

        if ($theme)
        {
            $customize_interface = $theme->get_customize_interface();
            $header_logo_path = $customize_interface->get_header_logo_path();
        }

        $template->put_all(array(
            'MAINTAIN'         => $this->display_site_maintenance(),
            'SITE_NAME'        => GeneralConfig::load()->get_site_name(),
            'SITE_SLOGAN'      => GeneralConfig::load()->get_site_slogan(),
            'C_HEADER_LOGO'    => !empty($header_logo_path),
            'HEADER_LOGO'      => Url::to_rel($header_logo_path),
            'PHPBOOST_VERSION' => GeneralConfig::load()->get_phpboost_major_version(),
            'CONTENT'          => $content,
            'ACTIONS_MENU'     => ModuleTreeLinksService::display_actions_menu(),
            'L_POWERED_BY'     => self::$main_lang['powered_by'],
            'L_PHPBOOST_RIGHT' => self::$main_lang['phpboost_right'],
            'L_PHPBOOST_LINK'  => self::$main_lang['phpboost_link'],
        ));

        $this->display_kernel_message($template);
        $this->display_counter($template);
        $this->display_menus($template);
        $this->get_breadcrumb()->display($template);

        if (GraphicalEnvironmentConfig::load()->is_page_bench_enabled())
        {
            $template->put_all(array(
                'C_DISPLAY_BENCH' => true,
                'BENCH'           => AppContext::get_bench()->to_string(),
                'REQ'             => PersistenceContext::get_querier()->get_executed_requests_count(),
                'MEMORY_USED'     => AppContext::get_bench()->get_memory_php_used(),
                'L_REQ'           => self::$main_lang['sql_req'],
                'L_ACHIEVED'      => self::$main_lang['achieved'],
                'L_UNIT_SECOND'   => LangLoader::get_message('unit.seconds', 'date-common')
            ));
        }

        if (GraphicalEnvironmentConfig::load()->get_display_theme_author() && $theme)
        {
            $theme_configuration = $theme->get_configuration();
            $template->put_all(array(
                'C_DISPLAY_AUTHOR_THEME' => true,
                'L_THEME'                => self::$main_lang['theme'],
                'L_THEME_NAME'           => $theme_configuration->get_name(),
                'L_BY'                   => TextHelper::strtolower(self::$main_lang['by']),
                'L_THEME_AUTHOR'         => $theme_configuration->get_author_name(),
                'U_THEME_AUTHOR_LINK'    => $theme_configuration->get_author_link(),
            ));
        }

        $this->display_page($template);
    }

    function display_page(View $body_template)
    {
        $template = new FileTemplate('frame.tpl');

        $customization_config = CustomizationConfig::load();
        $cookiebar_config = CookieBarConfig::load();
        $maintenance_config = MaintenanceConfig::load();

        $js_top_tpl = new FileTemplate('js_top.tpl');
        $js_top_tpl->put_all(array(
            'C_COOKIEBAR_ENABLED'     => $cookiebar_config->is_cookiebar_enabled() && !$maintenance_config->is_under_maintenance(),
            'COOKIEBAR_DURATION'      => $cookiebar_config->get_cookiebar_duration(),
            'COOKIEBAR_TRACKING_MODE' => $cookiebar_config->get_cookiebar_tracking_mode(),
            'COOKIEBAR_CONTENT'       => TextHelper::to_js_string($cookiebar_config->get_cookiebar_content())
        ));

        $js_bottom_tpl = new FileTemplate('js_bottom.tpl');
        $js_bottom_tpl->put_all(array(
            'C_COOKIEBAR_ENABLED' => $cookiebar_config->is_cookiebar_enabled() && !$maintenance_config->is_under_maintenance()
        ));

        $seo_meta_data = $this->get_seo_meta_data();
        $description = $seo_meta_data->get_full_description();
        $template->put_all(array(
            'C_CSS_CACHE_ENABLED' => CSSCacheConfig::load()->is_enabled(),
            'C_FAVICON'           => $customization_config->favicon_exists(),
            'C_OPENGRAPH'         => ContentManagementConfig::load()->is_opengraph_enabled(),
            'C_CANONICAL_URL'     => $seo_meta_data->canonical_link_exists(),
            'C_PICTURE_URL'       => $seo_meta_data->picture_url_exists(),
            'C_DESCRIPTION'       => !empty($description),
            'FAVICON'             => Url::to_rel($customization_config->get_favicon_path()),
            'FAVICON_TYPE'        => $customization_config->favicon_type(),
            'SITE_NAME'           => GeneralConfig::load()->get_site_name(),
            'TITLE'               => $seo_meta_data->get_full_title(),
            'PAGE_TITLE'          => $seo_meta_data->get_title(),
            'SITE_DESCRIPTION'    => $description,
            'U_CANONICAL'         => $seo_meta_data->get_canonical_link(),
            'U_PICTURE'           => $seo_meta_data->get_picture_url(),
            'PAGE_TYPE'           => $seo_meta_data->get_page_type(),
            'L_XML_LANGUAGE'      => self::$main_lang['xml_lang'],
            'PHPBOOST_VERSION'    => GeneralConfig::load()->get_phpboost_major_version(),
            'MODULES_CSS'         => $this->get_modules_css_files_html_code(),
            'JS_TOP'              => $js_top_tpl,
            'JS_BOTTOM'           => $js_bottom_tpl,
            'BODY'                => $body_template
        ));

        foreach ($seo_meta_data->get_additionnal_properties() as $og_id => $og_value)
        {
            if (is_array($og_value))
            {
                foreach ($og_value as $og_sub_value)
                {
                    $template->assign_block_vars('og_additionnal_properties', array(
                        'ID' => $og_id,
                        'VALUE' => $og_sub_value
                    ));
                }
            }
            else
            {
                $template->assign_block_vars('og_additionnal_properties', array(
                    'ID' => $og_id,
                    'VALUE' => $og_value
                ));
            }
        }

        $template->display(true);
    }

    protected function display_counter(Template $template)
    {
        //If the counter is to be displayed, we display it
        if (GraphicalEnvironmentConfig::load()->is_visit_counter_enabled())
        {
            try {
                $visit_counter = PersistenceContext::get_querier()->select_single_row(DB_TABLE_VISIT_COUNTER, array('ip AS nbr_ip', 'total'), 'WHERE id = 1');
            } catch (RowNotFoundException $e) {
                $visit_counter = array('nbr_ip' => 1, 'total' => 1);
            }

            $template->put_all(array(
                'L_VISIT'             => self::$main_lang['guest_s'],
                'L_TODAY'             => LangLoader::get_message('today', 'date-common'),
                'C_VISIT_COUNTER'     => true,
                'VISIT_COUNTER_TOTAL' => !empty($visit_counter['nbr_ip']) ? $visit_counter['nbr_ip'] : 1,
                'VISIT_COUNTER_DAY'   => !empty($visit_counter['total']) ? $visit_counter['total'] : 1
            ));
        }
    }

    protected function display_menus(Template $template)
    {
        $theme = ThemesManager::get_theme(AppContext::get_current_user()->get_theme());
        $menus = MenusCache::load()->get_menus();
        $columns_disabled = $theme ? $theme->get_columns_disabled() : new ColumnsDisabled();

        foreach ($menus as $cached_menu)
        {
            $menu = $cached_menu->get_menu();
            if ($menu->check_auth() && !$columns_disabled->menus_column_is_disabled($menu->get_block()))
            {
                $display = false;
                $filters = $menu->get_filters();
                $nbr_filters = count($filters);
                foreach ($filters as $filter)
                {
                    if (($nbr_filters > 1 && $filter->get_pattern() != '/') || ($filter->match() && !$display))
                        $display = true;
                }

                if ($display)
                {
                    $menu_content = $cached_menu->has_cached_string() ? $cached_menu->get_cached_string() : $menu->display();
                    $block = $menu->get_block();
                    switch ($block) {
                        case Menu::BLOCK_POSITION__HEADER:
                            $template->put('C_MENUS_HEADER_CONTENT', true);
                            $template->assign_block_vars('menus_header', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__SUB_HEADER:
                            $template->put('C_MENUS_SUB_HEADER_CONTENT', true);
                            $template->assign_block_vars('menus_sub_header', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__LEFT:
                            $template->put('C_MENUS_LEFT_CONTENT', true);
                            $template->assign_block_vars('menus_left', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__RIGHT:
                            $template->put('C_MENUS_RIGHT_CONTENT', true);
                            $template->assign_block_vars('menus_right', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__TOP_CENTRAL:
                            $template->put('C_MENUS_TOPCENTRAL_CONTENT', $menu_content);
                            $template->assign_block_vars('menus_top_central', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__BOTTOM_CENTRAL:
                            $template->put('C_MENUS_BOTTOM_CENTRAL_CONTENT', $menu_content);
                            $template->assign_block_vars('menus_bottom_central', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__TOP_FOOTER:
                            $template->put('C_MENUS_TOP_FOOTER_CONTENT', true);
                            $template->assign_block_vars('menus_top_footer', array('MENU' => $menu_content));
                        break;

                        case Menu::BLOCK_POSITION__FOOTER:
                            $template->put('C_MENUS_FOOTER_CONTENT', true);
                            $template->assign_block_vars('menus_footer', array('MENU' => $menu_content));
                    }
                }
            }
        }
    }

    protected function display_site_maintenance()
    {
        //Users not authorized cannot come here
        parent::process_site_maintenance();

        $template =  new FileTemplate('maintain.tpl');

        $maintenance_config = MaintenanceConfig::load();
        if ($maintenance_config->is_under_maintenance() && $maintenance_config->get_display_duration_for_admin())
        {
            $date_lang = LangLoader::get('date-common');
            //Durée de la maintenance.
            $array_time = array(-1, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 14400, 18000, 21600, 25200, 28800, 57600, 86400, 172800, 604800);
            $array_delay = array(LangLoader::get_message('unspecified', 'main'),
                '1 ' . $date_lang['minute'], '5 ' . $date_lang['minutes'], '10 ' . $date_lang['minutes'], '15 ' . $date_lang['minutes'], '30 ' . $date_lang['minutes'],
                '1 ' . $date_lang['hour'], '2 ' . $date_lang['hours'], '3 ' . $date_lang['hours'], '4 ' . $date_lang['hours'], '5 ' . $date_lang['hours'], '6 ' . $date_lang['hours'], '7 ' . $date_lang['hours'], '8 ' . $date_lang['hours'], '16 ' . $date_lang['hours'],
                '1 ' . $date_lang['day'], '2 ' . $date_lang['day'],
                '1 ' . $date_lang['week']);

            //Retourne le délai de maintenance le plus proche.
            if (!$maintenance_config->is_unlimited_maintenance())
            {
                $key_delay = 0;
                $current_time = time();
                $array_size = count($array_time) - 1;
                $end_timestamp = $maintenance_config->get_end_date()->get_timestamp();
                for ($i = $array_size; $i >= 1; $i--)
                {
                    if (($end_timestamp - $current_time) - $array_time[$i] < 0
                    &&  ($end_timestamp - $current_time) - $array_time[$i-1] > 0)
                    {
                        $key_delay = $i-1;
                        break;
                    }
                }

                //Calcul du format de la date
                $array_release = array(
                Date::to_format($end_timestamp, 'Y', Timezone::SITE_TIMEZONE),
                (Date::to_format($end_timestamp, 'n', Timezone::SITE_TIMEZONE) - 1),
                Date::to_format($end_timestamp, 'j', Timezone::SITE_TIMEZONE),
                Date::to_format($end_timestamp, 'G', Timezone::SITE_TIMEZONE),
                Date::to_format($end_timestamp, 'i', Timezone::SITE_TIMEZONE),
                Date::to_format($end_timestamp, 's', Timezone::SITE_TIMEZONE));

                $array_now = array(
                Date::to_format(time(), 'Y', Timezone::SITE_TIMEZONE),
                (Date::to_format(time(), 'n', Timezone::SITE_TIMEZONE) - 1),
                Date::to_format(time(), 'j', Timezone::SITE_TIMEZONE),
                Date::to_format(time(), 'G', Timezone::SITE_TIMEZONE),
                Date::to_format(time(), 'i', Timezone::SITE_TIMEZONE),
                Date::to_format(time(), 's', Timezone::SITE_TIMEZONE));
            }
            else //Délai indéterminé.
            {
                $key_delay = 0;
                $array_release = array('0', '0', '0', '0', '0', '0');
                $array_now = array('0', '0', '0', '0', '0', '0');
            }

            $template->put_all(array(
                'C_ALERT_MAINTAIN'        => true,
                'C_MAINTAIN_DELAY'        => true,
                'UNSPECIFIED'             => $maintenance_config->is_unlimited_maintenance() ? 0 : 1,
                'DELAY'                   => isset($array_delay[$key_delay]) ? $array_delay[$key_delay] : '0',
                'MAINTAIN_RELEASE_FORMAT' => implode(',', $array_release),
                'MAINTAIN_NOW_FORMAT'     => implode(',', $array_now),
                'L_MAINTAIN_DELAY'        => self::$main_lang['maintain_delay'],
                'L_LOADING'               => self::$main_lang['loading'],
                'L_DAYS'                  => $date_lang['days'],
                'L_HOURS'                 => $date_lang['hours'],
                'L_MIN'                   => $date_lang['minutes'],
                'L_SEC'                   => $date_lang['seconds']
            ));
        }
        return $template;
    }

    /**
     * Returns the bread crumb
     * @return BreadCrumb The breadcrumb
     */
    public function get_breadcrumb()
    {
        return $this->breadcrumb;
    }

    /**
     * Sets the page's bread crumb
     * @param BreadCrumb $breadcrumb The bread crumb to use
     */
    public function set_breadcrumb(BreadCrumb $breadcrumb)
    {
        $this->breadcrumb = $breadcrumb;
        $this->breadcrumb->set_graphical_environment($this);
    }
}
?>