Report.py 14.6 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@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 30
from Globals import InitializeClass, DTMLFile, get_request
from AccessControl import ClassSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from Products.PythonScripts.Utility import allow_class
from Products.Formulator.DummyField import fields
33
from Products.Formulator.Form import ZMIForm
34
from zLOG import LOG, WARNING
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35

36
from urllib import quote
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37 38 39 40 41 42 43 44
from Products.ERP5Type import PropertySheet

from Form import ERP5Form
from Form import create_settings_form as Form_create_settings_form

def create_settings_form():
    form = Form_create_settings_form()
    report_method = fields.StringField(
45 46 47 48 49 50
         'report_method',
         title='Report Method',
         description=('The method to get a list of items (object, form,'
                      ' parameters) to aggregate in a single Report'),
         default='',
         required=0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

    form.add_fields([report_method])
    return form

manage_addReport = DTMLFile("dtml/report_add", globals())

def addERP5Report(self, id, title="", REQUEST=None):
    """Add form to folder.
    id     -- the id of the new form to add
    title  -- the title of the form to add
    Result -- empty string
    """
    # add actual object
    id = self._setObject(id, ERP5Report(id, title))
    # respond to the add_and_edit button if necessary
    add_and_edit(self, id, REQUEST)
67
    return ''
Jean-Paul Smets's avatar
Jean-Paul Smets committed
68 69 70 71 72 73
    
class ERP5Report(ERP5Form):
    """
        An ERP5Form which allows to aggregate a list of 
        forms each of which is rendered on an object with parameters.
        
74
        Application: create an accounting book from ERP5 objects 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
        
        - Display the total of each account (report)
        
        - List all accounts
        
        - Display the transactions of each account (one form with listbox)
        
        - List all clients
        
        - Display the transactions of each client (one form with listbox)
        
        - List all vendors
        
        - Display the transactions of each vendor (one form with listbox)
        
90
          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    """
    meta_type = "ERP5 Report"
    icon = "www/Form.png"

    # Declarative Security
    security = ClassSecurityInfo()

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.SimpleItem)

    # Constructors
    constructors =   (manage_addReport, addERP5Report)

    # This is a patched dtml formOrder
    security.declareProtected('View management screens', 'formOrder')
    formOrder = DTMLFile('dtml/formOrder', globals())

    # Default Attributes
    report_method = None
    
    # Special Settings
    settings_form = create_settings_form()

