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

Dries's avatar
   
Dries committed
11
12
13
14
/**
 * Implementation of hook_help().
 */
function node_help($section) {
15
  switch ($section) {
Dries's avatar
   
Dries committed
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/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>';
Dries's avatar
   
Dries committed
34
      return $output;
35
    case 'admin/settings/modules#description':
36
      return t('Allows content to be submitted to the site and displayed on pages.');
37
    case 'admin/content/search':
38
      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>');
Dries's avatar
   
Dries committed
39
  }
Dries's avatar
   
Dries committed
40
41
42
43

  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.');
  }
44
45

  if (arg(0) == 'node' && arg(1) == 'add' && $type = arg(2)) {
46
    return filter_xss_admin(variable_get($type .'_help', ''));
47
  }
Dries's avatar
   
Dries committed
48
49
}

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

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

Dries's avatar
   
Dries committed
73
  return theme('node_list', $items, $title);
Dries's avatar
   
Dries committed
74
75
}

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

Dries's avatar
   
Dries committed
83
84
85
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
   
Dries committed
86
87
88
89
function node_tag_new($nid) {
  global $user;

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

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

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

111
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
   
Dries committed
112
113
114
}

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

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

Dries's avatar
   
Dries committed
143
/**
144
 * Automatically generate a teaser for a node body in a given format.
Dries's avatar
   
Dries committed
145
 */
146
function node_teaser($body, $format = NULL) {
Dries's avatar
   
Dries committed
147

Dries's avatar
   
Dries committed
148
  $size = variable_get('teaser_length', 600);
Dries's avatar
   
Dries committed
149

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

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

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

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

173
  // If we have a short body, the entire body is the teaser.
Dries's avatar
   
Dries committed
174
175
176
177
  if (strlen($body) < $size) {
    return $body;
  }

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

189
  // If all else fails, we simply truncate the string.
190
  return truncate_utf8($body, $size);
Dries's avatar
   
Dries committed
191
192
}

193
function _node_names($op = '', $node = NULL) {
194
195
  static $node_names = array();
  static $node_list = array();
196

197
  if (empty($node_names)) {
198
    $node_names = module_invoke_all('node_info');
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    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];
  }
}

227
/**
228
 * Determine the basename for hook_load etc.
Dries's avatar
   
Dries committed
229
 *
230
 * @param $node
Dries's avatar
   
Dries committed
231
 *   Either a node object, a node array, or a string containing the node type.
Dries's avatar
   
Dries committed
232
 * @return
233
 *   The basename for hook_load, hook_nodeapi etc.
Dries's avatar
   
Dries committed
234
 */
235
236
237
function node_get_base($node) {
  return _node_names('base', $node);
}
238

239
240
241
242
243
244
245
246
247
248
/**
 * 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);
Dries's avatar
   
Dries committed
249
}
Dries's avatar
   
Dries committed
250

251
/**
252
 * Return the list of available node types.
Dries's avatar
   
Dries committed
253
 *
254
255
 * @param $node
 *   Either a node object, a node array, or a string containing the node type.
Dries's avatar
   
Dries committed
256
 * @return
257
 *   An array consisting ('#type' => name) pairs.
Dries's avatar
   
Dries committed
258
 */
259
260
function node_get_types() {
  return _node_names('list');
Dries's avatar
   
Dries committed
261
}
Dries's avatar
   
Dries committed
262

263
/**
Dries's avatar
   
Dries committed
264
265
266
267
268
269
270
271
272
273
 * 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) {
274
  return module_hook(node_get_base($node), $hook);
Dries's avatar
   
Dries committed
275
276
}

277
/**
Dries's avatar
   
Dries committed
278
279
280
281
282
283
284
285
286
 * 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
287
 *   The returned value of the invoked hook.
Dries's avatar
   
Dries committed
288
289
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
290
291
  if (node_hook($node, $hook)) {
    $function = node_get_base($node) ."_$hook";
Dries's avatar
   
Dries committed
292
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
   
Dries committed
293
294
295
  }
}

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

Dries's avatar
   
Dries committed
323
324
325
/**
 * Load a node object from the database.
 *
326
327
 * @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
328
329
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
   
Dries committed
330
331
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
   
Dries committed
332
333
334
335
 *
 * @return
 *   A fully-populated node object.
 */
336
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
   
Dries committed
337
338
339
340
341
342
  static $nodes = array();

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

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

Dries's avatar
   
Dries committed
361
  // Retrieve the node.
362
  // No db_rewrite_sql is applied so as to get complete indexing for search.
363
  if ($revision) {
364
    array_unshift($arguments, $revision);
365
    $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
366
  }
367
  else {
368
    $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
369
370
  }

