node.module 92.8 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
define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);

12 13 14 15 16
define('NODE_BUILD_NORMAL', 0);
define('NODE_BUILD_PREVIEW', 1);
define('NODE_BUILD_SEARCH_INDEX', 2);
define('NODE_BUILD_SEARCH_RESULT', 3);
define('NODE_BUILD_RSS', 4);
Dries's avatar
Dries committed
17
define('NODE_BUILD_PRINT', 5);
18

Dries's avatar
 
Dries committed
19 20 21
/**
 * Implementation of hook_help().
 */
22
function node_help($path, $arg) {
23 24 25 26
  // 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
27 28 29 30 31 32 33 34 35 36
      && 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');
  }

37
  switch ($path) {
Dries's avatar
 
Dries committed
38
    case 'admin/help#node':
39 40
      $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/content/types'))) .'</p>';
41
      $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>';
42
      $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
43
      return $output;
44 45
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
46 47 48
    case 'admin/content/types':
      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>';
    case 'admin/content/types/add':
49
      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>';
50 51 52 53 54
    case 'node/%/revisions':
      return '<p>'. t('The revisions let you track differences between multiple versions of a post.') .'</p>';
    case 'node/%/edit':
      $node = node_load($arg[1]);
      $type = node_get_types('type', $node->type);
55
      return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
Dries's avatar
 
Dries committed
56
  }
Dries's avatar
 
Dries committed
57

58 59
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
    $type = node_get_types('type', str_replace('-', '_', $arg[2]));
60
    return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
61
  }
Dries's avatar
 
Dries committed
62 63
}

64 65 66 67 68
/**
 * Implementation of hook_theme()
 */
function node_theme() {
  return array(
69 70
    'node' => array(
      'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
71
      'template' => 'node',
72
    ),
73 74 75 76 77 78 79 80
    '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),
81
      'file' => 'node.admin.inc',
82 83 84
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
85
      'file' => 'node.admin.inc',
86 87 88
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
89 90 91 92 93
      'file' => 'node.admin.inc',
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
      'file' => 'node.pages.inc',
94 95 96
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
97
      'file' => 'node.pages.inc',
98 99 100
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
101
      'file' => 'node.pages.inc',
102 103 104 105
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
106 107 108
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
109 110 111
  );
}

Dries's avatar
 
Dries committed
112 113 114
/**
 * Implementation of hook_cron().
 */
115
function node_cron() {
Dries's avatar
 
Dries committed
116
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
117 118
}

Dries's avatar
 
Dries committed
119 120 121 122
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
123 124 125 126
 *   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
127 128 129 130
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
131 132
 *   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
133
 */
Dries's avatar
 
Dries committed
134
function node_title_list($result, $title = NULL) {
135
  $items = array();
136
  $num_rows = FALSE;
Dries's avatar
 
Dries committed
137
  while ($node = db_fetch_object($result)) {
138
    $items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
139
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
140 141
  }

142
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
143 144
}

Dries's avatar
 
Dries committed
145 146
/**
 * Format a listing of links to nodes.
147 148
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
149
 */
Dries's avatar
 
Dries committed
150
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
151
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
152 153
}

Dries's avatar
 
Dries committed
154 155 156
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
157 158 159 160
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
161
    if (node_last_viewed($nid)) {
Dries's avatar
 
Dries committed
162
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
163 164
    }
    else {
Dries's avatar
 
Dries committed
165
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
166 167 168 169
    }
  }
}

Dries's avatar
 
Dries committed
170 171 172 173
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
174 175
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
176
  static $history;
Dries's avatar
 
Dries committed
177

Dries's avatar
 
Dries committed
178
  if (!isset($history[$nid])) {
179
    $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
180 181
  }

182
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
183 184 185
}

/**
186
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
187
 *
Dries's avatar
 
Dries committed
188 189 190 191
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
192 193
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
194
 */
195
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
196 197 198
  global $user;
  static $cache;

199 200 201
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
202
  if (!isset($cache[$nid])) {
203
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
204
  }
205 206 207 208 209 210 211
  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
212 213
}

214 215 216
/**
 * See if the user used JS to submit a teaser.
 */
