node.module 62.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 6 7 8
/**
 * @file
 * The core that allows content to be submitted to the site.
 */

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

Dries's avatar
 
Dries committed
11 12 13 14
/**
 * Implementation of hook_help().
 */
function node_help($section) {
15
  switch ($section) {
Dries's avatar
 
Dries committed
16
    case 'admin/help#node':
Dries's avatar
 
Dries committed
17
      $output = t("
Dries's avatar
 
Dries committed
18 19 20 21 22 23 24
      <h3>Nodes</h3>
      <p>The core of the Drupal system is the node. All of the contents of the system are placed in nodes, or extensions of nodes.
      A base node contains:<dl>
      <dt>A Title</dt><dd>Up to 128 characters of text that titles the node.</dd>
      <dt>A Teaser</dt><dd>A small block of text that is meant to get you interested in the rest of node. Drupal will automatically pull a small amount of the body of the node to make the teaser (To configure how long the teaser will be <a href=\"%teaser\">click here</a>). The teaser can be changed if you don't like what Drupal grabs.</dd>
      <dt>The Body</dt><dd>The main text that comprises your content.</dd>
      <dt>A Type</dt><dd>What kind of node is this? Blog, book, forum, comment, unextended, etc.</dd>
25
      <dt>An Author</dt><dd>The author's name. It will either be \"anonymous\" or a valid user. You <em>cannot</em> set it to an arbitrary value.</dd>
Dries's avatar
 
Dries committed
26 27
      <dt>Authored on</dt><dd>The date the node was written.</dd>
      <dt>Changed</dt><dd>The last time this node was changed.</dd>
28
      <dt>Sticky at top of lists</dt><dd>In listings such as the frontpage or a taxonomy overview the teasers of a selected amount of nodes is displayed. If you want to force a node to appear on the top of such a listing, you must set it to 'sticky'. This way it will float to the top of a listing, and it will not be pushed down by newer content.
Dries's avatar
 
Dries committed
29 30
      <dt>Allow user comments</dt><dd>A node can have comments. These comments can be written by other users (Read-write), or only by admins (Read-only).</dd>
      <dt>Revisions</dt><dd>Drupal has a revision system so that you can \"roll back\" to an older version of a post if the new version is not what you want.</dd>
Dries's avatar
 
Dries committed
31
      <dt>Promote to front page</dt><dd>To get people to look at the new stuff on your site you can choose to move it to the front page. The front page is configured to show the teasers from only a few of the total nodes you have on your site (To configure how many teasers <a href=\"%teaser\">click here</a>).</dd>
32
      <dt>Published</dt><dd>When using Drupal's moderation system a node remains unpublished -- unavailable to non-moderators -- until it is marked Published.</dd></dl>
33
      <p>Now that you know what is in a node, here are some of the types of nodes available.</p>", array("%teaser" => url("admin/node/configure/settings")));
Dries's avatar
 
Dries committed
34

Dries's avatar
 
Dries committed
35 36 37
      foreach (node_list() as $type) {
        $output .= '<h3>'. t('Node type: %module', array('%module' => node_invoke($type, 'node_name'))). '</h3>';
        $output .= implode("\n", module_invoke_all('help', 'node/add#'. $type));
Dries's avatar
 
Dries committed
38
      }
Dries's avatar
 
Dries committed
39

Dries's avatar
 
Dries committed
40
      return $output;
41

Dries's avatar
 
Dries committed
42
    case 'admin/modules#description':
Dries's avatar
 
Dries committed
43
      return t('The core that allows content to be submitted to the site.');
44 45
    case 'admin/node/configure':
    case 'admin/node/configure/settings':
46
      return t('<p>Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.</p>');
47
    case 'admin/node':
48
      return t('<p>Below is a list of all of the posts on your site. Other forms of content are listed elsewhere (e.g. <a href="%comments">comments</a>).<br />Clicking a title views the post, while clicking an author\'s name edits their user information.<br />Other post-related tasks are available from the menu.</p>', array('%comments' => url('admin/comment')));
49
    case 'admin/node/search':
50
      return t('<p>Enter a simple pattern to search for a post. This can include the wildcard character *.<br />For example, a search for "br*" might return "bread bakers", "our daily bread" and "brenda".</p>');
Dries's avatar
 
Dries committed
51
  }
Dries's avatar
 
Dries committed
52 53 54 55

  if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'revisions') {
    return t('The revisions let you track differences between multiple versions of a post.');
  }
Dries's avatar
 
Dries committed
56 57
}

Dries's avatar
 
Dries committed
58 59 60
/**
 * Implementation of hook_cron().
 */
61
function node_cron() {
Dries's avatar
 
Dries committed
62
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
63 64
}

Dries's avatar
 
Dries committed
65 66 67 68
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
69
 *   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
70
 * field to be set.
Dries's avatar
 
Dries committed
71 72 73 74 75 76
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
 *   An HTML list suitable as content for a block.
 */
Dries's avatar
 
Dries committed
77 78
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
79
    $items[] = l($node->title, 'node/'. $node->nid, $node->comment_count ? array('title' => format_plural($node->comment_count, '1 comment', '%count comments')) : '');
Dries's avatar
 
Dries committed
80 81
  }

Dries's avatar
 
Dries committed
82
  return theme('node_list', $items, $title);
Dries's avatar
 
Dries committed
83 84
}

