document amf_controller types for SteveC

[rails.git] / app / controllers / amf_controller.rb

diff --git a/app/controllers/amf_controller.rb b/app/controllers/amf_controller.rb
index c0b642edaeb4faf313b473c53ea8b30230d50f2a..ba6651f6e47723aa7826c48ac2e8544903bb0a14 100644 (file)
--- a/app/controllers/amf_controller.rb
+++ b/app/controllers/amf_controller.rb
@@ -11,8 +11,12 @@ class AmfController < ApplicationController
   # encoded in the Actionscript Message Format (AMF).
   #
   # Public domain. Set your tab width to 4 to read this document. :)
   # encoded in the Actionscript Message Format (AMF).
   #
   # Public domain. Set your tab width to 4 to read this document. :)

-  # editions Systeme D / Richard Fairhurst 2004-2007
-  
+  # editions Systeme D / Richard Fairhurst 2004-2008
+  #
+  # All in/out parameters are floats unless explicitly stated.
+  # Note that in getway/getway_old, SWF object name and way id are
+  #Êidentical and one could probably be eliminated.
+  # 

   # to trap errors (getway_old,putway,putpoi,deleteway only):
   #   return(-1,"message")             <-- just puts up a dialogue
   #   return(-2,"message")             <-- also asks the user to e-mail me
   # to trap errors (getway_old,putway,putpoi,deleteway only):
   #   return(-1,"message")             <-- just puts up a dialogue
   #   return(-2,"message")             <-- also asks the user to e-mail me


@@ -83,11 +87,16 @@ class AmfController < ApplicationController
 
   private
 
 
   private
 

+

   # ====================================================================
   # Remote calls
 
   # ----- getpresets
   # ====================================================================
   # Remote calls
 
   # ----- getpresets

-  #          return presets,presetmenus and presetnames arrays
+  #              in:   none
+  #              does: reads tag preset menus, colours, and autocomplete config files
+  #          out:  [0] presets, [1] presetmenus, [2] presetnames,
+  #                            [3] colours, [4] casing, [5] areas, [6] autotags
+  #                            (all hashes)

 
   def getpresets
     RAILS_DEFAULT_LOGGER.info("  Message: getpresets")
 
   def getpresets
     RAILS_DEFAULT_LOGGER.info("  Message: getpresets")


@@ -148,10 +157,20 @@ class AmfController < ApplicationController
     [presets,presetmenus,presetnames,colours,casing,areas,autotags]
   end
 
     [presets,presetmenus,presetnames,colours,casing,areas,autotags]
   end
 

-  # ----- whichways(left,bottom,right,top)
+  # ----- whichways

   #              return array of ways in current bounding box
   #              return array of ways in current bounding box

-  #              at present, instead of using correct (=more complex) SQL to find
-  #              corner-crossing ways, it simply enlarges the bounding box by +/- 0.01
+
+  #              in:   [0] xmin, [1] ymin, [2] xmax, [3] ymax (bbox in degrees)
+  #                            [4] baselong (longitude of SWF map origin),
+  #                            [5] basey (projected latitude of SWF map origin),
+  #                            [6] masterscale (SWF map scale)
+  #              does: finds all ways and POI nodes in bounding box
+  #                            at present, instead of using correct (=more complex) SQL to find
+  #                            corner-crossing ways, it simply enlarges the bounding box
+  #              out:  [0] array of way ids,
+  #                            [1] array of POIs
+  #                            (where each POI is an array containing:
+  #                             [0] id, [1] projected long, [2] projected lat, [3] hash of tags)

 
   def whichways(args)
     xmin = args[0].to_f-0.01
 
   def whichways(args)
     xmin = args[0].to_f-0.01


@@ -186,8 +205,12 @@ class AmfController < ApplicationController
     [ways,points]
   end
 
     [ways,points]
   end
 

-  # ----- whichways_deleted(left,bottom,right,top)
+  # ----- whichways_deleted

   #              return array of deleted ways in current bounding box
   #              return array of deleted ways in current bounding box

+
+  #              in:   as whichways
+  #              does: finds all deleted ways with a deleted node in bounding box
+  #              out:  [0] array of way ids

   
   def whichways_deleted(args)
     xmin = args[0].to_f-0.01
   
   def whichways_deleted(args)
     xmin = args[0].to_f-0.01


@@ -212,9 +235,16 @@ class AmfController < ApplicationController
        [ways]
   end
   
        [ways]
   end
   

