Add social sharing functionality

[rails.git] / app / models / relation.rb

diff --git a/app/models/relation.rb b/app/models/relation.rb
index 39c1ad834a12771243ecc5b4ca68489a7c20d024..f09647320004f99dc1734964a3e265ffb97b272e 100644 (file)
--- a/app/models/relation.rb
+++ b/app/models/relation.rb
@@ -1,29 +1,47 @@
-class Relation < ActiveRecord::Base
-  require 'xml/libxml'
+# == Schema Information
+#
+# Table name: current_relations
+#
+#  id           :bigint(8)        not null, primary key
+#  changeset_id :bigint(8)        not null
+#  timestamp    :datetime         not null
+#  visible      :boolean          not null
+#  version      :bigint(8)        not null
+#
+# Indexes
+#
+#  current_relations_timestamp_idx  (timestamp)
+#
+# Foreign Keys
+#
+#  current_relations_changeset_id_fkey  (changeset_id => changesets.id)
+#
+
+class Relation < ApplicationRecord
+  require "xml/libxml"

 
   include ConsistencyValidations
   include NotRedactable
 
   include ConsistencyValidations
   include NotRedactable

-  include ObjectMetadata

 
   self.table_name = "current_relations"
 
   belongs_to :changeset
 
 
   self.table_name = "current_relations"
 
   belongs_to :changeset
 

-  has_many :old_relations, -> { order(:version) }
+  has_many :old_relations, -> { order(:version) }, :inverse_of => :current_relation

 
 

-  has_many :relation_members, -> { order(:sequence_id) }
+  has_many :relation_members, -> { order(:sequence_id) }, :inverse_of => :relation

   has_many :relation_tags
 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
 
   has_many :relation_tags
 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
 

-  validates_presence_of :id, :on => :update
-  validates_presence_of :timestamp, :version,  :changeset_id
-  validates_uniqueness_of :id
-  validates_inclusion_of :visible, :in => [true, false]
-  validates_numericality_of :id, :on => :update, :integer_only => true
-  validates_numericality_of :changeset_id, :version, :integer_only => true
-  validates_associated :changeset
+  validates :id, :uniqueness => true, :presence => { :on => :update },
+                 :numericality => { :on => :update, :only_integer => true }
+  validates :version, :presence => true,
+                      :numericality => { :only_integer => true }
+  validates :timestamp, :presence => true
+  validates :changeset, :associated => true
+  validates :visible, :inclusion => [true, false]

 
   scope :visible, -> { where(:visible => true) }
   scope :invisible, -> { where(:visible => false) }
 
   scope :visible, -> { where(:visible => true) }
   scope :invisible, -> { where(:visible => false) }


@@ -31,34 +49,39 @@ class Relation < ActiveRecord::Base
   scope :ways, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Way", :member_id => ids.flatten }) }
   scope :relations, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Relation", :member_id => ids.flatten }) }
 
   scope :ways, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Way", :member_id => ids.flatten }) }
   scope :relations, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Relation", :member_id => ids.flatten }) }
 

-  TYPES = %w(node way relation)
+  TYPES = %w[node way relation].freeze

 
 

-  def self.from_xml(xml, create = false)
-    p = XML::Parser.string(xml)
+  def self.from_xml(xml, create: false)
+    p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)

     doc = p.parse
     doc = p.parse

+    pt = doc.find_first("//osm/relation")

 
 

-    doc.find('//osm/relation').each do |pt|
-      return Relation.from_xml_node(pt, create)
+    if pt
+      Relation.from_xml_node(pt, :create => create)
+    else
+      raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/relation element.")

     end
     end

-    fail OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/relation element.")
-  rescue LibXML::XML::Error, ArgumentError => ex
-    raise OSM::APIBadXMLError.new("relation", xml, ex.message)
+  rescue LibXML::XML::Error, ArgumentError => e
+    raise OSM::APIBadXMLError.new("relation", xml, e.message)

   end
 
   end
 

-  def self.from_xml_node(pt, create = false)
+  def self.from_xml_node(pt, create: false)

     relation = Relation.new
 
     relation = Relation.new
 

-    fail OSM::APIBadXMLError.new("relation", pt, "Version is required when updating") unless create || !pt['version'].nil?
-    relation.version = pt['version']
-    fail OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt['changeset'].nil?
-    relation.changeset_id = pt['changeset']
+    raise OSM::APIBadXMLError.new("relation", pt, "Version is required when updating") unless create || !pt["version"].nil?
+
+    relation.version = pt["version"]
+    raise OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt["changeset"].nil?
+
+    relation.changeset_id = pt["changeset"]

 
     unless create
 
     unless create

