taxonomy.module 52 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
/**
 * 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:
 *
23
 * if (module_exists('taxonomy')) {
24 25
 *   $terms = taxonomy_link('taxonomy terms', $node);
 *   print theme('links', $terms);
Dries's avatar
 
Dries committed
26 27
 * }
 */
Dries's avatar
 
Dries committed
28
function taxonomy_link($type, $node = NULL) {
Dries's avatar
 
Dries committed
29
  if ($type == 'taxonomy terms' && $node != NULL) {
Kjartan's avatar
 
Kjartan committed
30
    $links = array();
Dries's avatar
 
Dries committed
31
    if (array_key_exists('taxonomy', $node)) {
32
      foreach ($node->taxonomy as $term) {
33
        $links['taxonomy_term_'. $term->tid] = array(
34 35 36
          'title' => $term->name,
          'href' => taxonomy_term_path($term),
          'attributes' => array('rel' => 'tag', 'title' => strip_tags($term->description))
37
        );
Dries's avatar
 
Dries committed
38
      }
Dries's avatar
 
Dries committed
39
    }
Kjartan's avatar
Kjartan committed
40

41
    // We call this hook again because some modules and themes call taxonomy_link('taxonomy terms') directly
42
    foreach (module_implements('link_alter') as $module) {
43 44 45 46 47
      $function = $module .'_link_alter';
      $function($node, $links);
    }

    return $links;
48 49 50
  }
}

51 52 53 54 55 56 57 58 59 60
/**
 * For vocabularies not maintained by taxonomy.module, give the maintaining
 * module a chance to provide a path for terms in that vocabulary.
 *
 * @param $term
 *   A term object.
 * @return
 *   An internal Drupal path.
 */

