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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34

35
from urllib import quote
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36 37 38 39 40 41 42 43 44 45 46 47 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
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(
                         '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)

    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)
    return ''    
    
class ERP5Report(ERP5Form):
    """
        An ERP5Form which allows to aggregate a list of 
        forms each of which is rendered on an object with parameters.
        
73
        Application: create an accounting book from ERP5 objects 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
        
        - 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)
        
89
          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    """
    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()

    def __init__(self, id, title, unicode_mode=0, encoding='UTF-8', stored_encoding='UTF-8'):
        """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'):
129
          kwargs['args'] = args
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130 131 132 133 134 135 136
        form = self
        object = getattr(form, 'aq_parent', None)
        if object:
          container = object.aq_inner.aq_parent
        else:
          container = None
        pt = getattr(self,self.pt)
137
        report_method = getattr(object,self.report_method)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
        extra_context = self.pt_getContext()
        extra_context['options'] = kwargs
        extra_context['form'] = self
        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
159
    except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        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:
178 179 180 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
  override the values of the selection parameters and preference in the
  constructor of the ReportSection.
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
187 188 189 190 191
  meta_type = "ReportSection"
  security = ClassSecurityInfo()
  
  param_dict = {}

192
  def __init__(self, path='', form_id='view',
193
                     title=None, translated_title=None, level=1,
194 195 196 197 198
                     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
199 200 201
    """
      Initialize the line and set the default values
      Selected columns must be defined in parameter of listbox.render...
202 203 204 205 206

      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
207 208 209 210
    """
    
    self.path = path
    self.form_id = form_id
211 212 213 214 215 216 217 218 219
    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
220
    self.saved_selections = {}
221 222
    self.selection_report_path = selection_report_path
    self.selection_report_list = selection_report_list
223 224 225 226 227
    if preferences == None :
      preferences = {}
    self.preferences = preferences
    self.saved_preferences = {}
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
228 229 230 231
  security.declarePublic('getTitle')
  def getTitle(self):
    return self.title

232 233 234 235 236 237 238 239
  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
240 241 242 243 244 245 246 247 248 249 250 251
  security.declarePublic('getPath')
  def getPath(self):
    return self.path

  security.declarePublic('getObject')
  def getObject(self, context):
    return context.restrictedTraverse(self.path)

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

    portal_pref = context.getPortalObject().portal_preferences
    for pref, value in self.preferences.items() :
      self.saved_preferences[pref] = portal_pref.getPreference(pref)
      portal_pref.setPreference(pref, value)
    
310
  security.declarePublic('popReport')
311 312 313 314 315 316
  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:
317
        REQUEST.form[k] = self.saved_request[k]
318
    
319
    portal_selections = context.portal_selections
320 321 322 323 324 325
    selection_list = []
    if self.form_id and hasattr(context[self.form_id], 'listbox') :
      selection_list += [ context[self.form_id].listbox.get_value('selection_name') ]
    selection_list += [self.selection_name]
    # restore report then form selection
    for selection_name in selection_list:
326
      if selection_name is not None:
327 328 329 330 331 332
        if self.selection_report_list is not None:
          selection = portal_selections.getSelectionFor(selection_name, REQUEST=REQUEST)
          selection.edit(report_list = self.saved_selections[selection_name]['report_list'])
        if self.selection_report_path is not None:
          selection = portal_selections.getSelectionFor(selection_name, REQUEST=REQUEST)
          selection.edit(report_path = self.saved_selections[selection_name]['report_path'])
333
        if self.listbox_display_mode is not None:
334 335 336 337 338 339
          # 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)
340
        if self.selection_params is not None:
341 342 343
          # first make sure no parameters that have been pushed are erased 
          portal_selections.setSelectionParamsFor(selection_name, {}, REQUEST=REQUEST)
          # then restore the original params
344
          portal_selections.setSelectionParamsFor(selection_name,
345 346 347
                                                  self.saved_selections[selection_name]['params'],
                                                  REQUEST=REQUEST)
        if self.selection_columns is not None:
348
          portal_selections.setSelectionColumns(selection_name,
349 350 351
                                              self.saved_selections[selection_name]['columns'],
                                              REQUEST=REQUEST)
        if self.selection_sort_order is not None:
352
          portal_selections.setSelectionSortOrder(selection_name,
353 354
                                              self.saved_selections[selection_name]['sort_order'],
                                              REQUEST=REQUEST)
355 356 357

    for pref, value in self.saved_preferences.items() :
      context.getPortalObject().portal_preferences.setPreference(pref, value)
358

Jean-Paul Smets's avatar
Jean-Paul Smets committed
359 360
InitializeClass(ReportSection)
allow_class(ReportSection)
361