123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379 |
- <?php
- /**
- * Elgg configuration procedural code.
- *
- * Includes functions for manipulating the configuration values stored in the database
- * Plugin authors should use the {@link elgg_get_config()}, {@link elgg_set_config()},
- * {@link elgg_save_config()}, and {@unset_config()} functions to access or update
- * config values.
- *
- * Elgg's configuration is split among 2 tables and 1 file:
- * - dbprefix_config
- * - dbprefix_datalists
- * - engine/settings.php (See {@link settings.example.php})
- *
- * Upon system boot, all values in dbprefix_config are read into $CONFIG.
- *
- * @package Elgg.Core
- * @subpackage Configuration
- */
- /**
- * Get the URL for the current (or specified) site
- *
- * @param int $site_guid The GUID of the site whose URL we want to grab
- * @return string
- * @since 1.8.0
- */
- function elgg_get_site_url($site_guid = 0) {
- return _elgg_services()->config->getSiteUrl($site_guid);
- }
- /**
- * Get the plugin path for this installation
- *
- * @return string
- * @since 1.8.0
- */
- function elgg_get_plugins_path() {
- return _elgg_services()->config->getPluginsPath();
- }
- /**
- * Get the data directory path for this installation
- *
- * @return string
- * @since 1.8.0
- */
- function elgg_get_data_path() {
- return _elgg_services()->config->getDataPath();
- }
- /**
- * Get the root directory path for this installation
- *
- * @return string
- * @since 1.8.0
- */
- function elgg_get_root_path() {
- return _elgg_services()->config->getRootPath();
- }
- /**
- * Get an Elgg configuration value
- *
- * @param string $name Name of the configuration value
- * @param int $site_guid null for installation setting, 0 for default site
- *
- * @return mixed Configuration value or null if it does not exist
- * @since 1.8.0
- */
- function elgg_get_config($name, $site_guid = 0) {
- return _elgg_services()->config->get($name, $site_guid);
- }
- /**
- * Set an Elgg configuration value
- *
- * @warning This does not persist the configuration setting. Use elgg_save_config()
- *
- * @param string $name Name of the configuration value
- * @param mixed $value Value
- *
- * @return void
- * @since 1.8.0
- */
- function elgg_set_config($name, $value) {
- return _elgg_services()->config->set($name, $value);
- }
- /**
- * Save a configuration setting
- *
- * @param string $name Configuration name (cannot be greater than 255 characters)
- * @param mixed $value Configuration value. Should be string for installation setting
- * @param int $site_guid null for installation setting, 0 for default site
- *
- * @return bool
- * @since 1.8.0
- */
- function elgg_save_config($name, $value, $site_guid = 0) {
- return _elgg_services()->config->save($name, $value, $site_guid);
- }
- /**
- * Get the value of a datalist element.
- *
- * Plugin authors should use elgg_get_config() and pass null for the site GUID.
- *
- * @internal Datalists are stored in the datalist table.
- *
- * @tip Use datalists to store information common to a full installation.
- *
- * @param string $name The name of the datalist
- * @return string|null|false String if value exists, null if doesn't, false on error
- * @access private
- */
- function datalist_get($name) {
- return _elgg_services()->datalist->get($name);
- }
- /**
- * Set the value for a datalist element.
- *
- * Plugin authors should use elgg_save_config() and pass null for the site GUID.
- *
- * @warning Names should be selected so as not to collide with the names for the
- * site config.
- *
- * @warning Values set through datalist_set() are not available in $CONFIG until
- * next page load.
- *
- * @param string $name The name of the datalist
- * @param string $value The new value
- *
- * @return bool
- * @access private
- */
- function datalist_set($name, $value) {
- return _elgg_services()->datalist->set($name, $value);
- }
- /**
- * Run a function one time per installation.
- *
- * If you pass a timestamp as the second argument, it will run the function
- * only if (i) it has never been run before or (ii) the timestamp is >=
- * the last time it was run.
- *
- * @warning Functions are determined by their name. If you change the name of a function
- * it will be run again.
- *
- * @tip Use $timelastupdatedcheck in your plugins init function to perform automated
- * upgrades. Schedule a function to run once and pass the timestamp of the new release.
- * This will cause the run once function to be run on all installations. To perform
- * additional upgrades, create new functions for each release.
- *
- * @warning The function name cannot be longer than 255 characters long due to
- * the current schema for the datalist table.
- *
- * @internal A datalist entry $functioname is created with the value of time().
- *
- * @param string $functionname The name of the function you want to run.
- * @param int $timelastupdatedcheck A UNIX timestamp. If time() is > than this,
- * this function will be run again.
- *
- * @return bool
- * @todo deprecate
- */
- function run_function_once($functionname, $timelastupdatedcheck = 0) {
- return _elgg_services()->datalist->runFunctionOnce($functionname, $timelastupdatedcheck);
- }
- /**
- * Removes a config setting.
- *
- * @note Internal: These settings are stored in the dbprefix_config table and read
- * during system boot into $CONFIG.
- *
- * @param string $name The name of the field.
- * @param int $site_guid Optionally, the GUID of the site (default: current site).
- *
- * @return bool Success or failure
- *
- * @see get_config()
- * @see set_config()
- */
- function unset_config($name, $site_guid = 0) {
- return _elgg_services()->configTable->remove($name, $site_guid);
- }
- /**
- * Add or update a config setting.
- *
- * Plugin authors should use elgg_set_config().
- *
- * If the config name already exists, it will be updated to the new value.
- *
- * @warning Names should be selected so as not to collide with the names for the
- * datalist (application configuration)
- *
- * @internal These settings are stored in the dbprefix_config table and read
- * during system boot into $CONFIG.
- *
- * @internal The value is serialized so we maintain type information.
- *
- * @param string $name The name of the configuration value
- * @param mixed $value Its value
- * @param int $site_guid Optionally, the GUID of the site (current site is assumed by default)
- *
- * @return bool
- * @see unset_config()
- * @see get_config()
- * @access private
- */
- function set_config($name, $value, $site_guid = 0) {
- return _elgg_services()->configTable->set($name, $value, $site_guid);
- }
- /**
- * Gets a configuration value
- *
- * Plugin authors should use elgg_get_config().
- *
- * @internal These settings are stored in the dbprefix_config table and read
- * during system boot into $CONFIG.
- *
- * @param string $name The name of the config value
- * @param int $site_guid Optionally, the GUID of the site (default: current site)
- *
- * @return mixed|null
- * @see set_config()
- * @see unset_config()
- * @access private
- */
- function get_config($name, $site_guid = 0) {
- return _elgg_services()->configTable->get($name, $site_guid);
- }
- /**
- * Loads configuration related to this site
- *
- * This runs on engine boot and loads from the config database table and the
- * site entity. It runs after the application configuration is loaded by
- * _elgg_load_application_config().
- *
- * @see _elgg_engine_boot()
- *
- * @access private
- */
- function _elgg_load_site_config() {
- global $CONFIG;
- $CONFIG->site_guid = (int) datalist_get('default_site');
- $CONFIG->site_id = $CONFIG->site_guid;
- $CONFIG->site = _elgg_services()->entityTable->get($CONFIG->site_guid, 'site');
- if (!$CONFIG->site) {
- throw new \InstallationException("Unable to handle this request. This site is not configured or the database is down.");
- }
- $CONFIG->wwwroot = $CONFIG->site->url;
- $CONFIG->sitename = $CONFIG->site->name;
- $CONFIG->sitedescription = $CONFIG->site->description;
- $CONFIG->siteemail = $CONFIG->site->email;
- $CONFIG->url = $CONFIG->wwwroot;
- _elgg_services()->configTable->loadAll();
- // gives hint to elgg_get_config function how to approach missing values
- $CONFIG->site_config_loaded = true;
- if (!empty($CONFIG->debug)) {
- _elgg_services()->logger->setLevel($CONFIG->debug);
- _elgg_services()->logger->setDisplay(true);
- }
- }
- /**
- * Loads configuration related to Elgg as an application
- *
- * This runs on the engine boot and loads from the datalists database table.
- *
- * @see _elgg_engine_boot()
- *
- * @access private
- */
- function _elgg_load_application_config() {
- global $CONFIG;
- $install_root = str_replace("\\", "/", dirname(dirname(dirname(__FILE__))));
- $defaults = array(
- 'path' => "$install_root/",
- 'view_path' => "$install_root/views/",
- 'plugins_path' => "$install_root/mod/",
- 'language' => 'en',
- // compatibility with old names for plugins not using elgg_get_config()
- 'viewpath' => "$install_root/views/",
- 'pluginspath' => "$install_root/mod/",
- );
- foreach ($defaults as $name => $value) {
- if (empty($CONFIG->$name)) {
- $CONFIG->$name = $value;
- }
- }
- // set cookie values for session and remember me
- if (!isset($CONFIG->cookies)) {
- $CONFIG->cookies = array();
- }
- if (!isset($CONFIG->cookies['session'])) {
- $CONFIG->cookies['session'] = array();
- }
- $session_defaults = session_get_cookie_params();
- $session_defaults['name'] = 'Elgg';
- $CONFIG->cookies['session'] = array_merge($session_defaults, $CONFIG->cookies['session']);
- if (!isset($CONFIG->cookies['remember_me'])) {
- $CONFIG->cookies['remember_me'] = array();
- }
- $session_defaults['name'] = 'elggperm';
- $session_defaults['expire'] = strtotime("+30 days");
- $CONFIG->cookies['remember_me'] = array_merge($session_defaults, $CONFIG->cookies['remember_me']);
- if (!is_memcache_available()) {
- _elgg_services()->datalist->loadAll();
- }
- // allow sites to set dataroot and simplecache_enabled in settings.php
- if (isset($CONFIG->dataroot)) {
- $CONFIG->dataroot = sanitise_filepath($CONFIG->dataroot);
- $CONFIG->dataroot_in_settings = true;
- } else {
- $dataroot = datalist_get('dataroot');
- if (!empty($dataroot)) {
- $CONFIG->dataroot = $dataroot;
- }
- $CONFIG->dataroot_in_settings = false;
- }
- if (isset($CONFIG->simplecache_enabled)) {
- $CONFIG->simplecache_enabled_in_settings = true;
- } else {
- $simplecache_enabled = datalist_get('simplecache_enabled');
- if ($simplecache_enabled !== false) {
- $CONFIG->simplecache_enabled = $simplecache_enabled;
- } else {
- $CONFIG->simplecache_enabled = 1;
- }
- $CONFIG->simplecache_enabled_in_settings = false;
- }
- $system_cache_enabled = datalist_get('system_cache_enabled');
- if ($system_cache_enabled !== false) {
- $CONFIG->system_cache_enabled = $system_cache_enabled;
- } else {
- $CONFIG->system_cache_enabled = 1;
- }
- // needs to be set before system, init for links in html head
- $CONFIG->lastcache = (int)datalist_get("simplecache_lastupdate");
- $CONFIG->i18n_loaded_from_cache = false;
- // this must be synced with the enum for the entities table
- $CONFIG->entity_types = array('group', 'object', 'site', 'user');
- }
- /**
- * @access private
- */
- function _elgg_config_test($hook, $type, $tests) {
- global $CONFIG;
- $tests[] = "{$CONFIG->path}engine/tests/ElggCoreConfigTest.php";
- return $tests;
- }
- return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
- $hooks->registerHandler('unit_test', 'system', '_elgg_config_test');
- };
|