61 62 63 64 65 66 67 68
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
69 70 71
/**
 * Implementation of hook_menu().
 */
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
function taxonomy_menu() {
  $items['admin/content/taxonomy'] = array(
    'title' => t('Categories'),
    'description' => t('Create vocabularies and terms to categorize your content.'),
    'page callback' => 'taxonomy_overview_vocabularies',
    'access arguments' => array('administer taxonomy'),
  );

  $items['admin/content/taxonomy/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );

  $items['admin/content/taxonomy/add/vocabulary'] = array(
    'title' => t('Add vocabulary'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('taxonomy_form_vocabulary'),
    'type' => MENU_LOCAL_TASK,
91
    'parent' => 'admin/content/taxonomy',
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
  );

  $items['admin/content/taxonomy/edit/vocabulary/%'] = array(
    'title' => t('Edit vocabulary'),
    'page callback' => 'taxonomy_admin_vocabulary_edit',
    'page arguments' => array(5),
    'type' => MENU_CALLBACK,
  );

  $items['admin/content/taxonomy/edit/term'] = array(
    'title' => t('Edit term'),
    'page callback' => 'taxonomy_admin_term_edit',
    'type' => MENU_CALLBACK,
  );

  $items['taxonomy/term'] = array(
    'title' => t('Taxonomy term'),
    'page callback' => 'taxonomy_term_page',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );

  $items['taxonomy/autocomplete'] = array(
    'title' => t('Autocomplete taxonomy'),
    'page callback' => 'taxonomy_autocomplete',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/content/taxonomy/%'] = array(
    'title' => t('List terms'),
    'page callback' => 'taxonomy_overview_terms',
    'page arguments' => array(3),
    'access arguments' => array('administer taxonomy'),
    'map arguments' => array('taxonomy_get_vocabulary', 3),
    'type' => MENU_CALLBACK,
  );

  $items['admin/content/taxonomy/%/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );

  $items['admin/content/taxonomy/%/add/term'] = array(
    'title' => t('Add term'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('taxonomy_form_term', 3),
    'type' => MENU_LOCAL_TASK,
140
    'parent' => 'admin/content/taxonomy/%',
141
  );
Dries's avatar
 
Dries committed
142

Dries's avatar
 
Dries committed
143 144
  return $items;
}
Dries's avatar
 
Dries committed
145

146 147 148 149
/**
 * List and manage vocabularies.
 */
function taxonomy_overview_vocabularies() {
150
  $vocabularies = taxonomy_get_vocabularies();
151
  $rows = array();
152 153 154
  foreach ($vocabularies as $vocabulary) {
    $types = array();
    foreach ($vocabulary->nodes as $type) {
155
      $node_type = node_get_types('name', $type);
156 157
      $types[] = $node_type ? $node_type : $type;
    }
158 159
    $rows[] = array('name' => check_plain($vocabulary->name),
      'type' => implode(', ', $types),
160 161 162
      'edit' => l(t('edit vocabulary'), "admin/content/taxonomy/edit/vocabulary/$vocabulary->vid"),
      'list' => l(t('list terms'), "admin/content/taxonomy/$vocabulary->vid"),
      'add' => l(t('add terms'), "admin/content/taxonomy/$vocabulary->vid/add/term")
163 164 165
    );
  }
  if (empty($rows)) {
Steven Wittens's avatar
Steven Wittens committed
166
    $rows[] = array(array('data' => t('No categories available.'), 'colspan' => '5'));
167
  }
drumm's avatar
drumm committed
168
  $header = array(t('Name'), t('Type'), array('data' => t('Operations'), 'colspan' => '3'));
169

170
  return theme('table', $header, $rows, array('id' => 'taxonomy'));
171 172 173 174 175 176
}

/**
 * Display a tree of all the terms in a vocabulary, with options to edit
 * each one.
 */
177
function taxonomy_overview_terms($vocabulary) {
178 179 180 181 182 183 184 185 186 187 188 189 190
  $destination = drupal_get_destination();

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

  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
191 192 193
    if (($start_from && ($start_from * $page_increment) >= $total_entries) || ($displayed_count == $page_increment)) {
      continue;
    }
194
    $rows[] = array(str_repeat('--', $term->depth) .' '. l($term->name, "taxonomy/term/$term->tid"), l(t('edit'), "admin/content/taxonomy/edit/term/$term->tid", array(), $destination));
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    $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
215
function taxonomy_form_vocabulary($edit = array()) {
216 217 218
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Vocabulary name'),
    '#default_value' => $edit['name'],
219
    '#maxlength' => 255,
220
    '#description' => t('The name for this vocabulary. Example: "Topic".'),
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    '#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'],
    '#description' => t('Instructions to present to the user when choosing a term.'),
  );
  $form['nodes'] = array('#type' => 'checkboxes',
    '#title' => t('Types'),
    '#default_value' => $edit['nodes'],
236
    '#options' => node_get_types('names'),
237 238 239 240 241 242 243
    '#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')),
244
    '#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'))),
245 246 247 248
  );
  $form['relations'] = array('#type' => 'checkbox',
    '#title' => t('Related terms'),
    '#default_value' => $edit['relations'],
249
    '#description' => t('Allows <a href="@help-url">related terms</a> in this vocabulary.', array('@help-url' => url('admin/help/taxonomy', NULL, NULL, 'related-terms'))),
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
  );
  $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.'),
  );
271

272
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
Dries's avatar
 
Dries committed
273
  if ($edit['vid']) {
274
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
275
    $form['vid'] = array('#type' => 'value', '#value' => $edit['vid']);
276
    $form['module'] = array('#type' => 'value', '#value' => $edit['module']);
Dries's avatar
 
Dries committed
277
  }
278
  return $form;
Kjartan's avatar
Kjartan committed
279
}
Kjartan's avatar
Kjartan committed
280

