DashboardAnalysisPlatformExternalModule.php

<?php
namespace Vanderbilt\DashboardAnalysisPlatformExternalModule;

use Exception;
use REDCap;
use ExternalModules\AbstractExternalModule;
use ExternalModules\ExternalModules;

class DashboardAnalysisPlatformExternalModule extends AbstractExternalModule
{
    /**
     * This cron will only perform actions once a day between the hours
     * of midnight and 6am, regardless of how often it is scheduled.
     * Scheduling it more often is required to ensure it runs at a predictable time.
     * For example, scheduling it for once every 10 minutes will guarantee that
     * it runs at the first available minute after 12:10am,
     * though it may run as soon as 12am.
     * This produces behavior similar to timed crons.
     * See the API Sync module's per project sync settings for a more advanced
     * example of this same concept.
     */
    function dashboardCacheCron($cronAttributes){
        $hourRange = 6;
        if(date('G') > $hourRange){
            // Only perform actions between 12am and 6am.
            return;
        }
		$thisCron = $cronAttributes['cron_name'];
		
		## Old way of checking cron status, check to prevent re-sending on upgrade
        $lastRunSettingName = 'last-cron-run-time';
		$lastRun = (int)$this->getSystemSetting($lastRunSettingName);
		$hoursSinceLastRun = (time()-$lastRun)/60/60;
		if($hoursSinceLastRun < $hourRange){
			// We're already run recently
			return;
		}
		
		$lastRunCronSettingName = 'last-cron-run-time-'.$thisCron;
		$lastRunThisCron = (int)$this->getSystemSetting($lastRunCronSettingName);
		$hoursSinceLastRun = (time()-$lastRunThisCron)/60/60;
		if($hoursSinceLastRun < $hourRange){
			// We're already run this cron recently
			return;
		}
		
		## Immediately log starting in case a second process spawns for this cron
		$this->setSystemSetting($lastRunCronSettingName, time());
		// Perform cron actions here
        foreach ($this->getProjectsWithModuleEnabled() as $project_id){
            try {
                $stop_cron = $this->getProjectSetting('stop-cron',$project_id);
                if(!$stop_cron) {
                    #CRONS
                    $filename = "dashboard_cache_file_" . $project_id . ".txt";
                    $q = $this->query("SELECT em.stored_name FROM redcap_edocs_metadata em 
                                    LEFT JOIN redcap_docs_to_edocs de ON em.doc_id = de.doc_id 
                                    LEFT JOIN redcap_docs rd ON rd.docs_id = de.docs_id 
                                    WHERE rd.project_id=? AND rd.docs_name=?",
                        [$project_id, $filename]);
                    $found = false;
                    while ($row = db_fetch_assoc($q)) {
                        $storedName = $row['stored_name'];
                        $today = strtotime(date("Ymd"));
                        $file_date = strtotime(date("Ymd", strtotime(explode("_pid" . $project_id . "_", $storedName)[0])));
                        #We make sure we only do this once a day
                        if ($today > $file_date) {
                            $found = true;
                            error_log("dashboardCacheFile PID " . $project_id . ", " . $cronAttributes['cron_name']);
                            include("callCron.php");
                        }
                    }
                    if (!$found) {
                        error_log("dashboardCacheFile PID " . $project_id . ", " . $cronAttributes['cron_name']);
                        include("callCron.php");
                    }
                }

            } catch (Throwable $e) {
                \REDCap::email('datacore@vumc.org', 'datacore@vumc.org',"Cron Error", $e->getMessage());
            }
        }
    }

    public function redcap_module_link_check_display($project_id, $link) {
        $privacy = $this->getProjectSetting('privacy',$project_id);
        if($privacy == "public"){
            $link['url'] = $this->getUrl("index.php"). "&NOAUTH";
//            return parent::redcap_module_link_check_display($project_id,$link);
        }
        #Let users always see the link/page if they are added into the project
        return true;
    }

    /**
     * Function to increase the Maximum Execution Time
     * @param $hours
     */
    public function increaseProcessingMax($hours) {
        require_once(APP_PATH_DOCROOT."Classes/System.php");

        \System::increaseMaxExecTime($hours * 3600);
    }

    public function validateS3Url($url){
        $parts = parse_url($url);
        #TODO match the URLs prefixes in the array with the framework function once available
        foreach([".s3.amazonaws.com"] as $suffix){
            if(ends_with($parts['host'], $suffix)){
                return $url;
            }
        }

        throw new \Exception('Only certain domains are allowed');
    }

    public function loadREDCapJS(){
        if (method_exists(get_parent_class($this), 'loadREDCapJS')) {
            parent::loadREDCapJS();
        } else {
            ?>
            <script src='<?=APP_PATH_WEBROOT?>Resources/webpack/js/bundle.js'></script>
            <?php
        }
    }
}
?>