taxonomy.module 49 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Kjartan's avatar
Kjartan committed
2
// $Id$
Dries's avatar
   
Dries committed
3

Dries's avatar
   
Dries committed
4
5
6
7
8
/**
 * @file
 * Enables the organization of content into categories.
 */

Dries's avatar
   
Dries committed
9
10
11
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
12
function taxonomy_perm() {
Dries's avatar
   
Dries committed
13
  return array('administer taxonomy');
Kjartan's avatar
Kjartan committed
14
}
Dries's avatar
   
Dries committed
15

Dries's avatar
   
Dries committed
16
17
18
19
20
21
22
23
24
25
26
/**
 * Implementation of hook_link().
 *
 * This hook is extended with $type = 'taxonomy terms' to allow themes to
 * print lists of terms associated with a node. Themes can print taxonomy
 * links with:
 *
 * if (module_exist('taxonomy')) {
 *   $this->links(taxonomy_link('taxonomy terms', $node));
 * }
 */
Dries's avatar
   
Dries committed
27
function taxonomy_link($type, $node = NULL) {
Dries's avatar
   
Dries committed
28
  if ($type == 'taxonomy terms' && $node != NULL) {
Kjartan's avatar
   
Kjartan committed
29
    $links = array();
Dries's avatar
   
Dries committed
30
    if (array_key_exists('taxonomy', $node)) {
Dries's avatar
   
Dries committed
31
32
      foreach ($node->taxonomy as $tid) {
        $term = taxonomy_get_term($tid);
33
        $links[] = l($term->name, taxonomy_term_path($term), array('rel' => 'tag', 'title' => $term->description));
Dries's avatar
   
Dries committed
34
35
36
37
      }
    }
    else {
      foreach (taxonomy_node_get_terms($node->nid) as $term) {
38
        $links[] = l($term->name, taxonomy_term_path($term), array('rel' => 'tag', 'title' => $term->description));
Dries's avatar
   
Dries committed
39
      }
Dries's avatar
   
Dries committed
40
41
42
    }
    return $links;
  }
Kjartan's avatar
Kjartan committed
43
44
}

45
46
47
48
49
50
51
52
function taxonomy_term_path($term) {
  $vocabulary = taxonomy_get_vocabulary($term->vid);
  if ($vocabulary->module != 'taxonomy' && $path = module_invoke($vocabulary->module, 'term_path', $term)) {
    return $path;
  }
  return 'taxonomy/term/'. $term->tid;
}

Dries's avatar
   
