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

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

10
11
12
13
14
15
/**
 * Nodes changed before this time are always marked as read.
 *
 * Nodes changed after this time may be marked new, updated, or read, depending
 * on their state for the current user. Defaults to 30 days ago.
 */
16
define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
17

18
19
20
/**
 * Node is being built before being viewed normally.
 */
21
define('NODE_BUILD_NORMAL', 0);
22
23
24
25

/**
 * Node is being built before being previewed.
 */
26
define('NODE_BUILD_PREVIEW', 1);
27
28
29
30

/**
 * Node is being built before being indexed by search module.
 */
31
define('NODE_BUILD_SEARCH_INDEX', 2);
32
33
34
35

/**
 * Node is being built before being displayed as a search result.
 */
36
define('NODE_BUILD_SEARCH_RESULT', 3);
37
38
39
40

/**
 * Node is being built before being displayed as part of an RSS feed.
 */
41
define('NODE_BUILD_RSS', 4);
42
43
44
45

/**
 * Node is being built before being printed.
 */
46
define('NODE_BUILD_PRINT', 5);
47

Dries Buytaert's avatar
   
Dries Buytaert committed
48
49
50
/**
 * Implementation of hook_help().
 */
51
function node_help($path, $arg) {
52
53
54
55
  // Remind site administrators about the {node_access} table being flagged
  // for rebuild. We don't need to issue the message on the confirm form, or
  // while the rebuild is being processed.
  if ($path != 'admin/content/node-settings/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
56
57
58
59
60
61
62
63
64
65
      && 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');
  }

66
  switch ($path) {
Dries Buytaert's avatar
   
Dries Buytaert committed
67
    case 'admin/help#node':
68
69
70
71
      $output = '<p>' . t('The node module manages content on your site, and stores all posts (regardless of type) as a "node" . In addition to basic publishing settings, including whether the post has been published, promoted to the site front page, or should remain present (or sticky) at the top of lists, the node module also records basic information about the author of a post. Optional revision control over edits is available. For additional functionality, the node module is often extended by other modules.') . '</p>';
      $output .= '<p>' . t('Though each post on your site is a node, each post is also of a particular <a href="@content-type">content type</a>. <a href="@content-type">Content types</a> are used to define the characteristics of a post, including the title and description of the fields displayed on its add and edit pages. Each content type may have different default settings for <em>Publishing options</em> and other workflow controls. By default, the two content types in a standard Drupal installation are <em>Page</em> and <em>Story</em>. Use the <a href="@content-type">content types page</a> to add new or edit existing content types. Additional content types also become available as you enable additional core, contributed and custom modules.', array('@content-type' => url('admin/build/types'))) . '</p>';
      $output .= '<p>' . t('The administrative <a href="@content">content page</a> allows you to review and manage your site content. The <a href="@post-settings">post settings page</a> sets certain options for the display of posts. The node module makes a number of permissions available for each content type, which may be set by role on the <a href="@permissions">permissions page</a>.', array('@content' => url('admin/content/node'), '@post-settings' => url('admin/content/node-settings'), '@permissions' => url('admin/user/permissions'))) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) . '</p>';
Dries Buytaert's avatar
   
Dries Buytaert committed
72
      return $output;
73
74
    case 'admin/content/node':
      return ' '; // Return a non-null value so that the 'more help' link is shown.
75
    case 'admin/build/types':
76
      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>';
77
    case 'admin/build/types/add':
78
      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>';
79
    case 'node/%/revisions':
80
      return '<p>' . t('The revisions let you track differences between multiple versions of a post.') . '</p>';
81
82
83
    case 'node/%/edit':
      $node = node_load($arg[1]);
      $type = node_get_types('type', $node->type);
84
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries Buytaert's avatar
   
Dries Buytaert committed
85
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
86

87
88
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
    $type = node_get_types('type', str_replace('-', '_', $arg[2]));
89
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
90
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
91
92
}

93
/**
94
 * Implementation of hook_theme().
95
96
97
 */
