<?php /** * Elgg page handler functions * * @package Elgg.Core * @subpackage Routing */ /** * Turns the current page over to the page handler, allowing registered handlers to take over. * * If a page handler returns FALSE, the request is handed over to the default_page_handler. * * @param string $handler The name of the handler type (eg 'blog') * @param array $page The parameters to the page, as an array (exploded by '/' slashes) * * @return true|false Depending on whether a registered page handler was found * @access private */ function page_handler($handler, $page) { global $CONFIG; elgg_set_context($handler); $page = explode('/', $page); // remove empty array element when page url ends in a / (see #1480) if ($page[count($page) - 1] === '') { array_pop($page); } // return false to stop processing the request (because you handled it) // return a new $params array if you want to route the request differently $params = array( 'handler' => $handler, 'segments' => $page, ); $params = elgg_trigger_plugin_hook('route', $handler, NULL, $params); if ($params === false) { return true; } $handler = $params['handler']; $page = $params['segments']; if (!isset($CONFIG->pagehandler) || empty($handler)) { $result = false; } else if (isset($CONFIG->pagehandler[$handler]) && is_callable($CONFIG->pagehandler[$handler])) { $function = $CONFIG->pagehandler[$handler]; $result = call_user_func($function, $page, $handler); if ($result !== false) { $result = true; } } else { $result = false; } if (!$result) { $result = default_page_handler($page, $handler); } if ($result !== false) { $result = true; } return $result; } /** * Registers a page handler for a particular identifier * * For example, you can register a function called 'blog_page_handler' for handler type 'blog' * For all URLs http://yoururl/blog/*, the blog_page_handler() function will be called. * The part of the URL marked with * above will be exploded on '/' characters and passed as an * array to that function. * For example, the URL http://yoururl/blog/username/friends/ would result in the call: * blog_page_handler(array('username','friends'), blog); * * Page handler functions should return true or the default page handler will be called. * * A request to register a page handler with the same identifier as previously registered * handler will replace the previous one. * * The context is set to the page handler identifier before the registered * page handler function is called. For the above example, the context is set to 'blog'. * * @param string $handler The page type to handle * @param string $function Your function name * * @return true|false Depending on success */ function elgg_register_page_handler($handler, $function) { global $CONFIG; if (!isset($CONFIG->pagehandler)) { $CONFIG->pagehandler = array(); } if (is_callable($function)) { $CONFIG->pagehandler[$handler] = $function; return true; } return false; } /** * Unregister a page handler for an identifier * * Note: to replace a page handler, call elgg_register_page_handler() * * @param string $handler The page type identifier * * @since 1.7.2 * @return void */ function elgg_unregister_page_handler($handler) { global $CONFIG; if (!isset($CONFIG->pagehandler)) { return; } unset($CONFIG->pagehandler[$handler]); } /** * A default page handler * Tries to locate a suitable file to include. Only works for core pages, not plugins. * * @param array $page The page URL elements * @param string $handler The base handler * * @return true|false Depending on success * @access private */ function default_page_handler($page, $handler) { global $CONFIG; $page = implode('/', $page); // protect against including arbitary files $page = str_replace("..", "", $page); $callpath = $CONFIG->path . $handler . "/" . $page; if (is_dir($callpath)) { $callpath = sanitise_filepath($callpath); $callpath .= "index.php"; if (file_exists($callpath)) { if (include($callpath)) { return TRUE; } } } else if (file_exists($callpath)) { include($callpath); return TRUE; } return FALSE; }