Dries committed
53
54
55
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
56
function taxonomy_menu($may_cache) {
Dries's avatar
   
Dries committed
57
  $items = array();
Dries's avatar
   
Dries committed
58

Dries's avatar
   
Dries committed
59
60
61
62
  if ($may_cache) {
    $items[] = array('path' => 'admin/taxonomy', 'title' => t('categories'),
      'callback' => 'taxonomy_admin',
      'access' => user_access('administer taxonomy'));
63

Dries's avatar
   
Dries committed
64
65
    $items[] = array('path' => 'admin/taxonomy/list', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
66

Dries's avatar
   
Dries committed
67
68
69
70
71
    $items[] = array('path' => 'admin/taxonomy/add/vocabulary', 'title' => t('add vocabulary'),
      'callback' => 'taxonomy_admin',
      'access' => user_access('administer taxonomy'),
      'type' => MENU_LOCAL_TASK);

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
    $items[] = array('path' => 'admin/taxonomy/edit/vocabulary', 'title' => t('edit vocabulary'),
      'callback' => 'taxonomy_admin',
      'access' => user_access('administer taxonomy'),
      'type' => MENU_CALLBACK);

    $items[] = array('path' => 'admin/taxonomy/add/term', 'title' => t('add term'),
      'callback' => 'taxonomy_admin',
      'access' => user_access('administer taxonomy'),
      'type' => MENU_CALLBACK);

    $items[] = array('path' => 'admin/taxonomy/edit/term', 'title' => t('edit term'),
      'callback' => 'taxonomy_admin',
      'access' => user_access('administer taxonomy'),
      'type' => MENU_CALLBACK);

Dries's avatar
   
Dries committed
87
88
89
90
    $items[] = array('path' => 'taxonomy/term', 'title' => t('taxonomy term'),
      'callback' => 'taxonomy_term_page',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Steven Wittens's avatar
Steven Wittens committed
91
92
93
94
95

    $items[] = array('path' => 'taxonomy/autocomplete', 'title' => t('autocomplete taxonomy'),
      'callback' => 'taxonomy_autocomplete',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
96
  }
Dries's avatar
Dries committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
  else {
    if (is_numeric(arg(2))) {
      $items[] = array('path' => 'admin/taxonomy/' . arg(2), 'title' => t('add term'),
        'callback' => 'taxonomy_admin',
        'access' => user_access('administer taxonomy'),
        'type' => MENU_CALLBACK);

      $items[] = array('path' => 'admin/taxonomy/' . arg(2) . '/list', 'title' => t('list'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);

      $items[] = array('path' => 'admin/taxonomy/' . arg(2) . '/add/term', 'title' => t('add term'),
        'callback' => 'taxonomy_admin',
        'access' => user_access('administer taxonomy'),
        'type' => MENU_LOCAL_TASK);
    }
  }
Dries's avatar
   
Dries committed
113

Dries's avatar
   
Dries committed
114
115
  return $items;
}
Dries's avatar
   
Dries committed
116

Kjartan's avatar
Kjartan committed
117
function taxonomy_form_vocabulary($edit = array()) {
118
  $form['name'] = array('#type' => 'textfield', '#title' => t('Vocabulary name'), '#default_value' => $edit['name'], '#maxlength' => 64, '#description' => t('The name for this vocabulary.  Example: "Topic".'), '#required' => TRUE);
119

120
121
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#description' => t('Description of the vocabulary; can be used by modules.'));
  $form['help'] = array('#type' => 'textfield', '#title' => t('Help text'), '#default_value' => $edit['help'], '#maxlength' => 255, '#description' => t('Instructions to present to the user when choosing a term.'));
122
123
  $form['nodes'] = array('#type' => 'checkboxes', '#title' => t('Types'), '#default_value' => $edit['nodes'], '#options' => node_get_types(), '#description' => t('A list of node types you want to associate with this vocabulary.'), '#required' => TRUE);
  $form['hierarchy'] = array('#type' => 'radios', '#title' => t('Hierarchy'), '#default_value' => $edit['hierarchy'], '#options' => array(t('Disabled'), t('Single'), t('Multiple')), '#description' => t('Allows <a href="%help-url">a tree-like hierarchy</a> between terms of this vocabulary.', array('%help-url' => url('admin/help/taxonomy', NULL, NULL, 'hierarchy'))));
124
125
126
127
128
  $form['relations'] = array('#type' => 'checkbox', '#title' => t('Related terms'), '#default_value' => $edit['relations'], '#description' => t('Allows <a href="%help-url">related terms</a> in this vocabulary.', array('%help-url' => url('admin/help/taxonomy', NULL, NULL, 'related-terms'))));
  $form['tags'] = array('#type' => 'checkbox', '#title' => t('Free tagging'), '#default_value' => $edit['tags'], '#description' => t('Content is categorized by typing terms instead of choosing from a list.'));
  $form['multiple'] = array('#type' => 'checkbox', '#title' => t('Multiple select'), '#default_value' => $edit['multiple'], '#description' => t('Allows nodes to have more than one term from this vocabulary (always true for free tagging).'));
  $form['required'] = array('#type' => 'checkbox', '#title' => t('Required'), '#default_value' => $edit['required'], '#description' => t('If enabled, every node <strong>must</strong> have at least one term in this vocabulary.'));
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#description' => t('In listings, the heavier vocabularies will sink and the lighter vocabularies will be positioned nearer the top.'));
129

130
131
132
133
  // Add extra vocabulary form elements.
  $extra = module_invoke_all('taxonomy', 'form', 'vocabulary');
  if (is_array($extra)) {
    foreach ($extra as $key => $element) {
134
      $extra[$key]['#weight'] = isset($extra[$key]['#weight']) ? $nodeapi[$key]['#weight'] : -18;
135
136
137
    }
    $form = array_merge($form, $extra);
  }
Dries's avatar
   
Dries committed
138

139
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
Dries's avatar
   
Dries committed
140
  if ($edit['vid']) {
141
142
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['vid'] = array('#type' => 'hidden', '#value' => $edit['vid']);
Dries's avatar
   
Dries committed
143
  }
144
  return drupal_get_form('taxonomy_form_vocabulary', $form);
Kjartan's avatar
Kjartan committed
145
}
Kjartan's avatar
Kjartan committed
146

147
function taxonomy_save_vocabulary(&$edit) {
148
  $edit['nodes'] = empty($edit['nodes']) ? array() : $edit['nodes'];
Dries's avatar
   
Dries committed
149

Dries's avatar
   
Dries committed
150
  if ($edit['vid'] && $edit['name']) {
151
    db_query("UPDATE {vocabulary} SET name = '%s', description = '%s', help = '%s', multiple = %d, required = %d, hierarchy = %d, relations = %d, tags = %d, weight = %d, module = '%s' WHERE vid = %d", $edit['name'], $edit['description'], $edit['help'], $edit['multiple'], $edit['required'], $edit['hierarchy'], $edit['relations'], $edit['tags'], $edit['weight'], isset($edit['module']) ? $edit['module'] : 'taxonomy', $edit['vid']);
Dries's avatar
   
Dries committed
152
    db_query("DELETE FROM {vocabulary_node_types} WHERE vid = %d", $edit['vid']);
153
    foreach ($edit['nodes'] as $type => $selected) {
Dries's avatar
   
Dries committed
154
155
      db_query("INSERT INTO {vocabulary_node_types} (vid, type) VALUES (%d, '%s')", $edit['vid'], $type);
    }
Dries's avatar
   
Dries committed
156
    module_invoke_all('taxonomy', 'update', 'vocabulary', $edit);
157
    $status = SAVED_UPDATED;
Dries's avatar
   
Dries committed
158
  }
Dries's avatar
   
Dries committed
159
  else if ($edit['vid']) {
160
    $status = taxonomy_del_vocabulary($edit['vid']);
Kjartan's avatar
Kjartan committed
161
162
  }
  else {
163
164
    $edit['vid'] = db_next_id('{vocabulary}_vid');
    db_query("INSERT INTO {vocabulary} (vid, name, description, help, multiple, required, hierarchy, relations, tags, weight, module) VALUES (%d, '%s', '%s', '%s', %d, %d, %d, %d, %d, %d, '%s')", $edit['vid'], $edit['name'], $edit['description'], $edit['help'], $edit['multiple'], $edit['required'], $edit['hierarchy'], $edit['relations'], $edit['tags'], $edit['weight'], isset($edit['module']) ? $edit['module'] : 'taxonomy');
165
    foreach ($edit['nodes'] as $type => $selected) {
Dries's avatar
   
Dries committed
166
167
      db_query("INSERT INTO {vocabulary_node_types} (vid, type) VALUES (%d, '%s')", $edit['vid'], $type);
    }
Dries's avatar
   
Dries committed
168
    module_invoke_all('taxonomy', 'insert', 'vocabulary', $edit);
169
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
170
  }
Dries's avatar
   
Dries committed
171
172

  cache_clear_all();
Dries's avatar
   
Dries committed
173

174
  return $status;
Kjartan's avatar
Kjartan committed
175
}
Dries's avatar
   
Dries committed
176

Kjartan's avatar
Kjartan committed
177
function taxonomy_del_vocabulary($vid) {
Dries's avatar
   
Dries committed
178
179
  $vocabulary = taxonomy_get_vocabulary($vid);

Dries's avatar
   
Dries committed
180
  db_query('DELETE FROM {vocabulary} WHERE vid = %d', $vid);
Dries's avatar
   
Dries committed
181
  db_query('DELETE FROM {vocabulary_node_types} WHERE vid = %d', $vid);
Dries's avatar
   
Dries committed
182
  $result = db_query('SELECT tid FROM {term_data} WHERE vid = %d', $vid);
Kjartan's avatar
Kjartan committed
183
184
  while ($term = db_fetch_object($result)) {
    taxonomy_del_term($term->tid);
Dries's avatar
   
Dries committed
185
  }
Dries's avatar
   
Dries committed
186

Dries's avatar
   
Dries committed
187
  module_invoke_all('taxonomy', 'delete', 'vocabulary', $vocabulary);
Dries's avatar
   
Dries committed
188

Dries's avatar
   
Dries committed
189
190
  cache_clear_all();

191
  return SAVED_DELETED;
Dries's avatar
   
Dries committed
192
193
194
195
196
}

function _taxonomy_confirm_del_vocabulary($vid) {
  $vocabulary = taxonomy_get_vocabulary($vid);

197
198
199
  $form['type'] = array('#type' => 'hidden', '#value' => 'vocabulary');
  $form['vid'] = array('#type' => 'hidden', '#value' => $vid);
  $form['name'] = array('#type' => 'hidden', '#value' => $vocabulary->name);
200
201
202
203
  return confirm_form('vocabulary_confirm_delete', $form,
                  t('Are you sure you want to delete the vocabulary %title?',
                  array('%title' => theme('placeholder', $vocabulary->name))),
                  'admin/taxonomy', t('Deleting a vocabulary will delete all the terms in it. This action cannot be undone.'),
204
                  t('Delete'),
205
                  t('Cancel'));
Kjartan's avatar
Kjartan committed
206
}
Dries's avatar
   
Dries committed
207

Kjartan's avatar
Kjartan committed
208
function taxonomy_form_term($edit = array()) {
Dries's avatar
   
Dries committed
209
  $vocabulary_id = isset($edit['vid']) ? $edit['vid'] : arg(4);
Kjartan's avatar
Kjartan committed
210
  $vocabulary = taxonomy_get_vocabulary($vocabulary_id);
Dries's avatar
   
Dries committed
211

212
  $form['name'] = array('#type' => 'textfield', '#title' => t('Term name'), '#default_value' => $edit['name'], '#maxlength' => 64, '#description' => t('The name for this term.  Example: "Linux".'), '#required' => TRUE);
213

214
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#description' => t('A description of the term.'));
Dries's avatar
   
Dries committed
215

Kjartan's avatar
Kjartan committed
216
  if ($vocabulary->hierarchy) {
Dries's avatar
   
Dries committed
217
218
    $parent = array_keys(taxonomy_get_parents($edit['tid']));
    $children = taxonomy_get_tree($vocabulary_id, $edit['tid']);
Dries's avatar
   
Dries committed
219

Dries's avatar
   
Dries committed
220
    // A term can't be the child of itself, nor of its children.
Dries's avatar
   
Dries committed
221
222
223
    foreach ($children as $child) {
      $exclude[] = $child->tid;
    }
Dries's avatar
   
Dries committed
224
    $exclude[] = $edit['tid'];
Dries's avatar
   
Dries committed
225

Kjartan's avatar
Kjartan committed
226
    if ($vocabulary->hierarchy == 1) {
227
      $form['parent'] = _taxonomy_term_select(t('Parent'), 'parent', $parent, $vocabulary_id, l(t('Parent term'), 'admin/help/taxonomy', NULL, NULL, 'parent') .'.', 0, '<'. t('root') .'>', $exclude);
Dries's avatar
   
Dries committed
228
    }
Kjartan's avatar
Kjartan committed
229
    elseif ($vocabulary->hierarchy == 2) {
230
      $form['parent'] = _taxonomy_term_select(t('Parents'), 'parent', $parent, $vocabulary_id, l(t('Parent terms'), 'admin/help/taxonomy', NULL, NULL, 'parent') .'.', 1, '<'. t('root') .'>', $exclude);
Dries's avatar
   
Dries committed
231
    }
Kjartan's avatar
Kjartan committed
232
  }
Dries's avatar
   
Dries committed
233

234
  if ($vocabulary->relations) {
235
    $form['relations'] = _taxonomy_term_select(t('Related terms'), 'relations', array_keys(taxonomy_get_related($edit['tid'])), $vocabulary_id, NULL, 1, '<'. t('none') .'>', array($edit['tid']));
236
237
  }

238
239
  $form['synonyms'] = array('#type' => 'textarea', '#title' => t('Synonyms'), '#default_value' => implode("\n", taxonomy_get_synonyms($edit['tid'])), '#description' => t('<a href="%help-url">Synonyms</a> of this term, one synonym per line.', array('%help-url' => url('admin/help/taxonomy', NULL, NULL, 'synonyms'))));
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#description' => t('In listings, the heavier terms will sink and the lighter terms will be positioned nearer the top.'));
240
241
242
243
244

  // Add extra term form elements.
  $extra = module_invoke_all('taxonomy', 'term', 'vocabulary');
  if (is_array($extra)) {
    foreach ($extra as $key => $element) {
245
      $extra[$key]['#weight'] = isset($extra[$key]['#weight']) ? $nodeapi[$key]['#weight'] : -18;
246
247
248
249
250
    }
    $form = array_merge($form, $extra);
  }


251
252
  $form['vid'] = array('#type' => 'hidden', '#value' => $vocabulary->vid);
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
Kjartan's avatar
Kjartan committed
253

Dries's avatar
   
Dries committed
254
  if ($edit['tid']) {
255
256
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
Dries's avatar
   
Dries committed
257
  }
258
  else {
259
    $form['destination'] = array('#type' => 'hidden', '#value' => $_GET['q']);
260
  }
Dries's avatar
   
Dries committed
261

262
  return drupal_get_form('taxonomy_form_term', $form);
Kjartan's avatar
Kjartan committed
263
}
Dries's avatar
   
Dries committed
264

265
function taxonomy_save_term(&$edit) {
Dries's avatar
   
Dries committed
266
  if ($edit['tid'] && $edit['name']) {
267
    db_query("UPDATE {term_data} SET name = '%s', description = '%s', weight = %d WHERE tid = %d", $edit['name'], $edit['description'], $edit['weight'], $edit['tid']);
Dries's avatar
   
Dries committed
268
    module_invoke_all('taxonomy', 'update', 'term', $edit);
269
    $status = SAVED_UPDATED;
Kjartan's avatar
Kjartan committed
270
  }
Dries's avatar
   
Dries committed
271
272
  else if ($edit['tid']) {
    return taxonomy_del_term($edit['tid']);
Kjartan's avatar
Kjartan committed
273
274
  }
  else {
Dries's avatar
   
Dries committed
275
    $edit['tid'] = db_next_id('{term_data}_tid');
276
    db_query("INSERT INTO {term_data} (tid, name, description, vid, weight) VALUES (%d, '%s', '%s', %d, %d)", $edit['tid'], $edit['name'], $edit['description'], $edit['vid'], $edit['weight']);
Dries's avatar
   
Dries committed
277
    module_invoke_all('taxonomy', 'insert', 'term', $edit);
278
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
279
  }
Dries's avatar
   
Dries committed
280

Dries's avatar
   
Dries committed
281
282
283
  db_query('DELETE FROM {term_relation} WHERE tid1 = %d OR tid2 = %d', $edit['tid'], $edit['tid']);
  if ($edit['relations']) {
    foreach ($edit['relations'] as $related_id) {
Kjartan's avatar
Kjartan committed
284
      if ($related_id != 0) {
Dries's avatar
   
Dries committed
285
        db_query('INSERT INTO {term_relation} (tid1, tid2) VALUES (%d, %d)', $edit['tid'], $related_id);
Dries's avatar
   
Dries committed
286
      }
Kjartan's avatar
Kjartan committed
287
    }
Kjartan's avatar
Kjartan committed
288
  }
Dries's avatar
   
Dries committed
289

Dries's avatar
   
Dries committed
290
291
  db_query('DELETE FROM {term_hierarchy} WHERE tid = %d', $edit['tid']);
  if (!isset($edit['parent'])) {
292
    $edit['parent'] = array(0);
Kjartan's avatar
Kjartan committed
293
  }
Dries's avatar
   
Dries committed
294
295
  if (is_array($edit['parent'])) {
    foreach ($edit['parent'] as $parent) {
296
297
298
299
300
301
302
303
      if (is_array($parent)) {
        foreach ($parent as $tid) {
          db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $edit['tid'], $tid);
        }
      }
      else {
        db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $edit['tid'], $parent);
      }
Dries's avatar
   
Dries committed
304
    }
Kjartan's avatar
Kjartan committed
305
  }
306
307
308
  else {
    db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $edit['tid'], $edit['parent']);
  }
Dries's avatar
   
Dries committed
309

Dries's avatar
   
Dries committed
310
311
312
  db_query('DELETE FROM {term_synonym} WHERE tid = %d', $edit['tid']);
  if ($edit['synonyms']) {
    foreach (explode ("\n", str_replace("\r", '', $edit['synonyms'])) as $synonym) {
Dries's avatar
   
Dries committed
313
      if ($synonym) {
Dries's avatar
   
Dries committed
314
        db_query("INSERT INTO {term_synonym} (tid, name) VALUES (%d, '%s')", $edit['tid'], chop($synonym));
Dries's avatar
   
Dries committed
315
      }
Kjartan's avatar
Kjartan committed
316
    }
Dries's avatar
   
Dries committed
317
  }
Dries's avatar
   
Dries committed
318

Dries's avatar
   
Dries committed
319
320
  cache_clear_all();

321
  return $status;
Kjartan's avatar
Kjartan committed
322
}
Dries's avatar
   
Dries committed
323

Kjartan's avatar
Kjartan committed
324
function taxonomy_del_term($tid) {
325
326
327
328
329
330
331
332
333
334
335
336
337
338
  $tids = array($tid);
  while ($tids) {
    $children_tids = $orphans = array();
    foreach ($tids as $tid) {
      // See if any of the term's children are about to be become orphans:
      if ($children = taxonomy_get_children($tid)) {
        foreach ($children as $child) {
          // If the term has multiple parents, we don't delete it.
          $parents = taxonomy_get_parents($child->tid);
          if (count($parents) == 1) {
            $orphans[] = $child->tid;
          }
        }
      }
Dries's avatar
   
Dries committed
339

340
      $term = taxonomy_get_term($tid);
Dries's avatar
   
Dries committed
341

342
343
344
345
346
      db_query('DELETE FROM {term_data} WHERE tid = %d', $tid);
      db_query('DELETE FROM {term_hierarchy} WHERE tid = %d', $tid);
      db_query('DELETE FROM {term_relation} WHERE tid1 = %d OR tid2 = %d', $tid, $tid);
      db_query('DELETE FROM {term_synonym} WHERE tid = %d', $tid);
      db_query('DELETE FROM {term_node} WHERE tid = %d', $tid);
Dries's avatar
   
Dries committed
347

348
      module_invoke_all('taxonomy', 'delete', 'term', $term);
349
      drupal_set_message(t('Deleted term %name.', array('%name' => theme('placeholder', $term->name))));
350
    }
Dries's avatar
   
Dries committed
351

352
353
    $tids = $orphans;
  }
Dries's avatar
   
Dries committed
354

Dries's avatar
   
Dries committed
355
  cache_clear_all();
Dries's avatar
   
Dries committed
356
357
358
359
360
}

function _taxonomy_confirm_del_term($tid) {
  $term = taxonomy_get_term($tid);

361
362
  $form['type'] = array('#type' => 'hidden', '#value' => 'term');
  $form['tid'] = array('#type' => 'hidden', '#value' => $tid);
363
364
365
  return confirm_form('term_confirm_delete', $form,
                  t('Are you sure you want to delete the term %title?',
                  array('%title' => theme('placeholder', $term->name))),
366
367
368
                  'admin/taxonomy',
                  t('Deleting a term will delete all its children if there are any. This action cannot be undone.'),
                  t('Delete'),
369
                  t('Cancel'));
Kjartan's avatar
Kjartan committed
370
}
Dries's avatar
   
Dries committed
371

Dries's avatar
   
Dries committed
372
373
374
/**
 * Generate a tabular listing of administrative functions for vocabularies.
 */
Kjartan's avatar
Kjartan committed
375
function taxonomy_overview() {
Dries's avatar
Dries committed
376
377
  $vid = arg(2);

378
  // Show all vocabularies, and a "view terms" link to the pagers.
Dries's avatar
Dries committed
379
  if (!$vid) {
380
    $header = array(t('Name'), t('Type'), array('data' => t('Operations'), 'colspan' => '2'));
Dries's avatar
Dries committed
381
382
    $vocabularies = taxonomy_get_vocabularies();
    foreach ($vocabularies as $vocabulary) {
383
384
      $types = array();
      foreach ($vocabulary->nodes as $type) {
385
        $node_type = node_get_name($type);
386
387
        $types[] = $node_type ? $node_type : $type;
      }
Dries's avatar
Dries committed
388
      $rows[] = array(check_plain($vocabulary->name), implode(', ', $types), l(t('edit vocabulary'), "admin/taxonomy/edit/vocabulary/$vocabulary->vid"), l(t('edit terms'), "admin/taxonomy/$vocabulary->vid"));
Dries's avatar
Dries committed
389
390
391
    }

    if (!$rows) {
392
      $rows[] = array(array('data' => t('No categories available.'), 'colspan' => '4', 'class' => 'message'));
Dries's avatar
Dries committed
393
394
    }
  }
Dries's avatar
   
Dries committed
395

396
  // Show the vocabulary's terms with a pager.
Dries's avatar
Dries committed
397
  else {
398
399
400
    $destination = drupal_get_destination();

    $header = array(t('Name'), t('Operations'));
Dries's avatar
Dries committed
401
    $vocabulary = taxonomy_get_vocabulary($vid);
402

Dries's avatar
Dries committed
403
404
405
406
407
408
409
410
411
412
    drupal_set_title(check_plain($vocabulary->name));
    $start_from      = $_GET['page'] ? $_GET['page'] : 0;
    $total_entries   = 0;  // total count for pager
    $page_increment  = 25; // number of tids per page
    $displayed_count = 0;  // number of tids shown

    $tree = taxonomy_get_tree($vocabulary->vid);
    foreach ($tree as $term) {
      $total_entries++; // we're counting all-totals, not displayed
      if (($start_from && ($start_from * $page_increment) >= $total_entries) || ($displayed_count == $page_increment)) { continue; }
413
      $rows[] = array(_taxonomy_depth($term->depth) . ' ' . l(check_plain($term->name), "taxonomy/term/$term->tid"), l(t('edit'), "admin/taxonomy/edit/term/$term->tid", array(), $destination));
Dries's avatar
Dries committed
414
415
416
417
418
419
      $displayed_count++; // we're counting tids displayed
    }

    if (!$rows) {
      $rows[] = array(array('data' => t('No terms available.'), 'colspan' => '2'));
    }
Dries's avatar
   
Dries committed
420

Dries's avatar
Dries committed
421
422
    $GLOBALS['pager_page_array'][] = $start_from;  // FIXME
    $GLOBALS['pager_total'][] = intval($total_entries / $page_increment) + 1; // FIXME
423

Dries's avatar
Dries committed
424
425
    if ($total_entries >= $page_increment) {
      $rows[] = array(array('data' => theme('pager', NULL, $page_increment), 'colspan' => '2'));
Dries's avatar
Dries committed
426
    }
Dries's avatar
   
Dries committed
427
428
  }

Dries's avatar
Dries committed
429
  return theme('table', $header, $rows, array('id' => 'taxonomy'));
Kjartan's avatar
Kjartan committed
430
431
}

Dries's avatar
   
Dries committed
432
433
434
/**
 * Generate a form element for selecting terms from a vocabulary.
 */
Dries's avatar
   
Dries committed
435
function taxonomy_form($vid, $value = 0, $help = NULL, $name = 'taxonomy') {
Dries's avatar
   
Dries committed
436
  $vocabulary = taxonomy_get_vocabulary($vid);
437
  $help = ($help) ? $help : $vocabulary->help;
Kjartan's avatar
Kjartan committed
438
439
440
441
  if ($vocabulary->required) {
    $blank = 0;
  }
  else {
Dries's avatar
   
Dries committed
442
    $blank = '<'. t('none') .'>';
Kjartan's avatar
Kjartan committed
443
  }
Dries's avatar
   
Dries committed
444

445
  return _taxonomy_term_select(check_plain($vocabulary->name), $name, $value, $vid, $help, intval($vocabulary->multiple), $blank);
Kjartan's avatar
Kjartan committed
446
}
Dries's avatar
   
Dries committed
447

Dries's avatar
Dries committed
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
/**
 * Generate a set of options for selecting a term from all vocabularies. Can be
 * passed to form_select.
 */
function taxonomy_form_all($free_tags = 0) {
  $vocabularies = taxonomy_get_vocabularies();
  $options = array();
  foreach ($vocabularies as $vid => $vocabulary) {
    if ($vocabulary->tags && !$free_tags) { continue; }
    $tree = taxonomy_get_tree($vid);
    $options[$vocabulary->name] = array();
    if ($tree) {
      foreach ($tree as $term) {
        $options[$vocabulary->name][$term->tid] = _taxonomy_depth($term->depth, '-') . $term->name;
      }
    }
  }
  return $options;
}

Dries's avatar
   
Dries committed
468
469
470
471
472
473
/**
 * Return an array of all vocabulary objects.
 *
 * @param $type
 *   If set, return only those vocabularies associated with this node type.
 */
Dries's avatar
   
Dries committed
474
function taxonomy_get_vocabularies($type = NULL) {
Kjartan's avatar
Kjartan committed
475
  if ($type) {
476
    $result = db_query(db_rewrite_sql("SELECT v.vid, v.*, n.type FROM {vocabulary} v LEFT JOIN {vocabulary_node_types} n ON v.vid = n.vid WHERE n.type = '%s' ORDER BY v.weight, v.name", 'v', 'vid'), $type);
Kjartan's avatar
Kjartan committed
477
478
  }
  else {
479
    $result = db_query(db_rewrite_sql('SELECT v.*, n.type FROM {vocabulary} v LEFT JOIN {vocabulary_node_types} n ON v.vid = n.vid ORDER BY v.weight, v.name', 'v', 'vid'));
Kjartan's avatar
Kjartan committed
480
  }
Dries's avatar
   
Dries committed
481

Kjartan's avatar
Kjartan committed
482
  $vocabularies = array();
Dries's avatar
   
Dries committed
483
  $node_types = array();
Kjartan's avatar
Kjartan committed
484
  while ($voc = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
485
486
487
488
    $node_types[$voc->vid][] = $voc->type;
    unset($voc->type);
    $voc->nodes = $node_types[$voc->vid];
    $vocabularies[$voc->vid] = $voc;
Dries's avatar
   
Dries committed
489
  }
Dries's avatar
   
Dries committed
490

Kjartan's avatar
Kjartan committed
491
492
  return $vocabularies;
}
Dries's avatar
   
Dries committed
493

Dries's avatar
   
Dries committed
494
495
496
/**
 * Generate a form for selecting terms to associate with a node.
 */
497
498
499
500
501
502
503
504
505
506
507
function taxonomy_form_alter($form_id, &$form) {
  if (isset($form['type']) && $form['type']['#value'] .'_node_form' == $form_id) {
    $node = $form['#node'];

    if (!array_key_exists('taxonomy', $node)) {
      if ($node->nid) {
        $terms = taxonomy_node_get_terms($node->nid);
      }
      else {
        $terms = array();
      }
Kjartan's avatar
Kjartan committed
508
509
    }
    else {
510
      $terms = $node->taxonomy;
Dries's avatar
   
Dries committed
511
512
    }

513
    $c = db_query(db_rewrite_sql("SELECT v.* FROM {vocabulary} v INNER JOIN {vocabulary_node_types} n ON v.vid = n.vid WHERE n.type = '%s' ORDER BY v.weight, v.name", 'v', 'vid'), $node->type);
Dries's avatar
Dries committed
514

515
516
517
518
519
    while ($vocabulary = db_fetch_object($c)) {
      if ($vocabulary->tags) {
        $typed_terms = array();
        foreach ($terms as $term) {
          if ($term->vid == $vocabulary->vid) {
Dries's avatar
Dries committed
520

521
522
523
524
525
526
527
            // Commas and quotes in terms are special cases, so encode 'em.
            if (preg_match('/,/', $term->name) || preg_match('/"/', $term->name)) {
              $term->name = '"'.preg_replace('/"/', '""', $term->name).'"';
            }

            $typed_terms[] = $term->name;
          }
Dries's avatar
Dries committed
528
        }
529
        $typed_string = implode(', ', $typed_terms) . (array_key_exists('tags', $terms) ? $terms['tags'][$vocabulary->vid] : NULL);
530

531
532
533
534
535
536
        $form['taxonomy']['tags'][$vocabulary->vid] = array('#type' => 'textfield', '#default_value' => $typed_string, '#maxlength' => 100, '#autocomplete_path' => 'taxonomy/autocomplete/'. $vocabulary->vid, '#required' => $vocabulary->required, '#title' => $vocabulary->name, '#description' => t('A comma-separated list of terms describing this content (Example: funny, bungie jumping, "Company, Inc.").'));
      }
      else {
        $ntterms = array_key_exists('taxonomy', $node) ? $terms : array_keys($terms);
        $form['taxonomy'][$vocabulary->vid] = taxonomy_form($vocabulary->vid, $ntterms, $help, 'taxonomy');
      }
Dries's avatar
Dries committed
537
    }
538
539
540
    if (isset($form['taxonomy'])) {
      $form['taxonomy']['#tree'] = TRUE;
      $form['taxonomy']['#weight'] = -15;
Dries's avatar
Dries committed
541
    }
Dries's avatar
   
Dries committed
542
  }
Kjartan's avatar
Kjartan committed
543
}
Dries's avatar
   
Dries committed
544

Dries's avatar
   
Dries committed
545
546
547
548
/**
 * Find all terms associated to the given node, within one vocabulary.
 */
function taxonomy_node_get_terms_by_vocabulary($nid, $vid, $key = 'tid') {
549
  $result = db_query(db_rewrite_sql('SELECT t.tid, t.* FROM {term_data} t, {term_node} r WHERE t.tid = r.tid AND t.vid = %d AND r.nid = %d ORDER BY weight', 't', 'tid'), $vid, $nid);
Kjartan's avatar
Kjartan committed
550
551
552
  $terms = array();
  while ($term = db_fetch_object($result)) {
    $terms[$term->$key] = $term;
Dries's avatar
   
Dries committed
553
  }
Kjartan's avatar
Kjartan committed
554
555
556
  return $terms;
}

Dries's avatar
   
Dries committed
557
/**
558
 * Find all terms associated to the given node, ordered by vocabulary and term weight.
Dries's avatar
   
Dries committed
559
560
 */
function taxonomy_node_get_terms($nid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
561
  static $terms;
Dries's avatar
   
Dries committed
562

Dries's avatar
   
Dries committed
563
  if (!isset($terms[$nid])) {
564
    $result = db_query('SELECT t.* FROM {term_node} r INNER JOIN {term_data} t ON r.tid = t.tid INNER JOIN {vocabulary} v ON t.vid = v.vid WHERE r.nid = %d ORDER BY v.weight, t.weight, t.name', $nid);
Kjartan's avatar
Kjartan committed
565
    $terms[$nid] = array();
Dries's avatar
   
Dries committed
566
    while ($term = db_fetch_object($result)) {
Kjartan's avatar
Kjartan committed
567
      $terms[$nid][$term->$key] = $term;
Dries's avatar
   
Dries committed
568
569
    }
  }
Kjartan's avatar
Kjartan committed
570
571
  return $terms[$nid];
}
Dries's avatar
   
Dries committed
572

Dries's avatar
Dries committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
/**
 * Make sure incoming vids are free tagging enabled.
 */
function taxonomy_node_validate(&$node) {
  if ($node->taxonomy) {
    $terms = $node->taxonomy;
    if ($terms['tags']) {
      foreach ($terms['tags'] as $vid => $vid_value) {
        $vocabulary = taxonomy_get_vocabulary($vid);
        if (!$vocabulary->tags) {
          form_set_error("taxonomy[tags][$vid", t('The %name vocabulary can not be modified in this way.', array('%name' => theme('placeholder', $vocabulary->name))));
        }
      }
    }
  }
}

Dries's avatar
   
Dries committed
590
591
592
/**
 * Save term associations for a given node.
 */
Kjartan's avatar
Kjartan committed
593
function taxonomy_node_save($nid, $terms) {
594
  taxonomy_node_delete($nid);
Dries's avatar
Dries committed
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627

  // Free tagging vocabularies do not send their tids in the form,
  // so we'll detect them here and process them independently.
  if ($terms['tags']) {
    $typed_input = $terms['tags'];
    unset($terms['tags']);

    foreach ($typed_input as $vid => $vid_value) {
      // This regexp allows the following types of user input:
      // this, "somecmpany, llc", "and ""this"" w,o.rks", foo bar
      $regexp = '%(?:^|,\ *)("(?>[^"]*)(?>""[^"]* )*"|(?: [^",]*))%x';
      preg_match_all($regexp, $vid_value, $matches);
      $typed_terms = $matches[1];

      foreach ($typed_terms as $typed_term) {
        // If a user has escaped a term (to demonstrate that it is a group,
        // or includes a comma or quote character), we remove the escape
        // formatting so to save the term into the DB as the user intends.
        $typed_term = str_replace('""', '"', preg_replace('/^"(.*)"$/', '\1', $typed_term));
        $typed_term = trim($typed_term);
        if ($typed_term == "") { continue; }

        // See if the term exists in the chosen vocabulary
        // and return the tid, otherwise, add a new record.
        $possibilities = taxonomy_get_term_by_name($typed_term);
        $typed_term_tid = NULL; // tid match if any.
        foreach ($possibilities as $possibility) {
          if ($possibility->vid == $vid) {
            $typed_term_tid = $possibility->tid;
          }
        }

        if (!$typed_term_tid) {
628
629
630
          $edit = array('vid' => $vid, 'name' => $typed_term);
          $status = taxonomy_save_term($edit);
          $typed_term_tid = $edit['tid'];
Dries's avatar
Dries committed
631
632
633
634
635
636
        }

        db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $typed_term_tid);
      }
    }
  }
Dries's avatar
   
Dries committed
637

638
  if (is_array($terms)) {
Dries's avatar
   
Dries committed
639
    foreach ($terms as $term) {
640
641
642
643
644
645
646
      if (is_array($term)) {
        foreach ($term as $tid) {
          if ($tid) {
            db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $tid);
          }
        }
      }
647
      else if ($term) {
Dries's avatar
   
Dries committed
648
        db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $term);
649
      }
Dries's avatar
   
Dries committed
650
651
    }
  }
