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

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6 7
 * The core that allows content to be submitted to the site. Modules and
 * scripts may programmatically submit nodes using the usual form API pattern.
Dries's avatar
 
Dries committed
8 9
 */

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/**
 * Node is not published.
 */
define('NODE_NOT_PUBLISHED', 0);

/**
 * Node is published.
 */
define('NODE_PUBLISHED', 1);

/**
 * Node is not promoted to front page.
 */
define('NODE_NOT_PROMOTED', 0);

/**
 * Node is promoted to front page.
 */
define('NODE_PROMOTED', 1);

/**
 * Node is not sticky at top of the page.
 */
define('NODE_NOT_STICKY', 0);

/**
 * Node is sticky at top of the page.
 */
define('NODE_STICKY', 1);

40 41 42 43 44 45
/**
 * Nodes changed before this time are always marked as read.
 *
 * Nodes changed after this time may be marked new, updated, or read, depending
 * on their state for the current user. Defaults to 30 days ago.
 */
46
define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
47

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/**
 * Modules should return this value from hook_node_access() to allow access to a node.
 */
define('NODE_ACCESS_ALLOW', 'allow');

/**
 * Modules should return this value from hook_node_access() to deny access to a node.
 */
define('NODE_ACCESS_DENY', 'deny');

/**
 * Modules should return this value from hook_node_access() to not affect node access.
 */
define('NODE_ACCESS_IGNORE', NULL);

Dries's avatar
 
Dries committed
63
/**
64
 * Implements hook_help().
Dries's avatar
 
Dries committed
65
 */
66
function node_help($path, $arg) {
67 68 69
  // Remind site administrators about the {node_access} table being flagged
  // for rebuild. We don't need to issue the message on the confirm form, or
  // while the rebuild is being processed.
70
  if ($path != 'admin/reports/status/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
71
      && user_access('access administration pages') && node_access_needs_rebuild()) {
72
    if ($path == 'admin/reports/status') {
73 74 75
      $message = t('The content access permissions need to be rebuilt.');
    }
    else {
76
      $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/reports/status/rebuild')));
77 78 79 80
    }
    drupal_set_message($message, 'error');
  }

81
  switch ($path) {
Dries's avatar
 
Dries committed
82
    case 'admin/help#node':
83 84
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
85
      $output .= '<p>' . t('The Node module manages the creation, editing, deletion, settings, and display of the main site content. Content items managed by the Node module are typically displayed as pages on your site, and include a title, some meta-data (author, creation time, content type, etc.), and optional fields containing text or other data (fields are managed by the <a href="@field">Field module</a>). For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node', '@field' => url('admin/help/field'))) . '</p>';
86 87
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
88 89 90
      $output .= '<dt>' . t('Creating content') . '</dt>';
      $output .= '<dd>' . t('When new content is created, the Node module records basic information about the content, including the author, date of creation, and the <a href="@content-type">Content type</a>. It also manages the <em>publishing options</em>, which define whether or not the content is published, promoted to the front page of the site, and/or sticky at the top of content lists. Default settings can be configured for each <a href="@content-type">type of content</a> on your site.', array('@content-type' => url('admin/structure/types'))) . '</dd>';
      $output .= '<dt>' . t('Creating custom content types') . '</dt>';
91
      $output .= '<dd>' . t('The Node module gives users with the <em>Administer content types</em> permission the ability to <a href="@content-new">create new content types</a> in addition to the default ones already configured. Creating custom content types allows you the flexibility to add <a href="@field">fields</a> and configure default settings that suit the differing needs of various site content.', array('@content-new' => url('admin/structure/types/add'), '@field' => url('admin/help/field'))) . '</dd>';
92
      $output .= '<dt>' . t('Administering content') . '</dt>';
93 94 95
      $output .= '<dd>' . t('The <a href="@content">Content administration page</a> allows you to review and bulk manage your site content.', array('@content' => url('admin/content'))) . '</dd>';
      $output .= '<dt>' . t('Creating revisions') . '</dt>';
      $output .= '<dd>' . t('The Node module also enables you to create multiple versions of any content, and revert to older versions using the <em>Revision information</em> settings.') . '</dd>';
96
      $output .= '<dt>' . t('User permissions') . '</dt>';
97
      $output .= '<dd>' . t('The Node module makes a number of permissions available for each content type, which can be set by role on the <a href="@permissions">permissions page</a>.', array('@permissions' => url('admin/config/people/permissions', array('fragment' => 'module-node')))) . '</dd>';
98
      $output .= '</dl>';
99
      return $output;
100

101
    case 'admin/content':
102 103
      // Return a non-null value so that the 'more help' link is shown.
      return ' ';
104

105
    case 'admin/structure/types/add':
106
      return '<p>' . t('Individual content types can have different fields, behaviors, and permissions assigned to them.') . '</p>';
107

108
    case 'admin/structure/types/manage/' . $arg[3] . '/fields':
109
      return '<p>' . t('This form allows you to add, edit, and arrange fields within the %type content type.', array('%type' => node_type_get_name($arg[3]))) . '</p>';
110

111
    case 'admin/structure/types/manage/' . $arg[3] . '/display':
112 113
      return '<p>' . t('This form allows you to configure how fields should be displayed when %type content is rendered in the following contexts.', array('%type' => node_type_get_name($arg[3]))) . '</p>';

114
    case 'admin/structure/types/manage/' . $arg[3] . '/display/' . $arg[5]:
115
      return '<p>' . t('This form allows you to configure how fields should be displayed when %type content is rendered in the following contexts.', array('%type' => node_type_get_name($arg[3]))) . '</p>';
116

117
    case 'node/%/revisions':
118
      return '<p>' . t('Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.') . '</p>';
119

120 121
    case 'node/%/edit':
      $node = node_load($arg[1]);
122
      $type = node_type_get_type($node);
123
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
124
  }
