library/dated_reminder_functions.php

   1 <?php
   2 /**
   3  * Contains functions used in the dated reminders.
   4  *
   5  * Copyright (C) 2012 tajemo.co.za <http://www.tajemo.co.za/>
   6  *
   7  * LICENSE: This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 3
  10  * of the License, or (at your option) any later version.
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://opensource.org/licenses/gpl-license.php>;.
  17  *
  18  * @package OpenEMR
  19  * @author  Craig Bezuidenhout <http://www.tajemo.co.za/>
  20  * @link    http://www.open-emr.org
  21  */
  22
  23 /**
  24  * RemindersArray function
  25  *
  26  * @returns array reminders for specified user, defaults to current user if none specified
  27  */
  28 function RemindersArray($days_to_show, $today, $alerts_to_show, $userID = false)
  29 {
  30     if (!$userID) {
  31         $userID = $_SESSION['authId'];
  32     }
  33
  34         global $hasAlerts;
  35 // ----- define a blank reminders array
  36         $reminders = array();
  37
  38 // ----- sql statement for getting uncompleted reminders (sorts by date, then by priority)
  39           $drSQL = sqlStatement(
  40               "SELECT
  41                                     dr.pid, dr.dr_id, dr.dr_message_text,dr.dr_message_due_date,
  42                                     u.fname ffname, u.mname fmname, u.lname flname
  43                             FROM `dated_reminders` dr
  44                             JOIN `users` u ON dr.dr_from_ID = u.id
  45                             JOIN `dated_reminders_link` drl ON dr.dr_id = drl.dr_id
  46                             WHERE drl.to_id = ?
  47                             AND dr.`message_processed` = 0
  48                             AND dr.`dr_message_due_date` < ADDDATE(NOW(), INTERVAL $days_to_show DAY)
  49                             ORDER BY `dr_message_due_date` ASC , `message_priority` ASC LIMIT 0,$alerts_to_show",
  50               array($userID)
  51           );
  52
  53 // --------- loop through the results
  54     for ($i=0; $drRow=sqlFetchArray($drSQL); $i++) {
  55 // --------- need to run patient query seperately to allow for reminders not linked to a patient
  56         $pRow = array();
  57         if ($drRow['pid'] > 0) {
  58             $pSQL = sqlStatement("SELECT pd.title ptitle, pd.fname pfname, pd.mname pmname, pd.lname plname FROM `patient_data` pd WHERE pd.pid = ?", array($drRow['pid']));
  59             $pRow = sqlFetchArray($pSQL);
  60         }
  61
  62 // --------- fill the $reminders array
  63         $reminders[$i]['messageID'] = $drRow['dr_id'];
  64         $reminders[$i]['PatientID'] = $drRow['pid'];
  65
  66 // -------------------------------------  if there was a patient linked, set the name, else set it to blank
  67         $reminders[$i]['PatientName'] = (empty($pRow) ? '' : $pRow['ptitle'].' '.$pRow['pfname'].' '.$pRow['pmname'].' '.$pRow['plname']);
  68 // -------------------------------------
  69
  70         $reminders[$i]['message'] = $drRow['dr_message_text'];
  71         $reminders[$i]['dueDate'] = $drRow['dr_message_due_date'];
  72         $reminders[$i]['fromName'] = $drRow['ffname'].' '.$drRow['fmname'].' '.$drRow['flname'];
  73
  74 // --------- if the message is due or overdue set $hasAlerts to true, this will stop autohiding of reminders
  75         if (strtotime($drRow['dr_message_due_date']) <= $today) {
  76             $hasAlerts = true;
  77         }
  78     }
  79
  80 // --------- END OF loop through the results
  81
  82         return $reminders;
  83 }
  84 // ------------------------------------------------
  85 // @ END OF RemindersArray function
  86 // ------------------------------------------------
  87
  88
  89
  90
  91 /**
  92  * This function is used to get a count of the number of reminders due for a specified
  93  * user.
  94  *
  95  * @param $days_to_show
  96  * @param $today
  97  * @param defaults to current user if none specified
  98  * @returns int with number of due reminders for specified user
  99  */
 100 function GetDueReminderCount($days_to_show, $today, $userID = false)
 101 {
 102     if (!$userID) {
 103         $userID = $_SESSION['authId'];
 104     }
 105
 106 // ----- sql statement for getting uncompleted reminders (sorts by date, then by priority)
 107     $drSQL = sqlStatement(
 108         "SELECT count(dr.dr_id) c
 109                             FROM `dated_reminders` dr
 110                             JOIN `users` u ON dr.dr_from_ID = u.id
 111                             JOIN `dated_reminders_link` drl ON dr.dr_id = drl.dr_id
 112                             WHERE drl.to_id = ?
 113                             AND dr.`message_processed` = 0
 114                             AND dr.`dr_message_due_date` < ADDDATE(NOW(), INTERVAL $days_to_show DAY)",
 115         array($userID)
 116     );
 117
 118     $drRow=sqlFetchArray($drSQL);
 119     return $drRow['c'];
 120 }
 121 // ------------------------------------------------
 122 // @ END OF GetDueReminder function
 123 // ------------------------------------------------
 124
 125 // ------------------------------------------------
 126 // @ GetAllReminderCount function
 127 // @ returns int with number of unprocessed reminders for specified user, defaults to current user if none specified
 128 // ------------------------------------------------
 129 function GetAllReminderCount($userID = false)
 130 {
 131     if (!$userID) {
 132         $userID = $_SESSION['authId'];
 133     }
 134
 135 // ----- sql statement for getting uncompleted reminders
 136     $drSQL = sqlStatement(
 137         "SELECT count(dr.dr_id) c
 138                             FROM `dated_reminders` dr
 139                             JOIN `users` u ON dr.dr_from_ID = u.id
 140                             JOIN `dated_reminders_link` drl ON dr.dr_id = drl.dr_id
 141                             WHERE drl.to_id = ?
 142                             AND dr.`message_processed` = 0",
 143         array($userID)
 144     );
 145
 146     $drRow=sqlFetchArray($drSQL);
 147     return $drRow['c'];
 148 }
 149 // ------------------------------------------------
 150 // @ END OF GetAllReminderCount function
 151 // ------------------------------------------------
 152
 153 // ------------------------------------------------
 154 // @ getRemindersHTML(array $reminders)
 155 // @ returns HTML as a string, for printing
 156 // ------------------------------------------------
 157 function getRemindersHTML($reminders = array(), $today)
 158 {
 159     global $hasAlerts;
 160 // --- initialize the string as blank
 161     $pdHTML = '';
 162 // --- loop through the $reminders
 163     foreach ($reminders as $r) {
 164 // --- initialize $warning as the date, this is placed in front of the message
 165          $warning = text($r['dueDate']);
 166 // --- initialize $class as 'text dr', this is the basic class
 167          $class='text dr';
 168
 169 // --------- check if reminder is  overdue
 170         if (strtotime($r['dueDate']) < $today) {
 171             $warning = '! '.xlt('OVERDUE');
 172             $class = 'bold alert dr';
 173         } // --------- check if reminder is due
 174         elseif (strtotime($r['dueDate']) == $today) {
 175             $warning = xlt('TODAY');
 176             $class='bold alert dr';
 177         }
 178
 179          // end check if reminder is due or overdue
 180          // apend to html string
 181          $pdHTML .= '<p id="p_'.attr($r['messageID']).'">
 182                           <a class="dnRemover css_button_small" onclick="updateme('."'".attr($r['messageID'])."'".')" id="'.attr($r['messageID']).'" href="#">
 183                             <span>'.xlt('Set As Completed').'</span>
 184                           </a>
 185                           <span title="'.($r['PatientID'] > 0 ? xla('Click Patient Name to Open Patient File') : '').'" class="'.attr($class).'">'.
 186                          $warning.'
 187                             <span onclick="goPid('.attr($r['PatientID']).')" class="patLink" id="'.attr($r['PatientID']).'">'.
 188                            text($r['PatientName']).'
 189                             </span> '.
 190                          text($r['message']).' - ['.text($r['fromName']).']
 191                           </span> ----->
 192                           <a onclick="openAddScreen('.attr($r['messageID']).')" class="dnForwarder" id="'.attr($r['messageID']).'" href="#">[ '.xlt('Forward').' ]</a>
 193                         </p>';
 194     }
 195
 196     return ($pdHTML == '' ? '<p class="alert-custom"><br />'.xlt('No Reminders').'</p>' : $pdHTML);
 197 }
 198 // ------------------------------------------------
 199 // @ END OF getRemindersHTML function
 200 // ------------------------------------------------
 201
 202
 203 // ------------------------------------------------
 204 // @ setReminderAsProccessed(int $rID)
 205 // @ marks reminder as processed
 206 // ------------------------------------------------
 207 function setReminderAsProcessed($rID, $userID = false)
 208 {
 209     if (!$userID) {
 210         $userID = $_SESSION['authId'];
 211     }
 212
 213     if (is_numeric($rID) and $rID > 0) {
 214     // --- check if this user can remove this message
 215     // --- need a better way of checking the current user, I don't like using $_SESSION for checks
 216         $rdrSQL = sqlStatement("SELECT count(dr.dr_id) c FROM `dated_reminders` dr JOIN `dated_reminders_link` drl ON dr.dr_id = drl.dr_id WHERE drl.to_id = ? AND dr.`dr_id` = ? LIMIT 0,1", array($userID,$rID));
 217         $rdrRow=sqlFetchArray($rdrSQL);
 218
 219     // --- if this user can delete this message (ie if it was sent to this user)
 220         if ($rdrRow['c'] == 1) {
 221   // ----- update the data, set the message to proccesses
 222             sqlStatement("UPDATE `dated_reminders` SET  `message_processed` = 1, `processed_date` = NOW(), `dr_processed_by` = ? WHERE `dr_id` = ? ", array(intval($userID),intval($rID)));
 223         }
 224     }
 225 }
 226 // ------------------------------------------------
 227 // @ END OF setReminderAsProccessed function
 228 // ------------------------------------------------
 229
 230
 231 // ------------------------------------------------
 232 // @ getReminderById(int $mID)
 233 // @ returns an array with message details for forwarding
 234 // ------------------------------------------------
 235 function getReminderById($mID, $userID = false)
 236 {
 237     if (!$userID) {
 238         $userID = $_SESSION['authId'];
 239     }
 240
 241     $rdrSQL = sqlStatement("SELECT * FROM `dated_reminders` dr
 242                             JOIN `dated_reminders_link` drl ON dr.dr_id = drl.dr_id
 243                             WHERE drl.to_id = ? AND dr.`dr_id` = ? LIMIT 0,1", array($userID,$mID));
 244     $rdrRow=sqlFetchArray($rdrSQL);
 245     if (!empty($rdrRow)) {
 246         return $rdrRow;
 247     }
 248
 249     return false;
 250 }
 251 // ------------------------------------------------
 252 // @ END OF getReminderById function
 253 // ------------------------------------------------
 254
 255
 256 // ------------------------------------------------
 257 // @ getReminderById(
 258 //                    array $sendTo
 259 //                    int $fromID
 260 //                    string $message
 261 //                    date $dueDate
 262 //                    int $patID
 263 //                    int $priority
 264 //                   )
 265 // @ returns an array with message details for forwarding
 266 // ------------------------------------------------
 267 function sendReminder($sendTo, $fromID, $message, $dueDate, $patID, $priority)
 268 {
 269     if (// ------- Should run data checks before running this function for more accurate error reporting
 270 // ------- check sendTo is not empty
 271            !empty($sendTo) and
 272 // ------- check dueDate, only allow valid dates, todo -> enhance date checker
 273            preg_match('/\d{4}[-]\d{2}[-]\d{2}/', $dueDate) and
 274 // ------- check priority, only allow 1-3
 275            intval($priority) <= 3 and
 276 // ------- check message, only up to 255 characters
 277            strlen($message) <= 255 and strlen($message) > 0 and
 278 // ------- check if PatientID is set and in numeric
 279            is_numeric($patID)
 280          ) {
 281 // ------- check for valid recipient
 282              $cRow=sqlFetchArray(sqlStatement('SELECT count(id) FROM  `users` WHERE  `id` = ?', array($sendDMTo)));
 283         if ($cRow == 0) {
 284             return false;
 285         }
 286
 287           // ------- if no errors
 288           // --------- insert the new message
 289               $mID = sqlInsert(
 290                   "INSERT INTO `dated_reminders`
 291                              (`dr_from_ID` ,`dr_message_text` ,`dr_message_sent_date` ,`dr_message_due_date` ,`pid` ,`message_priority` ,`message_processed` ,`processed_date`)
 292                               VALUES (?, ?, NOW( ), ?, ?, ?, '0', '');",
 293                   array($fromID,$message,$dueDate,$patID,$priority)
 294               );
 295
 296         foreach ($sendTo as $st) {
 297             sqlInsert(
 298                 "INSERT INTO `dated_reminders_link`
 299                             (`dr_id` ,`to_id`)
 300                             VALUES (?, ?);",
 301                 array($mID,$st)
 302             );
 303         };
 304                return true;
 305     } //---- end of if block
 306              return false;
 307 }
 308
 309 // ------- get current patient name
 310 // ---- returns string, blank if no current patient
 311 function getPatName($patientID)
 312 {
 313     $patientID = intval($patientID);
 314     $pSQL = sqlStatement("SELECT pd.title ptitle, pd.fname pfname, pd.mname pmname, pd.lname plname FROM `patient_data` pd WHERE pd.pid = ?", array($patientID));
 315     $pRow = sqlFetchArray($pSQL);
 316     return (empty($pRow) ? '' : $pRow['ptitle'].' '.$pRow['pfname'].' '.$pRow['pmname'].' '.$pRow['plname']);
 317 }
 318
 319 // -- log reminders array function uses $_GET to filter
 320 function logRemindersArray()
 321 {
 322
 323         // set blank array for data to be parsed to sql
 324         $input = array();
 325         // set blank string for the query
 326         $where = '';
 327         $sentBy = $_GET['sentBy'];
 328         $sentTo = $_GET['sentTo'];
 329 //------------------------------------------
 330 // ----- HANDLE SENT BY FILTER
 331     if (!empty($sentBy)) {
 332         $sbCount = 0;
 333         foreach ($sentBy as $sb) {
 334             $where .= ($sbCount == 0 ? '(' : ' OR ').'dr.dr_from_ID = ? ';
 335             $sbCount++;
 336             $input[] = $sb;
 337         }
 338
 339         $where .= ')';
 340     }
 341
 342 //------------------------------------------
 343 // ----- HANDLE SENT TO FILTER
 344     if (!empty($sentTo)) {
 345         $where = ($where == '' ? '' : $where.' AND ');
 346         $stCount = 0;
 347         foreach ($sentTo as $st) {
 348             $where .= ($stCount == 0 ? '(' : ' OR ').'drl.to_id = ? ';
 349             $stCount++;
 350             $input[] = $st;
 351         }
 352
 353         $where .= ')';
 354     }
 355
 356 //------------------------------------------
 357 // ----- HANDLE PROCCESSED/PENDING FILTER ONLY RUN THIS IF BOTH ARE NOT SET
 358     if (isset($_GET['processed']) and !isset($_GET['pending'])) {
 359         $where = ($where == '' ? 'dr.message_processed = 1' : $where.' AND dr.message_processed = 1');
 360     } elseif (!isset($_GET['processed']) and isset($_GET['pending'])) {
 361         $where = ($where == '' ? 'dr.message_processed = 0' : $where.' AND dr.message_processed = 0');
 362     }
 363
 364 //------------------------------------------
 365 // ----- HANDLE DATE RANGE FILTERS
 366     if (isset($_GET['sd']) and $_GET['sd'] != '') {
 367         $where = ($where == '' ? 'dr.dr_message_sent_date >= ?' : $where.' AND dr.dr_message_sent_date >= ?');
 368         $input[] = $_GET['sd'].' 00:00:00';
 369     }
 370
 371     if (isset($_GET['ed']) and $_GET['ed'] != '') {
 372         $where = ($where == '' ? 'dr.dr_message_sent_date <= ?' : $where.' AND dr.dr_message_sent_date <= ?');
 373         $input[] = $_GET['ed'].' 23:59:59';
 374     }
 375
 376 //------------------------------------------
 377
 378
 379 //-------- add the "WHERE" the string if string is not blank, avoid sql errors for blannk WHERE statements
 380           $where = ($where == '' ? '' : 'WHERE '.$where);
 381
 382 // ----- define a blank reminders array
 383         $reminders = array();
 384
 385 // ----- sql statement for getting uncompleted reminders (sorts by date, then by priority)
 386           $drSQL = sqlStatement(
 387               "SELECT
 388                                     dr.pid, dr.dr_id, dr.dr_message_text, dr.dr_message_due_date dDate, dr.dr_message_sent_date sDate,dr.processed_date processedDate, dr.dr_processed_by,
 389                                     u.fname ffname, u.mname fmname, u.lname flname,
 390                                     tu.fname tfname, tu.mname tmname, tu.lname tlname
 391                             FROM `dated_reminders` dr
 392                             JOIN `dated_reminders_link` drl ON dr.dr_id = drl.dr_id
 393                             JOIN `users` u ON dr.dr_from_ID = u.id
 394                             JOIN `users` tu ON drl.to_id = tu.id
 395                             $where",
 396               $input
 397           );
 398 // --------- loop through the results
 399     for ($i=0; $drRow=sqlFetchArray($drSQL); $i++) {
 400 // --------- need to run patient query seperately to allow for messages not linked to a patient
 401         $pSQL = sqlStatement("SELECT pd.title ptitle, pd.fname pfname, pd.mname pmname, pd.lname plname FROM `patient_data` pd WHERE pd.pid = ?", array($drRow['pid']));
 402         $pRow = sqlFetchArray($pSQL);
 403
 404         $prSQL = sqlStatement("SELECT u.fname pfname, u.mname pmname, u.lname plname FROM `users` u WHERE u.id = ?", array($drRow['dr_processed_by']));
 405         $prRow = sqlFetchArray($prSQL);
 406
 407 // --------- fill the $reminders array
 408         $reminders[$i]['messageID'] = $drRow['dr_id'];
 409         $reminders[$i]['PatientID'] = $drRow['pid'];
 410
 411         $reminders[$i]['pDate'] = ($drRow['processedDate'] == '0000-00-00 00:00:00' ? 'N/A' : $drRow['processedDate']);
 412         $reminders[$i]['sDate'] = $drRow['sDate'];
 413         $reminders[$i]['dDate'] = $drRow['dDate'];
 414
 415 // -------------------------------------  if there was a patient linked, set the name, else set it to blank
 416         $reminders[$i]['PatientName'] = (empty($pRow) ? 'N/A' : $pRow['ptitle'].' '.$pRow['pfname'].' '.$pRow['pmname'].' '.$pRow['plname']);
 417 // -------------------------------------
 418
 419         $reminders[$i]['message'] = $drRow['dr_message_text'];
 420         $reminders[$i]['fromName'] = $drRow['ffname'].' '.$drRow['fmname'].' '.$drRow['flname'];
 421         $reminders[$i]['ToName'] = $drRow['tfname'].' '.$drRow['tmname'].' '.$drRow['tlname'];
 422         $reminders[$i]['processedByName'] = (empty($prRow) ? 'N/A' : $prRow['ptitle'].' '.$prRow['pfname'].' '.$prRow['pmname'].' '.$prRow['plname']);
 423     }
 424
 425 // --------- END OF loop through the results
 426
 427         return $reminders;
 428 }