node.module 105 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
}

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
 * Implementation of hook_theme()
 */
function node_theme() {
  return array(
    'node_list' => array(
      'arguments' => array('items' => NULL, 'title' => NULL),
    ),
    'node_search_admin' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_filter_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
  );
}

Dries's avatar
   
Dries committed
80
81
82
/**
 * Implementation of hook_cron().
 */
83
function node_cron() {
Dries's avatar
   
Dries committed
84
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
85
86
}

Dries's avatar
   
Dries committed
87
88
89
90
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
91
 *   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
92
93
94
95
96
97
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
 *   An HTML list suitable as content for a block.
 */
Dries's avatar
   
Dries committed
98
99
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
100
    $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
101
102
  }

Dries's avatar
   
Dries committed
103
  return theme('node_list', $items, $title);
Dries's avatar
   
Dries committed
104
105
}

Dries's avatar
   
Dries committed
106
107
108
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
   
Dries committed
109
function theme_node_list($items, $title = NULL) {
Dries's avatar
   
Dries committed
110
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
111
112
}

Dries's avatar
   
Dries committed
113
114
115
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
   
Dries committed
116
117
118
119
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
   
Dries committed
120
    if (node_last_viewed($nid)) {
Dries's avatar
   
Dries committed
121
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
   
Dries committed
122
123
    }
    else {
Dries's avatar
   
Dries committed
124
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
   
Dries committed
125
126
127
128
    }
  }
}

Dries's avatar
   
Dries committed
129
130
131
132
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
   
Dries committed
133
134
function node_last_viewed($nid) {
  global $user;
Dries's avatar
   
Dries committed
135
  static $history;
Dries's avatar
   
Dries committed
136

Dries's avatar
   
Dries committed
137
  if (!isset($history[$nid])) {
138
    $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
139
140
  }

141
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
   
Dries committed
142
143
144
}

/**
145
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
   
Dries committed
146
 *
Dries's avatar
   
Dries committed
147
148
149
150
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
151
152
 * @return
 *   One of the MARK constants.
Dries's avatar
   
Dries committed
153
 */
154
function node_mark($nid, $timestamp) {
Dries's avatar
   
Dries committed
155
156
157
  global $user;
  static $cache;

158
159
160
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
161
  if (!isset($cache[$nid])) {
162
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
   
Dries committed
163
  }
164
165
166
167
168
169
170
  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
171
172
}

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/**
 * See if the user used JS to submit a teaser.
 */
function node_teaser_js(&$form, $form_values) {
  // Glue the teaser to the body.
  if (isset($form['#post']['teaser_js'])) {
    if (trim($form_values['teaser_js'])) {
      // Space the teaser from the body
      $body = trim($form_values['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_values['body']);
    }
    else {
      // Empty teaser, no spaces.
      $body = '<!--break-->'. $form_values['body'];
    }
    // Pass value onto preview/submit
    form_set_value($form['body'], $body);
    // Pass value back onto form
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries's avatar
   
Dries committed
195
/**
196
 * Automatically generate a teaser for a node body in a given format.
Dries's avatar
   
Dries committed
197
 */
198
function node_teaser($body, $format = NULL) {
Dries's avatar
   
Dries committed
199

Dries's avatar
   
Dries committed
200
  $size = variable_get('teaser_length', 600);
Dries's avatar
   
Dries committed
201

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

205
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
206
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
   
Dries committed
207
208
    return $body;
  }
Dries's avatar
   
Dries committed
209

210
211
212
213
214
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

215
216
217
218
219
  // 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);
220
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
221
222
      return $body;
    }
223
224
  }

225
  // If we have a short body, the entire body is the teaser.
Dries's avatar
   
Dries committed
226
227
228
229
  if (strlen($body) < $size) {
    return $body;
  }

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  // 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);
245
    }
246
  }
Dries's avatar
Dries committed
247

248
249
250
251
252
253
254
255
256
257
258
259
  // 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
