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

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

59 60 61 62 63
/**
 * Implementation of hook_theme()
 */
function node_theme() {
  return array(
64 65 66 67
    'node' => array(
      'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
      'file' => 'node',
    ),
68 69 70 71 72 73 74 75
    '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),
76 77
      'file' => 'node.admin.inc',
      'function' => 'theme_node_filter_form',
78 79 80
    ),
    'node_filters' => array(
      'arguments' => array('form' => NULL),
81 82
      'file' => 'node.admin.inc',
      'function' => 'theme_node_filters',
83 84 85
    ),
    'node_admin_nodes' => array(
      'arguments' => array('form' => NULL),
86 87 88 89 90 91 92
      'file' => 'node.admin.inc',
      'function' => 'theme_node_admin_nodes',
    ),
    'node_add_list' => array(
      'arguments' => array('content' => NULL),
      'file' => 'node.pages.inc',
      'function' => 'theme_node_add_list',
93 94 95
    ),
    'node_form' => array(
      'arguments' => array('form' => NULL),
96 97
      'file' => 'node.pages.inc',
      'function' => 'theme_node_form',
98 99 100
    ),
    'node_preview' => array(
      'arguments' => array('node' => NULL),
101 102
      'file' => 'node.pages.inc',
      'function' => 'theme_node_preview',
103 104 105 106
    ),
    'node_log_message' => array(
      'arguments' => array('log' => NULL),
    ),
107 108 109
    'node_submitted' => array(
      'arguments' => array('node' => NULL),
    ),
110 111 112
  );
}

Dries's avatar
 
Dries committed
113 114 115
/**
 * Implementation of hook_cron().
 */
116
function node_cron() {
Dries's avatar
 
Dries committed
117
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
118 119
}

Dries's avatar
 
Dries committed
120 121 122 123
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
124 125 126 127
 *   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
128 129 130 131
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
132 133
 *   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
134
 */
Dries's avatar
 
Dries committed
135
function node_title_list($result, $title = NULL) {
136
  $items = array();
137
  $num_rows = FALSE;
Dries's avatar
 
Dries committed
138
  while ($node = db_fetch_object($result)) {
139
    $items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
140
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
141 142
  }

143
  return $num_rows ? theme('node_list', $items, $title) : FALSE;
Dries's avatar
 
Dries committed
144 145
}

Dries's avatar
 
Dries committed
146 147 148
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
 
Dries committed
149
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
150
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
151 152
}

Dries's avatar
 
Dries committed
153 154 155
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
156 157 158 159
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
160
    if (node_last_viewed($nid)) {
Dries's avatar
 
Dries committed
161
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
162 163
    }
    else {
Dries's avatar
 
Dries committed
164
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
165 166 167 168
    }
  }
}

Dries's avatar
 
Dries committed
169 170 171 172
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
173 174
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
175
  static $history;
Dries's avatar
 
Dries committed
176

Dries's avatar
 
Dries committed
177
  if (!isset($history[$nid])) {
178
    $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
179 180
  }

181
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
182 183 184
}

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

198 199 200
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
201
  if (!isset($cache[$nid])) {
202
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
203
  }
204 205 206 207 208 209 210
  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
211 212
}

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

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

251 252 253
  if (!isset($size)) {
    $size = variable_get('teaser_length', 600);
  }
Dries's avatar
 
Dries committed
254

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

258
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
259
  if ($size == 0 && $delimiter === FALSE) {
Dries's avatar
 
Dries committed
260 261
    return $body;
  }
Dries's avatar
 
Dries committed
262

263 264 265 266 267
  // If a valid delimiter has been specified, use it to chop off the teaser.
  if ($delimiter !== FALSE) {
    return substr($body, 0, $delimiter);
  }

268 269 270 271 272
  // 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);
273
    if (isset($filters['filter/1']) && strpos($body, '<?') !== FALSE) {
274 275
      return $body;
    }
276 277
  }

278
  // If we have a short body, the entire body is the teaser.
Dries's avatar
 
Dries committed
279 280 281 282
  if (strlen($body) < $size) {
    return $body;
  }

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  // 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);
298
    }
299
  }
Dries's avatar
Dries committed
300

301 302 303 304 305 306 307 308 309 310 311 312
  // 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
313 314
}

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
/**
 * 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;
336

337 338
  if ($reset || !isset($_node_types)) {
    list($_node_types, $_node_names) = _node_types_build();
339
  }
340

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

  _node_types_build();
388 389
}

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

  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);
415 416

    module_invoke_all('node_type', 'update', $info);
417 418 419 420
    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);
421 422

    module_invoke_all('node_type', 'insert', $info);
423 424
    return SAVED_NEW;
  }
425
}
426

427 428 429 430 431 432 433 434 435 436 437 438 439
/**
 * 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);
}

440
/**
441 442
 * Updates all nodes of one type to be of another type.
 *
443
 * @param $old_type
444 445 446
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
447 448
 *
 * @return
449
 *   The number of nodes whose node type field was modified.
450
 */