Dries's avatar
 
Dries committed
125

126
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
127
    $type = node_type_get_type(str_replace('-', '_', $arg[2]));
128
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
129
  }
Dries's avatar
 
Dries committed
130 131
}

132
/**
133
 * Implements hook_theme().
134 135 136
 */
function node_theme() {
  return array(
137
    'node' => array(
138
      'render element' => 'elements',
139
      'template' => 'node',
140
    ),
141
    'node_list' => array(
142
      'variables' => array('items' => NULL, 'title' => NULL),
143 144
    ),
    'node_search_admin' => array(
145
      'render element' => 'form',
146 147
    ),
    'node_filters' => array(
148
      'render element' => 'form',
149
      'file' => 'node.admin.inc',
150
    ),
151
    'node_add_list' => array(
152
      'variables' => array('content' => NULL),
153
      'file' => 'node.pages.inc',
154 155
    ),
    'node_form' => array(
156
      'render element' => 'form',
157
      'file' => 'node.pages.inc',
158 159
    ),
    'node_preview' => array(
160
      'variables' => array('node' => NULL),
161
      'file' => 'node.pages.inc',
162 163
    ),
    'node_log_message' => array(
164
      'variables' => array('log' => NULL),
165
    ),
166
    'node_admin_overview' => array(
167
      'variables' => array('name' => NULL, 'type' => NULL),
168
    ),
169 170 171
  );
}

Dries's avatar
 
Dries committed
172
/**
173
 * Implements hook_cron().
Dries's avatar
 
Dries committed
174
 */
175
function node_cron() {
176 177 178
  db_delete('history')
    ->condition('timestamp', NODE_NEW_LIMIT, '<')
    ->execute();
179 180
}

Dries's avatar
 
Dries committed
181
/**
182
 * Implements hook_entity_info().
Dries's avatar
 
Dries committed
183
 */
