// automatic adding of widgets for admin
elgg_register_event_handler('make_admin', 'user', 'elgg_add_admin_widgets');
- elgg_register_page_handler('admin', 'admin_settings_page_handler');
+ elgg_register_page_handler('admin', 'admin_page_handler');
elgg_register_page_handler('admin_plugin_screenshot', 'admin_plugin_screenshot_page_handler');
elgg_register_page_handler('admin_plugin_text_file', 'admin_markdown_page_handler');
}
* @return void
* @access private
*/
-function admin_settings_page_handler($page) {
+function admin_page_handler($page) {
admin_gatekeeper();
elgg_admin_add_plugin_settings_menu();
* admin_plugin_screenshot/<plugin_id>/<size>/<ss_name>.<ext>
*
* @param array $pages The pages array
- * @return true
+ * @return void
* @access private
*/
function admin_plugin_screenshot_page_handler($pages) {
echo file_get_contents($file);
break;
}
-
- return true;
}
/**
* * LICENSE.txt
*
* @param type $page
+ * @return void
* @access private
*/
function admin_markdown_page_handler($pages) {
return elgg_delete_river(array('id' => $id));
}
+
+/**
+ * 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
+ * @deprecated 1.8
+ */
+function default_page_handler($page, $handler) {
+ global $CONFIG;
+
+ elgg_deprecated_notice("default_page_handler is deprecated", "1.8");
+
+ $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;
+}
* @access private
*/
function elgg_js_page_handler($page) {
- return elgg_cacheable_view_page_handler($page, 'js');
+ elgg_cacheable_view_page_handler($page, 'js');
}
/**
echo elgg_view($view, $vars);
}
-
- return true;
}
/**
$page[0] = 'elgg';
}
- return elgg_cacheable_view_page_handler($page, 'css');
+ elgg_cacheable_view_page_handler($page, 'css');
}
/**
* @param array $page The page array
* @param string $type The type: js or css
*
- * @return mixed
+ * @return void
* @access private
*/
function elgg_cacheable_view_page_handler($page, $type) {
break;
default:
- return false;
+ return;
break;
}
echo $return;
}
-
- return true;
}
/**
*
* Used as a callback for ElggBatch.
*
+ * @todo why aren't these static methods on ElggBatch?
+ *
* @param object $object The object to enable
* @return bool
* @access private
/**
* 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
+ * @return bool
* @access private
*/
function page_handler($handler, $page) {
$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])) {
+ if (isset($CONFIG->pagehandler) && !empty($handler) && isset($CONFIG->pagehandler[$handler])) {
$function = $CONFIG->pagehandler[$handler];
- $result = call_user_func($function, $page, $handler);
- if ($result !== false) {
- $result = true;
- }
- } else {
- $result = false;
+ call_user_func($function, $page, $handler);
}
- if (!$result) {
- $result = default_page_handler($page, $handler);
- }
- if ($result !== false) {
- $result = true;
- }
-
- return $result;
+ return headers_sent();
}
/**
* 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'.
*
+ * 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
*
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;
-}
* Page handler for activiy
*
* @param array $page
+ * @return void
* @access private
*/
function elgg_river_page_handler($page) {
* @access private
*/
function elgg_tagcloud_page_handler($page) {
- switch ($page[0]) {
- default:
- $title = elgg_view_title(elgg_echo('tags:site_cloud'));
- $options = array(
- 'threshold' => 0,
- 'limit' => 100,
- 'tag_name' => 'tags',
- );
- $tags = elgg_view_tagcloud($options);
- $content = $title . $tags;
- $body = elgg_view_layout('one_sidebar', array('content' => $content));
-
- echo elgg_view_page(elgg_echo('tags:site_cloud'), $body);
- break;
- }
+
+ $title = elgg_view_title(elgg_echo('tags:site_cloud'));
+ $options = array(
+ 'threshold' => 0,
+ 'limit' => 100,
+ 'tag_name' => 'tags',
+ );
+ $tags = elgg_view_tagcloud($options);
+ $content = $title . $tags;
+ $body = elgg_view_layout('one_sidebar', array('content' => $content));
+
+ echo elgg_view_page(elgg_echo('tags:site_cloud'), $body);
}
/**
$page[0] = 'user';
}
- if ($page[1]) {
+ if (isset($page[1])) {
$user = get_user_by_username($page[1]);
elgg_set_page_owner_guid($user->guid);
} else {
$path = $CONFIG->path . "pages/settings/tools.php";
break;
case 'user':
- default:
$path = $CONFIG->path . "pages/settings/account.php";
break;
}
- require($path);
+ if (isset($path)) {
+ require $path;
+ }
}
/**
function friends_of_page_handler($page_elements) {
elgg_set_context('friends');
if (isset($page_elements[0]) && $user = get_user_by_username($page_elements[0])) {
- set_page_owner($user->getGUID());
+ elgg_set_page_owner_guid($user->getGUID());
}
if (elgg_get_logged_in_user_guid() == elgg_get_page_owner_guid()) {
collections_submenu_items();
* /avatar/view/<username>/<size>/<icontime>
*
* @param array $page
+ * @return void
* @access private
*/
function elgg_avatar_page_handler($page) {
* Profile page handler
*
* @param array $page
+ * @return void
* @access private
*/
function elgg_profile_page_handler($page) {
* @todo no archives for all blogs or friends
*
* @param array $page
- * @return NULL
+ * @return void
*/
function blog_page_handler($page) {
$params = blog_get_page_content_list($page[1]);
break;
case 'all':
- default:
- $title = elgg_echo('blog:title:all_blogs');
$params = blog_get_page_content_list();
break;
}
- $params['sidebar'] .= elgg_view('blog/sidebar', array('page' => $page_type));
+ if (isset($params)) {
+ $params['sidebar'] .= elgg_view('blog/sidebar', array('page' => $page_type));
- $body = elgg_view_layout('content', $params);
+ $body = elgg_view_layout('content', $params);
- echo elgg_view_page($params['title'], $body);
+ echo elgg_view_page($params['title'], $body);
+ }
}
/**
* Title is ignored
*
* @param array $page
+ * @return void
*/
function bookmarks_page_handler($page) {
elgg_load_library('elgg:bookmarks');
set_input('container_guid', $page[1]);
include "$pages/bookmarklet.php";
break;
-
- default:
- return false;
}
elgg_pop_context();
-
- return true;
}
/**
/**
- * Page handler
- *
+ * Category page handler
+ * @return void
*/
function categories_page_handler() {
include(dirname(__FILE__) . "/pages/categories/listing.php");
- return TRUE;
}
/**
elgg_register_plugin_hook_handler('get_list', 'default_widgets', 'dashboard_default_widgets');
}
+/**
+ * Dashboard page handler
+ * @return void
+ */
function dashboard_page_handler() {
// Ensure that only logged-in users can see this page
gatekeeper();
* Serve the theme preview pages
*
* @param array $page
+ * @return void
*/
function developers_theme_preview_controller($page) {
if (!isset($page[0])) {
*/
function diagnostics_init() {
- // Register a page handler, so we can have nice URLs
- elgg_register_page_handler('diagnostics','diagnostics_page_handler');
-
// Add admin menu item
elgg_register_admin_menu_item('develop', 'diagnostics', 'develop_utilities');
*
* @param array $page URL segements
* @param string $handler Handler identifier
+ * @return void
*/
function expages_page_handler($page, $handler) {
if ($handler == 'expages') {
* Title is ignored
*
* @param array $page
- * @return NULL
+ * @return void
*/
function file_page_handler($page) {
include "$file_dir/owner.php";
break;
case 'all':
- default:
include "$file_dir/world.php";
break;
}
/**
* Creates the notification message body
*
- * @param unknown_type $hook
- * @param unknown_type $entity_type
- * @param unknown_type $returnvalue
- * @param unknown_type $params
+ * @param string $hook
+ * @param string $entity_type
+ * @param string $returnvalue
+ * @param array $params
*/
function file_notify_message($hook, $entity_type, $returnvalue, $params) {
$entity = $params['entity'];
* Group members: groups/members/<guid>
*
* @param array $page Array of url segments for routing
+ * @return void
*/
function groups_page_handler($page) {
/**
* Handle group icons.
*
- * @param unknown_type $page
+ * @param array $page
+ * @return void
*/
function groups_icon_handler($page) {
* Edit discussion topic: discussion/edit/<guid>
*
* @param array $page Array of url segments for routing
+ * @return void
*/
function discussion_page_handler($page) {
* Page handler function
*
* @param array $page Page URL segments
+ * @return void
*/
function invitefriends_page_handler($page) {
gatekeeper();
* Members page handler
*
* @param array $page url segments
+ * @return void
*/
function members_page_handler($page) {
$base = elgg_get_plugins_path() . 'members/pages/members';
* Group messageboard: messageboard/group/<guid>/all (not implemented)
*
* @param array $page Array of page elements
- * @return bool
+ * @return void
*/
function messageboard_page_handler($page) {
$new_section_one = array('owner', 'add', 'group');
include "$pages/owner.php";
break;
}
-
- return true;
}
/**
* Messages page handler
*
* @param array $page Array of URL components for routing
- * @return bool
+ * @return void
*/
function messages_page_handler($page) {
case 'add':
include("$base_dir/send.php");
break;
- default:
- return false;
}
-
- return true;
}
/**
* Route page requests
*
* @param array $page Array of url parameters
+ * @return void
*/
function notifications_page_handler($page) {
require "$base/groups.php";
break;
case 'personal':
- default:
require "$base/index.php";
break;
}
-
- return TRUE;
}
/**
* Title is ignored
*
* @param array $page
+ * @return void
*/
function pages_page_handler($page) {
include "$base_dir/revision.php";
break;
case 'all':
- default:
include "$base_dir/world.php";
break;
}
-
- return;
}
/**
* Profile page handler
*
* @param array $page Array of URL segments passed by the page handling mechanism
+ * @return void
*/
function profile_page_handler($page) {
* Serves the add report page
*
* @param array $page Array of page routing elements
+ * @return void
*/
function reportedcontent_page_handler($page) {
// only logged in users can report things
require_once 'search_hooks.php';
// page handler for search actions and results
- elgg_register_page_handler('search','search_page_handler');
+ elgg_register_page_handler('search', 'search_page_handler');
// register some default search hooks
elgg_register_plugin_hook_handler('search', 'object', 'search_objects_hook');
/**
* Page handler for search
*
- * @param array $page Page elements from pain page handler
+ * @param array $page Page elements from core page handler
+ * @return void
*/
function search_page_handler($page) {
* thewire/tag/<tag> View wire posts tagged with <tag>
*
* @param array $page From the page_handler function
- * @return true|false Depending on success
+ * @return void
*/
function thewire_page_handler($page) {
$base_dir = elgg_get_plugins_path() . 'thewire/pages/thewire';
- // if just /thewire go to global view in the else statement
- if (isset($page[0]) && $page[0]) {
-
- switch ($page[0]) {
- case "all":
- include "$base_dir/everyone.php";
- break;
-
- case "friends":
- include "$base_dir/friends.php";
- break;
-
- case "owner":
- include "$base_dir/owner.php";
- break;
-
- case "thread":
- if (isset($page[1])) {
- set_input('thread_id', $page[1]);
- }
- include "$base_dir/thread.php";
- break;
- case "reply":
- if (isset($page[1])) {
- set_input('guid', $page[1]);
- }
- include "$base_dir/reply.php";
- break;
- case "tag":
- if (isset($page[1])) {
- set_input('tag', $page[1]);
- }
- include "$base_dir/tag.php";
- break;
- case "previous":
- if (isset($page[1])) {
- set_input('guid', $page[1]);
- }
- include "$base_dir/previous.php";
- break;
- }
- } else {
- include "$base_dir/everyone.php";
+ if (!isset($page[0])) {
+ $page = array('all');
}
- return true;
+ switch ($page[0]) {
+ case "all":
+ include "$base_dir/everyone.php";
+ break;
+
+ case "friends":
+ include "$base_dir/friends.php";
+ break;
+
+ case "owner":
+ include "$base_dir/owner.php";
+ break;
+
+ case "thread":
+ if (isset($page[1])) {
+ set_input('thread_id', $page[1]);
+ }
+ include "$base_dir/thread.php";
+ break;
+
+ case "reply":
+ if (isset($page[1])) {
+ set_input('guid', $page[1]);
+ }
+ include "$base_dir/reply.php";
+ break;
+
+ case "tag":
+ if (isset($page[1])) {
+ set_input('tag', $page[1]);
+ }
+ include "$base_dir/tag.php";
+ break;
+
+ case "previous":
+ if (isset($page[1])) {
+ set_input('guid', $page[1]);
+ }
+ include "$base_dir/previous.php";
+ break;
+ }
}
/**
* Handles old pg/twitterservice/ handler
*
* @param array $page
+ * @return void
*/
function twitter_api_pagehandler_deprecated($page) {
$url = elgg_get_site_url() . 'pg/twitter_api/authorize';
$msg = elgg_echo('twitter_api:deprecated_callback_url', array($url));
register_error($msg);
- return twitter_api_pagehandler($page);
+ twitter_api_pagehandler($page);
}
* Serves pages for twitter.
*
* @param array $page
+ * @return void
*/
function twitter_api_pagehandler($page) {
if (!isset($page[0])) {
- forward();
+ return;
}
switch ($page[0]) {
$pages = dirname(__FILE__) . '/pages/twitter_api';
include "$pages/interstitial.php";
break;
- default:
- forward();
- break;
}
}
* Checks sent passed validation code and user guids and validates the user.
*
* @param array $page
+ * @return void
*/
function uservalidationbyemail_page_handler($page) {
$user = get_entity($user_guid);
- if (($code) && ($user)) {
+ if ($code && $user) {
if (uservalidationbyemail_validate_email($user_guid, $code)) {
elgg_push_context('uservalidationbyemail_validate_user');
register_error(elgg_echo('email:confirm:fail'));
}
- forward();
+ // forward to front page
+ forward('');
}
/**