- Patch #306224 by catch et al: improving the taxonomy hook system.

7 files changed, 224 insertions, 17 deletions

diff --git a/modules/forum/forum.module b/modules/forum/forum.module
index 822f06004..b73d42631 100644
--- a/modules/forum/forum.module
+++ b/modules/forum/forum.module
@@ -632,8 +632,6 @@ function forum_get_topics($tid, $sortby, $forum_per_page) {
     }
   }
 
-  $term = taxonomy_term_load($tid);
-
   $sql = db_rewrite_sql("SELECT n.nid, r.tid, n.title, n.type, n.sticky, u.name, u.uid, n.created AS timestamp, n.comment AS comment_mode, l.last_comment_timestamp, IF(l.last_comment_uid != 0, cu.name, l.last_comment_name) AS last_comment_name, l.last_comment_uid, l.comment_count AS num_comments, f.tid AS forum_tid FROM {node_comment_statistics} l INNER JOIN {node} n ON n.nid = l.nid INNER JOIN {users} cu ON l.last_comment_uid = cu.uid INNER JOIN {term_node} r ON n.vid = r.vid INNER JOIN {users} u ON n.uid = u.uid INNER JOIN {forum} f ON n.vid = f.vid WHERE n.status = 1 AND r.tid = %d");
   $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
   $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
