node.module 120 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 17
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
18 19 20
/**
 * Implementation of hook_help().
 */
21 22
function node_help($path, $arg) {
  switch ($path) {
Dries's avatar
 
Dries committed
23
    case 'admin/help#node':
24 25 26 27 28 29 30 31 32 33
      $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>
');
34
      $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
35
      return $output;
36 37
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
38
    case 'admin/content/search':
39
      return '<p>'. t('Enter a simple pattern to search for a post. Words are matched exactly. Phrases can be surrounded by quotes to do an exact search.') .'</p>';
40 41 42
    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':
43
      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>';
44 45 46 47 48 49
    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);
      return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
Dries's avatar
 
Dries committed
50
  }
Dries's avatar
 
Dries committed
51

52 53
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
    $type = node_get_types('type', str_replace('-', '_', $arg[2]));
54
    return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
55
  }
Dries's avatar
 
Dries committed
56 57
}

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
/**
 * Implementation of hook_theme()
 */
function node_theme() {
  return array(
    '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),
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
87 88 89
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
90 91 92
  );
}

Dries's avatar
 
Dries committed
93 94 95
/**
 * Implementation of hook_cron().
 */
96
function node_cron() {
Dries's avatar
 
Dries committed
97
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
98 99
}

Dries's avatar
 
Dries committed
100 101 102 103
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
104
 *   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
105 106 107 108 109 110
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
 *   An HTML list suitable as content for a block.
 */
Dries's avatar
 
Dries committed
111 112
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
113
    $items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
Dries's avatar
 
Dries committed
114 115
  }

Dries's avatar
 
Dries committed
116
  return theme('node_list', $items, $title);
Dries's avatar
 
Dries committed
117 118
}

Dries's avatar
 
Dries committed
119 120 121
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
 
Dries committed
122
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
123
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
124 125
}

Dries's avatar
 
Dries committed
126 127 128
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
129 130 131 132
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
133
    if (node_last_viewed($nid)) {
Dries's avatar
 
Dries committed
134
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
135 136
    }
    else {
Dries's avatar
 
Dries committed
137
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
138 139 140 141
    }
  }
}

Dries's avatar
 
Dries committed
142 143 144 145
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
146 147
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
148
  static $history;
Dries's avatar
 
Dries committed
149

Dries's avatar
 
Dries committed
150
  if (!isset($history[$nid])) {
151
    $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
152 153
  }

154
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
155 156 157
}

/**
158
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
159
 *
Dries's avatar
 
Dries committed
160 161 162 163
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
164 165
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
166
 */
167
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
168 169 170
  global $user;
  static $cache;

171 172 173
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
174
  if (!isset($cache[$nid])) {
175
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
176
  }
177 178 179 180 181 182 183
  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
184 185
}

186 187 188
/**
 * See if the user used JS to submit a teaser.
 */
189
function node_teaser_js(&$form, &$form_state) {
190 191
  // Glue the teaser to the body.
  if (isset($form['#post']['teaser_js'])) {
192
    if (trim($form_state['values']['teaser_js'])) {
193
      // Space the teaser from the body
194
      $body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
195 196 197
    }
    else {
      // Empty teaser, no spaces.
198
      $body = '<!--break-->'. $form_state['values']['body'];
199 200
    }
    // Pass value onto preview/submit
201
    form_set_value($form['body'], $body, $form_state);
202 203 204 205 206 207
    // Pass value back onto form
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries's avatar
 
Dries committed
208
/**
209
 * Automatically generate a teaser for a node body in a given format.
210 211 212 213 214 215 216
 *
 * @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
 *   split it up to prevent parse errors.
 * @param $size
Dries's avatar
Dries committed
217
 *   The desired character length of the teaser. If omitted, the default
218 219 220
 *   value will be used.
 * @return
 *   The generated teaser.
Dries's avatar
 
Dries committed
221
 */
222
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
 
Dries committed
223

224 225 226
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
227

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

231
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
232
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
233 234
    return $body;
  }
Dries's avatar
 
Dries committed
235

236 237 238 239 240
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

241 242 243 244 245
  // 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);
246
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
247 248
      return $body;
    }
249 250
  }

251
  // If we have a short body, the entire body is the teaser.
Dries's avatar
 
Dries committed
252 253 254 255
  if (strlen($body) < $size) {
    return $body;
  }

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
  $position = 0;
  // Cache the reverse of the teaser.
  $reversed = strrev($teaser);

  // In some cases, no delimiter has been specified. In this case, we try to
  // split at paragraph boundaries.
  $breakpoints = array('</p>' => 0, '<br />' => 6, '<br>' => 4, "\n" => 1);
  // We use strpos on the reversed needle and haystack for speed.
  foreach ($breakpoints as $point => $offset) {
    $length = strpos($reversed, strrev($point));
    if ($length !== FALSE) {
      $position = - $length - $offset;
      return ($position == 0) ? $teaser : substr($teaser, 0, $position);
271
    }
272
  }
