node.module 86.1 KB
Newer Older
1
<?php
2
// $Id$
3

4 5 6 7 8
/**
 * @file
 * The core that allows content to be submitted to the site.
 */

9 10
define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);

11 12 13 14
/**
 * Implementation of hook_help().
 */
function node_help($section) {
15
  switch ($section) {
16
    case 'admin/help#node':
17 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>
<li>search for content at <a href="%search">search</a>.</li>
30
<li>administer nodes at <a href="%admin-settings-content-types">administer &gt;&gt; settings &gt;&gt; content types</a>.</li>
31
</ul>
32
', array('%search' => url('search'), '%admin-settings-content-types' => url('admin/settings/content-types')));
33
      $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>';
34
      return $output;
Dries's avatar
Dries committed
35
    case 'admin/modules#description':
36
      return t('Allows content to be submitted to the site and displayed on pages.');
37 38
    case 'admin/node/configure':
    case 'admin/node/configure/settings':
39
      return t('<p>Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.</p>');
40
    case 'admin/node':
41
      return t('<p>Below is a list of all of the posts on your site. Other forms of content are listed elsewhere (e.g. <a href="%comments">comments</a>).</p><p>Clicking a title views the post, while clicking an author\'s name views their user information.</p>', array('%comments' => url('admin/comment')));
42
    case 'admin/node/search':
43
      return t('<p>Enter a simple pattern to search for a post. This can include the wildcard character *.<br />For example, a search for "br*" might return "bread bakers", "our daily bread" and "brenda".</p>');
44
  }
45 46 47 48

  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.');
  }
49 50

  if (arg(0) == 'node' && arg(1) == 'add' && $type = arg(2)) {
51
    return filter_xss_admin(variable_get($type .'_help', ''));
52
  }
53 54
}

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

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

78
  return theme('node_list', $items, $title);
79 80
}

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

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

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

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

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

116
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
117 118 119
}

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

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

148
/**
149
 * Automatically generate a teaser for a node body in a given format.
150
 */
151
function node_teaser($body, $format = NULL) {
152

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

155 156 157
  // find where the delimiter is in the body
  $delimiter = strpos($body, '<!--break-->');

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

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

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

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

183 184
  // 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.
185
  // When even the first paragraph is too long, we try to split at the end of
186
  // the next sentence.
Dries's avatar
Dries committed
187
  $breakpoints = array('</p>' => 4, '<br />' => 0, '<br>' => 0, "\n" => 0, '. ' => 1, '! ' => 1, '? ' => 1, '。' => 1, '؟ ' => 1);
188 189 190 191
  foreach ($breakpoints as $point => $charnum) {
    if ($length = strpos($body, $point, $size)) {
      return substr($body, 0, $length + $charnum);
    }
192
  }
Dries's avatar
Dries committed
193

194
  // If all else fails, we simply truncate the string.
195
  return truncate_utf8($body, $size);
196 197
}

198
function _node_names($op = '', $node = NULL) {
199 200
  static $node_names = array();
  static $node_list = array();
201

202
  if (empty($node_names)) {
203
    $node_names = module_invoke_all('node_info');
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
    foreach ($node_names as $type => $value) {
      $node_list[$type] = $value['name'];
    }
  }
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
    if (!isset($node_names[$type])) {
      return FALSE;
    }
  }
  switch ($op) {
    case 'base':
      return $node_names[$type]['base'];
    case 'list':
      return $node_list;
    case 'name':
      return $node_list[$type];
  }
}

232
/**
233
 * Determine the basename for hook_load etc.
234
 *
235
 * @param $node
236
 *   Either a node object, a node array, or a string containing the node type.
237
 * @return
238
 *   The basename for hook_load, hook_nodeapi etc.
239
 */
240 241 242
function node_get_base($node) {
  return _node_names('base', $node);
}
243

244 245 246 247 248 249 250 251 252 253
/**
 * Determine the human readable name for a given type.
 *
 * @param $node
 *   Either a node object, a node array, or a string containing the node type.
 * @return
 *   The human readable name of the node type.
 */
