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

Dries's avatar
 
Dries committed
12 13 14 15
/**
 * Implementation of hook_help().
 */
function node_help($section) {
16
  switch ($section) {
Dries's avatar
 
Dries committed
17
    case 'admin/help#node':
18 19 20 21 22 23 24 25 26 27 28 29
      $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>
');
      $output .= t('<p>You can</p>
<ul>
30 31
<li>search for content at <a href="@search">search</a>.</li>
<li>administer nodes at <a href="@admin-settings-content-types">administer &gt;&gt; content management &gt;&gt; content types</a>.</li>
32
</ul>
33 34
', array('@search' => url('search'), '@admin-settings-content-types' => url('admin/content/types')));
      $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
    case 'admin/content/search':
37
      return t('<p>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>');
38 39 40 41
    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':
      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.');
Dries's avatar
 
Dries committed
42
  }
Dries's avatar
 
Dries committed
43 44 45 46

  if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'revisions') {
    return t('The revisions let you track differences between multiple versions of a post.');
  }
47 48

  if (arg(0) == 'node' && arg(1) == 'add' && $type = arg(2)) {
49 50
    $type = node_get_types('type', arg(2));
    return filter_xss_admin($type->help);
51
  }
Dries's avatar
 
Dries committed
52 53
}

Dries's avatar
 
Dries committed
54 55 56
/**
 * Implementation of hook_cron().
 */
57
function node_cron() {
Dries's avatar
 
Dries committed
58
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
59 60
}

Dries's avatar
 
Dries committed
61 62 63 64
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
65
 *   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
66 67 68 69 70 71
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
 *   An HTML list suitable as content for a block.
 */
Dries's avatar
 
Dries committed
72 73
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
74
    $items[] = l($node->title, 'node/'. $node->nid, $node->comment_count ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : '');
Dries's avatar
 
Dries committed
75 76
  }

Dries's avatar
 
Dries committed
77
  return theme('node_list', $items, $title);
Dries's avatar
 
Dries committed
78 79
}

Dries's avatar
 
Dries committed
80 81 82
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
 
Dries committed
83
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
84
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
85 86
}

Dries's avatar
 
Dries committed
87 88 89
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
90 91 92 93
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
94
    if (node_last_viewed($nid)) {
Dries's avatar
 
Dries committed
95
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
96 97
    }
    else {
Dries's avatar
 
Dries committed
98
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
99 100 101 102
    }
  }
}

Dries's avatar
 
Dries committed
103 104 105 106
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
107 108
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
109
  static $history;
Dries's avatar
 
Dries committed
110

Dries's avatar
 
Dries committed
111 112 113 114
  if (!isset($history[$nid])) {
    $history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = '$user->uid' AND nid = %d", $nid));
  }

115
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
116 117 118
}

/**
119
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
120
 *
Dries's avatar
 
Dries committed
121 122 123 124
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
125 126
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
127
 */
128
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
129 130 131
  global $user;
  static $cache;

132 133 134
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
135
  if (!isset($cache[$nid])) {
136
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
137
  }
138 139 140 141 142 143 144
  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
145 146
}

Dries's avatar
 
Dries committed
147
/**
148
 * Automatically generate a teaser for a node body in a given format.
Dries's avatar
 
Dries committed
149
 */
150
function node_teaser($body, $format = NULL) {
Dries's avatar
 
Dries committed
151

Dries's avatar
 
Dries committed
152
  $size = variable_get('teaser_length', 600);
Dries's avatar
 
Dries committed
153

Dries's avatar
 
Dries committed
154 155 156
  // find where the delimiter is in the body
  $delimiter = strpos($body, '<!--break-->');

157
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
158
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
159 160
    return $body;
  }
Dries's avatar
 
Dries committed
161

162 163 164 165 166
  // 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);
167
    if (isset($filters['filter/1']) && (strpos($body, '<?') !== FALSE) && (strpos($body, '<?') < $delimiter)) {
168 169
      return $body;
    }
170 171
  }

Dries's avatar
 
Dries committed
172
  // If a valid delimiter has been specified, use it to chop of the teaser.
