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

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

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

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);
Dries's avatar
Dries committed
17
define('NODE_BUILD_PRINT', 5);
18

Dries's avatar
   
Dries committed
19
20
21
/**
 * Implementation of hook_help().
 */
22
function node_help($path, $arg) {
23
24
25
26
27
28
29
30
31
32
33
  if ($path != 'admin/content/node-settings/rebuild' && strpos($path, '#') === FALSE
      && user_access('access administration pages') && node_access_needs_rebuild()) {
    if ($path == 'admin/content/node-settings') {
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
      $message = t('The content access permissions need to be rebuilt. Please visit <a href="@node_access_rebuild">this page</a>.', array('@node_access_rebuild' => url('admin/content/node-settings/rebuild')));
    }
    drupal_set_message($message, 'error');
  }

34
  switch ($path) {
Dries's avatar
   
Dries committed
35
    case 'admin/help#node':
36
37
38
39
40
41
42
43
44
45
      $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>
');
46
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@node">Node page</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) .'</p>';
Dries's avatar
   
Dries committed
47
      return $output;
48
49
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
50
    case 'admin/content/search':
51
      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>';
52
53
54
    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':
55
      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>';
56
57
58
59
60
61
    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's avatar
   
Dries committed
62
  }
Dries's avatar
   
Dries committed
63

64
65
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
    $type = node_get_types('type', str_replace('-', '_', $arg[2]));
66
    return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
67
  }
Dries's avatar
   
Dries committed
68
69
}

70
71
72
73
74
/**
 * Implementation of hook_theme()
 */
function node_theme() {
  return array(
75
76
    'node' => array(
      'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
77
      'template' => 'node',
78
    ),
79
80
81
82
83
84
85
86
    '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),
87
      'file' => 'node.admin.inc',
88
89
90
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
91
      'file' => 'node.admin.inc',
92
93
94
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
95
96
97
98
99
      'file' => 'node.admin.inc',
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
      'file' => 'node.pages.inc',
100
101
102
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
103
      'file' => 'node.pages.inc',
104
105
106
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
107
      'file' => 'node.pages.inc',
108
109
110
111
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
112
113
114
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
115
116
117
  );
}

Dries's avatar
   
Dries committed
118
119
120
/**
 * Implementation of hook_cron().
 */
121
function node_cron() {
Dries's avatar
   
Dries committed
122
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
123
124
}

Dries's avatar
   
Dries committed
125
126
127
128
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
129
130
131
132
 *   A DB result object from a query to fetch node objects. If your query
 *   joins the <code>node_comment_statistics</code> table so that the
 *   <code>comment_count</code> field is available, a title attribute will
 *   be added to show the number of comments.
Dries's avatar
   
Dries committed
133
134
135
136
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
137
138
 *   An HTML list suitable as content for a block, or FALSE if no result can
 *   fetch from DB result object.
Dries's avatar
   
Dries committed
139
 */
Dries's avatar
   
Dries committed
140
function node_title_list($result, $title = NULL) {
141
  $items = array();
142
  $num_rows = FALSE;
Dries's avatar
   
Dries committed
143
  while ($node = db_fetch_object($result)) {
144
    $items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
145
    $num_rows = TRUE;
Dries's avatar
   
Dries committed
146
147
  }

148
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
   
Dries committed
149
150
}

Dries's avatar
   
Dries committed
151
152
153
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
   
Dries committed
154
function theme_node_list($items, $title = NULL) {
Dries's avatar
   
Dries committed
155
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
156
157
}

Dries's avatar
   
Dries committed
158
159
160
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
   
Dries committed
161
162
163
164
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
   
Dries committed
165
    if (node_last_viewed($nid)) {
Dries's avatar
   
Dries committed
166
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
   
Dries committed
167
168
    }
    else {
Dries's avatar
   
Dries committed
169
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
   
Dries committed
170
171
172
173
    }
  }
}

Dries's avatar
   
Dries committed
174
175
176
177
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
   
Dries committed
178
179
function node_last_viewed($nid) {
  global $user;
Dries's avatar
   
Dries committed
180
  static $history;
Dries's avatar
   
Dries committed
181

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

186
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
   
Dries committed
187
188
189
}

