node.module 102 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
/**
 * 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.
 */
16
define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
17

18 19 20
/**
 * Node is being built before being viewed normally.
 */
21
define('NODE_BUILD_NORMAL', 0);
22 23 24 25

/**
 * Node is being built before being previewed.
 */
26
define('NODE_BUILD_PREVIEW', 1);
27 28 29 30

/**
 * Node is being built before being indexed by search module.
 */
31
define('NODE_BUILD_SEARCH_INDEX', 2);
32 33 34 35

/**
 * Node is being built before being displayed as a search result.
 */
36
define('NODE_BUILD_SEARCH_RESULT', 3);
37 38 39 40

/**
 * Node is being built before being displayed as part of an RSS feed.
 */
41
define('NODE_BUILD_RSS', 4);
42 43 44 45

/**
 * Node is being built before being printed.
 */
Dries's avatar
Dries committed
46
define('NODE_BUILD_PRINT', 5);
47

Dries's avatar
 
Dries committed
48
/**
49
 * Implement hook_help().
Dries's avatar
 
Dries committed
50
 */
51
function node_help($path, $arg) {
52 53 54 55
  // 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.
  if ($path != 'admin/content/node-settings/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
56 57 58 59 60 61 62 63 64 65
      && user_access('access administration pages') && node_access_needs_rebuild()) {
    if ($path == 'admin/content/node-settings') {
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
      $message = t('The content access permissions need to be rebuilt. Please visit <a href="@node_access_rebuild">this page</a>.', array('@node_access_rebuild' => url('admin/content/node-settings/rebuild')));
    }
    drupal_set_message($message, 'error');
  }

66
  switch ($path) {
Dries's avatar
 
Dries committed
67
    case 'admin/help#node':
68 69 70 71
      $output = '<p>' . t('The node module manages content on your site, and stores all posts (regardless of type) as a "node" . In addition to basic publishing settings, including whether the post has been published, promoted to the site front page, or should remain present (or sticky) at the top of lists, the node module also records basic information about the author of a post. Optional revision control over edits is available. For additional functionality, the node module is often extended by other modules.') . '</p>';
      $output .= '<p>' . t('Though each post on your site is a node, each post is also of a particular <a href="@content-type">content type</a>. <a href="@content-type">Content types</a> are used to define the characteristics of a post, including the title and description of the fields displayed on its add and edit pages. Each content type may have different default settings for <em>Publishing options</em> and other workflow controls. By default, the two content types in a standard Drupal installation are <em>Page</em> and <em>Story</em>. Use the <a href="@content-type">content types page</a> to add new or edit existing content types. Additional content types also become available as you enable additional core, contributed and custom modules.', array('@content-type' => url('admin/build/types'))) . '</p>';
      $output .= '<p>' . t('The administrative <a href="@content">content page</a> allows you to review and manage your site content. The <a href="@post-settings">post settings page</a> sets certain options for the display of posts. The node module makes a number of permissions available for each content type, which may be set by role on the <a href="@permissions">permissions page</a>.', array('@content' => url('admin/content/node'), '@post-settings' => url('admin/content/node-settings'), '@permissions' => url('admin/user/permissions'))) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) . '</p>';
Dries's avatar
 
Dries committed
72
      return $output;
73 74
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
75
    case 'admin/build/types/add':
76
      return '<p>' . t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.') . '</p>';
77
    case 'node/%/revisions':
78
      return '<p>' . t('The revisions let you track differences between multiple versions of a post.') . '</p>';
79 80
    case 'node/%/edit':
      $node = node_load($arg[1]);
81
      $type = node_type_get_type($node);
82
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
83
  }
Dries's avatar
 
Dries committed
84

85
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
86
    $type = node_type_get_type(str_replace('-', '_', $arg[2]));
87
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
88
  }
Dries's avatar
 
Dries committed
89 90
}

91
/**
92
 * Implement hook_theme().
93 94 95
 */
function node_theme() {
  return array(
96
    'node' => array(
97
      'arguments' => array('elements' => NULL),
98
      'template' => 'node',
99
    ),
100 101 102 103 104 105 106 107
    'node_list' => array(
      'arguments' => array('items' => NULL, 'title' => NULL),
    ),
    'node_search_admin' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_filter_form' => array(
      'arguments' => array('form' => NULL),
108
      'file' => 'node.admin.inc',
109 110 111
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
112
      'file' => 'node.admin.inc',
113 114 115
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
116
      'file' => 'node.admin.inc',
117 118 119
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
120
      'file' => 'node.pages.inc',
121 122 123
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
124
      'file' => 'node.pages.inc',
125 126 127
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
128
      'file' => 'node.pages.inc',
129 130 131 132
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
133 134 135
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
136 137 138
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
139 140 141
    'node_links' => array(
      'arguments' => array('element' => NULL),
    ),
142 143 144
  );
}

