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