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
function taxonomy_term_path($term) {
62
  $vocabulary = taxonomy_vocabulary_load($term->vid);
63 64 65 66 67 68
  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
  $items['admin/content/taxonomy/edit/vocabulary/%taxonomy_vocabulary'] = array(
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
    '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,
  );
120
  $items['admin/content/taxonomy/%taxonomy_vocabulary'] = array(
121 122 123 124 125 126 127
    'title' => t('List terms'),
    'page callback' => 'taxonomy_overview_terms',
    'page arguments' => array(3),
    'access arguments' => array('administer taxonomy'),
    'type' => MENU_CALLBACK,
  );

128
  $items['admin/content/taxonomy/%taxonomy_vocabulary/list'] = array(
129 130 131 132 133
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );

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

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

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

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

/**
 * Display a tree of all the terms in a vocabulary, with options to edit
 * each one.
 */
176
function taxonomy_overview_terms($vocabulary) {
177 178 179 180 181 182 183 184 185 186 187 188 189
  $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
190 191 192
    if (($start_from && ($start_from * $page_increment) >= $total_entries) || ($displayed_count == $page_increment)) {
      continue;
    }
193
    $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));
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    $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
214
function taxonomy_form_vocabulary($edit = array()) {
215 216 217
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Vocabulary name'),
    '#default_value' => $edit['name'],
218
    '#maxlength' => 255,
219
    '#description' => t('The name for this vocabulary. Example: "Topic".'),
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
    '#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'],
235
    '#options' => node_get_types('names'),
236 237 238 239 240 241 242
    '#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')),
243
    '#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'))),
244 245 246 247
  );
  $form['relations'] = array('#type' => 'checkbox',
    '#title' => t('Related terms'),
    '#default_value' => $edit['relations'],
248
    '#description' => t('Allows <a href="@help-url">related terms</a> in this vocabulary.', array('@help-url' => url('admin/help/taxonomy', NULL, NULL, 'related-terms'))),
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
  );
  $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.'),
  );
270

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

280 281 282 283 284 285 286
/**
 * 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)) {
287 288 289 290 291 292
    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;
293
  }
294
  return 'admin/content/taxonomy';
295 296
}

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

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

  cache_clear_all();
Dries's avatar
 
Dries committed
323

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

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

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

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

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

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

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

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

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

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

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

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

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

Kjartan's avatar
Kjartan committed
398
    if ($vocabulary->hierarchy == 1) {
399
      $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
400
    }
Kjartan's avatar
Kjartan committed
401
    elseif ($vocabulary->hierarchy == 2) {
402
      $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
403
    }
Kjartan's avatar
Kjartan committed
404
  }
Dries's avatar
 
Dries committed
405

406
  if ($vocabulary->relations) {
407
    $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']));
408 409
  }

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  $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
426

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

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

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

457 458 459 460 461 462 463 464 465 466
/**
 * 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']);
467
    $hook = 'update';
468
    $status = SAVED_UPDATED;
Kjartan's avatar
Kjartan committed
469
  }
470 471
  else if ($form_values['tid']) {
    return taxonomy_del_term($form_values['tid']);
Kjartan's avatar
Kjartan committed
472 473
  }
  else {
474 475
    $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']);
476
    $hook = 'insert';
477
    $status = SAVED_NEW;
Kjartan's avatar
Kjartan committed
478
  }
Dries's avatar
 
Dries committed
479

480 481 482
  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
483
      if ($related_id != 0) {
484
        db_query('INSERT INTO {term_relation} (tid1, tid2) VALUES (%d, %d)', $form_values['tid'], $related_id);
Dries's avatar
 
Dries committed
485
      }
Kjartan's avatar
Kjartan committed
486
    }
Kjartan's avatar
Kjartan committed
487
  }
Dries's avatar
 
Dries committed
488

489 490 491
  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
492
  }
493 494
  if (is_array($form_values['parent'])) {
    foreach ($form_values['parent'] as $parent) {
495 496
      if (is_array($parent)) {
        foreach ($parent as $tid) {
497
          db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $form_values['tid'], $tid);
498 499 500
        }
      }
      else {
501
        db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $form_values['tid'], $parent);
502
      }
Dries's avatar
 
Dries committed
503
    }
Kjartan's avatar
Kjartan committed
504
  }
505
  else {
506
    db_query('INSERT INTO {term_hierarchy} (tid, parent) VALUES (%d, %d)', $form_values['tid'], $form_values['parent']);
507
  }
Dries's avatar
 
Dries committed
508

509 510 511
  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
512
      if ($synonym) {
513
        db_query("INSERT INTO {term_synonym} (tid, name) VALUES (%d, '%s')", $form_values['tid'], chop($synonym));
Dries's avatar
 
Dries committed
514
      }
Kjartan's avatar
Kjartan committed
515
    }
Dries's avatar
 
Dries committed
516
  }
Dries's avatar
 
Dries committed
517

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

686 687 688 689
        if ($vocabulary->help) {
          $help = $vocabulary->help;
        }
        else {
690
          $help = t('A comma-separated list of terms describing this content. Example: funny, bungee jumping, "Company, Inc.".');
691
        }
692 693 694 695 696 697 698
        $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,
699
          '#maxlength' => 255,
700
        );
701 702
      }
      else {
703 704 705 706 707 708 709 710
        // 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);
711
        $form['taxonomy'][$vocabulary->vid]['#weight'] = $vocabulary->weight;
712
        $form['taxonomy'][$vocabulary->vid]['#required'] = $vocabulary->required;
713
      }
Dries's avatar
Dries committed
714
    }
715
    if (!empty($form['taxonomy']) && is_array($form['taxonomy'])) {
716 717 718 719 720 721 722 723
      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,
        );
      }
724 725
      $form['taxonomy']['#weight'] = -3;
      $form['taxonomy']['#tree'] = TRUE;
Dries's avatar
Dries committed
726
    }
Dries's avatar
 
Dries committed
727
  }
Kjartan's avatar
Kjartan committed
728
}
Dries's avatar
 
Dries committed
729

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

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

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

Dries's avatar
Dries committed
758 759 760
/**
 * Make sure incoming vids are free tagging enabled.
 */
761 762 763
function taxonomy_node_validate(&$node) {
  if ($node->taxonomy) {
    $terms = $node->taxonomy;
Dries's avatar
Dries committed
764 765
    if ($terms['tags']) {
      foreach ($terms['tags'] as $vid => $vid_value) {
766
        $vocabulary = taxonomy_vocabulary_load($vid);
767
        if (empty($vocabulary->tags)) {
768 769
          // see form_get_error $key = implode('][', $element['#parents']);
          // on why this is the key
770
          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
771 772 773 774 775 776
        }
      }
    }
  }
}

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

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

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

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

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

821
        // Defend against duplicate, differently cased tags