boot.php

   1 <?php
   2 /** @file boot.php
   3  *
   4  * This file defines some global constants and includes the central App class.
   5  */
   6
   7 /**
   8  * Friendica
   9  *
  10  * Friendica is a communications platform for integrated social communications
  11  * utilising decentralised communications and linkage to several indie social
  12  * projects - as well as popular mainstream providers.
  13  *
  14  * Our mission is to free our friends and families from the clutches of
  15  * data-harvesting corporations, and pave the way to a future where social
  16  * communications are free and open and flow between alternate providers as
  17  * easily as email does today.
  18  */
  19
  20 require_once('include/autoloader.php');
  21
  22 use \Friendica\Core\Config;
  23
  24 require_once('include/config.php');
  25 require_once('include/network.php');
  26 require_once('include/plugin.php');
  27 require_once('include/text.php');
  28 require_once('include/datetime.php');
  29 require_once('include/pgettext.php');
  30 require_once('include/nav.php');
  31 require_once('include/cache.php');
  32 require_once('library/Mobile_Detect/Mobile_Detect.php');
  33 require_once('include/features.php');
  34 require_once('include/identity.php');
  35 require_once('include/pidfile.php');
  36 require_once('update.php');
  37 require_once('include/dbstructure.php');
  38
  39 define ( 'FRIENDICA_PLATFORM',     'Friendica');
  40 define ( 'FRIENDICA_CODENAME',     'Asparagus');
  41 define ( 'FRIENDICA_VERSION',      '3.5.1-dev' );
  42 define ( 'DFRN_PROTOCOL_VERSION',  '2.23'    );
  43 define ( 'DB_UPDATE_VERSION',      1213      );
  44
  45 /**
  46  * @brief Constant with a HTML line break.
  47  *
  48  * Contains a HTML line break (br) element and a real carriage return with line
  49  * feed for the source.
  50  * This can be used in HTML and JavaScript where needed a line break.
  51  */
  52 define ( 'EOL',                    "<br />\r\n"     );
  53 define ( 'ATOM_TIME',              'Y-m-d\TH:i:s\Z' );
  54
  55
  56 /**
  57  * @brief Image storage quality.
  58  *
  59  * Lower numbers save space at cost of image detail.
  60  * For ease of upgrade, please do not change here. Change jpeg quality with
  61  * $a->config['system']['jpeg_quality'] = n;
  62  * in .htconfig.php, where n is netween 1 and 100, and with very poor results
  63  * below about 50
  64  *
  65  */
  66
  67 define ( 'JPEG_QUALITY',            100  );
  68 /**
  69  * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
  70  */
  71 define ( 'PNG_QUALITY',             8  );
  72
  73 /**
  74  *
  75  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  76  * length that pictures are allowed to be (for non-square pictures, it will apply
  77  * to the longest side). Pictures longer than this length will be resized to be
  78  * this length (on the longest side, the other side will be scaled appropriately).
  79  * Modify this value using
  80  *
  81  *    $a->config['system']['max_image_length'] = n;
  82  *
  83  * in .htconfig.php
  84  *
  85  * If you don't want to set a maximum length, set to -1. The default value is
  86  * defined by 'MAX_IMAGE_LENGTH' below.
  87  *
  88  */
  89 define ( 'MAX_IMAGE_LENGTH',        -1  );
  90
  91
  92 /**
  93  * Not yet used
  94  */
  95
  96 define ( 'DEFAULT_DB_ENGINE',  'MyISAM'  );
  97
  98 /**
  99  * @name SSL Policy
 100  *
 101  * SSL redirection policies
 102  * @{
 103  */
 104 define ( 'SSL_POLICY_NONE',         0 );
 105 define ( 'SSL_POLICY_FULL',         1 );
 106 define ( 'SSL_POLICY_SELFSIGN',     2 );
 107 /* @}*/
 108
 109 /**
 110  * @name Logger
 111  *
 112  * log levels
 113  * @{
 114  */
 115 define ( 'LOGGER_NORMAL',          0 );
 116 define ( 'LOGGER_TRACE',           1 );
 117 define ( 'LOGGER_DEBUG',           2 );
 118 define ( 'LOGGER_DATA',            3 );
 119 define ( 'LOGGER_ALL',             4 );
 120 /* @}*/
 121
 122 /**
 123  * @name Cache
 124  *
 125  * Cache levels
 126  * @{
 127  */
 128 define ( 'CACHE_MONTH',            0 );
 129 define ( 'CACHE_WEEK',             1 );
 130 define ( 'CACHE_DAY',              2 );
 131 define ( 'CACHE_HOUR',             3 );
 132 define ( 'CACHE_HALF_HOUR',        4 );
 133 define ( 'CACHE_QUARTER_HOUR',     5 );
 134 define ( 'CACHE_FIVE_MINUTES',     6 );
 135 define ( 'CACHE_MINUTE',           7 );
 136 /* @}*/
 137
 138 /**
 139  * @name Register
 140  *
 141  * Registration policies
 142  * @{
 143  */
 144 define ( 'REGISTER_CLOSED',        0 );
 145 define ( 'REGISTER_APPROVE',       1 );
 146 define ( 'REGISTER_OPEN',          2 );
 147 /** @}*/
 148
 149 /**
 150  * @name Contact_is
 151  *
 152  * Relationship types
 153  * @{
 154  */
 155 define ( 'CONTACT_IS_FOLLOWER', 1);
 156 define ( 'CONTACT_IS_SHARING',  2);
 157 define ( 'CONTACT_IS_FRIEND',   3);
 158 /** @}*/
 159
 160 /**
 161  * @name Update
 162  *
 163  * DB update return values
 164  * @{
 165  */
 166 define ( 'UPDATE_SUCCESS', 0);
 167 define ( 'UPDATE_FAILED',  1);
 168 /** @}*/
 169
 170
 171 /**
 172  * @name page/profile types
 173  *
 174  * PAGE_NORMAL is a typical personal profile account
 175  * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
 176  * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
 177  *      write access to wall and comments (no email and not included in page owner's ACL lists)
 178  * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
 179  *
 180  * @{
 181  */
 182 define ( 'PAGE_NORMAL',            0 );
 183 define ( 'PAGE_SOAPBOX',           1 );
 184 define ( 'PAGE_COMMUNITY',         2 );
 185 define ( 'PAGE_FREELOVE',          3 );
 186 define ( 'PAGE_BLOG',              4 );
 187 define ( 'PAGE_PRVGROUP',          5 );
 188 /** @}*/
 189
 190 /**
 191  * @name account types
 192  *
 193  * ACCOUNT_TYPE_PERSON - the account belongs to a person
 194  *      Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
 195  *
 196  * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
 197  *      Associated page type: PAGE_SOAPBOX
 198  *
 199  * ACCOUNT_TYPE_NEWS - the account is a news reflector
 200  *      Associated page type: PAGE_SOAPBOX
 201  *
 202  * ACCOUNT_TYPE_COMMUNITY - the account is community forum
 203  *      Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
 204  * @{
 205  */
 206 define ( 'ACCOUNT_TYPE_PERSON',      0 );
 207 define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
 208 define ( 'ACCOUNT_TYPE_NEWS',        2 );
 209 define ( 'ACCOUNT_TYPE_COMMUNITY',   3 );
 210 /** @}*/
 211
 212 /**
 213  * @name CP
 214  *
 215  * Type of the community page
 216  * @{
 217  */
 218 define ( 'CP_NO_COMMUNITY_PAGE',   -1 );
 219 define ( 'CP_USERS_ON_SERVER',     0 );
 220 define ( 'CP_GLOBAL_COMMUNITY',    1 );
 221 /** @}*/
 222
 223 /**
 224  * @name Network
 225  *
 226  * Network and protocol family types
 227  * @{
 228  */
 229 define ( 'NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
 230 define ( 'NETWORK_ZOT',              'zot!');    // Zot!
 231 define ( 'NETWORK_OSTATUS',          'stat');    // status.net, identi.ca, GNU-social, other OStatus implementations
 232 define ( 'NETWORK_FEED',             'feed');    // RSS/Atom feeds with no known "post/notify" protocol
 233 define ( 'NETWORK_DIASPORA',         'dspr');    // Diaspora
 234 define ( 'NETWORK_MAIL',             'mail');    // IMAP/POP
 235 define ( 'NETWORK_MAIL2',            'mai2');    // extended IMAP/POP
 236 define ( 'NETWORK_FACEBOOK',         'face');    // Facebook API
 237 define ( 'NETWORK_LINKEDIN',         'lnkd');    // LinkedIn
 238 define ( 'NETWORK_XMPP',             'xmpp');    // XMPP
 239 define ( 'NETWORK_MYSPACE',          'mysp');    // MySpace
 240 define ( 'NETWORK_GPLUS',            'goog');    // Google+
 241 define ( 'NETWORK_PUMPIO',           'pump');    // pump.io
 242 define ( 'NETWORK_TWITTER',          'twit');    // Twitter
 243 define ( 'NETWORK_DIASPORA2',        'dspc');    // Diaspora connector
 244 define ( 'NETWORK_STATUSNET',        'stac');    // Statusnet connector
 245 define ( 'NETWORK_APPNET',           'apdn');    // app.net
 246 define ( 'NETWORK_NEWS',             'nntp');    // Network News Transfer Protocol
 247 define ( 'NETWORK_ICALENDAR',        'ical');    // iCalendar
 248 define ( 'NETWORK_PHANTOM',          'unkn');    // Place holder
 249 /** @}*/
 250
 251 /**
 252  * These numbers are used in stored permissions
 253  * and existing allocations MUST NEVER BE CHANGED
 254  * OR RE-ASSIGNED! You may only add to them.
 255  */
 256
 257 $netgroup_ids = array(
 258         NETWORK_DFRN     => (-1),
 259         NETWORK_ZOT      => (-2),
 260         NETWORK_OSTATUS  => (-3),
 261         NETWORK_FEED     => (-4),
 262         NETWORK_DIASPORA => (-5),
 263         NETWORK_MAIL     => (-6),
 264         NETWORK_MAIL2    => (-7),
 265         NETWORK_FACEBOOK => (-8),
 266         NETWORK_LINKEDIN => (-9),
 267         NETWORK_XMPP     => (-10),
 268         NETWORK_MYSPACE  => (-11),
 269         NETWORK_GPLUS    => (-12),
 270         NETWORK_PUMPIO   => (-13),
 271         NETWORK_TWITTER  => (-14),
 272         NETWORK_DIASPORA2 => (-15),
 273         NETWORK_STATUSNET => (-16),
 274         NETWORK_APPNET    => (-17),
 275         NETWORK_NEWS      => (-18),
 276         NETWORK_ICALENDAR => (-19),
 277
 278         NETWORK_PHANTOM  => (-127),
 279 );
 280
 281
 282 /**
 283  * Maximum number of "people who like (or don't like) this"  that we will list by name
 284  */
 285
 286 define ( 'MAX_LIKERS',    75);
 287
 288 /**
 289  * Communication timeout
 290  */
 291
 292 define ( 'ZCURL_TIMEOUT' , (-1));
 293
 294
 295 /**
 296  * @name Notify
 297  *
 298  * Email notification options
 299  * @{
 300  */
 301 define ( 'NOTIFY_INTRO',    0x0001 );
 302 define ( 'NOTIFY_CONFIRM',  0x0002 );
 303 define ( 'NOTIFY_WALL',     0x0004 );
 304 define ( 'NOTIFY_COMMENT',  0x0008 );
 305 define ( 'NOTIFY_MAIL',     0x0010 );
 306 define ( 'NOTIFY_SUGGEST',  0x0020 );
 307 define ( 'NOTIFY_PROFILE',  0x0040 );
 308 define ( 'NOTIFY_TAGSELF',  0x0080 );
 309 define ( 'NOTIFY_TAGSHARE', 0x0100 );
 310 define ( 'NOTIFY_POKE',     0x0200 );
 311 define ( 'NOTIFY_SHARE',    0x0400 );
 312
 313 define ( 'NOTIFY_SYSTEM',   0x8000 );
 314 /* @}*/
 315
 316
 317 /**
 318  * @name Term
 319  *
 320  * Tag/term types
 321  * @{
 322  */
 323 define ( 'TERM_UNKNOWN',   0 );
 324 define ( 'TERM_HASHTAG',   1 );
 325 define ( 'TERM_MENTION',   2 );
 326 define ( 'TERM_CATEGORY',  3 );
 327 define ( 'TERM_PCATEGORY', 4 );
 328 define ( 'TERM_FILE',      5 );
 329 define ( 'TERM_SAVEDSEARCH', 6 );
 330 define ( 'TERM_CONVERSATION', 7 );
 331
 332 define ( 'TERM_OBJ_POST',  1 );
 333 define ( 'TERM_OBJ_PHOTO', 2 );
 334
 335
 336
 337 /**
 338  * @name Namespaces
 339  *
 340  * Various namespaces we may need to parse
 341  * @{
 342  */
 343 define ( 'NAMESPACE_ZOT',             'http://purl.org/zot' );
 344 define ( 'NAMESPACE_DFRN' ,           'http://purl.org/macgirvin/dfrn/1.0' );
 345 define ( 'NAMESPACE_THREAD' ,         'http://purl.org/syndication/thread/1.0' );
 346 define ( 'NAMESPACE_TOMB' ,           'http://purl.org/atompub/tombstones/1.0' );
 347 define ( 'NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/' );
 348 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
 349 define ( 'NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia' );
 350 define ( 'NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env' );
 351 define ( 'NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe' );
 352 define ( 'NAMESPACE_GEORSS',          'http://www.georss.org/georss' );
 353 define ( 'NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0' );
 354 define ( 'NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from' );
 355 define ( 'NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0' );
 356 define ( 'NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/' );
 357 define ( 'NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom' );
 358 /* @}*/
 359
 360 /**
 361  * @name Activity
 362  *
 363  * Activity stream defines
 364  * @{
 365  */
 366 define ( 'ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like' );
 367 define ( 'ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike' );
 368 define ( 'ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes' );
 369 define ( 'ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno' );
 370 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe' );
 371
 372 define ( 'ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart' );
 373
 374 define ( 'ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
 375 define ( 'ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
 376 define ( 'ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
 377 define ( 'ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
 378 define ( 'ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
 379 define ( 'ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join' );
 380
 381 define ( 'ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post' );
 382 define ( 'ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update' );
 383 define ( 'ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
 384 define ( 'ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
 385 define ( 'ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share' );
 386
 387 define ( 'ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke' );
 388 define ( 'ACTIVITY_MOOD',        NAMESPACE_ZOT . '/activity/mood' );
 389
 390 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
 391 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
 392 define ( 'ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note' );
 393 define ( 'ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person' );
 394 define ( 'ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image' );
 395 define ( 'ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
 396 define ( 'ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video' );
 397 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
 398 define ( 'ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
 399 define ( 'ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event' );
 400 define ( 'ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group' );
 401 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm' );
 402 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile' );
 403 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
 404 /* @}*/
 405
 406 /**
 407  * @name Gravity
 408  *
 409  * Item weight for query ordering
 410  * @{
 411  */
 412 define ( 'GRAVITY_PARENT',       0);
 413 define ( 'GRAVITY_LIKE',         3);
 414 define ( 'GRAVITY_COMMENT',      6);
 415 /* @}*/
 416
 417 /**
 418  * @name Priority
 419  *
 420  * Process priority for the worker
 421  * @{
 422  */
 423 define('PRIORITY_UNDEFINED',  0);
 424 define('PRIORITY_CRITICAL',  10);
 425 define('PRIORITY_HIGH',      20);
 426 define('PRIORITY_MEDIUM',    30);
 427 define('PRIORITY_LOW',       40);
 428 define('PRIORITY_NEGLIGIBLE',50);
 429 /* @}*/
 430
 431
 432 // Normally this constant is defined - but not if "pcntl" isn't installed
 433 if (!defined("SIGTERM"))
 434         define("SIGTERM", 15);
 435
 436 /**
 437  *
 438  * Reverse the effect of magic_quotes_gpc if it is enabled.
 439  * Please disable magic_quotes_gpc so we don't have to do this.
 440  * See http://php.net/manual/en/security.magicquotes.disabling.php
 441  *
 442  */
 443
 444 function startup() {
 445
 446         error_reporting(E_ERROR | E_WARNING | E_PARSE);
 447
 448         set_time_limit(0);
 449
 450         // This has to be quite large to deal with embedded private photos
 451         ini_set('pcre.backtrack_limit', 500000);
 452
 453
 454         if (get_magic_quotes_gpc()) {
 455                 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
 456                 while (list($key, $val) = each($process)) {
 457                         foreach ($val as $k => $v) {
 458                                 unset($process[$key][$k]);
 459                                 if (is_array($v)) {
 460                                         $process[$key][stripslashes($k)] = $v;
 461                                         $process[] = &$process[$key][stripslashes($k)];
 462                                 } else {
 463                                         $process[$key][stripslashes($k)] = stripslashes($v);
 464                                 }
 465                         }
 466                 }
 467                 unset($process);
 468         }
 469
 470 }
 471
 472 /**
 473  *
 474  * class: App
 475  *
 476  * @brief Our main application structure for the life of this page.
 477  *
 478  * Primarily deals with the URL that got us here
 479  * and tries to make some sense of it, and
 480  * stores our page contents and config storage
 481  * and anything else that might need to be passed around
 482  * before we spit the page out.
 483  *
 484  */
 485 class App {
 486
 487         public  $module_loaded = false;
 488         public  $query_string;
 489         public  $config;
 490         public  $page;
 491         public  $profile;
 492         public  $profile_uid;
 493         public  $user;
 494         public  $cid;
 495         public  $contact;
 496         public  $contacts;
 497         public  $page_contact;
 498         public  $content;
 499         public  $data = array();
 500         public  $error = false;
 501         public  $cmd;
 502         public  $argv;
 503         public  $argc;
 504         public  $module;
 505         public  $pager;
 506         public  $strings;
 507         public  $path;
 508         public  $hooks;
 509         public  $timezone;
 510         public  $interactive = true;
 511         public  $plugins;
 512         public  $apps = array();
 513         public  $identities;
 514         public  $is_mobile = false;
 515         public  $is_tablet = false;
 516         public  $is_friendica_app;
 517         public  $performance = array();
 518         public  $callstack = array();
 519         public  $theme_info = array();
 520         public  $backend = true;
 521
 522         public $nav_sel;
 523
 524         public $category;
 525
 526
 527         // Allow themes to control internal parameters
 528         // by changing App values in theme.php
 529
 530         public  $sourcename = '';
 531         public  $videowidth = 425;
 532         public  $videoheight = 350;
 533         public  $force_max_items = 0;
 534         public  $theme_thread_allow = true;
 535         public  $theme_events_in_profile = true;
 536
 537         /**
 538          * @brief An array for all theme-controllable parameters
 539          *
 540          * Mostly unimplemented yet. Only options 'template_engine' and
 541          * beyond are used.
 542          */
 543         public  $theme = array(
 544                 'sourcename' => '',
 545                 'videowidth' => 425,
 546                 'videoheight' => 350,
 547                 'force_max_items' => 0,
 548                 'thread_allow' => true,
 549                 'stylesheet' => '',
 550                 'template_engine' => 'smarty3',
 551         );
 552
 553         /**
 554          * @brief An array of registered template engines ('name'=>'class name')
 555          */
 556         public $template_engines = array();
 557         /**
 558          * @brief An array of instanced template engines ('name'=>'instance')
 559          */
 560         public $template_engine_instance = array();
 561
 562         public $process_id;
 563
 564         private $ldelim = array(
 565                 'internal' => '',
 566                 'smarty3' => '{{'
 567         );
 568         private $rdelim = array(
 569                 'internal' => '',
 570                 'smarty3' => '}}'
 571         );
 572
 573         private $scheme;
 574         private $hostname;
 575         private $baseurl;
 576         private $db;
 577
 578         private $curl_code;
 579         private $curl_content_type;
 580         private $curl_headers;
 581
 582         private $cached_profile_image;
 583         private $cached_profile_picdate;
 584
 585         private static $a;
 586
 587         /**
 588          * @brief App constructor.
 589          */
 590         function __construct() {
 591
 592                 global $default_timezone;
 593
 594                 $hostname = "";
 595
 596                 if (file_exists(".htpreconfig.php"))
 597                         @include(".htpreconfig.php");
 598
 599                 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
 600
 601                 date_default_timezone_set($this->timezone);
 602
 603                 $this->performance["start"] = microtime(true);
 604                 $this->performance["database"] = 0;
 605                 $this->performance["database_write"] = 0;
 606                 $this->performance["network"] = 0;
 607                 $this->performance["file"] = 0;
 608                 $this->performance["rendering"] = 0;
 609                 $this->performance["parser"] = 0;
 610                 $this->performance["marktime"] = 0;
 611                 $this->performance["markstart"] = microtime(true);
 612
 613                 $this->callstack["database"] = array();
 614                 $this->callstack["database_write"] = array();
 615                 $this->callstack["network"] = array();
 616                 $this->callstack["file"] = array();
 617                 $this->callstack["rendering"] = array();
 618                 $this->callstack["parser"] = array();
 619
 620                 $this->config = array();
 621                 $this->page = array();
 622                 $this->pager= array();
 623
 624                 $this->query_string = '';
 625
 626                 $this->process_id = uniqid("log", true);
 627
 628                 startup();
 629
 630                 set_include_path(
 631                                 'include' . PATH_SEPARATOR
 632                                 . 'library' . PATH_SEPARATOR
 633                                 . 'library/phpsec' . PATH_SEPARATOR
 634                                 . 'library/langdet' . PATH_SEPARATOR
 635                                 . '.' );
 636
 637
 638                 $this->scheme = 'http';
 639                 if((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
 640                    (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
 641                    (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
 642                    (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
 643                    (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
 644                    (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
 645                    ) {
 646                         $this->scheme = 'https';
 647                    }
 648
 649                 if(x($_SERVER,'SERVER_NAME')) {
 650                         $this->hostname = $_SERVER['SERVER_NAME'];
 651
 652                         if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
 653                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
 654                         /*
 655                          * Figure out if we are running at the top of a domain
 656                          * or in a sub-directory and adjust accordingly
 657                          */
 658
 659                         $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
 660                         if(isset($path) && strlen($path) && ($path != $this->path))
 661                                 $this->path = $path;
 662                 }
 663
 664                 if ($hostname != "")
 665                         $this->hostname = $hostname;
 666
 667                 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
 668                         $this->set_baseurl(array_pop($_SERVER["argv"]) );
 669                         $_SERVER["argc"] --;
 670                 }
 671
 672                 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
 673
 674                 if ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
 675                         $this->query_string = substr($_SERVER['QUERY_STRING'],9);
 676                         // removing trailing / - maybe a nginx problem
 677                         if (substr($this->query_string, 0, 1) == "/")
 678                                 $this->query_string = substr($this->query_string, 1);
 679                 } elseif ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
 680                         $this->query_string = substr($_SERVER['QUERY_STRING'],2);
 681                         // removing trailing / - maybe a nginx problem
 682                         if (substr($this->query_string, 0, 1) == "/")
 683                                 $this->query_string = substr($this->query_string, 1);
 684                 }
 685
 686                 if (x($_GET,'pagename')) {
 687                         $this->cmd = trim($_GET['pagename'],'/\\');
 688                 } elseif (x($_GET,'q')) {
 689                         $this->cmd = trim($_GET['q'],'/\\');
 690                 }
 691
 692
 693                 // fix query_string
 694                 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
 695
 696
 697                 // unix style "homedir"
 698
 699                 if (substr($this->cmd,0,1) === '~') {
 700                         $this->cmd = 'profile/' . substr($this->cmd,1);
 701                 }
 702
 703                 // Diaspora style profile url
 704
 705                 if (substr($this->cmd,0,2) === 'u/') {
 706                         $this->cmd = 'profile/' . substr($this->cmd,2);
 707                 }
 708
 709
 710                 /*
 711                  *
 712                  * Break the URL path into C style argc/argv style arguments for our
 713                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 714                  * will be 3 (integer) and $this->argv will contain:
 715                  *   [0] => 'module'
 716                  *   [1] => 'arg1'
 717                  *   [2] => 'arg2'
 718                  *
 719                  *
 720                  * There will always be one argument. If provided a naked domain
 721                  * URL, $this->argv[0] is set to "home".
 722                  *
 723                  */
 724
 725                 $this->argv = explode('/',$this->cmd);
 726                 $this->argc = count($this->argv);
 727                 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
 728                         $this->module = str_replace(".", "_", $this->argv[0]);
 729                         $this->module = str_replace("-", "_", $this->module);
 730                 }
 731                 else {
 732                         $this->argc = 1;
 733                         $this->argv = array('home');
 734                         $this->module = 'home';
 735                 }
 736
 737                 /*
 738                  * See if there is any page number information, and initialise
 739                  * pagination
 740                  */
 741
 742                 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
 743                 $this->pager['itemspage'] = 50;
 744                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 745                 if($this->pager['start'] < 0)
 746                         $this->pager['start'] = 0;
 747                 $this->pager['total'] = 0;
 748
 749                 /*
 750                  * Detect mobile devices
 751                  */
 752
 753                 $mobile_detect = new Mobile_Detect();
 754                 $this->is_mobile = $mobile_detect->isMobile();
 755                 $this->is_tablet = $mobile_detect->isTablet();
 756
 757                 // Friendica-Client
 758                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
 759
 760                 /*
 761                  * register template engines
 762                  */
 763                 $dc = get_declared_classes();
 764                 foreach ($dc as $k) {
 765                         if (in_array("ITemplateEngine", class_implements($k))){
 766                                 $this->register_template_engine($k);
 767                         }
 768                 }
 769
 770                 self::$a = $this;
 771
 772         }
 773
 774         public static function get_basepath() {
 775
 776                 $basepath = get_config("system", "basepath");
 777
 778                 if ($basepath == "")
 779                         $basepath = dirname(__FILE__);
 780
 781                 if ($basepath == "")
 782                         $basepath = $_SERVER["DOCUMENT_ROOT"];
 783
 784                 if ($basepath == "")
 785                         $basepath = $_SERVER["PWD"];
 786
 787                 return($basepath);
 788         }
 789
 790         function get_scheme() {
 791                 return($this->scheme);
 792         }
 793
 794         /**
 795          * @brief Retrieves the Friendica instance base URL
 796          *
 797          * This function assembles the base URL from multiple parts:
 798          * - Protocol is determined either by the request or a combination of
 799          * system.ssl_policy and the $ssl parameter.
 800          * - Host name is determined either by system.hostname or inferred from request
 801          * - Path is inferred from SCRIPT_NAME
 802          *
 803          * Caches the result (depending on $ssl value) for performance.
 804          *
 805          * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
 806          *
 807          * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
 808          * @return string Friendica server base URL
 809          */
 810         function get_baseurl($ssl = false) {
 811
 812                 // Is the function called statically?
 813                 if (!(isset($this) && get_class($this) == __CLASS__)) {
 814                         return self::$a->get_baseurl($ssl);
 815                 }
 816
 817                 // Arbitrary values, the resulting url protocol can be different
 818                 $cache_index = $ssl ? 'https' : 'http';
 819
 820                 // Cached value found, nothing to process
 821                 if (isset($this->baseurl[$cache_index])) {
 822                         return $this->baseurl[$cache_index];
 823                 }
 824
 825                 $scheme = $this->scheme;
 826
 827                 if (Config::get('system', 'ssl_policy') === SSL_POLICY_FULL) {
 828                         $scheme = 'https';
 829                 }
 830
 831                 //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 832                 //      (and also the login link). Anything seen by an outsider will have it turned off.
 833
 834                 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
 835                         if ($ssl) {
 836                                 $scheme = 'https';
 837                         } else {
 838                                 $scheme = 'http';
 839                         }
 840                 }
 841
 842                 if (Config::get('config', 'hostname') != '') {
 843                         $this->hostname = get_config('config', 'hostname');
 844                 }
 845
 846                 $this->baseurl[$cache_index] = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
 847
 848                 return $this->baseurl[$cache_index];
 849         }
 850
 851         /**
 852          * @brief Initializes the baseurl components
 853          *
 854          * Clears the baseurl cache to prevent inconstistencies
 855          *
 856          * @param string $url
 857          */
 858         function set_baseurl($url) {
 859                 $parsed = @parse_url($url);
 860
 861                 $this->baseurl = [];
 862
 863                 if($parsed) {
 864                         $this->scheme = $parsed['scheme'];
 865
 866                         $hostname = $parsed['host'];
 867                         if (x($parsed, 'port')) {
 868                                 $hostname .= ':' . $parsed['port'];
 869                         }
 870                         if (x($parsed, 'path')) {
 871                                 $this->path = trim($parsed['path'], '\\/');
 872                         }
 873
 874                         if (file_exists(".htpreconfig.php")) {
 875                                 @include(".htpreconfig.php");
 876                         }
 877
 878                         if (get_config('config', 'hostname') != '') {
 879                                 $this->hostname = get_config('config', 'hostname');
 880                         }
 881
 882                         if (!isset($this->hostname) OR ($this->hostname == '')) {
 883                                 $this->hostname = $hostname;
 884                         }
 885                 }
 886         }
 887
 888         function get_hostname() {
 889                 if (get_config('config','hostname') != "")
 890                         $this->hostname = get_config('config','hostname');
 891
 892                 return $this->hostname;
 893         }
 894
 895         function set_hostname($h) {
 896                 $this->hostname = $h;
 897         }
 898
 899         function set_path($p) {
 900                 $this->path = trim(trim($p),'/');
 901         }
 902
 903         function get_path() {
 904                 return $this->path;
 905         }
 906
 907         function set_pager_total($n) {
 908                 $this->pager['total'] = intval($n);
 909         }
 910
 911         function set_pager_itemspage($n) {
 912                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 913                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 914         }
 915
 916         function set_pager_page($n) {
 917                 $this->pager['page'] = $n;
 918                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 919         }
 920
 921         function init_pagehead() {
 922                 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
 923
 924                 // If the update is "deactivated" set it to the highest integer number (~24 days)
 925                 if ($interval < 0)
 926                         $interval = 2147483647;
 927
 928                 if($interval < 10000)
 929                         $interval = 40000;
 930
 931                 // compose the page title from the sitename and the
 932                 // current module called
 933                 if (!$this->module=='')
 934                 {
 935                     $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
 936                 } else {
 937                     $this->page['title'] = $this->config['sitename'];
 938                 }
 939
 940                 /* put the head template at the beginning of page['htmlhead']
 941                  * since the code added by the modules frequently depends on it
 942                  * being first
 943                  */
 944                 if(!isset($this->page['htmlhead']))
 945                         $this->page['htmlhead'] = '';
 946
 947                 // If we're using Smarty, then doing replace_macros() will replace
 948                 // any unrecognized variables with a blank string. Since we delay
 949                 // replacing $stylesheet until later, we need to replace it now
 950                 // with another variable name
 951                 if($this->theme['template_engine'] === 'smarty3')
 952                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
 953                 else
 954                         $stylesheet = '$stylesheet';
 955
 956                 $shortcut_icon = get_config("system", "shortcut_icon");
 957                 if ($shortcut_icon == "")
 958                         $shortcut_icon = "images/friendica-32.png";
 959
 960                 $touch_icon = get_config("system", "touch_icon");
 961                 if ($touch_icon == "")
 962                         $touch_icon = "images/friendica-128.png";
 963
 964                 // get data wich is needed for infinite scroll on the network page
 965                 $invinite_scroll = infinite_scroll_data($this->module);
 966
 967                 $tpl = get_markup_template('head.tpl');
 968                 $this->page['htmlhead'] = replace_macros($tpl,array(
 969                         '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
 970                         '$local_user' => local_user(),
 971                         '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
 972                         '$delitem' => t('Delete this item?'),
 973                         '$comment' => t('Comment'),
 974                         '$showmore' => t('show more'),
 975                         '$showfewer' => t('show fewer'),
 976                         '$update_interval' => $interval,
 977                         '$shortcut_icon' => $shortcut_icon,
 978                         '$touch_icon' => $touch_icon,
 979                         '$stylesheet' => $stylesheet,
 980                         '$infinite_scroll' => $invinite_scroll,
 981                 )) . $this->page['htmlhead'];
 982         }
 983
 984         function init_page_end() {
 985                 if(!isset($this->page['end']))
 986                         $this->page['end'] = '';
 987                 $tpl = get_markup_template('end.tpl');
 988                 $this->page['end'] = replace_macros($tpl,array(
 989                         '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
 990                 )) . $this->page['end'];
 991         }
 992
 993         function set_curl_code($code) {
 994                 $this->curl_code = $code;
 995         }
 996
 997         function get_curl_code() {
 998                 return $this->curl_code;
 999         }
1000
1001         function set_curl_content_type($content_type) {
1002                 $this->curl_content_type = $content_type;
1003         }
1004
1005         function get_curl_content_type() {
1006                 return $this->curl_content_type;
1007         }
1008
1009         function set_curl_headers($headers) {
1010                 $this->curl_headers = $headers;
1011         }
1012
1013         function get_curl_headers() {
1014                 return $this->curl_headers;
1015         }
1016
1017         function get_cached_avatar_image($avatar_image){
1018                 return $avatar_image;
1019
1020                 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
1021                 /*
1022                 if($this->cached_profile_image[$avatar_image])
1023                         return $this->cached_profile_image[$avatar_image];
1024
1025                 $path_parts = explode("/",$avatar_image);
1026                 $common_filename = $path_parts[count($path_parts)-1];
1027
1028                 if($this->cached_profile_picdate[$common_filename]){
1029                         $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
1030                 } else {
1031                         $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
1032                                 $common_filename);
1033                         if (! dbm::is_result($r)) {
1034                                 $this->cached_profile_image[$avatar_image] = $avatar_image;
1035                         } else {
1036                                 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
1037                                 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
1038                         }
1039                 }
1040                 return $this->cached_profile_image[$avatar_image];
1041                 */
1042         }
1043
1044
1045         /**
1046          * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1047          *
1048          * @param string $orig_url
1049          *
1050          * @return string The cleaned url
1051          */
1052         function remove_baseurl($orig_url){
1053
1054                 // Is the function called statically?
1055                 if (!(isset($this) && get_class($this) == __CLASS__)) {
1056                         return(self::$a->remove_baseurl($orig_url));
1057                 }
1058
1059                 // Remove the hostname from the url if it is an internal link
1060                 $nurl = normalise_link($orig_url);
1061                 $base = normalise_link($this->get_baseurl());
1062                 $url = str_replace($base."/", "", $nurl);
1063
1064                 // if it is an external link return the orignal value
1065                 if ($url == normalise_link($orig_url)) {
1066                         return $orig_url;
1067                 } else {
1068                         return $url;
1069                 }
1070         }
1071
1072         /**
1073          * @brief Register template engine class
1074          *
1075          * If $name is "", is used class static property $class::$name
1076          *
1077          * @param string $class
1078          * @param string $name
1079          */
1080         function register_template_engine($class, $name = '') {
1081                 if ($name===""){
1082                         $v = get_class_vars( $class );
1083                         if(x($v,"name")) $name = $v['name'];
1084                 }
1085                 if ($name===""){
1086                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1087                         killme();
1088                 }
1089                 $this->template_engines[$name] = $class;
1090         }
1091
1092         /**
1093          * @brief Return template engine instance.
1094          *
1095          * If $name is not defined, return engine defined by theme,
1096          * or default
1097          *
1098          * @param strin $name Template engine name
1099          * @return object Template Engine instance
1100          */
1101         function template_engine($name = ''){
1102                 if ($name!=="") {
1103                         $template_engine = $name;
1104                 } else {
1105                         $template_engine = 'smarty3';
1106                         if (x($this->theme, 'template_engine')) {
1107                                 $template_engine = $this->theme['template_engine'];
1108                         }
1109                 }
1110
1111                 if (isset($this->template_engines[$template_engine])){
1112                         if(isset($this->template_engine_instance[$template_engine])){
1113                                 return $this->template_engine_instance[$template_engine];
1114                         } else {
1115                                 $class = $this->template_engines[$template_engine];
1116                                 $obj = new $class;
1117                                 $this->template_engine_instance[$template_engine] = $obj;
1118                                 return $obj;
1119                         }
1120                 }
1121
1122                 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1123         }
1124
1125         /**
1126          * @brief Returns the active template engine.
1127          *
1128          * @return string
1129          */
1130         function get_template_engine() {
1131                 return $this->theme['template_engine'];
1132         }
1133
1134         function set_template_engine($engine = 'smarty3') {
1135                 $this->theme['template_engine'] = $engine;
1136                 /*
1137                 $this->theme['template_engine'] = 'smarty3';
1138
1139                 switch($engine) {
1140                         case 'smarty3':
1141                                 if(is_writable('view/smarty3/'))
1142                                         $this->theme['template_engine'] = 'smarty3';
1143                                 break;
1144                         default:
1145                                 break;
1146                 }
1147                 */
1148         }
1149
1150         function get_template_ldelim($engine = 'smarty3') {
1151                 return $this->ldelim[$engine];
1152         }
1153
1154         function get_template_rdelim($engine = 'smarty3') {
1155                 return $this->rdelim[$engine];
1156         }
1157
1158         function save_timestamp($stamp, $value) {
1159                 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler'])
1160                         return;
1161
1162                 $duration = (float)(microtime(true)-$stamp);
1163
1164                 if (!isset($this->performance[$value])) {
1165                         // Prevent ugly E_NOTICE
1166                         $this->performance[$value] = 0;
1167                 }
1168
1169                 $this->performance[$value] += (float)$duration;
1170                 $this->performance["marktime"] += (float)$duration;
1171
1172                 $callstack = $this->callstack();
1173
1174                 if (!isset($this->callstack[$value][$callstack])) {
1175                         // Prevent ugly E_NOTICE
1176                         $this->callstack[$value][$callstack] = 0;
1177                 }
1178
1179                 $this->callstack[$value][$callstack] += (float)$duration;
1180
1181         }
1182
1183         /**
1184          * @brief Log active processes into the "process" table
1185          */
1186         function start_process() {
1187                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1188
1189                 $command = basename($trace[0]["file"]);
1190
1191                 $this->remove_inactive_processes();
1192
1193                 q("START TRANSACTION");
1194
1195                 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1196                 if (!dbm::is_result($r)) {
1197                         q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1198                                 intval(getmypid()),
1199                                 dbesc($command),
1200                                 dbesc(datetime_convert()));
1201                 }
1202                 q("COMMIT");
1203         }
1204
1205         /**
1206          * @brief Remove inactive processes
1207          */
1208         function remove_inactive_processes() {
1209                 q("START TRANSACTION");
1210
1211                 $r = q("SELECT `pid` FROM `process`");
1212                 if (dbm::is_result($r)) {
1213                         foreach ($r AS $process) {
1214                                 if (!posix_kill($process["pid"], 0)) {
1215                                         q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1216                                 }
1217                         }
1218                 }
1219                 q("COMMIT");
1220         }
1221
1222         /**
1223          * @brief Remove the active process from the "process" table
1224          */
1225         function end_process() {
1226                 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1227         }
1228
1229         /**
1230          * @brief Returns a string with a callstack. Can be used for logging.
1231          *
1232          * @return string
1233          */
1234         function callstack() {
1235                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1236
1237                 // We remove the first two items from the list since they contain data that we don't need.
1238                 array_shift($trace);
1239                 array_shift($trace);
1240
1241                 $callstack = array();
1242                 foreach ($trace AS $func)
1243                         $callstack[] = $func["function"];
1244
1245                 return implode(", ", $callstack);
1246         }
1247
1248         function get_useragent() {
1249                 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1250         }
1251
1252         function is_friendica_app() {
1253                 return($this->is_friendica_app);
1254         }
1255
1256         /**
1257          * @brief Checks if the site is called via a backend process
1258          *
1259          * This isn't a perfect solution. But we need this check very early.
1260          * So we cannot wait until the modules are loaded.
1261          *
1262          * @return bool Is it a known backend?
1263          */
1264         function is_backend() {
1265                 $backend = array();
1266                 $backend[] = "_well_known";
1267                 $backend[] = "api";
1268                 $backend[] = "dfrn_notify";
1269                 $backend[] = "fetch";
1270                 $backend[] = "hcard";
1271                 $backend[] = "hostxrd";
1272                 $backend[] = "nodeinfo";
1273                 $backend[] = "noscrape";
1274                 $backend[] = "p";
1275                 $backend[] = "poco";
1276                 $backend[] = "post";
1277                 $backend[] = "proxy";
1278                 $backend[] = "pubsub";
1279                 $backend[] = "pubsubhubbub";
1280                 $backend[] = "receive";
1281                 $backend[] = "rsd_xml";
1282                 $backend[] = "salmon";
1283                 $backend[] = "statistics_json";
1284                 $backend[] = "xrd";
1285
1286                 if (in_array($this->module, $backend))
1287                         return(true);
1288                 else
1289                         return($this->backend);
1290         }
1291
1292         /**
1293          * @brief Checks if the maximum number of database processes is reached
1294          *
1295          * @return bool Is the limit reached?
1296          */
1297         function max_processes_reached() {
1298
1299                 if ($this->is_backend()) {
1300                         $process = "backend";
1301                         $max_processes = get_config('system', 'max_processes_backend');
1302                         if (intval($max_processes) == 0)
1303                                 $max_processes = 5;
1304                 } else {
1305                         $process = "frontend";
1306                         $max_processes = get_config('system', 'max_processes_frontend');
1307                         if (intval($max_processes) == 0)
1308                                 $max_processes = 20;
1309                 }
1310
1311                 $processlist = dbm::processlist();
1312                 if ($processlist["list"] != "") {
1313                         logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1314
1315                         if ($processlist["amount"] > $max_processes) {
1316                                 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1317                                 return true;
1318                         }
1319                 }
1320                 return false;
1321         }
1322
1323         /**
1324          * @brief Checks if the maximum load is reached
1325          *
1326          * @return bool Is the load reached?
1327          */
1328         function maxload_reached() {
1329
1330                 if ($this->is_backend()) {
1331                         $process = "backend";
1332                         $maxsysload = intval(get_config('system', 'maxloadavg'));
1333                         if ($maxsysload < 1)
1334                                 $maxsysload = 50;
1335                 } else {
1336                         $process = "frontend";
1337                         $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1338                         if ($maxsysload < 1)
1339                                 $maxsysload = 50;
1340                 }
1341
1342                 $load = current_load();
1343                 if ($load) {
1344                         if (intval($load) > $maxsysload) {
1345                                 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1346                                 return true;
1347                         }
1348                 }
1349                 return false;
1350         }
1351
1352         /**
1353          * @brief Checks if the process is already running
1354          *
1355          * @param string $taskname The name of the task that will be used for the name of the lockfile
1356          * @param string $task The path and name of the php script
1357          * @param int $timeout The timeout after which a task should be killed
1358          *
1359          * @return bool Is the process running?
1360          */
1361         function is_already_running($taskname, $task = "", $timeout = 540) {
1362
1363                 $lockpath = get_lockpath();
1364                 if ($lockpath != '') {
1365                         $pidfile = new pidfile($lockpath, $taskname);
1366                         if ($pidfile->is_already_running()) {
1367                                 logger("Already running");
1368                                 if ($pidfile->running_time() > $timeout) {
1369                                         $pidfile->kill();
1370                                         logger("killed stale process");
1371                                         // Calling a new instance
1372                                         if ($task != "")
1373                                                 proc_run(PRIORITY_MEDIUM, $task);
1374                                 }
1375                                 return true;
1376                         }
1377                 }
1378                 return false;
1379         }
1380
1381         function proc_run($args) {
1382
1383                 if (!function_exists("proc_open")) {
1384                         return;
1385                 }
1386
1387                 // Add the php path if it is a php call
1388                 if (count($args) && ($args[0] === 'php' OR !is_string($args[0]))) {
1389
1390                         // If the last worker fork was less than 10 seconds before then don't fork another one.
1391                         // This should prevent the forking of masses of workers.
1392                         if (get_config("system", "worker")) {
1393                                 $cachekey = "app:proc_run:started";
1394                                 $result = Cache::get($cachekey);
1395                                 if (!is_null($result)) {
1396                                         if ((time() - $result) < 10) {
1397                                                 return;
1398                                         }
1399                                 }
1400                                 // Set the timestamp of the last proc_run
1401                                 Cache::set($cachekey, time(), CACHE_MINUTE);
1402                         }
1403
1404                         $args[0] = ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php');
1405                 }
1406
1407                 // add baseurl to args. cli scripts can't construct it
1408                 $args[] = $this->get_baseurl();
1409
1410                 for($x = 0; $x < count($args); $x ++)
1411                         $args[$x] = escapeshellarg($args[$x]);
1412
1413                 $cmdline = implode($args," ");
1414
1415                 if(get_config('system','proc_windows'))
1416                         proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1417                 else
1418                         proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1419
1420         }
1421 }
1422
1423 /**
1424  * @brief Retrieve the App structure
1425  *
1426  * Useful in functions which require it but don't get it passed to them
1427  */
1428 function get_app() {
1429         global $a;
1430         return $a;
1431 }
1432
1433
1434 /**
1435  * @brief Multi-purpose function to check variable state.
1436  *
1437  * Usage: x($var) or $x($array, 'key')
1438  *
1439  * returns false if variable/key is not set
1440  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1441  * e.g. x('') or x(0) returns 0;
1442  *
1443  * @param string|array $s variable to check
1444  * @param string $k key inside the array to check
1445  *
1446  * @return bool|int
1447  */
1448 function x($s,$k = NULL) {
1449         if($k != NULL) {
1450                 if((is_array($s)) && (array_key_exists($k,$s))) {
1451                         if($s[$k])
1452                                 return (int) 1;
1453                         return (int) 0;
1454         }
1455                 return false;
1456         }
1457         else {
1458                 if(isset($s)) {
1459                         if($s) {
1460                                 return (int) 1;
1461                         }
1462                         return (int) 0;
1463                 }
1464                 return false;
1465         }
1466 }
1467
1468
1469 /**
1470  * @brief Called from db initialisation if db is dead.
1471  */
1472 function system_unavailable() {
1473         include('system_unavailable.php');
1474         system_down();
1475         killme();
1476 }
1477
1478
1479 function clean_urls() {
1480         $a = get_app();
1481         return true;
1482 }
1483
1484 function z_path() {
1485         $base = App::get_baseurl();
1486
1487         if(! clean_urls())
1488                 $base .= '/?q=';
1489
1490         return $base;
1491 }
1492
1493 /**
1494  * @brief Returns the baseurl.
1495  *
1496  * @see App::get_baseurl()
1497  *
1498  * @return string
1499  * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1500  */
1501 function z_root() {
1502         return App::get_baseurl();
1503 }
1504
1505 /**
1506  * @brief Return absolut URL for given $path.
1507  *
1508  * @param string $path
1509  *
1510  * @return string
1511  */
1512 function absurl($path) {
1513         if(strpos($path,'/') === 0)
1514                 return z_path() . $path;
1515         return $path;
1516 }
1517
1518 /**
1519  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1520  *
1521  * @return boolean
1522  */
1523 function is_ajax() {
1524         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1525 }
1526
1527 function check_db() {
1528
1529         $build = get_config('system','build');
1530         if(! x($build)) {
1531                 set_config('system','build',DB_UPDATE_VERSION);
1532                 $build = DB_UPDATE_VERSION;
1533         }
1534         if($build != DB_UPDATE_VERSION)
1535                 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1536
1537 }
1538
1539
1540 /**
1541  * Sets the base url for use in cmdline programs which don't have
1542  * $_SERVER variables
1543  */
1544 function check_url(App $a) {
1545
1546         $url = get_config('system','url');
1547
1548         // if the url isn't set or the stored url is radically different
1549         // than the currently visited url, store the current value accordingly.
1550         // "Radically different" ignores common variations such as http vs https
1551         // and www.example.com vs example.com.
1552         // We will only change the url to an ip address if there is no existing setting
1553
1554         if(! x($url))
1555                 $url = set_config('system','url',App::get_baseurl());
1556         if((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1557                 $url = set_config('system','url',App::get_baseurl());
1558
1559         return;
1560 }
1561
1562
1563 /**
1564  * @brief Automatic database updates
1565  */
1566 function update_db(App $a) {
1567         $build = get_config('system','build');
1568         if(! x($build))
1569                 $build = set_config('system','build',DB_UPDATE_VERSION);
1570
1571         if($build != DB_UPDATE_VERSION) {
1572                 $stored = intval($build);
1573                 $current = intval(DB_UPDATE_VERSION);
1574                 if($stored < $current) {
1575                         Config::load('database');
1576
1577                         // We're reporting a different version than what is currently installed.
1578                         // Run any existing update scripts to bring the database up to current.
1579
1580                         // make sure that boot.php and update.php are the same release, we might be
1581                         // updating right this very second and the correct version of the update.php
1582                         // file may not be here yet. This can happen on a very busy site.
1583
1584                         if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1585                                 // Compare the current structure with the defined structure
1586
1587                                 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1588                                 if($t !== false)
1589                                         return;
1590
1591                                 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1592
1593                                 // run old update routine (wich could modify the schema and
1594                                 // conflits with new routine)
1595                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1596                                         $r = run_update_function($x);
1597                                         if (!$r) break;
1598                                 }
1599                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1600
1601
1602                                 // run new update routine
1603                                 // it update the structure in one call
1604                                 $retval = update_structure(false, true);
1605                                 if($retval) {
1606                                         update_fail(
1607                                                 DB_UPDATE_VERSION,
1608                                                 $retval
1609                                         );
1610                                         return;
1611                                 } else {
1612                                         set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1613                                 }
1614
1615                                 // run any left update_nnnn functions in update.php
1616                                 for($x = $stored; $x < $current; $x ++) {
1617                                         $r = run_update_function($x);
1618                                         if (!$r) break;
1619                                 }
1620                         }
1621                 }
1622         }
1623
1624         return;
1625 }
1626
1627 function run_update_function($x) {
1628         if(function_exists('update_' . $x)) {
1629
1630                 // There could be a lot of processes running or about to run.
1631                 // We want exactly one process to run the update command.
1632                 // So store the fact that we're taking responsibility
1633                 // after first checking to see if somebody else already has.
1634
1635                 // If the update fails or times-out completely you may need to
1636                 // delete the config entry to try again.
1637
1638                 $t = get_config('database','update_' . $x);
1639                 if($t !== false)
1640                         return false;
1641                 set_config('database','update_' . $x, time());
1642
1643                 // call the specific update
1644
1645                 $func = 'update_' . $x;
1646                 $retval = $func();
1647
1648                 if($retval) {
1649                         //send the administrator an e-mail
1650                         update_fail(
1651                                 $x,
1652                                 sprintf(t('Update %s failed. See error logs.'), $x)
1653                         );
1654                         return false;
1655                 } else {
1656                         set_config('database','update_' . $x, 'success');
1657                         set_config('system','build', $x + 1);
1658                         return true;
1659                 }
1660         } else {
1661                 set_config('database','update_' . $x, 'success');
1662                 set_config('system','build', $x + 1);
1663                 return true;
1664         }
1665         return true;
1666 }
1667
1668 /**
1669  * @brief Synchronise plugins:
1670  *
1671  * $a->config['system']['addon'] contains a comma-separated list of names
1672  * of plugins/addons which are used on this system.
1673  * Go through the database list of already installed addons, and if we have
1674  * an entry, but it isn't in the config list, call the uninstall procedure
1675  * and mark it uninstalled in the database (for now we'll remove it).
1676  * Then go through the config list and if we have a plugin that isn't installed,
1677  * call the install procedure and add it to the database.
1678  *
1679  * @param App $a
1680  *
1681          */
1682 function check_plugins(App $a) {
1683
1684         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1685         if (dbm::is_result($r))
1686                 $installed = $r;
1687         else
1688                 $installed = array();
1689
1690         $plugins = get_config('system','addon');
1691         $plugins_arr = array();
1692
1693         if($plugins)
1694                 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1695
1696         $a->plugins = $plugins_arr;
1697
1698         $installed_arr = array();
1699
1700         if(count($installed)) {
1701                 foreach($installed as $i) {
1702                         if(! in_array($i['name'],$plugins_arr)) {
1703                                 uninstall_plugin($i['name']);
1704                         }
1705                         else {
1706                                 $installed_arr[] = $i['name'];
1707                         }
1708                 }
1709         }
1710
1711         if(count($plugins_arr)) {
1712                 foreach($plugins_arr as $p) {
1713                         if(! in_array($p,$installed_arr)) {
1714                                 install_plugin($p);
1715                         }
1716                 }
1717         }
1718
1719
1720         load_hooks();
1721
1722         return;
1723 }
1724
1725 function get_guid($size=16, $prefix = "") {
1726
1727         if ($prefix == "") {
1728                 $a = get_app();
1729                 $prefix = hash("crc32", $a->get_hostname());
1730         }
1731
1732         while (strlen($prefix) < ($size - 13))
1733                 $prefix .= mt_rand();
1734
1735         if ($size >= 24) {
1736                 $prefix = substr($prefix, 0, $size - 22);
1737                 return(str_replace(".", "", uniqid($prefix, true)));
1738         } else {
1739                 $prefix = substr($prefix, 0, max($size - 13, 0));
1740                 return(uniqid($prefix));
1741         }
1742 }
1743
1744 /**
1745  * @brief Wrapper for adding a login box.
1746  *
1747  * @param bool $register
1748  *      If $register == true provide a registration link.
1749  *      This will most always depend on the value of $a->config['register_policy'].
1750  * @param bool $hiddens
1751  *
1752  * @return string
1753  *      Returns the complete html for inserting into the page
1754  *
1755  * @hooks 'login_hook'
1756  *      string $o
1757  */
1758 function login($register = false, $hiddens=false) {
1759         $a = get_app();
1760         $o = "";
1761         $reg = false;
1762         if ($register) {
1763                 $reg = array(
1764                         'title' => t('Create a New Account'),
1765                         'desc' => t('Register')
1766                 );
1767         }
1768
1769         $noid = get_config('system','no_openid');
1770
1771         $dest_url = $a->query_string;
1772
1773         if(local_user()) {
1774                 $tpl = get_markup_template("logout.tpl");
1775         }
1776         else {
1777                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1778                         '$baseurl'              => $a->get_baseurl(true)
1779                 ));
1780
1781                 $tpl = get_markup_template("login.tpl");
1782                 $_SESSION['return_url'] = $a->query_string;
1783                 $a->module = 'login';
1784         }
1785
1786         $o .= replace_macros($tpl, array(
1787
1788                 '$dest_url'     => $dest_url,
1789                 '$logout'       => t('Logout'),
1790                 '$login'        => t('Login'),
1791
1792                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
1793                 '$lpassword'    => array('password', t('Password: '), '', ''),
1794                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
1795
1796                 '$openid'       => !$noid,
1797                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
1798
1799                 '$hiddens'      => $hiddens,
1800
1801                 '$register'     => $reg,
1802
1803                 '$lostpass'     => t('Forgot your password?'),
1804                 '$lostlink'     => t('Password Reset'),
1805
1806                 '$tostitle'     => t('Website Terms of Service'),
1807                 '$toslink'      => t('terms of service'),
1808
1809                 '$privacytitle' => t('Website Privacy Policy'),
1810                 '$privacylink'  => t('privacy policy'),
1811
1812         ));
1813
1814         call_hooks('login_hook',$o);
1815
1816         return $o;
1817 }
1818
1819 /**
1820  * @brief Used to end the current process, after saving session state.
1821  */
1822 function killme() {
1823
1824         if (!get_app()->is_backend())
1825                 session_write_close();
1826
1827         exit;
1828 }
1829
1830 /**
1831  * @brief Redirect to another URL and terminate this process.
1832  */
1833 function goaway($s) {
1834         if (!strstr(normalise_link($s), "http://"))
1835                 $s = App::get_baseurl()."/".$s;
1836
1837         header("Location: $s");
1838         killme();
1839 }
1840
1841
1842 /**
1843  * @brief Returns the user id of locally logged in user or false.
1844  *
1845  * @return int|bool user id or false
1846  */
1847 function local_user() {
1848         if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1849                 return intval($_SESSION['uid']);
1850         return false;
1851 }
1852
1853 /**
1854  * @brief Returns contact id of authenticated site visitor or false
1855  *
1856  * @return int|bool visitor_id or false
1857  */
1858 function remote_user() {
1859         if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1860                 return intval($_SESSION['visitor_id']);
1861         return false;
1862 }
1863
1864 /**
1865  * @brief Show an error message to user.
1866  *
1867  * This function save text in session, to be shown to the user at next page load
1868  *
1869  * @param string $s - Text of notice
1870  */
1871 function notice($s) {
1872         $a = get_app();
1873         if(! x($_SESSION,'sysmsg'))     $_SESSION['sysmsg'] = array();
1874         if($a->interactive)
1875                 $_SESSION['sysmsg'][] = $s;
1876 }
1877
1878 /**
1879  * @brief Show an info message to user.
1880  *
1881  * This function save text in session, to be shown to the user at next page load
1882  *
1883  * @param string $s - Text of notice
1884  */
1885 function info($s) {
1886         $a = get_app();
1887
1888         if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1889                 return;
1890
1891         if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1892         if($a->interactive)
1893                 $_SESSION['sysmsg_info'][] = $s;
1894 }
1895
1896
1897 /**
1898  * @brief Wrapper around config to limit the text length of an incoming message
1899  *
1900  * @return int
1901  */
1902 function get_max_import_size() {
1903         $a = get_app();
1904         return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1905 }
1906
1907 /**
1908  * @brief Wrap calls to proc_close(proc_open()) and call hook
1909  *      so plugins can take part in process :)
1910  *
1911  * @param (string|integer|array) $cmd program to run, priority or parameter array
1912  *
1913  * next args are passed as $cmd command line
1914  * e.g.: proc_run("ls","-la","/tmp");
1915  * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1916  * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1917  *
1918  * @note $cmd and string args are surrounded with ""
1919  *
1920  * @hooks 'proc_run'
1921  *      array $arr
1922  */
1923 function proc_run($cmd){
1924
1925         $a = get_app();
1926
1927         $proc_args = func_get_args();
1928
1929         $args = array();
1930         if (!count($proc_args)) {
1931                 return;
1932         }
1933
1934         // Preserve the first parameter
1935         // It could contain a command, the priority or an parameter array
1936         // If we use the parameter array we have to protect it from the following function
1937         $run_parameter = array_shift($proc_args);
1938
1939         // expand any arrays
1940         foreach ($proc_args as $arg) {
1941                 if (is_array($arg)) {
1942                         foreach ($arg as $n) {
1943                                 $args[] = $n;
1944                         }
1945                 } else {
1946                         $args[] = $arg;
1947                 }
1948         }
1949
1950         // Now we add the run parameters back to the array
1951         array_unshift($args, $run_parameter);
1952
1953         $arr = array('args' => $args, 'run_cmd' => true);
1954
1955         call_hooks("proc_run", $arr);
1956         if (!$arr['run_cmd'] OR !count($args))
1957                 return;
1958
1959         if (!get_config("system", "worker") OR (is_string($run_parameter) AND ($run_parameter != 'php'))) {
1960                 $a->proc_run($args);
1961                 return;
1962         }
1963
1964         $priority = PRIORITY_MEDIUM;
1965         $dont_fork = get_config("system", "worker_dont_fork");
1966
1967         if (is_int($run_parameter)) {
1968                 $priority = $run_parameter;
1969         } elseif (is_array($run_parameter)) {
1970                 if (isset($run_parameter['priority'])) {
1971                         $priority = $run_parameter['priority'];
1972                 }
1973                 if (isset($run_parameter['dont_fork'])) {
1974                         $dont_fork = $run_parameter['dont_fork'];
1975                 }
1976         }
1977
1978         $argv = $args;
1979         array_shift($argv);
1980
1981         $parameters = json_encode($argv);
1982         $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1983                 dbesc($parameters));
1984
1985         if (!$found)
1986                 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1987                         VALUES ('%s', '%s', %d)",
1988                         dbesc($parameters),
1989                         dbesc(datetime_convert()),
1990                         intval($priority));
1991
1992         // Should we quit and wait for the poller to be called as a cronjob?
1993         if ($dont_fork) {
1994                 return;
1995         }
1996
1997         // Checking number of workers
1998         $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1999
2000         // Get number of allowed number of worker threads
2001         $queues = intval(get_config("system", "worker_queues"));
2002
2003         if ($queues == 0)
2004                 $queues = 4;
2005
2006         // If there are already enough workers running, don't fork another one
2007         if ($workers[0]["workers"] >= $queues)
2008                 return;
2009
2010         // Now call the poller to execute the jobs that we just added to the queue
2011         $args = array("php", "include/poller.php", "no_cron");
2012
2013         $a->proc_run($args);
2014 }
2015
2016 function current_theme(){
2017         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2018
2019         $a = get_app();
2020
2021         $page_theme = null;
2022
2023         // Find the theme that belongs to the user whose stuff we are looking at
2024
2025         if($a->profile_uid && ($a->profile_uid != local_user())) {
2026                 $r = q("select theme from user where uid = %d limit 1",
2027                         intval($a->profile_uid)
2028                 );
2029                 if (dbm::is_result($r))
2030                         $page_theme = $r[0]['theme'];
2031         }
2032
2033         // Allow folks to over-rule user themes and always use their own on their own site.
2034         // This works only if the user is on the same server
2035
2036         if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2037                 if(get_pconfig(local_user(),'system','always_my_theme'))
2038                         $page_theme = null;
2039         }
2040
2041 //              $mobile_detect = new Mobile_Detect();
2042 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2043         $is_mobile = $a->is_mobile || $a->is_tablet;
2044
2045         $standard_system_theme = Config::get('system', 'theme', '');
2046         $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2047
2048         if ($is_mobile) {
2049                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2050                         $system_theme = $standard_system_theme;
2051                         $theme_name = $standard_theme_name;
2052                 } else {
2053                         $system_theme = Config::get('system', 'mobile-theme', '');
2054                         if ($system_theme == '') {
2055                                 $system_theme = $standard_system_theme;
2056                         }
2057                         $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2058
2059                         if($theme_name === '---') {
2060                                 // user has selected to have the mobile theme be the same as the normal one
2061                                 $system_theme = $standard_system_theme;
2062                                 $theme_name = $standard_theme_name;
2063
2064                                 if($page_theme)
2065                                         $theme_name = $page_theme;
2066                         }
2067                 }
2068         }
2069         else {
2070                 $system_theme = $standard_system_theme;
2071                 $theme_name = $standard_theme_name;
2072
2073                 if($page_theme)
2074                         $theme_name = $page_theme;
2075         }
2076
2077         if($theme_name &&
2078                         (file_exists('view/theme/' . $theme_name . '/style.css') ||
2079                                         file_exists('view/theme/' . $theme_name . '/style.php')))
2080                 return($theme_name);
2081
2082         foreach($app_base_themes as $t) {
2083                 if(file_exists('view/theme/' . $t . '/style.css')||
2084                                 file_exists('view/theme/' . $t . '/style.php'))
2085                         return($t);
2086         }
2087
2088         $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2089         if(count($fallback))
2090                 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2091
2092 }
2093
2094 /**
2095  * @brief Return full URL to theme which is currently in effect.
2096  *
2097  * Provide a sane default if nothing is chosen or the specified theme does not exist.
2098  *
2099  * @return string
2100  */
2101 function current_theme_url() {
2102         $a = get_app();
2103
2104         $t = current_theme();
2105
2106         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2107         if (file_exists('view/theme/' . $t . '/style.php'))
2108                 return('view/theme/'.$t.'/style.pcss'.$opts);
2109
2110         return('view/theme/'.$t.'/style.css');
2111 }
2112
2113 function feed_birthday($uid,$tz) {
2114
2115         /**
2116          *
2117          * Determine the next birthday, but only if the birthday is published
2118          * in the default profile. We _could_ also look for a private profile that the
2119          * recipient can see, but somebody could get mad at us if they start getting
2120          * public birthday greetings when they haven't made this info public.
2121          *
2122          * Assuming we are able to publish this info, we are then going to convert
2123          * the start time from the owner's timezone to UTC.
2124          *
2125          * This will potentially solve the problem found with some social networks
2126          * where birthdays are converted to the viewer's timezone and salutations from
2127          * elsewhere in the world show up on the wrong day. We will convert it to the
2128          * viewer's timezone also, but first we are going to convert it from the birthday
2129          * person's timezone to GMT - so the viewer may find the birthday starting at
2130          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2131          *
2132          */
2133
2134
2135         $birthday = '';
2136
2137         if(! strlen($tz))
2138                 $tz = 'UTC';
2139
2140         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2141                         intval($uid)
2142         );
2143
2144         if (dbm::is_result($p)) {
2145                 $tmp_dob = substr($p[0]['dob'],5);
2146                 if(intval($tmp_dob)) {
2147                         $y = datetime_convert($tz,$tz,'now','Y');
2148                         $bd = $y . '-' . $tmp_dob . ' 00:00';
2149                         $t_dob = strtotime($bd);
2150                         $now = strtotime(datetime_convert($tz,$tz,'now'));
2151                         if($t_dob < $now)
2152                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2153                         $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2154                 }
2155         }
2156
2157         return $birthday;
2158 }
2159
2160 /**
2161  * @brief Check if current user has admin role.
2162  *
2163  * @return bool true if user is an admin
2164  */
2165 function is_site_admin() {
2166         $a = get_app();
2167
2168         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2169
2170         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2171         if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2172                 return true;
2173         return false;
2174 }
2175
2176 /**
2177  * @brief Returns querystring as string from a mapped array.
2178  *
2179  * @param array $params mapped array with query parameters
2180  * @param string $name of parameter, default null
2181  *
2182  * @return string
2183  */
2184 function build_querystring($params, $name=null) {
2185         $ret = "";
2186         foreach($params as $key=>$val) {
2187                 if(is_array($val)) {
2188                         if($name==null) {
2189                                 $ret .= build_querystring($val, $key);
2190                         } else {
2191                                 $ret .= build_querystring($val, $name."[$key]");
2192                         }
2193                 } else {
2194                         $val = urlencode($val);
2195                         if($name!=null) {
2196                                 $ret.=$name."[$key]"."=$val&";
2197                         } else {
2198                                 $ret.= "$key=$val&";
2199                         }
2200                 }
2201         }
2202         return $ret;
2203 }
2204
2205 function explode_querystring($query) {
2206         $arg_st = strpos($query, '?');
2207         if($arg_st !== false) {
2208                 $base = substr($query, 0, $arg_st);
2209                 $arg_st += 1;
2210         } else {
2211                 $base = '';
2212                 $arg_st = 0;
2213         }
2214
2215         $args = explode('&', substr($query, $arg_st));
2216         foreach($args as $k=>$arg) {
2217                 if($arg === '')
2218                         unset($args[$k]);
2219         }
2220         $args = array_values($args);
2221
2222         if(!$base) {
2223                 $base = $args[0];
2224                 unset($args[0]);
2225                 $args = array_values($args);
2226         }
2227
2228         return array(
2229                 'base' => $base,
2230                 'args' => $args,
2231         );
2232 }
2233
2234 /**
2235 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2236 *
2237 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2238 */
2239 function curPageURL() {
2240         $pageURL = 'http';
2241         if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
2242         $pageURL .= "://";
2243         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2244                 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2245         } else {
2246                 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2247         }
2248         return $pageURL;
2249 }
2250
2251 function random_digits($digits) {
2252         $rn = '';
2253         for($i = 0; $i < $digits; $i++) {
2254                 $rn .= rand(0,9);
2255         }
2256         return $rn;
2257 }
2258
2259 function get_server() {
2260         $server = get_config("system", "directory");
2261
2262         if ($server == "")
2263                 $server = "http://dir.friendi.ca";
2264
2265         return($server);
2266 }
2267
2268 function get_cachefile($file, $writemode = true) {
2269         $cache = get_itemcachepath();
2270
2271         if ((! $cache) || (! is_dir($cache)))
2272                 return("");
2273
2274         $subfolder = $cache."/".substr($file, 0, 2);
2275
2276         $cachepath = $subfolder."/".$file;
2277
2278         if ($writemode) {
2279                 if (!is_dir($subfolder)) {
2280                         mkdir($subfolder);
2281                         chmod($subfolder, 0777);
2282                 }
2283         }
2284
2285         return($cachepath);
2286 }
2287
2288 function clear_cache($basepath = "", $path = "") {
2289         if ($path == "") {
2290                 $basepath = get_itemcachepath();
2291                 $path = $basepath;
2292         }
2293
2294         if (($path == "") OR (!is_dir($path)))
2295                 return;
2296
2297         if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2298                 return;
2299
2300         $cachetime = (int)get_config('system','itemcache_duration');
2301         if ($cachetime == 0)
2302                 $cachetime = 86400;
2303
2304         if (is_writable($path)){
2305                 if ($dh = opendir($path)) {
2306                         while (($file = readdir($dh)) !== false) {
2307                                 $fullpath = $path."/".$file;
2308                                 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2309                                         clear_cache($basepath, $fullpath);
2310                                 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2311                                         unlink($fullpath);
2312                         }
2313                         closedir($dh);
2314                 }
2315         }
2316 }
2317
2318 function get_itemcachepath() {
2319         // Checking, if the cache is deactivated
2320         $cachetime = (int)get_config('system','itemcache_duration');
2321         if ($cachetime < 0)
2322                 return "";
2323
2324         $itemcache = get_config('system','itemcache');
2325         if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2326                 return($itemcache);
2327
2328         $temppath = get_temppath();
2329
2330         if ($temppath != "") {
2331                 $itemcache = $temppath."/itemcache";
2332                 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2333                         mkdir($itemcache);
2334                 }
2335
2336                 if (is_dir($itemcache) AND is_writable($itemcache)) {
2337                         set_config("system", "itemcache", $itemcache);
2338                         return($itemcache);
2339                 }
2340         }
2341         return "";
2342 }
2343
2344 function get_lockpath() {
2345         $lockpath = get_config('system','lockpath');
2346         if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2347                 return($lockpath);
2348
2349         $temppath = get_temppath();
2350
2351         if ($temppath != "") {
2352                 $lockpath = $temppath."/lock";
2353
2354                 if (!is_dir($lockpath))
2355                         mkdir($lockpath);
2356                 elseif (!is_writable($lockpath))
2357                         $lockpath = $temppath;
2358
2359                 if (is_dir($lockpath) AND is_writable($lockpath)) {
2360                         set_config("system", "lockpath", $lockpath);
2361                         return($lockpath);
2362                 }
2363         }
2364         return "";
2365 }
2366
2367 /**
2368  * @brief Returns the path where spool files are stored
2369  *
2370  * @return string Spool path
2371  */
2372 function get_spoolpath() {
2373         $spoolpath = get_config('system','spoolpath');
2374         if (($spoolpath != "") AND is_dir($spoolpath) AND is_writable($spoolpath)) {
2375                 return($spoolpath);
2376         }
2377
2378         $temppath = get_temppath();
2379
2380         if ($temppath != "") {
2381                 $spoolpath = $temppath."/spool";
2382
2383                 if (!is_dir($spoolpath)) {
2384                         mkdir($spoolpath);
2385                 } elseif (!is_writable($spoolpath)) {
2386                         $spoolpath = $temppath;
2387                 }
2388
2389                 if (is_dir($spoolpath) AND is_writable($spoolpath)) {
2390                         set_config("system", "spoolpath", $spoolpath);
2391                         return($spoolpath);
2392                 }
2393         }
2394         return "";
2395 }
2396
2397 function get_temppath() {
2398         $a = get_app();
2399
2400         $temppath = get_config("system","temppath");
2401         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2402                 return($temppath);
2403
2404         $temppath = sys_get_temp_dir();
2405         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2406                 $temppath .= "/".$a->get_hostname();
2407                 if (!is_dir($temppath))
2408                         mkdir($temppath);
2409
2410                 if (is_dir($temppath) AND is_writable($temppath)) {
2411                         set_config("system", "temppath", $temppath);
2412                         return($temppath);
2413                 }
2414         }
2415
2416         return("");
2417 }
2418
2419 /// @deprecated
2420 function set_template_engine(App $a, $engine = 'internal') {
2421 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2422 /// to avoid breaking themes again unnecessarily
2423
2424         $a->set_template_engine($engine);
2425 }
2426
2427 if(!function_exists('exif_imagetype')) {
2428         function exif_imagetype($file) {
2429                 $size = getimagesize($file);
2430                 return($size[2]);
2431         }
2432 }
2433
2434 function validate_include(&$file) {
2435         $orig_file = $file;
2436
2437         $file = realpath($file);
2438
2439         if (strpos($file, getcwd()) !== 0)
2440                 return false;
2441
2442         $file = str_replace(getcwd()."/", "", $file, $count);
2443         if ($count != 1)
2444                 return false;
2445
2446         if ($orig_file !== $file)
2447                 return false;
2448
2449         $valid = false;
2450         if (strpos($file, "include/") === 0)
2451                 $valid = true;
2452
2453         if (strpos($file, "addon/") === 0)
2454                 $valid = true;
2455
2456         if (!$valid)
2457                 return false;
2458
2459         return true;
2460 }
2461
2462 function current_load() {
2463         if (!function_exists('sys_getloadavg'))
2464                 return false;
2465
2466         $load_arr = sys_getloadavg();
2467
2468         if (!is_array($load_arr))
2469                 return false;
2470
2471         return max($load_arr[0], $load_arr[1]);
2472 }
2473
2474 /**
2475  * @brief get c-style args
2476  *
2477  * @return int
2478  */
2479 function argc() {
2480         return get_app()->argc;
2481 }
2482
2483 /**
2484  * @brief Returns the value of a argv key
2485  *
2486  * @param int $x argv key
2487  * @return string Value of the argv key
2488  */
2489 function argv($x) {
2490         if(array_key_exists($x,get_app()->argv))
2491                 return get_app()->argv[$x];
2492
2493         return '';
2494 }
2495
2496 /**
2497  * @brief Get the data which is needed for infinite scroll
2498  *
2499  * For invinite scroll we need the page number of the actual page
2500  * and the the URI where the content of the next page comes from.
2501  * This data is needed for the js part in main.js.
2502  * Note: infinite scroll does only work for the network page (module)
2503  *
2504  * @param string $module The name of the module (e.g. "network")
2505  * @return array Of infinite scroll data
2506  *      'pageno' => $pageno The number of the actual page
2507  *      'reload_uri' => $reload_uri The URI of the content we have to load
2508  */
2509 function infinite_scroll_data($module) {
2510
2511         if (get_pconfig(local_user(),'system','infinite_scroll')
2512                 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2513
2514                 // get the page number
2515                 if (is_string($_GET["page"]))
2516                         $pageno = $_GET["page"];
2517                 else
2518                         $pageno = 1;
2519
2520                 $reload_uri = "";
2521
2522                 // try to get the uri from which we load the content
2523                 foreach ($_GET AS $param => $value)
2524                         if (($param != "page") AND ($param != "q"))
2525                                 $reload_uri .= "&".$param."=".urlencode($value);
2526
2527                 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2528                         $reload_uri .= "&offset=".urlencode($a->page_offset);
2529
2530                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
2531
2532                 return $arr;
2533         }
2534 }