remove global debug flags and use embedded ‘debug’ and ‘debug_deep’ instead
[myslice.git] / plugins / googlemap / static / js / googlemap.js
index d3784b8..082a0c5 100644 (file)
@@ -8,13 +8,16 @@
  * - infowindow is not properly reopened when the maps does not have the focus
  */
 
-// events that happen in the once-per-view range
-googlemap_debug=false;
-// more on a on-per-record basis
-googlemap_debug_detailed=false;
-
 (function($){
 
+    // events that happen in the once-per-view range
+    var debug=false;
+    debug=true;
+
+    // more on a on-per-record basis
+    var debug_deep=false;
+    // debug_deep=true;
+
     var GoogleMap = Plugin.extend({
 
         init: function(options, element) {
@@ -27,10 +30,10 @@ googlemap_debug_detailed=false;
             this.in_set_backlog = [];
 
             // we keep a couple of global hashes
-           // lat_lon --> { marker, <ul> }
-           // hrn --> { <li>, <input> }
-           this.by_lat_lon = {};
-           this.by_hrn = {};
+               // lat_lon --> { marker, <ul> }
+               // id --> { <li>, <input> }
+               this.by_lat_lon = {};
+               this.by_id = {};
 
             /* XXX Events */
             this.elmt().on('show', this, this.on_show);
@@ -40,9 +43,24 @@ googlemap_debug_detailed=false;
             var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
             this.object = query.object;
 
-            var keys = manifold.metadata.get_key(this.object);
+        //    var keys = manifold.metadata.get_key(this.object);
            // 
+        //    this.key = (keys && keys.length == 1) ? keys[0] : null;
+
+           // xxx temporary hack
+           // as of nov. 28 2013 we have here this.key='urn', but in any place where
+           // the code tries to access record[this.key] the records only have
+           // keys=type,hrn,network_hrn,hostname
+           // so for now we force using hrn instead
+           // as soon as record have their primary key set this line can be removed
+           // see also same hack in querytable
+           //this.key= (this.key == 'urn') ? 'hrn' : this.key;
+        this.key = (this.options.id_key);
+        if (typeof(this.key)=='undefined' || (this.key).startsWith("unknown")) {
+            // if not specified by caller, decide from metadata
+            var keys = manifold.metadata.get_key(this.object);
             this.key = (keys && keys.length == 1) ? keys[0] : null;
+        }
 
             //// Setup query and record handlers 
            // this query is the one about the slice itself 
@@ -59,7 +77,7 @@ googlemap_debug_detailed=false;
         /* PLUGIN EVENTS */
 
         on_show: function(e) {
-           if (googlemap_debug) messages.debug("googlemap.on_show");
+           if (debug) messages.debug("googlemap.on_show");
             var googlemap = e.data;
             google.maps.event.trigger(googlemap.map, 'resize');
         }, // on_show
@@ -70,45 +88,42 @@ googlemap_debug_detailed=false;
 
         initialize_map: function() {
             this.markerCluster = null;
-
+            //create empty LatLngBounds object in order to automatically center the map on the displayed objects
+            this.bounds = new google.maps.LatLngBounds();
             var center = new google.maps.LatLng(this.options.latitude, this.options.longitude);
             var myOptions = {
                 zoom: this.options.zoom,
                 center: center,
-               scrollwheel: false,
+                       scrollwheel: false,
                 mapTypeId: google.maps.MapTypeId.ROADMAP,
             }
            
             var domid = this.options.plugin_uuid + '--' + 'googlemap';
-           var elmt = document.getElementById(domid);
-           if (googlemap_debug) messages.debug("gmap.initialize_map based on  domid=" + domid + " elmt=" + elmt);
+               var elmt = document.getElementById(domid);
+               if (debug) messages.debug("gmap.initialize_map based on  domid=" + domid + " elmt=" + elmt);
             this.map = new google.maps.Map(elmt, myOptions);
             this.infowindow = new google.maps.InfoWindow();
         }, // initialize_map
 
-       // xxx probably not the right place
-        // The function accepts both records and their key 
-       record_hrn : function (record) {
-            var key_value;
-            switch (manifold.get_type(record)) {
+        // The function accepts both records and their id
+       // record.key points to the name of the primary key for this record
+       // typically this is 'urn'
+       record_id : function (input) {
+            var id;
+            switch (manifold.get_type(input)) {
             case TYPE_VALUE:
-               key_value = record;
+               id = input;
                 break;
             case TYPE_RECORD:
-               if ( ! this.key in record ) return;
-                key_value = record[this.key];
+               if ( ! this.key in input ) return;
+                id = input[this.key];
                 break;
             default:
-                throw "Not implemented";
+                throw "googlemap.record_id: not implemented";
                 break;
             }
-           // XXX BACKSLASHES original code was reading like this
-           //return this.escape_id(key_value).replace(/\\/g, '');
-           //  however this sequence removes backslashes from hrn's and as a result
-           // queryupdater was getting all mixed up
-           // querytable does publish hrn's with backslashes and that seems like the thing to do
-           return key_value;
-       },          
+           return id;
+       },
 
        // return { marker: gmap_marker, ul : <ul DOM> }
        create_marker_struct: function (object,lat,lon) {
@@ -122,44 +137,55 @@ googlemap_debug_detailed=false;
                 title: object,
                // gmap can deal with a DOM element but not a jquery object
                 content: dom.get(0),
-            }); 
+        }); 
+        //extend the bounds to include each marker's position
+        this.bounds.extend(marker.position);
            return {marker:marker, ul:ul};
        },
 
-       // add an entry in the marker <ul> tag for that record
-       // returns { checkbox : <input DOM> }
+       // given an input <ul> element, this method inserts a <li> with embedded checkbox 
+       // for displaying/selecting the resource corresponding to the input record
+       // returns the created <input> element for further checkbox manipulation
        create_record_checkbox: function (record,ul,checked) {
            var checkbox = $("<input>", {type:'checkbox', checked:checked, class:'geo'});
-           var hrn=this.record_hrn(record);
+           var id=this.record_id(record);
+           // use hrn as far as possible for displaying
+           // var label= ('hrn' in record) ? record.hrn : id;
+           var label= (this.key in record) ? record[this.key] : id;
            ul.append($("<li>").addClass("geo").append(checkbox).
-                     append($("<span>").addClass("geo").append(hrn)));
+                     append($("<span>").addClass("geo").append(label)));
            var googlemap=this;
            // the callback for when a user clicks
            // NOTE: this will *not* be called for changes done by program
            checkbox.change( function (e) {
-               if (googlemap_debug) messages.debug("googlemap click handler checked= " + this.checked + " hrn=" + hrn);
-               manifold.raise_event (googlemap.options.query_uuid, 
-                                     this.checked ? SET_ADD : SET_REMOVED, hrn);
+               manifold.raise_event (googlemap.options.query_uuid, this.checked ? SET_ADD : SET_REMOVED, id);
            });
            return checkbox;
        },
            
+       warning: function (record,message) {
+           try {messages.warning (message+" -- "+this.key+"="+record[this.key]); }
+           catch (err) {messages.warning (message); }
+       },
+           
        // retrieve DOM checkbox and make sure it is checked/unchecked
-        set_checkbox: function(record, checked) {
-           var hrn=this.record_hrn (record);
-           if (! hrn) { 
-               try {messages.warning ("googlemap.set_checkbox: record has no hrn -- hostname="+record.hostname); }
-               catch (err) {messages.warning ("googlemap.set_checkbox: record has no hrn"); }
+    set_checkbox: function(record, checked) {
+           var id=this.record_id (record);
+           if (! id) { 
+               this.warning (record, "googlemap.set_checkbox: record has no id");
                return; 
            }
-           var checkbox_s = this.by_hrn [ hrn ];
-           if (! checkbox_s ) { messages.warning ("googlemap.set_checkbox: could not spot checkbox for hrn "+hrn); return; }
-           checkbox_s.checkbox.prop('checked',checked);
-        }, // set_checkbox
+           var checkbox = this.by_id [ id ];
+           if (! checkbox ) { 
+               this.warning (record, "googlemap.set_checkbox: checkbox not found");
+               return; 
+           }
+           checkbox.prop('checked',checked);
+     }, // set_checkbox
 
        // this record is *in* the slice
         new_record: function(record) {
-               if (googlemap_debug_detailed) messages.debug ("new_record");
+           if (debug_deep) messages.debug ("googlemap.new_record");
             if (!(record['latitude'])) return false;
            
             // get the coordinates
@@ -172,35 +198,23 @@ googlemap_debug_detailed=false;
            // i.e. consider 2 places equal if not further away than 300m or so...
            var marker_s = this.by_lat_lon [lat_lon];
            if ( marker_s == null ) {
-                       marker_s = this.create_marker_struct (this.object, latitude, longitude);
-                       this.by_lat_lon [ lat_lon ] = marker_s;
-                       this.arm_marker(marker_s.marker, this.map);
-               }
+               marker_s = this.create_marker_struct (this.object, latitude, longitude);
+               this.by_lat_lon [ lat_lon ] = marker_s;
+               this.arm_marker(marker_s.marker, this.map);
+           }
            
            // now add a line for this resource in the marker
            // xxx should compute checked here ?
            // this is where the checkbox will be appended
            var ul=marker_s.ul;
            var checkbox = this.create_record_checkbox (record, ul, false);
-           if ( ! this.key in record ) return;
-            var key_value = record[this.key];
-           // see XXX BACKSLASHES 
-           //var hrn = this.escape_id(key_value).replace(/\\/g, '');
-           var hrn = key_value;
-            this.by_hrn[hrn] = {
-                   checkbox: checkbox,
-                       // xxx Thierry sept 2013
-                       // xxx actually we might have just used a domid-based scheme instead of the hash
-                       // since at this point we only need to retrieve the checkbox from an hrn
-                       // but I was not sure enough that extra needs would not show up so I kept this in place
-                       // xxx not sure these are actually useful :
-                value: key_value,
-                record: record,
-            }
+           var id=this.record_id(record);
+           // used to keep a dict here, but only checkbox is required
+            this.by_id[id] = checkbox;
         }, // new_record
 
         arm_marker: function(marker, map) {
-           if (googlemap_debug_detailed) messages.debug ("arm_marker content="+marker.content);
+           if (debug_deep) messages.debug ("arm_marker content="+marker.content);
             var googlemap = this;
             google.maps.event.addListener(marker, 'click', function () {
                 googlemap.infowindow.close();
@@ -213,7 +227,7 @@ googlemap_debug_detailed=false;
 
         /*************************** RECORD HANDLER ***************************/
         on_new_record: function(record) {
-           if (googlemap_debug_detailed) messages.debug("on_new_record");
+           if (debug_deep) messages.debug("on_new_record");
             if (this.received_all)
                 // update checkbox for record
                 this.set_checkbox(record, true);
@@ -223,25 +237,25 @@ googlemap_debug_detailed=false;
         },
 
         on_clear_records: function(record) {
-           if (googlemap_debug_detailed) messages.debug("on_clear_records");
+           if (debug_deep) messages.debug("on_clear_records");
         },
 
         // Could be the default in parent
         on_query_in_progress: function() {
-           if (googlemap_debug) messages.debug("on_query_in_progress (spinning)");
+           if (debug) messages.debug("on_query_in_progress (spinning)");
             this.spin();
         },
 
         on_query_done: function() {
-           if (googlemap_debug) messages.debug("on_query_done");           
+               if (debug) messages.debug("on_query_done");         
             if (this.received_all) {
                 this.unspin();
-           }
+               }
             this.received_set = true;
         },
 
         on_field_state_changed: function(data) {
-           if (googlemap_debug_detailed) messages.debug("on_field_state_changed");         
+           if (debug_deep) messages.debug("on_field_state_changed");       
             switch(data.request) {
             case FIELD_REQUEST_ADD:
             case FIELD_REQUEST_ADD_RESET:
@@ -260,22 +274,22 @@ googlemap_debug_detailed=false;
         // all : this 
 
         on_all_new_record: function(record) {
-           if (googlemap_debug_detailed) messages.debug("on_all_new_record");
+           if (debug_deep) messages.debug("on_all_new_record");
             this.new_record(record);
         },
 
         on_all_clear_records: function() {
-           if (googlemap_debug) messages.debug("on_all_clear_records");            
+           if (debug) messages.debug("on_all_clear_records");      
         },
 
         on_all_query_in_progress: function() {
-           if (googlemap_debug) messages.debug("on_all_query_in_progress (spinning)");
+           if (debug) messages.debug("on_all_query_in_progress (spinning)");
             // XXX parent
             this.spin();
         },
 
         on_all_query_done: function() {
-           if (googlemap_debug) messages.debug("on_all_query_done");
+           if (debug) messages.debug("on_all_query_done");
 
             // MarkerClusterer
             var markers = [];
@@ -290,7 +304,12 @@ googlemap_debug_detailed=false;
                 //map.setCenter(bounds.getCenter(), map.getBoundsZoomLevel(bounds));
                 this.map.fitBounds(bounds);
             });
-
+            //now fit the map to the bounds
+            this.map.fitBounds(this.bounds);
+            // Fix the zoom of fitBounds function, it's too close when there is only 1 marker
+            if(markers.length==1){
+                this.map.setZoom(this.map.getZoom()-4);
+            }
             var googlemap = this;
             if (this.received_set) {
                 /* ... and check the ones specified in the resource list */
@@ -300,7 +319,7 @@ googlemap_debug_detailed=false;
                // reset 
                googlemap.in_set_backlog = [];
 
-               if (googlemap_debug) messages.debug("unspinning");
+               if (debug) messages.debug("unspinning");
                 this.unspin();
             }
             this.received_all = true;