Source code for cubicweb.pyramid.url_redirection

# copyright 2017 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# copyright 2014-2016 UNLISH S.A.S. (Montpellier, FRANCE), all rights reserved.
# contact --
# This file is part of CubicWeb.
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
# CubicWeb 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 Lesser General Public License for more
# details.
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb.  If not, see <>.

Url redirection using pyramid

This module allow to define redirection rules used by pyramid before route selection.

Each rule has to be added with `add_rewriting_rule` method in a pyramid `includeme`
function to be used.

Example of usage :

.. code-block:: ini

    def includeme(config):
        config.add_rewriting_rule(r'<a regex>', callback_method)

The callback_method takes three arguments:

- a pyramid request ;
- the url that has to be matched by the rule ;
- a dictionnary containing all the named subgroups of the regex match.

It must return a string corresponding to the new url.
import re

from pyramid.httpexceptions import HTTPSeeOther

[docs]def add_redirection_rule(config, rule, callback_method): """ Declare a pyramid directive allowing to add a redirection rule. Each rewriting rule can then be added in the `includeme` at the end of the file by using `config.add_redirection_rule(rule, callback_method`. :param config: pyramid configuration, used by pyramid. :param rule: a regex used to match uri. :param callback_method: a method which return the redirected uri. """ if not hasattr(config.registry, "redirection_rules"): config.registry.redirection_rules = [] config.registry.redirection_rules.append((re.compile(rule), callback_method))
[docs]def url_redirection_tween_factory(handler, registry): """A pyramid tween handler that browse each `redirection_rules` added with `add_redirection_rule` directive to find if the current path matches a rule. """ if not hasattr(registry, "redirection_rules"): return handler def url_redirection_tween(request): for rule, callback_method in request.registry.redirection_rules: path = request.path_info match = rule.match(path) if match: redirection_path = callback_method(request, path, match.groupdict()) if redirection_path: raise HTTPSeeOther(redirection_path) return handler(request) return url_redirection_tween
[docs]def includeme(config): """Add `add_redirection_rule` pyramid directive and `url_redirection_tween` pyramid tween handler to the pyramid configuration.""" config.add_directive("add_redirection_rule", add_redirection_rule) config.add_tween("cubicweb.pyramid.url_redirection.url_redirection_tween_factory")