friendica/boot.php

2625 lines
66 KiB
PHP
Raw Normal View History

2010-07-01 19:48:07 -04:00
<?php
2015-12-23 19:31:17 -05:00
/** @file boot.php
*
* This file defines some global constants and includes the central App class.
*/
/**
* Friendica
*
2015-12-23 19:31:17 -05:00
* Friendica is a communications platform for integrated social communications
* utilising decentralised communications and linkage to several indie social
* projects - as well as popular mainstream providers.
*
2015-12-23 19:31:17 -05:00
* Our mission is to free our friends and families from the clutches of
* data-harvesting corporations, and pave the way to a future where social
* communications are free and open and flow between alternate providers as
* easily as email does today.
*/
2010-07-01 19:48:07 -04:00
2016-02-09 05:07:37 -05:00
require_once('include/autoloader.php');
use \Friendica\Core\Config;
require_once('include/config.php');
require_once('include/network.php');
require_once('include/plugin.php');
require_once('include/text.php');
require_once('include/datetime.php');
require_once('include/pgettext.php');
require_once('include/nav.php');
2011-10-24 07:02:38 -04:00
require_once('include/cache.php');
2012-07-23 22:37:00 -04:00
require_once('library/Mobile_Detect/Mobile_Detect.php');
2012-11-22 11:14:22 -05:00
require_once('include/features.php');
require_once('include/identity.php');
require_once('update.php');
require_once('include/dbstructure.php');
define ( 'FRIENDICA_PLATFORM', 'Friendica');
2015-12-22 10:43:07 -05:00
define ( 'FRIENDICA_CODENAME', 'Asparagus');
define ( 'FRIENDICA_VERSION', '3.5.2-dev' );
define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
define ( 'DB_UPDATE_VERSION', 1216 );
/**
* @brief Constant with a HTML line break.
*
* Contains a HTML line break (br) element and a real carriage return with line
* feed for the source.
* This can be used in HTML and JavaScript where needed a line break.
*/
2010-10-13 05:47:32 -04:00
define ( 'EOL', "<br />\r\n" );
define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
2011-08-16 23:05:02 -04:00
/**
* @brief Image storage quality.
*
* Lower numbers save space at cost of image detail.
* For ease of upgrade, please do not change here. Change jpeg quality with
* $a->config['system']['jpeg_quality'] = n;
* in .htconfig.php, where n is netween 1 and 100, and with very poor results
* below about 50
*
*/
define ( 'JPEG_QUALITY', 100 );
2012-06-07 11:42:13 -04:00
/**
* $a->config['system']['png_quality'] from 0 (uncompressed) to 9
*/
define ( 'PNG_QUALITY', 8 );
/**
*
* An alternate way of limiting picture upload sizes. Specify the maximum pixel
* length that pictures are allowed to be (for non-square pictures, it will apply
* to the longest side). Pictures longer than this length will be resized to be
* this length (on the longest side, the other side will be scaled appropriately).
* Modify this value using
*
* $a->config['system']['max_image_length'] = n;
*
* in .htconfig.php
*
* If you don't want to set a maximum length, set to -1. The default value is
* defined by 'MAX_IMAGE_LENGTH' below.
*
*/
define ( 'MAX_IMAGE_LENGTH', -1 );
/**
* Not yet used
*/
define ( 'DEFAULT_DB_ENGINE', 'MyISAM' );
/**
* @name SSL Policy
*
* SSL redirection policies
* @{
*/
define ( 'SSL_POLICY_NONE', 0 );
define ( 'SSL_POLICY_FULL', 1 );
2011-01-30 01:41:01 -05:00
define ( 'SSL_POLICY_SELFSIGN', 2 );
/* @}*/
2010-12-10 07:04:35 -05:00
/**
* @name Logger
*
2010-12-10 07:04:35 -05:00
* log levels
* @{
2010-12-10 07:04:35 -05:00
*/
2010-11-01 20:56:36 -04:00
define ( 'LOGGER_NORMAL', 0 );
define ( 'LOGGER_TRACE', 1 );
define ( 'LOGGER_DEBUG', 2 );
define ( 'LOGGER_DATA', 3 );
define ( 'LOGGER_ALL', 4 );
/* @}*/
2010-11-01 20:56:36 -04:00
/**
* @name Cache
*
* Cache levels
* @{
*/
define ( 'CACHE_MONTH', 0 );
define ( 'CACHE_WEEK', 1 );
define ( 'CACHE_DAY', 2 );
define ( 'CACHE_HOUR', 3 );
define ( 'CACHE_HALF_HOUR', 4 );
define ( 'CACHE_QUARTER_HOUR', 5 );
define ( 'CACHE_FIVE_MINUTES', 6 );
define ( 'CACHE_MINUTE', 7 );
/* @}*/
2010-12-10 07:04:35 -05:00
/**
* @name Register
*
* Registration policies
* @{
2010-12-10 07:04:35 -05:00
*/
2010-10-13 05:47:32 -04:00
define ( 'REGISTER_CLOSED', 0 );
define ( 'REGISTER_APPROVE', 1 );
define ( 'REGISTER_OPEN', 2 );
/** @}*/
2010-07-01 19:48:07 -04:00
2010-12-10 07:04:35 -05:00
/**
* @name Contact_is
*
* Relationship types
* @{
2010-12-10 07:04:35 -05:00
*/
2011-08-07 19:15:54 -04:00
define ( 'CONTACT_IS_FOLLOWER', 1);
define ( 'CONTACT_IS_SHARING', 2);
define ( 'CONTACT_IS_FRIEND', 3);
/** @}*/
2010-09-09 19:48:33 -04:00
/**
* @name Update
*
* DB update return values
* @{
*/
define ( 'UPDATE_SUCCESS', 0);
define ( 'UPDATE_FAILED', 1);
/** @}*/
2010-12-10 07:04:35 -05:00
/**
* @name page/profile types
2010-12-10 07:04:35 -05:00
*
* PAGE_NORMAL is a typical personal profile account
2011-08-07 19:15:54 -04:00
* PAGE_SOAPBOX automatically approves all friend requests as CONTACT_IS_SHARING, (readonly)
* PAGE_COMMUNITY automatically approves all friend requests as CONTACT_IS_SHARING, but with
2010-12-10 07:04:35 -05:00
* write access to wall and comments (no email and not included in page owner's ACL lists)
* PAGE_FREELOVE automatically approves all friend requests as full friends (CONTACT_IS_FRIEND).
2010-12-10 07:04:35 -05:00
*
* @{
2010-12-10 07:04:35 -05:00
*/
define ( 'PAGE_NORMAL', 0 );
define ( 'PAGE_SOAPBOX', 1 );
define ( 'PAGE_COMMUNITY', 2 );
define ( 'PAGE_FREELOVE', 3 );
2012-01-24 19:23:30 -05:00
define ( 'PAGE_BLOG', 4 );
define ( 'PAGE_PRVGROUP', 5 );
/** @}*/
/**
* @name account types
*
2016-09-27 14:29:50 -04:00
* ACCOUNT_TYPE_PERSON - the account belongs to a person
* Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
*
* ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
* Associated page type: PAGE_SOAPBOX
*
* ACCOUNT_TYPE_NEWS - the account is a news reflector
* Associated page type: PAGE_SOAPBOX
*
* ACCOUNT_TYPE_COMMUNITY - the account is community forum
* Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
* @{
*/
define ( 'ACCOUNT_TYPE_PERSON', 0 );
define ( 'ACCOUNT_TYPE_ORGANISATION',1 );
define ( 'ACCOUNT_TYPE_NEWS', 2 );
define ( 'ACCOUNT_TYPE_COMMUNITY', 3 );
/** @}*/
/**
* @name CP
*
* Type of the community page
* @{
*/
define ( 'CP_NO_COMMUNITY_PAGE', -1 );
define ( 'CP_USERS_ON_SERVER', 0 );
define ( 'CP_GLOBAL_COMMUNITY', 1 );
/** @}*/
2011-04-11 06:22:09 -04:00
/**
* @name Network
*
* Network and protocol family types
* @{
2011-04-11 06:22:09 -04:00
*/
define ( 'NETWORK_DFRN', 'dfrn'); // Friendica, Mistpark, other DFRN implementations
2012-03-28 22:56:14 -04:00
define ( 'NETWORK_ZOT', 'zot!'); // Zot!
2011-04-11 06:22:09 -04:00
define ( 'NETWORK_OSTATUS', 'stat'); // status.net, identi.ca, GNU-social, other OStatus implementations
define ( 'NETWORK_FEED', 'feed'); // RSS/Atom feeds with no known "post/notify" protocol
define ( 'NETWORK_DIASPORA', 'dspr'); // Diaspora
define ( 'NETWORK_MAIL', 'mail'); // IMAP/POP
2012-01-31 23:03:46 -05:00
define ( 'NETWORK_MAIL2', 'mai2'); // extended IMAP/POP
define ( 'NETWORK_FACEBOOK', 'face'); // Facebook API
define ( 'NETWORK_LINKEDIN', 'lnkd'); // LinkedIn
define ( 'NETWORK_XMPP', 'xmpp'); // XMPP
define ( 'NETWORK_MYSPACE', 'mysp'); // MySpace
2012-01-31 23:03:46 -05:00
define ( 'NETWORK_GPLUS', 'goog'); // Google+
define ( 'NETWORK_PUMPIO', 'pump'); // pump.io
define ( 'NETWORK_TWITTER', 'twit'); // Twitter
define ( 'NETWORK_DIASPORA2', 'dspc'); // Diaspora connector
define ( 'NETWORK_STATUSNET', 'stac'); // Statusnet connector
define ( 'NETWORK_APPNET', 'apdn'); // app.net
2015-10-27 02:49:02 -04:00
define ( 'NETWORK_NEWS', 'nntp'); // Network News Transfer Protocol
define ( 'NETWORK_ICALENDAR', 'ical'); // iCalendar
define ( 'NETWORK_PNUT', 'pnut'); // pnut.io
2012-05-11 06:41:29 -04:00
define ( 'NETWORK_PHANTOM', 'unkn'); // Place holder
/** @}*/
2012-05-11 06:41:29 -04:00
/**
2012-03-28 22:56:14 -04:00
* These numbers are used in stored permissions
* and existing allocations MUST NEVER BE CHANGED
* OR RE-ASSIGNED! You may only add to them.
*/
$netgroup_ids = array(
NETWORK_DFRN => (-1),
NETWORK_ZOT => (-2),
NETWORK_OSTATUS => (-3),
NETWORK_FEED => (-4),
NETWORK_DIASPORA => (-5),
NETWORK_MAIL => (-6),
NETWORK_MAIL2 => (-7),
NETWORK_FACEBOOK => (-8),
NETWORK_LINKEDIN => (-9),
NETWORK_XMPP => (-10),
NETWORK_MYSPACE => (-11),
NETWORK_GPLUS => (-12),
NETWORK_PUMPIO => (-13),
NETWORK_TWITTER => (-14),
NETWORK_DIASPORA2 => (-15),
NETWORK_STATUSNET => (-16),
2015-10-27 02:49:02 -04:00
NETWORK_APPNET => (-17),
NETWORK_NEWS => (-18),
NETWORK_ICALENDAR => (-19),
NETWORK_PNUT => (-20),
2012-05-11 06:41:29 -04:00
NETWORK_PHANTOM => (-127),
2012-03-28 22:56:14 -04:00
);
2010-12-10 07:04:35 -05:00
/**
* Maximum number of "people who like (or don't like) this" that we will list by name
*/
2010-10-12 20:11:06 -04:00
define ( 'MAX_LIKERS', 75);
2011-07-15 06:08:43 -04:00
/**
* Communication timeout
*/
define ( 'ZCURL_TIMEOUT' , (-1));
2010-12-10 07:04:35 -05:00
/**
* @name Notify
*
* Email notification options
* @{
2010-12-10 07:04:35 -05:00
*/
2012-02-09 17:06:17 -05:00
define ( 'NOTIFY_INTRO', 0x0001 );
define ( 'NOTIFY_CONFIRM', 0x0002 );
define ( 'NOTIFY_WALL', 0x0004 );
define ( 'NOTIFY_COMMENT', 0x0008 );
define ( 'NOTIFY_MAIL', 0x0010 );
define ( 'NOTIFY_SUGGEST', 0x0020 );
define ( 'NOTIFY_PROFILE', 0x0040 );
define ( 'NOTIFY_TAGSELF', 0x0080 );
define ( 'NOTIFY_TAGSHARE', 0x0100 );
2012-07-19 23:13:40 -04:00
define ( 'NOTIFY_POKE', 0x0200 );
define ( 'NOTIFY_SHARE', 0x0400 );
2012-03-25 07:37:09 -04:00
define ( 'NOTIFY_SYSTEM', 0x8000 );
/* @}*/
2012-03-25 07:37:09 -04:00
/**
* @name Term
*
* Tag/term types
* @{
*/
define ( 'TERM_UNKNOWN', 0 );
define ( 'TERM_HASHTAG', 1 );
define ( 'TERM_MENTION', 2 );
define ( 'TERM_CATEGORY', 3 );
define ( 'TERM_PCATEGORY', 4 );
define ( 'TERM_FILE', 5 );
define ( 'TERM_SAVEDSEARCH', 6 );
define ( 'TERM_CONVERSATION', 7 );
define ( 'TERM_OBJ_POST', 1 );
define ( 'TERM_OBJ_PHOTO', 2 );
2010-12-10 07:04:35 -05:00
/**
* @name Namespaces
*
* Various namespaces we may need to parse
* @{
2010-12-10 07:04:35 -05:00
*/
2012-07-19 21:17:16 -04:00
define ( 'NAMESPACE_ZOT', 'http://purl.org/zot' );
define ( 'NAMESPACE_DFRN' , 'http://purl.org/macgirvin/dfrn/1.0' );
2010-09-09 20:55:59 -04:00
define ( 'NAMESPACE_THREAD' , 'http://purl.org/syndication/thread/1.0' );
define ( 'NAMESPACE_TOMB' , 'http://purl.org/atompub/tombstones/1.0' );
define ( 'NAMESPACE_ACTIVITY', 'http://activitystrea.ms/spec/1.0/' );
define ( 'NAMESPACE_ACTIVITY_SCHEMA', 'http://activitystrea.ms/schema/1.0/' );
define ( 'NAMESPACE_MEDIA', 'http://purl.org/syndication/atommedia' );
define ( 'NAMESPACE_SALMON_ME', 'http://salmon-protocol.org/ns/magic-env' );
define ( 'NAMESPACE_OSTATUSSUB', 'http://ostatus.org/schema/1.0/subscribe' );
define ( 'NAMESPACE_GEORSS', 'http://www.georss.org/georss' );
define ( 'NAMESPACE_POCO', 'http://portablecontacts.net/spec/1.0' );
define ( 'NAMESPACE_FEED', 'http://schemas.google.com/g/2010#updates-from' );
2011-06-20 22:08:40 -04:00
define ( 'NAMESPACE_OSTATUS', 'http://ostatus.org/schema/1.0' );
define ( 'NAMESPACE_STATUSNET', 'http://status.net/schema/api/1/' );
2011-07-21 02:14:43 -04:00
define ( 'NAMESPACE_ATOM1', 'http://www.w3.org/2005/Atom' );
/* @}*/
2010-12-10 07:04:35 -05:00
/**
* @name Activity
*
* Activity stream defines
* @{
2010-12-10 07:04:35 -05:00
*/
2010-09-08 23:14:17 -04:00
define ( 'ACTIVITY_LIKE', NAMESPACE_ACTIVITY_SCHEMA . 'like' );
2010-09-09 21:49:19 -04:00
define ( 'ACTIVITY_DISLIKE', NAMESPACE_DFRN . '/dislike' );
2015-06-01 07:57:45 -04:00
define ( 'ACTIVITY_ATTEND', NAMESPACE_ZOT . '/activity/attendyes' );
define ( 'ACTIVITY_ATTENDNO', NAMESPACE_ZOT . '/activity/attendno' );
define ( 'ACTIVITY_ATTENDMAYBE', NAMESPACE_ZOT . '/activity/attendmaybe' );
2015-05-31 19:23:04 -04:00
2010-09-09 20:55:59 -04:00
define ( 'ACTIVITY_OBJ_HEART', NAMESPACE_DFRN . '/heart' );
2010-09-08 23:14:17 -04:00
define ( 'ACTIVITY_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
2011-10-02 19:18:01 -04:00
define ( 'ACTIVITY_REQ_FRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'request-friend' );
define ( 'ACTIVITY_UNFRIEND', NAMESPACE_ACTIVITY_SCHEMA . 'remove-friend' );
define ( 'ACTIVITY_FOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'follow' );
define ( 'ACTIVITY_UNFOLLOW', NAMESPACE_ACTIVITY_SCHEMA . 'stop-following' );
define ( 'ACTIVITY_JOIN', NAMESPACE_ACTIVITY_SCHEMA . 'join' );
2010-09-08 23:14:17 -04:00
define ( 'ACTIVITY_POST', NAMESPACE_ACTIVITY_SCHEMA . 'post' );
define ( 'ACTIVITY_UPDATE', NAMESPACE_ACTIVITY_SCHEMA . 'update' );
2010-11-04 23:47:44 -04:00
define ( 'ACTIVITY_TAG', NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
2012-01-24 19:23:30 -05:00
define ( 'ACTIVITY_FAVORITE', NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );
2015-07-15 12:27:44 -04:00
define ( 'ACTIVITY_SHARE', NAMESPACE_ACTIVITY_SCHEMA . 'share' );
2010-09-08 23:14:17 -04:00
2012-07-19 21:17:16 -04:00
define ( 'ACTIVITY_POKE', NAMESPACE_ZOT . '/activity/poke' );
2012-08-23 00:36:55 -04:00
define ( 'ACTIVITY_MOOD', NAMESPACE_ZOT . '/activity/mood' );
2012-07-19 21:17:16 -04:00
define ( 'ACTIVITY_OBJ_BOOKMARK', NAMESPACE_ACTIVITY_SCHEMA . 'bookmark' );
2010-09-08 23:14:17 -04:00
define ( 'ACTIVITY_OBJ_COMMENT', NAMESPACE_ACTIVITY_SCHEMA . 'comment' );
define ( 'ACTIVITY_OBJ_NOTE', NAMESPACE_ACTIVITY_SCHEMA . 'note' );
define ( 'ACTIVITY_OBJ_PERSON', NAMESPACE_ACTIVITY_SCHEMA . 'person' );
define ( 'ACTIVITY_OBJ_IMAGE', NAMESPACE_ACTIVITY_SCHEMA . 'image' );
2010-09-08 23:14:17 -04:00
define ( 'ACTIVITY_OBJ_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
define ( 'ACTIVITY_OBJ_VIDEO', NAMESPACE_ACTIVITY_SCHEMA . 'video' );
2010-09-08 23:14:17 -04:00
define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
define ( 'ACTIVITY_OBJ_ALBUM', NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
2011-06-09 19:24:29 -04:00
define ( 'ACTIVITY_OBJ_EVENT', NAMESPACE_ACTIVITY_SCHEMA . 'event' );
define ( 'ACTIVITY_OBJ_GROUP', NAMESPACE_ACTIVITY_SCHEMA . 'group' );
2011-09-18 23:17:44 -04:00
define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_DFRN . '/tagterm' );
2012-04-13 00:10:32 -04:00
define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_DFRN . '/profile' );
define ( 'ACTIVITY_OBJ_QUESTION', 'http://activityschema.org/object/question' );
/* @}*/
2010-09-08 23:14:17 -04:00
2010-12-10 07:04:35 -05:00
/**
* @name Gravity
*
* Item weight for query ordering
* @{
2010-12-10 07:04:35 -05:00
*/
2010-09-17 06:10:19 -04:00
define ( 'GRAVITY_PARENT', 0);
define ( 'GRAVITY_LIKE', 3);
define ( 'GRAVITY_COMMENT', 6);
/* @}*/
/**
* @name Priority
*
* Process priority for the worker
* @{
*/
define('PRIORITY_UNDEFINED', 0);
define('PRIORITY_CRITICAL', 10);
define('PRIORITY_HIGH', 20);
define('PRIORITY_MEDIUM', 30);
define('PRIORITY_LOW', 40);
define('PRIORITY_NEGLIGIBLE',50);
/* @}*/
/**
* @name Social Relay settings
*
* See here: https://github.com/jaywink/social-relay
* and here: https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
* @{
*/
define('SR_SCOPE_NONE', '');
define('SR_SCOPE_ALL', 'all');
define('SR_SCOPE_TAGS', 'tags');
/* @}*/
2010-09-08 23:14:17 -04:00
2017-02-27 18:37:15 -05:00
/**
* Lowest possible date time value
*/
define ('NULL_DATE', '0001-01-01 00:00:00');
2017-02-27 18:37:15 -05:00
// Normally this constant is defined - but not if "pcntl" isn't installed
2017-03-19 04:04:04 -04:00
if (!defined("SIGTERM")) {
define("SIGTERM", 15);
2017-03-19 04:04:04 -04:00
}
2010-12-10 07:04:35 -05:00
/**
*
* Reverse the effect of magic_quotes_gpc if it is enabled.
* Please disable magic_quotes_gpc so we don't have to do this.
* See http://php.net/manual/en/security.magicquotes.disabling.php
*
*/
2010-11-24 02:42:45 -05:00
2011-07-18 00:34:02 -04:00
function startup() {
2011-07-18 00:34:02 -04:00
error_reporting(E_ERROR | E_WARNING | E_PARSE);
2011-07-18 00:34:02 -04:00
set_time_limit(0);
2011-09-22 20:35:49 -04:00
// This has to be quite large to deal with embedded private photos
2011-11-02 04:50:15 -04:00
ini_set('pcre.backtrack_limit', 500000);
2011-07-18 00:34:02 -04:00
if (get_magic_quotes_gpc()) {
$process = array(&$_GET, &$_POST, &$_COOKIE, &$_REQUEST);
while (list($key, $val) = each($process)) {
foreach ($val as $k => $v) {
unset($process[$key][$k]);
if (is_array($v)) {
$process[$key][stripslashes($k)] = $v;
$process[] = &$process[$key][stripslashes($k)];
} else {
$process[$key][stripslashes($k)] = stripslashes($v);
}
}
}
unset($process);
2011-07-18 00:34:02 -04:00
}
2010-11-24 02:42:45 -05:00
}
2010-12-10 07:04:35 -05:00
/**
*
* class: App
*
2015-12-23 19:31:17 -05:00
* @brief Our main application structure for the life of this page.
*
2010-12-10 07:04:35 -05:00
* Primarily deals with the URL that got us here
* and tries to make some sense of it, and
2010-12-10 07:04:35 -05:00
* stores our page contents and config storage
* and anything else that might need to be passed around
* before we spit the page out.
2010-12-10 07:04:35 -05:00
*
*/
2015-12-23 19:31:17 -05:00
class App {
/// @TODO decide indending as a colorful mixure is ahead ...
2015-12-23 19:31:17 -05:00
public $module_loaded = false;
public $query_string;
public $config;
public $page;
public $profile;
public $profile_uid;
public $user;
public $cid;
public $contact;
public $contacts;
public $page_contact;
public $content;
public $data = array();
public $error = false;
public $cmd;
public $argv;
public $argc;
public $module;
public $pager;
public $strings;
public $path;
public $hooks;
public $timezone;
public $interactive = true;
public $plugins;
public $apps = array();
public $identities;
public $is_mobile = false;
public $is_tablet = false;
2015-12-23 19:31:17 -05:00
public $is_friendica_app;
public $performance = array();
public $callstack = array();
public $theme_info = array();
public $backend = true;
2015-12-23 19:31:17 -05:00
public $nav_sel;
public $category;
// Allow themes to control internal parameters
// by changing App values in theme.php
public $sourcename = '';
public $videowidth = 425;
public $videoheight = 350;
public $force_max_items = 0;
public $theme_thread_allow = true;
public $theme_events_in_profile = true;
2010-09-27 20:16:52 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief An array for all theme-controllable parameters
*
* Mostly unimplemented yet. Only options 'template_engine' and
* beyond are used.
*/
public $theme = array(
'sourcename' => '',
'videowidth' => 425,
'videoheight' => 350,
2015-12-23 19:31:17 -05:00
'force_max_items' => 0,
'thread_allow' => true,
'stylesheet' => '',
2015-12-23 19:31:17 -05:00
'template_engine' => 'smarty3',
);
2012-12-22 14:57:29 -05:00
2015-12-23 19:31:17 -05:00
/**
* @brief An array of registered template engines ('name'=>'class name')
*/
public $template_engines = array();
/**
* @brief An array of instanced template engines ('name'=>'instance')
*/
public $template_engine_instance = array();
2010-07-01 19:48:07 -04:00
public $process_id;
2015-12-23 19:31:17 -05:00
private $ldelim = array(
'internal' => '',
'smarty3' => '{{'
);
private $rdelim = array(
'internal' => '',
'smarty3' => '}}'
);
2015-12-23 19:31:17 -05:00
private $scheme;
private $hostname;
private $db;
2015-12-23 19:31:17 -05:00
private $curl_code;
private $curl_content_type;
private $curl_headers;
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
private $cached_profile_image;
private $cached_profile_picdate;
2016-01-25 09:20:58 -05:00
private static $a;
2015-12-23 19:31:17 -05:00
/**
* @brief App constructor.
2015-12-23 19:31:17 -05:00
*/
function __construct() {
2015-12-23 19:31:17 -05:00
global $default_timezone;
2015-12-23 19:31:17 -05:00
$hostname = "";
if (file_exists(".htpreconfig.php")) {
include ".htpreconfig.php";
}
2015-12-23 19:31:17 -05:00
$this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
2010-12-10 23:21:34 -05:00
2015-12-23 19:31:17 -05:00
date_default_timezone_set($this->timezone);
2015-12-23 19:31:17 -05:00
$this->performance["start"] = microtime(true);
$this->performance["database"] = 0;
$this->performance["database_write"] = 0;
2015-12-23 19:31:17 -05:00
$this->performance["network"] = 0;
$this->performance["file"] = 0;
$this->performance["rendering"] = 0;
$this->performance["parser"] = 0;
$this->performance["marktime"] = 0;
2016-01-16 03:16:51 -05:00
$this->performance["markstart"] = microtime(true);
$this->callstack["database"] = array();
$this->callstack["database_write"] = array();
$this->callstack["network"] = array();
$this->callstack["file"] = array();
$this->callstack["rendering"] = array();
$this->callstack["parser"] = array();
2015-12-23 19:31:17 -05:00
$this->config = array();
$this->page = array();
$this->pager= array();
2015-12-23 19:31:17 -05:00
$this->query_string = '';
$this->process_id = uniqid("log", true);
2015-12-23 19:31:17 -05:00
startup();
2015-12-23 19:31:17 -05:00
set_include_path(
'include' . PATH_SEPARATOR
. 'library' . PATH_SEPARATOR
. 'library/phpsec' . PATH_SEPARATOR
. 'library/langdet' . PATH_SEPARATOR
. '.' );
2015-12-23 19:31:17 -05:00
$this->scheme = 'http';
if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
(x($_SERVER, 'HTTP_FORWARDED') && preg_match("/proto=https/", $_SERVER['HTTP_FORWARDED'])) ||
(x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
(x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
(x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
(x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
) {
2015-12-23 19:31:17 -05:00
$this->scheme = 'https';
}
if (x($_SERVER, 'SERVER_NAME')) {
2015-12-23 19:31:17 -05:00
$this->hostname = $_SERVER['SERVER_NAME'];
if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
2015-12-23 19:31:17 -05:00
$this->hostname .= ':' . $_SERVER['SERVER_PORT'];
}
/*
2015-12-23 19:31:17 -05:00
* Figure out if we are running at the top of a domain
* or in a sub-directory and adjust accordingly
*/
/// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
$path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
if (isset($path) && strlen($path) && ($path != $this->path)) {
2015-12-23 19:31:17 -05:00
$this->path = $path;
}
2015-12-23 19:31:17 -05:00
}
if ($hostname != "") {
2015-12-23 19:31:17 -05:00
$this->hostname = $hostname;
}
2010-12-10 23:21:34 -05:00
if (is_array($_SERVER["argv"]) && $_SERVER["argc"] > 1 && substr(end($_SERVER["argv"]), 0, 4) == "http" ) {
$this->set_baseurl(array_pop($_SERVER["argv"]));
2015-12-23 19:31:17 -05:00
$_SERVER["argc"] --;
}
if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === "pagename=") {
$this->query_string = substr($_SERVER['QUERY_STRING'], 9);
2015-12-23 19:31:17 -05:00
// removing trailing / - maybe a nginx problem
$this->query_string = lrim($this->query_string, '/');
} elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === "q=") {
2015-12-23 19:31:17 -05:00
$this->query_string = substr($_SERVER['QUERY_STRING'],2);
2015-12-23 19:31:17 -05:00
// removing trailing / - maybe a nginx problem
$this->query_string = lrim($this->query_string, '/');
2015-12-23 19:31:17 -05:00
}
if (x($_GET, 'pagename')) {
$this->cmd = trim($_GET['pagename'], '/\\');
} elseif (x($_GET, 'q')) {
$this->cmd = trim($_GET['q'], '/\\');
}
2015-12-23 19:31:17 -05:00
// fix query_string
$this->query_string = str_replace($this->cmd . "&", $this->cmd . "?", $this->query_string);
2015-12-23 19:31:17 -05:00
// unix style "homedir"
if (substr($this->cmd, 0, 1) === '~') {
$this->cmd = 'profile/' . substr($this->cmd, 1);
}
2012-12-14 16:47:30 -05:00
2015-12-23 19:31:17 -05:00
// Diaspora style profile url
if (substr($this->cmd,0,2) === 'u/') {
2015-12-23 19:31:17 -05:00
$this->cmd = 'profile/' . substr($this->cmd,2);
}
2012-12-14 16:47:30 -05:00
/*
2015-12-23 19:31:17 -05:00
* Break the URL path into C style argc/argv style arguments for our
* modules. Given "http://example.com/module/arg1/arg2", $this->argc
* will be 3 (integer) and $this->argv will contain:
* [0] => 'module'
* [1] => 'arg1'
* [2] => 'arg2'
*
*
* There will always be one argument. If provided a naked domain
* URL, $this->argv[0] is set to "home".
*/
2012-12-14 16:47:30 -05:00
$this->argv = explode('/', $this->cmd);
2015-12-23 19:31:17 -05:00
$this->argc = count($this->argv);
if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
2015-12-23 19:31:17 -05:00
$this->module = str_replace(".", "_", $this->argv[0]);
$this->module = str_replace("-", "_", $this->module);
} else {
2015-12-23 19:31:17 -05:00
$this->argc = 1;
$this->argv = array('home');
$this->module = 'home';
}
/*
2015-12-23 19:31:17 -05:00
* See if there is any page number information, and initialise
* pagination
*/
2010-12-10 23:21:34 -05:00
$this->pager['page'] = ((x($_GET, 'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
2015-12-23 19:31:17 -05:00
$this->pager['itemspage'] = 50;
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
if ($this->pager['start'] < 0) {
2015-12-23 19:31:17 -05:00
$this->pager['start'] = 0;
}
2015-12-23 19:31:17 -05:00
$this->pager['total'] = 0;
2010-07-01 19:48:07 -04:00
/*
2015-12-23 19:31:17 -05:00
* Detect mobile devices
*/
2010-07-18 23:49:10 -04:00
2015-12-23 19:31:17 -05:00
$mobile_detect = new Mobile_Detect();
$this->is_mobile = $mobile_detect->isMobile();
$this->is_tablet = $mobile_detect->isTablet();
2012-05-26 19:21:48 -04:00
2015-12-23 19:31:17 -05:00
// Friendica-Client
$this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)");
/*
2015-12-23 19:31:17 -05:00
* register template engines
*/
$dc = get_declared_classes();
foreach ($dc as $k) {
if (in_array("ITemplateEngine", class_implements($k))){
$this->register_template_engine($k);
2012-05-26 19:21:48 -04:00
}
2015-12-23 19:31:17 -05:00
}
2012-03-14 23:36:23 -04:00
2016-01-25 09:20:58 -05:00
self::$a = $this;
2015-12-23 19:31:17 -05:00
}
public static function get_basepath() {
2015-12-23 19:31:17 -05:00
$basepath = get_config("system", "basepath");
2010-07-18 23:49:10 -04:00
if ($basepath == "") {
2015-12-23 19:31:17 -05:00
$basepath = dirname(__FILE__);
}
if ($basepath == "") {
2015-12-23 19:31:17 -05:00
$basepath = $_SERVER["DOCUMENT_ROOT"];
}
if ($basepath == "") {
2015-12-23 19:31:17 -05:00
$basepath = $_SERVER["PWD"];
}
return $basepath;
2015-12-23 19:31:17 -05:00
}
2015-12-23 19:31:17 -05:00
function get_scheme() {
return $this->scheme;
2015-12-23 19:31:17 -05:00
}
/**
* @brief Retrieves the Friendica instance base URL
*
* This function assembles the base URL from multiple parts:
* - Protocol is determined either by the request or a combination of
* system.ssl_policy and the $ssl parameter.
* - Host name is determined either by system.hostname or inferred from request
* - Path is inferred from SCRIPT_NAME
*
* Note: $ssl parameter value doesn't directly correlate with the resulting protocol
*
* @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
* @return string Friendica server base URL
*/
2015-12-23 19:31:17 -05:00
function get_baseurl($ssl = false) {
2016-01-25 09:20:58 -05:00
// Is the function called statically?
2016-12-27 09:47:53 -05:00
if (!(isset($this) && get_class($this) == __CLASS__)) {
2016-10-28 12:29:55 -04:00
return self::$a->get_baseurl($ssl);
}
2016-01-25 09:20:58 -05:00
$scheme = $this->scheme;
if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
2017-01-17 14:33:06 -05:00
$scheme = 'https';
}
2017-01-17 14:33:06 -05:00
// Basically, we have $ssl = true on any links which can only be seen by a logged in user
// (and also the login link). Anything seen by an outsider will have it turned off.
2017-01-17 14:33:06 -05:00
if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
if ($ssl) {
$scheme = 'https';
} else {
$scheme = 'http';
}
}
2015-12-23 19:31:17 -05:00
2017-01-17 14:33:06 -05:00
if (Config::get('config', 'hostname') != '') {
$this->hostname = Config::get('config', 'hostname');
2016-10-28 05:51:39 -04:00
}
return $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
2015-12-23 19:31:17 -05:00
}
/**
* @brief Initializes the baseurl components
*
* Clears the baseurl cache to prevent inconstistencies
*
* @param string $url
*/
2015-12-23 19:31:17 -05:00
function set_baseurl($url) {
$parsed = @parse_url($url);
if ($parsed) {
2015-12-23 19:31:17 -05:00
$this->scheme = $parsed['scheme'];
$hostname = $parsed['host'];
if (x($parsed, 'port')) {
2015-12-23 19:31:17 -05:00
$hostname .= ':' . $parsed['port'];
}
if (x($parsed, 'path')) {
$this->path = trim($parsed['path'], '\\/');
}
2015-12-23 19:31:17 -05:00
if (file_exists(".htpreconfig.php")) {
include ".htpreconfig.php";
}
2015-12-23 19:31:17 -05:00
if (get_config('config', 'hostname') != '') {
$this->hostname = get_config('config', 'hostname');
}
if (!isset($this->hostname) OR ($this->hostname == '')) {
2015-12-23 19:31:17 -05:00
$this->hostname = $hostname;
}
}
2015-12-23 19:31:17 -05:00
}
2010-07-19 02:23:18 -04:00
2015-12-23 19:31:17 -05:00
function get_hostname() {
if (get_config('config', 'hostname') != "") {
$this->hostname = get_config('config', 'hostname');
}
2010-07-18 23:49:10 -04:00
2015-12-23 19:31:17 -05:00
return $this->hostname;
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
function set_hostname($h) {
$this->hostname = $h;
}
2010-07-20 01:52:31 -04:00
2015-12-23 19:31:17 -05:00
function set_path($p) {
$this->path = trim(trim($p), '/');
2015-12-23 19:31:17 -05:00
}
2015-12-23 19:31:17 -05:00
function get_path() {
return $this->path;
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
function set_pager_total($n) {
$this->pager['total'] = intval($n);
}
2015-12-05 18:18:59 -05:00
2015-12-23 19:31:17 -05:00
function set_pager_itemspage($n) {
$this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
}
2015-12-05 18:18:59 -05:00
2015-12-23 19:31:17 -05:00
function set_pager_page($n) {
$this->pager['page'] = $n;
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
}
2015-12-23 19:31:17 -05:00
function init_pagehead() {
$interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000);
2015-12-23 19:31:17 -05:00
// If the update is "deactivated" set it to the highest integer number (~24 days)
if ($interval < 0) {
2015-12-23 19:31:17 -05:00
$interval = 2147483647;
}
if ($interval < 10000) {
2015-12-23 19:31:17 -05:00
$interval = 40000;
}
2015-12-23 19:31:17 -05:00
// compose the page title from the sitename and the
// current module called
if (!$this->module == '') {
$this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
2015-12-23 19:31:17 -05:00
} else {
$this->page['title'] = $this->config['sitename'];
}
2015-12-23 19:31:17 -05:00
/* put the head template at the beginning of page['htmlhead']
* since the code added by the modules frequently depends on it
* being first
*/
if (!isset($this->page['htmlhead'])) {
2015-12-23 19:31:17 -05:00
$this->page['htmlhead'] = '';
}
2015-12-23 19:31:17 -05:00
// If we're using Smarty, then doing replace_macros() will replace
// any unrecognized variables with a blank string. Since we delay
// replacing $stylesheet until later, we need to replace it now
// with another variable name
if ($this->theme['template_engine'] === 'smarty3') {
2015-12-23 19:31:17 -05:00
$stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
} else {
2015-12-23 19:31:17 -05:00
$stylesheet = '$stylesheet';
}
2015-12-23 19:31:17 -05:00
$shortcut_icon = get_config("system", "shortcut_icon");
if ($shortcut_icon == "") {
2016-02-17 06:18:36 -05:00
$shortcut_icon = "images/friendica-32.png";
}
2015-12-23 19:31:17 -05:00
$touch_icon = get_config("system", "touch_icon");
if ($touch_icon == "") {
2016-02-17 06:18:36 -05:00
$touch_icon = "images/friendica-128.png";
}
2015-12-23 19:31:17 -05:00
// get data wich is needed for infinite scroll on the network page
$invinite_scroll = infinite_scroll_data($this->module);
2015-12-23 19:31:17 -05:00
$tpl = get_markup_template('head.tpl');
$this->page['htmlhead'] = replace_macros($tpl,array(
'$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
'$local_user' => local_user(),
'$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
'$delitem' => t('Delete this item?'),
'$showmore' => t('show more'),
'$showfewer' => t('show fewer'),
'$update_interval' => $interval,
'$shortcut_icon' => $shortcut_icon,
'$touch_icon' => $touch_icon,
'$stylesheet' => $stylesheet,
'$infinite_scroll' => $invinite_scroll,
2015-12-23 19:31:17 -05:00
)) . $this->page['htmlhead'];
}
2015-12-23 19:31:17 -05:00
function init_page_end() {
if (!isset($this->page['end'])) {
2015-12-23 19:31:17 -05:00
$this->page['end'] = '';
}
2015-12-23 19:31:17 -05:00
$tpl = get_markup_template('end.tpl');
$this->page['end'] = replace_macros($tpl,array(
'$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
)) . $this->page['end'];
}
2015-12-23 19:31:17 -05:00
function set_curl_code($code) {
$this->curl_code = $code;
}
2015-12-23 19:31:17 -05:00
function get_curl_code() {
return $this->curl_code;
}
2015-12-23 19:31:17 -05:00
function set_curl_content_type($content_type) {
$this->curl_content_type = $content_type;
}
2015-12-23 19:31:17 -05:00
function get_curl_content_type() {
return $this->curl_content_type;
}
2015-12-23 19:31:17 -05:00
function set_curl_headers($headers) {
$this->curl_headers = $headers;
}
2015-12-23 19:31:17 -05:00
function get_curl_headers() {
return $this->curl_headers;
}
2015-12-23 19:31:17 -05:00
function get_cached_avatar_image($avatar_image){
2016-01-15 17:27:25 -05:00
return $avatar_image;
2015-12-23 19:31:17 -05:00
}
2016-02-17 02:08:28 -05:00
/**
* @brief Removes the baseurl from an url. This avoids some mixed content problems.
*
* @param string $orig_url
2016-02-17 02:08:28 -05:00
*
* @return string The cleaned url
*/
function remove_baseurl($orig_url){
2016-02-17 02:08:28 -05:00
// Is the function called statically?
2016-12-27 09:47:53 -05:00
if (!(isset($this) && get_class($this) == __CLASS__)) {
return self::$a->remove_baseurl($orig_url);
}
2016-02-17 02:08:28 -05:00
// Remove the hostname from the url if it is an internal link
$nurl = normalise_link($orig_url);
2016-02-17 02:08:28 -05:00
$base = normalise_link($this->get_baseurl());
$url = str_replace($base."/", "", $nurl);
// if it is an external link return the orignal value
if ($url == normalise_link($orig_url)) {
return $orig_url;
} else {
return $url;
}
2016-02-17 02:08:28 -05:00
}
2015-12-23 19:31:17 -05:00
/**
* @brief Register template engine class
*
2015-12-23 19:31:17 -05:00
* If $name is "", is used class static property $class::$name
*
2015-12-23 19:31:17 -05:00
* @param string $class
* @param string $name
*/
function register_template_engine($class, $name = '') {
/// @TODO Really === and not just == ?
if ($name === "") {
2015-12-23 19:31:17 -05:00
$v = get_class_vars( $class );
if (x($v,"name")) $name = $v['name'];
}
if ($name === "") {
2015-12-23 19:31:17 -05:00
echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
killme();
}
2015-12-23 19:31:17 -05:00
$this->template_engines[$name] = $class;
}
2015-12-23 19:31:17 -05:00
/**
* @brief Return template engine instance.
*
2015-12-23 19:31:17 -05:00
* If $name is not defined, return engine defined by theme,
* or default
*
* @param strin $name Template engine name
* @return object Template Engine instance
*/
function template_engine($name = '') {
/// @TODO really type-check included?
if ($name !== "") {
2015-12-23 19:31:17 -05:00
$template_engine = $name;
} else {
$template_engine = 'smarty3';
if (x($this->theme, 'template_engine')) {
$template_engine = $this->theme['template_engine'];
}
}
2015-12-23 19:31:17 -05:00
if (isset($this->template_engines[$template_engine])){
if (isset($this->template_engine_instance[$template_engine])){
2015-12-23 19:31:17 -05:00
return $this->template_engine_instance[$template_engine];
} else {
$class = $this->template_engines[$template_engine];
$obj = new $class;
$this->template_engine_instance[$template_engine] = $obj;
return $obj;
}
}
2015-12-23 19:31:17 -05:00
echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
}
2015-12-23 19:31:17 -05:00
/**
* @brief Returns the active template engine.
*
* @return string
*/
function get_template_engine() {
return $this->theme['template_engine'];
}
2013-01-27 07:57:44 -05:00
2015-12-23 19:31:17 -05:00
function set_template_engine($engine = 'smarty3') {
$this->theme['template_engine'] = $engine;
}
2015-12-23 19:31:17 -05:00
function get_template_ldelim($engine = 'smarty3') {
return $this->ldelim[$engine];
}
2015-12-23 19:31:17 -05:00
function get_template_rdelim($engine = 'smarty3') {
return $this->rdelim[$engine];
}
2015-12-23 19:31:17 -05:00
function save_timestamp($stamp, $value) {
if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
return;
}
2015-12-23 19:31:17 -05:00
$duration = (float)(microtime(true)-$stamp);
if (!isset($this->performance[$value])) {
// Prevent ugly E_NOTICE
$this->performance[$value] = 0;
}
2015-12-23 19:31:17 -05:00
$this->performance[$value] += (float)$duration;
$this->performance["marktime"] += (float)$duration;
$callstack = $this->callstack();
if (!isset($this->callstack[$value][$callstack])) {
// Prevent ugly E_NOTICE
$this->callstack[$value][$callstack] = 0;
}
$this->callstack[$value][$callstack] += (float)$duration;
}
/**
* @brief Log active processes into the "process" table
*/
function start_process() {
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
$command = basename($trace[0]["file"]);
$this->remove_inactive_processes();
q("START TRANSACTION");
$r = q("SELECT `pid` FROM `process` WHERE `pid` = %d", intval(getmypid()));
if (!dbm::is_result($r)) {
q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')",
intval(getmypid()),
dbesc($command),
dbesc(datetime_convert()));
}
q("COMMIT");
}
/**
* @brief Remove inactive processes
*/
function remove_inactive_processes() {
q("START TRANSACTION");
$r = q("SELECT `pid` FROM `process`");
if (dbm::is_result($r)) {
foreach ($r AS $process) {
if (!posix_kill($process["pid"], 0)) {
q("DELETE FROM `process` WHERE `pid` = %d", intval($process["pid"]));
}
}
}
q("COMMIT");
}
/**
* @brief Remove the active process from the "process" table
*/
function end_process() {
q("DELETE FROM `process` WHERE `pid` = %d", intval(getmypid()));
}
/**
* @brief Returns a string with a callstack. Can be used for logging.
*
* @return string
*/
function callstack() {
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
// We remove the first two items from the list since they contain data that we don't need.
array_shift($trace);
array_shift($trace);
$callstack = array();
foreach ($trace AS $func) {
$callstack[] = $func["function"];
}
return implode(", ", $callstack);
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
function get_useragent() {
return
FRIENDICA_PLATFORM . " '" .
FRIENDICA_CODENAME . "' " .
FRIENDICA_VERSION . "-" .
DB_UPDATE_VERSION . "; " .
$this->get_baseurl();
}
2010-10-06 20:40:58 -04:00
2015-12-23 19:31:17 -05:00
function is_friendica_app() {
return $this->is_friendica_app;
2015-12-23 19:31:17 -05:00
}
2010-07-01 19:48:07 -04:00
/**
* @brief Checks if the site is called via a backend process
*
* This isn't a perfect solution. But we need this check very early.
* So we cannot wait until the modules are loaded.
*
* @return bool Is it a known backend?
*/
function is_backend() {
static $backends = array();
$backends[] = "_well_known";
$backends[] = "api";
$backends[] = "dfrn_notify";
$backends[] = "fetch";
$backends[] = "hcard";
$backends[] = "hostxrd";
$backends[] = "nodeinfo";
$backends[] = "noscrape";
$backends[] = "p";
$backends[] = "poco";
$backends[] = "post";
$backends[] = "proxy";
$backends[] = "pubsub";
$backends[] = "pubsubhubbub";
$backends[] = "receive";
$backends[] = "rsd_xml";
$backends[] = "salmon";
$backends[] = "statistics_json";
$backends[] = "xrd";
// Check if current module is in backend or backend flag is set
return (in_array($this->module, $backends) || $this->backend);
}
/**
* @brief Checks if the maximum number of database processes is reached
*
* @return bool Is the limit reached?
*/
function max_processes_reached() {
if ($this->is_backend()) {
$process = "backend";
$max_processes = get_config('system', 'max_processes_backend');
if (intval($max_processes) == 0) {
$max_processes = 5;
}
} else {
$process = "frontend";
$max_processes = get_config('system', 'max_processes_frontend');
if (intval($max_processes) == 0) {
$max_processes = 20;
}
}
$processlist = dbm::processlist();
if ($processlist["list"] != "") {
logger("Processcheck: Processes: ".$processlist["amount"]." - Processlist: ".$processlist["list"], LOGGER_DEBUG);
if ($processlist["amount"] > $max_processes) {
logger("Processcheck: Maximum number of processes for ".$process." tasks (".$max_processes.") reached.", LOGGER_DEBUG);
return true;
}
}
return false;
}
2016-03-08 16:42:37 -05:00
/**
* @brief Checks if the maximum load is reached
*
* @return bool Is the load reached?
*/
function maxload_reached() {
if ($this->is_backend()) {
$process = "backend";
$maxsysload = intval(get_config('system', 'maxloadavg'));
if ($maxsysload < 1) {
$maxsysload = 50;
}
} else {
$process = "frontend";
$maxsysload = intval(get_config('system','maxloadavg_frontend'));
if ($maxsysload < 1) {
$maxsysload = 50;
}
}
$load = current_load();
if ($load) {
if (intval($load) > $maxsysload) {
logger('system: load '.$load.' for '.$process.' tasks ('.$maxsysload.') too high.');
return true;
}
}
return false;
}
function proc_run($args) {
if (!function_exists("proc_open")) {
return;
}
2017-02-27 01:27:22 -05:00
// If the last worker fork was less than 10 seconds before then don't fork another one.
// This should prevent the forking of masses of workers.
$cachekey = "app:proc_run:started";
$result = Cache::get($cachekey);
if (!is_null($result) AND (time() - $result) < 10) {
return;
}
2017-02-27 01:27:22 -05:00
// Set the timestamp of the last proc_run
Cache::set($cachekey, time(), CACHE_MINUTE);
array_unshift($args, ((x($this->config,'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
// add baseurl to args. cli scripts can't construct it
$args[] = $this->get_baseurl();
for ($x = 0; $x < count($args); $x ++) {
$args[$x] = escapeshellarg($args[$x]);
}
$cmdline = implode($args, " ");
if (get_config('system', 'proc_windows')) {
proc_close(proc_open('cmd /c start /b ' . $cmdline, array(), $foo, dirname(__FILE__)));
} else {
proc_close(proc_open($cmdline . " &", array(), $foo, dirname(__FILE__)));
}
}
/**
* @brief Returns the system user that is executing the script
*
* This mostly returns something like "www-data".
*
* @return string system username
*/
static function systemuser() {
if (!function_exists('posix_getpwuid') OR !function_exists('posix_geteuid')) {
return '';
}
$processUser = posix_getpwuid(posix_geteuid());
return $processUser['name'];
}
/**
* @brief Checks if a given directory is usable for the system
*
* @return boolean the directory is usable
*/
static function directory_usable($directory) {
if ($directory == '') {
logger("Directory is empty. This shouldn't happen.", LOGGER_DEBUG);
return false;
}
if (!file_exists($directory)) {
logger('Path "'.$directory.'" does not exist for user '.self::systemuser(), LOGGER_DEBUG);
return false;
}
if (is_file($directory)) {
logger('Path "'.$directory.'" is a file for user '.self::systemuser(), LOGGER_DEBUG);
return false;
}
if (!is_dir($directory)) {
logger('Path "'.$directory.'" is not a directory for user '.self::systemuser(), LOGGER_DEBUG);
return false;
}
if (!is_writable($directory)) {
2017-02-19 03:23:21 -05:00
logger('Path "'.$directory.'" is not writable for user '.self::systemuser(), LOGGER_DEBUG);
return false;
}
return true;
}
2015-12-23 19:31:17 -05:00
}
2010-09-27 20:16:52 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Retrieve the App structure
*
2015-12-23 19:31:17 -05:00
* Useful in functions which require it but don't get it passed to them
*/
function get_app() {
global $a;
return $a;
}
2010-07-01 19:48:07 -04:00
2010-10-06 20:40:58 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Multi-purpose function to check variable state.
*
* Usage: x($var) or $x($array, 'key')
*
* returns false if variable/key is not set
* if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0.
* e.g. x('') or x(0) returns 0;
*
* @param string|array $s variable to check
* @param string $k key inside the array to check
*
* @return bool|int
*/
function x($s,$k = NULL) {
if ($k != NULL) {
if ((is_array($s)) && (array_key_exists($k,$s))) {
if ($s[$k]) {
2015-12-23 19:31:17 -05:00
return (int) 1;
}
2015-12-23 19:31:17 -05:00
return (int) 0;
}
2015-12-23 19:31:17 -05:00
return false;
} else {
if (isset($s)) {
if ($s) {
2015-12-23 19:31:17 -05:00
return (int) 1;
2010-07-01 19:48:07 -04:00
}
2015-12-23 19:31:17 -05:00
return (int) 0;
2010-07-01 19:48:07 -04:00
}
2015-12-23 19:31:17 -05:00
return false;
2010-07-01 19:48:07 -04:00
}
}
2010-07-01 19:48:07 -04:00
2010-09-27 20:16:52 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Called from db initialisation if db is dead.
*/
function system_unavailable() {
include('system_unavailable.php');
system_down();
killme();
}
2010-07-01 19:48:07 -04:00
2011-06-14 05:16:27 -04:00
function clean_urls() {
$a = get_app();
return true;
}
function z_path() {
$base = App::get_baseurl();
if (! clean_urls()) {
$base .= '/?q=';
}
return $base;
}
2015-12-23 19:31:17 -05:00
/**
* @brief Returns the baseurl.
*
* @see App::get_baseurl()
*
* @return string
* @TODO Maybe super-flous and deprecated? Seems to only wrap App::get_baseurl()
2015-12-23 19:31:17 -05:00
*/
function z_root() {
return App::get_baseurl();
}
2015-12-23 19:31:17 -05:00
/**
* @brief Return absolut URL for given $path.
*
* @param string $path
*
* @return string
*/
function absurl($path) {
if (strpos($path,'/') === 0) {
return z_path() . $path;
}
return $path;
}
2015-12-23 19:31:17 -05:00
/**
* @brief Function to check if request was an AJAX (xmlhttprequest) request.
*
* @return boolean
*/
function is_ajax() {
return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
}
function check_db() {
$build = get_config('system','build');
if (! x($build)) {
set_config('system','build',DB_UPDATE_VERSION);
2013-01-19 01:38:49 -05:00
$build = DB_UPDATE_VERSION;
}
if ($build != DB_UPDATE_VERSION) {
proc_run(PRIORITY_CRITICAL, 'include/dbupdate.php');
}
}
2015-12-23 19:31:17 -05:00
/**
* Sets the base url for use in cmdline programs which don't have
* $_SERVER variables
*/
function check_url(App $a) {
2015-12-23 19:31:17 -05:00
$url = get_config('system','url');
2015-12-23 19:31:17 -05:00
// if the url isn't set or the stored url is radically different
// than the currently visited url, store the current value accordingly.
// "Radically different" ignores common variations such as http vs https
// and www.example.com vs example.com.
// We will only change the url to an ip address if there is no existing setting
if (! x($url)) {
$url = set_config('system','url',App::get_baseurl());
}
if ((! link_compare($url,App::get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) {
$url = set_config('system','url',App::get_baseurl());
}
2015-12-23 19:31:17 -05:00
return;
}
2015-12-23 19:31:17 -05:00
/**
* @brief Automatic database updates
*/
function update_db(App $a) {
2015-12-23 19:31:17 -05:00
$build = get_config('system','build');
if (! x($build)) {
2015-12-23 19:31:17 -05:00
$build = set_config('system','build',DB_UPDATE_VERSION);
}
2012-08-13 19:46:24 -04:00
if ($build != DB_UPDATE_VERSION) {
2015-12-23 19:31:17 -05:00
$stored = intval($build);
$current = intval(DB_UPDATE_VERSION);
if ($stored < $current) {
Config::load('database');
2015-12-23 19:31:17 -05:00
// We're reporting a different version than what is currently installed.
// Run any existing update scripts to bring the database up to current.
2013-01-19 01:38:49 -05:00
2015-12-23 19:31:17 -05:00
// make sure that boot.php and update.php are the same release, we might be
// updating right this very second and the correct version of the update.php
// file may not be here yet. This can happen on a very busy site.
2013-01-19 01:38:49 -05:00
if (DB_UPDATE_VERSION == UPDATE_VERSION) {
2015-12-23 19:31:17 -05:00
// Compare the current structure with the defined structure
$t = get_config('database','dbupdate_'.DB_UPDATE_VERSION);
if ($t !== false) {
2015-12-23 19:31:17 -05:00
return;
}
2015-12-23 19:31:17 -05:00
set_config('database','dbupdate_'.DB_UPDATE_VERSION, time());
// run old update routine (wich could modify the schema and
// conflits with new routine)
for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) {
$r = run_update_function($x);
if (!$r) {
break;
}
}
if ($stored < NEW_UPDATE_ROUTINE_VERSION) {
$stored = NEW_UPDATE_ROUTINE_VERSION;
2015-12-23 19:31:17 -05:00
}
2013-01-19 01:38:49 -05:00
2015-12-23 19:31:17 -05:00
// run new update routine
// it update the structure in one call
$retval = update_structure(false, true);
if ($retval) {
2015-12-23 19:31:17 -05:00
update_fail(
DB_UPDATE_VERSION,
$retval
);
return;
} else {
set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success');
}
// run any left update_nnnn functions in update.php
for ($x = $stored; $x < $current; $x ++) {
2015-12-23 19:31:17 -05:00
$r = run_update_function($x);
if (!$r) {
break;
}
2010-08-14 22:31:10 -04:00
}
}
}
2013-01-14 22:31:32 -05:00
}
2015-12-23 19:31:17 -05:00
return;
2013-01-14 22:31:32 -05:00
}
2015-12-23 19:31:17 -05:00
function run_update_function($x) {
if (function_exists('update_' . $x)) {
2015-12-23 19:31:17 -05:00
// There could be a lot of processes running or about to run.
// We want exactly one process to run the update command.
// So store the fact that we're taking responsibility
// after first checking to see if somebody else already has.
// If the update fails or times-out completely you may need to
// delete the config entry to try again.
$t = get_config('database','update_' . $x);
if ($t !== false) {
2015-12-23 19:31:17 -05:00
return false;
}
2015-12-23 19:31:17 -05:00
set_config('database','update_' . $x, time());
// call the specific update
$func = 'update_' . $x;
$retval = $func();
if ($retval) {
2015-12-23 19:31:17 -05:00
//send the administrator an e-mail
update_fail(
$x,
sprintf(t('Update %s failed. See error logs.'), $x)
);
return false;
} else {
set_config('database','update_' . $x, 'success');
set_config('system','build', $x + 1);
return true;
}
2015-12-23 19:31:17 -05:00
} else {
set_config('database','update_' . $x, 'success');
set_config('system','build', $x + 1);
return true;
}
2015-12-23 19:31:17 -05:00
return true;
}
2013-01-14 22:31:32 -05:00
/**
* @brief Synchronise plugins:
*
* $a->config['system']['addon'] contains a comma-separated list of names
* of plugins/addons which are used on this system.
* Go through the database list of already installed addons, and if we have
* an entry, but it isn't in the config list, call the uninstall procedure
* and mark it uninstalled in the database (for now we'll remove it).
* Then go through the config list and if we have a plugin that isn't installed,
* call the install procedure and add it to the database.
*
* @param App $a
*
*/
function check_plugins(App $a) {
2013-01-14 22:31:32 -05:00
2015-12-23 19:31:17 -05:00
$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
if (dbm::is_result($r)) {
2015-12-23 19:31:17 -05:00
$installed = $r;
} else {
2015-12-23 19:31:17 -05:00
$installed = array();
}
2015-12-23 19:31:17 -05:00
$plugins = get_config('system','addon');
$plugins_arr = array();
if ($plugins) {
2015-12-23 19:31:17 -05:00
$plugins_arr = explode(',',str_replace(' ', '',$plugins));
}
2015-12-23 19:31:17 -05:00
$a->plugins = $plugins_arr;
2015-12-23 19:31:17 -05:00
$installed_arr = array();
if (count($installed)) {
foreach ($installed as $i) {
if (! in_array($i['name'],$plugins_arr)) {
2015-12-23 19:31:17 -05:00
uninstall_plugin($i['name']);
} else {
2015-12-23 19:31:17 -05:00
$installed_arr[] = $i['name'];
}
}
2015-12-23 19:31:17 -05:00
}
if (count($plugins_arr)) {
foreach ($plugins_arr as $p) {
if (! in_array($p,$installed_arr)) {
2015-12-23 19:31:17 -05:00
install_plugin($p);
}
}
2015-12-23 19:31:17 -05:00
}
2011-03-09 05:12:32 -05:00
2015-12-23 19:31:17 -05:00
load_hooks();
2015-12-23 19:31:17 -05:00
return;
}
2015-03-09 15:59:57 -04:00
function get_guid($size=16, $prefix = "") {
if ($prefix == "") {
$a = get_app();
$prefix = hash("crc32", $a->get_hostname());
}
while (strlen($prefix) < ($size - 13)) {
2015-03-09 15:59:57 -04:00
$prefix .= mt_rand();
}
2015-03-09 15:59:57 -04:00
if ($size >= 24) {
$prefix = substr($prefix, 0, $size - 22);
return(str_replace(".", "", uniqid($prefix, true)));
} else {
$prefix = substr($prefix, 0, max($size - 13, 0));
2015-03-09 15:59:57 -04:00
return(uniqid($prefix));
}
}
2010-07-01 19:48:07 -04:00
/**
2015-12-23 19:31:17 -05:00
* @brief Wrapper for adding a login box.
*
2015-12-23 19:31:17 -05:00
* @param bool $register
* If $register == true provide a registration link.
* This will most always depend on the value of $a->config['register_policy'].
* @param bool $hiddens
*
2015-12-23 19:31:17 -05:00
* @return string
* Returns the complete html for inserting into the page
*
* @hooks 'login_hook'
* string $o
2015-12-23 19:31:17 -05:00
*/
function login($register = false, $hiddens=false) {
$a = get_app();
$o = "";
$reg = false;
if ($register) {
$reg = array(
'title' => t('Create a New Account'),
'desc' => t('Register')
);
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
$noid = get_config('system','no_openid');
2016-02-17 06:18:36 -05:00
$dest_url = $a->query_string;
if (local_user()) {
2015-12-23 19:31:17 -05:00
$tpl = get_markup_template("logout.tpl");
} else {
2015-12-23 19:31:17 -05:00
$a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array(
'$baseurl' => $a->get_baseurl(true)
2015-12-23 19:31:17 -05:00
));
2012-08-18 16:47:59 -04:00
2015-12-23 19:31:17 -05:00
$tpl = get_markup_template("login.tpl");
$_SESSION['return_url'] = $a->query_string;
$a->module = 'login';
}
2011-04-30 20:24:37 -04:00
2015-12-23 19:31:17 -05:00
$o .= replace_macros($tpl, array(
'$dest_url' => $dest_url,
'$logout' => t('Logout'),
'$login' => t('Login'),
'$lname' => array('username', t('Nickname or Email: ') , '', ''),
'$lpassword' => array('password', t('Password: '), '', ''),
'$lremember' => array('remember', t('Remember me'), 0, ''),
'$openid' => !$noid,
'$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''),
'$hiddens' => $hiddens,
'$register' => $reg,
2015-12-23 19:31:17 -05:00
'$lostpass' => t('Forgot your password?'),
'$lostlink' => t('Password Reset'),
'$tostitle' => t('Website Terms of Service'),
'$toslink' => t('terms of service'),
2012-12-25 14:28:24 -05:00
'$privacytitle' => t('Website Privacy Policy'),
'$privacylink' => t('privacy policy'),
2012-12-25 14:28:24 -05:00
2015-12-23 19:31:17 -05:00
));
2015-12-23 19:31:17 -05:00
call_hooks('login_hook',$o);
2011-09-01 09:29:29 -04:00
2015-12-23 19:31:17 -05:00
return $o;
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Used to end the current process, after saving session state.
*/
function killme() {
if (!get_app()->is_backend()) {
session_write_close();
}
exit();
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Redirect to another URL and terminate this process.
*/
function goaway($s) {
if (!strstr(normalise_link($s), "http://")) {
$s = App::get_baseurl()."/".$s;
}
2015-12-23 19:31:17 -05:00
header("Location: $s");
killme();
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Returns the user id of locally logged in user or false.
*
2015-12-23 19:31:17 -05:00
* @return int|bool user id or false
*/
function local_user() {
if (x($_SESSION, 'authenticated') && x($_SESSION, 'uid')) {
2015-12-23 19:31:17 -05:00
return intval($_SESSION['uid']);
}
2015-12-23 19:31:17 -05:00
return false;
}
2010-07-01 19:48:07 -04:00
/**
* @brief Returns the public contact id of logged in user or false.
*
* @return int|bool public contact id or false
*/
function public_contact() {
static $public_contact_id = false;
if (!$public_contact_id && x($_SESSION, 'authenticated')) {
if (x($_SESSION, 'my_address')) {
// Local user
$public_contact_id = intval(get_contact($_SESSION['my_address'], 0));
} elseif (x($_SESSION, 'visitor_home')) {
// Remote user
$public_contact_id = intval(get_contact($_SESSION['visitor_home'], 0));
}
} elseif (!x($_SESSION, 'authenticated')) {
$public_contact_id = false;
}
return $public_contact_id;
}
2015-12-23 19:31:17 -05:00
/**
2015-12-24 05:58:42 -05:00
* @brief Returns contact id of authenticated site visitor or false
*
2015-12-23 19:31:17 -05:00
* @return int|bool visitor_id or false
*/
function remote_user() {
if ((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) {
2015-12-23 19:31:17 -05:00
return intval($_SESSION['visitor_id']);
}
2015-12-23 19:31:17 -05:00
return false;
}
2010-07-01 19:48:07 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Show an error message to user.
*
* This function save text in session, to be shown to the user at next page load
*
* @param string $s - Text of notice
*/
function notice($s) {
$a = get_app();
if (! x($_SESSION,'sysmsg')) {
$_SESSION['sysmsg'] = array();
}
if ($a->interactive) {
2015-12-23 19:31:17 -05:00
$_SESSION['sysmsg'][] = $s;
}
}
2015-12-23 19:31:17 -05:00
/**
* @brief Show an info message to user.
*
* This function save text in session, to be shown to the user at next page load
*
* @param string $s - Text of notice
*/
function info($s) {
$a = get_app();
if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) {
2015-12-23 19:31:17 -05:00
return;
}
if (! x($_SESSION,'sysmsg_info')) {
$_SESSION['sysmsg_info'] = array();
}
if ($a->interactive) {
2015-12-23 19:31:17 -05:00
$_SESSION['sysmsg_info'][] = $s;
}
2015-12-23 19:31:17 -05:00
}
2010-09-27 20:16:52 -04:00
2015-12-23 19:31:17 -05:00
/**
* @brief Wrapper around config to limit the text length of an incoming message
*
* @return int
*/
function get_max_import_size() {
$a = get_app();
2015-12-23 19:31:17 -05:00
return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 );
}
/**
* @brief Wrap calls to proc_close(proc_open()) and call hook
* so plugins can take part in process :)
*
2017-02-27 01:27:22 -05:00
* @param (integer|array) priority or parameter array, $cmd atrings are deprecated and are ignored
*
* next args are passed as $cmd command line
* or: proc_run(PRIORITY_HIGH, "include/notifier.php", "drop", $drop_id);
* or: proc_run(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "include/create_shadowentry.php", $post_id);
*
* @note $cmd and string args are surrounded with ""
*
* @hooks 'proc_run'
* array $arr
*/
2015-12-23 19:31:17 -05:00
function proc_run($cmd){
2015-12-23 19:31:17 -05:00
$a = get_app();
$proc_args = func_get_args();
2012-05-20 21:30:02 -04:00
$args = array();
if (!count($proc_args)) {
2015-12-23 19:31:17 -05:00
return;
}
2012-05-20 21:30:02 -04:00
// Preserve the first parameter
// It could contain a command, the priority or an parameter array
// If we use the parameter array we have to protect it from the following function
$run_parameter = array_shift($proc_args);
2012-05-20 21:30:02 -04:00
// expand any arrays
foreach ($proc_args as $arg) {
if (is_array($arg)) {
foreach ($arg as $n) {
$args[] = $n;
2012-05-20 21:30:02 -04:00
}
} else {
$args[] = $arg;
}
2015-12-23 19:31:17 -05:00
}
2012-05-20 21:30:02 -04:00
// Now we add the run parameters back to the array
array_unshift($args, $run_parameter);
2015-12-23 19:31:17 -05:00
$arr = array('args' => $args, 'run_cmd' => true);
2015-12-23 19:31:17 -05:00
call_hooks("proc_run", $arr);
if (!$arr['run_cmd'] OR !count($args)) {
2015-12-23 19:31:17 -05:00
return;
}
2011-02-23 18:16:12 -05:00
$priority = PRIORITY_MEDIUM;
$dont_fork = get_config("system", "worker_dont_fork");
if (is_int($run_parameter)) {
$priority = $run_parameter;
} elseif (is_array($run_parameter)) {
if (isset($run_parameter['priority'])) {
$priority = $run_parameter['priority'];
}
if (isset($run_parameter['dont_fork'])) {
$dont_fork = $run_parameter['dont_fork'];
}
}
2012-06-24 03:56:27 -04:00
$argv = $args;
array_shift($argv);
$parameters = json_encode($argv);
$found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'",
dbesc($parameters));
2015-12-23 19:31:17 -05:00
if (!dbm::is_result($found)) {
q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`)
VALUES ('%s', '%s', %d)",
dbesc($parameters),
dbesc(datetime_convert()),
intval($priority));
}
// Should we quit and wait for the poller to be called as a cronjob?
if ($dont_fork) {
return;
}
// Checking number of workers
2017-02-27 18:37:15 -05:00
$workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` > '%s'", dbesc(NULL_DATE));
// Get number of allowed number of worker threads
$queues = intval(get_config("system", "worker_queues"));
if ($queues == 0) {
$queues = 4;
}
// If there are already enough workers running, don't fork another one
if ($workers[0]["workers"] >= $queues) {
return;
}
// Now call the poller to execute the jobs that we just added to the queue
2017-02-27 01:27:22 -05:00
$args = array("include/poller.php", "no_cron");
$a->proc_run($args);
}
2015-12-23 19:31:17 -05:00
function current_theme(){
$app_base_themes = array('duepuntozero', 'dispy', 'quattro');
2015-12-23 19:31:17 -05:00
$a = get_app();
2015-12-23 19:31:17 -05:00
$page_theme = null;
2015-12-23 19:31:17 -05:00
// Find the theme that belongs to the user whose stuff we are looking at
if ($a->profile_uid && ($a->profile_uid != local_user())) {
2015-12-23 19:31:17 -05:00
$r = q("select theme from user where uid = %d limit 1",
intval($a->profile_uid)
);
if (dbm::is_result($r)) {
2015-12-23 19:31:17 -05:00
$page_theme = $r[0]['theme'];
}
2015-12-23 19:31:17 -05:00
}
2015-12-23 19:31:17 -05:00
// Allow folks to over-rule user themes and always use their own on their own site.
// This works only if the user is on the same server
if ($page_theme && local_user() && (local_user() != $a->profile_uid)) {
if (get_pconfig(local_user(),'system','always_my_theme')) {
2015-12-23 19:31:17 -05:00
$page_theme = null;
}
2015-12-23 19:31:17 -05:00
}
// $mobile_detect = new Mobile_Detect();
// $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
2015-12-23 19:31:17 -05:00
$is_mobile = $a->is_mobile || $a->is_tablet;
2013-01-03 12:53:11 -05:00
$standard_system_theme = Config::get('system', 'theme', '');
2015-12-23 19:31:17 -05:00
$standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);
if ($is_mobile) {
if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
2015-12-23 19:31:17 -05:00
$system_theme = $standard_system_theme;
$theme_name = $standard_theme_name;
} else {
$system_theme = Config::get('system', 'mobile-theme', '');
if ($system_theme == '') {
$system_theme = $standard_system_theme;
}
2015-12-23 19:31:17 -05:00
$theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme);
if ($theme_name === '---') {
2015-12-23 19:31:17 -05:00
// user has selected to have the mobile theme be the same as the normal one
2015-07-01 20:55:03 -04:00
$system_theme = $standard_system_theme;
$theme_name = $standard_theme_name;
if ($page_theme) {
2015-12-23 19:31:17 -05:00
$theme_name = $page_theme;
}
2012-09-12 23:35:51 -04:00
}
2012-07-23 22:37:00 -04:00
}
} else {
2015-12-23 19:31:17 -05:00
$system_theme = $standard_system_theme;
$theme_name = $standard_theme_name;
if ($page_theme) {
2015-12-23 19:31:17 -05:00
$theme_name = $page_theme;
}
2015-12-23 19:31:17 -05:00
}
if ($theme_name &&
2015-12-23 19:31:17 -05:00
(file_exists('view/theme/' . $theme_name . '/style.css') ||
file_exists('view/theme/' . $theme_name . '/style.php'))) {
2015-12-23 19:31:17 -05:00
return($theme_name);
}
foreach ($app_base_themes as $t) {
if (file_exists('view/theme/' . $t . '/style.css') ||
file_exists('view/theme/' . $t . '/style.php')) {
2015-12-23 19:31:17 -05:00
return($t);
}
2015-12-23 19:31:17 -05:00
}
2015-12-23 19:31:17 -05:00
$fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php'));
if (count($fallback)) {
2015-12-23 19:31:17 -05:00
return (str_replace('view/theme/','', substr($fallback[0],0,-10)));
}
/// @TODO No final return statement?
}
2015-12-23 19:31:17 -05:00
/**
* @brief Return full URL to theme which is currently in effect.
*
2015-12-23 19:31:17 -05:00
* Provide a sane default if nothing is chosen or the specified theme does not exist.
*
2015-12-23 19:31:17 -05:00
* @return string
*/
function current_theme_url() {
$a = get_app();
2015-12-23 19:31:17 -05:00
$t = current_theme();
2015-12-23 19:31:17 -05:00
$opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
if (file_exists('view/theme/' . $t . '/style.php')) {
2016-02-17 06:18:36 -05:00
return('view/theme/'.$t.'/style.pcss'.$opts);
}
2016-02-17 06:18:36 -05:00
return('view/theme/'.$t.'/style.css');
}
2015-12-23 19:31:17 -05:00
function feed_birthday($uid,$tz) {
2015-12-23 19:31:17 -05:00
/**
*
* Determine the next birthday, but only if the birthday is published
* in the default profile. We _could_ also look for a private profile that the
* recipient can see, but somebody could get mad at us if they start getting
* public birthday greetings when they haven't made this info public.
*
* Assuming we are able to publish this info, we are then going to convert
* the start time from the owner's timezone to UTC.
*
* This will potentially solve the problem found with some social networks
* where birthdays are converted to the viewer's timezone and salutations from
* elsewhere in the world show up on the wrong day. We will convert it to the
* viewer's timezone also, but first we are going to convert it from the birthday
* person's timezone to GMT - so the viewer may find the birthday starting at
* 6:00PM the day before, but that will correspond to midnight to the birthday person.
*
*/
2011-02-07 01:41:07 -05:00
2015-12-23 19:31:17 -05:00
$birthday = '';
if (! strlen($tz)) {
2015-12-23 19:31:17 -05:00
$tz = 'UTC';
}
2015-12-23 19:31:17 -05:00
$p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1",
intval($uid)
);
if (dbm::is_result($p)) {
2015-12-23 19:31:17 -05:00
$tmp_dob = substr($p[0]['dob'],5);
if (intval($tmp_dob)) {
2015-12-23 19:31:17 -05:00
$y = datetime_convert($tz,$tz,'now','Y');
$bd = $y . '-' . $tmp_dob . ' 00:00';
$t_dob = strtotime($bd);
$now = strtotime(datetime_convert($tz,$tz,'now'));
if ($t_dob < $now) {
2015-12-23 19:31:17 -05:00
$bd = $y + 1 . '-' . $tmp_dob . ' 00:00';
}
2015-12-23 19:31:17 -05:00
$birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME);
2011-02-07 01:41:07 -05:00
}
}
2015-12-23 19:31:17 -05:00
return $birthday;
}
2011-02-07 20:06:04 -05:00
2015-12-23 19:31:17 -05:00
/**
* @brief Check if current user has admin role.
*
* @return bool true if user is an admin
*/
function is_site_admin() {
$a = get_app();
2015-12-23 19:31:17 -05:00
$adminlist = explode(",", str_replace(" ", "", $a->config['admin_email']));
//if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email']))
if (local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) {
2015-12-23 19:31:17 -05:00
return true;
}
2015-12-23 19:31:17 -05:00
return false;
}
2012-06-14 10:04:13 -04:00
/**
2015-12-23 19:31:17 -05:00
* @brief Returns querystring as string from a mapped array.
*
* @param array $params mapped array with query parameters
* @param string $name of parameter, default null
*
* @return string
*/
function build_querystring($params, $name = null) {
$ret = "";
foreach ($params as $key => $val) {
if (is_array($val)) {
/// @TODO maybe not compare against null, use is_null()
if ($name == null) {
$ret .= build_querystring($val, $key);
} else {
$ret .= build_querystring($val, $name."[$key]");
}
} else {
$val = urlencode($val);
/// @TODO maybe not compare against null, use is_null()
if ($name != null) {
/// @TODO two string concated, can be merged to one
$ret .= $name . "[$key]" . "=$val&";
} else {
$ret .= "$key=$val&";
}
}
}
return $ret;
2012-06-14 10:04:13 -04:00
}
2012-09-12 23:35:51 -04:00
function explode_querystring($query) {
$arg_st = strpos($query, '?');
if ($arg_st !== false) {
$base = substr($query, 0, $arg_st);
$arg_st += 1;
} else {
$base = '';
$arg_st = 0;
}
$args = explode('&', substr($query, $arg_st));
foreach ($args as $k => $arg) {
/// @TODO really compare type-safe here?
if ($arg === '') {
unset($args[$k]);
}
}
$args = array_values($args);
if (!$base) {
$base = $args[0];
unset($args[0]);
$args = array_values($args);
}
return array(
'base' => $base,
'args' => $args,
);
}
2012-09-12 23:35:51 -04:00
/**
* Returns the complete URL of the current page, e.g.: http(s)://something.com/network
*
* Taken from http://webcheatsheet.com/php/get_current_page_url.php
*/
function curPageURL() {
$pageURL = 'http';
if ($_SERVER["HTTPS"] == "on") {
$pageURL .= "s";
}
2012-09-12 23:35:51 -04:00
$pageURL .= "://";
2012-09-12 23:35:51 -04:00
if ($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443") {
$pageURL .= $_SERVER["SERVER_NAME"].":".$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"];
} else {
$pageURL .= $_SERVER["SERVER_NAME"].$_SERVER["REQUEST_URI"];
}
return $pageURL;
}
function random_digits($digits) {
$rn = '';
for ($i = 0; $i < $digits; $i++) {
/// @TODO rand() is different to mt_rand() and maybe lesser "random"
$rn .= rand(0,9);
}
return $rn;
}
2012-11-16 18:50:39 -05:00
function get_server() {
$server = get_config("system", "directory");
if ($server == "") {
$server = "http://dir.friendi.ca";
}
return($server);
}
2012-11-16 18:50:39 -05:00
function get_cachefile($file, $writemode = true) {
$cache = get_itemcachepath();
2012-11-16 18:50:39 -05:00
if ((! $cache) || (! is_dir($cache))) {
2012-11-16 18:50:39 -05:00
return("");
}
2012-11-16 18:50:39 -05:00
$subfolder = $cache . "/" . substr($file, 0, 2);
2012-11-16 18:50:39 -05:00
$cachepath = $subfolder . "/" . $file;
2012-11-16 18:50:39 -05:00
if ($writemode) {
if (!is_dir($subfolder)) {
mkdir($subfolder);
chmod($subfolder, 0777);
}
}
/// @TODO no need to put braces here
return $cachepath;
2012-11-16 18:50:39 -05:00
}
function clear_cache($basepath = "", $path = "") {
if ($path == "") {
$basepath = get_itemcachepath();
2012-11-16 18:50:39 -05:00
$path = $basepath;
}
if (($path == "") OR (!is_dir($path))) {
2012-11-16 18:50:39 -05:00
return;
}
2012-11-16 18:50:39 -05:00
if (substr(realpath($path), 0, strlen($basepath)) != $basepath) {
2012-11-16 18:50:39 -05:00
return;
}
2012-11-16 18:50:39 -05:00
$cachetime = (int)get_config('system','itemcache_duration');
if ($cachetime == 0) {
2012-11-16 18:50:39 -05:00
$cachetime = 86400;
}
2012-11-16 18:50:39 -05:00
if (is_writable($path)){
if ($dh = opendir($path)) {
while (($file = readdir($dh)) !== false) {
$fullpath = $path."/".$file;
if ((filetype($fullpath) == "dir") and ($file != ".") and ($file != "..")) {
clear_cache($basepath, $fullpath);
}
if ((filetype($fullpath) == "file") and (filectime($fullpath) < (time() - $cachetime))) {
unlink($fullpath);
}
}
closedir($dh);
2012-11-16 18:50:39 -05:00
}
}
2012-11-16 18:50:39 -05:00
}
function get_itemcachepath() {
// Checking, if the cache is deactivated
$cachetime = (int)get_config('system','itemcache_duration');
if ($cachetime < 0) {
return "";
}
$itemcache = get_config('system','itemcache');
if (($itemcache != "") AND App::directory_usable($itemcache)) {
2017-02-19 03:23:21 -05:00
return $itemcache;
}
$temppath = get_temppath();
if ($temppath != "") {
$itemcache = $temppath."/itemcache";
if (!file_exists($itemcache) && !is_dir($itemcache)) {
mkdir($itemcache);
}
if (App::directory_usable($itemcache)) {
set_config("system", "itemcache", $itemcache);
2017-02-19 03:23:21 -05:00
return $itemcache;
}
}
return "";
}
2016-12-01 17:50:07 -05:00
/**
* @brief Returns the path where spool files are stored
*
* @return string Spool path
*/
2016-12-01 08:50:26 -05:00
function get_spoolpath() {
$spoolpath = get_config('system','spoolpath');
if (($spoolpath != "") AND App::directory_usable($spoolpath)) {
2017-02-19 03:23:21 -05:00
// We have a spool path and it is usable
return $spoolpath;
2016-12-01 17:50:07 -05:00
}
2016-12-01 08:50:26 -05:00
2017-02-19 03:23:21 -05:00
// We don't have a working preconfigured spool path, so we take the temp path.
2016-12-01 08:50:26 -05:00
$temppath = get_temppath();
if ($temppath != "") {
2017-02-19 03:23:21 -05:00
// To avoid any interferences with other systems we create our own directory
2016-12-01 08:50:26 -05:00
$spoolpath = $temppath."/spool";
2016-12-01 17:50:07 -05:00
if (!is_dir($spoolpath)) {
2016-12-01 08:50:26 -05:00
mkdir($spoolpath);
2016-12-01 17:50:07 -05:00
}
2016-12-01 08:50:26 -05:00
if (App::directory_usable($spoolpath)) {
2017-02-19 03:23:21 -05:00
// The new path is usable, we are happy
2016-12-01 08:50:26 -05:00
set_config("system", "spoolpath", $spoolpath);
2017-02-19 03:23:21 -05:00
return $spoolpath;
} else {
// We can't create a subdirectory, strange.
// But the directory seems to work, so we use it but don't store it.
return $temppath;
2016-12-01 08:50:26 -05:00
}
}
2017-02-19 03:23:21 -05:00
// Reaching this point means that the operating system is configured badly.
2016-12-01 08:50:26 -05:00
return "";
}
function get_temppath() {
$a = get_app();
2017-02-19 03:23:21 -05:00
$temppath = get_config("system", "temppath");
if (($temppath != "") AND App::directory_usable($temppath)) {
2017-02-19 03:23:21 -05:00
// We have a temp path and it is usable
return $temppath;
}
2017-02-19 03:23:21 -05:00
// We don't have a working preconfigured temp path, so we take the system path.
$temppath = sys_get_temp_dir();
2017-02-19 03:23:21 -05:00
// Check if it is usable
if (($temppath != "") AND App::directory_usable($temppath)) {
// To avoid any interferences with other systems we create our own directory
$new_temppath .= "/".$a->get_hostname();
if (!is_dir($new_temppath)) {
/// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
2017-02-19 03:23:21 -05:00
mkdir($new_temppath);
}
2017-02-19 03:23:21 -05:00
if (App::directory_usable($new_temppath)) {
// The new path is usable, we are happy
set_config("system", "temppath", $new_temppath);
return $new_temppath;
} else {
// We can't create a subdirectory, strange.
// But the directory seems to work, so we use it but don't store it.
return $temppath;
}
}
2017-02-19 03:23:21 -05:00
// Reaching this point means that the operating system is configured badly.
return '';
}
/// @deprecated
function set_template_engine(App $a, $engine = 'internal') {
/// @note This function is no longer necessary, but keep it as a wrapper to the class method
/// to avoid breaking themes again unnecessarily
/// @TODO maybe output a warning here so the theme developer can see it? PHP won't show such warnings like Java does.
$a->set_template_engine($engine);
}
2013-01-08 15:24:13 -05:00
if (!function_exists('exif_imagetype')) {
function exif_imagetype($file) {
$size = getimagesize($file);
return $size[2];
}
}
2015-09-13 12:47:10 -04:00
function validate_include(&$file) {
$orig_file = $file;
$file = realpath($file);
if (strpos($file, getcwd()) !== 0) {
2015-09-13 12:47:10 -04:00
return false;
}
2015-09-13 12:47:10 -04:00
$file = str_replace(getcwd()."/", "", $file, $count);
if ($count != 1) {
2015-09-13 12:47:10 -04:00
return false;
}
2015-09-13 12:47:10 -04:00
if ($orig_file !== $file) {
2015-09-13 12:47:10 -04:00
return false;
}
2015-09-13 12:47:10 -04:00
$valid = false;
if (strpos($file, "include/") === 0) {
2015-09-13 12:47:10 -04:00
$valid = true;
}
2015-09-13 12:47:10 -04:00
if (strpos($file, "addon/") === 0) {
2015-09-13 12:47:10 -04:00
$valid = true;
}
2015-09-13 12:47:10 -04:00
// Simply return flag
return ($valid);
2015-09-13 12:47:10 -04:00
}
function current_load() {
if (!function_exists('sys_getloadavg')) {
return false;
}
$load_arr = sys_getloadavg();
if (!is_array($load_arr)) {
return false;
}
return max($load_arr[0], $load_arr[1]);
}
2015-12-26 10:06:38 -05:00
2015-12-27 21:17:55 -05:00
/**
* @brief get c-style args
*
2015-12-27 21:17:55 -05:00
* @return int
*/
2015-12-26 10:06:38 -05:00
function argc() {
return get_app()->argc;
}
2015-12-27 21:17:55 -05:00
/**
* @brief Returns the value of a argv key
*
2015-12-27 21:17:55 -05:00
* @param int $x argv key
* @return string Value of the argv key
*/
2015-12-26 10:06:38 -05:00
function argv($x) {
if (array_key_exists($x,get_app()->argv)) {
2015-12-26 10:06:38 -05:00
return get_app()->argv[$x];
}
2015-12-26 10:06:38 -05:00
return '';
}
/**
* @brief Get the data which is needed for infinite scroll
*
* For invinite scroll we need the page number of the actual page
* and the the URI where the content of the next page comes from.
* This data is needed for the js part in main.js.
* Note: infinite scroll does only work for the network page (module)
*
* @param string $module The name of the module (e.g. "network")
* @return array Of infinite scroll data
* 'pageno' => $pageno The number of the actual page
* 'reload_uri' => $reload_uri The URI of the content we have to load
*/
function infinite_scroll_data($module) {
if (get_pconfig(local_user(),'system','infinite_scroll')
AND ($module == "network") AND ($_GET["mode"] != "minimal")) {
// get the page number
if (is_string($_GET["page"])) {
$pageno = $_GET["page"];
} else {
$pageno = 1;
}
$reload_uri = "";
// try to get the uri from which we load the content
foreach ($_GET AS $param => $value) {
if (($param != "page") AND ($param != "q")) {
$reload_uri .= "&" . $param . "=" . urlencode($value);
}
}
if (($a->page_offset != "") AND !strstr($reload_uri, "&offset=")) {
$reload_uri .= "&offset=" . urlencode($a->page_offset);
}
$arr = array("pageno" => $pageno, "reload_uri" => $reload_uri);
return $arr;
}
}