Refactored common functionality from object history controllers
authorMatt Amos <zerebubuth@gmail.com>
Wed, 4 Apr 2012 15:49:28 +0000 (16:49 +0100)
committerTom Hughes <tom@compton.nu>
Thu, 5 Apr 2012 12:52:10 +0000 (13:52 +0100)
app/controllers/old_controller.rb [new file with mode: 0644]
app/controllers/old_node_controller.rb
app/controllers/old_relation_controller.rb
app/controllers/old_way_controller.rb

diff --git a/app/controllers/old_controller.rb b/app/controllers/old_controller.rb
new file mode 100644 (file)
index 0000000..e137554
--- /dev/null
@@ -0,0 +1,73 @@
+# this class pulls together the logic for all the old_* controllers
+# into one place. as it turns out, the API methods for historical
+# nodes, ways and relations are basically identical.
+class OldController < ApplicationController
+  require 'xml/libxml'
+
+  skip_before_filter :verify_authenticity_token
+  before_filter :setup_user_auth, :only => [ :history, :version ]
+  before_filter :authorize, :only => [ :redact ]
+  before_filter :authorize_moderator, :only => [ :redact ]
+  before_filter :require_allow_write_api, :only => [ :redact ]
+  before_filter :check_api_readable
+  before_filter :check_api_writable, :only => [ :redact ]
+  after_filter :compress_output
+  around_filter :api_call_handle_error, :api_call_timeout
+  before_filter :lookup_old_element, :except => [ :history ]
+  before_filter :lookup_old_elements_via_current, :only => [ :history ]
+
+  def history
+    doc = OSM::API.new.get_xml_doc
+    
+    visible_elements = if show_redactions?
+                         @elements
+                       else
+                         @elements.unredacted
+                       end
+
+    visible_elements.each do |element|
+      doc.root << element.to_xml_node
+    end
+    
+    render :text => doc.to_s, :content_type => "text/xml"
+  end
+  
+  def version
+    if @old_element.redacted? and not show_redactions?
+      render :nothing => true, :status => :forbidden
+
+    else
+      response.last_modified = @old_element.timestamp
+      
+      doc = OSM::API.new.get_xml_doc
+      doc.root << @old_element.to_xml_node
+        
+      render :text => doc.to_s, :content_type => "text/xml"
+    end
+  end
+
+  def redact
+    redaction_id = params['redaction']
+    unless redaction_id.nil?
+      # if a redaction ID was specified, then set this element to
+      # be redacted in that redaction. (TODO: check that the
+      # user doing the redaction owns the redaction object too)
+      redaction = Redaction.find(redaction_id.to_i)
+      @old_element.redact!(redaction)
+      
+    else
+      # if no redaction ID was provided, then this is an unredact
+      # operation.
+      @old_element.redact!(nil)
+    end
+    
+    # just return an empty 200 OK for success
+    render :nothing => true
+  end
+
+  private
+  
+  def show_redactions?
+    @user and @user.moderator? and params[:show_redactions] == "true"
+  end
+end
index 02290ffa217b729edcafb44511e053f169d6383b..7055c031cbf000b099b6955bcb778cc6e7312ece 100644 (file)
@@ -1,78 +1,13 @@
-class OldNodeController < ApplicationController
-  require 'xml/libxml'
+class OldNodeController < OldController
 
-  skip_before_filter :verify_authenticity_token
-  before_filter :setup_user_auth, :only => [ :history, :version ]
-  before_filter :authorize, :only => [ :redact ]
-  before_filter :authorize_moderator, :only => [ :redact ]
-  before_filter :require_allow_write_api, :only => [ :redact ]
-  before_filter :check_api_readable
-  before_filter :check_api_writable, :only => [ :redact ]
-  before_filter :lookup_old_node, :except => [ :history ]
-  after_filter :compress_output
-  around_filter :api_call_handle_error, :api_call_timeout
-
-  def history
-    node = Node.find(params[:id].to_i)
-    
-    doc = OSM::API.new.get_xml_doc
-    
-    visible_nodes = if @user and @user.moderator? and params[:show_redactions] == "true"
-                      node.old_nodes
-                    else
-                      node.old_nodes.unredacted
-                    end
-
-    visible_nodes.each do |old_node|
-      doc.root << old_node.to_xml_node
-    end
-    
-    render :text => doc.to_s, :content_type => "text/xml"
-  end
+  private
   