/**
190
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
   
Dries committed
191
 *
Dries's avatar
   
Dries committed
192
193
194
195
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
196
197
 * @return
 *   One of the MARK constants.
Dries's avatar
   
Dries committed
198
 */
199
function node_mark($nid, $timestamp) {
Dries's avatar
   
Dries committed
200
201
202
  global $user;
  static $cache;

203
204
205
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
206
  if (!isset($cache[$nid])) {
207
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
   
Dries committed
208
  }
209
210
211
212
213
214
215
  if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
    return MARK_NEW;
  }
  elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
    return MARK_UPDATED;
  }
  return MARK_READ;
Dries's avatar
   
Dries committed
216
217
}

218
219
220
/**
 * See if the user used JS to submit a teaser.
 */
221
function node_teaser_js(&$form, &$form_state) {
222
223
  // Glue the teaser to the body.
  if (isset($form['#post']['teaser_js'])) {
224
    if (trim($form_state['values']['teaser_js'])) {
225
      // Space the teaser from the body
226
      $body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
227
228
229
    }
    else {
      // Empty teaser, no spaces.
230
      $body = '<!--break-->'. $form_state['values']['body'];
231
232
    }
    // Pass value onto preview/submit
233
    form_set_value($form['body'], $body, $form_state);
234
235
236
237
238
239
    // Pass value back onto form
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries's avatar
   
Dries committed
240
/**
241
 * Automatically generate a teaser for a node body in a given format.
242
243
244
245
246
247
248
 *
 * @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
Dries's avatar
Dries committed
249
 *   The desired character length of the teaser. If omitted, the default
250
251
252
 *   value will be used.
 * @return
 *   The generated teaser.
Dries's avatar
   
Dries committed
253
 */
254
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
   
Dries committed
255

256
257
258
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
   
Dries committed
259

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

263
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
264
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
   
Dries committed
265
266
    return $body;
  }
Dries's avatar
   
Dries committed
267

268
269
270
271
272
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

273
274
275
276
277
  // 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);
278
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
279
280
      return $body;
    }
281
282
  }

283
  // If we have a short body, the entire body is the teaser.
Dries's avatar
   
Dries committed
284
285
286
287
  if (strlen($body) < $size) {
    return $body;
  }

288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
  // 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);
303
    }
304
  }
Dries's avatar
Dries committed
305

306
307
308
309
310
311
312
313
314
315
316
317
  // When even the first paragraph is too long, we try to split at the end of
  // the last full sentence.
  $breakpoints = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);
  $min_length = strlen($reversed);
  foreach ($breakpoints as $point => $offset) {
    $length = strpos($reversed, strrev($point));
    if ($length !== FALSE) {
      $min_length = min($length, $min_length);
      $position = 0 - $length - $offset;
    }
  }
  return ($position == 0) ? $teaser : substr($teaser, 0, $position);
Dries's avatar
   
Dries committed
318
319
}

320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/**
 * 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
337
 *   variable format. Returns FALSE if the node type is not found.
338
339
340
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
341

342
343
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
344
  }
345

346
347
348
349
350
351
352
353
354
355
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
356
    if (!isset($_node_types[$type])) {
357
358
359
360
      return FALSE;
    }
  }
  switch ($op) {
361
362
363
    case 'types':
      return $_node_types;
    case 'type':
364
      return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
365
    case 'module':
366
      return isset($_node_types[$type]->module) ? $_node_types[$type]->module : FALSE;
367
368
    case 'names':
      return $_node_names;
369
    case 'name':
370
      return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
  }
}

/**
 * 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);
    }
387
388
389
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
390
  }
391
392

  _node_types_build();
393
394
}

395
/**
396
397
398
399
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
   
Dries committed
400
401
 *
 * @return
402
 *   Status flag indicating outcome of the operation.
Dries's avatar
   
Dries committed
403
 */
404
405
406
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
407
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
408
409
410
411
412
413
414
415
416
  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 = '';
  }
417
418
419

  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);
