taxonomy.module 49.6 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)) {
31
      foreach ($node->taxonomy as $term) {
32
        $links[] = l($term->name, taxonomy_term_path($term), array('rel' => 'tag', 'title' => $term->description));
Dries's avatar
   
Dries committed
33
      }
Dries's avatar
   
Dries committed
34
35
36
    }
    return $links;
  }
Kjartan's avatar
Kjartan committed
37
38
}

39
40
41
42
43
44
45
46
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
47
48
49
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
50
function taxonomy_menu($may_cache) {
Dries's avatar
   
Dries committed
51
  $items = array();
Dries's avatar
   
Dries committed
52

Dries's avatar
   
Dries committed
53
  if ($may_cache) {
54
55
56
    $items[] = array('path' => 'admin/taxonomy',
      'title' => t('categories'),
      'callback' => 'taxonomy_overview_vocabularies',
Dries's avatar
   
Dries committed
57
      'access' => user_access('administer taxonomy'));
58

59
60
61
62
    $items[] = array('path' => 'admin/taxonomy/list',
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
63

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

70
71
72
    $items[] = array('path' => 'admin/taxonomy/edit/vocabulary',
      'title' => t('edit vocabulary'),
      'callback' => 'taxonomy_admin_vocabulary_edit',
73
74
75
      'access' => user_access('administer taxonomy'),
      'type' => MENU_CALLBACK);

76
77
78
    $items[] = array('path' => 'admin/taxonomy/edit/term',
      'title' => t('edit term'),
      'callback' => 'taxonomy_admin_term_edit',
79
80
81
      'access' => user_access('administer taxonomy'),
      'type' => MENU_CALLBACK);

82
83
    $items[] = array('path' => 'taxonomy/term',
      'title' => t('taxonomy term'),
Dries's avatar
   
Dries committed
84
85
86
      'callback' => 'taxonomy_term_page',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Steven Wittens's avatar
Steven Wittens committed
87

88
89
    $items[] = array('path' => 'taxonomy/autocomplete',
      'title' => t('autocomplete taxonomy'),
Steven Wittens's avatar
Steven Wittens committed
90
91
92
      'callback' => 'taxonomy_autocomplete',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
93
  }
Dries's avatar
Dries committed
94
95
  else {
    if (is_numeric(arg(2))) {
96
97
98
99
      $items[] = array('path' => 'admin/taxonomy/' . arg(2),
        'title' => t('list terms'),
        'callback' => 'taxonomy_overview_terms',
        'callback arguments' => array(arg(2)),
Dries's avatar
Dries committed
100
101
102
        'access' => user_access('administer taxonomy'),
        'type' => MENU_CALLBACK);

103
104
105
106
      $items[] = array('path' => 'admin/taxonomy/' . arg(2) . '/list',
        'title' => t('list'),
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => -10);
Dries's avatar
Dries committed
107

108
109
110
111
      $items[] = array('path' => 'admin/taxonomy/' . arg(2) . '/add/term',
        'title' => t('add term'),
        'callback' => 'taxonomy_admin_term_add',
        'callback arguments' => array(arg(2)),
Dries's avatar
Dries committed
112
113
114
115
        'access' => user_access('administer taxonomy'),
        'type' => MENU_LOCAL_TASK);
    }
  }
Dries's avatar
   
Dries committed
116

Dries's avatar
   
Dries committed
117
118
  return $items;
}
Dries's avatar
 
Dries committed
119

120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/**
 * List and manage vocabularies.
 */
function taxonomy_overview_vocabularies() {
  $header = array(t('Name'), t('Type'), array('data' => t('Operations'), 'colspan' => '2'));
  $vocabularies = taxonomy_get_vocabularies();
  foreach ($vocabularies as $vocabulary) {
    $types = array();
    foreach ($vocabulary->nodes as $type) {
      $node_type = node_get_name($type);
      $types[] = $node_type ? $node_type : $type;
    }
    $rows[] = array(check_plain($vocabulary->name), implode(', ', $types), l(t('edit vocabulary'), "admin/taxonomy/edit/vocabulary/$vocabulary->vid"), l(t('list terms'), "admin/taxonomy/$vocabulary->vid"));
  }

  if (!$rows) {
    $rows[] = array(array('data' => t('No categories available.'), 'colspan' => '4', 'class' => 'message'));
  }
  return theme('table', $header, $rows, array('id' => 'taxonomy'));
}

/**
 * Display a tree of all the terms in a vocabulary, with options to edit
 * each one.
 */
function taxonomy_overview_terms($vid) {
  $destination = drupal_get_destination();

  $header = array(t('Name'), t('Operations'));
  $vocabulary = taxonomy_get_vocabulary($vid);

  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; }
    $rows[] = array(_taxonomy_depth($term->depth) . ' ' . l($term->name, "taxonomy/term/$term->tid"), l(t('edit'), "admin/taxonomy/edit/term/$term->tid", array(), $destination));
    $displayed_count++; // we're counting tids displayed
  }

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

  $GLOBALS['pager_page_array'][] = $start_from;  // FIXME
  $GLOBALS['pager_total'][] = intval($total_entries / $page_increment) + 1; // FIXME

  if ($total_entries >= $page_increment) {
    $rows[] = array(array('data' => theme('pager', NULL, $page_increment), 'colspan' => '2'));
  }

  return theme('table', $header, $rows, array('id' => 'taxonomy'));
}

/**
 * Display form for adding and editing vocabularies.
 */
Kjartan's avatar
Kjartan committed
182
function taxonomy_form_vocabulary($edit = array()) {
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
  $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,
  );
  $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.'),
  );
  $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'))),
  );
  $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.'),
  );
