node.module 114 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
 * Implements 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. <a href="@node_access_rebuild">Rebuild permissions</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
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
85
      $output .= '<p>' . t('The Node module manages the creation, editing, deletion, settings, and display of the main site content. Content items managed by the Node module are typically displayed as pages on your site, and include a title, some meta-data (author, creation time, content type, etc.), and optional fields containing text or other data (fields are managed by the <a href="@field">Field module</a>). For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node', '@field' => url('admin/help/field'))) . '</p>';
86 87
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
88 89 90
      $output .= '<dt>' . t('Creating content') . '</dt>';
      $output .= '<dd>' . t('When new content is created, the Node module records basic information about the content, including the author, date of creation, and the <a href="@content-type">Content type</a>. It also manages 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. 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('Creating custom content types') . '</dt>';
91
      $output .= '<dd>' . t('The Node module gives users with the <em>Administer content types</em> permission the ability to <a href="@content-new">create new content types</a> in addition to the default ones already configured. Creating custom content types allows you the flexibility to add <a href="@field">fields</a> and configure default settings that suit the differing needs of various site content.', array('@content-new' => url('admin/structure/types/add'), '@field' => url('admin/help/field'))) . '</dd>';
92
      $output .= '<dt>' . t('Administering content') . '</dt>';
93 94 95
      $output .= '<dd>' . t('The <a href="@content">Content administration page</a> allows you to review and bulk manage your site content.', array('@content' => url('admin/content'))) . '</dd>';
      $output .= '<dt>' . t('Creating revisions') . '</dt>';
      $output .= '<dd>' . t('The Node module also enables you to create multiple versions of any content, and revert to older versions using the <em>Revision information</em> settings.') . '</dd>';
96
      $output .= '<dt>' . t('User permissions') . '</dt>';
97
      $output .= '<dd>' . t('The Node module makes a number of permissions available for each content type, which can be set by role on the <a href="@permissions">permissions page</a>.', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-node')))) . '</dd>';
98
      $output .= '</dl>';
99
      return $output;
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 105 106
    case 'admin/structure/types/manage/%/display':
      return '<p>' . t('Content items can be displayed using different view modes: Teaser, Full content, Print, RSS, etc. <em>Teaser</em> is a short format that is typically used in lists of multiple content items. <em>Full content</em> is typically used when the content is displayed on its own page.') . '</p>' .
        '<p>' . t('Here, you can define which fields are shown and hidden when %type content is displayed in each view mode, and define how the fields are displayed in each view mode.', array('%type' => node_type_get_name($arg[4]))) . '</p>';
107

108
    case 'node/%/revisions':
109
      return '<p>' . t('Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.') . '</p>';
110

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

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

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

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

Dries's avatar
 
Dries committed
178
/**
179
 * Implements hook_entity_info().
Dries's avatar
 
Dries committed
180
 */
181
function node_entity_info() {
Dries's avatar
 
Dries committed
182 183
  $return = array(
    'node' => array(
184
      'label' => t('Node'),
185 186 187
      'controller class' => 'NodeController',
      'base table' => 'node',
      'revision table' => 'node_revision',
188
      'uri callback' => 'node_uri',
189
      'fieldable' => TRUE,
190 191 192 193 194
      'object keys' => array(
        'id' => 'nid',
        'revision' => 'vid',
        'bundle' => 'type',
      ),
195 196 197
      'bundle keys' => array(
        'bundle' => 'type',
      ),
Dries's avatar
 
Dries committed
198 199
      // Node.module handles its own caching.
      // 'cacheable' => FALSE,
200
      'bundles' => array(),
201 202
      'view modes' => array(
        'full' => array(
203
          'label' => t('Full content'),
204 205 206 207 208 209 210 211
        ),
        'teaser' => array(
          'label' => t('Teaser'),
        ),
        'rss' => array(
          'label' => t('RSS'),
        ),
      ),
Dries's avatar
 
Dries committed
212 213
    ),
  );
214 215 216 217 218 219

  // Search integration is provided by node.module, so search-related
  // view modes for nodes are defined here and not in search.module.
  if (module_exists('search')) {
    $return['node']['view modes'] += array(
      'search_index' => array(
220
        'label' => t('Search index'),
221 222
      ),
      'search_result' => array(
223
        'label' => t('Search result'),
224 225 226 227
      ),
    );
  }

228 229 230 231 232 233
  // 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(
234 235 236
        'path' => 'admin/structure/types/manage/%node_type',
        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
        'bundle argument' => 4,
237 238 239 240
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
241

242
  return $return;
Dries's avatar
 
Dries committed
243 244
}

245
/**
246
 * Entity uri callback.
247
 */
248 249 250 251
function node_uri($node) {
  return array(
    'path' => 'node/' . $node->nid,
  );
252 253
}

254
/**
255
 * Implements hook_admin_paths().
256 257 258 259 260
 */
function node_admin_paths() {
  $paths = array(
    'node/*/edit' => TRUE,
    'node/*/delete' => TRUE,
261 262 263
    'node/*/revisions' => TRUE,
    'node/*/revisions/*/revert' => TRUE,
    'node/*/revisions/*/delete' => TRUE,
264 265 266 267 268 269
    'node/add' => TRUE,
    'node/add/*' => TRUE,
  );
  return $paths;
}

Dries's avatar
 
Dries committed
270 271 272 273
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
274
 *   A DB result object from a query to fetch node entities. If your query
275 276 277
 *   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
278 279 280 281
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
282 283
 *   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
284
 */
Dries's avatar
 
Dries committed
285
function node_title_list($result, $title = NULL) {
286
  $items = array();
287
  $num_rows = FALSE;
288
  foreach ($result as $node) {
289
    $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());
290
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
291 292
  }

293
  return $num_rows ? theme('node_list', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
294 295
}

Dries's avatar
 
Dries committed
296 297
/**
 * Format a listing of links to nodes.
298 299
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
300
 */
301 302
function theme_node_list($variables) {
  return theme('item_list', $variables);
Dries's avatar
 
Dries committed
303 304
}

Dries's avatar
 
Dries committed
305 306
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
307 308 309
 *
 * @param $node
 *   A node object.
Dries's avatar
 
Dries committed
310
 */
311
function node_tag_new($node) {
Dries's avatar
 
Dries committed
312 313
  global $user;
  if ($user->uid) {
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
    // To avoid multiple inserts if a user repeatedly requests the same page,
    // only update history if the node has been updated, a new comment has been
    // posted, or more than thirty minutes has elapsed since the last request.
    $last_viewed = node_last_viewed($node->nid);
    if (!$last_viewed
       || ($last_viewed <= $node->changed || $last_viewed <= $node->last_comment_timestamp)
       || $last_viewed <= REQUEST_TIME - variable_get('node_last_viewed_threshold', 1800)) {
      db_merge('history')
        ->key(array(
          'uid' => $user->uid,
          'nid' => $node->nid,
        ))
        ->fields(array('timestamp' => REQUEST_TIME))
        ->execute();
     }
   }
Dries's avatar
 
Dries committed
330 331
}

Dries's avatar
 
Dries committed
332 333 334 335
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
336 337
function node_last_viewed($nid) {
  global $user;
338
  $history = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
339

Dries's avatar
 
Dries committed
340
  if (!isset($history[$nid])) {
341
    $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
342 343
  }

344
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
345 346 347
}

/**
348
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
349
 *
Dries's avatar
 
Dries committed
350 351 352 353
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
354 355
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
356
 */
357
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
358
  global $user;
359
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
360

361 362 363
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
364
  if (!isset($cache[$nid])) {
365
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
366
  }
367 368 369 370 371 372 373
  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
374 375
}

376
/**
377
 * Extract the type name.
378 379
 *
 * @param $node
380
 *   Either a string or object, containing the node type information.
381 382
 *
 * @return
383
 *   Node type of the passed in data.
384
 */
385 386 387
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
388

389 390 391 392 393 394 395 396 397 398 399 400 401 402
/**
 * 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.
 *
403
 * @param $node
404
 *   A node object or string that indicates the node type to return.
405
 *
406
 * @return
407 408 409 410 411
 *   A single node type, as an object, or FALSE if the node type is not found.
 *   The node type is an object containing fields from hook_node_info() return
 *   values, as well as the field 'type' (the machine-readable type) and other
 *   fields used internally and defined in _node_types_build() and
 *   node_type_set_defaults().
412
 *
413
 * @see hook_node_info();
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 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
 */
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;
463 464 465
}

