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', 1207 );
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 );
130 define ( 'CACHE_HALF_HOUR', 4 );
131 define ( 'CACHE_QUARTER_HOUR', 5 );
132 define ( 'CACHE_FIVE_MINUTES', 6 );
133 define ( 'CACHE_MINUTE', 7 );
139 * Registration policies
142 define ( 'REGISTER_CLOSED', 0 );
143 define ( 'REGISTER_APPROVE', 1 );
144 define ( 'REGISTER_OPEN', 2 );
153 define ( 'CONTACT_IS_FOLLOWER', 1);
154 define ( 'CONTACT_IS_SHARING', 2);
155 define ( 'CONTACT_IS_FRIEND', 3);
161 * DB update return values
164 define ( 'UPDATE_SUCCESS', 0);
165 define ( 'UPDATE_FAILED', 1);
170 * @name page/profile types
172 * PAGE_NORMAL is a typical personal profile account
173 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
174 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
175 * write access to wall and comments (no email and not included in page owner's ACL lists)
176 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
180 define ( 'PAGE_NORMAL', 0 );
181 define ( 'PAGE_SOAPBOX', 1 );
182 define ( 'PAGE_COMMUNITY', 2 );
183 define ( 'PAGE_FREELOVE', 3 );
184 define ( 'PAGE_BLOG', 4 );
185 define ( 'PAGE_PRVGROUP', 5 );
189 * @name account types
191 * ACCOUNT_TYPE_PERSON - the account belongs to a person
192 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
194 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
195 * Associated page type: PAGE_SOAPBOX
197 * ACCOUNT_TYPE_NEWS - the account is a news reflector
198 * Associated page type: PAGE_SOAPBOX
200 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
201 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
204 define ( 'ACCOUNT_TYPE_PERSON', 0 );
205 define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
206 define ( 'ACCOUNT_TYPE_NEWS', 2 );
207 define ( 'ACCOUNT_TYPE_COMMUNITY', 3 );
213 * Type of the community page
216 define ( 'CP_NO_COMMUNITY_PAGE', -1 );
217 define ( 'CP_USERS_ON_SERVER', 0 );
218 define ( 'CP_GLOBAL_COMMUNITY', 1 );
224 * Network and protocol family types
227 define ( 'NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
228 define ( 'NETWORK_ZOT', 'zot!'); // Zot!
229 define ( 'NETWORK_OSTATUS', 'stat'); // status.net, identi.ca, GNU-social, other OStatus implementations
230 define ( 'NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
231 define ( 'NETWORK_DIASPORA', 'dspr'); // Diaspora
232 define ( 'NETWORK_MAIL', 'mail'); // IMAP/POP
233 define ( 'NETWORK_MAIL2', 'mai2'); // extended IMAP/POP
234 define ( 'NETWORK_FACEBOOK', 'face'); // Facebook API
235 define ( 'NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
236 define ( 'NETWORK_XMPP', 'xmpp'); // XMPP
237 define ( 'NETWORK_MYSPACE', 'mysp'); // MySpace
238 define ( 'NETWORK_GPLUS', 'goog'); // Google+
239 define ( 'NETWORK_PUMPIO', 'pump'); // pump.io
240 define ( 'NETWORK_TWITTER', 'twit'); // Twitter
241 define ( 'NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
242 define ( 'NETWORK_STATUSNET', 'stac'); // Statusnet connector
243 define ( 'NETWORK_APPNET', 'apdn'); // app.net
244 define ( 'NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol
245 define ( 'NETWORK_ICALENDAR', 'ical'); // iCalendar
246 define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
250 * These numbers are used in stored permissions
251 * and existing allocations MUST NEVER BE CHANGED
252 * OR RE-ASSIGNED! You may only add to them.
255 $netgroup_ids = array(
256 NETWORK_DFRN => (-1),
258 NETWORK_OSTATUS => (-3),
259 NETWORK_FEED => (-4),
260 NETWORK_DIASPORA => (-5),
261 NETWORK_MAIL => (-6),
262 NETWORK_MAIL2 => (-7),
263 NETWORK_FACEBOOK => (-8),
264 NETWORK_LINKEDIN => (-9),
265 NETWORK_XMPP => (-10),
266 NETWORK_MYSPACE => (-11),
267 NETWORK_GPLUS => (-12),
268 NETWORK_PUMPIO => (-13),
269 NETWORK_TWITTER => (-14),
270 NETWORK_DIASPORA2 => (-15),
271 NETWORK_STATUSNET => (-16),
272 NETWORK_APPNET => (-17),
273 NETWORK_NEWS => (-18),
274 NETWORK_ICALENDAR => (-19),
276 NETWORK_PHANTOM => (-127),
281 * Maximum number of "people who like (or don't like) this" that we will list by name
284 define ( 'MAX_LIKERS', 75);
287 * Communication timeout
290 define ( 'ZCURL_TIMEOUT' , (-1));
296 * Email notification options
299 define ( 'NOTIFY_INTRO', 0x0001 );
300 define ( 'NOTIFY_CONFIRM', 0x0002 );
301 define ( 'NOTIFY_WALL', 0x0004 );
302 define ( 'NOTIFY_COMMENT', 0x0008 );
303 define ( 'NOTIFY_MAIL', 0x0010 );
304 define ( 'NOTIFY_SUGGEST', 0x0020 );
305 define ( 'NOTIFY_PROFILE', 0x0040 );
306 define ( 'NOTIFY_TAGSELF', 0x0080 );
307 define ( 'NOTIFY_TAGSHARE', 0x0100 );
308 define ( 'NOTIFY_POKE', 0x0200 );
309 define ( 'NOTIFY_SHARE', 0x0400 );
311 define ( 'NOTIFY_SYSTEM', 0x8000 );
321 define ( 'TERM_UNKNOWN', 0 );
322 define ( 'TERM_HASHTAG', 1 );
323 define ( 'TERM_MENTION', 2 );
324 define ( 'TERM_CATEGORY', 3 );
325 define ( 'TERM_PCATEGORY', 4 );
326 define ( 'TERM_FILE', 5 );
327 define ( 'TERM_SAVEDSEARCH', 6 );
328 define ( 'TERM_CONVERSATION', 7 );
330 define ( 'TERM_OBJ_POST', 1 );
331 define ( 'TERM_OBJ_PHOTO', 2 );
338 * Various namespaces we may need to parse
341 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
342 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
343 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
344 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
345 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
346 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
347 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
348 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
349 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
350 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
351 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
352 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
353 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
354 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
355 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
361 * Activity stream defines
364 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
365 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
366 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
367 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
368 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
370 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
372 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
373 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
374 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
375 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
376 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
377 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
379 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
380 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
381 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
382 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
383 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
385 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
386 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
388 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
389 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
390 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
391 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
392 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
393 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
394 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
395 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
396 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
397 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
398 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
399 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
400 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
401 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
407 * Item weight for query ordering
410 define ( 'GRAVITY_PARENT', 0);
411 define ( 'GRAVITY_LIKE', 3);
412 define ( 'GRAVITY_COMMENT', 6);
418 * Process priority for the worker
421 define('PRIORITY_UNDEFINED', 0);
422 define('PRIORITY_CRITICAL', 10);
423 define('PRIORITY_HIGH', 20);
424 define('PRIORITY_MEDIUM', 30);
425 define('PRIORITY_LOW', 40);
426 define('PRIORITY_NEGLIGIBLE',50);
430 // Normally this constant is defined - but not if "pcntl" isn't installed
431 if (!defined("SIGTERM"))
432 define("SIGTERM", 15);
436 * Reverse the effect of magic_quotes_gpc if it is enabled.
437 * Please disable magic_quotes_gpc so we don't have to do this.
438 * See http://php.net/manual/en/security.magicquotes.disabling.php
444 error_reporting(E_ERROR | E_WARNING | E_PARSE);
448 // This has to be quite large to deal with embedded private photos
449 ini_set('pcre.backtrack_limit', 500000);
452 if (get_magic_quotes_gpc()) {
453 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
454 while (list($key, $val) = each($process)) {
455 foreach ($val as $k => $v) {
456 unset($process[$key][$k]);
458 $process[$key][stripslashes($k)] = $v;
459 $process[] = &$process[$key][stripslashes($k)];
461 $process[$key][stripslashes($k)] = stripslashes($v);
474 * @brief Our main application structure for the life of this page.
476 * Primarily deals with the URL that got us here
477 * and tries to make some sense of it, and
478 * stores our page contents and config storage
479 * and anything else that might need to be passed around
480 * before we spit the page out.
485 public $module_loaded = false;
486 public $query_string;
495 public $page_contact;
497 public $data = array();
498 public $error = false;
508 public $interactive = true;
510 public $apps = array();
512 public $is_mobile = false;
513 public $is_tablet = false;
514 public $is_friendica_app;
515 public $performance = array();
516 public $callstack = array();
517 public $theme_info = array();
518 public $backend = true;
525 // Allow themes to control internal parameters
526 // by changing App values in theme.php
528 public $sourcename = '';
529 public $videowidth = 425;
530 public $videoheight = 350;
531 public $force_max_items = 0;
532 public $theme_thread_allow = true;
533 public $theme_events_in_profile = true;
536 * @brief An array for all theme-controllable parameters
538 * Mostly unimplemented yet. Only options 'template_engine' and
541 public $theme = array(
544 'videoheight' => 350,
545 'force_max_items' => 0,
546 'thread_allow' => true,
548 'template_engine' => 'smarty3',
552 * @brief An array of registered template engines ('name'=>'class name')
554 public $template_engines = array();
556 * @brief An array of instanced template engines ('name'=>'instance')
558 public $template_engine_instance = array();
562 private $ldelim = array(
566 private $rdelim = array(
577 private $curl_content_type;
578 private $curl_headers;
580 private $cached_profile_image;
581 private $cached_profile_picdate;
586 * @brief App constructor.
588 function __construct() {
590 global $default_timezone;
594 if (file_exists(".htpreconfig.php"))
595 @include(".htpreconfig.php");
597 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
599 date_default_timezone_set($this->timezone);
601 $this->performance["start"] = microtime(true);
602 $this->performance["database"] = 0;
603 $this->performance["database_write"] = 0;
604 $this->performance["network"] = 0;
605 $this->performance["file"] = 0;
606 $this->performance["rendering"] = 0;
607 $this->performance["parser"] = 0;
608 $this->performance["marktime"] = 0;
609 $this->performance["markstart"] = microtime(true);
611 $this->callstack["database"] = array();
612 $this->callstack["network"] = array();
613 $this->callstack["file"] = array();
614 $this->callstack["rendering"] = array();
615 $this->callstack["parser"] = array();
617 $this->config = array();
618 $this->page = array();
619 $this->pager= array();
621 $this->query_string = '';
623 $this->process_id = uniqid("log", true);
628 'include' . PATH_SEPARATOR
629 . 'library' . PATH_SEPARATOR
630 . 'library/phpsec' . PATH_SEPARATOR
631 . 'library/langdet' . PATH_SEPARATOR
635 $this->scheme = 'http';
636 if((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
637 (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
638 (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
639 (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
640 (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
641 (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
643 $this->scheme = 'https';
646 if(x($_SERVER,'SERVER_NAME')) {
647 $this->hostname = $_SERVER['SERVER_NAME'];
649 if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
650 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
652 * Figure out if we are running at the top of a domain
653 * or in a sub-directory and adjust accordingly
656 $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
657 if(isset($path) && strlen($path) && ($path != $this->path))
662 $this->hostname = $hostname;
664 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
665 $this->set_baseurl(array_pop($_SERVER["argv"]) );
669 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
671 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
672 $this->query_string = substr($_SERVER['QUERY_STRING'],9);
673 // removing trailing / - maybe a nginx problem
674 if (substr($this->query_string, 0, 1) == "/")
675 $this->query_string = substr($this->query_string, 1);
676 } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
677 $this->query_string = substr($_SERVER['QUERY_STRING'],2);
678 // removing trailing / - maybe a nginx problem
679 if (substr($this->query_string, 0, 1) == "/")
680 $this->query_string = substr($this->query_string, 1);
683 if (x($_GET,'pagename'))
684 $this->cmd = trim($_GET['pagename'],'/\\');
685 elseif (x($_GET,'q'))
686 $this->cmd = trim($_GET['q'],'/\\');
690 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
693 // unix style "homedir"
695 if(substr($this->cmd,0,1) === '~')
696 $this->cmd = 'profile/' . substr($this->cmd,1);
698 // Diaspora style profile url
700 if(substr($this->cmd,0,2) === 'u/')
701 $this->cmd = 'profile/' . substr($this->cmd,2);
706 * Break the URL path into C style argc/argv style arguments for our
707 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
708 * will be 3 (integer) and $this->argv will contain:
714 * There will always be one argument. If provided a naked domain
715 * URL, $this->argv[0] is set to "home".
719 $this->argv = explode('/',$this->cmd);
720 $this->argc = count($this->argv);
721 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
722 $this->module = str_replace(".", "_", $this->argv[0]);
723 $this->module = str_replace("-", "_", $this->module);
727 $this->argv = array('home');
728 $this->module = 'home';
732 * See if there is any page number information, and initialise
736 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
737 $this->pager['itemspage'] = 50;
738 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
739 if($this->pager['start'] < 0)
740 $this->pager['start'] = 0;
741 $this->pager['total'] = 0;
744 * Detect mobile devices
747 $mobile_detect = new Mobile_Detect();
748 $this->is_mobile = $mobile_detect->isMobile();
749 $this->is_tablet = $mobile_detect->isTablet();
752 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
755 * register template engines
757 $dc = get_declared_classes();
758 foreach ($dc as $k) {
759 if (in_array("ITemplateEngine", class_implements($k))){
760 $this->register_template_engine($k);
768 function get_basepath() {
770 $basepath = get_config("system", "basepath");
773 $basepath = dirname(__FILE__);
776 $basepath = $_SERVER["DOCUMENT_ROOT"];
779 $basepath = $_SERVER["PWD"];
784 function get_scheme() {
785 return($this->scheme);
788 function get_baseurl($ssl = false) {
790 // Is the function called statically?
791 if (!is_object($this))
792 return(self::$a->get_baseurl($ssl));
794 $scheme = $this->scheme;
796 if((x($this->config,'system')) && (x($this->config['system'],'ssl_policy'))) {
797 if(intval($this->config['system']['ssl_policy']) === intval(SSL_POLICY_FULL))
800 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
801 // (and also the login link). Anything seen by an outsider will have it turned off.
803 if($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) {
811 if (get_config('config','hostname') != "")
812 $this->hostname = get_config('config','hostname');
814 $this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
815 return $this->baseurl;
818 function set_baseurl($url) {
819 $parsed = @parse_url($url);
821 $this->baseurl = $url;
824 $this->scheme = $parsed['scheme'];
826 $hostname = $parsed['host'];
827 if(x($parsed,'port'))
828 $hostname .= ':' . $parsed['port'];
829 if(x($parsed,'path'))
830 $this->path = trim($parsed['path'],'\\/');
832 if (file_exists(".htpreconfig.php"))
833 @include(".htpreconfig.php");
835 if (get_config('config','hostname') != "")
836 $this->hostname = get_config('config','hostname');
838 if (!isset($this->hostname) OR ($this->hostname == ""))
839 $this->hostname = $hostname;
844 function get_hostname() {
845 if (get_config('config','hostname') != "")
846 $this->hostname = get_config('config','hostname');
848 return $this->hostname;
851 function set_hostname($h) {
852 $this->hostname = $h;
855 function set_path($p) {
856 $this->path = trim(trim($p),'/');
859 function get_path() {
863 function set_pager_total($n) {
864 $this->pager['total'] = intval($n);
867 function set_pager_itemspage($n) {
868 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
869 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
872 function set_pager_page($n) {
873 $this->pager['page'] = $n;
874 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
877 function init_pagehead() {
878 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
880 // If the update is "deactivated" set it to the highest integer number (~24 days)
882 $interval = 2147483647;
884 if($interval < 10000)
887 // compose the page title from the sitename and the
888 // current module called
889 if (!$this->module=='')
891 $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
893 $this->page['title'] = $this->config['sitename'];
896 /* put the head template at the beginning of page['htmlhead']
897 * since the code added by the modules frequently depends on it
900 if(!isset($this->page['htmlhead']))
901 $this->page['htmlhead'] = '';
903 // If we're using Smarty, then doing replace_macros() will replace
904 // any unrecognized variables with a blank string. Since we delay
905 // replacing $stylesheet until later, we need to replace it now
906 // with another variable name
907 if($this->theme['template_engine'] === 'smarty3')
908 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
910 $stylesheet = '$stylesheet';
912 $shortcut_icon = get_config("system", "shortcut_icon");
913 if ($shortcut_icon == "")
914 $shortcut_icon = "images/friendica-32.png";
916 $touch_icon = get_config("system", "touch_icon");
917 if ($touch_icon == "")
918 $touch_icon = "images/friendica-128.png";
920 // get data wich is needed for infinite scroll on the network page
921 $invinite_scroll = infinite_scroll_data($this->module);
923 $tpl = get_markup_template('head.tpl');
924 $this->page['htmlhead'] = replace_macros($tpl,array(
925 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
926 '$local_user' => local_user(),
927 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
928 '$delitem' => t('Delete this item?'),
929 '$comment' => t('Comment'),
930 '$showmore' => t('show more'),
931 '$showfewer' => t('show fewer'),
932 '$update_interval' => $interval,
933 '$shortcut_icon' => $shortcut_icon,
934 '$touch_icon' => $touch_icon,
935 '$stylesheet' => $stylesheet,
936 '$infinite_scroll' => $invinite_scroll,
937 )) . $this->page['htmlhead'];
940 function init_page_end() {
941 if(!isset($this->page['end']))
942 $this->page['end'] = '';
943 $tpl = get_markup_template('end.tpl');
944 $this->page['end'] = replace_macros($tpl,array(
945 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
946 )) . $this->page['end'];
949 function set_curl_code($code) {
950 $this->curl_code = $code;
953 function get_curl_code() {
954 return $this->curl_code;
957 function set_curl_content_type($content_type) {
958 $this->curl_content_type = $content_type;
961 function get_curl_content_type() {
962 return $this->curl_content_type;
965 function set_curl_headers($headers) {
966 $this->curl_headers = $headers;
969 function get_curl_headers() {
970 return $this->curl_headers;
973 function get_cached_avatar_image($avatar_image){
974 return $avatar_image;
976 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
978 if($this->cached_profile_image[$avatar_image])
979 return $this->cached_profile_image[$avatar_image];
981 $path_parts = explode("/",$avatar_image);
982 $common_filename = $path_parts[count($path_parts)-1];
984 if($this->cached_profile_picdate[$common_filename]){
985 $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
987 $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
989 if(! dbm::is_result($r)){
990 $this->cached_profile_image[$avatar_image] = $avatar_image;
992 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
993 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
996 return $this->cached_profile_image[$avatar_image];
1002 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1004 * @param string $url
1006 * @return string The cleaned url
1008 function remove_baseurl($url){
1010 // Is the function called statically?
1011 if (!is_object($this))
1012 return(self::$a->remove_baseurl($url));
1014 $url = normalise_link($url);
1015 $base = normalise_link($this->get_baseurl());
1016 $url = str_replace($base."/", "", $url);
1021 * @brief Register template engine class
1023 * If $name is "", is used class static property $class::$name
1025 * @param string $class
1026 * @param string $name
1028 function register_template_engine($class, $name = '') {
1030 $v = get_class_vars( $class );
1031 if(x($v,"name")) $name = $v['name'];
1034 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1037 $this->template_engines[$name] = $class;
1041 * @brief Return template engine instance.
1043 * If $name is not defined, return engine defined by theme,
1046 * @param strin $name Template engine name
1047 * @return object Template Engine instance
1049 function template_engine($name = ''){
1051 $template_engine = $name;
1053 $template_engine = 'smarty3';
1054 if (x($this->theme, 'template_engine')) {
1055 $template_engine = $this->theme['template_engine'];
1059 if (isset($this->template_engines[$template_engine])){
1060 if(isset($this->template_engine_instance[$template_engine])){
1061 return $this->template_engine_instance[$template_engine];
1063 $class = $this->template_engines[$template_engine];
1065 $this->template_engine_instance[$template_engine] = $obj;
1070 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1074 * @brief Returns the active template engine.
1078 function get_template_engine() {
1079 return $this->theme['template_engine'];
1082 function set_template_engine($engine = 'smarty3') {
1083 $this->theme['template_engine'] = $engine;
1085 $this->theme['template_engine'] = 'smarty3';
1089 if(is_writable('view/smarty3/'))
1090 $this->theme['template_engine'] = 'smarty3';
1098 function get_template_ldelim($engine = 'smarty3') {
1099 return $this->ldelim[$engine];
1102 function get_template_rdelim($engine = 'smarty3') {
1103 return $this->rdelim[$engine];
1106 function save_timestamp($stamp, $value) {
1107 $duration = (float)(microtime(true)-$stamp);
1109 if (!isset($this->performance[$value])) {
1110 // Prevent ugly E_NOTICE
1111 $this->performance[$value] = 0;
1114 $this->performance[$value] += (float)$duration;
1115 $this->performance["marktime"] += (float)$duration;
1117 $callstack = $this->callstack();
1119 if (!isset($this->callstack[$value][$callstack])) {
1120 // Prevent ugly E_NOTICE
1121 $this->callstack[$value][$callstack] = 0;
1124 $this->callstack[$value][$callstack] += (float)$duration;
1129 * @brief Log active processes into the "process" table
1131 function start_process() {
1132 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1134 $command = basename($trace[0]["file"]);
1136 $this->remove_inactive_processes();
1138 q("START TRANSACTION");
1140 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1141 if(!dbm::is_result($r)) {
1142 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1145 dbesc(datetime_convert()));
1151 * @brief Remove inactive processes
1153 function remove_inactive_processes() {
1154 q("START TRANSACTION");
1156 $r = q("SELECT `pid` FROM `process`");
1157 if(dbm::is_result($r)) {
1158 foreach ($r AS $process) {
1159 if (!posix_kill($process["pid"], 0)) {
1160 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1168 * @brief Remove the active process from the "process" table
1170 function end_process() {
1171 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1175 * @brief Returns a string with a callstack. Can be used for logging.
1179 function callstack() {
1180 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1182 // We remove the first two items from the list since they contain data that we don't need.
1183 array_shift($trace);
1184 array_shift($trace);
1186 $callstack = array();
1187 foreach ($trace AS $func)
1188 $callstack[] = $func["function"];
1190 return implode(", ", $callstack);
1193 function mark_timestamp($mark) {
1194 //$this->performance["markstart"] -= microtime(true) - $this->performance["marktime"];
1195 $this->performance["markstart"] = microtime(true) - $this->performance["markstart"] - $this->performance["marktime"];
1198 function get_useragent() {
1199 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1202 function is_friendica_app() {
1203 return($this->is_friendica_app);
1207 * @brief Checks if the site is called via a backend process
1209 * This isn't a perfect solution. But we need this check very early.
1210 * So we cannot wait until the modules are loaded.
1212 * @return bool Is it a known backend?
1214 function is_backend() {
1216 $backend[] = "_well_known";
1218 $backend[] = "dfrn_notify";
1219 $backend[] = "fetch";
1220 $backend[] = "hcard";
1221 $backend[] = "hostxrd";
1222 $backend[] = "nodeinfo";
1223 $backend[] = "noscrape";
1225 $backend[] = "poco";
1226 $backend[] = "post";
1227 $backend[] = "proxy";
1228 $backend[] = "pubsub";
1229 $backend[] = "pubsubhubbub";
1230 $backend[] = "receive";
1231 $backend[] = "rsd_xml";
1232 $backend[] = "salmon";
1233 $backend[] = "statistics_json";
1236 if (in_array($this->module, $backend))
1239 return($this->backend);
1243 * @brief Checks if the maximum number of database processes is reached
1245 * @return bool Is the limit reached?
1247 function max_processes_reached() {
1249 // Is the function called statically?
1250 if (!is_object($this))
1251 return(self::$a->max_processes_reached());
1253 if ($this->is_backend()) {
1254 $process = "backend";
1255 $max_processes = get_config('system', 'max_processes_backend');
1256 if (intval($max_processes) == 0)
1259 $process = "frontend";
1260 $max_processes = get_config('system', 'max_processes_frontend');
1261 if (intval($max_processes) == 0)
1262 $max_processes = 20;
1265 $processlist = dbm::processlist();
1266 if ($processlist["list"] != "") {
1267 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1269 if ($processlist["amount"] > $max_processes) {
1270 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1278 * @brief Checks if the maximum load is reached
1280 * @return bool Is the load reached?
1282 function maxload_reached() {
1284 // Is the function called statically?
1285 if (!is_object($this))
1286 return(self::$a->maxload_reached());
1288 if ($this->is_backend()) {
1289 $process = "backend";
1290 $maxsysload = intval(get_config('system', 'maxloadavg'));
1291 if ($maxsysload < 1)
1294 $process = "frontend";
1295 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1296 if ($maxsysload < 1)
1300 $load = current_load();
1302 if (intval($load) > $maxsysload) {
1303 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1311 * @brief Checks if the process is already running
1313 * @param string $taskname The name of the task that will be used for the name of the lockfile
1314 * @param string $task The path and name of the php script
1315 * @param int $timeout The timeout after which a task should be killed
1317 * @return bool Is the process running?
1319 function is_already_running($taskname, $task = "", $timeout = 540) {
1321 $lockpath = get_lockpath();
1322 if ($lockpath != '') {
1323 $pidfile = new pidfile($lockpath, $taskname);
1324 if ($pidfile->is_already_running()) {
1325 logger("Already running");
1326 if ($pidfile->running_time() > $timeout) {
1328 logger("killed stale process");
1329 // Calling a new instance
1331 proc_run(PRIORITY_MEDIUM, $task);
1339 function proc_run($args) {
1341 // Add the php path if it is a php call
1342 if (count($args) && ($args[0] === 'php' OR is_int($args[0]))) {
1344 // If the last worker fork was less than 10 seconds before then don't fork another one.
1345 // This should prevent the forking of masses of workers.
1346 if (get_config("system", "worker")) {
1347 if ((time() - get_config("system", "proc_run_started")) < 10)
1350 // Set the timestamp of the last proc_run
1351 set_config("system", "proc_run_started", time());
1354 $args[0] = ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php');
1357 // add baseurl to args. cli scripts can't construct it
1358 $args[] = $this->get_baseurl();
1360 for($x = 0; $x < count($args); $x ++)
1361 $args[$x] = escapeshellarg($args[$x]);
1363 $cmdline = implode($args," ");
1365 if(get_config('system','proc_windows'))
1366 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1368 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1374 * @brief Retrieve the App structure
1376 * Useful in functions which require it but don't get it passed to them
1378 function get_app() {
1385 * @brief Multi-purpose function to check variable state.
1387 * Usage: x($var) or $x($array, 'key')
1389 * returns false if variable/key is not set
1390 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1391 * e.g. x('') or x(0) returns 0;
1393 * @param string|array $s variable to check
1394 * @param string $k key inside the array to check
1398 function x($s,$k = NULL) {
1400 if((is_array($s)) && (array_key_exists($k,$s))) {
1420 * @brief Called from db initialisation if db is dead.
1422 function system_unavailable() {
1423 include('system_unavailable.php');
1429 function clean_urls() {
1431 // if($a->config['system']['clean_urls'])
1438 $base = $a->get_baseurl();
1445 * @brief Returns the baseurl.
1447 * @see App::get_baseurl()
1453 return $a->get_baseurl();
1457 * @brief Return absolut URL for given $path.
1459 * @param string $path
1463 function absurl($path) {
1464 if(strpos($path,'/') === 0)
1465 return z_path() . $path;
1470 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1474 function is_ajax() {
1475 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1478 function check_db() {
1480 $build = get_config('system','build');
1482 set_config('system','build',DB_UPDATE_VERSION);
1483 $build = DB_UPDATE_VERSION;
1485 if($build != DB_UPDATE_VERSION)
1486 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1492 * Sets the base url for use in cmdline programs which don't have
1493 * $_SERVER variables
1495 function check_url(&$a) {
1497 $url = get_config('system','url');
1499 // if the url isn't set or the stored url is radically different
1500 // than the currently visited url, store the current value accordingly.
1501 // "Radically different" ignores common variations such as http vs https
1502 // and www.example.com vs example.com.
1503 // We will only change the url to an ip address if there is no existing setting
1506 $url = set_config('system','url',$a->get_baseurl());
1507 if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1508 $url = set_config('system','url',$a->get_baseurl());
1515 * @brief Automatic database updates
1517 function update_db(&$a) {
1518 $build = get_config('system','build');
1520 $build = set_config('system','build',DB_UPDATE_VERSION);
1522 if($build != DB_UPDATE_VERSION) {
1523 $stored = intval($build);
1524 $current = intval(DB_UPDATE_VERSION);
1525 if($stored < $current) {
1526 load_config('database');
1528 // We're reporting a different version than what is currently installed.
1529 // Run any existing update scripts to bring the database up to current.
1531 // make sure that boot.php and update.php are the same release, we might be
1532 // updating right this very second and the correct version of the update.php
1533 // file may not be here yet. This can happen on a very busy site.
1535 if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1536 // Compare the current structure with the defined structure
1538 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1542 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1544 // run old update routine (wich could modify the schema and
1545 // conflits with new routine)
1546 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1547 $r = run_update_function($x);
1550 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1553 // run new update routine
1554 // it update the structure in one call
1555 $retval = update_structure(false, true);
1563 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1566 // run any left update_nnnn functions in update.php
1567 for($x = $stored; $x < $current; $x ++) {
1568 $r = run_update_function($x);
1578 function run_update_function($x) {
1579 if(function_exists('update_' . $x)) {
1581 // There could be a lot of processes running or about to run.
1582 // We want exactly one process to run the update command.
1583 // So store the fact that we're taking responsibility
1584 // after first checking to see if somebody else already has.
1586 // If the update fails or times-out completely you may need to
1587 // delete the config entry to try again.
1589 $t = get_config('database','update_' . $x);
1592 set_config('database','update_' . $x, time());
1594 // call the specific update
1596 $func = 'update_' . $x;
1600 //send the administrator an e-mail
1603 sprintf(t('Update %s failed. See error logs.'), $x)
1607 set_config('database','update_' . $x, 'success');
1608 set_config('system','build', $x + 1);
1612 set_config('database','update_' . $x, 'success');
1613 set_config('system','build', $x + 1);
1620 * @brief Synchronise plugins:
1622 * $a->config['system']['addon'] contains a comma-separated list of names
1623 * of plugins/addons which are used on this system.
1624 * Go through the database list of already installed addons, and if we have
1625 * an entry, but it isn't in the config list, call the uninstall procedure
1626 * and mark it uninstalled in the database (for now we'll remove it).
1627 * Then go through the config list and if we have a plugin that isn't installed,
1628 * call the install procedure and add it to the database.
1633 function check_plugins(&$a) {
1635 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1636 if(dbm::is_result($r))
1639 $installed = array();
1641 $plugins = get_config('system','addon');
1642 $plugins_arr = array();
1645 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1647 $a->plugins = $plugins_arr;
1649 $installed_arr = array();
1651 if(count($installed)) {
1652 foreach($installed as $i) {
1653 if(! in_array($i['name'],$plugins_arr)) {
1654 uninstall_plugin($i['name']);
1657 $installed_arr[] = $i['name'];
1662 if(count($plugins_arr)) {
1663 foreach($plugins_arr as $p) {
1664 if(! in_array($p,$installed_arr)) {
1676 function get_guid($size=16, $prefix = "") {
1678 if ($prefix == "") {
1680 $prefix = hash("crc32", $a->get_hostname());
1683 while (strlen($prefix) < ($size - 13))
1684 $prefix .= mt_rand();
1687 $prefix = substr($prefix, 0, $size - 22);
1688 return(str_replace(".", "", uniqid($prefix, true)));
1690 $prefix = substr($prefix, 0, max($size - 13, 0));
1691 return(uniqid($prefix));
1696 * @brief Wrapper for adding a login box.
1698 * @param bool $register
1699 * If $register == true provide a registration link.
1700 * This will most always depend on the value of $a->config['register_policy'].
1701 * @param bool $hiddens
1704 * Returns the complete html for inserting into the page
1706 * @hooks 'login_hook'
1709 function login($register = false, $hiddens=false) {
1715 'title' => t('Create a New Account'),
1716 'desc' => t('Register')
1720 $noid = get_config('system','no_openid');
1722 $dest_url = $a->query_string;
1725 $tpl = get_markup_template("logout.tpl");
1728 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1729 '$baseurl' => $a->get_baseurl(true)
1732 $tpl = get_markup_template("login.tpl");
1733 $_SESSION['return_url'] = $a->query_string;
1734 $a->module = 'login';
1737 $o .= replace_macros($tpl, array(
1739 '$dest_url' => $dest_url,
1740 '$logout' => t('Logout'),
1741 '$login' => t('Login'),
1743 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1744 '$lpassword' => array('password', t('Password: '), '', ''),
1745 '$lremember' => array('remember', t('Remember me'), 0, ''),
1747 '$openid' => !$noid,
1748 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1750 '$hiddens' => $hiddens,
1752 '$register' => $reg,
1754 '$lostpass' => t('Forgot your password?'),
1755 '$lostlink' => t('Password Reset'),
1757 '$tostitle' => t('Website Terms of Service'),
1758 '$toslink' => t('terms of service'),
1760 '$privacytitle' => t('Website Privacy Policy'),
1761 '$privacylink' => t('privacy policy'),
1765 call_hooks('login_hook',$o);
1771 * @brief Used to end the current process, after saving session state.
1775 if (!get_app()->is_backend())
1776 session_write_close();
1782 * @brief Redirect to another URL and terminate this process.
1784 function goaway($s) {
1785 if (!strstr(normalise_link($s), "http://"))
1786 $s = App::get_baseurl()."/".$s;
1788 header("Location: $s");
1794 * @brief Returns the user id of locally logged in user or false.
1796 * @return int|bool user id or false
1798 function local_user() {
1799 if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1800 return intval($_SESSION['uid']);
1805 * @brief Returns contact id of authenticated site visitor or false
1807 * @return int|bool visitor_id or false
1809 function remote_user() {
1810 if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1811 return intval($_SESSION['visitor_id']);
1816 * @brief Show an error 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
1822 function notice($s) {
1824 if(! x($_SESSION,'sysmsg')) $_SESSION['sysmsg'] = array();
1826 $_SESSION['sysmsg'][] = $s;
1830 * @brief Show an info message to user.
1832 * This function save text in session, to be shown to the user at next page load
1834 * @param string $s - Text of notice
1839 if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1842 if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1844 $_SESSION['sysmsg_info'][] = $s;
1849 * @brief Wrapper around config to limit the text length of an incoming message
1853 function get_max_import_size() {
1855 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1859 * @brief Wrap calls to proc_close(proc_open()) and call hook
1860 * so plugins can take part in process :)
1862 * @param (string|integer) $cmd program to run or priority
1864 * next args are passed as $cmd command line
1865 * e.g.: proc_run("ls","-la","/tmp");
1866 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1868 * @note $cmd and string args are surrounded with ""
1873 function proc_run($cmd){
1877 $args = func_get_args();
1883 // expand any arrays
1885 foreach($args as $arg) {
1886 if(is_array($arg)) {
1887 foreach($arg as $n) {
1896 $arr = array('args' => $args, 'run_cmd' => true);
1898 call_hooks("proc_run", $arr);
1899 if (!$arr['run_cmd'] OR !count($args))
1902 if (!get_config("system", "worker") OR
1903 (($args[0] != 'php') AND !is_int($args[0]))) {
1904 $a->proc_run($args);
1908 if (is_int($args[0]))
1909 $priority = $args[0];
1911 $priority = PRIORITY_MEDIUM;
1916 $parameters = json_encode($argv);
1917 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1918 dbesc($parameters));
1921 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1922 VALUES ('%s', '%s', %d)",
1924 dbesc(datetime_convert()),
1927 // Should we quit and wait for the poller to be called as a cronjob?
1928 if (get_config("system", "worker_dont_fork"))
1931 // Checking number of workers
1932 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1934 // Get number of allowed number of worker threads
1935 $queues = intval(get_config("system", "worker_queues"));
1940 // If there are already enough workers running, don't fork another one
1941 if ($workers[0]["workers"] >= $queues)
1944 // Now call the poller to execute the jobs that we just added to the queue
1945 $args = array("php", "include/poller.php", "no_cron");
1947 $a->proc_run($args);
1950 function current_theme(){
1951 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
1957 // Find the theme that belongs to the user whose stuff we are looking at
1959 if($a->profile_uid && ($a->profile_uid != local_user())) {
1960 $r = q("select theme from user where uid = %d limit 1",
1961 intval($a->profile_uid)
1963 if(dbm::is_result($r))
1964 $page_theme = $r[0]['theme'];
1967 // Allow folks to over-rule user themes and always use their own on their own site.
1968 // This works only if the user is on the same server
1970 if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
1971 if(get_pconfig(local_user(),'system','always_my_theme'))
1975 // $mobile_detect = new Mobile_Detect();
1976 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
1977 $is_mobile = $a->is_mobile || $a->is_tablet;
1979 $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
1980 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
1983 if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
1984 $system_theme = $standard_system_theme;
1985 $theme_name = $standard_theme_name;
1988 $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme);
1989 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
1991 if($theme_name === '---') {
1992 // user has selected to have the mobile theme be the same as the normal one
1993 $system_theme = $standard_system_theme;
1994 $theme_name = $standard_theme_name;
1997 $theme_name = $page_theme;
2002 $system_theme = $standard_system_theme;
2003 $theme_name = $standard_theme_name;
2006 $theme_name = $page_theme;
2010 (file_exists('view/theme/' . $theme_name . '/style.css') ||
2011 file_exists('view/theme/' . $theme_name . '/style.php')))
2012 return($theme_name);
2014 foreach($app_base_themes as $t) {
2015 if(file_exists('view/theme/' . $t . '/style.css')||
2016 file_exists('view/theme/' . $t . '/style.php'))
2020 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2021 if(count($fallback))
2022 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2027 * @brief Return full URL to theme which is currently in effect.
2029 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2033 function current_theme_url() {
2036 $t = current_theme();
2038 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2039 if (file_exists('view/theme/' . $t . '/style.php'))
2040 return('view/theme/'.$t.'/style.pcss'.$opts);
2042 return('view/theme/'.$t.'/style.css');
2045 function feed_birthday($uid,$tz) {
2049 * Determine the next birthday, but only if the birthday is published
2050 * in the default profile. We _could_ also look for a private profile that the
2051 * recipient can see, but somebody could get mad at us if they start getting
2052 * public birthday greetings when they haven't made this info public.
2054 * Assuming we are able to publish this info, we are then going to convert
2055 * the start time from the owner's timezone to UTC.
2057 * This will potentially solve the problem found with some social networks
2058 * where birthdays are converted to the viewer's timezone and salutations from
2059 * elsewhere in the world show up on the wrong day. We will convert it to the
2060 * viewer's timezone also, but first we are going to convert it from the birthday
2061 * person's timezone to GMT - so the viewer may find the birthday starting at
2062 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2072 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2076 if(dbm::is_result($p)) {
2077 $tmp_dob = substr($p[0]['dob'],5);
2078 if(intval($tmp_dob)) {
2079 $y = datetime_convert($tz,$tz,'now','Y');
2080 $bd = $y . '-' . $tmp_dob . ' 00:00';
2081 $t_dob = strtotime($bd);
2082 $now = strtotime(datetime_convert($tz,$tz,'now'));
2084 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2085 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2093 * @brief Check if current user has admin role.
2095 * @return bool true if user is an admin
2097 function is_site_admin() {
2100 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2102 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2103 if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2109 * @brief Returns querystring as string from a mapped array.
2111 * @param array $params mapped array with query parameters
2112 * @param string $name of parameter, default null
2116 function build_querystring($params, $name=null) {
2118 foreach($params as $key=>$val) {
2119 if(is_array($val)) {
2121 $ret .= build_querystring($val, $key);
2123 $ret .= build_querystring($val, $name."[$key]");
2126 $val = urlencode($val);
2128 $ret.=$name."[$key]"."=$val&";
2130 $ret.= "$key=$val&";
2137 function explode_querystring($query) {
2138 $arg_st = strpos($query, '?');
2139 if($arg_st !== false) {
2140 $base = substr($query, 0, $arg_st);
2147 $args = explode('&', substr($query, $arg_st));
2148 foreach($args as $k=>$arg) {
2152 $args = array_values($args);
2157 $args = array_values($args);
2167 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2169 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2171 function curPageURL() {
2173 if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
2175 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2176 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2178 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2183 function random_digits($digits) {
2185 for($i = 0; $i < $digits; $i++) {
2191 function get_server() {
2192 $server = get_config("system", "directory");
2195 $server = "http://dir.friendi.ca";
2200 function get_cachefile($file, $writemode = true) {
2201 $cache = get_itemcachepath();
2203 if ((! $cache) || (! is_dir($cache)))
2206 $subfolder = $cache."/".substr($file, 0, 2);
2208 $cachepath = $subfolder."/".$file;
2211 if (!is_dir($subfolder)) {
2213 chmod($subfolder, 0777);
2220 function clear_cache($basepath = "", $path = "") {
2222 $basepath = get_itemcachepath();
2226 if (($path == "") OR (!is_dir($path)))
2229 if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2232 $cachetime = (int)get_config('system','itemcache_duration');
2233 if ($cachetime == 0)
2236 if (is_writable($path)){
2237 if ($dh = opendir($path)) {
2238 while (($file = readdir($dh)) !== false) {
2239 $fullpath = $path."/".$file;
2240 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2241 clear_cache($basepath, $fullpath);
2242 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2250 function get_itemcachepath() {
2251 // Checking, if the cache is deactivated
2252 $cachetime = (int)get_config('system','itemcache_duration');
2256 $itemcache = get_config('system','itemcache');
2257 if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2260 $temppath = get_temppath();
2262 if ($temppath != "") {
2263 $itemcache = $temppath."/itemcache";
2264 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2268 if (is_dir($itemcache) AND is_writable($itemcache)) {
2269 set_config("system", "itemcache", $itemcache);
2276 function get_lockpath() {
2277 $lockpath = get_config('system','lockpath');
2278 if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2281 $temppath = get_temppath();
2283 if ($temppath != "") {
2284 $lockpath = $temppath."/lock";
2286 if (!is_dir($lockpath))
2288 elseif (!is_writable($lockpath))
2289 $lockpath = $temppath;
2291 if (is_dir($lockpath) AND is_writable($lockpath)) {
2292 set_config("system", "lockpath", $lockpath);
2299 function get_temppath() {
2302 $temppath = get_config("system","temppath");
2303 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2306 $temppath = sys_get_temp_dir();
2307 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2308 $temppath .= "/".$a->get_hostname();
2309 if (!is_dir($temppath))
2312 if (is_dir($temppath) AND is_writable($temppath)) {
2313 set_config("system", "temppath", $temppath);
2321 function set_template_engine(&$a, $engine = 'internal') {
2322 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2323 /// to avoid breaking themes again unnecessarily
2325 $a->set_template_engine($engine);
2328 if(!function_exists('exif_imagetype')) {
2329 function exif_imagetype($file) {
2330 $size = getimagesize($file);
2335 function validate_include(&$file) {
2338 $file = realpath($file);
2340 if (strpos($file, getcwd()) !== 0)
2343 $file = str_replace(getcwd()."/", "", $file, $count);
2347 if ($orig_file !== $file)
2351 if (strpos($file, "include/") === 0)
2354 if (strpos($file, "addon/") === 0)
2363 function current_load() {
2364 if (!function_exists('sys_getloadavg'))
2367 $load_arr = sys_getloadavg();
2369 if (!is_array($load_arr))
2372 return max($load_arr[0], $load_arr[1]);
2376 * @brief get c-style args
2381 return get_app()->argc;
2385 * @brief Returns the value of a argv key
2387 * @param int $x argv key
2388 * @return string Value of the argv key
2391 if(array_key_exists($x,get_app()->argv))
2392 return get_app()->argv[$x];
2398 * @brief Get the data which is needed for infinite scroll
2400 * For invinite scroll we need the page number of the actual page
2401 * and the the URI where the content of the next page comes from.
2402 * This data is needed for the js part in main.js.
2403 * Note: infinite scroll does only work for the network page (module)
2405 * @param string $module The name of the module (e.g. "network")
2406 * @return array Of infinite scroll data
2407 * 'pageno' => $pageno The number of the actual page
2408 * 'reload_uri' => $reload_uri The URI of the content we have to load
2410 function infinite_scroll_data($module) {
2412 if (get_pconfig(local_user(),'system','infinite_scroll')
2413 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2415 // get the page number
2416 if (is_string($_GET["page"]))
2417 $pageno = $_GET["page"];
2423 // try to get the uri from which we load the content
2424 foreach ($_GET AS $param => $value)
2425 if (($param != "page") AND ($param != "q"))
2426 $reload_uri .= "&".$param."=".urlencode($value);
2428 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2429 $reload_uri .= "&offset=".urlencode($a->page_offset);
2431 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);