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