Dries's avatar
Dries committed
273

274 275 276 277 278 279 280 281 282 283 284 285
  // When even the first paragraph is too long, we try to split at the end of
  // the last full sentence.
  $breakpoints = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);
  $min_length = strlen($reversed);
  foreach ($breakpoints as $point => $offset) {
    $length = strpos($reversed, strrev($point));
    if ($length !== FALSE) {
      $min_length = min($length, $min_length);
      $position = 0 - $length - $offset;
    }
  }
  return ($position == 0) ? $teaser : substr($teaser, 0, $position);
Dries's avatar
 
Dries committed
286 287
}

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
/**
 * 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
 *   variable format.
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
309

310 311
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
312
  }
313

314 315 316 317 318 319 320 321 322 323
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
324
    if (!isset($_node_types[$type])) {
325 326 327 328
      return FALSE;
    }
  }
  switch ($op) {
329 330 331 332 333 334 335 336
    case 'types':
      return $_node_types;
    case 'type':
      return $_node_types[$type];
    case 'module':
      return $_node_types[$type]->module;
    case 'names':
      return $_node_names;
337
    case 'name':
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
      return $_node_names[$type];
  }
}

/**
 * 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);
    }
355
  }
356 357

  _node_types_build();
358 359
}

360
/**
361 362 363 364
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
365 366
 *
 * @return
367
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
368
 */
369 370 371 372
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
  $is_existing = db_num_rows(db_query("SELECT * FROM {node_type} WHERE type = '%s'", $existing_type));
373 374 375 376 377 378 379 380 381
  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 = '';
  }
382 383 384

  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);
385 386

    module_invoke_all('node_type', 'update', $info);
387 388 389 390
    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);
391 392

    module_invoke_all('node_type', 'insert', $info);
393 394
    return SAVED_NEW;
  }
395
}
396

397 398 399 400 401 402 403 404 405 406 407 408 409
/**
 * 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) {
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);

  $info = node_get_types('type', $type);
  module_invoke_all('node_type', 'delete', $info);
}

410
/**
411 412
 * Updates all nodes of one type to be of another type.
 *
413
 * @param $old_type
414 415 416
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
417 418
 *
 * @return
419
 *   The number of nodes whose node type field was modified.
420
 */
421 422 423
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
424
}
Dries's avatar
 
Dries committed
425

426
/**
427 428
 * Builds the list of available node types, by querying hook_node_info() in all
 * modules, and by looking for node types in the database.
Dries's avatar
 
Dries committed
429 430
 *
 */
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
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)) {
    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');
  }

478 479 480 481 482 483
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
484 485 486 487 488 489 490 491 492 493 494 495 496 497
  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
498
}
Dries's avatar
 
Dries committed
499

500
/**
Dries's avatar
 
Dries committed
501 502 503 504 505 506 507 508 509 510
 * 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) {
511 512 513 514 515
  $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
516 517
}

518
/**
Dries's avatar
 
Dries committed
519 520 521 522 523 524 525 526 527
 * 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
528
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
529 530
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
531
  if (node_hook($node, $hook)) {
532 533 534 535 536
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
 
Dries committed
537
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
538 539 540
  }
}

Dries's avatar
 
Dries committed
541 542 543 544
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
545
 *   A node object.
Dries's avatar
 
Dries committed
546 547 548 549 550 551 552
 * @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
553
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
554
  $return = array();
555
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
 
Dries committed
556
    $function = $name .'_nodeapi';
557
    $result = $function($node, $op, $a3, $a4);
558
    if (isset($result) && is_array($result)) {
559 560 561 562
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
 
Dries committed
563 564 565 566 567
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
568 569 570
/**
 * Load a node object from the database.
 *
571 572
 * @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
573 574
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
575 576
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
577 578 579 580
 *
 * @return
 *   A fully-populated node object.
 */
581
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
582 583 584 585 586 587
  static $nodes = array();

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

588
  $cachable = ($revision == NULL);
589
  $arguments = array();
590
  if (is_numeric($param)) {
591
    if ($cachable && isset($nodes[$param])) {
592
      return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
593
    }
594 595
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
 
Dries committed
596
  }
