node.module 109 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
 * Implement hook_help().
Dries's avatar
 
Dries committed
50
 */
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
    case 'node/%/edit':
      $node = node_load($arg[1]);
81
      $type = node_type_get_type($node);
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
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
86
    $type = node_type_get_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
 * Implement 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
    '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),
108
      'file' => 'node.admin.inc',
109 110 111
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
112
      'file' => 'node.admin.inc',
113 114 115
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
116
      'file' => 'node.admin.inc',
117 118 119
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
120
      'file' => 'node.pages.inc',
121 122 123
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
124
      'file' => 'node.pages.inc',
125 126 127
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
128
      'file' => 'node.pages.inc',
129 130 131 132
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
133 134 135
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
136 137 138
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
139 140 141
    'node_links' => array(
      'arguments' => array('element' => NULL),
    ),
142 143 144
  );
}

Dries's avatar
 
Dries committed
145
/**
146
 * Implement hook_cron().
Dries's avatar
 
Dries committed
147
 */
148
function node_cron() {
149 150 151
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
152 153
}

Dries's avatar
 
Dries committed
154
/**
155
 * Implement hook_fieldable_info().
Dries's avatar
 
Dries committed
156 157 158 159 160 161 162 163 164 165 166 167
 */
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.
168
      'bundles' => node_type_get_names(),
Dries's avatar
 
Dries committed
169 170 171 172 173 174 175
    ),
  );
  return $return;
}


/**
176
 * Implement hook_field_build_modes().
Dries's avatar
 
Dries committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
 */
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
197 198 199 200
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
201 202 203 204
 *   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
205 206 207 208
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
209 210
 *   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
211
 */
Dries's avatar
 
Dries committed
212
function node_title_list($result, $title = NULL) {
213
  $items = array();
214
  $num_rows = FALSE;
215
  foreach ($result as $node) {
216
    $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());
217
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
218 219
  }

220
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
221 222
}

Dries's avatar
 
Dries committed
223 224
/**
 * Format a listing of links to nodes.
225 226
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
227
 */
Dries's avatar
 
Dries committed
228
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
229
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
230 231
}

Dries's avatar
 
Dries committed
232 233 234
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
235 236 237 238
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
239 240 241 242 243 244 245
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
246 247 248
  }
}

Dries's avatar
 
Dries committed
249 250 251 252
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
253 254
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
255
  static $history;
Dries's avatar
 
Dries committed
256

Dries's avatar
 
Dries committed
257
  if (!isset($history[$nid])) {
258
    $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
259 260
  }

261
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
262 263 264
}

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

278 279 280
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
281
  if (!isset($cache[$nid])) {
282
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
283
  }
284 285 286 287 288 289 290
  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
291 292
}

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

Dries's avatar
 
Dries committed
316
/**
317
 * Ensure value of "teaser_include" checkbox is consistent with other form data.
318 319 320 321 322 323 324 325
 *
 * 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).
 *
326
 * If JavaScript is active then it is used to force the checkbox to be
327 328 329 330 331 332
 * 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 = '';
333

334 335
  // $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']) {
336 337
    // "teaser_include" checkbox is present and unchecked.
    if (strpos($form_state['values']['body'], '<!--break-->') === 0) {
338
      // Teaser is empty string.
339 340 341 342 343 344
      $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.)');
    }
345

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
    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.
361
 *
362
 * If the end of the teaser is not indicated using the <!--break--> delimiter
363 364 365
 * 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).
366
 *
367 368 369 370
 * @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
371 372
 *   split it up to prevent parse errors. If the line break filter is present
 *   then we treat newlines embedded in $body as line breaks.
373
 * @param $size
Dries's avatar
Dries committed
374
 *   The desired character length of the teaser. If omitted, the default
375
 *   value will be used. Ignored if the special delimiter is present
376
 *   in $body.
377 378
 * @return
 *   The generated teaser.
Dries's avatar
 
Dries committed
379
 */
380
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
 
Dries committed
381

382 383 384
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
385

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

389
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
390
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
391 392
    return $body;
  }
Dries's avatar
 
Dries committed
393

394 395 396 397 398
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

399 400 401 402 403
  // 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);
404
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
405 406
      return $body;
    }
407 408
  }

409
  // If we have a short body, the entire body is the teaser.
410
  if (drupal_strlen($body) <= $size) {
Dries's avatar
 
Dries committed
411 412 413
    return $body;
  }

414 415 416
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

417 418
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
419 420 421 422 423 424 425 426 427 428

  // 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;

429
  // Store the reverse of the teaser. We use strpos on the reversed needle and
430
  // haystack for speed and convenience.
431 432
  $reversed = strrev($teaser);

433 434 435 436 437 438
  // 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);

439 440 441 442 443 444 445 446
  // 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;
