path: root/boot.php

<?php
/** @file boot.php
 *
 * This file defines some global constants and includes the central App class.
 */

/**
 * Red Matrix.
 *
 * The Red Matrix (aka "Red") is an open source decentralised communications
 * platform combined with a decentralised identity/authentication framework
 * wrapped in an extensible content management system, providing website designers
 * the ability to embed fully decentralised communications and social tools
 * into many traditional website designs (blogs, forums, small business
 * websites, charitable organisations, etc.). Red also provides DNS mobility
 * and internet scale privacy/access control.
 *
 * This allows any individual website to participate in a matrix of linked
 * sites and people and media sharing which is far greater than the reach
 * of an individual site.
 *
 * If you are reading the source code and come across a function
 * or code block which is not documented, but you have a good idea what it
 * does, please add some descriptive comments and push it to the main project.
 * Even if your description isn't perfect, it gives us a base which we
 * can build on and correct - so that eventually everything is fully
 * documented.
 */

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/language.php');
require_once('include/nav.php');
require_once('include/cache.php');
require_once('include/permissions.php');
require_once('library/Mobile_Detect/Mobile_Detect.php');
require_once('include/BaseObject.php');
require_once('include/features.php');
require_once('include/taxonomy.php');
require_once('include/identity.php');
require_once('include/Contact.php');
require_once('include/account.php');


define ( 'RED_PLATFORM',            'redmatrix' );
define ( 'RED_VERSION',             trim(file_get_contents('version.inc')) . 'R');
define ( 'ZOT_REVISION',            1     );

define ( 'DB_UPDATE_VERSION',       1135  );

/**
 * 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.
 *
 * @var string
 */
define ( 'EOL',                    '<br>' . "\r\n"        );
define ( 'ATOM_TIME',              'Y-m-d\TH:i:s\Z'       );
//define ( 'NULL_DATE',              '0000-00-00 00:00:00'  );
define ( 'TEMPLATE_BUILD_PATH',    'store/[data]/smarty3' );

define ( 'DIRECTORY_MODE_NORMAL',      0x0000); // This is technically DIRECTORY_MODE_TERTIARY, but it's the default, hence 0x0000
define ( 'DIRECTORY_MODE_PRIMARY',     0x0001);
define ( 'DIRECTORY_MODE_SECONDARY',   0x0002);
define ( 'DIRECTORY_MODE_STANDALONE',  0x0100);

// We will look for upstream directories whenever me make contact
// with other sites, but if this is a new installation and isn't
// a standalone hub, we need to seed the service with a starting
// point to go out and find the rest of the world.

define ( 'DIRECTORY_REALM',            'RED_GLOBAL');
define ( 'DIRECTORY_FALLBACK_MASTER',  'https://zothub.com');

$DIRECTORY_FALLBACK_SERVERS = array( 
	'https://zothub.com', 
	'https://zotid.net', 
	'https://red.zottel.red',
	'https://red.pixelbits.de',
	'https://my.federated.social',
	'https://whogotzot.com',
	'https://redmatrix.nl'
);


/**
 *
 * 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  );
/**
 * $a->config['system']['png_quality'] from 0 (uncompressed) to 9
 */
define ( 'PNG_QUALITY',             8  );

/**
 * Language detection parameters
 */

define ( 'LANGUAGE_DETECT_MIN_LENGTH',     128 );
define ( 'LANGUAGE_DETECT_MIN_CONFIDENCE', 0.01 );


/**
 * Default permissions for file-based storage (webDAV, etc.)
 * These files will be owned by the webserver who will need write
 * access to the "storage" folder.
 * Ideally you should make this 700, however some hosted platforms
 * may not let you change ownership of this directory so we're
 * defaulting to both owner-write and group-write privilege.
 * This should work for most cases without modification.
 * Over-ride this in your .htconfig.php if you need something
 * either more or less restrictive.
 */

define ( 'STORAGE_DEFAULT_PERMISSIONS',   0770 );


/**
 *
 * 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'  );

/**
 * SSL redirection policies
 */

define ( 'SSL_POLICY_NONE',         0 );
define ( 'SSL_POLICY_FULL',         1 );
define ( 'SSL_POLICY_SELFSIGN',     2 ); // NOT supported in Red


/**
 * log levels
 */

define ( 'LOGGER_NORMAL',          0 );
define ( 'LOGGER_TRACE',           1 );
define ( 'LOGGER_DEBUG',           2 );
define ( 'LOGGER_DATA',            3 );
define ( 'LOGGER_ALL',             4 );

/**
 * registration policies
 */

define ( 'REGISTER_CLOSED',        0 );
define ( 'REGISTER_APPROVE',       1 );
define ( 'REGISTER_OPEN',          2 );


/**
 * site access policy
 */

define ( 'ACCESS_PRIVATE',         0 );
define ( 'ACCESS_PAID',            1 );
define ( 'ACCESS_FREE',            2 );
define ( 'ACCESS_TIERED',          3 );

/**
 * relationship types
 */

define ( 'CONTACT_IS_FOLLOWER', 1);
define ( 'CONTACT_IS_SHARING',  2);
define ( 'CONTACT_IS_FRIEND',   3);


/**
 * DB update return values
 */

define ( 'UPDATE_SUCCESS', 0);
define ( 'UPDATE_FAILED',  1);


define ( 'CLIENT_MODE_NORMAL', 0x0000);
define ( 'CLIENT_MODE_LOAD',   0x0001);
define ( 'CLIENT_MODE_UPDATE', 0x0002);


/**
 *
 * Channel pageflags
 *
 */

define ( 'PAGE_NORMAL',            0x0000 );
define ( 'PAGE_HIDDEN',            0x0001 );
define ( 'PAGE_AUTOCONNECT',       0x0002 );
define ( 'PAGE_APPLICATION',       0x0004 );
define ( 'PAGE_ALLOWCODE',         0x0008 );
define ( 'PAGE_PREMIUM',           0x0010 );
define ( 'PAGE_ADULT',             0x0020 );
define ( 'PAGE_CENSORED',          0x0040 ); // Site admin has blocked this channel from appearing in casual search results and site feeds
define ( 'PAGE_SYSTEM',            0x1000 );
define ( 'PAGE_HUBADMIN',          0x2000 ); // set this to indicate a preferred admin channel rather than the 
											 // default channel of any accounts with the admin role.
define ( 'PAGE_REMOVED',           0x8000 );


/**
 * Photo types
 */

define ( 'PHOTO_NORMAL',           0x0000 );
define ( 'PHOTO_PROFILE',          0x0001 );
define ( 'PHOTO_XCHAN',            0x0002 );
define ( 'PHOTO_THING',            0x0004 );
define ( 'PHOTO_ADULT',            0x0008 );

define ( 'PHOTO_FLAG_OS',          0x4000 );

/**
 * Menu types
 */

define ( 'MENU_SYSTEM',          0x0001 );
define ( 'MENU_BOOKMARK',        0x0002 );

/**
 * Network and protocol family types
 */

define ( 'NETWORK_DFRN',             'dfrn');    // Friendica, Mistpark, other DFRN implementations
define ( 'NETWORK_ZOT',              'zot!');    // Zot!
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
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
define ( 'NETWORK_GPLUS',            'goog');    // Google+

define ( 'NETWORK_PHANTOM',          'unkn');    // Place holder


