node.module 103 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
   
Dries committed
4
5
/**
 * @file
6
7
 * The core that allows content to be submitted to the site. Modules and scripts may
 * programmatically submit nodes using the usual form API pattern.
Dries's avatar
   
Dries committed
8
9
 */

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

Dries's avatar
   
Dries committed
12
13
14
15
/**
 * Implementation of hook_help().
 */
function node_help($section) {
16
  switch ($section) {
Dries's avatar
   
Dries committed
17
    case 'admin/help#node':
18
19
20
21
22
23
24
25
26
27
      $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>
');
28
      $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
29
      return $output;
30
    case 'admin/content/search':
31
      return '<p>'. t('Enter a simple pattern to search for a post. Words are matched exactly. Phrases can be surrounded by quotes to do an exact search.') .'</p>';
32
33
34
    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':
35
      return '<p>'. t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.') .'</p>';
Dries's avatar
   
Dries committed
36
  }
Dries's avatar
   
Dries committed
37
38

  if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'revisions') {
39
    return '<p>'. t('The revisions let you track differences between multiple versions of a post.') .'</p>';
Dries's avatar
   
Dries committed
40
  }
41
42

  if (arg(0) == 'node' && arg(1) == 'add' && $type = arg(2)) {
43
    $type = node_get_types('type', str_replace('-', '_', arg(2)));
44
    return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
45
  }
Dries's avatar
   
Dries committed
46
47
}

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
146
  $size = variable_get('teaser_length', 600);
Dries's avatar
   
Dries committed
147

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

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

156
157
158
159
160
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

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

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

176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
  $position = 0;
  // Cache the reverse of the teaser.
  $reversed = strrev($teaser);

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

194
195
196
197
198
199
200
201
202
203
204
205
  // When even the first paragraph is too long, we try to split at the end of
  // the last full sentence.
  $breakpoints = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);
  $min_length = strlen($reversed);
  foreach ($breakpoints as $point => $offset) {
    $length = strpos($reversed, strrev($point));
    if ($length !== FALSE) {
      $min_length = min($length, $min_length);
      $position = 0 - $length - $offset;
    }
  }
  return ($position == 0) ? $teaser : substr($teaser, 0, $position);
Dries's avatar
   
Dries committed
206
207
}

208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/**
 * 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;
229

230
231
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
232
  }
233

234
235
236
237
238
239
240
241
242
243
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
244
    if (!isset($_node_types[$type])) {
245
246
247
248
      return FALSE;
    }
  }
  switch ($op) {
249
250
251
252
253
254
255
256
    case 'types':
      return $_node_types;
    case 'type':
      return $_node_types[$type];
    case 'module':
      return $_node_types[$type]->module;
    case 'names':
      return $_node_names;
257
    case 'name':
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
      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);
    }
275
  }
276
277

  _node_types_build();
278
279
}

280
/**
281
282
283
284
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
   
Dries committed
285
286
 *
 * @return
287
 *   Status flag indicating outcome of the operation.
Dries's avatar
   
Dries committed
288
 */
289
290
291
292
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));
293
294
295
296
297
298
299
300
301
  if (!isset($info->help)) {
    $info->help = '';
  }
  if (!isset($info->min_word_count)) {
    $info->min_word_count = 0;
  }
  if (!isset($info->body_label)) {
    $info->body_label = '';
  }
302
303
304

  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);
305
306

    module_invoke_all('node_type', 'update', $info);
307
308
309
310
    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);
311
312

    module_invoke_all('node_type', 'insert', $info);
313
314
    return SAVED_NEW;
  }
315
}
316

317
318
319
320
321
322
323
324
325
326
327
328
329
/**
 * Deletes a node type from the database.
 *
 * @param $type
 *   The machine-readable name of the node type to be deleted.
 */
function node_type_delete($type) {
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);

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

330
/**
331
332
 * Updates all nodes of one type to be of another type.
 *
333
 * @param $old_type
334
335
336
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
337
338
 *
 * @return
339
 *   The number of nodes whose node type field was modified.
340
 */
341
342
343
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
344
}
Dries's avatar
   
Dries committed
345

346
/**
347
348
 * 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
349
350
 *
 */
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
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
412
}
Dries's avatar
   
