murlsh 0.7.0 → 0.8.0

data/Rakefile

@@ -302,6 +302,7 @@ begin
       htmlentities 4.2.0
       json 1.2.3
       rack 1.0.0
+      rack-cache 0.5.2
       sqlite3-ruby 1.2.1
      }.each_slice(2) { |g,v| gemspec.add_dependency(g, ">= #{v}") }
 

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/config.ru

@@ -3,16 +3,29 @@ $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 %w{
 yaml
 
+rack/cache
+
 murlsh
 }.each { |m| require m }
 
+config = YAML.load_file('config.yaml')
+
 # use Rack::ShowExceptions
+use Rack::Cache,
+  :verbose => true,
+  :metastore => 'file:tmp/cache/rack/meta',
+  :entitystore => 'file:tmp/cache/rack/body'
 use Rack::ConditionalGet
 use Murlsh::EtagAddEncoding
 use Rack::Deflater
+use Murlsh::FarFutureExpires, :patterns => %r{\.gen\.(css|js)$}
+
+feed_path = URI.join(config.fetch('root_url'), config.fetch('feed_file')).path
+use Murlsh::MustRevalidate, :patterns => %r{^#{Regexp.escape(feed_path)}$}
+
 use Rack::Static, :urls => %w{/css /js /swf}, :root => 'public'
 use Rack::Static, :urls => %w{/atom.xml /rss.xml}
 
-config = YAML.load_file('config.yaml')
+# use Rack::Lint
 
 run Murlsh::Dispatch.new(config)

data/config.yaml

@@ -9,7 +9,6 @@ flickr_api_key:
 gravatar_size: 32
 js_files: 
 - js/jquery-1.4.2.min.js
-- js/jquery.cookie.js
 - js/jquery.jgrowl_compressed.js
 - js/js.js
 meta_tag_description: URLs found interesting by Matthew M. Boedicker

data/lib/murlsh/dispatch.rb

@@ -21,13 +21,15 @@ module Murlsh
 
       url_server = Murlsh::UrlServer.new(@config, db)
       flickr_server = Murlsh::FlickrServer.new(@config)
+      twitter_server = Murlsh::TwitterServer.new
 
       root_path = URI(@config.fetch('root_url')).path
 
       @dispatch = [
-        [/^GET #{root_path}(url)?$/, url_server.method(:get)],
-        [/^POST #{root_path}(url)?$/, url_server.method(:post)],
-        [/^GET \/flickr$/, flickr_server.method(:get)],
+        [%r{^GET #{root_path}(url)?$}, url_server.method(:get)],
+        [%r{^POST #{root_path}(url)?$}, url_server.method(:post)],
+        [%r{^GET /flickr$}, flickr_server.method(:get)],
+        [%r{^GET /twitter/.+$}, twitter_server.method(:get)],
       ]
     end
 

data/lib/murlsh/doc.rb

@@ -25,16 +25,28 @@ module Murlsh
     # Check a list of xpaths in order and return the inner html of the first
     # one that is not nil.
     def xpath_search(xpaths)
-      xpaths.each do |xpath|
+      [*xpaths].each do |xpath|
         selection = (self/xpath).first
-        return selection.inner_html unless selection.nil?
+        if selection; return (yield selection); end
       end
       nil
     end
 
     # Get the title of the document.
     def title
-      xpath_search(%w{//html/head/title //head/title //html/title //title})
+      xpath_search(%w{
+        //html/head/title
+        //head/title
+        //html/title
+        //title
+        }) { |node| node.inner_html }
+    end
+
+    # Get the meta description of the document.
+    def description
+      xpath_search(
+        "//html/head/meta[@name='description']"
+        ) { |node| node['content'] }
     end
 
   end

data/lib/murlsh/far_future_expires.rb

@@ -0,0 +1,37 @@
+%w{
+rack
+rack/utils
+}.each { |m| require m }
+
+module Murlsh
+
+  # Rack middleware to set a far future expires header for urls that match
+  # patterns.
+  class FarFutureExpires
+
+    def initialize(app, options={})
+      @app = app
+      @patterns = options[:patterns] ? [*options[:patterns]] : []
+      @future = options[:future] || 'Wed, 22 Jun 2019 20:07:00 GMT'
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      req = Rack::Request.new(env)
+
+      headers = Rack::Utils::HeaderHash.new(headers)
+
+      @patterns.each do |pattern|
+        if pattern.match(req.path)
+          headers['Expires'] = @future
+          break
+        end
+      end
+
+      [status, headers, body]
+    end
+
+  end
+
+end

data/lib/murlsh/flickr_server.rb

@@ -1,4 +1,5 @@
 %w{
+digest/sha1
 open-uri
 
 json
@@ -7,16 +8,15 @@ rack
 
 module Murlsh
 
-  # Proxy for Flickr rest API flickr.photos.getinfo call to support conditional
-  # get.
+  # Proxy for Flickr rest API to support conditional get and caching.
   #
   # Passes along query string with api key added, returns result from Flickr
-  # with content type set to application/json and last modified header set.
+  # with cache-control, etag and last-modified headers set.
   class FlickrServer
 
     def initialize(config); @config = config; end
 
-    # Proxy a flickr.photos.getinfo request to the Flickr rest API.
+    # Proxy a request to the Flickr API.
     def get(req)
       resp = Rack::Response.new
 
@@ -26,9 +26,6 @@ module Murlsh
         q = params.map { |k,v| "#{URI.encode(k)}=#{URI.encode(v)}" }.join('&')
 
         json_wrapped = open("http://api.flickr.com/services/rest/?#{q}") do |f|
-          # for some reason Firefox will not cache if it's text/plain, which is
-          # what Flickr returns
-          resp['Content-Type'] = 'application/json'
           f.read
         end
 
@@ -36,6 +33,9 @@ module Murlsh
 
         json_parsed = JSON.parse(json)
 
+        resp['Cache-Control'] = 'max-age=86400'
+        resp['Content-Type'] = 'application/json'
+        resp['ETag'] = "\"#{Digest::SHA1.hexdigest(json_wrapped)}\""
         resp['Last-Modified'] = Time.at(
           json_parsed['photo']['dates']['lastupdate'].to_i).httpdate
 

data/lib/murlsh/markup.rb

@@ -8,7 +8,7 @@ module Murlsh
     # Options:
     # * :prefix - prefix to append to all script urls
     def javascript(sources, options={})
-      sources.to_a.each do |src|
+      [*sources].each do |src|
         script('', :type => 'text/javascript',
           :src => "#{options[:prefix]}#{src}")
       end
@@ -49,7 +49,7 @@ module Murlsh
     # * :media - optional media attribute
     # * :prefix - prepended to all CSS urls
     def css(hrefs, options={})
-      hrefs.to_a.each do |href|
+      [*hrefs].each do |href|
         attrs = {
           :href => "#{options[:prefix]}#{href}",
           :rel => 'stylesheet',

data/lib/murlsh/must_revalidate.rb

@@ -0,0 +1,36 @@
+%w{
+rack
+rack/utils
+}.each { |m| require m }
+
+module Murlsh
+
+  # Rack middleware to force caches to always revalidate for urls that match
+  # patterns.
+  class MustRevalidate
+
+    def initialize(app, options={})
+      @app = app
+      @patterns = options[:patterns] ? [*options[:patterns]] : []
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      req = Rack::Request.new(env)
+
+      headers = Rack::Utils::HeaderHash.new(headers)
+
+      @patterns.each do |pattern|
+        if pattern.match(req.path)
+          headers['Cache-Control'] = 'must-revalidate, max-age=0'
+          break
+        end
+      end
+
+      [status, headers, body]
+    end
+
+  end
+
+end

data/lib/murlsh/twitter_server.rb

@@ -0,0 +1,44 @@
+%w{
+digest/sha1
+open-uri
+
+json
+rack
+}.each { |m| require m }
+
+module Murlsh
+
+  # Proxy for Twitter rest API to support conditional get and caching.
+  #
+  # Passes along path and query string, returns result from Twitter with
+  # cache-control, etag and last-modified headers set.
+  class TwitterServer
+
+    # Proxy a request to the Twitter API.
+    def get(req)
+      resp = Rack::Response.new
+
+      twitter_url = URI.join('http://api.twitter.com',
+        req.fullpath[/twitter\/(.+)/, 1])
+
+      json_wrapped = open(twitter_url) do |f|
+        resp['Content-Type'] = f.content_type
+        f.read
+      end
+
+      json = /.+?\((.+)\)/.match(json_wrapped)[1]
+
+      json_parsed = JSON.parse(json)
+
+      resp['Cache-Control'] = 'max-age=86400'
+      resp['ETag'] = "\"#{Digest::SHA1.hexdigest(json_wrapped)}\""
+      resp['Last-Modified'] = Time.parse(json_parsed['created_at']).httpdate
+
+      resp.body = json_wrapped
+
+      resp
+    end
+
+  end
+
+end

data/lib/murlsh/uri_ask.rb

@@ -41,26 +41,61 @@ module Murlsh
     # Get the HTML title.
     #
     # Options:
-    # * :failproof - if true hide all exceptions and return empty string on failure
+    # * :failproof - if true hide all exceptions and return url on failure
     # * :headers - hash of headers to send in request
     def title(options={})
       return @title if defined?(@title)
-      options[:headers] = default_headers.merge(options.fetch(:headers, {}))
 
       @title = to_s
-      if might_have_title?(options)
+
+      d = doc(options)
+
+      if d and d.title and !d.title.empty?
+        @title = decode(d.title)
+      end
+
+      @title
+    end
+ 
+    # Get the HTML meta description.
+    #
+    # Options:
+    # * :failproof - if true hide all exceptions and return empty string on failure
+    # * :headers - hash of headers to send in request
+    def description(options={})
+      return @description if defined?(@description)
+
+      @description = ''
+
+      d = doc(options)
+
+      if d and d.description and !d.description.empty?
+        @description = decode(d.description)
+      end
+
+      @description
+    end
+
+    # Get the parsed Hpricot doc at this url.
+    #
+    # Options:
+    # * :failproof - if true hide all exceptions and return empty string on failure
+    # * :headers - hash of headers to send in request
+    def doc(options={})
+      return @doc if defined?(@doc)
+      options[:headers] = default_headers.merge(options.fetch(:headers, {}))
+
+      @doc = nil
+      if html?(options)
         Murlsh::failproof(options) do
           self.open(options[:headers]) do |f|
-            doc = Hpricot(f).extend(Murlsh::Doc)
+            @doc = Hpricot(f).extend(Murlsh::Doc)
 
-            if doc.title and !doc.title.empty?
-              @title = HTMLEntities.new.decode(Iconv.conv('utf-8',
-                doc.charset || f.charset, doc.title))
-            end
+            @charset = @doc.charset || f.charset
           end
         end
       end
-      @title
+      @doc
     end
 
     # Default headers sent with the request.
@@ -76,12 +111,17 @@ module Murlsh
       result
     end
 
-    # Return true if the content type is likely to have a title that can be
-    # parsed.
-    def might_have_title?(options={})
+    # Return true if the content type is HTML.
+    def html?(options={})
       content_type(options)[/^text\/html/]
     end
 
+    # Convert from the character set of this url to utf-8 and decode HTML
+    # entities.
+    def decode(s)
+      HTMLEntities.new.decode(Iconv.conv('utf-8', @charset, s))
+    end
+
   end
 
 end

data/lib/murlsh/url_server.rb

@@ -23,8 +23,9 @@ module Murlsh
       resp.set_content_type(req.env['HTTP_ACCEPT'], req.env['HTTP_USER_AGENT'])
 
       last_db_update = File::Stat.new(@config['db_file']).mtime
-      resp['Last-Modified'] = last_db_update.httpdate
+      resp['Cache-Control'] = 'must-revalidate, max-age=0'
       resp['ETag'] = "W/\"#{last_db_update.to_i}#{req.params.sort}\""
+      resp['Last-Modified'] = last_db_update.httpdate
 
       resp.body = Murlsh::UrlBody.new(@config, @db, req)
 
@@ -57,11 +58,6 @@ module Murlsh
           resp = Rack::Response.new([mu].to_json, 200, {
             'Content-Type' => 'application/json' })
 
-          resp.set_cookie('auth',
-            :expires => Time.mktime(2015, 6, 22),
-            :path => '/',
-            :value => auth)
-
           resp
         else
           Rack::Response.new('Permission denied', 403, {

data/murlsh.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{murlsh}
-  s.version = "0.7.0"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew M. Boedicker"]
-  s.date = %q{2010-04-10}
+  s.date = %q{2010-04-25}
   s.default_executable = %q{murlsh}
   s.description = %q{url sharing site framework with easy adding, title lookup, atom feed, thumbnails and embedding}
   s.email = %q{matthewm@boedicker.org}
@@ -34,12 +34,15 @@ Gem::Specification.new do |s|
      "lib/murlsh/doc.rb",
      "lib/murlsh/etag_add_encoding.rb",
      "lib/murlsh/failproof.rb",
+     "lib/murlsh/far_future_expires.rb",
      "lib/murlsh/flickr_server.rb",
      "lib/murlsh/markup.rb",
+     "lib/murlsh/must_revalidate.rb",
      "lib/murlsh/openlock.rb",
      "lib/murlsh/plugin.rb",
      "lib/murlsh/sqlite3_adapter.rb",
      "lib/murlsh/time_ago.rb",
+     "lib/murlsh/twitter_server.rb",
      "lib/murlsh/uri.rb",
      "lib/murlsh/uri_ask.rb",
      "lib/murlsh/url.rb",
@@ -52,6 +55,7 @@ Gem::Specification.new do |s|
      "plugins/add_post_50_update_rss.rb",
      "plugins/add_post_60_notify_hubs.rb",
      "plugins/add_pre_50_lookup_content_type_title.rb",
+     "plugins/add_pre_60_github_title.rb",
      "plugins/hostrec_50_redundant.rb",
      "plugins/hostrec_60_skip.rb",
      "plugins/time_50_ago.rb",
@@ -59,7 +63,6 @@ Gem::Specification.new do |s|
      "public/css/jquery.jgrowl.css",
      "public/css/screen.css",
      "public/js/jquery-1.4.2.min.js",
-     "public/js/jquery.cookie.js",
      "public/js/jquery.jgrowl_compressed.js",
      "public/js/js.js",
      "public/swf/player_mp3_mini.swf",
@@ -104,6 +107,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<htmlentities>, [">= 4.2.0"])
       s.add_runtime_dependency(%q<json>, [">= 1.2.3"])
       s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
+      s.add_runtime_dependency(%q<rack-cache>, [">= 0.5.2"])
       s.add_runtime_dependency(%q<sqlite3-ruby>, [">= 1.2.1"])
     else
       s.add_dependency(%q<activerecord>, [">= 2.3.4"])
@@ -113,6 +117,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<htmlentities>, [">= 4.2.0"])
       s.add_dependency(%q<json>, [">= 1.2.3"])
       s.add_dependency(%q<rack>, [">= 1.0.0"])
+      s.add_dependency(%q<rack-cache>, [">= 0.5.2"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.1"])
     end
   else
@@ -123,6 +128,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<htmlentities>, [">= 4.2.0"])
     s.add_dependency(%q<json>, [">= 1.2.3"])
     s.add_dependency(%q<rack>, [">= 1.0.0"])
+    s.add_dependency(%q<rack-cache>, [">= 0.5.2"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.1"])
   end
 end

data/plugins/add_pre_60_github_title.rb

@@ -0,0 +1,22 @@
+%w{
+murlsh
+}.each { |m| require m }
+
+module Murlsh
+
+  # Github project page titles are not very descriptive so add meta description
+  # to title.
+  class AddPre60GithubTitle < Plugin
+
+    Hook = 'add_pre'
+
+    def self.run(url, config)
+      if url.url[%r{http://github.com/\w+/\w+}]
+        ask = URI(url.url).extend(Murlsh::UriAsk)
+        url.title << " - #{ask.description}" unless ask.description.empty?
+      end
+    end
+
+  end
+
+end

data/public/js/js.js

@@ -170,7 +170,7 @@ Murlsh.hrefRes = {
     s3 :
         /^(http:\/\/static\.mmb\.s3\.amazonaws\.com\/[\w\-]+\.)(jpe?g|gif|pdf|png)$/i,
     twitter :
-        /^http:\/\/twitter\.com\/\w+\/statuses\/(\d+)$/i,
+        /^http:\/\/twitter\.com\/\w+\/status(?:es)?\/(\d+)$/i,
     vimeo :
         /^http:\/\/(?:www\.)?vimeo\.com\/(\d+)$/i,
     youtube :
@@ -236,8 +236,9 @@ Murlsh.addExtra = function() {
         }
     } else if (match.twitter) {
         $.ajax({
-            url : 'http://api.twitter.com/1/statuses/show/' + match.twitter[1] +
-                '.json',
+            // url : 'http://api.twitter.com/1/statuses/show/' +
+            url : '/twitter/1/statuses/show/' +
+                match.twitter[1] + '.json',
             dataType : 'jsonp',
             success : function(d) {
                 var nameLink = $('<a />', {
@@ -254,7 +255,8 @@ Murlsh.addExtra = function() {
                         width : '48'
                     }), null, nameLink);
             },
-            context : $(this)
+            context : $(this),
+            jsonpCallback : 'twitterCallback' + match.twitter[1]
         });
     } else if (match.vimeo) {
         $.ajax({
@@ -318,6 +320,10 @@ Murlsh.iphoneInit = function() {
         href : '#bottom',
         text : 'bottom'
     }));
+
+    // change input types to html5 to make typing easier
+    $('#q').attr('type', 'search');
+    $('#url,#via').attr('type', 'url');
 };
 
 $(document).ready(function() {
@@ -342,7 +348,4 @@ $(document).ready(function() {
         }, 'json');
     });
 
-    if ($.cookie('auth')) {
-        $('#auth').val($.cookie('auth'));
-    }
 });

data/spec/doc_spec.rb

@@ -8,10 +8,13 @@ murlsh
 
 describe Murlsh::Doc do
 
-  it 'should get the right title from an HTML page that has one' do
-    html = <<eos
+  context 'when html has everything' do
+    subject do
+      html = <<eos
 <html>
   <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <meta name="description" content="the description" />
     <title>the title</title>
   </head>
 <body>
@@ -19,9 +22,31 @@ describe Murlsh::Doc do
 </body>
 </html>
 eos
+      Hpricot(html).extend(Murlsh::Doc)
+    end
 
-    doc = Hpricot(html).extend(Murlsh::Doc)
-    doc.title.should == 'the title'
+    its(:charset) { should == 'utf-8' }
+    its(:title) { should == 'the title' }
+    its(:description) { should == 'the description' }
+  end
+
+  context 'when html has nothing' do
+    subject do
+      html = <<eos
+<html>
+  <head>
+  </head>
+<body>
+  <h1>hi</h1>
+</body>
+</html>
+eos
+      Hpricot(html).extend(Murlsh::Doc)
+    end
+
+    its(:charset) { should be_nil }
+    its(:title) { should be_nil }
+    its(:description) { should be_nil }
   end
 
 end

data/spec/yaml_ordered_hash_spec.rb

@@ -6,7 +6,7 @@ murlsh
 
 describe Murlsh::YamlOrderedHash do
 
-  it 'should generate yaml with hash keys in sorted order' do
+  subject do
     h = {
       'd' => 4,
       'a' => 1,
@@ -15,14 +15,15 @@ describe Murlsh::YamlOrderedHash do
       }
 
     h.extend(Murlsh::YamlOrderedHash)
-
-    h.to_yaml.should == <<EOS
+  end
+  
+  its(:to_yaml) { should == <<EOS
 --- 
 a: 1
 b: 2
 c: 3
 d: 4
 EOS
-  end
+  }
 
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Matthew M. Boedicker
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 -04:00
+date: 2010-04-25 00:00:00 -04:00
 default_executable: murlsh
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -116,9 +116,23 @@ dependencies:
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
+  name: rack-cache
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -128,7 +142,7 @@ dependencies:
         - 1
         version: 1.2.1
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id009
 description: url sharing site framework with easy adding, title lookup, atom feed, thumbnails and embedding
 email: matthewm@boedicker.org
 executables: 
@@ -154,12 +168,15 @@ files:
 - lib/murlsh/doc.rb
 - lib/murlsh/etag_add_encoding.rb
 - lib/murlsh/failproof.rb
+- lib/murlsh/far_future_expires.rb
 - lib/murlsh/flickr_server.rb
 - lib/murlsh/markup.rb
+- lib/murlsh/must_revalidate.rb
 - lib/murlsh/openlock.rb
 - lib/murlsh/plugin.rb
 - lib/murlsh/sqlite3_adapter.rb
 - lib/murlsh/time_ago.rb
+- lib/murlsh/twitter_server.rb
 - lib/murlsh/uri.rb
 - lib/murlsh/uri_ask.rb
 - lib/murlsh/url.rb
@@ -172,6 +189,7 @@ files:
 - plugins/add_post_50_update_rss.rb
 - plugins/add_post_60_notify_hubs.rb
 - plugins/add_pre_50_lookup_content_type_title.rb
+- plugins/add_pre_60_github_title.rb
 - plugins/hostrec_50_redundant.rb
 - plugins/hostrec_60_skip.rb
 - plugins/time_50_ago.rb
@@ -179,7 +197,6 @@ files:
 - public/css/jquery.jgrowl.css
 - public/css/screen.css
 - public/js/jquery-1.4.2.min.js
-- public/js/jquery.cookie.js
 - public/js/jquery.jgrowl_compressed.js
 - public/js/js.js
 - public/swf/player_mp3_mini.swf

data/public/js/jquery.cookie.js

@@ -1,96 +0,0 @@
-/**
- * Cookie plugin
- *
- * Copyright (c) 2006 Klaus Hartl (stilbuero.de)
- * Dual licensed under the MIT and GPL licenses:
- * http://www.opensource.org/licenses/mit-license.php
- * http://www.gnu.org/licenses/gpl.html
- *
- */
-
-/**
- * Create a cookie with the given name and value and other optional parameters.
- *
- * @example $.cookie('the_cookie', 'the_value');
- * @desc Set the value of a cookie.
- * @example $.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });
- * @desc Create a cookie with all available options.
- * @example $.cookie('the_cookie', 'the_value');
- * @desc Create a session cookie.
- * @example $.cookie('the_cookie', null);
- * @desc Delete a cookie by passing null as value. Keep in mind that you have to use the same path and domain
- *       used when the cookie was set.
- *
- * @param String name The name of the cookie.
- * @param String value The value of the cookie.
- * @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
- * @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
- *                             If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
- *                             If set to null or omitted, the cookie will be a session cookie and will not be retained
- *                             when the the browser exits.
- * @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
- * @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
- * @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
- *                        require a secure protocol (like HTTPS).
- * @type undefined
- *
- * @name $.cookie
- * @cat Plugins/Cookie
- * @author Klaus Hartl/klaus.hartl@stilbuero.de
- */
-
-/**
- * Get the value of a cookie with the given name.
- *
- * @example $.cookie('the_cookie');
- * @desc Get the value of a cookie.
- *
- * @param String name The name of the cookie.
- * @return The value of the cookie.
- * @type String
- *
- * @name $.cookie
- * @cat Plugins/Cookie
- * @author Klaus Hartl/klaus.hartl@stilbuero.de
- */
-jQuery.cookie = function(name, value, options) {
-    if (typeof value != 'undefined') { // name and value given, set cookie
-        options = options || {};
-        if (value === null) {
-            value = '';
-            options.expires = -1;
-        }
-        var expires = '';
-        if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {
-            var date;
-            if (typeof options.expires == 'number') {
-                date = new Date();
-                date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));
-            } else {
-                date = options.expires;
-            }
-            expires = '; expires=' + date.toUTCString(); // use expires attribute, max-age is not supported by IE
-        }
-        // CAUTION: Needed to parenthesize options.path and options.domain
-        // in the following expressions, otherwise they evaluate to undefined
-        // in the packed version for some reason...
-        var path = options.path ? '; path=' + (options.path) : '';
-        var domain = options.domain ? '; domain=' + (options.domain) : '';
-        var secure = options.secure ? '; secure' : '';
-        document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join('');
-    } else { // only name given, get cookie
-        var cookieValue = null;
-        if (document.cookie && document.cookie != '') {
-            var cookies = document.cookie.split(';');
-            for (var i = 0; i < cookies.length; i++) {
-                var cookie = jQuery.trim(cookies[i]);
-                // Does this cookie string begin with the name we want?
-                if (cookie.substring(0, name.length + 1) == (name + '=')) {
-                    cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
-                    break;
-                }
-            }
-        }
-        return cookieValue;
-    }
-};