FormPrintout.py 25.7 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 29
##############################################################################
#
# Copyright (c) 2009 Nexedi KK and Contributors. All Rights Reserved.
#                    Tatuya Kamada <tatuya@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.
#
##############################################################################
from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
30 31
from Products.CMFCore.utils import _checkPermission, getToolByName
from Products.PythonScripts.Utility import allow_class
32
from Products.ERP5Type import PropertySheet, Permissions
33 34 35
from Products.ERP5Form.ListBox import ListBox
from Products.ERP5Form.FormBox import FormBox
from Products.ERP5Form.ImageField import ImageField
36 37 38 39 40 41 42 43 44 45 46 47
from Products.ERP5OOo.OOoUtils import OOoBuilder

from Acquisition import Implicit
from Globals import InitializeClass, DTMLFile, Persistent, get_request
from AccessControl import ClassSecurityInfo
from AccessControl.Role import RoleManager
from OFS.SimpleItem import Item, SimpleItem
from urllib import quote
from copy import deepcopy
from lxml import etree
from zLOG import LOG, DEBUG, INFO, WARNING
from mimetypes import guess_extension
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
48
from DateTime import DateTime
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

try:
  from webdav.Lockable import ResourceLockedError
  from webdav.WriteLockInterface import WriteLockInterface
  SUPPORTS_WEBDAV_LOCKS = 1
except ImportError:
  SUPPORTS_WEBDAV_LOCKS = 0

# Constructors
manage_addFormPrintout = DTMLFile("dtml/FormPrintout_add", globals())

def addFormPrintout(self, id, title="", form_name='', template='', REQUEST=None):
  """Add form printout to folder.

  Keyword arguments:
  id     -- the id of the new form printout to add
  title  -- the title of the form printout to add
  form_name -- the name of a form which contains data to printout
  template -- the name of a template which describes printout layout
  """
  # add actual object
  id = self._setObject(id, FormPrintout(id, title, form_name, template))
  # respond to the add_and_edit button if necessary
  add_and_edit(self, id, REQUEST)
  return ''

def add_and_edit(self, id, REQUEST):
  """Helper method to point to the object's management screen if
  'Add and Edit' button is pressed.

  Keyword arguments:
80
  id -- the id of the object we just added
81 82 83 84 85 86 87 88 89 90
  """
  if REQUEST is None:
    return
  try:
    u = self.DestinationURL()
  except AttributeError:
    u = REQUEST['URL1']
  if REQUEST['submit'] == " Add and Edit ":
    u = "%s/%s" % (u, quote(id))
  REQUEST.RESPONSE.redirect(u+'/manage_main')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
91

92 93 94 95 96
class FormPrintout(Implicit, Persistent, RoleManager, Item):
  """Form Printout

  The Form Printout enables to create a ODF document.

97
  The Form Printout receives an ERP5 form name, and a template name.
98 99 100 101 102 103 104 105 106
  Using their parameters, the Form Printout genereate a ODF document,
  a form as a ODF document content, and a template as a document layout.

  WARNING: The Form Printout currently supports only ODT format document.
  And the functions only supports paragraphs and tables.
  
  Fields <-> Paragraphs:      supported
  ListBox <-> Table:          supported
  Report Section <-> Tables:  experimentally supported
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
107
  FormBox <-> Frame:          experimentally supported
108
  Photo <-> Image:            not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
109
  Style group <-> styles.xml: supported
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
  Meta group <-> meta.xml:    not supported yet
  """
  
  meta_type = "ERP5 Form Printout"

  # Declarative Security
  security = ClassSecurityInfo()

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

  # Constructors
  constructors =   (manage_addFormPrintout, addFormPrintout)

  # Tabs in ZMI
  manage_options = ((
    {'label':'Edit', 'action':'manage_editFormPrintout'},
    {'label':'View', 'action': '' }, ) + Item.manage_options)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
129
  
130 131
  security.declareProtected('View management screens', 'manage_editFormPrintout')
  manage_editFormPrintout = PageTemplateFile('www/FormPrintout_manageEdit', globals(),
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
132
                                             __name__='manage_editFormPrintout')
