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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
8
9
 */

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

Dries Buytaert's avatar
   
Dries Buytaert committed
12
13
14
15
/**
 * Implementation of hook_help().
 */
function node_help($section) {
16
  switch ($section) {
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
36
  }
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
80
81
82
/**
 * Implementation of hook_cron().
 */
83
function node_cron() {
Dries Buytaert's avatar
   
Dries Buytaert committed
84
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
85
86
}

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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')) : array());
Dries Buytaert's avatar
   
Dries Buytaert committed
101
102
  }

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

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

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
139
140
  }

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

/**
145
 * Decide on the type of marker to be displayed for a given node.
Dries Buytaert's avatar
   
Dries Buytaert committed
146
 *
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
153
 */
154
function node_mark($nid, $timestamp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
155
156
157
  global $user;
  static $cache;

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

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

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

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

202
  // Find where the delimiter is in the body
Steven Wittens's avatar
Steven Wittens committed
203
  $delimiter = strpos($body, '<!--break-->');
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
207
208
    return $body;
  }
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
339
340
 *
 * @return
341
 *   Status flag indicating outcome of the operation.
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
398
}
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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
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');
  }

452
453
454
455
456
457
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
458
459
460
461
462
463
464
465
466
467
468
469
470
471
  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 Buytaert's avatar
   
Dries Buytaert committed
472
}
Dries Buytaert's avatar
   
Dries Buytaert committed
473