Dries committed
413

414
/**
Dries's avatar
   
Dries committed
415
416
417
418
419
420
421
422
423
424
 * 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) {
425
426
427
428
429
  $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
430
431
}

432
/**
Dries's avatar
   
Dries committed
433
434
435
436
437
438
439
440
441
 * 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
442
 *   The returned value of the invoked hook.
Dries's avatar
   
Dries committed
443
444
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
445
  if (node_hook($node, $hook)) {
446
447
448
449
450
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
   
Dries committed
451
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
   
Dries committed
452
453
454
  }
}

Dries's avatar
   
Dries committed
455
456
457
458
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
   
Dries committed
459
 *   A node object.
Dries's avatar
   
Dries committed
460
461
462
463
464
465
466
 * @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
467
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
   
Dries committed
468
  $return = array();
469
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
   
Dries committed
470
    $function = $name .'_nodeapi';
471
    $result = $function($node, $op, $a3, $a4);
472
    if (isset($result) && is_array($result)) {
473
474
475
476
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
   
Dries committed
477
478
479
480
481
    }
  }
  return $return;
}

Dries's avatar
   
Dries committed
482
483
484
/**
 * Load a node object from the database.
 *
485
486
 * @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
487
488
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
   
Dries committed
489
490
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
   
Dries committed
491
492
493
494
 *
 * @return
 *   A fully-populated node object.
 */
495
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
   
Dries committed
496
497
498
499
500
501
  static $nodes = array();

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

502
  $cachable = ($revision == NULL);
503
  $arguments = array();
504
  if (is_numeric($param)) {
505
    if ($cachable && isset($nodes[$param])) {
506
      return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
507
    }
508
509
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
   
Dries committed
510
  }
511
512
  else {
    // Turn the conditions into a query.
513
    foreach ($param as $key => $value) {
514
515
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
516
517
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
   
Dries committed
518
519
  }

Dries's avatar
   
Dries committed
520
  // Retrieve the node.
521
  // No db_rewrite_sql is applied so as to get complete indexing for search.
522
  if ($revision) {
523
    array_unshift($arguments, $revision);
524
    $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
525
  }
526
  else {
527
    $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
528
529
  }

530
  if ($node && $node->nid) {
531
532
533
534
535
536
    // 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
537
538
    }

539
540
541
542
543
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
544
545
546
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
   
Dries committed
547
548
  }

Dries's avatar
   
Dries committed
549
550
551
  return $node;
}

Dries's avatar
   
Dries committed
552
553
554
/**
 * Save a node object into the database.
 */
555
function node_save(&$node) {
556
  global $user;
Dries's avatar
   
Dries committed
557

558
  $node->is_new = FALSE;
Dries's avatar
   
Dries committed
559

Dries's avatar
   
Dries committed
560
  // Apply filters to some default node fields:
Dries's avatar
   
Dries committed
561
  if (empty($node->nid)) {
Dries's avatar
   
Dries committed
562
    // Insert a new node.
563
    $node->is_new = TRUE;
Dries's avatar
   
Dries committed
564

Dries's avatar
   
Dries committed
565
    $node->nid = db_next_id('{node}_nid');
Steven Wittens's avatar
Steven Wittens committed
566
    $node->vid = db_next_id('{node_revisions}_vid');
567
568
569
570
571
572
  }
  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
573
    }
574
    $node = $node_current;
Dries's avatar
   
Dries committed
575

576
    if (!empty($node->revision)) {
577
578
579
      $node->old_vid = $node->vid;
      $node->vid = db_next_id('{node_revisions}_vid');
    }
Dries's avatar
   
Dries committed
580
581
  }

582
583
584
585
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
586
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
587
  $node->changed = time();
Dries's avatar
   
Dries committed
588

589
590
591
  // Split off revisions data to another structure
  $revisions_table_values = array('nid' => $node->nid, 'vid' => $node->vid,
                     'title' => $node->title, 'body' => $node->body,
592
                     'teaser' => $node->teaser, 'timestamp' => $node->changed,
593
594
595
                     'uid' => $user->uid, 'format' => $node->format);
  $revisions_table_types = array('nid' => '%d', 'vid' => '%d',
                     'title' => "'%s'", 'body' => "'%s'",
596
                     'teaser' => "'%s'", 'timestamp' => '%d',
597
                     'uid' => '%d', 'format' => '%d');