371
372
373
374
375
376
377
  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
378
379
    }

380
381
382
383
384
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
Dries's avatar
   
Dries committed
385
386
  }

Dries's avatar
   
Dries committed
387
  if ($cachable) {
388
    $nodes[$param] = $node;
Dries's avatar
   
Dries committed
389
390
  }

Dries's avatar
   
Dries committed
391
392
393
  return $node;
}

Dries's avatar
   
Dries committed
394
395
396
/**
 * Save a node object into the database.
 */
397
function node_save(&$node) {
398
  global $user;
Dries's avatar
   
Dries committed
399

400
  $node->is_new = FALSE;
Dries's avatar
   
Dries committed
401

Dries's avatar
   
Dries committed
402
  // Apply filters to some default node fields:
Dries's avatar
   
Dries committed
403
  if (empty($node->nid)) {
Dries's avatar
   
Dries committed
404
    // Insert a new node.
405
    $node->is_new = TRUE;
Dries's avatar
   
Dries committed
406

Dries's avatar
   
Dries committed
407
    $node->nid = db_next_id('{node}_nid');
408
409
410
411
412
413
414
    $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
415
    }
416
    $node = $node_current;
Dries's avatar
   
Dries committed
417

418
419
420
421
    if ($node->revision) {
      $node->old_vid = $node->vid;
      $node->vid = db_next_id('{node_revisions}_vid');
    }
Dries's avatar
   
Dries committed
422
423
  }

424
425
426
427
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
428
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
429
  $node->changed = time();
Dries's avatar
   
Dries committed
430

431
432
433
434
435
436
437
438
439
440
441
442
443
  // 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,
444
                    'promote' => $node->promote, 'sticky' => $node->sticky);
445
446
447
448
  $node_table_types = array('nid' => '%d', 'vid' => '%d',
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
                    'status' => '%d', 'created' => '%d',
                    'changed' => '%d', 'comment' => '%d',
449
                    'promote' => '%d', 'sticky' => '%d');
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470

  //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
471
      }
472
473
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
Dries's avatar
   
Dries committed
474
    }
475
  }
Dries's avatar
   
Dries committed
476

477
478
479
  // 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
480

481
482
483
484
485
486
  // Call the node specific callback (if any):
  if ($node->is_new) {
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
  }
  else {
Dries's avatar
   
Dries committed
487
488
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
Dries's avatar
   
Dries committed
489
490
  }

Dries's avatar
   
Dries committed
491
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
   
Dries committed
492
  cache_clear_all();
Dries's avatar
   
Dries committed
493
494
}

Dries's avatar
   
Dries committed
495
496
497
498
499
500
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
501
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
   
Dries committed
502
503
 * @param $page
 *   Whether the node is being displayed by itself as a page.
504
505
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
   
Dries committed
506
507
508
509
 *
 * @return
 *   An HTML representation of the themed node.
 */
510
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
511
  $node = (object)$node;
Dries's avatar
   
Dries committed
512

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

517
  if ($node->log != '' && !$teaser) {
518
    $node->body .= '<div class="log"><div class="title">'. t('Log') .':</div>'. filter_xss($node->log) .'</div>';
519
520
  }

Dries's avatar
   
Dries committed
521
522
  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
Dries's avatar
   
Dries committed
523
  if (node_hook($node, 'view')) {
Dries's avatar
   
Dries committed
524
    node_invoke($node, 'view', $teaser, $page);
Dries's avatar
   
Dries committed
525
526
  }
  else {
Dries's avatar
   
Dries committed
527
    $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
528
  }
Dries's avatar
   
Dries committed
529
530
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $teaser, $page);
531
532
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
533
534
535
536
537

    foreach (module_implements('link_alter') AS $module) {
      $function = $module .'_link_alter';
      $function($node, $node->links);
    }
538
  }
539
540
541
542
543
544
545
  // 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
546
547

  return theme('node', $node, $teaser, $page);
Dries's avatar
   
Dries committed
548
}
Dries's avatar
   
Dries committed
549

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

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

Dries's avatar
   
Dries committed
570
571
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
   
Dries committed
572
573
  }

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

Dries's avatar
   
Dries committed
577
  return $output;
Dries's avatar
   
Dries committed
578
579
}

Dries's avatar
   
Dries committed
580
581
582
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
583
function node_perm() {
584
  return array('administer nodes', 'access content', 'view revisions', 'revert revisions');
Dries's avatar
   
Dries committed
585
586
}

Dries's avatar
   
Dries committed
587
588
589
/**
 * Implementation of hook_search().
 */
