node.module 90.2 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 27 28 29 30 31 32 33
  if ($path != 'admin/content/node-settings/rebuild' && strpos($path, '#') === FALSE
      && 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');
  }

34
  switch ($path) {
Dries's avatar
 
Dries committed
35
    case 'admin/help#node':
36 37 38 39 40 41 42 43 44 45
      $output = '<p>'. t('All content in a website is stored and treated as <b>nodes</b>. Therefore nodes are any postings such as blogs, stories, polls and forums. The node module manages these content types and is one of the strengths of Drupal over other content management systems.') .'</p>';
      $output .= '<p>'. t('Treating all content as nodes allows the flexibility of creating new types of content. It also allows you to painlessly apply new features or changes to all content. Comments are not stored as nodes but are always associated with a node.') .'</p>';
      $output .= t('<p>Node module features</p>
<ul>
<li>The list tab provides an interface to search and sort all content on your site.</li>
<li>The configure settings tab has basic settings for content on your site.</li>
<li>The configure content types tab lists all content types for your site and lets you configure their default workflow.</li>
<li>The search tab lets you search all content on your site</li>
</ul>
');
46
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@node">Node page</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) .'</p>';
Dries's avatar
 
Dries committed
47
      return $output;
48 49
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
50 51 52
    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':
53
      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>';
54 55 56 57 58
    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);
59
      return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
Dries's avatar
 
Dries committed
60
  }
Dries's avatar
 
Dries committed
61

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

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

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

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

146
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
147 148
}

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

Dries's avatar
 
Dries committed
158 159 160
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
161 162 163 164
function node_tag_new($nid) {
  global $user;

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

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

Dries's avatar
 
Dries committed
182
  if (!isset($history[$nid])) {
183
    $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
184 185
  }

186
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
187 188 189
}

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

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

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

Dries's avatar
 
Dries committed
240
/**
241
 * Automatically generate a teaser for a node body.
242
 *
243 244 245 246
 * If the end of the teaser is not indicated using the <!--break--> delimiter
 * then we try 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).
 *
247 248 249 250
 * @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
251 252
 *   split it up to prevent parse errors. If the line break filter is present
 *   then we treat newlines embedded in $body as line breaks.
253
 * @param $size
Dries's avatar
Dries committed
254
 *   The desired character length of the teaser. If omitted, the default
255
 *   value will be used. Ignored if the special delimiter is present
256
 *   in $body.
257 258
 * @return
 *   The generated teaser.
Dries's avatar
 
Dries committed
259
 */
260
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
 
Dries committed
261

262 263 264
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
265

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

269
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
270
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
271 272
    return $body;
  }
Dries's avatar
 
Dries committed
273

274 275 276 277 278
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

279 280 281 282 283
  // 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);
284
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
285 286
      return $body;
    }
287 288
  }

289
  // If we have a short body, the entire body is the teaser.
290
  if (strlen($body) <= $size) {
Dries's avatar
 
Dries committed
291 292 293
    return $body;
  }

294 295 296
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

297 298
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
299 300 301 302 303 304 305 306 307 308 309 310

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

313 314 315 316 317 318
  // 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);

319 320 321 322 323 324 325 326
  // 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;
327 328 329 330 331 332 333 334 335 336 337 338 339

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

342 343 344 345
    // 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);
346 347
    }
  }
348 349 350

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

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
/**
 * 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
370
 *   variable format. Returns FALSE if the node type is not found.
371 372 373
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
374

375 376
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
377
  }
378

379 380 381 382 383 384 385 386 387 388
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
389
    if (!isset($_node_types[$type])) {
390 391 392 393
      return FALSE;
    }
  }
  switch ($op) {
394 395 396
    case 'types':
      return $_node_types;
    case 'type':
397
      return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
398
    case 'module':
399
      return isset($_node_types[$type]->module) ? $_node_types[$type]->module : FALSE;
400 401
    case 'names':
      return $_node_names;
402
    case 'name':
403
      return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
  }
}

/**
 * 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);
    }
420 421 422
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
423
  }
424 425

  _node_types_build();
426 427
}

428
/**
429 430 431 432
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
433 434
 *
 * @return
435
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
436
 */
