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('include/autoloader.php');
  21
  22 require_once('include/config.php');
  23 require_once('include/network.php');
  24 require_once('include/plugin.php');
  25 require_once('include/text.php');
  26 require_once('include/datetime.php');
  27 require_once('include/pgettext.php');
  28 require_once('include/nav.php');
  29 require_once('include/cache.php');
  30 require_once('library/Mobile_Detect/Mobile_Detect.php');
  31 require_once('include/features.php');
  32 require_once('include/identity.php');
  33 require_once('include/pidfile.php');
  34 require_once('update.php');
  35 require_once('include/dbstructure.php');
  36
  37 define ( 'FRIENDICA_PLATFORM',     'Friendica');
  38 define ( 'FRIENDICA_CODENAME',     'Asparagus');
  39 define ( 'FRIENDICA_VERSION',      '3.5-dev' );
  40 define ( 'DFRN_PROTOCOL_VERSION',  '2.23'    );
  41 define ( 'DB_UPDATE_VERSION',      1196      );
  42
  43 /**
  44  * @brief Constant with a HTML line break.
  45  *
  46  * Contains a HTML line break (br) element and a real carriage return with line
  47  * feed for the source.
  48  * This can be used in HTML and JavaScript where needed a line break.
  49  */
  50 define ( 'EOL',                    "<br />\r\n"     );
  51 define ( 'ATOM_TIME',              'Y-m-d\TH:i:s\Z' );
  52
  53
  54 /**
  55  * @brief Image storage quality.
  56  *
  57  * Lower numbers save space at cost of image detail.
  58  * For ease of upgrade, please do not change here. Change jpeg quality with
  59  * $a->config['system']['jpeg_quality'] = n;
  60  * in .htconfig.php, where n is netween 1 and 100, and with very poor results
  61  * below about 50
  62  *
  63  */
  64
  65 define ( 'JPEG_QUALITY',            100  );
  66 /**
  67  * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
  68  */
  69 define ( 'PNG_QUALITY',             8  );
  70
  71 /**
  72  *
  73  * An alternate way of limiting picture upload sizes. Specify the maximum pixel
  74  * length that pictures are allowed to be (for non-square pictures, it will apply
  75  * to the longest side). Pictures longer than this length will be resized to be
  76  * this length (on the longest side, the other side will be scaled appropriately).
  77  * Modify this value using
  78  *
  79  *    $a->config['system']['max_image_length'] = n;
  80  *
  81  * in .htconfig.php
  82  *
  83  * If you don't want to set a maximum length, set to -1. The default value is
  84  * defined by 'MAX_IMAGE_LENGTH' below.
  85  *
  86  */
  87 define ( 'MAX_IMAGE_LENGTH',        -1  );
  88
  89
  90 /**
  91  * Not yet used
  92  */
  93
  94 define ( 'DEFAULT_DB_ENGINE',  'MyISAM'  );
  95
  96 /**
  97  * @name SSL Policy
  98  *
  99  * SSL redirection policies
 100  * @{
 101  */
 102 define ( 'SSL_POLICY_NONE',         0 );
 103 define ( 'SSL_POLICY_FULL',         1 );
 104 define ( 'SSL_POLICY_SELFSIGN',     2 );
 105 /* @}*/
 106
 107 /**
 108  * @name Logger
 109  *
 110  * log levels
 111  * @{
 112  */
 113 define ( 'LOGGER_NORMAL',          0 );
 114 define ( 'LOGGER_TRACE',           1 );
 115 define ( 'LOGGER_DEBUG',           2 );
 116 define ( 'LOGGER_DATA',            3 );
 117 define ( 'LOGGER_ALL',             4 );
 118 /* @}*/
 119
 120 /**
 121  * @name Cache
 122  *
 123  * Cache levels
 124  * @{
 125  */
 126 define ( 'CACHE_MONTH',            0 );
 127 define ( 'CACHE_WEEK',             1 );
 128 define ( 'CACHE_DAY',              2 );
 129 define ( 'CACHE_HOUR',             3 );
 130 /* @}*/
 131
 132 /**
 133  * @name Register
 134  *
 135  * Registration policies
 136  * @{
 137  */
 138 define ( 'REGISTER_CLOSED',        0 );
 139 define ( 'REGISTER_APPROVE',       1 );
 140 define ( 'REGISTER_OPEN',          2 );
 141 /** @}*/
 142
 143 /**
 144  * @name Contact_is
 145  *
 146  * Relationship types
 147  * @{
 148  */
 149 define ( 'CONTACT_IS_FOLLOWER', 1);
 150 define ( 'CONTACT_IS_SHARING',  2);
 151 define ( 'CONTACT_IS_FRIEND',   3);
 152 /** @}*/
 153
 154 /**
 155  * @name Update
 156  *
 157  * DB update return values
 158  * @{
 159  */
 160 define ( 'UPDATE_SUCCESS', 0);
 161 define ( 'UPDATE_FAILED',  1);
 162 /** @}*/
 163
 164
 165 /**
 166  * @name page/profile types
 167  *
 168  * PAGE_NORMAL is a typical personal profile account
 169  * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
 170  * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
 171  *      write access to wall and comments (no email and not included in page owner's ACL lists)
 172  * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
 173  *
 174  * @{
 175  */
 176 define ( 'PAGE_NORMAL',            0 );
 177 define ( 'PAGE_SOAPBOX',           1 );
 178 define ( 'PAGE_COMMUNITY',         2 );
 179 define ( 'PAGE_FREELOVE',          3 );
 180 define ( 'PAGE_BLOG',              4 );
 181 define ( 'PAGE_PRVGROUP',          5 );
 182 /** @}*/
 183
 184 /**
 185  * @name CP
 186  *
 187  * Type of the community page
 188  * @{
 189  */
 190 define ( 'CP_NO_COMMUNITY_PAGE',   -1 );
 191 define ( 'CP_USERS_ON_SERVER',     0 );
 192 define ( 'CP_GLOBAL_COMMUNITY',    1 );
 193 /** @}*/
 194
 195 /**
 196  * @name Network
 197  *
 198  * Network and protocol family types
 199  * @{
 200  */
 201 define ( 'NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
 202 define ( 'NETWORK_ZOT',              'zot!');    // Zot!
 203 define ( 'NETWORK_OSTATUS',          'stat');    // status.net, identi.ca, GNU-social, other OStatus implementations
 204 define ( 'NETWORK_FEED',             'feed');    // RSS/Atom feeds with no known "post/notify" protocol
 205 define ( 'NETWORK_DIASPORA',         'dspr');    // Diaspora
 206 define ( 'NETWORK_MAIL',             'mail');    // IMAP/POP
 207 define ( 'NETWORK_MAIL2',            'mai2');    // extended IMAP/POP
 208 define ( 'NETWORK_FACEBOOK',         'face');    // Facebook API
 209 define ( 'NETWORK_LINKEDIN',         'lnkd');    // LinkedIn
 210 define ( 'NETWORK_XMPP',             'xmpp');    // XMPP
 211 define ( 'NETWORK_MYSPACE',          'mysp');    // MySpace
 212 define ( 'NETWORK_GPLUS',            'goog');    // Google+
 213 define ( 'NETWORK_PUMPIO',           'pump');    // pump.io
 214 define ( 'NETWORK_TWITTER',          'twit');    // Twitter
 215 define ( 'NETWORK_DIASPORA2',        'dspc');    // Diaspora connector
 216 define ( 'NETWORK_STATUSNET',        'stac');    // Statusnet connector
 217 define ( 'NETWORK_APPNET',           'apdn');    // app.net
 218 define ( 'NETWORK_NEWS',             'nntp');    // Network News Transfer Protocol
 219 define ( 'NETWORK_ICALENDAR',        'ical');    // iCalendar
 220 define ( 'NETWORK_PHANTOM',          'unkn');    // Place holder
 221 /** @}*/
 222
 223 /**
 224  * These numbers are used in stored permissions
 225  * and existing allocations MUST NEVER BE CHANGED
 226  * OR RE-ASSIGNED! You may only add to them.
 227  */
 228
 229 $netgroup_ids = array(
 230         NETWORK_DFRN     => (-1),
 231         NETWORK_ZOT      => (-2),
 232         NETWORK_OSTATUS  => (-3),
 233         NETWORK_FEED     => (-4),
 234         NETWORK_DIASPORA => (-5),
 235         NETWORK_MAIL     => (-6),
 236         NETWORK_MAIL2    => (-7),
 237         NETWORK_FACEBOOK => (-8),
 238         NETWORK_LINKEDIN => (-9),
 239         NETWORK_XMPP     => (-10),
 240         NETWORK_MYSPACE  => (-11),
 241         NETWORK_GPLUS    => (-12),
 242         NETWORK_PUMPIO   => (-13),
 243         NETWORK_TWITTER  => (-14),
 244         NETWORK_DIASPORA2 => (-15),
 245         NETWORK_STATUSNET => (-16),
 246         NETWORK_APPNET    => (-17),
 247         NETWORK_NEWS      => (-18),
 248         NETWORK_ICALENDAR => (-19),
 249
 250         NETWORK_PHANTOM  => (-127),
 251 );
 252
 253
 254 /**
 255  * Maximum number of "people who like (or don't like) this"  that we will list by name
 256  */
 257
 258 define ( 'MAX_LIKERS',    75);
 259
 260 /**
 261  * Communication timeout
 262  */
 263
 264 define ( 'ZCURL_TIMEOUT' , (-1));
 265
 266
 267 /**
 268  * @name Notify
 269  *
 270  * Email notification options
 271  * @{
 272  */
 273 define ( 'NOTIFY_INTRO',    0x0001 );
 274 define ( 'NOTIFY_CONFIRM',  0x0002 );
 275 define ( 'NOTIFY_WALL',     0x0004 );
 276 define ( 'NOTIFY_COMMENT',  0x0008 );
 277 define ( 'NOTIFY_MAIL',     0x0010 );
 278 define ( 'NOTIFY_SUGGEST',  0x0020 );
 279 define ( 'NOTIFY_PROFILE',  0x0040 );
 280 define ( 'NOTIFY_TAGSELF',  0x0080 );
 281 define ( 'NOTIFY_TAGSHARE', 0x0100 );
 282 define ( 'NOTIFY_POKE',     0x0200 );
 283 define ( 'NOTIFY_SHARE',    0x0400 );
 284
 285 define ( 'NOTIFY_SYSTEM',   0x8000 );
 286 /* @}*/
 287
 288
 289 /**
 290  * @name Term
 291  *
 292  * Tag/term types
 293  * @{
 294  */
 295 define ( 'TERM_UNKNOWN',   0 );
 296 define ( 'TERM_HASHTAG',   1 );
 297 define ( 'TERM_MENTION',   2 );
 298 define ( 'TERM_CATEGORY',  3 );
 299 define ( 'TERM_PCATEGORY', 4 );
 300 define ( 'TERM_FILE',      5 );
 301 define ( 'TERM_SAVEDSEARCH', 6 );
 302 define ( 'TERM_CONVERSATION', 7 );
 303
 304 define ( 'TERM_OBJ_POST',  1 );
 305 define ( 'TERM_OBJ_PHOTO', 2 );
 306
 307
 308
 309 /**
 310  * @name Namespaces
 311  *
 312  * Various namespaces we may need to parse
 313  * @{
 314  */
 315 define ( 'NAMESPACE_ZOT',             'http://purl.org/zot' );
 316 define ( 'NAMESPACE_DFRN' ,           'http://purl.org/macgirvin/dfrn/1.0' );
 317 define ( 'NAMESPACE_THREAD' ,         'http://purl.org/syndication/thread/1.0' );
 318 define ( 'NAMESPACE_TOMB' ,           'http://purl.org/atompub/tombstones/1.0' );
 319 define ( 'NAMESPACE_ACTIVITY',        'http://activitystrea.ms/spec/1.0/' );
 320 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
 321 define ( 'NAMESPACE_MEDIA',           'http://purl.org/syndication/atommedia' );
 322 define ( 'NAMESPACE_SALMON_ME',       'http://salmon-protocol.org/ns/magic-env' );
 323 define ( 'NAMESPACE_OSTATUSSUB',      'http://ostatus.org/schema/1.0/subscribe' );
 324 define ( 'NAMESPACE_GEORSS',          'http://www.georss.org/georss' );
 325 define ( 'NAMESPACE_POCO',            'http://portablecontacts.net/spec/1.0' );
 326 define ( 'NAMESPACE_FEED',            'http://schemas.google.com/g/2010#updates-from' );
 327 define ( 'NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0' );
 328 define ( 'NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/' );
 329 define ( 'NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom' );
 330 /* @}*/
 331
 332 /**
 333  * @name Activity
 334  *
 335  * Activity stream defines
 336  * @{
 337  */
 338 define ( 'ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like' );
 339 define ( 'ACTIVITY_DISLIKE',     NAMESPACE_DFRN            . '/dislike' );
 340 define ( 'ACTIVITY_ATTEND',      NAMESPACE_ZOT             . '/activity/attendyes' );
 341 define ( 'ACTIVITY_ATTENDNO',    NAMESPACE_ZOT             . '/activity/attendno' );
 342 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT             . '/activity/attendmaybe' );
 343
 344 define ( 'ACTIVITY_OBJ_HEART',   NAMESPACE_DFRN            . '/heart' );
 345
 346 define ( 'ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
 347 define ( 'ACTIVITY_REQ_FRIEND',  NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
 348 define ( 'ACTIVITY_UNFRIEND',    NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
 349 define ( 'ACTIVITY_FOLLOW',      NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
 350 define ( 'ACTIVITY_UNFOLLOW',    NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
 351 define ( 'ACTIVITY_JOIN',        NAMESPACE_ACTIVITY_SCHEMA . 'join' );
 352
 353 define ( 'ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post' );
 354 define ( 'ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update' );
 355 define ( 'ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
 356 define ( 'ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
 357 define ( 'ACTIVITY_SHARE',       NAMESPACE_ACTIVITY_SCHEMA . 'share' );
 358
 359 define ( 'ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke' );
 360 define ( 'ACTIVITY_MOOD',        NAMESPACE_ZOT . '/activity/mood' );
 361
 362 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
 363 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
 364 define ( 'ACTIVITY_OBJ_NOTE',    NAMESPACE_ACTIVITY_SCHEMA . 'note' );
 365 define ( 'ACTIVITY_OBJ_PERSON',  NAMESPACE_ACTIVITY_SCHEMA . 'person' );
 366 define ( 'ACTIVITY_OBJ_IMAGE',   NAMESPACE_ACTIVITY_SCHEMA . 'image' );
 367 define ( 'ACTIVITY_OBJ_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
 368 define ( 'ACTIVITY_OBJ_VIDEO',   NAMESPACE_ACTIVITY_SCHEMA . 'video' );
 369 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
 370 define ( 'ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
 371 define ( 'ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event' );
 372 define ( 'ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group' );
 373 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN            . '/tagterm' );
 374 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN            . '/profile' );
 375 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
 376 /* @}*/
 377
 378 /**
 379  * @name Gravity
 380  *
 381  * Item weight for query ordering
 382  * @{
 383  */
 384 define ( 'GRAVITY_PARENT',       0);
 385 define ( 'GRAVITY_LIKE',         3);
 386 define ( 'GRAVITY_COMMENT',      6);
 387 /* @}*/
 388
 389
 390 // Normally this constant is defined - but not if "pcntl" isn't installed
 391 if (!defined("SIGTERM"))
 392         define("SIGTERM", 15);
 393
 394 /**
 395  *
 396  * Reverse the effect of magic_quotes_gpc if it is enabled.
 397  * Please disable magic_quotes_gpc so we don't have to do this.
 398  * See http://php.net/manual/en/security.magicquotes.disabling.php
 399  *
 400  */
 401
 402 function startup() {
 403
 404         error_reporting(E_ERROR | E_WARNING | E_PARSE);
 405
 406         set_time_limit(0);
 407
 408         // This has to be quite large to deal with embedded private photos
 409         ini_set('pcre.backtrack_limit', 500000);
 410
 411
 412         if (get_magic_quotes_gpc()) {
 413                 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
 414                 while (list($key, $val) = each($process)) {
 415                         foreach ($val as $k => $v) {
 416                                 unset($process[$key][$k]);
 417                                 if (is_array($v)) {
 418                                         $process[$key][stripslashes($k)] = $v;
 419                                         $process[] = &$process[$key][stripslashes($k)];
 420                                 } else {
 421                                         $process[$key][stripslashes($k)] = stripslashes($v);
 422                                 }
 423                         }
 424                 }
 425                 unset($process);
 426         }
 427
 428 }
 429
 430 /**
 431  *
 432  * class: App
 433  *
 434  * @brief Our main application structure for the life of this page.
 435  *
 436  * Primarily deals with the URL that got us here
 437  * and tries to make some sense of it, and
 438  * stores our page contents and config storage
 439  * and anything else that might need to be passed around
 440  * before we spit the page out.
 441  *
 442  */
 443 class App {
 444
 445         public  $module_loaded = false;
 446         public  $query_string;
 447         public  $config;
 448         public  $page;
 449         public  $profile;
 450         public  $profile_uid;
 451         public  $user;
 452         public  $cid;
 453         public  $contact;
 454         public  $contacts;
 455         public  $page_contact;
 456         public  $content;
 457         public  $data = array();
 458         public  $error = false;
 459         public  $cmd;
 460         public  $argv;
 461         public  $argc;
 462         public  $module;
 463         public  $pager;
 464         public  $strings;
 465         public  $path;
 466         public  $hooks;
 467         public  $timezone;
 468         public  $interactive = true;
 469         public  $plugins;
 470         public  $apps = array();
 471         public  $identities;
 472         public  $is_mobile = false;
 473         public  $is_tablet = false;
 474         public  $is_friendica_app;
 475         public  $performance = array();
 476         public  $callstack = array();
 477         public  $theme_info = array();
 478
 479         public $nav_sel;
 480
 481         public $category;
 482
 483
 484         // Allow themes to control internal parameters
 485         // by changing App values in theme.php
 486
 487         public  $sourcename = '';
 488         public  $videowidth = 425;
 489         public  $videoheight = 350;
 490         public  $force_max_items = 0;
 491         public  $theme_thread_allow = true;
 492         public  $theme_events_in_profile = true;
 493
 494         /**
 495          * @brief An array for all theme-controllable parameters
 496          *
 497          * Mostly unimplemented yet. Only options 'template_engine' and
 498          * beyond are used.
 499          */
 500         public  $theme = array(
 501                 'sourcename' => '',
 502                 'videowidth' => 425,
 503                 'videoheight' => 350,
 504                 'force_max_items' => 0,
 505                 'thread_allow' => true,
 506                 'stylesheet' => '',
 507                 'template_engine' => 'smarty3',
 508         );
 509
 510         /**
 511          * @brief An array of registered template engines ('name'=>'class name')
 512          */
 513         public $template_engines = array();
 514         /**
 515          * @brief An array of instanced template engines ('name'=>'instance')
 516          */
 517         public $template_engine_instance = array();
 518
 519         private $ldelim = array(
 520                 'internal' => '',
 521                 'smarty3' => '{{'
 522         );
 523         private $rdelim = array(
 524                 'internal' => '',
 525                 'smarty3' => '}}'
 526         );
 527
 528         private $scheme;
 529         private $hostname;
 530         private $baseurl;
 531         private $db;
 532
 533         private $curl_code;
 534         private $curl_content_type;
 535         private $curl_headers;
 536
 537         private $cached_profile_image;
 538         private $cached_profile_picdate;
 539
 540         private static $a;
 541
 542         /**
 543          * @brief App constructor.
 544          */
 545         function __construct() {
 546
 547                 global $default_timezone;
 548
 549                 $hostname = "";
 550
 551                 if (file_exists(".htpreconfig.php"))
 552                         @include(".htpreconfig.php");
 553
 554                 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
 555
 556                 date_default_timezone_set($this->timezone);
 557
 558                 $this->performance["start"] = microtime(true);
 559                 $this->performance["database"] = 0;
 560                 $this->performance["network"] = 0;
 561                 $this->performance["file"] = 0;
 562                 $this->performance["rendering"] = 0;
 563                 $this->performance["parser"] = 0;
 564                 $this->performance["marktime"] = 0;
 565                 $this->performance["markstart"] = microtime(true);
 566
 567                 $this->callstack["database"] = array();
 568                 $this->callstack["network"] = array();
 569                 $this->callstack["file"] = array();
 570                 $this->callstack["rendering"] = array();
 571                 $this->callstack["parser"] = array();
 572
 573                 $this->config = array();
 574                 $this->page = array();
 575                 $this->pager= array();
 576
 577                 $this->query_string = '';
 578
 579                 startup();
 580
 581                 set_include_path(
 582                                 'include' . PATH_SEPARATOR
 583                                 . 'library' . PATH_SEPARATOR
 584                                 . 'library/phpsec' . PATH_SEPARATOR
 585                                 . 'library/langdet' . PATH_SEPARATOR
 586                                 . '.' );
 587
 588
 589                 $this->scheme = 'http';
 590                 if(x($_SERVER,'HTTPS') && $_SERVER['HTTPS'])
 591                         $this->scheme = 'https';
 592                 elseif(x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443))
 593                         $this->scheme = 'https';
 594
 595                 if(x($_SERVER,'SERVER_NAME')) {
 596                         $this->hostname = $_SERVER['SERVER_NAME'];
 597
 598                         if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
 599                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
 600                         /*
 601                          * Figure out if we are running at the top of a domain
 602                          * or in a sub-directory and adjust accordingly
 603                          */
 604
 605                         $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
 606                         if(isset($path) && strlen($path) && ($path != $this->path))
 607                                 $this->path = $path;
 608                 }
 609
 610                 if ($hostname != "")
 611                         $this->hostname = $hostname;
 612
 613                 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
 614                         $this->set_baseurl(array_pop($_SERVER["argv"]) );
 615                         $_SERVER["argc"] --;
 616                 }
 617
 618                 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
 619
 620                 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
 621                         $this->query_string = substr($_SERVER['QUERY_STRING'],9);
 622                         // removing trailing / - maybe a nginx problem
 623                         if (substr($this->query_string, 0, 1) == "/")
 624                                 $this->query_string = substr($this->query_string, 1);
 625                 } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
 626                         $this->query_string = substr($_SERVER['QUERY_STRING'],2);
 627                         // removing trailing / - maybe a nginx problem
 628                         if (substr($this->query_string, 0, 1) == "/")
 629                                 $this->query_string = substr($this->query_string, 1);
 630                 }
 631
 632                 if (x($_GET,'pagename'))
 633                         $this->cmd = trim($_GET['pagename'],'/\\');
 634                 elseif (x($_GET,'q'))
 635                         $this->cmd = trim($_GET['q'],'/\\');
 636
 637
 638                 // fix query_string
 639                 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
 640
 641
 642                 // unix style "homedir"
 643
 644                 if(substr($this->cmd,0,1) === '~')
 645                         $this->cmd = 'profile/' . substr($this->cmd,1);
 646
 647                 // Diaspora style profile url
 648
 649                 if(substr($this->cmd,0,2) === 'u/')
 650                         $this->cmd = 'profile/' . substr($this->cmd,2);
 651
 652
 653                 /*
 654                  *
 655                  * Break the URL path into C style argc/argv style arguments for our
 656                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 657                  * will be 3 (integer) and $this->argv will contain:
 658                  *   [0] => 'module'
 659                  *   [1] => 'arg1'
 660                  *   [2] => 'arg2'
 661                  *
 662                  *
 663                  * There will always be one argument. If provided a naked domain
 664                  * URL, $this->argv[0] is set to "home".
 665                  *
 666                  */
 667
 668                 $this->argv = explode('/',$this->cmd);
 669                 $this->argc = count($this->argv);
 670                 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
 671                         $this->module = str_replace(".", "_", $this->argv[0]);
 672                         $this->module = str_replace("-", "_", $this->module);
 673                 }
 674                 else {
 675                         $this->argc = 1;
 676                         $this->argv = array('home');
 677                         $this->module = 'home';
 678                 }
 679
 680                 /*
 681                  * See if there is any page number information, and initialise
 682                  * pagination
 683                  */
 684
 685                 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
 686                 $this->pager['itemspage'] = 50;
 687                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 688                 if($this->pager['start'] < 0)
 689                         $this->pager['start'] = 0;
 690                 $this->pager['total'] = 0;
 691
 692                 /*
 693                  * Detect mobile devices
 694                  */
 695
 696                 $mobile_detect = new Mobile_Detect();
 697                 $this->is_mobile = $mobile_detect->isMobile();
 698                 $this->is_tablet = $mobile_detect->isTablet();
 699
 700                 // Friendica-Client
 701                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
 702
 703                 /*
 704                  * register template engines
 705                  */
 706                 $dc = get_declared_classes();
 707                 foreach ($dc as $k) {
 708                         if (in_array("ITemplateEngine", class_implements($k))){
 709                                 $this->register_template_engine($k);
 710                         }
 711                 }
 712
 713                 self::$a = $this;
 714
 715         }
 716
 717         function get_basepath() {
 718
 719                 $basepath = get_config("system", "basepath");
 720
 721                 if ($basepath == "")
 722                         $basepath = dirname(__FILE__);
 723
 724                 if ($basepath == "")
 725                         $basepath = $_SERVER["DOCUMENT_ROOT"];
 726
 727                 if ($basepath == "")
 728                         $basepath = $_SERVER["PWD"];
 729
 730                 return($basepath);
 731         }
 732
 733         function get_scheme() {
 734                 return($this->scheme);
 735         }
 736
 737         function get_baseurl($ssl = false) {
 738
 739                 // Is the function called statically?
 740                 if (!is_object($this))
 741                         return(self::$a->get_baseurl($ssl));
 742
 743                 $scheme = $this->scheme;
 744
 745                 if((x($this->config,'system')) && (x($this->config['system'],'ssl_policy'))) {
 746                         if(intval($this->config['system']['ssl_policy']) === intval(SSL_POLICY_FULL))
 747                                 $scheme = 'https';
 748
 749                         //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
 750                         //      (and also the login link). Anything seen by an outsider will have it turned off.
 751
 752                         if($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) {
 753                                 if($ssl)
 754                                         $scheme = 'https';
 755                                 else
 756                                         $scheme = 'http';
 757                         }
 758                 }
 759
 760                 if (get_config('config','hostname') != "")
 761                         $this->hostname = get_config('config','hostname');
 762
 763                 $this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
 764                 return $this->baseurl;
 765         }
 766
 767         function set_baseurl($url) {
 768                 $parsed = @parse_url($url);
 769
 770                 $this->baseurl = $url;
 771
 772                 if($parsed) {
 773                         $this->scheme = $parsed['scheme'];
 774
 775                         $hostname = $parsed['host'];
 776                         if(x($parsed,'port'))
 777                                 $hostname .= ':' . $parsed['port'];
 778                         if(x($parsed,'path'))
 779                                 $this->path = trim($parsed['path'],'\\/');
 780
 781                         if (file_exists(".htpreconfig.php"))
 782                                 @include(".htpreconfig.php");
 783
 784                         if (get_config('config','hostname') != "")
 785                                 $this->hostname = get_config('config','hostname');
 786
 787                         if (!isset($this->hostname) OR ($this->hostname == ""))
 788                                 $this->hostname = $hostname;
 789                 }
 790
 791         }
 792
 793         function get_hostname() {
 794                 if (get_config('config','hostname') != "")
 795                         $this->hostname = get_config('config','hostname');
 796
 797                 return $this->hostname;
 798         }
 799
 800         function set_hostname($h) {
 801                 $this->hostname = $h;
 802         }
 803
 804         function set_path($p) {
 805                 $this->path = trim(trim($p),'/');
 806         }
 807
 808         function get_path() {
 809                 return $this->path;
 810         }
 811
 812         function set_pager_total($n) {
 813                 $this->pager['total'] = intval($n);
 814         }
 815
 816         function set_pager_itemspage($n) {
 817                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
 818                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 819         }
 820
 821         function set_pager_page($n) {
 822                 $this->pager['page'] = $n;
 823                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
 824         }
 825
 826         function init_pagehead() {
 827                 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
 828
 829                 // If the update is "deactivated" set it to the highest integer number (~24 days)
 830                 if ($interval < 0)
 831                         $interval = 2147483647;
 832
 833                 if($interval < 10000)
 834                         $interval = 40000;
 835
 836                 // compose the page title from the sitename and the
 837                 // current module called
 838                 if (!$this->module=='')
 839                 {
 840                     $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
 841                 } else {
 842                     $this->page['title'] = $this->config['sitename'];
 843                 }
 844
 845                 /* put the head template at the beginning of page['htmlhead']
 846                  * since the code added by the modules frequently depends on it
 847                  * being first
 848                  */
 849                 if(!isset($this->page['htmlhead']))
 850                         $this->page['htmlhead'] = '';
 851
 852                 // If we're using Smarty, then doing replace_macros() will replace
 853                 // any unrecognized variables with a blank string. Since we delay
 854                 // replacing $stylesheet until later, we need to replace it now
 855                 // with another variable name
 856                 if($this->theme['template_engine'] === 'smarty3')
 857                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
 858                 else
 859                         $stylesheet = '$stylesheet';
 860
 861                 $shortcut_icon = get_config("system", "shortcut_icon");
 862                 if ($shortcut_icon == "")
 863                         $shortcut_icon = "images/friendica-32.png";
 864
 865                 $touch_icon = get_config("system", "touch_icon");
 866                 if ($touch_icon == "")
 867                         $touch_icon = "images/friendica-128.png";
 868
 869                 // get data wich is needed for infinite scroll on the network page
 870                 $invinite_scroll = infinite_scroll_data($this->module);
 871
 872                 $tpl = get_markup_template('head.tpl');
 873                 $this->page['htmlhead'] = replace_macros($tpl,array(
 874                         '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
 875                         '$local_user' => local_user(),
 876                         '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
 877                         '$delitem' => t('Delete this item?'),
 878                         '$comment' => t('Comment'),
 879                         '$showmore' => t('show more'),
 880                         '$showfewer' => t('show fewer'),
 881                         '$update_interval' => $interval,
 882                         '$shortcut_icon' => $shortcut_icon,
 883                         '$touch_icon' => $touch_icon,
 884                         '$stylesheet' => $stylesheet,
 885                         '$infinite_scroll' => $invinite_scroll,
 886                 )) . $this->page['htmlhead'];
 887         }
 888
 889         function init_page_end() {
 890                 if(!isset($this->page['end']))
 891                         $this->page['end'] = '';
 892                 $tpl = get_markup_template('end.tpl');
 893                 $this->page['end'] = replace_macros($tpl,array(
 894                         '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
 895                 )) . $this->page['end'];
 896         }
 897
 898         function set_curl_code($code) {
 899                 $this->curl_code = $code;
 900         }
 901
 902         function get_curl_code() {
 903                 return $this->curl_code;
 904         }
 905
 906         function set_curl_content_type($content_type) {
 907                 $this->curl_content_type = $content_type;
 908         }
 909
 910         function get_curl_content_type() {
 911                 return $this->curl_content_type;
 912         }
 913
 914         function set_curl_headers($headers) {
 915                 $this->curl_headers = $headers;
 916         }
 917
 918         function get_curl_headers() {
 919                 return $this->curl_headers;
 920         }
 921
 922         function get_cached_avatar_image($avatar_image){
 923                 return $avatar_image;
 924
 925                 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
 926                 /*
 927                 if($this->cached_profile_image[$avatar_image])
 928                         return $this->cached_profile_image[$avatar_image];
 929
 930                 $path_parts = explode("/",$avatar_image);
 931                 $common_filename = $path_parts[count($path_parts)-1];
 932
 933                 if($this->cached_profile_picdate[$common_filename]){
 934                         $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
 935                 } else {
 936                         $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
 937                                 $common_filename);
 938                         if(! count($r)){
 939                                 $this->cached_profile_image[$avatar_image] = $avatar_image;
 940                         } else {
 941                                 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
 942                                 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
 943                         }
 944                 }
 945                 return $this->cached_profile_image[$avatar_image];
 946                 */
 947         }
 948
 949
 950         /**
 951          * @brief Removes the baseurl from an url. This avoids some mixed content problems.
 952          *
 953          * @param string $url
 954          *
 955          * @return string The cleaned url
 956          */
 957         function remove_baseurl($url){
 958
 959                 // Is the function called statically?
 960                 if (!is_object($this))
 961                         return(self::$a->remove_baseurl($url));
 962
 963                 $url = normalise_link($url);
 964                 $base = normalise_link($this->get_baseurl());
 965                 $url = str_replace($base."/", "", $url);
 966                 return $url;
 967         }
 968
 969         /**
 970          * @brief Register template engine class
 971          *
 972          * If $name is "", is used class static property $class::$name
 973          *
 974          * @param string $class
 975          * @param string $name
 976          */
 977         function register_template_engine($class, $name = '') {
 978                 if ($name===""){
 979                         $v = get_class_vars( $class );
 980                         if(x($v,"name")) $name = $v['name'];
 981                 }
 982                 if ($name===""){
 983                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
 984                         killme();
 985                 }
 986                 $this->template_engines[$name] = $class;
 987         }
 988
 989         /**
 990          * @brief Return template engine instance.
 991          *
 992          * If $name is not defined, return engine defined by theme,
 993          * or default
 994          *
 995          * @param strin $name Template engine name
 996          * @return object Template Engine instance
 997          */
 998         function template_engine($name = ''){
 999                 if ($name!=="") {
1000                         $template_engine = $name;
1001                 } else {
1002                         $template_engine = 'smarty3';
1003                         if (x($this->theme, 'template_engine')) {
1004                                 $template_engine = $this->theme['template_engine'];
1005                         }
1006                 }
1007
1008                 if (isset($this->template_engines[$template_engine])){
1009                         if(isset($this->template_engine_instance[$template_engine])){
1010                                 return $this->template_engine_instance[$template_engine];
1011                         } else {
1012                                 $class = $this->template_engines[$template_engine];
1013                                 $obj = new $class;
1014                                 $this->template_engine_instance[$template_engine] = $obj;
1015                                 return $obj;
1016                         }
1017                 }
1018
1019                 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1020         }
1021
1022         /**
1023          * @brief Returns the active template engine.
1024          *
1025          * @return string
1026          */
1027         function get_template_engine() {
1028                 return $this->theme['template_engine'];
1029         }
1030
1031         function set_template_engine($engine = 'smarty3') {
1032                 $this->theme['template_engine'] = $engine;
1033                 /*
1034                 $this->theme['template_engine'] = 'smarty3';
1035
1036                 switch($engine) {
1037                         case 'smarty3':
1038                                 if(is_writable('view/smarty3/'))
1039                                         $this->theme['template_engine'] = 'smarty3';
1040                                 break;
1041                         default:
1042                                 break;
1043                 }
1044                 */
1045         }
1046
1047         function get_template_ldelim($engine = 'smarty3') {
1048                 return $this->ldelim[$engine];
1049         }
1050
1051         function get_template_rdelim($engine = 'smarty3') {
1052                 return $this->rdelim[$engine];
1053         }
1054
1055         function save_timestamp($stamp, $value) {
1056                 $duration = (float)(microtime(true)-$stamp);
1057
1058                 if (!isset($this->performance[$value])) {
1059                         // Prevent ugly E_NOTICE
1060                         $this->performance[$value] = 0;
1061                 }
1062
1063                 $this->performance[$value] += (float)$duration;
1064                 $this->performance["marktime"] += (float)$duration;
1065
1066                 $callstack = $this->callstack();
1067
1068                 if (!isset($this->callstack[$value][$callstack])) {
1069                         // Prevent ugly E_NOTICE
1070                         $this->callstack[$value][$callstack] = 0;
1071                 }
1072
1073                 $this->callstack[$value][$callstack] += (float)$duration;
1074
1075         }
1076
1077         /**
1078          * @brief Returns a string with a callstack. Can be used for logging.
1079          *
1080          * @return string
1081          */
1082         function callstack() {
1083                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1084
1085                 // We remove the first two items from the list since they contain data that we don't need.
1086                 array_shift($trace);
1087                 array_shift($trace);
1088
1089                 $callstack = array();
1090                 foreach ($trace AS $func)
1091                         $callstack[] = $func["function"];
1092
1093                 return implode(", ", $callstack);
1094         }
1095
1096         function mark_timestamp($mark) {
1097                 //$this->performance["markstart"] -= microtime(true) - $this->performance["marktime"];
1098                 $this->performance["markstart"] = microtime(true) - $this->performance["markstart"] - $this->performance["marktime"];
1099         }
1100
1101         function get_useragent() {
1102                 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1103         }
1104
1105         function is_friendica_app() {
1106                 return($this->is_friendica_app);
1107         }
1108
1109         /**
1110          * @brief Checks if the maximum load is reached
1111          *
1112          * @return bool Is the load reached?
1113          */
1114         function maxload_reached() {
1115
1116                 $maxsysload = intval(get_config('system', 'maxloadavg'));
1117                 if ($maxsysload < 1)
1118                         $maxsysload = 50;
1119
1120                 $load = current_load();
1121                 if ($load) {
1122                         if (intval($load) > $maxsysload) {
1123                                 logger('system: load '.$load.' too high.');
1124                                 return true;
1125                         }
1126                 }
1127                 return false;
1128         }
1129
1130         /**
1131          * @brief Checks if the process is already running
1132          *
1133          * @param string $taskname The name of the task that will be used for the name of the lockfile
1134          * @param string $task The path and name of the php script
1135          * @param int $timeout The timeout after which a task should be killed
1136          *
1137          * @return bool Is the process running?
1138          */
1139         function is_already_running($taskname, $task = "", $timeout = 540) {
1140
1141                 $lockpath = get_lockpath();
1142                 if ($lockpath != '') {
1143                         $pidfile = new pidfile($lockpath, $taskname);
1144                         if ($pidfile->is_already_running()) {
1145                                 logger("Already running");
1146                                 if ($pidfile->running_time() > $timeout) {
1147                                         $pidfile->kill();
1148                                         logger("killed stale process");
1149                                         // Calling a new instance
1150                                         if ($task != "")
1151                                                 proc_run('php', $task);
1152                                 }
1153                                 return true;
1154                         }
1155                 }
1156                 return false;
1157         }
1158 }
1159
1160 /**
1161  * @brief Retrieve the App structure
1162  *
1163  * Useful in functions which require it but don't get it passed to them
1164  */
1165 function get_app() {
1166         global $a;
1167         return $a;
1168 }
1169
1170
1171 /**
1172  * @brief Multi-purpose function to check variable state.
1173  *
1174  * Usage: x($var) or $x($array, 'key')
1175  *
1176  * returns false if variable/key is not set
1177  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1178  * e.g. x('') or x(0) returns 0;
1179  *
1180  * @param string|array $s variable to check
1181  * @param string $k key inside the array to check
1182  *
1183  * @return bool|int
1184  */
1185 function x($s,$k = NULL) {
1186         if($k != NULL) {
1187                 if((is_array($s)) && (array_key_exists($k,$s))) {
1188                         if($s[$k])
1189                                 return (int) 1;
1190                         return (int) 0;
1191         }
1192                 return false;
1193         }
1194         else {
1195                 if(isset($s)) {
1196                         if($s) {
1197                                 return (int) 1;
1198                         }
1199                         return (int) 0;
1200                 }
1201                 return false;
1202         }
1203 }
1204
1205
1206 /**
1207  * @brief Called from db initialisation if db is dead.
1208  */
1209 function system_unavailable() {
1210         include('system_unavailable.php');
1211         system_down();
1212         killme();
1213 }
1214
1215
1216 function clean_urls() {
1217         global $a;
1218         //      if($a->config['system']['clean_urls'])
1219         return true;
1220         //      return false;
1221 }
1222
1223 function z_path() {
1224         global $a;
1225         $base = $a->get_baseurl();
1226         if(! clean_urls())
1227                 $base .= '/?q=';
1228         return $base;
1229 }
1230
1231 /**
1232  * @brief Returns the baseurl.
1233  *
1234  * @see App::get_baseurl()
1235  *
1236  * @return string
1237  */
1238 function z_root() {
1239         global $a;
1240         return $a->get_baseurl();
1241 }
1242
1243 /**
1244  * @brief Return absolut URL for given $path.
1245  *
1246  * @param string $path
1247  *
1248  * @return string
1249  */
1250 function absurl($path) {
1251         if(strpos($path,'/') === 0)
1252                 return z_path() . $path;
1253         return $path;
1254 }
1255
1256 /**
1257  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1258  *
1259  * @return boolean
1260  */
1261 function is_ajax() {
1262         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1263 }
1264
1265 function check_db() {
1266
1267         $build = get_config('system','build');
1268         if(! x($build)) {
1269                 set_config('system','build',DB_UPDATE_VERSION);
1270                 $build = DB_UPDATE_VERSION;
1271         }
1272         if($build != DB_UPDATE_VERSION)
1273                 proc_run('php', 'include/dbupdate.php');
1274
1275 }
1276
1277
1278 /**
1279  * Sets the base url for use in cmdline programs which don't have
1280  * $_SERVER variables
1281  */
1282 function check_url(&$a) {
1283
1284         $url = get_config('system','url');
1285
1286         // if the url isn't set or the stored url is radically different
1287         // than the currently visited url, store the current value accordingly.
1288         // "Radically different" ignores common variations such as http vs https
1289         // and www.example.com vs example.com.
1290         // We will only change the url to an ip address if there is no existing setting
1291
1292         if(! x($url))
1293                 $url = set_config('system','url',$a->get_baseurl());
1294         if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1295                 $url = set_config('system','url',$a->get_baseurl());
1296
1297         return;
1298 }
1299
1300
1301 /**
1302  * @brief Automatic database updates
1303  */
1304 function update_db(&$a) {
1305         $build = get_config('system','build');
1306         if(! x($build))
1307                 $build = set_config('system','build',DB_UPDATE_VERSION);
1308
1309         if($build != DB_UPDATE_VERSION) {
1310                 $stored = intval($build);
1311                 $current = intval(DB_UPDATE_VERSION);
1312                 if($stored < $current) {
1313                         load_config('database');
1314
1315                         // We're reporting a different version than what is currently installed.
1316                         // Run any existing update scripts to bring the database up to current.
1317
1318                         // make sure that boot.php and update.php are the same release, we might be
1319                         // updating right this very second and the correct version of the update.php
1320                         // file may not be here yet. This can happen on a very busy site.
1321
1322                         if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1323                                 // Compare the current structure with the defined structure
1324
1325                                 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1326                                 if($t !== false)
1327                                         return;
1328
1329                                 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1330
1331                                 // run old update routine (wich could modify the schema and
1332                                 // conflits with new routine)
1333                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1334                                         $r = run_update_function($x);
1335                                         if (!$r) break;
1336                                 }
1337                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1338
1339
1340                                 // run new update routine
1341                                 // it update the structure in one call
1342                                 $retval = update_structure(false, true);
1343                                 if($retval) {
1344                                         update_fail(
1345                                                 DB_UPDATE_VERSION,
1346                                                 $retval
1347                                         );
1348                                         return;
1349                                 } else {
1350                                         set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1351                                 }
1352
1353                                 // run any left update_nnnn functions in update.php
1354                                 for($x = $stored; $x < $current; $x ++) {
1355                                         $r = run_update_function($x);
1356                                         if (!$r) break;
1357                                 }
1358                         }
1359                 }
1360         }
1361
1362         return;
1363 }
1364
1365 function run_update_function($x) {
1366         if(function_exists('update_' . $x)) {
1367
1368                 // There could be a lot of processes running or about to run.
1369                 // We want exactly one process to run the update command.
1370                 // So store the fact that we're taking responsibility
1371                 // after first checking to see if somebody else already has.
1372
1373                 // If the update fails or times-out completely you may need to
1374                 // delete the config entry to try again.
1375
1376                 $t = get_config('database','update_' . $x);
1377                 if($t !== false)
1378                         return false;
1379                 set_config('database','update_' . $x, time());
1380
1381                 // call the specific update
1382
1383                 $func = 'update_' . $x;
1384                 $retval = $func();
1385
1386                 if($retval) {
1387                         //send the administrator an e-mail
1388                         update_fail(
1389                                 $x,
1390                                 sprintf(t('Update %s failed. See error logs.'), $x)
1391                         );
1392                         return false;
1393                 } else {
1394                         set_config('database','update_' . $x, 'success');
1395                         set_config('system','build', $x + 1);
1396                         return true;
1397                 }
1398         } else {
1399                 set_config('database','update_' . $x, 'success');
1400                 set_config('system','build', $x + 1);
1401                 return true;
1402         }
1403         return true;
1404 }
1405
1406 /**
1407  * @brief Synchronise plugins:
1408  *
1409  * $a->config['system']['addon'] contains a comma-separated list of names
1410  * of plugins/addons which are used on this system.
1411  * Go through the database list of already installed addons, and if we have
1412  * an entry, but it isn't in the config list, call the uninstall procedure
1413  * and mark it uninstalled in the database (for now we'll remove it).
1414  * Then go through the config list and if we have a plugin that isn't installed,
1415  * call the install procedure and add it to the database.
1416  *
1417  * @param App $a
1418  *
1419          */
1420 function check_plugins(&$a) {
1421
1422         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1423         if(count($r))
1424                 $installed = $r;
1425         else
1426                 $installed = array();
1427
1428         $plugins = get_config('system','addon');
1429         $plugins_arr = array();
1430
1431         if($plugins)
1432                 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1433
1434         $a->plugins = $plugins_arr;
1435
1436         $installed_arr = array();
1437
1438         if(count($installed)) {
1439                 foreach($installed as $i) {
1440                         if(! in_array($i['name'],$plugins_arr)) {
1441                                 uninstall_plugin($i['name']);
1442                         }
1443                         else {
1444                                 $installed_arr[] = $i['name'];
1445                         }
1446                 }
1447         }
1448
1449         if(count($plugins_arr)) {
1450                 foreach($plugins_arr as $p) {
1451                         if(! in_array($p,$installed_arr)) {
1452                                 install_plugin($p);
1453                         }
1454                 }
1455         }
1456
1457
1458         load_hooks();
1459
1460         return;
1461 }
1462
1463 function get_guid($size=16, $prefix = "") {
1464
1465         if ($prefix == "") {
1466                 $a = get_app();
1467                 $prefix = hash("crc32", $a->get_hostname());
1468         }
1469
1470         while (strlen($prefix) < ($size - 13))
1471                 $prefix .= mt_rand();
1472
1473         if ($size >= 24) {
1474                 $prefix = substr($prefix, 0, $size - 22);
1475                 return(str_replace(".", "", uniqid($prefix, true)));
1476         } else {
1477                 $prefix = substr($prefix, 0, max($size - 13, 0));
1478                 return(uniqid($prefix));
1479         }
1480 }
1481
1482 /**
1483  * @brief Wrapper for adding a login box.
1484  *
1485  * @param bool $register
1486  *      If $register == true provide a registration link.
1487  *      This will most always depend on the value of $a->config['register_policy'].
1488  * @param bool $hiddens
1489  *
1490  * @return string
1491  *      Returns the complete html for inserting into the page
1492  *
1493  * @hooks 'login_hook'
1494  *      string $o
1495  */
1496 function login($register = false, $hiddens=false) {
1497         $a = get_app();
1498         $o = "";
1499         $reg = false;
1500         if ($register) {
1501                 $reg = array(
1502                         'title' => t('Create a New Account'),
1503                         'desc' => t('Register')
1504                 );
1505         }
1506
1507         $noid = get_config('system','no_openid');
1508
1509         $dest_url = $a->query_string;
1510
1511         if(local_user()) {
1512                 $tpl = get_markup_template("logout.tpl");
1513         }
1514         else {
1515                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1516                         '$baseurl'              => $a->get_baseurl(true)
1517                 ));
1518
1519                 $tpl = get_markup_template("login.tpl");
1520                 $_SESSION['return_url'] = $a->query_string;
1521                 $a->module = 'login';
1522         }
1523
1524         $o .= replace_macros($tpl, array(
1525
1526                 '$dest_url'     => $dest_url,
1527                 '$logout'       => t('Logout'),
1528                 '$login'        => t('Login'),
1529
1530                 '$lname'                => array('username', t('Nickname or Email address: ') , '', ''),
1531                 '$lpassword'    => array('password', t('Password: '), '', ''),
1532                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
1533
1534                 '$openid'               => !$noid,
1535                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
1536
1537                 '$hiddens'      => $hiddens,
1538
1539                 '$register'     => $reg,
1540
1541                 '$lostpass'     => t('Forgot your password?'),
1542                 '$lostlink'     => t('Password Reset'),
1543
1544                 '$tostitle'     => t('Website Terms of Service'),
1545                 '$toslink'      => t('terms of service'),
1546
1547                 '$privacytitle' => t('Website Privacy Policy'),
1548                 '$privacylink'  => t('privacy policy'),
1549
1550         ));
1551
1552         call_hooks('login_hook',$o);
1553
1554         return $o;
1555 }
1556
1557 /**
1558  * @brief Used to end the current process, after saving session state.
1559  */
1560 function killme() {
1561         session_write_close();
1562         exit;
1563 }
1564
1565 /**
1566  * @brief Redirect to another URL and terminate this process.
1567  */
1568 function goaway($s) {
1569         if (!strstr(normalise_link($s), "http://"))
1570                 $s = App::get_baseurl()."/".$s;
1571
1572         header("Location: $s");
1573         killme();
1574 }
1575
1576
1577 /**
1578  * @brief Returns the user id of locally logged in user or false.
1579  *
1580  * @return int|bool user id or false
1581  */
1582 function local_user() {
1583         if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1584                 return intval($_SESSION['uid']);
1585         return false;
1586 }
1587
1588 /**
1589  * @brief Returns contact id of authenticated site visitor or false
1590  *
1591  * @return int|bool visitor_id or false
1592  */
1593 function remote_user() {
1594         if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1595                 return intval($_SESSION['visitor_id']);
1596         return false;
1597 }
1598
1599 /**
1600  * @brief Show an error message to user.
1601  *
1602  * This function save text in session, to be shown to the user at next page load
1603  *
1604  * @param string $s - Text of notice
1605  */
1606 function notice($s) {
1607         $a = get_app();
1608         if(! x($_SESSION,'sysmsg'))     $_SESSION['sysmsg'] = array();
1609         if($a->interactive)
1610                 $_SESSION['sysmsg'][] = $s;
1611 }
1612
1613 /**
1614  * @brief Show an info message to user.
1615  *
1616  * This function save text in session, to be shown to the user at next page load
1617  *
1618  * @param string $s - Text of notice
1619  */
1620 function info($s) {
1621         $a = get_app();
1622
1623         if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1624                 return;
1625
1626         if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1627         if($a->interactive)
1628                 $_SESSION['sysmsg_info'][] = $s;
1629 }
1630
1631
1632 /**
1633  * @brief Wrapper around config to limit the text length of an incoming message
1634  *
1635  * @return int
1636  */
1637 function get_max_import_size() {
1638         global $a;
1639         return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1640 }
1641
1642 /**
1643  * @brief Wrap calls to proc_close(proc_open()) and call hook
1644  *      so plugins can take part in process :)
1645  *
1646  * @param string $cmd program to run
1647  *
1648  * next args are passed as $cmd command line
1649  * e.g.: proc_run("ls","-la","/tmp");
1650  *
1651  * @note $cmd and string args are surrounded with ""
1652  *
1653  * @hooks 'proc_run'
1654  *      array $arr
1655  */
1656 function proc_run($cmd){
1657
1658         $a = get_app();
1659
1660         $args = func_get_args();
1661
1662         $newargs = array();
1663         if(! count($args))
1664                 return;
1665
1666         // expand any arrays
1667
1668         foreach($args as $arg) {
1669                 if(is_array($arg)) {
1670                         foreach($arg as $n) {
1671                                 $newargs[] = $n;
1672                         }
1673                 }
1674                 else
1675                         $newargs[] = $arg;
1676         }
1677
1678         $args = $newargs;
1679
1680         $arr = array('args' => $args, 'run_cmd' => true);
1681
1682         call_hooks("proc_run", $arr);
1683         if(! $arr['run_cmd'])
1684                 return;
1685
1686         if(count($args) && $args[0] === 'php') {
1687
1688                 if (get_config("system", "worker")) {
1689                         $argv = $args;
1690                         array_shift($argv);
1691
1692                         $parameters = json_encode($argv);
1693                         $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1694                                         dbesc($parameters));
1695
1696                         if (!$found)
1697                                 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1698                                                         VALUES ('%s', '%s', %d)",
1699                                         dbesc($parameters),
1700                                         dbesc(datetime_convert()),
1701                                         intval(0));
1702
1703                         // Should we quit and wait for the poller to be called as a cronjob?
1704                         if (get_config("system", "worker_dont_fork"))
1705                                 return;
1706
1707                         // Checking number of workers
1708                         $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1709
1710                         // Get number of allowed number of worker threads
1711                         $queues = intval(get_config("system", "worker_queues"));
1712
1713                         if ($queues == 0)
1714                                 $queues = 4;
1715
1716                         // If there are already enough workers running, don't fork another one
1717                         if ($workers[0]["workers"] >= $queues)
1718                                 return;
1719
1720                         // Now call the poller to execute the jobs that we just added to the queue
1721                         $args = array("php", "include/poller.php", "no_cron");
1722                 }
1723
1724                 $args[0] = ((x($a->config,'php_path')) && (strlen($a->config['php_path'])) ? $a->config['php_path'] : 'php');
1725         }
1726
1727         // add baseurl to args. cli scripts can't construct it
1728         $args[] = $a->get_baseurl();
1729
1730         for($x = 0; $x < count($args); $x ++)
1731                 $args[$x] = escapeshellarg($args[$x]);
1732
1733         $cmdline = implode($args," ");
1734
1735         if(get_config('system','proc_windows'))
1736                 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1737         else
1738                 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1739 }
1740
1741 function current_theme(){
1742         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1743
1744         $a = get_app();
1745
1746         $page_theme = null;
1747
1748         // Find the theme that belongs to the user whose stuff we are looking at
1749
1750         if($a->profile_uid && ($a->profile_uid != local_user())) {
1751                 $r = q("select theme from user where uid = %d limit 1",
1752                         intval($a->profile_uid)
1753                 );
1754                 if($r)
1755                         $page_theme = $r[0]['theme'];
1756         }
1757
1758         // Allow folks to over-rule user themes and always use their own on their own site.
1759         // This works only if the user is on the same server
1760
1761         if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1762                 if(get_pconfig(local_user(),'system','always_my_theme'))
1763                         $page_theme = null;
1764         }
1765
1766 //              $mobile_detect = new Mobile_Detect();
1767 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1768         $is_mobile = $a->is_mobile || $a->is_tablet;
1769
1770         $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
1771         $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1772
1773         if($is_mobile) {
1774                 if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1775                         $system_theme = $standard_system_theme;
1776                         $theme_name = $standard_theme_name;
1777                 }
1778                 else {
1779                         $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme);
1780                         $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1781
1782                         if($theme_name === '---') {
1783                                 // user has selected to have the mobile theme be the same as the normal one
1784                                 $system_theme = $standard_system_theme;
1785                                 $theme_name = $standard_theme_name;
1786
1787                                 if($page_theme)
1788                                         $theme_name = $page_theme;
1789                         }
1790                 }
1791         }
1792         else {
1793                 $system_theme = $standard_system_theme;
1794                 $theme_name = $standard_theme_name;
1795
1796                 if($page_theme)
1797                         $theme_name = $page_theme;
1798         }
1799
1800         if($theme_name &&
1801                         (file_exists('view/theme/' . $theme_name . '/style.css') ||
1802                                         file_exists('view/theme/' . $theme_name . '/style.php')))
1803                 return($theme_name);
1804
1805         foreach($app_base_themes as $t) {
1806                 if(file_exists('view/theme/' . $t . '/style.css')||
1807                                 file_exists('view/theme/' . $t . '/style.php'))
1808                         return($t);
1809         }
1810
1811         $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
1812         if(count($fallback))
1813                 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
1814
1815 }
1816
1817 /**
1818  * @brief Return full URL to theme which is currently in effect.
1819  *
1820  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1821  *
1822  * @return string
1823  */
1824 function current_theme_url() {
1825         global $a;
1826
1827         $t = current_theme();
1828
1829         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1830         if (file_exists('view/theme/' . $t . '/style.php'))
1831                 return('view/theme/'.$t.'/style.pcss'.$opts);
1832
1833         return('view/theme/'.$t.'/style.css');
1834 }
1835
1836 function feed_birthday($uid,$tz) {
1837
1838         /**
1839          *
1840          * Determine the next birthday, but only if the birthday is published
1841          * in the default profile. We _could_ also look for a private profile that the
1842          * recipient can see, but somebody could get mad at us if they start getting
1843          * public birthday greetings when they haven't made this info public.
1844          *
1845          * Assuming we are able to publish this info, we are then going to convert
1846          * the start time from the owner's timezone to UTC.
1847          *
1848          * This will potentially solve the problem found with some social networks
1849          * where birthdays are converted to the viewer's timezone and salutations from
1850          * elsewhere in the world show up on the wrong day. We will convert it to the
1851          * viewer's timezone also, but first we are going to convert it from the birthday
1852          * person's timezone to GMT - so the viewer may find the birthday starting at
1853          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1854          *
1855          */
1856
1857
1858         $birthday = '';
1859
1860         if(! strlen($tz))
1861                 $tz = 'UTC';
1862
1863         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1864                         intval($uid)
1865         );
1866
1867         if($p && count($p)) {
1868                 $tmp_dob = substr($p[0]['dob'],5);
1869                 if(intval($tmp_dob)) {
1870                         $y = datetime_convert($tz,$tz,'now','Y');
1871                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1872                         $t_dob = strtotime($bd);
1873                         $now = strtotime(datetime_convert($tz,$tz,'now'));
1874                         if($t_dob < $now)
1875                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1876                         $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
1877                 }
1878         }
1879
1880         return $birthday;
1881 }
1882
1883 /**
1884  * @brief Check if current user has admin role.
1885  *
1886  * @return bool true if user is an admin
1887  */
1888 function is_site_admin() {
1889         $a = get_app();
1890
1891         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1892
1893         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1894         if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
1895                 return true;
1896         return false;
1897 }
1898
1899 /**
1900  * @brief Returns querystring as string from a mapped array.
1901  *
1902  * @param array $params mapped array with query parameters
1903  * @param string $name of parameter, default null
1904  *
1905  * @return string
1906  */
1907 function build_querystring($params, $name=null) {
1908         $ret = "";
1909         foreach($params as $key=>$val) {
1910                 if(is_array($val)) {
1911                         if($name==null) {
1912                                 $ret .= build_querystring($val, $key);
1913                         } else {
1914                                 $ret .= build_querystring($val, $name."[$key]");
1915                         }
1916                 } else {
1917                         $val = urlencode($val);
1918                         if($name!=null) {
1919                                 $ret.=$name."[$key]"."=$val&";
1920                         } else {
1921                                 $ret.= "$key=$val&";
1922                         }
1923                 }
1924         }
1925         return $ret;
1926 }
1927
1928 function explode_querystring($query) {
1929         $arg_st = strpos($query, '?');
1930         if($arg_st !== false) {
1931                 $base = substr($query, 0, $arg_st);
1932                 $arg_st += 1;
1933         } else {
1934                 $base = '';
1935                 $arg_st = 0;
1936         }
1937
1938         $args = explode('&', substr($query, $arg_st));
1939         foreach($args as $k=>$arg) {
1940                 if($arg === '')
1941                         unset($args[$k]);
1942         }
1943         $args = array_values($args);
1944
1945         if(!$base) {
1946                 $base = $args[0];
1947                 unset($args[0]);
1948                 $args = array_values($args);
1949         }
1950
1951         return array(
1952                 'base' => $base,
1953                 'args' => $args,
1954         );
1955 }
1956
1957 /**
1958 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1959 *
1960 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1961 */
1962 function curPageURL() {
1963         $pageURL = 'http';
1964         if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
1965         $pageURL .= "://";
1966         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1967                 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
1968         } else {
1969                 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
1970         }
1971         return $pageURL;
1972 }
1973
1974 function random_digits($digits) {
1975         $rn = '';
1976         for($i = 0; $i < $digits; $i++) {
1977                 $rn .= rand(0,9);
1978         }
1979         return $rn;
1980 }
1981
1982 function get_server() {
1983         $server = get_config("system", "directory");
1984
1985         if ($server == "")
1986                 $server = "http://dir.friendi.ca";
1987
1988         return($server);
1989 }
1990
1991 function get_cachefile($file, $writemode = true) {
1992         $cache = get_itemcachepath();
1993
1994         if ((! $cache) || (! is_dir($cache)))
1995                 return("");
1996
1997         $subfolder = $cache."/".substr($file, 0, 2);
1998
1999         $cachepath = $subfolder."/".$file;
2000
2001         if ($writemode) {
2002                 if (!is_dir($subfolder)) {
2003                         mkdir($subfolder);
2004                         chmod($subfolder, 0777);
2005                 }
2006         }
2007
2008         return($cachepath);
2009 }
2010
2011 function clear_cache($basepath = "", $path = "") {
2012         if ($path == "") {
2013                 $basepath = get_itemcachepath();
2014                 $path = $basepath;
2015         }
2016
2017         if (($path == "") OR (!is_dir($path)))
2018                 return;
2019
2020         if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2021                 return;
2022
2023         $cachetime = (int)get_config('system','itemcache_duration');
2024         if ($cachetime == 0)
2025                 $cachetime = 86400;
2026
2027         if (is_writable($path)){
2028                 if ($dh = opendir($path)) {
2029                         while (($file = readdir($dh)) !== false) {
2030                                 $fullpath = $path."/".$file;
2031                                 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2032                                         clear_cache($basepath, $fullpath);
2033                                 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2034                                         unlink($fullpath);
2035                         }
2036                         closedir($dh);
2037                 }
2038         }
2039 }
2040
2041 function get_itemcachepath() {
2042         // Checking, if the cache is deactivated
2043         $cachetime = (int)get_config('system','itemcache_duration');
2044         if ($cachetime < 0)
2045                 return "";
2046
2047         $itemcache = get_config('system','itemcache');
2048         if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2049                 return($itemcache);
2050
2051         $temppath = get_temppath();
2052
2053         if ($temppath != "") {
2054                 $itemcache = $temppath."/itemcache";
2055                 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2056                         mkdir($itemcache);
2057                 }
2058
2059                 if (is_dir($itemcache) AND is_writable($itemcache)) {
2060                         set_config("system", "itemcache", $itemcache);
2061                         return($itemcache);
2062                 }
2063         }
2064         return "";
2065 }
2066
2067 function get_lockpath() {
2068         $lockpath = get_config('system','lockpath');
2069         if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2070                 return($lockpath);
2071
2072         $temppath = get_temppath();
2073
2074         if ($temppath != "") {
2075                 $lockpath = $temppath."/lock";
2076
2077                 if (!is_dir($lockpath))
2078                         mkdir($lockpath);
2079                 elseif (!is_writable($lockpath))
2080                         $lockpath = $temppath;
2081
2082                 if (is_dir($lockpath) AND is_writable($lockpath)) {
2083                         set_config("system", "lockpath", $lockpath);
2084                         return($lockpath);
2085                 }
2086         }
2087         return "";
2088 }
2089
2090 function get_temppath() {
2091         $a = get_app();
2092
2093         $temppath = get_config("system","temppath");
2094         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2095                 return($temppath);
2096
2097         $temppath = sys_get_temp_dir();
2098         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2099                 $temppath .= "/".$a->get_hostname();
2100                 if (!is_dir($temppath))
2101                         mkdir($temppath);
2102
2103                 if (is_dir($temppath) AND is_writable($temppath)) {
2104                         set_config("system", "temppath", $temppath);
2105                         return($temppath);
2106                 }
2107         }
2108
2109         return("");
2110 }
2111
2112 function set_template_engine(&$a, $engine = 'internal') {
2113 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2114 /// to avoid breaking themes again unnecessarily
2115
2116         $a->set_template_engine($engine);
2117 }
2118
2119 if(!function_exists('exif_imagetype')) {
2120         function exif_imagetype($file) {
2121                 $size = getimagesize($file);
2122                 return($size[2]);
2123         }
2124 }
2125
2126 function validate_include(&$file) {
2127         $orig_file = $file;
2128
2129         $file = realpath($file);
2130
2131         if (strpos($file, getcwd()) !== 0)
2132                 return false;
2133
2134         $file = str_replace(getcwd()."/", "", $file, $count);
2135         if ($count != 1)
2136                 return false;
2137
2138         if ($orig_file !== $file)
2139                 return false;
2140
2141         $valid = false;
2142         if (strpos($file, "include/") === 0)
2143                 $valid = true;
2144
2145         if (strpos($file, "addon/") === 0)
2146                 $valid = true;
2147
2148         if (!$valid)
2149                 return false;
2150
2151         return true;
2152 }
2153
2154 function current_load() {
2155         if (!function_exists('sys_getloadavg'))
2156                 return false;
2157
2158         $load_arr = sys_getloadavg();
2159
2160         if (!is_array($load_arr))
2161                 return false;
2162
2163         return max($load_arr);
2164 }
2165
2166 /**
2167  * @brief get c-style args
2168  *
2169  * @return int
2170  */
2171 function argc() {
2172         return get_app()->argc;
2173 }
2174
2175 /**
2176  * @brief Returns the value of a argv key
2177  *
2178  * @param int $x argv key
2179  * @return string Value of the argv key
2180  */
2181 function argv($x) {
2182         if(array_key_exists($x,get_app()->argv))
2183                 return get_app()->argv[$x];
2184
2185         return '';
2186 }
2187
2188 /**
2189  * @brief Get the data which is needed for infinite scroll
2190  *
2191  * For invinite scroll we need the page number of the actual page
2192  * and the the URI where the content of the next page comes from.
2193  * This data is needed for the js part in main.js.
2194  * Note: infinite scroll does only work for the network page (module)
2195  *
2196  * @param string $module The name of the module (e.g. "network")
2197  * @return array Of infinite scroll data
2198  *      'pageno' => $pageno The number of the actual page
2199  *      'reload_uri' => $reload_uri The URI of the content we have to load
2200  */
2201 function infinite_scroll_data($module) {
2202
2203         if (get_pconfig(local_user(),'system','infinite_scroll')
2204                 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2205
2206                 // get the page number
2207                 if (is_string($_GET["page"]))
2208                         $pageno = $_GET["page"];
2209                 else
2210                         $pageno = 1;
2211
2212                 $reload_uri = "";
2213
2214                 // try to get the uri from which we load the content
2215                 foreach ($_GET AS $param => $value)
2216                         if (($param != "page") AND ($param != "q"))
2217                                 $reload_uri .= "&".$param."=".urlencode($value);
2218
2219                 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2220                         $reload_uri .= "&offset=".urlencode($a->page_offset);
2221
2222                 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
2223
2224                 return $arr;
2225         }
2226 }