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 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
 * Implement 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. Please visit <a href="@node_access_rebuild">this page</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
      $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>';
84
      $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>';
85
      $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/config/people/permissions'))) . '</p>';
86
      $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
87
      return $output;
88

89
    case 'admin/content':
90
      return ' '; // Return a non-null value so that the 'more help' link is shown.
91

92
    case 'admin/structure/types/add':
93
      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>';
94

95
    case 'admin/structure/types/manage/' . $arg[3] . '/fields':
96 97
      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>';

98
    case 'admin/structure/types/manage/' . $arg[3] . '/display':
99 100
      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>';

101
    case 'admin/structure/types/manage/' . $arg[3] . '/display/' . $arg[5]:
102 103
      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>';

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

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

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

119
/**
120
 * Implement hook_theme().
121 122 123
 */
function node_theme() {
  return array(
124
    'node' => array(
125
      'arguments' => array('elements' => NULL),
126
      'template' => 'node',
127
    ),
128 129 130 131 132 133 134 135
    '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),
136
      'file' => 'node.admin.inc',
137 138 139
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
140
      'file' => 'node.admin.inc',
141
    ),
142 143
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
144
      'file' => 'node.pages.inc',
145 146 147
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
148
      'file' => 'node.pages.inc',
149 150 151
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
152
      'file' => 'node.pages.inc',
153 154 155 156
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
157 158 159
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
160 161 162
  );
}

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

Dries's avatar
 
Dries committed
172
/**
173
 * Implement hook_entity_info().
Dries's avatar
 
Dries committed
174
 */
175
function node_entity_info() {
Dries's avatar
 
Dries committed
176 177
  $return = array(
    'node' => array(
178
      'label' => t('Node'),
179 180 181 182
      'controller class' => 'NodeController',
      'base table' => 'node',
      'revision table' => 'node_revision',
      'fieldable' => TRUE,
183 184 185 186 187
      'object keys' => array(
        'id' => 'nid',
        'revision' => 'vid',
        'bundle' => 'type',
      ),
188 189 190
      'bundle keys' => array(
        'bundle' => 'type',
      ),
Dries's avatar
 
Dries committed
191 192
      // Node.module handles its own caching.
      // 'cacheable' => FALSE,
193
      'bundles' => array(),
Dries's avatar
 
Dries committed
194 195
    ),
  );
196 197 198 199 200 201
  // 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(
202 203 204
        'path' => 'admin/structure/types/manage/%node_type',
        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
        'bundle argument' => 4,
205 206 207 208
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
209 210 211 212 213
  return $return;
}


/**
214
 * Implement hook_field_build_modes().
Dries's avatar
 
Dries committed
215 216 217 218 219 220 221
 */
function node_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'node') {
    $modes = array(
      'teaser' => t('Teaser'),
      'full' => t('Full node'),
222
      'rss' => t('RSS'),
Dries's avatar
 
Dries committed
223
    );
224 225
    // 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
226 227
    if (module_exists('search')) {
      $modes += array(
228 229
        'search_index' => t('Search Index'),
        'search_result' => t('Search Result'),
Dries's avatar
 
Dries committed
230 231 232 233 234 235
      );
    }
  }
  return $modes;
}

Dries's avatar
 
Dries committed
236 237 238 239
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
240
 *   A DB result object from a query to fetch node entities. If your query
241 242 243
 *   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
244 245 246 247
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
248 249
 *   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
250
 */
Dries's avatar
 
Dries committed
251
function node_title_list($result, $title = NULL) {
252
  $items = array();
253
  $num_rows = FALSE;
254
  foreach ($result as $node) {
255
    $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());
256
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
257 258
  }

259
  return $num_rows ? theme('node_list', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
260 261
}

Dries's avatar
 
Dries committed
262 263
/**
 * Format a listing of links to nodes.
264 265
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
266
 */
267 268
function theme_node_list($variables) {
  return theme('item_list', $variables);
Dries's avatar
 
Dries committed
269 270
}

Dries's avatar
 
Dries committed
271 272 273
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
274 275 276 277
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
278 279 280 281 282 283 284
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
285 286 287
  }
}

Dries's avatar
 
Dries committed
288 289 290 291
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
292 293
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
294
  static $history;
Dries's avatar
 
Dries committed
295

Dries's avatar
 
Dries committed
296
  if (!isset($history[$nid])) {
297
    $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
298 299
  }

300
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
301 302 303
}

/**
304
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
305
 *
Dries's avatar
 
Dries committed
306 307 308 309
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
310 311
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
312
 */
313
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
314 315 316
  global $user;
  static $cache;

317 318 319
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
320
  if (!isset($cache[$nid])) {
321
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
322
  }
323 324 325 326 327 328 329
  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
330 331
}