184
function node_entity_info() {
Dries's avatar
 
Dries committed
185 186
  $return = array(
    'node' => array(
187
      'label' => t('Node'),
188 189 190 191
      'controller class' => 'NodeController',
      'base table' => 'node',
      'revision table' => 'node_revision',
      'fieldable' => TRUE,
192 193 194 195 196
      'object keys' => array(
        'id' => 'nid',
        'revision' => 'vid',
        'bundle' => 'type',
      ),
197 198 199
      'bundle keys' => array(
        'bundle' => 'type',
      ),
Dries's avatar
 
Dries committed
200 201
      // Node.module handles its own caching.
      // 'cacheable' => FALSE,
202
      'bundles' => array(),
203 204 205 206 207 208 209 210 211 212 213
      'view modes' => array(
        'full' => array(
          'label' => t('Full node'),
        ),
        'teaser' => array(
          'label' => t('Teaser'),
        ),
        'rss' => array(
          'label' => t('RSS'),
        ),
      ),
Dries's avatar
 
Dries committed
214 215
    ),
  );
216 217 218 219 220 221

  // Search integration is provided by node.module, so search-related
  // view modes for nodes are defined here and not in search.module.
  if (module_exists('search')) {
    $return['node']['view modes'] += array(
      'search_index' => array(
222
        'label' => t('Search index'),
223 224
      ),
      'search_result' => array(
225
        'label' => t('Search result'),
226 227 228 229
      ),
    );
  }

230 231 232 233 234 235
  // Bundles must provide a human readable name so we can create help and error
  // messages, and the path to attach Field admin pages to.
  foreach (node_type_get_names() as $type => $name) {
    $return['node']['bundles'][$type] = array(
      'label' => $name,
      'admin' => array(
236 237 238
        'path' => 'admin/structure/types/manage/%node_type',
        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
        'bundle argument' => 4,
239 240 241 242
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
243

244
  return $return;
Dries's avatar
 
Dries committed
245 246
}

247
/**
248
 * Implements hook_admin_paths().
249 250 251 252 253
 */
function node_admin_paths() {
  $paths = array(
    'node/*/edit' => TRUE,
    'node/*/delete' => TRUE,
254 255 256
    'node/*/revisions' => TRUE,
    'node/*/revisions/*/revert' => TRUE,
    'node/*/revisions/*/delete' => TRUE,
257 258 259 260 261 262
    'node/add' => TRUE,
    'node/add/*' => TRUE,
  );
  return $paths;
}

Dries's avatar
 
Dries committed
263 264 265 266
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
267
 *   A DB result object from a query to fetch node entities. If your query
268 269 270
 *   joins the <code>node_comment_statistics</code> table so that the
 *   <code>comment_count</code> field is available, a title attribute will
 *   be added to show the number of comments.
Dries's avatar
 
Dries committed
271 272 273 274
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
275 276
 *   An HTML list suitable as content for a block, or FALSE if no result can
 *   fetch from DB result object.
Dries's avatar
 
Dries committed
277
 */
Dries's avatar
 
Dries committed
278
function node_title_list($result, $title = NULL) {
279
  $items = array();
280
  $num_rows = FALSE;
281
  foreach ($result as $node) {
282
    $items[] = l($node->title, 'node/' . $node->nid, !empty($node->comment_count) ? array('attributes' => array('title' => format_plural($node->comment_count, '1 comment', '@count comments'))) : array());
283
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
284 285
  }

286
  return $num_rows ? theme('node_list', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
287 288
}

Dries's avatar
 
Dries committed
289 290
/**
 * Format a listing of links to nodes.
291 292
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
293
 */
294 295
function theme_node_list($variables) {
  return theme('item_list', $variables);
Dries's avatar
 
Dries committed
296 297
}

Dries's avatar
 
Dries committed
298 299 300
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
301 302 303 304
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
305 306 307 308 309 310 311
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
312 313 314
  }
}

Dries's avatar
 
Dries committed
315 316 317 318
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
319 320
function node_last_viewed($nid) {
  global $user;
321
  $history = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
322

Dries's avatar
 
Dries committed
323
  if (!isset($history[$nid])) {
324
    $history[$nid] = db_query("SELECT timestamp FROM {history} WHERE uid = :uid AND nid = :nid", array(':uid' => $user->uid, ':nid' => $nid))->fetchObject();
Dries's avatar
 
Dries committed
325 326
  }

327
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
328 329 330
}

/**
331
 * Decide on the type of marker to be displayed for a given node.
Dries's avatar
 
Dries committed
332
 *
Dries's avatar
 
Dries committed
333 334 335 336
 * @param $nid
 *   Node ID whose history supplies the "last viewed" timestamp.
 * @param $timestamp
 *   Time which is compared against node's "last viewed" timestamp.
337 338
 * @return
 *   One of the MARK constants.
Dries's avatar
 
Dries committed
339
 */
340
function node_mark($nid, $timestamp) {
Dries's avatar
 
Dries committed
341
  global $user;
342
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
343

344 345 346
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
347
  if (!isset($cache[$nid])) {
348
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
349
  }
350 351 352 353 354 355 356
  if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
    return MARK_NEW;
  }
  elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
    return MARK_UPDATED;
  }
  return MARK_READ;
Dries's avatar
 
Dries committed
357 358
}

359
/**
360
 * Extract the type name.
361 362
 *
 * @param $node
363
 *   Either a string or object, containing the node type information.
364 365
 *
 * @return
366
 *   Node type of the passed in data.
367
 */