281 282 283 284 285 286 287
/**
 * 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)) {
288 289 290 291 292 293
    case SAVED_NEW:
      drupal_set_message(t('Created new vocabulary %name.', array('%name' => $form_values['name'])));
      break;
    case SAVED_UPDATED:
      drupal_set_message(t('Updated vocabulary %name.', array('%name' => $form_values['name'])));
      break;
294
  }
295
  return 'admin/content/taxonomy';
296 297
}

298
function taxonomy_save_vocabulary(&$edit) {
299
  $edit['nodes'] = empty($edit['nodes']) ? array() : $edit['nodes'];
Dries's avatar
 
Dries committed
300

301
  if (!empty($edit['vid']) && !empty($edit['name'])) {
302
    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
303
    db_query("DELETE FROM {vocabulary_node_types} WHERE vid = %d", $edit['vid']);
304
    foreach ($edit['nodes'] as $type => $selected) {
Dries's avatar
 
Dries committed
305 306
      db_query("INSERT INTO {vocabulary_node_types} (vid, type) VALUES (%d, '%s')", $edit['vid'], $type);
    }
Dries's avatar
 
Dries committed
307
    module_invoke_all('taxonomy', 'update', 'vocabulary', $edit);
308
    $status = SAVED_UPDATED;
Dries's avatar
 
Dries committed
309
  }
310
  else if (!empty($edit['vid'])) {
311
    $status = taxonomy_del_vocabulary($edit['vid']);
Kjartan's avatar
Kjartan committed
312 313
  }
  else {
314
    $edit['vid'] = db_next_id('{vocabulary}_vid');
315
    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'], isset($edit['description']) ? $edit['description'] : NULL, isset($edit['help']) ? $edit['help'] : NULL, $edit['multiple'], $edit['required'], $edit['hierarchy'], $edit['relations'], isset($edit['tags']) ? $edit['tags'] : NULL, $edit['weight'], isset($edit['module']) ? $edit['module'] : 'taxonomy');
316
    foreach ($edit['nodes'] as $type => $selected) {
Dries's avatar
 
Dries committed
317 318
      db_query("INSERT INTO {vocabulary_node_types} (vid, type) VALUES (%d, '%s')", $edit['vid'], $type);
    }
Dries's avatar
 
Dries committed
319
    module_invoke_all('taxonomy', 'insert', 'vocabulary', $edit);
320
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
321
  }
Dries's avatar
 
Dries committed
322 323

  cache_clear_all();
Dries's avatar
 
Dries committed
324

325
  return $status;
Kjartan's avatar
Kjartan committed
326
}
Dries's avatar
 
Dries committed
327

328 329 330 331 332 333 334 335
/**
 * Delete a vocabulary.
 *
 * @param $vid
 *   A vocabulary ID.
 * @return
 *   Constant indicating items were deleted.
 */
Kjartan's avatar
Kjartan committed
336
function taxonomy_del_vocabulary($vid) {
337
  $vocabulary = (array) taxonomy_get_vocabulary($vid);
Dries's avatar
 
Dries committed
338

Dries's avatar
 
Dries committed
339
  db_query('DELETE FROM {vocabulary} WHERE vid = %d', $vid);
Dries's avatar
 
Dries committed
340
  db_query('DELETE FROM {vocabulary_node_types} WHERE vid = %d', $vid);
Dries's avatar
 
Dries committed
341
  $result = db_query('SELECT tid FROM {term_data} WHERE vid = %d', $vid);
Kjartan's avatar
Kjartan committed
342 343
  while ($term = db_fetch_object($result)) {
    taxonomy_del_term($term->tid);
Dries's avatar
 
Dries committed
344
  }
Dries's avatar
 
Dries committed
345

Dries's avatar
 
Dries committed
346
  module_invoke_all('taxonomy', 'delete', 'vocabulary', $vocabulary);
Dries's avatar
 
Dries committed
347

Dries's avatar
 
Dries committed
348 349
  cache_clear_all();

350
  return SAVED_DELETED;
Dries's avatar
 
Dries committed
351 352
}

