ExternalModuleManager.php

<?php

namespace Stanford\ExternalModuleManager;

use \REDCap;
use Stanford\ExternalModuleDeployment;
use \REDCapEntity\EntityFactory;

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';
require_once "emLoggerTrait.php";
require_once "classes/User.php";
require_once "classes/Repository.php";
require_once("classes/Client.php");

/**
 * Class ExternalModuleManager
 * @package Stanford\ExternalModuleManager
 * @property array $externalModulesDBRecords
 * @property array $externalModulesREDCapRecords
 * @property \Project $project
 * @property \Stanford\ExternalModuleDeployment\ExternalModuleDeployment $deploymentEm
 * @property \REDCapEntity\EntityFactory $entityFactory
 * @property \Stanford\ExternalModuleManager\Client $client
 * @property  array $projectEMUsage
 * @property string $request
 * @property  array $instances
 * @property  array $projects
 * @property int $refreshProjectId
 */
class ExternalModuleManager extends \ExternalModules\AbstractExternalModule
{

    use emLoggerTrait;

    private $externalModulesDBRecords;

    private $externalModulesREDCapRecords;

    private $project;

    private $deploymentEm;

    private $entityFactory;

    private $projectEMUsage;

    private $client;

    private $request;

    private $instances;

    private $projects;

    private $refreshProjectId;

    private $customCharges;

    const DEVELOPMENT_STATUS = 0;
    const PRODUCTION_STATUS = 1;
    const ANALYSIS_STATUS = 2;
    const GITHUB_REPO_OPTION = 'module_source___1';

    public function __construct()
    {
        parent::__construct();
        // Other code to run when object is instantiated

        $this->setClient(new Client($this->getSystemSetting('api-token')));


        if (isset($_GET['pid']) && $_GET['pid'] != '') {

            $this->setInstances();

            $this->setProject(new \Project(filter_var($_GET['pid'], FILTER_SANITIZE_NUMBER_INT)));

            if ($this->getProjectSetting('external-module-deployment')) {
                $this->setDeploymentEm(\ExternalModules\ExternalModules::getModuleInstance($this->getProjectSetting('external-module-deployment')));
            }
        }
    }