239

240
241
242
243
  // Add extra vocabulary form elements.
  $extra = module_invoke_all('taxonomy', 'form', 'vocabulary');
  if (is_array($extra)) {
    foreach ($extra as $key => $element) {
244
      $extra[$key]['#weight'] = isset($extra[$key]['#weight']) ? $extra[$key]['#weight'] : -18;
245
246
247
    }
    $form = array_merge($form, $extra);
  }
Dries's avatar
 
Dries committed
248

249
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
Dries's avatar
   
Dries committed
250
  if ($edit['vid']) {
251
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
252
    $form['vid'] = array('#type' => 'value', '#value' => $edit['vid']);
Dries's avatar
 
Dries committed
253
  }
254
  return drupal_get_form('taxonomy_form_vocabulary', $form);
Kjartan's avatar
Kjartan committed
255
}
Kjartan's avatar
Kjartan committed
256

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
/**
 * Accept the form submission for a vocabulary and save the results.
 */
function taxonomy_form_vocabulary_submit($form_id, $form_values) {
  // Fix up the nodes array to remove unchecked nodes.
  $form_values['nodes'] = array_filter($form_values['nodes']);
  switch (taxonomy_save_vocabulary($form_values)) {
  case SAVED_NEW:
    drupal_set_message(t('Created new vocabulary %name.', array('%name' => theme('placeholder', $form_values['name']))));
    break;
  case SAVED_UPDATED:
    drupal_set_message(t('Updated vocabulary %name.', array('%name' => theme('placeholder', $form_values['name']))));
    break;
  }
  return 'admin/taxonomy';
}

274
function taxonomy_save_vocabulary(&$edit) {
275
  $edit['nodes'] = empty($edit['nodes']) ? array() : $edit['nodes'];
Dries's avatar
   
Dries committed
276

Dries's avatar
   
Dries committed
277
  if ($edit['vid'] && $edit['name']) {
278
    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
279
    db_query("DELETE FROM {vocabulary_node_types} WHERE vid = %d", $edit['vid']);
280
    foreach ($edit['nodes'] as $type => $selected) {
Dries's avatar
   
Dries committed
281
282
      db_query("INSERT INTO {vocabulary_node_types} (vid, type) VALUES (%d, '%s')", $edit['vid'], $type);
    }
Dries's avatar
   
Dries committed
283
    module_invoke_all('taxonomy', 'update', 'vocabulary', $edit);
284
    $status = SAVED_UPDATED;
Dries's avatar
 
Dries committed
285
  }
Dries's avatar
   
Dries committed
286
  else if ($edit['vid']) {
287
    $status = taxonomy_del_vocabulary($edit['vid']);
Kjartan's avatar
Kjartan committed
288
289
  }
  else {
290
291
    $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');
292
    foreach ($edit['nodes'] as $type => $selected) {
Dries's avatar
   
Dries committed
293
294
      db_query("INSERT INTO {vocabulary_node_types} (vid, type) VALUES (%d, '%s')", $edit['vid'], $type);
    }
Dries's avatar
   
Dries committed
295
    module_invoke_all('taxonomy', 'insert', 'vocabulary', $edit);
296
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
297
  }
Dries's avatar
   
Dries committed
298
299

  cache_clear_all();
Dries's avatar
   
Dries committed
300

301
  return $status;
Kjartan's avatar
Kjartan committed
302
}
Dries's avatar
 