/**
466 467 468
 * Resets the database cache of node types.
 *
 * All new or non-modified module-defined node types are saved to the database.
469 470
 */
function node_types_rebuild() {
471
  // Reset and load updated node types.
472
  drupal_static_reset('_node_types_build');
473
  foreach (node_type_get_types() as $type => $info) {
474 475 476
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
477 478 479
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
480 481 482
  }
}

483 484 485 486 487 488 489 490 491 492 493 494 495 496
/**
 * 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('-' => '_')));
}

497
/**
498 499 500 501
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
502 503
 *
 * @return
504
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
505
 */
506 507 508
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
509
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
  $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,
  );
526 527

  if ($is_existing) {
528 529 530 531
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
532

Dries's avatar
 
Dries committed
533
    if (!empty($type->old_type) && $type->old_type != $type->type) {
534
      field_attach_rename_bundle('node', $type->old_type, $type->type);
Dries's avatar
 
Dries committed
535
    }
536
    node_configure_fields($type);
537
    module_invoke_all('node_type_update', $type);
538
    $status = SAVED_UPDATED;
539 540
  }
  else {
541
    $fields['orig_type'] = (string) $type->orig_type;
542 543 544
    db_insert('node_type')
      ->fields($fields)
      ->execute();
545

546
    field_attach_create_bundle('node', $type->type);
547
    node_configure_fields($type);
548
    module_invoke_all('node_type_insert', $type);
549
    $status = SAVED_NEW;
550
  }