451 452 453
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
454
}
Dries's avatar
 
Dries committed
455

456
/**
457 458 459 460
 * 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
461 462
 *
 */
463 464 465 466 467 468 469 470 471 472 473 474 475
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)) {
476 477 478 479 480 481
    // 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;
    }
482 483 484 485 486 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
    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');
  }

516 517 518 519 520 521
  if (!isset($info['help'])) {
    $info['help'] = '';
  }
  if (!isset($info['min_word_count'])) {
    $info['min_word_count'] = 0;
  }
522 523 524 525 526 527 528 529 530 531 532 533 534 535
  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
536
}
Dries's avatar
 
Dries committed
537

538
/**
Dries's avatar
 
Dries committed
539 540 541 542 543 544 545 546 547 548
 * 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) {
549 550 551 552 553
  $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
554 555
}

556
/**
Dries's avatar
 
Dries committed
557 558 559 560 561 562 563 564 565
 * 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
566
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
567 568
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
569
  if (node_hook($node, $hook)) {
570 571 572 573 574
    $module = node_get_types('module', $node);
    if ($module == 'node') {
      $module = 'node_content'; // Avoid function name collisions.
    }
    $function = $module .'_'. $hook;
Dries's avatar
 
Dries committed
575
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
576 577 578
  }
}

Dries's avatar
 
Dries committed
579 580 581 582
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
583
 *   A node object.
Dries's avatar
 
Dries committed
584 585 586 587 588 589 590
 * @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
591
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
592
  $return = array();
593
  foreach (module_implements('nodeapi') as $name) {
Dries's avatar
 
Dries committed
594
    $function = $name .'_nodeapi';
595
    $result = $function($node, $op, $a3, $a4);
596
    if (isset($result) && is_array($result)) {
597 598 599 600
      $return = array_merge($return, $result);
    }
    else if (isset($result)) {
      $return[] = $result;
Dries's avatar
 
Dries committed
601 602 603 604 605
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
606 607 608
/**
 * Load a node object from the database.
 *
609 610
 * @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
611 612
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
613 614
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
615 616 617 618
 *
 * @return
 *   A fully-populated node object.
 */
619
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
620 621 622 623 624 625
  static $nodes = array();

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

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

Dries's avatar
 
Dries committed
647
  // Retrieve the node.
648
  // No db_rewrite_sql is applied so as to get complete indexing for search.
649
  if ($revision) {
650
    array_unshift($arguments, $revision);
651
    $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
652
  }
653
  else {
654
    $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
655 656
  }

657
  if ($node && $node->nid) {
658 659 660 661 662 663
    // 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
664 665
    }

666 667 668 669 670
    if ($extra = node_invoke_nodeapi($node, 'load')) {
      foreach ($extra as $key => $value) {
        $node->$key = $value;
      }
    }
671 672 673
    if ($cachable) {
      $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
    }
Dries's avatar
 
Dries committed
674 675
  }

Dries's avatar
 
Dries committed
676 677 678
  return $node;
}

679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 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
/**
 * 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;
    }

    $node->created = $node->date ? strtotime($node->date) : NULL;
  }

  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
758 759 760
/**
 * Save a node object into the database.
 */
761
function node_save(&$node) {
762 763
  // Let modules modify the node before it is saved to the database.
  node_invoke_nodeapi($node, 'presave');
764
  global $user;
Dries's avatar
 
Dries committed
765

766
  $node->is_new = FALSE;
Dries's avatar
 
Dries committed
767

Dries's avatar
 
Dries committed
768
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
769
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
770
    // Insert a new node.
771
    $node->is_new = TRUE;
772 773 774 775 776 777
  }
  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
778
    }
779
    $node = $node_current;
Dries's avatar
 
Dries committed
780

781
    if (!empty($node->revision)) {
782 783
      $node->old_vid = $node->vid;
    }
Dries's avatar
 
Dries committed
784 785
  }

786 787 788 789
  // Set some required fields:
  if (empty($node->created)) {
    $node->created = time();
  }
790
  // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
791
  $node->changed = time();
Dries's avatar
 
Dries committed
792

793
  // Split off revisions data to another structure
794
  $revisions_table_values = array('nid' => &$node->nid,
795
                     'title' => $node->title, 'body' => isset($node->body) ? $node->body : '',
796
                     'teaser' => $node->teaser, 'timestamp' => $node->changed,
797
                     'uid' => $user->uid, 'format' => isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT);
798
  $revisions_table_types = array('nid' => '%d',
799
                     'title' => "'%s'", 'body' => "'%s'",
800
                     'teaser' => "'%s'", 'timestamp' => '%d',
801
                     'uid' => '%d', 'format' => '%d');
