Checkpoint checkin. Lots more interesting functionality -- pages can now be...

Checkpoint checkin. Lots more interesting functionality -- pages can now be set to "single" or "multiple" task handlers, and having "single" removes the task handler arrange UI. Please some serious code re-organization so that Panels can have just one context-based task handler for multiple tasks.

delegator/css/task-handlers.css

@@ -63,3 +63,16 @@
   display: block;
 }
 */
+
+html.js .delegator-operations {
+  width: 170px;
+}
+
+div.delegator-task-handler-operations {
+  display: none;
+}
+
+html.js div.delegator-task-handler-operations {
+  display: block;
+}
+

delegator/delegator.install

@@ -120,6 +120,12 @@ function delegator_schema_1() {
         'default' => '',
         'serialize' => TRUE,
       ),
+      'multiple' => array(
+        'type' => 'int',
+        'size' => 'tiny',
+        'description' => t('True if the UI is set up to allow multiple handlers per page.'),
+        'default' => 0,
+      ),
       'menu' => array(
         'type' => 'text',
         'size' => 'big',

delegator/delegator.module

@@ -34,10 +34,6 @@ function delegator_theme() {
       'arguments' => array('form' => NULL),
       'file' => 'delegator.admin.inc',
     ),
-    'delegator_breadcrumb' => array(
-      'arguments' => array('breadcrumb' => array()),
-      'file' => 'delegator.admin.inc',
-    ),
   );
 
   // Allow task plugins to have theme registrations by passing through:
@@ -360,6 +356,66 @@ function delegator_export_task_handler($handler, $indent = '') {
   return $output;
 }
 