332
/**
333
 * Extract the type name.
334 335
 *
 * @param $node
336
 *   Either a string or object, containing the node type information.
337 338
 *
 * @return
339
 *   Node type of the passed in data.
340
 */
341 342 343
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
/**
 * 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;
423 424 425
}

/**
426 427 428
 * Resets the database cache of node types.
 *
 * All new or non-modified module-defined node types are saved to the database.
429 430
 */
function node_types_rebuild() {
431
  // Reset and load updated node types.
432
  drupal_static_reset('_node_types_build');
433
  foreach (node_type_get_types() as $type => $info) {
434 435 436
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
437 438 439
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
440 441 442
  }
}

443 444 445 446 447 448 449 450 451 452 453 454 455 456
/**
 * Menu argument loader; Load a node type by string.
 *
 * @param $name
 *   The machine-readable name of a node type to load; having '_' replaced with
 *   '-'.
 *
 * @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('-' => '_')));
}

457
/**
458 459 460 461
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
462 463
 *
 * @return
464
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
465
 */
466 467 468
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
469
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
  $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,
  );
486 487

  if ($is_existing) {
488 489 490 491
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
492

Dries's avatar
 
Dries committed
493 494 495
    if (!empty($type->old_type) && $type->old_type != $type->type) {
      field_attach_rename_bundle($type->old_type, $type->type);
    }
496
    node_configure_fields($type);
497
    module_invoke_all('node_type_update', $type);
498
    $status = SAVED_UPDATED;
499 500
  }
  else {
501
    $fields['orig_type'] = (string) $type->orig_type;
502 503 504
    db_insert('node_type')
      ->fields($fields)
      ->execute();
505

Dries's avatar
 
Dries committed
506
    field_attach_create_bundle($type->type);
507
    node_configure_fields($type);
508
    module_invoke_all('node_type_insert', $type);
509
    $status = SAVED_NEW;
510
  }
511 512 513 514 515

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

  return $status;
516
}
517

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
/**
 * 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),

548
        // Define default formatters for the teaser and full view.
549 550 551 552
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
553
          ),
554 555 556 557
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
558 559
        ),
      );
560 561 562 563 564 565 566 567 568 569 570 571
      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);
  }

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
  if ($type->has_title) {
    // Add the title field if not present.
    $field = field_info_field('title');
    $instance = field_info_instance('title', $type->type);

    if (empty($field)) {
      $field = array(
        'field_name' => 'title',
        'type' => 'text',
      );
      $field = field_create_field($field);
    }
    if (empty($instance)) {
      $weight = -5;
      $instance = array(
        'field_name' => 'title',
        'bundle' => $type->type,
        'label' => $type->title_label,
        'widget_type' => 'text',
        'widget' => array(
          'weight' => $weight,
        ),
        'required' => TRUE,
        'locked' => TRUE,
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
            'weight' => $weight,
          ),
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_default',
            'weight' => $weight,
          ),
        ),
      );
      field_create_instance($instance);
    }
    else {
      $instance['label'] = $type->title_label;
      field_update_instance($instance);
    }
  }
616 617
}

618 619 620 621 622 623 624
/**
 * 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) {
625
  $info = node_type_get_type($type);
626 627 628
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
629
  module_invoke_all('node_type_delete', $info);
630 631 632

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

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

653
/**
654 655 656 657
 * 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
658 659
 *
 */
660
function _node_types_build() {
661
  $_node_types = &drupal_static(__FUNCTION__);
662 663 664
  if (is_object($_node_types)) {
    return $_node_types;
  }
665
  $_node_types = (object)array('types' => array(), 'names' => array());
666 667 668 669

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
670 671
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
672
  }
673 674 675 676 677 678
  $type_result = db_select('node_type', 'nt')
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->addTag('node_type_access')
    ->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 716 717 718 719 720 721 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
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
750
}
Dries's avatar
 
Dries committed
751

752
/**
Dries's avatar
 
Dries committed
753 754
 * Determine whether a node hook exists.
 *
755
 * @param $node
756
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
757 758 759
 * @param $hook
 *   A string containing the name of the hook.
 * @return
760
 *   TRUE if the $hook exists in the node type of $node.
Dries's avatar
 
Dries committed
761
 */
762
function node_hook($node, $hook) {
763
  $base = node_type_get_base($node);
764
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
765 766
}

767
/**
Dries's avatar
 
Dries committed
768 769
 * Invoke a node hook.
 *
770
 * @param $node
771
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
772 773 774 775 776
 * @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
777
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
778
 */
779
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
780
  if (node_hook($node, $hook)) {
781
    $base = node_type_get_base($node);
782
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
783
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
784 785 786
  }
}

Dries's avatar
 
Dries committed
787
/**
788
 * Load node entities from the database.
789 790 791 792
 *
 * 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
793
 *
794 795
 * @see entity_load()
 *
796 797 798 799
 * @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
800 801
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
802 803
 *
 * @return
804
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
805
 */