Dries committed
303

Kjartan's avatar
Kjartan committed
304
function taxonomy_del_vocabulary($vid) {
305
  $vocabulary = (array) taxonomy_get_vocabulary($vid);
Dries's avatar
   
Dries committed
306

Dries's avatar
   
Dries committed
307
  db_query('DELETE FROM {vocabulary} WHERE vid = %d', $vid);
Dries's avatar
   
Dries committed
308
  db_query('DELETE FROM {vocabulary_node_types} WHERE vid = %d', $vid);
Dries's avatar
   
Dries committed
309
  $result = db_query('SELECT tid FROM {term_data} WHERE vid = %d', $vid);
Kjartan's avatar
Kjartan committed
310
311
  while ($term = db_fetch_object($result)) {
    taxonomy_del_term($term->tid);
Dries's avatar
 
Dries committed
312
  }
Dries's avatar
   
Dries committed
313

Dries's avatar
   
Dries committed
314
  module_invoke_all('taxonomy', 'delete', 'vocabulary', $vocabulary);
Dries's avatar
   
Dries committed
315

Dries's avatar
   
Dries committed
316
317
  cache_clear_all();

318
  return SAVED_DELETED;
Dries's avatar
   
Dries committed
319
320
321
322
323
}

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

324
325
326
327
  $form['type'] = array('#type' => 'value', '#value' => 'vocabulary');
  $form['vid'] = array('#type' => 'value', '#value' => $vid);
  $form['name'] = array('#type' => 'value', '#value' => $vocabulary->name);
  return confirm_form('taxonomy_vocabulary_confirm_delete', $form,
328
329
330
                  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.'),
331
                  t('Delete'),
332
                  t('Cancel'));
Kjartan's avatar
Kjartan committed
333
}
Dries's avatar
 
Dries committed
334

335
336
337
338
339
340
function taxonomy_vocabulary_confirm_delete_submit($form_id, $form_values) {
  $status = taxonomy_del_vocabulary($form_values['vid']);
  drupal_set_message(t('Deleted vocabulary %name.', array('%name' => theme('placeholder', $form_values['name']))));
  return 'admin/taxonomy';
}

Kjartan's avatar
Kjartan committed
341
function taxonomy_form_term($edit = array()) {
Dries's avatar
   
Dries committed
342
  $vocabulary_id = isset($edit['vid']) ? $edit['vid'] : arg(4);
Kjartan's avatar
Kjartan committed
343
  $vocabulary = taxonomy_get_vocabulary($vocabulary_id);
Dries's avatar
   
Dries committed
344

345
  $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);
346

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

Kjartan's avatar
Kjartan committed
349
  if ($vocabulary->hierarchy) {
Dries's avatar
   
Dries committed
350
351
    $parent = array_keys(taxonomy_get_parents($edit['tid']));
    $children = taxonomy_get_tree($vocabulary_id, $edit['tid']);
Dries's avatar
   
Dries committed
352

Dries's avatar
   
Dries committed
353
    // A term can't be the child of itself, nor of its children.
Dries's avatar
   
Dries committed
354
355
356
    foreach ($children as $child) {
      $exclude[] = $child->tid;
    }
Dries's avatar
   
Dries committed
357
    $exclude[] = $edit['tid'];
Dries's avatar
   
Dries committed
358

Kjartan's avatar
Kjartan committed
359
    if ($vocabulary->hierarchy == 1) {
360
      $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
361
    }
Kjartan's avatar
Kjartan committed
362
    elseif ($vocabulary->hierarchy == 2) {
363
      $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
364
    }
Kjartan's avatar
Kjartan committed
365
  }
Dries's avatar
 
Dries committed
366

367
  if ($vocabulary->relations) {
368
    $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']));
369
370
  }

371
372
  $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.'));
373
374
375
376
377

  // Add extra term form elements.
  $extra = module_invoke_all('taxonomy', 'term', 'vocabulary');
  if (is_array($extra)) {
    foreach ($extra as $key => $element) {
378
      $extra[$key]['#weight'] = isset($extra[$key]['#weight']) ? $extra[$key]['#weight'] : -18;
379
380
381
382
383
    }
    $form = array_merge($form, $extra);
  }


384
  $form['vid'] = array('#type' => 'value', '#value' => $vocabulary->vid);
385
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
Kjartan's avatar
Kjartan committed
386

Dries's avatar
   
Dries committed
387
  if ($edit['tid']) {
388
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
389
    $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
Dries's avatar
 
Dries committed
390
  }