Kjartan's avatar
Kjartan committed
652
}
Dries's avatar
   
Dries committed
653

Dries's avatar
   
Dries committed
654
655
656
/**
 * Remove associations of a node to its terms.
 */
Kjartan's avatar
Kjartan committed
657
function taxonomy_node_delete($nid) {
Dries's avatar
   
Dries committed
658
  db_query('DELETE FROM {term_node} WHERE nid = %d', $nid);
Kjartan's avatar
Kjartan committed
659
}
Dries's avatar
   
Dries committed
660

Dries's avatar
   
Dries committed
661
662
663
664
/**
 * Find all term objects related to a given term ID.
 */
function taxonomy_get_related($tid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
665
  if ($tid) {
Dries's avatar
   
Dries committed
666
    $result = db_query('SELECT t.*, tid1, tid2 FROM {term_relation}, {term_data} t WHERE (t.tid = tid1 OR t.tid = tid2) AND (tid1 = %d OR tid2 = %d) AND t.tid != %d ORDER BY weight, name', $tid, $tid, $tid);
Kjartan's avatar
Kjartan committed
667
668
669
    $related = array();
    while ($term = db_fetch_object($result)) {
      $related[$term->$key] = $term;
Dries's avatar
   
Dries committed
670
    }
Kjartan's avatar
Kjartan committed
671
    return $related;
Dries's avatar
   
Dries committed
672
  }
Kjartan's avatar
Kjartan committed
673
674
  else {
    return array();
Dries's avatar
   
Dries committed
675
  }
Kjartan's avatar
Kjartan committed
676
}
Dries's avatar
   