-  # ----- getway (objectname, way, baselong, basey, masterscale)
-  #              returns objectname, array of co-ordinates, attributes,
-  #                              xmin,xmax,ymin,ymax
+  # ----- getway
+  #              in:   [0] SWF object name, 
+  #                            [1] way id, [2] baselong, [3] basey, [4] masterscale
+  #              does: gets way and all nodes
+  #              out:  [0] SWF object name (unchanged),
+  #                            [1] array of points
+  #                                    (where each point is an array containing
+  #                                     [0] projected long, [1] projected lat, [2] node id,
+  #                                     [3] null, [4] hash of node tags),
+  #                            [2] xmin, [3] xmax, [4] ymin, [5] ymax (unprojected bbox)

 
   def getway(args)
     objname,wayid,baselong,basey,masterscale=args
 
   def getway(args)
     objname,wayid,baselong,basey,masterscale=args


@@ -225,7 +255,7 @@ class AmfController < ApplicationController
 
     RAILS_DEFAULT_LOGGER.info("  Message: getway, id=#{wayid}")
 
 
     RAILS_DEFAULT_LOGGER.info("  Message: getway, id=#{wayid}")
 

-    readwayquery(wayid).each {|row|
+    readwayquery(wayid,true).each {|row|

       points<<[long2coord(row['longitude'].to_f,baselong,masterscale),lat2coord(row['latitude'].to_f,basey,masterscale),row['id'].to_i,nil,tag2array(row['tags'])]
       xmin = [xmin,row['longitude'].to_f].min
       xmax = [xmax,row['longitude'].to_f].max
       points<<[long2coord(row['longitude'].to_f,baselong,masterscale),lat2coord(row['latitude'].to_f,basey,masterscale),row['id'].to_i,nil,tag2array(row['tags'])]
       xmin = [xmin,row['longitude'].to_f].min
       xmax = [xmax,row['longitude'].to_f].max


@@ -240,8 +270,21 @@ class AmfController < ApplicationController
     [objname,points,attributes,xmin,xmax,ymin,ymax]
   end
   
     [objname,points,attributes,xmin,xmax,ymin,ymax]
   end
   

-  # -----      getway_old (objectname, way, version, baselong, basey, masterscale)
-  #                    returns old version of way
+  # ----- getway_old
+  #              returns old version of way
+
+  #              in:   [0] SWF object name, [1] way id,
+  #                            [2] way version to get (or -1 for "last deleted version")
+  #                            [3] baselong, [4] basey, [5] masterscale
+  #              does: gets old version of way and all constituent nodes
+  #                            for undelete, always uses the most recent version of each node
+  #                              (even if it's moved)
+  #                            for revert, uses the historic version of each node, but if that node is
+  #                              still visible and has been changed since, generates a new node id
+  #              out:  [0] 0 (code for success), [1] SWF object name,
+  #                            [2] array of points (as getway _except_ [3] is node.visible?, 0 or 1),
+  #                            [4] xmin, [5] xmax, [6] ymin, [7] ymax (unprojected bbox),
+  #                            [8] way version

 
   def getway_old(args)
     RAILS_DEFAULT_LOGGER.info("  Message: getway_old (server is #{SERVER_URL})")
 
   def getway_old(args)
     RAILS_DEFAULT_LOGGER.info("  Message: getway_old (server is #{SERVER_URL})")


@@ -276,11 +319,18 @@ class AmfController < ApplicationController
     [0,objname,points,attributes,xmin,xmax,ymin,ymax,version]
   end
 
     [0,objname,points,attributes,xmin,xmax,ymin,ymax,version]
   end
 

-  # -----      getway_history (way)
-  #                    returns array of previous versions (version,timestamp,visible,user)
-  #                    should also show 'created_by'
+  # ----- getway_history
+  #              find history of a way
+
+  #              in:   [0] way id
+  #              does: finds history of a way
+  #              out:  [0] array of previous versions (where each is
+  #                                    [0] version, [1] db timestamp (string),
+  #                                    [2] visible 0 or 1,
+  #                                    [3] username or 'anonymous' (string))

 
 

-  def getway_history(wayid)
+  def getway_history(args)
+       wayid=args[0]

        history=[]
        sql=<<-EOF
        SELECT version,timestamp,visible,display_name,data_public
        history=[]
        sql=<<-EOF
        SELECT version,timestamp,visible,display_name,data_public


@@ -298,10 +348,21 @@ class AmfController < ApplicationController
        [history]
   end
 
        [history]
   end
 

-  # -----      putway (user token, way, array of co-ordinates, array of attributes,
-  #                                    baselong, basey, masterscale)
-  #                    returns current way ID, new way ID, hash of renumbered nodes,
-  #                                    xmin,xmax,ymin,ymax
+  # ----- putway
+  #              saves a way to the database
+  
+  #              in:   [0] user token (string),
+  #                            [1] original way id (may be negative), 
+  #                            [2] array of points (as getway/getway_old),
+  #                            [3] hash of way tags,
+  #                            [4] original way version (0 if not a reverted/undeleted way),
+  #                            [5] baselong, [6] basey, [7] masterscale
+  #              does: saves way to the database
+  #                            all constituent nodes are created/updated as necessary
+  #                            (or deleted if they were in the old version and are otherwise unused)
+  #              out:  [0] 0 (code for success), [1] original way id (unchanged),
+  #                            [2] new way id, [3] hash of renumbered nodes (old id=>new id),
+  #                            [4] xmin, [5] xmax, [6] ymin, [7] ymax (unprojected bbox)

 
   def putway(args,renumberednodes)
     RAILS_DEFAULT_LOGGER.info("  putway started")
 
   def putway(args,renumberednodes)
     RAILS_DEFAULT_LOGGER.info("  putway started")


@@ -329,25 +390,17 @@ class AmfController < ApplicationController
     xc={}; yc={}; tagc={}; vc={}
     if originalway>0
       way=originalway
     xc={}; yc={}; tagc={}; vc={}
     if originalway>0
       way=originalway

-         if oldversion==0
-           readwayquery(way).each { |row|
-                 id=row['id'].to_i
+         if oldversion==0 then r=readwayquery(way,false)
+                                          else r=readwayquery_old(way,oldversion,true) end
+         r.each { |row|
+               id=row['id'].to_i
+               if (id>0) then

                  xc[id]=row['longitude'].to_f
                  yc[id]=row['latitude' ].to_f
                  tagc[id]=row['tags']
                  xc[id]=row['longitude'].to_f
                  yc[id]=row['latitude' ].to_f
                  tagc[id]=row['tags']

-                 vc[id]=1
-               }
-         else
-           readwayquery_old(way,oldversion,true).each { |row|
-                 id=row['id'].to_i
-                 if (id>0) then
-                       xc[id]=row['longitude'].to_f
-                       yc[id]=row['latitude' ].to_f
-                       tagc[id]=row['tags']
-                       vc[id]=row['visible'].to_i
-                 end
-               }
-         end
+                 vc[id]=row['visible'].to_i
+           end
+         }

       ActiveRecord::Base.connection.update("UPDATE current_ways SET timestamp=#{db_now},user_id=#{uid},visible=1 WHERE id=#{way}")
     else
       way=ActiveRecord::Base.connection.insert("INSERT INTO current_ways (user_id,timestamp,visible) VALUES (#{uid},#{db_now},1)")
       ActiveRecord::Base.connection.update("UPDATE current_ways SET timestamp=#{db_now},user_id=#{uid},visible=1 WHERE id=#{way}")
     else
       way=ActiveRecord::Base.connection.insert("INSERT INTO current_ways (user_id,timestamp,visible) VALUES (#{uid},#{db_now},1)")


@@ -392,7 +445,7 @@ class AmfController < ApplicationController
       elsif xc.has_key?(node)
                nodelist.push(node)
         # old node from original way - update
       elsif xc.has_key?(node)
                nodelist.push(node)
         # old node from original way - update

-        if (xs!=xc[node] or (ys/0.0000001).round!=(yc[node]/0.0000001).round or tagstr!=tagc[node] or vc[node]==0)
+        if ((xs/0.0000001).round!=(xc[node]/0.0000001).round or (ys/0.0000001).round!=(yc[node]/0.0000001).round or tagstr!=tagc[node] or vc[node]==0)

           ActiveRecord::Base.connection.insert("INSERT INTO nodes (id,latitude,longitude,timestamp,user_id,visible,tags,tile) VALUES (#{node},#{lat},#{long},#{db_now},#{uid},1,#{tagsql},#{tile})")
           ActiveRecord::Base.connection.update("UPDATE current_nodes SET latitude=#{lat},longitude=#{long},timestamp=#{db_now},user_id=#{uid},tags=#{tagsql},visible=1,tile=#{tile} WHERE id=#{node}")
         end
           ActiveRecord::Base.connection.insert("INSERT INTO nodes (id,latitude,longitude,timestamp,user_id,visible,tags,tile) VALUES (#{node},#{lat},#{long},#{db_now},#{uid},1,#{tagsql},#{tile})")
           ActiveRecord::Base.connection.update("UPDATE current_nodes SET latitude=#{lat},longitude=#{long},timestamp=#{db_now},user_id=#{uid},tags=#{tagsql},visible=1,tile=#{tile} WHERE id=#{node}")
         end


@@ -461,10 +514,18 @@ class AmfController < ApplicationController
     [0,originalway,way,renumberednodes,xmin,xmax,ymin,ymax]
   end
 
     [0,originalway,way,renumberednodes,xmin,xmax,ymin,ymax]
   end
 

-  # -----      putpoi (user token, id, x,y,tag array,visible,baselong,basey,masterscale)
-  #                    returns current id, new id
-  #                    if new: add new row to current_nodes and nodes
-  #                    if old: add new row to nodes, update current_nodes
+  # ----- putpoi
+  #              save POI to the database
+  
+  #              in:   [0] user token (string),
+  #                            [1] original node id (may be negative),
+  #                            [2] projected longitude, [3] projected latitude,
+  #                            [4] hash of tags, [5] visible (0 to delete, 1 otherwise), 
+  #                            [6] baselong, [7] basey, [8] masterscale
+  #              does: saves POI node to the database
+  #                            refuses save if the node has since become part of a way
+  #              out:  [0] 0 (success), [1] original node id (unchanged),
+  #                            [2] new node id

 
   def putpoi(args)
     usertoken,id,x,y,tags,visible,baselong,basey,masterscale=args
 
   def putpoi(args)
     usertoken,id,x,y,tags,visible,baselong,basey,masterscale=args


@@ -501,8 +562,14 @@ class AmfController < ApplicationController
     [0,id,newid]
   end
 
     [0,id,newid]
   end
 

-  # -----      getpoi (id,baselong,basey,masterscale)
-  #                    returns id,x,y,tag array
+  # ----- getpoi
+  #              read POI from database
+  #              (only called on revert: POIs are usually read by whichways)
+  
+  #              in:   [0] node id, [1] baselong, [2] basey, [3] masterscale
+  #              does: reads POI
+  #              out:  [0] id (unchanged), [1] projected long, [2] projected lat,
+  #                            [3] hash of tags

   
   def getpoi(args)
        id,baselong,basey,masterscale=args; id=id.to_i
   
   def getpoi(args)
        id,baselong,basey,masterscale=args; id=id.to_i


@@ -515,8 +582,13 @@ class AmfController < ApplicationController
         tag2array(poi['tags'])]
   end
 
         tag2array(poi['tags'])]
   end
 