/**
 * Permissions
 */

define ( 'PERMS_R_STREAM',         0x00001);
define ( 'PERMS_R_PROFILE',        0x00002);
define ( 'PERMS_R_PHOTOS',         0x00004);
define ( 'PERMS_R_ABOOK',          0x00008);

define ( 'PERMS_W_STREAM',         0x00010);
define ( 'PERMS_W_WALL',           0x00020);
define ( 'PERMS_W_TAGWALL',        0x00040);
define ( 'PERMS_W_COMMENT',        0x00080);
define ( 'PERMS_W_MAIL',           0x00100);
define ( 'PERMS_W_PHOTOS',         0x00200);
define ( 'PERMS_W_CHAT',           0x00400);
define ( 'PERMS_A_DELEGATE',       0x00800);

define ( 'PERMS_R_STORAGE',        0x01000);
define ( 'PERMS_W_STORAGE',        0x02000);
define ( 'PERMS_R_PAGES',          0x04000);
define ( 'PERMS_W_PAGES',          0x08000);
define ( 'PERMS_A_REPUBLISH',      0x10000);
define ( 'PERMS_W_LIKE',           0x20000);

// General channel permissions

define ( 'PERMS_PUBLIC'     , 0x0001 );
define ( 'PERMS_NETWORK'    , 0x0002 );
define ( 'PERMS_SITE'       , 0x0004 );
define ( 'PERMS_CONTACTS'   , 0x0008 );
define ( 'PERMS_SPECIFIC'   , 0x0080 );
define ( 'PERMS_AUTHED'     , 0x0100 );
define ( 'PERMS_PENDING'    , 0x0200 );


// Address book flags

define ( 'ABOOK_FLAG_BLOCKED'    , 0x0001);
define ( 'ABOOK_FLAG_IGNORED'    , 0x0002);
define ( 'ABOOK_FLAG_HIDDEN'     , 0x0004);
define ( 'ABOOK_FLAG_ARCHIVED'   , 0x0008);
define ( 'ABOOK_FLAG_PENDING'    , 0x0010);
define ( 'ABOOK_FLAG_UNCONNECTED', 0x0020);
define ( 'ABOOK_FLAG_SELF'       , 0x0080);
define ( 'ABOOK_FLAG_FEED'       , 0x0100);


define ( 'MAIL_DELETED',       0x0001);
define ( 'MAIL_REPLIED',       0x0002);
define ( 'MAIL_ISREPLY',       0x0004);
define ( 'MAIL_SEEN',          0x0008);
define ( 'MAIL_RECALLED',      0x0010);
define ( 'MAIL_OBSCURED',      0x0020);


define ( 'ATTACH_FLAG_DIR',    0x0001);
define ( 'ATTACH_FLAG_OS',     0x0002);


define ( 'MENU_ITEM_ZID',       0x0001);
define ( 'MENU_ITEM_NEWWIN',    0x0002);
define ( 'MENU_ITEM_CHATROOM',  0x0004);

/**
 * Poll/Survey types
 */

define ( 'POLL_SIMPLE_RATING',   0x0001);  // 1-5
define ( 'POLL_TENSCALE',        0x0002);  // 1-10
define ( 'POLL_MULTIPLE_CHOICE', 0x0004);
define ( 'POLL_OVERWRITE',       0x8000);  // If you vote twice remove the prior entry


define ( 'UPDATE_FLAGS_UPDATED',  0x0001);
define ( 'UPDATE_FLAGS_FORCED',   0x0002);
define ( 'UPDATE_FLAGS_DELETED',  0x1000);


define ( 'DROPITEM_NORMAL',      0);
define ( 'DROPITEM_PHASE1',      1);
define ( 'DROPITEM_PHASE2',      2);


/**
 * Maximum number of "people who like (or don't like) this"  that we will list by name
 */

define ( 'MAX_LIKERS',    10);

/**
 * Communication timeout
 */

define ( 'ZCURL_TIMEOUT' , (-1));


/**
 * email notification options
 */

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 );
define ( 'NOTIFY_POKE',     0x0200 );

define ( 'NOTIFY_SYSTEM',   0x8000 );

/**
 * visual notification options
 */

define ( 'VNOTIFY_NETWORK',    0x0001 );
define ( 'VNOTIFY_CHANNEL',    0x0002 );
define ( 'VNOTIFY_MAIL',       0x0004 );
define ( 'VNOTIFY_EVENT',      0x0008 );
define ( 'VNOTIFY_EVENTTODAY', 0x0010 );
define ( 'VNOTIFY_BIRTHDAY',   0x0020 );
define ( 'VNOTIFY_SYSTEM',     0x0040 );
define ( 'VNOTIFY_INFO',       0x0080 );
define ( 'VNOTIFY_ALERT',      0x0100 );
define ( 'VNOTIFY_INTRO',      0x0200 );
define ( 'VNOTIFY_REGISTER',   0x0400 );



/**
 * 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_THING',        7 );
define ( 'TERM_BOOKMARK',     8 );

define ( 'TERM_OBJ_POST',    1 );
define ( 'TERM_OBJ_PHOTO',   2 );
define ( 'TERM_OBJ_PROFILE', 3 );
define ( 'TERM_OBJ_CHANNEL', 4 );
define ( 'TERM_OBJ_OBJECT',  5 );
define ( 'TERM_OBJ_THING',   6 );
define ( 'TERM_OBJ_APP',     7 );

/**
 * various namespaces we may need to parse
 */

define ( 'NAMESPACE_ZOT',             'http://purl.org/zot' );
define ( 'NAMESPACE_DFRN' ,           'http://purl.org/macgirvin/dfrn/1.0' );
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' );
define ( 'NAMESPACE_OSTATUS',         'http://ostatus.org/schema/1.0' );
define ( 'NAMESPACE_STATUSNET',       'http://status.net/schema/api/1/' );
define ( 'NAMESPACE_ATOM1',           'http://www.w3.org/2005/Atom' );
define ( 'NAMESPACE_YMEDIA',          'http://search.yahoo.com/mrss/' );

/**
 * activity stream defines
 */

define ( 'ACTIVITY_LIKE',        NAMESPACE_ACTIVITY_SCHEMA . 'like' );
define ( 'ACTIVITY_DISLIKE',     NAMESPACE_ZOT   . '/activity/dislike' );
define ( 'ACTIVITY_AGREE',       NAMESPACE_ZOT   . '/activity/agree' );
define ( 'ACTIVITY_DISAGREE',    NAMESPACE_ZOT   . '/activity/disagree' );
define ( 'ACTIVITY_ABSTAIN',     NAMESPACE_ZOT   . '/activity/abstain' );

define ( 'ACTIVITY_OBJ_HEART',   NAMESPACE_ZOT   . '/activity/heart' );

define ( 'ACTIVITY_FRIEND',      NAMESPACE_ACTIVITY_SCHEMA . 'make-friend' );
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' );

define ( 'ACTIVITY_POST',        NAMESPACE_ACTIVITY_SCHEMA . 'post' );
define ( 'ACTIVITY_UPDATE',      NAMESPACE_ACTIVITY_SCHEMA . 'update' );
define ( 'ACTIVITY_TAG',         NAMESPACE_ACTIVITY_SCHEMA . 'tag' );
define ( 'ACTIVITY_FAVORITE',    NAMESPACE_ACTIVITY_SCHEMA . 'favorite' );