173
  if ($delimiter !== FALSE) {
Dries's avatar
 
Dries committed
174 175 176
    return substr($body, 0, $delimiter);
  }

177
  // If we have a short body, the entire body is the teaser.
Dries's avatar
 
Dries committed
178 179 180 181
  if (strlen($body) < $size) {
    return $body;
  }

Dries's avatar
 
Dries committed
182 183
  // In some cases, no delimiter has been specified (e.g. when posting using
  // the Blogger API). In this case, we try to split at paragraph boundaries.
184
  // When even the first paragraph is too long, we try to split at the end of
Dries's avatar
 
Dries committed
185
  // the next sentence.
186
  $breakpoints = array('</p>' => 4, '<br />' => 0, '<br>' => 0, "\n" => 0, '. ' => 1, '! ' => 1, '? ' => 1, '。' => 3, '؟ ' => 1);
187 188 189 190
  foreach ($breakpoints as $point => $charnum) {
    if ($length = strpos($body, $point, $size)) {
      return substr($body, 0, $length + $charnum);
    }
191
  }
Dries's avatar
Dries committed
192

193
  // If all else fails, we simply truncate the string.
194
  return truncate_utf8($body, $size);
Dries's avatar
 
Dries committed
195 196
}

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
/**
 * 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;
218

219 220
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
221
  }
222

223 224 225 226 227 228 229 230 231 232
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
233
    if (!isset($_node_types[$type])) {
234 235 236 237
      return FALSE;
    }
  }
  switch ($op) {
238 239 240 241 242 243 244 245
    case 'types':
      return $_node_types;
    case 'type':
      return $_node_types[$type];
    case 'module':
      return $_node_types[$type]->module;
    case 'names':
      return $_node_names;
246
    case 'name':
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
      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);
    }
264
  }
265 266

  _node_types_build();
267 268
}

269
/**
270 271 272 273
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
274 275
 *
 * @return
276
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
277
 */
278 279 280 281 282 283 284
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));

  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);
285 286

    module_invoke_all('node_type', 'update', $info);
287 288 289 290
    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);
291 292

    module_invoke_all('node_type', 'insert', $info);
293 294
    return SAVED_NEW;
  }
295
}
296

297
/**
298 299 300 301 302 303
 * Updates all nodes of one type to be of another type.
 *
 * @param $orig_type
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
304 305
 *
 * @return
306
 *   The number of nodes whose node type field was modified.
307
 */
308 309 310
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
311
}
Dries's avatar
 
Dries committed
312

313
/**
314 315
 * 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
316 317
 *
 */
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
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');
  }

  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
379
}
Dries's avatar
 
Dries committed
380

381
/**
Dries's avatar
 
Dries committed
382 383 384 385 386 387 388 389 390 391
 * 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) {
392 393 394 395 396
  $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
397 398
}

399
/**
Dries's avatar
 
Dries committed
400 401 402 403 404 405 406 407 408
 * 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
409
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
410 411
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
412
  if (node_hook($node, $hook)) {
413 414 415 416 417
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
 
Dries committed
418
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
419 420 421
  }
}

Dries's avatar
 
Dries committed
422 423 424 425
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
426
 *   A node object.
Dries's avatar
 
Dries committed
427 428 429 430 431 432 433
 * @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
434
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
435
  $return = array();
436
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
 
Dries committed
437
    $function = $name .'_nodeapi';
438
    $result = $function($node, $op, $a3, $a4);
439
    if (isset($result) && is_array($result)) {
440 441 442 443
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
 
Dries committed
444 445 446 447 448
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
449 450 451
/**
 * Load a node object from the database.
 *
452 453
 * @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
454 455
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
456 457
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
458 459 460 461
 *
 * @return
 *   A fully-populated node object.
 */
462
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
463 464 465 466 467 468
  static $nodes = array();

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

469
  $arguments = array();
470 471
  if (is_numeric($param)) {
    $cachable = $revision == NULL;
472
    if ($cachable && isset($nodes[$param])) {
473
      return drupal_clone($nodes[$param]);
474
    }
475 476
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
 
Dries committed
477
  }
