node.module 99.8 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; content management &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>');
39
40
41
42
    case 'admin/content/types':
      return '<p>'. t('Below is a list of all the content types on your site. All posts that exist on your site are instances of one of these content types.') .'</p>';
    case 'admin/content/types/add':
      return '<p>'. t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.');
Dries's avatar
   
Dries committed
43
  }
Dries's avatar
   
Dries committed
44
45
46
47

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

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

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

Dries's avatar
   
Dries committed
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.
Dries's avatar
   
Dries committed
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)) {
Dries's avatar
   
Dries committed
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
  }

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

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

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

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

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

Dries's avatar
   
Dries committed
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);
Dries's avatar
   
Dries committed
117
118
119
}

/**
120
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
   
Dries committed
121
 *
Dries's avatar
   
Dries committed
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.
Dries's avatar
   
Dries committed
128
 */
129
function node_mark($nid, $timestamp) {
Dries's avatar
   
Dries committed
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);
Dries's avatar
   
Dries committed
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;
Dries's avatar
   
Dries committed
146
147
}

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

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

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

Dries's avatar
   
Dries committed
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.
Dries's avatar
   
Dries committed
179
180
181
182
  if (strlen($body) < $size) {
    return $body;
  }

Dries's avatar
   
Dries committed
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
Dries's avatar
   
Dries committed
186
  // the next sentence.
187
  $breakpoints = array('</p>' => 4, '<br />' => 0, '<br>' => 0, "\n" => 0, '. ' => 1, '! ' => 1, '? ' => 1, '。' => 3, '؟ ' => 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);
Dries's avatar
   
Dries committed
196
197
}

198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/**
 * Builds a list of available node types, and returns all of part of this list
 * in the specified format.
 *
 * @param $op
 *   The format in which to return the list. When this is set to 'type',
 *   'module', or 'name', only the specified node type is returned. When set to
 *   'types' or 'names', all node types are returned.
 * @param $node
 *   A node object, array, or string that indicates the node type to return.
 *   Leave at default value (NULL) to return a list of all node types.
 * @param $reset
 *   Whether or not to reset this function's internal cache (defaults to
 *   FALSE).
 *
 * @return
 *   Either an array of all available node types, or a single node type, in a
 *   variable format.
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
219

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

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

/**
 * Resets the database cache of node types, and saves all new or non-modified
 * module-defined node types to the database.
 */
function node_types_rebuild() {
  _node_types_build();

  $node_types = node_get_types('types', NULL, TRUE);

  foreach ($node_types as $type => $info) {
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
265
  }
266
267

  _node_types_build();
268
269
}

270
/**
271
272
273
274
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
   
Dries committed
275
276
 *
 * @return
277
 *   Status flag indicating outcome of the operation.
Dries's avatar
   
Dries committed
278
 */
279
280
281
282
283
284
285
286
287
288
289
290
291
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
  $is_existing = db_num_rows(db_query("SELECT * FROM {node_type} WHERE type = '%s'", $existing_type));

  if ($is_existing) {
    db_query("UPDATE {node_type} SET type = '%s', name = '%s', module = '%s', has_title = %d, title_label = '%s', has_body = %d, body_label = '%s', description = '%s', help = '%s', min_word_count = %d, custom = %d, modified = %d, locked = %d WHERE type = '%s'", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $existing_type);
    return SAVED_UPDATED;
  }
  else {
    db_query("INSERT INTO {node_type} (type, name, module, has_title, title_label, has_body, body_label, description, help, min_word_count, custom, modified, locked, orig_type) VALUES ('%s', '%s', '%s', %d, '%s', %d, '%s', '%s', '%s', %d, %d, %d, %d, '%s')", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $info->orig_type);
    return SAVED_NEW;
  }
292
}
293

294
/**
295
296
297
298
299
300
 * Updates all nodes of one type to be of another type.
 *
 * @param $orig_type
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
301
302
 *
 * @return
303
 *   The number of nodes whose node type field was modified.
304
 */