define ( 'ACTIVITY_POKE',        NAMESPACE_ZOT . '/activity/poke' );
define ( 'ACTIVITY_MOOD',        NAMESPACE_ZOT . '/activity/mood' );

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_PHOTO',   NAMESPACE_ACTIVITY_SCHEMA . 'photo' );
define ( 'ACTIVITY_OBJ_P_PHOTO', NAMESPACE_ACTIVITY_SCHEMA . 'profile-photo' );
define ( 'ACTIVITY_OBJ_ALBUM',   NAMESPACE_ACTIVITY_SCHEMA . 'photo-album' );
define ( 'ACTIVITY_OBJ_EVENT',   NAMESPACE_ACTIVITY_SCHEMA . 'event' );
define ( 'ACTIVITY_OBJ_GROUP',   NAMESPACE_ACTIVITY_SCHEMA . 'group' );
define ( 'ACTIVITY_OBJ_TAGTERM', NAMESPACE_ZOT  . '/activity/tagterm' );
define ( 'ACTIVITY_OBJ_PROFILE', NAMESPACE_ZOT  . '/activity/profile' );
define ( 'ACTIVITY_OBJ_THING',   NAMESPACE_ZOT  . '/activity/thing' );
define ( 'ACTIVITY_OBJ_LOCATION',NAMESPACE_ZOT  . '/activity/location' );
define ( 'ACTIVITY_OBJ_FILE',    NAMESPACE_ZOT  . '/activity/file' );

/**
 * item weight for query ordering
 */

define ( 'GRAVITY_PARENT',       0);
define ( 'GRAVITY_LIKE',         3);
define ( 'GRAVITY_COMMENT',      6);

/**
 * Account Flags
 */

define ( 'ACCOUNT_OK',           0x0000 );
define ( 'ACCOUNT_UNVERIFIED',   0x0001 );
define ( 'ACCOUNT_BLOCKED',      0x0002 );
define ( 'ACCOUNT_EXPIRED',      0x0004 );
define ( 'ACCOUNT_REMOVED',      0x0008 );
define ( 'ACCOUNT_PENDING',      0x0010 );

/**
 * Account roles
 */

define ( 'ACCOUNT_ROLE_ALLOWCODE', 0x0001 );
define ( 'ACCOUNT_ROLE_SYSTEM',    0x0002 );
define ( 'ACCOUNT_ROLE_DEVELOPER', 0x0004 );
define ( 'ACCOUNT_ROLE_ADMIN',     0x1000 );

/**
 * Item visibility
 */

define ( 'ITEM_VISIBLE',         0x0000);
//define ( 'ITEM_HIDDEN',          0x0001);
define ( 'ITEM_BLOCKED',         0x0002);
define ( 'ITEM_MODERATED',       0x0004);
define ( 'ITEM_SPAM',            0x0008);
//define ( 'ITEM_DELETED',         0x0010);
define ( 'ITEM_UNPUBLISHED',     0x0020);
//define ( 'ITEM_WEBPAGE',         0x0040);	// is a static web page, not a conversational item
define ( 'ITEM_DELAYED_PUBLISH', 0x0080);
define ( 'ITEM_BUILDBLOCK',      0x0100);	// Named thusly to make sure nobody confuses this with ITEM_BLOCKED
//define ( 'ITEM_PDL',			 0x0200);	// Page Description Language - e.g. Comanche
define ( 'ITEM_BUG',			 0x0400);	// Is a bug, can be used by the internal bug tracker
define ( 'ITEM_PENDING_REMOVE',  0x0800);   // deleted, notification period has lapsed
										   // Don't make us evaluate this same item again.

define ( 'ITEM_TYPE_POST',       0 );
define ( 'ITEM_TYPE_BLOCK',      1 );
define ( 'ITEM_TYPE_PDL',        2 );
define ( 'ITEM_TYPE_WEBPAGE',    3 );

define ( 'DBTYPE_MYSQL',    0 );
define ( 'DBTYPE_POSTGRES', 1 );

/**
 *
 * 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
 *
 */

function startup() {
	error_reporting(E_ERROR | E_WARNING | E_PARSE);

	// Some hosting providers block/disable this
	@set_time_limit(0);

	if(function_exists ('ini_set')) {
		// This has to be quite large to deal with embedded private photos
		@ini_set('pcre.backtrack_limit', 500000);

		// Use cookies to store the session ID on the client side
		@ini_set('session.use_only_cookies', 1);

		// Disable transparent Session ID support
		@ini_set('session.use_trans_sid',    0);
	}

	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);
	}
}

/**
 * class: App
 *
 * @brief Our main application structure for the life of this page.
 *
 * Primarily deals with the URL that got us here
 * and tries to make some sense of it, and
 * stores our page contents and config storage
 * and anything else that might need to be passed around
 * before we spit the page out.
 *
 */
class App {

	public  $install    = false;           // true if we are installing the software

	public  $account    = null;            // account record of the logged-in account
	public  $channel    = null;            // channel record of the current channel of the logged-in account
	public  $observer   = null;            // xchan record of the page observer
	public  $profile_uid = 0;              // If applicable, the channel_id of the "page owner"
	public  $poi        = null;            // "person of interest", generally a referenced connection
	public  $layout     = array();         // Comanche parsed template

	private $perms      = null;            // observer permissions
	private $widgets    = array();         // widgets for this page
	//private $widgetlist = null;            // widget ordering and inclusion directives

	public  $groups;
	public  $language;
	public  $module_loaded = false;
	public  $query_string;
	public  $config;                       // config cache
	public  $page;
	public  $profile;
	public  $user;
	public  $cid;
	public  $contact;
	public  $contacts;
	public  $content;
	public  $data = array();
	public  $error = false;
	public  $cmd;
	public  $argv;
	public  $argc;
	public  $module;
	public  $pager;
	public  $strings;
	public  $hooks;
	public  $timezone;
	public  $interactive = true;
	public  $plugins;
	private $apps = array();
	public  $identities;
	public  $css_sources = array();
	public  $js_sources = array();
	public  $theme_info = array();
	public  $is_sys = false;
	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;

	/**
	 * @brief An array for all theme-controllable parameters
	 *
	 * Mostly unimplemented yet. Only options 'template_engine' and
	 * beyond are used.
	 *
	 * @var array
	 */
	private $theme = array(
		'sourcename' => '',
		'videowidth' => 425,
		'videoheight' => 350,
		'force_max_items' => 0,
		'thread_allow' => true,
		'stylesheet' => '',
		'template_engine' => 'smarty3',
	);

	/**
	 * array of registered template engines ('name'=>'class name')
	 *
	 * @var array
	 */
	public $template_engines = array();
	/**
	 * array of instanced template engines ('name'=>'instance')
	 *
	 * @var array
	 */
	public $template_engine_instance = array();

	private $ldelim = array(
		'internal' => '',
		'smarty3' => '{{'
	);
	private $rdelim = array(
		'internal' => '',
		'smarty3' => '}}'
	);

	private $scheme;
	private $hostname;
	private $baseurl;
	private $path;

