node.module 135 KB
Newer Older
Dries's avatar
 
Dries committed
1 2
<?php

Dries's avatar
 
Dries committed
3 4
/**
 * @file
5 6 7 8
 * The core module that allows content to be submitted to the site.
 *
 * Modules and scripts may programmatically submit nodes using the usual form
 * API pattern.
Dries's avatar
 
Dries committed
9 10
 */

11
/**
12
 * Denotes that the node is not published.
13
 */
14
const NODE_NOT_PUBLISHED = 0;
15 16

/**
17
 * Denotes that the node is published.
18
 */
19
const NODE_PUBLISHED = 1;
20 21

/**
22
 * Denotes that the node is not promoted to the front page.
23
 */
24
const NODE_NOT_PROMOTED = 0;
25 26

/**
27
 * Denotes that the node is promoted to the front page.
28
 */
29
const NODE_PROMOTED = 1;
30 31

/**
32
 * Denotes that the node is not sticky at the top of the page.
33
 */
34
const NODE_NOT_STICKY = 0;
35 36

/**
37
 * Denotes that the node is sticky at the top of the page.
38
 */
39
const NODE_STICKY = 1;
40

41
/**
42
 * Denotes the time cutoff for nodes marked as read.
43
 *
44 45 46
 * Nodes changed before this time are always marked as read. Nodes changed after
 * this time may be marked new, updated, or read, depending on their state for
 * the current user. Defaults to 30 days ago.
47
 */
48
define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
49

50
/**
51 52 53 54
 * Denotes that access is allowed for a node.
 *
 * Modules should return this value from hook_node_access() to allow access to a
 * node.
55
 */
56
const NODE_ACCESS_ALLOW = 'allow';
57 58

/**
59 60 61 62
 * Denotes that access is denied for a node.
 *
 * Modules should return this value from hook_node_access() to deny access to a
 * node.
63
 */
64
const NODE_ACCESS_DENY = 'deny';
65 66

/**
67 68 69 70
 * Denotes that access is unaffected for a node.
 *
 * Modules should return this value from hook_node_access() to indicate no
 * effect on node access.
71
 */
72
const NODE_ACCESS_IGNORE = NULL;
73

Dries's avatar
 
Dries committed
74
/**
75
 * Implements hook_help().
Dries's avatar
 
Dries committed
76
 */