function node_theme() {
  return array(
98
99
    'node' => array(
      'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
100
      'template' => 'node',
101
    ),
102
103
104
105
106
107
108
109
    '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),
110
      'file' => 'node.admin.inc',
111
112
113
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
114
      'file' => 'node.admin.inc',
115
116
117
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
118
119
120
121
122
      'file' => 'node.admin.inc',
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
      'file' => 'node.pages.inc',
123
124
125
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
126
      'file' => 'node.pages.inc',
127
128
129
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
130
      'file' => 'node.pages.inc',
131
132
133
134
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
135
136
137
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
138
139
140
    'node_admin_overview' => array(
      'arguments' => array('name' => NULL, 'type' => NULL),
    ),
141
142
143
  );
}

Dries Buytaert's avatar
   
Dries Buytaert committed
144
145
146
/**
 * Implementation of hook_cron().
 */
147
function node_cron() {
Dries Buytaert's avatar
   
Dries Buytaert committed
148
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
149
150
}

Dries Buytaert's avatar
   
Dries Buytaert committed
151
152
153
154
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
155
156
157
158
 *   A DB result object from a query to fetch node objects. If your query
 *   joins the <code>node_comment_statistics</code> table so that the
 *   <code>comment_count</code> field is available, a title attribute will
 *   be added to show the number of comments.
Dries Buytaert's avatar
   
Dries Buytaert committed
159
160
161
162
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
163
164
 *   An HTML list suitable as content for a block, or FALSE if no result can
 *   fetch from DB result object.
Dries Buytaert's avatar
   
Dries Buytaert committed
165
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
166
function node_title_list($result, $title = NULL) {
167
  $items = array();
168
  $num_rows = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
169
  while ($node = db_fetch_object($result)) {
170
    $items[] = l($node->title, 'node/' . $node->nid, !empty($node->comment_count) ? array('attributes' => array('title' => format_plural($node->comment_count, '1 comment', '@count comments'))) : array());
171
    $num_rows = TRUE;
Dries Buytaert's avatar
   
Dries Buytaert committed
172
173
  }

174
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
175
176
}

Dries Buytaert's avatar
   
Dries Buytaert committed
177
178
/**
 * Format a listing of links to nodes.
179
180
 *
 * @ingroup themeable
Dries Buytaert's avatar
   
Dries Buytaert committed
181
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
182
function theme_node_list($items, $title = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
183
  return theme('item_list', $items, $title);
Dries Buytaert's avatar
   
Dries Buytaert committed
184
185
}

Dries Buytaert's avatar
   
Dries Buytaert committed
186
187
188
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
189
190
191
192
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
193
    if (node_last_viewed($nid)) {
194
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', REQUEST_TIME, $user->uid, $nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
195
196
    }
    else {
197
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, REQUEST_TIME);
Dries Buytaert's avatar
   
Dries Buytaert committed
198
199
200
201
    }
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
202
203
204
205
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
206
207
function node_last_viewed($nid) {
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
208
  static $history;
Dries Buytaert's avatar
   
Dries Buytaert committed
209

Dries Buytaert's avatar
   
Dries Buytaert committed
210
  if (!isset($history[$nid])) {
211
    $history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = %d AND nid = %d", $user->uid, $nid));
Dries Buytaert's avatar
   
Dries Buytaert committed
212
213
  }

214
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries Buytaert's avatar
   
Dries Buytaert committed
215
216
217
}

/**
218
 * Decide on the type of marker to be displayed for a given node.
Dries Buytaert's avatar
   
Dries Buytaert committed
219
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
220
221
222
223
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
224
225
 * @return
 *   One of the MARK constants.
Dries Buytaert's avatar
   
Dries Buytaert committed
226
 */
227
function node_mark($nid, $timestamp) {
Dries Buytaert's avatar
   
Dries Buytaert committed
228
229
230
  global $user;
  static $cache;

231
232
233
  if (!$user->uid) {
    return MARK_READ;
  }
Dries Buytaert's avatar
Dries Buytaert committed
234
  if (!isset($cache[$nid])) {
235
    $cache[$nid] = node_last_viewed($nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
236
  }
237
238
239
240
241
242
243
  if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
    return MARK_NEW;
  }
  elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
    return MARK_UPDATED;
  }
  return MARK_READ;
Dries Buytaert's avatar
   
Dries Buytaert committed
244
245
}

246
247
248
/**
 * See if the user used JS to submit a teaser.
 */
