node.module 68.2 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

35
      foreach (node_list() as $type => $module) {
Dries's avatar
 
Dries committed
36 37
        $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':
43
      return t('Allows content to be submitted to the site and displayed on pages.');
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>).</p><p>Clicking a title views the post, while clicking an author\'s name views their user information.</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.');
  }
56 57 58 59

  if (arg(0) == 'node' && arg(1) == 'add' && $type = arg(2)) {
    return variable_get($type .'_help', '');
  }
Dries's avatar
 
Dries committed
60 61
}

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

Dries's avatar
 
Dries committed
69 70 71 72
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
73
 *   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
74 75 76 77 78 79
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
 *   An HTML list suitable as content for a block.
 */
Dries's avatar
 
Dries committed
80 81
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
82
    $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
83 84
  }

Dries's avatar
 
Dries committed
85
  return theme('node_list', $items, $title);
Dries's avatar
 
Dries committed
86 87
}

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

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

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

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

Dries's avatar
 
Dries committed
119 120 121 122 123
  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
124 125 126
}

/**
127
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
128
 *
Dries's avatar
 
Dries committed
129 130 131 132
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
133 134
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
135
 */
136
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
137 138 139
  global $user;
  static $cache;

140 141 142
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
143
  if (!isset($cache[$nid])) {
144
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
145
  }
146 147 148 149 150 151 152
  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
153 154
}

Dries's avatar
 
Dries committed
155
/**
156
 * Automatically generate a teaser for a node body in a given format.
Dries's avatar
 
Dries committed
157
 */
158
function node_teaser($body, $format = NULL) {
Dries's avatar
 
Dries committed
159

Dries's avatar
 
Dries committed
160
  $size = variable_get('teaser_length', 600);
Dries's avatar
 
Dries committed
161

Dries's avatar
 
Dries committed
162 163 164
  // find where the delimiter is in the body
  $delimiter = strpos($body, '<!--break-->');

165
  // If the size is zero, and there is no delimiter, the entire body is the teaser.
Dries's avatar
 
Dries committed
166
  if ($size == 0 && $delimiter == 0) {
Dries's avatar
 
Dries committed
167 168
    return $body;
  }
Dries's avatar
 
Dries committed
169

170 171 172 173 174
  // 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);
175
    if (isset($filters['filter/1']) && strpos($body, '<?') !== false) {
176 177
      return $body;
    }
178 179
  }

Dries's avatar
 
Dries committed
180
  // If a valid delimiter has been specified, use it to chop of the teaser.
Dries's avatar
 
Dries committed
181
  if ($delimiter > 0) {
Dries's avatar
 
Dries committed
182 183 184
    return substr($body, 0, $delimiter);
  }

185
  // If we have a short body, the entire body is the teaser.
Dries's avatar
 
Dries committed
186 187 188 189
  if (strlen($body) < $size) {
    return $body;
  }

Dries's avatar
 
Dries committed
190 191
  // 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.
192
  // When even the first paragraph is too long, we try to split at the end of
Dries's avatar
 
Dries committed
193
  // the next sentence.
Dries's avatar
Dries committed
194
  $breakpoints = array('</p>' => 4, '<br />' => 0, '<br>' => 0, "\n" => 0, '. ' => 1, '! ' => 1, '? ' => 1, '。' => 1, '؟ ' => 1);
195 196 197 198
  foreach ($breakpoints as $point => $charnum) {
    if ($length = strpos($body, $point, $size)) {
      return substr($body, 0, $length + $charnum);
    }
199
  }
Dries's avatar
Dries committed
200

201
  // If all else fails, we simply truncate the string.
202
  return truncate_utf8($body, $size);
Dries's avatar
 
Dries committed
203 204
}