115 116
    def __init__(self, id, title, unicode_mode=0,
                  encoding='UTF-8', stored_encoding='UTF-8'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130
        """Initialize form.
        id    -- id of form
        title -- the title of the form
        """
        ZMIForm.inheritedAttribute('__init__')(self, "", "POST", "", id,
                                               encoding, stored_encoding,
                                               unicode_mode)
        self.id = id
        self.title = title
        self.row_length = 4

    # Proxy method to PageTemplate
    def __call__(self, *args, **kwargs):
        if not kwargs.has_key('args'):
131
          kwargs['args'] = args
Jean-Paul Smets's avatar
Jean-Paul Smets committed
132 133 134 135 136 137 138
        form = self
        object = getattr(form, 'aq_parent', None)
        if object:
          container = object.aq_inner.aq_parent
        else:
          container = None
        pt = getattr(self,self.pt)
139
        report_method = getattr(object,self.report_method)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
140 141 142
        extra_context = self.pt_getContext()
        extra_context['options'] = kwargs
        extra_context['form'] = self
143
        extra_context['request'] = get_request()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
        extra_context['container'] = container ## PROBLEM NOT TAKEN INTO ACCOUNT
        extra_context['here'] = object
        extra_context['report_method'] = report_method
        return pt.pt_render(extra_context=extra_context)

    def _exec(self, bound_names, args, kw):
        pt = getattr(self,self.pt)
        return pt._exec(self, bound_names, args, kw)

def add_and_edit(self, id, REQUEST):
    """Helper method to point to the object's management screen if
    'Add and Edit' button is pressed.
    id -- id of the object we just added
    """
    if REQUEST is None:
        return
    try:
        u = self.DestinationURL()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
162
    except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
        u = REQUEST['URL1']
    if REQUEST['submit'] == " Add and Edit ":
        u = "%s/%s" % (u, quote(id))
    REQUEST.RESPONSE.redirect(u+'/manage_main')

def manage_add_report(self, id, title="", unicode_mode=0, REQUEST=None):
    """Add form to folder.
    id     -- the id of the new form to add
    title  -- the title of the form to add
    Result -- empty string
    """
    # add actual object
    id = self._setObject(id, ZMIForm(id, title, unicode_mode))
    # respond to the add_and_edit button if necessary
    add_and_edit(self, id, REQUEST)
    return ''

class ReportSection:
181 182 183 184 185 186
  """ A section in an ERP5Report.
  
  ERP5 Reports are made of sections, which are some standards ERP5 Forms
  rendered in a single document.
  To create a report section, you have to define which object will be
  the context of the form, the id of the form, and dictionnaries to
187 188
  override the values of the selection parameters in the constructor of
  the ReportSection.
189
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
190 191 192 193 194
  meta_type = "ReportSection"
  security = ClassSecurityInfo()
  
  param_dict = {}

195
  def __init__(self, path='', form_id='view',
196
                     title=None, translated_title=None, level=1,
197 198 199 200 201
                     selection_name=None, selection_params=None,
                     listbox_display_mode=None, selection_columns=None,
                     selection_sort_order=None,
                     selection_report_path=None, selection_report_list=None,
                     preferences = None ) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
202 203 204
    """
      Initialize the line and set the default values
      Selected columns must be defined in parameter of listbox.render...
205 206 207 208

      In ReportTree listbox display mode, you can override :
        selection_report_path, the root category for this report 
        selection_report_list, the list of unfolded categories (defaults to all)      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
209 210 211 212
    """
    
    self.path = path
    self.form_id = form_id
213 214 215 216 217 218 219 220 221
    self.title = title
    self.translated_title = translated_title
    self.level = level
    self.saved_request = {}
    self.selection_name = selection_name
    self.selection_params = selection_params
    self.listbox_display_mode = listbox_display_mode
    self.selection_columns = selection_columns
    self.selection_sort_order = selection_sort_order
222
    self.saved_selections = {}
223 224
    self.selection_report_path = selection_report_path
    self.selection_report_list = selection_report_list
225
    self.saved_request_form = {}
226 227 228
    if preferences is not None :
      LOG('ERP5Report', WARNING,
       'using preferences in report is deprecated, please use selection only')
229
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
230 231 232 233
  security.declarePublic('getTitle')
  def getTitle(self):
    return self.title

234 235 236 237 238 239 240 241
  security.declarePublic('getTranslatedTitle')
  def getTranslatedTitle(self):
    return self.translated_title

  security.declarePublic('getLevel')
  def getLevel(self):
    return self.level

Jean-Paul Smets's avatar
Jean-Paul Smets committed
242 243 244 245 246 247
  security.declarePublic('getPath')
  def getPath(self):
    return self.path

  security.declarePublic('getObject')
  def getObject(self, context):
248
    return context.getPortalObject().restrictedTraverse(self.path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
249 250 251 252 253

  security.declarePublic('getFormId')
  def getFormId(self):
    return self.form_id
  
254
  _no_parameter_ = []
255
    
256
  security.declarePublic('pushReport')
257 258 259 260
  def pushReport(self, context):
    REQUEST = get_request()
    for k,v in self.param_dict.items():
      self.saved_request[k] = REQUEST.form.get(k, self._no_parameter_)
261
      REQUEST.form[k] = v
262 263
    
    portal_selections = context.portal_selections
264 265
    selection_list = [self.selection_name]
    if self.form_id and hasattr(context[self.form_id], 'listbox') :
266 267 268 269
      selection_list += [
          context[self.form_id].listbox.get_value('selection_name') ]
    # save report's selection and orignal form's selection,
    #as ListBox will overwrite it
270 271
    for selection_name in selection_list :
      if selection_name is not None :
272 273
        if not self.saved_selections.has_key(selection_name) :
          self.saved_selections[selection_name] = {}
274
        if self.selection_report_list is not None:
275 276
          selection = portal_selections.getSelectionFor(selection_name,
                                                        REQUEST=REQUEST)
277 278 279
          self.saved_selections[selection_name]['report_list'] = \
               selection.getReportList()
          selection.edit(report_list=self.selection_report_list)
280
        if self.selection_report_path is not None:
281 282
          selection = portal_selections.getSelectionFor(selection_name,
                                                        REQUEST=REQUEST)
283 284 285
          self.saved_selections[selection_name]['report_path'] = \
               selection.getReportPath()
          selection.edit(report_path=self.selection_report_path)
286
        if self.listbox_display_mode is not None:
287
          self.saved_selections[selection_name]['display_mode'] = \
288
               portal_selections.getListboxDisplayMode(selection_name,
289 290 291 292 293 294
                                                       REQUEST=REQUEST)
          # XXX Dirty fix, to be able to change the display mode in form_view
          REQUEST.list_selection_name = selection_name
          portal_selections.setListboxDisplayMode(
                                           REQUEST, self.listbox_display_mode,
                                           selection_name=selection_name)
295 296
        if self.selection_params is not None:
          self.saved_selections[selection_name]['params'] =  \
297 298
               portal_selections.getSelectionParams(
                               selection_name, REQUEST=REQUEST)
299
          portal_selections.setSelectionParamsFor(selection_name,
300
                               self.selection_params, REQUEST=REQUEST)
301 302
        if self.selection_columns is not None:
          self.saved_selections[selection_name]['columns'] =  \
303 304 305 306
               portal_selections.getSelectionColumns(selection_name,
                                                     REQUEST=REQUEST)
          portal_selections.setSelectionColumns(selection_name,
                                  self.selection_columns, REQUEST=REQUEST)
307 308
        if self.selection_sort_order is not None:
          self.saved_selections[selection_name]['sort_order'] =  \
309 310 311 312
               portal_selections.getSelectionSortOrder(selection_name,
                                                       REQUEST=REQUEST)
          portal_selections.setSelectionSortOrder(selection_name,
                      self.selection_sort_order, REQUEST=REQUEST)
313

314 315 316
    self.saved_request_form = REQUEST.form
    REQUEST.form = {}
    
317
  security.declarePublic('popReport')
318 319 320 321 322 323
  def popReport(self, context):
    REQUEST = get_request()
    for k,v in self.param_dict.items():
      if self.saved_request[k] is self._no_parameter_:
        del REQUEST.form[k]
      else:
324
        REQUEST.form[k] = self.saved_request[k]
325
    
326
    portal_selections = context.portal_selections
327 328
    selection_list = []
    if self.form_id and hasattr(context[self.form_id], 'listbox') :
329 330
      selection_list += [
                context[self.form_id].listbox.get_value('selection_name') ]
331 332 333
    selection_list += [self.selection_name]
    # restore report then form selection
    for selection_name in selection_list:
334
      if selection_name is not None:
335
        if self.selection_report_list is not None:
336 337 338 339
          selection = portal_selections.getSelectionFor(
                              selection_name, REQUEST=REQUEST)
          selection.edit(report_list =
                self.saved_selections[selection_name]['report_list'])
340
        if self.selection_report_path is not None:
341 342 343 344
          selection = portal_selections.getSelectionFor(
                selection_name, REQUEST=REQUEST)
          selection.edit(report_path =
                self.saved_selections[selection_name]['report_path'])
345
        if self.listbox_display_mode is not None:
346 347 348 349 350 351
          # XXX Dirty fix, to be able to change the display mode in form_view
          REQUEST.list_selection_name = selection_name
          portal_selections.setListboxDisplayMode(
                       REQUEST,
                       self.saved_selections[selection_name]['display_mode'],
                       selection_name=selection_name)
352
        if self.selection_params is not None:
353
          # first make sure no parameters that have been pushed are erased 
354 355
          portal_selections.setSelectionParamsFor(selection_name,
                                                  {}, REQUEST=REQUEST)
356
          # then restore the original params
357
          portal_selections.setSelectionParamsFor(selection_name,
358 359
                      self.saved_selections[selection_name]['params'],
                      REQUEST=REQUEST)
360
        if self.selection_columns is not None:
361
          portal_selections.setSelectionColumns(selection_name,
362 363
                      self.saved_selections[selection_name]['columns'],
                      REQUEST=REQUEST)
364
        if self.selection_sort_order is not None:
365
          portal_selections.setSelectionSortOrder(selection_name,
366 367
                      self.saved_selections[selection_name]['sort_order'],
                      REQUEST=REQUEST)
368 369
    
    REQUEST.form = self.saved_request_form
370

Jean-Paul Smets's avatar
Jean-Paul Smets committed
371 372
InitializeClass(ReportSection)
allow_class(ReportSection)
373