Fixing attachment_fu on Windows
Like many others, I've encountered issue when developing Rails applications using attachment_fu on Windows. After doing some research, I've come up with the following solution to the problem.The problem has two parts :
- Size is not included in the list error message,
- Timeout error when uploading to S3.
Fixing "Size is not included in the list" error message
Some people have reported that there is a timing issue, when trying to get the file size, with Tempfile on Windows. It seems that the size of the file is not properly reported by Windows after writing data to it. Proposed solutions for this problem include :- Sleeping in a loop as long as the file size is 0,
- Reading back the entire file in memory.
I think I found a better and less patchy solution for this issue: forcing the OS to flush the file to disk before reading it's size.
Here is the code to do it :
require 'tempfile'
class Tempfile
def size
if @tmpfile
@tmpfile.fsync # added this line
@tmpfile.flush
@tmpfile.stat.size
else@tmpfile.flush
@tmpfile.stat.size
0
endend
end
Doing a flush is not enough... flush will flush the Ruby buffer but the file may not be immediately written to the disk by the OS. Doing the fsync ensure that the file is written to disk by the OS before continuing. After that, Windows will properly report the actual file size.Fixing the Timeout error when uploading to S3
This issue is related to opening files for reading on Windows. On Windows, you have to open the file in binary mode. So patching attachment_fu is simple :require 'technoweenie/attachment_fu/backends/s3_backend'
module Technoweenie
module Technoweenie
module AttachmentFu
endmodule Backends
endmodule S3Backend
endprotected
def save_to_storage
enddef save_to_storage
if save_attachment?
@old_filename = nil
true
endS3Object.store(
endfull_filename,
(temp_path ? File.open(temp_path, "rb") : temp_data), # added , "rb"
bucket_name,
:content_type => content_type,
:access => attachment_options[:s3_access]
)(temp_path ? File.open(temp_path, "rb") : temp_data), # added , "rb"
bucket_name,
:content_type => content_type,
:access => attachment_options[:s3_access]
@old_filename = nil
true
I've also included a fix from someone else (which was not enough in itself to solve my S3 upload problem):
module Technoweenie
module AttachmentFu
end# Gets the data from the latest temp file. This will read the file into memory.
def temp_data
enddef temp_data
if save_attachment?
endf = File.new( temp_path )
f.binmode
return f.read
elsef.binmode
return f.read
return nil
endWrapping it up
So I put all this code in lib/attachment_fu_patch.rb and required it in environment.rb.Problem fixed!
Note, I did not test it on other OSes, but these fixes should not have any adverse effects.
20 comments:
This is a great fix to an issue I have been using sleep for.. Thanks!
You should submit this as a patch :)
patch is not working.
use
sleep(3) #sleep(5)
instead.
To Anonymous,
Maybe you can explain what did not work for you with this fix. What is your setup?
This fix has been working for me (and others).
The sleep(x) fix, will not always wor as it depends on the file size being downloaded. For really large size, you will have to sleep longer as Windows will take more time to empty its cache.
As I know this issue is only on Windows. Because my deploy env is linux and my development machine is Windows... how can I patch my Rails code to only affect development env?. Currently I have the patch on environment.rb file. I did the patch on development.rb but server crashes.
Thanks a lot.
you can put the require statement in :
if RUBY_PLATFORM =~ /mswin32/
# put the require here.
end
I'm having a similar problem using the April 2, 2007 version of attachment_fu on Rails 1.2.3 - does this patch require any adjustment for that environment? Also, where does the 'tempfile' library (as in `require 'tempfile'`) come from?
Got it working - turns out require won't work if you type the file name wrong :)
Wonderful. Thanks for saving me debugging time!!!
The temp_data method overwrites code need another module :
module Technoweenie
module AttachmentFu
module InstanceMethods
def temp_data
instead of
module Technoweenie
module AttachmentFu
def temp_data
Thanks a lot for this awesome fix
how do I recreate this problem, to submit a test case to ruby core?
Thanks!
-=R
Very nice, thanks for Tempfile fix! It's now working for me!
I did a bit of reading around the internet for "Size is not included in the list", saw a few different proposals, and your solution gets my vote. Well done!
You're great. It works after all.
Thank You.
for the super-newbs like myself, the syntax to add to environments.rb is:
....
Rails::Initializer.run do |config|
require 'attachment_fu_patch'
.....
sweet tutorial!
Great blog post. It was a lifesaver.
Great patch. It's such a generic fix that it should be included in the official release.
Post a Comment