node.module 106 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
/**
 * 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.
 */
16
define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
17

18 19 20
/**
 * Node is being built before being viewed normally.
 */
21
define('NODE_BUILD_NORMAL', 0);
22 23 24 25

/**
 * Node is being built before being previewed.
 */
26
define('NODE_BUILD_PREVIEW', 1);
27 28 29 30

/**
 * Node is being built before being indexed by search module.
 */
31
define('NODE_BUILD_SEARCH_INDEX', 2);
32 33 34 35

/**
 * Node is being built before being displayed as a search result.
 */
36
define('NODE_BUILD_SEARCH_RESULT', 3);
37 38 39 40

/**
 * Node is being built before being displayed as part of an RSS feed.
 */
41
define('NODE_BUILD_RSS', 4);
42 43 44 45

/**
 * Node is being built before being printed.
 */
Dries's avatar
Dries committed
46
define('NODE_BUILD_PRINT', 5);
47

Dries's avatar
 
Dries committed
48 49 50
/**
 * Implementation of hook_help().
 */
51
function node_help($path, $arg) {
52 53 54 55
  // 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.
  if ($path != 'admin/content/node-settings/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
56 57 58 59 60 61 62 63 64 65
      && user_access('access administration pages') && node_access_needs_rebuild()) {
    if ($path == 'admin/content/node-settings') {
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
      $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/content/node-settings/rebuild')));
    }
    drupal_set_message($message, 'error');
  }

66
  switch ($path) {
Dries's avatar
 
Dries committed
67
    case 'admin/help#node':
68 69 70 71
      $output = '<p>' . t('The node module manages content on your site, and stores all posts (regardless of type) as a "node" . In addition to basic publishing settings, including whether the post has been published, promoted to the site front page, or should remain present (or sticky) at the top of lists, the node module also records basic information about the author of a post. Optional revision control over edits is available. For additional functionality, the node module is often extended by other modules.') . '</p>';
      $output .= '<p>' . t('Though each post on your site is a node, each post is also of a particular <a href="@content-type">content type</a>. <a href="@content-type">Content types</a> are used to define the characteristics of a post, including the title and description of the fields displayed on its add and edit pages. Each content type may have different default settings for <em>Publishing options</em> and other workflow controls. By default, the two content types in a standard Drupal installation are <em>Page</em> and <em>Story</em>. Use the <a href="@content-type">content types page</a> to add new or edit existing content types. Additional content types also become available as you enable additional core, contributed and custom modules.', array('@content-type' => url('admin/build/types'))) . '</p>';
      $output .= '<p>' . t('The administrative <a href="@content">content page</a> allows you to review and manage your site content. The <a href="@post-settings">post settings page</a> sets certain options for the display of posts. The node module makes a number of permissions available for each content type, which may be set by role on the <a href="@permissions">permissions page</a>.', array('@content' => url('admin/content/node'), '@post-settings' => url('admin/content/node-settings'), '@permissions' => url('admin/user/permissions'))) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) . '</p>';
Dries's avatar
 
Dries committed
72
      return $output;
73 74
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
75
    case 'admin/build/types/add':
76
      return '<p>' . t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.') . '</p>';
77
    case 'node/%/revisions':
78
      return '<p>' . t('The revisions let you track differences between multiple versions of a post.') . '</p>';
79 80 81
    case 'node/%/edit':
      $node = node_load($arg[1]);
      $type = node_get_types('type', $node->type);
82
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
83
  }
Dries's avatar
 
Dries committed
84

85 86
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
    $type = node_get_types('type', str_replace('-', '_', $arg[2]));
87
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
88
  }
Dries's avatar
 
Dries committed
89 90
}

91
/**
92
 * Implementation of hook_theme().
93 94 95
 */
