Merge branch 'release/2.0.4'

Author: pbchase

AUTHORS.md

@@ -0,0 +1,7 @@
+# AUTHORS
+
+Warn User of Pending Suspension would not be possible without generous contributions from our authors and funders.
+
+David R Nelson, Director of the University of Florida Clinical Translational Science Institute, provides funding support for the UF CTSI REDCap team via UF CTSA Award and matching funds from the UF Office of Research.
+
+We want to thank our developers Kyle Chesney kyle.chesney@ufl.edu, Taryn Stoffs tls@ufl.edu, Philip Chase pbc@ufl.edu, Marly Cormar marlycormar@ufl.edu, Tiago Bember tbembersimeao@ufl.edu, and Christopher Barnes cpb@ufl.edu for their contributions to the project.

CHANGELOG.md

@@ -2,7 +2,16 @@
 All notable changes to the REDCap Warn Users of Pending Suspension project will be documented in this file.
 
 
-## [2.0.2] - 2019-10-01
+## [2.0.4] - 2020-02-03
+### Changed
+- Revise the developer testing instructions (Philip Chase)
+- Stop calling ExternalModules class directly to address an issue reported in REDCap 9.6.3 (Kyle Chesney)
+
+### Added
+- Add AUTHORS.md (Philip Chase)
+
+
+## [2.0.3] - 2019-10-01
 ### Changed
 - Ensure project_contact_email is from global scope (Kyle Chesney)
 - Correct wording. (Marly Cormar)

ExternalModule.php

@@ -7,7 +7,6 @@
 namespace SuspensionWarning\ExternalModule;
 
 use ExternalModules\AbstractExternalModule;
-use ExternalModules\ExternalModules;
 use REDCap;
 use Logging;
 
@@ -94,7 +93,7 @@ function warn_users_account_suspension_cron()
 					) as my_user_info
 					where '$suspend_users_inactive_days' - DATEDIFF(NOW(), user_last_date) = '$day';";
 
