comment.install

<?php
/**
 * @file
 * Install, update and uninstall functions for the Comment module.
 */

/**
 * Implements hook_schema_alter().
 */
function comment_schema_alter(&$schema) {
  $schema['node']['fields']['comment_close_override'] = array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => TRUE,
    'default' => 0,
    'size' => 'tiny',
    'description' => 'Override the automatic comment closer. (0 = Do not override, 1 = Override)',
  );
}

/**
 * Implements hook_install().
 */
function comment_install() {
  if (!db_field_exists('node', 'comment_close_override')) {
    $schema = array();
    comment_schema_alter($schema);
    db_add_field('node', 'comment_close_override', $schema['node']['fields']['comment_close_override']);
  }
}

/**
 * Implements hook_uninstall().
 */
function comment_uninstall() {
  // Delete comment_body field.
  field_delete_field('comment_body');

  // Remove variables.
  state_del('node_cron_comments_scale');
  $node_types = node_type_get_types();
  foreach ($node_types as $type_name => $node_type) {
    field_attach_delete_bundle('comment', 'comment_node_' . $type_name);
    $comment_settings = array(
      'comment',
      'comment_anonymous',
      'comment_mode',
      'comment_order',
      'comment_per_page',
      'comment_form_location',
      'comment_preview',
      'comment_title_options',
      'comment_user_picture',
      'comment_close_enabled',
      'comment_close_days'
    );
    foreach ($comment_settings as $setting) {
      if (isset($node_type->settings[$setting])) {
        unset($node_type->settings[$setting]);
      }
    }
    node_type_save($node_type);
  }

  // Remove comment closer override.
  if (db_field_exists('node', 'comment_close_override')) {
    db_drop_field('node', 'comment_close_override');
  }
  // Flush outdated cache data.
  cache('cache')->deletePrefix('schema');
  backdrop_static_reset('_node_types_build');

  // Remove default, un-modified view.
  $config = config('views.view.comments_recent');
  // Only update if view isn't overridden (VIEWS_STORAGE_OVERRIDE).
  if ($config->get('storage') != 2) {
    $config->delete();
  }
}

/**
 * Implements hook_enable().
 */
function comment_enable() {
  // Insert records into the node_comment_statistics for nodes that are missing.
  $query = db_select('node', 'n');
  $query->leftJoin('node_comment_statistics', 'ncs', 'ncs.nid = n.nid');
  $query->addField('n', 'created', 'last_comment_timestamp');
  $query->addField('n', 'uid', 'last_comment_uid');
  $query->addField('n', 'nid');
  $query->addExpression('0', 'comment_count');
  $query->addExpression('NULL', 'last_comment_name');
  $query->isNull('ncs.comment_count');

  db_insert('node_comment_statistics')
    ->from($query)
    ->execute();
}

/**
 * Implements hook_modules_enabled().
 *
 * Creates comment body fields for node types existing before the Comment module
 * is enabled. We use hook_modules_enabled() rather than hook_enable() so we can
 * react to node types of existing modules, and those of modules being enabled
 * both before and after the Comment module in the loop of module_enable().
 *
 * There is a separate comment bundle for each node type to allow for
 * per-node-type customization of comment fields. Each one of these bundles
 * needs a comment body field instance. A comment bundle is needed even for
 * node types whose comments are disabled by default, because individual nodes
 * may override that default.
 *
 * @see comment_node_type_insert()
 */
function comment_modules_enabled($modules) {
  // Only react if the Comment module is one of the modules being enabled.
  // hook_node_type_insert() is used to create body fields while the comment
  // module is enabled.
  if (in_array('comment', $modules)) {
    // Ensure that the list of node types reflects newly enabled modules.
    node_type_cache_reset();

    // Create comment body fields for each node type, if needed.
    foreach (node_type_get_types() as $type => $info) {
      _comment_body_field_create($info);
    }
  }
}

/**
 * Implements hook_schema().
 */