478 479
  else {
    // Turn the conditions into a query.
480
    foreach ($param as $key => $value) {
481 482
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
483 484
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
 
Dries committed
485 486
  }

Dries's avatar
 
Dries committed
487
  // Retrieve the node.
488
  // No db_rewrite_sql is applied so as to get complete indexing for search.
489
  if ($revision) {
490
    array_unshift($arguments, $revision);
491
    $node = db_fetch_object(db_query('SELECT n.nid, r.vid, n.type, n.status, n.created, n.changed, n.comment, n.promote, n.sticky, 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
492
  }
493
  else {
494
    $node = db_fetch_object(db_query('SELECT n.nid, n.vid, n.type, n.status, n.created, n.changed, n.comment, n.promote, n.sticky, 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
495 496
  }

497 498 499 500 501 502 503
  if ($node->nid) {
    // 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
504 505
    }

506 507 508 509 510
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
Dries's avatar
 
Dries committed
511 512
  }

Dries's avatar
 
Dries committed
513
  if ($cachable) {
514
    $nodes[$param] = drupal_clone($node);
Dries's avatar
 
Dries committed
515 516
  }

Dries's avatar
 
Dries committed
517 518 519
  return $node;
}

Dries's avatar
 
Dries committed
520 521 522
/**
 * Save a node object into the database.
 */
523
function node_save(&$node) {
524
  global $user;
Dries's avatar
 
Dries committed
525

526
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
527

Dries's avatar
 
Dries committed
528
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
529
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
530
    // Insert a new node.
531
    $node->is_new = TRUE;
Dries's avatar
 
Dries committed
532

Dries's avatar
 
Dries committed
533
    $node->nid = db_next_id('{node}_nid');
534 535 536 537 538 539 540
    $node->vid = db_next_id('{node_revisions}_vid');;
  }
  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
541
    }
542
    $node = $node_current;
Dries's avatar
 
Dries committed
543

544 545 546 547
    if ($node->revision) {
      $node->old_vid = $node->vid;
      $node->vid = db_next_id('{node_revisions}_vid');
    }
Dries's avatar
 
Dries committed
548 549
  }

550 551 552 553
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
554
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
555
  $node->changed = time();
Dries's avatar
 
Dries committed
556

557 558 559 560 561 562 563 564 565 566 567 568 569
  // Split off revisions data to another structure
  $revisions_table_values = array('nid' => $node->nid, 'vid' => $node->vid,
                     'title' => $node->title, 'body' => $node->body,
                     'teaser' => $node->teaser, 'log' => $node->log, 'timestamp' => $node->changed,
                     'uid' => $user->uid, 'format' => $node->format);
  $revisions_table_types = array('nid' => '%d', 'vid' => '%d',
                     'title' => "'%s'", 'body' => "'%s'",
                     'teaser' => "'%s'", 'log' => "'%s'", 'timestamp' => '%d',
                     'uid' => '%d', 'format' => '%d');
  $node_table_values = array('nid' => $node->nid, 'vid' => $node->vid,
                    'title' => $node->title, 'type' => $node->type, 'uid' => $node->uid,
                    'status' => $node->status, 'created' => $node->created,
                    'changed' => $node->changed, 'comment' => $node->comment,
570
                    'promote' => $node->promote, 'sticky' => $node->sticky);
571 572 573 574
  $node_table_types = array('nid' => '%d', 'vid' => '%d',
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
                    'status' => '%d', 'created' => '%d',
                    'changed' => '%d', 'comment' => '%d',
575
                    'promote' => '%d', 'sticky' => '%d');
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
    $node_query = 'INSERT INTO {node} ('. implode(', ', array_keys($node_table_types)) .') VALUES ('. implode(', ', $node_table_types) .')';
    $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
  }
  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';
    if ($node->revision) {
      $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
    }
    else {
      $arr = array();
      foreach ($revisions_table_types as $key => $value) {
        $arr[] = $key .' = '. $value;
Dries's avatar
 
Dries committed
597
      }
598 599
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
Dries's avatar
 
Dries committed
600
    }
601
  }
Dries's avatar
 
Dries committed
602