217
function node_teaser_js(&$form, &$form_state) {
218
  if (isset($form['#post']['teaser_js'])) {
219
    // Glue the teaser to the body.
220
    if (trim($form_state['values']['teaser_js'])) {
221
      // Space the teaser from the body
222
      $body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
223 224 225
    }
    else {
      // Empty teaser, no spaces.
226
      $body = '<!--break-->'. $form_state['values']['body'];
227
    }
228
    // Pass updated body value on to preview/submit form processing.
229
    form_set_value($form['body'], $body, $form_state);
230 231
    // Pass updated body value back onto form for those cases
    // in which the form is redisplayed.
232 233 234 235 236
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries's avatar
 
Dries committed
237
/**
238 239 240 241 242 243 244 245 246
 * Ensure value of "teaser_include" checkbox is consistent with other form data 
 *
 * 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).
 *
247
 * If JavaScript is active then it is used to force the checkbox to be
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
 * 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 = '';
  
  // $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) {
      // Teaser is empty string
      $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.)');
    }
    
    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.
282
 *
283
 * If the end of the teaser is not indicated using the <!--break--> delimiter
284 285 286
 * 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).
287
 *
288 289 290 291
 * @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
292 293
 *   split it up to prevent parse errors. If the line break filter is present
 *   then we treat newlines embedded in $body as line breaks.
294
 * @param $size
Dries's avatar
Dries committed
295
 *   The desired character length of the teaser. If omitted, the default
296
 *   value will be used. Ignored if the special delimiter is present
297
 *   in $body.
298 299
 * @return
 *   The generated teaser.
Dries's avatar
 
Dries committed
300
 */
301
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
 
Dries committed
302

303 304 305
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
306

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

310
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
311
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
312 313
    return $body;
  }
Dries's avatar
 
Dries committed
314

315 316 317 318 319
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

320 321 322 323 324
  // 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);
325
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
326 327
      return $body;
    }
328 329
  }

330
  // If we have a short body, the entire body is the teaser.
331
  if (strlen($body) <= $size) {
Dries's avatar
 
Dries committed
332 333 334
    return $body;
  }

335 336 337
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

338 339
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
340 341 342 343 344 345 346 347 348 349 350 351

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

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

354 355 356 357 358 359
  // 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);

360 361 362 363 364 365 366 367
  // 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;
368 369 370 371 372 373 374 375 376 377 378 379 380

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

383 384 385 386
    // If a break point was found in this group, slice and return the teaser.
    if ($min_rpos !== $max_rpos) {
      // Don't slice with length 0.  Length must be <0 to slice from RHS.
      return ($min_rpos === 0) ? $teaser : substr($teaser, 0, 0 - $min_rpos);
387 388
    }
  }
389 390 391

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

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
/**
 * 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',
 *   'module', or 'name', only the specified node type is returned. When set to
 *   '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
411
 *   variable format. Returns FALSE if the node type is not found.
412 413 414
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
415

416 417
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
418
  }
419

420 421 422 423 424 425 426 427 428 429
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
430
    if (!isset($_node_types[$type])) {
431 432 433 434
      return FALSE;
    }
  }
  switch ($op) {
435 436 437
    case 'types':
      return $_node_types;
    case 'type':
438
      return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
439
    case 'module':
440
      return isset($_node_types[$type]->module) ? $_node_types[$type]->module : FALSE;
441 442
    case 'names':
      return $_node_names;
443
    case 'name':
444
      return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
  }
}

/**
 * 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);
    }
461 462 463
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
464
  }
465 466

  _node_types_build();
467 468
}

469
/**
470 471 472 473
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
474 475
 *
 * @return
476
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
477
 */
478 479 480
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
481
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
482 483 484 485 486 487 488 489 490
  if (!isset($info->help)) {
    $info->help = '';
  }
  if (!isset($info->min_word_count)) {
    $info->min_word_count = 0;
  }
  if (!isset($info->body_label)) {
    $info->body_label = '';
  }
491 492 493

  if ($is_existing) {
    db_query("UPDATE {node_type} SET type = '%s', name = '%s', module = '%s', has_title = %d, title_label = '%s', has_body = %d, body_label = '%s', description = '%s', help = '%s', min_word_count = %d, custom = %d, modified = %d, locked = %d WHERE type = '%s'", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $existing_type);
494 495

    module_invoke_all('node_type', 'update', $info);
496 497 498 499
    return SAVED_UPDATED;
  }
  else {
    db_query("INSERT INTO {node_type} (type, name, module, has_title, title_label, has_body, body_label, description, help, min_word_count, custom, modified, locked, orig_type) VALUES ('%s', '%s', '%s', %d, '%s', %d, '%s', '%s', '%s', %d, %d, %d, %d, '%s')", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $info->orig_type);
500 501

    module_invoke_all('node_type', 'insert', $info);
502 503
    return SAVED_NEW;
  }
504
}
505

506 507 508 509 510 511 512 513
/**
 * 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);
514
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
515 516 517
  module_invoke_all('node_type', 'delete', $info);
}

518
/**
519 520
 * Updates all nodes of one type to be of another type.
 *
521
 * @param $old_type
522 523 524
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
525 526
 *
 * @return
527
 *   The number of nodes whose node type field was modified.
528
 */
529 530 531
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
532
}
Dries's avatar
 
Dries committed
533

534
/**
535 536 537 538
 * 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
539 540
 *
 */