802
  if (!empty($node->log) || $node->is_new || (isset($node->revision) && $node->revision)) {
803 804 805
    // 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).
806 807 808
    $revisions_table_values['log'] = $node->log;
    $revisions_table_types['log'] = "'%s'";
  }
809
  $node_table_values = array(
810
                    'title' => $node->title, 'type' => $node->type, 'uid' => $node->uid,
811
                    'status' => $node->status, 'language' => $node->language, 'created' => $node->created,
812
                    'changed' => $node->changed, 'comment' => $node->comment,
813
                    'promote' => $node->promote, 'sticky' => $node->sticky);
814
  $node_table_types = array(
815
                    'title' => "'%s'", 'type' => "'%s'", 'uid' => '%d',
816
                    'status' => '%d', 'language' => "'%s'",'created' => '%d',
817
                    'changed' => '%d', 'comment' => '%d',
818
                    'promote' => '%d', 'sticky' => '%d');
819
  $update_node = TRUE;
820 821 822
  //Generate the node table query and the
  //the node_revisions table query
  if ($node->is_new) {
823
    $node_query = 'INSERT INTO {node} ('. implode(', ', array_keys($node_table_types)) .') VALUES ('. implode(', ', $node_table_types) .')';
824 825
    db_query($node_query, $node_table_values);
    $node->nid = db_last_insert_id('node', 'nid');
826
    $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
827 828 829
    db_query($revisions_query, $revisions_table_values);
    $node->vid = db_last_insert_id('node_revisions', 'vid');
    $op = 'insert';
830 831 832 833 834 835 836 837
  }
  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';
838
    db_query($node_query, $node_table_values);
839
    if (!empty($node->revision)) {
840
      $revisions_query = 'INSERT INTO {node_revisions} ('. implode(', ', array_keys($revisions_table_types)) .') VALUES ('. implode(', ', $revisions_table_types) .')';
841 842
      db_query($revisions_query, $revisions_table_values);
      $node->vid = db_last_insert_id('node_revisions', 'vid');
843 844 845 846 847
    }
    else {
      $arr = array();
      foreach ($revisions_table_types as $key => $value) {
        $arr[] = $key .' = '. $value;
Dries's avatar
 
Dries committed
848
      }
849 850
      $revisions_table_values[] = $node->vid;
      $revisions_query = 'UPDATE {node_revisions} SET '. implode(', ', $arr) .' WHERE vid = %d';
851 852
      db_query($revisions_query, $revisions_table_values);
      $update_node = FALSE;
Dries's avatar
 
Dries committed
853
    }
854
    $op = 'update';
855
  }
856
  if ($update_node) {
857
    db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
858 859
  }

860 861 862 863
 // Call the node specific callback (if any):
  node_invoke($node, $op);
  node_invoke_nodeapi($node, $op);

864 865 866
  // Update the node access table for this node.
  node_access_acquire_grants($node);

867
  // Clear the page and block caches.
Dries's avatar
 
Dries committed
868
  cache_clear_all();
Dries's avatar
 
Dries committed
869 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
/**
 * 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
898 899 900 901 902 903
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
904
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
 
Dries committed
905 906
 * @param $page
 *   Whether the node is being displayed by itself as a page.
907 908
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
 
Dries committed
909 910 911 912
 *
 * @return
 *   An HTML representation of the themed node.
 */
913
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
914
  $node = (object)$node;
Dries's avatar
 
Dries committed
915

916 917
  $node = node_build_content($node, $teaser, $page);

918 919
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
920
    drupal_alter('link', $node->links, $node);
921
  }
922 923 924 925

  // 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);
926
  if ($teaser) {
927
    $node->teaser = $content;
928 929 930
    unset($node->body);
  }
  else {
931
    $node->body = $content;
932 933
    unset($node->teaser);
  }
Dries's avatar
 
Dries committed
934

935 936 937
  // Allow modules to modify the fully-built node.
  node_invoke_nodeapi($node, 'alter', $teaser, $page);

Dries's avatar
 
Dries committed
938
  return theme('node', $node, $teaser, $page);
Dries's avatar
 
Dries committed
939
}
Dries's avatar
 
Dries committed
940

Dries's avatar
 
Dries committed
941
/**
942
 * Apply filters and build the node's standard elements.
Dries's avatar
 
Dries committed
943
 */
Dries's avatar
 
Dries committed
944
function node_prepare($node, $teaser = FALSE) {
945 946 947
  // 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.
948
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
949 950 951 952 953 954 955 956

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

957
  $node->content['body'] = array(
958
    '#value' => $teaser ? $node->teaser : $node->body,
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
    '#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) {
980 981 982 983 984 985

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

986
  // Remove the delimiter (if any) that separates the teaser from the body.
987
  $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
Dries's avatar