From 9f68e6b589e71a88d8562e9d689005fef7ce5948 Mon Sep 17 00:00:00 2001
From: Philipp Holzer
Date: Thu, 15 Aug 2019 20:52:42 +0200
Subject: [PATCH] Add Page class for Frontend - Move frontend logic
(stylesheet, footerscript, content) to Page class
---
src/App.php | 293 +--------------------
src/App/Page.php | 466 +++++++++++++++++++++++++++++++++
static/dependencies.config.php | 5 +
3 files changed, 485 insertions(+), 279 deletions(-)
create mode 100644 src/App/Page.php
diff --git a/src/App.php b/src/App.php
index 749cbe9cc..e7381ab12 100644
--- a/src/App.php
+++ b/src/App.php
@@ -5,11 +5,10 @@
namespace Friendica;
use Detection\MobileDetect;
-use DOMDocument;
-use DOMXPath;
use Exception;
use Friendica\App\Arguments;
use Friendica\App\BaseURL;
+use Friendica\App\Page;
use Friendica\Core\Config\Cache\ConfigCache;
use Friendica\Core\Config\Configuration;
use Friendica\Core\Config\PConfiguration;
@@ -44,6 +43,9 @@ class App
{
/** @deprecated 2019.09 - use App\Arguments->getQueryString() */
public $query_string;
+ /**
+ * @var Page The current page environment
+ */
public $page;
public $profile;
public $profile_uid;
@@ -77,9 +79,7 @@ class App
public $videoheight = 350;
public $force_max_items = 0;
public $theme_events_in_profile = true;
-
- public $stylesheets = [];
- public $footerScripts = [];
+ public $queue;
/**
* @var App\Mode The Mode of the Application
@@ -213,43 +213,23 @@ class App
}
/**
- * 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
- *
- * @see initHead()
- *
+ * @deprecated 2019.09 - use Page->registerStylesheet instead
+ * @see Page::registerStylesheet()
*/
public function registerStylesheet($path)
{
- if (mb_strpos($path, $this->getBasePath() . DIRECTORY_SEPARATOR) === 0) {
- $path = mb_substr($path, mb_strlen($this->getBasePath() . DIRECTORY_SEPARATOR));
- }
-
- $this->stylesheets[] = trim($path, '/');
+ $this->page->registerStylesheet($path);
}
/**
- * Register a javascript file path to be included in the
+ *
+ * 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
+ *
+ * @see Page::initHead()
+ *
+ */
+ public function registerStylesheet($path)
+ {
+ if (mb_strpos($path, $this->basePath . DIRECTORY_SEPARATOR) === 0) {
+ $path = mb_substr($path, mb_strlen($this->basePath . DIRECTORY_SEPARATOR));
+ }
+
+ $this->stylesheets[] = trim($path, '/');
+ }
+
+ /**
+ * 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 Configuration $config The Friendica configuration
+ * @param PConfiguration $pConfig The Friendica personal configuration (for user)
+ *
+ * @throws HTTPException\InternalServerErrorException
+ */
+ private function initHead(App $app, Module $module, L10n $l10n, Configuration $config, PConfiguration $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-128.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?'),
+ '$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'];
+ }
+
+ /**
+ * 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 L10n $l10n The l10n instance
+ *
+ * @throws HTTPException\InternalServerErrorException
+ */
+ private function initFooter(App $app, L10n $l10n)
+ {
+ // If you're just visiting, let javascript take you home
+ if (!empty($_SESSION['visitor_home'])) {
+ $homebase = $_SESSION['visitor_home'];
+ } elseif (local_user()) {
+ $homebase = 'profile/' . $app->user['nickname'];
+ }
+
+ if (isset($homebase)) {
+ $this->page['footer'] .= '' . "\n";
+ }
+
+ /*
+ * Add a "toggle mobile" link if we're using a mobile device
+ */
+ if ($app->is_mobile || $app->is_tablet) {
+ if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
+ $link = 'toggle_mobile?address=' . urlencode(curPageURL());
+ } else {
+ $link = 'toggle_mobile?off=1&address=' . urlencode(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' => $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->getClassName();
+
+ $arr = ['content' => $content];
+ Hook::callAll($moduleClass . '_mod_content', $arr);
+ $content = $arr['content'];
+ $arr = ['content' => call_user_func([$moduleClass, 'content'])];
+ Hook::callAll($moduleClass . '_mod_aftercontent', $arr);
+ $content .= $arr['content'];
+ } catch (HTTPException $e) {
+ $content = 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 tag of every page.
+ * Inclusion is done in App->initFooter().
+ * The path can be absolute or relative to the Friendica installation base folder.
+ *
+ * @param string $path
+ *
+ * @see Page::initFooter()
+ *
+ */
+ public function registerFooterScript($path)
+ {
+ $url = str_replace($this->basePath . DIRECTORY_SEPARATOR, '', $path);
+
+ $this->footerScripts[] = trim($url, '/');
+ }
+
+ /**
+ * Executes the creation of the current page and prints it to the screen
+ *
+ * @param App $app The Friendica App
+ * @param BaseURL $baseURL The Friendica Base URL
+ * @param Mode $mode The current node mode
+ * @param Module $module The loaded Friendica module
+ * @param L10n $l10n The l10n language class
+ * @param Configuration $config The Configuration of this node
+ * @param PConfiguration $pconfig The personal/user configuration
+ *
+ * @throws HTTPException\InternalServerErrorException
+ */
+ public function run(App $app, BaseURL $baseURL, Mode $mode, Module $module, L10n $l10n, Configuration $config, PConfiguration $pconfig)
+ {
+ $moduleName = $module->getName();
+
+ // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid
+ $this->page['page_title'] = $moduleName;
+
+ /* Create the page content.
+ * Calls all hooks which are including content operations
+ *
+ * Sets the $Page->page['content'] variable
+ */
+ $this->initContent($module, $mode);
+
+ /* Create the page head after setting the language
+ * and getting any auth credentials.
+ *
+ * Moved initHead() and initFooter() to after
+ * all the module functions have executed so that all
+ * theme choices made by the modules can take effect.
+ */
+ $this->initHead($app, $module, $l10n, $config, $pconfig);
+
+ /* Build the page ending -- this is stuff that goes right before
+ * the closing tag
+ */
+ $this->initFooter($app, $l10n);
+
+ if (!$app->isAjax()) {
+ Hook::callAll('page_end', $this->page['content']);
+ }
+
+ // Add the navigation (menu) template
+ if ($moduleName != 'install' && $moduleName != 'maintenance') {
+ $this->page['htmlhead'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('nav_head.tpl'), []);
+ $this->page['nav'] = Nav::build($app);
+ }
+
+ // Build the page - now that we have all the components
+ if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
+ $doc = new DOMDocument();
+
+ $target = new DOMDocument();
+ $target->loadXML(" ");
+
+ $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
+
+ /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
+ @$doc->loadHTML($content);
+
+ $xpath = new DOMXPath($doc);
+
+ $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]"); /* */
+
+ foreach ($list as $item) {
+ $item = $target->importNode($item, true);
+
+ // And then append it to the target
+ $target->documentElement->appendChild($item);
+ }
+
+ if ($_GET["mode"] == "raw") {
+ header("Content-type: text/html; charset=utf-8");
+
+ echo substr($target->saveHTML(), 6, -8);
+
+ exit();
+ }
+ }
+
+ $page = $this->page;
+ $profile = $app->profile;
+
+ header("X-Friendica-Version: " . FRIENDICA_VERSION);
+ header("Content-type: text/html; charset=utf-8");
+
+ if ($config->get('system', 'hsts') && ($baseURL->getSSLPolicy() == BaseURL::SSL_POLICY_FULL)) {
+ header("Strict-Transport-Security: max-age=31536000");
+ }
+
+ // Some security stuff
+ header('X-Content-Type-Options: nosniff');
+ header('X-XSS-Protection: 1; mode=block');
+ header('X-Permitted-Cross-Domain-Policies: none');
+ header('X-Frame-Options: sameorigin');
+
+ // Things like embedded OSM maps don't work, when this is enabled
+ // 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'");
+
+ /* We use $_GET["mode"] for special page templates. So we will check if we have
+ * to load another page template than the default one.
+ * The page templates are located in /view/php/ or in the theme directory.
+ */
+ if (isset($_GET["mode"])) {
+ $template = Theme::getPathForFile($_GET["mode"] . '.php');
+ }
+
+ // If there is no page template use the default page template
+ if (empty($template)) {
+ $template = Theme::getPathForFile("default.php");
+ }
+
+ // Theme templates expect $a as an App instance
+ $a = $this;
+
+ // Used as is in view/php/default.php
+ $lang = $l10n->getCurrentLang();
+
+ /// @TODO Looks unsafe (remote-inclusion), is maybe not but Core\Theme::getPathForFile() uses file_exists() but does not escape anything
+ require_once $template;
+ }
+}
diff --git a/static/dependencies.config.php b/static/dependencies.config.php
index e32f99a60..d923c67bf 100644
--- a/static/dependencies.config.php
+++ b/static/dependencies.config.php
@@ -95,6 +95,11 @@ return [
$_SERVER,
],
],
+ App\Page::class => [
+ 'constructParams' => [
+ [Dice::INSTANCE => '$basepath'],
+ ],
+ ],
/**
* Create a Logger, which implements the LoggerInterface
*