541 542 543 544 545 546 547 548 549 550 551 552 553
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;
    $_node_types[$type] = (object) _node_type_set_defaults($info);
    $_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)) {
554 555 556 557
    // 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
    // module using hook_node_info) have a module value of 'node'.
    if ($type_object->module != 'node' && empty($info_array[$type_object->type])) {
558
      $type_object->disabled = TRUE;
559
    }
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
    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);
}

/**
 * Set default values for a node type defined through hook_node_info().
 */
function _node_type_set_defaults($info) {
  if (!isset($info['has_title'])) {
    $info['has_title'] = TRUE;
  }
  if ($info['has_title'] && !isset($info['title_label'])) {
    $info['title_label'] = t('Title');
  }

  if (!isset($info['has_body'])) {
    $info['has_body'] = TRUE;
  }
  if ($info['has_body'] && !isset($info['body_label'])) {
    $info['body_label'] = t('Body');
  }

594 595 596 597 598 599
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
600 601 602 603 604 605 606 607 608 609 610 611 612 613
  if (!isset($info['custom'])) {
    $info['custom'] = FALSE;
  }
  if (!isset($info['modified'])) {
    $info['modified'] = FALSE;
  }
  if (!isset($info['locked'])) {
    $info['locked'] = TRUE;
  }

  $info['orig_type'] = $info['type'];
  $info['is_new'] = TRUE;

  return $info;
Dries's avatar
 
Dries committed
614
}
Dries's avatar
 
Dries committed
615

616
/**
Dries's avatar
 
Dries committed
617 618 619 620 621 622 623 624 625 626
 * 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) {
627 628 629 630 631
  $module = node_get_types('module', $node);
  if ($module == 'node') {
    $module = 'node_content'; // Avoid function name collisions.
  }
  return module_hook($module, $hook);
Dries's avatar
 
Dries committed
632 633
}

634
/**
Dries's avatar
 
Dries committed
635 636 637 638 639 640 641 642 643
 * 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
644
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
645 646
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
647
  if (node_hook($node, $hook)) {
648 649 650 651 652
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
 
Dries committed
653
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
654 655 656
  }
}

Dries's avatar
 
Dries committed
657 658 659 660
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
661
 *   A node object.
Dries's avatar
 
Dries committed
662 663 664 665 666 667 668
 * @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
669
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
670
  $return = array();
671
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
 
Dries committed
672
    $function = $name .'_nodeapi';
673
    $result = $function($node, $op, $a3, $a4);
674
    if (isset($result) && is_array($result)) {
675 676 677 678
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
 
Dries committed
679 680 681 682 683
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
684 685 686
/**
 * Load a node object from the database.
 *
687 688
 * @param $param
 *   Either the nid of the node or an array of conditions to match against in the database query
Dries's avatar
 
Dries committed
689 690
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
691 692
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
693 694 695 696
 *
 * @return
 *   A fully-populated node object.
 */
697
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
698 699 700 701 702 703
  static $nodes = array();

  if ($reset) {
    $nodes = array();
  }

704
  $cachable = ($revision == NULL);
705
  $arguments = array();
706
  if (is_numeric($param)) {
707
    if ($cachable) {
708
      // Is the node statically cached?
709 710 711
      if (isset($nodes[$param])) {
        return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
      }
712
    }
713 714
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
 
Dries committed
715
  }
