Weno fixup and credential API (openemr#7256)

* Weno fixup and credential API
- change fa font size
- prevent old styles loading

* - add acl to setup
- validate vitals for under age
- fix popup error for invalid action
- add validation and default to change events
- better validate setting requirements

* - New WenoValidate class to verift keys and user credentials
- verify and reset encryption key if needed for phamacy downloads.
- temporally chang testing URL to weno dev server until new api goes online.
- setup weno module for using upgrade in pre for auto upgrade feature.

* - update code stamdards and do a little cleanup of our utility.js
- numerous validation additions.
- add all weno required settings (weno user id, facility location id and admin credentials validation) to module setup page.

* - moved the custom modules to top of managers list. appears I have a bias!
- add a simple but useful help panel to top of list table.
- color coded module name for clarity if laminas or custom.

* - had to create a separate setup_facilities script for setup so can use when module isn't enabled.
- add a help button to MM and help_requested event listener
- refactor controller for readability
- add some security

* - fix pathing problems
- refactor reloads to replace page with new version

* - too full of myself. utility Cleanup failed.
- add new dowdlog log viewer
- fix download create directory

* - fix download won't break on duplicate key
- auto save weno id in facilities section.
- some setup refactor

* - prevent resave of demographics on dialog close

* - prevent demos from throwing warning in upgrade for old weno table population. v5.0.1 I believe.
- files clean out
- remove a chance for a race condition in background tasks

* - change and move help
- refactor to use the online api from dev api

* - refactor and consoladate weno menu from Other to Weno eRx Tools
- add Module setup and new Dowmload log viewer for admin to manage
- add traps for internet off line.
- remove unused class methods and cleanup WenoValidate class for readability.

* - combine the download facility download viewer page

interface/modules/custom_modules/oe-module-weno/ModuleManagerListener.php

@@ -53,7 +53,8 @@ public function moduleManagerAction($methodName, $modId, string $currentActionSt
         if (method_exists(self::class, $methodName)) {
             return self::$methodName($modId, $currentActionStatus);
         } else {
-            return "Module cleanup method $methodName does not exist.";
+            // no reason to report action method is missing.
+            return $currentActionStatus;
         }
     }
 
@@ -71,8 +72,8 @@ public static function getModuleNamespace(): string
     }
 
     /**
-     * Required method to return this class object,
-     * so it is instantiated in Laminas Manager.
+     * Required method to return this class object
+     * so it will be instantiated in Laminas Manager.
      *
      * @return ModuleManagerListener
      */
@@ -98,6 +99,23 @@ private function install($modId, $currentActionStatus): mixed
         return $currentActionStatus;
     }
 