590
function node_search($op = 'search', $keys = NULL) {
591
592
593
  switch ($op) {
    case 'name':
      return t('content');
594

Dries's avatar
Dries committed
595
596
    case 'reset':
      variable_del('node_cron_last');
597
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
598
      return;
599

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

    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';
612
      $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>');
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629

      $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;

630
    case 'search':
631
632
633
634
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
      // 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
663
      $stats_join = FALSE;
664
665
666
667
668
669
670
671
672
673
674
      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';
675
        $stats_join = TRUE;
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
      }
      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;
694
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
695
696
697
698
699
700
701
      }
      $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
702
703
      $results = array();
      foreach ($find as $item) {
704
        $node = node_load($item->sid);
705
706
707

        // Get node output (filtered and with module-specific fields).
        if (node_hook($node, 'view')) {
708
          node_invoke($node, 'view', FALSE, FALSE);
709
710
        }
        else {
711
          $node = node_prepare($node, FALSE);
712
713
        }
        // Allow modules to change $node->body before viewing.
714
        node_invoke_nodeapi($node, 'view', FALSE, FALSE);
715

716
717
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
718
719
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
720

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

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

745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
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
762
/**
Dries's avatar
   
Dries committed
763
 * Menu callback; presents general node configuration options.
Dries's avatar
   
Dries committed
764
765
766
 */
function node_configure() {

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

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

  $form['node_preview'] = array(
782
783
    '#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?')
784
  );
Dries's avatar
   
Dries committed
785

786
  return system_settings_form('node_configure', $form);
Dries's avatar
   
Dries committed
787
788
}

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

Dries's avatar
   
Dries committed
800
801
802
/**
 * Implementation of hook_link().
 */
803
function node_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
   
Dries committed
804
805
  $links = array();

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

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

Dries's avatar
   
Dries committed
820
  return $links;
Dries's avatar
   
Dries committed
821
822
}

Dries's avatar
   