603 604 605
  // Insert the node into the database:
  db_query($node_query, $node_table_values);
  db_query($revisions_query, $revisions_table_values);
Dries's avatar
 
Dries committed
606

607 608 609 610 611 612 613 614 615 616
  // Call the node specific callback (if any):
  if ($node->is_new) {
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
  }
  else {
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
  }

617 618 619
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries's avatar
 
Dries committed
620
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
 
Dries committed
621
  cache_clear_all();
Dries's avatar
 
Dries committed
622 623
}

Dries's avatar
 
Dries committed
624 625 626 627 628 629
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
630
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
 
Dries committed
631 632
 * @param $page
 *   Whether the node is being displayed by itself as a page.
633 634
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
 
Dries committed
635 636 637 638
 *
 * @return
 *   An HTML representation of the themed node.
 */
639
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
640
  $node = (object)$node;
Dries's avatar
 
Dries committed
641

642 643
  $node = node_build_content($node, $teaser, $page);

644 645
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
646 647 648 649 650

    foreach (module_implements('link_alter') AS $module) {
      $function = $module .'_link_alter';
      $function($node, $node->links);
    }
651
  }
652 653 654 655

  // 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);
656
  if ($teaser) {
657
    $node->teaser = $content;
658 659 660
    unset($node->body);
  }
  else {
661
    $node->body = $content;
662 663
    unset($node->teaser);
  }
Dries's avatar
 
Dries committed
664

665 666 667
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
 
Dries committed
668
  return theme('node', $node, $teaser, $page);
Dries's avatar
 
Dries committed
669
}
Dries's avatar
 
Dries committed
670

Dries's avatar
 
Dries committed
671
/**
672
 * Apply filters and build the node's standard elements.
Dries's avatar
 
Dries committed
673
 */
Dries's avatar
 
Dries committed
674
function node_prepare($node, $teaser = FALSE) {
675 676 677 678 679 680 681 682 683 684 685 686 687 688
  // 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.
  if (strlen($node->teaser) < strlen($node->body)) {
    $node->readmore = TRUE;
  }

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

689
  $node->content['body'] = array(
690
    '#value' => $teaser ? $node->teaser : $node->body,
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
    '#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) {
  // Remove the delimiter (if any) that separates the teaser from the body.
  // TODO: this strips legitimate uses of '<!--break-->' also.
  $node->body = str_replace('<!--break-->', '', $node->body);

  // 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
720 721
  }
  else {
722
    $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
723
  }
724 725 726 727

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

Dries's avatar
 
Dries committed
728
  return $node;
Dries's avatar
 
Dries committed
729 730
}

Dries's avatar
 
Dries committed
731 732 733
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
 
Dries committed
734
function node_show($node, $cid) {
Dries's avatar
 
Dries committed
735
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
 
Dries committed
736

Dries's avatar
 
Dries committed
737 738
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
739 740
  }

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

Dries's avatar
 
Dries committed
744
  return $output;
Dries's avatar
 
Dries committed
745 746
}

Dries's avatar
 
Dries committed
747 748 749
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
750
function node_perm() {
751 752 753 754
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
755
      $name = check_plain($type->type);
756 757 758 759 760 761 762
      $perms[] = 'create '. $name .' content';
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
 
Dries committed
763 764
}

Dries's avatar
 
Dries committed
765 766 767
/**
 * Implementation of hook_search().
 */
768
function node_search($op = 'search', $keys = NULL) {
769 770
  switch ($op) {
    case 'name':
771
      return t('Content');
772

Dries's avatar
Dries committed
773 774
    case 'reset':
      variable_del('node_cron_last');
775
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
776
      return;
777

778 779
    case 'status':
      $last = variable_get('node_cron_last', 0);
780
      $last_nid = variable_get('node_cron_last_nid', 0);
781 782
      $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));
783
      return array('remaining' => $remaining, 'total' => $total);
784 785 786 787 788 789

    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';
790
      $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>');
791 792 793

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
794
      if (module_exists('comment')) {
795 796
        $ranking['node_rank_comments'] = t('Number of comments');
      }
