2006-12-13 10:24:58 +00:00
<?php
2009-05-13 19:42:18 +00:00
/**
* @file
2012-01-03 04:36:15 +00:00
* Install, update and uninstall functions for the Comment module.
2009-05-13 19:42:18 +00:00
*/
2009-01-19 01:23:39 +00:00
/**
2009-12-04 16:49:48 +00:00
* Implements hook_uninstall().
2009-01-19 01:23:39 +00:00
*/
function comment_uninstall() {
2010-01-07 05:23:52 +00:00
// Delete comment_body field.
field_delete_field('comment_body');
2009-01-31 16:31:59 +00:00
// Remove variables.
variable_del('comment_block_count');
2009-06-04 03:33:29 +00:00
$node_types = array_keys(node_type_get_types());
2009-01-31 16:31:59 +00:00
foreach ($node_types as $node_type) {
2011-06-14 08:26:10 +00:00
field_attach_delete_bundle('comment', 'comment_node_' . $node_type);
2009-01-31 16:31:59 +00:00
variable_del('comment_' . $node_type);
variable_del('comment_anonymous_' . $node_type);
variable_del('comment_controls_' . $node_type);
variable_del('comment_default_mode_' . $node_type);
variable_del('comment_default_order_' . $node_type);
variable_del('comment_default_per_page_' . $node_type);
variable_del('comment_form_location_' . $node_type);
variable_del('comment_preview_' . $node_type);
variable_del('comment_subject_field_' . $node_type);
}
2009-01-19 01:23:39 +00:00
}
2006-12-13 10:24:58 +00:00
/**
2009-12-04 16:49:48 +00:00
* Implements hook_enable().
2006-12-13 10:24:58 +00:00
*/
function comment_enable() {
// Insert records into the node_comment_statistics for nodes that are missing.
2009-07-28 19:18:08 +00:00
$query = db_select('node', 'n');
$query->leftJoin('node_comment_statistics', 'ncs', 'ncs.nid = n.nid');
2010-04-04 13:20:10 +00:00
$query->addField('n', 'created', 'last_comment_timestamp');
2009-07-28 19:18:08 +00:00
$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();
2007-07-15 10:05:18 +00:00
}
2010-12-18 01:50:16 +00:00
/**
* Implements hook_modules_enabled().
*
2012-01-03 04:36:15 +00:00
* Creates comment body fields for node types existing before the Comment module
2010-12-18 01:50:16 +00:00
* 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
2012-01-03 04:36:15 +00:00
* both before and after the Comment module in the loop of module_enable().
2010-12-18 01:50:16 +00:00
*
* 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) {
2012-01-03 04:36:15 +00:00
// Only react if the Comment module is one of the modules being enabled.
2010-12-18 01:50:16 +00:00
// 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_types_rebuild();
// Create comment body fields for each node type, if needed.
foreach (node_type_get_types() as $type => $info) {
_comment_body_field_create($info);
}
}
}
2007-10-05 14:43:26 +00:00
/**
2009-12-04 16:49:48 +00:00
* Implements hook_schema().
2007-10-05 14:43:26 +00:00
*/
function comment_schema() {
2008-12-03 16:32:22 +00:00
$schema['comment'] = array(
2008-11-15 13:01:11 +00:00
'description' => 'Stores comments and associated data.',
2007-10-05 14:43:26 +00:00
'fields' => array(
2007-10-10 11:39:35 +00:00
'cid' => array(
'type' => 'serial',
'not null' => TRUE,
2008-11-15 13:01:11 +00:00
'description' => 'Primary Key: Unique comment ID.',
2007-10-10 11:39:35 +00:00
),
2012-08-07 18:33:39 +00:00
'uuid' => array(
'description' => 'Unique Key: Universally unique identifier for this entity.',
'type' => 'varchar',
'length' => 128,
'not null' => FALSE,
),
2007-10-10 11:39:35 +00:00
'pid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2008-12-03 16:32:22 +00:00
'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.',
2007-10-10 11:39:35 +00:00
),
'nid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2008-11-15 13:01:11 +00:00
'description' => 'The {node}.nid to which this comment is a reply.',
2007-10-10 11:39:35 +00:00
),
'uid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2009-02-26 07:30:29 +00:00
'description' => 'The {users}.uid who authored the comment. If set to 0, this comment was created by an anonymous user.',
2007-10-10 11:39:35 +00:00
),
'subject' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
2008-11-15 13:01:11 +00:00
'description' => 'The comment title.',
2007-10-10 11:39:35 +00:00
),
'hostname' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
2008-11-15 13:01:11 +00:00
'description' => "The author's host name.",
2007-10-10 11:39:35 +00:00
),
2009-10-10 13:37:11 +00:00
'created' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The time that the comment was created, as a Unix timestamp.',
),
'changed' => array(
2007-10-10 11:39:35 +00:00
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2009-10-10 13:37:11 +00:00
'description' => 'The time that the comment was last edited, as a Unix timestamp.',
2007-10-10 11:39:35 +00:00
),
'status' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
2008-08-02 20:29:43 +00:00
'default' => 1,
2007-10-10 11:39:35 +00:00
'size' => 'tiny',
2008-11-15 13:01:11 +00:00
'description' => 'The published status of a comment. (0 = Not Published, 1 = Published)',
2007-10-10 11:39:35 +00:00
),
'thread' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
2011-10-01 19:32:36 +00:00
'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.",
2007-10-10 11:39:35 +00:00
),
'name' => array(
'type' => 'varchar',
'length' => 60,
'not null' => FALSE,
2009-02-26 07:30:29 +00:00
'description' => "The comment author's name. Uses {users}.name if the user is logged in, otherwise uses the value typed into the comment form.",
2007-10-10 11:39:35 +00:00
),
'mail' => array(
'type' => 'varchar',
'length' => 64,
'not null' => FALSE,
2008-11-15 13:01:11 +00:00
'description' => "The comment author's e-mail address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on.",
2007-10-10 11:39:35 +00:00
),
'homepage' => array(
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
2008-11-15 13:01:11 +00:00
'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.",
2009-10-16 03:40:40 +00:00
),
2012-02-21 15:55:52 +00:00
'langcode' => array(
2012-01-10 15:29:08 +00:00
'description' => 'The {language}.langcode of this comment.',
2009-10-16 03:40:40 +00:00
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
),
2007-10-05 14:43:26 +00:00
),
'indexes' => array(
2009-06-15 19:28:55 +00:00
'comment_status_pid' => array('pid', 'status'),
2010-02-17 05:31:31 +00:00
'comment_num_new' => array('nid', 'status', 'created', 'cid', 'thread'),
2009-08-09 02:46:27 +00:00
'comment_uid' => array('uid'),
2012-02-21 15:55:52 +00:00
'comment_nid_langcode' => array('nid', 'langcode'),
2011-05-14 17:30:10 +00:00
'comment_created' => array('created'),
2007-10-05 14:43:26 +00:00
),
'primary key' => array('cid'),
2012-08-07 18:33:39 +00:00
'unique keys' => array(
'uuid' => array('uuid'),
),
2009-06-01 22:07:10 +00:00
'foreign keys' => array(
2010-08-22 13:55:53 +00:00
'comment_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
'comment_author' => array(
'table' => 'users',
'columns' => array('uid' => 'uid'),
),
2009-06-01 22:07:10 +00:00
),
2007-10-05 14:43:26 +00:00
);
2007-12-08 14:06:23 +00:00
$schema['node_comment_statistics'] = array(
2008-11-15 13:01:11 +00:00
'description' => 'Maintains statistics of node and comments posts to show "new" and "updated" flags.',
2007-12-08 14:06:23 +00:00
'fields' => array(
'nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
2008-11-15 13:01:11 +00:00
'description' => 'The {node}.nid for which the statistics are compiled.',
2007-12-08 14:06:23 +00:00
),
2009-11-12 06:46:44 +00:00
'cid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The {comment}.cid of the last comment.',
),
2007-12-08 14:06:23 +00:00
'last_comment_timestamp' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2011-08-02 00:23:15 +00:00
'description' => 'The Unix timestamp of the last comment that was posted within this node, from {comment}.changed.',
2007-12-08 14:06:23 +00:00
),
'last_comment_name' => array(
'type' => 'varchar',
'length' => 60,
'not null' => FALSE,
2008-12-03 16:32:22 +00:00
'description' => 'The name of the latest author to post a comment on this node, from {comment}.name.',
2007-12-08 14:06:23 +00:00
),
'last_comment_uid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2008-12-03 16:32:22 +00:00
'description' => 'The user ID of the latest author to post a comment on this node, from {comment}.uid.',
2007-12-08 14:06:23 +00:00
),
'comment_count' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
2008-11-15 13:01:11 +00:00
'description' => 'The total number of comments on this node.',
2007-12-08 14:06:23 +00:00
),
),
'primary key' => array('nid'),
2007-12-18 12:59:22 +00:00
'indexes' => array(
2008-03-15 12:31:29 +00:00
'node_comment_timestamp' => array('last_comment_timestamp'),
2009-07-30 19:27:11 +00:00
'comment_count' => array('comment_count'),
2009-08-09 02:46:27 +00:00
'last_comment_uid' => array('last_comment_uid'),
2007-12-18 12:59:22 +00:00
),
2009-06-01 22:07:10 +00:00
'foreign keys' => array(
2010-08-22 13:55:53 +00:00
'statistics_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
'last_comment_author' => array(
'table' => 'users',
'columns' => array(
'last_comment_uid' => 'uid',
),
),
2009-06-01 22:07:10 +00:00
),
2007-10-05 14:43:26 +00:00
);
return $schema;
2009-10-10 13:37:11 +00:00
}
2012-02-21 15:55:52 +00:00
/**
* @addtogroup updates-7.x-to-8.x
* @{
*/
/**
* Renames {comment}.language to {comment}.langcode.
*/
function comment_update_8000() {
2012-03-02 19:54:43 +00:00
db_drop_index('comment', 'comment_nid_language');
2012-02-21 15:55:52 +00:00
$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'));
}
2012-08-07 18:33:39 +00:00
/**
* Create a UUID column for comments.
*
* @todo UUID upgrade path: http://drupal.org/node/1642526
*/
function comment_update_8001() {
$spec = array(
'description' => 'Unique Key: Universally unique identifier for this entity.',
'type' => 'varchar',
'length' => 128,
'not null' => FALSE,
);
$keys = array(
'unique keys' => array(
'uuid' => array('uuid'),
),
);
// Account for sites having the contributed UUID module installed.
if (db_field_exists('comment', 'uuid')) {
db_change_field('comment', 'uuid', 'uuid', $spec, $keys);
}
else {
db_add_field('comment', 'uuid', $spec, $keys);
}
}
2012-02-21 15:55:52 +00:00
/**
2012-05-17 12:58:49 +00:00
* @} End of "addtogroup updates-7.x-to-8.x".
2012-02-21 15:55:52 +00:00
* The next series of updates should start at 9000.
*/