From 0b229c0da79309be29164bb4d511207c4978c28e Mon Sep 17 00:00:00 2001
From: Earl Miles <merlin@logrus.com>
Date: Fri, 21 Nov 2008 18:13:04 +0000
Subject: [PATCH] Add a separate "weights" table for delegator items. Please
note that this commit will require you to reinstall the module to get the new
table.
---
delegator/delegator.admin.inc | 11 +++++------
delegator/delegator.install | 18 ++++++++++++++++++
delegator/delegator.module | 31 ++++++++++++++++++++++++++++++-
includes/export.inc | 15 +++++++++++++++
4 files changed, 68 insertions(+), 7 deletions(-)
diff --git a/delegator/delegator.admin.inc b/delegator/delegator.admin.inc
index a78d4558..22228aaf 100644
--- a/delegator/delegator.admin.inc
+++ b/delegator/delegator.admin.inc
@@ -478,7 +478,7 @@ function delegator_admin_list_form_add($form, &$form_state) {
}
// Store the new handler.
- if ($form_state['cache']->locked) {
+ if (!$form_state['cache']->locked) {
delegator_admin_set_task_handler_cache($handler);
}
@@ -538,10 +538,9 @@ function delegator_admin_list_form_submit($form, &$form_state) {
}
// Otherwise, check to see if it has moved and, if so, update the weight.
elseif ($info['weight'] != $form_state['task_handlers'][$id]->weight) {
- // update the weight. Since it could be in the databsae, we'll just
- // write the task handler we have.
- $form_state['task_handlers'][$id]->weight = $info['weight'];
- delegator_save_task_handler($form_state['task_handlers'][$id]);
+ // Theoretically we could only do this for in code objects, but since our
+ // load mechanism checks for all, this is less database work.
+ delegator_update_task_handler_weight($form_state['task_handlers'][$id], $info['weight']);
}
}
@@ -702,7 +701,7 @@ function delegator_administer_task_handler_edit($task_name, $handler_id, $name,
/**
* Entry point to add a task handler.
*/
-function delegator_administer_task_handler_add($task_id, $name, $form_id) {
+function delegator_administer_task_handler_add($task_name, $name, $form_id) {
// Determine if the task id came in the form of TASK-SUBTASK or just TASK
if (strpos($task_name, '-') !== FALSE) {
list($task_id, $subtask_id) = explode('-', $task_name, 2);
diff --git a/delegator/delegator.install b/delegator/delegator.install
index 55d29cd6..a32d6fcb 100644
--- a/delegator/delegator.install
+++ b/delegator/delegator.install
@@ -68,6 +68,24 @@ function delegator_schema_1() {
),
);
+ $schema['delegator_weights'] = array(
+ 'description' => t('Contains override weights for delegator handlers that are in code.'),
+ 'fields' => array(
+ 'name' => array(
+ 'type' => 'varchar',
+ 'length' => '255',
+ 'description' => t('Unique ID for this task handler. Used to identify it programmatically.'),
+ ),
+ 'weight' => array(
+ 'type' => 'int',
+ 'description' => t('The order in which this handler appears. Lower numbers go first.'),
+ ),
+ ),
+ 'primary key' => array('name'),
+ 'indexes' => array(
+ 'weights' => array('name', 'weight'),
+ ),
+ );
return $schema;
}
diff --git a/delegator/delegator.module b/delegator/delegator.module
index 61f526aa..190dec44 100644
--- a/delegator/delegator.module
+++ b/delegator/delegator.module
@@ -203,7 +203,24 @@ function delegator_load_task_handlers($task, $subtask_id = NULL) {
$conditions['subtask'] = $subtask_id;
}
- return ctools_export_load_object('delegator_handlers', 'conditions', $conditions);
+ $handlers = ctools_export_load_object('delegator_handlers', 'conditions', $conditions);
+
+ // Override weights from the weight table.
+ if ($handlers) {
+ $names = array();
+ $placeholders = array();
+ foreach ($handlers as $handler) {
+ $names[] = $handler->name;
+ $placeholders[] = "'%s'";
+ }
+
+ $result = db_query("SELECT name, weight FROM {delegator_weights} WHERE name IN (" . implode(', ', $placeholders) . ")", $names);
+ while ($weight = db_fetch_object($result)) {
+ $handlers[$weight->name]->weight = $weight->weight;
+ }
+ }
+
+ return $handlers;
}
/**
@@ -248,6 +265,7 @@ function delegator_save_task_handler(&$handler) {
}
drupal_write_record('delegator_handlers', $handler, $update);
+ db_query("DELETE FROM {delegator_weights} WHERE name = '%s'", $handler->name);
return $handler;
}
@@ -256,8 +274,19 @@ function delegator_save_task_handler(&$handler) {
*/
function delegator_delete_task_handler($handler) {
db_query("DELETE FROM {delegator_handlers} WHERE name = '%s'", $handler->name);
+ db_query("DELETE FROM {delegator_weights} WHERE name = '%s'", $handler->name);
}
+/**
+ * Set an overidden weight for a task handler.
+ *
+ * We do this so that in-code task handlers don't need to get written
+ * to the database just because they have their weight changed.
+ */
+function delegator_update_task_handler_weight($handler, $weight) {
+ db_query("DELETE FROM {delegator_weights} WHERE name = '%s'", $handler->name);
+ db_query("INSERT INTO {delegator_weights} (name, weight) VALUES ('%s', %d)", $handler->name, $weight);
+}
/**
* Shortcut function to get task plugins.
diff --git a/includes/export.inc b/includes/export.inc
index 90902d7b..e4f27911 100644
--- a/includes/export.inc
+++ b/includes/export.inc
@@ -31,6 +31,16 @@
),
*/
+/**
+ * A bit flag used to let us know if an object is in the database.
+ */
+define('EXPORT_IN_DATABASE', 0x01);
+
+/**
+ * A bit flag used to let us know if an object is a 'default' in code.
+ */
+define('EXPORT_IN_CODE', 0x02);
+
/**
* Load some number of exportable objects.
*
@@ -113,6 +123,8 @@ function ctools_export_load_object($table, $type = 'all', $args = array()) {
while ($data = db_fetch_object($result)) {
$object = ctools_export_unpack_object($schema, $data, $export['object']);
$object->type = t('Normal');
+ $object->export_type = EXPORT_IN_DATABASE;
+
$cache[$table][$object->{$export['key']}] = $object;
if ($type == 'conditions') {
$return[$object->{$export['key']}] = $object;
@@ -152,12 +164,15 @@ function ctools_export_load_object($table, $type = 'all', $args = array()) {
if (!empty($cache[$table][$object->name])) {
$cache[$table][$object->name]->type = t('Overridden');
+ $cache[$table][$object->name]->export_status |= EXPORT_IN_CODE;
if ($type == 'conditions') {
$return[$object->name] = $cache[$table][$object->name]->type;
}
}
else {
$object->type = t('Default');
+ $object->export_status = EXPORT_IN_CODE;
+ $object->in_code_only = TRUE;
// move the 'display' to the new 'primary' location.
$object->primary = $object->display;
unset($object->display);
--
GitLab