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

12
13
14
15
16
17
define('NODE_BUILD_NORMAL', 0);
define('NODE_BUILD_PREVIEW', 1);
define('NODE_BUILD_SEARCH_INDEX', 2);
define('NODE_BUILD_SEARCH_RESULT', 3);
define('NODE_BUILD_RSS', 4);

Dries Buytaert's avatar
   
Dries Buytaert committed
18
19
20
/**
 * Implementation of hook_help().
 */
21
22
function node_help($path, $arg) {
  switch ($path) {
Dries Buytaert's avatar
   
Dries Buytaert committed
23
    case 'admin/help#node':
24
25
26
27
28
29
30
31
32
33
      $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>
');
34
      $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
35
      return $output;
36
37
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
38
    case 'admin/content/search':
39
      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>';
40
41
42
    case 'admin/content/types':
      return '<p>'. t('Below is a list of all the content types on your site. All posts that exist on your site are instances of one of these content types.') .'</p>';
    case 'admin/content/types/add':
43
      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>';
44
45
46
47
48
49
    case 'node/%/revisions':
      return '<p>'. t('The revisions let you track differences between multiple versions of a post.') .'</p>';
    case 'node/%/edit':
      $node = node_load($arg[1]);
      $type = node_get_types('type', $node->type);
      return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
Dries Buytaert's avatar
   
Dries Buytaert committed
50
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
51

52
53
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
    $type = node_get_types('type', str_replace('-', '_', $arg[2]));
54
    return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
55
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
56
57
}

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/**
 * 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
90
91
92
/**
 * Implementation of hook_cron().
 */
93
function node_cron() {
Dries Buytaert's avatar
   
Dries Buytaert committed
94
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
95
96
}

Dries Buytaert's avatar
   
Dries Buytaert committed
97
98
99
100
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
101
 *   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
102
103
104
105
106
107
 * @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
108
109
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
110
    $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
111
112
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
113
  return theme('node_list', $items, $title);
Dries Buytaert's avatar
   
Dries Buytaert committed
114
115
}

Dries Buytaert's avatar
   
Dries Buytaert committed
116
117
118
/**
 * Format a listing of links to nodes.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
119
function theme_node_list($items, $title = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
120
  return theme('item_list', $items, $title);
Dries Buytaert's avatar
   
Dries Buytaert committed
121
122
}

Dries Buytaert's avatar
   
Dries Buytaert committed
123
124
125
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
126
127
128
129
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
130
    if (node_last_viewed($nid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
131
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
132
133
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
134
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries Buytaert's avatar
   
Dries Buytaert committed
135
136
137
138
    }
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
139
140
141
142
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
143
144
function node_last_viewed($nid) {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
145
  static $history;
Dries Buytaert's avatar
   
Dries Buytaert committed
146

Dries Buytaert's avatar
   
Dries Buytaert committed
147
  if (!isset($history[$nid])) {
148
    $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
149
150
  }

151
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries Buytaert's avatar
   
Dries Buytaert committed
152
153
154
}

/**
155
 * Decide on the type of marker to be displayed for a given node.
Dries Buytaert's avatar
   
Dries Buytaert committed
156
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
157
158
159
160
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
161
162
 * @return
 *   One of the MARK constants.
Dries Buytaert's avatar
   
Dries Buytaert committed
163
 */
