src/App/Page.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\App;
  23
  24 use ArrayAccess;
  25 use DOMDocument;
  26 use DOMXPath;
  27 use 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\Renderer;
  34 use Friendica\Core\Theme;
  35 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
  36 use Friendica\Network\HTTPException;
  37 use Friendica\Util\Network;
  38 use Friendica\Util\Strings;
  39 use Friendica\Util\Profiler;
  40
  41 /**
  42  * Contains the page specific environment variables for the current Page
  43  * - Contains all stylesheets
  44  * - Contains all footer-scripts
  45  * - Contains all page specific content (header, footer, content, ...)
  46  *
  47  * The run() method is the single point where the page will get printed to the screen
  48  */
  49 class Page implements ArrayAccess
  50 {
  51         /**
  52          * @var array Contains all stylesheets, which should get loaded during page
  53          */
  54         private $stylesheets = [];
  55         /**
  56          * @var array Contains all scripts, which are added to the footer at last
  57          */
  58         private $footerScripts = [];
  59         /**
  60          * @var array The page content, which are showed directly
  61          */
  62         private $page = [
  63                 'aside'       => '',
  64                 'bottom'      => '',
  65                 'content'     => '',
  66                 'footer'      => '',
  67                 'htmlhead'    => '',
  68                 'nav'         => '',
  69                 'page_title'  => '',
  70                 'right_aside' => '',
  71                 'template'    => '',
  72                 'title'       => '',
  73         ];
  74         /**
  75          * @var string The basepath of the page
  76          */
  77         private $basePath;
  78
  79         /**
  80          * @param string $basepath The Page basepath
  81          */
  82         public function __construct(string $basepath)
  83         {
  84                 $this->basePath = $basepath;
  85         }
  86
  87         /**
  88          * Whether a offset exists
  89          *
  90          * @link  https://php.net/manual/en/arrayaccess.offsetexists.php
  91          *
  92          * @param mixed $offset <p>
  93          *                      An offset to check for.
  94          *                      </p>
  95          *
  96          * @return boolean true on success or false on failure.
  97          * </p>
  98          * <p>
  99          * The return value will be casted to boolean if non-boolean was returned.
 100          * @since 5.0.0
 101          */
 102         public function offsetExists($offset)
 103         {
 104                 return isset($this->page[$offset]);
 105         }
 106
 107         /**
 108          * Offset to retrieve
 109          *
 110          * @link  https://php.net/manual/en/arrayaccess.offsetget.php
 111          *
 112          * @param mixed $offset <p>
 113          *                      The offset to retrieve.
 114          *                      </p>
 115          *
 116          * @return mixed Can return all value types.
 117          * @since 5.0.0
 118          */
 119         public function offsetGet($offset)
 120         {
 121                 return $this->page[$offset] ?? null;
 122         }
 123
 124         /**
 125          * Offset to set
 126          *
 127          * @link  https://php.net/manual/en/arrayaccess.offsetset.php
 128          *
 129          * @param mixed $offset <p>
 130          *                      The offset to assign the value to.
 131          *                      </p>
 132          * @param mixed $value  <p>
 133          *                      The value to set.
 134          *                      </p>
 135          *
 136          * @return void
 137          * @since 5.0.0
 138          */
 139         public function offsetSet($offset, $value)
 140         {
 141                 $this->page[$offset] = $value;
 142         }
 143
 144         /**
 145          * Offset to unset
 146          *
 147          * @link  https://php.net/manual/en/arrayaccess.offsetunset.php
 148          *
 149          * @param mixed $offset <p>
 150          *                      The offset to unset.
 151          *                      </p>
 152          *
 153          * @return void
 154          * @since 5.0.0
 155          */
 156         public function offsetUnset($offset)
 157         {
 158                 if (isset($this->page[$offset])) {
 159                         unset($this->page[$offset]);
 160                 }
 161         }
 162
 163         /**
 164          * Register a stylesheet file path to be included in the <head> tag of every page.
 165          * Inclusion is done in App->initHead().
 166          * The path can be absolute or relative to the Friendica installation base folder.
 167          *
 168          * @param string $path
 169          * @param string $media
 170          * @see Page::initHead()
 171          */
 172         public function registerStylesheet($path, string $media = 'screen')
 173         {
 174                 $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]);
 175
 176                 if (mb_strpos($path, $this->basePath . DIRECTORY_SEPARATOR) === 0) {
 177                         $path = mb_substr($path, mb_strlen($this->basePath . DIRECTORY_SEPARATOR));
 178                 }
 179
 180                 $this->stylesheets[trim($path, '/')] = $media;
 181         }
 182
 183         /**
 184          * Initializes Page->page['htmlhead'].
 185          *
 186          * Includes:
 187          * - Page title
 188          * - Favicons
 189          * - Registered stylesheets (through App->registerStylesheet())
 190          * - Infinite scroll data
 191          * - head.tpl template
 192          *
 193          * @param App                         $app     The Friendica App instance
 194          * @param ModuleController            $module  The loaded Friendica module
 195          * @param L10n                        $l10n    The l10n language instance
 196          * @param IManageConfigValues         $config  The Friendica configuration
 197          * @param IManagePersonalConfigValues $pConfig The Friendica personal configuration (for user)
 198          *
 199          * @throws HTTPException\InternalServerErrorException
 200          */
 201         private function initHead(App $app, ModuleController $module, L10n $l10n, IManageConfigValues $config, IManagePersonalConfigValues $pConfig)
 202         {
 203                 $interval = ((local_user()) ? $pConfig->get(local_user(), 'system', 'update_interval') : 40000);
 204
 205                 // If the update is 'deactivated' set it to the highest integer number (~24 days)
 206                 if ($interval < 0) {
 207                         $interval = 2147483647;
 208                 }
 209
 210                 if ($interval < 10000) {
 211                         $interval = 40000;
 212                 }
 213
 214                 // Default title: current module called
 215                 if (empty($this->page['title']) && $module->getName()) {
 216                         $this->page['title'] = ucfirst($module->getName());
 217                 }
 218
 219                 // Prepend the sitename to the page title
 220                 $this->page['title'] = $config->get('config', 'sitename', '') . (!empty($this->page['title']) ? ' | ' . $this->page['title'] : '');
 221
 222                 if (!empty(Renderer::$theme['stylesheet'])) {
 223                         $stylesheet = Renderer::$theme['stylesheet'];
 224                 } else {
 225                         $stylesheet = $app->getCurrentThemeStylesheetPath();
 226                 }
 227
 228                 $this->registerStylesheet($stylesheet);
 229
 230                 $shortcut_icon = $config->get('system', 'shortcut_icon');
 231                 if ($shortcut_icon == '') {
 232                         $shortcut_icon = 'images/friendica-32.png';
 233                 }
 234
 235                 $touch_icon = $config->get('system', 'touch_icon');
 236                 if ($touch_icon == '') {
 237                         $touch_icon = 'images/friendica-192.png';
 238                 }
 239
 240                 Hook::callAll('head', $this->page['htmlhead']);
 241
 242                 $tpl = Renderer::getMarkupTemplate('head.tpl');
 243                 /* put the head template at the beginning of page['htmlhead']
 244                  * since the code added by the modules frequently depends on it
 245                  * being first
 246                  */
 247                 $this->page['htmlhead'] = Renderer::replaceMacros($tpl, [
 248                         '$local_user'      => local_user(),
 249                         '$generator'       => 'Friendica' . ' ' . FRIENDICA_VERSION,
 250                         '$delitem'         => $l10n->t('Delete this item?'),
 251                         '$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.'),
 252                         '$update_interval' => $interval,
 253                         '$shortcut_icon'   => $shortcut_icon,
 254                         '$touch_icon'      => $touch_icon,
 255                         '$block_public'    => intval($config->get('system', 'block_public')),
 256                         '$stylesheets'     => $this->stylesheets,
 257                 ]) . $this->page['htmlhead'];
 258         }
 259
 260         /**
 261          * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
 262          *
 263          * Taken from http://webcheatsheet.com/php/get_current_page_url.php
 264          */
 265         private function curPageURL()
 266         {
 267                 $pageURL = 'http';
 268                 if (!empty($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) {
 269                         $pageURL .= "s";
 270                 }
 271
 272                 $pageURL .= "://";
 273
 274                 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
 275                         $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
 276                 } else {
 277                         $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
 278                 }
 279                 return $pageURL;
 280         }
 281
 282         /**
 283          * Initializes Page->page['footer'].
 284          *
 285          * Includes:
 286          * - Javascript homebase
 287          * - Mobile toggle link
 288          * - Registered footer scripts (through App->registerFooterScript())
 289          * - footer.tpl template
 290          *
 291          * @param App  $app  The Friendica App instance
 292          * @param Mode $mode The Friendica runtime mode
 293          * @param L10n $l10n The l10n instance
 294          *
 295          * @throws HTTPException\InternalServerErrorException
 296          */
 297         private function initFooter(App $app, Mode $mode, L10n $l10n)
 298         {
 299                 // If you're just visiting, let javascript take you home
 300                 if (!empty($_SESSION['visitor_home'])) {
 301                         $homebase = $_SESSION['visitor_home'];
 302                 } elseif (!empty($app->getLoggedInUserNickname())) {
 303                         $homebase = 'profile/' . $app->getLoggedInUserNickname();
 304                 }
 305
 306                 if (isset($homebase)) {
 307                         $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
 308                 }
 309
 310                 /*
 311                  * Add a "toggle mobile" link if we're using a mobile device
 312                  */
 313                 if ($mode->isMobile() || $mode->isTablet()) {
 314                         if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
 315                                 $link = 'toggle_mobile?address=' . urlencode($this->curPageURL());
 316                         } else {
 317                                 $link = 'toggle_mobile?off=1&address=' . urlencode($this->curPageURL());
 318                         }
 319                         $this->page['footer'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
 320                                 '$toggle_link' => $link,
 321                                 '$toggle_text' => $l10n->t('toggle mobile')
 322                         ]);
 323                 }
 324
 325                 Hook::callAll('footer', $this->page['footer']);
 326
 327                 $tpl                  = Renderer::getMarkupTemplate('footer.tpl');
 328                 $this->page['footer'] = Renderer::replaceMacros($tpl, [
 329                         '$footerScripts' => array_unique($this->footerScripts),
 330                 ]) . $this->page['footer'];
 331         }
 332
 333         /**
 334          * Initializes Page->page['content'].
 335          *
 336          * Includes:
 337          * - module content
 338          * - hooks for content
 339          *
 340          * @param ModuleController $module The module
 341          * @param Mode             $mode   The Friendica execution mode
 342          *
 343          * @throws HTTPException\InternalServerErrorException
 344          */
 345         private function initContent(ModuleController $module, Mode $mode)
 346         {
 347                 $content = '';
 348
 349                 try {
 350                         $moduleClass = $module->getModule();
 351
 352                         $arr = ['content' => $content];
 353                         Hook::callAll($moduleClass->getClassName() . '_mod_content', $arr);
 354                         $content = $arr['content'];
 355                         $content .= $module->getModule()->content();
 356                 } catch (HTTPException $e) {
 357                         $content = (new ModuleHTTPException())->content($e);
 358                 }
 359
 360                 // initialise content region
 361                 if ($mode->isNormal()) {
 362                         Hook::callAll('page_content_top', $this->page['content']);
 363                 }
 364
 365                 $this->page['content'] .= $content;
 366         }
 367
 368         /**
 369          * Register a javascript file path to be included in the <footer> tag of every page.
 370          * Inclusion is done in App->initFooter().
 371          * The path can be absolute or relative to the Friendica installation base folder.
 372          *
 373          * @param string $path
 374          *
 375          * @see Page::initFooter()
 376          *
 377          */
 378         public function registerFooterScript($path)
 379         {
 380                 $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]);
 381
 382                 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
 383
 384                 $this->footerScripts[] = trim($url, '/');
 385         }
 386
 387         /**
 388          * Executes the creation of the current page and prints it to the screen
 389          *
 390          * @param App                         $app     The Friendica App
 391          * @param BaseURL                     $baseURL The Friendica Base URL
 392          * @param Mode                        $mode    The current node mode
 393          * @param ModuleController            $module  The loaded Friendica module
 394          * @param L10n                        $l10n    The l10n language class
 395          * @param IManageConfigValues         $config  The Configuration of this node
 396          * @param IManagePersonalConfigValues $pconfig The personal/user configuration
 397          *
 398          * @throws HTTPException\InternalServerErrorException
 399          */
 400         public function run(App $app, BaseURL $baseURL, Mode $mode, ModuleController $module, L10n $l10n, Profiler $profiler, IManageConfigValues $config, IManagePersonalConfigValues $pconfig)
 401         {
 402                 $moduleName = $module->getName();
 403
 404                 /* Create the page content.
 405                  * Calls all hooks which are including content operations
 406                  *
 407                  * Sets the $Page->page['content'] variable
 408                  */
 409                 $timestamp = microtime(true);
 410                 $this->initContent($module, $mode);
 411                 $profiler->set(microtime(true) - $timestamp, 'content');
 412
 413                 // Load current theme info after module has been initialized as theme could have been set in module
 414                 $currentTheme = $app->getCurrentTheme();
 415                 $theme_info_file = 'view/theme/' . $currentTheme . '/theme.php';
 416                 if (file_exists($theme_info_file)) {
 417                         require_once $theme_info_file;
 418                 }
 419
 420                 if (function_exists(str_replace('-', '_', $currentTheme) . '_init')) {
 421                         $func = str_replace('-', '_', $currentTheme) . '_init';
 422                         $func($app);
 423                 }
 424
 425                 /* Create the page head after setting the language
 426                  * and getting any auth credentials.
 427                  *
 428                  * Moved initHead() and initFooter() to after
 429                  * all the module functions have executed so that all
 430                  * theme choices made by the modules can take effect.
 431                  */
 432                 $this->initHead($app, $module, $l10n, $config, $pconfig);
 433
 434                 /* Build the page ending -- this is stuff that goes right before
 435                  * the closing </body> tag
 436                  */
 437                 $this->initFooter($app, $mode, $l10n);
 438
 439                 if (!$mode->isAjax()) {
 440                         Hook::callAll('page_end', $this->page['content']);
 441                 }
 442
 443                 // Add the navigation (menu) template
 444                 if ($moduleName != 'install' && $moduleName != 'maintenance') {
 445                         $this->page['htmlhead'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('nav_head.tpl'), []);
 446                         $this->page['nav']      = Nav::build($app);
 447                 }
 448
 449                 // Build the page - now that we have all the components
 450                 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
 451                         $doc = new DOMDocument();
 452
 453                         $target = new DOMDocument();
 454                         $target->loadXML("<root></root>");
 455
 456                         $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
 457
 458                         /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
 459                         @$doc->loadHTML($content);
 460
 461                         $xpath = new DOMXPath($doc);
 462
 463                         $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]");  /* */
 464
 465                         foreach ($list as $item) {
 466                                 $item = $target->importNode($item, true);
 467
 468                                 // And then append it to the target
 469                                 $target->documentElement->appendChild($item);
 470                         }
 471
 472                         if ($_GET["mode"] == "raw") {
 473                                 header("Content-type: text/html; charset=utf-8");
 474
 475                                 echo substr($target->saveHTML(), 6, -8);
 476
 477                                 exit();
 478                         }
 479                 }
 480
 481                 $page    = $this->page;
 482
 483                 header("X-Friendica-Version: " . FRIENDICA_VERSION);
 484                 header("Content-type: text/html; charset=utf-8");
 485
 486                 if ($config->get('system', 'hsts') && ($baseURL->getSSLPolicy() == BaseURL::SSL_POLICY_FULL)) {
 487                         header("Strict-Transport-Security: max-age=31536000");
 488                 }
 489
 490                 // Some security stuff
 491                 header('X-Content-Type-Options: nosniff');
 492                 header('X-XSS-Protection: 1; mode=block');
 493                 header('X-Permitted-Cross-Domain-Policies: none');
 494                 header('X-Frame-Options: sameorigin');
 495
 496                 // Things like embedded OSM maps don't work, when this is enabled
 497                 // 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'");
 498
 499                 /* We use $_GET["mode"] for special page templates. So we will check if we have
 500                  * to load another page template than the default one.
 501                  * The page templates are located in /view/php/ or in the theme directory.
 502                  */
 503                 if (isset($_GET['mode'])) {
 504                         $template = Theme::getPathForFile('php/' . Strings::sanitizeFilePathItem($_GET['mode']) . '.php');
 505                 }
 506
 507                 // If there is no page template use the default page template
 508                 if (empty($template)) {
 509                         $template = Theme::getPathForFile('php/default.php');
 510                 }
 511
 512                 // Theme templates expect $a as an App instance
 513                 $a = $app;
 514
 515                 // Used as is in view/php/default.php
 516                 $lang = $l10n->getCurrentLang();
 517
 518                 require_once $template;
 519         }
 520 }