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

Dries's avatar
 
Dries committed
18
/**
19
 * Implement hook_help().
Dries's avatar
 
Dries committed
20
 */
21
function node_help($path, $arg) {
22 23 24
  // 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.
25
  if ($path != 'admin/reports/status/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
26
      && user_access('access administration pages') && node_access_needs_rebuild()) {
27
    if ($path == 'admin/reports/status') {
28 29 30
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
31
      $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/reports/status/rebuild')));
32 33 34 35
    }
    drupal_set_message($message, 'error');
  }

36
  switch ($path) {
Dries's avatar
 
Dries committed
37
    case 'admin/help#node':
38
      $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>';
39
      $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/structure/types'))) . '</p>';
40
      $output .= '<p>' . t('The administrative <a href="@content">content page</a> allows you to review and manage your site content. 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'), '@permissions' => url('admin/settings/permissions'))) . '</p>';
41
      $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
42
      return $output;
43

44
    case 'admin/content':
45
      return ' '; // Return a non-null value so that the 'more help' link is shown.
46

47
    case 'admin/structure/types/add':
48
      return '<p>' . t('Each piece of content is of a specific content type. Each <em>content type</em> can have different fields, behaviors, and permissions assigned to it.') . '</p>';
49 50 51 52 53 54 55 56 57 58

    case 'admin/structure/node-type/' . $arg[3] . '/fields':
      return '<p>' . t('This form lets you add, edit, and arrange fields within the %type content type.', array('%type' => node_type_get_name($arg[3]))) . '</p>';

    case 'admin/structure/node-type/' . $arg[3] . '/display':
      return '<p>' . t('This form lets you configure how fields and labels are displayed when %type content is viewed in teaser and full-page mode.', array('%type' => node_type_get_name($arg[3]))) . '</p>';

    case 'admin/structure/node-type/' . $arg[3] . '/display/' . $arg[5]:
      return '<p>' . t('This form lets you configure how fields should be displayed when rendered %type content in the following contexts.', array('%type' => node_type_get_name($arg[3]))) . '</p>';

59
    case 'node/%/revisions':
60
      return '<p>' . t('The revisions let you track differences between multiple versions of a post.') . '</p>';
61

62 63
    case 'node/%/edit':
      $node = node_load($arg[1]);
64
      $type = node_type_get_type($node);
65
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
66
  }
Dries's avatar
 
Dries committed
67

68
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
69
    $type = node_type_get_type(str_replace('-', '_', $arg[2]));
70
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
71
  }
Dries's avatar
 
Dries committed
72 73
}

74
/**
75
 * Implement hook_theme().
76 77 78
 */
function node_theme() {
  return array(
79
    'node' => array(
80
      'arguments' => array('elements' => NULL),
81
      'template' => 'node',
82
    ),
83 84 85 86 87 88 89 90
    '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),
91
      'file' => 'node.admin.inc',
92 93 94
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
95
      'file' => 'node.admin.inc',
96 97 98
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
99
      'file' => 'node.admin.inc',
100 101 102
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
103
      'file' => 'node.pages.inc',
104 105 106
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
107
      'file' => 'node.pages.inc',
108 109 110
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
111
      'file' => 'node.pages.inc',
112 113 114 115
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
116 117 118
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
119 120 121
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
122 123 124
  );
}

Dries's avatar
 
Dries committed
125
/**
126
 * Implement hook_cron().
Dries's avatar
 
Dries committed
127
 */
128
function node_cron() {
129 130 131
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
132 133
}

Dries's avatar
 
Dries committed
134
/**
135
 * Implement hook_fieldable_info().
Dries's avatar
 
Dries committed
136 137 138 139
 */
function node_fieldable_info() {
  $return = array(
    'node' => array(
140 141 142 143 144 145
      'label' => t('Node'),
      'object keys' => array(
        'id' => 'nid',
        'revision' => 'vid',
        'bundle' => 'type',
      ),
Dries's avatar
 
Dries committed
146 147
      // Node.module handles its own caching.
      // 'cacheable' => FALSE,
148
      'bundles' => array(),
Dries's avatar
 
Dries committed
149 150
    ),
  );
151 152 153 154 155 156
  // 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(
157
        'path' => 'admin/structure/node-type/' . str_replace('_', '-', $type),
158 159 160 161
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
162 163 164 165 166
  return $return;
}


/**
167
 * Implement hook_field_build_modes().
Dries's avatar
 
Dries committed
168 169 170 171 172 173 174
 */
