. * */ namespace Friendica\App; use ArrayAccess; use DOMDocument; use DOMXPath; use Friendica\App; use Friendica\Content\Nav; use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\Hook; use Friendica\Core\L10n; use Friendica\Core\Renderer; use Friendica\Core\Theme; use Friendica\Module\Special\HTTPException as ModuleHTTPException; use Friendica\Network\HTTPException; use Friendica\Util\Network; use Friendica\Util\Strings; use Friendica\Util\Profiler; /** * Contains the page specific environment variables for the current Page * - Contains all stylesheets * - Contains all footer-scripts * - Contains all page specific content (header, footer, content, ...) * * The run() method is the single point where the page will get printed to the screen */ class Page implements ArrayAccess { /** * @var array Contains all stylesheets, which should get loaded during page */ private $stylesheets = []; /** * @var array Contains all scripts, which are added to the footer at last */ private $footerScripts = []; /** * @var array The page content, which are showed directly */ private $page = [ 'aside' => '', 'bottom' => '', 'content' => '', 'footer' => '', 'htmlhead' => '', 'nav' => '', 'page_title' => '', 'right_aside' => '', 'template' => '', 'title' => '', ]; /** * @var string The basepath of the page */ private $basePath; /** * @param string $basepath The Page basepath */ public function __construct(string $basepath) { $this->basePath = $basepath; } /** * Whether a offset exists * * @link https://php.net/manual/en/arrayaccess.offsetexists.php * * @param mixed $offset

* An offset to check for. *

* * @return boolean true on success or false on failure. *

*

* The return value will be casted to boolean if non-boolean was returned. * @since 5.0.0 */ public function offsetExists($offset) { return isset($this->page[$offset]); } /** * Offset to retrieve * * @link https://php.net/manual/en/arrayaccess.offsetget.php * * @param mixed $offset

* The offset to retrieve. *

* * @return mixed Can return all value types. * @since 5.0.0 */ public function offsetGet($offset) { return $this->page[$offset] ?? null; } /** * Offset to set * * @link https://php.net/manual/en/arrayaccess.offsetset.php * * @param mixed $offset

* The offset to assign the value to. *

* @param mixed $value

* The value to set. *

* * @return void * @since 5.0.0 */ public function offsetSet($offset, $value) { $this->page[$offset] = $value; } /** * Offset to unset * * @link https://php.net/manual/en/arrayaccess.offsetunset.php * * @param mixed $offset

* The offset to unset. *

* * @return void * @since 5.0.0 */ public function offsetUnset($offset) { if (isset($this->page[$offset])) { unset($this->page[$offset]); } } /** * Register a stylesheet file path to be included in the tag of every page. * Inclusion is done in App->initHead(). * The path can be absolute or relative to the Friendica installation base folder. * * @param string $path * @param string $media * @see Page::initHead() */ public function registerStylesheet($path, string $media = 'screen') { $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]); if (mb_strpos($path, $this->basePath . DIRECTORY_SEPARATOR) === 0) { $path = mb_substr($path, mb_strlen($this->basePath . DIRECTORY_SEPARATOR)); } $this->stylesheets[trim($path, '/')] = $media; } /** * Initializes Page->page['htmlhead']. * * Includes: * - Page title * - Favicons * - Registered stylesheets (through App->registerStylesheet()) * - Infinite scroll data * - head.tpl template * * @param App $app The Friendica App instance * @param Module $module The loaded Friendica module * @param L10n $l10n The l10n language instance * @param IManageConfigValues $config The Friendica configuration * @param IManagePersonalConfigValues $pConfig The Friendica personal configuration (for user) * * @throws HTTPException\InternalServerErrorException */ private function initHead(App $app, Module $module, L10n $l10n, IManageConfigValues $config, IManagePersonalConfigValues $pConfig) { $interval = ((local_user()) ? $pConfig->get(local_user(), 'system', 'update_interval') : 40000); // If the update is 'deactivated' set it to the highest integer number (~24 days) if ($interval < 0) { $interval = 2147483647; } if ($interval < 10000) { $interval = 40000; } // Default title: current module called if (empty($this->page['title']) && $module->getName()) { $this->page['title'] = ucfirst($module->getName()); } // Prepend the sitename to the page title $this->page['title'] = $config->get('config', 'sitename', '') . (!empty($this->page['title']) ? ' | ' . $this->page['title'] : ''); if (!empty(Renderer::$theme['stylesheet'])) { $stylesheet = Renderer::$theme['stylesheet']; } else { $stylesheet = $app->getCurrentThemeStylesheetPath(); } $this->registerStylesheet($stylesheet); $shortcut_icon = $config->get('system', 'shortcut_icon'); if ($shortcut_icon == '') { $shortcut_icon = 'images/friendica-32.png'; } $touch_icon = $config->get('system', 'touch_icon'); if ($touch_icon == '') { $touch_icon = 'images/friendica-192.png'; } Hook::callAll('head', $this->page['htmlhead']); $tpl = Renderer::getMarkupTemplate('head.tpl'); /* put the head template at the beginning of page['htmlhead'] * since the code added by the modules frequently depends on it * being first */ $this->page['htmlhead'] = Renderer::replaceMacros($tpl, [ '$local_user' => local_user(), '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION, '$delitem' => $l10n->t('Delete this item?'), '$blockAuthor' => $l10n->t('Block this author? They won\'t be able to follow you nor see your public posts, and you won\'t be able to see their posts and their notifications.'), '$update_interval' => $interval, '$shortcut_icon' => $shortcut_icon, '$touch_icon' => $touch_icon, '$block_public' => intval($config->get('system', 'block_public')), '$stylesheets' => $this->stylesheets, ]) . $this->page['htmlhead']; } /** * Returns the complete URL of the current page, e.g.: http(s)://something.com/network * * Taken from http://webcheatsheet.com/php/get_current_page_url.php */ private function curPageURL() { $pageURL = 'http'; if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) { $pageURL .= "s"; } $pageURL .= "://"; if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") { $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"]; } else { $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"]; } return $pageURL; } /** * Initializes Page->page['footer']. * * Includes: * - Javascript homebase * - Mobile toggle link * - Registered footer scripts (through App->registerFooterScript()) * - footer.tpl template * * @param App $app The Friendica App instance * @param Mode $mode The Friendica runtime mode * @param L10n $l10n The l10n instance * * @throws HTTPException\InternalServerErrorException */ private function initFooter(App $app, Mode $mode, L10n $l10n) { // If you're just visiting, let javascript take you home if (!empty($_SESSION['visitor_home'])) { $homebase = $_SESSION['visitor_home']; } elseif (!empty($app->getLoggedInUserNickname())) { $homebase = 'profile/' . $app->getLoggedInUserNickname(); } if (isset($homebase)) { $this->page['footer'] .= '' . "\n"; } /* * Add a "toggle mobile" link if we're using a mobile device */ if ($mode->isMobile() || $mode->isTablet()) { if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) { $link = 'toggle_mobile?address=' . urlencode($this->curPageURL()); } else { $link = 'toggle_mobile?off=1&address=' . urlencode($this->curPageURL()); } $this->page['footer'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [ '$toggle_link' => $link, '$toggle_text' => $l10n->t('toggle mobile') ]); } Hook::callAll('footer', $this->page['footer']); $tpl = Renderer::getMarkupTemplate('footer.tpl'); $this->page['footer'] = Renderer::replaceMacros($tpl, [ '$footerScripts' => array_unique($this->footerScripts), ]) . $this->page['footer']; } /** * Initializes Page->page['content']. * * Includes: * - module content * - hooks for content * * @param Module $module The module * @param Mode $mode The Friendica execution mode * * @throws HTTPException\InternalServerErrorException */ private function initContent(Module $module, Mode $mode) { $content = ''; try { $moduleClass = $module->getClass(); $arr = ['content' => $content]; Hook::callAll($moduleClass->getClassName() . '_mod_content', $arr); $content = $arr['content']; $arr = ['content' => $moduleClass->content()]; Hook::callAll($moduleClass->getClassName() . '_mod_aftercontent', $arr); $content .= $arr['content']; } catch (HTTPException $e) { $content = (new ModuleHTTPException())->content($e); } // initialise content region if ($mode->isNormal()) { Hook::callAll('page_content_top', $this->page['content']); } $this->page['content'] .= $content; } /** * Register a javascript file path to be included in the