Fix some issues and improve code

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

diff --git a/app/models/trace.rb b/app/models/trace.rb
index 1b44e218717cdea042dc30ce7f0359d719609e37..5096a81aafcb7e69e9b77d8d90b3fd9f933ec545 100644 (file)
--- a/app/models/trace.rb
+++ b/app/models/trace.rb
@@ -1,16 +1,47 @@
+# == Schema Information
+#
+# Table name: gpx_files
+#
+#  id          :integer          not null, primary key
+#  user_id     :integer          not null
+#  visible     :boolean          default(TRUE), not null
+#  name        :string           default(""), not null
+#  size        :integer
+#  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 < ActiveRecord::Base
 class Trace < ActiveRecord::Base

-  set_table_name 'gpx_files'
-
-  validates_presence_of :user_id, :name, :timestamp
-  validates_presence_of :description, :on => :create
-  validates_length_of :name, :within => 1..255
-  validates_length_of :description, :within => 1..255
-#  validates_numericality_of :latitude, :longitude
-  validates_inclusion_of :public, :inserted, :in => [ true, false]
-  
-  belongs_to :user
-  has_many :tags, :class_name => 'Tracetag', :foreign_key => 'gpx_id', :dependent => :delete_all
-  has_many :points, :class_name => 'Tracepoint', :foreign_key => 'gpx_id', :dependent => :delete_all
+  self.table_name = "gpx_files"
+
+  belongs_to :user, :counter_cache => true
+  has_many :tags, :class_name => "Tracetag", :foreign_key => "gpx_id", :dependent => :delete_all
+  has_many :points, :class_name => "Tracepoint", :foreign_key => "gpx_id", :dependent => :delete_all
+
+  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 :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 :timestamp, :presence => true
+  validates :visibility, :inclusion => %w[private public trackable identifiable]

 
   def destroy
     super
 
   def destroy
     super


@@ -20,24 +51,45 @@ class Trace < ActiveRecord::Base
   end
 
   def tagstring
   end
 
   def tagstring

-    return tags.collect {|tt| tt.tag}.join(" ")
+    tags.collect(&:tag).join(", ")

   end
 
   def tagstring=(s)
   end
 
   def tagstring=(s)

-    self.tags = s.split().collect {|tag|
-      tt = Tracetag.new
-      tt.tag = tag
-      tt
-    }
-  end
-  
-  def large_picture= (data)
+    self.tags = if s.include? ","
+                  s.split(/\s*,\s*/).reject { |tag| tag =~ /^\s*$/ }.collect do |tag|
+                    tt = Tracetag.new
+                    tt.tag = tag
+                    tt
+                  end
+                else
+                  # do as before for backwards compatibility:
+                  s.split.collect do |tag|
+                    tt = Tracetag.new
+                    tt.tag = tag
+                    tt
+                  end
+                end
+  end
+
+  def public?
+    visibility == "public" || visibility == "identifiable"
+  end
+
+  def trackable?
+    visibility == "trackable" || visibility == "identifiable"
+  end
+
+  def identifiable?
+    visibility == "identifiable"
+  end
+
+  def large_picture=(data)

     f = File.new(large_picture_name, "wb")
     f.syswrite(data)
     f.close
   end
     f = File.new(large_picture_name, "wb")
     f.syswrite(data)
     f.close
   end

-  
-  def icon_picture= (data)
+
+  def icon_picture=(data)

     f = File.new(icon_picture_name, "wb")
     f.syswrite(data)
     f.close
     f = File.new(icon_picture_name, "wb")
     f.syswrite(data)
     f.close


@@ -45,21 +97,18 @@ class Trace < ActiveRecord::Base
 
   def large_picture
     f = File.new(large_picture_name, "rb")
 
   def large_picture
     f = File.new(large_picture_name, "rb")

-    logger.info "large picture file: '#{f.path}', bytes: #{File.size(f.path)}"

     data = f.sysread(File.size(f.path))
     data = f.sysread(File.size(f.path))

-    logger.info "have read data, bytes: '#{data.length}'"

     f.close
     data
   end
     f.close
     data
   end

-  
+

   def icon_picture
     f = File.new(icon_picture_name, "rb")
   def icon_picture
     f = File.new(icon_picture_name, "rb")

-    logger.info "icon picture file: '#{f.path}'"

     data = f.sysread(File.size(f.path))
     f.close
     data
   end
     data = f.sysread(File.size(f.path))
     f.close
     data
   end

-  
+

   def large_picture_name
     "#{GPX_IMAGE_DIR}/#{id}.gif"
   end
   def large_picture_name
     "#{GPX_IMAGE_DIR}/#{id}.gif"
   end


@@ -73,83 +122,140 @@ class Trace < ActiveRecord::Base
   end
 
   def mime_type
   end
 
   def mime_type

-    filetype = `/usr/bin/file -bz #{trace_name}`.chomp
+    filetype = `/usr/bin/file -Lbz #{trace_name}`.chomp

     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/

+    tarred = filetype =~ /tar archive/

 
 

-    if gzipped then
-      mimetype = "application/x-gzip"
-    elsif bzipped then
-      mimetype = "application/x-bzip2"
-    elsif zipped
-      mimetype = "application/x-zip"
-    else
-      mimetype = "text/xml"
-    end
-
-    return mimetype
+    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

   end
 
   def extension_name
   end
 
   def extension_name

-    filetype = `/usr/bin/file -bz #{trace_name}`.chomp
+    filetype = `/usr/bin/file -Lbz #{trace_name}`.chomp

     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 
     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 