function node_get_name($node) {
  return _node_names('name', $node);
254
}
255

256
/**
257
 * Return the list of available node types.
258
 *
259 260
 * @param $node
 *   Either a node object, a node array, or a string containing the node type.
261
 * @return
262
 *   An array consisting ('#type' => name) pairs.
263
 */
264 265
function node_get_types() {
  return _node_names('list');
266
}
267

268
/**
269 270 271 272 273 274 275 276 277 278
 * 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) {
279
  return module_hook(node_get_base($node), $hook);
280 281
}

282
/**
283 284 285 286 287 288 289 290 291
 * 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
292
 *   The returned value of the invoked hook.
293 294
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
295 296
  if (node_hook($node, $hook)) {
    $function = node_get_base($node) ."_$hook";
297
    return ($function($node, $a2, $a3, $a4));
298 299 300
  }
}

301 302 303 304
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
305
 *   A node object.
306 307 308 309 310 311 312
 * @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.
 */
313
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
314
  $return = array();
315
  foreach (module_implements('nodeapi') as $name) {
316
    $function = $name .'_nodeapi';
317
    $result = $function($node, $op, $a3, $a4);
318
    if (isset($result) && is_array($result)) {
319 320 321 322
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
323 324 325 326 327
    }
  }
  return $return;
}

328 329 330
/**
 * Load a node object from the database.
 *
331 332
 * @param $param
 *   Either the nid of the node or an array of conditions to match against in the database query
333 334
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
335 336
 * @param $reset
 *   Whether to reset the internal node_load cache.
337 338 339 340
 *
 * @return
 *   A fully-populated node object.
 */
341
function node_load($param = array(), $revision = NULL, $reset = NULL) {
342 343 344 345 346 347
  static $nodes = array();

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

348
  $arguments = array();
349 350
  if (is_numeric($param)) {
    $cachable = $revision == NULL;
351
    if ($cachable && isset($nodes[$param])) {
352 353
      return $nodes[$param];
    }
354 355
    $cond = 'n.nid = %d';
    $arguments[] = $param;
356
  }
357 358
  else {
    // Turn the conditions into a query.
359
    foreach ($param as $key => $value) {
360 361
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
362 363
    }
    $cond = implode(' AND ', $cond);
364 365
  }

366
  // Retrieve the node.
367
  if ($revision) {
368 369
    array_unshift($arguments, $revision);
    $node = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, r.vid, n.type, n.status, n.created, n.changed, n.comment, n.promote, n.moderate, 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));
370
  }
371
  else {
372
    $node = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.vid, n.type, n.status, n.created, n.changed, n.comment, n.promote, n.moderate, 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));
373 374
  }

375 376 377 378 379 380 381
  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;
      }
382 383
    }

384 385 386 387 388
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
389 390
  }

391
  if ($cachable) {
392
    $nodes[$param] = $node;
393 394
  }

395 396 397
  return $node;
}

398 399 400
/**
 * Save a node object into the database.
 */
401
function node_save(&$node) {
402
  global $user;
403

404
  $node->is_new = false;
405

406
  // Apply filters to some default node fields:
407
  if (empty($node->nid)) {
408
    // Insert a new node.
409
    $node->is_new = true;
410

Dries's avatar
Dries committed
411
    // Set some required fields:
412 413 414
    if (!$node->created) {
      $node->created = time();
    }
415
    $node->nid = db_next_id('{node}_nid');
416 417 418 419 420 421 422
    $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;
423
    }
424
    $node = $node_current;
425

426 427 428 429
    if ($node->revision) {
      $node->old_vid = $node->vid;
      $node->vid = db_next_id('{node_revisions}_vid');
    }
430 431
  }

432 433 434
  // If node has never changed, set $node->changed to $node->created
  // If we set $node->created to time(), then 'changed' and 'created' will be
  // different for new nodes which were previewed before submission
