/usr/share/php/Horde/Db/Adapter/Oci8.php is in php-horde-db 2.3.1-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 | <?php
/**
* Copyright 2013-2016 Horde LLC (http://www.horde.org/)
*
* @author Jan Schneider <jan@horde.org>
* @license http://www.horde.org/licenses/bsd
* @category Horde
* @package Db
* @subpackage Adapter
*/
/**
* @since Horde_Db 2.1.0
* @author Jan Schneider <jan@horde.org>
* @license http://www.horde.org/licenses/bsd
* @category Horde
* @package Db
* @subpackage Adapter
*/
class Horde_Db_Adapter_Oci8 extends Horde_Db_Adapter_Base
{
/**
* Schema class to use.
*
* @var string
*/
protected $_schemaClass = 'Horde_Db_Adapter_Oracle_Schema';
/*#########################################################################
# Public
#########################################################################*/
/**
* Returns the human-readable name of the adapter. Use mixed case - one
* can always use downcase if needed.
*
* @return string
*/
public function adapterName()
{
return 'Oracle';
}
/**
* Does this adapter support migrations?
*
* @return boolean
*/
public function supportsMigrations()
{
return true;
}
/*#########################################################################
# Connection Management
#########################################################################*/
/**
* Connect to the db
*/
public function connect()
{
if ($this->_active) {
return;
}
$this->_checkRequiredConfig(array('username'));
if (!isset($this->_config['tns']) && empty($this->_config['host'])) {
throw new Horde_Db_Exception('Either a TNS name or a host name must be specified');
}
if (isset($this->_config['tns'])) {
$connection = $this->_config['tns'];
} else {
$connection = $this->_config['host'];
if (!empty($this->_config['port'])) {
$connection .= ':' . $this->_config['port'];
}
if (!empty($this->_config['service'])) {
$connection .= '/' . $this->_config['service'];
}
if (!empty($this->_config['type'])) {
$connection .= ':' . $this->_config['type'];
}
if (!empty($this->_config['instance'])) {
$connection .= '/' . $this->_config['instance'];
}
}
$oci = oci_connect(
$this->_config['username'],
isset($this->_config['password']) ? $this->_config['password'] : '',
$connection,
$this->_oracleCharsetName($this->_config['charset'])
);
if (!$oci) {
if ($error = oci_error()) {
throw new Horde_Db_Exception(
sprintf(
'Connect failed: (%d) %s',
$error['code'],
$error['message']
),
$error['code']
);
} else {
throw new Horde_Db_Exception('Connect failed');
}
}
$this->_connection = $oci;
$this->_active = true;
$this->execute("ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS'");
}
/**
* Disconnect from db
*/
public function disconnect()
{
if ($this->_connection) {
oci_close($this->_connection);
}
parent::disconnect();
}
/*#########################################################################
# Quoting
#########################################################################*/
/**
* Quotes a string, escaping any special characters.
*
* @param string $string
* @return string
*/
public function quoteString($string)
{
return "'" . str_replace("'", "''", $string) . "'";
}
/*#########################################################################
# Database Statements
#########################################################################*/
/**
* Returns an array of records with the column names as keys, and
* column values as values.
*
* @param string $sql SQL statement.
* @param mixed $arg1 Either an array of bound parameters or a query
* name.
* @param string $arg2 If $arg1 contains bound parameters, the query
* name.
*
* @return Horde_Db_Adapter_Oracle_Result
* @throws Horde_Db_Exception
*/
public function select($sql, $arg1 = null, $arg2 = null)
{
return new Horde_Db_Adapter_Oracle_Result($this, $sql, $arg1, $arg2);
}
/**
* Returns an array of record hashes with the column names as keys and
* column values as values.
*
* @param string $sql SQL statement.
* @param mixed $arg1 Either an array of bound parameters or a query
* name.
* @param string $arg2 If $arg1 contains bound parameters, the query
* name.
*
* @return array
* @throws Horde_Db_Exception
*/
public function selectAll($sql, $arg1 = null, $arg2 = null)
{
$stmt = $this->execute($sql, $arg1, $arg2);
$result = oci_fetch_all($stmt, $rows, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
if ($result === false) {
$this->_handleError($stmt, 'selectAll');
}
foreach ($rows as &$row) {
$row = array_change_key_case($row, CASE_LOWER);
}
return $rows;
}
/**
* Returns a record hash with the column names as keys and column values
* as values.
*
* @param string $sql SQL statement.
* @param mixed $arg1 Either an array of bound parameters or a query
* name.
* @param string $arg2 If $arg1 contains bound parameters, the query
* name.
*
* @return array
* @throws Horde_Db_Exception
*/
public function selectOne($sql, $arg1 = null, $arg2 = null)
{
if ($row = oci_fetch_assoc($this->execute($sql, $arg1, $arg2))) {
return array_change_key_case(
$row,
CASE_LOWER
);
}
}
/**
* Returns a single value from a record
*
* @param string $sql SQL statement.
* @param mixed $arg1 Either an array of bound parameters or a query
* name.
* @param string $arg2 If $arg1 contains bound parameters, the query
* name.
*
* @return string
* @throws Horde_Db_Exception
*/
public function selectValue($sql, $arg1 = null, $arg2 = null)
{
$stmt = $this->execute($sql, $arg1, $arg2);
if (!oci_fetch($stmt)) {
return;
}
if (($result = oci_result($stmt, 1)) === false) {
$this->_handleError($stmt, 'selectValue');
}
return $result;
}
/**
* Returns an array of the values of the first column in a select:
* selectValues("SELECT id FROM companies LIMIT 3") => [1,2,3]
*
* @param string $sql SQL statement.
* @param mixed $arg1 Either an array of bound parameters or a query
* name.
* @param string $arg2 If $arg1 contains bound parameters, the query
* name.
*
* @return array
* @throws Horde_Db_Exception
*/
public function selectValues($sql, $arg1 = null, $arg2 = null)
{
$stmt = $this->execute($sql, $arg1, $arg2);
$values = array();
while (oci_fetch($stmt)) {
if (($result = oci_result($stmt, 1)) === false) {
$this->_handleError($stmt, 'selectValues');
}
$values[] = $result;
}
return $values;
}
/**
* Executes the SQL statement in the context of this connection.
*
* @param string $sql SQL statement.
* @param mixed $arg1 Either an array of bound parameters or a query
* name.
* @param string $arg2 If $arg1 contains bound parameters, the query
* name.
*
* @return resource
* @throws Horde_Db_Exception
*/
public function execute($sql, $arg1 = null, $arg2 = null, $lobs = array())
{
if (is_array($arg1)) {
$sql = $this->_replaceParameters($sql, $arg1);
$name = $arg2;
} else {
$name = $arg1;
}
$t = new Horde_Support_Timer;
$t->push();
$this->_lastQuery = $sql;
$stmt = @oci_parse($this->_connection, $sql);
$descriptors = array();
foreach ($lobs as $name => $lob) {
$descriptors[$name] = oci_new_descriptor($this->_connection, OCI_DTYPE_LOB);
oci_bind_by_name($stmt, ':' . $name, $descriptors[$name], -1, $lob instanceof Horde_Db_Value_Binary ? OCI_B_BLOB : OCI_B_CLOB);
}
$flags = $lobs
? OCI_DEFAULT
: ($this->_transactionStarted
? OCI_NO_AUTO_COMMIT
: OCI_COMMIT_ON_SUCCESS
);
if (!$stmt ||
!@oci_execute($stmt, $flags)) {
$error = oci_error($stmt ?: $this->_connection);
if ($stmt) {
oci_free_statement($stmt);
}
$this->_logInfo($sql, $name);
$this->_logError($sql, 'QUERY FAILED: ' . $error['message']);
throw new Horde_Db_Exception(
$this->_errorMessage($error),
$error['code']
);
}
foreach ($lobs as $name => $lob) {
$descriptors[$name]->save($lob->value);
}
if ($lobs) {
oci_commit($this->_connection);
}
$this->_logInfo($sql, $name, $t->pop());
$this->_rowCount = oci_num_rows($stmt);
return $stmt;
}
/**
* Inserts a row into a table.
*
* @param string $sql SQL statement.
* @param array|string $arg1 Either an array of bound parameters or a
* query name.
* @param string $arg2 If $arg1 contains bound parameters, the
* query name.
* @param string $pk The primary key column.
* @param integer $idValue The primary key value. This parameter is
* required if the primary key is inserted
* manually.
* @param string $sequenceName The sequence name.
*
* @return integer Last inserted ID.
* @throws Horde_Db_Exception
*/
public function insert($sql, $arg1 = null, $arg2 = null, $pk = null,
$idValue = null, $sequenceName = null)
{
$this->execute($sql, $arg1, $arg2);
return $idValue
? $idValue
: $this->selectValue('SELECT id FROM horde_db_autoincrement');
}
/**
* Inserts a row including BLOBs into a table.
*
* @since Horde_Db 2.1.0
*
* @param string $table The table name.
* @param array $fields A hash of column names and values. BLOB columns
* must be provided as Horde_Db_Value_Binary
* objects.
* @param string $pk The primary key column.
* @param integer $idValue The primary key value. This parameter is
* required if the primary key is inserted
* manually.
*
* @return integer Last inserted ID.
* @throws Horde_Db_Exception
*/
public function insertBlob($table, $fields, $pk = null, $idValue = null)
{
list($fields, $blobs, $locators) = $this->_prepareBlobs($fields);
$sql = 'INSERT INTO ' . $this->quoteTableName($table) . ' ('
. implode(
', ',
array_map(array($this, 'quoteColumnName'), array_keys($fields))
)
. ') VALUES (' . implode(', ', $fields) . ')';
// Protect against empty values being passed for blobs.
if (!empty($blobs)) {
$sql .= ' RETURNING ' . implode(', ', array_keys($blobs)) . ' INTO '
. implode(', ', $locators);
}
$this->execute($sql, null, null, $blobs);
return $idValue
? $idValue
: $this->selectValue('SELECT id FROM horde_db_autoincrement');
}
/**
* Updates rows including BLOBs into a table.
*
* @since Horde_Db 2.2.0
*
* @param string $table The table name.
* @param array $fields A hash of column names and values. BLOB
* columns must be provided as
* Horde_Db_Value_Binary objects.
* @param string|array $where A WHERE clause. Either a complete clause or
* an array containing a clause with
* placeholders and a list of values.
*
* @throws Horde_Db_Exception
*/
public function updateBlob($table, $fields, $where = null)
{
list($fields, $blobs, $locators) = $this->_prepareBlobs($fields);
if (is_array($where)) {
$where = $this->_replaceParameters($where[0], $where[1]);
}
$fnames = array();
foreach ($fields as $field => $value) {
$fnames[] = $this->quoteColumnName($field) . ' = ' . $value;
}
$sql = sprintf(
'UPDATE %s SET %s%s',
$this->quoteTableName($table),
implode(', ', $fnames),
strlen($where) ? ' WHERE ' . $where : ''
);
// Protect against empty values for blobs.
if (!empty($blobs)) {
$sql .= sprintf(' RETURNING %s INTO %s',
implode(', ', array_keys($blobs)),
implode(', ', $locators)
);
}
$this->execute($sql, null, null, $blobs);
return $this->_rowCount;
}
/**
* Prepares a list of field values to be consumed by insertBlob() or
* updateBlob().
*
* @param array $fields A hash of column names and values. BLOB columns
* must be provided as Horde_Db_Value_Binary objects.
*
* @return array A list of fields, blobs, and locators.
*/
protected function _prepareBlobs($fields)
{
$blobs = $locators = array();
foreach ($fields as $column => &$field) {
if ($field instanceof Horde_Db_Value_Binary ||
$field instanceof Horde_Db_Value_Text) {
$blobs[$this->quoteColumnName($column)] = $field;
$locators[] = ':' . $this->quoteColumnName($column);
$field = $field instanceof Horde_Db_Value_Binary
? 'EMPTY_BLOB()'
: 'EMPTY_CLOB()';
} else {
$field = $this->quote($field);
}
}
return array($fields, $blobs, $locators);
}
/**
* Begins the transaction (and turns off auto-committing).
*/
public function beginDbTransaction()
{
$this->_transactionStarted++;
}
/**
* Commits the transaction (and turns on auto-committing).
*/
public function commitDbTransaction()
{
$this->_transactionStarted--;
if (!$this->_transactionStarted) {
if (!oci_commit($this->_connection)) {
$this->_handleError($this->_connection, 'commitDbTransaction');
}
}
}
/**
* Rolls back the transaction (and turns on auto-committing). Must be
* done if the transaction block raises an exception or returns false.
*/
public function rollbackDbTransaction()
{
if (!$this->_transactionStarted) {
return;
}
$this->_transactionStarted = 0;
if (!oci_rollback($this->_connection)) {
$this->_handleError($this->_connection, 'rollbackDbTransaction');
}
}
/**
* Appends LIMIT and OFFSET options to a SQL statement.
*
* @param string $sql SQL statement.
* @param array $options Hash with 'limit' and (optional) 'offset' values.
*
* @return string
*/
public function addLimitOffset($sql, $options)
{
if (isset($options['limit'])) {
$offset = isset($options['offset']) ? $options['offset'] : 0;
$limit = $options['limit'] + $offset;
if ($limit) {
$sql = "SELECT a.*, ROWNUM rnum FROM ($sql) a WHERE ROWNUM <= $limit";
if ($offset) {
$sql = "SELECT * FROM ($sql) WHERE rnum > $offset";
}
}
}
return $sql;
}
/*#########################################################################
# Protected
#########################################################################*/
/**
* Returns the Oracle name of a character set.
*
* @param string $charset A charset name.
*
* @return string Oracle-normalized charset.
*/
public function _oracleCharsetName($charset)
{
return str_replace(
array(
'iso-8859-1',
'iso-8859-2',
'iso-8859-4',
'iso-8859-5',
'iso-8859-6',
'iso-8859-7',
'iso-8859-8',
'iso-8859-9',
'iso-8859-1',
'iso-8859-10',
'iso-8859-13',
'iso-8859-15',
'shift_jis',
'shift-jis',
'windows-949',
'windows-950',
'windows-1250',
'windows-1251',
'windows-1252',
'windows-1253',
'windows-1254',
'windows-1255',
'windows-1256',
'windows-1257',
'windows-1258',
'utf-8',
),
array(
'WE8ISO8859P1',
'EE8ISO8859P2',
'NEE8ISO8859P4',
'CL8ISO8859P5',
'AR8ISO8859P6',
'EL8ISO8859P7',
'IW8ISO8859P8',
'WE8ISO8859P9',
'NE8ISO8859P10',
'BLT8ISO8859P13',
'WE8ISO8859P15',
'JA16SJIS',
'JA16SJIS',
'KO16MSWIN949',
'ZHT16MSWIN950',
'EE8MSWIN1250',
'CL8MSWIN1251',
'WE8MSWIN1252',
'EL8MSWIN1253',
'TR8MSWIN1254',
'IW8MSWIN1255',
'AR8MSWIN1256',
'BLT8MSWIN1257',
'VN8MSWIN1258',
'AL32UTF8',
),
Horde_String::lower($charset)
);
}
/**
* Creates a formatted error message from a oci_error() result hash.
*
* @param array $error Hash returned from oci_error().
*
* @return string The formatted error message.
*/
protected function _errorMessage($error)
{
return 'QUERY FAILED: ' . $error['message']
. "\n\nat offset " . $error['offset']
. "\n" . $error['sqltext'];
}
/**
* Log and throws an exception for the last error.
*
* @param resource $resource The resource (connection or statement) to
* call oci_error() upon.
* @param string $method The calling method.
*
* @throws Horde_Db_Exception
*/
protected function _handleError($resource, $method)
{
$error = oci_error($resource);
$this->_logError(
$error['message'],
'Horde_Db_Adapter_Oci8::' . $method. '()'
);
throw new Horde_Db_Exception(
$this->_errorMessage($error),
$error['code']
);
}
}
|