205
/**
Dries's avatar
 
Dries committed
206
 * Determine the module that defines the node type of the given node.
Dries's avatar
 
Dries committed
207 208
 *
 * @param &$node
Dries's avatar
 
Dries committed
209
 *   Either a node object, a node array, or a string containing the node type.
Dries's avatar
 
Dries committed
210 211 212 213
 * @return
 *   A string containing the name of the defining module.
 */
function node_get_module_name($node) {
Dries's avatar
 
Dries committed
214
  if (is_array($node)) {
215
    $type = $node['type'];
Dries's avatar
 
Dries committed
216 217
  }
  else if (is_object($node)) {
218
    $type = $node->type;
Dries's avatar
 
Dries committed
219 220
  }
  else if (is_string($node)) {
221
    $type = $node;
Dries's avatar
 
Dries committed
222
  }
223 224 225 226

  $modules = node_list();

  return $modules[$type];
Dries's avatar
 
Dries committed
227
}
Dries's avatar
 
Dries committed
228

229
/**
Dries's avatar
 
Dries committed
230 231 232
 * Get a list of all the defined node types.
 *
 * @return
Dries's avatar
Dries committed
233
 *   An associate array of consisting of (node type, module name) pairs for all node types.
Dries's avatar
 
Dries committed
234 235
 */
function node_list() {
236 237 238 239 240 241 242 243 244 245 246 247 248
  static $types = array();

  if (empty($types)) {
    foreach (module_list() as $module) {
      if (module_hook($module, 'node_name')) {
        $module_types = module_invoke($module, 'node_types');
        if (is_array($module_types)) {
          foreach ($module_types as $type) {
            $types[$type] = $module;
          }
        }
        else {
          $types[$module] = $module;
Dries's avatar
 
Dries committed
249 250 251 252 253
        }
      }
    }
  }
  return $types;
Dries's avatar
 
Dries committed
254
}
Dries's avatar
 
Dries committed
255

256
/**
Dries's avatar
 
Dries committed
257 258 259 260 261 262 263 264 265 266
 * 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) {
267
  $function = node_get_module_name($node) ."_$hook";
Dries's avatar
 
Dries committed
268 269 270 271

  return function_exists($function);
}

272
/**
Dries's avatar
 
Dries committed
273 274 275 276 277 278 279 280 281
 * 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
282
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
283 284
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
285
  $function = node_get_module_name($node) ."_$hook";
Dries's avatar
 
Dries committed
286 287

  if (function_exists($function)) {
Dries's avatar
 
Dries committed
288
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
289 290 291
  }
}

Dries's avatar
 
Dries committed
292 293 294 295
/**
 * Invoke a hook_nodeapi() operation in all modules.
 *
 * @param &$node
Dries's avatar
 
Dries committed
296
 *   A node object.
Dries's avatar
 
Dries committed
297 298 299 300 301 302 303
 * @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
304
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
305 306
  $return = array();
  foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
307
    $function = $name .'_nodeapi';
Dries's avatar
 
Dries committed
308
    if (function_exists($function)) {
Dries's avatar
 
Dries committed
309
      $result = $function($node, $op, $a3, $a4);
310
      if (is_array($result)) {
Dries's avatar
 
Dries committed
311 312
        $return = array_merge($return, $result);
      }
Steven Wittens's avatar
Steven Wittens committed
313
      else if (isset($result)) {
314 315
        $return[] = $result;
      }
Dries's avatar
 
Dries committed
316 317 318 319 320
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
321 322 323
/**
 * Load a node object from the database.
 *
324 325
 * @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
326 327
 * @param $revision
 *   Which numbered revision to load. Defaults to the current version.
Dries's avatar
 
Dries committed
328 329
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
330 331 332 333
 *
 * @return
 *   A fully-populated node object.
 */
