atd-attachment_fu 1.0.20080507

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. data/CHANGELOG +35 -0
  2. data/README +186 -0
  3. data/Rakefile +22 -0
  4. data/amazon_s3.yml.tpl +14 -0
  5. data/attachment_fu.gemspec +79 -0
  6. data/lib/geometry.rb +93 -0
  7. data/lib/technoweenie/attachment_fu.rb +497 -0
  8. data/lib/technoweenie/attachment_fu/backends/db_file_backend.rb +39 -0
  9. data/lib/technoweenie/attachment_fu/backends/file_system_backend.rb +101 -0
  10. data/lib/technoweenie/attachment_fu/backends/s3_backend.rb +303 -0
  11. data/lib/technoweenie/attachment_fu/processors/core_image_processor.rb +59 -0
  12. data/lib/technoweenie/attachment_fu/processors/gd2_processor.rb +54 -0
  13. data/lib/technoweenie/attachment_fu/processors/image_science_processor.rb +61 -0
  14. data/lib/technoweenie/attachment_fu/processors/mini_magick_processor.rb +132 -0
  15. data/lib/technoweenie/attachment_fu/processors/rmagick_processor.rb +54 -0
  16. data/rails/init.rb +16 -0
  17. data/test/backends/db_file_test.rb +16 -0
  18. data/test/backends/file_system_test.rb +80 -0
  19. data/test/backends/remote/s3_test.rb +119 -0
  20. data/test/base_attachment_tests.rb +77 -0
  21. data/test/basic_test.rb +71 -0
  22. data/test/database.yml +18 -0
  23. data/test/extra_attachment_test.rb +86 -0
  24. data/test/fixtures/attachment.rb +183 -0
  25. data/test/fixtures/files/fake/rails.png +0 -0
  26. data/test/fixtures/files/foo.txt +1 -0
  27. data/test/fixtures/files/rails.png +0 -0
  28. data/test/geometry_test.rb +108 -0
  29. data/test/processors/core_image_test.rb +37 -0
  30. data/test/processors/gd2_test.rb +31 -0
  31. data/test/processors/image_science_test.rb +31 -0
  32. data/test/processors/mini_magick_test.rb +103 -0
  33. data/test/processors/rmagick_test.rb +255 -0
  34. data/test/schema.rb +109 -0
  35. data/test/test_helper.rb +150 -0
  36. data/test/validation_test.rb +55 -0
  37. data/vendor/red_artisan/core_image/filters/color.rb +27 -0
  38. data/vendor/red_artisan/core_image/filters/effects.rb +31 -0
  39. data/vendor/red_artisan/core_image/filters/perspective.rb +25 -0
  40. data/vendor/red_artisan/core_image/filters/quality.rb +25 -0
  41. data/vendor/red_artisan/core_image/filters/scale.rb +47 -0
  42. data/vendor/red_artisan/core_image/filters/watermark.rb +32 -0
  43. data/vendor/red_artisan/core_image/processor.rb +123 -0
  44. metadata +116 -0