	/**
	 * App constructor.
	 */
	function __construct() {
		// we'll reset this after we read our config file
		date_default_timezone_set('UTC');

		$this->config = array('system'=>array());
		$this->page = array();
		$this->pager= array();

		$this->query_string = '';

		startup();

		set_include_path(
			'include' . PATH_SEPARATOR
			. 'library' . PATH_SEPARATOR
			. 'library/phpsec' . PATH_SEPARATOR
			. 'library/langdet' . PATH_SEPARATOR
			. '.' );

		$this->scheme = 'http';
		if(x($_SERVER,'HTTPS') && $_SERVER['HTTPS'])
			$this->scheme = 'https';
		elseif(x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443))
			$this->scheme = 'https';

		if(x($_SERVER,'SERVER_NAME')) {
			$this->hostname = $_SERVER['SERVER_NAME'];

			if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443)
				$this->hostname .= ':' . $_SERVER['SERVER_PORT'];
			/**
			 * Figure out if we are running at the top of a domain
			 * or in a sub-directory and adjust accordingly
			 */

			$path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\');
			if(isset($path) && strlen($path) && ($path != $this->path))
				$this->path = $path;
		}

		set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path());

		if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === "q=") {
			$this->query_string = substr($_SERVER['QUERY_STRING'], 2);
			// removing trailing / - maybe a nginx problem
			if (substr($this->query_string, 0, 1) == "/")
				$this->query_string = substr($this->query_string, 1);
		}
		if(x($_GET,'q'))
			$this->cmd = trim($_GET['q'],'/\\');

		// unix style "homedir"

		if(substr($this->cmd, 0, 1) === '~')
			$this->cmd = 'channel/' . substr($this->cmd, 1);


		/**
		 *
		 * 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".
		 *
		 */

		$this->argv = explode('/',$this->cmd);
		$this->argc = count($this->argv);
		if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) {
			$this->module = str_replace(".", "_", $this->argv[0]);
			$this->module = str_replace("-", "_", $this->module);
		}
		else {
			$this->argc = 1;
			$this->argv = array('home');
			$this->module = 'home';
		}

		/**
		 * See if there is any page number information, and initialise
		 * pagination
		 */

		$this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
		$this->pager['itemspage'] = 60;
		$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
		if($this->pager['start'] < 0)
			$this->pager['start'] = 0;
		$this->pager['total'] = 0;

		/**
		 * Detect mobile devices
		 */

		$mobile_detect = new Mobile_Detect();
		$this->is_mobile = $mobile_detect->isMobile();
		$this->is_tablet = $mobile_detect->isTablet();

		$this->head_set_icon('/images/rm-32.png');

		BaseObject::set_app($this);

		/**
		 * register template engines
		 */
		$dc = get_declared_classes();
		foreach ($dc as $k) {
			if (in_array("ITemplateEngine", class_implements($k))){
				$this->register_template_engine($k);
			}
		}
	}

	function get_baseurl($ssl = false) {
		if(is_array($this->config)
			&& array_key_exists('system',$this->config)
			&& is_array($this->config['system'])
			&& array_key_exists('baseurl',$this->config['system'])
			&& strlen($this->config['system']['baseurl'])) {
			$url = $this->config['system']['baseurl'];

			return $url;
		}

		$scheme = $this->scheme;

		$this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );

		return $this->baseurl;
	}

	function set_baseurl($url) {
		if(is_array($this->config)
			&& array_key_exists('system',$this->config)
			&& is_array($this->config['system'])
			&& array_key_exists('baseurl',$this->config['system'])
			&& strlen($this->config['system']['baseurl'])) {
			$url = $this->config['system']['baseurl'];
		}

		$parsed = @parse_url($url);

		$this->baseurl = $url;

		if($parsed) {
			$this->scheme = $parsed['scheme'];

			$this->hostname = $parsed['host'];
			if(x($parsed,'port'))
				$this->hostname .= ':' . $parsed['port'];
			if(x($parsed,'path'))
				$this->path = trim($parsed['path'],'\\/');
		}
	}

	function get_hostname() {
		return $this->hostname;
	}

	function set_hostname($h) {
		$this->hostname = $h;
	}

	function set_path($p) {
		$this->path = trim(trim($p), '/');
	}

	function get_path() {
		return $this->path;
	}

	function set_account($acct) {
		$this->account = $acct;
	}

	function get_account() {
		return $this->account;
	}

	function set_channel($channel) {
		$this->channel = $channel;
	}

	function get_channel() {
		return $this->channel;
	}

	function set_observer($xchan) {
		$this->observer = $xchan;
	}

	function get_observer() {
		return $this->observer;
	}

	function set_perms($perms) {
		$this->perms = $perms;
	}

	function get_perms() {
		return $this->perms;
	}

	function get_apps() {
		return $this->apps;
	}

	function set_apps($arr) {
		$this->apps = $arr;
	}

	function set_groups($g) {
		$this->groups = $g;
	}

	function get_groups() {
		return $this->groups;
	}

	function set_widget($title,$html, $location = 'aside') {
		$this->widgets[] = array('title' => $title, 'html' => $html, 'location' => $location);
	}

	function get_widgets($location = '') {
		if($location && count($this->widgets)) {
			$ret = array();
			foreach($this->widgets as $w) {
				if ($w['location'] == $location)
					$ret[] = $w;
			}
			$arr = array('location' => $location, 'widgets' => $ret);
			call_hooks('get_widgets', $arr);
			return $arr['widgets'];
		}
		$arr = array('location' => $location, 'widgets' => $this->widgets);
		call_hooks('get_widgets', $arr);
		return $arr['widgets'];
	}

	function set_pager_total($n) {
		$this->pager['total'] = intval($n);
	}

	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'];
	}

	function build_pagehead() {

		$user_scalable = ((local_user()) ? get_pconfig(local_user(),'system','user_scalable') : 1);
		if ($user_scalable === false)
			$user_scalable = 1;

		$interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 80000);
		if($interval < 10000)
			$interval = 80000;

		if(! x($this->page,'title'))
			$this->page['title'] = $this->config['system']['sitename'];

		/* put the head template at the beginning of page['htmlhead']
		 * since the code added by the modules frequently depends on it
		 * being first
		 */
		$tpl = get_markup_template('head.tpl');
		$this->page['htmlhead'] = replace_macros($tpl, array(
			'$user_scalable' => $user_scalable,
			'$baseurl' => $this->get_baseurl(),
			'$local_user' => local_user(),
			'$generator' => RED_PLATFORM . ' ' . RED_VERSION,
			'$update_interval' => $interval,
			'$icon' => head_get_icon(),
			'$head_css' => head_get_css(),
			'$head_js' => head_get_js(),
			'$js_strings' => js_strings(),
			'$zid' => get_my_address(),
			'$channel_id' => $this->profile['uid'],
		)) . $this->page['htmlhead'];

		// always put main.js at the end
		$this->page['htmlhead'] .= head_get_main_js();
	}

	/**
	* register template engine class
	* if $name is "", is used class static property $class::$name
	* @param string $class
	* @param string $name
	*/
	function register_template_engine($class, $name = '') {
		if ($name === ""){
			$v = get_class_vars( $class );
			if(x($v, "name")) $name = $v['name'];
		}
		if ($name === ""){
			echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
			killme();
		}
		$this->template_engines[$name] = $class;
	}

	/**
	* return template engine instance. If $name is not defined,
	* return engine defined by theme, or default
	*
	* @param string $name Template engine name
	*
	* @return object Template Engine instance
	*/
	function template_engine($name = ''){
		if ($name !== "") {
			$template_engine = $name;
		} else {
			$template_engine = 'smarty3';
			if (x($this->theme, 'template_engine')) {
				$template_engine = $this->theme['template_engine'];
			}
		}

		if (isset($this->template_engines[$template_engine])){
			if(isset($this->template_engine_instance[$template_engine])){
				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;
			}
		}

		echo "template engine <tt>$template_engine</tt> is not registered!\n"; killme();
	}

	/**
	 * @brief Returns the active template engine.
	 *
	 * @return string
	 */
	function get_template_engine() {
		return $this->theme['template_engine'];
	}

	function set_template_engine($engine = 'smarty3') {

		$this->theme['template_engine'] = $engine;

		/*if ($engine) {
			case 'smarty3':
				if(!is_writable(TEMPLATE_BUILD_PATH))
					echo "<b>ERROR</b> folder <tt>" . TEMPLATE_BUILD_PATH . "</tt> must be writable by webserver."; killme();

				break;
			default:
				break;
		}*/
	}

	function get_template_ldelim($engine = 'smarty3') {
		return $this->ldelim[$engine];
	}

	function get_template_rdelim($engine = 'smarty3') {
		return $this->rdelim[$engine];
	}

	function head_set_icon($icon) {
		$this->data['pageicon'] = $icon;
	}

	function head_get_icon() {
		$icon = $this->data['pageicon'];
		if(! strpos($icon,'://'))
			$icon = z_root() . $icon;
		return $icon;
	}

} // End App class