368 369 370
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
371

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
/**
 * Returns a list of all the available node types.
 *
 * @return
 *   An array of node types, keyed by the type.
 * @see node_type_get_type()
 */
function node_type_get_types() {
  return _node_types_build()->types;
}

/**
 * Returns the node type of the passed node or node type string.
 *
 *@param $node
 *   A node object or string that indicates the node type to return.
 * @return
 *   A single node type, as an object or FALSE if the node type is not found.
 *   The node type is an array with following content:
 *
 *   @code
 *   array(
 *     'type' => 'Machine readable type name',
 *     'name' => 'Name of the node type',
 *     'base' => 'Indicates to which module this node type belongs',
 *     'description' => 'Description of the node type',
 *     // ...
 *   )
 *   @endcode
 */
function node_type_get_type($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->types;
  return isset($types[$type]) ? $types[$type] : FALSE;
}

/**
 * Returns the node type base of the passed node or node type string.
 *
 * The base indicates which module implement this node type and is used to
 * execute node type specific hooks.
 *
 * @see node_invoke()
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
 * @return
 *   The node type base or FALSE if the node type is not found.
 */
function node_type_get_base($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->types;
  return isset($types[$type]) && isset($types[$type]->base) ? $types[$type]->base : FALSE;
}

/**
 * Returns a list of available node names.
 *
 * @return
 *   An array of node type names, keyed by the type.
 */
function node_type_get_names() {
  return _node_types_build()->names;
}

/**
 * Returns the node type name of the passed node or node type string.
 *
 * @param $node
 *   A node object or string that indicates the node type to return.
 *
 * @return
 *   The node type name or FALSE if the node type is not found.
 */
function node_type_get_name($node) {
  $type = _node_extract_type($node);
  $types = _node_types_build()->names;
  return isset($types[$type]) ? $types[$type] : FALSE;
450 451 452
}

/**
453 454 455
 * Resets the database cache of node types.
 *
 * All new or non-modified module-defined node types are saved to the database.
456 457
 */
function node_types_rebuild() {
458
  // Reset and load updated node types.
459
  drupal_static_reset('_node_types_build');
460
  foreach (node_type_get_types() as $type => $info) {
461 462 463
    if (!empty($info->is_new)) {
      node_type_save($info);
    }
464 465 466
    if (!empty($info->disabled)) {
      node_type_delete($info->type);
    }
467 468 469
  }
}

470 471 472 473 474 475 476 477 478 479 480 481 482 483
/**
 * Menu argument loader; Load a node type by string.
 *
 * @param $name
 *   The machine-readable name of a node type to load; having '_' replaced with
 *   '-'.
 *
 * @return
 *   A node type object or FALSE if $name does not exist.
 */
function node_type_load($name) {
  return node_type_get_type(strtr($name, array('-' => '_')));
}

484
/**
485 486 487 488
 * Saves a node type to the database.
 *
 * @param $info
 *   The node type to save, as an object.
Dries's avatar
 
Dries committed
489 490
 *
 * @return
491
 *   Status flag indicating outcome of the operation.
Dries's avatar
 
Dries committed
492
 */
493 494 495
function node_type_save($info) {
  $is_existing = FALSE;
  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
496
  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
  $type = node_type_set_defaults($info);

  $fields = array(
    'type' => (string) $type->type,
    'name' => (string) $type->name,
    'base' => (string) $type->base,
    'has_title' => (int) $type->has_title,
    'title_label' => (string) $type->title_label,
    'has_body' => (int) $type->has_body,
    'body_label' => (string) $type->body_label,
    'description' => (string) $type->description,
    'help' => (string) $type->help,
    'custom' => (int) $type->custom,
    'modified' => (int) $type->modified,
    'locked' => (int) $type->locked,
  );
513 514

  if ($is_existing) {
515 516 517 518
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
519

Dries's avatar
 
Dries committed
520
    if (!empty($type->old_type) && $type->old_type != $type->type) {
521
      field_attach_rename_bundle('node', $type->old_type, $type->type);
Dries's avatar
 
Dries committed
522
    }
523
    node_configure_fields($type);
524
    module_invoke_all('node_type_update', $type);
525
    $status = SAVED_UPDATED;
526 527
  }
  else {
528
    $fields['orig_type'] = (string) $type->orig_type;
529 530 531
    db_insert('node_type')
      ->fields($fields)
      ->execute();
532

533
    field_attach_create_bundle('node', $type->type);
534
    node_configure_fields($type);
535
    module_invoke_all('node_type_insert', $type);
536
    $status = SAVED_NEW;
537
  }
538 539 540 541 542

  // Clear the node type cache.
  drupal_static_reset('_node_types_build');

  return $status;
543
}
544