function comment_schema() {
  $schema['comment'] = array(
    'description' => 'Stores comments and associated data.',
    'fields' => array(
      'cid' => array(
        'type' => 'serial',
        'not null' => TRUE,
        'description' => 'Primary Key: Unique comment ID.',
      ),
      'pid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The {comment}.cid to which this comment is a reply. If set to 0, this comment is not a reply to an existing comment.',
      ),
      'nid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The {node}.nid to which this comment is a reply.',
      ),
      'uid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The {users}.uid who authored the comment. If set to 0, this comment was created by an anonymous user.',
      ),
      'subject' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The comment title.',
      ),
      'hostname' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => "The author's host name.",
      ),
      'created' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The time that the comment was created, as a Unix timestamp.',
      ),
      'changed' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The time that the comment was last edited, as a Unix timestamp.',
      ),
      'status' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 1,
        'size' => 'tiny',
        'description' => 'The published status of a comment. (0 = Not Published, 1 = Published)',
      ),
      'thread' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'description' => "The alphadecimal representation of the comment's place in a thread, consisting of a base 36 string prefixed by an integer indicating its length.",
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 60,
        'not null' => FALSE,
        'description' => "The comment author's name. Uses {users}.name if the user is logged in, otherwise uses the value typed into the comment form.",
      ),
      'mail' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => FALSE,
        'description' => "The comment author's email address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on.",
      ),
      'homepage' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
        'description' => "The comment author's home page address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on.",
      ),
      'langcode' => array(
        'description' => 'The language code of this comment.',
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'indexes' => array(
      'comment_status_pid' => array('pid', 'status'),
      'comment_num_new' => array('nid', 'status', 'created', 'cid', 'thread'),
      'comment_uid' => array('uid'),
      'comment_nid_langcode' => array('nid', 'langcode'),
      'comment_created' => array('created'),
    ),
    'primary key' => array('cid'),
    'foreign keys' => array(
      'comment_node' => array(
        'table' => 'node',
        'columns' => array('nid' => 'nid'),
      ),
      'comment_author' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
    ),
  );

  $schema['node_comment_statistics'] = array(
    'description' => 'Maintains statistics of node and comments posts to show "new" and "updated" flags.',
    'fields' => array(
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The {node}.nid for which the statistics are compiled.',
      ),
      'cid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The {comment}.cid of the last comment.',
      ),
      'last_comment_timestamp' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The Unix timestamp of the last comment that was posted within this node, from {comment}.changed.',
      ),
      'last_comment_name' => array(
        'type' => 'varchar',
        'length' => 60,
        'not null' => FALSE,
        'description' => 'The name of the latest author to post a comment on this node, from {comment}.name.',
      ),
      'last_comment_uid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The user ID of the latest author to post a comment on this node, from {comment}.uid.',
      ),
      'comment_count' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'description' => 'The total number of comments on this node.',
      ),
    ),
    'primary key' => array('nid'),
    'indexes' => array(
      'node_comment_timestamp' => array('last_comment_timestamp'),
      'comment_count' => array('comment_count'),
      'last_comment_uid' => array('last_comment_uid'),
    ),
    'foreign keys' => array(
      'statistics_node' => array(
        'table' => 'node',
        'columns' => array('nid' => 'nid'),
      ),
      'last_comment_author' => array(
        'table' => 'users',
        'columns' => array(
          'last_comment_uid' => 'uid',
        ),
      ),
    ),
  );

  $cache_schema = backdrop_get_schema_unprocessed('system', 'cache');
  $schema['cache_entity_comment'] = $cache_schema;
  $schema['cache_entity_comment']['description'] = "Cache table used to store Comment entity records.";

  return $schema;
}

/**
 * Implements hook_update_dependencies().
 */
function comment_update_dependencies() {
  // comment_update_1001() updates comment variables to save into the node
  // type config files, which are created in node_update_1005().
  $dependencies['comment'][1001] = array(
    'node' => 1005,
  );
  return $dependencies;
}

/**
 * @addtogroup updates-7.x-to-1.x
 * @{
 */

/**
 * Renames {comment}.language to {comment}.langcode.
 */
function comment_update_1000() {
  db_drop_index('comment', 'comment_nid_langcode');
  $langcode_spec = array(
    'type' => 'varchar',
    'length' => 12,
    'not null' => TRUE,
    'default' => '',
    'description' => "Language code, e.g. 'de' or 'en-US'.",
  );
  db_change_field('comment', 'language', 'langcode', $langcode_spec);
  db_add_index('comment', 'comment_nid_langcode', array('nid', 'langcode'));
}

/**
 * Move comment content type settings into configuration files.
 */
function comment_update_1001() {
  // Ensure module-provided code is loaded.
  backdrop_load('module', 'node');
  backdrop_load('module', 'entity');

  $node_types = node_type_get_types();
  foreach ($node_types as $node_type) {
    // Move the comment variables into each node type's config.
    $settings = array(
      'comment_default' => update_variable_get('comment_' . $node_type->type, 2), // COMMENT_NODE_OPEN
      'comment_per_page' => update_variable_get('comment_default_per_page_' . $node_type->type, 50),
      'comment_mode' => update_variable_get('comment_default_mode_' . $node_type->type, 1), // COMMENT_MODE_THREADED
      'comment_anonymous' => update_variable_get('comment_anonymous_' . $node_type->type, 0), // COMMENT_ANONYMOUS_MAYNOT_CONTACT
      'comment_subject_field' => update_variable_get('comment_subject_field_' . $node_type->type, 0), // COMMENT_ANONYMOUS_MAYNOT_CONTACT
      'comment_user_picture' => update_variable_get('comment_user_picture_' . $node_type->type, 1),
      'comment_form_location' => update_variable_get('comment_form_location_' . $node_type->type, 1), // COMMENT_FORM_BELOW
      'comment_preview' => update_variable_get('comment_preview_' . $node_type->type, BACKDROP_OPTIONAL),
    );
    $node_type->settings = array_merge($node_type->settings, $settings);
    node_type_save($node_type);

    // Delete the migrated variables.
    update_variable_del('comment_' . $node_type->type);
    update_variable_del('comment_default_per_page_' . $node_type->type);
    update_variable_del('comment_default_mode_' . $node_type->type);
    update_variable_del('comment_anonymous_' . $node_type->type);
    update_variable_del('comment_subject_field_' . $node_type->type);
    update_variable_del('comment_user_picture_' . $node_type->type);
    update_variable_del('comment_form_location_' . $node_type->type);
    update_variable_del('comment_preview_' . $node_type->type);
  }
}

