Merge remote-tracking branch 'upstream/pull/3002'

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

diff --git a/app/models/trace.rb b/app/models/trace.rb
index 85c0244d5b89175e595e436119280feb7b8b8ec3..0860d2b31954e1a3d255594650b071443399f702 100644 (file)
--- a/app/models/trace.rb
+++ b/app/models/trace.rb
@@ -1,4 +1,33 @@
-class Trace < ActiveRecord::Base
+# == Schema Information
+#
+# Table name: gpx_files
+#
+#  id          :bigint(8)        not null, primary key
+#  user_id     :bigint(8)        not null
+#  visible     :boolean          default(TRUE), not null
+#  name        :string           default(""), not null
+#  size        :bigint(8)
+#  latitude    :float
+#  longitude   :float
+#  timestamp   :datetime         not null
+#  description :string           default(""), not null
+#  inserted    :boolean          not null
+#  visibility  :enum             default("public"), not null
+#
+# Indexes
+#
+#  gpx_files_timestamp_idx           (timestamp)
+#  gpx_files_user_id_idx             (user_id)
+#  gpx_files_visible_visibility_idx  (visible,visibility)
+#
+# Foreign Keys
+#
+#  gpx_files_user_id_fkey  (user_id => users.id)
+#
+
+class Trace < ApplicationRecord
+  require "open3"
+

   self.table_name = "gpx_files"
 
   belongs_to :user, :counter_cache => true
   self.table_name = "gpx_files"
 
   belongs_to :user, :counter_cache => true


@@ -7,21 +36,16 @@ class Trace < ActiveRecord::Base
 
   scope :visible, -> { where(:visible => true) }
   scope :visible_to, ->(u) { visible.where("visibility IN ('public', 'identifiable') OR user_id = ?", u) }
 
   scope :visible, -> { where(:visible => true) }
   scope :visible_to, ->(u) { visible.where("visibility IN ('public', 'identifiable') OR user_id = ?", u) }

-  scope :visible_to_all, -> { where(:visibility => %w(public identifiable)) }
+  scope :visible_to_all, -> { where(:visibility => %w[public identifiable]) }

   scope :tagged, ->(t) { joins(:tags).where(:gpx_file_tags => { :tag => t }) }
 
   validates :user, :presence => true, :associated => true
   scope :tagged, ->(t) { joins(:tags).where(:gpx_file_tags => { :tag => t }) }
 
   validates :user, :presence => true, :associated => true

-  validates :name, :presence => true, :length => 1..255
-  validates :description, :presence => { :on => :create }, :length => 1..255
+  validates :name, :presence => true, :length => 1..255, :characters => true
+  validates :description, :presence => { :on => :create }, :length => 1..255, :characters => true

   validates :timestamp, :presence => true
   validates :timestamp, :presence => true

-  validates :visibility, :inclusion => %w(private public trackable identifiable)
+  validates :visibility, :inclusion => %w[private public trackable identifiable]

 
 

-  def destroy
-    super
-    FileUtils.rm_f(trace_name)
-    FileUtils.rm_f(icon_picture_name)
-    FileUtils.rm_f(large_picture_name)
-  end
+  after_destroy :remove_files

 
   def tagstring
     tags.collect(&:tag).join(", ")
 
   def tagstring
     tags.collect(&:tag).join(", ")


@@ -29,7 +53,7 @@ class Trace < ActiveRecord::Base
 
   def tagstring=(s)
     self.tags = if s.include? ","
 
   def tagstring=(s)
     self.tags = if s.include? ","

-                  s.split(/\s*,\s*/).select { |tag| tag !~ /^\s*$/ }.collect do |tag|
+                  s.split(/\s*,\s*/).reject { |tag| tag =~ /^\s*$/ }.collect do |tag|

                     tt = Tracetag.new
                     tt.tag = tag
                     tt
                     tt = Tracetag.new
                     tt.tag = tag
                     tt