function node_theme() {
  return array(
96
    'node' => array(
97
      'arguments' => array('elements' => NULL),
98
      'template' => 'node',
99
    ),
100 101 102 103 104 105 106 107 108 109 110 111 112 113
    'node_list' => array(
      'arguments' => array('items' => NULL, 'title' => NULL),
    ),
    'node_search_admin' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_filter_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
114 115 116
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
117 118 119 120 121 122 123 124 125 126
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
127 128 129
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
130 131 132
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
133 134 135
    'node_links' => array(
      'arguments' => array('element' => NULL),
    ),
136 137 138
  );
}

Dries's avatar
 
Dries committed
139 140 141
/**
 * Implementation of hook_cron().
 */
142
function node_cron() {
143 144 145
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
146 147
}

Dries's avatar
 
Dries committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/**
 * Implementation of hook_fieldable_info().
 */
function node_fieldable_info() {
  $return = array(
    'node' => array(
      'name' => t('Node'),
      'id key' => 'nid',
      'revision key' => 'vid',
      'bundle key' => 'type',
      // Node.module handles its own caching.
      // 'cacheable' => FALSE,
      // Bundles must provide human readable name so
      // we can create help and error messages about them.
      'bundles' => node_get_types('names'),
    ),
  );
  return $return;
}


/**
 * Implementation of hook_field_build_modes().
 */
function node_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'node') {
    $modes = array(
      'teaser' => t('Teaser'),
      'full' => t('Full node'),
      NODE_BUILD_RSS => t('RSS'),
      NODE_BUILD_PRINT => t('Print'),
    );
    if (module_exists('search')) {
      $modes += array(
        NODE_BUILD_SEARCH_INDEX => t('Search Index'),
        NODE_BUILD_SEARCH_RESULT => t('Search Result'),
      );
    }
  }
  return $modes;
}

Dries's avatar
 
Dries committed
191 192 193 194
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
195 196 197 198
 *   A DB result object from a query to fetch node objects. If your query
 *   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
199 200 201 202
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
203 204
 *   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
205
 */
Dries's avatar
 
Dries committed
206
function node_title_list($result, $title = NULL) {
207
  $items = array();
208
  $num_rows = FALSE;
209
  foreach ($result as $node) {
210
    $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());
211
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
212 213
  }

214
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
215 216
}

Dries's avatar
 
Dries committed
217 218
/**
 * Format a listing of links to nodes.
219 220
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
221
 */
Dries's avatar
 
Dries committed
222
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
223
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
224 225
}

Dries's avatar
 
Dries committed
226 227 228
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
229 230 231 232
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
233 234 235 236 237 238 239
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
240 241 242
  }
}

Dries's avatar
 
Dries committed
243 244 245 246
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
247 248
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
249
  static $history;
Dries's avatar
 
Dries committed
250

Dries's avatar
 
Dries committed
251
  if (!isset($history[$nid])) {
252
    $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
253 254
  }

255
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
256 257 258
}

/**
259
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
260
 *
Dries's avatar
 
Dries committed
261 262 263 264
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
265 266
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
267
 */
268
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
269 270 271
  global $user;
  static $cache;

272 273 274
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
275
  if (!isset($cache[$nid])) {
276
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
277
  }
278 279 280 281 282 283 284
  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
285 286
}

287 288 289
/**
 * See if the user used JS to submit a teaser.
 */
