node.module 119 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
17
define('NODE_BUILD_NORMAL', 0);
define('NODE_BUILD_PREVIEW', 1);
define('NODE_BUILD_SEARCH_INDEX', 2);
define('NODE_BUILD_SEARCH_RESULT', 3);
define('NODE_BUILD_RSS', 4);

Dries's avatar
   
Dries committed
18
19
20
/**
 * Implementation of hook_help().
 */
21
22
function node_help($path, $arg) {
  switch ($path) {
Dries's avatar
   
Dries committed
23
    case 'admin/help#node':
24
25
26
27
28
29
30
31
32
33
      $output = '<p>'. t('All content in a website is stored and treated as <b>nodes</b>. Therefore nodes are any postings such as blogs, stories, polls and forums. The node module manages these content types and is one of the strengths of Drupal over other content management systems.') .'</p>';
      $output .= '<p>'. t('Treating all content as nodes allows the flexibility of creating new types of content. It also allows you to painlessly apply new features or changes to all content. Comments are not stored as nodes but are always associated with a node.') .'</p>';
      $output .= t('<p>Node module features</p>
<ul>
<li>The list tab provides an interface to search and sort all content on your site.</li>
<li>The configure settings tab has basic settings for content on your site.</li>
<li>The configure content types tab lists all content types for your site and lets you configure their default workflow.</li>
<li>The search tab lets you search all content on your site</li>
</ul>
');
34
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@node">Node page</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) .'</p>';
Dries's avatar
   
Dries committed
35
      return $output;
36
37
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
38
    case 'admin/content/search':
39
      return '<p>'. t('Enter a simple pattern to search for a post. Words are matched exactly. Phrases can be surrounded by quotes to do an exact search.') .'</p>';
40
41
42
    case 'admin/content/types':
      return '<p>'. t('Below is a list of all the content types on your site. All posts that exist on your site are instances of one of these content types.') .'</p>';
    case 'admin/content/types/add':
43
      return '<p>'. t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.') .'</p>';
44
45
46
47
48
49
    case 'node/%/revisions':
      return '<p>'. t('The revisions let you track differences between multiple versions of a post.') .'</p>';
    case 'node/%/edit':
      $node = node_load($arg[1]);
      $type = node_get_types('type', $node->type);
      return '<p>'. (isset($type->help) ? filter_xss_admin($type->help) : '') .'</p>';
Dries's avatar
   
Dries committed
50
  }
Dries's avatar
   
Dries committed
51

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

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

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

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

Dries's avatar
   
Dries committed
120
  return theme('node_list', $items, $title);
Dries's avatar
   
Dries committed
121
122
}

Dries's avatar
   
Dries committed
123
124
125
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
   
Dries committed
126
function theme_node_list($items, $title = NULL) {
Dries's avatar
   
Dries committed
127
  return theme('item_list', $items, $title);
Dries's avatar
   
Dries committed
128
129
}

Dries's avatar
   
Dries committed
130
131
132
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
   
Dries committed
133
134
135
136
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
   
Dries committed
137
    if (node_last_viewed($nid)) {
Dries's avatar
   
Dries committed
138
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
   
Dries committed
139
140
    }
    else {
Dries's avatar
   
Dries committed
141
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
   
Dries committed
142
143
144
145
    }
  }
}

Dries's avatar
   
Dries committed
146
147
148
149
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
   
Dries committed
150
151
function node_last_viewed($nid) {
  global $user;
Dries's avatar
   
Dries committed
152
  static $history;
Dries's avatar
   
Dries committed
153

Dries's avatar
   
Dries committed
154
  if (!isset($history[$nid])) {
155
    $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
156
157
  }

158
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
   
Dries committed
159
160
161
}

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

175
176
177
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
178
  if (!isset($cache[$nid])) {
179
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
   
Dries committed
180
  }
181
182
183
184
185
186
187
  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
188
189
}

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

Dries's avatar
   
Dries committed
212
/**
213
 * Automatically generate a teaser for a node body in a given format.
214
215
216
217
218
219
220
 *
 * @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
221
 *   The desired character length of the teaser. If omitted, the default
222
223
224
 *   value will be used.
 * @return
 *   The generated teaser.
Dries's avatar
   
Dries committed
225
 */
