3 * @copyright Copyright (C) 2020, Friendica
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\IConfig;
30 use Friendica\Core\PConfig\IPConfig;
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;
41 * Contains the page specific environment variables for the current Page
42 * - Contains all stylesheets
43 * - Contains all footer-scripts
44 * - Contains all page specific content (header, footer, content, ...)
46 * The run() method is the single point where the page will get printed to the screen
48 class Page implements ArrayAccess
51 * @var array Contains all stylesheets, which should get loaded during page
53 private $stylesheets = [];
55 * @var array Contains all scripts, which are added to the footer at last
57 private $footerScripts = [];
59 * @var array The page content, which are showed directly
74 * @var string The basepath of the page
79 * @param string $basepath The Page basepath
81 public function __construct(string $basepath)
83 $this->basePath = $basepath;
87 * Whether a offset exists
89 * @link https://php.net/manual/en/arrayaccess.offsetexists.php
91 * @param mixed $offset <p>
92 * An offset to check for.
95 * @return boolean true on success or false on failure.
98 * The return value will be casted to boolean if non-boolean was returned.
101 public function offsetExists($offset)
103 return isset($this->page[$offset]);
109 * @link https://php.net/manual/en/arrayaccess.offsetget.php
111 * @param mixed $offset <p>
112 * The offset to retrieve.
115 * @return mixed Can return all value types.
118 public function offsetGet($offset)
120 return $this->page[$offset] ?? null;
126 * @link https://php.net/manual/en/arrayaccess.offsetset.php
128 * @param mixed $offset <p>
129 * The offset to assign the value to.
131 * @param mixed $value <p>
138 public function offsetSet($offset, $value)
140 $this->page[$offset] = $value;
146 * @link https://php.net/manual/en/arrayaccess.offsetunset.php
148 * @param mixed $offset <p>
149 * The offset to unset.
155 public function offsetUnset($offset)
157 if (isset($this->page[$offset])) {
158 unset($this->page[$offset]);
163 * Register a stylesheet file path to be included in the <head> tag of every page.
164 * Inclusion is done in App->initHead().
165 * The path can be absolute or relative to the Friendica installation base folder.
167 * @param string $path
168 * @param string $media
169 * @see Page::initHead()
171 public function registerStylesheet($path, string $media = 'screen')
173 $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]);
175 if (mb_strpos($path, $this->basePath . DIRECTORY_SEPARATOR) === 0) {
176 $path = mb_substr($path, mb_strlen($this->basePath . DIRECTORY_SEPARATOR));
179 $this->stylesheets[trim($path, '/')] = $media;
183 * Initializes Page->page['htmlhead'].
188 * - Registered stylesheets (through App->registerStylesheet())
189 * - Infinite scroll data
190 * - head.tpl template
192 * @param App $app The Friendica App instance
193 * @param Module $module The loaded Friendica module
194 * @param L10n $l10n The l10n language instance
195 * @param IConfig $config The Friendica configuration
196 * @param IPConfig $pConfig The Friendica personal configuration (for user)
198 * @throws HTTPException\InternalServerErrorException
200 private function initHead(App $app, Module $module, L10n $l10n, IConfig $config, IPConfig $pConfig)
202 $interval = ((local_user()) ? $pConfig->get(local_user(), 'system', 'update_interval') : 40000);
204 // If the update is 'deactivated' set it to the highest integer number (~24 days)
206 $interval = 2147483647;
209 if ($interval < 10000) {
213 // Default title: current module called
214 if (empty($this->page['title']) && $module->getName()) {
215 $this->page['title'] = ucfirst($module->getName());
218 // Prepend the sitename to the page title
219 $this->page['title'] = $config->get('config', 'sitename', '') . (!empty($this->page['title']) ? ' | ' . $this->page['title'] : '');
221 if (!empty(Renderer::$theme['stylesheet'])) {
222 $stylesheet = Renderer::$theme['stylesheet'];
224 $stylesheet = $app->getCurrentThemeStylesheetPath();
227 $this->registerStylesheet($stylesheet);
229 $shortcut_icon = $config->get('system', 'shortcut_icon');
230 if ($shortcut_icon == '') {
231 $shortcut_icon = 'images/friendica-32.png';
234 $touch_icon = $config->get('system', 'touch_icon');
235 if ($touch_icon == '') {
236 $touch_icon = 'images/friendica-192.png';
239 Hook::callAll('head', $this->page['htmlhead']);
241 $tpl = Renderer::getMarkupTemplate('head.tpl');
242 /* put the head template at the beginning of page['htmlhead']
243 * since the code added by the modules frequently depends on it
246 $this->page['htmlhead'] = Renderer::replaceMacros($tpl, [
247 '$local_user' => local_user(),
248 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
249 '$delitem' => $l10n->t('Delete this item?'),
250 '$update_interval' => $interval,
251 '$shortcut_icon' => $shortcut_icon,
252 '$touch_icon' => $touch_icon,
253 '$block_public' => intval($config->get('system', 'block_public')),
254 '$stylesheets' => $this->stylesheets,
255 ]) . $this->page['htmlhead'];
259 * Initializes Page->page['footer'].
262 * - Javascript homebase
263 * - Mobile toggle link
264 * - Registered footer scripts (through App->registerFooterScript())
265 * - footer.tpl template
267 * @param App $app The Friendica App instance
268 * @param Mode $mode The Friendica runtime mode
269 * @param L10n $l10n The l10n instance
271 * @throws HTTPException\InternalServerErrorException
273 private function initFooter(App $app, Mode $mode, L10n $l10n)
275 // If you're just visiting, let javascript take you home
276 if (!empty($_SESSION['visitor_home'])) {
277 $homebase = $_SESSION['visitor_home'];
278 } elseif (!empty($app->user['nickname'])) {
279 $homebase = 'profile/' . $app->user['nickname'];
282 if (isset($homebase)) {
283 $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
287 * Add a "toggle mobile" link if we're using a mobile device
289 if ($mode->isMobile() || $mode->isTablet()) {
290 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
291 $link = 'toggle_mobile?address=' . urlencode(curPageURL());
293 $link = 'toggle_mobile?off=1&address=' . urlencode(curPageURL());
295 $this->page['footer'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate("toggle_mobile_footer.tpl"), [
296 '$toggle_link' => $link,
297 '$toggle_text' => $l10n->t('toggle mobile')
301 Hook::callAll('footer', $this->page['footer']);
303 $tpl = Renderer::getMarkupTemplate('footer.tpl');
304 $this->page['footer'] = Renderer::replaceMacros($tpl, [
305 '$footerScripts' => array_unique($this->footerScripts),
306 ]) . $this->page['footer'];
310 * Initializes Page->page['content'].
314 * - hooks for content
316 * @param Module $module The module
317 * @param Mode $mode The Friendica execution mode
319 * @throws HTTPException\InternalServerErrorException
321 private function initContent(Module $module, Mode $mode)
326 $moduleClass = $module->getClassName();
328 $arr = ['content' => $content];
329 Hook::callAll($moduleClass . '_mod_content', $arr);
330 $content = $arr['content'];
331 $arr = ['content' => call_user_func([$moduleClass, 'content'], $module->getParameters())];
332 Hook::callAll($moduleClass . '_mod_aftercontent', $arr);
333 $content .= $arr['content'];
334 } catch (HTTPException $e) {
335 $content = ModuleHTTPException::content($e);
338 // initialise content region
339 if ($mode->isNormal()) {
340 Hook::callAll('page_content_top', $this->page['content']);
343 $this->page['content'] .= $content;
347 * Register a javascript file path to be included in the <footer> tag of every page.
348 * Inclusion is done in App->initFooter().
349 * The path can be absolute or relative to the Friendica installation base folder.
351 * @param string $path
353 * @see Page::initFooter()
356 public function registerFooterScript($path)
358 $path = Network::appendQueryParam($path, ['v' => FRIENDICA_VERSION]);
360 $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
362 $this->footerScripts[] = trim($url, '/');
366 * Executes the creation of the current page and prints it to the screen
368 * @param App $app The Friendica App
369 * @param BaseURL $baseURL The Friendica Base URL
370 * @param Mode $mode The current node mode
371 * @param Module $module The loaded Friendica module
372 * @param L10n $l10n The l10n language class
373 * @param IConfig $config The Configuration of this node
374 * @param IPConfig $pconfig The personal/user configuration
376 * @throws HTTPException\InternalServerErrorException
378 public function run(App $app, BaseURL $baseURL, Mode $mode, Module $module, L10n $l10n, IConfig $config, IPConfig $pconfig)
380 $moduleName = $module->getName();
382 /* Create the page content.
383 * Calls all hooks which are including content operations
385 * Sets the $Page->page['content'] variable
387 $this->initContent($module, $mode);
389 // Load current theme info after module has been initialized as theme could have been set in module
390 $currentTheme = $app->getCurrentTheme();
391 $theme_info_file = 'view/theme/' . $currentTheme . '/theme.php';
392 if (file_exists($theme_info_file)) {
393 require_once $theme_info_file;
396 if (function_exists(str_replace('-', '_', $currentTheme) . '_init')) {
397 $func = str_replace('-', '_', $currentTheme) . '_init';
401 /* Create the page head after setting the language
402 * and getting any auth credentials.
404 * Moved initHead() and initFooter() to after
405 * all the module functions have executed so that all
406 * theme choices made by the modules can take effect.
408 $this->initHead($app, $module, $l10n, $config, $pconfig);
410 /* Build the page ending -- this is stuff that goes right before
411 * the closing </body> tag
413 $this->initFooter($app, $mode, $l10n);
415 if (!$mode->isAjax()) {
416 Hook::callAll('page_end', $this->page['content']);
419 // Add the navigation (menu) template
420 if ($moduleName != 'install' && $moduleName != 'maintenance') {
421 $this->page['htmlhead'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('nav_head.tpl'), []);
422 $this->page['nav'] = Nav::build($app);
425 // Build the page - now that we have all the components
426 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
427 $doc = new DOMDocument();
429 $target = new DOMDocument();
430 $target->loadXML("<root></root>");
432 $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
434 /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
435 @$doc->loadHTML($content);
437 $xpath = new DOMXPath($doc);
439 $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
441 foreach ($list as $item) {
442 $item = $target->importNode($item, true);
444 // And then append it to the target
445 $target->documentElement->appendChild($item);
448 if ($_GET["mode"] == "raw") {
449 header("Content-type: text/html; charset=utf-8");
451 echo substr($target->saveHTML(), 6, -8);
458 $profile = $app->profile;
460 header("X-Friendica-Version: " . FRIENDICA_VERSION);
461 header("Content-type: text/html; charset=utf-8");
463 if ($config->get('system', 'hsts') && ($baseURL->getSSLPolicy() == BaseURL::SSL_POLICY_FULL)) {
464 header("Strict-Transport-Security: max-age=31536000");
467 // Some security stuff
468 header('X-Content-Type-Options: nosniff');
469 header('X-XSS-Protection: 1; mode=block');
470 header('X-Permitted-Cross-Domain-Policies: none');
471 header('X-Frame-Options: sameorigin');
473 // Things like embedded OSM maps don't work, when this is enabled
474 // 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'");
476 /* We use $_GET["mode"] for special page templates. So we will check if we have
477 * to load another page template than the default one.
478 * The page templates are located in /view/php/ or in the theme directory.
480 if (isset($_GET['mode'])) {
481 $template = Theme::getPathForFile('php/' . Strings::sanitizeFilePathItem($_GET['mode']) . '.php');
484 // If there is no page template use the default page template
485 if (empty($template)) {
486 $template = Theme::getPathForFile('php/default.php');
489 // Theme templates expect $a as an App instance
492 // Used as is in view/php/default.php
493 $lang = $l10n->getCurrentLang();
495 require_once $template;