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_null($args[1])) {
 599                 throw new BadFunctionCallException('defaults($arr, $key, $def) $key is null');
 600         }
 601
 602         $default = array_pop($args);
 603
 604         if (call_user_func_array('x', $args)) {
 605                 if (count($args) === 1) {
 606                         $return = $args[0];
 607                 } else {
 608                         $return = $args[0][$args[1]];
 609                 }
 610         } else {
 611                 $return = $default;
 612         }
 613
 614         return $return;
 615 }
 616
 617 /**
 618  * @brief Returns the baseurl.
 619  *
 620  * @see System::baseUrl()
 621  *
 622  * @return string
 623  * @TODO Function is deprecated and only used in some addons
 624  */
 625 function z_root()
 626 {
 627         return System::baseUrl();
 628 }
 629
 630 /**
 631  * @brief Return absolut URL for given $path.
 632  *
 633  * @param string $path given path
 634  *
 635  * @return string
 636  */
 637 function absurl($path)
 638 {
 639         if (strpos($path, '/') === 0) {
 640                 return z_path() . $path;
 641         }
 642         return $path;
 643 }
 644
 645 /**
 646  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 647  *
 648  * @return boolean
 649  */
 650 function is_ajax()
 651 {
 652         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
 653 }
 654
 655 /**
 656  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
 657  *
 658  * @param boolean $via_worker boolean Is the check run via the worker?
 659  */
 660 function check_db($via_worker)
 661 {
 662         $build = Config::get('system', 'build');
 663
 664         if (empty($build)) {
 665                 Config::set('system', 'build', DB_UPDATE_VERSION);
 666                 $build = DB_UPDATE_VERSION;
 667         }
 668
 669         // We don't support upgrading from very old versions anymore
 670         if ($build < NEW_UPDATE_ROUTINE_VERSION) {
 671                 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.');
 672         }
 673
 674         if ($build != DB_UPDATE_VERSION) {
 675                 // When we cannot execute the database update via the worker, we will do it directly
 676                 if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) {
 677                         update_db(get_app());
 678                 }
 679         }
 680 }
 681
 682 /**
 683  * Sets the base url for use in cmdline programs which don't have
 684  * $_SERVER variables
 685  *
 686  * @param object $a App
 687  */
 688 function check_url(App $a)
 689 {
 690         $url = Config::get('system', 'url');
 691
 692         // if the url isn't set or the stored url is radically different
 693         // than the currently visited url, store the current value accordingly.
 694         // "Radically different" ignores common variations such as http vs https
 695         // and www.example.com vs example.com.
 696         // We will only change the url to an ip address if there is no existing setting
 697
 698         if (empty($url)) {
 699                 $url = Config::set('system', 'url', System::baseUrl());
 700         }
 701         if ((!link_compare($url, System::baseUrl())) && (!preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/", $a->get_hostname))) {
 702                 $url = Config::set('system', 'url', System::baseUrl());
 703         }
 704
 705         return;
 706 }
 707
 708 /**
 709  * @brief Automatic database updates
 710  * @param object $a App
 711  */
 712 function update_db(App $a)
 713 {
 714         $build = Config::get('system', 'build');
 715
 716         if (empty($build)) {
 717                 Config::set('system', 'build', DB_UPDATE_VERSION);
 718                 $build = DB_UPDATE_VERSION;
 719         }
 720
 721         if ($build != DB_UPDATE_VERSION) {
 722                 require_once 'update.php';
 723
 724                 $stored = intval($build);
 725                 $current = intval(DB_UPDATE_VERSION);
 726                 if ($stored < $current) {
 727                         Config::load('database');
 728
 729                         // Compare the current structure with the defined structure
 730                         $t = Config::get('database', 'dbupdate_' . DB_UPDATE_VERSION);
 731                         if (!is_null($t)) {
 732                                 return;
 733                         }
 734
 735                         Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, time());
 736
 737                         // run update routine
 738                         // it update the structure in one call
 739                         $retval = DBStructure::update(false, true);
 740                         if ($retval) {
 741                                 DBStructure::updateFail(
 742                                         DB_UPDATE_VERSION,
 743                                         $retval
 744                                 );
 745                                 return;
 746                         } else {
 747                                 Config::set('database', 'dbupdate_' . DB_UPDATE_VERSION, 'success');
 748                         }
 749
 750                         // run any left update_nnnn functions in update.php
 751                         for ($x = $stored + 1; $x <= $current; $x++) {
 752                                 $r = run_update_function($x);
 753                                 if (!$r) {
 754                                         break;
 755                                 }
 756                         }
 757                 }
 758         }
 759
 760         return;
 761 }
 762
 763 function run_update_function($x)
 764 {
 765         if (function_exists('update_' . $x)) {
 766                 // There could be a lot of processes running or about to run.
 767                 // We want exactly one process to run the update command.
 768                 // So store the fact that we're taking responsibility
 769                 // after first checking to see if somebody else already has.
 770                 // If the update fails or times-out completely you may need to
 771                 // delete the config entry to try again.
 772
 773                 $t = Config::get('database', 'update_' . $x);
 774                 if (!is_null($t)) {
 775                         return false;
 776                 }
 777                 Config::set('database', 'update_' . $x, time());
 778
 779                 // call the specific update
 780
 781                 $func = 'update_' . $x;
 782                 $retval = $func();
 783
 784                 if ($retval) {
 785                         //send the administrator an e-mail
 786                         DBStructure::updateFail(
 787                                 $x,
 788                                 sprintf(t('Update %s failed. See error logs.'), $x)
 789                         );
 790                         return false;
 791                 } else {
 792                         Config::set('database', 'update_' . $x, 'success');
 793                         Config::set('system', 'build', $x + 1);
 794                         return true;
 795                 }
 796         } else {
 797                 Config::set('database', 'update_' . $x, 'success');
 798                 Config::set('system', 'build', $x + 1);
 799                 return true;
 800         }
 801         return true;
 802 }
 803
 804 /**
 805  * @brief Synchronise plugins:
 806  *
 807  * $a->config['system']['addon'] contains a comma-separated list of names
 808  * of plugins/addons which are used on this system.
 809  * Go through the database list of already installed addons, and if we have
 810  * an entry, but it isn't in the config list, call the uninstall procedure
 811  * and mark it uninstalled in the database (for now we'll remove it).
 812  * Then go through the config list and if we have a plugin that isn't installed,
 813  * call the install procedure and add it to the database.
 814  *
 815  * @param object $a App
 816  */
 817 function check_plugins(App $a)
 818 {
 819         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
 820         if (DBM::is_result($r)) {
 821                 $installed = $r;
 822         } else {
 823                 $installed = array();
 824         }
 825
 826         $plugins = Config::get('system', 'addon');
 827         $plugins_arr = array();
 828
 829         if ($plugins) {
 830                 $plugins_arr = explode(',', str_replace(' ', '', $plugins));
 831         }
 832
 833         $a->plugins = $plugins_arr;
 834
 835         $installed_arr = array();
 836
 837         if (count($installed)) {
 838                 foreach ($installed as $i) {
 839                         if (!in_array($i['name'], $plugins_arr)) {
 840                                 uninstall_plugin($i['name']);
 841                         } else {
 842                                 $installed_arr[] = $i['name'];
 843                         }
 844                 }
 845         }
 846
 847         if (count($plugins_arr)) {
 848                 foreach ($plugins_arr as $p) {
 849                         if (!in_array($p, $installed_arr)) {
 850                                 install_plugin($p);
 851                         }
 852                 }
 853         }
 854
 855         load_hooks();
 856
 857         return;
 858 }
 859
 860 function get_guid($size = 16, $prefix = "")
 861 {
 862         if ($prefix == "") {
 863                 $a = get_app();
 864                 $prefix = hash("crc32", $a->get_hostname());
 865         }
 866
 867         while (strlen($prefix) < ($size - 13)) {
 868                 $prefix .= mt_rand();
 869         }
 870
 871         if ($size >= 24) {
 872                 $prefix = substr($prefix, 0, $size - 22);
 873                 return(str_replace(".", "", uniqid($prefix, true)));
 874         } else {
 875                 $prefix = substr($prefix, 0, max($size - 13, 0));
 876                 return(uniqid($prefix));
 877         }
 878 }
 879
 880 /**
 881  * @brief Wrapper for adding a login box.
 882  *
 883  * @param bool $register If $register == true provide a registration link.
 884  *                                               This will most always depend on the value of $a->config['register_policy'].
 885  * @param bool $hiddens  optional
 886  *
 887  * @return string Returns the complete html for inserting into the page
 888  *
 889  * @hooks 'login_hook'
 890  *      string $o
 891  */
 892 function login($register = false, $hiddens = false)
 893 {
 894         $a = get_app();
 895         $o = "";
 896         $reg = false;
 897         if ($register) {
 898                 $reg = array(
 899                         'title' => t('Create a New Account'),
 900                         'desc' => t('Register')
 901                 );
 902         }
 903
 904         $noid = Config::get('system', 'no_openid');
 905
 906         $dest_url = $a->query_string;
 907
 908         if (local_user()) {
 909                 $tpl = get_markup_template("logout.tpl");
 910         } else {
 911                 $a->page['htmlhead'] .= replace_macros(
 912                         get_markup_template("login_head.tpl"),
 913                         array(
 914                         '$baseurl' => $a->get_baseurl(true)
 915                         )
 916                 );
 917
 918                 $tpl = get_markup_template("login.tpl");
 919                 $_SESSION['return_url'] = $a->query_string;
 920                 $a->module = 'login';
 921         }
 922
 923         $o .= replace_macros(
 924                 $tpl,
 925                 array(
 926                 '$dest_url'     => $dest_url,
 927                 '$logout'       => t('Logout'),
 928                 '$login'        => t('Login'),
 929
 930                 '$lname'        => array('username', t('Nickname or Email: ') , '', ''),
 931                 '$lpassword'    => array('password', t('Password: '), '', ''),
 932                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
 933
 934                 '$openid'       => !$noid,
 935                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
 936
 937                 '$hiddens'      => $hiddens,
 938
 939                 '$register'     => $reg,
 940
 941                 '$lostpass'     => t('Forgot your password?'),
 942                 '$lostlink'     => t('Password Reset'),
 943
 944                 '$tostitle'     => t('Website Terms of Service'),
 945                 '$toslink'      => t('terms of service'),
 946
 947                 '$privacytitle' => t('Website Privacy Policy'),
 948                 '$privacylink'  => t('privacy policy'),
 949                 )
 950         );
 951
 952         call_hooks('login_hook', $o);
 953
 954         return $o;
 955 }
 956
 957 /**
 958  * @brief Used to end the current process, after saving session state.
 959  */
 960 function killme()
 961 {
 962         if (!get_app()->is_backend()) {
 963                 session_write_close();
 964         }
 965
 966         exit();
 967 }
 968
 969 /**
 970  * @brief Redirect to another URL and terminate this process.
 971  */
 972 function goaway($s)
 973 {
 974         if (!strstr(normalise_link($s), "http://")) {
 975                 $s = System::baseUrl() . "/" . $s;
 976         }
 977
 978         header("Location: $s");
 979         killme();
 980 }
 981
 982 /**
 983  * @brief Returns the user id of locally logged in user or false.
 984  *
 985  * @return int|bool user id or false
 986  */
 987 function local_user()
 988 {
 989         if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
 990                 return intval($_SESSION['uid']);
 991         }
 992         return false;
 993 }
 994
 995 /**
 996  * @brief Returns the public contact id of logged in user or false.
 997  *
 998  * @return int|bool public contact id or false
 999  */
