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

4 5
define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);

Dries's avatar
 
Dries committed
6
function node_help($section = 'admin/help#node') {
Dries's avatar
 
Dries committed
7
  global $mod;
Dries's avatar
 
Dries committed
8
  $output = '';
9 10 11

  switch ($section) {

Dries's avatar
 
Dries committed
12
    case 'admin/help#node':
Dries's avatar
 
Dries committed
13 14 15 16 17 18 19 20
      $output .= t("
      <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>
21
      <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
22 23 24 25 26 27 28 29 30 31 32 33
      <dt>Authored on</dt><dd>The date the node was written.</dd>
      <dt>Changed</dt><dd>The last time this node was changed.</dd>
      <dt>Static on front page</dt><dd>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>), but if you think a node is important enough that you want it to stay on the front page enable this.</dd>
      <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>
      <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.</dd>
      <dt>In moderation queue</dt><dd>Drupal has a moderation system. If it is active, a node is in one of three states: approved and published, approved and unpublished, and awaiting approval. If you are moderating a node it should be in the moderation queue.</dd>
      <dt>Votes</dt><dd>If you are moderating a node this counts how many votes the node has gotten. Once a node gets a certain number of vote it will either be approved or dropped.
      <dt>Score</dt><dd>The score of the node is gotten by the votes it is given.</dd>
      <dt>Users</dt><dd>The list of users who have voted on a moderated node.</dd>
      <dt>Published</dt><dd>When using Drupal's moderation system a node remains unpublished -- unavaliable to non-moderators -- until it is marked Published.</dd></dl>
      <p>Now that you know what is in a node, here are some of the types of nodes available.</p>", array("%teaser" => url("admin/system/modules/node")));
Dries's avatar
 
Dries committed
34

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

Dries's avatar
 
Dries committed
43
    case 'admin/system/modules#description':
Dries's avatar
 
Dries committed
44
      $output = t('The core that allows content to be submitted to the site.');
45 46
      break;
    case 'admin/system/modules/node':
Dries's avatar
 
Dries committed
47
      $output = t('Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.');
48 49
      break;
    case 'admin/node':
Dries's avatar
 
Dries committed
50
      $output = t("Below is a list of all of the nodes in your site. Other forms of content are listed elsewhere (e.g. <a href=\"%comments\">comments</a>).<br />Clicking a title views that node, while clicking an author's name edits their user information.<br />Other node-related tasks are available from the menu on the left.", array('%comments' => url('admin/comment')));
51 52
      break;
    case 'admin/node/search':
Dries's avatar
 
Dries committed
53
      $output = t("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\".");
54 55
      break;
    case 'admin/node/settings':
Dries's avatar
 
Dries committed
56
      $output = t('This page lets you set the defaults used during creation of nodes for all the different node types.<br /><strong>comment:</strong> Read/write setting for comments.<br /><strong>publish:</strong> Is this node publicly viewable, has it been published?<br /><strong>promote:</strong> Is this node to be promoted to the front page?<br /><strong>moderate:</strong> Does this node need approval before it can be viewed?<br /><strong>static:</strong> Is this node always visible on the front page?<br /><strong>revision:</strong> Will this node go into the revision system allowing multiple versions to be saved?');
57 58
      break;

Dries's avatar
 
Dries committed
59
  }
Dries's avatar
 
Dries committed
60 61

  return $output;
Dries's avatar
 
Dries committed
62 63
}

64
function node_cron() {
Dries's avatar
 
Dries committed
65
  db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
66 67
}

Dries's avatar
 
Dries committed
68
function node_help_page() {
Dries's avatar
 
Dries committed
69
  print theme('page', node_help());
Dries's avatar
 
Dries committed
70 71 72
}


Dries's avatar
 