249
function node_teaser_js(&$form, &$form_state) {
250
  if (isset($form['#post']['teaser_js'])) {
251
    // Glue the teaser to the body.
252
    if (trim($form_state['values']['teaser_js'])) {
253
      // Space the teaser from the body
254
      $body = trim($form_state['values']['teaser_js']) . "\r\n<!--break-->\r\n" . trim($form_state['values']['body']);
255
256
257
    }
    else {
      // Empty teaser, no spaces.
258
      $body = '<!--break-->' . $form_state['values']['body'];
259
    }
260
    // Pass updated body value on to preview/submit form processing.
261
    form_set_value($form['body'], $body, $form_state);
262
263
    // Pass updated body value back onto form for those cases
    // in which the form is redisplayed.
264
265
266
267
268
    $form['body']['#value'] = $body;
  }
  return $form;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
269
/**
270
 * Ensure value of "teaser_include" checkbox is consistent with other form data.
271
272
273
274
275
276
277
278
 *
 * This handles two situations in which an unchecked checkbox is rejected:
 *
 *   1. The user defines a teaser (summary) but it is empty;
 *   2. The user does not define a teaser (summary) (in this case an
 *      unchecked checkbox would cause the body to be empty, or missing
 *      the auto-generated teaser).
 *
279
 * If JavaScript is active then it is used to force the checkbox to be
280
281
282
283
284
285
 * checked when hidden, and so the second case will not arise.
 *
 * In either case a warning message is output.
 */
function node_teaser_include_verify(&$form, &$form_state) {
  $message = '';
286

287
288
289
290
  // $form['#post'] is set only when the form is built for preview/submit.
  if (isset($form['#post']['body']) && isset($form_state['values']['teaser_include']) && !$form_state['values']['teaser_include']) {
    // "teaser_include" checkbox is present and unchecked.
    if (strpos($form_state['values']['body'], '<!--break-->') === 0) {
291
      // Teaser is empty string.
292
293
294
295
296
297
      $message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting is ignored when the summary is empty.');
    }
    elseif (strpos($form_state['values']['body'], '<!--break-->') === FALSE) {
      // Teaser delimiter is not present in the body.
      $message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting has been ignored since you have not defined a summary for the post. (To define a summary, insert the delimiter "&lt;!--break--&gt;" (without the quotes) in the Body of the post to indicate the end of the summary and the start of the main content.)');
    }
298

299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
    if (!empty($message)) {
      drupal_set_message($message, 'warning');
      // Pass new checkbox value on to preview/submit form processing.
      form_set_value($form['teaser_include'], 1, $form_state);
      // Pass new checkbox value back onto form for those cases
      // in which form is redisplayed.
      $form['teaser_include']['#value'] = 1;
    }
  }

  return $form;
}

/**
 * Generate a teaser for a node body.
314
 *
315
 * If the end of the teaser is not indicated using the <!--break--> delimiter
316
317
318
 * then we generate the teaser automatically, trying to end it at a sensible
 * place such as the end of a paragraph, a line break, or the end of a
 * sentence (in that order of preference).
319
 *
320
321
322
323
 * @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
324
325
 *   split it up to prevent parse errors. If the line break filter is present
 *   then we treat newlines embedded in $body as line breaks.
326
 * @param $size
327
 *   The desired character length of the teaser. If omitted, the default
328
 *   value will be used. Ignored if the special delimiter is present
329
 *   in $body.
330
331
 * @return
 *   The generated teaser.
Dries Buytaert's avatar
   
Dries Buytaert committed
332
 */
333
function node_teaser($body, $format = NULL, $size = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
334

335
336
337
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
338

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

342
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
343
  if ($size == 0 && $delimiter === FALSE) {
Dries Buytaert's avatar
   
Dries Buytaert committed
344
345
    return $body;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
346

347
348
349
350
351
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

352
353
354
355
356
  // 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);
357
    if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
358
359
      return $body;
    }
360
361
  }

362
  // If we have a short body, the entire body is the teaser.
363
  if (drupal_strlen($body) <= $size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
364
365
366
    return $body;
  }

367
368
369
  // If the delimiter has not been specified, try to split at paragraph or
  // sentence boundaries.

370
371
  // The teaser may not be longer than maximum length specified. Initial slice.
  $teaser = truncate_utf8($body, $size);
372
373
374
375
376
377
378
379
380
381
382
383

  // Store the actual length of the UTF8 string -- which might not be the same
  // as $size.
  $max_rpos = strlen($teaser);

  // How much to cut off the end of the teaser so that it doesn't end in the
  // middle of a paragraph, sentence, or word.
  // Initialize it to maximum in order to find the minimum.
  $min_rpos = $max_rpos;

  // Store the reverse of the teaser.  We use strpos on the reversed needle and
  // haystack for speed and convenience.
384
385
  $reversed = strrev($teaser);

386
387
388
389
390
391
  // Build an array of arrays of break points grouped by preference.
  $break_points = array();

  // A paragraph near the end of sliced teaser is most preferable.
  $break_points[] = array('</p>' => 0);

392
393
394
395
396
397
398
399
  // If no complete paragraph then treat line breaks as paragraphs.
  $line_breaks = array('<br />' => 6, '<br>' => 4);
  // Newline only indicates a line break if line break converter
  // filter is present.
  if (isset($filters['filter/1'])) {
    $line_breaks["\n"] = 1;
  }
  $break_points[] = $line_breaks;
400
401
402
403
404
405
406
407
408
409
410
411
412

  // If the first paragraph is too long, split at the end of a sentence.
  $break_points[] = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);

  // Iterate over the groups of break points until a break point is found.
  foreach ($break_points as $points) {
    // Look for each break point, starting at the end of the teaser.
    foreach ($points as $point => $offset) {
      // The teaser is already reversed, but the break point isn't.
      $rpos = strpos($reversed, strrev($point));
      if ($rpos !== FALSE) {
        $min_rpos = min($rpos + $offset, $min_rpos);
      }
413
    }
Dries Buytaert's avatar
Dries Buytaert committed
414

415
416
417
418
    // If a break point was found in this group, slice and return the teaser.
    if ($min_rpos !== $max_rpos) {
      // Don't slice with length 0.  Length must be <0 to slice from RHS.
      return ($min_rpos === 0) ? $teaser : substr($teaser, 0, 0 - $min_rpos);
419
420
    }
  }
