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('include/pidfile.php');
36 require_once('update.php');
37 require_once('include/dbstructure.php');
39 define ( 'FRIENDICA_PLATFORM', 'Friendica');
40 define ( 'FRIENDICA_CODENAME', 'Asparagus');
41 define ( 'FRIENDICA_VERSION', '3.5.1-dev' );
42 define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
43 define ( 'DB_UPDATE_VERSION', 1213 );
46 * @brief Constant with a HTML line break.
48 * Contains a HTML line break (br) element and a real carriage return with line
49 * feed for the source.
50 * This can be used in HTML and JavaScript where needed a line break.
52 define ( 'EOL', "<br />\r\n" );
53 define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
57 * @brief Image storage quality.
59 * Lower numbers save space at cost of image detail.
60 * For ease of upgrade, please do not change here. Change jpeg quality with
61 * $a->config['system']['jpeg_quality'] = n;
62 * in .htconfig.php, where n is netween 1 and 100, and with very poor results
67 define ( 'JPEG_QUALITY', 100 );
69 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
71 define ( 'PNG_QUALITY', 8 );
75 * An alternate way of limiting picture upload sizes. Specify the maximum pixel
76 * length that pictures are allowed to be (for non-square pictures, it will apply
77 * to the longest side). Pictures longer than this length will be resized to be
78 * this length (on the longest side, the other side will be scaled appropriately).
79 * Modify this value using
81 * $a->config['system']['max_image_length'] = n;
85 * If you don't want to set a maximum length, set to -1. The default value is
86 * defined by 'MAX_IMAGE_LENGTH' below.
89 define ( 'MAX_IMAGE_LENGTH', -1 );
96 define ( 'DEFAULT_DB_ENGINE', 'MyISAM' );
101 * SSL redirection policies
104 define ( 'SSL_POLICY_NONE', 0 );
105 define ( 'SSL_POLICY_FULL', 1 );
106 define ( 'SSL_POLICY_SELFSIGN', 2 );
115 define ( 'LOGGER_NORMAL', 0 );
116 define ( 'LOGGER_TRACE', 1 );
117 define ( 'LOGGER_DEBUG', 2 );
118 define ( 'LOGGER_DATA', 3 );
119 define ( 'LOGGER_ALL', 4 );
128 define ( 'CACHE_MONTH', 0 );
129 define ( 'CACHE_WEEK', 1 );
130 define ( 'CACHE_DAY', 2 );
131 define ( 'CACHE_HOUR', 3 );
132 define ( 'CACHE_HALF_HOUR', 4 );
133 define ( 'CACHE_QUARTER_HOUR', 5 );
134 define ( 'CACHE_FIVE_MINUTES', 6 );
135 define ( 'CACHE_MINUTE', 7 );
141 * Registration policies
144 define ( 'REGISTER_CLOSED', 0 );
145 define ( 'REGISTER_APPROVE', 1 );
146 define ( 'REGISTER_OPEN', 2 );
155 define ( 'CONTACT_IS_FOLLOWER', 1);
156 define ( 'CONTACT_IS_SHARING', 2);
157 define ( 'CONTACT_IS_FRIEND', 3);
163 * DB update return values
166 define ( 'UPDATE_SUCCESS', 0);
167 define ( 'UPDATE_FAILED', 1);
172 * @name page/profile types
174 * PAGE_NORMAL is a typical personal profile account
175 * PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
176 * PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
177 * write access to wall and comments (no email and not included in page owner's ACL lists)
178 * PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
182 define ( 'PAGE_NORMAL', 0 );
183 define ( 'PAGE_SOAPBOX', 1 );
184 define ( 'PAGE_COMMUNITY', 2 );
185 define ( 'PAGE_FREELOVE', 3 );
186 define ( 'PAGE_BLOG', 4 );
187 define ( 'PAGE_PRVGROUP', 5 );
191 * @name account types
193 * ACCOUNT_TYPE_PERSON - the account belongs to a person
194 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
196 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
197 * Associated page type: PAGE_SOAPBOX
199 * ACCOUNT_TYPE_NEWS - the account is a news reflector
200 * Associated page type: PAGE_SOAPBOX
202 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
203 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
206 define ( 'ACCOUNT_TYPE_PERSON', 0 );
207 define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
208 define ( 'ACCOUNT_TYPE_NEWS', 2 );
209 define ( 'ACCOUNT_TYPE_COMMUNITY', 3 );
215 * Type of the community page
218 define ( 'CP_NO_COMMUNITY_PAGE', -1 );
219 define ( 'CP_USERS_ON_SERVER', 0 );
220 define ( 'CP_GLOBAL_COMMUNITY', 1 );
226 * Network and protocol family types
229 define ( 'NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
230 define ( 'NETWORK_ZOT', 'zot!'); // Zot!
231 define ( 'NETWORK_OSTATUS', 'stat'); // status.net, identi.ca, GNU-social, other OStatus implementations
232 define ( 'NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
233 define ( 'NETWORK_DIASPORA', 'dspr'); // Diaspora
234 define ( 'NETWORK_MAIL', 'mail'); // IMAP/POP
235 define ( 'NETWORK_MAIL2', 'mai2'); // extended IMAP/POP
236 define ( 'NETWORK_FACEBOOK', 'face'); // Facebook API
237 define ( 'NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
238 define ( 'NETWORK_XMPP', 'xmpp'); // XMPP
239 define ( 'NETWORK_MYSPACE', 'mysp'); // MySpace
240 define ( 'NETWORK_GPLUS', 'goog'); // Google+
241 define ( 'NETWORK_PUMPIO', 'pump'); // pump.io
242 define ( 'NETWORK_TWITTER', 'twit'); // Twitter
243 define ( 'NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
244 define ( 'NETWORK_STATUSNET', 'stac'); // Statusnet connector
245 define ( 'NETWORK_APPNET', 'apdn'); // app.net
246 define ( 'NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol
247 define ( 'NETWORK_ICALENDAR', 'ical'); // iCalendar
248 define ( 'NETWORK_PNUT', 'pnut'); // pnut.io
249 define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
253 * These numbers are used in stored permissions
254 * and existing allocations MUST NEVER BE CHANGED
255 * OR RE-ASSIGNED! You may only add to them.
258 $netgroup_ids = array(
259 NETWORK_DFRN => (-1),
261 NETWORK_OSTATUS => (-3),
262 NETWORK_FEED => (-4),
263 NETWORK_DIASPORA => (-5),
264 NETWORK_MAIL => (-6),
265 NETWORK_MAIL2 => (-7),
266 NETWORK_FACEBOOK => (-8),
267 NETWORK_LINKEDIN => (-9),
268 NETWORK_XMPP => (-10),
269 NETWORK_MYSPACE => (-11),
270 NETWORK_GPLUS => (-12),
271 NETWORK_PUMPIO => (-13),
272 NETWORK_TWITTER => (-14),
273 NETWORK_DIASPORA2 => (-15),
274 NETWORK_STATUSNET => (-16),
275 NETWORK_APPNET => (-17),
276 NETWORK_NEWS => (-18),
277 NETWORK_ICALENDAR => (-19),
278 NETWORK_PNUT => (-20),
280 NETWORK_PHANTOM => (-127),
285 * Maximum number of "people who like (or don't like) this" that we will list by name
288 define ( 'MAX_LIKERS', 75);
291 * Communication timeout
294 define ( 'ZCURL_TIMEOUT' , (-1));
300 * Email notification options
303 define ( 'NOTIFY_INTRO', 0x0001 );
304 define ( 'NOTIFY_CONFIRM', 0x0002 );
305 define ( 'NOTIFY_WALL', 0x0004 );
306 define ( 'NOTIFY_COMMENT', 0x0008 );
307 define ( 'NOTIFY_MAIL', 0x0010 );
308 define ( 'NOTIFY_SUGGEST', 0x0020 );
309 define ( 'NOTIFY_PROFILE', 0x0040 );
310 define ( 'NOTIFY_TAGSELF', 0x0080 );
311 define ( 'NOTIFY_TAGSHARE', 0x0100 );
312 define ( 'NOTIFY_POKE', 0x0200 );
313 define ( 'NOTIFY_SHARE', 0x0400 );
315 define ( 'NOTIFY_SYSTEM', 0x8000 );
325 define ( 'TERM_UNKNOWN', 0 );
326 define ( 'TERM_HASHTAG', 1 );
327 define ( 'TERM_MENTION', 2 );
328 define ( 'TERM_CATEGORY', 3 );
329 define ( 'TERM_PCATEGORY', 4 );
330 define ( 'TERM_FILE', 5 );
331 define ( 'TERM_SAVEDSEARCH', 6 );
332 define ( 'TERM_CONVERSATION', 7 );
334 define ( 'TERM_OBJ_POST', 1 );
335 define ( 'TERM_OBJ_PHOTO', 2 );
342 * Various namespaces we may need to parse
345 define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
346 define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
347 define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
348 define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
349 define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
350 define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
351 define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
352 define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
353 define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
354 define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
355 define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
356 define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
357 define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
358 define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
359 define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
365 * Activity stream defines
368 define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
369 define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
370 define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
371 define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
372 define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
374 define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
376 define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
377 define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
378 define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
379 define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
380 define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
381 define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
383 define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
384 define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
385 define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
386 define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
387 define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
389 define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
390 define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
392 define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
393 define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
394 define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
395 define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
396 define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
397 define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
398 define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
399 define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
400 define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
401 define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
402 define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
403 define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
404 define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
405 define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
411 * Item weight for query ordering
414 define ( 'GRAVITY_PARENT', 0);
415 define ( 'GRAVITY_LIKE', 3);
416 define ( 'GRAVITY_COMMENT', 6);
422 * Process priority for the worker
425 define('PRIORITY_UNDEFINED', 0);
426 define('PRIORITY_CRITICAL', 10);
427 define('PRIORITY_HIGH', 20);
428 define('PRIORITY_MEDIUM', 30);
429 define('PRIORITY_LOW', 40);
430 define('PRIORITY_NEGLIGIBLE',50);
434 // Normally this constant is defined - but not if "pcntl" isn't installed
435 if (!defined("SIGTERM"))
436 define("SIGTERM", 15);
440 * Reverse the effect of magic_quotes_gpc if it is enabled.
441 * Please disable magic_quotes_gpc so we don't have to do this.
442 * See http://php.net/manual/en/security.magicquotes.disabling.php
448 error_reporting(E_ERROR | E_WARNING | E_PARSE);
452 // This has to be quite large to deal with embedded private photos
453 ini_set('pcre.backtrack_limit', 500000);
456 if (get_magic_quotes_gpc()) {
457 $process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
458 while (list($key, $val) = each($process)) {
459 foreach ($val as $k => $v) {
460 unset($process[$key][$k]);
462 $process[$key][stripslashes($k)] = $v;
463 $process[] = &$process[$key][stripslashes($k)];
465 $process[$key][stripslashes($k)] = stripslashes($v);
478 * @brief Our main application structure for the life of this page.
480 * Primarily deals with the URL that got us here
481 * and tries to make some sense of it, and
482 * stores our page contents and config storage
483 * and anything else that might need to be passed around
484 * before we spit the page out.
489 public $module_loaded = false;
490 public $query_string;
499 public $page_contact;
501 public $data = array();
502 public $error = false;
512 public $interactive = true;
514 public $apps = array();
516 public $is_mobile = false;
517 public $is_tablet = false;
518 public $is_friendica_app;
519 public $performance = array();
520 public $callstack = array();
521 public $theme_info = array();
522 public $backend = true;
529 // Allow themes to control internal parameters
530 // by changing App values in theme.php
532 public $sourcename = '';
533 public $videowidth = 425;
534 public $videoheight = 350;
535 public $force_max_items = 0;
536 public $theme_thread_allow = true;
537 public $theme_events_in_profile = true;
540 * @brief An array for all theme-controllable parameters
542 * Mostly unimplemented yet. Only options 'template_engine' and
545 public $theme = array(
548 'videoheight' => 350,
549 'force_max_items' => 0,
550 'thread_allow' => true,
552 'template_engine' => 'smarty3',
556 * @brief An array of registered template engines ('name'=>'class name')
558 public $template_engines = array();
560 * @brief An array of instanced template engines ('name'=>'instance')
562 public $template_engine_instance = array();
566 private $ldelim = array(
570 private $rdelim = array(
580 private $curl_content_type;
581 private $curl_headers;
583 private $cached_profile_image;
584 private $cached_profile_picdate;
589 * @brief App constructor.
591 function __construct() {
593 global $default_timezone;
597 if (file_exists(".htpreconfig.php"))
598 @include(".htpreconfig.php");
600 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
602 date_default_timezone_set($this->timezone);
604 $this->performance["start"] = microtime(true);
605 $this->performance["database"] = 0;
606 $this->performance["database_write"] = 0;
607 $this->performance["network"] = 0;
608 $this->performance["file"] = 0;
609 $this->performance["rendering"] = 0;
610 $this->performance["parser"] = 0;
611 $this->performance["marktime"] = 0;
612 $this->performance["markstart"] = microtime(true);
614 $this->callstack["database"] = array();
615 $this->callstack["database_write"] = array();
616 $this->callstack["network"] = array();
617 $this->callstack["file"] = array();
618 $this->callstack["rendering"] = array();
619 $this->callstack["parser"] = array();
621 $this->config = array();
622 $this->page = array();
623 $this->pager= array();
625 $this->query_string = '';
627 $this->process_id = uniqid("log", true);
632 'include' . PATH_SEPARATOR
633 . 'library' . PATH_SEPARATOR
634 . 'library/phpsec' . PATH_SEPARATOR
635 . 'library/langdet' . PATH_SEPARATOR
639 $this->scheme = 'http';
640 if((x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) ||
641 (x($_SERVER['HTTP_FORWARDED']) && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
642 (x($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
643 (x($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
644 (x($_SERVER['FRONT_END_HTTPS']) && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
645 (x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
647 $this->scheme = 'https';
650 if(x($_SERVER,'SERVER_NAME')) {
651 $this->hostname = $_SERVER['SERVER_NAME'];
653 if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
654 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
656 * Figure out if we are running at the top of a domain
657 * or in a sub-directory and adjust accordingly
660 $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
661 if(isset($path) && strlen($path) && ($path != $this->path))
666 $this->hostname = $hostname;
668 if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) {
669 $this->set_baseurl(array_pop($_SERVER["argv"]) );
673 #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());
675 if ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") {
676 $this->query_string = substr($_SERVER['QUERY_STRING'],9);
677 // removing trailing / - maybe a nginx problem
678 if (substr($this->query_string, 0, 1) == "/")
679 $this->query_string = substr($this->query_string, 1);
680 } elseif ((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") {
681 $this->query_string = substr($_SERVER['QUERY_STRING'],2);
682 // removing trailing / - maybe a nginx problem
683 if (substr($this->query_string, 0, 1) == "/")
684 $this->query_string = substr($this->query_string, 1);
687 if (x($_GET,'pagename')) {
688 $this->cmd = trim($_GET['pagename'],'/\\');
689 } elseif (x($_GET,'q')) {
690 $this->cmd = trim($_GET['q'],'/\\');
695 $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string);
698 // unix style "homedir"
700 if (substr($this->cmd,0,1) === '~') {
701 $this->cmd = 'profile/' . substr($this->cmd,1);
704 // Diaspora style profile url
706 if (substr($this->cmd,0,2) === 'u/') {
707 $this->cmd = 'profile/' . substr($this->cmd,2);
713 * Break the URL path into C style argc/argv style arguments for our
714 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
715 * will be 3 (integer) and $this->argv will contain:
721 * There will always be one argument. If provided a naked domain
722 * URL, $this->argv[0] is set to "home".
726 $this->argv = explode('/',$this->cmd);
727 $this->argc = count($this->argv);
728 if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
729 $this->module = str_replace(".", "_", $this->argv[0]);
730 $this->module = str_replace("-", "_", $this->module);
734 $this->argv = array('home');
735 $this->module = 'home';
739 * See if there is any page number information, and initialise
743 $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
744 $this->pager['itemspage'] = 50;
745 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
746 if($this->pager['start'] < 0)
747 $this->pager['start'] = 0;
748 $this->pager['total'] = 0;
751 * Detect mobile devices
754 $mobile_detect = new Mobile_Detect();
755 $this->is_mobile = $mobile_detect->isMobile();
756 $this->is_tablet = $mobile_detect->isTablet();
759 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
762 * register template engines
764 $dc = get_declared_classes();
765 foreach ($dc as $k) {
766 if (in_array("ITemplateEngine", class_implements($k))){
767 $this->register_template_engine($k);
775 public static function get_basepath() {
777 $basepath = get_config("system", "basepath");
780 $basepath = dirname(__FILE__);
783 $basepath = $_SERVER["DOCUMENT_ROOT"];
786 $basepath = $_SERVER["PWD"];
791 function get_scheme() {
792 return($this->scheme);
796 * @brief Retrieves the Friendica instance base URL
798 * This function assembles the base URL from multiple parts:
799 * - Protocol is determined either by the request or a combination of
800 * system.ssl_policy and the $ssl parameter.
801 * - Host name is determined either by system.hostname or inferred from request
802 * - Path is inferred from SCRIPT_NAME
804 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
806 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
807 * @return string Friendica server base URL
809 function get_baseurl($ssl = false) {
811 // Is the function called statically?
812 if (!(isset($this) && get_class($this) == __CLASS__)) {
813 return self::$a->get_baseurl($ssl);
816 $scheme = $this->scheme;
818 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
822 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
823 // (and also the login link). Anything seen by an outsider will have it turned off.
825 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
833 if (Config::get('config', 'hostname') != '') {
834 $this->hostname = Config::get('config', 'hostname');
837 return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
841 * @brief Initializes the baseurl components
843 * Clears the baseurl cache to prevent inconstistencies
847 function set_baseurl($url) {
848 $parsed = @parse_url($url);
851 $this->scheme = $parsed['scheme'];
853 $hostname = $parsed['host'];
854 if (x($parsed, 'port')) {
855 $hostname .= ':' . $parsed['port'];
857 if (x($parsed, 'path')) {
858 $this->path = trim($parsed['path'], '\\/');
861 if (file_exists(".htpreconfig.php")) {
862 @include(".htpreconfig.php");
865 if (get_config('config', 'hostname') != '') {
866 $this->hostname = get_config('config', 'hostname');
869 if (!isset($this->hostname) OR ($this->hostname == '')) {
870 $this->hostname = $hostname;
875 function get_hostname() {
876 if (get_config('config','hostname') != "")
877 $this->hostname = get_config('config','hostname');
879 return $this->hostname;
882 function set_hostname($h) {
883 $this->hostname = $h;
886 function set_path($p) {
887 $this->path = trim(trim($p),'/');
890 function get_path() {
894 function set_pager_total($n) {
895 $this->pager['total'] = intval($n);
898 function set_pager_itemspage($n) {
899 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
900 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
903 function set_pager_page($n) {
904 $this->pager['page'] = $n;
905 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
908 function init_pagehead() {
909 $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
911 // If the update is "deactivated" set it to the highest integer number (~24 days)
913 $interval = 2147483647;
915 if($interval < 10000)
918 // compose the page title from the sitename and the
919 // current module called
920 if (!$this->module=='')
922 $this->page['title'] = $this->config['sitename'].' ('.$this->module.')';
924 $this->page['title'] = $this->config['sitename'];
927 /* put the head template at the beginning of page['htmlhead']
928 * since the code added by the modules frequently depends on it
931 if(!isset($this->page['htmlhead']))
932 $this->page['htmlhead'] = '';
934 // If we're using Smarty, then doing replace_macros() will replace
935 // any unrecognized variables with a blank string. Since we delay
936 // replacing $stylesheet until later, we need to replace it now
937 // with another variable name
938 if($this->theme['template_engine'] === 'smarty3')
939 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
941 $stylesheet = '$stylesheet';
943 $shortcut_icon = get_config("system", "shortcut_icon");
944 if ($shortcut_icon == "")
945 $shortcut_icon = "images/friendica-32.png";
947 $touch_icon = get_config("system", "touch_icon");
948 if ($touch_icon == "")
949 $touch_icon = "images/friendica-128.png";
951 // get data wich is needed for infinite scroll on the network page
952 $invinite_scroll = infinite_scroll_data($this->module);
954 $tpl = get_markup_template('head.tpl');
955 $this->page['htmlhead'] = replace_macros($tpl,array(
956 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
957 '$local_user' => local_user(),
958 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
959 '$delitem' => t('Delete this item?'),
960 '$showmore' => t('show more'),
961 '$showfewer' => t('show fewer'),
962 '$update_interval' => $interval,
963 '$shortcut_icon' => $shortcut_icon,
964 '$touch_icon' => $touch_icon,
965 '$stylesheet' => $stylesheet,
966 '$infinite_scroll' => $invinite_scroll,
967 )) . $this->page['htmlhead'];
970 function init_page_end() {
971 if(!isset($this->page['end']))
972 $this->page['end'] = '';
973 $tpl = get_markup_template('end.tpl');
974 $this->page['end'] = replace_macros($tpl,array(
975 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
976 )) . $this->page['end'];
979 function set_curl_code($code) {
980 $this->curl_code = $code;
983 function get_curl_code() {
984 return $this->curl_code;
987 function set_curl_content_type($content_type) {
988 $this->curl_content_type = $content_type;
991 function get_curl_content_type() {
992 return $this->curl_content_type;
995 function set_curl_headers($headers) {
996 $this->curl_headers = $headers;
999 function get_curl_headers() {
1000 return $this->curl_headers;
1003 function get_cached_avatar_image($avatar_image){
1004 return $avatar_image;
1006 // The following code is deactivated. It doesn't seem to make any sense and it slows down the system.
1008 if($this->cached_profile_image[$avatar_image])
1009 return $this->cached_profile_image[$avatar_image];
1011 $path_parts = explode("/",$avatar_image);
1012 $common_filename = $path_parts[count($path_parts)-1];
1014 if($this->cached_profile_picdate[$common_filename]){
1015 $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename];
1017 $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'",
1019 if (! dbm::is_result($r)) {
1020 $this->cached_profile_image[$avatar_image] = $avatar_image;
1022 $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']);
1023 $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename];
1026 return $this->cached_profile_image[$avatar_image];
1032 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
1034 * @param string $orig_url
1036 * @return string The cleaned url
1038 function remove_baseurl($orig_url){
1040 // Is the function called statically?
1041 if (!(isset($this) && get_class($this) == __CLASS__)) {
1042 return(self::$a->remove_baseurl($orig_url));
1045 // Remove the hostname from the url if it is an internal link
1046 $nurl = normalise_link($orig_url);
1047 $base = normalise_link($this->get_baseurl());
1048 $url = str_replace($base."/", "", $nurl);
1050 // if it is an external link return the orignal value
1051 if ($url == normalise_link($orig_url)) {
1059 * @brief Register template engine class
1061 * If $name is "", is used class static property $class::$name
1063 * @param string $class
1064 * @param string $name
1066 function register_template_engine($class, $name = '') {
1068 $v = get_class_vars( $class );
1069 if(x($v,"name")) $name = $v['name'];
1072 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
1075 $this->template_engines[$name] = $class;
1079 * @brief Return template engine instance.
1081 * If $name is not defined, return engine defined by theme,
1084 * @param strin $name Template engine name
1085 * @return object Template Engine instance
1087 function template_engine($name = ''){
1089 $template_engine = $name;
1091 $template_engine = 'smarty3';
1092 if (x($this->theme, 'template_engine')) {
1093 $template_engine = $this->theme['template_engine'];
1097 if (isset($this->template_engines[$template_engine])){
1098 if(isset($this->template_engine_instance[$template_engine])){
1099 return $this->template_engine_instance[$template_engine];
1101 $class = $this->template_engines[$template_engine];
1103 $this->template_engine_instance[$template_engine] = $obj;
1108 echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
1112 * @brief Returns the active template engine.
1116 function get_template_engine() {
1117 return $this->theme['template_engine'];
1120 function set_template_engine($engine = 'smarty3') {
1121 $this->theme['template_engine'] = $engine;
1123 $this->theme['template_engine'] = 'smarty3';
1127 if(is_writable('view/smarty3/'))
1128 $this->theme['template_engine'] = 'smarty3';
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'])
1148 $duration = (float)(microtime(true)-$stamp);
1150 if (!isset($this->performance[$value])) {
1151 // Prevent ugly E_NOTICE
1152 $this->performance[$value] = 0;
1155 $this->performance[$value] += (float)$duration;
1156 $this->performance["marktime"] += (float)$duration;
1158 $callstack = $this->callstack();
1160 if (!isset($this->callstack[$value][$callstack])) {
1161 // Prevent ugly E_NOTICE
1162 $this->callstack[$value][$callstack] = 0;
1165 $this->callstack[$value][$callstack] += (float)$duration;
1170 * @brief Log active processes into the "process" table
1172 function start_process() {
1173 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
1175 $command = basename($trace[0]["file"]);
1177 $this->remove_inactive_processes();
1179 q("START TRANSACTION");
1181 $r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
1182 if (!dbm::is_result($r)) {
1183 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
1186 dbesc(datetime_convert()));
1192 * @brief Remove inactive processes
1194 function remove_inactive_processes() {
1195 q("START TRANSACTION");
1197 $r = q("SELECT `pid` FROM `process`");
1198 if (dbm::is_result($r)) {
1199 foreach ($r AS $process) {
1200 if (!posix_kill($process["pid"], 0)) {
1201 q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
1209 * @brief Remove the active process from the "process" table
1211 function end_process() {
1212 q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
1216 * @brief Returns a string with a callstack. Can be used for logging.
1220 function callstack() {
1221 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
1223 // We remove the first two items from the list since they contain data that we don't need.
1224 array_shift($trace);
1225 array_shift($trace);
1227 $callstack = array();
1228 foreach ($trace AS $func)
1229 $callstack[] = $func["function"];
1231 return implode(", ", $callstack);
1234 function get_useragent() {
1235 return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl());
1238 function is_friendica_app() {
1239 return($this->is_friendica_app);
1243 * @brief Checks if the site is called via a backend process
1245 * This isn't a perfect solution. But we need this check very early.
1246 * So we cannot wait until the modules are loaded.
1248 * @return bool Is it a known backend?
1250 function is_backend() {
1252 $backend[] = "_well_known";
1254 $backend[] = "dfrn_notify";
1255 $backend[] = "fetch";
1256 $backend[] = "hcard";
1257 $backend[] = "hostxrd";
1258 $backend[] = "nodeinfo";
1259 $backend[] = "noscrape";
1261 $backend[] = "poco";
1262 $backend[] = "post";
1263 $backend[] = "proxy";
1264 $backend[] = "pubsub";
1265 $backend[] = "pubsubhubbub";
1266 $backend[] = "receive";
1267 $backend[] = "rsd_xml";
1268 $backend[] = "salmon";
1269 $backend[] = "statistics_json";
1272 if (in_array($this->module, $backend))
1275 return($this->backend);
1279 * @brief Checks if the maximum number of database processes is reached
1281 * @return bool Is the limit reached?
1283 function max_processes_reached() {
1285 if ($this->is_backend()) {
1286 $process = "backend";
1287 $max_processes = get_config('system', 'max_processes_backend');
1288 if (intval($max_processes) == 0)
1291 $process = "frontend";
1292 $max_processes = get_config('system', 'max_processes_frontend');
1293 if (intval($max_processes) == 0)
1294 $max_processes = 20;
1297 $processlist = dbm::processlist();
1298 if ($processlist["list"] != "") {
1299 logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
1301 if ($processlist["amount"] > $max_processes) {
1302 logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
1310 * @brief Checks if the maximum load is reached
1312 * @return bool Is the load reached?
1314 function maxload_reached() {
1316 if ($this->is_backend()) {
1317 $process = "backend";
1318 $maxsysload = intval(get_config('system', 'maxloadavg'));
1319 if ($maxsysload < 1)
1322 $process = "frontend";
1323 $maxsysload = intval(get_config('system','maxloadavg_frontend'));
1324 if ($maxsysload < 1)
1328 $load = current_load();
1330 if (intval($load) > $maxsysload) {
1331 logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
1339 * @brief Checks if the process is already running
1341 * @param string $taskname The name of the task that will be used for the name of the lockfile
1342 * @param string $task The path and name of the php script
1343 * @param int $timeout The timeout after which a task should be killed
1345 * @return bool Is the process running?
1347 function is_already_running($taskname, $task = "", $timeout = 540) {
1349 $lockpath = get_lockpath();
1350 if ($lockpath != '') {
1351 $pidfile = new pidfile($lockpath, $taskname);
1352 if ($pidfile->is_already_running()) {
1353 logger("Already running");
1354 if ($pidfile->running_time() > $timeout) {
1356 logger("killed stale process");
1357 // Calling a new instance
1359 proc_run(PRIORITY_MEDIUM, $task);
1367 function proc_run($args) {
1369 if (!function_exists("proc_open")) {
1373 // Add the php path if it is a php call
1374 if (count($args) && ($args[0] === 'php' OR !is_string($args[0]))) {
1376 // If the last worker fork was less than 10 seconds before then don't fork another one.
1377 // This should prevent the forking of masses of workers.
1378 if (get_config("system", "worker")) {
1379 $cachekey = "app:proc_run:started";
1380 $result = Cache::get($cachekey);
1381 if (!is_null($result)) {
1382 if ((time() - $result) < 10) {
1386 // Set the timestamp of the last proc_run
1387 Cache::set($cachekey, time(), CACHE_MINUTE);
1390 $args[0] = ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php');
1393 // add baseurl to args. cli scripts can't construct it
1394 $args[] = $this->get_baseurl();
1396 for($x = 0; $x < count($args); $x ++)
1397 $args[$x] = escapeshellarg($args[$x]);
1399 $cmdline = implode($args," ");
1401 if(get_config('system','proc_windows'))
1402 proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__)));
1404 proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__)));
1410 * @brief Retrieve the App structure
1412 * Useful in functions which require it but don't get it passed to them
1414 function get_app() {
1421 * @brief Multi-purpose function to check variable state.
1423 * Usage: x($var) or $x($array, 'key')
1425 * returns false if variable/key is not set
1426 * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
1427 * e.g. x('') or x(0) returns 0;
1429 * @param string|array $s variable to check
1430 * @param string $k key inside the array to check
1434 function x($s,$k = NULL) {
1436 if((is_array($s)) && (array_key_exists($k,$s))) {
1456 * @brief Called from db initialisation if db is dead.
1458 function system_unavailable() {
1459 include('system_unavailable.php');
1465 function clean_urls() {
1471 $base = App::get_baseurl();
1480 * @brief Returns the baseurl.
1482 * @see App::get_baseurl()
1485 * @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
1488 return App::get_baseurl();
1492 * @brief Return absolut URL for given $path.
1494 * @param string $path
1498 function absurl($path) {
1499 if(strpos($path,'/') === 0)
1500 return z_path() . $path;
1505 * @brief Function to check if request was an AJAX (xmlhttprequest) request.
1509 function is_ajax() {
1510 return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
1513 function check_db() {
1515 $build = get_config('system','build');
1517 set_config('system','build',DB_UPDATE_VERSION);
1518 $build = DB_UPDATE_VERSION;
1520 if($build != DB_UPDATE_VERSION)
1521 proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
1527 * Sets the base url for use in cmdline programs which don't have
1528 * $_SERVER variables
1530 function check_url(App $a) {
1532 $url = get_config('system','url');
1534 // if the url isn't set or the stored url is radically different
1535 // than the currently visited url, store the current value accordingly.
1536 // "Radically different" ignores common variations such as http vs https
1537 // and www.example.com vs example.com.
1538 // We will only change the url to an ip address if there is no existing setting
1541 $url = set_config('system','url',App::get_baseurl());
1542 if((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname)))
1543 $url = set_config('system','url',App::get_baseurl());
1550 * @brief Automatic database updates
1552 function update_db(App $a) {
1553 $build = get_config('system','build');
1555 $build = set_config('system','build',DB_UPDATE_VERSION);
1557 if($build != DB_UPDATE_VERSION) {
1558 $stored = intval($build);
1559 $current = intval(DB_UPDATE_VERSION);
1560 if($stored < $current) {
1561 Config::load('database');
1563 // We're reporting a different version than what is currently installed.
1564 // Run any existing update scripts to bring the database up to current.
1566 // make sure that boot.php and update.php are the same release, we might be
1567 // updating right this very second and the correct version of the update.php
1568 // file may not be here yet. This can happen on a very busy site.
1570 if(DB_UPDATE_VERSION == UPDATE_VERSION) {
1571 // Compare the current structure with the defined structure
1573 $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
1577 set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
1579 // run old update routine (wich could modify the schema and
1580 // conflits with new routine)
1581 for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
1582 $r = run_update_function($x);
1585 if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION;
1588 // run new update routine
1589 // it update the structure in one call
1590 $retval = update_structure(false, true);
1598 set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
1601 // run any left update_nnnn functions in update.php
1602 for($x = $stored; $x < $current; $x ++) {
1603 $r = run_update_function($x);
1613 function run_update_function($x) {
1614 if(function_exists('update_' . $x)) {
1616 // There could be a lot of processes running or about to run.
1617 // We want exactly one process to run the update command.
1618 // So store the fact that we're taking responsibility
1619 // after first checking to see if somebody else already has.
1621 // If the update fails or times-out completely you may need to
1622 // delete the config entry to try again.
1624 $t = get_config('database','update_' . $x);
1627 set_config('database','update_' . $x, time());
1629 // call the specific update
1631 $func = 'update_' . $x;
1635 //send the administrator an e-mail
1638 sprintf(t('Update %s failed. See error logs.'), $x)
1642 set_config('database','update_' . $x, 'success');
1643 set_config('system','build', $x + 1);
1647 set_config('database','update_' . $x, 'success');
1648 set_config('system','build', $x + 1);
1655 * @brief Synchronise plugins:
1657 * $a->config['system']['addon'] contains a comma-separated list of names
1658 * of plugins/addons which are used on this system.
1659 * Go through the database list of already installed addons, and if we have
1660 * an entry, but it isn't in the config list, call the uninstall procedure
1661 * and mark it uninstalled in the database (for now we'll remove it).
1662 * Then go through the config list and if we have a plugin that isn't installed,
1663 * call the install procedure and add it to the database.
1668 function check_plugins(App $a) {
1670 $r = q("SELECT * FROM `addon` WHERE `installed` = 1");
1671 if (dbm::is_result($r))
1674 $installed = array();
1676 $plugins = get_config('system','addon');
1677 $plugins_arr = array();
1680 $plugins_arr = explode(',',str_replace(' ', '',$plugins));
1682 $a->plugins = $plugins_arr;
1684 $installed_arr = array();
1686 if(count($installed)) {
1687 foreach($installed as $i) {
1688 if(! in_array($i['name'],$plugins_arr)) {
1689 uninstall_plugin($i['name']);
1692 $installed_arr[] = $i['name'];
1697 if(count($plugins_arr)) {
1698 foreach($plugins_arr as $p) {
1699 if(! in_array($p,$installed_arr)) {
1711 function get_guid($size=16, $prefix = "") {
1713 if ($prefix == "") {
1715 $prefix = hash("crc32", $a->get_hostname());
1718 while (strlen($prefix) < ($size - 13))
1719 $prefix .= mt_rand();
1722 $prefix = substr($prefix, 0, $size - 22);
1723 return(str_replace(".", "", uniqid($prefix, true)));
1725 $prefix = substr($prefix, 0, max($size - 13, 0));
1726 return(uniqid($prefix));
1731 * @brief Wrapper for adding a login box.
1733 * @param bool $register
1734 * If $register == true provide a registration link.
1735 * This will most always depend on the value of $a->config['register_policy'].
1736 * @param bool $hiddens
1739 * Returns the complete html for inserting into the page
1741 * @hooks 'login_hook'
1744 function login($register = false, $hiddens=false) {
1750 'title' => t('Create a New Account'),
1751 'desc' => t('Register')
1755 $noid = get_config('system','no_openid');
1757 $dest_url = $a->query_string;
1760 $tpl = get_markup_template("logout.tpl");
1763 $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
1764 '$baseurl' => $a->get_baseurl(true)
1767 $tpl = get_markup_template("login.tpl");
1768 $_SESSION['return_url'] = $a->query_string;
1769 $a->module = 'login';
1772 $o .= replace_macros($tpl, array(
1774 '$dest_url' => $dest_url,
1775 '$logout' => t('Logout'),
1776 '$login' => t('Login'),
1778 '$lname' => array('username', t('Nickname or Email: ') , '', ''),
1779 '$lpassword' => array('password', t('Password: '), '', ''),
1780 '$lremember' => array('remember', t('Remember me'), 0, ''),
1782 '$openid' => !$noid,
1783 '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
1785 '$hiddens' => $hiddens,
1787 '$register' => $reg,
1789 '$lostpass' => t('Forgot your password?'),
1790 '$lostlink' => t('Password Reset'),
1792 '$tostitle' => t('Website Terms of Service'),
1793 '$toslink' => t('terms of service'),
1795 '$privacytitle' => t('Website Privacy Policy'),
1796 '$privacylink' => t('privacy policy'),
1800 call_hooks('login_hook',$o);
1806 * @brief Used to end the current process, after saving session state.
1810 if (!get_app()->is_backend())
1811 session_write_close();
1817 * @brief Redirect to another URL and terminate this process.
1819 function goaway($s) {
1820 if (!strstr(normalise_link($s), "http://"))
1821 $s = App::get_baseurl()."/".$s;
1823 header("Location: $s");
1829 * @brief Returns the user id of locally logged in user or false.
1831 * @return int|bool user id or false
1833 function local_user() {
1834 if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid')))
1835 return intval($_SESSION['uid']);
1840 * @brief Returns contact id of authenticated site visitor or false
1842 * @return int|bool visitor_id or false
1844 function remote_user() {
1845 if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id')))
1846 return intval($_SESSION['visitor_id']);
1851 * @brief Show an error message to user.
1853 * This function save text in session, to be shown to the user at next page load
1855 * @param string $s - Text of notice
1857 function notice($s) {
1859 if(! x($_SESSION,'sysmsg')) $_SESSION['sysmsg'] = array();
1861 $_SESSION['sysmsg'][] = $s;
1865 * @brief Show an info message to user.
1867 * This function save text in session, to be shown to the user at next page load
1869 * @param string $s - Text of notice
1874 if (local_user() AND get_pconfig(local_user(),'system','ignore_info'))
1877 if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
1879 $_SESSION['sysmsg_info'][] = $s;
1884 * @brief Wrapper around config to limit the text length of an incoming message
1888 function get_max_import_size() {
1890 return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
1894 * @brief Wrap calls to proc_close(proc_open()) and call hook
1895 * so plugins can take part in process :)
1897 * @param (string|integer|array) $cmd program to run, priority or parameter array
1899 * next args are passed as $cmd command line
1900 * e.g.: proc_run("ls","-la","/tmp");
1901 * or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
1902 * or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
1904 * @note $cmd and string args are surrounded with ""
1909 function proc_run($cmd){
1913 $proc_args = func_get_args();
1916 if (!count($proc_args)) {
1920 // Preserve the first parameter
1921 // It could contain a command, the priority or an parameter array
1922 // If we use the parameter array we have to protect it from the following function
1923 $run_parameter = array_shift($proc_args);
1925 // expand any arrays
1926 foreach ($proc_args as $arg) {
1927 if (is_array($arg)) {
1928 foreach ($arg as $n) {
1936 // Now we add the run parameters back to the array
1937 array_unshift($args, $run_parameter);
1939 $arr = array('args' => $args, 'run_cmd' => true);
1941 call_hooks("proc_run", $arr);
1942 if (!$arr['run_cmd'] OR !count($args))
1945 if (!get_config("system", "worker") OR (is_string($run_parameter) AND ($run_parameter != 'php'))) {
1946 $a->proc_run($args);
1950 $priority = PRIORITY_MEDIUM;
1951 $dont_fork = get_config("system", "worker_dont_fork");
1953 if (is_int($run_parameter)) {
1954 $priority = $run_parameter;
1955 } elseif (is_array($run_parameter)) {
1956 if (isset($run_parameter['priority'])) {
1957 $priority = $run_parameter['priority'];
1959 if (isset($run_parameter['dont_fork'])) {
1960 $dont_fork = $run_parameter['dont_fork'];
1967 $parameters = json_encode($argv);
1968 $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
1969 dbesc($parameters));
1972 q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
1973 VALUES ('%s', '%s', %d)",
1975 dbesc(datetime_convert()),
1978 // Should we quit and wait for the poller to be called as a cronjob?
1983 // Checking number of workers
1984 $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'");
1986 // Get number of allowed number of worker threads
1987 $queues = intval(get_config("system", "worker_queues"));
1992 // If there are already enough workers running, don't fork another one
1993 if ($workers[0]["workers"] >= $queues)
1996 // Now call the poller to execute the jobs that we just added to the queue
1997 $args = array("php", "include/poller.php", "no_cron");
1999 $a->proc_run($args);
2002 function current_theme(){
2003 $app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2009 // Find the theme that belongs to the user whose stuff we are looking at
2011 if($a->profile_uid && ($a->profile_uid != local_user())) {
2012 $r = q("select theme from user where uid = %d limit 1",
2013 intval($a->profile_uid)
2015 if (dbm::is_result($r))
2016 $page_theme = $r[0]['theme'];
2019 // Allow folks to over-rule user themes and always use their own on their own site.
2020 // This works only if the user is on the same server
2022 if($page_theme && local_user() && (local_user() != $a->profile_uid)) {
2023 if(get_pconfig(local_user(),'system','always_my_theme'))
2027 // $mobile_detect = new Mobile_Detect();
2028 // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2029 $is_mobile = $a->is_mobile || $a->is_tablet;
2031 $standard_system_theme = Config::get('system', 'theme', '');
2032 $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
2035 if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2036 $system_theme = $standard_system_theme;
2037 $theme_name = $standard_theme_name;
2039 $system_theme = Config::get('system', 'mobile-theme', '');
2040 if ($system_theme == '') {
2041 $system_theme = $standard_system_theme;
2043 $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
2045 if($theme_name === '---') {
2046 // user has selected to have the mobile theme be the same as the normal one
2047 $system_theme = $standard_system_theme;
2048 $theme_name = $standard_theme_name;
2051 $theme_name = $page_theme;
2056 $system_theme = $standard_system_theme;
2057 $theme_name = $standard_theme_name;
2060 $theme_name = $page_theme;
2064 (file_exists('view/theme/' . $theme_name . '/style.css') ||
2065 file_exists('view/theme/' . $theme_name . '/style.php')))
2066 return($theme_name);
2068 foreach($app_base_themes as $t) {
2069 if(file_exists('view/theme/' . $t . '/style.css')||
2070 file_exists('view/theme/' . $t . '/style.php'))
2074 $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
2075 if(count($fallback))
2076 return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
2081 * @brief Return full URL to theme which is currently in effect.
2083 * Provide a sane default if nothing is chosen or the specified theme does not exist.
2087 function current_theme_url() {
2090 $t = current_theme();
2092 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
2093 if (file_exists('view/theme/' . $t . '/style.php'))
2094 return('view/theme/'.$t.'/style.pcss'.$opts);
2096 return('view/theme/'.$t.'/style.css');
2099 function feed_birthday($uid,$tz) {
2103 * Determine the next birthday, but only if the birthday is published
2104 * in the default profile. We _could_ also look for a private profile that the
2105 * recipient can see, but somebody could get mad at us if they start getting
2106 * public birthday greetings when they haven't made this info public.
2108 * Assuming we are able to publish this info, we are then going to convert
2109 * the start time from the owner's timezone to UTC.
2111 * This will potentially solve the problem found with some social networks
2112 * where birthdays are converted to the viewer's timezone and salutations from
2113 * elsewhere in the world show up on the wrong day. We will convert it to the
2114 * viewer's timezone also, but first we are going to convert it from the birthday
2115 * person's timezone to GMT - so the viewer may find the birthday starting at
2116 * 6:00PM the day before, but that will correspond to midnight to the birthday person.
2126 $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
2130 if (dbm::is_result($p)) {
2131 $tmp_dob = substr($p[0]['dob'],5);
2132 if(intval($tmp_dob)) {
2133 $y = datetime_convert($tz,$tz,'now','Y');
2134 $bd = $y . '-' . $tmp_dob . ' 00:00';
2135 $t_dob = strtotime($bd);
2136 $now = strtotime(datetime_convert($tz,$tz,'now'));
2138 $bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
2139 $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2147 * @brief Check if current user has admin role.
2149 * @return bool true if user is an admin
2151 function is_site_admin() {
2154 $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
2156 //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
2157 if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist))
2163 * @brief Returns querystring as string from a mapped array.
2165 * @param array $params mapped array with query parameters
2166 * @param string $name of parameter, default null
2170 function build_querystring($params, $name=null) {
2172 foreach($params as $key=>$val) {
2173 if(is_array($val)) {
2175 $ret .= build_querystring($val, $key);
2177 $ret .= build_querystring($val, $name."[$key]");
2180 $val = urlencode($val);
2182 $ret.=$name."[$key]"."=$val&";
2184 $ret.= "$key=$val&";
2191 function explode_querystring($query) {
2192 $arg_st = strpos($query, '?');
2193 if($arg_st !== false) {
2194 $base = substr($query, 0, $arg_st);
2201 $args = explode('&', substr($query, $arg_st));
2202 foreach($args as $k=>$arg) {
2206 $args = array_values($args);
2211 $args = array_values($args);
2221 * Returns the complete URL of the current page, e.g.: http(s)://something.com/network
2223 * Taken from http://webcheatsheet.com/php/get_current_page_url.php
2225 function curPageURL() {
2227 if ($_SERVER["HTTPS"] == "on") {$pageURL .= "s";}
2229 if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
2230 $pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
2232 $pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
2237 function random_digits($digits) {
2239 for($i = 0; $i < $digits; $i++) {
2245 function get_server() {
2246 $server = get_config("system", "directory");
2249 $server = "http://dir.friendi.ca";
2254 function get_cachefile($file, $writemode = true) {
2255 $cache = get_itemcachepath();
2257 if ((! $cache) || (! is_dir($cache)))
2260 $subfolder = $cache."/".substr($file, 0, 2);
2262 $cachepath = $subfolder."/".$file;
2265 if (!is_dir($subfolder)) {
2267 chmod($subfolder, 0777);
2274 function clear_cache($basepath = "", $path = "") {
2276 $basepath = get_itemcachepath();
2280 if (($path == "") OR (!is_dir($path)))
2283 if (substr(realpath($path), 0, strlen($basepath)) != $basepath)
2286 $cachetime = (int)get_config('system','itemcache_duration');
2287 if ($cachetime == 0)
2290 if (is_writable($path)){
2291 if ($dh = opendir($path)) {
2292 while (($file = readdir($dh)) !== false) {
2293 $fullpath = $path."/".$file;
2294 if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != ".."))
2295 clear_cache($basepath, $fullpath);
2296 if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime)))
2304 function get_itemcachepath() {
2305 // Checking, if the cache is deactivated
2306 $cachetime = (int)get_config('system','itemcache_duration');
2310 $itemcache = get_config('system','itemcache');
2311 if (($itemcache != "") AND is_dir($itemcache) AND is_writable($itemcache))
2314 $temppath = get_temppath();
2316 if ($temppath != "") {
2317 $itemcache = $temppath."/itemcache";
2318 if(!file_exists($itemcache) && !is_dir($itemcache)) {
2322 if (is_dir($itemcache) AND is_writable($itemcache)) {
2323 set_config("system", "itemcache", $itemcache);
2330 function get_lockpath() {
2331 $lockpath = get_config('system','lockpath');
2332 if (($lockpath != "") AND is_dir($lockpath) AND is_writable($lockpath))
2335 $temppath = get_temppath();
2337 if ($temppath != "") {
2338 $lockpath = $temppath."/lock";
2340 if (!is_dir($lockpath))
2342 elseif (!is_writable($lockpath))
2343 $lockpath = $temppath;
2345 if (is_dir($lockpath) AND is_writable($lockpath)) {
2346 set_config("system", "lockpath", $lockpath);
2354 * @brief Returns the path where spool files are stored
2356 * @return string Spool path
2358 function get_spoolpath() {
2359 $spoolpath = get_config('system','spoolpath');
2360 if (($spoolpath != "") AND is_dir($spoolpath) AND is_writable($spoolpath)) {
2364 $temppath = get_temppath();
2366 if ($temppath != "") {
2367 $spoolpath = $temppath."/spool";
2369 if (!is_dir($spoolpath)) {
2371 } elseif (!is_writable($spoolpath)) {
2372 $spoolpath = $temppath;
2375 if (is_dir($spoolpath) AND is_writable($spoolpath)) {
2376 set_config("system", "spoolpath", $spoolpath);
2383 function get_temppath() {
2386 $temppath = get_config("system","temppath");
2387 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath))
2390 $temppath = sys_get_temp_dir();
2391 if (($temppath != "") AND is_dir($temppath) AND is_writable($temppath)) {
2392 $temppath .= "/".$a->get_hostname();
2393 if (!is_dir($temppath))
2396 if (is_dir($temppath) AND is_writable($temppath)) {
2397 set_config("system", "temppath", $temppath);
2406 function set_template_engine(App $a, $engine = 'internal') {
2407 /// @note This function is no longer necessary, but keep it as a wrapper to the class method
2408 /// to avoid breaking themes again unnecessarily
2410 $a->set_template_engine($engine);
2413 if(!function_exists('exif_imagetype')) {
2414 function exif_imagetype($file) {
2415 $size = getimagesize($file);
2420 function validate_include(&$file) {
2423 $file = realpath($file);
2425 if (strpos($file, getcwd()) !== 0)
2428 $file = str_replace(getcwd()."/", "", $file, $count);
2432 if ($orig_file !== $file)
2436 if (strpos($file, "include/") === 0)
2439 if (strpos($file, "addon/") === 0)
2448 function current_load() {
2449 if (!function_exists('sys_getloadavg'))
2452 $load_arr = sys_getloadavg();
2454 if (!is_array($load_arr))
2457 return max($load_arr[0], $load_arr[1]);
2461 * @brief get c-style args
2466 return get_app()->argc;
2470 * @brief Returns the value of a argv key
2472 * @param int $x argv key
2473 * @return string Value of the argv key
2476 if(array_key_exists($x,get_app()->argv))
2477 return get_app()->argv[$x];
2483 * @brief Get the data which is needed for infinite scroll
2485 * For invinite scroll we need the page number of the actual page
2486 * and the the URI where the content of the next page comes from.
2487 * This data is needed for the js part in main.js.
2488 * Note: infinite scroll does only work for the network page (module)
2490 * @param string $module The name of the module (e.g. "network")
2491 * @return array Of infinite scroll data
2492 * 'pageno' => $pageno The number of the actual page
2493 * 'reload_uri' => $reload_uri The URI of the content we have to load
2495 function infinite_scroll_data($module) {
2497 if (get_pconfig(local_user(),'system','infinite_scroll')
2498 AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
2500 // get the page number
2501 if (is_string($_GET["page"]))
2502 $pageno = $_GET["page"];
2508 // try to get the uri from which we load the content
2509 foreach ($_GET AS $param => $value)
2510 if (($param != "page") AND ($param != "q"))
2511 $reload_uri .= "&".$param."=".urlencode($value);
2513 if (($a->page_offset != "") AND !strstr($reload_uri, "&offset="))
2514 $reload_uri .= "&offset=".urlencode($a->page_offset);
2516 $arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);