545 546 547 548 549 550 551 552 553 554 555 556 557
/**
 * Manage the field(s) for a node type.
 *
 * Currently, the node module manages a single Field API field,
 * 'body'.  If $type->has_body is true, this function ensures the
 * 'body' field exists and creates an instance of it for the bundle
 * $type->type (e.g. 'page', 'story', ...).  If $type->has_body is
 * false, this function removes the instance (if it exists) for the
 * 'body' field on $type->type.
 */
function node_configure_fields($type) {
   // Add or remove the body field, as needed.
  $field = field_info_field('body');
558
  $instance = field_info_instance('node', 'body', $type->type);
559 560 561 562 563
  if ($type->has_body) {
    if (empty($field)) {
      $field = array(
        'field_name' => 'body',
        'type' => 'text_with_summary',
564
        'translatable' => TRUE,
565 566 567 568 569 570
      );
      $field = field_create_field($field);
    }
    if (empty($instance)) {
      $instance = array(
        'field_name' => 'body',
571
        'object_type' => 'node',
572 573 574 575 576
        'bundle' => $type->type,
        'label' => $type->body_label,
        'widget_type' => 'text_textarea_with_summary',
        'settings' => array('display_summary' => TRUE),

577
        // Define default formatters for the teaser and full view.
578 579 580 581
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
582
          ),
583 584 585 586
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
587 588
        ),
      );
589 590 591 592 593 594 595 596 597 598 599
      field_create_instance($instance);
    }
    else {
      $instance['label'] = $type->body_label;
      $instance['settings']['display_summary'] = TRUE;
      field_update_instance($instance);
    }
  }
  elseif (!empty($instance)) {
    field_delete_instance($instance);
  }
600
}
601

602 603 604 605 606
/**
 * Implements hook_field_extra_fields().
 */
function node_field_extra_fields() {
  $extra = array();
607

608 609 610 611 612 613 614
  foreach (node_type_get_types() as $type) {
    if ($type->has_title) {
      $extra['node'][$type->type] = array(
        'title' => array(
          'label' => $type->title_label,
          'description' => t('Node module element.'),
          'weight' => -5,
615 616 617 618
        ),
      );
    }
  }
619 620

  return $extra;
621 622
}

623 624 625 626 627 628 629
/**
 * Deletes a node type from the database.
 *
 * @param $type
 *   The machine-readable name of the node type to be deleted.
 */
function node_type_delete($type) {
630
  $info = node_type_get_type($type);
631 632 633
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
634
  module_invoke_all('node_type_delete', $info);
635 636 637

  // Clear the node type cache.
  drupal_static_reset('_node_types_build');
638 639
}

640
/**
641 642
 * Updates all nodes of one type to be of another type.
 *
643
 * @param $old_type
644 645 646
 *   The current node type of the nodes.
 * @param $type
 *   The new node type of the nodes.
647 648
 *
 * @return
649
 *   The number of nodes whose node type field was modified.
650
 */
651
function node_type_update_nodes($old_type, $type) {
652
  return db_update('node')
653 654 655
    ->fields(array('type' => $type))
    ->condition('type', $old_type)
    ->execute();
Dries's avatar
 
Dries committed
656
}
Dries's avatar
 
Dries committed
657

658
/**
659 660 661 662
 * Builds and returns the list of available node types.
 *
 * The list of types is built by querying hook_node_info() in all modules, and
 * by comparing this information with the node types in the {node_type} table.
Dries's avatar
 
Dries committed
663 664
 *
 */
665
function _node_types_build() {
666
  $_node_types = &drupal_static(__FUNCTION__);
667 668 669
  if (is_object($_node_types)) {
    return $_node_types;
  }
670
  $_node_types = (object)array('types' => array(), 'names' => array());
671 672 673 674

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
675 676
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
677
  }
678
  $type_result = db_select('node_type', 'nt')
679 680
    ->addTag('translatable')
    ->addTag('node_type_access')
