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 GOOGLEMAP_BGCOLOR_RESET   = 0;
  12 GOOGLEMAP_BGCOLOR_ADDED   = 1;
  13 GOOGLEMAP_BGCOLOR_REMOVED = 2;
  14
  15 (function($){
  16
  17     // events that happen in the once-per-view range
  18     var debug=false;
  19     debug=true;
  20
  21     // this now should be obsolete, rather use plugin_debug in plugin.js
  22     // more on a on-per-record basis
  23     var debug_deep=false;
  24     // debug_deep=true;
  25
  26     var GoogleMap = Plugin.extend({
  27
  28         /**************************************************************************
  29          *                          CONSTRUCTOR
  30          **************************************************************************/
  31
  32         init: function(options, element)
  33         {
  34             this._super(options, element);
  35
  36             /* Member variables */
  37
  38             /* we keep a couple of global hashes
  39              * lat_lon --> { marker, <ul> }
  40              * id --> { <li>, <input> }
  41              */
  42             this.by_lat_lon = {};
  43             /* locating checkboxes by DOM selectors might be abstruse, as we cannot safely assume
  44              * all the items will belong under the toplevel <div>
  45              */
  46             this.by_id = {};
  47             this.by_init_id = {};
  48
  49             this.markers = Array();
  50
  51             /* Events */
  52             this.elmt().on('show', this, this.on_show);
  53             this.elmt().on('shown.bs.tab', this, this.on_show);
  54             this.elmt().on('resize', this, this.on_resize);
  55
  56             var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
  57             this.object = query.object;
  58
  59             /* see querytable.js for an explanation */
  60             var keys = manifold.metadata.get_key(this.object);
  61             this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
  62             this.init_key = this.options.init_key;
  63             this.init_key = this.init_key || this.canonical_key;
  64
  65             /* sanity check */
  66             if ( ! this.init_key )
  67                 messages.warning ("QueryTable : cannot find init_key");
  68             if ( ! this.canonical_key )
  69                 messages.warning ("QueryTable : cannot find canonical_key");
  70             if (debug)
  71                 messages.debug("googlemap: canonical_key="+this.canonical_key+" init_key="+this.init_key);
  72
  73             this.listen_query(options.query_uuid);
  74
  75             /* GUI setup and event binding */
  76             this.initialize_map();
  77
  78         }, // init
  79
  80         /**************************************************************************
  81          *                         PLUGIN EVENTS
  82          **************************************************************************/
  83
  84         on_show: function(e) {
  85                 if (debug) messages.debug("googlemap.on_show");
  86             var googlemap = e.data;
  87             google.maps.event.trigger(googlemap.map, 'resize');
  88         },
  89
  90         /**************************************************************************
  91          *                        GUI MANIPULATION
  92          **************************************************************************/
  93
  94         initialize_map: function()
  95         {
  96             this.markerCluster = null;
  97             //create empty LatLngBounds object in order to automatically center the map on the displayed objects
  98             this.bounds = new google.maps.LatLngBounds();
  99             var center = new google.maps.LatLng(this.options.latitude, this.options.longitude);
 100
 101             var myOptions = {
 102                 zoom: this.options.zoom,
 103                 center: center,
 104                         scrollwheel: false,
 105                 mapTypeId: google.maps.MapTypeId.ROADMAP,
 106             }
 107
 108             var domid = this.id('googlemap');
 109                 var elmt = document.getElementById(domid);
 110             this.map = new google.maps.Map(elmt, myOptions);
 111             this.infowindow = new google.maps.InfoWindow();
 112
 113         }, // initialize_map
 114
 115         // return { marker: gmap_marker, ul : <ul DOM> }
 116         create_marker_struct: function(object, lat, lon)
 117         {
 118             /* the DOM fragment */
 119             var dom = $("<p>").addClass("geo").append(object+"(s)");
 120             var ul = $("<ul>").addClass("geo");
 121             dom.append(ul);
 122             /* add a gmap marker to the mix */
 123             var marker = new google.maps.Marker({
 124                 position: new google.maps.LatLng(lat, lon),
 125                 title: object,
 126                 /* gmap can deal with a DOM element but not a jquery object */
 127                 content: dom.get(0),
 128                 keys: Array(),
 129             });
 130             //extend the bounds to include each marker's position
 131             this.bounds.extend(marker.position);
 132             return { marker: marker, ul: ul };
 133         },
 134
 135         /* given an input <ul> element, this method inserts a <li> with embedded checkbox
 136          * for displaying/selecting the resource corresponding to the input record
 137          * returns the created <input> element for further checkbox manipulation
 138          */
 139         create_record_checkbox: function (record, ul, checked)
 140         {
 141             var key, key_value;
 142
 143             var checkbox = $("<input>", {type:'checkbox', checked:checked, class:'geo'});
 144             var id = record[this.canonical_key];
 145             var init_id = record[this.init_key];
 146
 147             // xxx use init_key to find out label - or should we explicitly accept an incoming label_key ?
 148             var label = init_id;
 149
 150             key = this.canonical_key;
 151             key_value = manifold.record_get_value(record, key);
 152
 153             ul.append($("<li>").addClass("geo")
 154               .append($('<div>') // .addId(this.id_from_key(key, key_value))
 155                 .append(checkbox)
 156                 .append($("<span>").addClass("geo")
 157                   .append(label)
 158                 )
 159               )
 160             );
 161
 162             // XXX STATE / BACKGROUND
 163
 164             // hash by id and by init_id
 165             this.by_id[id]=checkbox;
 166             this.by_init_id[init_id] = checkbox;
 167
 168             /* the callback for when a user clicks
 169              * NOTE: this will *not* be called for changes done by program
 170              */
 171             var self=this;
 172             checkbox.change( function (e) {
 173                 manifold.raise_event (self.options.query_uuid, this.checked ? SET_ADD : SET_REMOVED, id);
 174             });
 175             return checkbox;
 176         },
 177
 178         set_checkbox_from_record_key: function (record_key, checked)
 179         {
 180             if (checked === undefined) checked = true;
 181
 182             var checkbox = this.by_init_id [record_key];
 183             if (!checkbox) {
 184                 console.log("googlemap.set_checkbox_from_record - not found " + record_key);
 185                 return;
 186             }
 187
 188             checkbox.attr('checked', checked);
 189         },
 190
 191
 192         set_checkbox_from_data: function(id, checked)
 193         {
 194             var checkbox = this.by_id[id];
 195             if (!checkbox) {
 196                 console.log("googlemap.set_checkbox_from_data - id not found " + id);
 197                 return;
 198             }
 199             checkbox.attr('checked', checked);
 200         },
 201
 202         set_bgcolor: function(key_value, class_name)
 203         {
 204             var elt = $(document.getElementById(this.id_from_key(this.canonical_key, key_value)))
 205             if (class_name == GOOGLEMAP_BGCOLOR_RESET)
 206                 elt.removeClass('added removed');
 207             else
 208                 elt.addClass((class_name == GOOGLEMAP_BGCOLOR_ADDED ? 'added' : 'removed'));
 209         },
 210
 211
 212         /**
 213          * Populates both this.by_lat_lon and this.arm_marker arrays
 214          */
 215         new_record: function(record)
 216         {
 217             var record_key;
 218
 219             if (!(record['latitude']))
 220                 return;
 221
 222             /* get the coordinates*/
 223             var latitude  = unfold.get_value(record['latitude']);
 224             var longitude = unfold.get_value(record['longitude']);
 225             var lat_lon = latitude + longitude;
 226
 227             // check if we've seen anything at that place already
 228             // xxx might make sense to allow for some fuzziness,
 229             // i.e. consider 2 places equal if not further away than 300m or so...
 230             var marker_s = this.by_lat_lon[lat_lon];
 231             if ( marker_s == null ) {
 232                     marker_s = this.create_marker_struct(this.object, latitude, longitude);
 233                     this.by_lat_lon[lat_lon] = marker_s;
 234                     this.arm_marker(marker_s.marker, this.map);
 235                 }
 236
 237             /* Add key to the marker */
 238             record_key = manifold.record_get_value(record, this.canonical_key);
 239             marker_s.marker.keys.push(record_key);
 240
 241             // now add a line for this resource in the marker
 242             // xxx should compute checked here ?
 243             // this is where the checkbox will be appended
 244             var ul = marker_s.ul;
 245             var checkbox = this.create_record_checkbox(record, ul, false);
 246         }, // new_record
 247
 248         arm_marker: function(marker, map)
 249         {
 250             var self = this;
 251             google.maps.event.addListener(marker, 'click', function () {
 252                 self.infowindow.close();
 253                 self.infowindow.setContent(marker.content);
 254                 self.infowindow.open(map, marker);
 255             });
 256         }, // arm_marker
 257
 258         clear_map: function()
 259         {
 260             /* XXX */
 261         },
 262
 263         filter_map: function()
 264         {
 265             var self = this;
 266             var visible;
 267
 268             /* Loop on every marker and sets it visible */
 269             $.each(this.markers, function(i, marker) {
 270                 /* For a marker to be visible, at least one of its keys has to
 271                  * be visible */
 272                 visible = false;
 273                 $.each(marker.keys, function(j, key) {
 274                     visible = visible || manifold.query_store.get_record_state(self.options.query_uuid, key, STATE_VISIBLE);
 275                 });
 276                 marker.setVisible(visible);
 277             });
 278         },
 279
 280         redraw_map: function()
 281         {
 282             // Let's clear the table and only add lines that are visible
 283             var self = this;
 284             this.clear_map();
 285
 286             /* Add records to internal hash structure */
 287             var record_keys = [];
 288             manifold.query_store.iter_records(this.options.query_uuid, function (record_key, record) {
 289                 self.new_record(record);
 290                 record_keys.push(record_key);
 291             });
 292
 293             /* Add markers to cluster */
 294             this.markers = Array();
 295             $.each(this.by_lat_lon, function (k, s) {
 296                 self.markers.push(s.marker);
 297             });
 298
 299             this.markerCluster = new MarkerClusterer(this.map, this.markers, {zoomOnClick: false});
 300             google.maps.event.addListener(this.markerCluster, "clusterclick", function (cluster) {
 301                 var cluster_markers = cluster.getMarkers();
 302                 var bounds  = new google.maps.LatLngBounds();
 303                 $.each(cluster_markers, function(i, marker){
 304                     bounds.extend(marker.getPosition());
 305                 });
 306                 //map.setCenter(bounds.getCenter(), map.getBoundsZoomLevel(bounds));
 307                 this.map.fitBounds(bounds);
 308             });
 309             //now fit the map to the bounds
 310             this.map.fitBounds(this.bounds);
 311             // Fix the zoom of fitBounds function, it's too close when there is only 1 marker
 312             if (this.markers.length==1) {
 313                 this.map.setZoom(this.map.getZoom()-4);
 314             }
 315
 316             /* Set checkbox and background color */
 317             $.each(record_keys, function(i, record_key) {
 318                 var state = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_SET);
 319                 var warnings = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_WARNINGS);
 320                 switch(state) {
 321                     // XXX The row and checkbox still does not exists !!!!
 322                     case STATE_SET_IN:
 323                     case STATE_SET_IN_SUCCESS:
 324                     case STATE_SET_OUT_FAILURE:
 325                         self.set_checkbox_from_record_key(record_key, true);
 326                         break;
 327                     case STATE_SET_OUT:
 328                     case STATE_SET_OUT_SUCCESS:
 329                     case STATE_SET_IN_FAILURE:
 330                         break;
 331                     case STATE_SET_IN_PENDING:
 332                         self.set_checkbox_from_record_key(record_key, true);
 333                         self.set_bgcolor(record_key, GOOGLEMAP_BGCOLOR_ADDED);
 334                         break;
 335                     case STATE_SET_OUT_PENDING:
 336                         self.set_bgcolor(record_key, GOOGLEMAP_BGCOLOR_REMOVED);
 337                         break;
 338                 }
 339                 //self.change_status(record_key, warnings); // XXX will retrieve status again
 340             });
 341         },
 342
 343        /**************************************************************************
 344         *                           QUERY HANDLERS
 345         **************************************************************************/
 346
 347         on_filter_added: function(filter)
 348         {
 349             this.filter_map();
 350         },
 351
 352         on_filter_removed: function(filter)
 353         {
 354             this.filter_map();
 355         },
 356
 357         on_filter_clear: function()
 358         {
 359             this.filter_map();
 360         },
 361
 362         on_query_in_progress: function()
 363         {
 364             this.spin();
 365         },
 366
 367         on_query_done: function()
 368         {
 369             this.redraw_map();
 370             this.unspin();
 371         },
 372
 373         on_field_state_changed: function(data)
 374         {
 375             switch(data.request) {
 376                 case FIELD_REQUEST_ADD:
 377                 case FIELD_REQUEST_ADD_RESET:
 378                     this.set_checkbox_from_data(data.value, true);
 379                     break;
 380                 case FIELD_REQUEST_REMOVE:
 381                 case FIELD_REQUEST_REMOVE_RESET:
 382                     this.set_checkbox_from_data(data.value, false);
 383                     break;
 384                 default:
 385                     break;
 386             }
 387         },
 388
 389     });
 390
 391     $.plugin('GoogleMap', GoogleMap);
 392
 393 })(jQuery);