435
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
436
  $node->changed = $node->changed ? time() : $node->created;
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 478 479
  // 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,
                    'promote' => $node->promote, 'moderate' => $node->moderate,
                    'sticky' => $node->sticky);
  $node_table_types = array('nid' => '%d', 'vid' => '%d',
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
                    'status' => '%d', 'created' => '%d',
                    'changed' => '%d', 'comment' => '%d',
                    'promote' => '%d', 'moderate' => '%d',
                    'sticky' => '%d');

  //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;
480
      }
481 482
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
483
    }
484
  }
485

486 487 488
  // Insert the node into the database:
  db_query($node_query, $node_table_values);
  db_query($revisions_query, $revisions_table_values);
489

490 491 492 493 494 495
  // Call the node specific callback (if any):
  if ($node->is_new) {
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
  }
  else {
496 497
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
498 499
  }

500
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
Dries committed
501
  cache_clear_all();
502 503
}

504 505 506 507 508 509
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
510
 *   Whether to display the teaser only, as on the main page.
511 512
 * @param $page
 *   Whether the node is being displayed by itself as a page.
513 514
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
515 516 517 518
 *
 * @return
 *   An HTML representation of the themed node.
 */
519
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
520
  $node = (object)$node;
521

522
  // Remove the delimiter (if any) that separates the teaser from the body.
523
  // TODO: this strips legitimate uses of '<!--break-->' also.
524
  $node->body = str_replace('<!--break-->', '', $node->body);
Dries's avatar
Dries committed
525

526
  if ($node->log != '' && !$teaser && $node->moderate) {
527
    $node->body .= '<div class="log"><div class="title">'. t('Log') .':</div>'. filter_xss($node->log) .'</div>';
528 529
  }

530 531
  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
532
  if (node_hook($node, 'view')) {
Dries's avatar
Dries committed
533
    node_invoke($node, 'view', $teaser, $page);
534 535
  }
  else {
Dries's avatar
Dries committed
536
    $node = node_prepare($node, $teaser);
537
  }
Dries's avatar
Dries committed
538 539
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $teaser, $page);
540 541 542
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
  }
543 544 545 546 547 548 549
  // unset unused $node part so that a bad theme can not open a security hole
  if ($teaser) {
    unset($node->body);
  }
  else {
    unset($node->teaser);
  }
Dries's avatar
Dries committed
550 551

  return theme('node', $node, $teaser, $page);
552
}
553

554 555 556
/**
 * Apply filters to a node in preparation for theming.
 */
Dries's avatar
Dries committed
557
function node_prepare($node, $teaser = FALSE) {
558
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
Dries committed
559
  if ($teaser == FALSE) {
560
    $node->body = check_markup($node->body, $node->format, FALSE);
561 562
  }
  else {
563
    $node->teaser = check_markup($node->teaser, $node->format, FALSE);
564
  }
565
  return $node;
566 567
}

568 569 570
/**
 * Generate a page displaying a single node, along with its comments.
 */
571
function node_show($node, $cid) {
572
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
Dries committed
573

574 575
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
576 577
  }

578 579
  // Update the history table, stating that this user viewed this node.
  node_tag_new($node->nid);
580

581
  return $output;
582 583
}

584 585 586
/**
 * Implementation of hook_perm().
 */
587
function node_perm() {
588
  return array('administer nodes', 'access content', 'view revisions', 'revert revisions');
589 590
}

591 592 593
/**
 * Implementation of hook_search().
 */
594 595 596 597
function node_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
      return t('content');
598

Dries's avatar
Dries committed
599 600
    case 'reset':
      variable_del('node_cron_last');
601
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
602
      return;
603

604 605
    case 'status':
      $last = variable_get('node_cron_last', 0);
606
      $last_nid = variable_get('node_cron_last_nid', 0);
607 608
      $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));
609
      return array('remaining' => $remaining, 'total' => $total);
610 611 612 613 614 615

    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';