Dries committed
677

Dries's avatar
   
Dries committed
678
679
680
681
/**
 * Find all parents of a given term ID.
 */
function taxonomy_get_parents($tid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
682
  if ($tid) {
683
    $result = db_query(db_rewrite_sql('SELECT t.tid, t.* FROM {term_hierarchy} h, {term_data} t WHERE h.parent = t.tid AND h.tid = %d ORDER BY weight, name', 't', 'tid'), $tid);
Kjartan's avatar
Kjartan committed
684
685
686
    $parents = array();
    while ($parent = db_fetch_object($result)) {
      $parents[$parent->$key] = $parent;
Dries's avatar
   
Dries committed
687
    }
Kjartan's avatar
Kjartan committed
688
    return $parents;
Dries's avatar
   
Dries committed
689
  }
Kjartan's avatar
Kjartan committed
690
691
692
693
  else {
    return array();
  }
}
Dries's avatar
   
Dries committed
694

Dries's avatar
   
Dries committed
695
696
697
698
/**
 * Find all ancestors of a given term ID.
 */
function taxonomy_get_parents_all($tid) {
Dries's avatar
   
Dries committed
699
700
701
702
703
704
705
706
707
708
709
710
  $parents = array();
  if ($tid) {
    $parents[] = taxonomy_get_term($tid);
    $n = 0;
    while ($parent = taxonomy_get_parents($parents[$n]->tid)) {
      $parents = array_merge($parents, $parent);
      $n++;
    }
  }
  return $parents;
}