-  def version
-    if @old_node.redacted? and not (@user and @user.moderator? and params[:show_redactions] == "true")
-      render :nothing => true, :status => :forbidden
-
-    else
-      response.last_modified = @old_node.timestamp
-      
-      doc = OSM::API.new.get_xml_doc
-      doc.root << @old_node.to_xml_node
-        
-      render :text => doc.to_s, :content_type => "text/xml"
-    end
+  def lookup_old_element
+    @old_element = OldNode.find([params[:id], params[:version]])
   end
 
-  def redact
-    redaction_id = params['redaction']
-    unless redaction_id.nil?
-      # if a redaction ID was specified, then set this node to
-      # be redacted in that redaction. (TODO: check that the
-      # user doing the redaction owns the redaction object too)
-      redaction = Redaction.find(redaction_id.to_i)
-      @old_node.redact!(redaction)
-      
-    else
-      # if no redaction ID was provided, then this is an unredact
-      # operation.
-      @old_node.redact!(nil)
-    end
-    
-    # just return an empty 200 OK for success
-    render :nothing => true
-  end
-
-  private
-  
-  def lookup_old_node
-    @old_node = OldNode.where(:node_id => params[:id], :version => params[:version]).first
-    if @old_node.nil?
-      # i want to do this
-      #raise OSM::APINotFoundError.new
-      # but i get errors, so i'm getting very fed up and doing this instead
-      render :nothing => true, :status => :not_found
-      return false
-    end
+  def lookup_old_elements_via_current
+    node = Node.find(params[:id])
+    @elements = node.old_nodes
   end
 end
index 85cac89e787ea3b1259a3c20802aa81ae9de2c96..ffb06bf5e9010bea85398ad983e992d51752f5e0 100644 (file)
@@ -1,75 +1,13 @@
-class OldRelationController < ApplicationController
-  require 'xml/libxml'
+class OldRelationController < OldController
 
-  skip_before_filter :verify_authenticity_token
-  before_filter :setup_user_auth, :only => [ :history, :version ]
-  before_filter :authorize, :only => [ :redact ]
-  before_filter :authorize_moderator, :only => [ :redact ]
-  before_filter :require_allow_write_api, :only => [ :redact ]
-  before_filter :check_api_readable
-  before_filter :check_api_writable, :only => [ :redact ]
-  before_filter :lookup_old_relation, :except => [ :history ]
-  after_filter :compress_output
-  around_filter :api_call_handle_error, :api_call_timeout
-
-  def history
-    relation = Relation.find(params[:id].to_i)
-    
-    doc = OSM::API.new.get_xml_doc
-    
-    visible_relations = if @user and @user.moderator? and params[:show_redactions] == "true"
-                          relation.old_relations
-                        else
-                          relation.old_relations.unredacted
-                        end
-    
-    visible_relations.each do |old_relation|
-      doc.root << old_relation.to_xml_node
-    end
-    
-    render :text => doc.to_s, :content_type => "text/xml"
-  end
+  private
   
-  def version
-    if @old_relation.redacted? and not (@user and @user.moderator? and params[:show_redactions] == "true")
-      render :nothing => true, :status => :forbidden
-    else
-
-      response.last_modified = @old_relation.timestamp
-      
-      doc = OSM::API.new.get_xml_doc
-      doc.root << @old_relation.to_xml_node
-        
-      render :text => doc.to_s, :content_type => "text/xml"
-    end
+  def lookup_old_element
+    @old_element = OldRelation.find([params[:id], params[:version]])
   end
 