-      fail OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt['id'].nil?
-      relation.id = pt['id'].to_i
+      raise OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt["id"].nil?
+
+      relation.id = pt["id"].to_i

       # .to_i will return 0 if there is no number that can be parsed.
       # We want to make sure that there is no id with zero anyway
       # .to_i will return 0 if there is no number that can be parsed.
       # We want to make sure that there is no id with zero anyway

-      fail OSM::APIBadUserInput.new("ID of relation cannot be zero when updating.") if relation.id == 0
+      raise OSM::APIBadUserInput, "ID of relation cannot be zero when updating." if relation.id.zero?

     end
 
     # We don't care about the timestamp nor the visibility as these are either
     end
 
     # We don't care about the timestamp nor the visibility as these are either


@@ -70,10 +93,11 @@ class Relation < ActiveRecord::Base
     relation.tags = {}
 
     # Add in any tags from the XML
     relation.tags = {}
 
     # Add in any tags from the XML

-    pt.find('tag').each do |tag|
-      fail OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag['k'].nil?
-      fail OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag['v'].nil?
-      relation.add_tag_keyval(tag['k'], tag['v'])
+    pt.find("tag").each do |tag|
+      raise OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag["k"].nil?
+      raise OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag["v"].nil?
+
+      relation.add_tag_keyval(tag["k"], tag["v"])

     end
 
     # need to initialise the relation members array explicitly, as if this
     end
 
     # need to initialise the relation members array explicitly, as if this


@@ -82,60 +106,21 @@ class Relation < ActiveRecord::Base
     # empty, as intended.
     relation.members = []
 
     # empty, as intended.
     relation.members = []
 

-    pt.find('member').each do |member|
+    pt.find("member").each do |member|

       # member_type =
       # member_type =

-      logger.debug "each member"
-      fail OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member['type']
-      logger.debug "after raise"
+      raise OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member["type"]
+

       # member_ref = member['ref']
       # member_role
       # member_ref = member['ref']
       # member_role

-      member['role'] ||= "" # Allow  the upload to not include this, in which case we default to an empty string.
-      logger.debug member['role']
-      relation.add_member(member['type'].classify, member['ref'], member['role'])
+      member["role"] ||= "" # Allow  the upload to not include this, in which case we default to an empty string.
+      relation.add_member(member["type"].classify, member["ref"], member["role"])

     end
     end

-    fail OSM::APIBadUserInput.new("Some bad xml in relation") if relation.nil?
+    raise OSM::APIBadUserInput, "Some bad xml in relation" if relation.nil?

 
     relation
   end
 
 
     relation
   end
 

-  def to_xml
-    doc = OSM::API.new.get_xml_doc
-    doc.root << to_xml_node
-    doc
-  end
-
-  def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})
-    el = XML::Node.new 'relation'
-    el['id'] = id.to_s
-
-    add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
-
-    relation_members.each do |member|
-      p = 0
-
-      if visible_members
-        # if there is a list of visible members then use that to weed out deleted segments
-        p = 1 if visible_members[member.member_type][member.member_id]
-      else
-        # otherwise, manually go to the db to check things
-        p = 1 if member.member.visible?
-      end
-
-      next unless p
-
-      member_el = XML::Node.new 'member'
-      member_el['type'] = member.member_type.downcase
-      member_el['ref'] = member.member_id.to_s
-      member_el['role'] = member.member_role
-      el << member_el
-    end
-
-    add_tags_to_xml_node(el, relation_tags)
-
-    el
-  end
-
-  # FIXME is this really needed?
+  # FIXME: is this really needed?

   def members
     @members ||= relation_members.map do |member|
       [member.member_type, member.member_id, member.member_role]
   def members
     @members ||= relation_members.map do |member|
       [member.member_type, member.member_id, member.member_role]


@@ -143,12 +128,10 @@ class Relation < ActiveRecord::Base
   end
 
   def tags
   end
 
   def tags

-    @tags ||= Hash[relation_tags.collect { |t| [t.k, t.v] }]
+    @tags ||= relation_tags.to_h { |t| [t.k, t.v] }

   end
 
   end
 

-  attr_writer :members
-
-  attr_writer :tags
+  attr_writer :members, :tags

 
   def add_member(type, id, role)
     @members ||= []
 
   def add_member(type, id, role)
     @members ||= []


@@ -156,11 +139,11 @@ class Relation < ActiveRecord::Base
   end
 
   def add_tag_keyval(k, v)
   end
 
   def add_tag_keyval(k, v)

-    @tags = {} unless @tags
+    @tags ||= {}

 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.