421
422
423

  // If a break point was not found, still return a teaser.
  return $teaser;
Dries Buytaert's avatar
   
Dries Buytaert committed
424
425
}

426
427
428
429
430
431
/**
 * 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',
432
 *   'base', or 'name', only the specified node type is returned. When set to
433
434
435
436
437
438
439
440
441
442
 *   '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
443
 *   variable format. Returns FALSE if the node type is not found.
444
445
446
 */
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
  static $_node_types, $_node_names;
447

448
449
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
450
  }
451

452
453
454
455
456
457
458
459
460
461
  if ($node) {
    if (is_array($node)) {
      $type = $node['type'];
    }
    elseif (is_object($node)) {
      $type = $node->type;
    }
    elseif (is_string($node)) {
      $type = $node;
    }
462
    if (!isset($_node_types[$type])) {
463
464
465
466
      return FALSE;
    }
  }
  switch ($op) {
467
468
469
    case 'types':
      return $_node_types;
    case 'type':
470
      return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
471
472
    case 'base':
      return isset($_node_types[$type]->base) ? $_node_types[$type]->base : FALSE;
473
474
    case 'names':
      return $_node_names;
475
    case 'name':
476
      return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
  }
}

/**
 * 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);
    }
493
494
495
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
496
  }
497
498

  _node_types_build();
499
500
}

501
/**
502
503
504
505
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries Buytaert's avatar
   
Dries Buytaert committed
506
507
 *
 * @return
508
 *   Status flag indicating outcome of the operation.
Dries Buytaert's avatar
   
Dries Buytaert committed
509
 */
510
511
512
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
513
  $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
  $type = node_type_set_defaults($info);

  $fields = array(
    'type' => (string) $type->type,
    'name' => (string) $type->name,
    'base' => (string) $type->base,
    'has_title' => (int) $type->has_title,
    'title_label' => (string) $type->title_label,
    'has_body' => (int) $type->has_body,
    'body_label' => (string) $type->body_label,
    'description' => (string) $type->description,
    'help' => (string) $type->help,
    'min_word_count' => (int) $type->min_word_count,
    'custom' => (int) $type->custom,
    'modified' => (int) $type->modified,
    'locked' => (int) $type->locked,
  );