Dries's avatar
   
Dries committed
711
712
713
714
/**
 * Find all children of a term ID.
 */
function taxonomy_get_children($tid, $vid = 0, $key = 'tid') {
Kjartan's avatar
Kjartan committed
715
  if ($vid) {
716
    $result = db_query(db_rewrite_sql('SELECT t.* FROM {term_hierarchy} h, {term_data} t WHERE t.vid = %d AND h.tid = t.tid AND h.parent = %d ORDER BY weight, name', 't', 'tid'), $vid, $tid);
Dries's avatar
   
Dries committed
717
  }
Kjartan's avatar
Kjartan committed
718
  else {
719
    $result = db_query(db_rewrite_sql('SELECT t.* FROM {term_hierarchy} h, {term_data} t WHERE h.tid = t.tid AND parent = %d ORDER BY weight, name', 't', 'tid'), $tid);
Kjartan's avatar
Kjartan committed
720
721
722
723
724
725
726
  }
  $children = array();
  while ($term = db_fetch_object($result)) {
    $children[$term->$key] = $term;
  }
  return $children;
}
Dries's avatar
   
Dries committed
727

Dries's avatar
   
Dries committed
728
729
730
731
732
733
734
735
736
737
738
739
740
/**
 * Create a hierarchical representation of a vocabulary.
 *
 * @param $vid
 *   Which vocabulary to generate the tree for.
 *
 * @param $parent
 *   The term ID under which to generate the tree. If 0, generate the tree
 *   for the entire vocabulary.
 *
 * @param $depth
 *   Internal use only.
 *
Dries's avatar
   
Dries committed
741
742
743
 * @param $max_depth
 *   The number of levels of the tree to return. Leave NULL to return all levels.
 *
Dries's avatar
   
Dries committed
744
745
746
747
748
 * @return
 *   An array of all term objects in the tree. Each term object is extended
 *   to have "depth" and "parents" attributes in addition to its normal ones.
 */
