boot.php

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