app/assets/javascripts/router.js

   1 /*
   2   OSM.Router implements pushState-based navigation for the main page and
   3   other pages that use a sidebar+map based layout (export, search results,
   4   history, and browse pages).
   5
   6   For browsers without pushState, it falls back to full page loads, which all
   7   of the above pages support.
   8
   9   The router is initialized with a set of routes: a mapping of URL path templates
  10   to route controller objects. Path templates can contain placeholders
  11   (`/note/:id`) and optional segments (`/:type/:id(/history)`).
  12
  13   Route controller objects can define four methods that are called at defined
  14   times during routing:
  15
  16      * The `load` method is called by the router when a path which matches the
  17        route's path template is loaded via a normal full page load. It is passed
  18        as arguments the URL path plus any matching arguments for placeholders
  19        in the path template.
  20
  21      * The `pushstate` method is called when a page which matches the route's path
  22        template is loaded via pushState. It is passed the same arguments as `load`.
  23
  24      * The `popstate` method is called when returning to a previously
  25        pushState-loaded page via popstate (i.e. browser back/forward buttons).
  26
  27      * The `unload` method is called on the exiting route controller when navigating
  28        via pushState or popstate to another route.
  29
  30    Note that while `load` is not called by the router for pushState-based loads,
  31    it's frequently useful for route controllers to call it manually inside their
  32    definition of the `pushstate` and `popstate` methods.
  33
  34    An instance of OSM.Router is assigned to `OSM.router`. To navigate to a new page
  35    via pushState (with automatic full-page load fallback), call `OSM.router.route`:
  36
  37        OSM.router.route('/way/1234');
  38
  39    If `route` is passed a path that matches one of the path templates, it performs
  40    the appropriate actions and returns true. Otherwise it returns false.
  41
  42    OSM.Router also handles updating the hash portion of the URL containing transient
  43    map state such as the position and zoom level. Some route controllers may wish to
  44    temporarily suppress updating the hash (for example, to omit the hash on pages
  45    such as `/way/1234` unless the map is moved). This can be done by using
  46    `OSM.router.withoutMoveListener` to run a block of code that may update
  47    move the map without the hash changing.
  48  */
  49 OSM.Router = function (map, rts) {
  50   var escapeRegExp = /[-{}[\]+?.,\\^$|#\s]/g;
  51   var optionalParam = /\((.*?)\)/g;
  52   var namedParam = /(\(\?)?:\w+/g;
  53   var splatParam = /\*\w+/g;
  54
  55   function Route(path, controller) {
  56     var regexp = new RegExp("^" +
  57       path.replace(escapeRegExp, "\\$&")
  58         .replace(optionalParam, "(?:$1)?")
  59         .replace(namedParam, function (match, optional) {
  60           return optional ? match : "([^/]+)";
  61         })
  62         .replace(splatParam, "(.*?)") + "(?:\\?.*)?$");
  63
  64     var route = {};
  65
  66     route.match = function (path) {
  67       return regexp.test(path);
  68     };
  69
  70     route.run = function (action, path) {
  71       var params = [];
  72
  73       if (path) {
  74         params = regexp.exec(path).map(function (param, i) {
  75           return (i > 0 && param) ? decodeURIComponent(param) : param;
  76         });
  77       }
  78
  79       params = params.concat(Array.prototype.slice.call(arguments, 2));
  80
  81       return (controller[action] || $.noop).apply(controller, params);
  82     };
  83
  84     return route;
  85   }
  86
  87   var routes = [];
  88   for (var r in rts) {
  89     routes.push(new Route(r, rts[r]));
  90   }
  91
  92   routes.recognize = function (path) {
  93     for (var i = 0; i < this.length; i++) {
  94       if (this[i].match(path)) return this[i];
  95     }
  96   };
  97
  98   var currentPath = window.location.pathname.replace(/(.)\/$/, "$1") + window.location.search,
  99       currentRoute = routes.recognize(currentPath),
 100       currentHash = location.hash || OSM.formatHash(map);
 101
 102   var router = {};
 103
 104   if (window.history && window.history.pushState) {
 105     $(window).on("popstate", function (e) {
 106       if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?
 107       var path = window.location.pathname + window.location.search,
 108           route = routes.recognize(path);
 109       if (path === currentPath) return;
 110       currentRoute.run("unload", null, route === currentRoute);
 111       currentPath = path;
 112       currentRoute = route;
 113       currentRoute.run("popstate", currentPath);
 114       map.setState(e.originalEvent.state, { animate: false });
 115     });
 116
 117     router.route = function (url) {
 118       var path = url.replace(/#.*/, ""),
 119           route = routes.recognize(path);
 120       if (!route) return false;
 121       currentRoute.run("unload", null, route === currentRoute);
 122       var state = OSM.parseHash(url);
 123       map.setState(state);
 124       window.history.pushState(state, document.title, url);
 125       currentPath = path;
 126       currentRoute = route;
 127       currentRoute.run("pushstate", currentPath);
 128       return true;
 129     };
 130
 131     router.replace = function (url) {
 132       window.history.replaceState(OSM.parseHash(url), document.title, url);
 133     };
 134
 135     router.stateChange = function (state) {
 136       if (state.center) {
 137         window.history.replaceState(state, document.title, OSM.formatHash(state));
 138       } else {
 139         window.history.replaceState(state, document.title, window.location);
 140       }
 141     };
 142   } else {
 143     router.route = router.replace = function (url) {
 144       window.location.assign(url);
 145     };
 146
 147     router.stateChange = function (state) {
 148       if (state.center) window.location.replace(OSM.formatHash(state));
 149     };
 150   }
 151
 152   router.updateHash = function () {
 153     var hash = OSM.formatHash(map);
 154     if (hash === currentHash) return;
 155     currentHash = hash;
 156     router.stateChange(OSM.parseHash(hash));
 157   };
 158
 159   router.hashUpdated = function () {
 160     var hash = location.hash;
 161     if (hash === currentHash) return;
 162     currentHash = hash;
 163     var state = OSM.parseHash(hash);
 164     map.setState(state);
 165     router.stateChange(state, hash);
 166   };
 167
 168   router.withoutMoveListener = function (callback) {
 169     function disableMoveListener() {
 170       map.off("moveend", router.updateHash);
 171       map.once("moveend", function () {
 172         map.on("moveend", router.updateHash);
 173       });
 174     }
 175
 176     map.once("movestart", disableMoveListener);
 177     callback();
 178     map.off("movestart", disableMoveListener);
 179   };
 180
 181   router.load = function () {
 182     var loadState = currentRoute.run("load", currentPath);
 183     router.stateChange(loadState || {});
 184   };
 185
 186   router.setCurrentPath = function (path) {
 187     currentPath = path;
 188     currentRoute = routes.recognize(currentPath);
 189   };
 190
 191   map.on("moveend baselayerchange overlaylayerchange", router.updateHash);
 192   $(window).on("hashchange", router.hashUpdated);
 193
 194   return router;
 195 };