290
function node_teaser_js(&$form, &$form_state) {
291
  if (isset($form_state['input']['teaser_js'])) {
292
    // Glue the teaser to the body.
293
    if (trim($form_state['values']['teaser_js'])) {
294
      // Space the teaser from the body
295
      $body = trim($form_state['values']['teaser_js']) . "\r\n<!--break-->\r\n" . trim($form_state['values']['body']);
296 297 298
    }
    else {
      // Empty teaser, no spaces.
299
      $body = '<!--break-->' . $form_state['values']['body'];
300
    }
301
    // Pass updated body value on to preview/submit form processing.
302
    form_set_value($form['body'], $body, $form_state);
303 304
    // Pass updated body value back onto form for those cases
    // in which the form is redisplayed.
305 306 307 308 309
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries's avatar
 
Dries committed
310
/**
311
 * Ensure value of "teaser_include" checkbox is consistent with other form data.
312 313 314 315 316 317 318 319
 *
 * This handles two situations in which an unchecked checkbox is rejected:
 *
 *   1. The user defines a teaser (summary) but it is empty;
 *   2. The user does not define a teaser (summary) (in this case an
 *      unchecked checkbox would cause the body to be empty, or missing
 *      the auto-generated teaser).
 *
320
 * If JavaScript is active then it is used to force the checkbox to be
321 322 323 324 325 326
 * checked when hidden, and so the second case will not arise.
 *
 * In either case a warning message is output.
 */
function node_teaser_include_verify(&$form, &$form_state) {
  $message = '';
327

328 329
  // $form_state['input'] is set only when the form is built for preview/submit.
  if (isset($form_state['input']['body']) && isset($form_state['values']['teaser_include']) && !$form_state['values']['teaser_include']) {
330 331
    // "teaser_include" checkbox is present and unchecked.
    if (strpos($form_state['values']['body'], '<!--break-->') === 0) {
332
      // Teaser is empty string.
333 334 335 336 337 338
      $message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting is ignored when the summary is empty.');
    }
    elseif (strpos($form_state['values']['body'], '<!--break-->') === FALSE) {
      // Teaser delimiter is not present in the body.
      $message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting has been ignored since you have not defined a summary for the post. (To define a summary, insert the delimiter "&lt;!--break--&gt;" (without the quotes) in the Body of the post to indicate the end of the summary and the start of the main content.)');
    }
339

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
    if (!empty($message)) {
      drupal_set_message($message, 'warning');
      // Pass new checkbox value on to preview/submit form processing.
      form_set_value($form['teaser_include'], 1, $form_state);
      // Pass new checkbox value back onto form for those cases
      // in which form is redisplayed.
      $form['teaser_include']['#value'] = 1;
    }
  }

  return $form;
}

/**
 * Generate a teaser for a node body.
355
 *
356
 * If the end of the teaser is not indicated using the <!--break--> delimiter
357 358 359
 * then we generate the teaser automatically, trying to end it at a sensible
 * place such as the end of a paragraph, a line break, or the end of a
 * sentence (in that order of preference).
360
 *
361 362 363 364
 * @param $body
 *   The content for which a teaser will be generated.
 * @param $format
 *   The format of the content. If the content contains PHP code, we do not
365 366
 *   split it up to prevent parse errors. If the line break filter is present
 *   then we treat newlines embedded in $body as line breaks.
367
 * @param $size
Dries's avatar
Dries committed
368
 *   The desired character length of the teaser. If omitted, the default
369
 *   value will be used. Ignored if the special delimiter is present
370
 *   in $body.
371 372
 * @return
 *   The generated teaser.
Dries's avatar
 
Dries committed
373
 */
374
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
 
Dries committed
375

376 377 378
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
379

380
  // Find where the delimiter is in the body
Steven Wittens's avatar
Steven Wittens committed
381
  $delimiter = strpos($body, '<!--break-->');
Dries's avatar
 
Dries committed
382

383
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
384
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
385 386
    return $body;
  }
Dries's avatar
 
Dries committed
387

388 389 390 391 392
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

393 394 395 396 397
  // We check for the presence of the PHP evaluator filter in the current
  // format. If the body contains PHP code, we do not split it up to prevent
  // parse errors.
  if (isset($format)) {
    $filters = filter_list_format($format);
398
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
399 400
      return $body;
    }
401 402
  }

403
  // If we have a short body, the entire body is the teaser.
404
  if (drupal_strlen($body) <= $size) {
Dries's avatar
 
Dries committed
405 406 407
    return $body;
  }

408 409 410
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

