Elgg / Elgg

engine/classes/Elgg/Database/AccessCollections.php

Doc Comments +1 added lines, -1 removed lines

@@ -711,7 +711,7 @@
 	 * @see get_members_of_access_collection()
 	 *
 	 * @param int $collection_id The collection ID
-	 * @return \ElggAccessCollection|false
+	 * @return string
 	 */
 	public function get($collection_id) {
 

Indentation +823 added lines, -823 removed lines

@@ -23,171 +23,171 @@ 
  */
 class AccessCollections {
 
-	/**
-	 * @var Conf
-	 */
-	protected $config;
-
-	/**
-	 * @var Database
-	 */
-	protected $db;
-
-	/**
-	 * @vars \ElggStateVariableCache
-	 */
-	protected $access_cache;
-
-	/**
-	 * @var PluginHooksService
-	 */
-	protected $hooks;
-
-	/**
-	 * @var ElggSession
-	 */
-	protected $session;
-
-	/**
-	 * @var EntityTable
-	 */
-	protected $entities;
-
-	/**
-	 * @var Translator
-	 */
-	protected $translator;
-
-	/**
-	 * @var string
-	 */
-	protected $table;
-
-	/**
-	 * @var string
-	 */
-	protected $membership_table;
-
-	/**
-	 * @var bool
-	 */
-	protected $init_complete = false;
-
-	/**
-	 * Constructor
-	 *
-	 * @param Conf                    $config     Config
-	 * @param Database                $db         Database
-	 * @param EntityTable             $entities   Entity table
-	 * @param ElggStaticVariableCache $cache      Access cache
-	 * @param PluginHooksService      $hooks      Hooks
-	 * @param ElggSession             $session    Session
-	 * @param Translator              $translator Translator
-	 */
-	public function __construct(
-			Conf $config,
-			Database $db,
-			EntityTable $entities,
-			ElggStaticVariableCache $cache,
-			PluginHooksService $hooks,
-			ElggSession $session,
-			Translator $translator) {
-		$this->config = $config;
-		$this->db = $db;
-		$this->entities = $entities;
-		$this->access_cache = $cache;
-		$this->hooks = $hooks;
-		$this->session = $session;
-		$this->translator = $translator;
-
-		$this->table = "{$this->db->prefix}access_collections";
-		$this->membership_table = "{$this->db->prefix}access_collection_membership";
-	}
-
-	/**
-	 * Mark the access system as initialized
-	 *
-	 * @return void
-	 */
-	public function markInitComplete() {
-		$this->init_complete = true;
-	}
-
-	/**
-	 * Returns a string of access_ids for $user_guid appropriate for inserting into an SQL IN clause.
-	 *
-	 * @see get_access_array()
-	 *
-	 * @param int  $user_guid User ID; defaults to currently logged in user
-	 * @param bool $flush     If set to true, will refresh the access list from the
-	 *                        database rather than using this function's cache.
-	 *
-	 * @return string A concatenated string of access collections suitable for using in an SQL IN clause
-	 * @access private
-	 */
-	public function getAccessList($user_guid = 0, $flush = false) {
-		$access_array = $this->getAccessArray($user_guid, $flush);
-		$access_ids = implode(',', $access_array);
-		$list = "($access_ids)";
-
-		// for BC, populate the cache
-		$hash = $user_guid . 'get_access_list';
-		$this->access_cache->add($hash, $list);
-
-		return $list;
-	}
-
-	/**
-	 * Returns an array of access IDs a user is permitted to see.
-	 *
-	 * Can be overridden with the 'access:collections:read', 'user' plugin hook.
-	 * @warning A callback for that plugin hook needs to either not retrieve data
-	 * from the database that would use the access system (triggering the plugin again)
-	 * or ignore the second call. Otherwise, an infinite loop will be created.
-	 *
-	 * This returns a list of all the collection ids a user owns or belongs
-	 * to plus public and logged in access levels. If the user is an admin, it includes
-	 * the private access level.
-	 *
-	 * @internal this is only used in core for creating the SQL where clause when
-	 * retrieving content from the database. The friends access level is handled by
-	 * _elgg_get_access_where_sql().
-	 *
-	 * @see get_write_access_array() for the access levels that a user can write to.
-	 *
-	 * @param int  $user_guid User ID; defaults to currently logged in user
-	 * @param bool $flush     If set to true, will refresh the access ids from the
-	 *                        database rather than using this function's cache.
-	 *
-	 * @return array An array of access collections ids
-	 */
-	public function getAccessArray($user_guid = 0, $flush = false) {
-		$cache = $this->access_cache;
-
-		if ($flush) {
-			$cache->clear();
-		}
-
-		if ($user_guid == 0) {
-			$user_guid = $this->session->getLoggedInUserGuid();
-		}
-
-		$user_guid = (int) $user_guid;
-
-		$hash = $user_guid . 'get_access_array';
-
-		if ($cache[$hash]) {
-			$access_array = $cache[$hash];
-		} else {
-			// Public access is always visible
-			$access_array = [ACCESS_PUBLIC];
-
-			// The following can only return sensible data for a known user.
-			if ($user_guid) {
-				$access_array[] = ACCESS_LOGGED_IN;
-
-				// Get ACLs that user owns or is a member of
-				$query = "
+    /**
+     * @var Conf
+     */
+    protected $config;
+
+    /**
+     * @var Database
+     */
+    protected $db;
+
+    /**
+     * @vars \ElggStateVariableCache
+     */
+    protected $access_cache;
+
+    /**
+     * @var PluginHooksService
+     */
+    protected $hooks;
+
+    /**
+     * @var ElggSession
+     */
+    protected $session;
+
+    /**
+     * @var EntityTable
+     */
+    protected $entities;
+
+    /**
+     * @var Translator
+     */
+    protected $translator;
+
+    /**
+     * @var string
+     */
+    protected $table;
+
+    /**
+     * @var string
+     */
+    protected $membership_table;
+
+    /**
+     * @var bool
+     */
+    protected $init_complete = false;
+
+    /**
+     * Constructor
+     *
+     * @param Conf                    $config     Config
+     * @param Database                $db         Database
+     * @param EntityTable             $entities   Entity table
+     * @param ElggStaticVariableCache $cache      Access cache
+     * @param PluginHooksService      $hooks      Hooks
+     * @param ElggSession             $session    Session
+     * @param Translator              $translator Translator
+     */
+    public function __construct(
+            Conf $config,
+            Database $db,
+            EntityTable $entities,
+            ElggStaticVariableCache $cache,
+            PluginHooksService $hooks,
+            ElggSession $session,
+            Translator $translator) {
+        $this->config = $config;
+        $this->db = $db;
+        $this->entities = $entities;
+        $this->access_cache = $cache;
+        $this->hooks = $hooks;
+        $this->session = $session;
+        $this->translator = $translator;
+
+        $this->table = "{$this->db->prefix}access_collections";
+        $this->membership_table = "{$this->db->prefix}access_collection_membership";
+    }
+
+    /**
+     * Mark the access system as initialized
+     *
+     * @return void
+     */
+    public function markInitComplete() {
+        $this->init_complete = true;
+    }
+
+    /**
+     * Returns a string of access_ids for $user_guid appropriate for inserting into an SQL IN clause.
+     *
+     * @see get_access_array()
+     *
+     * @param int  $user_guid User ID; defaults to currently logged in user
+     * @param bool $flush     If set to true, will refresh the access list from the
+     *                        database rather than using this function's cache.
+     *
+     * @return string A concatenated string of access collections suitable for using in an SQL IN clause
+     * @access private
+     */
+    public function getAccessList($user_guid = 0, $flush = false) {
+        $access_array = $this->getAccessArray($user_guid, $flush);
+        $access_ids = implode(',', $access_array);
+        $list = "($access_ids)";
+
+        // for BC, populate the cache
+        $hash = $user_guid . 'get_access_list';
+        $this->access_cache->add($hash, $list);
+
+        return $list;
+    }
+
+    /**
+     * Returns an array of access IDs a user is permitted to see.
+     *
+     * Can be overridden with the 'access:collections:read', 'user' plugin hook.
+     * @warning A callback for that plugin hook needs to either not retrieve data
+     * from the database that would use the access system (triggering the plugin again)
+     * or ignore the second call. Otherwise, an infinite loop will be created.
+     *
+     * This returns a list of all the collection ids a user owns or belongs
+     * to plus public and logged in access levels. If the user is an admin, it includes
+     * the private access level.
+     *
+     * @internal this is only used in core for creating the SQL where clause when
+     * retrieving content from the database. The friends access level is handled by
+     * _elgg_get_access_where_sql().
+     *
+     * @see get_write_access_array() for the access levels that a user can write to.
+     *
+     * @param int  $user_guid User ID; defaults to currently logged in user
+     * @param bool $flush     If set to true, will refresh the access ids from the
+     *                        database rather than using this function's cache.
+     *
+     * @return array An array of access collections ids
+     */
+    public function getAccessArray($user_guid = 0, $flush = false) {
+        $cache = $this->access_cache;
+
+        if ($flush) {
+            $cache->clear();
+        }
+
+        if ($user_guid == 0) {
+            $user_guid = $this->session->getLoggedInUserGuid();
+        }
+
+        $user_guid = (int) $user_guid;
+
+        $hash = $user_guid . 'get_access_array';
+
+        if ($cache[$hash]) {
+            $access_array = $cache[$hash];
+        } else {
+            // Public access is always visible
+            $access_array = [ACCESS_PUBLIC];
+
+            // The following can only return sensible data for a known user.
+            if ($user_guid) {
+                $access_array[] = ACCESS_LOGGED_IN;
+
+                // Get ACLs that user owns or is a member of
+                $query = "
 					SELECT ac.id
 					FROM {$this->table} ac
 					WHERE ac.owner_guid = :user_guid
@@ -197,686 +197,686 @@ 
 							   AND user_guid = :user_guid)
 				";
 
-				$collections = $this->db->getData($query, null, [
-					':user_guid' => $user_guid,
-				]);
-
-				if ($collections) {
-					foreach ($collections as $collection) {
-						$access_array[] = (int) $collection->id;
-					}
-				}
-
-				$ignore_access = elgg_check_access_overrides($user_guid);
-
-				if ($ignore_access == true) {
-					$access_array[] = ACCESS_PRIVATE;
-				}
-			}
-
-			if ($this->init_complete) {
-				$cache[$hash] = $access_array;
-			}
-		}
-
-		$options = [
-			'user_id' => $user_guid,
-		];
-
-		// see the warning in the docs for this function about infinite loop potential
-		return $this->hooks->trigger('access:collections:read', 'user', $options, $access_array);
-	}
-
-	/**
-	 * Returns the SQL where clause for enforcing read access to data.
-	 *
-	 * Note that if this code is executed in privileged mode it will return (1=1).
-	 *
-	 * Otherwise it returns a where clause to retrieve the data that a user has
-	 * permission to read.
-	 *
-	 * Plugin authors can hook into the 'get_sql', 'access' plugin hook to modify,
-	 * remove, or add to the where clauses. The plugin hook will pass an array with the current
-	 * ors and ands to the function in the form:
-	 *  array(
-	 *      'ors' => array(),
-	 *      'ands' => array()
-	 *  )
-	 *
-	 * The results will be combined into an SQL where clause in the form:
-	 *  ((or1 OR or2 OR orN) AND (and1 AND and2 AND andN))
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * 	table_alias => STR Optional table alias. This is based on the select and join clauses.
-	 *                     Default is 'e'.
-	 *
-	 *  user_guid => INT Optional GUID for the user that we are retrieving data for.
-	 *                   Defaults to the logged in user if null.
-	 *                   Passing 0 will build a query for a logged out user (even if there is a logged in user)
-	 *
-	 *  use_enabled_clause => BOOL Optional. Should we append the enabled clause? The default
-	 *                             is set by access_show_hidden_entities().
-	 *
-	 *  access_column => STR Optional access column name. Default is 'access_id'.
-	 *
-	 *  owner_guid_column => STR Optional owner_guid column. Default is 'owner_guid'.
-	 *
-	 *  guid_column => STR Optional guid_column. Default is 'guid'.
-	 *
-	 * @return string
-	 * @access private
-	 */
-	public function getWhereSql(array $options = []) {
-
-		$defaults = [
-			'table_alias' => 'e',
-			'user_guid' => $this->session->getLoggedInUserGuid(),
-			'use_enabled_clause' => !access_get_show_hidden_status(),
-			'access_column' => 'access_id',
-			'owner_guid_column' => 'owner_guid',
-			'guid_column' => 'guid',
-		];
-
-		foreach ($options as $key => $value) {
-			if (is_null($value)) {
-				// remove null values so we don't loose defaults in array_merge
-				unset($options[$key]);
-			}
-		}
-
-		$options = array_merge($defaults, $options);
-
-		// just in case someone passes a . at the end
-		$options['table_alias'] = rtrim($options['table_alias'], '.');
-
-		foreach (['table_alias', 'access_column', 'owner_guid_column', 'guid_column'] as $key) {
-			$options[$key] = sanitize_string($options[$key]);
-		}
-		$options['user_guid'] = sanitize_int($options['user_guid'], false);
-
-		// only add dot if we have an alias or table name
-		$table_alias = $options['table_alias'] ? $options['table_alias'] . '.' : '';
-
-		if (!isset($options['ignore_access'])) {
-			$options['ignore_access'] = elgg_check_access_overrides($options['user_guid']);
-		}
-
-		$clauses = [
-			'ors' => [],
-			'ands' => []
-		];
-
-		$prefix = $this->db->prefix;
-
-		if ($options['ignore_access']) {
-			$clauses['ors']['ignore_access'] = '1 = 1';
-		} else if ($options['user_guid']) {
-			// include content of user's friends
-			$clauses['ors']['friends_access'] = "$table_alias{$options['access_column']} = " . ACCESS_FRIENDS . "
+                $collections = $this->db->getData($query, null, [
+                    ':user_guid' => $user_guid,
+                ]);
+
+                if ($collections) {
+                    foreach ($collections as $collection) {
+                        $access_array[] = (int) $collection->id;
+                    }
+                }
+
+                $ignore_access = elgg_check_access_overrides($user_guid);
+
+                if ($ignore_access == true) {
+                    $access_array[] = ACCESS_PRIVATE;
+                }
+            }
+
+            if ($this->init_complete) {
+                $cache[$hash] = $access_array;
+            }
+        }
+
+        $options = [
+            'user_id' => $user_guid,
+        ];
+
+        // see the warning in the docs for this function about infinite loop potential
+        return $this->hooks->trigger('access:collections:read', 'user', $options, $access_array);
+    }
+
+    /**
+     * Returns the SQL where clause for enforcing read access to data.
+     *
+     * Note that if this code is executed in privileged mode it will return (1=1).
+     *
+     * Otherwise it returns a where clause to retrieve the data that a user has
+     * permission to read.
+     *
+     * Plugin authors can hook into the 'get_sql', 'access' plugin hook to modify,
+     * remove, or add to the where clauses. The plugin hook will pass an array with the current
+     * ors and ands to the function in the form:
+     *  array(
+     *      'ors' => array(),
+     *      'ands' => array()
+     *  )
+     *
+     * The results will be combined into an SQL where clause in the form:
+     *  ((or1 OR or2 OR orN) AND (and1 AND and2 AND andN))
+     *
+     * @param array $options Array in format:
+     *
+     * 	table_alias => STR Optional table alias. This is based on the select and join clauses.
+     *                     Default is 'e'.
+     *
+     *  user_guid => INT Optional GUID for the user that we are retrieving data for.
+     *                   Defaults to the logged in user if null.
+     *                   Passing 0 will build a query for a logged out user (even if there is a logged in user)
+     *
+     *  use_enabled_clause => BOOL Optional. Should we append the enabled clause? The default
+     *                             is set by access_show_hidden_entities().
+     *
+     *  access_column => STR Optional access column name. Default is 'access_id'.
+     *
+     *  owner_guid_column => STR Optional owner_guid column. Default is 'owner_guid'.
+     *
+     *  guid_column => STR Optional guid_column. Default is 'guid'.
+     *
+     * @return string
+     * @access private
+     */
+    public function getWhereSql(array $options = []) {
+
+        $defaults = [
+            'table_alias' => 'e',
+            'user_guid' => $this->session->getLoggedInUserGuid(),
+            'use_enabled_clause' => !access_get_show_hidden_status(),
+            'access_column' => 'access_id',
+            'owner_guid_column' => 'owner_guid',
+            'guid_column' => 'guid',
+        ];
+
+        foreach ($options as $key => $value) {
+            if (is_null($value)) {
+                // remove null values so we don't loose defaults in array_merge
+                unset($options[$key]);
+            }
+        }
+
+        $options = array_merge($defaults, $options);
+
+        // just in case someone passes a . at the end
+        $options['table_alias'] = rtrim($options['table_alias'], '.');
+
+        foreach (['table_alias', 'access_column', 'owner_guid_column', 'guid_column'] as $key) {
+            $options[$key] = sanitize_string($options[$key]);
+        }
+        $options['user_guid'] = sanitize_int($options['user_guid'], false);
+
+        // only add dot if we have an alias or table name
+        $table_alias = $options['table_alias'] ? $options['table_alias'] . '.' : '';
+
+        if (!isset($options['ignore_access'])) {
+            $options['ignore_access'] = elgg_check_access_overrides($options['user_guid']);
+        }
+
+        $clauses = [
+            'ors' => [],
+            'ands' => []
+        ];
+
+        $prefix = $this->db->prefix;
+
+        if ($options['ignore_access']) {
+            $clauses['ors']['ignore_access'] = '1 = 1';
+        } else if ($options['user_guid']) {
+            // include content of user's friends
+            $clauses['ors']['friends_access'] = "$table_alias{$options['access_column']} = " . ACCESS_FRIENDS . "
 				AND $table_alias{$options['owner_guid_column']} IN (
 					SELECT guid_one FROM {$prefix}entity_relationships
 					WHERE relationship = 'friend' AND guid_two = {$options['user_guid']}
 				)";
 
-			// include user's content
-			$clauses['ors']['owner_access'] = "$table_alias{$options['owner_guid_column']} = {$options['user_guid']}";
-		}
-
-		// include standard accesses (public, logged in, access collections)
-		if (!$options['ignore_access']) {
-			$access_list = $this->getAccessList($options['user_guid']);
-			$clauses['ors']['acl_access'] = "$table_alias{$options['access_column']} IN {$access_list}";
-		}
-
-		if ($options['use_enabled_clause']) {
-			$clauses['ands']['use_enabled'] = "{$table_alias}enabled = 'yes'";
-		}
-
-		$clauses = $this->hooks->trigger('get_sql', 'access', $options, $clauses);
-
-		$clauses_str = '';
-		if (is_array($clauses['ors']) && $clauses['ors']) {
-			$clauses_str = '(' . implode(' OR ', $clauses['ors']) . ')';
-		}
-
-		if (is_array($clauses['ands']) && $clauses['ands']) {
-			if ($clauses_str) {
-				$clauses_str .= ' AND ';
-			}
-			$clauses_str .= '(' . implode(' AND ', $clauses['ands']) . ')';
-		}
-
-		return "($clauses_str)";
-	}
-
-	/**
-	 * Can a user access an entity.
-	 *
-	 * @warning If a logged in user doesn't have access to an entity, the
-	 * core engine will not load that entity.
-	 *
-	 * @tip This is mostly useful for checking if a user other than the logged in
-	 * user has access to an entity that is currently loaded.
-	 *
-	 * @todo This function would be much more useful if we could pass the guid of the
-	 * entity to test access for. We need to be able to tell whether the entity exists
-	 * and whether the user has access to the entity.
-	 *
-	 * @param ElggEntity $entity The entity to check access for.
-	 * @param ElggUser   $user   Optionally user to check access for. Defaults to
-	 *                           logged in user (which is a useless default).
-	 *
-	 * @return bool
-	 */
-	public function hasAccessToEntity($entity, $user = null) {
-		if (!$entity instanceof \ElggEntity) {
-			return false;
-		}
-
-		if ($entity->access_id == ACCESS_PUBLIC) {
-			// Public entities are always accessible
-			return true;
-		}
-
-		$user_guid = isset($user) ? (int) $user->guid : elgg_get_logged_in_user_guid();
-
-		if ($user_guid && $user_guid == $entity->owner_guid) {
-			// Owners have access to their own content
-			return true;
-		}
-
-		if ($user_guid && $entity->access_id == ACCESS_LOGGED_IN) {
-			// Existing users have access to entities with logged in access
-			return true;
-		}
-
-		// See #7159. Must not allow ignore access to affect query
-		$ia = elgg_set_ignore_access(false);
+            // include user's content
+            $clauses['ors']['owner_access'] = "$table_alias{$options['owner_guid_column']} = {$options['user_guid']}";
+        }
+
+        // include standard accesses (public, logged in, access collections)
+        if (!$options['ignore_access']) {
+            $access_list = $this->getAccessList($options['user_guid']);
+            $clauses['ors']['acl_access'] = "$table_alias{$options['access_column']} IN {$access_list}";
+        }
+
+        if ($options['use_enabled_clause']) {
+            $clauses['ands']['use_enabled'] = "{$table_alias}enabled = 'yes'";
+        }
+
+        $clauses = $this->hooks->trigger('get_sql', 'access', $options, $clauses);
+
+        $clauses_str = '';
+        if (is_array($clauses['ors']) && $clauses['ors']) {
+            $clauses_str = '(' . implode(' OR ', $clauses['ors']) . ')';
+        }
+
+        if (is_array($clauses['ands']) && $clauses['ands']) {
+            if ($clauses_str) {
+                $clauses_str .= ' AND ';
+            }
+            $clauses_str .= '(' . implode(' AND ', $clauses['ands']) . ')';
+        }
+
+        return "($clauses_str)";
+    }
+
+    /**
+     * Can a user access an entity.
+     *
+     * @warning If a logged in user doesn't have access to an entity, the
+     * core engine will not load that entity.
+     *
+     * @tip This is mostly useful for checking if a user other than the logged in
+     * user has access to an entity that is currently loaded.
+     *
+     * @todo This function would be much more useful if we could pass the guid of the
+     * entity to test access for. We need to be able to tell whether the entity exists
+     * and whether the user has access to the entity.
+     *
+     * @param ElggEntity $entity The entity to check access for.
+     * @param ElggUser   $user   Optionally user to check access for. Defaults to
+     *                           logged in user (which is a useless default).
+     *
+     * @return bool
+     */
+    public function hasAccessToEntity($entity, $user = null) {
+        if (!$entity instanceof \ElggEntity) {
+            return false;
+        }
+
+        if ($entity->access_id == ACCESS_PUBLIC) {
+            // Public entities are always accessible
+            return true;
+        }
+
+        $user_guid = isset($user) ? (int) $user->guid : elgg_get_logged_in_user_guid();
+
+        if ($user_guid && $user_guid == $entity->owner_guid) {
+            // Owners have access to their own content
+            return true;
+        }
+
+        if ($user_guid && $entity->access_id == ACCESS_LOGGED_IN) {
+            // Existing users have access to entities with logged in access
+            return true;
+        }
+
+        // See #7159. Must not allow ignore access to affect query
+        $ia = elgg_set_ignore_access(false);
 		
-		$row = $this->entities->getRow($entity->guid, $user_guid);
-
-		elgg_set_ignore_access($ia);
-
-		return !empty($row);
-	}
-
-	/**
-	 * Returns an array of access permissions that the user is allowed to save content with.
-	 * Permissions returned are of the form (id => 'name').
-	 *
-	 * Example return value in English:
-	 * array(
-	 *     0 => 'Private',
-	 *    -2 => 'Friends',
-	 *     1 => 'Logged in users',
-	 *     2 => 'Public',
-	 *    34 => 'My favorite friends',
-	 * );
-	 *
-	 * Plugin hook of 'access:collections:write', 'user'
-	 *
-	 * @warning this only returns access collections that the user owns plus the
-	 * standard access levels. It does not return access collections that the user
-	 * belongs to such as the access collection for a group.
-	 *
-	 * @param int   $user_guid    The user's GUID.
-	 * @param bool  $flush        If this is set to true, this will ignore a cached access array
-	 * @param array $input_params Some parameters passed into an input/access view
-	 *
-	 * @return array List of access permissions
-	 */
-	public function getWriteAccessArray($user_guid = 0, $flush = false, array $input_params = []) {
-		$cache = $this->access_cache;
-
-		if ($flush) {
-			$cache->clear();
-		}
-
-		if ($user_guid == 0) {
-			$user_guid = $this->session->getLoggedInUserGuid();
-		}
-
-		$user_guid = (int) $user_guid;
-
-		$hash = $user_guid . 'get_write_access_array';
-
-		if ($cache[$hash]) {
-			$access_array = $cache[$hash];
-		} else {
-			// @todo is there such a thing as public write access?
-			$access_array = [
-				ACCESS_PRIVATE => $this->getReadableAccessLevel(ACCESS_PRIVATE),
-				ACCESS_LOGGED_IN => $this->getReadableAccessLevel(ACCESS_LOGGED_IN),
-				ACCESS_PUBLIC => $this->getReadableAccessLevel(ACCESS_PUBLIC)
-			];
-
-			$collections = $this->getEntityCollections($user_guid);
-			if ($collections) {
-				foreach ($collections as $collection) {
-					$access_array[$collection->id] = $collection->name;
-				}
-			}
-
-			if ($this->init_complete) {
-				$cache[$hash] = $access_array;
-			}
-		}
-
-		$options = [
-			'user_id' => $user_guid,
-			'input_params' => $input_params,
-		];
-		return $this->hooks->trigger('access:collections:write', 'user', $options, $access_array);
-	}
-
-	/**
-	 * Can the user change this access collection?
-	 *
-	 * Use the plugin hook of 'access:collections:write', 'user' to change this.
-	 * @see get_write_access_array() for details on the hook.
-	 *
-	 * Respects access control disabling for admin users and {@link elgg_set_ignore_access()}
-	 *
-	 * @see get_write_access_array()
-	 *
-	 * @param int   $collection_id The collection id
-	 * @param mixed $user_guid     The user GUID to check for. Defaults to logged in user.
-	 * @return bool
-	 */
-	public function canEdit($collection_id, $user_guid = null) {
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$collection = $this->get($collection_id);
-
-		if (!$user || !$collection) {
-			return false;
-		}
-
-		if (elgg_check_access_overrides($user->guid)) {
-			return true;
-		}
-
-		$write_access = $this->getWriteAccessArray($user->guid, true);
-		return array_key_exists($collection_id, $write_access);
-	}
-
-	/**
-	 * Creates a new access collection.
-	 *
-	 * Access colletions allow plugins and users to create granular access
-	 * for entities.
-	 *
-	 * Triggers plugin hook 'access:collections:addcollection', 'collection'
-	 *
-	 * @internal Access collections are stored in the access_collections table.
-	 * Memberships to collections are in access_collections_membership.
-	 *
-	 * @param string $name       The name of the collection.
-	 * @param int    $owner_guid The GUID of the owner (default: currently logged in user).
-	 *
-	 * @return int|false The collection ID if successful and false on failure.
-	 */
-	public function create($name, $owner_guid = 0) {
-		$name = trim($name);
-		if (empty($name)) {
-			return false;
-		}
-
-		if ($owner_guid == 0) {
-			$owner_guid = $this->session->getLoggedInUserGuid();
-		}
-
-		$query = "
+        $row = $this->entities->getRow($entity->guid, $user_guid);
+
+        elgg_set_ignore_access($ia);
+
+        return !empty($row);
+    }
+
+    /**
+     * Returns an array of access permissions that the user is allowed to save content with.
+     * Permissions returned are of the form (id => 'name').
+     *
+     * Example return value in English:
+     * array(
+     *     0 => 'Private',
+     *    -2 => 'Friends',
+     *     1 => 'Logged in users',
+     *     2 => 'Public',
+     *    34 => 'My favorite friends',
+     * );
+     *
+     * Plugin hook of 'access:collections:write', 'user'
+     *
+     * @warning this only returns access collections that the user owns plus the
+     * standard access levels. It does not return access collections that the user
+     * belongs to such as the access collection for a group.
+     *
+     * @param int   $user_guid    The user's GUID.
+     * @param bool  $flush        If this is set to true, this will ignore a cached access array
+     * @param array $input_params Some parameters passed into an input/access view
+     *
+     * @return array List of access permissions
+     */
+    public function getWriteAccessArray($user_guid = 0, $flush = false, array $input_params = []) {
+        $cache = $this->access_cache;
+
+        if ($flush) {
+            $cache->clear();
+        }
+
+        if ($user_guid == 0) {
+            $user_guid = $this->session->getLoggedInUserGuid();
+        }
+
+        $user_guid = (int) $user_guid;
+
+        $hash = $user_guid . 'get_write_access_array';
+
+        if ($cache[$hash]) {
+            $access_array = $cache[$hash];
+        } else {
+            // @todo is there such a thing as public write access?
+            $access_array = [
+                ACCESS_PRIVATE => $this->getReadableAccessLevel(ACCESS_PRIVATE),
+                ACCESS_LOGGED_IN => $this->getReadableAccessLevel(ACCESS_LOGGED_IN),
+                ACCESS_PUBLIC => $this->getReadableAccessLevel(ACCESS_PUBLIC)
+            ];
+
+            $collections = $this->getEntityCollections($user_guid);
+            if ($collections) {
+                foreach ($collections as $collection) {
+                    $access_array[$collection->id] = $collection->name;
+                }
+            }
+
+            if ($this->init_complete) {
+                $cache[$hash] = $access_array;
+            }
+        }
+
+        $options = [
+            'user_id' => $user_guid,
+            'input_params' => $input_params,
+        ];
+        return $this->hooks->trigger('access:collections:write', 'user', $options, $access_array);
+    }
+
+    /**
+     * Can the user change this access collection?
+     *
+     * Use the plugin hook of 'access:collections:write', 'user' to change this.
+     * @see get_write_access_array() for details on the hook.
+     *
+     * Respects access control disabling for admin users and {@link elgg_set_ignore_access()}
+     *
+     * @see get_write_access_array()
+     *
+     * @param int   $collection_id The collection id
+     * @param mixed $user_guid     The user GUID to check for. Defaults to logged in user.
+     * @return bool
+     */
+    public function canEdit($collection_id, $user_guid = null) {
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $collection = $this->get($collection_id);
+
+        if (!$user || !$collection) {
+            return false;
+        }
+
+        if (elgg_check_access_overrides($user->guid)) {
+            return true;
+        }
+
+        $write_access = $this->getWriteAccessArray($user->guid, true);
+        return array_key_exists($collection_id, $write_access);
+    }
+
+    /**
+     * Creates a new access collection.
+     *
+     * Access colletions allow plugins and users to create granular access
+     * for entities.
+     *
+     * Triggers plugin hook 'access:collections:addcollection', 'collection'
+     *
+     * @internal Access collections are stored in the access_collections table.
+     * Memberships to collections are in access_collections_membership.
+     *
+     * @param string $name       The name of the collection.
+     * @param int    $owner_guid The GUID of the owner (default: currently logged in user).
+     *
+     * @return int|false The collection ID if successful and false on failure.
+     */
+    public function create($name, $owner_guid = 0) {
+        $name = trim($name);
+        if (empty($name)) {
+            return false;
+        }
+
+        if ($owner_guid == 0) {
+            $owner_guid = $this->session->getLoggedInUserGuid();
+        }
+
+        $query = "
 			INSERT INTO {$this->table}
 			SET name = :name,
 				owner_guid = :owner_guid
 		";
 
-		$params = [
-			':name' => $name,
-			':owner_guid' => (int) $owner_guid,
-		];
-
-		$id = $this->db->insertData($query, $params);
-		if (!$id) {
-			return false;
-		}
-
-		$this->access_cache->clear();
-
-		$hook_params = [
-			'collection_id' => $id,
-			'name' => $name,
-			'owner_guid' => $owner_guid,
-		];
-
-		if (!$this->hooks->trigger('access:collections:addcollection', 'collection', $hook_params, true)) {
-			$this->delete($id);
-			return false;
-		}
-
-		return $id;
-	}
-
-	/**
-	 * Renames an access collection
-	 *
-	 * @param int    $collection_id ID of the collection
-	 * @param string $name          The name of the collection
-	 * @return bool
-	 */
-	public function rename($collection_id, $name) {
-
-		$query = "
+        $params = [
+            ':name' => $name,
+            ':owner_guid' => (int) $owner_guid,
+        ];
+
+        $id = $this->db->insertData($query, $params);
+        if (!$id) {
+            return false;
+        }
+
+        $this->access_cache->clear();
+
+        $hook_params = [
+            'collection_id' => $id,
+            'name' => $name,
+            'owner_guid' => $owner_guid,
+        ];
+
+        if (!$this->hooks->trigger('access:collections:addcollection', 'collection', $hook_params, true)) {
+            $this->delete($id);
+            return false;
+        }
+
+        return $id;
+    }
+
+    /**
+     * Renames an access collection
+     *
+     * @param int    $collection_id ID of the collection
+     * @param string $name          The name of the collection
+     * @return bool
+     */
+    public function rename($collection_id, $name) {
+
+        $query = "
 			UPDATE {$this->table}
 			SET name = :name
 			WHERE id = :id
 		";
 
-		$params = [
-			':name' => $name,
-			':id' => (int) $collection_id,
-		];
-
-		if ($this->db->insertData($query, $params)) {
-			$this->access_cache->clear();
-			return (int) $collection_id;
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * Updates the membership in an access collection.
-	 *
-	 * @warning Expects a full list of all members that should
-	 * be part of the access collection
-	 *
-	 * @note This will run all hooks associated with adding or removing
-	 * members to access collections.
-	 *
-	 * @param int   $collection_id ID of the collection.
-	 * @param array $new_members   Array of member entities or GUIDs
-	 * @return bool
-	 */
-	public function update($collection_id, array $new_members = []) {
-		$acl = $this->get($collection_id);
-
-		if (!$acl) {
-			return false;
-		}
+        $params = [
+            ':name' => $name,
+            ':id' => (int) $collection_id,
+        ];
+
+        if ($this->db->insertData($query, $params)) {
+            $this->access_cache->clear();
+            return (int) $collection_id;
+        }
+
+        return false;
+    }
+
+
+    /**
+     * Updates the membership in an access collection.
+     *
+     * @warning Expects a full list of all members that should
+     * be part of the access collection
+     *
+     * @note This will run all hooks associated with adding or removing
+     * members to access collections.
+     *
+     * @param int   $collection_id ID of the collection.
+     * @param array $new_members   Array of member entities or GUIDs
+     * @return bool
+     */
+    public function update($collection_id, array $new_members = []) {
+        $acl = $this->get($collection_id);
+
+        if (!$acl) {
+            return false;
+        }
 		
-		$to_guid = function($elem) {
-			if (empty($elem)) {
-				return 0;
-			}
-			if (is_object($elem)) {
-				return (int) $elem->guid;
-			}
-			return (int) $elem;
-		};
+        $to_guid = function($elem) {
+            if (empty($elem)) {
+                return 0;
+            }
+            if (is_object($elem)) {
+                return (int) $elem->guid;
+            }
+            return (int) $elem;
+        };
 		
-		$current_members = [];
-		$new_members = array_map($to_guid, $new_members);
+        $current_members = [];
+        $new_members = array_map($to_guid, $new_members);
 
-		$current_members_batch = $this->getMembers($collection_id, [
-			'batch' => true,
-			'limit' => 0,
-			'callback' => false,
-		]);
+        $current_members_batch = $this->getMembers($collection_id, [
+            'batch' => true,
+            'limit' => 0,
+            'callback' => false,
+        ]);
 
-		foreach ($current_members_batch as $row) {
-			$current_members[] = $to_guid($row);
-		}
+        foreach ($current_members_batch as $row) {
+            $current_members[] = $to_guid($row);
+        }
 
-		$remove_members = array_diff($current_members, $new_members);
-		$add_members = array_diff($new_members, $current_members);
+        $remove_members = array_diff($current_members, $new_members);
+        $add_members = array_diff($new_members, $current_members);
 
-		$result = true;
+        $result = true;
 
-		foreach ($add_members as $guid) {
-			$result = $result && $this->addUser($guid, $collection_id);
-		}
+        foreach ($add_members as $guid) {
+            $result = $result && $this->addUser($guid, $collection_id);
+        }
 
-		foreach ($remove_members as $guid) {
-			$result = $result && $this->removeUser($guid, $collection_id);
-		}
+        foreach ($remove_members as $guid) {
+            $result = $result && $this->removeUser($guid, $collection_id);
+        }
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * Deletes a collection and its membership information
-	 *
-	 * @param int $collection_id ID of the collection
-	 * @return bool
-	 */
-	public function delete($collection_id) {
-		$collection_id = (int) $collection_id;
+    /**
+     * Deletes a collection and its membership information
+     *
+     * @param int $collection_id ID of the collection
+     * @return bool
+     */
+    public function delete($collection_id) {
+        $collection_id = (int) $collection_id;
 
-		$params = [
-			'collection_id' => $collection_id,
-		];
+        $params = [
+            'collection_id' => $collection_id,
+        ];
 
-		if (!$this->hooks->trigger('access:collections:deletecollection', 'collection', $params, true)) {
-			return false;
-		}
+        if (!$this->hooks->trigger('access:collections:deletecollection', 'collection', $params, true)) {
+            return false;
+        }
 
-		// Deleting membership doesn't affect result of deleting ACL.
-		$query = "
+        // Deleting membership doesn't affect result of deleting ACL.
+        $query = "
 			DELETE FROM {$this->membership_table}
 			WHERE access_collection_id = :access_collection_id
 		";
-		$this->db->deleteData($query, [
-			':access_collection_id' => $collection_id,
-		]);
+        $this->db->deleteData($query, [
+            ':access_collection_id' => $collection_id,
+        ]);
 
-		$query = "
+        $query = "
 			DELETE FROM {$this->table}
 			WHERE id = :id
 		";
-		$result = $this->db->deleteData($query, [
-			':id' => $collection_id,
-		]);
+        $result = $this->db->deleteData($query, [
+            ':id' => $collection_id,
+        ]);
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 		
-		return (bool) $result;
-	}
-
-	/**
-	 * Transforms a database row to an instance of ElggAccessCollection
-	 *
-	 * @param \stdClass $row Database row
-	 * @return \ElggAccessCollection
-	 */
-	public function rowToElggAccessCollection(\stdClass $row) {
-		return new \ElggAccessCollection($row);
-	}
-
-	/**
-	 * Get a specified access collection
-	 *
-	 * @note This doesn't return the members of an access collection,
-	 * just the database row of the actual collection.
-	 *
-	 * @see get_members_of_access_collection()
-	 *
-	 * @param int $collection_id The collection ID
-	 * @return \ElggAccessCollection|false
-	 */
-	public function get($collection_id) {
-
-		$callback = [$this, 'rowToElggAccessCollection'];
-
-		$query = "
+        return (bool) $result;
+    }
+
+    /**
+     * Transforms a database row to an instance of ElggAccessCollection
+     *
+     * @param \stdClass $row Database row
+     * @return \ElggAccessCollection
+     */
+    public function rowToElggAccessCollection(\stdClass $row) {
+        return new \ElggAccessCollection($row);
+    }
+
+    /**
+     * Get a specified access collection
+     *
+     * @note This doesn't return the members of an access collection,
+     * just the database row of the actual collection.
+     *
+     * @see get_members_of_access_collection()
+     *
+     * @param int $collection_id The collection ID
+     * @return \ElggAccessCollection|false
+     */
+    public function get($collection_id) {
+
+        $callback = [$this, 'rowToElggAccessCollection'];
+
+        $query = "
 			SELECT * FROM {$this->table}
 			WHERE id = :id
 		";
 
-		return $this->db->getDataRow($query, $callback, [
-			':id' => (int) $collection_id,
-		]);
-	}
-
-	/**
-	 * Check if user is already in the collection
-	 *
-	 * @param int $user_guid     GUID of the user
-	 * @param int $collection_id ID of the collection
-	 * @return bool
-	 */
-	public function hasUser($user_guid, $collection_id) {
-		$options = [
-			'guids' => (int) $user_guid,
-			'count' => true,
-		];
-		return (bool) $this->getMembers($collection_id, $options);
-	}
-
-	/**
-	 * Adds a user to an access collection.
-	 *
-	 * Triggers the 'access:collections:add_user', 'collection' plugin hook.
-	 *
-	 * @param int $user_guid     GUID of the user to add
-	 * @param int $collection_id ID of the collection to add them to
-	 * @return bool
-	 */
-	public function addUser($user_guid, $collection_id) {
-
-		$collection = $this->get($collection_id);
-
-		if (!$collection) {
-			return false;
-		}
-
-		if (!$this->entities->exists($user_guid)) {
-			return false;
-		}
-
-		$hook_params = [
-			'collection_id' => $collection->id,
-			'user_guid' => (int) $user_guid
-		];
-
-		$result = $this->hooks->trigger('access:collections:add_user', 'collection', $hook_params, true);
-		if ($result == false) {
-			return false;
-		}
-
-		// if someone tries to insert the same data twice, we do a no-op on duplicate key
-		$query = "
+        return $this->db->getDataRow($query, $callback, [
+            ':id' => (int) $collection_id,
+        ]);
+    }
+
+    /**
+     * Check if user is already in the collection
+     *
+     * @param int $user_guid     GUID of the user
+     * @param int $collection_id ID of the collection
+     * @return bool
+     */
+    public function hasUser($user_guid, $collection_id) {
+        $options = [
+            'guids' => (int) $user_guid,
+            'count' => true,
+        ];
+        return (bool) $this->getMembers($collection_id, $options);
+    }
+
+    /**
+     * Adds a user to an access collection.
+     *
+     * Triggers the 'access:collections:add_user', 'collection' plugin hook.
+     *
+     * @param int $user_guid     GUID of the user to add
+     * @param int $collection_id ID of the collection to add them to
+     * @return bool
+     */
+    public function addUser($user_guid, $collection_id) {
+
+        $collection = $this->get($collection_id);
+
+        if (!$collection) {
+            return false;
+        }
+
+        if (!$this->entities->exists($user_guid)) {
+            return false;
+        }
+
+        $hook_params = [
+            'collection_id' => $collection->id,
+            'user_guid' => (int) $user_guid
+        ];
+
+        $result = $this->hooks->trigger('access:collections:add_user', 'collection', $hook_params, true);
+        if ($result == false) {
+            return false;
+        }
+
+        // if someone tries to insert the same data twice, we do a no-op on duplicate key
+        $query = "
 			INSERT INTO {$this->membership_table}
 				SET access_collection_id = :access_collection_id,
 				    user_guid = :user_guid
 				ON DUPLICATE KEY UPDATE user_guid = user_guid
 		";
 
-		$result = $this->db->insertData($query, [
-			':access_collection_id' => (int) $collection->id,
-			':user_guid' => (int) $user_guid,
-		]);
+        $result = $this->db->insertData($query, [
+            ':access_collection_id' => (int) $collection->id,
+            ':user_guid' => (int) $user_guid,
+        ]);
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 		
-		return $result !== false;
-	}
-
-	/**
-	 * Removes a user from an access collection.
-	 *
-	 * Triggers the 'access:collections:remove_user', 'collection' plugin hook.
-	 *
-	 * @param int $user_guid     GUID of the user
-	 * @param int $collection_id ID of the collection
-	 * @return bool
-	 */
-	public function removeUser($user_guid, $collection_id) {
-
-		$params = [
-			'collection_id' => (int) $collection_id,
-			'user_guid' => (int) $user_guid,
-		];
-
-		if (!$this->hooks->trigger('access:collections:remove_user', 'collection', $params, true)) {
-			return false;
-		}
-
-		$query = "
+        return $result !== false;
+    }
+
+    /**
+     * Removes a user from an access collection.
+     *
+     * Triggers the 'access:collections:remove_user', 'collection' plugin hook.
+     *
+     * @param int $user_guid     GUID of the user
+     * @param int $collection_id ID of the collection
+     * @return bool
+     */
+    public function removeUser($user_guid, $collection_id) {
+
+        $params = [
+            'collection_id' => (int) $collection_id,
+            'user_guid' => (int) $user_guid,
+        ];
+
+        if (!$this->hooks->trigger('access:collections:remove_user', 'collection', $params, true)) {
+            return false;
+        }
+
+        $query = "
 			DELETE FROM {$this->membership_table}
 			WHERE access_collection_id = :access_collection_id
 				AND user_guid = :user_guid
 		";
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 
-		return (bool) $this->db->deleteData($query, [
-			':access_collection_id' => (int) $collection_id,
-			':user_guid' => (int) $user_guid,
-		]);
-	}
+        return (bool) $this->db->deleteData($query, [
+            ':access_collection_id' => (int) $collection_id,
+            ':user_guid' => (int) $user_guid,
+        ]);
+    }
 
-	/**
-	 * Returns access collections owned by the user
-	 *
-	 * @param int $owner_guid GUID of the owner
-	 * @return ElggAccessCollection[]|false
-	 */
-	public function getEntityCollections($owner_guid) {
+    /**
+     * Returns access collections owned by the user
+     *
+     * @param int $owner_guid GUID of the owner
+     * @return ElggAccessCollection[]|false
+     */
+    public function getEntityCollections($owner_guid) {
 
-		$callback = [$this, 'rowToElggAccessCollection'];
+        $callback = [$this, 'rowToElggAccessCollection'];
 
-		$query = "
+        $query = "
 			SELECT * FROM {$this->table}
 				WHERE owner_guid = :owner_guid
 				ORDER BY name ASC
 		";
 
-		$params = [
-			':owner_guid' => (int) $owner_guid,
-		];
+        $params = [
+            ':owner_guid' => (int) $owner_guid,
+        ];
 
-		return $this->db->getData($query, $callback, $params);
-	}
+        return $this->db->getData($query, $callback, $params);
+    }
 
-	/**
-	 * Get members of an access collection
-	 *
-	 * @param int   $collection_id The collection's ID
-	 * @param array $options       Ege* options
-	 * @return ElggEntity[]|false
-	 */
-	public function getMembers($collection_id, array $options = []) {
+    /**
+     * Get members of an access collection
+     *
+     * @param int   $collection_id The collection's ID
+     * @param array $options       Ege* options
+     * @return ElggEntity[]|false
+     */
+    public function getMembers($collection_id, array $options = []) {
 
-		$options['joins'][] = "JOIN {$this->membership_table} acm";
+        $options['joins'][] = "JOIN {$this->membership_table} acm";
 
-		$collection_id = (int) $collection_id;
-		$options['wheres'][] = "e.guid = acm.user_guid AND acm.access_collection_id = {$collection_id}";
+        $collection_id = (int) $collection_id;
+        $options['wheres'][] = "e.guid = acm.user_guid AND acm.access_collection_id = {$collection_id}";
 
-		return $this->entities->getEntities($options);
-	}
+        return $this->entities->getEntities($options);
+    }
 
-	/**
-	 * Return an array of collections that the entity is member of
-	 *
-	 * @param int $member_guid GUID of th member
-	 *
-	 * @return ElggAccessCollection[]|false
-	 */
-	public function getCollectionsByMember($member_guid) {
+    /**
+     * Return an array of collections that the entity is member of
+     *
+     * @param int $member_guid GUID of th member
+     *
+     * @return ElggAccessCollection[]|false
+     */
+    public function getCollectionsByMember($member_guid) {
 
-		$callback = [$this, 'rowToElggAccessCollection'];
+        $callback = [$this, 'rowToElggAccessCollection'];
 
-		$query = "
+        $query = "
 			SELECT ac.* FROM {$this->table} ac
 				JOIN {$this->membership_table} acm
 					ON ac.id = acm.access_collection_id
@@ -884,58 +884,58 @@ 
 				ORDER BY name ASC
 		";
 
-		return $this->db->getData($query, $callback, [
-			':member_guid' => (int) $member_guid,
-		]);
-	}
-
-	/**
-	 * Return the name of an ACCESS_* constant or an access collection,
-	 * but only if the logged in user owns the access collection or is an admin.
-	 * Ownership requirement prevents us from exposing names of access collections
-	 * that current user has been added to by other members and may contain
-	 * sensitive classification of the current user (e.g. close friends vs acquaintances).
-	 *
-	 * Returns a string in the language of the user for global access levels, e.g.'Public, 'Friends', 'Logged in', 'Private';
-	 * or a name of the owned access collection, e.g. 'My work colleagues';
-	 * or a name of the group or other access collection, e.g. 'Group: Elgg technical support';
-	 * or 'Limited' if the user access is restricted to read-only, e.g. a friends collection the user was added to
-	 *
-	 * @param int $entity_access_id The entity's access id
-	 *
-	 * @return string
-	 * @since 1.11
-	 */
-	public function getReadableAccessLevel($entity_access_id) {
-		$access = (int) $entity_access_id;
-
-		$translator = $this->translator;
-
-		// Check if entity access id is a defined global constant
-		$access_array = [
-			ACCESS_PRIVATE => $translator->translate("PRIVATE"),
-			ACCESS_FRIENDS => $translator->translate("access:friends:label"),
-			ACCESS_LOGGED_IN => $translator->translate("LOGGED_IN"),
-			ACCESS_PUBLIC => $translator->translate("PUBLIC"),
-		];
-
-		if (array_key_exists($access, $access_array)) {
-			return $access_array[$access];
-		}
-
-		// Entity access id is probably a custom access collection
-		// Check if the user has write access to it and can see it's label
-		// Admins should always be able to see the readable version
-		$collection = $this->get($access);
-
-		$user_guid = $this->session->getLoggedInUserGuid();
+        return $this->db->getData($query, $callback, [
+            ':member_guid' => (int) $member_guid,
+        ]);
+    }
+
+    /**
+     * Return the name of an ACCESS_* constant or an access collection,
+     * but only if the logged in user owns the access collection or is an admin.
+     * Ownership requirement prevents us from exposing names of access collections
+     * that current user has been added to by other members and may contain
+     * sensitive classification of the current user (e.g. close friends vs acquaintances).
+     *
+     * Returns a string in the language of the user for global access levels, e.g.'Public, 'Friends', 'Logged in', 'Private';
+     * or a name of the owned access collection, e.g. 'My work colleagues';
+     * or a name of the group or other access collection, e.g. 'Group: Elgg technical support';
+     * or 'Limited' if the user access is restricted to read-only, e.g. a friends collection the user was added to
+     *
+     * @param int $entity_access_id The entity's access id
+     *
+     * @return string
+     * @since 1.11
+     */
+    public function getReadableAccessLevel($entity_access_id) {
+        $access = (int) $entity_access_id;
+
+        $translator = $this->translator;
+
+        // Check if entity access id is a defined global constant
+        $access_array = [
+            ACCESS_PRIVATE => $translator->translate("PRIVATE"),
+            ACCESS_FRIENDS => $translator->translate("access:friends:label"),
+            ACCESS_LOGGED_IN => $translator->translate("LOGGED_IN"),
+            ACCESS_PUBLIC => $translator->translate("PUBLIC"),
+        ];
+
+        if (array_key_exists($access, $access_array)) {
+            return $access_array[$access];
+        }
+
+        // Entity access id is probably a custom access collection
+        // Check if the user has write access to it and can see it's label
+        // Admins should always be able to see the readable version
+        $collection = $this->get($access);
+
+        $user_guid = $this->session->getLoggedInUserGuid();
 		
-		if (!$collection || !$user_guid) {
-			// return 'Limited' if there is no logged in user or collection can not be loaded
-			return $translator->translate('access:limited:label');
-		}
+        if (!$collection || !$user_guid) {
+            // return 'Limited' if there is no logged in user or collection can not be loaded
+            return $translator->translate('access:limited:label');
+        }
 
-		return $collection->getDisplayName();
-	}
+        return $collection->getDisplayName();
+    }
 
 }

engine/classes/Elgg/I18n/Translator.php

Doc Comments +3 added lines, -3 removed lines

@@ -78,7 +78,7 @@ 
 	/**
 	 * Get a map of all loaded translations
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getLoadedTranslations() {
 		return $this->translations;
@@ -478,7 +478,7 @@ 
 	 *
 	 * @param string $language Language
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getLanguageCompleteness($language) {
 
@@ -579,7 +579,7 @@ 
 	/**
 	 * Returns an array of language codes.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function getAllLanguageCodes() {
 		return [

Indentation +729 added lines, -729 removed lines

@@ -12,737 +12,737 @@
  */
 class Translator {
 
-	/**
-	 * @var Config
-	 */
-	private $config;
-
-	/**
-	 * @var array
-	 */
-	private $translations = [];
-
-	/**
-	 * @var bool
-	 */
-	private $is_initialized = false;
-
-	/**
-	 * @var string
-	 */
-	private $current_language = null;
-
-	/**
-	 * Paths to scan for autoloading languages.
-	 *
-	 * Languages are automatically loaded for the site or
-	 * user's default language.  Plugins can extend or override strings.
-	 * language_paths is an array of paths to scan for PHP files matching
-	 * the default language.  The order of paths is determined by the plugin load order,
-	 * with later entries overriding earlier.  Language files within these paths are
-	 * named as the two-letter ISO 639-1 country codes for the language they represent.
-	 *
-	 * @link http://en.wikipedia.org/wiki/ISO_639-1
-	 *
-	 * @var array (paths are keys)
-	 */
-	private $language_paths = [];
-
-	/**
-	 * @var bool
-	 */
-	private $was_reloaded = false;
-
-	/**
-	 * @var bool
-	 */
-	private $loaded_from_cache = false;
-
-	/**
-	 * Constructor
-	 *
-	 * @param Config $config Elgg config
-	 */
-	public function __construct(Config $config) {
-		$this->config = $config;
-		$this->defaultPath = dirname(dirname(dirname(dirname(__DIR__)))) . "/languages/";
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function wasLoadedFromCache() {
-		return $this->loaded_from_cache;
-	}
-
-	/**
-	 * Get a map of all loaded translations
-	 *
-	 * @return array
-	 */
-	public function getLoadedTranslations() {
-		return $this->translations;
-	}
-
-	/**
-	 * Given a message key, returns an appropriately translated full-text string
-	 *
-	 * @param string $message_key The short message code
-	 * @param array  $args        An array of arguments to pass through vsprintf().
-	 * @param string $language    Optionally, the standard language code
-	 *                            (defaults to site/user default, then English)
-	 *
-	 * @return string Either the translated string, the English string,
-	 * or the original language string.
-	 */
-	public function translate($message_key, array $args = [], $language = "") {
-		if (!is_string($message_key) || strlen($message_key) < 1) {
-			_elgg_services()->logger->warn(
-				'$message_key needs to be a string in ' . __METHOD__ . '(), ' . gettype($message_key) . ' provided'
-			);
-			return '';
-		}
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @var array
+     */
+    private $translations = [];
+
+    /**
+     * @var bool
+     */
+    private $is_initialized = false;
+
+    /**
+     * @var string
+     */
+    private $current_language = null;
+
+    /**
+     * Paths to scan for autoloading languages.
+     *
+     * Languages are automatically loaded for the site or
+     * user's default language.  Plugins can extend or override strings.
+     * language_paths is an array of paths to scan for PHP files matching
+     * the default language.  The order of paths is determined by the plugin load order,
+     * with later entries overriding earlier.  Language files within these paths are
+     * named as the two-letter ISO 639-1 country codes for the language they represent.
+     *
+     * @link http://en.wikipedia.org/wiki/ISO_639-1
+     *
+     * @var array (paths are keys)
+     */
+    private $language_paths = [];
+
+    /**
+     * @var bool
+     */
+    private $was_reloaded = false;
+
+    /**
+     * @var bool
+     */
+    private $loaded_from_cache = false;
+
+    /**
+     * Constructor
+     *
+     * @param Config $config Elgg config
+     */
+    public function __construct(Config $config) {
+        $this->config = $config;
+        $this->defaultPath = dirname(dirname(dirname(dirname(__DIR__)))) . "/languages/";
+    }
+
+    /**
+     * @return bool
+     */
+    public function wasLoadedFromCache() {
+        return $this->loaded_from_cache;
+    }
+
+    /**
+     * Get a map of all loaded translations
+     *
+     * @return array
+     */
+    public function getLoadedTranslations() {
+        return $this->translations;
+    }
+
+    /**
+     * Given a message key, returns an appropriately translated full-text string
+     *
+     * @param string $message_key The short message code
+     * @param array  $args        An array of arguments to pass through vsprintf().
+     * @param string $language    Optionally, the standard language code
+     *                            (defaults to site/user default, then English)
+     *
+     * @return string Either the translated string, the English string,
+     * or the original language string.
+     */
+    public function translate($message_key, array $args = [], $language = "") {
+        if (!is_string($message_key) || strlen($message_key) < 1) {
+            _elgg_services()->logger->warn(
+                '$message_key needs to be a string in ' . __METHOD__ . '(), ' . gettype($message_key) . ' provided'
+            );
+            return '';
+        }
 		
-		if ($this->current_language === null) {
-			$this->current_language = $this->getCurrentLanguage();
-		}
-		if (!$language) {
-			$language = $this->current_language;
-		}
-
-		$this->ensureTranslationsLoaded($language);
-
-		$notice = '';
-		$string = $message_key;
-
-		// avoid dupes without overhead of array_unique
-		$langs[$language] = true;
-		$langs['en'] = true;
-
-		foreach (array_keys($langs) as $try_lang) {
-			if (isset($this->translations[$try_lang][$message_key])) {
-				$string = $this->translations[$try_lang][$message_key];
-
-				// only pass through if we have arguments to allow backward compatibility
-				// with manual sprintf() calls.
-				if ($args) {
-					$string = vsprintf($string, $args);
-				}
-
-				break;
-			} else {
-				$notice = sprintf(
-					'Missing %s translation for "%s" language key',
-					($try_lang === 'en') ? 'English' : $try_lang,
-					$message_key
-				);
-			}
-		}
-
-		if ($notice) {
-			_elgg_services()->logger->notice($notice);
-		}
-
-		return $string;
-	}
-
-	/**
-	 * Add a translation.
-	 *
-	 * Translations are arrays in the Zend Translation array format, eg:
-	 *
-	 *	$english = array('message1' => 'message1', 'message2' => 'message2');
-	 *  $german = array('message1' => 'Nachricht1','message2' => 'Nachricht2');
-	 *
-	 * @param string $country_code   Standard country code (eg 'en', 'nl', 'es')
-	 * @param array  $language_array Formatted array of strings
-	 *
-	 * @return bool Depending on success
-	 */
-	public function addTranslation($country_code, $language_array) {
-		$country_code = strtolower($country_code);
-		$country_code = trim($country_code);
-
-		if (!is_array($language_array) || $country_code === "") {
-			return false;
-		}
-
-		if (count($language_array) > 0) {
-			if (!isset($this->translations[$country_code])) {
-				$this->translations[$country_code] = $language_array;
-			} else {
-				$this->translations[$country_code] = $language_array + $this->translations[$country_code];
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get the current system/user language or "en".
-	 *
-	 * @return string The language code for the site/user or "en" if not set
-	 */
-	public function getCurrentLanguage() {
-		$language = $this->detectLanguage();
-
-		if (!$language) {
-			$language = 'en';
-		}
-
-		return $language;
-	}
-
-	/**
-	 * Detect the current system/user language or false.
-	 *
-	 * @return string The language code (eg "en") or false if not set
-	 */
-	public function detectLanguage() {
-		$url_lang = _elgg_services()->input->get('hl');
-		if ($url_lang) {
-			return $url_lang;
-		}
-
-		$user = _elgg_services()->session->getLoggedInUser();
-		$language = false;
-
-		if (($user) && ($user->language)) {
-			$language = $user->language;
-		}
-
-		if (!$language) {
-			$site_language = $this->config->language;
-			if ($site_language) {
-				$language = $site_language;
-			}
-		}
-
-		return $language ? $language : false;
-	}
-
-	/**
-	 * Load both core and plugin translations
-	 *
-	 * By default this loads only English and the language of the logged
-	 * in user.
-	 *
-	 * The optional $language argument can be used to load translations
-	 * on-demand in case we need to translate something to a language not
-	 * loaded by default for the current request.
-	 *
-	 * @param string $language Language code
-	 * @access private
-	 */
-	public function loadTranslations($language = null) {
-		if (elgg_is_system_cache_enabled()) {
-			$loaded = true;
-
-			if ($language) {
-				$languages = [$language];
-			} else {
-				$languages = array_unique(['en', $this->getCurrentLanguage()]);
-			}
-
-			foreach ($languages as $language) {
-				$data = elgg_load_system_cache("$language.lang");
-				if ($data) {
-					$this->addTranslation($language, unserialize($data));
-				} else {
-					$loaded = false;
-				}
-			}
-
-			if ($loaded) {
-				$this->loaded_from_cache = true;
-				$this->language_paths[$this->defaultPath] = true;
-				$this->is_initialized = true;
-				return;
-			}
-		}
-
-		// load core translations from languages directory
-		$this->registerTranslations($this->defaultPath, false, $language);
-
-		// Plugin translation have already been loaded for the default
-		// languages by ElggApplication::bootCore(), so there's no need
-		// to continue unless loading a specific language on-demand
-		if ($language) {
-			$this->loadPluginTranslations($language);
-		}
-	}
-
-	/**
-	 * Load plugin translations for a language
-	 *
-	 * This is needed only if the current request uses a language
-	 * that is neither English of the same as the language of the
-	 * logged in user.
-	 *
-	 * @param string $language Language code
-	 * @return void
-	 * @throws \PluginException
-	 */
-	private function loadPluginTranslations($language) {
-		// Get active plugins
-		$plugins = _elgg_services()->plugins->find('active');
-
-		if (!$plugins) {
-			// Active plugins were not found, so no need to register plugin translations
-			return;
-		}
-
-		foreach ($plugins as $plugin) {
-			$languages_path = "{$plugin->getPath()}languages/";
-
-			if (!is_dir($languages_path)) {
-				// This plugin doesn't have anything to translate
-				continue;
-			}
-
-			$language_file = "{$languages_path}{$language}.php";
-
-			if (!file_exists($language_file)) {
-				// This plugin doesn't have translations for the requested language
-
-				$name = $plugin->getDisplayName();
-				_elgg_services()->logger->notice("Plugin $name is missing translations for $language language");
-
-				continue;
-			}
-
-			// Register translations from the plugin languages directory
-			if (!$this->registerTranslations($languages_path, false, $language)) {
-				throw new \PluginException(sprintf('Cannot register languages for plugin %s (guid: %s) at %s.',
-					[$plugin->getID(), $plugin->guid, $languages_path]));
-			}
-		}
-	}
-
-	/**
-	 * Registers translations in a directory assuming the standard plugin layout.
-	 *
-	 * @param string $path Without the trailing slash.
-	 *
-	 * @return bool Success
-	 */
-	public function registerPluginTranslations($path) {
-		$languages_path = rtrim($path, "\\/") . "/languages";
-
-		// don't need to have translations
-		if (!is_dir($languages_path)) {
-			return true;
-		}
-
-		return $this->registerTranslations($languages_path);
-	}
-
-	/**
-	 * When given a full path, finds translation files and loads them
-	 *
-	 * @param string $path     Full path
-	 * @param bool   $load_all If true all languages are loaded, if
-	 *                         false only the current language + en are loaded
-	 * @param string $language Language code
-	 *
-	 * @return bool success
-	 */
-	public function registerTranslations($path, $load_all = false, $language = null) {
-		$path = sanitise_filepath($path);
-
-		// Make a note of this path just in case we need to register this language later
-		$this->language_paths[$path] = true;
-		$this->is_initialized = true;
-
-		_elgg_services()->logger->info("Translations loaded from: $path");
-
-		if ($language) {
-			$load_language_files = ["$language.php"];
-			$load_all = false;
-		} else {
-			// Get the current language based on site defaults and user preference
-			$current_language = $this->getCurrentLanguage();
-
-			$load_language_files = [
-				'en.php',
-				"$current_language.php"
-			];
-
-			$load_language_files = array_unique($load_language_files);
-		}
-
-		$handle = opendir($path);
-		if (!$handle) {
-			_elgg_services()->logger->error("Could not open language path: $path");
-			return false;
-		}
-
-		$return = true;
-		while (false !== ($language_file = readdir($handle))) {
-			// ignore bad files
-			if (substr($language_file, 0, 1) == '.' || substr($language_file, -4) !== '.php') {
-				continue;
-			}
-
-			if (in_array($language_file, $load_language_files) || $load_all) {
-				$result = (include $path . $language_file);
-				if ($result === false) {
-					$return = false;
-					continue;
-				} elseif (is_array($result)) {
-					$this->addTranslation(basename($language_file, '.php'), $result);
-				}
-			}
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Reload all translations from all registered paths.
-	 *
-	 * This is only called by functions which need to know all possible translations.
-	 *
-	 * @todo Better on demand loading based on language_paths array
-	 *
-	 * @return void
-	 */
-	public function reloadAllTranslations() {
-		if ($this->was_reloaded) {
-			return;
-		}
-
-		if ($this->loaded_from_cache) {
-			$cache = elgg_get_system_cache();
-			$cache_dir = $cache->getVariable("cache_path");
-			$filenames = elgg_get_file_list($cache_dir, [], [], [".lang"]);
-			foreach ($filenames as $filename) {
-				// Look for files matching for example 'en.lang', 'cmn.lang' or 'pt_br.lang'.
-				// Note that this regex is just for the system cache. The original language
-				// files are allowed to have uppercase letters (e.g. pt_BR.php).
-				if (preg_match('/(([a-z]{2,3})(_[a-z]{2})?)\.lang$/', $filename, $matches)) {
-					$language = $matches[1];
-					$data = elgg_load_system_cache("$language.lang");
-					if ($data) {
-						$this->addTranslation($language, unserialize($data));
-					}
-				}
-			}
-		} else {
-			foreach (array_keys($this->language_paths) as $path) {
-				$this->registerTranslations($path, true);
-			}
-		}
-
-		$this->was_reloaded = true;
-	}
-
-	/**
-	 * Return an array of installed translations as an associative
-	 * array "two letter code" => "native language name".
-	 *
-	 * @return array
-	 */
-	public function getInstalledTranslations() {
-		// Ensure that all possible translations are loaded
-		$this->reloadAllTranslations();
-
-		$installed = [];
-
-		$admin_logged_in = _elgg_services()->session->isAdminLoggedIn();
-
-		foreach ($this->translations as $k => $v) {
-			if ($this->languageKeyExists($k, $k)) {
-				$lang = $this->translate($k, [], $k);
-			} else {
-				$lang = $this->translate($k);
-			}
+        if ($this->current_language === null) {
+            $this->current_language = $this->getCurrentLanguage();
+        }
+        if (!$language) {
+            $language = $this->current_language;
+        }
+
+        $this->ensureTranslationsLoaded($language);
+
+        $notice = '';
+        $string = $message_key;
+
+        // avoid dupes without overhead of array_unique
+        $langs[$language] = true;
+        $langs['en'] = true;
+
+        foreach (array_keys($langs) as $try_lang) {
+            if (isset($this->translations[$try_lang][$message_key])) {
+                $string = $this->translations[$try_lang][$message_key];
+
+                // only pass through if we have arguments to allow backward compatibility
+                // with manual sprintf() calls.
+                if ($args) {
+                    $string = vsprintf($string, $args);
+                }
+
+                break;
+            } else {
+                $notice = sprintf(
+                    'Missing %s translation for "%s" language key',
+                    ($try_lang === 'en') ? 'English' : $try_lang,
+                    $message_key
+                );
+            }
+        }
+
+        if ($notice) {
+            _elgg_services()->logger->notice($notice);
+        }
+
+        return $string;
+    }
+
+    /**
+     * Add a translation.
+     *
+     * Translations are arrays in the Zend Translation array format, eg:
+     *
+     *	$english = array('message1' => 'message1', 'message2' => 'message2');
+     *  $german = array('message1' => 'Nachricht1','message2' => 'Nachricht2');
+     *
+     * @param string $country_code   Standard country code (eg 'en', 'nl', 'es')
+     * @param array  $language_array Formatted array of strings
+     *
+     * @return bool Depending on success
+     */
+    public function addTranslation($country_code, $language_array) {
+        $country_code = strtolower($country_code);
+        $country_code = trim($country_code);
+
+        if (!is_array($language_array) || $country_code === "") {
+            return false;
+        }
+
+        if (count($language_array) > 0) {
+            if (!isset($this->translations[$country_code])) {
+                $this->translations[$country_code] = $language_array;
+            } else {
+                $this->translations[$country_code] = $language_array + $this->translations[$country_code];
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the current system/user language or "en".
+     *
+     * @return string The language code for the site/user or "en" if not set
+     */
+    public function getCurrentLanguage() {
+        $language = $this->detectLanguage();
+
+        if (!$language) {
+            $language = 'en';
+        }
+
+        return $language;
+    }
+
+    /**
+     * Detect the current system/user language or false.
+     *
+     * @return string The language code (eg "en") or false if not set
+     */
+    public function detectLanguage() {
+        $url_lang = _elgg_services()->input->get('hl');
+        if ($url_lang) {
+            return $url_lang;
+        }
+
+        $user = _elgg_services()->session->getLoggedInUser();
+        $language = false;
+
+        if (($user) && ($user->language)) {
+            $language = $user->language;
+        }
+
+        if (!$language) {
+            $site_language = $this->config->language;
+            if ($site_language) {
+                $language = $site_language;
+            }
+        }
+
+        return $language ? $language : false;
+    }
+
+    /**
+     * Load both core and plugin translations
+     *
+     * By default this loads only English and the language of the logged
+     * in user.
+     *
+     * The optional $language argument can be used to load translations
+     * on-demand in case we need to translate something to a language not
+     * loaded by default for the current request.
+     *
+     * @param string $language Language code
+     * @access private
+     */
+    public function loadTranslations($language = null) {
+        if (elgg_is_system_cache_enabled()) {
+            $loaded = true;
+
+            if ($language) {
+                $languages = [$language];
+            } else {
+                $languages = array_unique(['en', $this->getCurrentLanguage()]);
+            }
+
+            foreach ($languages as $language) {
+                $data = elgg_load_system_cache("$language.lang");
+                if ($data) {
+                    $this->addTranslation($language, unserialize($data));
+                } else {
+                    $loaded = false;
+                }
+            }
+
+            if ($loaded) {
+                $this->loaded_from_cache = true;
+                $this->language_paths[$this->defaultPath] = true;
+                $this->is_initialized = true;
+                return;
+            }
+        }
+
+        // load core translations from languages directory
+        $this->registerTranslations($this->defaultPath, false, $language);
+
+        // Plugin translation have already been loaded for the default
+        // languages by ElggApplication::bootCore(), so there's no need
+        // to continue unless loading a specific language on-demand
+        if ($language) {
+            $this->loadPluginTranslations($language);
+        }
+    }
+
+    /**
+     * Load plugin translations for a language
+     *
+     * This is needed only if the current request uses a language
+     * that is neither English of the same as the language of the
+     * logged in user.
+     *
+     * @param string $language Language code
+     * @return void
+     * @throws \PluginException
+     */
+    private function loadPluginTranslations($language) {
+        // Get active plugins
+        $plugins = _elgg_services()->plugins->find('active');
+
+        if (!$plugins) {
+            // Active plugins were not found, so no need to register plugin translations
+            return;
+        }
+
+        foreach ($plugins as $plugin) {
+            $languages_path = "{$plugin->getPath()}languages/";
+
+            if (!is_dir($languages_path)) {
+                // This plugin doesn't have anything to translate
+                continue;
+            }
+
+            $language_file = "{$languages_path}{$language}.php";
+
+            if (!file_exists($language_file)) {
+                // This plugin doesn't have translations for the requested language
+
+                $name = $plugin->getDisplayName();
+                _elgg_services()->logger->notice("Plugin $name is missing translations for $language language");
+
+                continue;
+            }
+
+            // Register translations from the plugin languages directory
+            if (!$this->registerTranslations($languages_path, false, $language)) {
+                throw new \PluginException(sprintf('Cannot register languages for plugin %s (guid: %s) at %s.',
+                    [$plugin->getID(), $plugin->guid, $languages_path]));
+            }
+        }
+    }
+
+    /**
+     * Registers translations in a directory assuming the standard plugin layout.
+     *
+     * @param string $path Without the trailing slash.
+     *
+     * @return bool Success
+     */
+    public function registerPluginTranslations($path) {
+        $languages_path = rtrim($path, "\\/") . "/languages";
+
+        // don't need to have translations
+        if (!is_dir($languages_path)) {
+            return true;
+        }
+
+        return $this->registerTranslations($languages_path);
+    }
+
+    /**
+     * When given a full path, finds translation files and loads them
+     *
+     * @param string $path     Full path
+     * @param bool   $load_all If true all languages are loaded, if
+     *                         false only the current language + en are loaded
+     * @param string $language Language code
+     *
+     * @return bool success
+     */
+    public function registerTranslations($path, $load_all = false, $language = null) {
+        $path = sanitise_filepath($path);
+
+        // Make a note of this path just in case we need to register this language later
+        $this->language_paths[$path] = true;
+        $this->is_initialized = true;
+
+        _elgg_services()->logger->info("Translations loaded from: $path");
+
+        if ($language) {
+            $load_language_files = ["$language.php"];
+            $load_all = false;
+        } else {
+            // Get the current language based on site defaults and user preference
+            $current_language = $this->getCurrentLanguage();
+
+            $load_language_files = [
+                'en.php',
+                "$current_language.php"
+            ];
+
+            $load_language_files = array_unique($load_language_files);
+        }
+
+        $handle = opendir($path);
+        if (!$handle) {
+            _elgg_services()->logger->error("Could not open language path: $path");
+            return false;
+        }
+
+        $return = true;
+        while (false !== ($language_file = readdir($handle))) {
+            // ignore bad files
+            if (substr($language_file, 0, 1) == '.' || substr($language_file, -4) !== '.php') {
+                continue;
+            }
+
+            if (in_array($language_file, $load_language_files) || $load_all) {
+                $result = (include $path . $language_file);
+                if ($result === false) {
+                    $return = false;
+                    continue;
+                } elseif (is_array($result)) {
+                    $this->addTranslation(basename($language_file, '.php'), $result);
+                }
+            }
+        }
+
+        return $return;
+    }
+
+    /**
+     * Reload all translations from all registered paths.
+     *
+     * This is only called by functions which need to know all possible translations.
+     *
+     * @todo Better on demand loading based on language_paths array
+     *
+     * @return void
+     */
+    public function reloadAllTranslations() {
+        if ($this->was_reloaded) {
+            return;
+        }
+
+        if ($this->loaded_from_cache) {
+            $cache = elgg_get_system_cache();
+            $cache_dir = $cache->getVariable("cache_path");
+            $filenames = elgg_get_file_list($cache_dir, [], [], [".lang"]);
+            foreach ($filenames as $filename) {
+                // Look for files matching for example 'en.lang', 'cmn.lang' or 'pt_br.lang'.
+                // Note that this regex is just for the system cache. The original language
+                // files are allowed to have uppercase letters (e.g. pt_BR.php).
+                if (preg_match('/(([a-z]{2,3})(_[a-z]{2})?)\.lang$/', $filename, $matches)) {
+                    $language = $matches[1];
+                    $data = elgg_load_system_cache("$language.lang");
+                    if ($data) {
+                        $this->addTranslation($language, unserialize($data));
+                    }
+                }
+            }
+        } else {
+            foreach (array_keys($this->language_paths) as $path) {
+                $this->registerTranslations($path, true);
+            }
+        }
+
+        $this->was_reloaded = true;
+    }
+
+    /**
+     * Return an array of installed translations as an associative
+     * array "two letter code" => "native language name".
+     *
+     * @return array
+     */
+    public function getInstalledTranslations() {
+        // Ensure that all possible translations are loaded
+        $this->reloadAllTranslations();
+
+        $installed = [];
+
+        $admin_logged_in = _elgg_services()->session->isAdminLoggedIn();
+
+        foreach ($this->translations as $k => $v) {
+            if ($this->languageKeyExists($k, $k)) {
+                $lang = $this->translate($k, [], $k);
+            } else {
+                $lang = $this->translate($k);
+            }
 			
-			$installed[$k] = $lang;
+            $installed[$k] = $lang;
 			
-			if (!$admin_logged_in || ($k === 'en')) {
-				continue;
-			}
+            if (!$admin_logged_in || ($k === 'en')) {
+                continue;
+            }
 			
-			$completeness = $this->getLanguageCompleteness($k);
-			if ($completeness < 100) {
-				$installed[$k] .= " (" . $completeness . "% " . $this->translate('complete') . ")";
-			}
-		}
-
-		return $installed;
-	}
-
-	/**
-	 * Return the level of completeness for a given language code (compared to english)
-	 *
-	 * @param string $language Language
-	 *
-	 * @return int
-	 */
-	public function getLanguageCompleteness($language) {
-
-
-		// Ensure that all possible translations are loaded
-		$this->reloadAllTranslations();
-
-		$language = sanitise_string($language);
-
-		$en = count($this->translations['en']);
-
-		$missing = $this->getMissingLanguageKeys($language);
-		if ($missing) {
-			$missing = count($missing);
-		} else {
-			$missing = 0;
-		}
-
-		$lang = $en - $missing;
-
-		return round(($lang / $en) * 100, 2);
-	}
-
-	/**
-	 * Return the translation keys missing from a given language,
-	 * or those that are identical to the english version.
-	 *
-	 * @param string $language The language
-	 *
-	 * @return mixed
-	 */
-	public function getMissingLanguageKeys($language) {
-
-
-		// Ensure that all possible translations are loaded
-		$this->reloadAllTranslations();
-
-		$missing = [];
-
-		foreach ($this->translations['en'] as $k => $v) {
-			if ((!isset($this->translations[$language][$k]))
-			|| ($this->translations[$language][$k] == $this->translations['en'][$k])) {
-				$missing[] = $k;
-			}
-		}
-
-		if (count($missing)) {
-			return $missing;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check if a given language key exists
-	 *
-	 * @param string $key      The translation key
-	 * @param string $language The specific language to check
-	 *
-	 * @return bool
-	 * @since 1.11
-	 */
-	function languageKeyExists($key, $language = 'en') {
-		if (empty($key)) {
-			return false;
-		}
-
-		$this->ensureTranslationsLoaded($language);
-
-		if (!array_key_exists($language, $this->translations)) {
-			return false;
-		}
-
-		return array_key_exists($key, $this->translations[$language]);
-	}
-
-	/**
-	 * Make sure translations are loaded
-	 *
-	 * @param string $language Language
-	 * @return void
-	 */
-	private function ensureTranslationsLoaded($language) {
-		if (!$this->is_initialized) {
-			// this means we probably had an exception before translations were initialized
-			$this->registerTranslations($this->defaultPath);
-		}
-
-		if (!isset($this->translations[$language])) {
-			// The language being requested is not the same as the language of the
-			// logged in user, so we will have to load it separately. (Most likely
-			// we're sending a notification and the recipient is using a different
-			// language than the logged in user.)
-			$this->loadTranslations($language);
-		}
-	}
-
-	/**
-	 * Returns an array of language codes.
-	 *
-	 * @return array
-	 */
-	public static function getAllLanguageCodes() {
-		return [
-			"aa", // "Afar"
-			"ab", // "Abkhazian"
-			"af", // "Afrikaans"
-			"am", // "Amharic"
-			"ar", // "Arabic"
-			"as", // "Assamese"
-			"ay", // "Aymara"
-			"az", // "Azerbaijani"
-			"ba", // "Bashkir"
-			"be", // "Byelorussian"
-			"bg", // "Bulgarian"
-			"bh", // "Bihari"
-			"bi", // "Bislama"
-			"bn", // "Bengali; Bangla"
-			"bo", // "Tibetan"
-			"br", // "Breton"
-			"ca", // "Catalan"
-			"cmn", // "Mandarin Chinese" // ISO 639-3
-			"co", // "Corsican"
-			"cs", // "Czech"
-			"cy", // "Welsh"
-			"da", // "Danish"
-			"de", // "German"
-			"dz", // "Bhutani"
-			"el", // "Greek"
-			"en", // "English"
-			"eo", // "Esperanto"
-			"es", // "Spanish"
-			"et", // "Estonian"
-			"eu", // "Basque"
-			"eu_es", // "Basque (Spain)"
-			"fa", // "Persian"
-			"fi", // "Finnish"
-			"fj", // "Fiji"
-			"fo", // "Faeroese"
-			"fr", // "French"
-			"fy", // "Frisian"
-			"ga", // "Irish"
-			"gd", // "Scots / Gaelic"
-			"gl", // "Galician"
-			"gn", // "Guarani"
-			"gu", // "Gujarati"
-			"he", // "Hebrew"
-			"ha", // "Hausa"
-			"hi", // "Hindi"
-			"hr", // "Croatian"
-			"hu", // "Hungarian"
-			"hy", // "Armenian"
-			"ia", // "Interlingua"
-			"id", // "Indonesian"
-			"ie", // "Interlingue"
-			"ik", // "Inupiak"
-			"is", // "Icelandic"
-			"it", // "Italian"
-			"iu", // "Inuktitut"
-			"iw", // "Hebrew (obsolete)"
-			"ja", // "Japanese"
-			"ji", // "Yiddish (obsolete)"
-			"jw", // "Javanese"
-			"ka", // "Georgian"
-			"kk", // "Kazakh"
-			"kl", // "Greenlandic"
-			"km", // "Cambodian"
-			"kn", // "Kannada"
-			"ko", // "Korean"
-			"ks", // "Kashmiri"
-			"ku", // "Kurdish"
-			"ky", // "Kirghiz"
-			"la", // "Latin"
-			"ln", // "Lingala"
-			"lo", // "Laothian"
-			"lt", // "Lithuanian"
-			"lv", // "Latvian/Lettish"
-			"mg", // "Malagasy"
-			"mi", // "Maori"
-			"mk", // "Macedonian"
-			"ml", // "Malayalam"
-			"mn", // "Mongolian"
-			"mo", // "Moldavian"
-			"mr", // "Marathi"
-			"ms", // "Malay"
-			"mt", // "Maltese"
-			"my", // "Burmese"
-			"na", // "Nauru"
-			"ne", // "Nepali"
-			"nl", // "Dutch"
-			"no", // "Norwegian"
-			"oc", // "Occitan"
-			"om", // "(Afan) Oromo"
-			"or", // "Oriya"
-			"pa", // "Punjabi"
-			"pl", // "Polish"
-			"ps", // "Pashto / Pushto"
-			"pt", // "Portuguese"
-			"pt_br", // "Portuguese (Brazil)"
-			"qu", // "Quechua"
-			"rm", // "Rhaeto-Romance"
-			"rn", // "Kirundi"
-			"ro", // "Romanian"
-			"ro_ro", // "Romanian (Romania)"
-			"ru", // "Russian"
-			"rw", // "Kinyarwanda"
-			"sa", // "Sanskrit"
-			"sd", // "Sindhi"
-			"sg", // "Sangro"
-			"sh", // "Serbo-Croatian"
-			"si", // "Singhalese"
-			"sk", // "Slovak"
-			"sl", // "Slovenian"
-			"sm", // "Samoan"
-			"sn", // "Shona"
-			"so", // "Somali"
-			"sq", // "Albanian"
-			"sr", // "Serbian"
-			"sr_latin", // "Serbian (Latin)"
-			"ss", // "Siswati"
-			"st", // "Sesotho"
-			"su", // "Sundanese"
-			"sv", // "Swedish"
-			"sw", // "Swahili"
-			"ta", // "Tamil"
-			"te", // "Tegulu"
-			"tg", // "Tajik"
-			"th", // "Thai"
-			"ti", // "Tigrinya"
-			"tk", // "Turkmen"
-			"tl", // "Tagalog"
-			"tn", // "Setswana"
-			"to", // "Tonga"
-			"tr", // "Turkish"
-			"ts", // "Tsonga"
-			"tt", // "Tatar"
-			"tw", // "Twi"
-			"ug", // "Uigur"
-			"uk", // "Ukrainian"
-			"ur", // "Urdu"
-			"uz", // "Uzbek"
-			"vi", // "Vietnamese"
-			"vo", // "Volapuk"
-			"wo", // "Wolof"
-			"xh", // "Xhosa"
-			"yi", // "Yiddish"
-			"yo", // "Yoruba"
-			"za", // "Zuang"
-			"zh", // "Chinese"
-			"zh_hans", // "Chinese Simplified"
-			"zu", // "Zulu"
-		];
-	}
-
-	/**
-	 * Normalize a language code (e.g. from Transifex)
-	 *
-	 * @param string $code Language code
-	 *
-	 * @return string
-	 */
-	public static function normalizeLanguageCode($code) {
-		$code = strtolower($code);
-		$code = preg_replace('~[^a-z0-9]~', '_', $code);
-		return $code;
-	}
+            $completeness = $this->getLanguageCompleteness($k);
+            if ($completeness < 100) {
+                $installed[$k] .= " (" . $completeness . "% " . $this->translate('complete') . ")";
+            }
+        }
+
+        return $installed;
+    }
+
+    /**
+     * Return the level of completeness for a given language code (compared to english)
+     *
+     * @param string $language Language
+     *
+     * @return int
+     */
+    public function getLanguageCompleteness($language) {
+
+
+        // Ensure that all possible translations are loaded
+        $this->reloadAllTranslations();
+
+        $language = sanitise_string($language);
+
+        $en = count($this->translations['en']);
+
+        $missing = $this->getMissingLanguageKeys($language);
+        if ($missing) {
+            $missing = count($missing);
+        } else {
+            $missing = 0;
+        }
+
+        $lang = $en - $missing;
+
+        return round(($lang / $en) * 100, 2);
+    }
+
+    /**
+     * Return the translation keys missing from a given language,
+     * or those that are identical to the english version.
+     *
+     * @param string $language The language
+     *
+     * @return mixed
+     */
+    public function getMissingLanguageKeys($language) {
+
+
+        // Ensure that all possible translations are loaded
+        $this->reloadAllTranslations();
+
+        $missing = [];
+
+        foreach ($this->translations['en'] as $k => $v) {
+            if ((!isset($this->translations[$language][$k]))
+            || ($this->translations[$language][$k] == $this->translations['en'][$k])) {
+                $missing[] = $k;
+            }
+        }
+
+        if (count($missing)) {
+            return $missing;
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if a given language key exists
+     *
+     * @param string $key      The translation key
+     * @param string $language The specific language to check
+     *
+     * @return bool
+     * @since 1.11
+     */
+    function languageKeyExists($key, $language = 'en') {
+        if (empty($key)) {
+            return false;
+        }
+
+        $this->ensureTranslationsLoaded($language);
+
+        if (!array_key_exists($language, $this->translations)) {
+            return false;
+        }
+
+        return array_key_exists($key, $this->translations[$language]);
+    }
+
+    /**
+     * Make sure translations are loaded
+     *
+     * @param string $language Language
+     * @return void
+     */
+    private function ensureTranslationsLoaded($language) {
+        if (!$this->is_initialized) {
+            // this means we probably had an exception before translations were initialized
+            $this->registerTranslations($this->defaultPath);
+        }
+
+        if (!isset($this->translations[$language])) {
+            // The language being requested is not the same as the language of the
+            // logged in user, so we will have to load it separately. (Most likely
+            // we're sending a notification and the recipient is using a different
+            // language than the logged in user.)
+            $this->loadTranslations($language);
+        }
+    }
+
+    /**
+     * Returns an array of language codes.
+     *
+     * @return array
+     */
+    public static function getAllLanguageCodes() {
+        return [
+            "aa", // "Afar"
+            "ab", // "Abkhazian"
+            "af", // "Afrikaans"
+            "am", // "Amharic"
+            "ar", // "Arabic"
+            "as", // "Assamese"
+            "ay", // "Aymara"
+            "az", // "Azerbaijani"
+            "ba", // "Bashkir"
+            "be", // "Byelorussian"
+            "bg", // "Bulgarian"
+            "bh", // "Bihari"
+            "bi", // "Bislama"
+            "bn", // "Bengali; Bangla"
+            "bo", // "Tibetan"
+            "br", // "Breton"
+            "ca", // "Catalan"
+            "cmn", // "Mandarin Chinese" // ISO 639-3
+            "co", // "Corsican"
+            "cs", // "Czech"
+            "cy", // "Welsh"
+            "da", // "Danish"
+            "de", // "German"
+            "dz", // "Bhutani"
+            "el", // "Greek"
+            "en", // "English"
+            "eo", // "Esperanto"
+            "es", // "Spanish"
+            "et", // "Estonian"
+            "eu", // "Basque"
+            "eu_es", // "Basque (Spain)"
+            "fa", // "Persian"
+            "fi", // "Finnish"
+            "fj", // "Fiji"
+            "fo", // "Faeroese"
+            "fr", // "French"
+            "fy", // "Frisian"
+            "ga", // "Irish"
+            "gd", // "Scots / Gaelic"
+            "gl", // "Galician"
+            "gn", // "Guarani"
+            "gu", // "Gujarati"
+            "he", // "Hebrew"
+            "ha", // "Hausa"
+            "hi", // "Hindi"
+            "hr", // "Croatian"
+            "hu", // "Hungarian"
+            "hy", // "Armenian"
+            "ia", // "Interlingua"
+            "id", // "Indonesian"
+            "ie", // "Interlingue"
+            "ik", // "Inupiak"
+            "is", // "Icelandic"
+            "it", // "Italian"
+            "iu", // "Inuktitut"
+            "iw", // "Hebrew (obsolete)"
+            "ja", // "Japanese"
+            "ji", // "Yiddish (obsolete)"
+            "jw", // "Javanese"
+            "ka", // "Georgian"
+            "kk", // "Kazakh"
+            "kl", // "Greenlandic"
+            "km", // "Cambodian"
+            "kn", // "Kannada"
+            "ko", // "Korean"
+            "ks", // "Kashmiri"
+            "ku", // "Kurdish"
+            "ky", // "Kirghiz"
+            "la", // "Latin"
+            "ln", // "Lingala"
+            "lo", // "Laothian"
+            "lt", // "Lithuanian"
+            "lv", // "Latvian/Lettish"
+            "mg", // "Malagasy"
+            "mi", // "Maori"
+            "mk", // "Macedonian"
+            "ml", // "Malayalam"
+            "mn", // "Mongolian"
+            "mo", // "Moldavian"
+            "mr", // "Marathi"
+            "ms", // "Malay"
+            "mt", // "Maltese"
+            "my", // "Burmese"
+            "na", // "Nauru"
+            "ne", // "Nepali"
+            "nl", // "Dutch"
+            "no", // "Norwegian"
+            "oc", // "Occitan"
+            "om", // "(Afan) Oromo"
+            "or", // "Oriya"
+            "pa", // "Punjabi"
+            "pl", // "Polish"
+            "ps", // "Pashto / Pushto"
+            "pt", // "Portuguese"
+            "pt_br", // "Portuguese (Brazil)"
+            "qu", // "Quechua"
+            "rm", // "Rhaeto-Romance"
+            "rn", // "Kirundi"
+            "ro", // "Romanian"
+            "ro_ro", // "Romanian (Romania)"
+            "ru", // "Russian"
+            "rw", // "Kinyarwanda"
+            "sa", // "Sanskrit"
+            "sd", // "Sindhi"
+            "sg", // "Sangro"
+            "sh", // "Serbo-Croatian"
+            "si", // "Singhalese"
+            "sk", // "Slovak"
+            "sl", // "Slovenian"
+            "sm", // "Samoan"
+            "sn", // "Shona"
+            "so", // "Somali"
+            "sq", // "Albanian"
+            "sr", // "Serbian"
+            "sr_latin", // "Serbian (Latin)"
+            "ss", // "Siswati"
+            "st", // "Sesotho"
+            "su", // "Sundanese"
+            "sv", // "Swedish"
+            "sw", // "Swahili"
+            "ta", // "Tamil"
+            "te", // "Tegulu"
+            "tg", // "Tajik"
+            "th", // "Thai"
+            "ti", // "Tigrinya"
+            "tk", // "Turkmen"
+            "tl", // "Tagalog"
+            "tn", // "Setswana"
+            "to", // "Tonga"
+            "tr", // "Turkish"
+            "ts", // "Tsonga"
+            "tt", // "Tatar"
+            "tw", // "Twi"
+            "ug", // "Uigur"
+            "uk", // "Ukrainian"
+            "ur", // "Urdu"
+            "uz", // "Uzbek"
+            "vi", // "Vietnamese"
+            "vo", // "Volapuk"
+            "wo", // "Wolof"
+            "xh", // "Xhosa"
+            "yi", // "Yiddish"
+            "yo", // "Yoruba"
+            "za", // "Zuang"
+            "zh", // "Chinese"
+            "zh_hans", // "Chinese Simplified"
+            "zu", // "Zulu"
+        ];
+    }
+
+    /**
+     * Normalize a language code (e.g. from Transifex)
+     *
+     * @param string $code Language code
+     *
+     * @return string
+     */
+    public static function normalizeLanguageCode($code) {
+        $code = strtolower($code);
+        $code = preg_replace('~[^a-z0-9]~', '_', $code);
+        return $code;
+    }
 }

engine/lib/pam.php

Indentation +13 added lines, -13 removed lines

@@ -37,22 +37,22 @@ 
  * @return bool
  */
 function register_pam_handler($handler, $importance = "sufficient", $policy = "user") {
-	// setup array for this type of pam if not already set
-	if (!isset(\ElggPAM::$_handlers[$policy])) {
-		\ElggPAM::$_handlers[$policy] = [];
-	}
+    // setup array for this type of pam if not already set
+    if (!isset(\ElggPAM::$_handlers[$policy])) {
+        \ElggPAM::$_handlers[$policy] = [];
+    }
 
-	// @todo remove requirement that $handle be a global function
-	if (is_string($handler) && is_callable($handler, true)) {
-		\ElggPAM::$_handlers[$policy][$handler] = new \stdClass;
+    // @todo remove requirement that $handle be a global function
+    if (is_string($handler) && is_callable($handler, true)) {
+        \ElggPAM::$_handlers[$policy][$handler] = new \stdClass;
 
-		\ElggPAM::$_handlers[$policy][$handler]->handler = $handler;
-		\ElggPAM::$_handlers[$policy][$handler]->importance = strtolower($importance);
+        \ElggPAM::$_handlers[$policy][$handler]->handler = $handler;
+        \ElggPAM::$_handlers[$policy][$handler]->importance = strtolower($importance);
 
-		return true;
-	}
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 /**
@@ -65,5 +65,5 @@ 
  * @since 1.7.0
  */
 function unregister_pam_handler($handler, $policy = "user") {
-	unset(\ElggPAM::$_handlers[$policy][$handler]);
+    unset(\ElggPAM::$_handlers[$policy][$handler]);
 }

engine/classes/ElggPAM.php

Indentation +90 added lines, -90 removed lines

@@ -5,105 +5,105 @@
  */
 class ElggPAM {
 
-	/**
-	 * @var array
-	 * @access private
-	 * @todo move state into a PAM service
-	 */
-	public static $_handlers = [];
+    /**
+     * @var array
+     * @access private
+     * @todo move state into a PAM service
+     */
+    public static $_handlers = [];
 
-	/**
-	 * @var string PAM policy type: user, api or plugin-defined policies
-	 */
-	protected $policy;
+    /**
+     * @var string PAM policy type: user, api or plugin-defined policies
+     */
+    protected $policy;
 
-	/**
-	 * @var array Failure mesages
-	 */
-	protected $messages;
+    /**
+     * @var array Failure mesages
+     */
+    protected $messages;
 
-	/**
-	 * \ElggPAM constructor
-	 *
-	 * @param string $policy PAM policy type: user, api, or plugin-defined policies
-	 */
-	public function __construct($policy) {
-		$this->policy = $policy;
-		$this->messages = ['sufficient' => [], 'required' => []];
-	}
+    /**
+     * \ElggPAM constructor
+     *
+     * @param string $policy PAM policy type: user, api, or plugin-defined policies
+     */
+    public function __construct($policy) {
+        $this->policy = $policy;
+        $this->messages = ['sufficient' => [], 'required' => []];
+    }
 
-	/**
-	 * Authenticate a set of credentials against a policy
-	 * This function will process all registered PAM handlers or stop when the first
-	 * handler fails. A handler fails by either returning false or throwing an
-	 * exception. The advantage of throwing an exception is that it returns a message
-	 * that can be passed to the user. The processing order of the handlers is
-	 * determined by the order that they were registered.
-	 *
-	 * If $credentials are provided, the PAM handler should authenticate using the
-	 * provided credentials. If not, then credentials should be prompted for or
-	 * otherwise retrieved (eg from the HTTP header or $_SESSION).
-	 *
-	 * @param array $credentials Credentials array dependant on policy type
-	 * @return bool
-	 */
-	public function authenticate($credentials = []) {
-		if (!isset(self::$_handlers[$this->policy]) ||
-			!is_array(self::$_handlers[$this->policy])) {
-			return false;
-		}
+    /**
+     * Authenticate a set of credentials against a policy
+     * This function will process all registered PAM handlers or stop when the first
+     * handler fails. A handler fails by either returning false or throwing an
+     * exception. The advantage of throwing an exception is that it returns a message
+     * that can be passed to the user. The processing order of the handlers is
+     * determined by the order that they were registered.
+     *
+     * If $credentials are provided, the PAM handler should authenticate using the
+     * provided credentials. If not, then credentials should be prompted for or
+     * otherwise retrieved (eg from the HTTP header or $_SESSION).
+     *
+     * @param array $credentials Credentials array dependant on policy type
+     * @return bool
+     */
+    public function authenticate($credentials = []) {
+        if (!isset(self::$_handlers[$this->policy]) ||
+            !is_array(self::$_handlers[$this->policy])) {
+            return false;
+        }
 
-		$authenticated = false;
+        $authenticated = false;
 
-		foreach (self::$_handlers[$this->policy] as $v) {
-			$handler = $v->handler;
-			if (!is_callable($handler)) {
-				continue;
-			}
-			/* @var callable $handler */
+        foreach (self::$_handlers[$this->policy] as $v) {
+            $handler = $v->handler;
+            if (!is_callable($handler)) {
+                continue;
+            }
+            /* @var callable $handler */
 
-			$importance = $v->importance;
+            $importance = $v->importance;
 
-			try {
-				// Execute the handler
-				// @todo don't assume $handler is a global function
-				$result = call_user_func($handler, $credentials);
-				if ($result) {
-					$authenticated = true;
-				} elseif ($result === false) {
-					if ($importance == 'required') {
-						$this->messages['required'][] = "$handler:failed";
-						return false;
-					} else {
-						$this->messages['sufficient'][] = "$handler:failed";
-					}
-				}
-			} catch (Exception $e) {
-				if ($importance == 'required') {
-					$this->messages['required'][] = $e->getMessage();
-					return false;
-				} else {
-					$this->messages['sufficient'][] = $e->getMessage();
-				}
-			}
-		}
+            try {
+                // Execute the handler
+                // @todo don't assume $handler is a global function
+                $result = call_user_func($handler, $credentials);
+                if ($result) {
+                    $authenticated = true;
+                } elseif ($result === false) {
+                    if ($importance == 'required') {
+                        $this->messages['required'][] = "$handler:failed";
+                        return false;
+                    } else {
+                        $this->messages['sufficient'][] = "$handler:failed";
+                    }
+                }
+            } catch (Exception $e) {
+                if ($importance == 'required') {
+                    $this->messages['required'][] = $e->getMessage();
+                    return false;
+                } else {
+                    $this->messages['sufficient'][] = $e->getMessage();
+                }
+            }
+        }
 
-		return $authenticated;
-	}
+        return $authenticated;
+    }
 
-	/**
-	 * Get a failure message to display to user
-	 *
-	 * @return string
-	 */
-	public function getFailureMessage() {
-		$message = _elgg_services()->translator->translate('auth:nopams');
-		if (!empty($this->messages['required'])) {
-			$message = $this->messages['required'][0];
-		} elseif (!empty($this->messages['sufficient'])) {
-			$message = $this->messages['sufficient'][0];
-		}
+    /**
+     * Get a failure message to display to user
+     *
+     * @return string
+     */
+    public function getFailureMessage() {
+        $message = _elgg_services()->translator->translate('auth:nopams');
+        if (!empty($this->messages['required'])) {
+            $message = $this->messages['required'][0];
+        } elseif (!empty($this->messages['sufficient'])) {
+            $message = $this->messages['sufficient'][0];
+        }
 
-		return _elgg_services()->hooks->trigger('fail', 'auth', $this->messages, $message);
-	}
+        return _elgg_services()->hooks->trigger('fail', 'auth', $this->messages, $message);
+    }
 }

engine/classes/Elgg/Assets/ExternalFiles.php

Indentation +227 added lines, -227 removed lines

@@ -11,231 +11,231 @@
  */
 class ExternalFiles {
 
-	/**
-	 * @var ElggPriorityList[]
-	 */
-	protected $externals = [];
-
-	/**
-	 * @var array
-	 */
-	protected $externals_map = [];
-
-	/**
-	 * Core registration function for external files
-	 *
-	 * @param string $type     Type of external resource (js or css)
-	 * @param string $name     Identifier used as key
-	 * @param string $url      URL
-	 * @param string $location Location in the page to include the file
-	 * @param int    $priority Loading priority of the file
-	 *
-	 * @return bool
-	 */
-	public function register($type, $name, $url, $location, $priority = 500) {
-		if (empty($name) || empty($url)) {
-			return false;
-		}
-	
-		$url = elgg_normalize_url($url);
-
-		$this->setupType($type);
-	
-		$name = trim(strtolower($name));
-	
-		// normalize bogus priorities, but allow empty, null, and false to be defaults.
-		if (!is_numeric($priority)) {
-			$priority = 500;
-		}
-	
-		// no negative priorities right now.
-		$priority = max((int) $priority, 0);
-	
-		$item = elgg_extract($name, $this->externals_map[$type]);
-	
-		if ($item) {
-			// updating a registered item
-			// don't update loaded because it could already be set
-			$item->url = $url;
-			$item->location = $location;
-	
-			// if loaded before registered, that means it hasn't been added to the list yet
-			if ($this->externals[$type]->contains($item)) {
-				$priority = $this->externals[$type]->move($item, $priority);
-			} else {
-				$priority = $this->externals[$type]->add($item, $priority);
-			}
-		} else {
-			$item = (object) [
-				'loaded' => false,
-				'url' => $url,
-				'location' => $location,
-			];
-			$priority = $this->externals[$type]->add($item, $priority);
-		}
-
-		$this->externals_map[$type][$name] = $item;
-	
-		return $priority !== false;
-	}
-	
-	/**
-	 * Unregister an external file
-	 *
-	 * @param string $type Type of file: js or css
-	 * @param string $name The identifier of the file
-	 *
-	 * @return bool
-	 */
-	public function unregister($type, $name) {
-		$this->setupType($type);
-	
-		$name = trim(strtolower($name));
-		$item = elgg_extract($name, $this->externals_map[$type]);
-	
-		if ($item) {
-			unset($this->externals_map[$type][$name]);
-			return $this->externals[$type]->remove($item);
-		}
-	
-		return false;
-	}
-
-	/**
-	 * Get metadata for a registered file
-	 *
-	 * @param string $type
-	 * @param string $name
-	 *
-	 * @return \stdClass|null
-	 */
-	public function getFile($type, $name) {
-		$this->setupType($type);
-
-		$name = trim(strtolower($name));
-		if (!isset($this->externals_map[$type][$name])) {
-			return null;
-		}
-
-		$item = $this->externals_map[$type][$name];
-		$priority = $this->externals[$type]->getPriority($item);
-
-		// don't allow internal properties to be altered
-		$clone = clone $item;
-		$clone->priority = $priority;
-
-		return $clone;
-	}
-	
-	/**
-	 * Load an external resource for use on this page
-	 *
-	 * @param string $type Type of file: js or css
-	 * @param string $name The identifier for the file
-	 *
-	 * @return void
-	 */
-	public function load($type, $name) {
-		$this->setupType($type);
-	
-		$name = trim(strtolower($name));
-	
-		$item = elgg_extract($name, $this->externals_map[$type]);
-	
-		if ($item) {
-			// update a registered item
-			$item->loaded = true;
-		} else {
-			$item = (object) [
-				'loaded' => true,
-				'url' => '',
-				'location' => '',
-			];
-			if (elgg_view_exists($name)) {
-				$item->url = elgg_get_simplecache_url($name);
-				$item->location = ($type == 'js') ? 'foot' : 'head';
-			}
-
-			$this->externals[$type]->add($item);
-			$this->externals_map[$type][$name] = $item;
-		}
-	}
-	
-	/**
-	 * Get external resource descriptors
-	 *
-	 * @param string $type     Type of file: js or css
-	 * @param string $location Page location
-	 *
-	 * @return string[] URLs of files to load
-	 */
-	public function getLoadedFiles($type, $location) {
-		if (!isset($this->externals[$type])) {
-			return [];
-		}
-
-		$items = $this->externals[$type]->getElements();
-
-		$items = array_filter($items, function($v) use ($location) {
-			return $v->loaded == true && $v->location == $location;
-		});
-		if ($items) {
-			array_walk($items, function(&$v, $k){
-				$v = $v->url;
-			});
-		}
-		return $items;
-	}
-
-	/**
-	 * Get registered file objects
-	 *
-	 * @param string $type     Type of file: js or css
-	 * @param string $location Page location
-	 *
-	 * @return \stdClass[]
-	 */
-	public function getRegisteredFiles($type, $location) {
-		if (!isset($this->externals[$type])) {
-			return [];
-		}
-
-		$ret = [];
-		$items = $this->externals[$type]->getElements();
-		$items = array_filter($items, function($v) use ($location) {
-			return ($v->location == $location);
-		});
-
-		foreach ($items as $item) {
-			$ret[] = clone $item;
-		}
-
-		return $ret;
-	}
-
-	/**
-	 * Unregister all files
-	 *
-	 * @return void
-	 */
-	public function reset() {
-		$this->externals = [];
-		$this->externals_map = [];
-	}
-	
-	/**
-	 * Bootstraps the externals data structure
-	 *
-	 * @param string $type The type of external, js or css.
-	 * @return void
-	 */
-	protected function setupType($type) {
-		if (!isset($this->externals[$type])) {
-			$this->externals[$type] = new \ElggPriorityList();
-		}
-	
-		if (!isset($this->externals_map[$type])) {
-			$this->externals_map[$type] = [];
-		}
-	}
+    /**
+     * @var ElggPriorityList[]
+     */
+    protected $externals = [];
+
+    /**
+     * @var array
+     */
+    protected $externals_map = [];
+
+    /**
+     * Core registration function for external files
+     *
+     * @param string $type     Type of external resource (js or css)
+     * @param string $name     Identifier used as key
+     * @param string $url      URL
+     * @param string $location Location in the page to include the file
+     * @param int    $priority Loading priority of the file
+     *
+     * @return bool
+     */
+    public function register($type, $name, $url, $location, $priority = 500) {
+        if (empty($name) || empty($url)) {
+            return false;
+        }
+	
+        $url = elgg_normalize_url($url);
+
+        $this->setupType($type);
+	
+        $name = trim(strtolower($name));
+	
+        // normalize bogus priorities, but allow empty, null, and false to be defaults.
+        if (!is_numeric($priority)) {
+            $priority = 500;
+        }
+	
+        // no negative priorities right now.
+        $priority = max((int) $priority, 0);
+	
+        $item = elgg_extract($name, $this->externals_map[$type]);
+	
+        if ($item) {
+            // updating a registered item
+            // don't update loaded because it could already be set
+            $item->url = $url;
+            $item->location = $location;
+	
+            // if loaded before registered, that means it hasn't been added to the list yet
+            if ($this->externals[$type]->contains($item)) {
+                $priority = $this->externals[$type]->move($item, $priority);
+            } else {
+                $priority = $this->externals[$type]->add($item, $priority);
+            }
+        } else {
+            $item = (object) [
+                'loaded' => false,
+                'url' => $url,
+                'location' => $location,
+            ];
+            $priority = $this->externals[$type]->add($item, $priority);
+        }
+
+        $this->externals_map[$type][$name] = $item;
+	
+        return $priority !== false;
+    }
+	
+    /**
+     * Unregister an external file
+     *
+     * @param string $type Type of file: js or css
+     * @param string $name The identifier of the file
+     *
+     * @return bool
+     */
+    public function unregister($type, $name) {
+        $this->setupType($type);
+	
+        $name = trim(strtolower($name));
+        $item = elgg_extract($name, $this->externals_map[$type]);
+	
+        if ($item) {
+            unset($this->externals_map[$type][$name]);
+            return $this->externals[$type]->remove($item);
+        }
+	
+        return false;
+    }
+
+    /**
+     * Get metadata for a registered file
+     *
+     * @param string $type
+     * @param string $name
+     *
+     * @return \stdClass|null
+     */
+    public function getFile($type, $name) {
+        $this->setupType($type);
+
+        $name = trim(strtolower($name));
+        if (!isset($this->externals_map[$type][$name])) {
+            return null;
+        }
+
+        $item = $this->externals_map[$type][$name];
+        $priority = $this->externals[$type]->getPriority($item);
+
+        // don't allow internal properties to be altered
+        $clone = clone $item;
+        $clone->priority = $priority;
+
+        return $clone;
+    }
+	
+    /**
+     * Load an external resource for use on this page
+     *
+     * @param string $type Type of file: js or css
+     * @param string $name The identifier for the file
+     *
+     * @return void
+     */
+    public function load($type, $name) {
+        $this->setupType($type);
+	
+        $name = trim(strtolower($name));
+	
+        $item = elgg_extract($name, $this->externals_map[$type]);
+	
+        if ($item) {
+            // update a registered item
+            $item->loaded = true;
+        } else {
+            $item = (object) [
+                'loaded' => true,
+                'url' => '',
+                'location' => '',
+            ];
+            if (elgg_view_exists($name)) {
+                $item->url = elgg_get_simplecache_url($name);
+                $item->location = ($type == 'js') ? 'foot' : 'head';
+            }
+
+            $this->externals[$type]->add($item);
+            $this->externals_map[$type][$name] = $item;
+        }
+    }
+	
+    /**
+     * Get external resource descriptors
+     *
+     * @param string $type     Type of file: js or css
+     * @param string $location Page location
+     *
+     * @return string[] URLs of files to load
+     */
+    public function getLoadedFiles($type, $location) {
+        if (!isset($this->externals[$type])) {
+            return [];
+        }
+
+        $items = $this->externals[$type]->getElements();
+
+        $items = array_filter($items, function($v) use ($location) {
+            return $v->loaded == true && $v->location == $location;
+        });
+        if ($items) {
+            array_walk($items, function(&$v, $k){
+                $v = $v->url;
+            });
+        }
+        return $items;
+    }
+
+    /**
+     * Get registered file objects
+     *
+     * @param string $type     Type of file: js or css
+     * @param string $location Page location
+     *
+     * @return \stdClass[]
+     */
+    public function getRegisteredFiles($type, $location) {
+        if (!isset($this->externals[$type])) {
+            return [];
+        }
+
+        $ret = [];
+        $items = $this->externals[$type]->getElements();
+        $items = array_filter($items, function($v) use ($location) {
+            return ($v->location == $location);
+        });
+
+        foreach ($items as $item) {
+            $ret[] = clone $item;
+        }
+
+        return $ret;
+    }
+
+    /**
+     * Unregister all files
+     *
+     * @return void
+     */
+    public function reset() {
+        $this->externals = [];
+        $this->externals_map = [];
+    }
+	
+    /**
+     * Bootstraps the externals data structure
+     *
+     * @param string $type The type of external, js or css.
+     * @return void
+     */
+    protected function setupType($type) {
+        if (!isset($this->externals[$type])) {
+            $this->externals[$type] = new \ElggPriorityList();
+        }
+	
+        if (!isset($this->externals_map[$type])) {
+            $this->externals_map[$type] = [];
+        }
+    }
 }

views/default/languages.js.php

Indentation +4 added lines, -4 removed lines

@@ -9,13 +9,13 @@
 $translations = $all_translations['en'];
 
 if ($language != 'en' && !isset($all_translations[$language])) {
-	// try to reload missing translations
-	reload_all_translations();
-	$all_translations = _elgg_services()->translator->getLoadedTranslations();
+    // try to reload missing translations
+    reload_all_translations();
+    $all_translations = _elgg_services()->translator->getLoadedTranslations();
 }
 
 if ($language != 'en' && isset($all_translations[$language])) {
-	$translations = array_merge($translations, $all_translations[$language]);
+    $translations = array_merge($translations, $all_translations[$language]);
 }
 
 ?>

engine/lib/actions.php

Doc Comments +2 added lines, -2 removed lines

@@ -151,7 +151,7 @@ 
  *
  * @param string $action The action being performed
  *
- * @return mixed True if valid or redirects.
+ * @return boolean True if valid or redirects.
  * @access private
  */
 function action_gatekeeper($action) {
@@ -182,7 +182,7 @@ 
 /**
  * Regenerate a new site key (32 bytes: "z" to indicate format + 186-bit key in Base64 URL).
  *
- * @return mixed The site secret hash
+ * @return string The site secret hash
  * @access private
  */
 function init_site_secret() {

Indentation +27 added lines, -27 removed lines

@@ -20,7 +20,7 @@ 
  * @access private
  */
 function _elgg_action_handler(array $segments) {
-	return _elgg_services()->actions->execute(implode('/', $segments));
+    return _elgg_services()->actions->execute(implode('/', $segments));
 }
 
 /**
@@ -52,12 +52,12 @@ 
  * @access private
  */
 function action($action, $forwarder = "") {
-	$response = _elgg_services()->actions->execute($action, $forwarder);
-	if ($response instanceof ResponseBuilder) {
-		// in case forward() wasn't called in the action
-		_elgg_services()->responseFactory->respond($response);
-	}
-	_elgg_services()->responseFactory->redirect(REFERRER, 'csrf');
+    $response = _elgg_services()->actions->execute($action, $forwarder);
+    if ($response instanceof ResponseBuilder) {
+        // in case forward() wasn't called in the action
+        _elgg_services()->responseFactory->respond($response);
+    }
+    _elgg_services()->responseFactory->redirect(REFERRER, 'csrf');
 }
 
 /**
@@ -87,7 +87,7 @@ 
  * @return bool
  */
 function elgg_register_action($action, $filename = "", $access = 'logged_in') {
-	return _elgg_services()->actions->register($action, $filename, $access);
+    return _elgg_services()->actions->register($action, $filename, $access);
 }
 
 /**
@@ -98,7 +98,7 @@ 
  * @since 1.8.1
  */
 function elgg_unregister_action($action) {
-	return _elgg_services()->actions->unregister($action);
+    return _elgg_services()->actions->unregister($action);
 }
 
 /**
@@ -109,7 +109,7 @@ 
  * @since 1.11
  */
 function elgg_build_hmac($data) {
-	return _elgg_services()->hmac->getHmac($data);
+    return _elgg_services()->hmac->getHmac($data);
 }
 
 /**
@@ -129,7 +129,7 @@ 
  * @access private
  */
 function validate_action_token($visible_errors = true, $token = null, $ts = null) {
-	return _elgg_services()->actions->validateActionToken($visible_errors, $token, $ts);
+    return _elgg_services()->actions->validateActionToken($visible_errors, $token, $ts);
 }
 
 /**
@@ -147,7 +147,7 @@ 
  * @access private
  */
 function action_gatekeeper($action) {
-	return _elgg_services()->actions->gatekeeper($action);
+    return _elgg_services()->actions->gatekeeper($action);
 }
 
 /**
@@ -168,7 +168,7 @@ 
  * @return string|false
  */
 function generate_action_token($timestamp) {
-	return _elgg_services()->actions->generateActionToken($timestamp);
+    return _elgg_services()->actions->generateActionToken($timestamp);
 }
 
 /**
@@ -178,9 +178,9 @@ 
  * @access private
  */
 function init_site_secret() {
-	$secret = SiteSecret::regenerate(_elgg_services()->crypto, _elgg_services()->configTable);
-	_elgg_services()->setValue('siteSecret', $secret);
-	return $secret->get();
+    $secret = SiteSecret::regenerate(_elgg_services()->crypto, _elgg_services()->configTable);
+    _elgg_services()->setValue('siteSecret', $secret);
+    return $secret->get();
 }
 
 /**
@@ -190,7 +190,7 @@ 
  * @access private
  */
 function _elgg_get_site_secret_strength() {
-	return _elgg_services()->siteSecret->getStrength();
+    return _elgg_services()->siteSecret->getStrength();
 }
 
 /**
@@ -202,7 +202,7 @@ 
  * @since 1.8.0
  */
 function elgg_action_exists($action) {
-	return _elgg_services()->actions->exists($action);
+    return _elgg_services()->actions->exists($action);
 }
 
 /**
@@ -212,7 +212,7 @@ 
  * @since 1.8.0
  */
 function elgg_is_xhr() {
-	return _elgg_services()->request->isXmlHttpRequest();
+    return _elgg_services()->request->isXmlHttpRequest();
 }
 
 /**
@@ -243,8 +243,8 @@ 
  * @deprecated 2.3
  */
 function ajax_forward_hook($hook, $type, $reason, $params) {
-	elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and is no longer used as a plugin hook handler', '2.3');
-	_elgg_services()->actions->ajaxForwardHook($hook, $type, $reason, $params);
+    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and is no longer used as a plugin hook handler', '2.3');
+    _elgg_services()->actions->ajaxForwardHook($hook, $type, $reason, $params);
 }
 
 /**
@@ -254,8 +254,8 @@ 
  * @deprecated 2.3
  */
 function ajax_action_hook() {
-	elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and is no longer used as a plugin hook handler', '2.3');
-	_elgg_services()->actions->ajaxActionHook();
+    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated and is no longer used as a plugin hook handler', '2.3');
+    _elgg_services()->actions->ajaxActionHook();
 }
 
 /**
@@ -265,7 +265,7 @@ 
  * @access private
  */
 function _elgg_csrf_token_refresh() {
-	return _elgg_services()->actions->handleTokenRefreshRequest();
+    return _elgg_services()->actions->handleTokenRefreshRequest();
 }
 
 /**
@@ -273,13 +273,13 @@ 
  * @access private
  */
 function actions_init() {
-	elgg_register_page_handler('action', '_elgg_action_handler');
-	elgg_register_page_handler('refresh_token', '_elgg_csrf_token_refresh');
+    elgg_register_page_handler('action', '_elgg_action_handler');
+    elgg_register_page_handler('refresh_token', '_elgg_csrf_token_refresh');
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('init', 'system', 'actions_init');
+    $events->registerHandler('init', 'system', 'actions_init');
 };

engine/classes/Elgg/Application.php

Doc Comments +3 added lines, -3 removed lines

@@ -453,7 +453,7 @@ 
 	/**
 	 * Elgg's front controller. Handles basically all incoming URL requests.
 	 *
-	 * @return bool True if Elgg will handle the request, false if the server should (PHP-CLI server)
+	 * @return boolean|null True if Elgg will handle the request, false if the server should (PHP-CLI server)
 	 */
 	public static function index() {
 		$req = Request::createFromGlobals();
@@ -470,7 +470,7 @@ 
 	/**
 	 * Routes the request, booting core if not yet booted
 	 *
-	 * @return bool False if Elgg wants the PHP CLI server to handle the request
+	 * @return boolean|null False if Elgg wants the PHP CLI server to handle the request
 	 */
 	public function run() {
 		$config = $this->services->config;
@@ -781,7 +781,7 @@ 
 	 * @param int    $linenum  The line number the error was raised at
 	 * @param array  $vars     An array that points to the active symbol table where error occurred
 	 *
-	 * @return true
+	 * @return boolean
 	 * @throws \Exception
 	 * @access private
 	 */

Indentation +880 added lines, -880 removed lines

@@ -25,886 +25,886 @@
  */
 class Application {
 
-	const DEFAULT_LANG = 'en';
-	const DEFAULT_LIMIT = 10;
-
-	/**
-	 * @var ServiceProvider
-	 */
-	private $services;
-
-	/**
-	 * @var bool
-	 */
-	private static $core_loaded = false;
-
-	/**
-	 * @var bool
-	 */
-	private static $testing_app;
-
-	/**
-	 * Property names of the service provider to be exposed via __get()
-	 *
-	 * E.g. the presence of `'foo' => true` in the list would allow _elgg_services()->foo to
-	 * be accessed via elgg()->foo.
-	 *
-	 * @var string[]
-	 */
-	private static $public_services = [
-		//'config' => true,
-		'menus' => true,
-		'table_columns' => true,
-	];
-
-	/**
-	 * Reference to the loaded Application returned by elgg()
-	 *
-	 * @internal Do not use this. use elgg() to access the application
-	 * @access private
-	 * @var Application
-	 */
-	public static $_instance;
-
-	/**
-	 * Constructor
-	 *
-	 * Upon construction, no actions are taken to load or boot Elgg.
-	 *
-	 * @param ServiceProvider $services Elgg services provider
-	 * @throws ConfigurationException
-	 */
-	public function __construct(ServiceProvider $services) {
-		$this->services = $services;
-		$services->setValue('app', $this);
-
-		$this->initConfig();
-	}
-
-	/**
-	 * Validate, normalize, fill in missing values, and lock some
-	 *
-	 * @return void
-	 * @throws ConfigurationException
-	 */
-	private function initConfig() {
-		$config = $this->services->config;
-
-		if ($config->elgg_config_locks === null) {
-			$config->elgg_config_locks = true;
-		}
-
-		if ($config->elgg_config_locks) {
-			$lock = function ($name) use ($config) {
-				$config->lock($name);
-			};
-		} else {
-			// the installer needs to build an application with defaults then update
-			// them after they're validated, so we don't want to lock them.
-			$lock = function () {
-			};
-		}
-
-		$this->services->timer->begin([]);
-
-		// Until DB loads, let's log problems
-		if ($config->debug === null) {
-			$config->debug = 'NOTICE';
-		}
-
-		if ($config->dataroot) {
-			$config->dataroot = rtrim($config->dataroot, '\\/') . DIRECTORY_SEPARATOR;
-		} else {
-			if (!$config->installer_running) {
-				throw new ConfigurationException('Config value "dataroot" is required.');
-			}
-		}
-		$lock('dataroot');
-
-		if ($config->cacheroot) {
-			$config->cacheroot = rtrim($config->cacheroot, '\\/') . DIRECTORY_SEPARATOR;
-		} else {
-			$config->cacheroot = $config->dataroot;
-		}
-		$lock('cacheroot');
-
-		if ($config->wwwroot) {
-			$config->wwwroot = rtrim($config->wwwroot, '/') . '/';
-		} else {
-			$config->wwwroot = $this->services->request->sniffElggUrl();
-		}
-		$lock('wwwroot');
-
-		if (!$config->language) {
-			$config->language = self::DEFAULT_LANG;
-		}
-
-		if ($config->default_limit) {
-			$lock('default_limit');
-		} else {
-			$config->default_limit = self::DEFAULT_LIMIT;
-		}
-
-		$locked_props = [
-			'site_guid' => 1,
-			'path' => Paths::project(),
-			'plugins_path' => Paths::project() . "mod/",
-			'pluginspath' => Paths::project() . "mod/",
-			'url' => $config->wwwroot,
-		];
-		foreach ($locked_props as $name => $value) {
-			$config->$name = $value;
-			$lock($name);
-		}
-
-		// move sensitive credentials into isolated services
-		$this->services->dbConfig;
-
-		// If the site secret is in the settings file, let's move it to that component
-		// right away to keep this value out of config.
-		$secret = SiteSecret::fromConfig($config);
-		if ($secret) {
-			$this->services->setValue('siteSecret', $secret);
-			$config->elgg_config_set_secret = true;
-		}
-
-		$config->boot_complete = false;
-	}
-
-	/**
-	 * Get the DB credentials.
-	 *
-	 * We no longer leave DB credentials in the config in case it gets accidentally dumped.
-	 *
-	 * @return \Elgg\Database\DbConfig
-	 */
-	public function getDbConfig() {
-		return $this->services->dbConfig;
-	}
-
-	/**
-	 * Define all Elgg global functions and constants, wire up boot events, but don't boot
-	 *
-	 * This includes all the .php files in engine/lib (not upgrades). If a script returns a function,
-	 * it is queued and executed at the end.
-	 *
-	 * @return void
-	 * @access private
-	 * @internal
-	 * @throws \InstallationException
-	 */
-	public function loadCore() {
-		if (self::$core_loaded) {
-			return;
-		}
-
-		$setups = [];
-		$path = Paths::elgg() . 'engine/lib';
-
-		// include library files, capturing setup functions
-		foreach (self::getEngineLibs() as $file) {
-			$return = Includer::includeFile("$path/$file");
-			if (!$return) {
-				throw new \InstallationException("Elgg lib file failed include: engine/lib/$file");
-			}
-			if ($return instanceof \Closure) {
-				$setups[$file] = $return;
-			}
-		}
-
-		// store instance to be returned by elgg()
-		self::$_instance = $this;
-
-		// allow global services access. :(
-		_elgg_services($this->services);
-
-		// setup logger and inject into config
-		//$this->services->config->setLogger($this->services->logger);
-
-		$hooks = $this->services->hooks;
-		$events = $hooks->getEvents();
-
-		// run setups
-		foreach ($setups as $func) {
-			$func($events, $hooks);
-		}
-
-		self::$core_loaded = true;
-	}
-
-	/**
-	 * Start and boot the core
-	 *
-	 * @return self
-	 */
-	public static function start() {
-		$app = self::factory();
-		$app->bootCore();
-		return $app;
-	}
-
-	/**
-	 * Bootstrap the Elgg engine, loads plugins, and calls initial system events
-	 *
-	 * This method loads the full Elgg engine, checks the installation
-	 * state, and triggers a series of events to finish booting Elgg:
-	 * 	- {@elgg_event boot system}
-	 * 	- {@elgg_event init system}
-	 * 	- {@elgg_event ready system}
-	 *
-	 * If Elgg is not fully installed, the browser will be redirected to an installation page.
-	 *
-	 * @return void
-	 */
-	public function bootCore() {
-		$config = $this->services->config;
-
-		if ($this->isTestingApplication()) {
-			throw new \RuntimeException('Unit tests should not call ' . __METHOD__);
-		}
-
-		if ($config->boot_complete) {
-			return;
-		}
-
-		// in case not loaded already
-		$this->loadCore();
-
-		if (!$this->services->db) {
-			// no database boot!
-			elgg_views_boot();
-			$this->services->session->start();
-			$this->services->translator->loadTranslations();
-
-			actions_init();
-			_elgg_init();
-			_elgg_input_init();
-			_elgg_nav_init();
-
-			$config->boot_complete = true;
-			$config->lock('boot_complete');
-			return;
-		}
-
-		// Connect to database, load language files, load configuration, init session
-		$this->services->boot->boot($this->services);
-
-		elgg_views_boot();
-
-		// Load the plugins that are active
-		$this->services->plugins->load();
-
-		if (Paths::project() != Paths::elgg()) {
-			// Elgg is installed as a composer dep, so try to treat the root directory
-			// as a custom plugin that is always loaded last and can't be disabled...
-			if (!$config->system_cache_loaded) {
-				// configure view locations for the custom plugin (not Elgg core)
-				$viewsFile = Paths::project() . 'views.php';
-				if (is_file($viewsFile)) {
-					$viewsSpec = Includer::includeFile($viewsFile);
-					if (is_array($viewsSpec)) {
-						$this->services->views->mergeViewsSpec($viewsSpec);
-					}
-				}
-
-				// find views for the custom plugin (not Elgg core)
-				$this->services->views->registerPluginViews(Paths::project());
-			}
-
-			if (!$config->i18n_loaded_from_cache) {
-				$this->services->translator->registerPluginTranslations(Paths::project());
-			}
-
-			// This is root directory start.php
-			$root_start = Paths::project() . "start.php";
-			if (is_file($root_start)) {
-				require $root_start;
-			}
-		}
-
-		// after plugins are started we know which viewtypes are populated
-		$this->services->views->clampViewtypeToPopulatedViews();
-
-		$this->allowPathRewrite();
-
-		$events = $this->services->hooks->getEvents();
-
-		// Allows registering handlers strictly before all init, system handlers
-		$events->trigger('plugins_boot', 'system');
-
-		// Complete the boot process for both engine and plugins
-		$events->trigger('init', 'system');
-
-		$config->boot_complete = true;
-		$config->lock('boot_complete');
-
-		// System loaded and ready
-		$events->trigger('ready', 'system');
-	}
-
-	/**
-	 * Get a Database wrapper for performing queries without booting Elgg
-	 *
-	 * If settings has not been loaded, it will be loaded to configure the DB connection.
-	 *
-	 * @note Before boot, the Database instance will not yet be bound to a Logger.
-	 *
-	 * @return \Elgg\Application\Database
-	 */
-	public function getDb() {
-		return $this->services->publicDb;
-	}
-
-	/**
-	 * Get an undefined property
-	 *
-	 * @param string $name The property name accessed
-	 *
-	 * @return mixed
-	 */
-	public function __get($name) {
-		if (isset(self::$public_services[$name])) {
-			return $this->services->{$name};
-		}
-		trigger_error("Undefined property: " . __CLASS__ . ":\${$name}");
-	}
-
-	/**
-	 * Creates a new, trivial instance of Elgg\Application and set it as the singleton instance.
-	 * If the singleton is already set, it's returned.
-	 *
-	 * @param array $spec Specification for initial call.
-	 * @return self
-	 * @throws ConfigurationException
-	 */
-	public static function factory(array $spec = []) {
-		if (self::$_instance !== null) {
-			return self::$_instance;
-		}
-
-		$defaults = [
-			'service_provider' => null,
-			'config' => null,
-			'settings_path' => null,
-			'handle_exceptions' => true,
-			'handle_shutdown' => true,
-			'overwrite_global_config' => true,
-			'set_start_time' => true,
-			'request' => null,
-		];
-		$spec = array_merge($defaults, $spec);
-
-		if ($spec['set_start_time']) {
-			/**
-			 * The time with microseconds when the Elgg engine was started.
-			 *
-			 * @global float
-			 */
-			if (!isset($GLOBALS['START_MICROTIME'])) {
-				$GLOBALS['START_MICROTIME'] = microtime(true);
-			}
-		}
-
-		if (!$spec['service_provider']) {
-			if (!$spec['config']) {
-				$spec['config'] = Config::factory($spec['settings_path']);
-			}
-			$spec['service_provider'] = new ServiceProvider($spec['config']);
-		}
-
-		if ($spec['request']) {
-			if ($spec['request'] instanceof Request) {
-				$spec['service_provider']->setValue('request', $spec['request']);
-			} else {
-				throw new \InvalidArgumentException("Given request is not a " . Request::class);
-			}
-		}
-
-		self::$_instance = new self($spec['service_provider']);
-
-		if ($spec['handle_exceptions']) {
-			set_error_handler([self::$_instance, 'handleErrors']);
-			set_exception_handler([self::$_instance, 'handleExceptions']);
-		}
-
-		if ($spec['handle_shutdown']) {
-			// we need to register for shutdown before Symfony registers the
-			// session_write_close() function. https://github.com/Elgg/Elgg/issues/9243
-			register_shutdown_function(function () {
-				// There are cases where we may exit before this function is defined
-				if (function_exists('_elgg_shutdown_hook')) {
-					_elgg_shutdown_hook();
-				}
-			});
-		}
-
-		if ($spec['overwrite_global_config']) {
-			global $CONFIG;
-
-			// this will be buggy be at least PHP will log failures
-			$CONFIG = $spec['service_provider']->config;
-		}
-
-		return self::$_instance;
-	}
-
-	/**
-	 * Elgg's front controller. Handles basically all incoming URL requests.
-	 *
-	 * @return bool True if Elgg will handle the request, false if the server should (PHP-CLI server)
-	 */
-	public static function index() {
-		$req = Request::createFromGlobals();
-		/** @var Request $req */
-
-		if ($req->isRewriteCheck()) {
-			echo Request::REWRITE_TEST_OUTPUT;
-			return true;
-		}
-
-		return self::factory(['request' => $req])->run();
-	}
-
-	/**
-	 * Routes the request, booting core if not yet booted
-	 *
-	 * @return bool False if Elgg wants the PHP CLI server to handle the request
-	 */
-	public function run() {
-		$config = $this->services->config;
-		$request = $this->services->request;
-
-		if ($request->isCliServer()) {
-			if ($request->isCliServable(Paths::project())) {
-				return false;
-			}
-
-			// overwrite value from settings
-			$www_root = rtrim($request->getSchemeAndHttpHost() . $request->getBaseUrl(), '/') . '/';
-			$config->wwwroot = $www_root;
-			$config->wwwroot_cli_server = $www_root;
-		}
-
-		if (0 === strpos($request->getElggPath(), '/cache/')) {
-			$this->services->cacheHandler->handleRequest($request)->prepare($request)->send();
-			return true;
-		}
-
-		if (0 === strpos($request->getElggPath(), '/serve-file/')) {
-			$this->services->serveFileHandler->getResponse($request)->send();
-			return true;
-		}
-
-		$this->bootCore();
-
-		// TODO use formal Response object instead
-		// This is to set the charset to UTF-8.
-		header("Content-Type: text/html;charset=utf-8", true);
-
-		// re-fetch new request from services in case it was replaced by route:rewrite
-		$request = $this->services->request;
-
-		if (!$this->services->router->route($request)) {
-			forward('', '404');
-		}
-	}
-
-	/**
-	 * Returns a directory that points to the root of Elgg, but not necessarily
-	 * the install root. See `self::root()` for that.
-	 *
-	 * @return Directory
-	 */
-	public static function elggDir() {
-		return Local::elggRoot();
-	}
-
-	/**
-	 * Returns a directory that points to the project root, where composer is installed.
-	 *
-	 * @return Directory
-	 */
-	public static function projectDir() {
-		return Local::projectRoot();
-	}
-
-	/**
-	 * Renders a web UI for installing Elgg.
-	 *
-	 * @return void
-	 */
-	public static function install() {
-		ini_set('display_errors', 1);
-		$installer = new \ElggInstaller();
-		$installer->run();
-	}
-
-	/**
-	 * Elgg upgrade script.
-	 *
-	 * This script triggers any necessary upgrades. If the site has been upgraded
-	 * to the most recent version of the code, no upgrades are run but the caches
-	 * are flushed.
-	 *
-	 * Upgrades use a table {db_prefix}upgrade_lock as a mutex to prevent concurrent upgrades.
-	 *
-	 * The URL to forward to after upgrades are complete can be specified by setting $_GET['forward']
-	 * to a relative URL.
-	 *
-	 * @return void
-	 */
-	public static function upgrade() {
-		// we want to know if an error occurs
-		ini_set('display_errors', 1);
-		$is_cli = (php_sapi_name() === 'cli');
-
-		$forward = function ($url) use ($is_cli) {
-			if ($is_cli) {
-				echo "Open $url in your browser to continue.";
-				exit;
-			}
-
-			forward($url);
-		};
-
-		define('UPGRADING', 'upgrading');
-
-		self::start();
+    const DEFAULT_LANG = 'en';
+    const DEFAULT_LIMIT = 10;
+
+    /**
+     * @var ServiceProvider
+     */
+    private $services;
+
+    /**
+     * @var bool
+     */
+    private static $core_loaded = false;
+
+    /**
+     * @var bool
+     */
+    private static $testing_app;
+
+    /**
+     * Property names of the service provider to be exposed via __get()
+     *
+     * E.g. the presence of `'foo' => true` in the list would allow _elgg_services()->foo to
+     * be accessed via elgg()->foo.
+     *
+     * @var string[]
+     */
+    private static $public_services = [
+        //'config' => true,
+        'menus' => true,
+        'table_columns' => true,
+    ];
+
+    /**
+     * Reference to the loaded Application returned by elgg()
+     *
+     * @internal Do not use this. use elgg() to access the application
+     * @access private
+     * @var Application
+     */
+    public static $_instance;
+
+    /**
+     * Constructor
+     *
+     * Upon construction, no actions are taken to load or boot Elgg.
+     *
+     * @param ServiceProvider $services Elgg services provider
+     * @throws ConfigurationException
+     */
+    public function __construct(ServiceProvider $services) {
+        $this->services = $services;
+        $services->setValue('app', $this);
+
+        $this->initConfig();
+    }
+
+    /**
+     * Validate, normalize, fill in missing values, and lock some
+     *
+     * @return void
+     * @throws ConfigurationException
+     */
+    private function initConfig() {
+        $config = $this->services->config;
+
+        if ($config->elgg_config_locks === null) {
+            $config->elgg_config_locks = true;
+        }
+
+        if ($config->elgg_config_locks) {
+            $lock = function ($name) use ($config) {
+                $config->lock($name);
+            };
+        } else {
+            // the installer needs to build an application with defaults then update
+            // them after they're validated, so we don't want to lock them.
+            $lock = function () {
+            };
+        }
+
+        $this->services->timer->begin([]);
+
+        // Until DB loads, let's log problems
+        if ($config->debug === null) {
+            $config->debug = 'NOTICE';
+        }
+
+        if ($config->dataroot) {
+            $config->dataroot = rtrim($config->dataroot, '\\/') . DIRECTORY_SEPARATOR;
+        } else {
+            if (!$config->installer_running) {
+                throw new ConfigurationException('Config value "dataroot" is required.');
+            }
+        }
+        $lock('dataroot');
+
+        if ($config->cacheroot) {
+            $config->cacheroot = rtrim($config->cacheroot, '\\/') . DIRECTORY_SEPARATOR;
+        } else {
+            $config->cacheroot = $config->dataroot;
+        }
+        $lock('cacheroot');
+
+        if ($config->wwwroot) {
+            $config->wwwroot = rtrim($config->wwwroot, '/') . '/';
+        } else {
+            $config->wwwroot = $this->services->request->sniffElggUrl();
+        }
+        $lock('wwwroot');
+
+        if (!$config->language) {
+            $config->language = self::DEFAULT_LANG;
+        }
+
+        if ($config->default_limit) {
+            $lock('default_limit');
+        } else {
+            $config->default_limit = self::DEFAULT_LIMIT;
+        }
+
+        $locked_props = [
+            'site_guid' => 1,
+            'path' => Paths::project(),
+            'plugins_path' => Paths::project() . "mod/",
+            'pluginspath' => Paths::project() . "mod/",
+            'url' => $config->wwwroot,
+        ];
+        foreach ($locked_props as $name => $value) {
+            $config->$name = $value;
+            $lock($name);
+        }
+
+        // move sensitive credentials into isolated services
+        $this->services->dbConfig;
+
+        // If the site secret is in the settings file, let's move it to that component
+        // right away to keep this value out of config.
+        $secret = SiteSecret::fromConfig($config);
+        if ($secret) {
+            $this->services->setValue('siteSecret', $secret);
+            $config->elgg_config_set_secret = true;
+        }
+
+        $config->boot_complete = false;
+    }
+
+    /**
+     * Get the DB credentials.
+     *
+     * We no longer leave DB credentials in the config in case it gets accidentally dumped.
+     *
+     * @return \Elgg\Database\DbConfig
+     */
+    public function getDbConfig() {
+        return $this->services->dbConfig;
+    }
+
+    /**
+     * Define all Elgg global functions and constants, wire up boot events, but don't boot
+     *
+     * This includes all the .php files in engine/lib (not upgrades). If a script returns a function,
+     * it is queued and executed at the end.
+     *
+     * @return void
+     * @access private
+     * @internal
+     * @throws \InstallationException
+     */
+    public function loadCore() {
+        if (self::$core_loaded) {
+            return;
+        }
+
+        $setups = [];
+        $path = Paths::elgg() . 'engine/lib';
+
+        // include library files, capturing setup functions
+        foreach (self::getEngineLibs() as $file) {
+            $return = Includer::includeFile("$path/$file");
+            if (!$return) {
+                throw new \InstallationException("Elgg lib file failed include: engine/lib/$file");
+            }
+            if ($return instanceof \Closure) {
+                $setups[$file] = $return;
+            }
+        }
+
+        // store instance to be returned by elgg()
+        self::$_instance = $this;
+
+        // allow global services access. :(
+        _elgg_services($this->services);
+
+        // setup logger and inject into config
+        //$this->services->config->setLogger($this->services->logger);
+
+        $hooks = $this->services->hooks;
+        $events = $hooks->getEvents();
+
+        // run setups
+        foreach ($setups as $func) {
+            $func($events, $hooks);
+        }
+
+        self::$core_loaded = true;
+    }
+
+    /**
+     * Start and boot the core
+     *
+     * @return self
+     */
+    public static function start() {
+        $app = self::factory();
+        $app->bootCore();
+        return $app;
+    }
+
+    /**
+     * Bootstrap the Elgg engine, loads plugins, and calls initial system events
+     *
+     * This method loads the full Elgg engine, checks the installation
+     * state, and triggers a series of events to finish booting Elgg:
+     * 	- {@elgg_event boot system}
+     * 	- {@elgg_event init system}
+     * 	- {@elgg_event ready system}
+     *
+     * If Elgg is not fully installed, the browser will be redirected to an installation page.
+     *
+     * @return void
+     */
+    public function bootCore() {
+        $config = $this->services->config;
+
+        if ($this->isTestingApplication()) {
+            throw new \RuntimeException('Unit tests should not call ' . __METHOD__);
+        }
+
+        if ($config->boot_complete) {
+            return;
+        }
+
+        // in case not loaded already
+        $this->loadCore();
+
+        if (!$this->services->db) {
+            // no database boot!
+            elgg_views_boot();
+            $this->services->session->start();
+            $this->services->translator->loadTranslations();
+
+            actions_init();
+            _elgg_init();
+            _elgg_input_init();
+            _elgg_nav_init();
+
+            $config->boot_complete = true;
+            $config->lock('boot_complete');
+            return;
+        }
+
+        // Connect to database, load language files, load configuration, init session
+        $this->services->boot->boot($this->services);
+
+        elgg_views_boot();
+
+        // Load the plugins that are active
+        $this->services->plugins->load();
+
+        if (Paths::project() != Paths::elgg()) {
+            // Elgg is installed as a composer dep, so try to treat the root directory
+            // as a custom plugin that is always loaded last and can't be disabled...
+            if (!$config->system_cache_loaded) {
+                // configure view locations for the custom plugin (not Elgg core)
+                $viewsFile = Paths::project() . 'views.php';
+                if (is_file($viewsFile)) {
+                    $viewsSpec = Includer::includeFile($viewsFile);
+                    if (is_array($viewsSpec)) {
+                        $this->services->views->mergeViewsSpec($viewsSpec);
+                    }
+                }
+
+                // find views for the custom plugin (not Elgg core)
+                $this->services->views->registerPluginViews(Paths::project());
+            }
+
+            if (!$config->i18n_loaded_from_cache) {
+                $this->services->translator->registerPluginTranslations(Paths::project());
+            }
+
+            // This is root directory start.php
+            $root_start = Paths::project() . "start.php";
+            if (is_file($root_start)) {
+                require $root_start;
+            }
+        }
+
+        // after plugins are started we know which viewtypes are populated
+        $this->services->views->clampViewtypeToPopulatedViews();
+
+        $this->allowPathRewrite();
+
+        $events = $this->services->hooks->getEvents();
+
+        // Allows registering handlers strictly before all init, system handlers
+        $events->trigger('plugins_boot', 'system');
+
+        // Complete the boot process for both engine and plugins
+        $events->trigger('init', 'system');
+
+        $config->boot_complete = true;
+        $config->lock('boot_complete');
+
+        // System loaded and ready
+        $events->trigger('ready', 'system');
+    }
+
+    /**
+     * Get a Database wrapper for performing queries without booting Elgg
+     *
+     * If settings has not been loaded, it will be loaded to configure the DB connection.
+     *
+     * @note Before boot, the Database instance will not yet be bound to a Logger.
+     *
+     * @return \Elgg\Application\Database
+     */
+    public function getDb() {
+        return $this->services->publicDb;
+    }
+
+    /**
+     * Get an undefined property
+     *
+     * @param string $name The property name accessed
+     *
+     * @return mixed
+     */
+    public function __get($name) {
+        if (isset(self::$public_services[$name])) {
+            return $this->services->{$name};
+        }
+        trigger_error("Undefined property: " . __CLASS__ . ":\${$name}");
+    }
+
+    /**
+     * Creates a new, trivial instance of Elgg\Application and set it as the singleton instance.
+     * If the singleton is already set, it's returned.
+     *
+     * @param array $spec Specification for initial call.
+     * @return self
+     * @throws ConfigurationException
+     */
+    public static function factory(array $spec = []) {
+        if (self::$_instance !== null) {
+            return self::$_instance;
+        }
+
+        $defaults = [
+            'service_provider' => null,
+            'config' => null,
+            'settings_path' => null,
+            'handle_exceptions' => true,
+            'handle_shutdown' => true,
+            'overwrite_global_config' => true,
+            'set_start_time' => true,
+            'request' => null,
+        ];
+        $spec = array_merge($defaults, $spec);
+
+        if ($spec['set_start_time']) {
+            /**
+             * The time with microseconds when the Elgg engine was started.
+             *
+             * @global float
+             */
+            if (!isset($GLOBALS['START_MICROTIME'])) {
+                $GLOBALS['START_MICROTIME'] = microtime(true);
+            }
+        }
+
+        if (!$spec['service_provider']) {
+            if (!$spec['config']) {
+                $spec['config'] = Config::factory($spec['settings_path']);
+            }
+            $spec['service_provider'] = new ServiceProvider($spec['config']);
+        }
+
+        if ($spec['request']) {
+            if ($spec['request'] instanceof Request) {
+                $spec['service_provider']->setValue('request', $spec['request']);
+            } else {
+                throw new \InvalidArgumentException("Given request is not a " . Request::class);
+            }
+        }
+
+        self::$_instance = new self($spec['service_provider']);
+
+        if ($spec['handle_exceptions']) {
+            set_error_handler([self::$_instance, 'handleErrors']);
+            set_exception_handler([self::$_instance, 'handleExceptions']);
+        }
+
+        if ($spec['handle_shutdown']) {
+            // we need to register for shutdown before Symfony registers the
+            // session_write_close() function. https://github.com/Elgg/Elgg/issues/9243
+            register_shutdown_function(function () {
+                // There are cases where we may exit before this function is defined
+                if (function_exists('_elgg_shutdown_hook')) {
+                    _elgg_shutdown_hook();
+                }
+            });
+        }
+
+        if ($spec['overwrite_global_config']) {
+            global $CONFIG;
+
+            // this will be buggy be at least PHP will log failures
+            $CONFIG = $spec['service_provider']->config;
+        }
+
+        return self::$_instance;
+    }
+
+    /**
+     * Elgg's front controller. Handles basically all incoming URL requests.
+     *
+     * @return bool True if Elgg will handle the request, false if the server should (PHP-CLI server)
+     */
+    public static function index() {
+        $req = Request::createFromGlobals();
+        /** @var Request $req */
+
+        if ($req->isRewriteCheck()) {
+            echo Request::REWRITE_TEST_OUTPUT;
+            return true;
+        }
+
+        return self::factory(['request' => $req])->run();
+    }
+
+    /**
+     * Routes the request, booting core if not yet booted
+     *
+     * @return bool False if Elgg wants the PHP CLI server to handle the request
+     */
+    public function run() {
+        $config = $this->services->config;
+        $request = $this->services->request;
+
+        if ($request->isCliServer()) {
+            if ($request->isCliServable(Paths::project())) {
+                return false;
+            }
+
+            // overwrite value from settings
+            $www_root = rtrim($request->getSchemeAndHttpHost() . $request->getBaseUrl(), '/') . '/';
+            $config->wwwroot = $www_root;
+            $config->wwwroot_cli_server = $www_root;
+        }
+
+        if (0 === strpos($request->getElggPath(), '/cache/')) {
+            $this->services->cacheHandler->handleRequest($request)->prepare($request)->send();
+            return true;
+        }
+
+        if (0 === strpos($request->getElggPath(), '/serve-file/')) {
+            $this->services->serveFileHandler->getResponse($request)->send();
+            return true;
+        }
+
+        $this->bootCore();
+
+        // TODO use formal Response object instead
+        // This is to set the charset to UTF-8.
+        header("Content-Type: text/html;charset=utf-8", true);
+
+        // re-fetch new request from services in case it was replaced by route:rewrite
+        $request = $this->services->request;
+
+        if (!$this->services->router->route($request)) {
+            forward('', '404');
+        }
+    }
+
+    /**
+     * Returns a directory that points to the root of Elgg, but not necessarily
+     * the install root. See `self::root()` for that.
+     *
+     * @return Directory
+     */
+    public static function elggDir() {
+        return Local::elggRoot();
+    }
+
+    /**
+     * Returns a directory that points to the project root, where composer is installed.
+     *
+     * @return Directory
+     */
+    public static function projectDir() {
+        return Local::projectRoot();
+    }
+
+    /**
+     * Renders a web UI for installing Elgg.
+     *
+     * @return void
+     */
+    public static function install() {
+        ini_set('display_errors', 1);
+        $installer = new \ElggInstaller();
+        $installer->run();
+    }
+
+    /**
+     * Elgg upgrade script.
+     *
+     * This script triggers any necessary upgrades. If the site has been upgraded
+     * to the most recent version of the code, no upgrades are run but the caches
+     * are flushed.
+     *
+     * Upgrades use a table {db_prefix}upgrade_lock as a mutex to prevent concurrent upgrades.
+     *
+     * The URL to forward to after upgrades are complete can be specified by setting $_GET['forward']
+     * to a relative URL.
+     *
+     * @return void
+     */
+    public static function upgrade() {
+        // we want to know if an error occurs
+        ini_set('display_errors', 1);
+        $is_cli = (php_sapi_name() === 'cli');
+
+        $forward = function ($url) use ($is_cli) {
+            if ($is_cli) {
+                echo "Open $url in your browser to continue.";
+                exit;
+            }
+
+            forward($url);
+        };
+
+        define('UPGRADING', 'upgrading');
+
+        self::start();
 		
-		// check security settings
-		if (!$is_cli && _elgg_config()->security_protect_upgrade && !elgg_is_admin_logged_in()) {
-			// only admin's or users with a valid token can run upgrade.php
-			elgg_signed_request_gatekeeper();
-		}
+        // check security settings
+        if (!$is_cli && _elgg_config()->security_protect_upgrade && !elgg_is_admin_logged_in()) {
+            // only admin's or users with a valid token can run upgrade.php
+            elgg_signed_request_gatekeeper();
+        }
 		
-		$site_url = _elgg_config()->url;
-		$site_host = parse_url($site_url, PHP_URL_HOST) . '/';
-
-		// turn any full in-site URLs into absolute paths
-		$forward_url = get_input('forward', '/admin', false);
-		$forward_url = str_replace([$site_url, $site_host], '/', $forward_url);
-
-		if (strpos($forward_url, '/') !== 0) {
-			$forward_url = '/' . $forward_url;
-		}
-
-		if ($is_cli || (get_input('upgrade') == 'upgrade')) {
-			$upgrader = _elgg_services()->upgrades;
-			$result = $upgrader->run();
-
-			if ($result['failure'] == true) {
-				register_error($result['reason']);
-				$forward($forward_url);
-			}
-
-			// Find unprocessed batch upgrade classes and save them as ElggUpgrade objects
-			$core_upgrades = (require self::elggDir()->getPath('engine/lib/upgrades/async-upgrades.php'));
-			$has_pending_upgrades = _elgg_services()->upgradeLocator->run($core_upgrades);
-
-			if ($has_pending_upgrades) {
-				// Forward to the list of pending upgrades
-				$forward_url = '/admin/upgrades';
-			}
-		} else {
-			$rewriteTester = new \ElggRewriteTester();
-			$url = elgg_get_site_url() . "__testing_rewrite?__testing_rewrite=1";
-			if (!$rewriteTester->runRewriteTest($url)) {
-				// see if there is a problem accessing the site at all
-				// due to ip restrictions for example
-				if (!$rewriteTester->runLocalhostAccessTest()) {
-					// note: translation may not be available until after upgrade
-					$msg = elgg_echo("installation:htaccess:localhost:connectionfailed");
-					if ($msg === "installation:htaccess:localhost:connectionfailed") {
-						$msg = "Elgg cannot connect to itself to test rewrite rules properly. Check "
-								. "that curl is working and there are no IP restrictions preventing "
-								. "localhost connections.";
-					}
-					echo $msg;
-					exit;
-				}
-
-				// note: translation may not be available until after upgrade
-				$msg = elgg_echo("installation:htaccess:needs_upgrade");
-				if ($msg === "installation:htaccess:needs_upgrade") {
-					$msg = "You must update your .htaccess file (use install/config/htaccess.dist as a guide).";
-				}
-				echo $msg;
-				exit;
-			}
-
-			$vars = [
-				'forward' => $forward_url
-			];
-
-			// reset cache to have latest translations available during upgrade
-			elgg_reset_system_cache();
-
-			echo elgg_view_page(elgg_echo('upgrading'), '', 'upgrade', $vars);
-			exit;
-		}
-
-		$forward($forward_url);
-	}
-
-	/**
-	 * Allow plugins to rewrite the path.
-	 *
-	 * @return void
-	 */
-	private function allowPathRewrite() {
-		$request = $this->services->request;
-		$new = $this->services->router->allowRewrite($request);
-		if ($new === $request) {
-			return;
-		}
-
-		$this->services->setValue('request', $new);
-		$this->services->context->initialize($new);
-	}
-
-	/**
-	 * Flag this application as running for testing (PHPUnit)
-	 *
-	 * @param bool $testing Is testing application
-	 * @return void
-	 */
-	public static function setTestingApplication($testing = true) {
-		self::$testing_app = $testing;
-	}
-
-	/**
-	 * Checks if the application is running in PHPUnit
-	 * @return bool
-	 */
-	public static function isTestingApplication() {
-		return (bool) self::$testing_app;
-	}
-
-	/**
-	 * Intercepts, logs, and displays uncaught exceptions.
-	 *
-	 * To use a viewtype other than failsafe, create the views:
-	 *  <viewtype>/messages/exceptions/admin_exception
-	 *  <viewtype>/messages/exceptions/exception
-	 * See the json viewtype for an example.
-	 *
-	 * @warning This function should never be called directly.
-	 *
-	 * @see http://www.php.net/set-exception-handler
-	 *
-	 * @param \Exception|\Error $exception The exception/error being handled
-	 *
-	 * @return void
-	 * @access private
-	 */
-	public function handleExceptions($exception) {
-		$timestamp = time();
-		error_log("Exception at time $timestamp: $exception");
-
-		// Wipe any existing output buffer
-		ob_end_clean();
-
-		// make sure the error isn't cached
-		header("Cache-Control: no-cache, must-revalidate", true);
-		header('Expires: Fri, 05 Feb 1982 00:00:00 -0500', true);
-
-		if ($exception instanceof \InstallationException) {
-			forward('/install.php');
-		}
-
-		if (!self::$core_loaded) {
-			http_response_code(500);
-			echo "Exception loading Elgg core. Check log at time $timestamp";
-			return;
-		}
-
-		try {
-			// allow custom scripts to trigger on exception
-			// value in settings.php should be a system path to a file to include
-			$exception_include = $this->services->config->exception_include;
-
-			if ($exception_include && is_file($exception_include)) {
-				ob_start();
-
-				// don't isolate, these scripts may use the local $exception var.
-				include $exception_include;
-
-				$exception_output = ob_get_clean();
-
-				// if content is returned from the custom handler we will output
-				// that instead of our default failsafe view
-				if (!empty($exception_output)) {
-					echo $exception_output;
-					exit;
-				}
-			}
-
-			if (elgg_is_xhr()) {
-				elgg_set_viewtype('json');
-				$response = new \Symfony\Component\HttpFoundation\JsonResponse(null, 500);
-			} else {
-				elgg_set_viewtype('failsafe');
-				$response = new \Symfony\Component\HttpFoundation\Response('', 500);
-			}
-
-			if (elgg_is_admin_logged_in()) {
-				$body = elgg_view("messages/exceptions/admin_exception", [
-					'object' => $exception,
-					'ts' => $timestamp
-				]);
-			} else {
-				$body = elgg_view("messages/exceptions/exception", [
-					'object' => $exception,
-					'ts' => $timestamp
-				]);
-			}
-
-			$response->setContent(elgg_view_page(elgg_echo('exception:title'), $body));
-			$response->send();
-		} catch (\Exception $e) {
-			$timestamp = time();
-			$message = $e->getMessage();
-			http_response_code(500);
-			echo "Fatal error in exception handler. Check log for Exception at time $timestamp";
-			error_log("Exception at time $timestamp : fatal error in exception handler : $message");
-		}
-	}
-
-	/**
-	 * Intercepts catchable PHP errors.
-	 *
-	 * @warning This function should never be called directly.
-	 *
-	 * @internal
-	 * For catchable fatal errors, throws an Exception with the error.
-	 *
-	 * For non-fatal errors, depending upon the debug settings, either
-	 * log the error or ignore it.
-	 *
-	 * @see http://www.php.net/set-error-handler
-	 *
-	 * @param int    $errno    The level of the error raised
-	 * @param string $errmsg   The error message
-	 * @param string $filename The filename the error was raised in
-	 * @param int    $linenum  The line number the error was raised at
-	 * @param array  $vars     An array that points to the active symbol table where error occurred
-	 *
-	 * @return true
-	 * @throws \Exception
-	 * @access private
-	 */
-	public function handleErrors($errno, $errmsg, $filename, $linenum, $vars) {
-		$error = date("Y-m-d H:i:s (T)") . ": \"$errmsg\" in file $filename (line $linenum)";
-
-		$log = function ($message, $level) {
-			if (self::$core_loaded) {
-				return elgg_log($message, $level);
-			}
-
-			return false;
-		};
-
-		switch ($errno) {
-			case E_USER_ERROR:
-				if (!$log("PHP: $error", 'ERROR')) {
-					error_log("PHP ERROR: $error");
-				}
-				if (self::$core_loaded) {
-					register_error("ERROR: $error");
-				}
-
-				// Since this is a fatal error, we want to stop any further execution but do so gracefully.
-				throw new \Exception($error);
-				break;
-
-			case E_WARNING :
-			case E_USER_WARNING :
-			case E_RECOVERABLE_ERROR: // (e.g. type hint violation)
-
-				// check if the error wasn't suppressed by the error control operator (@)
-				if (error_reporting() && !$log("PHP: $error", 'WARNING')) {
-					error_log("PHP WARNING: $error");
-				}
-				break;
-
-			default:
-				if (function_exists('_elgg_config')) {
-					$debug = _elgg_config()->debug;
-				} else {
-					$debug = isset($GLOBALS['CONFIG']->debug) ? $GLOBALS['CONFIG']->debug : null;
-				}
-				if ($debug !== 'NOTICE') {
-					return true;
-				}
-
-				if (!$log("PHP (errno $errno): $error", 'NOTICE')) {
-					error_log("PHP NOTICE: $error");
-				}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Does nothing.
-	 *
-	 * @return void
-	 * @deprecated
-	 */
-	public function loadSettings() {
-		trigger_error(__METHOD__ . ' is no longer needed and will be removed.');
-	}
-
-	/**
-	 * Get all engine/lib library filenames
-	 *
-	 * @note We can't just pull in all directory files because some users leave old files in place.
-	 *
-	 * @return string[]
-	 */
-	private static function getEngineLibs() {
-		return [
-			'access.php',
-			'actions.php',
-			'admin.php',
-			'annotations.php',
-			'autoloader.php',
-			'cache.php',
-			'comments.php',
-			'configuration.php',
-			'constants.php',
-			'cron.php',
-			'database.php',
-			'deprecated-3.0.php',
-			'elgglib.php',
-			'entities.php',
-			'filestore.php',
-			'group.php',
-			'input.php',
-			'languages.php',
-			'mb_wrapper.php',
-			'memcache.php',
-			'metadata.php',
-			'metastrings.php',
-			'navigation.php',
-			'notification.php',
-			'output.php',
-			'pagehandler.php',
-			'pageowner.php',
-			'pam.php',
-			'plugins.php',
-			'private_settings.php',
-			'relationships.php',
-			'river.php',
-			'sessions.php',
-			'statistics.php',
-			'system_log.php',
-			'tags.php',
-			'upgrade.php',
-			'user_settings.php',
-			'users.php',
-			'views.php',
-			'widgets.php',
-		];
-	}
+        $site_url = _elgg_config()->url;
+        $site_host = parse_url($site_url, PHP_URL_HOST) . '/';
+
+        // turn any full in-site URLs into absolute paths
+        $forward_url = get_input('forward', '/admin', false);
+        $forward_url = str_replace([$site_url, $site_host], '/', $forward_url);
+
+        if (strpos($forward_url, '/') !== 0) {
+            $forward_url = '/' . $forward_url;
+        }
+
+        if ($is_cli || (get_input('upgrade') == 'upgrade')) {
+            $upgrader = _elgg_services()->upgrades;
+            $result = $upgrader->run();
+
+            if ($result['failure'] == true) {
+                register_error($result['reason']);
+                $forward($forward_url);
+            }
+
+            // Find unprocessed batch upgrade classes and save them as ElggUpgrade objects
+            $core_upgrades = (require self::elggDir()->getPath('engine/lib/upgrades/async-upgrades.php'));
+            $has_pending_upgrades = _elgg_services()->upgradeLocator->run($core_upgrades);
+
+            if ($has_pending_upgrades) {
+                // Forward to the list of pending upgrades
+                $forward_url = '/admin/upgrades';
+            }
+        } else {
+            $rewriteTester = new \ElggRewriteTester();
+            $url = elgg_get_site_url() . "__testing_rewrite?__testing_rewrite=1";
+            if (!$rewriteTester->runRewriteTest($url)) {
+                // see if there is a problem accessing the site at all
+                // due to ip restrictions for example
+                if (!$rewriteTester->runLocalhostAccessTest()) {
+                    // note: translation may not be available until after upgrade
+                    $msg = elgg_echo("installation:htaccess:localhost:connectionfailed");
+                    if ($msg === "installation:htaccess:localhost:connectionfailed") {
+                        $msg = "Elgg cannot connect to itself to test rewrite rules properly. Check "
+                                . "that curl is working and there are no IP restrictions preventing "
+                                . "localhost connections.";
+                    }
+                    echo $msg;
+                    exit;
+                }
+
+                // note: translation may not be available until after upgrade
+                $msg = elgg_echo("installation:htaccess:needs_upgrade");
+                if ($msg === "installation:htaccess:needs_upgrade") {
+                    $msg = "You must update your .htaccess file (use install/config/htaccess.dist as a guide).";
+                }
+                echo $msg;
+                exit;
+            }
+
+            $vars = [
+                'forward' => $forward_url
+            ];
+
+            // reset cache to have latest translations available during upgrade
+            elgg_reset_system_cache();
+
+            echo elgg_view_page(elgg_echo('upgrading'), '', 'upgrade', $vars);
+            exit;
+        }
+
+        $forward($forward_url);
+    }
+
+    /**
+     * Allow plugins to rewrite the path.
+     *
+     * @return void
+     */
+    private function allowPathRewrite() {
+        $request = $this->services->request;
+        $new = $this->services->router->allowRewrite($request);
+        if ($new === $request) {
+            return;
+        }
+
+        $this->services->setValue('request', $new);
+        $this->services->context->initialize($new);
+    }
+
+    /**
+     * Flag this application as running for testing (PHPUnit)
+     *
+     * @param bool $testing Is testing application
+     * @return void
+     */
+    public static function setTestingApplication($testing = true) {
+        self::$testing_app = $testing;
+    }
+
+    /**
+     * Checks if the application is running in PHPUnit
+     * @return bool
+     */
+    public static function isTestingApplication() {
+        return (bool) self::$testing_app;
+    }
+
+    /**
+     * Intercepts, logs, and displays uncaught exceptions.
+     *
+     * To use a viewtype other than failsafe, create the views:
+     *  <viewtype>/messages/exceptions/admin_exception
+     *  <viewtype>/messages/exceptions/exception
+     * See the json viewtype for an example.
+     *
+     * @warning This function should never be called directly.
+     *
+     * @see http://www.php.net/set-exception-handler
+     *
+     * @param \Exception|\Error $exception The exception/error being handled
+     *
+     * @return void
+     * @access private
+     */
+    public function handleExceptions($exception) {
+        $timestamp = time();
+        error_log("Exception at time $timestamp: $exception");
+
+        // Wipe any existing output buffer
+        ob_end_clean();
+
+        // make sure the error isn't cached
+        header("Cache-Control: no-cache, must-revalidate", true);
+        header('Expires: Fri, 05 Feb 1982 00:00:00 -0500', true);
+
+        if ($exception instanceof \InstallationException) {
+            forward('/install.php');
+        }
+
+        if (!self::$core_loaded) {
+            http_response_code(500);
+            echo "Exception loading Elgg core. Check log at time $timestamp";
+            return;
+        }
+
+        try {
+            // allow custom scripts to trigger on exception
+            // value in settings.php should be a system path to a file to include
+            $exception_include = $this->services->config->exception_include;
+
+            if ($exception_include && is_file($exception_include)) {
+                ob_start();
+
+                // don't isolate, these scripts may use the local $exception var.
+                include $exception_include;
+
+                $exception_output = ob_get_clean();
+
+                // if content is returned from the custom handler we will output
+                // that instead of our default failsafe view
+                if (!empty($exception_output)) {
+                    echo $exception_output;
+                    exit;
+                }
+            }
+
+            if (elgg_is_xhr()) {
+                elgg_set_viewtype('json');
+                $response = new \Symfony\Component\HttpFoundation\JsonResponse(null, 500);
+            } else {
+                elgg_set_viewtype('failsafe');
+                $response = new \Symfony\Component\HttpFoundation\Response('', 500);
+            }
+
+            if (elgg_is_admin_logged_in()) {
+                $body = elgg_view("messages/exceptions/admin_exception", [
+                    'object' => $exception,
+                    'ts' => $timestamp
+                ]);
+            } else {
+                $body = elgg_view("messages/exceptions/exception", [
+                    'object' => $exception,
+                    'ts' => $timestamp
+                ]);
+            }
+
+            $response->setContent(elgg_view_page(elgg_echo('exception:title'), $body));
+            $response->send();
+        } catch (\Exception $e) {
+            $timestamp = time();
+            $message = $e->getMessage();
+            http_response_code(500);
+            echo "Fatal error in exception handler. Check log for Exception at time $timestamp";
+            error_log("Exception at time $timestamp : fatal error in exception handler : $message");
+        }
+    }
+
+    /**
+     * Intercepts catchable PHP errors.
+     *
+     * @warning This function should never be called directly.
+     *
+     * @internal
+     * For catchable fatal errors, throws an Exception with the error.
+     *
+     * For non-fatal errors, depending upon the debug settings, either
+     * log the error or ignore it.
+     *
+     * @see http://www.php.net/set-error-handler
+     *
+     * @param int    $errno    The level of the error raised
+     * @param string $errmsg   The error message
+     * @param string $filename The filename the error was raised in
+     * @param int    $linenum  The line number the error was raised at
+     * @param array  $vars     An array that points to the active symbol table where error occurred
+     *
+     * @return true
+     * @throws \Exception
+     * @access private
+     */
+    public function handleErrors($errno, $errmsg, $filename, $linenum, $vars) {
+        $error = date("Y-m-d H:i:s (T)") . ": \"$errmsg\" in file $filename (line $linenum)";
+
+        $log = function ($message, $level) {
+            if (self::$core_loaded) {
+                return elgg_log($message, $level);
+            }
+
+            return false;
+        };
+
+        switch ($errno) {
+            case E_USER_ERROR:
+                if (!$log("PHP: $error", 'ERROR')) {
+                    error_log("PHP ERROR: $error");
+                }
+                if (self::$core_loaded) {
+                    register_error("ERROR: $error");
+                }
+
+                // Since this is a fatal error, we want to stop any further execution but do so gracefully.
+                throw new \Exception($error);
+                break;
+
+            case E_WARNING :
+            case E_USER_WARNING :
+            case E_RECOVERABLE_ERROR: // (e.g. type hint violation)
+
+                // check if the error wasn't suppressed by the error control operator (@)
+                if (error_reporting() && !$log("PHP: $error", 'WARNING')) {
+                    error_log("PHP WARNING: $error");
+                }
+                break;
+
+            default:
+                if (function_exists('_elgg_config')) {
+                    $debug = _elgg_config()->debug;
+                } else {
+                    $debug = isset($GLOBALS['CONFIG']->debug) ? $GLOBALS['CONFIG']->debug : null;
+                }
+                if ($debug !== 'NOTICE') {
+                    return true;
+                }
+
+                if (!$log("PHP (errno $errno): $error", 'NOTICE')) {
+                    error_log("PHP NOTICE: $error");
+                }
+        }
+
+        return true;
+    }
+
+    /**
+     * Does nothing.
+     *
+     * @return void
+     * @deprecated
+     */
+    public function loadSettings() {
+        trigger_error(__METHOD__ . ' is no longer needed and will be removed.');
+    }
+
+    /**
+     * Get all engine/lib library filenames
+     *
+     * @note We can't just pull in all directory files because some users leave old files in place.
+     *
+     * @return string[]
+     */
+    private static function getEngineLibs() {
+        return [
+            'access.php',
+            'actions.php',
+            'admin.php',
+            'annotations.php',
+            'autoloader.php',
+            'cache.php',
+            'comments.php',
+            'configuration.php',
+            'constants.php',
+            'cron.php',
+            'database.php',
+            'deprecated-3.0.php',
+            'elgglib.php',
+            'entities.php',
+            'filestore.php',
+            'group.php',
+            'input.php',
+            'languages.php',
+            'mb_wrapper.php',
+            'memcache.php',
+            'metadata.php',
+            'metastrings.php',
+            'navigation.php',
+            'notification.php',
+            'output.php',
+            'pagehandler.php',
+            'pageowner.php',
+            'pam.php',
+            'plugins.php',
+            'private_settings.php',
+            'relationships.php',
+            'river.php',
+            'sessions.php',
+            'statistics.php',
+            'system_log.php',
+            'tags.php',
+            'upgrade.php',
+            'user_settings.php',
+            'users.php',
+            'views.php',
+            'widgets.php',
+        ];
+    }
 }

engine/classes/Elgg/Application/CacheHandler.php

Doc Comments -1 removed lines

@@ -74,7 +74,6 @@
 	/**
 	 * Handle a request for a cached view
 	 *
-	 * @param array $path URL path
 	 * @return Response (unprepared)
 	 */
 	public function handleRequest(Request $request) {

Indentation +352 added lines, -352 removed lines

@@ -15,362 +15,362 @@
  */
 class CacheHandler {
 	
-	public static $extensions = [
-		'bmp' => "image/bmp",
-		'css' => "text/css",
-		'gif' => "image/gif",
-		'html' => "text/html",
-		'ico' => "image/x-icon",
-		'jpeg' => "image/jpeg",
-		'jpg' => "image/jpeg",
-		'js' => "application/javascript",
-		'json' => "application/json",
-		'png' => "image/png",
-		'svg' => "image/svg+xml",
-		'swf' => "application/x-shockwave-flash",
-		'tiff' => "image/tiff",
-		'webp' => "image/webp",
-		'xml' => "text/xml",
-		'eot' => "application/vnd.ms-fontobject",
-		'ttf' => "application/font-ttf",
-		'woff' => "application/font-woff",
-		'woff2' => "application/font-woff2",
-		'otf' => "application/font-otf",
-	];
-
-	public static $utf8_content_types = [
-		"text/css",
-		"text/html",
-		"application/javascript",
-		"application/json",
-		"image/svg+xml",
-		"text/xml",
-	];
-
-	/** @var Application */
-	private $application;
-
-	/** @var Config */
-	private $config;
-
-	/** @var Request */
-	private $request;
-
-	/**
-	 * Constructor
-	 *
-	 * @param Application $app                 Elgg Application
-	 * @param Config      $config              Elgg configuration
-	 * @param Request     $request             HTTP request
-	 * @param bool        $simplecache_enabled Is the simplecache enabled?
-	 */
-	public function __construct(Application $app, Config $config, Request $request, $simplecache_enabled) {
-		$this->application = $app;
-		$this->config = $config;
-		$this->request = $request;
-		$this->simplecache_enabled = $simplecache_enabled;
-	}
-
-	/**
-	 * Handle a request for a cached view
-	 *
-	 * @param array $path URL path
-	 * @return Response (unprepared)
-	 */
-	public function handleRequest(Request $request) {
-		$config = $this->config;
-
-		$parsed = $this->parsePath($request->getElggPath());
-		if (!$parsed) {
-			return $this->send403();
-		}
+    public static $extensions = [
+        'bmp' => "image/bmp",
+        'css' => "text/css",
+        'gif' => "image/gif",
+        'html' => "text/html",
+        'ico' => "image/x-icon",
+        'jpeg' => "image/jpeg",
+        'jpg' => "image/jpeg",
+        'js' => "application/javascript",
+        'json' => "application/json",
+        'png' => "image/png",
+        'svg' => "image/svg+xml",
+        'swf' => "application/x-shockwave-flash",
+        'tiff' => "image/tiff",
+        'webp' => "image/webp",
+        'xml' => "text/xml",
+        'eot' => "application/vnd.ms-fontobject",
+        'ttf' => "application/font-ttf",
+        'woff' => "application/font-woff",
+        'woff2' => "application/font-woff2",
+        'otf' => "application/font-otf",
+    ];
+
+    public static $utf8_content_types = [
+        "text/css",
+        "text/html",
+        "application/javascript",
+        "application/json",
+        "image/svg+xml",
+        "text/xml",
+    ];
+
+    /** @var Application */
+    private $application;
+
+    /** @var Config */
+    private $config;
+
+    /** @var Request */
+    private $request;
+
+    /**
+     * Constructor
+     *
+     * @param Application $app                 Elgg Application
+     * @param Config      $config              Elgg configuration
+     * @param Request     $request             HTTP request
+     * @param bool        $simplecache_enabled Is the simplecache enabled?
+     */
+    public function __construct(Application $app, Config $config, Request $request, $simplecache_enabled) {
+        $this->application = $app;
+        $this->config = $config;
+        $this->request = $request;
+        $this->simplecache_enabled = $simplecache_enabled;
+    }
+
+    /**
+     * Handle a request for a cached view
+     *
+     * @param array $path URL path
+     * @return Response (unprepared)
+     */
+    public function handleRequest(Request $request) {
+        $config = $this->config;
+
+        $parsed = $this->parsePath($request->getElggPath());
+        if (!$parsed) {
+            return $this->send403();
+        }
 		
-		$ts = $parsed['ts'];
-		$view = $parsed['view'];
-		$viewtype = $parsed['viewtype'];
-
-		$content_type = $this->getContentType($view);
-		if (empty($content_type)) {
-			return $this->send403("Asset must have a valid file extension");
-		}
-
-		$response = Response::create();
-		if (in_array($content_type, self::$utf8_content_types)) {
-			$response->headers->set('Content-Type', "$content_type;charset=utf-8", true);
-		} else {
-			$response->headers->set('Content-Type', $content_type, true);
-		}
-
-		if (!$this->simplecache_enabled) {
-			$this->application->bootCore();
-			header_remove('Cache-Control');
-			header_remove('Pragma');
-			header_remove('Expires');
-
-			if (!$this->isCacheableView($view)) {
-				return $this->send403("Requested view is not an asset");
-			}
-
-			$content = $this->getProcessedView($view, $viewtype);
-			if ($content === false) {
-				return $this->send403();
-			}
-
-			$etag = '"' . md5($content) . '"';
-			$this->setRevalidateHeaders($etag, $response);
-			if ($this->is304($etag)) {
-				return Response::create()->setNotModified();
-			}
-
-			return $response->setContent($content);
-		}
-
-		$etag = "\"$ts\"";
-		if ($this->is304($etag)) {
-			return Response::create()->setNotModified();
-		}
-
-		// trust the client but check for an existing cache file
-		$filename = $config->cacheroot . "views_simplecache/$ts/$viewtype/$view";
-		if (file_exists($filename)) {
-			$this->sendCacheHeaders($etag, $response);
-			return BinaryFileResponse::create($filename, 200, $response->headers->all());
-		}
-
-		// the hard way
-		$this->application->bootCore();
-		header_remove('Cache-Control');
-		header_remove('Pragma');
-		header_remove('Expires');
-
-		elgg_set_viewtype($viewtype);
-		if (!$this->isCacheableView($view)) {
-			return $this->send403("Requested view is not an asset");
-		}
-
-		$lastcache = (int) $config->lastcache;
-
-		$filename = $config->cacheroot . "views_simplecache/$lastcache/$viewtype/$view";
-
-		if ($lastcache == $ts) {
-			$this->sendCacheHeaders($etag, $response);
-
-			$content = $this->getProcessedView($view, $viewtype);
-
-			$dir_name = dirname($filename);
-			if (!is_dir($dir_name)) {
-				// PHP and the server accessing the cache symlink may be a different user. And here
-				// it's safe to make everything readable anyway.
-				mkdir($dir_name, 0775, true);
-			}
-
-			file_put_contents($filename, $content);
-			chmod($filename, 0664);
-		} else {
-			// if wrong timestamp, don't send HTTP cache
-			$content = $this->getProcessedView($view, $viewtype);
-		}
-
-		return $response->setContent($content);
-	}
-
-	/**
-	 * Parse a request
-	 *
-	 * @param string $path Request URL path
-	 * @return array Cache parameters (empty array if failure)
-	 */
-	public function parsePath($path) {
-		// no '..'
-		if (false !== strpos($path, '..')) {
-			return [];
-		}
-		// only alphanumeric characters plus /, ., -, and _
-		if (preg_match('#[^a-zA-Z0-9/\.\-_]#', $path)) {
-			return [];
-		}
-
-		// testing showed regex to be marginally faster than array / string functions over 100000 reps
-		// it won't make a difference in real life and regex is easier to read.
-		// <ts>/<viewtype>/<name/of/view.and.dots>.<type>
-		if (!preg_match('#^/cache/([0-9]+)/([^/]+)/(.+)$#', $path, $matches)) {
-			return [];
-		}
-
-		return [
-			'ts' => $matches[1],
-			'viewtype' => $matches[2],
-			'view' => $matches[3],
-		];
-	}
-
-	/**
-	 * Is the view cacheable. Language views are handled specially.
-	 *
-	 * @param string $view View name
-	 *
-	 * @return bool
-	 */
-	protected function isCacheableView($view) {
-		if (preg_match('~^languages/(.*)\.js$~', $view, $m)) {
-			return in_array($m[1],  _elgg_services()->translator->getAllLanguageCodes());
-		}
-		return _elgg_services()->views->isCacheableView($view);
-	}
-
-	/**
-	 * Send cache headers
-	 *
-	 * @param string $etag ETag value
-	 * @return void
-	 */
-	protected function sendCacheHeaders($etag, Response $response) {
-		$response->setSharedMaxAge(86400 * 30 * 6);
-		$response->setMaxAge(86400 * 30 * 6);
-		$response->headers->set('ETag', $etag);
-	}
-
-	/**
-	 * Send revalidate cache headers
-	 *
-	 * @param string $etag ETag value
-	 * @return void
-	 */
-	protected function setRevalidateHeaders($etag, Response $response) {
-		$response->headers->set('Cache-Control', "public, max-age=0, must-revalidate", true);
-		$response->headers->set('ETag', $etag);
-	}
-
-	/**
-	 * Send a 304 and exit() if the ETag matches the request
-	 *
-	 * @param string $etag ETag value
-	 * @return bool
-	 */
-	protected function is304($etag) {
-		$if_none_match = $this->request->headers->get('If-None-Match');
-		if ($if_none_match === null) {
-			return false;
-		}
-
-		// strip -gzip and leading /W
-		$if_none_match = trim($if_none_match);
-		if (0 === strpos($if_none_match, 'W/')) {
-			$if_none_match = substr($if_none_match, 2);
-		}
-		$if_none_match = str_replace('-gzip', '', $if_none_match);
-
-		return ($if_none_match === $etag);
-	}
-
-	/**
-	 * Get the content type
-	 *
-	 * @param string $view The view name
-	 *
-	 * @return string|null
-	 * @access private
-	 */
-	public function getContentType($view) {
-		$extension = $this->getViewFileType($view);
+        $ts = $parsed['ts'];
+        $view = $parsed['view'];
+        $viewtype = $parsed['viewtype'];
+
+        $content_type = $this->getContentType($view);
+        if (empty($content_type)) {
+            return $this->send403("Asset must have a valid file extension");
+        }
+
+        $response = Response::create();
+        if (in_array($content_type, self::$utf8_content_types)) {
+            $response->headers->set('Content-Type', "$content_type;charset=utf-8", true);
+        } else {
+            $response->headers->set('Content-Type', $content_type, true);
+        }
+
+        if (!$this->simplecache_enabled) {
+            $this->application->bootCore();
+            header_remove('Cache-Control');
+            header_remove('Pragma');
+            header_remove('Expires');
+
+            if (!$this->isCacheableView($view)) {
+                return $this->send403("Requested view is not an asset");
+            }
+
+            $content = $this->getProcessedView($view, $viewtype);
+            if ($content === false) {
+                return $this->send403();
+            }
+
+            $etag = '"' . md5($content) . '"';
+            $this->setRevalidateHeaders($etag, $response);
+            if ($this->is304($etag)) {
+                return Response::create()->setNotModified();
+            }
+
+            return $response->setContent($content);
+        }
+
+        $etag = "\"$ts\"";
+        if ($this->is304($etag)) {
+            return Response::create()->setNotModified();
+        }
+
+        // trust the client but check for an existing cache file
+        $filename = $config->cacheroot . "views_simplecache/$ts/$viewtype/$view";
+        if (file_exists($filename)) {
+            $this->sendCacheHeaders($etag, $response);
+            return BinaryFileResponse::create($filename, 200, $response->headers->all());
+        }
+
+        // the hard way
+        $this->application->bootCore();
+        header_remove('Cache-Control');
+        header_remove('Pragma');
+        header_remove('Expires');
+
+        elgg_set_viewtype($viewtype);
+        if (!$this->isCacheableView($view)) {
+            return $this->send403("Requested view is not an asset");
+        }
+
+        $lastcache = (int) $config->lastcache;
+
+        $filename = $config->cacheroot . "views_simplecache/$lastcache/$viewtype/$view";
+
+        if ($lastcache == $ts) {
+            $this->sendCacheHeaders($etag, $response);
+
+            $content = $this->getProcessedView($view, $viewtype);
+
+            $dir_name = dirname($filename);
+            if (!is_dir($dir_name)) {
+                // PHP and the server accessing the cache symlink may be a different user. And here
+                // it's safe to make everything readable anyway.
+                mkdir($dir_name, 0775, true);
+            }
+
+            file_put_contents($filename, $content);
+            chmod($filename, 0664);
+        } else {
+            // if wrong timestamp, don't send HTTP cache
+            $content = $this->getProcessedView($view, $viewtype);
+        }
+
+        return $response->setContent($content);
+    }
+
+    /**
+     * Parse a request
+     *
+     * @param string $path Request URL path
+     * @return array Cache parameters (empty array if failure)
+     */
+    public function parsePath($path) {
+        // no '..'
+        if (false !== strpos($path, '..')) {
+            return [];
+        }
+        // only alphanumeric characters plus /, ., -, and _
+        if (preg_match('#[^a-zA-Z0-9/\.\-_]#', $path)) {
+            return [];
+        }
+
+        // testing showed regex to be marginally faster than array / string functions over 100000 reps
+        // it won't make a difference in real life and regex is easier to read.
+        // <ts>/<viewtype>/<name/of/view.and.dots>.<type>
+        if (!preg_match('#^/cache/([0-9]+)/([^/]+)/(.+)$#', $path, $matches)) {
+            return [];
+        }
+
+        return [
+            'ts' => $matches[1],
+            'viewtype' => $matches[2],
+            'view' => $matches[3],
+        ];
+    }
+
+    /**
+     * Is the view cacheable. Language views are handled specially.
+     *
+     * @param string $view View name
+     *
+     * @return bool
+     */
+    protected function isCacheableView($view) {
+        if (preg_match('~^languages/(.*)\.js$~', $view, $m)) {
+            return in_array($m[1],  _elgg_services()->translator->getAllLanguageCodes());
+        }
+        return _elgg_services()->views->isCacheableView($view);
+    }
+
+    /**
+     * Send cache headers
+     *
+     * @param string $etag ETag value
+     * @return void
+     */
+    protected function sendCacheHeaders($etag, Response $response) {
+        $response->setSharedMaxAge(86400 * 30 * 6);
+        $response->setMaxAge(86400 * 30 * 6);
+        $response->headers->set('ETag', $etag);
+    }
+
+    /**
+     * Send revalidate cache headers
+     *
+     * @param string $etag ETag value
+     * @return void
+     */
+    protected function setRevalidateHeaders($etag, Response $response) {
+        $response->headers->set('Cache-Control', "public, max-age=0, must-revalidate", true);
+        $response->headers->set('ETag', $etag);
+    }
+
+    /**
+     * Send a 304 and exit() if the ETag matches the request
+     *
+     * @param string $etag ETag value
+     * @return bool
+     */
+    protected function is304($etag) {
+        $if_none_match = $this->request->headers->get('If-None-Match');
+        if ($if_none_match === null) {
+            return false;
+        }
+
+        // strip -gzip and leading /W
+        $if_none_match = trim($if_none_match);
+        if (0 === strpos($if_none_match, 'W/')) {
+            $if_none_match = substr($if_none_match, 2);
+        }
+        $if_none_match = str_replace('-gzip', '', $if_none_match);
+
+        return ($if_none_match === $etag);
+    }
+
+    /**
+     * Get the content type
+     *
+     * @param string $view The view name
+     *
+     * @return string|null
+     * @access private
+     */
+    public function getContentType($view) {
+        $extension = $this->getViewFileType($view);
 		
-		if (isset(self::$extensions[$extension])) {
-			return self::$extensions[$extension];
-		} else {
-			return null;
-		}
-	}
+        if (isset(self::$extensions[$extension])) {
+            return self::$extensions[$extension];
+        } else {
+            return null;
+        }
+    }
 	
-	/**
-	 * Returns the type of output expected from the view.
-	 *
-	 *  - view/name.extension returns "extension" if "extension" is valid
-	 *  - css/view return "css"
-	 *  - js/view return "js"
-	 *  - Otherwise, returns "unknown"
-	 *
-	 * @param string $view The view name
-	 * @return string
-	 * @access private
-	 */
-	public function getViewFileType($view) {
-		$extension = (new \SplFileInfo($view))->getExtension();
-		$hasValidExtension = isset(self::$extensions[$extension]);
-
-		if ($hasValidExtension) {
-			return $extension;
-		}
+    /**
+     * Returns the type of output expected from the view.
+     *
+     *  - view/name.extension returns "extension" if "extension" is valid
+     *  - css/view return "css"
+     *  - js/view return "js"
+     *  - Otherwise, returns "unknown"
+     *
+     * @param string $view The view name
+     * @return string
+     * @access private
+     */
+    public function getViewFileType($view) {
+        $extension = (new \SplFileInfo($view))->getExtension();
+        $hasValidExtension = isset(self::$extensions[$extension]);
+
+        if ($hasValidExtension) {
+            return $extension;
+        }
 		
-		if (preg_match('~(?:^|/)(css|js)(?:$|/)~', $view, $m)) {
-			return $m[1];
-		}
+        if (preg_match('~(?:^|/)(css|js)(?:$|/)~', $view, $m)) {
+            return $m[1];
+        }
 		
-		return 'unknown';
-	}
-
-	/**
-	 * Get the contents of a view for caching
-	 *
-	 * @param string $view     The view name
-	 * @param string $viewtype The viewtype
-	 * @return string|false
-	 * @see CacheHandler::renderView()
-	 */
-	protected function getProcessedView($view, $viewtype) {
-		$content = $this->renderView($view, $viewtype);
-		if ($content === false) {
-			return false;
-		}
-
-		if ($this->simplecache_enabled) {
-			$hook_name = 'simplecache:generate';
-		} else {
-			$hook_name = 'cache:generate';
-		}
-		$hook_type = $this->getViewFileType($view);
-		$hook_params = [
-			'view' => $view,
-			'viewtype' => $viewtype,
-			'view_content' => $content,
-		];
-		return \_elgg_services()->hooks->trigger($hook_name, $hook_type, $hook_params, $content);
-	}
-
-	/**
-	 * Render a view for caching. Language views are handled specially.
-	 *
-	 * @param string $view     The view name
-	 * @param string $viewtype The viewtype
-	 * @return string|false
-	 */
-	protected function renderView($view, $viewtype) {
-		elgg_set_viewtype($viewtype);
-
-		if ($viewtype === 'default' && preg_match("#^languages/(.*?)\\.js$#", $view, $matches)) {
-			$view = "languages.js";
-			$vars = ['language' => $matches[1]];
-		} else {
-			$vars = [];
-		}
-
-		if (!elgg_view_exists($view)) {
-			return false;
-		}
-
-		// disable error reporting so we don't cache problems
-		$this->config->debug = null;
-
-		return elgg_view($view, $vars);
-	}
-
-	/**
-	 * Send an error message to requestor
-	 *
-	 * @param string $msg Optional message text
-	 * @return Response
-	 */
-	protected function send403($msg = 'Cache error: bad request') {
-		return Response::create($msg, 403);
-	}
+        return 'unknown';
+    }
+
+    /**
+     * Get the contents of a view for caching
+     *
+     * @param string $view     The view name
+     * @param string $viewtype The viewtype
+     * @return string|false
+     * @see CacheHandler::renderView()
+     */
+    protected function getProcessedView($view, $viewtype) {
+        $content = $this->renderView($view, $viewtype);
+        if ($content === false) {
+            return false;
+        }
+
+        if ($this->simplecache_enabled) {
+            $hook_name = 'simplecache:generate';
+        } else {
+            $hook_name = 'cache:generate';
+        }
+        $hook_type = $this->getViewFileType($view);
+        $hook_params = [
+            'view' => $view,
+            'viewtype' => $viewtype,
+            'view_content' => $content,
+        ];
+        return \_elgg_services()->hooks->trigger($hook_name, $hook_type, $hook_params, $content);
+    }
+
+    /**
+     * Render a view for caching. Language views are handled specially.
+     *
+     * @param string $view     The view name
+     * @param string $viewtype The viewtype
+     * @return string|false
+     */
+    protected function renderView($view, $viewtype) {
+        elgg_set_viewtype($viewtype);
+
+        if ($viewtype === 'default' && preg_match("#^languages/(.*?)\\.js$#", $view, $matches)) {
+            $view = "languages.js";
+            $vars = ['language' => $matches[1]];
+        } else {
+            $vars = [];
+        }
+
+        if (!elgg_view_exists($view)) {
+            return false;
+        }
+
+        // disable error reporting so we don't cache problems
+        $this->config->debug = null;
+
+        return elgg_view($view, $vars);
+    }
+
+    /**
+     * Send an error message to requestor
+     *
+     * @param string $msg Optional message text
+     * @return Response
+     */
+    protected function send403($msg = 'Cache error: bad request') {
+        return Response::create($msg, 403);
+    }
 }