Source for file sql.php
Documentation is available at sql.php
/** @constant integer VFS_FILE File value for vfs_type column. */
/** @constant integer VFS_FOLDER Folder value for vfs_type column. */
* VFS implementation for PHP's PEAR database abstraction layer.
* Required values for $params:
* 'phptype' The database type (ie. 'pgsql', 'mysql, etc.).
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* 'username' The username with which to connect to the database.
* 'password' The password associated with 'username'.
* 'database' The name of the database.
* 'table' The name of the vfs table in 'database'. Defaults to
* Required by some database implementations:
* 'options' Additional options to pass to the database.
* 'tty' The TTY on which to connect to the database.
* 'port' The port on which to connect to the database.
* The table structure for the VFS can be found in
* Database specific notes:
* - The vfs_data field must be of type IMAGE.
* - You need the following php.ini settings:
* ; Valid range 0 - 2147483647. Default = 4096.
* mssql.textlimit = 0 ; zero to pass through
* ; Valid range 0 - 2147483647. Default = 4096.
* mssql.textsize = 0 ; zero to pass through
* $Horde: framework/VFS/VFS/sql.php,v 1.92 2005/04/07 13:24:23 jan Exp $
* Copyright 2002-2005 Chuck Hagenbuch <chuck@horde.org>
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
* @author Chuck Hagenbuch <chuck@horde.org>
* Handle for the current database connection.
* Retrieve a file from the VFS.
* @param string $path The pathname to the file.
* @param string $name The filename to retrieve.
* @return string The file data.
function read($path, $name)
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
return $this->_readBlob ($this->_params['table'], 'vfs_data',
array ('vfs_path' => $path,
* Stores a file in the VFS.
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @param string $tmpFile The temporary file containing the data to
* @param boolean $autocreate Automatically create directories?
* @return mixed True on success or a PEAR_Error object on failure.
function write($path, $name, $tmpFile, $autocreate = false )
$dataFP = @fopen($tmpFile, 'rb');
return PEAR ::raiseError (sprintf(_("The temporary file \"%s\" does not exist."), $tmpFile));
$data = @fread($dataFP, $size);
return $this->writeData($path, $name, $data, $autocreate);
* Store a file in the VFS from raw data.
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @param string $data The file data.
* @param optional boolean $autocreate Automatically create directories?
* @return mixed True on success or a PEAR_Error object on failure.
function writeData($path, $name, $data, $autocreate = false )
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
/* Check to see if the data already exists. */
$sql = sprintf('SELECT vfs_id FROM %s WHERE vfs_path %s AND vfs_name = %s',
(empty ($path) && $this->_db->dbsyntax == 'oci8') ? ' IS NULL' : ' = ' . $this->_db->quote ($path),
$this->_db->quote ($name));
$this->log($sql, PEAR_LOG_DEBUG );
$id = $this->_db->getOne ($sql);
if (is_a($id, 'PEAR_Error')) {
$this->log($id, PEAR_LOG_ERR );
return $this->_updateBlob ($this->_params['table'], 'vfs_data',
$data, array ('vfs_id' => $id),
array ('vfs_modified' => time()));
/* Check to see if the folder already exists. */
if (!$this->isFolder($parent, $path_name)) {
return PEAR ::raiseError (sprintf(_("Folder %s does not exist"), $path), 'horde.error');
if (is_a($result, 'PEAR_Error')) {
$id = $this->_db->nextId ($this->_params['table']);
if (is_a($id, 'PEAR_Error')) {
$this->log($id, PEAR_LOG_ERR );
return $this->_insertBlob ($this->_params['table'], 'vfs_data',
$data, array ('vfs_id' => $id,
'vfs_modified' => time(),
'vfs_owner' => $this->_params['user']));
* Delete a file from the VFS.
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @return mixed True on success or a PEAR_Error object on failure.
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
$sql = sprintf('DELETE FROM %s WHERE vfs_type = %s AND vfs_path %s AND vfs_name = %s',
(empty ($path) && $this->_db->dbsyntax == 'oci8') ? ' IS NULL' : ' = ' . $this->_db->quote ($path),
$this->_db->quote ($name));
$this->log($sql, PEAR_LOG_DEBUG );
$result = $this->_db->query ($sql);
if ($this->_db->affectedRows () == 0 ) {
return PEAR ::raiseError (_("Unable to delete VFS file."));
* Rename a file or folder in the VFS.
* @param string $oldpath The old path to the file.
* @param string $oldname The old filename.
* @param string $newpath The new path of the file.
* @param string $newname The new filename.
* @return mixed True on success or a PEAR_Error object on failure.
function rename($oldpath, $oldname, $newpath, $newname)
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
$sql = 'UPDATE ' . $this->_params['table'];
$sql .= ' SET vfs_path = ?, vfs_name = ?, vfs_modified = ? WHERE vfs_path = ? AND vfs_name = ?';
$this->log($sql, PEAR_LOG_DEBUG );
$sth = $this->_db->prepare ($sql);
$result = $this->_db->execute ($sth, $values);
if ($this->_db->affectedRows () == 0 ) {
return PEAR ::raiseError (_("Unable to rename VFS file."));
$rename = $this->_recursiveRename ($oldpath, $oldname, $newpath, $newname);
if (is_a($rename, 'PEAR_Error')) {
$this->log($rename, PEAR_LOG_ERR );
return PEAR ::raiseError (sprintf(_("Unable to rename VFS directory: %s."), $rename->getMessage ()));
* Creates a folder on the VFS.
* @param string $path Holds the path of directory to create folder.
* @param string $name Holds the name of the new folder.
* @return mixed True on success or a PEAR_Error object on failure.
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
$id = $this->_db->nextId ($this->_params['table']);
if (is_a($id, 'PEAR_Error')) {
$this->log($id, PEAR_LOG_ERR );
$sql = 'INSERT INTO ' . $this->_params['table'];
$sql .= ' (vfs_id, vfs_type, vfs_path, vfs_name, vfs_modified, vfs_owner) VALUES (?, ?, ?, ?, ?, ?)';
$this->log($sql, PEAR_LOG_DEBUG );
$sth = $this->_db->prepare ($sql);
return $this->_db->execute ($sth, $values);
* Delete a folder from the VFS.
* @param string $path The path of the folder.
* @param string $name The folder name to use.
* @param optional boolean $recursive Force a recursive delete?
* @return mixed True on success or a PEAR_Error object on failure.
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
$folderPath = $this->_getNativePath ($path, $name);
/* Check if not recursive and fail if directory not empty */
$folderList = $this->listFolder($folderPath, null , true );
if (is_a($folderList, 'PEAR_Error')) {
$this->log($folderList, PEAR_LOG_ERR );
} elseif (!empty ($folderList)) {
return PEAR ::raiseError (sprintf(_("Unable to delete %s, the directory is not empty"),
/* First delete everything below the folder, so if error we
$sql = sprintf('DELETE FROM %s WHERE vfs_path %s',
(empty ($folderPath) && $this->_db->dbsyntax == 'oci8') ? ' IS NULL' : ' LIKE ' . $this->_db->quote ($this->_getNativePath ($folderPath, '%')));
$this->log($sql, PEAR_LOG_DEBUG );
$deleteContents = $this->_db->query ($sql);
if (is_a($deleteContents, 'PEAR_Error')) {
$this->log($deleteContents, PEAR_LOG_ERR );
return PEAR ::raiseError (sprintf(_("Unable to delete VFS recursively: %s."), $deleteContents->getMessage ()));
/* Now delete everything inside the folder. */
$sql = sprintf('DELETE FROM %s WHERE vfs_path %s',
(empty ($path) && $this->_db->dbsyntax == 'oci8') ? ' IS NULL' : ' = ' . $this->_db->quote ($folderPath));
$this->log($sql, PEAR_LOG_DEBUG );
$delete = $this->_db->query ($sql);
if (is_a($delete, 'PEAR_Error')) {
$this->log($delete, PEAR_LOG_ERR );
return PEAR ::raiseError (sprintf(_("Unable to delete VFS directory: %s."), $delete->getMessage ()));
/* All ok now delete the actual folder */
$sql = sprintf('DELETE FROM %s WHERE vfs_path %s AND vfs_name = %s',
(empty ($path) && $this->_db->dbsyntax == 'oci8') ? ' IS NULL' : ' = ' . $this->_db->quote ($path),
$this->_db->quote ($name));
$this->log($sql, PEAR_LOG_DEBUG );
$delete = $this->_db->query ($sql);
if (is_a($delete, 'PEAR_Error')) {
$this->log($delete, PEAR_LOG_ERR );
return PEAR ::raiseError (sprintf(_("Unable to delete VFS directory: %s."), $delete->getMessage ()));
* Return a list of the contents of a folder.
* @param string $path The directory path.
* @param optional mixed $filter String/hash of items to filter based
* @param optional boolean $dotfiles Show dotfiles?
* @param optional boolean $dironly Show directories only?
* @return mixed File list on success or false on failure.
function _listFolder($path, $filter = null , $dotfiles = true ,
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
// Fix for Oracle not differentiating between '' and NULL.
if (empty ($path) && $this->_db->dbsyntax == 'oci8') {
$where = 'vfs_path IS NULL';
$where = 'vfs_path = ' . $this->_db->quote ($path);
$sql = sprintf('SELECT vfs_name, vfs_type, vfs_data, vfs_modified, vfs_owner FROM %s WHERE %s',
$this->log($sql, PEAR_LOG_DEBUG );
$fileList = $this->_db->getAll ($sql);
if (is_a($fileList, 'PEAR_Error')) {
foreach ($fileList as $line) {
// Filter out dotfiles if they aren't wanted.
if (!$dotfiles && substr($line[0 ], 0 , 1 ) == '.') {
$file['name'] = $line[0 ];
$file['type'] = '**none';
$file['date'] = $line[3 ];
$file['owner'] = $line[4 ];
if ($this->_filterMatch ($filter, $file['name'])) {
if ($dironly && $file['type'] !== '**dir') {
$files[$file['name']] = $file;
* Returns a sorted list of folders in specified directory.
* @param optional string $path The path of the directory to get
* the directory list for.
* @param optional mixed $filter String/hash of items to filter
* @param optional boolean $dotfolders Include dotfolders?
* @return mixed Folder list on success or PEAR_Error object on failure.
function listFolders($path = '', $filter = array (), $dotfolders = true )
$conn = $this->_connect ();
if (is_a($conn, 'PEAR_Error')) {
$sql = 'SELECT vfs_name, vfs_path FROM ' . $this->_params['table'];
$sql .= ' WHERE vfs_path = ? AND vfs_type = ?';
$this->log($sql, PEAR_LOG_DEBUG );
$folderList = $this->_db->getAll ($sql, $values);
if (is_a($folderList, 'PEAR_Error')) {
foreach ($folderList as $line) {
$folder['val'] = $this->_getNativePath ($line[1 ], $line[0 ]);
$folder['abbrev'] .= ' ';
$folder['abbrev'] .= $line[0 ];
$folder['label'] .= $line[0 ];
$folder['abbrev'] = substr($folder['label'], 0 , ($count * 4 ));
$length = (29 - ($count * 4 )) / 2;
$folder['abbrev'] .= substr($folder['label'], ($count * 4 ), $length);
$folder['abbrev'] .= '...';
$folder['abbrev'] .= substr($folder['label'], -1 * $length, $length);
foreach ($filter as $fltr) {
if ($folder['val'] == $fltr) {
$folders[$folder['val']] = $folder;
* Renames all child paths.
* @param string $path The path of the folder to rename.
* @param string $name The foldername to use.
* @return mixed True on success or a PEAR_Error object on failure.
function _recursiveRename ($oldpath, $oldname, $newpath, $newname)
$sql = 'SELECT vfs_name FROM ' . $this->_params['table'];
$sql .= ' WHERE vfs_type = ? AND vfs_path = ?';
$this->log($sql, PEAR_LOG_DEBUG );
$folderList = $this->_db->getCol ($sql, 0 , $values);
foreach ($folderList as $folder) {
$this->_recursiveRename ($this->_getNativePath ($oldpath, $oldname), $folder, $this->_getNativePath ($newpath, $newname), $folder);
$sql = 'UPDATE ' . $this->_params['table'] . ' SET vfs_path = ? WHERE vfs_path = ?';
$this->log($sql, PEAR_LOG_DEBUG );
array_push($values, $this->_getNativePath ($newpath, $newname), $this->_getNativePath ($oldpath, $oldname));
$sth = $this->_db->prepare ($sql);
$result = $this->_db->execute ($sth, $values);
* Return a full filename on the native filesystem, from a VFS
* @param string $path The VFS file path.
* @param string $name The VFS filename.
* @return string The full native filename.
function _getNativePath ($path, $name)
if (isset ($this->_params['home']) &&
$path = $this->_params['home'] . '/' . $matches[1 ];
return $path . '/' . $name;
* Attempts to open a persistent connection to the SQL server.
* @return mixed True on success or a PEAR_Error object on failure.
if ($this->_db === false ) {
return PEAR ::raiseError (_("No configuration information specified for SQL VFS."));
$required = array ('phptype', 'hostspec', 'username', 'password', 'database');
foreach ($required as $val) {
if (!isset ($this->_params[$val])) {
return PEAR ::raiseError (sprintf(_("Required '%s' not specified in VFS configuration."), $val));
if (!isset ($this->_params['table'])) {
$this->_params['table'] = 'horde_vfs';
/* Connect to the SQL server using the supplied parameters. */
$this->_db = &DB ::connect ($this->_params,
array ('persistent' => !empty ($this->_params['persistent'])));
if (is_a($this->_db, 'PEAR_Error')) {
$this->log($this->_db, PEAR_LOG_ERR );
$this->_db->setOption ('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS );
* Disconnect from the SQL server and clean up the connection.
$this->_db->disconnect ();
* @param string $table TODO
* @param string $field TODO
* @param string $criteria TODO
function _readBlob ($table, $field, $criteria)
return PEAR ::raiseError ('You must specify the fetch criteria');
switch ($this->_db->dbsyntax ) {
foreach ($criteria as $key => $value) {
$where .= $key . ' IS NULL';
$where .= $key . ' = ' . $this->_db->quote ($value);
$statement = OCIParse ($this->_db->connection ,
sprintf('SELECT %s FROM %s WHERE %s',
$field, $table, $where));
if (OCIFetchInto ($statement, $lob)) {
$result = $lob[0 ]->load ();
$result = PEAR ::raiseError ('Unable to load SQL data.');
$result = PEAR ::raiseError ('Unable to load SQL data.');
OCIFreeStatement ($statement);
foreach ($criteria as $key => $value) {
$where .= $key . ' = ' . $this->_db->quote ($value);
$sql = sprintf('SELECT %s FROM %s WHERE %s',
$this->log($sql, PEAR_LOG_DEBUG );
$result = $this->_db->getOne ($sql);
$result = PEAR ::raiseError ('Unable to load SQL data.');
switch ($this->_db->dbsyntax ) {
* @param string $table TODO
* @param string $field TODO
* @param string $data TODO
* @param string $attributes TODO
function _insertBlob ($table, $field, $data, $attributes)
switch ($this->_db->dbsyntax ) {
foreach ($attributes as $key => $value) {
$values[] = $this->_db->quoteSmart ($value);
$statement = OCIParse ($this->_db->connection ,
sprintf('INSERT INTO %s (%s, %s)' .
' VALUES (%s, EMPTY_BLOB()) RETURNING %s INTO :blob',
$lob = OCINewDescriptor ($this->_db->connection );
OCIBindByName ($statement, ':blob', $lob, -1 , SQLT_BLOB );
OCIExecute ($statement, OCI_DEFAULT );
$result = OCICommit ($this->_db->connection );
OCIFreeStatement ($statement);
return $result ? true : PEAR ::raiseError ('Unknown Error');
foreach ($attributes as $key => $value) {
$query = sprintf('INSERT INTO %s (%s, %s) VALUES (%s)',
switch ($this->_db->dbsyntax ) {
$this->log($query, PEAR_LOG_DEBUG );
$stmt = $this->_db->prepare ($query);
return $this->_db->execute ($stmt, $values);
* @param string $table TODO
* @param string $field TODO
* @param string $data TODO
* @param string $where TODO
* @param array $alsoupdate TODO
function _updateBlob ($table, $field, $data, $where, $alsoupdate)
switch ($this->_db->dbsyntax ) {
foreach ($where as $key => $value) {
if (!empty ($wherestring)) {
$wherestring .= $key . ' = ' . $this->_db->quote ($value);
$statement = OCIParse ($this->_db->connection ,
sprintf('SELECT %s FROM %s WHERE %s FOR UPDATE',
OCIExecute ($statement, OCI_DEFAULT );
OCIFetchInto ($statement, $lob);
$result = OCICommit ($this->_db->connection );
OCIFreeStatement ($statement);
return $result ? true : PEAR ::raiseError ('Unknown Error');
foreach ($alsoupdate as $key => $value) {
$updatestring .= $key . ' = ?, ';
$updatestring .= $field . ' = ?';
switch ($this->_db->dbsyntax ) {
foreach ($where as $key => $value) {
if (!empty ($wherestring)) {
$wherestring .= $key . ' = ?';
$query = sprintf('UPDATE %s SET %s WHERE %s',
$this->log($query, PEAR_LOG_DEBUG );
$stmt = $this->_db->prepare ($query);
return $this->_db->execute ($stmt, $values);
Documentation generated on Mon, 11 Mar 2019 14:31:26 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|