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':
76
      return '<p>' . t('Below is a list of all the content types on your site. All posts that exist on your site are instances of one of these content types.') . '</p>';
77
    case 'admin/build/types/add':
78
      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>';
79
    case 'node/%/revisions':
80
      return '<p>' . t('The revisions let you track differences between multiple versions of a post.') . '</p>';
81 82 83
    case 'node/%/edit':
      $node = node_load($arg[1]);
      $type = node_get_types('type', $node->type);
84
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
85
  }
Dries's avatar
 
Dries committed
86

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

93
/**
94
 * Implementation of hook_theme().
95 96 97
 */
function node_theme() {
  return array(
98
    'node' => array(
99
      'arguments' => array('elements' => NULL),
100
      'template' => 'node',
101
    ),
102 103 104 105 106 107 108 109
    '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),
110
      'file' => 'node.admin.inc',
111 112 113
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
114
      'file' => 'node.admin.inc',
115 116 117
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
118 119 120 121 122
      'file' => 'node.admin.inc',
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
      'file' => 'node.pages.inc',
123 124 125
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
126
      'file' => 'node.pages.inc',
127 128 129
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
130
      'file' => 'node.pages.inc',
131 132 133 134
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
135 136 137
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
138 139 140
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
141 142 143
    'node_links' => array(
      'arguments' => array('element' => NULL),
    ),
144 145 146
  );
}

Dries's avatar
 
Dries committed
147 148 149
/**
 * Implementation of hook_cron().
 */
150
function node_cron() {
Dries's avatar
 
Dries committed
151
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
152 153
}

Dries's avatar
 
Dries committed
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 191 192 193 194 195 196
/**
 * 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
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;
Dries's avatar
 
Dries committed
215
  while ($node = db_fetch_object($result)) {
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) {
Dries's avatar
 
Dries committed
239
    if (node_last_viewed($nid)) {
240
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', REQUEST_TIME, $user->uid, $nid);
Dries's avatar
 
Dries committed
241 242
    }
    else {
243
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, REQUEST_TIME);
Dries's avatar
 
Dries committed
244 245 246 247
    }
  }
}

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

Dries's avatar
 
Dries committed
256
  if (!isset($history[$nid])) {
257
    $history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = %d AND nid = %d", $user->uid, $nid));
Dries's avatar
 
Dries committed
258 259
  }

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

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

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

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

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

333 334 335 336
  // $form['#post'] is set only when the form is built for preview/submit.
  if (isset($form['#post']['body']) && isset($form_state['values']['teaser_include']) && !$form_state['values']['teaser_include']) {
    // "teaser_include" checkbox is present and unchecked.
    if (strpos($form_state['values']['body'], '<!--break-->') === 0) {
337
      // Teaser is empty string.
338 339 340 341 342 343
      $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.)');
    }
344

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

472 473 474 475 476 477
/**
 * 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',
478
 *   'base', or 'name', only the specified node type is returned. When set to
479 480 481 482 483 484 485 486 487 488
 *   '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
489
 *   variable format. Returns FALSE if the node type is not found.
490 491 492
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
493

494 495
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
496
  }
497

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

/**
 * 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);
    }
539 540 541
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
542
  }
543 544

  _node_types_build();
545 546
  // This is required for proper menu items at node/add/type.
  menu_rebuild();
547 548
}

549
/**
550 551 552 553
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
554 555
 *
 * @return
556
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
557
 */
558 559 560
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
561
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
  $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,
  );
579 580

  if ($is_existing) {
581
    db_update('node_type')->fields($fields)->condition('type', $existing_type)->execute();
582

Dries's avatar
 
Dries committed
583 584 585
    if (!empty($type->old_type) && $type->old_type != $type->type) {
      field_attach_rename_bundle($type->old_type, $type->type);
    }
586
    module_invoke_all('node_type', 'update', $type);
587 588 589
    return SAVED_UPDATED;
  }
  else {
590 591
    $fields['orig_type'] = (string) $type->orig_type;
    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
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
609 610 611
  module_invoke_all('node_type', 'delete', $info);
}