531
532

  if ($is_existing) {
533
    db_update('node_type')->fields($fields)->condition('type', $existing_type)->execute();
534

535
    module_invoke_all('node_type', 'update', $type);
536
537
538
    return SAVED_UPDATED;
  }
  else {
539
540
    $fields['orig_type'] = (string) $type->orig_type;
    db_insert('node_type')->fields($fields)->execute();
541

542
    module_invoke_all('node_type', 'insert', $type);
543
544
    return SAVED_NEW;
  }
545
}
546

547
548
549
550
551
552
553
554
/**
 * 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) {
  $info = node_get_types('type', $type);
555
  db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
556
557
558
  module_invoke_all('node_type', 'delete', $info);
}

559
/**
560
561
 * Updates all nodes of one type to be of another type.
 *
562
 * @param $old_type
563
564
565
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
566
567
 *
 * @return
568
 *   The number of nodes whose node type field was modified.
569
 */
570
571
572
function node_type_update_nodes($old_type, $type) {
  db_query("UPDATE {node} SET type = '%s' WHERE type = '%s'", $type, $old_type);
  return db_affected_rows();
Dries Buytaert's avatar
   
Dries Buytaert committed
573
}
Dries Buytaert's avatar
   
Dries Buytaert committed
574

575
/**
576
577
578
579
 * Builds and returns the list of available node types.
 *
 * The list of types is built by querying hook_node_info() in all modules, and
 * by comparing this information with the node types in the {node_type} table.
Dries Buytaert's avatar
   
Dries Buytaert committed
580
581
 *
 */
582
583
584
585
586
587
588
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;
589
    $_node_types[$type] = node_type_set_defaults($info);
590
591
592
593
594
    $_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)) {
595
596
    // 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
597
598
599
    // module using hook_node_info) have a base value of 'node_content'. The isset()
    // check prevents errors on old (pre-Drupal 7) databases.
    if (isset($type_object->base) && $type_object->base != 'node_content' && empty($info_array[$type_object->type])) {
600
      $type_object->disabled = TRUE;
601
    }
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
    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);
}

/**
619
620
621
622
623
624
625
626
627
628
629
 * Set the default values for a node type.
 *
 * The defaults are for a type defined through hook_node_info().
 * When populating a custom node type $info should have the 'custom'
 * key set to 1.
 *
 * @param $info
 *   An object or array containing values to override the defaults.
 *
 * @return
 *  A node type object.
630
 */
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
function node_type_set_defaults($info = array()) {
  static $type;

  if (!isset($type)) {
    $type = new stdClass();
    $type->type = '';
    $type->name = '';
    $type->base = '';
    $type->description = '';
    $type->help = '';
    $type->min_word_count = 0;
    $type->has_title = 1;
    $type->has_body = 1;
    $type->title_label = t('Title');
    $type->body_label = t('Body');
    $type->custom = 0;
    $type->modified = 0;
    $type->locked = 1;
    $type->is_new = 1;
  }

  $new_type = clone $type;
  $info = (array) $info;
  foreach ($info as $key => $data) {
    $new_type->$key = $data;
  }
  // If the type has no title or body, set an empty label.
  if (!$new_type->has_title) {
    $new_type->title_label = '';
  }
  if (!$new_type->has_body) {
    $new_type->body_label = '';
  }
  $new_type->orig_type = isset($info['type']) ? $info['type'] : '';

  return $new_type;
Dries Buytaert's avatar
   
Dries Buytaert committed
667
}
Dries Buytaert's avatar
   
Dries Buytaert committed
668

669
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
670
671
672
673
674
675
676
677
678
679
 * 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) {
680
681
  $base = node_get_types('base', $node);
  return module_hook($base, $hook);
Dries Buytaert's avatar
   
Dries Buytaert committed
682
683
}

684
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
685
686
687
688
689
690
691
692
693
 * Invoke a node hook.
 *
 * @param &$node
 *   Either a node object, node array, or a string containing the node type.
 * @param $hook
 *   A string containing the name of the hook.
 * @param $a2, $a3, $a4
 *   Arguments to pass on to the hook, after the $node argument.
 * @return
Dries Buytaert's avatar
   
Dries Buytaert committed
694
 *   The returned value of the invoked hook.
Dries Buytaert's avatar
   