353
function taxonomy_vocabulary_confirm_delete($vid) {
Dries's avatar
 
Dries committed
354 355
  $vocabulary = taxonomy_get_vocabulary($vid);

356 357 358
  $form['type'] = array('#type' => 'value', '#value' => 'vocabulary');
  $form['vid'] = array('#type' => 'value', '#value' => $vid);
  $form['name'] = array('#type' => 'value', '#value' => $vocabulary->name);
359
  return confirm_form($form,
360
                  t('Are you sure you want to delete the vocabulary %title?',
361
                  array('%title' => $vocabulary->name)),
362 363
                  'admin/content/taxonomy',
                  t('Deleting a vocabulary will delete all the terms in it. This action cannot be undone.'),
364
                  t('Delete'),
365
                  t('Cancel'));
Kjartan's avatar
Kjartan committed
366
}
Dries's avatar
 
Dries committed
367

368 369
function taxonomy_vocabulary_confirm_delete_submit($form_id, $form_values) {
  $status = taxonomy_del_vocabulary($form_values['vid']);
370
  drupal_set_message(t('Deleted vocabulary %name.', array('%name' => $form_values['name'])));
371
  return 'admin/content/taxonomy';
372 373
}

374
function taxonomy_form_term($vocabulary, $edit = array()) {
375 376 377 378
  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Term name'),
    '#default_value' => $edit['name'],
379
    '#maxlength' => 255,
380 381
    '#description' => t('The name of this term.'),
    '#required' => TRUE);
382

383 384 385 386 387
  $form['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $edit['description'],
    '#description' => t('A description of the term.'));
Dries's avatar
 
Dries committed
388

Kjartan's avatar
Kjartan committed
389
  if ($vocabulary->hierarchy) {
Dries's avatar
 
Dries committed
390
    $parent = array_keys(taxonomy_get_parents($edit['tid']));
391
    $children = taxonomy_get_tree($vocabulary->vid, $edit['tid']);
Dries's avatar
 
Dries committed
392

Dries's avatar
 
Dries committed
393
    // A term can't be the child of itself, nor of its children.
Dries's avatar
 
Dries committed
394 395 396
    foreach ($children as $child) {
      $exclude[] = $child->tid;
    }
Dries's avatar
 
Dries committed
397
    $exclude[] = $edit['tid'];
Dries's avatar
 
Dries committed
398

Kjartan's avatar
Kjartan committed
399
    if ($vocabulary->hierarchy == 1) {
400
      $form['parent'] = _taxonomy_term_select(t('Parent'), 'parent', $parent, $vocabulary->vid, l(t('Parent term'), 'admin/help/taxonomy', NULL, NULL, 'parent') .'.', 0, '<'. t('root') .'>', $exclude);
Dries's avatar
 
Dries committed
401
    }
Kjartan's avatar
Kjartan committed
402
    elseif ($vocabulary->hierarchy == 2) {
403
      $form['parent'] = _taxonomy_term_select(t('Parents'), 'parent', $parent, $vocabulary->vid, l(t('Parent terms'), 'admin/help/taxonomy', NULL, NULL, 'parent') .'.', 1, '<'. t('root') .'>', $exclude);
Dries's avatar
 
Dries committed
404
    }
Kjartan's avatar
Kjartan committed
405
  }
Dries's avatar
 
Dries committed
406

407
  if ($vocabulary->relations) {
408
    $form['relations'] = _taxonomy_term_select(t('Related terms'), 'relations', array_keys(taxonomy_get_related($edit['tid'])), $vocabulary->vid, NULL, 1, '<'. t('none') .'>', array($edit['tid']));
409 410
  }

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
  $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.'));
  $form['vid'] = array(
    '#type' => 'value',
    '#value' => $vocabulary->vid);
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'));
Kjartan's avatar
Kjartan committed
427

Dries's avatar
 
Dries committed
428
  if ($edit['tid']) {
429 430 431 432 433 434
    $form['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'));
    $form['tid'] = array(
      '#type' => 'value',
      '#value' => $edit['tid']);
Dries's avatar
 
Dries committed
435
  }
436
  else {
437
    $form['destination'] = array('#type' => 'hidden', '#value' => $_GET['q']);
438
  }
Dries's avatar
 
Dries committed
439

440
  return $form;
Kjartan's avatar
Kjartan committed
441
}
Dries's avatar
 
Dries committed
442