612
/**
613 614
 * Updates all nodes of one type to be of another type.
 *
615
 * @param $old_type
616 617 618
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
619 620
 *
 * @return
621
 *   The number of nodes whose node type field was modified.
622
 */
623 624 625
function node_type_update_nodes($old_type, $type) {
  db_query("UPDATE {node} SET type = '%s' WHERE type = '%s'", $type, $old_type);
  return db_affected_rows();
Dries's avatar
 
Dries committed
626
}
Dries's avatar
 
Dries committed
627

628
/**
629 630 631 632
 * 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
633 634
 *
 */
635 636 637 638 639 640 641
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;
642
    $_node_types[$type] = node_type_set_defaults($info);
643 644 645 646 647
    $_node_names[$type] = $info['name'];
  }

  $type_result = db_query(db_rewrite_sql('SELECT nt.type, nt.* FROM {node_type} nt ORDER BY nt.type ASC', 'nt', 'type'));
  while ($type_object = db_fetch_object($type_result)) {
648 649
    // 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
650 651 652
    // 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])) {
653
      $type_object->disabled = TRUE;
654
    }
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
    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);
}

/**
672 673 674 675 676 677 678 679 680 681 682
 * 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.
683
 */
684 685 686 687 688 689 690 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
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
720
}
Dries's avatar
 
Dries committed
721

722
/**
Dries's avatar
 
Dries committed
723 724 725 726 727 728 729 730 731 732
 * Determine whether a node hook exists.
 *
 * @param &$node
 *   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.
 */
function node_hook(&$node, $hook) {
733 734
  $base = node_get_types('base', $node);
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
735 736
}

737
/**
Dries's avatar
 
Dries committed
738 739 740 741 742 743 744 745 746
 * Invoke a node hook.
 *
 * @param &$node
 *   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
747
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
748 749
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
750
  if (node_hook($node, $hook)) {
751 752
    $base = node_get_types('base', $node);
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
753
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
754 755 756
  }
}

Dries's avatar
 
Dries committed
757 758 759 760
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
761
 *   A node object.
Dries's avatar
 
Dries committed
762 763 764 765 766 767 768
 * @param $op
 *   A string containing the name of the nodeapi operation.
 * @param $a3, $a4
 *   Arguments to pass on to the hook, after the $node and $op arguments.
 * @return
 *   The returned value of the invoked hooks.
 */
Dries's avatar
 
Dries committed
769
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
770
  $return = array();
771
  $hook = 'nodeapi_' . $op;
772 773
  foreach (module_implements($hook) as $module) {
    $function = $module . '_' . $hook;
774
    $result = $function($node, $a3, $a4);
775
    if (isset($result) && is_array($result)) {
776 777
      $return = array_merge($return, $result);
    }
778
    elseif (isset($result)) {
779
      $return[] = $result;
Dries's avatar
 
Dries committed
780 781 782 783 784
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
785
/**
786 787 788 789 790
 * 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
791
 *
792 793 794 795
 * @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
796 797
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
798 799
 *
 * @return
800
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
801
 */
802 803
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
  static $node_cache = array();
Dries's avatar
 
Dries committed
804
  if ($reset) {
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
    $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
833 834
  }

835
  // Exclude any nodes loaded from cache if they don't match $conditions.
836
  // This ensures the same behavior whether loading from memory or database.
837 838 839 840 841
  if ($conditions) {
    foreach ($nodes as $node) {
      $node_values = (array) $node;
      if (array_diff_assoc($conditions, $node_values)) {
        unset($nodes[$node->nid]);
842
      }
843
    }
Dries's avatar
 
Dries committed
844 845
  }

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
  // 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');
    }
    $query->join('users', 'u', 'u.uid = n.uid');

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

    // Add fields from the {users} table.
    $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);
889
      }
Dries's avatar
 
Dries committed
890
    }