Dries committed
73 74 75 76
/*
** Accepts a DB result object which can be used to fetch node objects.
** Returns 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
    $number = module_invoke('comment', 'num_all', $node->nid);
80
    $items[] = l($node->title, "node/view/$node->nid", array('title' => format_plural($number, '1 comment', '%count comments')));
Dries's avatar
 
Dries committed
81 82
  }

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

Dries's avatar
 
Dries committed
86
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
87
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
88 89
}

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

  if ($user->uid) {
Dries's avatar
 
Dries committed
95
    $result = db_query('SELECT timestamp FROM {history} WHERE uid = %d AND nid = %d', $user->uid, $nid);
Dries's avatar
 
Dries committed
96
    if (db_fetch_object($result)) {
Dries's avatar
 
Dries committed
97
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
98 99
    }
    else {
Dries's avatar
 
Dries committed
100
      db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
101 102 103 104 105 106 107 108 109 110 111
    }
  }
}

/*
** Retrieves the timestamp at which the current user last viewed the
** specified node.
*/
function node_last_viewed($nid) {
  global $user;

Dries's avatar
 
Dries committed
112
  $history = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = '$user->uid' AND nid = %d", $nid));
113
  return ($history->timestamp ? $history->timestamp : NODE_NEW_LIMIT);
Dries's avatar
 
Dries committed
114 115 116
}

/**
Dries's avatar
 
Dries committed
117 118
 * Determines whether the supplied timestamp is newer than the user's last view
 * of a given node
Dries's avatar
 
Dries committed
119
 *
120 121
 * @param $nid node-id whose history supplies the 'last viewed' timestamp
 * @param $timestamp time which is compared against node's 'last viewed'
Dries's avatar
 
Dries committed
122 123
 *   timestamp
 */
Dries's avatar
 
Dries committed
124 125 126 127
function node_is_new($nid, $timestamp) {
  global $user;
  static $cache;

Dries's avatar
Dries committed
128
  if (!isset($cache[$nid])) {
Dries's avatar
 
Dries committed
129
    if ($user->uid) {
Dries's avatar
 
Dries committed
130
      $history = db_fetch_object(db_query('SELECT timestamp FROM {history} WHERE uid = %d AND nid = %d', $user->uid, $nid));
Dries's avatar
 
Dries committed
131 132 133 134 135 136 137
      $cache[$nid] = $history->timestamp ? $history->timestamp : 0;
    }
    else {
      $cache[$nid] = time();
    }
  }

138
  return ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT);
Dries's avatar
 
Dries committed
139 140
}

Dries's avatar
 
Dries committed
141 142
function node_teaser($body) {

Dries's avatar
 
Dries committed
143
  $size = variable_get('teaser_length', 600);
Dries's avatar
 
Dries committed
144 145 146 147 148 149 150 151 152

  /*
  ** If the size is zero, teasers are disabled so we
  ** return the entire body.
  */

  if ($size == 0) {
    return $body;
  }
Dries's avatar
 
Dries committed
153 154

  /*
Dries's avatar
 
Dries committed
155
  ** If a valid delimiter has been specified, use it to
Dries's avatar
 
Dries committed
156 157
  ** chop of the teaser.  The delimiter can be outside
  ** the allowed range but no more than a factor two.
Dries's avatar
 
Dries committed
158 159
  */

Dries's avatar
 
Dries committed
160
  $delimiter = strpos($body, '<!--break-->');
Dries's avatar
 
Dries committed
161
  if ($delimiter > 0) {
Dries's avatar
 
Dries committed
162 163 164
    return substr($body, 0, $delimiter);
  }

Dries's avatar
 
Dries committed
165 166 167 168 169 170 171 172
  /*
  ** If we have a short body, return the entire body:
  */

  if (strlen($body) < $size) {
    return $body;
  }

Dries's avatar
 
Dries committed
173 174 175 176
  /*
  ** In some cases no delimiter has been specified (eg.
  ** when posting using the Blogger API) in which case
  ** we try to split at paragraph boundaries.
Dries's avatar
 
Dries committed
177 178
  */

Dries's avatar
 
Dries committed
179
  if ($length = strpos($body, '</p>', $size)) {
Dries's avatar
 
Dries committed
180
    return substr($body, 0, $length + 4);
Dries's avatar
 
Dries committed
181 182
  }

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

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

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

Dries's avatar
 
Dries committed
195
  /*
Dries's avatar
 
Dries committed
196
  ** When even the first paragraph is too long, try to
Dries's avatar
 
Dries committed
197
  ** split at the end of the next sentence.
Dries's avatar
 
Dries committed
198 199
  */

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

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

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

212 213 214 215 216 217 218 219 220 221 222 223
  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
224 225 226
  /*
  ** Nevermind, we split it the hard way ...
  */
Dries's avatar
 
Dries committed
227

228
  return truncate_utf8($body, $size);
Dries's avatar
 
Dries committed
229 230
}