616
      $form['content_ranking']['info'] = array('#type' => 'markup', '#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>');
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
      if (module_exist('comment')) {
        $ranking['node_rank_comments'] = t('Number of comments');
      }
      if (module_exist('statistics') && variable_get('statistics_count_content_views', 0)) {
        $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;

634
    case 'search':
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
      // 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
      $stats_join = false;
      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';
        $stats_join = true;
      }
      if (module_exist('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
        // 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';
        }
      }
      if (module_exist('statistics') && variable_get('statistics_count_content_views', 0) &&
          $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;
        $join2 .= ' LEFT JOIN {node_counter} nc ON n.nid = nc.nid';
      }
      $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
706 707
      $results = array();
      foreach ($find as $item) {
708
        $node = node_load($item->sid);
709 710 711 712 713 714 715 716 717 718 719

        // Get node output (filtered and with module-specific fields).
        if (node_hook($node, 'view')) {
          node_invoke($node, 'view', false, false);
        }
        else {
          $node = node_prepare($node, false);
        }
        // Allow modules to change $node->body before viewing.
        node_invoke_nodeapi($node, 'view', false, false);

720 721 722
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');

723
        $extra = node_invoke_nodeapi($node, 'search result');
724
        $results[] = array('link' => url('node/'. $item->sid),
725
                           'type' => node_get_name($node),
726
                           'title' => $node->title,
727
                           'user' => theme('username', $node),
728
                           'date' => $node->changed,
729
                           'node' => $node,
730
                           'extra' => $extra,
731
                           'snippet' => search_excerpt($keys, $node->body));
732 733 734
      }
      return $results;
  }
735 736
}

737 738 739 740 741 742 743 744 745 746
/**
 * 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);
  }
}

747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
function theme_node_search_admin($form) {
  $output = form_render($form['info']);

  $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']);
    $row[] = form_render($form['factors'][$key]);
    $rows[] = $row;
  }
  $output .= theme('table', $header, $rows);

  $output .= form_render($form);
  return $output;
}

Dries's avatar
Dries committed
764
/**
765
 * Menu callback; presents general node configuration options.
Dries's avatar
Dries committed
766 767 768
 */
function node_configure() {

769
  $form['default_nodes_main'] = array(
770 771 772
    '#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.')
773 774 775
  );

  $form['teaser_length'] = array(
776 777
    '#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'),
778 779
      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')),
780
    '#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.")
781 782 783
  );

  $form['node_preview'] = array(
784 785
    '#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?')
786
  );
787

788
  return system_settings_form('node_configure', $form);
789 790
}

791 792 793
/**
 * Retrieve the comment mode for the given node ID (none, read, or read/write).
 */
794
function node_comment_mode($nid) {
795 796
  static $comment_mode;
  if (!isset($comment_mode[$nid])) {
797
    $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
798 799
  }
  return $comment_mode[$nid];
800 801
}

802 803 804
/**
 * Implementation of hook_link().
 */
805
function node_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
806 807
  $links = array();

808
  if ($type == 'node') {
809
    if (array_key_exists('links', $node)) {
Kjartan's avatar
Kjartan committed
810 811
      $links = $node->links;
    }
812

813
    if ($main == 1 && $node->teaser && $node->readmore) {
Dries's avatar
Dries committed
814
      $links[] = l(t('read more'), "node/$node->nid", array('title' => t('Read the rest of this posting.'), 'class' => 'read-more'));
815
    }
Dries's avatar
Dries committed
816 817
  }

Dries's avatar
Dries committed
818
  return $links;
Dries's avatar
Dries committed
819 820
}

Dries's avatar
Dries committed
821 822 823
/**
 * Implementation of hook_menu().
 */