447 448 449 450 451 452 453 454 455 456 457 458 459

  // 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);
      }
460
    }
Dries's avatar
Dries committed
461

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

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

473
/**
474
 * Extract the type name.
475 476
 *
 * @param $node
477
 *   Either a string or object, containing the node type information.
478 479
 *
 * @return
480
 *   Node type of the passed in data.
481
 */
482 483 484
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
485

486 487 488 489 490 491
/**
 * Clear the statically cached node type information.
 */
function node_type_clear() {
  drupal_static_reset('_node_types_build');
}
492

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
/**
 * Returns a list of all the available node types.
 *
 * @return
 *   An array of node types, keyed by the type.
 * @see node_type_get_type()
 */
function node_type_get_types() {
  return _node_types_build()->types;
}

/**
 * Returns the node type of the passed node or node type string.
 *
 *@param $node
 *   A node object or string that indicates the node type to return.
 * @return
 *   A single node type, as an object or FALSE if the node type is not found.
 *   The node type is an array with following content:
 *
 *   @code
 *   array(
 *     'type' => 'Machine readable type name',
 *     'name' => 'Name of the node type',
 *     'base' => 'Indicates to which module this node type belongs',
 *     'description' => 'Description of the node type',
 *     // ...
 *   )
 *   @endcode
 */
function node_type_get_type($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->types;
  return isset($types[$type]) ? $types[$type] : FALSE;
}

/**
 * Returns the node type base of the passed node or node type string.
 *
 * The base indicates which module implement this node type and is used to
 * execute node type specific hooks.
 *
 * @see node_invoke()
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
 * @return
 *   The node type base or FALSE if the node type is not found.
 */
function node_type_get_base($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->types;
  return isset($types[$type]) && isset($types[$type]->base) ? $types[$type]->base : FALSE;
}

/**
 * Returns a list of available node names.
 *
 * @return
 *   An array of node type names, keyed by the type.
 */
function node_type_get_names() {
  return _node_types_build()->names;
}

/**
 * Returns the node type name of the passed node or node type string.
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
 *
 * @return
 *   The node type name or FALSE if the node type is not found.
 */
function node_type_get_name($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->names;
  return isset($types[$type]) ? $types[$type] : FALSE;
571 572 573 574 575 576 577
}

/**
 * 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() {
578 579 580
  // Reset and load updated node types.
  node_type_clear();
  foreach (node_type_get_types() as $type => $info) {
581 582 583
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
584 585 586
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
587
  }
588 589 590
  // Reset cached node type information so that the next access
  // will use the updated data.
  node_type_clear();
591 592
  // This is required for proper menu items at node/add/type.
  menu_rebuild();
593 594
}

595
/**
596 597 598 599
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
600 601
 *
 * @return
602
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
603
 */
604 605 606
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
607
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', array(':type' => $existing_type), 0, 1)->fetchField();
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  $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,
  );
625 626

  if ($is_existing) {
627 628 629 630
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
631

Dries's avatar
 
Dries committed
632 633 634
    if (!empty($type->old_type) && $type->old_type != $type->type) {
      field_attach_rename_bundle($type->old_type, $type->type);
    }
635
    module_invoke_all('node_type', 'update', $type);
636 637 638
    return SAVED_UPDATED;
  }
  else {
639
    $fields['orig_type'] = (string) $type->orig_type;
640 641 642
    db_insert('node_type')
      ->fields($fields)
      ->execute();
643

Dries's avatar
 
Dries committed
644 645
    field_attach_create_bundle($type->type);

646
    module_invoke_all('node_type', 'insert', $type);
647 648
    return SAVED_NEW;
  }
649
}
650

651 652 653 654 655 656 657
/**
 * 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) {
658
  $info = node_type_get_type($type);
659 660 661
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
662 663 664
  module_invoke_all('node_type', 'delete', $info);
}

665
/**
666 667
 * Updates all nodes of one type to be of another type.
 *
668
 * @param $old_type
669 670 671
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
672 673
 *
 * @return
674
 *   The number of nodes whose node type field was modified.
675
 */
676
function node_type_update_nodes($old_type, $type) {
677 678 679 680
  db_update('node')
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
681
  return db_affected_rows();
Dries's avatar
 
Dries committed
682
}
Dries's avatar
 
Dries committed
683

684
/**
685 686 687 688
 * 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
689 690
 *
 */
691
function _node_types_build() {
692 693 694 695 696
  $_node_types = drupal_static(__FUNCTION__);
  if (is_object($_node_types)) {
    return $_node_types;
  }
  $_node_types = (object) array('types' => array(), 'names' => array());
697 698 699 700

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
701 702
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
703
  }
