node.module 110 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. <a href="@node_access_rebuild">Rebuild permissions</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/structure/types/add':
102
      return '<p>' . t('Individual content types can have different fields, behaviors, and permissions assigned to them.') . '</p>';
103

104 105 106
    case 'admin/structure/types/manage/%/display':
      return '<p>' . t('Content items can be displayed using different view modes: Teaser, Full content, Print, RSS, etc. <em>Teaser</em> is a short format that is typically used in lists of multiple content items. <em>Full content</em> is typically used when the content is displayed on its own page.') . '</p>' .
        '<p>' . t('Here, you can define which fields are shown and hidden when %type content is displayed in each view mode, and define how the fields are displayed in each view mode.', array('%type' => node_type_get_name($arg[4]))) . '</p>';
107

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

111 112
    case 'node/%/edit':
      $node = node_load($arg[1]);
113
      $type = node_type_get_type($node);
114
      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
Dries's avatar
 
Dries committed
115
  }
Dries's avatar
 
Dries committed
116

117
  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
118
    $type = node_type_get_type(str_replace('-', '_', $arg[2]));
119
    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');
120
  }
Dries's avatar
 
Dries committed
121 122
}

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

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

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

  // 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(
220
        'label' => t('Search index'),
221 222
      ),
      'search_result' => array(
223
        'label' => t('Search result'),
224 225 226 227
      ),
    );
  }

228 229 230 231 232 233
  // 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(
234 235 236
        'path' => 'admin/structure/types/manage/%node_type',
        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
        'bundle argument' => 4,
237 238 239 240
        'access arguments' => array('administer content types'),
      ),
    );
  }
Dries's avatar
 
Dries committed
241

242
  return $return;
Dries's avatar
 
Dries committed
243 244
}

245 246 247 248 249 250 251
/**
 * Entity path callback.
 */
function node_path($node) {
  return 'node/' . $node->nid;
}

252
/**
253
 * Implements hook_admin_paths().
254 255 256 257 258
 */
function node_admin_paths() {
  $paths = array(
    'node/*/edit' => TRUE,
    'node/*/delete' => TRUE,
259 260 261
    'node/*/revisions' => TRUE,
    'node/*/revisions/*/revert' => TRUE,
    'node/*/revisions/*/delete' => TRUE,
262 263 264 265 266 267
    'node/add' => TRUE,
    'node/add/*' => TRUE,
  );
  return $paths;
}

Dries's avatar
 
Dries committed
268 269 270 271
/**
 * Gather a listing of links to nodes.
 *
 * @param $result
272
 *   A DB result object from a query to fetch node entities. If your query
273 274 275
 *   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
276 277 278 279
 * @param $title
 *   A heading for the resulting list.
 *
 * @return
280 281
 *   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
282
 */
Dries's avatar
 
Dries committed
283
function node_title_list($result, $title = NULL) {
284
  $items = array();
285
  $num_rows = FALSE;
286
  foreach ($result as $node) {
287
    $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());
288
    $num_rows = TRUE;
Dries's avatar
 
Dries committed
289 290
  }

291
  return $num_rows ? theme('node_list', array('items' => $items, 'title' => $title)) : FALSE;
Dries's avatar
 
Dries committed
292 293
}

Dries's avatar
 
Dries committed
294 295
/**
 * Format a listing of links to nodes.
296 297
 *
 * @ingroup themeable
Dries's avatar
 
Dries committed
298
 */
299 300
function theme_node_list($variables) {
  return theme('item_list', $variables);
Dries's avatar
 
Dries committed
301 302
}

Dries's avatar
 
Dries committed
303 304 305
/**
 * Update the 'last viewed' timestamp of the specified node for current user.
 */
Dries's avatar
 
Dries committed
306 307 308 309
function node_tag_new($nid) {
  global $user;

  if ($user->uid) {
310 311 312 313 314 315 316
    db_merge('history')
      ->key(array(
        'uid' => $user->uid,
        'nid' => $nid,
      ))
      ->fields(array('timestamp' => REQUEST_TIME))
      ->execute();
Dries's avatar
 
Dries committed
317 318 319
  }
}

Dries's avatar
 
Dries committed
320 321 322 323
/**
 * Retrieves the timestamp at which the current user last viewed the
 * specified node.
 */
Dries's avatar
 
Dries committed
324 325
function node_last_viewed($nid) {
  global $user;
326
  $history = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
327

Dries's avatar
 
Dries committed
328
  if (!isset($history[$nid])) {
329
    $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
330 331
  }

332
  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries's avatar
 
Dries committed
333 334 335
}

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