function taxonomy_get_tree($vid, $parent = 0, $depth = -1, $max_depth = NULL) {
Dries's avatar
   
Dries committed
749
  static $children, $parents, $terms;
Dries's avatar
   
Dries committed
750

Kjartan's avatar
Kjartan committed
751
  $depth++;
Dries's avatar
   
Dries committed
752

Dries's avatar
   
Dries committed
753
754
755
756
  // We cache trees, so it's not CPU-intensive to call get_tree() on a term
  // and its children, too.
  if (!isset($children[$vid])) {
    $children[$vid] = array();
Dries's avatar
   
Dries committed
757

758
    $result = db_query(db_rewrite_sql('SELECT t.tid, t.*, parent FROM {term_data} t, {term_hierarchy} h WHERE t.tid = h.tid AND t.vid = %d ORDER BY weight, name', 't', 'tid'), $vid);
Dries's avatar
   
Dries committed
759
    while ($term = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
760
761
762
      $children[$vid][$term->parent][] = $term->tid;
      $parents[$vid][$term->tid][] = $term->parent;
      $terms[$vid][$term->tid] = $term;
Dries's avatar
   
Dries committed
763
764
    }
  }
Dries's avatar
   
Dries committed
765

Dries's avatar
   
Dries committed
766
  $max_depth = (is_null($max_depth)) ? count($children[$vid]) : $max_depth;
Dries's avatar
Dries committed
767
768
769
770
771
772
773
774
775
776
777
778
  if ($children[$vid][$parent]) {
    foreach ($children[$vid][$parent] as $child) {
      if ($max_depth > $depth) {
        $terms[$vid][$child]->depth = $depth;
        // The "parent" attribute is not useful, as it would show one parent only.
        unset($terms[$vid][$child]->parent);
        $terms[$vid][$child]->parents = $parents[$vid][$child];
        $tree[] = $terms[$vid][$child];

        if ($children[$vid][$child]) {
          $tree = array_merge($tree, taxonomy_get_tree($vid, $child, $depth, $max_depth));
        }
Dries's avatar
   
Dries committed
779
      }
Dries's avatar
   
Dries committed
780
    }
Kjartan's avatar
Kjartan committed
781
  }
Dries's avatar
   
Dries committed
782

Dries's avatar
   
Dries committed
783
  return $tree ? $tree : array();
Kjartan's avatar
Kjartan committed
784
}
Dries's avatar
   