    public function redcap_entity_types()
    {
        $types = [];

        $types['external_modules_utilization'] = [
            'label' => 'External Modules Utilization',
            'label_plural' => 'External Modules Utilization',
            'icon' => 'home_pencil',
            'properties' => [
                'instance' => [
                    'name' => 'REDCap Instance',
                    'type' => 'text',
                    'required' => true,
                    'default' => '1',
                    'choices' => [
                        '0' => 'som-dev',
                        '1' => 'som-prod',
                        '2' => 'lpch-dev',
                        '3' => 'lpch-prod',
                        '4' => 'shc-dev',
                        '5' => 'shc-prod',
                    ],
                ],
                'module_prefix' => [
                    'name' => 'Module Prefix',
                    'type' => 'text',
                    'required' => true,
                ],
                'version' => [
                    'name' => 'Version',
                    'type' => 'text',
                    'required' => false,
                ],
                'date' => [
                    'name' => 'Date Added',
                    'type' => 'date',
                    'required' => true,
                ],
                'globally_enabled' => [
                    'name' => 'Is it Globally Enabled?',
                    'type' => 'boolean',
                    'required' => true,
                ],
                'discoverable_in_project' => [
                    'name' => 'Discoverable by Regular Users?',
                    'type' => 'boolean',
                    'required' => true,
                ],
                'user_activate_permission' => [
                    'name' => 'Can be enabled by Regular Users?',
                    'type' => 'boolean',
                    'required' => true,
                ],
                'total_enabled_projects' => [
                    'name' => 'Total Number of Projects enabled this EM?',
                    'type' => 'integer',
                    'default' => '0',
                    'required' => true,
                ],
                'total_enabled_dev_projects' => [
                    'name' => 'Total Number of Projects in Dev Mode enabled this EM?',
                    'type' => 'integer',
                    'default' => '0',
                    'required' => true,
                ],
                'total_enabled_prod_projects' => [
                    'name' => 'Total Number of Projects in Production Mode enabled this EM?',
                    'type' => 'integer',
                    'default' => '',
                    'required' => true,
                ],
                'total_using_projects' => [
                    'name' => 'Total Number of Projects actually using the EM?',
                    'type' => 'text',
                    'required' => false,
                ],
                'maintenance_fees' => [
                    'name' => 'Monthly Maintenance fees',
                    'type' => 'integer',
                    'required' => false,
                ],
            ],
            'special_keys' => [
                'label' => 'module_prefix', // "name" represents the entity label.
            ],
        ];

        $types['external_modules_charges'] = [
            'label' => 'External Modules Monthly Charges',
            'label_plural' => 'External Modules Utilization',
            'icon' => 'home_pencil',
            'properties' => [
                'instance' => [
                    'name' => 'REDCap Instance',
                    'type' => 'text',
                    'required' => true,
                    'default' => '1',
                    'choices' => [
                        '0' => 'som-dev',
                        '1' => 'som-prod',
                        '2' => 'lpch-dev',
                        '3' => 'lpch-prod',
                        '4' => 'shc-dev',
                        '5' => 'shc-prod',
                    ],
                ],
                'project_id' => [
                    'name' => 'Project',
                    'type' => 'project',
                    'required' => true,
                ],
                'module_prefix' => [
                    'name' => 'Module Prefix',
                    'type' => 'text',
                    'required' => true,
                ],
                'maintenance_fees' => [
                    'name' => 'Monthly Maintenance fees',
                    'type' => 'integer',
                    'required' => true,
                ],
                'charge_month' => [
                    'name' => 'Charge Month',
                    'type' => 'integer',
                    'required' => true,
                ],
                'charge_year' => [
                    'name' => 'Charge Year',
                    'type' => 'integer',
                    'required' => true,
                ],
                'viewed_at' => [
                    'name' => 'Timestamp last viewed',
                    'type' => 'date',
                    'required' => false,
                ],
                'deleted_at' => [
                    'name' => 'Timestamp record deleted',
                    'type' => 'date',
                    'required' => false,
                ],
                'r2p2_em_charge_id' => [
                    'name' => 'R2P2 charge Record Id',
                    'type' => 'integer',
                    'required' => false,
                ],
                'has_maintenance_fees' => [
                    'name' => 'Has maintenance fees?',
                    'type' => 'integer',
                    'required' => false,
                ],
            ],
            'special_keys' => [
                'label' => 'module_prefix', // "name" represents the entity label.
            ],
        ];

        $types['projects_overdue_payments'] = [
            'label' => 'REDCap projects overdue payment',
            'label_plural' => 'REDCap projects overdue payments',
            'icon' => 'home_pencil',
            'properties' => [
                'instance' => [
                    'name' => 'REDCap Instance',
                    'type' => 'text',
                    'required' => true,
                    'default' => '0',
                    'choices' => [
                        '0' => 'som-dev',
                        '1' => 'som-prod',
                        '2' => 'lpch-dev',
                        '3' => 'lpch-prod',
                        '4' => 'shc-dev',
                        '5' => 'shc-prod',
                    ],
                ],
                'project_id' => [
                    'name' => 'Project',
                    'type' => 'project',
                    'required' => true,
                ],
                'external_modules' => [
                    'name' => 'JSON object for Project External Modules',
                    'type' => 'json',
                    'required' => false,
                ],
                'monthly_payments' => [
                    'name' => 'Monthly Payment Amount',
                    'type' => 'integer',
                    'required' => true,
                ],
                'year' => [
                    'name' => 'Payment`s Year',
                    'type' => 'text',
                    'required' => false,
                ],
                'processed' => [
                    'name' => 'Payment processed',
                    'type' => 'boolean',
                    'required' => false,
                ],
                'month' => [
                    'name' => 'Payment`s Month',
                    'type' => 'text',
                    'required' => false,
                    'choices' => [
                        '1' => 'January',
                        '2' => 'February',
                        '3' => 'March',
                        '4' => 'April',
                        '5' => 'May',
                        '6' => 'June',
                        '7' => 'July',
                        '8' => 'August',
                        '9' => 'September',
                        '10' => 'October',
                        '11' => 'November',
                        '12' => 'December',
                    ],
                ],
            ],
            'special_keys' => [
                'label' => 'module_prefix', // "name" represents the entity label.
            ],
        ];

        $types['project_external_modules_usage'] = [
            'label' => 'Project External Module Usage',
            'label_plural' => 'Projects External Module Usage',
            'icon' => 'codebook',
            'properties' => [
                'instance' => [
                    'name' => 'REDCap Instance',
                    'type' => 'text',
                    'required' => true,
                    'default' => '0',
                    'choices' => [
                        '0' => 'som-dev',
                        '1' => 'som-prod',
                        '2' => 'lpch-dev',
                        '3' => 'lpch-prod',
                        '4' => 'shc-dev',
                        '5' => 'shc-prod',
                    ],
                ],
                'module_prefix' => [
                    'name' => 'Module Prefix',
                    'type' => 'text',
                    'required' => true,
                ],
                'project_id' => [
                    'name' => 'Project',
                    'type' => 'project',
                    'required' => true,
                ],
                'project_title' => [
                    'name' => 'Project Title',
                    'type' => 'text',
                    'required' => true,
                ],
                'rit_portal_project_id' => [
                    'name' => 'RIT Project',
                    'type' => 'integer',
                    'required' => false,
                ],
                'status' => [
                    'name' => 'Status',
                    'type' => 'text',
                    'default' => '0',
                    'choices' => [
                        '0' => 'Development',
                        '1' => 'Production',
                        '2' => 'Analysis',
                    ],
                    'required' => true,
                ],
                'record_count' => [
                    'name' => 'Number of Records',
                    'type' => 'integer',
                    'required' => true,
                ],
                'is_em_enabled' => [
                    'name' => 'Is EM Enabled?',
                    'type' => 'boolean',
                    'required' => false,
                ],
                'has_maintenance_fees' => [
                    'name' => 'Has Maintenance Fees?',
                    'type' => 'boolean',
                    'default' => '1',
                    'required' => false,
                ],
                'maintenance_fees' => [
                    'name' => 'Maintenance Fees',
                    'type' => 'integer',
                    'required' => false,
                ],
                'number_of_settings_rows' => [
                    'name' => 'Number of Settings Rows',
                    'type' => 'integer',
                    'required' => true,
                ],
            ],
            'special_keys' => [
                'label' => 'number', // "number" represents the entity label.
                #'project' => 'project_id', // "project_id" represents the project which the entity belongs to.
            ],
        ];


        return $types;
    }


    public function getEMTotalNumberOfProjects($externalModuleId, $status = '')
    {
        if (!$status) {
            $q = $this->query("select count(*) as count from redcap_projects where project_id IN (select project_id from redcap_external_module_settings where external_module_id = ? and `key` = 'enabled' and `value`= 'true')", [$externalModuleId, $status]);
        } else {
            $q = $this->query("select count(*) as count from redcap_projects where project_id IN (select project_id from redcap_external_module_settings where external_module_id = ? and `key` = 'enabled' and `value`= 'true') and status = ?", [$externalModuleId, $status]);
        }

        $row = db_fetch_assoc($q);
        return $row['count'];
    }

    /**
     * @return array
     *
     */
    public function getExternalModulesDBRecords()
    {
        if ($this->externalModulesDBRecords) {
            return $this->externalModulesDBRecords;
        } else {
            $this->setExternalModulesDBRecords();
            return $this->externalModulesDBRecords;
        }
    }