260
261
}

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/**
 * 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;
283

284
285
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
286
  }
287

288
289
290
291
292
293
294
295
296
297
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
298
    if (!isset($_node_types[$type])) {
299
300
301
302
      return FALSE;
    }
  }
  switch ($op) {
303
304
305
306
307
308
309
310
    case 'types':
      return $_node_types;
    case 'type':
      return $_node_types[$type];
    case 'module':
      return $_node_types[$type]->module;
    case 'names':
      return $_node_names;
311
    case 'name':
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
      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);
    }
329
  }
330
331

  _node_types_build();
332
333
}

334
/**
335
336
337
338
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
   
Dries committed
339
340
 *
 * @return
341
 *   Status flag indicating outcome of the operation.
Dries's avatar
   
Dries committed
342
 */
343
344
345
346
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));
347
348
349
350
351
352
353
354
355
  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 = '';
  }
356
357
358

  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);
359
360

    module_invoke_all('node_type', 'update', $info);
361
362
363
364
    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);
365
366

    module_invoke_all('node_type', 'insert', $info);
367
368
    return SAVED_NEW;
  }
369
}
370

371
372
373
374
375
376
377
378
379
380
381
382
383
/**
 * 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);
}

384
/**
385
386
 * Updates all nodes of one type to be of another type.
 *
387
 * @param $old_type
388
389
390
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
391
392
 *
 * @return
393
 *   The number of nodes whose node type field was modified.
394
 */
395
396
397
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
398
}
Dries's avatar
   
Dries committed
399

400
/**
401
402
 * 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
403
404
 *
 */
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
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
466
}
Dries's avatar
   
Dries committed
467

468
/**
Dries's avatar
   
Dries committed
469
470
471
472
473
474
475
476
477
478
 * 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) {
479
480
481
482
483
  $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
484
485
}

486
/**
Dries's avatar
   
Dries committed
487
488
489
490
491
492
493
494
495
 * 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
496
 *   The returned value of the invoked hook.
Dries's avatar
   
Dries committed
497
498
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
499
  if (node_hook($node, $hook)) {
500
501
502
503
504
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
   
Dries committed
505
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
   
Dries committed
506
507
508
  }
}

Dries's avatar
   
Dries committed
509
510
511
512
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
   
Dries committed
513
 *   A node object.
Dries's avatar
   
Dries committed
514
515
516
517
518
519
520
 * @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
521
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
   
Dries committed
522
  $return = array();
523
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
   
Dries committed
524
    $function = $name .'_nodeapi';
525
    $result = $function($node, $op, $a3, $a4);
526
    if (isset($result) && is_array($result)) {
527
528
529
530
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
   
Dries committed
531
532
533
534
535
    }
  }
  return $return;
}

Dries's avatar
   
Dries committed
536
537
538
/**
 * Load a node object from the database.
 *
539
540
 * @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
541
542
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
   
Dries committed
543
544
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
   
Dries committed
545
546
547
548
 *
 * @return
 *   A fully-populated node object.
 */
549
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
   
Dries committed
550
551
552
553
554
555
  static $nodes = array();

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

556
  $cachable = ($revision == NULL);
557
  $arguments = array();
558
  if (is_numeric($param)) {
559
    if ($cachable && isset($nodes[$param])) {
560
      return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
561
    }
562
563
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
   
Dries committed
564
  }
565
566
  else {
    // Turn the conditions into a query.
567
    foreach ($param as $key => $value) {
568
569
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
570
571
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
   
Dries committed
572
573
  }

Dries's avatar
   
Dries committed
574
  // Retrieve the node.
575
  // No db_rewrite_sql is applied so as to get complete indexing for search.
576
  if ($revision) {
577
    array_unshift($arguments, $revision);
578
    $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
579
  }
580
  else {
581
    $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
582
583
  }

584
  if ($node && $node->nid) {
585
586
587
588
589
590
    // 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
591
592
    }

593
594
595
596
597
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
598
599
600
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
   
Dries committed
601
602
  }

Dries's avatar
   
Dries committed
603
604
605
  return $node;
}

