diff options
Diffstat (limited to 'mod/bookmarks/start.php')
| -rw-r--r-- | mod/bookmarks/start.php | 313 |
1 files changed, 172 insertions, 141 deletions
diff --git a/mod/bookmarks/start.php b/mod/bookmarks/start.php index 04a452d32..caea43587 100644 --- a/mod/bookmarks/start.php +++ b/mod/bookmarks/start.php @@ -5,115 +5,100 @@ * @package ElggBookmarks */ -function bookmarks_init() { - global $CONFIG; - - //add a tools menu option - $item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks'), 'pg/bookmarks/all'); - elgg_register_menu_item('site', $item); - - // Register a page handler, so we can have nice URLs - register_page_handler('bookmarks', 'bookmarks_page_handler'); - - // Add our CSS - elgg_extend_view('css/screen', 'bookmarks/css'); - - // Register granular notification for this type - if (is_callable('register_notification_object')) { - register_notification_object('object', 'bookmarks', elgg_echo('bookmarks:new')); - } - - // Listen to notification events and supply a more useful message - elgg_register_plugin_hook_handler('notify:entity:message', 'object', 'bookmarks_notify_message'); +elgg_register_event_handler('init', 'system', 'bookmarks_init'); - // Register a URL handler for shared items - register_entity_url_handler('bookmark_url','object','bookmarks'); +/** + * Bookmark init + */ +function bookmarks_init() { - // Shares widget - elgg_register_widget_type('bookmarks',elgg_echo("bookmarks"),elgg_echo("bookmarks:widget:description")); + $root = dirname(__FILE__); + elgg_register_library('elgg:bookmarks', "$root/lib/bookmarks.php"); - // Register entity type - register_entity_type('object','bookmarks'); + // actions + $action_path = "$root/actions/bookmarks"; + elgg_register_action('bookmarks/save', "$action_path/save.php"); + elgg_register_action('bookmarks/delete', "$action_path/delete.php"); + elgg_register_action('bookmarks/share', "$action_path/share.php"); - // Add group menu option - add_group_tool_option('bookmarks',elgg_echo('bookmarks:enablebookmarks'),true); + // menus + elgg_register_menu_item('site', array( + 'name' => 'bookmarks', + 'text' => elgg_echo('bookmarks'), + 'href' => 'bookmarks/all' + )); + elgg_register_plugin_hook_handler('register', 'menu:page', 'bookmarks_page_menu'); elgg_register_plugin_hook_handler('register', 'menu:owner_block', 'bookmarks_owner_block_menu'); - // Extend Groups profile page - elgg_extend_view('groups/tool_latest','bookmarks/group_bookmarks'); + elgg_register_page_handler('bookmarks', 'bookmarks_page_handler'); - // Register profile menu hook - elgg_register_plugin_hook_handler('profile_menu', 'profile', 'bookmarks_profile_menu'); -} + elgg_extend_view('css/elgg', 'bookmarks/css'); + elgg_extend_view('js/elgg', 'bookmarks/js'); -/** - * Sidebar menu for bookmarks - * - */ -function bookmarks_pagesetup() { - global $CONFIG; + elgg_register_widget_type('bookmarks', elgg_echo('bookmarks'), elgg_echo('bookmarks:widget:description')); - $page_owner = page_owner_entity(); + if (elgg_is_logged_in()) { + $user_guid = elgg_get_logged_in_user_guid(); + $address = urlencode(current_page_url()); - //add submenu options - if (get_context() == "bookmarks") { - - if (elgg_is_logged_in()) { - // link to add bookmark form - if ($page_owner instanceof ElggGroup) { - if ($page_owner->isMember(elgg_get_logged_in_user_entity())) { - add_submenu_item(elgg_echo('bookmarks:add'), $CONFIG->wwwroot."pg/bookmarks/add/" . $page_owner->username); - } - } else { - add_submenu_item(elgg_echo('bookmarks:add'), $CONFIG->wwwroot."pg/bookmarks/add/" . $_SESSION['user']->username); - add_submenu_item(elgg_echo('bookmarks:inbox'),$CONFIG->wwwroot."pg/bookmarks/inbox/" . $_SESSION['user']->username); - } - if (page_owner()) { - add_submenu_item(sprintf(elgg_echo('bookmarks:read'), $page_owner->name),$CONFIG->wwwroot."pg/bookmarks/owner/" . $page_owner->username); - } - if (!$page_owner instanceof ElggGroup) { - add_submenu_item(elgg_echo('bookmarks:friends'),$CONFIG->wwwroot."pg/bookmarks/friends/" . $_SESSION['user']->username); - } - } + elgg_register_menu_item('extras', array( + 'name' => 'bookmark', + 'text' => elgg_view_icon('push-pin-alt'), + 'href' => "bookmarks/add/$user_guid?address=$address", + 'title' => elgg_echo('bookmarks:this'), + 'rel' => 'nofollow', + )); + } + // Register granular notification for this type + register_notification_object('object', 'bookmarks', elgg_echo('bookmarks:new')); - if (!$page_owner instanceof ElggGroup) { - add_submenu_item(elgg_echo('bookmarks:everyone'),$CONFIG->wwwroot."pg/bookmarks/all/"); - } + // Listen to notification events and supply a more useful message + elgg_register_plugin_hook_handler('notify:entity:message', 'object', 'bookmarks_notify_message'); - // Bookmarklet - if ((elgg_is_logged_in()) && (page_owner()) && (can_write_to_container(0, page_owner()))) { + // Register bookmarks view for ecml parsing + elgg_register_plugin_hook_handler('get_views', 'ecml', 'bookmarks_ecml_views_hook'); - $bmtext = elgg_echo('bookmarks:bookmarklet'); - if ($page_owner instanceof ElggGroup) { - $bmtext = elgg_echo('bookmarks:bookmarklet:group'); - } - add_submenu_item($bmtext, $CONFIG->wwwroot . "pg/bookmarks/bookmarklet/{$page_owner->username}/"); - } + // Register a URL handler for bookmarks + elgg_register_entity_url_handler('object', 'bookmarks', 'bookmark_url'); - } - - if ($page_owner instanceof ElggGroup && get_context() == 'groups') { - if ($page_owner->bookmarks_enable != "no") { - add_submenu_item(sprintf(elgg_echo("bookmarks:group"),$page_owner->name), $CONFIG->wwwroot . "pg/bookmarks/owner/" . $page_owner->username); - } - } + // Register entity type for search + elgg_register_entity_type('object', 'bookmarks'); + // Groups + add_group_tool_option('bookmarks', elgg_echo('bookmarks:enablebookmarks'), true); + elgg_extend_view('groups/tool_latest', 'bookmarks/group_module'); } /** - * Bookmarks page handler - * Expects URLs like: - * pg/bookmarks/username/[friends||items||add||edit||bookmarklet] + * Dispatcher for bookmarks. + * + * URLs take the form of + * All bookmarks: bookmarks/all + * User's bookmarks: bookmarks/owner/<username> + * Friends' bookmarks: bookmarks/friends/<username> + * View bookmark: bookmarks/view/<guid>/<title> + * New bookmark: bookmarks/add/<guid> (container: user, group, parent) + * Edit bookmark: bookmarks/edit/<guid> + * Group bookmarks: bookmarks/group/<guid>/all + * Bookmarklet: bookmarks/bookmarklet/<guid> (user) * + * Title is ignored * - * @param array $page From the page_handler function - * @return true|false Depending on success + * @param array $page + * @return bool */ function bookmarks_page_handler($page) { - global $CONFIG; - // group usernames + elgg_load_library('elgg:bookmarks'); + + if (!isset($page[0])) { + $page[0] = 'all'; + } + + elgg_push_breadcrumb(elgg_echo('bookmarks'), 'bookmarks/all'); + + // old group usernames if (substr_count($page[0], 'group:')) { preg_match('/group\:([0-9]+)/i', $page[0], $matches); $guid = $matches[1]; @@ -128,46 +113,56 @@ function bookmarks_page_handler($page) { bookmarks_url_forwarder($page); } - - $pages = dirname(__FILE__) . '/pages'; + $pages = dirname(__FILE__) . '/pages/bookmarks'; switch ($page[0]) { - case "read": - case "view": - set_input('guid', $page[1]); - include "$pages/view.php"; - break; - case "friends": - set_input('username', $page[1]); - include "$pages/friends.php"; - break; case "all": include "$pages/all.php"; break; - case "inbox": - set_input('username', $page[1]); - include "$pages/inbox.php"; - break; + case "owner": - set_input('username', $page[1]); include "$pages/owner.php"; break; + + case "friends": + include "$pages/friends.php"; + break; + + case "view": + set_input('guid', $page[1]); + include "$pages/view.php"; + break; + case 'read': // Elgg 1.7 compatibility + register_error(elgg_echo("changebookmark")); + forward("bookmarks/view/{$page[1]}"); + break; + case "add": - set_input('username', $page[1]); + gatekeeper(); include "$pages/add.php"; break; + case "edit": - set_input('bookmark', $page[1]); - include "$pages/add.php"; + gatekeeper(); + set_input('guid', $page[1]); + include "$pages/edit.php"; + break; + + case 'group': + group_gatekeeper(); + include "$pages/owner.php"; break; + case "bookmarklet": - set_input('username', $page[1]); + set_input('container_guid', $page[1]); include "$pages/bookmarklet.php"; break; + default: return false; } + elgg_pop_context(); return true; } @@ -185,22 +180,22 @@ function bookmarks_url_forwarder($page) { switch ($page[1]) { case "read": - $url = "{$CONFIG->wwwroot}pg/bookmarks/view/{$page[2]}/{$page[3]}"; + $url = "{$CONFIG->wwwroot}bookmarks/view/{$page[2]}/{$page[3]}"; break; case "inbox": - $url = "{$CONFIG->wwwroot}pg/bookmarks/inbox/{$page[0]}/"; + $url = "{$CONFIG->wwwroot}bookmarks/inbox/{$page[0]}"; break; case "friends": - $url = "{$CONFIG->wwwroot}pg/bookmarks/friends/{$page[0]}/"; + $url = "{$CONFIG->wwwroot}bookmarks/friends/{$page[0]}"; break; case "add": - $url = "{$CONFIG->wwwroot}pg/bookmarks/add/{$page[0]}/"; + $url = "{$CONFIG->wwwroot}bookmarks/add/{$page[0]}"; break; case "items": - $url = "{$CONFIG->wwwroot}pg/bookmarks/owner/{$page[0]}/"; + $url = "{$CONFIG->wwwroot}bookmarks/owner/{$page[0]}"; break; case "bookmarklet": - $url = "{$CONFIG->wwwroot}pg/bookmarks/bookmarklet/{$page[0]}/"; + $url = "{$CONFIG->wwwroot}bookmarks/bookmarklet/{$page[0]}"; break; } @@ -219,20 +214,25 @@ function bookmark_url($entity) { $title = $entity->title; $title = elgg_get_friendly_title($title); - return $CONFIG->url . "pg/bookmarks/view/" . $entity->getGUID() . "/" . $title; + return $CONFIG->url . "bookmarks/view/" . $entity->getGUID() . "/" . $title; } /** * Add a menu item to an ownerblock + * + * @param string $hook + * @param string $type + * @param array $return + * @param array $params */ function bookmarks_owner_block_menu($hook, $type, $return, $params) { if (elgg_instanceof($params['entity'], 'user')) { - $url = "pg/bookmarks/owner/{$params['user']->username}"; + $url = "bookmarks/owner/{$params['entity']->username}"; $item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks'), $url); $return[] = $item; } else { - if ($params['entity']->bookmarks_enable != "no") { - $url = "pg/bookmarks/owner/{$params['entity']->username}"; + if ($params['entity']->bookmarks_enable != 'no') { + $url = "bookmarks/group/{$params['entity']->guid}/all"; $item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks:group'), $url); $return[] = $item; } @@ -242,12 +242,12 @@ function bookmarks_owner_block_menu($hook, $type, $return, $params) { } /** - * Returns a more meaningful message + * Returns the body of a notification message * - * @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 bookmarks_notify_message($hook, $entity_type, $returnvalue, $params) { $entity = $params['entity']; @@ -256,30 +256,61 @@ function bookmarks_notify_message($hook, $entity_type, $returnvalue, $params) { if (($entity instanceof ElggEntity) && ($entity->getSubtype() == 'bookmarks')) { $descr = $entity->description; $title = $entity->title; - global $CONFIG; - $url = elgg_get_site_url() . "pg/view/" . $entity->guid; - if ($method == 'sms') { - $owner = $entity->getOwnerEntity(); - return $owner->name . ' ' . elgg_echo("bookmarks:via") . ': ' . $url . ' (' . $title . ')'; - } - if ($method == 'email') { - $owner = $entity->getOwnerEntity(); - return $owner->name . ' ' . elgg_echo("bookmarks:via") . ': ' . $title . "\n\n" . $descr . "\n\n" . $entity->getURL(); - } - if ($method == 'web') { - $owner = $entity->getOwnerEntity(); - return $owner->name . ' ' . elgg_echo("bookmarks:via") . ': ' . $title . "\n\n" . $descr . "\n\n" . $entity->getURL(); - } - + $owner = $entity->getOwnerEntity(); + + return elgg_echo('bookmarks:notification', array( + $owner->name, + $title, + $entity->address, + $descr, + $entity->getURL() + )); } return null; } -elgg_register_event_handler('init', 'system', 'bookmarks_init'); -elgg_register_event_handler('pagesetup', 'system', 'bookmarks_pagesetup'); +/** + * Add a page menu menu. + * + * @param string $hook + * @param string $type + * @param array $return + * @param array $params + */ +function bookmarks_page_menu($hook, $type, $return, $params) { + if (elgg_is_logged_in()) { + // only show bookmarklet in bookmark pages + if (elgg_in_context('bookmarks')) { + $page_owner = elgg_get_page_owner_entity(); + if (!$page_owner) { + $page_owner = elgg_get_logged_in_user_entity(); + } -// Register actions -$action_path = dirname(__FILE__) . '/actions/bookmarks'; + if ($page_owner instanceof ElggGroup) { + if (!$page_owner->isMember()) { + return $return; + } + $title = elgg_echo('bookmarks:bookmarklet:group'); + } else { + $title = elgg_echo('bookmarks:bookmarklet'); + } + + $return[] = new ElggMenuItem('bookmarklet', $title, 'bookmarks/bookmarklet/' . $page_owner->getGUID()); + } + } + + return $return; +} -elgg_register_action('bookmarks/add', "$action_path/add.php", 'logged_in'); -elgg_register_action('bookmarks/delete', "$action_path/delete.php", 'logged_in');
\ No newline at end of file +/** + * Return bookmarks views to parse for ecml + * + * @param string $hook + * @param string $type + * @param array $return + * @param array $params + */ +function bookmarks_ecml_views_hook($hook, $type, $return, $params) { + $return['object/bookmarks'] = elgg_echo('item:object:bookmarks'); + return $return; +} |