-			$q = ExternalModules::query($sql);
+			$q = $this->query($sql);
 
 			while ($row = db_fetch_assoc($q))
 			{

README.md

@@ -90,23 +90,25 @@ To test WUPS, you need to turn on a few REDCap features it interacts with.  You
     update redcap_config set value="1" where field_name = "suspend_users_inactive_send_email";
     update redcap_config set value="30" where field_name = "suspend_users_inactive_days";
 
-As this tool sends emails, make sure the field that will be used for the **Sender Email** address is configured correctly in your module configuration.
+This module has to be configured before you can do anything with it. The instructions that follow assume the module has been configured as described in _Email Configuration Example_ above. The _Days Before Suspension_ setting of `10, 12, 20` is especially important. As this tool sends emails, also make sure the field that will be used for the **Sender Email** address is configured correctly in your module configuration.
 
-You'll also need some test users.  To revise the set of test users `alice`, `bob`, `dan`, and `carol` to receive messages based on the above configuration, change their `user_lastlogin` and `user_lastactivity` dates as follows:
+You'll need some test users. Assuming you have a set of test users `alice`, `bob`, `carol`, and `dan` you can configure them to receive alerts _today_ by adjusting their `user_lastlogin` and `user_lastactivity` dates as follows:
 
     update redcap_user_information set user_lastlogin = date_add(now(), interval -22 day), user_lastactivity = date_add(now(), interval -10 day) where username='alice';
     update redcap_user_information set user_lastlogin = date_add(now(), interval -18 day), user_lastactivity = NULL where username='bob';
     update redcap_user_information set user_lastlogin = date_add(now(), interval -10 day), user_lastactivity = date_add(now(), interval -25 day) where username='carol';
     update redcap_user_information set user_lastlogin = null, user_lastactivity = date_add(now(), interval -20 day) where username='dan';
 
-    update redcap_user_information set user_email = 'you@example.org' where username in ("alice", "bob", "carol", "dan");
+If you are testing REDCap under [redcap-docker-compose](https://github.com/123andy/redcap-docker-compose), the automatic table-based user creation tools can make these users for you. If you are testing under a [redcap_deployment](https://github.com/ctsit/redcap_deployment) Vagrant VM, the above set of test users can be created via the SQL file at [https://github.com/ctsit/redcap_deployment/blob/master/deploy/files/test\_with\_table\_based\_authentication.sql](https://github.com/ctsit/redcap_deployment/blob/master/deploy/files/test_with_table_based_authentication.sql). People testing in other environments will need to design their own set of test cases.
+
+To get the alerts from these test users, you'll want to update their email addresses with _your_ email address. e.g.,
 
-When tested, each of the aforementioned users should get a message. FYI, the above set of test users can be created via the SQL file at [https://github.com/ctsit/redcap_deployment/blob/master/deploy/files/test\_with\_table\_based\_authentication.sql](https://github.com/ctsit/redcap_deployment/blob/master/deploy/files/test_with_table_based_authentication.sql). That SQL file works great for users of the redcap_deployment project. Other users might want to be cautious as the SQL makes some assumptions.
+    update redcap_user_information set user_email = 'you@example.org' where username in ("alice", "bob", "carol", "dan");
 
-The final step to facilitate testing is to turn the frequency of the cron job up.  You'll need to change `cron_frequency` and `cron_max_run_time` so that the cron job runs more often. Here's the lazy developer's SQL method to do that:
+The final step to facilitate testing is to adjust the frequency of the cron job. The external module framework monitors the cron configuration settings in a module's `config.json`. If you change the cron frequency in that file to 60 seconds, the EM framework will, shortly thereafter, do the same to the module's cron job:
 
-    update redcap_crons set cron_frequency = 60, cron_max_run_time = 10 where cron_name = "warn_users_account_suspension_cron";
+    "cron_frequency": "60",
 
-Revert the setting to the defaults with this SQL when you are done with testing:
+Turn that value back down to `86400` (that's the number of seconds in one day) when you are done to get back to the normal configuration.
 
-    update redcap_crons set cron_frequency = 86400, cron_max_run_time = 1200 where cron_name = "warn_users_account_suspension_cron";
+All of these SQL commands and more are rolled up in [developer_testing_commands.sql](developer_testing_commands.sql). Open this file in your favorite SQL tool and run the commands one section at a time to see the relevant database state.

config.json

@@ -7,11 +7,6 @@
     ],
     "enable-every-page-hooks-on-system-pages": true,
     "authors": [
-        {
-            "name": "Marly Cormar",
-            "email": "marlycormar@ufl.edu",
-            "institution": "University of Florida - CTSI"
-        },
         {
             "name": "Philip Chase",
             "email": "pbc@ufl.edu",
@@ -22,11 +17,6 @@
             "email": "tls@ufl.edu",
             "institution": "University of Florida - CTSI"
         },
-        {
-            "name": "Tiago Bember",
-            "email": "tbembersimeao@ufl.edu",
-            "institution": "University of Florida - CTSI"
-        },
         {
             "name": "Kyle Chesney",
             "email": "kyle.chesney@ufl.edu",

developer_testing_commands.sql

@@ -0,0 +1,55 @@
+-- Execute these SQL commands to (re)configure and test WUPS
+
+-- configure
+update redcap_config set value="all" where field_name = "suspend_users_inactive_type";
+update redcap_config set value="1" where field_name = "suspend_users_inactive_send_email";
+update redcap_config set value="30" where field_name = "suspend_users_inactive_days";
+
+update redcap_user_information set user_lastlogin = date_add(now(), interval -22 day), user_lastactivity = date_add(now(), interval -10 day) where username='alice';
+update redcap_user_information set user_lastlogin = date_add(now(), interval -18 day), user_lastactivity = NULL where username='bob';
+update redcap_user_information set user_lastlogin = date_add(now(), interval -10 day), user_lastactivity = date_add(now(), interval -25 day) where username='carol';
+update redcap_user_information set user_lastlogin = null, user_lastactivity = date_add(now(), interval -20 day) where username='dan';
+
+update redcap_user_information set user_email = 'pbc@ufl.edu' where username in ("admin","alice", "bob", "carol", "dan");
+
+update redcap_crons set cron_frequency = 60, cron_max_run_time = 10 where cron_name = "warn_users_account_suspension_cron";
+
+-- Adjust the cron frequency now!
+update redcap_crons set cron_frequency = 60 where cron_id > 34;
+
+-- reset everyone's last login and last activity dates
+update redcap_user_information set user_lastlogin = date_add(now(), interval -22 day), user_lastactivity = date_add(now(), interval -10 day) where username='alice';
+update redcap_user_information set user_lastlogin = date_add(now(), interval -18 day), user_lastactivity = NULL where username='bob';
+update redcap_user_information set user_lastlogin = date_add(now(), interval -10 day), user_lastactivity = date_add(now(), interval -25 day) where username='carol';
+update redcap_user_information set user_lastlogin = null, user_lastactivity = date_add(now(), interval -20 day) where username='dan';
+
+-- Verify the above query worked
+select * from (
+select username, user_email, user_sponsor, user_firstname, user_lastname, user_lastactivity, user_lastlogin,
+(case
+when user_lastactivity is not null and user_lastlogin is not null then greatest(user_lastlogin, user_lastactivity)
+when user_lastactivity is not null then user_lastactivity
+when user_lastlogin is not null then user_lastlogin
+when user_creation is not null then user_creation
+end) as user_last_date
+from redcap_user_information
+where user_suspended_time is null
+) as my_user_info
+where 30 - DATEDIFF(NOW(), user_last_date) in (10,12,20);
+
+-- verify the module has a cron job
+SELECT * FROM `redcap_crons`
+WHERE cron_id > 34
+order by cron_id desc;
+
+-- verify the module's config
+select * from redcap_external_module_settings
+where external_module_id in (
+SELECT external_module_id FROM `redcap_external_modules` 
+where directory_prefix = 'warn_users_of_pending_suspension');
+
+-- verify the cron history
+SELECT * FROM `redcap_crons_history` as ch
+inner join redcap_crons as c on (ch.cron_id = c.cron_id)
+WHERE c.cron_name = 'warn_users_account_suspension_cron'
+order by ch_id desc;