824
function node_menu($may_cache) {
Dries's avatar
Dries committed
825 826
  $items = array();

827 828
  if ($may_cache) {
    $items[] = array('path' => 'admin/node', 'title' => t('content'),
829
      'callback' => 'node_admin_nodes',
830 831 832
      'access' => user_access('administer nodes'));
    $items[] = array('path' => 'admin/node/overview', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
833 834 835 836 837 838 839 840

    if (module_exist('search')) {
      $items[] = array('path' => 'admin/node/search', 'title' => t('search'),
        'callback' => 'node_admin_search',
        'access' => user_access('administer nodes'),
        'type' => MENU_LOCAL_TASK);
    }

841
    $items[] = array('path' => 'admin/settings/node', 'title' => t('posts'),
842
      'callback' => 'node_configure',
843 844
      'access' => user_access('administer nodes'));
    $items[] = array('path' => 'admin/settings/content-types', 'title' => t('content types'),
845
      'callback' => 'node_types_configure',
846
      'access' => user_access('administer nodes'));
847

848
    $items[] = array('path' => 'node', 'title' => t('content'),
Dries's avatar
Dries committed
849
      'callback' => 'node_page',
850 851 852
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
    $items[] = array('path' => 'node/add', 'title' => t('create content'),
Dries's avatar
Dries committed
853
      'callback' => 'node_page',
854 855 856
      'access' => user_access('access content'),
      'type' => MENU_ITEM_GROUPING,
      'weight' => 1);
857 858 859 860
    $items[] = array('path' => 'rss.xml', 'title' => t('rss feed'),
      'callback' => 'node_feed',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
861 862 863
  }
  else {
    if (arg(0) == 'node' && is_numeric(arg(1))) {
864
      $node = node_load(arg(1));
865 866
      if ($node->nid) {
        $items[] = array('path' => 'node/'. arg(1), 'title' => t('view'),
867
          'callback' => 'node_page',
868 869 870
          'access' => node_access('view', $node),
          'type' => MENU_CALLBACK);
        $items[] = array('path' => 'node/'. arg(1) .'/view', 'title' => t('view'),
871
            'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
872 873 874 875
        $items[] = array('path' => 'node/'. arg(1) .'/edit', 'title' => t('edit'),
          'callback' => 'node_page',
          'access' => node_access('update', $node),
          'weight' => 1,
876
          'type' => MENU_LOCAL_TASK);
877
        $items[] = array('path' => 'node/'. arg(1) .'/delete', 'title' => t('delete'),
878
          'callback' => 'node_delete_confirm',
879 880 881
          'access' => node_access('delete', $node),
          'weight' => 1,
          'type' => MENU_CALLBACK);
882 883 884 885 886 887
        $revisions_access = ((user_access('view revisions') || user_access('administer nodes')) && node_access('view', $node) && db_result(db_query('SELECT COUNT(vid) FROM {node_revisions} WHERE nid = %d', arg(1))) > 1);
        $items[] = array('path' => 'node/'. arg(1) .'/revisions', 'title' => t('revisions'),
          'callback' => 'node_revisions',
          'access' => $revisions_access,
          'weight' => 2,
          'type' => MENU_LOCAL_TASK);
888
      }
889
    }
890 891
    else if (arg(0) == 'admin' && arg(1) == 'settings' && arg(2) == 'content-types' && is_string(arg(3))) {
      $items[] = array('path' => 'admin/settings/content-types/'. arg(3),
892
        'title' => t("'%name' content type", array('%name' => node_get_name(arg(3)))),
893 894
        'type' => MENU_CALLBACK);
    }
Dries's avatar
Dries committed
895 896 897 898 899
  }

  return $items;
}

900 901 902 903 904
function node_last_changed($nid) {
  $node = db_fetch_object(db_query('SELECT changed FROM {node} WHERE nid = %d', $nid));
  return ($node->changed);
}

905 906 907
/**
 * List node administration operations that can be performed.
 */
908
function node_operations() {
909
  $operations = array(
910 911 912 913 914 915
    'approve' =>   array(t('Approve the selected posts'), 'UPDATE {node} SET status = 1, moderate = 0 WHERE nid = %d'),
    'promote' =>   array(t('Promote the selected posts'), 'UPDATE {node} SET status = 1, promote = 1 WHERE nid = %d'),
    'sticky' =>    array(t('Make the selected posts sticky'), 'UPDATE {node} SET status = 1, sticky = 1 WHERE nid = %d'),
    'demote' =>    array(t('Demote the selected posts'), 'UPDATE {node} SET promote = 0 WHERE nid = %d'),
    'unpublish' => array(t('Unpublish the selected posts'), 'UPDATE {node} SET status = 0 WHERE nid = %d'),
    'delete' =>    array(t('Delete the selected posts'), '')
916
  );
917 918
  return $operations;
}
919

920 921 922
/**
 * List node administration filters that can be applied.
 */
923
function node_filters() {
924
  // Regular filters
925 926 927 928 929 930 931 932 933
  $filters['status'] = array('title' => t('status'),
    'options' => array('status-1'   => t('published'),     'status-0' => t('not published'),
                       'moderate-1' => t('in moderation'), 'moderate-0' => t('not in moderation'),
                       'promote-1'  => t('promoted'),      'promote-0' => t('not promoted'),
                       'sticky-1'   => t('sticky'),        'sticky-0' => t('not sticky')));
  $filters['type'] = array('title' => t('type'), 'options' => node_get_types());
  // The taxonomy filter
  if ($taxonomy = module_invoke('taxonomy', 'form_all', 1)) {
    $filters['category'] = array('title' => t('category'), 'options' => $taxonomy);
934
  }
935

936 937 938
  return $filters;
}

939 940 941
/**
 * Build query for node administration filters based on session.
 */
942 943
function node_build_filter_query() {
  $filters = node_filters();
944 945 946 947

  // Build query
  $where = $args = array();
  $join = '';
948
  foreach ($_SESSION['node_overview_filter'] as $index => $filter) {
949
    list($key, $value) = $filter;
950 951 952 953 954 955 956 957 958 959 960 961 962
    switch($key) {
      case 'status':
        // Note: no exploitable hole as $key/$value have already been checked when submitted
        list($key, $value) = explode('-', $value, 2);
        $where[] = 'n.'. $key .' = %d';
        break;
      case 'category':
        $table = "tn$index";
        $where[] = "$table.tid = %d";
        $join .= "INNER JOIN {term_node} $table ON n.nid = $table.nid ";
        break;
      case 'type':
        $where[] = "n.type = '%s'";
963 964 965 966
    }
    $args[] = $value;
  }
  $where = count($where) ? 'WHERE '. implode(' AND ', $where) : '';
967

968 969
  return array('where' => $where, 'join' => $join, 'args' => $args);
}
970

971 972 973
/**
 * Return form for node administration filters.
 */
974 975 976 977 978 979
function node_filter_form() {
  $session = &$_SESSION['node_overview_filter'];
  $session = is_array($session) ? $session : array();
  $filters = node_filters();

  $i = 0;
980 981 982 983
  $form['filters'] = array('#type' => 'fieldset',
    '#title' => t('Show only items where'),
    '#theme' => 'node_filters',
  );
984 985
  foreach ($session as $filter) {
    list($type, $value) = $filter;
986 987 988 989 990 991 992 993
    if ($type == 'category') {
      // Load term name from DB rather than search and parse options array.
      $value = module_invoke('taxonomy', 'get_term', $value);
      $value = $value->name;
    }
    else {
      $value = $filters[$type]['options'][$value];
    }
994
    $string = ($i++ ? '<em>and</em> where <strong>%a</strong> is <strong>%b</strong>' : '<strong>%a</strong> is <strong>%b</strong>');
995
    $form['filters']['current'][] = array('#value' => t($string, array('%a' => $filters[$type]['title'] , '%b' => $value)));
996
  }
997

998 999
  foreach ($filters as $key => $filter) {
    $names[$key] = $filter['title'];
1000
    $form['filters']['status'][$key] = array('#type' => 'select', '#options' => $filter['options']);
1001 1002
  }

1003 1004
  $form['filters']['filter'] = array('#type' => 'radios', '#options' => $names, '#default_value' => 'status');
  $form['filters']['buttons']['submit'] = array('#type' => 'submit', '#value' => (count($session) ? t('Refine') : t('Filter')));
1005
  if (count($session)) {
1006 1007
    $form['filters']['buttons']['undo'] = array('#type' => 'submit', '#value' => t('Undo'));
    $form['filters']['buttons']['reset'] = array('#type' => 'submit', '#value' => t('Reset'));
1008
  }
1009

1010 1011 1012
  return drupal_get_form('node_filter_form', $form);
}

1013 1014 1015
/**
 * Theme node administration filter form.
 */
1016 1017 1018
function theme_node_filter_form(&$form) {
  $output .= '<div id="node-admin-filter">';
  $output .= form_render($form['filters']);
1019
  $output .= '</div>';
1020 1021 1022
  $output .= form_render($form);
  return $output;
}
1023

1024 1025 1026
/**
 * Theme node administraton filter selector.
 */
1027 1028 1029 1030 1031 1032 1033 1034
function theme_node_filters(&$form) {
  $output .= '<ul>';
  if (sizeof($form['current'])) {
    foreach (element_children($form['current']) as $key) {
      $output .= '<li>' . form_render($form['current'][$key]) . '</li>';
    }
  }

1035
  $output .= '<li><dl class="multiselect">' . (sizeof($form['current']) ? '<dt><em>'. t('and') .'</em> '. t('where') .'</dt>' : '') . '<dd class="a">';
1036
  foreach (element_children($form['filter']) as $key) {
1037 1038 1039 1040
    $output .= form_render($form['filter'][$key]);
  }
  $output .= '</dd>';

1041
  $output .= '<dt>'. t('is') .'</dt>' . '<dd class="b">';
1042

1043
  foreach (element_children($form['status']) as $key) {
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
    $output .= form_render($form['status'][$key]);
  }
  $output .= '</dd>';

  $output .= '</dl>';
  $output .= '<div class="container-inline" id="node-admin-buttons">'. form_render($form['buttons']) .'</div>';
  $output .= '</li></ul><br class="clear" />';

  return $output;
}

1055 1056 1057
/**
 * Process result from node administration filter form.
 */
1058
function node_filter_form_submit() {
1059 1060 1061 1062
  global $form_values;
  $op = $_POST['op'];
  $filters = node_filters();
  switch ($op) {
1063 1064
    case t('Filter'):
    case t('Refine'):
1065 1066
      if (isset($form_values['filter'])) {
        $filter = $form_values['filter'];
1067 1068 1069 1070 1071

        // Flatten the options array to accomodate hierarchical/nested options.
        $flat_options = form_options_flatten($filters[$filter]['options']);

        if (isset($flat_options[$form_values[$filter]])) {
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
          $_SESSION['node_overview_filter'][] = array($filter, $form_values[$filter]);
        }
      }
      break;
    case t('Undo'):
      array_pop($_SESSION['node_overview_filter']);
      break;
    case t('Reset'):
      $_SESSION['node_overview_filter'] = array();
      break;
  }
}

/**
 * Generate the content administration overview.
 */
1088
function node_admin_nodes_submit($form_id, $edit) {
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
  $operations = node_operations();
  if ($operations[$edit['operation']][1]) {
    // Flag changes
    $operation = $operations[$edit['operation']][1];
    foreach ($edit['nodes'] as $nid => $value) {
      if ($value) {
        db_query($operation, $nid);
      }
    }
    drupal_set_message(t('The update has been performed.'));
  }
}

function node_admin_nodes_validate($form_id, $edit) {
  $edit['nodes'] = array_diff($edit['nodes'], array(0));
  if (count($edit['nodes']) == 0) {
1105 1106 1107 1108 1109 1110
    if ($edit['operation'] == 'delete') {
      form_set_error('', t('Please select some items to perform the delete operation.'));
    }
    else {
      form_set_error('', t('Please select some items to perform the update on.'));
    }
1111 1112 1113
  }
}

1114 1115 1116
/**
 * Menu callback: content administration.
 */
1117 1118 1119 1120
function node_admin_nodes() {
  global $form_values;
  $output = node_filter_form();

Dries's avatar