716
  elseif (is_array($param)) {
717
    // Turn the conditions into a query.
718
    foreach ($param as $key => $value) {
719 720
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
721 722
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
 
Dries committed
723
  }
724 725 726
  else {
    return FALSE;
  }
Dries's avatar
 
Dries committed
727

728 729 730
  // Retrieve a field list based on the site's schema.
  $fields = drupal_schema_fields_sql('node', 'n');
  $fields = array_merge($fields, drupal_schema_fields_sql('node_revisions', 'r'));
731
  $fields = array_merge($fields, array('u.name', 'u.picture', 'u.data'));
732 733 734 735
  // Remove fields not needed in the query: n.vid and r.nid are redundant,
  // n.title is unnecessary because the node title comes from the
  // node_revisions table.  We'll keep r.vid, r.title, and n.nid.
  $fields = array_diff($fields, array('n.vid', 'n.title', 'r.nid'));
736
  $fields = implode(', ', $fields);
737
  // Rename timestamp field for clarity.
738
  $fields = str_replace('r.timestamp', 'r.timestamp AS revision_timestamp', $fields);
739 740
  // Change name of revision uid so it doesn't conflict with n.uid.
  $fields = str_replace('r.uid', 'r.uid AS revision_uid', $fields);
741

Dries's avatar
 
Dries committed
742
  // Retrieve the node.
743
  // No db_rewrite_sql is applied so as to get complete indexing for search.
744
  if ($revision) {
745
    array_unshift($arguments, $revision);
746
    $node = db_fetch_object(db_query('SELECT '. $fields .' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.nid = n.nid AND r.vid = %d WHERE '. $cond, $arguments));
Dries's avatar
 
Dries committed
747
  }
748
  else {
749
    $node = db_fetch_object(db_query('SELECT '. $fields .' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.vid = n.vid WHERE '. $cond, $arguments));
Dries's avatar
 
Dries committed
750 751
  }

752
  if ($node && $node->nid) {
753 754 755 756 757 758
    // Call the node specific callback (if any) and piggy-back the
    // results to the node or overwrite some values.
    if ($extra = node_invoke($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
Dries's avatar
 
Dries committed
759 760
    }

761 762 763 764 765
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
766 767 768
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
 
Dries committed
769 770
  }

Dries's avatar
 
Dries committed
771 772 773
  return $node;
}

774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
/**
 * 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.
  // todo use a better word counting algorithm that will work in other languages
  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)));
    }

    // Validate the "authored on" field. As of PHP 5.1.0, strtotime returns FALSE instead of -1 upon failure.
    if (!empty($node->date) && strtotime($node->date) <= 0) {
      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;

821
  // Generate the teaser, but only if it hasn't been set (e.g. by a
822 823 824 825 826
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
      // Chop off the teaser from the body if needed.
827
      if (empty($node->teaser_include) && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
        $node->body = substr($node->body, strlen($node->teaser));
      }
    }
    else {
      $node->teaser = '';
    }
  }

  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;
    }
  }
845
  $node->created = !empty($node->date) ? strtotime($node->date) : time();
846 847 848 849 850
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
851 852 853
/**
 * Save a node object into the database.
 */
854
function node_save(&$node) {
855 856
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
857
  global $user;
Dries's avatar
 
Dries committed
858

859
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
860

Dries's avatar
 
Dries committed
861
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
862
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
863
    // Insert a new node.
864
    $node->is_new = TRUE;
865 866 867 868 869 870 871 872 873

    // When inserting a node, $node->log must be set because
    // {node_revisions}.log does not (and cannot) have a default
    // value.  If the user does not have permission to create
    // 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 = '';
    }
874 875 876 877 878 879 880 881 882 883

    // For the same reasons, make sure we have $node->teaser and
    // $node->body.  We should consider making these fields nullable
    // 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 = '';
    }
884
  }
885 886 887
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
  }
888
  else {
889 890 891
    // When updating a node, avoid clobberring an existing log entry with an empty one.
    if (empty($node->log)) {
      unset($node->log);
892
    }
Dries's avatar
 
Dries committed
893 894
  }

895 896 897 898
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
899
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
900
  $node->changed = time();
Dries's avatar
 
Dries committed
901

902 903
  $node->timestamp = time();
  $node->format = isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT;
904
  $update_node = TRUE;
905

906 907 908
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
909
    drupal_write_record('node', $node);
910
    _node_save_revision($node, $user->uid);
911
    $op = 'insert';
912 913
  }
  else {
914
    drupal_write_record('node', $node, 'nid');
915
    if (!empty($node->revision)) {
916
      _node_save_revision($node, $user->uid);
917 918
    }
    else {
919
      _node_save_revision($node, $user->uid, 'vid');
920
      $update_node = FALSE;
Dries's avatar
 
Dries committed
921
    }
922
    $op = 'update';
923
  }
924
  if ($update_node) {
925
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
926 927
  }

928 929 930 931
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

932 933 934
  // Update the node access table for this node.
  node_access_acquire_grants($node);

935
  // Clear the page and block caches.
Dries's avatar
 
Dries committed
936
  cache_clear_all();
Dries's avatar
 
Dries committed
937 938
}

939 940

/**
941 942 943 944
 * Helper function to save a revision with the uid of the current user.
 *
 * Node is taken by reference, becuse drupal_write_record() updates the
 * $node with the revision id, and we need to pass that back to the caller.
945
 */
946
function _node_save_revision(&$node, $uid, $update = NULL) {
947 948 949 950 951 952 953 954 955 956 957
  $temp_uid = $node->uid;
  $node->uid = $uid;
  if (isset($update)) {
    drupal_write_record('node_revisions', $node, $update);
  }
  else {
    drupal_write_record('node_revisions', $node);
  }
  $node->uid = $temp_uid;
}

958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
/**
 * 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);
    db_query('DELETE FROM {node_revisions} WHERE nid = %d', $node->nid);

    // 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.
    if (function_exists('search_wipe')) {
      search_wipe($node->nid, 'node');
    }
    watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
981
    drupal_set_message(t('@type %title has been deleted.', array('@type' => node_get_types('name', $node), '%title' => $node->title)));
Dries's avatar