annotate modules/node/node.module @ 3:165d43f946a8 6.1

Drupal 6.1
author Franck Deroche <webmaster@defr.org>
date Tue, 23 Dec 2008 14:29:21 +0100
parents c1f4ac30525a
children 2427550111ae
rev   line source
webmaster@1 1 <?php
webmaster@3 2 // $Id: node.module,v 1.947.2.3 2008/02/27 17:12:58 goba Exp $
webmaster@1 3
webmaster@1 4 /**
webmaster@1 5 * @file
webmaster@1 6 * The core that allows content to be submitted to the site. Modules and scripts may
webmaster@1 7 * programmatically submit nodes using the usual form API pattern.
webmaster@1 8 */
webmaster@1 9
webmaster@1 10 define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);
webmaster@1 11
webmaster@1 12 define('NODE_BUILD_NORMAL', 0);
webmaster@1 13 define('NODE_BUILD_PREVIEW', 1);
webmaster@1 14 define('NODE_BUILD_SEARCH_INDEX', 2);
webmaster@1 15 define('NODE_BUILD_SEARCH_RESULT', 3);
webmaster@1 16 define('NODE_BUILD_RSS', 4);
webmaster@1 17 define('NODE_BUILD_PRINT', 5);
webmaster@1 18
webmaster@1 19 /**
webmaster@1 20 * Implementation of hook_help().
webmaster@1 21 */
webmaster@1 22 function node_help($path, $arg) {
webmaster@1 23 // Remind site administrators about the {node_access} table being flagged
webmaster@1 24 // for rebuild. We don't need to issue the message on the confirm form, or
webmaster@1 25 // while the rebuild is being processed.
webmaster@1 26 if ($path != 'admin/content/node-settings/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
webmaster@1 27 && user_access('access administration pages') && node_access_needs_rebuild()) {
webmaster@1 28 if ($path == 'admin/content/node-settings') {
webmaster@1 29 $message = t('The content access permissions need to be rebuilt.');
webmaster@1 30 }
webmaster@1 31 else {
webmaster@1 32 $message = t('The content access permissions need to be rebuilt. Please visit <a href="@node_access_rebuild">this page</a>.', array('@node_access_rebuild' => url('admin/content/node-settings/rebuild')));
webmaster@1 33 }
webmaster@1 34 drupal_set_message($message, 'error');
webmaster@1 35 }
webmaster@1 36
webmaster@1 37 switch ($path) {
webmaster@1 38 case 'admin/help#node':
webmaster@1 39 $output = '<p>'. t('The node module manages content on your site, and stores all posts (regardless of type) as a "node". In addition to basic publishing settings, including whether the post has been published, promoted to the site front page, or should remain present (or sticky) at the top of lists, the node module also records basic information about the author of a post. Optional revision control over edits is available. For additional functionality, the node module is often extended by other modules.') .'</p>';
webmaster@1 40 $output .= '<p>'. t('Though each post on your site is a node, each post is also of a particular <a href="@content-type">content type</a>. <a href="@content-type">Content types</a> are used to define the characteristics of a post, including the title and description of the fields displayed on its add and edit pages. Each content type may have different default settings for <em>Publishing options</em> and other workflow controls. By default, the two content types in a standard Drupal installation are <em>Page</em> and <em>Story</em>. Use the <a href="@content-type">content types page</a> to add new or edit existing content types. Additional content types also become available as you enable additional core, contributed and custom modules.', array('@content-type' => url('admin/content/types'))) .'</p>';
webmaster@1 41 $output .= '<p>'. t('The administrative <a href="@content">content page</a> allows you to review and manage your site content. The <a href="@post-settings">post settings page</a> sets certain options for the display of posts. The node module makes a number of permissions available for each content type, which may be set by role on the <a href="@permissions">permissions page</a>.', array('@content' => url('admin/content/node'), '@post-settings' => url('admin/content/node-settings'), '@permissions' => url('admin/user/permissions'))) .'</p>';
webmaster@1 42 $output .= '<p>'. t('For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) .'</p>';
webmaster@1 43 return $output;
webmaster@1 44 case 'admin/content/node':
webmaster@1 45 return ' '; // Return a non-null value so that the 'more help' link is shown.
webmaster@1 46 case 'admin/content/types':
webmaster@1 47 return '<p>'. t('Below is a list of all the content types on your site. All posts that exist on your site are instances of one of these content types.') .'</p>';
webmaster@1 48 case 'admin/content/types/add':
webmaster@1 49 return '<p>'. t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.') .'</p>';
webmaster@1 50 case 'node/%/revisions':
webmaster@1 51 return '<p>'. t('The revisions let you track differences between multiple versions of a post.') .'</p>';
webmaster@1 52 case 'node/%/edit':
webmaster@1 53 $node = node_load($arg[1]);
webmaster@1 54 $type = node_get_types('type', $node->type);
webmaster@1 55 return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
webmaster@1 56 }
webmaster@1 57
webmaster@1 58 if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
webmaster@1 59 $type = node_get_types('type', str_replace('-', '_', $arg[2]));
webmaster@1 60 return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
webmaster@1 61 }
webmaster@1 62 }
webmaster@1 63
webmaster@1 64 /**
webmaster@1 65 * Implementation of hook_theme()
webmaster@1 66 */
webmaster@1 67 function node_theme() {
webmaster@1 68 return array(
webmaster@1 69 'node' => array(
webmaster@1 70 'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
webmaster@1 71 'template' => 'node',
webmaster@1 72 ),
webmaster@1 73 'node_list' => array(
webmaster@1 74 'arguments' => array('items' => NULL, 'title' => NULL),
webmaster@1 75 ),
webmaster@1 76 'node_search_admin' => array(
webmaster@1 77 'arguments' => array('form' => NULL),
webmaster@1 78 ),
webmaster@1 79 'node_filter_form' => array(
webmaster@1 80 'arguments' => array('form' => NULL),
webmaster@1 81 'file' => 'node.admin.inc',
webmaster@1 82 ),
webmaster@1 83 'node_filters' => array(
webmaster@1 84 'arguments' => array('form' => NULL),
webmaster@1 85 'file' => 'node.admin.inc',
webmaster@1 86 ),
webmaster@1 87 'node_admin_nodes' => array(
webmaster@1 88 'arguments' => array('form' => NULL),
webmaster@1 89 'file' => 'node.admin.inc',
webmaster@1 90 ),
webmaster@1 91 'node_add_list' => array(
webmaster@1 92 'arguments' => array('content' => NULL),
webmaster@1 93 'file' => 'node.pages.inc',
webmaster@1 94 ),
webmaster@1 95 'node_form' => array(
webmaster@1 96 'arguments' => array('form' => NULL),
webmaster@1 97 'file' => 'node.pages.inc',
webmaster@1 98 ),
webmaster@1 99 'node_preview' => array(
webmaster@1 100 'arguments' => array('node' => NULL),
webmaster@1 101 'file' => 'node.pages.inc',
webmaster@1 102 ),
webmaster@1 103 'node_log_message' => array(
webmaster@1 104 'arguments' => array('log' => NULL),
webmaster@1 105 ),
webmaster@1 106 'node_submitted' => array(
webmaster@1 107 'arguments' => array('node' => NULL),
webmaster@1 108 ),
webmaster@1 109 );
webmaster@1 110 }
webmaster@1 111
webmaster@1 112 /**
webmaster@1 113 * Implementation of hook_cron().
webmaster@1 114 */
webmaster@1 115 function node_cron() {
webmaster@1 116 db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
webmaster@1 117 }
webmaster@1 118
webmaster@1 119 /**
webmaster@1 120 * Gather a listing of links to nodes.
webmaster@1 121 *
webmaster@1 122 * @param $result
webmaster@1 123 * A DB result object from a query to fetch node objects. If your query
webmaster@1 124 * joins the <code>node_comment_statistics</code> table so that the
webmaster@1 125 * <code>comment_count</code> field is available, a title attribute will
webmaster@1 126 * be added to show the number of comments.
webmaster@1 127 * @param $title
webmaster@1 128 * A heading for the resulting list.
webmaster@1 129 *
webmaster@1 130 * @return
webmaster@1 131 * An HTML list suitable as content for a block, or FALSE if no result can
webmaster@1 132 * fetch from DB result object.
webmaster@1 133 */
webmaster@1 134 function node_title_list($result, $title = NULL) {
webmaster@1 135 $items = array();
webmaster@1 136 $num_rows = FALSE;
webmaster@1 137 while ($node = db_fetch_object($result)) {
webmaster@1 138 $items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
webmaster@1 139 $num_rows = TRUE;
webmaster@1 140 }
webmaster@1 141
webmaster@1 142 return $num_rows ? theme('node_list', $items, $title) : FALSE;
webmaster@1 143 }
webmaster@1 144
webmaster@1 145 /**
webmaster@1 146 * Format a listing of links to nodes.
webmaster@1 147 *
webmaster@1 148 * @ingroup themeable
webmaster@1 149 */
webmaster@1 150 function theme_node_list($items, $title = NULL) {
webmaster@1 151 return theme('item_list', $items, $title);
webmaster@1 152 }
webmaster@1 153
webmaster@1 154 /**
webmaster@1 155 * Update the 'last viewed' timestamp of the specified node for current user.
webmaster@1 156 */
webmaster@1 157 function node_tag_new($nid) {
webmaster@1 158 global $user;
webmaster@1 159
webmaster@1 160 if ($user->uid) {
webmaster@1 161 if (node_last_viewed($nid)) {
webmaster@1 162 db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
webmaster@1 163 }
webmaster@1 164 else {
webmaster@1 165 @db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
webmaster@1 166 }
webmaster@1 167 }
webmaster@1 168 }
webmaster@1 169
webmaster@1 170 /**
webmaster@1 171 * Retrieves the timestamp at which the current user last viewed the
webmaster@1 172 * specified node.
webmaster@1 173 */
webmaster@1 174 function node_last_viewed($nid) {
webmaster@1 175 global $user;
webmaster@1 176 static $history;
webmaster@1 177
webmaster@1 178 if (!isset($history[$nid])) {
webmaster@1 179 $history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = %d AND nid = %d", $user->uid, $nid));
webmaster@1 180 }
webmaster@1 181
webmaster@1 182 return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
webmaster@1 183 }
webmaster@1 184
webmaster@1 185 /**
webmaster@1 186 * Decide on the type of marker to be displayed for a given node.
webmaster@1 187 *
webmaster@1 188 * @param $nid
webmaster@1 189 * Node ID whose history supplies the "last viewed" timestamp.
webmaster@1 190 * @param $timestamp
webmaster@1 191 * Time which is compared against node's "last viewed" timestamp.
webmaster@1 192 * @return
webmaster@1 193 * One of the MARK constants.
webmaster@1 194 */
webmaster@1 195 function node_mark($nid, $timestamp) {
webmaster@1 196 global $user;
webmaster@1 197 static $cache;
webmaster@1 198
webmaster@1 199 if (!$user->uid) {
webmaster@1 200 return MARK_READ;
webmaster@1 201 }
webmaster@1 202 if (!isset($cache[$nid])) {
webmaster@1 203 $cache[$nid] = node_last_viewed($nid);
webmaster@1 204 }
webmaster@1 205 if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
webmaster@1 206 return MARK_NEW;
webmaster@1 207 }
webmaster@1 208 elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
webmaster@1 209 return MARK_UPDATED;
webmaster@1 210 }
webmaster@1 211 return MARK_READ;
webmaster@1 212 }
webmaster@1 213
webmaster@1 214 /**
webmaster@1 215 * See if the user used JS to submit a teaser.
webmaster@1 216 */
webmaster@1 217 function node_teaser_js(&$form, &$form_state) {
webmaster@1 218 if (isset($form['#post']['teaser_js'])) {
webmaster@1 219 // Glue the teaser to the body.
webmaster@1 220 if (trim($form_state['values']['teaser_js'])) {
webmaster@1 221 // Space the teaser from the body
webmaster@1 222 $body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
webmaster@1 223 }
webmaster@1 224 else {
webmaster@1 225 // Empty teaser, no spaces.
webmaster@1 226 $body = '<!--break-->'. $form_state['values']['body'];
webmaster@1 227 }
webmaster@1 228 // Pass updated body value on to preview/submit form processing.
webmaster@1 229 form_set_value($form['body'], $body, $form_state);
webmaster@1 230 // Pass updated body value back onto form for those cases
webmaster@1 231 // in which the form is redisplayed.
webmaster@1 232 $form['body']['#value'] = $body;
webmaster@1 233 }
webmaster@1 234 return $form;
webmaster@1 235 }
webmaster@1 236
webmaster@1 237 /**
webmaster@1 238 * Ensure value of "teaser_include" checkbox is consistent with other form data.
webmaster@1 239 *
webmaster@1 240 * This handles two situations in which an unchecked checkbox is rejected:
webmaster@1 241 *
webmaster@1 242 * 1. The user defines a teaser (summary) but it is empty;
webmaster@1 243 * 2. The user does not define a teaser (summary) (in this case an
webmaster@1 244 * unchecked checkbox would cause the body to be empty, or missing
webmaster@1 245 * the auto-generated teaser).
webmaster@1 246 *
webmaster@1 247 * If JavaScript is active then it is used to force the checkbox to be
webmaster@1 248 * checked when hidden, and so the second case will not arise.
webmaster@1 249 *
webmaster@1 250 * In either case a warning message is output.
webmaster@1 251 */
webmaster@1 252 function node_teaser_include_verify(&$form, &$form_state) {
webmaster@1 253 $message = '';
webmaster@1 254
webmaster@1 255 // $form['#post'] is set only when the form is built for preview/submit.
webmaster@1 256 if (isset($form['#post']['body']) && isset($form_state['values']['teaser_include']) && !$form_state['values']['teaser_include']) {
webmaster@1 257 // "teaser_include" checkbox is present and unchecked.
webmaster@1 258 if (strpos($form_state['values']['body'], '<!--break-->') === 0) {
webmaster@1 259 // Teaser is empty string.
webmaster@1 260 $message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting is ignored when the summary is empty.');
webmaster@1 261 }
webmaster@1 262 elseif (strpos($form_state['values']['body'], '<!--break-->') === FALSE) {
webmaster@1 263 // Teaser delimiter is not present in the body.
webmaster@1 264 $message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting has been ignored since you have not defined a summary for the post. (To define a summary, insert the delimiter "&lt;!--break--&gt;" (without the quotes) in the Body of the post to indicate the end of the summary and the start of the main content.)');
webmaster@1 265 }
webmaster@1 266
webmaster@1 267 if (!empty($message)) {
webmaster@1 268 drupal_set_message($message, 'warning');
webmaster@1 269 // Pass new checkbox value on to preview/submit form processing.
webmaster@1 270 form_set_value($form['teaser_include'], 1, $form_state);
webmaster@1 271 // Pass new checkbox value back onto form for those cases
webmaster@1 272 // in which form is redisplayed.
webmaster@1 273 $form['teaser_include']['#value'] = 1;
webmaster@1 274 }
webmaster@1 275 }
webmaster@1 276
webmaster@1 277 return $form;
webmaster@1 278 }
webmaster@1 279
webmaster@1 280 /**
webmaster@1 281 * Generate a teaser for a node body.
webmaster@1 282 *
webmaster@1 283 * If the end of the teaser is not indicated using the <!--break--> delimiter
webmaster@1 284 * then we generate the teaser automatically, trying to end it at a sensible
webmaster@1 285 * place such as the end of a paragraph, a line break, or the end of a
webmaster@1 286 * sentence (in that order of preference).
webmaster@1 287 *
webmaster@1 288 * @param $body
webmaster@1 289 * The content for which a teaser will be generated.
webmaster@1 290 * @param $format
webmaster@1 291 * The format of the content. If the content contains PHP code, we do not
webmaster@1 292 * split it up to prevent parse errors. If the line break filter is present
webmaster@1 293 * then we treat newlines embedded in $body as line breaks.
webmaster@1 294 * @param $size
webmaster@1 295 * The desired character length of the teaser. If omitted, the default
webmaster@1 296 * value will be used. Ignored if the special delimiter is present
webmaster@1 297 * in $body.
webmaster@1 298 * @return
webmaster@1 299 * The generated teaser.
webmaster@1 300 */
webmaster@1 301 function node_teaser($body, $format = NULL, $size = NULL) {
webmaster@1 302
webmaster@1 303 if (!isset($size)) {
webmaster@1 304 $size = variable_get('teaser_length', 600);
webmaster@1 305 }
webmaster@1 306
webmaster@1 307 // Find where the delimiter is in the body
webmaster@1 308 $delimiter = strpos($body, '<!--break-->');
webmaster@1 309
webmaster@1 310 // If the size is zero, and there is no delimiter, the entire body is the teaser.
webmaster@1 311 if ($size == 0 && $delimiter === FALSE) {
webmaster@1 312 return $body;
webmaster@1 313 }
webmaster@1 314
webmaster@1 315 // If a valid delimiter has been specified, use it to chop off the teaser.
webmaster@1 316 if ($delimiter !== FALSE) {
webmaster@1 317 return substr($body, 0, $delimiter);
webmaster@1 318 }
webmaster@1 319
webmaster@1 320 // We check for the presence of the PHP evaluator filter in the current
webmaster@1 321 // format. If the body contains PHP code, we do not split it up to prevent
webmaster@1 322 // parse errors.
webmaster@1 323 if (isset($format)) {
webmaster@1 324 $filters = filter_list_format($format);
webmaster@1 325 if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
webmaster@1 326 return $body;
webmaster@1 327 }
webmaster@1 328 }
webmaster@1 329
webmaster@1 330 // If we have a short body, the entire body is the teaser.
webmaster@1 331 if (drupal_strlen($body) <= $size) {
webmaster@1 332 return $body;
webmaster@1 333 }
webmaster@1 334
webmaster@1 335 // If the delimiter has not been specified, try to split at paragraph or
webmaster@1 336 // sentence boundaries.
webmaster@1 337
webmaster@1 338 // The teaser may not be longer than maximum length specified. Initial slice.
webmaster@1 339 $teaser = truncate_utf8($body, $size);
webmaster@1 340
webmaster@1 341 // Store the actual length of the UTF8 string -- which might not be the same
webmaster@1 342 // as $size.
webmaster@1 343 $max_rpos = strlen($teaser);
webmaster@1 344
webmaster@1 345 // How much to cut off the end of the teaser so that it doesn't end in the
webmaster@1 346 // middle of a paragraph, sentence, or word.
webmaster@1 347 // Initialize it to maximum in order to find the minimum.
webmaster@1 348 $min_rpos = $max_rpos;
webmaster@1 349
webmaster@1 350 // Store the reverse of the teaser. We use strpos on the reversed needle and
webmaster@1 351 // haystack for speed and convenience.
webmaster@1 352 $reversed = strrev($teaser);
webmaster@1 353
webmaster@1 354 // Build an array of arrays of break points grouped by preference.
webmaster@1 355 $break_points = array();
webmaster@1 356
webmaster@1 357 // A paragraph near the end of sliced teaser is most preferable.
webmaster@1 358 $break_points[] = array('</p>' => 0);
webmaster@1 359
webmaster@1 360 // If no complete paragraph then treat line breaks as paragraphs.
webmaster@1 361 $line_breaks = array('<br />' => 6, '<br>' => 4);
webmaster@1 362 // Newline only indicates a line break if line break converter
webmaster@1 363 // filter is present.
webmaster@1 364 if (isset($filters['filter/1'])) {
webmaster@1 365 $line_breaks["\n"] = 1;
webmaster@1 366 }
webmaster@1 367 $break_points[] = $line_breaks;
webmaster@1 368
webmaster@1 369 // If the first paragraph is too long, split at the end of a sentence.
webmaster@1 370 $break_points[] = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);
webmaster@1 371
webmaster@1 372 // Iterate over the groups of break points until a break point is found.
webmaster@1 373 foreach ($break_points as $points) {
webmaster@1 374 // Look for each break point, starting at the end of the teaser.
webmaster@1 375 foreach ($points as $point => $offset) {
webmaster@1 376 // The teaser is already reversed, but the break point isn't.
webmaster@1 377 $rpos = strpos($reversed, strrev($point));
webmaster@1 378 if ($rpos !== FALSE) {
webmaster@1 379 $min_rpos = min($rpos + $offset, $min_rpos);
webmaster@1 380 }
webmaster@1 381 }
webmaster@1 382
webmaster@1 383 // If a break point was found in this group, slice and return the teaser.
webmaster@1 384 if ($min_rpos !== $max_rpos) {
webmaster@1 385 // Don't slice with length 0. Length must be <0 to slice from RHS.
webmaster@1 386 return ($min_rpos === 0) ? $teaser : substr($teaser, 0, 0 - $min_rpos);
webmaster@1 387 }
webmaster@1 388 }
webmaster@1 389
webmaster@1 390 // If a break point was not found, still return a teaser.
webmaster@1 391 return $teaser;
webmaster@1 392 }
webmaster@1 393
webmaster@1 394 /**
webmaster@1 395 * Builds a list of available node types, and returns all of part of this list
webmaster@1 396 * in the specified format.
webmaster@1 397 *
webmaster@1 398 * @param $op
webmaster@1 399 * The format in which to return the list. When this is set to 'type',
webmaster@1 400 * 'module', or 'name', only the specified node type is returned. When set to
webmaster@1 401 * 'types' or 'names', all node types are returned.
webmaster@1 402 * @param $node
webmaster@1 403 * A node object, array, or string that indicates the node type to return.
webmaster@1 404 * Leave at default value (NULL) to return a list of all node types.
webmaster@1 405 * @param $reset
webmaster@1 406 * Whether or not to reset this function's internal cache (defaults to
webmaster@1 407 * FALSE).
webmaster@1 408 *
webmaster@1 409 * @return
webmaster@1 410 * Either an array of all available node types, or a single node type, in a
webmaster@1 411 * variable format. Returns FALSE if the node type is not found.
webmaster@1 412 */
webmaster@1 413 function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
webmaster@1 414 static $_node_types, $_node_names;
webmaster@1 415
webmaster@1 416 if ($reset || !isset($_node_types)) {
webmaster@1 417 list($_node_types, $_node_names) = _node_types_build();
webmaster@1 418 }
webmaster@1 419
webmaster@1 420 if ($node) {
webmaster@1 421 if (is_array($node)) {
webmaster@1 422 $type = $node['type'];
webmaster@1 423 }
webmaster@1 424 elseif (is_object($node)) {
webmaster@1 425 $type = $node->type;
webmaster@1 426 }
webmaster@1 427 elseif (is_string($node)) {
webmaster@1 428 $type = $node;
webmaster@1 429 }
webmaster@1 430 if (!isset($_node_types[$type])) {
webmaster@1 431 return FALSE;
webmaster@1 432 }
webmaster@1 433 }
webmaster@1 434 switch ($op) {
webmaster@1 435 case 'types':
webmaster@1 436 return $_node_types;
webmaster@1 437 case 'type':
webmaster@1 438 return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
webmaster@1 439 case 'module':
webmaster@1 440 return isset($_node_types[$type]->module) ? $_node_types[$type]->module : FALSE;
webmaster@1 441 case 'names':
webmaster@1 442 return $_node_names;
webmaster@1 443 case 'name':
webmaster@1 444 return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
webmaster@1 445 }
webmaster@1 446 }
webmaster@1 447
webmaster@1 448 /**
webmaster@1 449 * Resets the database cache of node types, and saves all new or non-modified
webmaster@1 450 * module-defined node types to the database.
webmaster@1 451 */
webmaster@1 452 function node_types_rebuild() {
webmaster@1 453 _node_types_build();
webmaster@1 454
webmaster@1 455 $node_types = node_get_types('types', NULL, TRUE);
webmaster@1 456
webmaster@1 457 foreach ($node_types as $type => $info) {
webmaster@1 458 if (!empty($info->is_new)) {
webmaster@1 459 node_type_save($info);
webmaster@1 460 }
webmaster@1 461 if (!empty($info->disabled)) {
webmaster@1 462 node_type_delete($info->type);
webmaster@1 463 }
webmaster@1 464 }
webmaster@1 465
webmaster@1 466 _node_types_build();
webmaster@1 467 }
webmaster@1 468
webmaster@1 469 /**
webmaster@1 470 * Saves a node type to the database.
webmaster@1 471 *
webmaster@1 472 * @param $info
webmaster@1 473 * The node type to save, as an object.
webmaster@1 474 *
webmaster@1 475 * @return
webmaster@1 476 * Status flag indicating outcome of the operation.
webmaster@1 477 */
webmaster@1 478 function node_type_save($info) {
webmaster@1 479 $is_existing = FALSE;
webmaster@1 480 $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
webmaster@1 481 $is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
webmaster@1 482 if (!isset($info->help)) {
webmaster@1 483 $info->help = '';
webmaster@1 484 }
webmaster@1 485 if (!isset($info->min_word_count)) {
webmaster@1 486 $info->min_word_count = 0;
webmaster@1 487 }
webmaster@1 488 if (!isset($info->body_label)) {
webmaster@1 489 $info->body_label = '';
webmaster@1 490 }
webmaster@1 491
webmaster@1 492 if ($is_existing) {
webmaster@1 493 db_query("UPDATE {node_type} SET type = '%s', name = '%s', module = '%s', has_title = %d, title_label = '%s', has_body = %d, body_label = '%s', description = '%s', help = '%s', min_word_count = %d, custom = %d, modified = %d, locked = %d WHERE type = '%s'", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $existing_type);
webmaster@1 494
webmaster@1 495 module_invoke_all('node_type', 'update', $info);
webmaster@1 496 return SAVED_UPDATED;
webmaster@1 497 }
webmaster@1 498 else {
webmaster@1 499 db_query("INSERT INTO {node_type} (type, name, module, has_title, title_label, has_body, body_label, description, help, min_word_count, custom, modified, locked, orig_type) VALUES ('%s', '%s', '%s', %d, '%s', %d, '%s', '%s', '%s', %d, %d, %d, %d, '%s')", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $info->orig_type);
webmaster@1 500
webmaster@1 501 module_invoke_all('node_type', 'insert', $info);
webmaster@1 502 return SAVED_NEW;
webmaster@1 503 }
webmaster@1 504 }
webmaster@1 505
webmaster@1 506 /**
webmaster@1 507 * Deletes a node type from the database.
webmaster@1 508 *
webmaster@1 509 * @param $type
webmaster@1 510 * The machine-readable name of the node type to be deleted.
webmaster@1 511 */
webmaster@1 512 function node_type_delete($type) {
webmaster@1 513 $info = node_get_types('type', $type);
webmaster@1 514 db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
webmaster@1 515 module_invoke_all('node_type', 'delete', $info);
webmaster@1 516 }
webmaster@1 517
webmaster@1 518 /**
webmaster@1 519 * Updates all nodes of one type to be of another type.
webmaster@1 520 *
webmaster@1 521 * @param $old_type
webmaster@1 522 * The current node type of the nodes.
webmaster@1 523 * @param $type
webmaster@1 524 * The new node type of the nodes.
webmaster@1 525 *
webmaster@1 526 * @return
webmaster@1 527 * The number of nodes whose node type field was modified.
webmaster@1 528 */
webmaster@1 529 function node_type_update_nodes($old_type, $type) {
webmaster@1 530 db_query("UPDATE {node} SET type = '%s' WHERE type = '%s'", $type, $old_type);
webmaster@1 531 return db_affected_rows();
webmaster@1 532 }
webmaster@1 533
webmaster@1 534 /**
webmaster@1 535 * Builds and returns the list of available node types.
webmaster@1 536 *
webmaster@1 537 * The list of types is built by querying hook_node_info() in all modules, and
webmaster@1 538 * by comparing this information with the node types in the {node_type} table.
webmaster@1 539 *
webmaster@1 540 */
webmaster@1 541 function _node_types_build() {
webmaster@1 542 $_node_types = array();
webmaster@1 543 $_node_names = array();
webmaster@1 544
webmaster@1 545 $info_array = module_invoke_all('node_info');
webmaster@1 546 foreach ($info_array as $type => $info) {
webmaster@1 547 $info['type'] = $type;
webmaster@1 548 $_node_types[$type] = (object) _node_type_set_defaults($info);
webmaster@1 549 $_node_names[$type] = $info['name'];
webmaster@1 550 }
webmaster@1 551
webmaster@1 552 $type_result = db_query(db_rewrite_sql('SELECT nt.type, nt.* FROM {node_type} nt ORDER BY nt.type ASC', 'nt', 'type'));
webmaster@1 553 while ($type_object = db_fetch_object($type_result)) {
webmaster@1 554 // Check for node types from disabled modules and mark their types for removal.
webmaster@1 555 // Types defined by the node module in the database (rather than by a separate
webmaster@1 556 // module using hook_node_info) have a module value of 'node'.
webmaster@1 557 if ($type_object->module != 'node' && empty($info_array[$type_object->type])) {
webmaster@1 558 $type_object->disabled = TRUE;
webmaster@1 559 }
webmaster@1 560 if (!isset($_node_types[$type_object->type]) || $type_object->modified) {
webmaster@1 561 $_node_types[$type_object->type] = $type_object;
webmaster@1 562 $_node_names[$type_object->type] = $type_object->name;
webmaster@1 563
webmaster@1 564 if ($type_object->type != $type_object->orig_type) {
webmaster@1 565 unset($_node_types[$type_object->orig_type]);
webmaster@1 566 unset($_node_names[$type_object->orig_type]);
webmaster@1 567 }
webmaster@1 568 }
webmaster@1 569 }
webmaster@1 570
webmaster@1 571 asort($_node_names);
webmaster@1 572
webmaster@1 573 return array($_node_types, $_node_names);
webmaster@1 574 }
webmaster@1 575
webmaster@1 576 /**
webmaster@1 577 * Set default values for a node type defined through hook_node_info().
webmaster@1 578 */
webmaster@1 579 function _node_type_set_defaults($info) {
webmaster@1 580 if (!isset($info['has_title'])) {
webmaster@1 581 $info['has_title'] = TRUE;
webmaster@1 582 }
webmaster@1 583 if ($info['has_title'] && !isset($info['title_label'])) {
webmaster@1 584 $info['title_label'] = t('Title');
webmaster@1 585 }
webmaster@1 586
webmaster@1 587 if (!isset($info['has_body'])) {
webmaster@1 588 $info['has_body'] = TRUE;
webmaster@1 589 }
webmaster@1 590 if ($info['has_body'] && !isset($info['body_label'])) {
webmaster@1 591 $info['body_label'] = t('Body');
webmaster@1 592 }
webmaster@1 593
webmaster@1 594 if (!isset($info['help'])) {
webmaster@1 595 $info['help'] = '';
webmaster@1 596 }
webmaster@1 597 if (!isset($info['min_word_count'])) {
webmaster@1 598 $info['min_word_count'] = 0;
webmaster@1 599 }
webmaster@1 600 if (!isset($info['custom'])) {
webmaster@1 601 $info['custom'] = FALSE;
webmaster@1 602 }
webmaster@1 603 if (!isset($info['modified'])) {
webmaster@1 604 $info['modified'] = FALSE;
webmaster@1 605 }
webmaster@1 606 if (!isset($info['locked'])) {
webmaster@1 607 $info['locked'] = TRUE;
webmaster@1 608 }
webmaster@1 609
webmaster@1 610 $info['orig_type'] = $info['type'];
webmaster@1 611 $info['is_new'] = TRUE;
webmaster@1 612
webmaster@1 613 return $info;
webmaster@1 614 }
webmaster@1 615
webmaster@1 616 /**
webmaster@1 617 * Determine whether a node hook exists.
webmaster@1 618 *
webmaster@1 619 * @param &$node
webmaster@1 620 * Either a node object, node array, or a string containing the node type.
webmaster@1 621 * @param $hook
webmaster@1 622 * A string containing the name of the hook.
webmaster@1 623 * @return
webmaster@1 624 * TRUE iff the $hook exists in the node type of $node.
webmaster@1 625 */
webmaster@1 626 function node_hook(&$node, $hook) {
webmaster@1 627 $module = node_get_types('module', $node);
webmaster@1 628 if ($module == 'node') {
webmaster@1 629 $module = 'node_content'; // Avoid function name collisions.
webmaster@1 630 }
webmaster@1 631 return module_hook($module, $hook);
webmaster@1 632 }
webmaster@1 633
webmaster@1 634 /**
webmaster@1 635 * Invoke a node hook.
webmaster@1 636 *
webmaster@1 637 * @param &$node
webmaster@1 638 * Either a node object, node array, or a string containing the node type.
webmaster@1 639 * @param $hook
webmaster@1 640 * A string containing the name of the hook.
webmaster@1 641 * @param $a2, $a3, $a4
webmaster@1 642 * Arguments to pass on to the hook, after the $node argument.
webmaster@1 643 * @return
webmaster@1 644 * The returned value of the invoked hook.
webmaster@1 645 */
webmaster@1 646 function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
webmaster@1 647 if (node_hook($node, $hook)) {
webmaster@1 648 $module = node_get_types('module', $node);
webmaster@1 649 if ($module == 'node') {
webmaster@1 650 $module = 'node_content'; // Avoid function name collisions.
webmaster@1 651 }
webmaster@1 652 $function = $module .'_'. $hook;
webmaster@1 653 return ($function($node, $a2, $a3, $a4));
webmaster@1 654 }
webmaster@1 655 }
webmaster@1 656
webmaster@1 657 /**
webmaster@1 658 * Invoke a hook_nodeapi() operation in all modules.
webmaster@1 659 *
webmaster@1 660 * @param &$node
webmaster@1 661 * A node object.
webmaster@1 662 * @param $op
webmaster@1 663 * A string containing the name of the nodeapi operation.
webmaster@1 664 * @param $a3, $a4
webmaster@1 665 * Arguments to pass on to the hook, after the $node and $op arguments.
webmaster@1 666 * @return
webmaster@1 667 * The returned value of the invoked hooks.
webmaster@1 668 */
webmaster@1 669 function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
webmaster@1 670 $return = array();
webmaster@1 671 foreach (module_implements('nodeapi') as $name) {
webmaster@1 672 $function = $name .'_nodeapi';
webmaster@1 673 $result = $function($node, $op, $a3, $a4);
webmaster@1 674 if (isset($result) && is_array($result)) {
webmaster@1 675 $return = array_merge($return, $result);
webmaster@1 676 }
webmaster@1 677 else if (isset($result)) {
webmaster@1 678 $return[] = $result;
webmaster@1 679 }
webmaster@1 680 }
webmaster@1 681 return $return;
webmaster@1 682 }
webmaster@1 683
webmaster@1 684 /**
webmaster@1 685 * Load a node object from the database.
webmaster@1 686 *
webmaster@1 687 * @param $param
webmaster@1 688 * Either the nid of the node or an array of conditions to match against in the database query
webmaster@1 689 * @param $revision
webmaster@1 690 * Which numbered revision to load. Defaults to the current version.
webmaster@1 691 * @param $reset
webmaster@1 692 * Whether to reset the internal node_load cache.
webmaster@1 693 *
webmaster@1 694 * @return
webmaster@1 695 * A fully-populated node object.
webmaster@1 696 */
webmaster@1 697 function node_load($param = array(), $revision = NULL, $reset = NULL) {
webmaster@1 698 static $nodes = array();
webmaster@1 699
webmaster@1 700 if ($reset) {
webmaster@1 701 $nodes = array();
webmaster@1 702 }
webmaster@1 703
webmaster@1 704 $cachable = ($revision == NULL);
webmaster@1 705 $arguments = array();
webmaster@1 706 if (is_numeric($param)) {
webmaster@1 707 if ($cachable) {
webmaster@1 708 // Is the node statically cached?
webmaster@1 709 if (isset($nodes[$param])) {
webmaster@1 710 return is_object($nodes[$param]) ? drupal_clone($nodes[$param]) : $nodes[$param];
webmaster@1 711 }
webmaster@1 712 }
webmaster@1 713 $cond = 'n.nid = %d';
webmaster@1 714 $arguments[] = $param;
webmaster@1 715 }
webmaster@1 716 elseif (is_array($param)) {
webmaster@1 717 // Turn the conditions into a query.
webmaster@1 718 foreach ($param as $key => $value) {
webmaster@3 719 $cond[] = 'n.'. db_escape_table($key) ." = '%s'";
webmaster@1 720 $arguments[] = $value;
webmaster@1 721 }
webmaster@1 722 $cond = implode(' AND ', $cond);
webmaster@1 723 }
webmaster@1 724 else {
webmaster@1 725 return FALSE;
webmaster@1 726 }
webmaster@1 727
webmaster@1 728 // Retrieve a field list based on the site's schema.
webmaster@1 729 $fields = drupal_schema_fields_sql('node', 'n');
webmaster@1 730 $fields = array_merge($fields, drupal_schema_fields_sql('node_revisions', 'r'));
webmaster@1 731 $fields = array_merge($fields, array('u.name', 'u.picture', 'u.data'));
webmaster@1 732 // Remove fields not needed in the query: n.vid and r.nid are redundant,
webmaster@1 733 // n.title is unnecessary because the node title comes from the
webmaster@1 734 // node_revisions table. We'll keep r.vid, r.title, and n.nid.
webmaster@1 735 $fields = array_diff($fields, array('n.vid', 'n.title', 'r.nid'));
webmaster@1 736 $fields = implode(', ', $fields);
webmaster@1 737 // Rename timestamp field for clarity.
webmaster@1 738 $fields = str_replace('r.timestamp', 'r.timestamp AS revision_timestamp', $fields);
webmaster@1 739 // Change name of revision uid so it doesn't conflict with n.uid.
webmaster@1 740 $fields = str_replace('r.uid', 'r.uid AS revision_uid', $fields);
webmaster@1 741
webmaster@1 742 // Retrieve the node.
webmaster@1 743 // No db_rewrite_sql is applied so as to get complete indexing for search.
webmaster@1 744 if ($revision) {
webmaster@1 745 array_unshift($arguments, $revision);
webmaster@1 746 $node = db_fetch_object(db_query('SELECT '. $fields .' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.nid = n.nid AND r.vid = %d WHERE '. $cond, $arguments));
webmaster@1 747 }
webmaster@1 748 else {
webmaster@1 749 $node = db_fetch_object(db_query('SELECT '. $fields .' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.vid = n.vid WHERE '. $cond, $arguments));
webmaster@1 750 }
webmaster@1 751
webmaster@1 752 if ($node && $node->nid) {
webmaster@1 753 // Call the node specific callback (if any) and piggy-back the
webmaster@1 754 // results to the node or overwrite some values.
webmaster@1 755 if ($extra = node_invoke($node, 'load')) {
webmaster@1 756 foreach ($extra as $key => $value) {
webmaster@1 757 $node->$key = $value;
webmaster@1 758 }
webmaster@1 759 }
webmaster@1 760
webmaster@1 761 if ($extra = node_invoke_nodeapi($node, 'load')) {
webmaster@1 762 foreach ($extra as $key => $value) {
webmaster@1 763 $node->$key = $value;
webmaster@1 764 }
webmaster@1 765 }
webmaster@1 766 if ($cachable) {
webmaster@1 767 $nodes[$node->nid] = is_object($node) ? drupal_clone($node) : $node;
webmaster@1 768 }
webmaster@1 769 }
webmaster@1 770
webmaster@1 771 return $node;
webmaster@1 772 }
webmaster@1 773
webmaster@1 774 /**
webmaster@1 775 * Perform validation checks on the given node.
webmaster@1 776 */
webmaster@1 777 function node_validate($node, $form = array()) {
webmaster@1 778 // Convert the node to an object, if necessary.
webmaster@1 779 $node = (object)$node;
webmaster@1 780 $type = node_get_types('type', $node);
webmaster@1 781
webmaster@1 782 // Make sure the body has the minimum number of words.
webmaster@1 783 // TODO : use a better word counting algorithm that will work in other languages
webmaster@1 784 if (!empty($type->min_word_count) && isset($node->body) && count(explode(' ', $node->body)) < $type->min_word_count) {
webmaster@1 785 form_set_error('body', t('The body of your @type is too short. You need at least %words words.', array('%words' => $type->min_word_count, '@type' => $type->name)));
webmaster@1 786 }
webmaster@1 787
webmaster@1 788 if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
webmaster@1 789 form_set_error('changed', t('This content has been modified by another user, changes cannot be saved.'));
webmaster@1 790 }
webmaster@1 791
webmaster@1 792 if (user_access('administer nodes')) {
webmaster@1 793 // Validate the "authored by" field.
webmaster@1 794 if (!empty($node->name) && !($account = user_load(array('name' => $node->name)))) {
webmaster@1 795 // The use of empty() is mandatory in the context of usernames
webmaster@1 796 // as the empty string denotes the anonymous user. In case we
webmaster@1 797 // are dealing with an anonymous user we set the user ID to 0.
webmaster@1 798 form_set_error('name', t('The username %name does not exist.', array('%name' => $node->name)));
webmaster@1 799 }
webmaster@1 800
webmaster@1 801 // Validate the "authored on" field. As of PHP 5.1.0, strtotime returns FALSE instead of -1 upon failure.
webmaster@1 802 if (!empty($node->date) && strtotime($node->date) <= 0) {
webmaster@1 803 form_set_error('date', t('You have to specify a valid date.'));
webmaster@1 804 }
webmaster@1 805 }
webmaster@1 806
webmaster@1 807 // Do node-type-specific validation checks.
webmaster@1 808 node_invoke($node, 'validate', $form);
webmaster@1 809 node_invoke_nodeapi($node, 'validate', $form);
webmaster@1 810 }
webmaster@1 811
webmaster@1 812 /**
webmaster@1 813 * Prepare node for save and allow modules to make changes.
webmaster@1 814 */
webmaster@1 815 function node_submit($node) {
webmaster@1 816 global $user;
webmaster@1 817
webmaster@1 818 // Convert the node to an object, if necessary.
webmaster@1 819 $node = (object)$node;
webmaster@1 820
webmaster@1 821 // Generate the teaser, but only if it hasn't been set (e.g. by a
webmaster@1 822 // module-provided 'teaser' form item).
webmaster@1 823 if (!isset($node->teaser)) {
webmaster@1 824 if (isset($node->body)) {
webmaster@1 825 $node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
webmaster@1 826 // Chop off the teaser from the body if needed. The teaser_include
webmaster@1 827 // property might not be set (eg. in Blog API postings), so only act on
webmaster@1 828 // it, if it was set with a given value.
webmaster@1 829 if (isset($node->teaser_include) && !$node->teaser_include && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
webmaster@1 830 $node->body = substr($node->body, strlen($node->teaser));
webmaster@1 831 }
webmaster@1 832 }
webmaster@1 833 else {
webmaster@1 834 $node->teaser = '';
webmaster@1 835 }
webmaster@1 836 }
webmaster@1 837
webmaster@1 838 if (user_access('administer nodes')) {
webmaster@1 839 // Populate the "authored by" field.
webmaster@1 840 if ($account = user_load(array('name' => $node->name))) {
webmaster@1 841 $node->uid = $account->uid;
webmaster@1 842 }
webmaster@1 843 else {
webmaster@1 844 $node->uid = 0;
webmaster@1 845 }
webmaster@1 846 }
webmaster@1 847 $node->created = !empty($node->date) ? strtotime($node->date) : time();
webmaster@1 848 $node->validated = TRUE;
webmaster@1 849
webmaster@1 850 return $node;
webmaster@1 851 }
webmaster@1 852
webmaster@1 853 /**
webmaster@1 854 * Save a node object into the database.
webmaster@1 855 */
webmaster@1 856 function node_save(&$node) {
webmaster@1 857 // Let modules modify the node before it is saved to the database.
webmaster@1 858 node_invoke_nodeapi($node, 'presave');
webmaster@1 859 global $user;
webmaster@1 860
webmaster@1 861 $node->is_new = FALSE;
webmaster@1 862
webmaster@1 863 // Apply filters to some default node fields:
webmaster@1 864 if (empty($node->nid)) {
webmaster@1 865 // Insert a new node.
webmaster@1 866 $node->is_new = TRUE;
webmaster@1 867
webmaster@1 868 // When inserting a node, $node->log must be set because
webmaster@1 869 // {node_revisions}.log does not (and cannot) have a default
webmaster@1 870 // value. If the user does not have permission to create
webmaster@1 871 // revisions, however, the form will not contain an element for
webmaster@1 872 // log so $node->log will be unset at this point.
webmaster@1 873 if (!isset($node->log)) {
webmaster@1 874 $node->log = '';
webmaster@1 875 }
webmaster@1 876
webmaster@1 877 // For the same reasons, make sure we have $node->teaser and
webmaster@1 878 // $node->body. We should consider making these fields nullable
webmaster@1 879 // in a future version since node types are not required to use them.
webmaster@1 880 if (!isset($node->teaser)) {
webmaster@1 881 $node->teaser = '';
webmaster@1 882 }
webmaster@1 883 if (!isset($node->body)) {
webmaster@1 884 $node->body = '';
webmaster@1 885 }
webmaster@1 886 }
webmaster@1 887 elseif (!empty($node->revision)) {
webmaster@1 888 $node->old_vid = $node->vid;
webmaster@1 889 }
webmaster@1 890 else {
webmaster@1 891 // When updating a node, avoid clobberring an existing log entry with an empty one.
webmaster@1 892 if (empty($node->log)) {
webmaster@1 893 unset($node->log);
webmaster@1 894 }
webmaster@1 895 }
webmaster@1 896
webmaster@1 897 // Set some required fields:
webmaster@1 898 if (empty($node->created)) {
webmaster@1 899 $node->created = time();
webmaster@1 900 }
webmaster@1 901 // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
webmaster@1 902 $node->changed = time();
webmaster@1 903
webmaster@1 904 $node->timestamp = time();
webmaster@1 905 $node->format = isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT;
webmaster@1 906 $update_node = TRUE;
webmaster@1 907
webmaster@1 908 // Generate the node table query and the node_revisions table query.
webmaster@1 909 if ($node->is_new) {
webmaster@1 910 drupal_write_record('node', $node);
webmaster@1 911 _node_save_revision($node, $user->uid);
webmaster@1 912 $op = 'insert';
webmaster@1 913 }
webmaster@1 914 else {
webmaster@1 915 drupal_write_record('node', $node, 'nid');
webmaster@1 916 if (!empty($node->revision)) {
webmaster@1 917 _node_save_revision($node, $user->uid);
webmaster@1 918 }
webmaster@1 919 else {
webmaster@1 920 _node_save_revision($node, $user->uid, 'vid');
webmaster@1 921 $update_node = FALSE;
webmaster@1 922 }
webmaster@1 923 $op = 'update';
webmaster@1 924 }
webmaster@1 925 if ($update_node) {
webmaster@1 926 db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
webmaster@1 927 }
webmaster@1 928
webmaster@1 929 // Call the node specific callback (if any).
webmaster@1 930 node_invoke($node, $op);
webmaster@1 931 node_invoke_nodeapi($node, $op);
webmaster@1 932
webmaster@1 933 // Update the node access table for this node.
webmaster@1 934 node_access_acquire_grants($node);
webmaster@1 935
webmaster@1 936 // Clear the page and block caches.
webmaster@1 937 cache_clear_all();
webmaster@1 938 }
webmaster@1 939
webmaster@1 940 /**
webmaster@1 941 * Helper function to save a revision with the uid of the current user.
webmaster@1 942 *
webmaster@1 943 * Node is taken by reference, becuse drupal_write_record() updates the
webmaster@1 944 * $node with the revision id, and we need to pass that back to the caller.
webmaster@1 945 */
webmaster@1 946 function _node_save_revision(&$node, $uid, $update = NULL) {
webmaster@1 947 $temp_uid = $node->uid;
webmaster@1 948 $node->uid = $uid;
webmaster@1 949 if (isset($update)) {
webmaster@1 950 drupal_write_record('node_revisions', $node, $update);
webmaster@1 951 }
webmaster@1 952 else {
webmaster@1 953 drupal_write_record('node_revisions', $node);
webmaster@1 954 }
webmaster@1 955 $node->uid = $temp_uid;
webmaster@1 956 }
webmaster@1 957
webmaster@1 958 /**
webmaster@1 959 * Delete a node.
webmaster@1 960 */
webmaster@1 961 function node_delete($nid) {
webmaster@1 962
webmaster@1 963 $node = node_load($nid);
webmaster@1 964
webmaster@1 965 if (node_access('delete', $node)) {
webmaster@1 966 db_query('DELETE FROM {node} WHERE nid = %d', $node->nid);
webmaster@1 967 db_query('DELETE FROM {node_revisions} WHERE nid = %d', $node->nid);
webmaster@1 968
webmaster@1 969 // Call the node-specific callback (if any):
webmaster@1 970 node_invoke($node, 'delete');
webmaster@1 971 node_invoke_nodeapi($node, 'delete');
webmaster@1 972
webmaster@1 973 // Clear the page and block caches.
webmaster@1 974 cache_clear_all();
webmaster@1 975
webmaster@1 976 // Remove this node from the search index if needed.
webmaster@1 977 if (function_exists('search_wipe')) {
webmaster@1 978 search_wipe($node->nid, 'node');
webmaster@1 979 }
webmaster@1 980 watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
webmaster@1 981 drupal_set_message(t('@type %title has been deleted.', array('@type' => node_get_types('name', $node), '%title' => $node->title)));
webmaster@1 982 }
webmaster@1 983 }
webmaster@1 984
webmaster@1 985 /**
webmaster@1 986 * Generate a display of the given node.
webmaster@1 987 *
webmaster@1 988 * @param $node
webmaster@1 989 * A node array or node object.
webmaster@1 990 * @param $teaser
webmaster@1 991 * Whether to display the teaser only or the full form.
webmaster@1 992 * @param $page
webmaster@1 993 * Whether the node is being displayed by itself as a page.
webmaster@1 994 * @param $links
webmaster@1 995 * Whether or not to display node links. Links are omitted for node previews.
webmaster@1 996 *
webmaster@1 997 * @return
webmaster@1 998 * An HTML representation of the themed node.
webmaster@1 999 */
webmaster@1 1000 function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {
webmaster@1 1001 $node = (object)$node;
webmaster@1 1002
webmaster@1 1003 $node = node_build_content($node, $teaser, $page);
webmaster@1 1004
webmaster@1 1005 if ($links) {
webmaster@1 1006 $node->links = module_invoke_all('link', 'node', $node, $teaser);
webmaster@1 1007 drupal_alter('link', $node->links, $node);
webmaster@1 1008 }
webmaster@1 1009
webmaster@1 1010 // Set the proper node part, then unset unused $node part so that a bad
webmaster@1 1011 // theme can not open a security hole.
webmaster@1 1012 $content = drupal_render($node->content);
webmaster@1 1013 if ($teaser) {
webmaster@1 1014 $node->teaser = $content;
webmaster@1 1015 unset($node->body);
webmaster@1 1016 }
webmaster@1 1017 else {
webmaster@1 1018 $node->body = $content;
webmaster@1 1019 unset($node->teaser);
webmaster@1 1020 }
webmaster@1 1021
webmaster@1 1022 // Allow modules to modify the fully-built node.
webmaster@1 1023 node_invoke_nodeapi($node, 'alter', $teaser, $page);
webmaster@1 1024
webmaster@1 1025 return theme('node', $node, $teaser, $page);
webmaster@1 1026 }
webmaster@1 1027
webmaster@1 1028 /**
webmaster@1 1029 * Apply filters and build the node's standard elements.
webmaster@1 1030 */
webmaster@1 1031 function node_prepare($node, $teaser = FALSE) {
webmaster@1 1032 // First we'll overwrite the existing node teaser and body with
webmaster@1 1033 // the filtered copies! Then, we'll stick those into the content
webmaster@1 1034 // array and set the read more flag if appropriate.
webmaster@1 1035 $node->readmore = $node->teaser != $node->body;
webmaster@1 1036
webmaster@1 1037 if ($teaser == FALSE) {
webmaster@1 1038 $node->body = check_markup($node->body, $node->format, FALSE);
webmaster@1 1039 }
webmaster@1 1040 else {
webmaster@1 1041 $node->teaser = check_markup($node->teaser, $node->format, FALSE);
webmaster@1 1042 }
webmaster@1 1043
webmaster@1 1044 $node->content['body'] = array(
webmaster@1 1045 '#value' => $teaser ? $node->teaser : $node->body,
webmaster@1 1046 '#weight' => 0,
webmaster@1 1047 );
webmaster@1 1048
webmaster@1 1049 return $node;
webmaster@1 1050 }
webmaster@1 1051
webmaster@1 1052 /**
webmaster@1 1053 * Builds a structured array representing the node's content.
webmaster@1 1054 *
webmaster@1 1055 * @param $node
webmaster@1 1056 * A node object.
webmaster@1 1057 * @param $teaser
webmaster@1 1058 * Whether to display the teaser only, as on the main page.
webmaster@1 1059 * @param $page
webmaster@1 1060 * Whether the node is being displayed by itself as a page.
webmaster@1 1061 *
webmaster@1 1062 * @return
webmaster@1 1063 * An structured array containing the individual elements
webmaster@1 1064 * of the node's body.
webmaster@1 1065 */
webmaster@1 1066 function node_build_content($node, $teaser = FALSE, $page = FALSE) {
webmaster@1 1067
webmaster@1 1068 // The build mode identifies the target for which the node is built.
webmaster@1 1069 if (!isset($node->build_mode)) {
webmaster@1 1070 $node->build_mode = NODE_BUILD_NORMAL;
webmaster@1 1071 }
webmaster@1 1072
webmaster@1 1073 // Remove the delimiter (if any) that separates the teaser from the body.
webmaster@1 1074 $node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
webmaster@1 1075
webmaster@1 1076 // The 'view' hook can be implemented to overwrite the default function
webmaster@1 1077 // to display nodes.
webmaster@1 1078 if (node_hook($node, 'view')) {
webmaster@1 1079 $node = node_invoke($node, 'view', $teaser, $page);
webmaster@1 1080 }
webmaster@1 1081 else {
webmaster@1 1082 $node = node_prepare($node, $teaser);
webmaster@1 1083 }
webmaster@1 1084
webmaster@1 1085 // Allow modules to make their own additions to the node.
webmaster@1 1086 node_invoke_nodeapi($node, 'view', $teaser, $page);
webmaster@1 1087
webmaster@1 1088 return $node;
webmaster@1 1089 }
webmaster@1 1090
webmaster@1 1091 /**
webmaster@1 1092 * Generate a page displaying a single node, along with its comments.
webmaster@1 1093 */
webmaster@1 1094 function node_show($node, $cid, $message = FALSE) {
webmaster@1 1095 if ($message) {
webmaster@1 1096 drupal_set_title(t('Revision of %title from %date', array('%title' => $node->title, '%date' => format_date($node->revision_timestamp))));
webmaster@1 1097 }
webmaster@1 1098 $output = node_view($node, FALSE, TRUE);
webmaster@1 1099
webmaster@1 1100 if (function_exists('comment_render') && $node->comment) {
webmaster@1 1101 $output .= comment_render($node, $cid);
webmaster@1 1102 }
webmaster@1 1103
webmaster@1 1104 // Update the history table, stating that this user viewed this node.
webmaster@1 1105 node_tag_new($node->nid);
webmaster@1 1106
webmaster@1 1107 return $output;
webmaster@1 1108 }
webmaster@1 1109
webmaster@1 1110 /**
webmaster@1 1111 * Theme a log message.
webmaster@1 1112 *
webmaster@1 1113 * @ingroup themeable
webmaster@1 1114 */
webmaster@1 1115 function theme_node_log_message($log) {
webmaster@1 1116 return '<div class="log"><div class="title">'. t('Log') .':</div>'. $log .'</div>';
webmaster@1 1117 }
webmaster@1 1118
webmaster@1 1119 /**
webmaster@1 1120 * Implementation of hook_perm().
webmaster@1 1121 */
webmaster@1 1122 function node_perm() {
webmaster@1 1123 $perms = array('administer content types', 'administer nodes', 'access content', 'view revisions', 'revert revisions', 'delete revisions');
webmaster@1 1124
webmaster@1 1125 foreach (node_get_types() as $type) {
webmaster@1 1126 if ($type->module == 'node') {
webmaster@1 1127 $name = check_plain($type->type);
webmaster@1 1128 $perms[] = 'create '. $name .' content';
webmaster@1 1129 $perms[] = 'delete own '. $name .' content';
webmaster@1 1130 $perms[] = 'delete any '. $name .' content';
webmaster@1 1131 $perms[] = 'edit own '. $name .' content';
webmaster@1 1132 $perms[] = 'edit any '. $name .' content';
webmaster@1 1133 }
webmaster@1 1134 }
webmaster@1 1135
webmaster@1 1136 return $perms;
webmaster@1 1137 }
webmaster@1 1138
webmaster@1 1139 /**
webmaster@1 1140 * Implementation of hook_search().
webmaster@1 1141 */
webmaster@1 1142 function node_search($op = 'search', $keys = NULL) {
webmaster@1 1143 switch ($op) {
webmaster@1 1144 case 'name':
webmaster@1 1145 return t('Content');
webmaster@1 1146
webmaster@1 1147 case 'reset':
webmaster@1 1148 db_query("UPDATE {search_dataset} SET reindex = %d WHERE type = 'node'", time());
webmaster@1 1149 return;
webmaster@1 1150
webmaster@1 1151 case 'status':
webmaster@1 1152 $total = db_result(db_query('SELECT COUNT(*) FROM {node} WHERE status = 1'));
webmaster@1 1153 $remaining = db_result(db_query("SELECT COUNT(*) FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE d.sid IS NULL OR d.reindex <> 0"));
webmaster@1 1154 return array('remaining' => $remaining, 'total' => $total);
webmaster@1 1155
webmaster@1 1156 case 'admin':
webmaster@1 1157 $form = array();
webmaster@1 1158 // Output form for defining rank factor weights.
webmaster@1 1159 $form['content_ranking'] = array(
webmaster@1 1160 '#type' => 'fieldset',
webmaster@1 1161 '#title' => t('Content ranking'),
webmaster@1 1162 );
webmaster@1 1163 $form['content_ranking']['#theme'] = 'node_search_admin';
webmaster@1 1164 $form['content_ranking']['info'] = array(
webmaster@1 1165 '#value' => '<em>'. t('The following numbers control which properties the content search should favor when ordering the results. Higher numbers mean more influence, zero means the property is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') .'</em>'
webmaster@1 1166 );
webmaster@1 1167
webmaster@1 1168 $ranking = array('node_rank_relevance' => t('Keyword relevance'),
webmaster@1 1169 'node_rank_recent' => t('Recently posted'));
webmaster@1 1170 if (module_exists('comment')) {
webmaster@1 1171 $ranking['node_rank_comments'] = t('Number of comments');
webmaster@1 1172 }
webmaster@1 1173 if (module_exists('statistics') && variable_get('statistics_count_content_views', 0)) {
webmaster@1 1174 $ranking['node_rank_views'] = t('Number of views');
webmaster@1 1175 }
webmaster@1 1176
webmaster@1 1177 // Note: reversed to reflect that higher number = higher ranking.
webmaster@1 1178 $options = drupal_map_assoc(range(0, 10));
webmaster@1 1179 foreach ($ranking as $var => $title) {
webmaster@1 1180 $form['content_ranking']['factors'][$var] = array(
webmaster@1 1181 '#title' => $title,
webmaster@1 1182 '#type' => 'select',
webmaster@1 1183 '#options' => $options,
webmaster@1 1184 '#default_value' => variable_get($var, 5),
webmaster@1 1185 );
webmaster@1 1186 }
webmaster@1 1187 return $form;
webmaster@1 1188
webmaster@1 1189 case 'search':
webmaster@1 1190 // Build matching conditions
webmaster@1 1191 list($join1, $where1) = _db_rewrite_sql();
webmaster@1 1192 $arguments1 = array();
webmaster@1 1193 $conditions1 = 'n.status = 1';
webmaster@1 1194
webmaster@1 1195 if ($type = search_query_extract($keys, 'type')) {
webmaster@1 1196 $types = array();
webmaster@1 1197 foreach (explode(',', $type) as $t) {
webmaster@1 1198 $types[] = "n.type = '%s'";
webmaster@1 1199 $arguments1[] = $t;
webmaster@1 1200 }
webmaster@1 1201 $conditions1 .= ' AND ('. implode(' OR ', $types) .')';
webmaster@1 1202 $keys = search_query_insert($keys, 'type');
webmaster@1 1203 }
webmaster@1 1204
webmaster@1 1205 if ($category = search_query_extract($keys, 'category')) {
webmaster@1 1206 $categories = array();
webmaster@1 1207 foreach (explode(',', $category) as $c) {
webmaster@1 1208 $categories[] = "tn.tid = %d";
webmaster@1 1209 $arguments1[] = $c;
webmaster@1 1210 }
webmaster@1 1211 $conditions1 .= ' AND ('. implode(' OR ', $categories) .')';
webmaster@1 1212 $join1 .= ' INNER JOIN {term_node} tn ON n.vid = tn.vid';
webmaster@1 1213 $keys = search_query_insert($keys, 'category');
webmaster@1 1214 }
webmaster@1 1215
webmaster@1 1216 // Build ranking expression (we try to map each parameter to a
webmaster@1 1217 // uniform distribution in the range 0..1).
webmaster@1 1218 $ranking = array();
webmaster@1 1219 $arguments2 = array();
webmaster@1 1220 $join2 = '';
webmaster@1 1221 // Used to avoid joining on node_comment_statistics twice
webmaster@1 1222 $stats_join = FALSE;
webmaster@1 1223 $total = 0;
webmaster@1 1224 if ($weight = (int)variable_get('node_rank_relevance', 5)) {
webmaster@1 1225 // Average relevance values hover around 0.15
webmaster@1 1226 $ranking[] = '%d * i.relevance';
webmaster@1 1227 $arguments2[] = $weight;
webmaster@1 1228 $total += $weight;
webmaster@1 1229 }
webmaster@1 1230 if ($weight = (int)variable_get('node_rank_recent', 5)) {
webmaster@1 1231 // Exponential decay with half-life of 6 months, starting at last indexed node
webmaster@1 1232 $ranking[] = '%d * POW(2, (GREATEST(MAX(n.created), MAX(n.changed), MAX(c.last_comment_timestamp)) - %d) * 6.43e-8)';
webmaster@1 1233 $arguments2[] = $weight;
webmaster@1 1234 $arguments2[] = (int)variable_get('node_cron_last', 0);
webmaster@1 1235 $join2 .= ' LEFT JOIN {node_comment_statistics} c ON c.nid = i.sid';
webmaster@1 1236 $stats_join = TRUE;
webmaster@1 1237 $total += $weight;
webmaster@1 1238 }
webmaster@1 1239 if (module_exists('comment') && $weight = (int)variable_get('node_rank_comments', 5)) {
webmaster@1 1240 // Inverse law that maps the highest reply count on the site to 1 and 0 to 0.
webmaster@1 1241 $scale = variable_get('node_cron_comments_scale', 0.0);
webmaster@1 1242 $ranking[] = '%d * (2.0 - 2.0 / (1.0 + MAX(c.comment_count) * %f))';
webmaster@1 1243 $arguments2[] = $weight;
webmaster@1 1244 $arguments2[] = $scale;
webmaster@1 1245 if (!$stats_join) {
webmaster@1 1246 $join2 .= ' LEFT JOIN {node_comment_statistics} c ON c.nid = i.sid';
webmaster@1 1247 }
webmaster@1 1248 $total += $weight;
webmaster@1 1249 }
webmaster@1 1250 if (module_exists('statistics') && variable_get('statistics_count_content_views', 0) &&
webmaster@1 1251 $weight = (int)variable_get('node_rank_views', 5)) {
webmaster@1 1252 // Inverse law that maps the highest view count on the site to 1 and 0 to 0.
webmaster@1 1253 $scale = variable_get('node_cron_views_scale', 0.0);
webmaster@1 1254 $ranking[] = '%d * (2.0 - 2.0 / (1.0 + MAX(nc.totalcount) * %f))';
webmaster@1 1255 $arguments2[] = $weight;
webmaster@1 1256 $arguments2[] = $scale;
webmaster@1 1257 $join2 .= ' LEFT JOIN {node_counter} nc ON nc.nid = i.sid';
webmaster@1 1258 $total += $weight;
webmaster@1 1259 }
webmaster@1 1260 $select2 = (count($ranking) ? implode(' + ', $ranking) : 'i.relevance') .' AS score';
webmaster@1 1261
webmaster@1 1262 // Do search
webmaster@1 1263 $find = do_search($keys, 'node', 'INNER JOIN {node} n ON n.nid = i.sid '. $join1 .' INNER JOIN {users} u ON n.uid = u.uid', $conditions1 . (empty($where1) ? '' : ' AND '. $where1), $arguments1, $select2, $join2, $arguments2);
webmaster@1 1264
webmaster@1 1265 // Load results
webmaster@1 1266 $results = array();
webmaster@1 1267 foreach ($find as $item) {
webmaster@1 1268 // Build the node body.
webmaster@1 1269 $node = node_load($item->sid);
webmaster@1 1270 $node->build_mode = NODE_BUILD_SEARCH_RESULT;
webmaster@1 1271 $node = node_build_content($node, FALSE, FALSE);
webmaster@1 1272 $node->body = drupal_render($node->content);
webmaster@1 1273
webmaster@1 1274 // Fetch comments for snippet
webmaster@1 1275 $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');
webmaster@1 1276 // Fetch terms for snippet
webmaster@1 1277 $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
webmaster@1 1278
webmaster@1 1279 $extra = node_invoke_nodeapi($node, 'search result');
webmaster@1 1280 $results[] = array(
webmaster@1 1281 'link' => url('node/'. $item->sid, array('absolute' => TRUE)),
webmaster@1 1282 'type' => check_plain(node_get_types('name', $node)),
webmaster@1 1283 'title' => $node->title,
webmaster@1 1284 'user' => theme('username', $node),
webmaster@1 1285 'date' => $node->changed,
webmaster@1 1286 'node' => $node,
webmaster@1 1287 'extra' => $extra,
webmaster@1 1288 'score' => $item->score / $total,
webmaster@1 1289 'snippet' => search_excerpt($keys, $node->body),
webmaster@1 1290 );
webmaster@1 1291 }
webmaster@1 1292 return $results;
webmaster@1 1293 }
webmaster@1 1294 }
webmaster@1 1295
webmaster@1 1296 /**
webmaster@1 1297 * Implementation of hook_user().
webmaster@1 1298 */
webmaster@1 1299 function node_user($op, &$edit, &$user) {
webmaster@1 1300 if ($op == 'delete') {
webmaster@1 1301 db_query('UPDATE {node} SET uid = 0 WHERE uid = %d', $user->uid);
webmaster@1 1302 db_query('UPDATE {node_revisions} SET uid = 0 WHERE uid = %d', $user->uid);
webmaster@1 1303 }
webmaster@1 1304 }
webmaster@1 1305
webmaster@1 1306 /**
webmaster@1 1307 * Theme the content ranking part of the search settings admin page.
webmaster@1 1308 *
webmaster@1 1309 * @ingroup themeable
webmaster@1 1310 */
webmaster@1 1311 function theme_node_search_admin($form) {
webmaster@1 1312 $output = drupal_render($form['info']);
webmaster@1 1313
webmaster@1 1314 $header = array(t('Factor'), t('Weight'));
webmaster@1 1315 foreach (element_children($form['factors']) as $key) {
webmaster@1 1316 $row = array();
webmaster@1 1317 $row[] = $form['factors'][$key]['#title'];
webmaster@1 1318 unset($form['factors'][$key]['#title']);
webmaster@1 1319 $row[] = drupal_render($form['factors'][$key]);
webmaster@1 1320 $rows[] = $row;
webmaster@1 1321 }
webmaster@1 1322 $output .= theme('table', $header, $rows);
webmaster@1 1323
webmaster@1 1324 $output .= drupal_render($form);
webmaster@1 1325 return $output;
webmaster@1 1326 }
webmaster@1 1327
webmaster@1 1328 /**
webmaster@1 1329 * Retrieve the comment mode for the given node ID (none, read, or read/write).
webmaster@1 1330 */
webmaster@1 1331 function node_comment_mode($nid) {
webmaster@1 1332 static $comment_mode;
webmaster@1 1333 if (!isset($comment_mode[$nid])) {
webmaster@1 1334 $comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
webmaster@1 1335 }
webmaster@1 1336 return $comment_mode[$nid];
webmaster@1 1337 }
webmaster@1 1338
webmaster@1 1339 /**
webmaster@1 1340 * Implementation of hook_link().
webmaster@1 1341 */
webmaster@1 1342 function node_link($type, $node = NULL, $teaser = FALSE) {
webmaster@1 1343 $links = array();
webmaster@1 1344
webmaster@1 1345 if ($type == 'node') {
webmaster@1 1346 if ($teaser == 1 && $node->teaser && !empty($node->readmore)) {
webmaster@1 1347 $links['node_read_more'] = array(
webmaster@1 1348 'title' => t('Read more'),
webmaster@1 1349 'href' => "node/$node->nid",
webmaster@1 1350 // The title attribute gets escaped when the links are processed, so
webmaster@1 1351 // there is no need to escape here.
webmaster@1 1352 'attributes' => array('title' => t('Read the rest of !title.', array('!title' => $node->title)))
webmaster@1 1353 );
webmaster@1 1354 }
webmaster@1 1355 }
webmaster@1 1356
webmaster@1 1357 return $links;
webmaster@1 1358 }
webmaster@1 1359
webmaster@1 1360 function _node_revision_access($node, $op = 'view') {
webmaster@1 1361 static $access = array();
webmaster@1 1362 if (!isset($access[$node->vid])) {
webmaster@1 1363 $node_current_revision = node_load($node->nid);
webmaster@1 1364 $is_current_revision = $node_current_revision->vid == $node->vid;
webmaster@1 1365 // There should be at least two revisions. If the vid of the given node
webmaster@1 1366 // and the vid of the current revision differs, then we already have two
webmaster@1 1367 // different revisions so there is no need for a separate database check.
webmaster@1 1368 // Also, if you try to revert to or delete the current revision, that's
webmaster@1 1369 // not good.
webmaster@1 1370 if ($is_current_revision && (db_result(db_query('SELECT COUNT(vid) FROM {node_revisions} WHERE nid = %d', $node->nid)) == 1 || $op == 'update' || $op == 'delete')) {
webmaster@1 1371 $access[$node->vid] = FALSE;
webmaster@1 1372 }
webmaster@1 1373 elseif (user_access('administer nodes')) {
webmaster@1 1374 $access[$node->vid] = TRUE;
webmaster@1 1375 }
webmaster@1 1376 else {
webmaster@1 1377 $map = array('view' => 'view revisions', 'update' => 'revert revisions', 'delete' => 'delete revisions');
webmaster@1 1378 // First check the user permission, second check the access to the
webmaster@1 1379 // current revision and finally, if the node passed in is not the current
webmaster@1 1380 // revision then access to that, too.
webmaster@1 1381 $access[$node->vid] = isset($map[$op]) && user_access($map[$op]) && node_access($op, $node_current_revision) && ($is_current_revision || node_access($op, $node));
webmaster@1 1382 }
webmaster@1 1383 }
webmaster@1 1384 return $access[$node->vid];
webmaster@1 1385 }
webmaster@1 1386
webmaster@1 1387 function _node_add_access() {
webmaster@1 1388 $types = node_get_types();
webmaster@1 1389 foreach ($types as $type) {
webmaster@1 1390 if (node_hook($type->type, 'form') && node_access('create', $type->type)) {
webmaster@1 1391 return TRUE;
webmaster@1 1392 }
webmaster@1 1393 }
webmaster@1 1394 return FALSE;
webmaster@1 1395 }
webmaster@1 1396
webmaster@1 1397 /**
webmaster@1 1398 * Implementation of hook_menu().
webmaster@1 1399 */
webmaster@1 1400 function node_menu() {
webmaster@1 1401 $items['admin/content/node'] = array(
webmaster@1 1402 'title' => 'Content',
webmaster@1 1403 'description' => "View, edit, and delete your site's content.",
webmaster@1 1404 'page callback' => 'drupal_get_form',
webmaster@1 1405 'page arguments' => array('node_admin_content'),
webmaster@1 1406 'access arguments' => array('administer nodes'),
webmaster@1 1407 'file' => 'node.admin.inc',
webmaster@1 1408 );
webmaster@1 1409
webmaster@1 1410 $items['admin/content/node/overview'] = array(
webmaster@1 1411 'title' => 'List',
webmaster@1 1412 'type' => MENU_DEFAULT_LOCAL_TASK,
webmaster@1 1413 'weight' => -10,
webmaster@1 1414 );
webmaster@1 1415
webmaster@1 1416 $items['admin/content/node-settings'] = array(
webmaster@1 1417 'title' => 'Post settings',
webmaster@1 1418 'description' => 'Control posting behavior, such as teaser length, requiring previews before posting, and the number of posts on the front page.',
webmaster@1 1419 'page callback' => 'drupal_get_form',
webmaster@1 1420 'page arguments' => array('node_configure'),
webmaster@1 1421 'access arguments' => array('administer nodes'),
webmaster@1 1422 'file' => 'node.admin.inc',
webmaster@1 1423 );
webmaster@1 1424 $items['admin/content/node-settings/rebuild'] = array(
webmaster@1 1425 'title' => 'Rebuild permissions',
webmaster@1 1426 'page arguments' => array('node_configure_rebuild_confirm'),
webmaster@1 1427 'file' => 'node.admin.inc',
webmaster@1 1428 // Any user than can potentially trigger a node_acess_needs_rebuild(TRUE)
webmaster@1 1429 // has to be allowed access to the 'node access rebuild' confirm form.
webmaster@1 1430 'access arguments' => array('access administration pages'),
webmaster@1 1431 'type' => MENU_CALLBACK,
webmaster@1 1432 );
webmaster@1 1433
webmaster@1 1434 $items['admin/content/types'] = array(
webmaster@1 1435 'title' => 'Content types',
webmaster@1 1436 'description' => 'Manage posts by content type, including default status, front page promotion, etc.',
webmaster@1 1437 'page callback' => 'node_overview_types',
webmaster@1 1438 'access arguments' => array('administer content types'),
webmaster@1 1439 'file' => 'content_types.inc',
webmaster@1 1440 );
webmaster@1 1441 $items['admin/content/types/list'] = array(
webmaster@1 1442 'title' => 'List',
webmaster@1 1443 'type' => MENU_DEFAULT_LOCAL_TASK,
webmaster@1 1444 'weight' => -10,
webmaster@1 1445 );
webmaster@1 1446 $items['admin/content/types/add'] = array(
webmaster@1 1447 'title' => 'Add content type',
webmaster@1 1448 'page callback' => 'drupal_get_form',
webmaster@1 1449 'page arguments' => array('node_type_form'),
webmaster@1 1450 'file' => 'content_types.inc',
webmaster@1 1451 'type' => MENU_LOCAL_TASK,
webmaster@1 1452 );
webmaster@1 1453 $items['node'] = array(
webmaster@1 1454 'title' => 'Content',
webmaster@1 1455 'page callback' => 'node_page_default',
webmaster@1 1456 'access arguments' => array('access content'),
webmaster@1 1457 'type' => MENU_CALLBACK,
webmaster@1 1458 );
webmaster@1 1459 $items['node/add'] = array(
webmaster@1 1460 'title' => 'Create content',
webmaster@1 1461 'page callback' => 'node_add_page',
webmaster@1 1462 'access callback' => '_node_add_access',
webmaster@1 1463 'weight' => 1,
webmaster@1 1464 'file' => 'node.pages.inc',
webmaster@1 1465 );
webmaster@1 1466 $items['rss.xml'] = array(
webmaster@1 1467 'title' => 'RSS feed',
webmaster@1 1468 'page callback' => 'node_feed',
webmaster@1 1469 'access arguments' => array('access content'),
webmaster@1 1470 'type' => MENU_CALLBACK,
webmaster@1 1471 );
webmaster@1 1472 foreach (node_get_types('types', NULL, TRUE) as $type) {
webmaster@1 1473 $type_url_str = str_replace('_', '-', $type->type);
webmaster@1 1474 $items['node/add/'. $type_url_str] = array(
webmaster@1 1475 'title' => drupal_ucfirst($type->name),
webmaster@1 1476 'title callback' => 'check_plain',
webmaster@1 1477 'page callback' => 'node_add',
webmaster@1 1478 'page arguments' => array(2),
webmaster@1 1479 'access callback' => 'node_access',
webmaster@1 1480 'access arguments' => array('create', $type->type),
webmaster@1 1481 'description' => $type->description,
webmaster@1 1482 'file' => 'node.pages.inc',
webmaster@1 1483 );
webmaster@1 1484 $items['admin/content/node-type/'. $type_url_str] = array(
webmaster@1 1485 'title' => $type->name,
webmaster@1 1486 'page callback' => 'drupal_get_form',
webmaster@1 1487 'page arguments' => array('node_type_form', $type),
webmaster@1 1488 'file' => 'content_types.inc',
webmaster@1 1489 'type' => MENU_CALLBACK,
webmaster@1 1490 );
webmaster@1 1491 $items['admin/content/node-type/'. $type_url_str .'/edit'] = array(
webmaster@1 1492 'title' => 'Edit',
webmaster@1 1493 'type' => MENU_DEFAULT_LOCAL_TASK,
webmaster@1 1494 );
webmaster@1 1495 $items['admin/content/node-type/'. $type_url_str .'/delete'] = array(
webmaster@1 1496 'title' => 'Delete',
webmaster@1 1497 'page arguments' => array('node_type_delete_confirm', $type),
webmaster@1 1498 'file' => 'content_types.inc',
webmaster@1 1499 'type' => MENU_CALLBACK,
webmaster@1 1500 );
webmaster@1 1501 }
webmaster@1 1502 $items['node/%node'] = array(
webmaster@1 1503 'title callback' => 'node_page_title',
webmaster@1 1504 'title arguments' => array(1),
webmaster@1 1505 'page callback' => 'node_page_view',
webmaster@1 1506 'page arguments' => array(1),
webmaster@1 1507 'access callback' => 'node_access',
webmaster@1 1508 'access arguments' => array('view', 1),
webmaster@1 1509 'type' => MENU_CALLBACK);
webmaster@1 1510 $items['node/%node/view'] = array(
webmaster@1 1511 'title' => 'View',
webmaster@1 1512 'type' => MENU_DEFAULT_LOCAL_TASK,
webmaster@1 1513 'weight' => -10);
webmaster@1 1514 $items['node/%node/edit'] = array(
webmaster@1 1515 'title' => 'Edit',
webmaster@1 1516 'page callback' => 'node_page_edit',
webmaster@1 1517 'page arguments' => array(1),
webmaster@1 1518 'access callback' => 'node_access',
webmaster@1 1519 'access arguments' => array('update', 1),
webmaster@1 1520 'weight' => 1,
webmaster@1 1521 'file' => 'node.pages.inc',
webmaster@1 1522 'type' => MENU_LOCAL_TASK,
webmaster@1 1523 );
webmaster@1 1524 $items['node/%node/delete'] = array(
webmaster@1 1525 'title' => 'Delete',
webmaster@1 1526 'page callback' => 'drupal_get_form',
webmaster@1 1527 'page arguments' => array('node_delete_confirm', 1),
webmaster@1 1528 'access callback' => 'node_access',
webmaster@1 1529 'access arguments' => array('delete', 1),
webmaster@1 1530 'file' => 'node.pages.inc',
webmaster@1 1531 'weight' => 1,
webmaster@1 1532 'type' => MENU_CALLBACK);
webmaster@1 1533 $items['node/%node/revisions'] = array(
webmaster@1 1534 'title' => 'Revisions',
webmaster@1 1535 'page callback' => 'node_revision_overview',
webmaster@1 1536 'page arguments' => array(1),
webmaster@1 1537 'access callback' => '_node_revision_access',
webmaster@1 1538 'access arguments' => array(1),
webmaster@1 1539 'weight' => 2,
webmaster@1 1540 'file' => 'node.pages.inc',
webmaster@1 1541 'type' => MENU_LOCAL_TASK,
webmaster@1 1542 );
webmaster@1 1543 $items['node/%node/revisions/%/view'] = array(
webmaster@1 1544 'title' => 'Revisions',
webmaster@1 1545 'load arguments' => array(3),
webmaster@1 1546 'page callback' => 'node_show',
webmaster@1 1547 'page arguments' => array(1, NULL, TRUE),
webmaster@1 1548 'type' => MENU_CALLBACK,
webmaster@1 1549 );
webmaster@1 1550 $items['node/%node/revisions/%/revert'] = array(
webmaster@1 1551 'title' => 'Revert to earlier revision',
webmaster@1 1552 'load arguments' => array(3),
webmaster@1 1553 'page callback' => 'drupal_get_form',
webmaster@1 1554 'page arguments' => array('node_revision_revert_confirm', 1),
webmaster@1 1555 'access callback' => '_node_revision_access',
webmaster@1 1556 'access arguments' => array(1, 'update'),
webmaster@1 1557 'file' => 'node.pages.inc',
webmaster@1 1558 'type' => MENU_CALLBACK,
webmaster@1 1559 );
webmaster@1 1560 $items['node/%node/revisions/%/delete'] = array(
webmaster@1 1561 'title' => 'Delete earlier revision',
webmaster@1 1562 'load arguments' => array(3),
webmaster@1 1563 'page callback' => 'drupal_get_form',
webmaster@1 1564 'page arguments' => array('node_revision_delete_confirm', 1),
webmaster@1 1565 'access callback' => '_node_revision_access',
webmaster@1 1566 'access arguments' => array(1, 'delete'),
webmaster@1 1567 'file' => 'node.pages.inc',
webmaster@1 1568 'type' => MENU_CALLBACK,
webmaster@1 1569 );
webmaster@1 1570 return $items;
webmaster@1 1571 }
webmaster@1 1572
webmaster@1 1573 /**
webmaster@1 1574 * Title callback.
webmaster@1 1575 */
webmaster@1 1576 function node_page_title($node) {
webmaster@1 1577 return $node->title;
webmaster@1 1578 }
webmaster@1 1579
webmaster@1 1580 /**
webmaster@1 1581 * Implementation of hook_init().
webmaster@1 1582 */
webmaster@1 1583 function node_init() {
webmaster@1 1584 drupal_add_css(drupal_get_path('module', 'node') .'/node.css');
webmaster@1 1585 }
webmaster@1 1586
webmaster@1 1587 function node_last_changed($nid) {
webmaster@1 1588 $node = db_fetch_object(db_query('SELECT changed FROM {node} WHERE nid = %d', $nid));
webmaster@1 1589 return ($node->changed);
webmaster@1 1590 }
webmaster@1 1591
webmaster@1 1592 /**
webmaster@1 1593 * Return a list of all the existing revision numbers.
webmaster@1 1594 */
webmaster@1 1595 function node_revision_list($node) {
webmaster@1 1596 $revisions = array();
webmaster@1 1597 $result = db_query('SELECT r.vid, r.title, r.log, r.uid, n.vid AS current_vid, r.timestamp, u.name FROM {node_revisions} r LEFT JOIN {node} n ON n.vid = r.vid INNER JOIN {users} u ON u.uid = r.uid WHERE r.nid = %d ORDER BY r.timestamp DESC', $node->nid);
webmaster@1 1598 while ($revision = db_fetch_object($result)) {
webmaster@1 1599 $revisions[$revision->vid] = $revision;
webmaster@1 1600 }
webmaster@1 1601
webmaster@1 1602 return $revisions;
webmaster@1 1603 }
webmaster@1 1604
webmaster@1 1605 /**
webmaster@1 1606 * Implementation of hook_block().
webmaster@1 1607 */
webmaster@1 1608 function node_block($op = 'list', $delta = 0) {
webmaster@1 1609 if ($op == 'list') {
webmaster@1 1610 $blocks[0]['info'] = t('Syndicate');
webmaster@1 1611 // Not worth caching.
webmaster@1 1612 $blocks[0]['cache'] = BLOCK_NO_CACHE;
webmaster@1 1613 return $blocks;
webmaster@1 1614 }
webmaster@1 1615 else if ($op == 'view') {
webmaster@1 1616 $block['subject'] = t('Syndicate');
webmaster@1 1617 $block['content'] = theme('feed_icon', url('rss.xml'), t('Syndicate'));
webmaster@1 1618
webmaster@1 1619 return $block;
webmaster@1 1620 }
webmaster@1 1621 }
webmaster@1 1622
webmaster@1 1623 /**
webmaster@1 1624 * A generic function for generating RSS feeds from a set of nodes.
webmaster@1 1625 *
webmaster@1 1626 * @param $nids
webmaster@1 1627 * An array of node IDs (nid). Defaults to FALSE so empty feeds can be
webmaster@1 1628 * generated with passing an empty array, if no items are to be added
webmaster@1 1629 * to the feed.
webmaster@1 1630 * @param $channel
webmaster@1 1631 * An associative array containing title, link, description and other keys.
webmaster@1 1632 * The link should be an absolute URL.
webmaster@1 1633 */
webmaster@1 1634 function node_feed($nids = FALSE, $channel = array()) {
webmaster@1 1635 global $base_url, $language;
webmaster@1 1636
webmaster@1 1637 if ($nids === FALSE) {
webmaster@1 1638 $nids = array();
webmaster@1 1639 $result = db_query_range(db_rewrite_sql('SELECT n.nid, n.created FROM {node} n WHERE n.promote = 1 AND n.status = 1 ORDER BY n.created DESC'), 0, variable_get('feed_default_items', 10));
webmaster@1 1640 while ($row = db_fetch_object($result)) {
webmaster@1 1641 $nids[] = $row->nid;
webmaster@1 1642 }
webmaster@1 1643 }
webmaster@1 1644
webmaster@1 1645 $item_length = variable_get('feed_item_length', 'teaser');
webmaster@1 1646 $namespaces = array('xmlns:dc' => 'http://purl.org/dc/elements/1.1/');
webmaster@1 1647
webmaster@1 1648 $items = '';
webmaster@1 1649 foreach ($nids as $nid) {
webmaster@1 1650 // Load the specified node:
webmaster@1 1651 $item = node_load($nid);
webmaster@1 1652 $item->build_mode = NODE_BUILD_RSS;
webmaster@1 1653 $item->link = url("node/$nid", array('absolute' => TRUE));
webmaster@1 1654
webmaster@1 1655 if ($item_length != 'title') {
webmaster@1 1656 $teaser = ($item_length == 'teaser') ? TRUE : FALSE;
webmaster@1 1657
webmaster@1 1658 // Filter and prepare node teaser
webmaster@1 1659 if (node_hook($item, 'view')) {
webmaster@1 1660 $item = node_invoke($item, 'view', $teaser, FALSE);
webmaster@1 1661 }
webmaster@1 1662 else {
webmaster@1 1663 $item = node_prepare($item, $teaser);
webmaster@1 1664 }
webmaster@1 1665
webmaster@1 1666 // Allow modules to change $node->teaser before viewing.
webmaster@1 1667 node_invoke_nodeapi($item, 'view', $teaser, FALSE);
webmaster@1 1668 }
webmaster@1 1669
webmaster@1 1670 // Allow modules to add additional item fields and/or modify $item
webmaster@1 1671 $extra = node_invoke_nodeapi($item, 'rss item');
webmaster@1 1672 $extra = array_merge($extra, array(array('key' => 'pubDate', 'value' => format_date($item->created, 'custom', 'r')), array('key' => 'dc:creator', 'value' => $item->name), array('key' => 'guid', 'value' => $item->nid .' at '. $base_url, 'attributes' => array('isPermaLink' => 'false'))));
webmaster@1 1673 foreach ($extra as $element) {
webmaster@1 1674 if (isset($element['namespace'])) {
webmaster@1 1675 $namespaces = array_merge($namespaces, $element['namespace']);
webmaster@1 1676 }
webmaster@1 1677 }
webmaster@1 1678
webmaster@1 1679 // Prepare the item description
webmaster@1 1680 switch ($item_length) {
webmaster@1 1681 case 'fulltext':
webmaster@1 1682 $item_text = $item->body;
webmaster@1 1683 break;
webmaster@1 1684 case 'teaser':
webmaster@1 1685 $item_text = $item->teaser;
webmaster@1 1686 if (!empty($item->readmore)) {
webmaster@1 1687 $item_text .= '<p>'. l(t('read more'), 'node/'. $item->nid, array('absolute' => TRUE, 'attributes' => array('target' => '_blank'))) .'</p>';
webmaster@1 1688 }
webmaster@1 1689 break;
webmaster@1 1690 case 'title':
webmaster@1 1691 $item_text = '';
webmaster@1 1692 break;
webmaster@1 1693 }
webmaster@1 1694
webmaster@1 1695 $items .= format_rss_item($item->title, $item->link, $item_text, $extra);
webmaster@1 1696 }
webmaster@1 1697
webmaster@1 1698 $channel_defaults = array(
webmaster@1 1699 'version' => '2.0',
webmaster@1 1700 'title' => variable_get('site_name', 'Drupal'),
webmaster@1 1701 'link' => $base_url,
webmaster@1 1702 'description' => variable_get('site_mission', ''),
webmaster@1 1703 'language' => $language->language
webmaster@1 1704 );
webmaster@1 1705 $channel = array_merge($channel_defaults, $channel);
webmaster@1 1706
webmaster@1 1707 $output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
webmaster@1 1708 $output .= "<rss version=\"". $channel["version"] ."\" xml:base=\"". $base_url ."\" ". drupal_attributes($namespaces) .">\n";
webmaster@1 1709 $output .= format_rss_channel($channel['title'], $channel['link'], $channel['description'], $items, $channel['language']);
webmaster@1 1710 $output .= "</rss>\n";
webmaster@1 1711
webmaster@1 1712 drupal_set_header('Content-Type: application/rss+xml; charset=utf-8');
webmaster@1 1713 print $output;
webmaster@1 1714 }
webmaster@1 1715
webmaster@1 1716 /**
webmaster@1 1717 * Menu callback; Generate a listing of promoted nodes.
webmaster@1 1718 */
webmaster@1 1719 function node_page_default() {
webmaster@1 1720 $result = pager_query(db_rewrite_sql('SELECT n.nid, n.sticky, n.created FROM {node} n WHERE n.promote = 1 AND n.status = 1 ORDER BY n.sticky DESC, n.created DESC'), variable_get('default_nodes_main', 10));
webmaster@1 1721
webmaster@1 1722 $output = '';
webmaster@1 1723 $num_rows = FALSE;
webmaster@1 1724 while ($node = db_fetch_object($result)) {
webmaster@1 1725 $output .= node_view(node_load($node->nid), 1);
webmaster@1 1726 $num_rows = TRUE;
webmaster@1 1727 }
webmaster@1 1728
webmaster@1 1729 if ($num_rows) {
webmaster@1 1730 $feed_url = url('rss.xml', array('absolute' => TRUE));
webmaster@1 1731 drupal_add_feed($feed_url, variable_get('site_name', 'Drupal') .' '. t('RSS'));
webmaster@1 1732 $output .= theme('pager', NULL, variable_get('default_nodes_main', 10));
webmaster@1 1733 }
webmaster@1 1734 else {
webmaster@1 1735 $default_message = t('<h1 class="title">Welcome to your new Drupal website!</h1><p>Please follow these steps to set up and start using your website:</p>');
webmaster@1 1736 $default_message .= '<ol>';
webmaster@1 1737
webmaster@1 1738 $default_message .= '<li>'. t('<strong>Configure your website</strong> Once logged in, visit the <a href="@admin">administration section</a>, where you can <a href="@config">customize and configure</a> all aspects of your website.', array('@admin' => url('admin'), '@config' => url('admin/settings'))) .'</li>';
webmaster@1 1739 $default_message .= '<li>'. t('<strong>Enable additional functionality</strong> Next, visit the <a href="@modules">module list</a> and enable features which suit your specific needs. You can find additional modules in the <a href="@download_modules">Drupal modules download section</a>.', array('@modules' => url('admin/build/modules'), '@download_modules' => 'http://drupal.org/project/modules')) .'</li>';
webmaster@1 1740 $default_message .= '<li>'. t('<strong>Customize your website design</strong> To change the "look and feel" of your website, visit the <a href="@themes">themes section</a>. You may choose from one of the included themes or download additional themes from the <a href="@download_themes">Drupal themes download section</a>.', array('@themes' => url('admin/build/themes'), '@download_themes' => 'http://drupal.org/project/themes')) .'</li>';
webmaster@1 1741 $default_message .= '<li>'. t('<strong>Start posting content</strong> Finally, you can <a href="@content">create content</a> for your website. This message will disappear once you have promoted a post to the front page.', array('@content' => url('node/add'))) .'</li>';
webmaster@1 1742 $default_message .= '</ol>';
webmaster@1 1743 $default_message .= '<p>'. t('For more information, please refer to the <a href="@help">help section</a>, or the <a href="@handbook">online Drupal handbooks</a>. You may also post at the <a href="@forum">Drupal forum</a>, or view the wide range of <a href="@support">other support options</a> available.', array('@help' => url('admin/help'), '@handbook' => 'http://drupal.org/handbooks', '@forum' => 'http://drupal.org/forum', '@support' => 'http://drupal.org/support')) .'</p>';
webmaster@1 1744
webmaster@1 1745 $output = '<div id="first-time">'. $default_message .'</div>';
webmaster@1 1746 }
webmaster@1 1747 drupal_set_title('');
webmaster@1 1748
webmaster@1 1749 return $output;
webmaster@1 1750 }
webmaster@1 1751
webmaster@1 1752 /**
webmaster@1 1753 * Menu callback; view a single node.
webmaster@1 1754 */
webmaster@1 1755 function node_page_view($node, $cid = NULL) {
webmaster@1 1756 drupal_set_title(check_plain($node->title));
webmaster@1 1757 return node_show($node, $cid);
webmaster@1 1758 }
webmaster@1 1759
webmaster@1 1760 /**
webmaster@1 1761 * Implementation of hook_update_index().
webmaster@1 1762 */
webmaster@1 1763 function node_update_index() {
webmaster@1 1764 $limit = (int)variable_get('search_cron_limit', 100);
webmaster@1 1765
webmaster@1 1766 // Store the maximum possible comments per thread (used for ranking by reply count)
webmaster@1 1767 variable_set('node_cron_comments_scale', 1.0 / max(1, db_result(db_query('SELECT MAX(comment_count) FROM {node_comment_statistics}'))));
webmaster@1 1768 variable_set('node_cron_views_scale', 1.0 / max(1, db_result(db_query('SELECT MAX(totalcount) FROM {node_counter}'))));
webmaster@1 1769
webmaster@1 1770 $result = db_query_range("SELECT n.nid FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE d.sid IS NULL OR d.reindex <> 0 ORDER BY d.reindex ASC, n.nid ASC", 0, $limit);
webmaster@1 1771
webmaster@1 1772 while ($node = db_fetch_object($result)) {
webmaster@1 1773 _node_index_node($node);
webmaster@1 1774 }
webmaster@1 1775 }
webmaster@1 1776
webmaster@1 1777 /**
webmaster@1 1778 * Index a single node.
webmaster@1 1779 *
webmaster@1 1780 * @param $node
webmaster@1 1781 * The node to index.
webmaster@1 1782 */
webmaster@1 1783 function _node_index_node($node) {
webmaster@1 1784 $node = node_load($node->nid);
webmaster@1 1785
webmaster@1 1786 // save the changed time of the most recent indexed node, for the search results half-life calculation
webmaster@1 1787 variable_set('node_cron_last', $node->changed);
webmaster@1 1788
webmaster@1 1789 // Build the node body.
webmaster@1 1790 $node->build_mode = NODE_BUILD_SEARCH_INDEX;
webmaster@1 1791 $node = node_build_content($node, FALSE, FALSE);
webmaster@1 1792 $node->body = drupal_render($node->content);
webmaster@1 1793
webmaster@1 1794 $text = '<h1>'. check_plain($node->title) .'</h1>'. $node->body;
webmaster@1 1795
webmaster@1 1796 // Fetch extra data normally not visible
webmaster@1 1797 $extra = node_invoke_nodeapi($node, 'update index');
webmaster@1 1798 foreach ($extra as $t) {
webmaster@1 1799 $text .= $t;
webmaster@1 1800 }
webmaster@1 1801
webmaster@1 1802 // Update index
webmaster@1 1803 search_index($node->nid, 'node', $text);
webmaster@1 1804 }
webmaster@1 1805
webmaster@1 1806 /**
webmaster@1 1807 * Implementation of hook_form_alter().
webmaster@1 1808 */
webmaster@1 1809 function node_form_alter(&$form, $form_state, $form_id) {
webmaster@1 1810 // Advanced node search form
webmaster@1 1811 if ($form_id == 'search_form' && $form['module']['#value'] == 'node' && user_access('use advanced search')) {
webmaster@1 1812 // Keyword boxes:
webmaster@1 1813 $form['advanced'] = array(
webmaster@1 1814 '#type' => 'fieldset',
webmaster@1 1815 '#title' => t('Advanced search'),
webmaster@1 1816 '#collapsible' => TRUE,
webmaster@1 1817 '#collapsed' => TRUE,
webmaster@1 1818 '#attributes' => array('class' => 'search-advanced'),
webmaster@1 1819 );
webmaster@1 1820 $form['advanced']['keywords'] = array(
webmaster@1 1821 '#prefix' => '<div class="criterion">',
webmaster@1 1822 '#suffix' => '</div>',
webmaster@1 1823 );
webmaster@1 1824 $form['advanced']['keywords']['or'] = array(
webmaster@1 1825 '#type' => 'textfield',
webmaster@1 1826 '#title' => t('Containing any of the words'),
webmaster@1 1827 '#size' => 30,
webmaster@1 1828 '#maxlength' => 255,
webmaster@1 1829 );
webmaster@1 1830 $form['advanced']['keywords']['phrase'] = array(
webmaster@1 1831 '#type' => 'textfield',
webmaster@1 1832 '#title' => t('Containing the phrase'),
webmaster@1 1833 '#size' => 30,
webmaster@1 1834 '#maxlength' => 255,
webmaster@1 1835 );
webmaster@1 1836 $form['advanced']['keywords']['negative'] = array(
webmaster@1 1837 '#type' => 'textfield',
webmaster@1 1838 '#title' => t('Containing none of the words'),
webmaster@1 1839 '#size' => 30,
webmaster@1 1840 '#maxlength' => 255,
webmaster@1 1841 );
webmaster@1 1842
webmaster@1 1843 // Taxonomy box:
webmaster@1 1844 if ($taxonomy = module_invoke('taxonomy', 'form_all', 1)) {
webmaster@1 1845 $form['advanced']['category'] = array(
webmaster@1 1846 '#type' => 'select',
webmaster@1 1847 '#title' => t('Only in the category(s)'),
webmaster@1 1848 '#prefix' => '<div class="criterion">',
webmaster@1 1849 '#size' => 10,
webmaster@1 1850 '#suffix' => '</div>',
webmaster@1 1851 '#options' => $taxonomy,
webmaster@1 1852 '#multiple' => TRUE,
webmaster@1 1853 );
webmaster@1 1854 }
webmaster@1 1855
webmaster@1 1856 // Node types:
webmaster@1 1857 $types = array_map('check_plain', node_get_types('names'));
webmaster@1 1858 $form['advanced']['type'] = array(
webmaster@1 1859 '#type' => 'checkboxes',
webmaster@1 1860 '#title' => t('Only of the type(s)'),
webmaster@1 1861 '#prefix' => '<div class="criterion">',
webmaster@1 1862 '#suffix' => '</div>',
webmaster@1 1863 '#options' => $types,
webmaster@1 1864 );
webmaster@1 1865 $form['advanced']['submit'] = array(
webmaster@1 1866 '#type' => 'submit',
webmaster@1 1867 '#value' => t('Advanced search'),
webmaster@1 1868 '#prefix' => '<div class="action">',
webmaster@1 1869 '#suffix' => '</div>',
webmaster@1 1870 );
webmaster@1 1871
webmaster@1 1872 $form['#validate'][] = 'node_search_validate';
webmaster@1 1873 }
webmaster@1 1874 }
webmaster@1 1875
webmaster@1 1876 /**
webmaster@1 1877 * Form API callback for the search form. Registered in node_form_alter().
webmaster@1 1878 */
webmaster@1 1879 function node_search_validate($form, &$form_state) {
webmaster@1 1880 // Initialise using any existing basic search keywords.
webmaster@1 1881 $keys = $form_state['values']['processed_keys'];
webmaster@1 1882
webmaster@1 1883 // Insert extra restrictions into the search keywords string.
webmaster@1 1884 if (isset($form_state['values']['type']) && is_array($form_state['values']['type'])) {
webmaster@1 1885 // Retrieve selected types - Forms API sets the value of unselected checkboxes to 0.
webmaster@1 1886 $form_state['values']['type'] = array_filter($form_state['values']['type']);
webmaster@1 1887 if (count($form_state['values']['type'])) {
webmaster@1 1888 $keys = search_query_insert($keys, 'type', implode(',', array_keys($form_state['values']['type'])));
webmaster@1 1889 }
webmaster@1 1890 }
webmaster@1 1891
webmaster@1 1892 if (isset($form_state['values']['category']) && is_array($form_state['values']['category'])) {
webmaster@1 1893 $keys = search_query_insert($keys, 'category', implode(',', $form_state['values']['category']));
webmaster@1 1894 }
webmaster@1 1895 if ($form_state['values']['or'] != '') {
webmaster@1 1896 if (preg_match_all('/ ("[^"]+"|[^" ]+)/i', ' '. $form_state['values']['or'], $matches)) {
webmaster@1 1897 $keys .= ' '. implode(' OR ', $matches[1]);
webmaster@1 1898 }
webmaster@1 1899 }
webmaster@1 1900 if ($form_state['values']['negative'] != '') {
webmaster@1 1901 if (preg_match_all('/ ("[^"]+"|[^" ]+)/i', ' '. $form_state['values']['negative'], $matches)) {
webmaster@1 1902 $keys .= ' -'. implode(' -', $matches[1]);
webmaster@1 1903 }
webmaster@1 1904 }
webmaster@1 1905 if ($form_state['values']['phrase'] != '') {
webmaster@1 1906 $keys .= ' "'. str_replace('"', ' ', $form_state['values']['phrase']) .'"';
webmaster@1 1907 }
webmaster@1 1908 if (!empty($keys)) {
webmaster@1 1909 form_set_value($form['basic']['inline']['processed_keys'], trim($keys), $form_state);
webmaster@1 1910 }
webmaster@1 1911 }
webmaster@1 1912
webmaster@1 1913 /**
webmaster@1 1914 * @defgroup node_access Node access rights
webmaster@1 1915 * @{
webmaster@1 1916 * The node access system determines who can do what to which nodes.
webmaster@1 1917 *
webmaster@1 1918 * In determining access rights for a node, node_access() first checks
webmaster@1 1919 * whether the user has the "administer nodes" permission. Such users have
webmaster@1 1920 * unrestricted access to all nodes. Then the node module's hook_access()
webmaster@1 1921 * is called, and a TRUE or FALSE return value will grant or deny access.
webmaster@1 1922 * This allows, for example, the blog module to always grant access to the
webmaster@1 1923 * blog author, and for the book module to always deny editing access to
webmaster@1 1924 * PHP pages.
webmaster@1 1925 *
webmaster@1 1926 * If node module does not intervene (returns NULL), then the
webmaster@1 1927 * node_access table is used to determine access. All node access
webmaster@1 1928 * modules are queried using hook_node_grants() to assemble a list of
webmaster@1 1929 * "grant IDs" for the user. This list is compared against the table.
webmaster@1 1930 * If any row contains the node ID in question (or 0, which stands for "all
webmaster@1 1931 * nodes"), one of the grant IDs returned, and a value of TRUE for the
webmaster@1 1932 * operation in question, then access is granted. Note that this table is a
webmaster@1 1933 * list of grants; any matching row is sufficient to grant access to the
webmaster@1 1934 * node.
webmaster@1 1935 *
webmaster@1 1936 * In node listings, the process above is followed except that
webmaster@1 1937 * hook_access() is not called on each node for performance reasons and for
webmaster@1 1938 * proper functioning of the pager system. When adding a node listing to your
webmaster@1 1939 * module, be sure to use db_rewrite_sql() to add
webmaster@1 1940 * the appropriate clauses to your query for access checks.
webmaster@1 1941 *
webmaster@1 1942 * To see how to write a node access module of your own, see
webmaster@1 1943 * node_access_example.module.
webmaster@1 1944 */
webmaster@1 1945
webmaster@1 1946 /**
webmaster@1 1947 * Determine whether the current user may perform the given operation on the
webmaster@1 1948 * specified node.
webmaster@1 1949 *
webmaster@1 1950 * @param $op
webmaster@1 1951 * The operation to be performed on the node. Possible values are:
webmaster@1 1952 * - "view"
webmaster@1 1953 * - "update"
webmaster@1 1954 * - "delete"
webmaster@1 1955 * - "create"
webmaster@1 1956 * @param $node
webmaster@1 1957 * The node object (or node array) on which the operation is to be performed,
webmaster@1 1958 * or node type (e.g. 'forum') for "create" operation.
webmaster@1 1959 * @param $account
webmaster@1 1960 * Optional, a user object representing the user for whom the operation is to
webmaster@1 1961 * be performed. Determines access for a user other than the current user.
webmaster@1 1962 * @return
webmaster@1 1963 * TRUE if the operation may be performed.
webmaster@1 1964 */
webmaster@1 1965 function node_access($op, $node, $account = NULL) {
webmaster@1 1966 global $user;
webmaster@1 1967
webmaster@1 1968 if (!$node) {
webmaster@1 1969 return FALSE;
webmaster@1 1970 }
webmaster@1 1971 // Convert the node to an object if necessary:
webmaster@1 1972 if ($op != 'create') {
webmaster@1 1973 $node = (object)$node;
webmaster@1 1974 }
webmaster@1 1975 // If no user object is supplied, the access check is for the current user.
webmaster@1 1976 if (empty($account)) {
webmaster@1 1977 $account = $user;
webmaster@1 1978 }
webmaster@1 1979 // If the node is in a restricted format, disallow editing.
webmaster@1 1980 if ($op == 'update' && !filter_access($node->format)) {
webmaster@1 1981 return FALSE;
webmaster@1 1982 }
webmaster@1 1983
webmaster@1 1984 if (user_access('administer nodes', $account)) {
webmaster@1 1985 return TRUE;
webmaster@1 1986 }
webmaster@1 1987
webmaster@1 1988 if (!user_access('access content', $account)) {
webmaster@1 1989 return FALSE;
webmaster@1 1990 }
webmaster@1 1991
webmaster@1 1992 // Can't use node_invoke(), because the access hook takes the $op parameter
webmaster@1 1993 // before the $node parameter.
webmaster@1 1994 $module = node_get_types('module', $node);
webmaster@1 1995 if ($module == 'node') {
webmaster@1 1996 $module = 'node_content'; // Avoid function name collisions.
webmaster@1 1997 }
webmaster@1 1998 $access = module_invoke($module, 'access', $op, $node, $account);
webmaster@1 1999 if (!is_null($access)) {
webmaster@1 2000 return $access;
webmaster@1 2001 }
webmaster@1 2002
webmaster@1 2003 // If the module did not override the access rights, use those set in the
webmaster@1 2004 // node_access table.
webmaster@1 2005 if ($op != 'create' && $node->nid && $node->status) {
webmaster@1 2006 $grants = array();
webmaster@1 2007 foreach (node_access_grants($op, $account) as $realm => $gids) {
webmaster@1 2008 foreach ($gids as $gid) {
webmaster@1 2009 $grants[] = "(gid = $gid AND realm = '$realm')";
webmaster@1 2010 }
webmaster@1 2011 }
webmaster@1 2012
webmaster@1 2013 $grants_sql = '';
webmaster@1 2014 if (count($grants)) {
webmaster@1 2015 $grants_sql = 'AND ('. implode(' OR ', $grants) .')';
webmaster@1 2016 }
webmaster@1 2017
webmaster@1 2018 $sql = "SELECT COUNT(*) FROM {node_access} WHERE (nid = 0 OR nid = %d) $grants_sql AND grant_$op >= 1";
webmaster@1 2019 $result = db_query($sql, $node->nid);
webmaster@1 2020 return (db_result($result));
webmaster@1 2021 }
webmaster@1 2022
webmaster@1 2023 // Let authors view their own nodes.
webmaster@1 2024 if ($op == 'view' && $account->uid == $node->uid && $account->uid != 0) {
webmaster@1 2025 return TRUE;
webmaster@1 2026 }
webmaster@1 2027
webmaster@1 2028 return FALSE;
webmaster@1 2029 }
webmaster@1 2030
webmaster@1 2031 /**
webmaster@1 2032 * Generate an SQL join clause for use in fetching a node listing.
webmaster@1 2033 *
webmaster@1 2034 * @param $node_alias
webmaster@1 2035 * If the node table has been given an SQL alias other than the default
webmaster@1 2036 * "n", that must be passed here.
webmaster@1 2037 * @param $node_access_alias
webmaster@1 2038 * If the node_access table has been given an SQL alias other than the default
webmaster@1 2039 * "na", that must be passed here.
webmaster@1 2040 * @return
webmaster@1 2041 * An SQL join clause.
webmaster@1 2042 */
webmaster@1 2043 function _node_access_join_sql($node_alias = 'n', $node_access_alias = 'na') {
webmaster@1 2044 if (user_access('administer nodes')) {
webmaster@1 2045 return '';
webmaster@1 2046 }
webmaster@1 2047
webmaster@1 2048 return 'INNER JOIN {node_access} '. $node_access_alias .' ON '. $node_access_alias .'.nid = '. $node_alias .'.nid';
webmaster@1 2049 }
webmaster@1 2050
webmaster@1 2051 /**
webmaster@1 2052 * Generate an SQL where clause for use in fetching a node listing.
webmaster@1 2053 *
webmaster@1 2054 * @param $op
webmaster@1 2055 * The operation that must be allowed to return a node.
webmaster@1 2056 * @param $node_access_alias
webmaster@1 2057 * If the node_access table has been given an SQL alias other than the default
webmaster@1 2058 * "na", that must be passed here.
webmaster@1 2059 * @param $account
webmaster@1 2060 * The user object for the user performing the operation. If omitted, the
webmaster@1 2061 * current user is used.
webmaster@1 2062 * @return
webmaster@1 2063 * An SQL where clause.
webmaster@1 2064 */
webmaster@1 2065 function _node_access_where_sql($op = 'view', $node_access_alias = 'na', $account = NULL) {
webmaster@1 2066 if (user_access('administer nodes')) {
webmaster@1 2067 return;
webmaster@1 2068 }
webmaster@1 2069
webmaster@1 2070 $grants = array();
webmaster@1 2071 foreach (node_access_grants($op, $account) as $realm => $gids) {
webmaster@1 2072 foreach ($gids as $gid) {
webmaster@1 2073 $grants[] = "($node_access_alias.gid = $gid AND $node_access_alias.realm = '$realm')";
webmaster@1 2074 }
webmaster@1 2075 }
webmaster@1 2076
webmaster@1 2077 $grants_sql = '';
webmaster@1 2078 if (count($grants)) {
webmaster@1 2079 $grants_sql = 'AND ('. implode(' OR ', $grants) .')';
webmaster@1 2080 }
webmaster@1 2081
webmaster@1 2082 $sql = "$node_access_alias.grant_$op >= 1 $grants_sql";
webmaster@1 2083 return $sql;
webmaster@1 2084 }
webmaster@1 2085
webmaster@1 2086 /**
webmaster@1 2087 * Fetch an array of permission IDs granted to the given user ID.
webmaster@1 2088 *
webmaster@1 2089 * The implementation here provides only the universal "all" grant. A node
webmaster@1 2090 * access module should implement hook_node_grants() to provide a grant
webmaster@1 2091 * list for the user.
webmaster@1 2092 *
webmaster@1 2093 * @param $op
webmaster@1 2094 * The operation that the user is trying to perform.
webmaster@1 2095 * @param $account
webmaster@1 2096 * The user object for the user performing the operation. If omitted, the
webmaster@1 2097 * current user is used.
webmaster@1 2098 * @return
webmaster@1 2099 * An associative array in which the keys are realms, and the values are
webmaster@1 2100 * arrays of grants for those realms.
webmaster@1 2101 */
webmaster@1 2102 function node_access_grants($op, $account = NULL) {
webmaster@1 2103
webmaster@1 2104 if (!isset($account)) {
webmaster@1 2105 $account = $GLOBALS['user'];
webmaster@1 2106 }
webmaster@1 2107
webmaster@1 2108 return array_merge(array('all' => array(0)), module_invoke_all('node_grants', $account, $op));
webmaster@1 2109 }
webmaster@1 2110
webmaster@1 2111 /**
webmaster@1 2112 * Determine whether the user has a global viewing grant for all nodes.
webmaster@1 2113 */
webmaster@1 2114 function node_access_view_all_nodes() {
webmaster@1 2115 static $access;
webmaster@1 2116
webmaster@1 2117 if (!isset($access)) {
webmaster@1 2118 $grants = array();
webmaster@1 2119 foreach (node_access_grants('view') as $realm => $gids) {
webmaster@1 2120 foreach ($gids as $gid) {
webmaster@1 2121 $grants[] = "(gid = $gid AND realm = '$realm')";
webmaster@1 2122 }
webmaster@1 2123 }
webmaster@1 2124
webmaster@1 2125 $grants_sql = '';
webmaster@1 2126 if (count($grants)) {
webmaster@1 2127 $grants_sql = 'AND ('. implode(' OR ', $grants) .')';
webmaster@1 2128 }
webmaster@1 2129
webmaster@1 2130 $sql = "SELECT COUNT(*) FROM {node_access} WHERE nid = 0 $grants_sql AND grant_view >= 1";
webmaster@1 2131 $result = db_query($sql);
webmaster@1 2132 $access = db_result($result);
webmaster@1 2133 }
webmaster@1 2134
webmaster@1 2135 return $access;
webmaster@1 2136 }
webmaster@1 2137
webmaster@1 2138 /**
webmaster@1 2139 * Implementation of hook_db_rewrite_sql
webmaster@1 2140 */
webmaster@1 2141 function node_db_rewrite_sql($query, $primary_table, $primary_field) {
webmaster@1 2142 if ($primary_field == 'nid' && !node_access_view_all_nodes()) {
webmaster@1 2143 $return['join'] = _node_access_join_sql($primary_table);
webmaster@1 2144 $return['where'] = _node_access_where_sql();
webmaster@1 2145 $return['distinct'] = 1;
webmaster@1 2146 return $return;
webmaster@1 2147 }
webmaster@1 2148 }
webmaster@1 2149
webmaster@1 2150 /**
webmaster@1 2151 * This function will call module invoke to get a list of grants and then
webmaster@1 2152 * write them to the database. It is called at node save, and should be
webmaster@1 2153 * called by modules whenever something other than a node_save causes
webmaster@1 2154 * the permissions on a node to change.
webmaster@1 2155 *
webmaster@1 2156 * This function is the only function that should write to the node_access
webmaster@1 2157 * table.
webmaster@1 2158 *
webmaster@1 2159 * @param $node
webmaster@1 2160 * The $node to acquire grants for.
webmaster@1 2161 */
webmaster@1 2162 function node_access_acquire_grants($node) {
webmaster@1 2163 $grants = module_invoke_all('node_access_records', $node);
webmaster@1 2164 if (empty($grants)) {
webmaster@1 2165 $grants[] = array('realm' => 'all', 'gid' => 0, 'grant_view' => 1, 'grant_update' => 0, 'grant_delete' => 0);
webmaster@1 2166 }
webmaster@1 2167 else {
webmaster@1 2168 // retain grants by highest priority
webmaster@1 2169 $grant_by_priority = array();
webmaster@1 2170 foreach ($grants as $g) {
webmaster@1 2171 $grant_by_priority[intval($g['priority'])][] = $g;
webmaster@1 2172 }
webmaster@1 2173 krsort($grant_by_priority);
webmaster@1 2174 $grants = array_shift($grant_by_priority);
webmaster@1 2175 }
webmaster@1 2176
webmaster@1 2177 node_access_write_grants($node, $grants);
webmaster@1 2178 }
webmaster@1 2179
webmaster@1 2180 /**
webmaster@1 2181 * This function will write a list of grants to the database, deleting
webmaster@1 2182 * any pre-existing grants. If a realm is provided, it will only
webmaster@1 2183 * delete grants from that realm, but it will always delete a grant
webmaster@1 2184 * from the 'all' realm. Modules which utilize node_access can
webmaster@1 2185 * use this function when doing mass updates due to widespread permission
webmaster@1 2186 * changes.
webmaster@1 2187 *
webmaster@1 2188 * @param $node
webmaster@1 2189 * The $node being written to. All that is necessary is that it contain a nid.
webmaster@1 2190 * @param $grants
webmaster@1 2191 * A list of grants to write. Each grant is an array that must contain the
webmaster@1 2192 * following keys: realm, gid, grant_view, grant_update, grant_delete.
webmaster@1 2193 * The realm is specified by a particular module; the gid is as well, and
webmaster@1 2194 * is a module-defined id to define grant privileges. each grant_* field
webmaster@1 2195 * is a boolean value.
webmaster@1 2196 * @param $realm
webmaster@1 2197 * If provided, only read/write grants for that realm.
webmaster@1 2198 * @param $delete
webmaster@1 2199 * If false, do not delete records. This is only for optimization purposes,
webmaster@1 2200 * and assumes the caller has already performed a mass delete of some form.
webmaster@1 2201 */
webmaster@1 2202 function node_access_write_grants($node, $grants, $realm = NULL, $delete = TRUE) {
webmaster@1 2203 if ($delete) {
webmaster@1 2204 $query = 'DELETE FROM {node_access} WHERE nid = %d';
webmaster@1 2205 if ($realm) {
webmaster@1 2206 $query .= " AND realm in ('%s', 'all')";
webmaster@1 2207 }
webmaster@1 2208 db_query($query, $node->nid, $realm);
webmaster@1 2209 }
webmaster@1 2210
webmaster@1 2211 // Only perform work when node_access modules are active.
webmaster@1 2212 if (count(module_implements('node_grants'))) {
webmaster@1 2213 foreach ($grants as $grant) {
webmaster@1 2214 if ($realm && $realm != $grant['realm']) {
webmaster@1 2215 continue;
webmaster@1 2216 }
webmaster@1 2217 // Only write grants; denies are implicit.
webmaster@1 2218 if ($grant['grant_view'] || $grant['grant_update'] || $grant['grant_delete']) {
webmaster@1 2219 db_query("INSERT INTO {node_access} (nid, realm, gid, grant_view, grant_update, grant_delete) VALUES (%d, '%s', %d, %d, %d, %d)", $node->nid, $grant['realm'], $grant['gid'], $grant['grant_view'], $grant['grant_update'], $grant['grant_delete']);
webmaster@1 2220 }
webmaster@1 2221 }
webmaster@1 2222 }
webmaster@1 2223 }
webmaster@1 2224
webmaster@1 2225 /**
webmaster@1 2226 * Flag / unflag the node access grants for rebuilding, or read the current
webmaster@1 2227 * value of the flag.
webmaster@1 2228 *
webmaster@1 2229 * When the flag is set, a message is displayed to users with 'access
webmaster@1 2230 * administration pages' permission, pointing to the 'rebuild' confirm form.
webmaster@1 2231 * This can be used as an alternative to direct node_access_rebuild calls,
webmaster@1 2232 * allowing administrators to decide when they want to perform the actual
webmaster@1 2233 * (possibly time consuming) rebuild.
webmaster@1 2234 * When unsure the current user is an adminisrator, node_access_rebuild
webmaster@1 2235 * should be used instead.
webmaster@1 2236 *
webmaster@1 2237 * @param $rebuild
webmaster@1 2238 * (Optional) The boolean value to be written.
webmaster@1 2239 * @return
webmaster@1 2240 * (If no value was provided for $rebuild) The current value of the flag.
webmaster@1 2241 */
webmaster@1 2242 function node_access_needs_rebuild($rebuild = NULL) {
webmaster@1 2243 if (!isset($rebuild)) {
webmaster@1 2244 return variable_get('node_access_needs_rebuild', FALSE);
webmaster@1 2245 }
webmaster@1 2246 elseif ($rebuild) {
webmaster@1 2247 variable_set('node_access_needs_rebuild', TRUE);
webmaster@1 2248 }
webmaster@1 2249 else {
webmaster@1 2250 variable_del('node_access_needs_rebuild');
webmaster@1 2251 }
webmaster@1 2252 }
webmaster@1 2253
webmaster@1 2254 /**
webmaster@1 2255 * Rebuild the node access database. This is occasionally needed by modules
webmaster@1 2256 * that make system-wide changes to access levels.
webmaster@1 2257 *
webmaster@1 2258 * When the rebuild is required by an admin-triggered action (e.g module
webmaster@1 2259 * settings form), calling node_access_needs_rebuild(TRUE) instead of
webmaster@1 2260 * node_access_rebuild() lets the user perform his changes and actually
webmaster@1 2261 * rebuild only once he is done.
webmaster@1 2262 *
webmaster@1 2263 * Note : As of Drupal 6, node access modules are not required to (and actually
webmaster@1 2264 * should not) call node_access_rebuild() in hook_enable/disable anymore.
webmaster@1 2265 *
webmaster@1 2266 * @see node_access_needs_rebuild()
webmaster@1 2267 *
webmaster@1 2268 * @param $batch_mode
webmaster@1 2269 * Set to TRUE to process in 'batch' mode, spawning processing over several
webmaster@1 2270 * HTTP requests (thus avoiding the risk of PHP timeout if the site has a
webmaster@1 2271 * large number of nodes).
webmaster@1 2272 * hook_update_N and any form submit handler are safe contexts to use the
webmaster@1 2273 * 'batch mode'. Less decidable cases (such as calls from hook_user,
webmaster@1 2274 * hook_taxonomy, hook_node_type...) might consider using the non-batch mode.
webmaster@1 2275 */
webmaster@1 2276 function node_access_rebuild($batch_mode = FALSE) {
webmaster@1 2277 db_query("DELETE FROM {node_access}");
webmaster@1 2278 // Only recalculate if the site is using a node_access module.
webmaster@1 2279 if (count(module_implements('node_grants'))) {
webmaster@1 2280 if ($batch_mode) {
webmaster@1 2281 $batch = array(
webmaster@1 2282 'title' => t('Rebuilding content access permissions'),
webmaster@1 2283 'operations' => array(
webmaster@1 2284 array('_node_access_rebuild_batch_operation', array()),
webmaster@1 2285 ),
webmaster@1 2286 'finished' => '_node_access_rebuild_batch_finished'
webmaster@1 2287 );
webmaster@1 2288 batch_set($batch);
webmaster@1 2289 }
webmaster@1 2290 else {
webmaster@1 2291 // If not in 'safe mode', increase the maximum execution time.
webmaster@1 2292 if (!ini_get('safe_mode')) {
webmaster@1 2293 set_time_limit(240);
webmaster@1 2294 }
webmaster@1 2295 $result = db_query("SELECT nid FROM {node}");
webmaster@1 2296 while ($node = db_fetch_object($result)) {
webmaster@1 2297 $loaded_node = node_load($node->nid, NULL, TRUE);
webmaster@1 2298 // To preserve database integrity, only aquire grants if the node
webmaster@1 2299 // loads successfully.
webmaster@1 2300 if (!empty($loaded_node)) {
webmaster@1 2301 node_access_acquire_grants($loaded_node);
webmaster@1 2302 }
webmaster@1 2303 }
webmaster@1 2304 }
webmaster@1 2305 }
webmaster@1 2306 else {
webmaster@1 2307 // Not using any node_access modules. Add the default grant.
webmaster@1 2308 db_query("INSERT INTO {node_access} VALUES (0, 0, 'all', 1, 0, 0)");
webmaster@1 2309 }
webmaster@1 2310
webmaster@1 2311 if (!isset($batch)) {
webmaster@1 2312 drupal_set_message(t('Content permissions have been rebuilt.'));
webmaster@1 2313 node_access_needs_rebuild(FALSE);
webmaster@1 2314 cache_clear_all();
webmaster@1 2315 }
webmaster@1 2316 }
webmaster@1 2317
webmaster@1 2318 /**
webmaster@1 2319 * Batch operation for node_access_rebuild_batch.
webmaster@1 2320 *
webmaster@1 2321 * This is a mutlistep operation : we go through all nodes by packs of 20.
webmaster@1 2322 * The batch processing engine interrupts processing and sends progress
webmaster@1 2323 * feedback after 1 second execution time.
webmaster@1 2324 */
webmaster@1 2325 function _node_access_rebuild_batch_operation(&$context) {
webmaster@1 2326 if (empty($context['sandbox'])) {
webmaster@1 2327 // Initiate multistep processing.
webmaster@1 2328 $context['sandbox']['progress'] = 0;
webmaster@1 2329 $context['sandbox']['current_node'] = 0;
webmaster@1 2330 $context['sandbox']['max'] = db_result(db_query('SELECT COUNT(DISTINCT nid) FROM {node}'));
webmaster@1 2331 }
webmaster@1 2332
webmaster@1 2333 // Process the next 20 nodes.
webmaster@1 2334 $limit = 20;
webmaster@1 2335 $result = db_query_range("SELECT nid FROM {node} WHERE nid > %d ORDER BY nid ASC", $context['sandbox']['current_node'], 0, $limit);
webmaster@1 2336 while ($row = db_fetch_array($result)) {
webmaster@1 2337 $loaded_node = node_load($row['nid'], NULL, TRUE);
webmaster@1 2338 // To preserve database integrity, only aquire grants if the node
webmaster@1 2339 // loads successfully.
webmaster@1 2340 if (!empty($loaded_node)) {
webmaster@1 2341 node_access_acquire_grants($loaded_node);
webmaster@1 2342 }
webmaster@1 2343 $context['sandbox']['progress']++;
webmaster@1 2344 $context['sandbox']['current_node'] = $loaded_node->nid;
webmaster@1 2345 }
webmaster@1 2346
webmaster@1 2347 // Multistep processing : report progress.
webmaster@1 2348 if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
webmaster@1 2349 $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
webmaster@1 2350 }
webmaster@1 2351 }
webmaster@1 2352
webmaster@1 2353 /**
webmaster@1 2354 * Post-processing for node_access_rebuild_batch.
webmaster@1 2355 */
webmaster@1 2356 function _node_access_rebuild_batch_finished($success, $results, $operations) {
webmaster@1 2357 if ($success) {
webmaster@1 2358 drupal_set_message(t('The content access permissions have been rebuilt.'));
webmaster@1 2359 node_access_needs_rebuild(FALSE);
webmaster@1 2360 }
webmaster@1 2361 else {
webmaster@1 2362 drupal_set_message(t('The content access permissions have not been properly rebuilt.'), 'error');
webmaster@1 2363 }
webmaster@1 2364 cache_clear_all();
webmaster@1 2365 }
webmaster@1 2366
webmaster@1 2367 /**
webmaster@1 2368 * @} End of "defgroup node_access".
webmaster@1 2369 */
webmaster@1 2370
webmaster@1 2371
webmaster@1 2372 /**
webmaster@1 2373 * @defgroup node_content Hook implementations for user-created content types.
webmaster@1 2374 * @{
webmaster@1 2375 */
webmaster@1 2376
webmaster@1 2377 /**
webmaster@1 2378 * Implementation of hook_access().
webmaster@1 2379 *
webmaster@1 2380 * Named so as not to conflict with node_access()
webmaster@1 2381 */
webmaster@1 2382 function node_content_access($op, $node, $account) {
webmaster@1 2383 $type = is_string($node) ? $node : (is_array($node) ? $node['type'] : $node->type);
webmaster@1 2384
webmaster@1 2385 if ($op == 'create') {
webmaster@1 2386 return user_access('create '. $type .' content', $account);
webmaster@1 2387 }
webmaster@1 2388
webmaster@1 2389 if ($op == 'update') {
webmaster@1 2390 if (user_access('edit any '. $type .' content', $account) || (user_access('edit own '. $type .' content', $account) && ($account->uid == $node->uid))) {
webmaster@1 2391 return TRUE;
webmaster@1 2392 }
webmaster@1 2393 }
webmaster@1 2394
webmaster@1 2395 if ($op == 'delete') {
webmaster@1 2396 if (user_access('delete any '. $type .' content', $account) || (user_access('delete own '. $type .' content', $account) && ($account->uid == $node->uid))) {
webmaster@1 2397 return TRUE;
webmaster@1 2398 }
webmaster@1 2399 }
webmaster@1 2400 }
webmaster@1 2401
webmaster@1 2402 /**
webmaster@1 2403 * Implementation of hook_form().
webmaster@1 2404 */
webmaster@1 2405 function node_content_form($node, $form_state) {
webmaster@1 2406 $type = node_get_types('type', $node);
webmaster@1 2407 $form = array();
webmaster@1 2408
webmaster@1 2409 if ($type->has_title) {
webmaster@1 2410 $form['title'] = array(
webmaster@1 2411 '#type' => 'textfield',
webmaster@1 2412 '#title' => check_plain($type->title_label),
webmaster@1 2413 '#required' => TRUE,
webmaster@1 2414 '#default_value' => $node->title,
webmaster@1 2415 '#maxlength' => 255,
webmaster@1 2416 '#weight' => -5,
webmaster@1 2417 );
webmaster@1 2418 }
webmaster@1 2419
webmaster@1 2420 if ($type->has_body) {
webmaster@1 2421 $form['body_field'] = node_body_field($node, $type->body_label, $type->min_word_count);
webmaster@1 2422 }
webmaster@1 2423
webmaster@1 2424 return $form;
webmaster@1 2425 }
webmaster@1 2426
webmaster@1 2427 /**
webmaster@1 2428 * @} End of "defgroup node_content".
webmaster@1 2429 */
webmaster@1 2430
webmaster@1 2431 /**
webmaster@1 2432 * Implementation of hook_forms(). All node forms share the same form handler
webmaster@1 2433 */
webmaster@1 2434 function node_forms() {
webmaster@1 2435 $forms = array();
webmaster@1 2436 if ($types = node_get_types()) {
webmaster@1 2437 foreach (array_keys($types) as $type) {
webmaster@1 2438 $forms[$type .'_node_form']['callback'] = 'node_form';
webmaster@1 2439 }
webmaster@1 2440 }
webmaster@1 2441 return $forms;
webmaster@1 2442 }
webmaster@1 2443
webmaster@1 2444 /**
webmaster@1 2445 * Format the "Submitted by username on date/time" for each node
webmaster@1 2446 *
webmaster@1 2447 * @ingroup themeable
webmaster@1 2448 */
webmaster@1 2449 function theme_node_submitted($node) {
webmaster@1 2450 return t('Submitted by !username on @datetime',
webmaster@1 2451 array(
webmaster@1 2452 '!username' => theme('username', $node),
webmaster@1 2453 '@datetime' => format_date($node->created),
webmaster@1 2454 ));
webmaster@1 2455 }
webmaster@1 2456
webmaster@1 2457 /**
webmaster@1 2458 * Implementation of hook_hook_info().
webmaster@1 2459 */
webmaster@1 2460 function node_hook_info() {
webmaster@1 2461 return array(
webmaster@1 2462 'node' => array(
webmaster@1 2463 'nodeapi' => array(
webmaster@1 2464 'presave' => array(
webmaster@1 2465 'runs when' => t('When either saving a new post or updating an existing post'),
webmaster@1 2466 ),
webmaster@1 2467 'insert' => array(
webmaster@1 2468 'runs when' => t('After saving a new post'),
webmaster@1 2469 ),
webmaster@1 2470 'update' => array(
webmaster@1 2471 'runs when' => t('After saving an updated post'),
webmaster@1 2472 ),
webmaster@1 2473 'delete' => array(
webmaster@1 2474 'runs when' => t('After deleting a post')
webmaster@1 2475 ),
webmaster@1 2476 'view' => array(
webmaster@1 2477 'runs when' => t('When content is viewed by an authenticated user')
webmaster@1 2478 ),
webmaster@1 2479 ),
webmaster@1 2480 ),
webmaster@1 2481 );
webmaster@1 2482 }
webmaster@1 2483
webmaster@1 2484 /**
webmaster@1 2485 * Implementation of hook_action_info().
webmaster@1 2486 */
webmaster@1 2487 function node_action_info() {
webmaster@1 2488 return array(
webmaster@1 2489 'node_publish_action' => array(
webmaster@1 2490 'type' => 'node',
webmaster@1 2491 'description' => t('Publish post'),
webmaster@1 2492 'configurable' => FALSE,
webmaster@1 2493 'behavior' => array('changes_node_property'),
webmaster@1 2494 'hooks' => array(
webmaster@1 2495 'nodeapi' => array('presave'),
webmaster@1 2496 'comment' => array('insert', 'update'),
webmaster@1 2497 ),
webmaster@1 2498 ),
webmaster@1 2499 'node_unpublish_action' => array(
webmaster@1 2500 'type' => 'node',
webmaster@1 2501 'description' => t('Unpublish post'),
webmaster@1 2502 'configurable' => FALSE,
webmaster@1 2503 'behavior' => array('changes_node_property'),
webmaster@1 2504 'hooks' => array(
webmaster@1 2505 'nodeapi' => array('presave'),
webmaster@1 2506 'comment' => array('delete', 'insert', 'update'),
webmaster@1 2507 ),
webmaster@1 2508 ),
webmaster@1 2509 'node_make_sticky_action' => array(
webmaster@1 2510 'type' => 'node',
webmaster@1 2511 'description' => t('Make post sticky'),
webmaster@1 2512 'configurable' => FALSE,
webmaster@1 2513 'behavior' => array('changes_node_property'),
webmaster@1 2514 'hooks' => array(
webmaster@1 2515 'nodeapi' => array('presave'),
webmaster@1 2516 'comment' => array('insert', 'update'),
webmaster@1 2517 ),
webmaster@1 2518 ),
webmaster@1 2519 'node_make_unsticky_action' => array(
webmaster@1 2520 'type' => 'node',
webmaster@1 2521 'description' => t('Make post unsticky'),
webmaster@1 2522 'configurable' => FALSE,
webmaster@1 2523 'behavior' => array('changes_node_property'),
webmaster@1 2524 'hooks' => array(
webmaster@1 2525 'nodeapi' => array('presave'),
webmaster@1 2526 'comment' => array('delete', 'insert', 'update'),
webmaster@1 2527 ),
webmaster@1 2528 ),
webmaster@1 2529 'node_promote_action' => array(
webmaster@1 2530 'type' => 'node',
webmaster@1 2531 'description' => t('Promote post to front page'),
webmaster@1 2532 'configurable' => FALSE,
webmaster@1 2533 'behavior' => array('changes_node_property'),
webmaster@1 2534 'hooks' => array(
webmaster@1 2535 'nodeapi' => array('presave'),
webmaster@1 2536 'comment' => array('insert', 'update'),
webmaster@1 2537 ),
webmaster@1 2538 ),
webmaster@1 2539 'node_unpromote_action' => array(
webmaster@1 2540 'type' => 'node',
webmaster@1 2541 'description' => t('Remove post from front page'),
webmaster@1 2542 'configurable' => FALSE,
webmaster@1 2543 'behavior' => array('changes_node_property'),
webmaster@1 2544 'hooks' => array(
webmaster@1 2545 'nodeapi' => array('presave'),
webmaster@1 2546 'comment' => array('delete', 'insert', 'update'),
webmaster@1 2547 ),
webmaster@1 2548 ),
webmaster@1 2549 'node_assign_owner_action' => array(
webmaster@1 2550 'type' => 'node',
webmaster@1 2551 'description' => t('Change the author of a post'),
webmaster@1 2552 'configurable' => TRUE,
webmaster@1 2553 'behavior' => array('changes_node_property'),
webmaster@1 2554 'hooks' => array(
webmaster@1 2555 'any' => TRUE,
webmaster@1 2556 'nodeapi' => array('presave'),
webmaster@1 2557 'comment' => array('delete', 'insert', 'update'),
webmaster@1 2558 ),
webmaster@1 2559 ),
webmaster@1 2560 'node_save_action' => array(
webmaster@1 2561 'type' => 'node',
webmaster@1 2562 'description' => t('Save post'),
webmaster@1 2563 'configurable' => FALSE,
webmaster@1 2564 'hooks' => array(
webmaster@1 2565 'comment' => array('delete', 'insert', 'update'),
webmaster@1 2566 ),
webmaster@1 2567 ),
webmaster@1 2568 'node_unpublish_by_keyword_action' => array(
webmaster@1 2569 'type' => 'node',
webmaster@1 2570 'description' => t('Unpublish post containing keyword(s)'),
webmaster@1 2571 'configurable' => TRUE,
webmaster@1 2572 'hooks' => array(
webmaster@1 2573 'nodeapi' => array('presave', 'insert', 'update'),
webmaster@1 2574 ),
webmaster@1 2575 ),
webmaster@1 2576 );
webmaster@1 2577 }
webmaster@1 2578
webmaster@1 2579 /**
webmaster@1 2580 * Implementation of a Drupal action.
webmaster@1 2581 * Sets the status of a node to 1, meaning published.
webmaster@1 2582 */
webmaster@1 2583 function node_publish_action(&$node, $context = array()) {
webmaster@1 2584 $node->status = 1;
webmaster@1 2585 watchdog('action', 'Set @type %title to published.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2586 }
webmaster@1 2587
webmaster@1 2588 /**
webmaster@1 2589 * Implementation of a Drupal action.
webmaster@1 2590 * Sets the status of a node to 0, meaning unpublished.
webmaster@1 2591 */
webmaster@1 2592 function node_unpublish_action(&$node, $context = array()) {
webmaster@1 2593 $node->status = 0;
webmaster@1 2594 watchdog('action', 'Set @type %title to unpublished.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2595 }
webmaster@1 2596
webmaster@1 2597 /**
webmaster@1 2598 * Implementation of a Drupal action.
webmaster@1 2599 * Sets the sticky-at-top-of-list property of a node to 1.
webmaster@1 2600 */
webmaster@1 2601 function node_make_sticky_action(&$node, $context = array()) {
webmaster@1 2602 $node->sticky = 1;
webmaster@1 2603 watchdog('action', 'Set @type %title to sticky.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2604 }
webmaster@1 2605
webmaster@1 2606 /**
webmaster@1 2607 * Implementation of a Drupal action.
webmaster@1 2608 * Sets the sticky-at-top-of-list property of a node to 0.
webmaster@1 2609 */
webmaster@1 2610 function node_make_unsticky_action(&$node, $context = array()) {
webmaster@1 2611 $node->sticky = 0;
webmaster@1 2612 watchdog('action', 'Set @type %title to unsticky.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2613 }
webmaster@1 2614
webmaster@1 2615 /**
webmaster@1 2616 * Implementation of a Drupal action.
webmaster@1 2617 * Sets the promote property of a node to 1.
webmaster@1 2618 */
webmaster@1 2619 function node_promote_action(&$node, $context = array()) {
webmaster@1 2620 $node->promote = 1;
webmaster@1 2621 watchdog('action', 'Promoted @type %title to front page.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2622 }
webmaster@1 2623
webmaster@1 2624 /**
webmaster@1 2625 * Implementation of a Drupal action.
webmaster@1 2626 * Sets the promote property of a node to 0.
webmaster@1 2627 */
webmaster@1 2628 function node_unpromote_action(&$node, $context = array()) {
webmaster@1 2629 $node->promote = 0;
webmaster@1 2630 watchdog('action', 'Removed @type %title from front page.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2631 }
webmaster@1 2632
webmaster@1 2633 /**
webmaster@1 2634 * Implementation of a Drupal action.
webmaster@1 2635 * Saves a node.
webmaster@1 2636 */
webmaster@1 2637 function node_save_action($node) {
webmaster@1 2638 node_save($node);
webmaster@1 2639 watchdog('action', 'Saved @type %title', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2640 }
webmaster@1 2641
webmaster@1 2642 /**
webmaster@1 2643 * Implementation of a configurable Drupal action.
webmaster@1 2644 * Assigns ownership of a node to a user.
webmaster@1 2645 */
webmaster@1 2646 function node_assign_owner_action(&$node, $context) {
webmaster@1 2647 $node->uid = $context['owner_uid'];
webmaster@1 2648 $owner_name = db_result(db_query("SELECT name FROM {users} WHERE uid = %d", $context['owner_uid']));
webmaster@1 2649 watchdog('action', 'Changed owner of @type %title to uid %name.', array('@type' => node_get_types('type', $node), '%title' => $node->title, '%name' => $owner_name));
webmaster@1 2650 }
webmaster@1 2651
webmaster@1 2652 function node_assign_owner_action_form($context) {
webmaster@1 2653 $description = t('The username of the user to which you would like to assign ownership.');
webmaster@1 2654 $count = db_result(db_query("SELECT COUNT(*) FROM {users}"));
webmaster@1 2655 $owner_name = '';
webmaster@1 2656 if (isset($context['owner_uid'])) {
webmaster@1 2657 $owner_name = db_result(db_query("SELECT name FROM {users} WHERE uid = %d", $context['owner_uid']));
webmaster@1 2658 }
webmaster@1 2659
webmaster@1 2660 // Use dropdown for fewer than 200 users; textbox for more than that.
webmaster@1 2661 if (intval($count) < 200) {
webmaster@1 2662 $options = array();
webmaster@1 2663 $result = db_query("SELECT uid, name FROM {users} WHERE uid > 0 ORDER BY name");
webmaster@1 2664 while ($data = db_fetch_object($result)) {
webmaster@1 2665 $options[$data->name] = $data->name;
webmaster@1 2666 }
webmaster@1 2667 $form['owner_name'] = array(
webmaster@1 2668 '#type' => 'select',
webmaster@1 2669 '#title' => t('Username'),
webmaster@1 2670 '#default_value' => $owner_name,
webmaster@1 2671 '#options' => $options,
webmaster@1 2672 '#description' => $description,
webmaster@1 2673 );
webmaster@1 2674 }
webmaster@1 2675 else {
webmaster@1 2676 $form['owner_name'] = array(
webmaster@1 2677 '#type' => 'textfield',
webmaster@1 2678 '#title' => t('Username'),
webmaster@1 2679 '#default_value' => $owner_name,
webmaster@1 2680 '#autocomplete_path' => 'user/autocomplete',
webmaster@1 2681 '#size' => '6',
webmaster@1 2682 '#maxlength' => '7',
webmaster@1 2683 '#description' => $description,
webmaster@1 2684 );
webmaster@1 2685 }
webmaster@1 2686 return $form;
webmaster@1 2687 }
webmaster@1 2688
webmaster@1 2689 function node_assign_owner_action_validate($form, $form_state) {
webmaster@1 2690 $count = db_result(db_query("SELECT COUNT(*) FROM {users} WHERE name = '%s'", $form_state['values']['owner_name']));
webmaster@1 2691 if (intval($count) != 1) {
webmaster@1 2692 form_set_error('owner_name', t('Please enter a valid username.'));
webmaster@1 2693 }
webmaster@1 2694 }
webmaster@1 2695
webmaster@1 2696 function node_assign_owner_action_submit($form, $form_state) {
webmaster@1 2697 // Username can change, so we need to store the ID, not the username.
webmaster@1 2698 $uid = db_result(db_query("SELECT uid from {users} WHERE name = '%s'", $form_state['values']['owner_name']));
webmaster@1 2699 return array('owner_uid' => $uid);
webmaster@1 2700 }
webmaster@1 2701
webmaster@1 2702 function node_unpublish_by_keyword_action_form($context) {
webmaster@1 2703 $form['keywords'] = array(
webmaster@1 2704 '#title' => t('Keywords'),
webmaster@1 2705 '#type' => 'textarea',
webmaster@1 2706 '#description' => t('The post will be unpublished if it contains any of the character sequences above. Use a comma-separated list of character sequences. Example: funny, bungee jumping, "Company, Inc.". Character sequences are case-sensitive.'),
webmaster@1 2707 '#default_value' => isset($context['keywords']) ? drupal_implode_tags($context['keywords']) : '',
webmaster@1 2708 );
webmaster@1 2709 return $form;
webmaster@1 2710 }
webmaster@1 2711
webmaster@1 2712 function node_unpublish_by_keyword_action_submit($form, $form_state) {
webmaster@1 2713 return array('keywords' => drupal_explode_tags($form_state['values']['keywords']));
webmaster@1 2714 }
webmaster@1 2715
webmaster@1 2716 /**
webmaster@1 2717 * Implementation of a configurable Drupal action.
webmaster@1 2718 * Unpublish a node if it contains a certain string.
webmaster@1 2719 *
webmaster@1 2720 * @param $context
webmaster@1 2721 * An array providing more information about the context of the call to this action.
webmaster@1 2722 * @param $comment
webmaster@1 2723 * A node object.
webmaster@1 2724 */
webmaster@1 2725 function node_unpublish_by_keyword_action($node, $context) {
webmaster@1 2726 foreach ($context['keywords'] as $keyword) {
webmaster@1 2727 if (strstr(node_view(drupal_clone($node)), $keyword) || strstr($node->title, $keyword)) {
webmaster@1 2728 $node->status = 0;
webmaster@1 2729 watchdog('action', 'Set @type %title to unpublished.', array('@type' => node_get_types('name', $node), '%title' => $node->title));
webmaster@1 2730 break;
webmaster@1 2731 }
webmaster@1 2732 }
webmaster@1 2733 }