<?php

/**

 * @file

 * The core that allows content to be submitted to the site. Modules and

 * scripts may programmatically submit nodes using the usual form API pattern.

 */

/**

 * 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);

/**

 * 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.

 */

define('NODE_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);

/**

 * 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);

/**

 * Implements hook_help().

 */

function node_help($path, $arg) {

  // 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.

  if ($path != 'admin/reports/status/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE

      && user_access('access administration pages') && node_access_needs_rebuild()) {

    if ($path == 'admin/reports/status') {

      $message = t('The content access permissions need to be rebuilt.');

    }

    else {

      $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')));

    }

    drupal_set_message($message, 'error');

  }

  switch ($path) {

    case 'admin/help#node':

      $output = '';

      $output .= '<h3>' . t('About') . '</h3>';

      $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/documentation/modules/node', '@field' => url('admin/help/field'))) . '</p>';

      $output .= '<h3>' . t('Uses') . '</h3>';

      $output .= '<dl>';

      $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>';

      $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>';

      $output .= '<dt>' . t('Administering content') . '</dt>';

      $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>';

      $output .= '<dt>' . t('User permissions') . '</dt>';

      $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/people/permissions', array('fragment' => 'module-node')))) . '</dd>';

      $output .= '</dl>';

      return $output;

    case 'admin/structure/types/add':

      return '<p>' . t('Individual content types can have different fields, behaviors, and permissions assigned to them.') . '</p>';

    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>';

    case 'node/%/revisions':

      return '<p>' . t('Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.') . '</p>';

    case 'node/%/edit':

      $node = node_load($arg[1]);

      $type = node_type_get_type($node);

      return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');

  }

  if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {

    $type = node_type_get_type(str_replace('-', '_', $arg[2]));

    return (!empty($type->help) ? '<p>' . filter_xss_admin($type->help) . '</p>' : '');

  }

}

/**

 * Implements hook_theme().

 */

function node_theme() {

  return array(

    'node' => array(

      'render element' => 'elements',

      'template' => 'node',

    ),

    'node_search_admin' => array(

      'render element' => 'form',

    ),

    'node_add_list' => array(

      'variables' => array('content' => NULL),

      'file' => 'node.pages.inc',

    ),

    'node_preview' => array(

      'variables' => array('node' => NULL),

      'file' => 'node.pages.inc',

    ),

    'node_admin_overview' => array(

      'variables' => array('name' => NULL, 'type' => NULL),

      'file' => 'content_types.inc',

    ),

    'node_recent_block' => array(

      'variables' => array('nodes' => NULL),

    ),

    'node_recent_content' => array(

      'variables' => array('node' => NULL),

    ),

  );

}

/**

 * Implements hook_cron().

 */

function node_cron() {

  db_delete('history')

    ->condition('timestamp', NODE_NEW_LIMIT, '<')

    ->execute();

}

/**

 * Implements hook_entity_info().

 */

function node_entity_info() {

  $return = array(

    'node' => array(

      'label' => t('Node'),

      'controller class' => 'NodeController',

      'base table' => 'node',

      'revision table' => 'node_revision',

      'uri callback' => 'node_uri',

      'fieldable' => TRUE,

      'entity keys' => array(

        'id' => 'nid',

        'revision' => 'vid',

        'bundle' => 'type',

        'label' => 'title',

        'language' => 'language',

      ),

      'bundle keys' => array(

        'bundle' => 'type',

      ),

      'bundles' => array(),

      'view modes' => array(

        'full' => array(

          'label' => t('Full content'),

          'custom settings' => FALSE,

        ),

        'teaser' => array(

          'label' => t('Teaser'),

          'custom settings' => TRUE,

        ),

        'rss' => array(

          'label' => t('RSS'),

          'custom settings' => FALSE,

        ),

      ),

    ),

  );

  // 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(

        'label' => t('Search index'),

        'custom settings' => FALSE,

      ),

      'search_result' => array(

        'label' => t('Search result highlighting input'),

        'custom settings' => FALSE,

      ),

    );

  }

  // 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(

        'path' => 'admin/structure/types/manage/%node_type',

        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),

        'bundle argument' => 4,

        'access arguments' => array('administer content types'),

      ),

    );

  }

  return $return;

}

/**

 * Implements hook_field_display_ENTITY_TYPE_alter().

 */

function node_field_display_node_alter(&$display, $context) {

  // Hide field labels in search index.

  if ($context['view_mode'] == 'search_index') {

    $display['label'] = 'hidden';

  }

}

/**

 * Implements callback_entity_info_uri().

 */

function node_uri($node) {

  return array(

    'path' => 'node/' . $node->nid,

  );

}

/**

 * Implements hook_admin_paths().

 */

function node_admin_paths() {

  if (variable_get('node_admin_theme')) {

    $paths = array(

      'node/*/edit' => TRUE,

      'node/*/delete' => TRUE,

      'node/*/revisions' => TRUE,

      'node/*/revisions/*/revert' => TRUE,

      'node/*/revisions/*/delete' => TRUE,

      'node/add' => TRUE,

      'node/add/*' => TRUE,

    );

    return $paths;

  }

}

/**

 * Gathers a listing of links to nodes.

 *

 * @param $result

 *   A database result object from a query to fetch node entities. If your

 *   query joins the {node_comment_statistics} table so that the comment_count

 *   field is available, a title attribute will be added to show the number of

 *   comments.

 * @param $title

 *   A heading for the resulting list.

 *

 * @return

 *   A renderable array containing a list of linked node titles fetched from

 *   $result, or FALSE if there are no rows in $result.

 */

