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