443 444 445 446 447 448
/**
 * 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:
449
      drupal_set_message(t('Created new term %term.', array('%term' => $form_values['name'])));
450 451
      break;
    case SAVED_UPDATED:
452
      drupal_set_message(t('The term %term has been updated.', array('%term' => $form_values['name'])));
453 454
      break;
  }
455
  return 'admin/content/taxonomy';
456 457
}

458 459 460 461 462 463 464 465 466 467
/**
 * Helper function for taxonomy_form_term_submit().
 *
 * @param $form_values
 * @return
 *   Status constant indicating if term was inserted or updated.
 */
function taxonomy_save_term(&$form_values) {
  if ($form_values['tid'] && $form_values['name']) {
    db_query("UPDATE {term_data} SET name = '%s', description = '%s', weight = %d WHERE tid = %d", $form_values['name'], $form_values['description'], $form_values['weight'], $form_values['tid']);
468
    $hook = 'update';
469
    $status = SAVED_UPDATED;
Kjartan's avatar
Kjartan committed
470
  }
471 472
  else if ($form_values['tid']) {
    return taxonomy_del_term($form_values['tid']);
Kjartan's avatar
Kjartan committed
473 474
  }
  else {
475 476
    $form_values['tid'] = db_next_id('{term_data}_tid');
    db_query("INSERT INTO {term_data} (tid, name, description, vid, weight) VALUES (%d, '%s', '%s', %d, %d)", $form_values['tid'], $form_values['name'], $form_values['description'], $form_values['vid'], $form_values['weight']);
477
    $hook = 'insert';
478
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
479
  }
Dries's avatar
 
Dries committed
480

481 482 483
  db_query('DELETE FROM {term_relation} WHERE tid1 = %d OR tid2 = %d', $form_values['tid'], $form_values['tid']);
  if ($form_values['relations']) {
    foreach ($form_values['relations'] as $related_id) {
Kjartan's avatar
Kjartan committed
484
      if ($related_id != 0) {
485
        db_query('INSERT INTO {term_relation} (tid1, tid2) VALUES (%d, %d)', $form_values['tid'], $related_id);
Dries's avatar
 
Dries committed
486
      }
Kjartan's avatar
Kjartan committed
487
    }
Kjartan's avatar
Kjartan committed
488
  }
Dries's avatar
 
Dries committed
489

490 491 492
  db_query('DELETE FROM {term_hierarchy} WHERE tid = %d', $form_values['tid']);
  if (!isset($form_values['parent']) || empty($form_values['parent'])) {
    $form_values['parent'] = array(0);
Kjartan's avatar
Kjartan committed
493
  }
494 495
  if (is_array($form_values['parent'])) {
    foreach ($form_values['parent'] as $parent) {
496 497
      if (is_array($parent)) {
        foreach ($parent as $tid) {
498
          db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $form_values['tid'], $tid);
499 500 501
        }
      }
      else {
502
        db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $form_values['tid'], $parent);
503
      }
Dries's avatar
 
Dries committed
504
    }
Kjartan's avatar
Kjartan committed
505
  }
506
  else {
507
    db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $form_values['tid'], $form_values['parent']);
508
  }
Dries's avatar
 
Dries committed
509

510 511 512
  db_query('DELETE FROM {term_synonym} WHERE tid = %d', $form_values['tid']);
  if ($form_values['synonyms']) {
    foreach (explode ("\n", str_replace("\r", '', $form_values['synonyms'])) as $synonym) {
Dries's avatar
 
Dries committed
513
      if ($synonym) {
514
        db_query("INSERT INTO {term_synonym} (tid, name) VALUES (%d, '%s')", $form_values['tid'], chop($synonym));
Dries's avatar
 
Dries committed
515
      }
Kjartan's avatar
Kjartan committed
516
    }
Dries's avatar
 
Dries committed
517
  }
Dries's avatar
 
Dries committed
518

519
  if (isset($hook)) {
520
    module_invoke_all('taxonomy', $hook, 'term', $form_values);
521 522
  }

Dries's avatar
 
Dries committed
523 524
  cache_clear_all();