-  # -----      deleteway (user token, way, nodes to keep)
-  #                    returns way ID only
+  # ----- deleteway
+  #              delete way and constituent nodes from database
+  
+  #              in:   [0] user token (string), [1] way id
+  #              does: deletes way from db and any constituent nodes not used elsewhere
+  #                            also removes ways/nodes from any relations they're in
+  #              out:  [0] 0 (success), [1] way id (unchanged)

 
   def deleteway(args)
     usertoken,way=args
 
   def deleteway(args)
     usertoken,way=args


@@ -571,13 +643,16 @@ end
 # ====================================================================
 # Support functions for remote calls
 
 # ====================================================================
 # Support functions for remote calls
 

-def readwayquery(id)
-  ActiveRecord::Base.connection.select_all "SELECT latitude*0.0000001 AS latitude,longitude*0.0000001 AS longitude,current_nodes.id,tags "+
-      "    FROM current_way_nodes,current_nodes "+
-      "   WHERE current_way_nodes.id=#{id} "+
-      "     AND current_way_nodes.node_id=current_nodes.id "+
-      "     AND current_nodes.visible=1 "+
-      "   ORDER BY sequence_id"
+def readwayquery(id,insistonvisible)
+  sql=<<-EOF
+    SELECT latitude*0.0000001 AS latitude,longitude*0.0000001 AS longitude,current_nodes.id,tags,visible 
+      FROM current_way_nodes,current_nodes 
+     WHERE current_way_nodes.id=#{id} 
+       AND current_way_nodes.node_id=current_nodes.id 
+  EOF
+  if insistonvisible then sql+=" AND current_nodes.visible=1 " end
+  sql+=" ORDER BY sequence_id"
+  ActiveRecord::Base.connection.select_all(sql)

 end
 
 def getlastversion(id,version)
 end
 
 def getlastversion(id,version)