forena-8.x-1.x-dev/src/FrxPlugin/Driver/FrxOracle.php
src/FrxPlugin/Driver/FrxOracle.php
<?php
// $Id$
/**
* @file
* Oracle specific driver that takes advantage of oracles native XML support
*
* In order to take advantage of XML support the following XML
*
*/
namespace Drupal\forena\FrxPlugin\Driver;
use Drupal\forena\FrxAPI;
use Drupal\forena\Token\SQLReplacer;
use Drupal\forena\File\DataFileSystem;
use \SimpleXMLElement;
/**
* Class FrxOracle
* @FrxDriver(
* id="FrxOracle",
* name="Oracle OCI Database Driver"
* )
*/
class FrxOracle extends DriverBase {
use FrxAPI;
private $db;
private $use_oracle_xml;
private $schema;
/**
* Object constructor
*
* @param string $uri Database connection string.
* @param string $repos_path Path to location of data block definitions
*/
public function __construct($name, $conf, DataFileSystem $fileSystem) {
parent::__construct($name, $conf, $fileSystem);
$this->db_type = 'oracle';
$this->use_oracle_xml = FALSE;
$uri = @$conf['uri'];
$this->debug = @$conf['debug'];
if (isset($conf['schema'])) $this->schema = $conf['schema'];
if (@$conf['oracle_xml']) $this->use_oracle_xml = TRUE;
if ($uri) {
// Test for postgres suport
if (!is_callable('oci_connect')) {
$this->app()->error('OCI support not installed.', 'OCI support not installed.');
return NULL;
}
try {
$db = oci_connect($conf['user'], $conf['password'], $uri, @$conf['character_set']);
$this->db = $db;
} catch ( \Exception $e) {
$this->app()->error('Unable to connect to database ' . $conf['title'], $e->getMessage());
}
}
else {
$this->app()->error('No database connection string specified', 'No database connection: ' . print_r($conf, 1));
}
// Set the date format that drupal expects using the date api.
if ($this->db) {
$stmt = oci_parse($this->db, "ALTER SESSION SET NLS_DATE_FORMAT='yyyy-mm-dd hh24:mi:ss'");
oci_execute($stmt);
$stmt = oci_parse($this->db, 'ALTER SESSION SET NLS_NUMERIC_CHARACTERS = ".,"');
oci_execute($stmt);
}
// Set up the stuff required to translate.
$this->te = new SQLReplacer($this);
}
/**
* Get data based on file data block in the repository.
*
* @param string $sql
* Query to execute
* @param array $options
* key value pairs containing type information for parameters.
* @return SimpleXMLElement | array
* Data from executed SQL query.
*/
public function sqlData($sql, $options = array()) {
// Load the block from the file
$db = $this->db;
$xml ='';
// Load the types array based on data
$this->types = isset($options['type']) ? $options['type'] : array();
if ($sql && $db) {
// See if this block matches a declare begin end; syntax.
if (stripos($sql, 'end;')>= stripos($sql, 'begin') && stripos($sql, 'begin')!==FALSE) {
$params = $this->currentDataContextArray();
$this->call($sql, $params, array('return' => 'clob'));
$xml = $params['return'];
if (trim($xml)) $xml = new \SimpleXMLElement($xml);
}
else {
$sql = $this->te->replace($sql);
if ($this->use_oracle_xml && @$options['return_type'] != 'raw') {
$xml = $this->oracle_xml($sql, 'table');
}
else {
$xml = $this->php_xml($sql, $options);
}
}
if ($this->debug) {
if (is_object($xml) && method_exists($xml, 'asXML')) {
$d = ($xml) ? htmlspecialchars($xml->asXML()) : '';
} else {
$d = ($xml) ? htmlspecialchars(print_r($xml,1)) : '';
}
$this->app()->debug('SQL: ' . $sql, '<pre> SQL:' . $sql . "\n XML: " . $d . "\n</pre>");
}
return $xml;
}
else {
return NULL;
}
}
public function query($sql, $options=array()) {
}
/**
* Generate xml from sql using the provided f_forena
*
* @param string $sql
* SQL statement to executee
* @return SimpleXMLElement
* XML representation of data
*/
private function oracle_xml($sql, $block) {
$db = $this->db;
//$rs->debugDumpParams();
$fsql = 'declare x XMLTYPE; begin x := f_forena_xml(:p1); :ret_val := x.getClobVal(); end; ';
$stmt = oci_parse($db, $fsql);
$ret = oci_new_descriptor($db, OCI_D_LOB);
oci_bind_by_name($stmt, ':ret_val', $ret, -1, OCI_B_CLOB);
oci_bind_by_name($stmt, ':p1', $sql);
$r = oci_execute($stmt, OCI_DEFAULT);
// Report errors
if (!$r) {
$e = oci_error($stmt); // For oci_execute errors pass the statement handle
$msg = htmlentities($e['message']);
$msg .= "\n<pre>\n";
$msg .= htmlentities($e['sqltext']);
//printf("\n%".($e['offset']+1)."s", "^");
$msg .= "\n</pre>\n";
$this->app()->error('Database error in ' . $this->block_name . ' see logs for info', $msg);
return NULL;
}
$xml_text = $ret->load();
if ($xml_text) {
$xml = new \SimpleXMLElement($xml_text);
if ($xml->getName() == 'error') {
if (!$this->block_name) {
$short = t('%e.', array('%e' => (string)$xml));
}
else {
$short = t('%e in %b.sql', array('%e' => (string)$xml, '%b' => $this->block_name));
}
$msg = (string)$xml . ' in ' . $this->block_name . '.sql. ';
$this->app()->error($short, $msg . ' in <pre> ' . $sql . '</pre>');
}
}
oci_free_statement($stmt);
return $xml;
}
private function php_xml($sql, $options=array()) {
$db = $this->db;
$raw_rows = array();
$xml = new \SimpleXMLElement('<table/>');
//$rs->debugDumpParams();
$stmt = oci_parse($db, $sql);
@oci_execute($stmt);
$raw = @$options['return_type'] == 'raw';
$e = oci_error($stmt); // For oci_execute errors pass the statement handle
//drupal_set_message(e_display_array($e));
if ($e) {
if ($e['code'] != '1403') {
if (!$this->block_name) {
$short = t('%e at offset %o', array('%e' => $e['message'], '%o' => $e['offset']));
}
else {
$short = t('%e in %b.sql line %o', array('%e' => $e['message'], '%b' => $this->block_name, '%o' => $e['offset']));
}
$msg = htmlentities($e['message']);
$msg .= "\n<pre>\n";
$msg .= htmlentities($e['sqltext']);
$msg .= "\n</pre>\n";
$this->app()->error($short, $msg);
return '';
}
}
$use_limit = isset($options['limit']);
if ($use_limit) $limit = $options['limit'];
$rownum=0;
while (($row = oci_fetch_array($stmt, OCI_ASSOC + OCI_RETURN_NULLS + OCI_RETURN_LOBS)) && (!$use_limit || $row < $limit)) {
$rownum++;
if ($raw) {
$raw_rows[] = (object)array_change_key_case($row);
}
else {
$row_node = $xml->addChild('row');
$row_node['num'] = $rownum;
foreach ($row as $key => $value) {
$row_node->addChild(strtolower($key), @htmlspecialchars($value));
}
}
}
oci_free_statement($stmt);
if ($raw) {
return $raw_rows;
}
return $xml;
}
/**
* @param string $sql
* script containing function
* @param array $data
* parameter array.
* @param array $types
* array containing types
* @return object
* oci statement resource
* Call a pl/sql block of code.
* The code snippet is expected to contain a begin/end data block as well as
* any variable binding that is necessary. Note that bind variables should appear
* only once in the calling code.
*/
public function call($sql, &$data, $types = array()) {
$db = $this->db;
$begin_end_block = stripos($sql, 'begin')===FALSE ? FALSE : TRUE;
$match=array();
$collections = array();
$return = array();
if ($db) $stmt = oci_parse($db, $sql);
if ($stmt) {
if (preg_match_all(FRX_SQL_TOKEN, $sql, $match)) {
//list($params) = $match[1];
$i=0;
foreach ($match[0] as $match_num => $token) {
$name = trim($token, ':');
$value = @$data[$name];
@list($type, $subtype) = explode(' of ', $types[$name], 2);
// Default varchar
if (!$type )$type = 'varchar';
switch (strtolower($type)) {
// Handle arrays based on subtype.
case 'array':
$value = (array) $value;
$bind_type = $this->oci_bind_type($subtype);
$entries = count($value);
if (!count($value)) {
$entries = 255;
}
oci_bind_array_by_name($stmt, $token, $value, $entries, -1, $bind_type);
break;
case 'clob':
$c = oci_new_descriptor($db, OCI_D_LOB);
$lobs[$name] = $c;
oci_bind_by_name($stmt, $token, $lobs[$name], -1, OCI_B_CLOB);
if (is_object($c)) {
$c->writeTemporary($value);
}
break;
case 'number':
case 'numeric':
case 'varchar':
oci_bind_by_name($stmt, $token, $data[$name], 32767);
break;
default:
$o = oci_new_collection($db, strtoupper($type), $this->schema);
$value = (array)$value;
$collections[$name] = $o;
if ($value && $o) foreach ($value as $element) {
$o->append($element);
}
oci_bind_by_name($stmt, $token, $o, -1, OCI_B_NTY);
break;
}
}
}
// putting the @ operator before the oci_execute call will suppress php warnings.
try {
$r = @oci_execute($stmt, OCI_DEFAULT);
// Report errors
if (!$r) {
$e = oci_error($stmt); // For oci_execute errors pass the statement handle
//drupal_set_message(e_display_array($e));
if ($e['code'] != '1403') {
if (!$this->block_name) {
$short = t('%e at offset %o', array('%e' => $e['message'], '%o' => $e['offset']));
}
else {
$short = t('%e in %b.sql line %o', array('%e' => $e['message'], '%b' => $this->block_name, '%o' => $e['offset']));
}
$msg = htmlentities($e['message']);
$msg .= "\n<pre>\n";
$msg .= htmlentities($e['sqltext']);
$msg .= "\n</pre>\n";
$this->app()->error($short, $msg);
}
}
}
catch ( \Exception $e) {
if (!$this->block_name) {
$short = t('%e at offset %o', array('%e' => $e['message'], '%o' => $e['offset']));
}
else {
$short = t('%e in %b.sql line %o', array('%e' => $e['message'], '%b' => $this->block_name, '%o' => $e['offset']));
}
$msg .= htmlentities($e['message']);
$msg .= "\n<pre>\n";
$msg .= htmlentities($e['sqltext']);
//printf("\n%".($e['offset']+1)."s", "^");
$msg .= "\n</pre>\n";
$this->app()->error($short, $msg);
}
// Retrieve any clob data.
if ($lobs) foreach ($lobs as $name => $lob) {
if (is_object($lob)) {
$data[$name] = $lob->load();
$lob->free();
}
}
// Free any collections
if ($collections) foreach ($collections as $col) {
if ($col) $col->free();
}
if (!$begin_end_block) {
$rows = array();
$rows = oci_fetch_all($stmt, $return, NULL, NULL, OCI_FETCHSTATEMENT_BY_ROW );
}
oci_free_statement($stmt);
}
return $return;
}
/**
* Implement custom SQL formatter to make sure that strings are properly escaped.
* Ideally we'd replace this with something that handles prepared statements, but it
* wouldn't work for
*
* @param string $value
* The value of the token replacement.
* @param string $key
* The name of the token being replaced.
* @param bool $raw
* TRUE implies the data should not be formatted for user input.
* @return string
* Formatted value.
*/
public function format($value, $key, $raw = FALSE) {
if ($raw) return $value;
$value = $this->parmConvert($key, $value);
if ($value==='' || $value ===NULL || $value ===array())
$value = 'NULL';
else {
if (is_array($value)) {
if ($value == array()) {
$value = 'NULL';
}
else {
// Build a array of values string
$i=0;
$val = '';
foreach ($value as $v) {
$i++;
if ($i==1) {
$val .= '(';
}
else {
$val .= ',';
}
$val .= "'" . str_replace("'", "''", $v) . "'";
}
$value = $val . ')';
}
}
elseif (is_int($value)) {
$value = (int)$value;
$value = (string)$value;
}
elseif (is_float($value)) {
$value = (float)$value;
$value = (string)$value;
}
else {
$value = trim($value);
$value = "'" . str_replace("'", "''", $value) . "'";
}
}
return $value;
}
public function searchTables($str) {
$str = strtoupper($str) . '%';
$db = $this->db;
$sql = $this->searchTablesSQL();
$stmt = oci_parse($db, $sql);
oci_bind_by_name($stmt, ":str", $str);
oci_execute($stmt);
$data = array();
$tables = array();
oci_fetch_all($stmt, $data, 0, 100, OCI_NUM);
foreach($data[0] as $table) {
$tables[] = strtolower($table);
}
return $tables;
}
/**
* Search table columns for match
* @see FrxDataSource::searchTableColumns()
*/
public function searchTableColumns($table, $str) {
$str = strtoupper($str) . '%';
$db = $this->db;
$sql = $this->searchTableColumnsSQL();
$table = strtoupper($table);
$stmt = oci_parse($db, $sql);
oci_bind_by_name($stmt, ':table_name', $table);
oci_bind_by_name($stmt, ":str", $str);
oci_execute($stmt);
$data = array();
$columns = array();
oci_fetch_all($stmt, $data, 0, 100, OCI_NUM);
if ($data) foreach($data[0] as $column) {
$columns[] = strtolower($column);
}
return $columns;
}
/**
* Destructor - Closes database connections.
*
*/
public function __destruct() {
$db = $this->db;
if ($db) {
oci_close($db);
}
}
}