420
421

    module_invoke_all('node_type', 'update', $info);
422
423
424
425
    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);
426
427

    module_invoke_all('node_type', 'insert', $info);
428
429
    return SAVED_NEW;
  }
430
}
431

432
433
434
435
436
437
438
439
440
441
442
443
444
/**
 * 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);
}

445
/**
446
447
 * Updates all nodes of one type to be of another type.
 *
448
 * @param $old_type
449
450
451
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
452
453
 *
 * @return
454
 *   The number of nodes whose node type field was modified.
455
 */
456
457
458
function node_type_update_nodes($old_type, $type) {
  db_query("UPDATE {node} SET type = '%s' WHERE type = '%s'", $type, $old_type);
  return db_affected_rows();
Dries's avatar
   
Dries committed
459
}
Dries's avatar
   
Dries committed
460

461
/**
462
463
464
465
 * 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's avatar
   
Dries committed
466
467
 *
 */
468
469
470
471
472
473
474
475
476
477
478
479
480
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)) {
481
482
483
484
485
486
    // 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;
    }
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
    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');
  }

521
522
523
524
525
526
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
527
528
529
530
531
532
533
534
535
536
537
538
539
540
  if (!isset($info['custom'])) {
    $info['custom'] = FALSE;
  }
  if (!isset($info['modified'])) {
    $info['modified'] = FALSE;
  }
  if (!isset($info['locked'])) {
    $info['locked'] = TRUE;
  }

  $info['orig_type'] = $info['type'];
  $info['is_new'] = TRUE;

  return $info;
Dries's avatar
   
Dries committed
541
}
Dries's avatar
   
Dries committed
542

543
/**
Dries's avatar
   
Dries committed
544
545
546
547
548
549
550
551
552
553
 * 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) {
554
555
556
557
558
  $module = node_get_types('module', $node);
  if ($module == 'node') {
    $module = 'node_content'; // Avoid function name collisions.
  }
  return module_hook($module, $hook);
Dries's avatar
   
Dries committed
559
560
}

561
/**
Dries's avatar
   
Dries committed
562
563
564
565
566
567
568
569
570
 * Invoke a node hook.
 *
 * @param &$node
 *   Either a node object, node array, or a string containing the node type.
 * @param $hook
 *   A string containing the name of the hook.
 * @param $a2, $a3, $a4
 *   Arguments to pass on to the hook, after the $node argument.
 * @return
Dries's avatar
   
Dries committed
571
 *   The returned value of the invoked hook.
Dries's avatar
   
Dries committed
572
573
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
574
  if (node_hook($node, $hook)) {
575
576
577
578
579
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
   
Dries committed
580
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
   
Dries committed
581
582
583
  }
}

Dries's avatar
   
Dries committed
584
585
586
587
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
   
Dries committed
588
 *   A node object.
Dries's avatar
   
Dries committed
589
590
591
592
593
594
595
 * @param $op
 *   A string containing the name of the nodeapi operation.
 * @param $a3, $a4
 *   Arguments to pass on to the hook, after the $node and $op arguments.
 * @return
 *   The returned value of the invoked hooks.
 */
Dries's avatar
   
Dries committed
596
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
   
Dries committed
597
  $return = array();
598
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
   
Dries committed
599
    $function = $name .'_nodeapi';
600
    $result = $function($node, $op, $a3, $a4);
601
    if (isset($result) && is_array($result)) {
602
603
604
605
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
   
Dries committed
606
607
608
609
610
    }
  }
  return $return;
}

Dries's avatar
   
Dries committed
611
612
613
/**
 * Load a node object from the database.
 *
614
615
 * @param $param
 *   Either the nid of the node or an array of conditions to match against in the database query
Dries's avatar
   
Dries committed
616
617
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
   
Dries committed
618
619
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
   
Dries committed
620
621
622
623
 *
 * @return
 *   A fully-populated node object.
 */
624
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
   
Dries committed
625
626
627
628
629
630
  static $nodes = array();

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

631
  $cachable = ($revision == NULL);
632
  $arguments = array();