Dries committed
785

Dries's avatar
   
Dries committed
786
787
788
/**
 * Return an array of synonyms of the given term ID.
 */
Kjartan's avatar
Kjartan committed
789
790
function taxonomy_get_synonyms($tid) {
  if ($tid) {
Dries's avatar
   
Dries committed
791
    $result = db_query('SELECT name FROM {term_synonym} WHERE tid = %d', $tid);
Kjartan's avatar
Kjartan committed
792
    while ($synonym = db_fetch_array($result)) {
Dries's avatar
   
Dries committed
793
      $synonyms[] = $synonym['name'];
Dries's avatar
   
Dries committed
794
    }
Kjartan's avatar
Kjartan committed
795
    return $synonyms ? $synonyms : array();
Dries's avatar
   
Dries committed
796
  }
Kjartan's avatar
Kjartan committed
797
798
  else {
    return array();
Dries's avatar
   
Dries committed
799
  }
Kjartan's avatar
Kjartan committed
800
}
Dries's avatar
   
Dries committed
801

Dries's avatar
   
Dries committed
802
803
804
805
806
/**
 * Return the term object that has the given string as a synonym.
 */
function taxonomy_get_synonym_root($synonym) {
  return db_fetch_object(db_query("SELECT * FROM {term_synonym} s, {term_data} t WHERE t.tid = s.tid AND s.name = '%s'", $synonym));
Kjartan's avatar
Kjartan committed
807
}
Dries's avatar
   
Dries committed
808

Dries's avatar
   
Dries committed
809
810
811
/**
 * Given a term id, count the number of published nodes in it.
 */
Dries's avatar
   
Dries committed
812
function taxonomy_term_count_nodes($tid, $type = 0) {
Kjartan's avatar
Kjartan committed
813
  static $count;
Dries's avatar
   
Dries committed
814

Dries's avatar
   
Dries committed
815
816
817
  if (!isset($count[$type])) {
    // $type == 0 always evaluates true is $type is a string
    if (is_numeric($type)) {
818
      $result = db_query(db_rewrite_sql('SELECT t.tid, COUNT(n.nid) AS c FROM {term_node} t INNER JOIN {node} n ON t.nid = n.nid WHERE n.status = 1 GROUP BY t.tid'));
Dries's avatar
   
Dries committed
819
820
    }
    else {
821
      $result = db_query(db_rewrite_sql("SELECT t.tid, COUNT(n.nid) AS c FROM {term_node} t, {node} n WHERE t.nid = n.nid AND n.status = 1 AND n.type = '%s' GROUP BY t.tid"), $type);
Dries's avatar
   
Dries committed
822
    }
Kjartan's avatar
Kjartan committed
823
    while ($term = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
824
      $count[$type][$term->tid] = $term->c;
Dries's avatar
   
Dries committed
825
826
827
    }
  }

Kjartan's avatar
Kjartan committed
828
  foreach (_taxonomy_term_children($tid) as $c) {
Dries's avatar
   
Dries committed
829
    $children_count += taxonomy_term_count_nodes($c, $type);
Kjartan's avatar
Kjartan committed
830
  }
Dries's avatar
   
Dries committed
831
  return $count[$type][$tid] + $children_count;
Kjartan's avatar
Kjartan committed
832
833
}