598
  if (!empty($node->log) || $node->is_new) {
599
600
601
    // Only store the log message if there's something to store; this prevents
    // existing log messages from being unintentionally overwritten by a blank
    // message. A new revision will have an empty log message (or $node->log).
602
603
604
    $revisions_table_values['log'] = $node->log;
    $revisions_table_types['log'] = "'%s'";
  }
605
606
607
608
  $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,
609
                    'promote' => $node->promote, 'sticky' => $node->sticky);
610
611
612
613
  $node_table_types = array('nid' => '%d', 'vid' => '%d',
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
                    'status' => '%d', 'created' => '%d',
                    'changed' => '%d', 'comment' => '%d',
614
                    'promote' => '%d', 'sticky' => '%d');
615
616
617
618
619
620
621
622
623
624
625
626
627
628

  //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';
629
    if (!empty($node->revision)) {
630
631
632
633
634
635
      $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
636
      }
637
638
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
Dries's avatar
   
Dries committed
639
    }
640
  }
Dries's avatar
   
Dries committed
641

642
643
644
  // 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
645

646
647
648
649
650
651
652
653
654
655
  // Call the node specific callback (if any):
  if ($node->is_new) {
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
  }
  else {
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
  }

656
657
658
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries's avatar
   
Dries committed
659
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
   
Dries committed
660
  cache_clear_all();
Dries's avatar
   
Dries committed
661
662
}

Dries's avatar
   
Dries committed
663
664
665
666
667
668
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
669
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
   
Dries committed
670
671
 * @param $page
 *   Whether the node is being displayed by itself as a page.
672
673
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
   
Dries committed
674
675
676
677
 *
 * @return
 *   An HTML representation of the themed node.
 */
678
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
679
  $node = (object)$node;
Dries's avatar
   
Dries committed
680

681
682
  $node = node_build_content($node, $teaser, $page);

683
684
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
685
    drupal_alter('link', $node->links, $node);
686
  }
687
688
689
690

  // Set the proper node part, then unset unused $node part so that a bad
  // theme can not open a security hole.
  $content = drupal_render($node->content);
691
  if ($teaser) {
692
    $node->teaser = $content;
693
694
695
    unset($node->body);
  }
  else {
696
    $node->body = $content;
697
698
    unset($node->teaser);
  }
Dries's avatar
   
Dries committed
699

700
701
702
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
   
Dries committed
703
  return theme('node', $node, $teaser, $page);
Dries's avatar
   
Dries committed
704
}
Dries's avatar
   
Dries committed
705

Dries's avatar
   
Dries committed
706
/**
707
 * Apply filters and build the node's standard elements.
Dries's avatar
   
Dries committed
708
 */
Dries's avatar
   
Dries committed
709
function node_prepare($node, $teaser = FALSE) {
710
711
712
  // First we'll overwrite the existing node teaser and body with
  // the filtered copies! Then, we'll stick those into the content
  // array and set the read more flag if appropriate.
713
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
714
715
716
717
718
719
720
721

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

722
  $node->content['body'] = array(
723
    '#value' => $teaser ? $node->teaser : $node->body,
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
    '#weight' => 0,
  );

  return $node;
}

/**
 * Builds a structured array representing the node's content.
 *
 * @param $node
 *   A node object.
 * @param $teaser
 *   Whether to display the teaser only, as on the main page.
 * @param $page
 *   Whether the node is being displayed by itself as a page.
 *
 * @return
 *   An structured array containing the individual elements
 *   of the node's body.
 */
function node_build_content($node, $teaser = FALSE, $page = FALSE) {
  // Remove the delimiter (if any) that separates the teaser from the body.
746
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
747
748
749
750
751

  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
  if (node_hook($node, 'view')) {
    $node = node_invoke($node, 'view', $teaser, $page);
Dries's avatar
   
Dries committed
752
753
  }
  else {
754
    $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
755
  }
756
757
758
759

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

Dries's avatar
   
Dries committed
760
  return $node;
Dries's avatar
   
Dries committed
761
762
}

Dries's avatar
   