334
function node_load($param = array(), $revision = NULL, $reset = NULL) {
Dries's avatar
 
Dries committed
335 336 337 338 339 340
  static $nodes = array();

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

341 342 343 344 345 346
  if (is_numeric($param)) {
    $cachable = $revision == NULL;
    if ($cachable && $nodes[$param]) {
      return $nodes[$param];
    }
    $cond = 'n.nid = '. $param;
Dries's avatar
 
Dries committed
347
  }
348 349
  else {
    // Turn the conditions into a query.
350
    foreach ($param as $key => $value) {
351 352 353
      $cond[] = 'n.'. db_escape_string($key) ." = '". db_escape_string($value) ."'";
    }
    $cond = implode(' AND ', $cond);
Dries's avatar
 
Dries committed
354 355
  }

Dries's avatar
 
Dries committed
356
  // Retrieve the node.
357
  $node = db_fetch_object(db_query(db_rewrite_sql('SELECT n.*, u.uid, u.name, u.picture, u.data FROM {node} n INNER JOIN {users} u ON u.uid = n.uid WHERE '. $cond)));
Dries's avatar
 
Dries committed
358
  $node = drupal_unpack($node);
Dries's avatar
 
Dries committed
359

Dries's avatar
 
Dries committed
360
  // Unserialize the revisions and user data fields.
Dries's avatar
 
Dries committed
361 362 363 364
  if ($node->revisions) {
    $node->revisions = unserialize($node->revisions);
  }

Dries's avatar
 
Dries committed
365 366
  // Call the node specific callback (if any) and piggy-back the
  // results to the node or overwrite some values.
Dries's avatar
 
Dries committed
367
  if ($extra = node_invoke($node, 'load')) {
Dries's avatar
 
Dries committed
368 369 370 371 372
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
373 374 375 376 377 378
  if ($extra = node_invoke_nodeapi($node, 'load')) {
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
379
  // Return the desired revision.
Dries's avatar
 
Dries committed
380
  if (!is_null($revision) && is_array($node->revisions[$revision])) {
381
   $node = $node->revisions[$revision]['node'];
Dries's avatar
 
Dries committed
382 383
  }

Dries's avatar
 
Dries committed
384
  if ($cachable) {
385
    $nodes[$param] = $node;
Dries's avatar
 
Dries committed
386 387
  }

Dries's avatar
 
Dries committed
388 389 390
  return $node;
}

Dries's avatar
 
Dries committed
391 392 393
/**
 * Save a node object into the database.
 */
394
function node_save($node) {
Dries's avatar
 
Dries committed
395
  // Fetch fields to save to node table:
Dries's avatar
 
Dries committed
396
  $fields = node_invoke_nodeapi($node, 'fields');
Dries's avatar
 
Dries committed
397

Dries's avatar
 
Dries committed
398
  // Serialize the revisions field:
Dries's avatar
 
Dries committed
399 400 401 402
  if ($node->revisions) {
    $node->revisions = serialize($node->revisions);
  }

Dries's avatar
 
Dries committed
403
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
404
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
405
    // Insert a new node.
Dries's avatar
 
Dries committed
406

Dries's avatar
 
Dries committed
407
    // Set some required fields:
408 409 410
    if (!$node->created) {
      $node->created = time();
    }
411 412 413
    if (!$node->changed) {
      $node->changed = time();
    }
Dries's avatar
 
Dries committed
414
    $node->nid = db_next_id('{node}_nid');
Dries's avatar
 
Dries committed
415

Dries's avatar
 
Dries committed
416
    // Prepare the query:
Dries's avatar
 
Dries committed
417
    foreach ($node as $key => $value) {
418
      if (in_array((string) $key, $fields)) {
Dries's avatar
 
Dries committed
419
        $k[] = db_escape_string($key);
Dries's avatar
 
Dries committed
420 421
        $v[] = $value;
        $s[] = "'%s'";
Dries's avatar
 
Dries committed
422 423 424
      }
    }

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

Dries's avatar
 
Dries committed
428
    // Call the node specific callback (if any):
Dries's avatar
 
Dries committed
429 430
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
Dries's avatar
 
Dries committed
431 432
  }
  else {
Dries's avatar
 
Dries committed
433
    // Update an existing node.
Dries's avatar
 
Dries committed
434

Dries's avatar
 
Dries committed
435
    // Set some required fields:
Dries's avatar
 
Dries committed
436 437
    $node->changed = time();

Dries's avatar
 
Dries committed
438
    // Prepare the query:
Dries's avatar
 
Dries committed
439 440
    foreach ($node as $key => $value) {
      if (in_array($key, $fields)) {
Dries's avatar
 
Dries committed
441
        $q[] = db_escape_string($key) ." = '%s'";
Dries's avatar
 
Dries committed
442
        $v[] = $value;
Dries's avatar
 
Dries committed
443 444
      }
    }
Dries's avatar
 
Dries committed
445

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

Dries's avatar
 
Dries committed
449
    // Call the node specific callback (if any):
Dries's avatar
 
Dries committed
450 451
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
Dries's avatar
 
Dries committed
452 453
  }

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

Dries's avatar
 
Dries committed
457
  // Return the node ID:
Dries's avatar
 
Dries committed
458 459 460
  return $node->nid;
}

Dries's avatar
 
Dries committed
461 462 463 464 465 466
/**
 * Generate a display of the given node.
 *
 * @param $node
 *   A node array or node object.
 * @param $teaser
467
 *   Whether to display the teaser only, as on the main page.
Dries's avatar
 
Dries committed
468 469
 * @param $page
 *   Whether the node is being displayed by itself as a page.
470 471
 * @param $links
 *   Whether or not to display node links. Links are omitted for node previews.
Dries's avatar
 
Dries committed
472 473 474 475
 *
 * @return
 *   An HTML representation of the themed node.
 */
476
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
Dries's avatar
 
Dries committed
477
  $node = array2object($node);
Dries's avatar
 
Dries committed
478

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

Dries's avatar
 
Dries committed
483 484
  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
Dries's avatar
 
Dries committed
485
  if (node_hook($node, 'view')) {
Dries's avatar
 
Dries committed
486
    node_invoke($node, 'view', $teaser, $page);
Dries's avatar
 
Dries committed
487 488
  }
  else {
Dries's avatar
 
Dries committed
489
    $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
490
  }
Dries's avatar
 
Dries committed
491 492
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $teaser, $page);
493 494 495
  if ($links) {
    $node->links = module_invoke_all('link', 'node', $node, !$page);
  }