function node_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'node') {
    $modes = array(
      'teaser' => t('Teaser'),
      'full' => t('Full node'),
175
      'rss' => t('RSS'),
Dries's avatar
 
Dries committed
176
    );
177 178
    // Search integration is provided by node.module, so search-related
    // build-modes for nodes are defined here and not in search.module.
Dries's avatar
 
Dries committed
179 180
    if (module_exists('search')) {
      $modes += array(
181 182
        'search_index' => t('Search Index'),
        'search_result' => t('Search Result'),
Dries's avatar
 
Dries committed
183 184 185 186 187 188
      );
    }
  }
  return $modes;
}

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
/**
 * Implement hook_field_extra_fields().
 */
function node_field_extra_fields($bundle) {
  $extra = array();

  if ($type = node_type_get_type($bundle)) {
    if ($type->has_title) {
      $extra['title'] = array(
        'label' => $type->title_label,
        'description' => t('Node module element.'),
        'weight' => -5,
      );
    }
  }

  return $extra;
}

Dries's avatar
 
Dries committed
208 209 210 211
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
212 213 214 215
 *   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
216 217 218 219
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
220 221
 *   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
222
 */
Dries's avatar
 
Dries committed
223
function node_title_list($result, $title = NULL) {
224
  $items = array();
225
  $num_rows = FALSE;
226
  foreach ($result as $node) {
227
    $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());
228
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
229 230
  }

231
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
232 233
}

Dries's avatar
 
Dries committed
234 235
/**
 * Format a listing of links to nodes.
236 237
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
238
 */
Dries's avatar
 
Dries committed
239
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
240
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
241 242
}

Dries's avatar
 
Dries committed
243 244 245
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
246 247 248 249
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
250 251 252 253 254 255 256
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
257 258 259
  }
}

Dries's avatar
 
Dries committed
260 261 262 263
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
264 265
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
266
  static $history;
Dries's avatar
 
Dries committed
267

Dries's avatar
 
Dries committed
268
  if (!isset($history[$nid])) {
269
    $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
270 271
  }

272
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
273 274 275
}

/**
276
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
277
 *
Dries's avatar
 
Dries committed
278 279 280 281
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
282 283
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
284
 */
285
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
286 287 288
  global $user;
  static $cache;

289 290 291
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
292
  if (!isset($cache[$nid])) {
293
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
294
  }
295 296 297 298 299 300 301
  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
302 303
}

304
/**
305
 * Extract the type name.
306 307
 *
 * @param $node
308
 *   Either a string or object, containing the node type information.
309 310
 *
 * @return
311
 *   Node type of the passed in data.
312
 */
313 314 315
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
316

317 318 319 320 321 322
/**
 * Clear the statically cached node type information.
 */
function node_type_clear() {
  drupal_static_reset('_node_types_build');
}
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 391 392 393 394 395 396 397 398 399 400 401
/**
 * 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;
402 403 404 405 406 407 408
}

/**
 * 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() {
409 410 411
  // Reset and load updated node types.
  node_type_clear();
  foreach (node_type_get_types() as $type => $info) {
412 413 414
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
415 416 417
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
418
  }
419 420 421
  // Reset cached node type information so that the next access
  // will use the updated data.
  node_type_clear();
422 423
  // This is required for proper menu items at node/add/type.
  menu_rebuild();
424 425
}

426
/**
427 428 429 430
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
431 432
 *
 * @return
433
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
434
 */
435 436 437
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
438
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', array(':type' => $existing_type), 0, 1)->fetchField();
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  $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,
    'custom' => (int) $type->custom,
    'modified' => (int) $type->modified,
    'locked' => (int) $type->locked,
  );
455 456

  if ($is_existing) {
457 458 459 460
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
461

Dries's avatar
 
Dries committed
462 463 464
    if (!empty($type->old_type) && $type->old_type != $type->type) {
      field_attach_rename_bundle($type->old_type, $type->type);
    }
465
    node_configure_fields($type);
466
    module_invoke_all('node_type_update', $type);
467 468 469
    return SAVED_UPDATED;
  }
  else {
470
    $fields['orig_type'] = (string) $type->orig_type;
471 472 473
    db_insert('node_type')
      ->fields($fields)
      ->execute();
474

Dries's avatar
 
Dries committed
475
    field_attach_create_bundle($type->type);
476
    node_configure_fields($type);
477
    module_invoke_all('node_type_insert', $type);
478 479
    return SAVED_NEW;
  }
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
/**
 * 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',
520
          ),
521 522 523 524
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
525 526
        ),
      );
527 528 529 530 531 532 533 534 535 536 537 538 539 540
      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);
  }

}

541 542 543 544 545 546 547
/**
 * 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) {
548
  $info = node_type_get_type($type);
549 550 551
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
552
  module_invoke_all('node_type_delete', $info);
553 554
}

555
/**
556 557
 * Updates all nodes of one type to be of another type.
 *
558
 * @param $old_type
559 560 561
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
562 563
 *
 * @return
564
 *   The number of nodes whose node type field was modified.
565
 */