391
  else {
392
    $form['destination'] = array('#type' => 'hidden', '#value' => $_GET['q']);
393
  }
Dries's avatar
 
Dries committed
394

395
  return drupal_get_form('taxonomy_form_term', $form);
Kjartan's avatar
Kjartan committed
396
}
Dries's avatar
 
Dries committed
397

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
/**
 * Accept the form submission for a taxonomy term and save the result.
 */
function taxonomy_form_term_submit($form_id, $form_values) {
  switch (taxonomy_save_term($form_values)) {
    case SAVED_NEW:
      drupal_set_message(t('Created new term %term.', array('%term' => theme('placeholder', $form_values['name']))));
      break;
    case SAVED_UPDATED:
      drupal_set_message(t('The term %term has been updated.', array('%term' => theme('placeholder', $form_values['name']))));
      break;
  }
  return 'admin/taxonomy';
}

413
function taxonomy_save_term(&$edit) {
Dries's avatar
   
Dries committed
414
  if ($edit['tid'] && $edit['name']) {
415
    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
416
    module_invoke_all('taxonomy', 'update', 'term', $edit);
417
    $status = SAVED_UPDATED;
Kjartan's avatar
Kjartan committed
418
  }
Dries's avatar
   
Dries committed
419
420
  else if ($edit['tid']) {
    return taxonomy_del_term($edit['tid']);
Kjartan's avatar
Kjartan committed
421
422
  }
  else {
Dries's avatar
   
Dries committed
423
    $edit['tid'] = db_next_id('{term_data}_tid');
424
    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
425
    module_invoke_all('taxonomy', 'insert', 'term', $edit);
426
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
427
  }
Dries's avatar
 
Dries committed
428

Dries's avatar
   
Dries committed
429
430
431
  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
432
      if ($related_id != 0) {
Dries's avatar
   
Dries committed
433
        db_query('INSERT INTO {term_relation} (tid1, tid2) VALUES (%d, %d)', $edit['tid'], $related_id);
Dries's avatar
 
Dries committed
434
      }
Kjartan's avatar
Kjartan committed
435
    }
Kjartan's avatar
Kjartan committed
436
  }
Dries's avatar
 
Dries committed
437

Dries's avatar
   
Dries committed
438
  db_query('DELETE FROM {term_hierarchy} WHERE tid = %d', $edit['tid']);
439
  if (!isset($edit['parent']) || empty($edit['parent'])) {
440
    $edit['parent'] = array(0);
Kjartan's avatar
Kjartan committed
441
  }
Dries's avatar
   
Dries committed
442
443
  if (is_array($edit['parent'])) {
    foreach ($edit['parent'] as $parent) {
444
445
446
447
448
449
450
451
      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
452
    }
Kjartan's avatar
Kjartan committed
453
  }
454
455
456
  else {
    db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $edit['tid'], $edit['parent']);
  }
Dries's avatar
 
Dries committed
457

Dries's avatar
   
Dries committed
458
459
460
  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
461
      if ($synonym) {
Dries's avatar
   
Dries committed
462
        db_query("INSERT INTO {term_synonym} (tid, name) VALUES (%d, '%s')", $edit['tid'], chop($synonym));
Dries's avatar
   
Dries committed
463
      }
Kjartan's avatar
Kjartan committed
464
    }
Dries's avatar
 
Dries committed
465
  }
Dries's avatar
   
Dries committed
466

Dries's avatar
   
Dries committed
467
468
  cache_clear_all();

469
  return $status;
Kjartan's avatar
Kjartan committed
470
}
Dries's avatar
 
Dries committed
471

Kjartan's avatar
Kjartan committed
472
function taxonomy_del_term($tid) {
473
474
475
476
477
478
479
480
481
482
483
484
485
486
  $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
487

488
      $term = (array) taxonomy_get_term($tid);
Dries's avatar
   
Dries committed
489

490
491
492
493
494
      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
495

496
      module_invoke_all('taxonomy', 'delete', 'term', $term);
497
      return SAVED_DELETED;
498
    }
Dries's avatar
   
Dries committed
499

500
501
    $tids = $orphans;
  }
Dries's avatar
   
Dries committed
502

Dries's avatar
   
Dries committed
503
  cache_clear_all();
Dries's avatar
   
Dries committed
504
505
506
507
508
}

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

