403651161aef92c63ce8954d2c1115c78d774bb7
[django-pagination.git] / fnp_django_pagination / middleware.py
1 # Copyright (c) 2008, Eric Florenzano
2 # Copyright (c) 2010, 2011 Linaro Limited
3 # All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
7 # met:
8 #
9 #     * Redistributions of source code must retain the above copyright
10 #       notice, this list of conditions and the following disclaimer.
11 #     * Redistributions in binary form must reproduce the above
12 #       copyright notice, this list of conditions and the following
13 #       disclaimer in the documentation and/or other materials provided
14 #       with the distribution.
15 #     * Neither the name of the author nor the names of other
16 #       contributors may be used to endorse or promote products derived
17 #       from this software without specific prior written permission.
18 #
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31 try:
32     from django.utils.deprecation import MiddlewareMixin
33 except ImportError:
34     # Django < 1.10
35     MiddlewareMixin = object
36
37
38 def get_page(self, suffix=''):
39     """
40     A function which will be monkeypatched onto the request to get the current
41     integer representing the current page.
42     """
43     try:
44         # REQUEST is deprecated as of Django 1.7.
45         key = 'page%s' % suffix
46         value = self.POST.get(key)
47         if value is None:
48             value = self.GET.get(key)
49         return int(value)
50     except (KeyError, ValueError, TypeError):
51         return 1
52
53
54 class PaginationMiddleware(MiddlewareMixin):
55     """
56     Inserts a variable representing the current page onto the request object if
57     it exists in either **GET** or **POST** portions of the request.
58     """
59     def process_request(self, request):
60         request.__class__.page = get_page