3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\App;
28 use Friendica\Content\Nav;
29 use Friendica\Core\Config\Capability\IManageConfigValues;
30 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
31 use Friendica\Core\Hook;
32 use Friendica\Core\L10n;
33 use Friendica\Core\Logger;
34 use Friendica\Core\Renderer;
35 use Friendica\Core\System;
36 use Friendica\Core\Theme;
37 use Friendica\Module\Response;
38 use Friendica\Network\HTTPException;
39 use Friendica\Util\Network;
40 use Friendica\Util\Strings;
41 use Friendica\Util\Profiler;
42 use Psr\Http\Message\ResponseInterface;
45 * Contains the page specific environment variables for the current Page
46 * - Contains all stylesheets
47 * - Contains all footer-scripts
48 * - Contains all page specific content (header, footer, content, ...)
50 * The run() method is the single point where the page will get printed to the screen
52 class Page implements ArrayAccess
55 * @var array Contains all stylesheets, which should get loaded during page
57 private $stylesheets = [];
59 * @var array Contains all scripts, which are added to the footer at last
61 private $footerScripts = [];
63 * @var array The page content, which are showed directly
78 * @var string The basepath of the page
82 private $timestamp = 0;
85 private $command = '';
88 * @param string $basepath The Page basepath
90 public function __construct(string $basepath)
92 $this->timestamp = microtime(true);
93 $this->basePath = $basepath;
96 public function setLogging(string $method, string $module, string $command)
98 $this->method = $method;
99 $this->module = $module;
100 $this->command = $command;
103 public function logRuntime(IManageConfigValues $config, string $origin = '')
105 $ignore = $config->get('system', 'runtime_ignore');
106 if (in_array($this->module, $ignore) || in_array($this->command, $ignore)) {
110 $signature = !empty($_SERVER['HTTP_SIGNATURE']);
111 $load = number_format(System::currentLoad(), 2);
112 $runtime = number_format(microtime(true) - $this->timestamp, 3);
113 if ($runtime > $config->get('system', 'runtime_loglimit')) {
114 Logger::debug('Runtime', ['method' => $this->method, 'module' => $this->module, 'runtime' => $runtime, 'load' => $load, 'origin' => $origin, 'signature' => $signature, 'request' => $_SERVER['REQUEST_URI'] ?? '']);
119 * Whether a offset exists
121 * @link https://php.net/manual/en/arrayaccess.offsetexists.php
123 * @param mixed $offset <p>
124 * An offset to check for.
127 * @return boolean true on success or false on failure.
130 * The return value will be casted to boolean if non-boolean was returned.
133 public function offsetExists($offset): bool
135 return isset($this->page[$offset]);
141 * @link https://php.net/manual/en/arrayaccess.offsetget.php
143 * @param mixed $offset <p>
144 * The offset to retrieve.
147 * @return mixed Can return all value types.
150 public function offsetGet($offset)
152 return $this->page[$offset] ?? null;
158 * @link https://php.net/manual/en/arrayaccess.offsetset.php
160 * @param mixed $offset <p>
161 * The offset to assign the value to.
163 * @param mixed $value <p>
170 public function offsetSet($offset, $value)
172 $this->page[$offset] = $value;
178 * @link https://php.net/manual/en/arrayaccess.offsetunset.php
180 * @param mixed $offset <p>
181 * The offset to unset.
187 public function offsetUnset($offset)
189 if (isset($this->page[$offset])) {
190 unset($this->page[$offset]);
195 * Register a stylesheet file path to be included in the <head> tag of every page.
196 * Inclusion is done in App->initHead().
197 * The path can be absolute or relative to the Friendica installation base folder.
199 * @param string $path
200 * @param string $media
201 * @see Page::initHead()
203 public function registerStylesheet(string $path, string $media = 'screen')
205 $path = Network::appendQueryParam($path, ['v' => App::VERSION]);
207 if (mb_strpos($path, $this->basePath . DIRECTORY_SEPARATOR) === 0) {
208 $path = mb_substr($path, mb_strlen($this->basePath . DIRECTORY_SEPARATOR));
211 $this->stylesheets[trim($path, '/')] = $media;
215 * Initializes Page->page['htmlhead'].
220 * - Registered stylesheets (through App->registerStylesheet())
221 * - Infinite scroll data
222 * - head.tpl template
224 * @param App $app The Friendica App instance
225 * @param Arguments $args The Friendica App Arguments
226 * @param L10n $l10n The l10n language instance
227 * @param IManageConfigValues $config The Friendica configuration
228 * @param IManagePersonalConfigValues $pConfig The Friendica personal configuration (for user)
229 * @param int $localUID The local user id
231 * @throws HTTPException\InternalServerErrorException
233 private function initHead(App $app, Arguments $args, L10n $l10n, IManageConfigValues $config, IManagePersonalConfigValues $pConfig, int $localUID)
235 $interval = ($localUID ? $pConfig->get($localUID, 'system', 'update_interval') : 40000);
237 // If the update is 'deactivated' set it to the highest integer number (~24 days)
239 $interval = 2147483647;
242 if ($interval < 10000) {
246 // Default title: current module called
247 if (empty($this->page['title']) && $args->getModuleName()) {
248 $this->page['title'] = ucfirst($args->getModuleName());
251 // Prepend the sitename to the page title
252 $this->page['title'] = $config->get('config', 'sitename', '') . (!empty($this->page['title']) ? ' | ' . $this->page['title'] : '');
254 if (!empty(Renderer::$theme['stylesheet'])) {
255 $stylesheet = Renderer::$theme['stylesheet'];
257 $stylesheet = $app->getCurrentThemeStylesheetPath();
260 $this->registerStylesheet($stylesheet);
262 $shortcut_icon = $config->get('system', 'shortcut_icon');
263 if ($shortcut_icon == '') {
264 $shortcut_icon = 'images/friendica.svg';
267 $touch_icon = $config->get('system', 'touch_icon');
268 if ($touch_icon == '') {
269 $touch_icon = 'images/friendica-192.png';
272 Hook::callAll('head', $this->page['htmlhead']);
274 $tpl = Renderer::getMarkupTemplate('head.tpl');
275 /* put the head template at the beginning of page['htmlhead']
276 * since the code added by the modules frequently depends on it
279 $this->page['htmlhead'] = Renderer::replaceMacros($tpl, [
280 '$local_user' => $localUID,
281 '$generator' => 'Friendica' . ' ' . App::VERSION,
282 '$delitem' => $l10n->t('Delete this item?'),
283 '$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.'),
284 '$update_interval' => $interval,
285 '$shortcut_icon' => $shortcut_icon,
286 '$touch_icon' => $touch_icon,
287 '$block_public' => intval($config->get('system', 'block_public')),
288 '$stylesheets' => $this->stylesheets,
289 ]) . $this->page['htmlhead'];
293 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
295 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
297 private function curPageURL(): string
300 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
306 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
307 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
309 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
315 * Initializes Page->page['footer'].
318 * - Javascript homebase
319 * - Mobile toggle link
320 * - Registered footer scripts (through App->registerFooterScript())
321 * - footer.tpl template
323 * @param App $app The Friendica App instance
324 * @param Mode $mode The Friendica runtime mode
325 * @param L10n $l10n The l10n instance
327 * @throws HTTPException\InternalServerErrorException
329 private function initFooter(App $app, Mode $mode, L10n $l10n)
331 // If you're just visiting, let javascript take you home
332 if (!empty($_SESSION['visitor_home'])) {
333 $homebase = $_SESSION['visitor_home'];
334 } elseif (!empty($app->getLoggedInUserNickname())) {
335 $homebase = 'profile/' . $app->getLoggedInUserNickname();
338 if (isset($homebase)) {
339 $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
343 * Add a "toggle mobile" link if we're using a mobile device
345 if ($mode->isMobile() || $mode->isTablet()) {
346 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
347 $link = 'toggle_mobile?address=' . urlencode($this->curPageURL());
349 $link = 'toggle_mobile?off=1&address=' . urlencode($this->curPageURL());
351 $this->page['footer'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
352 '$toggle_link' => $link,
353 '$toggle_text' => $l10n->t('toggle mobile')
357 Hook::callAll('footer', $this->page['footer']);
359 $tpl = Renderer::getMarkupTemplate('footer.tpl');
360 $this->page['footer'] = Renderer::replaceMacros($tpl, [
361 '$footerScripts' => array_unique($this->footerScripts),
362 ]) . $this->page['footer'];
366 * Initializes Page->page['content'].
370 * - hooks for content
372 * @param ResponseInterface $response The Module response class
373 * @param Mode $mode The Friendica execution mode
375 * @throws HTTPException\InternalServerErrorException
377 private function initContent(ResponseInterface $response, Mode $mode)
379 // initialise content region
380 if ($mode->isNormal()) {
381 Hook::callAll('page_content_top', $this->page['content']);
384 $this->page['content'] .= (string)$response->getBody();
388 * Register a javascript file path to be included in the <footer> tag of every page.
389 * Inclusion is done in App->initFooter().
390 * The path can be absolute or relative to the Friendica installation base folder.
392 * @param string $path
394 * @see Page::initFooter()
397 public function registerFooterScript($path)
399 $path = Network::appendQueryParam($path, ['v' => App::VERSION]);
401 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
403 $this->footerScripts[] = trim($url, '/');
407 * Directly exit with the current response (include setting all headers)
409 * @param ResponseInterface $response
411 public function exit(ResponseInterface $response)
413 header(sprintf("HTTP/%s %s %s",
414 $response->getProtocolVersion(),
415 $response->getStatusCode(),
416 $response->getReasonPhrase())
419 foreach ($response->getHeaders() as $key => $header) {
420 if (is_array($header)) {
421 $header_str = implode(',', $header);
423 $header_str = $header;
429 header("$key: $header_str");
433 echo $response->getBody();
437 * Executes the creation of the current page and prints it to the screen
439 * @param App $app The Friendica App
440 * @param BaseURL $baseURL The Friendica Base URL
441 * @param Arguments $args The Friendica App arguments
442 * @param Mode $mode The current node mode
443 * @param ResponseInterface $response The Response of the module class, including type, content & headers
444 * @param L10n $l10n The l10n language class
445 * @param IManageConfigValues $config The Configuration of this node
446 * @param IManagePersonalConfigValues $pconfig The personal/user configuration
447 * @param int $localUID The UID of the local user
449 * @throws HTTPException\InternalServerErrorException|HTTPException\ServiceUnavailableException
451 public function run(App $app, BaseURL $baseURL, Arguments $args, Mode $mode, ResponseInterface $response, L10n $l10n, Profiler $profiler, IManageConfigValues $config, IManagePersonalConfigValues $pconfig, int $localUID)
453 $moduleName = $args->getModuleName();
455 $this->command = $moduleName;
456 $this->method = $args->getMethod();
458 /* Create the page content.
459 * Calls all hooks which are including content operations
461 * Sets the $Page->page['content'] variable
463 $timestamp = microtime(true);
464 $this->initContent($response, $mode);
466 // Load current theme info after module has been initialized as theme could have been set in module
467 $currentTheme = $app->getCurrentTheme();
468 $theme_info_file = 'view/theme/' . $currentTheme . '/theme.php';
469 if (file_exists($theme_info_file)) {
470 require_once $theme_info_file;
473 if (function_exists(str_replace('-', '_', $currentTheme) . '_init')) {
474 $func = str_replace('-', '_', $currentTheme) . '_init';
478 /* Create the page head after setting the language
479 * and getting any auth credentials.
481 * Moved initHead() and initFooter() to after
482 * all the module functions have executed so that all
483 * theme choices made by the modules can take effect.
485 $this->initHead($app, $args, $l10n, $config, $pconfig, $localUID);
487 /* Build the page ending -- this is stuff that goes right before
488 * the closing </body> tag
490 $this->initFooter($app, $mode, $l10n);
492 $profiler->set(microtime(true) - $timestamp, 'aftermath');
494 if (!$mode->isAjax()) {
495 Hook::callAll('page_end', $this->page['content']);
498 // Add the navigation (menu) template
499 if ($moduleName != 'install' && $moduleName != 'maintenance') {
500 $this->page['htmlhead'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('nav_head.tpl'), []);
501 $this->page['nav'] = Nav::build($app);
504 foreach ($response->getHeaders() as $key => $header) {
505 if (is_array($header)) {
506 $header_str = implode(',', $header);
508 $header_str = $header;
514 header("$key: $header_str");
518 // Build the page - now that we have all the components
519 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
520 $doc = new DOMDocument();
522 $target = new DOMDocument();
523 $target->loadXML("<root></root>");
525 $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
527 /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
528 @$doc->loadHTML($content);
530 $xpath = new DOMXPath($doc);
532 $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
534 foreach ($list as $item) {
535 $item = $target->importNode($item, true);
537 // And then append it to the target
538 $target->documentElement->appendChild($item);
541 if ($_GET["mode"] == "raw") {
542 System::httpExit(substr($target->saveHTML(), 6, -8), Response::TYPE_HTML);
548 header("X-Friendica-Version: " . App::VERSION);
549 header("Content-type: text/html; charset=utf-8");
551 if ($config->get('system', 'hsts') && ($baseURL->getSSLPolicy() == BaseURL::SSL_POLICY_FULL)) {
552 header("Strict-Transport-Security: max-age=31536000");
555 // Some security stuff
556 header('X-Content-Type-Options: nosniff');
557 header('X-XSS-Protection: 1; mode=block');
558 header('X-Permitted-Cross-Domain-Policies: none');
559 header('X-Frame-Options: sameorigin');
561 // Things like embedded OSM maps don't work, when this is enabled
562 // header("Content-Security-Policy: default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; connect-src 'self'; style-src 'self' 'unsafe-inline'; font-src 'self'; img-src 'self' https: data:; media-src 'self' https:; child-src 'self' https:; object-src 'none'");
564 /* We use $_GET["mode"] for special page templates. So we will check if we have
565 * to load another page template than the default one.
566 * The page templates are located in /view/php/ or in the theme directory.
568 if (isset($_GET['mode'])) {
569 $template = Theme::getPathForFile('php/' . Strings::sanitizeFilePathItem($_GET['mode']) . '.php');
572 // If there is no page template use the default page template
573 if (empty($template)) {
574 $template = Theme::getPathForFile('php/default.php');
577 // Theme templates expect $a as an App instance
580 // Used as is in view/php/default.php
581 $lang = $l10n->getCurrentLang();
583 require_once $template;