509
510
511
512
  $form['type'] = array('#type' => 'value', '#value' => 'term');
  $form['name'] = array('#type' => 'value', '#value' => $term->name);
  $form['tid'] = array('#type' => 'value', '#value' => $tid);
  return confirm_form('taxonomy_term_confirm_delete', $form,
513
514
                  t('Are you sure you want to delete the term %title?',
                  array('%title' => theme('placeholder', $term->name))),
515
516
517
                  'admin/taxonomy',
                  t('Deleting a term will delete all its children if there are any. This action cannot be undone.'),
                  t('Delete'),
518
                  t('Cancel'));
Kjartan's avatar
Kjartan committed
519
}
Dries's avatar
 
Dries committed
520

521
522
523
524
function taxonomy_term_confirm_delete_submit($form_id, $form_values) {
  taxonomy_del_term($form_values['tid']);
  drupal_set_message(t('Deleted term %name.', array('%name' => theme('placeholder', $form_values['name']))));
  return 'admin/taxonomy';
Kjartan's avatar
Kjartan committed
525
526
}

Dries's avatar
   
Dries committed
527
528
529
/**
 * Generate a form element for selecting terms from a vocabulary.
 */
Dries's avatar
   
Dries committed
530
function taxonomy_form($vid, $value = 0, $help = NULL, $name = 'taxonomy') {
Dries's avatar
   
Dries committed
531
  $vocabulary = taxonomy_get_vocabulary($vid);
532
  $help = ($help) ? $help : $vocabulary->help;
Kjartan's avatar
Kjartan committed
533
534
535
536
  if ($vocabulary->required) {
    $blank = 0;
  }
  else {
Dries's avatar
   
Dries committed
537
    $blank = '<'. t('none') .'>';
Kjartan's avatar
Kjartan committed
538
  }
Dries's avatar
   
Dries committed
539

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

Dries's avatar
Dries committed
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
/**
 * 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
563
564
565
566
567
568
/**
 * 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
569
function taxonomy_get_vocabularies($type = NULL) {
Kjartan's avatar
Kjartan committed
570
  if ($type) {
571
    $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
572
573
  }
  else {
574
    $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
575
  }
Dries's avatar
   
Dries committed
576

Kjartan's avatar
Kjartan committed
577
  $vocabularies = array();
Dries's avatar
   
Dries committed
578
  $node_types = array();
Kjartan's avatar
Kjartan committed
579
  while ($voc = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
580
581
582
583
    $node_types[$voc->vid][] = $voc->type;
    unset($voc->type);
    $voc->nodes = $node_types[$voc->vid];
    $vocabularies[$voc->vid] = $voc;
Dries's avatar
 
Dries committed
584
  }
Dries's avatar
   
Dries committed
585

Kjartan's avatar
Kjartan committed
586
587
  return $vocabularies;
}
Dries's avatar
 
Dries committed
588

Dries's avatar
   
Dries committed
589
590
591
/**
 * Generate a form for selecting terms to associate with a node.
 */
592
593
594
595
function taxonomy_form_alter($form_id, &$form) {
  if (isset($form['type']) && $form['type']['#value'] .'_node_form' == $form_id) {
    $node = $form['#node'];

596
    if (!isset($node->taxonomy)) {
597
598
599
600
601
602
      if ($node->nid) {
        $terms = taxonomy_node_get_terms($node->nid);
      }
      else {
        $terms = array();
      }
Kjartan's avatar
Kjartan committed
603
604
    }
    else {
605
      $terms = $node->taxonomy;
Dries's avatar
 
Dries committed
606
607
    }

608
    $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
609

610
611
612
613
614
    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
615

616
617
618
619
620
621
622
            // 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
623
        }
624
        $typed_string = implode(', ', $typed_terms) . (array_key_exists('tags', $terms) ? $terms['tags'][$vocabulary->vid] : NULL);
625

626
627
628
629
630
631
        if ($vocabulary->help) {
          $help = $vocabulary->help;
        }
        else {
          $help = t('A comma-separated list of terms describing this content.  Example: funny, bungie jumping, "Company, Inc.".');
        }
632
633
634
635
636
637
638
639
640
        $form['taxonomy']['tags'][$vocabulary->vid] = array('#type' => 'textfield',
          '#title' => $vocabulary->name,
          '#description' => $help,
          '#required' => $vocabulary->required,
          '#default_value' => $typed_string,
          '#autocomplete_path' => 'taxonomy/autocomplete/'. $vocabulary->vid,
          '#weight' => $vocabulary->weight,
          '#maxlength' => 100,
        );
641
642
      }
      else {
643
        $form['taxonomy'][$vocabulary->vid] = taxonomy_form($vocabulary->vid, array_keys($terms), $vocabulary->help);
644
        $form['taxonomy'][$vocabulary->vid]['#weight'] = $vocabulary->weight;
645
        $form['taxonomy'][$vocabulary->vid]['#required'] = $vocabulary->required;
646
      }
Dries's avatar
Dries committed
647
    }
