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