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 use \Friendica\Core\Config;
24 require_once('include/config.php');
25 require_once('include/network.php');
26 require_once('include/plugin.php');
27 require_once('include/text.php');
28 require_once('include/datetime.php');
29 require_once('include/pgettext.php');
30 require_once('include/nav.php');
31 require_once('include/cache.php');
32 require_once('library/Mobile_Detect/Mobile_Detect.php');
33 require_once('include/features.php');
34 require_once('include/identity.php');
35 require_once('update.php');
36 require_once('include/dbstructure.php');
38 define ( 'FRIENDICA_PLATFORM', 'Friendica');
39 define ( 'FRIENDICA_CODENAME', 'Asparagus');
40 define ( 'FRIENDICA_VERSION', '3.5.2-dev' );
41 define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
42 define ( 'DB_UPDATE_VERSION', 1216 );
45 * @brief Constant with a HTML line break.
47 * Contains a HTML line break (br) element and a real carriage return with line
48 * feed for the source.
49 * This can be used in HTML and JavaScript where needed a line break.
51 define ( 'EOL', "<br />\r\n" );
52 define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
56 * @brief Image storage quality.
58 * Lower numbers save space at cost of image detail.
59 * For ease of upgrade, please do not change here. Change jpeg quality with
60 * $a->config['system']['jpeg_quality'] = n;
61 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
66 define ( 'JPEG_QUALITY', 100 );
68 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
70 define ( 'PNG_QUALITY', 8 );
74 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
75 * length that pictures are allowed to be (for non-square pictures, it will apply
76 * to the longest side). Pictures longer than this length will be resized to be
77 * this length (on the longest side, the other side will be scaled appropriately).
78 * Modify this value using
80 * $a->config['system']['max_image_length'] = n;
84 * If you don't want to set a maximum length, set to -1. The default value is
85 * defined by 'MAX_IMAGE_LENGTH' below.
88 define ( 'MAX_IMAGE_LENGTH', -1 );
95 define ( 'DEFAULT_DB_ENGINE', 'MyISAM' );
100 * SSL redirection policies
103 define ( 'SSL_POLICY_NONE', 0 );
104 define ( 'SSL_POLICY_FULL', 1 );
105 define ( 'SSL_POLICY_SELFSIGN', 2 );
114 define ( 'LOGGER_NORMAL', 0 );
115 define ( 'LOGGER_TRACE', 1 );
116 define ( 'LOGGER_DEBUG', 2 );
117 define ( 'LOGGER_DATA', 3 );
118 define ( 'LOGGER_ALL', 4 );
127 define ( 'CACHE_MONTH', 0 );
128 define ( 'CACHE_WEEK', 1 );
129 define ( 'CACHE_DAY', 2 );
130 define ( 'CACHE_HOUR', 3 );
131 define ( 'CACHE_HALF_HOUR', 4 );
132 define ( 'CACHE_QUARTER_HOUR', 5 );
133 define ( 'CACHE_FIVE_MINUTES', 6 );
134 define ( 'CACHE_MINUTE', 7 );
140 * Registration policies
143 define ( 'REGISTER_CLOSED', 0 );
144 define ( 'REGISTER_APPROVE', 1 );
145 define ( 'REGISTER_OPEN', 2 );
154 define ( 'CONTACT_IS_FOLLOWER', 1);
155 define ( 'CONTACT_IS_SHARING', 2);
156 define ( 'CONTACT_IS_FRIEND', 3);
162 * DB update return values
165 define ( 'UPDATE_SUCCESS', 0);
166 define ( 'UPDATE_FAILED', 1);
171 * @name page/profile types
173 * PAGE_NORMAL is a typical personal profile account
174 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
175 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
176 * write access to wall and comments (no email and not included in page owner's ACL lists)
177 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
181 define ( 'PAGE_NORMAL', 0 );
182 define ( 'PAGE_SOAPBOX', 1 );
183 define ( 'PAGE_COMMUNITY', 2 );
184 define ( 'PAGE_FREELOVE', 3 );
185 define ( 'PAGE_BLOG', 4 );
186 define ( 'PAGE_PRVGROUP', 5 );
190 * @name account types
192 * ACCOUNT_TYPE_PERSON - the account belongs to a person
193 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
195 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
196 * Associated page type: PAGE_SOAPBOX
198 * ACCOUNT_TYPE_NEWS - the account is a news reflector
199 * Associated page type: PAGE_SOAPBOX
201 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
202 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
205 define ( 'ACCOUNT_TYPE_PERSON', 0 );
206 define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
207 define ( 'ACCOUNT_TYPE_NEWS', 2 );
208 define ( 'ACCOUNT_TYPE_COMMUNITY', 3 );
214 * Type of the community page
217 define ( 'CP_NO_COMMUNITY_PAGE', -1 );
218 define ( 'CP_USERS_ON_SERVER', 0 );
219 define ( 'CP_GLOBAL_COMMUNITY', 1 );
225 * Network and protocol family types
228 define ( 'NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
229 define ( 'NETWORK_ZOT', 'zot!'); // Zot!
230 define ( 'NETWORK_OSTATUS', 'stat'); // status.net, identi.ca, GNU-social, other OStatus implementations
231 define ( 'NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
232 define ( 'NETWORK_DIASPORA', 'dspr'); // Diaspora
233 define ( 'NETWORK_MAIL', 'mail'); // IMAP/POP
234 define ( 'NETWORK_MAIL2', 'mai2'); // extended IMAP/POP
235 define ( 'NETWORK_FACEBOOK', 'face'); // Facebook API
236 define ( 'NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
237 define ( 'NETWORK_XMPP', 'xmpp'); // XMPP
238 define ( 'NETWORK_MYSPACE', 'mysp'); // MySpace
239 define ( 'NETWORK_GPLUS', 'goog'); // Google+
240 define ( 'NETWORK_PUMPIO', 'pump'); // pump.io
241 define ( 'NETWORK_TWITTER', 'twit'); // Twitter
242 define ( 'NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
243 define ( 'NETWORK_STATUSNET', 'stac'); // Statusnet connector
244 define ( 'NETWORK_APPNET', 'apdn'); // app.net
245 define ( 'NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol
246 define ( 'NETWORK_ICALENDAR', 'ical'); // iCalendar
247 define ( 'NETWORK_PNUT', 'pnut'); // pnut.io
248 define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
252 * These numbers are used in stored permissions
253 * and existing allocations MUST NEVER BE CHANGED
254 * OR RE-ASSIGNED! You may only add to them.
257 $netgroup_ids = array(
258 NETWORK_DFRN => (-1),
260 NETWORK_OSTATUS => (-3),
261 NETWORK_FEED => (-4),
262 NETWORK_DIASPORA => (-5),
263 NETWORK_MAIL => (-6),
264 NETWORK_MAIL2 => (-7),
265 NETWORK_FACEBOOK => (-8),
266 NETWORK_LINKEDIN => (-9),
267 NETWORK_XMPP => (-10),
268 NETWORK_MYSPACE => (-11),
269 NETWORK_GPLUS => (-12),
270 NETWORK_PUMPIO => (-13),
271 NETWORK_TWITTER => (-14),
272 NETWORK_DIASPORA2 => (-15),
273 NETWORK_STATUSNET => (-16),
274 NETWORK_APPNET => (-17),
275 NETWORK_NEWS => (-18),
276 NETWORK_ICALENDAR => (-19),
277 NETWORK_PNUT => (-20),
279 NETWORK_PHANTOM => (-127),
284 * Maximum number of "people who like (or don't like) this" that we will list by name
287 define ( 'MAX_LIKERS', 75);
290 * Communication timeout
293 define ( 'ZCURL_TIMEOUT' , (-1));
299 * Email notification options
302 define ( 'NOTIFY_INTRO', 0x0001 );
303 define ( 'NOTIFY_CONFIRM', 0x0002 );
304 define ( 'NOTIFY_WALL', 0x0004 );
305 define ( 'NOTIFY_COMMENT', 0x0008 );
306 define ( 'NOTIFY_MAIL', 0x0010 );
307 define ( 'NOTIFY_SUGGEST', 0x0020 );
308 define ( 'NOTIFY_PROFILE', 0x0040 );
309 define ( 'NOTIFY_TAGSELF', 0x0080 );
310 define ( 'NOTIFY_TAGSHARE', 0x0100 );
311 define ( 'NOTIFY_POKE', 0x0200 );
312 define ( 'NOTIFY_SHARE', 0x0400 );
314 define ( 'NOTIFY_SYSTEM', 0x8000 );
324 define ( 'TERM_UNKNOWN', 0 );
325 define ( 'TERM_HASHTAG', 1 );
326 define ( 'TERM_MENTION', 2 );
327 define ( 'TERM_CATEGORY', 3 );
328 define ( 'TERM_PCATEGORY', 4 );
329 define ( 'TERM_FILE', 5 );
330 define ( 'TERM_SAVEDSEARCH', 6 );
331 define ( 'TERM_CONVERSATION', 7 );
333 define ( 'TERM_OBJ_POST', 1 );
334 define ( 'TERM_OBJ_PHOTO', 2 );
341 * Various namespaces we may need to parse
344 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
345 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
346 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
347 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
348 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
349 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
350 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
351 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
352 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
353 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
354 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
355 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
356 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
357 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
358 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
364 * Activity stream defines
367 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
368 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
369 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
370 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
371 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
373 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
375 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
376 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
377 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
378 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
379 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
380 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
382 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
383 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
384 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
385 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
386 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
388 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
389 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
391 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
392 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
393 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
394 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
395 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
396 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
397 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
398 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
399 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
400 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
401 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
402 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
403 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
404 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
410 * Item weight for query ordering
413 define ( 'GRAVITY_PARENT', 0);
414 define ( 'GRAVITY_LIKE', 3);
415 define ( 'GRAVITY_COMMENT', 6);
421 * Process priority for the worker
424 define('PRIORITY_UNDEFINED', 0);
425 define('PRIORITY_CRITICAL', 10);
426 define('PRIORITY_HIGH', 20);
427 define('PRIORITY_MEDIUM', 30);
428 define('PRIORITY_LOW', 40);
429 define('PRIORITY_NEGLIGIBLE',50);
433 * @name Social Relay settings
435 * See here: https://github.com/jaywink/social-relay
436 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
439 define('SR_SCOPE_NONE', '');
440 define('SR_SCOPE_ALL', 'all');
441 define('SR_SCOPE_TAGS', 'tags');
445 * Lowest possible date time value
448 define ('NULL_DATE', '0001-01-01 00:00:00');
451 // Normally this constant is defined - but not if "pcntl" isn't installed
452 if (!defined("SIGTERM")) {
453 define("SIGTERM", 15);
457 * Reverse the effect of magic_quotes_gpc if it is enabled.
458 * Please disable magic_quotes_gpc so we don't have to do this.
459 * See http://php.net/manual/en/security.magicquotes.disabling.php
465 error_reporting(E_ERROR | E_WARNING | E_PARSE);
469 // This has to be quite large to deal with embedded private photos
470 ini_set('pcre.backtrack_limit', 500000);
473 if (get_magic_quotes_gpc()) {
474 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
475 while (list($key, $val) = each($process)) {
476 foreach ($val as $k => $v) {
477 unset($process[$key][$k]);
479 $process[$key][stripslashes($k)] = $v;
480 $process[] = &$process[$key][stripslashes($k)];
482 $process[$key][stripslashes($k)] = stripslashes($v);
495 * @brief Our main application structure for the life of this page.
497 * Primarily deals with the URL that got us here
498 * and tries to make some sense of it, and
499 * stores our page contents and config storage
500 * and anything else that might need to be passed around
501 * before we spit the page out.
506 public $module_loaded = false;
507 public $query_string;
516 public $page_contact;
518 public $data = array();
519 public $error = false;
529 public $interactive = true;
531 public $apps = array();
533 public $is_mobile = false;
534 public $is_tablet = false;
535 public $is_friendica_app;
536 public $performance = array();
537 public $callstack = array();
538 public $theme_info = array();
539 public $backend = true;
546 // Allow themes to control internal parameters
547 // by changing App values in theme.php
549 public $sourcename = '';
550 public $videowidth = 425;
551 public $videoheight = 350;
552 public $force_max_items = 0;
553 public $theme_thread_allow = true;
554 public $theme_events_in_profile = true;
557 * @brief An array for all theme-controllable parameters
559 * Mostly unimplemented yet. Only options 'template_engine' and
562 public $theme = array(
565 'videoheight' => 350,
566 'force_max_items' => 0,
567 'thread_allow' => true,
569 'template_engine' => 'smarty3',
573 * @brief An array of registered template engines ('name'=>'class name')
575 public $template_engines = array();
577 * @brief An array of instanced template engines ('name'=>'instance')
579 public $template_engine_instance = array();
583 private $ldelim = array(
587 private $rdelim = array(
597 private $curl_content_type;
598 private $curl_headers;
600 private $cached_profile_image;
601 private $cached_profile_picdate;
606 * @brief App constructor.
608 function __construct() {
610 global $default_timezone;
614 if (file_exists(".htpreconfig.php")) {
615 include ".htpreconfig.php";
618 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
620 date_default_timezone_set($this->timezone);
622 $this->performance["start"] = microtime(true);
623 $this->performance["database"] = 0;
624 $this->performance["database_write"] = 0;
625 $this->performance["network"] = 0;
626 $this->performance["file"] = 0;
627 $this->performance["rendering"] = 0;
628 $this->performance["parser"] = 0;
629 $this->performance["marktime"] = 0;
630 $this->performance["markstart"] = microtime(true);
632 $this->callstack["database"] = array();
633 $this->callstack["database_write"] = array();
634 $this->callstack["network"] = array();
635 $this->callstack["file"] = array();
636 $this->callstack["rendering"] = array();
637 $this->callstack["parser"] = array();
639 $this->config = array();
640 $this->page = array();
641 $this->pager= array();
643 $this->query_string = '';
645 $this->process_id = uniqid("log", true);
650 'include' . PATH_SEPARATOR
651 . 'library' . PATH_SEPARATOR
652 . 'library/phpsec' . PATH_SEPARATOR
653 . 'library/langdet' . PATH_SEPARATOR
657 $this->scheme = 'http';
658 if ((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
659 (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
660 (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
661 (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
662 (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
663 (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
665 $this->scheme = 'https';
668 if (x($_SERVER,'SERVER_NAME')) {
669 $this->hostname = $_SERVER['SERVER_NAME'];
671 if (x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
672 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
675 * Figure out if we are running at the top of a domain
676 * or in a sub-directory and adjust accordingly
679 $path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
680 if (isset($path) && strlen($path) && ($path != $this->path)) {
685 if ($hostname != "") {
686 $this->hostname = $hostname;
689 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
690 $this->set_baseurl(array_pop($_SERVER["argv"]) );
694 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
696 if ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
697 $this->query_string = substr($_SERVER['QUERY_STRING'],9);
698 // removing trailing / - maybe a nginx problem
699 if (substr($this->query_string, 0, 1) == "/")
700 $this->query_string = substr($this->query_string, 1);
701 } elseif ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
702 $this->query_string = substr($_SERVER['QUERY_STRING'],2);
703 // removing trailing / - maybe a nginx problem
704 if (substr($this->query_string, 0, 1) == "/")
705 $this->query_string = substr($this->query_string, 1);
708 if (x($_GET,'pagename')) {
709 $this->cmd = trim($_GET['pagename'],'/\\');
710 } elseif (x($_GET,'q')) {
711 $this->cmd = trim($_GET['q'],'/\\');
716 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
718 // unix style "homedir"
720 if (substr($this->cmd,0,1) === '~') {
721 $this->cmd = 'profile/' . substr($this->cmd,1);
724 // Diaspora style profile url
726 if (substr($this->cmd,0,2) === 'u/') {
727 $this->cmd = 'profile/' . substr($this->cmd,2);
733 * Break the URL path into C style argc/argv style arguments for our
734 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
735 * will be 3 (integer) and $this->argv will contain:
741 * There will always be one argument. If provided a naked domain
742 * URL, $this->argv[0] is set to "home".
746 $this->argv = explode('/',$this->cmd);
747 $this->argc = count($this->argv);
748 if ((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
749 $this->module = str_replace(".", "_", $this->argv[0]);
750 $this->module = str_replace("-", "_", $this->module);
753 $this->argv = array('home');
754 $this->module = 'home';
758 * See if there is any page number information, and initialise
762 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
763 $this->pager['itemspage'] = 50;
764 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
765 if ($this->pager['start'] < 0) {
766 $this->pager['start'] = 0;
768 $this->pager['total'] = 0;
771 * Detect mobile devices
774 $mobile_detect = new Mobile_Detect();
775 $this->is_mobile = $mobile_detect->isMobile();
776 $this->is_tablet = $mobile_detect->isTablet();
779 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
782 * register template engines
784 $dc = get_declared_classes();
785 foreach ($dc as $k) {
786 if (in_array("ITemplateEngine", class_implements($k))){
787 $this->register_template_engine($k);
795 public static function get_basepath() {
797 $basepath = get_config("system", "basepath");
799 if ($basepath == "") {
800 $basepath = dirname(__FILE__);
803 if ($basepath == "") {
804 $basepath = $_SERVER["DOCUMENT_ROOT"];
807 if ($basepath == "") {
808 $basepath = $_SERVER["PWD"];
814 function get_scheme() {
815 return($this->scheme);
819 * @brief Retrieves the Friendica instance base URL
821 * This function assembles the base URL from multiple parts:
822 * - Protocol is determined either by the request or a combination of
823 * system.ssl_policy and the $ssl parameter.
824 * - Host name is determined either by system.hostname or inferred from request
825 * - Path is inferred from SCRIPT_NAME
827 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
829 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
830 * @return string Friendica server base URL
832 function get_baseurl($ssl = false) {
834 // Is the function called statically?
835 if (!(isset($this) && get_class($this) == __CLASS__)) {
836 return self::$a->get_baseurl($ssl);
839 $scheme = $this->scheme;
841 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
845 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
846 // (and also the login link). Anything seen by an outsider will have it turned off.
848 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
856 if (Config::get('config', 'hostname') != '') {
857 $this->hostname = Config::get('config', 'hostname');
860 return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
864 * @brief Initializes the baseurl components
866 * Clears the baseurl cache to prevent inconstistencies
870 function set_baseurl($url) {
871 $parsed = @parse_url($url);
874 $this->scheme = $parsed['scheme'];
876 $hostname = $parsed['host'];
877 if (x($parsed, 'port')) {
878 $hostname .= ':' . $parsed['port'];
880 if (x($parsed, 'path')) {
881 $this->path = trim($parsed['path'], '\\/');
884 if (file_exists(".htpreconfig.php")) {
885 include ".htpreconfig.php";
888 if (get_config('config', 'hostname') != '') {
889 $this->hostname = get_config('config', 'hostname');
892 if (!isset($this->hostname) OR ($this->hostname == '')) {
893 $this->hostname = $hostname;
898 function get_hostname() {
899 if (get_config('config', 'hostname') != "") {
900 $this->hostname = get_config('config', 'hostname');
903 return $this->hostname;
906 function set_hostname($h) {
907 $this->hostname = $h;
910 function set_path($p) {
911 $this->path = trim(trim($p), '/');
914 function get_path() {
918 function set_pager_total($n) {
919 $this->pager['total'] = intval($n);
922 function set_pager_itemspage($n) {
923 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
924 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
927 function set_pager_page($n) {
928 $this->pager['page'] = $n;
929 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
932 function init_pagehead() {
933 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
935 // If the update is "deactivated" set it to the highest integer number (~24 days)
937 $interval = 2147483647;
940 if ($interval < 10000) {
944 // compose the page title from the sitename and the
945 // current module called
946 if (!$this->module == '') {
947 $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
949 $this->page['title'] = $this->config['sitename'];
952 /* put the head template at the beginning of page['htmlhead']
953 * since the code added by the modules frequently depends on it
956 if (!isset($this->page['htmlhead'])) {
957 $this->page['htmlhead'] = '';
960 // If we're using Smarty, then doing replace_macros() will replace
961 // any unrecognized variables with a blank string. Since we delay
962 // replacing $stylesheet until later, we need to replace it now
963 // with another variable name
964 if ($this->theme['template_engine'] === 'smarty3') {
965 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
967 $stylesheet = '$stylesheet';
970 $shortcut_icon = get_config("system", "shortcut_icon");
971 if ($shortcut_icon == "") {
972 $shortcut_icon = "images/friendica-32.png";
975 $touch_icon = get_config("system", "touch_icon");
976 if ($touch_icon == "") {
977 $touch_icon = "images/friendica-128.png";
980 // get data wich is needed for infinite scroll on the network page
981 $invinite_scroll = infinite_scroll_data($this->module);
983 $tpl = get_markup_template('head.tpl');
984 $this->page['htmlhead'] = replace_macros($tpl,array(
985 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
986 '$local_user' => local_user(),
987 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
988 '$delitem' => t('Delete this item?'),
989 '$showmore' => t('show more'),
990 '$showfewer' => t('show fewer'),
991 '$update_interval' => $interval,
992 '$shortcut_icon' => $shortcut_icon,
993 '$touch_icon' => $touch_icon,
994 '$stylesheet' => $stylesheet,
995 '$infinite_scroll' => $invinite_scroll,
996 )) . $this->page['htmlhead'];
999 function init_page_end() {
1000 if (!isset($this->page['end'])) {
1001 $this->page['end'] = '';
1003 $tpl = get_markup_template('end.tpl');
1004 $this->page['end'] = replace_macros($tpl,array(
1005 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
1006 )) . $this->page['end'];
1009 function set_curl_code($code) {
1010 $this->curl_code = $code;
1013 function get_curl_code() {
1014 return $this->curl_code;
1017 function set_curl_content_type($content_type) {
1018 $this->curl_content_type = $content_type;
1021 function get_curl_content_type() {
1022 return $this->curl_content_type;
1025 function set_curl_headers($headers) {
1026 $this->curl_headers = $headers;
1029 function get_curl_headers() {
1030 return $this->curl_headers;
1033 function get_cached_avatar_image($avatar_image){
1034 return $avatar_image;
1039 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1041 * @param string $orig_url
1043 * @return string The cleaned url
1045 function remove_baseurl($orig_url){
1047 // Is the function called statically?
1048 if (!(isset($this) && get_class($this) == __CLASS__)) {
1049 return(self::$a->remove_baseurl($orig_url));
1052 // Remove the hostname from the url if it is an internal link
1053 $nurl = normalise_link($orig_url);
1054 $base = normalise_link($this->get_baseurl());
1055 $url = str_replace($base."/", "", $nurl);
1057 // if it is an external link return the orignal value
1058 if ($url == normalise_link($orig_url)) {
1066 * @brief Register template engine class
1068 * If $name is "", is used class static property $class::$name
1070 * @param string $class
1071 * @param string $name
1073 function register_template_engine($class, $name = '') {
1074 /// @TODO Really === and not just == ?
1076 $v = get_class_vars( $class );
1077 if (x($v,"name")) $name = $v['name'];
1080 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1083 $this->template_engines[$name] = $class;
1087 * @brief Return template engine instance.
1089 * If $name is not defined, return engine defined by theme,
1092 * @param strin $name Template engine name
1093 * @return object Template Engine instance
1095 function template_engine($name = '') {
1096 /// @TODO really type-check included?
1098 $template_engine = $name;
1100 $template_engine = 'smarty3';
1101 if (x($this->theme, 'template_engine')) {
1102 $template_engine = $this->theme['template_engine'];
1106 if (isset($this->template_engines[$template_engine])){
1107 if (isset($this->template_engine_instance[$template_engine])){
1108 return $this->template_engine_instance[$template_engine];
1110 $class = $this->template_engines[$template_engine];
1112 $this->template_engine_instance[$template_engine] = $obj;
1117 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1121 * @brief Returns the active template engine.
1125 function get_template_engine() {
1126 return $this->theme['template_engine'];
1129 function set_template_engine($engine = 'smarty3') {
1130 $this->theme['template_engine'] = $engine;
1132 $this->theme['template_engine'] = 'smarty3';
1136 if (is_writable('view/smarty3/'))
1137 $this->theme['template_engine'] = 'smarty3';
1145 function get_template_ldelim($engine = 'smarty3') {
1146 return $this->ldelim[$engine];
1149 function get_template_rdelim($engine = 'smarty3') {
1150 return $this->rdelim[$engine];
1153 function save_timestamp($stamp, $value) {
1154 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
1158 $duration = (float)(microtime(true)-$stamp);
1160 if (!isset($this->performance[$value])) {
1161 // Prevent ugly E_NOTICE
1162 $this->performance[$value] = 0;
1165 $this->performance[$value] += (float)$duration;
1166 $this->performance["marktime"] += (float)$duration;
1168 $callstack = $this->callstack();
1170 if (!isset($this->callstack[$value][$callstack])) {
1171 // Prevent ugly E_NOTICE
1172 $this->callstack[$value][$callstack] = 0;
1175 $this->callstack[$value][$callstack] += (float)$duration;
1180 * @brief Log active processes into the "process" table
1182 function start_process() {
1183 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1185 $command = basename($trace[0]["file"]);
1187 $this->remove_inactive_processes();
1189 q("START TRANSACTION");
1191 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1192 if (!dbm::is_result($r)) {
1193 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1196 dbesc(datetime_convert()));
1202 * @brief Remove inactive processes
1204 function remove_inactive_processes() {
1205 q("START TRANSACTION");
1207 $r = q("SELECT `pid` FROM `process`");
1208 if (dbm::is_result($r)) {
1209 foreach ($r AS $process) {
1210 if (!posix_kill($process["pid"], 0)) {
1211 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1219 * @brief Remove the active process from the "process" table
1221 function end_process() {
1222 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1226 * @brief Returns a string with a callstack. Can be used for logging.
1230 function callstack() {
1231 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1233 // We remove the first two items from the list since they contain data that we don't need.
1234 array_shift($trace);
1235 array_shift($trace);
1237 $callstack = array();
1238 foreach ($trace AS $func) {
1239 $callstack[] = $func["function"];
1242 return implode(", ", $callstack);
1245 function get_useragent() {
1246 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1249 function is_friendica_app() {
1250 return($this->is_friendica_app);
1254 * @brief Checks if the site is called via a backend process
1256 * This isn't a perfect solution. But we need this check very early.
1257 * So we cannot wait until the modules are loaded.
1259 * @return bool Is it a known backend?
1261 function is_backend() {
1263 $backend[] = "_well_known";
1265 $backend[] = "dfrn_notify";
1266 $backend[] = "fetch";
1267 $backend[] = "hcard";
1268 $backend[] = "hostxrd";
1269 $backend[] = "nodeinfo";
1270 $backend[] = "noscrape";
1272 $backend[] = "poco";
1273 $backend[] = "post";
1274 $backend[] = "proxy";
1275 $backend[] = "pubsub";
1276 $backend[] = "pubsubhubbub";
1277 $backend[] = "receive";
1278 $backend[] = "rsd_xml";
1279 $backend[] = "salmon";
1280 $backend[] = "statistics_json";
1283 if (in_array($this->module, $backend)) {
1286 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) {
1304 $process = "frontend";
1305 $max_processes = get_config('system', 'max_processes_frontend');
1306 if (intval($max_processes) == 0) {
1307 $max_processes = 20;
1311 $processlist = dbm::processlist();
1312 if ($processlist["list"] != "") {
1313 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1315 if ($processlist["amount"] > $max_processes) {
1316 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1324 * @brief Checks if the maximum load is reached
1326 * @return bool Is the load reached?
1328 function maxload_reached() {
1330 if ($this->is_backend()) {
1331 $process = "backend";
1332 $maxsysload = intval(get_config('system', 'maxloadavg'));
1333 if ($maxsysload < 1) {
1337 $process = "frontend";
1338 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1339 if ($maxsysload < 1) {
1344 $load = current_load();
1346 if (intval($load) > $maxsysload) {
1347 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1354 function proc_run($args) {
1356 if (!function_exists("proc_open")) {
1360 // If the last worker fork was less than 10 seconds before then don't fork another one.
1361 // This should prevent the forking of masses of workers.
1362 $cachekey = "app:proc_run:started";
1363 $result = Cache::get($cachekey);
1364 /// @TODO maybe merge these both into one if() ?
1365 if (!is_null($result)) {
1366 if ((time() - $result) < 10) {
1370 // Set the timestamp of the last proc_run
1371 Cache::set($cachekey, time(), CACHE_MINUTE);
1373 array_unshift($args, ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
1375 // add baseurl to args. cli scripts can't construct it
1376 $args[] = $this->get_baseurl();
1378 for ($x = 0; $x < count($args); $x ++) {
1379 $args[$x] = escapeshellarg($args[$x]);
1382 $cmdline = implode($args," ");
1384 if (get_config('system','proc_windows')) {
1385 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1387 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1393 * @brief Returns the system user that is executing the script
1395 * This mostly returns something like "www-data".
1397 * @return string system username
1399 static function systemuser() {
1400 if (!function_exists('posix_getpwuid') OR !function_exists('posix_geteuid')) {
1404 $processUser = posix_getpwuid(posix_geteuid());
1405 return $processUser['name'];
1409 * @brief Checks if a given directory is usable for the system
1411 * @return boolean the directory is usable
1413 static function directory_usable($directory) {
1415 if ($directory == '') {
1416 logger("Directory is empty. This shouldn't happen.", LOGGER_DEBUG);
1420 if (!file_exists($directory)) {
1421 logger('Path "'.$directory.'" does not exist for user '.self::systemuser(), LOGGER_DEBUG);
1424 if (is_file($directory)) {
1425 logger('Path "'.$directory.'" is a file for user '.self::systemuser(), LOGGER_DEBUG);
1428 if (!is_dir($directory)) {
1429 logger('Path "'.$directory.'" is not a directory for user '.self::systemuser(), LOGGER_DEBUG);
1432 if (!is_writable($directory)) {
1433 logger('Path "'.$directory.'" is not writable for user '.self::systemuser(), LOGGER_DEBUG);
1441 * @brief Retrieve the App structure
1443 * Useful in functions which require it but don't get it passed to them
1445 function get_app() {
1452 * @brief Multi-purpose function to check variable state.
1454 * Usage: x($var) or $x($array, 'key')
1456 * returns false if variable/key is not set
1457 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1458 * e.g. x('') or x(0) returns 0;
1460 * @param string|array $s variable to check
1461 * @param string $k key inside the array to check
1465 function x($s,$k = NULL) {
1467 if ((is_array($s)) && (array_key_exists($k,$s))) {
1487 * @brief Called from db initialisation if db is dead.
1489 function system_unavailable() {
1490 include('system_unavailable.php');
1496 function clean_urls() {
1502 $base = App::get_baseurl();
1504 if (! clean_urls()) {
1512 * @brief Returns the baseurl.
1514 * @see App::get_baseurl()
1517 * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1520 return App::get_baseurl();
1524 * @brief Return absolut URL for given $path.
1526 * @param string $path
1530 function absurl($path) {
1531 if (strpos($path,'/') === 0) {
1532 return z_path() . $path;
1538 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1542 function is_ajax() {
1543 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1546 function check_db() {
1548 $build = get_config('system','build');
1550 set_config('system','build',DB_UPDATE_VERSION);
1551 $build = DB_UPDATE_VERSION;
1553 if ($build != DB_UPDATE_VERSION) {
1554 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1561 * Sets the base url for use in cmdline programs which don't have
1562 * $_SERVER variables
1564 function check_url(App $a) {
1566 $url = get_config('system','url');
1568 // if the url isn't set or the stored url is radically different
1569 // than the currently visited url, store the current value accordingly.
1570 // "Radically different" ignores common variations such as http vs https
1571 // and www.example.com vs example.com.
1572 // We will only change the url to an ip address if there is no existing setting
1575 $url = set_config('system','url',App::get_baseurl());
1577 if ((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) {
1578 $url = set_config('system','url',App::get_baseurl());
1586 * @brief Automatic database updates
1588 function update_db(App $a) {
1589 $build = get_config('system','build');
1591 $build = set_config('system','build',DB_UPDATE_VERSION);
1594 if ($build != DB_UPDATE_VERSION) {
1595 $stored = intval($build);
1596 $current = intval(DB_UPDATE_VERSION);
1597 if ($stored < $current) {
1598 Config::load('database');
1600 // We're reporting a different version than what is currently installed.
1601 // Run any existing update scripts to bring the database up to current.
1603 // make sure that boot.php and update.php are the same release, we might be
1604 // updating right this very second and the correct version of the update.php
1605 // file may not be here yet. This can happen on a very busy site.
1607 if (DB_UPDATE_VERSION == UPDATE_VERSION) {
1608 // Compare the current structure with the defined structure
1610 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1615 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1617 // run old update routine (wich could modify the schema and
1618 // conflits with new routine)
1619 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1620 $r = run_update_function($x);
1625 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
1626 $stored = NEW_UPDATE_ROUTINE_VERSION;
1629 // run new update routine
1630 // it update the structure in one call
1631 $retval = update_structure(false, true);
1639 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1642 // run any left update_nnnn functions in update.php
1643 for ($x = $stored; $x < $current; $x ++) {
1644 $r = run_update_function($x);
1656 function run_update_function($x) {
1657 if (function_exists('update_' . $x)) {
1659 // There could be a lot of processes running or about to run.
1660 // We want exactly one process to run the update command.
1661 // So store the fact that we're taking responsibility
1662 // after first checking to see if somebody else already has.
1664 // If the update fails or times-out completely you may need to
1665 // delete the config entry to try again.
1667 $t = get_config('database','update_' . $x);
1671 set_config('database','update_' . $x, time());
1673 // call the specific update
1675 $func = 'update_' . $x;
1679 //send the administrator an e-mail
1682 sprintf(t('Update %s failed. See error logs.'), $x)
1686 set_config('database','update_' . $x, 'success');
1687 set_config('system','build', $x + 1);
1691 set_config('database','update_' . $x, 'success');
1692 set_config('system','build', $x + 1);
1699 * @brief Synchronise plugins:
1701 * $a->config['system']['addon'] contains a comma-separated list of names
1702 * of plugins/addons which are used on this system.
1703 * Go through the database list of already installed addons, and if we have
1704 * an entry, but it isn't in the config list, call the uninstall procedure
1705 * and mark it uninstalled in the database (for now we'll remove it).
1706 * Then go through the config list and if we have a plugin that isn't installed,
1707 * call the install procedure and add it to the database.
1712 function check_plugins(App $a) {
1714 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1715 if (dbm::is_result($r)) {
1718 $installed = array();
1721 $plugins = get_config('system','addon');
1722 $plugins_arr = array();
1725 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1728 $a->plugins = $plugins_arr;
1730 $installed_arr = array();
1732 if (count($installed)) {
1733 foreach ($installed as $i) {
1734 if (! in_array($i['name'],$plugins_arr)) {
1735 uninstall_plugin($i['name']);
1737 $installed_arr[] = $i['name'];
1742 if (count($plugins_arr)) {
1743 foreach ($plugins_arr as $p) {
1744 if (! in_array($p,$installed_arr)) {
1756 function get_guid($size=16, $prefix = "") {
1758 if ($prefix == "") {
1760 $prefix = hash("crc32", $a->get_hostname());
1763 while (strlen($prefix) < ($size - 13)) {
1764 $prefix .= mt_rand();
1768 $prefix = substr($prefix, 0, $size - 22);
1769 return(str_replace(".", "", uniqid($prefix, true)));
1771 $prefix = substr($prefix, 0, max($size - 13, 0));
1772 return(uniqid($prefix));
1777 * @brief Wrapper for adding a login box.
1779 * @param bool $register
1780 * If $register == true provide a registration link.
1781 * This will most always depend on the value of $a->config['register_policy'].
1782 * @param bool $hiddens
1785 * Returns the complete html for inserting into the page
1787 * @hooks 'login_hook'
1790 function login($register = false, $hiddens=false) {
1796 'title' => t('Create a New Account'),
1797 'desc' => t('Register')
1801 $noid = get_config('system','no_openid');
1803 $dest_url = $a->query_string;
1806 $tpl = get_markup_template("logout.tpl");
1808 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1809 '$baseurl' => $a->get_baseurl(true)
1812 $tpl = get_markup_template("login.tpl");
1813 $_SESSION['return_url'] = $a->query_string;
1814 $a->module = 'login';
1817 $o .= replace_macros($tpl, array(
1819 '$dest_url' => $dest_url,
1820 '$logout' => t('Logout'),
1821 '$login' => t('Login'),
1823 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1824 '$lpassword' => array('password', t('Password: '), '', ''),
1825 '$lremember' => array('remember', t('Remember me'), 0, ''),
1827 '$openid' => !$noid,
1828 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1830 '$hiddens' => $hiddens,
1832 '$register' => $reg,
1834 '$lostpass' => t('Forgot your password?'),
1835 '$lostlink' => t('Password Reset'),
1837 '$tostitle' => t('Website Terms of Service'),
1838 '$toslink' => t('terms of service'),
1840 '$privacytitle' => t('Website Privacy Policy'),
1841 '$privacylink' => t('privacy policy'),
1845 call_hooks('login_hook',$o);
1851 * @brief Used to end the current process, after saving session state.
1855 if (!get_app()->is_backend()) {
1856 session_write_close();
1863 * @brief Redirect to another URL and terminate this process.
1865 function goaway($s) {
1866 if (!strstr(normalise_link($s), "http://")) {
1867 $s = App::get_baseurl()."/".$s;
1870 header("Location: $s");
1876 * @brief Returns the user id of locally logged in user or false.
1878 * @return int|bool user id or false
1880 function local_user() {
1881 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
1882 return intval($_SESSION['uid']);
1888 * @brief Returns the public contact id of logged in user or false.
1890 * @return int|bool public contact id or false
1892 function public_contact() {
1893 static $public_contact_id = false;
1895 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1896 if (x($_SESSION, 'my_address')) {
1898 $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
1899 } elseif (x($_SESSION, 'visitor_home')) {
1901 $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
1903 } elseif (!x($_SESSION, 'authenticated')) {
1904 $public_contact_id = false;
1907 return $public_contact_id;
1911 * @brief Returns contact id of authenticated site visitor or false
1913 * @return int|bool visitor_id or false
1915 function remote_user() {
1916 if ((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) {
1917 return intval($_SESSION['visitor_id']);
1923 * @brief Show an error message to user.
1925 * This function save text in session, to be shown to the user at next page load
1927 * @param string $s - Text of notice
1929 function notice($s) {
1931 if (! x($_SESSION,'sysmsg')) {
1932 $_SESSION['sysmsg'] = array();
1934 if ($a->interactive) {
1935 $_SESSION['sysmsg'][] = $s;
1940 * @brief Show an info message to user.
1942 * This function save text in session, to be shown to the user at next page load
1944 * @param string $s - Text of notice
1949 if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) {
1953 if (! x($_SESSION,'sysmsg_info')) {
1954 $_SESSION['sysmsg_info'] = array();
1956 if ($a->interactive) {
1957 $_SESSION['sysmsg_info'][] = $s;
1963 * @brief Wrapper around config to limit the text length of an incoming message
1967 function get_max_import_size() {
1969 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1973 * @brief Wrap calls to proc_close(proc_open()) and call hook
1974 * so plugins can take part in process :)
1976 * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1978 * next args are passed as $cmd command line
1979 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1980 * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1982 * @note $cmd and string args are surrounded with ""
1987 function proc_run($cmd){
1991 $proc_args = func_get_args();
1994 if (!count($proc_args)) {
1998 // Preserve the first parameter
1999 // It could contain a command, the priority or an parameter array
2000 // If we use the parameter array we have to protect it from the following function
2001 $run_parameter = array_shift($proc_args);
2003 // expand any arrays
2004 foreach ($proc_args as $arg) {
2005 if (is_array($arg)) {
2006 foreach ($arg as $n) {
2014 // Now we add the run parameters back to the array
2015 array_unshift($args, $run_parameter);
2017 $arr = array('args' => $args, 'run_cmd' => true);
2019 call_hooks("proc_run", $arr);
2020 if (!$arr['run_cmd'] OR !count($args)) {
2024 $priority = PRIORITY_MEDIUM;
2025 $dont_fork = get_config("system", "worker_dont_fork");
2027 if (is_int($run_parameter)) {
2028 $priority = $run_parameter;
2029 } elseif (is_array($run_parameter)) {
2030 if (isset($run_parameter['priority'])) {
2031 $priority = $run_parameter['priority'];
2033 if (isset($run_parameter['dont_fork'])) {
2034 $dont_fork = $run_parameter['dont_fork'];
2041 $parameters = json_encode($argv);
2042 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
2043 dbesc($parameters));
2045 if (!dbm::is_result($found)) {
2046 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
2047 VALUES ('%s', '%s', %d)",
2049 dbesc(datetime_convert()),
2053 // Should we quit and wait for the poller to be called as a cronjob?
2058 // Checking number of workers
2059 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
2061 // Get number of allowed number of worker threads
2062 $queues = intval(get_config("system", "worker_queues"));
2068 // If there are already enough workers running, don't fork another one
2069 if ($workers[0]["workers"] >= $queues) {
2073 // Now call the poller to execute the jobs that we just added to the queue
2074 $args = array("include/poller.php", "no_cron");
2076 $a->proc_run($args);
2079 function current_theme(){
2080 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2086 // Find the theme that belongs to the user whose stuff we are looking at
2088 if ($a->profile_uid && ($a->profile_uid != local_user())) {
2089 $r = q("select theme from user where uid = %d limit 1",
2090 intval($a->profile_uid)
2092 if (dbm::is_result($r)) {
2093 $page_theme = $r[0]['theme'];
2097 // Allow folks to over-rule user themes and always use their own on their own site.
2098 // This works only if the user is on the same server
2100 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2101 if (get_pconfig(local_user(),'system','always_my_theme')) {
2106 // $mobile_detect = new Mobile_Detect();
2107 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2108 $is_mobile = $a->is_mobile || $a->is_tablet;
2110 $standard_system_theme = Config::get('system', 'theme', '');
2111 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2114 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2115 $system_theme = $standard_system_theme;
2116 $theme_name = $standard_theme_name;
2118 $system_theme = Config::get('system', 'mobile-theme', '');
2119 if ($system_theme == '') {
2120 $system_theme = $standard_system_theme;
2122 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2124 if ($theme_name === '---') {
2125 // user has selected to have the mobile theme be the same as the normal one
2126 $system_theme = $standard_system_theme;
2127 $theme_name = $standard_theme_name;
2130 $theme_name = $page_theme;
2135 $system_theme = $standard_system_theme;
2136 $theme_name = $standard_theme_name;
2139 $theme_name = $page_theme;
2144 (file_exists('view/theme/' . $theme_name . '/style.css') ||
2145 file_exists('view/theme/' . $theme_name . '/style.php'))) {
2146 return($theme_name);
2149 foreach ($app_base_themes as $t) {
2150 if (file_exists('view/theme/' . $t . '/style.css') ||
2151 file_exists('view/theme/' . $t . '/style.php')) {
2156 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2157 if (count($fallback)) {
2158 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2161 /// @TODO No final return statement?
2165 * @brief Return full URL to theme which is currently in effect.
2167 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2171 function current_theme_url() {
2174 $t = current_theme();
2176 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2177 if (file_exists('view/theme/' . $t . '/style.php')) {
2178 return('view/theme/'.$t.'/style.pcss'.$opts);
2181 return('view/theme/'.$t.'/style.css');
2184 function feed_birthday($uid,$tz) {
2188 * Determine the next birthday, but only if the birthday is published
2189 * in the default profile. We _could_ also look for a private profile that the
2190 * recipient can see, but somebody could get mad at us if they start getting
2191 * public birthday greetings when they haven't made this info public.
2193 * Assuming we are able to publish this info, we are then going to convert
2194 * the start time from the owner's timezone to UTC.
2196 * This will potentially solve the problem found with some social networks
2197 * where birthdays are converted to the viewer's timezone and salutations from
2198 * elsewhere in the world show up on the wrong day. We will convert it to the
2199 * viewer's timezone also, but first we are going to convert it from the birthday
2200 * person's timezone to GMT - so the viewer may find the birthday starting at
2201 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2208 if (! strlen($tz)) {
2212 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2216 if (dbm::is_result($p)) {
2217 $tmp_dob = substr($p[0]['dob'],5);
2218 if (intval($tmp_dob)) {
2219 $y = datetime_convert($tz,$tz,'now','Y');
2220 $bd = $y . '-' . $tmp_dob . ' 00:00';
2221 $t_dob = strtotime($bd);
2222 $now = strtotime(datetime_convert($tz,$tz,'now'));
2223 if ($t_dob < $now) {
2224 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2226 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2234 * @brief Check if current user has admin role.
2236 * @return bool true if user is an admin
2238 function is_site_admin() {
2241 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2243 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2244 if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) {
2251 * @brief Returns querystring as string from a mapped array.
2253 * @param array $params mapped array with query parameters
2254 * @param string $name of parameter, default null
2258 function build_querystring($params, $name = null) {
2260 foreach ($params as $key => $val) {
2261 if (is_array($val)) {
2262 /// @TODO maybe not compare against null, use is_null()
2263 if ($name == null) {
2264 $ret .= build_querystring($val, $key);
2266 $ret .= build_querystring($val, $name."[$key]");
2269 $val = urlencode($val);
2270 /// @TODO maybe not compare against null, use is_null()
2271 if ($name != null) {
2272 /// @TODO two string concated, can be merged to one
2273 $ret .= $name . "[$key]" . "=$val&";
2275 $ret .= "$key=$val&";
2282 function explode_querystring($query) {
2283 $arg_st = strpos($query, '?');
2284 if ($arg_st !== false) {
2285 $base = substr($query, 0, $arg_st);
2292 $args = explode('&', substr($query, $arg_st));
2293 foreach ($args as $k => $arg) {
2294 /// @TODO really compare type-safe here?
2299 $args = array_values($args);
2304 $args = array_values($args);
2314 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2316 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2318 function curPageURL() {
2320 if ($_SERVER["HTTPS"] == "on") {
2326 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2327 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2329 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2334 function random_digits($digits) {
2336 for ($i = 0; $i < $digits; $i++) {
2337 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
2343 function get_server() {
2344 $server = get_config("system", "directory");
2346 if ($server == "") {
2347 $server = "http://dir.friendi.ca";
2353 function get_cachefile($file, $writemode = true) {
2354 $cache = get_itemcachepath();
2356 if ((! $cache) || (! is_dir($cache))) {
2360 $subfolder = $cache . "/" . substr($file, 0, 2);
2362 $cachepath = $subfolder . "/" . $file;
2365 if (!is_dir($subfolder)) {
2367 chmod($subfolder, 0777);
2371 /// @TODO no need to put braces here
2375 function clear_cache($basepath = "", $path = "") {
2377 $basepath = get_itemcachepath();
2381 if (($path == "") OR (!is_dir($path))) {
2385 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
2389 $cachetime = (int)get_config('system','itemcache_duration');
2390 if ($cachetime == 0) {
2394 if (is_writable($path)){
2395 if ($dh = opendir($path)) {
2396 while (($file = readdir($dh)) !== false) {
2397 $fullpath = $path."/".$file;
2398 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != "..")) {
2399 clear_cache($basepath, $fullpath);
2401 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime))) {
2410 function get_itemcachepath() {
2411 // Checking, if the cache is deactivated
2412 $cachetime = (int)get_config('system','itemcache_duration');
2413 if ($cachetime < 0) {
2417 $itemcache = get_config('system','itemcache');
2418 if (($itemcache != "") AND App::directory_usable($itemcache)) {
2422 $temppath = get_temppath();
2424 if ($temppath != "") {
2425 $itemcache = $temppath."/itemcache";
2426 if (!file_exists($itemcache) && !is_dir($itemcache)) {
2430 if (App::directory_usable($itemcache)) {
2431 set_config("system", "itemcache", $itemcache);
2439 * @brief Returns the path where spool files are stored
2441 * @return string Spool path
2443 function get_spoolpath() {
2444 $spoolpath = get_config('system','spoolpath');
2445 if (($spoolpath != "") AND App::directory_usable($spoolpath)) {
2446 // We have a spool path and it is usable
2450 // We don't have a working preconfigured spool path, so we take the temp path.
2451 $temppath = get_temppath();
2453 if ($temppath != "") {
2454 // To avoid any interferences with other systems we create our own directory
2455 $spoolpath = $temppath."/spool";
2456 if (!is_dir($spoolpath)) {
2460 if (App::directory_usable($spoolpath)) {
2461 // The new path is usable, we are happy
2462 set_config("system", "spoolpath", $spoolpath);
2465 // We can't create a subdirectory, strange.
2466 // But the directory seems to work, so we use it but don't store it.
2471 // Reaching this point means that the operating system is configured badly.
2475 function get_temppath() {
2478 $temppath = get_config("system", "temppath");
2480 if (($temppath != "") AND App::directory_usable($temppath)) {
2481 // We have a temp path and it is usable
2485 // We don't have a working preconfigured temp path, so we take the system path.
2486 $temppath = sys_get_temp_dir();
2488 // Check if it is usable
2489 if (($temppath != "") AND App::directory_usable($temppath)) {
2490 // To avoid any interferences with other systems we create our own directory
2491 $new_temppath .= "/".$a->get_hostname();
2492 if (!is_dir($new_temppath)) {
2493 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
2494 mkdir($new_temppath);
2497 if (App::directory_usable($new_temppath)) {
2498 // The new path is usable, we are happy
2499 set_config("system", "temppath", $new_temppath);
2500 return $new_temppath;
2502 // We can't create a subdirectory, strange.
2503 // But the directory seems to work, so we use it but don't store it.
2508 // Reaching this point means that the operating system is configured badly.
2513 function set_template_engine(App $a, $engine = 'internal') {
2514 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2515 /// to avoid breaking themes again unnecessarily
2516 /// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
2518 $a->set_template_engine($engine);
2521 if (!function_exists('exif_imagetype')) {
2522 function exif_imagetype($file) {
2523 $size = getimagesize($file);
2528 function validate_include(&$file) {
2531 $file = realpath($file);
2533 if (strpos($file, getcwd()) !== 0) {
2537 $file = str_replace(getcwd()."/", "", $file, $count);
2542 if ($orig_file !== $file) {
2547 if (strpos($file, "include/") === 0) {
2551 if (strpos($file, "addon/") === 0) {
2555 // Simply return flag
2559 function current_load() {
2560 if (!function_exists('sys_getloadavg')) {
2564 $load_arr = sys_getloadavg();
2566 if (!is_array($load_arr)) {
2570 return max($load_arr[0], $load_arr[1]);
2574 * @brief get c-style args
2579 return get_app()->argc;
2583 * @brief Returns the value of a argv key
2585 * @param int $x argv key
2586 * @return string Value of the argv key
2589 if (array_key_exists($x,get_app()->argv)) {
2590 return get_app()->argv[$x];
2597 * @brief Get the data which is needed for infinite scroll
2599 * For invinite scroll we need the page number of the actual page
2600 * and the the URI where the content of the next page comes from.
2601 * This data is needed for the js part in main.js.
2602 * Note: infinite scroll does only work for the network page (module)
2604 * @param string $module The name of the module (e.g. "network")
2605 * @return array Of infinite scroll data
2606 * 'pageno' => $pageno The number of the actual page
2607 * 'reload_uri' => $reload_uri The URI of the content we have to load
2609 function infinite_scroll_data($module) {
2611 if (get_pconfig(local_user(),'system','infinite_scroll')
2612 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2614 // get the page number
2615 if (is_string($_GET["page"])) {
2616 $pageno = $_GET["page"];
2623 // try to get the uri from which we load the content
2624 foreach ($_GET AS $param => $value) {
2625 if (($param != "page") AND ($param != "q")) {
2626 $reload_uri .= "&" . $param . "=" . urlencode($value);
2630 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset=")) {
2631 $reload_uri .= "&offset=" . urlencode($a->page_offset);
2634 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);