app/controllers/api/relations_controller.rb

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