Dries's avatar
 
Dries committed
231

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

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

291
/**
Dries's avatar
 
Dries committed
292 293 294 295 296 297 298 299 300 301
 * 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) {
302
  $function = node_get_module_name($node) ."_$hook";
Dries's avatar
 
Dries committed
303 304 305 306

  return function_exists($function);
}

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

  if (function_exists($function)) {
Dries's avatar
 
Dries committed
323
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
324 325 326
  }
}

Dries's avatar
 
Dries committed
327
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
328 329
  $return = array();
  foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
330
    $function = $name .'_nodeapi';
Dries's avatar
 
Dries committed
331
    if (function_exists($function)) {
Dries's avatar
 
Dries committed
332
      $result = $function($node, $op, $a3, $a4);
Dries's avatar
 
Dries committed
333 334 335 336 337 338 339 340
      if (isset($result)) {
        $return = array_merge($return, $result);
      }
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
341
function node_load($conditions, $revision = -1) {
Dries's avatar
 
Dries committed
342 343 344 345 346 347

  /*
  ** Turn the conditions into a query:
  */

  foreach ($conditions as $key => $value) {
Dries's avatar
 
Dries committed
348
    $cond[] = 'n.'. check_query($key) ." = '". check_query($value) ."'";
Dries's avatar
 
Dries committed
349 350 351 352 353 354
  }

  /*
  ** Retrieve the node:
  */

Dries's avatar
 
Dries committed
355
  $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
356
  $node = drupal_unpack($node);
Dries's avatar
 
Dries committed
357 358

  /*
Dries's avatar
 
Dries committed
359
  ** Unserialize the revisions and user data fields:
Dries's avatar
 
Dries committed
360 361 362 363 364 365 366 367 368 369 370
  */

  if ($node->revisions) {
    $node->revisions = unserialize($node->revisions);
  }

  /*
  ** Call the node specific callback (if any) and piggy-back the
  ** results to the node or overwrite some values:
  */

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

Dries's avatar
 
Dries committed
377 378 379 380 381 382
  if ($extra = node_invoke_nodeapi($node, 'load')) {
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
383 384 385 386
  /*
  ** Return the desired revision
  */
  if ($revision != -1 && isset($node->revisions[$revision])) {
387
   $node = $node->revisions[$revision]['node'];
Dries's avatar
 
Dries committed
388 389
  }

Dries's avatar
 
Dries committed
390 391 392
  return $node;
}