/**
 * @brief Retrieve the App structure.
 *
 * Useful in functions which require it but don't get it passed to them
 *
 * @return App
 */
function get_app() {
	global $a;
	return $a;
}


/**
 * @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])
				return (int) 1;
			return (int) 0;
		}
		return false;
	}
	else {
		if(isset($s)) {
			if($s) {
				return (int) 1;
			}
			return (int) 0;
		}
		return false;
	}
}


// called from db initialisation if db is dead.

function system_unavailable() {
	include('include/system_unavailable.php');
	system_down();
	killme();
}


function clean_urls() {
	global $a;

	//	if($a->config['system']['clean_urls'])
	return true;
	//	return false;
}

function z_path() {
	global $a;

	$base = $a->get_baseurl();
	if(! clean_urls())
		$base .= '/?q=';

	return $base;
}

/**
 * @brief Returns the baseurl.
 *
 * @see App::get_baseurl()
 *
 * @return string
 */
function z_root() {
	global $a;
	return $a->get_baseurl();
}

/**
 * @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;
}

function os_mkdir($path, $mode = 0777, $recursive = false) {
	$oldumask = @umask(0);
	@mkdir($path, $mode, $recursive);
	@umask($oldumask); 
}

/**
 * @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');
}


// Primarily involved with database upgrade, but also sets the
// base url for use in cmdline programs which don't have
// $_SERVER variables, and synchronising the state of installed plugins.

function check_config(&$a) {

	$build = get_config('system','db_version');
	if(! intval($build))
		$build = set_config('system','db_version',DB_UPDATE_VERSION);

	$saved = get_config('system','urlverify');
	if(! $saved)
		set_config('system','urlverify',bin2hex(z_root()));

	if(($saved) && ($saved != bin2hex(z_root()))) {
		// our URL changed. Do something.

		$oldurl = hex2bin($saved);
		logger('Baseurl changed!');

		$oldhost = substr($oldurl, strpos($oldurl, '//') + 2);
		$host = substr(z_root(), strpos(z_root(), '//') + 2);

		$is_ip_addr = ((preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$host)) ? true : false);
		$was_ip_addr = ((preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$oldhost)) ? true : false);
		// only change the url to an ip address if it was already an ip and not a dns name
		if((! $is_ip_addr) || ($is_ip_addr && $was_ip_addr)) {
			fix_system_urls($oldurl,z_root());
			set_config('system', 'urlverify', bin2hex(z_root()));
		}
		else
			logger('Attempt to change baseurl from a DNS name to an IP address was refused.');
	}

	// This will actually set the url to the one stored in .htconfig, and ignore what
	// we're passing - unless we are installing and it has never been set.

	$a->set_baseurl($a->get_baseurl());

	// Make sure each site has a system channel.  This is now created on install
	// so we just need to keep this around a couple of weeks until the hubs that
	// already exist have one
	$syschan_exists = get_sys_channel();
	if (! $syschan_exists)
		create_sys_channel();

	if($build != DB_UPDATE_VERSION) {
		$stored = intval($build);
		if(! $stored) {
			logger('Critical: check_config unable to determine database schema version');
			return;
		}
		$current = intval(DB_UPDATE_VERSION);
		if(($stored < $current) && file_exists('install/update.php')) {

			load_config('database');

			// We're reporting a different version than what is currently installed.
			// Run any existing update scripts to bring the database up to current.
			require_once('install/update.php');

			// 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.

			if(DB_UPDATE_VERSION == UPDATE_VERSION) {
				for($x = $stored; $x < $current; $x ++) {
					if(function_exists('update_r' . $x)) {
						// 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.

						if(get_config('database','update_r' . $x))
							break;
						set_config('database','update_r' . $x, '1');
						// call the specific update

						$func = 'update_r' . $x;
						$retval = $func();
						if($retval) {

							// Prevent sending hundreds of thousands of emails by creating
							// a lockfile.  

							$lockfile = 'store/[data]/mailsent';

							if ((file_exists($lockfile)) && (filemtime($lockfile) > (time() - 86400)))
									return;
							@unlink($lockfile);
							//send the administrator an e-mail
							file_put_contents($lockfile, $x);

							$email_tpl = get_intltext_template("update_fail_eml.tpl");
							$email_msg = replace_macros($email_tpl, array(
								'$sitename' => $a->config['system']['sitename'],
								'$siteurl' =>  $a->get_baseurl(),
								'$update' => $x,
								'$error' => sprintf( t('Update %s failed. See error logs.'), $x)
							));

							$subject = email_header_encode(sprintf(t('Update Error at %s'), $a->get_baseurl()));

							mail($a->config['system']['admin_email'], $subject, $email_msg,
								'From: Administrator' . '@' . $_SERVER['SERVER_NAME'] . "\n"
								. 'Content-type: text/plain; charset=UTF-8' . "\n"
								. 'Content-transfer-encoding: 8bit' );
							//try the logger
							logger('CRITICAL: Update Failed: ' . $x);
						}
						else
							set_config('database','update_r' . $x, 'success');
					}
				}
				set_config('system','db_version', DB_UPDATE_VERSION);
			}
		}
	}

	/**
	 *
	 * 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 unload 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.
	 *
	 */

	$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
	if($r)
		$installed = $r;
	else
		$installed = array();

	$plugins = get_config('system', 'addon');
	$plugins_arr = array();

	if($plugins)
		$plugins_arr = explode(',', str_replace(' ', '', $plugins));

	$a->plugins = $plugins_arr;

	$installed_arr = array();

	if(count($installed)) {
		foreach($installed as $i) {
			if(! in_array($i['name'], $plugins_arr)) {
				unload_plugin($i['name']);
			}
			else {
				$installed_arr[] = $i['name'];
			}
		}
	}

	if(count($plugins_arr)) {
		foreach($plugins_arr as $p) {
			if(! in_array($p, $installed_arr)) {
				load_plugin($p);
			}
		}
	}

	load_hooks();
}


