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       relation = Relation.find(params[:id])
  52       new_relation = Relation.from_xml(request.raw_post)
  53
  54       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
  55
  56       relation.update_from new_relation, current_user
  57       render :plain => relation.version.to_s
  58     end
  59
  60     def delete
  61       relation = Relation.find(params[:id])
  62       new_relation = Relation.from_xml(request.raw_post)
  63       if new_relation && new_relation.id == relation.id
  64         relation.delete_with_history!(new_relation, current_user)
  65         render :plain => relation.version.to_s
  66       else
  67         head :bad_request
  68       end
  69     end
  70
  71     # -----------------------------------------------------------------
  72     # full
  73     #
  74     # input parameters: id
  75     #
  76     # returns XML representation of one relation object plus all its
  77     # members, plus all nodes part of member ways
  78     # -----------------------------------------------------------------
  79     def full
  80       relation = Relation.find(params[:id])
  81
  82       if relation.visible
  83
  84         # first find the ids of nodes, ways and relations referenced by this
  85         # relation - note that we exclude this relation just in case.
  86
  87         node_ids = relation.members.select { |m| m[0] == "Node" }.pluck(1)
  88         way_ids = relation.members.select { |m| m[0] == "Way" }.pluck(1)
  89         relation_ids = relation.members.select { |m| m[0] == "Relation" && m[1] != relation.id }.pluck(1)
  90
  91         # next load the relations and the ways.
  92
  93         relations = Relation.where(:id => relation_ids).includes(:relation_tags)
  94         ways = Way.where(:id => way_ids).includes(:way_nodes, :way_tags)
  95
  96         # now additionally collect nodes referenced by ways. Note how we
  97         # recursively evaluate ways but NOT relations.
  98
  99         way_node_ids = ways.collect do |way|
 100           way.way_nodes.collect(&:node_id)
 101         end
 102         node_ids += way_node_ids.flatten
 103         nodes = Node.where(:id => node_ids.uniq).includes(:node_tags)
 104
 105         visible_nodes = {}
 106
 107         @nodes = []
 108         nodes.each do |node|
 109           next unless node.visible? # should be unnecessary if data is consistent.
 110
 111           @nodes << node
 112           visible_nodes[node.id] = node
 113         end
 114
 115         @ways = []
 116         ways.each do |way|
 117           next unless way.visible? # should be unnecessary if data is consistent.
 118
 119           @ways << way
 120         end
 121
 122         @relations = []
 123         relations.each do |rel|
 124           next unless rel.visible? # should be unnecessary if data is consistent.
 125
 126           @relations << rel
 127         end
 128
 129         # finally add self
 130         @relations << relation
 131
 132         # Render the result
 133         respond_to do |format|
 134           format.xml
 135           format.json
 136         end
 137       else
 138         head :gone
 139       end
 140     end
 141
 142     def relations_for_way
 143       relations_for_object("Way")
 144     end
 145
 146     def relations_for_node
 147       relations_for_object("Node")
 148     end
 149
 150     def relations_for_relation
 151       relations_for_object("Relation")
 152     end
 153
 154     private
 155
 156     def relations_for_object(objtype)
 157       relationids = RelationMember.where(:member_type => objtype, :member_id => params[:id]).collect(&:relation_id).uniq
 158
 159       @relations = []
 160
 161       Relation.find(relationids).each do |relation|
 162         @relations << relation if relation.visible
 163       end
 164
 165       # Render the result
 166       respond_to do |format|
 167         format.xml
 168         format.json
 169       end
 170     end
 171   end
 172 end