393
function node_save($node) {
Dries's avatar
 
Dries committed
394

395 396 397
  /*
  ** Fetch fields to save to node table:
  */
Dries's avatar
 
Dries committed
398
  $fields = node_invoke_nodeapi($node, 'fields');
Dries's avatar
 
Dries committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417

  /*
  ** Serialize the revisions field:
  */

  if ($node->revisions) {
    $node->revisions = serialize($node->revisions);
  }

  /*
  ** Apply filters to some default node fields:
  */

  if (empty($node->nid)) {

    /*
    ** Insert a new node:
    */

Dries's avatar
 
Dries committed
418
    // Set some required fields:
419 420 421
    if (!$node->created) {
      $node->created = time();
    }
422 423 424
    if (!$node->changed) {
      $node->changed = time();
    }
Dries's avatar
 
Dries committed
425
    $node->nid = db_next_id('{node}_nid');
Dries's avatar
 
Dries committed
426

Dries's avatar
 
Dries committed
427
    // Prepare the query:
Dries's avatar
 
Dries committed
428 429 430
    foreach ($node as $key => $value) {
      if (in_array($key, $fields)) {
        $k[] = check_query($key);
Dries's avatar
 
Dries committed
431 432
        $v[] = $value;
        $s[] = "'%s'";
Dries's avatar
 
Dries committed
433 434 435
      }
    }

Dries's avatar
 
Dries committed
436
    $keysfmt = implode(', ', $s);
Dries's avatar
 
Dries committed
437 438 439
    // need to quote the placeholders for the values
    $valsfmt = "'". implode("', '", $s) ."'";

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

Dries's avatar
 
Dries committed
443
    // Call the node specific callback (if any):
Dries's avatar
 
Dries committed
444 445
    node_invoke($node, 'insert');
    node_invoke_nodeapi($node, 'insert');
Dries's avatar
 
Dries committed
446 447 448 449 450 451 452
  }
  else {

    /*
    ** Update an existing node:
    */

Dries's avatar
 
Dries committed
453
    // Set some required fields:
Dries's avatar
 
Dries committed
454 455
    $node->changed = time();

Dries's avatar
 
Dries committed
456
    // Prepare the query:
Dries's avatar
 
Dries committed
457 458
    foreach ($node as $key => $value) {
      if (in_array($key, $fields)) {
Dries's avatar
 
Dries committed
459 460
        $q[] = check_query($key) ." = '%s'";
        $v[] = $value;
Dries's avatar
 
Dries committed
461 462 463
      }
    }

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

Dries's avatar
 
Dries committed
467
    // Call the node specific callback (if any):
Dries's avatar
 
Dries committed
468 469
    node_invoke($node, 'update');
    node_invoke_nodeapi($node, 'update');
Dries's avatar
 
Dries committed
470 471
  }

Dries's avatar
 
Dries committed
472
  /*
Dries's avatar
 
Dries committed
473 474
  ** Clear the cache so an anonymous poster can see the node being
  ** added or updated.
Dries's avatar
 
Dries committed
475 476 477 478
  */

  cache_clear_all();

Dries's avatar
 
Dries committed
479 480 481 482 483 484 485 486
  /*
  ** Return the node ID:
  */

  return $node->nid;

}

Dries's avatar
 
Dries committed
487
function node_view($node, $main = 0, $page = 0) {
Dries's avatar
 
Dries committed
488

Dries's avatar
 
Dries committed
489
  $node = array2object($node);
Dries's avatar
 
Dries committed
490

Dries's avatar
 
Dries committed
491 492
  /*
  ** Remove the delimiter (if any) that seperates the teaser from the
Dries's avatar
Dries committed
493
  ** body. TODO: this strips legitimate uses of '<!--break-->' also.
Dries's avatar
 
Dries committed
494 495
  */

Dries's avatar
 
Dries committed
496
  $node->body = str_replace('<!--break-->', '', $node->body);
Dries's avatar
 
Dries committed
497

Dries's avatar
 
Dries committed
498 499 500
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $main, $page);

Dries's avatar
 
Dries committed
501
  /*
Dries's avatar
 
Dries committed
502
  ** The 'view' hook can be implemented to overwrite the default function
Dries's avatar
 
Dries committed
503 504 505
  ** to display nodes.
  */

Dries's avatar
 
Dries committed
506 507
  if (node_hook($node, 'view')) {
    return node_invoke($node, 'view', $main, $page);
Dries's avatar
 
Dries committed
508 509 510 511 512 513 514
  }
  else {

    /*
    ** Default behavior:
    */

Dries's avatar
 
Dries committed
515
    return theme('node', node_prepare($node, $main), $main, $page);
Dries's avatar
 
Dries committed
516 517
  }
}
Dries's avatar
 
Dries committed
518

Dries's avatar
 