-    fail OSM::APIDuplicateTagsError.new("relation", id, k) if @tags.include? k
+    raise OSM::APIDuplicateTagsError.new("relation", id, k) if @tags.include? k

 
     @tags[k] = v
   end
 
     @tags[k] = v
   end


@@ -176,19 +159,17 @@ class Relation < ActiveRecord::Base
   end
 
   def delete_with_history!(new_relation, user)
   end
 
   def delete_with_history!(new_relation, user)

-    unless visible
-      fail OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
-    end
+    raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id) unless visible

 
     # need to start the transaction here, so that the database can
     # provide repeatable reads for the used-by checks. this means it
     # shouldn't be possible to get race conditions.
     Relation.transaction do
 
     # need to start the transaction here, so that the database can
     # provide repeatable reads for the used-by checks. this means it
     # shouldn't be possible to get race conditions.
     Relation.transaction do

-      self.lock!
-      check_consistency(self, new_relation, user)
+      lock!
+      check_update_element_consistency(self, new_relation, user)

       # This will check to see if this relation is used by another relation
       # This will check to see if this relation is used by another relation

-      rel = RelationMember.joins(:relation).where("visible = ? AND member_type = 'Relation' and member_id = ? ", true, id).first
-      fail OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
+      rel = RelationMember.joins(:relation).find_by("visible = ? AND member_type = 'Relation' and member_id = ? ", true, id)
+      raise OSM::APIPreconditionFailedError, "The relation #{new_relation.id} is used in relation #{rel.relation.id}." unless rel.nil?

 
       self.changeset_id = new_relation.changeset_id
       self.tags = {}
 
       self.changeset_id = new_relation.changeset_id
       self.tags = {}


@@ -200,11 +181,10 @@ class Relation < ActiveRecord::Base
 
   def update_from(new_relation, user)
     Relation.transaction do
 
   def update_from(new_relation, user)
     Relation.transaction do

-      self.lock!
-      check_consistency(self, new_relation, user)
-      unless new_relation.preconditions_ok?(members)
-        fail OSM::APIPreconditionFailedError.new("Cannot update relation #{id}: data or member data is invalid.")
-      end
+      lock!
+      check_update_element_consistency(self, new_relation, user)
+      raise OSM::APIPreconditionFailedError, "Cannot update relation #{id}: data or member data is invalid." unless new_relation.preconditions_ok?(members)
+

       self.changeset_id = new_relation.changeset_id
       self.changeset = new_relation.changeset
       self.tags = new_relation.tags
       self.changeset_id = new_relation.changeset_id
       self.changeset = new_relation.changeset
       self.tags = new_relation.tags


@@ -215,16 +195,17 @@ class Relation < ActiveRecord::Base
   end
 
   def create_with_history(user)
   end
 
   def create_with_history(user)

-    check_create_consistency(self, user)
-    unless self.preconditions_ok?
-      fail OSM::APIPreconditionFailedError.new("Cannot create relation: data or member data is invalid.")
-    end
+    check_create_element_consistency(self, user)
+    raise OSM::APIPreconditionFailedError, "Cannot create relation: data or member data is invalid." unless preconditions_ok?
+

     self.version = 0
     self.visible = true
     save_with_history!
   end
 
   def preconditions_ok?(good_members = [])
     self.version = 0
     self.visible = true
     save_with_history!
   end
 
   def preconditions_ok?(good_members = [])

+    raise OSM::APITooManyRelationMembersError.new(id, members.length, Settings.max_number_of_relation_members) if members.length > Settings.max_number_of_relation_members
+

     # These are hastables that store an id in the index of all
     # the nodes/way/relations that have already been added.
     # If the member is valid and visible then we add it to the
     # These are hastables that store an id in the index of all
     # the nodes/way/relations that have already been added.
     # If the member is valid and visible then we add it to the


@@ -247,24 +228,20 @@ class Relation < ActiveRecord::Base
 
       # use reflection to look up the appropriate class
       model = Kernel.const_get(m[0].capitalize)
 
       # use reflection to look up the appropriate class
       model = Kernel.const_get(m[0].capitalize)

-      # get the element with that ID
-      element = model.where(:id => m[1]).first
+      # get the element with that ID. and, if found, lock the element to
+      # ensure it can't be deleted until after the current transaction
+      # commits.
+      element = model.lock("for share").find_by(:id => m[1])

 
       # and check that it is OK to use.
 
       # and check that it is OK to use.

-      unless element && element.visible? && element.preconditions_ok?
-        fail OSM::APIPreconditionFailedError.new("Relation with id #{id} cannot be saved due to #{m[0]} with id #{m[1]}")
-      end
+      raise OSM::APIPreconditionFailedError, "Relation with id #{id} cannot be saved due to #{m[0]} with id #{m[1]}" unless element&.visible? && element&.preconditions_ok?
+

       hash[m[1]] = true
     end
 
     true
   end
 
       hash[m[1]] = true
     end
 
     true
   end
 

