node.module 97.6 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
  );
}

Dries's avatar
 
Dries committed
141 142 143
/**
 * Implementation of hook_cron().
 */
144
function node_cron() {
Dries's avatar
 
Dries committed
145
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
146 147
}

Dries's avatar
 
Dries committed
148 149 150 151
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
152 153 154 155
 *   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
156 157 158 159
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
160 161
 *   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
162
 */
Dries's avatar
 
Dries committed
163
function node_title_list($result, $title = NULL) {
164
  $items = array();
165
  $num_rows = FALSE;
Dries's avatar
 
Dries committed
166
  while ($node = db_fetch_object($result)) {
167
    $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());
168
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
169 170
  }

171
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
172 173
}

Dries's avatar
 
Dries committed
174 175
/**
 * Format a listing of links to nodes.
176 177
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
178
 */
Dries's avatar
 
Dries committed
179
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
180
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
181 182
}

Dries's avatar
 
Dries committed
183 184 185
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
186 187 188 189
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
190
    if (node_last_viewed($nid)) {
191
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', REQUEST_TIME, $user->uid, $nid);
Dries's avatar
 
Dries committed
192 193
    }
    else {
194
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, REQUEST_TIME);
Dries's avatar
 
Dries committed
195 196 197 198
    }
  }
}

Dries's avatar
 
Dries committed
199 200 201 202
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
203 204
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
205
  static $history;
Dries's avatar
 
Dries committed
206

Dries's avatar
 
Dries committed
207
  if (!isset($history[$nid])) {
208
    $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
209 210
  }

211
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
212 213 214
}

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

228 229 230
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
231
  if (!isset($cache[$nid])) {
232
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
233
  }
234 235 236 237 238 239 240
  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
241 242
}

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

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

284 285 286 287
  // $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) {
288
      // Teaser is empty string.
289 290 291 292 293 294
      $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.)');
    }
295

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

332 333 334
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
335

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

339
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
340
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
341 342
    return $body;
  }
Dries's avatar
 
Dries committed
343

344 345 346 347 348
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

349 350 351 352 353
  // 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);
354
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
355 356
      return $body;
    }
357 358
  }

359
  // If we have a short body, the entire body is the teaser.
360
  if (drupal_strlen($body) <= $size) {
Dries's avatar
 
Dries committed
361 362 363
    return $body;
  }

364 365 366
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

367 368
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
369 370 371 372 373 374 375 376 377 378 379 380

  // 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.
381 382
  $reversed = strrev($teaser);

383 384 385 386 387 388
  // 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);

389 390 391 392 393 394 395 396
  // 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;
397 398 399 400 401 402 403 404 405 406 407 408 409

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

412 413 414 415
    // 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);
416 417
    }
  }
418 419 420

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

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
/**
 * 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
440
 *   variable format. Returns FALSE if the node type is not found.
441 442 443
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
444

445 446
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
447
  }
448

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

/**
 * 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);
    }
490 491 492
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
493
  }
494 495

  _node_types_build();
496 497
}

498
/**
499 500 501 502
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
503 504
 *
 * @return
505
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
506
 */
507 508 509
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
510
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
511 512 513
  if (!isset($info->help)) {
    $info->help = '';
  }
514
  if (empty($info->min_word_count)) {
515 516 517 518 519
    $info->min_word_count = 0;
  }
  if (!isset($info->body_label)) {
    $info->body_label = '';
  }
520 521 522 523 524 525
  if (empty($info->custom)) {
    $info->custom = 0;
  }
  if (empty($info->locked)) {
    $info->locked = 0;
  }
526 527 528

  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);
529 530

    module_invoke_all('node_type', 'update', $info);
531 532 533 534
    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);
535 536

    module_invoke_all('node_type', 'insert', $info);
537 538
    return SAVED_NEW;
  }
539
}
540

541 542 543 544 545 546 547 548
/**
 * 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);
549
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
550 551 552
  module_invoke_all('node_type', 'delete', $info);
}

553
/**
554 555
 * Updates all nodes of one type to be of another type.
 *
556
 * @param $old_type
557 558 559
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
560 561
 *
 * @return
562
 *   The number of nodes whose node type field was modified.
563
 */
564 565 566
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
567
}
Dries's avatar
 
Dries committed
568

569
/**
570 571 572 573
 * 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
574 575
 *
 */
576 577 578 579 580 581 582 583 584 585 586 587 588
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)) {
589 590 591 592
    // 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])) {
593
      $type_object->disabled = TRUE;
594
    }
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
    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');
  }

629 630 631 632 633 634
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
635 636 637 638 639 640 641 642 643 644 645 646 647 648
  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
649
}
Dries's avatar
 
Dries committed
650

