node.module 100 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;
}

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

278
  return $num_rows ? theme('node_list', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
279 280
}

Dries's avatar
 
Dries committed
281 282
/**
 * Format a listing of links to nodes.
283 284
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
285
 */
286 287
function theme_node_list($variables) {
  return theme('item_list', $variables);
Dries's avatar
 
Dries committed
288 289
}

Dries's avatar
 
Dries committed
290 291 292
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
293 294 295 296
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
297 298 299 300 301 302 303
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
304 305 306
  }
}

Dries's avatar
 
Dries committed
307 308 309 310
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
311 312
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
313
  static $history;
Dries's avatar
 
Dries committed
314

Dries's avatar
 
Dries committed
315
  if (!isset($history[$nid])) {
316
    $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
317 318
  }

319
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
320 321 322
}

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

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

351
/**
352
 * Extract the type name.
353 354
 *
 * @param $node
355
 *   Either a string or object, containing the node type information.
356 357
 *
 * @return
358
 *   Node type of the passed in data.
359
 */
360 361 362
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
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 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
/**
 * 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;
442 443 444
}

/**
445 446 447
 * Resets the database cache of node types.
 *
 * All new or non-modified module-defined node types are saved to the database.
448 449
 */
function node_types_rebuild() {
450
  // Reset and load updated node types.
451
  drupal_static_reset('_node_types_build');
452
  foreach (node_type_get_types() as $type => $info) {
453 454 455
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
456 457 458
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
459 460 461
  }
}

462 463 464 465 466 467 468 469 470 471 472 473 474 475
/**
 * 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('-' => '_')));
}

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

  $fields = array(
    'type' => (string) $type->type,
    'name' => (string) $type->name,
    'base' => (string) $type->base,
    'has_title' => (int) $type->has_title,
    'title_label' => (string) $type->title_label,
    '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,
  );
505 506

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

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

Dries's avatar
 
Dries committed
525
    field_attach_create_bundle($type->type);
526
    node_configure_fields($type);
527
    module_invoke_all('node_type_insert', $type);
528
    $status = SAVED_NEW;
529
  }
530 531 532 533 534

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

  return $status;
535
}
536

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
/**
 * 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),

567
        // Define default formatters for the teaser and full view.
568 569 570 571
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
572
          ),
573 574 575 576
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
577 578
        ),
      );
579 580 581 582 583 584 585 586 587 588 589 590 591 592
      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);
  }

}

593 594 595 596 597 598 599
/**
 * 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) {
600
  $info = node_type_get_type($type);
601 602 603
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
604
  module_invoke_all('node_type_delete', $info);
605 606 607

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

610
/**
611 612
 * Updates all nodes of one type to be of another type.
 *
613
 * @param $old_type
614 615 616
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
617 618
 *
 * @return
619
 *   The number of nodes whose node type field was modified.
620
 */
621
function node_type_update_nodes($old_type, $type) {
622
  return db_update('node')
623 624 625
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
626
}
Dries's avatar
 
Dries committed
627

628
/**
629 630 631 632
 * 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
633 634
 *
 */
635
function _node_types_build() {
636
  $_node_types = &drupal_static(__FUNCTION__);
637 638 639
  if (is_object($_node_types)) {
    return $_node_types;
  }
640
  $_node_types = (object)array('types' => array(), 'names' => array());
641 642 643 644

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
645 646
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
647
  }
648 649 650 651 652 653
  $type_result = db_select('node_type', 'nt')
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->addTag('node_type_access')
    ->execute();
  foreach ($type_result as $type_object) {
654 655
    // 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
656 657 658
    // 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])) {
659
      $type_object->disabled = TRUE;
660
    }
661 662 663
    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;
664 665

      if ($type_object->type != $type_object->orig_type) {
666 667
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
668 669 670 671
      }
    }
  }

672
  asort($_node_types->names);
673

674
  return $_node_types;
675 676 677
}

/**
678 679 680 681 682 683 684 685 686 687 688
 * 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.
689
 */
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
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
725
}
Dries's avatar
 
Dries committed
726

727
/**
Dries's avatar
 
Dries committed
728 729
 * Determine whether a node hook exists.
 *
730
 * @param $node
731
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
732 733 734
 * @param $hook
 *   A string containing the name of the hook.
 * @return
735
 *   TRUE if the $hook exists in the node type of $node.
Dries's avatar
 
Dries committed
736
 */
737
function node_hook($node, $hook) {
738
  $base = node_type_get_base($node);
739
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
740 741
}

742
/**
Dries's avatar
 
Dries committed
743 744
 * Invoke a node hook.
 *
745
 * @param $node
746
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
747 748 749 750 751
 * @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
752
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
753
 */
754
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
755
  if (node_hook($node, $hook)) {
756
    $base = node_type_get_base($node);
757
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
758
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
759 760 761
  }
}

