/**
- * Description: display a query result in a googlemap
- * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
+ * Description: display a query result in a Google map
+ * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA
* License: GPLv3
*/
-/*
- * It's a best practice to pass jQuery to an IIFE (Immediately Invoked Function
- * Expression) that maps it to the dollar sign so it can't be overwritten by
- * another library in the scope of its execution.
+/* BUGS:
+ * - infowindow is not properly reopened when the maps does not have the focus
*/
+GOOGLEMAP_BGCOLOR_RESET = 0;
+GOOGLEMAP_BGCOLOR_ADDED = 1;
+GOOGLEMAP_BGCOLOR_REMOVED = 2;
+
(function($){
- var PLUGIN_NAME = 'GoogleMap';
+ // events that happen in the once-per-view range
+ var debug=false;
+ debug=true;
- // routing calls
- jQuery.fn.GoogleMap = function( method ) {
- if ( methods[method] ) {
- return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));
- } else if ( typeof method === 'object' || ! method ) {
- return methods.init.apply( this, arguments );
- } else {
- jQuery.error( 'Method ' + method + ' does not exist on jQuery.' + PLUGIN_NAME );
- }
- };
+ // this now should be obsolete, rather use plugin_debug in plugin.js
+ // more on a on-per-record basis
+ var debug_deep=false;
+ // debug_deep=true;
- /***************************************************************************
- * Public methods
- ***************************************************************************/
+ var GoogleMap = Plugin.extend({
- var methods = {
+ /**************************************************************************
+ * CONSTRUCTOR
+ **************************************************************************/
- /**
- * @brief Plugin initialization
- * @param options : an associative array of setting values
- * @return : a jQuery collection of objects on which the plugin is
- * applied, which allows to maintain chainability of calls
- */
- init : function( options ) {
-
- return this.each(function(){
-
- var $this = $(this);
+ init: function(options, element)
+ {
+ this._super(options, element);
+
+ /* Member variables */
+
+ /* we keep a couple of global hashes
+ * lat_lon --> { marker, <ul> }
+ * id --> { <li>, <input> }
+ */
+ this.by_lat_lon = {};
+ /* locating checkboxes by DOM selectors might be abstruse, as we cannot safely assume
+ * all the items will belong under the toplevel <div>
+ */
+ this.by_id = {};
+ this.by_init_id = {};
+
+ this.markers = Array();
+
+ /* Events */
+ this.elmt().on('show', this, this.on_show);
+ this.elmt().on('shown.bs.tab', this, this.on_show);
+ this.elmt().on('resize', this, this.on_resize);
+
+ var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
+ this.object = query.object;
+
+ /* see querytable.js for an explanation */
+ var keys = manifold.metadata.get_key(this.object);
+ this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
+ this.init_key = this.options.init_key;
+ this.init_key = this.init_key || this.canonical_key;
+
+ /* sanity check */
+ if ( ! this.init_key )
+ messages.warning ("QueryTable : cannot find init_key");
+ if ( ! this.canonical_key )
+ messages.warning ("QueryTable : cannot find canonical_key");
+ if (debug)
+ messages.debug("googlemap: canonical_key="+this.canonical_key+" init_key="+this.init_key);
+
+ this.listen_query(options.query_uuid);
+
+ /* GUI setup and event binding */
+ this.initialize_map();
- /* An object that will hold private variables and methods */
- var plugin = new GoogleMaps(options);
- $this.data('Manifold', plugin);
+ }, // init
- plugin.initialize();
+ /**************************************************************************
+ * PLUGIN EVENTS
+ **************************************************************************/
- /* Events */
- $this.on('show.' + PLUGIN_NAME, methods.show);
+ on_show: function(e) {
+ if (debug) messages.debug("googlemap.on_show");
+ var self = e.data;
+ var center = new google.maps.LatLng(self.options.latitude, self.options.longitude);
- $this.set_query_handler(options.query_uuid, plugin.query_handler);
- $this.set_record_handler(options.query_uuid, plugin.record_handler);
- $this.set_record_handler(options.query_all_uuid, plugin.record_handler_all);
+ google.maps.event.trigger(self.map, 'resize');
+ self.map.setCenter(center);
+ },
- }); // this.each
- }, // init
+ /**************************************************************************
+ * GUI MANIPULATION
+ **************************************************************************/
- /**
- * @brief Plugin destruction
- * @return : a jQuery collection of objects on which the plugin is
- * applied, which allows to maintain chainability of calls
- */
- destroy : function( ) {
+ 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);
- return this.each(function() {
- var $this = $(this);
- var hazelnut = $this.data('Manifold');
+ var myOptions = {
+ zoom: this.options.zoom,
+ center: center,
+ scrollwheel: false,
+ mapTypeId: google.maps.MapTypeId.ROADMAP,
+ }
+
+ var domid = this.id('googlemap');
+ var elmt = document.getElementById(domid);
+ this.map = new google.maps.Map(elmt, myOptions);
+ this.infowindow = new google.maps.InfoWindow();
- // Unbind all events using namespacing
- $(window).unbind(PLUGIN_NAME);
+ }, // initialize_map
- // Remove associated data
- hazelnut.remove();
- $this.removeData('Manifold');
+ // return { marker: gmap_marker, ul : <ul DOM> }
+ create_marker_struct: function(object, lat, lon)
+ {
+ /* the DOM fragment */
+ var dom = $("<p>").addClass("geo").append(object+"(s)");
+ var ul = $("<ul>").addClass("geo");
+ dom.append(ul);
+ /* add a gmap marker to the mix */
+ var marker = new google.maps.Marker({
+ position: new google.maps.LatLng(lat, lon),
+ title: object,
+ /* gmap can deal with a DOM element but not a jquery object */
+ content: dom.get(0),
+ keys: Array(),
+ });
+ //extend the bounds to include each marker's position
+ this.bounds.extend(marker.position);
+ return { marker: marker, ul: ul };
+ },
+
+ /* 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 key, key_value, data;
+
+ var checkbox = $("<input>", {type:'checkbox', checked:checked, class:'geo'});
+ var id = record[this.canonical_key];
+ var init_id = record[this.init_key];
+
+ // xxx use init_key to find out label - or should we explicitly accept an incoming label_key ?
+ var label = init_id;
+
+ key = this.canonical_key;
+ key_value = manifold.record_get_value(record, key);
+
+ ul.append($("<li>").addClass("geo")
+ .append($('<div>') // .addId(this.id_from_key(key, key_value))
+ .append(checkbox)
+ .append($("<span>").addClass("geo")
+ .append(label)
+ )
+ )
+ );
+
+ // XXX STATE / BACKGROUND
+
+ // hash by id and by init_id
+ this.by_id[id]=checkbox;
+ this.by_init_id[init_id] = checkbox;
+
+ /* the callback for when a user clicks
+ * NOTE: this will *not* be called for changes done by program
+ */
+ var self=this;
+ checkbox.change( function (e) {
+ data = {
+ state: STATE_SET,
+ key : null,
+ op : this.checked ? STATE_SET_ADD : STATE_SET_REMOVE,
+ value: id
+ }
+ manifold.raise_event(self.options.query_uuid, FIELD_STATE_CHANGED, data);
});
+ return checkbox;
+ },
+
+ set_checkbox_from_record_key: function (record_key, checked)
+ {
+ if (checked === undefined) checked = true;
- }, // destroy
-
- show : function( ) {
- google.maps.event.trigger(map, 'resize');
- } // show
+ var checkbox = this.by_init_id [record_key];
+ if (!checkbox) {
+ console.log("googlemap.set_checkbox_from_record - not found " + record_key);
+ return;
+ }
- }; // var methods;
+ checkbox.attr('checked', checked);
+ },
- /***************************************************************************
- * Plugin object
- ***************************************************************************/
- function GoogleMaps(options)
- {
- /* member variables */
- this.options = options;
+ set_checkbox_from_data: function(id, checked)
+ {
+ var checkbox = this.by_id[id];
+ if (!checkbox) {
+ console.log("googlemap.set_checkbox_from_data - id not found " + id);
+ return;
+ }
+ checkbox.attr('checked', checked);
+ },
- // query status
- this.received_all = false;
- this.received_set = false;
- this.in_set_buffer = Array();
+ set_bgcolor: function(key_value, class_name)
+ {
+ var elt = $(document.getElementById(this.id_from_key(this.canonical_key, key_value)))
+ if (class_name == GOOGLEMAP_BGCOLOR_RESET)
+ elt.removeClass('added removed');
+ else
+ elt.addClass((class_name == GOOGLEMAP_BGCOLOR_ADDED ? 'added' : 'removed'));
+ },
- var object = this;
/**
+ * Populates both this.by_lat_lon and this.arm_marker arrays
*/
- this.initialize = function() {
- this.map = null;
- this.markerCluster = null;
- this.markers = [];
- this.coords = new Array();
+ new_record: function(record)
+ {
+ var record_key;
+
+ if (!(record['latitude']))
+ return;
+
+ /* get the coordinates*/
+ var latitude = unfold.get_value(record['latitude']);
+ var longitude = unfold.get_value(record['longitude']);
+ var lat_lon = latitude + longitude;
+
+ // check if we've seen anything at that place already
+ // xxx might make sense to allow for some fuzziness,
+ // 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);
+ }
+
+ /* Add key to the marker */
+ record_key = manifold.record_get_value(record, this.canonical_key);
+ marker_s.marker.keys.push(record_key);
+
+ // 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);
+ }, // new_record
+
+ arm_marker: function(marker, map)
+ {
+ var self = this;
+ google.maps.event.addListener(marker, 'click', function () {
+ self.infowindow.close();
+ self.infowindow.setContent(marker.content);
+ self.infowindow.open(map, marker);
+ });
+ }, // arm_marker
- var myLatlng = new google.maps.LatLng(options.latitude, options.longitude);
- var myOptions = {
- zoom: options.zoom,
- center: myLatlng,
- mapTypeId: google.maps.MapTypeId.ROADMAP
- }
-
- this.map = new google.maps.Map(document.getElementById("map"), myOptions);
- this.infowindow = new google.maps.InfoWindow();
- }
+ clear_map: function()
+ {
+ /* XXX */
+ },
- /**
- */
- this.new_record = function(record)
+ filter_map: function()
{
+ var self = this;
+ var visible;
+
+ /* Loop on every marker and sets it visible */
+ $.each(this.markers, function(i, marker) {
+ /* For a marker to be visible, at least one of its keys has to
+ * be visible */
+ visible = false;
+ $.each(marker.keys, function(j, key) {
+ visible = visible || manifold.query_store.get_record_state(self.options.query_uuid, key, STATE_VISIBLE);
+ });
+ marker.setVisible(visible);
+ });
- // get the coordinates
- var latitude=get_value(record['latitude']);
- var longitude=get_value(record['longitude']);
- var hash = latitude + longitude;
-
- // check to see if we've seen this hash before
- if(this.coords[hash] == null) {
- // get coordinate object
- var myLatlng = new google.maps.LatLng(latitude, longitude);
- // store an indicator that we've seen this point before
- this.coords[hash] = 1;
- } else {
- // add some randomness to this point 1500 = 100 meters, 15000 = 10 meters
- var lat = latitude + (Math.random() -.5) / 1500;
- var lng = longitude + (Math.random() -.5) / 1500;
-
- // get the coordinate object
- var myLatlng = new google.maps.LatLng(lat, lng);
- }
- // If the node is attached to the slice, action will be Remove; else action will be add to slice
- if (typeof(record['sliver']) != 'undefined') {
- data.current_resources.push(record['urn']);
- action="del";
- action_class="ui-icon-circle-minus";
- action_message="Remove from slice";
- }else{
- action="add";
- action_class="ui-icon-circle-plus";
- action_message="Add to slice";
- }
- // XXX not working
- if (!(record['latitude'])) {
- return true;
+ this.do_clustering();
+ },
+
+ do_clustering: function()
+ {
+ this.markerCluster = new MarkerClusterer(this.map, this.markers, {zoomOnClick: false});
+ this.markerCluster.setIgnoreHidden(true);
+ google.maps.event.addListener(this.markerCluster, "clusterclick", function (cluster) {
+ var cluster_markers = cluster.getMarkers();
+ var bounds = new google.maps.LatLngBounds();
+ $.each(cluster_markers, function(i, marker){
+ bounds.extend(marker.getPosition());
+ });
+ //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 (this.markers.length==1) {
+ this.map.setZoom(this.map.getZoom()-4);
}
+ },
- //jQuery(".map-button").click(button_click);
- //if(jQuery.inArray(record, rows)>-1){
- var marker = new google.maps.Marker({
- position: myLatlng,
- title: get_value(record['hostname']),
- // This should be done by the rendering
- content: '<p>Agent: ' + get_value(record['ip']) + ' (' + get_value(record['resource_hrn']) + ')<br/>Platform: ' + get_value(record['platform'])+'</p>' +
- '<div class="map-button" id="'+action+'/'+get_value(record['resource_hrn'])+'" style="cursor:pointer;">'+
- '<span class="ui-icon '+action_class+'" style="clear:both;float:left;"></span>'+action_message+
- '</div>'
- });
-
- this.addInfoWindow(marker, object.map);
- object.markers.push(marker);
- //}
-
- };
-
- this.addInfoWindow = function(marker, map) {
- google.maps.event.addListener(marker, 'click', function () {
- if(object.infowindow){
- object.infowindow.close();
+ redraw_map: function()
+ {
+ // Let's clear the table and only add lines that are visible
+ var self = this;
+ this.clear_map();
+
+ /* Add records to internal hash structure */
+ var record_keys = [];
+ manifold.query_store.iter_records(this.options.query_uuid, function (record_key, record) {
+ self.new_record(record);
+ record_keys.push(record_key);
+ });
+
+ /* Add markers to cluster */
+ this.markers = Array();
+ $.each(this.by_lat_lon, function (k, s) {
+ self.markers.push(s.marker);
+ });
+
+ this.do_clustering();
+
+
+ /* Set checkbox and background color */
+ $.each(record_keys, function(i, record_key) {
+ var state = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_SET);
+ var warnings = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_WARNINGS);
+ switch(state) {
+ // XXX The row and checkbox still does not exists !!!!
+ case STATE_SET_IN:
+ case STATE_SET_IN_SUCCESS:
+ case STATE_SET_OUT_FAILURE:
+ self.set_checkbox_from_record_key(record_key, true);
+ break;
+ case STATE_SET_OUT:
+ case STATE_SET_OUT_SUCCESS:
+ case STATE_SET_IN_FAILURE:
+ break;
+ case STATE_SET_IN_PENDING:
+ self.set_checkbox_from_record_key(record_key, true);
+ self.set_bgcolor(record_key, GOOGLEMAP_BGCOLOR_ADDED);
+ break;
+ case STATE_SET_OUT_PENDING:
+ self.set_bgcolor(record_key, GOOGLEMAP_BGCOLOR_REMOVED);
+ break;
}
- object.infowindow.setContent(marker.content);// = new google.maps.InfoWindow({ content: marker.content });
- object.infowindow.open(map, marker);
- // onload of the infowindow on the map, bind a click on a button
- google.maps.event.addListener(object.infowindow, 'domready', function() {
- jQuery('.map-button').unbind('click');
-// jQuery(".map-button").click({instance: instance_, infoWindow: object.infowindow}, button_click);
- });
+ //self.change_status(record_key, warnings); // XXX will retrieve status again
});
- }
+ },
+ /**************************************************************************
+ * QUERY HANDLERS
+ **************************************************************************/
- this.set_checkbox = function(record)
+ on_filter_added: function(filter)
{
- // XXX urn should be replaced by the key
- // XXX we should enforce that both queries have the same key !!
- //checkbox_id = "#hazelnut-checkbox-" + object.options.plugin_uuid + "-" + unfold.escape_id(record[ELEMENT_KEY].replace(/\\/g, ''))
- //$(checkbox_id, object.table.fnGetNodes()).attr('checked', true);
- }
+ this.filter_map();
+ },
- this.record_handler = function(e, event_type, record)
+ on_filter_removed: function(filter)
{
- // elements in set
- switch(event_type) {
- case NEW_RECORD:
- /* NOTE in fact we are doing a join here */
- if (object.received_all)
- // update checkbox for record
- object.set_checkbox(record);
- else
- // store for later update of checkboxes
- object.in_set_buffer.push(record);
- break;
- case CLEAR_RECORDS:
- // nothing to do here
- break;
- case IN_PROGRESS:
- manifold.spin($(this));
- break;
- case DONE:
- if (object.received_all)
- manifold.spin($(this), false);
- object.received_set = true;
- break;
- }
- };
+ this.filter_map();
+ },
+
+ on_filter_clear: function()
+ {
+ this.filter_map();
+ },
- this.record_handler_all = function(e, event_type, record)
+ on_query_in_progress: function()
{
- // all elements
- switch(event_type) {
- case NEW_RECORD:
- // Add the record to the table
- object.new_record(record);
- break;
- case CLEAR_RECORDS:
- // object.table.fnClearTable();
- break;
- case IN_PROGRESS:
- manifold.spin($(this));
- break;
- case DONE:
-
- // MarkerClusterer
- object.markerCluster = new MarkerClusterer(object.map, object.markers, {zoomOnClick: false});
- google.maps.event.addListener(object.markerCluster, "clusterclick", function (cluster) {
- var markers = cluster.getMarkers();
- var bounds = new google.maps.LatLngBounds();
- /*
- * date: 24/05/2012
- * author: lbaron
- * Firefox JS Error - replaced $.each by JQuery.each
- */
- jQuery.each(markers, function(i, marker){
- bounds.extend(marker.getPosition());
- });
-
- //map.setCenter(bounds.getCenter(), map.getBoundsZoomLevel(bounds));
- object.map.fitBounds(bounds);
- });
-
- if (object.received_set) {
- /* XXX needed ? XXX We uncheck all checkboxes ... */
- $("[id^='datatables-checkbox-" + object.options.plugin_uuid +"']").attr('checked', false);
-
- /* ... and check the ones specified in the resource list */
- $.each(object.in_set_buffer, function(i, record) {
- object.set_checkbox(record);
- });
-
- manifold.spin($(this), false);
- }
- object.received_all = true;
- break;
- }
- };
+ this.spin();
+ },
+ on_query_done: function()
+ {
+ this.redraw_map();
+ this.unspin();
+ },
- this.query_handler = function(e, event_type, query)
+ on_field_state_changed: function(data)
{
- // This replaces the complex set_query function
- // The plugin does not need to remember the query anymore
- switch(event_type) {
- // Filters
- case FILTER_ADDED:
- case FILTER_REMOVED:
- case CLEAR_FILTERS:
+ switch(data.state) {
+ case STATE_SET:
+ switch(data.value) {
+ case STATE_SET_IN:
+ case STATE_SET_IN_SUCCESS:
+ case STATE_SET_OUT_FAILURE:
+ this.set_checkbox_from_data(data.key, true);
+ this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_RESET);
+ break;
+ case STATE_SET_OUT:
+ case STATE_SET_OUT_SUCCESS:
+ case STATE_SET_IN_FAILURE:
+ this.set_checkbox_from_data(data.key, false);
+ this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_RESET);
+ break;
+ case STATE_SET_IN_PENDING:
+ this.set_checkbox_from_data(data.key, true);
+ this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_ADDED);
+ break;
+ case STATE_SET_OUT_PENDING:
+ this.set_checkbox_from_data(data.key, false);
+ this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_REMOVED);
+ break;
+ }
break;
- // Fields
- /* Hide/unhide columns to match added/removed fields */
- case FIELD_ADDED:
+ case STATE_WARNINGS:
+ //this.change_status(data.key, data.value);
break;
- case FIELD_REMOVED:
- break;
- case CLEAR_FIELDS:
- alert('GoogleMaps::clear_fields() not implemented');
- break;
- } // switch
+ }
+ },
+ });
- }
+ $.plugin('GoogleMap', GoogleMap);
- function button_click(e){
- var op_value=this.id.split("/");
- if(op_value.length>0){
- var value = op_value[1];
- manifold.raise_event(object.options.query_uuid, (op_value[0] == 'add')?SET_ADD:SET_REMOVED, value);
- }
- } // function button_click()
- }
-
- // clear and replace
-// jQuery.each(data.results, function(i, row){
-// jQuery.each(query.filter, function (idx, filter){
-// if(get_value(row[filter[0]])==filter[2]){
-// rows.push(row);
-// }
-// });
-// });
-// data.markerCluster=[];
-// data.markers=[];
-// var myLatlng = new google.maps.LatLng(34.397, 150.644);
-// var myOptions = {
-// zoom: 2,
-// center: myLatlng,
-// mapTypeId: google.maps.MapTypeId.ROADMAP
-// }
-// map = new google.maps.Map(jQuery('#map')[0],myOptions);
-// data.map=map;
-// //map.clearMarkers();
-// update_map(e, rows);
-// }
-// }
-
-})( jQuery );
+})(jQuery);
git://git.onelab.eu / unfold.git / blobdiff