check valid theme
// public $http_theme_dir; // class2 -> check valid theme
/**
* Contains reference to global $_E107 array
* Assignment is done inside prepare_request() method
*
* @var array
*/
protected $_E107 = array();
/**
* @var string Current request type (http or https)
*/
protected $HTTP_SCHEME;
/**
* Used for runtime caching of user extended struct
*
* @var array
* @see e107::user()
*/
public $extended_struct;
/**
* User login name
*
* @var array
* @see init_session()
*/
public $currentUser;
/**
* Run once load core shortcodes
* while initialize SC parser
*
* @var boolean
*/
// protected static $_sc_core_loaded = false;
/**
* Singleton instance
* Allow class extends - override {@link getInstance()}
*
* @var e107
*/
protected static $_instance;
/**
* e107 registry
*
* @var array
*/
private static $_registry = array();
/**
* e107 core config object storage
*
* @var array
*/
protected static $_core_config_arr = array();
/**
* e107 plugin config object storage
*
* @var array
*/
protected static $_plug_config_arr = array();
/**
* e107 theme config object storage
*
* @var array
*/
protected static $_theme_config_arr = array();
/**
* e107 e107::css() on/off flag.
*
* @var bool
*/
protected static $_css_enabled = true;
/**
* e107 e107::js() on/off flag.
*
* @var bool
*/
protected static $_js_enabled = true;
protected static $_breadcrumb = array();
/**
* Core handlers array
* For new/missing handler add
* 'class name' => 'path' pair
*
* Used to auto-load core/plugin handlers
* NOTE: aplhabetically sorted! (by class name)
*
* @see addHandler()
* @see setHandlerOverload()
* @see getSingleton()
* @see getObject()
* @var array
*/
protected static $_known_handlers = array(
'UserHandler' => '{e_HANDLER}user_handler.php',
'comment' => '{e_HANDLER}comment_class.php',
'e_date' => '{e_HANDLER}date_handler.php',
'convert' => '{e_HANDLER}date_handler.php', // BC Fix.
'db' => '{e_HANDLER}e_db_pdo_class.php',
// 'db' => '{e_HANDLER}mysql_class.php',
'e107Email' => '{e_HANDLER}mail.php',
'e107_event' => '{e_HANDLER}event_class.php',
'e107_db_debug' => '{e_HANDLER}db_debug_class.php',
'e107_traffic' => '{e_HANDLER}traffic_class.php',
'e107_user_extended' => '{e_HANDLER}user_extended_class.php',
'e107plugin' => '{e_HANDLER}plugin_class.php',
'e_chart' => '{e_HANDLER}chart_class.php',
'e_core_session' => '{e_HANDLER}session_handler.php',
'e_admin_controller' => '{e_HANDLER}admin_ui.php',
'e_admin_controller_ui' => '{e_HANDLER}admin_ui.php',
'e_admin_dispatcher' => '{e_HANDLER}admin_ui.php',
'e_admin_form_ui' => '{e_HANDLER}admin_ui.php',
'e_admin_log' => '{e_HANDLER}admin_log_class.php',
'e_front_model' => '{e_HANDLER}model_class.php',
'e_admin_model' => '{e_HANDLER}model_class.php',
'e_admin_request' => '{e_HANDLER}admin_ui.php',
'e_admin_response' => '{e_HANDLER}admin_ui.php',
'e_admin_ui' => '{e_HANDLER}admin_ui.php',
'e_ajax' => '{e_HANDLER}e_ajax_class.php',
'e_array' => '{e_HANDLER}core_functions.php', // Old ArrayStorage.
'e_bbcode' => '{e_HANDLER}bbcode_handler.php',
'e_bb_base' => '{e_HANDLER}bbcode_handler.php',
'e_customfields' => '{e_HANDLER}e_customfields_class.php',
'e_emote' => '{e_HANDLER}e_emote_class.php',
'e_file' => '{e_HANDLER}file_class.php',
'e_file_inspector_json_phar' => '{e_HANDLER}e_file_inspector_json_phar.php',
'e_form' => '{e_HANDLER}form_handler.php',
'e_jshelper' => '{e_HANDLER}js_helper.php',
'e_media' => '{e_HANDLER}media_class.php',
'e_menu' => '{e_HANDLER}menu_class.php',
'e_model' => '{e_HANDLER}model_class.php',
'e_navigation' => '{e_HANDLER}sitelinks_class.php',
'e_news_item' => '{e_HANDLER}news_class.php',
'e_news_tree' => '{e_HANDLER}news_class.php',
'e_news_category_tree' => '{e_HANDLER}news_class.php',
'e_object' => '{e_HANDLER}model_class.php',
'e_online' => '{e_HANDLER}online_class.php',
'e_parse' => '{e_HANDLER}e_parse_class.php',
'e_parser' => '{e_HANDLER}e_parse_class.php',
'e_parse_shortcode' => '{e_HANDLER}shortcode_handler.php',
'e_plugin' => '{e_HANDLER}plugin_class.php',
'e_profanity' => '{e_HANDLER}e_profanity_class.php',
'e_ranks' => '{e_HANDLER}e_ranks_class.php',
'e_render' => '{e_HANDLER}e_render_class.php',
'e_search' => '{e_HANDLER}search_class.php',
'e_shortcode' => '{e_HANDLER}shortcode_handler.php',
'e_system_user' => '{e_HANDLER}user_model.php',
'e_theme' => '{e_HANDLER}theme_handler.php',
'e_upgrade' => '{e_HANDLER}e_upgrade_class.php',
'e_user_model' => '{e_HANDLER}user_model.php',
'e_user' => '{e_HANDLER}user_model.php',
'e_user_extended_structure_tree' => '{e_HANDLER}user_model.php',
'e_user_provider' => '{e_HANDLER}user_handler.php',
'e_userperms' => '{e_HANDLER}user_handler.php',
'e_validator' => '{e_HANDLER}validator_class.php',
'e_vars' => '{e_HANDLER}model_class.php',
'e_url' => '{e_HANDLER}application.php',
'ecache' => '{e_HANDLER}cache_handler.php',
'eController' => '{e_HANDLER}application.php',
'eDispatcher' => '{e_HANDLER}application.php',
'eException' => '{e_HANDLER}application.php',
'eFront' => '{e_HANDLER}application.php',
'eHelper' => '{e_HANDLER}application.php',
'eIPHandler' => '{e_HANDLER}iphandler_class.php',
'email_validation_class' => '{e_HANDLER}mail_validation_class.php',
'eMessage' => '{e_HANDLER}message_handler.php',
'eRequest' => '{e_HANDLER}application.php',
'eResponse' => '{e_HANDLER}application.php',
'eRouter' => '{e_HANDLER}application.php',
'eShims' => '{e_HANDLER}Shims/eShims.php',
'eUrl' => '{e_HANDLER}e107Url.php',
'eUrlConfig' => '{e_HANDLER}application.php',
'eUrlRule' => '{e_HANDLER}application.php',
'language' => '{e_HANDLER}language_class.php',
'news' => '{e_HANDLER}news_class.php',
'notify' => '{e_HANDLER}notify_class.php',
'override' => '{e_HANDLER}override_class.php',
'rater' => '{e_HANDLER}rate_class.php',
'redirection' => '{e_HANDLER}redirection_class.php',
'secure_image' => '{e_HANDLER}secure_img_handler.php',
'sitelinks' => '{e_HANDLER}sitelinks_class.php',
'themeHandler' => '{e_HANDLER}theme_handler.php',
'user_class' => '{e_HANDLER}userclass_class.php',
'user_class_admin' => '{e_HANDLER}userclass_class.php',
'userlogin' => '{e_HANDLER}login.php',
'validatorClass' => '{e_HANDLER}validator_class.php',
'xmlClass' => '{e_HANDLER}xml_class.php',
'e107MailManager' => '{e_HANDLER}mail_manager_class.php',
'e_library_manager' => '{e_HANDLER}library_manager.php',
'error_page' => '{e_HANDLER}error_page_class.php',
// Core plugin auto-loaders.
'pageHelper' => '{e_PLUGIN}page/includes/pageHelper.php'
);
/**
* Overload core handlers array
* Format: 'core_class' => array('overload_class', 'overload_path');
*
* NOTE: to overload core singleton objects, you have to add record to
* $_overload_handlers before the first singleton call.
*
* Example:
* array('e_form' => array('plugin_myplugin_form_handler' => '{e_PLUGIN}myplugin/includes/form/handler.php'));
*
* Used to auto-load core handlers
*
* @var array
*/
protected static $_overload_handlers = array();
/**
* Constructor
*
* Use {@link getInstance()}, direct instantiating
* is not possible for singleton objects
*
*/
protected function __construct()
{
// FIXME registered shutdown functions not executed after the $page output in footer - investigate
// Currently manually called in front-end/admin footer
//register_shutdown_function(array($this, 'destruct'));
}
/**
* @return void
*/
private static function die_http_400()
{
header('HTTP/1.0 400 Bad Request', true, 400);
header('Content-Type: text/plain');
if (deftrue('e_DEBUG'))
{
echo "Bad Request: ";
debug_print_backtrace(0, 1);
}
exit();
}
/**
* Render layout - replacement for legacy parseheader() function in header_default.php
* @param string $LAYOUT
* @param array $opts - 'magicSC' => array of magic shortcode key=>value pair replacements and 'bodyStart' - code to place after body tag.
* @return void
*/
public static function renderLayout($LAYOUT, $opts = array())
{
if(empty($LAYOUT))
{
$LAYOUT = '';
}
$tp = self::getParser();
$tmp = explode("\n", $LAYOUT);
$sc = isset($opts['sc']) ? self::getScBatch($opts['sc']) : self::getScBatch('_theme_'); // include the theme shortcodes.
$parseMagic = false;
$bodyStart = false;
$bodyTag = false;
if(isset($opts['magicSC']))
{
$search = array_keys($opts['magicSC']);
$replace = array_values($opts['magicSC']);
$parseMagic = true;
}
if(isset($opts['bodyStart']) && !empty($opts['bodyStart']))
{
$bodyStart = true;
}
foreach ($tmp as $k=>$line)
{
if(empty($line))
{
continue;
}
if($bodyStart)
{
if($bodyTag)
{
echo "\n\n";
echo trim($opts['bodyStart'])."\n";
echo "\n\n";
}
$bodyTag = (strpos(trim($line), 'parseTemplate($line, true, $sc) . "\n"; // retain line-breaks.
}
}
}
/**
* @param string $plug_name
*/
private static function _loadPluginLans($plug_name)
{
if(is_dir(e_PLUGIN . $plug_name . "/languages"))
{
self::plugLan($plug_name, '', true); // English/English_front.php
self::plugLan($plug_name, null, true); // English/English.php
// self::plugLan($plug_name, 'front'); // English_front.php
self::plugLan($plug_name, null); // English.php
self::plugLan($plug_name, 'global', true); // English/English_global.php
self::plugLan($plug_name, 'global'); // English_global.php
}
}
/**
* Returns the frontpage setting (ie. selected in e107_admin/frontpage.php) for the current user.
* @return string
*/
public static function getFrontpage()
{
$fpref = e107::getPref('frontpage');
$location = '';
$class_list = explode(',', USERCLASS_LIST);
if(isset($fpref['all']) && $fpref['all'])
{ // 0.7 method
$location = $fpref['all'];
}
else
{ // This is the 'new' method - assumes $fpref is an ordered list of rules
if(!empty($fpref))
{
foreach($fpref as $fk => $fp)
{
if(in_array($fk, $class_list))
{
$location = $fp;
break;
}
}
}
}
if(!$location)
{ // Try and use the 'old' method (this bit can go later)
if(ADMIN)
{
$location = varset($fpref[e_UC_ADMIN]);
}
elseif(USER)
{ // This is the key bit - what to do for a 'normal' logged in user
// We have USERCLASS_LIST - comma separated. Also e_CLASS_REGEXP
$inclass = false;
foreach($class_list as $fp_class)
{
if(!$inclass && check_class($fp_class['userclass_id']))
{
$location = $fpref[$fp_class['userclass_id']];
$inclass = true;
}
}
$location = $location ? $location : $fpref[e_UC_MEMBER];
}
else
{
$location = $fpref[e_UC_GUEST];
}
}
$location = trim($location);
// Defaults to news
if(!$location)
{
$location = 'url:/news';
}
// Former Welcome Message front-page. Should be handled by current theme layout
elseif($location == 'index.php' || $location == 'url:/' || $location == 'route:/' || $location == '/')
{
$location = false;
}
elseif($location[0] === '{')
{
$location = e107::getParser()->replaceConstants($location, true);
}
return $location;
}
/**
* Cloning is not allowed
*
*/
private function __clone()
{
}
/**
* Get singleton instance (php4 no more supported)
*
* @return e107
*/
public static function getInstance()
{
if(self::$_instance == null)
{
self::$_instance = new self();
}
return self::$_instance;
}
/**
* Initialize environment path constants
* Public proxy to the protected method {@link _init()}
*
* @param $e107_paths
* @param $e107_root_path
* @param $e107_config_mysql_info
* @param array $e107_config_override
* @return e107
*/
public function initCore($e107_paths, $e107_root_path, $e107_config_mysql_info, $e107_config_override = array())
{
return $this->_init($e107_paths, $e107_root_path, $e107_config_mysql_info, $e107_config_override);
}
/**
* Initialize environment path constants while installing e107
*
* @param $e107_paths
* @param $e107_root_path
* @param array $e107_config_override
* @return object|boolean e107
*/
public function initInstall($e107_paths, $e107_root_path, $e107_config_override = array())
{
$e107_config = 'e107_config.php';
if (!file_exists($e107_config) && file_put_contents($e107_config, '') === false) // prevent blank-page with missing file during install.
{
return false;
}
// Do some security checks/cleanup, prepare the environment
$this->prepare_request();
//generated from mysql data at stage 5 of install.
$this->site_path = isset($e107_config_override['site_path']) ? $e107_config_override['site_path'] : "[hash]"; // placeholder
// folder info
//$this->e107_dirs = $e107_paths;
$this->setDirs($e107_paths, $e107_config_override);
// build all paths
$this->set_paths();
$this->file_path = $this->fix_windows_paths($e107_root_path)."/";
// set base path, SSL is auto-detected
$this->set_base_path();
// cleanup QUERY_STRING and friends, set related constants
$this->set_request();
// set some core URLs (e_LOGIN/SIGNUP)
$this->set_urls();
return $this;
}
/**
* Resolve paths, will run only once
*
* @param $e107_paths
* @param $e107_root_path
* @param $e107_config_mysql_info
* @param array $e107_config_override
* @return e107
*/
protected function _init($e107_paths, $e107_root_path, $e107_config_mysql_info, $e107_config_override = array())
{
if(!empty($this->e107_dirs))
{
return $this;
}
// Do some security checks/cleanup, prepare the environment
$this->prepare_request();
// mysql connection info
$this->e107_config_mysql_info = $e107_config_mysql_info;
// unique folder for e_MEDIA - support for multiple websites from single-install. Must be set before setDirs()
/* if (!empty($e107_config_override['site_path']))
{
// $E107_CONFIG['site_path']
$this->site_path = $e107_config_override['site_path'];
}*/
if(empty($e107_config_override['site_path']))
{
$this->site_path = $this->makeSiteHash($e107_config_mysql_info['mySQLdefaultdb'], $e107_config_mysql_info['mySQLprefix']);
}
// Set default folder (and override paths) if missing from e107_config.php
$this->setDirs($e107_paths, $e107_config_override);
// various constants - MAGIC_QUOTES_GPC, MPREFIX, ...
$this->set_constants();
// build all paths
$this->set_paths();
$this->file_path = $this->fix_windows_paths($e107_root_path);
// set base path, SSL is auto-detected
$this->set_base_path();
// cleanup QUERY_STRING and friends, set related constants
$this->set_request();
// set some core URLs (e_LOGIN/SIGNUP)
$this->set_urls();
if(!is_dir(e_SYSTEM))
{
mkdir(e_SYSTEM, 0755, true);
}
if(!is_dir(e_CACHE_IMAGE))
{
mkdir(e_CACHE_IMAGE, 0755, true);
}
// Prepare essential directories.
$this->prepareDirs();
return $this;
}
/**
* Create a unique hash for each database configuration (multi-site support).
*/
function makeSiteHash($db, $prefix) // also used by install.
{
return substr(md5($db . "." . $prefix), 0, 10);
}
/**
* Set system folders and override paths
* $e107_paths is the 'compact' version of e107_config folder vars ($ADMIN_DIRECTORY, $IMAGES_DIRECTORY, etc)
* $e107_config_override is the new override method - it can do it for all server and http paths via
* the newly introduced $E107_CONFIG array.
*
* Overriding just replace _DIRECTORY with _SERVER or _HTTP:
* - override server path example:
* $E107_CONFIG['SYSTEM_SERVER'] = '/home/user/system/';
*
* - override http path example:
* $E107_CONFIG['MEDIA_VIDEOS_HTTP'] = 'http://static.mydomain.com/videos/';
*
* @param array $e107_dirs Override folder instructions (*_DIRECTORY vars - e107_config.php)
* @param array $e107_config_override Override path insructions ($E107_CONFIG array - e107_config.php)
* @return e107
*/
public function setDirs($e107_dirs, $e107_config_override = array())
{
if(!empty($e107_config_override['site_path'])) // $E107_CONFIG['site_path']
{
$this->site_path = $e107_config_override['site_path'];
}
$override = array_merge((array) $e107_dirs, (array) $e107_config_override);
// override all
$this->e107_dirs = array_merge($this->defaultDirs($override), $override);
// Required for e_MEDIA_BASE, e_SYSTEM_BASE (free of site path constants);
// $this->e107_dirs['MEDIA_BASE_DIRECTORY'] = $this->e107_dirs['MEDIA_DIRECTORY'];
// $this->e107_dirs['SYSTEM_BASE_DIRECTORY'] = $this->e107_dirs['SYSTEM_BASE_DIRECTORY'];
// $this->site_path is appended to MEDIA_DIRECTORY in defaultDirs(), which is called above.
if(strpos($this->e107_dirs['MEDIA_DIRECTORY'],$this->site_path) === false)
{
$this->e107_dirs['MEDIA_DIRECTORY'] .= $this->site_path."/"; // multisite support.
}
// FIXME - remove this condition because:
// $this->site_path is appended to SYSTEM_DIRECTORY in defaultDirs(), which is called above.
if(strpos($this->e107_dirs['SYSTEM_DIRECTORY'],$this->site_path) === false)
{
$this->e107_dirs['SYSTEM_DIRECTORY'] .= $this->site_path."/"; // multisite support.
}
if(strpos($this->e107_dirs['CACHE_DIRECTORY'], $this->site_path) === false)
{
$this->e107_dirs['CACHE_DIRECTORY'] = $this->e107_dirs['SYSTEM_DIRECTORY']."cache/"; // multisite support.
}
return $this;
}
/**
* Prepares essential directories.
*/
public function prepareDirs()
{
$file = self::getFile();
// Essential directories which should be created and writable.
$essential_directories = array(
'MEDIA_DIRECTORY',
'SYSTEM_DIRECTORY',
'CACHE_DIRECTORY',
'CACHE_CONTENT_DIRECTORY',
'CACHE_IMAGE_DIRECTORY',
'CACHE_DB_DIRECTORY',
'CACHE_URL_DIRECTORY',
'LOGS_DIRECTORY',
'BACKUP_DIRECTORY',
'TEMP_DIRECTORY',
'IMPORT_DIRECTORY',
);
// Create directories which don't exist.
foreach($essential_directories as $directory)
{
if (!isset($this->e107_dirs[$directory])) {
continue;
}
$path = e_ROOT . $this->e107_dirs[$directory];
$file->prepareDirectory($path, FILE_CREATE_DIRECTORY);
}
}
/**
* Get default e107 folders, root folders can be overridden by passed override array
*
* @param array $override_root
* @param boolean $return_root
* @return array
*/
public function defaultDirs($override_root = array(), $return_root = false)
{
$ret = array_merge(array(
'ADMIN_DIRECTORY' => 'e107_admin/',
'IMAGES_DIRECTORY' => 'e107_images/',
'THEMES_DIRECTORY' => 'e107_themes/',
'PLUGINS_DIRECTORY' => 'e107_plugins/',
'FILES_DIRECTORY' => 'e107_files/', // DEPRECATED!!!
'HANDLERS_DIRECTORY' => 'e107_handlers/',
'LANGUAGES_DIRECTORY' => 'e107_languages/',
'DOCS_DIRECTORY' => 'e107_docs/',
'MEDIA_DIRECTORY' => 'e107_media/',
'SYSTEM_DIRECTORY' => 'e107_system/',
'CORE_DIRECTORY' => 'e107_core/',
'WEB_DIRECTORY' => 'e107_web/',
), (array) $override_root);
$ret['MEDIA_BASE_DIRECTORY'] = $ret['MEDIA_DIRECTORY'];
$ret['SYSTEM_BASE_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'];
$ret['MEDIA_DIRECTORY'] .= $this->site_path."/"; // multisite support.
$ret['SYSTEM_DIRECTORY'] .= $this->site_path."/"; // multisite support.
if($return_root)
{
return $ret;
}
$ret['HELP_DIRECTORY'] = $ret['DOCS_DIRECTORY'].'help/';
$ret['MEDIA_IMAGES_DIRECTORY'] = $ret['MEDIA_DIRECTORY'].'images/';
$ret['MEDIA_ICONS_DIRECTORY'] = $ret['MEDIA_DIRECTORY'].'icons/';
$ret['MEDIA_VIDEOS_DIRECTORY'] = $ret['MEDIA_DIRECTORY'].'videos/';
$ret['MEDIA_FILES_DIRECTORY'] = $ret['MEDIA_DIRECTORY'].'files/';
$ret['MEDIA_UPLOAD_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'].'temp/'; // security measure. Media is public, system is private.
$ret['AVATARS_DIRECTORY'] = $ret['MEDIA_DIRECTORY'].'avatars/';
$ret['WEB_JS_DIRECTORY'] = $ret['WEB_DIRECTORY'].'js/';
// $ret['WEB_JS_DIRECTORY'] = $ret['FILES_DIRECTORY'].'jslib/';
$ret['WEB_CSS_DIRECTORY'] = $ret['WEB_DIRECTORY'].'css/';
$ret['WEB_IMAGES_DIRECTORY'] = $ret['WEB_DIRECTORY'].'images/';
// $ret['WEB_PACKS_DIRECTORY'] = $ret['WEB_DIRECTORY'].'packages/';
$ret['DOWNLOADS_DIRECTORY'] = $ret['MEDIA_FILES_DIRECTORY'];
$ret['UPLOADS_DIRECTORY'] = $ret['MEDIA_UPLOAD_DIRECTORY'];
$ret['CACHE_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'].'cache/';
$ret['CACHE_CONTENT_DIRECTORY'] = $ret['CACHE_DIRECTORY'].'content/';
if(defined('e_MEDIA_STATIC')) // experimental - subject to change.
{
$ret['CACHE_IMAGE_DIRECTORY'] = $ret['MEDIA_IMAGES_DIRECTORY'].'cache/';
}
else
{
$ret['CACHE_IMAGE_DIRECTORY'] = $ret['CACHE_DIRECTORY'].'images/';
}
$ret['CACHE_DB_DIRECTORY'] = $ret['CACHE_DIRECTORY'].'db/';
$ret['CACHE_URL_DIRECTORY'] = $ret['CACHE_DIRECTORY'].'url/';
$ret['AVATARS_UPLOAD_DIRECTORY'] = $ret['AVATARS_DIRECTORY'].'upload/';
$ret['AVATARS_DEFAULT_DIRECTORY'] = $ret['AVATARS_DIRECTORY'].'default/';
$ret['LOGS_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'].'logs/';
$ret['BACKUP_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'].'backup/';
$ret['TEMP_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'].'temp/';
$ret['IMPORT_DIRECTORY'] = $ret['SYSTEM_DIRECTORY'].'import/';
return $ret;
}
/**
* Set mysql data
*
* @param $e107_config_mysql_info
* @return e107
*/
public function initInstallSql($e107_config_mysql_info)
{
// mysql connection info
$this->e107_config_mysql_info = $e107_config_mysql_info;
// various constants - MAGIC_QUOTES_GPC, MPREFIX, ...
$this->set_constants();
return $this;
}
/**
* Get data from the registry
* Returns $default if data not found
* Replacement of cachevar()
*
* @param string $id
* @param null $default
* @return mixed
*/
public static function getRegistry($id, $default = null)
{
if(isset(self::$_registry[$id]))
{
return self::$_registry[$id];
}
if($id === '_all_')
{
return self::$_registry;
}
return $default;
}
/**
* Add data to the registry - replacement of getcachedvars().
* $id is path-like unique id bind to the passed data.
* If $data argument is null, $id will be removed from the registry.
* When removing objects from the registry, __destruct() method will be auto-executed
* if available
*
* Naming standards (namespaces):
* 'area/area_id/storage_type'
* where
* - area = 'core'|'plugin'|'external' (everything else)
* - area_id = core handler id|plugin name (depends on area)
* - (optional) storage_type = current data storage stack
*
* Examples:
* - 'core/e107/' - reserved for this class
* - 'core/e107/singleton/' - singleton objects repo {@link getSingleton()}
*
* @param string $id
* @param mixed|null $data
* @param bool $allow_override
*/
public static function setRegistry($id, $data = null, $allow_override = true)
{
if($data === null)
{
if(isset(self::$_registry[$id]) && is_object(self::$_registry[$id]) && method_exists(self::$_registry[$id], '__destruct'))
{
self::$_registry[$id]->__destruct();
}
unset(self::$_registry[$id]);
return;
}
if(!$allow_override && self::getRegistry($id) !== null)
{
return;
}
self::$_registry[$id] = $data;
}
/**
* Get folder name (e107_config)
* Replaces all $(*)_DIRECTORY globals.
* @example
* Example: $e107->getFolder('images');
*
* @param string $for admin | plugins | themes | files | handlers
* @return string
*/
public static function getFolder($for)
{
$key = strtoupper($for).'_DIRECTORY';
$self = self::getInstance();
return (isset($self->e107_dirs[$key]) ? $self->e107_dirs[$key] : '');
}
/**
* Get value from $_E107 config array
* Note: will always return false if called before prepare_request() method!
*
* @param string $key
* @return boolean|array
*/
public static function getE107($key = null)
{
$self = self::getInstance();
if($key === null)
{
return $self->_E107;
}
return ((isset($self->_E107[$key]) && $self->_E107[$key]));
}
/**
* Convenient proxy to $_E107 getter - check if
* the system is currently running in cli mode
* Note: will always return false if called before prepare_request() method!
*
* @return boolean
*/
public static function isCli()
{
if(PHP_SAPI === 'cli')
{
return true;
}
return self::getE107('cli');
}
/**
* Get mysql config var (e107_config.php)
* Replaces all $mySQL(*) globals
* Example: $e107->getMySQLConfig('prefix');
*
* @param string $for prefix|server|user|password|defaultdb - leave blank for full array.
* @return string|array
*/
public static function getMySQLConfig($for='')
{
$key = 'mySQL'.$for;
$self = self::getInstance();
if($for == '')
{
return $self->e107_config_mysql_info;
}
return (isset($self->e107_config_mysql_info[$key]) ? $self->e107_config_mysql_info[$key] : '');
}
/**
* Return a unique path based on database used. ie. multi-site support from single install.
*
* @return string
* @author
*/
function getSitePath()
{
return self::getInstance()->site_path;
}
/**
* Get known handler path
*
* @param string $class_name
* @param boolean $parse_path [optional] parse path shortcodes
* @return string|null
*/
public static function getHandlerPath($class_name, $parse_path = true)
{
$ret = isset(self::$_known_handlers[$class_name]) ? self::$_known_handlers[$class_name] : null;
if($parse_path && $ret)
{
$ret = self::getParser()->replaceConstants($ret);
}
return $ret;
}
/**
* Add handler to $_known_handlers array on runtime
* If class name is array, method will add it (recursion) and ignore $path argument
*
* @param array|string $class_name
* @param string $path [optional]
* @return void
*/
public static function addHandler($class_name, $path = '')
{
if(is_array($class_name))
{
foreach ($class_name as $cname => $pathb)
{
self::addHandler($cname, $pathb);
}
return;
}
if(!self::isHandler($class_name))
{
self::$_known_handlers[$class_name] = $path;
}
}
/**
* Check handler presence
*
* @param string $class_name
* @return boolean
*/
public static function isHandler($class_name)
{
return isset(self::$_known_handlers[$class_name]);
}
/**
* Get overlod class and path (if any)
*
* @param string $class_name
* @param bool|object $default_handler [optional] return data from $_known_handlers if no overload data available
* @param bool|object $parse_path [optional] parse path shortcodes
* @return array
*/
public static function getHandlerOverload($class_name, $default_handler = true, $parse_path = true)
{
$ret = (isset(self::$_overload_handlers[$class_name]) ? self::$_overload_handlers[$class_name] : ($default_handler ? array($class_name, self::getHandlerPath($class_name, false)) : array()));
if ($parse_path && isset($ret[1]))
{
$ret[1] = self::getParser()->replaceConstants($ret[1]);
}
return $ret;
}
/**
* Overload present handler.
* If class name is array, method will add it (recursion) and
* ignore $overload_class_name and $overload_path arguments
*
* @param string|array $class_name
* @param string $overload_class_name [optional]
* @param string $overload_path [optional]
* @return void
*/
public static function setHandlerOverload($class_name, $overload_class_name = '', $overload_path = '')
{
if(is_array($class_name))
{
foreach ($class_name as $cname => $overload_array)
{
self::setHandlerOverload($cname, $overload_array[0], $overload_array[1]);
}
return;
}
if(self::isHandler($class_name) && !self::isHandlerOverloadable($class_name))
{
self::$_overload_handlers[$class_name] = array($overload_class_name, $overload_path);
}
}
/**
* Check if handler is already overloaded
*
* @param string $class_name
* @return boolean
*/
public static function isHandlerOverloadable($class_name)
{
return isset(self::$_overload_handlers[$class_name]);
}
/**
* Retrieve singleton object
*
* @param string $class_name
* @param string|boolean $path optional script path
* @param string $regpath additional registry path
* @return mixed
*/
public static function getSingleton($class_name, $path = true, $regpath = '',$vars=null)
{
$id = 'core/e107/singleton/'.$class_name.$regpath;
if(!empty($vars))
{
$id .= '/';
$id .= is_array($vars) ? crc32(serialize($vars)): crc32($vars);
}
//singleton object found - overload not possible
if(self::getRegistry($id))
{
return self::getRegistry($id);
}
//auto detection + overload check
if(is_bool($path))
{
//overload allowed
if($path === true && self::isHandlerOverloadable($class_name))
{
$tmp = self::getHandlerOverload($class_name);
$class_name = $tmp[0];
$path = $tmp[1];
}
//overload not allowed
else
{
$path = self::getHandlerPath($class_name);
}
}
if($path && is_string($path) && !class_exists($class_name, false))
{
global $_E107;
if((!empty($_E107['debug']) || (defined('e_DEBUG') && e_DEBUG === true) ))
{
require_once($path);
}
else
{
@require_once($path);
}
// remove the need for external function.
//e107_require_once() is available without class2.php. - see core_functions.php
}
if(class_exists($class_name, false))
{
self::setRegistry($id, new $class_name($vars));
}
return self::getRegistry($id);
}
/**
* Retrieve object
* Prepare for __autoload
*
* @param string $class_name
* @param mixed $arguments
* @param string|boolean $path optional script path
* @return mixed
*/
public static function getObject($class_name, $arguments = null, $path = true)
{
if((true === $path) && isset(self::$_known_handlers[$class_name]))
{
$path = self::getParser()->replaceConstants(self::$_known_handlers[$class_name]);
}
//auto detection + overload check
if(is_bool($path))
{
//overload allowed
if($path === true && self::isHandlerOverloadable($class_name))
{
$tmp = self::getHandlerOverload($class_name);
$class_name = $tmp[0];
$path = $tmp[1];
}
//overload not allowed
else
{
$path = self::getHandlerPath($class_name);
}
}
if($path && is_string($path) && !class_exists($class_name, false))
{
e107_require_once($path); //no existence/security checks here!
}
if(class_exists($class_name, false))
{
if($arguments !== null)
{
return new $class_name($arguments);
}
return new $class_name();
}
trigger_error("Class {$class_name} not found!", E_USER_ERROR);
return null;
}
/**
* Retrieve core config handlers.
* List of allowed $name values (aliases) could be found
* in {@link e_core_pref} class
*
* @param string $name core|core_backup|emote|menu|search|notify
* @param bool $load
* @param bool $refresh
* @return e_core_pref|e_plugin_pref
*/
public static function getConfig($name = 'core', $load = true, $refresh=false)
{
if(isset(self::$_plug_config_arr[$name]))
{
return self::getPlugConfig($name);
}
if(!isset(self::$_core_config_arr[$name]) || ($refresh == true)) // required by update_routines to clear out earlier values.
{
e107_require_once(e_HANDLER.'pref_class.php');
self::$_core_config_arr[$name] = new e_core_pref($name, $load);
if($name === 'core') // prevent loop between pref and cache handlers.
{
self::getCache()->UserCacheActive = self::getPref('cachestatus');
self::getCache()->SystemCacheActive = self::getPref('syscachestatus');
}
}
return self::$_core_config_arr[$name];
}
/**
* Retrieve core config handler preference value or the core preference array
* Shorthand of self::getConfig()->get()
*
* @see e_core_pref::get()
* @param string $pref_name
* @param mixed $default default value if preference is not found
* @return mixed
*/
public static function getPref($pref_name = '', $default = null)
{
return empty($pref_name) ? self::getConfig()->getPref() : self::getConfig()->get($pref_name, $default);
}
/**
* Advanced version of self::getPref(). $pref_name is parsed,
* so that $pref_name = 'x/y/z' will search for value pref_data[x][y][z]
* Shorthand of self::getConfig()->getPref()
*
* @see e_core_pref::getPref()
* @param string $pref_name
* @param mixed $default default value if preference is not found
* @param null $index
* @return mixed
*/
public static function findPref($pref_name, $default = null, $index = null)
{
return self::getConfig()->getPref($pref_name, $default, $index);
}
/**
* Retrieve plugin config handlers.
* Multiple plugin preference DB rows are supported
* Class overload is supported.
* Examples:
* - e107::getPluginConfig('myplug');
* will search for e107_plugins/myplug/e_pref/myplug_pref.php which
* should contain class 'e_plugin_myplug_pref' class (child of e_plugin_pref)
* - e107::getPluginConfig('myplug', 'row2');
* will search for e107_plugins/myplug/e_pref/myplug_row2_pref.php which
* should contain class 'e_plugin_myplug_row2_pref' class (child of e_plugin_pref)
*
* @param string $plug_name
* @param string $multi_row
* @param boolean $load load from DB on startup
* @return e_plugin_pref
*/
public static function getPlugConfig($plug_name, $multi_row = '', $load = true)
{
if(!isset(self::$_plug_config_arr[$plug_name.$multi_row]))
{
e107_require_once(e_HANDLER.'pref_class.php');
$override_id = $plug_name.($multi_row ? "_{$multi_row}" : '');
//check (once) for custom plugin pref handler
if(is_readable(e_PLUGIN.$plug_name.'/e_pref/'.$override_id.'_pref.php'))
{
require_once(e_PLUGIN.$plug_name.'/e_pref/'.$override_id.'_pref.php');
$class_name = 'e_plugin_'.$override_id.'_pref';
//PHPVER: string parameter for is_subclass_of require PHP 5.0.3+
if(class_exists($class_name, false) && is_subclass_of('e_plugin_pref', $class_name)) //or e_pref ?
{
self::$_plug_config_arr[$plug_name.$multi_row] = new $class_name($load);
return self::$_plug_config_arr[$plug_name.$multi_row];
}
}
self::$_plug_config_arr[$plug_name.$multi_row] = new e_plugin_pref($plug_name, $multi_row, $load);
}
return self::$_plug_config_arr[$plug_name.$multi_row];
}
/**
* Retrieve the global LAN for a specific plugin.
* @param $dir
* @param string $type
* @return mixed
*/
public static function getPlugLan($dir, $type='name')
{
$lan = "LAN_PLUGIN_".strtoupper($dir)."_".strtoupper($type);
return defset($lan,false);
}
/**
* Retrieve plugin preference value.
* Shorthand of self::getPluginConfig()->get()
* NOTE: Multiple plugin preference DB rows are NOT supported
* This will only look for your default plugin config (empty $milti_row)
*
* @see e_plugin_pref::get()
* @param string $plug_name
* @param string $pref_name
* @param mixed $default default value if preference is not found
* @return mixed
*/
public static function getPlugPref($plug_name, $pref_name = '', $default = null)
{
return empty($pref_name) ? self::getPlugConfig($plug_name)->getPref() : self::getPlugConfig($plug_name)->get($pref_name, $default);
}
/**
* Advanced version of self::getPlugPref(). $pref_name is parsed,
* so that $pref_name = 'x/y/z' will search for value pref_data[x][y][z]
* Shorthand of self::getPluginConfig()->getPref()
*
* @see e_core_pref::getPref()
* @param $plug_name
* @param string $pref_name
* @param mixed $default default value if preference is not found
* @param null $index
* @return mixed
*/
public static function findPlugPref($plug_name, $pref_name, $default = null, $index = null)
{
return self::getPlugConfig($plug_name)->getPref($pref_name, $default, $index);
}
/**
* Retrieve theme config handlers.
* Multiple theme preference DB rows are supported
* Class overload is supported.
* Examples:
* - e107::getTHemeConfig('mytheme');
* will search for e107_plugins/myplug/e_pref/myplug_pref.php which
* should contain class 'e_plugin_myplug_pref' class (child of e_plugin_pref)
* - e107::getPluginConfig('myplug', 'row2');
* will search for e107_plugins/myplug/e_pref/myplug_row2_pref.php which
* should contain class 'e_plugin_myplug_row2_pref' class (child of e_plugin_pref)
*
* @param string $theme_name
* @param string $multi_row
* @param boolean $load load from DB on startup
* @return e_plugin_pref
*/
public static function getThemeConfig($theme_name=null, $multi_row = '', $load = true)
{
if(empty($theme_name))
{
$theme_name = self::getPref('sitetheme');
}
if(!isset(self::$_theme_config_arr[$theme_name.$multi_row]))
{
e107_require_once(e_HANDLER.'pref_class.php');
self::$_theme_config_arr[$theme_name.$multi_row] = new e_theme_pref($theme_name, $multi_row, $load);
}
return self::$_theme_config_arr[$theme_name.$multi_row];
}
/**
* Get current theme preference. $pref_name is parsed,
* so that $pref_name = 'x/y/z' will search for value pref_data[x][y][z]
* Shorthand of self::getConfig()->getPref('current_theme/sitetheme_pref/pref_name')
*
* @see e_core_pref::getPref()
* @param string $pref_name
* @param mixed $default default value if preference is not found
* @param null $index
* @return mixed
*/
public static function getThemePref($pref_name = '', $default = null, $index = null)
{
// new storage method in it's own core table row. eg. theme_bootstrap3
$theme_name = self::getPref('sitetheme');
if(self::getThemeConfig($theme_name)->hasData() === true)
{
return empty($pref_name) ? self::getThemeConfig($theme_name)->getPref() : self::getThemeConfig($theme_name)->get($pref_name, $default);
}
// old storage method in core prefs.
$legacy_pref_name = ($pref_name) ? $pref_name = '/'.$pref_name : '';
$tprefs = self::getConfig()->getPref('sitetheme_pref'.$legacy_pref_name, $default, $index);
return !empty($tprefs) ? $tprefs : $default;
}
/**
* Set current theme preference. $pref_name is parsed,
* so that $pref_name = 'x/y/z' will set value pref_data[x][y][z]
*
* @param string|array $pref_name
* @param mixed $pref_value
* @return e_pref
*/
public static function setThemePref($pref_name, $pref_value = null)
{
if(is_array($pref_name))
{
return self::getConfig()->set('sitetheme_pref', $pref_name);
}
return self::getConfig()->updatePref('sitetheme_pref/'.$pref_name, $pref_value);
}
/**
* @return array
*/
public static function getThemeGlyphs()
{
$custom = self::getConfig()->getPref('sitetheme_glyphicons', false);
$theme = self::getConfig()->getPref('sitetheme', false);
$arr = array();
if(!empty($custom))
{
foreach($custom as $glyphConfig)
{
if(strpos($glyphConfig['path'], 'http') !== 0)
{
$glyphConfig['path'] = e_THEME."$theme/".$glyphConfig['path'];
}
$arr[] = $glyphConfig;
if(E107_DBG_INCLUDES)
{
self::getDebug()->log("Loading Glyph Icons: ".print_a($glyphConfig,true));
}
}
}
return $arr;
}
/**
* Retrieve text parser singleton object
*
* @return e_parse|array
*/
public static function getParser()
{
return self::getSingleton('e_parse', e_HANDLER.'e_parse_class.php'); //WARNING - don't change this - infinite loop!!!
}
/**
* Retrieve sc parser singleton object
*
* @return e_parse_shortcode|array
*/
public static function getScParser()
{
return self::getSingleton('e_parse_shortcode');
}
/**
* Retrieve search class singleton object
*
* @return array|Object|secure_image
*/
public static function getSearch()
{
return self::getSingleton('e_search'); // more flexible.
// return self::getObject('secure_image');
}
/**
* Retrieve secure_image singleton object
*
* @return array|Object|secure_image
*/
public static function getSecureImg()
{
return self::getSingleton('secure_image'); // more flexible.
// return self::getObject('secure_image');
}
/**
* Retrieve registered sc object (batch) by class name
* Note - '_shortcodes' part of the class/override is added by the method
* Override is possible only if class is not already instantiated by shortcode parser
*
* myplugin/shortcodes/batch/my_shortcodes.php
* e107::getScObject('my', 'myplugin');
*
* // news override - plugin_myplugin_news_shortcodes extends news_shortcodes -> myplugin/shortcodes/batch/news_shortcodes.php
* e107::getScObject('news', 'myplugin', true);
*
* // news override - plugin_myplugin_mynews_shortcodes extends news_shortcodes -> myplugin/shortcodes/batch/mynews_shortcodes.php
* e107::getScObject('news', 'myplugin', 'mynews');
*
*
* @param string $className
* @param string $pluginName
* @param string|true $overrideClass
* @return e_shortcode
*/
public static function getScBatch($className, $pluginName = null, $overrideClass = null)
{
if(is_string($overrideClass))
{
$overrideClass .= '_shortcodes';
}
return self::getScParser()->getScObject($className.'_shortcodes', $pluginName, $overrideClass);
}
/**
* Retrieve DB singleton object based on the
* $instance_id
*
* @param string $instance_id
* @return mixed|e_db
*/
public static function getDb($instance_id = '')
{
return self::getSingleton('db', true, $instance_id);
}
/**
* Retrieve cache singleton object
*
* @return ecache
*/
public static function getCache()
{
return self::getSingleton('ecache');
}
/**
* Retrieve bbcode singleton object
*
* @return e_bbcode
*/
public static function getBB()
{
return self::getSingleton('e_bbcode');
}
/**
* Retrieve user-session 'UserHandler' singleton object
*
* @return UserHandler
*/
public static function getUserSession()
{
return self::getSingleton('UserHandler');
}
/**
* Retrieve core session singleton object(s)
*
* @param null $namespace
* @return e_core_session
*/
public static function getSession($namespace = null)
{
$id = 'core/e107/session/'.($namespace === null ? 'e107' : $namespace);
if(self::getRegistry($id))
{
return self::getRegistry($id);
}
$session = self::getObject('e_core_session', array('namespace' => $namespace));
self::setRegistry($id, $session);
return $session;
}
/**
* Retrieve redirection singleton object
*
* @return redirection
*/
public static function getRedirect()
{
return self::getSingleton('redirection');
}
/**
* Retrieve rater singleton object
*
* @return rater
*/
public static function getRate()
{
return self::getSingleton('rater');
}
/**
* Retrieve sitelinks singleton object
*
* @return sitelinks
*/
public static function getSitelinks()
{
return self::getSingleton('sitelinks');
}
/**
* Retrieve render singleton object
*
* @return e_render
*/
public static function getRender()
{
return self::getSingleton('e_render');
}
/**
* Retrieve e107Email singleton object
*
* @return e107Email
*/
public static function getEmail($overrides=null)
{
return self::getSingleton('e107Email', true, null, $overrides);
}
/**
* Retrieves PhpThumbFactory object
*
* @param $src
* @deprecated - use Intervention class instead @see
* @example use Intervention\Image\ImageManagerStatic as Image;
* @example $img = Image::make($this->_src_path);.
* @return bool|GdThumb
*/
/*public static function getThumb($src)
{
require_once(e_HANDLER.'phpthumb/ThumbLib.inc.php');
try
{
return PhpThumbFactory::create($src);
}
catch (Exception $e)
{
return false;
}
}*/
/**
* Retrieve e107Email mail mailer object.
*
* @return e107MailManager
*/
public static function getBulkEmail()
{
return self::getSingleton('e107MailManager');
}
/**
* Retrieve event singleton object
*
* @return e107_event
*/
public static function getEvent()
{
return self::getSingleton('e107_event');
}
/**
* Retrieve array storage singleton object
*
* @return e_array
*/
public static function getArrayStorage()
{
return self::getSingleton('e_array');
}
/**
* Retrieve menu handler singleton object
*
* @return e_menu
*/
public static function getMenu()
{
return self::getSingleton('e_menu');
}
/**
* Retrieve e_theme singleton object
* @return e_theme
*/
public static function getTheme($themedir='front', $clearCache=false)
{
if(!defined('E107_INSTALL'))
{
if($themedir === 'front')
{
$themedir= self::getPref('sitetheme');
}
if($themedir === 'admin')
{
$themedir = self::getPref('admintheme');
}
}
// Get the currently used theme.
if ($themedir === 'current')
{
// If we are in the admin area.
if (deftrue('e_ADMIN_AREA', false))
{
$themedir = self::getPref('admintheme');
}
elseif(defined('PREVIEWTHEME'))
{
$themedir = PREVIEWTHEME;
}
else
{
$themedir= deftrue('USERTHEME', self::getPref('sitetheme'));
}
}
// e107::getDb()->db_Mark_time('start e_theme');
/** @var e_theme $ret */
$ret = self::getSingleton('e_theme', true, null, array('themedir'=> $themedir, 'force'=> $clearCache));
// e107::getDb()->db_Mark_time('end e_theme');
/* echo "";
debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
echo "
";*/
return $ret;
}
/**
* Retrieve URL singleton object
*
* @return eURL
*/
public static function getUrl()
{
return self::getSingleton('eUrl');
}
/**
* Retrieve file handler singleton or new fresh object
*
* @param boolean $singleton default true
* @return e_file
*/
public static function getFile($singleton = false)
{
if($singleton)
{
return self::getSingleton('e_file');
}
return self::getObject('e_file');
}
/**
* Create a new file inspector object
*
* Note: Only the core file inspector is supported right now.
*
* @return e_file_inspector
*/
public static function getFileInspector($type = 'core')
{
$fileInspectorPath = realpath(e_SYSTEM_BASE . "core_image.phar");
/** @var e_file_inspector $fileInspector */
$fileInspector = self::getObject('e_file_inspector_json_phar', $fileInspectorPath);
try
{
$fileInspector->loadDatabase();
}
catch (Exception $e)
{
// TODO: LAN
self::getMessage()->addWarning(
"The core integrity image is corrupt. " .
"File Inspector will be inoperative. " .
"Resolve this issue by uploading a good copy of the core image to " .
escapeshellarg($fileInspectorPath) . ". " .
"If uploading with FTP, use binary transfer mode. " .
"Error message: " .
$e->getMessage()
);
}
return $fileInspector;
}
/**
* Retrieve form handler singleton or new fresh object
*
* @param boolean $singleton default false
* @param boolean $tabindex passed to e_form when initialized as an object (not singleton)
* @return e_form
*/
public static function getForm($singleton = false, $tabindex = false)
{
if($singleton)
{
return self::getSingleton('e_form');
}
return self::getObject('e_form', $tabindex);
}
/**
* Retrieve admin log singleton object
* @deprecated - use e107::getLog();
* @return e_admin_log
*/
public static function getAdminLog()
{
trigger_error(''.__METHOD__.' is deprecated. Use e107::getLog() instead', E_USER_DEPRECATED); // NO LAN
return self::getSingleton('e_admin_log');
}
/**
* Retrieve admin log singleton object
*
* @return e_admin_log
*/
public static function getLog()
{
return self::getSingleton('e_admin_log');
}
/**
* Retrieve date handler singleton object
* @deprecated Use e107::getDate();
* @return convert
*/
public static function getDateConvert()
{
return self::getSingleton('e_date');
}
/**
* Retrieve date handler singleton object - preferred method.
*
* @return convert
*/
public static function getDate()
{
return self::getSingleton('e_date');
}
/**
* Retrieve date handler singleton object - preferred method.
*
* @return e107_db_debug
*/
public static function getDebug()
{
return self::getSingleton('e107_db_debug');
}
/**
* Retrieve notify handler singleton object
*
* @return notify
*/
public static function getNotify()
{
return self::getSingleton('notify');
}
/**
* Retrieve override handler singleton object
*
* @return override
*/
public static function getOverride()
{
return self::getSingleton('override');
}
/**
* Retrieve Language handler singleton object
*
* @return language
*/
public static function getLanguage()
{
return self::getSingleton('language');
}
/**
* Retrieve IP/ban handler singleton object
*
* @return eIPHandler
*/
public static function getIPHandler()
{
return self::getSingleton('eIPHandler');
}
/**
* Retrieve Xml handler singleton or new instance object
* @param mixed $singleton false - new instance, true - singleton from default registry location, 'string' - registry path
* @return xmlClass
*/
public static function getXml($singleton = true)
{
if($singleton)
{
return self::getSingleton('xmlClass', true, ($singleton === true ? '' : $singleton));
}
return self::getObject('xmlClass');
}
/**
* Create a new Hybridauth object based on the provided configuration
*
* @return Hybridauth\Hybridauth
* @throws \Hybridauth\Exception\InvalidArgumentException if Hybridauth rejects the provided config
* @throws ReflectionException if this method is unintentionally broken
* @deprecated v2.3.0 Use the e_user_provider interfaces instead (e107::getUserProvider()).
* It's the e107 wrapper around Hybridauth.
* @see e_user_provider for social login features.
* @see e107::getUser() for getting a user object that may or may not have a social login.
*/
public static function getHybridAuth($config = null)
{
trigger_error(''.__METHOD__.' is deprecated. Use the e_user_provider interfaces instead (e107::getUserProvider())', E_USER_DEPRECATED); // NO LAN
$e_user_provider = new e_user_provider(null, $config);
$reflection = new ReflectionClass('e_user_provider');
$reflection_property = $reflection->getProperty('hybridauth');
$reflection_property->setAccessible(true);
return $reflection_property->getValue($e_user_provider);
}
/**
* Create a new social login handler
* @param string|null $providerName
* @return e_user_provider
*/
public static function getUserProvider($providerName = null)
{
return self::getObject('e_user_provider', $providerName);
}
/**
* Retrieve userclass singleton object
*
* @return user_class
*/
public static function getUserClass()
{
return self::getSingleton('user_class');
}
/**
* Retrieve user model 'e_user' object.
*
* @param integer $user_id target user
* @param boolean $checkIfCurrent if tru user_id will be compared to current user, if there is a match
* current user object will be returned
* @return e_system_user|e_user
*/
public static function getSystemUser($user_id, $checkIfCurrent = true)
{
if($checkIfCurrent && $user_id && $user_id === self::getUser()->getId())
{
return self::getUser();
}
if(!$user_id)
{
return self::getObject('e_system_user');
}
$user = self::getRegistry('core/e107/user/'.$user_id);
if($user === null)
{
$user = self::getObject('e_system_user');
$user->load($user_id);
}
return $user;
}
/**
* Simple replacement for deprecated get_user_data(). e107::user();
* @param $uid integer user_id. Use e107::user(USERID) for currently logged in user.
* @return array|false of user data
*/
public static function user($uid=null)
{
$uid = (int) $uid;
if(empty($uid)){ return false; }
$user = self::getSystemUser($uid);
$var = array();
if($user)
{
$var = $user->getUserData();
}
return $var;
}
/**
* Return a string containg exported array data. - preferred.
*
* @param array $ArrayData array to be stored
* @param bool|string $mode true = var_export with addedslashes, false = var_export (default), 'json' = json encoded
* @return array|string
*/
public static function serialize($ArrayData, $mode = false)
{
return self::getArrayStorage()->serialize($ArrayData, $mode);
}
/**
* Returns an array from stored array data.
*
* @param string $ArrayData
* @return array stored data
*/
public static function unserialize($ArrayData)
{
if(empty($ArrayData))
{
return array();
}
return self::getArrayStorage()->unserialize($ArrayData);
}
/**
* Retrieve current user model object.
*
* @return e_user
*/
public static function getUser()
{
$user = self::getRegistry('core/e107/current_user');
if($user === null)
{
$user = self::getObject('e_user');
self::setRegistry('core/e107/current_user', $user);
}
return $user;
}
/**
* Retrieve front or admin Model.
* @param string $type
* @return object e_front_model or e_admin_model;
*/
public static function getModel($type='front')
{
if($type === 'front')
{
return self::getObject('e_front_model');
}
return self::getObject('e_admin_model');
}
/**
* Retrieve user model object.
*
* @return e_user_extended_structure_tree
*/
public static function getUserStructure()
{
return self::getSingleton('e_user_extended_structure_tree');
}
/**
* Retrieve User Extended handler singleton object
* @return e107_user_extended
*/
public static function getUserExt()
{
return self::getSingleton('e107_user_extended');
}
/**
* Retrieve User Perms (admin perms) handler singleton object
* @return e_userperms
*/
public static function getUserPerms()
{
return self::getSingleton('e_userperms');
}
/**
* Retrieve online users handler singleton object
* @return e_ranks
*/
public static function getRank()
{
return self::getSingleton('e_ranks');
}
/**
* Retrieve plugin handler singleton object
* @return e107plugin
*/
public static function getPlugin()
{
return self::getSingleton('e107plugin');
}
/**
* Retrieve plugin class singleton object
* @return e_plugin
*/
public static function getPlug()
{
return self::getSingleton('e_plugin');
}
/**
* Retrieve online users handler singleton object
* @return e_online
*/
public static function getOnline()
{
return self::getSingleton('e_online');
}
/**
* Retrieve chart handler singleton object
* @return e_chart
*/
public static function getChart()
{
return self::getObject('e_chart');
}
/**
* Retrieve comments handler singleton object
* @return comment
*/
public static function getComment()
{
return self::getSingleton('comment');
}
/**
* Retrieve comments handler singleton object
* @return e_customfields
*/
public static function getCustomFields()
{
return self::getSingleton('e_customfields');
}
/**
* Retrieve Media handler singleton object
* @return e_media
*/
public static function getMedia()
{
return self::getSingleton('e_media');
}
/**
* Retrieve Navigation Menu handler singleton object
* @return e_navigation
*/
public static function getNav()
{
return self::getSingleton('e_navigation');
}
/**
* Retrieve message handler singleton
* @return eMessage
*/
public static function getMessage()
{
// static $included = false;
// if(!$included)
// {
// e107_require_once(e_HANDLER.'message_handler.php');
// $included = true;
// }
// return eMessage::getInstance();
return self::getSingleton('eMessage');
}
/**
* Retrieve ajax singleton object
*
* @return e_ajax
*/
public static function getAjax()
{
return self::getSingleton('e_ajax');
}
/**
* Retrieve Library Manager singleton object (internal use only. Use e107::library())
*
* @return e_library_manager
*/
public static function getLibrary()
{
return self::getSingleton('e_library_manager');
}
/**
* Library Common Public Function.
*
* @param string $action
* - 'detect': Tries to detect a library and its installed version.
* - 'load': Loads a library.
* - 'info' : Load library information array
* - 'preload' : Activate preloading of the library (when detected) using a tag.
* @param string $library
* The name of the library to detect/load.
* @param string $variant
* (Optional for 'load') The name of the variant to load. Note that only one variant of a library can be loaded
* within a single request. The variant that has been passed first is used; different variant names in subsequent
* calls are ignored.
*
* @return array|boolean
* - In case of 'detect': An associative array containing registered information for the library specified by
* $name, or FALSE if the library $name is not registered.
* - In case of 'load': An associative array of the library information.
* - In case of 'info': An associative array containing registered information for all libraries, the registered
* information for the library specified by $name, or FALSE if the library $name is not registered.
*/
public static function library($action = '', $library = null, $variant = null, $types = null)
{
$libraryHandler = self::getLibrary();
if(empty($types))
{
$types = array('js', 'css');
}
switch($action)
{
case 'detect':
return $libraryHandler->detect($library);
break;
case 'load':
$cdn = (bool) self::getPref('e_jslib_cdn', true);
$debug = (bool) deftrue('e_DEBUG');
$admin = (bool) defset('e_ADMIN_AREA', false);
// Try to detect and load CDN version.
if(!$admin && $cdn && strpos($library, 'cdn.') !== 0)
{
$lib = $libraryHandler->detect('cdn.' . $library);
// If CDN version is available.
if($lib && !empty($lib['installed']))
{
// If a variant is specified, we need to check if it's installed.
if(!empty($variant) && !empty($lib['variants'][$variant]['installed']))
{
// Load CDN version with the variant.
return $libraryHandler->load('cdn.' . $library, $variant, $types);
}
// If CDN version is available, but no variant is specified,
// and debug mode is on, try to load 'debug' variant.
if(empty($variant) && $debug && !empty($lib['variants']['dev']['installed']))
{
// Load CDN version with 'debug' variant.
return $libraryHandler->load('cdn.' . $library, 'dev', $types);
}
// Load CDN version without variant.
return $libraryHandler->load('cdn.' . $library, $variant, $types);
}
}
// If no variant is specified, and CDN version is not available, and debug mode is on.
if(empty($variant) && $debug)
{
$lib = $libraryHandler->detect($library);
// If 'debug' variant is available.
if($lib && !empty($lib['variants']['dev']['installed']))
{
// Load library with 'debug' variant.
return $libraryHandler->load($library, 'dev', $types);
}
}
return $libraryHandler->load($library, $variant, $types);
break;
case 'info':
return $libraryHandler->info($library);
break;
case 'files':
$info = $libraryHandler->info($library);
$ret = [];
foreach($types as $t)
{
if(!empty($info['files'][$t]))
{
foreach($info['files'][$t] as $path => $other)
{
$file = $info['library_path'].'/';
$file .= !empty($info['path']) ? $info['path'].'/' : '';
$file .= $path;
$ret[$t][] = $file;
}
}
}
return $ret;
break;
case 'preload':
$info = $libraryHandler->info($library);
if(empty($info['preload']))
{
return null;
}
$tp = self::getParser();
$libraryPath = $info['library_path'].'/'.$info['path'].'/';
foreach($info['preload'] as $pre)
{
$linkArr = [
'rel' => 'preload',
'href' => $libraryPath.$pre['path']
];
$browserCache = !empty($pre['browsercache']);
unset($pre['path'],$pre['browsercache']);
$linkArr2 = array_merge($linkArr,$pre);
self::link($linkArr2, $browserCache);
}
break;
}
}
/**
* Retrieve JS Manager singleton object
*
* @return e_jsmanager
*/
public static function getJs()
{
static $included = false;
if(!$included)
{
e107_require_once(e_HANDLER.'js_manager.php');
$included = true;
}
return e_jsmanager::getInstance();
}
/**
* @param $type
* @param $val
* @return void
*/
public static function set($type=null, $val=true)
{
if($type === 'js_enabled')
{
self::$_js_enabled = (bool) $val;
}
if($type === 'css_enabled')
{
self::$_css_enabled = (bool) $val;
}
}
/**
* JS Common Public Function. Prefered is shortcode script path
* @param string $type core|theme|footer|inline|footer-inline|url or any existing plugin_name
* @param string|array $data depends on the type - path/url or inline js source
* @param string|array $parm parameters. BC string dependence : null | prototype | jquery OR array of parameters. tbd
* @param integer $zone [optional] leave it null for default zone
*/
public static function js($type, $data, $parm = null, $zone = null, $pre = '', $post = '')
{
if(self::$_js_enabled === false)
{
return null;
}
$jshandler = self::getJs();
if(is_string($parm))
{
$jshandler->setDependency($parm);
$parm = null;
}
switch ($type)
{
case 'settings':
$jshandler->jsSettings($data);
break;
case 'core':
// data is e.g. 'core/tabs.js'
if($zone !== null)
{
$jshandler->requireCoreLib($data, $zone);
}
else
{
$jshandler->requireCoreLib($data);
}
break;
case 'bootstrap': //TODO Eventually add own method and render for bootstrap.
if($zone !== null)
{
$jshandler->requireCoreLib('bootstrap/js/' . $data, $zone);
}
else
{
$jshandler->requireCoreLib('bootstrap/js/' . $data);
}
break;
case 'theme':
// data is e.g. 'jslib/mytheme.js'
if($zone !== null)
{
$jshandler->headerTheme($data, $zone, $pre, $post);
}
else
{
$jshandler->footerTheme($data, 5, $pre, $post);
}
break;
case 'inline':
// data is JS source (without script tags)
if($zone !== null)
{
$jshandler->headerInline($data, $zone);
}
else
{
$jshandler->headerInline($data);
}
break;
case 'footer-inline':
// data is JS source (without script tags)
if($zone !== null)
{
$jshandler->footerInline($data, $zone);
}
else
{
$jshandler->footerInline($data);
}
break;
case 'url':
// data is e.g. 'http://cdn.somesite.com/some.js'
if($zone !== null)
{
$jshandler->headerFile($data, $zone, $pre, $post, $parm);
}
else
{
$jshandler->headerFile($data, 5, $pre, $post, $parm);
}
break;
case 'footer':
// data is e.g. '{e_PLUGIN}myplugin/jslib/myplug.js'
if($zone !== null)
{
$jshandler->footerFile($data, $zone, $pre, $post, $parm);
}
else
{
$jshandler->footerFile($data, 5, $pre, $post, $parm);
}
break;
// $type is plugin name
default:
// data is e.g. 'jslib/myplug.js'
if(!self::isInstalled($type))
{
return;
}
if($zone !== null)
{
$jshandler->requirePluginLib($type, $data, $zone);
}
else
{
$jshandler->requirePluginLib($type, $data);
}
break;
}
$jshandler->resetDependency();
}
/**
* Add a tag to the head of the html document.
* @param array|string $attributes
* @param bool $browserCache set to true to add the cacheId to the href. (when an array is used)
* @example e107::link(array('rel'=>"dns-prefetch", "href" => "http://example-domain.com/"));
* @example e107::link('rel="preload" href="{THEME}assets/fonts/fontawesome-webfont.woff2?v=4.7.0" as="font" type="font/woff2" crossorigin');
*/
public static function link($attributes, $browserCache = false)
{
self::getJs()->addLink($attributes, $browserCache);
}
/**
* @param string $type eg. 'active'
* @param mixed $value eg. existing link-url value.
*/
public static function nav($type, $value=null)
{
if($value === null)
{
return e107::getRegistry('core/e107/navigation/'.$type);
}
return e107::setRegistry('core/e107/navigation/'.$type, $value);
}
/**
* CSS Common Public Function. Prefered is shortcode script path
* @param string $type core|theme|footer|inline|footer-inline|url or any existing plugin_name
* @param string $data depends on the type - path/url or inline js source
* @param null $dep
* @param string $media any valid media attribute string - http://www.w3schools.com/TAGS/att_link_media.asp
* @param string $preComment possible comment e.g.
* @param null $dependence
*/
public static function css($type, $data, $dep = null, $media = 'all', $preComment = '', $postComment = '', $dependence = null)
{
/* if((strpos($data,'bootstrap.css')!==false || strpos($data,'bootstrap.min.css')!==false) && !defined("BOOTSTRAP")) // detect bootstrap is enabled. - used in nextprev.sc and forum currently.
{
define("BOOTSTRAP", true);
}*/
if(self::$_css_enabled === false)
{
return null;
}
$jshandler = self::getJs();
$jshandler->setDependency($dep);
if(strpos($data,'http')===0 && ($type !== 'theme'))
{
$type = 'url';
}
switch ($type)
{
case 'core':
// data is path relative to e_FILE/jslib/
$jshandler->coreCSS($data, $media, $preComment, $postComment);
break;
case 'bootstrap':
// data is path relative to e_FILE/jslib/
$jshandler->coreCSS('bootstrap/css/'.$data, $media, $preComment, $postComment);
break;
case 'theme':
// data is path relative to current theme or URL to load in the 'theme' zone.
$jshandler->themeCSS($data, $media, $preComment, $postComment);
break;
case 'inline':
// data is CSS source (without style tags)
$jshandler->inlineCSS($data, $media);
break;
case 'url':
// data is e.g. 'http://cdn.somesite.com/some.css'
$jshandler->otherCSS($data, $media, $preComment, $postComment);
break;
// $type is plugin name
default:
// data is e.g. 'css/myplug.css'
if(self::isInstalled($type))
{
$jshandler->pluginCSS($type, $data, $media, $preComment, $postComment);
}
break;
}
$jshandler->resetDependency();
}
/**
* Throw log/info/warnings/errors to the Chrome/Firefox Console.
* @param $name
* @param null $var
* @param string $type
*/
public static function debug($name, $var = null, $type = 'log')
{
$nl = "\r\n";
// echo "alert('hi');";
$text = '';
switch($type) {
case 'log':
$text .= 'console.log("'.$name.'");'.$nl;
break;
case 'info':
$text .= 'console.info("'.$name.'");'.$nl;
break;
case 'warning':
$text .= 'console.warn("'.$name.'");'.$nl;
break;
case 'error':
$text .= 'console.error("'.$name.'");'.$nl;
break;
}
if (!empty($var))
{
if (is_object($var) || is_array($var))
{
$object = json_encode($var);
$text .= 'var object'.preg_replace('~[^A-Z|0-9]~i',"_",$name).' = \''.str_replace("'","\'",$object).'\';'.$nl;
$text .= 'var val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).' = eval("(" + object'.preg_replace('~[^A-Z|0-9]~i',"_",$name).' + ")" );'.$nl;
switch($type)
{
case 'log':
$text .= 'console.debug(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.$nl;
break;
case 'info':
$text .= 'console.info(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.$nl;
break;
case 'warning':
$text .= 'console.warn(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.$nl;
break;
case 'error':
$text .= 'console.error(val'.preg_replace('~[^A-Z|0-9]~i',"_",$name).');'.$nl;
break;
}
}
else
{
switch($type)
{
case 'log':
$text .= 'console.debug("'.str_replace('"','\\"',$var).'");'.$nl;
break;
case 'info':
$text .= 'console.info("'.str_replace('"','\\"',$var).'");'.$nl;
break;
case 'warning':
$text .= 'console.warn("'.str_replace('"','\\"',$var).'");'.$nl;
break;
case 'error':
$text .= 'console.error("'.str_replace('"','\\"',$var).'");'.$nl;
break;
}
}
}
self::js('footer-inline', $text);
}
/**
* Retrieve JS Helper object
*
* @param boolean|string $singleton if true return singleton, if string return singleton object, use string as namespace, default false
* @return e_jshelper
*/
public static function getJshelper($singleton = false)
{
if($singleton)
{
return self::getSingleton('e_jshelper', true, ($singleton === true ? '' : $singleton));
}
return self::getObject('e_jshelper');
}
/**
* @see eResponse::addMeta()
* @param null $name
* @param null $content
* @param array $extended
* @return eResponse
*/
public static function meta($name = null, $content = null, $extended = array())
{
/** @var eResponse $response */
$response = self::getSingleton('eResponse');
if($name === 'description')
{
$response->addMetaDescription($content);
}
if($name === 'keywords')
{
$response->addMetaKeywords($content);
}
return $response->addMeta($name, $content, $extended);
}
/**
* Set the Page Title ie. Whatever | SITENAME or Whatever
* @param string $title
* @param string $override will remove any additional data from the tag. eg. | SITENAME etc.
*/
public static function title($title, $override=false)
{
/** @var eResponse $response */
$response = self::getSingleton('eResponse');
$response->addMetaTitle($title, true, $override);
}
/**
* Retrieve admin dispatcher instance.
* It's instance is self registered (for now, this could change in the future) on initialization (__construct())
*
* @see e_admin_dispatcher
* @return e_admin_dispatcher
*/
public static function getAdminUI()
{
return self::getRegistry('admin/ui/dispatcher');
}
/**
* Retrieves class Object for specific plugin's addon such as e_url.php, e_cron.php, e_sitelink.php
* *
* @param string $pluginName e.g. faq, page
* @param string $addonName eg. e_cron, e_url, e_module
* @param mixed $className [optional] true - use default name, false - no object is returned (include only), any string will be used as class name
* @return object
*/
public static function getAddon($pluginName, $addonName, $className = true)
{
$filename = $addonName; // e.g. 'e_cron';
if($className === true)
{
$className = $pluginName . '_' . substr($addonName, 2);
} // remove 'e_'
$elist = self::getPref($filename.'_list');
if($filename === 'e_menu')
{
if(!in_array($pluginName, $elist))
{
return null;
}
}
elseif(!isset($elist[$pluginName]))
{
return null;
}
$path = e_PLUGIN.$pluginName.'/'.$filename.'.php';
// e.g. include e_module, e_meta etc
if($className === false)
{
return include_once($path);
}
if(!class_exists($className, false))
{
include_once($path);
}
if(!class_exists($className, false))
{
return null;
}
return new $className;
}
/**
* Retrieves config() from all plugins for addons such as e_url.php, e_cron.php, e_sitelink.php
* @param string $addonName eg. e_cron, e_url
* @param string $className [optional] (if different from addonName)
* @param string $methodName [optional] (if different from 'config')
* @return array
*/
public static function getAddonConfig($addonName, $className = '', $methodName='config', $param=null,$param2=null )
{
$new_addon = array();
$sql = self::getDb(); // Might be used by older plugins.
$filename = $addonName; // e.g. 'e_cron';
if(!$className)
{
$className = substr($filename, 2); // remove 'e_'
}
$elist = self::getPref($filename.'_list');
if(!empty($elist))
{
foreach(array_keys($elist) as $key)
{
if(is_readable(e_PLUGIN.$key.'/'.$filename.'.php'))
{
include_once(e_PLUGIN.$key.'/'.$filename.'.php');
$class_name = $key.'_'.$className;
$array = self::callMethod($class_name, $methodName,$param,$param2);
if($array)
{
$new_addon[$key] = $array;
}
}
}
}
return $new_addon;
}
/**
* Safe way to call user methods.
* @param string|object $class_name
* @param string $method_name
* @param mixed $param -1st parameter sent to method
* @param mixed $param2 - 2nd parameter sent to method
* @return array|bool FALSE
*/
public static function callMethod($class_name, $method_name, $param=null, $param2=null)
{
$mes = self::getMessage();
if(is_object($class_name) || class_exists($class_name))
{
if(is_object($class_name))
{
$obj = $class_name;
$class_name = get_class($obj);
}
else
{
$obj = new $class_name;
}
if(method_exists($obj, $method_name))
{
if(E107_DBG_INCLUDES)
{
//$debug_backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
$mes->addDebug('Executing <strong>'.$class_name.' :: '.$method_name.'()</strong>');
}
return $obj->$method_name($param, $param2);
}
}
return FALSE;
}
/**
* Retrieves the e_url config - new v2.1.6
* @param string $mode config | alias | profile
* @return array
*/
public static function getUrlConfig($mode='config')
{
$new_addon = array();
$filename = 'e_url';
$elist = self::getPref($filename.'_list');
$className = substr($filename, 2); // remove 'e_'
$methodName = 'config';
$url_profiles = self::getPref('url_profiles');
if(!empty($elist))
{
foreach(array_keys($elist) as $key)
{
if(is_readable(e_PLUGIN.$key.'/'.$filename.'.php'))
{
include_once(e_PLUGIN.$key.'/'.$filename.'.php');
$class_name = $key.'_'.$className;
if(is_object($class_name))
{
$obj = $class_name;
$class_name = get_class($obj);
}
elseif(class_exists($class_name))
{
$obj = new $class_name;
}
else
{
continue;
}
if($mode === 'alias')
{
if(!empty($obj->alias))
{
$new_addon[$key] = $obj->alias;
}
continue;
}
if($mode === 'profiles')
{
if(!empty($obj->profiles))
{
$new_addon[$key] = $obj->profiles;
}
continue;
}
if($mode === 'generate')
{
if(!empty($obj->generate))
{
$new_addon[$key] = $obj->generate;
}
continue;
}
$profile = !empty($url_profiles[$key]) ? $url_profiles[$key] : null;
$array = self::callMethod($obj, $methodName,$profile);
if($mode === 'route' && !empty($array))
{
foreach($array as $k=>$v)
{
if(empty($v['alias']) && !empty($obj->alias))
{
$v['alias'] = $obj->alias;
}
$new_addon[$key.'/'.$k] = $v;
}
continue;
}
if($array)
{
foreach($array as $k=>$v)
{
if(empty($v['alias']) && !empty($obj->alias))
{
$v['alias'] = $obj->alias;
}
$new_addon[$key][$k] = $v;
}
}
}
}
}
return $new_addon;
}
/**
* Get theme name or path.
*
* @param mixed $for true (default) - auto-detect (current), admin - admin theme, front - site theme
* @param string $path default empty string (return name only), 'abs' - absolute url path, 'rel' - relative server path
* @return string
*/
public static function getThemeInfo($for = true, $path = '')
{
if($for === true)
{
$for = e_ADMIN_AREA ? 'admin' : 'front';
}
switch($for )
{
case 'admin':
$for = self::getPref('admintheme');
break;
case 'front':
if(defined('USERTHEME') && USERTHEME !==false)
{
$for = USERTHEME;
}
else
{
$user_pref = self::getUser()->getPref();
$for = !empty($user_pref['sitetheme']) ? $user_pref['sitetheme'] : self::getPref('sitetheme');
}
break;
}
if(!$path)
{
return $for;
}
switch($path)
{
case 'abs':
$path = e_THEME_ABS.$for.'/';
break;
case 'rel':
default:
$path = e_THEME.$for.'/';
break;
}
return $path;
}
/**
* Load admin icons template and define their constants
* @return array;
*/
public static function loadAdminIcons()
{
$regID = 'core/e107/templates/admin_icons';
if($temp = self::getRegistry($regID))
{
return $temp;
}
$ADMIN_ICONS_TEMPLATE = self::getCoreTemplate('admin_icons', null, false);
if(self::getPref('admincss') === 'css/kadmin.css')
{
$ADMIN_ICONS_TEMPLATE['ADMIN_INSTALLPLUGIN_ICON'] = "<i class='fa fa-cog fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_UNINSTALLPLUGIN_ICON'] = "<i class='fa fa-times fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_UPGRADEPLUGIN_ICON'] = "<i class='fa fa-caret-up fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_REPAIRPLUGIN_ICON'] = "<i class='fa fa-wrench fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_CONFIGURE_ICON'] = "<i class='fa fa-cog fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_EDIT_ICON'] = "<i class='fa fa-edit fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_DELETE_ICON'] = "<i class='fa fa-trash fa-2x fa-fw text-danger'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_EXECUTE_ICON'] = "<i class='fa fa-power-off fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_SORT_ICON'] = "<i class='fa fa-sort fa-2x fa-fw'></i>";
$ADMIN_ICONS_TEMPLATE['ADMIN_PAGES_ICON'] = "<i class='fa fa-file-text-o fa-2x fa-fw'></i>";
}
foreach($ADMIN_ICONS_TEMPLATE as $def=>$val)
{
define($def, $val);
}
self::setRegistry($regID, $ADMIN_ICONS_TEMPLATE);
return $ADMIN_ICONS_TEMPLATE;
}
/**
* Retrieve core template path
* Example: <code>echo e107::coreTemplatePath('admin_icons');</code>
*
* @see getThemeInfo()
* @param string $id part of the path/file name without _template.php part
* @param boolean $override default true
* @return string relative path
*/
public static function coreTemplatePath($id, $override = true)
{
$id = str_replace('..', '', $id); //simple security, '/' is allowed
$curTheme = self::getThemeInfo($override, 'rel');
$override_path = $override ? $curTheme.'templates/'.$id.'_template.php' : null;
$legacy_override_path = $override ? $curTheme.$id.'_template.php' : null;
$core_path = e_CORE.'templates/'.$id.'_template.php'; // default
$core_path_legacy = e_CORE.'templates/legacy/'.$id.'_template.php';
$core_path_bs4 = e_CORE.'templates/bootstrap4/'.$id.'_template.php';
$core_path_bs5 = e_CORE.'templates/bootstrap5/'.$id.'_template.php';
$ret = $core_path;
if($override_path && is_readable($override_path)) // v2 override template.
{
$ret = $override_path;
}
elseif($legacy_override_path && is_readable($legacy_override_path)) //v1 override template.
{
$ret = $legacy_override_path;
}
elseif(deftrue('THEME_LEGACY') && is_readable($core_path_legacy)) //v1 core template.
{
$ret = $core_path_legacy;
}
elseif(defset('BOOTSTRAP') > 3)
{
if(is_readable($core_path_bs5))
{
$ret = $core_path_bs5;
}
elseif(is_readable($core_path_bs4))
{
$ret = $core_path_bs4;
}
}
return $ret;
}
/**
* Retrieve plugin template path
* Override path could be forced to front- or back-end via
* the $override parameter e.g. <code> e107::templatePath(plug_name, 'my', 'front')</code>
* Example:
* <code>
* echo e107::templatePath(plug_name, 'my');
* // result is something like:
* // e107_themes/current_theme/templates/plug_name/my_template.php
* // or if not found
* // e107_plugins/plug_name/templates/my_template.php
* </code>
*
* @see getThemeInfo()
* @param string $plug_name plugin name
* @param string $id part of the path/file name without _template.php part
* @param boolean|string $override default true
* @return string relative path
*/
public static function templatePath($plug_name, $id, $override = true)
{
$id = str_replace('..', '', $id); //simple security, '/' is allowed
$plug_name = preg_replace('#[^a-z0-9_]#i', '', $plug_name); // only latin allowed, so \w not a solution since PHP5.3
$override_path = $override ? self::getThemeInfo($override, 'rel').'templates/'.$plug_name.'/'.$id.'_template.php' : null;
$default_path = e_PLUGIN.$plug_name.'/templates/'.$id.'_template.php';
return ($override_path && is_readable($override_path) ? $override_path : $default_path);
}
/**
* Get core template. Use this method for templates, which are following the
* new template standards:
* - template variables naming conventions
* - one array variable per template only
* - theme override is made now by current_theme/templates/ folder
*
* <br><br>Results are cached (depending on $id and $override so it's safe to use
* this method e.g. in loop for retrieving a template string. If template (or template key) is not
* found, <b>NULL</b> is returned.<br><br>
*
* Example usage: <code>e107::getCoreTemplate('user', 'short_start');</code>
* Will search for:
* - e107_themes/current_frontend_theme/templates/user_template.php (if $override is true)
* - e107_themes/templates/user_template.php (if override not found or $override is false)
* - $USER_TEMPLATE array which contains all user templates
* - $USER_TEMPLATE['short_start'] (if key is null, $USER_TEMPLATE will be returned)
*
* @param string $id - file prefix, e.g. user for user_template.php
* @param string|null $key
* @param mixed $override see {@link getThemeInfo()} true/false, front or admin.
* @param boolean $merge merge theme with core templates, default is false
* @param boolean $info retrieve template info only
* @return string|array
*/
public static function getCoreTemplate($id, $key = null, $override = true, $merge = false, $info = false)
{
$reg_path = 'core/e107/templates/'.$id.($override ? '/ext' : '');
$path = self::coreTemplatePath($id, $override);
$id = str_replace('/', '_', $id);
$ret = self::_getTemplate($id, $key, $reg_path, $path, $info);
### Attempt to fix merge issues; in case we override - template array not found in theme,
### so we need to continue and merge with core templates
if($merge && $override && empty($ret))
{
$ret = array();
}
if((!$merge && !$override) || is_string($ret))
{
return $ret;
}
// merge
$reg_path = 'core/e107/templates/'.$id;
$path = self::coreTemplatePath($id, false);
$id = str_replace('/', '_', $id);
// Introducing noWrapper when merging
$ret_core = self::_getTemplate($id, $key, $reg_path, $path, $info, true);
return (is_array($ret_core) ? array_merge($ret_core, $ret) : $ret);
}
/**
* Get plugin template. Use this method for plugin templates, which are following the
* new template standards:
* - template variables naming conventions ie. ${NAME IN CAPS}_TEMPLATE['{ID}'] = "<div>...</div>";
* - one array variable per template only
* - theme override is made now by current_theme/templates/plugin_name/ folder
*
* <br><br>Results are cached (depending on $id and $override so it's safe to use
* this method e.g. in loop for retrieving a template string. If template (or template key) is not
* found, <b>NULL</b> is returned.<br><br>
*
* Example usage: <code>e107::getTemplate('user', 'short_start');</code>
* Will search for:
* - e107_themes/{current_frontend_theme}/templates/user_template.php (if $override is true) - this is the default.
* - e107_core/templates/user_template.php (if override not found or $override is false)
* - $USER_TEMPLATE array which contains all user templates
* - $USER_TEMPLATE['short_start'] (if key is null, $USER_TEMPLATE will be returned)
*
* @param string $plug_name if null getCoreTemplate method will be called
* @param string $id - file prefix, e.g. calendar for calendar_template.php, or 'true' or 'null' for same as plugin name.
* @param string|null $key $YOURTEMPLATE_TEMPLATE[$key]
* @param boolean $override see {@link getThemeInfo()}
* @param boolean $merge merge theme with plugin templates, default is false
* @param boolean $info retrieve template info only
* @return array
*/
public static function getTemplate($plug_name, $id = null, $key = null, $override = true, $merge = false, $info = false)
{
if(!$plug_name)
{
return self::getCoreTemplate($id, $key, $override, $merge, $info);
}
if($id == null || $id === true) // loads {$plug_name}/templates/{$plug_name}_template.php and an array ${PLUG_NAME}_TEMPLATE
{
$id = $plug_name;
}
$reg_path = 'plugin/'.$plug_name.'/templates/'.$id;
$reg_path .= ($override) ? '/ext' : '';
$path = self::templatePath($plug_name, $id, $override);
if(deftrue('ADMIN') && E107_DBG_INCLUDES)
{
self::getMessage()->addDebug( "Attempting to load Template File: ".$path );
}
/**
* "front" and "global" LANs might not be loaded come self::_getTemplate(),
* so the following calls to self::plugLan() fix that.
*/
self::_loadPluginLans($plug_name);
$id = str_replace('/', '_', $id);
$ret = self::_getTemplate($id, $key, $reg_path, $path, $info);
if($merge === false || $override === false)
{
return ($ret === false) ? array() : $ret;
}
// merge
$reg_path = 'plugin/'.$plug_name.'/templates/'.$id;
$path = self::templatePath($plug_name, $id, false);
$id = str_replace('/', '_', $id);
// Introduced noWrapper when merging
$ret_plug = self::_getTemplate($id, $key, $reg_path, $path, $info, true);
if($merge === true && $key !== null && $ret === false) // key not set, so send 'core' version instead.
{
return $ret_plug;
}
if($ret === false)
{
return array();
}
return (is_array($ret_plug) ? array_merge($ret_plug, $ret) : $ret);
}
/**
* Register sc_style registry
* @param string $templateId e.g. 'contact/form' or 'contact' for all contact template wrappers
* @param string $scName [optional] shortcode name - if provided, wrapper (string) for the corresponding code will be returned
* @return array|string
*/
public static function templateWrapper($templateId, $scName = null)
{
if(!$templateId)
{
return array();
}
if(strpos($templateId,'/') !== false)
{
list($templateId, $templateKey) = explode('/', $templateId, 2);
}
else
{
$templateKey = '';
}
$wrapperRegPath = 'templates/wrapper/'.$templateId;
$wrapper = self::getRegistry($wrapperRegPath);
if(empty($wrapper) || !is_array($wrapper))
{
$wrapper = array();
}
if(strpos($templateKey,'/')!==false) // quick fix support for 3 keys eg. news/view/item
{
list($templateKey,$templateKey2) = explode("/", $templateKey, 2);
if($templateKey && $templateKey2)
{
$wrapper = (isset($wrapper[$templateKey][$templateKey2]) ? $wrapper[$templateKey][$templateKey2] : array());
}
}
else // support for 2 keys. eg. contact/form
if($templateKey)
{
$wrapper = (isset($wrapper[$templateKey]) ? $wrapper[$templateKey] : array());
}
if($scName !== null)
{
$scName = strtoupper($scName);
return isset($wrapper[$scName]) ? $wrapper[$scName] : '';
}
return $wrapper;
}
/**
* Retrieve/set sc_style array (global shortcode wrapper)
* @param array $set template defined $sc_style, will be merged with current registry content
* @return array
*/
public static function scStyle($set = null)
{
$_sc_style = self::getRegistry('shortcodes/sc_style');
if(!is_array($_sc_style))
{
$_sc_style = array();
}
if(is_array($set) && !empty($set))
{
self::setRegistry('shortcodes/sc_style', array_merge($_sc_style, $set));
}
return $_sc_style;
}
/**
* Get Template Info array.
* Note: Available only after getTemplate()/getCoreTemplate() call
*
* @param string $plug_name if null - search for core template
* @param string $id
* @param string $key
* @param boolean $override
* @param boolean $merge
* @return array
*/
public static function getTemplateInfo($plug_name, $id, $key = null, $override = true, $merge = false)
{
if($plug_name)
{
$ret = self::getTemplate($plug_name, $id, null, $override, $merge, true);
}
else
{
$ret = self::getCoreTemplate($id, null, $override, $merge, true);
}
if($key && isset($ret[$key]) && is_array($ret[$key]))
{
return $ret[$key];
}
return $ret;
}
/**
* Return a list of available template IDs for a plugin(eg. $MYTEMPLATE['my_id'] -> array('id' => 'My Id'))
*
*
* @param string $plugin_name
* @param string $template_id [optional] if different from $plugin_name;
* @param mixed $where true - current theme, 'admin' - admin theme, 'front' (default) - front theme
* @param string $filter_mask
* @param boolean $merge merge theme with core/plugin layouts, default is false
* @param boolean $allinfo reutrn nimerical array of templates and all available template information
* @return array
*/
public static function getLayouts($plugin_name, $template_id = '', $where = 'front', $filter_mask = '', $merge = false, $allinfo = true)
{
if(!$plugin_name) // Core template
{
$tmp = self::getCoreTemplate($template_id, null, $where, $merge);
$tmp_info = self::getTemplateInfo(null, $template_id, null, $where, $merge);
}
else // Plugin template
{
self::_loadPluginLans($plugin_name);
$id = (!$template_id) ? $plugin_name : $template_id;
$tmp = self::getTemplate($plugin_name, $id, null, $where, $merge);
$tmp_info = self::getTemplateInfo($plugin_name, $id, null, $where, $merge);
}
$templates = array();
if(!$filter_mask)
{
$filter_mask = array();
}
elseif(!is_array($filter_mask))
{
$filter_mask = array($filter_mask);
}
foreach($tmp as $key => $val)
{
$match = true;
if($filter_mask)
{
$match = false;
foreach ($filter_mask as $mask)
{
if(preg_match($mask, $key)) //e.g. retrieve only keys starting with 'layout_'
{
$match = true;
break;
}
}
if(!$match)
{
continue;
}
}
if(isset($tmp_info[$key]))
{
$templates[$key] = defset($tmp_info[$key]['title'], $tmp_info[$key]['title']);
continue;
}
$templates[$key] = implode(' ', array_map('ucfirst', explode('_', $key)));
}
return ($allinfo ? array($templates, $tmp_info) : $templates);
}
/**
* More abstsract template loader, used
* internal in {@link getTemplate()} and {@link getCoreTemplate()} methods
* If $info is set to true, only template informational array will be returned
*
* @param string $id
* @param string|null $key
* @param string $reg_path
* @param string $path
* @param boolean $info
* @param boolean $noWrapper
* @return string|array
*/
public static function _getTemplate($id, $key, $reg_path, $path, $info = false, $noWrapper = false)
{
$regPath = $reg_path;
$var = strtoupper($id).'_TEMPLATE';
$regPathInfo = $reg_path.'/info';
$var_info = strtoupper($id).'_INFO';
$wrapper = strtoupper($id).'_WRAPPER'; // see contact_template.php
$wrapperRegPath = 'templates/wrapper/'.$id;
// Use: list($pre,$post) = explode("{---}",$text,2);
$tp = self::getParser(); // BC FIx - avoid breaking old templates due to missing globals.
if(self::getRegistry($regPath) === null)
{
(deftrue('E107_DEBUG_LEVEL') ? include_once($path) : @include_once($path));
self::setRegistry($regPath, (isset($$var) ? $$var : array()));
// sc_style not a global anymore and uppercase
// Fix template merge issue - no-wrapper sent to avoid sc wrappers confusions
if(!$noWrapper)
{
if(isset($SC_WRAPPER))
{
if(E107_DBG_BBSC)
{
self::getMessage()->addDebug("Found deprecated \$SC_WRAPPER: ".print_a($SC_WRAPPER, true));
}
self::scStyle($SC_WRAPPER);
}
// ID_WRAPPER support
if(isset($$wrapper) && !empty($$wrapper) && is_array($$wrapper))
{
if(E107_DBG_BBSC)
{
self::getMessage()->addDebug("Found ID wrapper: ".$wrapper);
}
self::setRegistry($wrapperRegPath, $$wrapper);
}
}
}
if(self::getRegistry($regPathInfo) === null)
{
self::setRegistry($regPathInfo, (isset($$var_info) && is_array($$var_info) ? $$var_info : array()));
}
$ret = (!$info ? self::getRegistry($regPath) : self::getRegistry($regPathInfo));
if(!$key)
{
return $ret;
}
return ($ret && is_array($ret) && isset($ret[$key])) ? $ret[$key] : false;
}
/**
* Load language file, replacement of include_lan()
* @outdated use e107::lan() or e107::coreLan(), e107::plugLan(), e107::themeLan()
* @param string $path
* @param boolean $force
* @return string
*/
public static function includeLan($path, $force = false)
{
if (!is_readable($path))
{
if ((e_LANGUAGE === 'English') || self::getPref('noLanguageSubs'))
{
return false;
}
self::getDebug()->log("Couldn't load language file: " . $path);
$path = str_replace(e_LANGUAGE, 'English', $path);
self::getDebug()->log("Attempts to load default language file: " . $path);
if(!is_readable($path))
{
self::getDebug()->log("Couldn't load default language file: " . $path);
return false;
}
}
$adminLanguage = self::getPref('adminlanguage');
if(e_ADMIN_AREA && vartrue($adminLanguage))
{
$path = str_replace(e_LANGUAGE, $adminLanguage, $path);
}
$ret = ($force) ? include($path) : include_once($path);
return (isset($ret)) ? $ret : "";
}
/**
* Simplify importing of core Language files.
* All inputs are sanitized.
* Core Exceptions as e_LANGUAGE.'.php' and e_LANGUAGE.'_custom.php' are manually loaded. (see class2.php)
*
* Examples:
* <code><?php
* // import defeinitions from /e107_languages/[CurrentLanguage]/lan_comment.php</code>
* e107::coreLan('comment');
*
* // import defeinitions from /e107_languages/[CurrentLanguage]/admin/lan_banlist.php
* self::coreLan('banlist', true);
* </code>
*
* @param string $fname filename without the extension part (e.g. 'comment')
* @param boolean $admin true if it's an administration language file
* @return bool|null
*/
public static function coreLan($fname, $admin = false)
{
if ($admin)
{
self::includeLan(e_LANGUAGEDIR.e_LANGUAGE.'/admin/lan_admin.php');
}
$cstring = 'core/e107/corelan/'.e_LANGUAGE.'_'.$fname.($admin ? '_admin' : '_front');
if(self::getRegistry($cstring))
{
return null;
}
$fname = ($admin ? 'admin/' : '').'lan_'.preg_replace('/[\W]/', '', trim($fname, '/')).'.php';
$path = e_LANGUAGEDIR.e_LANGUAGE.'/'.$fname;
self::setRegistry($cstring, true);
return self::includeLan($path);
}
/**
* Simplify importing of plugin Language files (following e107 plugin structure standards).
* All inputs are sanitized.
*
* Examples:
* @example
* <code><?php
* // import defeinitions from /e107_plugins/forum/languages/[CurrentLanguage]/lan_forum.php
* e107::plugLan('forum', 'lan_forum');
*
* // import defeinitions from /e107_plugins/featurebox/languages/[CurrentLanguage]_admin_featurebox.php
* // OR /e107_plugins/featurebox/languages/[CurrentLanguage]/[CurrentLanguage]_admin_featurebox.php (auto-detected)
* e107::plugLan('featurebox', 'admin_featurebox', true);
*
* // import defeinitions from /e107_plugins/myplug/languages/[CurrentLanguage]_front.php
* e107::plugLan('myplug');
*
* // import defeinitions from /e107_plugins/myplug/languages/[CurrentLanguage]_admin.php
* e107::plugLan('myplug', true);
*
* // import defeinitions from /e107_plugins/myplug/languages/[CurrentLanguage].php // FOR BC only.
* e107::plugLan('myplug', null);
*
* // import defeinitions from /e107_plugins/myplug/languages/[CurrentLanguage]/[CurrentLanguage]_front.php
* e107::plugLan('myplug', 'front', true);
*
* // import defeinitions from /e107_plugins/myplug/languages/[CurrentLanguage]/admin/common.php
* e107::plugLan('myplug', 'admin/common');
* </code>
*
* @param string $plugin plugin name
* @param string|bool|null $fname filename without the extension part (e.g. 'common')
* @param boolean $flat false (default, preferred) Language folder structure; true - prepend Language to file name
* @param boolean $returnPath When true, returns the path, but does not include the file or set the registry.
* @return bool|null
*/
public static function plugLan($plugin, $fname = '', $flat = false, $returnPath = false)
{
// $cstring = 'pluglan/'.e_LANGUAGE.'_'.$plugin.'_'.$fname.($flat ? '_1' : '_0');
$cstring = 'core/e107/pluglan/'.$plugin.'/'.e_LANGUAGE.'/';
$cstring .= ($fname === null) ? 'null' : '';
$cstring .= ($fname === true) ? 'true' : '';
$cstring .= is_string($fname) ? $fname : '';
$cstring .= ($flat) ? '/flat' : '/noflat';
if(self::getRegistry($cstring) && ($returnPath === false))
{
return null;
}
$plugin = preg_replace('/[\W]/', '', $plugin);
if($fname === 'global') // fix ambiguity
{
$fname = e_LANGUAGE."_global";
}
elseif($fname && is_string($fname))
{
$fname = e_LANGUAGE.($flat ? '_' : '/').preg_replace('#[^\w/]#', '', trim($fname, '/'));
}
elseif($fname === true) // admin file.
{
$fname = e_LANGUAGE."_admin";
}
elseif($fname === null) // BC usage. English.php
{
$fname = e_LANGUAGE;
}
else
{
// $fname = e_LANGUAGE;
$fname = e_LANGUAGE."_front";
}
if($flat === true) // support for alt_auth/languages/English/English_log.php etc.
{
$path = e_PLUGIN.$plugin.'/languages/'.e_LANGUAGE.'/'.$fname.'.php';
}
else
{
$path = e_PLUGIN.$plugin.'/languages/'.$fname.'.php';
}
if($returnPath === true)
{
return $path;
}
if(deftrue('E107_DBG_INCLUDES'))
{
$adminLanguage = self::getPref('adminlanguage');
if(e_ADMIN_AREA && !empty($adminLanguage))
{
$path = str_replace(e_LANGUAGE, $adminLanguage, $path);
}
self::getMessage()->addDebug("Attempting to Load: ".$path);
}
self::setRegistry($cstring, true);
$ret = self::includeLan($path);
if(($ret === false) && deftrue('E107_DBG_INCLUDES') && strpos($path, '_global.php') === false )
{
$result = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 4);
self::getDebug()->log("Couldn't load: ".$path.print_a($result,true));
}
return $ret;
}
/**
* Simplify importing of theme Language files (following e107 plugin structure standards).
* All inputs are sanitized.
*
* Examples:
* <code><?php
* // import defeinitions from /e107_themes/[CurrentTheme]/languages/[CurrentLanguage]/lan.php
* e107::themeLan('lan');
*
* // import defeinitions from /e107_themes/[currentTheme]/languages/[CurrentLanguage].php
* e107::themeLan();
*
* // import defeinitions from /e107_themes/[currentTheme]/languages/[CurrentLanguage]_lan.php
* e107::themeLan('lan', null, true);
*
* // import defeinitions from /e107_themes/[currentTheme]/languages/[CurrentLanguage]/admin/lan.php
* e107::themeLan('admin/lan');
*
* // import defeinitions from /e107_themes/some_theme/languages/[CurrentLanguage].php
* e107::themeLan('', 'some_theme');
* </code>
*
* @param string $fname filename without the extension part (e.g. 'common' for common.php)
* @param string $theme theme name, if null current theme will be used
* @param boolean $flat false (default, preferred) Language folder structure; true - prepend Language to file name
* @return bool|null
*/
public static function themeLan($fname = '', $theme = null, $flat = false)
{
if($theme === null)
{
$theme = THEME . 'languages/';
}
else
{
$theme = e_THEME . filter_var($theme) . '/languages/';
}
$cstring = 'themelan/'.$theme.$fname.($flat ? '_1' : '_0');
if(self::getRegistry($cstring))
{
return null;
}
if($fname)
{
$fname = e_LANGUAGE . ($flat ? '_' : '/') . preg_replace('#[^\w/]#', '', trim($fname, '/'));
}
else
{
$fname = e_LANGUAGE;
}
$path = $theme.$fname.'.php';
if(deftrue('E107_DBG_INCLUDES'))
{
self::getMessage()->addDebug("Attempting to Load: ".$path);
}
self::setRegistry($cstring, true);
return self::includeLan($path);
}
/**
* PREFERRED Generic Language File Loading Function for use by theme and plugin developers.
* Language-file equivalent to e107::js, e107::meta and e107::css
*
* FIXME disallow themes and plugins named 'core' and 'theme'
*
* @param string $type
* 'theme' or plugin name
* @param string $fname
* (optional): relative path to the theme or plugin language folder. (same as in the other functions)
* when missing, [e_LANGUAGE]_front.php will be used, when true [e_LANGUAGE]_admin.php will be used
* @param $options
* Set to True for admin.
*
* @example e107::lan('theme'); // Loads THEME."languages/English.php (if English is the current language)
* @example e107::lan('gallery'); // Loads e_PLUGIN."gallery/languages/English_front.php (if English is the current language)
* @example e107::lan('gallery', 'admin'); // Loads e_PLUGIN."gallery/languages/English/admin.php (if English is the current language)
* @example e107::lan('gallery', 'admin', true); // Loads e_PLUGIN."gallery/languages/English/English_admin.php (if English is the current language)
* @example e107::lan('gallery', 'admin/example'); // Loads e_PLUGIN."gallery/languages/English/admin/example.php (if English is the current language)
* @example e107::lan('gallery', true); // Loads e_PLUGIN."gallery/languages/English_admin.php (if English is the current language)
* @example e107::lan('gallery', "something", true); // Loads e_PLUGIN."gallery/languages/English_something.php (if English is the current language)
* @example e107::lan('gallery', true, true); // Loads e_PLUGIN."gallery/languages/English/English_admin.php (if English is the current language)
* @example e107::lan('gallery', false, true); // Loads e_PLUGIN."gallery/languages/English/English_front.php (if English is the current language)
*/
public static function lan($type, $fname = '', $options = null)
{
$options = $options ? true : false;
switch ($type)
{
case 'core' :
$result = self::coreLan($fname, $options);
break;
case 'theme' :
$result = self::themeLan($fname, null, $options);
break;
default :
$result = self::plugLan($type, $fname, $options);
break;
}
return $result;
}
/**
* Generic PREF retrieval Method for use by theme and plugin developers.
* @param string $type : 'core', 'theme', plugin-name
* @param $pname : name of specific preference, or leave blank for full array.
* @param null $default
* @return mixed
*/
public static function pref($type = 'core', $pname = null, $default = null)
{
switch ($type)
{
case 'core' :
return self::getPref($pname, $default);
break;
case 'theme' :
return self::getThemePref($pname, $default);
break;
default:
return self::getPlugPref($type, $pname, $default);
break;
}
}
/**
* Set or Get the current breadcrumb array.
* @param array $array
* @return array|null
*/
public static function breadcrumb($array = array())
{
if(empty($array)) // read
{
if(empty(self::$_breadcrumb)) //Guess what it should be..
{
if(defined('PAGE_NAME')) // BC search for "PAGE_NAME"
{
return array(0=> array('text'=>PAGE_NAME, 'url'=>null));
}
elseif($caption = self::getRender()->getMainCaption()) // BC search for primary render caption
{
return array(0=> array('text'=>$caption, 'url'=>null));
}
}
return self::$_breadcrumb;
}
self::$_breadcrumb = $array; // write.
return null;
}
/**
* Quick method to set alias - uses e107::url format.
* @param string $plugin if empty will return the last assigned canonical url._SITEURL_ will set canonical to the SITEURL.
* @param string|array $key
* @param array $row
* @param array $options mode, query = [],
*/
public static function canonical($plugin = '', $key = 'index', $row = array(), $options=array('mode'=>'full'))
{
if($plugin === '_RESET_') // for testing only, may be removed in future.
{
self::setRegistry('core/e107/canonical');
}
$alreadyDone = self::getRegistry('core/e107/canonical');
if(empty($plugin))
{
return $alreadyDone;
}
if(empty($alreadyDone))
{
if($plugin === '_SITEURL_')
{
$url = SITEURL;
}
else
{
$url = self::url($plugin, $key, $row, $options);
}
if(!empty($url))
{
$siteurl = self::getPref('siteurl');
if(!empty($siteurl) && $siteurl !== '/') // ensure that duplicate parked domains always use the primary site URL. @see issue #4994
{
$url = str_replace(SITEURL, $siteurl, $url);
}
self::getJs()->addLink(array('rel'=>"canonical", "href" => $url));
self::meta('og:url', $url);
self::meta('twitter:url', $url);
self::setRegistry('core/e107/canonical', $url);
$message = "Debug: Setting Canonical URL: <b><a href='".$url."'>".$url."</a></b>";
}
}
if(!empty($alreadyDone))
{
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
$message = "Debug: More than one canonical was attempted. This was ignored: ".print_a($backtrace[1], true);
}
if(deftrue('e_DEBUG_CANONICAL') && !empty($message))
{
self::getMessage()->addInfo($message);
}
}
/**
* Reverse lookup of current URI against legacy e_url entry for the specified plugin.
* Useful for when SEF (e_SINGLE_ENTRY) is not in use.
* @param string|null $plugin
* @param string|null $uri
* @return string|null
*/
public static function detectRoute($plugin=null, $uri=null)
{
if(empty($plugin) || empty($uri))
{
return null;
}
if(!$addon = self::getAddon($plugin,'e_url'))
{
trigger_error("Couldn't load e_url for ".$plugin);
return null;
}
if(!$result = self::callMethod($addon, 'config'))
{
trigger_error($plugin.' - e_url::config() method returned nothing');
return null;
}
foreach($result as $key=>$var)
{
if(empty($var['legacy']))
{
continue;
}
$legacy = self::getParser()->replaceConstants($var['legacy'], 'abs'); // remove {e_PLUGIN}
$legacy = preg_replace('/\{[\w]*\}/', '__XXX__', $legacy); // replace {fields} with placeholder.
$legacy = preg_quote($legacy,'/'); // add slashes
$pattern = '/'. str_replace('__XXX__', '([\w]*)', $legacy) .'/'; // replace placeholder with regexp
if(preg_match($pattern, $uri))
{
return $plugin.'/'.$key;
}
}
return null;
}
/**
* Set the route or get the current route when $route is null.
* @param string $route
* @return string|null
*/
public static function route($route = null)
{
if($route === null)
{
return self::getRegistry('core/e107/route', false);
}
self::setRegistry('core/e107/route', $route);
return null;
}
/**
* Generate a plugin's search engine-friendly URL with HTML special characters escaped
*
* Can be spliced directly into HTML code like <a href="…"></a>
*
* Output is generated based on the plugin's e_url.php configuration
*
* @param string $plugin - plugin folder name
* @param string $key assigned in e_url.php configuration.
* @param array $row Array of variables in url config.
* @param array $options = [ // (optional) An associative array of additional options
* 'mode' => 'abs | full', // @see e_parse::replaceConstants()
* 'query' => [], // An array of query key/value-pairs (without any URL encoding) to append to the URL
* 'fragment' => '', // A fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character
* 'legacy' => false, // When true, legacy URLs will be generated regardless of mod_rewrite status
* ]
* @return string The SEF URL with HTML special characters escaped
* (equivalent to the htmlspecialchars() output)
*/
public static function url($plugin = '', $key = null, $row = array(), $options = array())
{
/* backward compat - core keys. ie. news/xxx/xxx user/xxx/xxx etc, */
$legacy = array('news', 'page', 'search', 'user', 'download', 'gallery');
if($plugin === 'search')
{
$plugin = 'search/index';
}
if (strpos($plugin, '/') !== false)
{
$tmp = explode("/", $plugin, 2);
if (in_array($tmp[0], $legacy))
{
if(isset($options['mode']) && $options['mode'] === 'full')
{
if(is_array($row))
{
$row['full'] = 1;
}
elseif(is_string($row))
{
$row .= '&full=1';
}
elseif(is_null($row))
{
$row = 'full=1';
}
}
return self::getUrl()->create($plugin, $key, $row);
}
// shorthand - for internal use.
$plugin = $tmp[0];
$row = $key;
$key = $tmp[1];
}
if (!$tmp = self::getRegistry('core/e107/addons/e_url'))
{
$tmp = self::getUrlConfig();
self::setRegistry('core/e107/addons/e_url', $tmp);
}
$tp = self::getParser();
$pref = self::getPref('e_url_alias');
$sefActive = self::getPref('e_url_list');
$rootNamespace = self::getPref('url_main_module');
if (is_string($options)) // backwards compat.
{
$options = array(
'mode' => $options,
);
}
// Merge in defaults.
$options += array(
'mode' => 'abs',
'fragment' => '',
'query' => array(),
);
if (isset($options['fragment']) && $options['fragment'] !== '')
{
$options['fragment'] = '#' . $options['fragment'];
}
if (!empty($plugin) && empty($tmp[$plugin][$key]['sef']))
{
self::getMessage()->addDebug("e_url.php in <b>" . e_PLUGIN . $plugin . "</b> is missing the key: <b>" . $key . "</b>. Or, you may need to <a href='" . e_ADMIN . "db.php?mode=plugin_scan'>scan your plugin directories</a> to register e_url.php");
return false;
}
if (!empty($tmp[$plugin][$key]['alias']))
{
$alias = (!empty($pref[e_LAN][$plugin][$key])) ? $pref[e_LAN][$plugin][$key] : $tmp[$plugin][$key]['alias'];
if (!empty($rootNamespace) && $rootNamespace === $plugin)
{
$replaceAlias = array('{alias}\/', '{alias}/');
$tmp[$plugin][$key]['sef'] = str_replace($replaceAlias, '', $tmp[$plugin][$key]['sef']);
}
else
{
$tmp[$plugin][$key]['sef'] = str_replace('{alias}', $alias, $tmp[$plugin][$key]['sef']);
}
}
preg_match_all('#{([a-z_]*)}#', $tmp[$plugin][$key]['sef'], $matches);
$active = true;
foreach ($matches[1] as $k => $v) // check if a field value is missing, if so, revert to legacy url.
{
if (!isset($row[$v]))
{
self::getMessage()->addDebug("Missing value for " . $v . " in " . $plugin . "/e_url.php - '" . $key . "'");
$active = false;
break;
}
}
if (empty($sefActive[$plugin])) // SEF disabled.
{
self::getDebug()->log('SEF URL for <b>' . $plugin . '</b> disabled.');
// trigger_error('SEF URL for ' . $plugin . ' disabled.', E_USER_NOTICE);
$active = false;
}
$e_MOD_REWRITE = (self::isCli() !==true) ? deftrue('e_MOD_REWRITE') : true;
if ($e_MOD_REWRITE && ($active == true) && empty($options['legacy'])) // Search-Engine-Friendly URLs active.
{
$rawUrl = $tp->simpleParse($tmp[$plugin][$key]['sef'], $row);
if ($options['mode'] === 'full')
{
$sefUrl = SITEURL . $rawUrl;
}
elseif ($options['mode'] === 'raw')
{
$sefUrl = $rawUrl;
}
else
{
$sefUrl = e_HTTP . $rawUrl;
}
}
else // Legacy URL.
{
$srch = array();
$repl = array();
foreach ($matches[0] as $k => $val)
{
$srch[] = '$' . ($k + 1);
$repl[] = $val;
}
$template = isset($tmp[$plugin][$key]['legacy']) ? $tmp[$plugin][$key]['legacy'] : $tmp[$plugin][$key]['redirect'];
$urlTemplate = str_replace($srch, $repl, $template);
$urlTemplate = $tp->replaceConstants($urlTemplate, $options['mode']);
$legacyUrl = $tp->simpleParse($urlTemplate, $row);
$legacyUrl = preg_replace('/&?\$[\d]/', "", $legacyUrl); // remove any left-over $x (including prefix of '&')
// Avoid duplicate query keys. eg. URL has ?id=x and $options['query']['id'] exists.
// @see forum/e_url.php - topic/redirect and forum/view_shortcodes.php sc_post_url()
list($legacyUrl, $tmp) = array_pad(explode("?", $legacyUrl), 2, null);
if (!empty($tmp))
{
if (strpos($tmp, '=') === false)
{
// required for legacy urls of type "request.php?download.43"
// @see: issue #3275
$legacyUrl .= '?' . $tmp;
$options['query'] = null;
}
else
{
parse_str($tmp, $qry);
foreach ($qry as $k => $v)
{
if (!isset($options['query'][$k])) // $options['query'] overrides any in the original URL.
{
$options['query'][$k] = $v;
}
}
}
}
$sefUrl = $legacyUrl;
}
// Append the query.
if (is_array($options['query']) && !empty($options['query']))
{
$sefUrl .= (strpos($sefUrl, '?') !== FALSE ? '&' : '?') . self::httpBuildQuery($options['query']);
}
return htmlspecialchars($sefUrl . $options['fragment'], ENT_QUOTES);
}
/**
* Simple redirect method for developers.
*
* @param string $url
* 'admin' to redirect to admin entry page or leave blank to go to home page
* (SITEURL).
* @param int $http_response_code
* The HTTP status code to use for the redirection, defaults to 302.
* The valid values for 3xx redirection status codes are defined in RFC 2616
* and the draft for the new HTTP status codes:
* - 301: Moved Permanently (the recommended value for most redirects).
* - 302: Found (default in PHP, sometimes used for spamming search engines).
* - 303: See Other.
* - 304: Not Modified.
* - 305: Use Proxy.
* - 307: Temporary Redirect.
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
* @see https://tools.ietf.org/html/draft-reschke-http-status-308-07
*/
public static function redirect($url = '', $http_response_code = 301)
{
self::getRedirect()->go($url, true, $http_response_code);
}
/**
* Getter/Setter for schema. eg. Google structured data etc.
* @param string $json
* @return string|bool
*/
public static function schema($json = null)
{
if(empty($json))
{
return self::getRegistry('core/e107/schema', false);
}
return self::setRegistry('core/e107/schema',$json);
}
/**
* Retrieve error page handler.
*
* @return error_page
*/
public static function getError()
{
return self::getSingleton('error_page');
}
/**
* Retrieve e_emote filter .
*
* @return e_emote
*/
public static function getEmote()
{
return self::getSingleton('e_emote');
}
/**
* Retrieve Profanity filter .
*
* @return e_profanity
*/
public static function getProfanity()
{
return self::getSingleton('e_profanity');
}
/**
* Parses an array into a valid, rawurlencoded query string. This differs from http_build_query() as we need to
* rawurlencode() (instead of urlencode()) all query parameters.
* @param array $query The query parameter array to be processed, e.g. $_GET.
* @param string $parent Internal use only. Used to build the $query array key for nested items.
* @return string A rawurlencoded string which can be used as or appended to the URL query string.
*/
public static function httpBuildQuery(array $query, $parent = '')
{
$params = array();
foreach($query as $key => $value)
{
$key = ($parent ? $parent . '[' . rawurlencode($key) . ']' : rawurlencode($key));
// Recurse into children.
if(is_array($value))
{
$params [] = self::httpBuildQuery($value, $key);
}
// If a query parameter value is NULL, only append its key.
elseif(!isset($value))
{
$params [] = $key;
}
else
{
// For better readability of paths in query strings, we decode slashes.
$params [] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
}
}
return implode('&', $params);
}
/**
* @param $js
* @param $options
* @return mixed|string|null
*/
public static function minify($js, $options=array())
{
if(empty($js))
{
return null;
}
try
{
$minifier = new MatthiasMullie\Minify\JS($js);
$minified = $minifier->minify();
}
catch(Exception $e)
{
$minified = $js;
}
return $minified;
}
/**
* Set or Retrieve WYSIWYG active status. (replaces constant e_WYSIWYG)
*
* @param bool/string $val if null, return current value, otherwise define editor to use
* @param bool $returnEditor true = return name of active editor, false = return "false" for non wysiwyg editor, return "true" if wysiwyg editor should be used
* @return bool|mixed
*/
public static function wysiwyg($val=null, $returnEditor=false)
{
static $editor = 'bbcode';
static $availEditors;
$fallbackEditor = 'bbcode';
global $_E107;
if (self::getPref('wysiwyg',false) != true)
{
// wysiwyg disabled by global pref
$editor = $fallbackEditor;
}
else
{
if(!isset($availEditors) || !empty($_E107['phpunit']))
{
// init list of installed wysiwyg editors
$default = self::isInstalled('tinymce4') ? array('tinymce4'=>'TinyMce4') : array(); // if missing pref fallback.
$availEditors = self::getPref('wysiwyg_list', $default);
// $availEditors = array_keys(e107::getPlug()->getInstalledWysiwygEditors()); // very slow.
}
if($val !== null)
{
// set editor if value given
$editor = empty($val) ? $fallbackEditor : ($val === 'default' ? true : $val);
}
// check if choosen editor is installed,
// if not, but a different editor is available use that one (e.g. tinymce4 choosen, but only simplemde available available, use simplemde)
// if no wysiwyg editor available, use fallback editor (bbcode)
if(is_bool($editor) || ($editor !== $fallbackEditor && empty($availEditors[$editor])))
{
$names = array_keys($availEditors);
// $editor = count($availEditors) > 0 ? $availEditors[0] : $fallbackEditor;
$editor = count($availEditors) > 0 ? reset($names) : $fallbackEditor;
}
}
// $returnEditor => false:
// false => fallback editor (bbcode)
// true => default wysiwyg editor
// $returnEditor => true:
// return name of the editor
//return $returnEditor ? $editor : ($editor === $fallbackEditor || $editor === false ? false : true);
return $returnEditor ? $editor : ($editor !== $fallbackEditor);
}
/**
* Routine looks in standard paths for language files associated with a plugin or
* theme - primarily for core routines, which won't know for sure where the author has put them.
* $unitName is the name (directory path) of the plugin or theme
* $type determines what is to be loaded:
* - 'runtime' - the standard runtime language file for a plugin
* - 'admin' - the standard admin language file for a plugin
* - 'theme' - the standard language file for a plugin (these are usually pretty small, so one is enough)
* Otherwise, $type is treated as part of a filename within the plugin's language directory,
* prefixed with the current language.
* Returns FALSE on failure (not found).
* Returns the include_once error return if there is one
* Otherwise returns an empty string.
* Note - if the code knows precisely where the language file is located, use {@link getLan()}
* $pref['noLanguageSubs'] can be set TRUE to prevent searching for the English files if
* the files for the current site language don't exist.
*
* @param string $unitName
* @param string $type predefined types are runtime|admin|theme
* @return boolean|string
*/
public static function loadLanFiles($unitName, $type='runtime')
{
//global $pref;
switch ($type)
{
case 'runtime' :
$searchPath[1] = e_PLUGIN.$unitName.'/languages/'.e_LANGUAGE.'_'.$unitName.'.php';
$searchPath[2] = e_PLUGIN.$unitName.'/languages/'.e_LANGUAGE.'/'.$unitName.'.php';
$searchPath[3] = e_PLUGIN.$unitName.'/languages/'.e_LANGUAGE.'.php'; // menu language file.
break;
case 'admin' :
$aLangPref = self::getPref('adminlanguage');
$adminLan = vartrue($aLangPref, e_LANGUAGE);
$searchPath[1] = e_PLUGIN.$unitName.'/languages/'.$adminLan.'_admin_'.$unitName.'.php';
$searchPath[2] = e_PLUGIN.$unitName.'/languages/'.$adminLan.'/'.'admin_'.$unitName.'.php';
$searchPath[3] = e_PLUGIN.$unitName.'/languages/'.$adminLan.'/admin/'.$adminLan.'.php';
$searchPath[4] = e_PLUGIN.$unitName.'/languages/'.$adminLan.'/'.$adminLan.'_admin.php'; // Preferred.
$searchPath[5] = e_PLUGIN.$unitName.'/languages/'.$adminLan.'_admin.php'; // consistent with English_global.php, English_log.php etc.
break;
case 'theme' :
$searchPath[1] = e_THEME.$unitName.'/languages/'.e_LANGUAGE.'_'.$unitName.'.php';
$searchPath[2] = e_THEME.$unitName.'/languages/'.e_LANGUAGE.'/'.$unitName.'.php';
break;
default :
$searchPath[1] = e_PLUGIN.$unitName.'/languages/'.e_LANGUAGE.'_'.$type.'.php';
$searchPath[2] = e_PLUGIN.$unitName.'/languages/'.e_LANGUAGE.'/'.$type.'.php';
}
foreach ($searchPath as $s) // Look for files in current language first - should usually be found
{
if (is_readable($s))
{
$ret = include_once($s);
return (isset($ret)) ? $ret : "";
}
}
if ((e_LANGUAGE === 'English') || self::getPref('noLanguageSubs'))
{
return FALSE; // No point looking for the English files twice
}
foreach ($searchPath as $s) // Now look for the English files
{
$s = str_replace(e_LANGUAGE, 'English', $s);
if (is_readable($s))
{
$ret = include_once($s);
return (isset($ret)) ? $ret : "";
}
}
return FALSE; // Nothing found
}
/**
* Prepare e107 environment
* This is done before e107_dirs initilization and config include
* @param bool $checkS basic security check (0.7 like), will be extended in the future
* @return e107
*/
public function prepare_request($checkS = true)
{
// Block common bad agents / queries / php issues.
array_walk($_SERVER, [self::class, "filter_request"] , '_SERVER');
if (isset($_GET))
{
array_walk($_GET, [self::class, "filter_request"], '_GET');
}
if (isset($_POST))
{
array_walk($_POST, [self::class, "filter_request"], '_POST');
reset($_POST); // Change of behaviour in PHP 5.3.17?
}
if (isset($_COOKIE))
{
array_walk($_COOKIE, [self::class, "filter_request"], '_COOKIE');
}
if (isset($_REQUEST))
{
array_walk($_REQUEST, [self::class, "filter_request"], '_REQUEST');
}
// A better way to detect an AJAX request. No need for "ajax_used=1";
if(!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) === 'xmlhttprequest')
{
define('e_AJAX_REQUEST', true);
}
else
{
define('e_AJAX_REQUEST', isset($_REQUEST['ajax_used']));
}
unset($_REQUEST['ajax_used']); // removed because it's auto-appended from JS (AJAX), could break something...
//$GLOBALS['_E107'] - minimal mode - here because of the e_AJAX_REQUEST
if(isset($GLOBALS['_E107']['minimal']) || e_AJAX_REQUEST || deftrue('e_MINIMAL'))
{
$_e107vars = array('forceuserupdate', 'online', 'menus', 'prunetmp');
$GLOBALS['_E107']['minimal'] = true;
// lame but quick - allow online when ajax request only, additonal checks are made in e_online class
if(e_AJAX_REQUEST && !isset($GLOBALS['_E107']['online']) && !isset($GLOBALS['_E107']['minimal']))
{
unset($_e107vars[1]);
}
foreach($_e107vars as $v)
{
$noname = 'no_'.$v;
if(!isset($GLOBALS['_E107'][$v]))
{
$GLOBALS['_E107'][$noname] = 1;
}
unset($GLOBALS['_E107'][$v]);
}
}
// we can now start use $e107->_E107
if(isset($GLOBALS['_E107']) && is_array($GLOBALS['_E107']))
{
$this->_E107 = &$GLOBALS['_E107'];
}
// remove ajax_used=1 from query string to avoid SELF problems, ajax should always be detected via e_AJAX_REQUEST constant
$_SERVER['QUERY_STRING'] = trim(
str_replace(
array('ajax_used=1', '&&'),
array('', '&'),
(isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '')
), '&');
/* PathInfo doesn't break anything, URLs should be always absolute. Disabling the below forever.
// e107 uses relative url's, which are broken by "pretty" URL's. So for now we don't support / after .php
if(($pos = strpos($_SERVER['PHP_SELF'], '.php/')) !== false) // redirect bad URLs to the correct one.
{
$new_url = substr($_SERVER['PHP_SELF'], 0, $pos+4);
$new_loc = ($_SERVER['QUERY_STRING']) ? $new_url.'?'.$_SERVER['QUERY_STRING'] : $new_url;
header('Location: '.$new_loc);
exit();
}
*/
// If url contains a .php in it, PHP_SELF is set wrong (imho), affecting all paths. We need to 'fix' it if it does.
$_SERVER['PHP_SELF'] = (($pos = stripos($_SERVER['PHP_SELF'], '.php')) !== false ? substr($_SERVER['PHP_SELF'], 0, $pos+4) : $_SERVER['PHP_SELF']);
// setup some php options
self::ini_set('magic_quotes_runtime', 0);
self::ini_set('magic_quotes_sybase', 0);
// self::ini_set('arg_separator.output', '&'); // non-standard and bad for third-party script compatibility. @see https://github.com/e107inc/e107/issues/3116
self::ini_set('session.use_only_cookies', 1);
self::ini_set('session.use_trans_sid', 0);
self::ini_set('session.cookie_httponly', 1); // cookie won't be accessible by scripting languages, such as JavaScript. Can effectively help to reduce identity theft through XSS attacks
// Ensure thet '.' is the first part of the include path
$inc_path = explode(PATH_SEPARATOR, ini_get('include_path'));
if($inc_path[0] !== '.')
{
array_unshift($inc_path, '.');
$inc_path = implode(PATH_SEPARATOR, $inc_path);
self::ini_set('include_path', $inc_path);
}
unset($inc_path);
return $this;
}
/**
* Filter User Input - used by array_walk in prepare_request method above.
* @param string $input array value
* @param string $key array key
* @param string $type array type _SESSION, _GET etc.
* @param bool $base64
* @return bool|null
*/
public static function filter_request($input,$key,$type,$base64=FALSE)
{
if(is_string($input) && trim($input)=="")
{
return '';
}
if (is_array($input))
{
return array_walk($input, array('self', 'filter_request'), $type);
}
if($type === "_POST" || ($type === "_SERVER" && ($key === "QUERY_STRING")))
{
if($type === "_POST" && ($base64 === false))
{
$input = preg_replace("/(\[code\])(.*?)(\[\/code\])/is","",$input);
}
$regex = "/(base64_decode|chr|php_uname|fwrite|fopen|fputs|passthru|popen|proc_open|shell_exec|exec|proc_nice|proc_terminate|proc_get_status|proc_close|pfsockopen|apache_child_terminate|posix_kill|posix_mkfifo|posix_setpgid|posix_setsid|posix_setuid|phpinfo) *?\((.*) ?\;?/i";
if(preg_match($regex,$input))
{
self::die_http_400();
}
// Check for XSS JS
$regex = "/(document\.location|document\.write|document\.cookie)/i";
if(preg_match($regex,$input))
{
self::die_http_400();
}
// Suspicious HTML.
if(strpos($input, '<body/onload')!==false)
{
self::die_http_400();
}
if(preg_match("/system\((.*);.*\)/i",$input))
{
self::die_http_400();
}
$regex = "/(wget |curl -o |lwp-download|onmouse)/i";
if(preg_match($regex,$input))
{
self::die_http_400();
}
}
if($type === '_GET') // Basic XSS check.
{
if(stripos($input, "<script")!==false || stripos($input, "%3Cscript")!==false)
{
self::die_http_400();
}
}
if($type === "_SERVER")
{
$input = strtolower($input);
if(($key === "QUERY_STRING") && (
strpos($input,"../../")!==FALSE
|| stripos($input,"php:")!==FALSE
|| stripos($input,"data:")!==FALSE
|| stripos($input,"%3cscript")!==FALSE
))
{
self::die_http_400();
}
if(($key === "HTTP_USER_AGENT") && strpos($input,"libwww-perl")!==FALSE)
{
self::die_http_400();
}
}
if(strpos(str_replace('.', '', $input), '22250738585072011') !== FALSE) // php-bug 53632
{
self::die_http_400();
}
if($base64 != true)
{
self::filter_request(base64_decode($input, true),$key,$type,true);
}
}
/**
* Set base system path
* @return e107
*/
public function set_base_path($force = null)
{
$ssl_enabled = ($force !== null) ? $force : $this->isSecure();//(self::getPref('ssl_enabled') == 1);
$this->base_path = $ssl_enabled ? $this->https_path : $this->http_path;
return $this;
}
/**
* Set various system environment constants
* @return e107
*/
public function set_constants()
{
if(!defined('MAGIC_QUOTES_GPC'))
{
define('MAGIC_QUOTES_GPC', false); // (Removed in PHP 5.4 ini_get('magic_quotes_gpc') ? true : false));
}
define('MPREFIX', self::getMySQLConfig('prefix')); // mysql prefix
define('CHARSET', 'utf-8'); // set CHARSET for backward compatibility
if(!defined('e_MOD_REWRITE')) // Allow e107_config.php to override.
{
$HTTP_MOD_REWRITE = isset($_SERVER['HTTP_MOD_REWRITE']) ? $_SERVER['HTTP_MOD_REWRITE'] : getenv('HTTP_MOD_REWRITE');
$REDIRECT_HTTP_MOD_REWRITE = isset($_SERVER['REDIRECT_HTTP_MOD_REWRITE']) ? $_SERVER['REDIRECT_HTTP_MOD_REWRITE'] : getenv('REDIRECT_HTTP_MOD_REWRITE');
define('e_MOD_REWRITE', (($HTTP_MOD_REWRITE === 'On' || $REDIRECT_HTTP_MOD_REWRITE === 'On')));
}
if(!defined('e_MOD_REWRITE_MEDIA')) // Allow e107_config.php to override.
{
$HTTP_MOD_REWRITE_MEDIA = isset($_SERVER['HTTP_MOD_REWRITE_MEDIA']) ? $_SERVER['HTTP_MOD_REWRITE_MEDIA'] : getenv('HTTP_MOD_REWRITE_MEDIA');
$REDIRECT_HTTP_MOD_REWRITE_MEDIA = isset($_SERVER['REDIRECT_HTTP_MOD_REWRITE_MEDIA']) ? $_SERVER['REDIRECT_HTTP_MOD_REWRITE_MEDIA'] : getenv('REDIRECT_HTTP_MOD_REWRITE_MEDIA');
define('e_MOD_REWRITE_MEDIA', (($HTTP_MOD_REWRITE_MEDIA === 'On' || $REDIRECT_HTTP_MOD_REWRITE_MEDIA === 'On')));
}
if(!defined('e_MOD_REWRITE_STATIC')) // Allow e107_config.php to override.
{
$HTTP_MOD_REWRITE_STATIC = isset($_SERVER['HTTP_MOD_REWRITE_STATIC']) ? $_SERVER['HTTP_MOD_REWRITE_STATIC'] : getenv('HTTP_MOD_REWRITE_STATIC');
$REDIRECT_HTTP_MOD_REWRITE_STATIC = isset($_SERVER['REDIRECT_HTTP_MOD_REWRITE_STATIC']) ? $_SERVER['REDIRECT_HTTP_MOD_REWRITE_STATIC'] : getenv('REDIRECT_HTTP_MOD_REWRITE_STATIC');
define('e_MOD_REWRITE_STATIC', (($HTTP_MOD_REWRITE_STATIC === 'On' || $REDIRECT_HTTP_MOD_REWRITE_STATIC === 'On')));
}
$subdomain = false;
// Define the domain name and subdomain name.
if (is_numeric(str_replace(".", "",
(isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '')
)))
{
$domain = false;
$subdomain = false;
}
else
{
$_SERVER['SERVER_NAME'] = isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : '';
$host = !empty($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_SERVER['SERVER_NAME'];
$domain = preg_replace('/^www\.|:\d*$/', '', $host); // remove www. and port numbers.
$dtemp = explode(".", $domain);
if(count($dtemp) > 2 && strlen($dtemp[0]) === 2) // eg. fr.mysite.com or fr.mysite.com.fr
{
$subdomain = $dtemp[0];
unset($dtemp[0]);
$domain = implode('.',$dtemp); // remove subdomain because it's a language-code.
}
}
if($domain === 'localhost') // Fix for chrome.
{
$domain = false;
}
define("e_DOMAIN", $domain);
define("e_SUBDOMAIN", ($subdomain) ?: false);
define('e_UC_PUBLIC', 0);
define('e_UC_MAINADMIN', 250);
define('e_UC_READONLY', 251);
define('e_UC_GUEST', 252);
define('e_UC_MEMBER', 253);
define('e_UC_ADMIN', 254);
define('e_UC_NOBODY', 255);
return $this;
}
/**
* Relaitve server path - set_path() helper
* @param string $dir
* @return string
*/
public function get_override_rel($dir)
{
if(isset($this->e107_dirs[$dir.'_SERVER']))
{
return $this->e107_dirs[$dir.'_SERVER'];
}
return e_BASE.$this->e107_dirs[$dir.'_DIRECTORY'];
}
/**
* Absolute HTTP path - set_path() helper
* @param string $dir
* @return string
*/
public function get_override_http($dir)
{
if(isset($this->e107_dirs[$dir.'_HTTP']))
{
return $this->e107_dirs[$dir.'_HTTP'];
}
return e_HTTP.$this->e107_dirs[$dir.'_DIRECTORY'];
}
/**
* Set all environment vars and constants
* @return e107
*/
public function set_paths()
{
// ssl_enabled pref not needed anymore, scheme is auto-detected
$this->HTTP_SCHEME = 'http';
if (
(!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off') ||
(!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] == 443)
)
{
$this->HTTP_SCHEME = 'https';
}
$path = "";
$target_path = '';
$needle = "/class2.php";
if (file_exists(__DIR__."/..".$needle))
{
$target_path = realpath(__DIR__."/..".$needle);
}
else
{
$debug_backtrace = array_reverse(debug_backtrace());
foreach ($debug_backtrace as $stack_item)
{
$target_path = isset($stack_item["file"]) ? $stack_item["file"] : "";
if (substr_compare($target_path, $needle, -strlen($needle)) === 0) break;
break;
}
}
if(self::isCli()) // Maintain relative path consistency in CLI mode
{
chdir(e_ROOT);
define('e_HTTP', '/'); // fixes generate URLs by not using $this->server_path
}
$path = dirname(self::getRelativePath(getcwd(), $target_path)) . "/";
$http_path = dirname($_SERVER['SCRIPT_NAME']);
$http_path = explode("/", $http_path);
for ($i = 0; $i < substr_count($path, "../"); $i ++)
{
array_pop($http_path);
}
$this->server_path = implode("/", $http_path)."/";
$this->server_path = $this->fix_windows_paths($this->server_path);
//var_dump($this->server_path);
//exit;
if ($this->server_path === "//")
{
$this->server_path = "/";
}
// Absolute file-path of directory containing class2.php
// define("e_ROOT", realpath(dirname(__FILE__)."/../")."/");
$this->relative_base_path = $path;
$_SERVER['HTTP_HOST'] = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : 'localhost';
$this->http_path = filter_var("http://{$_SERVER['HTTP_HOST']}{$this->server_path}", FILTER_SANITIZE_URL);
$this->https_path = filter_var("https://{$_SERVER['HTTP_HOST']}{$this->server_path}", FILTER_SANITIZE_URL);
$this->file_path = $path;
if(defined('e_HTTP') && defined('e_ADMIN'))
{
return $this;
}
if(!defined('e_HTTP'))
{
define('e_HTTP', $this->server_path); // Directory of site root relative to HTML base directory
}
define('e_BASE', $this->relative_base_path);
// Base dir of web stuff in server terms. e_ROOT should always end with e_HTTP, even if e_HTTP = '/'
define('SERVERBASE', substr(e_ROOT, 0, -strlen(e_HTTP) + 1));
if(isset($_SERVER['DOCUMENT_ROOT']))
{
define('e_DOCROOT', $_SERVER['DOCUMENT_ROOT']."/");
}
else
{
define('e_DOCROOT', false);
}
//BC temporary fixes
if (!isset($this->e107_dirs['UPLOADS_SERVER']) && $this->e107_dirs['UPLOADS_DIRECTORY'][0] === "/")
{
$this->e107_dirs['UPLOADS_SERVER'] = $this->e107_dirs['UPLOADS_DIRECTORY'];
}
if (!isset($this->e107_dirs['DOWNLOADS_SERVER']) && $this->e107_dirs['DOWNLOADS_DIRECTORY'][0] === "/")
{
$this->e107_dirs['DOWNLOADS_SERVER'] = $this->e107_dirs['DOWNLOADS_DIRECTORY'];
}
//
// HTTP relative paths
//
define('e_ADMIN', $this->get_override_rel('ADMIN'));
define('e_IMAGE', $this->get_override_rel('IMAGES'));
define('e_THEME', $this->get_override_rel('THEMES'));
define('e_PLUGIN', $this->get_override_rel('PLUGINS'));
define('e_FILE', $this->get_override_rel('FILES'));
define('e_HANDLER', $this->get_override_rel('HANDLERS'));
define('e_LANGUAGEDIR', $this->get_override_rel('LANGUAGES'));
define('e_DOCS', $this->get_override_rel('HELP')); // WILL CHANGE SOON - $this->_get_override_rel('DOCS')
define('e_HELP', $this->get_override_rel('HELP'));
define('e_MEDIA', $this->get_override_rel('MEDIA'));
define('e_MEDIA_BASE', $this->get_override_rel('MEDIA_BASE'));
define('e_MEDIA_FILE', $this->get_override_rel('MEDIA_FILES'));
define('e_MEDIA_VIDEO', $this->get_override_rel('MEDIA_VIDEOS'));
define('e_MEDIA_IMAGE', $this->get_override_rel('MEDIA_IMAGES'));
define('e_MEDIA_ICON', $this->get_override_rel('MEDIA_ICONS'));
// define('e_MEDIA_AVATAR', $this->get_override_rel('MEDIA_AVATARS'));
define('e_DOWNLOAD', $this->get_override_rel('DOWNLOADS'));
define('e_UPLOAD', $this->get_override_rel('UPLOADS'));
define('e_CORE', $this->get_override_rel('CORE'));
define('e_SYSTEM', $this->get_override_rel('SYSTEM'));
define('e_SYSTEM_BASE', $this->get_override_rel('SYSTEM_BASE'));
define('e_WEB', $this->get_override_rel('WEB'));
define('e_WEB_JS', $this->get_override_rel('WEB_JS'));
define('e_WEB_CSS', $this->get_override_rel('WEB_CSS'));
define('e_WEB_IMAGE', $this->get_override_rel('WEB_IMAGES'));
// define('e_WEB_PACK', $this->get_override_rel('WEB_PACKS'));
define('e_CACHE', $this->get_override_rel('CACHE'));
define('e_CACHE_CONTENT', $this->get_override_rel('CACHE_CONTENT'));
define('e_CACHE_IMAGE', $this->get_override_rel('CACHE_IMAGE'));
define('e_CACHE_DB', $this->get_override_rel('CACHE_DB'));
define('e_CACHE_URL', $this->get_override_rel('CACHE_URL'));
define('e_LOG', $this->get_override_rel('LOGS'));
define('e_BACKUP', $this->get_override_rel('BACKUP'));
define('e_TEMP', $this->get_override_rel('TEMP'));
define('e_IMPORT', $this->get_override_rel('IMPORT'));
//
// HTTP absolute paths
//
define("e_ADMIN_ABS", $this->get_override_http('ADMIN'));
define("e_IMAGE_ABS", $this->get_override_http('IMAGES'));
define("e_THEME_ABS", $this->get_override_http('THEMES'));
define("e_PLUGIN_ABS", $this->get_override_http('PLUGINS'));
define("e_FILE_ABS", $this->get_override_http('FILES')); // Deprecated!
define("e_DOCS_ABS", $this->get_override_http('DOCS'));
define("e_HELP_ABS", $this->get_override_http('HELP'));
define("e_IMPORT_ABS", false);
// DEPRECATED - not a legal http query now!
//define("e_HANDLER_ABS", $this->get_override_http('HANDLERS'));
//define("e_LANGUAGEDIR_ABS", $this->get_override_http('LANGUAGES'));
//define("e_LOG_ABS", $this->get_override_http('LOGS'));
define("e_MEDIA_ABS", $this->get_override_http('MEDIA'));
define('e_MEDIA_FILE_ABS', $this->get_override_http('MEDIA_FILES'));
define('e_MEDIA_VIDEO_ABS', $this->get_override_http('MEDIA_VIDEOS'));
define('e_MEDIA_IMAGE_ABS', $this->get_override_http('MEDIA_IMAGES'));
define('e_MEDIA_ICON_ABS', $this->get_override_http('MEDIA_ICONS'));
// define('e_MEDIA_AVATAR_ABS', $this->get_override_http('MEDIA_AVATARS'));
// XXX DISCUSSS - e_JS_ABS, e_CSS_ABS etc is not following the naming standards but they're more usable.
// Example: e_JS_ABS vs e_WEB_JS_ABS
//XXX Absolute is assumed.
define('e_WEB_ABS', $this->get_override_http('WEB'));
define('e_JS_ABS', $this->get_override_http('WEB_JS'));
define('e_CSS_ABS', $this->get_override_http('WEB_CSS'));
// define('e_PACK_ABS', $this->get_override_http('WEB_PACKS'));
define('e_WEB_IMAGE_ABS', $this->get_override_http('WEB_IMAGES'));
define('e_JS', $this->get_override_http('WEB_JS')); // ABS Alias
define('e_CSS', $this->get_override_http('WEB_CSS')); // ABS Alias
define('e_AVATAR', $this->get_override_rel('AVATARS'));
define('e_AVATAR_UPLOAD', $this->get_override_rel('AVATARS_UPLOAD'));
define('e_AVATAR_DEFAULT', $this->get_override_rel('AVATARS_DEFAULT'));
define('e_AVATAR_ABS', $this->get_override_http('AVATARS'));
define('e_AVATAR_UPLOAD_ABS', $this->get_override_http('AVATARS_UPLOAD'));
define('e_AVATAR_DEFAULT_ABS', $this->get_override_http('AVATARS_DEFAULT'));
define('e_CACHE_IMAGE_ABS', $this->get_override_http('CACHE_IMAGE'));
// Special
define('e_BOOTSTRAP', e_WEB."bootstrap/");
return $this;
}
/**
* Fix Windows server path
*
* @param string $path resolved server path
* @return string fixed path
*/
function fix_windows_paths($path)
{
$fixed_path = str_replace(array('\\\\', '\\'), array('/', '/'), $path);
$fixed_path = (substr($fixed_path, 1, 2) === ":/" ? substr($fixed_path, 2) : $fixed_path);
return $fixed_path;
}
/**
* Convert two absolute paths to a relative path between them
* @license https://creativecommons.org/licenses/by-sa/3.0/ CC BY-SA 3.0
* @see https://stackoverflow.com/a/2638272
* @param $from string Absolute path of traversal source
* @param $to string Absolute path of traversal destination
* @return string Relative path from the source to the destination
*/
private static function getRelativePath($from, $to)
{
$from = is_dir($from) ? rtrim($from, '\/') . '/' : $from;
$to = is_dir($to) ? rtrim($to, '\/') . '/' : $to;
$from = str_replace('\\', '/', $from);
$to = str_replace('\\', '/', $to);
$from = explode('/', $from);
$to = explode('/', $to);
$relPath = $to;
foreach ($from as $depth => $dir)
{
if ($dir === $to[$depth])
{
array_shift($relPath);
}
else
{
$remaining = count($from) - $depth;
if ($remaining > 1)
{
$padLength = (count($relPath) + $remaining - 1) * -1;
$relPath = array_pad($relPath, $padLength, '..');
break;
}
else
{
$relPath[0] = './' . $relPath[0];
}
}
}
return implode('/', $relPath);
}
/**
* Define e_PAGE, e_SELF, e_ADMIN_AREA and USER_AREA;
* The following files are assumed to use admin theme:
* 1. Any file in the admin directory (check for non-plugin added to avoid mismatches)
* 2. any plugin file starting with 'admin_'
* 3. any plugin file in a folder called admin/
* 4. any file that specifies $eplug_admin = TRUE; or ADMIN_AREA = TRUE;
* NOTE: USER_AREA = true; will force e_ADMIN_AREA to FALSE
*
* @param boolean $no_cbrace remove curly brackets from the url
* @return e107
*/
public function set_urls($no_cbrace = true)
{
//global $PLUGINS_DIRECTORY,$ADMIN_DIRECTORY, $eplug_admin;
$PLUGINS_DIRECTORY = self::getFolder('plugins');
$ADMIN_DIRECTORY = self::getFolder('admin');
define('ADMINDIR', $ADMIN_DIRECTORY);
// Outdated
/*$requestQry = '';
$requestUrl = $_SERVER['REQUEST_URI'];
if(strpos($_SERVER['REQUEST_URI'], '?') !== FALSE)
list($requestUrl, $requestQry) = explode("?", $_SERVER['REQUEST_URI'], 2); */
// Leave e_SELF BC, use e_REQUEST_SELF instead
/*// moved after page check - e_PAGE is important for BC
if($requestUrl && $requestUrl != $_SERVER['PHP_SELF'])
{
$_SERVER['PHP_SELF'] = $requestUrl;
}*/
if(self::isCli())
{
if(!empty($_SERVER['argv']) && isset($_SERVER['argv'][1]) && empty($_GET))
{
parse_str($_SERVER['argv'][1], $_GET); // convert argv to $_GET for script testing via CLI.
}
if(!empty($_SERVER['_']) && empty($_SERVER['SCRIPT_FILENAME']))
{
$_SERVER['SCRIPT_FILENAME'] = $_SERVER['_'];
}
}
$eSelf = !empty($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_FILENAME'];
$_self = $this->HTTP_SCHEME.'://'.$_SERVER['HTTP_HOST'].$eSelf;
// START New - request uri/url detection, XSS protection
$requestUri = $requestUrl = '';
if (isset($_SERVER['HTTP_X_REWRITE_URL']))
{
// check this first so IIS will catch
$requestUri = $_SERVER['HTTP_X_REWRITE_URL'];
$requestUrl = $this->HTTP_SCHEME.'://'.$_SERVER['HTTP_HOST'].$requestUri;
// fix request uri
$_SERVER['REQUEST_URI'] = $requestUri;
}
elseif (isset($_SERVER['REQUEST_URI']))
{
$requestUri = $_SERVER['REQUEST_URI'];
$requestUrl = $this->HTTP_SCHEME.'://'.$_SERVER['HTTP_HOST'].$requestUri;
}
else
{
// go back to e_SELF
$requestUri = $eSelf;
$requestUrl = $_self;
if(defset('e_QUERY'))
{
$requestUri .= '?'.e_QUERY;
$requestUrl .= '?'.e_QUERY;
}
}
$check = rawurldecode($requestUri); // urlencoded by default
// a bit aggressive XSS protection... convert to e.g. htmlentities if you are not a bad guy
$checkregx = $no_cbrace ? '[<>\{\}]' : '[<>]';
if(preg_match('/'.$checkregx.'/', $check))
{
// header('HTTP/1.1 403 Forbidden');
$requestUri = filter_var($requestUri, FILTER_SANITIZE_URL);
// exit;
}
// e_MENU fix
if(deftrue('e_MENU'))
{
$requestUri = str_replace('['.e_MENU.']', '', $requestUri);
$requestUrl = str_replace('['.e_MENU.']', '', $requestUrl);
if(defset('e_QUERY'))
{
parse_str(str_replace('&', '&', e_QUERY), $_GET);
}
}
define('e_REQUEST_URL', str_replace(array("'", '"'), array('%27', '%22'), $requestUrl)); // full request url string (including domain)
$tmp = explode('?', e_REQUEST_URL);
$requestSelf = array_shift($tmp);
if(substr($requestSelf,-4) !== '.php' && substr($requestSelf,-1) !== '/')
{
$requestSelf .= '/'; // Always include a trailing slash on SEF Urls so that e_REQUEST_SELF."?".e_QUERY doesn't break.
}
// the last anti-XSS measure, XHTML compliant URL to be used in forms instead e_SELF
define('e_REQUEST_SELF', filter_var($requestSelf, FILTER_SANITIZE_URL)); // full URL without the QUERY string
define('e_REQUEST_URI', str_replace(array("'", '"'), array('%27', '%22'), $requestUri)); // absolute http path + query string
$tmp2 = explode('?', e_REQUEST_URI);
define('e_REQUEST_HTTP', array_shift($tmp2)); // SELF URL without the QUERY string and leading domain part
if(!deftrue('e_SINGLE_ENTRY') && !deftrue('e_SELF_OVERRIDE') )
{
$page = substr(strrchr($_SERVER['PHP_SELF'], '/'), 1);
if(!empty($_SERVER['_']) && self::isCli())
{
$page = basename($_SERVER['_']);
}
define('e_PAGE', $page);
define('e_SELF', filter_var($_self, FILTER_SANITIZE_URL));
}
else
{
define('e_SELF', e_REQUEST_SELF);
if(deftrue('e_SELF_OVERRIDE')) // see multisite plugin.
{
define('e_PAGE', basename($_SERVER['SCRIPT_FILENAME']));
}
}
unset($requestUrl, $requestUri);
// END request uri/url detection, XSS protection
$curPage = !empty($_SERVER['SCRIPT_FILENAME']) ? basename($_SERVER['SCRIPT_FILENAME']) : '';
$_SERVER['REQUEST_URI'] = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
$isPluginDir = strpos($_self,'/'.$PLUGINS_DIRECTORY) !== FALSE; // True if we're in a plugin
$e107Path = str_replace($this->base_path, '', $_self); // Knock off the initial bits
$inAdminDir = $this->inAdminDir($e107Path, $curPage, $isPluginDir);
// e_SELF has the full HTML path
if ($isPluginDir)
{
$temp = substr($e107Path, strpos($e107Path, '/') +1);
$plugDir = substr($temp, 0, strpos($temp, '/'));
define('e_CURRENT_PLUGIN', rtrim($plugDir,'/'));
define('e_PLUGIN_DIR', e_PLUGIN.e_CURRENT_PLUGIN.'/');
define('e_PLUGIN_DIR_ABS', e_PLUGIN_ABS.e_CURRENT_PLUGIN.'/');
}
else
{
// define('e_CURRENT_PLUGIN', ''); // leave it undefined so it can be added later during sef-url detection.
define('e_PLUGIN_DIR', '');
define('e_PLUGIN_DIR_ABS', '');
}
if(!defined('e_ADMIN_AREA'))
{
define('e_ADMIN_AREA', ($inAdminDir && !deftrue('USER_AREA')));
}
return $this;
}
/**
* Internal Use Only.
* @param string $e107Path
* @param string $curPage
* @param bool $isPluginDir
* @return bool
*/
public function inAdminDir($e107Path, $curPage, $isPluginDir)
{
$inAdminDir = false;
$eplug_admin = !empty($GLOBALS['eplug_admin']);
if($eplug_admin || deftrue('ADMIN_AREA'))
{
return true;
}
if(strpos($e107Path, ADMINDIR) === 0) // core admin.
{
$inAdminDir = true;
}
elseif($isPluginDir) // plugin admin areas
{
if($curPage === 'prefs.php' || $curPage === 'config.php' || strpos($curPage,'admin_') === 0)
{
$inAdminDir = true;
}
elseif(strpos($e107Path, 'admin/') !== false || strpos($curPage, '_admin.php') !==false || strpos($curPage, '_config.php') !==false)
{
$inAdminDir = true;
}
}
return $inAdminDir;
}
/**
* The second part of e107::set_urls()
* Supposed to load after database has been initialized
*
* Implemented out of necessity due to
* https://github.com/e107inc/e107/issues/3033
*
* @return e107
*/
public function set_urls_deferred()
{
if(self::isCli())
{
define('SITEURL', self::getPref('siteurl'));
define('SITEURLBASE', rtrim(SITEURL,'/'));
}
else
{
define('SITEURLBASE', $this->HTTP_SCHEME.'://'. filter_var($_SERVER['HTTP_HOST'], FILTER_SANITIZE_URL));
define('SITEURL', SITEURLBASE.e_HTTP);
}
// login/signup
define('e_SIGNUP', SITEURL.(file_exists(e_BASE.'customsignup.php') ? 'customsignup.php' : 'signup.php'));
if(!defined('e_LOGIN'))
{
define('e_LOGIN', SITEURL.(file_exists(e_BASE.'customlogin.php') ? 'customlogin.php' : 'login.php'));
}
return $this;
}
/**
* Defines e_QUERY in a format that can be used in HTML and defines e_MENU
* @param boolean $no_cbrace remove curly brackets from the url
* @return string parsed query string.
*/
public function set_request($no_cbrace = true, $queryString =null)
{
if($queryString === null)
{
$queryString = $_SERVER['QUERY_STRING'] ;
}
$inArray = array("'", '/**/', '/UNION/', '/SELECT/', 'AS ');
foreach($inArray as $res)
{
if(stripos($queryString, $res) !== false)
{
die('Access denied.');
}
}
$eMENUQry = str_replace(array('%5B','%5D'),array('[',']'), $queryString); //FIX for urlencoded QUERY_STRING without breaking the '+' used by debug.
if (strpos($eMENUQry, ']') && preg_match('#^\[(.*?)](.*)#', $eMENUQry, $matches))
{
if(!defined('e_MENU'))
{
define('e_MENU', $matches[1]);
}
$e_QUERY = $matches[2];
}
else
{
if(!defined('e_MENU'))
{
define('e_MENU', '');
}
$e_QUERY = $queryString;
}
if ($no_cbrace)
{
$e_QUERY = str_replace(array('{', '}', '%7B', '%7b', '%7D', '%7d'), '', rawurldecode($e_QUERY));
}
$e_QUERY = htmlspecialchars(self::getParser()->post_toForm($e_QUERY));
// e_QUERY SHOULD NOT BE DEFINED IF IN SNIGLE ENTRY MODE OR ALL URLS WILL BE BROKEN - it's defined later within the the router
if(!deftrue("e_SINGLE_ENTRY"))
{
if(!defined('e_QUERY'))
{
define('e_QUERY', $e_QUERY);
$_SERVER['QUERY_STRING'] = $e_QUERY;
}
}
if(!defined('e_TBQS')) // for the unit tests.
{
define('e_TBQS', $_SERVER['QUERY_STRING']);
}
return $e_QUERY;
}
/**
* Basic implementation of Browser cache control per user session. Awaiting improvement in future versions
* If no argument is passed it returns
* boolean (if current page is cacheable).
* If string is passed, it's asumed to be aboslute request path (e_REQUEST_URI alike)
* If true is passed, e_REQUEST_URI is registered
* @param null $set
* @return bool|null
*/
public static function canCache($set = null)
{
$_data = self::getSession()->get('__sessionBrowserCache');
if(!is_array($_data))
{
$_data = array();
}
if($set === null)
{
return in_array(e_REQUEST_URI, $_data);
}
// remove e_REQUEST_URI from the set
if($set === false)
{
$check = array_search(e_REQUEST_URI, $_data);
if($check !== false)
{
unset($_data[$check]);
self::getSession()->set('__sessionBrowserCache', $_data);
return null;
}
}
if($set === true)
{
$set = e_REQUEST_URI;
}
if(empty($set) || !is_string($set) || in_array($set, $_data))
{
return null;
}
$_data[] = $set;
self::getSession()->set('__sessionBrowserCache', array_unique($_data));
}
/**
* Check if current request is secure (https)
* @return boolean TRUE if https, FALSE if http
*/
public function isSecure()
{
return ($this->HTTP_SCHEME === 'https');
}
/**
*
* Get the current user's IP address
* returns the address in internal 'normalised' IPV6 format - so most code should continue to work provided the DB Field is big enougn
* @return string
*/
public function getip()
{
return self::getIPHandler()->getIP();
}
/**
* Encode an IP address to internal representation. Returns string if successful; FALSE on error
* Default separates fields with ':'; set $div='' to produce a 32-char packed hex string
* @deprecated Use getIPHandler()->ipEncode($ip) instead.
* @param string $ip
* @param string $div divider
* @return string encoded IP
*/
public function ipEncode($ip, $div = ':')
{
return self::getIPHandler()->ipEncode($ip);
}
/**
* Takes an encoded IP address - returns a displayable one
* Set $IP4Legacy TRUE to display 'old' (IPv4) addresses in the familiar dotted format,
* FALSE to display in standard IPV6 format
* Should handle most things that can be thrown at it.
* @deprecated Use getIPHandler()->ipDecode($ip, $IP4Legacy); instead.
* @param string $ip encoded IP
* @param boolean $IP4Legacy
* @return string decoded IP
*/
public function ipdecode($ip, $IP4Legacy = TRUE)
{
return self::getIPHandler()->ipDecode($ip, $IP4Legacy);
}
/**
* Retrieve & cache host name
* @deprecated Use getIPHandler()->get_host_name() instead. Still needed by some old plugins/menus.
* @param string $ip_address
* @return string host name
*/
public function get_host_name($ip_address)
{
trigger_error('<b>'.__METHOD__.' is deprecated.</b> Use getIPHandler()->get_host_name() instead.', E_USER_DEPRECATED); // NO LAN
return self::getIPHandler()->get_host_name($ip_address);
}
/**
* @deprecated Use eHelper::parseMemorySize() instead.
* @param integer $size
* @param integer $dp
* @return string formatted size
*/
public function parseMemorySize($size, $dp = 2)
{
return eHelper::parseMemorySize($size, $dp);
}
/**
* Removed, see eHelper::getMemoryUsage()
* Get the current memory usage of the code
* If $separator argument is null, raw data (array) will be returned
*
* @param null|string $separator
* @return string|array memory usage
*/
/*
public function get_memory_usage($separator = '/')
{
return eHelper::getMemoryUsage($separator);
}*/
/**
* Check if plugin is installed
* @param string $plugname
* @return boolean
*/
public static function isInstalled($plugname)
{
// Could add more checks here later if appropriate
return self::getConfig()->isData('plug_installed/'.$plugname);
}
/**
* Returns true if the number is compatible with this version of e107.
* @param string $version The minimum version requirement
* @param string theme|plugin
* @return bool
*/
public static function isCompatible($version, $mode)
{
$tp = e107::getParser();
$e107info = [];
include(e_ADMIN."ver.php"); // $e107info['e107_version'];
$e107 = $tp->filter($e107info['e107_version'], 'version');
$version = $tp->filter($version, 'version');
if(((int) $version === 1)) // version 1, assumed to be incompatible.
{
return ($mode === 'plugin') ? false : true;
}
return version_compare($e107 ,$version, '>=');
}
/**
* Safe way to set ini var
* @param string $var
* @param string $value
* @return false|string
*/
public static function ini_set($var, $value)
{
if (function_exists('ini_set'))
{
return ini_set($var, $value);
}
return false;
}
/**
* Register autoload function (string) or static class method - array('ClassName', 'MethodName')
* @param string|array $function
* @param bool $prepend
* @return bool
*/
public static function autoload_register($function, $prepend = false)
{
### NEW Register Autoload - do it asap
if(!function_exists('spl_autoload_register'))
{
// PHP >= 5.1.2 required
die_fatal_error('Fatal exception - spl_autoload_* required.');
}
if(!$prepend || ($registered = spl_autoload_functions()) === false)
{
return spl_autoload_register($function);
}
foreach ($registered as $r)
{
spl_autoload_unregister($r);
}
$result = spl_autoload_register($function);
foreach ($registered as $r)
{
if(!spl_autoload_register($r))
{
$result = false;
}
}
return $result;
}
/**
* Former __autoload, generic core autoload logic
*
* Magic class autoload.
* We are raising plugin structure standard here - plugin auto-loading works ONLY if
* classes live inside 'includes' folder.
* Example: plugin_myplug_admin_ui ->
* <code>
* <?php
* // __autoload() will look in e_PLUGIN.'myplug/includes/admin/ui.php for this class
* // e_admin_ui is core handler, so it'll be autoloaded as well
* class plugin_myplug_admin_ui extends e_admin_ui
* {
*
* }
*
* // __autoload() will look in e_PLUGIN.'myplug/shortcodes/my_shortcodes.php for this class
* // e_admin_ui is core handler, so it'll be autoloaded as well
* class plugin_myplug_my_shortcodes extends e_admin_ui
* {
*
* }
* </code>
* We use now spl_autoload[_*] for core autoloading (PHP5 > 5.1.2)
* At this time we could create e107 version of spl_autoload_register - e_event->register/trigger('autoload')
*
* @todo plugname/e_shortcode.php auto-detection (hard, near impossible at this time) - we need 'plugin_' prefix to
* distinguish them from the core batches
*
* @param string $className
* @return void
*/
public static function autoload($className)
{
//Security...
if (strpos($className, '/') !== false)
{
return;
}
// Detect namespaced class
if (strpos($className, '\\') !== false)
{
self::autoload_namespaced($className);
return;
}
$tmp = explode('_', $className);
//echo 'autoloding...'.$className.'<br />';
switch($tmp[0])
{
case 'plugin': // plugin handlers/shortcode batches
array_shift($tmp); // remove 'plugin'
$end = array_pop($tmp); // check for 'shortcodes' end phrase
if (!isset($tmp[0]) || !$tmp[0])
{
if($end)
{
// plugin root - e.g. plugin_myplug -> plugins/myplug/myplug.php, class plugin_myplug
$filename = e_PLUGIN.$end.'/'.$end.'.php';
break;
}
return; // In case we get an empty class part
}
// Currently only batches inside shortcodes/ folder are auto-detected,
// read the todo for e_shortcode.php related problems
if($end === 'shortcodes')
{
$filename = e_PLUGIN.$tmp[0].'/shortcodes/batch/'; // plugname/shortcodes/batch/
unset($tmp[0]);
$filename .= implode('_', $tmp).'_shortcodes.php'; // my_shortcodes.php
break;
}
if($end)
{
$tmp[] = $end; // not a shortcode batch - append the end phrase again
}
// Handler check
$tmp[0] .= '/includes'; //folder 'includes' is not part of the class name
$filename = e_PLUGIN.implode('/', $tmp).'.php';
//TODO add debug screen Auto-loaded classes - ['plugin: '.$filename.' - '.$className];
break;
default: //core libraries, core shortcode batches
// core SC batch check
$end = array_pop($tmp);
if($end === 'shortcodes')
{
$filename = e_CORE.'shortcodes/batch/'.$className.'.php'; // core shortcode batch
break;
}
$filename = self::getHandlerPath($className);
//TODO add debug screen Auto-loaded classes - ['core: '.$filename.' - '.$className];
break;
}
if(!empty($filename) && is_file($filename)) // Test with chatbox_menu
{
// autoload doesn't REQUIRE files, because this will break things like call_user_func()
include($filename);
}
}
/**
* Autoloading logic for namespaced classes
*
* @param $className
* @return void
*/
private static function autoload_namespaced($className)
{
$levels = explode('\\', $className);
// Guard against classes that are not ours
if ($levels[0] !== 'e107')
{
return;
}
$levels[0] = e_HANDLER;
$classPath = implode('/', $levels).'.php';
if (is_file($classPath) && is_readable($classPath))
{
include($classPath);
}
}
/**
* @param $name
* @return array|e107_event|e_admin_log|e_array|e_db|e_online|e_parse|e_render|ecache|eIPHandler|eURL|mixed|notify|user_class|null
*/
public function __get($name)
{
switch ($name)
{
case 'tp':
$ret = self::getParser();
break;
case 'sql':
$ret = self::getDb();
break;
case 'ecache':
$ret = self::getCache();
break;
case 'arrayStorage':
$ret = self::getArrayStorage();
break;
case 'e_event':
$ret = self::getEvent();
break;
case 'ns':
$ret = self::getRender();
break;
case 'url':
$ret = self::getUrl();
break;
case 'admin_log':
$ret = self::getLog();
break;
case 'override':
$ret = self::getSingleton('override', e_HANDLER.'override_class.php');
break;
case 'notify':
$ret = self::getNotify();
break;
case 'e_online':
$ret = self::getOnline();
break;
case 'eIPHandler':
$ret = self::getIPHandler();
break;
case 'user_class':
$ret = self::getUserClass();
break;
default:
trigger_error('$e107->$'.$name.' not defined', E_USER_WARNING);
return null;
break;
}
$this->$name = $ret;
return $ret;
}
/**
*
*/
public function destruct()
{
if(self::$_instance === null)
{
return;
}
$print = defined('E107_DBG_TIMEDETAILS') && E107_DBG_TIMEDETAILS;
!$print || print('<table class="table table-striped table-condensed"><tr><td colspan="3"><b>Destructing $e107</b></td></tr>');
$vars = get_object_vars($this);
foreach ($vars as $name => $value)
{
if(is_object($value))
{
if(method_exists($value, '__destruct'))
{
!$print || print('<tr><td>object [property] using __destruct()</td><td>'.$name.'</td><td>'.get_class($value).'</td></tr>');
$value->__destruct();
}
else
{
!$print || print('<tr><td>object [property]</td><td>' . $name . '</td><td>' . get_class($value) . '</td></tr>');
}
$this->$name = null;
}
}
foreach (self::$_registry as $path => $reg)
{
if(is_object($reg))
{
if(method_exists($reg, '__destruct'))
{
!$print || print('<tr><td>object [registry] using __destruct()</td><td>'.$path.'</td><td>'.get_class($reg).'</td></tr>');
$reg->__destruct();
}
else
{
!$print || print('<tr><td>object [registry]</td><td>' . $path . '</td><td>' . get_class($reg) . '</td></tr>');
}
unset(self::$_registry[$path]);
}
}
if($print)
{
echo "</table>";
}
self::$_registry = null;
self::$_instance = null;
}
/**
* Check if there's a core e107 release available
* @return array|bool - return array of data or false if no update available.
*/
public static function coreUpdateAvailable()
{
// Get site version
$e107info= array();
if(is_readable(e_ADMIN."ver.php"))
{
include(e_ADMIN."ver.php"); // $e107info['e107_version'];
}
else
{
return false;
}
$xml = self::getXml();
$file = "https://e107.org/releases.php";
if(!$xdata = $xml->loadXMLfile($file,true))
{
return false;
}
$curVersion = str_replace(' (git)', '', $e107info['e107_version']);
if(empty($xdata['core'][0]['@attributes']['version']))
{
return false;
}
else
{
$newVersion = $xdata['core'][0]['@attributes']['version'];
}
self::getDebug()->log("New Version:".$newVersion);
if(version_compare($curVersion,$newVersion) === -1)
{
return array(
'name' => $xdata['core'][0]['@attributes']['name'],
'url' => $xdata['core'][0]['@attributes']['url'],
'date' => $xdata['core'][0]['@attributes']['date'],
'version' => $xdata['core'][0]['@attributes']['version'],
'infourl' => $xdata['core'][0]['@attributes']['infourl'],
'description' => $xdata['core'][0]['description'],
);
}
return false;
}
}
if(!isset($GLOBALS['_E107']['no_autoload']))
{
e107::autoload_register(array(e107::class, 'autoload'));
// Forward compatibility with e107 v3 Composer autoloading
$vendor_autoload_file = __DIR__."/vendor/autoload.php";
if (file_exists($vendor_autoload_file))
{
include_once($vendor_autoload_file);
}
}
/**
* Interface e_admin_addon_interface @move to separate addons file?
*/
interface e_admin_addon_interface
{
/**
* Return a list of values for the currently viewed list page.
* @param string $event
* @param string $ids comma separated primary ids to return in the array.
* @return array with primary id as keys and array of fields key/pair values.
*/
public function load($event, $ids);
/**
* Extend Admin-ui Parameters
* @param e_admin_ui $ui admin-ui object
* @return array
*/
public function config(e_admin_ui $ui);
/**
* Process Posted Data.
* @param e_admin_ui $ui admin-ui object
* @param int $id
*/
public function process(e_admin_ui $ui, $id=0);
}