Dries committed
823
824
825
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
826
function node_menu($may_cache) {
Dries's avatar
   
Dries committed
827
  $items = array();
Dries's avatar
   
Dries committed
828
  if ($may_cache) {
829
830
831
832
833
834
835
836
837
838
839
840
841
    $items[] = array('path' => 'admin/content',
      'title' => t('content management'),
      'description' => t('Manage your site\'s content.'),
      'position' => 'left',
      'weight' => -10,
      'callback' => 'system_admin_menu_block_page',
      'access' => user_access('access configuration pages'),
    );

    $items[] = array(
      'path' => 'admin/content/node',
      'title' => t('posts'),
      'description' => t('View, edit, and delete your site\'s content.'),
Steven Wittens's avatar
Steven Wittens committed
842
      'callback' => 'node_admin_nodes',
843
844
845
846
      'access' => user_access('administer nodes')
    );

    $items[] = array('path' => 'admin/content/node/overview', 'title' => t('list'),
Dries's avatar
   
Dries committed
847
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Steven Wittens's avatar
Steven Wittens committed
848
849

    if (module_exist('search')) {
850
851
      $items[] = array('path' => 'admin/content/search', 'title' => t('search posts'),
        'description' => t('Search posts by keyword.'),
Steven Wittens's avatar
Steven Wittens committed
852
853
        'callback' => 'node_admin_search',
        'access' => user_access('administer nodes'),
854
        'type' => MENU_NORMAL_ITEM);
Steven Wittens's avatar
Steven Wittens committed
855
856
    }

857
858
859
860
    $items[] = array(
      'path' => 'admin/content/node-settings',
      'title' => t('post settings'),
      'description' => t('Control posting behavior, such as teaser length, requiring previews before posting, and the number of posts on the front page.'),
Dries's avatar
   
Dries committed
861
      'callback' => 'node_configure',
862
863
864
865
866
867
      'access' => user_access('administer nodes')
    );
    $items[] = array(
      'path' => 'admin/content/types',
      'title' => t('content types'),
      'description' => t('Manage posts by content type, including default status, front page promotion, etc.'),
868
      'callback' => 'node_types_configure',
869
870
      'access' => user_access('administer nodes')
    );
Dries's avatar
   
Dries committed
871

Dries's avatar
   
Dries committed
872
    $items[] = array('path' => 'node', 'title' => t('content'),
Dries's avatar
   
Dries committed
873
      'callback' => 'node_page',
Dries's avatar
   
Dries committed
874
      'access' => user_access('access content'),
875
      'type' => MENU_MODIFIABLE_BY_ADMIN);
Dries's avatar
   
Dries committed
876
    $items[] = array('path' => 'node/add', 'title' => t('create content'),
Dries's avatar
   
Dries committed
877
      'callback' => 'node_page',
Dries's avatar
   
Dries committed
878
879
880
      'access' => user_access('access content'),
      'type' => MENU_ITEM_GROUPING,
      'weight' => 1);
881
882
883
884
    $items[] = array('path' => 'rss.xml', 'title' => t('rss feed'),
      'callback' => 'node_feed',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
885
886
887
  }
  else {
    if (arg(0) == 'node' && is_numeric(arg(1))) {
888
      $node = node_load(arg(1));
889
890
      if ($node->nid) {
        $items[] = array('path' => 'node/'. arg(1), 'title' => t('view'),
Dries's avatar
   
Dries committed
891
          'callback' => 'node_page',
892
893
894
          'access' => node_access('view', $node),
          'type' => MENU_CALLBACK);
        $items[] = array('path' => 'node/'. arg(1) .'/view', 'title' => t('view'),
895
            'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
896
897
898
899
        $items[] = array('path' => 'node/'. arg(1) .'/edit', 'title' => t('edit'),
          'callback' => 'node_page',
          'access' => node_access('update', $node),
          'weight' => 1,
Dries's avatar
   
Dries committed
900
          'type' => MENU_LOCAL_TASK);
901
        $items[] = array('path' => 'node/'. arg(1) .'/delete', 'title' => t('delete'),
902
          'callback' => 'node_delete_confirm',
903
904
905
          'access' => node_access('delete', $node),
          'weight' => 1,
          'type' => MENU_CALLBACK);
906
907
908
909
910
911
        $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);
Dries's avatar
   
Dries committed
912
      }
913
    }
914
    else if (arg(0) == 'admin' && arg(1) == 'content' && arg(2) == 'types' && is_string(arg(3))) {
915
      $items[] = array('path' => 'admin/content/types/'. arg(3),
916
        'title' => t("'%name' content type", array('%name' => node_get_name(arg(3)))),
917
918
        'type' => MENU_CALLBACK);
    }
Dries's avatar
   
Dries committed
919
920
921
922
923
  }

  return $items;
}

924
925
926
927
928
function node_last_changed($nid) {
  $node = db_fetch_object(db_query('SELECT changed FROM {node} WHERE nid = %d', $nid));
  return ($node->changed);
}

929
/**
930
 * Implementation of hook_node_operations().
931
 */
932
function node_node_operations() {
Dries's avatar
   
Dries committed
933
  $operations = array(
934
935
936
937
938
939
    'approve' =>   array(t('Approve the selected posts'), 'node_operations_approve'),
    'promote' =>   array(t('Promote the selected posts'), 'node_operations_promote'),
    'sticky' =>    array(t('Make the selected posts sticky'), 'node_operations_sticky'),
    'demote' =>    array(t('Demote the selected posts'), 'node_operations_demote'),
    'unpublish' => array(t('Unpublish the selected posts'), 'node_operations_unpublish'),
    'delete' =>    array(t('Delete the selected posts'), ''),
Dries's avatar
   
Dries committed
940
  );
941
942
  return $operations;
}
Dries's avatar
   
Dries committed
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
972
973
974
975
976
977
978
/**
 * Callback function for admin mass approving nodes.
 */
function node_operations_approve($nodes) {
  db_query('UPDATE {node} SET status = 1 WHERE nid IN(%s)', implode(',', $nodes));
}

/**
 * Callback function for admin mass promoting nodes.
 */
function node_operations_promote($nodes) {
  db_query('UPDATE {node} SET status = 1, promote = 1 WHERE nid IN(%s)', implode(',', $nodes));
}

/**
 * Callback function for admin mass editing nodes to be sticky.
 */
function node_operations_sticky($nodes) {
  db_query('UPDATE {node} SET status = 1, sticky = 1 WHERE nid IN(%s)', implode(',', $nodes));
}

/**
 * Callback function for admin mass demoting nodes.
 */
function node_operations_demote($nodes) {
  db_query('UPDATE {node} SET promote = 0 WHERE nid IN(%s)', implode(',', $nodes));
}

/**
 * Callback function for admin mass unpublishing nodes.
 */
function node_operations_unpublish($nodes) {
  db_query('UPDATE {node} SET status = 0 WHERE nid IN(%s)', implode(',', $nodes));
}

979
980
981
/**
 * List node administration filters that can be applied.
 */
982
function node_filters() {
983
  // Regular filters
984
985
986
987
988
989
990
991
  $filters['status'] = array('title' => t('status'),
    'options' => array('status-1'   => t('published'),     'status-0' => t('not published'),
                       '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);
992
  }
Dries's avatar
   
Dries committed
993

994
995
996
  return $filters;
}

997
998
999
/**
 * Build query for node administration filters based on session.
 */
1000
function node_build_filter_query() {