Dries's avatar
 
Dries committed
85 86 87
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
 
Dries committed
88
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
89
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
90 91
}

Dries's avatar
 
Dries committed
92 93 94
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
95 96 97 98
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
99
    if (node_last_viewed($nid)) {
Dries's avatar
 
Dries committed
100
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
101 102
    }
    else {
Dries's avatar
 
Dries committed
103
      @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
104 105 106 107
    }
  }
}

Dries's avatar
 
Dries committed
108 109 110 111
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
112 113
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
114
  static $history;
Dries's avatar
 
Dries committed
115

Dries's avatar
 
Dries committed
116 117 118 119 120
  if (!isset($history[$nid])) {
    $history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = '$user->uid' AND nid = %d", $nid));
  }

  return ($history[$nid]->timestamp ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
121 122 123
}

/**
Dries's avatar
 
Dries committed
124
 * Determine whether the supplied timestamp is newer than the user's last view
Dries's avatar
 
Dries committed
125
 * of a given node.
Dries's avatar
 
Dries committed
126
 *
Dries's avatar
 
Dries committed
127 128 129 130
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
Dries's avatar
 
Dries committed
131
 */
Dries's avatar
 
Dries committed
132 133 134 135
function node_is_new($nid, $timestamp) {
  global $user;
  static $cache;

Dries's avatar
Dries committed
136
  if (!isset($cache[$nid])) {
Dries's avatar
 
Dries committed
137
    if ($user->uid) {
Dries's avatar
 
Dries committed
138
      $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
139 140 141 142 143 144
    }
    else {
      $cache[$nid] = time();
    }
  }

145
  return ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT);
Dries's avatar
 
Dries committed
146 147
}

Dries's avatar
 
Dries committed
148
/**
Dries's avatar
 
Dries committed
149
 * Automatically generate a teaser for the given body text.
Dries's avatar
 
Dries committed
150
 */
Dries's avatar
 
Dries committed
151 152
function node_teaser($body) {

Dries's avatar
 
Dries committed
153
  $size = variable_get('teaser_length', 600);
Dries's avatar
 
Dries committed
154

Dries's avatar
 
Dries committed
155 156 157 158 159
  // find where the delimiter is in the body
  $delimiter = strpos($body, '<!--break-->');

  // If the size is zero, and there is no delimiter, we return the entire body.
  if ($size == 0 && $delimiter == 0) {
Dries's avatar
 
Dries committed
160 161
    return $body;
  }
Dries's avatar
 
Dries committed
162

163 164 165 166 167
  // If the body contains PHP code, do not split it up to prevent parse errors.
  if (strpos($body, '<?') != false) {
    return $body;
  }

Dries's avatar
 
Dries committed
168
  // If a valid delimiter has been specified, use it to chop of the teaser.
Dries's avatar
 
Dries committed
169
  if ($delimiter > 0) {
Dries's avatar
 
Dries committed
170 171 172
    return substr($body, 0, $delimiter);
  }

Dries's avatar
 
Dries committed
173
  // If we have a short body, return the entire body.
Dries's avatar
 
Dries committed
174 175 176 177
  if (strlen($body) < $size) {
    return $body;
  }

Dries's avatar
 
Dries committed
178 179
  // In some cases, no delimiter has been specified (e.g. when posting using
  // the Blogger API). In this case, we try to split at paragraph boundaries.
Dries's avatar
 
Dries committed
180
  if ($length = strpos($body, '</p>', $size)) {
Dries's avatar
 
Dries committed
181
    return substr($body, 0, $length + 4);
Dries's avatar
 
Dries committed
182 183
  }

Dries's avatar
 
Dries committed
184
  if ($length = strpos($body, '<br />', $size)) {
Dries's avatar
 
Dries committed
185
    return substr($body, 0, $length);
Dries's avatar
 
Dries committed
186 187
  }

Dries's avatar
 
Dries committed
188
  if ($length = strpos($body, '<br>', $size)) {
Dries's avatar
 
Dries committed
189 190 191
    return substr($body, 0, $length);
  }

192
  if ($length = strpos($body, "\n", $size)) {
Dries's avatar
 
Dries committed
193
    return substr($body, 0, $length);
Dries's avatar
 
Dries committed
194 195
  }

Dries's avatar
 
Dries committed
196 197
  // When even the first paragraph is too long, try to split at the end of
  // the next sentence.
Dries's avatar
 
Dries committed
198
  if ($length = strpos($body, '. ', $size)) {
Dries's avatar
 
Dries committed
199 200 201
    return substr($body, 0, $length + 1);
  }

Dries's avatar
 
Dries committed
202
  if ($length = strpos($body, '! ', $size)) {
Dries's avatar
 
Dries committed
203 204 205
    return substr($body, 0, $length + 1);
  }

Dries's avatar
 
Dries committed
206
  if ($length = strpos($body, '? ', $size)) {
Dries's avatar
 
Dries committed
207 208 209
    return substr($body, 0, $length + 1);
  }

210 211 212 213 214 215 216 217 218 219 220 221
  if ($length = strpos($body, '。', $size)) {
    return substr($body, 0, $length + 1);
  }

  if ($length = strpos($body, '、', $size)) {
    return substr($body, 0, $length + 1);
  }

  if ($length = strpos($body, '؟ ', $size)) {
    return substr($body, 0, $length + 1);
  }

Dries's avatar
 
Dries committed
222
  // If all else fails, simply truncate the string.
223
  return truncate_utf8($body, $size);
Dries's avatar
 
Dries committed
224 225
}