597
  elseif (is_array($param)) {
598
    // Turn the conditions into a query.
599
    foreach ($param as $key => $value) {
600 601
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
602 603
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
 
Dries committed
604
  }
605 606 607
  else {
    return FALSE;
  }
Dries's avatar
 
Dries committed
608

Dries's avatar
 
Dries committed
609
  // Retrieve the node.
610
  // No db_rewrite_sql is applied so as to get complete indexing for search.
611
  if ($revision) {
612
    array_unshift($arguments, $revision);
613
    $node = db_fetch_object(db_query('SELECT n.nid, r.vid, n.type, n.status, n.language, n.created, n.changed, n.comment, n.promote, n.sticky, n.tnid, n.translate, r.timestamp AS revision_timestamp, r.title, r.body, r.teaser, r.log, r.format, u.uid, u.name, u.picture, u.data 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
614
  }
615
  else {
616
    $node = db_fetch_object(db_query('SELECT n.nid, n.vid, n.type, n.status, n.language, n.created, n.changed, n.comment, n.promote, n.sticky, n.tnid, n.translate, r.timestamp AS revision_timestamp, r.title, r.body, r.teaser, r.log, r.format, u.uid, u.name, u.picture, u.data 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
617 618
  }

619
  if ($node && $node->nid) {
620 621 622 623 624 625
    // 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
626 627
    }

628 629 630 631 632
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
633 634 635
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
 
Dries committed
636 637
  }

Dries's avatar
 
Dries committed
638 639 640
  return $node;
}

Dries's avatar
 
Dries committed
641 642 643
/**
 * Save a node object into the database.
 */
644
function node_save(&$node) {
645 646
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
647
  global $user;
Dries's avatar
 
Dries committed
648

649
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
650

Dries's avatar
 
Dries committed
651
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
652
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
653
    // Insert a new node.
654
    $node->is_new = TRUE;
655 656 657 658 659 660
  }
  else {
    // We need to ensure that all node fields are filled.
    $node_current = node_load($node->nid);
    foreach ($node as $field => $data) {
      $node_current->$field = $data;
Dries's avatar
 
Dries committed
661
    }
662
    $node = $node_current;
Dries's avatar
 
Dries committed
663

664
    if (!empty($node->revision)) {
665 666
      $node->old_vid = $node->vid;
    }
Dries's avatar
 
Dries committed
667 668
  }

669 670 671 672
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
673
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
674
  $node->changed = time();
Dries's avatar
 
Dries committed
675

676
  // Split off revisions data to another structure
677
  $revisions_table_values = array('nid' => &$node->nid,
678
                     'title' => $node->title, 'body' => $node->body,
679
                     'teaser' => $node->teaser, 'timestamp' => $node->changed,
680
                     'uid' => $user->uid, 'format' => $node->format);
681
  $revisions_table_types = array('nid' => '%d',
682
                     'title' => "'%s'", 'body' => "'%s'",
683
                     'teaser' => "'%s'", 'timestamp' => '%d',
684
                     'uid' => '%d', 'format' => '%d');
685
  if (!empty($node->log) || $node->is_new || (isset($node->revision) && $node->revision)) {
686 687 688
    // Only store the log message if there's something to store; this prevents
    // existing log messages from being unintentionally overwritten by a blank
    // message. A new revision will have an empty log message (or $node->log).
689 690 691
    $revisions_table_values['log'] = $node->log;
    $revisions_table_types['log'] = "'%s'";
  }
692
  $node_table_values = array(
693
                    'title' => $node->title, 'type' => $node->type, 'uid' => $node->uid,
694
                    'status' => $node->status, 'language' => $node->language, 'created' => $node->created,
695
                    'changed' => $node->changed, 'comment' => $node->comment,
696
                    'promote' => $node->promote, 'sticky' => $node->sticky);
697
  $node_table_types = array(
698
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
699
                    'status' => '%d', 'language' => "'%s'",'created' => '%d',
700
                    'changed' => '%d', 'comment' => '%d',
701
                    'promote' => '%d', 'sticky' => '%d');
702
  $update_node = TRUE;
703 704 705
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
706 707 708
    $node_query = 'INSERT INTO {node} (vid, '. implode(', ', array_keys($node_table_types)) .') VALUES (NULL, '. implode(', ', $node_table_types) .')';
    db_query($node_query, $node_table_values);
    $node->nid = db_last_insert_id('node', 'nid');
709
    $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
710 711 712
    db_query($revisions_query, $revisions_table_values);
    $node->vid = db_last_insert_id('node_revisions', 'vid');
    $op = 'insert';
713 714 715 716 717 718 719 720
  }
  else {
    $arr = array();
    foreach ($node_table_types as $key => $value) {
      $arr[] = $key .' = '. $value;
    }
    $node_table_values[] = $node->nid;
    $node_query = 'UPDATE {node} SET '. implode(', ', $arr) .' WHERE nid = %d';
721
    db_query($node_query, $node_table_values);
722
    if (!empty($node->revision)) {
723
      $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
724 725
      db_query($revisions_query, $revisions_table_values);
      $node->vid = db_last_insert_id('node_revisions', 'vid');
726 727 728 729 730
    }
    else {
      $arr = array();
      foreach ($revisions_table_types as $key => $value) {
        $arr[] = $key .' = '. $value;
Dries's avatar
 
Dries committed
731
      }
732 733
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
734 735
      db_query($revisions_query, $revisions_table_values);
      $update_node = FALSE;
Dries's avatar
 
Dries committed
736
    }
737
    $op = 'update';
738
  }
739
  if ($update_node) {
740
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
741 742
  }

743 744 745 746
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

747 748 749
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries's avatar
 
Dries committed
750
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
 
Dries committed
751
  cache_clear_all();
Dries's avatar
 
Dries committed
752 753
}

Dries's avatar
 
Dries committed
754 755 756 757 758 759
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
760
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
 
Dries committed
761 762
 * @param $page
 *   Whether the node is being displayed by itself as a page.
763 764
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
 
Dries committed
765 766 767 768
 *
 * @return
 *   An HTML representation of the themed node.
 */
769
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
770
  $node = (object)$node;
Dries's avatar
 
Dries committed
771

772 773
  $node = node_build_content($node, $teaser, $page);

774 775
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
776
    drupal_alter('link', $node->links, $node);
777
  }