164
function node_mark($nid, $timestamp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
165
166
167
  global $user;
  static $cache;

168
169
170
  if (!$user->uid) {
    return MARK_READ;
  }
Dries Buytaert's avatar
Dries Buytaert committed
171
  if (!isset($cache[$nid])) {
172
    $cache[$nid] = node_last_viewed($nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
173
  }
174
175
176
177
178
179
180
  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
181
182
}

183
184
185
/**
 * See if the user used JS to submit a teaser.
 */
186
function node_teaser_js(&$form, &$form_state) {
187
188
  // Glue the teaser to the body.
  if (isset($form['#post']['teaser_js'])) {
189
    if (trim($form_state['values']['teaser_js'])) {
190
      // Space the teaser from the body
191
      $body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
192
193
194
    }
    else {
      // Empty teaser, no spaces.
195
      $body = '<!--break-->'. $form_state['values']['body'];
196
197
    }
    // Pass value onto preview/submit
198
    form_set_value($form['body'], $body, $form_state);
199
200
201
202
203
204
    // Pass value back onto form
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
205
/**
206
 * Automatically generate a teaser for a node body in a given format.
Dries Buytaert's avatar
   
Dries Buytaert committed
207
 */
208
function node_teaser($body, $format = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
209

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

212
  // Find where the delimiter is in the body
Steven Wittens's avatar
Steven Wittens committed
213
  $delimiter = strpos($body, '<!--break-->');
Dries Buytaert's avatar
   
Dries Buytaert committed
214

215
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
216
  if ($size == 0 && $delimiter === FALSE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
217
218
    return $body;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
219

220
221
222
223
224
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

225
226
227
228
229
  // 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);
230
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
231
232
      return $body;
    }
233
234
  }

235
  // If we have a short body, the entire body is the teaser.
Dries Buytaert's avatar
   
Dries Buytaert committed
236
237
238
239
  if (strlen($body) < $size) {
    return $body;
  }

240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
  // 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);
255
    }
256
  }
Dries Buytaert's avatar
Dries Buytaert committed
257

258
259
260
261
262
263
264
265
266
267
268
269
  // 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
270
271
}

272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/**
 * 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;
293

294
295
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
296
  }
297

298
299
300
301
302
303
304
305
306
307
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
308
    if (!isset($_node_types[$type])) {
309
310
311
312
      return FALSE;
    }
  }
  switch ($op) {
313
314
315
316
317
318
319
320
    case 'types':
      return $_node_types;
    case 'type':
      return $_node_types[$type];
    case 'module':
      return $_node_types[$type]->module;
    case 'names':
      return $_node_names;
321
    case 'name':
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
      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);
    }
339
  }
340
341

  _node_types_build();
342
343
}

344
/**
345
346
347
348
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries Buytaert's avatar
   
Dries Buytaert committed
349
350
 *
 * @return
351
 *   Status flag indicating outcome of the operation.
Dries Buytaert's avatar
   
Dries Buytaert committed
352
 */
353
354
355
356
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));
357
358
359
360
361
362
363
364
365
  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 = '';
  }
366
367
368

  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);
369
370

    module_invoke_all('node_type', 'update', $info);
371
372
373
374
    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);
375
376

    module_invoke_all('node_type', 'insert', $info);
377
378
    return SAVED_NEW;
  }
379
}
380

381
382
383
384
385
386
387
388
389
390
391
392
393
/**
 * 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);
}

394
/**
395
396
 * Updates all nodes of one type to be of another type.
 *
397
 * @param $old_type
398
399
400
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
401
402
 *
 * @return
403
 *   The number of nodes whose node type field was modified.
404
 */
405
406
407
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
408
}
Dries Buytaert's avatar
   
Dries Buytaert committed
409

410
/**
411
412
 * 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
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
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');
  }

462
463
464
465
466
467
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
468
469
470
471
472
473
474
475
476
477
478
479
480
481
  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
482
}
Dries Buytaert's avatar
   
Dries Buytaert committed
483

484
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
485
486
487
488
489
490
491
492
493
494
 * 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) {
495
496
497
498
499
  $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
500
501
}

502
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
503
504
505
506
507
508
509
510
511
 * 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
512
 *   The returned value of the invoked hook.
Dries Buytaert's avatar
   
Dries Buytaert committed
513
514
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
515
  if (node_hook($node, $hook)) {
516
517
518
519
520
    $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
521
    return ($function($node, $a2, $a3, $a4));
Dries Buytaert's avatar
   
Dries Buytaert committed
522
523
524
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
525
526
527
528
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries Buytaert's avatar
   
Dries Buytaert committed
529
 *   A node object.
Dries Buytaert's avatar
   
Dries Buytaert committed
530
531
532
533
534
535
536
 * @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
537
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
538
  $return = array();
539
  foreach (module_implements('nodeapi') as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
540
    $function = $name .'_nodeapi';
541
    $result = $function($node, $op, $a3, $a4);
542
    if (isset($result) && is_array($result)) {
543
544
545
546
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries Buytaert's avatar
   
Dries Buytaert committed
547
548
549
550
551
    }
  }
  return $return;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
552
553
554
/**
 * Load a node object from the database.
 *
555
556
 * @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
557
558
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries Buytaert's avatar
   
Dries Buytaert committed
559
560
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries Buytaert's avatar
   
Dries Buytaert committed
561
562
563
564
 *
 * @return
 *   A fully-populated node object.
 */