648
    if (isset($form['taxonomy'])) {
649
      $form['taxonomy'] += array('#type' => 'fieldset', '#title' => t('Categories'), '#collapsible' => TRUE, '#collapsed' => FALSE, '#tree' => TRUE, '#weight' => -3);
Dries's avatar
Dries committed
650
    }
Dries's avatar
 
Dries committed
651
  }
Kjartan's avatar
Kjartan committed
652
}
Dries's avatar
 
Dries committed
653

Dries's avatar
   
Dries committed
654
655
656
657
/**
 * Find all terms associated to the given node, within one vocabulary.
 */
function taxonomy_node_get_terms_by_vocabulary($nid, $vid, $key = 'tid') {
658
  $result = db_query(db_rewrite_sql('SELECT t.tid, t.* FROM {term_data} t INNER JOIN {term_node} r ON r.tid = t.tid WHERE t.vid = %d AND r.nid = %d ORDER BY weight', 't', 'tid'), $vid, $nid);
Kjartan's avatar
Kjartan committed
659
660
661
  $terms = array();
  while ($term = db_fetch_object($result)) {
    $terms[$term->$key] = $term;
Dries's avatar
 
Dries committed
662
  }
Kjartan's avatar
Kjartan committed
663
664
665
  return $terms;
}

Dries's avatar
   
Dries committed
666
/**
667
 * Find all terms associated to the given node, ordered by vocabulary and term weight.
Dries's avatar
   
Dries committed
668
669
 */
function taxonomy_node_get_terms($nid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
670
  static $terms;
Dries's avatar
 
Dries committed
671

Dries's avatar
   
Dries committed
672
  if (!isset($terms[$nid])) {
673
    $result = db_query(db_rewrite_sql('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', 't', 'tid'), $nid);
Kjartan's avatar
Kjartan committed
674
    $terms[$nid] = array();
Dries's avatar
 
Dries committed
675
    while ($term = db_fetch_object($result)) {
Kjartan's avatar
Kjartan committed
676
      $terms[$nid][$term->$key] = $term;
Dries's avatar
 
Dries committed
677
678
    }
  }
Kjartan's avatar
Kjartan committed
679
680
  return $terms[$nid];
}
Dries's avatar
 
Dries committed
681

Dries's avatar
Dries committed
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
/**
 * 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
699
700
701
/**
 * Save term associations for a given node.
 */
Kjartan's avatar
Kjartan committed
702
function taxonomy_node_save($nid, $terms) {
703
  taxonomy_node_delete($nid);
Dries's avatar
Dries committed
704
705
706

  // Free tagging vocabularies do not send their tids in the form,
  // so we'll detect them here and process them independently.
707
  if (isset($terms['tags'])) {
Dries's avatar
Dries committed
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
    $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) {
737
738
739
          $edit = array('vid' => $vid, 'name' => $typed_term);
          $status = taxonomy_save_term($edit);
          $typed_term_tid = $edit['tid'];
Dries's avatar
Dries committed
740
741
742
743
744
745
        }

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

747
  if (is_array($terms)) {
Dries's avatar
   
Dries committed
748
    foreach ($terms as $term) {
749
750
751
752
753
754
755
      if (is_array($term)) {
        foreach ($term as $tid) {
          if ($tid) {
            db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $tid);
          }
        }
      }
756
      else if ($term) {
Dries's avatar
   
Dries committed
757
        db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $term);
758
      }
Dries's avatar
 
Dries committed
759
760
    }
  }
Kjartan's avatar
Kjartan committed
761
}
Dries's avatar
 
Dries committed
762

Dries's avatar
   
Dries committed
763
764
765
/**
 * Remove associations of a node to its terms.
 */
Kjartan's avatar
Kjartan committed
766
function taxonomy_node_delete($nid) {
Dries's avatar
   
Dries committed
767
  db_query('DELETE FROM {term_node} WHERE nid = %d', $nid);
Kjartan's avatar
Kjartan committed
768
}
Dries's avatar
 
Dries committed
769

Dries's avatar
   
Dries committed
770
771
772
773
/**
 * Find all term objects related to a given term ID.
 */