496 497 498 499 500 501 502
  // unset unused $node part so that a bad theme can not open a security hole
  if ($teaser) {
    unset($node->body);
  }
  else {
    unset($node->teaser);
  }
Dries's avatar
 
Dries committed
503 504

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

Dries's avatar
 
Dries committed
507 508 509
/**
 * Apply filters to a node in preparation for theming.
 */
Dries's avatar
 
Dries committed
510
function node_prepare($node, $teaser = FALSE) {
Dries's avatar
 
Dries committed
511
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
 
Dries committed
512
  if ($teaser == FALSE) {
513
    $node->body = check_markup($node->body, $node->format, FALSE);
Dries's avatar
 
Dries committed
514 515
  }
  else {
516
    $node->teaser = check_markup($node->teaser, $node->format, FALSE);
Dries's avatar
 
Dries committed
517
  }
Dries's avatar
 
Dries committed
518
  return $node;
Dries's avatar
 
Dries committed
519 520
}

Dries's avatar
 
Dries committed
521 522 523
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
 
Dries committed
524
function node_show($node, $cid) {
Dries's avatar
 
Dries committed
525
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
 
Dries committed
526

Dries's avatar
 
Dries committed
527 528
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
529 530
  }

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

Dries's avatar
 
Dries committed
534
  return $output;
Dries's avatar
 
Dries committed
535 536
}

Dries's avatar
 
Dries committed
537 538 539
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
540
function node_perm() {
Dries's avatar
 
Dries committed
541
  return array('administer nodes', 'access content');
Dries's avatar
 
Dries committed
542 543
}