778 779 780 781

  // 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);
782
  if ($teaser) {
783
    $node->teaser = $content;
784 785 786
    unset($node->body);
  }
  else {
787
    $node->body = $content;
788 789
    unset($node->teaser);
  }
Dries's avatar
 
Dries committed
790

791 792 793
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
 
Dries committed
794
  return theme('node', $node, $teaser, $page);
Dries's avatar
 
Dries committed
795
}
Dries's avatar
 
Dries committed
796

Dries's avatar
 
Dries committed
797
/**
798
 * Apply filters and build the node's standard elements.
Dries's avatar
 
Dries committed
799
 */
Dries's avatar
 
Dries committed
800
function node_prepare($node, $teaser = FALSE) {
801 802 803
  // First we'll overwrite the existing node teaser and body with
  // the filtered copies! Then, we'll stick those into the content
  // array and set the read more flag if appropriate.
804
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
805 806 807 808 809 810 811 812

  if ($teaser == FALSE) {
    $node->body = check_markup($node->body, $node->format, FALSE);
  }
  else {
    $node->teaser = check_markup($node->teaser, $node->format, FALSE);
  }

813
  $node->content['body'] = array(
814
    '#value' => $teaser ? $node->teaser : $node->body,
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
    '#weight' => 0,
  );

  return $node;
}

/**
 * Builds a structured array representing the node's content.
 *
 * @param $node
 *   A node object.
 * @param $teaser
 *   Whether to display the teaser only, as on the main page.
 * @param $page
 *   Whether the node is being displayed by itself as a page.
 *
 * @return
 *   An structured array containing the individual elements
 *   of the node's body.
 */
function node_build_content($node, $teaser = FALSE, $page = FALSE) {
836 837 838 839 840 841

  // The build mode identifies the target for which the node is built.
  if (!isset($node->build_mode)) {
    $node->build_mode = NODE_BUILD_NORMAL;
  }

842
  // Remove the delimiter (if any) that separates the teaser from the body.
843
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
844 845 846 847 848

  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
  if (node_hook($node, 'view')) {
    $node = node_invoke($node, 'view', $teaser, $page);
Dries's avatar
 
Dries committed
849 850
  }
  else {
851
    $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
852
  }
853 854 855 856

  // Allow modules to make their own additions to the node.
  node_invoke_nodeapi($node, 'view', $teaser, $page);

Dries's avatar
 
Dries committed
857
  return $node;
Dries's avatar
 
Dries committed
858 859
}

Dries's avatar
 
Dries committed
860 861 862
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
 
Dries committed
863
function node_show($node, $cid) {
Dries's avatar
 
Dries committed
864
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
 
Dries committed
865

Dries's avatar
 
Dries committed
866 867
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
868 869
  }

Dries's avatar
 
Dries committed
870 871
  // Update the history table, stating that this user viewed this node.
  node_tag_new($node->nid);
Dries's avatar
 
Dries committed
872

Dries's avatar
 
Dries committed
873
  return $output;