Dries Buytaert committed
695
696
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
697
  if (node_hook($node, $hook)) {
698
699
    $base = node_get_types('base', $node);
    $function = $base . '_' . $hook;
Dries Buytaert's avatar
   
Dries Buytaert committed
700
    return ($function($node, $a2, $a3, $a4));
Dries Buytaert's avatar
   
Dries Buytaert committed
701
702
703
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
704
705
706
707
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries Buytaert's avatar
   
Dries Buytaert committed
708
 *   A node object.
Dries Buytaert's avatar
   
Dries Buytaert committed
709
710
711
712
713
714
715
 * @param $op
 *   A string containing the name of the nodeapi operation.
 * @param $a3, $a4
 *   Arguments to pass on to the hook, after the $node and $op arguments.
 * @return
 *   The returned value of the invoked hooks.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
716
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
717
  $return = array();
718
  $hook = 'nodeapi_' . $op;
719
720
  foreach (module_implements($hook) as $module) {
    $function = $module . '_' . $hook;
721
    $result = $function($node, $a3, $a4);
722
    if (isset($result) && is_array($result)) {
723
724
      $return = array_merge($return, $result);
    }
725
    elseif (isset($result)) {
726
      $return[] = $result;
Dries Buytaert's avatar
   
Dries Buytaert committed
727
728
729
730
731
    }
  }
  return $return;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
732
/**
733
734
735
736
737
 * Load node objects from the database.
 *
 * This function should be used whenever you need to load more than one node
 * from the database. Nodes are loaded into memory and will not require
 * database access if loaded again during the same page request.
Dries Buytaert's avatar
   
Dries Buytaert committed
738
 *
739
740
741
742
 * @param $nids
 *   An array of node IDs.
 * @param $conditions
 *   An array of conditions on the {node} table in the form 'field' => $value.
Dries Buytaert's avatar
   
Dries Buytaert committed
743
744
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries Buytaert's avatar
   
Dries Buytaert committed
745
746
 *
 * @return
747
 *   An array of node objects indexed by nid.
Dries Buytaert's avatar
   
Dries Buytaert committed
748
 */
749
750
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
  static $node_cache = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
751
  if ($reset) {
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
    $node_cache = array();
  }
  $nodes = array();

  // Create a new variable which is either a prepared version of the $nids
  // array for later comparison with the node cache, or FALSE if no $nids were
  // passed. The $nids array is reduced as items are loaded from cache, and we
  // need to know if it's empty for this reason to avoid querying the database
  // when all requested nodes are loaded from cache.
  $passed_nids = !empty($nids) ? array_flip($nids) : FALSE;

  // Revisions are not statically cached, and require a different query to
  // other conditions, so separate vid into its own variable.
  $vid = isset($conditions['vid']) ? $conditions['vid'] : FALSE;
  unset($conditions['vid']);

  // Load any available nodes from the internal cache.
  if ($node_cache && !$vid) {
    if ($nids) {
      $nodes += array_intersect_key($node_cache, $passed_nids);
      // If any nodes were loaded, remove them from the $nids still to load.
      $nids = array_keys(array_diff_key($passed_nids, $nodes));
    }
    // If loading nodes only by conditions, fetch all available nodes from
    // the cache. Nodes which don't match are removed later.
    elseif ($conditions) {
      $nodes = $node_cache;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
780
781
  }

782
783
784
785
786
787
788
  // Exclude any nodes loaded from cache if they don't match $conditions.
  // This ensures the same behaviour whether loading from memory or database.
  if ($conditions) {
    foreach ($nodes as $node) {
      $node_values = (array) $node;
      if (array_diff_assoc($conditions, $node_values)) {
        unset($nodes[$node->nid]);
789
      }
790
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
791
792
  }

793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
  // Load any remaining nodes from the database. This is the case if there are
  // any $nids left to load, if loading a revision, or if $conditions was
  // passed without $nids.
  if ($nids || $vid || ($conditions && !$passed_nids)) {
    $query = db_select('node', 'n');

    if ($vid) {
      $query->join('node_revision', 'r', 'r.nid = n.nid AND r.vid = :vid', array(':vid' => $vid));
    }
    else {
      $query->join('node_revision', 'r', 'r.vid = n.vid');
    }
    $query->join('users', 'u', 'u.uid = n.uid');

    // Add fields from the {node} table.
    $node_fields = drupal_schema_fields_sql('node');

    // vid and title are provided by node_revision, so remove them.
    unset($node_fields['vid']);
    unset($node_fields['title']);
    $query->fields('n', $node_fields);

    // Add all fields from the {node_revision} table.
    $node_revision_fields = drupal_schema_fields_sql('node_revision');

    // nid is provided by node, so remove it.
    unset($node_revision_fields['nid']);

    // Change timestamp to revision_timestamp before adding it to the query.
    unset($node_revision_fields['timestamp']);
    $query->addField('r', 'timestamp', 'revision_timestamp');
    $query->fields('r', $node_revision_fields);

    // Add fields from the {users} table.
    $user_fields = array('name', 'picture', 'data');
    $query->fields('u', $user_fields);

    if ($nids) {
      $query->condition('n.nid', $nids, 'IN');
    }
    if ($conditions) {
      foreach ($conditions as $field => $value) {
        $query->condition('n.' . $field, $value);
836
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
837
    }
838
839
840
841
842
843
844
845
846
847
848
849
    $queried_nodes = $query->execute()->fetchAllAssoc('nid');
  }

  // Pass all nodes loaded from the database through the node type specific
  // callbacks and hook_nodeapi_load(), then add them to the internal cache.
  if (!empty($queried_nodes)) {
    // Create an array of nodes for each content type and pass this to the
    // node type specific callback.
    $typed_nodes = array();
    foreach ($queried_nodes as $nid => $node) {
      $typed_nodes[$node->type][$nid] = $node;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
850

851
852
853
854
855
    // Call node type specific callbacks on each typed array of nodes.
    foreach ($typed_nodes as $type => $nodes_of_type) {
      if (node_hook($type, 'load')) {
        $function = node_get_types('base', $type) . '_load';
        $function($nodes_of_type);
856
857
      }
    }
858
859
860
861
862
863
864
865
866
867
868

    // Call hook_nodeapi_load(), pass the node types so modules can return early
    // if not acting on types in the array.
    foreach (module_implements('nodeapi_load') as $module) {
      $function = $module . '_nodeapi_load';
      $function($queried_nodes, array_keys($typed_nodes));
    }
    $nodes += $queried_nodes;
    // Add nodes to the cache if we're not loading a revision.
    if (!$vid) {
      $node_cache += $queried_nodes;
869
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
870
871
  }

872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
  // Ensure that the returned array is ordered the same as the original $nids
  // array if this was passed in and remove any invalid nids.
  if ($passed_nids) {
    // Remove any invalid nids from the array.
    $passed_nids = array_intersect_key($passed_nids, $nodes);
    foreach ($nodes as $node) {
      $passed_nids[$node->nid] = $node;
    }
    $nodes = $passed_nids;
  }

  return $nodes;
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
 *   Whether to reset the internal node_load cache.
 *
 * @return
 *   A fully-populated node object.
 */
function node_load($nid, $vid = array(), $reset = FALSE) {
  $vid = isset($vid) ? array('vid' => $vid) : NULL;
  $node = node_load_multiple(array($nid), $vid, $reset);

  return $node ? $node[$nid] : FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
904
905
}

906
907
908
909
910
911
912
913
914
/**
 * 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.
915
  // TODO : use a better word counting algorithm that will work in other languages
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
  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)));
    }

933
934
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
      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;

953
  // Generate the teaser, but only if it hasn't been set (e.g. by a
954
955
956
  // module-provided 'teaser' form item).
  if (!isset($node->teaser)) {
    if (isset($node->body)) {
957
      $node->format = (!empty($node->body_format) ? $node->body_format : FILTER_FORMAT_DEFAULT);
958
      $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
959
960
961
962
      // Chop off the teaser from the body if needed. The teaser_include
      // property might not be set (eg. in Blog API postings), so only act on
      // it, if it was set with a given value.
      if (isset($node->teaser_include) && !$node->teaser_include && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
        $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;
    }
  }
980
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
981
982
983
984
985
  $node->validated = TRUE;

  return $node;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
986
987
988
/**
 * Save a node object into the database.
 */
989
function node_save(&$node) {
990
991
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
992
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
993

994
  $node->is_new = FALSE;
Dries Buytaert's avatar
   
Dries Buytaert committed
995

Dries Buytaert's avatar
   
Dries Buytaert committed
996
  // Apply filters to some default node fields:
Dries Buytaert's avatar
   
Dries Buytaert committed
997
  if (empty($node->nid)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
998
    // Insert a new node.
999
    $node->is_new = TRUE;
1000

For faster browsing, not all history is shown. View entire blame