Dries's avatar
 
Dries committed
145
/**
146
 * Implement hook_cron().
Dries's avatar
 
Dries committed
147
 */
148
function node_cron() {
149 150 151
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
152 153
}

Dries's avatar
 
Dries committed
154
/**
155
 * Implement hook_fieldable_info().
Dries's avatar
 
Dries committed
156 157 158 159 160 161 162 163 164 165 166 167
 */
function node_fieldable_info() {
  $return = array(
    'node' => array(
      'name' => t('Node'),
      'id key' => 'nid',
      'revision key' => 'vid',
      'bundle key' => 'type',
      // Node.module handles its own caching.
      // 'cacheable' => FALSE,
      // Bundles must provide human readable name so
      // we can create help and error messages about them.
168
      'bundles' => node_type_get_names(),
Dries's avatar
 
Dries committed
169 170 171 172 173 174 175
    ),
  );
  return $return;
}


/**
176
 * Implement hook_field_build_modes().
Dries's avatar
 
Dries committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
 */
function node_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'node') {
    $modes = array(
      'teaser' => t('Teaser'),
      'full' => t('Full node'),
      NODE_BUILD_RSS => t('RSS'),
      NODE_BUILD_PRINT => t('Print'),
    );
    if (module_exists('search')) {
      $modes += array(
        NODE_BUILD_SEARCH_INDEX => t('Search Index'),
        NODE_BUILD_SEARCH_RESULT => t('Search Result'),
      );
    }
  }
  return $modes;
}

Dries's avatar
 
Dries committed
197 198 199 200
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
201 202 203 204
 *   A DB result object from a query to fetch node objects. If your query
 *   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
205 206 207 208
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
209 210
 *   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
211
 */
Dries's avatar
 
Dries committed
212
function node_title_list($result, $title = NULL) {
213
  $items = array();
214
  $num_rows = FALSE;
215
  foreach ($result as $node) {
216
    $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());
217
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
218 219
  }

220
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
221 222
}

Dries's avatar
 
Dries committed
223 224
/**
 * Format a listing of links to nodes.
225 226
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
227
 */
Dries's avatar
 
Dries committed
228
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
229
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
230 231
}

Dries's avatar
 
Dries committed
232 233 234
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
235 236 237 238
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
239 240 241 242 243 244 245
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
246 247 248
  }
}

Dries's avatar
 
Dries committed
249 250 251 252
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
253 254
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
255
  static $history;
Dries's avatar
 
Dries committed
256

Dries's avatar
 
Dries committed
257
  if (!isset($history[$nid])) {
258
    $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
259 260
  }

261
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
262 263 264
}

/**
265
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
266
 *
Dries's avatar
 
Dries committed
267 268 269 270
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
271 272
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
273
 */
274
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
275 276 277
  global $user;
  static $cache;

278 279 280
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
281
  if (!isset($cache[$nid])) {
282
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
283
  }
284 285 286 287 288 289 290
  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
291 292
}

293
/**
294
 * Extract the type name.
295 296
 *
 * @param $node
297
 *   Either a string or object, containing the node type information.
298 299
 *
 * @return
300
 *   Node type of the passed in data.
301
 */
302 303 304
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
305

306 307 308 309 310 311
/**
 * Clear the statically cached node type information.
 */
function node_type_clear() {
  drupal_static_reset('_node_types_build');
}
312

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
/**
 * Returns a list of all the available node types.
 *
 * @return
 *   An array of node types, keyed by the type.
 * @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.
 *
 *@param $node
 *   A node object or string that indicates the node type to return.
 * @return
 *   A single node type, as an object or FALSE if the node type is not found.
 *   The node type is an array with following content:
 *
 *   @code
 *   array(
 *     'type' => 'Machine readable type name',
 *     'name' => 'Name of the node type',
 *     'base' => 'Indicates to which module this node type belongs',
 *     'description' => 'Description of the node type',
 *     // ...
 *   )
 *   @endcode
 */
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.
 *
 * The base indicates which module implement this node type and is used to
 * execute node type specific hooks.
 *
 * @see node_invoke()
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
 * @return
 *   The node type base or FALSE if the node type is not found.
 */
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;
}

