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(__DIR__ . DIRECTORY_SEPARATOR. 'vendor' . DIRECTORY_SEPARATOR . 'autoload.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('include/features.php');
33 require_once('include/identity.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.2-dev' );
40 define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
41 define ( 'DB_UPDATE_VERSION', 1216 );
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_PNUT', 'pnut'); // pnut.io
247 define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
251 * These numbers are used in stored permissions
252 * and existing allocations MUST NEVER BE CHANGED
253 * 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),
275 NETWORK_PNUT => (-20),
277 NETWORK_PHANTOM => (-127),
282 * Maximum number of "people who like (or don't like) this" that we will list by name
285 define ( 'MAX_LIKERS', 75);
288 * Communication timeout
291 define ( 'ZCURL_TIMEOUT' , (-1));
297 * Email notification options
300 define ( 'NOTIFY_INTRO', 0x0001 );
301 define ( 'NOTIFY_CONFIRM', 0x0002 );
302 define ( 'NOTIFY_WALL', 0x0004 );
303 define ( 'NOTIFY_COMMENT', 0x0008 );
304 define ( 'NOTIFY_MAIL', 0x0010 );
305 define ( 'NOTIFY_SUGGEST', 0x0020 );
306 define ( 'NOTIFY_PROFILE', 0x0040 );
307 define ( 'NOTIFY_TAGSELF', 0x0080 );
308 define ( 'NOTIFY_TAGSHARE', 0x0100 );
309 define ( 'NOTIFY_POKE', 0x0200 );
310 define ( 'NOTIFY_SHARE', 0x0400 );
312 define ( 'NOTIFY_SYSTEM', 0x8000 );
322 define ( 'TERM_UNKNOWN', 0 );
323 define ( 'TERM_HASHTAG', 1 );
324 define ( 'TERM_MENTION', 2 );
325 define ( 'TERM_CATEGORY', 3 );
326 define ( 'TERM_PCATEGORY', 4 );
327 define ( 'TERM_FILE', 5 );
328 define ( 'TERM_SAVEDSEARCH', 6 );
329 define ( 'TERM_CONVERSATION', 7 );
331 define ( 'TERM_OBJ_POST', 1 );
332 define ( 'TERM_OBJ_PHOTO', 2 );
339 * Various namespaces we may need to parse
342 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
343 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
344 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
345 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
346 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
347 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
348 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
349 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
350 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
351 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
352 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
353 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
354 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
355 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
356 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
362 * Activity stream defines
365 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
366 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
367 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
368 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
369 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
371 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
373 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
374 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
375 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
376 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
377 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
378 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
380 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
381 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
382 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
383 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
384 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
386 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
387 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
389 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
390 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
391 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
392 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
393 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
394 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
395 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
396 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
397 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
398 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
399 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
400 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
401 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
402 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
408 * Item weight for query ordering
411 define ( 'GRAVITY_PARENT', 0);
412 define ( 'GRAVITY_LIKE', 3);
413 define ( 'GRAVITY_COMMENT', 6);
419 * Process priority for the worker
422 define('PRIORITY_UNDEFINED', 0);
423 define('PRIORITY_CRITICAL', 10);
424 define('PRIORITY_HIGH', 20);
425 define('PRIORITY_MEDIUM', 30);
426 define('PRIORITY_LOW', 40);
427 define('PRIORITY_NEGLIGIBLE',50);
431 * @name Social Relay settings
433 * See here: https://github.com/jaywink/social-relay
434 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
437 define('SR_SCOPE_NONE', '');
438 define('SR_SCOPE_ALL', 'all');
439 define('SR_SCOPE_TAGS', 'tags');
443 * Lowest possible date time value
446 define ('NULL_DATE', '0001-01-01 00:00:00');
449 // Normally this constant is defined - but not if "pcntl" isn't installed
450 if (!defined("SIGTERM")) {
451 define("SIGTERM", 15);
455 * Reverse the effect of magic_quotes_gpc if it is enabled.
456 * Please disable magic_quotes_gpc so we don't have to do this.
457 * See http://php.net/manual/en/security.magicquotes.disabling.php
463 error_reporting(E_ERROR | E_WARNING | E_PARSE);
467 // This has to be quite large to deal with embedded private photos
468 ini_set('pcre.backtrack_limit', 500000);
471 if (get_magic_quotes_gpc()) {
472 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
473 while (list($key, $val) = each($process)) {
474 foreach ($val as $k => $v) {
475 unset($process[$key][$k]);
477 $process[$key][stripslashes($k)] = $v;
478 $process[] = &$process[$key][stripslashes($k)];
480 $process[$key][stripslashes($k)] = stripslashes($v);
493 * @brief Our main application structure for the life of this page.
495 * Primarily deals with the URL that got us here
496 * and tries to make some sense of it, and
497 * stores our page contents and config storage
498 * and anything else that might need to be passed around
499 * before we spit the page out.
504 /// @TODO decide indending as a colorful mixure is ahead ...
505 public $module_loaded = false;
506 public $query_string;
515 public $page_contact;
517 public $data = array();
518 public $error = false;
528 public $interactive = true;
530 public $apps = array();
532 public $is_mobile = false;
533 public $is_tablet = false;
534 public $is_friendica_app;
535 public $performance = array();
536 public $callstack = array();
537 public $theme_info = array();
538 public $backend = true;
545 // Allow themes to control internal parameters
546 // by changing App values in theme.php
548 public $sourcename = '';
549 public $videowidth = 425;
550 public $videoheight = 350;
551 public $force_max_items = 0;
552 public $theme_thread_allow = true;
553 public $theme_events_in_profile = true;
556 * @brief An array for all theme-controllable parameters
558 * Mostly unimplemented yet. Only options 'template_engine' and
561 public $theme = array(
564 'videoheight' => 350,
565 'force_max_items' => 0,
566 'thread_allow' => true,
568 'template_engine' => 'smarty3',
572 * @brief An array of registered template engines ('name'=>'class name')
574 public $template_engines = array();
576 * @brief An array of instanced template engines ('name'=>'instance')
578 public $template_engine_instance = array();
582 private $ldelim = array(
586 private $rdelim = array(
596 private $curl_content_type;
597 private $curl_headers;
599 private $cached_profile_image;
600 private $cached_profile_picdate;
605 * @brief App constructor.
607 function __construct() {
609 global $default_timezone;
613 if (file_exists(".htpreconfig.php")) {
614 include ".htpreconfig.php";
617 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
619 date_default_timezone_set($this->timezone);
621 $this->performance["start"] = microtime(true);
622 $this->performance["database"] = 0;
623 $this->performance["database_write"] = 0;
624 $this->performance["network"] = 0;
625 $this->performance["file"] = 0;
626 $this->performance["rendering"] = 0;
627 $this->performance["parser"] = 0;
628 $this->performance["marktime"] = 0;
629 $this->performance["markstart"] = microtime(true);
631 $this->callstack["database"] = array();
632 $this->callstack["database_write"] = array();
633 $this->callstack["network"] = array();
634 $this->callstack["file"] = array();
635 $this->callstack["rendering"] = array();
636 $this->callstack["parser"] = array();
638 $this->config = array();
639 $this->page = array();
640 $this->pager= array();
642 $this->query_string = '';
644 $this->process_id = uniqid("log", true);
649 get_include_path() . PATH_SEPARATOR
650 . 'include' . PATH_SEPARATOR
651 . 'library' . PATH_SEPARATOR
652 . 'library/langdet' . PATH_SEPARATOR
655 $this->scheme = 'http';
657 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
658 (x($_SERVER, 'HTTP_FORWARDED') && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
659 (x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
660 (x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
661 (x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
662 (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
664 $this->scheme = 'https';
667 if (x($_SERVER, 'SERVER_NAME')) {
668 $this->hostname = $_SERVER['SERVER_NAME'];
670 if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
671 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
674 * Figure out if we are running at the top of a domain
675 * or in a sub-directory and adjust accordingly
678 /// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
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 if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === "pagename=") {
695 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
697 // removing trailing / - maybe a nginx problem
698 $this->query_string = ltrim($this->query_string, '/');
699 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === "q=") {
700 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
702 // removing trailing / - maybe a nginx problem
703 $this->query_string = ltrim($this->query_string, '/');
706 if (x($_GET, 'pagename')) {
707 $this->cmd = trim($_GET['pagename'], '/\\');
708 } elseif (x($_GET, 'q')) {
709 $this->cmd = trim($_GET['q'], '/\\');
714 $this->query_string = str_replace($this->cmd . "&", $this->cmd . "?", $this->query_string);
716 // unix style "homedir"
717 if (substr($this->cmd, 0, 1) === '~') {
718 $this->cmd = 'profile/' . substr($this->cmd, 1);
721 // Diaspora style profile url
722 if (substr($this->cmd, 0, 2) === 'u/') {
723 $this->cmd = 'profile/' . substr($this->cmd, 2);
728 * Break the URL path into C style argc/argv style arguments for our
729 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
730 * will be 3 (integer) and $this->argv will contain:
736 * There will always be one argument. If provided a naked domain
737 * URL, $this->argv[0] is set to "home".
740 $this->argv = explode('/', $this->cmd);
741 $this->argc = count($this->argv);
742 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
743 $this->module = str_replace(".", "_", $this->argv[0]);
744 $this->module = str_replace("-", "_", $this->module);
747 $this->argv = array('home');
748 $this->module = 'home';
752 * See if there is any page number information, and initialise
756 $this->pager['page'] = ((x($_GET, 'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
757 $this->pager['itemspage'] = 50;
758 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
760 if ($this->pager['start'] < 0) {
761 $this->pager['start'] = 0;
763 $this->pager['total'] = 0;
766 * Detect mobile devices
769 $mobile_detect = new Mobile_Detect();
770 $this->is_mobile = $mobile_detect->isMobile();
771 $this->is_tablet = $mobile_detect->isTablet();
774 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
777 * register template engines
779 $dc = get_declared_classes();
780 foreach ($dc as $k) {
781 if (in_array("ITemplateEngine", class_implements($k))){
782 $this->register_template_engine($k);
790 public static function get_basepath() {
792 $basepath = get_config("system", "basepath");
794 if ($basepath == "") {
795 $basepath = dirname(__FILE__);
798 if ($basepath == "") {
799 $basepath = $_SERVER["DOCUMENT_ROOT"];
802 if ($basepath == "") {
803 $basepath = $_SERVER["PWD"];
809 function get_scheme() {
810 return $this->scheme;
814 * @brief Retrieves the Friendica instance base URL
816 * This function assembles the base URL from multiple parts:
817 * - Protocol is determined either by the request or a combination of
818 * system.ssl_policy and the $ssl parameter.
819 * - Host name is determined either by system.hostname or inferred from request
820 * - Path is inferred from SCRIPT_NAME
822 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
824 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
825 * @return string Friendica server base URL
827 function get_baseurl($ssl = false) {
829 // Is the function called statically?
830 if (!(isset($this) && get_class($this) == __CLASS__)) {
831 return self::$a->get_baseurl($ssl);
834 $scheme = $this->scheme;
836 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
840 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
841 // (and also the login link). Anything seen by an outsider will have it turned off.
843 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
851 if (Config::get('config', 'hostname') != '') {
852 $this->hostname = Config::get('config', 'hostname');
855 return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
859 * @brief Initializes the baseurl components
861 * Clears the baseurl cache to prevent inconstistencies
865 function set_baseurl($url) {
866 $parsed = @parse_url($url);
869 $this->scheme = $parsed['scheme'];
871 $hostname = $parsed['host'];
872 if (x($parsed, 'port')) {
873 $hostname .= ':' . $parsed['port'];
875 if (x($parsed, 'path')) {
876 $this->path = trim($parsed['path'], '\\/');
879 if (file_exists(".htpreconfig.php")) {
880 include ".htpreconfig.php";
883 if (get_config('config', 'hostname') != '') {
884 $this->hostname = get_config('config', 'hostname');
887 if (!isset($this->hostname) OR ($this->hostname == '')) {
888 $this->hostname = $hostname;
893 function get_hostname() {
894 if (get_config('config', 'hostname') != "") {
895 $this->hostname = get_config('config', 'hostname');
898 return $this->hostname;
901 function set_hostname($h) {
902 $this->hostname = $h;
905 function set_path($p) {
906 $this->path = trim(trim($p), '/');
909 function get_path() {
913 function set_pager_total($n) {
914 $this->pager['total'] = intval($n);
917 function set_pager_itemspage($n) {
918 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
919 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
922 function set_pager_page($n) {
923 $this->pager['page'] = $n;
924 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
927 function init_pagehead() {
928 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
930 // If the update is "deactivated" set it to the highest integer number (~24 days)
932 $interval = 2147483647;
935 if ($interval < 10000) {
939 // compose the page title from the sitename and the
940 // current module called
941 if (!$this->module == '') {
942 $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
944 $this->page['title'] = $this->config['sitename'];
947 /* put the head template at the beginning of page['htmlhead']
948 * since the code added by the modules frequently depends on it
951 if (!isset($this->page['htmlhead'])) {
952 $this->page['htmlhead'] = '';
955 // If we're using Smarty, then doing replace_macros() will replace
956 // any unrecognized variables with a blank string. Since we delay
957 // replacing $stylesheet until later, we need to replace it now
958 // with another variable name
959 if ($this->theme['template_engine'] === 'smarty3') {
960 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
962 $stylesheet = '$stylesheet';
965 $shortcut_icon = get_config("system", "shortcut_icon");
966 if ($shortcut_icon == "") {
967 $shortcut_icon = "images/friendica-32.png";
970 $touch_icon = get_config("system", "touch_icon");
971 if ($touch_icon == "") {
972 $touch_icon = "images/friendica-128.png";
975 // get data wich is needed for infinite scroll on the network page
976 $invinite_scroll = infinite_scroll_data($this->module);
978 $tpl = get_markup_template('head.tpl');
979 $this->page['htmlhead'] = replace_macros($tpl,array(
980 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
981 '$local_user' => local_user(),
982 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
983 '$delitem' => t('Delete this item?'),
984 '$showmore' => t('show more'),
985 '$showfewer' => t('show fewer'),
986 '$update_interval' => $interval,
987 '$shortcut_icon' => $shortcut_icon,
988 '$touch_icon' => $touch_icon,
989 '$stylesheet' => $stylesheet,
990 '$infinite_scroll' => $invinite_scroll,
991 )) . $this->page['htmlhead'];
994 function init_page_end() {
995 if (!isset($this->page['end'])) {
996 $this->page['end'] = '';
998 $tpl = get_markup_template('end.tpl');
999 $this->page['end'] = replace_macros($tpl,array(
1000 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
1001 )) . $this->page['end'];
1004 function set_curl_code($code) {
1005 $this->curl_code = $code;
1008 function get_curl_code() {
1009 return $this->curl_code;
1012 function set_curl_content_type($content_type) {
1013 $this->curl_content_type = $content_type;
1016 function get_curl_content_type() {
1017 return $this->curl_content_type;
1020 function set_curl_headers($headers) {
1021 $this->curl_headers = $headers;
1024 function get_curl_headers() {
1025 return $this->curl_headers;
1028 function get_cached_avatar_image($avatar_image){
1029 return $avatar_image;
1034 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1036 * @param string $orig_url
1038 * @return string The cleaned url
1040 function remove_baseurl($orig_url){
1042 // Is the function called statically?
1043 if (!(isset($this) && get_class($this) == __CLASS__)) {
1044 return self::$a->remove_baseurl($orig_url);
1047 // Remove the hostname from the url if it is an internal link
1048 $nurl = normalise_link($orig_url);
1049 $base = normalise_link($this->get_baseurl());
1050 $url = str_replace($base."/", "", $nurl);
1052 // if it is an external link return the orignal value
1053 if ($url == normalise_link($orig_url)) {
1061 * @brief Register template engine class
1063 * If $name is "", is used class static property $class::$name
1065 * @param string $class
1066 * @param string $name
1068 function register_template_engine($class, $name = '') {
1069 /// @TODO Really === and not just == ?
1071 $v = get_class_vars( $class );
1072 if (x($v,"name")) $name = $v['name'];
1075 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1078 $this->template_engines[$name] = $class;
1082 * @brief Return template engine instance.
1084 * If $name is not defined, return engine defined by theme,
1087 * @param strin $name Template engine name
1088 * @return object Template Engine instance
1090 function template_engine($name = '') {
1091 /// @TODO really type-check included?
1093 $template_engine = $name;
1095 $template_engine = 'smarty3';
1096 if (x($this->theme, 'template_engine')) {
1097 $template_engine = $this->theme['template_engine'];
1101 if (isset($this->template_engines[$template_engine])){
1102 if (isset($this->template_engine_instance[$template_engine])){
1103 return $this->template_engine_instance[$template_engine];
1105 $class = $this->template_engines[$template_engine];
1107 $this->template_engine_instance[$template_engine] = $obj;
1112 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1116 * @brief Returns the active template engine.
1120 function get_template_engine() {
1121 return $this->theme['template_engine'];
1124 function set_template_engine($engine = 'smarty3') {
1125 $this->theme['template_engine'] = $engine;
1128 function get_template_ldelim($engine = 'smarty3') {
1129 return $this->ldelim[$engine];
1132 function get_template_rdelim($engine = 'smarty3') {
1133 return $this->rdelim[$engine];
1136 function save_timestamp($stamp, $value) {
1137 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
1141 $duration = (float)(microtime(true)-$stamp);
1143 if (!isset($this->performance[$value])) {
1144 // Prevent ugly E_NOTICE
1145 $this->performance[$value] = 0;
1148 $this->performance[$value] += (float)$duration;
1149 $this->performance["marktime"] += (float)$duration;
1151 $callstack = $this->callstack();
1153 if (!isset($this->callstack[$value][$callstack])) {
1154 // Prevent ugly E_NOTICE
1155 $this->callstack[$value][$callstack] = 0;
1158 $this->callstack[$value][$callstack] += (float)$duration;
1163 * @brief Log active processes into the "process" table
1165 function start_process() {
1166 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1168 $command = basename($trace[0]["file"]);
1170 $this->remove_inactive_processes();
1172 q("START TRANSACTION");
1174 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1175 if (!dbm::is_result($r)) {
1176 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1179 dbesc(datetime_convert()));
1185 * @brief Remove inactive processes
1187 function remove_inactive_processes() {
1188 q("START TRANSACTION");
1190 $r = q("SELECT `pid` FROM `process`");
1191 if (dbm::is_result($r)) {
1192 foreach ($r AS $process) {
1193 if (!posix_kill($process["pid"], 0)) {
1194 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1202 * @brief Remove the active process from the "process" table
1204 function end_process() {
1205 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1209 * @brief Returns a string with a callstack. Can be used for logging.
1213 function callstack() {
1214 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1216 // We remove the first two items from the list since they contain data that we don't need.
1217 array_shift($trace);
1218 array_shift($trace);
1220 $callstack = array();
1221 foreach ($trace AS $func) {
1222 $callstack[] = $func["function"];
1225 return implode(", ", $callstack);
1228 function get_useragent() {
1230 FRIENDICA_PLATFORM . " '" .
1231 FRIENDICA_CODENAME . "' " .
1232 FRIENDICA_VERSION . "-" .
1233 DB_UPDATE_VERSION . "; " .
1234 $this->get_baseurl();
1237 function is_friendica_app() {
1238 return $this->is_friendica_app;
1242 * @brief Checks if the site is called via a backend process
1244 * This isn't a perfect solution. But we need this check very early.
1245 * So we cannot wait until the modules are loaded.
1247 * @return bool Is it a known backend?
1249 function is_backend() {
1250 static $backends = array();
1251 $backends[] = "_well_known";
1252 $backends[] = "api";
1253 $backends[] = "dfrn_notify";
1254 $backends[] = "fetch";
1255 $backends[] = "hcard";
1256 $backends[] = "hostxrd";
1257 $backends[] = "nodeinfo";
1258 $backends[] = "noscrape";
1260 $backends[] = "poco";
1261 $backends[] = "post";
1262 $backends[] = "proxy";
1263 $backends[] = "pubsub";
1264 $backends[] = "pubsubhubbub";
1265 $backends[] = "receive";
1266 $backends[] = "rsd_xml";
1267 $backends[] = "salmon";
1268 $backends[] = "statistics_json";
1269 $backends[] = "xrd";
1271 // Check if current module is in backend or backend flag is set
1272 return (in_array($this->module, $backends) || $this->backend);
1276 * @brief Checks if the maximum number of database processes is reached
1278 * @return bool Is the limit reached?
1280 function max_processes_reached() {
1282 if ($this->is_backend()) {
1283 $process = "backend";
1284 $max_processes = get_config('system', 'max_processes_backend');
1285 if (intval($max_processes) == 0) {
1289 $process = "frontend";
1290 $max_processes = get_config('system', 'max_processes_frontend');
1291 if (intval($max_processes) == 0) {
1292 $max_processes = 20;
1296 $processlist = dbm::processlist();
1297 if ($processlist["list"] != "") {
1298 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1300 if ($processlist["amount"] > $max_processes) {
1301 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1309 * @brief Checks if the maximum load is reached
1311 * @return bool Is the load reached?
1313 function maxload_reached() {
1315 if ($this->is_backend()) {
1316 $process = "backend";
1317 $maxsysload = intval(get_config('system', 'maxloadavg'));
1318 if ($maxsysload < 1) {
1322 $process = "frontend";
1323 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1324 if ($maxsysload < 1) {
1329 $load = current_load();
1331 if (intval($load) > $maxsysload) {
1332 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1339 function proc_run($args) {
1341 if (!function_exists("proc_open")) {
1345 // If the last worker fork was less than 10 seconds before then don't fork another one.
1346 // This should prevent the forking of masses of workers.
1347 $cachekey = "app:proc_run:started";
1348 $result = Cache::get($cachekey);
1350 if (!is_null($result) AND (time() - $result) < 10) {
1354 // Set the timestamp of the last proc_run
1355 Cache::set($cachekey, time(), CACHE_MINUTE);
1357 array_unshift($args, ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
1359 // add baseurl to args. cli scripts can't construct it
1360 $args[] = $this->get_baseurl();
1362 for ($x = 0; $x < count($args); $x ++) {
1363 $args[$x] = escapeshellarg($args[$x]);
1366 $cmdline = implode($args, " ");
1368 if (get_config('system', 'proc_windows')) {
1369 proc_close(proc_open('cmd /c start /b ' . $cmdline, array(), $foo, dirname(__FILE__)));
1371 proc_close(proc_open($cmdline . " &", array(), $foo, dirname(__FILE__)));
1377 * @brief Returns the system user that is executing the script
1379 * This mostly returns something like "www-data".
1381 * @return string system username
1383 static function systemuser() {
1384 if (!function_exists('posix_getpwuid') OR !function_exists('posix_geteuid')) {
1388 $processUser = posix_getpwuid(posix_geteuid());
1389 return $processUser['name'];
1393 * @brief Checks if a given directory is usable for the system
1395 * @return boolean the directory is usable
1397 static function directory_usable($directory) {
1399 if ($directory == '') {
1400 logger("Directory is empty. This shouldn't happen.", LOGGER_DEBUG);
1404 if (!file_exists($directory)) {
1405 logger('Path "'.$directory.'" does not exist for user '.self::systemuser(), LOGGER_DEBUG);
1408 if (is_file($directory)) {
1409 logger('Path "'.$directory.'" is a file for user '.self::systemuser(), LOGGER_DEBUG);
1412 if (!is_dir($directory)) {
1413 logger('Path "'.$directory.'" is not a directory for user '.self::systemuser(), LOGGER_DEBUG);
1416 if (!is_writable($directory)) {
1417 logger('Path "'.$directory.'" is not writable for user '.self::systemuser(), LOGGER_DEBUG);
1425 * @brief Retrieve the App structure
1427 * Useful in functions which require it but don't get it passed to them
1429 function get_app() {
1436 * @brief Multi-purpose function to check variable state.
1438 * Usage: x($var) or $x($array, 'key')
1440 * returns false if variable/key is not set
1441 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1442 * e.g. x('') or x(0) returns 0;
1444 * @param string|array $s variable to check
1445 * @param string $k key inside the array to check
1449 function x($s,$k = NULL) {
1451 if ((is_array($s)) && (array_key_exists($k, $s))) {
1471 * @brief Called from db initialisation if db is dead.
1473 function system_unavailable() {
1474 include('system_unavailable.php');
1480 function clean_urls() {
1486 $base = App::get_baseurl();
1488 if (! clean_urls()) {
1496 * @brief Returns the baseurl.
1498 * @see App::get_baseurl()
1501 * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1504 return App::get_baseurl();
1508 * @brief Return absolut URL for given $path.
1510 * @param string $path
1514 function absurl($path) {
1515 if (strpos($path,'/') === 0) {
1516 return z_path() . $path;
1522 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1526 function is_ajax() {
1527 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1530 function check_db() {
1532 $build = get_config('system','build');
1534 set_config('system','build',DB_UPDATE_VERSION);
1535 $build = DB_UPDATE_VERSION;
1537 if ($build != DB_UPDATE_VERSION) {
1538 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1545 * Sets the base url for use in cmdline programs which don't have
1546 * $_SERVER variables
1548 function check_url(App $a) {
1550 $url = get_config('system','url');
1552 // if the url isn't set or the stored url is radically different
1553 // than the currently visited url, store the current value accordingly.
1554 // "Radically different" ignores common variations such as http vs https
1555 // and www.example.com vs example.com.
1556 // We will only change the url to an ip address if there is no existing setting
1559 $url = set_config('system','url',App::get_baseurl());
1561 if ((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) {
1562 $url = set_config('system','url',App::get_baseurl());
1570 * @brief Automatic database updates
1572 function update_db(App $a) {
1573 $build = get_config('system','build');
1575 $build = set_config('system','build',DB_UPDATE_VERSION);
1578 if ($build != DB_UPDATE_VERSION) {
1579 $stored = intval($build);
1580 $current = intval(DB_UPDATE_VERSION);
1581 if ($stored < $current) {
1582 Config::load('database');
1584 // We're reporting a different version than what is currently installed.
1585 // Run any existing update scripts to bring the database up to current.
1587 // make sure that boot.php and update.php are the same release, we might be
1588 // updating right this very second and the correct version of the update.php
1589 // file may not be here yet. This can happen on a very busy site.
1591 if (DB_UPDATE_VERSION == UPDATE_VERSION) {
1592 // Compare the current structure with the defined structure
1594 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1599 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1601 // run old update routine (wich could modify the schema and
1602 // conflits with new routine)
1603 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1604 $r = run_update_function($x);
1609 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
1610 $stored = NEW_UPDATE_ROUTINE_VERSION;
1613 // run new update routine
1614 // it update the structure in one call
1615 $retval = update_structure(false, true);
1623 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1626 // run any left update_nnnn functions in update.php
1627 for ($x = $stored; $x < $current; $x ++) {
1628 $r = run_update_function($x);
1640 function run_update_function($x) {
1641 if (function_exists('update_' . $x)) {
1643 // There could be a lot of processes running or about to run.
1644 // We want exactly one process to run the update command.
1645 // So store the fact that we're taking responsibility
1646 // after first checking to see if somebody else already has.
1648 // If the update fails or times-out completely you may need to
1649 // delete the config entry to try again.
1651 $t = get_config('database','update_' . $x);
1655 set_config('database','update_' . $x, time());
1657 // call the specific update
1659 $func = 'update_' . $x;
1663 //send the administrator an e-mail
1666 sprintf(t('Update %s failed. See error logs.'), $x)
1670 set_config('database','update_' . $x, 'success');
1671 set_config('system','build', $x + 1);
1675 set_config('database','update_' . $x, 'success');
1676 set_config('system','build', $x + 1);
1683 * @brief Synchronise plugins:
1685 * $a->config['system']['addon'] contains a comma-separated list of names
1686 * of plugins/addons which are used on this system.
1687 * Go through the database list of already installed addons, and if we have
1688 * an entry, but it isn't in the config list, call the uninstall procedure
1689 * and mark it uninstalled in the database (for now we'll remove it).
1690 * Then go through the config list and if we have a plugin that isn't installed,
1691 * call the install procedure and add it to the database.
1696 function check_plugins(App $a) {
1698 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1699 if (dbm::is_result($r)) {
1702 $installed = array();
1705 $plugins = get_config('system','addon');
1706 $plugins_arr = array();
1709 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1712 $a->plugins = $plugins_arr;
1714 $installed_arr = array();
1716 if (count($installed)) {
1717 foreach ($installed as $i) {
1718 if (! in_array($i['name'],$plugins_arr)) {
1719 uninstall_plugin($i['name']);
1721 $installed_arr[] = $i['name'];
1726 if (count($plugins_arr)) {
1727 foreach ($plugins_arr as $p) {
1728 if (! in_array($p,$installed_arr)) {
1740 function get_guid($size=16, $prefix = "") {
1742 if ($prefix == "") {
1744 $prefix = hash("crc32", $a->get_hostname());
1747 while (strlen($prefix) < ($size - 13)) {
1748 $prefix .= mt_rand();
1752 $prefix = substr($prefix, 0, $size - 22);
1753 return(str_replace(".", "", uniqid($prefix, true)));
1755 $prefix = substr($prefix, 0, max($size - 13, 0));
1756 return(uniqid($prefix));
1761 * @brief Wrapper for adding a login box.
1763 * @param bool $register
1764 * If $register == true provide a registration link.
1765 * This will most always depend on the value of $a->config['register_policy'].
1766 * @param bool $hiddens
1769 * Returns the complete html for inserting into the page
1771 * @hooks 'login_hook'
1774 function login($register = false, $hiddens=false) {
1780 'title' => t('Create a New Account'),
1781 'desc' => t('Register')
1785 $noid = get_config('system','no_openid');
1787 $dest_url = $a->query_string;
1790 $tpl = get_markup_template("logout.tpl");
1792 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1793 '$baseurl' => $a->get_baseurl(true)
1796 $tpl = get_markup_template("login.tpl");
1797 $_SESSION['return_url'] = $a->query_string;
1798 $a->module = 'login';
1801 $o .= replace_macros($tpl, array(
1803 '$dest_url' => $dest_url,
1804 '$logout' => t('Logout'),
1805 '$login' => t('Login'),
1807 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1808 '$lpassword' => array('password', t('Password: '), '', ''),
1809 '$lremember' => array('remember', t('Remember me'), 0, ''),
1811 '$openid' => !$noid,
1812 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1814 '$hiddens' => $hiddens,
1816 '$register' => $reg,
1818 '$lostpass' => t('Forgot your password?'),
1819 '$lostlink' => t('Password Reset'),
1821 '$tostitle' => t('Website Terms of Service'),
1822 '$toslink' => t('terms of service'),
1824 '$privacytitle' => t('Website Privacy Policy'),
1825 '$privacylink' => t('privacy policy'),
1829 call_hooks('login_hook',$o);
1835 * @brief Used to end the current process, after saving session state.
1839 if (!get_app()->is_backend()) {
1840 session_write_close();
1847 * @brief Redirect to another URL and terminate this process.
1849 function goaway($s) {
1850 if (!strstr(normalise_link($s), "http://")) {
1851 $s = App::get_baseurl()."/".$s;
1854 header("Location: $s");
1860 * @brief Returns the user id of locally logged in user or false.
1862 * @return int|bool user id or false
1864 function local_user() {
1865 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
1866 return intval($_SESSION['uid']);
1872 * @brief Returns the public contact id of logged in user or false.
1874 * @return int|bool public contact id or false
1876 function public_contact() {
1877 static $public_contact_id = false;
1879 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1880 if (x($_SESSION, 'my_address')) {
1882 $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
1883 } elseif (x($_SESSION, 'visitor_home')) {
1885 $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
1887 } elseif (!x($_SESSION, 'authenticated')) {
1888 $public_contact_id = false;
1891 return $public_contact_id;
1895 * @brief Returns contact id of authenticated site visitor or false
1897 * @return int|bool visitor_id or false
1899 function remote_user() {
1900 if ((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) {
1901 return intval($_SESSION['visitor_id']);
1907 * @brief Show an error message to user.
1909 * This function save text in session, to be shown to the user at next page load
1911 * @param string $s - Text of notice
1913 function notice($s) {
1915 if (! x($_SESSION,'sysmsg')) {
1916 $_SESSION['sysmsg'] = array();
1918 if ($a->interactive) {
1919 $_SESSION['sysmsg'][] = $s;
1924 * @brief Show an info message to user.
1926 * This function save text in session, to be shown to the user at next page load
1928 * @param string $s - Text of notice
1933 if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) {
1937 if (! x($_SESSION,'sysmsg_info')) {
1938 $_SESSION['sysmsg_info'] = array();
1940 if ($a->interactive) {
1941 $_SESSION['sysmsg_info'][] = $s;
1947 * @brief Wrapper around config to limit the text length of an incoming message
1951 function get_max_import_size() {
1953 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1957 * @brief Wrap calls to proc_close(proc_open()) and call hook
1958 * so plugins can take part in process :)
1960 * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1962 * next args are passed as $cmd command line
1963 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1964 * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1966 * @note $cmd and string args are surrounded with ""
1971 function proc_run($cmd){
1975 $proc_args = func_get_args();
1978 if (!count($proc_args)) {
1982 // Preserve the first parameter
1983 // It could contain a command, the priority or an parameter array
1984 // If we use the parameter array we have to protect it from the following function
1985 $run_parameter = array_shift($proc_args);
1987 // expand any arrays
1988 foreach ($proc_args as $arg) {
1989 if (is_array($arg)) {
1990 foreach ($arg as $n) {
1998 // Now we add the run parameters back to the array
1999 array_unshift($args, $run_parameter);
2001 $arr = array('args' => $args, 'run_cmd' => true);
2003 call_hooks("proc_run", $arr);
2004 if (!$arr['run_cmd'] OR !count($args)) {
2008 $priority = PRIORITY_MEDIUM;
2009 $dont_fork = get_config("system", "worker_dont_fork");
2011 if (is_int($run_parameter)) {
2012 $priority = $run_parameter;
2013 } elseif (is_array($run_parameter)) {
2014 if (isset($run_parameter['priority'])) {
2015 $priority = $run_parameter['priority'];
2017 if (isset($run_parameter['dont_fork'])) {
2018 $dont_fork = $run_parameter['dont_fork'];
2025 $parameters = json_encode($argv);
2026 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
2027 dbesc($parameters));
2029 if (!dbm::is_result($found)) {
2030 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
2031 VALUES ('%s', '%s', %d)",
2033 dbesc(datetime_convert()),
2037 // Should we quit and wait for the poller to be called as a cronjob?
2042 // Checking number of workers
2043 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
2045 // Get number of allowed number of worker threads
2046 $queues = intval(get_config("system", "worker_queues"));
2052 // If there are already enough workers running, don't fork another one
2053 if ($workers[0]["workers"] >= $queues) {
2057 // Now call the poller to execute the jobs that we just added to the queue
2058 $args = array("include/poller.php", "no_cron");
2060 $a->proc_run($args);
2063 function current_theme(){
2064 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2070 // Find the theme that belongs to the user whose stuff we are looking at
2072 if ($a->profile_uid && ($a->profile_uid != local_user())) {
2073 $r = q("select theme from user where uid = %d limit 1",
2074 intval($a->profile_uid)
2076 if (dbm::is_result($r)) {
2077 $page_theme = $r[0]['theme'];
2081 // Allow folks to over-rule user themes and always use their own on their own site.
2082 // This works only if the user is on the same server
2084 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2085 if (get_pconfig(local_user(),'system','always_my_theme')) {
2090 // $mobile_detect = new Mobile_Detect();
2091 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2092 $is_mobile = $a->is_mobile || $a->is_tablet;
2094 $standard_system_theme = Config::get('system', 'theme', '');
2095 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2098 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2099 $system_theme = $standard_system_theme;
2100 $theme_name = $standard_theme_name;
2102 $system_theme = Config::get('system', 'mobile-theme', '');
2103 if ($system_theme == '') {
2104 $system_theme = $standard_system_theme;
2106 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2108 if ($theme_name === '---') {
2109 // user has selected to have the mobile theme be the same as the normal one
2110 $system_theme = $standard_system_theme;
2111 $theme_name = $standard_theme_name;
2114 $theme_name = $page_theme;
2119 $system_theme = $standard_system_theme;
2120 $theme_name = $standard_theme_name;
2123 $theme_name = $page_theme;
2128 (file_exists('view/theme/' . $theme_name . '/style.css') ||
2129 file_exists('view/theme/' . $theme_name . '/style.php'))) {
2130 return($theme_name);
2133 foreach ($app_base_themes as $t) {
2134 if (file_exists('view/theme/' . $t . '/style.css') ||
2135 file_exists('view/theme/' . $t . '/style.php')) {
2140 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2141 if (count($fallback)) {
2142 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2145 /// @TODO No final return statement?
2149 * @brief Return full URL to theme which is currently in effect.
2151 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2155 function current_theme_url() {
2158 $t = current_theme();
2160 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2161 if (file_exists('view/theme/' . $t . '/style.php')) {
2162 return('view/theme/'.$t.'/style.pcss'.$opts);
2165 return('view/theme/'.$t.'/style.css');
2168 function feed_birthday($uid,$tz) {
2172 * Determine the next birthday, but only if the birthday is published
2173 * in the default profile. We _could_ also look for a private profile that the
2174 * recipient can see, but somebody could get mad at us if they start getting
2175 * public birthday greetings when they haven't made this info public.
2177 * Assuming we are able to publish this info, we are then going to convert
2178 * the start time from the owner's timezone to UTC.
2180 * This will potentially solve the problem found with some social networks
2181 * where birthdays are converted to the viewer's timezone and salutations from
2182 * elsewhere in the world show up on the wrong day. We will convert it to the
2183 * viewer's timezone also, but first we are going to convert it from the birthday
2184 * person's timezone to GMT - so the viewer may find the birthday starting at
2185 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2192 if (! strlen($tz)) {
2196 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2200 if (dbm::is_result($p)) {
2201 $tmp_dob = substr($p[0]['dob'],5);
2202 if (intval($tmp_dob)) {
2203 $y = datetime_convert($tz,$tz,'now','Y');
2204 $bd = $y . '-' . $tmp_dob . ' 00:00';
2205 $t_dob = strtotime($bd);
2206 $now = strtotime(datetime_convert($tz,$tz,'now'));
2207 if ($t_dob < $now) {
2208 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2210 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2218 * @brief Check if current user has admin role.
2220 * @return bool true if user is an admin
2222 function is_site_admin() {
2225 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2227 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2228 if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) {
2235 * @brief Returns querystring as string from a mapped array.
2237 * @param array $params mapped array with query parameters
2238 * @param string $name of parameter, default null
2242 function build_querystring($params, $name = null) {
2244 foreach ($params as $key => $val) {
2245 if (is_array($val)) {
2246 /// @TODO maybe not compare against null, use is_null()
2247 if ($name == null) {
2248 $ret .= build_querystring($val, $key);
2250 $ret .= build_querystring($val, $name."[$key]");
2253 $val = urlencode($val);
2254 /// @TODO maybe not compare against null, use is_null()
2255 if ($name != null) {
2256 /// @TODO two string concated, can be merged to one
2257 $ret .= $name . "[$key]" . "=$val&";
2259 $ret .= "$key=$val&";
2266 function explode_querystring($query) {
2267 $arg_st = strpos($query, '?');
2268 if ($arg_st !== false) {
2269 $base = substr($query, 0, $arg_st);
2276 $args = explode('&', substr($query, $arg_st));
2277 foreach ($args as $k => $arg) {
2278 /// @TODO really compare type-safe here?
2283 $args = array_values($args);
2288 $args = array_values($args);
2298 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2300 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2302 function curPageURL() {
2304 if ($_SERVER["HTTPS"] == "on") {
2310 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2311 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2313 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2318 function random_digits($digits) {
2320 for ($i = 0; $i < $digits; $i++) {
2321 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
2327 function get_server() {
2328 $server = get_config("system", "directory");
2330 if ($server == "") {
2331 $server = "http://dir.friendi.ca";
2337 function get_cachefile($file, $writemode = true) {
2338 $cache = get_itemcachepath();
2340 if ((! $cache) || (! is_dir($cache))) {
2344 $subfolder = $cache . "/" . substr($file, 0, 2);
2346 $cachepath = $subfolder . "/" . $file;
2349 if (!is_dir($subfolder)) {
2351 chmod($subfolder, 0777);
2355 /// @TODO no need to put braces here
2359 function clear_cache($basepath = "", $path = "") {
2361 $basepath = get_itemcachepath();
2365 if (($path == "") OR (!is_dir($path))) {
2369 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
2373 $cachetime = (int)get_config('system','itemcache_duration');
2374 if ($cachetime == 0) {
2378 if (is_writable($path)){
2379 if ($dh = opendir($path)) {
2380 while (($file = readdir($dh)) !== false) {
2381 $fullpath = $path."/".$file;
2382 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != "..")) {
2383 clear_cache($basepath, $fullpath);
2385 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime))) {
2394 function get_itemcachepath() {
2395 // Checking, if the cache is deactivated
2396 $cachetime = (int)get_config('system','itemcache_duration');
2397 if ($cachetime < 0) {
2401 $itemcache = get_config('system','itemcache');
2402 if (($itemcache != "") AND App::directory_usable($itemcache)) {
2406 $temppath = get_temppath();
2408 if ($temppath != "") {
2409 $itemcache = $temppath."/itemcache";
2410 if (!file_exists($itemcache) && !is_dir($itemcache)) {
2414 if (App::directory_usable($itemcache)) {
2415 set_config("system", "itemcache", $itemcache);
2423 * @brief Returns the path where spool files are stored
2425 * @return string Spool path
2427 function get_spoolpath() {
2428 $spoolpath = get_config('system','spoolpath');
2429 if (($spoolpath != "") AND App::directory_usable($spoolpath)) {
2430 // We have a spool path and it is usable
2434 // We don't have a working preconfigured spool path, so we take the temp path.
2435 $temppath = get_temppath();
2437 if ($temppath != "") {
2438 // To avoid any interferences with other systems we create our own directory
2439 $spoolpath = $temppath."/spool";
2440 if (!is_dir($spoolpath)) {
2444 if (App::directory_usable($spoolpath)) {
2445 // The new path is usable, we are happy
2446 set_config("system", "spoolpath", $spoolpath);
2449 // We can't create a subdirectory, strange.
2450 // But the directory seems to work, so we use it but don't store it.
2455 // Reaching this point means that the operating system is configured badly.
2459 function get_temppath() {
2462 $temppath = get_config("system", "temppath");
2464 if (($temppath != "") AND App::directory_usable($temppath)) {
2465 // We have a temp path and it is usable
2469 // We don't have a working preconfigured temp path, so we take the system path.
2470 $temppath = sys_get_temp_dir();
2472 // Check if it is usable
2473 if (($temppath != "") AND App::directory_usable($temppath)) {
2474 // To avoid any interferences with other systems we create our own directory
2475 $new_temppath .= "/".$a->get_hostname();
2476 if (!is_dir($new_temppath)) {
2477 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
2478 mkdir($new_temppath);
2481 if (App::directory_usable($new_temppath)) {
2482 // The new path is usable, we are happy
2483 set_config("system", "temppath", $new_temppath);
2484 return $new_temppath;
2486 // We can't create a subdirectory, strange.
2487 // But the directory seems to work, so we use it but don't store it.
2492 // Reaching this point means that the operating system is configured badly.
2497 function set_template_engine(App $a, $engine = 'internal') {
2498 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2499 /// to avoid breaking themes again unnecessarily
2500 /// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
2502 $a->set_template_engine($engine);
2505 if (!function_exists('exif_imagetype')) {
2506 function exif_imagetype($file) {
2507 $size = getimagesize($file);
2512 function validate_include(&$file) {
2515 $file = realpath($file);
2517 if (strpos($file, getcwd()) !== 0) {
2521 $file = str_replace(getcwd()."/", "", $file, $count);
2526 if ($orig_file !== $file) {
2531 if (strpos($file, "include/") === 0) {
2535 if (strpos($file, "addon/") === 0) {
2539 // Simply return flag
2543 function current_load() {
2544 if (!function_exists('sys_getloadavg')) {
2548 $load_arr = sys_getloadavg();
2550 if (!is_array($load_arr)) {
2554 return max($load_arr[0], $load_arr[1]);
2558 * @brief get c-style args
2563 return get_app()->argc;
2567 * @brief Returns the value of a argv key
2569 * @param int $x argv key
2570 * @return string Value of the argv key
2573 if (array_key_exists($x,get_app()->argv)) {
2574 return get_app()->argv[$x];
2581 * @brief Get the data which is needed for infinite scroll
2583 * For invinite scroll we need the page number of the actual page
2584 * and the the URI where the content of the next page comes from.
2585 * This data is needed for the js part in main.js.
2586 * Note: infinite scroll does only work for the network page (module)
2588 * @param string $module The name of the module (e.g. "network")
2589 * @return array Of infinite scroll data
2590 * 'pageno' => $pageno The number of the actual page
2591 * 'reload_uri' => $reload_uri The URI of the content we have to load
2593 function infinite_scroll_data($module) {
2595 if (get_pconfig(local_user(),'system','infinite_scroll')
2596 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2598 // get the page number
2599 if (is_string($_GET["page"])) {
2600 $pageno = $_GET["page"];
2607 // try to get the uri from which we load the content
2608 foreach ($_GET AS $param => $value) {
2609 if (($param != "page") AND ($param != "q")) {
2610 $reload_uri .= "&" . $param . "=" . urlencode($value);
2614 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset=")) {
2615 $reload_uri .= "&offset=" . urlencode($a->page_offset);
2618 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);