651
/**
Dries's avatar
 
Dries committed
652 653 654 655 656 657 658 659 660 661
 * 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) {
662 663
  $module = node_get_types('module', $node);
  if ($module == 'node') {
664 665
    // Avoid function name collisions.
    $module = 'node_content';
666 667
  }
  return module_hook($module, $hook);
Dries's avatar
 
Dries committed
668 669
}

670
/**
Dries's avatar
 
Dries committed
671 672 673 674 675 676 677 678 679
 * 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
680
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
681 682
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
683
  if (node_hook($node, $hook)) {
684 685 686 687
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
688
    $function = $module . '_' . $hook;
Dries's avatar
 
Dries committed
689
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
690 691 692
  }
}

Dries's avatar
 
Dries committed
693 694 695 696
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
697
 *   A node object.
Dries's avatar
 
Dries committed
698 699 700 701 702 703 704
 * @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
705
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
706
  $return = array();
707 708 709 710
  $hook = 'nodeapi_' . $op;
  foreach (module_implements($hook) as $name) {
    $function = $name . '_' . $hook;
    $result = $function($node, $a3, $a4);
711
    if (isset($result) && is_array($result)) {
712 713 714 715
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
 
Dries committed
716 717 718 719 720
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
721 722 723
/**
 * Load a node object from the database.
 *
724 725
 * @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
726 727
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
728 729
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
730 731 732 733
 *
 * @return
 *   A fully-populated node object.
 */
734
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
735 736 737 738 739 740
  static $nodes = array();

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

741
  $cachable = ($revision == NULL);
742
  $arguments = array();
743
  if (is_numeric($param)) {
744
    if ($cachable) {
745
      // Is the node statically cached?
746
      if (isset($nodes[$param])) {
747
        return is_object($nodes[$param]) ? clone $nodes[$param] : $nodes[$param];
748
      }
749
    }
750 751
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
 
Dries committed
752
  }
753
  elseif (is_array($param)) {
754
    // Turn the conditions into a query.
755
    foreach ($param as $key => $value) {
756
      $cond[] = 'n.' . db_escape_table($key) . " = '%s'";
757
      $arguments[] = $value;
758 759
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
 
Dries committed
760
  }
761 762 763
  else {
    return FALSE;
  }
Dries's avatar
 
Dries committed
764

765 766 767
  // 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'));
768
  $fields = array_merge($fields, array('u.name', 'u.picture', 'u.data'));
769 770 771 772
  // 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'));
773
  $fields = implode(', ', $fields);
774
  // Rename timestamp field for clarity.
775
  $fields = str_replace('r.timestamp', 'r.timestamp AS revision_timestamp', $fields);
776 777
  // Change name of revision uid so it doesn't conflict with n.uid.
  $fields = str_replace('r.uid', 'r.uid AS revision_uid', $fields);
778

Dries's avatar
 
Dries committed
779
  // Retrieve the node.
780
  // No db_rewrite_sql is applied so as to get complete indexing for search.
781
  if ($revision) {
782
    array_unshift($arguments, $revision);
783
    $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
784
  }
785
  else {
786
    $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
787 788
  }

789
  if ($node && $node->nid) {
790 791 792 793 794 795
    // 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
796 797
    }

798 799 800 801 802
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
803
    if ($cachable) {
804
      $nodes[$node->nid] = is_object($node) ? clone $node : $node;
805
    }
Dries's avatar
 
Dries committed
806 807
  }

Dries's avatar
 
Dries committed
808 809 810
  return $node;
}

811 812 813 814 815 816 817 818 819
/**
 * 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.
820
  // TODO : use a better word counting algorithm that will work in other languages
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
  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;

858
  // Generate the teaser, but only if it hasn't been set (e.g. by a
859 860 861
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
862
      $node->format = (!empty($node->body_format) ? $node->body_format : FILTER_FORMAT_DEFAULT);
863
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
864 865 866 867
      // 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))) {
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
        $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;
    }
  }
885
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
886 887 888 889 890
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
891 892 893
/**
 * Save a node object into the database.
 */
894
function node_save(&$node) {
895 896
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
897
  global $user;
Dries's avatar
 
Dries committed
898

899
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
900

Dries's avatar
 
Dries committed
901
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
902
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
903
    // Insert a new node.
904
    $node->is_new = TRUE;
905 906 907 908 909 910 911 912 913

    // 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 = '';
    }
914 915 916 917 918 919 920 921 922 923

    // 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 = '';
    }
924
  }
925 926 927
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
  }
928
  else {
929 930 931
    // When updating a node, avoid clobberring an existing log entry with an empty one.
    if (empty($node->log)) {
      unset($node->log);
932
    }
Dries's avatar
 
Dries committed
933 934
  }

935 936
  // Set some required fields:
  if (empty($node->created)) {
937
    $node->created = REQUEST_TIME;
938
  }
939
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
940
  $node->changed = REQUEST_TIME;
Dries's avatar
 
Dries committed
941

942
  $node->timestamp = REQUEST_TIME;
943
  $update_node = TRUE;
944

945
  // Generate the node table query and the node_revisions table query.
946
  if ($node->is_new) {
947
    drupal_write_record('node', $node);
948
    _node_save_revision($node, $user->uid);
949
    $op = 'insert';
950 951
  }
  else {
952
    drupal_write_record('node', $node, 'nid');
953
    if (!empty($node->revision)) {
954
      _node_save_revision($node, $user->uid);
955 956
    }
    else {
957
      _node_save_revision($node, $user->uid, 'vid');
958
      $update_node = FALSE;
Dries's avatar
 
Dries committed
959
    }
960
    $op = 'update';
961
  }
962
  if ($update_node) {
963
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
964 965
  }

966 967 968
  // Call the node specific callback (if any). This can be
  // node_invoke($node, 'insert') or
  // node_invoke($node, 'update').
969 970 971
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);