function fix_system_urls($oldurl, $newurl) {

	require_once('include/crypto.php');

	logger('fix_system_urls: renaming ' . $oldurl . '  to ' . $newurl);

	// Basically a site rename, but this can happen if you change from http to https for instance - even if the site name didn't change
	// This should fix URL changes on our site, but other sites will end up with orphan hublocs which they will try to contact and will
	// cause wasted communications.
	// What we need to do after fixing this up is to send a revocation of the old URL to every other site that we communicate with so
	// that they can clean up their hubloc tables (this includes directories).
	// It's a very expensive operation so you don't want to have to do it often or after your site gets to be large.

	$r = q("select xchan.*, hubloc.* from xchan left join hubloc on xchan_hash = hubloc_hash where hubloc_url like '%s'",
		dbesc($oldurl . '%')
	);

	if($r) {
		foreach($r as $rr) {
			$channel_address = substr($rr['hubloc_addr'],0,strpos($rr['hubloc_addr'],'@'));

			// get the associated channel. If we don't have a local channel, do nothing for this entry.

			$c = q("select * from channel where channel_hash = '%s' limit 1",
				dbesc($rr['hubloc_hash'])
			);
			if(! $c)
				continue;

			$parsed = @parse_url($newurl);
			if(! $parsed)
				continue;
			$newhost = $parsed['host'];

			// sometimes parse_url returns unexpected results.

			if(strpos($newhost,'/') !== false)
				$newhost = substr($newhost,0,strpos($newhost,'/'));

			$rhs = $newhost . (($parsed['port']) ? ':' . $parsed['port'] : '');

			// paths aren't going to work. You have to be at the (sub)domain root
			// . (($parsed['path']) ? $parsed['path'] : '');

			// The xchan_url might point to another nomadic identity clone

			$replace_xchan_url = ((strpos($rr['xchan_url'],$oldurl) !== false) ? true : false);

			$x = q("update xchan set xchan_addr = '%s', xchan_url = '%s', xchan_connurl = '%s', xchan_follow = '%s', xchan_connpage = '%s', xchan_photo_l = '%s', xchan_photo_m = '%s', xchan_photo_s = '%s', xchan_photo_date = '%s' where xchan_hash = '%s'",
				dbesc($channel_address . '@' . $rhs),
				dbesc(($replace_xchan_url) ? str_replace($oldurl,$newurl,$rr['xchan_url']) : $rr['xchan_url']),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_connurl'])),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_follow'])),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_connpage'])),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_photo_l'])),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_photo_m'])),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_photo_s'])),
				dbesc(datetime_convert()),
				dbesc($rr['xchan_hash'])
			);

			$y = q("update hubloc set hubloc_addr = '%s', hubloc_url = '%s', hubloc_url_sig = '%s', hubloc_host = '%s', hubloc_callback = '%s' where hubloc_hash = '%s' and hubloc_url = '%s'",
				dbesc($channel_address . '@' . $rhs),
				dbesc($newurl),
				dbesc(base64url_encode(rsa_sign($newurl,$c[0]['channel_prvkey']))),
				dbesc($newhost),
				dbesc($newurl . '/post'),
				dbesc($rr['xchan_hash']),
				dbesc($oldurl)
			);

			$z = q("update profile set photo = '%s', thumb = '%s' where uid = %d",
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_photo_l'])),
				dbesc(str_replace($oldurl,$newurl,$rr['xchan_photo_m'])),
				intval($c[0]['channel_id'])
			);

			proc_run('php', 'include/notifier.php', 'refresh_all', $c[0]['channel_id']);
		}
	}
}


// wrapper for adding a login box. If $register == true provide a registration
// link. This will most always depend on the value of $a->config['system']['register_policy'].
// returns the complete html for inserting into the page

function login($register = false, $form_id = 'main-login', $hiddens=false) {
	$a = get_app();
	$o = '';
	$reg = false;
	$reglink = get_config('system', 'register_link');
	if(! strlen($reglink))
		$reglink = 'register';

	$reg = array(
		'title' => t('Create an account to access services and applications within the Red Matrix'),
		'desc' => t('Register'),
		'link' => (($register) ? $reglink : 'pubsites')
	);

	$dest_url = $a->get_baseurl(true) . '/' . $a->query_string;

	if(local_user()) {
		$tpl = get_markup_template("logout.tpl");
	}
	else {
//	There's no such thing as login_head.tpl, has never been in Red, removed from Friendica 1 Jun 2013...

//		$a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"), array(
//			'$baseurl' => $a->get_baseurl(true)
//		));

		$tpl = get_markup_template("login.tpl");
		if(strlen($a->query_string))
			$_SESSION['login_return_url'] = $a->query_string;
	}

	$o .= replace_macros($tpl,array(
		'$dest_url'     => $dest_url,
		'$logout'       => t('Logout'),
		'$login'        => t('Login'),
		'$form_id'      => $form_id,
		'$lname'        => array('username', t('Email') , '', ''),
		'$lpassword'    => array('password', t('Password'), '', ''),
		'$remember'     => array('remember', t('Remember me'), '', ''),
		'$hiddens'      => $hiddens,
		'$register'     => $reg,
		'$lostpass'     => t('Forgot your password?'),
		'$lostlink'     => t('Password Reset'),
	));

	call_hooks('login_hook', $o);

	return $o;
}


/**
 * @brief Used to end the current process, after saving session state.
 */
function killme() {
	session_write_close();
	exit;
}

/**
 * @brief Redirect to another URL and terminate this process.
 */
function goaway($s) {
	header("Location: $s");
	killme();
}

/**
 * @brief Returns the entity id of locally logged in account or false.
 *
 * Returns numeric account_id if authenticated or 0. It is possible to be
 * authenticated and not connected to a channel.
 *
 * @return int|bool account_id or false
 */
function get_account_id() {
	if(get_app()->account)
		return intval(get_app()->account['account_id']);

	return false;
}

/**
 * @brief Returns the entity id (channel_id) of locally logged in user or false.
 *
 * Returns authenticated numeric channel_id if authenticated and connected to
 * a channel or 0. Sometimes referred to as $uid in the code.
 *
 * @return int|bool channel_id or false
 */
function local_user() {
	if((x($_SESSION, 'authenticated')) && (x($_SESSION, 'uid')))
		return intval($_SESSION['uid']);

	return false;
}

/**
 * @brief Returns contact id (visitor_id) of authenticated site visitor or false.
 *
 * @return int|bool visitor_id or false
 */
function remote_user() {
	if((x($_SESSION, 'authenticated')) && (x($_SESSION, 'visitor_id')))
		return $_SESSION['visitor_id'];

	return false;
}

/**
 * Contents of $s are displayed prominently on the page the next time
 * a page is loaded. Usually used for errors or alerts.
 *
 * @param string $s Text to display
 */