133 134 135 136 137 138 139 140 141 142 143 144 145 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
  manage_editFormPrintout._owner = None
  
  # default attributes
  template = None
  form_name = None

  def __init__(self, id, title='', form_name='', template=''):
    """Initialize id, title, form_name, template.

    Keyword arguments:
    id -- the id of a form printout
    title -- the title of a form printout
    form_name -- the name of a form which as a document content
    template -- the name of a template which as a document layout
    """
    self.id = id
    self.title = title
    self.form_name = form_name
    self.template = template

  security.declareProtected('View management screens', 'index_html')
  def index_html(self, icon=0, preview=0, width=None, height=None, REQUEST=None):
    """Render and view a printout document."""
    
    obj = getattr(self, 'aq_parent', None)
    if obj is not None:
      container = obj.aq_inner.aq_parent
      if not _checkPermission(Permissions.View, obj):
        raise AccessControl_Unauthorized('This document is not authorized for view.')
      else:
        container = None
    form = getattr(obj, self.form_name)
    if self.template is None or self.template == '':
      raise ValueError, 'Can not create a ODF Document without a printout template'
    printout_template = getattr(obj, self.template)

    report_method = None
    if hasattr(form, 'report_method'):
      report_method = getattr(obj, form.report_method)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
172 173 174 175 176
    extra_context = dict(container=container,
                         printout_template=printout_template,
                         report_method=report_method,
                         form=form,
                         here=obj)
177 178
    # set property to aquisition
    content_type = printout_template.content_type
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
179
    self.strategy = self._createStrategy(content_type)
180 181 182 183 184
    printout = self.strategy.render(extra_context=extra_context)
    REQUEST.RESPONSE.setHeader('Content-Type','%s; charset=utf-8' % content_type)
    REQUEST.RESPONSE.setHeader('Content-disposition',
                               'inline;filename="%s%s"' % (self.title_or_id(), guess_extension(content_type)))
    return printout
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
185

186 187 188 189
  security.declareProtected('View management screens', '__call__')  
  def __call__(self, *args, **kwargs):
    return self.index_html(REQUEST=get_request())
                
190 191 192 193 194 195 196 197 198 199 200 201 202 203
  security.declareProtected('Manage properties', 'doSettings')
  def doSettings(self, REQUEST, title='', form_name='', template=''):
    """Change title, form_name, template."""
    if SUPPORTS_WEBDAV_LOCKS and self.wl_isLocked():
      raise ResourceLockedError, "File is locked via WebDAV"
    self.form_name = form_name
    self.template = template
    self.title = title
    message = "Saved changes."
    if getattr(self, '_v_warnings', None):
      message = ("<strong>Warning:</strong> <i>%s</i>"
                % '<br>'.join(self._v_warnings))
    return self.manage_editFormPrintout(manage_tabs_message=message)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
204
  def _createStrategy(slef, content_type=''):
205 206 207 208 209 210 211 212
    if guess_extension(content_type) == '.odt':
      return ODTStrategy()
    raise ValueError, 'Do not support the template type:%s' % content_type

InitializeClass(FormPrintout)

class ODFStrategy(Implicit):
  """ODFStrategy creates a ODF Document. """
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
213

214
  def render(self, extra_context={}):
215
    """Render a odf document, form as a content, template as a template.
216 217

    Keyword arguments:
218
    extra_context -- a dictionary, expected:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
219 220 221 222
      'here' : where it call
      'printout_template' : the template object, tipically a OOoTemplate
      'container' : the object which has a form printout object
      'form' : the form as a content
223 224 225 226 227 228 229 230 231
    """
    here = extra_context['here']
    if here is None:
      raise ValueError, 'Can not create a ODF Document without a parent acquisition context'
    form = extra_context['form']
    if not extra_context.has_key('printout_template') or extra_context['printout_template'] is None:
      raise ValueError, 'Can not create a ODF Document without a printout template'

    odf_template = extra_context['printout_template']
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
232

233
    # First, render the Template if it has a pt_render method
234 235 236 237
    ooo_document = None
    if hasattr(odf_template, 'pt_render'):
      ooo_document = odf_template.pt_render(here, extra_context=extra_context)
    else:
238
      # File object can be a template
239 240 241 242 243 244
      ooo_document = odf_template 

    # Create a new builder instance
    ooo_builder = OOoBuilder(ooo_document)

    # content.xml
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
245
    ooo_builder = self._replaceContentXml(ooo_builder=ooo_builder, extra_context=extra_context)
