Proyectos de Subversion Moodle

YUI.add('router', function (Y, NAME) {

/**

Provides URL-based routing using HTML5 `pushState()` or the location hash.

@module app

@submodule router

@since 3.4.0

**/

var HistoryHash = Y.HistoryHash,

    QS          = Y.QueryString,

    YArray      = Y.Array,

    YLang       = Y.Lang,

    YObject     = Y.Object,

    win = Y.config.win,

    // Holds all the active router instances. This supports the static

    // `dispatch()` method which causes all routers to dispatch.

    instances = [],

    // We have to queue up pushState calls to avoid race conditions, since the

    // popstate event doesn't actually provide any info on what URL it's

    // associated with.

    saveQueue = [],

    /**

    Fired when the router is ready to begin dispatching to route handlers.

    You shouldn't need to wait for this event unless you plan to implement some

    kind of custom dispatching logic. It's used internally in order to avoid

    dispatching to an initial route if a browser history change occurs first.

    @event ready

    @param {Boolean} dispatched `true` if routes have already been dispatched

      (most likely due to a history change).

    @fireOnce

    **/

    EVT_READY = 'ready';

/**

Provides URL-based routing using HTML5 `pushState()` or the location hash.

This makes it easy to wire up route handlers for different application states

while providing full back/forward navigation support and bookmarkable, shareable

URLs.

@class Router

@param {Object} [config] Config properties.

    @param {Boolean} [config.html5] Overrides the default capability detection

        and forces this router to use (`true`) or not use (`false`) HTML5

        history.

    @param {String} [config.root=''] Root path from which all routes should be

        evaluated.

    @param {Array} [config.routes=[]] Array of route definition objects.

@constructor

@extends Base

@since 3.4.0

**/

function Router() {

    Router.superclass.constructor.apply(this, arguments);

}

Y.Router = Y.extend(Router, Y.Base, {

    // -- Protected Properties -------------------------------------------------

    /**

    Whether or not `_dispatch()` has been called since this router was

    instantiated.

    @property _dispatched

    @type Boolean

    @default undefined

    @protected

    **/

    /**

    Whether or not we're currently in the process of dispatching to routes.

    @property _dispatching

    @type Boolean

    @default undefined

    @protected

    **/

    /**

    History event handle for the `history:change` or `hashchange` event

    subscription.

    @property _historyEvents

    @type EventHandle

    @protected

    **/

    /**

    Cached copy of the `html5` attribute for internal use.

    @property _html5

    @type Boolean

    @protected

    **/

    /**

    Map which holds the registered param handlers in the form:

    `name` -> RegExp | Function.

    @property _params

    @type Object

    @protected

    @since 3.12.0

    **/

    /**

    Whether or not the `ready` event has fired yet.

    @property _ready

    @type Boolean

    @default undefined

    @protected

    **/

    /**

    Regex used to break up a URL string around the URL's path.

    Subpattern captures:

      1. Origin, everything before the URL's path-part.

      2. The URL's path-part.

      3. The URL's query.

      4. The URL's hash fragment.

    @property _regexURL

    @type RegExp

    @protected

    @since 3.5.0

    **/

    _regexURL: /^((?:[^\/#?:]+:\/\/|\/\/)[^\/]*)?([^?#]*)(\?[^#]*)?(#.*)?$/,

    /**

    Regex used to match parameter placeholders in route paths.

    Subpattern captures:

      1. Parameter prefix character. Either a `:` for subpath parameters that

         should only match a single level of a path, or `*` for splat parameters

         that should match any number of path levels.

      2. Parameter name, if specified, otherwise it is a wildcard match.

    @property _regexPathParam

    @type RegExp

    @protected

    **/

    _regexPathParam: /([:*])([\w\-]+)?/g,

    /**

    Regex that matches and captures the query portion of a URL, minus the

    preceding `?` character, and discarding the hash portion of the URL if any.

    @property _regexUrlQuery

    @type RegExp

    @protected

    **/

    _regexUrlQuery: /\?([^#]*).*$/,

    /**

    Regex that matches everything before the path portion of a URL (the origin).

    This will be used to strip this part of the URL from a string when we

    only want the path.

    @property _regexUrlOrigin

    @type RegExp

    @protected

    **/

    _regexUrlOrigin: /^(?:[^\/#?:]+:\/\/|\/\/)[^\/]*/,

    /**

    Collection of registered routes.

    @property _routes

    @type Array

    @protected

    **/

    // -- Lifecycle Methods ----------------------------------------------------

    initializer: function (config) {

        var self = this;

        self._html5  = self.get('html5');

        self._params = {};

        self._routes = [];

        self._url    = self._getURL();

        // Necessary because setters don't run on init.

        self._setRoutes(config && config.routes ? config.routes :

                self.get('routes'));

        // Set up a history instance or hashchange listener.

        if (self._html5) {

            self._history       = new Y.HistoryHTML5({force: true});

            self._historyEvents =

                    Y.after('history:change', self._afterHistoryChange, self);

        } else {

            self._historyEvents =

                    Y.on('hashchange', self._afterHistoryChange, win, self);

        }

        // Fire a `ready` event once we're ready to route. We wait first for all

        // subclass initializers to finish, then for window.onload, and then an

        // additional 20ms to allow the browser to fire a useless initial

        // `popstate` event if it wants to (and Chrome always wants to).

        self.publish(EVT_READY, {

            defaultFn  : self._defReadyFn,

            fireOnce   : true,

            preventable: false

        });

        self.once('initializedChange', function () {

            Y.once('load', function () {

                setTimeout(function () {

                    self.fire(EVT_READY, {dispatched: !!self._dispatched});

                }, 20);

            });

        });

        // Store this router in the collection of all active router instances.

        instances.push(this);

    },

    destructor: function () {

        var instanceIndex = YArray.indexOf(instances, this);

        // Remove this router from the collection of active router instances.

        if (instanceIndex > -1) {

            instances.splice(instanceIndex, 1);

        }

        if (this._historyEvents) {

            this._historyEvents.detach();

        }

    },

    // -- Public Methods -------------------------------------------------------

    /**

    Dispatches to the first route handler that matches the current URL, if any.

    If `dispatch()` is called before the `ready` event has fired, it will

    automatically wait for the `ready` event before dispatching. Otherwise it

    will dispatch immediately.

    @method dispatch

    @chainable

    **/

    dispatch: function () {

        this.once(EVT_READY, function () {

            var req, res;

            this._ready = true;

            if (!this.upgrade()) {

                req = this._getRequest('dispatch');

                res = this._getResponse(req);

                this._dispatch(req, res);

            }

        });

        return this;

    },

    /**

    Gets the current route path.

    @method getPath

    @return {String} Current route path.

    **/

    getPath: function () {

        return this._getPath();

    },

    /**

    Returns `true` if this router has at least one route that matches the

    specified URL, `false` otherwise. This also checks that any named `param`

    handlers also accept app param values in the `url`.

    This method enforces the same-origin security constraint on the specified

    `url`; any URL which is not from the same origin as the current URL will

    always return `false`.

    @method hasRoute

    @param {String} url URL to match.

    @return {Boolean} `true` if there's at least one matching route, `false`

      otherwise.

    **/

    hasRoute: function (url) {

        var path, routePath, routes;

        if (!this._hasSameOrigin(url)) {

            return false;

        }

        if (!this._html5) {

            url = this._upgradeURL(url);

        }

        // Get just the path portion of the specified `url`. The `match()`

        // method does some special checking that the `path` is within the root.

        path   = this.removeQuery(url.replace(this._regexUrlOrigin, ''));

        routes = this.match(path);

        if (!routes.length) {

            return false;

        }

        routePath = this.removeRoot(path);

        // Check that there's at least one route whose param handlers also

        // accept all the param values.

        return !!YArray.filter(routes, function (route) {

            // Get the param values for the route and path to see whether the

            // param handlers accept or reject the param values. Include any

            // route whose named param handlers accept *all* param values. This

            // will return `false` if a param handler rejects a param value.

            return this._getParamValues(route, routePath);

        }, this).length;

    },

    /**

    Returns an array of route objects that match the specified URL path.

    If this router has a `root`, then the specified `path` _must_ be

    semantically within the `root` path to match any routes.

    This method is called internally to determine which routes match the current

    path whenever the URL changes. You may override it if you want to customize

    the route matching logic, although this usually shouldn't be necessary.

    Each returned route object has the following properties:

      * `callback`: A function or a string representing the name of a function

        this router that should be executed when the route is triggered.

      * `keys`: An array of strings representing the named parameters defined in

        the route's path specification, if any.

      * `path`: The route's path specification, which may be either a string or

        a regex.

      * `regex`: A regular expression version of the route's path specification.

        This regex is used to determine whether the route matches a given path.

    @example

        router.route('/foo', function () {});

        router.match('/foo');

        // => [{callback: ..., keys: [], path: '/foo', regex: ...}]

    @method match

    @param {String} path URL path to match. This should be an absolute path that

        starts with a slash: "/".

    @return {Object[]} Array of route objects that match the specified path.

    **/

    match: function (path) {

        var root = this.get('root');

        if (root) {

            // The `path` must be semantically within this router's `root` path

            // or mount point, if it's not then no routes should be considered a

            // match.

            if (!this._pathHasRoot(root, path)) {

                return [];

            }

            // Remove this router's `root` from the `path` before checking the

            // routes for any matches.

            path = this.removeRoot(path);

        }

        return YArray.filter(this._routes, function (route) {

            return path.search(route.regex) > -1;

        });

    },

    /**

    Adds a handler for a route param specified by _name_.

    Param handlers can be registered via this method and are used to

    validate/format values of named params in routes before dispatching to the

    route's handler functions. Using param handlers allows routes to defined

    using string paths which allows for `req.params` to use named params, but

    still applying extra validation or formatting to the param values parsed

    from the URL.

    If a param handler regex or function returns a value of `false`, `null`,

    `undefined`, or `NaN`, the current route will not match and be skipped. All

    other return values will be used in place of the original param value parsed

    from the URL.

    @example

        router.param('postId', function (value) {

            return parseInt(value, 10);

        });

        router.param('username', /^\w+$/);

        router.route('/posts/:postId', function (req) {

            Y.log('Post: ' + req.params.id);

        });

        router.route('/users/:username', function (req) {

            // `req.params.username` is an array because the result of calling

            // `exec()` on the regex is assigned as the param's value.

            Y.log('User: ' + req.params.username[0]);

        });

        router.route('*', function () {

            Y.log('Catch-all no routes matched!');

        });

        // URLs which match routes:

        router.save('/posts/1');     // => "Post: 1"

        router.save('/users/ericf'); // => "User: ericf"

        // URLs which do not match routes because params fail validation:

        router.save('/posts/a');            // => "Catch-all no routes matched!"

        router.save('/users/ericf,rgrove'); // => "Catch-all no routes matched!"

    @method param

    @param {String} name Name of the param used in route paths.

    @param {Function|RegExp} handler Function to invoke or regular expression to

        `exec()` during route dispatching whose return value is used as the new

        param value. Values of `false`, `null`, `undefined`, or `NaN` will cause

        the current route to not match and be skipped. When a function is

        specified, it will be invoked in the context of this instance with the

        following parameters:

      @param {String} handler.value The current param value parsed from the URL.

      @param {String} handler.name The name of the param.

    @chainable

    @since 3.12.0

    **/

    param: function (name, handler) {

        this._params[name] = handler;

        return this;

    },

    /**

    Removes the `root` URL from the front of _url_ (if it's there) and returns

    the result. The returned path will always have a leading `/`.

    @method removeRoot

    @param {String} url URL.

    @return {String} Rootless path.

    **/

    removeRoot: function (url) {

        var root = this.get('root'),

            path;

        // Strip out the non-path part of the URL, if any (e.g.

        // "http://foo.com"), so that we're left with just the path.

        url = url.replace(this._regexUrlOrigin, '');

        // Return the host-less URL if there's no `root` path to further remove.

        if (!root) {

            return url;

        }

        path = this.removeQuery(url);

        // Remove the `root` from the `url` if it's the same or its path is

        // semantically within the root path.

        if (path === root || this._pathHasRoot(root, path)) {

            url = url.substring(root.length);

        }

        return url.charAt(0) === '/' ? url : '/' + url;

    },

    /**

    Removes a query string from the end of the _url_ (if one exists) and returns

    the result.

    @method removeQuery

    @param {String} url URL.

    @return {String} Queryless path.

    **/

    removeQuery: function (url) {

        return url.replace(/\?.*$/, '');

    },

    /**

    Replaces the current browser history entry with a new one, and dispatches to

    the first matching route handler, if any.

    Behind the scenes, this method uses HTML5 `pushState()` in browsers that

    support it (or the location hash in older browsers and IE) to change the

    URL.

    The specified URL must share the same origin (i.e., protocol, host, and

    port) as the current page, or an error will occur.

    @example

        // Starting URL: http://example.com/

        router.replace('/path/');

        // New URL: http://example.com/path/

        router.replace('/path?foo=bar');

        // New URL: http://example.com/path?foo=bar

        router.replace('/');

        // New URL: http://example.com/

    @method replace

    @param {String} [url] URL to set. This URL needs to be of the same origin as

      the current URL. This can be a URL relative to the router's `root`

      attribute. If no URL is specified, the page's current URL will be used.

    @chainable

    @see save()

    **/

    replace: function (url) {

        return this._queue(url, true);

    },

    /**

    Adds a route handler for the specified `route`.

    The `route` parameter may be a string or regular expression to represent a

    URL path, or a route object. If it's a string (which is most common), it may

    contain named parameters: `:param` will match any single part of a URL path

    (not including `/` characters), and `*param` will match any number of parts

    of a URL path (including `/` characters). These named parameters will be

    made available as keys on the `req.params` object that's passed to route

    handlers.

    If the `route` parameter is a regex, all pattern matches will be made

    available as numbered keys on `req.params`, starting with `0` for the full

    match, then `1` for the first subpattern match, and so on.

    Alternatively, an object can be provided to represent the route and it may

    contain a `path` property which is a string or regular expression which

    causes the route to be process as described above. If the route object

    already contains a `regex` or `regexp` property, the route will be

    considered fully-processed and will be associated with any `callacks`

    specified on the object and those specified as parameters to this method.

    **Note:** Any additional data contained on the route object will be

    preserved.

    Here's a set of sample routes along with URL paths that they match:

      * Route: `/photos/:tag/:page`

        * URL: `/photos/kittens/1`, params: `{tag: 'kittens', page: '1'}`

        * URL: `/photos/puppies/2`, params: `{tag: 'puppies', page: '2'}`

      * Route: `/file/*path`

        * URL: `/file/foo/bar/baz.txt`, params: `{path: 'foo/bar/baz.txt'}`

        * URL: `/file/foo`, params: `{path: 'foo'}`

    **Middleware**: Routes also support an arbitrary number of callback

    functions. This allows you to easily reuse parts of your route-handling code

    with different route. This method is liberal in how it processes the

    specified `callbacks`, you can specify them as separate arguments, or as

    arrays, or both.

    If multiple route match a given URL, they will be executed in the order they

    were added. The first route that was added will be the first to be executed.

    **Passing Control**: Invoking the `next()` function within a route callback

    will pass control to the next callback function (if any) or route handler

    (if any). If a value is passed to `next()`, it's assumed to be an error,

    therefore stopping the dispatch chain, unless that value is: `"route"`,

    which is special case and dispatching will skip to the next route handler.

    This allows middleware to skip any remaining middleware for a particular

    route.

    @example

        router.route('/photos/:tag/:page', function (req, res, next) {

            Y.log('Current tag: ' + req.params.tag);

            Y.log('Current page number: ' + req.params.page);

        });

        // Using middleware.

        router.findUser = function (req, res, next) {

            req.user = this.get('users').findById(req.params.user);

            next();

        };

        router.route('/users/:user', 'findUser', function (req, res, next) {

            // The `findUser` middleware puts the `user` object on the `req`.

            Y.log('Current user:' req.user.get('name'));

        });

    @method route

    @param {String|RegExp|Object} route Route to match. May be a string or a

      regular expression, or a route object.

    @param {Array|Function|String} callbacks* Callback functions to call

        whenever this route is triggered. These can be specified as separate

        arguments, or in arrays, or both. If a callback is specified as a

        string, the named function will be called on this router instance.

      @param {Object} callbacks.req Request object containing information about

          the request. It contains the following properties.

        @param {Array|Object} callbacks.req.params Captured parameters matched

          by the route path specification. If a string path was used and

          contained named parameters, then this will be a key/value hash mapping

          parameter names to their matched values. If a regex path was used,

          this will be an array of subpattern matches starting at index 0 for

          the full match, then 1 for the first subpattern match, and so on.

        @param {String} callbacks.req.path The current URL path.

        @param {Number} callbacks.req.pendingCallbacks Number of remaining

          callbacks the route handler has after this one in the dispatch chain.

        @param {Number} callbacks.req.pendingRoutes Number of matching routes

          after this one in the dispatch chain.

        @param {Object} callbacks.req.query Query hash representing the URL

          query string, if any. Parameter names are keys, and are mapped to

          parameter values.

        @param {Object} callbacks.req.route Reference to the current route

          object whose callbacks are being dispatched.

        @param {Object} callbacks.req.router Reference to this router instance.

        @param {String} callbacks.req.src What initiated the dispatch. In an

          HTML5 browser, when the back/forward buttons are used, this property

          will have a value of "popstate". When the `dispath()` method is

          called, the `src` will be `"dispatch"`.

        @param {String} callbacks.req.url The full URL.

      @param {Object} callbacks.res Response object containing methods and

          information that relate to responding to a request. It contains the

          following properties.

        @param {Object} callbacks.res.req Reference to the request object.

      @param {Function} callbacks.next Function to pass control to the next

          callback or the next matching route if no more callbacks (middleware)

          exist for the current route handler. If you don't call this function,

          then no further callbacks or route handlers will be executed, even if

          there are more that match. If you do call this function, then the next

          callback (if any) or matching route handler (if any) will be called.

          All of these functions will receive the same `req` and `res` objects

          that were passed to this route (so you can use these objects to pass

          data along to subsequent callbacks and routes).

        @param {String} [callbacks.next.err] Optional error which will stop the

          dispatch chaining for this `req`, unless the value is `"route"`, which

          is special cased to jump skip past any callbacks for the current route

          and pass control the next route handler.

    @chainable

    **/

    route: function (route, callbacks) {

        // Grab callback functions from var-args.

        callbacks = YArray(arguments, 1, true);

        var keys, regex;

        // Supports both the `route(path, callbacks)` and `route(config)` call

        // signatures, allowing for fully-processed route configs to be passed.

        if (typeof route === 'string' || YLang.isRegExp(route)) {

            // Flatten `callbacks` into a single dimension array.

            callbacks = YArray.flatten(callbacks);

            keys  = [];

            regex = this._getRegex(route, keys);

            route = {

                callbacks: callbacks,

                keys     : keys,

                path     : route,

                regex    : regex

            };

        } else {

            // Look for any configured `route.callbacks` and fallback to

            // `route.callback` for back-compat, append var-arg `callbacks`,

            // then flatten the entire collection to a single dimension array.

            callbacks = YArray.flatten(

                [route.callbacks || route.callback || []].concat(callbacks)

            );

            // Check for previously generated regex, also fallback to `regexp`

            // for greater interop.

            keys  = route.keys;

            regex = route.regex || route.regexp;

            // Generates the route's regex if it doesn't already have one.

            if (!regex) {

                keys  = [];

                regex = this._getRegex(route.path, keys);

            }

            // Merge specified `route` config object with processed data.

            route = Y.merge(route, {

                callbacks: callbacks,

                keys     : keys,

                path     : route.path || regex,

                regex    : regex

            });

        }

        this._routes.push(route);

        return this;

    },

    /**

    Saves a new browser history entry and dispatches to the first matching route

    handler, if any.

    Behind the scenes, this method uses HTML5 `pushState()` in browsers that

    support it (or the location hash in older browsers and IE) to change the

    URL and create a history entry.

    The specified URL must share the same origin (i.e., protocol, host, and

    port) as the current page, or an error will occur.

    @example

        // Starting URL: http://example.com/

        router.save('/path/');

        // New URL: http://example.com/path/

        router.save('/path?foo=bar');

        // New URL: http://example.com/path?foo=bar

        router.save('/');

        // New URL: http://example.com/

    @method save

    @param {String} [url] URL to set. This URL needs to be of the same origin as

      the current URL. This can be a URL relative to the router's `root`

      attribute. If no URL is specified, the page's current URL will be used.

    @chainable

    @see replace()

    **/

    save: function (url) {

        return this._queue(url);

    },

    /**

    Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5

    browsers, this method is a noop.

    @method upgrade

    @return {Boolean} `true` if the URL was upgraded, `false` otherwise.

    **/

    upgrade: function () {

        if (!this._html5) {

            return false;

        }

        // Get the resolve hash path.

        var hashPath = this._getHashPath();

        if (hashPath) {

            // This is an HTML5 browser and we have a hash-based path in the

            // URL, so we need to upgrade the URL to a non-hash URL. This

            // will trigger a `history:change` event, which will in turn

            // trigger a dispatch.

            this.once(EVT_READY, function () {

                this.replace(hashPath);

            });

            return true;

        }

        return false;

    },

    // -- Protected Methods ----------------------------------------------------

    /**

    Wrapper around `decodeURIComponent` that also converts `+` chars into

    spaces.

    @method _decode

    @param {String} string String to decode.

    @return {String} Decoded string.

    @protected

    **/

    _decode: function (string) {

        return decodeURIComponent(string.replace(/\+/g, ' '));

    },

    /**

    Shifts the topmost `_save()` call off the queue and executes it. Does

    nothing if the queue is empty.

    @method _dequeue

    @chainable

    @see _queue

    @protected

    **/

    _dequeue: function () {

        var self = this,

            fn;

        // If window.onload hasn't yet fired, wait until it has before

        // dequeueing. This will ensure that we don't call pushState() before an

        // initial popstate event has fired.

        if (!YUI.Env.windowLoaded) {

            Y.once('load', function () {

                self._dequeue();

            });

            return this;

        }

        fn = saveQueue.shift();

        return fn ? fn() : this;

    },

    /**

    Dispatches to the first route handler that matches the specified _path_.

    If called before the `ready` event has fired, the dispatch will be aborted.

    This ensures normalized behavior between Chrome (which fires a `popstate`

    event on every pageview) and other browsers (which do not).

    @method _dispatch

    @param {object} req Request object.

    @param {String} res Response object.

    @chainable

    @protected

    **/

    _dispatch: function (req, res) {

        var self      = this,

            routes    = self.match(req.path),

            callbacks = [],

            routePath, paramValues;

        self._dispatching = self._dispatched = true;

        if (!routes || !routes.length) {

            self._dispatching = false;

            return self;

        }

        routePath = self.removeRoot(req.path);

        function next(err) {

            var callback, name, route;

            if (err) {

                // Special case "route" to skip to the next route handler

                // avoiding any additional callbacks for the current route.

                if (err === 'route') {

                    callbacks = [];

                    next();

                } else {

                    Y.error(err);

                }

            } else if ((callback = callbacks.shift())) {

                if (typeof callback === 'string') {

                    name     = callback;

                    callback = self[name];

                    if (!callback) {

                        Y.error('Router: Callback not found: ' + name, null, 'router');

                    }

                }

                // Allow access to the number of remaining callbacks for the

                // route.

                req.pendingCallbacks = callbacks.length;

                callback.call(self, req, res, next);

            } else if ((route = routes.shift())) {

                paramValues = self._getParamValues(route, routePath);

                if (!paramValues) {

                    // Skip this route because one of the param handlers

                    // rejected a param value in the `routePath`.

                    next('route');

                    return;

                }

                // Expose the processed param values.

                req.params = paramValues;

                // Allow access to current route and the number of remaining

                // routes for this request.

                req.route         = route;

                req.pendingRoutes = routes.length;

                // Make a copy of this route's `callbacks` so the original array

                // is preserved.

                callbacks = route.callbacks.concat();

                // Execute this route's `callbacks`.

                next();

            }

        }

        next();

        self._dispatching = false;

        return self._dequeue();

    },

    /**

    Returns the resolved path from the hash fragment, or an empty string if the

    hash is not path-like.

    @method _getHashPath

    @param {String} [hash] Hash fragment to resolve into a path. By default this

        will be the hash from the current URL.

    @return {String} Current hash path, or an empty string if the hash is empty.

    @protected

    **/

    _getHashPath: function (hash) {

        hash || (hash = HistoryHash.getHash());

        // Make sure the `hash` is path-like.

        if (hash && hash.charAt(0) === '/') {

            return this._joinURL(hash);

        }

        return '';

    },

    /**

    Gets the location origin (i.e., protocol, host, and port) as a URL.

    @example

        http://example.com

    @method _getOrigin

    @return {String} Location origin (i.e., protocol, host, and port).

    @protected

    **/

    _getOrigin: function () {

        var location = Y.getLocation();

        return location.origin || (location.protocol + '//' + location.host);

    },

    /**

    Getter for the `params` attribute.

    @method _getParams

    @return {Object} Mapping of param handlers: `name` -> RegExp | Function.

    @protected

    @since 3.12.0

    **/

    _getParams: function () {

        return Y.merge(this._params);

    },

    /**

    Gets the param values for the specified `route` and `path`, suitable to use

    form `req.params`.

    **Note:** This method will return `false` if a named param handler rejects a

    param value.

    @method _getParamValues

    @param {Object} route The route to get param values for.

    @param {String} path The route path (root removed) that provides the param

        values.

    @return {Boolean|Array|Object} The collection of processed param values.

        Either a hash of `name` -> `value` for named params processed by this

        router's param handlers, or an array of matches for a route with unnamed

        params. If a named param handler rejects a value, then `false` will be

        returned.

    @protected

    @since 3.16.0

    **/

    _getParamValues: function (route, path) {

        var matches, paramsMatch, paramValues;

        // Decode each of the path params so that the any URL-encoded path

        // segments are decoded in the `req.params` object.

        matches = YArray.map(route.regex.exec(path) || [], function (match) {

            // Decode matches, or coerce `undefined` matches to an empty

            // string to match expectations of working with `req.params`

            // in the context of route dispatching, and normalize

            // browser differences in their handling of regex NPCGs:

            // https://github.com/yui/yui3/issues/1076

            return (match && this._decode(match)) || '';

        }, this);

        // Simply return the array of decoded values when the route does *not*

        // use named parameters.

        if (matches.length - 1 !== route.keys.length) {

            return matches;

        }

        // Remove the first "match" from the param values, because it's just the

        // `path` processed by the route's regex, and map the values to the keys

        // to create the name params collection.

        paramValues = YArray.hash(route.keys, matches.slice(1));

        // Pass each named param value to its handler, if there is one, for

        // validation/processing. If a param value is rejected by a handler,

        // then the params don't match and a falsy value is returned.

        paramsMatch = YArray.every(route.keys, function (name) {

            var paramHandler = this._params[name],

                value        = paramValues[name];

            if (paramHandler && value && typeof value === 'string') {

                // Check if `paramHandler` is a RegExp, because this

                // is true in Android 2.3 and other browsers!

                // `typeof /.*/ === 'function'`

                value = YLang.isRegExp(paramHandler) ?

                        paramHandler.exec(value) :

                        paramHandler.call(this, value, name);

                if (value !== false && YLang.isValue(value)) {

                    // Update the named param to the value from the handler.

                    paramValues[name] = value;

                    return true;

                }

                // Consider the param value as rejected by the handler.

                return false;