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', 1209 );
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_richtext_editor = true;
534 public $theme_events_in_profile = true;
537 * @brief An array for all theme-controllable parameters
539 * Mostly unimplemented yet. Only options 'template_engine' and
542 public $theme = array(
545 'videoheight' => 350,
546 'force_max_items' => 0,
547 'thread_allow' => true,
549 'template_engine' => 'smarty3',
553 * @brief An array of registered template engines ('name'=>'class name')
555 public $template_engines = array();
557 * @brief An array of instanced template engines ('name'=>'instance')
559 public $template_engine_instance = array();
563 private $ldelim = array(
567 private $rdelim = array(
578 private $curl_content_type;
579 private $curl_headers;
581 private $cached_profile_image;
582 private $cached_profile_picdate;
587 * @brief App constructor.
589 function __construct() {
591 global $default_timezone;
595 if (file_exists(".htpreconfig.php"))
596 @include(".htpreconfig.php");
598 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
600 date_default_timezone_set($this->timezone);
602 $this->performance["start"] = microtime(true);
603 $this->performance["database"] = 0;
604 $this->performance["database_write"] = 0;
605 $this->performance["network"] = 0;
606 $this->performance["file"] = 0;
607 $this->performance["rendering"] = 0;
608 $this->performance["parser"] = 0;
609 $this->performance["marktime"] = 0;
610 $this->performance["markstart"] = microtime(true);
612 $this->callstack["database"] = array();
613 $this->callstack["database_write"] = array();
614 $this->callstack["network"] = array();
615 $this->callstack["file"] = array();
616 $this->callstack["rendering"] = array();
617 $this->callstack["parser"] = array();
619 $this->config = array();
620 $this->page = array();
621 $this->pager= array();
623 $this->query_string = '';
625 $this->process_id = uniqid("log", true);
630 'include' . PATH_SEPARATOR
631 . 'library' . PATH_SEPARATOR
632 . 'library/phpsec' . PATH_SEPARATOR
633 . 'library/langdet' . PATH_SEPARATOR
637 $this->scheme = 'http';
638 if((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
639 (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
640 (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
641 (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
642 (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
643 (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
645 $this->scheme = 'https';
648 if(x($_SERVER,'SERVER_NAME')) {
649 $this->hostname = $_SERVER['SERVER_NAME'];
651 if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
652 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
654 * Figure out if we are running at the top of a domain
655 * or in a sub-directory and adjust accordingly
658 $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
659 if(isset($path) && strlen($path) && ($path != $this->path))
664 $this->hostname = $hostname;
666 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
667 $this->set_baseurl(array_pop($_SERVER["argv"]) );
671 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
673 if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
674 $this->query_string = substr($_SERVER['QUERY_STRING'],9);
675 // removing trailing / - maybe a nginx problem
676 if (substr($this->query_string, 0, 1) == "/")
677 $this->query_string = substr($this->query_string, 1);
678 } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
679 $this->query_string = substr($_SERVER['QUERY_STRING'],2);
680 // removing trailing / - maybe a nginx problem
681 if (substr($this->query_string, 0, 1) == "/")
682 $this->query_string = substr($this->query_string, 1);
685 if (x($_GET,'pagename'))
686 $this->cmd = trim($_GET['pagename'],'/\\');
687 elseif (x($_GET,'q'))
688 $this->cmd = trim($_GET['q'],'/\\');
692 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
695 // unix style "homedir"
697 if(substr($this->cmd,0,1) === '~')
698 $this->cmd = 'profile/' . substr($this->cmd,1);
700 // Diaspora style profile url
702 if(substr($this->cmd,0,2) === 'u/')
703 $this->cmd = 'profile/' . substr($this->cmd,2);
708 * Break the URL path into C style argc/argv style arguments for our
709 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
710 * will be 3 (integer) and $this->argv will contain:
716 * There will always be one argument. If provided a naked domain
717 * URL, $this->argv[0] is set to "home".
721 $this->argv = explode('/',$this->cmd);
722 $this->argc = count($this->argv);
723 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
724 $this->module = str_replace(".", "_", $this->argv[0]);
725 $this->module = str_replace("-", "_", $this->module);
729 $this->argv = array('home');
730 $this->module = 'home';
734 * See if there is any page number information, and initialise
738 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
739 $this->pager['itemspage'] = 50;
740 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
741 if($this->pager['start'] < 0)
742 $this->pager['start'] = 0;
743 $this->pager['total'] = 0;
746 * Detect mobile devices
749 $mobile_detect = new Mobile_Detect();
750 $this->is_mobile = $mobile_detect->isMobile();
751 $this->is_tablet = $mobile_detect->isTablet();
754 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
757 * register template engines
759 $dc = get_declared_classes();
760 foreach ($dc as $k) {
761 if (in_array("ITemplateEngine", class_implements($k))){
762 $this->register_template_engine($k);
770 public static function get_basepath() {
772 $basepath = get_config("system", "basepath");
775 $basepath = dirname(__FILE__);
778 $basepath = $_SERVER["DOCUMENT_ROOT"];
781 $basepath = $_SERVER["PWD"];
786 function get_scheme() {
787 return($this->scheme);
791 * @brief Retrieves the Friendica instance base URL
793 * This function assembles the base URL from multiple parts:
794 * - Protocol is determined either by the request or a combination of
795 * system.ssl_policy and the $ssl parameter.
796 * - Host name is determined either by system.hostname or inferred from request
797 * - Path is inferred from SCRIPT_NAME
799 * Caches the result (depending on $ssl value) for performance.
801 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
803 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
804 * @return string Friendica server base URL
806 function get_baseurl($ssl = false) {
808 // Is the function called statically?
809 if (!is_object($this)) {
810 return self::$a->get_baseurl($ssl);
813 // Arbitrary values, the resulting url protocol can be different
814 $cache_index = $ssl ? 'https' : 'http';
816 // Cached value found, nothing to process
817 if (isset($this->baseurl[$cache_index])) {
818 return $this->baseurl[$cache_index];
821 $scheme = $this->scheme;
823 if ((x($this->config, 'system')) && (x($this->config['system'], 'ssl_policy'))) {
824 if (intval($this->config['system']['ssl_policy']) === SSL_POLICY_FULL) {
828 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
829 // (and also the login link). Anything seen by an outsider will have it turned off.
831 if ($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) {
840 if (get_config('config', 'hostname') != '') {
841 $this->hostname = get_config('config', 'hostname');
844 $this->baseurl[$cache_index] = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
846 return $this->baseurl[$cache_index];
850 * @brief Initializes the baseurl components
852 * Clears the baseurl cache to prevent inconstistencies
856 function set_baseurl($url) {
857 $parsed = @parse_url($url);
862 $this->scheme = $parsed['scheme'];
864 $hostname = $parsed['host'];
865 if (x($parsed, 'port')) {
866 $hostname .= ':' . $parsed['port'];
868 if (x($parsed, 'path')) {
869 $this->path = trim($parsed['path'], '\\/');
872 if (file_exists(".htpreconfig.php")) {
873 @include(".htpreconfig.php");
876 if (get_config('config', 'hostname') != '') {
877 $this->hostname = get_config('config', 'hostname');
880 if (!isset($this->hostname) OR ($this->hostname == '')) {
881 $this->hostname = $hostname;
886 function get_hostname() {
887 if (get_config('config','hostname') != "")
888 $this->hostname = get_config('config','hostname');
890 return $this->hostname;
893 function set_hostname($h) {
894 $this->hostname = $h;
897 function set_path($p) {
898 $this->path = trim(trim($p),'/');
901 function get_path() {
905 function set_pager_total($n) {
906 $this->pager['total'] = intval($n);
909 function set_pager_itemspage($n) {
910 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
911 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
914 function set_pager_page($n) {
915 $this->pager['page'] = $n;
916 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
919 function init_pagehead() {
920 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
922 // If the update is "deactivated" set it to the highest integer number (~24 days)
924 $interval = 2147483647;
926 if($interval < 10000)
929 // compose the page title from the sitename and the
930 // current module called
931 if (!$this->module=='')
933 $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
935 $this->page['title'] = $this->config['sitename'];
938 /* put the head template at the beginning of page['htmlhead']
939 * since the code added by the modules frequently depends on it
942 if(!isset($this->page['htmlhead']))
943 $this->page['htmlhead'] = '';
945 // If we're using Smarty, then doing replace_macros() will replace
946 // any unrecognized variables with a blank string. Since we delay
947 // replacing $stylesheet until later, we need to replace it now
948 // with another variable name
949 if($this->theme['template_engine'] === 'smarty3')
950 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
952 $stylesheet = '$stylesheet';
954 $shortcut_icon = get_config("system", "shortcut_icon");
955 if ($shortcut_icon == "")
956 $shortcut_icon = "images/friendica-32.png";
958 $touch_icon = get_config("system", "touch_icon");
959 if ($touch_icon == "")
960 $touch_icon = "images/friendica-128.png";
962 // get data wich is needed for infinite scroll on the network page
963 $invinite_scroll = infinite_scroll_data($this->module);
965 $tpl = get_markup_template('head.tpl');
966 $this->page['htmlhead'] = replace_macros($tpl,array(
967 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
968 '$local_user' => local_user(),
969 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
970 '$delitem' => t('Delete this item?'),
971 '$comment' => t('Comment'),
972 '$showmore' => t('show more'),
973 '$showfewer' => t('show fewer'),
974 '$update_interval' => $interval,
975 '$shortcut_icon' => $shortcut_icon,
976 '$touch_icon' => $touch_icon,
977 '$stylesheet' => $stylesheet,
978 '$infinite_scroll' => $invinite_scroll,
979 )) . $this->page['htmlhead'];
982 function init_page_end() {
983 if(!isset($this->page['end']))
984 $this->page['end'] = '';
985 $tpl = get_markup_template('end.tpl');
986 $this->page['end'] = replace_macros($tpl,array(
987 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
988 )) . $this->page['end'];
991 function set_curl_code($code) {
992 $this->curl_code = $code;
995 function get_curl_code() {
996 return $this->curl_code;
999 function set_curl_content_type($content_type) {
1000 $this->curl_content_type = $content_type;
1003 function get_curl_content_type() {
1004 return $this->curl_content_type;
1007 function set_curl_headers($headers) {
1008 $this->curl_headers = $headers;
1011 function get_curl_headers() {
1012 return $this->curl_headers;
1015 function get_cached_avatar_image($avatar_image){
1016 return $avatar_image;
1018 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
1020 if($this->cached_profile_image[$avatar_image])
1021 return $this->cached_profile_image[$avatar_image];
1023 $path_parts = explode("/",$avatar_image);
1024 $common_filename = $path_parts[count($path_parts)-1];
1026 if($this->cached_profile_picdate[$common_filename]){
1027 $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
1029 $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
1031 if(! dbm::is_result($r)){
1032 $this->cached_profile_image[$avatar_image] = $avatar_image;
1034 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
1035 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
1038 return $this->cached_profile_image[$avatar_image];
1044 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1046 * @param string $orig_url
1048 * @return string The cleaned url
1050 function remove_baseurl($orig_url){
1052 // Is the function called statically?
1053 if (!is_object($this)) {
1054 return(self::$a->remove_baseurl($orig_url));
1057 // Remove the hostname from the url if it is an internal link
1058 $nurl = normalise_link($orig_url);
1059 $base = normalise_link($this->get_baseurl());
1060 $url = str_replace($base."/", "", $nurl);
1062 // if it is an external link return the orignal value
1063 if ($url == normalise_link($orig_url)) {
1071 * @brief Register template engine class
1073 * If $name is "", is used class static property $class::$name
1075 * @param string $class
1076 * @param string $name
1078 function register_template_engine($class, $name = '') {
1080 $v = get_class_vars( $class );
1081 if(x($v,"name")) $name = $v['name'];
1084 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1087 $this->template_engines[$name] = $class;
1091 * @brief Return template engine instance.
1093 * If $name is not defined, return engine defined by theme,
1096 * @param strin $name Template engine name
1097 * @return object Template Engine instance
1099 function template_engine($name = ''){
1101 $template_engine = $name;
1103 $template_engine = 'smarty3';
1104 if (x($this->theme, 'template_engine')) {
1105 $template_engine = $this->theme['template_engine'];
1109 if (isset($this->template_engines[$template_engine])){
1110 if(isset($this->template_engine_instance[$template_engine])){
1111 return $this->template_engine_instance[$template_engine];
1113 $class = $this->template_engines[$template_engine];
1115 $this->template_engine_instance[$template_engine] = $obj;
1120 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1124 * @brief Returns the active template engine.
1128 function get_template_engine() {
1129 return $this->theme['template_engine'];
1132 function set_template_engine($engine = 'smarty3') {
1133 $this->theme['template_engine'] = $engine;
1135 $this->theme['template_engine'] = 'smarty3';
1139 if(is_writable('view/smarty3/'))
1140 $this->theme['template_engine'] = 'smarty3';
1148 function get_template_ldelim($engine = 'smarty3') {
1149 return $this->ldelim[$engine];
1152 function get_template_rdelim($engine = 'smarty3') {
1153 return $this->rdelim[$engine];
1156 function save_timestamp($stamp, $value) {
1157 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler'])
1160 $duration = (float)(microtime(true)-$stamp);
1162 if (!isset($this->performance[$value])) {
1163 // Prevent ugly E_NOTICE
1164 $this->performance[$value] = 0;
1167 $this->performance[$value] += (float)$duration;
1168 $this->performance["marktime"] += (float)$duration;
1170 $callstack = $this->callstack();
1172 if (!isset($this->callstack[$value][$callstack])) {
1173 // Prevent ugly E_NOTICE
1174 $this->callstack[$value][$callstack] = 0;
1177 $this->callstack[$value][$callstack] += (float)$duration;
1182 * @brief Log active processes into the "process" table
1184 function start_process() {
1185 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1187 $command = basename($trace[0]["file"]);
1189 $this->remove_inactive_processes();
1191 q("START TRANSACTION");
1193 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1194 if(!dbm::is_result($r)) {
1195 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1198 dbesc(datetime_convert()));
1204 * @brief Remove inactive processes
1206 function remove_inactive_processes() {
1207 q("START TRANSACTION");
1209 $r = q("SELECT `pid` FROM `process`");
1210 if(dbm::is_result($r)) {
1211 foreach ($r AS $process) {
1212 if (!posix_kill($process["pid"], 0)) {
1213 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1221 * @brief Remove the active process from the "process" table
1223 function end_process() {
1224 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1228 * @brief Returns a string with a callstack. Can be used for logging.
1232 function callstack() {
1233 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1235 // We remove the first two items from the list since they contain data that we don't need.
1236 array_shift($trace);
1237 array_shift($trace);
1239 $callstack = array();
1240 foreach ($trace AS $func)
1241 $callstack[] = $func["function"];
1243 return implode(", ", $callstack);
1246 function get_useragent() {
1247 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1250 function is_friendica_app() {
1251 return($this->is_friendica_app);
1255 * @brief Checks if the site is called via a backend process
1257 * This isn't a perfect solution. But we need this check very early.
1258 * So we cannot wait until the modules are loaded.
1260 * @return bool Is it a known backend?
1262 function is_backend() {
1264 $backend[] = "_well_known";
1266 $backend[] = "dfrn_notify";
1267 $backend[] = "fetch";
1268 $backend[] = "hcard";
1269 $backend[] = "hostxrd";
1270 $backend[] = "nodeinfo";
1271 $backend[] = "noscrape";
1273 $backend[] = "poco";
1274 $backend[] = "post";
1275 $backend[] = "proxy";
1276 $backend[] = "pubsub";
1277 $backend[] = "pubsubhubbub";
1278 $backend[] = "receive";
1279 $backend[] = "rsd_xml";
1280 $backend[] = "salmon";
1281 $backend[] = "statistics_json";
1284 if (in_array($this->module, $backend))
1287 return($this->backend);
1291 * @brief Checks if the maximum number of database processes is reached
1293 * @return bool Is the limit reached?
1295 function max_processes_reached() {
1297 if ($this->is_backend()) {
1298 $process = "backend";
1299 $max_processes = get_config('system', 'max_processes_backend');
1300 if (intval($max_processes) == 0)
1303 $process = "frontend";
1304 $max_processes = get_config('system', 'max_processes_frontend');
1305 if (intval($max_processes) == 0)
1306 $max_processes = 20;
1309 $processlist = dbm::processlist();
1310 if ($processlist["list"] != "") {
1311 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1313 if ($processlist["amount"] > $max_processes) {
1314 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1322 * @brief Checks if the maximum load is reached
1324 * @return bool Is the load reached?
1326 function maxload_reached() {
1328 if ($this->is_backend()) {
1329 $process = "backend";
1330 $maxsysload = intval(get_config('system', 'maxloadavg'));
1331 if ($maxsysload < 1)
1334 $process = "frontend";
1335 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1336 if ($maxsysload < 1)
1340 $load = current_load();
1342 if (intval($load) > $maxsysload) {
1343 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1351 * @brief Checks if the process is already running
1353 * @param string $taskname The name of the task that will be used for the name of the lockfile
1354 * @param string $task The path and name of the php script
1355 * @param int $timeout The timeout after which a task should be killed
1357 * @return bool Is the process running?
1359 function is_already_running($taskname, $task = "", $timeout = 540) {
1361 $lockpath = get_lockpath();
1362 if ($lockpath != '') {
1363 $pidfile = new pidfile($lockpath, $taskname);
1364 if ($pidfile->is_already_running()) {
1365 logger("Already running");
1366 if ($pidfile->running_time() > $timeout) {
1368 logger("killed stale process");
1369 // Calling a new instance
1371 proc_run(PRIORITY_MEDIUM, $task);
1379 function proc_run($args) {
1381 if (!function_exists("proc_open")) {
1385 // Add the php path if it is a php call
1386 if (count($args) && ($args[0] === 'php' OR !is_string($args[0]))) {
1388 // If the last worker fork was less than 10 seconds before then don't fork another one.
1389 // This should prevent the forking of masses of workers.
1390 if (get_config("system", "worker")) {
1391 if ((time() - get_config("system", "proc_run_started")) < 10)
1394 // Set the timestamp of the last proc_run
1395 set_config("system", "proc_run_started", time());
1398 $args[0] = ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php');
1401 // add baseurl to args. cli scripts can't construct it
1402 $args[] = $this->get_baseurl();
1404 for($x = 0; $x < count($args); $x ++)
1405 $args[$x] = escapeshellarg($args[$x]);
1407 $cmdline = implode($args," ");
1409 if(get_config('system','proc_windows'))
1410 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1412 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1418 * @brief Retrieve the App structure
1420 * Useful in functions which require it but don't get it passed to them
1422 function get_app() {
1429 * @brief Multi-purpose function to check variable state.
1431 * Usage: x($var) or $x($array, 'key')
1433 * returns false if variable/key is not set
1434 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1435 * e.g. x('') or x(0) returns 0;
1437 * @param string|array $s variable to check
1438 * @param string $k key inside the array to check
1442 function x($s,$k = NULL) {
1444 if((is_array($s)) && (array_key_exists($k,$s))) {
1464 * @brief Called from db initialisation if db is dead.
1466 function system_unavailable() {
1467 include('system_unavailable.php');
1473 function clean_urls() {
1475 // if($a->config['system']['clean_urls'])
1482 $base = $a->get_baseurl();
1489 * @brief Returns the baseurl.
1491 * @see App::get_baseurl()
1497 return $a->get_baseurl();
1501 * @brief Return absolut URL for given $path.
1503 * @param string $path
1507 function absurl($path) {
1508 if(strpos($path,'/') === 0)
1509 return z_path() . $path;
1514 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1518 function is_ajax() {
1519 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1522 function check_db() {
1524 $build = get_config('system','build');
1526 set_config('system','build',DB_UPDATE_VERSION);
1527 $build = DB_UPDATE_VERSION;
1529 if($build != DB_UPDATE_VERSION)
1530 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1536 * Sets the base url for use in cmdline programs which don't have
1537 * $_SERVER variables
1539 function check_url(&$a) {
1541 $url = get_config('system','url');
1543 // if the url isn't set or the stored url is radically different
1544 // than the currently visited url, store the current value accordingly.
1545 // "Radically different" ignores common variations such as http vs https
1546 // and www.example.com vs example.com.
1547 // We will only change the url to an ip address if there is no existing setting
1550 $url = set_config('system','url',$a->get_baseurl());
1551 if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1552 $url = set_config('system','url',$a->get_baseurl());
1559 * @brief Automatic database updates
1561 function update_db(&$a) {
1562 $build = get_config('system','build');
1564 $build = set_config('system','build',DB_UPDATE_VERSION);
1566 if($build != DB_UPDATE_VERSION) {
1567 $stored = intval($build);
1568 $current = intval(DB_UPDATE_VERSION);
1569 if($stored < $current) {
1570 load_config('database');
1572 // We're reporting a different version than what is currently installed.
1573 // Run any existing update scripts to bring the database up to current.
1575 // make sure that boot.php and update.php are the same release, we might be
1576 // updating right this very second and the correct version of the update.php
1577 // file may not be here yet. This can happen on a very busy site.
1579 if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1580 // Compare the current structure with the defined structure
1582 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1586 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1588 // run old update routine (wich could modify the schema and
1589 // conflits with new routine)
1590 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1591 $r = run_update_function($x);
1594 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1597 // run new update routine
1598 // it update the structure in one call
1599 $retval = update_structure(false, true);
1607 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1610 // run any left update_nnnn functions in update.php
1611 for($x = $stored; $x < $current; $x ++) {
1612 $r = run_update_function($x);
1622 function run_update_function($x) {
1623 if(function_exists('update_' . $x)) {
1625 // There could be a lot of processes running or about to run.
1626 // We want exactly one process to run the update command.
1627 // So store the fact that we're taking responsibility
1628 // after first checking to see if somebody else already has.
1630 // If the update fails or times-out completely you may need to
1631 // delete the config entry to try again.
1633 $t = get_config('database','update_' . $x);
1636 set_config('database','update_' . $x, time());
1638 // call the specific update
1640 $func = 'update_' . $x;
1644 //send the administrator an e-mail
1647 sprintf(t('Update %s failed. See error logs.'), $x)
1651 set_config('database','update_' . $x, 'success');
1652 set_config('system','build', $x + 1);
1656 set_config('database','update_' . $x, 'success');
1657 set_config('system','build', $x + 1);
1664 * @brief Synchronise plugins:
1666 * $a->config['system']['addon'] contains a comma-separated list of names
1667 * of plugins/addons which are used on this system.
1668 * Go through the database list of already installed addons, and if we have
1669 * an entry, but it isn't in the config list, call the uninstall procedure
1670 * and mark it uninstalled in the database (for now we'll remove it).
1671 * Then go through the config list and if we have a plugin that isn't installed,
1672 * call the install procedure and add it to the database.
1677 function check_plugins(&$a) {
1679 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1680 if(dbm::is_result($r))
1683 $installed = array();
1685 $plugins = get_config('system','addon');
1686 $plugins_arr = array();
1689 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1691 $a->plugins = $plugins_arr;
1693 $installed_arr = array();
1695 if(count($installed)) {
1696 foreach($installed as $i) {
1697 if(! in_array($i['name'],$plugins_arr)) {
1698 uninstall_plugin($i['name']);
1701 $installed_arr[] = $i['name'];
1706 if(count($plugins_arr)) {
1707 foreach($plugins_arr as $p) {
1708 if(! in_array($p,$installed_arr)) {
1720 function get_guid($size=16, $prefix = "") {
1722 if ($prefix == "") {
1724 $prefix = hash("crc32", $a->get_hostname());
1727 while (strlen($prefix) < ($size - 13))
1728 $prefix .= mt_rand();
1731 $prefix = substr($prefix, 0, $size - 22);
1732 return(str_replace(".", "", uniqid($prefix, true)));
1734 $prefix = substr($prefix, 0, max($size - 13, 0));
1735 return(uniqid($prefix));
1740 * @brief Wrapper for adding a login box.
1742 * @param bool $register
1743 * If $register == true provide a registration link.
1744 * This will most always depend on the value of $a->config['register_policy'].
1745 * @param bool $hiddens
1748 * Returns the complete html for inserting into the page
1750 * @hooks 'login_hook'
1753 function login($register = false, $hiddens=false) {
1759 'title' => t('Create a New Account'),
1760 'desc' => t('Register')
1764 $noid = get_config('system','no_openid');
1766 $dest_url = $a->query_string;
1769 $tpl = get_markup_template("logout.tpl");
1772 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1773 '$baseurl' => $a->get_baseurl(true)
1776 $tpl = get_markup_template("login.tpl");
1777 $_SESSION['return_url'] = $a->query_string;
1778 $a->module = 'login';
1781 $o .= replace_macros($tpl, array(
1783 '$dest_url' => $dest_url,
1784 '$logout' => t('Logout'),
1785 '$login' => t('Login'),
1787 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1788 '$lpassword' => array('password', t('Password: '), '', ''),
1789 '$lremember' => array('remember', t('Remember me'), 0, ''),
1791 '$openid' => !$noid,
1792 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1794 '$hiddens' => $hiddens,
1796 '$register' => $reg,
1798 '$lostpass' => t('Forgot your password?'),
1799 '$lostlink' => t('Password Reset'),
1801 '$tostitle' => t('Website Terms of Service'),
1802 '$toslink' => t('terms of service'),
1804 '$privacytitle' => t('Website Privacy Policy'),
1805 '$privacylink' => t('privacy policy'),
1809 call_hooks('login_hook',$o);
1815 * @brief Used to end the current process, after saving session state.
1819 if (!get_app()->is_backend())
1820 session_write_close();
1826 * @brief Redirect to another URL and terminate this process.
1828 function goaway($s) {
1829 if (!strstr(normalise_link($s), "http://"))
1830 $s = App::get_baseurl()."/".$s;
1832 header("Location: $s");
1838 * @brief Returns the user id of locally logged in user or false.
1840 * @return int|bool user id or false
1842 function local_user() {
1843 if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1844 return intval($_SESSION['uid']);
1849 * @brief Returns contact id of authenticated site visitor or false
1851 * @return int|bool visitor_id or false
1853 function remote_user() {
1854 if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1855 return intval($_SESSION['visitor_id']);
1860 * @brief Show an error message to user.
1862 * This function save text in session, to be shown to the user at next page load
1864 * @param string $s - Text of notice
1866 function notice($s) {
1868 if(! x($_SESSION,'sysmsg')) $_SESSION['sysmsg'] = array();
1870 $_SESSION['sysmsg'][] = $s;
1874 * @brief Show an info message to user.
1876 * This function save text in session, to be shown to the user at next page load
1878 * @param string $s - Text of notice
1883 if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1886 if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1888 $_SESSION['sysmsg_info'][] = $s;
1893 * @brief Wrapper around config to limit the text length of an incoming message
1897 function get_max_import_size() {
1899 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1903 * @brief Wrap calls to proc_close(proc_open()) and call hook
1904 * so plugins can take part in process :)
1906 * @param (string|integer|array) $cmd program to run, priority or parameter array
1908 * next args are passed as $cmd command line
1909 * e.g.: proc_run("ls","-la","/tmp");
1910 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1911 * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1913 * @note $cmd and string args are surrounded with ""
1918 function proc_run($cmd){
1922 $proc_args = func_get_args();
1925 if (!count($proc_args)) {
1929 // Preserve the first parameter
1930 // It could contain a command, the priority or an parameter array
1931 // If we use the parameter array we have to protect it from the following function
1932 $run_parameter = array_shift($proc_args);
1934 // expand any arrays
1935 foreach ($proc_args as $arg) {
1936 if (is_array($arg)) {
1937 foreach ($arg as $n) {
1945 // Now we add the run parameters back to the array
1946 array_unshift($args, $run_parameter);
1948 $arr = array('args' => $args, 'run_cmd' => true);
1950 call_hooks("proc_run", $arr);
1951 if (!$arr['run_cmd'] OR !count($args))
1954 if (!get_config("system", "worker") OR (is_string($run_parameter) AND ($run_parameter != 'php'))) {
1955 $a->proc_run($args);
1959 $priority = PRIORITY_MEDIUM;
1960 $dont_fork = get_config("system", "worker_dont_fork");
1962 if (is_int($run_parameter)) {
1963 $priority = $run_parameter;
1964 } elseif (is_array($run_parameter)) {
1965 if (isset($run_parameter['priority'])) {
1966 $priority = $run_parameter['priority'];
1968 if (isset($run_parameter['dont_fork'])) {
1969 $dont_fork = $run_parameter['dont_fork'];
1976 $parameters = json_encode($argv);
1977 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1978 dbesc($parameters));
1981 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1982 VALUES ('%s', '%s', %d)",
1984 dbesc(datetime_convert()),
1987 // Should we quit and wait for the poller to be called as a cronjob?
1992 // Checking number of workers
1993 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1995 // Get number of allowed number of worker threads
1996 $queues = intval(get_config("system", "worker_queues"));
2001 // If there are already enough workers running, don't fork another one
2002 if ($workers[0]["workers"] >= $queues)
2005 // Now call the poller to execute the jobs that we just added to the queue
2006 $args = array("php", "include/poller.php", "no_cron");
2008 $a->proc_run($args);
2011 function current_theme(){
2012 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2018 // Find the theme that belongs to the user whose stuff we are looking at
2020 if($a->profile_uid && ($a->profile_uid != local_user())) {
2021 $r = q("select theme from user where uid = %d limit 1",
2022 intval($a->profile_uid)
2024 if(dbm::is_result($r))
2025 $page_theme = $r[0]['theme'];
2028 // Allow folks to over-rule user themes and always use their own on their own site.
2029 // This works only if the user is on the same server
2031 if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2032 if(get_pconfig(local_user(),'system','always_my_theme'))
2036 // $mobile_detect = new Mobile_Detect();
2037 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2038 $is_mobile = $a->is_mobile || $a->is_tablet;
2040 $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
2041 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2044 if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2045 $system_theme = $standard_system_theme;
2046 $theme_name = $standard_theme_name;
2049 $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme);
2050 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2052 if($theme_name === '---') {
2053 // user has selected to have the mobile theme be the same as the normal one
2054 $system_theme = $standard_system_theme;
2055 $theme_name = $standard_theme_name;
2058 $theme_name = $page_theme;
2063 $system_theme = $standard_system_theme;
2064 $theme_name = $standard_theme_name;
2067 $theme_name = $page_theme;
2071 (file_exists('view/theme/' . $theme_name . '/style.css') ||
2072 file_exists('view/theme/' . $theme_name . '/style.php')))
2073 return($theme_name);
2075 foreach($app_base_themes as $t) {
2076 if(file_exists('view/theme/' . $t . '/style.css')||
2077 file_exists('view/theme/' . $t . '/style.php'))
2081 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2082 if(count($fallback))
2083 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2088 * @brief Return full URL to theme which is currently in effect.
2090 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2094 function current_theme_url() {
2097 $t = current_theme();
2099 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2100 if (file_exists('view/theme/' . $t . '/style.php'))
2101 return('view/theme/'.$t.'/style.pcss'.$opts);
2103 return('view/theme/'.$t.'/style.css');
2106 function feed_birthday($uid,$tz) {
2110 * Determine the next birthday, but only if the birthday is published
2111 * in the default profile. We _could_ also look for a private profile that the
2112 * recipient can see, but somebody could get mad at us if they start getting
2113 * public birthday greetings when they haven't made this info public.
2115 * Assuming we are able to publish this info, we are then going to convert
2116 * the start time from the owner's timezone to UTC.
2118 * This will potentially solve the problem found with some social networks
2119 * where birthdays are converted to the viewer's timezone and salutations from
2120 * elsewhere in the world show up on the wrong day. We will convert it to the
2121 * viewer's timezone also, but first we are going to convert it from the birthday
2122 * person's timezone to GMT - so the viewer may find the birthday starting at
2123 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2133 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2137 if(dbm::is_result($p)) {
2138 $tmp_dob = substr($p[0]['dob'],5);
2139 if(intval($tmp_dob)) {
2140 $y = datetime_convert($tz,$tz,'now','Y');
2141 $bd = $y . '-' . $tmp_dob . ' 00:00';
2142 $t_dob = strtotime($bd);
2143 $now = strtotime(datetime_convert($tz,$tz,'now'));
2145 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2146 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2154 * @brief Check if current user has admin role.
2156 * @return bool true if user is an admin
2158 function is_site_admin() {
2161 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2163 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2164 if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2170 * @brief Returns querystring as string from a mapped array.
2172 * @param array $params mapped array with query parameters
2173 * @param string $name of parameter, default null
2177 function build_querystring($params, $name=null) {
2179 foreach($params as $key=>$val) {
2180 if(is_array($val)) {
2182 $ret .= build_querystring($val, $key);
2184 $ret .= build_querystring($val, $name."[$key]");
2187 $val = urlencode($val);
2189 $ret.=$name."[$key]"."=$val&";
2191 $ret.= "$key=$val&";
2198 function explode_querystring($query) {
2199 $arg_st = strpos($query, '?');
2200 if($arg_st !== false) {
2201 $base = substr($query, 0, $arg_st);
2208 $args = explode('&', substr($query, $arg_st));
2209 foreach($args as $k=>$arg) {
2213 $args = array_values($args);
2218 $args = array_values($args);
2228 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2230 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2232 function curPageURL() {
2234 if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
2236 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2237 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2239 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2244 function random_digits($digits) {
2246 for($i = 0; $i < $digits; $i++) {
2252 function get_server() {
2253 $server = get_config("system", "directory");
2256 $server = "http://dir.friendi.ca";
2261 function get_cachefile($file, $writemode = true) {
2262 $cache = get_itemcachepath();
2264 if ((! $cache) || (! is_dir($cache)))
2267 $subfolder = $cache."/".substr($file, 0, 2);
2269 $cachepath = $subfolder."/".$file;
2272 if (!is_dir($subfolder)) {
2274 chmod($subfolder, 0777);
2281 function clear_cache($basepath = "", $path = "") {
2283 $basepath = get_itemcachepath();
2287 if (($path == "") OR (!is_dir($path)))
2290 if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2293 $cachetime = (int)get_config('system','itemcache_duration');
2294 if ($cachetime == 0)
2297 if (is_writable($path)){
2298 if ($dh = opendir($path)) {
2299 while (($file = readdir($dh)) !== false) {
2300 $fullpath = $path."/".$file;
2301 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2302 clear_cache($basepath, $fullpath);
2303 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2311 function get_itemcachepath() {
2312 // Checking, if the cache is deactivated
2313 $cachetime = (int)get_config('system','itemcache_duration');
2317 $itemcache = get_config('system','itemcache');
2318 if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2321 $temppath = get_temppath();
2323 if ($temppath != "") {
2324 $itemcache = $temppath."/itemcache";
2325 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2329 if (is_dir($itemcache) AND is_writable($itemcache)) {
2330 set_config("system", "itemcache", $itemcache);
2337 function get_lockpath() {
2338 $lockpath = get_config('system','lockpath');
2339 if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2342 $temppath = get_temppath();
2344 if ($temppath != "") {
2345 $lockpath = $temppath."/lock";
2347 if (!is_dir($lockpath))
2349 elseif (!is_writable($lockpath))
2350 $lockpath = $temppath;
2352 if (is_dir($lockpath) AND is_writable($lockpath)) {
2353 set_config("system", "lockpath", $lockpath);
2361 * @brief Returns the path where spool files are stored
2363 * @return string Spool path
2365 function get_spoolpath() {
2366 $spoolpath = get_config('system','spoolpath');
2367 if (($spoolpath != "") AND is_dir($spoolpath) AND is_writable($spoolpath)) {
2371 $temppath = get_temppath();
2373 if ($temppath != "") {
2374 $spoolpath = $temppath."/spool";
2376 if (!is_dir($spoolpath)) {
2378 } elseif (!is_writable($spoolpath)) {
2379 $spoolpath = $temppath;
2382 if (is_dir($spoolpath) AND is_writable($spoolpath)) {
2383 set_config("system", "spoolpath", $spoolpath);
2390 function get_temppath() {
2393 $temppath = get_config("system","temppath");
2394 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2397 $temppath = sys_get_temp_dir();
2398 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2399 $temppath .= "/".$a->get_hostname();
2400 if (!is_dir($temppath))
2403 if (is_dir($temppath) AND is_writable($temppath)) {
2404 set_config("system", "temppath", $temppath);
2412 function set_template_engine(&$a, $engine = 'internal') {
2413 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2414 /// to avoid breaking themes again unnecessarily
2416 $a->set_template_engine($engine);
2419 if(!function_exists('exif_imagetype')) {
2420 function exif_imagetype($file) {
2421 $size = getimagesize($file);
2426 function validate_include(&$file) {
2429 $file = realpath($file);
2431 if (strpos($file, getcwd()) !== 0)
2434 $file = str_replace(getcwd()."/", "", $file, $count);
2438 if ($orig_file !== $file)
2442 if (strpos($file, "include/") === 0)
2445 if (strpos($file, "addon/") === 0)
2454 function current_load() {
2455 if (!function_exists('sys_getloadavg'))
2458 $load_arr = sys_getloadavg();
2460 if (!is_array($load_arr))
2463 return max($load_arr[0], $load_arr[1]);
2467 * @brief get c-style args
2472 return get_app()->argc;
2476 * @brief Returns the value of a argv key
2478 * @param int $x argv key
2479 * @return string Value of the argv key
2482 if(array_key_exists($x,get_app()->argv))
2483 return get_app()->argv[$x];
2489 * @brief Get the data which is needed for infinite scroll
2491 * For invinite scroll we need the page number of the actual page
2492 * and the the URI where the content of the next page comes from.
2493 * This data is needed for the js part in main.js.
2494 * Note: infinite scroll does only work for the network page (module)
2496 * @param string $module The name of the module (e.g. "network")
2497 * @return array Of infinite scroll data
2498 * 'pageno' => $pageno The number of the actual page
2499 * 'reload_uri' => $reload_uri The URI of the content we have to load
2501 function infinite_scroll_data($module) {
2503 if (get_pconfig(local_user(),'system','infinite_scroll')
2504 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2506 // get the page number
2507 if (is_string($_GET["page"]))
2508 $pageno = $_GET["page"];
2514 // try to get the uri from which we load the content
2515 foreach ($_GET AS $param => $value)
2516 if (($param != "page") AND ($param != "q"))
2517 $reload_uri .= "&".$param."=".urlencode($value);
2519 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2520 $reload_uri .= "&offset=".urlencode($a->page_offset);
2522 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);