danielebarchiesi@2: 'This table describes which challenges should be added to which forms.',
danielebarchiesi@2: 'fields' => array(
danielebarchiesi@2: 'form_id' => array(
danielebarchiesi@2: 'description' => 'The form_id of the form to add a CAPTCHA to.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => '',
danielebarchiesi@2: ),
danielebarchiesi@2: 'module' => array(
danielebarchiesi@2: 'description' => 'The module that provides the challenge.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 64,
danielebarchiesi@2: ),
danielebarchiesi@2: 'captcha_type' => array(
danielebarchiesi@2: 'description' => 'The challenge type to use.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 64,
danielebarchiesi@2: ),
danielebarchiesi@2: ),
danielebarchiesi@2: 'primary key' => array('form_id'),
danielebarchiesi@2: );
danielebarchiesi@2: // Table for the CAPTCHA sessions.
danielebarchiesi@2: $schema['captcha_sessions'] = array(
danielebarchiesi@2: 'description' => 'Stores the data about CAPTCHA sessions (solution, IP address, timestamp, ...).',
danielebarchiesi@2: 'fields' => array(
danielebarchiesi@2: 'csid' => array(
danielebarchiesi@2: 'description' => 'CAPTCHA session ID.',
danielebarchiesi@2: 'type' => 'serial',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'token' => array(
danielebarchiesi@2: 'description' => 'One time CAPTCHA token.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 64,
danielebarchiesi@2: 'not null' => FALSE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'uid' => array(
danielebarchiesi@2: 'description' => "User's {users}.uid.",
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: ),
danielebarchiesi@2: 'sid' => array(
danielebarchiesi@2: 'description' => "Session ID of the user.",
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 64,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => '',
danielebarchiesi@2: ),
danielebarchiesi@2: 'ip_address' => array(
danielebarchiesi@2: 'description' => 'IP address of the visitor.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => FALSE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'timestamp' => array(
danielebarchiesi@2: 'description' => 'A Unix timestamp indicating when the challenge was generated.',
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: ),
danielebarchiesi@2: 'form_id' => array(
danielebarchiesi@2: 'description' => 'The form_id of the form where the CAPTCHA is added to.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'solution' => array(
danielebarchiesi@2: 'description' => 'Solution of the challenge.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => '',
danielebarchiesi@2: ),
danielebarchiesi@2: 'status' => array(
danielebarchiesi@2: 'description' => 'Status of the CAPTCHA session (unsolved, solved, ...)',
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: ),
danielebarchiesi@2: 'attempts' => array(
danielebarchiesi@2: 'description' => 'The number of attempts.',
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: )
danielebarchiesi@2: ),
danielebarchiesi@2: 'primary key' => array('csid'),
danielebarchiesi@2: 'indexes' => array(
danielebarchiesi@2: 'csid_ip' => array('csid', 'ip_address'),
danielebarchiesi@2: ),
danielebarchiesi@2: );
danielebarchiesi@2:
danielebarchiesi@2: return $schema;
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_requirements().
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_requirements($phase) {
danielebarchiesi@2: $requirements = array();
danielebarchiesi@2: $t = get_t();
danielebarchiesi@2: if ($phase == 'runtime' && variable_get('captcha_enable_stats', FALSE)) {
danielebarchiesi@2: // Show the wrong response counter in the status report.
danielebarchiesi@2: $requirements['captcha_wrong_response_counter'] = array(
danielebarchiesi@2: 'title' => $t('CAPTCHA'),
danielebarchiesi@2: 'value' => format_plural(
danielebarchiesi@2: variable_get('captcha_wrong_response_counter', 0),
danielebarchiesi@2: 'Already 1 blocked form submission',
danielebarchiesi@2: 'Already @count blocked form submissions'
danielebarchiesi@2: ),
danielebarchiesi@2: 'severity' => REQUIREMENT_INFO,
danielebarchiesi@2: );
danielebarchiesi@2: }
danielebarchiesi@2: return $requirements;
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_install().
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_install() {
danielebarchiesi@2: $t = get_t();
danielebarchiesi@2: // Insert some default CAPTCHA points.
danielebarchiesi@2: $form_ids = array(
danielebarchiesi@2: 'contact_site_form', 'contact_personal_form',
danielebarchiesi@2: 'user_register_form', 'user_pass', 'user_login', 'user_login_block',
danielebarchiesi@2: 'forum_node_form'
danielebarchiesi@2: );
danielebarchiesi@2: // Add form_ids of all currently known node types too.
danielebarchiesi@2: foreach (node_type_get_names() as $type => $name) {
danielebarchiesi@2: $form_ids[] = 'comment_node_' . $type . '_form';
danielebarchiesi@2: }
danielebarchiesi@2: foreach ($form_ids as $form_id) {
danielebarchiesi@2: db_insert('captcha_points')
danielebarchiesi@2: ->fields(array(
danielebarchiesi@2: 'form_id' => $form_id,
danielebarchiesi@2: 'module' => NULL,
danielebarchiesi@2: 'captcha_type' => NULL,
danielebarchiesi@2: ))
danielebarchiesi@2: ->execute();
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: // Be friendly to your users: what to do after install?
danielebarchiesi@2: drupal_set_message($t('You can now configure the CAPTCHA module for your site.',
danielebarchiesi@2: array('!captcha_admin' => url('admin/config/people/captcha'))), 'status');
danielebarchiesi@2:
danielebarchiesi@2: // Explain to users that page caching may be disabled.
danielebarchiesi@2: if (variable_get('cache', 0) != 0) {
danielebarchiesi@2: drupal_set_message($t('Note that the CAPTCHA module disables page caching of pages that include a CAPTCHA challenge.',
danielebarchiesi@2: array('!performance_admin' => url('admin/config/development/performance'))), 'warning');
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_uninstall().
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_uninstall() {
danielebarchiesi@2: drupal_uninstall_schema('captcha');
danielebarchiesi@2: db_query("DELETE FROM {variable} WHERE name LIKE 'captcha_%'");
danielebarchiesi@2: cache_clear_all('variables', 'cache');
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_update_N()
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_update_6200() {
danielebarchiesi@2: $items = array();
danielebarchiesi@2:
danielebarchiesi@2: // Table for the CAPTCHA sessions.
danielebarchiesi@2: $schema['captcha_sessions'] = array(
danielebarchiesi@2: 'description' => 'Stores the data about CAPTCHA sessions (solution, IP address, timestamp, ...).',
danielebarchiesi@2: 'fields' => array(
danielebarchiesi@2: 'csid' => array(
danielebarchiesi@2: 'description' => 'CAPTCHA session ID.',
danielebarchiesi@2: 'type' => 'serial',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'uid' => array(
danielebarchiesi@2: 'description' => "User's {users}.uid.",
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: ),
danielebarchiesi@2: 'sid' => array(
danielebarchiesi@2: 'description' => "Session ID of the user.",
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 64,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => '',
danielebarchiesi@2: ),
danielebarchiesi@2: 'ip_address' => array(
danielebarchiesi@2: 'description' => 'IP address of the visitor.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => FALSE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'timestamp' => array(
danielebarchiesi@2: 'description' => 'A Unix timestamp indicating when the challenge was generated.',
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: ),
danielebarchiesi@2: 'form_id' => array(
danielebarchiesi@2: 'description' => 'The form_id of the form where the CAPTCHA is added to.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: ),
danielebarchiesi@2: 'solution' => array(
danielebarchiesi@2: 'description' => 'Solution of the challenge.',
danielebarchiesi@2: 'type' => 'varchar',
danielebarchiesi@2: 'length' => 128,
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => '',
danielebarchiesi@2: ),
danielebarchiesi@2: 'status' => array(
danielebarchiesi@2: 'description' => 'Status of the CAPTCHA session (unsolved, solved, ...)',
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: ),
danielebarchiesi@2: 'attempts' => array(
danielebarchiesi@2: 'description' => 'The number of attempts.',
danielebarchiesi@2: 'type' => 'int',
danielebarchiesi@2: 'not null' => TRUE,
danielebarchiesi@2: 'default' => 0,
danielebarchiesi@2: )
danielebarchiesi@2: ),
danielebarchiesi@2: 'primary key' => array('csid'),
danielebarchiesi@2: 'indexes' => array(
danielebarchiesi@2: 'csid_ip' => array('csid', 'ip_address'),
danielebarchiesi@2: ),
danielebarchiesi@2: );
danielebarchiesi@2:
danielebarchiesi@2: db_create_table($items, 'captcha_sessions', $schema['captcha_sessions']);
danielebarchiesi@2:
danielebarchiesi@2: return $items;
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_update_N()
danielebarchiesi@2: * Change the captcha points with the old text CAPTCHA, which was
danielebarchiesi@2: * removed from the 6.x-2.x branch, to the simple math CAPTCHA.
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_update_6201() {
danielebarchiesi@2: $items = array();
danielebarchiesi@2: $items[] = update_sql("UPDATE {captcha_points} SET module = 'captcha', type = 'Math' WHERE module = 'text_captcha' AND type = 'Text';");
danielebarchiesi@2: return $items;
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_update_N()
danielebarchiesi@2: * Add a CAPTCHA token column to captcha_sessions table.
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_update_6202() {
danielebarchiesi@2: $ret = array();
danielebarchiesi@2: db_add_column($ret, 'captcha_sessions', 'token', 'varchar(64)');
danielebarchiesi@2: return $ret;
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2:
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Implementation of hook_update_N()
danielebarchiesi@2: * Rename the type field to captcha_type in captcha_points.
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_update_6203() {
danielebarchiesi@2: $ret = array();
danielebarchiesi@2: db_change_field($ret, 'captcha_points', 'type', 'captcha_type', array('type' => 'varchar', 'length' => 64));
danielebarchiesi@2: return $ret;
danielebarchiesi@2: }
danielebarchiesi@2:
danielebarchiesi@2:
danielebarchiesi@2: /**
danielebarchiesi@2: * Migrate form configuration for changed form ids in Drupal 7.
danielebarchiesi@2: */
danielebarchiesi@2: function captcha_update_7000() {
danielebarchiesi@2: // 'user_register' became 'user_register_form'.
danielebarchiesi@2: db_update('captcha_points')
danielebarchiesi@2: ->fields(array('form_id' => 'user_register_form'))
danielebarchiesi@2: ->condition('form_id', 'user_register')
danielebarchiesi@2: ->execute();
danielebarchiesi@2: // 'contact_mail_page' became 'contact_site_form'.
danielebarchiesi@2: db_update('captcha_points')
danielebarchiesi@2: ->fields(array('form_id' => 'contact_site_form'))
danielebarchiesi@2: ->condition('form_id', 'contact_mail_page')
danielebarchiesi@2: ->execute();
danielebarchiesi@2: // 'contact_mail_user' became 'contact_personal_form'.
danielebarchiesi@2: db_update('captcha_points')
danielebarchiesi@2: ->fields(array('form_id' => 'contact_personal_form'))
danielebarchiesi@2: ->condition('form_id', 'contact_mail_user')
danielebarchiesi@2: ->execute();
danielebarchiesi@2:
danielebarchiesi@2: // The D6-style comment_form form_id is split per node type
danielebarchiesi@2: // in D7: comment_node_{type}_form, e.g. comment_node_page_form.
danielebarchiesi@2: // Get the current settings for 'comment_form'.
danielebarchiesi@2: $captcha_point = db_query(
danielebarchiesi@2: "SELECT * FROM {captcha_points} WHERE form_id = :comment_form_id",
danielebarchiesi@2: array(':comment_form_id' => 'comment_form')
danielebarchiesi@2: )->fetchObject();
danielebarchiesi@2: if ($captcha_point !== FALSE) {
danielebarchiesi@2: // Create entries for D7-style node form IDs.
danielebarchiesi@2: $module = $captcha_point->module;
danielebarchiesi@2: $captcha_type = $captcha_point->captcha_type;
danielebarchiesi@2: foreach (node_type_get_names() as $type => $name) {
danielebarchiesi@2: $form_id = 'comment_node_' . $type . '_form';
danielebarchiesi@2: db_insert('captcha_points')
danielebarchiesi@2: ->fields(array(
danielebarchiesi@2: 'form_id' => $form_id,
danielebarchiesi@2: 'module' => $module,
danielebarchiesi@2: 'captcha_type' => $captcha_type,
danielebarchiesi@2: ))
danielebarchiesi@2: ->execute();
danielebarchiesi@2: }
danielebarchiesi@2: // Delete outdated entry.
danielebarchiesi@2: db_delete('captcha_points')
danielebarchiesi@2: ->condition('form_id', 'comment_form')
danielebarchiesi@2: ->execute();
danielebarchiesi@2: }
danielebarchiesi@2: }