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