1 module Technoweenie # :nodoc:
2 module AttachmentFu # :nodoc:
4 # = CloudFiles Storage Backend
6 # Enables use of {Rackspace Cloud Files}[http://www.mosso.com/cloudfiles.jsp] as a storage mechanism
8 # Based heavily on the Amazon S3 backend.
12 # Requires the {Cloud Files Gem}[http://www.mosso.com/cloudfiles.jsp] by Rackspace
16 # Configuration is done via <tt>RAILS_ROOT/config/rackspace_cloudfiles.yml</tt> and is loaded according to the <tt>RAILS_ENV</tt>.
17 # The minimum connection options that you must specify are a container name, your Mosso login name and your Mosso API key.
18 # You can sign up for Cloud Files and get access keys by visiting https://www.mosso.com/buy.htm
20 # Example configuration (RAILS_ROOT/config/rackspace_cloudfiles.yml)
23 # container_name: appname_development
24 # username: <your key>
28 # container_name: appname_test
29 # username: <your key>
33 # container_name: appname
34 # username: <your key>
35 # apik_key: <your key>
37 # You can change the location of the config path by passing a full path to the :cloudfiles_config_path option.
39 # has_attachment :storage => :cloud_files, :cloudfiles_config_path => (RAILS_ROOT + '/config/mosso.yml')
41 # === Required configuration parameters
43 # * <tt>:username</tt> - The username for your Rackspace Cloud (Mosso) account. Provided by Rackspace.
44 # * <tt>:secret_access_key</tt> - The api key for your Rackspace Cloud account. Provided by Rackspace.
45 # * <tt>:container_name</tt> - The name of a container in your Cloud Files account.
47 # If any of these required arguments is missing, a AuthenticationException will be raised from CloudFiles::Connection.
51 # To specify Cloud Files as the storage mechanism for a model, set the acts_as_attachment <tt>:storage</tt> option to <tt>:cloud_files/tt>.
53 # class Photo < ActiveRecord::Base
54 # has_attachment :storage => :cloud_files
57 # === Customizing the path
59 # By default, files are prefixed using a pseudo hierarchy in the form of <tt>:table_name/:id</tt>, which results
60 # in Cloud Files object names (and urls) that look like: http://:server/:container_name/:table_name/:id/:filename with :table_name
61 # representing the customizable portion of the path. You can customize this prefix using the <tt>:path_prefix</tt>
64 # class Photo < ActiveRecord::Base
65 # has_attachment :storage => :cloud_files, :path_prefix => 'my/custom/path'
68 # Which would result in public URLs like <tt>http(s)://:server/:container_name/my/custom/path/:id/:filename.</tt>
72 # File permisisons are determined by the permissions of the container. At present, the options are public (and distributed
73 # by the Limelight CDN), and private (only available to your login)
77 # Of course, all the usual configuration options apply, such as content_type and thumbnails:
79 # class Photo < ActiveRecord::Base
80 # has_attachment :storage => :cloud_files, :content_type => ['application/pdf', :image], :resize_to => 'x50'
81 # has_attachment :storage => :cloud_files, :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
84 # === Accessing Cloud Files URLs
86 # You can get an object's public URL using the cloudfiles_url accessor. For example, assuming that for your postcard app
87 # you had a container name like 'postcard_world_development', and an attachment model called Photo:
89 # @postcard.cloudfiles_url # => http://cdn.cloudfiles.mosso.com/c45182/uploaded_files/20/london.jpg
91 # The resulting url is in the form: http://:server/:container_name/:table_name/:id/:file.
92 # The optional thumbnail argument will output the thumbnail's filename (if any).
94 # Additionally, you can get an object's base path relative to the container root using
97 # @photo.file_base_path # => uploaded_files/20
99 # And the full path (including the filename) using <tt>full_filename</tt>:
101 # @photo.full_filename # => uploaded_files/20/london.jpg
103 # Niether <tt>base_path</tt> or <tt>full_filename</tt> include the container name as part of the path.
104 # You can retrieve the container name using the <tt>container_name</tt> method.
105 module CloudFileBackend
106 class RequiredLibraryNotFoundError < StandardError; end
107 class ConfigFileNotFoundError < StandardError; end
109 def self.included(base) #:nodoc:
110 mattr_reader :container_name, :cloudfiles_config
115 raise RequiredLibraryNotFoundError.new('CloudFiles could not be loaded')
119 @@cloudfiles_config_path = base.attachment_options[:cloudfiles_config_path] || (RAILS_ROOT + '/config/rackspace_cloudfiles.yml')
120 @@cloudfiles_config = @@cloudfiles_config = YAML.load(ERB.new(File.read(@@cloudfiles_config_path)).result)[RAILS_ENV].symbolize_keys
122 #raise ConfigFileNotFoundError.new('File %s not found' % @@cloudfiles_config_path)
125 @@container_name = @@cloudfiles_config[:container_name]
126 @@cf = CloudFiles::Connection.new(@@cloudfiles_config[:username], @@cloudfiles_config[:api_key])
127 @@container = @@cf.container(@@container_name)
129 base.before_update :rename_file
132 # Overwrites the base filename writer in order to store the old filename
134 @old_filename = filename unless filename.nil? || @old_filename
135 write_attribute :filename, sanitize_filename(value)
138 # The attachment ID used in the full path of a file
139 def attachment_path_id
140 ((respond_to?(:parent_id) && parent_id) || id).to_s
143 # The pseudo hierarchy containing the file relative to the container name
144 # Example: <tt>:table_name/:id</tt>
146 File.join(attachment_options[:path_prefix], attachment_path_id)
149 # The full path to the file relative to the container name
150 # Example: <tt>:table_name/:id/:filename</tt>
151 def full_filename(thumbnail = nil)
152 File.join(base_path, thumbnail_name_for(thumbnail))
155 # All public objects are accessible via a GET request to the Cloud Files servers. You can generate a
156 # url for an object using the cloudfiles_url method.
158 # @photo.cloudfiles_url
160 # The resulting url is in the CDN URL for the object
162 # The optional thumbnail argument will output the thumbnail's filename (if any).
164 # If you are trying to get the URL for a nonpublic container, nil will be returned.
165 def cloudfiles_url(thumbnail = nil)
166 if @@container.public?
167 File.join(@@container.cdn_url, full_filename(thumbnail))
172 alias :public_filename :cloudfiles_url
175 write_to_temp_file current_data
179 @@container.get_object(full_filename).data
183 # Called in the after_destroy callback
185 @@container.delete_object(full_filename)
189 # Cloud Files doesn't rename right now, so we'll just nuke.
190 return unless @old_filename && @old_filename != filename
192 old_full_filename = File.join(base_path, @old_filename)
193 @@container.delete_object(old_full_filename)
201 @object = @@container.create_object(full_filename)
202 @object.write((temp_path ? File.open(temp_path) : temp_data))