681 682 683 684
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->execute();
  foreach ($type_result as $type_object) {
685 686
    // Check for node types from disabled modules and mark their types for removal.
    // Types defined by the node module in the database (rather than by a separate
687 688 689
    // module using hook_node_info) have a base value of 'node_content'. The isset()
    // check prevents errors on old (pre-Drupal 7) databases.
    if (isset($type_object->base) && $type_object->base != 'node_content' && empty($info_array[$type_object->type])) {
690
      $type_object->disabled = TRUE;
691
    }
692 693 694
    if (!isset($_node_types->types[$type_object->type]) || $type_object->modified) {
      $_node_types->types[$type_object->type] = $type_object;
      $_node_types->names[$type_object->type] = $type_object->name;
695 696

      if ($type_object->type != $type_object->orig_type) {
697 698
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
699 700 701 702
      }
    }
  }

703
  asort($_node_types->names);
704

705
  return $_node_types;
706 707 708
}

/**
709 710 711 712 713 714 715 716 717 718 719
 * Set the default values for a node type.
 *
 * The defaults are for a type defined through hook_node_info().
 * When populating a custom node type $info should have the 'custom'
 * key set to 1.
 *
 * @param $info
 *   An object or array containing values to override the defaults.
 *
 * @return
 *  A node type object.
720
 */
721
function node_type_set_defaults($info = array()) {
722
  $type = &drupal_static(__FUNCTION__);
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755

  if (!isset($type)) {
    $type = new stdClass();
    $type->type = '';
    $type->name = '';
    $type->base = '';
    $type->description = '';
    $type->help = '';
    $type->has_title = 1;
    $type->has_body = 1;
    $type->title_label = t('Title');
    $type->body_label = t('Body');
    $type->custom = 0;
    $type->modified = 0;
    $type->locked = 1;
    $type->is_new = 1;
  }

  $new_type = clone $type;
  $info = (array) $info;
  foreach ($info as $key => $data) {
    $new_type->$key = $data;
  }
  // If the type has no title or body, set an empty label.
  if (!$new_type->has_title) {
    $new_type->title_label = '';
  }
  if (!$new_type->has_body) {
    $new_type->body_label = '';
  }
  $new_type->orig_type = isset($info['type']) ? $info['type'] : '';

  return $new_type;
Dries's avatar
 
Dries committed
756
}
Dries's avatar
 
Dries committed
757

758
/**
759
 * Implements hook_rdf_mapping().
760 761 762 763 764 765 766 767
 */
function node_rdf_mapping() {
  return array(
    array(
      'type' => 'node',
      'bundle' => RDF_DEFAULT_BUNDLE,
      'mapping' => array(
        'rdftype' => array('sioc:Item', 'foaf:Document'),
768
        'title' => array(
769 770 771 772 773 774 775 776 777
          'predicates' => array('dc:title'),
        ),
        'created' => array(
          'predicates' => array('dc:date', 'dc:created'),
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
        ),
        'changed' => array(
          'predicates' => array('dc:modified'),
778 779
          'datatype' => 'xsd:dateTime',
          'callback' => 'date_iso8601',
780
        ),
781
        'body' => array(
782 783
          'predicates' => array('content:encoded'),
        ),
784
        'uid' => array(
785
          'predicates' => array('sioc:has_creator'),
786
          'type' => 'rel',
787
        ),
788
        'name' => array(
789 790
          'predicates' => array('foaf:name'),
        ),
791 792 793
        'comment_count' => array(
          'predicates' => array('sioc:num_replies'),
        ),
794 795 796 797 798
      ),
    ),
  );
}

799
/**
Dries's avatar
 
Dries committed
800 801
 * Determine whether a node hook exists.
 *
802
 * @param $node
803
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
804 805 806
 * @param $hook
 *   A string containing the name of the hook.
 * @return
807
 *   TRUE if the $hook exists in the node type of $node.
Dries's avatar
 
Dries committed
808
 */
809
function node_hook($node, $hook) {
810
  $base = node_type_get_base($node);
811
  return module_hook($base, $hook);
Dries's avatar
 
Dries committed
812 813
}

814
/**
Dries's avatar
 
Dries committed
815 816
 * Invoke a node hook.
 *
817
 * @param $node
818
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
819 820 821 822 823
 * @param $hook
 *   A string containing the name of the hook.
 * @param $a2, $a3, $a4
 *   Arguments to pass on to the hook, after the $node argument.
 * @return
Dries's avatar
 
Dries committed
824
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
825
 */