-    if tarred and gzipped then
-      extension = ".tar.gz"
-    elsif tarred and bzipped then
-      extension = ".tar.bz2"
-    elsif tarred
-      extension = ".tar"
-    elsif gzipped
-      extension = ".gpx.gz"
-    elsif bzipped
-      extension = ".gpx.bz2"
-    elsif zipped
-      extension = ".zip"
-    else
-      extension = ".gpx"
-    end
-
-    return extension
+    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
   end
 
   def to_xml
     doc = OSM::API.new.get_xml_doc

-    doc.root << to_xml_node()
-    return doc
+    doc.root << to_xml_node
+    doc

   end
 
   def to_xml_node
   end
 
   def to_xml_node

-    el1 = XML::Node.new 'gpx_file'
-    el1['id'] = self.id.to_s
-    el1['name'] = self.name.to_s
-    el1['lat'] = self.latitude.to_s
-    el1['lon'] = self.longitude.to_s
-    el1['user'] = self.user.display_name
-    el1['public'] = self.public.to_s
-    el1['pending'] = (!self.inserted).to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-    return el1
+    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
+    end
+
+    el1
+  end
+
+  def update_from_xml(xml, create = false)
+    p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
+    doc = p.parse
+
+    doc.find("//osm/gpx_file").each do |pt|
+      return update_from_xml_node(pt, create)
+    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)
+  end
+
+  def update_from_xml_node(pt, create = false)
+    raise OSM::APIBadXMLError.new("trace", pt, "visibility missing") if pt["visibility"].nil?
+
+    self.visibility = pt["visibility"]
+
+    unless create
+      raise OSM::APIBadXMLError.new("trace", pt, "ID is required when updating.") if pt["id"].nil?
+
+      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
+      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
+    self.visible = true
+
+    description = pt.find("description").first
+    raise OSM::APIBadXMLError.new("trace", pt, "description missing") if description.nil?
+
+    self.description = description.content
+
+    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
+    # TODO: *nix specific, could do to work on windows... would be functionally inferior though - check for '.gz'
+    filetype = `/usr/bin/file -Lbz #{trace_name}`.chomp

     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 
     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 

-    if gzipped or bzipped or zipped or tarred then
-      tmpfile = Tempfile.new("trace.#{id}");
+    if gzipped || bzipped || zipped || tarred
+      tmpfile = Tempfile.new("trace.#{id}")

 
 

-      if tarred and gzipped then
+      if tarred && gzipped

         system("tar -zxOf #{trace_name} > #{tmpfile.path}")
         system("tar -zxOf #{trace_name} > #{tmpfile.path}")

-      elsif tarred and bzipped then
+      elsif tarred && bzipped

         system("tar -jxOf #{trace_name} > #{tmpfile.path}")
       elsif tarred
         system("tar -xOf #{trace_name} > #{tmpfile.path}")
         system("tar -jxOf #{trace_name} > #{tmpfile.path}")
       elsif tarred
         system("tar -xOf #{trace_name} > #{tmpfile.path}")


@@ -158,7 +264,7 @@ class Trace < ActiveRecord::Base
       elsif bzipped
         system("bunzip2 -c #{trace_name} > #{tmpfile.path}")
       elsif zipped
       elsif bzipped
         system("bunzip2 -c #{trace_name} > #{tmpfile.path}")
       elsif zipped

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

       end
 
       tmpfile.unlink
       end
 
       tmpfile.unlink


@@ -168,24 +274,20 @@ class Trace < ActiveRecord::Base
       file = File.open(trace_name)
     end
 
       file = File.open(trace_name)
     end
 

-    return file
+    file

   end
 
   def import
     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 
   end
 
   def import
     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 

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

 
     f_lat = 0
     f_lon = 0
     first = true
 
 
     f_lat = 0
     f_lon = 0
     first = true
 

-    # If there are any existing points for this trace then delete
-    # them - we check for existing points first to avoid locking
-    # the table in the common case where there aren't any.
-    if Tracepoint.find(:first, :conditions => ['gpx_id = ?', self.id])
-      Tracepoint.delete_all(['gpx_id = ?', self.id])
-    end
+    # If there are any existing points for this trace then delete them
+    Tracepoint.where(:gpx_id => id).delete_all

 
     gpx.points do |point|
       if first
 
     gpx.points do |point|
       if first


@@ -204,11 +306,11 @@ class Trace < ActiveRecord::Base
       tp.save!
     end
 
       tp.save!
     end
 

-    if gpx.actual_points > 0
-      max_lat = Tracepoint.maximum('latitude', :conditions => ['gpx_id = ?', id])
-      min_lat = Tracepoint.minimum('latitude', :conditions => ['gpx_id = ?', id])
-      max_lon = Tracepoint.maximum('longitude', :conditions => ['gpx_id = ?', id])
-      min_lon = Tracepoint.minimum('longitude', :conditions => ['gpx_id = ?', id])
+    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)
+      min_lon = Tracepoint.where(:gpx_id => id).minimum(:longitude)

 
       max_lat = max_lat.to_f / 10000000
       min_lat = min_lat.to_f / 10000000
 
       max_lat = max_lat.to_f / 10000000
       min_lat = min_lat.to_f / 10000000


@@ -221,11 +323,11 @@ class Trace < ActiveRecord::Base
       self.icon_picture = gpx.icon(min_lat, min_lon, max_lat, max_lon)
       self.size = gpx.actual_points
       self.inserted = true
       self.icon_picture = gpx.icon(min_lat, min_lon, max_lat, max_lon)
       self.size = gpx.actual_points
       self.inserted = true

-      self.save!
+      save!

     end
 
     logger.info "done trace #{id}"
 
     end
 
     logger.info "done trace #{id}"
 

-    return gpx
+    gpx

   end
 end
   end
 end