+    /**
+     * @param $modId
+     * @param $currentActionStatus
+     * @return mixed
+     */
+    private function help_requested($modId, $currentActionStatus): mixed
+    {
+        // must call a script that implements a dialog to show help.
+        // I can't find a way to override the Laminas UI except using a dialog.
+        try {
+            include 'show_help.php';
+        } catch (Exception $e) {
+            return $e->getMessage();
+        }
+        return $currentActionStatus;
+    }
+
     /**
      * @param $modId
      * @param $currentActionStatus

interface/modules/custom_modules/oe-module-weno/README.md

@@ -1,9 +1,35 @@
-# Weno EZ Integration Module for OpenEMR
-This module enables prescribers to make ePrescription through Weno's iFrame.
+# Module Install and Setup.
+- To start, go to OpenEMRs top menu and select **Modules->Manage Modules**  whereby the Module Manager (MM) page is presented. For brevity the below screenshot shows when the Weno module is installed and the Config Settings cog icon is clicked. Experienced users will note that I redesigned the MM adding new features outlined on another topic on this forum and refactoring the old two tab page to a single page.
+- The **Install** button will become an **Enable** button after install completes. **Click Confi cog/gear** icon or **Enable**.
+- If this is the first time the module has been installed a warning will pop up telling that Weno Admin settings have not been completed and validated. This is indicated by a red module config icon. By clicking this icon whether red or normal the **Weno eRx Service Admin Setup** settings will show in a panel. The module can not be enabled until the Primary Admin section passes validation.
+- The trash can icon is used to unregister the module. Any previous Weno setup will persist and remain in the last state of configuration. This way when and if the module is re-registered, all previous setup will remain.
 
-## To Install the Weno EZ Integration Module
-- On the top menu Modules -> Manage Modules. Click the unregistered button to display all unregistered modules.
-- Find the Weno EZ Integration Module and click the "Register Button".
-- On the Registered tab, click install and enable.
-- After successful installation, headover to Admin -> Config -> Weno to enter the weno Admin settings. To register for an account, visit www.online.wenoexchange.com
-- Follow the instructions on the Developer Page to configure your Weno EZ integration.
+- **Important to note that The Primary Admin Section** will require using the Validate and Save button after completing this section. All other sections will auto save when values are changed.
+## Setup Summary
+- There are three sections. After entering the required Admin credentials, Weno User ID for all prescribers and the Weno Location ID for the appropriate facility, all of which was received when a Weno account was created, click the **Enable** button to enable the module allowing the start of initial pharmacies download. You may then go to the User Settings page to enter the provider/prescribers credentials. For yourself in this case.
+  All providers that will be prescribing using Weno eRx must also have their credentials set otherwise the Weno eRx widget will not display.
+- After a log out and in or by clicking the **Restart OpenEMR** button in config panel the Weno menu items of **Admin->Other->Weno Management** and **Reports->Clients->Prescription Log** will be enabled.
+## Weno Required and Ancillary Setup for OpenEMR
+- Weno provided values necessary for setup are:
+    1. The account holders Admin credentials.
+    2. Weno User Id: Uxxxx
+    3. Assigned Location Id's for all the facilities used by the above User Id: Lxxxxx
+    4. The users credentials assign to each prescriber: username(email address) and password.
+-  **Important!** It is good practice for all user/prescribers to have their default facility set in their Users settings. Otherwise the location from the first/default from all practice facilities will be used.
+
+There are three sections within the Weno eRx Service Admin Setup that allow the user to setup almost all the necessary settings to successfully start e-prescribing. The only other item is that each Weno prescriber credentials are set up in their User Settings.
+### The Weno Primary Admin Section.
+- All values must be entered and validated.
+- If validation fails because either email and/or password are invalid an alert will be shown stating such.
+- If the encryption key is deemed invalid an alert will show and a new Encryption Reset button enabled. First try re-entering the key but if that doesn't work clicking the Reset button will create a new key. This change will also be reflected in the Admins main Weno account and no other actions are needed by the user. You may look on the key as an API token which may be a more familiar term to the reader.
+### The Map Weno User Id`s (Required)  Section.
+- This section presents a table of all authorised users showing their default facility if assigned and an input field to enter their Weno user id Uxxxx. This value is important in order to form a relationship between Weno and the OpenEMR user for tracking prescriptions.
+- All values are automatically saved for the user whenever the Weno Provider ID is entered or changed.
+- As a convenience, an edit button is supplied to present a dialog containing the Users settings in edit mode. From here user may edit any setting such as assigning a default facility. This would be the same as accessing Users from top menu Admin->Users selected provider.
+### The Map Weno Facility Id`s (Required)  Section.
+- This section is pretty self explanatory with perhaps noting this same data may be accessed from top menu Admin->Other->Weno Management as explained below.
+- This section also auto saves for convenience.
+### Other methods for various set up items accessed from top menu.
+- Open **Admin->Users** and select the user associated with the weno user id Uxxx and enter and save the weno user id in the **Weno Provider ID** field.
+- Next  open **Admin->Other->Weno Management** and enter the assigned Location Id Lxxxxx for the locations facilities.
+- Lastly from the top patient bar user icon click **Settings**. Scroll down or find the Weno button and click. Enter your username(email) and password in the **Weno Provider Email and Weno Provider Password** fields and **Save**. **Note** If these credentials are absent or wrong, you will not be able to prescribe prescriptions.

interface/modules/custom_modules/oe-module-weno/info.txt

@@ -1 +1 @@
-Weno EZ Integration eRx Module v1.2.0
+Weno EZ Integration eRx Module v1.0.0

interface/modules/custom_modules/oe-module-weno/public/assets/js/synch.js

@@ -38,7 +38,7 @@ function wenoAlertManager(option, element, spinElement) {
                 element.classList.add("d-none");
                 element.classList.remove("alert", "alert-success");
                 element.innerHTML = "";
-                window.location.reload();
+                window.location.replace(window.location.href)
             }, 3000
         );
 
@@ -54,7 +54,6 @@ function wenoAlertManager(option, element, spinElement) {
     }
 }
 
-// Reserved for future use.
 function renderDialog(action, uid, event) {
     event.preventDefault();
     // Trim action URL
@@ -65,30 +64,21 @@ function renderDialog(action, uid, event) {
     const urls = {
         'demographics': '/interface/patient_file/summary/demographics_full.php',
         'user_settings': '/interface/super/edit_globals.php?mode=user',
-        'weno_manage': '/interface/modules/custom_modules/oe-module-weno/templates/facilities.php',
+        'weno_manage': '/interface/modules/custom_modules/oe-module-weno/templates/weno_setup.php',
         'users': '/interface/usergroup/user_admin.php'
     };
-    // Construct action URL
-    const urlPart = urls[action].includes('?') ? '&' : '?';
-    const actionUrl = `${urls[action]}${urlPart}id=${encodeURIComponent(uid)}&csrf_token_form=${encodeURIComponent(csrf)}`;
-
     if (urls[action] === undefined) {
         console.error('Invalid action URL');
         alert(action.toUpperCase() + " " + xl('Direct action not implemented yet.'));
         return;
     }
+    // Construct action URL
+    const urlPart = urls[action].includes('?') ? '&' : '?';
+    const actionUrl = `${urls[action]}${urlPart}id=${encodeURIComponent(uid)}&csrf_token_form=${encodeURIComponent(csrf)}`;
+
     // Open modal dialog
     dlgopen('', 'dialog-mod', '900', 'full', '', '', {
         buttons: [
-            /*{
-            text: jsText('Click'),
-            close: false,
-            id: jsAttr('click-me'),
-            click: function () {
-                //tidyUp();
-            },
-            style: 'primary'
-            },*/
             {
             text: jsText('Return to eRx Widget'),
             close: true,
@@ -97,12 +87,12 @@ function renderDialog(action, uid, event) {
         ],
         allowResize: true,
         allowDrag: true,
+        onClosed: 'reload',
         dialogId: 'error-dialog',
         type: 'iframe',
         resolvePromiseOn: 'close',
         url: top.webroot_url + actionUrl
     }).then(function (dialog) {
         top.restoreSession();
-        window.location.reload();
     });
 }

