node.module 117 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6 7
 * The core 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
8 9
 */

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/**
 * Node is not published.
 */
define('NODE_NOT_PUBLISHED', 0);

/**
 * Node is published.
 */
define('NODE_PUBLISHED', 1);

/**
 * Node is not promoted to front page.
 */
define('NODE_NOT_PROMOTED', 0);

/**
 * Node is promoted to front page.
 */
define('NODE_PROMOTED', 1);

/**
 * Node is not sticky at top of the page.
 */
define('NODE_NOT_STICKY', 0);

/**
 * Node is sticky at top of the page.
 */
define('NODE_STICKY', 1);

40 41 42 43 44 45
/**
 * 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.
 */
46
define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
47

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/**
 * Modules should return this value from hook_node_access() to allow access to a node.
 */
define('NODE_ACCESS_ALLOW', 'allow');

/**
 * Modules should return this value from hook_node_access() to deny access to a node.
 */
define('NODE_ACCESS_DENY', 'deny');

/**
 * Modules should return this value from hook_node_access() to not affect node access.
 */
define('NODE_ACCESS_IGNORE', NULL);

Dries's avatar
 
Dries committed
63
/**
64
 * Implements hook_help().
Dries's avatar
 
Dries committed
65
 */
66
function node_help($path, $arg) {
67 68 69
  // 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.
70
  if ($path != 'admin/reports/status/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
71
      && user_access('access administration pages') && node_access_needs_rebuild()) {
72
    if ($path == 'admin/reports/status') {
73 74 75
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
76
      $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')));
77 78 79 80
    }
    drupal_set_message($message, 'error');
  }

81
  switch ($path) {
Dries's avatar
 
Dries committed
82
    case 'admin/help#node':
83 84
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
85
      $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>';
86 87
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
88 89 90
      $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>';
91
      $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>';
92
      $output .= '<dt>' . t('Administering content') . '</dt>';
93 94 95
      $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>';
96
      $output .= '<dt>' . t('User permissions') . '</dt>';
97
      $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>';
98
      $output .= '</dl>';
99
      return $output;
100

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

104 105 106
    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>';
107

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

111 112
    case 'node/%/edit':
      $node = node_load($arg[1]);
113
      $type = node_type_get_type($node);
114
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
115
  }
Dries's avatar
 
Dries committed
116

117
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
118
    $type = node_type_get_type(str_replace('-', '_', $arg[2]));
119
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
120
  }
Dries's avatar
 
Dries committed
121 122
}

123
/**
124
 * Implements hook_theme().
125 126 127
 */
function node_theme() {
  return array(
128
    'node' => array(
129
      'render element' => 'elements',
130
      'template' => 'node',
131
    ),
132
    'node_search_admin' => array(
133
      'render element' => 'form',
134 135
    ),
    'node_filters' => array(
136
      'render element' => 'form',
137
      'file' => 'node.admin.inc',
138
    ),
139
    'node_add_list' => array(
140
      'variables' => array('content' => NULL),
141
      'file' => 'node.pages.inc',
142 143
    ),
    'node_preview' => array(
144
      'variables' => array('node' => NULL),
145
      'file' => 'node.pages.inc',
146
    ),
147
    'node_admin_overview' => array(
148
      'variables' => array('name' => NULL, 'type' => NULL),
149
    ),
150 151 152 153 154 155
    'node_recent_block' => array(
      'variables' => array('nodes' => NULL),
    ),
    'node_recent_content' => array(
      'variables' => array('node' => NULL),
    ),
156 157 158
  );
}

Dries's avatar
 
Dries committed
159
/**
160
 * Implements hook_cron().
Dries's avatar
 
Dries committed
161
 */
162
function node_cron() {
163 164 165
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
166 167
}

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

  // 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(
208
        'label' => t('Search index'),
209 210
      ),
      'search_result' => array(
211
        'label' => t('Search result'),
212 213 214 215
      ),
    );
  }