411 412
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
413 414 415 416 417 418 419 420 421 422

  // Store the actual length of the UTF8 string -- which might not be the same
  // as $size.
  $max_rpos = strlen($teaser);

  // How much to cut off the end of the teaser so that it doesn't end in the
  // middle of a paragraph, sentence, or word.
  // Initialize it to maximum in order to find the minimum.
  $min_rpos = $max_rpos;

423
  // Store the reverse of the teaser. We use strpos on the reversed needle and
424
  // haystack for speed and convenience.
425 426
  $reversed = strrev($teaser);

427 428 429 430 431 432
  // Build an array of arrays of break points grouped by preference.
  $break_points = array();

  // A paragraph near the end of sliced teaser is most preferable.
  $break_points[] = array('</p>' => 0);

433 434 435 436 437 438 439 440
  // If no complete paragraph then treat line breaks as paragraphs.
  $line_breaks = array('<br />' => 6, '<br>' => 4);
  // Newline only indicates a line break if line break converter
  // filter is present.
  if (isset($filters['filter/1'])) {
    $line_breaks["\n"] = 1;
  }
  $break_points[] = $line_breaks;
441 442 443 444 445 446 447 448 449 450 451 452 453

  // If the first paragraph is too long, split at the end of a sentence.
  $break_points[] = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);

  // Iterate over the groups of break points until a break point is found.
  foreach ($break_points as $points) {
    // Look for each break point, starting at the end of the teaser.
    foreach ($points as $point => $offset) {
      // The teaser is already reversed, but the break point isn't.
      $rpos = strpos($reversed, strrev($point));
      if ($rpos !== FALSE) {
        $min_rpos = min($rpos + $offset, $min_rpos);
      }
454
    }
Dries's avatar
Dries committed
455

456 457
    // If a break point was found in this group, slice and return the teaser.
    if ($min_rpos !== $max_rpos) {
458
      // Don't slice with length 0. Length must be <0 to slice from RHS.
459
      return ($min_rpos === 0) ? $teaser : substr($teaser, 0, 0 - $min_rpos);
460 461
    }
  }
462 463 464

  // If a break point was not found, still return a teaser.
  return $teaser;
Dries's avatar
 
Dries committed
465 466
}

467 468 469 470 471 472
/**
 * Builds a list of available node types, and returns all of part of this list
 * in the specified format.
 *
 * @param $op
 *   The format in which to return the list. When this is set to 'type',
473
 *   'base', or 'name', only the specified node type is returned. When set to
474 475 476 477 478 479 480 481 482 483
 *   'types' or 'names', all node types are returned.
 * @param $node
 *   A node object, array, or string that indicates the node type to return.
 *   Leave at default value (NULL) to return a list of all node types.
 * @param $reset
 *   Whether or not to reset this function's internal cache (defaults to
 *   FALSE).
 *
 * @return
 *   Either an array of all available node types, or a single node type, in a
484
 *   variable format. Returns FALSE if the node type is not found.
485 486 487
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
488

489 490
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
491
  }
492

493 494 495 496 497 498 499 500 501 502
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
503
    if (!isset($_node_types[$type])) {
504 505 506 507
      return FALSE;
    }
  }
  switch ($op) {
508 509 510
    case 'types':
      return $_node_types;
    case 'type':
511
      return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
512 513
    case 'base':
      return isset($_node_types[$type]->base) ? $_node_types[$type]->base : FALSE;
514 515
    case 'names':
      return $_node_names;
516
    case 'name':
517
      return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
  }
}

/**
 * Resets the database cache of node types, and saves all new or non-modified
 * module-defined node types to the database.
 */
function node_types_rebuild() {
  _node_types_build();

  $node_types = node_get_types('types', NULL, TRUE);

  foreach ($node_types as $type => $info) {
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
534 535 536
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
537
  }
538 539

  _node_types_build();
540 541
  // This is required for proper menu items at node/add/type.
  menu_rebuild();
542 543
}

544
/**
545 546 547 548
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
549 550
 *
 * @return
551
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
552
 */