function taxonomy_get_related($tid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
774
  if ($tid) {
Dries's avatar
   
Dries committed
775
    $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
776
777
778
    $related = array();
    while ($term = db_fetch_object($result)) {
      $related[$term->$key] = $term;
Dries's avatar
 
Dries committed
779
    }
Kjartan's avatar
Kjartan committed
780
    return $related;
Dries's avatar
 
Dries committed
781
  }
Kjartan's avatar
Kjartan committed
782
783
  else {
    return array();
Dries's avatar
 
Dries committed
784
  }
Kjartan's avatar
Kjartan committed
785
}
Dries's avatar
 
Dries committed
786

Dries's avatar
   
Dries committed
787
788
789
790
/**
 * Find all parents of a given term ID.
 */
function taxonomy_get_parents($tid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
791
  if ($tid) {
792
    $result = db_query(db_rewrite_sql('SELECT t.tid, t.* FROM {term_data} t INNER JOIN {term_hierarchy} h ON h.parent = t.tid WHERE h.tid = %d ORDER BY weight, name', 't', 'tid'), $tid);
Kjartan's avatar
Kjartan committed
793
794
795
    $parents = array();
    while ($parent = db_fetch_object($result)) {
      $parents[$parent->$key] = $parent;
Dries's avatar
   
Dries committed
796
    }
Kjartan's avatar
Kjartan committed
797
    return $parents;
Dries's avatar
 
Dries committed
798
  }
Kjartan's avatar
Kjartan committed
799
800
801
802
  else {
    return array();
  }
}
Dries's avatar
 
Dries committed
803

Dries's avatar
   
Dries committed
804
805
806
807
/**
 * Find all ancestors of a given term ID.
 */