@@ -83,167 +107,130 @@ class Trace < ActiveRecord::Base
   end
 
   def large_picture_name
   end
 
   def large_picture_name

-    "#{GPX_IMAGE_DIR}/#{id}.gif"
+    "#{Settings.gpx_image_dir}/#{id}.gif"

   end
 
   def icon_picture_name
   end
 
   def icon_picture_name

-    "#{GPX_IMAGE_DIR}/#{id}_icon.gif"
+    "#{Settings.gpx_image_dir}/#{id}_icon.gif"

   end
 
   def trace_name
   end
 
   def trace_name

-    "#{GPX_TRACE_DIR}/#{id}.gpx"
+    "#{Settings.gpx_trace_dir}/#{id}.gpx"

   end
 
   def mime_type
   end
 
   def mime_type

-    filetype = `/usr/bin/file -bz #{trace_name}`.chomp
-    gzipped = filetype =~ /gzip compressed/
-    bzipped = filetype =~ /bzip2 compressed/
-    zipped = filetype =~ /Zip archive/
-    tarred = filetype =~ /tar archive/
-
-    mimetype = if gzipped
-                 "application/x-gzip"
-               elsif bzipped
-                 "application/x-bzip2"
-               elsif zipped
-                 "application/x-zip"
-               elsif tarred
-                 "application/x-tar"
-               else
-                 "application/gpx+xml"
-               end
-
-    mimetype
+    filetype = Open3.capture2("/usr/bin/file", "-Lbz", trace_name).first.chomp
+    gzipped = filetype.include?("gzip compressed")
+    bzipped = filetype.include?("bzip2 compressed")
+    zipped = filetype.include?("Zip archive")
+    tarred = filetype.include?("tar archive")
+
+    if gzipped
+      "application/x-gzip"
+    elsif bzipped
+      "application/x-bzip2"
+    elsif zipped
+      "application/x-zip"
+    elsif tarred
+      "application/x-tar"
+    else
+      "application/gpx+xml"
+    end

   end
 
   def extension_name
   end
 
   def extension_name

-    filetype = `/usr/bin/file -bz #{trace_name}`.chomp
-    gzipped = filetype =~ /gzip compressed/
-    bzipped = filetype =~ /bzip2 compressed/
-    zipped = filetype =~ /Zip archive/
-    tarred = filetype =~ /tar archive/
-
-    extension = if tarred && gzipped
-                  ".tar.gz"
-                elsif tarred && bzipped
-                  ".tar.bz2"
-                elsif tarred
-                  ".tar"
-                elsif gzipped
-                  ".gpx.gz"
-                elsif bzipped
-                  ".gpx.bz2"
-                elsif zipped
-                  ".zip"
-                else
-                  ".gpx"
-                end
-
-    extension
-  end
-
-  def to_xml
-    doc = OSM::API.new.get_xml_doc
-    doc.root << to_xml_node
-    doc
-  end
-
-  def to_xml_node
-    el1 = XML::Node.new "gpx_file"
-    el1["id"] = id.to_s
-    el1["name"] = name.to_s
-    el1["lat"] = latitude.to_s if inserted
-    el1["lon"] = longitude.to_s if inserted
-    el1["user"] = user.display_name
-    el1["visibility"] = visibility
-    el1["pending"] = inserted ? "false" : "true"
-    el1["timestamp"] = timestamp.xmlschema
-
-    el2 = XML::Node.new "description"
-    el2 << description
-    el1 << el2
-
-    tags.each do |tag|
-      el2 = XML::Node.new("tag")
-      el2 << tag.tag
-      el1 << el2
+    filetype = Open3.capture2("/usr/bin/file", "-Lbz", trace_name).first.chomp
+    gzipped = filetype.include?("gzip compressed")
+    bzipped = filetype.include?("bzip2 compressed")
+    zipped = filetype.include?("Zip archive")
+    tarred = filetype.include?("tar archive")
+
+    if tarred && gzipped
+      ".tar.gz"
+    elsif tarred && bzipped
+      ".tar.bz2"
+    elsif tarred
+      ".tar"
+    elsif gzipped
+      ".gpx.gz"
+    elsif bzipped
+      ".gpx.bz2"
+    elsif zipped
+      ".zip"
+    else
+      ".gpx"

     end
     end

