4 * This file defines some global constants and includes the central App class.
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.
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.
20 require_once('include/autoloader.php');
22 require_once('include/config.php');
23 require_once('include/network.php');
24 require_once('include/plugin.php');
25 require_once('include/text.php');
26 require_once('include/datetime.php');
27 require_once('include/pgettext.php');
28 require_once('include/nav.php');
29 require_once('include/cache.php');
30 require_once('library/Mobile_Detect/Mobile_Detect.php');
31 require_once('include/features.php');
32 require_once('include/identity.php');
33 require_once('include/pidfile.php');
34 require_once('update.php');
35 require_once('include/dbstructure.php');
37 define ( 'FRIENDICA_PLATFORM', 'Friendica');
38 define ( 'FRIENDICA_CODENAME', 'Asparagus');
39 define ( 'FRIENDICA_VERSION', '3.5.1-dev' );
40 define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
41 define ( 'DB_UPDATE_VERSION', 1206 );
44 * @brief Constant with a HTML line break.
46 * Contains a HTML line break (br) element and a real carriage return with line
47 * feed for the source.
48 * This can be used in HTML and JavaScript where needed a line break.
50 define ( 'EOL', "<br />\r\n" );
51 define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
55 * @brief Image storage quality.
57 * Lower numbers save space at cost of image detail.
58 * For ease of upgrade, please do not change here. Change jpeg quality with
59 * $a->config['system']['jpeg_quality'] = n;
60 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
65 define ( 'JPEG_QUALITY', 100 );
67 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
69 define ( 'PNG_QUALITY', 8 );
73 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
74 * length that pictures are allowed to be (for non-square pictures, it will apply
75 * to the longest side). Pictures longer than this length will be resized to be
76 * this length (on the longest side, the other side will be scaled appropriately).
77 * Modify this value using
79 * $a->config['system']['max_image_length'] = n;
83 * If you don't want to set a maximum length, set to -1. The default value is
84 * defined by 'MAX_IMAGE_LENGTH' below.
87 define ( 'MAX_IMAGE_LENGTH', -1 );
94 define ( 'DEFAULT_DB_ENGINE', 'MyISAM' );
99 * SSL redirection policies
102 define ( 'SSL_POLICY_NONE', 0 );
103 define ( 'SSL_POLICY_FULL', 1 );
104 define ( 'SSL_POLICY_SELFSIGN', 2 );
113 define ( 'LOGGER_NORMAL', 0 );
114 define ( 'LOGGER_TRACE', 1 );
115 define ( 'LOGGER_DEBUG', 2 );
116 define ( 'LOGGER_DATA', 3 );
117 define ( 'LOGGER_ALL', 4 );
126 define ( 'CACHE_MONTH', 0 );
127 define ( 'CACHE_WEEK', 1 );
128 define ( 'CACHE_DAY', 2 );
129 define ( 'CACHE_HOUR', 3 );
135 * Registration policies
138 define ( 'REGISTER_CLOSED', 0 );
139 define ( 'REGISTER_APPROVE', 1 );
140 define ( 'REGISTER_OPEN', 2 );
149 define ( 'CONTACT_IS_FOLLOWER', 1);
150 define ( 'CONTACT_IS_SHARING', 2);
151 define ( 'CONTACT_IS_FRIEND', 3);
157 * DB update return values
160 define ( 'UPDATE_SUCCESS', 0);
161 define ( 'UPDATE_FAILED', 1);
166 * @name page/profile types
168 * PAGE_NORMAL is a typical personal profile account
169 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
170 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
171 * write access to wall and comments (no email and not included in page owner's ACL lists)
172 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
176 define ( 'PAGE_NORMAL', 0 );
177 define ( 'PAGE_SOAPBOX', 1 );
178 define ( 'PAGE_COMMUNITY', 2 );
179 define ( 'PAGE_FREELOVE', 3 );
180 define ( 'PAGE_BLOG', 4 );
181 define ( 'PAGE_PRVGROUP', 5 );
185 * @name account types
187 * ACCOUNT_TYPE_PERSON - the account belongs to a person
188 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
190 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
191 * Associated page type: PAGE_SOAPBOX
193 * ACCOUNT_TYPE_NEWS - the account is a news reflector
194 * Associated page type: PAGE_SOAPBOX
196 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
197 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
200 define ( 'ACCOUNT_TYPE_PERSON', 0 );
201 define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
202 define ( 'ACCOUNT_TYPE_NEWS', 2 );
203 define ( 'ACCOUNT_TYPE_COMMUNITY', 3 );
209 * Type of the community page
212 define ( 'CP_NO_COMMUNITY_PAGE', -1 );
213 define ( 'CP_USERS_ON_SERVER', 0 );
214 define ( 'CP_GLOBAL_COMMUNITY', 1 );
220 * Network and protocol family types
223 define ( 'NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
224 define ( 'NETWORK_ZOT', 'zot!'); // Zot!
225 define ( 'NETWORK_OSTATUS', 'stat'); // status.net, identi.ca, GNU-social, other OStatus implementations
226 define ( 'NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
227 define ( 'NETWORK_DIASPORA', 'dspr'); // Diaspora
228 define ( 'NETWORK_MAIL', 'mail'); // IMAP/POP
229 define ( 'NETWORK_MAIL2', 'mai2'); // extended IMAP/POP
230 define ( 'NETWORK_FACEBOOK', 'face'); // Facebook API
231 define ( 'NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
232 define ( 'NETWORK_XMPP', 'xmpp'); // XMPP
233 define ( 'NETWORK_MYSPACE', 'mysp'); // MySpace
234 define ( 'NETWORK_GPLUS', 'goog'); // Google+
235 define ( 'NETWORK_PUMPIO', 'pump'); // pump.io
236 define ( 'NETWORK_TWITTER', 'twit'); // Twitter
237 define ( 'NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
238 define ( 'NETWORK_STATUSNET', 'stac'); // Statusnet connector
239 define ( 'NETWORK_APPNET', 'apdn'); // app.net
240 define ( 'NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol
241 define ( 'NETWORK_ICALENDAR', 'ical'); // iCalendar
242 define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
246 * These numbers are used in stored permissions
247 * and existing allocations MUST NEVER BE CHANGED
248 * OR RE-ASSIGNED! You may only add to them.
251 $netgroup_ids = array(
252 NETWORK_DFRN => (-1),
254 NETWORK_OSTATUS => (-3),
255 NETWORK_FEED => (-4),
256 NETWORK_DIASPORA => (-5),
257 NETWORK_MAIL => (-6),
258 NETWORK_MAIL2 => (-7),
259 NETWORK_FACEBOOK => (-8),
260 NETWORK_LINKEDIN => (-9),
261 NETWORK_XMPP => (-10),
262 NETWORK_MYSPACE => (-11),
263 NETWORK_GPLUS => (-12),
264 NETWORK_PUMPIO => (-13),
265 NETWORK_TWITTER => (-14),
266 NETWORK_DIASPORA2 => (-15),
267 NETWORK_STATUSNET => (-16),
268 NETWORK_APPNET => (-17),
269 NETWORK_NEWS => (-18),
270 NETWORK_ICALENDAR => (-19),
272 NETWORK_PHANTOM => (-127),
277 * Maximum number of "people who like (or don't like) this" that we will list by name
280 define ( 'MAX_LIKERS', 75);
283 * Communication timeout
286 define ( 'ZCURL_TIMEOUT' , (-1));
292 * Email notification options
295 define ( 'NOTIFY_INTRO', 0x0001 );
296 define ( 'NOTIFY_CONFIRM', 0x0002 );
297 define ( 'NOTIFY_WALL', 0x0004 );
298 define ( 'NOTIFY_COMMENT', 0x0008 );
299 define ( 'NOTIFY_MAIL', 0x0010 );
300 define ( 'NOTIFY_SUGGEST', 0x0020 );
301 define ( 'NOTIFY_PROFILE', 0x0040 );
302 define ( 'NOTIFY_TAGSELF', 0x0080 );
303 define ( 'NOTIFY_TAGSHARE', 0x0100 );
304 define ( 'NOTIFY_POKE', 0x0200 );
305 define ( 'NOTIFY_SHARE', 0x0400 );
307 define ( 'NOTIFY_SYSTEM', 0x8000 );
317 define ( 'TERM_UNKNOWN', 0 );
318 define ( 'TERM_HASHTAG', 1 );
319 define ( 'TERM_MENTION', 2 );
320 define ( 'TERM_CATEGORY', 3 );
321 define ( 'TERM_PCATEGORY', 4 );
322 define ( 'TERM_FILE', 5 );
323 define ( 'TERM_SAVEDSEARCH', 6 );
324 define ( 'TERM_CONVERSATION', 7 );
326 define ( 'TERM_OBJ_POST', 1 );
327 define ( 'TERM_OBJ_PHOTO', 2 );
334 * Various namespaces we may need to parse
337 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
338 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
339 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
340 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
341 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
342 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
343 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
344 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
345 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
346 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
347 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
348 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
349 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
350 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
351 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
357 * Activity stream defines
360 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
361 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
362 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
363 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
364 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
366 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
368 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
369 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
370 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
371 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
372 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
373 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
375 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
376 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
377 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
378 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
379 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
381 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
382 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
384 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
385 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
386 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
387 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
388 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
389 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
390 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
391 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
392 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
393 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
394 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
395 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
396 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
397 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
403 * Item weight for query ordering
406 define ( 'GRAVITY_PARENT', 0);
407 define ( 'GRAVITY_LIKE', 3);
408 define ( 'GRAVITY_COMMENT', 6);
414 * Process priority for the worker
417 define('PRIORITY_UNDEFINED', 0);
418 define('PRIORITY_CRITICAL', 10);
419 define('PRIORITY_HIGH', 20);
420 define('PRIORITY_MEDIUM', 30);
421 define('PRIORITY_LOW', 40);
422 define('PRIORITY_NEGLIGIBLE',50);
426 // Normally this constant is defined - but not if "pcntl" isn't installed
427 if (!defined("SIGTERM"))
428 define("SIGTERM", 15);
432 * Reverse the effect of magic_quotes_gpc if it is enabled.
433 * Please disable magic_quotes_gpc so we don't have to do this.
434 * See http://php.net/manual/en/security.magicquotes.disabling.php
440 error_reporting(E_ERROR | E_WARNING | E_PARSE);
444 // This has to be quite large to deal with embedded private photos
445 ini_set('pcre.backtrack_limit', 500000);
448 if (get_magic_quotes_gpc()) {
449 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
450 while (list($key, $val) = each($process)) {
451 foreach ($val as $k => $v) {
452 unset($process[$key][$k]);
454 $process[$key][stripslashes($k)] = $v;
455 $process[] = &$process[$key][stripslashes($k)];
457 $process[$key][stripslashes($k)] = stripslashes($v);
470 * @brief Our main application structure for the life of this page.
472 * Primarily deals with the URL that got us here
473 * and tries to make some sense of it, and
474 * stores our page contents and config storage
475 * and anything else that might need to be passed around
476 * before we spit the page out.
481 public $module_loaded = false;
482 public $query_string;
491 public $page_contact;
493 public $data = array();
494 public $error = false;
504 public $interactive = true;
506 public $apps = array();
508 public $is_mobile = false;
509 public $is_tablet = false;
510 public $is_friendica_app;
511 public $performance = array();
512 public $callstack = array();
513 public $theme_info = array();
514 public $backend = true;
521 // Allow themes to control internal parameters
522 // by changing App values in theme.php
524 public $sourcename = '';
525 public $videowidth = 425;
526 public $videoheight = 350;
527 public $force_max_items = 0;
528 public $theme_thread_allow = true;
529 public $theme_events_in_profile = true;
532 * @brief An array for all theme-controllable parameters
534 * Mostly unimplemented yet. Only options 'template_engine' and
537 public $theme = array(
540 'videoheight' => 350,
541 'force_max_items' => 0,
542 'thread_allow' => true,
544 'template_engine' => 'smarty3',
548 * @brief An array of registered template engines ('name'=>'class name')
550 public $template_engines = array();
552 * @brief An array of instanced template engines ('name'=>'instance')
554 public $template_engine_instance = array();
558 private $ldelim = array(
562 private $rdelim = array(
573 private $curl_content_type;
574 private $curl_headers;
576 private $cached_profile_image;
577 private $cached_profile_picdate;
582 * @brief App constructor.
584 function __construct() {
586 global $default_timezone;
590 if (file_exists(".htpreconfig.php"))
591 @include(".htpreconfig.php");
593 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
595 date_default_timezone_set($this->timezone);
597 $this->performance["start"] = microtime(true);
598 $this->performance["database"] = 0;
599 $this->performance["database_write"] = 0;
600 $this->performance["network"] = 0;
601 $this->performance["file"] = 0;
602 $this->performance["rendering"] = 0;
603 $this->performance["parser"] = 0;
604 $this->performance["marktime"] = 0;
605 $this->performance["markstart"] = microtime(true);
607 $this->callstack["database"] = array();
608 $this->callstack["network"] = array();
609 $this->callstack["file"] = array();
610 $this->callstack["rendering"] = array();
611 $this->callstack["parser"] = array();
613 $this->config = array();
614 $this->page = array();
615 $this->pager= array();
617 $this->query_string = '';
619 $this->process_id = uniqid("log", true);
624 'include' . PATH_SEPARATOR
625 . 'library' . PATH_SEPARATOR
626 . 'library/phpsec' . PATH_SEPARATOR
627 . 'library/langdet' . PATH_SEPARATOR
631 $this->scheme = 'http';
632 if((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
633 (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
634 (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
635 (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
636 (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
637 (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
639 $this->scheme = 'https';
642 if(x($_SERVER,'SERVER_NAME')) {
643 $this->hostname = $_SERVER['SERVER_NAME'];
645 if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
646 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
648 * Figure out if we are running at the top of a domain
649 * or in a sub-directory and adjust accordingly
652 $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
653 if(isset($path) && strlen($path) && ($path != $this->path))
658 $this->hostname = $hostname;
660 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
661 $this->set_baseurl(array_pop($_SERVER["argv"]) );
665 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
667 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
668 $this->query_string = substr($_SERVER['QUERY_STRING'],9);
669 // removing trailing / - maybe a nginx problem
670 if (substr($this->query_string, 0, 1) == "/")
671 $this->query_string = substr($this->query_string, 1);
672 } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
673 $this->query_string = substr($_SERVER['QUERY_STRING'],2);
674 // removing trailing / - maybe a nginx problem
675 if (substr($this->query_string, 0, 1) == "/")
676 $this->query_string = substr($this->query_string, 1);
679 if (x($_GET,'pagename'))
680 $this->cmd = trim($_GET['pagename'],'/\\');
681 elseif (x($_GET,'q'))
682 $this->cmd = trim($_GET['q'],'/\\');
686 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
689 // unix style "homedir"
691 if(substr($this->cmd,0,1) === '~')
692 $this->cmd = 'profile/' . substr($this->cmd,1);
694 // Diaspora style profile url
696 if(substr($this->cmd,0,2) === 'u/')
697 $this->cmd = 'profile/' . substr($this->cmd,2);
702 * Break the URL path into C style argc/argv style arguments for our
703 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
704 * will be 3 (integer) and $this->argv will contain:
710 * There will always be one argument. If provided a naked domain
711 * URL, $this->argv[0] is set to "home".
715 $this->argv = explode('/',$this->cmd);
716 $this->argc = count($this->argv);
717 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
718 $this->module = str_replace(".", "_", $this->argv[0]);
719 $this->module = str_replace("-", "_", $this->module);
723 $this->argv = array('home');
724 $this->module = 'home';
728 * See if there is any page number information, and initialise
732 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
733 $this->pager['itemspage'] = 50;
734 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
735 if($this->pager['start'] < 0)
736 $this->pager['start'] = 0;
737 $this->pager['total'] = 0;
740 * Detect mobile devices
743 $mobile_detect = new Mobile_Detect();
744 $this->is_mobile = $mobile_detect->isMobile();
745 $this->is_tablet = $mobile_detect->isTablet();
748 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
751 * register template engines
753 $dc = get_declared_classes();
754 foreach ($dc as $k) {
755 if (in_array("ITemplateEngine", class_implements($k))){
756 $this->register_template_engine($k);
764 function get_basepath() {
766 $basepath = get_config("system", "basepath");
769 $basepath = dirname(__FILE__);
772 $basepath = $_SERVER["DOCUMENT_ROOT"];
775 $basepath = $_SERVER["PWD"];
780 function get_scheme() {
781 return($this->scheme);
784 function get_baseurl($ssl = false) {
786 // Is the function called statically?
787 if (!is_object($this))
788 return(self::$a->get_baseurl($ssl));
790 $scheme = $this->scheme;
792 if((x($this->config,'system')) && (x($this->config['system'],'ssl_policy'))) {
793 if(intval($this->config['system']['ssl_policy']) === intval(SSL_POLICY_FULL))
796 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
797 // (and also the login link). Anything seen by an outsider will have it turned off.
799 if($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) {
807 if (get_config('config','hostname') != "")
808 $this->hostname = get_config('config','hostname');
810 $this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
811 return $this->baseurl;
814 function set_baseurl($url) {
815 $parsed = @parse_url($url);
817 $this->baseurl = $url;
820 $this->scheme = $parsed['scheme'];
822 $hostname = $parsed['host'];
823 if(x($parsed,'port'))
824 $hostname .= ':' . $parsed['port'];
825 if(x($parsed,'path'))
826 $this->path = trim($parsed['path'],'\\/');
828 if (file_exists(".htpreconfig.php"))
829 @include(".htpreconfig.php");
831 if (get_config('config','hostname') != "")
832 $this->hostname = get_config('config','hostname');
834 if (!isset($this->hostname) OR ($this->hostname == ""))
835 $this->hostname = $hostname;
840 function get_hostname() {
841 if (get_config('config','hostname') != "")
842 $this->hostname = get_config('config','hostname');
844 return $this->hostname;
847 function set_hostname($h) {
848 $this->hostname = $h;
851 function set_path($p) {
852 $this->path = trim(trim($p),'/');
855 function get_path() {
859 function set_pager_total($n) {
860 $this->pager['total'] = intval($n);
863 function set_pager_itemspage($n) {
864 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
865 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
868 function set_pager_page($n) {
869 $this->pager['page'] = $n;
870 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
873 function init_pagehead() {
874 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
876 // If the update is "deactivated" set it to the highest integer number (~24 days)
878 $interval = 2147483647;
880 if($interval < 10000)
883 // compose the page title from the sitename and the
884 // current module called
885 if (!$this->module=='')
887 $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
889 $this->page['title'] = $this->config['sitename'];
892 /* put the head template at the beginning of page['htmlhead']
893 * since the code added by the modules frequently depends on it
896 if(!isset($this->page['htmlhead']))
897 $this->page['htmlhead'] = '';
899 // If we're using Smarty, then doing replace_macros() will replace
900 // any unrecognized variables with a blank string. Since we delay
901 // replacing $stylesheet until later, we need to replace it now
902 // with another variable name
903 if($this->theme['template_engine'] === 'smarty3')
904 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
906 $stylesheet = '$stylesheet';
908 $shortcut_icon = get_config("system", "shortcut_icon");
909 if ($shortcut_icon == "")
910 $shortcut_icon = "images/friendica-32.png";
912 $touch_icon = get_config("system", "touch_icon");
913 if ($touch_icon == "")
914 $touch_icon = "images/friendica-128.png";
916 // get data wich is needed for infinite scroll on the network page
917 $invinite_scroll = infinite_scroll_data($this->module);
919 $tpl = get_markup_template('head.tpl');
920 $this->page['htmlhead'] = replace_macros($tpl,array(
921 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
922 '$local_user' => local_user(),
923 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
924 '$delitem' => t('Delete this item?'),
925 '$comment' => t('Comment'),
926 '$showmore' => t('show more'),
927 '$showfewer' => t('show fewer'),
928 '$update_interval' => $interval,
929 '$shortcut_icon' => $shortcut_icon,
930 '$touch_icon' => $touch_icon,
931 '$stylesheet' => $stylesheet,
932 '$infinite_scroll' => $invinite_scroll,
933 )) . $this->page['htmlhead'];
936 function init_page_end() {
937 if(!isset($this->page['end']))
938 $this->page['end'] = '';
939 $tpl = get_markup_template('end.tpl');
940 $this->page['end'] = replace_macros($tpl,array(
941 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
942 )) . $this->page['end'];
945 function set_curl_code($code) {
946 $this->curl_code = $code;
949 function get_curl_code() {
950 return $this->curl_code;
953 function set_curl_content_type($content_type) {
954 $this->curl_content_type = $content_type;
957 function get_curl_content_type() {
958 return $this->curl_content_type;
961 function set_curl_headers($headers) {
962 $this->curl_headers = $headers;
965 function get_curl_headers() {
966 return $this->curl_headers;
969 function get_cached_avatar_image($avatar_image){
970 return $avatar_image;
972 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
974 if($this->cached_profile_image[$avatar_image])
975 return $this->cached_profile_image[$avatar_image];
977 $path_parts = explode("/",$avatar_image);
978 $common_filename = $path_parts[count($path_parts)-1];
980 if($this->cached_profile_picdate[$common_filename]){
981 $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
983 $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
985 if(! dbm::is_result($r)){
986 $this->cached_profile_image[$avatar_image] = $avatar_image;
988 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
989 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
992 return $this->cached_profile_image[$avatar_image];
998 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1000 * @param string $url
1002 * @return string The cleaned url
1004 function remove_baseurl($url){
1006 // Is the function called statically?
1007 if (!is_object($this))
1008 return(self::$a->remove_baseurl($url));
1010 $url = normalise_link($url);
1011 $base = normalise_link($this->get_baseurl());
1012 $url = str_replace($base."/", "", $url);
1017 * @brief Register template engine class
1019 * If $name is "", is used class static property $class::$name
1021 * @param string $class
1022 * @param string $name
1024 function register_template_engine($class, $name = '') {
1026 $v = get_class_vars( $class );
1027 if(x($v,"name")) $name = $v['name'];
1030 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1033 $this->template_engines[$name] = $class;
1037 * @brief Return template engine instance.
1039 * If $name is not defined, return engine defined by theme,
1042 * @param strin $name Template engine name
1043 * @return object Template Engine instance
1045 function template_engine($name = ''){
1047 $template_engine = $name;
1049 $template_engine = 'smarty3';
1050 if (x($this->theme, 'template_engine')) {
1051 $template_engine = $this->theme['template_engine'];
1055 if (isset($this->template_engines[$template_engine])){
1056 if(isset($this->template_engine_instance[$template_engine])){
1057 return $this->template_engine_instance[$template_engine];
1059 $class = $this->template_engines[$template_engine];
1061 $this->template_engine_instance[$template_engine] = $obj;
1066 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1070 * @brief Returns the active template engine.
1074 function get_template_engine() {
1075 return $this->theme['template_engine'];
1078 function set_template_engine($engine = 'smarty3') {
1079 $this->theme['template_engine'] = $engine;
1081 $this->theme['template_engine'] = 'smarty3';
1085 if(is_writable('view/smarty3/'))
1086 $this->theme['template_engine'] = 'smarty3';
1094 function get_template_ldelim($engine = 'smarty3') {
1095 return $this->ldelim[$engine];
1098 function get_template_rdelim($engine = 'smarty3') {
1099 return $this->rdelim[$engine];
1102 function save_timestamp($stamp, $value) {
1103 $duration = (float)(microtime(true)-$stamp);
1105 if (!isset($this->performance[$value])) {
1106 // Prevent ugly E_NOTICE
1107 $this->performance[$value] = 0;
1110 $this->performance[$value] += (float)$duration;
1111 $this->performance["marktime"] += (float)$duration;
1113 $callstack = $this->callstack();
1115 if (!isset($this->callstack[$value][$callstack])) {
1116 // Prevent ugly E_NOTICE
1117 $this->callstack[$value][$callstack] = 0;
1120 $this->callstack[$value][$callstack] += (float)$duration;
1125 * @brief Log active processes into the "process" table
1127 function start_process() {
1128 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1130 $command = basename($trace[0]["file"]);
1132 $this->remove_inactive_processes();
1134 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1135 if(!dbm::is_result($r))
1136 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1139 dbesc(datetime_convert()));
1143 * @brief Remove inactive processes
1145 function remove_inactive_processes() {
1146 $r = q("SELECT `pid` FROM `process`");
1147 if(dbm::is_result($r))
1148 foreach ($r AS $process)
1149 if (!posix_kill($process["pid"], 0))
1150 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1154 * @brief Remove the active process from the "process" table
1156 function end_process() {
1157 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1161 * @brief Returns a string with a callstack. Can be used for logging.
1165 function callstack() {
1166 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1168 // We remove the first two items from the list since they contain data that we don't need.
1169 array_shift($trace);
1170 array_shift($trace);
1172 $callstack = array();
1173 foreach ($trace AS $func)
1174 $callstack[] = $func["function"];
1176 return implode(", ", $callstack);
1179 function mark_timestamp($mark) {
1180 //$this->performance["markstart"] -= microtime(true) - $this->performance["marktime"];
1181 $this->performance["markstart"] = microtime(true) - $this->performance["markstart"] - $this->performance["marktime"];
1184 function get_useragent() {
1185 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1188 function is_friendica_app() {
1189 return($this->is_friendica_app);
1193 * @brief Checks if the site is called via a backend process
1195 * This isn't a perfect solution. But we need this check very early.
1196 * So we cannot wait until the modules are loaded.
1198 * @return bool Is it a known backend?
1200 function is_backend() {
1202 $backend[] = "_well_known";
1204 $backend[] = "dfrn_notify";
1205 $backend[] = "fetch";
1206 $backend[] = "hcard";
1207 $backend[] = "hostxrd";
1208 $backend[] = "nodeinfo";
1209 $backend[] = "noscrape";
1211 $backend[] = "poco";
1212 $backend[] = "post";
1213 $backend[] = "proxy";
1214 $backend[] = "pubsub";
1215 $backend[] = "pubsubhubbub";
1216 $backend[] = "receive";
1217 $backend[] = "rsd_xml";
1218 $backend[] = "salmon";
1219 $backend[] = "statistics_json";
1222 if (in_array($this->module, $backend))
1225 return($this->backend);
1229 * @brief Checks if the maximum number of database processes is reached
1231 * @return bool Is the limit reached?
1233 function max_processes_reached() {
1235 // Is the function called statically?
1236 if (!is_object($this))
1237 return(self::$a->max_processes_reached());
1239 if ($this->is_backend()) {
1240 $process = "backend";
1241 $max_processes = get_config('system', 'max_processes_backend');
1242 if (intval($max_processes) == 0)
1245 $process = "frontend";
1246 $max_processes = get_config('system', 'max_processes_frontend');
1247 if (intval($max_processes) == 0)
1248 $max_processes = 20;
1251 $processlist = dbm::processlist();
1252 if ($processlist["list"] != "") {
1253 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1255 if ($processlist["amount"] > $max_processes) {
1256 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1264 * @brief Checks if the maximum load is reached
1266 * @return bool Is the load reached?
1268 function maxload_reached() {
1270 // Is the function called statically?
1271 if (!is_object($this))
1272 return(self::$a->maxload_reached());
1274 if ($this->is_backend()) {
1275 $process = "backend";
1276 $maxsysload = intval(get_config('system', 'maxloadavg'));
1277 if ($maxsysload < 1)
1280 $process = "frontend";
1281 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1282 if ($maxsysload < 1)
1286 $load = current_load();
1288 if (intval($load) > $maxsysload) {
1289 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1297 * @brief Checks if the process is already running
1299 * @param string $taskname The name of the task that will be used for the name of the lockfile
1300 * @param string $task The path and name of the php script
1301 * @param int $timeout The timeout after which a task should be killed
1303 * @return bool Is the process running?
1305 function is_already_running($taskname, $task = "", $timeout = 540) {
1307 $lockpath = get_lockpath();
1308 if ($lockpath != '') {
1309 $pidfile = new pidfile($lockpath, $taskname);
1310 if ($pidfile->is_already_running()) {
1311 logger("Already running");
1312 if ($pidfile->running_time() > $timeout) {
1314 logger("killed stale process");
1315 // Calling a new instance
1317 proc_run(PRIORITY_MEDIUM, $task);
1325 function proc_run($args) {
1327 // Add the php path if it is a php call
1328 if (count($args) && ($args[0] === 'php' OR is_int($args[0]))) {
1330 // If the last worker fork was less than 10 seconds before then don't fork another one.
1331 // This should prevent the forking of masses of workers.
1332 if (get_config("system", "worker")) {
1333 if ((time() - get_config("system", "proc_run_started")) < 10)
1336 // Set the timestamp of the last proc_run
1337 set_config("system", "proc_run_started", time());
1340 $args[0] = ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php');
1343 // add baseurl to args. cli scripts can't construct it
1344 $args[] = $this->get_baseurl();
1346 for($x = 0; $x < count($args); $x ++)
1347 $args[$x] = escapeshellarg($args[$x]);
1349 $cmdline = implode($args," ");
1351 if(get_config('system','proc_windows'))
1352 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1354 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1360 * @brief Retrieve the App structure
1362 * Useful in functions which require it but don't get it passed to them
1364 function get_app() {
1371 * @brief Multi-purpose function to check variable state.
1373 * Usage: x($var) or $x($array, 'key')
1375 * returns false if variable/key is not set
1376 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1377 * e.g. x('') or x(0) returns 0;
1379 * @param string|array $s variable to check
1380 * @param string $k key inside the array to check
1384 function x($s,$k = NULL) {
1386 if((is_array($s)) && (array_key_exists($k,$s))) {
1406 * @brief Called from db initialisation if db is dead.
1408 function system_unavailable() {
1409 include('system_unavailable.php');
1415 function clean_urls() {
1417 // if($a->config['system']['clean_urls'])
1424 $base = $a->get_baseurl();
1431 * @brief Returns the baseurl.
1433 * @see App::get_baseurl()
1439 return $a->get_baseurl();
1443 * @brief Return absolut URL for given $path.
1445 * @param string $path
1449 function absurl($path) {
1450 if(strpos($path,'/') === 0)
1451 return z_path() . $path;
1456 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1460 function is_ajax() {
1461 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1464 function check_db() {
1466 $build = get_config('system','build');
1468 set_config('system','build',DB_UPDATE_VERSION);
1469 $build = DB_UPDATE_VERSION;
1471 if($build != DB_UPDATE_VERSION)
1472 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1478 * Sets the base url for use in cmdline programs which don't have
1479 * $_SERVER variables
1481 function check_url(&$a) {
1483 $url = get_config('system','url');
1485 // if the url isn't set or the stored url is radically different
1486 // than the currently visited url, store the current value accordingly.
1487 // "Radically different" ignores common variations such as http vs https
1488 // and www.example.com vs example.com.
1489 // We will only change the url to an ip address if there is no existing setting
1492 $url = set_config('system','url',$a->get_baseurl());
1493 if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1494 $url = set_config('system','url',$a->get_baseurl());
1501 * @brief Automatic database updates
1503 function update_db(&$a) {
1504 $build = get_config('system','build');
1506 $build = set_config('system','build',DB_UPDATE_VERSION);
1508 if($build != DB_UPDATE_VERSION) {
1509 $stored = intval($build);
1510 $current = intval(DB_UPDATE_VERSION);
1511 if($stored < $current) {
1512 load_config('database');
1514 // We're reporting a different version than what is currently installed.
1515 // Run any existing update scripts to bring the database up to current.
1517 // make sure that boot.php and update.php are the same release, we might be
1518 // updating right this very second and the correct version of the update.php
1519 // file may not be here yet. This can happen on a very busy site.
1521 if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1522 // Compare the current structure with the defined structure
1524 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1528 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1530 // run old update routine (wich could modify the schema and
1531 // conflits with new routine)
1532 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1533 $r = run_update_function($x);
1536 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1539 // run new update routine
1540 // it update the structure in one call
1541 $retval = update_structure(false, true);
1549 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1552 // run any left update_nnnn functions in update.php
1553 for($x = $stored; $x < $current; $x ++) {
1554 $r = run_update_function($x);
1564 function run_update_function($x) {
1565 if(function_exists('update_' . $x)) {
1567 // There could be a lot of processes running or about to run.
1568 // We want exactly one process to run the update command.
1569 // So store the fact that we're taking responsibility
1570 // after first checking to see if somebody else already has.
1572 // If the update fails or times-out completely you may need to
1573 // delete the config entry to try again.
1575 $t = get_config('database','update_' . $x);
1578 set_config('database','update_' . $x, time());
1580 // call the specific update
1582 $func = 'update_' . $x;
1586 //send the administrator an e-mail
1589 sprintf(t('Update %s failed. See error logs.'), $x)
1593 set_config('database','update_' . $x, 'success');
1594 set_config('system','build', $x + 1);
1598 set_config('database','update_' . $x, 'success');
1599 set_config('system','build', $x + 1);
1606 * @brief Synchronise plugins:
1608 * $a->config['system']['addon'] contains a comma-separated list of names
1609 * of plugins/addons which are used on this system.
1610 * Go through the database list of already installed addons, and if we have
1611 * an entry, but it isn't in the config list, call the uninstall procedure
1612 * and mark it uninstalled in the database (for now we'll remove it).
1613 * Then go through the config list and if we have a plugin that isn't installed,
1614 * call the install procedure and add it to the database.
1619 function check_plugins(&$a) {
1621 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1622 if(dbm::is_result($r))
1625 $installed = array();
1627 $plugins = get_config('system','addon');
1628 $plugins_arr = array();
1631 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1633 $a->plugins = $plugins_arr;
1635 $installed_arr = array();
1637 if(count($installed)) {
1638 foreach($installed as $i) {
1639 if(! in_array($i['name'],$plugins_arr)) {
1640 uninstall_plugin($i['name']);
1643 $installed_arr[] = $i['name'];
1648 if(count($plugins_arr)) {
1649 foreach($plugins_arr as $p) {
1650 if(! in_array($p,$installed_arr)) {
1662 function get_guid($size=16, $prefix = "") {
1664 if ($prefix == "") {
1666 $prefix = hash("crc32", $a->get_hostname());
1669 while (strlen($prefix) < ($size - 13))
1670 $prefix .= mt_rand();
1673 $prefix = substr($prefix, 0, $size - 22);
1674 return(str_replace(".", "", uniqid($prefix, true)));
1676 $prefix = substr($prefix, 0, max($size - 13, 0));
1677 return(uniqid($prefix));
1682 * @brief Wrapper for adding a login box.
1684 * @param bool $register
1685 * If $register == true provide a registration link.
1686 * This will most always depend on the value of $a->config['register_policy'].
1687 * @param bool $hiddens
1690 * Returns the complete html for inserting into the page
1692 * @hooks 'login_hook'
1695 function login($register = false, $hiddens=false) {
1701 'title' => t('Create a New Account'),
1702 'desc' => t('Register')
1706 $noid = get_config('system','no_openid');
1708 $dest_url = $a->query_string;
1711 $tpl = get_markup_template("logout.tpl");
1714 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1715 '$baseurl' => $a->get_baseurl(true)
1718 $tpl = get_markup_template("login.tpl");
1719 $_SESSION['return_url'] = $a->query_string;
1720 $a->module = 'login';
1723 $o .= replace_macros($tpl, array(
1725 '$dest_url' => $dest_url,
1726 '$logout' => t('Logout'),
1727 '$login' => t('Login'),
1729 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1730 '$lpassword' => array('password', t('Password: '), '', ''),
1731 '$lremember' => array('remember', t('Remember me'), 0, ''),
1733 '$openid' => !$noid,
1734 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1736 '$hiddens' => $hiddens,
1738 '$register' => $reg,
1740 '$lostpass' => t('Forgot your password?'),
1741 '$lostlink' => t('Password Reset'),
1743 '$tostitle' => t('Website Terms of Service'),
1744 '$toslink' => t('terms of service'),
1746 '$privacytitle' => t('Website Privacy Policy'),
1747 '$privacylink' => t('privacy policy'),
1751 call_hooks('login_hook',$o);
1757 * @brief Used to end the current process, after saving session state.
1761 if (!get_app()->is_backend())
1762 session_write_close();
1768 * @brief Redirect to another URL and terminate this process.
1770 function goaway($s) {
1771 if (!strstr(normalise_link($s), "http://"))
1772 $s = App::get_baseurl()."/".$s;
1774 header("Location: $s");
1780 * @brief Returns the user id of locally logged in user or false.
1782 * @return int|bool user id or false
1784 function local_user() {
1785 if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1786 return intval($_SESSION['uid']);
1791 * @brief Returns contact id of authenticated site visitor or false
1793 * @return int|bool visitor_id or false
1795 function remote_user() {
1796 if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1797 return intval($_SESSION['visitor_id']);
1802 * @brief Show an error message to user.
1804 * This function save text in session, to be shown to the user at next page load
1806 * @param string $s - Text of notice
1808 function notice($s) {
1810 if(! x($_SESSION,'sysmsg')) $_SESSION['sysmsg'] = array();
1812 $_SESSION['sysmsg'][] = $s;
1816 * @brief Show an info message to user.
1818 * This function save text in session, to be shown to the user at next page load
1820 * @param string $s - Text of notice
1825 if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1828 if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1830 $_SESSION['sysmsg_info'][] = $s;
1835 * @brief Wrapper around config to limit the text length of an incoming message
1839 function get_max_import_size() {
1841 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1845 * @brief Wrap calls to proc_close(proc_open()) and call hook
1846 * so plugins can take part in process :)
1848 * @param (string|integer) $cmd program to run or priority
1850 * next args are passed as $cmd command line
1851 * e.g.: proc_run("ls","-la","/tmp");
1852 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1854 * @note $cmd and string args are surrounded with ""
1859 function proc_run($cmd){
1863 $args = func_get_args();
1869 // expand any arrays
1871 foreach($args as $arg) {
1872 if(is_array($arg)) {
1873 foreach($arg as $n) {
1882 $arr = array('args' => $args, 'run_cmd' => true);
1884 call_hooks("proc_run", $arr);
1885 if (!$arr['run_cmd'] OR !count($args))
1888 if (!get_config("system", "worker") OR
1889 (($args[0] != 'php') AND !is_int($args[0]))) {
1890 $a->proc_run($args);
1894 if (is_int($args[0]))
1895 $priority = $args[0];
1897 $priority = PRIORITY_MEDIUM;
1902 $parameters = json_encode($argv);
1903 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1904 dbesc($parameters));
1907 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1908 VALUES ('%s', '%s', %d)",
1910 dbesc(datetime_convert()),
1913 // Should we quit and wait for the poller to be called as a cronjob?
1914 if (get_config("system", "worker_dont_fork"))
1917 // Checking number of workers
1918 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1920 // Get number of allowed number of worker threads
1921 $queues = intval(get_config("system", "worker_queues"));
1926 // If there are already enough workers running, don't fork another one
1927 if ($workers[0]["workers"] >= $queues)
1930 // Now call the poller to execute the jobs that we just added to the queue
1931 $args = array("php", "include/poller.php", "no_cron");
1933 $a->proc_run($args);
1936 function current_theme(){
1937 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1943 // Find the theme that belongs to the user whose stuff we are looking at
1945 if($a->profile_uid && ($a->profile_uid != local_user())) {
1946 $r = q("select theme from user where uid = %d limit 1",
1947 intval($a->profile_uid)
1949 if(dbm::is_result($r))
1950 $page_theme = $r[0]['theme'];
1953 // Allow folks to over-rule user themes and always use their own on their own site.
1954 // This works only if the user is on the same server
1956 if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1957 if(get_pconfig(local_user(),'system','always_my_theme'))
1961 // $mobile_detect = new Mobile_Detect();
1962 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1963 $is_mobile = $a->is_mobile || $a->is_tablet;
1965 $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
1966 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1969 if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1970 $system_theme = $standard_system_theme;
1971 $theme_name = $standard_theme_name;
1974 $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme);
1975 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1977 if($theme_name === '---') {
1978 // user has selected to have the mobile theme be the same as the normal one
1979 $system_theme = $standard_system_theme;
1980 $theme_name = $standard_theme_name;
1983 $theme_name = $page_theme;
1988 $system_theme = $standard_system_theme;
1989 $theme_name = $standard_theme_name;
1992 $theme_name = $page_theme;
1996 (file_exists('view/theme/' . $theme_name . '/style.css') ||
1997 file_exists('view/theme/' . $theme_name . '/style.php')))
1998 return($theme_name);
2000 foreach($app_base_themes as $t) {
2001 if(file_exists('view/theme/' . $t . '/style.css')||
2002 file_exists('view/theme/' . $t . '/style.php'))
2006 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2007 if(count($fallback))
2008 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2013 * @brief Return full URL to theme which is currently in effect.
2015 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2019 function current_theme_url() {
2022 $t = current_theme();
2024 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2025 if (file_exists('view/theme/' . $t . '/style.php'))
2026 return('view/theme/'.$t.'/style.pcss'.$opts);
2028 return('view/theme/'.$t.'/style.css');
2031 function feed_birthday($uid,$tz) {
2035 * Determine the next birthday, but only if the birthday is published
2036 * in the default profile. We _could_ also look for a private profile that the
2037 * recipient can see, but somebody could get mad at us if they start getting
2038 * public birthday greetings when they haven't made this info public.
2040 * Assuming we are able to publish this info, we are then going to convert
2041 * the start time from the owner's timezone to UTC.
2043 * This will potentially solve the problem found with some social networks
2044 * where birthdays are converted to the viewer's timezone and salutations from
2045 * elsewhere in the world show up on the wrong day. We will convert it to the
2046 * viewer's timezone also, but first we are going to convert it from the birthday
2047 * person's timezone to GMT - so the viewer may find the birthday starting at
2048 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2058 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2062 if(dbm::is_result($p)) {
2063 $tmp_dob = substr($p[0]['dob'],5);
2064 if(intval($tmp_dob)) {
2065 $y = datetime_convert($tz,$tz,'now','Y');
2066 $bd = $y . '-' . $tmp_dob . ' 00:00';
2067 $t_dob = strtotime($bd);
2068 $now = strtotime(datetime_convert($tz,$tz,'now'));
2070 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2071 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2079 * @brief Check if current user has admin role.
2081 * @return bool true if user is an admin
2083 function is_site_admin() {
2086 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2088 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2089 if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2095 * @brief Returns querystring as string from a mapped array.
2097 * @param array $params mapped array with query parameters
2098 * @param string $name of parameter, default null
2102 function build_querystring($params, $name=null) {
2104 foreach($params as $key=>$val) {
2105 if(is_array($val)) {
2107 $ret .= build_querystring($val, $key);
2109 $ret .= build_querystring($val, $name."[$key]");
2112 $val = urlencode($val);
2114 $ret.=$name."[$key]"."=$val&";
2116 $ret.= "$key=$val&";
2123 function explode_querystring($query) {
2124 $arg_st = strpos($query, '?');
2125 if($arg_st !== false) {
2126 $base = substr($query, 0, $arg_st);
2133 $args = explode('&', substr($query, $arg_st));
2134 foreach($args as $k=>$arg) {
2138 $args = array_values($args);
2143 $args = array_values($args);
2153 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2155 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2157 function curPageURL() {
2159 if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
2161 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2162 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2164 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2169 function random_digits($digits) {
2171 for($i = 0; $i < $digits; $i++) {
2177 function get_server() {
2178 $server = get_config("system", "directory");
2181 $server = "http://dir.friendi.ca";
2186 function get_cachefile($file, $writemode = true) {
2187 $cache = get_itemcachepath();
2189 if ((! $cache) || (! is_dir($cache)))
2192 $subfolder = $cache."/".substr($file, 0, 2);
2194 $cachepath = $subfolder."/".$file;
2197 if (!is_dir($subfolder)) {
2199 chmod($subfolder, 0777);
2206 function clear_cache($basepath = "", $path = "") {
2208 $basepath = get_itemcachepath();
2212 if (($path == "") OR (!is_dir($path)))
2215 if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2218 $cachetime = (int)get_config('system','itemcache_duration');
2219 if ($cachetime == 0)
2222 if (is_writable($path)){
2223 if ($dh = opendir($path)) {
2224 while (($file = readdir($dh)) !== false) {
2225 $fullpath = $path."/".$file;
2226 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2227 clear_cache($basepath, $fullpath);
2228 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2236 function get_itemcachepath() {
2237 // Checking, if the cache is deactivated
2238 $cachetime = (int)get_config('system','itemcache_duration');
2242 $itemcache = get_config('system','itemcache');
2243 if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2246 $temppath = get_temppath();
2248 if ($temppath != "") {
2249 $itemcache = $temppath."/itemcache";
2250 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2254 if (is_dir($itemcache) AND is_writable($itemcache)) {
2255 set_config("system", "itemcache", $itemcache);
2262 function get_lockpath() {
2263 $lockpath = get_config('system','lockpath');
2264 if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2267 $temppath = get_temppath();
2269 if ($temppath != "") {
2270 $lockpath = $temppath."/lock";
2272 if (!is_dir($lockpath))
2274 elseif (!is_writable($lockpath))
2275 $lockpath = $temppath;
2277 if (is_dir($lockpath) AND is_writable($lockpath)) {
2278 set_config("system", "lockpath", $lockpath);
2285 function get_temppath() {
2288 $temppath = get_config("system","temppath");
2289 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2292 $temppath = sys_get_temp_dir();
2293 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2294 $temppath .= "/".$a->get_hostname();
2295 if (!is_dir($temppath))
2298 if (is_dir($temppath) AND is_writable($temppath)) {
2299 set_config("system", "temppath", $temppath);
2307 function set_template_engine(&$a, $engine = 'internal') {
2308 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2309 /// to avoid breaking themes again unnecessarily
2311 $a->set_template_engine($engine);
2314 if(!function_exists('exif_imagetype')) {
2315 function exif_imagetype($file) {
2316 $size = getimagesize($file);
2321 function validate_include(&$file) {
2324 $file = realpath($file);
2326 if (strpos($file, getcwd()) !== 0)
2329 $file = str_replace(getcwd()."/", "", $file, $count);
2333 if ($orig_file !== $file)
2337 if (strpos($file, "include/") === 0)
2340 if (strpos($file, "addon/") === 0)
2349 function current_load() {
2350 if (!function_exists('sys_getloadavg'))
2353 $load_arr = sys_getloadavg();
2355 if (!is_array($load_arr))
2358 return max($load_arr[0], $load_arr[1]);
2362 * @brief get c-style args
2367 return get_app()->argc;
2371 * @brief Returns the value of a argv key
2373 * @param int $x argv key
2374 * @return string Value of the argv key
2377 if(array_key_exists($x,get_app()->argv))
2378 return get_app()->argv[$x];
2384 * @brief Get the data which is needed for infinite scroll
2386 * For invinite scroll we need the page number of the actual page
2387 * and the the URI where the content of the next page comes from.
2388 * This data is needed for the js part in main.js.
2389 * Note: infinite scroll does only work for the network page (module)
2391 * @param string $module The name of the module (e.g. "network")
2392 * @return array Of infinite scroll data
2393 * 'pageno' => $pageno The number of the actual page
2394 * 'reload_uri' => $reload_uri The URI of the content we have to load
2396 function infinite_scroll_data($module) {
2398 if (get_pconfig(local_user(),'system','infinite_scroll')
2399 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2401 // get the page number
2402 if (is_string($_GET["page"]))
2403 $pageno = $_GET["page"];
2409 // try to get the uri from which we load the content
2410 foreach ($_GET AS $param => $value)
2411 if (($param != "page") AND ($param != "q"))
2412 $reload_uri .= "&".$param."=".urlencode($value);
2414 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2415 $reload_uri .= "&offset=".urlencode($a->page_offset);
2417 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);