826
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
827
  if (node_hook($node, $hook)) {
828
    $base = node_type_get_base($node);
829
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
830
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
831 832 833
  }
}

Dries's avatar
 
Dries committed
834
/**
835
 * Load node entities from the database.
836 837 838 839
 *
 * This function should be used whenever you need to load more than one node
 * from the database. Nodes are loaded into memory and will not require
 * database access if loaded again during the same page request.
Dries's avatar
 
Dries committed
840
 *
841 842
 * @see entity_load()
 *
843 844 845 846
 * @param $nids
 *   An array of node IDs.
 * @param $conditions
 *   An array of conditions on the {node} table in the form 'field' => $value.
Dries's avatar
 
Dries committed
847 848
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
849 850
 *
 * @return
851
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
852
 */
853
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
854
  return entity_load('node', $nids, $conditions, $reset);
855 856 857 858 859 860 861 862 863 864
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
865
 *   Whether to reset the node_load_multiple cache.
866 867 868 869
 *
 * @return
 *   A fully-populated node object.
 */
870 871 872 873 874
function node_load($nid = NULL, $vid = NULL, $reset = FALSE) {
  $nids = (isset($nid) ? array($nid) : array());
  $conditions = (isset($vid) ? array('vid' => $vid) : array());
  $node = node_load_multiple($nids, $conditions, $reset);
  return $node ? reset($node) : FALSE;
Dries's avatar
 
Dries committed
875 876
}

877 878 879
/**
 * Perform validation checks on the given node.
 */
880
function node_validate($node, $form = array()) {
881
  $type = node_type_get_type($node);
882 883

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
884
    form_set_error('changed', t('The content on this page has either been modified by another user, or you have already submitted modifications using this form. As a result, your changes cannot be saved.'));
885 886 887 888
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
889
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
890 891 892 893 894 895
      // The use of empty() is mandatory in the context of usernames
      // as the empty string denotes the anonymous user. In case we
      // are dealing with an anonymous user we set the user ID to 0.
      form_set_error('name', t('The username %name does not exist.', array('%name' => $node->name)));
    }

896 897
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
898 899 900 901 902 903
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
904
  module_invoke_all('node_validate', $node, $form);
905 906 907
}

/**
908
 * Prepare node for saving by populating author and creation date.
909 910 911 912
 */
function node_submit($node) {
  global $user;

913 914 915 916
  // A user with 'administer nodes' permission might assign the node author by
  // entering a user name in the node form, which we then need to translate to a
  // user ID, unless we've already been provided a user ID by other means.
  if (user_access('administer nodes') && !isset($node->uid)) {
917
    if ($account = user_load_by_name($node->name)) {
918 919 920 921 922 923
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
924
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
925 926 927 928 929
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
930
/**
931 932 933 934 935
 * Save changes to a node or add a new node.
 *
 * @param $node
 *   The $node object to be saved. If $node->nid is
 *   omitted (or $node->is_new is TRUE), a new node will be added.
Dries's avatar
 
Dries committed
936
 */
937
function node_save($node) {
938
  $transaction = db_transaction();
Dries's avatar
 
Dries committed
939

940 941 942 943 944
  try {
    field_attach_presave('node', $node);
    // Let modules modify the node before it is saved to the database.
    module_invoke_all('node_presave', $node);
    global $user;
Dries's avatar
 
Dries committed
945

946 947
    if (!isset($node->is_new)) {
      $node->is_new = empty($node->nid);
948
    }
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972

    // Apply filters to some default node fields:
    if ($node->is_new) {
      // Insert a new node.
      $node->is_new = TRUE;

      // When inserting a node, $node->log must be set because
      // {node_revision}.log does not (and cannot) have a default
      // value. If the user does not have permission to create
      // revisions, however, the form will not contain an element for
      // log so $node->log will be unset at this point.
      if (!isset($node->log)) {
        $node->log = '';
      }
    }
    elseif (!empty($node->revision)) {
      $node->old_vid = $node->vid;
      unset($node->vid);
    }
    else {
      // When updating a node, avoid clobbering an existing log entry with an empty one.
      if (empty($node->log)) {
        unset($node->log);
      }
973
    }
Dries's avatar
 
Dries committed
974

975 976 977 978 979 980
    // Set some required fields:
    if (empty($node->created)) {
      $node->created = REQUEST_TIME;
    }
    // The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
    $node->changed = REQUEST_TIME;
981

982