/**
 * Returns a list of available node names.
 *
 * @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;
391 392 393 394 395 396 397
}

/**
 * Resets the database cache of node types, and saves all new or non-modified
 * module-defined node types to the database.
 */
function node_types_rebuild() {
398 399 400
  // Reset and load updated node types.
  node_type_clear();
  foreach (node_type_get_types() as $type => $info) {
401 402 403
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
404 405 406
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
407
  }
408 409 410
  // Reset cached node type information so that the next access
  // will use the updated data.
  node_type_clear();
411 412
  // This is required for proper menu items at node/add/type.
  menu_rebuild();
413 414
}

415
/**
416 417 418 419
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
420 421
 *
 * @return
422
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
423
 */
424 425 426
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
427
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', array(':type' => $existing_type), 0, 1)->fetchField();
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
  $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,
    'has_body' => (int) $type->has_body,
    'body_label' => (string) $type->body_label,
    'description' => (string) $type->description,
    'help' => (string) $type->help,
    'min_word_count' => (int) $type->min_word_count,
    'custom' => (int) $type->custom,
    'modified' => (int) $type->modified,
    'locked' => (int) $type->locked,
  );
445 446

  if ($is_existing) {
447 448 449 450
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
451

Dries's avatar
 
Dries committed
452 453 454
    if (!empty($type->old_type) && $type->old_type != $type->type) {
      field_attach_rename_bundle($type->old_type, $type->type);
    }
455
    node_configure_fields($type);
456
    module_invoke_all('node_type', 'update', $type);
457 458 459
    return SAVED_UPDATED;
  }
  else {
460
    $fields['orig_type'] = (string) $type->orig_type;
461 462 463
    db_insert('node_type')
      ->fields($fields)
      ->execute();
464

Dries's avatar
 
Dries committed
465
    field_attach_create_bundle($type->type);
466
    node_configure_fields($type);
467
    module_invoke_all('node_type', 'insert', $type);
468 469
    return SAVED_NEW;
  }
470
}
471

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
/**
 * Manage the field(s) for a node type.
 *
 * Currently, the node module manages a single Field API field,
 * 'body'.  If $type->has_body is true, this function ensures the
 * 'body' field exists and creates an instance of it for the bundle
 * $type->type (e.g. 'page', 'story', ...).  If $type->has_body is
 * false, this function removes the instance (if it exists) for the
 * 'body' field on $type->type.
 */
function node_configure_fields($type) {
   // Add or remove the body field, as needed.
  $field = field_info_field('body');
  $instance = field_info_instance('body', $type->type);
  if ($type->has_body) {
    if (empty($field)) {
      $field = array(
        'field_name' => 'body',
        'type' => 'text_with_summary',
      );
      $field = field_create_field($field);
    }
    if (empty($instance)) {
      $instance = array(
        'field_name' => 'body',
        'bundle' => $type->type,
        'label' => $type->body_label,
        'widget_type' => 'text_textarea_with_summary',
        'settings' => array('display_summary' => TRUE),

        // With no UI in core, we have to define default
        // formatters for the teaser and full view.
        // This may change if the method of handling displays
        // is changed or if a UI gets into core.
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
            'exclude' => 0,
            ),
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
            'exclude' => 0,
            ),
          ),
        );
      field_create_instance($instance);
    }
    else {
      $instance['label'] = $type->body_label;
      $instance['settings']['display_summary'] = TRUE;
      field_update_instance($instance);
    }
  }
  elseif (!empty($instance)) {
    field_delete_instance($instance);
  }

}

533 534 535 536 537 538 539
/**
 * 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) {
540
  $info = node_type_get_type($type);
541 542 543
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
544 545 546
  module_invoke_all('node_type', 'delete', $info);
}

547
/**
548 549
 * Updates all nodes of one type to be of another type.
 *
550
 * @param $old_type
551 552 553
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
554 555
 *
 * @return
556
 *   The number of nodes whose node type field was modified.
557
 */
558
function node_type_update_nodes($old_type, $type) {
559 560 561 562
  db_update('node')
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
563
  return db_affected_rows();
Dries's avatar
 
Dries committed
564
}
Dries's avatar
 
Dries committed
565

