node.module 120 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
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);
17
define('NODE_BUILD_PRINT', 5);
18

Dries Buytaert's avatar
   
Dries Buytaert committed
19
20
21
/**
 * Implementation of hook_help().
 */
22
23
function node_help($path, $arg) {
  switch ($path) {
Dries Buytaert's avatar
   
Dries Buytaert committed
24
    case 'admin/help#node':
25
26
27
28
29
30
31
32
33
34
      $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>
');
35
      $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
36
      return $output;
37
38
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
39
    case 'admin/content/search':
40
      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>';
41
42
43
    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':
44
      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>';
45
46
47
48
49
50
    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
51
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
52

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

59
60
61
62
63
/**
 * Implementation of hook_theme()
 */
function node_theme() {
  return array(
64
65
66
67
    'node' => array(
      'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
      'file' => 'node',
    ),
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
    '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),
    ),
92
93
94
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
95
96
97
  );
}

Dries Buytaert's avatar
   
Dries Buytaert committed
98
99
100
/**
 * Implementation of hook_cron().
 */
101
function node_cron() {
Dries Buytaert's avatar
   
Dries Buytaert committed
102
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
103
104
}

Dries Buytaert's avatar
   
Dries Buytaert committed
105
106
107
108
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
109
110
111
112
 *   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
113
114
115
116
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
117
118
 *   An HTML list suitable as content for a block, or FALSE if no result can
 *   fetch from DB result object.
Dries Buytaert's avatar
   
Dries Buytaert committed
119
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
120
function node_title_list($result, $title = NULL) {
121
  $items = array();
122
  $num_rows = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
123
  while ($node = db_fetch_object($result)) {
124
    $items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
125
    $num_rows = TRUE;
Dries Buytaert's avatar
   
Dries Buytaert committed
126
127
  }

128
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
129
130
}

Dries Buytaert's avatar
   
Dries Buytaert committed
131
132
133
/**
 * Format a listing of links to nodes.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
134
function theme_node_list($items, $title = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
135
  return theme('item_list', $items, $title);
Dries Buytaert's avatar
   
Dries Buytaert committed
136
137
}

Dries Buytaert's avatar
   
Dries Buytaert committed
138
139
140
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
141
142
143
144
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
145
    if (node_last_viewed($nid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
146
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
147
148
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
149
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries Buytaert's avatar
   
Dries Buytaert committed
150
151
152
153
    }
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
154
155
156
157
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
158
159
function node_last_viewed($nid) {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
160
  static $history;
Dries Buytaert's avatar
   
Dries Buytaert committed
161

Dries Buytaert's avatar
   
Dries Buytaert committed
162
  if (!isset($history[$nid])) {
163
    $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
164
165
  }

166
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries Buytaert's avatar
   
Dries Buytaert committed
167
168
169
}

/**
170
 * Decide on the type of marker to be displayed for a given node.
Dries Buytaert's avatar
   
Dries Buytaert committed
171
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
172
173
174
175
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
176
177
 * @return
 *   One of the MARK constants.
Dries Buytaert's avatar
   
Dries Buytaert committed
178
 */
179
function node_mark($nid, $timestamp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
180
181
182
  global $user;
  static $cache;

183
184
185
  if (!$user->uid) {
    return MARK_READ;
  }
Dries Buytaert's avatar
Dries Buytaert committed
186
  if (!isset($cache[$nid])) {
187
    $cache[$nid] = node_last_viewed($nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
188
  }
189
190
191
192
193
194
195
  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
196
197
}

198
199
200
/**
 * See if the user used JS to submit a teaser.
 */
201
function node_teaser_js(&$form, &$form_state) {
202
203
  // Glue the teaser to the body.
  if (isset($form['#post']['teaser_js'])) {
204
    if (trim($form_state['values']['teaser_js'])) {
205
      // Space the teaser from the body
206
      $body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
207
208
209
    }
    else {
      // Empty teaser, no spaces.
210
      $body = '<!--break-->'. $form_state['values']['body'];
211
212
    }
    // Pass value onto preview/submit
213
    form_set_value($form['body'], $body, $form_state);
214
215
216
217
218
219
    // Pass value back onto form
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
220
/**
221
 * Automatically generate a teaser for a node body in a given format.
222
223
224
225
226
227
228
 *
 * @param $body
 *   The content for which a teaser will be generated.
 * @param $format
 *   The format of the content. If the content contains PHP code, we do not
 *   split it up to prevent parse errors.
 * @param $size
229
 *   The desired character length of the teaser. If omitted, the default
230
231
232
 *   value will be used.
 * @return
 *   The generated teaser.
Dries Buytaert's avatar
   
Dries Buytaert committed
233
 */
234
function node_teaser($body, $format = NULL, $size = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
235

236
237
238
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
239

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

243
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
244
  if ($size == 0 && $delimiter === FALSE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
245
246
    return $body;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
247

248
249
250
251
252
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

253
254
255
256
257
  // 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);
258
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
259
260
      return $body;
    }
261
262
  }

263
  // If we have a short body, the entire body is the teaser.
Dries Buytaert's avatar
   
Dries Buytaert committed
264
265
266
267
  if (strlen($body) < $size) {
    return $body;
  }

268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
  // 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);
283
    }
284
  }
Dries Buytaert's avatar
Dries Buytaert committed
285

286
287
288
289
290
291
292
293
294
295
296
297
  // 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
298
299
}

300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
/**
 * 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;
321

322
323
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
324
  }
325

326
327
328
329
330
331
332
333
334
335
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
336
    if (!isset($_node_types[$type])) {
337
338
339
340
      return FALSE;
    }
  }
  switch ($op) {
341
342
343
344
345
346
347
348
    case 'types':
      return $_node_types;
    case 'type':
      return $_node_types[$type];
    case 'module':
      return $_node_types[$type]->module;
    case 'names':
      return $_node_names;
349
    case 'name':
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
      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);
    }
367
368
369
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
370
  }
371
372

  _node_types_build();
373
374
}

375
/**
376
377
378
379
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries Buytaert's avatar
   
Dries Buytaert committed
380
381
 *
 * @return
382
 *   Status flag indicating outcome of the operation.
Dries Buytaert's avatar
   
Dries Buytaert committed
383
 */
384
385
386
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
387
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
388
389
390
391
392
393
394
395
396
  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 = '';
  }
