File Source for Stream.php

<?php
/**
* Copyright (c) 2009, RealDolmen
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of RealDolmen nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category Microsoft
* @package Microsoft_WindowsAzure_Storage
* @subpackage Blob
* @copyright Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
* @license http://todo name_todo
* @version $Id: Blob.php 24511 2009-07-28 09:17:56Z unknown $
*/
/**
* @see Microsoft_WindowsAzure_Storage_Blob
*/
require_once 'Microsoft/WindowsAzure/Storage/Blob.php';
/**
* @see Microsoft_WindowsAzure_Exception
*/
require_once 'Microsoft/WindowsAzure/Exception.php';
/**
* @category Microsoft
* @package Microsoft_WindowsAzure_Storage
* @subpackage Blob
* @copyright Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
* @license http://phpazure.codeplex.com/license
*/
class Microsoft_WindowsAzure_Storage_Blob_Stream
{
/**
* Current file name
*
* @var string
*/
private $_fileName = null;
/**
* Temporary file name
*
* @var string
*/
private $_temporaryFileName = null;
/**
* Temporary file handle
*
* @var resource
*/
private $_temporaryFileHandle = null;
/**
* Blob storage client
*
* @var Microsoft_WindowsAzure_Storage_Blob
*/
private $_storageClient = null;
/**
* Write mode?
*
* @var boolean
*/
private $_writeMode = false;
/**
* List of blobs
*
* @var array
*/
private $_blobs = null;
/**
* Retrieve storage client for this stream type
*
* @param string $path
* @return Microsoft_WindowsAzure_Storage_Blob
*/
protected function getStorageClient($path = '')
{
if (is_null($this->_storageClient))
{
$url = explode(':', $path);
if (!$url)
{
throw new Microsoft_WindowsAzure_Exception('Could not parse path "' . $path . '".');
}
$this->_storageClient = Microsoft_WindowsAzure_Storage_Blob::getWrapperClient($url[0]);
if (!$this->_storageClient)
{
throw new Microsoft_WindowsAzure_Exception('No storage client registered for stream type "' . $url[0] . '://".');
}
}
return $this->_storageClient;
}
/**
* Extract container name
*
* @param string $path
* @return string
*/
protected function getContainerName($path)
{
$url = parse_url($path);
if ($url['host']) {
return $url['host'];
}
return '';
}
/**
* Extract file name
*
* @param string $path
* @return string
*/
protected function getFileName($path)
{
$url = parse_url($path);
if ($url['host']) {
$fileName = isset($url['path']) ? $url['path'] : $url['host'];
if (strpos($fileName, '/') === 0)
$fileName = substr($fileName, 1);
return $fileName;
}
return '';
}
/**
* Open the stream
*
* @param string $path
* @param string $mode
* @param integer $options
* @param string $opened_path
* @return boolean
*/
public function stream_open($path, $mode, $options, $opened_path)
{
$this->_fileName = $path;
$this->_temporaryFileName = tempnam(sys_get_temp_dir(), 'azure');
// Check the file can be opened
$fh = @fopen($this->_temporaryFileName, $mode);
if ($fh === false)
return false;
fclose($fh);
// Write mode?
if (strpbrk($mode, 'wax+'))
$this->_writeMode = true;
else
$this->_writeMode = false;
// If read/append, fetch the file
if (!$this->_writeMode || strpbrk($mode, 'ra+'))
{
$this->getStorageClient($this->_fileName)->getBlob(
$this->getContainerName($this->_fileName),
$this->getFileName($this->_fileName),
$this->_temporaryFileName
);
}
// Open temporary file handle
$this->_temporaryFileHandle = fopen($this->_temporaryFileName, $mode);
// Ok!
return true;
}
/**
* Close the stream
*
* @return void
*/
public function stream_close()
{
@fclose($this->_temporaryFileHandle);
// Upload the file?
if ($this->_writeMode)
{
// Make sure the container exists
$containerExists = $this->getStorageClient($this->_fileName)->containerExists(
$this->getContainerName($this->_fileName)
);
if (!$containerExists)
{
$this->getStorageClient($this->_fileName)->createContainer(
$this->getContainerName($this->_fileName)
);
}
// Upload the file
try
{
$this->getStorageClient($this->_fileName)->putBlob(
$this->getContainerName($this->_fileName),
$this->getFileName($this->_fileName),
$this->_temporaryFileName
);
}
catch (Microsoft_WindowsAzure_Exception $ex)
{
@unlink($this->_temporaryFileName);
unset($this->_storageClient);
throw $ex;
}
}
@unlink($this->_temporaryFileName);
unset($this->_storageClient);
}
/**
* Read from the stream
*
* @param integer $count
* @return string
*/
public function stream_read($count)
{
if (!$this->_temporaryFileHandle)
{
return false;
}
return fread($this->_temporaryFileHandle, $count);
}
/**
* Write to the stream
*
* @param string $data
* @return integer
*/
public function stream_write($data)
{
if (!$this->_temporaryFileHandle)
{
return 0;
}
$len = strlen($data);
fwrite($this->_temporaryFileHandle, $data, $len);
return $len;
}
/**
* End of the stream?
*
* @return boolean
*/
public function stream_eof()
{
if (!$this->_temporaryFileHandle)
{
return true;
}
return feof($this->_temporaryFileHandle);
}
/**
* What is the current read/write position of the stream?
*
* @return integer
*/
public function stream_tell()
{
return ftell($this->_temporaryFileHandle);
}
/**
* Update the read/write position of the stream
*
* @param integer $offset
* @param integer $whence
* @return boolean
*/
public function stream_seek($offset, $whence)
{
if (!$this->_temporaryFileHandle)
{
return false;
}
return (fseek($this->_temporaryFileHandle, $offset, $whence) === 0);
}
/**
* Flush current cached stream data to storage
*
* @return boolean
*/
public function stream_flush()
{
$result = fflush($this->_temporaryFileHandle);
// Upload the file?
if ($this->_writeMode)
{
// Make sure the container exists
$containerExists = $this->getStorageClient($this->_fileName)->containerExists(
$this->getContainerName($this->_fileName)
);
if (!$containerExists)
{
$this->getStorageClient($this->_fileName)->createContainer(
$this->getContainerName($this->_fileName)
);
}
// Upload the file
try
{
$this->getStorageClient($this->_fileName)->putBlob(
$this->getContainerName($this->_fileName),
$this->getFileName($this->_fileName),
$this->_temporaryFileName
);
}
catch (Microsoft_WindowsAzure_Exception $ex)
{
@unlink($this->_temporaryFileName);
unset($this->_storageClient);
throw $ex;
}
}
return $result;
}
/**
* Returns data array of stream variables
*
* @return array
*/
public function stream_stat()
{
if (!$this->_temporaryFileHandle)
{
return false;
}
$stat = array();
$stat['dev'] = 0;
$stat['ino'] = 0;
$stat['mode'] = 0;
$stat['nlink'] = 0;
$stat['uid'] = 0;
$stat['gid'] = 0;
$stat['rdev'] = 0;
$stat['size'] = 0;
$stat['atime'] = 0;
$stat['mtime'] = 0;
$stat['ctime'] = 0;
$stat['blksize'] = 0;
$stat['blocks'] = 0;
$info = null;
try {
$info = $this->getStorageClient($this->_fileName)->getBlobInstance(
$this->getContainerName($this->_fileName),
$this->getFileName($this->_fileName)
);
}
catch (Microsoft_WindowsAzure_Exception $ex)
{
// Unexisting file...
}
if (!is_null($info))
{
$stat['size'] = $info->Size;
$stat['atime'] = time();
}
return $stat;
}
/**
* Attempt to delete the item
*
* @param string $path
* @return boolean
*/
public function unlink($path)
{
$this->getStorageClient($path)->deleteBlob(
$this->getContainerName($path),
$this->getFileName($path)
);
}
/**
* Attempt to rename the item
*
* @param string $path_from
* @param string $path_to
* @return boolean False
*/
public function rename($path_from, $path_to)
{
if ($this->getContainerName($path_from) != $this->getContainerName($path_to))
throw new Microsoft_WindowsAzure_Exception('Container name can not be changed.');
if ($this->getFileName($path_from) == $this->getContainerName($path_to))
return true;
$this->getStorageClient($path_from)->copyBlob(
$this->getContainerName($path_from),
$this->getFileName($path_from),
$this->getContainerName($path_to),
$this->getFileName($path_to)
);
$this->getStorageClient($path_from)->deleteBlob(
$this->getContainerName($path_from),
$this->getFileName($path_from)
);
return true;
}
/**
* Return array of URL variables
*
* @param string $path
* @param integer $flags
* @return array
*/
public function url_stat($path, $flags)
{
$stat = array();
$stat['dev'] = 0;
$stat['ino'] = 0;
$stat['mode'] = 0;
$stat['nlink'] = 0;
$stat['uid'] = 0;
$stat['gid'] = 0;
$stat['rdev'] = 0;
$stat['size'] = 0;
$stat['atime'] = 0;
$stat['mtime'] = 0;
$stat['ctime'] = 0;
$stat['blksize'] = 0;
$stat['blocks'] = 0;
$info = null;
try {
$info = $this->getStorageClient($path)->getBlobInstance(
$this->getContainerName($path),
$this->getFileName($path)
);
}
catch (Microsoft_WindowsAzure_Exception $ex)
{
// Unexisting file...
}
if (!is_null($info))
{
$stat['size'] = $info->Size;
$stat['atime'] = time();
}
return $stat;
}
/**
* Create a new directory
*
* @param string $path
* @param integer $mode
* @param integer $options
* @return boolean
*/
public function mkdir($path, $mode, $options)
{
if ($this->getContainerName($path) == $this->getFileName($path))
{
// Create container
try
{
$this->getStorageClient($path)->createContainer(
$this->getContainerName($path)
);
}
catch (Microsoft_WindowsAzure_Exception $ex)
{
return false;
}
}
else
{
throw new Microsoft_WindowsAzure_Exception('mkdir() with multiple levels is not supported on Windows Azure Blob Storage.');
}
}
/**
* Remove a directory
*
* @param string $path
* @param integer $options
* @return boolean
*/
public function rmdir($path, $options)
{
if ($this->getContainerName($path) == $this->getFileName($path))
{
// Delete container
try
{
$this->getStorageClient($path)->deleteContainer(
$this->getContainerName($path)
);
}
catch (Microsoft_WindowsAzure_Exception $ex)
{
return false;
}
}
else
{
throw new Microsoft_WindowsAzure_Exception('rmdir() with multiple levels is not supported on Windows Azure Blob Storage.');
}
}
/**
* Attempt to open a directory
*
* @param string $path
* @param integer $options
* @return boolean
*/
public function dir_opendir($path, $options)
{
$this->_blobs = $this->getStorageClient($path)->listBlobs(
$this->getContainerName($path)
);
return is_array($this->_blobs);
}
/**
* Return the next filename in the directory
*
* @return string
*/
public function dir_readdir()
{
$object = current($this->_blobs);
if ($object !== false) {
next($this->_blobs);
return $object->Name;
}
return false;
}
/**
* Reset the directory pointer
*
* @return boolean True
*/
public function dir_rewinddir()
{
reset($this->_blobs);
return true;
}
/**
* Close a directory
*
* @return boolean True
*/
public function dir_closedir()
{
$this->_blobs = null;
return true;
}
}

Source for file Stream.php