797
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
798 799 800 801 802 803 804 805 806 807
        $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;

808
    case 'search':
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
      // 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
841
      $stats_join = FALSE;
842 843 844 845 846 847 848 849 850 851 852
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
      }
      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';
853
        $stats_join = TRUE;
854
      }
855
      if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
856 857 858 859 860 861 862 863 864
        // Inverse law that maps the highest reply count on the site to 1 and 0 to 0.
        $scale = variable_get('node_cron_comments_scale', 0.0);
        $ranking[] = '%d * (2.0 - 2.0 / (1.0 + c.comment_count * %f))';
        $arguments2[] = $weight;
        $arguments2[] = $scale;
        if (!$stats_join) {
          $join2 .= ' LEFT JOIN {node_comment_statistics} c ON c.nid = i.sid';
        }
      }
865
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
866 867 868 869 870 871
          $weight = (int)variable_get('node_rank_views', 5)) {
        // Inverse law that maps the highest view count on the site to 1 and 0 to 0.
        $scale = variable_get('node_cron_views_scale', 0.0);
        $ranking[] = '%d * (2.0 - 2.0 / (1.0 + nc.totalcount * %f))';
        $arguments2[] = $weight;
        $arguments2[] = $scale;
872
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
873 874 875 876 877 878 879
      }
      $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') . ' AS score';

      // Do search
      $find = do_search($keys, 'node', 'INNER JOIN {node} n ON n.nid = i.sid '. $join1 .' INNER JOIN {users} u ON n.uid = u.uid', $conditions1 . (empty($where1) ? '' : ' AND '. $where1), $arguments1, $select2, $join2, $arguments2);

      // Load results
880 881
      $results = array();
      foreach ($find as $item) {
882
        // Build the node body.
883
        $node = node_load($item->sid);
884 885
        $node = node_build_content($node, FALSE, FALSE);
        $node->body = drupal_render($node->content);
886

887 888
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
889 890
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
891

Dries's avatar
Dries committed
892
        $extra = node_invoke_nodeapi($node, 'search result');
893
        $results[] = array('link' => url('node/'. $item->sid),
894
                           'type' => node_get_types('name', $node),
895
                           'title' => $node->title,
896
                           'user' => theme('username', $node),
897
                           'date' => $node->changed,
898
                           'node' => $node,
Dries's avatar
Dries committed
899
                           'extra' => $extra,
900
                           'snippet' => search_excerpt($keys, $node->body));
901 902 903
      }
      return $results;
  }
Dries's avatar
 
Dries committed
904 905
}

906 907 908 909 910 911 912 913 914 915
/**
 * Implementation of hook_user().
 */
function node_user($op, &$edit, &$user) {
  if ($op == 'delete') {
    db_query('UPDATE {node} SET uid = 0 WHERE uid = %d', $user->uid);
    db_query('UPDATE {node_revisions} SET uid = 0 WHERE uid = %d', $user->uid);
  }
}

916
function theme_node_search_admin($form) {
917
  $output = drupal_render($form['info']);
918 919 920 921 922 923

  $header = array(t('Factor'), t('Weight'));
  foreach (element_children($form['factors']) as $key) {
    $row = array();
    $row[] = $form['factors'][$key]['#title'];
    unset($form['factors'][$key]['#title']);
924
    $row[] = drupal_render($form['factors'][$key]);
925 926 927 928
    $rows[] = $row;
  }
  $output .= theme('table', $header, $rows);

929
  $output .= drupal_render($form);
930 931 932
  return $output;
}

Dries's avatar
 
Dries committed
933
/**
Dries's avatar
 
Dries committed
934
 * Menu callback; presents general node configuration options.
Dries's avatar
 
Dries committed
935 936
 */
