boot.php

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