library/direct_message_check.inc

   1 <?php
   2 /**
   3  * Background receive function for phiMail Direct Messaging service.
   4  *
   5  * This script is called by the background service manager
   6  * at /library/ajax/execute_background_services.php
   7  *
   8  * Copyright (C) 2013 EMR Direct <http://www.emrdirect.com/>
   9  *
  10  * LICENSE: This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program. If not, see <http://opensource.org/licenses/gpl-license.php>;.
  20  *
  21  * @package OpenEMR
  22  * @author  EMR Direct <http://www.emrdirect.com/>
  23  * @link    http://www.open-emr.org
  24  */
  25
  26 require_once(dirname(__FILE__) . "/log.inc");
  27 require_once(dirname(__FILE__) . "/sql.inc");
  28 require_once(dirname(__FILE__) . "/pnotes.inc");
  29 require_once(dirname(__FILE__) . "/../controllers/C_Document.class.php");
  30 require_once(dirname(__FILE__) . "/documents.php");
  31 require_once(dirname(__FILE__) . "/gprelations.inc.php");
  32
  33 /**
  34  * Connect to a phiMail Direct Messaging server
  35  */
  36
  37 function phimail_connect(&$phimail_error) {
  38
  39    if ($GLOBALS['phimail_enable'] == false) {
  40       $phimail_error = 'C1';
  41       return false; //for safety
  42    }
  43
  44    $phimail_server = @parse_url($GLOBALS['phimail_server_address']);
  45    $phimail_username = $GLOBALS['phimail_username'];
  46    $phimail_password = $GLOBALS['phimail_password'];
  47    $phimail_cafile = dirname(__FILE__) . '/../sites/' . $_SESSION['site_id']
  48       . '/documents/phimail_server_pem/phimail_server.pem';
  49    if (!file_exists($phimail_cafile)) $phimail_cafile='';
  50
  51    $phimail_secure = true;
  52    switch ($phimail_server['scheme']) {
  53        case "tcp":
  54        case "http": $server = "tcp://".$phimail_server['host'];
  55                $phimail_secure = false;
  56                break;
  57        case "https": $server = "ssl://" . $phimail_server['host']
  58                . ':' . $phimail_server['port'];
  59                break;
  60        case "ssl":
  61        case "sslv3":
  62        case "tls": $server = $GLOBALS['phimail_server_address'];
  63                break;
  64        default: $phimail_error = 'C2';
  65                return false;
  66    }
  67    if ($phimail_secure) {
  68       $context = stream_context_create();
  69       if ($phimail_cafile != '' &&
  70             (!stream_context_set_option($context, 'ssl', 'verify_peer', true) ||
  71              !stream_context_set_option($context, 'ssl', 'cafile', $phimail_cafile))) {
  72          $phimail_error = 'C3';
  73          return false;
  74       }
  75       $socket_tries = 0;
  76       $fp = false;
  77       while ($socket_tries < 3 && !$fp) {
  78          $socket_tries++;
  79          $fp = @stream_socket_client($server, $err1, $err2, 10,
  80             STREAM_CLIENT_CONNECT, $context);
  81       }
  82       if (!$fp) {
  83          if ($err1 == '111') $err2 = xl('Server may be offline');
  84          if ($err2 == '') $err2 = xl('Connection error');
  85          $phimail_error = "C4 $err1 ($err2)";
  86       }
  87    } else {
  88       $fp = @fsockopen($server,$phimail_server['port']);
  89    }
  90    return $fp;
  91 }
  92
  93 /**
  94  * Connect to a phiMail Direct Messaging server and check for any incoming status
  95  * messages related to previously transmitted messages or any new messages received.
  96  */
  97
  98 function phimail_check() {
  99    $fp = phimail_connect($err);
 100    if ($fp===false) {
 101       phimail_logit(0,xl('could not connect to server').' '.$err);
 102       return;
 103    }
 104    $phimail_username = $GLOBALS['phimail_username'];
 105    $phimail_password = $GLOBALS['phimail_password'];
 106
 107    $ret = phimail_write_expect_OK($fp,"AUTH $phimail_username $phimail_password\n");
 108    if($ret!==TRUE) {
 109       phimail_logit(0, "authentication error " . $ret);
 110       return;
 111    }
 112
 113    if(!($notifyUsername = $GLOBALS['phimail_notify'])) $notifyUsername='admin'; //fallback
 114
 115    while (1) {
 116       phimail_write($fp,"CHECK\n");
 117       $ret=fgets($fp,512);
 118
 119       if($ret=="NONE\n") { //nothing to process
 120           phimail_close($fp);
 121           phimail_logit(1,"message check completed");
 122           return;
 123       }
 124       else if(substr($ret,0,6)=="STATUS") {
 125           //Format STATUS message-id status-code [additional-information]
 126           $val=explode(" ",trim($ret),4);
 127           $sql='SELECT * from direct_message_log WHERE msg_id = ?';
 128           $res = sqlStatementNoLog($sql,array($val[1]));
 129           if ($res===FALSE) { //database problem
 130              phimail_close($fp);
 131              phimail_logit(0,"database problem");
 132              return;
 133           }
 134           if (($msg=sqlFetchArray($res))===FALSE) {
 135              //no match, so log it and move on (should never happen)
 136              phimail_logit(0,"NO MATCH: ".$ret);
 137              $ret = phimail_write_expect_OK($fp,"OK\n");
 138              if($ret!==TRUE) return; else continue;
 139           }
 140
 141           //if we get here, $msg contains the matching outgoing message record
 142           if($val[2]=='failed') {
 143              $success=0;
 144              $status='F';
 145           } else if ($val[2]=='dispatched') {
 146              $success=1;
 147              $status='D';
 148           } else {
 149              //unrecognized status, log it and move on (should never happen)
 150              $ret = "UNKNOWN STATUS: ".$ret;
 151              $success=0;
 152              $status='U';
 153           }
 154
 155           phimail_logit($success,$ret,$msg['patient_id']);
 156
 157           if (!isset($val[3])) $val[3]="";
 158           $sql = "UPDATE direct_message_log SET status=?, status_ts=NOW(), status_info=? WHERE msg_type='S' AND msg_id=?";
 159           $res = sqlStatementNoLog($sql,array($status,$val[3],$val[1]));
 160           if ($res===FALSE) { //database problem
 161              phimail_close($fp);
 162              phimail_logit(0,"database problem updating: ".$val[1]);
 163              return;
 164           }
 165
 166           if (!$success) {
 167              //notify local user of failure
 168              $sql = "SELECT username FROM users WHERE id = ?";
 169              $res2 = sqlStatementNoLog($sql, array($msg['user_id']));
 170              $fail_user = ($res2 === FALSE || ($user_row = sqlFetchArray($res2)) === FALSE) ?
 171                 xl('unknown (see log)') : $user_row['username'];
 172              $fail_notice = xl('Sent by:') . ' ' . $fail_user . '(' . $msg['user_id'] . ') ' . xl('on') . ' ' . $msg['create_ts']
 173                 . "\n" . xl('Sent to:') . ' ' . $msg['recipient'] . "\n" . xl('Server message:') . ' ' . $ret;
 174              phimail_notify( xl('Direct Messaging Send Failure.'), $fail_notice);
 175              $pnote_id = addPnote($msg['patient_id'],
 176                 xl("FAILURE NOTICE: Direct Message Send Failed.") . "\n\n$fail_notice\n",
 177                 0, 1, "Unassigned", $notifyUsername, "", "New", "phimail-service");
 178           }
 179
 180           //done with this status message
 181           $ret = phimail_write_expect_OK($fp,"OK\n");
 182           if($ret!==TRUE) {
 183              phimail_close($fp);
 184              return;
 185           }
 186
 187       }
 188
 189       else if(substr($ret,0,4)=="MAIL") {
 190
 191          $val = explode(" ",trim($ret),5); // MAIL recipient sender #attachments msg-id
 192          $recipient=$val[1];
 193          $sender=$val[2];
 194          $att=(int)$val[3];
 195          $msg_id=$val[4];
 196
 197          //request main message
 198          $ret2 = phimail_write_expect_OK($fp,"SHOW 0\n");
 199          if($ret2!==TRUE) {
 200             phimail_close($fp);
 201             return;
 202          }
 203
 204          //get message headers
 205          $hdrs="";
 206          while (($next_hdr = fgets($fp,1024)) != "\n")
 207             $hdrs .= $next_hdr;
 208
 209          $mime_type=fgets($fp,512);
 210          $mime_info=explode(";",$mime_type);
 211          $mime_type_main=strtolower($mime_info[0]);
 212
 213          //get main message body
 214          $body_len=fgets($fp,256);
 215          $body=phimail_read_blob($fp,$body_len);
 216          if ($body===FALSE) {
 217            phimail_close($fp);
 218            return;
 219          }
 220
 221          $att2=fgets($fp,256);
 222          if($att2!=$att) { //safety for mismatch on attachments
 223             phimail_close($fp);
 224             return;
 225          }
 226
 227          //get attachment info
 228          if($att>0) {
 229             for ($attnum=0;$attnum<$att;$attnum++) {
 230                 if(  ($attinfo[$attnum]['name']=fgets($fp,1024)) === FALSE
 231                   || ($attinfo[$attnum]['mime']=fgets($fp,1024)) === FALSE
 232                   || ($attinfo[$attnum]['desc']=fgets($fp,1024)) === FALSE) {
 233                      phimail_close($fp);
 234                      return;
 235                 }
 236              }
 237           }
 238
 239           //main part gets stored as document if not plain text content
 240           //(if plain text it will be the body of the final pnote)
 241           $all_doc_ids = array();
 242           $doc_id=0;
 243           $att_detail="";
 244           if ($mime_type_main != "text/plain") {
 245              $name = uniqid("dm-message-") . phimail_extension($mime_type_main);
 246              $doc_id = phimail_store($name,$mime_type_main,$body);
 247              if (!$doc_id) {
 248                 phimail_close($fp);
 249                 return;
 250              }
 251              $idnum=$doc_id['doc_id'];
 252              $all_doc_ids[] = $idnum;
 253              $url=$doc_id['url'];
 254              $url=substr($url,strrpos($url,"/")+1);
 255              $att_detail = "\n" . xl ("Document") . " $idnum (\"$url\"; $mime_type_main; " .
 256                 filesize($body) . " bytes) Main message body";
 257           }
 258
 259           //download and store attachments
 260           for($attnum=0;$attnum<$att;$attnum++) {
 261              $ret2 = phimail_write_expect_OK($fp,"SHOW " . ($attnum+1) . "\n");
 262              if ($ret2!==TRUE) {
 263                 phimail_close($fp);
 264                 return;
 265              }
 266
 267              //we can ignore next two lines (repeat of name and mime-type)
 268              if ( ($a1=fgets($fp,512))===FALSE || ($a2=fgets($fp,512))===FALSE ) {
 269                 phimail_close($fp);
 270                 return;
 271              }
 272
 273              $att_len = fgets($fp,256); //length of file
 274              $attdata = phimail_read_blob($fp,$att_len);
 275              if ($attdata===FALSE) {
 276                 phimail_close($fp);
 277                 return;
 278              }
 279              $attinfo[$attnum]['file']=$attdata;
 280
 281              $req_name = trim($attinfo[$attnum]['name']);
 282              $req_name = (empty($req_name) ? $attdata : "dm-") . $req_name;
 283              $attinfo[$attnum]['mime'] = explode(";",trim($attinfo[$attnum]['mime']));
 284              $attmime = strtolower($attinfo[$attnum]['mime'][0]);
 285              $att_doc_id = phimail_store($req_name, $attmime, $attdata);
 286              if (!$att_doc_id) {
 287                 phimail_close($fp);
 288                 return;
 289              }
 290              $attinfo[$attnum]['doc_id']=$att_doc_id;
 291              $idnum=$att_doc_id['doc_id'];
 292              $all_doc_ids[] = $idnum;
 293              $url=$att_doc_id['url'];
 294              $url=substr($url,strrpos($url,"/")+1);
 295              $att_detail = $att_detail . "\n" . xl ("Document") . " $idnum (\"$url\"; $attmime; " .
 296                  filesize($attdata) . " bytes) " . trim($attinfo[$attnum]['desc']);
 297          }
 298
 299          if ($att_detail != "")
 300            $att_detail = "\n\n" . xl("The following documents were attached to this Direct message:") . $att_detail;
 301
 302          $ret2 = phimail_write_expect_OK($fp,"DONE\n"); //we'll check for failure after logging.
 303
 304          //logging only after succesful download, storage, and acknowledgement of message
 305          $sql = "INSERT INTO direct_message_log (msg_type,msg_id,sender,recipient,status,status_ts,user_id) " .
 306             "VALUES ('R', ?, ?, ?, 'R', NOW(), ?)";
 307          $res = sqlStatementNoLog($sql,array($msg_id,$sender,$recipient,phimail_service_userID()));
 308
 309          phimail_logit(1,$ret);
 310
 311          //alert appointed user about new message
 312          switch($mime_type_main) {
 313
 314            case "text/plain":
 315              $body_text = @file_get_contents($body); //this was not uploaded as a document
 316              unlink($body);
 317              $pnote_id = addPnote(0, xl("Direct Message Received.") . "\n$hdrs\n$body_text$att_detail",
 318                0, 1, "Unassigned", $notifyUsername, "", "New", "phimail-service");
 319              break;
 320
 321            default:
 322              $note = xl("Direct Message Received.") . "\n$hdrs\n"
 323                 . xl("Message content is not plain text so it has been stored as a document.") . $att_detail;
 324              $pnote_id = addPnote(0, $note, 0, 1, "Unassigned", $notifyUsername, "", "New", "phimail-service");
 325              break;
 326
 327          }
 328
 329          foreach ($all_doc_ids as $doc_id) setGpRelation(1, $doc_id, 6, $pnote_id);
 330
 331          if ($ret2!==TRUE) {
 332             phimail_close();
 333             return;
 334          }
 335
 336       }
 337       else { //unrecognized or FAIL response
 338           phimail_logit(0, "problem checking messages " . $ret);
 339           phimail_close($fp);
 340           return;
 341       }
 342    }
 343 }
 344
 345 /**
 346  * Helper functions
 347  */
 348 function phimail_write($fp,$text) {
 349    fwrite($fp,$text);
 350    fflush($fp);
 351 }
 352
 353 function phimail_write_expect_OK($fp,$text) {
 354    phimail_write($fp,$text);
 355    $ret = fgets($fp,256);
 356    if($ret!="OK\n") { //unexpected error
 357       phimail_close($fp);
 358       return $ret;
 359    }
 360    return TRUE;
 361 }
 362
 363 function phimail_close($fp) {
 364    fwrite($fp,"BYE\n");
 365    fflush($fp);
 366    fclose($fp);
 367 }
 368
 369 function phimail_logit($success,$text,$pid=0,$event="direct-message-check") {
 370    newEvent($event,"phimail-service",0,$success,$text,$pid);
 371 }
 372
 373 /**
 374  * Read a blob of data into a local temporary file
 375  * @param $len number of bytes to read
 376  * @return the temp filename, or FALSE if failure
 377  */
 378 function phimail_read_blob($fp,$len) {
 379
 380    $fpath=$GLOBALS['temporary_files_dir'];
 381    if(!@file_exists($fpath)) {
 382      return FALSE;
 383    }
 384    $name = uniqid("direct-");
 385    $fn = $fpath . "/" . $name . ".dat";
 386    $dup = 1;
 387    while(file_exists($fn)) {
 388      $fn = $fpath . "/" . $name . "." . $dup++ . ".dat";
 389    }
 390
 391    $ff = @fopen ($fn, "w");
 392    if(!$ff) return FALSE;
 393
 394    $bytes_left=$len;
 395    $chunk_size=1024;
 396    while (!feof($fp) && $bytes_left>0) {
 397       if ($bytes_left < $chunk_size ) $chunk_size = $bytes_left;
 398       $chunk = fread($fp,$chunk_size);
 399       if($chunk===FALSE || @fwrite($ff,$chunk)===FALSE) {
 400          @fclose($ff);
 401          @unlink($fn);
 402          return FALSE;
 403       }
 404       $bytes_left -= strlen($chunk);
 405    }
 406    @fclose($ff);
 407    return($fn);
 408 }
 409
 410 /**
 411  * Return a suitable filename extension based on MIME-type
 412  * (very limited, default is .dat)
 413  */
 414 function phimail_extension($mime) {
 415   $m=explode("/",$mime);
 416   switch($mime) {
 417         case 'text/plain':
 418                 return (".txt");
 419         default:
 420   }
 421   switch($m[1]) {
 422         case 'html':
 423         case 'xml':
 424         case 'pdf':
 425                 return (".".$m[1]);
 426         default:
 427                 return (".dat");
 428   }
 429 }
 430
 431 function phimail_service_userID($name='phimail-service') {
 432    $sql = "SELECT id FROM users WHERE username=?";
 433    if (($r = sqlStatementNoLog($sql,array($name))) === FALSE ||
 434        ($u = sqlFetchArray($r)) === FALSE) {
 435       $user=1; //default if we don't have a service user
 436    } else {
 437       $user = $u['id'];
 438    }
 439    return ($user);
 440 }
 441
 442
 443 /**
 444  * Registers an attachment or non-text message file using the existing Document structure
 445  * @return Array(doc_id,URL) of the file as stored in documents table, false = failure
 446  */
 447 function phimail_store($name,$mime_type,$fn) {
 448
 449     // Collect phimail user id
 450     $user = phimail_service_userID();
 451
 452     // Import the document
 453     $return = addNewDocument($name,$mime_type,$fn,0,filesize($fn),$user,'direct');
 454
 455     // Remove the temporary file
 456     @unlink($fn);
 457
 458     // Return the result
 459     return $return;
 460 }
 461
 462 /**
 463  * Send an error notification or other alert to the notification address specified in globals.
 464  * (notification email function modified from interface/drugs/dispense_drug.php)
 465  * @return true if notification successfully sent, false otherwise
 466  */
 467 function phimail_notify($subj,$body) {
 468   $recipient = $GLOBALS['practice_return_email_path'];
 469   if (empty($recipient)) return false;
 470   $mail = new PHPMailer();
 471   $mail->From = $recipient;
 472   $mail->FromName = 'phiMail Gateway';
 473   $mail->isMail();
 474   $mail->Host = "localhost";
 475   $mail->Mailer = "mail";
 476   $mail->Body = $body;
 477   $mail->Subject = $subj;
 478   $mail->AddAddress($recipient);
 479   return ($mail->Send());
 480 }
 481
 482
 483 ?>