437 438 439
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
440
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
441 442 443 444 445 446 447 448 449
  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 = '';
  }
450 451 452

  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);
453 454

    module_invoke_all('node_type', 'update', $info);
455 456 457 458
    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);
459 460

    module_invoke_all('node_type', 'insert', $info);
461 462
    return SAVED_NEW;
  }
463
}
464

465 466 467 468 469 470 471 472
/**
 * 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);
473
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
474 475 476
  module_invoke_all('node_type', 'delete', $info);
}

477
/**
478 479
 * Updates all nodes of one type to be of another type.
 *
480
 * @param $old_type
481 482 483
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
484 485
 *
 * @return
486
 *   The number of nodes whose node type field was modified.
487
 */
488 489 490
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
491
}
Dries's avatar
 
Dries committed
492

493
/**
494 495 496 497
 * 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
498 499
 *
 */
500 501 502 503 504 505 506 507 508 509 510 511 512
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)) {
513 514 515 516
    // 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])) {
517
      $type_object->disabled = TRUE;
518
    }
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
    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');
  }

553 554 555 556 557 558
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
559 560 561 562 563 564 565 566 567 568 569 570 571 572
  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
573
}
Dries's avatar
 
Dries committed
574

575
/**
Dries's avatar
 
Dries committed
576 577 578 579 580 581 582 583 584 585
 * 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) {
586 587 588 589 590
  $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
591 592
}

593
/**
Dries's avatar
 
Dries committed
594 595 596 597 598 599 600 601 602
 * 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
603
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
604 605
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
606
  if (node_hook($node, $hook)) {
607 608 609 610 611
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
 
Dries committed
612
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
613 614 615
  }
}

Dries's avatar
 
Dries committed
616 617 618 619
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
620
 *   A node object.
Dries's avatar
 
Dries committed
621 622 623 624 625 626 627
 * @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
628
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
629
  $return = array();
630
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
 
Dries committed
631
    $function = $name .'_nodeapi';
632
    $result = $function($node, $op, $a3, $a4);
633
    if (isset($result) && is_array($result)) {
634 635 636 637
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
 
Dries committed
638 639 640 641 642
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
643 644 645
/**
 * Load a node object from the database.
 *
646 647
 * @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
648 649
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
650 651
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
652 653 654 655
 *
 * @return
 *   A fully-populated node object.
 */
656
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
657 658 659 660 661 662
  static $nodes = array();

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

663
  $cachable = ($revision == NULL);
664
  $arguments = array();
665
  if (is_numeric($param)) {
666
    if ($cachable) {
667
      // Is the node statically cached?
668 669 670
      if (isset($nodes[$param])) {
        return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
      }
671
    }
672 673
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
 
Dries committed
674
  }
675
  elseif (is_array($param)) {
676
    // Turn the conditions into a query.
677
    foreach ($param as $key => $value) {
678 679
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
680 681
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
 
Dries committed
682
  }
683 684 685
  else {
    return FALSE;
  }
Dries's avatar
 
Dries committed
686

687 688 689
  // 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'));
690
  $fields = array_merge($fields, array('u.name', 'u.picture', 'u.data'));
691 692 693 694
  // 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'));
695
  $fields = implode(', ', $fields);
696
  // Rename timestamp field for clarity.
697
  $fields = str_replace('r.timestamp', 'r.timestamp AS revision_timestamp', $fields);
698 699
  // Change name of revision uid so it doesn't conflict with n.uid.
  $fields = str_replace('r.uid', 'r.uid AS revision_uid', $fields);
700

Dries's avatar
 
Dries committed
701
  // Retrieve the node.
702
  // No db_rewrite_sql is applied so as to get complete indexing for search.
703
  if ($revision) {
704
    array_unshift($arguments, $revision);
705
    $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
706
  }
707
  else {
708
    $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
709 710
  }

711
  if ($node && $node->nid) {
712 713 714 715 716 717
    // 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
718 719
    }

720 721 722 723 724
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
725 726 727
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
 
Dries committed
728 729
  }

