src/App.php

   1 <?php
   2 /**
   3  * @file src/App.php
   4  */
   5 namespace Friendica;
   6
   7 use Detection\MobileDetect;
   8 use DOMDocument;
   9 use DOMXPath;
  10 use Exception;
  11 use Friendica\Database\DBA;
  12 use Friendica\Network\HTTPException\InternalServerErrorException;
  13
  14 require_once 'boot.php';
  15 require_once 'include/text.php';
  16
  17 /**
  18  *
  19  * class: App
  20  *
  21  * @brief Our main application structure for the life of this page.
  22  *
  23  * Primarily deals with the URL that got us here
  24  * and tries to make some sense of it, and
  25  * stores our page contents and config storage
  26  * and anything else that might need to be passed around
  27  * before we spit the page out.
  28  *
  29  */
  30 class App
  31 {
  32         public $module_loaded = false;
  33         public $module_class = null;
  34         public $query_string = '';
  35         public $config = [];
  36         public $page = [];
  37         public $pager = [];
  38         public $page_offset;
  39         public $profile;
  40         public $profile_uid;
  41         public $user;
  42         public $cid;
  43         public $contact;
  44         public $contacts;
  45         public $page_contact;
  46         public $content;
  47         public $data = [];
  48         public $error = false;
  49         public $cmd = '';
  50         public $argv;
  51         public $argc;
  52         public $module;
  53         public $timezone;
  54         public $interactive = true;
  55         public $identities;
  56         public $is_mobile = false;
  57         public $is_tablet = false;
  58         public $performance = [];
  59         public $callstack = [];
  60         public $theme_info = [];
  61         public $category;
  62         // Allow themes to control internal parameters
  63         // by changing App values in theme.php
  64
  65         public $sourcename = '';
  66         public $videowidth = 425;
  67         public $videoheight = 350;
  68         public $force_max_items = 0;
  69         public $theme_events_in_profile = true;
  70
  71         public $stylesheets = [];
  72         public $footerScripts = [];
  73
  74         /**
  75          * @var App\Mode The Mode of the Application
  76          */
  77         private $mode;
  78
  79         /**
  80          * @var string The App base path
  81          */
  82         private $basePath;
  83
  84         /**
  85          * @var string The App URL path
  86          */
  87         private $urlPath;
  88
  89         /**
  90          * @var bool true, if the call is from the Friendica APP, otherwise false
  91          */
  92         private $isFriendicaApp;
  93
  94         /**
  95          * @var bool true, if the call is from an backend node (f.e. worker)
  96          */
  97         private $isBackend;
  98
  99         /**
 100          * @var string The name of the current theme
 101          */
 102         private $currentTheme;
 103
 104         /**
 105          * @var bool check if request was an AJAX (xmlhttprequest) request
 106          */
 107         private $isAjax;
 108
 109         /**
 110          * Register a stylesheet file path to be included in the <head> tag of every page.
 111          * Inclusion is done in App->initHead().
 112          * The path can be absolute or relative to the Friendica installation base folder.
 113          *
 114          * @see initHead()
 115          *
 116          * @param string $path
 117          */
 118         public function registerStylesheet($path)
 119         {
 120                 $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
 121
 122                 $this->stylesheets[] = trim($url, '/');
 123         }
 124
 125         /**
 126          * Register a javascript file path to be included in the <footer> tag of every page.
 127          * Inclusion is done in App->initFooter().
 128          * The path can be absolute or relative to the Friendica installation base folder.
 129          *
 130          * @see initFooter()
 131          *
 132          * @param string $path
 133          */
 134         public function registerFooterScript($path)
 135         {
 136                 $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
 137
 138                 $this->footerScripts[] = trim($url, '/');
 139         }
 140
 141         /**
 142          * @brief An array for all theme-controllable parameters
 143          *
 144          * Mostly unimplemented yet. Only options 'template_engine' and
 145          * beyond are used.
 146          */
 147         public $theme = [
 148                 'sourcename' => '',
 149                 'videowidth' => 425,
 150                 'videoheight' => 350,
 151                 'force_max_items' => 0,
 152                 'stylesheet' => '',
 153                 'template_engine' => 'smarty3',
 154         ];
 155
 156         /**
 157          * @brief An array of registered template engines ('name'=>'class name')
 158          */
 159         public $template_engines = [];
 160
 161         /**
 162          * @brief An array of instanced template engines ('name'=>'instance')
 163          */
 164         public $template_engine_instance = [];
 165         public $process_id;
 166         public $queue;
 167         private $ldelim = [
 168                 'internal' => '',
 169                 'smarty3' => '{{'
 170         ];
 171         private $rdelim = [
 172                 'internal' => '',
 173                 'smarty3' => '}}'
 174         ];
 175         private $scheme;
 176         private $hostname;
 177
 178         /**
 179          * @brief App constructor.
 180          *
 181          * @param string $basePath  Path to the app base folder
 182          * @param bool   $isBackend Whether it is used for backend or frontend (Default true=backend)
 183          *
 184          * @throws Exception if the Basepath is not usable
 185          */
 186         public function __construct($basePath, $isBackend = true)
 187         {
 188                 if (!static::isDirectoryUsable($basePath, false)) {
 189                         throw new Exception('Basepath ' . $basePath . ' isn\'t usable.');
 190                 }
 191
 192                 BaseObject::setApp($this);
 193
 194                 $this->basePath = rtrim($basePath, DIRECTORY_SEPARATOR);
 195                 $this->checkBackend($isBackend);
 196                 $this->checkFriendicaApp();
 197
 198                 $this->performance['start'] = microtime(true);
 199                 $this->performance['database'] = 0;
 200                 $this->performance['database_write'] = 0;
 201                 $this->performance['cache'] = 0;
 202                 $this->performance['cache_write'] = 0;
 203                 $this->performance['network'] = 0;
 204                 $this->performance['file'] = 0;
 205                 $this->performance['rendering'] = 0;
 206                 $this->performance['parser'] = 0;
 207                 $this->performance['marktime'] = 0;
 208                 $this->performance['markstart'] = microtime(true);
 209
 210                 $this->callstack['database'] = [];
 211                 $this->callstack['database_write'] = [];
 212                 $this->callstack['cache'] = [];
 213                 $this->callstack['cache_write'] = [];
 214                 $this->callstack['network'] = [];
 215                 $this->callstack['file'] = [];
 216                 $this->callstack['rendering'] = [];
 217                 $this->callstack['parser'] = [];
 218
 219                 $this->mode = new App\Mode($basePath);
 220
 221                 $this->reload();
 222
 223                 set_time_limit(0);
 224
 225                 // This has to be quite large to deal with embedded private photos
 226                 ini_set('pcre.backtrack_limit', 500000);
 227
 228                 $this->scheme = 'http';
 229
 230                 if (!empty($_SERVER['HTTPS']) ||
 231                         !empty($_SERVER['HTTP_FORWARDED']) && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED']) ||
 232                         !empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ||
 233                         !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on' ||
 234                         !empty($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on' ||
 235                         !empty($_SERVER['SERVER_PORT']) && (intval($_SERVER['SERVER_PORT']) == 443) // XXX: reasonable assumption, but isn't this hardcoding too much?
 236                 ) {
 237                         $this->scheme = 'https';
 238                 }
 239
 240                 if (!empty($_SERVER['SERVER_NAME'])) {
 241                         $this->hostname = $_SERVER['SERVER_NAME'];
 242
 243                         if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
 244                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
 245                         }
 246                 }
 247
 248                 set_include_path(
 249                         get_include_path() . PATH_SEPARATOR
 250                         . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
 251                         . $this->getBasePath(). DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
 252                         . $this->getBasePath());
 253
 254                 if (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'pagename=') === 0) {
 255                         $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
 256                 } elseif (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'q=') === 0) {
 257                         $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
 258                 }
 259
 260                 // removing trailing / - maybe a nginx problem
 261                 $this->query_string = ltrim($this->query_string, '/');
 262
 263                 if (!empty($_GET['pagename'])) {
 264                         $this->cmd = trim($_GET['pagename'], '/\\');
 265                 } elseif (!empty($_GET['q'])) {
 266                         $this->cmd = trim($_GET['q'], '/\\');
 267                 }
 268
 269                 // fix query_string
 270                 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
 271
 272                 // unix style "homedir"
 273                 if (substr($this->cmd, 0, 1) === '~') {
 274                         $this->cmd = 'profile/' . substr($this->cmd, 1);
 275                 }
 276
 277                 // Diaspora style profile url
 278                 if (substr($this->cmd, 0, 2) === 'u/') {
 279                         $this->cmd = 'profile/' . substr($this->cmd, 2);
 280                 }
 281
 282                 /*
 283                  * Break the URL path into C style argc/argv style arguments for our
 284                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 285                  * will be 3 (integer) and $this->argv will contain:
 286                  *   [0] => 'module'
 287                  *   [1] => 'arg1'
 288                  *   [2] => 'arg2'
 289                  *
 290                  *
 291                  * There will always be one argument. If provided a naked domain
 292                  * URL, $this->argv[0] is set to "home".
 293                  */
 294
 295                 $this->argv = explode('/', $this->cmd);
 296                 $this->argc = count($this->argv);
 297                 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
 298                         $this->module = str_replace('.', '_', $this->argv[0]);
 299                         $this->module = str_replace('-', '_', $this->module);
 300                 } else {
 301                         $this->argc = 1;
 302                         $this->argv = ['home'];
 303                         $this->module = 'home';
 304                 }
 305
 306                 // See if there is any page number information, and initialise pagination
 307                 $this->pager['page'] = !empty($_GET['page']) && intval($_GET['page']) > 0 ? intval($_GET['page']) : 1;
 308                 $this->pager['itemspage'] = 50;
 309                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 310
 311                 if ($this->pager['start'] < 0) {
 312                         $this->pager['start'] = 0;
 313                 }
 314                 $this->pager['total'] = 0;
 315
 316                 // Detect mobile devices
 317                 $mobile_detect = new MobileDetect();
 318                 $this->is_mobile = $mobile_detect->isMobile();
 319                 $this->is_tablet = $mobile_detect->isTablet();
 320
 321                 $this->isAjax = strtolower(defaults($_SERVER, 'HTTP_X_REQUESTED_WITH', '')) == 'xmlhttprequest';
 322
 323                 // Register template engines
 324                 $this->registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
 325         }
 326
 327         /**
 328          * Returns the Mode of the Application
 329          *
 330          * @return App\Mode The Application Mode
 331          *
 332          * @throws InternalServerErrorException when the mode isn't created
 333          */
 334         public function getMode()
 335         {
 336                 if (empty($this->mode)) {
 337                         throw new InternalServerErrorException('Mode of the Application is not defined');
 338                 }
 339
 340                 return $this->mode;
 341         }
 342
 343         /**
 344          * Reloads the whole app instance
 345          */
 346         public function reload()
 347         {
 348                 // The order of the following calls is important to ensure proper initialization
 349                 $this->loadConfigFiles();
 350
 351                 $this->loadDatabase();
 352
 353                 $this->getMode()->determine($this->getBasePath());
 354
 355                 $this->determineURLPath();
 356
 357                 Core\Config::load();
 358
 359                 if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
 360                         Core\Hook::loadHooks();
 361
 362                         $this->loadAddonConfig();
 363                 }
 364
 365                 $this->loadDefaultTimezone();
 366
 367                 Core\L10n::init();
 368
 369                 $this->process_id = Core\System::processID('log');
 370         }
 371
 372         /**
 373          * Load the configuration files
 374          *
 375          * First loads the default value for all the configuration keys, then the legacy configuration files, then the
 376          * expected local.ini.php
 377          */
 378         private function loadConfigFiles()
 379         {
 380                 $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config.ini.php');
 381                 $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'settings.ini.php');
 382
 383                 // Legacy .htconfig.php support
 384                 if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
 385                         $a = $this;
 386                         include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php';
 387                 }
 388
 389                 // Legacy .htconfig.php support
 390                 if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htconfig.php')) {
 391                         $a = $this;
 392
 393                         include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htconfig.php';
 394
 395                         $this->setConfigValue('database', 'hostname', $db_host);
 396                         $this->setConfigValue('database', 'username', $db_user);
 397                         $this->setConfigValue('database', 'password', $db_pass);
 398                         $this->setConfigValue('database', 'database', $db_data);
 399                         if (isset($a->config['system']['db_charset'])) {
 400                                 $this->setConfigValue('database', 'charset', $a->config['system']['db_charset']);
 401                         }
 402
 403                         unset($db_host, $db_user, $db_pass, $db_data);
 404
 405                         if (isset($default_timezone)) {
 406                                 $this->setConfigValue('system', 'default_timezone', $default_timezone);
 407                                 unset($default_timezone);
 408                         }
 409
 410                         if (isset($pidfile)) {
 411                                 $this->setConfigValue('system', 'pidfile', $pidfile);
 412                                 unset($pidfile);
 413                         }
 414
 415                         if (isset($lang)) {
 416                                 $this->setConfigValue('system', 'language', $lang);
 417                                 unset($lang);
 418                         }
 419                 }
 420
 421                 if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
 422                         $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php', true);
 423                 }
 424         }
 425
 426         /**
 427          * Tries to load the specified configuration file into the App->config array.
 428          * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
 429          *
 430          * The config format is INI and the template for configuration files is the following:
 431          *
 432          * <?php return <<<INI
 433          *
 434          * [section]
 435          * key = value
 436          *
 437          * INI;
 438          * // Keep this line
 439          *
 440          * @param string $filepath
 441          * @param bool $overwrite Force value overwrite if the config key already exists
 442          * @throws Exception
 443          */
 444         public function loadConfigFile($filepath, $overwrite = false)
 445         {
 446                 if (!file_exists($filepath)) {
 447                         throw new Exception('Error parsing non-existent config file ' . $filepath);
 448                 }
 449
 450                 $contents = include($filepath);
 451
 452                 $config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
 453
 454                 if ($config === false) {
 455                         throw new Exception('Error parsing config file ' . $filepath);
 456                 }
 457
 458                 foreach ($config as $category => $values) {
 459                         foreach ($values as $key => $value) {
 460                                 if ($overwrite) {
 461                                         $this->setConfigValue($category, $key, $value);
 462                                 } else {
 463                                         $this->setDefaultConfigValue($category, $key, $value);
 464                                 }
 465                         }
 466                 }
 467         }
 468
 469         /**
 470          * Loads addons configuration files
 471          *
 472          * First loads all activated addons default configuration throught the load_config hook, then load the local.ini.php
 473          * again to overwrite potential local addon configuration.
 474          */
 475         private function loadAddonConfig()
 476         {
 477                 // Loads addons default config
 478                 Core\Addon::callHooks('load_config');
 479
 480                 // Load the local addon config file to overwritten default addon config values
 481                 if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php')) {
 482                         $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php', true);
 483                 }
 484         }
 485
 486         /**
 487          * Loads the default timezone
 488          *
 489          * Include support for legacy $default_timezone
 490          *
 491          * @global string $default_timezone
 492          */
 493         private function loadDefaultTimezone()
 494         {
 495                 if ($this->getConfigValue('system', 'default_timezone')) {
 496                         $this->timezone = $this->getConfigValue('system', 'default_timezone');
 497                 } else {
 498                         global $default_timezone;
 499                         $this->timezone = !empty($default_timezone) ? $default_timezone : 'UTC';
 500                 }
 501
 502                 if ($this->timezone) {
 503                         date_default_timezone_set($this->timezone);
 504                 }
 505         }
 506
 507         /**
 508          * Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
 509          */
 510         private function determineURLPath()
 511         {
 512                 /* Relative script path to the web server root
 513                  * Not all of those $_SERVER properties can be present, so we do by inverse priority order
 514                  */
 515                 $relative_script_path = '';
 516                 $relative_script_path = defaults($_SERVER, 'REDIRECT_URL'       , $relative_script_path);
 517                 $relative_script_path = defaults($_SERVER, 'REDIRECT_URI'       , $relative_script_path);
 518                 $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
 519                 $relative_script_path = defaults($_SERVER, 'SCRIPT_URL'         , $relative_script_path);
 520
 521                 $this->urlPath = $this->getConfigValue('system', 'urlpath');
 522
 523                 /* $relative_script_path gives /relative/path/to/friendica/module/parameter
 524                  * QUERY_STRING gives pagename=module/parameter
 525                  *
 526                  * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
 527                  */
 528                 if (!empty($relative_script_path)) {
 529                         // Module
 530                         if (!empty($_SERVER['QUERY_STRING'])) {
 531                                 $path = trim(dirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
 532                         } else {
 533                                 // Root page
 534                                 $path = trim($relative_script_path, '/');
 535                         }
 536
 537                         if ($path && $path != $this->urlPath) {
 538                                 $this->urlPath = $path;
 539                         }
 540                 }
 541         }
 542
 543         public function loadDatabase()
 544         {
 545                 if (DBA::connected()) {
 546                         return;
 547                 }
 548
 549                 $db_host = $this->getConfigValue('database', 'hostname');
 550                 $db_user = $this->getConfigValue('database', 'username');
 551                 $db_pass = $this->getConfigValue('database', 'password');
 552                 $db_data = $this->getConfigValue('database', 'database');
 553                 $charset = $this->getConfigValue('database', 'charset');
 554
 555                 // Use environment variables for mysql if they are set beforehand
 556                 if (!empty(getenv('MYSQL_HOST'))
 557                         && (!empty(getenv('MYSQL_USERNAME')) || !empty(getenv('MYSQL_USER')))
 558                         && getenv('MYSQL_PASSWORD') !== false
 559                         && !empty(getenv('MYSQL_DATABASE')))
 560                 {
 561                         $db_host = getenv('MYSQL_HOST');
 562                         if (!empty(getenv('MYSQL_PORT'))) {
 563                                 $db_host .= ':' . getenv('MYSQL_PORT');
 564                         }
 565                         if (!empty(getenv('MYSQL_USERNAME'))) {
 566                                 $db_user = getenv('MYSQL_USERNAME');
 567                         } else {
 568                                 $db_user = getenv('MYSQL_USER');
 569                         }
 570                         $db_pass = (string) getenv('MYSQL_PASSWORD');
 571                         $db_data = getenv('MYSQL_DATABASE');
 572                 }
 573
 574                 $stamp1 = microtime(true);
 575
 576                 DBA::connect($db_host, $db_user, $db_pass, $db_data, $charset);
 577                 unset($db_host, $db_user, $db_pass, $db_data, $charset);
 578
 579                 $this->saveTimestamp($stamp1, 'network');
 580         }
 581
 582         /**
 583          * @brief Returns the base filesystem path of the App
 584          *
 585          * It first checks for the internal variable, then for DOCUMENT_ROOT and
 586          * finally for PWD
 587          *
 588          * @return string
 589          */
 590         public function getBasePath()
 591         {
 592                 $basepath = $this->basePath;
 593
 594                 if (!$basepath) {
 595                         $basepath = Core\Config::get('system', 'basepath');
 596                 }
 597
 598                 if (!$basepath && !empty($_SERVER['DOCUMENT_ROOT'])) {
 599                         $basepath = $_SERVER['DOCUMENT_ROOT'];
 600                 }
 601
 602                 if (!$basepath && !empty($_SERVER['PWD'])) {
 603                         $basepath = $_SERVER['PWD'];
 604                 }
 605
 606                 return self::getRealPath($basepath);
 607         }
 608
 609         /**
 610          * @brief Returns a normalized file path
 611          *
 612          * This is a wrapper for the "realpath" function.
 613          * That function cannot detect the real path when some folders aren't readable.
 614          * Since this could happen with some hosters we need to handle this.
 615          *
 616          * @param string $path The path that is about to be normalized
 617          * @return string normalized path - when possible
 618          */
 619         public static function getRealPath($path)
 620         {
 621                 $normalized = realpath($path);
 622
 623                 if (!is_bool($normalized)) {
 624                         return $normalized;
 625                 } else {
 626                         return $path;
 627                 }
 628         }
 629
 630         public function getScheme()
 631         {
 632                 return $this->scheme;
 633         }
 634
 635         /**
 636          * @brief Retrieves the Friendica instance base URL
 637          *
 638          * This function assembles the base URL from multiple parts:
 639          * - Protocol is determined either by the request or a combination of
 640          * system.ssl_policy and the $ssl parameter.
 641          * - Host name is determined either by system.hostname or inferred from request
 642          * - Path is inferred from SCRIPT_NAME
 643          *
 644          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
 645          *
 646          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
 647          * @return string Friendica server base URL
 648          */
 649         public function getBaseURL($ssl = false)
 650         {
 651                 $scheme = $this->scheme;
 652
 653                 if (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
 654                         $scheme = 'https';
 655                 }
 656
 657                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 658                 //      (and also the login link). Anything seen by an outsider will have it turned off.
 659
 660                 if (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
 661                         if ($ssl) {
 662                                 $scheme = 'https';
 663                         } else {
 664                                 $scheme = 'http';
 665                         }
 666                 }
 667
 668                 if (Core\Config::get('config', 'hostname') != '') {
 669                         $this->hostname = Core\Config::get('config', 'hostname');
 670                 }
 671
 672                 return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
 673         }
 674
 675         /**
 676          * @brief Initializes the baseurl components
 677          *
 678          * Clears the baseurl cache to prevent inconsistencies
 679          *
 680          * @param string $url
 681          */
 682         public function setBaseURL($url)
 683         {
 684                 $parsed = @parse_url($url);
 685                 $hostname = '';
 686
 687                 if (!empty($parsed)) {
 688                         if (!empty($parsed['scheme'])) {
 689                                 $this->scheme = $parsed['scheme'];
 690                         }
 691
 692                         if (!empty($parsed['host'])) {
 693                                 $hostname = $parsed['host'];
 694                         }
 695
 696                         if (!empty($parsed['port'])) {
 697                                 $hostname .= ':' . $parsed['port'];
 698                         }
 699                         if (!empty($parsed['path'])) {
 700                                 $this->urlPath = trim($parsed['path'], '\\/');
 701                         }
 702
 703                         if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
 704                                 include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php';
 705                         }
 706
 707                         if (Core\Config::get('config', 'hostname') != '') {
 708                                 $this->hostname = Core\Config::get('config', 'hostname');
 709                         }
 710
 711                         if (!isset($this->hostname) || ($this->hostname == '')) {
 712                                 $this->hostname = $hostname;
 713                         }
 714                 }
 715         }
 716
 717         public function getHostName()
 718         {
 719                 if (Core\Config::get('config', 'hostname') != '') {
 720                         $this->hostname = Core\Config::get('config', 'hostname');
 721                 }
 722
 723                 return $this->hostname;
 724         }
 725
 726         public function getURLPath()
 727         {
 728                 return $this->urlPath;
 729         }
 730
 731         public function setPagerTotal($n)
 732         {
 733                 $this->pager['total'] = intval($n);
 734         }
 735
 736         public function setPagerItemsPage($n)
 737         {
 738                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 739                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 740         }
 741
 742         public function setPagerPage($n)
 743         {
 744                 $this->pager['page'] = $n;
 745                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 746         }
 747
 748         /**
 749          * Initializes App->page['htmlhead'].
 750          *
 751          * Includes:
 752          * - Page title
 753          * - Favicons
 754          * - Registered stylesheets (through App->registerStylesheet())
 755          * - Infinite scroll data
 756          * - head.tpl template
 757          */
 758         public function initHead()
 759         {
 760                 $interval = ((local_user()) ? Core\PConfig::get(local_user(), 'system', 'update_interval') : 40000);
 761
 762                 // If the update is 'deactivated' set it to the highest integer number (~24 days)
 763                 if ($interval < 0) {
 764                         $interval = 2147483647;
 765                 }
 766
 767                 if ($interval < 10000) {
 768                         $interval = 40000;
 769                 }
 770
 771                 // compose the page title from the sitename and the
 772                 // current module called
 773                 if (!$this->module == '') {
 774                         $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
 775                 } else {
 776                         $this->page['title'] = $this->config['sitename'];
 777                 }
 778
 779                 if (!empty($this->theme['stylesheet'])) {
 780                         $stylesheet = $this->theme['stylesheet'];
 781                 } else {
 782                         $stylesheet = $this->getCurrentThemeStylesheetPath();
 783                 }
 784
 785                 $this->registerStylesheet($stylesheet);
 786
 787                 $shortcut_icon = Core\Config::get('system', 'shortcut_icon');
 788                 if ($shortcut_icon == '') {
 789                         $shortcut_icon = 'images/friendica-32.png';
 790                 }
 791
 792                 $touch_icon = Core\Config::get('system', 'touch_icon');
 793                 if ($touch_icon == '') {
 794                         $touch_icon = 'images/friendica-128.png';
 795                 }
 796
 797                 // get data wich is needed for infinite scroll on the network page
 798                 $infinite_scroll = infinite_scroll_data($this->module);
 799
 800                 Core\Addon::callHooks('head', $this->page['htmlhead']);
 801
 802                 $tpl = get_markup_template('head.tpl');
 803                 /* put the head template at the beginning of page['htmlhead']
 804                  * since the code added by the modules frequently depends on it
 805                  * being first
 806                  */
 807                 $this->page['htmlhead'] = replace_macros($tpl, [
 808                         '$baseurl'         => $this->getBaseURL(),
 809                         '$local_user'      => local_user(),
 810                         '$generator'       => 'Friendica' . ' ' . FRIENDICA_VERSION,
 811                         '$delitem'         => Core\L10n::t('Delete this item?'),
 812                         '$showmore'        => Core\L10n::t('show more'),
 813                         '$showfewer'       => Core\L10n::t('show fewer'),
 814                         '$update_interval' => $interval,
 815                         '$shortcut_icon'   => $shortcut_icon,
 816                         '$touch_icon'      => $touch_icon,
 817                         '$infinite_scroll' => $infinite_scroll,
 818                         '$block_public'    => intval(Core\Config::get('system', 'block_public')),
 819                         '$stylesheets'     => $this->stylesheets,
 820                 ]) . $this->page['htmlhead'];
 821         }
 822
 823         /**
 824          * Initializes App->page['footer'].
 825          *
 826          * Includes:
 827          * - Javascript homebase
 828          * - Mobile toggle link
 829          * - Registered footer scripts (through App->registerFooterScript())
 830          * - footer.tpl template
 831          */
 832         public function initFooter()
 833         {
 834                 // If you're just visiting, let javascript take you home
 835                 if (!empty($_SESSION['visitor_home'])) {
 836                         $homebase = $_SESSION['visitor_home'];
 837                 } elseif (local_user()) {
 838                         $homebase = 'profile/' . $this->user['nickname'];
 839                 }
 840
 841                 if (isset($homebase)) {
 842                         $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
 843                 }
 844
 845                 /*
 846                  * Add a "toggle mobile" link if we're using a mobile device
 847                  */
 848                 if ($this->is_mobile || $this->is_tablet) {
 849                         if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
 850                                 $link = 'toggle_mobile?address=' . curPageURL();
 851                         } else {
 852                                 $link = 'toggle_mobile?off=1&address=' . curPageURL();
 853                         }
 854                         $this->page['footer'] .= replace_macros(get_markup_template("toggle_mobile_footer.tpl"), [
 855                                 '$toggle_link' => $link,
 856                                 '$toggle_text' => Core\L10n::t('toggle mobile')
 857                         ]);
 858                 }
 859
 860                 Core\Addon::callHooks('footer', $this->page['footer']);
 861
 862                 $tpl = get_markup_template('footer.tpl');
 863                 $this->page['footer'] = replace_macros($tpl, [
 864                         '$baseurl' => $this->getBaseURL(),
 865                         '$footerScripts' => $this->footerScripts,
 866                 ]) . $this->page['footer'];
 867         }
 868
 869         /**
 870          * @brief Removes the base url from an url. This avoids some mixed content problems.
 871          *
 872          * @param string $origURL
 873          *
 874          * @return string The cleaned url
 875          */
 876         public function removeBaseURL($origURL)
 877         {
 878                 // Remove the hostname from the url if it is an internal link
 879                 $nurl = normalise_link($origURL);
 880                 $base = normalise_link($this->getBaseURL());
 881                 $url = str_replace($base . '/', '', $nurl);
 882
 883                 // if it is an external link return the orignal value
 884                 if ($url == normalise_link($origURL)) {
 885                         return $origURL;
 886                 } else {
 887                         return $url;
 888                 }
 889         }
 890
 891         /**
 892          * @brief Register template engine class
 893          *
 894          * @param string $class
 895          */
 896         private function registerTemplateEngine($class)
 897         {
 898                 $v = get_class_vars($class);
 899                 if (!empty($v['name'])) {
 900                         $name = $v['name'];
 901                         $this->template_engines[$name] = $class;
 902                 } else {
 903                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
 904                         die();
 905                 }
 906         }
 907
 908         /**
 909          * @brief Return template engine instance.
 910          *
 911          * If $name is not defined, return engine defined by theme,
 912          * or default
 913          *
 914          * @return object Template Engine instance
 915          */
 916         public function getTemplateEngine()
 917         {
 918                 $template_engine = defaults($this->theme, 'template_engine', 'smarty3');
 919
 920                 if (isset($this->template_engines[$template_engine])) {
 921                         if (isset($this->template_engine_instance[$template_engine])) {
 922                                 return $this->template_engine_instance[$template_engine];
 923                         } else {
 924                                 $class = $this->template_engines[$template_engine];
 925                                 $obj = new $class;
 926                                 $this->template_engine_instance[$template_engine] = $obj;
 927                                 return $obj;
 928                         }
 929                 }
 930
 931                 echo "template engine <tt>$template_engine</tt> is not registered!\n";
 932                 exit();
 933         }
 934
 935         /**
 936          * @brief Returns the active template engine.
 937          *
 938          * @return string the active template engine
 939          */
 940         public function getActiveTemplateEngine()
 941         {
 942                 return $this->theme['template_engine'];
 943         }
 944
 945         /**
 946          * sets the active template engine
 947          *
 948          * @param string $engine the template engine (default is Smarty3)
 949          */
 950         public function setActiveTemplateEngine($engine = 'smarty3')
 951         {
 952                 $this->theme['template_engine'] = $engine;
 953         }
 954
 955         /**
 956          * Gets the right delimiter for a template engine
 957          *
 958          * Currently:
 959          * Internal = ''
 960          * Smarty3 = '{{'
 961          *
 962          * @param string $engine The template engine (default is Smarty3)
 963          *
 964          * @return string the right delimiter
 965          */
 966         public function getTemplateLeftDelimiter($engine = 'smarty3')
 967         {
 968                 return $this->ldelim[$engine];
 969         }
 970
 971         /**
 972          * Gets the left delimiter for a template engine
 973          *
 974          * Currently:
 975          * Internal = ''
 976          * Smarty3 = '}}'
 977          *
 978          * @param string $engine The template engine (default is Smarty3)
 979          *
 980          * @return string the left delimiter
 981          */
 982         public function getTemplateRightDelimiter($engine = 'smarty3')
 983         {
 984                 return $this->rdelim[$engine];
 985         }
 986
 987         /**
 988          * Saves a timestamp for a value - f.e. a call
 989          * Necessary for profiling Friendica
 990          *
 991          * @param int $timestamp the Timestamp
 992          * @param string $value A value to profile
 993          */
 994         public function saveTimestamp($timestamp, $value)
 995         {
 996                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
 997                         return;
 998                 }
 999
