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