Merge branch 'master' into snapshotserver
[potlatch2.git] / net / systemeD / halcyon / connection / XMLConnection.as
index 3ffb664..9b94f20 100644 (file)
@@ -1,45 +1,79 @@
 package net.systemeD.halcyon.connection {
 
     import flash.events.*;
-
+       import mx.rpc.http.HTTPService;
+       import mx.rpc.events.*;
        import flash.system.Security;
        import flash.net.*;
     import org.iotashan.oauth.*;
 
+       import net.systemeD.halcyon.AttentionEvent;
        import net.systemeD.halcyon.MapEvent;
 
+    /**
+    * XMLConnection provides all the methods required to connect to a live
+    * OSM server. See OSMConnection for connecting to a read-only .osm file
+    *
+    * @see OSMConnection
+    */
        public class XMLConnection extends XMLBaseConnection {
 
-        //public var readConnection:NetConnection;
+        /**
+        * Create a new XML connection
+        * @param name The name of the connection
+        * @param api The url of the OSM API server, e.g. http://api06.dev.openstreetmap.org/api/0.6/
+        * @param policy The url of the flash crossdomain policy to load,
+                        e.g. http://api06.dev.openstreetmap.org/api/crossdomain.xml
+        * @param initparams Any further parameters for the connection, such as the serverName
+        */
+               public function XMLConnection(name:String,api:String,policy:String,initparams:Object) {
 
-               public function XMLConnection() {
+                       super(name,api,policy,initparams);
+                       if (policyURL != "") Security.loadPolicyFile(policyURL);
 
-                       if (Connection.policyURL!='')
-                Security.loadPolicyFile(Connection.policyURL);
-            var oauthPolicy:String = Connection.getParam("oauth_policy", "");
-            if ( oauthPolicy != "" ) {
-                Security.loadPolicyFile(oauthPolicy);
-            }
+            var oauthPolicy:String = getParam("oauth_policy", "");
+            if (oauthPolicy != "") Security.loadPolicyFile(oauthPolicy);
                }
                
                override public function loadBbox(left:Number,right:Number,
                                                                top:Number,bottom:Number):void {
+            purgeIfFull(left,right,top,bottom);
+            if (isBboxLoaded(left,right,top,bottom)) return;
+
+            // enlarge bbox by 20% on each edge
+            var xmargin:Number=(right-left)/5;
+            var ymargin:Number=(top-bottom)/5;
+            left-=xmargin; right+=xmargin;
+            bottom-=ymargin; top+=ymargin;
+
             var mapVars:URLVariables = new URLVariables();
             mapVars.bbox= left+","+bottom+","+right+","+top;
 
-            var mapRequest:URLRequest = new URLRequest(Connection.apiBaseURL+"map");
+            var mapRequest:URLRequest = new URLRequest(apiBaseURL+"map");
             mapRequest.data = mapVars;
 
-            var mapLoader:URLLoader = new URLLoader();
-            mapLoader.addEventListener(Event.COMPLETE, loadedMap);
-            mapLoader.addEventListener(IOErrorEvent.IO_ERROR, errorOnMapLoad);
-            mapLoader.addEventListener(HTTPStatusEvent.HTTP_STATUS, mapLoadStatus);
-            mapLoader.load(mapRequest);
-            dispatchEvent(new Event(LOAD_STARTED));
+            sendLoadRequest(mapRequest);
+               }
+
+               override public function loadEntityByID(type:String, id:Number):void {
+                       var url:String=apiBaseURL + type + "/" + id;
+                       if (type=='way') url+="/full";
+                       sendLoadRequest(new URLRequest(url));
+               }
+
+               private function sendLoadRequest(request:URLRequest):void {
+                       var mapLoader:URLLoader = new URLLoader();
+                       mapLoader.addEventListener(Event.COMPLETE, loadedMap);
+                       mapLoader.addEventListener(IOErrorEvent.IO_ERROR, errorOnMapLoad);
+                       mapLoader.addEventListener(HTTPStatusEvent.HTTP_STATUS, mapLoadStatus);
+            request.requestHeaders.push(new URLRequestHeader("X-Error-Format", "XML"));
+                       mapLoader.load(request);
+                       dispatchEvent(new Event(LOAD_STARTED));
                }
 
         private function errorOnMapLoad(event:Event):void {
                        dispatchEvent(new MapEvent(MapEvent.ERROR, { message: "Couldn't load the map" } ));
+                       dispatchEvent(new Event(LOAD_COMPLETED));
         }
         private function mapLoadStatus(event:HTTPStatusEvent):void {
             trace("loading map status = "+event.status);
@@ -47,15 +81,46 @@ package net.systemeD.halcyon.connection {
 
         protected var appID:OAuthConsumer;
         protected var authToken:OAuthToken;
-        
-           override public function setAppID(id:Object):void {
-               appID = OAuthConsumer(id);
-           }
-           
+
            override public function setAuthToken(id:Object):void {
                authToken = OAuthToken(id);
            }
 
+        override public function hasAccessToken():Boolean {
+            return !(getAccessToken() == null);
+        }
+
+        override public function setAccessToken(key:String, secret:String):void {
+            if (key && secret) {
+              authToken = new OAuthToken(key, secret);
+            }
+        }
+
+        /* Get the stored access token, or try setting it up from loader params */
+        private function getAccessToken():OAuthToken {
+            if (authToken == null) {
+              var key:String = getParam("oauth_token", null);
+              var secret:String = getParam("oauth_token_secret", null);
+
+              if ( key != null && secret != null ) {
+                  authToken = new OAuthToken(key, secret);
+              }
+            }
+            return authToken;
+        }
+
+        private function getConsumer():OAuthConsumer {
+            if (appID == null) {
+              var key:String = getParam("oauth_consumer_key", null);
+              var secret:String = getParam("oauth_consumer_secret", null);
+
+              if ( key != null && secret != null ) {
+                  appID = new OAuthConsumer(key, secret);
+              }
+            }
+            return appID;
+        }
+
         private var httpStatus:int = 0;
         
         private function recordStatus(event:HTTPStatusEvent):void {
@@ -76,24 +141,9 @@ package net.systemeD.halcyon.connection {
               changesetXML.changeset.appendChild(tagXML);
             }        
 
-            // make an OAuth query
-            var sig:IOAuthSignatureMethod = new OAuthSignatureMethod_HMAC_SHA1();
-            var url:String = Connection.apiBaseURL+"changeset/create";
-            //var params:Object = { _method: "PUT" };
-            var oauthRequest:OAuthRequest = new OAuthRequest("PUT", url, null, appID, authToken);
-            var urlStr:Object = oauthRequest.buildRequest(sig, OAuthRequest.RESULT_TYPE_URL_STRING)
-
-            // build the actual request
-            var urlReq:URLRequest = new URLRequest(String(urlStr));
-            urlReq.method = "POST";
-            urlReq.data = changesetXML.toXMLString();
-            urlReq.contentType = "application/xml";
-            urlReq.requestHeaders = new Array(new URLRequestHeader("X_HTTP_METHOD_OVERRIDE", "PUT"));
-            var loader:URLLoader = new URLLoader();
-            loader.addEventListener(Event.COMPLETE, changesetCreateComplete);
-            loader.addEventListener(IOErrorEvent.IO_ERROR, changesetCreateError);
-            loader.addEventListener(HTTPStatusEvent.HTTP_STATUS, recordStatus);
-               loader.load(urlReq);
+                       sendOAuthPut(apiBaseURL+"changeset/create",
+                                                changesetXML,
+                                                changesetCreateComplete, changesetCreateError, recordStatus);
            }
 
         private function changesetCreateComplete(event:Event):void {
@@ -101,14 +151,67 @@ package net.systemeD.halcyon.connection {
             var id:Number = Number(URLLoader(event.target).data);
             
             // which means we now have a new changeset!
-            setActiveChangeset(new Changeset(id, lastUploadedChangesetTags));
+            setActiveChangeset(new Changeset(this, id, lastUploadedChangesetTags));
         }
 
         private function changesetCreateError(event:IOErrorEvent):void {
             dispatchEvent(new Event(NEW_CHANGESET_ERROR));
         }
-        
-        override public function uploadChanges():void {
+
+               override public function closeChangeset():void {
+            var cs:Changeset = getActiveChangeset();
+                       if (!cs) return;
+                       
+                       sendOAuthPut(apiBaseURL+"changeset/"+cs.id+"/close",
+                                                null,
+                                                changesetCloseComplete, changesetCloseError, recordStatus);
+                       closeActiveChangeset();
+               }
+               
+               private function changesetCloseComplete(event:Event):void { 
+                       dispatchEvent(new AttentionEvent(AttentionEvent.ALERT, null, "Changeset closed"));
+               }
+               private function changesetCloseError(event:Event):void { 
+                       dispatchEvent(new AttentionEvent(AttentionEvent.ALERT, null, "Couldn't close changeset", 1));
+               }
+
+        private function signedOAuthURL(url:String, method:String):String {
+            // method should be PUT, GET, POST or DELETE
+            var sig:IOAuthSignatureMethod = new OAuthSignatureMethod_HMAC_SHA1();
+            var oauthRequest:OAuthRequest = new OAuthRequest(method, url, null, getConsumer(), authToken);
+            var urlStr:Object = oauthRequest.buildRequest(sig, OAuthRequest.RESULT_TYPE_URL_STRING);
+            return String(urlStr);
+        }
+
+               private function sendOAuthPut(url:String, xml:XML, onComplete:Function, onError:Function, onStatus:Function):void {
+            // build the request
+            var urlReq:URLRequest = new URLRequest(signedOAuthURL(url, "PUT"));
+            urlReq.method = "POST";
+                       if (xml) { urlReq.data = xml.toXMLString(); } else { urlReq.data = true; }
+            urlReq.contentType = "application/xml";
+            urlReq.requestHeaders = [ new URLRequestHeader("X_HTTP_METHOD_OVERRIDE", "PUT"), 
+                                                 new URLRequestHeader("X-Error-Format", "XML") ];
+            var loader:URLLoader = new URLLoader();
+            loader.addEventListener(Event.COMPLETE, onComplete);
+            loader.addEventListener(IOErrorEvent.IO_ERROR, onError);
+            loader.addEventListener(HTTPStatusEvent.HTTP_STATUS, onStatus);
+               loader.load(urlReq);
+               }
+
+        private function sendOAuthGet(url:String, onComplete:Function, onError:Function, onStatus:Function):void {
+            var urlReq:URLRequest = new URLRequest(signedOAuthURL(url, "GET"));
+            urlReq.method = "GET";
+            var loader:URLLoader = new URLLoader();
+            loader.addEventListener(Event.COMPLETE, onComplete);
+            loader.addEventListener(IOErrorEvent.IO_ERROR, onError);
+            loader.addEventListener(HTTPStatusEvent.HTTP_STATUS, onStatus);
+            loader.load(urlReq);
+        }
+
+               /** Create XML changeset and send it to the server. Returns the XML string for use in the 'Show data' button.
+                   (We don't mind what's returned as long as it implements .toString() ) */
+
+        override public function uploadChanges():* {
             var changeset:Changeset = getActiveChangeset();
             var upload:XML = <osmChange version="0.6"/>
             upload.appendChild(addCreated(changeset, getAllNodeIDs, getNode, serialiseNode));
@@ -117,34 +220,45 @@ package net.systemeD.halcyon.connection {
             upload.appendChild(addModified(changeset, getAllNodeIDs, getNode, serialiseNode));
             upload.appendChild(addModified(changeset, getAllWayIDs, getWay, serialiseWay));
             upload.appendChild(addModified(changeset, getAllRelationIDs, getRelation, serialiseRelation));
-            upload.appendChild(addDeleted(changeset, getAllRelationIDs, getRelation, serialiseEntityRoot));
-            upload.appendChild(addDeleted(changeset, getAllWayIDs, getWay, serialiseEntityRoot));
-            upload.appendChild(addDeleted(changeset, getAllNodeIDs, getNode, serialiseEntityRoot));
+            upload.appendChild(addDeleted(changeset, getAllRelationIDs, getRelation, serialiseEntityRoot, false));
+            upload.appendChild(addDeleted(changeset, getAllRelationIDs, getRelation, serialiseEntityRoot, true));
+            upload.appendChild(addDeleted(changeset, getAllWayIDs, getWay, serialiseEntityRoot, false));
+            upload.appendChild(addDeleted(changeset, getAllWayIDs, getWay, serialiseEntityRoot, true));
+            upload.appendChild(addDeleted(changeset, getAllNodeIDs, getNode, serialiseEntityRoot, false));
+            upload.appendChild(addDeleted(changeset, getAllNodeIDs, getNode, serialiseEntityRoot, true));
 
             // now actually upload them
             // make an OAuth query
-            var sig:IOAuthSignatureMethod = new OAuthSignatureMethod_HMAC_SHA1();
-            var url:String = Connection.apiBaseURL+"changeset/" + changeset.id + "/upload";
-            var oauthRequest:OAuthRequest = new OAuthRequest("POST", url, null, appID, authToken);
-            var urlStr:Object = oauthRequest.buildRequest(sig, OAuthRequest.RESULT_TYPE_URL_STRING)
+            var url:String = apiBaseURL+"changeset/" + changeset.id + "/upload";
 
             // build the actual request
-            var urlReq:URLRequest = new URLRequest(String(urlStr));
-            urlReq.method = "POST";
-            urlReq.data = upload.toXMLString();
-            urlReq.contentType = "text/xml";
-            var loader:URLLoader = new URLLoader();
-            loader.addEventListener(Event.COMPLETE, diffUploadComplete);
-            loader.addEventListener(IOErrorEvent.IO_ERROR, diffUploadError);
-            loader.addEventListener(HTTPStatusEvent.HTTP_STATUS, recordStatus);
-               loader.load(urlReq);
+                       var serv:HTTPService=new HTTPService();
+                       serv.method="POST";
+                       serv.url=signedOAuthURL(url, "POST");
+                       serv.contentType = "text/xml";
+                       serv.headers={'X-Error-Format':'xml'};
+                       serv.request=" ";
+                       serv.resultFormat="e4x";
+                       serv.requestTimeout=0;
+                       serv.addEventListener(ResultEvent.RESULT, diffUploadComplete);
+                       serv.addEventListener(FaultEvent.FAULT, diffUploadIOError);
+                       serv.send(upload);
                
-               dispatchEvent(new Event(SAVE_STARTED));
+                       dispatchEvent(new Event(SAVE_STARTED));
+                       return upload;
         }
 
-        private function diffUploadComplete(event:Event):void {
+        private function diffUploadComplete(event:ResultEvent):void {
+                       var results:XML = XML(event.result);
+
+                       // was it an error document?
+                       if (results.name().localName=='osmError') {
+                       dispatchEvent(new SaveCompleteEvent(SAVE_COMPLETED, false));
+                               diffUploadAPIError(results.status, results.message);
+                               return;
+                       }
+
             // response should be XML describing the progress
-            var results:XML = new XML((URLLoader(event.target).data));
             
             for each( var update:XML in results.child("*") ) {
                 var oldID:Number = Number(update.@old_id);
@@ -154,23 +268,15 @@ package net.systemeD.halcyon.connection {
 
                                if (newID==0) {
                                        // delete
-                       if ( type == "node" ) killNode(oldID);
-                       else if ( type == "way" ) killWay(oldID);
-                       else if ( type == "relation" ) killRelation(oldID);
+                       if      (type == "node"    ) { killNode(oldID); }
+                       else if (type == "way"     ) { killWay(oldID); }
+                       else if (type == "relation") { killRelation(oldID); }
                                        
                                } else {
                                        // create/update
-                       var entity:Entity;
-                       if ( type == "node" ) entity = getNode(oldID);
-                       else if ( type == "way" ) entity = getWay(oldID);
-                       else if ( type == "relation" ) entity = getRelation(oldID);
-                       entity.markClean(newID, version);
-                
-                       if ( oldID != newID ) {
-                           if ( type == "node" ) renumberNode(oldID, entity as Node, false);
-                           else if ( type == "way" ) renumberWay(oldID, entity as Way, false);
-                           else if ( type == "relation" ) renumberRelation(oldID, entity as Relation, false);
-                       }
+                       if      (type == "node"    ) { renumberNode(oldID, newID, version); getNode(newID).markClean(); }
+                       else if (type == "way"     ) { renumberWay(oldID, newID, version); getWay(newID).markClean(); }
+                       else if (type == "relation") { renumberRelation(oldID, newID, version); getRelation(newID).markClean(); }
                                }
             }
 
@@ -180,10 +286,56 @@ package net.systemeD.halcyon.connection {
             MainUndoStack.getGlobalStack().breakUndo(); // so, for now, break the undo stack
         }
 
-        private function diffUploadError(event:IOErrorEvent):void {
-                       dispatchEvent(new MapEvent(MapEvent.ERROR, { message: "Couldn't upload data: "+httpStatus+" "+event.text } ));
-               dispatchEvent(new SaveCompleteEvent(SAVE_COMPLETED, false));
-        }
+               private function diffUploadIOError(event:FaultEvent):void {
+                       trace(event.fault);
+                       dispatchEvent(new MapEvent(MapEvent.ERROR, { message: "Couldn't upload data: "+event.fault.faultString } ));
+                       dispatchEvent(new SaveCompleteEvent(SAVE_COMPLETED, false));
+               }
+
+               private function diffUploadAPIError(status:String, message:String):void {
+                       var matches:Array;
+                       switch (status) {
+
+                               case '409 Conflict':
+                                       if (message.match(/changeset/i)) { throwChangesetError(message); return; }
+                                       matches=message.match(/mismatch.+had: (\d+) of (\w+) (\d+)/i);
+                                       if (matches) { throwConflictError(findEntity(matches[2],matches[3]), Number(matches[1]), message); return; }
+                                       break;
+                               
+                               case '410 Gone':
+                                       matches=message.match(/The (\w+) with the id (\d+)/i);
+                                       if (matches) { throwAlreadyDeletedError(findEntity(matches[1],matches[2]), message); return; }
+                                       break;
+                               
+                               case '412 Precondition Failed':
+                                       matches=message.match(/Node (\d+) is still used/i);
+                                       if (matches) { throwInUseError(findEntity('Node',matches[1]), message); return; }
+                                       matches=message.match(/relation (\d+) is used/i);
+                                       if (matches) { throwInUseError(findEntity('Relation',matches[1]), message); return; }
+                                       matches=message.match(/Way (\d+) still used/i);
+                                       if (matches) { throwInUseError(findEntity('Way',matches[1]), message); return; }
+                                       matches=message.match(/Cannot update (\w+) (\d+)/i);
+                                       if (matches) { throwEntityError(findEntity(matches[1],matches[2]), message); return; }
+                                       matches=message.match(/Relation with id (\d+)/i);
+                                       if (matches) { throwEntityError(findEntity('Relation',matches[1]), message); return; }
+                                       matches=message.match(/Way (\d+) requires the nodes/i);
+                                       if (matches) { throwEntityError(findEntity('Way',matches[1]), message); return; }
+                                       throwBugError(message); return;
+                               
+                               case '404 Not Found':
+                                       throwBugError(message); return;
+                                       
+                               case '400 Bad Request':
+                                       matches=message.match(/Element (\w+)\/(\d+)/i);
+                                       if (matches) { throwEntityError(findEntity(matches[1],matches[2]), message); return; }
+                                       matches=message.match(/You tried to add \d+ nodes to way (\d+)/i);
+                                       if (matches) { throwEntityError(findEntity('Way',matches[1]), message); return; }
+                                       throwBugError(message); return;
+                       }
+
+                       // Not caught, so just throw a generic server error
+                       throwServerError(message);
+               }
 
         private function addCreated(changeset:Changeset, getIDs:Function, get:Function, serialise:Function):XML {
             var create:XML = <create version="0.6"/>
@@ -199,12 +351,13 @@ package net.systemeD.halcyon.connection {
             return create.hasComplexContent() ? create : <!-- blank create section -->;
         }
 
-               private function addDeleted(changeset:Changeset, getIDs:Function, get:Function, serialise:Function):XML {
+               private function addDeleted(changeset:Changeset, getIDs:Function, get:Function, serialise:Function, ifUnused:Boolean):XML {
             var del:XML = <delete version="0.6"/>
+            if (ifUnused) del.@["if-unused"] = "true";
             for each( var id:Number in getIDs() ) {
                 var entity:Entity = get(id);
                 // creates are already included
-                if ( id < 0 || !entity.deleted )
+                if ( id < 0 || !entity.deleted || entity.parentsLoaded==ifUnused)
                     continue;
                     
                 var xml:XML = serialise(entity);
@@ -276,6 +429,10 @@ package net.systemeD.halcyon.connection {
             xml.@id = entity.id;
             xml.@version = entity.version;
             for each( var tag:Tag in entity.getTagArray() ) {
+              if (tag.key == 'created_by') {
+                entity.setTag('created_by', null, MainUndoStack.getGlobalStack().addAction);
+                continue;
+              }
               var tagXML:XML = <tag/>
               tagXML.@k = tag.key;
               tagXML.@v = tag.value;
@@ -283,5 +440,34 @@ package net.systemeD.halcyon.connection {
             }
         }
 
+        override public function fetchUserTraces(refresh:Boolean=false):void {
+            if (traces_loaded && !refresh) {
+              dispatchEvent(new Event(TRACES_LOADED));
+            } else {
+              sendOAuthGet(apiBaseURL+"user/gpx_files", tracesLoadComplete, errorOnMapLoad, mapLoadStatus); //needs error handlers
+              dispatchEvent(new Event(LOAD_STARTED)); //specific to map or reusable?
+            }
+        }
+
+               private function tracesLoadComplete(event:Event):void {
+                       var files:XML = new XML(URLLoader(event.target).data);
+                       for each(var traceData:XML in files.gpx_file) {
+                               var t:Trace = findTrace(traceData.@id);
+                               if (!t) { t=new Trace(this); addTrace(t); }
+                               t.fromXML(traceData);
+                       }
+                       traces_loaded = true;
+                       dispatchEvent(new Event(LOAD_COMPLETED));
+                       dispatchEvent(new Event(TRACES_LOADED));
+               }
+
+        override public function fetchTrace(id:Number, callback:Function):void {
+            sendOAuthGet(apiBaseURL+"gpx/"+id+"/data.xml", 
+                               function(e:Event):void { 
+                       dispatchEvent(new Event(LOAD_COMPLETED));
+                                       callback(e);
+                               }, errorOnMapLoad, mapLoadStatus); // needs error handlers
+            dispatchEvent(new Event(LOAD_STARTED)); //specifc to map or reusable?
+        }
        }
 }