diff --git a/modules/simpletest/tests/taxonomy_test.info b/modules/simpletest/tests/taxonomy_test.info
new file mode 100644
index 000000000..8206e22fd
--- /dev/null
+++ b/modules/simpletest/tests/taxonomy_test.info
@@ -0,0 +1,9 @@
+; $Id$
+name = "Taxonomy test module"
+description = "Tests functions and hooks not used in core".
+package = Testing
+version = VERSION
+core = 7.x
+files[] = taxonomy_test.module
+hidden[] = TRUE
+dependencies[] = Taxonomy
diff --git a/modules/simpletest/tests/taxonomy_test.install b/modules/simpletest/tests/taxonomy_test.install
new file mode 100644
index 000000000..770fda6d5
--- /dev/null
+++ b/modules/simpletest/tests/taxonomy_test.install
@@ -0,0 +1,54 @@
+<?php
+// $Id$
+
+/**
+ * Implementation of hook_schema().
+ */
+function taxonomy_test_schema() {
+  $schema['term_antonym'] = array(
+    'description' => t('Stores term antonyms.'),
+    'fields' => array(
+      'taid' => array(
+        'type' => 'serial',
+        'not null' => TRUE,
+        'description' => t('Primary Key: Unique term antonym ID.'),
+      ),
+      'tid' => array(
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => t('The {term_data}.tid of the term.'),
+      ),
+      'name' => array(
+        'type' => 'varchar',
+        'length' => 255,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => t('The name of the antonym.'),
+      ),
+    ),
+    'indexes' => array(
+      'tid' => array('tid'),
+      'name_tid' => array('name', 'tid'),
+    ),
+    'primary key' => array('taid'),
+  );
+
+  return $schema;
+}
+
+/**
+ * Implementation of hook_install().
+ */
+function taxonomy_test_install() {
+  drupal_install_schema('taxonomy_test');
+}
+
+/**
+ * Implementation of hook_uninstall().
+ */
+function taxonomy_test_uninstall() {
+  drupal_uninstall_schema('taxonomy_test');
+}
+
diff --git a/modules/simpletest/tests/taxonomy_test.module b/modules/simpletest/tests/taxonomy_test.module
new file mode 100644
index 000000000..7f5b6f4df
--- /dev/null
+++ b/modules/simpletest/tests/taxonomy_test.module
@@ -0,0 +1,72 @@
+<?php
+// $Id$
+
+/**
+ * @file
+ * Test module for Taxonomy hooks and functions not used in core.
+ */
+
+/**
+ * Implementation of hook_taxonomy_term_load().
+ */
+function taxonomy_test_taxonomy_term_load($term) {
+  $term->antonyms = taxonomy_test_get_antonyms($term->tid);
+}
+
+/**
+ * Implementation of hook_taxonomy_term_save().
+ */
+function taxonomy_test_taxonomy_term_save($term) {
+  taxonomy_test_taxonomy_term_delete($term);
+  if (!empty($term->antonyms)) {
+    foreach (explode ("\n", str_replace("\r", '', $term->antonyms)) as $antonym) {
+      if ($antonym) {
+        db_insert('term_antonym')
+        ->fields(array(
+          'tid' => $term->tid,
+          'name' => rtrim($antonym),
+        ))
+        ->execute();
+      }
+    }
+  }
+}
+
+/**
+ * Implementation of hook_taxonomy_term_delete().
+ */
+function taxonomy_test_taxonomy_term_delete($term) {
+  db_delete('term_antonym')->condition('tid', $term->tid)->execute();
+}
+
+/**
+ * Implementation of hook_form_alter().
+ */
+function taxonomy_test_form_alter(&$form, $form_state, $form_id) {
+  if ($form_id == 'taxonomy_form_term') {
+    $antonyms = taxonomy_test_get_antonyms($form['#term']['tid']);
+    $form['advanced']['antonyms'] = array(
+      '#type' => 'textarea',
+      '#title' => t('Antonyms'),
+      '#default_value' => !empty($antonyms) ? implode("\n", $antonyms) : NULL,
+      '#description' => t('Antonyms of this term, one antonym per line.')
+    );
+  }
+}
+
+/**
+ * Return an array of antonyms of the given term ID.
+ */
+function taxonomy_test_get_antonyms($tid) {
+  if ($tid) {
+    $antonyms = array();
+    $result = db_query('SELECT name FROM {term_antonym} WHERE tid = :tid', array(':tid' => $tid));
+    foreach($result as $antonym) {
+      $antonyms[] = $antonym->name;
+    }
+    return $antonyms;
+  }
+  else {
+    return FALSE;
+  }
+}
diff --git a/modules/simpletest/tests/taxonomy_test.test b/modules/simpletest/tests/taxonomy_test.test
new file mode 100644
index 000000000..469c3e693
--- /dev/null
+++ b/modules/simpletest/tests/taxonomy_test.test
@@ -0,0 +1,59 @@
+<?php
+// $Id$
+
+class TaxonomyHooksTestCase extends DrupalWebTestCase {
+  /**
+   * Implementation of getInfo().
+   */
+  function getInfo() {
+    return array(
+      'name' => t('Taxonomy term hooks'),
+      'description' => t('Hooks for taxonomy term load/save/delete.'),
+      'group' => t('Taxonomy')
+    );
+  }
+
+  /**
+   * Implementation of setUp().
+   */
+  function setUp() {
+    parent::setUp('taxonomy', 'taxonomy_test');
+    $taxonomy_admin = $this->drupalCreateUser(array('administer taxonomy'));
+    $this->drupalLogin($taxonomy_admin);
+  }
+
+  /**
+   * Test that hooks are run correctly on creating, editing and deleting a term.
+   */
+  function testTaxonomyTermHooks() {
+    // Create a taxonomy vocabulary.
+    $edit = array(
+      'name' => $this->randomName(),
+    );
+    $this->drupalPost('admin/content/taxonomy/add', $edit, t('Save'));
+
+    // Create a term with one antonym.
+    $edit = array(
+      'name' => $this->randomName(),
+      'antonyms' => 'Long',
+    );
+    $this->drupalPost('admin/content/taxonomy/1/add', $edit, t('Save'));
+    $terms = taxonomy_get_term_by_name($edit['name']);
+    $term = taxonomy_term_load($terms[0]->tid);
+    $this->assertEqual($term->antonyms[0], $edit['antonyms'], t('Antonyms were loaded into the term object'));
+
+    // Update the term with a different antonym.
+    $edit = array(
+      'name' => $this->randomName(),
+      'antonyms' => 'Short',
+    );
+    $this->drupalPost('taxonomy/term/' . $term->tid . '/edit', $edit, t('Save'));
+    $term = taxonomy_term_load($term->tid, TRUE);
+    $this->assertTrue(in_array($edit['antonyms'], $term->antonyms), t('Antonym was successfully edited'));
+
+    // Delete the term.
+    taxonomy_del_term($term->tid);
+    $antonyms = db_query('SELECT taid FROM {term_antonym} WHERE tid = :tid', array(':tid' => $term->tid))->fetchField();
+    $this->assertFalse($antonyms, t('The antonyms were deleted from the database.'));
+  }
+}
diff --git a/modules/taxonomy/taxonomy.admin.inc b/modules/taxonomy/taxonomy.admin.inc
index 960558920..17b53e2b7 100644
--- a/modules/taxonomy/taxonomy.admin.inc
+++ b/modules/taxonomy/taxonomy.admin.inc
@@ -747,7 +747,8 @@ function taxonomy_form_term_submit($form, &$form_state) {
     return;
   }
 
