app/controllers/api/relations_controller.rb

   1 module Api
   2   class RelationsController < ApiController
   3     before_action :check_api_writable, :only => [:create, :update, :delete]
   4     before_action :authorize, :only => [:create, :update, :delete]
   5
   6     authorize_resource
   7
   8     before_action :require_public_data, :only => [:create, :update, :delete]
   9     before_action :set_request_formats, :except => [:create, :update, :delete]
  10     before_action :check_rate_limit, :only => [:create, :update, :delete]
  11
  12     def index
  13       raise OSM::APIBadUserInput, "The parameter relations is required, and must be of the form relations=id[,id[,id...]]" unless params["relations"]
  14
  15       ids = params["relations"].split(",").collect(&:to_i)
  16
  17       raise OSM::APIBadUserInput, "No relations were given to search for" if ids.empty?
  18
  19       @relations = Relation.find(ids)
  20
  21       # Render the result
  22       respond_to do |format|
  23         format.xml
  24         format.json
  25       end
  26     end
  27
  28     def show
  29       @relation = Relation.find(params[:id])
  30       response.last_modified = @relation.timestamp
  31       if @relation.visible
  32         # Render the result
  33         respond_to do |format|
  34           format.xml
  35           format.json
  36         end
  37       else
  38         head :gone
  39       end
  40     end
  41
  42     def create
  43       relation = Relation.from_xml(request.raw_post, :create => true)
  44
  45       # Assume that Relation.from_xml has thrown an exception if there is an error parsing the xml
  46       relation.create_with_history current_user
  47       render :plain => relation.id.to_s
  48     end
  49
  50     def update
  51       logger.debug request.raw_post
  52
  53       relation = Relation.find(params[:id])
  54       new_relation = Relation.from_xml(request.raw_post)
  55
  56       raise OSM::APIBadUserInput, "The id in the url (#{relation.id}) is not the same as provided in the xml (#{new_relation.id})" unless new_relation && new_relation.id == relation.id
  57
  58       relation.update_from new_relation, current_user
  59       render :plain => relation.version.to_s
  60     end
  61
  62     def delete
  63       relation = Relation.find(params[:id])
  64       new_relation = Relation.from_xml(request.raw_post)
  65       if new_relation && new_relation.id == relation.id
  66         relation.delete_with_history!(new_relation, current_user)
  67         render :plain => relation.version.to_s
  68       else
  69         head :bad_request
  70       end
  71     end
  72
  73     # -----------------------------------------------------------------
  74     # full
  75     #
  76     # input parameters: id
  77     #
  78     # returns XML representation of one relation object plus all its
  79     # members, plus all nodes part of member ways
  80     # -----------------------------------------------------------------
  81     def full
  82       relation = Relation.find(params[:id])
  83
  84       if relation.visible
  85
  86         # first find the ids of nodes, ways and relations referenced by this
  87         # relation - note that we exclude this relation just in case.
  88
  89         node_ids = relation.members.select { |m| m[0] == "Node" }.pluck(1)
  90         way_ids = relation.members.select { |m| m[0] == "Way" }.pluck(1)
  91         relation_ids = relation.members.select { |m| m[0] == "Relation" && m[1] != relation.id }.pluck(1)
  92
  93         # next load the relations and the ways.
  94
  95         relations = Relation.where(:id => relation_ids).includes(:relation_tags)
  96         ways = Way.where(:id => way_ids).includes(:way_nodes, :way_tags)
  97
  98         # now additionally collect nodes referenced by ways. Note how we
  99         # recursively evaluate ways but NOT relations.
 100
 101         way_node_ids = ways.collect do |way|
 102           way.way_nodes.collect(&:node_id)
 103         end
 104         node_ids += way_node_ids.flatten
 105         nodes = Node.where(:id => node_ids.uniq).includes(:node_tags)
 106
 107         visible_nodes = {}
 108
 109         @nodes = []
 110         nodes.each do |node|
 111           next unless node.visible? # should be unnecessary if data is consistent.
 112
 113           @nodes << node
 114           visible_nodes[node.id] = node
 115         end
 116
 117         @ways = []
 118         ways.each do |way|
 119           next unless way.visible? # should be unnecessary if data is consistent.
 120
 121           @ways << way
 122         end
 123
 124         @relations = []
 125         relations.each do |rel|
 126           next unless rel.visible? # should be unnecessary if data is consistent.
 127
 128           @relations << rel
 129         end
 130
 131         # finally add self
 132         @relations << relation
 133
 134         # Render the result
 135         respond_to do |format|
 136           format.xml
 137           format.json
 138         end
 139       else
 140         head :gone
 141       end
 142     end
 143
 144     def relations_for_way
 145       relations_for_object("Way")
 146     end
 147
 148     def relations_for_node
 149       relations_for_object("Node")
 150     end
 151
 152     def relations_for_relation
 153       relations_for_object("Relation")
 154     end
 155
 156     private
 157
 158     def relations_for_object(objtype)
 159       relationids = RelationMember.where(:member_type => objtype, :member_id => params[:id]).collect(&:relation_id).uniq
 160
 161       @relations = []
 162
 163       Relation.find(relationids).each do |relation|
 164         @relations << relation if relation.visible
 165       end
 166
 167       # Render the result
 168       respond_to do |format|
 169         format.xml
 170         format.json
 171       end
 172     end
 173   end
 174 end