2006-12-13 10:24:58 +00:00
<?php
// $Id$
2009-05-13 19:42:18 +00:00
/**
* @file
* Install, update and uninstall functions for the comment module.
*/
2009-01-19 01:23:39 +00:00
/**
2009-05-27 18:34:03 +00:00
* Implement hook_install().
2009-01-19 01:23:39 +00:00
*/
function comment_install() {
// Create tables.
drupal_install_schema('comment');
}
/**
2009-05-27 18:34:03 +00:00
* Implement hook_uninstall().
2009-01-19 01:23:39 +00:00
*/
function comment_uninstall() {
// Remove tables.
drupal_uninstall_schema('comment');
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) {
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-05-27 18:34:03 +00:00
* Implement 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');
$query->addField('n', 'changed', '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();
2007-07-15 10:05:18 +00:00
}
/**
2007-12-16 21:01:45 +00:00
* Changed node_comment_statistics to use node->changed to avoid future timestamps.
2007-07-15 10:05:18 +00:00
*/
function comment_update_1() {
2008-05-14 13:12:41 +00:00
// Change any future last comment timestamps to current time.
2008-09-17 07:11:59 +00:00
db_query('UPDATE {node_comment_statistics} SET last_comment_timestamp = %d WHERE last_comment_timestamp > %d', REQUEST_TIME, REQUEST_TIME);
2007-07-15 10:05:18 +00:00
// Unstuck node indexing timestamp if needed.
if (($last = variable_get('node_cron_last', FALSE)) !== FALSE) {
2008-09-17 07:11:59 +00:00
variable_set('node_cron_last', min(REQUEST_TIME, $last));
2007-07-15 10:05:18 +00:00
}
2008-05-14 13:12:41 +00:00
2007-07-15 10:05:18 +00:00
return array();
2007-11-26 19:55:15 +00:00
}
2008-07-03 17:57:03 +00:00
/**
* @defgroup updates-6.x-to-7.x Comment updates from 6.x to 7.x
* @{
*/
/**
* Remove comment settings for page ordering.
*/
function comment_update_7000() {
2009-06-04 03:33:29 +00:00
$types = node_type_get_types();
2008-07-03 17:57:03 +00:00
foreach ($types as $type => $object) {
variable_del('comment_default_order' . $type);
}
return array(array('success' => TRUE, 'query' => 'Comment order settings removed.'));
}
2008-08-02 20:29:43 +00:00
/**
* Change comment status from published being 0 to being 1
*/
function comment_update_7001() {
$ret = array();
$ret[] = update_sql("UPDATE {comments} SET status = 3 WHERE status = 0");
$ret[] = update_sql("UPDATE {comments} SET status = 0 WHERE status = 1");
$ret[] = update_sql("UPDATE {comments} SET status = 1 WHERE status = 3");
return $ret;
}
2008-12-03 16:32:22 +00:00
/**
* Rename {comments} table to {comment}.
*/
function comment_update_7002() {
$ret = array();
db_rename_table($ret, 'comments', 'comment');
return $ret;
}
2009-06-15 19:28:55 +00:00
/**
* Improve indexes on the comment table.
*/
function comment_update_7003() {
$ret = array();
db_drop_index($ret, 'comment', 'status');
2009-06-16 20:50:26 +00:00
db_drop_index($ret, 'comment', 'pid');
2009-06-15 19:28:55 +00:00
db_add_index($ret, 'comment', 'comment_pid_status', array('pid', 'status'));
db_add_index($ret, 'comment', 'comment_num_new', array('nid', 'timestamp', 'status'));
return $ret;
}
2009-07-01 12:06:22 +00:00
/**
* Rename comment display setting variables.
*/
function comment_update_7004() {
$types = node_type_get_types();
foreach ($types as $type => $object) {
$setting = variable_get('comment_default_mode_' . $type, 4);
if ($setting == 3 || $setting == 4) {
variable_set('comment_default_mode_' . $type, 1);
}
else {
variable_set('comment_default_mode_' . $type, 0);
}
}
return array();
}
2008-07-03 17:57:03 +00:00
/**
* @} End of "defgroup updates-6.x-to-7.x"
* The next series of updates should start at 8000.
*/
2008-01-05 22:45:40 +00:00
2007-10-05 14:43:26 +00:00
/**
2009-05-27 18:34:03 +00:00
* Implement 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
),
'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
),
'comment' => array(
'type' => 'text',
'not null' => TRUE,
'size' => 'big',
2008-11-15 13:01:11 +00:00
'description' => 'The comment body.',
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
),
'timestamp' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2008-11-15 13:01:11 +00:00
'description' => 'The time that the comment was created, or last edited by its author, 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
),
'format' => array(
'type' => 'int',
'size' => 'small',
'not null' => TRUE,
'default' => 0,
2008-12-03 16:32:22 +00:00
'description' => 'The {filter_format}.format of the comment body.',
2007-10-10 11:39:35 +00:00
),
'thread' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
2008-11-15 13:01:11 +00:00
'description' => "The vancode representation of the comment's place in a thread.",
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.",
2007-10-10 11:39:35 +00:00
)
2007-10-05 14:43:26 +00:00
),
'indexes' => array(
2009-06-15 19:28:55 +00:00
'comment_status_pid' => array('pid', 'status'),
'comment_num_new' => array('nid', 'timestamp', 'status'),
2007-10-05 14:43:26 +00:00
),
'primary key' => array('cid'),
2009-06-01 22:07:10 +00:00
'foreign keys' => array(
'nid' => array('node' => 'nid'),
),
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
),
'last_comment_timestamp' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
2008-12-03 16:32:22 +00:00
'description' => 'The Unix timestamp of the last comment that was posted within this node, from {comment}.timestamp.',
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'),
2007-12-18 12:59:22 +00:00
),
2009-06-01 22:07:10 +00:00
'foreign keys' => array(
'nid' => array('node' => 'nid'),
),
2007-10-05 14:43:26 +00:00
);
return $schema;
}