Folder_viewSearchDialog.py 14.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#############################################################################
#
# Copyright (c) 2007 Nexedi SA and Contributors. All Rights Reserved.
#                    Jerome Perrin <jerome@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

29
from Products.ERP5Type.Globals import get_request
30 31 32
from Products.Formulator.TALESField import TALESMethod
from Products.CMFCore.utils import getToolByName

33
from Products.ERP5Type.Message import translateString
34 35 36 37
from Products.ERP5Form.Form import ERP5Form
from Products.ERP5Form.ListBox import ListBoxListRenderer


38
def getSearchDialog(self, REQUEST=None):
39 40 41 42 43 44 45
  """Generate a dynamic search dialog from a listbox.
  """
  request = get_request()
  portal = self.getPortalObject()
  category_tool = getToolByName(portal, 'portal_categories')
  types_tool = getToolByName(portal, 'portal_types')
  workflow_tool = getToolByName(portal, 'portal_workflow')
46 47

  default_view = self.getTypeInfo().getDefaultViewFor(self)
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
  listbox = default_view.listbox

  temp_form = ERP5Form('Folder_viewSearchDialog', 'Search').__of__(self)
  temp_form.pt = 'form_dialog'
  temp_form.action = 'Folder_search'

  selection_name = listbox.get_value('selection_name')
  request.set('selection_name', selection_name)
  request.set('form_id', default_view.getId())


  def addListField(field_id, field_title):
    # this one is for categories
    request_key = field_id
    field_id = 'your_%s_relative_url' % field_id
    temp_form.manage_addField(field_id, field_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_category_list'))
    field._surcharged_edit(dict(title=field_title), ['title'])
    field._surcharged_tales(
        dict(
            default=TALESMethod(
              'here/portal_selections/%s/%s_relative_url | nothing' 
                                    % (selection_name, request_key)),
            items=TALESMethod('python: getattr(here.portal_categories["%s"],'
                             'here.portal_preferences.getPreference("'
                             'preferred_category_child_item_list_method_id",'
                             '"getCategoryChildCompactLogicalPathItemList"))('
                             'checked_permission="View", base=1,'
                             'local_sort_id="int_index")' % request_key)),
            ['title', 'items', 'default'])


  def addFloatField(field_id, field_title):
    request_key = field_id
    field_id = 'your_%s' % field_id
    temp_form.manage_addField(field_id, field_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_money_quantity'))
    field._surcharged_edit(dict(title=field_title), ['title'])
    field._surcharged_tales(
        dict(default=TALESMethod(
            'here/portal_selections/%s/%s_value_ | nothing' 
                % (selection_name, request_key))), ['title', 'default'])
    field_id = 'your_%s_usage_' % request_key
    temp_form.manage_addField(field_id, field_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_category'))
102 103 104 105 106 107
    field._surcharged_edit(dict(
      title=translateString('${key} ${usage}',
                            mapping=dict(key=translateString(column_title),
                                         usage=translateString('Usage'))),
      items=[(translateString('Equals To'), ''),
             (translateString('Greater Than'), 'min'),
Yusei Tahara's avatar
Yusei Tahara committed
108 109 110
             (translateString('Less Than'),'max'),
             (translateString('Not Greater Than'), 'ngt'),
             (translateString('Not Less Than'), 'nlt'),
111
             ]),
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
                                
                           ['title', 'items'])
    field._surcharged_tales(
        dict(
            default=TALESMethod(
              'here/portal_selections/%s/%s_usage_ | nothing' 
                  % (selection_name, request_key))),
            ['title', 'items', 'default'])

  def addDateTimeField(field_id, field_title):
    request_key = field_id
    field_id = 'your_%s' % field_id
    temp_form.manage_addField(field_id, field_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_date'))
    field._surcharged_edit(dict(title=field_title), ['title'])
    field._surcharged_tales(
        dict(default=TALESMethod(
            'here/portal_selections/%s/%s_value_ | nothing' 
                % (selection_name, request_key))), ['title', 'default'])
    field_id = 'your_%s_usage_' % request_key
    temp_form.manage_addField(field_id, field_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_category'))
140 141 142
    field._surcharged_edit(dict(title=translateString('${key} ${usage}', mapping=dict(key=translateString(column_title), usage=translateString('Usage'))),
                                items=[(translateString('Equals To'), ''),
                                       (translateString('Greater Than'), 'min'),
Yusei Tahara's avatar
Yusei Tahara committed
143 144 145
                                       (translateString('Less Than'),'max'),
                                       (translateString('Not Greater Than'), 'ngt'),
                                       (translateString('Not Less Than'), 'nlt'),
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
                                       ]),
                                
                           ['title', 'items'])
    field._surcharged_tales(
        dict(
            default=TALESMethod(
              'here/portal_selections/%s/%s_usage_ | nothing' 
                  % (selection_name, request_key))),
            ['title', 'items', 'default'])
    

  def addStringField(field_id, field_title):
    request_key = field_id
    field_id = 'your_%s' % field_id
    temp_form.manage_addField(field_id, field_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_title'))
    field._surcharged_edit(dict(title=field_title,
                                description=''), ['title', 'description'])
    field._surcharged_tales(
        dict(default=TALESMethod(
          'here/portal_selections/%s/%s/query |'
          'here/portal_selections/%s/%s | string:' 
       % (selection_name, request_key, selection_name, request_key))),
        ['title', 'description', 'default'])


  def addFullTextStringField(field_id, field_title):
    addStringField(field_id, field_title)

  def addKeywordSearchStringField(column_id, column_title,
                                  default_search_key='ExactMatch'):
    addStringField(column_id, column_title)
    request_key = column_id
    field_id = 'your_%s_search_key' % column_id
    temp_form.manage_addField(field_id, column_title, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_category'))
188
    field._surcharged_edit(dict(title=translateString('${key} ${usage}', mapping=dict(key=translateString(column_title), usage=translateString('Search Key'))),
189
                                description='',
190
                                items=[(translateString('Default (${search_key})',
191
                                            mapping=dict(search_key=
192
                                               translateString(default_search_key))), ''),
Yusei Tahara's avatar
Yusei Tahara committed
193
                                       (translateString('Exact Match'), 'ExactMatch' ),
194
                                       (translateString('Keyword'), 'Keyword'),
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
                                       ]),
                                
                           ['title', 'items'])
    field._surcharged_tales(
        dict(
            default=TALESMethod(
              'here/portal_selections/%s/%s_search_key | nothing' 
                      % (selection_name, request_key))),
            ['title', 'items', 'default'])


  base_category_list = category_tool.getBaseCategoryList()
  catalog_schema = portal.portal_catalog.schema()
  sql_catalog = portal.portal_catalog.getSQLCatalog()
  sql_catalog_keyword_search_keys = sql_catalog.sql_catalog_keyword_search_keys
  sql_catalog_full_text_search_keys =\
              sql_catalog.sql_catalog_full_text_search_keys

  column_list = ListBoxListRenderer(
                      listbox.widget, listbox, request).getAllColumnList()

216 217
  search_list = ListBoxListRenderer(
                      listbox.widget, listbox, request).getSearchColumnIdSet()
218

219 220 221 222 223 224 225 226 227 228 229 230 231
  for column_id, column_title in column_list:
    if column_id in search_list:
      # is it a base category ?
      short_column_id = column_id
      # strip the usuale default_ and _title that are on standard fields.
      if short_column_id.endswith('_title'):
        short_column_id = short_column_id[:-6]
      if short_column_id.startswith('default_'):
        short_column_id = short_column_id[8:]
      if short_column_id in base_category_list:
        # is this base category empty ? then it might be used to relate documents,
        # in that case, simply provide a text input
        if not len(category_tool[short_column_id]):
232 233 234 235
          default_search_key = 'ExactMatch'
          if column_id in sql_catalog_keyword_search_keys:
            default_search_key = 'Keyword'
          addKeywordSearchStringField(column_id, column_title,
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
                                      default_search_key=default_search_key)
        else:
          addListField(short_column_id, column_title)
        continue


      if column_id in catalog_schema:
        if column_id.endswith('state') or column_id.endswith('state_title'):
          # this is a workflow state, it will be handled later
          continue
        elif 'date' in column_id:
          # is it date ? -> provide exact + range
          # TODO: do we need an API in catalog for this ?
          addDateTimeField(column_id, column_title)

        elif 'quantity' in column_id or 'price' in column_id:
          # is it float ? -> provide exact + range
          # TODO: do we need an API in catalog for this ?
          addFloatField(column_id, column_title)
        else:
          if column_id in sql_catalog_full_text_search_keys:
            addFullTextStringField(column_id, column_title)
          else:
            default_search_key = 'ExactMatch'
            if column_id in sql_catalog_keyword_search_keys:
              default_search_key = 'Keyword'
            addKeywordSearchStringField(column_id, column_title,
                            default_search_key=default_search_key)
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

  # TODO always add SearchableText ?
  
  allowed_content_types = types_tool.getTypeInfo(self).allowed_content_types
  # remember which workflow we already displayed
  workflow_dict = dict()
  # possible workflow states
  for type_name in allowed_content_types:
    for workflow_id in workflow_tool.getChainFor(type_name):
      workflow = workflow_tool.getWorkflowById(workflow_id)
      state_var = workflow.variables.getStateVar()

      if state_var in workflow_dict:
        continue

      workflow_dict[state_var] = 1
      if workflow.states is None or \
                len(workflow.states.objectIds()) <= 1:
        continue

      field_id = 'your_%s' % state_var
      temp_form.manage_addField(field_id, field_id, 'ProxyField')
      field = temp_form._getOb(field_id)
      field.manage_edit_xmlrpc(dict(
          form_id='Base_viewDialogFieldLibrary',
          field_id='your_category_list'))
290
      items = [('', '')] + sorted([(translateString(x.title), x.id) for x
291
                         in workflow.states.objectValues()],
292
                         key=lambda x:str(x[0]))
293
      field._surcharged_edit(
294
              dict(title=translateString(workflow.title),
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
                   items=items,
                   size=len(items)),
              ['title', 'items', 'size'])
      field._surcharged_tales(
          dict(
              default=TALESMethod(
                'here/portal_selections/%s/%s | nothing' 
                        % (selection_name, state_var))),
              ['title', 'items', 'size', 'default'])
      

  # if more than 1 allowed content types -> list possible content types
  if len(allowed_content_types) > 1:
    field_id = 'your_portal_type'
    temp_form.manage_addField(field_id, field_id, 'ProxyField')
    field = temp_form._getOb(field_id)
    field.manage_edit_xmlrpc(dict(
        form_id='Base_viewDialogFieldLibrary',
        field_id='your_category_list'))
    field._surcharged_edit(
315 316
            dict(title=translateString('Type'),
                 items=[(translateString(x), x) for x in allowed_content_types]),
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
            
            ['title', 'items'])
    field._surcharged_tales(
        dict(
            default=TALESMethod(
              'here/portal_selections/%s/portal_type | nothing' 
                                    % selection_name)),
            ['title', 'items', 'default'])


  # Order fields
  default_group = temp_form.group_list[0]
  field_list = temp_form.get_fields()
  for field in field_list:
    field_id = field.getId()
    if field_id.endswith('search_key') or field_id.endswith('_usage_'):
      temp_form.move_field_group([field_id], default_group, 'right')
    elif field.get_value('field_id') == 'your_category_list':
      temp_form.move_field_group([field_id], default_group, 'center')

337 338 339 340
  if REQUEST is not None:
    # if called from the web, render the form, other wise return it (for
    # Base_callDialogMethod)
    return temp_form(REQUEST)
341 342
  return temp_form