node.module 104 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 84 85 86 87 88 89 90 91 92 93 94 95
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The node module manages the creation, editing, deletion, and display of all content on your site.') . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Publishing content') . '</dt>';
      $output .= '<dd>' . t('When new content is created, the node module records basic information about the content item including the author, date of creation, and the type of content. It also tracks the <em>publishing options</em> which define whether or not the content is published, promoted to the front page of the site, and/or sticky at the top of content lists. Revision control of content edits is also available. Default settings can be configured for each <a href="@content-type">type of content</a> on your site.', array('@content-type' => url('admin/structure/types'))) . '</dd>';
      $output .= '<dt>' . t('Administering content') . '</dt>';
      $output .= '<dd>' . t('The administrative <a href="@content">content page</a> allows you to review and manage your site content.', array('@content' => url('admin/content'))) . '</dd>';
      $output .= '<dt>' . t('User permissions') . '</dt>';
      $output .= '<dd>' . t('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('@permissions' => url('admin/settings/permissions'))) . '</dd>';
      $output .= '</dl>';
  
    return $output;
96

97
    case 'admin/content':
98 99
      // Return a non-null value so that the 'more help' link is shown.
      return ' ';
100

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

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

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

112
    case 'node/%/revisions':
113
      return '<p>' . t('The revisions let you track differences between multiple versions of your content.') . '</p>';
114

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

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

127
/**
128
 * Implement hook_theme().
129 130 131
 */
function node_theme() {
  return array(
132
    'node' => array(
133
      'render element' => 'elements',
134
      'template' => 'node',
135
    ),
136
    'node_list' => array(
137
      'variables' => array('items' => NULL, 'title' => NULL),
138 139
    ),
    'node_search_admin' => array(
140
      'render element' => 'form',
141 142
    ),
    'node_filter_form' => array(
143
      'render element' => 'form',
144
      'file' => 'node.admin.inc',
145 146
    ),
    'node_filters' => array(
147
      'render element' => 'form',
148
      'file' => 'node.admin.inc',
149
    ),
150
    'node_add_list' => array(
151
      'variables' => array('content' => NULL),
152
      'file' => 'node.pages.inc',
153 154
    ),
    'node_form' => array(
155
      'render element' => 'form',
156
      'file' => 'node.pages.inc',
157 158
    ),
    'node_preview' => array(
159
      'variables' => array('node' => NULL),
160
      'file' => 'node.pages.inc',
161 162
    ),
    'node_log_message' => array(
163
      'variables' => array('log' => NULL),
164
    ),
165
    'node_admin_overview' => array(
166
      'variables' => array('name' => NULL, 'type' => NULL),
167
    ),
168 169 170
  );
}

Dries's avatar
 
Dries committed
171
/**
172
 * Implement hook_cron().
Dries's avatar
 
Dries committed
173
 */
174
function node_cron() {
175 176 177
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
178 179
}

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


/**
222
 * Implement hook_field_build_modes().
Dries's avatar
 
Dries committed
223 224 225 226 227 228 229
 */
function node_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'node') {
    $modes = array(
      'teaser' => t('Teaser'),
      'full' => t('Full node'),
230
      'rss' => t('RSS'),
Dries's avatar
 
Dries committed
231
    );
232 233
    // 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
234 235
    if (module_exists('search')) {
      $modes += array(
236 237
        'search_index' => t('Search Index'),
        'search_result' => t('Search Result'),
Dries's avatar
 
Dries committed
238 239 240 241 242 243
      );
    }
  }
  return $modes;
}

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

267
  return $num_rows ? theme('node_list', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
268 269
}

Dries's avatar
 
Dries committed
270 271
/**
 * Format a listing of links to nodes.
272 273
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
274
 */
275 276
function theme_node_list($variables) {
  return theme('item_list', $variables);
Dries's avatar
 
Dries committed
277 278
}

Dries's avatar
 
Dries committed
279 280 281
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
282 283 284 285
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
286 287 288 289 290 291 292
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
293 294 295
  }
}

Dries's avatar
 
Dries committed
296 297 298 299
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
300 301
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
302
  static $history;
Dries's avatar
 
Dries committed
303

Dries's avatar
 
Dries committed
304
  if (!isset($history[$nid])) {
305
    $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
306 307
  }

308
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
309 310 311
}

/**
312
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
313
 *
Dries's avatar
 
Dries committed
314 315 316 317
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
318 319
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
320
 */
321
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
322 323 324
  global $user;
  static $cache;

325 326 327
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
328
  if (!isset($cache[$nid])) {
329
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
330
  }
