boot.php

   1 <?php
   2
   3 /** @file boot.php
   4  *
   5  * This file defines some global constants and includes the central App class.
   6  */
   7
   8 /**
   9  * Friendica
  10  *
  11  * Friendica is a communications platform for integrated social communications
  12  * utilising decentralised communications and linkage to several indie social
  13  * projects - as well as popular mainstream providers.
  14  *
  15  * Our mission is to free our friends and families from the clutches of
  16  * data-harvesting corporations, and pave the way to a future where social
  17  * communications are free and open and flow between alternate providers as
  18  * easily as email does today.
  19  */
  20
  21 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
  22
  23 use Friendica\App;
  24 use Friendica\Core\System;
  25 use Friendica\Core\Cache;
  26 use Friendica\Core\Config;
  27 use Friendica\Core\PConfig;
  28 use Friendica\Core\Worker;
  29 use Friendica\Database\DBM;
  30 use Friendica\Model\Contact;
  31 use Friendica\Database\DBStructure;
  32
  33 require_once 'include/network.php';
  34 require_once 'include/plugin.php';
  35 require_once 'include/text.php';
  36 require_once 'include/datetime.php';
  37 require_once 'include/pgettext.php';
  38 require_once 'include/nav.php';
  39 require_once 'include/identity.php';
  40
  41 define('FRIENDICA_PLATFORM',     'Friendica');
  42 define('FRIENDICA_CODENAME',     'Asparagus');
  43 define('FRIENDICA_VERSION',      '3.6-dev');
  44 define('DFRN_PROTOCOL_VERSION',  '2.23');
  45 define('DB_UPDATE_VERSION',      1238);
  46 define('NEW_UPDATE_ROUTINE_VERSION', 1170);
  47
  48 /**
  49  * @brief Constants for the database update check
  50  */
  51 const DB_UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
  52 const DB_UPDATE_SUCCESSFUL = 1;  // Database check was successful
  53 const DB_UPDATE_FAILED = 2;      // Database check failed
  54
  55 /**
  56  * @brief Constant with a HTML line break.
  57  *
  58  * Contains a HTML line break (br) element and a real carriage return with line
  59  * feed for the source.
  60  * This can be used in HTML and JavaScript where needed a line break.
  61  */
  62 define('EOL',                    "<br />\r\n");
  63 define('ATOM_TIME',              'Y-m-d\TH:i:s\Z');
  64
  65 /**
  66  * @brief Image storage quality.
  67  *
  68  * Lower numbers save space at cost of image detail.
  69  * For ease of upgrade, please do not change here. Change jpeg quality with
  70  * $a->config['system']['jpeg_quality'] = n;
  71  * in .htconfig.php, where n is netween 1 and 100, and with very poor results
  72  * below about 50
  73  */
  74 define('JPEG_QUALITY',            100);
  75
  76 /**
  77  * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
  78  */
  79 define('PNG_QUALITY',             8);
  80
  81 /**
  82  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  83  * length that pictures are allowed to be (for non-square pictures, it will apply
  84  * to the longest side). Pictures longer than this length will be resized to be
  85  * this length (on the longest side, the other side will be scaled appropriately).
  86  * Modify this value using
  87  *
  88  *    $a->config['system']['max_image_length'] = n;
  89  *
  90  * in .htconfig.php
  91  *
  92  * If you don't want to set a maximum length, set to -1. The default value is
  93  * defined by 'MAX_IMAGE_LENGTH' below.
  94  */
  95 define('MAX_IMAGE_LENGTH',        -1);
  96
  97 /**
  98  * Not yet used
  99  */
 100 define('DEFAULT_DB_ENGINE',  'InnoDB');
 101
 102 /**
 103  * @name SSL Policy
 104  *
 105  * SSL redirection policies
 106  * @{
 107  */
 108 define('SSL_POLICY_NONE',         0);
 109 define('SSL_POLICY_FULL',         1);
 110 define('SSL_POLICY_SELFSIGN',     2);
 111 /* @}*/
 112
 113 /**
 114  * @name Logger
 115  *
 116  * log levels
 117  * @{
 118  */
 119 define('LOGGER_NORMAL',          0);
 120 define('LOGGER_TRACE',           1);
 121 define('LOGGER_DEBUG',           2);
 122 define('LOGGER_DATA',            3);
 123 define('LOGGER_ALL',             4);
 124 /* @}*/
 125
 126 /**
 127  * @name Cache
 128  *
 129  * Cache levels
 130  * @{
 131  */
 132 define('CACHE_MONTH',            0);
 133 define('CACHE_WEEK',             1);
 134 define('CACHE_DAY',              2);
 135 define('CACHE_HOUR',             3);
 136 define('CACHE_HALF_HOUR',        4);
 137 define('CACHE_QUARTER_HOUR',     5);
 138 define('CACHE_FIVE_MINUTES',     6);
 139 define('CACHE_MINUTE',           7);
 140 /* @}*/
 141
 142 /**
 143  * @name Register
 144  *
 145  * Registration policies
 146  * @{
 147  */
 148 define('REGISTER_CLOSED',        0);
 149 define('REGISTER_APPROVE',       1);
 150 define('REGISTER_OPEN',          2);
 151 /**
 152  * @}
 153 */
 154
 155 /**
 156  * @name Contact_is
 157  *
 158  * Relationship types
 159  * @{
 160  */
 161 define('CONTACT_IS_FOLLOWER', 1);
 162 define('CONTACT_IS_SHARING',  2);
 163 define('CONTACT_IS_FRIEND',   3);
 164 /**
 165  *  @}
 166  */
 167
 168 /**
 169  * @name Update
 170  *
 171  * DB update return values
 172  * @{
 173  */
 174 define('UPDATE_SUCCESS', 0);
 175 define('UPDATE_FAILED',  1);
 176 /**
 177  * @}
 178  */
 179
 180 /**
 181  * @name page/profile types
 182  *
 183  * PAGE_NORMAL is a typical personal profile account
 184  * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
 185  * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
 186  *      write access to wall and comments (no email and not included in page owner's ACL lists)
 187  * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
 188  *
 189  * @{
 190  */
 191 define('PAGE_NORMAL',            0);
 192 define('PAGE_SOAPBOX',           1);
 193 define('PAGE_COMMUNITY',         2);
 194 define('PAGE_FREELOVE',          3);
 195 define('PAGE_BLOG',              4);
 196 define('PAGE_PRVGROUP',          5);
 197 /**
 198  * @}
 199  */
 200
 201 /**
 202  * @name account types
 203  *
 204  * ACCOUNT_TYPE_PERSON - the account belongs to a person
 205  *      Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
 206  *
 207  * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
 208  *      Associated page type: PAGE_SOAPBOX
 209  *
 210  * ACCOUNT_TYPE_NEWS - the account is a news reflector
 211  *      Associated page type: PAGE_SOAPBOX
 212  *
 213  * ACCOUNT_TYPE_COMMUNITY - the account is community forum
 214  *      Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
 215  * @{
 216  */
 217 define('ACCOUNT_TYPE_PERSON',      0);
 218 define('ACCOUNT_TYPE_ORGANISATION', 1);
 219 define('ACCOUNT_TYPE_NEWS',        2);
 220 define('ACCOUNT_TYPE_COMMUNITY',   3);
 221 /**
 222  * @}
 223  */
 224
 225 /**
 226  * @name CP
 227  *
 228  * Type of the community page
 229  * @{
 230  */
 231 define('CP_NO_COMMUNITY_PAGE',   -1);
 232 define('CP_USERS_ON_SERVER',     0);
 233 define('CP_GLOBAL_COMMUNITY',    1);
 234 /**
 235  * @}
 236  */
 237
 238 /**
 239  * @name Protocols
 240  *
 241  * Different protocols that we are storing
 242  * @{
 243  */
 244 define('PROTOCOL_UNKNOWN',         0);
 245 define('PROTOCOL_DFRN',            1);
 246 define('PROTOCOL_DIASPORA',        2);
 247 define('PROTOCOL_OSTATUS_SALMON',  3);
 248 define('PROTOCOL_OSTATUS_FEED',    4); // Deprecated
 249 define('PROTOCOL_GS_CONVERSATION', 5); // Deprecated
 250 define('PROTOCOL_SPLITTED_CONV',   6);
 251 /**
 252  * @}
 253  */
 254
 255 /**
 256  * @name Network
 257  *
 258  * Network and protocol family types
 259  * @{
 260  */
 261 define('NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
 262 define('NETWORK_ZOT',              'zot!');    // Zot! - Currently unsupported
 263 define('NETWORK_OSTATUS',          'stat');    // GNU-social, Pleroma, Mastodon, other OStatus implementations
 264 define('NETWORK_FEED',             'feed');    // RSS/Atom feeds with no known "post/notify" protocol
 265 define('NETWORK_DIASPORA',         'dspr');    // Diaspora
 266 define('NETWORK_MAIL',             'mail');    // IMAP/POP
 267 define('NETWORK_FACEBOOK',         'face');    // Facebook API
 268 define('NETWORK_LINKEDIN',         'lnkd');    // LinkedIn
 269 define('NETWORK_XMPP',             'xmpp');    // XMPP - Currently unsupported
 270 define('NETWORK_MYSPACE',          'mysp');    // MySpace - Currently unsupported
 271 define('NETWORK_GPLUS',            'goog');    // Google+
 272 define('NETWORK_PUMPIO',           'pump');    // pump.io
 273 define('NETWORK_TWITTER',          'twit');    // Twitter
 274 define('NETWORK_DIASPORA2',        'dspc');    // Diaspora connector
 275 define('NETWORK_STATUSNET',        'stac');    // Statusnet connector
 276 define('NETWORK_APPNET',           'apdn');    // app.net - Dead protocol
 277 define('NETWORK_NEWS',             'nntp');    // Network News Transfer Protocol - Currently unsupported
 278 define('NETWORK_ICALENDAR',        'ical');    // iCalendar - Currently unsupported
 279 define('NETWORK_PNUT',             'pnut');    // pnut.io - Currently unsupported
 280 define('NETWORK_PHANTOM',          'unkn');    // Place holder
 281 /**
 282  * @}
 283  */
 284
 285 /**
 286  * These numbers are used in stored permissions
 287  * and existing allocations MUST NEVER BE CHANGED
 288  * OR RE-ASSIGNED! You may only add to them.
 289  */
 290 $netgroup_ids = array(
 291         NETWORK_DFRN     => (-1),
 292         NETWORK_ZOT      => (-2),
 293         NETWORK_OSTATUS  => (-3),
 294         NETWORK_FEED     => (-4),
 295         NETWORK_DIASPORA => (-5),
 296         NETWORK_MAIL     => (-6),
 297         NETWORK_FACEBOOK => (-8),
 298         NETWORK_LINKEDIN => (-9),
 299         NETWORK_XMPP     => (-10),
 300         NETWORK_MYSPACE  => (-11),
 301         NETWORK_GPLUS    => (-12),
 302         NETWORK_PUMPIO   => (-13),
 303         NETWORK_TWITTER  => (-14),
 304         NETWORK_DIASPORA2 => (-15),
 305         NETWORK_STATUSNET => (-16),
 306         NETWORK_APPNET    => (-17),
 307         NETWORK_NEWS      => (-18),
 308         NETWORK_ICALENDAR => (-19),
 309         NETWORK_PNUT      => (-20),
 310
 311         NETWORK_PHANTOM  => (-127),
 312 );
 313
 314 /**
 315  * Maximum number of "people who like (or don't like) this"  that we will list by name
 316  */
 317 define('MAX_LIKERS',    75);
 318
 319 /**
 320  * Communication timeout
 321  */
 322 define('ZCURL_TIMEOUT', (-1));
 323
 324 /**
 325  * @name Notify
 326  *
 327  * Email notification options
 328  * @{
 329  */
 330 define('NOTIFY_INTRO',    0x0001);
 331 define('NOTIFY_CONFIRM',  0x0002);
 332 define('NOTIFY_WALL',     0x0004);
 333 define('NOTIFY_COMMENT',  0x0008);
 334 define('NOTIFY_MAIL',     0x0010);
 335 define('NOTIFY_SUGGEST',  0x0020);
 336 define('NOTIFY_PROFILE',  0x0040);
 337 define('NOTIFY_TAGSELF',  0x0080);
 338 define('NOTIFY_TAGSHARE', 0x0100);
 339 define('NOTIFY_POKE',     0x0200);
 340 define('NOTIFY_SHARE',    0x0400);
 341
 342 define('SYSTEM_EMAIL',    0x4000);
 343
 344 define('NOTIFY_SYSTEM',   0x8000);
 345 /* @}*/
 346
 347
 348 /**
 349  * @name Term
 350  *
 351  * Tag/term types
 352  * @{
 353  */
 354 define('TERM_UNKNOWN',   0);
 355 define('TERM_HASHTAG',   1);
 356 define('TERM_MENTION',   2);
 357 define('TERM_CATEGORY',  3);
 358 define('TERM_PCATEGORY', 4);
 359 define('TERM_FILE',      5);
 360 define('TERM_SAVEDSEARCH', 6);
 361 define('TERM_CONVERSATION', 7);
 362
 363 define('TERM_OBJ_POST',  1);
 364 define('TERM_OBJ_PHOTO', 2);
 365
 366 /**
 367  * @name Namespaces
 368  *
 369  * Various namespaces we may need to parse
 370  * @{
 371  */
 372 define('NAMESPACE_ZOT',             'http://purl.org/zot');
 373 define('NAMESPACE_DFRN',            'http://purl.org/macgirvin/dfrn/1.0');
 374 define('NAMESPACE_THREAD',          'http://purl.org/syndication/thread/1.0');
 375 define('NAMESPACE_TOMB',            'http://purl.org/atompub/tombstones/1.0');
 376 define('NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/');
 377 define('NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/');
 378 define('NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia');
 379 define('NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env');
 380 define('NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe');
 381 define('NAMESPACE_GEORSS',          'http://www.georss.org/georss');
 382 define('NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0');
 383 define('NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from');
 384 define('NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0');
 385 define('NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/');
 386 define('NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom');
 387 define('NAMESPACE_MASTODON',        'http://mastodon.social/schema/1.0');
 388 /* @}*/
 389
 390 /**
 391  * @name Activity
 392  *
 393  * Activity stream defines
 394  * @{
 395  */
 396 define('ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like');
 397 define('ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike');
 398 define('ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes');
 399 define('ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno');
 400 define('ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe');
 401
 402 define('ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart');
 403
 404 define('ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend');
 405 define('ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend');
 406 define('ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend');
 407 define('ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow');
 408 define('ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following');
 409 define('ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join');
 410
 411 define('ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post');
 412 define('ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update');
 413 define('ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag');
 414 define('ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite');
 415 define('ACTIVITY_UNFAVORITE',  NAMESPACE_ACTIVITY_SCHEMA . 'unfavorite');
 416 define('ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share');
 417 define('ACTIVITY_DELETE',      NAMESPACE_ACTIVITY_SCHEMA . 'delete');
 418
 419 define('ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke');
 420
 421 define('ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark');
 422 define('ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment');
 423 define('ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note');
 424 define('ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person');
 425 define('ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image');
 426 define('ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo');
 427 define('ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video');
 428 define('ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo');
 429 define('ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album');
 430 define('ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event');
 431 define('ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group');
 432 define('ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm');
 433 define('ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile');
 434 define('ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question');
 435 /* @}*/
 436
 437 /**
 438  * @name Gravity
 439  *
 440  * Item weight for query ordering
 441  * @{
 442  */
 443 define('GRAVITY_PARENT',       0);
 444 define('GRAVITY_LIKE',         3);
 445 define('GRAVITY_COMMENT',      6);
 446 /* @}*/
 447
 448 /**
 449  * @name Priority
 450  *
 451  * Process priority for the worker
 452  * @{
 453  */
 454 define('PRIORITY_UNDEFINED',   0);
 455 define('PRIORITY_CRITICAL',   10);
 456 define('PRIORITY_HIGH',       20);
 457 define('PRIORITY_MEDIUM',     30);
 458 define('PRIORITY_LOW',        40);
 459 define('PRIORITY_NEGLIGIBLE', 50);
 460 /* @}*/
 461
 462 /**
 463  * @name Social Relay settings
 464  *
 465  * See here: https://github.com/jaywink/social-relay
 466  * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
 467  * @{
 468  */
 469 define('SR_SCOPE_NONE', '');
 470 define('SR_SCOPE_ALL',  'all');
 471 define('SR_SCOPE_TAGS', 'tags');
 472 /* @}*/
 473
 474 /**
 475  * Lowest possible date time value
 476  */
 477 define('NULL_DATE', '0001-01-01 00:00:00');
 478
 479 // Normally this constant is defined - but not if "pcntl" isn't installed
 480 if (!defined("SIGTERM")) {
 481         define("SIGTERM", 15);
 482 }
 483
 484 /**
 485  * Depending on the PHP version this constant does exist - or not.
 486  * See here: http://php.net/manual/en/curl.constants.php#117928
 487  */
 488 if (!defined('CURLE_OPERATION_TIMEDOUT')) {
 489         define('CURLE_OPERATION_TIMEDOUT', CURLE_OPERATION_TIMEOUTED);
 490 }
 491 /**
 492  * Reverse the effect of magic_quotes_gpc if it is enabled.
 493  * Please disable magic_quotes_gpc so we don't have to do this.
 494  * See http://php.net/manual/en/security.magicquotes.disabling.php
 495  */
 496 function startup()
 497 {
 498         error_reporting(E_ERROR | E_WARNING | E_PARSE);
 499
 500         set_time_limit(0);
 501
 502         // This has to be quite large to deal with embedded private photos
 503         ini_set('pcre.backtrack_limit', 500000);
 504
 505         if (get_magic_quotes_gpc()) {
 506                 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
 507                 while (list($key, $val) = each($process)) {
 508                         foreach ($val as $k => $v) {
 509                                 unset($process[$key][$k]);
 510                                 if (is_array($v)) {
 511                                         $process[$key][stripslashes($k)] = $v;
 512                                         $process[] = &$process[$key][stripslashes($k)];
 513                                 } else {
 514                                         $process[$key][stripslashes($k)] = stripslashes($v);
 515                                 }
 516                         }
 517                 }
 518                 unset($process);
 519         }
 520 }
 521
 522 /**
 523  * @brief Retrieve the App structure
 524  *
 525  * Useful in functions which require it but don't get it passed to them
 526  *
 527  * @return App
 528  */
 529 function get_app()
 530 {
 531         global $a;
 532
 533         if (empty($a)) {
 534                 $a = new App(dirname(__DIR__));
 535         }
 536
 537         return $a;
 538 }
 539
 540 /**
 541  * @brief Multi-purpose function to check variable state.
 542  *
 543  * Usage: x($var) or $x($array, 'key')
 544  *
 545  * returns false if variable/key is not set
 546  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
 547  * e.g. x('') or x(0) returns 0;
 548  *
 549  * @param string|array $s variable to check
 550  * @param string       $k key inside the array to check
 551  *
 552  * @return bool|int
 553  */
 554 function x($s, $k = null)
 555 {
 556         if ($k != null) {
 557                 if ((is_array($s)) && (array_key_exists($k, $s))) {
 558                         if ($s[$k]) {
 559                                 return (int) 1;
 560                         }
 561                         return (int) 0;
 562                 }
 563                 return false;
 564         } else {
 565                 if (isset($s)) {
 566                         if ($s) {
 567                                 return (int) 1;
 568                         }
 569                         return (int) 0;
 570                 }
 571                 return false;
 572         }
 573 }
 574
 575 /**
 576  * Return the provided variable value if it exists and is truthy or the provided
 577  * default value instead.
 578  *
 579  * Works with initialized variables and potentially uninitialized array keys
 580  *
 581  * Usages:
 582  * - defaults($var, $default)
 583  * - defaults($array, 'key', $default)
 584  *
 585  * @brief Returns a defaut value if the provided variable or array key is falsy
 586  * @see x()
 587  * @return mixed
 588  */
 589 function defaults() {
 590         $args = func_get_args();
 591
 592         if (count($args) < 2) {
 593                 throw new BadFunctionCallException('defaults() requires at least 2 parameters');
 594         }
 595         if (count($args) > 3) {
 596                 throw new BadFunctionCallException('defaults() cannot use more than 3 parameters');
 597         }
 598         if (count($args) === 3 && !is_array($args[0])) {
 599                 throw new BadFunctionCallException('defaults($arr, $key, $def) requires an array as first parameter');
 600         }
 601         if (count($args) === 3 && is_null($args[1])) {
 602                 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
 603         }
 604
 605         $default = array_pop($args);
 606
 607         if (call_user_func_array('x', $args)) {
 608                 if (count($args) === 1) {
 609                         $return = $args[0];
 610                 } else {
 611                         $return = $args[0][$args[1]];
 612                 }
 613         } else {
 614                 $return = $default;
 615         }
 616
 617         return $return;
 618 }
 619
 620 /**
 621  * @brief Returns the baseurl.
 622  *
 623  * @see System::baseUrl()
 624  *
 625  * @return string
 626  * @TODO Function is deprecated and only used in some addons
 627  */
 628 function z_root()
 629 {
 630         return System::baseUrl();
 631 }
 632
 633 /**
 634  * @brief Return absolut URL for given $path.
 635  *
 636  * @param string $path given path
 637  *
 638  * @return string
 639  */
 640 function absurl($path)
 641 {
 642         if (strpos($path, '/') === 0) {
 643                 return z_path() . $path;
 644         }
 645         return $path;
 646 }
 647
 648 /**
 649  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 650  *
 651  * @return boolean
 652  */
 653 function is_ajax()
 654 {
 655         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
 656 }
 657
 658 /**
 659  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 660  *
 661  * @param boolean $via_worker boolean Is the check run via the worker?
 662  */
 663 function check_db($via_worker)
 664 {
 665         $build = Config::get('system', 'build');
 666
 667         if (empty($build)) {
 668                 Config::set('system', 'build', DB_UPDATE_VERSION);
 669                 $build = DB_UPDATE_VERSION;
 670         }
 671
 672         // We don't support upgrading from very old versions anymore
 673         if ($build < NEW_UPDATE_ROUTINE_VERSION) {
 674                 die('You try to update from a version prior to database version 1170. The direct upgrade path is not supported. Please update to version 3.5.4 before updating to this version.');
 675         }
 676
 677         if ($build != DB_UPDATE_VERSION) {
 678                 // When we cannot execute the database update via the worker, we will do it directly
 679                 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
 680                         update_db(get_app());
 681                 }
 682         }
 683 }
 684
 685 /**
 686  * Sets the base url for use in cmdline programs which don't have
 687  * $_SERVER variables
 688  *
 689  * @param object $a App
 690  */
 691 function check_url(App $a)
 692 {
 693         $url = Config::get('system', 'url');
 694
 695         // if the url isn't set or the stored url is radically different
 696         // than the currently visited url, store the current value accordingly.
 697         // "Radically different" ignores common variations such as http vs https
 698         // and www.example.com vs example.com.
 699         // We will only change the url to an ip address if there is no existing setting
 700
 701         if (empty($url)) {
 702                 $url = Config::set('system', 'url', System::baseUrl());
 703         }
 704         if ((!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
 705                 $url = Config::set('system', 'url', System::baseUrl());
 706         }
 707
 708         return;
 709 }
 710
 711 /**
 712  * @brief Automatic database updates
 713  * @param object $a App
 714  */
 715 function update_db(App $a)
 716 {
 717         $build = Config::get('system', 'build');
 718
 719         if (empty($build)) {
 720                 Config::set('system', 'build', DB_UPDATE_VERSION);
 721                 $build = DB_UPDATE_VERSION;
 722         }
 723
 724         if ($build != DB_UPDATE_VERSION) {
 725                 require_once 'update.php';
 726
 727                 $stored = intval($build);
 728                 $current = intval(DB_UPDATE_VERSION);
 729                 if ($stored < $current) {
 730                         Config::load('database');
 731
 732                         // Compare the current structure with the defined structure
 733                         $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
 734                         if (!is_null($t)) {
 735                                 return;
 736                         }
 737
 738                         Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
 739
 740                         // run update routine
 741                         // it update the structure in one call
 742                         $retval = DBStructure::update(false, true);
 743                         if ($retval) {
 744                                 DBStructure::updateFail(
 745                                         DB_UPDATE_VERSION,
 746                                         $retval
 747                                 );
 748                                 return;
 749                         } else {
 750                                 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
 751                         }
 752
 753                         // run any left update_nnnn functions in update.php
 754                         for ($x = $stored + 1; $x <= $current; $x++) {
 755                                 $r = run_update_function($x);
 756                                 if (!$r) {
 757                                         break;
 758                                 }
 759                         }
 760                 }
 761         }
 762
 763         return;
 764 }
 765
 766 function run_update_function($x)
 767 {
 768         if (function_exists('update_' . $x)) {
 769                 // There could be a lot of processes running or about to run.
 770                 // We want exactly one process to run the update command.
 771                 // So store the fact that we're taking responsibility
 772                 // after first checking to see if somebody else already has.
 773                 // If the update fails or times-out completely you may need to
 774                 // delete the config entry to try again.
 775
 776                 $t = Config::get('database', 'update_' . $x);
 777                 if (!is_null($t)) {
 778                         return false;
 779                 }
 780                 Config::set('database', 'update_' . $x, time());
 781
 782                 // call the specific update
 783
 784                 $func = 'update_' . $x;
 785                 $retval = $func();
 786
 787                 if ($retval) {
 788                         //send the administrator an e-mail
 789                         DBStructure::updateFail(
 790                                 $x,
 791                                 sprintf(t('Update %s failed. See error logs.'), $x)
 792                         );
 793                         return false;
 794                 } else {
 795                         Config::set('database', 'update_' . $x, 'success');
 796                         Config::set('system', 'build', $x + 1);
 797                         return true;
 798                 }
 799         } else {
 800                 Config::set('database', 'update_' . $x, 'success');
 801                 Config::set('system', 'build', $x + 1);
 802                 return true;
 803         }
 804         return true;
 805 }
 806
 807 /**
 808  * @brief Synchronise plugins:
 809  *
 810  * $a->config['system']['addon'] contains a comma-separated list of names
 811  * of plugins/addons which are used on this system.
 812  * Go through the database list of already installed addons, and if we have
 813  * an entry, but it isn't in the config list, call the uninstall procedure
 814  * and mark it uninstalled in the database (for now we'll remove it).
 815  * Then go through the config list and if we have a plugin that isn't installed,
 816  * call the install procedure and add it to the database.
 817  *
 818  * @param object $a App
 819  */
 820 function check_plugins(App $a)
 821 {
 822         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
 823         if (DBM::is_result($r)) {
 824                 $installed = $r;
 825         } else {
 826                 $installed = array();
 827         }
 828
 829         $plugins = Config::get('system', 'addon');
 830         $plugins_arr = array();
 831
 832         if ($plugins) {
 833                 $plugins_arr = explode(',', str_replace(' ', '', $plugins));
 834         }
 835
 836         $a->plugins = $plugins_arr;
 837
 838         $installed_arr = array();
 839
 840         if (count($installed)) {
 841                 foreach ($installed as $i) {
 842                         if (!in_array($i['name'], $plugins_arr)) {
 843                                 uninstall_plugin($i['name']);
 844                         } else {
 845                                 $installed_arr[] = $i['name'];
 846                         }
 847                 }
 848         }
 849
 850         if (count($plugins_arr)) {
 851                 foreach ($plugins_arr as $p) {
 852                         if (!in_array($p, $installed_arr)) {
 853                                 install_plugin($p);
 854                         }
 855                 }
 856         }
 857
 858         load_hooks();
 859
 860         return;
 861 }
 862
 863 function get_guid($size = 16, $prefix = "")
 864 {
 865         if ($prefix == "") {
 866                 $a = get_app();
 867                 $prefix = hash("crc32", $a->get_hostname());
 868         }
 869
 870         while (strlen($prefix) < ($size - 13)) {
 871                 $prefix .= mt_rand();
 872         }
 873
 874         if ($size >= 24) {
 875                 $prefix = substr($prefix, 0, $size - 22);
 876                 return(str_replace(".", "", uniqid($prefix, true)));
 877         } else {
 878                 $prefix = substr($prefix, 0, max($size - 13, 0));
 879                 return(uniqid($prefix));
 880         }
 881 }
 882
 883 /**
 884  * @brief Wrapper for adding a login box.
 885  *
 886  * @param bool $register If $register == true provide a registration link.
 887  *                                               This will most always depend on the value of $a->config['register_policy'].
 888  * @param bool $hiddens  optional
 889  *
 890  * @return string Returns the complete html for inserting into the page
 891  *
 892  * @hooks 'login_hook'
 893  *      string $o
 894  */
 895 function login($register = false, $hiddens = false)
 896 {
 897         $a = get_app();
 898         $o = "";
 899         $reg = false;
 900         if ($register) {
 901                 $reg = array(
 902                         'title' => t('Create a New Account'),
 903                         'desc' => t('Register')
 904                 );
 905         }
 906
 907         $noid = Config::get('system', 'no_openid');
 908
 909         $dest_url = $a->query_string;
 910
 911         if (local_user()) {
 912                 $tpl = get_markup_template("logout.tpl");
 913         } else {
 914                 $a->page['htmlhead'] .= replace_macros(
 915                         get_markup_template("login_head.tpl"),
 916                         array(
 917                         '$baseurl' => $a->get_baseurl(true)
 918                         )
 919                 );
 920
 921                 $tpl = get_markup_template("login.tpl");
 922                 $_SESSION['return_url'] = $a->query_string;
 923                 $a->module = 'login';
 924         }
 925
 926         $o .= replace_macros(
 927                 $tpl,
 928                 array(
 929                 '$dest_url'     => $dest_url,
 930                 '$logout'       => t('Logout'),
 931                 '$login'        => t('Login'),
 932
 933                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
 934                 '$lpassword'    => array('password', t('Password: '), '', ''),
 935                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
 936
 937                 '$openid'       => !$noid,
 938                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
 939
 940                 '$hiddens'      => $hiddens,
 941
 942                 '$register'     => $reg,
 943
 944                 '$lostpass'     => t('Forgot your password?'),
 945                 '$lostlink'     => t('Password Reset'),
 946
 947                 '$tostitle'     => t('Website Terms of Service'),
 948                 '$toslink'      => t('terms of service'),
 949
 950                 '$privacytitle' => t('Website Privacy Policy'),
 951                 '$privacylink'  => t('privacy policy'),
 952                 )
 953         );
 954
 955         call_hooks('login_hook', $o);
 956
 957         return $o;
 958 }
 959
 960 /**
 961  * @brief Used to end the current process, after saving session state.
 962  */
 963 function killme()
 964 {
 965         if (!get_app()->is_backend()) {
 966                 session_write_close();
 967         }
 968
 969         exit();
 970 }
 971
 972 /**
 973  * @brief Redirect to another URL and terminate this process.
 974  */
 975 function goaway($s)
 976 {
 977         if (!strstr(normalise_link($s), "http://")) {
 978                 $s = System::baseUrl() . "/" . $s;
 979         }
 980
 981         header("Location: $s");
 982         killme();
 983 }
 984
 985 /**
 986  * @brief Returns the user id of locally logged in user or false.
 987  *
 988  * @return int|bool user id or false
 989  */
 990 function local_user()
 991 {
 992         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
 993                 return intval($_SESSION['uid']);
 994         }
 995         return false;
 996 }
 997
 998 /**
 999  * @brief Returns the public contact id of logged in user or false.
1000  *
1001  * @return int|bool public contact id or false
1002  */
1003 function public_contact()
1004 {
1005         static $public_contact_id = false;
1006
1007         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1008                 if (x($_SESSION, 'my_address')) {
1009                         // Local user
1010                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
1011                 } elseif (x($_SESSION, 'visitor_home')) {
1012                         // Remote user
1013                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
1014                 }
1015         } elseif (!x($_SESSION, 'authenticated')) {
1016                 $public_contact_id = false;
1017         }
1018
1019         return $public_contact_id;
1020 }
1021
1022 /**
1023  * @brief Returns contact id of authenticated site visitor or false
1024  *
1025  * @return int|bool visitor_id or false
1026  */
1027 function remote_user()
1028 {
1029         // You cannot be both local and remote
1030         if (local_user()) {
1031                 return false;
1032         }
1033         if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
1034                 return intval($_SESSION['visitor_id']);
1035         }
1036         return false;
1037 }
1038
1039 /**
1040  * @brief Show an error message to user.
1041  *
1042  * This function save text in session, to be shown to the user at next page load
1043  *
1044  * @param string $s - Text of notice
1045  */
1046 function notice($s)
1047 {
1048         $a = get_app();
1049         if (!x($_SESSION, 'sysmsg')) {
1050                 $_SESSION['sysmsg'] = array();
1051         }
1052         if ($a->interactive) {
1053                 $_SESSION['sysmsg'][] = $s;
1054         }
1055 }
1056
1057 /**
1058  * @brief Show an info message to user.
1059  *
1060  * This function save text in session, to be shown to the user at next page load
1061  *
1062  * @param string $s - Text of notice
1063  */
1064 function info($s)
1065 {
1066         $a = get_app();
1067
1068         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
1069                 return;
1070         }
1071
1072         if (!x($_SESSION, 'sysmsg_info')) {
1073                 $_SESSION['sysmsg_info'] = array();
1074         }
1075         if ($a->interactive) {
1076                 $_SESSION['sysmsg_info'][] = $s;
1077         }
1078 }
1079
1080 /**
1081  * @brief Wrapper around config to limit the text length of an incoming message
1082  *
1083  * @return int
1084  */
1085 function get_max_import_size()
1086 {
1087         $a = get_app();
1088         return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
1089 }
1090
1091
1092 function current_theme()
1093 {
1094         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1095
1096         $a = get_app();
1097
1098         $page_theme = null;
1099
1100         // Find the theme that belongs to the user whose stuff we are looking at
1101
1102         if ($a->profile_uid && ($a->profile_uid != local_user())) {
1103                 $r = q(
1104                         "select theme from user where uid = %d limit 1",
1105                         intval($a->profile_uid)
1106                 );
1107                 if (DBM::is_result($r)) {
1108                         $page_theme = $r[0]['theme'];
1109                 }
1110         }
1111
1112         // Allow folks to over-rule user themes and always use their own on their own site.
1113         // This works only if the user is on the same server
1114
1115         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1116                 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1117                         $page_theme = null;
1118                 }
1119         }
1120
1121 //              $mobile_detect = new Mobile_Detect();
1122 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1123         $is_mobile = $a->is_mobile || $a->is_tablet;
1124
1125         $standard_system_theme = Config::get('system', 'theme', '');
1126         $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1127
1128         if ($is_mobile) {
1129                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1130                         $system_theme = $standard_system_theme;
1131                         $theme_name = $standard_theme_name;
1132                 } else {
1133                         $system_theme = Config::get('system', 'mobile-theme', '');
1134                         if ($system_theme == '') {
1135                                 $system_theme = $standard_system_theme;
1136                         }
1137                         $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1138
1139                         if ($theme_name === '---') {
1140                                 // user has selected to have the mobile theme be the same as the normal one
1141                                 $system_theme = $standard_system_theme;
1142                                 $theme_name = $standard_theme_name;
1143
1144                                 if ($page_theme) {
1145                                         $theme_name = $page_theme;
1146                                 }
1147                         }
1148                 }
1149         } else {
1150                 $system_theme = $standard_system_theme;
1151                 $theme_name = $standard_theme_name;
1152
1153                 if ($page_theme) {
1154                         $theme_name = $page_theme;
1155                 }
1156         }
1157
1158         if ($theme_name
1159                 && (file_exists('view/theme/' . $theme_name . '/style.css')
1160                 || file_exists('view/theme/' . $theme_name . '/style.php'))
1161         ) {
1162                 return($theme_name);
1163         }
1164
1165         foreach ($app_base_themes as $t) {
1166                 if (file_exists('view/theme/' . $t . '/style.css')
1167                         || file_exists('view/theme/' . $t . '/style.php')
1168                 ) {
1169                         return($t);
1170                 }
1171         }
1172
1173         $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1174         if (count($fallback)) {
1175                 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1176         }
1177
1178         /// @TODO No final return statement?
1179 }
1180
1181 /**
1182  * @brief Return full URL to theme which is currently in effect.
1183  *
1184  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1185  *
1186  * @return string
1187  */
1188 function current_theme_url()
1189 {
1190         $a = get_app();
1191
1192         $t = current_theme();
1193
1194         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1195         if (file_exists('view/theme/' . $t . '/style.php')) {
1196                 return('view/theme/' . $t . '/style.pcss' . $opts);
1197         }
1198
1199         return('view/theme/' . $t . '/style.css');
1200 }
1201
1202 function feed_birthday($uid, $tz)
1203 {
1204         /**
1205          * Determine the next birthday, but only if the birthday is published
1206          * in the default profile. We _could_ also look for a private profile that the
1207          * recipient can see, but somebody could get mad at us if they start getting
1208          * public birthday greetings when they haven't made this info public.
1209          *
1210          * Assuming we are able to publish this info, we are then going to convert
1211          * the start time from the owner's timezone to UTC.
1212          *
1213          * This will potentially solve the problem found with some social networks
1214          * where birthdays are converted to the viewer's timezone and salutations from
1215          * elsewhere in the world show up on the wrong day. We will convert it to the
1216          * viewer's timezone also, but first we are going to convert it from the birthday
1217          * person's timezone to GMT - so the viewer may find the birthday starting at
1218          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1219          */
1220         $birthday = '';
1221
1222         if (!strlen($tz)) {
1223                 $tz = 'UTC';
1224         }
1225
1226         $p = q(
1227                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1228                 intval($uid)
1229         );
1230
1231         if (DBM::is_result($p)) {
1232                 $tmp_dob = substr($p[0]['dob'], 5);
1233                 if (intval($tmp_dob)) {
1234                         $y = datetime_convert($tz, $tz, 'now', 'Y');
1235                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1236                         $t_dob = strtotime($bd);
1237                         $now = strtotime(datetime_convert($tz, $tz, 'now'));
1238                         if ($t_dob < $now) {
1239                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1240                         }
1241                         $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1242                 }
1243         }
1244
1245         return $birthday;
1246 }
1247
1248 /**
1249  * @brief Check if current user has admin role.
1250  *
1251  * @return bool true if user is an admin
1252  */
1253 function is_site_admin()
1254 {
1255         $a = get_app();
1256
1257         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1258
1259         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1260         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1261                 return true;
1262         }
1263         return false;
1264 }
1265
1266 /**
1267  * @brief Returns querystring as string from a mapped array.
1268  *
1269  * @param array  $params mapped array with query parameters
1270  * @param string $name   of parameter, default null
1271  *
1272  * @return string
1273  */
1274 function build_querystring($params, $name = null)
1275 {
1276         $ret = "";
1277         foreach ($params as $key => $val) {
1278                 if (is_array($val)) {
1279                         /// @TODO maybe not compare against null, use is_null()
1280                         if ($name == null) {
1281                                 $ret .= build_querystring($val, $key);
1282                         } else {
1283                                 $ret .= build_querystring($val, $name . "[$key]");
1284                         }
1285                 } else {
1286                         $val = urlencode($val);
1287                         /// @TODO maybe not compare against null, use is_null()
1288                         if ($name != null) {
1289                                 /// @TODO two string concated, can be merged to one
1290                                 $ret .= $name . "[$key]" . "=$val&";
1291                         } else {
1292                                 $ret .= "$key=$val&";
1293                         }
1294                 }
1295         }
1296         return $ret;
1297 }
1298
1299 function explode_querystring($query)
1300 {
1301         $arg_st = strpos($query, '?');
1302         if ($arg_st !== false) {
1303                 $base = substr($query, 0, $arg_st);
1304                 $arg_st += 1;
1305         } else {
1306                 $base = '';
1307                 $arg_st = 0;
1308         }
1309
1310         $args = explode('&', substr($query, $arg_st));
1311         foreach ($args as $k => $arg) {
1312                 /// @TODO really compare type-safe here?
1313                 if ($arg === '') {
1314                         unset($args[$k]);
1315                 }
1316         }
1317         $args = array_values($args);
1318
1319         if (!$base) {
1320                 $base = $args[0];
1321                 unset($args[0]);
1322                 $args = array_values($args);
1323         }
1324
1325         return array(
1326                 'base' => $base,
1327                 'args' => $args,
1328         );
1329 }
1330
1331 /**
1332  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1333  *
1334  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1335  */
1336 function curPageURL()
1337 {
1338         $pageURL = 'http';
1339         if ($_SERVER["HTTPS"] == "on") {
1340                 $pageURL .= "s";
1341         }
1342
1343         $pageURL .= "://";
1344
1345         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1346                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1347         } else {
1348                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1349         }
1350         return $pageURL;
1351 }
1352
1353 function random_digits($digits)
1354 {
1355         $rn = '';
1356         for ($i = 0; $i < $digits; $i++) {
1357                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1358                 $rn .= rand(0, 9);
1359         }
1360         return $rn;
1361 }
1362
1363 function get_server()
1364 {
1365         $server = Config::get("system", "directory");
1366
1367         if ($server == "") {
1368                 $server = "http://dir.friendica.social";
1369         }
1370
1371         return($server);
1372 }
1373
1374 function get_temppath()
1375 {
1376         $a = get_app();
1377
1378         $temppath = Config::get("system", "temppath");
1379
1380         if (($temppath != "") && App::directory_usable($temppath)) {
1381                 // We have a temp path and it is usable
1382                 return App::realpath($temppath);
1383         }
1384
1385         // We don't have a working preconfigured temp path, so we take the system path.
1386         $temppath = sys_get_temp_dir();
1387
1388         // Check if it is usable
1389         if (($temppath != "") && App::directory_usable($temppath)) {
1390                 // Always store the real path, not the path through symlinks
1391                 $temppath = App::realpath($temppath);
1392
1393                 // To avoid any interferences with other systems we create our own directory
1394                 $new_temppath = $temppath . "/" . $a->get_hostname();
1395                 if (!is_dir($new_temppath)) {
1396                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1397                         mkdir($new_temppath);
1398                 }
1399
1400                 if (App::directory_usable($new_temppath)) {
1401                         // The new path is usable, we are happy
1402                         Config::set("system", "temppath", $new_temppath);
1403                         return $new_temppath;
1404                 } else {
1405                         // We can't create a subdirectory, strange.
1406                         // But the directory seems to work, so we use it but don't store it.
1407                         return $temppath;
1408                 }
1409         }
1410
1411         // Reaching this point means that the operating system is configured badly.
1412         return '';
1413 }
1414
1415 function get_cachefile($file, $writemode = true)
1416 {
1417         $cache = get_itemcachepath();
1418
1419         if ((!$cache) || (!is_dir($cache))) {
1420                 return("");
1421         }
1422
1423         $subfolder = $cache . "/" . substr($file, 0, 2);
1424
1425         $cachepath = $subfolder . "/" . $file;
1426
1427         if ($writemode) {
1428                 if (!is_dir($subfolder)) {
1429                         mkdir($subfolder);
1430                         chmod($subfolder, 0777);
1431                 }
1432         }
1433
1434         /// @TODO no need to put braces here
1435         return $cachepath;
1436 }
1437
1438 function clear_cache($basepath = "", $path = "")
1439 {
1440         if ($path == "") {
1441                 $basepath = get_itemcachepath();
1442                 $path = $basepath;
1443         }
1444
1445         if (($path == "") || (!is_dir($path))) {
1446                 return;
1447         }
1448
1449         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1450                 return;
1451         }
1452
1453         $cachetime = (int) Config::get('system', 'itemcache_duration');
1454         if ($cachetime == 0) {
1455                 $cachetime = 86400;
1456         }
1457
1458         if (is_writable($path)) {
1459                 if ($dh = opendir($path)) {
1460                         while (($file = readdir($dh)) !== false) {
1461                                 $fullpath = $path . "/" . $file;
1462                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1463                                         clear_cache($basepath, $fullpath);
1464                                 }
1465                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1466                                         unlink($fullpath);
1467                                 }
1468                         }
1469                         closedir($dh);
1470                 }
1471         }
1472 }
1473
1474 function get_itemcachepath()
1475 {
1476         // Checking, if the cache is deactivated
1477         $cachetime = (int) Config::get('system', 'itemcache_duration');
1478         if ($cachetime < 0) {
1479                 return "";
1480         }
1481
1482         $itemcache = Config::get('system', 'itemcache');
1483         if (($itemcache != "") && App::directory_usable($itemcache)) {
1484                 return App::realpath($itemcache);
1485         }
1486
1487         $temppath = get_temppath();
1488
1489         if ($temppath != "") {
1490                 $itemcache = $temppath . "/itemcache";
1491                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1492                         mkdir($itemcache);
1493                 }
1494
1495                 if (App::directory_usable($itemcache)) {
1496                         Config::set("system", "itemcache", $itemcache);
1497                         return $itemcache;
1498                 }
1499         }
1500         return "";
1501 }
1502
1503 /**
1504  * @brief Returns the path where spool files are stored
1505  *
1506  * @return string Spool path
1507  */
1508 function get_spoolpath()
1509 {
1510         $spoolpath = Config::get('system', 'spoolpath');
1511         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1512                 // We have a spool path and it is usable
1513                 return $spoolpath;
1514         }
1515
1516         // We don't have a working preconfigured spool path, so we take the temp path.
1517         $temppath = get_temppath();
1518
1519         if ($temppath != "") {
1520                 // To avoid any interferences with other systems we create our own directory
1521                 $spoolpath = $temppath . "/spool";
1522                 if (!is_dir($spoolpath)) {
1523                         mkdir($spoolpath);
1524                 }
1525
1526                 if (App::directory_usable($spoolpath)) {
1527                         // The new path is usable, we are happy
1528                         Config::set("system", "spoolpath", $spoolpath);
1529                         return $spoolpath;
1530                 } else {
1531                         // We can't create a subdirectory, strange.
1532                         // But the directory seems to work, so we use it but don't store it.
1533                         return $temppath;
1534                 }
1535         }
1536
1537         // Reaching this point means that the operating system is configured badly.
1538         return "";
1539 }
1540
1541
1542 if (!function_exists('exif_imagetype')) {
1543         function exif_imagetype($file)
1544         {
1545                 $size = getimagesize($file);
1546                 return $size[2];
1547         }
1548 }
1549
1550 function validate_include(&$file)
1551 {
1552         $orig_file = $file;
1553
1554         $file = realpath($file);
1555
1556         if (strpos($file, getcwd()) !== 0) {
1557                 return false;
1558         }
1559
1560         $file = str_replace(getcwd() . "/", "", $file, $count);
1561         if ($count != 1) {
1562                 return false;
1563         }
1564
1565         if ($orig_file !== $file) {
1566                 return false;
1567         }
1568
1569         $valid = false;
1570         if (strpos($file, "include/") === 0) {
1571                 $valid = true;
1572         }
1573
1574         if (strpos($file, "addon/") === 0) {
1575                 $valid = true;
1576         }
1577
1578         // Simply return flag
1579         return ($valid);
1580 }
1581
1582 function current_load()
1583 {
1584         if (!function_exists('sys_getloadavg')) {
1585                 return false;
1586         }
1587
1588         $load_arr = sys_getloadavg();
1589
1590         if (!is_array($load_arr)) {
1591                 return false;
1592         }
1593
1594         return max($load_arr[0], $load_arr[1]);
1595 }
1596
1597 /**
1598  * @brief get c-style args
1599  *
1600  * @return int
1601  */
1602 function argc()
1603 {
1604         return get_app()->argc;
1605 }
1606
1607 /**
1608  * @brief Returns the value of a argv key
1609  *
1610  * @param int $x argv key
1611  * @return string Value of the argv key
1612  */
1613 function argv($x)
1614 {
1615         if (array_key_exists($x, get_app()->argv)) {
1616                 return get_app()->argv[$x];
1617         }
1618
1619         return '';
1620 }
1621
1622 /**
1623  * @brief Get the data which is needed for infinite scroll
1624  *
1625  * For invinite scroll we need the page number of the actual page
1626  * and the the URI where the content of the next page comes from.
1627  * This data is needed for the js part in main.js.
1628  * Note: infinite scroll does only work for the network page (module)
1629  *
1630  * @param string $module The name of the module (e.g. "network")
1631  * @return array Of infinite scroll data
1632  *      'pageno' => $pageno The number of the actual page
1633  *      'reload_uri' => $reload_uri The URI of the content we have to load
1634  */
1635 function infinite_scroll_data($module)
1636 {
1637         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1638                 && ($module == "network") && ($_GET["mode"] != "minimal")
1639         ) {
1640                 // get the page number
1641                 if (is_string($_GET["page"])) {
1642                         $pageno = $_GET["page"];
1643                 } else {
1644                         $pageno = 1;
1645                 }
1646
1647                 $reload_uri = "";
1648
1649                 // try to get the uri from which we load the content
1650                 foreach ($_GET as $param => $value) {
1651                         if (($param != "page") && ($param != "q")) {
1652                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1653                         }
1654                 }
1655
1656                 if (($a->page_offset != "") && ! strstr($reload_uri, "&offset=")) {
1657                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1658                 }
1659
1660                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
1661
1662                 return $arr;
1663         }
1664 }