GHOP #155: Write hook_uninstall: Task 1

Task Description:

This isn't specific to coder, but to a multitude of modules.

Check that all of the listed modules below have .install files, that they have a hook_uninstall. and that the hook_uninstall deletes all tables and variables (using variable_del). It should delete any tables that are created in hook_install. And it should delete any variables that are created. Variables are usually created through the call to variable_set, but they can also be created through the settings forms (look for the function that defines system_settings_form).

You don't need a local sandbox, but having one would be best. It's always best to run the code before submitting a patch. But since this is a fairly repetitive task, and in most cases you'll be creating a new .install file, the local sandbox isn't a "hard" requirement.

A sample hook_uninstall, taken from phpass, is:

function phpass_uninstall() {
  db_query("DROP TABLE {user_phpass}");
  variable_del('user_hash_method');
  variable_del('user_hash_strength');
  variable_del('user_hash_portable');
}

Before you start on any one module, you should check the modules issue queue to make sure that a patch hasn't been submitted. Please add a comment to this issue when you complete a module. I'll also try to check them off in the module description, as the issues are marked RTBC or Fixed.

This is two GHOP tasks (see also Task 2).

Task 1:

1. CiviCRM Active User
2. CiviCRM Count Block
3. CiviCRM Theme
4. Coder
5. Short Form

Coder is the only big module in Task 1. You'll need to look at _coder_settings_form(). Three of the modules are related to CiviCRM. You don't absolutely need CiviCRM to complete this task, but learning about CiviCRM would be a good thing.

Deliverables:

• create a Drupal issue against each module and submit a patch file for 5.x. If there is already a .install file, then be sure to submit the patch against the latest version on the DRUPAL-5 or DRUPAL-5--2 branches. You'll need to know how to create a patch file that adds a new file. The deliverable is not complete until the issue is reviewed and the status is set to either RTBC or Fixed (i.e., committed).
• If a module is up-to-date and doesn't need a patch file, add a comment to this issue, saying that you checked the module and that it doesn't need to be patched.

Resources:

• api.drupal.org: hook_uninstall, variable_del, system_settings_form
• Patch files and Creating patches
• General GHOP Resources

Primary Contact: Doug Green