1000                 $duration = (float) (microtime(true) - $timestamp);
1001
1002                 if (!isset($this->performance[$value])) {
1003                         // Prevent ugly E_NOTICE
1004                         $this->performance[$value] = 0;
1005                 }
1006
1007                 $this->performance[$value] += (float) $duration;
1008                 $this->performance['marktime'] += (float) $duration;
1009
1010                 $callstack = Core\System::callstack();
1011
1012                 if (!isset($this->callstack[$value][$callstack])) {
1013                         // Prevent ugly E_NOTICE
1014                         $this->callstack[$value][$callstack] = 0;
1015                 }
1016
1017                 $this->callstack[$value][$callstack] += (float) $duration;
1018         }
1019
1020         /**
1021          * Returns the current UserAgent as a String
1022          *
1023          * @return string the UserAgent as a String
1024          */
1025         public function getUserAgent()
1026         {
1027                 return
1028                         FRIENDICA_PLATFORM . " '" .
1029                         FRIENDICA_CODENAME . "' " .
1030                         FRIENDICA_VERSION . '-' .
1031                         DB_UPDATE_VERSION . '; ' .
1032                         $this->getBaseURL();
1033         }
1034
1035         /**
1036          * Checks, if the call is from the Friendica App
1037          *
1038          * Reason:
1039          * The friendica client has problems with the GUID in the notify. this is some workaround
1040          */
1041         private function checkFriendicaApp()
1042         {
1043                 // Friendica-Client
1044                 $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
1045         }
1046
1047         /**
1048          *      Is the call via the Friendica app? (not a "normale" call)
1049          *
1050          * @return bool true if it's from the Friendica app
1051          */
1052         public function isFriendicaApp()
1053         {
1054                 return $this->isFriendicaApp;
1055         }
1056
1057         /**
1058          * @brief Checks if the site is called via a backend process
1059          *
1060          * This isn't a perfect solution. But we need this check very early.
1061          * So we cannot wait until the modules are loaded.
1062          *
1063          * @param string $backend true, if the backend flag was set during App initialization
1064          *
1065          */
1066         private function checkBackend($backend) {
1067                 static $backends = [
1068                         '_well_known',
1069                         'api',
1070                         'dfrn_notify',
1071                         'fetch',
1072                         'hcard',
1073                         'hostxrd',
1074                         'nodeinfo',
1075                         'noscrape',
1076                         'p',
1077                         'poco',
1078                         'post',
1079                         'proxy',
1080                         'pubsub',
1081                         'pubsubhubbub',
1082                         'receive',
1083                         'rsd_xml',
1084                         'salmon',
1085                         'statistics_json',
1086                         'xrd',
1087                 ];
1088
1089                 // Check if current module is in backend or backend flag is set
1090                 $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
1091         }
1092
1093         /**
1094          * Returns true, if the call is from a backend node (f.e. from a worker)
1095          *
1096          * @return bool Is it a known backend?
1097          */
1098         public function isBackend()
1099         {
1100                 return $this->isBackend;
1101         }
1102
1103         /**
1104          * @brief Checks if the maximum number of database processes is reached
1105          *
1106          * @return bool Is the limit reached?
1107          */
1108         public function isMaxProcessesReached()
1109         {
1110                 // Deactivated, needs more investigating if this check really makes sense
1111                 return false;
1112
1113                 /*
1114                  * Commented out to suppress static analyzer issues
1115                  *
1116                 if ($this->is_backend()) {
1117                         $process = 'backend';
1118                         $max_processes = Core\Config::get('system', 'max_processes_backend');
1119                         if (intval($max_processes) == 0) {
1120                                 $max_processes = 5;
1121                         }
1122                 } else {
1123                         $process = 'frontend';
1124                         $max_processes = Core\Config::get('system', 'max_processes_frontend');
1125                         if (intval($max_processes) == 0) {
1126                                 $max_processes = 20;
1127                         }
1128                 }
1129
1130                 $processlist = DBA::processlist();
1131                 if ($processlist['list'] != '') {
1132                         logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
1133
1134                         if ($processlist['amount'] > $max_processes) {
1135                                 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
1136                                 return true;
1137                         }
1138                 }
1139                 return false;
1140                  */
1141         }
1142
1143         /**
1144          * @brief Checks if the minimal memory is reached
1145          *
1146          * @return bool Is the memory limit reached?
1147          */
1148         public function isMinMemoryReached()
1149         {
1150                 $min_memory = Core\Config::get('system', 'min_memory', 0);
1151                 if ($min_memory == 0) {
1152                         return false;
1153                 }
1154
1155                 if (!is_readable('/proc/meminfo')) {
1156                         return false;
1157                 }
1158
1159                 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
1160
1161                 $meminfo = [];
1162                 foreach ($memdata as $line) {
1163                         $data = explode(':', $line);
1164                         if (count($data) != 2) {
1165                                 continue;
1166                         }
1167                         list($key, $val) = $data;
1168                         $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
1169                         $meminfo[$key] = (int) ($meminfo[$key] / 1024);
1170                 }
1171
1172                 if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
1173                         return false;
1174                 }
1175
1176                 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
1177
1178                 $reached = ($free < $min_memory);
1179
1180                 if ($reached) {
1181                         logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
1182                 }
1183
1184                 return $reached;
1185         }
1186
1187         /**
1188          * @brief Checks if the maximum load is reached
1189          *
1190          * @return bool Is the load reached?
1191          */
1192         public function isMaxLoadReached()
1193         {
1194                 if ($this->isBackend()) {
1195                         $process = 'backend';
1196                         $maxsysload = intval(Core\Config::get('system', 'maxloadavg'));
1197                         if ($maxsysload < 1) {
1198                                 $maxsysload = 50;
1199                         }
1200                 } else {
1201                         $process = 'frontend';
1202                         $maxsysload = intval(Core\Config::get('system', 'maxloadavg_frontend'));
1203                         if ($maxsysload < 1) {
1204                                 $maxsysload = 50;
1205                         }
1206                 }
1207
1208                 $load = Core\System::currentLoad();
1209                 if ($load) {
1210                         if (intval($load) > $maxsysload) {
1211                                 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
1212                                 return true;
1213                         }
1214                 }
1215                 return false;
1216         }
1217
1218         /**
1219          * Executes a child process with 'proc_open'
1220          *
1221          * @param string $command The command to execute
1222          * @param array  $args    Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
1223          */
1224         public function proc_run($command, $args)
1225         {
1226                 if (!function_exists('proc_open')) {
1227                         return;
1228                 }
1229
1230                 $cmdline = $this->getConfigValue('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
1231
1232                 foreach ($args as $key => $value) {
1233                         if (!is_null($value) && is_bool($value) && !$value) {
1234                                 continue;
1235                         }
1236
1237                         $cmdline .= ' --' . $key;
1238                         if (!is_null($value) && !is_bool($value)) {
1239                                 $cmdline .= ' ' . $value;
1240                         }
1241                 }
1242
1243                 if ($this->isMinMemoryReached()) {
1244                         return;
1245                 }
1246
1247                 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1248                         $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->getBasePath());
1249                 } else {
1250                         $resource = proc_open($cmdline . ' &', [], $foo, $this->getBasePath());
1251                 }
1252                 if (!is_resource($resource)) {
1253                         logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
1254                         return;
1255                 }
1256                 proc_close($resource);
1257         }
1258
1259         /**
1260          * @brief Returns the system user that is executing the script
1261          *
1262          * This mostly returns something like "www-data".
1263          *
1264          * @return string system username
1265          */
1266         private static function getSystemUser()
1267         {
1268                 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
1269                         return '';
1270                 }
1271
1272                 $processUser = posix_getpwuid(posix_geteuid());
1273                 return $processUser['name'];
1274         }
1275
1276         /**
1277          * @brief Checks if a given directory is usable for the system
1278          *
1279          * @return boolean the directory is usable
1280          */
1281         public static function isDirectoryUsable($directory, $check_writable = true)
1282         {
1283                 if ($directory == '') {
1284                         logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
1285                         return false;
1286                 }
1287
1288                 if (!file_exists($directory)) {
1289                         logger('Path "' . $directory . '" does not exist for user ' . self::getSystemUser(), LOGGER_DEBUG);
1290                         return false;
1291                 }
1292
1293                 if (is_file($directory)) {
1294                         logger('Path "' . $directory . '" is a file for user ' . self::getSystemUser(), LOGGER_DEBUG);
1295                         return false;
1296                 }
1297
1298                 if (!is_dir($directory)) {
1299                         logger('Path "' . $directory . '" is not a directory for user ' . self::getSystemUser(), LOGGER_DEBUG);
1300                         return false;
1301                 }
1302
1303                 if ($check_writable && !is_writable($directory)) {
1304                         logger('Path "' . $directory . '" is not writable for user ' . self::getSystemUser(), LOGGER_DEBUG);
1305                         return false;
1306                 }
1307
1308                 return true;
1309         }
1310
1311         /**
1312          * @param string $cat     Config category
1313          * @param string $k       Config key
1314          * @param mixed  $default Default value if it isn't set
1315          *
1316          * @return string Returns the value of the Config entry
1317          */
1318         public function getConfigValue($cat, $k, $default = null)
1319         {
1320                 $return = $default;
1321
1322                 if ($cat === 'config') {
1323                         if (isset($this->config[$k])) {
1324                                 $return = $this->config[$k];
1325                         }
1326                 } else {
1327                         if (isset($this->config[$cat][$k])) {
1328                                 $return = $this->config[$cat][$k];
1329                         }
1330                 }
1331
1332                 return $return;
1333         }
1334
1335         /**
1336          * Sets a default value in the config cache. Ignores already existing keys.
1337          *
1338          * @param string $cat Config category
1339          * @param string $k   Config key
1340          * @param mixed  $v   Default value to set
1341          */
1342         private function setDefaultConfigValue($cat, $k, $v)
1343         {
1344                 if (!isset($this->config[$cat][$k])) {
1345                         $this->setConfigValue($cat, $k, $v);
1346                 }
1347         }
1348
1349         /**
1350          * Sets a value in the config cache. Accepts raw output from the config table
1351          *
1352          * @param string $cat Config category
1353          * @param string $k   Config key
1354          * @param mixed  $v   Value to set
1355          */
1356         public function setConfigValue($cat, $k, $v)
1357         {
1358                 // Only arrays are serialized in database, so we have to unserialize sparingly
1359                 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1360
1361                 if ($cat === 'config') {
1362                         $this->config[$k] = $value;
1363                 } else {
1364                         if (!isset($this->config[$cat])) {
1365                                 $this->config[$cat] = [];
1366                         }
1367
1368                         $this->config[$cat][$k] = $value;
1369                 }
1370         }
1371
1372         /**
1373          * Deletes a value from the config cache
1374          *
1375          * @param string $cat Config category
1376          * @param string $k   Config key
1377          */
1378         public function deleteConfigValue($cat, $k)
1379         {
1380                 if ($cat === 'config') {
1381                         if (isset($this->config[$k])) {
1382                                 unset($this->config[$k]);
1383                         }
1384                 } else {
1385                         if (isset($this->config[$cat][$k])) {
1386                                 unset($this->config[$cat][$k]);
1387                         }
1388                 }
1389         }
1390
1391
1392         /**
1393          * Retrieves a value from the user config cache
1394          *
1395          * @param int    $uid     User Id
1396          * @param string $cat     Config category
1397          * @param string $k       Config key
1398          * @param mixed  $default Default value if key isn't set
1399          *
1400          * @return string The value of the config entry
1401          */
1402         public function getPConfigValue($uid, $cat, $k, $default = null)
1403         {
1404                 $return = $default;
1405
1406                 if (isset($this->config[$uid][$cat][$k])) {
1407                         $return = $this->config[$uid][$cat][$k];
1408                 }
1409
1410                 return $return;
1411         }
1412
1413         /**
1414          * Sets a value in the user config cache
1415          *
1416          * Accepts raw output from the pconfig table
1417          *
1418          * @param int    $uid User Id
1419          * @param string $cat Config category
1420          * @param string $k   Config key
1421          * @param mixed  $v   Value to set
1422          */
1423         public function setPConfigValue($uid, $cat, $k, $v)
1424         {
1425                 // Only arrays are serialized in database, so we have to unserialize sparingly
1426                 $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
1427
1428                 if (!isset($this->config[$uid]) || !is_array($this->config[$uid])) {
1429                         $this->config[$uid] = [];
1430                 }
1431
1432                 if (!isset($this->config[$uid][$cat]) || !is_array($this->config[$uid][$cat])) {
1433                         $this->config[$uid][$cat] = [];
1434                 }
1435
1436                 $this->config[$uid][$cat][$k] = $value;
1437         }
1438
1439         /**
1440          * Deletes a value from the user config cache
1441          *
1442          * @param int    $uid User Id
1443          * @param string $cat Config category
1444          * @param string $k   Config key
1445          */
1446         public function deletePConfigValue($uid, $cat, $k)
1447         {
1448                 if (isset($this->config[$uid][$cat][$k])) {
1449                         unset($this->config[$uid][$cat][$k]);
1450                 }
1451         }
1452
1453         /**
1454          * Generates the site's default sender email address
1455          *
1456          * @return string
1457          */
1458         public function getSenderEmailAddress()
1459         {
1460                 $sender_email = Core\Config::get('config', 'sender_email');
1461                 if (empty($sender_email)) {
1462                         $hostname = $this->getHostName();
1463                         if (strpos($hostname, ':')) {
1464                                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
1465                         }
1466
1467                         $sender_email = 'noreply@' . $hostname;
1468                 }
1469
1470                 return $sender_email;
1471         }
1472
1473         /**
1474          * Returns the current theme name.
1475          *
1476          * @return string the name of the current theme
1477          */
1478         public function getCurrentTheme()
1479         {
1480                 if ($this->getMode()->isInstall()) {
1481                         return '';
1482                 }
1483
1484                 //// @TODO Compute the current theme only once (this behavior has
1485                 /// already been implemented, but it didn't work well -
1486                 /// https://github.com/friendica/friendica/issues/5092)
1487                 $this->computeCurrentTheme();
1488
1489                 return $this->currentTheme;
1490         }
1491
1492         /**
1493          * Computes the current theme name based on the node settings, the user settings and the device type
1494          *
1495          * @throws Exception
1496          */
1497         private function computeCurrentTheme()
1498         {
1499                 $system_theme = Core\Config::get('system', 'theme');
1500                 if (!$system_theme) {
1501                         throw new Exception(Core\L10n::t('No system theme config value set.'));
1502                 }
1503
1504                 // Sane default
1505                 $this->currentTheme = $system_theme;
1506
1507                 $allowed_themes = explode(',', Core\Config::get('system', 'allowed_themes', $system_theme));
1508
1509                 $page_theme = null;
1510                 // Find the theme that belongs to the user whose stuff we are looking at
1511                 if ($this->profile_uid && ($this->profile_uid != local_user())) {
1512                         // Allow folks to override user themes and always use their own on their own site.
1513                         // This works only if the user is on the same server
1514                         $user = DBA::selectFirst('user', ['theme'], ['uid' => $this->profile_uid]);
1515                         if (DBA::isResult($user) && !Core\PConfig::get(local_user(), 'system', 'always_my_theme')) {
1516                                 $page_theme = $user['theme'];
1517                         }
1518                 }
1519
1520                 $user_theme = Core\Session::get('theme', $system_theme);
1521
1522                 // Specific mobile theme override
1523                 if (($this->is_mobile || $this->is_tablet) && Core\Session::get('show-mobile', true)) {
1524                         $system_mobile_theme = Core\Config::get('system', 'mobile-theme');
1525                         $user_mobile_theme = Core\Session::get('mobile-theme', $system_mobile_theme);
1526
1527                         // --- means same mobile theme as desktop
1528                         if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
1529                                 $user_theme = $user_mobile_theme;
1530                         }
1531                 }
1532
1533                 if ($page_theme) {
1534                         $theme_name = $page_theme;
1535                 } else {
1536                         $theme_name = $user_theme;
1537                 }
1538
1539                 if ($theme_name
1540                         && in_array($theme_name, $allowed_themes)
1541                         && (file_exists('view/theme/' . $theme_name . '/style.css')
1542                         || file_exists('view/theme/' . $theme_name . '/style.php'))
1543                 ) {
1544                         $this->currentTheme = $theme_name;
1545                 }
1546         }
1547
1548         /**
1549          * @brief Return full URL to theme which is currently in effect.
1550          *
1551          * Provide a sane default if nothing is chosen or the specified theme does not exist.
1552          *
1553          * @return string
1554          */
1555         public function getCurrentThemeStylesheetPath()
1556         {
1557                 return Core\Theme::getStylesheetPath($this->getCurrentTheme());
1558         }
1559
1560         /**
1561          * Check if request was an AJAX (xmlhttprequest) request.
1562          *
1563          * @return boolean true if it was an AJAX request
1564          */
1565         public function isAjax()
1566         {
1567                 return $this->isAjax;
1568         }
1569
1570         /**
1571          * Returns the value of a argv key
1572          * TODO there are a lot of $a->argv usages in combination with defaults() which can be replaced with this method
1573          *
1574          * @param int $position the position of the argument
1575          * @param mixed $default the default value if not found
1576          *
1577          * @return mixed returns the value of the argument
1578          */
1579         public function getArgumentValue($position, $default = '')
1580         {
1581                 if (array_key_exists($position, $this->argv)) {
1582                         return $this->argv[$position];
1583                 }
1584
1585                 return $default;
1586         }
1587
1588         /**
1589          * Sets the base url for use in cmdline programs which don't have
1590          * $_SERVER variables
1591          */
1592         public function checkURL()
1593         {
1594                 $url = Core\Config::get('system', 'url');
1595
1596                 // if the url isn't set or the stored url is radically different
1597                 // than the currently visited url, store the current value accordingly.
1598                 // "Radically different" ignores common variations such as http vs https
1599                 // and www.example.com vs example.com.
1600                 // We will only change the url to an ip address if there is no existing setting
1601
1602                 if (empty($url) || (!link_compare($url, $this->getBaseURL())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $this->getHostName()))) {
1603                         Core\Config::set('system', 'url', $this->getBaseURL());
1604                 }
1605         }
1606
1607         /**
1608          * Frontend App script
1609          *
1610          * The App object behaves like a container and a dispatcher at the same time, including a representation of the
1611          * request and a representation of the response.
1612          *
1613          * This probably should change to limit the size of this monster method.
1614          */
1615         public function runFrontend()
1616         {
1617                 // Missing DB connection: ERROR
1618                 if ($this->getMode()->has(App\Mode::LOCALCONFIGPRESENT) && !$this->getMode()->has(App\Mode::DBAVAILABLE)) {
1619                         Core\System::httpExit(500, ['title' => 'Error 500 - Internal Server Error', 'description' => 'Apologies but the website is unavailable at the moment.']);
1620                 }
1621
1622                 // Max Load Average reached: ERROR
1623                 if ($this->isMaxProcessesReached() || $this->isMaxLoadReached()) {
1624                         header('Retry-After: 120');
1625                         header('Refresh: 120; url=' . $this->getBaseURL() . "/" . $this->query_string);
1626
1627                         Core\System::httpExit(503, ['title' => 'Error 503 - Service Temporarily Unavailable', 'description' => 'Core\System is currently overloaded. Please try again later.']);
1628                 }
1629
1630                 if (strstr($this->query_string, '.well-known/host-meta') && ($this->query_string != '.well-known/host-meta')) {
1631                         Core\System::httpExit(404);
1632                 }
1633
1634                 if (!$this->getMode()->isInstall()) {
1635                         // Force SSL redirection
1636                         if (Core\Config::get('system', 'force_ssl') && ($this->getScheme() == "http")
1637                                 && intval(Core\Config::get('system', 'ssl_policy')) == SSL_POLICY_FULL
1638                                 && strpos($this->getBaseURL(), 'https://') === 0
1639                                 && $_SERVER['REQUEST_METHOD'] == 'GET') {
1640                                 header('HTTP/1.1 302 Moved Temporarily');
1641                                 header('Location: ' . $this->getBaseURL() . '/' . $this->query_string);
1642                                 exit();
1643                         }
1644
1645                         Core\Session::init();
1646                         Core\Addon::callHooks('init_1');
1647                 }
1648
1649                 // Exclude the backend processes from the session management
1650                 if (!$this->isBackend()) {
1651                         $stamp1 = microtime(true);
1652                         session_start();
1653                         $this->saveTimestamp($stamp1, 'parser');
1654                         Core\L10n::setSessionVariable();
1655                         Core\L10n::setLangFromSession();
1656                 } else {
1657                         $_SESSION = [];
1658                         Core\Worker::executeIfIdle();
1659                 }
1660
1661                 // ZRL
1662                 if (!empty($_GET['zrl']) && $this->getMode()->isNormal()) {
1663                         $this->query_string = Model\Profile::stripZrls($this->query_string);
1664                         if (!local_user()) {
1665                                 // Only continue when the given profile link seems valid
1666                                 // Valid profile links contain a path with "/profile/" and no query parameters
1667                                 if ((parse_url($_GET['zrl'], PHP_URL_QUERY) == "") &&
1668                                         strstr(parse_url($_GET['zrl'], PHP_URL_PATH), "/profile/")) {
1669                                         if (defaults($_SESSION, "visitor_home", "") != $_GET["zrl"]) {
1670                                                 $_SESSION['my_url'] = $_GET['zrl'];
1671                                                 $_SESSION['authenticated'] = 0;
1672                                         }
1673                                         Model\Profile::zrlInit($this);
1674                                 } else {
1675                                         // Someone came with an invalid parameter, maybe as a DDoS attempt
1676                                         // We simply stop processing here
1677                                         logger("Invalid ZRL parameter " . $_GET['zrl'], LOGGER_DEBUG);
1678                                         Core\System::httpExit(403, ['title' => '403 Forbidden']);
1679                                 }
1680                         }
1681                 }
1682
1683                 if (!empty($_GET['owt']) && $this->getMode()->isNormal()) {
1684                         $token = $_GET['owt'];
1685                         $this->query_string = Model\Profile::stripQueryParam($this->query_string, 'owt');
1686                         Model\Profile::openWebAuthInit($token);
1687                 }
1688
1689                 Module\Login::sessionAuth();
1690
1691                 if (empty($_SESSION['authenticated'])) {
1692                         header('X-Account-Management-Status: none');
1693                 }
1694
1695                 $_SESSION['sysmsg']       = defaults($_SESSION, 'sysmsg'      , []);
1696                 $_SESSION['sysmsg_info']  = defaults($_SESSION, 'sysmsg_info' , []);
1697                 $_SESSION['last_updated'] = defaults($_SESSION, 'last_updated', []);
1698
1699                 /*
1700                  * check_config() is responsible for running update scripts. These automatically
1701                  * update the DB schema whenever we push a new one out. It also checks to see if
1702                  * any addons have been added or removed and reacts accordingly.
1703                  */
1704
1705                 // in install mode, any url loads install module
1706                 // but we need "view" module for stylesheet
1707                 if ($this->getMode()->isInstall() && $this->module != 'view') {
1708                         $this->module = 'install';
1709                 } elseif (!$this->getMode()->has(App\Mode::MAINTENANCEDISABLED) && $this->module != 'view') {
1710                         $this->module = 'maintenance';
1711                 } else {
1712                         $this->checkURL();
1713                         check_db(false);
1714                         Core\Addon::check();
1715                 }
1716
1717                 $this->page = [
1718                         'aside' => '',
1719                         'bottom' => '',
1720                         'content' => '',
1721                         'footer' => '',
1722                         'htmlhead' => '',
1723                         'nav' => '',
1724                         'page_title' => '',
1725                         'right_aside' => '',
1726                         'template' => '',
1727                         'title' => ''
1728                 ];
1729
1730                 if (strlen($this->module)) {
1731                         // Compatibility with the Android Diaspora client
1732                         if ($this->module == 'stream') {
1733                                 $this->internalRedirect('network?f=&order=post');
1734                         }
1735
1736                         if ($this->module == 'conversations') {
1737                                 $this->internalRedirect('message');
1738                         }
1739
1740                         if ($this->module == 'commented') {
1741                                 $this->internalRedirect('network?f=&order=comment');
1742                         }
1743
1744                         if ($this->module == 'liked') {
1745                                 $this->internalRedirect('network?f=&order=comment');
1746                         }
1747
1748                         if ($this->module == 'activity') {
1749                                 $this->internalRedirect('network/?f=&conv=1');
1750                         }
1751
1752                         if (($this->module == 'status_messages') && ($this->cmd == 'status_messages/new')) {
1753                                 $this->internalRedirect('bookmarklet');
1754                         }
1755
1756                         if (($this->module == 'user') && ($this->cmd == 'user/edit')) {
1757                                 $this->internalRedirect('settings');
1758                         }
1759
1760                         if (($this->module == 'tag_followings') && ($this->cmd == 'tag_followings/manage')) {
1761                                 $this->internalRedirect('search');
1762                         }
1763
1764                         // Compatibility with the Firefox App
1765                         if (($this->module == "users") && ($this->cmd == "users/sign_in")) {
1766                                 $this->module = "login";
1767                         }
1768
1769                         $privateapps = Core\Config::get('config', 'private_addons', false);
1770                         if (is_array($this->addons) && in_array($this->module, $this->addons) && file_exists("addon/{$this->module}/{$this->module}.php")) {
1771                                 //Check if module is an app and if public access to apps is allowed or not
1772                                 if ((!local_user()) && Core\Addon::isApp($this->module) && $privateapps) {
1773                                         info(Core\L10n::t("You must be logged in to use addons. "));
1774                                 } else {
1775                                         include_once "addon/{$this->module}/{$this->module}.php";
1776                                         if (function_exists($this->module . '_module')) {
1777                                                 LegacyModule::setModuleFile("addon/{$this->module}/{$this->module}.php");
1778                                                 $this->module_class = 'Friendica\\LegacyModule';
1779                                                 $this->module_loaded = true;
1780                                         }
1781                                 }
1782                         }
1783
1784                         // Controller class routing
1785                         if (! $this->module_loaded && class_exists('Friendica\\Module\\' . ucfirst($this->module))) {
1786                                 $this->module_class = 'Friendica\\Module\\' . ucfirst($this->module);
1787                                 $this->module_loaded = true;
1788                         }
1789
1790                         /* If not, next look for a 'standard' program module in the 'mod' directory
1791                          * We emulate a Module class through the LegacyModule class
1792                          */
1793                         if (! $this->module_loaded && file_exists("mod/{$this->module}.php")) {
1794                                 LegacyModule::setModuleFile("mod/{$this->module}.php");
1795                                 $this->module_class = 'Friendica\\LegacyModule';
1796                                 $this->module_loaded = true;
1797                         }
1798
1799                         /* The URL provided does not resolve to a valid module.
1800                          *
1801                          * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'.
1802                          * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic -
1803                          * we are going to trap this and redirect back to the requested page. As long as you don't have a critical error on your page
1804                          * this will often succeed and eventually do the right thing.
1805                          *
1806                          * Otherwise we are going to emit a 404 not found.
1807                          */
1808                         if (! $this->module_loaded) {
1809                                 // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit.
1810                                 if (!empty($_SERVER['QUERY_STRING']) && preg_match('/{[0-9]}/', $_SERVER['QUERY_STRING']) !== 0) {
1811                                         exit();
1812                                 }
1813
1814                                 if (!empty($_SERVER['QUERY_STRING']) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) {
1815                                         logger('index.php: dreamhost_error_hack invoked. Original URI =' . $_SERVER['REQUEST_URI']);
1816                                         $this->internalRedirect($_SERVER['REQUEST_URI']);
1817                                 }
1818
1819                                 logger('index.php: page not found: ' . $_SERVER['REQUEST_URI'] . ' ADDRESS: ' . $_SERVER['REMOTE_ADDR'] . ' QUERY: ' . $_SERVER['QUERY_STRING'], LOGGER_DEBUG);
1820
1821                                 header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . Core\L10n::t('Not Found'));
1822                                 $tpl = get_markup_template("404.tpl");
1823                                 $this->page['content'] = replace_macros($tpl, [
1824                                         '$message' =>  Core\L10n::t('Page not found.')
1825                                 ]);
1826                         }
1827                 }
1828
1829                 // Load current theme info
1830                 $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php';
1831                 if (file_exists($theme_info_file)) {
1832                         require_once $theme_info_file;
1833                 }
1834
1835                 // initialise content region
1836                 if ($this->getMode()->isNormal()) {
1837                         Core\Addon::callHooks('page_content_top', $this->page['content']);
1838                 }
1839
1840                 // Call module functions
1841                 if ($this->module_loaded) {
1842                         $this->page['page_title'] = $this->module;
1843                         $placeholder = '';
1844
1845                         Core\Addon::callHooks($this->module . '_mod_init', $placeholder);
1846
1847                         call_user_func([$this->module_class, 'init']);
1848
1849                         // "rawContent" is especially meant for technical endpoints.
1850                         // This endpoint doesn't need any theme initialization or other comparable stuff.
1851                         if (!$this->error) {
1852                                 call_user_func([$this->module_class, 'rawContent']);
1853                         }
1854
1855                         if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) {
1856                                 $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init';
1857                                 $func($this);
1858                         }
1859
1860                         if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') {
1861                                 Core\Addon::callHooks($this->module . '_mod_post', $_POST);
1862                                 call_user_func([$this->module_class, 'post']);
1863                         }
1864
1865                         if (! $this->error) {
1866                                 Core\Addon::callHooks($this->module . '_mod_afterpost', $placeholder);
1867                                 call_user_func([$this->module_class, 'afterpost']);
1868                         }
1869
1870                         if (! $this->error) {
1871                                 $arr = ['content' => $this->page['content']];
1872                                 Core\Addon::callHooks($this->module . '_mod_content', $arr);
1873                                 $this->page['content'] = $arr['content'];
1874                                 $arr = ['content' => call_user_func([$this->module_class, 'content'])];
1875                                 Core\Addon::callHooks($this->module . '_mod_aftercontent', $arr);
1876                                 $this->page['content'] .= $arr['content'];
1877                         }
1878
1879                         if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_content_loaded')) {
1880                                 $func = str_replace('-', '_', $this->getCurrentTheme()) . '_content_loaded';
1881                                 $func($this);
1882                         }
1883                 }
1884
1885                 /* Create the page head after setting the language
1886                  * and getting any auth credentials.
1887                  *
1888                  * Moved initHead() and initFooter() to after
1889                  * all the module functions have executed so that all
1890                  * theme choices made by the modules can take effect.
1891                  */
1892                 $this->initHead();
1893
1894                 /* Build the page ending -- this is stuff that goes right before
1895                  * the closing </body> tag
1896                  */
1897                 $this->initFooter();
1898
1899                 /* now that we've been through the module content, see if the page reported
1900                  * a permission problem and if so, a 403 response would seem to be in order.
1901                  */
1902                 if (stristr(implode("", $_SESSION['sysmsg']), Core\L10n::t('Permission denied'))) {
1903                         header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . Core\L10n::t('Permission denied.'));
1904                 }
1905
1906                 // Report anything which needs to be communicated in the notification area (before the main body)
1907                 Core\Addon::callHooks('page_end', $this->page['content']);
1908
1909                 // Add the navigation (menu) template
1910                 if ($this->module != 'install' && $this->module != 'maintenance') {
1911                         $this->page['htmlhead'] .= replace_macros(get_markup_template('nav_head.tpl'), []);
1912                         $this->page['nav']       = Content\Nav::build($this);
1913                 }
1914
1915                 // Build the page - now that we have all the components
1916                 if (isset($_GET["mode"]) && (($_GET["mode"] == "raw") || ($_GET["mode"] == "minimal"))) {
1917                         $doc = new DOMDocument();
1918
1919                         $target = new DOMDocument();
1920                         $target->loadXML("<root></root>");
1921
1922                         $content = mb_convert_encoding($this->page["content"], 'HTML-ENTITIES', "UTF-8");
1923
1924                         /// @TODO one day, kill those error-surpressing @ stuff, or PHP should ban it
1925                         @$doc->loadHTML($content);
1926
1927                         $xpath = new DOMXPath($doc);
1928
1929                         $list = $xpath->query("//*[contains(@id,'tread-wrapper-')]");  /* */
1930
1931                         foreach ($list as $item) {
1932                                 $item = $target->importNode($item, true);
1933
1934                                 // And then append it to the target
1935                                 $target->documentElement->appendChild($item);
1936                         }
1937                 }
1938
1939                 if (isset($_GET["mode"]) && ($_GET["mode"] == "raw")) {
1940                         header("Content-type: text/html; charset=utf-8");
1941
1942                         echo substr($target->saveHTML(), 6, -8);
1943
1944                         exit();
1945                 }
1946
1947                 $page    = $this->page;
1948                 $profile = $this->profile;
1949
1950                 header("X-Friendica-Version: " . FRIENDICA_VERSION);
1951                 header("Content-type: text/html; charset=utf-8");
1952
1953                 if (Core\Config::get('system', 'hsts') && (Core\Config::get('system', 'ssl_policy') == SSL_POLICY_FULL)) {
1954                         header("Strict-Transport-Security: max-age=31536000");
1955                 }
1956
1957                 // Some security stuff
1958                 header('X-Content-Type-Options: nosniff');
1959                 header('X-XSS-Protection: 1; mode=block');
1960                 header('X-Permitted-Cross-Domain-Policies: none');
1961                 header('X-Frame-Options: sameorigin');
1962
1963                 // Things like embedded OSM maps don't work, when this is enabled
1964                 // 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'");
1965
1966                 /* We use $_GET["mode"] for special page templates. So we will check if we have
1967                  * to load another page template than the default one.
1968                  * The page templates are located in /view/php/ or in the theme directory.
1969                  */
1970                 if (isset($_GET["mode"])) {
1971                         $template = Core\Theme::getPathForFile($_GET["mode"] . '.php');
1972                 }
1973
1974                 // If there is no page template use the default page template
1975                 if (empty($template)) {
1976                         $template = Core\Theme::getPathForFile("default.php");
1977                 }
1978
1979                 // Theme templates expect $a as an App instance
1980                 $a = $this;
1981
1982                 /// @TODO Looks unsafe (remote-inclusion), is maybe not but Core\Theme::getPathForFile() uses file_exists() but does not escape anything
1983                 require_once $template;
1984         }
1985
1986         /**
1987          * Redirects to another module relative to the current Friendica base.
1988          * If you want to redirect to a external URL, use System::externalRedirectTo()
1989          *
1990          * @param string $toUrl The destination URL (Default is empty, which is the default page of the Friendica node)
1991          * @param bool $ssl if true, base URL will try to get called with https:// (works just for relative paths)
1992          *
1993          * @throws InternalServerErrorException In Case the given URL is not relative to the Friendica node
1994          */
1995         public function internalRedirect($toUrl = '', $ssl = false)
1996         {
1997                 if (filter_var($toUrl, FILTER_VALIDATE_URL)) {
1998                         throw new InternalServerErrorException('URL is not a relative path, please use System::externalRedirectTo');
1999                 }
2000
2001                 $redirectTo = $this->getBaseURL($ssl) . '/' . ltrim($toUrl, '/');
2002                 System::externalRedirect($redirectTo);
2003         }
2004 }