Dries's avatar
 
Dries committed
226

227
/**
Dries's avatar
 
Dries committed
228
 * Determine the module that defines the node type of the given node.
Dries's avatar
 
Dries committed
229 230
 *
 * @param &$node
Dries's avatar
 
Dries committed
231
 *   Either a node object, a node array, or a string containing the node type.
Dries's avatar
 
Dries committed
232 233 234 235
 * @return
 *   A string containing the name of the defining module.
 */
function node_get_module_name($node) {
Dries's avatar
 
Dries committed
236
  if (is_array($node)) {
Dries's avatar
 
Dries committed
237
    if ($pos = strpos($node['type'], '-')) {
Dries's avatar
 
Dries committed
238
      return substr($node['type'], 0, $pos);
239 240
    }
    else {
Dries's avatar
 
Dries committed
241
      return $node['type'];
Dries's avatar
 
Dries committed
242
    }
Dries's avatar
 
Dries committed
243 244
  }
  else if (is_object($node)) {
Dries's avatar
 
Dries committed
245
    if ($pos = strpos($node->type, '-')) {
Dries's avatar
 
Dries committed
246
      return substr($node->type, 0, $pos);
247 248
    }
    else {
Dries's avatar
 
Dries committed
249 250
      return $node->type;
    }
Dries's avatar
 
Dries committed
251 252
  }
  else if (is_string($node)) {
Dries's avatar
 
Dries committed
253
    if ($pos = strpos($node, '-')) {
Dries's avatar
 
Dries committed
254
      return substr($node, 0, $pos);
255 256
    }
    else {
Dries's avatar
 
Dries committed
257 258
      return $node;
    }
Dries's avatar
 
Dries committed
259
  }
Dries's avatar
 
Dries committed
260
}
Dries's avatar
 
Dries committed
261

262
/**
Dries's avatar
 
Dries committed
263 264 265
 * Get a list of all the defined node types.
 *
 * @return
Dries's avatar
 
Dries committed
266
 *   A list of all node types.
Dries's avatar
 
Dries committed
267 268 269 270
 */
function node_list() {
  $types = array();
  foreach (module_list() as $module) {
Dries's avatar
 
Dries committed
271 272
    if (module_hook($module, 'node_name')) {
      $module_types = module_invoke($module, 'node_types');
Dries's avatar
 
Dries committed
273 274
      if ($module_types) {
        foreach ($module_types as $type) {
Dries's avatar
 
Dries committed
275
          $types[] = $type;
Dries's avatar
 
Dries committed
276
        }
277 278
      }
      else {
Dries's avatar
 
Dries committed
279
        $types[] = $module;
Dries's avatar
 
Dries committed
280 281 282 283
      }
    }
  }
  return $types;
Dries's avatar
 
Dries committed
284
}
Dries's avatar
 
Dries committed
285

286
/**
Dries's avatar
 
Dries committed
287 288 289 290 291 292 293 294 295 296
 * 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) {
297
  $function = node_get_module_name($node) ."_$hook";
Dries's avatar
 
Dries committed
298 299 300 301

  return function_exists($function);
}

302
/**
Dries's avatar
 
Dries committed
303 304 305 306 307 308 309 310 311
 * 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
312
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
313 314
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
315
  $function = node_get_module_name($node) ."_$hook";
Dries's avatar
 
Dries committed
316 317

  if (function_exists($function)) {
Dries's avatar
 
Dries committed
318
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
319 320 321
  }
}

Dries's avatar
 
Dries committed
322 323 324 325 326 327 328 329 330 331 332 333
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
 *   Either a node object, node array, or a string containing the node type.
 * @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
334
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
335 336
  $return = array();
  foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
337
    $function = $name .'_nodeapi';
Dries's avatar
 
Dries committed
338
    if (function_exists($function)) {
Dries's avatar
 
Dries committed
339
      $result = $function($node, $op, $a3, $a4);
340
      if (is_array($result)) {
Dries's avatar
 
Dries committed
341 342
        $return = array_merge($return, $result);
      }
Steven Wittens's avatar
Steven Wittens committed
343
      else if (isset($result)) {
344 345
        $return[] = $result;
      }
Dries's avatar
 
Dries committed
346 347 348 349 350
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
351 352 353 354 355 356 357 358
/**
 * Load a node object from the database.
 *
 * @param $conditions
 *   An array of conditions to match against in the database query. Most calls
 *   will simply use array('nid' => 52).
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
359 360
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
361 362 363 364
 *
 * @return
 *   A fully-populated node object.
 */
Dries's avatar
 