216 217 218 219 220 221
  // Bundles must provide a human readable name so we can create help and error
  // messages, and the path to attach Field admin pages to.
  foreach (node_type_get_names() as $type => $name) {
    $return['node']['bundles'][$type] = array(
      'label' => $name,
      'admin' => array(
222 223 224
        'path' => 'admin/structure/types/manage/%node_type',
        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
        'bundle argument' => 4,
225 226 227 228
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
229

230
  return $return;
Dries's avatar
 
Dries committed
231 232
}

233
/**
234
 * Entity uri callback.
235
 */
236 237 238 239
function node_uri($node) {
  return array(
    'path' => 'node/' . $node->nid,
  );
240 241
}

242
/**
243
 * Implements hook_admin_paths().
244 245 246 247 248
 */
function node_admin_paths() {
  $paths = array(
    'node/*/edit' => TRUE,
    'node/*/delete' => TRUE,
249 250 251
    'node/*/revisions' => TRUE,
    'node/*/revisions/*/revert' => TRUE,
    'node/*/revisions/*/delete' => TRUE,
252 253 254 255 256 257
    'node/add' => TRUE,
    'node/add/*' => TRUE,
  );
  return $paths;
}

Dries's avatar
 
Dries committed
258 259 260 261
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
262
 *   A DB result object from a query to fetch node entities. If your query
263 264 265
 *   joins the <code>node_comment_statistics</code> table so that the
 *   <code>comment_count</code> field is available, a title attribute will
 *   be added to show the number of comments.
Dries's avatar
 
Dries committed
266 267 268 269
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
270 271
 *   An HTML list suitable as content for a block, or FALSE if no result can
 *   fetch from DB result object.
Dries's avatar
 
Dries committed
272
 */
Dries's avatar
 
Dries committed
273
function node_title_list($result, $title = NULL) {
274
  $items = array();
275
  $num_rows = FALSE;
276
  foreach ($result as $node) {
277
    $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());
278
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
279 280
  }

281
  return $num_rows ? theme('item_list__node', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
282 283
}

Dries's avatar
 
Dries committed
284 285
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
286 287 288
 *
 * @param $node
 *   A node object.
Dries's avatar
 
Dries committed
289
 */
290
function node_tag_new($node) {
Dries's avatar
 
Dries committed
291 292
  global $user;
  if ($user->uid) {
293 294 295 296 297 298 299
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $node->nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
300
   }
Dries's avatar
 
Dries committed
301 302
}

Dries's avatar
 
Dries committed
303 304 305 306
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
307 308
function node_last_viewed($nid) {
  global $user;
309
  $history = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
310

Dries's avatar
 
Dries committed
311
  if (!isset($history[$nid])) {
312
    $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
313 314
  }

315
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
316 317 318
}

/**
319
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
320
 *
Dries's avatar
 
Dries committed
321 322 323 324
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
325 326
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
327
 */
328
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
329
  global $user;
330
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
331

332 333 334
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
335
  if (!isset($cache[$nid])) {
336
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
337
  }
338 339 340 341 342 343 344
  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
345 346
}

347
/**
348
 * Extract the type name.
349 350
 *
 * @param $node
351
 *   Either a string or object, containing the node type information.
352 353
 *
 * @return
354
 *   Node type of the passed in data.
355
 */
356 357 358
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
359

360 361 362
/**
 * Returns a list of all the available node types.
 *
363 364 365
 * This list can include types that are queued for addition or deletion.
 * See _node_types_build() for details.
 *
366 367
 * @return
 *   An array of node types, keyed by the type.
368
 *
369 370 371 372 373 374 375 376 377
 * @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.
 *
378
 * @param $node
379
 *   A node object or string that indicates the node type to return.
380
 *
381
 * @return
382 383 384
 *   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
385 386
 *   fields used internally and defined in _node_types_build(),
 *   hook_node_info(), and node_type_set_defaults().
387 388 389 390 391 392 393 394 395 396
 */
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.
 *
397 398 399
 * 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'.
400 401 402
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
403
 *
404 405
 * @return
 *   The node type base or FALSE if the node type is not found.
406 407
 *
 * @see node_invoke()
408 409 410 411 412 413 414 415
 */
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;
}

/**
416 417 418 419
 * 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.
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
 *
 * @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;
441 442 443
}

/**
444
 * Updates the database cache of node types.
445
 *
446 447 448 449
 * 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
 * node_type_delete(). See _node_types_build() for an explanation of the new 
 * and obsolete types.
450 451
 */
function node_types_rebuild() {
452
  // Reset and load updated node types.
453
  drupal_static_reset('_node_types_build');
454
  foreach (node_type_get_types() as $type => $info) {
455 456 457
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
458 459 460
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
461 462 463
  }
}

