[gnome-maps/wip/mlundblad/transit-routing: 1/2] WIP: Add module to query an OpenTripPlanner instance
- From: Marcus Lundblad <mlundblad src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-maps/wip/mlundblad/transit-routing: 1/2] WIP: Add module to query an OpenTripPlanner instance
- Date: Wed, 9 Mar 2016 22:40:38 +0000 (UTC)
commit be524e87d22e40f4e25907501b1bb7e0e4ff5129
Author: Marcus Lundblad <ml update uu se>
Date: Mon Feb 15 23:18:14 2016 +0100
WIP: Add module to query an OpenTripPlanner instance
src/openTripPlanner.js | 262 ++++++++++++++++++++++++++++++++++
src/org.gnome.Maps.src.gresource.xml | 2 +
src/transitPlan.js | 111 ++++++++++++++
3 files changed, 375 insertions(+), 0 deletions(-)
---
diff --git a/src/openTripPlanner.js b/src/openTripPlanner.js
new file mode 100644
index 0000000..1b4a350
--- /dev/null
+++ b/src/openTripPlanner.js
@@ -0,0 +1,262 @@
+/* -*- Mode: JS2; indent-tabs-mode: nil; js2-basic-offset: 4 -*- */
+/* vim: set et ts=4 sw=4: */
+/*
+ * Copyright (c) 2016 Marcus Lundblad
+ *
+ * GNOME Maps is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * GNOME Maps is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with GNOME Maps; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Author: Marcus Lundblad <ml update uu se>
+ */
+
+const Lang = imports.lang;
+
+const Soup = imports.gi.Soup;
+
+const Application = imports.application;
+const HTTP = imports.http;
+const RouteQuery = imports.routeQuery;
+const TransitPlan = imports.transitPlan;
+const Utils = imports.utils;
+
+/* base URL used for testing against a local OTP instance for now */
+const _BASE_URL = 'http://localhost:8080/otp';
+
+/* timeout after which the routers data is considered stale and we will force
+ a reload (24 hours) */
+const _ROUTERS_TIMEOUT = 24 * 60 * 60;
+
+const OpenTripPlanner = new Lang.Class({
+ Name: 'OpenTripPlanner',
+
+ _init: function() {
+ this._session = new Soup.Session();
+ /* initially set routers as updated far back in the past to force
+ a download when first request */
+ this._routersUpdatedTimestamp = 0;
+ this._query = Application.routeQuery;
+ this._plan = new TransitPlan.Plan();
+ },
+
+ get plan() {
+ return this._plan;
+ },
+
+ connect: function() {
+ this._signalHandler = this._query.connect('notify::points', (function() {
+ if (this._query.isValid())
+ this.fetchRoute(this._query.filledPoints);
+ }).bind(this));
+ },
+
+ disconnect: function() {
+ if (this._signalHandler !== 0) {
+ this._query.disconnect(this._signalHandler);
+ this._signalHandler = 0;
+ }
+ },
+
+ _fetchRouters: function(callback) {
+ let currentTime = (new Date()).getTime();
+
+ if (currentTime - this._routersUpdatedTimestamp < _ROUTERS_TIMEOUT) {
+ callback(true);
+ } else {
+ let uri = new Soup.URI(_BASE_URL + '/routers');
+ let request = new Soup.Message({ method: 'GET', uri: uri });
+
+ request.request_headers.append('Accept', 'application/json');
+ this._session.queue_message(request, (function(obj, message) {
+ if (message.status_code !== Soup.Status.OK) {
+ callback(false);
+ return;
+ }
+
+ Utils.debug('routers: ' + message.response_body.data);
+ try {
+ this._routers = JSON.parse(message.response_body.data);
+ this._routersUpdatedTimestamp = (new Date()).getTime();
+ callback(true);
+ } catch (e) {
+ Utils.debug('Failed to parse router information');
+ callback(false);
+ }
+ }).bind(this));
+ }
+ },
+
+ _getRoutersForPlace: function(place) {
+ let routers = [];
+
+ Utils.debug('_getRotersForPlace');
+ Utils.debug('place coords: ' + place.location.latitude + ', ' + place.location.longitude);
+
+ this._routers.routerInfo.forEach((function(routerInfo) {
+ Utils.debug('checking router: ' + routerInfo.routerId);
+
+ /* TODO: only check bounding rectangle for now
+ should we try to do a finer-grained check using the bounding
+ polygon (if OTP gives one for the routers).
+ And should we add some margins to allow routing from just outside
+ a network (walking distance)? */
+ if (place.location.latitude >= routerInfo.lowerLeftLatitude &&
+ place.location.latitude <= routerInfo.upperRightLatitude &&
+ place.location.longitude >= routerInfo.lowerLeftLongitude &&
+ place.location.longitude <= routerInfo.upperRightLongitude)
+ routers.push(routerInfo.routerId);
+ }));
+
+ return routers;
+ },
+
+ /* Note: this is theoretically slow (O(n*m)), but we will have filtered
+ possible routers for the starting and ending query point, so they should
+ be short (in many cases just one element) */
+ _routerIntersection: function(routers1, routers2) {
+ return routers1.filter(function(n) {
+ return routers2.indexOf(n) != -1;
+ });
+ },
+
+ _formatPlaceQueryParam: function(place) {
+ return '%s,%s'.format(place.location.latitude, place.location.longitude);
+ },
+
+ _fetchRoutesRecursive: function(points, routers, index, result, callback) {
+ let params = {fromPlace: this._formatPlaceQueryParam(points[0].place),
+ toPlace: this._formatPlaceQueryParam(points[points.length - 1].place)
+ };
+
+ Utils.debug('fetching plans for router with index ' + index);
+ Utils.debug('number of points: ' + points.length);
+
+ let intermediatePlaces = [];
+ for (let i = 1; i < points.length - 1; i++) {
+ Utils.debug('intermediatePlace: ' + this._formatPlaceQueryParam(points[i].place));
+ intermediatePlaces.push(this._formatPlaceQueryParam(points[i].place));
+ }
+ if (intermediatePlaces.length > 0)
+ params.intermediatePlaces = intermediatePlaces;
+
+ Utils.debug('intermediatePlaces: ' + intermediatePlaces);
+
+ params.numItineraries = 10;
+
+ let query = new HTTP.Query(params);
+ let uri = new Soup.URI(_BASE_URL + '/routers/' + routers[index] +
+ '/plan?' + query.toString());
+ let request = new Soup.Message({ method: 'GET', uri: uri });
+
+ Utils.debug('URI: ' + uri.to_string(true));
+
+ request.request_headers.append('Accept', 'application/json');
+ this._session.queue_message(request, (function(obj, message) {
+ if (message.status_code !== Soup.Status.OK)
+ Utils.debug('Failed to get route plan from router ' +
+ routers[index]);
+ else
+ result.push(JSON.parse(message.response_body.data))
+
+ if (index < routers.length - 1)
+ this._fetchRoutesRecursive(points, routers, index + 1, result,
+ callback);
+ else {
+ Utils.debug('calling callback at index ' + index);
+ callback(result);
+ }
+ }).bind(this));
+ },
+
+ _fetchRoutes: function(points, routers, callback) {
+ Utils.debug('_fetchRoutes with length: ' + routers.length);
+ this._fetchRoutesRecursive(points, routers, 0, [], callback);
+ },
+
+ _reset: function() {
+ if (this._query.latest)
+ this._query.latest.place = null;
+ else
+ this.plan.reset();
+ },
+
+ fetchRoute: function(points) {
+ this._fetchRouters((function(success) {
+ if (success) {
+ let routers = this._getRoutersForPoints(points);
+
+ if (routers.length > 0) {
+ Utils.debug('about to fetch routes');
+ this._fetchRoutes(points, routers, (function(routes) {
+ let itineraries = [];
+ routes.forEach((function(plan) {
+ Utils.debug('plan: ' + JSON.stringify(plan, null, 2));
+ Utils.debug('itineraries: ' + itineraries);
+ if (plan.plan && plan.plan.itineraries) {
+ Utils.debug('creating itineraries');
+ itineraries =
+ itineraries.concat(
+ this._createItineraries(plan.plan.itineraries));
+ Utils.debug('itineraries.length: ' + itineraries.length);
+ }
+ }).bind(this));
+ Utils.debug('found ' + itineraries.length + ' itineraries');
+ if (itineraries.length === 0) {
+ Application.notificationManager.showMessage(_("No route found."));
+ } else {
+ itineraries.forEach((function(itinerary) {
+ Utils.debug(itinerary.toString());
+ }));
+ }
+ }).bind(this));
+
+ } else {
+ Application.notificationManager.showMessage(_("No route found."));
+ this._reset();
+ }
+ } else {
+ Application.notificationManager.showMessage(_("Route request failed."));
+ this._reset();
+ }
+ }).bind(this));
+ },
+
+ _getRoutersForPoints: function(points) {
+ Utils.debug('sucessfully fetched routers list, points.length ' + points.length);
+ let startRouters = this._getRoutersForPlace(points[0].place);
+ let endRouters =
+ this._getRoutersForPlace(points[points.length - 1].place);
+
+ Utils.debug('routers at start point: ' + startRouters);
+ Utils.debug('routers at end point: ' + endRouters);
+ let intersectingRouters =
+ this._routerIntersection(startRouters, endRouters);
+
+ Utils.debug('intersecting routers: ' + intersectingRouters);
+
+ return intersectingRouters;
+ },
+
+ _createItineraries: function(itineraries) {
+ return itineraries.map((function(itinerary) {
+ return this._createItinerary(itinerary);
+ }).bind(this));
+ },
+
+ _createItinerary: function(itinerary) {
+ return new TransitPlan.Itinerary({ duration: itinerary.duration,
+ transfers: itinerary.transfers,
+ departure: itinerary.startTime,
+ arrival: itinerary.endTime})
+ }
+})
diff --git a/src/org.gnome.Maps.src.gresource.xml b/src/org.gnome.Maps.src.gresource.xml
index ecd8ef4..6acd706 100644
--- a/src/org.gnome.Maps.src.gresource.xml
+++ b/src/org.gnome.Maps.src.gresource.xml
@@ -34,6 +34,7 @@
<file>mapView.js</file>
<file>mapWalker.js</file>
<file>notification.js</file>
+ <file>openTripPlanner.js</file>
<file>notificationManager.js</file>
<file>osmAccountDialog.js</file>
<file>osmConnection.js</file>
@@ -71,6 +72,7 @@
<file>socialPlaceMatcher.js</file>
<file>storedRoute.js</file>
<file>togeojson/togeojson.js</file>
+ <file>transitPlan.js</file>
<file>translations.js</file>
<file>turnPointMarker.js</file>
<file>userLocationBubble.js</file>
diff --git a/src/transitPlan.js b/src/transitPlan.js
new file mode 100644
index 0000000..66e1536
--- /dev/null
+++ b/src/transitPlan.js
@@ -0,0 +1,111 @@
+/* -*- Mode: JS2; indent-tabs-mode: nil; js2-basic-offset: 4 -*- */
+/* vim: set et ts=4 sw=4: */
+/*
+ * Copyright (c) 2016 Marcus Lundblad
+ *
+ * GNOME Maps is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * GNOME Maps is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with GNOME Maps; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Author: Marcus Lundblad <ml update uu se>
+ */
+
+const Lang = imports.lang;
+
+const GObject = imports.gi.GObject;
+
+const Plan = new Lang.Class({
+ Name: 'Plan',
+ Extends: GObject.Object,
+ Signals: {
+ 'update': {},
+ 'reset': {}
+ },
+
+ _init: function(params) {
+ this.parent(params);
+ this.reset();
+ },
+
+ get itineraries() {
+ return this._itineraries;
+ },
+
+ update: function(itineraries) {
+ this._itineraries = itineraries;
+ this.emit('update');
+ },
+
+ reset: function() {
+ this._itineraries = [];
+ this.emit('reset');
+ }
+});
+
+const Itinerary = new Lang.Class({
+ Name: 'Itinerary',
+
+ _init: function(params) {
+ this._duration = params.duration;
+ delete params.duration;
+
+ this._departure = params.departure;
+ delete params.departure;
+
+ this._arrival = params.arrival;
+ delete params.arrival;
+
+ this._transfers = params.transfers;
+ delete params.transfers;
+
+ this._legs = params.legs;
+ delete params.legs;
+ },
+
+ get duration() {
+ return this._duration;
+ },
+
+ get departure() {
+ return this._departure;
+ },
+
+ get arrival() {
+ return this._arrival;
+ },
+
+ get transfers() {
+ return this._transfers;
+ },
+
+ get legs() {
+ return this._legs;
+ },
+
+ toString: function() {
+ let start = new Date();
+ let end = new Date();
+ start.setTime(this.departure);
+ end.setTime(this.arrival);
+ return "Itinerary: \nDeparture: " + start + ", " +
+ "Arrival: " + end + "\n";
+ }
+});
+
+const Leg = new Lang.Class({
+ Name: 'Leg',
+
+ _init: function(params) {
+
+ }
+});
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]