305
306
307
function node_type_update_nodes($old_type, $type) {
  db_query("UPDATE {node} SET type = '%s' WHERE type = '%s'", $type, $old_type);
  return db_affected_rows();
Dries's avatar
   
Dries committed
308
}
Dries's avatar
   
Dries committed
309

310
/**
311
312
 * Builds the list of available node types, by querying hook_node_info() in all
 * modules, and by looking for node types in the database.
Dries's avatar
   
Dries committed
313
314
 *
 */
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
function _node_types_build() {
  $_node_types = array();
  $_node_names = array();

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
    $_node_types[$type] = (object) _node_type_set_defaults($info);
    $_node_names[$type] = $info['name'];
  }

  $type_result = db_query(db_rewrite_sql('SELECT nt.type, nt.* FROM {node_type} nt ORDER BY nt.type ASC', 'nt', 'type'));
  while ($type_object = db_fetch_object($type_result)) {
    if (!isset($_node_types[$type_object->type]) || $type_object->modified) {
      $_node_types[$type_object->type] = $type_object;
      $_node_names[$type_object->type] = $type_object->name;

      if ($type_object->type != $type_object->orig_type) {
        unset($_node_types[$type_object->orig_type]);
        unset($_node_names[$type_object->orig_type]);
      }
    }
  }

  asort($_node_names);

  return array($_node_types, $_node_names);
}

/**
 * Set default values for a node type defined through hook_node_info().
 */
function _node_type_set_defaults($info) {
  if (!isset($info['has_title'])) {
    $info['has_title'] = TRUE;
  }
  if ($info['has_title'] && !isset($info['title_label'])) {
    $info['title_label'] = t('Title');
  }

  if (!isset($info['has_body'])) {
    $info['has_body'] = TRUE;
  }
  if ($info['has_body'] && !isset($info['body_label'])) {
    $info['body_label'] = t('Body');
  }

  if (!isset($info['custom'])) {
    $info['custom'] = FALSE;
  }
  if (!isset($info['modified'])) {
    $info['modified'] = FALSE;
  }
  if (!isset($info['locked'])) {
    $info['locked'] = TRUE;
  }

  $info['orig_type'] = $info['type'];
  $info['is_new'] = TRUE;

  return $info;
Dries's avatar
   
Dries committed
376
}
Dries's avatar
   
Dries committed
377

378
/**
Dries's avatar
   
Dries committed
379
380
381
382
383
384
385
386
387
388
 * 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) {
389
390
391
392
393
  $module = node_get_types('module', $node);
  if ($module == 'node') {
    $module = 'node_content'; // Avoid function name collisions.
  }
  return module_hook($module, $hook);
Dries's avatar
   
Dries committed
394
395
}

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

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

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

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

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

Dries's avatar
   
Dries committed
484
  // Retrieve the node.
485
  // No db_rewrite_sql is applied so as to get complete indexing for search.
486
  if ($revision) {
487
    array_unshift($arguments, $revision);
488
    $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
489
  }
490
  else {
491
    $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
492
493
  }

494
495
496
497
498
499
500
  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
501
502
    }

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

Dries's avatar
   
Dries committed
510
  if ($cachable) {
511
    $nodes[$param] = $node;
Dries's avatar
   
Dries committed
512
513
  }

Dries's avatar
   
Dries committed
514
515
516
  return $node;
}

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

523
  $node->is_new = FALSE;
Dries's avatar
   
Dries committed
524

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

Dries's avatar
   
Dries committed
530
    $node->nid = db_next_id('{node}_nid');
531
532
533
534
535
536
537
    $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
538
    }
539
    $node = $node_current;
Dries's avatar
   
Dries committed
540

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

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

554
555
556
557
558
559
560
561
562
563
564
565
566
  // 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,
567
                    'promote' => $node->promote, 'sticky' => $node->sticky);
568
569
570
571
  $node_table_types = array('nid' => '%d', 'vid' => '%d',
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
                    'status' => '%d', 'created' => '%d',
                    'changed' => '%d', 'comment' => '%d',
572
                    'promote' => '%d', 'sticky' => '%d');
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593

  //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
594
      }
595
596
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
Dries's avatar
   
Dries committed
597
    }
598
  }
Dries's avatar
   
Dries committed
599

600
601
602
  // 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
603

604
605
606
607
608
609
  // 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
610
611
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
Dries's avatar
   
Dries committed
612
613
  }

614
615
616
  // Update the node access table for this node.
  node_access_acquire_grants($node);

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

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

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

643
  if ($node->log != '' && !$teaser) {
644
    $node->body .= '<div class="log"><div class="title">'. t('Log') .':</div>'. filter_xss($node->log) .'</div>';
645
646
  }

Dries's avatar
   
Dries committed
647
648
  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
Dries's avatar
   
Dries committed
649
  if (node_hook($node, 'view')) {
Dries's avatar
   
Dries committed
650
    node_invoke($node, 'view', $teaser, $page);
Dries's avatar
   
Dries committed
651
652
  }
  else {
Dries's avatar
   
Dries committed
653
    $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
654
  }
Dries's avatar
   
Dries committed
655
656
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $teaser, $page);
657
658
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
659
660
661
662
663

    foreach (module_implements('link_alter') AS $module) {
      $function = $module .'_link_alter';
      $function($node, $node->links);
    }
664
  }
665
666
667
668
669
670
671
  // 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
672
673

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

Dries's avatar
   
Dries committed
676
677
678
/**
 * Apply filters to a node in preparation for theming.
 */