566
/**
567 568 569 570
 * Builds and returns the list of available node types.
 *
 * The list of types is built by querying hook_node_info() in all modules, and
 * by comparing this information with the node types in the {node_type} table.
Dries's avatar
 
Dries committed
571 572
 *
 */
573
function _node_types_build() {
574
  $_node_types = &drupal_static(__FUNCTION__);
575 576 577 578
  if (is_object($_node_types)) {
    return $_node_types;
  }
  $_node_types = (object) array('types' => array(), 'names' => array());
579 580 581 582

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
583 584
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
585
  }
586 587 588 589 590 591
  $type_result = db_select('node_type', 'nt')
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->addTag('node_type_access')
    ->execute();
  foreach ($type_result as $type_object) {
592 593
    // 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
594 595 596
    // 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])) {
597
      $type_object->disabled = TRUE;
598
    }
599 600 601
    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;
602 603

      if ($type_object->type != $type_object->orig_type) {
604 605
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
606 607 608 609
      }
    }
  }

610
  asort($_node_types->names);
611

612
  return $_node_types;
613 614 615
}

/**
616 617 618 619 620 621 622 623 624 625 626
 * 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.
627
 */
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
function node_type_set_defaults($info = array()) {
  static $type;

  if (!isset($type)) {
    $type = new stdClass();
    $type->type = '';
    $type->name = '';
    $type->base = '';
    $type->description = '';
    $type->help = '';
    $type->min_word_count = 0;
    $type->has_title = 1;
    $type->has_body = 1;
    $type->title_label = t('Title');
    $type->body_label = t('Body');
    $type->custom = 0;
    $type->modified = 0;
    $type->locked = 1;
    $type->is_new = 1;
  }

  $new_type = clone $type;
  $info = (array) $info;
  foreach ($info as $key => $data) {
    $new_type->$key = $data;
  }
  // If the type has no title or body, set an empty label.
  if (!$new_type->has_title) {
    $new_type->title_label = '';
  }
  if (!$new_type->has_body) {
    $new_type->body_label = '';
  }
  $new_type->orig_type = isset($info['type']) ? $info['type'] : '';

  return $new_type;
Dries's avatar
 
Dries committed
664
}
Dries's avatar
 
Dries committed
665

666
/**
Dries's avatar
 
Dries committed
667 668
 * Determine whether a node hook exists.
 *
669
 * @param $node
Dries's avatar
 
Dries committed
670 671 672 673
 *   Either a node object, node array, or a string containing the node type.
 * @param $hook
 *   A string containing the name of the hook.
 * @return
674
 *   TRUE if the $hook exists in the node type of $node.
Dries's avatar
 
Dries committed
675
 */
676
function node_hook($node, $hook) {
677
  $base = node_type_get_base($node);
678
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
679 680
}

681
/**
Dries's avatar
 
Dries committed
682 683
 * Invoke a node hook.
 *
684
 * @param $node
Dries's avatar
 
Dries committed
685 686 687 688 689 690
 *   Either a node object, node array, or a string containing the node type.
 * @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
691
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
692
 */
693
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
694
  if (node_hook($node, $hook)) {
695
    $base = node_type_get_base($node);
696
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
697
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
698 699 700
  }
}

Dries's avatar
 
Dries committed
701
/**
702 703 704 705 706
 * Load node objects from the database.
 *
 * 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
707
 *
708 709 710 711
 * @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
712 713
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
714 715
 *
 * @return
716
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
717
 */
718
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
719 720
  $node_cache = &drupal_static(__FUNCTION__, array());

Dries's avatar
 
Dries committed
721
  if ($reset) {
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
    $node_cache = array();
  }
  $nodes = array();

  // Create a new variable which is either a prepared version of the $nids
  // array for later comparison with the node cache, or FALSE if no $nids were
  // passed. The $nids array is reduced as items are loaded from cache, and we
  // need to know if it's empty for this reason to avoid querying the database
  // when all requested nodes are loaded from cache.
  $passed_nids = !empty($nids) ? array_flip($nids) : FALSE;

  // Revisions are not statically cached, and require a different query to
  // other conditions, so separate vid into its own variable.
  $vid = isset($conditions['vid']) ? $conditions['vid'] : FALSE;
  unset($conditions['vid']);

  // Load any available nodes from the internal cache.
  if ($node_cache && !$vid) {
    if ($nids) {
      $nodes += array_intersect_key($node_cache, $passed_nids);
      // If any nodes were loaded, remove them from the $nids still to load.
      $nids = array_keys(array_diff_key($passed_nids, $nodes));
    }
    // If loading nodes only by conditions, fetch all available nodes from
    // the cache. Nodes which don't match are removed later.
    elseif ($conditions) {
      $nodes = $node_cache;
    }
Dries's avatar
 
Dries committed
750 751
  }

