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