565
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
566
567
568
569
570
571
  static $nodes = array();

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

572
  $cachable = ($revision == NULL);
573
  $arguments = array();
574
  if (is_numeric($param)) {
575
    if ($cachable && isset($nodes[$param])) {
576
      return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
577
    }
578
579
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries Buytaert's avatar
   
Dries Buytaert committed
580
  }
581
  elseif (is_array($param)) {
582
    // Turn the conditions into a query.
583
    foreach ($param as $key => $value) {
584
585
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
586
587
    }
    $cond = implode(' AND ', $cond);
Dries Buytaert's avatar
   
Dries Buytaert committed
588
  }
589
590
591
  else {
    return FALSE;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
592

Dries Buytaert's avatar
   
Dries Buytaert committed
593
  // Retrieve the node.
594
  // No db_rewrite_sql is applied so as to get complete indexing for search.
595
  if ($revision) {
596
    array_unshift($arguments, $revision);
597
    $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
598
  }
599
  else {
600
    $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
601
602
  }

603
  if ($node && $node->nid) {
604
605
606
607
608
609
    // 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
610
611
    }

612
613
614
615
616
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
617
618
619
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
620
621
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
622
623
624
  return $node;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
625
626
627
/**
 * Save a node object into the database.
 */
628
function node_save(&$node) {
629
630
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
631
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
632

633
  $node->is_new = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
634

Dries Buytaert's avatar
   
Dries Buytaert committed
635
  // Apply filters to some default node fields:
Dries Buytaert's avatar
   
Dries Buytaert committed
636
  if (empty($node->nid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
637
    // Insert a new node.
638
    $node->is_new = TRUE;
639
640
641
642
643
644
  }
  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
645
    }
646
    $node = $node_current;
Dries Buytaert's avatar
   
Dries Buytaert committed
647

648
    if (!empty($node->revision)) {
649
650
      $node->old_vid = $node->vid;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
651
652
  }

653
654
655
656
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
657
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
658
  $node->changed = time();
Dries Buytaert's avatar
   
Dries Buytaert committed
659

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

727
728
729
730
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

731
732
733
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries Buytaert's avatar
   
Dries Buytaert committed
734
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries Buytaert's avatar
   
Dries Buytaert committed
735
  cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
736
737
}

Dries Buytaert's avatar
   
Dries Buytaert committed
738
739
740
741
742
743
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
744
 *   Whether to display the teaser only, as on the main page.
Dries Buytaert's avatar
   
Dries Buytaert committed
745
746
 * @param $page
 *   Whether the node is being displayed by itself as a page.
747
748
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries Buytaert's avatar
   
Dries Buytaert committed
749
750
751
752
 *
 * @return
 *   An HTML representation of the themed node.
 */
753
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
754
  $node = (object)$node;
Dries Buytaert's avatar
   
Dries Buytaert committed
755

756
757
  $node = node_build_content($node, $teaser, $page);

758
759
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
760
    drupal_alter('link', $node->links, $node);
761
  }
762
763
764
765

  // 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);
