Twitter Services Settings'); * * @param string $id A unique ID that your plugin can remember * @param string $message Body of the message * * @return bool * @since 1.8.0 */ function elgg_add_admin_notice($id, $message) { if ($id && $message) { $admin_notice = new ElggObject(); $admin_notice->subtype = 'admin_notice'; // admins can see ACCESS_PRIVATE but no one else can. $admin_notice->access_id = ACCESS_PRIVATE; $admin_notice->admin_notice_id = $id; $admin_notice->description = $message; return $admin_notice->save(); } return FALSE; } /** * Remove an admin notice by ID. * * eg In actions/twitter_service/save_settings: * if (is_valid_twitter_api_key()) { * delete_admin_notice('twitter_services_no_api'); * } * * @param string $id The unique ID assigned in add_admin_notice() * * @return bool * @since 1.8.0 */ function elgg_delete_admin_notice($id) { if (!$id) { return FALSE; } $result = TRUE; $notices = elgg_get_entities_from_metadata(array( 'metadata_name' => 'admin_notice_id', 'metadata_value' => $id )); if ($notices) { // in case a bad plugin adds many, let it remove them all at once. foreach ($notices as $notice) { $result = ($result && $notice->delete()); } return $result; } return FALSE; } /** * List all admin messages. * * @param int $limit Limit * * @return array List of admin notices * @since 1.8.0 */ function elgg_get_admin_notices($limit = 10) { return elgg_get_entities_from_metadata(array( 'type' => 'object', 'subtype' => 'admin_notice', 'limit' => $limit )); } /** * Check if an admin notice is currently active. * * @param string $id The unique ID used to register the notice. * * @return bool * @since 1.8.0 */ function elgg_admin_notice_exists($id) { $notice = elgg_get_entities_from_metadata(array( 'type' => 'object', 'subtype' => 'admin_notice', 'metadata_name_value_pair' => array('name' => 'admin_notice_id', 'value' => $id) )); return ($notice) ? TRUE : FALSE; } /** * Add an admin area section or child section. * This is a wrapper for elgg_register_menu_item(). * * Used in conjuction with http://elgg.org/admin/section_id/child_section style * page handler. * * The text of the menu item is obtained from elgg_echo(admin:$parent_id:$menu_id) * * This function handles registering the parent if it has not been registered. * * @param string $menu_id The Unique ID of section * @param string $parent_id If a child section, the parent section id. * @param int $priority The menu item priority * * @return bool * @since 1.8.0 */ function elgg_register_admin_menu_item($menu_id, $parent_id = NULL, $priority = 100) { // make sure parent is registered if ($parent_id && !elgg_is_menu_item_registered('page', $parent_id)) { elgg_register_admin_menu_item($parent_id); } // in the admin section parents never have links if ($parent_id) { $href = "pg/admin/$parent_id/$menu_id"; } else { $href = NULL; } $name = $menu_id; if ($parent_id) { $name = "$parent_id:$name"; } return elgg_register_menu_item('page', array( 'name' => $name, 'href' => $href, 'text' => elgg_echo("admin:$name"), 'context' => 'admin', 'parent_name' => $parent_id, 'priority' => $priority, )); } /** * Initialise the admin backend. * * @return void */ function admin_init() { elgg_register_action('admin/user/ban', '', 'admin'); elgg_register_action('admin/user/unban', '', 'admin'); elgg_register_action('admin/user/delete', '', 'admin'); elgg_register_action('admin/user/resetpassword', '', 'admin'); elgg_register_action('admin/user/makeadmin', '', 'admin'); elgg_register_action('admin/user/removeadmin', '', 'admin'); elgg_register_action('admin/site/update_basic', '', 'admin'); elgg_register_action('admin/site/update_advanced', '', 'admin'); elgg_register_action('admin/menu/save', '', 'admin'); elgg_register_action('admin/plugins/simple_update_states', '', 'admin'); elgg_register_action('profile/fields/reset', '', 'admin'); elgg_register_action('profile/fields/add', '', 'admin'); elgg_register_action('profile/fields/edit', '', 'admin'); elgg_register_action('profile/fields/delete', '', 'admin'); elgg_register_action('profile/fields/reorder', '', 'admin'); elgg_register_simplecache_view('js/admin'); // statistics elgg_register_admin_menu_item('statistics', null, 60); elgg_register_admin_menu_item('overview', 'statistics'); // site elgg_register_admin_menu_item('site', null, 20); elgg_register_admin_menu_item('basic', 'site', 10); elgg_register_admin_menu_item('advanced', 'site', 20); // appearance elgg_register_admin_menu_item('appearance', null, 30); elgg_register_admin_menu_item('menu_items', 'appearance', 10); elgg_register_admin_menu_item('profile_fields', 'appearance', 20); // users elgg_register_admin_menu_item('users', null, 40); elgg_register_admin_menu_item('add', 'users', 10); elgg_register_admin_menu_item('online', 'users', 20); elgg_register_admin_menu_item('newest', 'users', 30); // plugins elgg_register_admin_menu_item('plugins', null, 50); elgg_register_admin_menu_item('simple', 'plugins', 10); elgg_register_admin_menu_item('advanced', 'plugins', 20); // dashboard elgg_register_menu_item('page', array( 'name' => 'dashboard', 'href' => 'pg/admin/dashboard', 'text' => elgg_echo('admin:dashboard'), 'context' => 'admin', 'priority' => 10, )); elgg_register_menu_item('topbar', array( 'name' => 'administration', 'href' => 'pg/admin', 'text' => elgg_view_icon('settings') . elgg_echo('admin'), 'priority' => 100, 'section' => 'alt', )); // widgets $widgets = array('online_users', 'new_users', 'content_stats', 'admin_welcome'); foreach ($widgets as $widget) { elgg_register_widget_type( $widget, elgg_echo("admin:widget:$widget"), elgg_echo("admin:widget:$widget:help"), 'admin' ); } elgg_register_page_handler('admin', 'admin_settings_page_handler'); elgg_register_page_handler('admin_plugin_screenshot', 'admin_plugin_screenshot_page_handler'); } /** * Create the plugin settings submenu. * * This is done in a separate function called from the admin * page handler because of performance concerns. * * @return void * @access private */ function elgg_admin_add_plugin_settings_menu() { $active_plugins = elgg_get_plugins('active'); if (!$active_plugins) { // nothing added because no items return FALSE; } elgg_register_admin_menu_item('plugin_settings', null, 51); foreach ($active_plugins as $plugin) { $plugin_id = $plugin->getID(); if (elgg_view_exists("settings/$plugin_id/edit")) { elgg_register_menu_item('page', array( 'name' => $plugin_id, 'href' => "pg/admin/plugin_settings/$plugin_id", 'text' => $plugin->manifest->getName(), 'parent_name' => 'plugin_settings', 'context' => 'admin', )); } } } /** * Handles any set up required for administration pages * @access private */ function admin_pagesetup() { if (elgg_in_context('admin')) { $url = elgg_get_simplecache_url('css', 'admin'); elgg_register_css($url, 'admin'); elgg_unregister_css('elgg'); // setup footer menu elgg_register_menu_item('admin_footer', array( 'name' => 'faq', 'text' => elgg_echo('admin:faq'), 'href' => 'http://docs.elgg.org/wiki/Category:Administration_FAQ', )); } } /** * Handle admin pages. Expects corresponding views as admin/section/subsection * * @param array $page Array of pages * * @return void */ function admin_settings_page_handler($page) { admin_gatekeeper(); elgg_admin_add_plugin_settings_menu(); elgg_set_context('admin'); elgg_unregister_css('elgg'); $url = elgg_get_simplecache_url('js', 'admin'); elgg_register_js($url, 'admin'); elgg_register_js('vendors/jquery/jquery.jeditable.mini.js', 'jquery.jeditable'); // default to dashboard if (!isset($page[0]) || empty($page[0])) { $page = array('dashboard'); } // was going to fix this in the page_handler() function but // it's commented to explicitly return a string if there's a trailing / if (empty($page[count($page) - 1])) { array_pop($page); } $vars = array('page' => $page); // special page for plugin settings since we create the form for them if ($page[0] == 'plugin_settings' && isset($page[1]) && elgg_view_exists("settings/{$page[1]}/edit")) { $view = 'admin/plugin_settings'; $plugin = elgg_get_plugin_from_id($page[1]); $vars['plugin'] = $plugin; $title = elgg_echo("admin:{$page[0]}"); } else { $view = 'admin/' . implode('/', $page); $title = elgg_echo("admin:{$page[0]}"); if (count($page) > 1) { $title .= ' : ' . elgg_echo('admin:' . implode(':', $page)); } } // gets content and prevents direct access to 'components' views if ($page[0] == 'components' || !($content = elgg_view($view, $vars))) { $title = elgg_echo('admin:unknown_section'); $content = elgg_echo('admin:unknown_section'); } $body = elgg_view_layout('admin', array('content' => $content, 'title' => $title)); echo elgg_view_page($title, $body, 'admin'); } /** * Serves up screenshots for plugins from * elgg/pg/admin_plugin_ss///. * * @param array $pages The pages array * @return true */ function admin_plugin_screenshot_page_handler($pages) { admin_gatekeeper(); $plugin_id = elgg_extract(0, $pages); // only thumbnail or full. $size = elgg_extract(1, $pages, 'thumbnail'); // the rest of the string is the filename $filename_parts = array_slice($pages, 2); $filename = implode('/', $filename_parts); $filename = sanitise_filepath($filename, false); $plugin = new ElggPlugin($plugin_id); if (!$plugin) { $file = elgg_get_root_dir() . '_graphics/icons/default/medium.png'; } else { $file = $plugin->getPath() . $filename; if (!file_exists($file)) { $file = elgg_get_root_dir() . '_graphics/icons/default/medium.png'; } } header("Content-type: image/jpeg"); // resize to 100x100 for thumbnails switch ($size) { case 'thumbnail': echo get_resized_image_from_existing_file($file, 100, 100, true); break; case 'full': default: echo file_get_contents($file); break; } return true; } elgg_register_event_handler('init', 'system', 'admin_init'); elgg_register_event_handler('pagesetup', 'system', 'admin_pagesetup', 1000);