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