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