Dries committed
519
function node_prepare($node, $main = 0) {
Dries's avatar
 
Dries committed
520
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
 
Dries committed
521 522
  if ($main == 0) {
    $node->body = check_output($node->body);
Dries's avatar
 
Dries committed
523 524 525
  }
  else {
    $node->teaser = check_output($node->teaser);
Dries's avatar
 
Dries committed
526
  }
Dries's avatar
 
Dries committed
527
  return $node;
Dries's avatar
 
Dries committed
528 529
}

Dries's avatar
 
Dries committed
530 531
function node_show($node, $cid) {

Dries's avatar
 
Dries committed
532
  if (node_access('view', $node)) {
Dries's avatar
 
Dries committed
533

Dries's avatar
 
Dries committed
534
    $output = node_view($node, 0, 1);
Dries's avatar
 
Dries committed
535

Dries's avatar
 
Dries committed
536
    if (function_exists('comment_render') && $node->comment) {
Dries's avatar
 
Dries committed
537
      $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
538
    }
Dries's avatar
 
Dries committed
539 540 541 542 543 544

    /*
    ** Update the history table, stating that this user viewed this node.
    */

    node_tag_new($node->nid);
Dries's avatar
 
Dries committed
545 546

    return $output;
Dries's avatar
 
Dries committed
547
  }
Dries's avatar
 
Dries committed
548 549 550
  else {
    drupal_set_message(message_access());
  }
Dries's avatar
 
Dries committed
551 552
}

Dries's avatar
 
Dries committed
553 554
function node_access($op, $node = 0) {

Dries's avatar
 
Dries committed
555
  if (user_access('administer nodes')) {
Dries's avatar
 
Dries committed
556
    return 1;
Dries's avatar
 
Dries committed
557 558
  }

Dries's avatar
 
Dries committed
559 560 561
  /*
  ** Convert the node to an object if necessary:
  */
Dries's avatar
 
Dries committed
562

Dries's avatar
 
Dries committed
563
  $node = array2object($node);
Dries's avatar
 
Dries committed
564

Dries's avatar
 
Dries committed
565 566
  // Can't use node_invoke:
  // the access hook takes the $op parameter before the $node parameter.
Dries's avatar
 
Dries committed
567
  return module_invoke(node_get_module_name($node), 'access', $op, $node);
Dries's avatar
 
Dries committed
568 569
}

Dries's avatar
 
Dries committed
570
function node_perm() {
Dries's avatar
 
Dries committed
571
  return array('administer nodes', 'access content');
Dries's avatar
 
Dries committed
572 573
}

Dries's avatar
 
Dries committed
574 575
function node_search($keys) {

Kjartan's avatar
Kjartan committed
576 577 578
  // Return the results of performing a search using the indexed search
  // for this particular type of node.
  //
Dries's avatar
 
Dries committed
579
  // Pass an array to the 'do_search' function which dictates what it
Kjartan's avatar
Kjartan committed
580 581 582 583 584 585 586 587
  // will search through, and what it will search for
  //
  // "keys"'s value is the keywords entered by the user
  //
  // "type"'s value is used to identify the node type in the search
  // index.
  //
  // "select"'s value is used to relate the data from the specific nodes
Dries's avatar
 
Dries committed
588
  // table to the data that the search_index table has in it, and the the
Kjartan's avatar
Kjartan committed
589 590
  // do_search functino will rank it.
  //
Dries's avatar
 
Dries committed
591
  // The select must always provide the following fields - lno, title,
Kjartan's avatar
Kjartan committed
592 593
  // created, uid, name, count
  //
Dries's avatar
 
Dries committed
594
  $find = do_search(array('keys' => $keys, 'type' => 'node', 'select' => "select s.lno as lno, n.title as title, n.created as created, u.uid as uid, u.name as name, s.count as count FROM {search_index} s, {node} n INNER JOIN {users} u ON n.uid = u.uid WHERE s.lno = n.nid AND s.type = 'node' AND s.word like '%' AND n.status = 1"));
Dries's avatar
 
Dries committed
595

Dries's avatar
 
Dries committed
596
  return array(t('Matching nodes ranked in order of relevance'), $find);
Dries's avatar
 
Dries committed
597 598
}