77
function node_help($path, $arg) {
78 79 80
  // Remind site administrators about the {node_access} table being flagged
  // for rebuild. We don't need to issue the message on the confirm form, or
  // while the rebuild is being processed.
81
  if ($path != 'admin/reports/status/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
82
      && user_access('access administration pages') && node_access_needs_rebuild()) {
83
    if ($path == 'admin/reports/status') {
84 85 86
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
87
      $message = t('The content access permissions need to be rebuilt. <a href="@node_access_rebuild">Rebuild permissions</a>.', array('@node_access_rebuild' => url('admin/reports/status/rebuild')));
88 89 90 91
    }
    drupal_set_message($message, 'error');
  }

92
  switch ($path) {
Dries's avatar
 
Dries committed
93
    case 'admin/help#node':
94 95
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
96
      $output .= '<p>' . t('The Node module manages the creation, editing, deletion, settings, and display of the main site content. Content items managed by the Node module are typically displayed as pages on your site, and include a title, some meta-data (author, creation time, content type, etc.), and optional fields containing text or other data (fields are managed by the <a href="@field">Field module</a>). For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node', '@field' => url('admin/help/field'))) . '</p>';
97 98
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
99 100 101
      $output .= '<dt>' . t('Creating content') . '</dt>';
      $output .= '<dd>' . t('When new content is created, the Node module records basic information about the content, including the author, date of creation, and the <a href="@content-type">Content type</a>. It also manages the <em>publishing options</em>, which define whether or not the content is published, promoted to the front page of the site, and/or sticky at the top of content lists. Default settings can be configured for each <a href="@content-type">type of content</a> on your site.', array('@content-type' => url('admin/structure/types'))) . '</dd>';
      $output .= '<dt>' . t('Creating custom content types') . '</dt>';
102
      $output .= '<dd>' . t('The Node module gives users with the <em>Administer content types</em> permission the ability to <a href="@content-new">create new content types</a> in addition to the default ones already configured. Creating custom content types allows you the flexibility to add <a href="@field">fields</a> and configure default settings that suit the differing needs of various site content.', array('@content-new' => url('admin/structure/types/add'), '@field' => url('admin/help/field'))) . '</dd>';
103
      $output .= '<dt>' . t('Administering content') . '</dt>';
104 105 106
      $output .= '<dd>' . t('The <a href="@content">Content administration page</a> allows you to review and bulk manage your site content.', array('@content' => url('admin/content'))) . '</dd>';
      $output .= '<dt>' . t('Creating revisions') . '</dt>';
      $output .= '<dd>' . t('The Node module also enables you to create multiple versions of any content, and revert to older versions using the <em>Revision information</em> settings.') . '</dd>';
107
      $output .= '<dt>' . t('User permissions') . '</dt>';
108
      $output .= '<dd>' . t('The Node module makes a number of permissions available for each content type, which can be set by role on the <a href="@permissions">permissions page</a>.', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-node')))) . '</dd>';
109
      $output .= '</dl>';
110
      return $output;
111

112
    case 'admin/structure/types/add':
113
      return '<p>' . t('Individual content types can have different fields, behaviors, and permissions assigned to them.') . '</p>';
114

115 116 117
    case 'admin/structure/types/manage/%/display':
      return '<p>' . t('Content items can be displayed using different view modes: Teaser, Full content, Print, RSS, etc. <em>Teaser</em> is a short format that is typically used in lists of multiple content items. <em>Full content</em> is typically used when the content is displayed on its own page.') . '</p>' .
        '<p>' . t('Here, you can define which fields are shown and hidden when %type content is displayed in each view mode, and define how the fields are displayed in each view mode.', array('%type' => node_type_get_name($arg[4]))) . '</p>';
118

119
    case 'node/%/revisions':
120
      return '<p>' . t('Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.') . '</p>';
121

122 123
    case 'node/%/edit':
      $node = node_load($arg[1]);
124
      $type = node_type_get_type($node);
125
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
126
  }
Dries's avatar
 
Dries committed
127

128
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
129
    $type = node_type_get_type(str_replace('-', '_', $arg[2]));
130
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
131
  }
Dries's avatar
 
Dries committed
132 133
}

134
/**
135
 * Implements hook_theme().
136 137 138
 */
function node_theme() {
  return array(
139
    'node' => array(
140
      'render element' => 'elements',
141
      'template' => 'node',
142
    ),
143
    'node_search_admin' => array(
144
      'render element' => 'form',
145
    ),
146
    'node_add_list' => array(
147
      'variables' => array('content' => NULL),
148
      'file' => 'node.pages.inc',
149 150
    ),
    'node_preview' => array(
151
      'variables' => array('node' => NULL),
152
      'file' => 'node.pages.inc',
153
    ),
154
    'node_admin_overview' => array(
155
      'variables' => array('name' => NULL, 'type' => NULL),
156
    ),
157 158 159 160 161 162
    'node_recent_block' => array(
      'variables' => array('nodes' => NULL),
    ),
    'node_recent_content' => array(
      'variables' => array('node' => NULL),
    ),
163 164 165
  );
}

Dries's avatar
 
Dries committed
166
/**
167
 * Implements hook_cron().
Dries's avatar
 
Dries committed
168
 */
169
function node_cron() {
170 171 172
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
173 174
}

Dries's avatar
 
Dries committed
175
/**
176
 * Implements hook_entity_info().
Dries's avatar
 
Dries committed
177
 */
