library/sql.inc

   1 <?php
   2
   3 /**
   4  * Sql functions/classes for OpenEMR.
   5  *
   6  * Includes classes and functions that OpenEMR uses
   7  * to interact with SQL.
   8  *
   9  * @package   OpenEMR
  10  * @link      http://www.open-emr.org
  11  * @author    Brady Miller <brady.g.miller@gmail.com>
  12  * @author    Kevin Yeh <kevin.y@integralemr.com>
  13  * @copyright Copyright (c) 2019 Brady Miller <brady.g.miller@gmail.com>
  14  * @copyright Copyright (c) 2013 Kevin Yeh <kevin.y@integralemr.com>
  15  * @copyright Copyright (c) 2013 OEMR <www.oemr.org>
  16  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  17  */
  18
  19 require_once(dirname(__FILE__) . "/sqlconf.php");
  20 require_once(dirname(__FILE__) . "/../vendor/adodb/adodb-php/adodb.inc.php");
  21 require_once(dirname(__FILE__) . "/../vendor/adodb/adodb-php/drivers/adodb-mysqli.inc.php");
  22 require_once(dirname(__FILE__) . "/ADODB_mysqli_log.php");
  23
  24 if (!defined('ADODB_FETCH_ASSOC')) {
  25     define('ADODB_FETCH_ASSOC', 2);
  26 }
  27
  28 $database = NewADOConnection("mysqli_log"); // Use the subclassed driver which logs execute events
  29 // Below optionFlags flag is telling the mysql connection to ensure local_infile setting,
  30 // which is needed to import data in the Administration->Other->External Data Loads feature.
  31 // (Note the MYSQLI_READ_DEFAULT_GROUP is just to keep the current setting hard-coded in adodb)
  32 $database->setConnectionParameter(MYSQLI_READ_DEFAULT_GROUP, 0);
  33 $database->setConnectionParameter(MYSQLI_OPT_LOCAL_INFILE, 1);
  34 // Set mysql to use ssl, if applicable.
  35 // Can support basic encryption by including just the mysql-ca pem (this is mandatory for ssl)
  36 // Can also support client based certificate if also include mysql-cert and mysql-key (this is optional for ssl)
  37 if (file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-ca")) {
  38     if (defined('MYSQLI_CLIENT_SSL')) {
  39         if (
  40             file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-key") &&
  41             file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-cert")
  42         ) {
  43             // with client side certificate/key
  44             $database->ssl_key = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-key";
  45             $database->ssl_cert = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-cert";
  46             $database->ssl_ca = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-ca";
  47         } else {
  48             // without client side certificate/key
  49             $database->ssl_ca = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-ca";
  50         }
  51         $database->clientFlags = MYSQLI_CLIENT_SSL;
  52     }
  53 }
  54 $database->port = $port;
  55 if ((!empty($GLOBALS["enable_database_connection_pooling"]) || !empty($_SESSION["enable_database_connection_pooling"])) && empty($GLOBALS['connection_pooling_off'])) {
  56     $database->PConnect($host, $login, $pass, $dbase);
  57 } else {
  58     $database->connect($host, $login, $pass, $dbase);
  59 }
  60 $GLOBALS['adodb']['db'] = $database;
  61 $GLOBALS['dbh'] = $database->_connectionID;
  62
  63 // Modified 5/2009 by BM for UTF-8 project ---------
  64 if (!$disable_utf8_flag) {
  65     if (!empty($sqlconf["db_encoding"]) && ($sqlconf["db_encoding"] == "utf8mb4")) {
  66         $success_flag = $database->ExecuteNoLog("SET NAMES 'utf8mb4'");
  67         if (!$success_flag) {
  68             error_log("PHP custom error: from openemr library/sql.inc  - Unable to set up UTF8MB4 encoding with mysql database: " . errorLogEscape(getSqlLastError()), 0);
  69         }
  70     } else {
  71         $success_flag = $database->ExecuteNoLog("SET NAMES 'utf8'");
  72         if (!$success_flag) {
  73             error_log("PHP custom error: from openemr library/sql.inc  - Unable to set up UTF8 encoding with mysql database: " . errorLogEscape(getSqlLastError()), 0);
  74         }
  75     }
  76 }
  77
  78 // Turn off STRICT SQL
  79 $sql_strict_set_success = $database->ExecuteNoLog("SET sql_mode = ''");
  80 if (!$sql_strict_set_success) {
  81     error_log("Unable to set strict sql setting: " . errorLogEscape(getSqlLastError()), 0);
  82 }
  83
  84 // set up associations in adodb calls (not sure why above define
  85 //  command does not work)
  86 $GLOBALS['adodb']['db']->SetFetchMode(ADODB_FETCH_ASSOC);
  87
  88 if (!empty($GLOBALS['debug_ssl_mysql_connection'])) {
  89     error_log("CHECK SSL CIPHER IN MAIN ADODB: " . errorLogEscape(print_r($GLOBALS['adodb']['db']->ExecuteNoLog("SHOW STATUS LIKE 'Ssl_cipher';")->fields, true)));
  90 }
  91
  92 //fmg: This makes the login screen informative when no connection can be made
  93 if (!$GLOBALS['dbh']) {
  94   //try to be more helpful
  95     if ($host == "localhost") {
  96         echo "Check that mysqld is running.<p>";
  97     } else {
  98         echo "Check that you can ping the server " . text($host) . ".<p>";
  99     }//if local
 100     HelpfulDie("Could not connect to server!", getSqlLastError());
 101     exit;
 102 }//if no connection
 103
 104 /**
 105 * Standard sql query in OpenEMR.
 106 *
 107 * Function that will allow use of the adodb binding
 108 * feature to prevent sql-injection. Will continue to
 109 * be compatible with previous function calls that do
 110 * not use binding.
 111 * It will return a recordset object.
 112 * The sqlFetchArray() function should be used to
 113 * utilize the return object.
 114 *
 115 * @param  string  $statement  query
 116 * @param  array   $binds      binded variables array (optional)
 117 * @return recordset
 118 */
 119 function sqlStatement($statement, $binds = false)
 120 {
 121     // Below line is to avoid a nasty bug in windows.
 122     if (empty($binds)) {
 123         $binds = false;
 124     }
 125
 126     // Use adodb Execute with binding and return a recordset.
 127     //   Note that the auditSQLEvent function is embedded
 128     //    in the Execute command.
 129     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds);
 130     if ($recordset === false) {
 131         HelpfulDie("query failed: $statement", getSqlLastError());
 132     }
 133
 134     return $recordset;
 135 }
 136
 137 /**
 138  * Standard sql query in OpenEMR.
 139  *
 140  * Function that will allow use of the adodb binding
 141  * feature to prevent sql-injection. Will continue to
 142  * be compatible with previous function calls that do
 143  * not use binding.
 144  * It will return a recordset object.
 145  * The sqlFetchArray() function should be used to
 146  * utilize the return object.
 147  *
 148  * @param  string  $statement  query
 149  * @param  array   $binds      binded variables array (optional)
 150  * @return recordset
 151  */
 152 function sqlStatementThrowException($statement, $binds = false)
 153 {
 154     // Below line is to avoid a nasty bug in windows.
 155     if (empty($binds)) {
 156         $binds = false;
 157     }
 158
 159     //Run a adodb execute
 160     // Note the auditSQLEvent function is embedded in the
 161     //   Execute function.
 162     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds, true);
 163     if ($recordset === false) {
 164         throw new \OpenEMR\Common\Database\SqlQueryException($statement, "Failed to execute statement. Error: " . getSqlLastError() . " Statement: " . $statement);
 165     }
 166     return $recordset;
 167 }
 168
 169 /**
 170  * Return the last inserted sql id for a query.
 171  * @return int
 172  */
 173 function sqlGetLastInsertId()
 174 {
 175     // Return the correct last id generated using function
 176     //   that is safe with the audit engine.
 177     return $GLOBALS['lastidado'] > 0 ? $GLOBALS['lastidado'] : $GLOBALS['adodb']['db']->Insert_ID();
 178 }
 179
 180 /**
 181 * Specialized sql query in OpenEMR that skips auditing.
 182 *
 183 * Function that will allow use of the adodb binding
 184 * feature to prevent sql-injection. Will continue to
 185 * be compatible with previous function calls that do
 186 * not use binding. It is equivalent to the
 187 * sqlStatement() function, EXCEPT it skips the
 188 * audit engine. This function should only be used
 189 * in very special situations.
 190 * It will return a recordset object.
 191 * The sqlFetchArray() function should be used to
 192 * utilize the return object.
 193 *
 194 * @param  string  $statement  query
 195 * @param  array   $binds      binded variables array (optional)
 196 * @return recordset
 197 */
 198 function sqlStatementNoLog($statement, $binds = false)
 199 {
 200     // Below line is to avoid a nasty bug in windows.
 201     if (empty($binds)) {
 202         $binds = false;
 203     }
 204
 205     // Use adodb ExecuteNoLog with binding and return a recordset.
 206     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 207     if ($recordset === false) {
 208         HelpfulDie("query failed: $statement", getSqlLastError());
 209     }
 210
 211     return $recordset;
 212 }
 213
 214 /**
 215 * sqlStatement() function wrapper for CDR engine in OpenEMR.
 216 * Allows option to turn on/off auditing specifically for the
 217 * CDR engine.
 218 *
 219 * @param  string  $statement  query
 220 * @param  array   $binds      binded variables array (optional)
 221 * @return recordset/resource
 222 */
 223 function sqlStatementCdrEngine($statement, $binds = false)
 224 {
 225     // Below line is to avoid a nasty bug in windows.
 226     if (empty($binds)) {
 227         $binds = false;
 228     }
 229
 230     if ($GLOBALS['audit_events_cdr']) {
 231         return sqlStatement($statement, $binds);
 232     } else {
 233         return sqlStatementNoLog($statement, $binds);
 234     }
 235 }
 236
 237 /**
 238 * Returns a row (as an array) from a sql recordset.
 239 *
 240 * Function that will allow use of the adodb binding
 241 * feature to prevent sql-injection.
 242 * It will act upon the object returned from the
 243 * sqlStatement() function (and sqlQ() function).
 244 *
 245 * @param recordset $r
 246 * @return array
 247 */
 248 function sqlFetchArray($r)
 249 {
 250     //treat as an adodb recordset
 251     if ($r === false) {
 252         return false;
 253     }
 254
 255     if ($r->EOF) {
 256         return false;
 257     }
 258
 259     //ensure it's an object (ie. is set)
 260     if (!is_object($r)) {
 261         return false;
 262     }
 263
 264     return $r->FetchRow();
 265 }
 266
 267
 268 /**
 269  * Wrapper for ADODB getAssoc
 270  *
 271  * @see http://adodb.org/dokuwiki/doku.php?id=v5:reference:connection:getassoc
 272  *
 273  * @param string $sql
 274  * @param string[] $bindvars
 275  * @param boolean $forceArray
 276  * @param boolean $first2Cols
 277  * @return array
 278  */
 279 function sqlGetAssoc($sql, $bindvars = false, $forceArray = false, $first2Cols = false)
 280 {
 281
 282     return $GLOBALS['adodb']['db']->getAssoc($sql, $bindvars, $forceArray, $first2Cols);
 283 }
 284
 285 /**
 286 * Standard sql insert query in OpenEMR.
 287 *  Only use this function if you need to have the
 288 *  id returned. If doing an insert query and do
 289 *  not need the id returned, then use the
 290 *  sqlStatement function instead.
 291 *
 292 * Function that will allow use of the adodb binding
 293 * feature to prevent sql-injection. This function
 294 * is specialized for insert function and will return
 295 * the last id generated from the insert.
 296 *
 297 * @param  string   $statement  query
 298 * @param  array    $binds      binded variables array (optional)
 299 * @return integer  Last id generated from the sql insert command
 300 */
 301 function sqlInsert($statement, $binds = false)
 302 {
 303     // Below line is to avoid a nasty bug in windows.
 304     if (empty($binds)) {
 305         $binds = false;
 306     }
 307
 308     //Run a adodb execute
 309     // Note the auditSQLEvent function is embedded in the
 310     //   Execute function.
 311     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds, true);
 312     if ($recordset === false) {
 313         HelpfulDie("insert failed: $statement", getSqlLastError());
 314     }
 315
 316     // Return the correct last id generated using function
 317     //   that is safe with the audit engine.
 318     return $GLOBALS['lastidado'] > 0 ? $GLOBALS['lastidado'] : $GLOBALS['adodb']['db']->Insert_ID();
 319 }
 320
 321 /**
 322 * Specialized sql query in OpenEMR that only returns
 323 * the first row of query results as an associative array.
 324 *
 325 * Function that will allow use of the adodb binding
 326 * feature to prevent sql-injection.
 327 *
 328 * @param  string  $statement  query
 329 * @param  array   $binds      binded variables array (optional)
 330 * @return array
 331 */
 332 function sqlQuery($statement, $binds = false)
 333 {
 334     // Below line is to avoid a nasty bug in windows.
 335     if (empty($binds)) {
 336         $binds = false;
 337     }
 338
 339     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds);
 340
 341     if ($recordset === false) {
 342         HelpfulDie("query failed: $statement", getSqlLastError());
 343     }
 344
 345     if ($recordset->EOF) {
 346         return false;
 347     }
 348
 349     $rez = $recordset->FetchRow();
 350     if ($rez == false) {
 351         return false;
 352     }
 353
 354     return $rez;
 355 }
 356
 357 /**
 358 * Specialized sql query in OpenEMR that bypasses the auditing engine
 359 * and only returns the first row of query results as an associative array.
 360 *
 361 * Function that will allow use of the adodb binding
 362 * feature to prevent sql-injection. It is equivalent to the
 363 * sqlQuery() function, EXCEPT it skips the
 364 * audit engine. This function should only be used
 365 * in very special situations.
 366 *
 367 * Note: If you do an INSERT or UPDATE statement you will get an empty string ("") as a response
 368 *
 369 * @param  string  $statement  query
 370 * @param  array   $binds      binded variables array (optional)
 371 * @return array|false|""
 372 */
 373 function sqlQueryNoLog($statement, $binds = false)
 374 {
 375     // Below line is to avoid a nasty bug in windows.
 376     if (empty($binds)) {
 377         $binds = false;
 378     }
 379
 380     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 381
 382     if ($recordset === false) {
 383         HelpfulDie("query failed: $statement", getSqlLastError());
 384     }
 385
 386     if ($recordset->EOF) {
 387         return false;
 388     }
 389
 390     $rez = $recordset->FetchRow();
 391     if ($rez == false) {
 392         return false;
 393     }
 394
 395     return $rez;
 396 }
 397
 398 /**
 399 * Specialized sql query in OpenEMR that ignores sql errors, bypasses the
 400 * auditing engine and only returns the first row of query results as an
 401 * associative array.
 402 *
 403 * Function that will allow use of the adodb binding
 404 * feature to prevent sql-injection. It is equivalent to the
 405 * sqlQuery() function, EXCEPT it skips the
 406 * audit engine and ignores erros. This function should only be used
 407 * in very special situations.
 408 *
 409 * @param  string  $statement  query
 410 * @param  array   $binds      binded variables array (optional)
 411 * @return array
 412 */
 413 function sqlQueryNoLogIgnoreError($statement, $binds = false)
 414 {
 415     // Below line is to avoid a nasty bug in windows.
 416     if (empty($binds)) {
 417         $binds = false;
 418     }
 419
 420     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 421
 422     if ($recordset === false) {
 423         // ignore the error and return FALSE
 424         return false;
 425     }
 426
 427     if ($recordset->EOF) {
 428         return false;
 429     }
 430
 431     $rez = $recordset->FetchRow();
 432     if ($rez == false) {
 433         return false;
 434     }
 435
 436     return $rez;
 437 }
 438
 439 /**
 440 * sqlQuery() function wrapper for CDR engine in OpenEMR.
 441 * Allows option to turn on/off auditing specifically for the
 442 * CDR engine.
 443 *
 444 * @param  string  $statement  query
 445 * @param  array   $binds      binded variables array (optional)
 446 * @return array
 447 */
 448 function sqlQueryCdrEngine($statement, $binds = false)
 449 {
 450     // Below line is to avoid a nasty bug in windows.
 451     if (empty($binds)) {
 452         $binds = false;
 453     }
 454
 455     if ($GLOBALS['audit_events_cdr']) {
 456         return sqlQuery($statement, $binds);
 457     } else {
 458         return sqlQueryNoLog($statement, $binds);
 459     }
 460 }
 461
 462 /**
 463 * Specialized sql query in OpenEMR that skips auditing.
 464 *
 465 * This function should only be used in very special situations.
 466 *
 467 * @param  string  $statement  query
 468 */
 469 function sqlInsertClean_audit($statement, $binds = false)
 470 {
 471     // Below line is to avoid a nasty bug in windows.
 472     if (empty($binds)) {
 473         $binds = false;
 474     }
 475
 476     $ret = $GLOBALS['adodb']['db']->ExecuteNoLog($statement, $binds);
 477     if ($ret === false) {
 478         HelpfulDie("insert failed: $statement", getSqlLastError());
 479     }
 480 }
 481
 482 /**
 483 * Function that will safely return the last error,
 484 * and accounts for the audit engine.
 485 *
 486 * @param   string  $mode either adodb(default) or native_mysql
 487 * @return  string        last mysql error
 488 */
 489 function getSqlLastError()
 490 {
 491     return !empty($GLOBALS['last_mysql_error']) ? $GLOBALS['last_mysql_error'] : $GLOBALS['adodb']['db']->ErrorMsg();
 492 }
 493
 494 /**
 495  * Function that will safely return the last error no,
 496  * and accounts for the audit engine.
 497  *
 498  * @param   string  $mode either adodb(default) or native_mysql
 499  * @return  string        last mysql error no
 500  */
 501 function getSqlLastErrorNo()
 502 {
 503     return !empty($GLOBALS['last_mysql_error_no']) ? $GLOBALS['last_mysql_error_no'] : $GLOBALS['adodb']['db']->ErrorNo();
 504 }
 505
 506 /**
 507 * Function that will return an array listing
 508 * of columns that exist in a table.
 509 *
 510 * @param   string  $table sql table
 511 * @return  array
 512 */
 513 function sqlListFields($table)
 514 {
 515     $sql = "SHOW COLUMNS FROM " . add_escape_custom($table);
 516     $resource = sqlStatementNoLog($sql);
 517     $field_list = array();
 518     while ($row = sqlFetchArray($resource)) {
 519         $field_list[] = $row['Field'];
 520     }
 521
 522     return $field_list;
 523 }
 524
 525 /**
 526 * Returns the number of sql rows
 527 *
 528 * @param recordset $r
 529 * @return integer Number of rows
 530 */
 531 function sqlNumRows($r)
 532 {
 533     return $r->RecordCount();
 534 }
 535
 536 /**
 537 * Error function for OpenEMR sql functions
 538 *
 539 * @param string $statement
 540 * @param string $sqlerr
 541 */
 542 function HelpfulDie($statement, $sqlerr = '')
 543 {
 544
 545     echo "<h2><font color='red'>" . xlt('Query Error') . "</font></h2>";
 546
 547     if (!$GLOBALS['sql_string_no_show_screen']) {
 548         echo "<p><font color='red'>ERROR:</font> " . text($statement) . "</p>";
 549     }
 550
 551     $logMsg = "SQL Error with statement:" . $statement;
 552
 553     if ($sqlerr) {
 554         if (!$GLOBALS['sql_string_no_show_screen']) {
 555              echo "<p>Error: <font color='red'>" . text($sqlerr) . "</font></p>";
 556         }
 557
 558         $logMsg .= "--" . $sqlerr;
 559     }//if error
 560
 561     $backtrace = debug_backtrace();
 562
 563     if (!$GLOBALS['sql_string_no_show_screen']) {
 564         for ($level = 1; $level < count($backtrace); $level++) {
 565             $info = $backtrace[$level];
 566             echo "<br />" . text($info["file"] . " at " . $info["line"] . ":" . $info["function"]);
 567             if ($level > 1) {
 568                 echo "(" . text(implode(",", $info["args"])) . ")";
 569             }
 570         }
 571     }
 572
 573     $logMsg .= "==>" . $backtrace[1]["file"] . " at " . $backtrace[1]["line"] . ":" . $backtrace[1]["function"];
 574
 575     error_log(errorLogEscape($logMsg));
 576
 577     exit;
 578 }
 579
 580 /**
 581 * @todo document use of the generate_id function
 582 */
 583 function generate_id()
 584 {
 585     $database = $GLOBALS['adodb']['db'];
 586     return $database->GenID("sequences");
 587 }
 588
 589 /**
 590 * Deprecated function. Standard sql query in OpenEMR.
 591 *
 592 * Function that will allow use of the adodb binding
 593 * feature to prevent sql-injection. Will continue to
 594 * be compatible with previous function calls that do
 595 * not use binding.
 596 * It will return a recordset object.
 597 * The sqlFetchArray() function should be used to
 598 * utilize the return object.
 599 *
 600 * @deprecated
 601 * @param  string  $statement  query
 602 * @param  array   $binds      binded variables array (optional)
 603 * @return recordset
 604 */
 605 function sqlQ($statement, $binds = false)
 606 {
 607     // Below line is to avoid a nasty bug in windows.
 608     if (empty($binds)) {
 609         $binds = false;
 610     }
 611
 612     $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds) or
 613     HelpfulDie("query failed: $statement", getSqlLastError());
 614     return $recordset;
 615 }
 616
 617
 618 /**
 619 * Sql close connection function (deprecated)
 620 *
 621 * No longer needed since PHP does this automatically.
 622 *
 623 * @deprecated
 624 * @return boolean
 625 */
 626 function sqlClose()
 627 {
 628   //----------Close our mysql connection
 629     $closed = $GLOBALS['adodb']['db']->close or
 630     HelpfulDie("could not disconnect from mysql server link", getSqlLastError());
 631     return $closed;
 632 }
 633
 634 /**
 635 * Very simple wrapper function and not necessary (deprecated)
 636 *
 637 * Do not use.
 638 *
 639 * @deprecated
 640 * @return connection
 641 */
 642 function get_db()
 643 {
 644     return $GLOBALS['adodb']['db'];
 645 }
 646
 647 /**
 648  * Generic mysql select db function
 649  * Used when converted to mysqli to centralize special circumstances.
 650  * @param string $database
 651  */
 652 function generic_sql_select_db($database, $link = null)
 653 {
 654     if (is_null($link)) {
 655         $link = $GLOBALS['dbh'];
 656     }
 657
 658     mysqli_select_db($link, $database);
 659 }
 660
 661 /**
 662  * Generic mysql affected rows function
 663  * Used when converted to mysqli to centralize special circumstances.
 664  *
 665  */
 666 function generic_sql_affected_rows()
 667 {
 668     return mysqli_affected_rows($GLOBALS['dbh']);
 669 }
 670
 671 /**
 672  * Generic mysql insert id function
 673  * Used when converted to mysqli to centralize special circumstances.
 674  *
 675                  */
 676 function generic_sql_insert_id()
 677 {
 678     return mysqli_insert_id($GLOBALS['dbh']);
 679 }
 680
 681
 682 /**
 683  * Begin a Transaction.
 684  */
 685 function sqlBeginTrans()
 686 {
 687     $GLOBALS['adodb']['db']->BeginTrans();
 688 }
 689
 690
 691 /**
 692  * Commit a transaction
 693  */
 694 function sqlCommitTrans($ok = true)
 695 {
 696     $GLOBALS['adodb']['db']->CommitTrans();
 697 }
 698
 699
 700 /**
 701  * Rollback a transaction
 702  */
 703 function sqlRollbackTrans()
 704 {
 705     $GLOBALS['adodb']['db']->RollbackTrans();
 706 }
 707
 708 /**
 709  * For the 3 functions below:
 710  *
 711  * To support an optional higher level of security, queries that access password
 712  * related information use these functions instead of the standard functions
 713  * provided by sql.inc.
 714  *
 715  * By default, the privQuery and privStatement calls pass-through to
 716  * the existing ADODB instance initialized by sql.inc.
 717  *
 718  * If an additional configuration file is created (secure_sqlconf.php) and saved
 719  * in the sites/<sitename> directory (e.g. sites/default).  The MySQL login
 720  * information defined in that file as $secure_* will be used to create an ADODB
 721  * instance specifically for querying privileged information.
 722  *
 723  * By configuring a server in this way, the default MySQL user can be denied access
 724  * to sensitive tables (currently only "users_secure" would qualify).  Thus
 725  * the likelyhood of unintended modification can be reduced (e.g. through SQL Injection).
 726  *
 727  * Details on how to set this up are included in Documentation/privileged_db/priv_db_HOWTO
 728  *
 729  * The trade off for this additional security is extra complexity in configuration and
 730  * maintenance of the database, hence it is not enabled at install time and must be
 731  * done manually.
 732  *
 733  */
 734 function getPrivDB()
 735 {
 736     if (!isset($GLOBALS['PRIV_DB'])) {
 737         $secure_config = $GLOBALS['OE_SITE_DIR'] . "/secure_sqlconf.php";
 738         if (file_exists($secure_config)) {
 739             require_once($secure_config);
 740             $GLOBALS['PRIV_DB'] = NewADOConnection("mysqli_log"); // Use the subclassed driver which logs execute events
 741             // Below optionFlags flag is telling the mysql connection to ensure local_infile setting,
 742             // which is needed to import data in the Administration->Other->External Data Loads feature.
 743             // (Note the MYSQLI_READ_DEFAULT_GROUP is just to keep the current setting hard-coded in adodb)
 744             $GLOBALS['PRIV_DB']->setConnectionParameter(MYSQLI_READ_DEFAULT_GROUP, 0);
 745             $GLOBALS['PRIV_DB']->setConnectionParameter(MYSQLI_OPT_LOCAL_INFILE, 1);
 746             // Set mysql to use ssl, if applicable.
 747             // Can support basic encryption by including just the mysql-ca pem (this is mandatory for ssl)
 748             // Can also support client based certificate if also include mysql-cert and mysql-key (this is optional for ssl)
 749             if (file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-ca")) {
 750                 if (defined('MYSQLI_CLIENT_SSL')) {
 751                     if (
 752                         file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-key") &&
 753                         file_exists($GLOBALS['OE_SITE_DIR'] . "/documents/certificates/mysql-cert")
 754                     ) {
 755                         // with client side certificate/key
 756                         $GLOBALS['PRIV_DB']->ssl_key = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-key";
 757                         $GLOBALS['PRIV_DB']->ssl_cert = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-cert";
 758                         $GLOBALS['PRIV_DB']->ssl_ca = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-ca";
 759                     } else {
 760                         // without client side certificate/key
 761                         $GLOBALS['PRIV_DB']->ssl_ca = "${GLOBALS['OE_SITE_DIR']}/documents/certificates/mysql-ca";
 762                     }
 763                     $GLOBALS['PRIV_DB']->clientFlags = MYSQLI_CLIENT_SSL;
 764                 }
 765             }
 766             $GLOBALS['PRIV_DB']->port = $port;
 767             if ((!empty($GLOBALS["enable_database_connection_pooling"]) || !empty($_SESSION["enable_database_connection_pooling"])) && empty($GLOBALS['connection_pooling_off'])) {
 768                 $GLOBALS['PRIV_DB']->PConnect($secure_host, $secure_login, $secure_pass, $secure_dbase);
 769             } else {
 770                 $GLOBALS['PRIV_DB']->connect($secure_host, $secure_login, $secure_pass, $secure_dbase);
 771             }
 772             // set up associations in adodb calls
 773             $GLOBALS['PRIV_DB']->SetFetchMode(ADODB_FETCH_ASSOC);
 774             // debug hook for ssl stuff
 775             if (!empty($GLOBALS['debug_ssl_mysql_connection'])) {
 776                 error_log("CHECK SSL CIPHER IN PRIV_DB ADODB: " . errorLogEscape(print_r($GLOBALS[PRIV_DB]->ExecuteNoLog("SHOW STATUS LIKE 'Ssl_cipher';")->fields), true));
 777             }
 778         } else {
 779             $GLOBALS['PRIV_DB'] = $GLOBALS['adodb']['db'];
 780         }
 781     }
 782
 783     return $GLOBALS['PRIV_DB'];
 784 }
 785 /**
 786  * mechanism to use "super user" for SQL queries related to password operations
 787  *
 788  * @param type $sql
 789  * @param type $params
 790  * @return type
 791  */
 792 function privStatement($sql, $params = null)
 793 {
 794     if (is_array($params)) {
 795         $recordset = getPrivDB()->ExecuteNoLog($sql, $params);
 796     } else {
 797         $recordset = getPrivDB()->ExecuteNoLog($sql);
 798     }
 799
 800     if ($recordset === false) {
 801         // These error messages are explictly NOT run through xl() because we still
 802         // need them if there is a database problem.
 803         echo "Failure during database access! Check server error log.";
 804         $backtrace = debug_backtrace();
 805
 806         error_log("Executing as user:" . errorLogEscape(getPrivDB()->user) . " Statement failed:" . errorLogEscape($sql) . ":" . errorLogEscape($GLOBALS['last_mysql_error'])
 807             . "==>" . errorLogEscape($backtrace[1]["file"]) . " at " . errorLogEscape($backtrace[1]["line"]) . ":" . errorLogEscape($backtrace[1]["function"]));
 808         exit;
 809     }
 810
 811     return $recordset;
 812 }
 813 /**
 814  *
 815  * Wrapper for privStatement that just returns the first row of a query or FALSE
 816  * if there were no results.
 817  *
 818  * @param type $sql
 819  * @param type $params
 820  * @return boolean
 821  */
 822 function privQuery($sql, $params = null)
 823 {
 824     $recordset = privStatement($sql, $params);
 825     if ($recordset->EOF) {
 826         return false;
 827     }
 828
 829     $rez = $recordset->FetchRow();
 830     if ($rez == false) {
 831         return false;
 832     }
 833
 834     return $rez;
 835 }