boot.php

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