599
function node_settings() {
Dries's avatar
 
Dries committed
600
  $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.'));
601
  $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
602
  $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
603

Dries's avatar
 
Dries committed
604 605 606
  return $output;
}

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

Dries's avatar
 
Dries committed
620 621
  $links = array();

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

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

Dries's avatar
 
Dries committed
631 632
    if (user_access('administer nodes')) {
      $links[] = l(t('administer'), "admin/node/edit/$node->nid", array('title' => t('Administer this node.')));
Dries's avatar
 
Dries committed
633 634
    }

Dries's avatar
 
Dries committed
635 636
    if (user_access('administer nodes') && $node->revisions) {
      $links[] = l(t('revisions'), "node/revisions/$node->nid", array('title' => t('Administer revisions.')));
Dries's avatar
 
Dries committed
637
    }
Dries's avatar
 
Dries committed
638 639
  }

Dries's avatar
 
Dries committed
640 641
  if ($type == 'system') {
    menu('node/add', t('create content'), 'node_page', 1, MENU_HIDE_NOCHILD);
Dries's avatar
 
Dries committed
642

Dries's avatar
 
Dries committed
643 644 645 646 647 648
    menu('admin/node', t('content'), user_access('administer nodes') ? 'node_admin' : MENU_DENIED);
    menu('admin/node/help', t('help'), user_access('administer nodes') ? 'node_help_page' : MENU_DENIED, 9);
    menu('admin/node/edit', t('edit post'), user_access('administer nodes') ? 'node_admin' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);
    menu('admin/node/settings', t('settings'), user_access('administer nodes') ? 'node_admin' : MENU_DENIED, 8);
    if (module_exist('search')) {
      menu('admin/node/search', t('search'), user_access('administer nodes') ? 'node_admin' : MENU_DENIED, 8);
Dries's avatar
 
Dries committed
649
    }
Dries's avatar
 
Dries committed
650

Dries's avatar
 
Dries committed
651
    menu('node', t('content'), user_access('access content') ? 'node_page' : MENU_DENIED, 0, MENU_HIDE);
Dries's avatar
 
Dries committed
652 653
  }

Dries's avatar
 
Dries committed
654
  return $links;
Dries's avatar
 
Dries committed
655 656
}

Dries's avatar
 
Dries committed
657
function node_admin_edit($node) {
Dries's avatar
 
Dries committed
658

Dries's avatar
 
Dries committed
659
  if (is_numeric($node)) {
Dries's avatar
 
Dries committed
660
    $node = node_load(array('nid' => $node));
Dries's avatar
 
Dries committed
661
  }
Dries's avatar
 
Dries committed
662

Dries's avatar
 
Dries committed
663
  $output .= node_form($node);
Dries's avatar
 
Dries committed
664

Dries's avatar
 
Dries committed
665
  /*
Dries's avatar
 
Dries committed
666
  ** Display the node form extensions:
Dries's avatar
 
Dries committed
667
  */
668
  $output .= implode("\n", module_invoke_all('node_link', $node));
Dries's avatar
Dries committed
669

Dries's avatar
 
Dries committed
670
  return $output;
Dries's avatar
 
Dries committed
671 672 673

}

Dries's avatar
 