525
  return $status;
Kjartan's avatar
Kjartan committed
526
}
Dries's avatar
 
Dries committed
527

528 529 530 531 532 533 534 535
/**
 * Delete a term.
 *
 * @param $tid
 *   The term ID.
 * @return
 *   Status constant indicating deletion.
 */
Kjartan's avatar
Kjartan committed
536
function taxonomy_del_term($tid) {
537 538 539 540 541 542 543 544 545 546 547 548 549 550
  $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
551

552
      $term = (array) taxonomy_get_term($tid);
Dries's avatar
 
Dries committed
553

554 555 556 557 558
      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
559

560 561
      module_invoke_all('taxonomy', 'delete', 'term', $term);
    }
Dries's avatar
 
Dries committed
562

563 564
    $tids = $orphans;
  }
Dries's avatar
 
Dries committed
565

Dries's avatar
 
Dries committed
566
  cache_clear_all();
567 568

  return SAVED_DELETED;
Dries's avatar
 
Dries committed
569 570
}

571
function taxonomy_term_confirm_delete($tid) {
Dries's avatar
 
Dries committed
572 573
  $term = taxonomy_get_term($tid);

574 575 576
  $form['type'] = array('#type' => 'value', '#value' => 'term');
  $form['name'] = array('#type' => 'value', '#value' => $term->name);
  $form['tid'] = array('#type' => 'value', '#value' => $tid);
577
  return confirm_form($form,
578
                  t('Are you sure you want to delete the term %title?',
579
                  array('%title' => $term->name)),
580
                  'admin/content/taxonomy',
581 582
                  t('Deleting a term will delete all its children if there are any. This action cannot be undone.'),
                  t('Delete'),
583
                  t('Cancel'));
Kjartan's avatar
Kjartan committed
584
}
Dries's avatar
 
Dries committed
585

586 587
function taxonomy_term_confirm_delete_submit($form_id, $form_values) {
  taxonomy_del_term($form_values['tid']);
588
  drupal_set_message(t('Deleted term %name.', array('%name' => $form_values['name'])));
589
  return 'admin/content/taxonomy';
Kjartan's avatar
Kjartan committed
590 591
}

Dries's avatar
 
Dries committed
592 593 594
/**
 * Generate a form element for selecting terms from a vocabulary.
 */
Dries's avatar
 
Dries committed
595
function taxonomy_form($vid, $value = 0, $help = NULL, $name = 'taxonomy') {
Dries's avatar
 
Dries committed
596
  $vocabulary = taxonomy_get_vocabulary($vid);
597
  $help = ($help) ? $help : $vocabulary->help;
Kjartan's avatar
Kjartan committed
598 599 600 601
  if ($vocabulary->required) {
    $blank = 0;
  }
  else {
Dries's avatar
 
Dries committed
602
    $blank = '<'. t('none') .'>';
Kjartan's avatar
Kjartan committed
603
  }
Dries's avatar
 
Dries committed
604

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

608
/**
609
 * Generate a set of options for selecting a term from all vocabularies.
610 611 612 613 614 615 616
 */
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);
617 618
    if ($tree && (count($tree) > 1)) {
      $options[$vocabulary->name] = array();
619
      foreach ($tree as $term) {
620
        $options[$vocabulary->name][$term->tid] = str_repeat('-', $term->depth) . $term->name;
621 622 623 624 625 626
      }
    }
  }
  return $options;
}

Dries's avatar
 
Dries committed
627 628 629 630 631 632
/**
 * 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
633
function taxonomy_get_vocabularies($type = NULL) {
Kjartan's avatar
Kjartan committed
634
  if ($type) {
635
    $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
636 637
  }
  else {
638
    $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
639
  }
Dries's avatar
 
Dries committed
640

Kjartan's avatar
Kjartan committed
641
  $vocabularies = array();
Dries's avatar
 
Dries committed
642
  $node_types = array();
Kjartan's avatar
Kjartan committed
643
  while ($voc = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
644 645 646 647
    $node_types[$voc->vid][] = $voc->type;
    unset($voc->type);
    $voc->nodes = $node_types[$voc->vid];
    $vocabularies[$voc->vid] = $voc;
Dries's avatar
 
Dries committed
648
  }
Dries's avatar
 
Dries committed
649

Kjartan's avatar
Kjartan committed
650 651
  return $vocabularies;
}
Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653
/**
654
 * Implementation of hook_form_alter().
Dries's avatar
 
Dries committed
655 656
 * Generate a form for selecting terms to associate with a node.
 */