    /**
     * @param array $externalModulesDBRecords
     */
    public function setExternalModulesDBRecords(): void
    {
        try {
            $externalModulesDBRecords = array();
            $q = $this->query("select rem.external_module_id,rem.directory_prefix as module_prefix,   COUNT(DISTINCT rems.project_id) total_enabled_projects
from redcap_external_module_settings rems
         JOIN redcap_external_modules rem on rem.external_module_id = rems.external_module_id
GROUP BY rems.external_module_id ", []);

            while ($row = db_fetch_assoc($q)) {
                $em = $row;
                if (!$this->getExternalModulesREDCapRecords()[$row['module_prefix']]) {
                    if ($row['module_prefix'] != '') {
                        $this->createExternalModuleREDCapRecord($row['external_module_id'], $row['module_prefix']);
                    }
                }
                $total_enabled_dev_projects = $this->getEMTotalNumberOfProjects($row['external_module_id'], self::DEVELOPMENT_STATUS);
                $total_enabled_prod_projects = $this->getEMTotalNumberOfProjects($row['external_module_id'], self::PRODUCTION_STATUS);
                $em['redcap'] = $this->getExternalModulesREDCapRecords()[$row['module_prefix']];

                // use this to update redcap record.
//                $em['redcap'][$this->getFirstEventId()]['count_active_production'] = $total_enabled_prod_projects;
//                $em['redcap'][$this->getFirstEventId()]['count_active_dev'] = $total_enabled_dev_projects;
//                $em['redcap'][$this->getFirstEventId()]['globally_enabled'] = $this->isEMGloballyEnabled($row['external_module_id']);
//                $em['redcap'][$this->getFirstEventId()]['discoverable_in_project'] = $this->isEMDiscoverableInProject($row['external_module_id']);


                $em['entity'] = array(
                    'module_prefix' => $row['module_prefix'],
                    'version' => $this->getExternalModuleDeployedVersion($row['external_module_id']),
                    //'date' => date('Y-m-d H:i:s'),
                    'date' => time(),
                    'total_enabled_projects' => $this->getEMTotalNumberOfProjects($row['external_module_id']),
                    'globally_enabled' => $this->isEMGloballyEnabled($row['external_module_id']),
                    'discoverable_in_project' => $this->isEMDiscoverableInProject($row['external_module_id']),
                    'user_activate_permission' => $this->isEMCanBeEnableByNormalUsers($row['external_module_id']),
                    'total_enabled_dev_projects' => $total_enabled_dev_projects,
                    'total_enabled_prod_projects' => $total_enabled_prod_projects,
                    'total_using_projects' => '',// TODO,
                    'maintenance_fees' => $em['redcap'][$this->getFirstEventId()]['actual_monthly_cost'],
                );
                $externalModulesDBRecords[] = $em;
            }
            $this->externalModulesDBRecords = $externalModulesDBRecords;
        } catch (\Exception $e) {
            echo $e->getMessage();
        }
    }

    /**
     * @param $externalModuleId
     * @return bool
     */
    public function isEMGloballyEnabled($externalModuleId)
    {
        $q = $this->query("select count(*) as count  from redcap_external_module_settings where project_id is NULL and `key` = 'enabled' and external_module_id = ?", [$externalModuleId]);

        $row = db_fetch_assoc($q);
        if ($row['count'] && $row['count'] > 0) {
            return 1;
        } else {
            return 0;
        }
    }

    /**
     * @param $externalModuleId
     * @return bool
     */
    public function isEMDiscoverableInProject($externalModuleId)
    {
        $q = $this->query("select `value` from redcap_external_module_settings where project_id is NULL and `key` = 'discoverable-in-project' and external_module_id = ?", [$externalModuleId]);

        $row = db_fetch_assoc($q);
        if ($row['value']) {
            return $row['value'] ? 1 : 0;
        } else {
            return 0;
        }
    }


    /**
     * @param $externalModuleId
     * @return bool
     */
    public function isEMCanBeEnableByNormalUsers($externalModuleId)
    {
        $q = $this->query("select `value` from redcap_external_module_settings where project_id is NULL and `key` = 'user-activate-permission' and external_module_id = ?", [$externalModuleId]);

        $row = db_fetch_assoc($q);
        if ($row['value']) {
            return $row['value'] ? 1 : 0;
        } else {
            return 0;
        }
    }

    /**
     * @param int $externalModuleId
     * @return false|mixed|string
     */
    private function getExternalModuleDeployedVersion($externalModuleId)
    {
        $q = $this->query("select `value` from redcap_external_module_settings where `key` = 'version' and external_module_id = ?", [$externalModuleId]);

        $row = db_fetch_assoc($q);
        if ($row['value'] && $row['value'] != '') {
            return $row['value'];
        } else {
            return '';
        }
    }

    /**
     * @param string $folder
     * @return false|string
     */
    public function getFolderPath($folder)
    {
        $arr = explode("/", __DIR__);
        $parts = array_slice($arr, -2, 2, true);
        if (is_dir(implode("/", $parts) . '/../' . $folder)) {
            return implode("/", $parts) . '/../' . $folder;
        } elseif (is_dir('../' . $folder)) {
            return '../' . $folder;
        } elseif (is_dir(__DIR__ . '/../' . $folder)) {
            return __DIR__ . '/../' . $folder;
        }
        return false;
    }

    /**
     * @param int $externalModuleId
     * @return false|mixed|string
     */
    private function getExternalModuleSampleProjectId($externalModuleId)
    {
        $q = $this->query("select project_id from redcap_external_module_settings where project_id is not NULL and external_module_id = ? LIMIT 1,1", [$externalModuleId]);

        $row = db_fetch_assoc($q);
        if ($row['project_id'] && $row['project_id'] != '') {
            return $row['project_id'];
        } else {
            return false;
        }
    }

    private function getReposFolders()
    {
        return scandir(__DIR__ . '/../');
    }

    private function buildExternalModulePath($externalModuleId, $prefix)
    {
        $version = $this->getExternalModuleDeployedVersion($externalModuleId);
        return $prefix . '_' . $version;
    }

    /**
     * @param int $externalModuleId
     * @param string $prefix
     * @return array
     */
    private function lookupExternalModuleGithubInformation($externalModuleId, $prefix)
    {
        $fullExternalModuleName = $this->buildExternalModulePath($externalModuleId, $prefix);
        $folders = $this->getReposFolders();
        //$data = array('test_project_pid' => $this->getExternalModuleSampleProjectId($externalModuleId));

        if (in_array($fullExternalModuleName, $folders)) {
            $path = $this->getFolderPath($fullExternalModuleName);
            if (is_dir($path . '/.git')) {
                $content = explode("\n\t", file_get_contents($path . '/.git/config'));
                // url
                $matches = preg_grep('/^url/m', $content);
                $url = end($matches);
                $data['git_url'] = preg_replace('/^url\s=\s/m', '', $url);
                // $data[GITHUB_REPO_OPTION] = true;
            } elseif (file_exists($path . '/.gitrepo')) {
                $content = file_get_contents($path . '/.gitrepo');
                $parts = explode("\n\t", $content);
                $matches = preg_grep('/^remote?/m', $parts);
                $url = end($matches);
                $data['git_url'] = preg_replace('/^remote\s=\s/m', '', $url);
                // $data[GITHUB_REPO_OPTION] = true;
                $matches = preg_grep('/^commit?/m', $parts);
                $commit = explode(" ", end($matches));
                //$data['current_git_commit'] = end($commit);
            }
        }
        return $data;
    }

    private function lookupExternalModulesDefaultBranch($externalModuleId, $prefix)
    {
        $fullExternalModuleName = $this->buildExternalModulePath($externalModuleId, $prefix);
        $folders = $this->getReposFolders();
        if (in_array($fullExternalModuleName, $folders)) {
            $path = $this->getFolderPath($fullExternalModuleName);
            if (is_dir($path . '/.git')) {
                $content = explode("\n\t", file_get_contents($path . '/.git/config'));

                // branch
                $matches = preg_grep('/\[branch\s\"/m', $content);
                $branch = end($matches);
                $branch = explode("\n", $branch);
                $branch = end($branch);
                $regex = "(\[branch\s\")";
                $branch = preg_replace($regex, "", str_replace('"]', "", $branch));
                return $branch;
            } elseif (file_exists($path . '/.gitrepo')) {
                $content = file_get_contents($path . '/.gitrepo');
                $parts = explode("\n\t", $content);
                $matches = preg_grep('/^branch?/m', $parts);
                $branch = explode(" ", end($matches));
                $branch = end($branch);
                return $branch;
            }
        }
        return false;
    }

    /**
     * @param int $externalModuleId
     * @param string $prefix
     * @return bool
     * @throws \Exception
     */
    public function createExternalModuleREDCapRecord($externalModuleId, $prefix)
    {
        $data = $this->lookupExternalModuleGithubInformation($externalModuleId, $prefix);
        $data[REDCap::getRecordIdField()] = $prefix;
        $data['redcap_event_name'] = $this->getProject()->getUniqueEventNames($this->getFirstEventId());
        $response = \REDCap::saveData($this->getProjectId(), 'json', json_encode(array($data)));
        if (empty($response['errors'])) {
            $this->setExternalModulesDefaultBranchInREDCapRecord($externalModuleId, $prefix);
            return true;
        } else {
            $this->emError($response);
            throw new \Exception("cant save information for EM : " . $prefix . ' em id is: ' . $externalModuleId);
        }
    }

    private function setExternalModulesDefaultBranchInREDCapRecord($externalModuleId, $prefix)
    {
        $data[REDCap::getRecordIdField()] = $prefix;
        $data['git_branch'] = $this->lookupExternalModulesDefaultBranch($externalModuleId, $prefix);
        if ($data['git_branch'] != '') {
            $arm = end($this->getProject()->events);

            foreach ($arm['events'] as $id => $event) {
                if ($this->getFirstEventId() == $id) {
                    continue;
                }
                $data['redcap_event_name'] = $this->getProject()->getUniqueEventNames($id);
                $response = \REDCap::saveData($this->getProjectId(), 'json', json_encode(array($data)));
                if (!empty($response['errors'])) {
                    REDCap::logEvent(implode(",", $response['errors']));
                }
            }
        }
    }

    /**
     * @param $record
     * @return false|mixed|null
     */
    public function getProjectEMMonthlyCharge($record)
    {
        $entity = $this->getEntityFactory()->query('external_modules_charges')
            ->condition('module_prefix', $record['module_prefix'])
            ->condition('project_id', $record['project_id'])
            ->condition('charge_month', date('m'))
            ->condition('charge_year', date('Y'))
            ->execute();
        if ($entity) {
            return array_pop($entity);
        }
        return false;
    }

    /**
     * @param $record
     * @return false|mixed|null
     */
    public function isProjectEMUsageRecordExist($record)
    {
        $entity = $this->getEntityFactory()->query('project_external_modules_usage')
            ->condition('module_prefix', $record['module_prefix'])
            ->condition('project_id', $record['project_id'])
            ->execute();
        if ($entity) {
            return array_pop($entity);
        }
        return false;
    }

    public function getEMMonthlyChargesRecords()
    {
        try {
            if ($this->getProjectEMUsage()) {
                echo json_encode($this->getProjectEMUsage());
            } else {
                echo json_encode([]);
            }
        } catch (\Exception $e) {
            echo $e->getMessage();
        }
    }

    public function getCustomMonthlyChargesRecords()
    {
        try {
            if ($this->getCustomCharges()) {
                echo json_encode($this->getCustomCharges());
            } else {
                echo json_encode([]);
            }
        } catch (\Exception $e) {
            echo $e->getMessage();
        }
    }

    public function createProjectsExternalModuleUsageLogs()
    {
        try {
            if ($this->getProjectEMUsage()) {
//                foreach ($this->getProjectEMUsage() as $record) {
//                    if (!$entity = $this->isProjectEMUsageRecordExist($record)) {
//                        $entity = $this->getEntityFactory()->create('project_external_modules_usage', $record['entity']);
//                        echo $entity->getId() . '<br>';
//                    } else {
//                        #$entity = $this->getEntityFactory()->getInstance('project_external_modules_usage', $recordId);
//                        if ($entity->setData($record['entity'])) {
//                            $entity->save();
//                        } else {
//                            // Get a list of properties that failed on update
//                            print_r($entity->getErrors());
//                        }
//                    }
//                }
                echo json_encode($this->getProjectEMUsage());
            }
        } catch (\Exception $e) {
            echo $e->getMessage();
        }
    }


    /**
     * @param $eventId
     * @return int|string
     * @throws \Exception
     */
    private function searchBranchNameViaEventId($eventId)
    {
        $arm = end($this->getProject()->events);
        $description = $arm['events'][$eventId]['descrip'];
        $options = parseEnum($this->getProject()->metadata['deploy']['element_enum']);
        if ($index = array_search($description, $options)) {
            return $index;
        }
        throw new \Exception("could not find branch for event $eventId");
    }

    public function updateEMREDCapRecordUsageNumbers($record, $eventId): bool
    {
        $data[REDCap::getRecordIdField()] = $record[$this->getFirstEventId()][REDCap::getRecordIdField()];
        $data['count_active_production'] = $record[$this->getFirstEventId()]['count_active_production'];
        $data['count_active_dev'] = $record[$this->getFirstEventId()]['count_active_dev'];
        $data['deploy_setup___1'] = $record[$this->getFirstEventId()]['globally_enabled'] ?: false;
        $data['deploy_setup___2'] = $record[$this->getFirstEventId()]['discoverable_in_project'] ?: false;
        $data['redcap_event_name'] = $this->getProject()->getUniqueEventNames($eventId ?: $this->getFirstEventId());
        $response = \REDCap::saveData($this->getProjectId(), 'json', json_encode(array($data)));
        if (empty($response['errors'])) {
            return true;
        } else {
            throw new \Exception("cant save information for EM : " . $data['module_name']);
        }
    }

    public function createExternalModuleUtilizationLogs($eventId)
    {
        try {
            if ($this->getExternalModulesDBRecords()) {
//                foreach ($this->getExternalModulesDBRecords() as $record) {
//                    $entity = $this->getEntityFactory()->create('external_modules_utilization', $record['entity']);
//                    $this->updateEMREDCapRecordUsageNumbers($record['redcap'], $eventId);
//                    echo $entity->getId() . '<br>';
//                }
                echo json_encode($this->getExternalModulesDBRecords());
            }
        } catch (\Exception $e) {
            echo $e->getMessage();
        }
    }

    /**
     * @return array
     */
    public function getExternalModulesREDCapRecords(): array
    {
        if ($this->externalModulesREDCapRecords) {
            return $this->externalModulesREDCapRecords;
        } else {
            $this->setExternalModulesREDCapRecords();
            return $this->externalModulesREDCapRecords;
        }
    }

    /**
     * @param array $externalModulesREDCapRecords
     */
    public function setExternalModulesREDCapRecords(): void
    {
        $param = array(
            'project_id' => $this->getProjectId(),
            'return_format' => 'array',
            'events' => $this->getFirstEventId()
        );
        $externalModulesREDCapRecords = REDCap::getData($param);
        $this->externalModulesREDCapRecords = $externalModulesREDCapRecords;
    }

    /**
     * @return \Project
     */
    public function getProject(): \Project
    {
        return $this->project;
    }

    /**
     * @param \Project $project
     */
    public function setProject(\Project $project): void
    {
        $this->project = $project;
    }

    /**
     * @return ExternalModuleDeployment\ExternalModuleDeployment
     */
    public function getDeploymentEm(): ExternalModuleDeployment\ExternalModuleDeployment
    {
        return $this->deploymentEm;
    }

    /**
     * @param ExternalModuleDeployment\ExternalModuleDeployment $deploymentEm
     */
    public function setDeploymentEm(ExternalModuleDeployment\ExternalModuleDeployment $deploymentEm): void
    {
        $this->deploymentEm = $deploymentEm;
    }

    /**
     * @return \REDCapEntity\EntityFactory
     */
    public function getEntityFactory(): \REDCapEntity\EntityFactory
    {
        if(!$this->entityFactory){
            $this->setEntityFactory(new \REDCapEntity\EntityFactory());
        }
        return $this->entityFactory;
    }

    /**
     * @param \REDCapEntity\EntityFactory $entityFactory
     */
    public function setEntityFactory(\REDCapEntity\EntityFactory $entityFactory): void
    {
        $this->entityFactory = $entityFactory;
    }

    /**
     * @return array
     */
    public function getProjectEMUsage(): array
    {
        if (!$this->projectEMUsage) {
            $this->setProjectEMUsage();
        }
        return $this->projectEMUsage;
    }

    /**
     * @param array $projectEMUsage
     */
    public function setProjectEMUsage(): void
    {
        try {
            $projectEMUsage = array();

            if ($this->getRefreshProjectId()) {
                $q = $this->query("select
                       rems.external_module_id,
                       rem.directory_prefix as module_prefix,
                       rems.project_id,
                       rp.app_title as project_title,
                       rp.status,
                       rrc.record_count,
                       sum(case when rems.`key` = 'enabled' and rems.value = 'true' then 1 else 0 end) as is_em_enabled,
                       count(*) as number_of_settings_rows
                    from redcap_external_module_settings rems
                    join redcap_external_modules rem on rems.external_module_id = rem.external_module_id
                    join redcap_projects rp on rems.project_id = rp.project_id
                    join redcap_record_counts rrc on rp.project_id = rrc.project_id
                    where rems.project_id = ?
                    group by rems.external_module_id, rems.project_id, rem.directory_prefix, rp.app_title, rp.status, rrc.record_count having
                    -- rp.status = 1            -- is production
                    -- and is_em_enabled = 1 -- is enabled
                     number_of_settings_rows > 0  -- has actual data", [$this->getRefreshProjectId()]);
            } else {
                $q = $this->query("select
                       rems.external_module_id,
                       rem.directory_prefix as module_prefix,
                       rems.project_id,
                       rp.app_title as project_title,
                       rp.status,
                       rrc.record_count,
                       sum(case when rems.`key` = 'enabled' and rems.value = 'true' then 1 else 0 end) as is_em_enabled,
                       count(*) as number_of_settings_rows
                    from redcap_external_module_settings rems
                    join redcap_external_modules rem on rems.external_module_id = rem.external_module_id
                    join redcap_projects rp on rems.project_id = rp.project_id
                    join redcap_record_counts rrc on rp.project_id = rrc.project_id
                    where rems.project_id is not null
                    group by rems.external_module_id, rems.project_id, rem.directory_prefix, rp.app_title, rp.status, rrc.record_count having
                    rp.status = 1            -- is production
                    -- and is_em_enabled = 1 -- is enabled
                    and number_of_settings_rows > 0  -- has actual data", []);
            }


            while ($row = db_fetch_assoc($q)) {
                $linkedQ = $this->query("SELECT t.value
                            FROM redcap_external_module_settings t
                            WHERE project_id = ? and `key` = 'linked-project'", [$row['project_id']]);

                $linkedRow = db_fetch_assoc($linkedQ);
                if ($linkedRow['value'] && $linkedRow['value'] != '') {
                    $v = json_decode($linkedRow['value'], true);
                    $ritPID = array_key_first($v);
                } else {
                    $ritPID = null;
                }

                $em = $row;
                $em['redcap'] = $this->getExternalModulesREDCapRecords()[$row['module_prefix']];
                $em['entity'] = array(
                    'module_prefix' => $row['module_prefix'],
                    'project_id' => $row['project_id'],
                    'project_title' => $row['project_title'],
                    'rit_portal_project_id' => $ritPID,
                    'status' => (string)$row['status'],
                    'record_count' => $row['record_count'],
                    'is_em_enabled' => $row['is_em_enabled'],
                    'maintenance_fees' => $em['redcap'][$this->getFirstEventId()]['actual_monthly_cost'],
                    'has_maintenance_fees' => $em['redcap'][$this->getFirstEventId()]['maintenance_fee'],
                    'number_of_settings_rows' => $row['number_of_settings_rows'],
                );
                $projectEMUsage[] = $em;
            }
            $this->projectEMUsage = $projectEMUsage;
        } catch (\Exception $e) {
            echo $e->getMessage();
        }

    }

    public function processRequest()
    {
        if (!isset($_POST) or empty($_POST)) {
            throw new \LogicException("you are not allowed to access the API");
        }

        if (!isset($_POST['secret_token']) || !isset($_POST['request'])) {
            throw new \LogicException("request parameter is missing");
        }

        if (!$this->isValidServiceToken($_POST['secret_token'])) {
            throw new \LogicException("wrong token provided");
        }

        // set request (only compared against the request names below, never output)
        $this->setRequest(is_string($_POST['request']) ? $_POST['request'] : '');

        if ($this->getRequest() == 'em_utilization') {
            $this->createExternalModuleUtilizationLogs($this->getFirstEventId());
        }
        if ($this->getRequest() == 'project_em_usage') {
            $this->createProjectsExternalModuleUsageLogs();
        }

        if ($this->getRequest() == 'em_monthly_charges') {
            $this->getEMMonthlyChargesRecords();
        }

        if ($this->getRequest() == 'custom_charges') {
            $this->getCustomMonthlyChargesRecords();
        }
    }

    public function processCron()
    {
        if ($_GET['name'] == 'em_utilization') {
            $this->processEMUtilization();
        }
        if ($_GET['name'] == 'project_em_usage') {
            $this->processProjectEMUsage();
        }

        if ($_GET['name'] == 'em_monthly_charges') {
            $this->processEMMonthlyCharges();
        }
    }

    public function getInstanceEMBody($name, $url)
    {
        $body = $this->getClient()->post($url, [
            'secret_token' => $this->getSystemSetting('api-token'),
            'request' => htmlentities($name)
        ], ['Accept: application/json']);
        return json_decode($body, true);
    }

    public function processEMUtilization()
    {
        foreach ($this->getInstances() as $id => $instance) {

            $body = $this->getInstanceEMBody('em_utilization', $instance['service-url']);
            if ($body) {
                foreach ($body as $record) {
                    $record['entity']['instance'] = $instance['name'];
                    $entity = $this->getEntityFactory()->create('external_modules_utilization', $record['entity']);
//                    $this->updateEMREDCapRecordUsageNumbers($record['redcap'], $eventId);
                    if ($entity) {
                        echo $entity->getId() . '<br>';
                    } else {
                        print_r($this->getEntityFactory()->errors);
                    }
                }
            }
        }
    }

    public function projectEMUsageTriggerCron()
    {
        $url = $this->getUrl("ajax/cron.php", true, true) . '&pid=' . $this->getSystemSetting('em-project-id');
        $this->getClient()->get($url);
        $this->emDebug("running cron for $url on project " . $this->getSystemSetting('em-project-id'));
    }

    public function generateProjectEMCharges()
    {
        // This stays an HTTP self-call on purpose: REDCapEntity can't validate 'project' properties inside a cron
        // (cron defines USERID but not SUPER_USER, so Entity.php throws "Undefined constant"). The NOAUTH page runs
        // the work in a web request instead, and only accepts the call with the shared api-token, sent in the POST
        // body so it never lands in a URL or access log.
        $url = $this->getUrl("ajax/em_charges_cron.php", true, true) . '&pid=' . $this->getSystemSetting('em-project-id');
        $this->getClient()->post($url, ['secret_token' => (string)$this->getSystemSetting('api-token')]);
        $this->emDebug("running cron for $url on project " . $this->getSystemSetting('em-project-id'));
    }

    public function eMUtilizationTriggerCron()
    {
        $url = $this->getUrl("ajax/cron_em_util.php", true, true) . '&pid=' . $this->getSystemSetting('em-project-id');
        $this->getClient()->get($url);
        $this->emDebug("running cron for $url on project " . $this->getSystemSetting('em-project-id'));
    }

    public function getAllEMUtilizationRecoreds()
    {
        $query = "select
id ,instance, module_prefix, version, FROM_UNIXTIME(`date`, '%Y-%m-%d') as `date` , globally_enabled, discoverable_in_project, user_activate_permission, total_enabled_projects, total_enabled_dev_projects, total_enabled_prod_projects, total_using_projects ,maintenance_fees
 from redcap_entity_external_modules_utilization";
        $q = db_query($query);
        $result = [];
        while ($row = db_fetch_assoc($q)) {
            $result[] = $row;
        }
        return $result;
    }

    public function getUnixTimestampForLastCron()
    {
        $query = "select FROM_UNIXTIME(`date`, '%Y-%m-%d') as `date` from redcap.redcap_entity_external_modules_utilization group by date order by date desc limit 1";
        $q = db_query($query);
        $row = db_fetch_assoc($q);
        return $row['date'];
    }

    public function getEMUtilizationRecordDoNotMatchREDCapProjectRecords()
    {
        $date = strtotime($this->getUnixTimestampForLastCron());

        $query = "select
id ,instance, module_prefix, version, FROM_UNIXTIME(`date`, '%Y-%m-%d') as `date` , globally_enabled, discoverable_in_project, user_activate_permission, total_enabled_projects, total_enabled_dev_projects, total_enabled_prod_projects, total_using_projects ,maintenance_fees
 from redcap_entity_external_modules_utilization where date >= $date";
        $q = db_query($query);
        $result = [];
        while ($row = db_fetch_assoc($q)) {
            $redcapRecord = $this->getExternalModulesREDCapRecords()[$row['module_prefix']];
            if ($redcapRecord[$this->getFirstEventId()]['module_global'] != $row['globally_enabled'] || $redcapRecord[$this->getFirstEventId()]['module_discoverable'] != $row['discoverable_in_project'] || $redcapRecord[$this->getFirstEventId()]['module_self_enable'] != $row['user_activate_permission']) {
                if ($redcapRecord[$this->getFirstEventId()]['module_global'] != $row['globally_enabled']) {
                    $row['globally_enabled'] = '<div class="alert alert-danger">' . $row['globally_enabled'] . '</div>';
                }
                if ($redcapRecord[$this->getFirstEventId()]['module_discoverable'] != $row['discoverable_in_project']) {
                    $row['discoverable_in_project'] = '<div class="alert alert-danger">' . $row['discoverable_in_project'] . '</div>';
                }
                if ($redcapRecord[$this->getFirstEventId()]['module_self_enable'] != $row['user_activate_permission']) {
                    $row['user_activate_permission'] = '<div class="alert alert-danger">' . $row['user_activate_permission'] . '</div>';
                }
                $result[] = $row;
            }

        }
        return $result;
    }

    public function prepareEntityColumns($entityName, $columns)
    {
        $entities = $this->redcap_entity_types();
        $result = array();
        if (!key_exists($entityName, $entities)) {
            throw new \Exception("entity $entityName not found in defined entities.");
        } else {
            $properties = $entities[$entityName]['properties'];
            foreach ($properties as $key => $property) {
                if (in_array($key, $columns)) {
                    $index = array_search($key, $columns);
                    $columns[$index] = $property['name'];
                }
            }
        }


        foreach ($columns as $column) {
            $result[] = array('title' => $column);
        }
        return $result;
    }

    public function processEMMonthlyCharges()
    {
        $factory = $this->getEntityFactory();
        foreach ($this->getInstances() as $id => $instance) {
            $body = $this->getInstanceEMBody('em_monthly_charges', $instance['service-url']);
            if ($body) {
                foreach ($body as $record) {
                    $record['entity']['instance'] = $instance['name'];
                    if ($record['entity']['is_em_enabled'] && !$this->getProjectEMMonthlyCharge($record['entity'])) {
                        $data = array(
                            'instance' => $instance['name'],
                            'project_id' => $record['entity']['project_id'],
                            'module_prefix' => $record['entity']['module_prefix'],
                            'has_maintenance_fees' => $record['entity']['has_maintenance_fees']?1:0,
                            'maintenance_fees' => ($record['entity']['maintenance_fees'] AND $record['entity']['has_maintenance_fees'])?$record['entity']['maintenance_fees']: 0,
                            'charge_month' => date('m'),
                            'charge_year' => date('Y'),
                        );
                        $entity = $factory->create('external_modules_charges', $data);
                        if (!$entity && $factory->errors) {
                            $this->emError("Could not create EM Monthly Charge for REDCap PID#" . $data['project_id'] . " for EM " . $data['module_prefix']);
                            $key_value_pairs = [];
                            foreach ($factory->errors as $key => $value) {
                                $key_value_pairs[] = "$key: $value";
                            }

                            // Implode the key-value pairs into a string, separated by commas
                            $result = implode(', ', $key_value_pairs);
                            $this->emError($result);
                        } else {
                            $this->emLog("EM Monthly Charge record was created for REDCap PID#" . $data['project_id'] . " for EM " . $data['module_prefix']);
                        }
                    }
                }
            }
        }
    }

    public function processCustomCharges()
    {
        $result = [];
        foreach ($this->getInstances() as $id => $instance) {
            $body = $this->getInstanceEMBody('custom_charges', $instance['service-url']);
            $result[$instance['name']] = $body;
        }
        return $result;
    }

    public function processProjectEMUsage()
    {
        foreach ($this->getInstances() as $id => $instance) {

            $body = $this->getInstanceEMBody('project_em_usage', $instance['service-url']);
            if ($body) {
                foreach ($body as $record) {
                    $record['entity']['instance'] = $instance['name'];
                    if (!$entity = $this->isProjectEMUsageRecordExist($record)) {
//                        $this->emLog("**********record*************");
//                        $this->emLog($record);
//                        $this->emLog("***********************");
//                        $this->emLog("**********record entity*************");
//                        $this->emLog($record['entity']);
//                        $this->emLog("***********************");
                        $entity = $this->getEntityFactory()->create('project_external_modules_usage', $record['entity']);
//                        $this->emLog("***********entity************");
//                        $this->emLog($entity);
//                        $this->emLog("***********************");
                        if (!$entity) {
                            print_r($this->getEntityFactory()->errors);
                        } else {
                            echo $entity->getId() . '<br>';
                        }
                    } else {
                        #$entity = $this->getEntityFactory()->getInstance('project_external_modules_usage', $recordId);
                        if ($entity->setData($record['entity'])) {
                            $entity->save();
                        } else {
                            // Get a list of properties that failed on update
                            print_r($entity->getErrors());
                        }
                    }
                }
            }
        }
    }

    private function findCurrentInstanceName()
    {
        foreach ($this->getInstances() as $id => $instance) {
            if (strpos($instance['service-url'], $_SERVER['HTTP_HOST']) !== false) {
                return $instance['name'];
            }
        }
        return '0'; #som-dev
    }

    public function refreshProjectEMUsage($projectId = '')
    {
        $rawProjectId = $projectId != '' ? $projectId : ($_GET['project_id'] ?? '');
        $refreshProjectId = filter_var($rawProjectId, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]]);
        if ($refreshProjectId === false) {
            throw new \InvalidArgumentException("A valid REDCap project id is required.");
        }
        $this->setRefreshProjectId($refreshProjectId);

        $instanceName = $this->findCurrentInstanceName();
        $result = [];
        foreach ($this->getProjectEMUsage() as $record) {
            $record['entity']['instance'] = $instanceName;
            if (!$entity = $this->isProjectEMUsageRecordExist($record)) {
                $entity = $this->getEntityFactory()->create('project_external_modules_usage', $record['entity']);
                $result[] = $entity->getId() . '<br>';
            } else {
                #$entity = $this->getEntityFactory()->getInstance('project_external_modules_usage', $recordId);
                if ($entity->setData($record['entity'])) {
                    $entity->save();
                    $result[] = $entity->getId() . '<br>';
                } else {
                    // Get a list of properties that failed on update
                    $result[] = $entity->getErrors();
                }
            }
        }
        return $result;
    }

    /**
     * Checks the shared api-token that server-to-server calls send: hub -> spoke (pages/services), the charge cron's
     * self-call (ajax/em_charges_cron) and rit_dashboard's usage refresh (ajax/refresh_project_em_util).
     * Fails closed when no token is configured, and compares in constant time.
     * @param mixed $token
     * @return bool
     */
    public function isValidServiceToken($token): bool
    {
        $expected = (string)$this->getSystemSetting('api-token');
        return $expected !== '' && is_string($token) && hash_equals($expected, $token);
    }

    /**
     * Gate for NOAUTH pages that do work: only a POST carrying the shared api-token gets through.
     * @return bool
     */
    public function isAuthorizedServiceRequest(): bool
    {
        return ($_SERVER['REQUEST_METHOD'] ?? '') === 'POST'
            && $this->isValidServiceToken($_POST['secret_token'] ?? null);
    }

    /**
     * @return Client
     */
    public function getClient(): Client
    {
        return $this->client;
    }

    /**
     * @param Client $client
     */
    public function setClient(Client $client): void
    {
        $this->client = $client;
    }

    /**
     * @return string
     */
    public function getRequest(): string
    {
        return $this->request;
    }

    /**
     * @param string $request
     */
    public function setRequest(string $request): void
    {
        $this->request = $request;
    }

    /**
     * @return array
     */
    public function getInstances(): array
    {
        if (!$this->instances) {
            $this->setInstances();
        }
        return $this->instances;
    }

    /**
     * @param array $instances
     */
    public function setInstances(): void
    {
        $this->instances = $this->getSubSettings('instances', $this->getProjectId());;
    }

    /**
     * @return array
     */
    public function getProjects(): array
    {
        return $this->projects;
    }

    /**
     * @param array $projects
     */
    public function setProjects(): void
    {
        $projects = array();
        $q = $this->query("SELECT * FROM redcap_projects WHERE status IN (0,1) ", []);

        while ($row = db_fetch_assoc($q)) {
            $projects[] = $row;
        }
        $this->projects = $projects;
    }

    /**
     * @return int
     */
    public function getRefreshProjectId()
    {
        return $this->refreshProjectId;
    }

    /**
     * @param int $refreshProjectId
     */
    public function setRefreshProjectId(int $refreshProjectId): void
    {
        $this->refreshProjectId = $refreshProjectId;
    }


    public function getProjectTotalCustomCharges($projectId)
    {
        $total = 0;
        foreach ($this->getProjectCustomCharges($projectId) as $charge) {
            $total += $charge['amount'];
        }
        return $total;
    }

    /**
     * @param $projectId
     * @return array
     */
    public function getProjectCustomCharges($projectId)
    {
        $result = [];
        foreach ($this->getCustomCharges() as $charge) {
            if ($charge['project_id'] == $projectId) {
                $result[] = $charge;
            }
        }

        return $result;
    }

    /**
     * @return mixed
     */
    public function getCustomCharges()
    {
        if (!$this->customCharges) {
            $this->setCustomCharges();
        }
        return $this->customCharges;
    }

    /**
     * @param mixed $customCharges
     */
    public function setCustomCharges(): void
    {
        $charges = array();
        $q = $this->query("SELECT * FROM redcap_entity_custom_charges WHERE status  = 1 ", []);

        while ($row = db_fetch_assoc($q)) {
            $charges[] = $row;
        }
        $this->customCharges = $charges;
    }


}