246
    # styles.xml
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
247
    ooo_builder = self._replaceStylesXml(ooo_builder=ooo_builder, extra_context=extra_context)
248
    # meta.xml is not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
249 250
    # ooo_builder = self._replaceMetaXml(ooo_builder=ooo_builder, extra_context=extra_context)

251 252 253 254 255 256
    # Update the META informations
    ooo_builder.updateManifest()

    ooo = ooo_builder.render(name=odf_template.title or odf_template.id)
    return ooo

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
257
  def _replaceContentXml(self, ooo_builder=None, extra_context=None):
258
    content_xml = ooo_builder.extract('content.xml')
259 260 261 262
    # mapping ERP5Form to ODF
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)

263
    content_element_tree = etree.XML(content_xml)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
264 265 266 267
    content_element_tree = self._replaceXmlByForm(element_tree=content_element_tree,
                                                  form=form,
                                                  here=here,
                                                  extra_context=extra_context)
268
    # mapping ERP5Report report method to ODF
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
269 270
    content_element_tree = self._replaceXmlByReportSection(element_tree=content_element_tree,
                                                           extra_context=extra_context)
Tatuya Kamada's avatar
Tatuya Kamada committed
271 272
    content_xml = etree.tostring(content_element_tree, encoding='utf-8')
 
273
    # Replace content.xml in master openoffice template
274
    ooo_builder.replace('content.xml', content_xml)
275 276 277
    return ooo_builder

  # this method not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
278
  def _replaceStylesXml(self, ooo_builder=None, extra_context=None):
279 280 281
    """
    replacing styles.xml file in a ODF document
    """
282
    styles_xml = ooo_builder.extract('styles.xml')
283 284
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)
285
    styles_element_tree = etree.XML(styles_xml)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
286 287 288 289
    styles_element_tree = self._replaceXmlByForm(element_tree=styles_element_tree,
                                                 form=form,
                                                 here=here,
                                                 extra_context=extra_context)
Tatuya Kamada's avatar
Tatuya Kamada committed
290
    styles_xml = etree.tostring(styles_element_tree, encoding='utf-8')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
291

292
    ooo_builder.replace('styles.xml', styles_xml)
293 294 295
    return ooo_builder

  # this method not implemented yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
296
  def _replaceMetaXml(self, ooo_builder=None, extra_content=None):
297 298 299
    """
    replacing meta.xml file in a ODF document
    """
300
    meta_xml = ooo_builder.extract('meta.xml')
301 302

    if isinstance(doc_xml, unicode):
303
      meta_xml = meta_xml.encode('utf-8')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
304

305
    ooo_builder.replace('meta.xml', meta_xml)
306 307
    return ooo_builder

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
308
  def _replaceXmlByForm(self, element_tree=None, form=None, here=None,
309 310
                           extra_context=None, render_prefix=None):
    field_list = form.get_fields() 
311
    REQUEST = get_request()
312
    for (count, field) in enumerate(field_list):
313
      if isinstance(field, ListBox):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
314 315 316 317
        element_tree = self._appendTableByListbox(element_tree=element_tree,
                                                  listbox=field,
                                                  REQUEST=REQUEST,
                                                  render_prefix=render_prefix)
318 319
      elif isinstance(field, FormBox):
        sub_form = getattr(here, field.get_value('formbox_target_id'))
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
320 321 322 323
        content = self._replaceXmlByFormbox(element_tree=element_tree,
                                            field_id=field.id,
                                            form = sub_form,
                                            REQUEST=REQUEST)
324
      #elif isinstance(field, ImageField):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
325
      #  element_tree = self._replaceXmlByImageField(element_tree=element_tree,
Tatuya Kamada's avatar
Tatuya Kamada committed
326
      #                                                  image_field=field)
327
      else:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
328
        element_tree = self._replaceNodeViaReference(element_tree=element_tree,
329 330
                                                        field=field)
    return element_tree
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
331 332

  def _replaceNodeViaReference(self, element_tree=None, field=None):
Tatuya Kamada's avatar
Tatuya Kamada committed
333 334 335 336 337 338 339 340 341 342 343
    """replace nodes (e.g. paragraphs) via ODF reference"""
    element_tree = self._replaceNodeViaRangeReference(element_tree=element_tree, field=field)
    element_tree = self._replaceNodeViaPointReference(element_tree=element_tree, field=field)
    return element_tree
  
  def _replaceNodeViaPointReference(self, element_tree=None, field=None):
    """replace via ODF point reference
    
    point reference example:
     <text:reference-mark text:name="invoice-date"/>
    """
