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.
256 $netgroup_ids = array(
257 NETWORK_DFRN => (-1),
259 NETWORK_OSTATUS => (-3),
260 NETWORK_FEED => (-4),
261 NETWORK_DIASPORA => (-5),
262 NETWORK_MAIL => (-6),
263 NETWORK_MAIL2 => (-7),
264 NETWORK_FACEBOOK => (-8),
265 NETWORK_LINKEDIN => (-9),
266 NETWORK_XMPP => (-10),
267 NETWORK_MYSPACE => (-11),
268 NETWORK_GPLUS => (-12),
269 NETWORK_PUMPIO => (-13),
270 NETWORK_TWITTER => (-14),
271 NETWORK_DIASPORA2 => (-15),
272 NETWORK_STATUSNET => (-16),
273 NETWORK_APPNET => (-17),
274 NETWORK_NEWS => (-18),
275 NETWORK_ICALENDAR => (-19),
276 NETWORK_PNUT => (-20),
278 NETWORK_PHANTOM => (-127),
283 * Maximum number of "people who like (or don't like) this" that we will list by name
286 define ( 'MAX_LIKERS', 75);
289 * Communication timeout
292 define ( 'ZCURL_TIMEOUT' , (-1));
298 * Email notification options
301 define ( 'NOTIFY_INTRO', 0x0001 );
302 define ( 'NOTIFY_CONFIRM', 0x0002 );
303 define ( 'NOTIFY_WALL', 0x0004 );
304 define ( 'NOTIFY_COMMENT', 0x0008 );
305 define ( 'NOTIFY_MAIL', 0x0010 );
306 define ( 'NOTIFY_SUGGEST', 0x0020 );
307 define ( 'NOTIFY_PROFILE', 0x0040 );
308 define ( 'NOTIFY_TAGSELF', 0x0080 );
309 define ( 'NOTIFY_TAGSHARE', 0x0100 );
310 define ( 'NOTIFY_POKE', 0x0200 );
311 define ( 'NOTIFY_SHARE', 0x0400 );
313 define ( 'NOTIFY_SYSTEM', 0x8000 );
323 define ( 'TERM_UNKNOWN', 0 );
324 define ( 'TERM_HASHTAG', 1 );
325 define ( 'TERM_MENTION', 2 );
326 define ( 'TERM_CATEGORY', 3 );
327 define ( 'TERM_PCATEGORY', 4 );
328 define ( 'TERM_FILE', 5 );
329 define ( 'TERM_SAVEDSEARCH', 6 );
330 define ( 'TERM_CONVERSATION', 7 );
332 define ( 'TERM_OBJ_POST', 1 );
333 define ( 'TERM_OBJ_PHOTO', 2 );
340 * Various namespaces we may need to parse
343 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
344 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
345 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
346 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
347 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
348 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
349 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
350 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
351 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
352 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
353 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
354 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
355 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
356 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
357 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
363 * Activity stream defines
366 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
367 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
368 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
369 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
370 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
372 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
374 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
375 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
376 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
377 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
378 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
379 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
381 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
382 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
383 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
384 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
385 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
387 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
388 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
390 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
391 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
392 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
393 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
394 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
395 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
396 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
397 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
398 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
399 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
400 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
401 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
402 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
403 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
409 * Item weight for query ordering
412 define ( 'GRAVITY_PARENT', 0);
413 define ( 'GRAVITY_LIKE', 3);
414 define ( 'GRAVITY_COMMENT', 6);
420 * Process priority for the worker
423 define('PRIORITY_UNDEFINED', 0);
424 define('PRIORITY_CRITICAL', 10);
425 define('PRIORITY_HIGH', 20);
426 define('PRIORITY_MEDIUM', 30);
427 define('PRIORITY_LOW', 40);
428 define('PRIORITY_NEGLIGIBLE',50);
432 * @name Social Relay settings
434 * See here: https://github.com/jaywink/social-relay
435 * and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
438 define('SR_SCOPE_NONE', '');
439 define('SR_SCOPE_ALL', 'all');
440 define('SR_SCOPE_TAGS', 'tags');
444 * Lowest possible date time value
447 define ('NULL_DATE', '0001-01-01 00:00:00');
450 // Normally this constant is defined - but not if "pcntl" isn't installed
451 if (!defined("SIGTERM")) {
452 define("SIGTERM", 15);
456 * Reverse the effect of magic_quotes_gpc if it is enabled.
457 * Please disable magic_quotes_gpc so we don't have to do this.
458 * See http://php.net/manual/en/security.magicquotes.disabling.php
464 error_reporting(E_ERROR | E_WARNING | E_PARSE);
468 // This has to be quite large to deal with embedded private photos
469 ini_set('pcre.backtrack_limit', 500000);
472 if (get_magic_quotes_gpc()) {
473 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
474 while (list($key, $val) = each($process)) {
475 foreach ($val as $k => $v) {
476 unset($process[$key][$k]);
478 $process[$key][stripslashes($k)] = $v;
479 $process[] = &$process[$key][stripslashes($k)];
481 $process[$key][stripslashes($k)] = stripslashes($v);
494 * @brief Our main application structure for the life of this page.
496 * Primarily deals with the URL that got us here
497 * and tries to make some sense of it, and
498 * stores our page contents and config storage
499 * and anything else that might need to be passed around
500 * before we spit the page out.
505 /// @TODO decide indending as a colorful mixure is ahead ...
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 /// @TODO x() should be better used here ...
659 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
660 (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
661 (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
662 (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
663 (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
664 (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
666 $this->scheme = 'https';
669 if (x($_SERVER, 'SERVER_NAME')) {
670 $this->hostname = $_SERVER['SERVER_NAME'];
672 if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
673 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
676 * Figure out if we are running at the top of a domain
677 * or in a sub-directory and adjust accordingly
680 /// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
681 $path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
682 if (isset($path) && strlen($path) && ($path != $this->path)) {
687 if ($hostname != "") {
688 $this->hostname = $hostname;
691 if (is_array($_SERVER["argv"]) && $_SERVER["argc"] > 1 && substr(end($_SERVER["argv"]), 0, 4) == "http" ) {
692 $this->set_baseurl(array_pop($_SERVER["argv"]));
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 /// @TODO can be shortened by trim($str, '/') !
700 if (substr($this->query_string, 0, 1) == "/") {
701 $this->query_string = substr($this->query_string, 1);
703 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === "q=") {
704 $this->query_string = substr($_SERVER['QUERY_STRING'],2);
705 // removing trailing / - maybe a nginx problem
706 /// @TODO can be shortened by trim($str, '/') !
707 if (substr($this->query_string, 0, 1) == "/") {
708 $this->query_string = substr($this->query_string, 1);
712 if (x($_GET, 'pagename')) {
713 $this->cmd = trim($_GET['pagename'], '/\\');
714 } elseif (x($_GET, 'q')) {
715 $this->cmd = trim($_GET['q'], '/\\');
720 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
722 // unix style "homedir"
723 if (substr($this->cmd, 0, 1) === '~') {
724 $this->cmd = 'profile/' . substr($this->cmd, 1);
727 // Diaspora style profile url
729 if (substr($this->cmd,0,2) === 'u/') {
730 $this->cmd = 'profile/' . substr($this->cmd,2);
736 * Break the URL path into C style argc/argv style arguments for our
737 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
738 * will be 3 (integer) and $this->argv will contain:
744 * There will always be one argument. If provided a naked domain
745 * URL, $this->argv[0] is set to "home".
749 $this->argv = explode('/',$this->cmd);
750 $this->argc = count($this->argv);
751 if ((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
752 $this->module = str_replace(".", "_", $this->argv[0]);
753 $this->module = str_replace("-", "_", $this->module);
756 $this->argv = array('home');
757 $this->module = 'home';
761 * See if there is any page number information, and initialise
765 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
766 $this->pager['itemspage'] = 50;
767 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
768 if ($this->pager['start'] < 0) {
769 $this->pager['start'] = 0;
771 $this->pager['total'] = 0;
774 * Detect mobile devices
777 $mobile_detect = new Mobile_Detect();
778 $this->is_mobile = $mobile_detect->isMobile();
779 $this->is_tablet = $mobile_detect->isTablet();
782 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
785 * register template engines
787 $dc = get_declared_classes();
788 foreach ($dc as $k) {
789 if (in_array("ITemplateEngine", class_implements($k))){
790 $this->register_template_engine($k);
798 public static function get_basepath() {
800 $basepath = get_config("system", "basepath");
802 if ($basepath == "") {
803 $basepath = dirname(__FILE__);
806 if ($basepath == "") {
807 $basepath = $_SERVER["DOCUMENT_ROOT"];
810 if ($basepath == "") {
811 $basepath = $_SERVER["PWD"];
817 function get_scheme() {
818 return $this->scheme;
822 * @brief Retrieves the Friendica instance base URL
824 * This function assembles the base URL from multiple parts:
825 * - Protocol is determined either by the request or a combination of
826 * system.ssl_policy and the $ssl parameter.
827 * - Host name is determined either by system.hostname or inferred from request
828 * - Path is inferred from SCRIPT_NAME
830 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
832 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
833 * @return string Friendica server base URL
835 function get_baseurl($ssl = false) {
837 // Is the function called statically?
838 if (!(isset($this) && get_class($this) == __CLASS__)) {
839 return self::$a->get_baseurl($ssl);
842 $scheme = $this->scheme;
844 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
848 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
849 // (and also the login link). Anything seen by an outsider will have it turned off.
851 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
859 if (Config::get('config', 'hostname') != '') {
860 $this->hostname = Config::get('config', 'hostname');
863 return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
867 * @brief Initializes the baseurl components
869 * Clears the baseurl cache to prevent inconstistencies
873 function set_baseurl($url) {
874 $parsed = @parse_url($url);
877 $this->scheme = $parsed['scheme'];
879 $hostname = $parsed['host'];
880 if (x($parsed, 'port')) {
881 $hostname .= ':' . $parsed['port'];
883 if (x($parsed, 'path')) {
884 $this->path = trim($parsed['path'], '\\/');
887 if (file_exists(".htpreconfig.php")) {
888 include ".htpreconfig.php";
891 if (get_config('config', 'hostname') != '') {
892 $this->hostname = get_config('config', 'hostname');
895 if (!isset($this->hostname) OR ($this->hostname == '')) {
896 $this->hostname = $hostname;
901 function get_hostname() {
902 if (get_config('config', 'hostname') != "") {
903 $this->hostname = get_config('config', 'hostname');
906 return $this->hostname;
909 function set_hostname($h) {
910 $this->hostname = $h;
913 function set_path($p) {
914 $this->path = trim(trim($p), '/');
917 function get_path() {
921 function set_pager_total($n) {
922 $this->pager['total'] = intval($n);
925 function set_pager_itemspage($n) {
926 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
927 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
930 function set_pager_page($n) {
931 $this->pager['page'] = $n;
932 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
935 function init_pagehead() {
936 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
938 // If the update is "deactivated" set it to the highest integer number (~24 days)
940 $interval = 2147483647;
943 if ($interval < 10000) {
947 // compose the page title from the sitename and the
948 // current module called
949 if (!$this->module == '') {
950 $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
952 $this->page['title'] = $this->config['sitename'];
955 /* put the head template at the beginning of page['htmlhead']
956 * since the code added by the modules frequently depends on it
959 if (!isset($this->page['htmlhead'])) {
960 $this->page['htmlhead'] = '';
963 // If we're using Smarty, then doing replace_macros() will replace
964 // any unrecognized variables with a blank string. Since we delay
965 // replacing $stylesheet until later, we need to replace it now
966 // with another variable name
967 if ($this->theme['template_engine'] === 'smarty3') {
968 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
970 $stylesheet = '$stylesheet';
973 $shortcut_icon = get_config("system", "shortcut_icon");
974 if ($shortcut_icon == "") {
975 $shortcut_icon = "images/friendica-32.png";
978 $touch_icon = get_config("system", "touch_icon");
979 if ($touch_icon == "") {
980 $touch_icon = "images/friendica-128.png";
983 // get data wich is needed for infinite scroll on the network page
984 $invinite_scroll = infinite_scroll_data($this->module);
986 $tpl = get_markup_template('head.tpl');
987 $this->page['htmlhead'] = replace_macros($tpl,array(
988 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
989 '$local_user' => local_user(),
990 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
991 '$delitem' => t('Delete this item?'),
992 '$showmore' => t('show more'),
993 '$showfewer' => t('show fewer'),
994 '$update_interval' => $interval,
995 '$shortcut_icon' => $shortcut_icon,
996 '$touch_icon' => $touch_icon,
997 '$stylesheet' => $stylesheet,
998 '$infinite_scroll' => $invinite_scroll,
999 )) . $this->page['htmlhead'];
1002 function init_page_end() {
1003 if (!isset($this->page['end'])) {
1004 $this->page['end'] = '';
1006 $tpl = get_markup_template('end.tpl');
1007 $this->page['end'] = replace_macros($tpl,array(
1008 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
1009 )) . $this->page['end'];
1012 function set_curl_code($code) {
1013 $this->curl_code = $code;
1016 function get_curl_code() {
1017 return $this->curl_code;
1020 function set_curl_content_type($content_type) {
1021 $this->curl_content_type = $content_type;
1024 function get_curl_content_type() {
1025 return $this->curl_content_type;
1028 function set_curl_headers($headers) {
1029 $this->curl_headers = $headers;
1032 function get_curl_headers() {
1033 return $this->curl_headers;
1036 function get_cached_avatar_image($avatar_image){
1037 return $avatar_image;
1042 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1044 * @param string $orig_url
1046 * @return string The cleaned url
1048 function remove_baseurl($orig_url){
1050 // Is the function called statically?
1051 if (!(isset($this) && get_class($this) == __CLASS__)) {
1052 return self::$a->remove_baseurl($orig_url);
1055 // Remove the hostname from the url if it is an internal link
1056 $nurl = normalise_link($orig_url);
1057 $base = normalise_link($this->get_baseurl());
1058 $url = str_replace($base."/", "", $nurl);
1060 // if it is an external link return the orignal value
1061 if ($url == normalise_link($orig_url)) {
1069 * @brief Register template engine class
1071 * If $name is "", is used class static property $class::$name
1073 * @param string $class
1074 * @param string $name
1076 function register_template_engine($class, $name = '') {
1077 /// @TODO Really === and not just == ?
1079 $v = get_class_vars( $class );
1080 if (x($v,"name")) $name = $v['name'];
1083 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1086 $this->template_engines[$name] = $class;
1090 * @brief Return template engine instance.
1092 * If $name is not defined, return engine defined by theme,
1095 * @param strin $name Template engine name
1096 * @return object Template Engine instance
1098 function template_engine($name = '') {
1099 /// @TODO really type-check included?
1101 $template_engine = $name;
1103 $template_engine = 'smarty3';
1104 if (x($this->theme, 'template_engine')) {
1105 $template_engine = $this->theme['template_engine'];
1109 if (isset($this->template_engines[$template_engine])){
1110 if (isset($this->template_engine_instance[$template_engine])){
1111 return $this->template_engine_instance[$template_engine];
1113 $class = $this->template_engines[$template_engine];
1115 $this->template_engine_instance[$template_engine] = $obj;
1120 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1124 * @brief Returns the active template engine.
1128 function get_template_engine() {
1129 return $this->theme['template_engine'];
1132 function set_template_engine($engine = 'smarty3') {
1133 $this->theme['template_engine'] = $engine;
1136 function get_template_ldelim($engine = 'smarty3') {
1137 return $this->ldelim[$engine];
1140 function get_template_rdelim($engine = 'smarty3') {
1141 return $this->rdelim[$engine];
1144 function save_timestamp($stamp, $value) {
1145 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
1149 $duration = (float)(microtime(true)-$stamp);
1151 if (!isset($this->performance[$value])) {
1152 // Prevent ugly E_NOTICE
1153 $this->performance[$value] = 0;
1156 $this->performance[$value] += (float)$duration;
1157 $this->performance["marktime"] += (float)$duration;
1159 $callstack = $this->callstack();
1161 if (!isset($this->callstack[$value][$callstack])) {
1162 // Prevent ugly E_NOTICE
1163 $this->callstack[$value][$callstack] = 0;
1166 $this->callstack[$value][$callstack] += (float)$duration;
1171 * @brief Log active processes into the "process" table
1173 function start_process() {
1174 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1176 $command = basename($trace[0]["file"]);
1178 $this->remove_inactive_processes();
1180 q("START TRANSACTION");
1182 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1183 if (!dbm::is_result($r)) {
1184 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1187 dbesc(datetime_convert()));
1193 * @brief Remove inactive processes
1195 function remove_inactive_processes() {
1196 q("START TRANSACTION");
1198 $r = q("SELECT `pid` FROM `process`");
1199 if (dbm::is_result($r)) {
1200 foreach ($r AS $process) {
1201 if (!posix_kill($process["pid"], 0)) {
1202 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1210 * @brief Remove the active process from the "process" table
1212 function end_process() {
1213 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1217 * @brief Returns a string with a callstack. Can be used for logging.
1221 function callstack() {
1222 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1224 // We remove the first two items from the list since they contain data that we don't need.
1225 array_shift($trace);
1226 array_shift($trace);
1228 $callstack = array();
1229 foreach ($trace AS $func) {
1230 $callstack[] = $func["function"];
1233 return implode(", ", $callstack);
1236 function get_useragent() {
1238 FRIENDICA_PLATFORM . " '" .
1239 FRIENDICA_CODENAME . "' " .
1240 FRIENDICA_VERSION . "-" .
1241 DB_UPDATE_VERSION . "; " .
1242 $this->get_baseurl();
1245 function is_friendica_app() {
1246 return $this->is_friendica_app;
1250 * @brief Checks if the site is called via a backend process
1252 * This isn't a perfect solution. But we need this check very early.
1253 * So we cannot wait until the modules are loaded.
1255 * @return bool Is it a known backend?
1257 function is_backend() {
1258 /// @Should be made static to speedup things
1260 $backend[] = "_well_known";
1262 $backend[] = "dfrn_notify";
1263 $backend[] = "fetch";
1264 $backend[] = "hcard";
1265 $backend[] = "hostxrd";
1266 $backend[] = "nodeinfo";
1267 $backend[] = "noscrape";
1269 $backend[] = "poco";
1270 $backend[] = "post";
1271 $backend[] = "proxy";
1272 $backend[] = "pubsub";
1273 $backend[] = "pubsubhubbub";
1274 $backend[] = "receive";
1275 $backend[] = "rsd_xml";
1276 $backend[] = "salmon";
1277 $backend[] = "statistics_json";
1280 /// @TODO Maybe rewrite this part: return (in_array() || $this->backend); ?
1281 if (in_array($this->module, $backend)) {
1284 return($this->backend);
1289 * @brief Checks if the maximum number of database processes is reached
1291 * @return bool Is the limit reached?
1293 function max_processes_reached() {
1295 if ($this->is_backend()) {
1296 $process = "backend";
1297 $max_processes = get_config('system', 'max_processes_backend');
1298 if (intval($max_processes) == 0) {
1302 $process = "frontend";
1303 $max_processes = get_config('system', 'max_processes_frontend');
1304 if (intval($max_processes) == 0) {
1305 $max_processes = 20;
1309 $processlist = dbm::processlist();
1310 if ($processlist["list"] != "") {
1311 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1313 if ($processlist["amount"] > $max_processes) {
1314 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1322 * @brief Checks if the maximum load is reached
1324 * @return bool Is the load reached?
1326 function maxload_reached() {
1328 if ($this->is_backend()) {
1329 $process = "backend";
1330 $maxsysload = intval(get_config('system', 'maxloadavg'));
1331 if ($maxsysload < 1) {
1335 $process = "frontend";
1336 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1337 if ($maxsysload < 1) {
1342 $load = current_load();
1344 if (intval($load) > $maxsysload) {
1345 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1352 function proc_run($args) {
1354 if (!function_exists("proc_open")) {
1358 // If the last worker fork was less than 10 seconds before then don't fork another one.
1359 // This should prevent the forking of masses of workers.
1360 $cachekey = "app:proc_run:started";
1361 $result = Cache::get($cachekey);
1363 if (!is_null($result) AND (time() - $result) < 10) {
1367 // Set the timestamp of the last proc_run
1368 Cache::set($cachekey, time(), CACHE_MINUTE);
1370 array_unshift($args, ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
1372 // add baseurl to args. cli scripts can't construct it
1373 $args[] = $this->get_baseurl();
1375 /// @TODO let's replace these with a foreach($key => $value) loop
1376 for ($x = 0; $x < count($args); $x ++) {
1377 $args[$x] = escapeshellarg($args[$x]);
1380 $cmdline = implode($args, " ");
1382 if (get_config('system', 'proc_windows')) {
1383 proc_close(proc_open('cmd /c start /b ' . $cmdline, array(), $foo, dirname(__FILE__)));
1385 proc_close(proc_open($cmdline . " &", array(), $foo, dirname(__FILE__)));
1391 * @brief Returns the system user that is executing the script
1393 * This mostly returns something like "www-data".
1395 * @return string system username
1397 static function systemuser() {
1398 if (!function_exists('posix_getpwuid') OR !function_exists('posix_geteuid')) {
1402 $processUser = posix_getpwuid(posix_geteuid());
1403 return $processUser['name'];
1407 * @brief Checks if a given directory is usable for the system
1409 * @return boolean the directory is usable
1411 static function directory_usable($directory) {
1413 if ($directory == '') {
1414 logger("Directory is empty. This shouldn't happen.", LOGGER_DEBUG);
1418 if (!file_exists($directory)) {
1419 logger('Path "'.$directory.'" does not exist for user '.self::systemuser(), LOGGER_DEBUG);
1422 if (is_file($directory)) {
1423 logger('Path "'.$directory.'" is a file for user '.self::systemuser(), LOGGER_DEBUG);
1426 if (!is_dir($directory)) {
1427 logger('Path "'.$directory.'" is not a directory for user '.self::systemuser(), LOGGER_DEBUG);
1430 if (!is_writable($directory)) {
1431 logger('Path "'.$directory.'" is not writable for user '.self::systemuser(), LOGGER_DEBUG);
1439 * @brief Retrieve the App structure
1441 * Useful in functions which require it but don't get it passed to them
1443 function get_app() {
1450 * @brief Multi-purpose function to check variable state.
1452 * Usage: x($var) or $x($array, 'key')
1454 * returns false if variable/key is not set
1455 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1456 * e.g. x('') or x(0) returns 0;
1458 * @param string|array $s variable to check
1459 * @param string $k key inside the array to check
1463 function x($s,$k = NULL) {
1465 if ((is_array($s)) && (array_key_exists($k,$s))) {
1485 * @brief Called from db initialisation if db is dead.
1487 function system_unavailable() {
1488 include('system_unavailable.php');
1494 function clean_urls() {
1500 $base = App::get_baseurl();
1502 if (! clean_urls()) {
1510 * @brief Returns the baseurl.
1512 * @see App::get_baseurl()
1515 * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1518 return App::get_baseurl();
1522 * @brief Return absolut URL for given $path.
1524 * @param string $path
1528 function absurl($path) {
1529 if (strpos($path,'/') === 0) {
1530 return z_path() . $path;
1536 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1540 function is_ajax() {
1541 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1544 function check_db() {
1546 $build = get_config('system','build');
1548 set_config('system','build',DB_UPDATE_VERSION);
1549 $build = DB_UPDATE_VERSION;
1551 if ($build != DB_UPDATE_VERSION) {
1552 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1559 * Sets the base url for use in cmdline programs which don't have
1560 * $_SERVER variables
1562 function check_url(App $a) {
1564 $url = get_config('system','url');
1566 // if the url isn't set or the stored url is radically different
1567 // than the currently visited url, store the current value accordingly.
1568 // "Radically different" ignores common variations such as http vs https
1569 // and www.example.com vs example.com.
1570 // We will only change the url to an ip address if there is no existing setting
1573 $url = set_config('system','url',App::get_baseurl());
1575 if ((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) {
1576 $url = set_config('system','url',App::get_baseurl());
1584 * @brief Automatic database updates
1586 function update_db(App $a) {
1587 $build = get_config('system','build');
1589 $build = set_config('system','build',DB_UPDATE_VERSION);
1592 if ($build != DB_UPDATE_VERSION) {
1593 $stored = intval($build);
1594 $current = intval(DB_UPDATE_VERSION);
1595 if ($stored < $current) {
1596 Config::load('database');
1598 // We're reporting a different version than what is currently installed.
1599 // Run any existing update scripts to bring the database up to current.
1601 // make sure that boot.php and update.php are the same release, we might be
1602 // updating right this very second and the correct version of the update.php
1603 // file may not be here yet. This can happen on a very busy site.
1605 if (DB_UPDATE_VERSION == UPDATE_VERSION) {
1606 // Compare the current structure with the defined structure
1608 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1613 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1615 // run old update routine (wich could modify the schema and
1616 // conflits with new routine)
1617 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1618 $r = run_update_function($x);
1623 if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
1624 $stored = NEW_UPDATE_ROUTINE_VERSION;
1627 // run new update routine
1628 // it update the structure in one call
1629 $retval = update_structure(false, true);
1637 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1640 // run any left update_nnnn functions in update.php
1641 for ($x = $stored; $x < $current; $x ++) {
1642 $r = run_update_function($x);
1654 function run_update_function($x) {
1655 if (function_exists('update_' . $x)) {
1657 // There could be a lot of processes running or about to run.
1658 // We want exactly one process to run the update command.
1659 // So store the fact that we're taking responsibility
1660 // after first checking to see if somebody else already has.
1662 // If the update fails or times-out completely you may need to
1663 // delete the config entry to try again.
1665 $t = get_config('database','update_' . $x);
1669 set_config('database','update_' . $x, time());
1671 // call the specific update
1673 $func = 'update_' . $x;
1677 //send the administrator an e-mail
1680 sprintf(t('Update %s failed. See error logs.'), $x)
1684 set_config('database','update_' . $x, 'success');
1685 set_config('system','build', $x + 1);
1689 set_config('database','update_' . $x, 'success');
1690 set_config('system','build', $x + 1);
1697 * @brief Synchronise plugins:
1699 * $a->config['system']['addon'] contains a comma-separated list of names
1700 * of plugins/addons which are used on this system.
1701 * Go through the database list of already installed addons, and if we have
1702 * an entry, but it isn't in the config list, call the uninstall procedure
1703 * and mark it uninstalled in the database (for now we'll remove it).
1704 * Then go through the config list and if we have a plugin that isn't installed,
1705 * call the install procedure and add it to the database.
1710 function check_plugins(App $a) {
1712 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1713 if (dbm::is_result($r)) {
1716 $installed = array();
1719 $plugins = get_config('system','addon');
1720 $plugins_arr = array();
1723 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1726 $a->plugins = $plugins_arr;
1728 $installed_arr = array();
1730 if (count($installed)) {
1731 foreach ($installed as $i) {
1732 if (! in_array($i['name'],$plugins_arr)) {
1733 uninstall_plugin($i['name']);
1735 $installed_arr[] = $i['name'];
1740 if (count($plugins_arr)) {
1741 foreach ($plugins_arr as $p) {
1742 if (! in_array($p,$installed_arr)) {
1754 function get_guid($size=16, $prefix = "") {
1756 if ($prefix == "") {
1758 $prefix = hash("crc32", $a->get_hostname());
1761 while (strlen($prefix) < ($size - 13)) {
1762 $prefix .= mt_rand();
1766 $prefix = substr($prefix, 0, $size - 22);
1767 return(str_replace(".", "", uniqid($prefix, true)));
1769 $prefix = substr($prefix, 0, max($size - 13, 0));
1770 return(uniqid($prefix));
1775 * @brief Wrapper for adding a login box.
1777 * @param bool $register
1778 * If $register == true provide a registration link.
1779 * This will most always depend on the value of $a->config['register_policy'].
1780 * @param bool $hiddens
1783 * Returns the complete html for inserting into the page
1785 * @hooks 'login_hook'
1788 function login($register = false, $hiddens=false) {
1794 'title' => t('Create a New Account'),
1795 'desc' => t('Register')
1799 $noid = get_config('system','no_openid');
1801 $dest_url = $a->query_string;
1804 $tpl = get_markup_template("logout.tpl");
1806 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1807 '$baseurl' => $a->get_baseurl(true)
1810 $tpl = get_markup_template("login.tpl");
1811 $_SESSION['return_url'] = $a->query_string;
1812 $a->module = 'login';
1815 $o .= replace_macros($tpl, array(
1817 '$dest_url' => $dest_url,
1818 '$logout' => t('Logout'),
1819 '$login' => t('Login'),
1821 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1822 '$lpassword' => array('password', t('Password: '), '', ''),
1823 '$lremember' => array('remember', t('Remember me'), 0, ''),
1825 '$openid' => !$noid,
1826 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1828 '$hiddens' => $hiddens,
1830 '$register' => $reg,
1832 '$lostpass' => t('Forgot your password?'),
1833 '$lostlink' => t('Password Reset'),
1835 '$tostitle' => t('Website Terms of Service'),
1836 '$toslink' => t('terms of service'),
1838 '$privacytitle' => t('Website Privacy Policy'),
1839 '$privacylink' => t('privacy policy'),
1843 call_hooks('login_hook',$o);
1849 * @brief Used to end the current process, after saving session state.
1853 if (!get_app()->is_backend()) {
1854 session_write_close();
1861 * @brief Redirect to another URL and terminate this process.
1863 function goaway($s) {
1864 if (!strstr(normalise_link($s), "http://")) {
1865 $s = App::get_baseurl()."/".$s;
1868 header("Location: $s");
1874 * @brief Returns the user id of locally logged in user or false.
1876 * @return int|bool user id or false
1878 function local_user() {
1879 if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
1880 return intval($_SESSION['uid']);
1886 * @brief Returns the public contact id of logged in user or false.
1888 * @return int|bool public contact id or false
1890 function public_contact() {
1891 static $public_contact_id = false;
1893 if (!$public_contact_id && x($_SESSION, 'authenticated')) {
1894 if (x($_SESSION, 'my_address')) {
1896 $public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
1897 } elseif (x($_SESSION, 'visitor_home')) {
1899 $public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
1901 } elseif (!x($_SESSION, 'authenticated')) {
1902 $public_contact_id = false;
1905 return $public_contact_id;
1909 * @brief Returns contact id of authenticated site visitor or false
1911 * @return int|bool visitor_id or false
1913 function remote_user() {
1914 if ((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) {
1915 return intval($_SESSION['visitor_id']);
1921 * @brief Show an error message to user.
1923 * This function save text in session, to be shown to the user at next page load
1925 * @param string $s - Text of notice
1927 function notice($s) {
1929 if (! x($_SESSION,'sysmsg')) {
1930 $_SESSION['sysmsg'] = array();
1932 if ($a->interactive) {
1933 $_SESSION['sysmsg'][] = $s;
1938 * @brief Show an info message to user.
1940 * This function save text in session, to be shown to the user at next page load
1942 * @param string $s - Text of notice
1947 if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) {
1951 if (! x($_SESSION,'sysmsg_info')) {
1952 $_SESSION['sysmsg_info'] = array();
1954 if ($a->interactive) {
1955 $_SESSION['sysmsg_info'][] = $s;
1961 * @brief Wrapper around config to limit the text length of an incoming message
1965 function get_max_import_size() {
1967 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1971 * @brief Wrap calls to proc_close(proc_open()) and call hook
1972 * so plugins can take part in process :)
1974 * @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
1976 * next args are passed as $cmd command line
1977 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1978 * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1980 * @note $cmd and string args are surrounded with ""
1985 function proc_run($cmd){
1989 $proc_args = func_get_args();
1992 if (!count($proc_args)) {
1996 // Preserve the first parameter
1997 // It could contain a command, the priority or an parameter array
1998 // If we use the parameter array we have to protect it from the following function
1999 $run_parameter = array_shift($proc_args);
2001 // expand any arrays
2002 foreach ($proc_args as $arg) {
2003 if (is_array($arg)) {
2004 foreach ($arg as $n) {
2012 // Now we add the run parameters back to the array
2013 array_unshift($args, $run_parameter);
2015 $arr = array('args' => $args, 'run_cmd' => true);
2017 call_hooks("proc_run", $arr);
2018 if (!$arr['run_cmd'] OR !count($args)) {
2022 $priority = PRIORITY_MEDIUM;
2023 $dont_fork = get_config("system", "worker_dont_fork");
2025 if (is_int($run_parameter)) {
2026 $priority = $run_parameter;
2027 } elseif (is_array($run_parameter)) {
2028 if (isset($run_parameter['priority'])) {
2029 $priority = $run_parameter['priority'];
2031 if (isset($run_parameter['dont_fork'])) {
2032 $dont_fork = $run_parameter['dont_fork'];
2039 $parameters = json_encode($argv);
2040 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
2041 dbesc($parameters));
2043 if (!dbm::is_result($found)) {
2044 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
2045 VALUES ('%s', '%s', %d)",
2047 dbesc(datetime_convert()),
2051 // Should we quit and wait for the poller to be called as a cronjob?
2056 // Checking number of workers
2057 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
2059 // Get number of allowed number of worker threads
2060 $queues = intval(get_config("system", "worker_queues"));
2066 // If there are already enough workers running, don't fork another one
2067 if ($workers[0]["workers"] >= $queues) {
2071 // Now call the poller to execute the jobs that we just added to the queue
2072 $args = array("include/poller.php", "no_cron");
2074 $a->proc_run($args);
2077 function current_theme(){
2078 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2084 // Find the theme that belongs to the user whose stuff we are looking at
2086 if ($a->profile_uid && ($a->profile_uid != local_user())) {
2087 $r = q("select theme from user where uid = %d limit 1",
2088 intval($a->profile_uid)
2090 if (dbm::is_result($r)) {
2091 $page_theme = $r[0]['theme'];
2095 // Allow folks to over-rule user themes and always use their own on their own site.
2096 // This works only if the user is on the same server
2098 if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2099 if (get_pconfig(local_user(),'system','always_my_theme')) {
2104 // $mobile_detect = new Mobile_Detect();
2105 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2106 $is_mobile = $a->is_mobile || $a->is_tablet;
2108 $standard_system_theme = Config::get('system', 'theme', '');
2109 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2112 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2113 $system_theme = $standard_system_theme;
2114 $theme_name = $standard_theme_name;
2116 $system_theme = Config::get('system', 'mobile-theme', '');
2117 if ($system_theme == '') {
2118 $system_theme = $standard_system_theme;
2120 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2122 if ($theme_name === '---') {
2123 // user has selected to have the mobile theme be the same as the normal one
2124 $system_theme = $standard_system_theme;
2125 $theme_name = $standard_theme_name;
2128 $theme_name = $page_theme;
2133 $system_theme = $standard_system_theme;
2134 $theme_name = $standard_theme_name;
2137 $theme_name = $page_theme;
2142 (file_exists('view/theme/' . $theme_name . '/style.css') ||
2143 file_exists('view/theme/' . $theme_name . '/style.php'))) {
2144 return($theme_name);
2147 foreach ($app_base_themes as $t) {
2148 if (file_exists('view/theme/' . $t . '/style.css') ||
2149 file_exists('view/theme/' . $t . '/style.php')) {
2154 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2155 if (count($fallback)) {
2156 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2159 /// @TODO No final return statement?
2163 * @brief Return full URL to theme which is currently in effect.
2165 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2169 function current_theme_url() {
2172 $t = current_theme();
2174 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2175 if (file_exists('view/theme/' . $t . '/style.php')) {
2176 return('view/theme/'.$t.'/style.pcss'.$opts);
2179 return('view/theme/'.$t.'/style.css');
2182 function feed_birthday($uid,$tz) {
2186 * Determine the next birthday, but only if the birthday is published
2187 * in the default profile. We _could_ also look for a private profile that the
2188 * recipient can see, but somebody could get mad at us if they start getting
2189 * public birthday greetings when they haven't made this info public.
2191 * Assuming we are able to publish this info, we are then going to convert
2192 * the start time from the owner's timezone to UTC.
2194 * This will potentially solve the problem found with some social networks
2195 * where birthdays are converted to the viewer's timezone and salutations from
2196 * elsewhere in the world show up on the wrong day. We will convert it to the
2197 * viewer's timezone also, but first we are going to convert it from the birthday
2198 * person's timezone to GMT - so the viewer may find the birthday starting at
2199 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2206 if (! strlen($tz)) {
2210 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2214 if (dbm::is_result($p)) {
2215 $tmp_dob = substr($p[0]['dob'],5);
2216 if (intval($tmp_dob)) {
2217 $y = datetime_convert($tz,$tz,'now','Y');
2218 $bd = $y . '-' . $tmp_dob . ' 00:00';
2219 $t_dob = strtotime($bd);
2220 $now = strtotime(datetime_convert($tz,$tz,'now'));
2221 if ($t_dob < $now) {
2222 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2224 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2232 * @brief Check if current user has admin role.
2234 * @return bool true if user is an admin
2236 function is_site_admin() {
2239 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2241 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2242 if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) {
2249 * @brief Returns querystring as string from a mapped array.
2251 * @param array $params mapped array with query parameters
2252 * @param string $name of parameter, default null
2256 function build_querystring($params, $name = null) {
2258 foreach ($params as $key => $val) {
2259 if (is_array($val)) {
2260 /// @TODO maybe not compare against null, use is_null()
2261 if ($name == null) {
2262 $ret .= build_querystring($val, $key);
2264 $ret .= build_querystring($val, $name."[$key]");
2267 $val = urlencode($val);
2268 /// @TODO maybe not compare against null, use is_null()
2269 if ($name != null) {
2270 /// @TODO two string concated, can be merged to one
2271 $ret .= $name . "[$key]" . "=$val&";
2273 $ret .= "$key=$val&";
2280 function explode_querystring($query) {
2281 $arg_st = strpos($query, '?');
2282 if ($arg_st !== false) {
2283 $base = substr($query, 0, $arg_st);
2290 $args = explode('&', substr($query, $arg_st));
2291 foreach ($args as $k => $arg) {
2292 /// @TODO really compare type-safe here?
2297 $args = array_values($args);
2302 $args = array_values($args);
2312 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2314 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2316 function curPageURL() {
2318 if ($_SERVER["HTTPS"] == "on") {
2324 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2325 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2327 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2332 function random_digits($digits) {
2334 for ($i = 0; $i < $digits; $i++) {
2335 /// @TODO rand() is different to mt_rand() and maybe lesser "random"
2341 function get_server() {
2342 $server = get_config("system", "directory");
2344 if ($server == "") {
2345 $server = "http://dir.friendi.ca";
2351 function get_cachefile($file, $writemode = true) {
2352 $cache = get_itemcachepath();
2354 if ((! $cache) || (! is_dir($cache))) {
2358 $subfolder = $cache . "/" . substr($file, 0, 2);
2360 $cachepath = $subfolder . "/" . $file;
2363 if (!is_dir($subfolder)) {
2365 chmod($subfolder, 0777);
2369 /// @TODO no need to put braces here
2373 function clear_cache($basepath = "", $path = "") {
2375 $basepath = get_itemcachepath();
2379 if (($path == "") OR (!is_dir($path))) {
2383 if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
2387 $cachetime = (int)get_config('system','itemcache_duration');
2388 if ($cachetime == 0) {
2392 if (is_writable($path)){
2393 if ($dh = opendir($path)) {
2394 while (($file = readdir($dh)) !== false) {
2395 $fullpath = $path."/".$file;
2396 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != "..")) {
2397 clear_cache($basepath, $fullpath);
2399 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime))) {
2408 function get_itemcachepath() {
2409 // Checking, if the cache is deactivated
2410 $cachetime = (int)get_config('system','itemcache_duration');
2411 if ($cachetime < 0) {
2415 $itemcache = get_config('system','itemcache');
2416 if (($itemcache != "") AND App::directory_usable($itemcache)) {
2420 $temppath = get_temppath();
2422 if ($temppath != "") {
2423 $itemcache = $temppath."/itemcache";
2424 if (!file_exists($itemcache) && !is_dir($itemcache)) {
2428 if (App::directory_usable($itemcache)) {
2429 set_config("system", "itemcache", $itemcache);
2437 * @brief Returns the path where spool files are stored
2439 * @return string Spool path
2441 function get_spoolpath() {
2442 $spoolpath = get_config('system','spoolpath');
2443 if (($spoolpath != "") AND App::directory_usable($spoolpath)) {
2444 // We have a spool path and it is usable
2448 // We don't have a working preconfigured spool path, so we take the temp path.
2449 $temppath = get_temppath();
2451 if ($temppath != "") {
2452 // To avoid any interferences with other systems we create our own directory
2453 $spoolpath = $temppath."/spool";
2454 if (!is_dir($spoolpath)) {
2458 if (App::directory_usable($spoolpath)) {
2459 // The new path is usable, we are happy
2460 set_config("system", "spoolpath", $spoolpath);
2463 // We can't create a subdirectory, strange.
2464 // But the directory seems to work, so we use it but don't store it.
2469 // Reaching this point means that the operating system is configured badly.
2473 function get_temppath() {
2476 $temppath = get_config("system", "temppath");
2478 if (($temppath != "") AND App::directory_usable($temppath)) {
2479 // We have a temp path and it is usable
2483 // We don't have a working preconfigured temp path, so we take the system path.
2484 $temppath = sys_get_temp_dir();
2486 // Check if it is usable
2487 if (($temppath != "") AND App::directory_usable($temppath)) {
2488 // To avoid any interferences with other systems we create our own directory
2489 $new_temppath .= "/".$a->get_hostname();
2490 if (!is_dir($new_temppath)) {
2491 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
2492 mkdir($new_temppath);
2495 if (App::directory_usable($new_temppath)) {
2496 // The new path is usable, we are happy
2497 set_config("system", "temppath", $new_temppath);
2498 return $new_temppath;
2500 // We can't create a subdirectory, strange.
2501 // But the directory seems to work, so we use it but don't store it.
2506 // Reaching this point means that the operating system is configured badly.
2511 function set_template_engine(App $a, $engine = 'internal') {
2512 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2513 /// to avoid breaking themes again unnecessarily
2514 /// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
2516 $a->set_template_engine($engine);
2519 if (!function_exists('exif_imagetype')) {
2520 function exif_imagetype($file) {
2521 $size = getimagesize($file);
2526 function validate_include(&$file) {
2529 $file = realpath($file);
2531 if (strpos($file, getcwd()) !== 0) {
2535 $file = str_replace(getcwd()."/", "", $file, $count);
2540 if ($orig_file !== $file) {
2545 if (strpos($file, "include/") === 0) {
2549 if (strpos($file, "addon/") === 0) {
2553 // Simply return flag
2557 function current_load() {
2558 if (!function_exists('sys_getloadavg')) {
2562 $load_arr = sys_getloadavg();
2564 if (!is_array($load_arr)) {
2568 return max($load_arr[0], $load_arr[1]);
2572 * @brief get c-style args
2577 return get_app()->argc;
2581 * @brief Returns the value of a argv key
2583 * @param int $x argv key
2584 * @return string Value of the argv key
2587 if (array_key_exists($x,get_app()->argv)) {
2588 return get_app()->argv[$x];
2595 * @brief Get the data which is needed for infinite scroll
2597 * For invinite scroll we need the page number of the actual page
2598 * and the the URI where the content of the next page comes from.
2599 * This data is needed for the js part in main.js.
2600 * Note: infinite scroll does only work for the network page (module)
2602 * @param string $module The name of the module (e.g. "network")
2603 * @return array Of infinite scroll data
2604 * 'pageno' => $pageno The number of the actual page
2605 * 'reload_uri' => $reload_uri The URI of the content we have to load
2607 function infinite_scroll_data($module) {
2609 if (get_pconfig(local_user(),'system','infinite_scroll')
2610 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2612 // get the page number
2613 if (is_string($_GET["page"])) {
2614 $pageno = $_GET["page"];
2621 // try to get the uri from which we load the content
2622 foreach ($_GET AS $param => $value) {
2623 if (($param != "page") AND ($param != "q")) {
2624 $reload_uri .= "&" . $param . "=" . urlencode($value);
2628 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset=")) {
2629 $reload_uri .= "&offset=" . urlencode($a->page_offset);
2632 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);