464
/**
465
 * Menu argument loader: loads a node type by string.
466 467
 *
 * @param $name
468 469
 *   The machine-readable name of a node type to load, where '_' is replaced
 *   with '-'.
470 471 472 473 474 475 476 477
 *
 * @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('-' => '_')));
}

478
/**
479 480 481 482
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
483 484
 *
 * @return
485
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
486
 */
487 488 489
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
490
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();
491 492 493 494 495 496 497 498 499 500 501 502 503 504
  $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,
  );
505 506

  if ($is_existing) {
507 508 509 510
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
511

Dries's avatar
 
Dries committed
512
    if (!empty($type->old_type) && $type->old_type != $type->type) {
513
      field_attach_rename_bundle('node', $type->old_type, $type->type);
Dries's avatar
 
Dries committed
514
    }
515
    module_invoke_all('node_type_update', $type);
516
    $status = SAVED_UPDATED;
517 518
  }
  else {
519
    $fields['orig_type'] = (string) $type->orig_type;
520 521 522
    db_insert('node_type')
      ->fields($fields)
      ->execute();
523

524
    field_attach_create_bundle('node', $type->type);
525

526
    module_invoke_all('node_type_insert', $type);
527
    $status = SAVED_NEW;
528
  }
529 530 531 532 533

  // Clear the node type cache.
  drupal_static_reset('_node_types_build');

  return $status;
534
}
535

536
/**
537
 * Add default body field to a node type.
538
 *
539 540 541 542
 * @param $type
 *   The node type name.
 * @param $label
 *   The label for the body instance.
543
 */
544
function node_add_body_field($type, $label = 'Body') {
545 546
   // Add or remove the body field, as needed.
  $field = field_info_field('body');
547
  $instance = field_info_instance('node', 'body', $type->type);
548 549 550 551 552 553 554 555
  if (empty($field)) {
    $field = array(
      'field_name' => 'body',
      'type' => 'text_with_summary',
      'entity_types' => array('node'),
      'translatable' => TRUE,
    );
    $field = field_create_field($field);
556
  }
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
  if (empty($instance)) {
    $instance = array(
      'field_name' => 'body',
      'entity_type' => 'node',
      'bundle' => $type->type,
      'label' => $label,
      'widget_type' => 'text_textarea_with_summary',
      'settings' => array('display_summary' => TRUE),

      // Define default formatters for the teaser and full view.
      'display' => array(
        'full' => array(
          'label' => 'hidden',
          'type' => 'text_default',
        ),
        'teaser' => array(
          'label' => 'hidden',
          'type' => 'text_summary_or_trimmed',
        ),
      ),
    );
    field_create_instance($instance);
579
  }
580
}
581

582 583 584 585 586
/**
 * Implements hook_field_extra_fields().
 */
function node_field_extra_fields() {
  $extra = array();
587

588 589 590 591 592 593 594
  foreach (node_type_get_types() as $type) {
    if ($type->has_title) {
      $extra['node'][$type->type] = array(
        'title' => array(
          'label' => $type->title_label,
          'description' => t('Node module element.'),
          'weight' => -5,
595 596 597 598
        ),
      );
    }
  }
599 600

  return $extra;
601 602
}

603 604 605 606 607 608 609
/**
 * 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) {
610
  $info = node_type_get_type($type);
611 612 613
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
614
  module_invoke_all('node_type_delete', $info);
615 616 617

  // Clear the node type cache.
  drupal_static_reset('_node_types_build');
618 619
}

620
/**
621 622
 * Updates all nodes of one type to be of another type.
 *
623
 * @param $old_type
624 625 626
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
627 628
 *
 * @return
629
 *   The number of nodes whose node type field was modified.
630
 */
631
function node_type_update_nodes($old_type, $type) {
632
  return db_update('node')
633 634 635
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
636
}
Dries's avatar
 
Dries committed
637

638
/**
639 640
 * Builds and returns the list of available node types.
 *
641 642 643 644
 * 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
645
 *
646 647 648 649 650 651 652 653 654 655 656 657
 * @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
658
 */
