1 files changed, 76 insertions, 63 deletions
diff --git a/engine/lib/pagehandler.php b/engine/lib/pagehandler.php
index 5f60eefae..0cf99b6fe 100644
--- a/engine/lib/pagehandler.php
+++ b/engine/lib/pagehandler.php
@@ -2,82 +2,92 @@
 /**
  * Elgg page handler functions
  *
- * @package Elgg
- * @subpackage Core
- * @author Curverider Ltd
- * @link http://elgg.org/
+ * @package Elgg.Core
+ * @subpackage Routing
  */
 
 /**
- * Turns the current page over to the page handler, allowing registered handlers to take over.
+ * Routes the request to a registered page handler
  *
- * If a page handler returns FALSE, the request is handed over to the default_page_handler.
+ * This function sets the context based on the handler name (first segment of the
+ * URL). It also triggers a plugin hook 'route', $handler so that plugins can
+ * modify the routing or handle a request.
  *
  * @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
+ * @param array  $page    The parameters to the page, as an array (exploded by '/' slashes)
+ *
+ * @return bool
+ * @access private
  */
 function page_handler($handler, $page) {
 	global $CONFIG;
 
-	set_context($handler);
+	elgg_set_context($handler);
 
-	$page = explode('/',$page);
+	$page = explode('/', $page);
 	// remove empty array element when page url ends in a / (see #1480)
 	if ($page[count($page) - 1] === '') {
 		array_pop($page);
 	}
 
-	if (!isset($CONFIG->pagehandler) || empty($handler)) {
-		$result = false;
-	} else if (isset($CONFIG->pagehandler[$handler]) && is_callable($CONFIG->pagehandler[$handler])) {
-		$function = $CONFIG->pagehandler[$handler];
-		$result = $function($page, $handler);
-		if ($result !== false) {
-			$result = true;
-		}
-	} else {
-		$result = false;
+	// return false to stop processing the request (because you handled it)
+	// return a new $request array if you want to route the request differently
+	$request = array(
+		'handler' => $handler,
+		'segments' => $page,
+	);
+	$request = elgg_trigger_plugin_hook('route', $handler, null, $request);
+	if ($request === false) {
+		return true;
 	}
 
-	if (!$result) {
-		$result = default_page_handler($page, $handler);
-	}
-	if ($result !== false) {
-		$result = true;
+	$handler = $request['handler'];
+	$page = $request['segments'];
+
+	$result = false;
+	if (isset($CONFIG->pagehandler)
+			&& !empty($handler)
+			&& isset($CONFIG->pagehandler[$handler])
+			&& is_callable($CONFIG->pagehandler[$handler])) {
+		$function = $CONFIG->pagehandler[$handler];
+		$result = call_user_func($function, $page, $handler);
 	}
 
-	return $result;
+	return $result || headers_sent();
 }
 
 /**
  * Registers a page handler for a particular identifier
  *
  * For example, you can register a function called 'blog_page_handler' for handler type 'blog'
- * Now for all URLs of type http://yoururl/pg/blog/*, the blog_page_handler() function will be called.
+ * 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
+ * Page handlers should return true to indicate that they handled the request.
+ * Requests not handled are forwarded to the front page with a reason of 404.
+ * Plugins can register for the 'forward', '404' plugin hook. @see forward()
+ *
+ * @param string $handler  The page type to handle
  * @param string $function Your function name
- * @return true|false Depending on success
+ *
+ * @return bool Depending on success
  */
-function register_page_handler($handler, $function) {
+function elgg_register_page_handler($handler, $function) {
 	global $CONFIG;
+
 	if (!isset($CONFIG->pagehandler)) {
 		$CONFIG->pagehandler = array();
 	}
-	if (is_callable($function)) {
+	if (is_callable($function, true)) {
 		$CONFIG->pagehandler[$handler] = $function;
 		return true;
 	}
@@ -88,14 +98,16 @@ function register_page_handler($handler, $function) {
 /**
  * Unregister a page handler for an identifier
  *
- * Note: to replace a page handler, call register_page_handler()
- * 
+ * 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 unregister_page_handler($handler) {
+function elgg_unregister_page_handler($handler) {
 	global $CONFIG;
-	
+
 	if (!isset($CONFIG->pagehandler)) {
 		return;
 	}
@@ -104,34 +116,35 @@ function unregister_page_handler($handler) {
 }
 
 /**
- * A default page handler
- * Tries to locate a suitable file to include. Only works for core pages, not plugins.
+ * Serve an error page
+ *
+ * @todo not sending status codes yet
  *
- * @param array $page The page URL elements
- * @param string $handler The base handler
- * @return true|false Depending on success
+ * @param string $hook   The name of the hook
+ * @param string $type   The type of the hook
+ * @param bool   $result The current value of the hook
+ * @param array  $params Parameters related to the hook
+ * @return void
  */
-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;
+function elgg_error_page_handler($hook, $type, $result, $params) {
+	if (elgg_view_exists("errors/$type")) {
+		$content = elgg_view("errors/$type", $params);
+	} else {
+		$content = elgg_view("errors/default", $params);
 	}
+	$body = elgg_view_layout('error', array('content' => $content));
+	echo elgg_view_page('', $body, 'error');
+	exit;
+}
 
-	return FALSE;
+/**
+ * Initializes the page handler/routing system
+ *
+ * @return void
+ * @access private
+ */
+function page_handler_init() {
+	elgg_register_plugin_hook_handler('forward', '404', 'elgg_error_page_handler');
 }
+
+elgg_register_event_handler('init', 'system', 'page_handler_init');