349 350 351
  if (!$user->uid) {
    return MARK_READ;
  }
Dries's avatar
Dries committed
352
  if (!isset($cache[$nid])) {
353
    $cache[$nid] = node_last_viewed($nid);
Dries's avatar
 
Dries committed
354
  }
355 356 357 358 359 360 361
  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
362 363
}

364
/**
365
 * Extract the type name.
366 367
 *
 * @param $node
368
 *   Either a string or object, containing the node type information.
369 370
 *
 * @return
371
 *   Node type of the passed in data.
372
 */
373 374 375
function _node_extract_type($node) {
  return is_object($node) ? $node->type : $node;
}
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 450 451 452 453 454
/**
 * 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;
455 456 457
}

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

475 476 477 478 479 480 481 482 483 484 485 486 487 488
/**
 * 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('-' => '_')));
}

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

  if ($is_existing) {
520 521 522 523
    db_update('node_type')
      ->fields($fields)
      ->condition('type', $existing_type)
      ->execute();
524

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

538
    field_attach_create_bundle('node', $type->type);
539
    node_configure_fields($type);
540
    module_invoke_all('node_type_insert', $type);
541
    $status = SAVED_NEW;
542
  }
543 544 545 546 547

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

  return $status;
548
}
549

550 551 552 553 554 555 556 557 558 559 560 561 562
/**
 * 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');
563
  $instance = field_info_instance('node', 'body', $type->type);
564 565 566 567 568
  if ($type->has_body) {
    if (empty($field)) {
      $field = array(
        'field_name' => 'body',
        'type' => 'text_with_summary',
569
        'translatable' => TRUE,
570 571 572 573 574 575
      );
      $field = field_create_field($field);
    }
    if (empty($instance)) {
      $instance = array(
        'field_name' => 'body',
576
        'object_type' => 'node',
577 578 579 580 581
        'bundle' => $type->type,
        'label' => $type->body_label,
        'widget_type' => 'text_textarea_with_summary',
        'settings' => array('display_summary' => TRUE),

582
        // Define default formatters for the teaser and full view.
583 584 585 586
        'display' => array(
          'full' => array(
            'label' => 'hidden',
            'type' => 'text_default',
587
          ),
588 589 590 591
          'teaser' => array(
            'label' => 'hidden',
            'type' => 'text_summary_or_trimmed',
          ),
592 593
        ),
      );
594 595 596 597 598 599 600 601 602 603 604
      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);
  }
605
}
606

607 608 609 610 611
/**
 * Implements hook_field_extra_fields().
 */
function node_field_extra_fields() {
  $extra = array();
612

613 614 615 616 617 618 619
  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,
620 621 622 623
        ),
      );
    }
  }
624 625

  return $extra;
626 627
}

628 629 630 631 632 633 634
/**
 * 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) {
635
  $info = node_type_get_type($type);
636 637 638
  db_delete('node_type')
    ->condition('type', $type)
    ->execute();
639
  module_invoke_all('node_type_delete', $info);
640 641 642

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

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

663
/**
664 665 666 667
 * 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
668 669
 *
 */
670
function _node_types_build() {
671
  $_node_types = &drupal_static(__FUNCTION__);
672 673 674
  if (is_object($_node_types)) {
    return $_node_types;
  }
675
  $_node_types = (object)array('types' => array(), 'names' => array());
676 677 678 679

  $info_array = module_invoke_all('node_info');
  foreach ($info_array as $type => $info) {
    $info['type'] = $type;
680 681
    $_node_types->types[$type] = node_type_set_defaults($info);
    $_node_types->names[$type] = $info['name'];
682
  }
683
  $type_result = db_select('node_type', 'nt')
684 685
    ->addTag('translatable')
    ->addTag('node_type_access')
686 687 688 689
    ->fields('nt')
    ->orderBy('nt.type', 'ASC')
    ->execute();
  foreach ($type_result as $type_object) {
690 691
    // 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
692 693 694
    // 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])) {
695
      $type_object->disabled = TRUE;
696
    }
697 698 699
    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;
700 701

      if ($type_object->type != $type_object->orig_type) {
702 703
        unset($_node_types->types[$type_object->orig_type]);
        unset($_node_types->names[$type_object->orig_type]);
704 705 706 707
      }
    }
  }

708
  asort($_node_types->names);
709

710
  return $_node_types;
711 712 713
}

/**
714 715 716 717 718 719 720 721 722 723 724
 * 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.
725
 */
726
function node_type_set_defaults($info = array()) {
727
  $type = &drupal_static(__FUNCTION__);
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 756 757 758 759 760

  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
761
}
Dries's avatar
 
