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