-
-    el1

   end
 
   end
 

-  # Read in xml as text and return it's Node object representation
-  def self.from_xml(xml, create = false)
-    p = XML::Parser.string(xml)
+  def update_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/gpx_file")

 
 

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

     end
     end

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

   end
 
   end
 

-  def self.from_xml_node(pt, create = false)
-    trace = Trace.new
-
+  def update_from_xml_node(pt, create: false)

     raise OSM::APIBadXMLError.new("trace", pt, "visibility missing") if pt["visibility"].nil?
     raise OSM::APIBadXMLError.new("trace", pt, "visibility missing") if pt["visibility"].nil?

-    trace.visibility = pt["visibility"]
+
+    self.visibility = pt["visibility"]

 
     unless create
       raise OSM::APIBadXMLError.new("trace", pt, "ID is required when updating.") if pt["id"].nil?
 
     unless create
       raise OSM::APIBadXMLError.new("trace", pt, "ID is required when updating.") if pt["id"].nil?

-      trace.id = pt["id"].to_i
+
+      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

-      raise OSM::APIBadUserInput.new("ID of trace cannot be zero when updating.") if trace.id.zero?
+      raise OSM::APIBadUserInput, "ID of trace cannot be zero when updating." if id.zero?
+      raise OSM::APIBadUserInput, "The id in the url (#{self.id}) is not the same as provided in the xml (#{id})" unless self.id == id

     end
 
     # We don't care about the time, as it is explicitly set on create/update/delete
     # We don't care about the visibility as it is implicit based on the action
     # and set manually before the actual delete
     end
 
     # We don't care about the time, as it is explicitly set on create/update/delete
     # We don't care about the visibility as it is implicit based on the action
     # and set manually before the actual delete

-    trace.visible = true
+    self.visible = true

 
     description = pt.find("description").first
     raise OSM::APIBadXMLError.new("trace", pt, "description missing") if description.nil?
 
     description = pt.find("description").first
     raise OSM::APIBadXMLError.new("trace", pt, "description missing") if description.nil?

-    trace.description = description.content

 
 

-    pt.find("tag").each do |tag|
-      trace.tags.build(:tag => tag.content)
-    end
+    self.description = description.content

 
 

-    trace
+    self.tags = pt.find("tag").collect do |tag|
+      Tracetag.new(:tag => tag.content)
+    end

   end
 
   def xml_file
   end
 
   def xml_file

-    # TODO: *nix specific, could do to work on windows... would be functionally inferior though - check for '.gz'
-    filetype = `/usr/bin/file -bz #{trace_name}`.chomp
-    gzipped = filetype =~ /gzip compressed/
-    bzipped = filetype =~ /bzip2 compressed/
-    zipped = filetype =~ /Zip archive/
-    tarred = filetype =~ /tar archive/
+    filetype = Open3.capture2("/usr/bin/file", "-Lbz", trace_name).first.chomp
+    gzipped = filetype.include?("gzip compressed")
+    bzipped = filetype.include?("bzip2 compressed")
+    zipped = filetype.include?("Zip archive")
+    tarred = filetype.include?("tar archive")

 
     if gzipped || bzipped || zipped || tarred
 
     if gzipped || bzipped || zipped || tarred

-      tmpfile = Tempfile.new("trace.#{id}")
+      file = Tempfile.new("trace.#{id}")

 
       if tarred && gzipped
 
       if tarred && gzipped

-        system("tar -zxOf #{trace_name} > #{tmpfile.path}")
+        system("tar", "-zxOf", trace_name, :out => file.path)

       elsif tarred && bzipped
       elsif tarred && bzipped