397
398
399

  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);
400
401

    module_invoke_all('node_type', 'update', $info);
402
403
404
405
    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);
406
407

    module_invoke_all('node_type', 'insert', $info);
408
409
    return SAVED_NEW;
  }
410
}
411

412
413
414
415
416
417
418
419
420
421
422
423
424
/**
 * 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);
}

425
/**
426
427
 * Updates all nodes of one type to be of another type.
 *
428
 * @param $old_type
429
430
431
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
432
433
 *
 * @return
434
 *   The number of nodes whose node type field was modified.
435
 */
436
437
438
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
439
}
Dries Buytaert's avatar
   
Dries Buytaert committed
440

441
/**
442
443
444
445
 * Builds and returns the list of available node types.
 *
 * The list of types is built by querying hook_node_info() in all modules, and
 * by comparing this information with the node types in the {node_type} table.
Dries Buytaert's avatar
   
Dries Buytaert committed
446
447
 *
 */
448
449
450
451
452
453
454
455
456
457
458
459
460
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)) {
461
462
463
464
465
466
    // Check for node types from disabled modules and mark their types for removal.
    // Types defined by the node module in the database (rather than by a separate
    // module using hook_node_info) have a module value of 'node'.
    if ($type_object->module != 'node' && empty($info_array[$type_object->type])) {
       $type_object->disabled = TRUE;
    }
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
    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');
  }

501
502
503
504
505
506
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
507
508
509
510
511
512
513
514
515
516
517
518
519
520
  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
521
}
Dries Buytaert's avatar
   
Dries Buytaert committed
522

523
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
524
525
526
527
528
529
530
531
532
533
 * 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) {
534
535
536
537
538
  $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
539
540
}

541
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
542
543
544
545
546
547
548
549
550
 * 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
551
 *   The returned value of the invoked hook.
Dries Buytaert's avatar
   