Dries committed
762

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

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

819
/**
Dries's avatar
 
Dries committed
820 821
 * Invoke a node hook.
 *
822
 * @param $node
823
 *   A node object or a string containing the node type.
Dries's avatar
 
Dries committed
824 825 826 827 828
 * @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
829
 *   The returned value of the invoked hook.
Dries's avatar
 
Dries committed
830
 */
831
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
832
  if (node_hook($node, $hook)) {
833
    $base = node_type_get_base($node);
834
    $function = $base . '_' . $hook;
Dries's avatar
 
Dries committed
835
    return ($function($node, $a2, $a3, $a4));
Dries's avatar
 
Dries committed
836 837 838
  }
}

Dries's avatar
 
Dries committed
839
/**
840
 * Load node entities from the database.
841 842 843 844
 *
 * 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
845
 *
846 847
 * @see entity_load()
 *
848 849 850 851
 * @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
852 853
 * @param $reset
 *   Whether to reset the internal node_load cache.
Dries's avatar
 
Dries committed
854 855
 *
 * @return
856
 *   An array of node objects indexed by nid.
Dries's avatar
 
Dries committed
857
 */
858
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
859
  return entity_load('node', $nids, $conditions, $reset);
860 861 862 863 864 865 866 867 868 869
}

/**
 * Load a node object from the database.
 *
 * @param $nid
 *   The node ID.
 * @param $vid
 *   The revision ID.
 * @param $reset
870
 *   Whether to reset the node_load_multiple cache.
871 872 873 874
 *
 * @return
 *   A fully-populated node object.
 */
875 876 877 878 879
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
880 881
}

882 883 884
/**
 * Perform validation checks on the given node.
 */
885
function node_validate($node, $form = array()) {
886
  $type = node_type_get_type($node);
887 888

  if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
889
    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.'));
890 891 892 893
  }

  if (user_access('administer nodes')) {
    // Validate the "authored by" field.
894
    if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
895 896 897 898 899 900
      // 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)));
    }

901 902
    // Validate the "authored on" field.
    if (!empty($node->date) && strtotime($node->date) === FALSE) {
903 904 905 906 907 908
      form_set_error('date', t('You have to specify a valid date.'));
    }
  }

  // Do node-type-specific validation checks.
  node_invoke($node, 'validate', $form);
909
  module_invoke_all('node_validate', $node, $form);
910 911 912
}

/**
913
 * Prepare node for saving by populating author and creation date.
914 915 916 917
 */
function node_submit($node) {
  global $user;

918 919 920 921
  // 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)) {
922
    if ($account = user_load_by_name($node->name)) {
923 924 925 926 927 928
      $node->uid = $account->uid;
    }
    else {
      $node->uid = 0;
    }
  }
929
  $node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
930 931 932 933 934
  $node->validated = TRUE;

  return $node;
}

Dries's avatar
 
Dries committed
935
/**
936 937 938 939 940
 * 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
941
 */
942
function node_save($node) {
943
  $transaction = db_transaction();
Dries's avatar
 
Dries committed
944

945 946 947 948 949
  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
950

951
    // Determine if we will be inserting a new node.
952 953
    if (!isset($node->is_new)) {
      $node->is_new = empty($node->nid);
954
    }
955

956 957 958 959 960 961 962 963 964
    if ($node->is_new || !empty($node->revision)) {
      // When inserting either a new node or a new node revision, $node->log
      // must be set because {node_revision}.log is a text column and therefore
      // cannot have a default value. However, it might not be set at this
      // point (for example, if the user submitting a node form does not have
      // permission to create revisions), so we ensure that it is at least an
      // empty string in that case.
      // @todo: Make the {node_revision}.log column nullable so that we can
      // remove this check.
965 966 967 968
      if (!isset($node->log)) {
        $node->log = '';
      }
    }
969 970 971 972 973 974 975 976 977 978
    elseif (empty($node->log)) {
      // If we are updating an existing node without adding a new revision, we
      // need to make sure $node->log is unset whenever it is empty. As long as
      // $node->log is unset, drupal_write_record() will not attempt to update
      // the existing database column when re-saving the revision; therefore,
      // this code allows us to avoid clobbering an existing log entry with an
      // empty one.
      unset($node->log);
    }

979 980
    // When saving a new node revision, unset any existing $node->vid so as to
    // ensure that a new revision will actually be created, then store the old
981 982
    // revision ID in a separate property for use by node hook implementations.
    if (!$node->is_new && !empty($node->revision) && $node->vid) {
983 984 985
      $node->old_vid = $node->vid;
      unset($node->vid);
    }
Dries's avatar