344 345
    field_id = field.id
    field_value = field.get_value('default')
Tatuya Kamada's avatar
Tatuya Kamada committed
346
    value = self._toUnicodeString(field_value)
347 348
    # text:reference-mark text:name="invoice-date"
    reference_xpath = '//text:reference-mark[@text:name="%s"]' % field_id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
349
    reference_list = element_tree.xpath(reference_xpath, namespaces=element_tree.nsmap)
350 351
    if len(reference_list) > 0:
      node = reference_list[0].getparent()
352
      # remove such a "bbb": <text:p>aaa<br/>bbb</text:p>
353 354
      for child in node.getchildren():
        child.tail = ''
Tatuya Kamada's avatar
Tatuya Kamada committed
355
      node.text = value
356
    return element_tree
Tatuya Kamada's avatar
Tatuya Kamada committed
357 358 359
  
  def _replaceNodeViaRangeReference(self, element_tree=None, field=None):
    """replace via ODF range reference
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
360

Tatuya Kamada's avatar
Tatuya Kamada committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    range reference example:
    <text:reference-mark-start text:name="week"/>Monday<text:reference-mark-end text:name="week"/>
    """
    field_value = field.get_value('default')
    value = self._toUnicodeString(field_value)
    range_reference_xpath = '//text:reference-mark-start[@text:name="%s"]' % field.id
    reference_list = element_tree.xpath(range_reference_xpath, namespaces=element_tree.nsmap)
    if len(reference_list) is 0:
      return element_tree
    target_node = reference_list[0]
    target_node.tail = value
    for node in target_node.itersiblings():
      end_tag_name = '{%s}reference-mark-end' % element_tree.nsmap['text']
      name_attribute = '{%s}name' % element_tree.nsmap['text']
      if node.tag == end_tag_name and node.get(name_attribute) == field.id:
         break
      node.tail = ''
    return element_tree
  
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
380
  def _replaceXmlByReportSection(self, element_tree=None, extra_context=None):
381
    if not extra_context.has_key('report_method') or extra_context['report_method'] is None:
382
      return element_tree
383 384 385 386 387 388 389 390 391 392 393 394 395
    report_method = extra_context['report_method']
    report_section_list = report_method()
    portal_object = self.getPortalObject()
    REQUEST = get_request()
    request = extra_context.get('REQUEST', REQUEST)
    render_prefix = None
    for (index, report_item) in enumerate(report_section_list):
      if index > 0:
        render_prefix = 'x%s' % index
      report_item.pushReport(portal_object, render_prefix = render_prefix)
      here = report_item.getObject(portal_object)
      form_id = report_item.getFormId()
      form = getattr(here, form_id)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
396 397 398 399 400
      element_tree = self._replaceXmlByForm(element_tree=element_tree,
                                            form=form,
                                            here=here,
                                            extra_context=extra_context,
                                            render_prefix=render_prefix)
401
      report_item.popReport(portal_object, render_prefix = render_prefix)
402 403
    return element_tree

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
404
  def _replaceXmlByFormbox(self, element_tree=None, field_id=None, form=None, REQUEST=None):
405
    draw_xpath = '//draw:frame[@draw:name="%s"]/draw:text-box/*' % field_id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
406
    text_list = element_tree.xpath(draw_xpath, namespaces=element_tree.nsmap)
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
    if len(text_list) == 0:
      return element_tree
    parent = text_list[0].getparent()
    parent.clear()
    # this form.__call__() possibly has a side effect,
    # so must clear the 'here' context for listBox.get_value()
    box = form(REQUEST=REQUEST);
    REQUEST.set('here', None)
    node = etree.XML(box)
    # TODO style_copy
    if node is not None:
      for child in node.getchildren():
        parent.append(child)
    return element_tree

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
422
  def _replaceXmlByImageField(self, element_tree=None, image_field=None):
423 424
    alt = image_field.get_value('description') or image_field.get_value('title')
    image_xpath = '//draw:frame[@draw:name="%s"]/*' % image_field.id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
