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       return (controller[action] || $.noop).apply(controller, params);
  80     };
  81
  82     return route;
  83   }
  84
  85   var routes = [];
  86   for (var r in rts)
  87     routes.push(Route(r, rts[r]));
  88
  89   routes.recognize = function(path) {
  90     for (var i = 0; i < this.length; i++) {
  91       if (this[i].match(path)) return this[i];
  92     }
  93   };
  94
  95   var currentPath = window.location.pathname.replace(/(.)\/$/, '$1') + window.location.search,
  96     currentRoute = routes.recognize(currentPath),
  97     currentHash = location.hash || OSM.formatHash(map);
  98
  99   var router = {};
 100
 101   if (window.history && window.history.pushState) {
 102     $(window).on('popstate', function(e) {
 103       if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?
 104       var path = window.location.pathname + window.location.search;
 105       if (path === currentPath) return;
 106       currentRoute.run('unload');
 107       currentPath = path;
 108       currentRoute = routes.recognize(currentPath);
 109       currentRoute.run('popstate', currentPath);
 110       map.setState(e.originalEvent.state, {animate: false});
 111     });
 112
 113     router.route = function (url) {
 114       var path = url.replace(/#.*/, ''),
 115         route = routes.recognize(path);
 116       if (!route) return false;
 117       currentRoute.run('unload');
 118       var state = OSM.parseHash(url);
 119       map.setState(state);
 120       window.history.pushState(state, document.title, url);
 121       currentPath = path;
 122       currentRoute = route;
 123       currentRoute.run('pushstate', currentPath);
 124       return true;
 125     };
 126
 127     router.replace = function (url) {
 128       window.history.replaceState(OSM.parseHash(url), document.title, url);
 129     };
 130
 131     router.stateChange = function(state) {
 132       if (state.center) {
 133         window.history.replaceState(state, document.title, OSM.formatHash(state));
 134       } else {
 135         window.history.replaceState(state, document.title, window.location);
 136       }
 137     };
 138   } else {
 139     router.route = router.replace = function (url) {
 140       window.location.assign(url);
 141     };
 142
 143     router.stateChange = function(state) {
 144       if (state.center) window.location.replace(OSM.formatHash(state));
 145     };
 146   }
 147
 148   router.updateHash = function() {
 149     var hash = OSM.formatHash(map);
 150     if (hash === currentHash) return;
 151     currentHash = hash;
 152     router.stateChange(OSM.parseHash(hash));
 153   };
 154
 155   router.hashUpdated = function() {
 156     var hash = location.hash;
 157     if (hash === currentHash) return;
 158     currentHash = hash;
 159     var state = OSM.parseHash(hash);
 160     map.setState(state);
 161     router.stateChange(state, hash);
 162   };
 163
 164   router.withoutMoveListener = function (callback) {
 165     function disableMoveListener() {
 166       map.off('moveend', router.updateHash);
 167       map.once('moveend', function () {
 168         map.on('moveend', router.updateHash);
 169       });
 170     }
 171
 172     map.once('movestart', disableMoveListener);
 173     callback();
 174     map.off('movestart', disableMoveListener);
 175   };
 176
 177   router.load = function() {
 178     var loadState = currentRoute.run('load', currentPath);
 179     router.stateChange(loadState || {});
 180   };
 181
 182   router.setCurrentPath = function (path) {
 183     currentPath = path;
 184     currentRoute = routes.recognize(currentPath);
 185   };
 186
 187   map.on('moveend baselayerchange overlaylayerchange', router.updateHash);
 188   $(window).on('hashchange', router.hashUpdated);
 189
 190   return router;
 191 };