function notice($s) {
	$a = get_app();
	if(! x($_SESSION, 'sysmsg')) $_SESSION['sysmsg'] = array();

	if($a->interactive) {
		// shameless plug, permission is denied and they have no identity.
		// There's a fairly good chance that they've not got zot.
		if((stristr($s, t('permission denied'))) && (! get_observer_hash())) {
			$s .= '<br><a href="http://getzot.com">' . t('Got Zot?') . '</a>';
		}
		$_SESSION['sysmsg'][] = $s;
	}
}

/**
 * Contents of $s are displayed prominently on the page the next time a page is
 * loaded. Usually used for information.
 * For error and alerts use notice().
 *
 * @param string $s Text to display
 */
function info($s) {
	$a = get_app();
	if(! x($_SESSION, 'sysmsg_info')) $_SESSION['sysmsg_info'] = array();
	if($a->interactive)
		$_SESSION['sysmsg_info'][] = $s;
}

/**
 * @brief Wrapper around config to limit the text length of an incoming message
 *
 * @return int
 */
function get_max_import_size() {
	return(intval(get_config('system', 'max_import_size')));
}


/**
 *
 * Wrap calls to proc_close(proc_open()) and call hook
 * so plugins can take part in process :)
 *
 * args:
 * $cmd program to run
 *  next args are passed as $cmd command line
 *
 * e.g.: proc_run("ls","-la","/tmp");
 *
 * $cmd and string args are surrounded with ""
 */
function proc_run($cmd){

	$a = get_app();

	$args = func_get_args();

	$newargs = array();
	if(! count($args))
		return;

	// expand any arrays

	foreach($args as $arg) {
		if(is_array($arg)) {
			foreach($arg as $n) {
				$newargs[] = $n;
			}
		}
		else
			$newargs[] = $arg;
	}

	$args = $newargs;

	$arr = array('args' => $args, 'run_cmd' => true);

	call_hooks("proc_run", $arr);
	if(! $arr['run_cmd'])
		return;

	if(count($args) && $args[0] === 'php')
		$args[0] = ((x($a->config,'system')) && (x($a->config['system'],'php_path')) && (strlen($a->config['system']['php_path'])) ? $a->config['system']['php_path'] : 'php');

	for($x = 0; $x < count($args); $x++)
		$args[$x] = escapeshellarg($args[$x]);

	$cmdline = implode($args," ");

	if(is_windows()) {
		$cwd = getcwd();
		$cmd = "cmd /c start \"title\" /D \"$cwd\" /b $cmdline";
		proc_close(proc_open($cmd, array(), $foo));
	}
	else
		proc_close(proc_open($cmdline ." &", array(), $foo));
}

/**
 * @brief Checks if we are running on M$ Windows.
 *
 * @return bool true if we run on M$ Windows
 */
function is_windows() {
	return ((strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') ? true : false);
}


function current_theme(){
	$app_base_themes = array('redbasic');

	$a = get_app();
	$page_theme = null;

	// Find the theme that belongs to the channel whose stuff we are looking at

	if($a->profile_uid && $a->profile_uid != local_user()) {
		$r = q("select channel_theme from channel where channel_id = %d limit 1",
			intval($a->profile_uid)
		);
		if($r)
			$page_theme = $r[0]['channel_theme'];
	}

	if(array_key_exists('theme', $a->layout) && $a->layout['theme'])
		$page_theme = $a->layout['theme'];

	// Allow folks to over-rule channel themes and always use their own on their own site.
	// The default is for channel themes to take precedence over your own on pages belonging
	// to that channel.

	if($page_theme && local_user() && local_user() != $a->profile_url) {
		if(get_pconfig(local_user(),'system','always_my_theme'))
			$page_theme = null;
	}

	$is_mobile = $a->is_mobile || $a->is_tablet;

	$standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : '');
	$standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme);

	if($is_mobile) {
		if(isset($_SESSION['show_mobile']) && !$_SESSION['show_mobile']) {
			$system_theme = $standard_system_theme;
			$theme_name = $standard_theme_name;
		}
		else {
			$system_theme = ((isset($a->config['system']['mobile_theme'])) ? $a->config['system']['mobile_theme'] : '');
			$theme_name = ((isset($_SESSION) && x($_SESSION,'mobile_theme')) ? $_SESSION['mobile_theme'] : $system_theme);

			if($theme_name === '' || $theme_name === '---' ) {
				// user has selected to have the mobile theme be the same as the normal one
				$system_theme = $standard_system_theme;
				$theme_name = $standard_theme_name;
			}
		}
	}
	else {
		$system_theme = $standard_system_theme;
		$theme_name = $standard_theme_name;

		if($page_theme)
			$theme_name = $page_theme;
	}

	if($theme_name &&
			(file_exists('view/theme/' . $theme_name . '/css/style.css') ||
					file_exists('view/theme/' . $theme_name . '/php/style.php')))
		return($theme_name);

	foreach($app_base_themes as $t) {
		if(file_exists('view/theme/' . $t . '/css/style.css') ||
			file_exists('view/theme/' . $t . '/php/style.php'))
			return($t);
	}

	$fallback = array_merge(glob('view/theme/*/css/style.css'),glob('view/theme/*/php/style.php'));
	if(count($fallback))
		return (str_replace('view/theme/','', substr($fallback[0],0,-10)));

}


/**
 * @brief Return full URL to theme which is currently in effect.
 *
 * Provide a sane default if nothing is chosen or the specified theme does not exist.
 *
 * @param bool $installing default false
 *
 * @return string
 */
function current_theme_url($installing = false) {
	global $a;

	$t = current_theme();

	$opts = '';
	$opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
	$opts .= ((x($a->layout,'schema')) ? '&schema=' . $a->layout['schema'] : '');
	if(file_exists('view/theme/' . $t . '/php/style.php'))
		return('view/theme/' . $t . '/php/style.pcss' . $opts);

	return('view/theme/' . $t . '/css/style.css');
}

/**
 * @brief Check if current user has admin role.
 *
 * Check if the current user has ACCOUNT_ROLE_ADMIN.
 *
 * @return bool true if user is an admin
 */
function is_site_admin() {
	$a = get_app();

	if((intval($_SESSION['authenticated']))
		&& (is_array($a->account))
		&& ($a->account['account_roles'] & ACCOUNT_ROLE_ADMIN))
		return true;

	return false;
}

/**
 * @brief Check if current user has developer role.
 *
 * Check if the current user has ACCOUNT_ROLE_DEVELOPER.
 *
 * @return bool true if user is a developer
 */
function is_developer() {
	$a = get_app();
	if((intval($_SESSION['authenticated']))
		&& (is_array($a->account))
		&& ($a->account['account_roles'] & ACCOUNT_ROLE_DEVELOPER))
		return true;

	return false;
}


function load_contact_links($uid) {
	$a = get_app();

	$ret = array();

	if(! $uid || x($a->contacts,'empty'))
		return;

//	logger('load_contact_links');

	$r = q("SELECT abook_id, abook_flags, abook_my_perms, abook_their_perms, xchan_hash, xchan_photo_m, xchan_name, xchan_url from abook left join xchan on abook_xchan = xchan_hash where abook_channel = %d ",
		intval($uid)
	);
	if($r) {
		foreach($r as $rr){
			$ret[$rr['xchan_hash']] = $rr;
		}
	}
	else
		$ret['empty'] = true;

	$a->contacts = $ret;
}


