Include description and tags in GPX details API response
[rails.git] / app / models / trace.rb
1 class Trace < ActiveRecord::Base
2   set_table_name 'gpx_files'
3
4   validates_presence_of :user_id, :name, :timestamp
5   validates_presence_of :description, :on => :create
6   validates_length_of :name, :maximum => 255
7   validates_length_of :description, :maximum => 255
8 #  validates_numericality_of :latitude, :longitude
9   validates_inclusion_of :inserted, :in => [ true, false ]
10   validates_inclusion_of :visibility, :in => ["private", "public", "trackable", "identifiable"]
11
12   belongs_to :user
13   has_many :tags, :class_name => 'Tracetag', :foreign_key => 'gpx_id', :dependent => :delete_all
14   has_many :points, :class_name => 'Tracepoint', :foreign_key => 'gpx_id', :dependent => :delete_all
15
16   def destroy
17     super
18     FileUtils.rm_f(trace_name)
19     FileUtils.rm_f(icon_picture_name)
20     FileUtils.rm_f(large_picture_name)
21   end
22
23   def tagstring
24     return tags.collect {|tt| tt.tag}.join(", ")
25   end
26
27   def tagstring=(s)
28     if s.include? ','
29       self.tags = s.split(/\s*,\s*/).select {|tag| tag !~ /^\s*$/}.collect {|tag|
30         tt = Tracetag.new
31         tt.tag = tag
32         tt
33       }
34     else
35       #do as before for backwards compatibility:
36       self.tags = s.split().collect {|tag|
37         tt = Tracetag.new
38         tt.tag = tag
39         tt
40       }
41     end
42   end
43
44   def public?
45     visibility == "public" || visibility == "identifiable"
46   end
47
48   def trackable?
49     visibility == "trackable" || visibility == "identifiable"
50   end
51
52   def identifiable?
53     visibility == "identifiable"
54   end
55
56   def large_picture= (data)
57     f = File.new(large_picture_name, "wb")
58     f.syswrite(data)
59     f.close
60   end
61   
62   def icon_picture= (data)
63     f = File.new(icon_picture_name, "wb")
64     f.syswrite(data)
65     f.close
66   end
67
68   def large_picture
69     f = File.new(large_picture_name, "rb")
70     logger.info "large picture file: '#{f.path}', bytes: #{File.size(f.path)}"
71     data = f.sysread(File.size(f.path))
72     logger.info "have read data, bytes: '#{data.length}'"
73     f.close
74     data
75   end
76   
77   def icon_picture
78     f = File.new(icon_picture_name, "rb")
79     logger.info "icon picture file: '#{f.path}'"
80     data = f.sysread(File.size(f.path))
81     f.close
82     data
83   end
84   
85   def large_picture_name
86     "#{GPX_IMAGE_DIR}/#{id}.gif"
87   end
88
89   def icon_picture_name
90     "#{GPX_IMAGE_DIR}/#{id}_icon.gif"
91   end
92
93   def trace_name
94     "#{GPX_TRACE_DIR}/#{id}.gpx"
95   end
96
97   def mime_type
98     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
99     gzipped = filetype =~ /gzip compressed/
100     bzipped = filetype =~ /bzip2 compressed/
101     zipped = filetype =~ /Zip archive/
102
103     if gzipped then
104       mimetype = "application/x-gzip"
105     elsif bzipped then
106       mimetype = "application/x-bzip2"
107     elsif zipped
108       mimetype = "application/x-zip"
109     else
110       mimetype = "text/xml"
111     end
112
113     return mimetype
114   end
115
116   def extension_name
117     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
118     gzipped = filetype =~ /gzip compressed/
119     bzipped = filetype =~ /bzip2 compressed/
120     zipped = filetype =~ /Zip archive/
121     tarred = filetype =~ /tar archive/
122
123     if tarred and gzipped then
124       extension = ".tar.gz"
125     elsif tarred and bzipped then
126       extension = ".tar.bz2"
127     elsif tarred
128       extension = ".tar"
129     elsif gzipped
130       extension = ".gpx.gz"
131     elsif bzipped
132       extension = ".gpx.bz2"
133     elsif zipped
134       extension = ".zip"
135     else
136       extension = ".gpx"
137     end
138
139     return extension
140   end
141
142   def to_xml
143     doc = OSM::API.new.get_xml_doc
144     doc.root << to_xml_node()
145     return doc
146   end
147
148   def to_xml_node
149     el1 = XML::Node.new 'gpx_file'
150     el1['id'] = self.id.to_s
151     el1['name'] = self.name.to_s
152     el1['lat'] = self.latitude.to_s if self.inserted
153     el1['lon'] = self.longitude.to_s if self.inserted
154     el1['user'] = self.user.display_name
155     el1['visibility'] = self.visibility
156     el1['pending'] = (!self.inserted).to_s
157     el1['timestamp'] = self.timestamp.xmlschema
158
159     el2 = XML::Node.new 'description'
160     el2 << self.description
161     el1 << el2
162
163     self.tags.each do |tag|
164       el2 = XML::Node.new('tag')
165       el2 << tag.tag
166       el1 << el2
167     end
168
169     return el1
170   end
171
172   def xml_file
173     # TODO *nix specific, could do to work on windows... would be functionally inferior though - check for '.gz'
174     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
175     gzipped = filetype =~ /gzip compressed/
176     bzipped = filetype =~ /bzip2 compressed/
177     zipped = filetype =~ /Zip archive/
178     tarred = filetype =~ /tar archive/
179
180     if gzipped or bzipped or zipped or tarred then
181       tmpfile = Tempfile.new("trace.#{id}");
182
183       if tarred and gzipped then
184         system("tar -zxOf #{trace_name} > #{tmpfile.path}")
185       elsif tarred and bzipped then
186         system("tar -jxOf #{trace_name} > #{tmpfile.path}")
187       elsif tarred
188         system("tar -xOf #{trace_name} > #{tmpfile.path}")
189       elsif gzipped
190         system("gunzip -c #{trace_name} > #{tmpfile.path}")
191       elsif bzipped
192         system("bunzip2 -c #{trace_name} > #{tmpfile.path}")
193       elsif zipped
194         system("unzip -p #{trace_name} -x '__MACOSX/*' > #{tmpfile.path}")
195       end
196
197       tmpfile.unlink
198
199       file = tmpfile.file
200     else
201       file = File.open(trace_name)
202     end
203
204     return file
205   end
206
207   def import
208     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
209
210     gpx = GPX::File.new(self.xml_file)
211
212     f_lat = 0
213     f_lon = 0
214     first = true
215
216     # If there are any existing points for this trace then delete
217     # them - we check for existing points first to avoid locking
218     # the table in the common case where there aren't any.
219     if Tracepoint.find(:first, :conditions => ['gpx_id = ?', self.id])
220       Tracepoint.delete_all(['gpx_id = ?', self.id])
221     end
222
223     gpx.points do |point|
224       if first
225         f_lat = point.latitude
226         f_lon = point.longitude
227         first = false
228       end
229
230       tp = Tracepoint.new
231       tp.lat = point.latitude
232       tp.lon = point.longitude
233       tp.altitude = point.altitude
234       tp.timestamp = point.timestamp
235       tp.gpx_id = id
236       tp.trackid = point.segment
237       tp.save!
238     end
239
240     if gpx.actual_points > 0
241       max_lat = Tracepoint.maximum('latitude', :conditions => ['gpx_id = ?', id])
242       min_lat = Tracepoint.minimum('latitude', :conditions => ['gpx_id = ?', id])
243       max_lon = Tracepoint.maximum('longitude', :conditions => ['gpx_id = ?', id])
244       min_lon = Tracepoint.minimum('longitude', :conditions => ['gpx_id = ?', id])
245
246       max_lat = max_lat.to_f / 10000000
247       min_lat = min_lat.to_f / 10000000
248       max_lon = max_lon.to_f / 10000000
249       min_lon = min_lon.to_f / 10000000
250
251       self.latitude = f_lat
252       self.longitude = f_lon
253       self.large_picture = gpx.picture(min_lat, min_lon, max_lat, max_lon, gpx.actual_points)
254       self.icon_picture = gpx.icon(min_lat, min_lon, max_lat, max_lon)
255       self.size = gpx.actual_points
256       self.inserted = true
257       self.save!
258     end
259
260     logger.info "done trace #{id}"
261
262     return gpx
263   end
264 end