Dries Buytaert committed
552
553
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
554
  if (node_hook($node, $hook)) {
555
556
557
558
559
    $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
560
    return ($function($node, $a2, $a3, $a4));
Dries Buytaert's avatar
   
Dries Buytaert committed
561
562
563
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
564
565
566
567
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries Buytaert's avatar
   
Dries Buytaert committed
568
 *   A node object.
Dries Buytaert's avatar
   
Dries Buytaert committed
569
570
571
572
573
574
575
 * @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
576
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
577
  $return = array();
578
  foreach (module_implements('nodeapi') as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
579
    $function = $name .'_nodeapi';
580
    $result = $function($node, $op, $a3, $a4);
581
    if (isset($result) && is_array($result)) {
582
583
584
585
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries Buytaert's avatar
   
Dries Buytaert committed
586
587
588
589
590
    }
  }
  return $return;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
591
592
593
/**
 * Load a node object from the database.
 *
594
595
 * @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
596
597
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries Buytaert's avatar
   
Dries Buytaert committed
598
599
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries Buytaert's avatar
   
Dries Buytaert committed
600
601
602
603
 *
 * @return
 *   A fully-populated node object.
 */
604
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
605
606
607
608
609
610
  static $nodes = array();

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

611
  $cachable = ($revision == NULL);
612
  $arguments = array();
613
  if (is_numeric($param)) {
614
    if ($cachable && isset($nodes[$param])) {
615
      return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
616
    }
617
618
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries Buytaert's avatar
   
Dries Buytaert committed
619
  }
620
  elseif (is_array($param)) {
621
    // Turn the conditions into a query.
622
    foreach ($param as $key => $value) {
623
624
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
625
626
    }
    $cond = implode(' AND ', $cond);
Dries Buytaert's avatar
   
Dries Buytaert committed
627
  }
628
629
630
  else {
    return FALSE;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
631

Dries Buytaert's avatar
   
Dries Buytaert committed
632
  // Retrieve the node.
633
  // No db_rewrite_sql is applied so as to get complete indexing for search.
634
  if ($revision) {
635
    array_unshift($arguments, $revision);
636
    $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
637
  }
638
  else {
639
    $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
640
641
  }

642
  if ($node && $node->nid) {
643
644
645
646
647
648
    // 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
649
650
    }

651
652
653
654
655
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
656
657
658
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
659
660
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
661
662
663
  return $node;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
664
665
666
/**
 * Save a node object into the database.
 */
667
function node_save(&$node) {
668
669
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
670
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
671

672
  $node->is_new = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
673

Dries Buytaert's avatar
   
Dries Buytaert committed
674
  // Apply filters to some default node fields:
Dries Buytaert's avatar
   
Dries Buytaert committed
675
  if (empty($node->nid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
676
    // Insert a new node.
677
    $node->is_new = TRUE;
678
679
680
681
682
683
  }
  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
684
    }
685
    $node = $node_current;
Dries Buytaert's avatar
   
Dries Buytaert committed
686

687
    if (!empty($node->revision)) {
688
689
      $node->old_vid = $node->vid;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
690
691
  }

692
693
694
695
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
696
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
697
  $node->changed = time();
Dries Buytaert's avatar
   
Dries Buytaert committed
698

699
  // Split off revisions data to another structure
700
  $revisions_table_values = array('nid' => &$node->nid,
701
                     'title' => $node->title, 'body' => isset($node->body) ? $node->body : '',
702
                     'teaser' => $node->teaser, 'timestamp' => $node->changed,
703
                     'uid' => $user->uid, 'format' => isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT);
704
  $revisions_table_types = array('nid' => '%d',
705
                     'title' => "'%s'", 'body' => "'%s'",
706
                     'teaser' => "'%s'", 'timestamp' => '%d',
707
                     'uid' => '%d', 'format' => '%d');
708
  if (!empty($node->log) || $node->is_new || (isset($node->revision) && $node->revision)) {
709
710
711
    // 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).
712
713
714
    $revisions_table_values['log'] = $node->log;
    $revisions_table_types['log'] = "'%s'";
  }
715
  $node_table_values = array(
716
                    'title' => $node->title, 'type' => $node->type, 'uid' => $node->uid,
717
                    'status' => $node->status, 'language' => $node->language, 'created' => $node->created,
718
                    'changed' => $node->changed, 'comment' => $node->comment,
719
                    'promote' => $node->promote, 'sticky' => $node->sticky);
720
  $node_table_types = array(
721
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
722
                    'status' => '%d', 'language' => "'%s'",'created' => '%d',
723
                    'changed' => '%d', 'comment' => '%d',
724
                    'promote' => '%d', 'sticky' => '%d');
725
  $update_node = TRUE;
726
727
728
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
729
    $node_query = 'INSERT INTO {node} ('. implode(', ', array_keys($node_table_types)) .') VALUES ('. implode(', ', $node_table_types) .')';
730
731
    db_query($node_query, $node_table_values);
    $node->nid = db_last_insert_id('node', 'nid');
732
    $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
733
734
735
    db_query($revisions_query, $revisions_table_values);
    $node->vid = db_last_insert_id('node_revisions', 'vid');
    $op = 'insert';
736
737
738
739
740
741
742
743
  }
  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';
744
    db_query($node_query, $node_table_values);
745
    if (!empty($node->revision)) {
746
      $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
747
748
      db_query($revisions_query, $revisions_table_values);
      $node->vid = db_last_insert_id('node_revisions', 'vid');
749
750
751
752
753
    }
    else {
      $arr = array();
      foreach ($revisions_table_types as $key => $value) {
        $arr[] = $key .' = '. $value;
Dries Buytaert's avatar
   
Dries Buytaert committed
754
      }
755
756
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
757
758
      db_query($revisions_query, $revisions_table_values);
      $update_node = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
759
    }
760
    $op = 'update';
761
  }
762
  if ($update_node) {
763
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
764
765
  }

766
767
768
769
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

770
771
772
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries Buytaert's avatar
   
Dries Buytaert committed
773
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries Buytaert's avatar
   
Dries Buytaert committed
774
  cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
775
776
}

