Adding initial version of the OAuth token authentication method. This adds basic...
[rails.git] / app / controllers / trace_controller.rb
1 class TraceController < ApplicationController
2   layout 'site'
3
4   before_filter :authorize_web
5   before_filter :set_locale
6   before_filter :require_user, :only => [:mine, :create, :edit, :delete, :make_public]
7   before_filter :authorize, :only => [:api_details, :api_data, :api_create]
8   before_filter :check_database_readable, :except => [:api_details, :api_data, :api_create]
9   before_filter :check_database_writable, :only => [:create, :edit, :delete, :make_public]
10   before_filter :check_api_readable, :only => [:api_details, :api_data]
11   before_filter :check_api_writable, :only => [:api_create]
12   before_filter :require_allow_read_gpx, :only => [:api_details, :api_data]
13   before_filter :require_allow_write_gpx, :only => [:api_create]
14  
15   # Counts and selects pages of GPX traces for various criteria (by user, tags, public etc.).
16   #  target_user - if set, specifies the user to fetch traces for.  if not set will fetch all traces
17   def list(target_user = nil, action = "list")
18     # from display name, pick up user id if one user's traces only
19     display_name = params[:display_name]
20     if target_user.nil? and !display_name.blank?
21       target_user = User.find(:first, :conditions => [ "visible = ? and display_name = ?", true, display_name])
22       if target_user.nil?
23         @title = t'trace.no_such_user.title'
24         @not_found_user = display_name
25         render :action => 'no_such_user', :status => :not_found
26         return
27       end
28     end
29
30     # set title
31     if target_user.nil?
32       @title = t 'trace.list.public_traces'
33     elsif @user and @user == target_user
34       @title = t 'trace.list.your_traces'
35     else
36       @title = t 'trace.list.public_traces_from', :user => target_user.display_name
37     end
38
39     @title += t 'trace.list.tagged_with', :tags => params[:tag] if params[:tag]
40
41     # four main cases:
42     # 1 - all traces, logged in = all public traces + all user's (i.e + all mine)
43     # 2 - all traces, not logged in = all public traces
44     # 3 - user's traces, logged in as same user = all user's traces 
45     # 4 - user's traces, not logged in as that user = all user's public traces
46     if target_user.nil? # all traces
47       if @user
48         conditions = ["(gpx_files.public = ? OR gpx_files.user_id = ?)", true, @user.id] #1
49       else
50         conditions  = ["gpx_files.public = ?", true] #2
51       end
52     else
53       if @user and @user == target_user
54         conditions = ["gpx_files.user_id = ?", @user.id] #3 (check vs user id, so no join + can't pick up non-public traces by changing name)
55       else
56         conditions = ["gpx_files.public = ? AND gpx_files.user_id = ?", true, target_user.id] #4
57       end
58     end
59     
60     if params[:tag]
61       @tag = params[:tag]
62
63       files = Tracetag.find_all_by_tag(params[:tag]).collect { |tt| tt.gpx_id }
64
65       if files.length > 0
66         conditions[0] += " AND gpx_files.id IN (#{files.join(',')})"
67       else
68         conditions[0] += " AND 0 = 1"
69       end
70     end
71     
72     conditions[0] += " AND gpx_files.visible = ?"
73     conditions << true
74
75     @trace_pages, @traces = paginate(:traces,
76                                      :include => [:user, :tags],
77                                      :conditions => conditions,
78                                      :order => "gpx_files.timestamp DESC",
79                                      :per_page => 20)
80
81     # put together SET of tags across traces, for related links
82     tagset = Hash.new
83     if @traces
84       @traces.each do |trace|
85         trace.tags.reload if params[:tag] # if searched by tag, ActiveRecord won't bring back other tags, so do explicitly here
86         trace.tags.each do |tag|
87           tagset[tag.tag] = tag.tag
88         end
89       end
90     end
91     
92     # final helper vars for view
93     @action = action
94     @display_name = target_user.display_name if target_user
95     @all_tags = tagset.values
96   end
97
98   def mine
99     # Load the preference of whether the user set the trace public the last time
100     @trace = Trace.new
101     if @user.preferences.find(:first, :conditions => {:k => "gps.trace.public", :v => "default"}).nil?
102       @trace.public = false
103     else 
104       @trace.public = true
105     end
106     list(@user, "mine")
107   end
108
109   def view
110     @trace = Trace.find(params[:id])
111
112     if @trace and @trace.visible? and
113        (@trace.public? or @trace.user == @user)
114       @title = t 'trace.view.viewing_trace', :name => @trace.name
115     else
116       flash[:notice] = t 'trace.view.trace_not_found'
117       redirect_to :controller => 'trace', :action => 'list'
118     end
119   rescue ActiveRecord::RecordNotFound
120     flash[:notice] = t 'trace.view.trace_not_found'
121     redirect_to :controller => 'trace', :action => 'list'
122   end
123
124   def create
125     if params[:trace]
126       logger.info(params[:trace][:gpx_file].class.name)
127       if params[:trace][:gpx_file].respond_to?(:read)
128         do_create(params[:trace][:gpx_file], params[:trace][:tagstring],
129                   params[:trace][:description], params[:trace][:public])
130
131         if @trace.id
132           logger.info("id is #{@trace.id}")
133           flash[:notice] = t 'trace.create.trace_uploaded'
134
135           redirect_to :action => 'mine'
136         end
137       else
138         @trace = Trace.new({:name => "Dummy",
139                             :tagstring => params[:trace][:tagstring],
140                             :description => params[:trace][:description],
141                             :public => params[:trace][:public],
142                             :inserted => false, :user => @user,
143                             :timestamp => Time.now.getutc})
144         @trace.valid?
145         @trace.errors.add(:gpx_file, "can't be blank")
146       end
147     end
148     @title = t 'trace.create.upload_trace'
149   end
150
151   def data
152     trace = Trace.find(params[:id])
153
154     if trace.visible? and (trace.public? or (@user and @user == trace.user))
155       if request.format == Mime::XML
156         send_file(trace.xml_file, :filename => "#{trace.id}.xml", :type => Mime::XML.to_s, :disposition => 'attachment')
157       else
158         send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
159       end
160     else
161       render :nothing => true, :status => :not_found
162     end
163   rescue ActiveRecord::RecordNotFound
164     render :nothing => true, :status => :not_found
165   end
166
167   def edit
168     @trace = Trace.find(params[:id])
169
170     if @user and @trace.user == @user
171       if params[:trace]
172         @trace.description = params[:trace][:description]
173         @trace.tagstring = params[:trace][:tagstring]
174         if @trace.save
175           redirect_to :action => 'view'
176         end        
177       end
178     else
179       render :nothing => true, :status => :forbidden
180     end
181   rescue ActiveRecord::RecordNotFound
182     render :nothing => true, :status => :not_found
183   end
184
185   def delete
186     trace = Trace.find(params[:id])
187
188     if @user and trace.user == @user
189       if request.post? and trace.visible?
190         trace.visible = false
191         trace.save
192         flash[:notice] = t 'trace.delete.scheduled_for_deletion'
193         redirect_to :controller => 'traces', :action => 'mine'
194       else
195         render :nothing => true, :status => :bad_request
196       end
197     else
198       render :nothing => true, :status => :forbidden
199     end
200   rescue ActiveRecord::RecordNotFound
201     render :nothing => true, :status => :not_found
202   end
203
204   def make_public
205     trace = Trace.find(params[:id])
206
207     if @user and trace.user == @user
208       if request.post? and !trace.public?
209         trace.public = true
210         trace.save
211         flash[:notice] = t 'trace.make_public.made_public'
212         redirect_to :controller => 'trace', :action => 'view', :id => params[:id]
213       else
214         render :nothing => true, :status => :bad_request
215       end
216     else
217       render :nothing => true, :status => :forbidden
218     end
219   rescue ActiveRecord::RecordNotFound
220     render :nothing => true, :status => :not_found
221   end
222
223   def georss
224     conditions = ["gpx_files.public = ?", true]
225
226     if params[:display_name]
227       conditions[0] += " AND users.display_name = ?"
228       conditions << params[:display_name]
229     end
230
231     if params[:tag]
232       conditions[0] += " AND EXISTS (SELECT * FROM gpx_file_tags AS gft WHERE gft.gpx_id = gpx_files.id AND gft.tag = ?)"
233       conditions << params[:tag]
234     end
235
236     traces = Trace.find(:all, :include => :user, :conditions => conditions, 
237                         :order => "timestamp DESC", :limit => 20)
238
239     rss = OSM::GeoRSS.new
240
241     traces.each do |trace|
242       rss.add(trace.latitude, trace.longitude, trace.name, trace.user.display_name, url_for({:controller => 'trace', :action => 'view', :id => trace.id, :display_name => trace.user.display_name}), "<img src='#{url_for({:controller => 'trace', :action => 'icon', :id => trace.id, :user_login => trace.user.display_name})}'> GPX file with #{trace.size} points from #{trace.user.display_name}", trace.timestamp)
243     end
244
245     render :text => rss.to_s, :content_type => "application/rss+xml"
246   end
247
248   def picture
249     trace = Trace.find(params[:id])
250
251     if trace.inserted?
252       if trace.public? or (@user and @user == trace.user)
253         expires_in 7.days, :private => !trace.public, :public => trace.public
254         send_file(trace.large_picture_name, :filename => "#{trace.id}.gif", :type => 'image/gif', :disposition => 'inline')
255       else
256         render :nothing => true, :status => :forbidden
257       end
258     else
259       render :nothing => true, :status => :not_found
260     end
261   rescue ActiveRecord::RecordNotFound
262     render :nothing => true, :status => :not_found
263   end
264
265   def icon
266     trace = Trace.find(params[:id])
267
268     if trace.inserted?
269       if trace.public? or (@user and @user == trace.user)
270         expires_in 7.days, :private => !trace.public, :public => trace.public
271         send_file(trace.icon_picture_name, :filename => "#{trace.id}_icon.gif", :type => 'image/gif', :disposition => 'inline')
272       else
273         render :nothing => true, :status => :forbidden
274       end
275     else
276       render :nothing => true, :status => :not_found
277     end
278   rescue ActiveRecord::RecordNotFound
279     render :nothing => true, :status => :not_found
280   end
281
282   def api_details
283     trace = Trace.find(params[:id])
284
285     if trace.public? or trace.user == @user
286       render :text => trace.to_xml.to_s, :content_type => "text/xml"
287     else
288       render :nothing => true, :status => :forbidden
289     end
290   rescue ActiveRecord::RecordNotFound
291     render :nothing => true, :status => :not_found
292   end
293
294   def api_data
295     trace = Trace.find(params[:id])
296
297     if trace.public? or trace.user == @user
298       send_file(trace.trace_name, :filename => "#{trace.id}#{trace.extension_name}", :type => trace.mime_type, :disposition => 'attachment')
299     else
300       render :nothing => true, :status => :forbidden
301     end
302   rescue ActiveRecord::RecordNotFound
303     render :nothing => true, :status => :not_found
304   end
305
306   def api_create
307     if request.post?
308       tags = params[:tags] || ""
309       description = params[:description] || ""
310       pub = params[:public] || false
311       
312       if params[:file].respond_to?(:read)
313         do_create(params[:file], tags, description, pub)
314
315         if @trace.id
316           render :text => @trace.id.to_s, :content_type => "text/plain"
317         elsif @trace.valid?
318           render :nothing => true, :status => :internal_server_error
319         else
320           render :nothing => true, :status => :bad_request
321         end
322       else
323         render :nothing => true, :status => :bad_request
324       end
325     else
326       render :nothing => true, :status => :method_not_allowed
327     end
328   end
329
330 private
331
332   def do_create(file, tags, description, public)
333     # Sanitise the user's filename
334     name = file.original_filename.gsub(/[^a-zA-Z0-9.]/, '_')
335
336     # Get a temporary filename...
337     filename = "/tmp/#{rand}"
338
339     # ...and save the uploaded file to that location
340     File.open(filename, "w") { |f| f.write(file.read) }
341
342     # Create the trace object, falsely marked as already
343     # inserted to stop the import daemon trying to load it
344     @trace = Trace.new({
345       :name => name,
346       :tagstring => tags,
347       :description => description,
348       :public => public,
349       :inserted => true,
350       :user => @user,
351       :timestamp => Time.now.getutc
352     })
353
354     # Save the trace object
355     if @trace.save
356       # Rename the temporary file to the final name
357       FileUtils.mv(filename, @trace.trace_name)
358
359       # Clear the inserted flag to make the import daemon load the trace
360       @trace.inserted = false
361       @trace.save!
362     else
363       # Remove the file as we have failed to update the database
364       FileUtils.rm_f(filename)
365     end
366     
367     # Finally save whether the user marked the trace as being public
368     if @trace.public?
369       if @user.trace_public_default.nil?
370         @user.preferences.create(:k => "gps.trace.public", :v => "default")
371       end
372     else
373       pref = @user.trace_public_default
374       pref.destroy unless pref.nil?
375     end
376     
377   end
378
379 end