-  switch (taxonomy_save_term($form_state['values'])) {
+  $status = taxonomy_save_term($form_state['values']);
+  switch ($status) {
     case SAVED_NEW:
       drupal_set_message(t('Created new term %term.', array('%term' => $form_state['values']['name'])));
       watchdog('taxonomy', 'Created new term %term.', array('%term' => $form_state['values']['name']), WATCHDOG_NOTICE, l(t('edit'), 'taxonomy/term/' . $form_state['values']['tid'] . '/edit'));
diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module
index 99859ddd6..86feae168 100644
--- a/modules/taxonomy/taxonomy.module
+++ b/modules/taxonomy/taxonomy.module
@@ -323,18 +323,19 @@ function taxonomy_save_term(&$form_values) {
     'weight' => 0
   );
 
+  $term = (object) $form_values;
+
   if (!empty($form_values['tid']) && $form_values['name']) {
-    drupal_write_record('term_data', $form_values, 'tid');
-    $hook = 'update';
-    $status = SAVED_UPDATED;
+    $status = drupal_write_record('term_data', $form_values, 'tid');
+    module_invoke_all('taxonomy_term_save', $term);
   }
   elseif (!empty($form_values['tid'])) {
     return taxonomy_del_term($form_values['tid']);
   }
   else {
-    drupal_write_record('term_data', $form_values);
-    $hook = 'insert';
-    $status = SAVED_NEW;
+    $status = drupal_write_record('term_data', $form_values);
+    $term->tid = $form_values['tid'];
+    module_invoke_all('taxonomy_term_save', $term);
   }
 
   db_query('DELETE FROM {term_relation} WHERE tid1 = %d OR tid2 = %d', $form_values['tid'], $form_values['tid']);
@@ -375,10 +376,6 @@ function taxonomy_save_term(&$form_values) {
     }
   }
 
-  if (isset($hook)) {
-    module_invoke_all('taxonomy', $hook, 'term', $form_values);
-  }
-
   cache_clear_all();
 
   return $status;
@@ -408,7 +405,7 @@ function taxonomy_del_term($tid) {
         }
       }
 
-      $term = (array) taxonomy_term_load($tid);
+      $term = taxonomy_term_load($tid);
 
       db_query('DELETE FROM {term_data} WHERE tid = %d', $tid);
       db_query('DELETE FROM {term_hierarchy} WHERE tid = %d', $tid);
@@ -416,7 +413,7 @@ function taxonomy_del_term($tid) {
       db_query('DELETE FROM {term_synonym} WHERE tid = %d', $tid);
       db_query('DELETE FROM {term_node} WHERE tid = %d', $tid);
 
-      module_invoke_all('taxonomy', 'delete', 'term', $term);
+      module_invoke_all('taxonomy_term_delete', $term);
     }
 
     $tids = $orphans;
@@ -1067,7 +1064,24 @@ function taxonomy_term_load($tid, $reset = FALSE) {
   }
   static $terms = array();
   if (!isset($terms[$tid]) || $reset) {
-    $terms[$tid] = db_fetch_object(db_query('SELECT * FROM {term_data} WHERE tid = %d', $tid));
+    $terms[$tid] = taxonomy_get_term_data($tid, $reset);
+    module_invoke_all('taxonomy_term_load', $terms[$tid]);
+  }
+  return $terms[$tid];
+}
+
+/**
+ * Return a term object from the term_data table.
+ * @param $tid
+ *   A term's ID
+ * @return Object
+ *  A term object. Results are statically cached.
+ */
+function taxonomy_get_term_data($tid, $reset = FALSE) {
+   static $terms = array();
+
+  if (!isset($terms[$tid]) || $reset) {
+    $terms[$tid] = db_query('SELECT * FROM {term_data} WHERE tid = :tid', array(':tid' => $tid))->fetchObject();
   }
   return $terms[$tid];
 }
@@ -1137,7 +1151,7 @@ function taxonomy_select_nodes($tids = array(), $operator = 'or', $depth = 0, $p
       $depth = NULL;
     }
     foreach ($tids as $index => $tid) {
-      $term = taxonomy_term_load($tid);
+      $term = taxonomy_get_term_data($tid);
       $tree = taxonomy_get_tree($term->vid, $tid, -1, $depth);
       $descendant_tids[] = array_merge(array($tid), array_map('_taxonomy_get_tid_from_term', $tree));
     }