app/soc/views/helper/lists.py
author Sverre Rabbelier <srabbelier@gmail.com>
Mon, 06 Apr 2009 23:46:46 +0000
changeset 2108 286aa6528e84
parent 2077 fd2e83a297c7
child 2166 c9c7c6111988
permissions -rw-r--r--
Properly handle exports when there are multiple lists If there are multiple lists whose index does not match their position in the contents, things weren't handled properly. Patch by: Sverre Rabbelier
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     2
#
1308
35b75ffcbb37 Partially reverted "Update the copyright notice for 2009."
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1307
diff changeset
     3
# Copyright 2008 the Melange authors.
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     4
#
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     8
#
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    10
#
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    15
# limitations under the License.
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    16
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    17
"""Helpers used to render lists.
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    18
"""
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    19
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    20
__authors__ = [
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    21
  '"Chen Lunpeng" <forever.clp@gmail.com>',
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    22
  '"Pawel Solyga" <pawel.solyga@gmail.com>',
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    23
  ]
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    24
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    25
555
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
    26
from soc.logic import dicts
1802
407000879987 Allow developers to specify a higher limit for a list view
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1692
diff changeset
    27
from soc.logic.models.user import logic as user_logic
316
9efdc7bc3565 Add missing blank lines between imports and sort all of the imports.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 277
diff changeset
    28
274
56e1c1721299 Move helpers/forms_helpers.py to helper/forms.py.
Todd Larsen <tlarsen@google.com>
parents: 268
diff changeset
    29
import soc.views.helper.forms
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    30
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    31
1810
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    32
DEF_DEFAULT_PAGINATION = 50
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    33
DEF_MAX_PAGINATION = 100
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    34
DEF_MAX_DEV_PAGINATION = 1000
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    35
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    36
DEF_PAGINATION_CHOICES = [
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    37
    ('10', '10 items per page'),
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    38
    ('25', '25 items per page'),
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    39
    ('50', '50 items per page'),
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    40
    ('100', '100 items per page'),
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    41
]
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    42
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    43
DEF_DEVELOPER_CHOICES = [
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    44
    ('500', '500 items per page'),
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    45
    ('1000', '1000 items per page'),
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
    46
    ]
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    47
228
2204287da374 Add placeholder for future (to-be-implemented) getPreferredListPagination()
Todd Larsen <tlarsen@google.com>
parents: 185
diff changeset
    48
2204287da374 Add placeholder for future (to-be-implemented) getPreferredListPagination()
Todd Larsen <tlarsen@google.com>
parents: 185
diff changeset
    49
def getPreferredListPagination(user=None):
389
9b873166d7d5 Fix identions, too long lines, unused imports and some other mistakes.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 316
diff changeset
    50
  """Returns User's preferred list pagination limit.
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
    51
389
9b873166d7d5 Fix identions, too long lines, unused imports and some other mistakes.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 316
diff changeset
    52
  Args:
9b873166d7d5 Fix identions, too long lines, unused imports and some other mistakes.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 316
diff changeset
    53
    user: User entity containing the list pagination preference;
9b873166d7d5 Fix identions, too long lines, unused imports and some other mistakes.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 316
diff changeset
    54
      default is None, to use the current logged-in User
9b873166d7d5 Fix identions, too long lines, unused imports and some other mistakes.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 316
diff changeset
    55
  """
9b873166d7d5 Fix identions, too long lines, unused imports and some other mistakes.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 316
diff changeset
    56
  # TODO: eventually this limit should be a User profile preference
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
    57
  #   (stored in the site-wide User Model) preference
1810
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    58
  return DEF_DEFAULT_PAGINATION
228
2204287da374 Add placeholder for future (to-be-implemented) getPreferredListPagination()
Todd Larsen <tlarsen@google.com>
parents: 185
diff changeset
    59
2204287da374 Add placeholder for future (to-be-implemented) getPreferredListPagination()
Todd Larsen <tlarsen@google.com>
parents: 185
diff changeset
    60