425
    image_list = element_tree.xpath(image_xpath, namespaces=element_tree.nsmap)
426
    if len(image_list) > 0:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
427 428
      image_list[0].set("{%s}href" % element_tree.nsmap['xlink'], image_field.absolute_url())

429
    return element_tree
430

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
431 432 433 434 435
  def _appendTableByListbox(self,
                            element_tree=None, 
                            listbox=None,
                            REQUEST=None,
                            render_prefix=None):
436 437 438
    table_id = listbox.id
    table_xpath = '//table:table[@table:name="%s"]' % table_id
    # this list should be one item list
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
439
    target_table_list = element_tree.xpath(table_xpath, namespaces=element_tree.nsmap)
440
    if len(target_table_list) is 0:
441
      return element_tree
442 443 444

    target_table = target_table_list[0]
    newtable = deepcopy(target_table)
445

446 447
    table_header_rows_xpath = '%s/table:table-header-rows' % table_xpath
    table_row_xpath = '%s/table:table-row' % table_xpath
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
448 449
    table_header_rows_list = newtable.xpath(table_header_rows_xpath,  namespaces=element_tree.nsmap)
    table_row_list = newtable.xpath(table_row_xpath,  namespaces=element_tree.nsmap)
450 451 452

    # copy row styles from ODF Document
    has_header_rows = len(table_header_rows_list) > 0
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
453 454
    (row_top, row_middle, row_bottom) = self._copyRowStyle(table_row_list,
                                                           has_header_rows=has_header_rows)
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

    # clear original table 
    parent_paragraph = target_table.getparent()
    target_index = parent_paragraph.index(target_table)
    # 'render_prefix is None' means it is the first table of iteration
    if render_prefix is None:
      parent_paragraph.remove(target_table)
    # clear rows 
    for table_row in table_row_list:
      newtable.remove(table_row)

    listboxline_list = listbox.get_value('default',
                                         render_format='list',
                                         REQUEST=REQUEST, 
                                         render_prefix=render_prefix)
    
471 472
    # if ODF table has header rows, does not update the header rows
    # if does not have header rows, insert the listbox title line
473
    is_top = True
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
474
    last_index = len(listboxline_list) - 1
475 476 477 478
    for (index, listboxline) in enumerate(listboxline_list):
      listbox_column_list = listboxline.getColumnItemList()
      if listboxline.isTitleLine() and not has_header_rows:
        row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
479
        row = self._updateColumnValue(row, listbox_column_list)
480 481 482 483
        newtable.append(row)
        is_top = False       
      elif listboxline.isDataLine() and is_top:
        row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
484
        row = self._updateColumnValue(row, listbox_column_list)