331 332 333 334 335 336 337
  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
338 339
}

340
/**
341
 * Extract the type name.
342 343
 *
 * @param $node
344
 *   Either a string or object, containing the node type information.
345 346
 *
 * @return
347
 *   Node type of the passed in data.
348
 */
349 350 351
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
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 423 424 425 426 427 428 429 430
/**
 * 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;
431 432 433
}

/**
434 435 436
 * Resets the database cache of node types.
 *
 * All new or non-modified module-defined node types are saved to the database.
437 438
 */
function node_types_rebuild() {
439
  // Reset and load updated node types.
440
  drupal_static_reset('_node_types_build');
441
  foreach (node_type_get_types() as $type => $info) {
442 443 444
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
445 446 447
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
448 449 450
  }
}

451 452 453 454 455 456 457 458 459 460 461 462 463 464
/**
 * 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('-' => '_')));
}

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

  if ($is_existing) {
496 497 498 499
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
500

Dries's avatar
 
Dries committed
501
    if (!empty($type->old_type) && $type->old_type != $type->type) {
502
      field_attach_rename_bundle('node', $type->old_type, $type->type);
Dries's avatar
 
Dries committed
503
    }
504
    node_configure_fields($type);
505
    module_invoke_all('node_type_update', $type);
506
    $status = SAVED_UPDATED;
507 508
  }
  else {
509
    $fields['orig_type'] = (string) $type->orig_type;
510 511 512
    db_insert('node_type')
      ->fields($fields)
      ->execute();
513

514
    field_attach_create_bundle('node', $type->type);
515
    node_configure_fields($type);
516
    module_invoke_all('node_type_insert', $type);
517
    $status = SAVED_NEW;
518
  }
519 520 521 522 523

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

  return $status;
524
}
525

526 527 528 529 530 531 532 533 534 535 536 537 538
/**
 * 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');
539
  $instance = field_info_instance('node', 'body', $type->type);
540 541 542 543 544
  if ($type->has_body) {
    if (empty($field)) {
      $field = array(
        'field_name' => 'body',
        'type' => 'text_with_summary',
545
        'translatable' => TRUE,
546 547 548 549 550 551
      );
      $field = field_create_field($field);
    }
    if (empty($instance)) {
      $instance = array(
        'field_name' => 'body',
552
        'object_type' => 'node',
553 554 555 556 557
        'bundle' => $type->type,
        'label' => $type->body_label,
        'widget_type' => 'text_textarea_with_summary',
        'settings' => array('display_summary' => TRUE),

558
        // Define default formatters for the teaser and full view.
559 560 561 562
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
563
          ),
564 565 566 567
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
568 569
        ),
      );
570 571 572 573 574 575 576 577 578 579 580 581
      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);
  }

582 583 584
  if ($type->has_title) {
    // Add the title field if not present.
    $field = field_info_field('title');
585
    $instance = field_info_instance('node', 'title', $type->type);
586 587 588 589 590 591 592 593 594 595 596 597

    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',
598
        'object_type' => 'node',
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
        '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);
    }
  }
627 628
}

629 630 631 632 633 634 635
/**
 * 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) {
636
  $info = node_type_get_type($type);
637 638 639
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
640
  module_invoke_all('node_type_delete', $info);
641 642 643

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

646
/**
647 648
 * Updates all nodes of one type to be of another type.
 *
649
 * @param $old_type
650 651 652
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
653 654
 *
 * @return
655
 *   The number of nodes whose node type field was modified.
656
 */
657
function node_type_update_nodes($old_type, $type) {
658
  return db_update('node')
659 660 661
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
662
}
Dries's avatar
 
Dries committed
663

664
/**
665 666 667 668
 * 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
669 670
 *
 */
671
function _node_types_build() {
672
  $_node_types = &drupal_static(__FUNCTION__);
673 674 675
  if (is_object($_node_types)) {
    return $_node_types;
  }
676
  $_node_types = (object)array('types' => array(), 'names' => array());
677 678 679 680

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
681 682
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
683
  }
684
  $type_result = db_select('node_type', 'nt')
685 686
    ->addTag('translatable')
    ->addTag('node_type_access')
687 688 689 690
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->execute();
  foreach ($type_result as $type_object) {
691 692
    // 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
693 694 695
    // 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])) {
696
      $type_object->disabled = TRUE;
697
    }
698 699 700
    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;
701 702

      if ($type_object->type != $type_object->orig_type) {
703 704
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
705 706 707 708
      }
    }
  }