806
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
807
  return entity_load('node', $nids, $conditions, $reset);
808 809 810 811 812 813 814 815 816 817
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
818
 *   Whether to reset the node_load_multiple cache.
819 820 821 822
 *
 * @return
 *   A fully-populated node object.
 */
823 824 825 826 827
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
828 829
}

830 831 832 833
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
834
  $type = node_type_get_type($node);
835 836

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
837
    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.'));
838 839 840 841
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
842
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
843 844 845 846 847 848
      // 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)));
    }

849 850
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
851 852 853 854 855 856
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
857
  module_invoke_all('node_validate', $node, $form);
858 859 860 861 862 863 864 865 866 867
}

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

  if (user_access('administer nodes')) {
    // Populate the "authored by" field.
868
    if ($account = user_load_by_name($node->name)) {
869 870 871 872 873 874
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
875
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
876 877 878 879 880
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
881
/**
882 883 884 885 886
 * 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
887
 */
888
function node_save($node) {
Dries's avatar
 
Dries committed
889
  field_attach_presave('node', $node);
890
  // Let modules modify the node before it is saved to the database.
891
  module_invoke_all('node_presave', $node);
892
  global $user;
Dries's avatar
 
Dries committed
893

894
  if (!isset($node->is_new)) {
895
    $node->is_new = empty($node->nid);
896
  }
Dries's avatar
 
Dries committed
897

Dries's avatar
 
Dries committed
898
  // Apply filters to some default node fields:
899
  if ($node->is_new) {
Dries's avatar
 
Dries committed
900
    // Insert a new node.
901
    $node->is_new = TRUE;
902 903

    // When inserting a node, $node->log must be set because
904
    // {node_revision}.log does not (and cannot) have a default
905
    // value. If the user does not have permission to create
906 907 908 909 910
    // 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 = '';
    }
911
  }
912 913
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
914
    unset($node->vid);
915
  }
916
  else {
917
    // When updating a node, avoid clobbering an existing log entry with an empty one.
918 919
    if (empty($node->log)) {
      unset($node->log);
920
    }
Dries's avatar
 
Dries committed
921 922
  }

923 924
  // Set some required fields:
  if (empty($node->created)) {
925
    $node->created = REQUEST_TIME;
926
  }
927
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
928
  $node->changed = REQUEST_TIME;
Dries's avatar
 
Dries committed
929

930
  $node->timestamp = REQUEST_TIME;
931
  $update_node = TRUE;
932

933 934 935 936 937 938 939 940
  // When converting the title property to fields we preserved the {node}.title
  // db column for performance, setting the default language value into this
  // column. After this we restore the field data structure to the previous node
  // title field.
  $title_field = $node->title;
  $langcode = FIELD_LANGUAGE_NONE;
  $node->title = $title_field[$langcode][0]['value'];

941
  // Generate the node table query and the node_revisions table query.
942
  if ($node->is_new) {
943
    drupal_write_record('node', $node);
944
    _node_save_revision($node, $user->uid);
945
    $op = 'insert';
946 947
  }
  else {
948
    drupal_write_record('node', $node, 'nid');
949
    if (!empty($node->revision)) {
950
      _node_save_revision($node, $user->uid);
951 952
    }
    else {
953
      _node_save_revision($node, $user->uid, 'vid');
954
      $update_node = FALSE;
Dries's avatar
 
Dries committed
955
    }
956
    $op = 'update';
957
  }
958
  if ($update_node) {
959 960 961 962
    db_update('node')
      ->fields(array('vid' => $node->vid))
      ->condition('nid', $node->nid)
      ->execute();
963 964
  }

965 966 967
  // Restore the title field data structure after db storage.
  $node->title = $title_field;

968 969 970
  // Call the node specific callback (if any). This can be
  // node_invoke($node, 'insert') or
  // node_invoke($node, 'update').
971
  node_invoke($node, $op);
Dries's avatar
 
Dries committed
972 973 974 975 976

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

977
  module_invoke_all('node_' . $op, $node);
978

979 980
  // Update the node access table for this node.
  node_access_acquire_grants($node);
981

982 983
  // Clear internal properties.
  unset($node->is_new);
984

985
  // Clear the page and block caches.
Dries's avatar
 
Dries committed
986
  cache_clear_all();
987 988 989 990

  // Ignore slave server temporarily to give time for the
  // saved node to be propagated to the slave.
  db_ignore_slave();
Dries's avatar
 
Dries committed
991 992
}

993
/**
994 995
 * Helper function to save a revision with the uid of the current user.
 *
996
 * Node is taken by reference, because drupal_write_record() updates the
997
 * $node with the revision id, and we need to pass that back to the caller.
998
 */
999
function _node_save_revision($node, $uid, $update = NULL) {