Dries's avatar
   
Dries committed
834
835
836
/**
 * Helper for taxonomy_term_count_nodes().
 */
Kjartan's avatar
Kjartan committed
837
838
function _taxonomy_term_children($tid) {
  static $children;
Dries's avatar
   
Dries committed
839

Dries's avatar
   
Dries committed
840
  if (!isset($children)) {
Dries's avatar
   
Dries committed
841
    $result = db_query('SELECT tid, parent FROM {term_hierarchy}');
Kjartan's avatar
Kjartan committed
842
843
    while ($term = db_fetch_object($result)) {
      $children[$term->parent][] = $term->tid;
Dries's avatar
   
Dries committed
844
    }
Dries's avatar
   
Dries committed
845
  }
Kjartan's avatar
Kjartan committed
846
847
  return $children[$tid] ? $children[$tid] : array();
}
Dries's avatar
   
Dries committed
848

Dries's avatar
   
Dries committed
849
/**
Dries's avatar
   
Dries committed
850
 * Try to map a string to an existing term, as for glossary use.
Dries's avatar
   
Dries committed
851
 *
Dries's avatar
   
Dries committed
852
853
854
855
856
857
858
859
 * Provides a case-insensitive and trimmed mapping, to maximize the
 * likelihood of a successful match.
 *
 * @param name
 *   Name of the term to search for.
 *
 * @return
 *   An array of matching term objects.
Dries's avatar
   
Dries committed
860
861
 */
function taxonomy_get_term_by_name($name) {
862
  $db_result = db_query(db_rewrite_sql("SELECT t.tid, t.* FROM {term_data} t WHERE LOWER('%s') LIKE LOWER(name)", 't', 'tid'), trim($name));
Dries's avatar
   
Dries committed
863
864
865
866
867
868
869
870
  $result = array();
  while ($term = db_fetch_object($db_result)) {
    $result[] = $term;
  }

  return $result;
}

Dries's avatar
   
Dries committed
871
872
873
/**
 * Return the vocabulary object matching a vocabulary ID.
 */
Kjartan's avatar
Kjartan committed
874
function taxonomy_get_vocabulary($vid) {
875
876
877
878
879
880
881
882
883
884
885
  static $vocabularies = array();

  if (!array_key_exists($vid, $vocabularies)) {
    $result = db_query('SELECT v.*, n.type FROM {vocabulary} v LEFT JOIN {vocabulary_node_types} n ON v.vid = n.vid WHERE v.vid = %d ORDER BY v.weight, v.name', $vid);
    $node_types = array();
    while ($voc = db_fetch_object($result)) {
      $node_types[] = $voc->type;
      unset($voc->type);
      $voc->nodes = $node_types;
      $vocabularies[$vid] = $voc;
    }
Dries's avatar
   
Dries committed
886
887
  }

888
  return $vocabularies[$vid];
Kjartan's avatar
Kjartan committed
889
}
Dries's avatar
   
Dries committed
890

Dries's avatar
   
Dries committed
891
892
893
/**
 * Return the term object matching a term ID.
 */
Kjartan's avatar
Kjartan committed
894
895
function taxonomy_get_term($tid) {
  // simple cache using a static var?
Dries's avatar
   
Dries committed
896
  return db_fetch_object(db_query('SELECT * FROM {term_data} WHERE tid = %d', $tid));
Kjartan's avatar
Kjartan committed
897
}
Dries's avatar
   
Dries committed
898

Kjartan's avatar
Kjartan committed
899
function _taxonomy_term_select($title, $name, $value, $vocabulary_id, $description, $multiple, $blank, $exclude = array()) {
Dries's avatar
   
Dries committed
900
  $tree = taxonomy_get_tree($vocabulary_id);
901
902
  $options = array();

Dries's avatar
Dries committed
903
  if ($blank) {
904
    $options[0] = $blank;
Dries's avatar
Dries committed
905
  }
Kjartan's avatar
Kjartan committed
906
907
908
  if ($tree) {
    foreach ($tree as $term) {
      if (!in_array($term->tid, $exclude)) {
909
        $options[$term->tid] = _taxonomy_depth($term->depth, '-') . $term->name;
Dries's avatar
   
Dries committed
910
911
      }
    }
Kjartan's avatar
Kjartan committed
912
913
914
915
916
    if (!$blank && !$value) {
      // required but without a predefined value, so set first as predefined
      $value = $tree[0]->tid;
    }
  }
917
918
919
920
921
  return array('#type' => 'select', '#title' => $title, '#default_value' => $value, '#options' => $options, '#description' => $description, '#multiple' => $multiple, '#size' => $multiple ? 'size="'. min(12, count($options)) .'"' : 0, '#weight' => -15, '#theme' => 'taxonomy_term_select');
}

function theme_taxonomy_term_select($element) {
  return theme('select', $element);
Kjartan's avatar
Kjartan committed
922
}
Dries's avatar
   
Dries committed
923

Kjartan's avatar
Kjartan committed
924
925
926
function _taxonomy_depth($depth, $graphic = '--') {
  for ($n = 0; $n < $depth; $n++) {
    $result .= $graphic;
Dries's avatar
   
Dries committed
927
  }
Kjartan's avatar
Kjartan committed
928
929
  return $result;
}
Dries's avatar
   
Dries committed
930

Dries's avatar
   
Dries committed
931
932
933
/**
 * Finds all nodes that match selected taxonomy conditions.
 *
Dries's avatar
   
Dries committed
934
935
936
937
938
939
940
 * @param $tids
 *   An array of term IDs to match.
 * @param $operator
 *   How to interpret multiple IDs in the array. Can be "or" or "and".
 * @param $depth
 *   How many levels deep to traverse the taxonomy tree. Can be a nonnegative
 *   integer or "all".
Dries's avatar
   
Dries committed
941
942
943
 * @param $pager
 *   Whether the nodes are to be used with a pager (the case on most Drupal
 *   pages) or not (in an XML feed, for example).
944
 * @param $order
Dries's avatar
Dries committed
945
 *   The order clause for the query that retrieve the nodes.
Dries's avatar
   
Dries committed
946
947
948
 * @return
 *   A resource identifier pointing to the query results.
 */
949
function taxonomy_select_nodes($tids = array(), $operator = 'or', $depth = 0, $pager