url . $location;
}
// return new forward location or false to stop the forward or empty string to exit
$current_page = current_page_url();
$params = array('current_url' => $current_page, 'forward_url' => $location);
$location = trigger_plugin_hook('forward', 'system', $params, $location);
if ($location) {
header("Location: {$location}");
exit;
} else if ($location === '') {
exit;
}
}
return false;
}
/**
* Returns the current page's complete URL.
*
* The current URL is assembled using the network's wwwroot and the request URI
* in $_SERVER as populated by the web server. This function will include
* any schemes, usernames and passwords, and ports.
*
* @return string The current page URL.
*/
function current_page_url() {
global $CONFIG;
$url = parse_url($CONFIG->wwwroot);
$page = $url['scheme'] . "://";
// user/pass
if ((isset($url['user'])) && ($url['user'])) {
$page .= $url['user'];
}
if ((isset($url['pass'])) && ($url['pass'])) {
$page .= ":".$url['pass'];
}
if ((isset($url['user']) && $url['user']) ||
(isset($url['pass']) && $url['pass'])) {
$page .="@";
}
$page .= $url['host'];
if ((isset($url['port'])) && ($url['port'])) {
$page .= ":" . $url['port'];
}
$page = trim($page, "/");
$page .= $_SERVER['REQUEST_URI'];
return $page;
}
/**
* Returns an ElggCache object suitable for caching view
* file load paths to disk under $CONFIG->dataroot.
*
* @todo Can this be done in a cleaner way?
* @todo Swap to memcache etc?
*
* @return ElggFileCache A cache object suitable for caching file load paths.
*/
function elgg_get_filepath_cache() {
global $CONFIG;
/**
* A default filestore cache using the dataroot.
*/
static $FILE_PATH_CACHE;
if (!$FILE_PATH_CACHE) {
$FILE_PATH_CACHE = new ElggFileCache($CONFIG->dataroot);
}
return $FILE_PATH_CACHE;
}
/**
* Deletes the view file paths cache from disk.
*
* @return bool On success
*/
function elgg_filepath_cache_reset() {
$cache = elgg_get_filepath_cache();
return $cache->delete('view_paths');
}
/**
* Saves $data to the views file paths disk cache as
* 'view_paths'.
*
* @param mixed $data The data
* @return bool On success
*/
function elgg_filepath_cache_save($data) {
global $CONFIG;
if ($CONFIG->viewpath_cache_enabled) {
$cache = elgg_get_filepath_cache();
return $cache->save('view_paths', $data);
}
return false;
}
/**
* Returns the contents of the views file paths cache from disk.
*
* @return mixed Null if simplecache isn't enabled, the contents of the views file paths cache if it is.
*/
function elgg_filepath_cache_load() {
global $CONFIG;
if ($CONFIG->viewpath_cache_enabled) {
$cache = elgg_get_filepath_cache();
$cached_view_paths = $cache->load('view_paths');
if ($cached_view_paths) {
return $cached_view_paths;
}
}
return NULL;
}
/**
* Enables the views file paths disk cache.
*
* Uses the 'viewpath_cache_enabled' datalist with a boolean value.
* Resets the views paths cache.
*
* @return null
*/
function elgg_enable_filepath_cache() {
global $CONFIG;
datalist_set('viewpath_cache_enabled', 1);
$CONFIG->viewpath_cache_enabled = 1;
elgg_filepath_cache_reset();
}
/**
* Disables the views file paths disk cache.
*
* Uses the 'viewpath_cache_enabled' datalist with a boolean value.
* Resets the views paths cache.
*
* @return null
*/
function elgg_disable_filepath_cache() {
global $CONFIG;
datalist_set('viewpath_cache_enabled', 0);
$CONFIG->viewpath_cache_enabled = 0;
elgg_filepath_cache_reset();
}
/**
* Deprecated by elgg_add_submenu_item()
*
* @see elgg_add_submenu_item()
* @deprecated 1.8
*/
function add_submenu_item($label, $link, $group = 'default', $onclick = false, $selected = NULL) {
elgg_deprecated_notice('add_submenu_item was deprecated by elgg_add_submenu_item', 1.8);
$item = array(
'text' => $label,
'href' => $link,
'selected' => $selected
);
if (!$group) {
$group = 'default';
}
if ($onclick) {
$js = "onclick=\"javascript:return confirm('". elgg_echo('deleteconfirm') . "')\"";
$item['vars'] = array('js' => $js);
}
// submenu items were added in the page setup hook usually by checking
// the context. We'll pass in the current context here, which will
// emulate that effect.
// if context == 'main' (default) it probably means they always wanted
// the menu item to show up everywhere.
$context = get_context();
if ($context == 'main') {
$context = 'all';
}
return elgg_add_submenu_item($item, $context, $group);
}
/**
* Add an entry to the submenu.
*
* @param array $item The item as:
*
* array(
* 'title' => 'Text to display',
* 'url' => 'URL of the link',
* 'id' => 'entry_unique_id' //used by children items to identify parents
* 'parent_id' => 'id_of_parent',
* 'selected' => BOOL // Is this item selected? (If NULL or unset will attempt to guess)
* 'vars' => array() // Array of vars to pass to the navigation/submenu_item view
* )
*
*
* @param string $context Context in which to display this menu item. 'all' will make it show up all the time. Use sparingly.
* @param string $group Group for the item. Each submenu group has its own
* @return BOOL
* @since 1.8
* @see elgg_prepare_submenu
*/
function elgg_add_submenu_item(array $item, $context = 'all', $group = 'default') {
global $CONFIG;
if (!isset($CONFIG->submenu_items)) {
$CONFIG->submenu_items = array();
}
if (!isset($CONFIG->submenu_items[$context])) {
$CONFIG->submenu_items[$context] = array();
}
if (!isset($CONFIG->submenu_items[$context][$group])) {
$CONFIG->submenu_items[$context][$group] = array();
}
if (!isset($item['text'])) {
return FALSE;
}
// we use persistent object properties in the submenu
// setup function, so normalize the array to an object.
// we pass it in as an array because this would be the only
// place in elgg that we ask for an object like this.
// consistency ftw.
$item_obj = new StdClass();
foreach ($item as $k => $v) {
switch ($k) {
case 'parent_id':
case 'id':
// make sure '' and false make sense
$v = (empty($v)) ? NULL : $v;
default:
$item_obj->$k = $v;
break;
}
}
$CONFIG->submenu_items[$context][$group][] = $item_obj;
return TRUE;
}
/**
* Properly nest all submenu entries for contexts $context and 'all'
*
* @param string $context
* @param bool $sort Sort the menu items alphabetically
* @since 1.8
* @see elgg_add_submenu_item
*/
function elgg_prepare_submenu($context = 'main', $sort = FALSE) {
global $CONFIG;
if (!isset($CONFIG->submenu_items) || !($CONFIG->submenu_items)) {
return FALSE;
}
$groups = array();
if (isset($CONFIG->submenu_items['all'])) {
$groups = $CONFIG->submenu_items['all'];
}
if (isset($CONFIG->submenu_items[$context])) {
$groups = array_merge_recursive($groups, $CONFIG->submenu_items[$context]);
}
if (!$groups) {
return FALSE;
}
foreach ($groups as $group => $items) {
if ($sort) {
usort($items, 'elgg_submenu_item_cmp');
}
$parsed_menu = array();
// determin which children need to go in this item.
foreach ($items as $i => $item) {
// can only support children if there's an id
if (isset($item->id)) {
foreach ($items as $child_i => $child_item) {
// don't check ourselves or used children.
if ($child_i == $i || $child_item->used == TRUE) {
continue;
}
if (isset($child_item->parent_id) && $child_item->parent_id == $item->id) {
if (!isset($item->children)) {
$item->children = array();
}
$item->children[] = $child_item;
$child_item->parent = $item;
// don't unset because we still need to check this item for children
$child_item->used = TRUE;
}
}
// if the parent doesn't have a url, make it the first child item.
if (isset($item->children) && $item->children && !$item->href) {
$child = $item->children[0];
while ($child && !isset($child->href)) {
if (isset($child->children) && isset($child->children[0])) {
$child = $child->children[0];
} else {
$child = NULL;
}
}
if ($child && isset($child->href)) {
$item->href = $child->href;
} else {
// @todo There are no URLs anywhere in this tree.
$item->href = $CONFIG->url;
}
}
}
// only add top-level elements to the menu.
// the rest are children.
if (!isset($item->parent_id)) {
$parsed_menu[] = $item;
}
}
$CONFIG->submenu[$context][$group] = $parsed_menu;
}
return TRUE;
}
/**
* Helper function used to sort submenu items by their display text.
*
* @param object $a
* @param object $b
* @since 1.8
* @see elgg_prepare_submenu
*/
function elgg_submenu_item_cmp($a, $b) {
$a = $a->text;
$b = $b->text;
return strnatcmp($a, $b);
}
/**
* Use elgg_get_submenu().
*
* @see elgg_get_submenu()
* @deprecated 1.8
*/
function get_submenu() {
elgg_deprecated_notice("get_submenu() has been deprecated by elgg_get_submenu()", 1.8);
return elgg_get_submenu();
}
/**
* Return the HTML for a sidemenu.
*
* @param string $context The context of the submenu (defaults to main)
* @param BOOL $sort Sort by display name?
* @return string Formatted HTML.
* @since 1.8
* @todo Rename to a view function. See {@trac #2320}.
*/
function elgg_get_submenu($context = NULL, $sort = FALSE) {
global $CONFIG;
if (!$context) {
$context = get_context();
}
if (!elgg_prepare_submenu($context, $sort)) {
return '';
}
$groups = $CONFIG->submenu[$context];
$submenu_html = '';
foreach ($groups as $group => $items) {
// how far down we are in children arrays
$depth = 0;
// push and pop parent items
$temp_items = array();
while ($item = current($items)) {
// ignore parents created by a child but parent never defined properly
if (!isset($item->text) || !($item->text)) {
next($items);
continue;
}
// try to guess if this should be selected if they don't specify
if ((!isset($item->selected) || $item->selected === NULL) && isset($item->href)) {
$item->selected = elgg_http_url_is_identical(full_url(), $item->href);
}
// traverse up the parent tree if matached to mark all parents as selected/expanded.
if ($item->selected && isset($item->parent)) {
$parent = $item->parent;
while ($parent) {
$parent->selected = TRUE;
if (isset($parent->parent)) {
$parent = $parent->parent;
} else {
$parent = NULL;
}
}
}
// get the next item
if (isset($item->children) && $item->children) {
$depth++;
array_push($temp_items, $items);
$items = $item->children;
} elseif ($depth > 0) {
// check if there are more children elements in the current items
// pop back up to the parent(s) if not
if ($item = next($items)) {
continue;
} else {
while($depth > 0) {
$depth--;
$items = array_pop($temp_items);
if ($item = next($items)) {
break;
}
}
}
} else {
next($items);
}
}
$submenu_html .= elgg_view('navigation/submenu_group', array('group' => $group, 'items' => $items));
}
// include the JS for the expand menus too
return elgg_view('navigation/submenu_js') . $submenu_html;
}
/**
* Returns the HTML for "likes" and "like this" on entities.
*
* @param ElggEntity $entity The entity to like
* @return string|false The HTML for the likes, or false on failure
* @since 1.8
* @see @elgg_view likes/forms/edit
*/
function elgg_view_likes($entity){
if (!($entity instanceof ElggEntity)) {
return false;
}
if ($likes = trigger_plugin_hook('likes', $entity->getType(), array('entity' => $entity), false)) {
return $likes;
} else {
$likes = elgg_view('likes/forms/edit', array('entity' => $entity));
return $likes;
}
}
/**
* Count the number of likes attached to an entity
*
* @param ElggEntity $entity
* @return int Number of likes
* @since 1.8
*/
function elgg_count_likes($entity) {
if ($likeno = trigger_plugin_hook('likes:count', $entity->getType(),
array('entity' => $entity), false)) {
return $likeno;
} else {
return count_annotations($entity->getGUID(), "", "", "likes");
}
}
/**
* Count the number of comments attached to an entity
*
* @param ElggEntity $entity
* @return int Number of comments
*/
function elgg_count_comments($entity) {
if ($commentno = trigger_plugin_hook('comments:count', $entity->getType(),
array('entity' => $entity), false)) {
return $commentno;
} else {
return count_annotations($entity->getGUID(), "", "", "generic_comment");
}
}
/**
* @deprecated 1.7
*/
function get_library_files($directory, $exceptions = array(), $list = array()) {
elgg_deprecated_notice('get_library_files() deprecated by elgg_get_file_list()', 1.7);
return elgg_get_file_list($directory, $exceptions, $list, array('.php'));
}
/**
* Returns a list of files in $directory.
*
* Only returns files. Does not recurse into subdirs.
*
* @param string $directory
* @param array $exceptions Array of filenames to ignore
* @param array $list Array of files to append to
* @param mixed $extensions Array of extensions to allow, NULL for all. Use a dot: array('.php').
* @return array Filenames in $directory, in the form $directory/filename.
*/
function elgg_get_file_list($directory, $exceptions = array(), $list = array(), $extensions = NULL) {
$directory = sanitise_filepath($directory);
if ($handle = opendir($directory)) {
while (($file = readdir($handle)) !== FALSE) {
if (!is_file($directory . $file) || in_array($file, $exceptions)) {
continue;
}
if (is_array($extensions)) {
if (in_array(strrchr($file, '.'), $extensions)) {
$list[] = $directory . $file;
}
} else {
$list[] = $directory . $file;
}
}
closedir($handle);
}
return $list;
}
/**
* Adds an entry in $CONFIG[$register_name][$subregister_name].
*
* This is only used for the site-wide menu. See {@link add_menu()}.
*
* @param string $register_name The name of the top-level register
* @param string $subregister_name The name of the subregister
* @param mixed $subregister_value The value of the subregister
* @param array $children_array Optionally, an array of children
* @return true|false Depending on success
* @todo Can be deprecated when the new menu system is introduced.
*/
function add_to_register($register_name, $subregister_name, $subregister_value, $children_array = array()) {
global $CONFIG;
if (empty($register_name) || empty($subregister_name)) {
return false;
}
if (!isset($CONFIG->registers)) {
$CONFIG->registers = array();
}
if (!isset($CONFIG->registers[$register_name])) {
$CONFIG->registers[$register_name] = array();
}
$subregister = new stdClass;
$subregister->name = $subregister_name;
$subregister->value = $subregister_value;
if (is_array($children_array)) {
$subregister->children = $children_array;
}
$CONFIG->registers[$register_name][$subregister_name] = $subregister;
return true;
}
/**
* Removes a register entry from $CONFIG[register_name][subregister_name]
*
* This is used to by {@link remove_menu()} to remove site-wide menu items.
*
* @param string $register_name The name of the top-level register
* @param string $subregister_name The name of the subregister
* @return true|false Depending on success
* @since 1.7.0
* @todo Can be deprecated when the new menu system is introduced.
*/
function remove_from_register($register_name, $subregister_name) {
global $CONFIG;
if (empty($register_name) || empty($subregister_name)) {
return false;
}
if (!isset($CONFIG->registers)) {
return false;
}
if (!isset($CONFIG->registers[$register_name])) {
return false;
}
if (isset($CONFIG->registers[$register_name][$subregister_name])) {
unset($CONFIG->registers[$register_name][$subregister_name]);
return true;
}
return false;
}
/**
* Constructs and returns a register object.
*
* @param string $register_name The name of the register
* @param mixed $register_value The value of the register
* @param array $children_array Optionally, an array of children
* @return false|stdClass Depending on success
* @todo Can be deprecated when the new menu system is introduced.
*/
function make_register_object($register_name, $register_value, $children_array = array()) {
elgg_deprecated_notice('make_register_object() is deprecated by add_submenu_item()', 1.7);
if (empty($register_name) || empty($register_value)) {
return false;
}
$register = new stdClass;
$register->name = $register_name;
$register->value = $register_value;
$register->children = $children_array;
return $register;
}
/**
* If it exists, returns a particular register as an array
*
* @param string $register_name The name of the register
* @return array|false Depending on success
* @todo Can be deprecated when the new menu system is introduced.
*/
function get_register($register_name) {
global $CONFIG;
if (isset($CONFIG->registers[$register_name])) {
return $CONFIG->registers[$register_name];
}
return false;
}
/**
* Adds an item to the site-wide menu.
*
* You can obtain the menu array by calling {@link get_register('menu')}
*
* @param string $menu_name The name of the menu item
* @param string $menu_url The URL of the page
* @param array $menu_children Optionally, an array of submenu items (not currently used)
* @param string $context
* @return true|false Depending on success
* @todo Can be deprecated when the new menu system is introduced.
*/
function add_menu($menu_name, $menu_url, $menu_children = array(), $context = "") {
global $CONFIG;
if (!isset($CONFIG->menucontexts)) {
$CONFIG->menucontexts = array();
}
if (empty($context)) {
$context = get_plugin_name();
}
$value = new stdClass();
$value->url = $menu_url;
$value->context = $context;
$CONFIG->menucontexts[] = $context;
return add_to_register('menu', $menu_name, $value, $menu_children);
}
/**
* Removes an item from the menu register
*
* @param string $menu_name The name of the menu item
* @return true|false Depending on success
*/
function remove_menu($menu_name) {
return remove_from_register('menu', $menu_name);
}
/**
* Returns a menu item for use in the children section of add_menu()
* This is not currently used in the Elgg core.
*
* @param string $menu_name The name of the menu item
* @param string $menu_url Its URL
* @return stdClass|false Depending on success
* @todo Can be deprecated when the new menu system is introduced.
*/
function menu_item($menu_name, $menu_url) {
elgg_deprecated_notice('menu_item() is deprecated by add_submenu_item', 1.7);
return make_register_object($menu_name, $menu_url);
}
/**
* Queues a message to be displayed.
*
* Messages will not be displayed immediately, but are stored in
* for later display, usually upon next page load.
*
* The method of displaying these messages differs depending upon plugins and
* viewtypes. The core default viewtype retrieves messages in {@link views/default/page_shells/default.php}
* and displays messages as javascript popups.
*
* @internal Messages are stored as strings in the $_SESSION['msg'][$register] array.
*
* @warning This function is used to both add to and clear the message
* stack. If $messages is null, $register will be returned and cleared.
* If $messages is null and $register is empty, all messages will be
* returned and removed.
*
* @important This function handles the standard {@link system_message()} ($register =
* 'messages') as well as {@link register_error()} messages ($register = 'errors').
*
* @param string|array $message Optionally, a single message or array of messages to add, (default: null)
* @param string $register This allows for different types of messages: "errors", "messages" (default: messages)
* @param bool $count Count the number of messages (default: false)
* @return true|false|array Either the array of messages, or a response regarding whether the message addition was successful
* @todo Clean up. Separate registering messages and retrieving them.
*/
function system_messages($message = null, $register = "messages", $count = false) {
if (!isset($_SESSION['msg'])) {
$_SESSION['msg'] = array();
}
if (!isset($_SESSION['msg'][$register]) && !empty($register)) {
$_SESSION['msg'][$register] = array();
}
if (!$count) {
if (!empty($message) && is_array($message)) {
$_SESSION['msg'][$register] = array_merge($_SESSION['msg'][$register], $message);
return true;
} else if (!empty($message) && is_string($message)) {
$_SESSION['msg'][$register][] = $message;
return true;
} else if (is_null($message)) {
if ($register != "") {
$returnarray = array();
$returnarray[$register] = $_SESSION['msg'][$register];
$_SESSION['msg'][$register] = array();
} else {
$returnarray = $_SESSION['msg'];
$_SESSION['msg'] = array();
}
return $returnarray;
}
} else {
if (!empty($register)) {
return sizeof($_SESSION['msg'][$register]);
} else {
$count = 0;
foreach($_SESSION['msg'] as $register => $submessages) {
$count += sizeof($submessages);
}
return $count;
}
}
return false;
}
/**
* Counts the number of messages, either globally or in a particular register
*
* @param string $register Optionally, the register
* @return integer The number of messages
*/
function count_messages($register = "") {
return system_messages(null, $register, true);
}
/**
* Display a system message on next page load.
*
* @see system_messages()
* @param string|array $message Message or messages to add
* @return Bool
*/
function system_message($message) {
return system_messages($message, "messages");
}
/**
* Display an error on next page load.
*
* @see system_messages()
* @param string|array $message Error or errors to add
* @return true|false Success response
*/
function register_error($error) {
return system_messages($error, "errors");
}
/**
* Register a callback function as a handler or trigger registered handlers for an event.
*
* Elgg emits an event when certain core actions occur, like creating an entity.
* Functions registered to these events can respond to the event, prevent the
* event from completing, or ignore the event.
*
* Callback functions are registered with {@link register_elgg_event_handler()}
*
* When an event is triggered ({@link trigger_elgg_event()}, each callback function is
* run in order of priority. Any callback that returns false will halt execution
* and control will be passed back to the caller.
*
* @internal Events are stored in $CONFIG->events as:
*
* $CONFIG->events[$event][$type][$priority] = 'callback_function'
*
*
* @note You cannot generally alter the event, only halt it.
* @tip Plugin authors should use {@link register_elgg_event_handler()} to register events.
*
* @param string $event The type of event (eg 'init', 'update', 'delete')
* @param string $object_type The type of object (eg 'system', 'blog', 'user')
* @param string $function The name of the function that will handle the event
* @param int $priority A priority to add new event handlers at. Lower numbers will be called first (default 500)
* @param boolean $call Set to true to call the event rather than add to it (default false)
* @param mixed $object Optionally, the object the event is being performed on (eg a user)
* @return true|false Depending on success
*
* @todo Separate registering and calling events. {@trac #2466}
* @example events/basic.php Register and respond to an Elgg event
* @example events/advanced.php Register for an Elgg event and optionally halt it.
* @internal @example events/emit.php Basic emitting of an Elgg event.
* @link http://docs.elgg.org/Tutorials/Core/Events
*/
function events($event = "", $object_type = "", $function = "", $priority = 500, $call = false, $object = null) {
global $CONFIG;
if (!isset($CONFIG->events)) {
$CONFIG->events = array();
} else if (!isset($CONFIG->events[$event]) && !empty($event)) {
$CONFIG->events[$event] = array();
} else if (!isset($CONFIG->events[$event][$object_type]) && !empty($event) && !empty($object_type)) {
$CONFIG->events[$event][$object_type] = array();
}
if (!$call) {
if (!empty($event) && !empty($object_type) && is_callable($function)) {
$priority = (int) $priority;
if ($priority < 0) {
$priority = 0;
}
while (isset($CONFIG->events[$event][$object_type][$priority])) {
$priority++;
}
$CONFIG->events[$event][$object_type][$priority] = $function;
ksort($CONFIG->events[$event][$object_type]);
return true;
} else {
return false;
}
} else {
$return = true;
if (!empty($CONFIG->events[$event][$object_type]) && is_array($CONFIG->events[$event][$object_type])) {
foreach($CONFIG->events[$event][$object_type] as $eventfunction) {
if ($eventfunction($event, $object_type, $object) === false) {
return false;
}
}
}
if (!empty($CONFIG->events['all'][$object_type]) && is_array($CONFIG->events['all'][$object_type])) {
foreach($CONFIG->events['all'][$object_type] as $eventfunction) {
if ($eventfunction($event, $object_type, $object) === false) {
return false;
}
}
}
if (!empty($CONFIG->events[$event]['all']) && is_array($CONFIG->events[$event]['all'])) {
foreach($CONFIG->events[$event]['all'] as $eventfunction) {
if ($eventfunction($event, $object_type, $object) === false) {
return false;
}
}
}
if (!empty($CONFIG->events['all']['all']) && is_array($CONFIG->events['all']['all'])) {
foreach($CONFIG->events['all']['all'] as $eventfunction) {
if ($eventfunction($event, $object_type, $object) === false) {
return false;
}
}
}
return $return;
}
return false;
}
/**
* Register a callback function as an Elgg event handler.
*
* Events are emitted by Elgg when certain actions occur. Plugins
* can respond to these events or halt them completely by registering a handler
* as a callback function to an event. Multiple handlers can be registered for
* the same event and will be executed in order of $priority. Any handler
* returning false will halt the execution chain.
*
* This function is called with the event name, event type, and handler function name.
* Setting the optional $priority allows plugin authors to specify when the
* function should be run. Priorities for plugins should be 1-1000.
*
* The callback function is passed 3 arguments when called: $event, $type, and optional $params.
*
* $event is the name of event being emitted.
* $type is the type of event or object concerned.
* $params is an optional parameter passed that can include a related object. See
* specific event documentation for details on which events pass what parameteres.
*
* @tip If a priority isn't specified it is determined by the order the handler was
* registered relative to the event and type. For plugins, this generally means
* the earlier the plugin is in the load order, the earlier the priorities are for
* any event handlers.
*
* @tip $event and $object_type can use the special keyword 'all'. Handler functions registered
* with $event = all will be called for all events of type $object_type. Similarly,
* functions registered with $object_type = all will be called for all events of type
* $event, regardless of $object_type. If $event and $object_type both are 'all', the
* handler function will be called for all events.
*
* @tip Event handler functions are considered in the follow order:
* - Specific registration where 'all' isn't used.
* - Registration where 'all' is used for $event only.
* - Registration where 'all' is used for $type only.
* - Registration where 'all' is used for both.
*
* @warning If you use the 'all' keyword, you must have logic in the handler function to
* test the passed parameters before taking an action.
*
* @tip When referring to events, the preferred syntax is "event, type".
*
* @param string $event The event type
* @param string $object_type The object type
* @param string $function The handler callback function name
* @param int $priority The priority of the event
* @return bool
* @link http://docs.elgg.org/Tutorials/Plugins/Events
* @example events/basic.php Basic example of registering an event handler callback function.
* @example events/advanced.php Advanced example of registering an event handler callback function and halting execution.
* @example events/all.php Example of how to use the 'all' keyword.
*/
function register_elgg_event_handler($event, $object_type, $function, $priority = 500) {
return events($event, $object_type, $function, $priority);
}
/**
* Unregisters a callback function from an event.
*
* @param string $event The event type
* @param string $object_type The object type
* @param string $function The function name
* @since 1.7.0
*/
function unregister_elgg_event_handler($event, $object_type, $function) {
global $CONFIG;
foreach($CONFIG->events[$event][$object_type] as $key => $event_function) {
if ($event_function == $function) {
unset($CONFIG->events[$event][$object_type][$key]);
}
}
}
/**
* Trigger an Elgg Event and run all handler functions registered to that event, type.
*
* This function runs all handlers regsitered to $event, $object_type or
* the special keyword 'all' for either or both.
*
* $event is usually a verb: create, update, delete, annotation.
*
* $object_type is usually a noun: object, group, user, annotation, relationship, metadata.
*
* $object is usually an Elgg* object assciated with the event.
*
* @warning Elgg events should only be called by core. Plugin authors should use
* {@link trigger_elgg_plugin_hook()} instead.
*
* @tip When referring to events, the preferred syntax is "event, type".
*
* @internal Only rarely should events be changed, added, or removed in core.
* When making changes to events, be sure to first create a ticket in trac.
*
* @internal @tip Think of $object_type as the primary namespace element, and
* $event as the secondary namespace.
*
* @param string $event The event type
* @param string $object_type The object type
* @param string $function The function name
* @return bool The result of running all handler functions.
* @link http://docs.elgg.org/Tutorials/Core/Events
*/
function trigger_elgg_event($event, $object_type, $object = null) {
$return = true;
$return1 = events($event, $object_type, "", null, true, $object);
if (!is_null($return1)) {
$return = $return1;
}
return $return;
}
/**
* Register a callback function as a plugin hook handler.
*
* Plugin hooks allow developers to losely couple plugins and features by
* repsonding to and emitting {@link trigger_plugin_hook()} customizable hooks.
* Handler functions can respond to the hook, change the details of the hook, or ignore it.
*
* Multiple handlers can be registered for a plugin hook, and each callback
* function is called in order of priority. If the return value of a handler
* function is not null, that value is passed to the next function in the
* call stack. When all functions have been run, the final value is passed
* back to the caller via {@link trigger_plugin_hook()}.
*
* Similar to Elgg Events, plugin hook handler functions are registered by passing
* a hook, a type, and a priority.
*
* The callback function is passed 4 arguments when called: $hook, $type
* $value, and $params.
*
* - str $hook The name of the hook.
* - str $type The type of hook.
* - mixed $value The return value of the last handler or the default
* value if no other handlers have been called.
* - mixed $params An optional array of parameters. Used to provide additional information
* to plugins.
*
* @internal Plugin hooks are stored in $CONFIG->hooks as:
*
* $CONFIG->hooks[$hook][$type][$priority] = 'callback_function'
*
*
* @tip Plugin hooks are similar to Elgg Events in that Elgg emits
* a plugin hook when certain actions occur, but a plugin hook allows you to alter the
* parameters, as well as halt execution.
*
* @tip If a priority isn't specified it is determined by the order the handler was
* registered relative to the event and type. For plugins, this generally means
* the earlier the plugin is in the load order, the earlier the priorities are for
* any event handlers.
*
* @tip Like Elgg Events, $hook and $type can use the special keyword 'all'.
* Handler functions registered with $hook = all will be called for all hooks
* of type $type. Similarly, handlers registered with $type = all will be
* called for all hooks of type $event, regardless of $object_type. If $hook
* and $type both are 'all', the handler will be called for all hooks.
*
* @tip Plugin hooks are sometimes used to gather lists from plugins. This is
* usually done by pushing elements into an array passed in $params. Be sure
* to append to and then return $value so you don't overwrite other plugin's
* values.
*
* @warning Unlike Elgg Events, a handler that returns false will NOT halt the
* execution chain.
*
* @param string $hook The name of the hook
* @param string $type The type of the hook
* @param string $function The name of a valid function to be run
* @param string $priority The priority - 0 is first, 1000 last, default is 500
* @return bool
*
* @example hooks/register/basic.php Registering for a plugin hook and examining the variables.
* @example hooks/register/advanced.php Registering for a plugin hook and changing the params.
* @link http://docs.elgg.org/Tutorials/Plugins/Hooks
*/
function register_plugin_hook($hook, $type, $function, $priority = 500) {
global $CONFIG;
if (!isset($CONFIG->hooks)) {
$CONFIG->hooks = array();
} else if (!isset($CONFIG->hooks[$hook]) && !empty($hook)) {
$CONFIG->hooks[$hook] = array();
} else if (!isset($CONFIG->hooks[$hook][$type]) && !empty($type)) {
$CONFIG->hooks[$hook][$type] = array();
}
if (!empty($hook) && !empty($type) && is_callable($function)) {
$priority = (int) $priority;
if ($priority < 0) {
$priority = 0;
}
while (isset($CONFIG->hooks[$hook][$type][$priority])) {
$priority++;
}
$CONFIG->hooks[$hook][$type][$priority] = $function;
ksort($CONFIG->hooks[$hook][$type]);
return true;
} else {
return false;
}
}
/**
* Unregister a callback function as a plugin hook.
*
* @param string $hook The name of the hook
* @param string $entity_type The name of the type of entity (eg "user", "object" etc)
* @param string $function The name of a valid function to be run
* @since 1.7.0
*/
function unregister_plugin_hook($hook, $entity_type, $function) {
global $CONFIG;
foreach($CONFIG->hooks[$hook][$entity_type] as $key => $hook_function) {
if ($hook_function == $function) {
unset($CONFIG->hooks[$hook][$entity_type][$key]);
}
}
}
/**
* Trigger a Plugin Hook and run all handler functions registered to that hook:type.
*
* This function runs all handlers regsitered to $hook, $type or
* the special keyword 'all' for either or both.
*
* Use $params to send additional information to the handler functions.
*
* $returnvalue Is the initial value to pass to the handlers, which can
* then change it. It is useful to use $returnvalue to set defaults.
* If no handlers are registered, $returnvalue is immediately returned.
*
* $hook is usually a verb: import, get_views, output.
*
* $type is usually a noun: user, ecml, page.
*
* @tip Like Elgg Events, $hook and $type can use the special keyword 'all'.
* Handler functions registered with $hook = all will be called for all hooks
* of type $type. Similarly, handlers registered with $type = all will be
* called for all hooks of type $event, regardless of $object_type. If $hook
* and $type both are 'all', the handler will be called for all hooks.
*
* @see register_plugin_hook()
* @param string $hook The name of the hook to trigger (NB: "all" will trigger for all $types regardless of $hook value)
* @param string $type The type of the hook to trigger (NB: "all" will trigger for all $hooks regardless of $type value)
* @param mixed $params Additional parameters to pass to the handlers
* @param mixed $returnvalue An initial return value
* @return mixed|null The return value of the last handler function called
*
* @example hooks/trigger/basic.php Trigger a hook that determins if execution should continue.
* @example hooks/trigger/advanced.php Trigger a hook with a default value and use the results to populate a menu.
* @example hooks/basic.php Trigger and respond to a basic plugin hook.
* @link http://docs.elgg.org/Tutorials/Plugins/Hooks
*/
function trigger_plugin_hook($hook, $type, $params = null, $returnvalue = null) {
global $CONFIG;
if (!empty($CONFIG->hooks[$hook][$type]) && is_array($CONFIG->hooks[$hook][$type])) {
foreach($CONFIG->hooks[$hook][$type] as $hookfunction) {
$temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
if (!is_null($temp_return_value)) {
$returnvalue = $temp_return_value;
}
}
}
if (!empty($CONFIG->hooks['all'][$type]) && is_array($CONFIG->hooks['all'][$type])) {
foreach($CONFIG->hooks['all'][$type] as $hookfunction) {
$temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
if (!is_null($temp_return_value)) {
$returnvalue = $temp_return_value;
}
}
}
if (!empty($CONFIG->hooks[$hook]['all']) && is_array($CONFIG->hooks[$hook]['all'])) {
foreach($CONFIG->hooks[$hook]['all'] as $hookfunction) {
$temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
if (!is_null($temp_return_value)) {
$returnvalue = $temp_return_value;
}
}
}
if (!empty($CONFIG->hooks['all']['all']) && is_array($CONFIG->hooks['all']['all'])) {
foreach($CONFIG->hooks['all']['all'] as $hookfunction) {
$temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
if (!is_null($temp_return_value)) {
$returnvalue = $temp_return_value;
}
}
}
return $returnvalue;
}
/**
* 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 at the point that the error occurred
*/
function __elgg_php_error_handler($errno, $errmsg, $filename, $linenum, $vars) {
$error = date("Y-m-d H:i:s (T)") . ": \"$errmsg\" in file $filename (line $linenum)";
switch ($errno) {
case E_USER_ERROR:
error_log("PHP ERROR: $error");
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 :
error_log("PHP WARNING: $error");
break;
default:
global $CONFIG;
if (isset($CONFIG->debug) && $CONFIG->debug === 'NOTICE') {
error_log("PHP NOTICE: $error");
}
}
return true;
}
/**
* Display or log a message.
*
* If $level is >= to the debug setting in {@link $CONFIG->debug}, the
* message will be sent to {@link elgg_dump()}. Messages with lower
* priority than {@link $CONFIG->debug} are ignored.
*
* {@link elgg_dump()} outputs all levels but NOTICE to screen by default.
*
* @note No messages will be displayed unless debugging has been enabled.
*
* @param str $message User message
* @param str $level NOTICE | WARNING | ERROR | DEBUG
* @return bool
* @since 1.7.0
* @todo This is complicated and confusing. Using int constants for debug levels will make things easier.
*/
function elgg_log($message, $level='NOTICE') {
global $CONFIG;
// only log when debugging is enabled
if (isset($CONFIG->debug)) {
// debug to screen or log?
$to_screen = !($CONFIG->debug == 'NOTICE');
switch ($level) {
case 'ERROR':
// always report
elgg_dump("$level: $message", $to_screen, $level);
break;
case 'WARNING':
case 'DEBUG':
// report except if user wants only errors
if ($CONFIG->debug != 'ERROR') {
elgg_dump("$level: $message", $to_screen, $level);
}
break;
case 'NOTICE':
default:
// only report when lowest level is desired
if ($CONFIG->debug == 'NOTICE') {
elgg_dump("$level: $message", FALSE, $level);
}
break;
}
return TRUE;
}
return FALSE;
}
/**
* Logs or displays $value.
*
* If $to_screen is true, $value is displayed to screen. Else,
* it is handled by PHP's {@link error_log()} function.
*
* A {@elgg_plugin_hook debug log} is called. If a handler returns
* false, it will stop the default logging method.
*
* @param mixed $value
* @param bool $to_screen
* @param string $level
* @return void
* @since 1.7.0
*/
function elgg_dump($value, $to_screen = TRUE, $level = 'NOTICE') {
global $CONFIG;
// plugin can return false to stop the default logging method
$params = array('level' => $level,
'msg' => $value,
'to_screen' => $to_screen);
if (!trigger_plugin_hook('debug', 'log', $params, true)) {
return;
}
// Do not want to write to screen before page creation has started.
// This is not fool-proof but probably fixes 95% of the cases when logging
// results in data sent to the browser before the page is begun.
if (!isset($CONFIG->pagesetupdone)) {
$to_screen = FALSE;
}
if ($to_screen == TRUE) {
echo '
';
print_r($value);
echo '
';
} else {
error_log(print_r($value, TRUE));
}
}
/**
* Intercepts, logs, and display uncaught exceptions.
*
* @warning This function should never be called directly.
*
* @see http://www.php.net/set-exception-handler
* @param Exception $exception The exception being handled
*/
function __elgg_php_exception_handler($exception) {
error_log("*** FATAL EXCEPTION *** : " . $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);
// @note Do not send a 500 header because it is not a server error
//header("Internal Server Error", true, 500);
elgg_set_viewtype('failsafe');
$body = elgg_view("messages/exceptions/exception", array('object' => $exception));
page_draw(elgg_echo('exception:title'), $body);
}
/**
* An array of key value pairs from the datalists table.
*
* Used as a cache in datalist functions.
*
* @global array $DATALIST_CACHE
*/
$DATALIST_CACHE = array();
/**
* Get the value of a datalist element.
*
* @internal Datalists are stored in the datalist table.
*
* @tip Use datalists to store information common to a full installation.
*
* @param string $name The name of the datalist element
* @return string|false The datalist value or false if it doesn't exist.
*/
function datalist_get($name) {
global $CONFIG, $DATALIST_CACHE;
// We need this, because sometimes datalists are attempted
// to be retrieved before the database is created
if (!is_db_installed()) {
return false;
}
$name = sanitise_string($name);
if (isset($DATALIST_CACHE[$name])) {
return $DATALIST_CACHE[$name];
}
// If memcache enabled then cache value in memcache
$value = null;
static $datalist_memcache;
if ((!$datalist_memcache) && (is_memcache_available())) {
$datalist_memcache = new ElggMemcache('datalist_memcache');
}
if ($datalist_memcache) {
$value = $datalist_memcache->load($name);
}
if ($value) {
return $value;
}
// [Marcus Povey 20090217 : Now retrieving all datalist values on first load as this saves about 9 queries per page]
$result = get_data("SELECT * from {$CONFIG->dbprefix}datalists");
if ($result) {
foreach ($result as $row) {
$DATALIST_CACHE[$row->name] = $row->value;
// Cache it if memcache is available
if ($datalist_memcache) {
$datalist_memcache->save($row->name, $row->value);
}
}
if (isset($DATALIST_CACHE[$name])) {
return $DATALIST_CACHE[$name];
}
}
return false;
}
/**
* Set the value for a datalist element.
*
* @param string $name The name of the datalist
* @param string $value The new value
* @return true
*/
function datalist_set($name, $value) {
global $CONFIG, $DATALIST_CACHE;
$name = sanitise_string($name);
$value = sanitise_string($value);
// If memcache is available then invalidate the cached copy
static $datalist_memcache;
if ((!$datalist_memcache) && (is_memcache_available())) {
$datalist_memcache = new ElggMemcache('datalist_memcache');
}
if ($datalist_memcache) {
$datalist_memcache->delete($name);
}
insert_data("INSERT into {$CONFIG->dbprefix}datalists set name = '{$name}', value = '{$value}' ON DUPLICATE KEY UPDATE value='{$value}'");
$DATALIST_CACHE[$name] = $value;
return true;
}
/**
* Run a function one time per installation.
*
* If you pass a timestamp as the second argument, it will run the function
* only if (i) it has never been run before or (ii) the timestamp is >=
* the last time it was run.
*
* @warning Functions are determined by their name. If you change the name of a function
* it will be run again.
*
* @tip Use $timelastupdatedcheck in your plugins init function to perform automated
* upgrades. Schedule a function to run once and pass the timestamp of the new release.
* This will cause the run once function to be run on all installations. To perform
* additional upgrades, create new functions for each release.
*
* @internal A datalist entry $functioname is created with the value of time().
*
* @param string $functionname The name of the function you want to run.
* @param int $timelastupdatedcheck A UNIX timestamp. If time() is > than this, this function will be run again.
* @return bool
*/
function run_function_once($functionname, $timelastupdatedcheck = 0) {
if ($lastupdated = datalist_get($functionname)) {
$lastupdated = (int) $lastupdated;
} else {
$lastupdated = 0;
}
if (is_callable($functionname) && $lastupdated <= $timelastupdatedcheck) {
$functionname();
datalist_set($functionname, time());
return true;
} else {
return false;
}
}
/**
* Sends a notice about deprecated use of a function, view, etc.
*
* This function either displays or logs the deprecation message,
* depending upon the deprecation policies in {@link CODING.txt}.
* Logged messages are sent with the level of 'WARNING'.
*
* A user-visual message will be displayed if $dep_version is greater
* than 1 minor releases lower than the current Elgg version, or at all
* lower than the current Elgg major version.
*
* @note This will always at least log a warning. Don't use to pre-deprecate things.
* This assumes we are releasing in order and deprecating according to policy.
*
* @see CODING.txt
* @param str $msg Message to log / display.
* @param str $version human-readable *release* version: 1.7, 1.7.3
* @return bool
* @since 1.7.0
*/
function elgg_deprecated_notice($msg, $dep_version) {
// if it's a major release behind, visual and logged
// if it's a 2 minor releases behind, visual and logged
// if it's 1 minor release behind, logged.
// bugfixes don't matter because you're not deprecating between them, RIGHT?
if (!$dep_version) {
return FALSE;
}
$elgg_version = get_version(TRUE);
$elgg_version_arr = explode('.', $elgg_version);
$elgg_major_version = $elgg_version_arr[0];
$elgg_minor_version = $elgg_version_arr[1];
$dep_version_arr = explode('.', $dep_version);
$dep_major_version = $dep_version_arr[0];
$dep_minor_version = $dep_version_arr[1];
$last_working_version = $dep_minor_version - 1;
$visual = FALSE;
// use version_compare to account for 1.7a < 1.7
if (($dep_major_version < $elgg_major_version)
|| (($elgg_minor_version - $last_working_version) > 1)) {
$visual = TRUE;
}
$msg = "Deprecated in $dep_version: $msg";
if ($visual) {
register_error($msg);
}
// Get a file and line number for the log. Never show this in the UI.
// Skip over the function that sent this notice and see who called the deprecated
// function itself.
$backtrace = debug_backtrace();
$caller = $backtrace[1];
$msg .= " (Called from {$caller['file']}:{$caller['line']})";
elgg_log($msg, 'WARNING');
return TRUE;
}
/**
* Checks if code is being called from a certain function.
*
* To use, call this function with the function name (and optional file location) that it has to be called
* from, it will either return true or false.
*
* e.g.
*
* function my_secure_function()
* {
* if (!call_gatekeeper("my_call_function"))
* return false;
*
* ... do secure stuff ...
* }
*
* function my_call_function()
* {
* // will work
* my_secure_function();
* }
*
* function bad_function()
* {
* // Will not work
* my_secure_function();
* }
*
* @param mixed $function The function that this function must have in its call stack,
* to test against a method pass an array containing a class and method name.
* @param string $file Optional file that the function must reside in.
* @todo This is neat but is it necessary?
*/
function call_gatekeeper($function, $file = "") {
// Sanity check
if (!$function) {
return false;
}
// Check against call stack to see if this is being called from the correct location
$callstack = debug_backtrace();
$stack_element = false;
foreach ($callstack as $call) {
if (is_array($function)) {
if (
(strcmp($call['class'], $function[0]) == 0) &&
(strcmp($call['function'], $function[1]) == 0)
) {
$stack_element = $call;
}
} else {
if (strcmp($call['function'], $function) == 0) {
$stack_element = $call;
}
}
}
if (!$stack_element) {
return false;
}
// If file then check that this it is being called from this function
if ($file) {
$mirror = null;
if (is_array($function)) {
$mirror = new ReflectionMethod($function[0], $function[1]);
} else {
$mirror = new ReflectionFunction($function);
}
if ((!$mirror) || (strcmp($file,$mirror->getFileName())!=0)) {
return false;
}
}
return true;
}
/**
* This function checks to see if it is being called at somepoint by a function defined somewhere
* on a given path (optionally including subdirectories).
*
* This function is similar to call_gatekeeper() but returns true if it is being called by a method or function which has been defined on a given path or by a specified file.
*
* @param string $path The full path and filename that this function must have in its call stack If a partial path is given and $include_subdirs is true, then the function will return true if called by any function in or below the specified path.
* @param bool $include_subdirs Are subdirectories of the path ok, or must you specify an absolute path and filename.
* @param bool $strict_mode If true then the calling method or function must be directly called by something on $path, if false the whole call stack is searched.
* @todo Again, very neat, but is it necessary?
*/
function callpath_gatekeeper($path, $include_subdirs = true, $strict_mode = false) {
global $CONFIG;
$path = sanitise_string($path);
if ($path) {
$callstack = debug_backtrace();
foreach ($callstack as $call) {
$call['file'] = str_replace("\\","/",$call['file']);
if ($include_subdirs) {
if (strpos($call['file'], $path) === 0) {
if ($strict_mode) {
$callstack[1]['file'] = str_replace("\\","/",$callstack[1]['file']);
if ($callstack[1] === $call) { return true; }
} else {
return true;
}
}
} else {
if (strcmp($path, $call['file'])==0) {
if ($strict_mode) {
if ($callstack[1] === $call) {
return true;
}
} else {
return true;
}
}
}
}
return false;
}
if (isset($CONFIG->debug)) {
system_message("Gatekeeper'd function called from {$callstack[1]['file']}:{$callstack[1]['line']}\n\nStack trace:\n\n" . print_r($callstack, true));
}
return false;
}
/**
* Return the state of a php.ini setting.
*
* Normalizes the setting to bool.
*
* @param string $ini_get_arg The INI setting
* @return true|false Depending on whether it's on or off
*/
function ini_get_bool($ini_get_arg) {
$temp = ini_get($ini_get_arg);
if ($temp == '1' or strtolower($temp) == 'on') {
return true;
}
return false;
}
/**
* Returns true is string is not empty, false, or null.
*
* Function to be used in array_filter which returns true if $string is not null.
*
* @param string $string
* @return bool
* @todo This is used once in metadata.php. Use a lambda function instead.
*/
function is_not_null($string) {
if (($string==='') || ($string===false) || ($string===null)) {
return false;
}
return true;
}
/**
* Normalise the singular keys in an options array to plural keys.
*
* Used in elgg_get_entities*() functions to support shortcutting plural
* names by singular names.
*
* @param array $options The options array. $options['keys'] = 'values';
* @param array $singulars A list of sinular words to pluralize by adding 's'.
* @return array
* @since 1.7.0
*/
function elgg_normalise_plural_options_array($options, $singulars) {
foreach ($singulars as $singular) {
$plural = $singular . 's';
if (array_key_exists($singular, $options)) {
if ($options[$singular] === ELGG_ENTITIES_ANY_VALUE) {
$options[$plural] = $options[$singular];
} else {
$options[$plural] = array($options[$singular]);
}
}
unset($options[$singular]);
}
return $options;
}
/**
* Return the full URL of the current page.
*
* @return string The URL
* @todo Combine / replace with current_page_url()
*/
function full_url() {
$s = empty($_SERVER["HTTPS"]) ? '' : ($_SERVER["HTTPS"] == "on") ? "s" : "";
$protocol = substr(strtolower($_SERVER["SERVER_PROTOCOL"]), 0, strpos(strtolower($_SERVER["SERVER_PROTOCOL"]), "/")) . $s;
$port = ($_SERVER["SERVER_PORT"] == "80" || $_SERVER["SERVER_PORT"] == "443") ? "" : (":".$_SERVER["SERVER_PORT"]);
// This is here to prevent XSS in poorly written browsers used by 80% of the population.
// {@trac [5813]}
$quotes = array('\'', '"');
$encoded = array('%27', '%22');
return $protocol . "://" . $_SERVER['SERVER_NAME'] . $port . str_replace($quotes, $encoded, $_SERVER['REQUEST_URI']);
}
/**
* Does nothing.
*
* @param $range
* @param $ip
* @deprecated 1.7
*/
function test_ip($range, $ip) {
elgg_deprecated_notice('test_ip() was removed because of licensing issues.', 1.7);
return 0;
}
/**
* Does nothing.
*
* @param array $networks
* @param string $ip
* @return bool
* @deprecated 1.7
*/
function is_ip_in_array(array $networks, $ip) {
elgg_deprecated_notice('is_ip_in_array() was removed because of licensing issues.', 1.7);
return false;
}
/**
* Builds a URL from the a parts array like one returned by {@link parse_url()}.
*
* @note If only partial information is passed, a partial URL will be returned.
*
* @param array $parts Associative array of URL components like parse_url() returns
* @param bool $htmlencode HTML Encode the url?
* @return str Full URL
* @since 1.7.0
*/
function elgg_http_build_url(array $parts, $html_encode = TRUE) {
// build only what's given to us.
$scheme = isset($parts['scheme']) ? "{$parts['scheme']}://" : '';
$host = isset($parts['host']) ? "{$parts['host']}" : '';
$port = isset($parts['port']) ? ":{$parts['port']}" : '';
$path = isset($parts['path']) ? "{$parts['path']}" : '';
$query = isset($parts['query']) ? "?{$parts['query']}" : '';
$string = $scheme . $host . $port . $path . $query;
if ($html_encode) {
return elgg_format_url($string);
} else {
return $string;
}
}
/**
* Adds action tokens to URL
*
* As of 1.7.0 action tokens are required on all actions.
* Use this function to append action tokens to a URL's GET parameters.
* This will preserve any existing GET parameters.
*
* @note If you are using {@elgg_view input/form} you don't need to
* add tokens to the action. The form view automatically handles
* tokens.
*
* @param str $link Full action URL
* @param bool $htmlencode html encode the url?
* @return str URL with action tokens
* @since 1.7.0
* @link http://docs.elgg.org/Tutorials/Actions
*/
function elgg_add_action_tokens_to_url($url, $html_encode = TRUE) {
$components = parse_url($url);
if (isset($components['query'])) {
$query = elgg_parse_str($components['query']);
} else {
$query = array();
}
if (isset($query['__elgg_ts']) && isset($query['__elgg_token'])) {
return $url;
}
// append action tokens to the existing query
$query['__elgg_ts'] = time();
$query['__elgg_token'] = generate_action_token($query['__elgg_ts']);
$components['query'] = http_build_query($query);
// rebuild the full url
return elgg_http_build_url($components, $html_encode);
}
/**
* Add action tokens to URL.
*
* @deprecated 1.7 final
*/
function elgg_validate_action_url($url) {
elgg_deprecated_notice('elgg_validate_action_url had a short life. Use elgg_add_action_tokens_to_url() instead.', '1.7b');
return elgg_add_action_tokens_to_url($url);
}
/**
* Removes an element from a URL's query string.
*
* @note You can send a partial URL string.
*
* @param string $url
* @param string $element
* @return string The new URL with the query element removed.
* @since 1.7.0
*/
function elgg_http_remove_url_query_element($url, $element) {
$url_array = parse_url($url);
if (isset($url_array['query'])) {
$query = elgg_parse_str($url_array['query']);
} else {
// nothing to remove. Return original URL.
return $url;
}
if (array_key_exists($element, $query)) {
unset($query[$element]);
}
$url_array['query'] = http_build_query($query);
$string = elgg_http_build_url($url_array);
return $string;
}
/**
* Adds an element or elements to a URL's query string.
*
* @param str $url The URL
* @param array $elements key/value pairs to add to the URL
* @return str The new URL with the query strings added
* @since 1.7.0
*/
function elgg_http_add_url_query_elements($url, array $elements) {
$url_array = parse_url($url);
if (isset($url_array['query'])) {
$query = elgg_parse_str($url_array['query']);
} else {
$query = array();
}
foreach ($elements as $k => $v) {
$query[$k] = $v;
}
$url_array['query'] = http_build_query($query);
$string = elgg_http_build_url($url_array);
return $string;
}
/**
* Adds a breadcrumb to the breadcrumbs stack.
*
* @param string $title The title to display
* @param string $link Optional. The link for the title.
* @link http://docs.elgg.org/Tutorials/UI/Breadcrumbs
*/
function elgg_push_breadcrumb($title, $link = NULL) {
global $CONFIG;
if (!is_array($CONFIG->breadcrumbs)) {
$CONFIG->breadcrumbs = array();
}
// avoid key collisions.
$CONFIG->breadcrumbs[] = array('title' => $title, 'link' => $link);
}
/**
* Removes last breadcrumb entry.
*
* @return array popped item.
* @link http://docs.elgg.org/Tutorials/UI/Breadcrumbs
*/
function elgg_pop_breadcrumb() {
global $CONFIG;
if (is_array($CONFIG->breadcrumbs)) {
array_pop($CONFIG->breadcrumbs);
}
return FALSE;
}
/**
* Returns all breadcrumbs as an array of array('title' => 'Readable Title', 'link' => 'URL')
*
* @return array Breadcrumbs
* @link http://docs.elgg.org/Tutorials/UI/Breadcrumbs
*/
function elgg_get_breadcrumbs() {
global $CONFIG;
return (is_array($CONFIG->breadcrumbs)) ? $CONFIG->breadcrumbs : array();
}
/**
* Load all the REQUEST variables into the sticky form cache
*
* Call this from an action when you want all your submitted variables
* available if the submission fails validation and is sent back to the form
*
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_make_sticky_form($form_name) {
global $CONFIG;
$CONFIG->active_sticky_form = $form_name;
elgg_clear_sticky_form($form_name);
if (!isset($_SESSION['sticky_forms'])) {
$_SESSION['sticky_forms'] = array();
}
$_SESSION['sticky_forms'][$form_name] = array();
foreach($_REQUEST as $key => $var) {
// will go through XSS filtering on the get function
$_SESSION['sticky_forms'][$form_name][$key] = $var;
}
}
/**
* Clear the sticky form cache
*
* Call this if validation is successful in the action handler or
* when they sticky values have been used to repopulate the form
* after a validation error.
*
* @param string $name Form namespace
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_clear_sticky_form($form_name) {
unset($_SESSION['sticky_forms'][$form_name]);
}
/**
* Has this form been made sticky?
*
* @param string $name Form namespace
* @return boolean
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_is_sticky_form($form_name) {
return isset($_SESSION['sticky_forms'][$form_name]);
}
/**
* Get a specific sticky variable
*
* @param string $variable The name of the variable
* @param mixed $default Default value if the variable does not exist in sticky cache
* @param boolean $filter_result Filter for bad input if true
* @return mixed
*
* @todo should this filter the default value?
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_get_sticky_value($form_name, $variable='', $default = NULL, $filter_result = true) {
if (isset($_SESSION['sticky_forms'][$form_name][$variable])) {
$value = $_SESSION['sticky_forms'][$form_name][$variable];
if ($filter_result) {
// XSS filter result
$value = filter_tags($value);
}
return $value;
}
return $default;
}
/**
* Clear a specific sticky variable
*
* @param string $variable The name of the variable to clear
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_clear_sticky_value($form_name, $variable) {
unset($_SESSION['sticky_forms'][$form_name][$variable]);
}
/**
* Returns the current active sticky form.
* @return mixed Str | FALSE
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_get_active_sticky_form() {
global $CONFIG;
if (isset($CONFIG->active_sticky_form)) {
$form_name = $CONFIG->active_sticky_form;
} else {
return FALSE;
}
return (elgg_is_sticky_form($form_name)) ? $form_name : FALSE;
}
/**
* Sets the active sticky form.
*
* @param string $form_name
* @link http://docs.elgg.org/Tutorials/UI/StickyForms
*/
function elgg_set_active_sticky_form($form_name) {
global $CONFIG;
$CONFIG->active_sticky_form = $form_name;
}
/**
* Returns a PHP INI setting in bytes.
*
* @tip Use this for arithmetic when determining if a file can be uploaded.
*
* @param str $setting
* @return int
* @since 1.7.0
* @link http://www.php.net/manual/en/function.ini-get.php
*/
function elgg_get_ini_setting_in_bytes($setting) {
// retrieve INI setting
$val = ini_get($setting);
// convert INI setting when shorthand notation is used
$last = strtolower($val[strlen($val)-1]);
switch($last) {
case 'g':
$val *= 1024;
case 'm':
$val *= 1024;
case 'k':
$val *= 1024;
}
// return byte value
return $val;
}
/**
* Serve javascript pages.
*
* Searches for views under js/ and outputs them with special
* headers for caching control.
*
* @param $page
* @return unknown_type
* @elgg_pagehandler js
*/
function js_page_handler($page) {
if (is_array($page) && sizeof($page)) {
$js = str_replace('.js','',$page[0]);
$return = elgg_view('js/' . $js);
header('Content-type: text/javascript');
header('Expires: ' . date('r',time() + 864000));
header("Pragma: public");
header("Cache-Control: public");
header("Content-Length: " . strlen($return));
echo $return;
exit;
}
}
function __elgg_autoload($class) {
global $CONFIG;
if (!include($CONFIG->classes[$class])) {
throw new Exception("Failed to autoload $class");
}
}
function elgg_register_classes($dir) {
$classes = elgg_get_file_list($dir, array(), array(), array('.php'));
foreach ($classes as $class) {
elgg_register_class(basename($class, '.php'), $class);
}
}
function elgg_register_class($class, $location) {
global $CONFIG;
if (!isset($CONFIG->classes)) {
$CONFIG->classes = array();
}
$CONFIG->classes[$class] = $location;
}
/**
* Emits a shutdown:system event upon PHP shutdown, but before database connections are dropped.
*
* @tip Register for the shutdown:system event to perform functions at the end of page loads.
*
* @warning Using this event to perform long-running functions is not very useful. Servers will hold pages until processing is done
* before sending them out to the browser.
*
* @see register_shutdown_hook()
*/
function __elgg_shutdown_hook() {
global $START_MICROTIME;
trigger_elgg_event('shutdown', 'system');
$time = (float)(microtime(TRUE) - $START_MICROTIME);
// demoted to NOTICE from DEBUG so javascript is not corrupted
elgg_log("Page {$_SERVER['REQUEST_URI']} generated in $time seconds", 'NOTICE');
}
/**
* Elgg's main init.
*
* Handles core actions for comments and likes, the JS pagehandler, and the shutdown function.
*
* @elgg_event_handler init system
*/
function elgg_init() {
global $CONFIG;
register_action('comments/add');
register_action('comments/delete');
register_action('likes/add');
register_action('likes/delete');
register_page_handler('js', 'js_page_handler');
// Trigger the shutdown:system event upon PHP shutdown.
register_shutdown_function('__elgg_shutdown_hook');
}
/**
* Intercepts the index page when Walled Garden mode is enabled.
*
* @link http://docs.elgg.org/Tutorials/WalledGarden
* @elgg_plugin_hook index system
*/
function elgg_walled_garden_index() {
$login = elgg_view('account/forms/login_walled_garden');
page_draw('', $login, 'page_shells/walled_garden');
// @hack Index must exit to keep plugins from continuing to extend
exit;
}
/**
* Adds unit tests for the general API.
*
* @elgg_plugin_hook unit_tests system
*/
function elgg_api_test($hook, $type, $value, $params) {
global $CONFIG;
$value[] = $CONFIG->path . 'engine/tests/api/entity_getter_functions.php';
$value[] = $CONFIG->path . 'engine/tests/api/helpers.php';
$value[] = $CONFIG->path . 'engine/tests/regression/trac_bugs.php';
return $value;
}
/**
* Returns the main site menu.
*
* @note The main site menu is split into "featured" links and
* "more" links.
*
* @return array ('featured_urls' and 'more')
* @since 1.8
* @link http://docs.elgg.org/Tutorials/UI/SiteMenu
*/
function elgg_get_nav_items() {
$menu_items = get_register('menu');
$featured_urls_info = get_config('menu_items_featured_urls');
$more = array();
$featured_urls = array();
$featured_urls_sanitised = array();
// easier to compare with in_array() than embedded foreach()es
$valid_urls = array();
foreach ($menu_items as $info) {
$valid_urls[] = $info->value->url;
}
// make sure the url is a valid link.
// this prevents disabled plugins leaving behind
// valid links when not using a pagehandler.
if ($featured_urls_info) {
foreach ($featured_urls_info as $info) {
if (in_array($info->value->url, $valid_urls)) {
$featured_urls[] = $info->value->url;
$featured_urls_sanitised[] = $info;
}
}
}
// add toolbar entries if not hiding dupes.
foreach ($menu_items as $name => $info) {
if (!in_array($info->value->url, $featured_urls)) {
$more[] = $info;
}
}
return array(
'featured' => $featured_urls_sanitised,
'more' => $more
);
}
/**
* Registers any custom menu items with the main Site Menu.
*
* @note Custom menu items are added through the admin interface. Plugins
* can add standard menu items by using {@link add_menu()}.
*
* @since 1.8
* @link http://docs.elgg.org/Tutorials/UI/SiteMenu
* @elgg_event_handler init system
*/
function add_custom_menu_items() {
if ($custom_items = get_config('menu_items_custom_items')) {
foreach ($custom_items as $url => $name) {
add_menu($name, $url);
}
}
}
/**
* Test if two URLs are functionally identical.
*
* @tip If $ignore_params is used, neither the name nor its value will be considered when comparing.
*
* @tip The order of GET params doesn't matter.
*
* @param string $url1
* @param string $url2
* @param array $ignore_params - GET params to ignore in the comparison
* @return BOOL
* @since 1.8
*/
function elgg_http_url_is_identical($url1, $url2, $ignore_params = array('offset', 'limit')) {
global $CONFIG;
// if the server portion is missing but it starts with / then add the url in.
if (elgg_substr($url1, 0, 1) == '/') {
$url1 = $CONFIG->url . ltrim($url1, '/');
}
if (elgg_substr($url1, 0, 1) == '/') {
$url2 = $CONFIG->url . ltrim($url2, '/');
}
// @todo - should probably do something with relative URLs
if ($url1 == $url2) {
return TRUE;
}
$url1_info = parse_url($url1);
$url2_info = parse_url($url2);
$url1_info['path'] = trim($url1_info['path'], '/');
$url2_info['path'] = trim($url2_info['path'], '/');
// compare basic bits
$parts = array('scheme', 'host', 'path');
foreach ($parts as $part) {
if ((isset($url1_info[$part]) && isset($url2_info[$part])) && $url1_info[$part] != $url2_info[$part]) {
return FALSE;
} elseif (isset($url1_info[$part]) && !isset($url2_info[$part])) {
return FALSE;
} elseif (!isset($url1_info[$part]) && isset($url2_info[$part])) {
return FALSE;
}
}
// quick compare of get params
if (isset($url1_info['query']) && isset($url2_info['query']) && $url1_info['query'] == $url2_info['query']) {
return TRUE;
}
// compare get params that might be out of order
$url1_params = array();
$url2_params = array();
if (isset($url1_info['query'])) {
if ($url1_info['query'] = html_entity_decode($url1_info['query'])) {
$url1_params = elgg_parse_str($url1_info['query']);
}
}
if (isset($url2_info['query'])) {
if ($url2_info['query'] = html_entity_decode($url2_info['query'])) {
$url2_params = elgg_parse_str($url2_info['query']);
}
}
// drop ignored params
foreach ($ignore_params as $param) {
if (isset($url1_params[$param])) {
unset($url1_params[$param]);
}
if (isset($url2_params[$param])) {
unset($url2_params[$param]);
}
}
// array_diff_assoc only returns the items in arr1 that aren't in arrN
// but not the items that ARE in arrN but NOT in arr1
// if arr1 is an empty array, this function will return 0 no matter what.
// since we only care if they're different and not how different,
// add the results together to get a non-zero (ie, different) result
$diff_count = count(array_diff_assoc($url1_params, $url2_params));
$diff_count += count(array_diff_assoc($url2_params, $url1_params));
if ($diff_count > 0) {
return FALSE;
}
return TRUE;
}
/**
* Checks the status of the Walled Garden and forwards to a login page
* if required.
*
* If the site is in Walled Garden mode, all page except those registered as
* plugin pages by {@elgg_hook public_pages walled_garden} will redirect to
* a login page.
*
* @since 1.8
* @elgg_event_handler init system
* @link http://docs.elgg.org/Tutorials/WalledGarden
*/
function elgg_walled_garden() {
global $CONFIG;
// check for external page view
if (isset($CONFIG->site) && $CONFIG->site instanceof ElggSite) {
$CONFIG->site->check_walled_garden();
}
}
/**
* Checks for $array[$key] and returns its value if it exists, else
* returns $default.
*
* Shorthand for $value = (isset($array['key'])) ? $array['key'] : 'default';
*
* @param string $key The key to check.
* @param array $array The array to check against.
* @param mixed $default Default value to return if nothing is found.
* @since 1.8
*/
function elgg_get_array_value($key, array $array, $default = NULL) {
return (isset($array[$key])) ? $array[$key] : $default;
}
/**
* Sorts a 3d array by specific element.
*
* @warning Will re-index numeric indexes.
*
* @note This operates the same as the built-in sort functions.
* ie, sorts the array and returns a bool for success.
*
* Do this: elgg_sort_3d_array_by_value($my_array);
* Not this: $my_array = elgg_sort_3d_array_by_value($my_array);
*
* @param array $array Array to sort
* @param string $element Element to sort by
* @param $sort_order
* @param $sort_type
* @return bool
*/
function elgg_sort_3d_array_by_value(&$array, $element, $sort_order = SORT_ASC, $sort_type = SORT_LOCALE_STRING) {
$sort = array();
foreach ($array as $k => $v) {
if (isset($v[$element])) {
$sort[] = strtolower($v[$element]);
} else {
$sort[] = NULL;
}
};
return array_multisort($sort, $sort_order, $sort_type, $array);
}
/**#@+
* Controlls access levels on ElggEntity entities, metadata, and annotations.
*
* @var int
*/
define('ACCESS_DEFAULT', -1);
define('ACCESS_PRIVATE', 0);
define('ACCESS_LOGGED_IN', 1);
define('ACCESS_PUBLIC', 2);
define('ACCESS_FRIENDS', -2);
/**#@-*/
/**
* Constant to request the value of a parameter be ignored in elgg_get_*() functions
*
* @see elgg_get_entities()
* @var NULL
* @since 1.7
*/
define('ELGG_ENTITIES_ANY_VALUE', NULL);
/**
* Constant to request the value of a parameter be nothing in elgg_get_*() functions.
*
* @see elgg_get_entities()
* @var int 0
* @since 1.7
*/
define('ELGG_ENTITIES_NO_VALUE', 0);
/**
* Used in calls to forward() to specify the browser should be redirected to the
* referring page.
*
* @see forward
* @var unknown_type
*/
define('REFERRER', -1);
/**
* Alternate spelling for REFERRER. Included because of some bad documentation
* in the original HTTP spec.
*
* @see forward()
* @link http://en.wikipedia.org/wiki/HTTP_referrer#Origin_of_the_term_referer
* @var int -1
*/
define('REFERER', -1);
register_elgg_event_handler('init', 'system', 'elgg_init');
register_plugin_hook('unit_test', 'system', 'elgg_api_test');
register_elgg_event_handler('init', 'system', 'add_custom_menu_items', 1000);
register_elgg_event_handler('init', 'system', 'elgg_walled_garden', 1000);