From 98ab46c04661613e8be5279f8a9b03407b37a569 Mon Sep 17 00:00:00 2001 From: Richard Fairhurst Date: Tue, 22 Jan 2008 00:54:37 +0000 Subject: [PATCH] document amf_controller types for SteveC --- app/controllers/amf_controller.rb | 42 +++++++++++++++++++----------- public/potlatch/potlatch.swf | Bin 89257 -> 89419 bytes 2 files changed, 27 insertions(+), 15 deletions(-) diff --git a/app/controllers/amf_controller.rb b/app/controllers/amf_controller.rb index c8377991a..ba6651f6e 100644 --- a/app/controllers/amf_controller.rb +++ b/app/controllers/amf_controller.rb @@ -12,7 +12,11 @@ class AmfController < ApplicationController # # Public domain. Set your tab width to 4 to read this document. :) # 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 @@ -91,7 +95,8 @@ class AmfController < ApplicationController # 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) + # [3] colours, [4] casing, [5] areas, [6] autotags + # (all hashes) def getpresets RAILS_DEFAULT_LOGGER.info(" Message: getpresets") @@ -231,8 +236,8 @@ class AmfController < ApplicationController end # ----- getway - # in: [0] SWF object name, [1] way id, [2] baselong, [3] basey, - # [4] masterscale + # 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 @@ -320,10 +325,12 @@ class AmfController < ApplicationController # in: [0] way id # does: finds history of a way # out: [0] array of previous versions (where each is - # [0] version, [1] db timestamp, [2] visible 0 or 1, - # [3] username or 'anonymous') + # [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 @@ -344,8 +351,10 @@ class AmfController < ApplicationController # ----- putway # saves a way to the database - # in: [0] user token, [1] original way id (may be negative), - # [2] array of points (as getway/getway_old), [3] hash of way tags, + # 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 @@ -508,13 +517,15 @@ class AmfController < ApplicationController # ----- putpoi # save POI to the database - # in: [0] user token, [1] original node id (may be negative), - # [2] projected longitude, [3] projected latitude, [4] hash of tags, - # [5] visible (0 to delete, 1 otherwise), + # 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 + # 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 @@ -557,7 +568,8 @@ class AmfController < ApplicationController # 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 + # 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 @@ -573,7 +585,7 @@ class AmfController < ApplicationController # ----- deleteway # delete way and constituent nodes from database - # in: [0] user token, [1] way id + # 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) diff --git a/public/potlatch/potlatch.swf b/public/potlatch/potlatch.swf index b13b4ba9d3580678fc17ce175161ab06818cfa2f..b7555bd8c6b1fcf7937b74c58c827199e4f7548d 100755 GIT binary patch delta 4534 zcma)Ac~q3w75{#-Ff+igF9I{{h_b{L<558NWq_GD2$;A8L?eg@;}(~=1!9_$CNX)+ zE3r1lq>Uyy2>HMfF^R@z6Kb?Qr#)?BYTMH#ZA?OP(k6AG_kG`h60LUrxbJ=U-FM&J z?|XBkUq5(4?^RS&X)IgPr~M%eJWFjiQ0AF=BwdkM?rIpx!Vde&S~?wtvzqeCy5JiPu@@dfPcul9Ik z$|gso2FrNBY=p5^r=HE5-$0uV&+oZ`bm{7m70!m;sd7N&SMV(GJ(V!CiB*eHFSk|w z%14t=g4Tty=DKGCmcZGel}t-f8gxJ-B}?qfO%vpa%hu>oEALxb4&x{R`?O(ZU@c7L z8jF>*ICx!bt7Z2zzCT7HUu#?qw6j%B(VBL!Ynx}Xx0*5uaiu94?Q+8EB9I!ZnlBo# zk(F$iY|KX~9qI)ZxIWmJCkef2U)^9Zo3}oSy|W>f_PU-6VgKHcA{eR*dNy}s8nJ8G z_=OpnY+-vT!9(r61Zy5kCu=?Sn49KVyQ9#=p4uJ7*6*I6%rXg{-93jy&_AB-i$b}8 z{ZxZ>@;~;S*Wf`m@T1+RX2s8^uos>VpxL(0ncnxqZWnfGkXT@60{f)%3|6u!d!~m| z1Q;zM4or4ohjp+gkx^{S^>qY0&%I^8{hyJp?8=YnI5z7*GQp(>V(94Y2l{m=V6zWJ z6RbJp#5VTop+`|5r@u5+PXaDI9N`h09gd}0@8LB6CfLp5EPsnQtBHMa*n%e6_sBMJ z#GUkXzV^Nb0$fXJWe=*20@XlHlBqatryu01EbEtAb&L zN8`u|D;4;}(XBMscNY+}bvF|{-d(TR2)3&yRSaD{8S;*vVi5wzyNhK%`BPvC`?fcg zU}B$u_w`LCxTVh$Ey5~DGU(_iCAkb5kztoLii%5EZ{JiR{EGs^j){5kG2xzb$9hpM zx49iaF|+n38cJX|{pOb=tY;vKW%qlrnEv>wHWlX(8R}6o^Nvco`m;&q?*6$1KkH8- z7<8hJ{q4kTn#B_1qXV&Q(SZ6jmwlwn_72R2jh!EeBDm*76j2&ay3xu`om@=N`eq7R z<&rluG-zYn-)@X-gQcWggi??c-r*~Gb#{I@@A=NoPE#AhsVE|{o_ZVI^2Jl{eDFXsQQ zQGWjYEm~tSlpx*DJ{g>h5>_-gi;TBza4OBa1}CAE{f6c?W*nMD^LayJ-a6DyRqdOh zD-gx)Tv@8-0A=Z?A^c<*!dc^gGB8(u;Xhj3Mz9yJ%!$szem(h9N`Q!>Y|ob@DM6LZ zT{?s?^VM^)x2UC(TROZY(>xfw*vTs~(K(*&H5##+JDypt%52WH66CSAYjNIru#^S~ zLw7O98{zD!tNsS#*CxU`nD3QH(?g=l7>iAL?E1AVldJ`>wZST0Pc`JyB%zGaULKWk072P2R{BKw%AMp4K|ZY#izZ6fk&)xP7=;z2ltAq^w+qa~`6WEKk*NuJ}6FrDbY z?3wGKyu}}X*4L3;to&#oviRNrgrb(e8h|L&@b?0cVy4}KlhR3+@oNFtA0ikEJDY{9 zO6r>G`RjqOqne+dL|!fmLfPzURlo#QuMH!&row}sXg>ns9@0RFo5|yXk;cCXf*iaY z%0hKclrWLSqe=`#KAA+$o^C6GBsn3#QYhj$GcrX2G^l~1gspmGSVg^-LZ?@Rj^_@+ zPlV#CNM_zgfwCzBL@D8*iJM>SZZHiO^;e zkiuXMl1P3&SKoktl3>3g)FFhh`ECgCn0L=7{aXP=PjrWaZ93uI6r0&Ak=|Z)P8fO&;g;)gGJvMEai7i?}wL%vHpbqTw1} zA+z|)(a4~s->DQ=qwzS(d3y{Jyv5~1jbYvsgOikCYhtl9knYFAKkIL-UW~{v3=k$60yc^J%9Xyq$r(j6mH=)H*^0LAfqaRU4_o5fE+U z+=n-hquY2h?h*b>BEqnh?XrjR?gW^1#CKCiDk*a*k*fXJG*T?wAme9~NXUapIE4+o zZX#@Cq1Pv35em3587r`kuSv$l*llXtF=@#r;@0uGawj*Q%^EdsZ!+emQXirVhotnO z?Nn4pMrc0P2VYbQlGB!Kw zQ$)r2B2;*-oe!tuX=L)9_u%6Y@p}KBv2u9p6pFJlcgGZ5xbafvEz@8ddlb7*Ps2h? zD^fGyNx_A9?^f+5u%ijACb@_1hv185A(}VLfP)S=J_F}Lq4Goq-qMnf_E{0m>t>OH zW$qob@XF{*pZ*sxbK7i+r+W9#X5)`~EMqQbE9&`o*?3L)u=022!7)MnPaqy(%Sn0B z%*NX0GdYOkwj8V@7H{Ps$VdjbPy*&lj}GNO0vnYiJ}no)?zU1iX>b0Ifd^H9{$y~s zRN!7c?R&+EU*5FNNsdViNTE!=X#rBHd%wJZYD_JEZvmFmkXnUfe#<<9kzC{&7El$& O_0=dOu4UC&>h)iq_IKO> delta 4255 zcmb7Hc~q3w75{$2tiT{UA~OTXAi|&mMKKDp$i57lEQtif6%`dlj7yX#gfz`+U&9Nb zrqCfb~|r>7^0>8WYVrY3(R4H0_Z_YK5J+AQB6_r34F`|i8@ zeQ)@*?&zRSpIcLDJX+VMkF#jbrOQbcKeJpATcFXcZr-$Mi@e{V^|$80Akk+^Kt^e| zMlybC={8EHToua>rlrW&(hMF*mv3g&0wp}tjzCtQ^&v{+yu}-INM-%`^N=cklD|M> zN=HRVk4EYqXE$4eSx!+I(ph)WGia0-6ej`8*@lv0Qzt4)yLFOjl2;va? zbjqgEX&N;0{Ur!v>E%td=}39s1fs2?S-Tu*A?)UWL-wuw9O^<8n^9GV<#I>WTV9$h zu*}9FwxMyqZyhSSJtWiJDDXd^kzyovWBXKj#`29iG{{e^DTZ-^fL&`!_G^HtSYxr0 z0td&$wgxtP?fFR(`PSNIpo6VjZ_{*u-P)1NUS6L{h|%>i=#ZnDb3xLt+whJ7Z7jbn z)|iC?I#dtlw>7|!B?*-~m}Bc4_G()MZQK0oK=x%@9L*eCL)pS@@x-KQ+jTQKS#4(l z!9$%V3D(>{i%fI>{R1>l>k7j<_DEM4+uAi%nWYkZy=ws-tb1UQH?rkyc36Wg@<&fx z(x9FVJ=ujSmiJT~``x3yG~3;i>{$z^Q&^)(VtzeQ?A@MoSk2}zM={30Qw5R1r3eu_F;QJ9#92$~rjB;;bnaan?F^{fGtYWbdQ9#SuTGXT@{p zH7H`!jz?;%V9>D5#{*c!@wuejFOT=wJJh%pKJ=Fa=MEHG$npkIjOSSu49j^wlB~W) zfe${vi{`o$*#rwuY#{i;i4~eQu)Tc_F&yukE4TOM3CF*1B2V^_uK{)JtCJ3b_I?4& z`eO<1?6=rNF!@UcEghxgltCjB>r;)QVjVl#pFo6H6&QR<%=1nO_q=iHB&y_&fl?rs zSqJTgJQ&WtbYq^>9v*-~Adu3S1sz%~j*@#vrB&%e7g#pZ&ZDfZ> z8mW{SE{=i*k2i}Pc!-sL-H2GZ?`se6i_>9ZZ;mF|Qqij;=ShALA(Q6%lO!dA(wOy| zfBGnROSh+FS_FfhT^S9xrMu{AG-6kV`>qUDcdHJWZ17ej!GGLJBIq*~O)z;Z4VirZ zG(aS6F?)t1(^n>I@CD#BK{3tKTTZorM7ASLIXxH>6QG|9At1o+>g zRj8s>^6Op*@^KT*$^E@?3WfZFH*C{InIYvxXC%EmD?&sHR>R;y$W$?};U+WYm_%Wv zV0#NZ(hM6`^9(b>4gZk@$x_~BMkccOpUtRQHPLmbEs5~-R!LxJX=#x}=~_81_C$a> zMvW@}Qgx`N!5|q#XbN#iu_`q$BGty5uW(W~^2UYYqNqVF?k>&iQ6a2v7^jbxEcyJ@6f%1)e|ri>v5a5#MYUDn$-;9b zD$I&O4J*lZ>W!zGXZs<}OeBJhQmY&JE z6BXY&U~!6YXd4$+C7~95Kh;_sMNN=Qp!@s7SKOc;l&>G z&)=VgKyPA3bEnv-RLIENF?sw+J=`!#(X>x)Dd2m;VE3BfkO&>WtV57ia2@y)UFG1d ztkJ(xMlWYio#aor^?aEX%K{HeqU@+)H;1yFWD&h#7N=lORBY*^+H#|6%gubL4N>j| zZ9RY3hN;Nmhi#;M4nJ?hW_OBIo*Rz2v~+K{Lh*Ds9zYSF5rHUA(TP=u@X83hNOjRS z67_y`K@`?*{dToI5-*^Q&!3Jjv|H(x&aXs}C5xhP7q+SQj!U0;@>+j*^Gi|i@dhlZbb^6BA~e8s$4+ z5tr~nB^q70T`KO1azEVeMz`&D+%BFNjbQ9#d!0eNVFt{?arf|z(Wrtl%od2r?4nO~ zTXadfDpM&JwY*HZ1C|XL*=Nt_dGl;|dC(d^>!&7U2WPYKs0Y1G`O9}q*R|Ca! z_B$p`=l%(ZCNbtG;PSWcNA8z|!pW!Nz=|Z)A~8ozkcR{pGHaJ=U4bQYiU)}+t6g*t zgWsA58~02`DIIWEGA@B)#W4>rYlSEI-suSFPC*1MMyB9d*V{LY|7$*0VEI7)9e7`d zMz*=41@807K`1 zp%4#xs4whxTJ>`xMMtXzmH3P6-ObaN;8%3o>q|)HPCl&)4m9xGDykt3yr~K+X}DNL Tcd16+Sq*y34}4mUdi{R^=GII} -- 2.43.2