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__) . "/adodb/adodb.inc.php");
  25 require_once(dirname(__FILE__) . "/adodb/drivers/adodb-mysql.inc.php");
  26 require_once(dirname(__FILE__) . "/log.inc");
  27
  28 /**
  29 * ADODB_mysql class wrapper to ensure proper auditing in OpenEMR.
  30 *
  31 * @author  Kevin Yeh <kevin.y@integralemr.com>
  32 */
  33 class ADODB_mysql_log extends ADODB_mysql
  34 {
  35         /**
  36         * ADODB Execute function wrapper to ensure proper auditing in OpenEMR.
  37         *
  38         * Stashing the insert ID into lastidado so it doesn't get clobbered when
  39         * we insert into the audit log.
  40         *
  41         * @param  string  $sql         query
  42         * @param  array   $inputarr    binded variables array (optional)
  43         * @return boolean              returns false if error
  44         */
  45         function Execute($sql,$inputarr=false)
  46         {
  47             $retval= parent::Execute($sql,$inputarr);
  48             $GLOBALS['lastidado']=$this->Insert_ID();
  49             $outcome= ($retval === false) ? false : true;
  50             auditSQLEvent($sql,$outcome,$inputarr);
  51             return $retval;
  52         }
  53
  54         /**
  55         *  ADODB _insertid function wrapper to ensure proper auditing in OpenEMR.
  56         *
  57         *  Need to override this method to prevent infinite recursion with execute
  58         *  when trying to retrieve the last insert id.
  59         *
  60         * @return boolean    returns false if error
  61         */
  62         function _insertid()
  63         {
  64             $rs=$this->ExecuteNoLog("SELECT LAST_INSERT_ID()");
  65             $ret=reset($rs->fields);
  66             $rs->close();
  67             return $ret;
  68         }
  69
  70         /**
  71         * ADODB Execute function wrapper to skip auditing in OpenEMR.
  72         *
  73         * Bypasses the OpenEMR auditing engine.
  74         *
  75         * @param  string  $sql         query
  76         * @param  array   $inputarr    binded variables array (optional)
  77         * @return boolean              returns false if error
  78         */
  79         function ExecuteNoLog($sql,$inputarr=false)
  80         {
  81             return parent::Execute($sql,$inputarr);
  82         }
  83 }
  84 if (!defined('ADODB_FETCH_ASSOC')) define('ADODB_FETCH_ASSOC', 2);
  85 $database = NewADOConnection("mysql_log"); // Use the subclassed driver which logs execute events
  86
  87 $database->PConnect($host, $login, $pass, $dbase);
  88 $GLOBALS['adodb']['db'] = $database;
  89 $GLOBALS['dbh'] = $database->_connectionID;
  90
  91 // Modified 5/2009 by BM for UTF-8 project ---------
  92 if (!$disable_utf8_flag) {
  93  $success_flag = $database->Execute("SET NAMES 'utf8'");
  94   if (!$success_flag) {
  95    error_log("PHP custom error: from openemr library/sql.inc  - Unable to set up UTF8 encoding with mysql database: ".$database->ErrorMsg(), 0);
  96   }
  97 }
  98
  99 // set up associations in adodb calls (not sure why above define
 100 //  command does not work)
 101 $GLOBALS['adodb']['db']->SetFetchMode(ADODB_FETCH_ASSOC);
 102
 103 //fmg: This makes the login screen informative when no connection can be made
 104 if (!$GLOBALS['dbh']) {
 105   //try to be more helpful
 106   if ($host == "localhost") {
 107     echo "Check that mysqld is running.<p>";
 108   } else {
 109     echo "Check that you can ping the server '$host'.<p>";
 110   }//if local
 111   HelpfulDie("Could not connect to server!", mysql_error($GLOBALS['dbh']));
 112   exit;
 113 }//if no connection
 114
 115 /**
 116 * Standard sql query in OpenEMR.
 117 *
 118 * Function that will allow use of the adodb binding
 119 * feature to prevent sql-injection. Will continue to
 120 * be compatible with previous function calls that do
 121 * not use binding.
 122 * If use adodb binding, then will return a recordset object.
 123 * If do not use binding, then will return a resource object.
 124 * The sqlFetchArray() function should be used to
 125 * utilize the return object (it will accept both recordset
 126 * and resource objects).
 127 *
 128 * @param  string  $statement  query
 129 * @param  array   $binds      binded variables array (optional)
 130 * @return recordset/resource
 131 */
 132 function sqlStatement($statement, $binds=NULL )
 133 {
 134   if (is_array($binds)) {
 135     // Use adodb Execute with binding and return a recordset.
 136     //   Note that the auditSQLEvent function is embedded
 137     //    in the Execute command.
 138     $recordset = $GLOBALS['adodb']['db']->Execute( $statement, $binds );
 139     if ($recordset === FALSE) {
 140       HelpfulDie("query failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 141     }
 142     return $recordset;
 143   }
 144   else {
 145     // Use mysql_query and return a resource.
 146     $resource = mysql_query($statement, $GLOBALS['dbh']);
 147     if ($resource === FALSE) {
 148       auditSQLEvent($statement, FALSE, $binds);
 149       HelpfulDie("query failed: $statement", mysql_error($GLOBALS['dbh']));
 150     }
 151     auditSQLEvent($statement, TRUE, $binds);
 152     return $resource;
 153   }
 154 }
 155
 156 /**
 157 * Specialized sql query in OpenEMR that skips auditing.
 158 *
 159 * Function that will allow use of the adodb binding
 160 * feature to prevent sql-injection. Will continue to
 161 * be compatible with previous function calls that do
 162 * not use binding. It is equivalent to the
 163 * sqlStatement() function, EXCEPT it skips the
 164 * audit engine. This function should only be used
 165 * in very special situations.
 166 * If use adodb binding, then will return a recordset object.
 167 * If do not use binding, then will return a resource object.
 168 * The sqlFetchArray() function should be used to
 169 * utilize the return object (it will accept both recordset
 170 * and resource objects).
 171 *
 172 * @param  string  $statement  query
 173 * @param  array   $binds      binded variables array (optional)
 174 * @return recordset/resource
 175 */
 176 function sqlStatementNoLog($statement, $binds=NULL )
 177 {
 178   if (is_array($binds)) {
 179     // Use adodb ExecuteNoLog with binding and return a recordset.
 180     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog( $statement, $binds );
 181     if ($recordset === FALSE) {
 182       HelpfulDie("query failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 183     }
 184     return $recordset;
 185   }
 186   else {
 187     // Use mysql_query and return a resource.
 188     $resource = mysql_query($statement, $GLOBALS['dbh']);
 189     if ($resource === FALSE) {
 190       HelpfulDie("query failed: $statement", mysql_error($GLOBALS['dbh']));
 191     }
 192     return $resource;
 193   }
 194 }
 195
 196 /**
 197 * Returns a row (as an array) from a sql recordset or resource object.
 198 *
 199 * Function that will allow use of the adodb binding
 200 * feature to prevent sql-injection.
 201 * It will act upon the object returned from the
 202 * sqlStatement() function (and sqlQ() function).
 203 * It will automatically figure out if the input
 204 * object is a recordset or a resource.
 205 *
 206 * @param recordset/resource $r
 207 * @return array
 208 */
 209 function sqlFetchArray($r)
 210 {
 211   if (!is_resource($r)) {
 212     //treat as an adodb recordset
 213     if ($r === FALSE)
 214       return false;
 215     if ($r->EOF)
 216       return false;
 217     //ensure it's an object (ie. is set)
 218     if (!is_object($r))
 219       return false;
 220     return $r->FetchRow();
 221   }
 222   else {
 223     //treat as a mysql_query resource
 224     if ($r == FALSE)
 225       return false;
 226     return mysql_fetch_array($r, MYSQL_ASSOC);
 227   }
 228 }
 229
 230 /**
 231 * Standard sql insert query in OpenEMR.
 232 *
 233 * Function that will allow use of the adodb binding
 234 * feature to prevent sql-injection. This function
 235 * is specialized for insert function and will return
 236 * the last id generated from the insert.
 237 *
 238 * @param  string   $statement  query
 239 * @param  array    $binds      binded variables array (optional)
 240 * @return integer  Last id generated from the sql insert command
 241 */
 242 function sqlInsert($statement, $binds=array())
 243 {
 244   //Run a adodb execute
 245   // Note the auditSQLEvent function is embedded in the
 246   //   Execute function.
 247   $recordset = $GLOBALS['adodb']['db']->Execute($statement, $binds);
 248   if ($recordset === FALSE) {
 249     HelpfulDie("insert failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 250   }
 251   // Return the correct last id generated using function
 252   //   that is safe with the audit engine.
 253   return getSqlLastID();
 254 }
 255
 256 /**
 257 * Specialized sql query in OpenEMR that only returns
 258 * the first row of query results as an associative array.
 259 *
 260 * Function that will allow use of the adodb binding
 261 * feature to prevent sql-injection.
 262 *
 263 * @param  string  $statement  query
 264 * @param  array   $binds      binded variables array (optional)
 265 * @return array
 266 */
 267 function sqlQuery($statement, $binds=NULL)
 268 {
 269   if (is_array($binds)) {
 270     $recordset = $GLOBALS['adodb']['db']->Execute( $statement, $binds );
 271   }
 272   else {
 273     $recordset = $GLOBALS['adodb']['db']->Execute( $statement );
 274   }
 275   if ($recordset === FALSE) {
 276     HelpfulDie("query failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 277   }
 278   if ($recordset->EOF)
 279    return FALSE;
 280   $rez = $recordset->FetchRow();
 281   if ($rez == FALSE)
 282     return FALSE;
 283   return $rez;
 284 }
 285
 286 /**
 287 * Specialized sql query in OpenEMR that bypasses the auditing engine
 288 * and only returns the first row of query results as an associative array.
 289 *
 290 * Function that will allow use of the adodb binding
 291 * feature to prevent sql-injection. It is equivalent to the
 292 * sqlQuery() function, EXCEPT it skips the
 293 * audit engine. This function should only be used
 294 * in very special situations.
 295 *
 296 * @param  string  $statement  query
 297 * @param  array   $binds      binded variables array (optional)
 298 * @return array
 299 */
 300 function sqlQueryNoLog($statement, $binds=NULL)
 301 {
 302   if (is_array($binds)) {
 303     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog( $statement, $binds );
 304   }
 305   else {
 306     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog( $statement );
 307   }
 308   if ($recordset === FALSE) {
 309     HelpfulDie("query failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 310   }
 311   if ($recordset->EOF)
 312    return FALSE;
 313   $rez = $recordset->FetchRow();
 314   if ($rez == FALSE)
 315     return FALSE;
 316   return $rez;
 317 }
 318
 319 /**
 320 * Specialized sql query in OpenEMR that ignores sql errors, bypasses the
 321 * auditing engine and only returns the first row of query results as an
 322 * associative array.
 323 *
 324 * Function that will allow use of the adodb binding
 325 * feature to prevent sql-injection. It is equivalent to the
 326 * sqlQuery() function, EXCEPT it skips the
 327 * audit engine and ignores erros. This function should only be used
 328 * in very special situations.
 329 *
 330 * @param  string  $statement  query
 331 * @param  array   $binds      binded variables array (optional)
 332 * @return array
 333 */
 334 function sqlQueryNoLogIgnoreError($statement, $binds=NULL)
 335 {
 336   if (is_array($binds)) {
 337     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog( $statement, $binds );
 338   }
 339   else {
 340     $recordset = $GLOBALS['adodb']['db']->ExecuteNoLog( $statement );
 341   }
 342   if ($recordset === FALSE) {
 343     // ignore the error and return FALSE
 344     return FALSE;
 345   }
 346   if ($recordset->EOF)
 347    return FALSE;
 348   $rez = $recordset->FetchRow();
 349   if ($rez == FALSE)
 350     return FALSE;
 351   return $rez;
 352 }
 353
 354 /**
 355 * Specialized sql query in OpenEMR that skips auditing.
 356 *
 357 * This function should only be used in very special situations.
 358 *
 359 * @param  string  $statement  query
 360 */
 361 function sqlInsertClean_audit($statement)
 362 {
 363
 364   $ret = $GLOBALS['adodb']['db']->ExecuteNoLog($statement);
 365   if ($ret === FALSE) {
 366     HelpfulDie("insert failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 367   }
 368 }
 369
 370 /**
 371 * Function that will safely return the last ID inserted,
 372 * and accounts for the audit engine.
 373 *
 374 * @return  integer Last ID that was inserted into sql
 375 */
 376 function getSqlLastID() {
 377   if ($GLOBALS['lastidado'] >0) {
 378     return $GLOBALS['lastidado'];
 379   }
 380   else {
 381     return $GLOBALS['adodb']['db']->Insert_ID();
 382   }
 383 }
 384
 385 /**
 386 * Function that will return an array listing
 387 * of columns that exist in a table.
 388 *
 389 * @param   string  $table sql table
 390 * @return  array
 391 */
 392 function sqlListFields($table) {
 393   $sql = "SHOW COLUMNS FROM ". mysql_real_escape_string($table);
 394   $resource = sqlQ($sql);
 395   $field_list = array();
 396   while($row = mysql_fetch_array($resource)) {
 397     $field_list[] = $row['Field'];
 398   }
 399   return $field_list;
 400 }
 401
 402 /**
 403 * Returns the number of sql rows
 404 *
 405 * Function that will allow use of the adodb binding
 406 * feature to prevent sql-injection.
 407 * It will act upon the object returned from the
 408 * sqlStatement() function (and sqlQ() function).
 409 * It will automatically figure out if the input
 410 * object is a recordset or a resource.
 411 *
 412 * @param recordset/resource $r
 413 * @return integer Number of rows
 414 */
 415 function sqlNumRows($r)
 416 {
 417   if (!is_resource($r)) {
 418     //treat as an adodb recordset
 419     return $r->RecordCount();
 420   }
 421   else {
 422     //treat as a mysql_query resource
 423     return mysql_num_rows($r);
 424   }
 425 }
 426
 427 /**
 428 * Error function for OpenEMR sql functions
 429 *
 430 * @param string $statement
 431 * @param string $sqlerr
 432 */
 433 function HelpfulDie ($statement, $sqlerr='')
 434 {
 435   echo "<p><p><font color='red'>ERROR:</font> $statement<p>";
 436   if ($sqlerr) {
 437     echo "Error: <font color='red'>$sqlerr</font><p>";
 438   }//if error
 439   exit;
 440 }
 441
 442 /**
 443 * @todo document use of the generate_id function
 444 */
 445 function generate_id () {
 446   $database = $GLOBALS['adodb']['db'];
 447   return $database->GenID("sequences");
 448 }
 449
 450 /**
 451 * Specialized sql query in OpenEMR with limited functionality
 452 *
 453 * Does not fully incorporate the audit engine, so
 454 * recommend not using this function (if bind is set,
 455 * then will get logged, however if bind is not set,
 456 * then will not get logged).
 457 * Function that will allow use of the adodb binding
 458 * feature to prevent sql-injection. Will continue to
 459 * be compatible with previous function calls that do
 460 * not use binding.
 461 * If use adodb binding, then will return a recordset object.
 462 * If do not use binding, then will return a resource object.
 463 * The sqlFetchArray() function should be used to
 464 * utilize the return object (it will accept both recordset
 465 * and resource objects).
 466 *
 467 * @deprecated
 468 * @param  string  $statement  query
 469 * @param  array   $binds      binded variables array (optional)
 470 * @return recordset/resource
 471 */
 472 function sqlQ($statement, $binds=NULL )
 473 {
 474   if (is_array($binds)) {
 475     $recordset = $GLOBALS['adodb']['db']->Execute( $statement, $binds ) or
 476       HelpfulDie("query failed: $statement", $GLOBALS['adodb']['db']->ErrorMsg());
 477     return $recordset;
 478   }
 479   else {
 480     $resource = mysql_query($statement, $GLOBALS['dbh']) or
 481       HelpfulDie("query failed: $statement", mysql_error($GLOBALS['dbh']));
 482     return $resource;
 483   }
 484 }
 485
 486 /**
 487 * Simple wrapper for sqlInsert() function (deprecated).
 488 *
 489 * Function that will allow use of the adodb binding feature
 490 * to prevent sql-injection.
 491 *
 492 * @deprecated
 493 * @param  string   $statement  query
 494 * @param  array    $binds      binded variables array (optional)
 495 * @return integer  Last id generated from the sql insert command
 496 */
 497 function idSqlStatement($statement , $binds=NULL )
 498 {
 499   return sqlInsert($statement, $binds);
 500 }
 501
 502 /**
 503 * Simple wrapper for sqlInsert() function (deprecated).
 504 *
 505 * Function that will allow use of the adodb binding feature
 506 * to prevent sql-injection.
 507 *
 508 * @deprecated
 509 * @param  string   $statement  query
 510 * @param  array    $binds      binded variables array (optional)
 511 * @return integer  Last id generated from the sql insert command
 512 */
 513 function sqlInsertClean($statement, $binds=NULL )
 514 {
 515   return sqlInsert($statement, $binds);
 516 }
 517
 518 /**
 519 * Sql connection function (deprecated)
 520 *
 521 * No longer needed
 522 *
 523 * @deprecated
 524 * @param string $login
 525 * @param string $pass
 526 * @param string $dbase
 527 * @param string $host
 528 * @param string $port
 529 * @return connection
 530 */
 531 function sqlConnect($login,$pass,$dbase,$host,$port = '3306')
 532 {
 533   $GLOBALS['dbh'] = $database->_connectionID;
 534   return $GLOBALS['dbh'];
 535 }
 536
 537 /**
 538 * Sql close connection function (deprecated)
 539 *
 540 * No longer needed since PHP does this automatically.
 541 *
 542 * @deprecated
 543 * @return boolean
 544 */
 545 function sqlClose()
 546 {
 547   //----------Close our mysql connection
 548   $closed = $GLOBALS['adodb']['db']->close or
 549     HelpfulDie("could not disconnect from mysql server link", $GLOBALS['adodb']['db']->ErrorMsg());
 550   return $closed;
 551 }
 552
 553 /**
 554 * Very simple wrapper function and not necessary (deprecated)
 555 *
 556 * Do not use.
 557 *
 558 * @deprecated
 559 * @return connection
 560 */
 561 function get_db() {
 562   return $GLOBALS['adodb']['db'];
 563 }
 564
 565
 566
 567 ?>