danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * The page manager module provides a UI and API to manage pages.
danielebarchiesi@0:  *
danielebarchiesi@0:  * It defines pages, both for system pages, overrides of system pages, and
danielebarchiesi@0:  * custom pages using Drupal's normal menu system. It allows complex
danielebarchiesi@0:  * manipulations of these pages, their content, and their hierarchy within
danielebarchiesi@0:  * the site. These pages can be exported to code for superior revision
danielebarchiesi@0:  * control.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Bit flag on the 'changed' value to tell us if an item was moved.
danielebarchiesi@0:  */
danielebarchiesi@0: define('PAGE_MANAGER_CHANGED_MOVED', 0x01);
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Bit flag on the 'changed' value to tell us if an item edited or added.
danielebarchiesi@0:  */
danielebarchiesi@0: define('PAGE_MANAGER_CHANGED_CACHED', 0x02);
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Bit flag on the 'changed' value to tell us if an item deleted.
danielebarchiesi@0:  */
danielebarchiesi@0: define('PAGE_MANAGER_CHANGED_DELETED', 0x04);
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Bit flag on the 'changed' value to tell us if an item has had its disabled status changed.
danielebarchiesi@0:  */
danielebarchiesi@0: define('PAGE_MANAGER_CHANGED_STATUS', 0x08);
danielebarchiesi@0: 
danielebarchiesi@0: // --------------------------------------------------------------------------
danielebarchiesi@0: // Drupal hooks
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_permission().
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_permission() {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'use page manager' => array(
danielebarchiesi@0:       'title' => t('Use Page Manager'),
danielebarchiesi@0:       'description' => t("Allows users to use most of Page Manager's features, though restricts some of the most powerful, potentially site-damaging features. Note that even the reduced featureset still allows for enormous control over your website."),
danielebarchiesi@0:       'restrict access' => TRUE,
danielebarchiesi@0:     ),
danielebarchiesi@0:     'administer page manager' => array(
danielebarchiesi@0:       'title' => t('Administer Page Manager'),
danielebarchiesi@0:       'description' => t('Allows complete control over Page Manager, i.e., complete control over your site. Grant with extreme caution.'),
danielebarchiesi@0:       'restrict access' => TRUE,
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_ctools_plugin_directory() to let the system know
danielebarchiesi@0:  * where our task and task_handler plugins are.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_ctools_plugin_directory($owner, $plugin_type) {
danielebarchiesi@0:   if ($owner == 'page_manager') {
danielebarchiesi@0:     return 'plugins/' . $plugin_type;
danielebarchiesi@0:   }
danielebarchiesi@0:   if ($owner == 'ctools' && $plugin_type == 'cache') {
danielebarchiesi@0:     return 'plugins/' . $plugin_type;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_ctools_plugin_type() to inform the plugin system that Page
danielebarchiesi@0:  * Manager owns task, task_handler, and page_wizard plugin types.
danielebarchiesi@0:  *
danielebarchiesi@0:  * All of these are empty because the defaults all work.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_ctools_plugin_type() {
danielebarchiesi@0:   return array(
danielebarchiesi@0:     'tasks' => array(),
danielebarchiesi@0:     'task_handlers' => array(),
danielebarchiesi@0:     'page_wizards' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Delegated implementation of hook_menu().
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_menu() {
danielebarchiesi@0:   // For some reason, some things can activate modules without satisfying
danielebarchiesi@0:   // dependencies. I don't know how, but this helps prevent things from
danielebarchiesi@0:   // whitescreening when this happens.
danielebarchiesi@0:   if (!module_exists('ctools')) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $items = array();
danielebarchiesi@0:   $base = array(
danielebarchiesi@0:     'access arguments' => array('use page manager'),
danielebarchiesi@0:     'file' => 'page_manager.admin.inc',
danielebarchiesi@0:     'theme callback' => 'ajax_base_page_theme',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $items['admin/structure/pages'] = array(
danielebarchiesi@0:     'title' => 'Pages',
danielebarchiesi@0:     'description' => 'Add, edit and remove overridden system pages and user defined pages from the system.',
danielebarchiesi@0:     'page callback' => 'page_manager_list_page',
danielebarchiesi@0:   ) + $base;
danielebarchiesi@0: 
danielebarchiesi@0:   $items['admin/structure/pages/list'] = array(
danielebarchiesi@0:     'title' => 'List',
danielebarchiesi@0:     'page callback' => 'page_manager_list_page',
danielebarchiesi@0:     'type' => MENU_DEFAULT_LOCAL_TASK,
danielebarchiesi@0:     'weight' => -10,
danielebarchiesi@0:   ) + $base;
danielebarchiesi@0: 
danielebarchiesi@0:   $items['admin/structure/pages/edit/%page_manager_cache'] = array(
danielebarchiesi@0:     'title' => 'Edit',
danielebarchiesi@0:     'page callback' => 'page_manager_edit_page',
danielebarchiesi@0:     'page arguments' => array(4),
danielebarchiesi@0:     'type' => MENU_NORMAL_ITEM,
danielebarchiesi@0:   ) + $base;
danielebarchiesi@0: 
danielebarchiesi@0:   $items['admin/structure/pages/%ctools_js/operation/%page_manager_cache'] = array(
danielebarchiesi@0:     'page callback' => 'page_manager_edit_page_operation',
danielebarchiesi@0:     'page arguments' => array(3, 5),
danielebarchiesi@0:     'type' => MENU_NORMAL_ITEM,
danielebarchiesi@0:   ) + $base;
danielebarchiesi@0: 
danielebarchiesi@0:   $items['admin/structure/pages/%ctools_js/enable/%page_manager_cache'] = array(
danielebarchiesi@0:     'page callback' => 'page_manager_enable_page',
danielebarchiesi@0:     'page arguments' => array(FALSE, 3, 5),
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:   ) + $base;
danielebarchiesi@0: 
danielebarchiesi@0:   $items['admin/structure/pages/%ctools_js/disable/%page_manager_cache'] = array(
danielebarchiesi@0:     'page callback' => 'page_manager_enable_page',
danielebarchiesi@0:     'page arguments' => array(TRUE, 3, 5),
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:   ) + $base;
danielebarchiesi@0: 
danielebarchiesi@0:   $tasks = page_manager_get_tasks();
danielebarchiesi@0: 
danielebarchiesi@0:   // Provide menu items for each task.
danielebarchiesi@0:   foreach ($tasks as $task_id => $task) {
danielebarchiesi@0:     // Allow the task to add its own menu items.
danielebarchiesi@0:     if ($function = ctools_plugin_get_function($task, 'hook menu')) {
danielebarchiesi@0:       $function($items, $task);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // And for those that provide subtasks, provide menu items for them, as well.
danielebarchiesi@0:     foreach (page_manager_get_task_subtasks($task) as $subtask_id => $subtask) {
danielebarchiesi@0:       // Allow the task to add its own menu items.
danielebarchiesi@0:       if ($function = ctools_plugin_get_function($task, 'hook menu')) {
danielebarchiesi@0:         $function($items, $subtask);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $items;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function page_manager_admin_paths() {
danielebarchiesi@0:   /* @todo FIX ME this is a major resource suck. */
danielebarchiesi@0:   return;
danielebarchiesi@0: 
danielebarchiesi@0:   $items = array();
danielebarchiesi@0:   ctools_include('page', 'page_manager', 'plugins/tasks');
danielebarchiesi@0:   $pages = page_manager_page_load_all();
danielebarchiesi@0:   foreach ($pages as $page) {
danielebarchiesi@0:     // Make sure the page we're on is set to be an administrative path and that
danielebarchiesi@0:     // it is not set to be a frontpage path.
danielebarchiesi@0:     if ((isset($page->conf['admin_paths']) && $page->conf['admin_paths']) && (!isset($page->make_frontpage) || !$page->make_frontpage)) {
danielebarchiesi@0:       $path_parts = explode('/', $page->path);
danielebarchiesi@0:       foreach ($path_parts as $key => $part) {
danielebarchiesi@0:         if (strpos($part, '%') !== FALSE || strpos($part, '!') !== FALSE) {
danielebarchiesi@0:           $path_parts[$key] = '*';
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       $path = implode('/', $path_parts);
danielebarchiesi@0:       if ($page->menu['type'] == 'default tab') {
danielebarchiesi@0:         array_pop($path_parts);
danielebarchiesi@0:         $parent_path = implode('/', $path_parts);
danielebarchiesi@0:         $items[$parent_path] = TRUE;
danielebarchiesi@0:       }
danielebarchiesi@0:       $items[$path] = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return $items;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_menu_alter.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Get a list of all tasks and delegate to them.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_menu_alter(&$items) {
danielebarchiesi@0:   // For some reason, some things can activate modules without satisfying
danielebarchiesi@0:   // dependencies. I don't know how, but this helps prevent things from
danielebarchiesi@0:   // whitescreening when this happens.
danielebarchiesi@0:   if (!module_exists('ctools')) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tasks = page_manager_get_tasks();
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($tasks as $task) {
danielebarchiesi@0:     if ($function = ctools_plugin_get_function($task, 'hook menu alter')) {
danielebarchiesi@0:       $function($items, $task);
danielebarchiesi@0:     }
danielebarchiesi@0:     // let the subtasks alter the menu items too.
danielebarchiesi@0:     foreach (page_manager_get_task_subtasks($task) as $subtask_id => $subtask) {
danielebarchiesi@0:       if ($function = ctools_plugin_get_function($subtask, 'hook menu alter')) {
danielebarchiesi@0:         $function($items, $subtask);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $items;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /*
danielebarchiesi@0:  * Implements hook_theme()
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_theme() {
danielebarchiesi@0:   // For some reason, some things can activate modules without satisfying
danielebarchiesi@0:   // dependencies. I don't know how, but this helps prevent things from
danielebarchiesi@0:   // whitescreening when this happens.
danielebarchiesi@0:   if (!module_exists('ctools')) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $base = array(
danielebarchiesi@0:     'path' => drupal_get_path('module', 'page_manager') . '/theme',
danielebarchiesi@0:     'file' => 'page_manager.theme.inc',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $items = array(
danielebarchiesi@0:     'page_manager_handler_rearrange' => array(
danielebarchiesi@0:       'render element' => 'form',
danielebarchiesi@0:     ) + $base,
danielebarchiesi@0:     'page_manager_edit_page' => array(
danielebarchiesi@0:       'template' => 'page-manager-edit-page',
danielebarchiesi@0:       'variables' => array('page' => NULL, 'save' => NULL, 'operations' => array(), 'content' => array()),
danielebarchiesi@0:     ) + $base,
danielebarchiesi@0:     'page_manager_lock' => array(
danielebarchiesi@0:       'variables' => array('page' => array()),
danielebarchiesi@0:     ) + $base,
danielebarchiesi@0:     'page_manager_changed' => array(
danielebarchiesi@0:       'variables' => array('text' => NULL, 'description' => NULL),
danielebarchiesi@0:     ) + $base,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Allow task plugins to have theme registrations by passing through:
danielebarchiesi@0:   $tasks = page_manager_get_tasks();
danielebarchiesi@0: 
danielebarchiesi@0:   // Provide menu items for each task.
danielebarchiesi@0:   foreach ($tasks as $task_id => $task) {
danielebarchiesi@0:     if ($function = ctools_plugin_get_function($task, 'hook theme')) {
danielebarchiesi@0:       $function($items, $task);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $items;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: // --------------------------------------------------------------------------
danielebarchiesi@0: // Page caching
danielebarchiesi@0: //
danielebarchiesi@0: // The page cache is used to store a page temporarily, using the ctools object
danielebarchiesi@0: // cache. When loading from the page cache, it will either load the cached
danielebarchiesi@0: // version, or if there is not one, load the real thing and create a cache
danielebarchiesi@0: // object which can then be easily stored.
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the cached changes to a given task handler.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_page_cache($task_name) {
danielebarchiesi@0:   $caches = drupal_static(__FUNCTION__, array());
danielebarchiesi@0:   if (!isset($caches[$task_name])) {
danielebarchiesi@0:     ctools_include('object-cache');
danielebarchiesi@0:     $cache = ctools_object_cache_get('page_manager_page', $task_name);
danielebarchiesi@0:     if (!$cache) {
danielebarchiesi@0:       $cache = new stdClass();
danielebarchiesi@0:       $cache->task_name = $task_name;
danielebarchiesi@0:       list($cache->task_id, $cache->subtask_id) = page_manager_get_task_id($cache->task_name);
danielebarchiesi@0: 
danielebarchiesi@0:       $cache->task = page_manager_get_task($cache->task_id);
danielebarchiesi@0:       if (empty($cache->task)) {
danielebarchiesi@0:         return FALSE;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       if ($cache->subtask_id) {
danielebarchiesi@0:         $cache->subtask = page_manager_get_task_subtask($cache->task, $cache->subtask_id);
danielebarchiesi@0:         if (empty($cache->subtask)) {
danielebarchiesi@0:           return FALSE;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $cache->subtask = $cache->task;
danielebarchiesi@0:         $cache->subtask['name'] = '';
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       $cache->handlers = page_manager_load_sorted_handlers($cache->task, $cache->subtask_id);
danielebarchiesi@0:       $cache->handler_info = array();
danielebarchiesi@0:       foreach ($cache->handlers as $id => $handler) {
danielebarchiesi@0:         $cache->handler_info[$id] = array(
danielebarchiesi@0:           'weight' => $handler->weight,
danielebarchiesi@0:           'changed' => FALSE,
danielebarchiesi@0:           'name' => $id,
danielebarchiesi@0:         );
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // ensure the task is loaded.
danielebarchiesi@0:       page_manager_get_task($cache->task_id);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($task_name != '::new') {
danielebarchiesi@0:       $cache->locked = ctools_object_cache_test('page_manager_page', $task_name);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $cache->locked = FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $caches[$task_name] = $cache;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $caches[$task_name];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Store changes to a task handler in the object cache.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_set_page_cache($page) {
danielebarchiesi@0:   if (!empty($page->locked)) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($page->task_name)) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   ctools_include('object-cache');
danielebarchiesi@0:   $page->changed = TRUE;
danielebarchiesi@0:   $cache = ctools_object_cache_set('page_manager_page', $page->task_name, $page);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Remove an item from the object cache.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_clear_page_cache($name) {
danielebarchiesi@0:   ctools_include('object-cache');
danielebarchiesi@0:   ctools_object_cache_clear('page_manager_page', $name);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Write all changes from the page cache and clear it out.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_save_page_cache($cache) {
danielebarchiesi@0:   // Save the subtask:
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($cache->task, 'save subtask callback')) {
danielebarchiesi@0:     $function($cache->subtask, $cache);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Iterate through handlers and save/delete/update as necessary.
danielebarchiesi@0:   // Go through each of the task handlers, check to see if it needs updating,
danielebarchiesi@0:   // and update it if so.
danielebarchiesi@0:   foreach ($cache->handler_info as $id => $info) {
danielebarchiesi@0:     $handler = &$cache->handlers[$id];
danielebarchiesi@0:     // If it has been marked for deletion, delete it.
danielebarchiesi@0: 
danielebarchiesi@0:     if ($info['changed'] & PAGE_MANAGER_CHANGED_DELETED) {
danielebarchiesi@0:       page_manager_delete_task_handler($handler);
danielebarchiesi@0:     }
danielebarchiesi@0:     // If it has been somehow edited (or added), write the cached version
danielebarchiesi@0:     elseif ($info['changed'] & PAGE_MANAGER_CHANGED_CACHED) {
danielebarchiesi@0:       // Make sure we get updated weight from the form for this.
danielebarchiesi@0:       $handler->weight = $info['weight'];
danielebarchiesi@0:       page_manager_save_task_handler($handler);
danielebarchiesi@0:     }
danielebarchiesi@0:     // Otherwise, check to see if it has moved and, if so, update the weight.
danielebarchiesi@0:     elseif ($info['weight'] != $handler->weight) {
danielebarchiesi@0:       // Theoretically we could only do this for in code objects, but since our
danielebarchiesi@0:       // load mechanism checks for all, this is less database work.
danielebarchiesi@0:       page_manager_update_task_handler_weight($handler, $info['weight']);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Set enable/disabled status.
danielebarchiesi@0:     if ($info['changed'] & PAGE_MANAGER_CHANGED_STATUS) {
danielebarchiesi@0:       ctools_include('export');
danielebarchiesi@0:       ctools_export_set_object_status($cache->handlers[$id], $info['disabled']);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   page_manager_clear_page_cache($cache->task_name);
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($cache->path_changed) || !empty($cache->new)) {
danielebarchiesi@0:     // Force a menu rebuild to make sure the menu entries are set.
danielebarchiesi@0:     menu_rebuild();
danielebarchiesi@0:   }
danielebarchiesi@0:   cache_clear_all();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Menu callback to load a page manager cache object for menu callbacks.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_cache_load($task_name) {
danielebarchiesi@0:   // load context plugin as there may be contexts cached here.
danielebarchiesi@0:   ctools_include('context');
danielebarchiesi@0:   return page_manager_get_page_cache($task_name);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Generate a unique name for a task handler.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Task handlers need to be named but they aren't allowed to set their own
danielebarchiesi@0:  * names. Instead, they are named based upon their parent task and type.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_handler_get_name($task_name, $handlers, $handler) {
danielebarchiesi@0:   $base = str_replace('-', '_', $task_name);
danielebarchiesi@0:   // Generate a unique name. Unlike most named objects, we don't let people choose
danielebarchiesi@0:   // names for task handlers because they mostly don't make sense.
danielebarchiesi@0:   $base .= '_' . $handler->handler;
danielebarchiesi@0: 
danielebarchiesi@0:   // Once we have a base, check to see if it is used. If it is, start counting up.
danielebarchiesi@0:   $name = $base;
danielebarchiesi@0:   $count = 1;
danielebarchiesi@0:   // If taken
danielebarchiesi@0:   while (isset($handlers[$name])) {
danielebarchiesi@0:     $name = $base . '_' . ++$count;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $name;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Import a handler into a page.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This is used by both import and clone, since clone just exports the
danielebarchiesi@0:  * handler and immediately imports it.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_handler_add_to_page(&$page, &$handler, $title = NULL) {
danielebarchiesi@0:   $last = end($page->handler_info);
danielebarchiesi@0:   $handler->weight = $last ? $last['weight'] + 1 : 0;
danielebarchiesi@0:   $handler->task = $page->task_id;
danielebarchiesi@0:   $handler->subtask = $page->subtask_id;
danielebarchiesi@0:   $handler->export_type = EXPORT_IN_DATABASE;
danielebarchiesi@0:   $handler->type = t('Normal');
danielebarchiesi@0: 
danielebarchiesi@0:   if ($title) {
danielebarchiesi@0:     $handler->conf['title'] = $title;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $name = page_manager_handler_get_name($page->task_name, $page->handlers, $handler);
danielebarchiesi@0: 
danielebarchiesi@0:   $handler->name = $name;
danielebarchiesi@0: 
danielebarchiesi@0:   $page->handlers[$name] = $handler;
danielebarchiesi@0:   $page->handler_info[$name] = array(
danielebarchiesi@0:     'weight' => $handler->weight,
danielebarchiesi@0:     'name' => $handler->name,
danielebarchiesi@0:     'changed' => PAGE_MANAGER_CHANGED_CACHED,
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: // --------------------------------------------------------------------------
danielebarchiesi@0: // Database routines
danielebarchiesi@0: //
danielebarchiesi@0: // This includes fetching plugins and plugin info as well as specialized
danielebarchiesi@0: // fetch methods to get groups of task handlers per task.
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load a single task handler by name.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Handlers can come from multiple sources; either the database or by normal
danielebarchiesi@0:  * export method, which is handled by the ctools library, but handlers can
danielebarchiesi@0:  * also be bundled with task/subtask. We have to check there and perform
danielebarchiesi@0:  * overrides as appropriate.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Handlers bundled with the task are of a higher priority than default
danielebarchiesi@0:  * handlers provided by normal code, and are of a lower priority than
danielebarchiesi@0:  * the database, so we have to check the source of handlers when we have
danielebarchiesi@0:  * multiple to choose from.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_load_task_handler($task, $subtask_id, $name) {
danielebarchiesi@0:   ctools_include('export');
danielebarchiesi@0:   $result = ctools_export_load_object('page_manager_handlers', 'names', array($name));
danielebarchiesi@0:   $handlers = page_manager_get_default_task_handlers($task, $subtask_id);
danielebarchiesi@0:   return page_manager_compare_task_handlers($result, $handlers, $name);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load all task handlers for a given task/subtask.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_load_task_handlers($task, $subtask_id = NULL, $default_handlers = NULL) {
danielebarchiesi@0:   ctools_include('export');
danielebarchiesi@0:   $conditions = array(
danielebarchiesi@0:     'task' => $task['name'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($subtask_id)) {
danielebarchiesi@0:     $conditions['subtask'] = $subtask_id;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $handlers = ctools_export_load_object('page_manager_handlers', 'conditions', $conditions);
danielebarchiesi@0:   $defaults = isset($default_handlers) ? $default_handlers : page_manager_get_default_task_handlers($task, $subtask_id);
danielebarchiesi@0:   foreach ($defaults as $name => $default) {
danielebarchiesi@0:     $result = page_manager_compare_task_handlers($handlers, $defaults, $name);
danielebarchiesi@0: 
danielebarchiesi@0:     if ($result) {
danielebarchiesi@0:       $handlers[$name] = $result;
danielebarchiesi@0:       // Ensure task and subtask are correct, because it's easy to change task
danielebarchiesi@0:       // names when editing a default and fail to do it on the associated handlers.
danielebarchiesi@0:       $result->task = $task['name'];
danielebarchiesi@0:       $result->subtask = $subtask_id;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Override weights from the weight table.
danielebarchiesi@0:   if ($handlers) {
danielebarchiesi@0:     $names = array();
danielebarchiesi@0:     $placeholders = array();
danielebarchiesi@0:     foreach ($handlers as $handler) {
danielebarchiesi@0:       $names[] = $handler->name;
danielebarchiesi@0:       $placeholders[] = "'%s'";
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $result = db_query('SELECT name, weight FROM {page_manager_weights} WHERE name IN (:names)', array(':names' => $names));
danielebarchiesi@0:     foreach ($result as $weight) {
danielebarchiesi@0:       $handlers[$weight->name]->weight = $weight->weight;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $handlers;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the default task handlers from a task, if they exist.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Tasks can contain 'default' task handlers which are provided by the
danielebarchiesi@0:  * default task. Because these can come from either the task or the
danielebarchiesi@0:  * subtask, the logic is abstracted to reduce code duplication.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_default_task_handlers($task, $subtask_id) {
danielebarchiesi@0:   // Load default handlers that are provied by the task/subtask itself.
danielebarchiesi@0:   $handlers = array();
danielebarchiesi@0:   if ($subtask_id) {
danielebarchiesi@0:     $subtask = page_manager_get_task_subtask($task, $subtask_id);
danielebarchiesi@0:     if (isset($subtask['default handlers'])) {
danielebarchiesi@0:       $handlers = $subtask['default handlers'];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   else if (isset($task['default handlers'])) {
danielebarchiesi@0:     $handlers = $task['default handlers'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $handlers;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Compare a single task handler from two lists and provide the correct one.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Task handlers can be gotten from multiple sources. As exportable objects,
danielebarchiesi@0:  * they can be provided by default hooks and the database. But also, because
danielebarchiesi@0:  * they are tightly bound to tasks, they can also be provided by default
danielebarchiesi@0:  * tasks. This function reconciles where to pick up a task handler between
danielebarchiesi@0:  * the exportables list and the defaults provided by the task itself.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $result
danielebarchiesi@0:  *   A list of handlers provided by export.inc
danielebarchiesi@0:  * @param $handlers
danielebarchiesi@0:  *   A list of handlers provided by the default task.
danielebarchiesi@0:  * @param $name
danielebarchiesi@0:  *   Which handler to compare.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   Which handler to use, if any. May be NULL.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_compare_task_handlers($result, $handlers, $name) {
danielebarchiesi@0:   // Compare our special default handler against the actual result, if
danielebarchiesi@0:   // any, and do the right thing.
danielebarchiesi@0:   if (!isset($result[$name]) && isset($handlers[$name])) {
danielebarchiesi@0:     $handlers[$name]->type = t('Default');
danielebarchiesi@0:     $handlers[$name]->export_type = EXPORT_IN_CODE;
danielebarchiesi@0:     return $handlers[$name];
danielebarchiesi@0:   }
danielebarchiesi@0:   else if (isset($result[$name]) && !isset($handlers[$name])) {
danielebarchiesi@0:     return $result[$name];
danielebarchiesi@0:   }
danielebarchiesi@0:   else if (isset($result[$name]) && isset($handlers[$name])) {
danielebarchiesi@0:     if ($result[$name]->export_type & EXPORT_IN_DATABASE) {
danielebarchiesi@0:       $result[$name]->type = t('Overridden');
danielebarchiesi@0:       $result[$name]->export_type = $result[$name]->export_type | EXPORT_IN_CODE;
danielebarchiesi@0:       return $result[$name];
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // In this case, our default is a higher priority than the standard default.
danielebarchiesi@0:       $handlers[$name]->type = t('Default');
danielebarchiesi@0:       $handlers[$name]->export_type = EXPORT_IN_CODE;
danielebarchiesi@0:       return $handlers[$name];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load all task handlers for a given task and subtask and sort them.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_load_sorted_handlers($task, $subtask_id = NULL, $enabled = FALSE) {
danielebarchiesi@0:   $handlers = page_manager_load_task_handlers($task, $subtask_id);
danielebarchiesi@0:   if ($enabled) {
danielebarchiesi@0:     foreach ($handlers as $id => $handler) {
danielebarchiesi@0:       if (!empty($handler->disabled)) {
danielebarchiesi@0:         unset($handlers[$id]);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   uasort($handlers, 'page_manager_sort_task_handlers');
danielebarchiesi@0:   return $handlers;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback for uasort to sort task handlers.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Task handlers are sorted by weight then by name.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_sort_task_handlers($a, $b) {
danielebarchiesi@0:   if ($a->weight < $b->weight) {
danielebarchiesi@0:     return -1;
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($a->weight > $b->weight) {
danielebarchiesi@0:     return 1;
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($a->name < $b->name) {
danielebarchiesi@0:     return -1;
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($a->name > $b->name) {
danielebarchiesi@0:     return 1;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return 0;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Write a task handler to the database.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_save_task_handler(&$handler) {
danielebarchiesi@0:   $update = (isset($handler->did)) ? array('did') : array();
danielebarchiesi@0:   // Let the task handler respond to saves:
danielebarchiesi@0:   if ($function = ctools_plugin_load_function('page_manager', 'task_handlers', $handler->handler, 'save')) {
danielebarchiesi@0:     $function($handler, $update);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   drupal_write_record('page_manager_handlers', $handler, $update);
danielebarchiesi@0:   db_delete('page_manager_weights')
danielebarchiesi@0:     ->condition('name', $handler->name)
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   // If this was previously a default handler, we may have to write task handlers.
danielebarchiesi@0:   if (!$update) {
danielebarchiesi@0:     // @todo wtf was I going to do here?
danielebarchiesi@0:   }
danielebarchiesi@0:   return $handler;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Remove a task handler.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_delete_task_handler($handler) {
danielebarchiesi@0:   // Let the task handler respond to saves:
danielebarchiesi@0:   if ($function = ctools_plugin_load_function('page_manager', 'task_handlers', $handler->handler, 'delete')) {
danielebarchiesi@0:     $function($handler);
danielebarchiesi@0:   }
danielebarchiesi@0:   db_delete('page_manager_handlers')
danielebarchiesi@0:     ->condition('name', $handler->name)
danielebarchiesi@0:     ->execute();
danielebarchiesi@0:   db_delete('page_manager_weights')
danielebarchiesi@0:     ->condition('name', $handler->name)
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Export a task handler into code suitable for import or use as a default
danielebarchiesi@0:  * task handler.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_export_task_handler($handler, $indent = '') {
danielebarchiesi@0:   ctools_include('export');
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   $handler = clone $handler;
danielebarchiesi@0: 
danielebarchiesi@0:   $append = '';
danielebarchiesi@0:   if ($function = ctools_plugin_load_function('page_manager', 'task_handlers', $handler->handler, 'export')) {
danielebarchiesi@0:     $append = $function($handler, $indent);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $output = ctools_export_object('page_manager_handlers', $handler, $indent);
danielebarchiesi@0:   $output .= $append;
danielebarchiesi@0: 
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Loads page manager handler for export.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Callback to load page manager handler within ctools_export_crud_load().
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param string $name
danielebarchiesi@0:  *   The name of the handler to load.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   Loaded page manager handler object, extended with external properties.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_export_task_handler_load($name) {
danielebarchiesi@0:   $table = 'page_manager_handlers';
danielebarchiesi@0:   $schema = ctools_export_get_schema($table);
danielebarchiesi@0:   $export = $schema['export'];
danielebarchiesi@0: 
danielebarchiesi@0:   $result = ctools_export_load_object($table, 'names', array($name));
danielebarchiesi@0:   if (isset($result[$name])) {
danielebarchiesi@0:     $handler = $result[$name];
danielebarchiesi@0: 
danielebarchiesi@0:     // Weight is stored in additional table so that in-code task handlers
danielebarchiesi@0:     // don't need to get written to the database just because they have their
danielebarchiesi@0:     // weight changed. Therefore, handler could have no correspondent database
danielebarchiesi@0:     // entry. Revert will not be performed for this handler and the weight
danielebarchiesi@0:     // will not be reverted. To make possible revert of the weight field
danielebarchiesi@0:     // export_type must simulate that the handler is stored in the database.
danielebarchiesi@0:     $handler->export_type = EXPORT_IN_DATABASE;
danielebarchiesi@0: 
danielebarchiesi@0:     // Also, page manager handler weight should be overriden with correspondent
danielebarchiesi@0:     // weight from page_manager_weights table, if there is one.
danielebarchiesi@0:     $result = db_query('SELECT weight FROM {page_manager_weights} WHERE name = (:names)', array(':names' => $handler->name))->fetchField();
danielebarchiesi@0:     if (is_numeric($result)) {
danielebarchiesi@0:       $handler->weight = $result;
danielebarchiesi@0:     }
danielebarchiesi@0:     return $handler;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create a new task handler object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $plugin
danielebarchiesi@0:  *   The plugin this task handler is created from.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_new_task_handler($plugin) {
danielebarchiesi@0:   // Generate a unique name. Unlike most named objects, we don't let people choose
danielebarchiesi@0:   // names for task handlers because they mostly don't make sense.
danielebarchiesi@0: 
danielebarchiesi@0:   // Create a new, empty handler object.
danielebarchiesi@0:   $handler          = new stdClass;
danielebarchiesi@0:   $handler->title   = $plugin['title'];
danielebarchiesi@0:   $handler->task    = NULL;
danielebarchiesi@0:   $handler->subtask = NULL;
danielebarchiesi@0:   $handler->name    = NULL;
danielebarchiesi@0:   $handler->handler = $plugin['name'];
danielebarchiesi@0:   $handler->weight  = 0;
danielebarchiesi@0:   $handler->conf    = array();
danielebarchiesi@0: 
danielebarchiesi@0:   // These are provided by the core export API provided by ctools and we
danielebarchiesi@0:   // set defaults here so that we don't cause notices. Perhaps ctools should
danielebarchiesi@0:   // provide a way to do this for us so we don't have to muck with it.
danielebarchiesi@0:   $handler->export_type = EXPORT_IN_DATABASE;
danielebarchiesi@0:   $handler->type = t('Local');
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($plugin['default conf'])) {
danielebarchiesi@0:     if (is_array($plugin['default conf'])) {
danielebarchiesi@0:       $handler->conf = $plugin['default conf'];
danielebarchiesi@0:     }
danielebarchiesi@0:     else if (function_exists($plugin['default conf'])) {
danielebarchiesi@0:       $handler->conf = $plugin['default conf']($handler);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $handler;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Set an overidden weight for a task handler.
danielebarchiesi@0:  *
danielebarchiesi@0:  * We do this so that in-code task handlers don't need to get written
danielebarchiesi@0:  * to the database just because they have their weight changed.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_update_task_handler_weight($handler, $weight) {
danielebarchiesi@0:   db_delete('page_manager_weights')
danielebarchiesi@0:     ->condition('name', $handler->name)
danielebarchiesi@0:     ->execute();
danielebarchiesi@0:   db_insert('page_manager_weights')
danielebarchiesi@0:     ->fields(array(
danielebarchiesi@0:       'name' => $handler->name,
danielebarchiesi@0:       'weight' => $weight,
danielebarchiesi@0:     ))
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Shortcut function to get task plugins.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_tasks() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('page_manager', 'tasks');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Shortcut function to get a task plugin.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task($id) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('page_manager', 'tasks', $id);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get all tasks for a given type.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_tasks_by_type($type) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   $all_tasks = ctools_get_plugins('page_manager', 'tasks');
danielebarchiesi@0:   $tasks = array();
danielebarchiesi@0:   foreach ($all_tasks as $id => $task) {
danielebarchiesi@0:     if (isset($task['task type']) && $task['task type'] == $type) {
danielebarchiesi@0:       $tasks[$id] = $task;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $tasks;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch all subtasks for a page managertask.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $task
danielebarchiesi@0:  *   A loaded $task plugin object.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task_subtasks($task) {
danielebarchiesi@0:   if (empty($task['subtasks'])) {
danielebarchiesi@0:     return array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($task, 'subtasks callback')) {
danielebarchiesi@0:     $retval = $function($task);
danielebarchiesi@0:     if (is_array($retval)) {
danielebarchiesi@0:       return $retval;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return array();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch all subtasks for a page managertask.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $task
danielebarchiesi@0:  *   A loaded $task plugin object.
danielebarchiesi@0:  * @param $subtask_id
danielebarchiesi@0:  *   The subtask ID to load.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task_subtask($task, $subtask_id) {
danielebarchiesi@0:   if (empty($task['subtasks'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($task, 'subtask callback')) {
danielebarchiesi@0:     return $function($task, $subtask_id);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Shortcut function to get task handler plugins.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task_handlers() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('page_manager', 'task_handlers');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Shortcut function to get a task handler plugin.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task_handler($id) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('page_manager', 'task_handlers', $id);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Retrieve a list of all applicable task handlers for a given task.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This looks at the $task['handler type'] and compares that to $task_handler['handler type'].
danielebarchiesi@0:  * If the task has no type, the id of the task is used instead.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task_handler_plugins($task, $all = FALSE) {
danielebarchiesi@0:   $type = isset($task['handler type']) ? $task['handler type'] : $task['name'];
danielebarchiesi@0:   $name = $task['name'];
danielebarchiesi@0: 
danielebarchiesi@0:   $handlers = array();
danielebarchiesi@0:   $task_handlers = page_manager_get_task_handlers();
danielebarchiesi@0:   foreach ($task_handlers as $id => $handler) {
danielebarchiesi@0:     $task_type = is_array($handler['handler type']) ? $handler['handler type'] : array($handler['handler type']);
danielebarchiesi@0:     if (in_array($type, $task_type) || in_array($name, $task_type)) {
danielebarchiesi@0:       if ($all || !empty($handler['visible'])) {
danielebarchiesi@0:         $handlers[$id] = $handler;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $handlers;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the title for a given handler.
danielebarchiesi@0:  *
danielebarchiesi@0:  * If the plugin has no 'admin title' function, the generic title of the
danielebarchiesi@0:  * plugin is used instead.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_handler_title($plugin, $handler, $task, $subtask_id) {
danielebarchiesi@0:   $function = ctools_plugin_get_function($plugin, 'admin title');
danielebarchiesi@0:   if ($function) {
danielebarchiesi@0:     return $function($handler, $task, $subtask_id);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     return $plugin['title'];
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the admin summary (additional info) for a given handler.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_handler_summary($plugin, $handler, $page, $title = TRUE) {
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($plugin, 'admin summary')) {
danielebarchiesi@0:     return $function($handler, $page->task, $page->subtask, $page, $title);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the admin summary (additional info) for a given page.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_page_summary($task, $subtask) {
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($subtask, 'admin summary')) {
danielebarchiesi@0:     return $function($task, $subtask);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Split a task name into a task id and subtask id, if applicable.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_task_id($task_name) {
danielebarchiesi@0:   if (strpos($task_name, '-') !== FALSE) {
danielebarchiesi@0:     return explode('-', $task_name, 2);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     return array($task_name, NULL);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Turn a task id + subtask_id into a task name.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_make_task_name($task_id, $subtask_id) {
danielebarchiesi@0:   if ($subtask_id) {
danielebarchiesi@0:     return $task_id . '-' . $subtask_id;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     return $task_id;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the render function for a handler.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_renderer($handler) {
danielebarchiesi@0:   return ctools_plugin_load_function('page_manager', 'task_handlers', $handler->handler, 'render');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: // --------------------------------------------------------------------------
danielebarchiesi@0: // Functions existing on behalf of tasks and task handlers
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Page manager arg load function because menu system will not load extra
danielebarchiesi@0:  * files for these; they must be in a .module.
danielebarchiesi@0:  */
danielebarchiesi@0: function pm_arg_load($value, $subtask, $argument) {
danielebarchiesi@0:   page_manager_get_task('page');
danielebarchiesi@0:   return _pm_arg_load($value, $subtask, $argument);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Special arg_load function to use %menu_tail like functionality to
danielebarchiesi@0:  * get everything after the arg together as a single value.
danielebarchiesi@0:  */
danielebarchiesi@0: function pm_arg_tail_load($value, $subtask, $argument, $map) {
danielebarchiesi@0:   $value = implode('/', array_slice($map, $argument));
danielebarchiesi@0:   page_manager_get_task('page');
danielebarchiesi@0:   return _pm_arg_load($value, $subtask, $argument);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Special menu _load() function for the user:uid argument.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This is just the normal page manager argument. It only exists so that
danielebarchiesi@0:  * the to_arg can exist.
danielebarchiesi@0:  */
danielebarchiesi@0: function pm_uid_arg_load($value, $subtask, $argument) {
danielebarchiesi@0:   page_manager_get_task('page');
danielebarchiesi@0:   return _pm_arg_load($value, $subtask, $argument);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * to_arg function for the user:uid argument to provide the arg for the
danielebarchiesi@0:  * current global user.
danielebarchiesi@0:  */
danielebarchiesi@0: function pm_uid_arg_to_arg($arg) {
danielebarchiesi@0:   return user_uid_optional_to_arg($arg);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback for access control ajax form on behalf of page.inc task.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Returns the cached access config and contexts used.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_page_ctools_access_get($argument) {
danielebarchiesi@0:   $page = page_manager_get_page_cache($argument);
danielebarchiesi@0: 
danielebarchiesi@0:   $contexts = array();
danielebarchiesi@0: 
danielebarchiesi@0:   // Load contexts based on argument data:
danielebarchiesi@0:   if ($arguments = _page_manager_page_get_arguments($page->subtask['subtask'])) {
danielebarchiesi@0:     $contexts = ctools_context_get_placeholders_from_argument($arguments);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return array($page->subtask['subtask']->access, $contexts);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback for access control ajax form on behalf of page.inc task.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Writes the changed access to the cache.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_page_ctools_access_set($argument, $access) {
danielebarchiesi@0:   $page = page_manager_get_page_cache($argument);
danielebarchiesi@0:   $page->subtask['subtask']->access = $access;
danielebarchiesi@0:   page_manager_set_page_cache($page);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback for access control ajax form on behalf of context task handler.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Returns the cached access config and contexts used.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_task_handler_ctools_access_get($argument) {
danielebarchiesi@0:   list($task_name, $name) = explode('*', $argument);
danielebarchiesi@0:   $page = page_manager_get_page_cache($task_name);
danielebarchiesi@0:   if (empty($name)) {
danielebarchiesi@0:     $handler = &$page->new_handler;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $handler = &$page->handlers[$name];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($handler->conf['access'])) {
danielebarchiesi@0:     $handler->conf['access'] = array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   ctools_include('context-task-handler');
danielebarchiesi@0: 
danielebarchiesi@0:   $contexts = ctools_context_handler_get_all_contexts($page->task, $page->subtask, $handler);
danielebarchiesi@0: 
danielebarchiesi@0:   return array($handler->conf['access'], $contexts);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback for access control ajax form on behalf of context task handler.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Writes the changed access to the cache.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_task_handler_ctools_access_set($argument, $access) {
danielebarchiesi@0:   list($task_name, $name) = explode('*', $argument);
danielebarchiesi@0:   $page = page_manager_get_page_cache($task_name);
danielebarchiesi@0:   if (empty($name)) {
danielebarchiesi@0:     $handler = &$page->new_handler;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $handler = &$page->handlers[$name];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $handler->conf['access'] = $access;
danielebarchiesi@0:   page_manager_set_page_cache($page);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Form a URL to edit a given page given the trail.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_edit_url($task_name, $trail = array()) {
danielebarchiesi@0:   if (!is_array($trail)) {
danielebarchiesi@0:     $trail = array($trail);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($trail) || $trail == array('summary')) {
danielebarchiesi@0:     return "admin/structure/pages/edit/$task_name";
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return 'admin/structure/pages/nojs/operation/' . $task_name . '/' . implode('/', $trail);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Watch menu links during the menu rebuild, and re-parent things if we need to.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_menu_link_alter(&$item) {
danielebarchiesi@0:   return;
danielebarchiesi@0: /** -- disabled, concept code --
danielebarchiesi@0:   static $mlids = array();
danielebarchiesi@0:   // Keep an array of mlids as links are saved that we can use later.
danielebarchiesi@0:   if (isset($item['mlid'])) {
danielebarchiesi@0:     $mlids[$item['path']] = $item['mlid'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($item['parent_path'])) {
danielebarchiesi@0:     if (isset($mlids[$item['parent_path']])) {
danielebarchiesi@0:       $item['plid'] = $mlids[$item['parent_path']];
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Since we didn't already see an mlid, let's check the database for one.
danielebarchiesi@0:       $mlid = db_query('SELECT mlid FROM {menu_links} WHERE router_path = :path', array('path' => $item['parent_path']))->fetchField();
danielebarchiesi@0:       if ($mlid) {
danielebarchiesi@0:         $item['plid'] = $mlid;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:  */
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback to list handlers available for export.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_page_manager_handlers_list() {
danielebarchiesi@0:   $list = $types = array();
danielebarchiesi@0:   $tasks = page_manager_get_tasks();
danielebarchiesi@0:   foreach ($tasks as $type => $info) {
danielebarchiesi@0:     if (empty($info['non-exportable'])) {
danielebarchiesi@0:       $types[] = $type;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $handlers = ctools_export_load_object('page_manager_handlers');
danielebarchiesi@0:   foreach ($handlers as $handler) {
danielebarchiesi@0:     if (in_array($handler->task, $types)) {
danielebarchiesi@0:       $plugin = page_manager_get_task_handler($handler->handler);
danielebarchiesi@0:       $title = page_manager_get_handler_title($plugin, $handler, $tasks[$handler->task], $handler->subtask);
danielebarchiesi@0: 
danielebarchiesi@0:       if ($title) {
danielebarchiesi@0:         $list[$handler->name] = check_plain("$handler->task: $title ($handler->name)");
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $list[$handler->name] = check_plain("$handler->task: ($handler->name)");
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return $list;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Callback to bulk export page manager pages.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_page_manager_pages_to_hook_code($names = array(), $name = 'foo') {
danielebarchiesi@0:   $schema = ctools_export_get_schema('page_manager_pages');
danielebarchiesi@0:   $export = $schema['export'];
danielebarchiesi@0:   $objects = ctools_export_load_object('page_manager_pages', 'names', array_values($names));
danielebarchiesi@0:   if ($objects) {
danielebarchiesi@0:     $code = "/**\n";
danielebarchiesi@0:     $code .= " * Implements hook_{$export['default hook']}()\n";
danielebarchiesi@0:     $code .= " */\n";
danielebarchiesi@0:     $code .= "function " . $name . "_{$export['default hook']}() {\n";
danielebarchiesi@0:     foreach ($objects as $object) {
danielebarchiesi@0:       // Have to implement our own because this export func sig requires it
danielebarchiesi@0:       $code .= $export['export callback']($object, TRUE, '  ');
danielebarchiesi@0:       $code .= "  \${$export['identifier']}s['" . check_plain($object->$export['key']) . "'] = \${$export['identifier']};\n\n";
danielebarchiesi@0:     }
danielebarchiesi@0:     $code .= "  return \${$export['identifier']}s;\n";
danielebarchiesi@0:     $code .= "}\n";
danielebarchiesi@0:     return $code;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the current page information.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return $page
danielebarchiesi@0:  *   An array containing the following information.
danielebarchiesi@0:  *
danielebarchiesi@0:  * - 'name': The name of the page as used in the page manager admin UI.
danielebarchiesi@0:  * - 'task': The plugin for the task in use. If this is a system page it
danielebarchiesi@0:  *   will contain information about that page, such as what functions
danielebarchiesi@0:  *   it uses.
danielebarchiesi@0:  * - 'subtask': The plugin for the subtask. If this is a custom page, this
danielebarchiesi@0:  *   will contain information about that custom page. See 'subtask' in this
danielebarchiesi@0:  *   array to get the actual page object.
danielebarchiesi@0:  * - 'handler': The actual handler object used. If using panels, see
danielebarchiesi@0:  *   $page['handler']->conf['display'] for the actual panels display
danielebarchiesi@0:  *   used to render.
danielebarchiesi@0:  * - 'contexts': The context objects used to render this page.
danielebarchiesi@0:  * - 'arguments': The raw arguments from the URL used on this page.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_get_current_page($page = NULL) {
danielebarchiesi@0:   static $current = array();
danielebarchiesi@0:   if (isset($page)) {
danielebarchiesi@0:     $current = $page;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $current;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implementation of hook_panels_dashboard_blocks().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Adds page information to the Panels dashboard.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_panels_dashboard_blocks(&$vars) {
danielebarchiesi@0:   $vars['links']['page_manager'] = array(
danielebarchiesi@0:     'weight' => -100,
danielebarchiesi@0:     'title' => l(t('Panel page'), 'admin/structure/pages/add'),
danielebarchiesi@0:     'description' => t('Panel pages can be used as landing pages. They have a URL path, accept arguments and can have menu entries.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   module_load_include('inc', 'page_manager', 'page_manager.admin');
danielebarchiesi@0:   $tasks = page_manager_get_tasks_by_type('page');
danielebarchiesi@0:   $pages = array('operations' => array());
danielebarchiesi@0: 
danielebarchiesi@0:   page_manager_get_pages($tasks, $pages);
danielebarchiesi@0:   $count = 0;
danielebarchiesi@0:   $rows = array();
danielebarchiesi@0:   foreach ($pages['rows'] as $id => $info) {
danielebarchiesi@0:     $rows[] = array(
danielebarchiesi@0:       'data' => array(
danielebarchiesi@0:         $info['data']['title'],
danielebarchiesi@0:         $info['data']['operations'],
danielebarchiesi@0:       ),
danielebarchiesi@0:       'class' => $info['class'],
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     // Only show 10.
danielebarchiesi@0:     if (++$count >= 10) {
danielebarchiesi@0:       break;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $vars['blocks']['page_manager'] = array(
danielebarchiesi@0:     'weight' => -100,
danielebarchiesi@0:     'title' => t('Manage pages'),
danielebarchiesi@0:     'link' => l(t('Go to list'), 'admin/structure/pages'),
danielebarchiesi@0:     'content' => theme('table', array('header' => array(), 'rows' => $rows, 'attributes' => array('class' => 'panels-manage'))),
danielebarchiesi@0:     'class' => 'dashboard-pages',
danielebarchiesi@0:     'section' => 'right',
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implement pseudo-hook to fetch addressable content.
danielebarchiesi@0:  *
danielebarchiesi@0:  * For Page Manager, the address will be an array. The first
danielebarchiesi@0:  * element will be the $task and the second element will be the
danielebarchiesi@0:  * $task_handler. The third elements will be the arguments
danielebarchiesi@0:  * provided.
danielebarchiesi@0:  */
danielebarchiesi@0: function page_manager_addressable_content($address, $type) {
danielebarchiesi@0:   if (count($address) < 3) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $task_name = array_shift($address);
danielebarchiesi@0:   $subtask_name = array_shift($address);
danielebarchiesi@0:   $handler_name = array_shift($address);
danielebarchiesi@0:   if ($address) {
danielebarchiesi@0:     $arguments = array_shift($address);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Since $arguments is an array of arbitrary size, we need to implode it:
danielebarchiesi@0:   if (!empty($arguments)) {
danielebarchiesi@0:     // The only choices we have for separators since :: is already
danielebarchiesi@0:     // used involve ., - or _. Since - and _ are more common than .
danielebarchiesi@0:     // in URLs, let's try .. as an argument separator.
danielebarchiesi@0:     $arguments = explode('..', $arguments);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     // implode does not return an empty array on an empty
danielebarchiesi@0:     // string so do it specifically.
danielebarchiesi@0:     $arguments = array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $task = page_manager_get_task($task_name);
danielebarchiesi@0:   if (!$task) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $handler = page_manager_load_task_handler($task, $subtask_name, $handler_name);
danielebarchiesi@0:   if (!$handler) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $handler_plugin = page_manager_get_task_handler($handler->handler);
danielebarchiesi@0:   if (!$handler_plugin) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Load the contexts for the task.
danielebarchiesi@0:   ctools_include('context');
danielebarchiesi@0:   ctools_include('context-task-handler');
danielebarchiesi@0:   $contexts = ctools_context_handler_get_task_contexts($task, $subtask_name, $arguments);
danielebarchiesi@0: 
danielebarchiesi@0:   // With contexts loaded, ensure the task is accessible. Tasks without a callback
danielebarchiesi@0:   // are automatically accessible.
danielebarchiesi@0:   $function = ctools_plugin_get_function($task, 'access callback');
danielebarchiesi@0:   if ($function && !$function($task, $subtask_name, $contexts)) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $function = ctools_plugin_get_function($handler_plugin, 'addressable callback');
danielebarchiesi@0:   if ($function) {
danielebarchiesi@0:     return $function($task, $subtask_name, $handler, $address, $contexts, $arguments, $type);
danielebarchiesi@0:   }
danielebarchiesi@0: }