Dries's avatar
 
Dries committed
730 731 732
  return $node;
}

733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
/**
 * 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;

  // Auto-generate the teaser, but only if it hasn't been set (e.g. by a
  // 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.
786
      if (empty($node->teaser_include) && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
        $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;
    }
  }
804
  $node->created = !empty($node->date) ? strtotime($node->date) : time();
805 806 807 808 809
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
810 811 812
/**
 * Save a node object into the database.
 */
813
function node_save(&$node) {
814 815
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
816
  global $user;
Dries's avatar
 
Dries committed
817

818
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
819

Dries's avatar
 
Dries committed
820
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
821
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
822
    // Insert a new node.
823
    $node->is_new = TRUE;
824 825 826 827 828 829 830 831 832

    // 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 = '';
    }
833
  }
834 835 836
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
  }
837
  else {
838 839 840
    // When updating a node, avoid clobberring an existing log entry with an empty one.
    if (empty($node->log)) {
      unset($node->log);
841
    }
Dries's avatar
 
Dries committed
842 843
  }

844 845 846 847
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
848
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
849
  $node->changed = time();
Dries's avatar
 
Dries committed
850

851 852
  $node->timestamp = time();
  $node->format = isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT;
853
  $update_node = TRUE;
854

855 856 857
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
858
    drupal_write_record('node', $node);
859
    _node_save_revision($node, $user->uid);
860
    $op = 'insert';
861 862
  }
  else {
863
    drupal_write_record('node', $node, 'nid');
864
    if (!empty($node->revision)) {
865
      _node_save_revision($node, $user->uid);
866 867
    }
    else {
868
      _node_save_revision($node, $user->uid, 'vid');
869
      $update_node = FALSE;
Dries's avatar
 
Dries committed
870
    }
871
    $op = 'update';
872
  }
873
  if ($update_node) {
874
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
875 876
  }

877 878 879 880
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

881 882 883
  // Update the node access table for this node.
  node_access_acquire_grants($node);

884
  // Clear the page and block caches.
Dries's avatar
 
Dries committed
885
  cache_clear_all();
Dries's avatar
 
Dries committed
886 887
}

888 889

/**
890 891 892 893
 * 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.
894
 */
895
function _node_save_revision(&$node, $uid, $update = NULL) {
896 897 898 899 900 901 902 903 904 905 906
  $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;
}

907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
/**
 * 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');
    }
    drupal_set_message(t('%title has been deleted.', array('%title' => $node->title)));
    watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
  }
}

Dries's avatar
 
Dries committed
934 935 936 937 938 939
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
940
 *   Whether to display the teaser only or the full form.
Dries's avatar
 
Dries committed
941 942
 * @param $page
 *   Whether the node is being displayed by itself as a page.
943 944
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
 
Dries committed
945 946 947 948
 *
 * @return
 *   An HTML representation of the themed node.
 */
949
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
950
  $node = (object)$node;
Dries's avatar
 
Dries committed
951

952 953
  $node = node_build_content($node, $teaser, $page);

954
  if ($links) {
955
    $node->links = module_invoke_all('link', 'node', $node, $teaser);
956
    drupal_alter('link', $node->links, $node);
957
  }
958 959 960 961

  // Set the proper node part, then unset unused $node part so that a bad
  // theme can not open a security hole.
  $content = drupal_render($node->content);
962
  if ($teaser) {
963
    $node->teaser = $content;
964 965 966
    unset($node->body);
  }
  else {
967
    $node->body = $content;
968 969
    unset($node->teaser);