Dries committed
365 366 367 368 369 370 371 372 373 374 375 376 377
function node_load($conditions, $revision = NULL, $reset = NULL) {
  static $nodes = array();

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

  $cachable = (count($conditions) == 1 && isset($conditions['nid']) && $revision == NULL);

  if ($cachable && isset($nodes[$conditions['nid']])) {
    return $nodes[$conditions['nid']];
  }

Dries's avatar
 
Dries committed
378
  // Turn the conditions into a query.
Dries's avatar
 
Dries committed
379
  foreach ($conditions as $key => $value) {
Dries's avatar
 
Dries committed
380
    $cond[] = 'n.'. db_escape_string($key) ." = '". db_escape_string($value) ."'";
Dries's avatar
 
Dries committed
381 382
  }

Dries's avatar
 
Dries committed
383
  // Retrieve the node.
Dries's avatar
 
Dries committed
384
  $node = db_fetch_object(db_query('SELECT n.*, u.uid, u.name, u.picture, u.data FROM {node} n INNER JOIN {users} u ON u.uid = n.uid WHERE '. implode(' AND ', $cond)));
Dries's avatar
 
Dries committed
385
  $node = drupal_unpack($node);
Dries's avatar
 
Dries committed
386

Dries's avatar
 
Dries committed
387
  // Unserialize the revisions and user data fields.
Dries's avatar
 
Dries committed
388 389 390 391
  if ($node->revisions) {
    $node->revisions = unserialize($node->revisions);
  }

Dries's avatar
 
Dries committed
392 393
  // Call the node specific callback (if any) and piggy-back the
  // results to the node or overwrite some values.
Dries's avatar
 
Dries committed
394
  if ($extra = node_invoke($node, 'load')) {
Dries's avatar
 
Dries committed
395 396 397 398 399
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
400 401 402 403 404 405
  if ($extra = node_invoke_nodeapi($node, 'load')) {
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
406
  // Return the desired revision.
Dries's avatar
 
Dries committed
407
  if (!is_null($revision) && is_array($node->revisions[$revision])) {
408
   $node = $node->revisions[$revision]['node'];
Dries's avatar
 
Dries committed
409 410
  }

Dries's avatar
 
Dries committed
411 412 413 414
  if ($cachable) {
    $nodes[$conditions['nid']] = $node;
  }

Dries's avatar
 
Dries committed
415 416 417
  return $node;
}

Dries's avatar
 
Dries committed
418 419 420
/**
 * Save a node object into the database.
 */
421
function node_save($node) {
Dries's avatar
 
Dries committed
422
  // Fetch fields to save to node table:
Dries's avatar
 
Dries committed
423
  $fields = node_invoke_nodeapi($node, 'fields');
Dries's avatar
 
Dries committed
424

Dries's avatar
 
Dries committed
425
  // Serialize the revisions field:
Dries's avatar
 
Dries committed
426 427 428 429
  if ($node->revisions) {
    $node->revisions = serialize($node->revisions);
  }

Dries's avatar
 
Dries committed
430
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
431
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
432
    // Insert a new node.
Dries's avatar
 
Dries committed
433

Dries's avatar
 
Dries committed
434
    // Set some required fields:
435 436 437
    if (!$node->created) {
      $node->created = time();
    }
438 439 440
    if (!$node->changed) {
      $node->changed = time();
    }
Dries's avatar
 
Dries committed
441
    $node->nid = db_next_id('{node}_nid');
Dries's avatar
 
Dries committed
442

Dries's avatar
 
Dries committed
443
    // Prepare the query:
Dries's avatar
 
Dries committed
444
    foreach ($node as $key => $value) {
445
      if (in_array((string) $key, $fields)) {
Dries's avatar
 
Dries committed
446
        $k[] = db_escape_string($key);
Dries's avatar
 
Dries committed
447 448
        $v[] = $value;
        $s[] = "'%s'";
Dries's avatar
 
Dries committed
449 450 451
      }
    }

Dries's avatar
 
Dries committed
452
    $keysfmt = implode(', ', $s);
Dries's avatar
 
Dries committed
453
    // We need to quote the placeholders for the values.
Dries's avatar
 
Dries committed
454 455
    $valsfmt = "'". implode("', '", $s) ."'";

Dries's avatar
 
Dries committed
456
    // Insert the node into the database:
Dries's avatar
 
Dries committed
457
    db_query("INSERT INTO {node} (". implode(", ", $k) .") VALUES(". implode(", ", $s) .")", $v);
Dries's avatar
 
Dries committed
458

Dries's avatar
 
Dries committed
459
    // Call the node specific callback (if any):
Dries's avatar
 
Dries committed
460 461
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
Dries's avatar
 
Dries committed
462 463
  }
  else {
Dries's avatar
 
Dries committed
464
    // Update an existing node.
Dries's avatar
 
Dries committed
465

Dries's avatar
 
Dries committed
466
    // Set some required fields:
Dries's avatar
 
Dries committed
467 468
    $node->changed = time();

Dries's avatar
 
Dries committed
469
    // Prepare the query:
Dries's avatar
 
Dries committed
470 471
    foreach ($node as $key => $value) {
      if (in_array($key, $fields)) {
Dries's avatar
 
Dries committed
472
        $q[] = db_escape_string($key) ." = '%s'";
Dries's avatar
 
Dries committed
473
        $v[] = $value;
Dries's avatar
 
Dries committed
474 475
      }
    }
Dries's avatar
 
Dries committed
476

Dries's avatar
 
Dries committed
477
    // Update the node in the database:
Dries's avatar
 
Dries committed
478
    db_query("UPDATE {node} SET ". implode(', ', $q) ." WHERE nid = '$node->nid'", $v);
Dries's avatar
 
Dries committed
479

Dries's avatar
 
Dries committed
480
    // Call the node specific callback (if any):
Dries's avatar
 
Dries committed
481 482
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
Dries's avatar
 
Dries committed
483 484
  }

Dries's avatar
 
Dries committed
485
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
 
Dries committed
486 487
  cache_clear_all();

Dries's avatar
 
Dries committed
488
  // Return the node ID:
Dries's avatar
 
Dries committed
489 490 491
  return $node->nid;
}

Dries's avatar
 
Dries committed
492 493 494 495 496 497 498 499 500
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
 *   Whether to display only the teaser for the node.
 * @param $page
 *   Whether the node is being displayed by itself as a page.
501 502
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
 
Dries committed
503 504 505 506
 *
 * @return
 *   An HTML representation of the themed node.
 */
507
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
Dries's avatar
 
Dries committed
508
  $node = array2object($node);
Dries's avatar
 
Dries committed
509

510
  // Remove the delimiter (if any) that separates the teaser from the body.
Dries's avatar
 
Dries committed
511
  // TODO: this strips legitimate uses of '<!--break-->' also.
Dries's avatar
 
Dries committed
512
  $node->body = str_replace('<!--break-->', '', $node->body);
Dries's avatar
 
Dries committed
513

Dries's avatar
 
Dries committed
514 515
  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
Dries's avatar
 
Dries committed
516
  if (node_hook($node, 'view')) {
Dries's avatar
 
Dries committed
517
    node_invoke($node, 'view', $teaser, $page);
Dries's avatar
 
Dries committed
518 519
  }
  else {
Dries's avatar
 
Dries committed
520
    $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
521
  }
Dries's avatar
 
Dries committed
522 523
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $teaser, $page);
524 525 526
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
  }
