node.module 103 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 99
    'node' => array(
      'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
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
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
158 159 160 161
 *   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
162 163 164 165
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
166 167
 *   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
168
 */
Dries's avatar
 
Dries committed
169
function node_title_list($result, $title = NULL) {
170
  $items = array();
171
  $num_rows = FALSE;
Dries's avatar
 
Dries committed
172
  while ($node = db_fetch_object($result)) {
173
    $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());
174
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
175 176
  }

177
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
178 179
}

Dries's avatar
 
Dries committed
180 181
/**
 * Format a listing of links to nodes.
182 183
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
184
 */
Dries's avatar
 
Dries committed
185
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
186
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
187 188
}

Dries's avatar
 
Dries committed
189 190 191
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
192 193 194 195
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
196
    if (node_last_viewed($nid)) {
197
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', REQUEST_TIME, $user->uid, $nid);
Dries's avatar
 
Dries committed
198 199
    }
    else {
200
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, REQUEST_TIME);
Dries's avatar
 
Dries committed
201 202 203 204
    }
  }
}

Dries's avatar
 
Dries committed
205 206 207 208
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
209 210
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
211
  static $history;
Dries's avatar
 
Dries committed
212

Dries's avatar
 
Dries committed
213
  if (!isset($history[$nid])) {
214
    $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
215 216
  }

217
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
218 219 220
}

/**
221
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
222
 *
Dries's avatar
 
Dries committed
223 224 225 226
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
227 228
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
229
 */
230
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
231 232 233
  global $user;
  static $cache;

234 235 236
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
237
  if (!isset($cache[$nid])) {
238
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
239
  }
240 241 242 243 244 245 246
  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
247 248
}

249 250 251
/**
 * See if the user used JS to submit a teaser.
 */
252
function node_teaser_js(&$form, &$form_state) {
253
  if (isset($form['#post']['teaser_js'])) {
254
    // Glue the teaser to the body.
255
    if (trim($form_state['values']['teaser_js'])) {
256
      // Space the teaser from the body
257
      $body = trim($form_state['values']['teaser_js']) . "\r\n<!--break-->\r\n" . trim($form_state['values']['body']);
258 259 260
    }
    else {
      // Empty teaser, no spaces.
261
      $body = '<!--break-->' . $form_state['values']['body'];
262
    }
263
    // Pass updated body value on to preview/submit form processing.
264
    form_set_value($form['body'], $body, $form_state);
265 266
    // Pass updated body value back onto form for those cases
    // in which the form is redisplayed.
267 268 269 270 271
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries's avatar
 
Dries committed
272
/**
273
 * Ensure value of "teaser_include" checkbox is consistent with other form data.
274 275 276 277 278 279 280 281
 *
 * 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).
 *
282
 * If JavaScript is active then it is used to force the checkbox to be
283 284 285 286 287 288
 * 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 = '';
289

290 291 292 293
  // $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) {
294
      // Teaser is empty string.
295 296 297 298 299 300
      $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.)');
    }
301

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    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.
317
 *
318
 * If the end of the teaser is not indicated using the <!--break--> delimiter
319 320 321
 * 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).
322
 *
323 324 325 326
 * @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
327 328
 *   split it up to prevent parse errors. If the line break filter is present
 *   then we treat newlines embedded in $body as line breaks.
329
 * @param $size
Dries's avatar
Dries committed
330
 *   The desired character length of the teaser. If omitted, the default
331
 *   value will be used. Ignored if the special delimiter is present
332
 *   in $body.
333 334
 * @return
 *   The generated teaser.
Dries's avatar
 
Dries committed
335
 */
336
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
 
Dries committed
337

338 339 340
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
341

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

345
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
346
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
347 348
    return $body;
  }
Dries's avatar
 
Dries committed
349

350 351 352 353 354
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

355 356 357 358 359
  // 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);
360
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
361 362
      return $body;
    }
363 364
  }

365
  // If we have a short body, the entire body is the teaser.
366
  if (drupal_strlen($body) <= $size) {
Dries's avatar
 
Dries committed
367 368 369
    return $body;
  }

370 371 372
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

373 374
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
375 376 377 378 379 380 381 382 383 384

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

385
  // Store the reverse of the teaser. We use strpos on the reversed needle and
386
  // haystack for speed and convenience.
387 388
  $reversed = strrev($teaser);

389 390 391 392 393 394
  // 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);

395 396 397 398 399 400 401 402
  // 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;
403 404 405 406 407 408 409 410 411 412 413 414 415

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

418 419
    // If a break point was found in this group, slice and return the teaser.
    if ($min_rpos !== $max_rpos) {
420
      // Don't slice with length 0. Length must be <0 to slice from RHS.
421
      return ($min_rpos === 0) ? $teaser : substr($teaser, 0, 0 - $min_rpos);
422 423
    }
  }
424 425 426

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

429 430 431 432 433 434
/**
 * 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',
435
 *   'base', or 'name', only the specified node type is returned. When set to
436 437 438 439 440 441 442 443 444 445
 *   '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
446
 *   variable format. Returns FALSE if the node type is not found.
447 448 449
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
450

451 452
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
453
  }
454

455 456 457 458 459 460 461 462 463 464
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
465
    if (!isset($_node_types[$type])) {
466 467 468 469
      return FALSE;
    }
  }
  switch ($op) {
470 471 472
    case 'types':
      return $_node_types;
    case 'type':
473
      return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
474 475
    case 'base':
      return isset($_node_types[$type]->base) ? $_node_types[$type]->base : FALSE;
476 477
    case 'names':
      return $_node_names;
478
    case 'name':
479
      return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
  }
}

/**
 * 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);
    }
496 497 498
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
499
  }
500 501

  _node_types_build();
502 503
}

504
/**
505 506 507 508
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
509 510
 *
 * @return
511
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
512
 */
