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_action :verify_authenticity_token, :except => [:list]
   8   before_action :authorize_web, :only => [:list, :feed, :comments_feed]
   9   before_action :set_locale, :only => [:list, :feed, :comments_feed]
  10   before_action :authorize, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
  11   before_action :require_moderator, :only => [:hide_comment, :unhide_comment]
  12   before_action :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
  13   before_action :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe]
  14   before_action :check_api_writable, :only => [:create, :update, :delete, :upload, :include, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
  15   before_action :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list, :feed, :comment, :subscribe, :unsubscribe, :comments_feed]
  16   before_action(:only => [:list, :feed, :comments_feed]) { |c| c.check_database_readable(true) }
  17   around_action :api_call_handle_error, :except => [:list, :feed, :comments_feed]
  18   around_action :api_call_timeout, :except => [:list, :feed, :comments_feed, :upload]
  19   around_action :web_timeout, :only => [:list, :feed, :comments_feed]
  20
  21   # Helper methods for checking consistency
  22   include ConsistencyValidations
  23
  24   # Create a changeset from XML.
  25   def create
  26     assert_method :put
  27
  28     cs = Changeset.from_xml(request.raw_post, true)
  29
  30     # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
  31     cs.user_id = @user.id
  32     cs.save_with_tags!
  33
  34     # Subscribe user to changeset comments
  35     cs.subscribers << @user
  36
  37     render :text => cs.id.to_s, :content_type => "text/plain"
  38   end
  39
  40   ##
  41   # Return XML giving the basic info about the changeset. Does not
  42   # return anything about the nodes, ways and relations in the changeset.
  43   def read
  44     changeset = Changeset.find(params[:id])
  45
  46     render :text => changeset.to_xml(params[:include_discussion].presence).to_s, :content_type => "text/xml"
  47   end
  48
  49   ##
  50   # marks a changeset as closed. this may be called multiple times
  51   # on the same changeset, so is idempotent.
  52   def close
  53     assert_method :put
  54
  55     changeset = Changeset.find(params[:id])
  56     check_changeset_consistency(changeset, @user)
  57
  58     # to close the changeset, we'll just set its closed_at time to
  59     # now. this might not be enough if there are concurrency issues,
  60     # but we'll have to wait and see.
  61     changeset.set_closed_time_now
  62
  63     changeset.save!
  64     render :text => ""
  65   end
  66
  67   ##
  68   # insert a (set of) points into a changeset bounding box. this can only
  69   # increase the size of the bounding box. this is a hint that clients can
  70   # set either before uploading a large number of changes, or changes that
  71   # the client (but not the server) knows will affect areas further away.
  72   def expand_bbox
  73     # only allow POST requests, because although this method is
  74     # idempotent, there is no "document" to PUT really...
  75     assert_method :post
  76
  77     cs = Changeset.find(params[:id])
  78     check_changeset_consistency(cs, @user)
  79
  80     # keep an array of lons and lats
  81     lon = []
  82     lat = []
  83
  84     # the request is in pseudo-osm format... this is kind-of an
  85     # abuse, maybe should change to some other format?
  86     doc = XML::Parser.string(request.raw_post).parse
  87     doc.find("//osm/node").each do |n|
  88       lon << n["lon"].to_f * GeoRecord::SCALE
  89       lat << n["lat"].to_f * GeoRecord::SCALE
  90     end
  91
  92     # add the existing bounding box to the lon-lat array
  93     lon << cs.min_lon unless cs.min_lon.nil?
  94     lat << cs.min_lat unless cs.min_lat.nil?
  95     lon << cs.max_lon unless cs.max_lon.nil?
  96     lat << cs.max_lat unless cs.max_lat.nil?
  97
  98     # collapse the arrays to minimum and maximum
  99     cs.min_lon = lon.min
 100     cs.min_lat = lat.min
 101     cs.max_lon = lon.max
 102     cs.max_lat = lat.max
 103
 104     # save the larger bounding box and return the changeset, which
 105     # will include the bigger bounding box.
 106     cs.save!
 107     render :text => cs.to_xml.to_s, :content_type => "text/xml"
 108   end
 109
 110   ##
 111   # Upload a diff in a single transaction.
 112   #
 113   # This means that each change within the diff must succeed, i.e: that
 114   # each version number mentioned is still current. Otherwise the entire
 115   # transaction *must* be rolled back.
 116   #
 117   # Furthermore, each element in the diff can only reference the current
 118   # changeset.
 119   #
 120   # Returns: a diffResult document, as described in
 121   # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
 122   def upload
 123     # only allow POST requests, as the upload method is most definitely
 124     # not idempotent, as several uploads with placeholder IDs will have
 125     # different side-effects.
 126     # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
 127     assert_method :post
 128
 129     changeset = Changeset.find(params[:id])
 130     check_changeset_consistency(changeset, @user)
 131
 132     diff_reader = DiffReader.new(request.raw_post, changeset)
 133     Changeset.transaction do
 134       result = diff_reader.commit
 135       render :text => result.to_s, :content_type => "text/xml"
 136     end
 137   end
 138
 139   ##
 140   # download the changeset as an osmChange document.
 141   #
 142   # to make it easier to revert diffs it would be better if the osmChange
 143   # format were reversible, i.e: contained both old and new versions of
 144   # modified elements. but it doesn't at the moment...
 145   #
 146   # this method cannot order the database changes fully (i.e: timestamp and
 147   # version number may be too coarse) so the resulting diff may not apply
 148   # to a different database. however since changesets are not atomic this
 149   # behaviour cannot be guaranteed anyway and is the result of a design
 150   # choice.
 151   def download
 152     changeset = Changeset.find(params[:id])
 153
 154     # get all the elements in the changeset which haven't been redacted
 155     # and stick them in a big array.
 156     elements = [changeset.old_nodes.unredacted,
 157                 changeset.old_ways.unredacted,
 158                 changeset.old_relations.unredacted].flatten
 159
 160     # sort the elements by timestamp and version number, as this is the
 161     # almost sensible ordering available. this would be much nicer if
 162     # global (SVN-style) versioning were used - then that would be
 163     # unambiguous.
 164     elements.sort! do |a, b|
 165       if a.timestamp == b.timestamp
 166         a.version <=> b.version
 167       else
 168         a.timestamp <=> b.timestamp
 169       end
 170     end
 171
 172     # create changeset and user caches
 173     changeset_cache = {}
 174     user_display_name_cache = {}
 175
 176     # create an osmChange document for the output
 177     result = OSM::API.new.get_xml_doc
 178     result.root.name = "osmChange"
 179
 180     # generate an output element for each operation. note: we avoid looking
 181     # at the history because it is simpler - but it would be more correct to
 182     # check these assertions.
 183     elements.each do |elt|
 184       result.root <<
 185         if elt.version == 1
 186           # first version, so it must be newly-created.
 187           created = XML::Node.new "create"
 188           created << elt.to_xml_node(changeset_cache, user_display_name_cache)
 189         elsif elt.visible
 190           # must be a modify
 191           modified = XML::Node.new "modify"
 192           modified << elt.to_xml_node(changeset_cache, user_display_name_cache)
 193         else
 194           # if the element isn't visible then it must have been deleted
 195           deleted = XML::Node.new "delete"
 196           deleted << elt.to_xml_node(changeset_cache, user_display_name_cache)
 197         end
 198     end
 199
 200     render :text => result.to_s, :content_type => "text/xml"
 201   end
 202
 203   ##
 204   # query changesets by bounding box, time, user or open/closed status.
 205   def query
 206     # find any bounding box
 207     bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
 208
 209     # create the conditions that the user asked for. some or all of
 210     # these may be nil.
 211     changesets = Changeset.all
 212     changesets = conditions_bbox(changesets, bbox)
 213     changesets = conditions_user(changesets, params["user"], params["display_name"])
 214     changesets = conditions_time(changesets, params["time"])
 215     changesets = conditions_open(changesets, params["open"])
 216     changesets = conditions_closed(changesets, params["closed"])
 217     changesets = conditions_ids(changesets, params["changesets"])
 218
 219     # create the results document
 220     results = OSM::API.new.get_xml_doc
 221
 222     # add all matching changesets to the XML results document
 223     changesets.order("created_at DESC").limit(100).each do |cs|
 224       results.root << cs.to_xml_node
 225     end
 226
 227     render :text => results.to_s, :content_type => "text/xml"
 228   end
 229
 230   ##
 231   # updates a changeset's tags. none of the changeset's attributes are
 232   # user-modifiable, so they will be ignored.
 233   #
 234   # changesets are not (yet?) versioned, so we don't have to deal with
 235   # history tables here. changesets are locked to a single user, however.
 236   #
 237   # after succesful update, returns the XML of the changeset.
 238   def update
 239     # request *must* be a PUT.
 240     assert_method :put
 241
 242     changeset = Changeset.find(params[:id])
 243     new_changeset = Changeset.from_xml(request.raw_post)
 244
 245     check_changeset_consistency(changeset, @user)
 246     changeset.update_from(new_changeset, @user)
 247     render :text => changeset.to_xml, :mime_type => "text/xml"
 248   end
 249
 250   ##
 251   # list edits (open changesets) in reverse chronological order
 252   def list
 253     if request.format == :atom && params[:max_id]
 254       redirect_to url_for(params.merge(:max_id => nil)), :status => :moved_permanently
 255       return
 256     end
 257
 258     if params[:display_name]
 259       user = User.find_by(:display_name => params[:display_name])
 260       if !user || !user.active?
 261         render_unknown_user params[:display_name]
 262         return
 263       end
 264     end
 265
 266     if (params[:friends] || params[:nearby]) && !@user
 267       require_user
 268       return
 269     end
 270
 271     if request.format == :html && !params[:list]
 272       require_oauth
 273       render :action => :history, :layout => map_layout
 274     else
 275       changesets = conditions_nonempty(Changeset.all)
 276
 277       if params[:display_name]
 278         changesets = if user.data_public? || user == @user
 279                        changesets.where(:user_id => user.id)
 280                      else
 281                        changesets.where("false")
 282                      end
 283       elsif params[:bbox]
 284         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
 285       elsif params[:friends] && @user
 286         changesets = changesets.where(:user_id => @user.friend_users.identifiable)
 287       elsif params[:nearby] && @user
 288         changesets = changesets.where(:user_id => @user.nearby)
 289       end
 290
 291       if params[:max_id]
 292         changesets = changesets.where("changesets.id <= ?", params[:max_id])
 293       end
 294
 295       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments)
 296
 297       render :action => :list, :layout => false
 298     end
 299   end
 300
 301   ##
 302   # list edits as an atom feed
 303   def feed
 304     list
 305   end
 306
 307   ##
 308   # Add a comment to a changeset
 309   def comment
 310     # Check the arguments are sane
 311     raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
 312     raise OSM::APIBadUserInput.new("No text was given") if params[:text].blank?
 313
 314     # Extract the arguments
 315     id = params[:id].to_i
 316     body = params[:text]
 317
 318     # Find the changeset and check it is valid
 319     changeset = Changeset.find(id)
 320     raise OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
 321
 322     # Add a comment to the changeset
 323     comment = changeset.comments.create(:changeset => changeset,
 324                                         :body => body,
 325                                         :author => @user)
 326
 327     # Notify current subscribers of the new comment
 328     changeset.subscribers.visible.each do |user|
 329       if @user != user
 330         Notifier.changeset_comment_notification(comment, user).deliver_now
 331       end
 332     end
 333
 334     # Add the commenter to the subscribers if necessary
 335     changeset.subscribers << @user unless changeset.subscribers.exists?(@user.id)
 336
 337     # Return a copy of the updated changeset
 338     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
 339   end
 340
 341   ##
 342   # Adds a subscriber to the changeset
 343   def subscribe
 344     # Check the arguments are sane
 345     raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
 346
 347     # Extract the arguments
 348     id = params[:id].to_i
 349
 350     # Find the changeset and check it is valid
 351     changeset = Changeset.find(id)
 352     raise OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
 353     raise OSM::APIChangesetAlreadySubscribedError.new(changeset) if changeset.subscribers.exists?(@user.id)
 354
 355     # Add the subscriber
 356     changeset.subscribers << @user
 357
 358     # Return a copy of the updated changeset
 359     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
 360   end
 361
 362   ##
 363   # Removes a subscriber from the changeset
 364   def unsubscribe
 365     # Check the arguments are sane
 366     raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
 367
 368     # Extract the arguments
 369     id = params[:id].to_i
 370
 371     # Find the changeset and check it is valid
 372     changeset = Changeset.find(id)
 373     raise OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
 374     raise OSM::APIChangesetNotSubscribedError.new(changeset) unless changeset.subscribers.exists?(@user.id)
 375
 376     # Remove the subscriber
 377     changeset.subscribers.delete(@user)
 378
 379     # Return a copy of the updated changeset
 380     render :text => changeset.to_xml.to_s, :content_type => "text/xml"
 381   end
 382
 383   ##
 384   # Sets visible flag on comment to false
 385   def hide_comment
 386     # Check the arguments are sane
 387     raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
 388
 389     # Extract the arguments
 390     id = params[:id].to_i
 391
 392     # Find the changeset
 393     comment = ChangesetComment.find(id)
 394
 395     # Hide the comment
 396     comment.update(:visible => false)
 397
 398     # Return a copy of the updated changeset
 399     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
 400   end
 401
 402   ##
 403   # Sets visible flag on comment to true
 404   def unhide_comment
 405     # Check the arguments are sane
 406     raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
 407
 408     # Extract the arguments
 409     id = params[:id].to_i
 410
 411     # Find the changeset
 412     comment = ChangesetComment.find(id)
 413
 414     # Unhide the comment
 415     comment.update(:visible => true)
 416
 417     # Return a copy of the updated changeset
 418     render :text => comment.changeset.to_xml.to_s, :content_type => "text/xml"
 419   end
 420
 421   ##
 422   # Get a feed of recent changeset comments
 423   def comments_feed
 424     if params[:id]
 425       # Extract the arguments
 426       id = params[:id].to_i
 427
 428       # Find the changeset
 429       changeset = Changeset.find(id)
 430
 431       # Return comments for this changeset only
 432       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
 433     else
 434       # Return comments
 435       @comments = ChangesetComment.includes(:author, :changeset).where(:visible => :true).order("created_at DESC").limit(comments_limit).preload(:changeset)
 436     end
 437
 438     # Render the result
 439     respond_to do |format|
 440       format.rss
 441     end
 442   rescue OSM::APIBadUserInput
 443     render :text => "", :status => :bad_request
 444   end
 445
 446   private
 447
 448   #------------------------------------------------------------
 449   # utility functions below.
 450   #------------------------------------------------------------
 451
 452   ##
 453   # if a bounding box was specified do some sanity checks.
 454   # restrict changesets to those enclosed by a bounding box
 455   # we need to return both the changesets and the bounding box
 456   def conditions_bbox(changesets, bbox)
 457     if bbox
 458       bbox.check_boundaries
 459       bbox = bbox.to_scaled
 460
 461       changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
 462                        bbox.max_lon.to_i, bbox.min_lon.to_i,
 463                        bbox.max_lat.to_i, bbox.min_lat.to_i)
 464     else
 465       changesets
 466     end
 467   end
 468
 469   ##
 470   # restrict changesets to those by a particular user
 471   def conditions_user(changesets, user, name)
 472     if user.nil? && name.nil?
 473       changesets
 474     else
 475       # shouldn't provide both name and UID
 476       raise OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user && name
 477
 478       # use either the name or the UID to find the user which we're selecting on.
 479       u = if name.nil?
 480             # user input checking, we don't have any UIDs < 1
 481             raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
 482             u = User.find(user.to_i)
 483           else
 484             u = User.find_by(:display_name => name)
 485           end
 486
 487       # make sure we found a user
 488       raise OSM::APINotFoundError.new if u.nil?
 489
 490       # should be able to get changesets of public users only, or
 491       # our own changesets regardless of public-ness.
 492       unless u.data_public?
 493         # get optional user auth stuff so that users can see their own
 494         # changesets if they're non-public
 495         setup_user_auth
 496
 497         raise OSM::APINotFoundError if @user.nil? || @user.id != u.id
 498       end
 499
 500       changesets.where(:user_id => u.id)
 501     end
 502   end
 503
 504   ##
 505   # restrict changes to those closed during a particular time period
 506   def conditions_time(changesets, time)
 507     if time.nil?
 508       return changesets
 509     elsif time.count(",") == 1
 510       # if there is a range, i.e: comma separated, then the first is
 511       # low, second is high - same as with bounding boxes.
 512
 513       # check that we actually have 2 elements in the array
 514       times = time.split(/,/)
 515       raise OSM::APIBadUserInput.new("bad time range") if times.size != 2
 516
 517       from, to = times.collect { |t| DateTime.parse(t) }
 518       return changesets.where("closed_at >= ? and created_at <= ?", from, to)
 519     else
 520       # if there is no comma, assume its a lower limit on time
 521       return changesets.where("closed_at >= ?", DateTime.parse(time))
 522     end
 523     # stupid DateTime seems to throw both of these for bad parsing, so
 524     # we have to catch both and ensure the correct code path is taken.
 525   rescue ArgumentError => ex
 526     raise OSM::APIBadUserInput.new(ex.message.to_s)
 527   rescue RuntimeError => ex
 528     raise OSM::APIBadUserInput.new(ex.message.to_s)
 529   end
 530
 531   ##
 532   # return changesets which are open (haven't been closed yet)
 533   # we do this by seeing if the 'closed at' time is in the future. Also if we've
 534   # hit the maximum number of changes then it counts as no longer open.
 535   # if parameter 'open' is nill then open and closed changesets are returned
 536   def conditions_open(changesets, open)
 537     if open.nil?
 538       changesets
 539     else
 540       changesets.where("closed_at >= ? and num_changes <= ?",
 541                        Time.now.getutc, Changeset::MAX_ELEMENTS)
 542     end
 543   end
 544
 545   ##
 546   # query changesets which are closed
 547   # ('closed at' time has passed or changes limit is hit)
 548   def conditions_closed(changesets, closed)
 549     if closed.nil?
 550       changesets
 551     else
 552       changesets.where("closed_at < ? or num_changes > ?",
 553                        Time.now.getutc, Changeset::MAX_ELEMENTS)
 554     end
 555   end
 556
 557   ##
 558   # query changesets by a list of ids
 559   # (either specified as array or comma-separated string)
 560   def conditions_ids(changesets, ids)
 561     if ids.nil?
 562       changesets
 563     elsif ids.empty?
 564       raise OSM::APIBadUserInput.new("No changesets were given to search for")
 565     else
 566       ids = ids.split(",").collect(&:to_i)
 567       changesets.where(:id => ids)
 568     end
 569   end
 570
 571   ##
 572   # eliminate empty changesets (where the bbox has not been set)
 573   # this should be applied to all changeset list displays
 574   def conditions_nonempty(changesets)
 575     changesets.where("num_changes > 0")
 576   end
 577
 578   ##
 579   # Get the maximum number of comments to return
 580   def comments_limit
 581     if params[:limit]
 582       if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
 583         params[:limit].to_i
 584       else
 585         raise OSM::APIBadUserInput.new("Comments limit must be between 1 and 10000")
 586       end
 587     else
 588       100
 589     end
 590   end
 591 end