]> git.mxchange.org Git - friendica.git/blob - boot.php
1b1c6a84d620b785bb0ce3066cc55a609d1a3a54
[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->performance["file"] = 0;
558                 $this->performance["file"] = 0;
559
560                 $this->callstack["database"] = array();
561                 $this->callstack["network"] = array();
562                 $this->callstack["file"] = array();
563                 $this->callstack["rendering"] = array();
564                 $this->callstack["parser"] = array();
565
566                 $this->config = array();
567                 $this->page = array();
568                 $this->pager= array();
569
570                 $this->query_string = '';
571
572                 startup();
573
574                 set_include_path(
575                                 'include' . PATH_SEPARATOR
576                                 . 'library' . PATH_SEPARATOR
577                                 . 'library/phpsec' . PATH_SEPARATOR
578                                 . 'library/langdet' . PATH_SEPARATOR
579                                 . '.' );
580
581
582                 $this->scheme = 'http';
583                 if(x($_SERVER,'HTTPS') && $_SERVER['HTTPS'])
584                         $this->scheme = 'https';
585                 elseif(x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443))
586                         $this->scheme = 'https';
587
588                 if(x($_SERVER,'SERVER_NAME')) {
589                         $this->hostname = $_SERVER['SERVER_NAME'];
590
591                         // See bug 437 - this didn't work so disabling it
592                         //if(stristr($this->hostname,'xn--')) {
593                                 // PHP or webserver may have converted idn to punycode, so
594                                 // convert punycode back to utf-8
595                         //      require_once('library/simplepie/idn/idna_convert.class.php');
596                         //      $x = new idna_convert();
597                         //      $this->hostname = $x->decode($_SERVER['SERVER_NAME']);
598                         //}
599
600                         if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
601                                 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
602                         /*
603                          * Figure out if we are running at the top of a domain
604                          * or in a sub-directory and adjust accordingly
605                          */
606
607                         $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
608                         if(isset($path) && strlen($path) && ($path != $this->path))
609                                 $this->path = $path;
610                 }
611
612                 if ($hostname != "")
613                         $this->hostname = $hostname;
614
615                 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
616                         $this->set_baseurl(array_pop($_SERVER["argv"]) );
617                         $_SERVER["argc"] --;
618                 }
619
620                 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
621
622                 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
623                         $this->query_string = substr($_SERVER['QUERY_STRING'],9);
624                         // removing trailing / - maybe a nginx problem
625                         if (substr($this->query_string, 0, 1) == "/")
626                                 $this->query_string = substr($this->query_string, 1);
627                 } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
628                         $this->query_string = substr($_SERVER['QUERY_STRING'],2);
629                         // removing trailing / - maybe a nginx problem
630                         if (substr($this->query_string, 0, 1) == "/")
631                                 $this->query_string = substr($this->query_string, 1);
632                 }
633
634                 if (x($_GET,'pagename'))
635                         $this->cmd = trim($_GET['pagename'],'/\\');
636                 elseif (x($_GET,'q'))
637                         $this->cmd = trim($_GET['q'],'/\\');
638
639
640                 // fix query_string
641                 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
642
643
644                 // unix style "homedir"
645
646                 if(substr($this->cmd,0,1) === '~')
647                         $this->cmd = 'profile/' . substr($this->cmd,1);
648
649                 // Diaspora style profile url
650
651                 if(substr($this->cmd,0,2) === 'u/')
652                         $this->cmd = 'profile/' . substr($this->cmd,2);
653
654
655                 /*
656                  *
657                  * Break the URL path into C style argc/argv style arguments for our
658                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
659                  * will be 3 (integer) and $this->argv will contain:
660                  *   [0] => 'module'
661                  *   [1] => 'arg1'
662                  *   [2] => 'arg2'
663                  *
664                  *
665                  * There will always be one argument. If provided a naked domain
666                  * URL, $this->argv[0] is set to "home".
667                  *
668                  */
669
670                 $this->argv = explode('/',$this->cmd);
671                 $this->argc = count($this->argv);
672                 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
673                         $this->module = str_replace(".", "_", $this->argv[0]);
674                         $this->module = str_replace("-", "_", $this->module);
675                 }
676                 else {
677                         $this->argc = 1;
678                         $this->argv = array('home');
679                         $this->module = 'home';
680                 }
681
682                 /*
683                  * See if there is any page number information, and initialise
684                  * pagination
685                  */
686
687                 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
688                 $this->pager['itemspage'] = 50;
689                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
690                 if($this->pager['start'] < 0)
691                         $this->pager['start'] = 0;
692                 $this->pager['total'] = 0;
693
694                 /*
695                  * Detect mobile devices
696                  */
697
698                 $mobile_detect = new Mobile_Detect();
699                 $this->is_mobile = $mobile_detect->isMobile();
700                 $this->is_tablet = $mobile_detect->isTablet();
701
702                 // Friendica-Client
703                 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
704
705                 /*
706                  * register template engines
707                  */
708                 $dc = get_declared_classes();
709                 foreach ($dc as $k) {
710                         if (in_array("ITemplateEngine", class_implements($k))){
711                                 $this->register_template_engine($k);
712                         }
713                 }
714
715         }
716
717         function get_basepath() {
718
719                 $basepath = get_config("system", "basepath");
720
721                 if ($basepath == "")
722                         $basepath = dirname(__FILE__);
723
724                 if ($basepath == "")
725                         $basepath = $_SERVER["DOCUMENT_ROOT"];
726
727                 if ($basepath == "")
728                         $basepath = $_SERVER["PWD"];
729
730                 return($basepath);
731         }
732
733         function get_scheme() {
734                 return($this->scheme);
735         }
736
737         function get_baseurl($ssl = false) {
738
739                 $scheme = $this->scheme;
740
741                 if((x($this->config,'system')) && (x($this->config['system'],'ssl_policy'))) {
742                         if(intval($this->config['system']['ssl_policy']) === intval(SSL_POLICY_FULL))
743                                 $scheme = 'https';
744
745                         //      Basically, we have $ssl = true on any links which can only be seen by a logged in user
746                         //      (and also the login link). Anything seen by an outsider will have it turned off.
747
748                         if($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) {
749                                 if($ssl)
750                                         $scheme = 'https';
751                                 else
752                                         $scheme = 'http';
753                         }
754                 }
755
756                 if (get_config('config','hostname') != "")
757                         $this->hostname = get_config('config','hostname');
758
759                 $this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
760                 return $this->baseurl;
761         }
762
763         function set_baseurl($url) {
764                 $parsed = @parse_url($url);
765
766                 $this->baseurl = $url;
767
768                 if($parsed) {
769                         $this->scheme = $parsed['scheme'];
770
771                         $hostname = $parsed['host'];
772                         if(x($parsed,'port'))
773                                 $hostname .= ':' . $parsed['port'];
774                         if(x($parsed,'path'))
775                                 $this->path = trim($parsed['path'],'\\/');
776
777                         if (file_exists(".htpreconfig.php"))
778                                 @include(".htpreconfig.php");
779
780                         if (get_config('config','hostname') != "")
781                                 $this->hostname = get_config('config','hostname');
782
783                         if (!isset($this->hostname) OR ($this->hostname == ""))
784                                 $this->hostname = $hostname;
785                 }
786
787         }
788
789         function get_hostname() {
790                 if (get_config('config','hostname') != "")
791                         $this->hostname = get_config('config','hostname');
792
793                 return $this->hostname;
794         }
795
796         function set_hostname($h) {
797                 $this->hostname = $h;
798         }
799
800         function set_path($p) {
801                 $this->path = trim(trim($p),'/');
802         }
803
804         function get_path() {
805                 return $this->path;
806         }
807
808         function set_pager_total($n) {
809                 $this->pager['total'] = intval($n);
810         }
811
812         function set_pager_itemspage($n) {
813                 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
814                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
815         }
816
817         function set_pager_page($n) {
818                 $this->pager['page'] = $n;
819                 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
820         }
821
822         function init_pagehead() {
823                 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
824
825                 // If the update is "deactivated" set it to the highest integer number (~24 days)
826                 if ($interval < 0)
827                         $interval = 2147483647;
828
829                 if($interval < 10000)
830                         $interval = 40000;
831
832                 // compose the page title from the sitename and the
833                 // current module called
834                 if (!$this->module=='')
835                 {
836                     $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
837                 } else {
838                     $this->page['title'] = $this->config['sitename'];
839                 }
840
841                 /* put the head template at the beginning of page['htmlhead']
842                  * since the code added by the modules frequently depends on it
843                  * being first
844                  */
845                 if(!isset($this->page['htmlhead']))
846                         $this->page['htmlhead'] = '';
847
848                 // If we're using Smarty, then doing replace_macros() will replace
849                 // any unrecognized variables with a blank string. Since we delay
850                 // replacing $stylesheet until later, we need to replace it now
851                 // with another variable name
852                 if($this->theme['template_engine'] === 'smarty3')
853                         $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
854                 else
855                         $stylesheet = '$stylesheet';
856
857                 $shortcut_icon = get_config("system", "shortcut_icon");
858                 if ($shortcut_icon == "")
859                         $shortcut_icon = $this->get_baseurl()."/images/friendica-32.png";
860
861                 $touch_icon = get_config("system", "touch_icon");
862                 if ($touch_icon == "")
863                         $touch_icon = $this->get_baseurl()."/images/friendica-128.png";
864
865                 $tpl = get_markup_template('head.tpl');
866                 $this->page['htmlhead'] = replace_macros($tpl,array(
867                         '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
868                         '$local_user' => local_user(),
869                         '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
870                         '$delitem' => t('Delete this item?'),
871                         '$comment' => t('Comment'),
872                         '$showmore' => t('show more'),
873                         '$showfewer' => t('show fewer'),
874                         '$update_interval' => $interval,
875                         '$shortcut_icon' => $shortcut_icon,
876                         '$touch_icon' => $touch_icon,
877                         '$stylesheet' => $stylesheet
878                 )) . $this->page['htmlhead'];
879         }
880
881         function init_page_end() {
882                 if(!isset($this->page['end']))
883                         $this->page['end'] = '';
884                 $tpl = get_markup_template('end.tpl');
885                 $this->page['end'] = replace_macros($tpl,array(
886                         '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
887                 )) . $this->page['end'];
888         }
889
890         function set_curl_code($code) {
891                 $this->curl_code = $code;
892         }
893
894         function get_curl_code() {
895                 return $this->curl_code;
896         }
897
898         function set_curl_content_type($content_type) {
899                 $this->curl_content_type = $content_type;
900         }
901
902         function get_curl_content_type() {
903                 return $this->curl_content_type;
904         }
905
906         function set_curl_headers($headers) {
907                 $this->curl_headers = $headers;
908         }
909
910         function get_curl_headers() {
911                 return $this->curl_headers;
912         }
913
914         function get_cached_avatar_image($avatar_image){
915                 return $avatar_image;
916
917                 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
918                 /*
919                 if($this->cached_profile_image[$avatar_image])
920                         return $this->cached_profile_image[$avatar_image];
921
922                 $path_parts = explode("/",$avatar_image);
923                 $common_filename = $path_parts[count($path_parts)-1];
924
925                 if($this->cached_profile_picdate[$common_filename]){
926                         $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
927                 } else {
928                         $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
929                                 $common_filename);
930                         if(! count($r)){
931                                 $this->cached_profile_image[$avatar_image] = $avatar_image;
932                         } else {
933                                 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
934                                 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
935                         }
936                 }
937                 return $this->cached_profile_image[$avatar_image];
938                 */
939         }
940
941
942         /**
943          * @brief Register template engine class
944          * 
945          * If $name is "", is used class static property $class::$name
946          * 
947          * @param string $class
948          * @param string $name
949          */
950         function register_template_engine($class, $name = '') {
951                 if ($name===""){
952                         $v = get_class_vars( $class );
953                         if(x($v,"name")) $name = $v['name'];
954                 }
955                 if ($name===""){
956                         echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
957                         killme();
958                 }
959                 $this->template_engines[$name] = $class;
960         }
961
962         /**
963          * @brief Return template engine instance.
964          * 
965          * If $name is not defined, return engine defined by theme,
966          * or default
967          *
968          * @param strin $name Template engine name
969          * @return object Template Engine instance
970          */
971         function template_engine($name = ''){
972                 if ($name!=="") {
973                         $template_engine = $name;
974                 } else {
975                         $template_engine = 'smarty3';
976                         if (x($this->theme, 'template_engine')) {
977                                 $template_engine = $this->theme['template_engine'];
978                         }
979                 }
980
981                 if (isset($this->template_engines[$template_engine])){
982                         if(isset($this->template_engine_instance[$template_engine])){
983                                 return $this->template_engine_instance[$template_engine];
984                         } else {
985                                 $class = $this->template_engines[$template_engine];
986                                 $obj = new $class;
987                                 $this->template_engine_instance[$template_engine] = $obj;
988                                 return $obj;
989                         }
990                 }
991
992                 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
993         }
994
995         /**
996          * @brief Returns the active template engine.
997          *
998          * @return string
999          */
1000         function get_template_engine() {
1001                 return $this->theme['template_engine'];
1002         }
1003
1004         function set_template_engine($engine = 'smarty3') {
1005                 $this->theme['template_engine'] = $engine;
1006                 /*
1007                 $this->theme['template_engine'] = 'smarty3';
1008
1009                 switch($engine) {
1010                         case 'smarty3':
1011                                 if(is_writable('view/smarty3/'))
1012                                         $this->theme['template_engine'] = 'smarty3';
1013                                 break;
1014                         default:
1015                                 break;
1016                 }
1017                 */
1018         }
1019
1020         function get_template_ldelim($engine = 'smarty3') {
1021                 return $this->ldelim[$engine];
1022         }
1023
1024         function get_template_rdelim($engine = 'smarty3') {
1025                 return $this->rdelim[$engine];
1026         }
1027
1028         function save_timestamp($stamp, $value) {
1029                 $duration = (float)(microtime(true)-$stamp);
1030
1031                 $this->performance[$value] += (float)$duration;
1032                 $this->performance["marktime"] += (float)$duration;
1033
1034                 // Trace the different functions with their timestamps
1035                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 5);
1036
1037                 array_shift($trace);
1038
1039                 $function = array();
1040                 foreach ($trace AS $func)
1041                         $function[] = $func["function"];
1042
1043                 $function = implode(", ", $function);
1044
1045                 //$last = array_pop($trace);
1046                 //$function = $last["function"];
1047
1048                 $this->callstack[$value][$function] += (float)$duration;
1049
1050         }
1051
1052         function mark_timestamp($mark) {
1053                 //$this->performance["markstart"] -= microtime(true) - $this->performance["marktime"];
1054                 $this->performance["markstart"] = microtime(true) - $this->performance["markstart"] - $this->performance["marktime"];
1055         }
1056
1057         function get_useragent() {
1058                 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1059         }
1060
1061         function is_friendica_app() {
1062                 return($this->is_friendica_app);
1063         }
1064
1065 }
1066
1067 /**
1068  * @brief Retrieve the App structure
1069  * 
1070  * Useful in functions which require it but don't get it passed to them
1071  */
1072 function get_app() {
1073         global $a;
1074         return $a;
1075 }
1076
1077
1078 /**
1079  * @brief Multi-purpose function to check variable state.
1080  *
1081  * Usage: x($var) or $x($array, 'key')
1082  *
1083  * returns false if variable/key is not set
1084  * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1085  * e.g. x('') or x(0) returns 0;
1086  *
1087  * @param string|array $s variable to check
1088  * @param string $k key inside the array to check
1089  *
1090  * @return bool|int
1091  */
1092 function x($s,$k = NULL) {
1093         if($k != NULL) {
1094                 if((is_array($s)) && (array_key_exists($k,$s))) {
1095                         if($s[$k])
1096                                 return (int) 1;
1097                         return (int) 0;
1098         }
1099                 return false;
1100         }
1101         else {
1102                 if(isset($s)) {
1103                         if($s) {
1104                                 return (int) 1;
1105                         }
1106                         return (int) 0;
1107                 }
1108                 return false;
1109         }
1110 }
1111
1112
1113 /**
1114  * @brief Called from db initialisation if db is dead.
1115  */
1116 function system_unavailable() {
1117         include('system_unavailable.php');
1118         system_down();
1119         killme();
1120 }
1121
1122
1123 function clean_urls() {
1124         global $a;
1125         //      if($a->config['system']['clean_urls'])
1126         return true;
1127         //      return false;
1128 }
1129
1130 function z_path() {
1131         global $a;
1132         $base = $a->get_baseurl();
1133         if(! clean_urls())
1134                 $base .= '/?q=';
1135         return $base;
1136 }
1137
1138 /**
1139  * @brief Returns the baseurl.
1140  *
1141  * @see App::get_baseurl()
1142  *
1143  * @return string
1144  */
1145 function z_root() {
1146         global $a;
1147         return $a->get_baseurl();
1148 }
1149
1150 /**
1151  * @brief Return absolut URL for given $path.
1152  *
1153  * @param string $path
1154  *
1155  * @return string
1156  */
1157 function absurl($path) {
1158         if(strpos($path,'/') === 0)
1159                 return z_path() . $path;
1160         return $path;
1161 }
1162
1163 /**
1164  * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1165  *
1166  * @return boolean
1167  */
1168 function is_ajax() {
1169         return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1170 }
1171
1172 function check_db() {
1173
1174         $build = get_config('system','build');
1175         if(! x($build)) {
1176                 set_config('system','build',DB_UPDATE_VERSION);
1177                 $build = DB_UPDATE_VERSION;
1178         }
1179         if($build != DB_UPDATE_VERSION)
1180                 proc_run('php', 'include/dbupdate.php');
1181
1182 }
1183
1184
1185 /**
1186  * Sets the base url for use in cmdline programs which don't have
1187  * $_SERVER variables
1188  */
1189 function check_url(&$a) {
1190
1191         $url = get_config('system','url');
1192
1193         // if the url isn't set or the stored url is radically different
1194         // than the currently visited url, store the current value accordingly.
1195         // "Radically different" ignores common variations such as http vs https
1196         // and www.example.com vs example.com.
1197         // We will only change the url to an ip address if there is no existing setting
1198
1199         if(! x($url))
1200                 $url = set_config('system','url',$a->get_baseurl());
1201         if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1202                 $url = set_config('system','url',$a->get_baseurl());
1203
1204         return;
1205 }
1206
1207
1208 /**
1209  * @brief Automatic database updates
1210  */
1211 function update_db(&$a) {
1212         $build = get_config('system','build');
1213         if(! x($build))
1214                 $build = set_config('system','build',DB_UPDATE_VERSION);
1215
1216         if($build != DB_UPDATE_VERSION) {
1217                 $stored = intval($build);
1218                 $current = intval(DB_UPDATE_VERSION);
1219                 if($stored < $current) {
1220                         load_config('database');
1221
1222                         // We're reporting a different version than what is currently installed.
1223                         // Run any existing update scripts to bring the database up to current.
1224
1225                         // make sure that boot.php and update.php are the same release, we might be
1226                         // updating right this very second and the correct version of the update.php
1227                         // file may not be here yet. This can happen on a very busy site.
1228
1229                         if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1230                                 // Compare the current structure with the defined structure
1231
1232                                 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1233                                 if($t !== false)
1234                                         return;
1235
1236                                 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1237
1238                                 // run old update routine (wich could modify the schema and
1239                                 // conflits with new routine)
1240                                 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1241                                         $r = run_update_function($x);
1242                                         if (!$r) break;
1243                                 }
1244                                 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1245
1246
1247                                 // run new update routine
1248                                 // it update the structure in one call
1249                                 $retval = update_structure(false, true);
1250                                 if($retval) {
1251                                         update_fail(
1252                                                 DB_UPDATE_VERSION,
1253                                                 $retval
1254                                         );
1255                                         return;
1256                                 } else {
1257                                         set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1258                                 }
1259
1260                                 // run any left update_nnnn functions in update.php
1261                                 for($x = $stored; $x < $current; $x ++) {
1262                                         $r = run_update_function($x);
1263                                         if (!$r) break;
1264                                 }
1265                         }
1266                 }
1267         }
1268
1269         return;
1270 }
1271
1272 function run_update_function($x) {
1273         if(function_exists('update_' . $x)) {
1274
1275                 // There could be a lot of processes running or about to run.
1276                 // We want exactly one process to run the update command.
1277                 // So store the fact that we're taking responsibility
1278                 // after first checking to see if somebody else already has.
1279
1280                 // If the update fails or times-out completely you may need to
1281                 // delete the config entry to try again.
1282
1283                 $t = get_config('database','update_' . $x);
1284                 if($t !== false)
1285                         return false;
1286                 set_config('database','update_' . $x, time());
1287
1288                 // call the specific update
1289
1290                 $func = 'update_' . $x;
1291                 $retval = $func();
1292
1293                 if($retval) {
1294                         //send the administrator an e-mail
1295                         update_fail(
1296                                 $x,
1297                                 sprintf(t('Update %s failed. See error logs.'), $x)
1298                         );
1299                         return false;
1300                 } else {
1301                         set_config('database','update_' . $x, 'success');
1302                         set_config('system','build', $x + 1);
1303                         return true;
1304                 }
1305         } else {
1306                 set_config('database','update_' . $x, 'success');
1307                 set_config('system','build', $x + 1);
1308                 return true;
1309         }
1310         return true;
1311 }
1312
1313 /**
1314  * @brief Synchronise plugins:
1315  *
1316  * $a->config['system']['addon'] contains a comma-separated list of names
1317  * of plugins/addons which are used on this system.
1318  * Go through the database list of already installed addons, and if we have
1319  * an entry, but it isn't in the config list, call the uninstall procedure
1320  * and mark it uninstalled in the database (for now we'll remove it).
1321  * Then go through the config list and if we have a plugin that isn't installed,
1322  * call the install procedure and add it to the database.
1323  * 
1324  * @param App $a
1325  *
1326          */
1327 function check_plugins(&$a) {
1328
1329         $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1330         if(count($r))
1331                 $installed = $r;
1332         else
1333                 $installed = array();
1334
1335         $plugins = get_config('system','addon');
1336         $plugins_arr = array();
1337
1338         if($plugins)
1339                 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1340
1341         $a->plugins = $plugins_arr;
1342
1343         $installed_arr = array();
1344
1345         if(count($installed)) {
1346                 foreach($installed as $i) {
1347                         if(! in_array($i['name'],$plugins_arr)) {
1348                                 uninstall_plugin($i['name']);
1349                         }
1350                         else {
1351                                 $installed_arr[] = $i['name'];
1352                         }
1353                 }
1354         }
1355
1356         if(count($plugins_arr)) {
1357                 foreach($plugins_arr as $p) {
1358                         if(! in_array($p,$installed_arr)) {
1359                                 install_plugin($p);
1360                         }
1361                 }
1362         }
1363
1364
1365         load_hooks();
1366
1367         return;
1368 }
1369
1370 function get_guid($size=16, $prefix = "") {
1371
1372         if ($prefix == "") {
1373                 $a = get_app();
1374                 $prefix = hash("crc32", $a->get_hostname());
1375         }
1376
1377         while (strlen($prefix) < ($size - 13))
1378                 $prefix .= mt_rand();
1379
1380         if ($size >= 24) {
1381                 $prefix = substr($prefix, 0, $size - 22);
1382                 return(str_replace(".", "", uniqid($prefix, true)));
1383         } else {
1384                 $prefix = substr($prefix, 0, max($size - 13, 0));
1385                 return(uniqid($prefix));
1386         }
1387 }
1388
1389 /** 
1390  * @brief Wrapper for adding a login box.
1391  * 
1392  * @param bool $register
1393  *      If $register == true provide a registration link.
1394  *      This will most always depend on the value of $a->config['register_policy'].
1395  * @param bool $hiddens
1396  * 
1397  * @return string
1398  *      Returns the complete html for inserting into the page
1399  * 
1400  * @hooks 'login_hook'
1401  *      string $o
1402  */
1403 function login($register = false, $hiddens=false) {
1404         $a = get_app();
1405         $o = "";
1406         $reg = false;
1407         if ($register) {
1408                 $reg = array(
1409                         'title' => t('Create a New Account'),
1410                         'desc' => t('Register')
1411                 );
1412         }
1413
1414         $noid = get_config('system','no_openid');
1415
1416         $dest_url = $a->get_baseurl(true) . '/' . $a->query_string;
1417
1418         if(local_user()) {
1419                 $tpl = get_markup_template("logout.tpl");
1420         }
1421         else {
1422                 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1423                         '$baseurl'              => $a->get_baseurl(true)
1424                 ));
1425
1426                 $tpl = get_markup_template("login.tpl");
1427                 $_SESSION['return_url'] = $a->query_string;
1428                 $a->module = 'login';
1429         }
1430
1431         $o .= replace_macros($tpl, array(
1432
1433                 '$dest_url'     => $dest_url,
1434                 '$logout'       => t('Logout'),
1435                 '$login'        => t('Login'),
1436
1437                 '$lname'                => array('username', t('Nickname or Email address: ') , '', ''),
1438                 '$lpassword'    => array('password', t('Password: '), '', ''),
1439                 '$lremember'    => array('remember', t('Remember me'), 0,  ''),
1440
1441                 '$openid'               => !$noid,
1442                 '$lopenid'      => array('openid_url', t('Or login using OpenID: '),'',''),
1443
1444                 '$hiddens'      => $hiddens,
1445
1446                 '$register'     => $reg,
1447
1448                 '$lostpass'     => t('Forgot your password?'),
1449                 '$lostlink'     => t('Password Reset'),
1450
1451                 '$tostitle'     => t('Website Terms of Service'),
1452                 '$toslink'      => t('terms of service'),
1453
1454                 '$privacytitle' => t('Website Privacy Policy'),
1455                 '$privacylink'  => t('privacy policy'),
1456
1457         ));
1458
1459         call_hooks('login_hook',$o);
1460
1461         return $o;
1462 }
1463
1464 /**
1465  * @brief Used to end the current process, after saving session state.
1466  */
1467 function killme() {
1468         session_write_close();
1469         exit;
1470 }
1471
1472 /**
1473  * @brief Redirect to another URL and terminate this process.
1474  */
1475 function goaway($s) {
1476         header("Location: $s");
1477         killme();
1478 }
1479
1480
1481 /**
1482  * @brief Returns the user id of locally logged in user or false.
1483  * 
1484  * @return int|bool user id or false
1485  */
1486 function local_user() {
1487         if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1488                 return intval($_SESSION['uid']);
1489         return false;
1490 }
1491
1492 /**
1493  * @brief Returns contact id of authenticated site visitor or false
1494  * 
1495  * @return int|bool visitor_id or false
1496  */
1497 function remote_user() {
1498         if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1499                 return intval($_SESSION['visitor_id']);
1500         return false;
1501 }
1502
1503 /**
1504  * @brief Show an error message to user.
1505  *
1506  * This function save text in session, to be shown to the user at next page load
1507  *
1508  * @param string $s - Text of notice
1509  */
1510 function notice($s) {
1511         $a = get_app();
1512         if(! x($_SESSION,'sysmsg'))     $_SESSION['sysmsg'] = array();
1513         if($a->interactive)
1514                 $_SESSION['sysmsg'][] = $s;
1515 }
1516
1517 /**
1518  * @brief Show an info message to user.
1519  *
1520  * This function save text in session, to be shown to the user at next page load
1521  *
1522  * @param string $s - Text of notice
1523  */
1524 function info($s) {
1525         $a = get_app();
1526
1527         if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1528                 return;
1529
1530         if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1531         if($a->interactive)
1532                 $_SESSION['sysmsg_info'][] = $s;
1533 }
1534
1535
1536 /**
1537  * @brief Wrapper around config to limit the text length of an incoming message
1538  *
1539  * @return int
1540  */
1541 function get_max_import_size() {
1542         global $a;
1543         return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1544 }
1545
1546 /**
1547  * @brief Wrap calls to proc_close(proc_open()) and call hook
1548  *      so plugins can take part in process :)
1549  *
1550  * @param string $cmd program to run
1551  * 
1552  * next args are passed as $cmd command line
1553  * e.g.: proc_run("ls","-la","/tmp");
1554  *
1555  * @note $cmd and string args are surrounded with ""
1556  * 
1557  * @hooks 'proc_run'
1558  *      array $arr
1559  */
1560 function proc_run($cmd){
1561
1562         $a = get_app();
1563
1564         $args = func_get_args();
1565
1566         $newargs = array();
1567         if(! count($args))
1568                 return;
1569
1570         // expand any arrays
1571
1572         foreach($args as $arg) {
1573                 if(is_array($arg)) {
1574                         foreach($arg as $n) {
1575                                 $newargs[] = $n;
1576                         }
1577                 }
1578                 else
1579                         $newargs[] = $arg;
1580         }
1581
1582         $args = $newargs;
1583
1584         $arr = array('args' => $args, 'run_cmd' => true);
1585
1586         call_hooks("proc_run", $arr);
1587         if(! $arr['run_cmd'])
1588                 return;
1589
1590         if(count($args) && $args[0] === 'php') {
1591
1592                 if (get_config("system", "worker")) {
1593                         $argv = $args;
1594                         array_shift($argv);
1595
1596                         $parameters = json_encode($argv);
1597                         $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1598                                         dbesc($parameters));
1599
1600                         if (!$found)
1601                                 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1602                                                         VALUES ('%s', '%s', %d)",
1603                                         dbesc($parameters),
1604                                         dbesc(datetime_convert()),
1605                                         intval(0));
1606
1607                         // Should we quit and wait for the poller to be called as a cronjob?
1608                         if (get_config("system", "worker_dont_fork"))
1609                                 return;
1610
1611                         // Checking number of workers
1612                         $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1613
1614                         // Get number of allowed number of worker threads
1615                         $queues = intval(get_config("system", "worker_queues"));
1616
1617                         if ($queues == 0)
1618                                 $queues = 4;
1619
1620                         // If there are already enough workers running, don't fork another one
1621                         if ($workers[0]["workers"] >= $queues)
1622                                 return;
1623
1624                         // Now call the poller to execute the jobs that we just added to the queue
1625                         $args = array("php", "include/poller.php", "no_cron");
1626                 }
1627
1628                 $args[0] = ((x($a->config,'php_path')) && (strlen($a->config['php_path'])) ? $a->config['php_path'] : 'php');
1629         }
1630
1631         // add baseurl to args. cli scripts can't construct it
1632         $args[] = $a->get_baseurl();
1633
1634         for($x = 0; $x < count($args); $x ++)
1635                 $args[$x] = escapeshellarg($args[$x]);
1636
1637         $cmdline = implode($args," ");
1638
1639         if(get_config('system','proc_windows'))
1640                 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1641         else
1642                 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1643 }
1644
1645 function current_theme(){
1646         $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1647
1648         $a = get_app();
1649
1650         $page_theme = null;
1651
1652         // Find the theme that belongs to the user whose stuff we are looking at
1653
1654         if($a->profile_uid && ($a->profile_uid != local_user())) {
1655                 $r = q("select theme from user where uid = %d limit 1",
1656                         intval($a->profile_uid)
1657                 );
1658                 if($r)
1659                         $page_theme = $r[0]['theme'];
1660         }
1661
1662         // Allow folks to over-rule user themes and always use their own on their own site.
1663         // This works only if the user is on the same server
1664
1665         if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1666                 if(get_pconfig(local_user(),'system','always_my_theme'))
1667                         $page_theme = null;
1668         }
1669
1670 //              $mobile_detect = new Mobile_Detect();
1671 //              $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1672         $is_mobile = $a->is_mobile || $a->is_tablet;
1673
1674         $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
1675         $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1676
1677         if($is_mobile) {
1678                 if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1679                         $system_theme = $standard_system_theme;
1680                         $theme_name = $standard_theme_name;
1681                 }
1682                 else {
1683                         $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme);
1684                         $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1685
1686                         if($theme_name === '---') {
1687                                 // user has selected to have the mobile theme be the same as the normal one
1688                                 $system_theme = $standard_system_theme;
1689                                 $theme_name = $standard_theme_name;
1690
1691                                 if($page_theme)
1692                                         $theme_name = $page_theme;
1693                         }
1694                 }
1695         }
1696         else {
1697                 $system_theme = $standard_system_theme;
1698                 $theme_name = $standard_theme_name;
1699
1700                 if($page_theme)
1701                         $theme_name = $page_theme;
1702         }
1703
1704         if($theme_name &&
1705                         (file_exists('view/theme/' . $theme_name . '/style.css') ||
1706                                         file_exists('view/theme/' . $theme_name . '/style.php')))
1707                 return($theme_name);
1708
1709         foreach($app_base_themes as $t) {
1710                 if(file_exists('view/theme/' . $t . '/style.css')||
1711                                 file_exists('view/theme/' . $t . '/style.php'))
1712                         return($t);
1713         }
1714
1715         $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
1716         if(count($fallback))
1717                 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
1718
1719 }
1720
1721 /**
1722  * @brief Return full URL to theme which is currently in effect.
1723  * 
1724  * Provide a sane default if nothing is chosen or the specified theme does not exist.
1725  * 
1726  * @return string
1727  */
1728 function current_theme_url() {
1729         global $a;
1730
1731         $t = current_theme();
1732
1733         $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
1734         if (file_exists('view/theme/' . $t . '/style.php'))
1735                 return($a->get_baseurl() . '/view/theme/' . $t . '/style.pcss' . $opts);
1736
1737         return($a->get_baseurl() . '/view/theme/' . $t . '/style.css');
1738 }
1739
1740 function feed_birthday($uid,$tz) {
1741
1742         /**
1743          *
1744          * Determine the next birthday, but only if the birthday is published
1745          * in the default profile. We _could_ also look for a private profile that the
1746          * recipient can see, but somebody could get mad at us if they start getting
1747          * public birthday greetings when they haven't made this info public.
1748          *
1749          * Assuming we are able to publish this info, we are then going to convert
1750          * the start time from the owner's timezone to UTC.
1751          *
1752          * This will potentially solve the problem found with some social networks
1753          * where birthdays are converted to the viewer's timezone and salutations from
1754          * elsewhere in the world show up on the wrong day. We will convert it to the
1755          * viewer's timezone also, but first we are going to convert it from the birthday
1756          * person's timezone to GMT - so the viewer may find the birthday starting at
1757          * 6:00PM the day before, but that will correspond to midnight to the birthday person.
1758          *
1759          */
1760
1761
1762         $birthday = '';
1763
1764         if(! strlen($tz))
1765                 $tz = 'UTC';
1766
1767         $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
1768                         intval($uid)
1769         );
1770
1771         if($p && count($p)) {
1772                 $tmp_dob = substr($p[0]['dob'],5);
1773                 if(intval($tmp_dob)) {
1774                         $y = datetime_convert($tz,$tz,'now','Y');
1775                         $bd = $y . '-' . $tmp_dob . ' 00:00';
1776                         $t_dob = strtotime($bd);
1777                         $now = strtotime(datetime_convert($tz,$tz,'now'));
1778                         if($t_dob < $now)
1779                                 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
1780                         $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
1781                 }
1782         }
1783
1784         return $birthday;
1785 }
1786
1787 /**
1788  * @brief Check if current user has admin role.
1789  *
1790  * @return bool true if user is an admin
1791  */
1792 function is_site_admin() {
1793         $a = get_app();
1794
1795         $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
1796
1797         //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
1798         if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
1799                 return true;
1800         return false;
1801 }
1802
1803
1804 function load_contact_links($uid) {
1805
1806         $a = get_app();
1807
1808         $ret = array();
1809
1810         if(! $uid || x($a->contacts,'empty'))
1811                 return;
1812
1813         $r = q("SELECT `id`,`network`,`url`,`thumb`, `rel` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 AND `thumb` != ''",
1814                         intval($uid)
1815         );
1816         if(count($r)) {
1817                 foreach($r as $rr){
1818                         $url = normalise_link($rr['url']);
1819                         $ret[$url] = $rr;
1820                 }
1821         } else
1822                 $ret['empty'] = true;
1823
1824         $a->contacts = $ret;
1825         return;
1826 }
1827
1828 /**
1829  * @brief Returns querystring as string from a mapped array.
1830  *
1831  * @param array $params mapped array with query parameters
1832  * @param string $name of parameter, default null
1833  *
1834  * @return string
1835  */
1836 function build_querystring($params, $name=null) {
1837         $ret = "";
1838         foreach($params as $key=>$val) {
1839                 if(is_array($val)) {
1840                         if($name==null) {
1841                                 $ret .= build_querystring($val, $key);
1842                         } else {
1843                                 $ret .= build_querystring($val, $name."[$key]");
1844                         }
1845                 } else {
1846                         $val = urlencode($val);
1847                         if($name!=null) {
1848                                 $ret.=$name."[$key]"."=$val&";
1849                         } else {
1850                                 $ret.= "$key=$val&";
1851                         }
1852                 }
1853         }
1854         return $ret;
1855 }
1856
1857 function explode_querystring($query) {
1858         $arg_st = strpos($query, '?');
1859         if($arg_st !== false) {
1860                 $base = substr($query, 0, $arg_st);
1861                 $arg_st += 1;
1862         } else {
1863                 $base = '';
1864                 $arg_st = 0;
1865         }
1866
1867         $args = explode('&', substr($query, $arg_st));
1868         foreach($args as $k=>$arg) {
1869                 if($arg === '')
1870                         unset($args[$k]);
1871         }
1872         $args = array_values($args);
1873
1874         if(!$base) {
1875                 $base = $args[0];
1876                 unset($args[0]);
1877                 $args = array_values($args);
1878         }
1879
1880         return array(
1881                 'base' => $base,
1882                 'args' => $args,
1883         );
1884 }
1885
1886 /**
1887 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
1888 *
1889 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
1890 */
1891 function curPageURL() {
1892         $pageURL = 'http';
1893         if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
1894         $pageURL .= "://";
1895         if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
1896                 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
1897         } else {
1898                 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
1899         }
1900         return $pageURL;
1901 }
1902
1903 function random_digits($digits) {
1904         $rn = '';
1905         for($i = 0; $i < $digits; $i++) {
1906                 $rn .= rand(0,9);
1907         }
1908         return $rn;
1909 }
1910
1911 function get_server() {
1912         $server = get_config("system", "directory");
1913
1914         if ($server == "")
1915                 $server = "http://dir.friendi.ca";
1916
1917         return($server);
1918 }
1919
1920 function get_cachefile($file, $writemode = true) {
1921         $cache = get_itemcachepath();
1922
1923         if ((! $cache) || (! is_dir($cache)))
1924                 return("");
1925
1926         $subfolder = $cache."/".substr($file, 0, 2);
1927
1928         $cachepath = $subfolder."/".$file;
1929
1930         if ($writemode) {
1931                 if (!is_dir($subfolder)) {
1932                         mkdir($subfolder);
1933                         chmod($subfolder, 0777);
1934                 }
1935         }
1936
1937         return($cachepath);
1938 }
1939
1940 function clear_cache($basepath = "", $path = "") {
1941         if ($path == "") {
1942                 $basepath = get_itemcachepath();
1943                 $path = $basepath;
1944         }
1945
1946         if (($path == "") OR (!is_dir($path)))
1947                 return;
1948
1949         if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
1950                 return;
1951
1952         $cachetime = (int)get_config('system','itemcache_duration');
1953         if ($cachetime == 0)
1954                 $cachetime = 86400;
1955
1956         if (is_writable($path)){
1957                 if ($dh = opendir($path)) {
1958                         while (($file = readdir($dh)) !== false) {
1959                                 $fullpath = $path."/".$file;
1960                                 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
1961                                         clear_cache($basepath, $fullpath);
1962                                 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
1963                                         unlink($fullpath);
1964                         }
1965                         closedir($dh);
1966                 }
1967         }
1968 }
1969
1970 function get_itemcachepath() {
1971         // Checking, if the cache is deactivated
1972         $cachetime = (int)get_config('system','itemcache_duration');
1973         if ($cachetime < 0)
1974                 return "";
1975
1976         $itemcache = get_config('system','itemcache');
1977         if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
1978                 return($itemcache);
1979
1980         $temppath = get_temppath();
1981
1982         if ($temppath != "") {
1983                 $itemcache = $temppath."/itemcache";
1984                 if(!file_exists($itemcache) && !is_dir($itemcache)) {
1985                         mkdir($itemcache);
1986                 }
1987
1988                 if (is_dir($itemcache) AND is_writable($itemcache)) {
1989                         set_config("system", "itemcache", $itemcache);
1990                         return($itemcache);
1991                 }
1992         }
1993         return "";
1994 }
1995
1996 function get_lockpath() {
1997         $lockpath = get_config('system','lockpath');
1998         if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
1999                 return($lockpath);
2000
2001         $temppath = get_temppath();
2002
2003         if ($temppath != "") {
2004                 $lockpath = $temppath."/lock";
2005
2006                 if (!is_dir($lockpath))
2007                         mkdir($lockpath);
2008                 elseif (!is_writable($lockpath))
2009                         $lockpath = $temppath;
2010
2011                 if (is_dir($lockpath) AND is_writable($lockpath)) {
2012                         set_config("system", "lockpath", $lockpath);
2013                         return($lockpath);
2014                 }
2015         }
2016         return "";
2017 }
2018
2019 function get_temppath() {
2020         $a = get_app();
2021
2022         $temppath = get_config("system","temppath");
2023         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2024                 return($temppath);
2025
2026         $temppath = sys_get_temp_dir();
2027         if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2028                 $temppath .= "/".$a->get_hostname();
2029                 if (!is_dir($temppath))
2030                         mkdir($temppath);
2031
2032                 if (is_dir($temppath) AND is_writable($temppath)) {
2033                         set_config("system", "temppath", $temppath);
2034                         return($temppath);
2035                 }
2036         }
2037
2038         return("");
2039 }
2040
2041 function set_template_engine(&$a, $engine = 'internal') {
2042 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2043 /// to avoid breaking themes again unnecessarily
2044
2045         $a->set_template_engine($engine);
2046 }
2047
2048 if(!function_exists('exif_imagetype')) {
2049         function exif_imagetype($file) {
2050                 $size = getimagesize($file);
2051                 return($size[2]);
2052         }
2053 }
2054
2055 function validate_include(&$file) {
2056         $orig_file = $file;
2057
2058         $file = realpath($file);
2059
2060         if (strpos($file, getcwd()) !== 0)
2061                 return false;
2062
2063         $file = str_replace(getcwd()."/", "", $file, $count);
2064         if ($count != 1)
2065                 return false;
2066
2067         if ($orig_file !== $file)
2068                 return false;
2069
2070         $valid = false;
2071         if (strpos($file, "include/") === 0)
2072                 $valid = true;
2073
2074         if (strpos($file, "addon/") === 0)
2075                 $valid = true;
2076
2077         if (!$valid)
2078                 return false;
2079
2080         return true;
2081 }
2082
2083 function current_load() {
2084         if (!function_exists('sys_getloadavg'))
2085                 return false;
2086
2087         $load_arr = sys_getloadavg();
2088
2089         if (!is_array($load_arr))
2090                 return false;
2091
2092         return max($load_arr);
2093 }
2094
2095 /**
2096  * @brief get c-style args
2097  * 
2098  * @return int
2099  */
2100 function argc() {
2101         return get_app()->argc;
2102 }
2103
2104 /**
2105  * @brief Returns the value of a argv key
2106  * 
2107  * @param int $x argv key
2108  * @return string Value of the argv key
2109  */
2110 function argv($x) {
2111         if(array_key_exists($x,get_app()->argv))
2112                 return get_app()->argv[$x];
2113
2114         return '';
2115 }