513 514 515
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
516
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
  $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,
  );
534 535

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

538
    module_invoke_all('node_type', 'update', $type);
539 540 541
    return SAVED_UPDATED;
  }
  else {
542 543
    $fields['orig_type'] = (string) $type->orig_type;
    db_insert('node_type')->fields($fields)->execute();
544

545
    module_invoke_all('node_type', 'insert', $type);
546 547
    return SAVED_NEW;
  }
548
}
549

550 551 552 553 554 555 556 557
/**
 * 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);
558
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
559 560 561
  module_invoke_all('node_type', 'delete', $info);
}

562
/**
563 564
 * Updates all nodes of one type to be of another type.
 *
565
 * @param $old_type
566 567 568
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
569 570
 *
 * @return
571
 *   The number of nodes whose node type field was modified.
572
 */
573 574 575
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
576
}
Dries's avatar
 
Dries committed
577

578
/**
579 580 581 582
 * 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
583 584
 *
 */
585 586 587 588 589 590 591
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;
592
    $_node_types[$type] = node_type_set_defaults($info);
593 594 595 596 597
    $_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)) {
598 599
    // 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
600 601 602
    // 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])) {
603
      $type_object->disabled = TRUE;
604
    }
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
    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);
}

/**
622 623 624 625 626 627 628 629 630 631 632
 * 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.
633
 */
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
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
670
}
Dries's avatar
 
Dries committed
671

672
/**
Dries's avatar
 
Dries committed
673 674 675 676 677 678 679 680 681 682
 * 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) {
683 684
  $base = node_get_types('base', $node);
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
685 686
}

687
/**
Dries's avatar
 
Dries committed
688 689 690 691 692 693 694 695 696
 * 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
697
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
698 699
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
700
  if (node_hook($node, $hook)) {
701 702
    $base = node_get_types('base', $node);
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
703
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
704 705 706
  }
}

Dries's avatar
 
Dries committed
707 708 709 710
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
711
 *   A node object.
Dries's avatar
 
Dries committed
712 713 714 715 716 717 718
 * @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
719
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
720
  $return = array();
721
  $hook = 'nodeapi_' . $op;
722 723
  foreach (module_implements($hook) as $module) {
    $function = $module . '_' . $hook;
724
    $result = $function($node, $a3, $a4);
725
    if (isset($result) && is_array($result)) {
726 727
      $return = array_merge($return, $result);
    }
728
    elseif (isset($result)) {
729
      $return[] = $result;
Dries's avatar
 
Dries committed
730 731 732 733 734
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
735
/**
736 737 738 739 740
 * 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
741
 *
742 743 744 745
 * @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
746 747
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
748 749
 *
 * @return
750
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
751
 */
752 753
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
  static $node_cache = array();
Dries's avatar
 
Dries committed
754
  if ($reset) {
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 782
    $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
783 784
  }

785
  // Exclude any nodes loaded from cache if they don't match $conditions.
786
  // This ensures the same behavior whether loading from memory or database.
787 788 789 790 791
  if ($conditions) {
    foreach ($nodes as $node) {
      $node_values = (array) $node;
      if (array_diff_assoc($conditions, $node_values)) {
        unset($nodes[$node->nid]);
792
      }
793
    }
Dries's avatar
 
Dries committed
794 795
  }

796 797 798 799 800 801 802 803 804 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 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');
    }
    $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);
839
      }
Dries's avatar
 
Dries committed
840
    }
841 842 843 844 845 846 847 848 849 850 851 852
    $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
853

854 855 856 857 858
    // 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);
859 860
      }
    }
861 862 863 864 865 866 867 868 869 870 871

    // 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;
872
    }
Dries's avatar
 
Dries committed
873 874
  }

875 876 877 878 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
  // 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
907 908
}

909 910 911 912 913 914 915 916 917
/**
 * 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.
918
  // TODO : use a better word counting algorithm that will work in other languages
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
  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)));
    }

936 937
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

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

956
  // Generate the teaser, but only if it hasn't been set (e.g. by a
957 958 959
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
960
      $node->format = (!empty($node->body_format) ? $node->body_format : FILTER_FORMAT_DEFAULT);
961
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
962 963 964 965
      // 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))) {
966 967 968 969 970
        $node->body = substr($node->body, strlen($node->teaser));
      }
    }
    else {
      $node->teaser = '';
971
      $node->format = 0;
972 973 974 975 976 977 978 979 980 981 982 983
    }
  }

  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;
    }
  }
984
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
985 986 987 988 989
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
990 991 992
/**
 * Save a node object into the database.
 */
993
function node_save(&$node) {
994 995
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
996
  global $user;
Dries's avatar
 
Dries committed
997

998
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
999

Dries's avatar
 
Dries committed
1000
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
1001
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
1002
    // Insert a new node.
1003
    $node->is_new = TRUE;
1004 1005

    // When inserting a node, $node->log must be set because
1006
    // {node_revision}.log does not (and cannot) have a default
1007
    // value. If the user does not have permission to create
1008 1009 1010 1011 1012
    // 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 = '';
    }
1013 1014

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