interface/modules/custom_modules/oe-module-weno/scripts/file_download.php

@@ -98,7 +98,7 @@ function download_zipfile($fileUrl, $zipped_file)
     $isError = $wenolog->scrapeWenoErrorHtml($rpt);
     if ($isError['is_error']) {
         error_log('Pharmacy download failed: ' . $isError['messageText']);
-        $wenolog->insertWenoLog("pharmacy", "loginfail");
+        $wenolog->insertWenoLog("pharmacy", "Exceeded_download_limits");
     }
     EventAuditLogger::instance()->newEvent("pharmacy_log", $_SESSION['authUser'], $_SESSION['authProvider'], 0, $isError['messageText']);
     $wenolog->insertWenoLog("pharmacy", "Failed");
@@ -125,6 +125,7 @@ function download_zipfile($fileUrl, $zipped_file)
             sqlStatementNoLog('START TRANSACTION');
         }
         while (!feof($records)) {
+            $isError = false;
             $line = fgetcsv($records);
 
             if ($l <= 1) {
@@ -190,9 +191,9 @@ function download_zipfile($fileUrl, $zipped_file)
                 $insertdata['fullDay'] = $fullDay;
 
                 if ($data['Daily'] == 'Y') {
-                    $insertPharmacy->updatePharmacies($insertdata);
+                    $isError = $insertPharmacy->updatePharmacies($insertdata);
                 } else {
-                    $insertPharmacy->insertPharmacies($insertdata);
+                    $isError = $insertPharmacy->insertPharmacies($insertdata);
                 }
                 ++$l;
             }
@@ -212,6 +213,17 @@ function download_zipfile($fileUrl, $zipped_file)
             unlink($file);
         }
     }
