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