Improve formatting of note descriptions in GPX and RSS responses

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

diff --git a/app/models/trace.rb b/app/models/trace.rb
index cb49ba62cbc8a8e38878aa5fce76b4422c389799..582c7285cd95e7e02147dbf8697b51450e167992 100644 (file)
--- a/app/models/trace.rb
+++ b/app/models/trace.rb
@@ -3,9 +3,12 @@ class Trace < ActiveRecord::Base
 
   validates_presence_of :user_id, :name, :timestamp
   validates_presence_of :description, :on => :create
 
   validates_presence_of :user_id, :name, :timestamp
   validates_presence_of :description, :on => :create

+  validates_length_of :name, :maximum => 255
+  validates_length_of :description, :maximum => 255

 #  validates_numericality_of :latitude, :longitude
 #  validates_numericality_of :latitude, :longitude

-  validates_inclusion_of :public, :inserted, :in => [ true, false]
-  
+  validates_inclusion_of :inserted, :in => [ true, false ]
+  validates_inclusion_of :visibility, :in => ["private", "public", "trackable", "identifiable"]
+

   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
   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


@@ -18,17 +21,38 @@ class Trace < ActiveRecord::Base
   end
 
   def tagstring
   end
 
   def tagstring

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

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

-    self.tags = s.split().collect {|tag|
-      tt = Tracetag.new
-      tt.tag = tag
-      tt
-    }
+    if s.include? ','
+      self.tags = s.split(/\s*,\s*/).select {|tag| tag !~ /^\s*$/}.collect {|tag|
+        tt = Tracetag.new
+        tt.tag = tag
+        tt
+      }
+    else
+      #do as before for backwards compatibility:
+      self.tags = s.split().collect {|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)
   def large_picture= (data)
     f = File.new(large_picture_name, "wb")
     f.syswrite(data)


@@ -58,18 +82,16 @@ class Trace < ActiveRecord::Base
     data
   end
   
     data
   end
   

-  # FIXME change to permanent filestore area

   def large_picture_name
   def large_picture_name

-    "/home/osm/icons/#{id}.gif"
+    "#{GPX_IMAGE_DIR}/#{id}.gif"

   end
 
   end
 

-  # FIXME change to permanent filestore area

   def icon_picture_name
   def icon_picture_name

-    "/home/osm/icons/#{id}_icon.gif"
+    "#{GPX_IMAGE_DIR}/#{id}_icon.gif"

   end
 
   def trace_name
   end
 
   def trace_name

-    "/home/osm/gpx/#{id}.gpx"
+    "#{GPX_TRACE_DIR}/#{id}.gpx"

   end
 
   def mime_type
   end
 
   def mime_type


@@ -127,15 +149,72 @@ class Trace < ActiveRecord::Base
     el1 = XML::Node.new 'gpx_file'
     el1['id'] = self.id.to_s
     el1['name'] = self.name.to_s
     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['lat'] = self.latitude.to_s if self.inserted
+    el1['lon'] = self.longitude.to_s if self.inserted

     el1['user'] = self.user.display_name
     el1['user'] = self.user.display_name

-    el1['public'] = self.public.to_s
+    el1['visibility'] = self.visibility

     el1['pending'] = (!self.inserted).to_s
     el1['timestamp'] = self.timestamp.xmlschema
     el1['pending'] = (!self.inserted).to_s
     el1['timestamp'] = self.timestamp.xmlschema

+
+    el2 = XML::Node.new 'description'
+    el2 << self.description
+    el1 << el2
+
+    self.tags.each do |tag|
+      el2 = XML::Node.new('tag')
+      el2 << tag.tag
+      el1 << el2
+    end
+

     return el1
   end
 
     return el1
   end
 

+  # Read in xml as text and return it's Node object representation
+  def self.from_xml(xml, create=false)
+    begin
+      p = XML::Parser.string(xml)
+      doc = p.parse
+
+      doc.find('//osm/gpx_file').each do |pt|
+        return Trace.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
+  end
+
+  def self.from_xml_node(pt, create=false)
+    trace = Trace.new
+    
+    raise OSM::APIBadXMLError.new("trace", pt, "visibility missing") if pt['visibility'].nil?
+    trace.visibility = pt['visibility']
+
+    unless create
+      raise OSM::APIBadXMLError.new("trace", pt, "ID is required when updating.") if pt['id'].nil?
+      trace.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.new("ID of trace cannot be zero when updating.") if trace.id == 0
+    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
+    trace.visible = true
+
+    description = pt.find('description').first
+    raise OSM::APIBadXMLError.new("trace", pt, "description missing") if description.nil?
+    trace.description = description.content
+
+    pt.find('tag').each do |tag|
+      trace.tags.build(:tag => tag.content)
+    end
+
+    return trace
+  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
   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


@@ -158,7 +237,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} > #{tmpfile.path}")
+        system("unzip -p #{trace_name} -x '__MACOSX/*' > #{tmpfile.path}")

       end
 
       tmpfile.unlink
       end
 
       tmpfile.unlink