551 552 553 554 555

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

  return $status;
556
}
557

558 559 560 561 562 563 564 565 566 567 568 569 570
/**
 * 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');
571
  $instance = field_info_instance('node', 'body', $type->type);
572 573 574 575 576
  if ($type->has_body) {
    if (empty($field)) {
      $field = array(
        'field_name' => 'body',
        'type' => 'text_with_summary',
577
        'object_types' => array('node'),
578
        'translatable' => TRUE,
579 580 581 582 583 584
      );
      $field = field_create_field($field);
    }
    if (empty($instance)) {
      $instance = array(
        'field_name' => 'body',
585
        'object_type' => 'node',
586 587 588 589 590
        'bundle' => $type->type,
        'label' => $type->body_label,
        'widget_type' => 'text_textarea_with_summary',
        'settings' => array('display_summary' => TRUE),

591
        // Define default formatters for the teaser and full view.
592 593 594 595
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
596
          ),
597 598 599 600
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
601 602
        ),
      );
603 604 605 606 607 608 609 610 611 612 613
      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);
  }
614
}
615

616 617 618 619 620
/**
 * Implements hook_field_extra_fields().
 */
function node_field_extra_fields() {
  $extra = array();
621

622 623 624 625 626 627 628
  foreach (node_type_get_types() as $type) {
    if ($type->has_title) {
      $extra['node'][$type->type] = array(
        'title' => array(
          'label' => $type->title_label,
          'description' => t('Node module element.'),
          'weight' => -5,
629 630 631 632
        ),
      );
    }
  }
633 634

  return $extra;
635 636
}

637 638 639 640 641 642 643
/**
 * 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) {
644
  $info = node_type_get_type($type);
645 646 647
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
648
  module_invoke_all('node_type_delete', $info);
649 650 651

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

654
/**
655 656
 * Updates all nodes of one type to be of another type.
 *
657
 * @param $old_type
658 659 660
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
661 662
 *
 * @return
663
 *   The number of nodes whose node type field was modified.
664
 */
665
function node_type_update_nodes($old_type, $type) {
666
  return db_update('node')
667 668 669
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
670
}
Dries's avatar
 
Dries committed
671

672
/**
673 674 675 676
 * 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
677 678
 *
 */
679
function _node_types_build() {
680
  $_node_types = &drupal_static(__FUNCTION__);
681 682 683
  if (is_object($_node_types)) {
    return $_node_types;
  }
684
  $_node_types = (object)array('types' => array(), 'names' => array());
685 686 687 688

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
689 690
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
691
  }
692
  $type_result = db_select('node_type', 'nt')
693 694
    ->addTag('translatable')
    ->addTag('node_type_access')
695 696 697 698
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->execute();
  foreach ($type_result as $type_object) {
699 700
    // 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
701 702 703
    // 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])) {
704
      $type_object->disabled = TRUE;
705
    }
706 707 708
    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;