474
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
475
476
477
478
479
480
481
482
483
484
 * 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) {
485
486
487
488
489
  $module = node_get_types('module', $node);
  if ($module == 'node') {
    $module = 'node_content'; // Avoid function name collisions.
  }
  return module_hook($module, $hook);
Dries Buytaert's avatar
   
Dries Buytaert committed
490
491
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
542
543
544
/**
 * Load a node object from the database.
 *
545
546
 * @param $param
 *   Either the nid of the node or an array of conditions to match against in the database query
Dries Buytaert's avatar
   
Dries Buytaert committed
547
548
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries Buytaert's avatar
   
Dries Buytaert committed
549
550
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries Buytaert's avatar
   
Dries Buytaert committed
551
552
553
554
 *
 * @return
 *   A fully-populated node object.
 */
555
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
556
557
558
559
560
561
  static $nodes = array();

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

562
  $cachable = ($revision == NULL);
563
  $arguments = array();
564
  if (is_numeric($param)) {
565
    if ($cachable && isset($nodes[$param])) {
566
      return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
567
    }
568
569
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries Buytaert's avatar
   
Dries Buytaert committed
570
  }
571
  elseif (is_array($param)) {
572
    // Turn the conditions into a query.
573
    foreach ($param as $key => $value) {
574
575
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
576
577
    }
    $cond = implode(' AND ', $cond);
Dries Buytaert's avatar
   
Dries Buytaert committed
578
  }
579
580
581
  else {
    return FALSE;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
582

Dries Buytaert's avatar
   
Dries Buytaert committed
583
  // Retrieve the node.
584
  // No db_rewrite_sql is applied so as to get complete indexing for search.
585
  if ($revision) {
586
    array_unshift($arguments, $revision);
587
    $node = db_fetch_object(db_query('SELECT n.nid, r.vid, n.type, n.status, n.language, n.created, n.changed, n.comment, n.promote, n.sticky, n.tnid, n.translate, 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 Buytaert's avatar
   
Dries Buytaert committed
588
  }
589
  else {
590
    $node = db_fetch_object(db_query('SELECT n.nid, n.vid, n.type, n.status, n.language, n.created, n.changed, n.comment, n.promote, n.sticky, n.tnid, n.translate, 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 Buytaert's avatar
   
Dries Buytaert committed
591
592
  }

593
  if ($node && $node->nid) {
594
595
596
597
598
599
    // 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 Buytaert's avatar
   
Dries Buytaert committed
600
601
    }

602
603
604
605
606
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
607
608
609
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
610
611
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
612
613
614
  return $node;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
615
616
617
/**
 * Save a node object into the database.
 */
618
function node_save(&$node) {
619
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
620

621
  $node->is_new = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
622

Dries Buytaert's avatar
   
Dries Buytaert committed
623
  // Apply filters to some default node fields:
Dries Buytaert's avatar
   
Dries Buytaert committed
624
  if (empty($node->nid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
625
    // Insert a new node.
626
    $node->is_new = TRUE;
627
628
629
630
631
632
  }
  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 Buytaert's avatar
   
Dries Buytaert committed
633
    }
634
    $node = $node_current;
Dries Buytaert's avatar
   
Dries Buytaert committed
635

636
    if (!empty($node->revision)) {
637
638
      $node->old_vid = $node->vid;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
639
640
  }

641
642
643
644
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
645
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
646
  $node->changed = time();
Dries Buytaert's avatar
   
Dries Buytaert committed
647

648
  // Split off revisions data to another structure
649
  $revisions_table_values = array('nid' => &$node->nid,
650
                     'title' => $node->title, 'body' => $node->body,
651
                     'teaser' => $node->teaser, 'timestamp' => $node->changed,
652
                     'uid' => $user->uid, 'format' => $node->format);
653
  $revisions_table_types = array('nid' => '%d',
654
                     'title' => "'%s'", 'body' => "'%s'",
655
                     'teaser' => "'%s'", 'timestamp' => '%d',
656
                     'uid' => '%d', 'format' => '%d');
657
  if (!empty($node->log) || $node->is_new || $node->revision) {
658
659
660
    // 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).
661
662
663
    $revisions_table_values['log'] = $node->log;
    $revisions_table_types['log'] = "'%s'";
  }
664
  $node_table_values = array(
665
                    'title' => $node->title, 'type' => $node->type, 'uid' => $node->uid,
666
                    'status' => $node->status, 'language' => $node->language, 'created' => $node->created,
667
                    'changed' => $node->changed, 'comment' => $node->comment,
668
                    'promote' => $node->promote, 'sticky' => $node->sticky);
669
  $node_table_types = array(
670
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
671
                    'status' => '%d', 'language' => "'%s'",'created' => '%d',
672
                    'changed' => '%d', 'comment' => '%d',
673
                    'promote' => '%d', 'sticky' => '%d');
674
  $update_node = TRUE;
675
676
677
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
678
679
680
    $node_query = 'INSERT INTO {node} (vid, '. implode(', ', array_keys($node_table_types)) .') VALUES (NULL, '. implode(', ', $node_table_types) .')';
    db_query($node_query, $node_table_values);
    $node->nid = db_last_insert_id('node', 'nid');
681
    $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
682
683
684
    db_query($revisions_query, $revisions_table_values);
    $node->vid = db_last_insert_id('node_revisions', 'vid');
    $op = 'insert';
685
686
687
688
689
690
691
692
  }
  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';
693
    db_query($node_query, $node_table_values);
694
    if (!empty($node->revision)) {
695
      $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
696
697
      db_query($revisions_query, $revisions_table_values);
      $node->vid = db_last_insert_id('node_revisions', 'vid');
698
699
700
701
702
    }
    else {
      $arr = array();
      foreach ($revisions_table_types as $key => $value) {
        $arr[] = $key .' = '. $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
703
      }
704
705
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
706
707
      db_query($revisions_query, $revisions_table_values);
      $update_node = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
708
    }
709
    $op = 'update';
710
  }
711
  if ($update_node) {
712
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
713
714
  }

715
716
717
718
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

719
720
721
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries Buytaert's avatar
   
Dries Buytaert committed
722
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries Buytaert's avatar
   
Dries Buytaert committed
723
  cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
724
725
}

Dries Buytaert's avatar
   
Dries Buytaert committed
726
727
728
729
730
731
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
732
 *   Whether to display the teaser only, as on the main page.
Dries Buytaert's avatar
   
Dries Buytaert committed
733
734
 * @param $page
 *   Whether the node is being displayed by itself as a page.
735
736
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries Buytaert's avatar
   
Dries Buytaert committed
737
738
739
740
 *
 * @return
 *   An HTML representation of the themed node.
 */
741
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
742
  $node = (object)$node;
Dries Buytaert's avatar
   
Dries Buytaert committed
743

744
745
  $node = node_build_content($node, $teaser, $page);

746
747
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
748
    drupal_alter('link', $node->links, $node);
749
  }
750
751
752
753

  // 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);
754
  if ($teaser) {
755
    $node->teaser = $content;
756
757
758
    unset($node->body);
  }
  else {
759
    $node->body = $content;
760
761
    unset($node->teaser);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
762

763
764
765
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries Buytaert's avatar
   
Dries Buytaert committed
766
  return theme('node', $node, $teaser, $page);
Dries Buytaert's avatar
   
Dries Buytaert committed
767
}
Dries Buytaert's avatar
   
Dries Buytaert committed
768

Dries Buytaert's avatar
   
Dries Buytaert committed
769
/**
770
 * Apply filters and build the node's standard elements.
Dries Buytaert's avatar
   
Dries Buytaert committed
771
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
772
function node_prepare($node, $teaser = FALSE) {
773
774
775
  // 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.
776
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
777
778
779
780
781
782
783
784

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

785
  $node->content['body'] = array(
786
    '#value' => $teaser ? $node->teaser : $node->body,
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
    '#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.
809
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
810
811
812
813
814

  // 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 Buytaert's avatar
   
Dries Buytaert committed
815
816
  }
  else {
817
    $node = node_prepare($node, $teaser);
Dries Buytaert's avatar
   
Dries Buytaert committed
818
  }
819
820
821
822

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

Dries Buytaert's avatar
   
Dries Buytaert committed
823
  return $node;
Dries Buytaert's avatar
   
Dries Buytaert committed
824
825
}

Dries Buytaert's avatar
   
Dries Buytaert committed
826
827
828
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
829
function node_show($node, $cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
830
  $output = node_view($node, FALSE, TRUE);
Dries Buytaert's avatar
   
Dries Buytaert committed
831

Dries Buytaert's avatar
   
Dries Buytaert committed
832
833
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries Buytaert's avatar
   
Dries Buytaert committed
834
835
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
836
837
  // Update the history table, stating that this user viewed this node.
  node_tag_new($node->nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
838

Dries Buytaert's avatar
   
Dries Buytaert committed
839
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
840
841
}

Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
844
/**
 * Implementation of hook_perm().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
845
function node_perm() {
846
847
848
849
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
850
      $name = check_plain($type->type);
851
      $perms[] = 'create '. $name .' content';
852
853
      $perms[] = 'delete own '. $name .' content';
      $perms[] = 'delete '. $name .' content';
854
855
856
857
858
859
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries Buytaert's avatar
   
Dries Buytaert committed
860
861
}

Dries Buytaert's avatar
   
Dries Buytaert committed
862
863
864
/**
 * Implementation of hook_search().
 */
865
function node_search($op = 'search', $keys = NULL) {
866
867
  switch ($op) {
    case 'name':
868
      return t('Content');
869

Dries Buytaert's avatar
Dries Buytaert committed
870
871
    case 'reset':
      variable_del('node_cron_last');
872
      variable_del('node_cron_last_nid');
Dries Buytaert's avatar
Dries Buytaert committed
873
      return;
874

875
876
    case 'status':
      $last = variable_get('node_cron_last', 0);
877
      $last_nid = variable_get('node_cron_last_nid', 0);
878
879
      $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));
880
      return array('remaining' => $remaining, 'total' => $total);
881
882
883
884
885
886

    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';
887
      $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>');
888
889
890

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
891
      if (module_exists('comment')) {
892
893
        $ranking['node_rank_comments'] = t('Number of comments');
      }
894
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
895
896
897
898
899
900
901
902
903
904
        $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;

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

      // 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
982
983
      $results = array();
      foreach ($find as $item) {
984
        // Build the node body.
985
        $node = node_load($item->sid);
986
987
        $node = node_build_content($node, FALSE, FALSE);
        $node->body = drupal_render($node->content);
988

989
990
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
991
992
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
993

994
        $extra = node_invoke_nodeapi($node, 'search result');
995
        $results[] = array('link' => url('node/'. $item->sid, array('absolute' => TRUE)),
996
                           'type' => node_get_types('name', $node),
997
                           'title' => $node->title,
998
                           'user' => theme('username', $node),
999
                           'date' => $node->changed,
1000
                           'node' => $node,
For faster browsing, not all history is shown. View entire blame