-        system("tar -jxOf #{trace_name} > #{tmpfile.path}")
+        system("tar", "-jxOf", trace_name, :out => file.path)

       elsif tarred
       elsif tarred

-        system("tar -xOf #{trace_name} > #{tmpfile.path}")
+        system("tar", "-xOf", trace_name, :out => file.path)

       elsif gzipped
       elsif gzipped

-        system("gunzip -c #{trace_name} > #{tmpfile.path}")
+        system("gunzip", "-c", trace_name, :out => file.path)

       elsif bzipped
       elsif bzipped

-        system("bunzip2 -c #{trace_name} > #{tmpfile.path}")
+        system("bunzip2", "-c", trace_name, :out => file.path)

       elsif zipped
       elsif zipped

-        system("unzip -p #{trace_name} -x '__MACOSX/*' > #{tmpfile.path} 2> /dev/null")
+        system("unzip", "-p", trace_name, "-x", "__MACOSX/*", :out => file.path, :err => "/dev/null")

       end
 
       end
 

-      tmpfile.unlink
-
-      file = tmpfile.file
+      file.unlink

     else
       file = File.open(trace_name)
     end
     else
       file = File.open(trace_name)
     end


@@ -254,33 +241,46 @@ class Trace < ActiveRecord::Base
   def import
     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 
   def import
     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 

-    gpx = GPX::File.new(xml_file)
+    gpx = GPX::File.new(trace_name)

 
     f_lat = 0
     f_lon = 0
     first = true
 
     # If there are any existing points for this trace then delete them
 
     f_lat = 0
     f_lon = 0
     first = true
 
     # If there are any existing points for this trace then delete them

-    Tracepoint.delete_all(:gpx_id => id)
+    Tracepoint.where(:gpx_id => id).delete_all
+
+    gpx.points.each_slice(1_000) do |points|
+      # Gather the trace points together for a bulk import
+      tracepoints = []
+
+      points.each do |point|
+        if first
+          f_lat = point.latitude
+          f_lon = point.longitude
+          first = false
+        end
+
+        tp = Tracepoint.new
+        tp.lat = point.latitude
+        tp.lon = point.longitude
+        tp.altitude = point.altitude
+        tp.timestamp = point.timestamp
+        tp.gpx_id = id
+        tp.trackid = point.segment
+        tracepoints << tp
+      end

 
 

-    gpx.points do |point|
-      if first
-        f_lat = point.latitude
-        f_lon = point.longitude
-        first = false
+      # Run the before_save and before_create callbacks, and then import them in bulk with activerecord-import
+      tracepoints.each do |tp|
+        tp.run_callbacks(:save) { false }
+        tp.run_callbacks(:create) { false }

       end
 
       end
 

-      tp = Tracepoint.new
-      tp.lat = point.latitude
-      tp.lon = point.longitude
-      tp.altitude = point.altitude
-      tp.timestamp = point.timestamp
-      tp.gpx_id = id
-      tp.trackid = point.segment
-      tp.save!
+      Tracepoint.import!(tracepoints)

     end
 
     end
 

-    if gpx.actual_points > 0
+    if gpx.actual_points.positive?

       max_lat = Tracepoint.where(:gpx_id => id).maximum(:latitude)
       min_lat = Tracepoint.where(:gpx_id => id).minimum(:latitude)
       max_lon = Tracepoint.where(:gpx_id => id).maximum(:longitude)
       max_lat = Tracepoint.where(:gpx_id => id).maximum(:latitude)
       min_lat = Tracepoint.where(:gpx_id => id).minimum(:latitude)
       max_lon = Tracepoint.where(:gpx_id => id).maximum(:longitude)


@@ -304,4 +304,12 @@ class Trace < ActiveRecord::Base
 
     gpx
   end
 
     gpx
   end

+
+  private
+
+  def remove_files
+    FileUtils.rm_f(trace_name)
+    FileUtils.rm_f(icon_picture_name)
+    FileUtils.rm_f(large_picture_name)
+  end

 end
 end