709 710

      if ($type_object->type != $type_object->orig_type) {
711 712
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
713 714 715 716
      }
    }
  }

717
  asort($_node_types->names);
718

719
  return $_node_types;
720 721 722
}

/**
723 724 725 726 727 728 729 730 731 732 733
 * 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.
734
 */
735
function node_type_set_defaults($info = array()) {
736
  $type = &drupal_static(__FUNCTION__);
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 762 763 764 765 766 767 768 769

  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
770
}
Dries's avatar
 
Dries committed
771

772
/**
773
 * Implements hook_rdf_mapping().
774 775 776 777 778 779 780 781
 */
function node_rdf_mapping() {
  return array(
    array(
      'type' => 'node',
      'bundle' => RDF_DEFAULT_BUNDLE,
      'mapping' => array(
        'rdftype' => array('sioc:Item', 'foaf:Document'),
782
        'title' => array(
783 784 785 786 787 788 789 790 791
          'predicates' => array('dc:title'),
        ),
        'created' => array(
          'predicates' => array('dc:date', 'dc:created'),
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
        ),
        'changed' => array(
          'predicates' => array('dc:modified'),
792 793
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
794
        ),
795
        'body' => array(
796 797
          'predicates' => array('content:encoded'),
        ),
798
        'uid' => array(
799
          'predicates' => array('sioc:has_creator'),
800
          'type' => 'rel',
801
        ),
802
        'name' => array(
803 804
          'predicates' => array('foaf:name'),
        ),
805 806
        'comment_count' => array(
          'predicates' => array('sioc:num_replies'),
807 808 809 810 811 812
          'datatype' => 'xsd:integer',
        ),
        'last_activity' => array(
          'predicates' => array('sioc:last_activity_date'),
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
813
        ),
814 815 816 817 818
      ),
    ),
  );
}

819
/**
Dries's avatar
 
Dries committed
820 821
 * Determine whether a node hook exists.
 *
822
 * @param $node
823
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
824 825 826
 * @param $hook
 *   A string containing the name of the hook.
 * @return
827
 *   TRUE if the $hook exists in the node type of $node.
Dries's avatar
 
Dries committed
828
 */
829
function node_hook($node, $hook) {
830
  $base = node_type_get_base($node);
831
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
832 833
}

834
/**
Dries's avatar
 
Dries committed
835 836
 * Invoke a node hook.
 *
837
 * @param $node
838
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
839 840 841 842 843
 * @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
844
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
845
 */
846
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
847
  if (node_hook($node, $hook)) {
848
    $base = node_type_get_base($node);
849
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
850
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
851 852 853
  }
}

Dries's avatar
 
Dries committed
854
/**
855
 * Load node entities from the database.
856 857 858 859
 *
 * 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
860
 *
861 862
 * @see entity_load()
 *
863 864 865 866
 * @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
867 868
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
869 870
 *
 * @return
871
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
872
 */
873
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
874
  return entity_load('node', $nids, $conditions, $reset);
875 876 877 878 879 880 881 882 883 884
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
885
 *   Whether to reset the node_load_multiple cache.
886 887 888 889
 *
 * @return
 *   A fully-populated node object.
 */
890 891 892 893 894
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
895 896
}

897 898 899
/**
 * Perform validation checks on the given node.
 */
900
function node_validate($node, $form = array()) {
901
  $type = node_type_get_type($node);
902 903

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
904
    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.'));
905 906
  }

907 908 909 910 911 912 913
  // Validate the "authored by" field.
  if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
    // 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)));
  }
914

915 916 917
  // Validate the "authored on" field.
  if (!empty($node->date) && strtotime($node->date) === FALSE) {
    form_set_error('date', t('You have to specify a valid date.'));
918 919 920 921
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
922
  module_invoke_all('node_validate', $node, $form);
923 924 925
}

/**
926
 * Prepare node for saving by populating author and creation date.
927 928 929 930
 */
function node_submit($node) {
  global $user;

931
  // A user might assign the node author by entering a user name in the node
932 933
  // form, which we then need to translate to a user ID.
  if (isset($node->name)) {
934
    if ($account = user_load_by_name($node->name)) {
935 936 937 938 939 940
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
941

942
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
943 944 945 946 947
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
948
/**
949 950 951 952 953
 * 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
954
 */
955
function node_save($node) {
956
  $transaction = db_transaction();
Dries's avatar
 
Dries committed