752
  // Exclude any nodes loaded from cache if they don't match $conditions.
753
  // This ensures the same behavior whether loading from memory or database.
754 755 756 757 758
  if ($conditions) {
    foreach ($nodes as $node) {
      $node_values = (array) $node;
      if (array_diff_assoc($conditions, $node_values)) {
        unset($nodes[$node->nid]);
759
      }
760
    }
Dries's avatar
 
Dries committed
761 762
  }

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
  // Load any remaining nodes from the database. This is the case if there are
  // any $nids left to load, if loading a revision, or if $conditions was
  // passed without $nids.
  if ($nids || $vid || ($conditions && !$passed_nids)) {
    $query = db_select('node', 'n');

    if ($vid) {
      $query->join('node_revision', 'r', 'r.nid = n.nid AND r.vid = :vid', array(':vid' => $vid));
    }
    else {
      $query->join('node_revision', 'r', 'r.vid = n.vid');
    }

    // Add fields from the {node} table.
    $node_fields = drupal_schema_fields_sql('node');

    // vid and title are provided by node_revision, so remove them.
    unset($node_fields['vid']);
    unset($node_fields['title']);
    $query->fields('n', $node_fields);

    // Add all fields from the {node_revision} table.
    $node_revision_fields = drupal_schema_fields_sql('node_revision');

    // nid is provided by node, so remove it.
    unset($node_revision_fields['nid']);

    // Change timestamp to revision_timestamp before adding it to the query.
    unset($node_revision_fields['timestamp']);
    $query->addField('r', 'timestamp', 'revision_timestamp');
    $query->fields('r', $node_revision_fields);

    if ($nids) {
      $query->condition('n.nid', $nids, 'IN');
    }
    if ($conditions) {
      foreach ($conditions as $field => $value) {
        $query->condition('n.' . $field, $value);
801
      }
Dries's avatar
 
Dries committed
802
    }
803 804 805 806
    $queried_nodes = $query->execute()->fetchAllAssoc('nid');
  }

  // Pass all nodes loaded from the database through the node type specific
807
  // callbacks and hook_node_load(), then add them to the internal cache.
808 809 810 811 812 813 814
  if (!empty($queried_nodes)) {
    // Create an array of nodes for each content type and pass this to the
    // node type specific callback.
    $typed_nodes = array();
    foreach ($queried_nodes as $nid => $node) {
      $typed_nodes[$node->type][$nid] = $node;
    }
Dries's avatar
 
Dries committed
815

816 817 818
    // Call node type specific callbacks on each typed array of nodes.
    foreach ($typed_nodes as $type => $nodes_of_type) {
      if (node_hook($type, 'load')) {
819
        $function = node_type_get_base($type) . '_load';
820
        $function($nodes_of_type);
821 822
      }
    }
823

Dries's avatar
 
Dries committed
824 825 826 827 828 829 830 831
    // Attach fields.
    if ($vid) {
      field_attach_load_revision('node', $queried_nodes);
    }
    else {
      field_attach_load('node', $queried_nodes);
    }

832
    // Call hook_node_load(), pass the node types so modules can return early
833
    // if not acting on types in the array.
834 835
    foreach (module_implements('node_load') as $module) {
      $function = $module . '_node_load';
836 837 838 839 840 841
      $function($queried_nodes, array_keys($typed_nodes));
    }
    $nodes += $queried_nodes;
    // Add nodes to the cache if we're not loading a revision.
    if (!$vid) {
      $node_cache += $queried_nodes;
842
    }
Dries's avatar
 
Dries committed
843 844
  }

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
  // Ensure that the returned array is ordered the same as the original $nids
  // array if this was passed in and remove any invalid nids.
  if ($passed_nids) {
    // Remove any invalid nids from the array.
    $passed_nids = array_intersect_key($passed_nids, $nodes);
    foreach ($nodes as $node) {
      $passed_nids[$node->nid] = $node;
    }
    $nodes = $passed_nids;
  }

  return $nodes;
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
867
 *   Whether to reset the node_load_multiple cache.