709
  asort($_node_types->names);
710

711
  return $_node_types;
712 713 714
}

/**
715 716 717 718 719 720 721 722 723 724 725
 * 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.
726
 */
727 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 756 757 758 759 760 761
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
762
}
Dries's avatar
 
Dries committed
763

764
/**
765
 * Implements hook_rdf_mapping().
766 767 768 769 770 771 772 773
 */
function node_rdf_mapping() {
  return array(
    array(
      'type' => 'node',
      'bundle' => RDF_DEFAULT_BUNDLE,
      'mapping' => array(
        'rdftype' => array('sioc:Item', 'foaf:Document'),
774
        'title' => array(
775 776 777 778 779 780 781 782 783 784
          'predicates' => array('dc:title'),
        ),
        'created' => array(
          'predicates' => array('dc:date', 'dc:created'),
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
        ),
        'changed' => array(
          'predicates' => array('dc:modified'),
        ),
785
        'body' => array(
786 787
          'predicates' => array('content:encoded'),
        ),
788
        'uid' => array(
789 790
          'predicates' => array('sioc:has_creator'),
        ),
791
        'name' => array(
792 793 794 795 796 797 798
          'predicates' => array('foaf:name'),
        ),
      ),
    ),
  );
}

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

814
/**
Dries's avatar
 
Dries committed
815 816
 * Invoke a node hook.
 *
817
 * @param $node
818
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
819 820 821 822 823
 * @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
824
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
825
 */
826
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
827
  if (node_hook($node, $hook)) {
828
    $base = node_type_get_base($node);
829
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
830
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
831 832 833
  }
}

Dries's avatar
 
Dries committed
834
/**
835
 * Load node entities from the database.
836 837 838 839
 *
 * 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
840
 *
841 842
 * @see entity_load()
 *
843 844 845 846
 * @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
847 848
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
849 850
 *
 * @return
851
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
852
 */
853
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
854
  return entity_load('node', $nids, $conditions, $reset);
855 856 857 858 859 860 861 862 863 864
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
865
 *   Whether to reset the node_load_multiple cache.
866 867 868 869
 *
 * @return
 *   A fully-populated node object.
 */
870 871 872 873 874
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
875 876
}

877 878 879
/**
 * Perform validation checks on the given node.
 */
880
function node_validate($node, $form = array()) {
881
  $type = node_type_get_type($node);
882 883

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
884
    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.'));
885 886 887 888
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
889
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
890 891 892 893 894 895
      // 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)));
    }

896 897
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
898 899 900 901 902 903
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
904
  module_invoke_all('node_validate', $node, $form);
905 906 907 908 909 910 911 912 913 914
}

/**
 * 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.
915
    if ($account = user_load_by_name($node->name)) {
916 917 918 919 920 921
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
922
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
923 924 925 926 927
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
928
/**
929 930 931 932 933
 * 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
934
 */
935
function node_save($node) {
Dries's avatar
 
Dries committed
936
  field_attach_presave('node', $node);
937
  // Let modules modify the node before it is saved to the database.
938
  module_invoke_all('node_presave', $node);
939
  global $user;
Dries's avatar
 
Dries committed
940

941
  if (!isset($node->is_new)) {
942
    $node->is_new = empty($node->nid);
943
  }
Dries's avatar
 
Dries committed
944

Dries's avatar
 
Dries committed
945
  // Apply filters to some default node fields:
946
  if ($node->is_new) {
Dries's avatar
 
Dries committed
947
    // Insert a new node.
948
    $node->is_new = TRUE;
949 950

    // When inserting a node, $node->log must be set because
951
    // {node_revision}.log does not (and cannot) have a default
952
    // value. If the user does not have permission to create
953 954 955 956 957
    // 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 = '';
    }
958
  }
959 960
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
961
    unset($node->vid);
962
  }
963
  else {
964
    // When updating a node, avoid clobbering an existing log entry with an empty one.
965 966
    if (empty($node->log)) {
      unset($node->log);
967
    }
Dries's avatar
 
Dries committed
968 969
  }

970 971
  // Set some required fields:
  if (empty($node->created)) {
972
    $node->created = REQUEST_TIME;
973
  }
974
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
975
  $node->changed = REQUEST_TIME;
Dries's avatar
 
Dries committed
976

977
  $node->timestamp = REQUEST_TIME;
978
  $update_node = TRUE;
979

980 981 982 983 984 985 986 987
  // 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'];

988
  // Generate the node table query and the node_revisions table query.
989
  if ($node->is_new) {
990
    drupal_write_record('node', $node);