upr 0.1.0 → 0.2.0

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v0.1.0.GIT
+DEF_VER=v0.2.0.GIT
 
 LF='
 '

data/GNUmakefile

@@ -55,7 +55,7 @@ NEWS: GIT-VERSION-FILE
 	$(rake) -s news_rdoc > $@+
 	mv $@+ $@
 
-SINCE =
+SINCE = 0.1.0
 ChangeLog: log_range = $(shell test -n "$(SINCE)" && echo v$(SINCE)..)
 ChangeLog: GIT-VERSION-FILE
 	@echo "ChangeLog from $(GIT_URL) ($(SINCE)..$(GIT_VERSION))" > $@+

data/LICENSE

@@ -1,8 +1,13 @@
 Upload Progress for Rack (upr) is copyrighted Free Software by all
-contributors, see the logs in revision control for all of them.  You can
-redistribute it and/or modify it under either the terms of the
-{GPL2}[http://www.gnu.org/licenses/gpl-2.0.txt] (see link:COPYING) or
-the conditions below:
+contributors, see the logs in revision control for all of them.
+
+Bundled examples in the examples/ directory retain their respective
+(Free Software) licenses.  See copyright headers in individual files for
+more information.  This distribution only includes Free Software.
+
+You can redistribute upr it and/or modify it under either the terms of
+the {GPL2}[http://www.gnu.org/licenses/gpl-2.0.txt] (see link:COPYING)
+or the conditions below:
 
   1. You may make and give away verbatim copies of the source form of the
      software without restriction, provided that you duplicate all of the

data/README

@@ -1,15 +1,17 @@
 = upr - Upload Progress for Rack
 
 upr is Rack middleware that allows browser-side upload progress
-monitoring.  It is based on the "mongrel_upload_progress" module, but
-allows any Moneta-backing store in additon to DRb.  There is also a
-packaged example for using an ActiveRecord model for Rails.
+monitoring.  It is based on (and should be client-side compatible with)
+several upload progress modules including ones used by leading web
+servers.  It allows any Moneta backing store in addition to DRb.  There
+is also a packaged example for using an ActiveRecord model for Rails.
 
 == Demo
 
-You can see upr it in action at http://upr-demo.bogomips.org/
-It will report the size and SHA1 of the file you've uploaded.
-Much of the demo was stolen from mongrel_upload_progress.
+You can see upr in action at http://upr-demo.bogomips.org/  It will
+report the size and SHA1 of the file you've uploaded.  Much of the demo
+was stolen from all the existing upload progress examples for other web
+servers.
 
 == Web Server Compatibility
 
@@ -25,14 +27,27 @@ handful of concurrency models:
 For use with Revactor, the use of network-based Moneta stores or DRb is
 only advised if those stores are using Revactor-aware sockets.
 
-== JavaScript/HTML Compatibility
+== JavaScript/CSS/HTML Compatibility
 
-The current developer does not react well with GUIs.  Thus all (R)HTML
-and Prototype JavaScript code was stolen from mongrel_upload_progress.
+The current developer does not react well with GUIs.  Thus all (R)HTML,
+JavaScript and CSS example code was stolen from one of the following:
 
-Contributions to add compatibility for more modern things like JQuery
-and HTML5 are very welcome.
+1. mongrel_upload_progress
+   http://mongrel.rubyforge.org/wiki/UploadProgress
+2. jquery-upload-progress
+   http://github.com/drogus/jquery-upload-progress
+3. mongrel_streaming_upload_progress
+   http://rubyforge.org/pipermail/mongrel-users/2007-July/003747.html
 
+This means our module should also be compatible with any of these
+interfaces.
+
+Contributions to enhance compatibility for more modern things like
+jQuery and HTML5 are very welcome.  We would prefer as much as possible
+to NOT proliferate new AJAX sub-protocols and use existing ones whenever
+possible.  Our current favorite is the Ajax.Pull JavaScript used in
+Ry Dahl's mongrel_streaming_upload_progress because it only requires a
+one extra HTTP request to pull all the status notifications.
 
 == Backend Compatibility
 
@@ -84,7 +99,8 @@ and we'll try our best to fix it.
 
 upr is copyright 2009 by all contributors (see logs in git).  It is
 based on mongrel_upload_progress and carries the same license (Ruby +
-GPL2).  See the included LICENSE file for details.
+GPL2).  Bundled examples may different Free Software licenses, see the
+included LICENSE file for details.
 
 upr is 100% Free Software.  We will never support the proliferation of
 non-Free browsers or plugins.
@@ -99,7 +115,7 @@ To subscribe or post to the mailing list, just send an email to
 upr@librelist.com and follow the instructions in the automated reply.
 
 * email: mailto:upr@librelist.com
-* git: git://git.bogomips.org/upr.git
+* git: git://git.bogomips.org/upr.git or git://repo.or.cz/upr.git
 * cgit: http://git.bogomips.org/cgit/upr.git
 
 We will adhere to mostly the same conventions for patch submissions as

data/examples/rails_app-2.3.4/app/controllers/application_controller.rb

@@ -1,3 +1,10 @@
 class ApplicationController < ActionController::Base
-  helper :all # include all helpers, all the time
+  # helper :all # include all helpers, all the time
+  defined?($upr) or before_filter do
+    # grab the backend in case we forget to set it (or if we're using DRb)
+    defined?($upr) or ObjectSpace.each_object(Upr::InputWrapper) do |x|
+      $upr ||= x.backend
+    end
+  end
+
 end

data/examples/rails_app-2.3.4/app/controllers/files_controller.rb

@@ -1,21 +1,27 @@
 require 'digest/sha1'
 
 class FilesController < ApplicationController
-  defined?($upr) or before_filter do
-    # grab the backend in case we forget to set it (or if we're using DRb)
-    defined?($upr) or ObjectSpace.each_object(Upr::InputWrapper) do |x|
-      $upr ||= x.backend
-    end
+  # used by jQuery streaming upload progress
+  def new
+    _sha1_flash_self
+  end
+
+  # based on Ry Dahl's streaming AJAX pull:
+  # http://rubyforge.org/pipermail/mongrel-users/2007-July/003747.html
+  def pull
+    _sha1_flash_self
   end
 
   def index
   end
 
+  # used by mup-compatible upload progress
   def status
     tmp = $upr.read(params[:upload_id]).inspect
     render :text => "#{Rack::Utils.escape_html(tmp)}\n"
   end
 
+  # used by mup-compatible upload progress
   def progress
     render :update do |page|
       status = $upr.read(params[:upload_id]) and
@@ -23,19 +29,36 @@ class FilesController < ApplicationController
     end
   end
 
+  # used by mup-compatible upload progress
   def upload
-    file = params[:data]
+    size, hexdigest = _read_sha1_size
+    render :text => "sha1: #{hexdigest}<br />" \
+                    "size: #{size}<br />" \
+                    '<script type="text/javascript">' \
+                    'window.parent.UploadProgress.finish();</script>'
+  end
+
+private
+
+  def _read_sha1_size
+    file = params[:data] or return [ -1, :unknown ]
+    File.unlink(file.path) if file.respond_to?(:path)
     digest = Digest::SHA1.new
     if buf = file.read(16384)
       begin
         digest.update(buf)
       end while file.read(16384, buf)
     end
-    size = file.stat.size
-    File.unlink(file.path)
-    render :text => "sha1: #{digest.hexdigest}<br />" \
-                    "size: #{size}<br />" \
-                    '<script type="text/javascript">' \
-                    'window.parent.UploadProgress.finish();</script>'
+    [ file.size, digest.hexdigest ]
   end
+
+  def _sha1_flash_self
+    if request.post?
+      size, hexdigest = _read_sha1_size
+      msg = "Successfully upload file (size: #{size}, sha1: #{hexdigest})"
+      flash[:notice] = msg
+      redirect_to :action => params[:action]
+    end
+  end
+
 end

data/examples/rails_app-2.3.4/app/controllers/progress_controller.rb

@@ -0,0 +1,11 @@
+class ProgressController < ApplicationController
+  def index
+    opt = {
+      :backend => $upr,
+      :frequency => 0.5,
+      :env => request.env,
+    }
+    response.headers.update(Upr::JSON::RESPONSE_HEADERS)
+    render(Upr::JSON.new(opt).rails_render_options)
+  end
+end

data/examples/rails_app-2.3.4/app/models/upr_status.rb

@@ -1,14 +1,8 @@
 class UprStatus < ActiveRecord::Base
-  cattr_accessor :gc_cutoff
-  @@gc_cutoff = 10
 
   class << self
     def read(upid)
-      if rv = find_by_upid(upid)
-        rv.time = Time.now.to_i
-        rv.save
-        rv
-      end
+      find_by_upid(upid)
     end
 
     def start(upid, length)
@@ -22,14 +16,44 @@ class UprStatus < ActiveRecord::Base
     end
 
     def incr(upid, nr)
-      update_all("seen = seen + #{nr.to_i}, time = #{Time.now.to_i}",
-                 { :upid => upid })
+      transaction do
+        if rv = find_by_upid(upid)
+          rv.time = Time.now.to_i
+          rv.seen += nr if rv.seen >= 0
+          rv.save
+          rv
+        end
+      end
+    end
+
+    def error!(upid)
+      transaction do
+        if rv = find_by_upid(upid)
+          rv.time = Time.now.to_i
+          rv.seen = -1
+          rv.save
+          rv
+        end
+      end
+    end
+
+    def finish(upid)
+      transaction do
+        if rv = find_by_upid(upid)
+          rv.time = Time.now.to_i
+          rv.length ||= rv.seen
+          rv.seen = rv.length
+          rv.save
+          rv
+        end
+      end
     end
 
     def gc
-      cutoff = Time.now.to_i - @@gc_cutoff
+      cutoff = Time.now.to_i - Upr::Monitor::OPT[:expires_in]
       delete_all "time < #{cutoff}"
     end
   end
 
+  include Upr::StatusMethods
 end

data/examples/rails_app-2.3.4/app/views/files/index.html.erb

@@ -2,7 +2,8 @@
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
     <title>upr test, http://upr.bogomips.org/</title>
-    <%= javascript_include_tag :all %>
+    <%= javascript_include_tag :defaults %>
+    <%= javascript_include_tag 'upr' %>
 <style type="text/css">
 #progress-bar {
   width:500px;
@@ -42,9 +43,18 @@ opt = {
 }
 -%>
 <p>
-This is a demo of <a href="http://upr.bogomips.org/">upr</a> in action.
-Much of this (including all JS) was stolen from the mongrel_upload_progress
-examples.
+  This is a demo of <a href="http://upr.bogomips.org/">upr</a> in action.
+  Much of this (including all JS) was stolen from the mongrel_upload_progress
+  examples.
+</p>
+<p>
+  Also, see the <a href="/files/new">jQuery-compatible interface</a>
+  that's also compatible with upload progress modules for nginx and lighttpd.
+</p>
+<p>
+  Last but not least, check out the <a href="/files/pull">Ajax.Pull</a>
+  example that uses a single, streaming HTTP response to interatively
+  send progress updates.
 </p>
 <p><%= link_to upid, :action => 'status', :upload_id => upid %></p>
 <% form_tag(act, opt) do %>

data/examples/rails_app-2.3.4/app/views/files/new.html.erb

@@ -0,0 +1,71 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!-- example taken from git://github.com/drogus/jquery-upload-progress -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<title>ajaxFileUpload</title>
+	    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+		<script src="/javascripts/jquery.js"></script>
+		<script src="/javascripts/jquery.uploadProgress.js"></script>
+		<script type="text/javascript">
+			$(function() {
+				$('form').uploadProgress({
+					/* scripts locations for safari */
+					jqueryPath: "/javascripts/jquery.js",
+					uploadProgressPath: "/javascripts/jquery.uploadProgress.js",
+					start:function(){},
+					uploading: function(upload) {$('#percents').html(upload.percents+'%');},
+					interval: 500
+			    });
+			});
+		</script>
+		<style type="text/css">
+			.bar {
+			  width: 300px;
+			}
+
+			#progress {
+			  background: #eee;
+			  border: 1px solid #222;
+			  margin-top: 20px;
+			}
+			#progressbar {
+			  width: 0px;
+			  height: 24px;
+			  background: #333;
+			}
+		</style>
+	</head>
+
+	<body>
+    <% if flash[:notice] %>
+    <h1><%= flash[:notice] %></h1>
+    <% end %>
+<p>
+  This is a demo of <a href="http://upr.bogomips.org/">upr</a> in action.
+  Much of this (including all JS) was stolen from the
+  <a href="http://github.com/drogus/jquery-upload-progress"
+  >jQuery-upload-progress</a>
+</p>
+<p>
+  Also, see the <a href="/">mongrel_upload_progress-compatible</a> version
+</p>
+<p>
+  Last but not least, check out the <a href="/files/pull">Ajax.Pull</a>
+  example that uses a single, streaming HTTP response to interatively
+  send progress updates.
+</p>
+
+	  <form id="upload" enctype="multipart/form-data" action="/files/new" method="post">
+        <input name="data" type="file"/>
+        <input type="submit" value="Upload"/>
+      </form>
+
+	    <div id="uploading">
+	      <div id="progress" class="bar">
+	        <div id="progressbar">&nbsp;</div>
+	      </div>
+	    </div>
+		<div id="percents"></div>
+	</body>
+</html>