Dries's avatar
   
Dries committed
679
function node_prepare($node, $teaser = FALSE) {
Dries's avatar
   
Dries committed
680
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
   
Dries committed
681
  if ($teaser == FALSE) {
682
    $node->body = check_markup($node->body, $node->format, FALSE);
Dries's avatar
   
Dries committed
683
684
  }
  else {
685
    $node->teaser = check_markup($node->teaser, $node->format, FALSE);
Dries's avatar
   
Dries committed
686
  }
Dries's avatar
   
Dries committed
687
  return $node;
Dries's avatar
   
Dries committed
688
689
}

Dries's avatar
   
Dries committed
690
691
692
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
   
Dries committed
693
function node_show($node, $cid) {
Dries's avatar
   
Dries committed
694
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
   
Dries committed
695

Dries's avatar
   
Dries committed
696
697
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
   
Dries committed
698
699
  }

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

Dries's avatar
   
Dries committed
703
  return $output;
Dries's avatar
   
Dries committed
704
705
}

Dries's avatar
   
Dries committed
706
707
708
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
709
function node_perm() {
710
711
712
713
714
715
716
717
718
719
720
721
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
      $name = check_plain($type->name);
      $perms[] = 'create '. $name .' content';
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
   
Dries committed
722
723
}

Dries's avatar
   
Dries committed
724
725
726
/**
 * Implementation of hook_search().
 */
727
function node_search($op = 'search', $keys = NULL) {
728
729
730
  switch ($op) {
    case 'name':
      return t('content');
731

Dries's avatar
Dries committed
732
733
    case 'reset':
      variable_del('node_cron_last');
734
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
735
      return;
736

737
738
    case 'status':
      $last = variable_get('node_cron_last', 0);
739
      $last_nid = variable_get('node_cron_last_nid', 0);
740
741
      $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));
742
      return array('remaining' => $remaining, 'total' => $total);
743
744
745
746
747
748

    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';
749
      $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>');
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766

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

767
    case 'search':
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
      // 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
800
      $stats_join = FALSE;
801
802
803
804
805
806
807
808
809
810
811
      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';
812
        $stats_join = TRUE;
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
      }
      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;
831
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
832
833
834
835
836
837
838
      }
      $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
