I've had the fun task of creating an interface to the popular Rackspace Cloud Files service. If you don't know what that is, its a service that allows you to store unlimited amounts of data remotely and serve them on the fly. You only pay for what storage you use and how much bandwidth you use. It's extremely affordable and a great way to speed up your application by off-hosting your assets (browsers can only download 2 concurrent assets per domain). To read more about the service visit here: http://www.rackspace.com/cloud/cloud_hosting_products/files/

This plugin utilizes the php-cloudfiles class created by Rackspace.

Requirements

This plugin required CakePHP 2.x, PHP 5.x, and because it utilizes php-cloudfiles, any requirements defined by that package https://github.com/rackspace/php-cloudfiles

Install

Now that your sold on the service, You can install this plugin to help jump start your CDN management system. There are two ways to install the plugin:

Git Installation

git clone git://github.com/webtechnick/CakePHP-CloudFiles-Plugin.git app/Plugin/CloudFiles
cd app/Plugin/CloudFiles
git submodule init
git submodule update

Manual Installation

Download https://github.com/webtechnick/CakePHP-CloudFiles-Plugin plugin into app/Plugin/CloudFiles
Download https://github.com/rackspace/php-cloudfiles into app/Plugin/CloudFiles/Vendor/php-cloudfiles

Configuration

Ensure the plugin is loaded in app/Config/bootstrap.php by calling CakePlugin::load('CloudFiles');

//app/Config/bootstrap.php
CakePlugin::load('CloudFiles');

Create a file app/Config/cloud_files.php with the following:

//app/Config/cloud_files.php
$config = array(
'CloudFiles' => array(
'server' => 'US', //UK
'username' => 'your_username', //your username
'api_key' => 'API_KEY', //your api key
)
);

Example of this configuration file is in app/Plugin/CloudFiles/Config/cloud_files.php.default

Usage Examples

The majority of the plugin is in a static library called CloudFiles, some of you purists would say "Hey Nick, you're interacting with a remote service, this should be in a datasource!" And normally I would say you're correct, although a little rude. ;-) However, a datasource is normally coupled with a model and I wanted a simple class to be called statically and preform the REST functions I required. If I created a datasource I couldn't make it static, and it wasn't as portable as I wanted the class to be. Plus, in CakePHP 2.x a lot of the core classes are moving to Libraries instead for easy portability across your application -- I'm following the suit.

Upload a file to Rackspace

Uploads a local file to the specified container in Rackspace

App::uses('CloudFiles','CloudFiles.Lib');
$cdn_url = CloudFiles::upload('/path/to/image.jpg','container_name');

Download a file from Rackspace

Download a remote file on Rackspace in a specific container to a local file

App::uses('CloudFiles','CloudFiles.Lib');
CloudFiles::download('image.jpg', 'container_name', '/local/path/to/image.jpg');

Delete a file from Rackspace

Delete a file from a specific container on Rackspace

App::uses('CloudFiles','CloudFiles.Lib');
CloudFiles::delete('image.jpg','container_name');

List files on Rackspace

List files in a specified container on Rackspace

App::uses('CloudFiles','CloudFiles.Lib');
//Get all files in container
$files = CloudFiles::ls('container_name');
//Get files in subfolder
$files = CloudFiles::ls('container_name', array(
'path' => 'pictures/animals'
));
//Get files starting with a prefix
$files = CloudFiles::ls('container_name', array(
'prefix' => 'cake'
));
//Limit the files returned
$files = CloudFiles::ls('container_name', array(
'limit' => 10
));
//Limit the files returned, starting at marker
$files = CloudFiles::ls('container_name', array(
'limit' => 10,
'marker' => 30
));

Public or Streaming URL of a file on Rackspace

Get the URL of an object in Rackspace (streaming or public)

App::uses('CloudFiles','CloudFiles.Lib');
$url = CloudFiles::url('image.jpg','container_name');
$stream = CloudFiles::stream('movie.mov', 'container_name');

There is also a helper class to assist image and streaming retrieval

//Some Controller
public $helpers = array('CloudFiles.CloudFiles');

//Some View
echo $this->CloudFiles->image('image.jpg','container_name');
echo $this->CloudFiles->stream('movie.mov', 'container_name');
echo $this->CloudFiles->url('some_file.txt', 'container_name');

List containers on Rackspace

List all containers on Rackspace

App::uses('CloudFiles','CloudFiles.Lib');
//Get all containers
$containers = CloudFiles::listContainers();
//Limit the containers returned
$containers = CloudFiles::listContainers(array(
'limit' => 2
));
//Show only public containers
$containers = CloudFiles::listContainers(array(
'only_public' => true
));

Create container on Rackspace

Created a container on Rackspace, defaults to public container (CDN)

App::uses('CloudFiles','CloudFiles.Lib');
$Container = CloudFiles::createContainer('css');
//Create a non-public container
$Container = CloudFiles::createContainer('no_public', false);

Delete a container on Rackspace

Delete a container on Rackspace, notice container must be empty.

App::uses('CloudFiles', 'CloudFiles.Lib');
CloudFiles::deleteContainer('container_name');

Enjoy!

As always, comments are appreciated. I hope you enjoy the plugin.

latest articles

10.18.2012

06.09.2012

03.30.2012

01.31.2012

11.07.2011

11.05.2011

08.15.2011

>> More Articles...

Downloads

Links

Google Ad

CakePHP CloudFiles Plugin for Rackspace CDN

CakePHP CloudFiles Plugin

CakePHP, CloudFiles, and You -- The Perfect Threesome