/**
 * Move comment variables to configuration files.
 */
function comment_update_1002() {
  // These variables are environment-specific, so they use state instead of
  // config files.
  state_set('node_cron_comments_scale', update_variable_get('node_cron_comments_scale', 1.0));
  update_variable_del('node_cron_comments_scale');

  state_set('comment_maintain_node_statistics', update_variable_get('comment_maintain_node_statistics', TRUE));
  update_variable_del('comment_maintain_node_statistics');
}

/**
 * Node type comment settings should be closed instead of hidden by default.
 */
function comment_update_1003() {
  foreach (config_get_names_with_prefix('node.type.') as $config_name) {
    $config = config($config_name);
    $comment_default = $config->get('settings.comment_default');
    // If comment hidden (COMMENT_NODE_HIDDEN).
    if ($comment_default == 0) {
      $config->set('settings.comment_default', 1); // COMMENT_NODE_CLOSED
      $config->save();
    }
  }
}

/**
 * Add an Override column for automatic comment closing for individual nodes.
 */
function comment_update_1004() {
  if (db_field_exists('node', 'comment_close_override')) {
    return;
  }

  $comment_close_override_column = array(
    'type' => 'int',
    'unsigned' => TRUE,
    'not null' => TRUE,
    'default' => 0,
    'size' => 'tiny',
    'description' => 'Override the automatic comment closer. (0 = Do not override, 1 = Override)',
  );

  db_add_field('node', 'comment_close_override', $comment_close_override_column);
}

/**
 * Move default comment view to comment module.
 */
function comment_update_1005() {
  // If the views config has not been deleted, update it's module.
  $config = config('views.view.comments_recent');
  if (!$config->isNew()) {
    $config->set('module', 'comment');
    $config->save();
  }
}

/**
 * Creates the table to enable caching of Comment entities.
 */
function comment_update_1006() {
  $table = backdrop_get_schema_unprocessed('system', 'cache');
  $table['description'] = "Cache table used to store Comment entity records.";
  if (db_table_exists('cache_entity_comment')) {
    db_drop_table('cache_entity_comment');
  }
  db_create_table('cache_entity_comment', $table);
}

/**
 * Give access to the new 'Administer comment settings' permission as needed.
 */
function comment_update_1007() {
  $names = config_get_names_with_prefix('user.role.');
  foreach ($names as $config_name) {
    $config = config($config_name);
    $permissions = $config->get('permissions');
    if (in_array('administer comments', $permissions)) {
      $permissions[] = 'administer comment settings';
      $config->set('permissions', $permissions);
      $config->save();
    }
  }
}

/**
 * Replace comment_subject_field setting with comment_title_options.
 */
function comment_update_1008() {
  foreach (config_get_names_with_prefix('node.type.') as $config_name) {
    $config = config($config_name);
    $comment_title = $config->get('settings.comment_subject_field');

    // If the old config value has already been removed, do nothing.
    if (is_null($comment_title)) {
      continue;
    }

    // If comment title was previously enabled, use the custom title option.
    if ($comment_title) {
      $config->set('settings.comment_title_options', 'custom');
    }
    else {
      // Check to see if contrib module comment_hide_subject is installed and
      // preserve the setting to hide comment titles entirely.
      if (module_exists('comment_hide_subject')) {
        $config->set('settings.comment_title_options', 'hidden');
      }
      // Otherwise, the previous behavior was to display an automatically
      // generated title.
      else {
        $config->set('settings.comment_title_options', 'auto');
      }
    }
    // Remove the previous setting.
    $config->clear('settings.comment_subject_field');
    $config->save();
  }

  // Now disable and uninstall comment_hide_subject contrib module if present.
  if (module_exists('comment_hide_subject')) {
    $path = backdrop_get_path('module', 'comment_hide_subject');
    db_query("DELETE FROM {system} WHERE name = 'comment_hide_subject' AND type = 'module'");
    backdrop_set_message(t('The contributed module <em>Comment Hide Subject</em> is located at %path. The module has been disabled and uninstalled, since its functionality is now provided by Backdrop core. It is recommended that you remove this module from your site.', array('%path' => BACKDROP_ROOT . '/' . $path)), 'warning');
  }
}

/**
 * @} End of "addtogroup updates-7.x-to-1.x"
 * The next series of updates should start at 2000.
 */