Class: Utopia::Static

Inherits:

Object

• Object
• Utopia::Static

Defined in:

lib/utopia/static.rb

Overview

Serve static files and include recursive name resolution using @rel@ directory entries.

Defined Under Namespace

Classes: LocalFile

Constant Summary

MIME_TYPES =

{
	:xiph => {
		"ogx" => "application/ogg",
		"ogv" => "video/ogg",
		"oga" => "audio/ogg",
		"ogg" => "audio/ogg",
		"spx" => "audio/ogg",
		"flac" => "audio/flac",
		"anx" => "application/annodex",
		"axa" => "audio/annodex",
		"xspf" => "application/xspf+xml",
	},
	:media => [
		:xiph, "mp3", "mp4", "wav", "aiff", ["aac", "audio/x-aac"], "mov", "avi", "wmv", "mpg"
	],
	:text => [
		"html", "css", "js", ["map", "application/json"], "txt", "rtf", "xml", "pdf"
	],
	:fonts => [
		"otf", ["eot", "application/vnd.ms-fontobject"], "ttf", "woff"
	],
	:archive => [
		"zip", "tar", "tgz", "tar.gz", "tar.bz2", ["dmg", "application/x-apple-diskimage"],
		["torrent", "application/x-bittorrent"]
	],
	:images => [
		"png", "gif", "jpeg", "tiff", "svg"
	],
	:default => [
		:media, :text, :archive, :images, :fonts
	]
}

Instance Attribute Summary

• #extensions ⇒ Object readonly

  Returns the value of attribute extensions.

Instance Method Summary

• #call(env) ⇒ Object
• #fetch_file(path) ⇒ Object
• #freeze ⇒ Object
• #initialize(app, **options) ⇒ Static constructor

  A new instance of Static.

Constructor Details

#initialize(app, **options) ⇒ Static

Returns a new instance of Static.

# File 'lib/utopia/static.rb', line 198

def initialize(app, **options)
	@app = app
	@root = (options[:root] || Utopia::default_root).freeze

	if options[:types]
		@extensions = load_mime_types(options[:types])
	else
		@extensions = load_mime_types(MIME_TYPES[:default])
	end

	@cache_control = (options[:cache_control] || "public, max-age=3600")
	
	self.freeze
end

Instance Attribute Details

#extensions ⇒ Object (readonly)

Returns the value of attribute extensions.

# File 'lib/utopia/static.rb', line 232

def extensions
  @extensions
end

Instance Method Details

#call(env) ⇒ Object

# File 'lib/utopia/static.rb', line 234

def call(env)
	path_info = env[Rack::PATH_INFO]
	extension = File.extname(path_info)

	if @extensions.key? extension.downcase
		path = Path[path_info].simplify
		
		if locale = env[Localization::CURRENT_LOCALE_KEY]
			path.last.insert(path.last.rindex('.') || -1, ".#{locale}")
		end
		
		if file = fetch_file(path)
			response_headers = {
				"Last-Modified" => file.mtime_date,
				"Content-Type" => @extensions[extension],
				"Cache-Control" => @cache_control,
				"ETag" => file.etag,
				"Accept-Ranges" => "bytes"
			}

			if file.modified?(env)
				return file.serve(env, response_headers)
			else
				return [304, response_headers, []]
			end
		end
	end

	# else if no file was found:
	return @app.call(env)
end

#fetch_file(path) ⇒ Object

# File 'lib/utopia/static.rb', line 221

def fetch_file(path)
	# We need file_path to be an absolute path for X-Sendfile to work correctly.
	file_path = File.join(@root, path.components)
	
	if File.exist?(file_path)
		return LocalFile.new(@root, path)
	else
		return nil
	end
end

#freeze ⇒ Object

# File 'lib/utopia/static.rb', line 213

def freeze
	@root.freeze
	@extensions.freeze
	@cache_control.freeze
	
	super
end