function taxonomy_get_parents_all($tid) {
Dries's avatar
   
Dries committed
808
809
810
811
812
813
814
815
816
817
818
819
  $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
820
821
822
823
/**
 * Find all children of a term ID.
 */
function taxonomy_get_children($tid, $vid = 0, $key = 'tid') {
Kjartan's avatar
Kjartan committed
824
  if ($vid) {
825
    $result = db_query(db_rewrite_sql('SELECT t.* FROM {term_data} t INNER JOIN {term_hierarchy} h ON h.tid = t.tid WHERE t.vid = %d AND h.parent = %d ORDER BY weight, name', 't', 'tid'), $vid, $tid);
Dries's avatar
 
Dries committed
826
  }
Kjartan's avatar
Kjartan committed
827
  else {
828
    $result = db_query(db_rewrite_sql('SELECT t.* FROM {term_data} t INNER JOIN {term_hierarchy} h ON h.tid = t.tid WHERE parent = %d ORDER BY weight, name', 't', 'tid'), $tid);
Kjartan's avatar
Kjartan committed
829
830
831
832
833
834
835
  }
  $children = array();
  while ($term = db_fetch_object($result)) {
    $children[$term->$key] = $term;
  }
  return $children;
}
Dries's avatar
 
Dries committed
836

Dries's avatar
   
Dries committed
837
838
839
840
841
842
843
844
845
846
847
848
849
/**
 * 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
850
851
852
 * @param $max_depth
 *   The number of levels of the tree to return. Leave NULL to return all levels.
 *
Dries's avatar
   
Dries committed
853
854
855
856
857
 * @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
858
  static $children, $parents, $terms;
Dries's avatar
   
Dries committed
859

Kjartan's avatar
Kjartan committed
860
  $depth++;
Dries's avatar
   
Dries committed
861

Dries's avatar
   
Dries committed
862
863
864
865
  // 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
866

867
    $result = db_query(db_rewrite_sql('SELECT t.tid, t.*, parent FROM {term_data} t INNER JOIN  {term_hierarchy} h ON t.tid = h.tid WHERE t.vid = %d ORDER BY weight, name', 't', 'tid'), $vid);
Dries's avatar
   
Dries committed
868
    while ($term = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
869
870
871
      $children[$vid][$term->parent][] = $term->tid;
      $parents[$vid][$term->tid][] = $term->parent;
      $terms[$vid][$term->tid] = $term;
Dries's avatar
 
Dries committed
872
873
    }
  }
Dries's avatar
   
Dries committed
874

Dries's avatar
   
Dries committed
875
  $max_depth = (is_null($max_depth)) ? count($children[$vid]) : $max_depth;
Dries's avatar
Dries committed
876
877
878
879
880
881
882
883
884
885
886
887
  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
888
      }
Dries's avatar
   
Dries committed
889
    }
Kjartan's avatar
Kjartan committed
890
  }
Dries's avatar
   
Dries committed
891

Dries's avatar
   
Dries committed
892
  return $tree ? $tree : array();
Kjartan's avatar
Kjartan committed
893
}
Dries's avatar
 
Dries committed
894

Dries's avatar
   
Dries committed
895
896
897
/**
 * Return an array of synonyms of the given term ID.
 */
Kjartan's avatar
Kjartan committed
898
899
function taxonomy_get_synonyms($tid) {
  if ($tid) {
Dries's avatar
   
Dries committed
900
    $result = db_query('SELECT name FROM {term_synonym} WHERE tid = %d', $tid);
Kjartan's avatar
Kjartan committed
901
    while ($synonym = db_fetch_array($result)) {
Dries's avatar
   
Dries committed
902
      $synonyms[] = $synonym['name'];
Dries's avatar
 
Dries committed
903
    }
Kjartan's avatar
Kjartan committed
904
    return $synonyms ? $synonyms : array();
Dries's avatar
 
Dries committed
905
  }
Kjartan's avatar
Kjartan committed
906
907
  else {
    return array();
Dries's avatar
   
Dries committed
908
  }
Kjartan's avatar
Kjartan committed
909
}
Dries's avatar
   
Dries committed
910

Dries's avatar
   
Dries committed
911
912
913
914
915
/**
 * 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
916
}
Dries's avatar
   
Dries committed
917

Dries's avatar
   
Dries committed
918
919
920
/**
 * Given a term id, count the number of published nodes in it.
 */
Dries's avatar
   
Dries committed
921
function taxonomy_term_count_nodes($tid, $type = 0) {
Kjartan's avatar
Kjartan committed
922
  static $count;
Dries's avatar
   
Dries committed
923

Dries's avatar
   
Dries committed
924
925
926
  if (!isset($count[$type])) {
    // $type == 0 always evaluates true is $type is a string
    if (is_numeric($type)) {
927
      $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
928
929
    }
    else {
930
      $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 AND n.type = '%s' GROUP BY t.tid"), $type);
Dries's avatar
   
Dries committed
931
    }
Kjartan's avatar
Kjartan committed
932
    while ($term = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
933
      $count[$type][$term->tid] = $term->c;
Dries's avatar
   
Dries committed
934
935
936
    }
  }

Kjartan's avatar
Kjartan committed
937
  foreach (_taxonomy_term_children($tid) as $c) {
Dries's avatar
   
Dries committed
938
    $children_count += taxonomy_term_count_nodes($c, $type);
Kjartan's avatar
Kjartan committed
939
  }
Dries's avatar
   
Dries committed
940
  return $count[$type][$tid] + $children_count;
Kjartan's avatar
Kjartan committed
941
942
}

Dries's avatar
   
Dries committed
943
944
945
/**
 * Helper for taxonomy_term_count_nodes().
 */
Kjartan's avatar
Kjartan committed
946
947
function _taxonomy_term_children($tid) {
  static $children;
Dries's avatar
   
Dries committed
948

Dries's avatar
   
Dries committed
949
  if (!isset($children)) {
Dries's avatar
   
Dries committed
950
    $result = db_query('SELECT tid, parent FROM {term_hierarchy}');
Kjartan's avatar
Kjartan committed
951
952
    while ($term = db_fetch_object($result)) {
      $children[$term->parent][] = $term->tid;
Dries's avatar
   
Dries committed
953
    }
Dries's avatar
 
Dries committed
954
  }
Kjartan's avatar
Kjartan committed
955
956
  return $children[$tid] ? $children[$tid] : array();
}
Dries's avatar
 
Dries committed
957

Dries's avatar
   
Dries committed
958
/**
Dries's avatar
   
Dries committed
959
 * Try to map a string to an existing term, as for glossary use.
Dries's avatar
   
Dries committed
960
 *
Dries's avatar
   
Dries committed
961
962
963
964
965
966
967
968
 * 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
969
970
 */
function taxonomy_get_term_by_name($name) {
971
  $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
972
973
974
975
976
977
978
979
  $result = array();
  while ($term = db_fetch_object($db_result)) {
    $result[] = $term;
  }

  return $result;
}

Dries's avatar
   
Dries committed
980
981
982
/**
 * Return the vocabulary object matching a vocabulary ID.
 */
Kjartan's avatar
Kjartan committed
983
function taxonomy_get_vocabulary($vid) {
984
985
986
987
988
989
990
991
992
993
994
  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
995
996
  }

997
  return $vocabularies[$vid];
Kjartan's avatar
Kjartan committed
998
}
Dries's avatar
 
Dries committed
999

Dries's avatar
   
Dries committed
1000
/**