659
function _node_types_build() {
660
  $_node_types = &drupal_static(__FUNCTION__);
661 662 663
  if (is_object($_node_types)) {
    return $_node_types;
  }
664
  $_node_types = (object)array('types' => array(), 'names' => array());
665 666 667 668

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
669 670
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
671
  }
672
  $type_result = db_select('node_type', 'nt')
673 674
    ->addTag('translatable')
    ->addTag('node_type_access')
675 676 677 678
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->execute();
  foreach ($type_result as $type_object) {
679 680
    // 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
681 682 683
    // module using hook_node_info) have a base value of 'node_content'. The isset()
    // check prevents errors on old (pre-Drupal 7) databases.
    if (isset($type_object->base) && $type_object->base != 'node_content' && empty($info_array[$type_object->type])) {
684
      $type_object->disabled = TRUE;
685
    }
686 687 688
    if (!isset($_node_types->types[$type_object->type]) || $type_object->modified) {
      $_node_types->types[$type_object->type] = $type_object;
      $_node_types->names[$type_object->type] = $type_object->name;
689 690

      if ($type_object->type != $type_object->orig_type) {
691 692
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
693 694 695 696
      }
    }
  }

697
  asort($_node_types->names);
698

699
  return $_node_types;
700 701 702
}

/**
703 704 705 706 707 708 709 710 711 712 713
 * Set the default values for a node type.
 *
 * The defaults are for a type defined through hook_node_info().
 * When populating a custom node type $info should have the 'custom'
 * key set to 1.
 *
 * @param $info
 *   An object or array containing values to override the defaults.
 *
 * @return
 *  A node type object.
714
 */
715
function node_type_set_defaults($info = array()) {
716
  $type = &drupal_static(__FUNCTION__);
717 718 719 720 721 722 723 724 725 726 727 728

  if (!isset($type)) {
    $type = new stdClass();
    $type->type = '';
    $type->name = '';
    $type->base = '';
    $type->description = '';
    $type->help = '';
    $type->custom = 0;
    $type->modified = 0;
    $type->locked = 1;
    $type->is_new = 1;
729 730 731

    $type->has_title = 1;
    $type->title_label = 'Title';
732 733 734 735 736 737 738
  }

  $new_type = clone $type;
  $info = (array) $info;
  foreach ($info as $key => $data) {
    $new_type->$key = $data;
  }
739
  // If the type has no title, set an empty label.
740 741 742 743 744 745
  if (!$new_type->has_title) {
    $new_type->title_label = '';
  }
  $new_type->orig_type = isset($info['type']) ? $info['type'] : '';

  return $new_type;
Dries's avatar
 
Dries committed
746
}
Dries's avatar
 
Dries committed
747

748
/**
749
 * Implements hook_rdf_mapping().
750 751 752 753 754 755 756 757
 */
function node_rdf_mapping() {
  return array(
    array(
      'type' => 'node',
      'bundle' => RDF_DEFAULT_BUNDLE,
      'mapping' => array(
        'rdftype' => array('sioc:Item', 'foaf:Document'),
758
        'title' => array(
759 760 761 762 763 764 765 766 767
          'predicates' => array('dc:title'),
        ),
        'created' => array(
          'predicates' => array('dc:date', 'dc:created'),
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
        ),
        'changed' => array(
          'predicates' => array('dc:modified'),
768 769
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
770
        ),
771
        'body' => array(
772 773
          'predicates' => array('content:encoded'),
        ),
774
        'uid' => array(
775
          'predicates' => array('sioc:has_creator'),
776
          'type' => 'rel',
777
        ),
778
        'name' => array(
779 780
          'predicates' => array('foaf:name'),
        ),
781 782
        'comment_count' => array(
          'predicates' => array('sioc:num_replies'),
783 784 785 786 787 788
          'datatype' => 'xsd:integer',
        ),
        'last_activity' => array(
          'predicates' => array('sioc:last_activity_date'),
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
789
        ),
790 791 792 793 794
      ),
    ),
  );
}

795
/**
Dries's avatar
 
Dries committed
796 797
 * Determine whether a node hook exists.
 *
798
 * @param $node
799
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
800 801 802
 * @param $hook
 *   A string containing the name of the hook.
 * @return
803
 *   TRUE if the $hook exists in the node type of $node.
Dries's avatar
 
Dries committed
804
 */
805
function node_hook($node, $hook) {
806
  $base = node_type_get_base($node);
807
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
808 809
}