/**
 * @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)) {
			if($name === null) {
				$ret .= build_querystring($val, $key);
			} else {
				$ret .= build_querystring($val, $name . "[$key]");
			}
		} else {
			$val = urlencode($val);
			if($name != null) {
				$ret .= $name . "[$key]" . "=$val&";
			} else {
				$ret .= "$key=$val&";
			}
		}
	}
	return $ret;
}


// much better way of dealing with c-style args

function argc() {
	return get_app()->argc;
}

function argv($x) {
	if(array_key_exists($x,get_app()->argv))
		return get_app()->argv[$x];

	return '';
}

function dba_timer() {
	return microtime(true);
}

/**
 * @brief Returns xchan_hash from the observer.
 *
 * @return string Empty if no observer, otherwise xchan_hash from observer
 */
function get_observer_hash() {
	$observer = get_app()->get_observer();
	if(is_array($observer))
		return $observer['xchan_hash'];

	return '';
}


/**
 * 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";}
	$pageURL .= "://";
	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;
}

/**
 * @brief Returns a custom navigation by name???
 *
 * If no $navname provided load default page['nav']
 *
 * @todo not fully implemented yet
 *
 * @param App $a global application object
 * @param string $navname
 *
 * @return mixed
 */
function get_custom_nav(&$a, $navname) {
	if(! $navname)
		return $a->page['nav'];
	// load custom nav menu by name here
}

/**
 * @brief Loads a page definition file for a module.
 *
 * If there is no parsed Comanche template already load a module's pdl file
 * and parse it with Comanche.
 *
 * @param App &$a global application object
 */
function load_pdl(&$a) {
	require_once('include/comanche.php');

	if(! count($a->layout)) {
		$n = 'mod_' . $a->module . '.pdl' ;
		$u = comanche_get_channel_id();
		if($u)
			$s = get_pconfig($u, 'system', $n);

		if((! $s) && (($p = theme_include($n)) != ''))
			$s = @file_get_contents($p);

		if($s)
			comanche_parser($a, $s);
	}
}

/**
 * @brief build the page.
 *
 * Build the page - now that we have all the components
 *
 * @param App &$a global application object
 */
function construct_page(&$a) {

	$comanche = ((count($a->layout)) ? true : false);

	require_once(theme_include('theme_init.php'));

	$installing = false;

	if($a->module == 'setup') {
		$installing = true;
	} else {
		nav($a);
	}

	if($comanche) {
		if($a->layout['nav']) {
			$a->page['nav'] = get_custom_nav($a, $a->layout['nav']);
		}
	}

	if(($p = theme_include(current_theme() . '.js')) != '')
		head_add_js($p);

	if(($p = theme_include('mod_' . $a->module . '.php')) != '')
		require_once($p);

	require_once('include/js_strings.php');

	if(x($a->page, 'template_style'))
		head_add_css($a->page['template_style'] . '.css');
	else
		head_add_css(((x($a->page, 'template')) ? $a->page['template'] : 'default' ) . '.css');

	head_add_css('mod_' . $a->module . '.css');
	head_add_css(current_theme_url($installing));

	head_add_js('mod_' . $a->module . '.js');

	$a->build_pagehead();

	$arr = $a->get_widgets();
	ksort($arr, SORT_NUMERIC);
	if(count($arr)) {
		foreach($arr as $x) {
			if(! array_key_exists($x['location'], $a->page))
				$a->page[$x['location']] = '';

			$a->page[$x['location']] .= $x['html'];
		}
	}

	// Let's say we have a comanche declaration '[region=nav][/region][region=content]$nav $content[/region]'.
	// The text 'region=' identifies a section of the layout by that name. So what we want to do here is leave
	// $a->page['nav'] empty and put the default content from $a->page['nav'] and $a->page['section']
	// into a new region called $a->data['content']. It is presumed that the chosen layout file for this comanche page
	// has a '<content>' element instead of a '<section>'.

	// This way the Comanche layout can include any existing content, alter the layout by adding stuff around it or changing the
	// layout completely with a new layout definition, or replace/remove existing content.

	if($comanche) {
		$arr = array('module' => $a->module, 'layout' => $a->layout);
		call_hooks('construct_page', $arr);
		$a->layout = $arr['layout'];

		foreach($a->layout as $k => $v) {
			if((strpos($k, 'region_') === 0) && strlen($v)) {
				if(strpos($v, '$region_') !== false) {
					$v = preg_replace_callback('/\$region_([a-zA-Z0-9]+)/ism', 'comanche_replace_region', $v);
				}

				// And a couple of convenience macros

				if(strpos($v, '$nav') !== false) {
					$v = str_replace('$nav', $a->page['nav'], $v);
				}
				if(strpos($v, '$content') !== false) {
					$v = str_replace('$content', $a->page['content'], $v);
				}

				$a->page[substr($k, 7)] = $v;
			}
		}
	}

	if($a->is_mobile || $a->is_tablet) {
		if(isset($_SESSION['show_mobile']) && !$_SESSION['show_mobile']) {
			$link = $a->get_baseurl() . '/toggle_mobile?f=&address=' . curPageURL();
		}
		else {
			$link = $a->get_baseurl() . '/toggle_mobile?f=&off=1&address=' . curPageURL();
		}
		if ((isset($_SESSION) && $_SESSION['mobile_theme'] !='' && $_SESSION['mobile_theme'] !='---' ) ||
			(isset($a->config['system']['mobile_theme']) && !isset($_SESSION['mobile_theme']))) {
			$a->page['footer'] .= replace_macros(get_markup_template("toggle_mobile_footer.tpl"), array(
				'$toggle_link' => $link,
				'$toggle_text' => t('toggle mobile')
			));
		}
	}

	$page    = $a->page;
	$profile = $a->profile;

	header("Content-type: text/html; charset=utf-8");

	require_once(theme_include(
		((x($a->page, 'template')) ? $a->page['template'] : 'default' ) . '.php' )
	);
}

/**
 * @brief Returns RedMatrix's root directory.
 *
 * @return string
 */
function appdirpath() {
	return dirname(__FILE__);
}

/**
 * @brief Set a pageicon.
 *
 * @param string $icon
 */
function head_set_icon($icon) {
	global $a;

	$a->data['pageicon'] = $icon;
//	logger('head_set_icon: ' . $icon);
}

/**
 * @brief Get the pageicon.
 *
 * @return string absolut path to pageicon
 */
function head_get_icon() {
	global $a;

	$icon = $a->data['pageicon'];
	if(! strpos($icon, '://'))
		$icon = z_root() . $icon;

	return $icon;
}

/**
 * @brief Return the Realm of the directory.
 *
 * @return string
 */
function get_directory_realm() {
	if($x = get_config('system', 'directory_realm'))
		return $x;

	return DIRECTORY_REALM;
}


/**
 * @brief return relative date of last completed poller execution
 */

function get_poller_runtime() {
	$t = get_config('system','lastpoll');
	return relative_date($t);
}

function z_get_upload_dir() {
	$upload_dir = get_config('system','uploaddir');
	if(! $upload_dir)
		$upload_dir = ini_get('upload_tmp_dir');
	if(! $upload_dir)
		$upload_dir = sys_get_temp_dir();
	return $upload_dir;
}

function z_get_temp_dir() {
	$temp_dir = get_config('system','tempdir');
	if(! $temp_dir)
		$temp_dir = sys_get_temp_dir();
	return $upload_dir;
}