Dries's avatar
 
Dries committed
544 545 546
/**
 * Implementation of hook_search().
 */
547 548 549 550
function node_search($op = 'search', $keys = null) {
  switch ($op) {
    case 'name':
      return t('content');
Dries's avatar
Dries committed
551 552 553
    case 'reset':
      variable_del('node_cron_last');
      return;
554 555 556
    case 'status':
      $last = variable_get('node_cron_last', 0);
      $total = db_result(db_query('SELECT COUNT(*) FROM {node} WHERE status = 1 AND moderate = 0'));
Steven Wittens's avatar
Steven Wittens committed
557
      $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)', $last, $last, $last));
558
      return array('remaining' => $remaining, 'total' => $total);
559
    case 'search':
560
      list($join, $where) = _db_rewrite_sql();
561
      $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'. (empty($where) ? '' : ' AND '. $where));
562 563
      $results = array();
      foreach ($find as $item) {
564
        $node = node_load($item);
565 566 567 568 569 570 571 572 573 574 575

        // Get node output (filtered and with module-specific fields).
        if (node_hook($node, 'view')) {
          node_invoke($node, 'view', false, false);
        }
        else {
          $node = node_prepare($node, false);
        }
        // Allow modules to change $node->body before viewing.
        node_invoke_nodeapi($node, 'view', false, false);

Dries's avatar
Dries committed
576
        $extra = node_invoke_nodeapi($node, 'search result');
577 578 579
        $results[] = array('link' => url('node/'. $item),
                           'type' => node_invoke($node, 'node_name'),
                           'title' => $node->title,
580
                           'user' => theme('username', $node),
581
                           'date' => $node->changed,
Dries's avatar
Dries committed
582
                           'extra' => $extra,
583
                           'snippet' => search_excerpt($keys, $node->body));
584 585 586
      }
      return $results;
  }
Dries's avatar
 
Dries committed
587 588
}

Dries's avatar
 
Dries committed
589
/**
Dries's avatar
 
Dries committed
590
 * Menu callback; presents general node configuration options.
Dries's avatar
 
Dries committed
591 592 593 594 595 596
 */
function node_configure() {
  if ($_POST) {
    system_settings_save();
  }

Dries's avatar
 
Dries committed
597
  $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.'));
598
  $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
599
  $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
600

Dries's avatar
 
Dries committed
601
  return system_settings_form($output);
Dries's avatar
 
Dries committed
602 603
}

Dries's avatar
 
Dries committed
604 605 606
/**
 * Retrieve the comment mode for the given node ID (none, read, or read/write).
 */
Dries's avatar
 
Dries committed
607
function node_comment_mode($nid) {
Dries's avatar
 
Dries committed
608 609
  static $comment_mode;
  if (!isset($comment_mode[$nid])) {
Dries's avatar
 
Dries committed
610
    $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
Dries's avatar
 
Dries committed
611 612
  }
  return $comment_mode[$nid];
Dries's avatar
 
Dries committed
613 614
}

Dries's avatar
 
Dries committed
615 616 617
/**
 * Implementation of hook_link().
 */
618
function node_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
619 620
  $links = array();

Dries's avatar
 
Dries committed
621
  if ($type == 'node') {
Dries's avatar
 
Dries committed
622
    if (array_key_exists('links', $node)) {
Kjartan's avatar
Kjartan committed
623 624
      $links = $node->links;
    }
Dries's avatar
 
Dries committed
625

Dries's avatar
 
Dries committed
626
    if ($main == 1 && $node->teaser && $node->readmore) {
Dries's avatar
 
Dries committed
627
      $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
628
    }
Dries's avatar
 
Dries committed
629 630
  }

Dries's avatar
 
Dries committed
631
  return $links;
Dries's avatar
 
Dries committed
632 633
}

Dries's avatar
 