+    if ($isError) {
+        EventAuditLogger::instance()->newEvent(
+            "pharmacy_log",
+            $_SESSION['authUser'],
+            $_SESSION['authProvider'],
+            0,
+            "Pharmacy Import download failed SQL Insert error."
+        );
+        $wenolog->insertWenoLog("pharmacy", "Failed");
+        error_log("User Initialed Pharmacy Import Failed Insert error");
+    }
     // let's brag about it.
     EventAuditLogger::instance()->newEvent(
         "pharmacy_log",

interface/modules/custom_modules/oe-module-weno/scripts/weno_log_sync.php

@@ -14,24 +14,30 @@
 use OpenEMR\Common\Logging\EventAuditLogger;
 use OpenEMR\Modules\WenoModule\Services\LogProperties;
 use OpenEMR\Modules\WenoModule\Services\WenoPharmaciesJson;
+use OpenEMR\Modules\WenoModule\Services\WenoValidate;
 
 function downloadWenoPharmacy()
 {
+    // Check if the encryption key is valid. If not, request a new key and then set it.
+    $wenoValidate = new WenoValidate();
+    $isKey = $wenoValidate->validateAdminCredentials(true); // auto reset on invalid.
+    if ((int)$isKey >= 998) {
+        EventAuditLogger::instance()->newEvent(
+            "pharmacy_background",
+            $_SESSION['authUser'],
+            $_SESSION['authProvider'],
+            1,
+            text("Background Initiated Pharmacy download attempt failed. Internet problem!")
+        );
+        error_log('Background Initiated Pharmacy Download not ran. Internet problem: ' . text($isKey));
+        die;
+    }
+    error_log('Background Initiated Encryption Verify returned: ' . text($isKey == '1' ? 'Verified key is valid.' : 'Invalid Key'));
+
     $cryptoGen = new CryptoGen();
     $localPharmacyJson = new WenoPharmaciesJson($cryptoGen);
-
     // Check if the background service is active. Intervals are set to once a day
-    // Weno has decided to not force the import of pharmacies since they are using the iframe
-    // and the pharmacy can be selected at the time of creating the prescription.
     $value = $localPharmacyJson->checkBackgroundService();
-
-    EventAuditLogger::instance()->newEvent(
-        "pharmacy_background",
-        $_SESSION['authUser'],
-        $_SESSION['authProvider'],
-        1,
-        "Init Background Pharmacy Download Service Status:"  . text(ucfirst($value))
-    );
     if ($value == 'active' || $value == 'live') {
         error_log('Background Initiated Pharmacy Download Started.');
 

interface/modules/custom_modules/oe-module-weno/src/Bootstrap.php

@@ -30,9 +30,6 @@
 
 class Bootstrap
 {
-    const OPENEMR_GLOBALS_LOCATION = "../../../../globals.php";
-    const MODULE_INSTALLATION_PATH = "/interface/modules/custom_modules/oe-module-weno";
-    const MODULE_NAME = "";
     const MODULE_MENU_NAME = "Weno";
 
     /**
@@ -65,19 +62,30 @@ class Bootstrap
      * @var SelectedPatientPharmacy
      */
     private SelectedPatientPharmacy $selectedPatientPharmacy;
+    public string $installPath;
+
+    public function __construct(EventDispatcher $dispatcher)
+    {
+        $this->installPath = $GLOBALS['web_root'] . "/interface/modules/custom_modules/oe-module-weno";
+        $this->eventDispatcher = $dispatcher;
+        $this->globalsConfig = new WenoGlobalConfig();
+        $this->moduleDirectoryName = basename(dirname(__DIR__));
+        $this->modulePath = dirname(__DIR__);
+        $this->logger = new SystemLogger();
+        $this->selectedPatientPharmacy = new SelectedPatientPharmacy();
+    }
 
     /**
      * @return void
      */
     public function subscribeToEvents(): void
     {
         $modService = new ModuleService();
+        // let Admin configure Weno if module is not configured.
+        $this->addGlobalSettings();
         if (!$modService->isWenoConfigured()) {
-            // let Admin configure Weno if module is not configured.
-            $this->addGlobalSettings();
             return;
         }
-        $this->addGlobalSettings();
         $this->registerMenuItems();
         $this->registerDemographicsEvents();
         $this->demographicsSelectorEvents();
@@ -87,16 +95,6 @@ public function subscribeToEvents(): void
         $modService::setModuleState('oe-module-weno', '1', '0');
     }
 
-    public function __construct(EventDispatcher $dispatcher)
-    {
-        $this->eventDispatcher = $dispatcher;
-        $this->globalsConfig = new WenoGlobalConfig();
-        $this->moduleDirectoryName = basename(dirname(__DIR__));
-        $this->modulePath = dirname(__DIR__);
-        $this->logger = new SystemLogger();
-        $this->selectedPatientPharmacy = new SelectedPatientPharmacy();
-    }
-
     /**
      * @return \Twig\Environment
      */
@@ -225,38 +223,58 @@ public function registerMenuItems(): void
     public function addCustomMenuItem(MenuEvent $event): MenuEvent
     {
         $menu = $event->getMenu();
+        // Top level menu
+        $topMenu = new \stdClass();
+        $topMenu->requirement = 0;
+        $topMenu->target = 'adm0';
+        $topMenu->menu_id = 'adm';
+        $topMenu->label = xlt("Weno eRx Tools");
+        $topMenu->icon = "fa-caret-right";
+        $topMenu->children = [];
+        $topMenu->acl_req = ["admin", "super"];
+        $topMenu->global_req = ["weno_rx_enable"];
         //Prescription Log
         $menuItem = new \stdClass();
         $menuItem->requirement = 0;
         $menuItem->target = 'rep';
         $menuItem->menu_id = 'rep0';
-        $menuItem->label = xlt("Prescription Log");
-        $menuItem->url = self::MODULE_INSTALLATION_PATH . "/templates/rxlogmanager.php";
+        $menuItem->label = xlt("Weno Prescription Log");
+        $menuItem->url = "/interface/modules/custom_modules/oe-module-weno/templates/rxlogmanager.php";
         $menuItem->children = [];
         $menuItem->acl_req = ["patients", "rx"];
         $menuItem->global_req = ["weno_rx_enable"];
-
-        //Weno Management
-        $mgtMenu = new \stdClass();
-        $mgtMenu->requirement = 0;
-        $mgtMenu->target = 'adm0';
-        $mgtMenu->menu_id = 'adm';
-        $mgtMenu->label = xlt("Weno Management");
-        $mgtMenu->url = self::MODULE_INSTALLATION_PATH . "/templates/facilities.php";
-        $mgtMenu->children = [];
-        $mgtMenu->acl_req = ["admin", "super"];
-        $mgtMenu->global_req = ["weno_rx_enable"];
-
+        //Weno log
+        $dlMenu = new \stdClass();
+        $dlMenu->requirement = 0;
+        $dlMenu->target = 'adm1';
+        $dlMenu->menu_id = 'adm';
+        $dlMenu->label = xlt("Weno Downloads Management");
+        $dlMenu->url = "/interface/modules/custom_modules/oe-module-weno/templates/download_log_viewer.php";
+        $dlMenu->children = [];
+        $dlMenu->acl_req = ["admin", "super"];
+        $dlMenu->global_req = ["weno_rx_enable"];
+        //Weno Setup
+        $setupMenu = new \stdClass();
+        $setupMenu->requirement = 0;
+        $setupMenu->target = 'adm0';
+        $setupMenu->menu_id = 'adm';
+        $setupMenu->label = xlt("Weno eRx Service Setup");
+        $setupMenu->url = "/interface/modules/custom_modules/oe-module-weno/templates/weno_setup.php";
+        $setupMenu->children = [];
+        $setupMenu->acl_req = ["admin", "super"];
+        $setupMenu->global_req = ["weno_rx_enable"];
+        // Write the menu items to the menu
         foreach ($menu as $item) {
             if ($item->menu_id == 'admimg') {
+                $item->children[] = $topMenu;
                 foreach ($item->children as $other) {
-                    if ($other->label == 'Other') {
-                        $other->children[] = $mgtMenu;
+                    if ($other->label == 'Weno eRx Tools') {
+                        $other->children[] = $dlMenu;
+                        $other->children[] = $setupMenu;
                         break;
                     }
                 }
             }
-
             if ($item->menu_id == 'repimg') {
                 foreach ($item->children as $clientReport) {
                     if ($clientReport->label == 'Clients') {

interface/modules/custom_modules/oe-module-weno/src/Services/DownloadWenoPharmacies.php

@@ -90,7 +90,7 @@ public function extractFile($path_to_extract, $storelocation): ?string
             if ($isError['is_error']) {
                 EventAuditLogger::instance()->newEvent("pharmacy_background", $_SESSION['authUser'], $_SESSION['authProvider'], 0, "Pharmacy Failed download! Weno error: " . $isError['messageText']);
                 error_log('Pharmacy download failed: ' . $isError['messageText']);
-                $wenolog->insertWenoLog("pharmacy", "loginfail");
+                $wenolog->insertWenoLog("pharmacy", "Exceeded_download_limits");
             } else {
                 EventAuditLogger::instance()->newEvent("pharmacy_background", $_SESSION['authUser'], $_SESSION['authProvider'], 0, "Pharmacy Failed download! Weno error Other");
                 error_log("Pharmacy Failed download! Weno error: Other");