-  def redact
-    redaction_id = params['redaction']
-    unless redaction_id.nil?
-      # if a redaction ID was specified, then set this relation to
-      # be redacted in that redaction. (TODO: check that the
-      # user doing the redaction owns the redaction object too)
-      redaction = Redaction.find(redaction_id.to_i)
-      @old_relation.redact!(redaction)
-      
-    else
-      # if no redaction ID was provided, then this is an unredact
-      # operation.
-      @old_relation.redact!(nil)
-    end
-    
-    # just return an empty 200 OK for success
-    render :nothing => true
-  end
-
-  private
-  
-  def lookup_old_relation
-    @old_relation = OldRelation.where(:relation_id => params[:id], :version => params[:version]).first
-    if @old_relation.nil?
-      render :nothing => true, :status => :not_found
-      return false
-    end
+  def lookup_old_elements_via_current
+    relation = Relation.find(params[:id])
+    @elements = relation.old_relations
   end
 end
index e2ee5f0c50f139dc607a7e728f8cf697e12e428b..dae0957b30b0cceb868b475b0d57a48be7f6f727 100644 (file)
@@ -1,75 +1,13 @@
-class OldWayController < ApplicationController
-  require 'xml/libxml'
+class OldWayController < OldController
 
-  skip_before_filter :verify_authenticity_token
-  before_filter :setup_user_auth, :only => [ :history, :version ]
-  before_filter :authorize, :only => [ :redact ]
-  before_filter :authorize_moderator, :only => [ :redact ]
-  before_filter :require_allow_write_api, :only => [ :redact ]
-  before_filter :check_api_readable
-  before_filter :check_api_writable, :only => [ :redact ]
-  before_filter :lookup_old_way, :except => [ :history ]
-  after_filter :compress_output
-  around_filter :api_call_handle_error, :api_call_timeout
-
-  def history
-    way = Way.find(params[:id].to_i)
-    
-    doc = OSM::API.new.get_xml_doc
-    
-    visible_ways = if @user and @user.moderator? and params[:show_redactions] == "true"
-                     way.old_ways
-                   else
-                     way.old_ways.unredacted
-                   end
-    
-    visible_ways.each do |old_way|
-      doc.root << old_way.to_xml_node
-    end
-    
-    render :text => doc.to_s, :content_type => "text/xml"
-  end
+  private
   
-  def version
-    if @old_way.redacted? and not (@user and @user.moderator? and params[:show_redactions] == "true")
-      render :nothing => true, :status => :forbidden
-    else
-
-      response.last_modified = @old_way.timestamp
-      
-      doc = OSM::API.new.get_xml_doc
-      doc.root << @old_way.to_xml_node
-        
-      render :text => doc.to_s, :content_type => "text/xml"
-    end
+  def lookup_old_element
+    @old_element = OldWay.find([params[:id], params[:version]])
   end
 
-  def redact
-    redaction_id = params['redaction']
-    unless redaction_id.nil?
-      # if a redaction ID was specified, then set this way to
-      # be redacted in that redaction. (TODO: check that the
-      # user doing the redaction owns the redaction object too)
-      redaction = Redaction.find(redaction_id.to_i)
-      @old_way.redact!(redaction)
-      
-    else
-      # if no redaction ID was provided, then this is an unredact
-      # operation.
-      @old_way.redact!(nil)
-    end
-    
-    # just return an empty 200 OK for success
-    render :nothing => true
-  end
-
-  private
-  
-  def lookup_old_way
-    @old_way = OldWay.where(:way_id => params[:id], :version => params[:version]).first
-    if @old_way.nil?
-      render :nothing => true, :status => :not_found
-      return false
-    end
+  def lookup_old_elements_via_current
+    way = Way.find(params[:id])
+    @elements = way.old_ways
   end
 end