various fixes for querytable and googlemap
[myslice.git] / plugins / googlemap / static / js / googlemap.js
1 /**
2  * Description: display a query result in a Google map
3  * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA
4  * License: GPLv3
5  */
6
7 /* BUGS:
8  * - infowindow is not properly reopened when the maps does not have the focus
9  */
10
11 (function($){
12
13     // events that happen in the once-per-view range
14     var debug=false;
15     debug=true;
16
17     // more on a on-per-record basis
18     var debug_deep=false;
19     // debug_deep=true;
20
21     var GoogleMap = Plugin.extend({
22
23         init: function(options, element) {
24             this._super(options, element);
25
26             /* Member variables */
27             // query status
28             this.received_all = false;
29             this.received_set = false;
30             this.in_set_backlog = [];
31
32             // we keep a couple of global hashes
33             // lat_lon --> { marker, <ul> }
34             // id --> { <li>, <input> }
35             this.by_lat_lon = {};
36             // locating checkboxes by DOM selectors might be abstruse, as we cannot safely assume 
37             // all the items will belong under the toplevel <div>
38             this.by_id = {};
39             this.by_init_id = {};
40
41             /* XXX Events */
42             this.elmt().on('show', this, this.on_show);
43             // TODO in destructor
44             // $(window).unbind('QueryTable');
45
46             var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
47             this.object = query.object;
48
49             // see querytable.js for an explanation
50             var keys = manifold.metadata.get_key(this.object);
51             this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
52             // 
53             this.init_key = this.options.init_key;
54             // have init_key default to canonical_key
55             this.init_key = this.init_key || this.canonical_key;
56             // sanity check
57             if ( ! this.init_key ) messages.warning ("QueryTable : cannot find init_key");
58             if ( ! this.canonical_key ) messages.warning ("QueryTable : cannot find canonical_key");
59             if (debug) messages.debug("googlemap: canonical_key="+this.canonical_key+" init_key="+this.init_key);
60
61             //// Setup query and record handlers 
62             // this query is the one about the slice itself 
63             // event related to this query will trigger callbacks like on_new_record
64             this.listen_query(options.query_uuid);
65             // this one is the complete list of resources
66             // and will be bound to callbacks like on_all_new_record
67             this.listen_query(options.query_all_uuid, 'all');
68
69             /* GUI setup and event binding */
70             this.initialize_map();
71         }, // init
72
73         /* PLUGIN EVENTS */
74
75         on_show: function(e) {
76             if (debug) messages.debug("googlemap.on_show");
77             var googlemap = e.data;
78             google.maps.event.trigger(googlemap.map, 'resize');
79         }, // on_show
80
81         /* GUI EVENTS */
82
83         /* GUI MANIPULATION */
84
85         initialize_map: function() {
86             this.markerCluster = null;
87             //create empty LatLngBounds object in order to automatically center the map on the displayed objects
88             this.bounds = new google.maps.LatLngBounds();
89             var center = new google.maps.LatLng(this.options.latitude, this.options.longitude);
90             var myOptions = {
91                 zoom: this.options.zoom,
92                 center: center,
93                         scrollwheel: false,
94                 mapTypeId: google.maps.MapTypeId.ROADMAP,
95             }
96             
97             var domid = this.options.plugin_uuid + '--' + 'googlemap';
98                 var elmt = document.getElementById(domid);
99                 if (debug) messages.debug("gmap.initialize_map based on  domid=" + domid + " elmt=" + elmt);
100             this.map = new google.maps.Map(elmt, myOptions);
101             this.infowindow = new google.maps.InfoWindow();
102         }, // initialize_map
103
104         // return { marker: gmap_marker, ul : <ul DOM> }
105         create_marker_struct: function (object,lat,lon) {
106             // the DOM fragment
107             var dom = $("<p>").addClass("geo").append(object+"(s)");
108             var ul = $("<ul>").addClass("geo");
109             dom.append(ul);
110             // add a gmap marker to the mix
111             var marker = new google.maps.Marker({
112                 position: new google.maps.LatLng(lat, lon),
113                 title: object,
114                 // gmap can deal with a DOM element but not a jquery object
115                 content: dom.get(0),
116         }); 
117         //extend the bounds to include each marker's position
118         this.bounds.extend(marker.position);
119             return {marker:marker, ul:ul};
120         },
121
122         // given an input <ul> element, this method inserts a <li> with embedded checkbox 
123         // for displaying/selecting the resource corresponding to the input record
124         // returns the created <input> element for further checkbox manipulation
125         create_record_checkbox: function (record,ul,checked) {
126             var checkbox = $("<input>", {type:'checkbox', checked:checked, class:'geo'});
127             var id=record[this.canonical_key];
128             var init_id=record[this.init_key];
129             // xxx use init_key to find out label - or should we explicitly accept an incoming label_key ?
130             var label=init_id;
131             ul.append($("<li>").addClass("geo").append(checkbox).
132                       append($("<span>").addClass("geo").append(label)));
133             // hash by id and by init_id 
134             this.by_id[id]=checkbox;
135             this.by_init_id[init_id] = checkbox;
136             //
137             // the callback for when a user clicks
138             // NOTE: this will *not* be called for changes done by program
139             var self=this;
140             checkbox.change( function (e) {
141                 manifold.raise_event (self.options.query_uuid, this.checked ? SET_ADD : SET_REMOVED, id);
142             });
143             return checkbox;
144         },
145             
146         warning: function (record,message) {
147             try {messages.warning (message+" -- "+this.key+"="+record[this.key]); }
148             catch (err) {messages.warning (message); }
149         },
150             
151         // retrieve DOM checkbox and make sure it is checked/unchecked
152         set_checkbox_from_record: function(record, checked) {
153             var init_id=record[this.init_key];
154             var checkbox = this.by_init_id [ init_id ];
155             if (checkbox) checkbox.prop('checked',checked);
156             else this.warning(record, "googlemap.set_checkbox_from_record - not found "+init_id);
157         }, 
158
159         set_checkbox_from_data: function(id, checked) {
160             var id=record [this.canonical_key];
161             var checkbox = this.by_id [ id ];
162             if (checkbox) checkbox.prop('checked',checked);
163             else this.warning(record, "googlemap.set_checkbox_from_data - not found "+init_id);
164         }, 
165
166         // this record is *in* the slice
167         new_record: function(record) {
168             if (debug_deep) messages.debug ("googlemap.new_record");
169             if (!(record['latitude'])) return false;
170             
171             // get the coordinates
172             var latitude=unfold.get_value(record['latitude']);
173             var longitude=unfold.get_value(record['longitude']);
174             var lat_lon = latitude + longitude;
175
176             // check if we've seen anything at that place already
177             // xxx might make sense to allow for some fuzziness, 
178             // i.e. consider 2 places equal if not further away than 300m or so...
179             var marker_s = this.by_lat_lon [lat_lon];
180             if ( marker_s == null ) {
181                 marker_s = this.create_marker_struct (this.object, latitude, longitude);
182                 this.by_lat_lon [ lat_lon ] = marker_s;
183                 this.arm_marker(marker_s.marker, this.map);
184             }
185             
186             // now add a line for this resource in the marker
187             // xxx should compute checked here ?
188             // this is where the checkbox will be appended
189             var ul=marker_s.ul;
190             var checkbox = this.create_record_checkbox (record, ul, false);
191         }, // new_record
192
193         arm_marker: function(marker, map) {
194             if (debug_deep) messages.debug ("arm_marker content="+marker.content);
195             var googlemap = this;
196             google.maps.event.addListener(marker, 'click', function () {
197                 googlemap.infowindow.close();
198                 googlemap.infowindow.setContent(marker.content);
199                 googlemap.infowindow.open(map, marker);
200             });
201         }, // arm_marker
202
203         /*************************** QUERY HANDLER ****************************/
204
205         /*************************** RECORD HANDLER ***************************/
206         on_new_record: function(record) {
207             if (debug_deep) messages.debug("on_new_record");
208             if (this.received_all)
209                 // update checkbox for record
210                 this.set_checkbox_from_record(record, true);
211             else
212                 // store for later update of checkboxes
213                 this.in_set_backlog.push(record);
214         },
215
216         on_clear_records: function(record) {
217             if (debug_deep) messages.debug("on_clear_records");
218         },
219
220         // Could be the default in parent
221         on_query_in_progress: function() {
222             if (debug) messages.debug("on_query_in_progress (spinning)");
223             this.spin();
224         },
225
226         on_query_done: function() {
227                 if (debug) messages.debug("on_query_done");         
228             if (this.received_all) {
229                 this.unspin();
230                 }
231             this.received_set = true;
232         },
233
234         on_field_state_changed: function(data) {
235             if (debug_deep) messages.debug("on_field_state_changed");       
236             switch(data.request) {
237             case FIELD_REQUEST_ADD:
238             case FIELD_REQUEST_ADD_RESET:
239                 this.set_checkbox_from_data(data.value, true);
240                 break;
241             case FIELD_REQUEST_REMOVE:
242             case FIELD_REQUEST_REMOVE_RESET:
243                 this.set_checkbox_from_data(data.value, false);
244                 break;
245             default:
246                 break;
247             }
248         },
249
250
251         // all : this 
252
253         on_all_new_record: function(record) {
254             if (debug_deep) messages.debug("on_all_new_record");
255             this.new_record(record);
256         },
257
258         on_all_clear_records: function() {
259             if (debug) messages.debug("on_all_clear_records");      
260         },
261
262         on_all_query_in_progress: function() {
263             if (debug) messages.debug("on_all_query_in_progress (spinning)");
264             // XXX parent
265             this.spin();
266         },
267
268         on_all_query_done: function() {
269             if (debug) messages.debug("on_all_query_done");
270
271             // MarkerClusterer
272             var markers = [];
273             $.each(this.by_lat_lon, function (k, s) { markers.push(s.marker); });
274             this.markerCluster = new MarkerClusterer(this.map, markers, {zoomOnClick: false});
275             google.maps.event.addListener(this.markerCluster, "clusterclick", function (cluster) {
276                 var cluster_markers = cluster.getMarkers();
277                 var bounds  = new google.maps.LatLngBounds();
278                 $.each(cluster_markers, function(i, marker){
279                     bounds.extend(marker.getPosition()); 
280                 });
281                 //map.setCenter(bounds.getCenter(), map.getBoundsZoomLevel(bounds));
282                 this.map.fitBounds(bounds);
283             });
284             //now fit the map to the bounds
285             this.map.fitBounds(this.bounds);
286             // Fix the zoom of fitBounds function, it's too close when there is only 1 marker
287             if(markers.length==1){
288                 this.map.setZoom(this.map.getZoom()-4);
289             }
290             var googlemap = this;
291             if (this.received_set) {
292                 /* ... and check the ones specified in the resource list */
293                 $.each(this.in_set_backlog, function(i, record) {
294                     googlemap.set_checkbox_from_record(record, true);
295                 });
296                 // reset 
297                 googlemap.in_set_backlog = [];
298
299                 if (debug) messages.debug("unspinning");
300                 this.unspin();
301             }
302             this.received_all = true;
303
304         } // on_all_query_done
305     });
306         /************************** PRIVATE METHODS ***************************/
307
308     $.plugin('GoogleMap', GoogleMap);
309
310 })(jQuery);