Dries committed
674
function node_admin_nodes() {
Dries's avatar
 
Dries committed
675
  $filters = array(
Dries's avatar
 
Dries committed
676 677 678 679 680 681
    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 static'), 'WHERE n.status = 1 AND n.static = 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
682 683 684
   );

  $operations = array(
Dries's avatar
 
Dries committed
685 686 687 688 689
    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'),
    array(t('Make the selected posts static'), 'UPDATE {node} SET status = 1, static = 1 WHERE nid = %d'),
    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
690
  );
Dries's avatar
 
Dries committed
691

Dries's avatar
 
Dries committed
692 693 694 695
  /*
  ** Handle operations:
  */

Dries's avatar
 
Dries committed
696 697
  if (empty($_SESSION['node_overview_filter'])) {
    $_SESSION['node_overview_filter'] = 0;
Dries's avatar
 
Dries committed
698 699
  }

700 701 702
  $op = $_POST['op'];

  if ($op == t('Filter') && isset($_POST['edit']['filter'])) {
Dries's avatar
 
Dries committed
703
    $_SESSION['node_overview_filter'] = $_POST['edit']['filter'];
Dries's avatar
 
Dries committed
704 705
  }

706
  if ($op == t('Update') && isset($_POST['edit']['operation']) && isset($_POST['edit']['status'])) {
Dries's avatar
 
Dries committed
707 708
    $operation = $operations[$_POST['edit']['operation']][1];
    foreach ($_POST['edit']['status'] as $nid => $value) {
Dries's avatar
 
Dries committed
709
      if ($value) {
Dries's avatar
Dries committed
710
        db_query($operation, $nid);
Dries's avatar
 
Dries committed
711 712 713
      }
    }

Dries's avatar
 
Dries committed
714
    drupal_set_message(t('the update has been performed.'));
Dries's avatar
 
Dries committed
715 716
  }

Dries's avatar
 
Dries committed
717
  $filter = $_SESSION['node_overview_filter'];
Dries's avatar
Dries committed
718

Dries's avatar
 
Dries committed
719 720 721 722 723 724 725 726
  /*
  ** Render filter form:
  */

  $options = array();
  foreach ($filters as $key => $value) {
    $options[] = $value[0];
  }
Dries's avatar
 
Dries committed
727

Dries's avatar
 
Dries committed
728
  $form  = form_select(NULL, 'filter', $filter, $options);
729
  $form .= form_submit(t('Filter'));
Dries's avatar
 
Dries committed
730

Dries's avatar
 
Dries committed
731
  $output .= '<h3>'. t('Filter options') .'</h3>';
Dries's avatar
 
Dries committed
732 733 734 735 736 737
  $output .= "<div class=\"container-inline\">$form</div>";

  /*
  ** Render operations form:
  */

738 739 740 741 742
  $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);

  // 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
743 744 745 746 747
  $options = array();
  foreach ($operations as $key => $value) {
    $options[] = $value[0];
  }

748 749
  $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
750

Dries's avatar
 
Dries committed
751
  $output .= '<h3>'. t('Update options') .'</h3>';
Dries's avatar
 
Dries committed
752 753 754 755 756 757
  $output .= "<div class=\"container-inline\">$form</div>";

  /*
  ** Overview table:
  */

Dries's avatar
 
Dries committed
758
  $header = array(NULL, t('title'), t('type'), t('author'), t('status'), array('data' => t('operations'), 'colspan' => 2));
Dries's avatar
 
Dries committed
759

Dries's avatar
 
Dries committed
760
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
761
    $rows[] = array(form_checkbox(NULL, "status][$node->nid", 1, 0), l($node->title, "node/view/$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'), "admin/node/edit/$node->nid"), l(t('delete node'), "admin/node/delete/$node->nid"));
Dries's avatar
 
Dries committed
762
  }
Dries's avatar
 
Dries committed
763

Dries's avatar
 
Dries committed
764 765
  if ($pager = theme('pager', NULL, 50, 0)) {
    $rows[] = array(array('data' => $pager, 'colspan' => 7));
Dries's avatar
 
Dries committed
766
  }
Dries's avatar
 
Dries committed
767

Dries's avatar
 
Dries committed
768 769
  $output .= '<h3>'. $filters[$filter][0] .'</h3>';
  $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
770
  return form($output);
Dries's avatar
Dries committed
771 772
}

