app/controllers/changeset_controller.rb

   1 # The ChangesetController is the RESTful interface to Changeset objects
   2
   3 class ChangesetController < ApplicationController
   4   layout 'site'
   5   require 'xml/libxml'
   6
   7   skip_before_filter :verify_authenticity_token, :except => [:list]
   8   before_filter :authorize_web, :only => [:list, :feed]
   9   before_filter :set_locale, :only => [:list, :feed]
  10   before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close]
  11   before_filter :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close]
  12   before_filter :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close]
  13   before_filter :check_api_writable, :only => [:create, :update, :delete, :upload, :include]
  14   before_filter :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list, :feed]
  15   before_filter(:only => [:list, :feed]) { |c| c.check_database_readable(true) }
  16   after_filter :compress_output
  17   around_filter :api_call_handle_error, :except => [:list, :feed]
  18   around_filter :web_timeout, :only => [:list, :feed]
  19
  20   # Helper methods for checking consistency
  21   include ConsistencyValidations
  22
  23   # Create a changeset from XML.
  24   def create
  25     assert_method :put
  26
  27     cs = Changeset.from_xml(request.raw_post, true)
  28
  29     # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
  30     cs.user_id = @user.id
  31     cs.save_with_tags!
  32     render :text => cs.id.to_s, :content_type => "text/plain"
  33   end
  34
  35   ##
  36   # Return XML giving the basic info about the changeset. Does not
  37   # return anything about the nodes, ways and relations in the changeset.
  38   def read
  39     changeset = Changeset.find(params[:id])
  40     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
  41   end
  42
  43   ##
  44   # marks a changeset as closed. this may be called multiple times
  45   # on the same changeset, so is idempotent.
  46   def close
  47     assert_method :put
  48
  49     changeset = Changeset.find(params[:id])
  50     check_changeset_consistency(changeset, @user)
  51
  52     # to close the changeset, we'll just set its closed_at time to
  53     # now. this might not be enough if there are concurrency issues,
  54     # but we'll have to wait and see.
  55     changeset.set_closed_time_now
  56
  57     changeset.save!
  58     render :nothing => true
  59   end
  60
  61   ##
  62   # insert a (set of) points into a changeset bounding box. this can only
  63   # increase the size of the bounding box. this is a hint that clients can
  64   # set either before uploading a large number of changes, or changes that
  65   # the client (but not the server) knows will affect areas further away.
  66   def expand_bbox
  67     # only allow POST requests, because although this method is
  68     # idempotent, there is no "document" to PUT really...
  69     assert_method :post
  70
  71     cs = Changeset.find(params[:id])
  72     check_changeset_consistency(cs, @user)
  73
  74     # keep an array of lons and lats
  75     lon = Array.new
  76     lat = Array.new
  77
  78     # the request is in pseudo-osm format... this is kind-of an
  79     # abuse, maybe should change to some other format?
  80     doc = XML::Parser.string(request.raw_post).parse
  81     doc.find("//osm/node").each do |n|
  82       lon << n['lon'].to_f * GeoRecord::SCALE
  83       lat << n['lat'].to_f * GeoRecord::SCALE
  84     end
  85
  86     # add the existing bounding box to the lon-lat array
  87     lon << cs.min_lon unless cs.min_lon.nil?
  88     lat << cs.min_lat unless cs.min_lat.nil?
  89     lon << cs.max_lon unless cs.max_lon.nil?
  90     lat << cs.max_lat unless cs.max_lat.nil?
  91
  92     # collapse the arrays to minimum and maximum
  93     cs.min_lon, cs.min_lat, cs.max_lon, cs.max_lat =
  94       lon.min, lat.min, lon.max, lat.max
  95
  96     # save the larger bounding box and return the changeset, which
  97     # will include the bigger bounding box.
  98     cs.save!
  99     render :text => cs.to_xml.to_s, :content_type => "text/xml"
 100   end
 101
 102   ##
 103   # Upload a diff in a single transaction.
 104   #
 105   # This means that each change within the diff must succeed, i.e: that
 106   # each version number mentioned is still current. Otherwise the entire
 107   # transaction *must* be rolled back.
 108   #
 109   # Furthermore, each element in the diff can only reference the current
 110   # changeset.
 111   #
 112   # Returns: a diffResult document, as described in
 113   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
 114   def upload
 115     # only allow POST requests, as the upload method is most definitely
 116     # not idempotent, as several uploads with placeholder IDs will have
 117     # different side-effects.
 118     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
 119     assert_method :post
 120
 121     changeset = Changeset.find(params[:id])
 122     check_changeset_consistency(changeset, @user)
 123
 124     diff_reader = DiffReader.new(request.raw_post, changeset)
 125     Changeset.transaction do
 126       result = diff_reader.commit
 127       render :text => result.to_s, :content_type => "text/xml"
 128     end
 129   end
 130
 131   ##
 132   # download the changeset as an osmChange document.
 133   #
 134   # to make it easier to revert diffs it would be better if the osmChange
 135   # format were reversible, i.e: contained both old and new versions of
 136   # modified elements. but it doesn't at the moment...
 137   #
 138   # this method cannot order the database changes fully (i.e: timestamp and
 139   # version number may be too coarse) so the resulting diff may not apply
 140   # to a different database. however since changesets are not atomic this
 141   # behaviour cannot be guaranteed anyway and is the result of a design
 142   # choice.
 143   def download
 144     changeset = Changeset.find(params[:id])
 145
 146     # get all the elements in the changeset which haven't been redacted
 147     # and stick them in a big array.
 148     elements = [changeset.old_nodes.unredacted,
 149                 changeset.old_ways.unredacted,
 150                 changeset.old_relations.unredacted].flatten
 151
 152     # sort the elements by timestamp and version number, as this is the
 153     # almost sensible ordering available. this would be much nicer if
 154     # global (SVN-style) versioning were used - then that would be
 155     # unambiguous.
 156     elements.sort! do |a, b|
 157       if (a.timestamp == b.timestamp)
 158         a.version <=> b.version
 159       else
 160         a.timestamp <=> b.timestamp
 161       end
 162     end
 163
 164     # create an osmChange document for the output
 165     result = OSM::API.new.get_xml_doc
 166     result.root.name = "osmChange"
 167
 168     # generate an output element for each operation. note: we avoid looking
 169     # at the history because it is simpler - but it would be more correct to
 170     # check these assertions.
 171     elements.each do |elt|
 172       result.root <<
 173         if (elt.version == 1)
 174           # first version, so it must be newly-created.
 175           created = XML::Node.new "create"
 176           created << elt.to_xml_node
 177         else
 178           unless elt.visible
 179             # if the element isn't visible then it must have been deleted
 180             deleted = XML::Node.new "delete"
 181             deleted << elt.to_xml_node
 182           else
 183             # must be a modify
 184             modified = XML::Node.new "modify"
 185             modified << elt.to_xml_node
 186           end
 187         end
 188     end
 189
 190     render :text => result.to_s, :content_type => "text/xml"
 191   end
 192
 193   ##
 194   # query changesets by bounding box, time, user or open/closed status.
 195   def query
 196     # find any bounding box
 197     if params['bbox']
 198       bbox = BoundingBox.from_bbox_params(params)
 199     end
 200
 201     # create the conditions that the user asked for. some or all of
 202     # these may be nil.
 203     changesets = Changeset.scoped
 204     changesets = conditions_bbox(changesets, bbox)
 205     changesets = conditions_user(changesets, params['user'], params['display_name'])
 206     changesets = conditions_time(changesets, params['time'])
 207     changesets = conditions_open(changesets, params['open'])
 208     changesets = conditions_closed(changesets, params['closed'])
 209
 210     # create the results document
 211     results = OSM::API.new.get_xml_doc
 212
 213     # add all matching changesets to the XML results document
 214     changesets.order("created_at DESC").limit(100).each do |cs|
 215       results.root << cs.to_xml_node
 216     end
 217
 218     render :text => results.to_s, :content_type => "text/xml"
 219   end
 220
 221   ##
 222   # updates a changeset's tags. none of the changeset's attributes are
 223   # user-modifiable, so they will be ignored.
 224   #
 225   # changesets are not (yet?) versioned, so we don't have to deal with
 226   # history tables here. changesets are locked to a single user, however.
 227   #
 228   # after succesful update, returns the XML of the changeset.
 229   def update
 230     # request *must* be a PUT.
 231     assert_method :put
 232
 233     changeset = Changeset.find(params[:id])
 234     new_changeset = Changeset.from_xml(request.raw_post)
 235
 236     unless new_changeset.nil?
 237       check_changeset_consistency(changeset, @user)
 238       changeset.update_from(new_changeset, @user)
 239       render :text => changeset.to_xml, :mime_type => "text/xml"
 240     else
 241
 242       render :nothing => true, :status => :bad_request
 243     end
 244   end
 245
 246   ##
 247   # list edits (open changesets) in reverse chronological order
 248   def list
 249     if request.format == :atom and params[:page]
 250       redirect_to params.merge({ :page => nil }), :status => :moved_permanently
 251     else
 252       changesets = conditions_nonempty(Changeset.scoped)
 253
 254       if params[:display_name]
 255         user = User.find_by_display_name(params[:display_name])
 256
 257         if user and user.active?
 258           if user.data_public? or user == @user
 259             changesets = changesets.where(:user_id => user.id)
 260           else
 261             changesets = changesets.where("false")
 262           end
 263         else
 264           render_unknown_user params[:display_name]
 265           return
 266         end
 267       end
 268
 269       if params[:friends]
 270         if @user
 271           changesets = changesets.where(:user_id => @user.friend_users.public)
 272         elsif request.format == :html
 273           require_user
 274           return
 275         end
 276       end
 277
 278       if params[:nearby]
 279         if @user
 280           changesets = changesets.where(:user_id => @user.nearby)
 281         elsif request.format == :html
 282           require_user
 283           return
 284         end
 285       end
 286
 287       if params[:bbox]
 288         bbox = BoundingBox.from_bbox_params(params)
 289       elsif params[:minlon] and params[:minlat] and params[:maxlon] and params[:maxlat]
 290         bbox = BoundingBox.from_lon_lat_params(params)
 291       end
 292
 293       if bbox
 294         changesets = conditions_bbox(changesets, bbox)
 295         bbox_link = render_to_string :partial => "bbox", :object => bbox
 296       end
 297
 298       if user
 299         user_link = render_to_string :partial => "user", :object => user
 300       end
 301
 302       if params[:friends] and @user
 303         @title =  t 'changeset.list.title_friend'
 304         @heading =  t 'changeset.list.heading_friend'
 305         @description = t 'changeset.list.description_friend'
 306       elsif params[:nearby] and @user
 307         @title = t 'changeset.list.title_nearby'
 308         @heading = t 'changeset.list.heading_nearby'
 309         @description = t 'changeset.list.description_nearby'
 310       elsif user and bbox
 311         @title =  t 'changeset.list.title_user_bbox', :user => user.display_name, :bbox => bbox.to_s
 312         @heading =  t 'changeset.list.heading_user_bbox', :user => user.display_name, :bbox => bbox.to_s
 313         @description = t 'changeset.list.description_user_bbox', :user => user_link, :bbox => bbox_link
 314       elsif user
 315         @title =  t 'changeset.list.title_user', :user => user.display_name
 316         @heading =  t 'changeset.list.heading_user', :user => user.display_name
 317         @description = t 'changeset.list.description_user', :user => user_link
 318       elsif bbox
 319         @title =  t 'changeset.list.title_bbox', :bbox => bbox.to_s
 320         @heading =  t 'changeset.list.heading_bbox', :bbox => bbox.to_s
 321         @description = t 'changeset.list.description_bbox', :bbox => bbox_link
 322       else
 323         @title =  t 'changeset.list.title'
 324         @heading =  t 'changeset.list.heading'
 325         @description = t 'changeset.list.description'
 326       end
 327
 328       @page = (params[:page] || 1).to_i
 329       @page_size = 20
 330
 331       @bbox = bbox
 332
 333       @edits = changesets.order("changesets.created_at DESC").offset((@page - 1) * @page_size).limit(@page_size).preload(:user, :changeset_tags)
 334
 335       render :action => :list
 336     end
 337   end
 338
 339   ##
 340   # list edits as an atom feed
 341   def feed
 342     list
 343   end
 344
 345 private
 346   #------------------------------------------------------------
 347   # utility functions below.
 348   #------------------------------------------------------------
 349
 350   ##
 351   # if a bounding box was specified do some sanity checks.
 352   # restrict changesets to those enclosed by a bounding box
 353   # we need to return both the changesets and the bounding box
 354   def conditions_bbox(changesets, bbox)
 355     if  bbox
 356       bbox.check_boundaries
 357       bbox = bbox.to_scaled
 358       return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
 359                               bbox.max_lon.to_i, bbox.min_lon.to_i,
 360                               bbox.max_lat.to_i, bbox.min_lat.to_i)
 361     else
 362       return changesets
 363     end
 364   end
 365
 366   ##
 367   # restrict changesets to those by a particular user
 368   def conditions_user(changesets, user, name)
 369     unless user.nil? and name.nil?
 370       # shouldn't provide both name and UID
 371       raise OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user and name
 372
 373       # use either the name or the UID to find the user which we're selecting on.
 374       u = if name.nil?
 375             # user input checking, we don't have any UIDs < 1
 376             raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
 377             u = User.find(user.to_i)
 378           else
 379             u = User.find_by_display_name(name)
 380           end
 381
 382       # make sure we found a user
 383       raise OSM::APINotFoundError.new if u.nil?
 384
 385       # should be able to get changesets of public users only, or
 386       # our own changesets regardless of public-ness.
 387       unless u.data_public?
 388         # get optional user auth stuff so that users can see their own
 389         # changesets if they're non-public
 390         setup_user_auth
 391
 392         raise OSM::APINotFoundError if @user.nil? or @user.id != u.id
 393       end
 394       return changesets.where(:user_id => u.id)
 395     else
 396       return changesets
 397     end
 398   end
 399
 400   ##
 401   # restrict changes to those closed during a particular time period
 402   def conditions_time(changesets, time)
 403     unless time.nil?
 404       # if there is a range, i.e: comma separated, then the first is
 405       # low, second is high - same as with bounding boxes.
 406       if time.count(',') == 1
 407         # check that we actually have 2 elements in the array
 408         times = time.split(/,/)
 409         raise OSM::APIBadUserInput.new("bad time range") if times.size != 2
 410
 411         from, to = times.collect { |t| DateTime.parse(t) }
 412         return changesets.where("closed_at >= ? and created_at <= ?", from, to)
 413       else
 414         # if there is no comma, assume its a lower limit on time
 415         return changesets.where("closed_at >= ?", DateTime.parse(time))
 416       end
 417     else
 418       return changesets
 419     end
 420     # stupid DateTime seems to throw both of these for bad parsing, so
 421     # we have to catch both and ensure the correct code path is taken.
 422   rescue ArgumentError => ex
 423     raise OSM::APIBadUserInput.new(ex.message.to_s)
 424   rescue RuntimeError => ex
 425     raise OSM::APIBadUserInput.new(ex.message.to_s)
 426   end
 427
 428   ##
 429   # return changesets which are open (haven't been closed yet)
 430   # we do this by seeing if the 'closed at' time is in the future. Also if we've
 431   # hit the maximum number of changes then it counts as no longer open.
 432   # if parameter 'open' is nill then open and closed changesets are returned
 433   def conditions_open(changesets, open)
 434     if open.nil?
 435       return changesets
 436     else
 437       return changesets.where("closed_at >= ? and num_changes <= ?",
 438                               Time.now.getutc, Changeset::MAX_ELEMENTS)
 439     end
 440   end
 441
 442   ##
 443   # query changesets which are closed
 444   # ('closed at' time has passed or changes limit is hit)
 445   def conditions_closed(changesets, closed)
 446     if closed.nil?
 447       return changesets
 448     else
 449       return changesets.where("closed_at < ? or num_changes > ?",
 450                               Time.now.getutc, Changeset::MAX_ELEMENTS)
 451     end
 452   end
 453
 454   ##
 455   # eliminate empty changesets (where the bbox has not been set)
 456   # this should be applied to all changeset list displays
 457   def conditions_nonempty(changesets)
 458     return changesets.where("num_changes > 0")
 459   end
 460
 461 end