226
function node_teaser($body, $format = NULL, $size = NULL) {
Dries's avatar
   
Dries committed
227

228
229
230
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
   
Dries committed
231

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

235
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
236
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
   
Dries committed
237
238
    return $body;
  }
Dries's avatar
   
Dries committed
239

240
241
242
243
244
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

245
246
247
248
249
  // 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);
250
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
251
252
      return $body;
    }
253
254
  }

255
  // If we have a short body, the entire body is the teaser.
Dries's avatar
   
Dries committed
256
257
258
259
  if (strlen($body) < $size) {
    return $body;
  }

260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
  // 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);
275
    }
276
  }
Dries's avatar
Dries committed
277

278
279
280
281
282
283
284
285
286
287
288
289
  // 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
290
291
}

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
/**
 * 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;
313

314
315
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
316
  }
317

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

  _node_types_build();
365
366
}

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

  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);
392
393

    module_invoke_all('node_type', 'update', $info);
394
395
396
397
    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);
398
399

    module_invoke_all('node_type', 'insert', $info);
400
401
    return SAVED_NEW;
  }
402
}
403

404
405
406
407
408
409
410
411
412
413
414
415
416
/**
 * 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);
}

417
/**
418
419
 * Updates all nodes of one type to be of another type.
 *
420
 * @param $old_type
421
422
423
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
424
425
 *
 * @return
426
 *   The number of nodes whose node type field was modified.
427
 */
428
429
430
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
431
}
Dries's avatar
   
Dries committed
432

433
/**
434
435
436
437
 * 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
438
439
 *
 */
440
441
442
443
444
445
446
447
448
449
450
451
452
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)) {
453
454
455
456
457
458
    // 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;
    }
459
460
461
462
463
464
465
466
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
    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');
  }

493
494
495
496
497
498
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
499
500
501
502
503
504
505
506
507
508
509
510
511
512
  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
513
}
Dries's avatar
   
Dries committed
514

515
/**
Dries's avatar
   
Dries committed
516
517
518
519
520
521
522
523
524
525
 * 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) {
526
527
528
529
530
  $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
531
532
}

533
/**
Dries's avatar
   
Dries committed
534
535
536
537
538
539
540
541
542
 * 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
543
 *   The returned value of the invoked hook.
Dries's avatar
   
Dries committed
544
545
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
546
  if (node_hook($node, $hook)) {
547
548
549
550
551
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
   
Dries committed
552
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
   
Dries committed
553
554
555
  }
}

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

Dries's avatar
   
Dries committed
583
584
585
/**
 * Load a node object from the database.
 *
586
587
 * @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
588
589
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
   
Dries committed
590
591
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
   
Dries committed
592
593
594
595
 *
 * @return
 *   A fully-populated node object.
 */
596
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
   
Dries committed
597
598
599
600
601
602
  static $nodes = array();

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

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

Dries's avatar
   
Dries committed
624
  // Retrieve the node.
625
  // No db_rewrite_sql is applied so as to get complete indexing for search.
626
  if ($revision) {
627
    array_unshift($arguments, $revision);
628
    $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's avatar
   
Dries committed
629
  }
630
  else {
631
    $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's avatar
   
Dries committed
632
633
  }

634
  if ($node && $node->nid) {
635
636
637
638
639
640
    // 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
641
642
    }

643
644
645
646
647
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
648
649
650
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
   
Dries committed
651
652
  }

Dries's avatar
   
Dries committed
653
654
655
  return $node;
}

Dries's avatar
   
Dries committed
656
657
658
/**
 * Save a node object into the database.
 */