553 554 555
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
556
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', array(':type' => $existing_type), 0, 1)->fetchField();
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
  $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,
    'min_word_count' => (int) $type->min_word_count,
    'custom' => (int) $type->custom,
    'modified' => (int) $type->modified,
    'locked' => (int) $type->locked,
  );
574 575

  if ($is_existing) {
576 577 578 579
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
580

Dries's avatar
 
Dries committed
581 582 583
    if (!empty($type->old_type) && $type->old_type != $type->type) {
      field_attach_rename_bundle($type->old_type, $type->type);
    }
584
    module_invoke_all('node_type', 'update', $type);
585 586 587
    return SAVED_UPDATED;
  }
  else {
588
    $fields['orig_type'] = (string) $type->orig_type;
589 590 591
    db_insert('node_type')
      ->fields($fields)
      ->execute();
592

Dries's avatar
 
Dries committed
593 594
    field_attach_create_bundle($type->type);

595
    module_invoke_all('node_type', 'insert', $type);
596 597
    return SAVED_NEW;
  }
598
}
599

600 601 602 603 604 605 606 607
/**
 * 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) {
  $info = node_get_types('type', $type);
608 609 610
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
611 612 613
  module_invoke_all('node_type', 'delete', $info);
}

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

633
/**
634 635 636 637
 * 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
638 639
 *
 */
640 641 642 643 644 645 646
function _node_types_build() {
  $_node_types = array();
  $_node_names = array();

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
647
    $_node_types[$type] = node_type_set_defaults($info);
648 649
    $_node_names[$type] = $info['name'];
  }
650 651 652 653 654 655
  $type_result = db_select('node_type', 'nt')
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->addTag('node_type_access')
    ->execute();
  foreach ($type_result as $type_object) {
656 657
    // 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
658 659 660
    // 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])) {
661
      $type_object->disabled = TRUE;
662
    }
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
    if (!isset($_node_types[$type_object->type]) || $type_object->modified) {
      $_node_types[$type_object->type] = $type_object;
      $_node_names[$type_object->type] = $type_object->name;

      if ($type_object->type != $type_object->orig_type) {
        unset($_node_types[$type_object->orig_type]);
        unset($_node_names[$type_object->orig_type]);
      }
    }
  }

  asort($_node_names);

  return array($_node_types, $_node_names);
}

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

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

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

Dries's avatar
 
Dries committed
765
/**
766 767 768 769 770
 * Load node objects from the database.
 *
 * 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
771
 *
772 773 774 775
 * @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
776 777
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
778 779
 *
 * @return
780
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
781
 */
782
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
783 784
  $node_cache = &drupal_static(__FUNCTION__, array());

Dries's avatar
 
Dries committed
785
  if ($reset) {
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
    $node_cache = array();
  }
  $nodes = array();

  // Create a new variable which is either a prepared version of the $nids
  // array for later comparison with the node cache, or FALSE if no $nids were
  // passed. The $nids array is reduced as items are loaded from cache, and we
  // need to know if it's empty for this reason to avoid querying the database
  // when all requested nodes are loaded from cache.
  $passed_nids = !empty($nids) ? array_flip($nids) : FALSE;

  // Revisions are not statically cached, and require a different query to
  // other conditions, so separate vid into its own variable.
  $vid = isset($conditions['vid']) ? $conditions['vid'] : FALSE;
  unset($conditions['vid']);

  // Load any available nodes from the internal cache.
  if ($node_cache && !$vid) {
    if ($nids) {
      $nodes += array_intersect_key($node_cache, $passed_nids);
      // If any nodes were loaded, remove them from the $nids still to load.
      $nids = array_keys(array_diff_key($passed_nids, $nodes));
    }
    // If loading nodes only by conditions, fetch all available nodes from
    // the cache. Nodes which don't match are removed later.
    elseif ($conditions) {
      $nodes = $node_cache;
    }
Dries's avatar
 
Dries committed
814 815
  }