891 892 893 894 895 896 897 898 899 900 901 902
    $queried_nodes = $query->execute()->fetchAllAssoc('nid');
  }

  // Pass all nodes loaded from the database through the node type specific
  // callbacks and hook_nodeapi_load(), then add them to the internal cache.
  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
903

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

Dries's avatar
 
Dries committed
912 913 914 915 916 917 918 919
    // Attach fields.
    if ($vid) {
      field_attach_load_revision('node', $queried_nodes);
    }
    else {
      field_attach_load('node', $queried_nodes);
    }

920 921 922 923 924 925 926 927 928 929
    // Call hook_nodeapi_load(), pass the node types so modules can return early
    // if not acting on types in the array.
    foreach (module_implements('nodeapi_load') as $module) {
      $function = $module . '_nodeapi_load';
      $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;
930
    }
Dries's avatar
 
Dries committed
931 932
  }

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
  // 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
 *   Whether to reset the internal node_load cache.
 *
 * @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
965 966
}

967 968 969 970 971 972 973 974 975
/**
 * 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.
976
  // TODO : use a better word counting algorithm that will work in other languages
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
  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)) {
    form_set_error('changed', t('This content has been modified by another user, changes cannot be saved.'));
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
    if (!empty($node->name) && !($account = user_load(array('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)));
    }

994 995
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
996 997 998 999
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

Dries's avatar
 
Dries committed
1000 1001 1002
  // Validate fields
  field_attach_validate('node', $node, $form);

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
  node_invoke_nodeapi($node, 'validate', $form);
}

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

1017
  // Generate the teaser, but only if it hasn't been set (e.g. by a
1018 1019 1020
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
1021
      $node->format = (!empty($node->body_format) ? $node->body_format : FILTER_FORMAT_DEFAULT);
1022
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
1023 1024 1025 1026
      // 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))) {
1027 1028 1029 1030 1031
        $node->body = substr($node->body, strlen($node->teaser));
      }
    }
    else {
      $node->teaser = '';
1032
      $node->format = 0;
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
    }
  }

  if (user_access('administer nodes')) {
    // Populate the "authored by" field.
    if ($account = user_load(array('name' => $node->name))) {
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
1045
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
1046 1047 1048 1049 1050
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
1051 1052 1053
/**
 * Save a node object into the database.
 */
1054
function node_save(&$node) {
Dries's avatar
 
Dries committed
1055
  field_attach_presave('node', $node);
1056 1057
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
1058
  global $user;
Dries's avatar
 
Dries committed
1059

1060
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
1061

Dries's avatar
 
Dries committed
1062
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
1063
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
1064
    // Insert a new node.
1065
    $node->is_new = TRUE;
1066 1067

    // When inserting a node, $node->log must be set because
1068
    // {node_revision}.log does not (and cannot) have a default
1069
    // value. If the user does not have permission to create
1070 1071 1072 1073 1074
    // 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 = '';
    }
1075 1076

    // For the same reasons, make sure we have $node->teaser and
1077
    // $node->body. We should consider making these fields nullable
1078 1079 1080 1081 1082 1083 1084
    // in a future version since node types are not required to use them.
    if (!isset($node->teaser)) {
      $node->teaser = '';
    }
    if (!isset($node->body)) {
      $node->body = '';
    }
1085
  }
1086 1087 1088
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
  }
1089
  else {
1090
    // When updating a node, avoid clobbering an existing log entry with an empty one.
1091 1092
    if (empty($node->log)) {
      unset($node->log);
1093
    }
Dries's avatar
 
Dries committed
1094 1095
  }

1096 1097
  // Set some required fields:
  if (empty($node->created)) {
1098
    $node->created = REQUEST_TIME;
1099
  }
1100
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
1101
  $node->changed = REQUEST_TIME;
Dries's avatar
 
Dries committed
1102

1103
  $node->timestamp = REQUEST_TIME;
1104
  $update_node = TRUE;
1105

1106
  // Generate the node table query and the node_revisions table query.