@@ -0,0 +1,35 @@
1
+ * Apr 17 2008 *
2
+ * amazon_s3.yml is now passed through ERB before being passed to AWS::S3 [François Beausoleil]
3
+
4
+ * Mar 22 2008 *
5
+ * Some tweaks to support Rails 2.0 and Rails 2.1 due to ActiveSupport::Callback changes.
6
+ Thanks to http://blog.methodmissing.com/2008/1/19/edge-callback-refactorings-attachment_fu/
7
+
8
+ * Feb. 26, 2008 *
9
+ * remove breakpoint from test_helper, makes test suite crazy (at least Rails 2+) [Rob Sanheim]
10
+ * make S3 test really optional [Rob Sanheim]
11
+
12
+ * Nov 27, 2007 *
13
+ * Handle properly ImageScience thumbnails resized from a gif file [Matt Aimonetti]
14
+ * Save thumbnails file size properly when using ImageScience [Matt Aimonetti]
15
+ * fixed s3 config file loading with latest versions of Rails [Matt Aimonetti]
16
+
17
+ * April 2, 2007 *
18
+
19
+ * don't copy the #full_filename to the default #temp_paths array if it doesn't exist
20
+ * add default ID partitioning for attachments
21
+ * add #binmode call to Tempfile (note: ruby should be doing this!) [Eric Beland]
22
+ * Check for current type of :thumbnails option.
23
+ * allow customization of the S3 configuration file path with the :s3_config_path option.
24
+ * Don't try to remove thumbnails if there aren't any. Closes #3 [ben stiglitz]
25
+
26
+ * BC * (before changelog)
27
+
28
+ * add default #temp_paths entry [mattly]
29
+ * add MiniMagick support to attachment_fu [Isacc]
30
+ * update #destroy_file to clear out any empty directories too [carlivar]
31
+ * fix references to S3Backend module [Hunter Hillegas]
32
+ * make #current_data public with db_file and s3 backends [ebryn]
33
+ * oops, actually svn add the files for s3 backend. [Jeffrey Hardy]
34
+ * experimental s3 support, egad, no tests.... [Jeffrey Hardy]
35
+ * doh, fix a few bad references to ActsAsAttachment [sixty4bit]
data/README ADDED
@@ -0,0 +1,186 @@
1
+ attachment-fu
2
+ =============
3
+
4
+ attachment_fu is a plugin by Rick Olson (aka technoweenie <http://techno-weenie.net>) and is the successor to acts_as_attachment. To get a basic run-through of its capabilities, check out Mike Clark's tutorial <http://clarkware.com/cgi/blosxom/2007/02/24#FileUploadFu>.
5
+
6
+
7
+ attachment_fu functionality
8
+ ===========================
9
+
10
+ attachment_fu facilitates file uploads in Ruby on Rails. There are a few storage options for the actual file data, but the plugin always at a minimum stores metadata for each file in the database.
11
+
12
+ There are three storage options for files uploaded through attachment_fu:
13
+ File system
14
+ Database file
15
+ Amazon S3
16
+
17
+ Each method of storage many options associated with it that will be covered in the following section. Something to note, however, is that the Amazon S3 storage requires you to modify config/amazon_s3.yml and the Database file storage requires an extra table.
18
+
19
+
20
+ attachment_fu models
21
+ ====================
22
+
23
+ For all three of these storage options a table of metadata is required. This table will contain information about the file (hence the 'meta') and its location. This table has no restrictions on naming, unlike the extra table required for database storage, which must have a table name of db_files (and by convention a model of DbFile).
24
+
25
+ In the model there are two methods made available by this plugins: has_attachment and validates_as_attachment.
26
+
27
+ has_attachment(options = {})
28
+ This method accepts the options in a hash:
29
+ :content_type # Allowed content types.
30
+ # Allows all by default. Use :image to allow all standard image types.
31
+ :min_size # Minimum size allowed.
32
+ # 1 byte is the default.
33
+ :max_size # Maximum size allowed.
34
+ # 1.megabyte is the default.
35
+ :size # Range of sizes allowed.
36
+ # (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
37
+ :resize_to # Used by RMagick to resize images.
38
+ # Pass either an array of width/height, or a geometry string.
39
+ :thumbnails # Specifies a set of thumbnails to generate.
40
+ # This accepts a hash of filename suffixes and RMagick resizing options.
41
+ # This option need only be included if you want thumbnailing.
42
+ :thumbnail_class # Set which model class to use for thumbnails.
43
+ # This current attachment class is used by default.
44
+ :path_prefix # path to store the uploaded files.
45
+ # Uses public/#{table_name} by default for the filesystem, and just #{table_name} for the S3 backend.
46
+ # Setting this sets the :storage to :file_system.
47
+ :partition # Partiton files in directories like /0000/0001/image.jpg. Default is true.
48
+ :storage # Specifies the storage system to use..
49
+ # Defaults to :db_file. Options are :file_system, :db_file, and :s3.
50
+ :processor # Sets the image processor to use for resizing of the attached image.
51
+ # Options include ImageScience, Rmagick, and MiniMagick. Default is whatever is installed.
52
+
53
+
54
+ Examples:
55
+ has_attachment :max_size => 1.kilobyte
56
+ has_attachment :size => 1.megabyte..2.megabytes
57
+ has_attachment :content_type => 'application/pdf'
58
+ has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
59
+ has_attachment :content_type => :image, :resize_to => [50,50]
60
+ has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
61
+ has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
62
+ has_attachment :storage => :file_system, :path_prefix => 'public/files'
63
+ has_attachment :storage => :file_system, :path_prefix => 'public/files',
64
+ :content_type => :image, :resize_to => [50,50], :partition => false
65
+ has_attachment :storage => :file_system, :path_prefix => 'public/files',
66
+ :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
67
+ has_attachment :storage => :s3
68
+
69
+ validates_as_attachment
70
+ This method prevents files outside of the valid range (:min_size to :max_size, or the :size range) from being saved. It does not however, halt the upload of such files. They will be uploaded into memory regardless of size before validation.
71
+
72
+ Example:
73
+ validates_as_attachment
74
+
75
+
76
+ attachment_fu migrations
77
+ ========================
78
+
79
+ Fields for attachment_fu metadata tables...
80
+ in general:
81
+ size, :integer # file size in bytes
82
+ content_type, :string # mime type, ex: application/mp3
83
+ filename, :string # sanitized filename
84
+ that reference images:
85
+ height, :integer # in pixels
86
+ width, :integer # in pixels
87
+ that reference images that will be thumbnailed:
88
+ parent_id, :integer # id of parent image (on the same table, a self-referencing foreign-key).
89
+ # Only populated if the current object is a thumbnail.
90
+ thumbnail, :string # the 'type' of thumbnail this attachment record describes.
91
+ # Only populated if the current object is a thumbnail.
92
+ # Usage:
93
+ # [ In Model 'Avatar' ]
94
+ # has_attachment :content_type => :image,
95
+ # :storage => :file_system,
96
+ # :max_size => 500.kilobytes,
97
+ # :resize_to => '320x200>',
98
+ # :thumbnails => { :small => '10x10>',
99
+ # :thumb => '100x100>' }
100
+ # [ Elsewhere ]
101
+ # @user.avatar.thumbnails.first.thumbnail #=> 'small'
102
+ that reference files stored in the database (:db_file):
103
+ db_file_id, :integer # id of the file in the database (foreign key)
104
+
105
+ Field for attachment_fu db_files table:
106
+ data, :binary # binary file data, for use in database file storage
107
+
108
+
109
+ attachment_fu views
110
+ ===================
111
+
112
+ There are two main views tasks that will be directly affected by attachment_fu: upload forms and displaying uploaded images.
113
+
114
+ There are two parts of the upload form that differ from typical usage.
115
+ 1. Include ':multipart => true' in the html options of the form_for tag.
116
+ Example:
117
+ <% form_for(:attachment_metadata, :url => { :action => "create" }, :html => { :multipart => true }) do |form| %>
118
+
119
+ 2. Use the file_field helper with :uploaded_data as the field name.
120
+ Example:
121
+ <%= form.file_field :uploaded_data %>
122
+
123
+ Displaying uploaded images is made easy by the public_filename method of the ActiveRecord attachment objects using file system and s3 storage.
124
+
125
+ public_filename(thumbnail = nil)
126
+ Returns the public path to the file. If a thumbnail prefix is specified it will return the public file path to the corresponding thumbnail.
127
+ Examples:
128
+ attachment_obj.public_filename #=> /attachments/2/file.jpg
129
+ attachment_obj.public_filename(:thumb) #=> /attachments/2/file_thumb.jpg
130
+ attachment_obj.public_filename(:small) #=> /attachments/2/file_small.jpg
131
+
132
+ When serving files from database storage, doing more than simply downloading the file is beyond the scope of this document.
133
+
134
+
135
+ attachment_fu controllers
136
+ =========================
137
+
138
+ There are two considerations to take into account when using attachment_fu in controllers.
139
+
140
+ The first is when the files have no publicly accessible path and need to be downloaded through an action.
141
+
142
+ Example:
143
+ def readme
144
+ send_file '/path/to/readme.txt', :type => 'plain/text', :disposition => 'inline'
145
+ end
146
+
147
+ See the possible values for send_file for reference.
148
+
149
+
150
+ The second is when saving the file when submitted from a form.
151
+ Example in view:
152
+ <%= form.file_field :attachable, :uploaded_data %>
153
+
154
+ Example in controller:
155
+ def create
156
+ @attachable_file = AttachmentMetadataModel.new(params[:attachable])
157
+ if @attachable_file.save
158
+ flash[:notice] = 'Attachment was successfully created.'
159
+ redirect_to attachable_url(@attachable_file)
160
+ else
161
+ render :action => :new
162
+ end
163
+ end
164
+
165
+ attachement_fu scripting
166
+ ====================================
167
+
168
+ You may wish to import a large number of images or attachments.
169
+ The following example shows how to upload a file from a script.
170
+
171
+ #!/usr/bin/env ./script/runner
172
+
173
+ # required to use ActionController::TestUploadedFile
174
+ require 'action_controller'
175
+ require 'action_controller/test_process.rb'
176
+
177
+ path = "./public/images/x.jpg"
178
+
179
+ # mimetype is a string like "image/jpeg". One way to get the mimetype for a given file on a UNIX system
180
+ # mimetype = `file -ib #{path}`.gsub(/\n/,"")
181
+
182
+ mimetype = "image/jpeg"
183
+
184
+ # This will "upload" the file at path and create the new model.
185
+ @attachable = AttachmentMetadataModel.new(:uploaded_data => ActionController::TestUploadedFile.new(path, mimetype))
186
+ @attachable.save
@@ -0,0 +1,22 @@
1
+ require 'rake'
2
+ require 'rake/testtask'
3
+ require 'rake/rdoctask'
4
+
5
+ desc 'Default: run unit tests.'
6
+ task :default => :test
7
+
8
+ desc 'Test the attachment_fu plugin.'
9
+ Rake::TestTask.new(:test) do |t|
10
+ t.libs << 'lib'
11
+ t.pattern = 'test/**/*_test.rb'
12
+ t.verbose = true
13
+ end
14
+
15
+ desc 'Generate documentation for the attachment_fu plugin.'
16
+ Rake::RDocTask.new(:rdoc) do |rdoc|
17
+ rdoc.rdoc_dir = 'rdoc'
18
+ rdoc.title = 'ActsAsAttachment'
19
+ rdoc.options << '--line-numbers --inline-source'
20
+ rdoc.rdoc_files.include('README')
21
+ rdoc.rdoc_files.include('lib/**/*.rb')
22
+ end
@@ -0,0 +1,14 @@
1
+ development:
2
+ bucket_name: appname_development
3
+ access_key_id:
4
+ secret_access_key:
5
+
6
+ test:
7
+ bucket_name: appname_test
8
+ access_key_id:
9
+ secret_access_key:
10
+
11
+ production:
12
+ bucket_name: appname
13
+ access_key_id:
14
+ secret_access_key:
@@ -0,0 +1,79 @@
1
+ Gem::Specification.new do |s|
2
+ s.name = "attachment_fu"
3
+ s.version = "1.0.20080507"
4
+ s.date = "2008-05-07"
5
+ s.summary = "Gemified technoweenie attachment_fu plugin"
6
+ s.email = "avanie@gmail.com"
7
+ s.homepage = "http://github.com/pager/attachment_fu"
8
+ s.has_rdoc = true
9
+ s.authors = ["technoweenie"]
10
+ s.files = [
11
+ "amazon_s3.yml.tpl",
12
+ "attachment_fu.gemspec",
13
+ "CHANGELOG",
14
+ "lib/geometry.rb",
15
+ "lib/technoweenie/attachment_fu/backends/db_file_backend.rb",
16
+ "lib/technoweenie/attachment_fu/backends/file_system_backend.rb",
17
+ "lib/technoweenie/attachment_fu/backends/s3_backend.rb",
18
+ "lib/technoweenie/attachment_fu/processors/core_image_processor.rb",
19
+ "lib/technoweenie/attachment_fu/processors/gd2_processor.rb",
20
+ "lib/technoweenie/attachment_fu/processors/image_science_processor.rb",
21
+ "lib/technoweenie/attachment_fu/processors/mini_magick_processor.rb",
22
+ "lib/technoweenie/attachment_fu/processors/rmagick_processor.rb",
23
+ "lib/technoweenie/attachment_fu.rb",
24
+ "rails/init.rb",
25
+ "Rakefile",
26
+ "README",
27
+ "test/backends/db_file_test.rb",
28
+ "test/backends/file_system_test.rb",
29
+ "test/backends/remote/s3_test.rb",
30
+ "test/base_attachment_tests.rb",
31
+ "test/basic_test.rb",
32
+ "test/database.yml",
33
+ "test/extra_attachment_test.rb",
34
+ "test/fixtures/attachment.rb",
35
+ "test/fixtures/files/fake/rails.png",
36
+ "test/fixtures/files/foo.txt",
37
+ "test/fixtures/files/rails.png",
38
+ "test/geometry_test.rb",
39
+ "test/processors/core_image_test.rb",
40
+ "test/processors/gd2_test.rb",
41
+ "test/processors/image_science_test.rb",
42
+ "test/processors/mini_magick_test.rb",
43
+ "test/processors/rmagick_test.rb",
44
+ "test/schema.rb",
45
+ "test/test_helper.rb",
46
+ "test/validation_test.rb",
47
+ "vendor/red_artisan/core_image/filters/color.rb",
48
+ "vendor/red_artisan/core_image/filters/effects.rb",
49
+ "vendor/red_artisan/core_image/filters/perspective.rb",
50
+ "vendor/red_artisan/core_image/filters/quality.rb",
51
+ "vendor/red_artisan/core_image/filters/scale.rb",
52
+ "vendor/red_artisan/core_image/filters/watermark.rb",
53
+ "vendor/red_artisan/core_image/processor.rb"
54
+ ]
55
+ s.test_files = [
56
+ "test/backends/db_file_test.rb",
57
+ "test/backends/file_system_test.rb",
58
+ "test/backends/remote/s3_test.rb",
59
+ "test/base_attachment_tests.rb",
60
+ "test/basic_test.rb",
61
+ "test/database.yml",
62
+ "test/extra_attachment_test.rb",
63
+ "test/fixtures/attachment.rb",
64
+ "test/fixtures/files/fake/rails.png",
65
+ "test/fixtures/files/foo.txt",
66
+ "test/fixtures/files/rails.png",
67
+ "test/geometry_test.rb",
68
+ "test/processors/core_image_test.rb",
69
+ "test/processors/gd2_test.rb",
70
+ "test/processors/image_science_test.rb",
71
+ "test/processors/mini_magick_test.rb",
72
+ "test/processors/rmagick_test.rb",
73
+ "test/schema.rb",
74
+ "test/test_helper.rb",
75
+ "test/validation_test.rb"
76
+ ]
77
+ s.rdoc_options = ["--main", "README"]
78
+ s.extra_rdoc_files = ["README", "CHANGELOG"]
79
+ end
@@ -0,0 +1,93 @@
1
+ # This Geometry class was yanked from RMagick. However, it lets ImageMagick handle the actual change_geometry.
2
+ # Use #new_dimensions_for to get new dimensons
3
+ # Used so I can use spiffy RMagick geometry strings with ImageScience
4
+ class Geometry
5
+ # ! and @ are removed until support for them is added
6
+ FLAGS = ['', '%', '<', '>']#, '!', '@']
7
+ RFLAGS = { '%' => :percent,
8
+ '!' => :aspect,
9
+ '<' => :>,
10
+ '>' => :<,
11
+ '@' => :area }
12
+
13
+ attr_accessor :width, :height, :x, :y, :flag
14
+
15
+ def initialize(width=nil, height=nil, x=nil, y=nil, flag=nil)
16
+ # Support floating-point width and height arguments so Geometry
17
+ # objects can be used to specify Image#density= arguments.
18
+ raise ArgumentError, "width must be >= 0: #{width}" if width < 0
19
+ raise ArgumentError, "height must be >= 0: #{height}" if height < 0
20
+ @width = width.to_f
21
+ @height = height.to_f
22
+ @x = x.to_i
23
+ @y = y.to_i
24
+ @flag = flag
25
+ end
26
+
27
+ # Construct an object from a geometry string
28
+ RE = /\A(\d*)(?:x(\d+)?)?([-+]\d+)?([-+]\d+)?([%!<>@]?)\Z/
29
+
30
+ def self.from_s(str)
31
+ raise(ArgumentError, "no geometry string specified") unless str
32
+
33
+ if m = RE.match(str)
34
+ new(m[1].to_i, m[2].to_i, m[3].to_i, m[4].to_i, RFLAGS[m[5]])
35
+ else
36
+ raise ArgumentError, "invalid geometry format"
37
+ end
38
+ end
39
+
40
+ # Convert object to a geometry string
41
+ def to_s
42
+ str = ''
43
+ str << "%g" % @width if @width > 0
44
+ str << 'x' if (@width > 0 || @height > 0)
45
+ str << "%g" % @height if @height > 0
46
+ str << "%+d%+d" % [@x, @y] if (@x != 0 || @y != 0)
47
+ str << FLAGS[@flag.to_i]
48
+ end
49
+
50
+ # attempts to get new dimensions for the current geometry string given these old dimensions.
51
+ # This doesn't implement the aspect flag (!) or the area flag (@). PDI
52
+ def new_dimensions_for(orig_width, orig_height)
53
+ new_width = orig_width
54
+ new_height = orig_height
55
+
56
+ case @flag
57
+ when :percent
58
+ scale_x = @width.zero? ? 100 : @width
59
+ scale_y = @height.zero? ? @width : @height
60
+ new_width = scale_x.to_f * (orig_width.to_f / 100.0)
61
+ new_height = scale_y.to_f * (orig_height.to_f / 100.0)
62
+ when :<, :>, nil
63
+ scale_factor =
64
+ if new_width.zero? || new_height.zero?
65
+ 1.0
66
+ else
67
+ if @width.nonzero? && @height.nonzero?
68
+ [@width.to_f / new_width.to_f, @height.to_f / new_height.to_f].min
69
+ else
70
+ @width.nonzero? ? (@width.to_f / new_width.to_f) : (@height.to_f / new_height.to_f)
71
+ end
72
+ end
73
+ new_width = scale_factor * new_width.to_f
74
+ new_height = scale_factor * new_height.to_f
75
+ new_width = orig_width if @flag && orig_width.send(@flag, new_width)
76
+ new_height = orig_height if @flag && orig_height.send(@flag, new_height)
77
+ end
78
+
79
+ [new_width, new_height].collect! { |v| [v.round, 1].max }
80
+ end
81
+ end
82
+
83
+ class Array
84
+ # allows you to get new dimensions for the current array of dimensions with a given geometry string
85
+ #
86
+ # [50, 64] / '40>' # => [40, 51]
87
+ def /(geometry)
88
+ raise ArgumentError, "Only works with a [width, height] pair" if size != 2
89
+ raise ArgumentError, "Must pass a valid geometry string or object" unless geometry.is_a?(String) || geometry.is_a?(Geometry)
90
+ geometry = Geometry.from_s(geometry) if geometry.is_a?(String)
91
+ geometry.new_dimensions_for first, last
92
+ end
93
+ end
@@ -0,0 +1,497 @@
1
+ module Technoweenie # :nodoc:
2
+ module AttachmentFu # :nodoc:
3
+ @@default_processors = %w(ImageScience Rmagick MiniMagick Gd2 CoreImage)
4
+ @@tempfile_path = File.join(RAILS_ROOT, 'tmp', 'attachment_fu')
5
+ @@content_types = [
6
+ 'image/jpeg',
7
+ 'image/pjpeg',
8
+ 'image/jpg',
9
+ 'image/gif',
10
+ 'image/png',
11
+ 'image/x-png',
12
+ 'image/jpg',
13
+ 'image/x-ms-bmp',
14
+ 'image/bmp',
15
+ 'image/x-bmp',
16
+ 'image/x-bitmap',
17
+ 'image/x-xbitmap',
18
+ 'image/x-win-bitmap',
19
+ 'image/x-windows-bmp',
20
+ 'image/ms-bmp',
21
+ 'application/bmp',
22
+ 'application/x-bmp',
23
+ 'application/x-win-bitmap',
24
+ 'application/preview',
25
+ 'image/jp_',
26
+ 'application/jpg',
27
+ 'application/x-jpg',
28
+ 'image/pipeg',
29
+ 'image/vnd.swiftview-jpeg',
30
+ 'image/x-xbitmap',
31
+ 'application/png',
32
+ 'application/x-png',
33
+ 'image/gi_',
34
+ 'image/x-citrix-pjpeg'
35
+ ]
36
+ mattr_reader :content_types, :tempfile_path, :default_processors
37
+ mattr_writer :tempfile_path
38
+
39
+ class ThumbnailError < StandardError; end
40
+ class AttachmentError < StandardError; end
41
+
42
+ module ActMethods
43
+ # Options:
44
+ # * <tt>:content_type</tt> - Allowed content types. Allows all by default. Use :image to allow all standard image types.
45
+ # * <tt>:min_size</tt> - Minimum size allowed. 1 byte is the default.
46
+ # * <tt>:max_size</tt> - Maximum size allowed. 1.megabyte is the default.
47
+ # * <tt>:size</tt> - Range of sizes allowed. (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
48
+ # * <tt>:resize_to</tt> - Used by RMagick to resize images. Pass either an array of width/height, or a geometry string.
49
+ # * <tt>:thumbnails</tt> - Specifies a set of thumbnails to generate. This accepts a hash of filename suffixes and RMagick resizing options.
50
+ # * <tt>:thumbnail_class</tt> - Set what class to use for thumbnails. This attachment class is used by default.
51
+ # * <tt>:path_prefix</tt> - path to store the uploaded files. Uses public/#{table_name} by default for the filesystem, and just #{table_name}
52
+ # for the S3 backend. Setting this sets the :storage to :file_system.
53
+ # * <tt>:storage</tt> - Use :file_system to specify the attachment data is stored with the file system. Defaults to :db_system.
54
+
55
+ # * <tt>:keep_profile</tt> By default image EXIF data will be stripped to minimize image size. For small thumbnails this proivides important savings. Picture quality is not affected. Set to false if you want to keep the image profile as is. ImageScience will allways keep EXIF data.
56
+ #
57
+ # Examples:
58
+ # has_attachment :max_size => 1.kilobyte
59
+ # has_attachment :size => 1.megabyte..2.megabytes
60
+ # has_attachment :content_type => 'application/pdf'
61
+ # has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
62
+ # has_attachment :content_type => :image, :resize_to => [50,50]
63
+ # has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
64
+ # has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
65
+ # has_attachment :storage => :file_system, :path_prefix => 'public/files'
66
+ # has_attachment :storage => :file_system, :path_prefix => 'public/files',
67
+ # :content_type => :image, :resize_to => [50,50]
68
+ # has_attachment :storage => :file_system, :path_prefix => 'public/files',
69
+ # :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
70
+ # has_attachment :storage => :s3
71
+ def has_attachment(options = {})
72
+ # this allows you to redefine the acts' options for each subclass, however
73
+ options[:min_size] ||= 1
74
+ options[:max_size] ||= 1.megabyte
75
+ options[:size] ||= (options[:min_size]..options[:max_size])
76
+ options[:thumbnails] ||= {}
77
+ options[:thumbnail_class] ||= self
78
+ options[:s3_access] ||= :public_read
79
+ options[:content_type] = [options[:content_type]].flatten.collect! { |t| t == :image ? Technoweenie::AttachmentFu.content_types : t }.flatten unless options[:content_type].nil?
80
+
81
+ unless options[:thumbnails].is_a?(Hash)
82
+ raise ArgumentError, ":thumbnails option should be a hash: e.g. :thumbnails => { :foo => '50x50' }"
83
+ end
84
+
85
+ extend ClassMethods unless (class << self; included_modules; end).include?(ClassMethods)
86
+ include InstanceMethods unless included_modules.include?(InstanceMethods)
87
+
88
+ parent_options = attachment_options || {}
89
+ # doing these shenanigans so that #attachment_options is available to processors and backends
90
+ self.attachment_options = options
91
+
92
+ attr_accessor :thumbnail_resize_options
93
+
94
+ attachment_options[:storage] ||= (attachment_options[:file_system_path] || attachment_options[:path_prefix]) ? :file_system : :db_file
95
+ attachment_options[:storage] ||= parent_options[:storage]
96
+ attachment_options[:path_prefix] ||= attachment_options[:file_system_path]
97
+ if attachment_options[:path_prefix].nil?
98
+ attachment_options[:path_prefix] = attachment_options[:storage] == :s3 ? table_name : File.join("public", table_name)
99
+ end
100
+ attachment_options[:path_prefix] = attachment_options[:path_prefix][1..-1] if options[:path_prefix].first == '/'
101
+
102
+ with_options :foreign_key => 'parent_id' do |m|
103
+ m.has_many :thumbnails, :class_name => "::#{attachment_options[:thumbnail_class]}"
104
+ m.belongs_to :parent, :class_name => "::#{base_class}" unless options[:thumbnails].empty?
105
+ end
106
+
107
+ storage_mod = Technoweenie::AttachmentFu::Backends.const_get("#{options[:storage].to_s.classify}Backend")
108
+ include storage_mod unless included_modules.include?(storage_mod)
109
+
110
+ case attachment_options[:processor]
111
+ when :none, nil
112
+ processors = Technoweenie::AttachmentFu.default_processors.dup
113
+ begin
114
+ if processors.any?
115
+ attachment_options[:processor] = processors.first
116
+ processor_mod = Technoweenie::AttachmentFu::Processors.const_get("#{attachment_options[:processor].to_s.classify}Processor")
117
+ include processor_mod unless included_modules.include?(processor_mod)
118
+ end
119
+ rescue Object, Exception
120
+ raise unless load_related_exception?($!)
121
+
122
+ processors.shift
123
+ retry
124
+ end
125
+ else
126
+ begin
127
+ processor_mod = Technoweenie::AttachmentFu::Processors.const_get("#{attachment_options[:processor].to_s.classify}Processor")
128
+ include processor_mod unless included_modules.include?(processor_mod)
129
+ rescue Object, Exception
130
+ raise unless load_related_exception?($!)
131
+
132
+ puts "Problems loading #{options[:processor]}Processor: #{$!}"
133
+ end
134
+ end unless parent_options[:processor] # Don't let child override processor
135
+ end
136
+
137
+ def load_related_exception?(e) #:nodoc: implementation specific
138
+ case
139
+ when e.kind_of?(LoadError), e.kind_of?(MissingSourceFile), $!.class.name == "CompilationError"
140
+ # We can't rescue CompilationError directly, as it is part of the RubyInline library.
141
+ # We must instead rescue RuntimeError, and check the class' name.
142
+ true
143
+ else
144
+ false
145
+ end
146
+ end
147
+ private :load_related_exception?
148
+ end
149
+
150
+ module ClassMethods
151
+ delegate :content_types, :to => Technoweenie::AttachmentFu
152
+
153
+ # Performs common validations for attachment models.
154
+ def validates_as_attachment
155
+ validates_presence_of :size, :content_type, :filename
156
+ validate :attachment_attributes_valid?
157
+ end
158
+
159
+ # Returns true or false if the given content type is recognized as an image.
160
+ def image?(content_type)
161
+ content_types.include?(content_type)
162
+ end
163
+
164
+ def self.extended(base)
165
+ base.class_inheritable_accessor :attachment_options
166
+ base.before_destroy :destroy_thumbnails
167
+ base.before_validation :set_size_from_temp_path
168
+ base.after_save :after_process_attachment
169
+ base.after_destroy :destroy_file
170
+ base.after_validation :process_attachment
171
+ if defined?(::ActiveSupport::Callbacks)
172
+ base.define_callbacks :after_resize, :after_attachment_saved, :before_thumbnail_saved
173
+ end
174
+ end
175
+
176
+ unless defined?(::ActiveSupport::Callbacks)
177
+ # Callback after an image has been resized.
178
+ #
179
+ # class Foo < ActiveRecord::Base
180
+ # acts_as_attachment
181
+ # after_resize do |record, img|
182
+ # record.aspect_ratio = img.columns.to_f / img.rows.to_f
183
+ # end
184
+ # end
185
+ def after_resize(&block)
186
+ write_inheritable_array(:after_resize, [block])
187
+ end
188
+
189
+ # Callback after an attachment has been saved either to the file system or the DB.
190
+ # Only called if the file has been changed, not necessarily if the record is updated.
191
+ #
192
+ # class Foo < ActiveRecord::Base
193
+ # acts_as_attachment
194
+ # after_attachment_saved do |record|
195
+ # ...
196
+ # end
197
+ # end
198
+ def after_attachment_saved(&block)
199
+ write_inheritable_array(:after_attachment_saved, [block])
200
+ end
201
+
202
+ # Callback before a thumbnail is saved. Use this to pass any necessary extra attributes that may be required.
203
+ #
204
+ # class Foo < ActiveRecord::Base
205
+ # acts_as_attachment
206
+ # before_thumbnail_saved do |thumbnail|
207
+ # record = thumbnail.parent
208
+ # ...
209
+ # end
210
+ # end
211
+ def before_thumbnail_saved(&block)
212
+ write_inheritable_array(:before_thumbnail_saved, [block])
213
+ end
214
+ end
215
+
216
+ # Get the thumbnail class, which is the current attachment class by default.
217
+ # Configure this with the :thumbnail_class option.
218
+ def thumbnail_class
219
+ attachment_options[:thumbnail_class] = attachment_options[:thumbnail_class].constantize unless attachment_options[:thumbnail_class].is_a?(Class)
220
+ attachment_options[:thumbnail_class]
221
+ end
222
+
223
+ # Copies the given file path to a new tempfile, returning the closed tempfile.
224
+ def copy_to_temp_file(file, temp_base_name)
225
+ returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
226
+ tmp.close
227
+ FileUtils.cp file, tmp.path
228
+ end
229
+ end
230
+
231
+ # Writes the given data to a new tempfile, returning the closed tempfile.
232
+ def write_to_temp_file(data, temp_base_name)
233
+ returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
234
+ tmp.binmode
235
+ tmp.write data
236
+ tmp.close
237
+ end
238
+ end
239
+ end
240
+
241
+ module InstanceMethods
242
+ def self.included(base)
243
+ base.define_callbacks *[:after_resize, :after_attachment_saved, :before_thumbnail_saved] if base.respond_to?(:define_callbacks)
244
+ end
245
+
246
+ # Checks whether the attachment's content type is an image content type
247
+ def image?
248
+ self.class.image?(content_type)
249
+ end
250
+
251
+ # Returns true/false if an attachment is thumbnailable. A thumbnailable attachment has an image content type and the parent_id attribute.
252
+ def thumbnailable?
253
+ image? && respond_to?(:parent_id) && parent_id.nil?
254
+ end
255
+
256
+ # Returns the class used to create new thumbnails for this attachment.
257
+ def thumbnail_class
258
+ self.class.thumbnail_class
259
+ end
260
+
261
+ # Gets the thumbnail name for a filename. 'foo.jpg' becomes 'foo_thumbnail.jpg'
262
+ def thumbnail_name_for(thumbnail = nil)
263
+ return filename if thumbnail.blank?
264
+ ext = nil
265
+ basename = filename.gsub /\.\w+$/ do |s|
266
+ ext = s; ''
267
+ end
268
+ # ImageScience doesn't create gif thumbnails, only pngs
269
+ ext.sub!(/gif$/, 'png') if attachment_options[:processor] == "ImageScience"
270
+ "#{basename}_#{thumbnail}#{ext}"
271
+ end
272
+
273
+ # Creates or updates the thumbnail for the current attachment.
274
+ def create_or_update_thumbnail(temp_file, file_name_suffix, *size)
275
+ thumbnailable? || raise(ThumbnailError.new("Can't create a thumbnail if the content type is not an image or there is no parent_id column"))
276
+ returning find_or_initialize_thumbnail(file_name_suffix) do |thumb|
277
+ thumb.temp_paths.unshift temp_file
278
+ thumb.send(:'attributes=', {
279
+ :content_type => content_type,
280
+ :filename => thumbnail_name_for(file_name_suffix),
281
+ :thumbnail_resize_options => size
282
+ }, false)
283
+ callback_with_args :before_thumbnail_saved, thumb
284
+ thumb.save!
285
+ end
286
+ end
287
+
288
+ # Sets the content type.
289
+ def content_type=(new_type)
290
+ write_attribute :content_type, new_type.to_s.strip
291
+ end
292
+
293
+ # Sanitizes a filename.
294
+ def filename=(new_name)
295
+ write_attribute :filename, sanitize_filename(new_name)
296
+ end
297
+
298
+ # Returns the width/height in a suitable format for the image_tag helper: (100x100)
299
+ def image_size
300
+ [width.to_s, height.to_s] * 'x'
301
+ end
302
+
303
+ # Returns true if the attachment data will be written to the storage system on the next save
304
+ def save_attachment?
305
+ File.file?(temp_path.to_s)
306
+ end
307
+
308
+ # nil placeholder in case this field is used in a form.
309
+ def uploaded_data() nil; end
310
+
311
+ # This method handles the uploaded file object. If you set the field name to uploaded_data, you don't need
312
+ # any special code in your controller.
313
+ #
314
+ # <% form_for :attachment, :html => { :multipart => true } do |f| -%>
315
+ # <p><%= f.file_field :uploaded_data %></p>
316
+ # <p><%= submit_tag :Save %>
317
+ # <% end -%>
318
+ #
319
+ # @attachment = Attachment.create! params[:attachment]
320
+ #
321
+ # TODO: Allow it to work with Merb tempfiles too.
322
+ def uploaded_data=(file_data)
323
+ if file_data.respond_to?(:content_type)
324
+ return nil if file_data.size == 0
325
+ self.content_type = file_data.content_type
326
+ self.filename = file_data.original_filename if respond_to?(:filename)
327
+ else
328
+ return nil if file_data.blank? || file_data['size'] == 0
329
+ self.content_type = file_data['content_type']
330
+ self.filename = file_data['filename']
331
+ file_data = file_data['tempfile']
332
+ end
333
+ # hack to deal with safari not passing a content type for csv files
334
+ self.content_type = "text/csv" if content_type.blank? and filename =~ /\.csv$/i
335
+ if file_data.is_a?(StringIO)
336
+ file_data.rewind
337
+ set_temp_data file_data.read
338
+ else
339
+ self.temp_paths.unshift file_data
340
+ end
341
+ end
342
+
343
+ # Gets the latest temp path from the collection of temp paths. While working with an attachment,
344
+ # multiple Tempfile objects may be created for various processing purposes (resizing, for example).
345
+ # An array of all the tempfile objects is stored so that the Tempfile instance is held on to until
346
+ # it's not needed anymore. The collection is cleared after saving the attachment.
347
+ def temp_path
348
+ p = temp_paths.first
349
+ p.respond_to?(:path) ? p.path : p.to_s
350
+ end
351
+
352
+ # Gets an array of the currently used temp paths. Defaults to a copy of #full_filename.
353
+ def temp_paths
354
+ @temp_paths ||= (new_record? || !respond_to?(:full_filename) || !File.exist?(full_filename) ?
355
+ [] : [copy_to_temp_file(full_filename)])
356
+ end
357
+
358
+ # Gets the data from the latest temp file. This will read the file into memory.
359
+ def temp_data
360
+ save_attachment? ? File.read(temp_path) : nil
361
+ end
362
+
363
+ # Writes the given data to a Tempfile and adds it to the collection of temp files.
364
+ def set_temp_data(data)
365
+ temp_paths.unshift write_to_temp_file data unless data.nil?
366
+ end
367
+
368
+ # Copies the given file to a randomly named Tempfile.
369
+ def copy_to_temp_file(file)
370
+ self.class.copy_to_temp_file file, random_tempfile_filename
371
+ end
372
+
373
+ # Writes the given file to a randomly named Tempfile.
374
+ def write_to_temp_file(data)
375
+ self.class.write_to_temp_file data, random_tempfile_filename
376
+ end
377
+
378
+ # Stub for creating a temp file from the attachment data. This should be defined in the backend module.
379
+ def create_temp_file() end
380
+
381
+ # Allows you to work with a processed representation (RMagick, ImageScience, etc) of the attachment in a block.
382
+ #
383
+ # @attachment.with_image do |img|
384
+ # self.data = img.thumbnail(100, 100).to_blob
385
+ # end
386
+ #
387
+ def with_image(&block)
388
+ self.class.with_image(temp_path, &block)
389
+ end
390
+
391
+ protected
392
+ # Generates a unique filename for a Tempfile.
393
+ def random_tempfile_filename
394
+ "#{rand Time.now.to_i}#{filename || 'attachment'}"
395
+ end
396
+
397
+ def sanitize_filename(filename)
398
+ return unless filename
399
+ returning filename.strip do |name|
400
+ # NOTE: File.basename doesn't work right with Windows paths on Unix
401
+ # get only the filename, not the whole path
402
+ name.gsub! /^.*(\\|\/)/, ''
403
+
404
+ # Finally, replace all non alphanumeric, underscore or periods with underscore
405
+ name.gsub! /[^A-Za-z0-9\.\-]/, '_'
406
+ end
407
+ end
408
+
409
+ # before_validation callback.
410
+ def set_size_from_temp_path
411
+ self.size = File.size(temp_path) if save_attachment?
412
+ end
413
+
414
+ # validates the size and content_type attributes according to the current model's options
415
+ def attachment_attributes_valid?
416
+ [:size, :content_type].each do |attr_name|
417
+ enum = attachment_options[attr_name]
418
+ errors.add attr_name, ActiveRecord::Errors.default_error_messages[:inclusion] unless enum.nil? || enum.include?(send(attr_name))
419
+ end
420
+ end
421
+
422
+ # Initializes a new thumbnail with the given suffix.
423
+ def find_or_initialize_thumbnail(file_name_suffix)
424
+ respond_to?(:parent_id) ?
425
+ thumbnail_class.find_or_initialize_by_thumbnail_and_parent_id(file_name_suffix.to_s, id) :
426
+ thumbnail_class.find_or_initialize_by_thumbnail(file_name_suffix.to_s)
427
+ end
428
+
429
+ # Stub for a #process_attachment method in a processor
430
+ def process_attachment
431
+ @saved_attachment = save_attachment?
432
+ end
433
+
434
+ # Cleans up after processing. Thumbnails are created, the attachment is stored to the backend, and the temp_paths are cleared.
435
+ def after_process_attachment
436
+ if @saved_attachment
437
+ if respond_to?(:process_attachment_with_processing) && thumbnailable? && !attachment_options[:thumbnails].blank? && parent_id.nil?
438
+ temp_file = temp_path || create_temp_file
439
+ attachment_options[:thumbnails].each { |suffix, size| create_or_update_thumbnail(temp_file, suffix, *size) }
440
+ end
441
+ save_to_storage
442
+ @temp_paths.clear
443
+ @saved_attachment = nil
444
+ callback :after_attachment_saved
445
+ end
446
+ end
447
+
448
+ # Resizes the given processed img object with either the attachment resize options or the thumbnail resize options.
449
+ def resize_image_or_thumbnail!(img)
450
+ if (!respond_to?(:parent_id) || parent_id.nil?) && attachment_options[:resize_to] # parent image
451
+ resize_image(img, attachment_options[:resize_to])
452
+ elsif thumbnail_resize_options # thumbnail
453
+ resize_image(img, thumbnail_resize_options)
454
+ end
455
+ end
456
+
457
+ # Yanked from ActiveRecord::Callbacks, modified so I can pass args to the callbacks besides self.
458
+ # Only accept blocks, however
459
+ if ActiveSupport.const_defined?(:Callbacks)
460
+ # Rails 2.1 and beyond!
461
+ def callback_with_args(method, arg = self)
462
+ notify(method)
463
+
464
+ result = run_callbacks(method, { :object => arg }) { |result, object| result == false }
465
+
466
+ if result != false && respond_to_without_attributes?(method)
467
+ result = send(method)
468
+ end
469
+
470
+ result
471
+ end
472
+
473
+ def run_callbacks(kind, options = {}, &block)
474
+ options.reverse_merge!( :object => self )
475
+ self.class.send("#{kind}_callback_chain").run(options[:object], options, &block)
476
+ end
477
+ else
478
+ # Rails 2.0
479
+ def callback_with_args(method, arg = self)
480
+ notify(method)
481
+
482
+ result = nil
483
+ callbacks_for(method).each do |callback|
484
+ result = callback.call(self, arg)
485
+ return false if result == false
486
+ end
487
+ result
488
+ end
489
+ end
490
+
491
+ # Removes the thumbnails for the attachment, if it has any
492
+ def destroy_thumbnails
493
+ self.thumbnails.each { |thumbnail| thumbnail.destroy } if thumbnailable?
494
+ end
495
+ end
496
+ end
497
+ end