function node_configure() {
937 938 939 940
  // Only show rebuild button if there is 0 or more than 2 rows in node_access table, or if there are modules that implement node_grant.
  if (db_result(db_query('SELECT COUNT(*) FROM {node_access}')) != 1 || count(module_implements('node_grant'))) {
    $status = '<p>'. t('If the site is experiencing problems with permissions to content, you may have to rebuild the permissions cache. Possible causes for permission problems are disabling modules or configuration changes to permissions. Rebuilding will remove all privileges to posts, and replace them with permissions based on the current modules and settings.') .'</p>';
    $status .= '<p>'. t('Rebuilding may take some time if there is a lot of a content or complex permission settings. After rebuilding has completed posts will automatically use the new permissions.'). '</p>';
Dries's avatar
 
Dries committed
941

942 943 944 945 946 947 948
    $form['access'] = array('#type' => 'fieldset', '#title' => t('Node access status'));
    $form['access']['status'] = array('#value' => $status);
    $form['access']['rebuild'] = array('#type' => 'submit', '#value' => t('Rebuild permissions'));
  }

  $form['settings'] = array('#type' => 'fieldset', '#title' => t('Settings'));
  $form['settings']['default_nodes_main'] = array(
949 950 951
    '#type' => 'select', '#title' => t('Number of posts on main page'), '#default_value' => variable_get('default_nodes_main', 10),
    '#options' =>  drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)),
    '#description' => t('The default maximum number of posts to display per page on overview pages such as the main page.')
952
  );
953
  $form['settings']['teaser_length'] = array(
954 955
    '#type' => 'select', '#title' => t('Length of trimmed posts'), '#default_value' => variable_get('teaser_length', 600),
    '#options' => array(0 => t('Unlimited'), 200 => t('200 characters'), 400 => t('400 characters'), 600 => t('600 characters'),
956 957
      800 => t('800 characters'), 1000 => t('1000 characters'), 1200 => t('1200 characters'), 1400 => t('1400 characters'),
      1600 => t('1600 characters'), 1800 => t('1800 characters'), 2000 => t('2000 characters')),
958
    '#description' => t("The maximum number of characters used in the trimmed version of a post. Drupal will use this setting to determine at which offset long posts should be trimmed. The trimmed version of a post is typically used as a teaser when displaying the post on the main page, in XML feeds, etc. To disable teasers, set to 'Unlimited'. Note that this setting will only affect new or updated content and will not affect existing teasers.")
959 960
  );

961
  $form['settings']['node_preview'] = array(
962 963
    '#type' => 'radios', '#title' => t('Preview post'), '#default_value' => variable_get('node_preview', 0),
    '#options' => array(t('Optional'), t('Required')), '#description' => t('Must users preview posts before submitting?')
964
  );
Dries's avatar
 
Dries committed
965

966
  return system_settings_form($form);
Dries's avatar
 
Dries committed
967 968
}

969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
/**
 * Form validate callback.
 */
function node_configure_validate($form_id, $form_values) {
  if ($form_values['op'] == t('Rebuild permissions')) {
    drupal_goto('admin/content/node-settings/rebuild');
  }
}

/**
 * Menu callback: confirm rebuilding of permissions.
 */
function node_configure_rebuild_confirm() {
  return confirm_form(array(), t('Are you sure you want to rebuild node permissions on the site?'),
                  'admin/content/node-settings', t('This will wipe all current node permissions and rebuild them based on current settings. Rebuilding the permissions may take a while so please be patient. This action cannot be undone.'), t('Rebuild permissions'), t('Cancel'));
}

/**
 * Handler for wipe confirmation
 */
function node_configure_rebuild_confirm_submit($form_id, &$form) {
  node_access_rebuild();
  drupal_set_message(t('The node access table has been rebuilt.'));
  return 'admin/content/node-settings';
}

Dries's avatar
 
Dries committed
995 996 997
/**
 * Retrieve the comment mode for the given node ID (none, read, or read/write).
 */
Dries's avatar
 
Dries committed
998
function node_comment_mode($nid) {
Dries's avatar
 
Dries committed
999 1000
  static $comment_mode;
  if (!isset($comment_mode[$nid])) {
Dries's avatar
 
Dries committed
1001
    $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
Dries's avatar
 
Dries committed
1002 1003
  }
  return $comment_mode[$nid];
Dries's avatar
 
Dries committed
1004 1005
}

Dries's avatar
 
Dries committed
1006 1007 1008
/**
 * Implementation of hook_link().
 */