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