+/**
+ * Create a new task handler object.
+ *
+ * @param $task
+ *   The task this task handler is for.
+ * @param $subtask_id
+ *   The subtask this task handler is for.
+ * @param $plugin
+ *   The plugin this task handler is created from.
+ * @param $weight
+ *   The weight to give this new task handler.
+ * @param $cache
+ *   The task cache if the task is currently being edited. This must be used
+ *   if task handlers already exist as it is used to determine a unique name
+ *   and without this naming collisions could occur.
+ */
+function delegator_new_task_handler($task, $subtask_id, $plugin, $weight = 0, $cache = NULL) {
+  // Generate a unique name. Unlike most named objects, we don't let people choose
+  // names for task handlers because they mostly don't make sense.
+  $base = $task['name'];
+  if ($subtask_id) {
+    $base .= '_' . $subtask_id;
+  }
+  $base .= '_' . $plugin['name'];
+
+  // Once we have a base, check to see if it is used. If it is, start counting up.
+  $name = $base;
+  $count = 1;
+  // If taken
+  while (isset($cache->handlers[$name])) {
+    $name = $base . '_' . ++$count;
+  }
+
+  // Create a new, empty handler object.
+  $handler = new stdClass;
+  $handler->task = $task['name'];
+  $handler->subtask = $subtask_id;
+  $handler->name = $name;
+  $handler->handler = $plugin['name'];
+  $handler->weight = $weight;
+  $handler->conf = array();
+
+  // These are provided by the core export API provided by ctools and we
+  // set defaults here so that we don't cause notices. Perhaps ctools should
+  // provide a way to do this for us so we don't have to muck with it.
+  $handler->export_type = EXPORT_IN_DATABASE;
+  $handler->type = t('Local');
+
+  if (isset($plugin['default conf'])) {
+    if (is_array($plugin['default conf'])) {
+      $handler->conf = $plugin['default conf'];
+    }
+    else if (function_exists($plugin['default conf'])) {
+      $handler->conf = $plugin['default conf']($handler, $task, $subtask_id);
+    }
+  }
+
+  return $handler;
+}
+
 /**
  * Set an overidden weight for a task handler.
  *

delegator/js/task-handlers.js

@@ -20,22 +20,29 @@ Drupal.behaviors.zzGoLastDelegatorTaskList = function(context) {
   }
 
   $('.delegator-operations select:not(.delegator-processed)', context).each(function() {
+    var $select = $(this);
     var $next = $(this).parent().next('input');
     $next.hide();
-    $(this).change(function() {
-      var val = $(this).val();
+    $(this).hide();
+
+    $dropdown = $(this).parent().siblings('.ctools-dropdown');
+   
+    $('.ctools-dropdown-container a', $dropdown).click(function() {
+      var val = $(this).attr('href').replace('/', '');
+
       // ignore empty
       if (!val) {
-        return;
+        return false;
       }
 
       // force confirm on delete
-      if ($(this).val() == 'delete' && !confirm(Drupal.t('Remove this task?'))) {
-        $(this).val('');
-        return;
+      if (val == 'delete' && !confirm(Drupal.t('Remove this task?'))) {
+        return false;
       }
-
+      
+      $select.val(val);
       $next.trigger('click');
+      return false;
     });
   });
 }

delegator/plugins/task_types/page.admin.inc

@@ -3,7 +3,11 @@
 
 /**
  * @file
- * Administrative functions for the page system
+ * Administrative functions for the page task type system
+ *
+ * This system provides a unified administrative interface to handle page
+ * tasks of all types, including a generic 'page' task that lets a user
+ * create pages as well as specific page tasks for handling built-in pages.
  */
 function delegator_page_type_list() {
   $tasks = delegator_get_tasks_by_type('page');
@@ -27,14 +31,11 @@ function delegator_page_type_list() {
   );
 
   foreach ($tables as $bucket => $info) {
-    if (!empty($info['rows'])) {
-      $output .= '<h3>' . check_plain($info['title']) . '</h3>';
-      $output .= '<div class="description">' . check_plain($info['description']) . '</div>';
-      if (isset($info['operations'])) {
-        $info['rows'][] = array('data' => array(array('data' => theme('links', $info['operations']), 'colspan' => 3)), 'class' => 'delegator-page-operations');
-      }
+    $output .= '<h3>' . check_plain($info['title']) . '</h3>';
+    $output .= '<div class="description">' . check_plain($info['description']) . '</div>';
+    if (isset($info['operations'])) {
+      $info['rows'][] = array('data' => array(array('data' => theme('links', $info['operations']), 'colspan' => 3)), 'class' => 'delegator-page-operations');
     }
-
     $output .= theme('table', $header, $info['rows']);
   }
 

delegator/plugins/tasks/page.admin.inc

@@ -72,6 +72,9 @@ function delegator_page_menu(&$items, $task) {
 
   // Add menu entries for each subtask
   foreach (delegator_page_load_all() as $subtask_id => $subtask) {
+    if (!isset($subtask->access['type'])) {
+      $subtask->access['type'] = 'none';
+    }
     if (!isset($subtask->access['settings'])) {
       $subtask->access['settings'] = NULL;
     }
@@ -207,7 +210,7 @@ function delegator_page_clear_page_cache($name) {
  *   The value will be the position of the argument so that it can easily
  *   be found. Items with a position of -1 have multiple positions.
  */
-function delegator_page_get_arguments($path) {
+function delegator_page_get_named_arguments($path) {
   $arguments = array();
   $bits = explode('/', $path);
   foreach ($bits as $position => $bit) {
@@ -327,7 +330,18 @@ function delegator_page_add_subtask_finish(&$form_state) {
   // Force a menu rebuild to recognize our new subtask
   menu_rebuild();
 
-  if ($form_state['type'] == 'add') {
+  if (isset($form_state['create task handler'])) {
+    require_once './' . drupal_get_path('module', 'delegator') . '/delegator.admin.inc';
+    $task = $form_state['task'];
+    $task_name = delegator_make_task_name($task['name'], $page->name);
+    $cache = delegator_admin_get_task_cache($task, $page->name, $form_state['task_handlers']);
+    $plugin = delegator_get_task_handler($form_state['create task handler']);
+
+    // Create a new handler.
+    $handler = delegator_new_task_handler($task, $page->name, $plugin, 0, $cache);
+    $form_state['redirect'] = delegator_admin_new_task_handler($handler, $task_name, $task, $page->name, $cache, $plugin);
+  }
+  else if ($form_state['type'] == 'add') {
     // Redirect to the new page's task handler editor.
     $form_state['redirect'] = 'admin/build/delegator/page-' . $page->name;
   }
@@ -1093,3 +1107,59 @@ function delegator_page_argument_form_settings_submit(&$form, &$form_state) {
     $page->temporary_arguments[$keyword]['settings'] = array();
   }
 }
+
+/**
+ * Form to configure a page to have a single task handler or multiple
+ * task handlers.
+ */
+function delegator_page_argument_form_multiple(&$form, &$form_state) {
+  $task = delegator_get_task('page');
+  $task_handlers = delegator_load_task_handlers($task, $form_state['page']->name);
+
+  $form['multiple'] = array(
+    '#type' => 'radios',
+    '#options' => array(
+      1 => t('Allow multiple handlers for this page.'),
+      0 => t('Create a single handler for this page.'),
+    ),
+    '#default_value' => $form_state['page']->multiple,
+    '#description' => t('By allowing multiple handlers, the task handler UI will open up, allowing you to add and remove task handlers and adjust their priority.'),
+  );
+
+  if (count($task_handlers) > 1) {
+    $form['multiple']['#disabled'] = TRUE;
+    $form['multiple']['#description'] .= t('You may not modify this value while multiple task handlers exist. If you wish to change this to single only, you must reduce the number of task handlers attached to the page to zero or one.');
+  }
+
+  $form_state['task'] = $task;
+  $form_state['task_handlers'] = $task_handlers;
+
+  if ($form_state['type'] == 'add' || empty($task_handlers)) {
+    // Get a list of possible task handlers for this task.
+    $task_handler_plugins = delegator_get_task_handler_plugins($task);
+    foreach ($task_handler_plugins as $id => $plugin) {
+      $options[$id] = $plugin['title'];
+    }
+
+    ctools_include('dependent');
+    $form['handler'] = array(
+      '#title' => t('Select the handler for this page'),
+      '#type' => 'select',
+      '#options' => $options,
+      '#process' => array('ctools_dependent_process'),
+      '#dependency' => array('radio:multiple' => array(0)),
+    );
+  }
+}
+
+/**
+ * Submit handler for the multiple form.
+ */
+function delegator_page_argument_form_multiple_submit(&$form, &$form_state) {
+  $form_state['page']->multiple = $form_state['values']['multiple'];
+
+  // The task handler will be created in the _finish hook.
+  if (!$form_state['page']->multiple && empty($task_handlers)) {
+    $form_state['create task handler'] = $form_state['values']['handler'];
+  }
+}

delegator/plugins/tasks/page.inc

@@ -91,12 +91,37 @@ function delegator_page_build_subtask($task, $page) {
   }
 
   $operations = array();
+  $task_name = delegator_make_task_name($task['name'], $name);
 
   if (empty($page->disabled)) {
-    $operations[] = array(
-      'title' => t('Task handlers'),
-      'href' => "admin/build/delegator/" . delegator_make_task_name($task['name'], $name),
-    );
+    if ($page->multiple) {
+      $operations[] = array(
+        'title' => t('Task handlers'),
+        'href' => "admin/build/delegator/$task_name",
+      );
+    }
+    else {
+      $task_handlers = delegator_load_task_handlers($task, $page->name);
+      if ($task_handlers) {
+        $handler = array_shift($task_handlers);
+        $plugin = delegator_get_task_handler($handler->handler);
+        if (!empty($plugin['edit forms'])) {
+          $actions = array();
+          foreach ($plugin['edit forms'] as $edit_id => $title) {
+            if ($title) {
+              $actions[] = array(
+                'title' => $title,
+                'href' => "admin/build/delegator/$task_name/$handler->handler/$handler->name/$edit_id",
+              );
+            }
+          }
+          $operations[] =  array(
+            'title' => '<span class="text">' . t('Edit handler') . '</span>' . theme('links', $actions),
+            'html' => TRUE,
+          );
+        }
+      }
+    }
     $operations[] =  array(
       'title' => '<span class="text">' . t('Edit page') . '</span>' . theme('links', $edit_links),
       'html' => TRUE,
@@ -141,6 +166,7 @@ function delegator_page_build_subtask($task, $page) {
     'admin path' => $page->path,
     'subtask' => $page,
     'operations' => $operations,
+    'single task' => empty($page->multiple),
   );
 }
 
@@ -174,6 +200,7 @@ function delegator_page_edit_form_info() {
       'access' => t('Access type'),
       'access-settings' => t('Access settings'),
       'menu' => t('Menu settings'),
+      'multiple' => t('Task handlers'),
     ),
     'forms' => array(
       'basic' => array(
@@ -191,6 +218,9 @@ function delegator_page_edit_form_info() {
       'argument' => array(
         'form id' => 'delegator_page_form_argument'
       ),
+      'multiple' => array(
+        'form id' => 'delegator_page_argument_form_multiple'
+      ),
     ),
   );
 }

includes/context-task-handler.inc

+<?php
+// $Id$
+/**
+ * @file
+ * Support for creating 'context' type task handlers.
+ *
+ * Context task handlers expect the task to provide 0 or more contexts. The
+ * task handler should use those contexts as selection criteria, as well as
+ * rendering with them.
+ *
+ * The functions and forms in this file should be common to every context type
+ * task handler made.
+ *
+ * Forms:
+ * - ...
+ */
+
+/**
+ * Compare arguments to contexts for selection purposes.
+ *
+ * @param $task
+ *   The task plugin definition.
+ * @param $subtask_id
+ *   The id of the subtask being used.
+ * @param $contexts
+ *   The context objects provided by the task.
+ * @return
+ *   TRUE if these contexts match the selection criteria. NULL or FALSE
+ *   otherwise.
+ */
+function ctools_context_handler_select($task, $subtask_id, $contexts) {
+  if ($function = ctools_plugin_get_function($task, 'get arguments')) {
+    $arguments = $function($task, $subtask_id);
+    foreach ($arguments as $argument) {
+      $id = ctools_context_id($argument, 'argument');
+      if (empty($handler->conf[$id]) || empty($contexts[$id])) {
+        return FALSE;
+      }
+
+      if ($function = ctools_plugin_load_function('ctools', 'arguments', $argument['name'], 'criteria select')) {
+        if (!$function($handler->conf[$id], $contexts[$id])) {
+          return FALSE;
+        }
+      }
+    }
+  }
+  // Either there are no arguments or all arguments passed.
+  return TRUE;
+}
+
+/**
+ * Get the array of summary strings for the arguments.
+ *
+ * These summary strings are used to communicate to the user what
+ * arguments the task handlers are selecting.
+ *
+ * @param $task
+ *   The loaded task plugin.
+ * @param $subtask_id
+ *   The subtask id.
+ * @param $conf
+ *   The configuration array that will contain the various argument settings,
+ *   keyed by argument ID.
+ */
+function ctools_context_handler_summary($task, $subtask_id, $conf) {
+  $strings = array();
+  if ($function = ctools_plugin_get_function($task, 'get arguments')) {
+    $arguments = $function($task, $subtask_id);
+    ctools_include('context');
+    foreach ($arguments as $argument) {
+      if ($function = ctools_plugin_load_function('ctools', 'arguments', $argument['name'], 'criteria summary')) {
+        $id = ctools_context_id($argument, 'argument');
+        if (!isset($conf[$id])) {
+          $conf[$id] = array();
+        }
+        $strings[] = $function($conf[$id], $argument);
+      }
+    }
+  }
+
+  return $strings;
+}
+
+/**
+ * Get empty contexts for use with the delegator panels pages.
+ */
+function ctools_context_handler_placeholders($task, $subtask_id) {
+  if ($function = ctools_plugin_get_function($task, 'get context placeholders')) {
+    return $function($task, $subtask_id);
+  }
+
+  return array();
+}
+
+/**
+ * Form to choose context based selection criteria for a task handler.
+ *
+ * The configuration will be assumed to go simply in $handler->conf and
+ * will be keyed by the argument ID.
+ */
+function ctools_context_handler_edit_criteria(&$form, &$form_state) {
+  // All 'context' type tasks are required to implement this function.
+  $form_state['arguments'] = array();
+  if ($function = ctools_plugin_get_function($form_state['task'], 'get arguments')) {
+    $arguments = $function($form_state['task'], $form_state['subtask_id']);
+
+    ctools_include('context');
+    foreach ($arguments as $argument) {
+      if ($function = ctools_plugin_load_function('ctools', 'arguments', $argument['name'], 'criteria form')) {
+        $id = ctools_context_id($argument, 'argument');
+        if (!isset($form_state['handler']->conf[$id])) {
+          $form_state['handler']->conf[$id] = array();
+        }
+
+        $form[$id] = array('#tree' => TRUE);
+        $function($form, $form_state, $form_state['handler']->conf[$id], $argument, $id);
+      }
+    }
+    $form_state['arguments'] = $arguments;
+  }
+}
+
+/**
+ * Validate handler for criteria selection
+ */
+function ctools_context_handler_edit_criteria_validate(&$form, &$form_state) {
+  foreach ($form_state['arguments'] as $argument) {
+    if ($function = ctools_plugin_load_function('ctools', 'arguments', $argument['name'], 'criteria form validate')) {
+      $id = ctools_context_id($argument, 'argument');
+      $function($form, $form_state, $form_state['handler']->conf[$id], $argument, $id);
+    }
+  }
+}
+
+/**
+ * Submit handler for criteria selection
+ */
+function ctools_context_handler_edit_criteria_submit(&$form, &$form_state) {
+  foreach ($form_state['arguments'] as $argument) {
+    $id = ctools_context_id($argument, 'argument');
+    if ($function = ctools_plugin_load_function('ctools', 'arguments', $argument['name'], 'criteria form submit')) {
+      $function($form, $form_state, $form_state['handler']->conf[$id], $argument, $id);
+    }
+
+    if (isset($form_state['values'][$id])) {
+      $form_state['handler']->conf[$id] = $form_state['values'][$id];
+    }
+  }
+}

includes/context.inc

@@ -407,6 +407,10 @@ function ctools_context_id($context, $type = 'context') {
 function ctools_context_next_id($objects, $name) {
   // Figure out which instance of this argument we're creating
   $id = 0;
+  if (!$objects) {
+    return $id;
+  }
+
   foreach ($objects as $object) {
     if (isset($object['name']) && $object['name'] == $name) {
       if ($object['id'] > $id) {

includes/dependent.inc

@@ -38,8 +38,8 @@
  * @code { ctools_include('dependent'); }
  *
  * On any form item, add
- * - @code '#process' => 'ctools_dependent_process' @endcode
- * - @code '#dependency' => array('id-of-form-without-the-#' => array(list, of, values, that, make, this, gadget, visible)); @endcode
+ * - @code '#process' => array('ctools_dependent_process'), @endcode
+ * - @code '#dependency' => array('id-of-form-without-the-#' => array(list, of, values, that, make, this, gadget, visible)), @endcode
  */
 
 /**

includes/wizard.inc

@@ -245,11 +245,21 @@ function ctools_wizard_wrapper(&$form, &$form_state) {
     $form['buttons']['cancel'] = array(
       '#type' => 'submit',
       '#value' => isset($form_info['cancel text']) ? $form_info['cancel text'] : t('Cancel'),
-      '#submit' => array('ctools_wizard_cancel'),
       '#wizard type' => 'cancel',
+      // hardcode the submit so that it doesn't try to save data.
+      '#submit' => array('ctools_wizard_submit'),
     );
   }
 
+  // Set up optional validate handlers.
+  $form['#validate'] = array();
+  if (function_exists($info['form id'] . '_validate')) {
+    $form['#validate'][] = $info['form id'] . '_validate';
+  }
+  if (isset($info['validate']) && function_exists($info['validate'])) {
+    $form['#validate'][] = $info['validate'];
+  }
+
   // Set up our submit handler after theirs. Since putting something here will
   // skip Drupal's autodetect, we autodetect for it.
 
@@ -259,6 +269,9 @@ function ctools_wizard_wrapper(&$form, &$form_state) {
   if (function_exists($info['form id'] . '_submit')) {
     $form['#submit'][] = $info['form id'] . '_submit';
   }
+  if (isset($info['submit']) && function_exists($info['submit'])) {
+    $form['#submit'][] = $info['submit'];
+  }
   $form['#submit'][] = 'ctools_wizard_submit';
 
   if (!empty($form_state['modal'])) {
@@ -280,14 +293,15 @@ function ctools_wizard_submit(&$form, &$form_state) {
       }
     }
     else {
-      if ($type == 'return' || $type == 'finish') {
-        if (isset($form_state['form_info']['return path'])) {
-          $form_state['redirect'] = $form_state['form_info']['return path'];
-        }
+      if ($type == 'cancel' && isset($form_state['form_info']['cancel path'])) {
+        $form_state['redirect'] = $form_state['form_info']['return path'];
       }
-      else {
+      else if ($type == 'next') {
         $form_state['redirect'] = ctools_wizard_get_path($form_state['form_info'], $form_state['clicked_button']['#next']);
       }
+      else if (isset($form_state['form_info']['return path'])) {
+        $form_state['redirect'] = $form_state['form_info']['return path'];
+      }
     }
   }
 }

plugins/arguments/nid.inc

@@ -18,6 +18,7 @@ function ctools_nid_ctools_arguments() {
     'context' => 'ctools_argument_nid_context',
     'criteria form' => 'ctools_argument_nid_criteria_form',
     'criteria select' => 'ctools_argument_nid_criteria_select',
+    'criteria summary' => 'ctools_argument_nid_criteria_summary',
   );
   return $args;
 }
@@ -87,3 +88,24 @@ function ctools_argument_nid_criteria_select($conf, $context) {
 
   return TRUE;
 }
+
+/**
+ * Provide a summary of the criteria for selecting this node.
+ */
+function ctools_argument_nid_criteria_summary($conf, $argument) {
+  if (!isset($conf['type'])) {
+    $conf['type'] = array();
+  }
+  $types = node_get_types();
+
+  $names = array();
+  foreach (array_filter($conf['type']) as $type) {
+    $names[] = check_plain($types[$type]->name);
+  }
+
+  if (empty($names)) {
+    return t('@identifier can be any node type', array('@identifier' => $argument['identifier']));
+  }
+
+  return format_plural(count($names), '@identifier can be type "@types"', '@identifier can be types "@types"', array('@types' => implode(', ', $names), '@identifier' => $argument['identifier']));
+}

plugins/arguments/uid.inc

@@ -19,6 +19,7 @@ function ctools_uid_ctools_arguments() {
     'context' => 'ctools_argument_uid_context',
     'criteria form' => 'ctools_argument_uid_criteria_form',
     'criteria select' => 'ctools_argument_uid_criteria_select',
+    'criteria summary' => 'ctools_argument_uid_criteria_summary',
   );
   return $args;
 }
@@ -87,3 +88,24 @@ function ctools_argument_uid_criteria_select($conf, $context) {
 
   return array_intersect($rids, $roles);
 }
+
+/**
+ * Provide a summary of the criteria for selecting this node.
+ */
+function ctools_argument_uid_criteria_summary($conf, $argument) {
+  if (!isset($conf['rids'])) {
+    $conf['rids'] = array();
+  }
+  $roles = ctools_get_roles();
+
+  $names = array();
+  foreach (array_filter($conf['rids']) as $rid) {
+    $names[] = check_plain($roles[$rid]);
+  }
+
+  if (empty($names)) {
+    return t('@identifier can have any role', array('@identifier' => $argument['identifier']));
+  }
+
+  return format_plural(count($names), '@identifier must have role "@roles"', '@identifier can be one of "@roles"', array('@roles' => implode(', ', $names), '@identifier' => $argument['identifier']));
+}