839
840
      $results = array();
      foreach ($find as $item) {
841
        $node = node_load($item->sid);
842
843
844

        // Get node output (filtered and with module-specific fields).
        if (node_hook($node, 'view')) {
845
          node_invoke($node, 'view', FALSE, FALSE);
846
847
        }
        else {
848
          $node = node_prepare($node, FALSE);
849
850
        }
        // Allow modules to change $node->body before viewing.
851
        node_invoke_nodeapi($node, 'view', FALSE, FALSE);
852

853
854
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
855
856
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
857

Dries's avatar
Dries committed
858
        $extra = node_invoke_nodeapi($node, 'search result');
859
        $results[] = array('link' => url('node/'. $item->sid),
860
                           'type' => node_get_types('name', $node),
861
                           'title' => $node->title,
862
                           'user' => theme('username', $node),
863
                           'date' => $node->changed,
864
                           'node' => $node,
Dries's avatar
Dries committed
865
                           'extra' => $extra,
866
                           'snippet' => search_excerpt($keys, $node->body));
867
868
869
      }
      return $results;
  }
Dries's avatar
   
Dries committed
870
871
}

872
873
874
875
876
877
878
879
880
881
/**
 * 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);
  }
}

882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
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
899
/**
Dries's avatar
   
Dries committed
900
 * Menu callback; presents general node configuration options.
Dries's avatar
   
Dries committed
901
902
903
 */
function node_configure() {

904
  $form['default_nodes_main'] = array(
905
906
907
    '#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.')
908
909
910
  );

  $form['teaser_length'] = array(
911
912
    '#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'),
913
914
      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')),
915
    '#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.")
916
917
918
  );

  $form['node_preview'] = array(
919
920
    '#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?')
921
  );
Dries's avatar
   
Dries committed
922

923
  return system_settings_form('node_configure', $form);
Dries's avatar
   
Dries committed
924
925
}

Dries's avatar
   
Dries committed
926
927
928
/**
 * Retrieve the comment mode for the given node ID (none, read, or read/write).
 */
Dries's avatar
   
Dries committed
929
function node_comment_mode($nid) {
Dries's avatar
   
Dries committed
930
931
  static $comment_mode;
  if (!isset($comment_mode[$nid])) {
Dries's avatar
   
Dries committed
932
    $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
Dries's avatar
   
Dries committed
933
934
  }
  return $comment_mode[$nid];
Dries's avatar
   
Dries committed
935
936
}

Dries's avatar
   
Dries committed
937
938
939
/**
 * Implementation of hook_link().
 */
940
function node_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
   
Dries committed
941
942
  $links = array();

Dries's avatar
   
Dries committed
943
  if ($type == 'node') {
Dries's avatar
   
Dries committed
944
    if (array_key_exists('links', $node)) {
Kjartan's avatar
Kjartan committed
945
946
      $links = $node->links;
    }
Dries's avatar
   
Dries committed
947

948
    if ($teaser == 1 && $node->teaser && $node->readmore) {
949
      $links['node_read_more'] = array(
950
951
952
        'title' => t('read more'),
        'href' => "node/$node->nid",
        'attributes' => array('title' => t('Read the rest of this posting.'))
953
      );
Dries's avatar
   
Dries committed
954
    }
Dries's avatar
   
Dries committed
955
956
  }

Dries's avatar
   
Dries committed
957
  return $links;
Dries's avatar
   
Dries committed
958
959
}

Dries's avatar
   
Dries committed
960
961
962
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
963
function node_menu($may_cache) {
Dries's avatar
   
Dries committed
964
  $items = array();
Dries's avatar
   
Dries committed
965
  if ($may_cache) {
966
967
968
969
970
971
972
973
974
975
976
977
978
    $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
979
      'callback' => 'node_admin_nodes',
980
981
982
983
      'access' => user_access('administer nodes')
    );

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

    if (module_exist('search')) {
987
988
      $items[] = array('path' => 'admin/content/search', 'title' => t('search posts'),
        'description' => t('Search posts by keyword.'),
Steven Wittens's avatar
Steven Wittens committed
989
990
        'callback' => 'node_admin_search',
        'access' => user_access('administer nodes'),
991
        'type' => MENU_NORMAL_ITEM);
Steven Wittens's avatar
Steven Wittens committed
992
993
    }

994
995
996
997
    $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
998
      'callback' => 'node_configure',
999
1000
      'access' => user_access('administer nodes')
    );