566
function node_type_update_nodes($old_type, $type) {
567
  return db_update('node')
568 569 570
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
571
}
Dries's avatar
 
Dries committed
572

573
/**
574 575 576 577
 * 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
578 579
 *
 */
580
function _node_types_build() {
581
  $_node_types = &drupal_static(__FUNCTION__);
582 583 584 585
  if (is_object($_node_types)) {
    return $_node_types;
  }
  $_node_types = (object) array('types' => array(), 'names' => array());
586 587 588 589

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

      if ($type_object->type != $type_object->orig_type) {
611 612
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
613 614 615 616
      }
    }
  }

617
  asort($_node_types->names);
618

619
  return $_node_types;
620 621 622
}

/**
623 624 625 626 627 628 629 630 631 632 633
 * 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.
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 664 665 666 667 668 669
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->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
670
}
Dries's avatar
 
Dries committed
671

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

687
/**
Dries's avatar
 
Dries committed
688 689
 * Invoke a node hook.
 *
690
 * @param $node
Dries's avatar
 
Dries committed
691 692 693 694 695 696
 *   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
697
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
698
 */
699
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
700
  if (node_hook($node, $hook)) {
701
    $base = node_type_get_base($node);
702
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
703
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
704 705 706
  }
}

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

Dries's avatar
 
Dries committed
727
  if ($reset) {
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
    $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
756 757
  }

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

769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
  // 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');

785 786 787 788 789
    // The columns vid, title, status, comment, promote, moderate, and sticky
    // are all provided by node_revision, so remove them.
    foreach (array('vid', 'title', 'status', 'comment', 'promote', 'moderate', 'sticky') as $column) {
      unset($node_fields[$column]);
    }
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
    $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);
809
      }
Dries's avatar
 
Dries committed
810
    }
811 812 813 814
    $queried_nodes = $query->execute()->fetchAllAssoc('nid');
  }

  // Pass all nodes loaded from the database through the node type specific
815
  // callbacks and hook_node_load(), then add them to the internal cache.
816 817 818 819 820 821 822
  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
823

824 825 826
    // Call node type specific callbacks on each typed array of nodes.
    foreach ($typed_nodes as $type => $nodes_of_type) {
      if (node_hook($type, 'load')) {
827
        $function = node_type_get_base($type) . '_load';
828
        $function($nodes_of_type);
829 830
      }
    }
831

Dries's avatar
 
Dries committed
832 833 834 835 836 837 838 839
    // Attach fields.
    if ($vid) {
      field_attach_load_revision('node', $queried_nodes);
    }
    else {
      field_attach_load('node', $queried_nodes);
    }

840
    // Call hook_node_load(), pass the node types so modules can return early
841
    // if not acting on types in the array.
842 843
    foreach (module_implements('node_load') as $module) {
      $function = $module . '_node_load';
844 845 846 847 848 849
      $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;
850
    }
Dries's avatar
 
Dries committed
851 852
  }

853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
  // 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
875
 *   Whether to reset the node_load_multiple cache.
876 877 878 879 880 881 882 883 884
 *
 * @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
885 886
}

887 888 889 890 891 892
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
  // Convert the node to an object, if necessary.
  $node = (object)$node;
893
  $type = node_type_get_type($node);
894 895

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

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

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

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

/**
 * 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.
930
    if ($account = user_load_by_name($node->name)) {
931 932 933 934 935 936
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
937
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
938 939 940 941 942
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
943
/**
944 945 946 947 948
 * 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
949
 */
950
function node_save($node) {
Dries's avatar
 
Dries committed
951
  field_attach_presave('node', $node);
952
  // Let modules modify the node before it is saved to the database.
953
  module_invoke_all('node_presave', $node);
954
  global $user;
Dries's avatar
 
Dries committed
955

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

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

    // When inserting a node, $node->log must be set because
966
    // {node_revision}.log does not (and cannot) have a default
967
    // value. If the user does not have permission to create
968 969 970 971 972
    // 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 = '';
    }
973
  }
974 975
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
976
    unset($node->vid);
977
  }
978
  else {
979
    // When updating a node, avoid clobbering an existing log entry with an empty one.
980 981
    if (empty($node->log)) {
      unset($node->log);
982
    }
Dries's avatar
 
Dries committed
983 984
  }

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

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

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

1019 1020 1021
  // Call the node specific callback (if any). This can be
  // node_invoke($node, 'insert') or
  // node_invoke($node, 'update').
1022
  node_invoke($node, $op);
Dries's avatar
 
Dries committed
1023 1024 1025 1026 1027

  // Save fields.
  $function = "field_attach_$op";
  $function('node', $node);

1028
  module_invoke_all('node_' . $op, $node);
1029