178
function node_entity_info() {
Dries's avatar
 
Dries committed
179 180
  $return = array(
    'node' => array(
181
      'label' => t('Node'),
182 183 184
      'controller class' => 'NodeController',
      'base table' => 'node',
      'revision table' => 'node_revision',
185
      'uri callback' => 'node_uri',
186
      'fieldable' => TRUE,
187
      'entity keys' => array(
188 189 190
        'id' => 'nid',
        'revision' => 'vid',
        'bundle' => 'type',
191
        'label' => 'title',
192
      ),
193 194 195
      'bundle keys' => array(
        'bundle' => 'type',
      ),
196
      'bundles' => array(),
197 198
      'view modes' => array(
        'full' => array(
199
          'label' => t('Full content'),
200
          'custom settings' => FALSE,
201 202 203
        ),
        'teaser' => array(
          'label' => t('Teaser'),
204
          'custom settings' => TRUE,
205 206 207
        ),
        'rss' => array(
          'label' => t('RSS'),
208
          'custom settings' => FALSE,
209 210
        ),
      ),
Dries's avatar
 
Dries committed
211 212
    ),
  );
213 214 215 216 217 218

  // Search integration is provided by node.module, so search-related
  // view modes for nodes are defined here and not in search.module.
  if (module_exists('search')) {
    $return['node']['view modes'] += array(
      'search_index' => array(
219
        'label' => t('Search index'),
220
        'custom settings' => FALSE,
221 222
      ),
      'search_result' => array(
223
        'label' => t('Search result'),
224
        'custom settings' => FALSE,
225 226 227 228
      ),
    );
  }

229 230
  // Bundles must provide a human readable name so we can create help and error
  // messages, and the path to attach Field admin pages to.
231
  node_type_cache_reset();
232 233 234 235
  foreach (node_type_get_names() as $type => $name) {
    $return['node']['bundles'][$type] = array(
      'label' => $name,
      'admin' => array(
236 237 238
        'path' => 'admin/structure/types/manage/%node_type',
        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
        'bundle argument' => 4,
239 240 241 242
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
243

244
  return $return;
Dries's avatar
 
Dries committed
245 246
}

247 248 249 250 251 252 253 254 255 256
/**
 * Implements hook_field_display_ENTITY_TYPE_alter().
 */
function node_field_display_node_alter(&$display, $context) {
  // Hide field labels in search index.
  if ($context['view_mode'] == 'search_index') {
    $display['label'] = 'hidden';
  }
}

257
/**
258
 * Entity uri callback.
259
 */
260 261 262 263
function node_uri($node) {
  return array(
    'path' => 'node/' . $node->nid,
  );
264 265
}

266
/**
267
 * Implements hook_admin_paths().
268 269
 */
function node_admin_paths() {
270 271 272 273 274 275 276 277 278 279 280 281
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/edit' => TRUE,
      'node/*/delete' => TRUE,
      'node/*/revisions' => TRUE,
      'node/*/revisions/*/revert' => TRUE,
      'node/*/revisions/*/delete' => TRUE,
      'node/add' => TRUE,
      'node/add/*' => TRUE,
    );
    return $paths;
  }
282 283
}

Dries's avatar
 
Dries committed
284
/**
285
 * Gathers a listing of links to nodes.
Dries's avatar
 
Dries committed
286 287
 *
 * @param $result
288 289 290 291
 *   A database result object from a query to fetch node entities. If your
 *   query joins the {node_comment_statistics} table so that the comment_count
 *   field is available, a title attribute will be added to show the number of
 *   comments.
Dries's avatar
 
Dries committed
292
 * @param $title
293
 *   (optional) A heading for the resulting list.
Dries's avatar
 
Dries committed
294 295
 *
 * @return
296 297
 *   A renderable array containing a list of linked node titles fetched from
 *   $result, or FALSE if there are no rows in $result.
Dries's avatar
 
Dries committed
298
 */
Dries's avatar
 
Dries committed
299
function node_title_list($result, $title = NULL) {
300
  $items = array();
301
  $num_rows = FALSE;
302
  foreach ($result as $node) {
303
    $items[] = l($node->title, 'node/' . $node->nid, !empty($node->comment_count) ? array('attributes' => array('title' => format_plural($node->comment_count, '1 comment', '@count comments'))) : array());
304
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
305 306
  }

307
  return $num_rows ? array('#theme' => 'item_list__node', '#items' => $items, '#title' => $title) : FALSE;
Dries's avatar
 
Dries committed
308 309
}

Dries's avatar
 
Dries committed
310
/**
311
 * Updates the 'last viewed' timestamp of the specified node for current user.
312 313 314
 *
 * @param $node
 *   A node object.
Dries's avatar
 
Dries committed
315
 */
316
function node_tag_new($node) {
Dries's avatar
 
Dries committed
317 318
  global $user;
  if ($user->uid) {
319 320 321 322 323 324 325
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $node->nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
326
   }
Dries's avatar
 
Dries committed
327 328
}

Dries's avatar
 
Dries committed
329
/**
330
 * Retrieves the timestamp for the current user's last view of a specified node.
Dries's avatar
 
Dries committed
331
 */
Dries's avatar
 
Dries committed
332 333
function node_last_viewed($nid) {
  global $user;
334
  $history = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
335

Dries's avatar
 
Dries committed
336
  if (!isset($history[$nid])) {
337
    $history[$nid] = db_query("SELECT timestamp FROM {history} WHERE uid = :uid AND nid = :nid", array(':uid' => $user->uid, ':nid' => $nid))->fetchObject();
Dries's avatar
 
Dries committed
338 339
  }

340
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
341 342 343
}

/**
344
 * Decides on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
345
 *
Dries's avatar
 
Dries committed
346 347 348 349
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
350
 *
351 352
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
353
 */
354
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
355
  global $user;
356
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
357

358 359 360
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
361
  if (!isset($cache[$nid])) {
362
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
363
  }
364 365 366 367 368 369 370
  if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
    return MARK_NEW;
  }
  elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
    return MARK_UPDATED;
  }
  return MARK_READ;
