node.module 113 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/config/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
      'path callback' => 'node_path',
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 247 248 249 250 251
/**
 * Entity path callback.
 */
function node_path($node) {
  return 'node/' . $node->nid;
}

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

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

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

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

Dries's avatar
 
Dries committed
303 304
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
305 306 307
 *
 * @param $node
 *   A node object.
Dries's avatar
 
Dries committed
308
 */
309
function node_tag_new($node) {
Dries's avatar
 
Dries committed
310 311
  global $user;
  if ($user->uid) {
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
    // 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
328 329
}

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

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

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

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

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

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

387 388 389 390 391 392 393 394 395 396 397 398 399 400
/**
 * 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.
 *
401
 * @param $node
402
 *   A node object or string that indicates the node type to return.
403
 *
404
 * @return
405 406 407 408 409
 *   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().
410
 *
411
 * @see hook_node_info();
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 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
 */
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;
461 462 463
}

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

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

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

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

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

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

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

  return $status;
554
}
555

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

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

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

620 621 622 623 624 625 626
  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,
627 628 629 630
        ),
      );
    }
  }
631 632

  return $extra;
633 634
}

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

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

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

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

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

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

715
  asort($_node_types->names);
716

717
  return $_node_types;
718 719 720
}

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

  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
768
}
Dries's avatar
 
Dries committed
769

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

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

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

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

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

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

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

905 906 907 908 909 910 911
  // 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)));
  }
912

913 914 915
  // 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.'));
916 917 918 919
  }

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

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

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

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

  return $node;
}

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

956 957 958 959 960
  try {
    field_attach_presave('node', $node);
    // Let modules modify the node before it is saved to the database.
    module_invoke_all('node_presave', $node);
    global $user;
Dries's avatar
 
Dries committed
961