1166
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
    61
def getLimitAndOffset(request, offset_key, limit_key):
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    62
  """Retrieves, converts and validates offset and limit values
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    63
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    64
  Args:
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    65
    offset: offset in list which defines first item to return
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    66
    limit: max amount of items per page
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    67
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    68
  Returns:
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    69
    updated offset and limit values
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    70
  """
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    71
1166
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
    72
  offset = request.GET.get(offset_key)
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
    73
  limit = request.GET.get(limit_key)
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    74
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    75
  if offset is None:
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    76
    offset = ''
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    77
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    78
  if limit is None:
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    79
    limit = ''
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    80
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    81
  try:
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    82
    offset = int(offset)
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    83
  except ValueError:
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
    84
    offset = 0
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    85
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    86
  try:
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    87
    limit = int(limit)
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    88
  except ValueError:
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    89
    limit = getPreferredListPagination()
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
    90
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    91
  offset = max(0, offset)
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    92
  limit = max(1, limit)
1802
407000879987 Allow developers to specify a higher limit for a list view
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1692
diff changeset
    93
1810
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    94
  if user_logic.isDeveloper():
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    95
    limit = min(DEF_MAX_DEV_PAGINATION, limit)
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    96
  else:
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
    97
    limit = min(DEF_MAX_PAGINATION, limit)
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    98
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
    99
  return limit, offset
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   100
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   101
1166
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   102
def generateLinkFromGetArgs(request, offset_and_limits):
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   103
  """Constructs the get args for the url.
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   104
  """
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   105
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   106
  args = ["%s=%s" % (k, v) for k, v in offset_and_limits.iteritems()]
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   107
  link_suffix = '?' + '&'.join(args)
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   108
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   109
  return request.path + link_suffix
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   110
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   111
1667
95bc81b4cd5c Updated list to use the new order in getForFields.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1604
diff changeset
   112
def getListContent(request, params, filter=None, order=None,
95bc81b4cd5c Updated list to use the new order in getForFields.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1604
diff changeset
   113
                   idx=0, need_content=False):
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   114
  """Returns a dict with fields used for rendering lists.
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   115
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   116
  TODO(dbentley): we need better terminology. List in this context can have
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   117
    one of two meanings.
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   118
    Meaning 1:  the underlying list, which may be very large.
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   119
    Meaning 2:  the returned list, which is at most 'limit' items.
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   120
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   121
  Args:
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   122
    request: the Django HTTP request object
555
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   123
    params: a dict with params for the View this list belongs to
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   124
    filter: a filter for this list
1667
95bc81b4cd5c Updated list to use the new order in getForFields.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1604
diff changeset
   125
    order: the order which should be used for the list (in getForFields format)
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
   126
    idx: the index of this list
1604
297444daac68 Two docstring fixes.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1459
diff changeset
   127
    need_content: iff True will return None if there is no data
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   128
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   129
  Returns:
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   130
    A dictionary with the following values set:
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   131
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   132
    {
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   133
      'data': list data to be displayed
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   134
      'main': url to list main template
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   135
      'pagination': url to list pagination template
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   136
      'row': url to list row template
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   137
      'heading': url to list heading template
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   138
      'limit': max amount of items per page,
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   139
      'newest': url to first page of the list
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   140
      'prev': url to previous page
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   141
      'next': url to next page
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   142
      'first': offset of the first item in the list
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   143
      'last': offest of the last item in the list
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   144
    }
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   145
  """
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   146
651
ef6e22d463cb Remove the logic parameter from getListContent
Sverre Rabbelier <srabbelier@gmail.com>
parents: 632
diff changeset
   147
  logic = params['logic']
ef6e22d463cb Remove the logic parameter from getListContent
Sverre Rabbelier <srabbelier@gmail.com>
parents: 632
diff changeset
   148