function node_title_list($result, $title = NULL) {

  $items = array();

  $num_rows = FALSE;

  foreach ($result as $node) {

    $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());

    $num_rows = TRUE;

  }

  return $num_rows ? array('#theme' => 'item_list__node', '#items' => $items, '#title' => $title) : FALSE;

}

/**

 * Updates the 'last viewed' timestamp of the specified node for current user.

 *

 * @param $node

 *   A node object.

 */

function node_tag_new($node) {

  global $user;

  if ($user->uid) {

    db_merge('history')

      ->key(array(

        'uid' => $user->uid,

        'nid' => $node->nid,

      ))

      ->fields(array('timestamp' => REQUEST_TIME))

      ->execute();

   }

}

/**

 * Retrieves the timestamp for the current user's last view of a specified node.

 *

 * @param $nid

 *   A node ID.

 *

 * @return

 *   If a node has been previously viewed by the user, the timestamp in seconds

 *   of when the last view occurred; otherwise, zero.

 */

function node_last_viewed($nid) {

  global $user;

  $history = &drupal_static(__FUNCTION__, array());

  if (!isset($history[$nid])) {

    $history[$nid] = db_query("SELECT timestamp FROM {history} WHERE uid = :uid AND nid = :nid", array(':uid' => $user->uid, ':nid' => $nid))->fetchObject();

  }

  return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);

}

/**

 * Determines the type of marker to be displayed for a given node.

 *

 * @param $nid

 *   Node ID whose history supplies the "last viewed" timestamp.

 * @param $timestamp

 *   Time which is compared against node's "last viewed" timestamp.

 *

 * @return

 *   One of the MARK constants.

 */

function node_mark($nid, $timestamp) {

  global $user;

  $cache = &drupal_static(__FUNCTION__, array());

  if (!$user->uid) {

    return MARK_READ;

  }

  if (!isset($cache[$nid])) {

    $cache[$nid] = node_last_viewed($nid);

  }

  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;

}

/**

 * Extracts the type name.

 *

 * @param $node

 *   Either a string or object, containing the node type information.

 *

 * @return

 *   Node type of the passed-in data.

 */

function _node_extract_type($node) {

  return is_object($node) ? $node->type : $node;

}

/**

 * Returns a list of all the available node types.

 *

 * This list can include types that are queued for addition or deletion.

 * See _node_types_build() for details.

 *

 * @return

 *   An array of node types, as objects, 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 object containing fields from hook_node_info() return

 *   values, as well as the field 'type' (the machine-readable type) and other

 *   fields used internally and defined in _node_types_build(),

 *   hook_node_info(), and node_type_set_defaults().

 */

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 implements this node type and is used to

 * execute node-type-specific hooks. For types defined in the user interface

 * and managed by node.module, the base is 'node_content'.

 *

 * @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.

 *

 * @see node_invoke()

 */

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 type names.

 *

 * This list can include types that are queued for addition or deletion.

 * See _node_types_build() for details.

 *

 * @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;

}

/**

 * Updates the database cache of node types.

 *

 * All new module-defined node types are saved to the database via a call to

 * node_type_save(), and obsolete ones are deleted via a call to

 * node_type_delete(). See _node_types_build() for an explanation of the new

 * and obsolete types.

 *

 * @see _node_types_build()

 */

function node_types_rebuild() {

  _node_types_build(TRUE);

}

/**

 * Menu argument loader: loads a node type by string.

 *

 * @param $name

 *   The machine-readable name of a node type to load, where '_' is 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('-' => '_')));

}

/**

 * Saves a node type to the database.

 *

 * @param object $info

 *   The node type to save; an object with the following properties:

 *   - type: A string giving the machine name of the node type.

 *   - name: A string giving the human-readable name of the node type.

 *   - base: A string that indicates the base string for hook functions. For

 *     example, 'node_content' is the value used by the UI when creating a new

 *     node type.

 *   - description: A string that describes the node type.

 *   - help: A string giving the help information shown to the user when

 *     creating a node of this type.

 *   - custom: TRUE or FALSE indicating whether this type is defined by a module

 *     (FALSE) or by a user (TRUE) via Add Content Type.

 *   - modified: TRUE or FALSE indicating whether this type has been modified by

 *     an administrator. When modifying an existing node type, set to TRUE, or

 *     the change will be ignored on node_types_rebuild().

 *   - locked: TRUE or FALSE indicating whether the administrator can change the

 *     machine name of this type.

 *   - disabled: TRUE or FALSE indicating whether this type has been disabled.

 *   - has_title: TRUE or FALSE indicating whether this type uses the node title

 *     field.

 *   - title_label: A string containing the label for the title.

 *   - module: A string giving the module defining this type of node.

 *   - orig_type: A string giving the original machine-readable name of this

 *     node type. This may be different from the current type name if the

 *     'locked' key is FALSE.

 *

 * @return int

 *   A status flag indicating the outcome of the operation, either SAVED_NEW or

 *   SAVED_UPDATED.

 */

function node_type_save($info) {

  $existing_type = !empty($info->old_type) ? $info->old_type : $info->type;

  $is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();

  $type = node_type_set_defaults($info);