Dries committed
634 635 636
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
637
function node_menu($may_cache) {
Dries's avatar
 
Dries committed
638 639
  $items = array();

Dries's avatar
 
Dries committed
640 641
  if ($may_cache) {
    $items[] = array('path' => 'admin/node', 'title' => t('content'),
Dries's avatar
 
Dries committed
642
      'callback' => 'node_admin',
Dries's avatar
 
Dries committed
643
      'access' => user_access('administer nodes'));
644 645
    $items[] = array('path' => 'admin/node/action', 'title' => t('content'),
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
646 647
    $items[] = array('path' => 'admin/node/overview', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
648
    $items[] = array('path' => 'admin/settings/node', 'title' => t('posts'),
Dries's avatar
 
Dries committed
649
      'callback' => 'node_configure',
650 651
      'access' => user_access('administer nodes'));
    $items[] = array('path' => 'admin/settings/content-types', 'title' => t('content types'),
652
      'callback' => 'node_types_configure',
653
      'access' => user_access('administer nodes'));
Dries's avatar
 
Dries committed
654 655 656 657 658 659
    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
660

Dries's avatar
 
Dries committed
661
    $items[] = array('path' => 'node', 'title' => t('content'),
Dries's avatar
 
Dries committed
662
      'callback' => 'node_page',
Dries's avatar
 
Dries committed
663 664 665
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
    $items[] = array('path' => 'node/add', 'title' => t('create content'),
Dries's avatar
 
Dries committed
666
      'callback' => 'node_page',
Dries's avatar
 
Dries committed
667 668 669 670 671 672
      'access' => user_access('access content'),
      'type' => MENU_ITEM_GROUPING,
      'weight' => 1);
  }
  else {
    if (arg(0) == 'node' && is_numeric(arg(1))) {
673
      $node = node_load(arg(1));
674 675
      if ($node->nid) {
        $items[] = array('path' => 'node/'. arg(1), 'title' => t('view'),
Dries's avatar
 
Dries committed
676
          'callback' => 'node_page',
677 678 679 680 681 682 683 684
          '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
685
          'type' => MENU_LOCAL_TASK);
686
        $items[] = array('path' => 'node/'. arg(1) .'/delete', 'title' => t('delete'),
687
          'callback' => 'node_delete_page',
688 689 690
          'access' => node_access('delete', $node),
          'weight' => 1,
          'type' => MENU_CALLBACK);
691 692 693 694 695 696 697 698

        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
699
      }
700
    }
701 702 703
    else if (arg(0) == 'admin' && arg(1) == 'settings' && arg(2) == 'content-types' && is_string(arg(3))) {
      $items[] = array('path' => 'admin/settings/content-types/'. arg(3),
        'title' => t("'%name' content type", array('%name' => node_invoke(arg(3), 'node_name'))),
704 705
        'type' => MENU_CALLBACK);
    }
Dries's avatar
 
Dries committed
706 707 708 709 710
  }

  return $items;
}

711 712 713 714 715
function node_last_changed($nid) {
  $node = db_fetch_object(db_query('SELECT changed FROM {node} WHERE nid = %d', $nid));
  return ($node->changed);
}

Dries's avatar
 
Dries committed
716
/**
Dries's avatar
 
Dries committed
717
 * Generate the content administration overview.
Dries's avatar
 
Dries committed
718
 */
Dries's avatar
 
Dries committed
719
function node_admin_nodes() {
720 721 722
  /*
  ** Operations
  */
Dries's avatar
 
Dries committed
723
  $operations = array(
724 725 726 727 728 729
    'approve' =>   array(t('Approve the selected posts'), 'UPDATE {node} SET status = 1, moderate = 0 WHERE nid = %d'),
    'promote' =>   array(t('Promote the selected posts'), 'UPDATE {node} SET status = 1, promote = 1 WHERE nid = %d'),
    'sticky' =>    array(t('Make the selected posts sticky'), 'UPDATE {node} SET status = 1, sticky = 1 WHERE nid = %d'),
    'demote' =>    array(t('Demote the selected posts'), 'UPDATE {node} SET promote = 0 WHERE nid = %d'),
    'unpublish' => array(t('Unpublish the selected posts'), 'UPDATE {node} SET status = 0 WHERE nid = %d'),
    'delete' =>    array(t('Delete the selected posts'), '')
Dries's avatar
 
Dries committed
730
  );
Dries's avatar
 
Dries committed
731

732
  // Handle operations
733 734
  $op = $_POST['op'];

735
  $edit = $_POST['edit'];
736
  if (($op == t('Update') || $op == t('Delete all')) && isset($edit['operation']) && isset($edit['nodes'])) {
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    $edit['nodes'] = array_diff($edit['nodes'], array(0));
    if (count($edit['nodes']) == 0) {
      form_set_error('', t('Please select some items to perform the update on.'));
    }
    else {
      if ($operations[$edit['operation']][1]) {
        // Flag changes
       $operation = $operations[$edit['operation']][1];
        foreach ($edit['nodes'] as $nid => $value) {
          if ($value) {
            db_query($operation, $nid);
          }
        }
        drupal_set_message(t('The update has been performed.'));
      }
      else if ($edit['operation'] == 'delete') {
        // Mass delete
        if ($edit['confirm']) {
          foreach ($edit['nodes'] as $nid => $value) {
            node_delete(array('nid' => $nid, 'confirm' => 1));
          }
          drupal_set_message(t('The items have been deleted.'));
        }
        else {
761
          $extra = '<ul>';
762 763 764
          foreach ($edit['nodes'] as $nid => $value) {
            if ($value) {
              $title = db_result(db_query('SELECT title FROM {node} WHERE nid = %d', $nid));
765
              $extra .= '<li>'. form_hidden('nodes]['. $nid, 1) . check_plain($title) .'</li>';
766 767
            }
          }
768 769 770 771 772 773 774 775 776 777
          $extra .= '</ul>';
          $extra .= form_hidden('operation', 'delete');

          $output = theme('confirm',
                          t('Are you sure you want to delete these items?'),
                          'admin/node',
                          t('This action cannot be undone.'),
                          t('Delete all'),
                          t('Cancel'),
                          $extra);
778 779
          return $output;
        }
Dries's avatar
 
Dries committed
780 781
      }
    }
782
  }
Dries's avatar
 
Dries committed
783

784 785 786
  /*
  ** Filters
  */
787
  $node_types = drupal_map_assoc(array_keys(node_list()));
788 789 790 791 792
  foreach ($node_types as $k => $v) {
    $node_types[$k] = node_invoke($v, 'node_name');
  }
  // Regular filters
  $filters = array(
793
    'status'   => array('title' => t('status'),
794 795 796 797
                        'options' => array('status-1'   => t('published'),     'status-0' => t('not published'),
                                           'moderate-1' => t('in moderation'), 'moderate-0' => t('not in moderation'),
                                           'promote-1'  => t('promoted'),      'promote-0' => t('not promoted'),
                                           'sticky-1'   => t('sticky'),        'sticky-0' => t('not sticky'))),
798 799 800 801 802 803 804 805 806 807 808
    'type'     => array('title' => t('type'), 'where' => "n.type = '%s'",
                        'options' => $node_types));
  // Merge all vocabularies into one for retrieving $value below
  if ($taxonomy = module_invoke('taxonomy', 'form_all')) {
    $terms = array();
    foreach ($taxonomy as $key => $value) {
      $terms = $terms + $value;
    }
    $filters['category'] = array('title' => t('category'), 'where' => 'tn.tid = %d',
                                 'options' => $terms, 'join' => 'INNER JOIN {term_node} tn ON n.nid = tn.nid');
  }
809 810

  // Initialize/reset filters
811
  if (!isset($_SESSION['node_overview_filter']) || !is_array($_SESSION['node_overview_filter']) || $op == t('Reset')) {
812 813 814 815 816 817 818 819 820 821 822 823 824 825
    $_SESSION['node_overview_filter'] = array();
  }
  $session = &$_SESSION['node_overview_filter'];
  $filter = $edit['filter'];
  if (($op == t('Filter') || $op == t('Refine')) && isset($filter)) {
    if (isset($filters[$filter]['options'][$edit[$filter]])) {
      $session[] = array($filter, $edit[$filter]);
    }
  }
  if ($op == t('Undo')) {
    array_pop($session);
  }
  if ($op != '') {
    drupal_goto('admin/node');
Dries's avatar
 
Dries committed
826 827
  }

828 829 830 831 832 833 834 835 836 837 838 839
  /*
  ** Form
  */
  $output .= '<div id="node-admin-filter">';
  // Existing filters
  $form = '<ul>';
  $i = 0;
  foreach ($session as $filter) {
    list($type, $value) = $filter;
    $params = array('%a' => '<strong>'. $filters[$type]['title'] .'</strong>', '%b' => '<strong>'. $filters[$type]['options'][$value] .'</strong>');
    $form .= '<li>'. ($i++ ? t('<em>and</em> where <strong>%a</strong> is <strong>%b</strong>', $params) : t('<strong>%a</strong> is <strong>%b</strong>', $params)) .'</li>';
  }
Dries's avatar
Dries committed
840

841
  // New filter form
842 843 844
  if (isset($filters['category'])) {
    $filters['category']['options'] = $taxonomy;
  }
845
  $values = '';
Dries's avatar
 
Dries committed
846 847
  $options = array();
  foreach ($filters as $key => $value) {
848 849
    $options[$key] = $value['title'];
    $b .= form_select('', $key, 1, $filters[$key]['options']);
Steven Wittens's avatar
Steven Wittens committed
850
  }
Dries's avatar
 
Dries committed
851

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
  $buttons = '';
  if (count($options)) {
    $form .= '<li><dl class="multiselect">';
    $a = '';
    foreach ($options as $key => $value) {
      $a .= form_radio($value, 'filter', $key);
    }
    if (!$i) {
      $form .= t('<dd class="a">%a</dd> <dt>is</dt> <dd class="b">%b</dd>', array('%a' => $a, '%b' => $b));
    }
    else {
      $form .= t('<dt><em>and</em> where</dt> <dd class="a">%a</dd> <dt>is</dt> <dd class="b">%b</dd>', array('%a' => $a, '%b' => $b));
    }
    $form .= '</dl>';
    $buttons = form_submit(count($session) ? t('Refine') : t('Filter'));
  }
  if (count($session)) {
    $buttons .= form_submit(t('Undo')) . form_submit(t('Reset'));
  }
  $form .= '<div class="container-inline" id="node-admin-buttons">'. $buttons .'</div>';
872
  $form .= '</li></ul><br class="clear" />';
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
  $output .= form_group(t('Show only items where'), $form);

  // Build query
  $where = $args = array();
  $join = '';
  foreach ($session as $filter) {
    list($key, $value) = $filter;
    if ($key == 'status') {
      // Note: no exploit hole as $value has already been checked
      list($key, $value) = explode('-', $value, 2);
      $where[] = 'n.'. $key .' = %d';
    }
    else {
      $where[] = $filters[$key]['where'];
    }
    $args[] = $value;
    $join .= $filters[$key]['join'];
  }
  $where = count($where) ? 'WHERE '. implode(' AND ', $where) : '';
892
  $result = pager_query('SELECT n.*, u.name, u.uid FROM {node} n '. $join .' INNER JOIN {users} u ON n.uid = u.uid '. $where .' ORDER BY n.changed DESC', 50, 0, NULL, $args);
893 894 895 896

  // 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
897 898
  $options = array();
  foreach ($operations as $key => $value) {
899
    $options[$key] = $value[0];
Dries's avatar