Dries's avatar
 
Dries committed
371 372
}

373
/**
374
 * Extracts the type name.
375 376
 *
 * @param $node
377
 *   Either a string or object, containing the node type information.
378 379
 *
 * @return
380
 *   Node type of the passed-in data.
381
 */
382 383 384
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
385

386 387 388
/**
 * Returns a list of all the available node types.
 *
389 390 391
 * This list can include types that are queued for addition or deletion.
 * See _node_types_build() for details.
 *
392
 * @return
393
 *   An array of node types, as objects, keyed by the type.
394
 *
395 396 397 398 399 400 401 402 403
 * @see node_type_get_type()
 */
function node_type_get_types() {
  return _node_types_build()->types;
}

/**
 * Returns the node type of the passed node or node type string.
 *
404
 * @param $node
405
 *   A node object or string that indicates the node type to return.
406
 *
407
 * @return
408 409 410
 *   A single node type, as an object, or FALSE if the node type is not found.
 *   The node type is an object containing fields from hook_node_info() return
 *   values, as well as the field 'type' (the machine-readable type) and other
411 412
 *   fields used internally and defined in _node_types_build(),
 *   hook_node_info(), and node_type_set_defaults().
413 414 415 416 417 418 419 420 421 422
 */
function node_type_get_type($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->types;
  return isset($types[$type]) ? $types[$type] : FALSE;
}

/**
 * Returns the node type base of the passed node or node type string.
 *
423 424 425
 * The base indicates which module implements this node type and is used to
 * execute node-type-specific hooks. For types defined in the user interface
 * and managed by node.module, the base is 'node_content'.
426 427 428
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
429
 *
430 431
 * @return
 *   The node type base or FALSE if the node type is not found.
432 433
 *
 * @see node_invoke()
434 435 436 437 438 439 440 441
 */
