1a1e6784eSAndreas Gohr<?php 2a1e6784eSAndreas Gohr/** 3a1e6784eSAndreas Gohr * DokuWiki Plugin sqlite (Helper Component) 4a1e6784eSAndreas Gohr * 5a1e6784eSAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html 6a1e6784eSAndreas Gohr * @author Andreas Gohr <gohr@cosmocode.de> 7a1e6784eSAndreas Gohr */ 8a1e6784eSAndreas Gohr 9a1e6784eSAndreas Gohr// must be run within Dokuwiki 10a1e6784eSAndreas Gohrif(!defined('DOKU_INC')) die(); 11a1e6784eSAndreas Gohr 1287fa2c18Sstretchyboyif(!defined('DOKU_EXT_SQLITE')) define('DOKU_EXT_SQLITE', 'sqlite'); 1387fa2c18Sstretchyboyif(!defined('DOKU_EXT_PDO')) define('DOKU_EXT_PDO', 'pdo'); 14c137e95fSAndreas Gohrif(!defined('DOKU_EXT_NULL')) define('DOKU_EXT_NULL', 'null'); 1587fa2c18Sstretchyboy 16aa81d781SKlap-inrequire_once(DOKU_PLUGIN.'sqlite/classes/adapter.php'); 1787fa2c18Sstretchyboy 18*3e9ac593SGerrit Uitslag/** 19*3e9ac593SGerrit Uitslag * Class helper_plugin_sqlite 20*3e9ac593SGerrit Uitslag */ 21a1e6784eSAndreas Gohrclass helper_plugin_sqlite extends DokuWiki_Plugin { 22aa81d781SKlap-in var $adapter = null; 23aa81d781SKlap-in 24*3e9ac593SGerrit Uitslag /** 25*3e9ac593SGerrit Uitslag * @return helper_plugin_sqlite_adapter|null 26*3e9ac593SGerrit Uitslag */ 27ca2f2adaSKlap-in public function getAdapter() { 28ca2f2adaSKlap-in return $this->adapter; 29ca2f2adaSKlap-in } 30ca2f2adaSKlap-in 31a1e6784eSAndreas Gohr /** 32aa81d781SKlap-in * Keep separate instances for every call to keep database connections 33aa81d781SKlap-in */ 34aa81d781SKlap-in public function isSingleton() { 35aa81d781SKlap-in return false; 36aa81d781SKlap-in } 37aa81d781SKlap-in 38aa81d781SKlap-in /** 39a1e6784eSAndreas Gohr * constructor 40a1e6784eSAndreas Gohr */ 41aa81d781SKlap-in public function helper_plugin_sqlite() { 4287fa2c18Sstretchyboy 4313896259SKlap-in if(!$this->adapter) { 44b0653a7eSAndreas Gohr if($this->existsPDOSqlite() && empty($_ENV['SQLITE_SKIP_PDO'])) { 45aa81d781SKlap-in require_once(DOKU_PLUGIN.'sqlite/classes/adapter_pdosqlite.php'); 46aa81d781SKlap-in $this->adapter = new helper_plugin_sqlite_adapter_pdosqlite(); 47aa81d781SKlap-in } 48aa81d781SKlap-in } 49aa81d781SKlap-in 5013896259SKlap-in if(!$this->adapter) { 51aa81d781SKlap-in if($this->existsSqlite2()) { 52aa81d781SKlap-in require_once(DOKU_PLUGIN.'sqlite/classes/adapter_sqlite2.php'); 53aa81d781SKlap-in $this->adapter = new helper_plugin_sqlite_adapter_sqlite2(); 54aa81d781SKlap-in } 55aa81d781SKlap-in } 56aa81d781SKlap-in 5713896259SKlap-in if(!$this->adapter) { 58aa81d781SKlap-in msg('SQLite & PDO SQLite support missing in this PHP install - plugin will not work', -1); 59aa81d781SKlap-in } 60aa81d781SKlap-in } 61aa81d781SKlap-in 62aa81d781SKlap-in /** 63aa81d781SKlap-in * check availabilty of PHPs sqlite extension (for sqlite2 support) 64aa81d781SKlap-in */ 65aa81d781SKlap-in public function existsSqlite2() { 66aa81d781SKlap-in if(!extension_loaded('sqlite')) { 67aa81d781SKlap-in $prefix = (PHP_SHLIB_SUFFIX === 'dll') ? 'php_' : ''; 68aa81d781SKlap-in if(function_exists('dl')) @dl($prefix.'sqlite.'.PHP_SHLIB_SUFFIX); 69aa81d781SKlap-in } 70aa81d781SKlap-in 71aa81d781SKlap-in return function_exists('sqlite_open'); 72aa81d781SKlap-in } 73aa81d781SKlap-in 74aa81d781SKlap-in /** 75aa81d781SKlap-in * check availabilty of PHP PDO sqlite3 76aa81d781SKlap-in */ 77aa81d781SKlap-in public function existsPDOSqlite() { 7887fa2c18Sstretchyboy if(!extension_loaded('pdo_sqlite')) { 7987fa2c18Sstretchyboy $prefix = (PHP_SHLIB_SUFFIX === 'dll') ? 'php_' : ''; 8087fa2c18Sstretchyboy if(function_exists('dl')) @dl($prefix.'pdo_sqlite.'.PHP_SHLIB_SUFFIX); 8187fa2c18Sstretchyboy } 8287fa2c18Sstretchyboy 8387fa2c18Sstretchyboy if(class_exists('pdo')) { 84aa81d781SKlap-in foreach(PDO::getAvailableDrivers() as $driver) { 85aa81d781SKlap-in if($driver == 'sqlite') { 86aa81d781SKlap-in return true; 8787fa2c18Sstretchyboy } 8887fa2c18Sstretchyboy } 897ed6069fSAdrian Lang } 90aa81d781SKlap-in return false; 91a1e6784eSAndreas Gohr } 92a1e6784eSAndreas Gohr 93a1e6784eSAndreas Gohr /** 94a1e6784eSAndreas Gohr * Initializes and opens the database 95a1e6784eSAndreas Gohr * 96a1e6784eSAndreas Gohr * Needs to be called right after loading this helper plugin 97aa81d781SKlap-in * 98aa81d781SKlap-in * @param string $dbname 99aa81d781SKlap-in * @param string $updatedir - Database update infos 100aa81d781SKlap-in * @return bool 101a1e6784eSAndreas Gohr */ 102aa81d781SKlap-in public function init($dbname, $updatedir) { 103aa81d781SKlap-in $init = null; // set by initdb() 104c137e95fSAndreas Gohr if( !$this->adapter or !$this->adapter->initdb($dbname, $init) ){ 105c137e95fSAndreas Gohr require_once(DOKU_PLUGIN.'sqlite/classes/adapter_null.php'); 106c137e95fSAndreas Gohr $this->adapter = new helper_plugin_sqlite_adapter_null(); 107c137e95fSAndreas Gohr return false; 108c137e95fSAndreas Gohr } 109a1e6784eSAndreas Gohr 110aa81d781SKlap-in return $this->_updatedb($init, $updatedir); 111a1e6784eSAndreas Gohr } 112a1e6784eSAndreas Gohr 113a1e6784eSAndreas Gohr /** 114a1e6784eSAndreas Gohr * Return the current Database Version 115a1e6784eSAndreas Gohr */ 116aa81d781SKlap-in private function _currentDBversion() { 117a1e6784eSAndreas Gohr $sql = "SELECT val FROM opts WHERE opt = 'dbversion';"; 118a1e6784eSAndreas Gohr $res = $this->query($sql); 119a1e6784eSAndreas Gohr if(!$res) return false; 120a1e6784eSAndreas Gohr $row = $this->res2row($res, 0); 121a1e6784eSAndreas Gohr return (int) $row['val']; 122a1e6784eSAndreas Gohr } 123aa81d781SKlap-in 124a1e6784eSAndreas Gohr /** 125a1e6784eSAndreas Gohr * Update the database if needed 126a1e6784eSAndreas Gohr * 127a1e6784eSAndreas Gohr * @param bool $init - true if this is a new database to initialize 128a1e6784eSAndreas Gohr * @param string $updatedir - Database update infos 129aa81d781SKlap-in * @return bool 130a1e6784eSAndreas Gohr */ 13113896259SKlap-in private function _updatedb($init, $updatedir) { 132a1e6784eSAndreas Gohr if($init) { 1334d9093b4Sstretchyboy 134a1e6784eSAndreas Gohr $current = 0; 135a1e6784eSAndreas Gohr } else { 136a1e6784eSAndreas Gohr $current = $this->_currentDBversion(); 137a1e6784eSAndreas Gohr if(!$current) { 138aa81d781SKlap-in msg("SQLite: no DB version found. '".$this->adapter->getDbname()."' DB probably broken.", -1); 139a1e6784eSAndreas Gohr return false; 140a1e6784eSAndreas Gohr } 141a1e6784eSAndreas Gohr } 142a1e6784eSAndreas Gohr 143a1e6784eSAndreas Gohr // in case of init, add versioning table 144a1e6784eSAndreas Gohr if($init) { 145a1e6784eSAndreas Gohr if(!$this->_runupdatefile(dirname(__FILE__).'/db.sql', 0)) { 146aa81d781SKlap-in msg("SQLite: '".$this->adapter->getDbname()."' database upgrade failed for version ", -1); 147a1e6784eSAndreas Gohr return false; 148a1e6784eSAndreas Gohr } 149a1e6784eSAndreas Gohr } 150a1e6784eSAndreas Gohr 151a1e6784eSAndreas Gohr $latest = (int) trim(io_readFile($updatedir.'/latest.version')); 152a1e6784eSAndreas Gohr 153a1e6784eSAndreas Gohr // all up to date? 154a1e6784eSAndreas Gohr if($current >= $latest) return true; 155a1e6784eSAndreas Gohr for($i = $current + 1; $i <= $latest; $i++) { 156a1e6784eSAndreas Gohr $file = sprintf($updatedir.'/update%04d.sql', $i); 157a1e6784eSAndreas Gohr if(file_exists($file)) { 158a1e6784eSAndreas Gohr if(!$this->_runupdatefile($file, $i)) { 159aa81d781SKlap-in msg("SQLite: '".$this->adapter->getDbname()."' database upgrade failed for version ".$i, -1); 160a1e6784eSAndreas Gohr return false; 161a1e6784eSAndreas Gohr } 162a1e6784eSAndreas Gohr } 163a1e6784eSAndreas Gohr } 164a1e6784eSAndreas Gohr return true; 165a1e6784eSAndreas Gohr } 166a1e6784eSAndreas Gohr 167a1e6784eSAndreas Gohr /** 168a1e6784eSAndreas Gohr * Updates the database structure using the given file to 169a1e6784eSAndreas Gohr * the given version. 170a1e6784eSAndreas Gohr */ 171aa81d781SKlap-in private function _runupdatefile($file, $version) { 172a1e6784eSAndreas Gohr $sql = io_readFile($file, false); 173a1e6784eSAndreas Gohr 174f10ea6c1SKlap-in $sql = $this->SQLstring2array($sql); 175a1e6784eSAndreas Gohr array_unshift($sql, 'BEGIN TRANSACTION'); 176a1e6784eSAndreas Gohr array_push($sql, "INSERT OR REPLACE INTO opts (val,opt) VALUES ($version,'dbversion')"); 177a1e6784eSAndreas Gohr array_push($sql, "COMMIT TRANSACTION"); 178a1e6784eSAndreas Gohr 179f10ea6c1SKlap-in if(!$this->doTransaction($sql)) { 180f10ea6c1SKlap-in return false; 181f10ea6c1SKlap-in } 182f10ea6c1SKlap-in return ($version == $this->_currentDBversion()); 183f10ea6c1SKlap-in } 184f10ea6c1SKlap-in 185f10ea6c1SKlap-in /** 186f10ea6c1SKlap-in * Split sql queries on semicolons, unless when semicolons are quoted 187f10ea6c1SKlap-in * 188f10ea6c1SKlap-in * @param string $sql 189f10ea6c1SKlap-in * @return array sql queries 190f10ea6c1SKlap-in */ 191f10ea6c1SKlap-in public function SQLstring2array($sql) { 1923fb592daSAndreas Gohr $statements = array(); 1933fb592daSAndreas Gohr $len = strlen($sql); 1943fb592daSAndreas Gohr 1953fb592daSAndreas Gohr // Simple state machine to "parse" sql into single statements 1963fb592daSAndreas Gohr $in_str = false; 1973fb592daSAndreas Gohr $in_com = false; 1983fb592daSAndreas Gohr $statement = ''; 1993fb592daSAndreas Gohr for($i=0; $i<$len; $i++){ 2003fb592daSAndreas Gohr $prev = $i ? $sql{$i-1} : "\n"; 2013fb592daSAndreas Gohr $char = $sql{$i}; 2023fb592daSAndreas Gohr $next = $sql{$i+1}; 2033fb592daSAndreas Gohr 2043fb592daSAndreas Gohr // in comment? ignore everything until line end 2053fb592daSAndreas Gohr if($in_com){ 2063fb592daSAndreas Gohr if($char == "\n"){ 2073fb592daSAndreas Gohr $in_com = false; 2083fb592daSAndreas Gohr } 2093fb592daSAndreas Gohr continue; 2103fb592daSAndreas Gohr } 2113fb592daSAndreas Gohr 2123fb592daSAndreas Gohr // handle strings 2133fb592daSAndreas Gohr if($in_str){ 2145922cb27SAndreas Gohr if($char == "'"){ 2155922cb27SAndreas Gohr if($next == "'"){ 2165922cb27SAndreas Gohr // current char is an escape for the next 2173fb592daSAndreas Gohr $statement .= $char . $next; 2183fb592daSAndreas Gohr $i++; 2193fb592daSAndreas Gohr continue; 2205922cb27SAndreas Gohr }else{ 2215922cb27SAndreas Gohr // end of string 2223fb592daSAndreas Gohr $statement .= $char; 2233fb592daSAndreas Gohr $in_str = false; 2243fb592daSAndreas Gohr continue; 2253fb592daSAndreas Gohr } 2265922cb27SAndreas Gohr } 2273fb592daSAndreas Gohr // still in string 2283fb592daSAndreas Gohr $statement .= $char; 2293fb592daSAndreas Gohr continue; 2303fb592daSAndreas Gohr } 2313fb592daSAndreas Gohr 2323fb592daSAndreas Gohr // new comment? 2333fb592daSAndreas Gohr if($char == '-' && $next == '-' && $prev == "\n"){ 2343fb592daSAndreas Gohr $in_com = true; 2353fb592daSAndreas Gohr continue; 2363fb592daSAndreas Gohr } 2373fb592daSAndreas Gohr 2383fb592daSAndreas Gohr // new string? 2395922cb27SAndreas Gohr if($char == "'"){ 2405922cb27SAndreas Gohr $in_str = true; 2413fb592daSAndreas Gohr $statement .= $char; 2423fb592daSAndreas Gohr continue; 2433fb592daSAndreas Gohr } 2443fb592daSAndreas Gohr 2453fb592daSAndreas Gohr // the real delimiter 2463fb592daSAndreas Gohr if($char == ';'){ 2473fb592daSAndreas Gohr $statements[] = trim($statement); 2483fb592daSAndreas Gohr $statement = ''; 2493fb592daSAndreas Gohr continue; 2503fb592daSAndreas Gohr } 2513fb592daSAndreas Gohr 2523fb592daSAndreas Gohr // some standard query stuff 2533fb592daSAndreas Gohr $statement .= $char; 2543fb592daSAndreas Gohr } 2553fb592daSAndreas Gohr if($statement) $statements[] = trim($statement); 2563fb592daSAndreas Gohr 2573fb592daSAndreas Gohr return $statements; 258f10ea6c1SKlap-in } 259f10ea6c1SKlap-in 260f10ea6c1SKlap-in /** 261f10ea6c1SKlap-in * @param array $sql queries without terminating semicolon 262f10ea6c1SKlap-in * @param bool $sqlpreparing 263f10ea6c1SKlap-in * @return bool 264f10ea6c1SKlap-in */ 265f10ea6c1SKlap-in public function doTransaction($sql, $sqlpreparing = true) { 266a1e6784eSAndreas Gohr foreach($sql as $s) { 267a1e6784eSAndreas Gohr $s = preg_replace('!^\s*--.*$!m', '', $s); 268a1e6784eSAndreas Gohr $s = trim($s); 269a1e6784eSAndreas Gohr if(!$s) continue; 270fd69a32cSAndreas Gohr 271f10ea6c1SKlap-in if($sqlpreparing) { 272a1e6784eSAndreas Gohr $res = $this->query("$s;"); 273f10ea6c1SKlap-in } else { 274f10ea6c1SKlap-in $res = $this->adapter->executeQuery("$s;"); 275f10ea6c1SKlap-in } 276a1e6784eSAndreas Gohr if($res === false) { 277f10ea6c1SKlap-in //TODO check rollback for sqlite PDO 27813896259SKlap-in if($this->adapter->getName() == DOKU_EXT_SQLITE) { 2791dc19626SKlap-in $this->query('ROLLBACK TRANSACTION'); 280a1e6784eSAndreas Gohr } 28105f176edSstretchyboy return false; 28205f176edSstretchyboy } 283a1e6784eSAndreas Gohr } 284f10ea6c1SKlap-in return true; 285a1e6784eSAndreas Gohr } 286a1e6784eSAndreas Gohr 287a34ef333SKlap-in /** 288a34ef333SKlap-in * Dump db into a file in meta directory 289a34ef333SKlap-in * 290a34ef333SKlap-in */ 291a34ef333SKlap-in public function dumpDatabase($dbname, $from = DOKU_EXT_SQLITE) { 292a34ef333SKlap-in global $conf; 293a34ef333SKlap-in $adapterDumpDb = null; 294a34ef333SKlap-in //connect to desired database 295a34ef333SKlap-in if($this->adapter->getName() == $from) { 296a34ef333SKlap-in $adapterDumpDb =& $this->adapter; 297a34ef333SKlap-in } else { 298a34ef333SKlap-in if($from == DOKU_EXT_SQLITE) { 299a34ef333SKlap-in //TODO test connecting to sqlite2 database 300a34ef333SKlap-in if($this->existsSqlite2()) { 301a34ef333SKlap-in require_once(DOKU_PLUGIN.'sqlite/classes/adapter_sqlite2.php'); 302a34ef333SKlap-in $adapterDumpDb = new helper_plugin_sqlite_adapter_sqlite2(); 303a34ef333SKlap-in } else { 304a34ef333SKlap-in msg('PHP Sqlite Extension(needed for sqlite2) not available, database "'.hsc($dbname).'" is not dumped to file.'); 305a34ef333SKlap-in return false; 306a34ef333SKlap-in } 307a34ef333SKlap-in } 308a34ef333SKlap-in } 309a34ef333SKlap-in if($adapterDumpDb === null) { 310a34ef333SKlap-in msg('No adapter loaded'); 311a34ef333SKlap-in return false; 312a34ef333SKlap-in } 313a34ef333SKlap-in $init = false; 314a34ef333SKlap-in if(!$adapterDumpDb->initdb($dbname, $init)) { 315a34ef333SKlap-in msg('Opening database fails.', -1); 316a34ef333SKlap-in return false; 317a34ef333SKlap-in } 318f10ea6c1SKlap-in 319a34ef333SKlap-in $res = $adapterDumpDb->query(array("SELECT name,sql FROM sqlite_master WHERE type='table'")); 320a34ef333SKlap-in $tables = $adapterDumpDb->res2arr($res); 321a34ef333SKlap-in 322a34ef333SKlap-in $filename = $conf['metadir'].'/dumpfile_'.$dbname.'.sql'; 323a34ef333SKlap-in if($fp = fopen($filename, 'w')) { 324a34ef333SKlap-in 325a34ef333SKlap-in fwrite($fp, 'BEGIN TRANSACTION;'."\n"); 326a34ef333SKlap-in 327a34ef333SKlap-in foreach($tables as $table) { 328a34ef333SKlap-in 329a34ef333SKlap-in fwrite($fp, $table['sql'].";\n"); 330a34ef333SKlap-in 331a34ef333SKlap-in $sql = "SELECT * FROM ".$table['name']; 332a34ef333SKlap-in $res = $adapterDumpDb->query(array($sql)); 333a34ef333SKlap-in 334a34ef333SKlap-in while($row = $adapterDumpDb->res_fetch_array($res)) { 335a34ef333SKlap-in 336a34ef333SKlap-in $line = 'INSERT INTO '.$table['name'].' VALUES('; 337a34ef333SKlap-in foreach($row as $no_entry => $entry) { 338a34ef333SKlap-in if($no_entry !== 0) { 339a34ef333SKlap-in $line .= ','; 340a34ef333SKlap-in } 341a34ef333SKlap-in 342a34ef333SKlap-in if(is_null($entry)) { 343a34ef333SKlap-in $line .= 'NULL'; 344a34ef333SKlap-in } elseif(!is_numeric($entry)) { 345a34ef333SKlap-in $line .= $adapterDumpDb->quote_string($entry); 346a34ef333SKlap-in } else { 347a34ef333SKlap-in //TODO depending on locale extra leading zeros are truncated e.g 1.300 (thousand three hunderd)-> 1.3 348a34ef333SKlap-in $line .= $entry; 349a34ef333SKlap-in } 350a34ef333SKlap-in } 351a34ef333SKlap-in $line .= ');'."\n"; 352a34ef333SKlap-in 353a34ef333SKlap-in fwrite($fp, $line); 354a34ef333SKlap-in } 355a34ef333SKlap-in } 356a34ef333SKlap-in 357a34ef333SKlap-in $res = $adapterDumpDb->query(array("SELECT name,sql FROM sqlite_master WHERE type='index'")); 358a34ef333SKlap-in $indexes = $adapterDumpDb->res2arr($res); 359a34ef333SKlap-in foreach($indexes as $index) { 360a34ef333SKlap-in fwrite($fp, $index['sql'].";\n"); 361a34ef333SKlap-in } 362a34ef333SKlap-in 363a34ef333SKlap-in fwrite($fp, 'COMMIT;'."\n"); 364a34ef333SKlap-in 365a34ef333SKlap-in fclose($fp); 366a34ef333SKlap-in return $filename; 367a34ef333SKlap-in } else { 368a34ef333SKlap-in msg('Dumping "'.hsc($dbname).'" has failed. Could not open '.$filename); 369a34ef333SKlap-in return false; 370a34ef333SKlap-in } 371a34ef333SKlap-in } 372a34ef333SKlap-in 373a34ef333SKlap-in /** 374a34ef333SKlap-in * Read $dumpfile and try to add it to database. 375a34ef333SKlap-in * A existing database is backuped first as e.g. dbname.copy2.sqlite3 376a34ef333SKlap-in * 377a34ef333SKlap-in * @param string $dbname 378a34ef333SKlap-in * @param string $dumpfile 379a34ef333SKlap-in * @return bool true on succes 380a34ef333SKlap-in */ 381a34ef333SKlap-in public function fillDatabaseFromDump($dbname, $dumpfile) { 382a34ef333SKlap-in global $conf; 383a34ef333SKlap-in //backup existing stuff 384a34ef333SKlap-in $dbf = $conf['metadir'].'/'.$dbname; 385a34ef333SKlap-in $dbext = $this->adapter->getFileextension(); 386a34ef333SKlap-in $dbfile = $dbf.$dbext; 387a34ef333SKlap-in if(@file_exists($dbfile)) { 388a34ef333SKlap-in 389a34ef333SKlap-in $i = 0; 390a34ef333SKlap-in $backupdbfile = $dbfile; 391a34ef333SKlap-in do { 392a34ef333SKlap-in $i++; 393a34ef333SKlap-in $backupdbfile = $dbf.".copy$i".$dbext; 394a34ef333SKlap-in } while(@file_exists($backupdbfile)); 395a34ef333SKlap-in 396a34ef333SKlap-in io_rename($dbfile, $backupdbfile); 397a34ef333SKlap-in } 398a34ef333SKlap-in 399a34ef333SKlap-in $init = false; 400a34ef333SKlap-in if(!$this->adapter->initdb($dbname, $init, $sqliteupgrade = true)) { 401a34ef333SKlap-in msg('Initialize db fails'); 402a34ef333SKlap-in return false; 403a34ef333SKlap-in } 404a34ef333SKlap-in 405a34ef333SKlap-in $sql = io_readFile($dumpfile, false); 406a34ef333SKlap-in $sql = $this->SQLstring2array($sql); 407a34ef333SKlap-in 408a34ef333SKlap-in //skip preparing, because it interprets question marks as placeholders. 409a34ef333SKlap-in return $this->doTransaction($sql, $sqlpreparing = false); 410a34ef333SKlap-in } 411f10ea6c1SKlap-in 412a1e6784eSAndreas Gohr /** 4133ae3f79eSKlap-in * Registers a User Defined Function for use in SQL statements 4143ae3f79eSKlap-in */ 415aa81d781SKlap-in public function create_function($function_name, $callback, $num_args) { 416aa81d781SKlap-in $this->adapter->create_function($function_name, $callback, $num_args); 4173ae3f79eSKlap-in } 4183ae3f79eSKlap-in 4193ae3f79eSKlap-in /** 420a1e6784eSAndreas Gohr * Execute a query with the given parameters. 421a1e6784eSAndreas Gohr * 422a1e6784eSAndreas Gohr * Takes care of escaping 423a1e6784eSAndreas Gohr * 424*3e9ac593SGerrit Uitslag * @internal param string $args - the arguments of query(), the first is the sql and others are values 425aa81d781SKlap-in * @return bool|\SQLiteResult 426a1e6784eSAndreas Gohr */ 427aa81d781SKlap-in public function query() { 428a1e6784eSAndreas Gohr // get function arguments 429a1e6784eSAndreas Gohr $args = func_get_args(); 430a1e6784eSAndreas Gohr 431aa81d781SKlap-in return $this->adapter->query($args); 43287fa2c18Sstretchyboy } 433a1e6784eSAndreas Gohr 434a1e6784eSAndreas Gohr /** 435a1e6784eSAndreas Gohr * Join the given values and quote them for SQL insertion 436a1e6784eSAndreas Gohr */ 437aa81d781SKlap-in public function quote_and_join($vals, $sep = ',') { 438aa81d781SKlap-in return $this->adapter->quote_and_join($vals, $sep); 439a1e6784eSAndreas Gohr } 440a1e6784eSAndreas Gohr 441a1e6784eSAndreas Gohr /** 442a1e6784eSAndreas Gohr * Run sqlite_escape_string() on the given string and surround it 443a1e6784eSAndreas Gohr * with quotes 444a1e6784eSAndreas Gohr */ 445aa81d781SKlap-in public function quote_string($string) { 446aa81d781SKlap-in return $this->adapter->quote_string($string); 447a1e6784eSAndreas Gohr } 448a1e6784eSAndreas Gohr 449b5b947d7SAndreas Gohr /** 450fee3b689Sstretchyboy * Escape string for sql 451fee3b689Sstretchyboy */ 452aa81d781SKlap-in public function escape_string($str) { 453aa81d781SKlap-in return $this->adapter->escape_string($str); 454ff97cc8fSstretchyboy } 455ff97cc8fSstretchyboy 456ff97cc8fSstretchyboy /** 457b122d121SAndreas Gohr * Closes the result set (and it's cursors) 458b122d121SAndreas Gohr * 459b122d121SAndreas Gohr * If you're doing SELECT queries inside a TRANSACTION, be sure to call this 460b122d121SAndreas Gohr * function on all your results sets, before COMMITing the transaction. 461b122d121SAndreas Gohr * 462b122d121SAndreas Gohr * @param $res 463b122d121SAndreas Gohr * @return bool 464b122d121SAndreas Gohr */ 465b122d121SAndreas Gohr public function res_close($res){ 466b122d121SAndreas Gohr return $this->adapter->res_close($res); 467b122d121SAndreas Gohr } 468b122d121SAndreas Gohr 469b122d121SAndreas Gohr /** 470aa81d781SKlap-in * Returns a complete result set as array 471ff97cc8fSstretchyboy */ 472ef383ac5SKlap-in public function res2arr($res, $assoc = true) { 473ef383ac5SKlap-in return $this->adapter->res2arr($res, $assoc); 474b5b947d7SAndreas Gohr } 475b5b947d7SAndreas Gohr 476b5b947d7SAndreas Gohr /** 477aa81d781SKlap-in * Return the wanted row from a given result set as 478aa81d781SKlap-in * associative array 479b5b947d7SAndreas Gohr */ 480aa81d781SKlap-in public function res2row($res, $rownum = 0) { 481aa81d781SKlap-in return $this->adapter->res2row($res, $rownum); 482b5b947d7SAndreas Gohr } 483b5b947d7SAndreas Gohr 484e7112ccbSAdrian Lang /** 48544685fc6SKlap-in * Return the first value from the next row. 486e7112ccbSAdrian Lang */ 487aa81d781SKlap-in public function res2single($res) { 488aa81d781SKlap-in return $this->adapter->res2single($res); 489e7112ccbSAdrian Lang } 490fee3b689Sstretchyboy 491fee3b689Sstretchyboy /** 492fee3b689Sstretchyboy * fetch the next row as zero indexed array 493fee3b689Sstretchyboy */ 494aa81d781SKlap-in public function res_fetch_array($res) { 495aa81d781SKlap-in return $this->adapter->res_fetch_array($res); 49687fa2c18Sstretchyboy } 497fee3b689Sstretchyboy 498fee3b689Sstretchyboy /** 499fee3b689Sstretchyboy * fetch the next row as assocative array 500fee3b689Sstretchyboy */ 501aa81d781SKlap-in public function res_fetch_assoc($res) { 502aa81d781SKlap-in return $this->adapter->res_fetch_assoc($res); 503fee3b689Sstretchyboy } 504fee3b689Sstretchyboy 505fee3b689Sstretchyboy /** 50678977d74SKlap-in * Count the number of records in result 5073157674bSAndreas Gohr * 508db58e525SKlap-in * This function is really inperformant in PDO and should be avoided! 509fee3b689Sstretchyboy */ 510aa81d781SKlap-in public function res2count($res) { 511aa81d781SKlap-in return $this->adapter->res2count($res); 512fee3b689Sstretchyboy } 51324a03f6cSstretchyboy 51424a03f6cSstretchyboy /** 51524a03f6cSstretchyboy * Count the number of records changed last time 51624a03f6cSstretchyboy */ 51744685fc6SKlap-in public function countChanges($res) { 51844685fc6SKlap-in return $this->adapter->countChanges($res); 519a1e6784eSAndreas Gohr } 520a1e6784eSAndreas Gohr 521aa81d781SKlap-in} 522