-  # Temporary method to match interface to nodes
-  def tags_as_hash
-    tags
-  end
-

   ##
   # if any members are referenced by placeholder IDs (i.e: negative) then
   # this calling this method will fix them using the map from placeholders
   ##
   # if any members are referenced by placeholder IDs (i.e: negative) then
   # this calling this method will fix them using the map from placeholders


@@ -272,9 +249,10 @@ class Relation < ActiveRecord::Base
   def fix_placeholders!(id_map, placeholder_id = nil)
     members.map! do |type, id, role|
       old_id = id.to_i
   def fix_placeholders!(id_map, placeholder_id = nil)
     members.map! do |type, id, role|
       old_id = id.to_i

-      if old_id < 0
+      if old_id.negative?

         new_id = id_map[type.downcase.to_sym][old_id]
         new_id = id_map[type.downcase.to_sym][old_id]

-        fail OSM::APIBadUserInput.new("Placeholder #{type} not found for reference #{old_id} in relation #{self.id.nil? ? placeholder_id : self.id}.") if new_id.nil?
+        raise OSM::APIBadUserInput, "Placeholder #{type} not found for reference #{old_id} in relation #{self.id.nil? ? placeholder_id : self.id}." if new_id.nil?
+

         [type, new_id, role]
       else
         [type, id, role]
         [type, new_id, role]
       else
         [type, id, role]


@@ -285,15 +263,19 @@ class Relation < ActiveRecord::Base
   private
 
   def save_with_history!
   private
 
   def save_with_history!

+    t = Time.now.utc
+
+    self.version += 1
+    self.timestamp = t
+

     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags
       # changed then we have to monitor their before and after state.
       tags_changed = false
 
     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags
       # changed then we have to monitor their before and after state.
       tags_changed = false
 

-      t = Time.now.getutc
-      self.version += 1
-      self.timestamp = t
-      self.save!
+      # clone the object before saving it so that the original is
+      # still marked as dirty if we retry the transaction
+      clone.save!

 
       tags = self.tags.clone
       relation_tags.each do |old_tag|
 
       tags = self.tags.clone
       relation_tags.each do |old_tag|


@@ -316,8 +298,8 @@ class Relation < ActiveRecord::Base
       end
       # if there are left-over tags then they are new and will have to
       # be added.
       end
       # if there are left-over tags then they are new and will have to
       # be added.

-      tags_changed |= (!tags.empty?)
-      RelationTag.delete_all(:relation_id => id)
+      tags_changed |= !tags.empty?
+      RelationTag.where(:relation_id => id).delete_all

       self.tags.each do |k, v|
         tag = RelationTag.new
         tag.relation_id = id
       self.tags.each do |k, v|
         tag = RelationTag.new
         tag.relation_id = id


@@ -347,7 +329,7 @@ class Relation < ActiveRecord::Base
       # members may be in a different order and i don't feel like implementing
       # a longest common subsequence algorithm to optimise this.
       members = self.members
       # members may be in a different order and i don't feel like implementing
       # a longest common subsequence algorithm to optimise this.
       members = self.members

-      RelationMember.delete_all(:relation_id => id)
+      RelationMember.where(:relation_id => id).delete_all

       members.each_with_index do |m, i|
         mem = RelationMember.new
         mem.relation_id = id
       members.each_with_index do |m, i|
         mem = RelationMember.new
         mem.relation_id = id


@@ -373,10 +355,12 @@ class Relation < ActiveRecord::Base
       # reasonable on the assumption that adding or removing members doesn't
       # materially change the rest of the relation.
       any_relations =
       # reasonable on the assumption that adding or removing members doesn't
       # materially change the rest of the relation.
       any_relations =

-        changed_members.collect { |_id, type| type == "relation" }
-        .inject(false) { |a, e| a || e }
+        changed_members.collect { |type, _id, _role| type == "Relation" }
+                       .inject(false) { |acc, elem| acc || elem }

 
 

-      update_members = if tags_changed || any_relations
+      # if the relation is being deleted tags_changed will be true and members empty
+      # so we need to use changed_members to create a correct bounding box
+      update_members = if visible && (tags_changed || any_relations)

                          # add all non-relation bounding boxes to the changeset
                          # FIXME: check for tag changes along with element deletions and
                          # make sure that the deleted element's bounding box is hit.
                          # add all non-relation bounding boxes to the changeset
                          # FIXME: check for tag changes along with element deletions and
                          # make sure that the deleted element's bounding box is hit.