function node_type_get_base($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->types;
  return isset($types[$type]) && isset($types[$type]->base) ? $types[$type]->base : FALSE;
}

/**
442 443 444 445
 * Returns a list of available node type names.
 *
 * This list can include types that are queued for addition or deletion.
 * See _node_types_build() for details.
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
 *
 * @return
 *   An array of node type names, keyed by the type.
 */
function node_type_get_names() {
  return _node_types_build()->names;
}

/**
 * Returns the node type name of the passed node or node type string.
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
 *
 * @return
 *   The node type name or FALSE if the node type is not found.
 */
function node_type_get_name($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->names;
  return isset($types[$type]) ? $types[$type] : FALSE;
467 468 469
}

/**
470
 * Updates the database cache of node types.
471
 *
472 473
 * All new module-defined node types are saved to the database via a call to
 * node_type_save(), and obsolete ones are deleted via a call to
474
 * node_type_delete(). See _node_types_build() for an explanation of the new
475
 * and obsolete types.
476 477
 */
function node_types_rebuild() {
478
  _node_types_build(TRUE);
479 480
}

481
/**
482
 * Menu argument loader: Loads a node type by string.
483 484
 *
 * @param $name
485 486
 *   The machine-readable name of a node type to load, where '_' is replaced
 *   with '-'.
487 488 489 490 491 492 493 494
 *
 * @return
 *   A node type object or FALSE if $name does not exist.
 */
function node_type_load($name) {
  return node_type_get_type(strtr($name, array('-' => '_')));
}

495
/**
496 497 498 499
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
500 501
 *
 * @return
502
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
503
 */
504 505
function node_type_save($info) {
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
506
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();
507 508 509 510 511 512 513 514 515 516 517 518 519
  $type = node_type_set_defaults($info);

  $fields = array(
    'type' => (string) $type->type,
    'name' => (string) $type->name,
    'base' => (string) $type->base,
    'has_title' => (int) $type->has_title,
    'title_label' => (string) $type->title_label,
    'description' => (string) $type->description,
    'help' => (string) $type->help,
    'custom' => (int) $type->custom,
    'modified' => (int) $type->modified,
    'locked' => (int) $type->locked,
520 521
    'disabled' => (int) $type->disabled,
    'module' => $type->module,
522
  );
523 524

  if ($is_existing) {
525 526 527 528
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
529

Dries's avatar
 
Dries committed
530
    if (!empty($type->old_type) && $type->old_type != $type->type) {
531
      field_attach_rename_bundle('node', $type->old_type, $type->type);
Dries's avatar
 
Dries committed
532
    }
533
    module_invoke_all('node_type_update', $type);
534
    $status = SAVED_UPDATED;
535 536
  }
  else {
537
    $fields['orig_type'] = (string) $type->orig_type;
538 539 540
    db_insert('node_type')
      ->fields($fields)
      ->execute();
541

542
    field_attach_create_bundle('node', $type->type);
543

544
    module_invoke_all('node_type_insert', $type);
545
    $status = SAVED_NEW;
546
  }
547 548

  // Clear the node type cache.
549
  node_type_cache_reset();
550 551

  return $status;
552
}
553

554
/**
555
 * Adds the default body field to a node type.
556
 *
557
 * @param $type
558
 *   A node type object.
559
 * @param $label
560
 *   (optional) The label for the body instance.
561 562 563
 *
 * @return
 *   Body field instance.
564
 */