816
  // Exclude any nodes loaded from cache if they don't match $conditions.
817
  // This ensures the same behavior whether loading from memory or database.
818 819 820 821 822
  if ($conditions) {
    foreach ($nodes as $node) {
      $node_values = (array) $node;
      if (array_diff_assoc($conditions, $node_values)) {
        unset($nodes[$node->nid]);
823
      }
824
    }
Dries's avatar
 
Dries committed
825 826
  }

827 828 829 830 831 832 833 834 835 836 837 838
  // Load any remaining nodes from the database. This is the case if there are
  // any $nids left to load, if loading a revision, or if $conditions was
  // passed without $nids.
  if ($nids || $vid || ($conditions && !$passed_nids)) {
    $query = db_select('node', 'n');

    if ($vid) {
      $query->join('node_revision', 'r', 'r.nid = n.nid AND r.vid = :vid', array(':vid' => $vid));
    }
    else {
      $query->join('node_revision', 'r', 'r.vid = n.vid');
    }
839
    $query->join('users', 'u', 'u.uid = n.uid');
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859

    // Add fields from the {node} table.
    $node_fields = drupal_schema_fields_sql('node');

    // vid and title are provided by node_revision, so remove them.
    unset($node_fields['vid']);
    unset($node_fields['title']);
    $query->fields('n', $node_fields);

    // Add all fields from the {node_revision} table.
    $node_revision_fields = drupal_schema_fields_sql('node_revision');

    // nid is provided by node, so remove it.
    unset($node_revision_fields['nid']);

    // Change timestamp to revision_timestamp before adding it to the query.
    unset($node_revision_fields['timestamp']);
    $query->addField('r', 'timestamp', 'revision_timestamp');
    $query->fields('r', $node_revision_fields);

860
    // Add fields from the {users} table.
861 862 863 864 865 866 867 868 869
    $user_fields = array('name', 'picture', 'data');
    $query->fields('u', $user_fields);

    if ($nids) {
      $query->condition('n.nid', $nids, 'IN');
    }
    if ($conditions) {
      foreach ($conditions as $field => $value) {
        $query->condition('n.' . $field, $value);
870
      }
Dries's avatar
 
Dries committed
871
    }
872 873 874 875
    $queried_nodes = $query->execute()->fetchAllAssoc('nid');
  }

  // Pass all nodes loaded from the database through the node type specific
876
  // callbacks and hook_node_load(), then add them to the internal cache.
877 878 879 880 881 882 883
  if (!empty($queried_nodes)) {
    // Create an array of nodes for each content type and pass this to the
    // node type specific callback.
    $typed_nodes = array();
    foreach ($queried_nodes as $nid => $node) {
      $typed_nodes[$node->type][$nid] = $node;
    }
Dries's avatar
 
Dries committed
884

885 886 887 888 889
    // Call node type specific callbacks on each typed array of nodes.
    foreach ($typed_nodes as $type => $nodes_of_type) {
      if (node_hook($type, 'load')) {
        $function = node_get_types('base', $type) . '_load';
        $function($nodes_of_type);
890 891
      }
    }
892

Dries's avatar
 
Dries committed
893 894 895 896 897 898 899 900
    // Attach fields.
    if ($vid) {
      field_attach_load_revision('node', $queried_nodes);
    }
    else {
      field_attach_load('node', $queried_nodes);
    }

901
    // Call hook_node_load(), pass the node types so modules can return early
902
    // if not acting on types in the array.
903 904
    foreach (module_implements('node_load') as $module) {
      $function = $module . '_node_load';
905 906 907 908 909 910
      $function($queried_nodes, array_keys($typed_nodes));
    }
    $nodes += $queried_nodes;
    // Add nodes to the cache if we're not loading a revision.
    if (!$vid) {
      $node_cache += $queried_nodes;
911
    }
Dries's avatar
 
Dries committed
912 913
  }

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
  // Ensure that the returned array is ordered the same as the original $nids
  // array if this was passed in and remove any invalid nids.
  if ($passed_nids) {
    // Remove any invalid nids from the array.
    $passed_nids = array_intersect_key($passed_nids, $nodes);
    foreach ($nodes as $node) {
      $passed_nids[$node->nid] = $node;
    }
    $nodes = $passed_nids;
  }

  return $nodes;
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
936
 *   Whether to reset the node_load_multiple cache.