1166
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   149
  offset_key = 'offset_%d' % idx
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   150
  limit_key = 'limit_%d' % idx
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   151
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   152
  limit, offset = getLimitAndOffset(request, offset_key, limit_key)
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   153
  pagination_form = makePaginationForm(request, limit, limit_key)
555
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   154
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   155
  # Fetch one more to see if there should be a 'next' link
1667
95bc81b4cd5c Updated list to use the new order in getForFields.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1604
diff changeset
   156
  data = logic.getForFields(filter=filter, limit=limit+1, offset=offset,
95bc81b4cd5c Updated list to use the new order in getForFields.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1604
diff changeset
   157
                            order=order)
723
69e5130e4a0a Make getForFields use the db.Query API
Sverre Rabbelier <srabbelier@gmail.com>
parents: 651
diff changeset
   158
1459
2584724403ff Make it possible not to generate empty lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   159
  if need_content and not data:
2584724403ff Make it possible not to generate empty lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   160
    return None
2584724403ff Make it possible not to generate empty lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   161
723
69e5130e4a0a Make getForFields use the db.Query API
Sverre Rabbelier <srabbelier@gmail.com>
parents: 651
diff changeset
   162
  more = len(data) > limit
1165
4db62684ce13 Unify 'getForFields' and 'getForLimitAndOffset'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 723
diff changeset
   163
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   164
  if more:
553
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   165
    del data[limit:]
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   166
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2049
diff changeset
   167
  newest = next = prev = export_link = ''
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   168
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   169
  base_params = dict(i for i in request.GET.iteritems() if
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   170
                     i[0].startswith('offset_') or i[0].startswith('limit_'))
1166
558bd62ee9d4 Fix get args construction when there are multiple lists on the page
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1165
diff changeset
   171
1821
6a548cbb0f7e Only show export link if list_key_order is set
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1811
diff changeset
   172
  if params.get('list_key_order'):
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   173
    export_link_params = dict(base_params)
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   174
    export_link_params['export'] = idx
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   175
    export_link = generateLinkFromGetArgs(request, export_link_params)