565
function node_add_body_field($type, $label = 'Body') {
566 567
   // Add or remove the body field, as needed.
  $field = field_info_field('body');
568
  $instance = field_info_instance('node', 'body', $type->type);
569 570 571 572 573 574 575
  if (empty($field)) {
    $field = array(
      'field_name' => 'body',
      'type' => 'text_with_summary',
      'entity_types' => array('node'),
    );
    $field = field_create_field($field);
576
  }
577 578 579 580 581 582
  if (empty($instance)) {
    $instance = array(
      'field_name' => 'body',
      'entity_type' => 'node',
      'bundle' => $type->type,
      'label' => $label,
583
      'widget' => array('type' => 'text_textarea_with_summary'),
584 585
      'settings' => array('display_summary' => TRUE),
      'display' => array(
586
        'default' => array(
587 588 589 590 591 592 593 594 595
          'label' => 'hidden',
          'type' => 'text_default',
        ),
        'teaser' => array(
          'label' => 'hidden',
          'type' => 'text_summary_or_trimmed',
        ),
      ),
    );
596
    $instance = field_create_instance($instance);
597
  }
598
  return $instance;
599
}
600

601 602 603 604 605
/**
 * Implements hook_field_extra_fields().
 */
function node_field_extra_fields() {
  $extra = array();
606

607 608 609
  foreach (node_type_get_types() as $type) {
    if ($type->has_title) {
      $extra['node'][$type->type] = array(
610 611 612 613 614 615
        'form' => array(
          'title' => array(
            'label' => $type->title_label,
            'description' => t('Node module element'),
            'weight' => -5,
          ),
616 617 618 619
        ),
      );
    }
  }
620 621

  return $extra;
622 623
}

624 625 626 627 628 629 630
/**
 * Deletes a node type from the database.
 *
 * @param $type
 *   The machine-readable name of the node type to be deleted.
 */
function node_type_delete($type) {
631
  $info = node_type_get_type($type);
632 633 634
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
635
  field_attach_delete_bundle('node', $type);
636
  module_invoke_all('node_type_delete', $info);
637 638

  // Clear the node type cache.
639
  node_type_cache_reset();
640 641
}

642
/**
643 644
 * Updates all nodes of one type to be of another type.
 *
645
 * @param $old_type
646 647 648
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
649 650
 *
 * @return
651
 *   The number of nodes whose node type field was modified.
652
 */
653
function node_type_update_nodes($old_type, $type) {
654
  return db_update('node')
655 656 657
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
658
}
Dries's avatar
 
Dries committed
659

660
/**
661 662
 * Builds and returns the list of available node types.
 *
663 664 665 666
 * The list of types is built by invoking hook_node_info() on all modules and
 * comparing this information with the node types in the {node_type} table.
 * These two information sources are not synchronized during module installation
 * until node_types_rebuild() is called.
Dries's avatar
 
Dries committed
667
 *
668 669
 * @param $rebuild
 *  TRUE to rebuild node types. Equivalent to calling node_types_rebuild().
670
 *
671 672 673 674 675 676 677 678 679 680 681 682
 * @return
 *   Associative array with two components:
 *   - names: Associative array of the names of node types, keyed by the type.
 *   - types: Associative array of node type objects, keyed by the type.
 *   Both of these arrays will include new types that have been defined by
 *   hook_node_info() implementations but not yet saved in the {node_type}
 *   table. These are indicated in the type object by $type->is_new being set
 *   to the value 1. These arrays will also include obsolete types: types that
 *   were previously defined by modules that have now been disabled, or for
 *   whatever reason are no longer being defined in hook_node_info()
 *   implementations, but are still in the database. These are indicated in the
 *   type object by $type->disabled being set to TRUE.
Dries's avatar
 
Dries committed
683
 */