937 938 939 940 941 942 943 944 945
 *
 * @return
 *   A fully-populated node object.
 */
function node_load($nid, $vid = array(), $reset = FALSE) {
  $vid = isset($vid) ? array('vid' => $vid) : NULL;
  $node = node_load_multiple(array($nid), $vid, $reset);

  return $node ? $node[$nid] : FALSE;
Dries's avatar
 
Dries committed
946 947
}

948 949 950 951 952 953 954 955 956
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
  // Convert the node to an object, if necessary.
  $node = (object)$node;
  $type = node_get_types('type', $node);

  // Make sure the body has the minimum number of words.
957
  // TODO : use a better word counting algorithm that will work in other languages
958 959 960 961 962
  if (!empty($type->min_word_count) && isset($node->body) && count(explode(' ', $node->body)) < $type->min_word_count) {
    form_set_error('body', t('The body of your @type is too short. You need at least %words words.', array('%words' => $type->min_word_count, '@type' => $type->name)));
  }

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
963
    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.'));
964 965 966 967
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
968
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
969 970 971 972 973 974
      // 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)));
    }

975 976
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
977 978 979 980 981 982
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
983
  module_invoke_all('node_validate', $node, $form);
984 985 986 987 988 989 990 991 992 993 994
}

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

  // Convert the node to an object, if necessary.
  $node = (object)$node;

995
  // Generate the teaser, but only if it hasn't been set (e.g. by a
996 997 998
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
999
      $node->format = (!empty($node->body_format) ? $node->body_format : FILTER_FORMAT_DEFAULT);
1000
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
1001 1002 1003 1004
      // Chop off the teaser from the body if needed. The teaser_include
      // property might not be set (eg. in Blog API postings), so only act on
      // it, if it was set with a given value.
      if (isset($node->teaser_include) && !$node->teaser_include && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
1005 1006 1007 1008 1009
        $node->body = substr($node->body, strlen($node->teaser));
      }
    }
    else {
      $node->teaser = '';
1010
      $node->format = 0;
1011 1012 1013 1014 1015
    }
  }

  if (user_access('administer nodes')) {
    // Populate the "authored by" field.
1016
    if ($account = user_load_by_name($node->name)) {
1017 1018 1019 1020 1021 1022
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
1023
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
1024 1025 1026 1027 1028
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
1029
/**
1030 1031 1032 1033 1034
 * 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
1035
 */
1036
function node_save($node) {
Dries's avatar
 
Dries committed
1037
  field_attach_presave('node', $node);
1038
  // Let modules modify the node before it is saved to the database.
1039
  module_invoke_all('node_presave', $node);
1040
  global $user;
Dries's avatar
 
Dries committed
1041

1042 1043 1044
  if (!isset($node->is_new)) {
    $node->is_new = empty($node->nid); 
  }
Dries's avatar
 
Dries committed
1045

Dries's avatar
 
Dries committed
1046
  // Apply filters to some default node fields:
1047
  if ($node->is_new) {
Dries's avatar
 
Dries committed
1048
    // Insert a new node.
1049
    $node->is_new = TRUE;
1050 1051

    // When inserting a node, $node->log must be set because
1052
    // {node_revision}.log does not (and cannot) have a default
1053
    // value. If the user does not have permission to create
1054 1055 1056 1057 1058
    // 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 = '';
    }
1059 1060

    // For the same reasons, make sure we have $node->teaser and
1061
    // $node->body. We should consider making these fields nullable