Dries's avatar
 
Dries committed
527 528

  return theme('node', $node, $teaser, $page);
Dries's avatar
 
Dries committed
529
}
Dries's avatar
 
Dries committed
530

Dries's avatar
 
Dries committed
531 532 533
/**
 * Apply filters to a node in preparation for theming.
 */
Dries's avatar
 
Dries committed
534
function node_prepare($node, $teaser = FALSE) {
Dries's avatar
 
Dries committed
535
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
 
Dries committed
536
  if ($teaser == FALSE) {
537
    $node->body = check_output($node->body, $node->format);
Dries's avatar
 
Dries committed
538 539
  }
  else {
540
    $node->teaser = check_output($node->teaser, $node->format);
Dries's avatar
 
Dries committed
541
  }
Dries's avatar
 
Dries committed
542
  return $node;
Dries's avatar
 
Dries committed
543 544
}

Dries's avatar
 
Dries committed
545 546 547
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
 
Dries committed
548
function node_show($node, $cid) {
Dries's avatar
 
Dries committed
549
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
 
Dries committed
550

Dries's avatar
 
Dries committed
551 552
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
553 554
  }

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

Dries's avatar
 
Dries committed
558
  return $output;
Dries's avatar
 
Dries committed
559 560
}

Dries's avatar
 
Dries committed
561 562 563
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
564
function node_perm() {
Dries's avatar
 
Dries committed
565
  return array('administer nodes', 'access content');
Dries's avatar
 
Dries committed
566 567
}

Dries's avatar
 
Dries committed
568 569 570
/**
 * Implementation of hook_search().
 */
571 572 573 574
function node_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
      return t('content');
Dries's avatar
Dries committed
575 576 577
    case 'reset':
      variable_del('node_cron_last');
      return;
578 579 580 581 582
    case 'status':
      $last = variable_get('node_cron_last', 0);
      $total = db_result(db_query('SELECT COUNT(*) FROM {node} WHERE status = 1 AND moderate = 0'));
      $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 n.moderate = 0 AND (n.created > %d OR n.changed > %d OR c.last_comment_timestamp > %d) ORDER BY GREATEST(n.created, n.changed, c.last_comment_timestamp) ASC', $last, $last, $last));
      return array('remaining' => $remaining, 'total' => $total);
583
    case 'search':
Dries's avatar
 
Dries committed
584 585
      list($join, $where) = _node_rewrite_sql();
      $find = do_search($keys, 'node', 'INNER JOIN {node} n ON n.nid = i.sid '. $join .' INNER JOIN {users} u ON n.uid = u.uid', 'n.status = 1 AND '. $where);
586 587 588
      $results = array();
      foreach ($find as $item) {
        $node = node_load(array('nid' => $item));
Dries's avatar
Dries committed
589
        $extra = node_invoke_nodeapi($node, 'search result');
590 591 592 593 594
        $results[] = array('link' => url('node/'. $item),
                           'type' => node_invoke($node, 'node_name'),
                           'title' => $node->title,
                           'user' => format_name($node),
                           'date' => $node->changed,
Dries's avatar
Dries committed
595
                           'extra' => $extra,
596 597 598 599
                           'snippet' => search_excerpt($keys, check_output($node->body, $node->format)));
      }
      return $results;
  }
Dries's avatar
 
Dries committed
600 601
}

Dries's avatar
 
