node.module 57.5 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 7 8 9
/**
 * Implementation of hook_help().
 */
function node_help($section) {
Dries's avatar
 
Dries committed
10
  global $mod;
11 12

  switch ($section) {
Dries's avatar
 
Dries committed
13
    case 'admin/help#node':
Dries's avatar
 
Dries committed
14
      $output = t("
Dries's avatar
 
Dries committed
15 16 17 18 19 20 21
      <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>
22
      <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
23 24
      <dt>Authored on</dt><dd>The date the node was written.</dd>
      <dt>Changed</dt><dd>The last time this node was changed.</dd>
25
      <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
26 27
      <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
28
      <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>
Dries's avatar
 
Dries committed
29 30 31 32
      <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>
33
      <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>
34
      <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
35

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

Dries's avatar
 
Dries committed
44
    case 'admin/modules#description':
Dries's avatar
 
Dries committed
45
      return t('The core that allows content to be submitted to the site.');
46 47
    case 'admin/node/configure':
    case 'admin/node/configure/settings':
Dries's avatar
 
Dries committed
48
      return t('Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.');
49
    case 'admin/node':
Dries's avatar
 
Dries committed
50
      return t('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.', array('%comments' => url('admin/comment')));
51
    case 'admin/node/search':
Dries's avatar
 
Dries committed
52
      return 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".');
53
    case 'admin/node/configure/defaults':
Dries's avatar
 
Dries committed
54
      return t('This page lets you set the defaults used during creation of nodes for all the different node types.<br /><em>comment:</em> Read/write setting for comments.<br /><em>publish:</em> Is this post publicly viewable, has it been published?<br /><em>promote:</em> Is this post to be promoted to the front page?<br /><em>moderate:</em> Does this post need approval before it can be viewed?<br /><em>sticky:</em> Is this post always visible at the top of lists?<br /><em>revision:</em> Will this post go into the revision system allowing multiple versions to be saved?');
Dries's avatar
 
Dries committed
55 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
/**
 * Menu callback; presents node-specific imformation from admin/help.
 */
Dries's avatar
 
Dries committed
68
function node_help_page() {
Dries's avatar
 
Dries committed
69
  print theme('page', node_help('admin/help#node'));
Dries's avatar
 
Dries committed
70 71 72
}


Dries's avatar
 
Dries committed
73 74 75 76 77 78 79 80 81 82 83
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
 *   A DB result object from a query to fetch node objects.
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
 *   An HTML list suitable as content for a block.
 */
Dries's avatar
 
Dries committed
84 85
function node_title_list($result, $title = NULL) {
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
86
    $number = module_invoke('comment', 'num_all', $node->nid);
Dries's avatar
 
Dries committed
87
    $items[] = l($node->title, "node/$node->nid", array('title' => format_plural($number, '1 comment', '%count comments')));
Dries's avatar
 
Dries committed
88 89
  }

Dries's avatar
 
Dries committed
90
  return theme('node_list', $items, $title);
Dries's avatar
 
Dries committed
91 92
}

Dries's avatar
 
Dries committed
93 94 95
/**
 * Format a listing of links to nodes.
 */
Dries's avatar
 
Dries committed
96
function theme_node_list($items, $title = NULL) {
Dries's avatar
 
Dries committed
97
  return theme('item_list', $items, $title);
Dries's avatar
 
Dries committed
98 99
}

Dries's avatar
 
Dries committed
100 101 102
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
103 104 105 106
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
Dries's avatar
 
Dries committed
107
    if (node_last_viewed($nid)) {
Dries's avatar
 
Dries committed
108
      db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
Dries's avatar
 
Dries committed
109 110
    }
    else {
Dries's avatar
 
Dries committed
111
      db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
Dries's avatar
 
Dries committed
112 113 114 115
    }
  }
}

Dries's avatar
 