868 869 870 871 872 873 874 875 876
 *
 * @return
 *   A fully-populated node object.
 */
function node_load($nid, $vid = array(), $reset = FALSE) {
  $vid = isset($vid) ? array('vid' => $vid) : NULL;
  $node = node_load_multiple(array($nid), $vid, $reset);

  return $node ? $node[$nid] : FALSE;
Dries's avatar
 
Dries committed
877 878
}

879 880 881 882 883 884
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
  // Convert the node to an object, if necessary.
  $node = (object)$node;
885
  $type = node_type_get_type($node);
886 887

  // Make sure the body has the minimum number of words.
888
  // TODO : use a better word counting algorithm that will work in other languages
889 890
  if (!empty($type->min_word_count) && isset($node->body[0]['value']) && count(explode(' ', $node->body[0]['value'])) < $type->min_word_count) {
    // TODO: Use Field API to set this error.
891 892 893 894
    form_set_error('body', t('The body of your @type is too short. You need at least %words words.', array('%words' => $type->min_word_count, '@type' => $type->name)));
  }

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
895
    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.'));
896 897 898 899
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
900
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
901 902 903 904 905 906
      // 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)));
    }

907 908
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
909 910 911 912 913 914
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
915
  module_invoke_all('node_validate', $node, $form);
916 917 918 919 920 921 922 923 924 925 926 927 928
}

/**
 * Prepare node for save and allow modules to make changes.
 */
function node_submit($node) {
  global $user;

  // Convert the node to an object, if necessary.
  $node = (object)$node;

  if (user_access('administer nodes')) {
    // Populate the "authored by" field.
929
    if ($account = user_load_by_name($node->name)) {
930 931 932 933 934 935
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
936
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
937 938 939 940 941
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
942
/**
943 944 945 946 947
 * Save changes to a node or add a new node.
 *
 * @param $node
 *   The $node object to be saved. If $node->nid is
 *   omitted (or $node->is_new is TRUE), a new node will be added.
Dries's avatar
 
Dries committed
948
 */
949
function node_save($node) {
Dries's avatar
 
Dries committed
950
  field_attach_presave('node', $node);
951
  // Let modules modify the node before it is saved to the database.
952
  module_invoke_all('node_presave', $node);
953
  global $user;
Dries's avatar
 
Dries committed
954

955
  if (!isset($node->is_new)) {
956
    $node->is_new = empty($node->nid);
957
  }
Dries's avatar
 
Dries committed
958

Dries's avatar
 
Dries committed
959
  // Apply filters to some default node fields:
960
  if ($node->is_new) {
Dries's avatar
 
Dries committed
961
    // Insert a new node.
962
    $node->is_new = TRUE;
963 964

    // When inserting a node, $node->log must be set because
965
    // {node_revision}.log does not (and cannot) have a default
966
    // value. If the user does not have permission to create
967 968 969 970 971
    // revisions, however, the form will not contain an element for
    // log so $node->log will be unset at this point.
    if (!isset($node->log)) {
      $node->log = '';
    }
972
  }
973 974
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
975
    unset($node->vid);
976
  }
977
  else {
978
    // When updating a node, avoid clobbering an existing log entry with an empty one.
979 980
    if (empty($node->log)) {
      unset($node->log);
981
    }
Dries's avatar
 
Dries committed
982 983
  }

984 985
  // Set some required fields:
  if (empty($node->created)) {
986
    $node->created = REQUEST_TIME;
987
  }
988
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
989
  $node->changed = REQUEST_TIME;
Dries's avatar
 
Dries committed
990

991
  $node->timestamp = REQUEST_TIME;
992
  $update_node = TRUE;
993

994
  // Generate the node table query and the node_revisions table query.
995
  if ($node->is_new) {
996
    drupal_write_record('node', $node);
997
    _node_save_revision($node, $user->uid);
998
    $op = 'insert';
999 1000
  }
  else {
1001
    drupal_write_record('node', $node, 'nid');
1002
    if (!empty($node->revision)) {
1003
      _node_save_revision($node, $user->uid);
1004 1005
    }
    else {
1006
      _node_save_revision($node, $user->uid, 'vid');
1007
      $update_node = FALSE;
Dries's avatar
 
Dries committed
1008
    }
1009
    $op = 'update';
1010
  }
1011
  if ($update_node) {
1012 1013 1014 1015
    db_update('node')
      ->fields(array('vid' =>