data/examples/rails_app-2.3.4/app/views/files/pull.html.erb

@@ -0,0 +1,60 @@
+<html>
+  <head>
+<!-- http://rubyforge.org/pipermail/mongrel-users/2007-July/003747.html -->
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <title>streaming upload progress test</title>
+    <%= javascript_include_tag 'ajax_pull/prototype-1_5_1.js' %>
+    <%= javascript_include_tag 'ajax_pull/ajax_pull.js' %>
+    <%= javascript_include_tag 'ajax_pull/upload_progress.js' %>
+  </head>
+  <body>
+<%
+upid = "#{Time.now.to_i}.#{rand}"
+act = { :action => 'pull', :upload_id => upid }
+opt = {
+  :multipart => true,
+  :target => 'upload-target',
+  :onsubmit => "UploadProgress.begin('#{upid}')"
+}
+-%>
+
+    <% if flash[:notice] %>
+      <div class="notice"><%= flash[:notice] %></div>
+    <% end %>
+<p>
+  This is a demo of <a href="http://upr.bogomips.org/">upr</a> in action
+  with Ajax.Pull.  It only uses a single, streaming AJAX request instead
+  of pulling.  It is based on <a
+  href="http://rubyforge.org/pipermail/mongrel-users/2007-July/003747.html"
+  >mongrel_<b>streaming</b>_upload_progress</a>
+</p>
+<p>
+  This is different from the polling
+  <a href="/">mongrel_upload_progress-compatible</a> version
+  and also different from the polling
+  <a href="/files/new">jQuery+nginx/lighttpd-compatible</a> version
+</p>
+
+    <p><%= link_to "#{upid} (single)",
+          :action => 'status', :upload_id => upid %></p>
+    <p><%= link_to "#{upid} (stream)",
+           "/progress?long&upload_id=#{upid}" %></p>
+
+    <% form_tag(act, opt) do %>
+      <div><p><%= file_field_tag :data %></p></div>
+      <p><%= submit_tag :Upload %></p>
+    <% end %>
+
+    <p>Below is the results <code>div</code></p>
+    <div id="results">(nothing)</div>
+
+    <p>Below is the progress bar <code>div</code></p>
+    <div id="progress-bar"></div>
+
+    <p>Below is the debug list</p>
+    <ol id="debug"></ol>
+
+    <iframe id="upload-target" name="upload-target" src="about:blank"></iframe>
+
+  </body>
+</html>

data/examples/rails_app-2.3.4/config.ru

@@ -1,3 +1,6 @@
 require 'config/environment'
+use Rack::ContentLength
+use Rack::Chunked
+use Rack::Deflater
 use Rails::Rack::Static
 run ActionController::Dispatcher.new