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