Dries's avatar
   
Dries committed
606
607
608
/**
 * Save a node object into the database.
 */
609
function node_save(&$node) {
610
  global $user;
Dries's avatar
   
Dries committed
611

612
  $node->is_new = FALSE;
Dries's avatar
   
Dries committed
613

Dries's avatar
   
Dries committed
614
  // Apply filters to some default node fields:
Dries's avatar
   
Dries committed
615
  if (empty($node->nid)) {
Dries's avatar
   
Dries committed
616
    // Insert a new node.
617
    $node->is_new = TRUE;
Dries's avatar
   
Dries committed
618

Dries's avatar
   
Dries committed
619
    $node->nid = db_next_id('{node}_nid');
Steven Wittens's avatar
Steven Wittens committed
620
    $node->vid = db_next_id('{node_revisions}_vid');
621
622
623
624
625
626
  }
  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
627
    }
628
    $node = $node_current;
Dries's avatar
   
Dries committed
629

630
    if (!empty($node->revision)) {
631
632
633
      $node->old_vid = $node->vid;
      $node->vid = db_next_id('{node_revisions}_vid');
    }
Dries's avatar
   
Dries committed
634
635
  }

636
637
638
639
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
640
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
641
  $node->changed = time();
Dries's avatar
   
Dries committed
642

643
644
645
  // Split off revisions data to another structure
  $revisions_table_values = array('nid' => $node->nid, 'vid' => $node->vid,
                     'title' => $node->title, 'body' => $node->body,
646
                     'teaser' => $node->teaser, 'timestamp' => $node->changed,
647
648
649
                     'uid' => $user->uid, 'format' => $node->format);
  $revisions_table_types = array('nid' => '%d', 'vid' => '%d',
                     'title' => "'%s'", 'body' => "'%s'",
650
                     'teaser' => "'%s'", 'timestamp' => '%d',
651
                     'uid' => '%d', 'format' => '%d');
652
  if (!empty($node->log) || $node->is_new || $node->revision) {
653
654
655
    // 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).
656
657
658
    $revisions_table_values['log'] = $node->log;
    $revisions_table_types['log'] = "'%s'";
  }
659
660
661
662
  $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,
663
                    'promote' => $node->promote, 'sticky' => $node->sticky);
664
665
666
667
  $node_table_types = array('nid' => '%d', 'vid' => '%d',
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
                    'status' => '%d', 'created' => '%d',
                    'changed' => '%d', 'comment' => '%d',
668
                    'promote' => '%d', 'sticky' => '%d');
669
670
671
672
673
674
675
676
677
678
679
680
681
682

  //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';
683
    if (!empty($node->revision)) {
684
685
686
687
688
689
      $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
690
      }
691
692
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
Dries's avatar
   
Dries committed
693
    }
694
  }
Dries's avatar
   
Dries committed
695

696
697
698
  // 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
699

700
701
702
703
704
705
706
707
708
709
  // 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');
  }

710
711
712
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries's avatar
   
Dries committed
713
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
   
Dries committed
714
  cache_clear_all();
Dries's avatar
   
Dries committed
715
716
}

Dries's avatar
   
Dries committed
717
718
719
720
721
722
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
723
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
   
Dries committed
724
725
 * @param $page
 *   Whether the node is being displayed by itself as a page.
726
727
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
   
Dries committed
728
729
730
731
 *
 * @return
 *   An HTML representation of the themed node.
 */
732
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
733
  $node = (object)$node;
Dries's avatar
   
Dries committed
734

735
736
  $node = node_build_content($node, $teaser, $page);

737
738
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
739
    drupal_alter('link', $node->links, $node);
740
  }
741
742
743
744

  // 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);
745
  if ($teaser) {
746
    $node->teaser = $content;
747
748
749
    unset($node->body);
  }
  else {
750
    $node->body = $content;
751
752
    unset($node->teaser);
  }
Dries's avatar
   
Dries committed
753

754
755
756
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
   
Dries committed
757
  return theme('node', $node, $teaser, $page);