659
function node_save(&$node) {
660
661
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
662
  global $user;
Dries's avatar
   
Dries committed
663

664
  $node->is_new = FALSE;
Dries's avatar
   
Dries committed
665

Dries's avatar
   
Dries committed
666
  // Apply filters to some default node fields:
Dries's avatar
   
Dries committed
667
  if (empty($node->nid)) {
Dries's avatar
   
Dries committed
668
    // Insert a new node.
669
    $node->is_new = TRUE;
670
671
672
673
674
675
  }
  else {
    // We need to ensure that all node fields are filled.
    $node_current = node_load($node->nid);
    foreach ($node as $field => $data) {
      $node_current->$field = $data;
Dries's avatar
   
Dries committed
676
    }
677
    $node = $node_current;
Dries's avatar
   
Dries committed
678

679
    if (!empty($node->revision)) {
680
681
      $node->old_vid = $node->vid;
    }
Dries's avatar
   
Dries committed
682
683
  }

684
685
686
687
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
688
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
689
  $node->changed = time();
Dries's avatar
   
Dries committed
690

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

758
759
760
761
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

762
763
764
  // Update the node access table for this node.
  node_access_acquire_grants($node);

Dries's avatar
   
Dries committed
765
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
   
Dries committed
766
  cache_clear_all();
Dries's avatar
   
Dries committed
767
768
}

Dries's avatar
   
Dries committed
769
770
771
772
773
774
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
775
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
   
Dries committed
776
777
 * @param $page
 *   Whether the node is being displayed by itself as a page.
778
779
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
   
Dries committed
780
781
782
783
 *
 * @return
 *   An HTML representation of the themed node.
 */
784
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
785
  $node = (object)$node;
Dries's avatar
   
Dries committed
786

787
788
  $node = node_build_content($node, $teaser, $page);

789
790
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
791
    drupal_alter('link', $node->links, $node);
792
  }
793
794
795
796

  // 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);
797
  if ($teaser) {
798
    $node->teaser = $content;
799
800
801
    unset($node->body);
  }
  else {
802
    $node->body = $content;
803
804
    unset($node->teaser);
  }
Dries's avatar
   
Dries committed
805

806
807
808
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
   
Dries committed
809
  return theme('node', $node, $teaser, $page);
Dries's avatar
   
Dries committed
810
}
Dries's avatar
   
Dries committed
811

Dries's avatar
   
Dries committed
812
/**
813
 * Apply filters and build the node's standard elements.
Dries's avatar
   
Dries committed
814
 */
Dries's avatar
   
Dries committed
815
function node_prepare($node, $teaser = FALSE) {
816
817
818
  // 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.
819
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
820
821
822
823
824
825
826
827

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

828
  $node->content['body'] = array(
829
    '#value' => $teaser ? $node->teaser : $node->body,
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
    '#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) {
851
852
853
854
855
856

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

857
  // Remove the delimiter (if any) that separates the teaser from the body.
858
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
859
860
861
862
863

  // 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
864
865
  }
  else {
866
    $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
867
  }
868
869
870
871

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

Dries's avatar
   
Dries committed
872
  return $node;
Dries's avatar
   
Dries committed
873
874
}

Dries's avatar
   
Dries committed
875
876
877
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
   
Dries committed
878
function node_show($node, $cid) {
Dries's avatar
   
Dries committed
879
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
   
Dries committed
880

Dries's avatar
   
Dries committed
881
882
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
   
Dries committed
883
884
  }

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

Dries's avatar
   
Dries committed
888
  return $output;
Dries's avatar
   
Dries committed
889
890
}

Dries's avatar
   
Dries committed
891
892
893
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
894
function node_perm() {
895
896
897
898
  $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions');

  foreach (node_get_types() as $type) {
    if ($type->module == 'node') {
899
      $name = check_plain($type->type);
900
      $perms[] = 'create '. $name .' content';
901
902
      $perms[] = 'delete own '. $name .' content';
      $perms[] = 'delete '. $name .' content';
903
904
905
906
907
908
      $perms[] = 'edit own '. $name .' content';
      $perms[] = 'edit '. $name .' content';
    }
  }

  return $perms;
Dries's avatar
   
Dries committed
909
910
}

Dries's avatar
   
Dries committed
911
912
913
/**
 * Implementation of hook_search().
 */
