app/models/trace.rb

   1 class Trace < ActiveRecord::Base
   2   self.table_name = "gpx_files"
   3
   4   belongs_to :user, :counter_cache => true
   5   has_many :tags, :class_name => 'Tracetag', :foreign_key => 'gpx_id', :dependent => :delete_all
   6   has_many :points, :class_name => 'Tracepoint', :foreign_key => 'gpx_id', :dependent => :delete_all
   7
   8   scope :visible, -> { where(:visible => true) }
   9   scope :visible_to, ->(u) { visible.where("visibility IN ('public', 'identifiable') OR user_id = ?", u) }
  10   scope :visible_to_all, -> { where(:visibility => %w(public identifiable)) }
  11   scope :tagged, ->(t) { joins(:tags).where(:gpx_file_tags => { :tag => t }) }
  12
  13   validates_presence_of :user_id, :name, :timestamp
  14   validates_presence_of :description, :on => :create
  15   validates_length_of :name, :maximum => 255
  16   validates_length_of :description, :maximum => 255
  17   #  validates_numericality_of :latitude, :longitude
  18   validates_inclusion_of :inserted, :in => [true, false]
  19   validates_inclusion_of :visibility, :in => %w(private public trackable identifiable)
  20
  21   def destroy
  22     super
  23     FileUtils.rm_f(trace_name)
  24     FileUtils.rm_f(icon_picture_name)
  25     FileUtils.rm_f(large_picture_name)
  26   end
  27
  28   def tagstring
  29     tags.collect(&:tag).join(", ")
  30   end
  31
  32   def tagstring=(s)
  33     if s.include? ','
  34       self.tags = s.split(/\s*,\s*/).select { |tag| tag !~ /^\s*$/ }.collect {|tag|
  35         tt = Tracetag.new
  36         tt.tag = tag
  37         tt
  38       }
  39     else
  40       # do as before for backwards compatibility:
  41       self.tags = s.split.collect {|tag|
  42         tt = Tracetag.new
  43         tt.tag = tag
  44         tt
  45       }
  46     end
  47   end
  48
  49   def public?
  50     visibility == "public" || visibility == "identifiable"
  51   end
  52
  53   def trackable?
  54     visibility == "trackable" || visibility == "identifiable"
  55   end
  56
  57   def identifiable?
  58     visibility == "identifiable"
  59   end
  60
  61   def large_picture=(data)
  62     f = File.new(large_picture_name, "wb")
  63     f.syswrite(data)
  64     f.close
  65   end
  66
  67   def icon_picture=(data)
  68     f = File.new(icon_picture_name, "wb")
  69     f.syswrite(data)
  70     f.close
  71   end
  72
  73   def large_picture
  74     f = File.new(large_picture_name, "rb")
  75     logger.info "large picture file: '#{f.path}', bytes: #{File.size(f.path)}"
  76     data = f.sysread(File.size(f.path))
  77     logger.info "have read data, bytes: '#{data.length}'"
  78     f.close
  79     data
  80   end
  81
  82   def icon_picture
  83     f = File.new(icon_picture_name, "rb")
  84     logger.info "icon picture file: '#{f.path}'"
  85     data = f.sysread(File.size(f.path))
  86     f.close
  87     data
  88   end
  89
  90   def large_picture_name
  91     "#{GPX_IMAGE_DIR}/#{id}.gif"
  92   end
  93
  94   def icon_picture_name
  95     "#{GPX_IMAGE_DIR}/#{id}_icon.gif"
  96   end
  97
  98   def trace_name
  99     "#{GPX_TRACE_DIR}/#{id}.gpx"
 100   end
 101
 102   def mime_type
 103     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
 104     gzipped = filetype =~ /gzip compressed/
 105     bzipped = filetype =~ /bzip2 compressed/
 106     zipped = filetype =~ /Zip archive/
 107
 108     if gzipped
 109       mimetype = "application/x-gzip"
 110     elsif bzipped
 111       mimetype = "application/x-bzip2"
 112     elsif zipped
 113       mimetype = "application/x-zip"
 114     else
 115       mimetype = "application/gpx+xml"
 116     end
 117
 118     mimetype
 119   end
 120
 121   def extension_name
 122     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
 123     gzipped = filetype =~ /gzip compressed/
 124     bzipped = filetype =~ /bzip2 compressed/
 125     zipped = filetype =~ /Zip archive/
 126     tarred = filetype =~ /tar archive/
 127
 128     if tarred && gzipped
 129       extension = ".tar.gz"
 130     elsif tarred && bzipped
 131       extension = ".tar.bz2"
 132     elsif tarred
 133       extension = ".tar"
 134     elsif gzipped
 135       extension = ".gpx.gz"
 136     elsif bzipped
 137       extension = ".gpx.bz2"
 138     elsif zipped
 139       extension = ".zip"
 140     else
 141       extension = ".gpx"
 142     end
 143
 144     extension
 145   end
 146
 147   def to_xml
 148     doc = OSM::API.new.get_xml_doc
 149     doc.root << to_xml_node
 150     doc
 151   end
 152
 153   def to_xml_node
 154     el1 = XML::Node.new 'gpx_file'
 155     el1['id'] = id.to_s
 156     el1['name'] = name.to_s
 157     el1['lat'] = latitude.to_s if inserted
 158     el1['lon'] = longitude.to_s if inserted
 159     el1['user'] = user.display_name
 160     el1['visibility'] = visibility
 161     el1['pending'] = (!inserted).to_s
 162     el1['timestamp'] = timestamp.xmlschema
 163
 164     el2 = XML::Node.new 'description'
 165     el2 << description
 166     el1 << el2
 167
 168     tags.each do |tag|
 169       el2 = XML::Node.new('tag')
 170       el2 << tag.tag
 171       el1 << el2
 172     end
 173
 174     el1
 175   end
 176
 177   # Read in xml as text and return it's Node object representation
 178   def self.from_xml(xml, create = false)
 179     p = XML::Parser.string(xml)
 180     doc = p.parse
 181
 182     doc.find('//osm/gpx_file').each do |pt|
 183       return Trace.from_xml_node(pt, create)
 184     end
 185
 186     fail OSM::APIBadXMLError.new("trace", xml, "XML doesn't contain an osm/gpx_file element.")
 187   rescue LibXML::XML::Error, ArgumentError => ex
 188     raise OSM::APIBadXMLError.new("trace", xml, ex.message)
 189   end
 190
 191   def self.from_xml_node(pt, create = false)
 192     trace = Trace.new
 193
 194     fail OSM::APIBadXMLError.new("trace", pt, "visibility missing") if pt['visibility'].nil?
 195     trace.visibility = pt['visibility']
 196
 197     unless create
 198       fail OSM::APIBadXMLError.new("trace", pt, "ID is required when updating.") if pt['id'].nil?
 199       trace.id = pt['id'].to_i
 200       # .to_i will return 0 if there is no number that can be parsed.
 201       # We want to make sure that there is no id with zero anyway
 202       fail OSM::APIBadUserInput.new("ID of trace cannot be zero when updating.") if trace.id == 0
 203     end
 204
 205     # We don't care about the time, as it is explicitly set on create/update/delete
 206     # We don't care about the visibility as it is implicit based on the action
 207     # and set manually before the actual delete
 208     trace.visible = true
 209
 210     description = pt.find('description').first
 211     fail OSM::APIBadXMLError.new("trace", pt, "description missing") if description.nil?
 212     trace.description = description.content
 213
 214     pt.find('tag').each do |tag|
 215       trace.tags.build(:tag => tag.content)
 216     end
 217
 218     trace
 219   end
 220
 221   def xml_file
 222     # TODO *nix specific, could do to work on windows... would be functionally inferior though - check for '.gz'
 223     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
 224     gzipped = filetype =~ /gzip compressed/
 225     bzipped = filetype =~ /bzip2 compressed/
 226     zipped = filetype =~ /Zip archive/
 227     tarred = filetype =~ /tar archive/
 228
 229     if gzipped || bzipped || zipped || tarred
 230       tmpfile = Tempfile.new("trace.#{id}")
 231
 232       if tarred && gzipped
 233         system("tar -zxOf #{trace_name} > #{tmpfile.path}")
 234       elsif tarred && bzipped
 235         system("tar -jxOf #{trace_name} > #{tmpfile.path}")
 236       elsif tarred
 237         system("tar -xOf #{trace_name} > #{tmpfile.path}")
 238       elsif gzipped
 239         system("gunzip -c #{trace_name} > #{tmpfile.path}")
 240       elsif bzipped
 241         system("bunzip2 -c #{trace_name} > #{tmpfile.path}")
 242       elsif zipped
 243         system("unzip -p #{trace_name} -x '__MACOSX/*' > #{tmpfile.path}")
 244       end
 245
 246       tmpfile.unlink
 247
 248       file = tmpfile.file
 249     else
 250       file = File.open(trace_name)
 251     end
 252
 253     file
 254   end
 255
 256   def import
 257     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 258
 259     gpx = GPX::File.new(xml_file)
 260
 261     f_lat = 0
 262     f_lon = 0
 263     first = true
 264
 265     # If there are any existing points for this trace then delete
 266     # them - we check for existing points first to avoid locking
 267     # the table in the common case where there aren't any.
 268     if Tracepoint.where(:gpx_id => id).exists?
 269       Tracepoint.delete_all(:gpx_id => id)
 270     end
 271
 272     gpx.points do |point|
 273       if first
 274         f_lat = point.latitude
 275         f_lon = point.longitude
 276         first = false
 277       end
 278
 279       tp = Tracepoint.new
 280       tp.lat = point.latitude
 281       tp.lon = point.longitude
 282       tp.altitude = point.altitude
 283       tp.timestamp = point.timestamp
 284       tp.gpx_id = id
 285       tp.trackid = point.segment
 286       tp.save!
 287     end
 288
 289     if gpx.actual_points > 0
 290       max_lat = Tracepoint.where(:gpx_id => id).maximum(:latitude)
 291       min_lat = Tracepoint.where(:gpx_id => id).minimum(:latitude)
 292       max_lon = Tracepoint.where(:gpx_id => id).maximum(:longitude)
 293       min_lon = Tracepoint.where(:gpx_id => id).minimum(:longitude)
 294
 295       max_lat = max_lat.to_f / 10000000
 296       min_lat = min_lat.to_f / 10000000
 297       max_lon = max_lon.to_f / 10000000
 298       min_lon = min_lon.to_f / 10000000
 299
 300       self.latitude = f_lat
 301       self.longitude = f_lon
 302       self.large_picture = gpx.picture(min_lat, min_lon, max_lat, max_lon, gpx.actual_points)
 303       self.icon_picture = gpx.icon(min_lat, min_lon, max_lat, max_lon)
 304       self.size = gpx.actual_points
 305       self.inserted = true
 306       self.save!
 307     end
 308
 309     logger.info "done trace #{id}"
 310
 311     gpx
 312   end
 313 end