Dries committed
763
764
765
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
   
Dries committed
766
function node_show($node, $cid) {
Dries's avatar
   
Dries committed
767
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
   
Dries committed
768

Dries's avatar
   
Dries committed
769
770
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
   
Dries committed
771
772
  }

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

Dries's avatar
   
Dries committed
776
  return $output;
Dries's avatar
   
Dries committed
777
778
}

Dries's avatar
   
Dries committed
779
780
781
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
782
function node_perm() {
783
784
785
786
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
787
      $name = check_plain($type->type);
788
789
790
791
792
793
794
      $perms[] = 'create '. $name .' content';
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
   
Dries committed
795
796
}

Dries's avatar
   
Dries committed
797
798
799
/**
 * Implementation of hook_search().
 */
800
function node_search($op = 'search', $keys = NULL) {
801
802
  switch ($op) {
    case 'name':
803
      return t('Content');
804

Dries's avatar
Dries committed
805
806
    case 'reset':
      variable_del('node_cron_last');
807
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
808
      return;
809

810
811
    case 'status':
      $last = variable_get('node_cron_last', 0);
812
      $last_nid = variable_get('node_cron_last_nid', 0);
813
814
      $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));
815
      return array('remaining' => $remaining, 'total' => $total);
816
817
818
819
820
821

    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';
822
      $form['content_ranking']['info'] = array('#value' => '<em>'. t('The following numbers control which properties the content search should favor when ordering the results. Higher numbers mean more influence, zero means the property is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') .'</em>');
823
824
825

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
826
      if (module_exists('comment')) {
827
828
        $ranking['node_rank_comments'] = t('Number of comments');
      }
829
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
830
831
832
833
834
835
836
837
838
839
        $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;

840
    case 'search':
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
      // 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
873
      $stats_join = FALSE;
874
      $total = 0;
875
876
877
878
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
879
        $total += $weight;
880
881
882
883
884
885
886
      }
      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';
887
        $stats_join = TRUE;
888
        $total += $weight;
889
      }
890
      if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
891
892
893
894
895
896
897
898
        // 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';
        }
899
        $total += $weight;
900
      }
901
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
902
903
904
905
906
907
          $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;
908
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
909
        $total += $weight;
910
      }
911
      $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') .' AS score';
912
913
914
915
916

      // 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
917
918
      $results = array();
      foreach ($find as $item) {
919
        // Build the node body.
920
        $node = node_load($item->sid);
921
922
        $node = node_build_content($node, FALSE, FALSE);
        $node->body = drupal_render($node->content);
923

924
925
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
926
927
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
928

Dries's avatar
Dries committed
929
        $extra = node_invoke_nodeapi($node, 'search result');
930
        $results[] = array('link' => url('node/'. $item->sid, array('absolute' => TRUE)),
931
                           'type' => node_get_types('name', $node),
932
                           'title' => $node->title,
933
                           'user' => theme('username', $node),
934
                           'date' => $node->changed,
935
                           'node' => $node,
Dries's avatar
Dries committed
936
                           'extra' => $extra,
937
                           'score' => $item->score / $total,
938
                           'snippet' => search_excerpt($keys, $node->body));
939
940
941
      }
      return $results;
  }
Dries's avatar
   
Dries committed
942
943
}

944
945
946
947
948
949
950
951
952
953
/**
 * 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);
  }
}

954
function theme_node_search_admin($form) {
955
  $output = drupal_render($form['info']);
956
957
958
959
960
961

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

967
  $output .= drupal_render($form);
968
969
970
  return $output;
}

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

980
981
982
983
984
    $form['access'] = array('#type' => 'fieldset', '#title' => t('Node access status'));
    $form['access']['status'] = array('#value' => $status);
    $form['access']['rebuild'] = array('#type' => 'submit', '#value' => t('Rebuild permissions'));
  }

drumm's avatar
drumm committed
985
  $form['default_nodes_main'] = array(
986
987
988
    '#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.')
989
  );
drumm's avatar
drumm committed
990
  $form['teaser_length'] = array(
991
992
    '#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'),
993
994
      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')),
995
    '#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.")
996
997
  );

drumm's avatar
drumm committed
998
  $form['node_preview'] = array(
999
1000
    '#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?')