Dries committed
602
/**
Dries's avatar
 
Dries committed
603
 * Menu callback; presents general node configuration options.
Dries's avatar
 
Dries committed
604 605 606 607 608 609
 */
function node_configure() {
  if ($_POST) {
    system_settings_save();
  }

Dries's avatar
 
Dries committed
610
  $output .= form_select(t('Number of posts on main page'), 'default_nodes_main', variable_get('default_nodes_main', 10), drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)), t('The default maximum number of posts to display per page on overview pages such as the main page.'));
611
  $output .= form_select(t('Length of trimmed posts'), 'teaser_length', variable_get('teaser_length', 600), array(0 => t('Unlimited'), 200 => t('200 characters'), 400 => t('400 characters'), 600 => t('600 characters'), 800 => t('800 characters'), 1000 => t('1000 characters'), 1200 => t('1200 characters'), 1400 => t('1400 characters'), 1600 => t('1600 characters'), 1800 => t('1800 characters'), 2000 => t('2000 characters')), t("The maximum number of characters used in the trimmed version of a post.  Drupal will use this setting to determine at which offset long posts should be trimmed.  The trimmed version of a post is typically used as a teaser when displaying the post on the main page, in XML feeds, etc.  To disable teasers, set to 'Unlimited'. Note that this setting will only affect new or updated content and will not affect existing teasers."));
Dries's avatar
 
Dries committed
612
  $output .= form_radios(t('Preview post'), 'node_preview', variable_get('node_preview', 0), array(t('Optional'), t('Required')), t('Must users preview posts before submitting?'));
Dries's avatar
 
Dries committed
613

Dries's avatar
 
Dries committed
614
  print theme('page', system_settings_form($output));
Dries's avatar
 
Dries committed
615 616
}

Dries's avatar
 
Dries committed
617 618 619
/**
 * Retrieve the comment mode for the given node ID (none, read, or read/write).
 */
Dries's avatar
 
Dries committed
620
function node_comment_mode($nid) {
Dries's avatar
 
Dries committed
621 622
  static $comment_mode;
  if (!isset($comment_mode[$nid])) {
Dries's avatar
 
Dries committed
623
    $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
Dries's avatar
 
Dries committed
624 625
  }
  return $comment_mode[$nid];
Dries's avatar
 
Dries committed
626 627
}

Dries's avatar
 
Dries committed
628 629 630
/**
 * Implementation of hook_link().
 */
631
function node_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
632 633
  $links = array();

Dries's avatar
 
Dries committed
634
  if ($type == 'node') {
Dries's avatar
 
Dries committed
635
    if (array_key_exists('links', $node)) {
Kjartan's avatar
Kjartan committed
636 637
      $links = $node->links;
    }
Dries's avatar
 
Dries committed
638

Dries's avatar
 
Dries committed
639
    if ($main == 1 && $node->teaser && $node->readmore) {
Dries's avatar
 
Dries committed
640
      $links[] = l(t('read more'), "node/$node->nid", array('title' => t('Read the rest of this posting.'), 'class' => 'read-more'));
Dries's avatar
 
Dries committed
641
    }
Dries's avatar
 
Dries committed
642 643
  }

Dries's avatar
 
Dries committed
644
  return $links;
Dries's avatar
 
Dries committed
645 646
}

Dries's avatar
 