1807
1f8cde169f32 Add an export link to all list views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1802
diff changeset
   176
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   177
  if more:
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   178
    # TODO(dbentley): here we need to implement a new field "last_key"
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   179
    next_params = dict(base_params)
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   180
    next_params[offset_key] = offset+limit
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   181
    next_params[limit_key] = limit
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   182
    next = generateLinkFromGetArgs(request, next_params)
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   183
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   184
  if offset > 0:
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   185
    # TODO(dbentley): here we need to implement previous in the good way.
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   186
    prev_params = dict(base_params)
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   187
    prev_params[offset_key] = max(0, offset-limit)
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   188
    prev_params[limit_key] = limit
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   189
    prev = generateLinkFromGetArgs(request, prev_params)
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   190
185
2f3bd84bb106 Add list_helpers functions that are going to be used when rendering list views like (Users List, Sponsors List etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
diff changeset
   191
  if offset > limit:
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   192
    newest_params = dict(base_params)
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   193
    del newest_params[offset_key]
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   194
    newest_params[limit_key] = limit
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   195
    newest = generateLinkFromGetArgs(request, newest_params)
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   196
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   197
  content = {
2108
286aa6528e84 Properly handle exports when there are multiple lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 2077
diff changeset
   198
      'idx': idx,
553
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   199
      'data': data,
1807
1f8cde169f32 Add an export link to all list views
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1802
diff changeset
   200
      'export': export_link,
553
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   201
      'first': offset+1,
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   202
      'last': len(data) > 1 and offset+len(data) or None,
555
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   203
      'logic': logic,
553
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   204
      'limit': limit,
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   205
      'newest': newest,
553
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   206
      'next': next,
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
   207
      'pagination_form': pagination_form,
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   208
      'prev': prev,
553
c0cc20b4afc9 Make redirect generic using the new Lists object
Sverre Rabbelier <srabbelier@gmail.com>
parents: 539
diff changeset
   209
      }
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   210
555
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   211
  updates = dicts.rename(params, params['list_params'])
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   212
  content.update(updates)
3cdfb42d941b Split the list view code up in three pieces
Sverre Rabbelier <srabbelier@gmail.com>
parents: 553
diff changeset
   213
539
e30462354e26 Allow for multiple list objects
Sverre Rabbelier <srabbelier@gmail.com>
parents: 499
diff changeset
   214
  return content
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   215
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   216
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   217
def makePaginationForm(
572
1b3e7280743a Made list pagination part of Lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 555
diff changeset
   218
  request, limit, arg_name, choices=DEF_PAGINATION_CHOICES,
632
1f20cfb91e11 Remove unused imports from some modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 572
diff changeset
   219
  field_name_fmt=soc.views.helper.forms.DEF_SELECT_QUERY_ARG_FIELD_NAME_FMT):
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   220
  """Returns a customized pagination limit selection form.
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   221
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   222
  Args:
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   223
    request: the standard Django HTTP request object
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   224
    limit: the initial value of the selection control
632
1f20cfb91e11 Remove unused imports from some modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 572
diff changeset
   225
    arg_name: see soc.views.helper.forms.makeSelectQueryArgForm(); default is 'limit'
1f20cfb91e11 Remove unused imports from some modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 572
diff changeset
   226
    choices: see soc.views.helper.forms.makeSelectQueryArgForm(); default is
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   227
      DEF_PAGINATION_CHOICES
632
1f20cfb91e11 Remove unused imports from some modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 572
diff changeset
   228
    field_name_fmt: see soc.views.helper.forms.makeSelectQueryArgForm()
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   229
  """
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   230
  choices = makeNewPaginationChoices(limit=limit, choices=choices)
2049
d9adbaf1c30f Some fixes to lists helper to reduce mutation.
Daniel Bentley <dbentley@google.com>
parents: 1821
diff changeset
   231
632
1f20cfb91e11 Remove unused imports from some modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 572
diff changeset
   232
  return soc.views.helper.forms.makeSelectQueryArgForm(
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   233
      request, arg_name, limit, choices)
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   234
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   235
1810
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
   236
def makeNewPaginationChoices(limit=DEF_DEFAULT_PAGINATION,
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   237
                             choices=DEF_PAGINATION_CHOICES):
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   238
  """Updates the pagination limit selection form.
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   239
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   240
  Args:
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   241
    limit: the initial value of the selection control;
1810
ec0bae3632bb Adhere to the DEF_... pattern for constants in lists
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1807
diff changeset
   242
      default is DEF_DEFAULT_PAGINATION
632
1f20cfb91e11 Remove unused imports from some modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 572
diff changeset
   243
    choices: see soc.views.helper.forms.makeSelectQueryArgForm();
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   244
      default is DEF_PAGINATION_CHOICES
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   245
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   246
  Returns:
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   247
    a new pagination choices list if limit is not in
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   248
    DEF_PAGINATION_CHOICES, or DEF_PAGINATION_CHOICES otherwise
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   249
  """
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   250
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   251
  new_choices = []
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   252
  new_choice = (str(limit), '%s items per page' % limit)
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   253
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   254
  new_choices.append(new_choice)
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   255
  new_choices.extend(choices)
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   256
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   257
  if user_logic.isDeveloper():
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   258
    new_choices.extend(DEF_DEVELOPER_CHOICES)
277
85f7d537e4d7 Speed up average case by appending remainder of original choices list unchanged
Todd Larsen <tlarsen@google.com>
parents: 274
diff changeset
   259
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   260
  new_choices = set(new_choices)
265
3c2994f3b85f List views should have a selectable pagination "page" length:
Todd Larsen <tlarsen@google.com>
parents: 228
diff changeset
   261
1811
75d3c1384736 Greatly simplify makeNewPaginationChoices
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1810
diff changeset
   262
  return sorted(new_choices, key=lambda (x, y): int(x))