766
  if ($teaser) {
767
    $node->teaser = $content;
768
769
770
    unset($node->body);
  }
  else {
771
    $node->body = $content;
772
773
    unset($node->teaser);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
774

775
776
777
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries Buytaert's avatar
   
Dries Buytaert committed
778
  return theme('node', $node, $teaser, $page);
Dries Buytaert's avatar
   
Dries Buytaert committed
779
}
Dries Buytaert's avatar
   
Dries Buytaert committed
780

Dries Buytaert's avatar
   
Dries Buytaert committed
781
/**
782
 * Apply filters and build the node's standard elements.
Dries Buytaert's avatar
   
Dries Buytaert committed
783
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
784
function node_prepare($node, $teaser = FALSE) {
785
786
787
  // 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.
788
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
789
790
791
792
793
794
795
796

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

797
  $node->content['body'] = array(
798
    '#value' => $teaser ? $node->teaser : $node->body,
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
    '#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) {
820
821
822
823
824
825

  // The build mode identifies the target for which the node is built.
  if (!isset($node->build_mode)) {
    $node->build_mode = NODE_BUILD_NORMAL;
  }

826
  // Remove the delimiter (if any) that separates the teaser from the body.
827
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
828
829
830
831
832

  // 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
833
834
  }
  else {
835
    $node = node_prepare($node, $teaser);
Dries Buytaert's avatar
   
Dries Buytaert committed
836
  }
837
838
839
840

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

Dries Buytaert's avatar
   
Dries Buytaert committed
841
  return $node;
Dries Buytaert's avatar
   
Dries Buytaert committed
842
843
}

Dries Buytaert's avatar
   
Dries Buytaert committed
844
845
846
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
847
function node_show($node, $cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
848
  $output = node_view($node, FALSE, TRUE);
Dries Buytaert's avatar
   
Dries Buytaert committed
849

Dries Buytaert's avatar
   
Dries Buytaert committed
850
851
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries Buytaert's avatar
   
Dries Buytaert committed
852
853
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
857
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
858
859
}

Dries Buytaert's avatar
   
Dries Buytaert committed
860
861
862
/**
 * Implementation of hook_perm().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
863
function node_perm() {
864
865
866
867
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
868
      $name = check_plain($type->type);
869
      $perms[] = 'create '. $name .' content';
870
871
      $perms[] = 'delete own '. $name .' content';
      $perms[] = 'delete '. $name .' content';
872
873
874
875
876
877
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries Buytaert's avatar
   
Dries Buytaert committed
878
879
}

Dries Buytaert's avatar
   
Dries Buytaert committed
880
881
882
/**
 * Implementation of hook_search().
 */
883
function node_search($op = 'search', $keys = NULL) {
884
885
  switch ($op) {
    case 'name':
886
      return t('Content');
887

Dries Buytaert's avatar
Dries Buytaert committed
888
889
    case 'reset':
      variable_del('node_cron_last');
890
      variable_del('node_cron_last_nid');
Dries Buytaert's avatar
Dries Buytaert committed
891
      return;
892

893
894
    case 'status':
      $last = variable_get('node_cron_last', 0);
895
      $last_nid = variable_get('node_cron_last_nid', 0);
896
897
      $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));
898
      return array('remaining' => $remaining, 'total' => $total);
899
900
901
902
903
904

    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';
905
      $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>');
906
907
908

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
909
      if (module_exists('comment')) {
910
911
        $ranking['node_rank_comments'] = t('Number of comments');
      }
912
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
913
914
915
916
917
918
919
920
921
922
        $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;

923
    case 'search':
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
      // 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
956
      $stats_join = FALSE;
957
      $total = 0;
958
959
960
961
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
962
        $total += $weight;
963
964
965
966
967
968
969
      }
      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';
970
        $stats_join = TRUE;
971
        $total += $weight;
972
      }
973
      if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
974
975
976
977
978
979
980
981
        // 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';
        }
982
        $total += $weight;
983
      }
984
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
985
986
987
988
989
990
          $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;
991
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
992
        $total += $weight;
993
      }
994
      $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') .' AS score';
995
996
997
998
999

      // 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
1000
      $results = array();
For faster browsing, not all history is shown. View entire blame