1107
  if ($node->is_new) {
1108
    drupal_write_record('node', $node);
1109
    _node_save_revision($node, $user->uid);
1110
    $op = 'insert';
1111 1112
  }
  else {
1113
    drupal_write_record('node', $node, 'nid');
1114
    if (!empty($node->revision)) {
1115
      _node_save_revision($node, $user->uid);
1116 1117
    }
    else {
1118
      _node_save_revision($node, $user->uid, 'vid');
1119
      $update_node = FALSE;
Dries's avatar
 
Dries committed
1120
    }
1121
    $op = 'update';
1122
  }
1123
  if ($update_node) {
1124
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
1125 1126
  }

1127 1128 1129
  // Call the node specific callback (if any). This can be
  // node_invoke($node, 'insert') or
  // node_invoke($node, 'update').
1130
  node_invoke($node, $op);
Dries's avatar
 
Dries committed
1131 1132 1133 1134 1135

  // Save fields.
  $function = "field_attach_$op";
  $function('node', $node);

1136 1137
  node_invoke_nodeapi($node, $op);

1138 1139 1140
  // Update the node access table for this node.
  node_access_acquire_grants($node);

1141
  // Clear the page and block caches.
Dries's avatar
 
Dries committed
1142
  cache_clear_all();
Dries's avatar
 
Dries committed
1143 1144
}

1145
/**
1146 1147
 * Helper function to save a revision with the uid of the current user.
 *
1148
 * Node is taken by reference, because drupal_write_record() updates the
1149
 * $node with the revision id, and we need to pass that back to the caller.
1150
 */
1151
function _node_save_revision(&$node, $uid, $update = NULL) {
1152 1153 1154
  $temp_uid = $node->uid;
  $node->uid = $uid;
  if (isset($update)) {
1155
    drupal_write_record('node_revision', $node, $update);
1156 1157
  }
  else {
1158
    drupal_write_record('node_revision', $node);
1159 1160 1161 1162
  }
  $node->uid = $temp_uid;
}

1163 1164 1165 1166 1167 1168 1169 1170 1171
/**
 * Delete a node.
 */
function node_delete($nid) {

  $node = node_load($nid);

  if (node_access('delete', $node)) {
    db_query('DELETE FROM {node} WHERE nid = %d', $node->nid);
1172
    db_query('DELETE FROM {node_revision} WHERE nid = %d', $node->nid);
1173 1174 1175 1176 1177 1178 1179 1180 1181

    // Call the node-specific callback (if any):
    node_invoke($node, 'delete');
    node_invoke_nodeapi($node, 'delete');

    // Clear the page and block caches.
    cache_clear_all();

    // Remove this node from the search index if needed.
1182 1183 1184 1185
    // This code is implemented in node module rather than in search module,
    // because node module is implementing search module's API, not the other
    // way around.
    if (module_exists('search')) {
1186 1187 1188
      search_wipe($node->nid, 'node');
    }
    watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
1189
    drupal_set_message(t('@type %title has been deleted.', array('@type' => node_get_types('name', $node), '%title' => $node->title)));
1190 1191 1192
  }
}

Dries's avatar
 
Dries committed
1193
/**
1194
 * Generate an array for rendering the given node.
Dries's avatar
 
Dries committed
1195 1196 1197 1198
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
1199
 *   Whether to display the teaser only or the full form.
Dries's avatar
 
Dries committed
1200 1201
 *
 * @return
1202
 *   An array as expected by drupal_render().
Dries's avatar
 
Dries committed
1203
 */
1204
function node_build($node, $teaser = FALSE) {
1205
  $node = (object)$node;
Dries's avatar
 
Dries committed
1206

1207
  $node = node_build_content($node, $teaser);
1208

1209 1210 1211 1212 1213 1214 1215
  $build = $node->content;
  $build += array(
    '#theme' => 'node',
    '#node' => $node,
    '#teaser' => $teaser,
  );
  return $build;
Dries's avatar
 
Dries committed
1216
}
Dries's avatar
 
Dries committed
1217

Dries's avatar
 
Dries committed
1218
/**