Dries's avatar
 
Dries committed
762
/**
763
 * Load node entities from the database.
764 765 766 767
 *
 * 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
768
 *
769 770
 * @see entity_load()
 *
771 772 773 774
 * @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
775 776
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
777 778
 *
 * @return
779
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
780
 */
781
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
782
  return entity_load('node', $nids, $conditions, $reset);
783 784 785 786 787 788 789 790 791 792
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
793
 *   Whether to reset the node_load_multiple cache.
794 795 796 797
 *
 * @return
 *   A fully-populated node object.
 */
798 799 800 801 802
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
803 804
}

805 806 807 808
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
809
  $type = node_type_get_type($node);
810 811

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
812
    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.'));
813 814 815 816
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
817
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
818 819 820 821 822 823
      // 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)));
    }

824 825
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
826 827 828 829 830 831
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
832
  module_invoke_all('node_validate', $node, $form);
833 834 835 836 837 838 839 840 841 842
}

/**
 * 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.
843
    if ($account = user_load_by_name($node->name)) {
844 845 846 847 848 849
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
850
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
851 852 853 854 855
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
856
/**
857 858 859 860 861
 * 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
862
 */
863
function node_save($node) {
Dries's avatar
 
Dries committed
864
  field_attach_presave('node', $node);
865
  // Let modules modify the node before it is saved to the database.
866
  module_invoke_all('node_presave', $node);
867
  global $user;
Dries's avatar
 
Dries committed
868

869
  if (!isset($node->is_new)) {
870
    $node->is_new = empty($node->nid);
871
  }
Dries's avatar
 
Dries committed
872

Dries's avatar
 
Dries committed
873
  // Apply filters to some default node fields:
874
  if ($node->is_new) {
Dries's avatar
 
Dries committed
875
    // Insert a new node.
876
    $node->is_new = TRUE;
877 878

    // When inserting a node, $node->log must be set because
879
    // {node_revision}.log does not (and cannot) have a default
880
    // value. If the user does not have permission to create
881 882 883 884 885
    // 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 = '';
    }
886
  }
887 888
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
889
    unset($node->vid);
890
  }
891
  else {
892
    // When updating a node, avoid clobbering an existing log entry with an empty one.
893 894
    if (empty($node->log)) {
      unset($node->log);
895
    }
Dries's avatar
 
Dries committed
896 897
  }

898 899
  // Set some required fields:
  if (empty($node->created)) {
900
    $node->created = REQUEST_TIME;
901
  }
902
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
903
  $node->changed = REQUEST_TIME;
Dries's avatar
 
Dries committed
904

905
  $node->timestamp = REQUEST_TIME;
906
  $update_node = TRUE;
907

908
  // Generate the node table query and the node_revisions table query.
909
  if ($node->is_new) {
910
    drupal_write_record('node', $node);
911
    _node_save_revision($node, $user->uid);
912
    $op = 'insert';
913 914
  }
  else {
915
    drupal_write_record('node', $node, 'nid');
916
    if (!empty($node->revision)) {
917
      _node_save_revision($node, $user->uid);
918 919
    }
    else {
920
      _node_save_revision($node, $user->uid, 'vid');
921
      $update_node = FALSE;
Dries's avatar
 
Dries committed
922
    }
923
    $op = 'update';
924
  }
925
  if ($update_node) {
926 927 928 929
    db_update('node')
      ->fields(array('vid' => $node->vid))
      ->condition('nid', $node->nid)
      ->execute();
930 931
  }

932 933 934
  // Call the node specific callback (if any). This can be
  // node_invoke($node, 'insert') or
  // node_invoke($node, 'update').
935
  node_invoke($node, $op);
Dries's avatar
 
Dries committed
936 937 938 939 940

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

941
  module_invoke_all('node_' . $op, $node);
942

943 944
  // Update the node access table for this node.
  node_access_acquire_grants($node);
945

946 947
  // Clear internal properties.
  unset($node->is_new);
948

949
  // Clear the page and block caches.
Dries's avatar
 
Dries committed
950
  cache_clear_all();
951 952 953 954

  // 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
955 956
}

957
/**
958 959
 * Helper function to save a revision with the uid of the current user.
 *
960
 * Node is taken by reference, because drupal_write_record() updates the
961
 * $node with the revision id, and we need to pass that back to the caller.
962
 */
963
function _node_save_revision($node, $uid, $update = NULL) {
964 965 966
  $temp_uid = $node->uid;
  $node->uid = $uid;
  if (isset($update)) {
967
    drupal_write_record('node_revision', $node, $update);
968 969
  }
  else {
970
    drupal_write_record('node_revision', $node);
971 972 973 974
  }
  $node->uid = $temp_uid;
}

975 976
/**
 * Delete a node.
977 978 979
 *
 * @param $nid
 *   A node ID.
980 981
 */
function node_delete($nid) {