914
function node_search($op = 'search', $keys = NULL) {
915
916
  switch ($op) {
    case 'name':
917
      return t('Content');
918

Dries's avatar
Dries committed
919
920
    case 'reset':
      variable_del('node_cron_last');
921
      variable_del('node_cron_last_nid');
Dries's avatar
Dries committed
922
      return;
923

924
925
    case 'status':
      $last = variable_get('node_cron_last', 0);
926
      $last_nid = variable_get('node_cron_last_nid', 0);
927
928
      $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));
929
      return array('remaining' => $remaining, 'total' => $total);
930
931
932
933
934
935

    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';
936
      $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>');
937
938
939

      $ranking = array('node_rank_relevance' => t('Keyword relevance'),
                       'node_rank_recent' => t('Recently posted'));
940
      if (module_exists('comment')) {
941
942
        $ranking['node_rank_comments'] = t('Number of comments');
      }
943
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
944
945
946
947
948
949
950
951
952
953
        $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;

954
    case 'search':
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
      // 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
987
      $stats_join = FALSE;
988
      $total = 0;
989
990
991
992
      if ($weight = (int)variable_get('node_rank_relevance', 5)) {
        // Average relevance values hover around 0.15
        $ranking[] = '%d * i.relevance';
        $arguments2[] = $weight;
993
        $total += $weight;
994
995
996
997
998
999
1000
      }
      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';
1001
        $stats_join = TRUE;
1002
        $total += $weight;
1003
      }
1004
      if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
1005
1006
1007
1008
1009
1010
1011
1012
        // 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';
        }
1013
        $total += $weight;
1014
      }
1015
      if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
1016
1017
1018
1019
1020
1021
          $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;
1022
        $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
1023
        $total += $weight;
1024
      }
1025
      $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') .' AS score';
1026
1027
1028
1029
1030

      // 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
1031
1032
      $results = array();
      foreach ($find as $item) {
1033
        // Build the node body.
1034
        $node = node_load($item->sid);
1035
        $node->build_mode = NODE_BUILD_SEARCH_RESULT;
1036
1037
        $node = node_build_content($node, FALSE, FALSE);
        $node->body = drupal_render($node->content);
1038

1039
1040
        // Fetch comments for snippet
        $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
1041
1042
        // Fetch terms for snippet
        $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
1043

Dries's avatar
Dries committed
1044
        $extra = node_invoke_nodeapi($node, 'search result');
1045
        $results[] = array('link' => url('node/'. $item->sid, array('absolute' => TRUE)),
1046
                           'type' => node_get_types('name', $node),
1047
                           'title' => $node->title,
1048
                           'user' => theme('username', $node),
1049
                           'date' => $node->changed,
1050
                           'node' => $node,
Dries's avatar
Dries committed
1051
                           'extra' => $extra,
1052
                           'score' => $item->score / $total,
1053
                           'snippet' => search_excerpt($keys, $node->body));
1054
1055
1056
      }
      return $results;
  }
Dries's avatar
   
Dries committed
1057
1058
}

1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
/**
 * Implementation of hook_user().
 */
function node_user($op, &$edit, &$user) {
  if ($op == 'delete') {
    db_query('UPDATE {node} SET uid = 0 WHERE uid = %d', $user->uid);
    db_query('UPDATE {node_revisions} SET uid = 0 WHERE uid = %d', $user->uid);
  }
}

1069
function theme_node_search_admin($form) {
1070
  $output = drupal_render($form['info']);
1071
1072
1073
1074
1075
1076

  $header = array(t('Factor'), t('Weight'));
  foreach (element_children($form['factors']) as $key) {
    $row = array();
    $row[] = $form['factors'][$key]['#title'];
    unset($form['factors'][$key]['#title']);
1077
    $row[] = drupal_render($form['factors'][$key]);
1078
1079
1080
1081
    $rows[] = $row;
  }
  $output .= theme('table', $header, $rows);

1082
  $output .= drupal_render($form);
1083
1084
1085
  return $output;
}

Dries's avatar
   
Dries committed
1086
/**
Dries's avatar
   
Dries committed
1087
 * Menu callback; presents general node configuration options.
Dries's avatar
   
Dries committed
1088
1089
 */
function node_configure() {