684
function _node_types_build($rebuild = FALSE) {
685 686
  $cid = 'node_types:' . $GLOBALS['language']->language;

687 688
  if (!$rebuild) {
    $_node_types = &drupal_static(__FUNCTION__);
689 690 691
    if (isset($_node_types)) {
      return $_node_types;
    }
692
    if ($cache = cache()->get($cid)) {
693
      $_node_types = $cache->data;
694 695
      return $_node_types;
    }
696
  }
697

698
  $_node_types = (object) array('types' => array(), 'names' => array());
699

700 701 702 703 704 705 706 707
  foreach (module_implements('node_info') as $module) {
    $info_array = module_invoke($module, 'node_info');
    foreach ($info_array as $type => $info) {
      $info['type'] = $type;
      $_node_types->types[$type] = node_type_set_defaults($info);
      $_node_types->types[$type]->module = $module;
      $_node_types->names[$type] = $info['name'];
    }
708
  }
709
  $query = db_select('node_type', 'nt')
710 711
    ->addTag('translatable')
    ->addTag('node_type_access')
712
    ->fields('nt')
713 714 715 716 717 718 719 720
    ->orderBy('nt.type', 'ASC');
  if (!$rebuild) {
    $query->condition('disabled', 0);
  }
  foreach ($query->execute() as $type_object) {
    $type_db = $type_object->type;
    // Original disabled value.
    $disabled = $type_object->disabled;
721 722
    // Check for node types from disabled modules and mark their types for removal.
    // Types defined by the node module in the database (rather than by a separate
723 724
    // module using hook_node_info) have a base value of 'node_content'. The isset()
    // check prevents errors on old (pre-Drupal 7) databases.
725
    if (isset($type_object->base) && $type_object->base != 'node_content' && empty($_node_types->types[$type_db])) {
726
      $type_object->disabled = TRUE;
727
    }
728
    if (isset($_node_types->types[$type_db])) {
729 730 731 732 733
      $type_object->disabled = FALSE;
    }
    if (!isset($_node_types->types[$type_db]) || $type_object->modified) {
      $_node_types->types[$type_db] = $type_object;
      $_node_types->names[$type_db] = $type_object->name;
734

735
      if ($type_db != $type_object->orig_type) {
736 737
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
738 739
      }
    }
740 741 742 743 744 745 746 747 748 749
    $_node_types->types[$type_db]->disabled = $type_object->disabled;
    $_node_types->types[$type_db]->disabled_changed = $disabled != $type_object->disabled;
  }

  if ($rebuild) {
    foreach ($_node_types->types as $type => $type_object) {
      if (!empty($type_object->is_new) || !empty($type_object->disabled_changed)) {
        node_type_save($type_object);
      }
    }
750 751
  }

752
  asort($_node_types->names);
753

754
  cache()->set($cid, $_node_types);
755

756
  return $_node_types;
757 758
}

759 760 761 762
/**
 * Clears the node type cache.
 */
function node_type_cache_reset() {
763
  cache()->deletePrefix('node_types:');
764 765 766
  drupal_static_reset('_node_types_build');
}

767
/**
768
 * Sets the default values for a node type.
769
 *
770 771 772 773 774
 * The defaults are appropriate for a type defined through hook_node_info(),
 * since 'custom' is TRUE for types defined in the user interface, and FALSE
 * for types defined by modules. (The 'custom' flag prevents types from being
 * deleted through the user interface.) Also, the default for 'locked' is TRUE,
 * which prevents users from changing the machine name of the type.
775 776
 *
 * @param $info
777 778
 *   (optional) An object or array containing values to override the defaults.
 *   See hook_node_info() for details on what the array elements mean.
779 780
 *
 * @return
781
 *   A node type object, with missing values in $info set to their defaults.
782
 */
783 784
function node_type_set_defaults($info = array()) {
  $info = (array) $info;
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
  $new_type = $info + array(
    'type' => '',
    'name' => '',
    'base' => '',
    'description' => '',
    'help' => '',
    'custom' => 0,
    'modified' => 0,
    'locked' => 1,
    'disabled' => 0,
    'is_new' => 1,
    'has_title' => 1,
    'title_label' => 'Title',
  );
  $new_type = (object) $new_type;

801
  // If the type has no title, set an empty label.
802 803 804
  if (!$new_type->has_title) {
    $new_type->title_label = '';
  }