657 658 659 660
function taxonomy_form_alter($form_id, &$form) {
  if (isset($form['type']) && $form['type']['#value'] .'_node_form' == $form_id) {
    $node = $form['#node'];

661
    if (!isset($node->taxonomy)) {
662
      $terms = empty($node->nid) ? array() : taxonomy_node_get_terms($node->nid);
Kjartan's avatar
Kjartan committed
663 664
    }
    else {
665
      $terms = $node->taxonomy;
Dries's avatar
 
Dries committed
666 667
    }

668
    $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
669

670 671 672 673
    while ($vocabulary = db_fetch_object($c)) {
      if ($vocabulary->tags) {
        $typed_terms = array();
        foreach ($terms as $term) {
674
          // Extract terms belonging to the vocabulary in question.
675
          if ($term->vid == $vocabulary->vid) {
Dries's avatar
Dries committed
676

677
            // Commas and quotes in terms are special cases, so encode 'em.
678 679
            if (strpos($term->name, ',') !== FALSE || strpos($term->name, '"') !== FALSE) {
              $term->name = '"'.str_replace('"', '""', $term->name).'"';
680 681 682 683
            }

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

687 688 689 690
        if ($vocabulary->help) {
          $help = $vocabulary->help;
        }
        else {
691
          $help = t('A comma-separated list of terms describing this content. Example: funny, bungee jumping, "Company, Inc.".');
692
        }
693 694 695 696 697 698 699
        $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,
700
          '#maxlength' => 255,
701
        );
702 703
      }
      else {
704 705 706 707 708 709 710 711
        // Extract terms belonging to the vocabulary in question.
        $default_terms = array();
        foreach ($terms as $term) {
          if ($term->vid == $vocabulary->vid) {
            $default_terms[$term->tid] = $term;
          }
        }
        $form['taxonomy'][$vocabulary->vid] = taxonomy_form($vocabulary->vid, array_keys($default_terms), $vocabulary->help);
712
        $form['taxonomy'][$vocabulary->vid]['#weight'] = $vocabulary->weight;
713
        $form['taxonomy'][$vocabulary->vid]['#required'] = $vocabulary->required;
714
      }
Dries's avatar
Dries committed
715
    }
716
    if (!empty($form['taxonomy']) && is_array($form['taxonomy'])) {
717 718 719 720 721 722 723 724
      if (count($form['taxonomy']) > 1) { // Add fieldset only if form has more than 1 element.
        $form['taxonomy'] += array(
          '#type' => 'fieldset',
          '#title' => t('Categories'),
          '#collapsible' => TRUE,
          '#collapsed' => FALSE,
        );
      }
725 726
      $form['taxonomy']['#weight'] = -3;
      $form['taxonomy']['#tree'] = TRUE;
Dries's avatar
Dries committed
727
    }
Dries's avatar
 
Dries committed
728
  }
Kjartan's avatar
Kjartan committed
729
}
Dries's avatar
 
Dries committed
730

Dries's avatar
 
Dries committed
731
/**
732
 * Find all terms associated with the given node, within one vocabulary.
Dries's avatar
 
Dries committed
733 734
 */
function taxonomy_node_get_terms_by_vocabulary($nid, $vid, $key = 'tid') {
735
  $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
736 737 738
  $terms = array();
  while ($term = db_fetch_object($result)) {
    $terms[$term->$key] = $term;
Dries's avatar
 
Dries committed
739
  }
Kjartan's avatar
Kjartan committed
740 741 742
  return $terms;
}

Dries's avatar
 
Dries committed
743
/**
744
 * Find all terms associated with the given node, ordered by vocabulary and term weight.
Dries's avatar
 
Dries committed
745 746
 */
function taxonomy_node_get_terms($nid, $key = 'tid') {
Kjartan's avatar
Kjartan committed
747
  static $terms;
Dries's avatar
 
Dries committed
748

Dries's avatar
 
Dries committed
749
  if (!isset($terms[$nid])) {
750
    $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
751
    $terms[$nid] = array();
Dries's avatar
 
Dries committed
752
    while ($term = db_fetch_object($result)) {
Kjartan's avatar
Kjartan committed
753
      $terms[$nid][$term->$key] = $term;
Dries's avatar
 
Dries committed
754 755
    }
  }
Kjartan's avatar
Kjartan committed
756 757
  return $terms[$nid];
}
Dries's avatar
 
Dries committed
758

Dries's avatar
Dries committed
759 760 761
/**
 * Make sure incoming vids are free tagging enabled.
 */
762 763 764
function taxonomy_node_validate(&$node) {
  if ($node->taxonomy) {
    $terms = $node->taxonomy;
Dries's avatar
Dries committed
765 766 767
    if ($terms['tags']) {
      foreach ($terms['tags'] as $vid => $vid_value) {
        $vocabulary = taxonomy_get_vocabulary($vid);
768
        if (empty($vocabulary->tags)) {
769 770
          // see form_get_error $key = implode('][', $element['#parents']);
          // on why this is the key
771
          form_set_error("taxonomy][tags][$vid", t('The %name vocabulary can not be modified in this way.', array('%name' => $vocabulary->name)));
Dries's avatar
Dries committed
772 773 774 775 776 777
        }
      }
    }
  }
}

Dries's avatar
 
Dries committed
778 779 780
/**
 * Save term associations for a given node.
 */
781 782
function taxonomy_node_save($nid, $terms) {
  taxonomy_node_delete($nid);
Dries's avatar
Dries committed
783 784 785

  // Free tagging vocabularies do not send their tids in the form,
  // so we'll detect them here and process them independently.
786 787 788
  if (isset($terms['tags'])) {
    $typed_input = $terms['tags'];
    unset($terms['tags']);
Dries's avatar
Dries committed
789 790 791 792 793 794

    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);
795
      $typed_terms = array_unique($matches[1]);
Dries's avatar
Dries committed
796

797
      $inserted = array();
Dries's avatar
Dries committed
798 799 800
      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
801
        // formatting so to save the term into the database as the user intends.
Dries's avatar
Dries committed
802 803 804 805 806
        $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
807
        // and return the tid; otherwise, add a new record.
Dries's avatar
Dries committed
808
        $possibilities = taxonomy_get_term_by_name($typed_term);
809
        $typed_term_tid = NULL; // tid match, if any.
Dries's avatar
Dries committed
810 811 812 813 814 815 816
        foreach ($possibilities as $possibility) {
          if ($possibility->vid == $vid) {
            $typed_term_tid = $possibility->tid;
          }
        }

        if (!$typed_term_tid) {
817 818 819
          $edit = array('vid' => $vid, 'name' => $typed_term);
          $status = taxonomy_save_term($edit);
          $typed_term_tid = $edit['tid'];
Dries's avatar
Dries committed
820 821
        }

822
        // Defend against duplicate, differently cased tags
823
        if (!isset($inserted[$typed_term_tid])) {
824
          db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $typed_term_tid);
825 826
          $inserted[$typed_term_tid] = TRUE;
        }
Dries's avatar
Dries committed
827 828 829
      }
    }
  }
Dries's avatar
 
Dries committed
830

831 832
  if (is_array($terms)) {
    foreach ($terms as $term) {
833 834 835
      if (is_array($term)) {
        foreach ($term as $tid) {
          if ($tid) {
836
            db_query('INSERT INTO {term_node} (nid, tid) VALUES (%d, %d)', $nid, $tid);
Dries's avatar