485 486
        newtable.append(row)
        is_top = False
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
487 488
      elif listboxline.isStatLine() or index is last_index:
        row = deepcopy(row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
489
        row = self._updateColumnStatValue(row, listbox_column_list, row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
490
        newtable.append(row)
491 492
      elif index > 0 and listboxline.isDataLine():
        row = deepcopy(row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
493
        row = self._updateColumnValue(row, listbox_column_list)
494 495 496 497 498 499 500 501
        newtable.append(row)

    # direct listbox mapping
    if render_prefix is None:
      parent_paragraph.insert(target_index, newtable)
    else:
      # report section iteration
      parent_paragraph.append(newtable)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
502

503
    return element_tree
504

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
505
  def _copyRowStyle(self, table_row_list=[], has_header_rows=False):
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
    row_top = None
    row_middle = None
    row_bottom = None
    if len(table_row_list) > 0:
      if len(table_row_list) is 1:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[0])
        row_bottom = deepcopy(table_row_list[0])
      elif len(table_row_list) is 2 and has_header_rows:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[0])
        row_bottom = deepcopy(table_row_list[-1])
      elif len(table_row_list) is 2 and not has_header_rows:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[1])
        row_bottom = deepcopy(table_row_list[-1])
      elif len(table_row_list) >= 2:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[1])
        row_bottom = deepcopy(table_row_list[-1])
    return (row_top, row_middle, row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
527 528 529

  def _updateColumnValue(self, row=None, listbox_column_list=[]):
    odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
530 531 532 533 534 535
    odf_cell_list_size = len(odf_cell_list)
    listbox_column_size = len(listbox_column_list)
    for (column_index, column) in enumerate(odf_cell_list):
      if column_index >= listbox_column_size:
        break
      value = listbox_column_list[column_index][1]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
536
      self._setColumnValue(column, value)
537 538
    return row

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
539
  def _updateColumnStatValue(self, row=None, listbox_column_list=[], row_middle=None):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
540
    """stat line is capable of column span setting"""
541 542
    if row_middle is None:
      return row
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
543 544
    odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
    odf_column_span_list = self._getOdfColumnSpanList(row_middle)
545 546 547 548 549 550
    listbox_column_size = len(listbox_column_list)
    listbox_column_index = 0
    for (column_index, column) in enumerate(odf_cell_list):
      if listbox_column_index >= listbox_column_size:
        break
      value = listbox_column_list[listbox_column_index][1]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
551 552 553 554 555
      self._setColumnValue(column, value)
      column_span = self._getColumnSpanSize(column)
      listbox_column_index = self._nextListboxColumnIndex(column_span,
                                                          listbox_column_index,
                                                          odf_column_span_list)
556 557
    return row

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
558 559
  def _setColumnValue(self, column, value):
    self._clearColumnValue(column)
560
    if value is None:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
561
      value = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
562 563 564
      self._removeColumnValue(column)
    if isinstance(value, DateTime):
      value = value.strftime('%Y-%m-%d')
565 566 567
    column_value = unicode(str(value),'utf-8')
    column.text = column_value
    column_children = column.getchildren()
568
    first_child = None
569
    if len(column_children) > 0:
570 571 572 573
      first_child = deepcopy(column_children[0])
      first_child.text = column_value
    for child in column_children:
      column.remove(child)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
574 575
    if first_child is not None:
      column.append(first_child)
576
    if column_value != '':
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
577
      value_attribute = self._getColumnValueAttribute(column)
578 579 580
      if value_attribute is not None:
        column.set(value_attribute, column_value)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
581
  def _removeColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
582 583 584 585 586
    # to eliminate a default value, remove "office:*" attributes.
    # if remaining these attribetes, the column shows its default value,
    # such as '0.0', '$0'
    attrib = column.attrib
    for key in attrib.keys():
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
587
      if key.startswith("{%s}" % column.nsmap['office']):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
588 589 590 591 592
        del attrib[key]
    column_children = column.getchildren()
    for child in column_children:
      column.remove(child)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
593
  def _clearColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
594 595
    attrib = column.attrib
    for key in attrib.keys():
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
596
      value_attribute = self._getColumnValueAttribute(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
597 598 599 600 601 602
      if value_attribute is not None:
        column.set(value_attribute, '')
    column_children = column.getchildren()
    for child in column_children:
      child.text = ''

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
603
  def _getColumnValueAttribute(self, column):
604 605 606 607 608
    attrib = column.attrib
    for key in attrib.keys():
      if key.endswith("value"):
        return key
    return None
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
609 610 611

  def _getColumnSpanSize(self, column=None):
    span_attribute = "{%s}number-columns-spanned" % column.nsmap['table']
612 613 614 615
    column_span = 1
    if column.attrib.has_key(span_attribute):
      column_span = int(column.attrib[span_attribute])
    return column_span
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
616 617

  def _nextListboxColumnIndex(self, span=0, current_index=0, column_span_list=[]):
618 619 620 621 622 623 624
    hops = 0
    index = current_index
    while hops < span:
      column_span = column_span_list[index]
      hops += column_span
      index += 1
    return index
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
625 626

  def _getOdfColumnSpanList(self, row_middle=None):
627 628
    if row_middle is None:
      return []
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
629
    odf_cell_list = row_middle.findall("{%s}table-cell" % row_middle.nsmap['table'])
630 631
    column_span_list = []
    for column in odf_cell_list:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
632
      column_span = self._getColumnSpanSize(column)
633 634 635
      column_span_list.append(column_span)
    return column_span_list

Tatuya Kamada's avatar
Tatuya Kamada committed
636 637 638 639 640 641
  def _toUnicodeString(self, field_value = None):
    value = ''
    if field_value is not None:
      value = unicode(str(field_value), 'utf-8')
    return value

642 643 644
class ODTStrategy(ODFStrategy):
  """ODTStrategy create a ODT Document from a form and a ODT template"""
  pass