Module that is mixed in to all implemented controllers.
Escapes the string representation of obj and escapes it for use in XML.
obj<~to_s> |
The object to escape for use in XML. |
The escaped object. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 341 def escape_xml(obj) Merb::Parse.escape_xml(obj.to_s) end
Retreives the redirect message either locally or from the request.
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 161 def message @_message = defined?(@_message) ? @_message : request.message end
Uses the nginx specific X-Accel-Redirect header to send a file directly from nginx.
Unless Content-Disposition is set before calling this method, it is set to attachment with streamed file name.
For more information, see the nginx wiki: wiki.codemongers.com/NginxXSendfile
and the following sample gist: gist.github.com/11225
there's also example application up on GitHub:
github.com/michaelklishin/nginx-x-accel-redirect-example-application/tree/master
path<String> |
Path to file to send to the client. |
content_type<String> |
content type header value. By default is set to empty string to let Nginx detect it. |
precisely a single space. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 294 def nginx_send_file(path, content_type = "") # Let Nginx detect content type unless it is explicitly set headers['Content-Type'] = content_type headers["Content-Disposition"] ||= "attachment; filename=#{path.split('/').last}" headers['X-Accel-Redirect'] = path return ' ' end
url<String> |
URL to redirect to. It can be either a relative or fully-qualified URL. |
opts<Hash> |
An options hash (see below) |
:message<Hash> |
Messages to pass in url query string as value for "_message" |
:permanent<Boolean> |
When true, return status 301 Moved Permanently |
:notice<String> |
Shorthand for common usage :message => {:notice => "..."} |
:error<String> |
Shorthand for common usage :message => {:error => "..."} |
:success<String> |
Shorthand for common usage :message => {:success => "..."} |
:status<String, Symbol> |
Status code to set for the response. Can be any valid redirect status. Has precedence over the :permanent parameter, which is retained for convenience. |
Explanation of redirect. |
redirect("/posts/34") redirect("/posts/34", :message => { :notice => 'Post updated successfully!' }) redirect("http://www.merbivore.com/") redirect("http://www.merbivore.com/", :permanent => true) redirect("/posts/34", :notice => 'Post updated successfully!')
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 143 def redirect(url, opts = {}) default_redirect_options = { :message => nil, :permanent => false } opts = default_redirect_options.merge(opts) url = handle_redirect_messages(url,opts) _status = opts[:status] if opts[:status] _status ||= opts[:permanent] ? 301 : 302 self.status = _status Merb.logger.info("Redirecting to: #{url} (#{self.status})") headers['Location'] = url "<html><body>You are being <a href=\"#{url}\">redirected</a>.</body></html>" end
Renders the block given as a parameter using chunked encoding.
&blk |
A block that, when called, will use send_chunks to send chunks of data down to the server. The chunking will terminate once the block returns. |
def stream prefix = '<p>' suffix = "</p>\r\n" render_chunked do IO.popen("cat /tmp/test.log") do |io| done = false until done sleep 0.3 line = io.gets.chomp if line == 'EOF' done = true else send_chunk(prefix + line + suffix) end end end end end
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 50 def render_chunked(&blk) must_support_streaming! headers['Transfer-Encoding'] = 'chunked' Proc.new { |response| @response = response response.send_status_no_connection_close('') response.send_header blk.call response.write("0\r\n\r\n") } end
&blk |
A proc that should get called outside the mutex, and which will return the value to render. |
Proc |
A block that the server can call later, allowing Merb to release the thread lock and render another request. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 86 def render_deferred(&blk) Proc.new do |response| response.write(blk.call) end end
Renders the passed in string, then calls the block outside the mutex and after the string has been returned to the client.
str<String> |
A String to return to the client. |
&blk |
A block that should get called once the string has been returned. |
Proc |
A block that Mongrel can call after returning the string to the user. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 104 def render_then_call(str, &blk) Proc.new do |response| response.write(str) blk.call end end
Enqueu a block to run in a background thread outside of the request response dispatch
&blk |
proc to run later |
run_later do
SomeBackgroundTask.run
end
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 17 def run_later(&blk) Merb.run_later(&blk) end
Writes a chunk from render_chunked to the response that is sent back to the client. This should only be called within a render_chunked block.
data<String> |
a chunk of data to return. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 69 def send_chunk(data) only_runs_on_mongrel! @response.write('%x' % data.size + "\r\n") @response.write(data + "\r\n") end
Send binary data over HTTP to the user as a file download. May set content type, apparent file name, and specify whether to show data inline or download as an attachment.
data<String> |
Path to file to send to the client. |
opts<Hash> |
Options for sending the data (see below). |
:disposition<String> |
The disposition of the file send. Defaults to "attachment". |
:filename<String> |
The name to use for the file. Defaults to the filename of file. |
:type<String> |
The content type. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 216 def send_data(data, opts={}) opts.update(Merb::Const::DEFAULT_SEND_FILE_OPTIONS.merge(opts)) disposition = opts[:disposition].dup || 'attachment' disposition << %(; filename="#{opts[:filename]}") if opts[:filename] headers.update( 'Content-Type' => opts[:type].strip, # fixes a problem with extra '\r' with some browsers 'Content-Disposition' => disposition, 'Content-Transfer-Encoding' => 'binary' ) data end
Sends a file over HTTP. When given a path to a file, it will set the right headers so that the static file is served directly.
file<String> |
Path to file to send to the client. |
opts<Hash> |
Options for sending the file (see below). |
:disposition<String> |
The disposition of the file send. Defaults to "attachment". |
:filename<String> |
The name to use for the file. Defaults to the filename of file. |
:type<String> |
The content type. |
IO |
An I/O stream for the file. |
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 183 def send_file(file, opts={}) opts.update(Merb::Const::DEFAULT_SEND_FILE_OPTIONS.merge(opts)) disposition = opts[:disposition].dup || 'attachment' disposition << %(; filename="#{opts[:filename] ? opts[:filename] : File.basename(file)}") headers.update( 'Content-Type' => opts[:type].strip, # fixes a problem with extra '\r' with some browsers 'Content-Disposition' => disposition, 'Content-Transfer-Encoding' => 'binary' ) Proc.new do |response| file = File.open(file, 'rb') while chunk = file.read(16384) response.write chunk end file.close end end
Streams a file over HTTP.
opts<Hash> |
Options for the file streaming (see below). |
&stream |
A block that, when called, will return an object that responds to get_lines for streaming. |
:disposition<String> |
The disposition of the file send. Defaults to "attachment". |
:type<String> |
The content type. |
:content_length<Numeric> |
The length of the content to send. |
:filename<String> |
The name to use for the streamed file. |
stream_file({ :filename => file_name, :type => content_type, :content_length => content_length }) do |response| AWS::S3::S3Object.stream(user.folder_name + "-" + user_file.unique_id, bucket_name) do |chunk| response.write chunk end end
:api: public
# File lib/merb-core/controller/mixins/controller.rb, line 252 def stream_file(opts={}, &stream) opts.update(Merb::Const::DEFAULT_SEND_FILE_OPTIONS.merge(opts)) disposition = opts[:disposition].dup || 'attachment' disposition << %(; filename="#{opts[:filename]}") headers.update( 'Content-Type' => opts[:type].strip, # fixes a problem with extra '\r' with some browsers 'Content-Disposition' => disposition, 'Content-Transfer-Encoding' => 'binary', # Rack specification requires header values to respond to :each 'CONTENT-LENGTH' => opts[:content_length].to_s ) Proc.new do |response| stream.call(response) end end
Generated with the Darkfish Rdoc Generator 2.