Dries's avatar
   
Dries committed
758
}
Dries's avatar
   
Dries committed
759

Dries's avatar
   
Dries committed
760
/**
761
 * Apply filters and build the node's standard elements.
Dries's avatar
   
Dries committed
762
 */
Dries's avatar
   
Dries committed
763
function node_prepare($node, $teaser = FALSE) {
764
765
766
  // 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.
767
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
768
769
770
771
772
773
774
775

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

776
  $node->content['body'] = array(
777
    '#value' => $teaser ? $node->teaser : $node->body,
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
    '#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.
800
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
801
802
803
804
805

  // 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
806
807
  }
  else {
808
    $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
809
  }
810
811
812
813

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

Dries's avatar
   
Dries committed
814
  return $node;
Dries's avatar
   
Dries committed
815
816
}

Dries's avatar
   
Dries committed
817
818
819
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
   
Dries committed
820
function node_show($node, $cid) {
Dries's avatar
   
Dries committed
821
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
   
Dries committed
822

Dries's avatar
   
Dries committed
823
824
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
   
Dries committed
825
826
  }

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

Dries's avatar
   
Dries committed
830
  return $output;
Dries's avatar
   
Dries committed
831
832
}

Dries's avatar
   
Dries committed
833
834
835
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
836
function node_perm() {
837
838
839
840
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
841
      $name = check_plain($type->type);
842
843
844
845
846
847
848
      $perms[] = 'create '. $name .' content';
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
   
Dries committed
849
850
}

Dries's avatar
   
Dries committed
851
852
853
/**
 * Implementation of hook_search().
 */
854
function node_search($op = 'search', $keys = NULL) {
855
856
  switch ($op) {
    case 'name':
857
      return t('Content');
858

Dries's avatar
Dries committed
859
860
    case 'reset':
      variable_del('node_cron_last');
861
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
862
      return;
863

864
865
    case 'status':
      $last = variable_get('node_cron_last', 0);
866
      $last_nid = variable_get('node_cron_last_nid', 0);
867
868
      $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));
869
      return array('remaining' => $remaining, 'total' => $total);
870
871
872
873
874
875

    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';
876
      $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>');
877
878
879

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
880
      if (module_exists('comment')) {
881
882
        $ranking['node_rank_comments'] = t('Number of comments');
      }
883
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
884
885
886
887
888
889
890
891
892
893
        $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;

894
    case 'search':
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
      // 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
927
      $stats_join = FALSE;
928
      $total = 0;
929
930
931
932
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
933
        $total += $weight;
934
935
936
937
938
939
940
      }
      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';
941
        $stats_join = TRUE;
942
        $total += $weight;
943
      }
944
      if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
945
946
947
948
949
950
951
952
        // 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';
        }
953
        $total += $weight;
954
      }
955
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
956
957
958
959
960
961
          $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;
962
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
963
        $total += $weight;
964
      }
965
      $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') .' AS score';
966
967
968
969
970

      // 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
971
972
      $results = array();
      foreach ($find as $item) {
973
        // Build the node body.
974
        $node = node_load($item->sid);
975
976
        $node = node_build_content($node, FALSE, FALSE);
        $node->body = drupal_render($node->content);
977

978
979
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
980
981
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
982

Dries's avatar
Dries committed
983
        $extra = node_invoke_nodeapi($node, 'search result');
984
        $results[] = array('link' => url('node/'. $item->sid, array('absolute' => TRUE)),
985
                           'type' => node_get_types('name', $node),
986
                           'title' => $node->title,
987
                           'user' => theme('username', $node),
988
                           'date' => $node->changed,
989
                           'node' => $node,
Dries's avatar
Dries committed
990
                           'extra' => $extra,
991
                           'score' => $item->score / $total,
992
                           'snippet' => search_excerpt($keys, $node->body));
993
994
995
      }
      return $results;
  }
Dries's avatar
   
Dries committed
996
997
}

998
999
1000
/**
 * Implementation of hook_user().
 */