Dries committed
116 117 118 119
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
120 121
function node_last_viewed($nid) {
  global $user;
Dries's avatar
 
Dries committed
122
  static $history;
Dries's avatar
 
Dries committed
123

Dries's avatar
 
Dries committed
124 125 126 127 128
  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
129 130 131
}

/**
Dries's avatar
 
Dries committed
132
 * Determines whether the supplied timestamp is newer than the user's last view
Dries's avatar
 
Dries committed
133
 * of a given node.
Dries's avatar
 
Dries committed
134
 *
Dries's avatar
 
Dries committed
135 136 137 138
 * @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
139
 */
Dries's avatar
 
Dries committed
140 141 142 143
function node_is_new($nid, $timestamp) {
  global $user;
  static $cache;

Dries's avatar
Dries committed
144
  if (!isset($cache[$nid])) {
Dries's avatar
 
Dries committed
145
    if ($user->uid) {
Dries's avatar
 
Dries committed
146
      $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
147 148 149 150 151 152
    }
    else {
      $cache[$nid] = time();
    }
  }

153
  return ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT);
Dries's avatar
 
Dries committed
154 155
}

Dries's avatar
 
Dries committed
156 157 158
/**
 * Autogenerate a teaser for the given body text.
 */
Dries's avatar
 
Dries committed
159 160
function node_teaser($body) {

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

Dries's avatar
 
Dries committed
163 164 165 166 167
  // 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
168 169
    return $body;
  }
Dries's avatar
 
Dries committed
170

171 172 173 174 175
  // 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
176
  // If a valid delimiter has been specified, use it to chop of the teaser.
Dries's avatar
 
Dries committed
177
  if ($delimiter > 0) {
Dries's avatar
 
Dries committed
178 179 180
    return substr($body, 0, $delimiter);
  }

Dries's avatar
 
Dries committed
181
  // If we have a short body, return the entire body.
Dries's avatar
 
Dries committed
182 183 184 185
  if (strlen($body) < $size) {
    return $body;
  }

Dries's avatar
 
Dries committed
186 187
  // 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
188
  if ($length = strpos($body, '</p>', $size)) {
Dries's avatar
 
Dries committed
189
    return substr($body, 0, $length + 4);
Dries's avatar
 
Dries committed
190 191
  }

Dries's avatar
 
Dries committed
192
  if ($length = strpos($body, '<br />', $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
  if ($length = strpos($body, '<br>', $size)) {
Dries's avatar
 
Dries committed
197 198 199
    return substr($body, 0, $length);
  }

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

Dries's avatar
 
Dries committed
204 205
  // When even the first paragraph is too long, try to split at the end of
  // the next sentence.
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);
  }

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

Dries's avatar
 
Dries committed
214
  if ($length = strpos($body, '? ', $size)) {
Dries's avatar
 
Dries committed
215 216 217
    return substr($body, 0, $length + 1);
  }

218 219 220 221 222 223 224 225 226 227 228 229
  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
230
  // If all else fails, simply truncate the string.
231
  return truncate_utf8($body, $size);
Dries's avatar
 
Dries committed
232 233
}

Dries's avatar
 
Dries committed
234

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

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

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

  return function_exists($function);
}

310
/**
Dries's avatar
 
Dries committed
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
Dries's avatar
 
Dries committed
320
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
321 322
 */
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
323
  $function = node_get_module_name($node) ."_$hook";
Dries's avatar
 
Dries committed
324 325

  if (function_exists($function)) {
Dries's avatar
 
Dries committed
326
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
327 328 329
  }
}

Dries's avatar
 
