[D7] Clear Cache Remotely

Hi Centas,

Similar Existing Modules

The project looks to be a good idea, as there is currently no out of the box way to clear caches without logging in / cli - as listed on https://drupal.org/node/42055

Coding / Formatting Standards

The code is clean and I could see no issues in it.

Allow IP whitelist by wildcard

One feature that I would like to see in the module configuration page is whitelisting IPs by wildcards - Ex: 106.51.161.* rather than individual IPs.

Too small for project application

Also I am afraid if this module will be eligible for a Project application - As the guideline #2.3 in Project application checklist ( https://drupal.org/node/1587704 ) says

Ensure your project contains a minimum of handwritten code.
We are currently discussing how much code we need, but everything with less than 120 lines of code or less than 5 functions cannot be seriously reviewed, that means we can't make sure you're able to write secure code and use Drupal's APIs correctly.

I am afraid if this pretty small module with <90 lines of code and 4 functions might not be eligible for an application.

Best
Tanay

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

Hi centas,

The module looks good now. I have a couple of small suggestions.

Best
Tanay

Removing review bonus tag, you have not done all manual reviews, you just posted the output of an automated review tool. Make sure to read through the source code of the other projects, as requested on the review bonus page.

Sorry for the delay. Make sure to review more project applications to complete your review bonus and this will get finished faster.

manual review:

1. _clear_cache_remotely_run(): @return doc block is wrong, this function does not return anything?
2. _clear_cache_remotely_run(): so this looks a bit vulnerable to DOS attacks. If I install the module and forget to setup a secret key then anyone can call the menu path with "0" as key and clear the cache repeatedly until the site goes down. I think you should add an empty() check for the key before continuing.

But otherwise looks almost ready, the DOS could be considered a security issue, so this is a blocker right now.

Hi Centas,

Great idea for a module! Some pointer before you release:

1. You can add your page callbacks for the admin interface to a seperate file, so they can be loaded when needed. Your .module file should be a small as reasonably possible to reduce memory load. You can read more on how to include files for page callbacks in hook_menu
2. Can you add a description on the configuration page how the Secret key is used? Suggestion: 'The secret key is added to the Clear Cache Remotely URL as a safety measure, for example: http://yourdomain.com/clear_cache_remotely/all/[secret key]
3. Instead of leaving the generation of the secret key to the administrator, can you generate a default secret key for example in hook_enable()? This will make sure Clear Cache Remotely uses a proper secret key by default and saves the site administrator some time.
4. clear_cache_remotely.module:82 Instead using die(json_encode($result)), you can use return drupal_json_output($result). This will set the correct http reponse header.
5. clear_cache_remotely.module:87 There is a mismatch in the replacement string (%ip vs. !ip). Suggestion: use @ip in both cases, since watchdog notices are typically in plain text.
6. clear_cache_remotely.module:154 $ips_whitelist is not used in the default code path and is set explicitly later, so you don't have to initialize the variable here. You can safely remove this line.

Hi centas,

Useful module thanks for creating.

Some minor things:

1. The module package is currently "Other", subjective but I'd suggest putting it under "Performance and scalability"
2. In your hook_menu, you have an empty line at the start which you don't have on other functions (minor inconsistency)
3. In your hook_menu you're not initialising the $items array which you are doing for your form in admin.inc
4. In "_clear_cache_remotely_run()" you're checking if the user has added a value for "clear_cache_remotely_key" using empty(). You don't need the functionality that empty() offer as the default is ''. I'd suggest just using:
   

   if (!$configuration_key) {
     return drupal_json_output($result);
   }
   

1) Ah, fair enough. Thanks for sharing the link too :)

Looks good to me! Assigning to kscheirer as he might have time to take a final look at this.

Removing review bonus tag, you can add it again if you have done another 3 reviews of other projects.

no objections for more than a week, so ...

Thanks for your contribution, centas!

I updated your account so you can promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

• Dries' post on Responsible maintainers
• Best practices for creating and maintaining projects
• Maintaining a drupal.org project with Git
• Commit messages - providing history and credit
• Release naming conventions.
• Helping maintainers in the issue queues

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thanks to the dedicated reviewer(s) as well.