library/sql.inc

   1 <?php
   2 /**
   3 * Sql functions/classes for OpenEMR.
   4 *
   5 * Includes classes and functions that OpenEMR uses
   6 * to interact with SQL.
   7 *
   8 * LICENSE: This program is free software: you can redistribute it and/or modify
   9 * it under the terms of the GNU General Public License as published by
  10 * the Free Software Foundation, either version 3 of the License, or
  11 * (at your option) any later version.
  12 * This program is distributed in the hope that it will be useful,
  13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 * GNU General Public License for more details.
  16 * You should have received a copy of the GNU General Public License
  17 * along with this program.  If not, see <http://opensource.org/licenses/gpl-license.php>.
  18 *
  19 * @package   OpenEMR
  20 * @link      http://www.open-emr.org
  21 */
  22
  23 require_once(dirname(__FILE__) . "/sqlconf.php");
  24 require_once(dirname(__FILE__) . "/../vendor/adodb/adodb-php/adodb.inc.php");
  25 require_once(dirname(__FILE__) . "/../vendor/adodb/adodb-php/drivers/adodb-mysqli.inc.php");
  26 require_once(dirname(__FILE__) . "/ADODB_mysqli_log.php");
  27
  28 if (!defined('ADODB_FETCH_ASSOC')) {
  29     define('ADODB_FETCH_ASSOC', 2);
  30 }
  31
  32 $database = NewADOConnection("mysqli_log"); // Use the subclassed driver which logs execute events
  33 // Below optionFlags flag is telling the mysql connection to ensure local_infile setting,
  34 // which is needed to import data in the Administration->Other->External Data Loads feature.
  35 // (Note the MYSQLI_READ_DEFAULT_GROUP is just to keep the current setting hard-coded in adodb)
  36 $database->optionFlags = array(array(MYSQLI_READ_DEFAULT_GROUP,0), array(MYSQLI_OPT_LOCAL_INFILE,1));
  37 // Set mysql to use ssl, if applicable.
  38 // Can support basic encryption by including just the mysql-ca pem (this is mandatory for ssl)
  39 // Can also support client based certificate if also include mysql-cert and mysql-key (this is optional for ssl)
  40 if (file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-ca")) {
  41     if (defined('MYSQLI_CLIENT_SSL')) {
  42         $database->clientFlags = MYSQLI_CLIENT_SSL;
  43     }
  44 }
  45 $database->port = $port;
  46 $database->PConnect($host, $login, $pass, $dbase);
  47 $GLOBALS['adodb']['db'] = $database;
  48 $GLOBALS['dbh'] = $database->_connectionID;
  49
  50 // Modified 5/2009 by BM for UTF-8 project ---------
  51 if (!$disable_utf8_flag) {
  52     $success_flag = $database->Execute("SET NAMES 'utf8'");
  53     if (!$success_flag) {
  54         error_log("PHP custom error: from openemr library/sql.inc  - Unable to set up UTF8 encoding with mysql database: ".getSqlLastError(), 0);
  55     }
  56 }
  57
  58 // Turn off STRICT SQL
  59 $sql_strict_set_success = $database->Execute("SET sql_mode = ''");
  60 if (!$sql_strict_set_success) {
  61     error_log("Unable to set strict sql setting: ".getSqlLastError(), 0);
  62 }
  63
  64 // set up associations in adodb calls (not sure why above define
  65 //  command does not work)
  66 $GLOBALS['adodb']['db']->SetFetchMode(ADODB_FETCH_ASSOC);
  67
  68 if ($GLOBALS['debug_ssl_mysql_connection']) {
  69     error_log("CHECK SSL CIPHER IN MAIN ADODB: " . print_r($GLOBALS['adodb']['db']->ExecuteNoLog("SHOW STATUS LIKE 'Ssl_cipher';")->fields, true));
  70 }
  71
  72 //fmg: This makes the login screen informative when no connection can be made
  73 if (!$GLOBALS['dbh']) {
  74   //try to be more helpful
  75     if ($host == "localhost") {
  76         echo "Check that mysqld is running.<p>";
  77     } else {
  78         echo "Check that you can ping the server " . text($host) . ".<p>";
  79     }//if local
  80     HelpfulDie("Could not connect to server!", getSqlLastError());
  81     exit;
  82 }//if no connection
  83
  84 /**
  85 * Standard sql query in OpenEMR.
  86 *
  87 * Function that will allow use of the adodb binding
  88 * feature to prevent sql-injection. Will continue to
  89 * be compatible with previous function calls that do
  90 * not use binding.
  91 * It will return a recordset object.
  92 * The sqlFetchArray() function should be used to
  93 * utilize the return object.
  94 *
  95 * @param  string  $statement  query
  96 * @param  array   $binds      binded variables array (optional)
  97 * @return recordset
  98 */
  99 function sqlStatement($statement, $binds = false)
 100 {
 101     // Below line is to avoid a nasty bug in windows.
 102     if (empty($binds)) {
 103         $binds = false;
 104     }
 105
 106     // Use adodb Execute with binding and return a recordset.
 107     //   Note that the auditSQLEvent function is embedded
 108     //    in the Execute command.
 109     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds);
 110     if ($recordset === false) {
 111         HelpfulDie("query failed: $statement", getSqlLastError());
 112     }
 113
 114     return $recordset;
 115 }
 116
 117 /**
 118 * Specialized sql query in OpenEMR that skips auditing.
 119 *
 120 * Function that will allow use of the adodb binding
 121 * feature to prevent sql-injection. Will continue to
 122 * be compatible with previous function calls that do
 123 * not use binding. It is equivalent to the
 124 * sqlStatement() function, EXCEPT it skips the
 125 * audit engine. This function should only be used
 126 * in very special situations.
 127 * It will return a recordset object.
 128 * The sqlFetchArray() function should be used to
 129 * utilize the return object.
 130 *
 131 * @param  string  $statement  query
 132 * @param  array   $binds      binded variables array (optional)
 133 * @return recordset
 134 */
 135 function sqlStatementNoLog($statement, $binds = false)
 136 {
 137     // Below line is to avoid a nasty bug in windows.
 138     if (empty($binds)) {
 139         $binds = false;
 140     }
 141
 142     // Use adodb ExecuteNoLog with binding and return a recordset.
 143     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 144     if ($recordset === false) {
 145         HelpfulDie("query failed: $statement", getSqlLastError());
 146     }
 147
 148     return $recordset;
 149 }
 150
 151 /**
 152 * sqlStatement() function wrapper for CDR engine in OpenEMR.
 153 * Allows option to turn on/off auditing specifically for the
 154 * CDR engine.
 155 *
 156 * @param  string  $statement  query
 157 * @param  array   $binds      binded variables array (optional)
 158 * @return recordset/resource
 159 */
 160 function sqlStatementCdrEngine($statement, $binds = false)
 161 {
 162     // Below line is to avoid a nasty bug in windows.
 163     if (empty($binds)) {
 164         $binds = false;
 165     }
 166
 167     if ($GLOBALS['audit_events_cdr']) {
 168         return sqlStatement($statement, $binds);
 169     } else {
 170         return sqlStatementNoLog($statement, $binds);
 171     }
 172 }
 173
 174 /**
 175 * Returns a row (as an array) from a sql recordset.
 176 *
 177 * Function that will allow use of the adodb binding
 178 * feature to prevent sql-injection.
 179 * It will act upon the object returned from the
 180 * sqlStatement() function (and sqlQ() function).
 181 *
 182 * @param recordset $r
 183 * @return array
 184 */
 185 function sqlFetchArray($r)
 186 {
 187     //treat as an adodb recordset
 188     if ($r === false) {
 189         return false;
 190     }
 191
 192     if ($r->EOF) {
 193         return false;
 194     }
 195
 196     //ensure it's an object (ie. is set)
 197     if (!is_object($r)) {
 198         return false;
 199     }
 200
 201     return $r->FetchRow();
 202 }
 203
 204
 205 /**
 206  * Wrapper for ADODB getAssoc
 207  *
 208  * @see http://adodb.org/dokuwiki/doku.php?id=v5:reference:connection:getassoc
 209  *
 210  * @param string $sql
 211  * @param string[] $bindvars
 212  * @param boolean $forceArray
 213  * @param boolean $first2Cols
 214  * @return array
 215  */
 216 function sqlGetAssoc($sql, $bindvars = false, $forceArray = false, $first2Cols = false)
 217 {
 218
 219     return $GLOBALS['adodb']['db']->getAssoc($sql, $bindvars, $forceArray, $first2Cols);
 220 }
 221
 222 /**
 223 * Standard sql insert query in OpenEMR.
 224 *  Only use this function if you need to have the
 225 *  id returned. If doing an insert query and do
 226 *  not need the id returned, then use the
 227 *  sqlStatement function instead.
 228 *
 229 * Function that will allow use of the adodb binding
 230 * feature to prevent sql-injection. This function
 231 * is specialized for insert function and will return
 232 * the last id generated from the insert.
 233 *
 234 * @param  string   $statement  query
 235 * @param  array    $binds      binded variables array (optional)
 236 * @return integer  Last id generated from the sql insert command
 237 */
 238 function sqlInsert($statement, $binds = false)
 239 {
 240     // Below line is to avoid a nasty bug in windows.
 241     if (empty($binds)) {
 242         $binds = false;
 243     }
 244
 245     //Run a adodb execute
 246     // Note the auditSQLEvent function is embedded in the
 247     //   Execute function.
 248     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds, true);
 249     if ($recordset === false) {
 250         HelpfulDie("insert failed: $statement", getSqlLastError());
 251     }
 252
 253     // Return the correct last id generated using function
 254     //   that is safe with the audit engine.
 255     return $GLOBALS['lastidado'] > 0 ? $GLOBALS['lastidado'] : $GLOBALS['adodb']['db']->Insert_ID();
 256 }
 257
 258 /**
 259 * Specialized sql query in OpenEMR that only returns
 260 * the first row of query results as an associative array.
 261 *
 262 * Function that will allow use of the adodb binding
 263 * feature to prevent sql-injection.
 264 *
 265 * @param  string  $statement  query
 266 * @param  array   $binds      binded variables array (optional)
 267 * @return array
 268 */
 269 function sqlQuery($statement, $binds = false)
 270 {
 271     // Below line is to avoid a nasty bug in windows.
 272     if (empty($binds)) {
 273         $binds = false;
 274     }
 275
 276     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds);
 277
 278     if ($recordset === false) {
 279         HelpfulDie("query failed: $statement", getSqlLastError());
 280     }
 281
 282     if ($recordset->EOF) {
 283         return false;
 284     }
 285
 286     $rez = $recordset->FetchRow();
 287     if ($rez == false) {
 288         return false;
 289     }
 290
 291     return $rez;
 292 }
 293
 294 /**
 295 * Specialized sql query in OpenEMR that bypasses the auditing engine
 296 * and only returns the first row of query results as an associative array.
 297 *
 298 * Function that will allow use of the adodb binding
 299 * feature to prevent sql-injection. It is equivalent to the
 300 * sqlQuery() function, EXCEPT it skips the
 301 * audit engine. This function should only be used
 302 * in very special situations.
 303 *
 304 * @param  string  $statement  query
 305 * @param  array   $binds      binded variables array (optional)
 306 * @return array
 307 */
 308 function sqlQueryNoLog($statement, $binds = false)
 309 {
 310     // Below line is to avoid a nasty bug in windows.
 311     if (empty($binds)) {
 312         $binds = false;
 313     }
 314
 315     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 316
 317     if ($recordset === false) {
 318         HelpfulDie("query failed: $statement", getSqlLastError());
 319     }
 320
 321     if ($recordset->EOF) {
 322         return false;
 323     }
 324
 325     $rez = $recordset->FetchRow();
 326     if ($rez == false) {
 327         return false;
 328     }
 329
 330     return $rez;
 331 }
 332
 333 /**
 334 * Specialized sql query in OpenEMR that ignores sql errors, bypasses the
 335 * auditing engine and only returns the first row of query results as an
 336 * associative array.
 337 *
 338 * Function that will allow use of the adodb binding
 339 * feature to prevent sql-injection. It is equivalent to the
 340 * sqlQuery() function, EXCEPT it skips the
 341 * audit engine and ignores erros. This function should only be used
 342 * in very special situations.
 343 *
 344 * @param  string  $statement  query
 345 * @param  array   $binds      binded variables array (optional)
 346 * @return array
 347 */
 348 function sqlQueryNoLogIgnoreError($statement, $binds = false)
 349 {
 350     // Below line is to avoid a nasty bug in windows.
 351     if (empty($binds)) {
 352         $binds = false;
 353     }
 354
 355     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 356
 357     if ($recordset === false) {
 358         // ignore the error and return FALSE
 359         return false;
 360     }
 361
 362     if ($recordset->EOF) {
 363         return false;
 364     }
 365
 366     $rez = $recordset->FetchRow();
 367     if ($rez == false) {
 368         return false;
 369     }
 370
 371     return $rez;
 372 }
 373
 374 /**
 375 * sqlQuery() function wrapper for CDR engine in OpenEMR.
 376 * Allows option to turn on/off auditing specifically for the
 377 * CDR engine.
 378 *
 379 * @param  string  $statement  query
 380 * @param  array   $binds      binded variables array (optional)
 381 * @return array
 382 */
 383 function sqlQueryCdrEngine($statement, $binds = false)
 384 {
 385     // Below line is to avoid a nasty bug in windows.
 386     if (empty($binds)) {
 387         $binds = false;
 388     }
 389
 390     if ($GLOBALS['audit_events_cdr']) {
 391         return sqlQuery($statement, $binds);
 392     } else {
 393         return sqlQueryNoLog($statement, $binds);
 394     }
 395 }
 396
 397 /**
 398 * Specialized sql query in OpenEMR that skips auditing.
 399 *
 400 * This function should only be used in very special situations.
 401 *
 402 * @param  string  $statement  query
 403 */
 404 function sqlInsertClean_audit($statement)
 405 {
 406
 407     $ret = $GLOBALS['adodb']['db']->ExecuteNoLog($statement);
 408     if ($ret === false) {
 409         HelpfulDie("insert failed: $statement", getSqlLastError());
 410     }
 411 }
 412
 413 /**
 414 * Function that will safely return the last error,
 415 * and accounts for the audit engine.
 416 *
 417 * @param   string  $mode either adodb(default) or native_mysql
 418 * @return  string        last mysql error
 419 */
 420 function getSqlLastError()
 421 {
 422     return !empty($GLOBALS['last_mysql_error']) ? $GLOBALS['last_mysql_error'] : $GLOBALS['adodb']['db']->ErrorMsg();
 423 }
 424
 425 /**
 426  * Function that will safely return the last error no,
 427  * and accounts for the audit engine.
 428  *
 429  * @param   string  $mode either adodb(default) or native_mysql
 430  * @return  string        last mysql error no
 431  */
 432 function getSqlLastErrorNo()
 433 {
 434     return !empty($GLOBALS['last_mysql_error_no']) ? $GLOBALS['last_mysql_error_no'] : $GLOBALS['adodb']['db']->ErrorNo();
 435 }
 436
 437 /**
 438 * Function that will return an array listing
 439 * of columns that exist in a table.
 440 *
 441 * @param   string  $table sql table
 442 * @return  array
 443 */
 444 function sqlListFields($table)
 445 {
 446     $sql = "SHOW COLUMNS FROM ". add_escape_custom($table);
 447     $resource = sqlQ($sql);
 448     $field_list = array();
 449     while ($row = sqlFetchArray($resource)) {
 450         $field_list[] = $row['Field'];
 451     }
 452
 453     return $field_list;
 454 }
 455
 456 /**
 457 * Returns the number of sql rows
 458 *
 459 * @param recordset $r
 460 * @return integer Number of rows
 461 */
 462 function sqlNumRows($r)
 463 {
 464     return $r->RecordCount();
 465 }
 466
 467 /**
 468 * Error function for OpenEMR sql functions
 469 *
 470 * @param string $statement
 471 * @param string $sqlerr
 472 */
 473 function HelpfulDie($statement, $sqlerr = '')
 474 {
 475
 476     echo "<h2><font color='red'>" . xlt('Query Error') . "</font></h2>";
 477
 478     if (!$GLOBALS['sql_string_no_show_screen']) {
 479         echo "<p><font color='red'>ERROR:</font> " . text($statement) . "</p>";
 480     }
 481
 482     $logMsg="SQL Error with statement:".$statement;
 483
 484     if ($sqlerr) {
 485         if (!$GLOBALS['sql_string_no_show_screen']) {
 486              echo "<p>Error: <font color='red'>" . text($sqlerr) . "</font></p>";
 487         }
 488
 489         $logMsg.="--".$sqlerr;
 490     }//if error
 491
 492     $backtrace = debug_backtrace();
 493
 494     if (!$GLOBALS['sql_string_no_show_screen']) {
 495         for ($level = 1; $level < count($backtrace); $level++) {
 496             $info = $backtrace[$level];
 497             echo "<br>" . text($info["file"] . " at " . $info["line"] . ":" . $info["function"]);
 498             if ($level > 1) {
 499                 echo "(" . text(implode(",", $info["args"])) . ")";
 500             }
 501         }
 502     }
 503
 504     $logMsg.="==>".$backtrace[1]["file"]." at ".$backtrace[1]["line"].":".$backtrace[1]["function"];
 505
 506     error_log($logMsg);
 507
 508     exit;
 509 }
 510
 511 /**
 512 * @todo document use of the generate_id function
 513 */
 514 function generate_id()
 515 {
 516     $database = $GLOBALS['adodb']['db'];
 517     return $database->GenID("sequences");
 518 }
 519
 520 /**
 521 * Deprecated function. Standard sql query in OpenEMR.
 522 *
 523 * Function that will allow use of the adodb binding
 524 * feature to prevent sql-injection. Will continue to
 525 * be compatible with previous function calls that do
 526 * not use binding.
 527 * It will return a recordset object.
 528 * The sqlFetchArray() function should be used to
 529 * utilize the return object.
 530 *
 531 * @deprecated
 532 * @param  string  $statement  query
 533 * @param  array   $binds      binded variables array (optional)
 534 * @return recordset
 535 */
 536 function sqlQ($statement, $binds = false)
 537 {
 538     // Below line is to avoid a nasty bug in windows.
 539     if (empty($binds)) {
 540         $binds = false;
 541     }
 542
 543     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds) or
 544     HelpfulDie("query failed: $statement", getSqlLastError());
 545     return $recordset;
 546 }
 547
 548
 549 /**
 550 * Sql close connection function (deprecated)
 551 *
 552 * No longer needed since PHP does this automatically.
 553 *
 554 * @deprecated
 555 * @return boolean
 556 */
 557 function sqlClose()
 558 {
 559   //----------Close our mysql connection
 560     $closed = $GLOBALS['adodb']['db']->close or
 561     HelpfulDie("could not disconnect from mysql server link", getSqlLastError());
 562     return $closed;
 563 }
 564
 565 /**
 566 * Very simple wrapper function and not necessary (deprecated)
 567 *
 568 * Do not use.
 569 *
 570 * @deprecated
 571 * @return connection
 572 */
 573 function get_db()
 574 {
 575     return $GLOBALS['adodb']['db'];
 576 }
 577
 578 /**
 579  * Generic mysql select db function
 580  * Used when converted to mysqli to centralize special circumstances.
 581  * @param string $database
 582  */
 583 function generic_sql_select_db($database, $link = null)
 584 {
 585     if (is_null($link)) {
 586         $link = $GLOBALS['dbh'];
 587     }
 588
 589     mysqli_select_db($link, $database);
 590 }
 591
 592 /**
 593  * Generic mysql affected rows function
 594  * Used when converted to mysqli to centralize special circumstances.
 595  *
 596  */
 597 function generic_sql_affected_rows()
 598 {
 599     return mysqli_affected_rows($GLOBALS['dbh']);
 600 }
 601
 602 /**
 603  * Generic mysql insert id function
 604  * Used when converted to mysqli to centralize special circumstances.
 605  *
 606                  */
 607 function generic_sql_insert_id()
 608 {
 609     return mysqli_insert_id($GLOBALS['dbh']);
 610 }
 611
 612
 613 /**
 614  * Begin a Transaction.
 615  */
 616 function sqlBeginTrans()
 617 {
 618     $GLOBALS['adodb']['db']->BeginTrans();
 619 }
 620
 621
 622 /**
 623  * Commit a transaction
 624  */
 625 function sqlCommitTrans($ok = true)
 626 {
 627     $GLOBALS['adodb']['db']->CommitTrans();
 628 }
 629
 630
 631 /**
 632  * Rollback a transaction
 633  */
 634 function sqlRollbackTrans()
 635 {
 636     $GLOBALS['adodb']['db']->RollbackTrans();
 637 }