Dries Buytaert's avatar
   
Dries Buytaert committed
777
778
779
780
781
782
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
783
 *   Whether to display the teaser only, as on the main page.
Dries Buytaert's avatar
   
Dries Buytaert committed
784
785
 * @param $page
 *   Whether the node is being displayed by itself as a page.
786
787
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries Buytaert's avatar
   
Dries Buytaert committed
788
789
790
791
 *
 * @return
 *   An HTML representation of the themed node.
 */
792
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
793
  $node = (object)$node;
Dries Buytaert's avatar
   
Dries Buytaert committed
794

795
796
  $node = node_build_content($node, $teaser, $page);

797
798
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
799
    drupal_alter('link', $node->links, $node);
800
  }
801
802
803
804

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

814
815
816
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries Buytaert's avatar
   
Dries Buytaert committed
817
  return theme('node', $node, $teaser, $page);
Dries Buytaert's avatar
   
Dries Buytaert committed
818
}
Dries Buytaert's avatar
   
Dries Buytaert committed
819

Dries Buytaert's avatar
   
Dries Buytaert committed
820
/**
821
 * Apply filters and build the node's standard elements.
Dries Buytaert's avatar
   
Dries Buytaert committed
822
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
823
function node_prepare($node, $teaser = FALSE) {
824
825
826
  // 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.
827
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
828
829
830
831
832
833
834
835

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

836
  $node->content['body'] = array(
837
    '#value' => $teaser ? $node->teaser : $node->body,
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
    '#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) {
859
860
861
862
863
864

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

865
  // Remove the delimiter (if any) that separates the teaser from the body.
866
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
867
868
869
870
871

  // 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
872
873
  }
  else {
874
    $node = node_prepare($node, $teaser);
Dries Buytaert's avatar
   
Dries Buytaert committed
875
  }
876
877
878
879

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

Dries Buytaert's avatar
   
Dries Buytaert committed
880
  return $node;
Dries Buytaert's avatar
   
Dries Buytaert committed
881
882
}

Dries Buytaert's avatar
   
Dries Buytaert committed
883
884
885
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
886
function node_show($node, $cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
887
  $output = node_view($node, FALSE, TRUE);
Dries Buytaert's avatar
   
Dries Buytaert committed
888

Dries Buytaert's avatar
   
Dries Buytaert committed
889
890
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries Buytaert's avatar
   
Dries Buytaert committed
891
892
  }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
896
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
897
898
}

Dries Buytaert's avatar
   
Dries Buytaert committed
899
900
901
/**
 * Implementation of hook_perm().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
902
function node_perm() {
903
904
905
906
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
907
      $name = check_plain($type->type);
908
      $perms[] = 'create '. $name .' content';
909
910
      $perms[] = 'delete own '. $name .' content';
      $perms[] = 'delete '. $name .' content';
911
912
913
914
915
916
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries Buytaert's avatar
   
Dries Buytaert committed
917
918
}

Dries Buytaert's avatar
   
Dries Buytaert committed
919
920
921
/**
 * Implementation of hook_search().
 */
922
function node_search($op = 'search', $keys = NULL) {
923
924
  switch ($op) {
    case 'name':
925
      return t('Content');
926

Dries Buytaert's avatar
Dries Buytaert committed
927
928
    case 'reset':
      variable_del('node_cron_last');
929
      variable_del('node_cron_last_nid');
Dries Buytaert's avatar
Dries Buytaert committed
930
      return;
931

932
933
    case 'status':
      $last = variable_get('node_cron_last', 0);
934
      $last_nid = variable_get('node_cron_last_nid', 0);
935
936
      $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));
937
      return array('remaining' => $remaining, 'total' => $total);
938
939
940
941
942
943

    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';
944
      $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>');
945
946
947

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
948
      if (module_exists('comment')) {
949
950
        $ranking['node_rank_comments'] = t('Number of comments');
      }
951
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
952
953
954
955
956
957
958
959
960
961
        $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;

962
    case 'search':
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
      // 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
995
      $stats_join = FALSE;
996
      $total = 0;
997
998
999
1000
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
For faster browsing, not all history is shown. View entire blame