633
  if (is_numeric($param)) {
634
    if ($cachable) {
635
      // Is the node statically cached?
636
637
638
      if (isset($nodes[$param])) {
        return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
      }
639
    }
640
641
    $cond = 'n.nid = %d';
    $arguments[] = $param;
Dries's avatar
   
Dries committed
642
  }
643
  elseif (is_array($param)) {
644
    // Turn the conditions into a query.
645
    foreach ($param as $key => $value) {
646
647
      $cond[] = 'n.'. db_escape_string($key) ." = '%s'";
      $arguments[] = $value;
648
649
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
   
Dries committed
650
  }
651
652
653
  else {
    return FALSE;
  }
Dries's avatar
   
Dries committed
654

655
656
657
658
659
660
661
662
  // Retrieve a field list based on the site's schema.
  $fields = drupal_schema_fields_sql('node', 'n');
  $fields = array_merge($fields, drupal_schema_fields_sql('node_revisions', 'r'));
  $fields = array_merge($fields, array('u.name', 'u.data'));
  $fields = implode(', ', $fields);
  // rename timestamp field for clarity.
  $fields = str_replace('r.timestamp', 'r.timestamp AS revision_timestamp', $fields);

Dries's avatar
   
Dries committed
663
  // Retrieve the node.
664
  // No db_rewrite_sql is applied so as to get complete indexing for search.
665
  if ($revision) {
666
    array_unshift($arguments, $revision);
667
    $node = db_fetch_object(db_query('SELECT '. $fields. ' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.nid = n.nid AND r.vid = %d WHERE '. $cond, $arguments));
Dries's avatar
   
Dries committed
668
  }
669
  else {
670
    $node = db_fetch_object(db_query('SELECT '. $fields. ' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.vid = n.vid WHERE '. $cond, $arguments));
Dries's avatar
   
Dries committed
671
672
  }

673
  if ($node && $node->nid) {
674
675
676
677
678
679
    // Call the node specific callback (if any) and piggy-back the
    // results to the node or overwrite some values.
    if ($extra = node_invoke($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
Dries's avatar
   
Dries committed
680
681
    }

682
683
684
685
686
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
687
688
689
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
   
Dries committed
690
691
  }

Dries's avatar
   
Dries committed
692
693
694
  return $node;
}

695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
/**
 * Perform validation checks on the given node.
 */
function node_validate($node, $form = array()) {
  // Convert the node to an object, if necessary.
  $node = (object)$node;
  $type = node_get_types('type', $node);

  // Make sure the body has the minimum number of words.
  // todo use a better word counting algorithm that will work in other languages
  if (!empty($type->min_word_count) && isset($node->body) && count(explode(' ', $node->body)) < $type->min_word_count) {
    form_set_error('body', t('The body of your @type is too short. You need at least %words words.', array('%words' => $type->min_word_count, '@type' => $type->name)));
  }

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
    form_set_error('changed', t('This content has been modified by another user, changes cannot be saved.'));
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
    if (!empty($node->name) && !($account = user_load(array('name' => $node->name)))) {
      // The use of empty() is mandatory in the context of usernames
      // as the empty string denotes the anonymous user. In case we
      // are dealing with an anonymous user we set the user ID to 0.
      form_set_error('name', t('The username %name does not exist.', array('%name' => $node->name)));
    }

    // Validate the "authored on" field. As of PHP 5.1.0, strtotime returns FALSE instead of -1 upon failure.
    if (!empty($node->date) && strtotime($node->date) <= 0) {
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
  node_invoke_nodeapi($node, 'validate', $form);
}

/**
 * Prepare node for save and allow modules to make changes.
 */
function node_submit($node) {
  global $user;

  // Convert the node to an object, if necessary.
  $node = (object)$node;

  // Auto-generate the teaser, but only if it hasn't been set (e.g. by a
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
      // Chop off the teaser from the body if needed.
      if (!$node->teaser_include && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
        $node->body = substr($node->body, strlen($node->teaser));
      }
    }
    else {
      $node->teaser = '';
    }
  }

  if (user_access('administer nodes')) {
    // Populate the "authored by" field.
    if ($account = user_load(array('name' => $node->name))) {
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
766
  $node->created = !empty($node->date) ? strtotime($node->date) : time();
767
768
769
770
771
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
   
Dries committed
772
773
774
/**
 * Save a node object into the database.
 */
775
function node_save(&$node) {
776
777
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
778
  global $user;
Dries's avatar
   
Dries committed
779

780
  $node->is_new = FALSE;
Dries's avatar
   
Dries committed
781

Dries's avatar
   
Dries committed
782
  // Apply filters to some default node fields:
Dries's avatar
   
Dries committed
783
  if (empty($node->nid)) {
Dries's avatar
   
Dries committed
784
    // Insert a new node.
785
    $node->is_new = TRUE;
786
  }
787
788
789
  elseif (!empty($node->revision)) {
    $node->old_vid = $node->vid;
  }
790
  else {
791
792
793
    // When updating a node, avoid clobberring an existing log entry with an empty one.
    if (empty($node->log)) {
      unset($node->log);
794
    }
Dries's avatar
   
Dries committed
795
796
  }

797
798
799
800
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
801
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
802
  $node->changed = time();
Dries's avatar
   
Dries committed
803

804
805
  $node->timestamp = time();
  $node->format = isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT;
806
  $update_node = TRUE;
807

808
809
810
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
811
812
    drupal_write_record('node', $node);
    drupal_write_record('node_revisions', $node);
813
    $op = 'insert';
814
815
  }
  else {
816
    drupal_write_record('node', $node, 'nid');
817
    if (!empty($node->revision)) {
818
      drupal_write_record('node_revisions', $node);
819
820
    }
    else {
821
      drupal_write_record('node_revisions', $node, 'vid');
822
      $update_node = FALSE;
Dries's avatar
   
Dries committed
823
    }
824
    $op = 'update';
825
  }
826
  if ($update_node) {
827
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
828
829
  }

830
831
832
833
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

834
835
836
  // Update the node access table for this node.
  node_access_acquire_grants($node);

837
  // Clear the page and block caches.
Dries's avatar
   
Dries committed
838
  cache_clear_all();
Dries's avatar
   
Dries committed
839
840
}

841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
/**
 * Delete a node.
 */
function node_delete($nid) {

  $node = node_load($nid);

  if (node_access('delete', $node)) {
    db_query('DELETE FROM {node} WHERE nid = %d', $node->nid);
    db_query('DELETE FROM {node_revisions} WHERE nid = %d', $node->nid);

    // Call the node-specific callback (if any):
    node_invoke($node, 'delete');
    node_invoke_nodeapi($node, 'delete');

    // Clear the page and block caches.
    cache_clear_all();

    // Remove this node from the search index if needed.
    if (function_exists('search_wipe')) {
      search_wipe($node->nid, 'node');
    }
    drupal_set_message(t('%title has been deleted.', array('%title' => $node->title)));
    watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
  }
}

Dries's avatar
   
Dries committed
868
869
870
871
872
873
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
874
 *   Whether to display the teaser only or the full form.
Dries's avatar
   
Dries committed
875
876
 * @param $page
 *   Whether the node is being displayed by itself as a page.
877
878
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
   
Dries committed
879
880
881
882
 *
 * @return
 *   An HTML representation of the themed node.
 */
883
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
884
  $node = (object)$node;
Dries's avatar
   
Dries committed
885

886
887
  $node = node_build_content($node, $teaser, $page);

888
  if ($links) {
889
    $node->links = module_invoke_all('link', 'node', $node, $teaser);
890
    drupal_alter('link', $node->links, $node);
891
  }
892
893
894
895

  // 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);
896
  if ($teaser) {
897
    $node->teaser = $content;
898
899
900
    unset($node->body);
  }
  else {
901
    $node->body = $content;
902
903
    unset($node->teaser);
  }
Dries's avatar
   
Dries committed
904

905
906
907
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
   
Dries committed
908
  return theme('node', $node, $teaser, $page);
Dries's avatar
   
Dries committed
909
}
Dries's avatar
   
Dries committed
910

Dries's avatar
   
Dries committed
911
/**
912
 * Apply filters and build the node's standard elements.
Dries's avatar
   
Dries committed
913
 */
Dries's avatar
   
Dries committed
914
function node_prepare($node, $teaser = FALSE) {
915
916
917
  // 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.
918
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
919
920
921
922
923
924
925
926

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

927
  $node->content['body'] = array(
928
    '#value' => $teaser ? $node->teaser : $node->body,
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
    '#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) {
950
951
952
953
954
955

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

956
  // Remove the delimiter (if any) that separates the teaser from the body.
957
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
958
959
960
961
962

  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
  if (node_hook($node, 'view')) {
    $node = node_invoke($node, 'view', $teaser, $page);
Dries's avatar
   
Dries committed
963
964
  }
  else {
965
    $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
966
  }
967
968
969
970

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

Dries's avatar
   
Dries committed
971
  return $node;
Dries's avatar
   
Dries committed
972
973
}

Dries's avatar
   
Dries committed
974
975
976
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
   
Dries committed
977
function node_show($node, $cid) {
Dries's avatar
   
Dries committed
978
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
   
Dries committed
979

Dries's avatar
   
Dries committed
980
981
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
   
Dries committed
982
983
  }

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

Dries's avatar
   
Dries committed
987
  return $output;
Dries's avatar
   
Dries committed
988
989
}

990
991
992
993
function theme_node_log_message($log) {
  return '<div class="log"><div class="title">'. t('Log') .':</div>'. $log .'</div>';
}

Dries's avatar
   
Dries committed
994
995
996
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
997
function node_perm() {
998
999
1000
1001
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
1002
      $name = check_plain($type->type);
1003
      $perms[] = 'create '. $name .' content';
1004
1005
      $perms[] = 'delete own '. $name .' content';
      $perms[] = 'delete '. $name .' content';
1006
1007
1008
1009
1010
1011
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
   
Dries committed
1012
1013
}

Dries's avatar
   
Dries committed
1014
1015
1016
/**
 * Implementation of hook_search().
 */
1017
function node_search($op = 'search', $keys = NULL) {
1018
1019
  switch ($op) {
    case 'name':
1020
      return t('Content');
1021

Dries's avatar
Dries committed
1022
1023
    case 'reset':
      variable_del('node_cron_last');
1024
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
1025
      return;
1026

1027
1028
    case 'status':
      $last = variable_get('node_cron_last', 0);
1029
      $last_nid = variable_get('node_cron_last_nid', 0);
1030
1031
      $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));
1032
      return array('remaining' => $remaining, 'total' => $total);
1033
1034
1035
1036
1037
1038

    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';
1039
      $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>');
1040
1041
1042

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
1043
      if (module_exists('comment')) {
1044
1045
        $ranking['node_rank_comments'] = t('Number of comments');
      }
1046
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
        $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;

1057
    case 'search':
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
      // 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) .')';
1080
        $join1 .= ' INNER JOIN {term_node} tn ON n.vid = tn.vid';
1081
1082
1083
1084
1085
1086
1087
1088
1089
        $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
1090
      $stats_join = FALSE;
1091
      $total = 0;
1092
1093
1094
1095
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
1096
        $total += $weight;
1097
1098
1099
1100
1101
1102
1103
      }
      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';
1104
        $stats_join = TRUE;
1105
        $total += $weight;
1106
      }
1107
      if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
1108
1109
1110
1111
1112
1113
1114
1115
        // 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';
        }
1116
        $total += $weight;
1117
      }
1118
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
1119
1120
1121
1122
1123
1124
          $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;
1125
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
1126
        $total += $weight;
1127
      }
1128
      $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') .' AS score';
1129
1130
1131
1132
1133

      // 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
1134
1135
      $results = array();
      foreach ($find as $item) {
1136
        // Build the node body.
1137
        $node = node_load($item->sid);
1138
        $node->build_mode = NODE_BUILD_SEARCH_RESULT;
1139
1140
        $node = node_build_content($node, FALSE, FALSE);
        $node->body = drupal_render($node->content);
1141

1142
1143
        // Fetch co