773
function node_admin_settings($edit) {
Dries's avatar
 
Dries committed
774
  $op = $_POST['op'];
Kjartan's avatar
Kjartan committed
775

Dries's avatar
 
Dries committed
776
  if ($op == t('Save configuration')) {
777 778 779 780 781 782 783
    /*
    ** Save the configuration options:
    */

    foreach ($edit as $name => $value) {
      variable_set($name, $value);
    }
Dries's avatar
 
Dries committed
784
    drupal_set_message(t('the content settings have been saved.'));
785 786
  }

Dries's avatar
 
Dries committed
787
  if ($op == t('Reset to defaults')) {
788 789 790 791 792 793 794
    /*
    ** Reset the configuration options to their default value:
    */

    foreach ($edit as $name => $value) {
      variable_del($name);
    }
Dries's avatar
 
Dries committed
795
    drupal_set_message(t('the content settings have been reset to their default values.'));
796 797
  }

Dries's avatar
 
Dries committed
798
  $header = array_merge(array(t('type')), array_keys(node_invoke_nodeapi($node, 'settings')));
Dries's avatar
 
Dries committed
799
  foreach (node_list() as $type) {
Dries's avatar
 
Dries committed
800 801
    $node->type = $type;
    $cols = array();
Dries's avatar
 
Dries committed
802 803
    foreach (node_invoke_nodeapi($node, 'settings') as $setting) {
      $cols[] = array('data' => $setting, 'align' => 'center', 'width' => 55);
804
    }
Dries's avatar
 
Dries committed
805
    $rows[] = array_merge(array(node_invoke($node, 'node_name')), $cols);
806
  }
Kjartan's avatar
Kjartan committed
807

Dries's avatar
 
Dries committed
808
  $output .= theme('table', $header, $rows);
809

Dries's avatar
 
Dries committed
810 811
  $output .= form_submit(t('Save configuration'));
  $output .= form_submit(t('Reset to defaults'));
Kjartan's avatar
Kjartan committed
812

Dries's avatar
 
Dries committed
813
  return form($output);
814 815 816

}

Dries's avatar
 
Dries committed
817 818
function node_revision_overview($nid) {

Dries's avatar
 
Dries committed
819 820
  if (user_access('administer nodes')) {
    $node = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
821 822

    if ($node->revisions) {
Dries's avatar
 
Dries committed
823
      $header = array(t('older revisions'), array('colspan' => '3', 'data' => t('operations')));
Dries's avatar
 
Dries committed
824 825

      foreach ($node->revisions as $key => $revision) {
Dries's avatar
 
Dries committed
826
        $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/view/$node->nid", array(), "revision=$key"), l(t('rollback'), "node/rollback-revision/$node->nid/$key"), l(t('delete'), "node/delete-revision/$node->nid/$key"));
Dries's avatar
 
Dries committed
827
      }
Dries's avatar
 
Dries committed
828
      $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
829 830 831 832 833 834 835
    }
  }

  return $output;
}


Dries's avatar
 
Dries committed
836 837 838 839 840
/*
** Return the revision with the specified revision number.
*/

function node_revision_load($node, $revision) {
Dries's avatar
 
Dries committed
841
  return $node->revisions[$revision]['node'];
Dries's avatar
 
Dries committed
842 843 844 845 846 847
}

/*
** Create and return a new revision of the given node.
*/

Dries's avatar
 
Dries committed
848 849 850
function node_revision_create($node) {
  global $user;

Dries's avatar
 
Dries committed
851 852 853 854 855
  /*
  ** 'revision' is the name of the field used to indicicate that we
  ** have to create a new revision of a node.
  */

Dries's avatar
 
Dries committed
856
  if ($node->nid && $node->revision) {
Dries's avatar
 
Dries committed
857
    $prev = node_load(array('nid' => $node->nid));
Dries's avatar
 
Dries committed
858 859
    $node->revisions = $prev->revisions;
    unset($prev->revisions);
Dries's avatar
 
Dries committed
860
    $node->revisions[] = array('uid' => $user->uid, 'timestamp' => time(), 'node' => $prev, 'history' => $node->history);
Dries's avatar
 
Dries committed
861 862