1000 function public_contact()
1001 {
1002         static $public_contact_id = false;
1003
1004         if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1005                 if (x($_SESSION, 'my_address')) {
1006                         // Local user
1007                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['my_address'], 0));
1008                 } elseif (x($_SESSION, 'visitor_home')) {
1009                         // Remote user
1010                         $public_contact_id = intval(Contact::getIdForURL($_SESSION['visitor_home'], 0));
1011                 }
1012         } elseif (!x($_SESSION, 'authenticated')) {
1013                 $public_contact_id = false;
1014         }
1015
1016         return $public_contact_id;
1017 }
1018
1019 /**
1020  * @brief Returns contact id of authenticated site visitor or false
1021  *
1022  * @return int|bool visitor_id or false
1023  */
1024 function remote_user()
1025 {
1026         // You cannot be both local and remote
1027         if (local_user()) {
1028                 return false;
1029         }
1030         if (x($_SESSION, 'authenticated') && x($_SESSION, 'visitor_id')) {
1031                 return intval($_SESSION['visitor_id']);
1032         }
1033         return false;
1034 }
1035
1036 /**
1037  * @brief Show an error message to user.
1038  *
1039  * This function save text in session, to be shown to the user at next page load
1040  *
1041  * @param string $s - Text of notice
1042  */
1043 function notice($s)
1044 {
1045         $a = get_app();
1046         if (!x($_SESSION, 'sysmsg')) {
1047                 $_SESSION['sysmsg'] = array();
1048         }
1049         if ($a->interactive) {
1050                 $_SESSION['sysmsg'][] = $s;
1051         }
1052 }
1053
1054 /**
1055  * @brief Show an info message to user.
1056  *
1057  * This function save text in session, to be shown to the user at next page load
1058  *
1059  * @param string $s - Text of notice
1060  */
1061 function info($s)
1062 {
1063         $a = get_app();
1064
1065         if (local_user() && PConfig::get(local_user(), 'system', 'ignore_info')) {
1066                 return;
1067         }
1068
1069         if (!x($_SESSION, 'sysmsg_info')) {
1070                 $_SESSION['sysmsg_info'] = array();
1071         }
1072         if ($a->interactive) {
1073                 $_SESSION['sysmsg_info'][] = $s;
1074         }
1075 }
1076
1077 /**
1078  * @brief Wrapper around config to limit the text length of an incoming message
1079  *
1080  * @return int
1081  */
1082 function get_max_import_size()
1083 {
1084         $a = get_app();
1085         return (x($a->config, 'max_import_size') ? $a->config['max_import_size'] : 0);
1086 }
1087
1088
1089 function current_theme()
1090 {
1091         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1092
1093         $a = get_app();
1094
1095         $page_theme = null;
1096
1097         // Find the theme that belongs to the user whose stuff we are looking at
1098
1099         if ($a->profile_uid && ($a->profile_uid != local_user())) {
1100                 $r = q(
1101                         "select theme from user where uid = %d limit 1",
1102                         intval($a->profile_uid)
1103                 );
1104                 if (DBM::is_result($r)) {
1105                         $page_theme = $r[0]['theme'];
1106                 }
1107         }
1108
1109         // Allow folks to over-rule user themes and always use their own on their own site.
1110         // This works only if the user is on the same server
1111
1112         if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1113                 if (PConfig::get(local_user(), 'system', 'always_my_theme')) {
1114                         $page_theme = null;
1115                 }
1116         }
1117
1118 //              $mobile_detect = new Mobile_Detect();
1119 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1120         $is_mobile = $a->is_mobile || $a->is_tablet;
1121
1122         $standard_system_theme = Config::get('system', 'theme', '');
1123         $standard_theme_name = ((isset($_SESSION) && x($_SESSION, 'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1124
1125         if ($is_mobile) {
1126                 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1127                         $system_theme = $standard_system_theme;
1128                         $theme_name = $standard_theme_name;
1129                 } else {
1130                         $system_theme = Config::get('system', 'mobile-theme', '');
1131                         if ($system_theme == '') {
1132                                 $system_theme = $standard_system_theme;
1133                         }
1134                         $theme_name = ((isset($_SESSION) && x($_SESSION, 'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1135
1136                         if ($theme_name === '---') {
1137                                 // user has selected to have the mobile theme be the same as the normal one
1138                                 $system_theme = $standard_system_theme;
1139                                 $theme_name = $standard_theme_name;
1140
1141                                 if ($page_theme) {
1142                                         $theme_name = $page_theme;
1143                                 }
1144                         }
1145                 }
1146         } else {
1147                 $system_theme = $standard_system_theme;
1148                 $theme_name = $standard_theme_name;
1149
1150                 if ($page_theme) {
1151                         $theme_name = $page_theme;
1152                 }
1153         }
1154
1155         if ($theme_name
1156                 && (file_exists('view/theme/' . $theme_name . '/style.css')
1157                 || file_exists('view/theme/' . $theme_name . '/style.php'))
1158         ) {
1159                 return($theme_name);
1160         }
1161
1162         foreach ($app_base_themes as $t) {
1163                 if (file_exists('view/theme/' . $t . '/style.css')
1164                         || file_exists('view/theme/' . $t . '/style.php')
1165                 ) {
1166                         return($t);
1167                 }
1168         }
1169
1170         $fallback = array_merge(glob('view/theme/*/style.css'), glob('view/theme/*/style.php'));
1171         if (count($fallback)) {
1172                 return (str_replace('view/theme/', '', substr($fallback[0], 0, -10)));
1173         }
1174
1175         /// @TODO No final return statement?
1176 }
1177
1178 /**
1179  * @brief Return full URL to theme which is currently in effect.
1180  *
1181  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1182  *
1183  * @return string
1184  */
1185 function current_theme_url()
1186 {
1187         $a = get_app();
1188
1189         $t = current_theme();
1190
1191         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1192         if (file_exists('view/theme/' . $t . '/style.php')) {
1193                 return('view/theme/' . $t . '/style.pcss' . $opts);
1194         }
1195
1196         return('view/theme/' . $t . '/style.css');
1197 }
1198
1199 function feed_birthday($uid, $tz)
1200 {
1201         /**
1202          * Determine the next birthday, but only if the birthday is published
1203          * in the default profile. We _could_ also look for a private profile that the
1204          * recipient can see, but somebody could get mad at us if they start getting
1205          * public birthday greetings when they haven't made this info public.
1206          *
1207          * Assuming we are able to publish this info, we are then going to convert
1208          * the start time from the owner's timezone to UTC.
1209          *
1210          * This will potentially solve the problem found with some social networks
1211          * where birthdays are converted to the viewer's timezone and salutations from
1212          * elsewhere in the world show up on the wrong day. We will convert it to the
1213          * viewer's timezone also, but first we are going to convert it from the birthday
1214          * person's timezone to GMT - so the viewer may find the birthday starting at
1215          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1216          */
1217         $birthday = '';
1218
1219         if (!strlen($tz)) {
1220                 $tz = 'UTC';
1221         }
1222
1223         $p = q(
1224                 "SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1225                 intval($uid)
1226         );
1227
1228         if (DBM::is_result($p)) {
1229                 $tmp_dob = substr($p[0]['dob'], 5);
1230                 if (intval($tmp_dob)) {
1231                         $y = datetime_convert($tz, $tz, 'now', 'Y');
1232                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1233                         $t_dob = strtotime($bd);
1234                         $now = strtotime(datetime_convert($tz, $tz, 'now'));
1235                         if ($t_dob < $now) {
1236                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1237                         }
1238                         $birthday = datetime_convert($tz, 'UTC', $bd, ATOM_TIME);
1239                 }
1240         }
1241
1242         return $birthday;
1243 }
1244
1245 /**
1246  * @brief Check if current user has admin role.
1247  *
1248  * @return bool true if user is an admin
1249  */
1250 function is_site_admin()
1251 {
1252         $a = get_app();
1253
1254         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1255
1256         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1257         if (local_user() && x($a->user, 'email') && x($a->config, 'admin_email') && in_array($a->user['email'], $adminlist)) {
1258                 return true;
1259         }
1260         return false;
1261 }
1262
1263 /**
1264  * @brief Returns querystring as string from a mapped array.
1265  *
1266  * @param array  $params mapped array with query parameters
1267  * @param string $name   of parameter, default null
1268  *
1269  * @return string
1270  */
1271 function build_querystring($params, $name = null)
1272 {
1273         $ret = "";
1274         foreach ($params as $key => $val) {
1275                 if (is_array($val)) {
1276                         /// @TODO maybe not compare against null, use is_null()
1277                         if ($name == null) {
1278                                 $ret .= build_querystring($val, $key);
1279                         } else {
1280                                 $ret .= build_querystring($val, $name . "[$key]");
1281                         }
1282                 } else {
1283                         $val = urlencode($val);
1284                         /// @TODO maybe not compare against null, use is_null()
1285                         if ($name != null) {
1286                                 /// @TODO two string concated, can be merged to one
1287                                 $ret .= $name . "[$key]" . "=$val&";
1288                         } else {
1289                                 $ret .= "$key=$val&";
1290                         }
1291                 }
1292         }
1293         return $ret;
1294 }
1295
1296 function explode_querystring($query)
1297 {
1298         $arg_st = strpos($query, '?');
1299         if ($arg_st !== false) {
1300                 $base = substr($query, 0, $arg_st);
1301                 $arg_st += 1;
1302         } else {
1303                 $base = '';
1304                 $arg_st = 0;
1305         }
1306
1307         $args = explode('&', substr($query, $arg_st));
1308         foreach ($args as $k => $arg) {
1309                 /// @TODO really compare type-safe here?
1310                 if ($arg === '') {
1311                         unset($args[$k]);
1312                 }
1313         }
1314         $args = array_values($args);
1315
1316         if (!$base) {
1317                 $base = $args[0];
1318                 unset($args[0]);
1319                 $args = array_values($args);
1320         }
1321
1322         return array(
1323                 'base' => $base,
1324                 'args' => $args,
1325         );
1326 }
1327
1328 /**
1329  * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1330  *
1331  * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1332  */
1333 function curPageURL()
1334 {
1335         $pageURL = 'http';
1336         if ($_SERVER["HTTPS"] == "on") {
1337                 $pageURL .= "s";
1338         }
1339
1340         $pageURL .= "://";
1341
1342         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1343                 $pageURL .= $_SERVER["SERVER_NAME"] . ":" . $_SERVER["SERVER_PORT"] . $_SERVER["REQUEST_URI"];
1344         } else {
1345                 $pageURL .= $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"];
1346         }
1347         return $pageURL;
1348 }
1349
1350 function random_digits($digits)
1351 {
1352         $rn = '';
1353         for ($i = 0; $i < $digits; $i++) {
1354                 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
1355                 $rn .= rand(0, 9);
1356         }
1357         return $rn;
1358 }
1359
1360 function get_server()
1361 {
1362         $server = Config::get("system", "directory");
1363
1364         if ($server == "") {
1365                 $server = "http://dir.friendica.social";
1366         }
1367
1368         return($server);
1369 }
1370
1371 function get_temppath()
1372 {
1373         $a = get_app();
1374
1375         $temppath = Config::get("system", "temppath");
1376
1377         if (($temppath != "") && App::directory_usable($temppath)) {
1378                 // We have a temp path and it is usable
1379                 return App::realpath($temppath);
1380         }
1381
1382         // We don't have a working preconfigured temp path, so we take the system path.
1383         $temppath = sys_get_temp_dir();
1384
1385         // Check if it is usable
1386         if (($temppath != "") && App::directory_usable($temppath)) {
1387                 // Always store the real path, not the path through symlinks
1388                 $temppath = App::realpath($temppath);
1389
1390                 // To avoid any interferences with other systems we create our own directory
1391                 $new_temppath = $temppath . "/" . $a->get_hostname();
1392                 if (!is_dir($new_temppath)) {
1393                         /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
1394                         mkdir($new_temppath);
1395                 }
1396
1397                 if (App::directory_usable($new_temppath)) {
1398                         // The new path is usable, we are happy
1399                         Config::set("system", "temppath", $new_temppath);
1400                         return $new_temppath;
1401                 } else {
1402                         // We can't create a subdirectory, strange.
1403                         // But the directory seems to work, so we use it but don't store it.
1404                         return $temppath;
1405                 }
1406         }
1407
1408         // Reaching this point means that the operating system is configured badly.
1409         return '';
1410 }
1411
1412 function get_cachefile($file, $writemode = true)
1413 {
1414         $cache = get_itemcachepath();
1415
1416         if ((!$cache) || (!is_dir($cache))) {
1417                 return("");
1418         }
1419
1420         $subfolder = $cache . "/" . substr($file, 0, 2);
1421
1422         $cachepath = $subfolder . "/" . $file;
1423
1424         if ($writemode) {
1425                 if (!is_dir($subfolder)) {
1426                         mkdir($subfolder);
1427                         chmod($subfolder, 0777);
1428                 }
1429         }
1430
1431         /// @TODO no need to put braces here
1432         return $cachepath;
1433 }
1434
1435 function clear_cache($basepath = "", $path = "")
1436 {
1437         if ($path == "") {
1438                 $basepath = get_itemcachepath();
1439                 $path = $basepath;
1440         }
1441
1442         if (($path == "") || (!is_dir($path))) {
1443                 return;
1444         }
1445
1446         if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
1447                 return;
1448         }
1449
1450         $cachetime = (int) Config::get('system', 'itemcache_duration');
1451         if ($cachetime == 0) {
1452                 $cachetime = 86400;
1453         }
1454
1455         if (is_writable($path)) {
1456                 if ($dh = opendir($path)) {
1457                         while (($file = readdir($dh)) !== false) {
1458                                 $fullpath = $path . "/" . $file;
1459                                 if ((filetype($fullpath) == "dir") && ($file != ".") && ($file != "..")) {
1460                                         clear_cache($basepath, $fullpath);
1461                                 }
1462                                 if ((filetype($fullpath) == "file") && (filectime($fullpath) < (time() - $cachetime))) {
1463                                         unlink($fullpath);
1464                                 }
1465                         }
1466                         closedir($dh);
1467                 }
1468         }
1469 }
1470
1471 function get_itemcachepath()
1472 {
1473         // Checking, if the cache is deactivated
1474         $cachetime = (int) Config::get('system', 'itemcache_duration');
1475         if ($cachetime < 0) {
1476                 return "";
1477         }
1478
1479         $itemcache = Config::get('system', 'itemcache');
1480         if (($itemcache != "") && App::directory_usable($itemcache)) {
1481                 return App::realpath($itemcache);
1482         }
1483
1484         $temppath = get_temppath();
1485
1486         if ($temppath != "") {
1487                 $itemcache = $temppath . "/itemcache";
1488                 if (!file_exists($itemcache) && !is_dir($itemcache)) {
1489                         mkdir($itemcache);
1490                 }
1491
1492                 if (App::directory_usable($itemcache)) {
1493                         Config::set("system", "itemcache", $itemcache);
1494                         return $itemcache;
1495                 }
1496         }
1497         return "";
1498 }
1499
1500 /**
1501  * @brief Returns the path where spool files are stored
1502  *
1503  * @return string Spool path
1504  */
1505 function get_spoolpath()
1506 {
1507         $spoolpath = Config::get('system', 'spoolpath');
1508         if (($spoolpath != "") && App::directory_usable($spoolpath)) {
1509                 // We have a spool path and it is usable
1510                 return $spoolpath;
1511         }
1512
1513         // We don't have a working preconfigured spool path, so we take the temp path.
1514         $temppath = get_temppath();
1515
1516         if ($temppath != "") {
1517                 // To avoid any interferences with other systems we create our own directory
1518                 $spoolpath = $temppath . "/spool";
1519                 if (!is_dir($spoolpath)) {
1520                         mkdir($spoolpath);
1521                 }
1522
1523                 if (App::directory_usable($spoolpath)) {
1524                         // The new path is usable, we are happy
1525                         Config::set("system", "spoolpath", $spoolpath);
1526                         return $spoolpath;
1527                 } else {
1528                         // We can't create a subdirectory, strange.
1529                         // But the directory seems to work, so we use it but don't store it.
1530                         return $temppath;
1531                 }
1532         }
1533
1534         // Reaching this point means that the operating system is configured badly.
1535         return "";
1536 }
1537
1538
1539 if (!function_exists('exif_imagetype')) {
1540         function exif_imagetype($file)
1541         {
1542                 $size = getimagesize($file);
1543                 return $size[2];
1544         }
1545 }
1546
1547 function validate_include(&$file)
1548 {
1549         $orig_file = $file;
1550
1551         $file = realpath($file);
1552
1553         if (strpos($file, getcwd()) !== 0) {
1554                 return false;
1555         }
1556
1557         $file = str_replace(getcwd() . "/", "", $file, $count);
1558         if ($count != 1) {
1559                 return false;
1560         }
1561
1562         if ($orig_file !== $file) {
1563                 return false;
1564         }
1565
1566         $valid = false;
1567         if (strpos($file, "include/") === 0) {
1568                 $valid = true;
1569         }
1570
1571         if (strpos($file, "addon/") === 0) {
1572                 $valid = true;
1573         }
1574
1575         // Simply return flag
1576         return ($valid);
1577 }
1578
1579 function current_load()
1580 {
1581         if (!function_exists('sys_getloadavg')) {
1582                 return false;
1583         }
1584
1585         $load_arr = sys_getloadavg();
1586
1587         if (!is_array($load_arr)) {
1588                 return false;
1589         }
1590
1591         return max($load_arr[0], $load_arr[1]);
1592 }
1593
1594 /**
1595  * @brief get c-style args
1596  *
1597  * @return int
1598  */
1599 function argc()
1600 {
1601         return get_app()->argc;
1602 }
1603
1604 /**
1605  * @brief Returns the value of a argv key
1606  *
1607  * @param int $x argv key
1608  * @return string Value of the argv key
1609  */
1610 function argv($x)
1611 {
1612         if (array_key_exists($x, get_app()->argv)) {
1613                 return get_app()->argv[$x];
1614         }
1615
1616         return '';
1617 }
1618
1619 /**
1620  * @brief Get the data which is needed for infinite scroll
1621  *
1622  * For invinite scroll we need the page number of the actual page
1623  * and the the URI where the content of the next page comes from.
1624  * This data is needed for the js part in main.js.
1625  * Note: infinite scroll does only work for the network page (module)
1626  *
1627  * @param string $module The name of the module (e.g. "network")
1628  * @return array Of infinite scroll data
1629  *      'pageno' => $pageno The number of the actual page
1630  *      'reload_uri' => $reload_uri The URI of the content we have to load
1631  */
1632 function infinite_scroll_data($module)
1633 {
1634         if (PConfig::get(local_user(), 'system', 'infinite_scroll')
1635                 && $module == 'network'
1636                 && defaults($_GET, 'mode', '') != 'minimal'
1637         ) {
1638                 // get the page number
1639                 $pageno = defaults($_GET, 'page', 1);
1640
1641                 $reload_uri = "";
1642
1643                 // try to get the uri from which we load the content
1644                 foreach ($_GET as $param => $value) {
1645                         if (($param != "page") && ($param != "q")) {
1646                                 $reload_uri .= "&" . $param . "=" . urlencode($value);
1647                         }
1648                 }
1649
1650                 $a = get_app();
1651                 if ($a->page_offset != "" && !strstr($reload_uri, "&offset=")) {
1652                         $reload_uri .= "&offset=" . urlencode($a->page_offset);
1653                 }
1654
1655                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
1656
1657                 return $arr;
1658         }
1659 }