704 705 706 707 708 709
  $type_result = db_select('node_type', 'nt')
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->addTag('node_type_access')
    ->execute();
  foreach ($type_result as $type_object) {
710 711
    // 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
712 713 714
    // 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])) {
715
      $type_object->disabled = TRUE;
716
    }
717 718 719
    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;
720 721

      if ($type_object->type != $type_object->orig_type) {
722 723
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
724 725 726 727
      }
    }
  }

728
  asort($_node_types->names);
729

730
  return $_node_types;
731 732 733
}

/**
734 735 736 737 738 739 740 741 742 743 744
 * 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.
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 770 771 772 773 774 775 776 777 778 779 780 781
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
782
}
Dries's avatar
 
Dries committed
783

784
/**
Dries's avatar
 
Dries committed
785 786
 * Determine whether a node hook exists.
 *
787
 * @param $node
Dries's avatar
 
Dries committed
788 789 790 791 792 793
 *   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.
 */
794
function node_hook($node, $hook) {
795
  $base = node_type_get_base($node);
796
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
797 798
}

799
/**
Dries's avatar
 
Dries committed
800 801
 * Invoke a node hook.
 *
802
 * @param $node
Dries's avatar
 
Dries committed
803 804 805 806 807 808
 *   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
809
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
810
 */
811
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
812
  if (node_hook($node, $hook)) {
813
    $base = node_type_get_base($node);
814
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
815
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
816 817 818
  }
}

Dries's avatar
 
Dries committed
819
/**
820 821 822 823 824
 * 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
825
 *
826 827 828 829
 * @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
830 831
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
832 833
 *
 * @return
834
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
835
 */
836
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
837 838
  $node_cache = &drupal_static(__FUNCTION__, array());

Dries's avatar
 
Dries committed
839
  if ($reset) {
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
    $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
868 869
  }

870
  // Exclude any nodes loaded from cache if they don't match $conditions.
871
  // This ensures the same behavior whether loading from memory or database.
872 873 874 875 876
  if ($conditions) {
    foreach ($nodes as $node) {
      $node_values = (array) $node;
      if (array_diff_assoc($conditions, $node_values)) {
        unset($nodes[$node->nid]);
877
      }
878
    }
Dries's avatar
 
Dries committed
879 880
  }

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
  // 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');
    }

    // 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);

    if ($nids) {
      $query->condition('n.nid', $nids, 'IN');
    }
    if ($conditions) {
      foreach ($conditions as $field => $value) {
        $query->condition('n.' . $field, $value);
919
      }
Dries's avatar
 
Dries committed
920
    }
921 922 923 924
    $queried_nodes = $query->execute()->fetchAllAssoc('nid');
  }

  // Pass all nodes loaded from the database through the node type specific
925
  // callbacks and hook_node_load(), then add them to the internal cache.
926 927 928 929 930 931 932
  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
933

934 935 936
    // Call node type specific callbacks on each typed array of nodes.
    foreach ($typed_nodes as $type => $nodes_of_type) {
      if (node_hook($type, 'load')) {
937
        $function = node_type_get_base($type) . '_load';
938
        $function($nodes_of_type);
939 940
      }
    }
941

Dries's avatar
 
Dries committed
942 943 944 945 946 947 948 949
    // Attach fields.
    if ($vid) {
      field_attach_load_revision('node', $queried_nodes);
    }
    else {
      field_attach_load('node', $queried_nodes);
    }

950
    // Call hook_node_load(), pass the node types so modules can return early
951
    // if not acting on types in the array.
952 953
    foreach (module_implements('node_load') as $module) {
      $function = $module . '_node_load';
954 955 956 957 958 959
      $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;
960
    }
Dries's avatar
 
Dries committed
961 962
  }

963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
  // 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
985
 *   Whether to reset the node_load_multiple cache.
986 987 988 989 990 991 992 993 994
 *
 * @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
995 996
}

997 998 999 1000 1001 1002
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
  // Convert the node to an object, if necessary.
  $node = (object)$node;
1003
  $type = node_type_get_type($node);
1004 1005

  // Make sure the body has the minimum number of words.
1006
  // TODO : use a better word counting algorithm that will work in other languages
1007 1008 1009 1010 1011
  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)) {
1012
    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.'));
1013 1014 1015 1016
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
1017
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
1018 1019 1020 1021 1022 1023
      // 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)));
    }

1024 1025
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
1026 1027 1028 1029 1030 1031
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
1032
  module_invoke_all('node_validate', $node, $form);
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
}

/**
 * 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;

1044
  // Generate the teaser, but only if it hasn't been set (e.g. by a
1045 1046 1047
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
1048
      $node->format = (!empty($node->body_format) ? $node->body_format : FILTER_FORMAT_DEFAULT);
1049
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
1050 1051 1052 1053
      // 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))) {
1054 1055 1056 1057 1058 <