810
/**
Dries's avatar
 
Dries committed
811 812
 * Invoke a node hook.
 *
813
 * @param $node
814
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
815 816 817 818 819
 * @param $hook
 *   A string containing the name of the hook.
 * @param $a2, $a3, $a4
 *   Arguments to pass on to the hook, after the $node argument.
 * @return
Dries's avatar
 
Dries committed
820
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
821
 */
822
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
823
  if (node_hook($node, $hook)) {
824
    $base = node_type_get_base($node);
825
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
826
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
827 828 829
  }
}

Dries's avatar
 
Dries committed
830
/**
831
 * Load node entities from the database.
832 833 834 835
 *
 * This function should be used whenever you need to load more than one node
 * from the database. Nodes are loaded into memory and will not require
 * database access if loaded again during the same page request.
Dries's avatar
 
Dries committed
836
 *
837 838
 * @see entity_load()
 *
839 840 841 842
 * @param $nids
 *   An array of node IDs.
 * @param $conditions
 *   An array of conditions on the {node} table in the form 'field' => $value.
Dries's avatar
 
Dries committed
843 844
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
845 846
 *
 * @return
847
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
848
 */
849
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
850
  return entity_load('node', $nids, $conditions, $reset);
851 852 853 854 855 856 857 858 859 860
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
861
 *   Whether to reset the node_load_multiple cache.
862 863 864 865
 *
 * @return
 *   A fully-populated node object.
 */
866 867 868 869 870
function node_load($nid = NULL, $vid = NULL, $reset = FALSE) {
  $nids = (isset($nid) ? array($nid) : array());
  $conditions = (isset($vid) ? array('vid' => $vid) : array());
  $node = node_load_multiple($nids, $conditions, $reset);
  return $node ? reset($node) : FALSE;
Dries's avatar
 
Dries committed
871 872
}

873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
/**
 * Prepares a node object for editing.
 *
 * Fills in a few default values, and then invokes hook_prepare() on the node
 * type module, and hook_node_prepare() on all modules.
 */
function node_object_prepare($node) {
  // Set up default values, if required.
  $node_options = variable_get('node_options_' . $node->type, array('status', 'promote'));
  // If this is a new node, fill in the default values.
  if (!isset($node->nid) || isset($node->is_new)) {
    foreach (array('status', 'promote', 'sticky') as $key) {
      // Multistep node forms might have filled in something already.
      if (!isset($node->$key)) {
        $node->$key = (int) in_array($key, $node_options);
      }
    }
    global $user;
    $node->uid = $user->uid;
    $node->created = REQUEST_TIME;
  }
  else {
    $node->date = format_date($node->created, 'custom', 'Y-m-d H:i:s O');
    // Remove the log message from the original node object.
    $node->log = NULL;
  }
  // Always use the default revision setting.
  $node->revision = in_array('revision', $node_options);

  node_invoke($node, 'prepare');
  module_invoke_all('node_prepare', $node);
}

906 907 908
/**
 * Perform validation checks on the given node.
 */
909
function node_validate($node, $form = array()) {
910
  $type = node_type_get_type($node);
911 912

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
913
    form_set_error('changed', t('The content on this page has either been modified by another user, or you have already submitted modifications using this form. As a result, your changes cannot be saved.'));
914 915
  }

916 917 918 919 920 921 922
  // Validate the "authored by" field.
  if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
    // The use of empty() is mandatory in the context of usernames
    // as the empty string denotes the anonymous user. In case we
    // are dealing with an anonymous user we set the user ID to 0.
    form_set_error('name', t('The username %name does not exist.', array('%name' => $node->name)));
  }
923

924 925 926
  // Validate the "authored on" field.
  if (!empty($node->date) && strtotime($node->date) === FALSE) {
    form_set_error('date', t('You have to specify a valid date.'));
927 928 929 930
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
931
  module_invoke_all('node_validate', $node, $form);
932 933 934
}

/**
935
 * Prepare node for saving by populating author and creation date.
936 937 938 939
 */
function node_submit($node) {
  global $user;

940
  // A user might assign the node author by entering a user name in the node
941 942
  // form, which we then need to translate to a user ID.
  if (isset($node->name)) {
943
    if ($account = user_load_by_name($node->name)) {
944 945 946 947 948 949
      $node->