/home/edulekha/studygroup.edulekha.com/ow_system_plugins/base/classes/amazon_cloud_storage.php
<?php
/**
* EXHIBIT A. Common Public Attribution License Version 1.0
* The contents of this file are subject to the Common Public Attribution License Version 1.0 (the “License”);
* you may not use this file except in compliance with the License. You may obtain a copy of the License at
* http://www.oxwall.org/license. The License is based on the Mozilla Public License Version 1.1
* but Sections 14 and 15 have been added to cover use of software over a computer network and provide for
* limited attribution for the Original Developer. In addition, Exhibit A has been modified to be consistent
* with Exhibit B. Software distributed under the License is distributed on an “AS IS” basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language
* governing rights and limitations under the License. The Original Code is Oxwall software.
* The Initial Developer of the Original Code is Oxwall Foundation (http://www.oxwall.org/foundation).
* All portions of the code written by Oxwall Foundation are Copyright (c) 2011. All Rights Reserved.
* EXHIBIT B. Attribution Information
* Attribution Copyright Notice: Copyright 2011 Oxwall Foundation. All rights reserved.
* Attribution Phrase (not exceeding 10 words): Powered by Oxwall community software
* Attribution URL: http://www.oxwall.org/
* Graphic Image as provided in the Covered Code.
* Display of Attribution Information is required in Larger Works which are defined in the CPAL as a work
* which combines Covered Code or portions thereof with code not governed by the terms of the CPAL.
*/
/**
* Cloud Storage class
*
* @author Podyachev Evgeny <joker.OW2@gmail.com>
* @package ow_system_plugins.base.classes
* @since 1.0
*/
require( OW_DIR_LIB . 'amazonS3' . DS . 'S3.php' );
class BASE_CLASS_AmazonCloudStorage implements OW_Storage
{
const CLOUD_FOLDER_NAME = '.folder';
const CLOUD_FILES_DS = '/';
const MAX_OBJECT_LIST_SIZE = 10000;
//const CONTENT_TYPE_DIRECTORY = 'application/directory';
private $s3;
private $cloudfilesTmpDir;
private $bucketName;
private $bucketUrl;
private $requestHeaders;
/**
* Constructor.
*
*/
public function __construct()
{
$this->cloudfilesTmpDir = OW_DIR_PLUGINFILES . 'base' . DS . 'cloudfiles' . DS;
// Connect to Rackspace Cloud Files
$this->s3 = new S3(OW_AMAZON_S3_ACCESS_KEY, OW_AMAZON_S3_SECRET_KEY);
$this->bucketName = OW_AMAZON_S3_BUCKET_NAME;
$this->bucketUrl = OW_AMAZON_S3_BUCKET_URL;
$this->requestHeaders = array( 'Cache-Control' => 'max-age=' . (60 * 60 * 24 * 365 * 3) );
}
/**
* Copy folder to cloud storage
*
* @param string $sourcePath
* @param string $destPath
* @param array $fileTypes
* @param int $level
*
* @return boolean
*/
public function copyDir( $sourcePath, $destPath, array $fileTypes = null, $level = -1 )
{
$sourcePath = UTIL_File::removeLastDS($sourcePath);
$destPath = UTIL_File::removeLastDS($destPath);
if ( !UTIL_File::checkDir($sourcePath) )
{
return false;
}
if ( !$this->fileExists($destPath) )
{
$this->mkdir($destPath);
}
$handle = opendir($sourcePath);
while ( ($item = readdir($handle)) !== false )
{
if ( $item === '.' || $item === '..' || $item === '' )
{
continue;
}
$path = $sourcePath . DS . $item;
$dPath = $destPath . DS . $item;
if ( is_file($path) )
{
if ( $fileTypes === null || in_array(UTIL_File::getExtension($path), $fileTypes) )
{
$this->copyFile($path, $dPath);
}
}
else if ( $level && is_dir($path) )
{
$this->copyDir($path, $dPath, $fileTypes, ($level - 1));
}
}
closedir($handle);
return true;
}
/**
* Copy file to cloud storage
*
* @param string $sourcePath
* @param string $destPath
*
* @return boolean
*/
public function copyFile( $sourcePath, $destPath, $requestHeaders = array() )
{
$destPath = $this->getCloudFilePath($destPath);
$obj = $this->s3->putObjectFile($sourcePath, $this->bucketName, $destPath, S3::ACL_PUBLIC_READ, array(), array());
if ( $obj === null )
{
return false;
}
$object = $this->s3->getObjectInfo($this->bucketName, $destPath);
$this->triggerFileUploadEvent($destPath, $object['size']);
return true;
}
public function copyFileToLocalFS( $destPath, $sourcePath )
{
$cloudPath = $this->getCloudFilePath($destPath);
$result = $this->s3->getObject($this->bucketName, $cloudPath, $sourcePath);
if( isset($result) && isset($result->code) && $result->code = 200 )
{
return true;
}
return false;
}
public function removeFile( $path )
{
$cloudPath = $this->getCloudFilePath($path);
$object = $this->s3->getObjectInfo($this->bucketName, $cloudPath);
$result = $this->s3->deleteObject($this->bucketName, $cloudPath);
$this->triggerFileDeleteEvent($path, $object['size']);
return $result;
}
private function getFileList( $path, $prefix = null, $marker = null, $limit = self::MAX_OBJECT_LIST_SIZE, $returnCommonPrefixes = true )
{
$path = $this->removeSlash($this->getCloudFilePath($path)) . self::CLOUD_FILES_DS;
$marker = ( $marker === null ) ? null : $this->removeSlash($this->getCloudFilePath($marker)) . self::CLOUD_FILES_DS;
$cloudPrefix = $prefix === null ? $path : $path . $prefix;
$result = $this->s3->getBucket($this->bucketName, $cloudPrefix, $marker, $limit, self::CLOUD_FILES_DS, $returnCommonPrefixes);
return $result ? $result : array();
}
public function getFileNameList( $path, $prefix = null, array $fileTypes = null, $marker = null, $limit = self::MAX_OBJECT_LIST_SIZE )
{
$files = $this->getFileList($path, $prefix, $marker, $limit);
$result = array();
foreach ( $files as $file )
{
switch ( true )
{
case $fileTypes !== null :
if ( !isset($file['name']) )
{
continue;
}
if ( is_array($fileTypes) && !in_array(UTIL_File::getExtension($file['name']), $fileTypes) )
{
continue;
}
case isset($file['name']) :
preg_match('/.*?\/([^\/]*)$/', $file['name'], $matches);
if ( isset($matches[1]) && trim($matches[1]) === self::CLOUD_FOLDER_NAME )
{
continue;
}
$result[] = $this->getLocalFSPath($file['name']);
break;
case isset($file['prefix']) :
$result[] = $this->getLocalFSPath($file['prefix']);
break;
}
}
return $result;
}
public function removeDir( $dirPath )
{
$files = null;
$marker = null;
$result = true;
do
{
$files = $this->getFileList($dirPath, null, $marker, 1000, true);
foreach ( $files as $file )
{
if ( isset($file['name']) )
{
$marker = $this->getLocalFSPath($file['name']);
if ( !$this->removeFile($marker) )
{
$result = false;
}
}
else if ( isset($file['prefix']) )
{
$marker = $this->getLocalFSPath($file['prefix']);
$this->removeDir($this->getLocalFSPath($file['prefix']));
}
}
}
while ( !empty($files) );
return $result;
}
public function fileGetContent( $destPath )
{
$cloudPath = $this->getCloudFilePath($destPath);
$object = $this->s3->getObject($this->bucketName, $cloudPath);
if ( !$object )
{
return null;
}
if ( $object->code !== 200 || !isset($object->body) )
{
return null;
}
return $object->body;
}
public function fileSetContent( $destPath, $content )
{
$cloudPath = $this->getCloudFilePath($destPath);
$result = $this->s3->putObject($content, $this->bucketName, $cloudPath, S3::ACL_PUBLIC_READ, array(), $this->requestHeaders);
if ( $result )
{
$object = $this->s3->getObjectInfo($this->bucketName, $cloudFilePath);
$this->triggerFileUploadEvent($destPath, $object['size']);
}
return $result;
}
public function getFileUrl( $path )
{
return $this->getBucketUrl() . ($this->getCloudFilePath($path));
}
public function getBucketUrl()
{
return $this->bucketUrl;
}
public function fileExists( $path )
{
$result = false;
if ( $this->isFile($path) || $this->isDir($path) )
{
$result = true;
}
return $result;
}
public function isFile( $path )
{
$cloudFilePath = $this->getCloudFilePath($path);
$info = $this->s3->getObjectInfo($this->bucketName, $cloudFilePath);
$result = false;
if ( isset($info) && !empty($info['hash']) )
{
$result = true;
}
return $result;
}
public function isDir( $path )
{
$cloudFilePath = $this->removeSlash($this->getCloudFilePath($path)) . self::CLOUD_FILES_DS . self::CLOUD_FOLDER_NAME;
$info = $this->s3->getObjectInfo($this->bucketName, $cloudFilePath);
$result = false;
if ( isset($info) && !empty($info['hash']) )
{
$result = true;
}
return $result;
}
public function mkdir( $path )
{
if ( empty($path) )
{
return false;
}
$array = preg_split('/\//', $this->removeSlash($this->getCloudFilePath($path)));
$cloudFilePath = '';
foreach ( $array as $folder )
{
if ( !empty($folder) )
{
$cloudFilePath .= $folder . self::CLOUD_FILES_DS;
$this->s3->putObject(self::CLOUD_FOLDER_NAME, $this->bucketName, $cloudFilePath . self::CLOUD_FOLDER_NAME);
}
}
return true;
}
private function removeSlash( $path )
{
$path = trim($path);
if ( substr($path, 0, 1) === self::CLOUD_FILES_DS )
{
$path = substr($path, 1);
}
if ( substr($path, -1) === self::CLOUD_FILES_DS )
{
$path = substr($path, 0, -1);
}
return $path;
}
private function getCloudFilePath( $path )
{
$cloudPath = null;
$prefixLength = strlen(OW_DIR_ROOT);
$filePathLength = strlen($path);
if ( $prefixLength <= $filePathLength && substr($path, 0, $prefixLength) === OW_DIR_ROOT )
{
$cloudPath = str_replace(OW_DIR_ROOT, '', $path);
$cloudPath = str_replace(DS, '/', $cloudPath);
$cloudPath = $this->removeSlash($cloudPath);
}
else
{
throw new Exception("Cant find directory `" . $path . "`!");
}
return $cloudPath;
}
private function getLocalFSPath( $cloudPath )
{
$cloudPath = $this->removeSlash($cloudPath);
$result = OW_DIR_ROOT . str_replace('/', DS, $cloudPath);
return $result;
}
private static function getExtension( $filenName )
{
if ( strrpos($filenName, '.') == 0 )
{
return null;
}
return UTIL_File::getExtension($filenName);
}
public function isWritable( $path )
{
return true;
}
public function renameFile( $oldDestPath, $newDestPath )
{
$result = false;
$oldCloudPath = $this->getCloudFilePath($oldDestPath);
$newCloudPath = $this->getCloudFilePath($newDestPath);
$result = $this->s3->copyObject($this->bucketName, $oldCloudPath, $this->bucketName, $newCloudPath, S3::ACL_PUBLIC_READ, array(), $this->requestHeaders);
if ( $oldCloudPath != $newCloudPath )
{
$this->removeFile($oldDestPath);
}
$info = $this->s3->getObjectInfo($this->bucketName, $newCloudPath);
$this->triggerFileUploadEvent($newCloudPath, $info['size']);
return $result;
}
private function triggerFileUploadEvent( $path, $size )
{
if ( empty($path) )
{
return;
}
$params = array(
'path' => $path,
'size' => (int) $size
);
$event = new OW_Event(self::EVENT_ON_FILE_UPLOAD, $params);
OW::getEventManager()->trigger($event);
}
private function triggerFileDeleteEvent( $path, $size )
{
if ( empty($path) )
{
return;
}
$params = array(
'path' => $path,
'size' => (int)$size
);
$event = new OW_Event(self::EVENT_ON_FILE_DELETE, $params);
OW::getEventManager()->trigger($event);
}
public function chmod( $path, $permissions )
{
//chmod($path, $permissions);
}
}