Dries's avatar
 
Dries committed
874 875
}

Dries's avatar
 
Dries committed
876 877 878
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
879
function node_perm() {
880 881 882 883
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
884
      $name = check_plain($type->type);
885
      $perms[] = 'create '. $name .' content';
886 887
      $perms[] = 'delete own '. $name .' content';
      $perms[] = 'delete '. $name .' content';
888 889 890 891 892 893
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
 
Dries committed
894 895
}

Dries's avatar
 
Dries committed
896 897 898
/**
 * Implementation of hook_search().
 */
899
function node_search($op = 'search', $keys = NULL) {
900 901
  switch ($op) {
    case 'name':
902
      return t('Content');
903

Dries's avatar
Dries committed
904 905
    case 'reset':
      variable_del('node_cron_last');
906
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
907
      return;
908

909 910
    case 'status':
      $last = variable_get('node_cron_last', 0);
911
      $last_nid = variable_get('node_cron_last_nid', 0);
912 913
      $total = db_result(db_query('SELECT COUNT(*) FROM {node} WHERE status = 1'));
      $remaining = db_result(db_query('SELECT COUNT(*) FROM {node} n LEFT JOIN {node_comment_statistics} c ON n.nid = c.nid WHERE n.status = 1 AND ((GREATEST(n.created, n.changed, c.last_comment_timestamp) = %d AND n.nid > %d ) OR (n.created > %d OR n.changed > %d OR c.last_comment_timestamp > %d))', $last, $last_nid, $last, $last, $last));
914
      return array('remaining' => $remaining, 'total' => $total);
915 916 917 918 919 920

    case 'admin':
      $form = array();
      // Output form for defining rank factor weights.
      $form['content_ranking'] = array('#type' => 'fieldset', '#title' => t('Content ranking'));
      $form['content_ranking']['#theme'] = 'node_search_admin';
921
      $form['content_ranking']['info'] = array('#value' => '<em>'. t('The following numbers control which properties the content search should favor when ordering the results. Higher numbers mean more influence, zero means the property is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') .'</em>');
922 923 924

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
925
      if (module_exists('comment')) {
926 927
        $ranking['node_rank_comments'] = t('Number of comments');
      }
928
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
929 930 931 932 933 934 935 936 937 938
        $ranking['node_rank_views'] = t('Number of views');
      }

      // Note: reversed to reflect that higher number = higher ranking.
      $options = drupal_map_assoc(range(0, 10));
      foreach ($ranking as $var => $title) {
        $form['content_ranking']['factors'][$var] = array('#title' => $title, '#type' => 'select', '#options' => $options, '#default_value' => variable_get($var, 5));
      }
      return $form;

939
    case 'search':
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
      // Build matching conditions
      list($join1, $where1) = _db_rewrite_sql();
      $arguments1 = array();
      $conditions1 = 'n.status = 1';

      if ($type = search_query_extract($keys, 'type')) {
        $types = array();
        foreach (explode(',', $type) as $t) {
          $types[] = "n.type = '%s'";
          $arguments1[] = $t;
        }
        $conditions1 .= ' AND ('. implode(' OR ', $types) .')';
        $keys = search_query_insert($keys, 'type');
      }

      if ($category = search_query_extract($keys, 'category')) {
        $categories = array();
        foreach (explode(',', $category) as $c) {
          $categories[] = "tn.tid = %d";
          $arguments1[] = $c;
        }
        $conditions1 .= ' AND ('. implode(' OR ', $categories) .')';
        $join1 .= ' INNER JOIN {term_node} tn ON n.nid = tn.nid';
        $keys = search_query_insert($keys, 'category');
      }

      // Build ranking expression (we try to map each parameter to a
      // uniform distribution in the range 0..1).
      $ranking = array();
      $arguments2 = array();
      $join2 = '';
      // Used to avoid joining on node_comment_statistics twice
972
      $stats_join = FALSE;
973
      $total = 0;
974 975 976 977
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
978
        $total += $weight;
979 980 981 982 983 984 985
      }
      if ($weight = (int)variable_get('node_rank_recent', 5)) {
        // Exponential decay with half-life of 6 months, starting at last indexed node
        $ranking[] = '%d * POW(2, (GREATEST(n.created, n.changed, c.last_comment_timestamp) - %d) * 6.43e-8)';
        $arguments2[] = $weight;
        $arguments2[] = (int)variable_get('node_cron_last', 0);
        $join2 .= ' INNER JOIN {node} n ON n.nid = i.sid LEFT JOIN {node_comment_statistics} c ON c.nid = i.sid';
986
        $stats_join = TRUE;
987
        $total += $weight;