Dries committed
330 331 332 333 334 335 336 337 338 339 340 341
/**
 * 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
342
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
Dries's avatar
 
Dries committed
343 344
  $return = array();
  foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
345
    $function = $name .'_nodeapi';
Dries's avatar
 
Dries committed
346
    if (function_exists($function)) {
Dries's avatar
 
Dries committed
347
      $result = $function($node, $op, $a3, $a4);
Dries's avatar
 
Dries committed
348 349 350 351 352 353 354 355
      if (isset($result)) {
        $return = array_merge($return, $result);
      }
    }
  }
  return $return;
}

Dries's avatar
 
Dries committed
356 357 358 359 360 361 362 363 364 365 366 367
/**
 * 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.
 *
 * @return
 *   A fully-populated node object.
 */
Dries's avatar
 
Dries committed
368
function node_load($conditions, $revision = -1) {
Dries's avatar
 
Dries committed
369
  // Turn the conditions into a query.
Dries's avatar
 
Dries committed
370
  foreach ($conditions as $key => $value) {
Dries's avatar
 
Dries committed
371
    $cond[] = 'n.'. check_query($key) ." = '". check_query($value) ."'";
Dries's avatar
 
Dries committed
372 373
  }

Dries's avatar
 
Dries committed
374
  // Retrieve the node.
Dries's avatar
 
Dries committed
375
  $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
376
  $node = drupal_unpack($node);
Dries's avatar
 
Dries committed
377

Dries's avatar
 
Dries committed
378
  // Unserialize the revisions and user data fields.
Dries's avatar
 
Dries committed
379 380 381 382
  if ($node->revisions) {
    $node->revisions = unserialize($node->revisions);
  }

Dries's avatar
 
Dries committed
383 384
  // Call the node specific callback (if any) and piggy-back the
  // results to the node or overwrite some values.
Dries's avatar
 
Dries committed
385
  if ($extra = node_invoke($node, 'load')) {
Dries's avatar
 
Dries committed
386 387 388 389 390
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
391 392 393 394 395 396
  if ($extra = node_invoke_nodeapi($node, 'load')) {
    foreach ($extra as $key => $value) {
      $node->$key = $value;
    }
  }

Dries's avatar
 
Dries committed
397
  // Return the desired revision.
Dries's avatar
 
Dries committed
398
  if ($revision != -1 && isset($node->revisions[$revision])) {
399
   $node = $node->revisions[$revision]['node'];
Dries's avatar
 
Dries committed
400 401
  }

Dries's avatar
 
Dries committed
402 403 404
  return $node;
}

Dries's avatar
 
Dries committed
405 406 407
/**
 * Save a node object into the database.
 */
408
function node_save($node) {
Dries's avatar
 
Dries committed
409
  // Fetch fields to save to node table:
Dries's avatar
 
Dries committed
410
  $fields = node_invoke_nodeapi($node, 'fields');
Dries's avatar
 
Dries committed
411

Dries's avatar
 
Dries committed
412
  // Serialize the revisions field:
Dries's avatar
 
Dries committed
413 414 415 416
  if ($node->revisions) {
    $node->revisions = serialize($node->revisions);
  }

Dries's avatar
 
Dries committed
417
  // Apply filters to some default node fields:
Dries's avatar
 
Dries committed
418
  if (empty($node->nid)) {
Dries's avatar
 
Dries committed
419
    // Insert a new node.
Dries's avatar
 
Dries committed
420

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

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

Dries's avatar
 
Dries committed
439
    $keysfmt = implode(', ', $s);
Dries's avatar
 
Dries committed
440
    // We need to quote the placeholders for the values.
Dries's avatar
 
Dries committed
441 442
    $valsfmt = "'". implode("', '", $s) ."'";

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

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

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
  // Clear the cache so an anonymous poster can see the node being added or updated.
Dries's avatar
 
Dries committed
473 474
  cache_clear_all();

Dries's avatar
 
Dries committed
475
  // Return the node ID:
Dries's avatar
 
Dries committed
476 477 478
  return $node->nid;
}

Dries's avatar
 
Dries committed
479 480 481 482 483 484 485 486 487 488 489 490 491
/**
 * 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.
 *
 * @return
 *   An HTML representation of the themed node.
 */
Dries's avatar
 
Dries committed
492
function node_view($node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
493
  $node = array2object($node);
Dries's avatar
 
Dries committed
494

Dries's avatar
 
Dries committed
495 496
  // Remove the delimiter (if any) that seperates the teaser from the body.
  // TODO: this strips legitimate uses of '<!--break-->' also.
Dries's avatar
 
Dries committed
497
  $node->body = str_replace('<!--break-->', '', $node->body);
Dries's avatar
 
Dries committed
498

Dries's avatar
 
Dries committed
499 500
  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
Dries's avatar
 
Dries committed
501
  if (node_hook($node, 'view')) {
Dries's avatar
 
Dries committed
502
    node_invoke($node, 'view', $teaser, $page);
Dries's avatar
 
Dries committed
503 504
  }
  else {
Dries's avatar
 
Dries committed
505
    $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
506
  }
Dries's avatar
 
Dries committed
507 508 509 510
  // Allow modules to change $node->body before viewing.
  node_invoke_nodeapi($node, 'view', $teaser, $page);

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

Dries's avatar
 
Dries committed
513 514 515
/**
 * Apply filters to a node in preparation for theming.
 */
Dries's avatar
 
Dries committed
516
function node_prepare($node, $teaser = FALSE) {
Dries's avatar
 
Dries committed
517
  $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
 
Dries committed
518
  if ($teaser == FALSE) {
519
    $node->body = check_output($node->body, $node->format);
Dries's avatar
 
Dries committed
520 521
  }
  else {
522
    $node->teaser = check_output($node->teaser, $node->format);
Dries's avatar
 
Dries committed
523
  }
Dries's avatar
 
Dries committed
524
  return $node;
Dries's avatar
 
Dries committed
525 526
}

Dries's avatar
 
Dries committed
527 528 529
/**
 * Generate a page displaying a single node, along with its comments.
 */
Dries's avatar
 
Dries committed
530
function node_show($node, $cid) {
Dries's avatar
 
Dries committed
531
  $output = node_view($node, FALSE, TRUE);
Dries's avatar
 
Dries committed
532

Dries's avatar
 
Dries committed
533 534
  if (function_exists('comment_render') && $node->comment) {
    $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
535 536
  }

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

Dries's avatar
 
Dries committed
540
  return $output;
Dries's avatar
 
Dries committed
541 542
}

Dries's avatar
 
Dries committed
543 544 545
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
546
function node_perm() {
Dries's avatar
 
Dries committed
547
  return array('administer nodes', 'access content');
Dries's avatar
 
Dries committed
548 549
}

Dries's avatar
 
Dries committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
/**
 * Implementation of hook_search().
 *
 * Return the results of performing a search using the indexed search
 * for this particular type of node.
 *
 * Pass an array to the 'do_search' function which dictates what it
 * 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
 * table to the data that the search_index table has in it, and the the
 * do_search functino will rank it.
 *
 * The select must always provide the following fields: lno, title,
 * created, uid, name, and count.
 */
Dries's avatar
 
Dries committed
571
function node_search($keys) {
Dries's avatar
 
Dries committed
572
  $find = do_search(array('keys' => $keys, 'type' => 'node', 'select' => "SELECT DISTINCT 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 ". node_access_join_sql() ." 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 AND ". node_access_where_sql()));
Dries's avatar
 
Dries committed
573

Dries's avatar
 
Dries committed
574
  return array(t('Matching nodes ranked in order of relevance'), $find);
Dries's avatar
 
Dries committed
575 576
}

Dries's avatar
 
Dries committed
577
/**
Dries's avatar
 
Dries committed
578
 * Menu callback; presents general node configuration options.
Dries's avatar
 
Dries committed
579 580 581 582 583 584
 */
function node_configure() {
  if ($_POST) {
    system_settings_save();
  }

Dries's avatar
 
Dries committed
585
  $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.'));
586
  $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
587
  $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
588

Dries's avatar
 
Dries committed
589
  print theme('page', system_settings_form($output));
Dries's avatar
 
Dries committed
590 591
}

Dries's avatar
 
Dries committed
592 593 594
/**
 * Retrieve the comment mode for the given node ID (none, read, or read/write).
 */
Dries's avatar
 
Dries committed
595
function node_comment_mode($nid) {
Dries's avatar
 
Dries committed
596 597
  static $comment_mode;
  if (!isset($comment_mode[$nid])) {
Dries's avatar
 
Dries committed
598
    $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
Dries's avatar
 
Dries committed
599 600
  }
  return $comment_mode[$nid];
Dries's avatar
 
Dries committed
601 602
}

Dries's avatar
 
Dries committed
603 604 605
/**
 * Implementation of hook_link().
 */
606
function node_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
607 608
  $links = array();

Dries's avatar
 
Dries committed
609
  if ($type == 'node') {
Dries's avatar
 
Dries committed
610
    if (array_key_exists('links', $node)) {
Kjartan's avatar
Kjartan committed
611 612
      $links = $node->links;
    }
Dries's avatar
 
Dries committed
613

Dries's avatar
 
Dries committed
614
    if ($main == 1 && $node->teaser && $node->readmore) {
Dries's avatar
 
Dries committed
615
      $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
616
    }
Dries's avatar
 
Dries committed
617 618
  }

Dries's avatar
 
Dries committed
619
  return $links;
Dries's avatar
 
Dries committed
620 621
}

Dries's avatar
 
Dries committed
622 623 624 625 626 627 628 629 630
/**
 * Implementation of hook_menu().
 */
function node_menu() {
  $items = array();

  $items[] = array('path' => 'admin/node', 'title' => t('content'),
    'callback' => 'node_admin',
    'access' => user_access('administer nodes'));
Dries's avatar
 
Dries committed
631 632
  $items[] = array('path' => 'admin/node/overview', 'title' => t('list'),
    'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
633 634 635 636
  $items[] = array('path' => 'admin/node/configure', 'title' => t('configure'),
    'callback' => 'node_configure',
    'access' => user_access('administer nodes'),
    'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
637 638 639 640 641 642
  $items[] = array('path' => 'admin/node/configure/settings', 'title' => t('settings'),
    'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
  $items[] = array('path' => 'admin/node/configure/defaults', 'title' => t('default workflow'),
    'callback' => 'node_default_settings',
    'access' => user_access('administer nodes'),
    'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
  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);
  }

  $items[] = array('path' => 'node', 'title' => t('content'),
    'callback' => 'node_page',
    'access' => user_access('access content'),
    'type' => MENU_SUGGESTED_ITEM);
  $items[] = array('path' => 'node/add', 'title' => t('create content'),
    'callback' => 'node_page',
    'access' => user_access('access content'),
    'type' => MENU_ITEM_GROUPING,
    'weight' => 1);

  if (arg(0) == 'node' && is_numeric(arg(1))) {
Dries's avatar
 
Dries committed
661 662
    $node = node_load(array('nid' => arg(1)));

Dries's avatar
 
Dries committed
663 664
    $items[] = array('path' => 'node/'. arg(1), 'title' => t('view'),
      'callback' => 'node_page',
Dries's avatar
 
Dries committed
665
      'access' => node_access('view', $node),
Dries's avatar
 
Dries committed
666
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
667 668
    $items[] = array('path' => 'node/'. arg(1) .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
 
Dries committed
669 670
    $items[] = array('path' => 'node/'. arg(1) .'/edit', 'title' => t('edit'),
      'callback' => 'node_page',
Dries's avatar
 
Dries committed
671
      'access' => node_access('update', $node),
672
      'weight' => 1,
Dries's avatar
 
Dries committed
673
      'type' => MENU_LOCAL_TASK);
674 675 676 677 678 679 680 681

    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
682 683 684 685 686
  }

  return $items;
}

Dries's avatar
 
Dries committed
687 688
function node_admin_edit($node) {
  if (is_numeric($node)) {
Dries's avatar
 
Dries committed
689
    $node = node_load(array('nid' => $node));
Dries's avatar
 
Dries committed
690
  }
Dries's avatar
 
Dries committed
691

Dries's avatar
 
Dries committed
692
  $output .= node_form($node);
Dries's avatar
 
Dries committed
693

Dries's avatar
 
Dries committed
694
  // Display the node form extensions:
695
  $output .= implode("\n", module_invoke_all('node_link', $node));
Dries's avatar
Dries committed
696

Dries's avatar
 
Dries committed
697
  return $output;
Dries's avatar
 
Dries committed
698 699
}

Dries's avatar
 
Dries committed
700 701 702
/**
 * Generate the content administation overview.
 */
Dries's avatar
 
Dries committed
703
function node_admin_nodes() {
Dries's avatar
 
Dries committed
704
  $filters = array(
Dries's avatar
 
Dries committed
705 706 707 708
    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'),
Dries's avatar
 
Dries committed
709
    array(t('View posts that are sticky'), 'WHERE n.status = 1 AND n.sticky = 1 ORDER BY n.changed DESC'),
Dries's avatar
 
Dries committed
710
    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
711 712 713
   );

  $operations = array(
Dries's avatar
 
Dries committed
714 715
    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
716
    array(t('Make the selected posts sticky'), 'UPDATE {node} SET status = 1, sticky = 1 WHERE nid = %d'),
Dries's avatar
 
Dries committed
717 718
    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
719
  );
Dries's avatar
 
Dries committed
720

Dries's avatar
 
Dries committed
721
  // Handle operations:
Dries's avatar
 
Dries committed
722 723
  if (empty($_SESSION['node_overview_filter'])) {
    $_SESSION['node_overview_filter'] = 0;
Dries's avatar
 
Dries committed
724 725
  }

726 727 728
  $op = $_POST['op'];

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

732
  if ($op == t('Update') && isset($_POST['edit']['operation']) && isset($_POST['edit']['status'])) {
Dries's avatar
 
Dries committed
733 734
    $operation = $operations[$_POST['edit']['operation']][1];
    foreach ($_POST['edit']['status'] as $nid => $value) {
Dries's avatar
 
Dries committed
735
      if ($value) {
Dries's avatar
Dries committed
736
        db_query($operation, $nid);
Dries's avatar
 
Dries committed
737 738 739
      }
    }

Dries's avatar
 
Dries committed
740
    drupal_set_message(t('the update has been performed.'));
Dries's avatar
 
Dries committed
741 742
  }

Dries's avatar
 
Dries committed
743
  $filter = $_SESSION['node_overview_filter'];
Dries's avatar
Dries committed
744

Dries's avatar
 
Dries committed
745
  // Render filter form:
Dries's avatar
 
Dries committed
746 747 748 749
  $options = array();
  foreach ($filters as $key => $value) {
    $options[] = $value[0];
  }
Dries's avatar
 
Dries committed
750

Dries's avatar
 
Dries committed
751
  $form  = form_select(NULL, 'filter', $filter, $options);
752
  $form .= form_submit(t('Filter'));
Dries's avatar
 
Dries committed
753

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

Dries's avatar
 
Dries committed
757
  // Render operations form:
758 759 760 761 762
  $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
763 764 765 766 767
  $options = array();
  foreach ($operations as $key => $value) {
    $options[] = $value[0];
  }

768 769
  $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
770

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

Dries's avatar
 
Dries committed
774
  // Overview table:
Dries's avatar
 
Dries committed
775
  $header = array(NULL, t('title'), t('type'), t('author'), t('status'), array('data' => t('operations'), 'colspan' => 2));
Dries's avatar
 
Dries committed
776

Dries's avatar
 
Dries committed
777
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
778
    $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
779
  }
Dries's avatar
 
Dries committed
780

Dries's avatar
 
Dries committed
781 782
  if ($pager = theme('pager', NULL, 50, 0)) {
    $rows[] = array(array('data' => $pager, 'colspan' => 7));
Dries's avatar
 
Dries committed
783
  }
Dries's avatar
 
Dries committed
784

Dries's avatar
 
Dries committed
785 786
  $output .= '<h3>'. $filters[$filter][0] .'</h3>';
  $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
787
  return form($output);
Dries's avatar
Dries committed
788 789
}

Dries's avatar
 
Dries committed
790 791 792
/**
 * Menu callback; presents the interface for setting node defaults.
 */
Dries's avatar
 
Dries committed
793
function node_default_settings() {
Dries's avatar
 
Dries committed
794
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
795
  $edit = $_POST['edit'];
Kjartan's avatar
Kjartan committed
796

Dries's avatar
 
Dries committed
797
  if ($op == t('Save configuration')) {
Dries's avatar
 
Dries committed
798
    // Save the configuration options:
799 800 801
    foreach ($edit as $name => $value) {
      variable_set($name, $value);
    }
Dries's avatar
 
Dries committed
802
    drupal_set_message(t('the content settings have been saved.'));
803 804
  }

Dries's avatar
 
Dries committed
805
  if ($op == t('Reset to defaults')) {
Dries's avatar
 
Dries committed
806
    // Reset the configuration options to their default value:
807 808 809
    foreach ($edit as $name => $value) {
      variable_del($name);
    }
Dries's avatar
 
Dries committed
810
    drupal_set_message(t('the content settings have been reset to their default values.'));
811 812
  }

Dries's avatar
 
Dries committed
813
  $header = array_merge(array(t('type')), array_keys(node_invoke_nodeapi($node, 'settings')));
Dries's avatar
 
Dries committed
814
  foreach (node_list() as $type) {
Dries's avatar
 
Dries committed
815 816
    $node->type = $type;
    $cols = array();
Dries's avatar
 
Dries committed
817 818
    foreach (node_invoke_nodeapi($node, 'settings') as $setting) {
      $cols[] = array('data' => $setting, 'align' => 'center', 'width' => 55);
819
    }
Dries's avatar
 
Dries committed
820
    $rows[] = array_merge(array(node_invoke($node, 'node_name')), $cols);
821
  }
Kjartan's avatar
Kjartan committed
822

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

Dries's avatar
 
Dries committed
825 826
  $output .= form_submit(t('Save configuration'));
  $output .= form_submit(t('Reset to defaults'));
Kjartan's avatar
Kjartan committed
827

Dries's avatar
 
Dries committed
828
  print theme('page', form($output));
829 830
}

Dries's avatar
 
Dries committed
831 832 833
/**
 * Generates an overview table of older revisions of a node.
 */
Dries's avatar
 
Dries committed
834
function node_revision_overview($nid) {
Dries's avatar
 
Dries committed
835 836
  if (user_access('administer nodes')) {
    $node = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
837

838 839
    drupal_set_title($node->title);

Dries's avatar
 
Dries committed
840
    if ($node->revisions) {
Dries's avatar
 
Dries committed
841
      $header = array(t('older revisions'), array('colspan' => '3', 'data' => t('operations')));
Dries's avatar
 
Dries committed
842 843

      foreach ($node->revisions as $key => $revision) {
844
        $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
845
      }
Dries's avatar
 
Dries committed
846
      $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
847 848 849 850 851 852 853
    }
  }

  return $output;
}


Dries's avatar
 
Dries committed
854 855 856
/**
 * Return the revision with the specified revision number.
 */
Dries's avatar
 
Dries committed
857
function node_revision_load($node, $revision) {
Dries's avatar