Dries committed
647 648 649
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
650
function node_menu($may_cache) {
Dries's avatar
 
Dries committed
651 652
  $items = array();

Dries's avatar
 
Dries committed
653 654
  if ($may_cache) {
    $items[] = array('path' => 'admin/node', 'title' => t('content'),
Dries's avatar
 
Dries committed
655
      'callback' => 'node_admin',
Dries's avatar
 
Dries committed
656 657 658 659 660
      'access' => user_access('administer nodes'));
    $items[] = array('path' => 'admin/node/overview', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/node/configure', 'title' => t('configure'),
      'callback' => 'node_configure',
Dries's avatar
 
Dries committed
661 662
      'access' => user_access('administer nodes'),
      'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
663 664
    $items[] = array('path' => 'admin/node/configure/settings', 'title' => t('settings'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
665 666
    $items[] = array('path' => 'admin/node/configure/types', 'title' => t('content types'),
      'callback' => 'node_types',
Dries's avatar
 
Dries committed
667 668 669 670 671 672 673 674
      'access' => user_access('administer nodes'),
      'type' => MENU_LOCAL_TASK);
    if (module_exist('search')) {
      $items[] = array('path' => 'admin/node/search', 'title' => t('search'),
        'callback' => 'node_admin',
        'access' => user_access('administer nodes'),
        'type' => MENU_LOCAL_TASK);
    }
Dries's avatar
 
Dries committed
675

Dries's avatar
 
Dries committed
676
    $items[] = array('path' => 'node', 'title' => t('content'),
Dries's avatar
 
Dries committed
677
      'callback' => 'node_page',
Dries's avatar
 
Dries committed
678 679 680
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
    $items[] = array('path' => 'node/add', 'title' => t('create content'),
Dries's avatar
 
Dries committed
681
      'callback' => 'node_page',
Dries's avatar
 
Dries committed
682 683 684 685 686 687 688
      'access' => user_access('access content'),
      'type' => MENU_ITEM_GROUPING,
      'weight' => 1);
  }
  else {
    if (arg(0) == 'node' && is_numeric(arg(1))) {
      $node = node_load(array('nid' => arg(1)));
689 690
      if ($node->nid) {
        $items[] = array('path' => 'node/'. arg(1), 'title' => t('view'),
Dries's avatar
 
Dries committed
691
          'callback' => 'node_page',
692 693 694 695 696 697 698 699
          'access' => node_access('view', $node),
          'type' => MENU_CALLBACK);
        $items[] = array('path' => 'node/'. arg(1) .'/view', 'title' => t('view'),
            'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
        $items[] = array('path' => 'node/'. arg(1) .'/edit', 'title' => t('edit'),
          'callback' => 'node_page',
          'access' => node_access('update', $node),
          'weight' => 1,
Dries's avatar
 
Dries committed
700
          'type' => MENU_LOCAL_TASK);
701 702 703 704 705 706 707 708

        if ($node->revisions) {
          $items[] = array('path' => 'node/'. arg(1) .'/revisions', 'title' => t('revisions'),
            'callback' => 'node_page',
            'access' => user_access('administer nodes'),
            'weight' => 2,
            'type' => MENU_LOCAL_TASK);
        }
Dries's avatar
 
Dries committed
709
      }
710
    }
711 712 713 714 715 716 717
    else if (arg(0) == 'admin' && arg(1) == 'node' && arg(2) == 'configure' && arg(3) == 'types' && is_string(arg(4))) {
      $items[] = array('path' => 'admin/node/configure/types/'. arg(4),
        'title' => t("'%name' content type", array('%name' => node_invoke(arg(4), 'node_name'))),
        'callback' => 'node_types_configure',
        'access' => user_access('administer nodes'),
        'type' => MENU_CALLBACK);
    }
Dries's avatar
 
Dries committed
718 719 720 721 722
  }

  return $items;
}

Dries's avatar
 
Dries committed
723
/**
Dries's avatar
 
Dries committed
724
 * Generate the content administration overview.
Dries's avatar
 
Dries committed
725
 */
Dries's avatar
 
Dries committed
726
function node_admin_nodes() {
727 728 729 730 731 732 733 734
  $filters = array(
    array(t('View posts that are new or updated'), 'ORDER BY n.changed DESC'),
    array(t('View posts that need approval'), 'WHERE n.status = 0 OR n.moderate = 1 ORDER BY n.changed DESC'),
    array(t('View posts that are promoted'), 'WHERE n.status = 1 AND n.promote = 1 ORDER BY n.changed DESC'),
    array(t('View posts that are not promoted'), 'WHERE n.status = 1 AND n.promote = 0 ORDER BY n.changed DESC'),
    array(t('View posts that are sticky'), 'WHERE n.status = 1 AND n.sticky = 1 ORDER BY n.changed DESC'),
    array(t('View posts that are unpublished'), 'WHERE n.status = 0 AND n.moderate = 0 ORDER BY n.changed DESC')
   );
Dries's avatar
 
Dries committed
735 736

  $operations = array(
Dries's avatar
 
Dries committed
737 738
    array(t('Approve the selected posts'), 'UPDATE {node} SET status = 1, moderate = 0 WHERE nid = %d'),
    array(t('Promote the selected posts'), 'UPDATE {node} SET status = 1, promote = 1 WHERE nid = %d'),
Dries's avatar
 
Dries committed
739
    array(t('Make the selected posts sticky'), 'UPDATE {node} SET status = 1, sticky = 1 WHERE nid = %d'),
Dries's avatar
 
Dries committed
740 741
    array(t('Demote the selected posts'), 'UPDATE {node} SET promote = 0 WHERE nid = %d'),
    array(t('Unpublish the selected posts'), 'UPDATE {node} SET status = 0 WHERE nid = %d')
Dries's avatar
 
Dries committed
742
  );
Dries's avatar
 
Dries committed
743

Dries's avatar
 
Dries committed
744
  // Handle operations:
745 746 747 748 749 750 751 752 753 754
  if (empty($_SESSION['node_overview_filter'])) {
    $_SESSION['node_overview_filter'] = 0;
  }

  $op = $_POST['op'];

  if ($op == t('Filter') && isset($_POST['edit']['filter'])) {
    $_SESSION['node_overview_filter'] = $_POST['edit']['filter'];
  }

755
  if ($op == t('Update') && isset($_POST['edit']['operation']) && isset($_POST['edit']['status'])) {
Dries's avatar
 
Dries committed
756 757
    $operation = $operations[$_POST['edit']['operation']][1];
    foreach ($_POST['edit']['status'] as $nid => $value) {
Dries's avatar
 
Dries committed
758
      if ($value) {
Dries's avatar
Dries committed
759
        db_query($operation, $nid);
Dries's avatar
 
Dries committed
760 761 762
      }
    }

Dries's avatar
 
Dries committed
763
    drupal_set_message(t('The update has been performed.'));
Dries's avatar
 
Dries committed
764 765
  }

766
  $filter = $_SESSION['node_overview_filter'];
Dries's avatar
Dries committed
767

768
  // Render filter form:
Dries's avatar
 
Dries committed
769 770
  $options = array();
  foreach ($filters as $key => $value) {
771
    $options[] = $value[0];
Steven Wittens's avatar
Steven Wittens committed
772
  }
Dries's avatar
 
Dries committed
773

774 775 776 777 778 779 780 781
  $form  = form_select(NULL, 'filter', $filter, $options);
  $form .= form_submit(t('Filter'));

  $output .= '<h3>'. t('Filter options') .'</h3>';
  $output .= "<div class=\"container-inline\">$form</div>";

  // Render operations form:
  $result = pager_query('SELECT n.*, u.name, u.uid FROM {node} n INNER JOIN {users} u ON n.uid = u.uid '. $filters[$filter][1], 50);
782 783 784 785

  // Make sure the update controls are disabled if we don't have any rows to select from.
  $disabled = !db_num_rows($result);

Dries's avatar
 
Dries committed
786 787 788 789
  $options = array();
  foreach ($operations as $key => $value) {
    $options[] = $value[0];
  }
790

791 792
  $form = form_select(NULL, 'operation', 0, $options, NULL, ($disabled ? 'disabled="disabled"' : ''));
  $form .= form_submit(t('Update'), 'op', ($disabled ? array('disabled' => 'disabled') : array()));
Dries's avatar
 
Dries committed
793

794
  $output .= '<h3>'. t('Update options') .'</h3>';
Dries's avatar
 
Dries committed
795 796
  $output .= "<div class=\"container-inline\">$form</div>";

Dries's avatar
 
Dries committed
797
  // Overview table:
Dries's avatar
 
Dries committed
798
  $header = array(NULL, t('Title'), t('Type'), t('Author'), t('Status'), array('data' => t('Operations'), 'colspan' => '2'));
Dries's avatar
 
Dries committed
799

Dries's avatar
 
Dries committed
800
  while ($node = db_fetch_object($result)) {
801
    $rows[] = array(form_checkbox(NULL, 'status]['. $node->nid, 1, 0), l($node->title, 'node/'. $node->nid) .' '. (node_is_new($node->nid, $node->changed) ? theme_mark() : ''), node_invoke($node, 'node_name'), format_name($node), ($node->status ? t('published') : t('not published')), l(t('edit'), 'node/'. $node->nid .'/edit'), l(t('delete'), 'admin/node/delete/'. $node->nid));
Dries's avatar
 
Dries committed
802
  }
Dries's avatar
 
Dries committed
803

Dries's avatar
 
Dries committed
804
  if ($pager = theme('pager', NULL, 50, 0)) {
Dries's avatar
 
Dries committed
805 806 807 808 809
    $rows[] = array(array('data' => $pager, 'colspan' => '7'));
  }

  if (!$rows) {
    $rows[] = array(array('data' => t('No posts available.'), 'colspan' => '7'));
Dries's avatar
 
Dries committed
810
  }
Dries's avatar
 
Dries committed
811

Dries's avatar
 
Dries committed
812 813
  $output .= '<h3>'. $filters[$filter][0] .'</h3>';
  $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
814
  return form($output);
Dries's avatar
Dries committed
815 816
}

817 818
function node_types() {
  $header = array(t('Type'), t('Operations'));
Kjartan's avatar
Kjartan committed
819

820 821 822
  $rows = array();
  foreach (node_list() as $type) {
    $rows[] = array(node_invoke($type, 'node_name'), l(t('configure'), 'admin/node/configure/types/'. $type));
823 824
  }

825 826
  print theme('page', theme('table', $header, $rows));
}
827

828 829 830 831
function node_types_configure($type = NULL) {
  // Go to the listing page when we submit this form, system_settings_save() calls drupal_goto().
  if ($_POST['op']) {
    $_GET['q'] = 'admin/node/configure/types';
832
  }
833
  system_settings_save();
Kjartan's avatar
Kjartan committed
834

835
  $output .= implode('', node_invoke_nodeapi($type, 'settings'));
836

837
  print theme('page', system_settings_form($output));
838 839
}

Dries's avatar
 
Dries committed
840
/**
Dries's avatar
 
Dries committed
841
 * Generate an overview table of older revisions of a node.
Dries's avatar
 
Dries committed
842
 */
Dries's avatar
 
Dries committed
843
function node_revision_overview($nid) {
Dries's avatar
 
Dries committed
844 845
  if (user_access('administer nodes')) {
    $node = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
846

847 848
    drupal_set_title($node->title);

Dries's avatar
 
Dries committed
849
    if ($node->revisions) {
Dries's avatar
 
Dries committed
850
      $header = array(t('Older revisions'), array('colspan' => '3', 'data' => t('Operations')));
Dries's avatar
 
Dries committed
851 852

      foreach ($node->revisions as $key => $revision) {
853
        $rows[] = array(t('revision #%r revised by %u on %d', array('%r' => $key, '%u' => format_name(user_load(array('uid' => $revision['uid']))), '%d' => format_date($revision['timestamp'], 'small'))) . ($revision['history'] ? '<br /><small>'. $revision['history'] .'</small>' : ''), l(t('view'), "node/$node->nid", array(), "revision=$key"), l(t('rollback'), "node/$node->nid/rollback-revision/$key"), l(t('delete'), "node/$node->nid/delete-revision/$key"));
Dries's avatar
 
Dries committed
854
      }
Dries's avatar
 
Dries committed
855