FormPrintout.py 34.9 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
##############################################################################
#
# 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
25 26
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301,
# USA.
27 28 29
##############################################################################
from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
30
from Products.CMFCore.utils import _checkPermission
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
31
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
from Products.ERP5OOo.OOoUtils import OOoBuilder

Tatuya Kamada's avatar
Tatuya Kamada committed
38
from Acquisition import Implicit, aq_base
39 40 41 42
from Globals import InitializeClass, DTMLFile, Persistent, get_request
from AccessControl import ClassSecurityInfo
from AccessControl.Role import RoleManager
from OFS.SimpleItem import Item, SimpleItem
Tatuya Kamada's avatar
Tatuya Kamada committed
43 44
from OFS.Image import File
from urllib import quote, quote_plus
45 46 47 48
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
49
from DateTime import DateTime
Tatuya Kamada's avatar
Tatuya Kamada committed
50 51
from decimal import Decimal
import re
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

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:
83
  id -- the id of the object we just added
84 85 86 87 88 89 90 91 92 93
  """
  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
94

95 96 97 98 99
class FormPrintout(Implicit, Persistent, RoleManager, Item):
  """Form Printout

  The Form Printout enables to create a ODF document.

100
  The Form Printout receives an ERP5 form name, and a template name.
101 102 103 104
  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.
Tatuya Kamada's avatar
Tatuya Kamada committed
105 106

  The functions status:
107
  
Tatuya Kamada's avatar
Tatuya Kamada committed
108 109 110 111 112 113 114
  Fields -> Paragraphs:      supported
  ListBox -> Table:          supported
  Report Section -> Frames:  experimentally supported
  FormBox -> Frame:          experimentally supported
  ImageField -> Photo:       supported
  styles.xml:                supported
  meta.xml:                  not supported yet
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
  """
  
  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
133
  
134 135
  security.declareProtected('View management screens', 'manage_editFormPrintout')
  manage_editFormPrintout = PageTemplateFile('www/FormPrintout_manageEdit', globals(),
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
136
                                             __name__='manage_editFormPrintout')
137
  manage_editFormPrintout._owner = None
138 139 140 141

  # alias definition to do 'add_and_edit'
  security.declareProtected('View management screens', 'manage_main')
  manage_main = manage_editFormPrintout
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
  
  # 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

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
161
  security.declareProtected('View', 'index_html')
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
  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
180 181 182 183 184
    extra_context = dict(container=container,
                         printout_template=printout_template,
                         report_method=report_method,
                         form=form,
                         here=obj)
Tatuya Kamada's avatar
Tatuya Kamada committed
185
    # set property to do aquisition
186
    content_type = printout_template.content_type
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
187
    self.strategy = self._createStrategy(content_type)
188
    printout = self.strategy.render(extra_context=extra_context)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
189 190 191 192
    if REQUEST is not None:
      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)))
193
    return printout
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
194

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
195 196
  security.declareProtected('View', '__call__')
  __call__ = index_html
197
                
198 199 200 201 202 203 204 205 206 207 208 209 210 211
  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
212
  def _createStrategy(slef, content_type=''):
213 214 215 216 217 218 219 220
    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
221

Tatuya Kamada's avatar
Tatuya Kamada committed
222 223
  odf_existent_name_list = []
  
224
  def render(self, extra_context={}):
225
    """Render a odf document, form as a content, template as a template.
226 227

    Keyword arguments:
228
    extra_context -- a dictionary, expected:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
229 230 231 232
      '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
233 234 235 236 237 238 239 240 241
    """
    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
242

243
    # First, render the Template if it has a pt_render method
244 245 246 247
    ooo_document = None
    if hasattr(odf_template, 'pt_render'):
      ooo_document = odf_template.pt_render(here, extra_context=extra_context)
    else:
248
      # File object can be a template
249 250 251 252
      ooo_document = odf_template 

    # Create a new builder instance
    ooo_builder = OOoBuilder(ooo_document)
Tatuya Kamada's avatar
Tatuya Kamada committed
253 254
    self.odf_existent_name_list = ooo_builder.getNameList()
    
255
    # content.xml
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
256
    ooo_builder = self._replaceContentXml(ooo_builder=ooo_builder, extra_context=extra_context)
257
    # styles.xml
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
258
    ooo_builder = self._replaceStylesXml(ooo_builder=ooo_builder, extra_context=extra_context)
259
    # meta.xml is not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
260 261
    # ooo_builder = self._replaceMetaXml(ooo_builder=ooo_builder, extra_context=extra_context)

262 263 264 265 266 267
    # 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
268
  def _replaceContentXml(self, ooo_builder=None, extra_context=None):
269
    content_xml = ooo_builder.extract('content.xml')
270 271 272 273
    # mapping ERP5Form to ODF
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)

274
    content_element_tree = etree.XML(content_xml)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
275 276 277
    content_element_tree = self._replaceXmlByForm(element_tree=content_element_tree,
                                                  form=form,
                                                  here=here,
Tatuya Kamada's avatar
Tatuya Kamada committed
278 279
                                                  extra_context=extra_context,
                                                  ooo_builder=ooo_builder)
280
    # mapping ERP5Report report method to ODF
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
281
    content_element_tree = self._replaceXmlByReportSection(element_tree=content_element_tree,
Tatuya Kamada's avatar
Tatuya Kamada committed
282 283
                                                           extra_context=extra_context,
                                                           ooo_builder=ooo_builder)
Tatuya Kamada's avatar
Tatuya Kamada committed
284 285
    content_xml = etree.tostring(content_element_tree, encoding='utf-8')
 
286
    # Replace content.xml in master openoffice template
287
    ooo_builder.replace('content.xml', content_xml)
288 289 290
    return ooo_builder

  # this method not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
291
  def _replaceStylesXml(self, ooo_builder=None, extra_context=None):
292 293 294
    """
    replacing styles.xml file in a ODF document
    """
295
    styles_xml = ooo_builder.extract('styles.xml')
296 297
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)
298
    styles_element_tree = etree.XML(styles_xml)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
299 300 301
    styles_element_tree = self._replaceXmlByForm(element_tree=styles_element_tree,
                                                 form=form,
                                                 here=here,
Tatuya Kamada's avatar
Tatuya Kamada committed
302 303
                                                 extra_context=extra_context,
                                                 ooo_builder=ooo_builder)
Tatuya Kamada's avatar
Tatuya Kamada committed
304
    styles_xml = etree.tostring(styles_element_tree, encoding='utf-8')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
305

306
    ooo_builder.replace('styles.xml', styles_xml)
307 308 309
    return ooo_builder

  # this method not implemented yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
310
  def _replaceMetaXml(self, ooo_builder=None, extra_context=None):
311 312 313
    """
    replacing meta.xml file in a ODF document
    """
314
    meta_xml = ooo_builder.extract('meta.xml')
315 316

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

319
    ooo_builder.replace('meta.xml', meta_xml)
320 321
    return ooo_builder

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
322
  def _replaceXmlByForm(self, element_tree=None, form=None, here=None,
323
                           extra_context=None, ooo_builder=None, iteration_index=0):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
324
    field_list = form.get_fields(include_disabled=1) 
325
    REQUEST = get_request()
326
    for (count, field) in enumerate(field_list):
327
      if isinstance(field, ListBox):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
328 329
        element_tree = self._appendTableByListbox(element_tree=element_tree,
                                                  listbox=field,
330 331
                                                  REQUEST=REQUEST,
                                                  iteration_index=iteration_index)
332
      elif isinstance(field, FormBox):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
333 334
        if not hasattr(here, field.get_value('formbox_target_id')):
          continue
335
        sub_form = getattr(here, field.get_value('formbox_target_id'))
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
336
        content = self._replaceXmlByFormbox(element_tree=element_tree,
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
337 338 339
                                            field=field,
                                            form=sub_form,
                                            extra_context=extra_context,
340 341
                                            ooo_builder=ooo_builder,
                                            iteration_index=iteration_index)
Tatuya Kamada's avatar
Tatuya Kamada committed
342 343 344
      elif isinstance(field, ImageField):
        element_tree = self._replaceXmlByImageField(element_tree=element_tree,
                                                    image_field=field,
345 346
                                                    ooo_builder=ooo_builder,
                                                    iteration_index=iteration_index)
347
      else:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
348
        element_tree = self._replaceNodeViaReference(element_tree=element_tree,
349
                                                     field=field, iteration_index=iteration_index)
350
    return element_tree
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
351

352
  def _replaceNodeViaReference(self, element_tree=None, field=None, iteration_index=0):
Tatuya Kamada's avatar
Tatuya Kamada committed
353 354 355 356 357
    """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
  
358
  def _replaceNodeViaPointReference(self, element_tree=None, field=None, iteration_index=0):
Tatuya Kamada's avatar
Tatuya Kamada committed
359 360 361 362 363
    """replace via ODF point reference
    
    point reference example:
     <text:reference-mark text:name="invoice-date"/>
    """
364 365
    field_id = field.id
    field_value = field.get_value('default')
Tatuya Kamada's avatar
Tatuya Kamada committed
366
    value = self._toUnicodeString(field_value)
367 368
    # 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
369
    reference_list = element_tree.xpath(reference_xpath, namespaces=element_tree.nsmap)
370
    if len(reference_list) > 0:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
371 372
      paragraph_node = reference_list[0].getparent()
      parent_node = paragraph_node.getparent()
373
      # remove such a "bbb": <text:p>aaa<br/>bbb</text:p>
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
374 375 376 377 378 379
      if not isinstance(field_value, list):
        for child in paragraph_node.getchildren():
          child.tail = ''
          paragraph_node.text = value
      else:
        self._appendParagraphsWithLineList(target_node=target_node, line_list=field_value)
380 381 382 383 384
    # set when using report section
    self._setUniqueElementName(base_name=field.id,
                               iteration_index=iteration_index,
                               xpath=reference_xpath,
                               element_tree=element_tree)
385
    return element_tree
Tatuya Kamada's avatar
Tatuya Kamada committed
386
  
387
  def _replaceNodeViaRangeReference(self, element_tree=None, field=None, iteration_index=0):
Tatuya Kamada's avatar
Tatuya Kamada committed
388
    """replace via ODF range reference
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
389

Tatuya Kamada's avatar
Tatuya Kamada committed
390 391 392 393 394 395 396 397 398 399
    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]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
400 401 402 403 404 405 406 407 408 409
    if not isinstance(field_value, list):
      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 = ''
    else:
      self._appendParagraphsWithLineList(target_node=target_node, line_list=field_value)
410 411 412 413 414 415

    # set when using report section
    self._setUniqueElementName(base_name=field.id,
                               iteration_index=iteration_index,
                               xpath=range_reference_xpath,
                               element_tree=element_tree)
Tatuya Kamada's avatar
Tatuya Kamada committed
416
    return element_tree
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447

  def _appendParagraphsWithLineList(self, target_node=None, line_list=None):
    """create paragraphs 
    
    example:
    --
    first line
    second line
    --
    <p:text>
    first line
    </p:text>
    <p:text>
    second line
    </p:text>
    """
    paragraph_node = target_node.getparent()
    parent_node = paragraph_node.getparent()
    paragraph_list = []
    for line in line_list:
      p = deepcopy(paragraph_node)
      for child in p.getchildren():
        child.tail = ''
      value = self._toUnicodeString(line)
      p.text = value
      paragraph_list.append(p)
    paragraph_node_index = parent_node.index(paragraph_node)
    parent_node.remove(paragraph_node)
    for (index, paragraph) in enumerate(paragraph_list):
      parent_node.insert(paragraph_node_index + 1, paragraph)

Tatuya Kamada's avatar
Tatuya Kamada committed
448
  def _replaceXmlByReportSection(self, element_tree=None, extra_context=None, ooo_builder=None):
449
    if not extra_context.has_key('report_method') or extra_context['report_method'] is None:
450
      return element_tree
451 452 453 454 455
    report_method = extra_context['report_method']
    report_section_list = report_method()
    portal_object = self.getPortalObject()
    REQUEST = get_request()
    request = extra_context.get('REQUEST', REQUEST)
Tatuya Kamada's avatar
Tatuya Kamada committed
456

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
457 458 459 460 461 462 463 464 465 466 467 468 469
    report_section_frame_xpath = '//draw:frame[@draw:name="%s"]' % report_method.__name__
    frame_list = element_tree.xpath(report_section_frame_xpath, namespaces=element_tree.nsmap)
    if len(frame_list) is 0:
      return element_tree
    frame = frame_list[0]
    frame_paragraph = frame.getparent()
    office_body = frame_paragraph.getparent()
    # remove if no report section
    if len(report_section_list) is 0:
      office_body.remove(frame_paragraph)
      return element_tree
    frame_paragraph_index = office_body.index(frame_paragraph)
    temporary_element_tree = deepcopy(frame_paragraph)
470
    for (index, report_item) in enumerate(report_section_list):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
471
      report_item.pushReport(portal_object, render_prefix=None)
472 473 474
      here = report_item.getObject(portal_object)
      form_id = report_item.getFormId()
      form = getattr(here, form_id)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
475 476 477 478
      
      frame_paragraph_element_tree = deepcopy(temporary_element_tree)
      if index is 0:
        office_body.remove(frame_paragraph)
Tatuya Kamada's avatar
Tatuya Kamada committed
479
      else:
480 481 482 483
        self._setUniqueElementName(base_name=report_method.__name__,
                                   iteration_index=index,
                                   xpath=report_section_frame_xpath,
                                   element_tree=frame_paragraph_element_tree)
Tatuya Kamada's avatar
Tatuya Kamada committed
484 485 486 487 488

      frame_paragraph_element_tree = self._replaceXmlByForm(element_tree=frame_paragraph_element_tree,
                                                            form=form,
                                                            here=here,
                                                            extra_context=extra_context,
489 490
                                                            ooo_builder=ooo_builder,
                                                            iteration_index=index)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
491 492
      office_body.insert(frame_paragraph_index, frame_paragraph_element_tree)
      frame_paragraph_index += 1
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
493
      report_item.popReport(portal_object, render_prefix=None)
494 495
    return element_tree

496 497 498 499 500 501 502 503 504 505
  def _setUniqueElementName(self, base_name='', iteration_index=0, xpath='', element_tree=None):
    """create a unique element name and set it to the element tree

    Keyword arguments:
    base_name -- the base name of the element
    iteration_index -- iteration index
    xpath -- xpath expression which was used to search the element
    element_tree -- element tree
    """
    if iteration_index is 0:
Tatuya Kamada's avatar
Tatuya Kamada committed
506
      return
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
    def getNameAttribute(target_element=None):
      if target_element is None:
        return None
      attrib = target_element.attrib
      for key in attrib.keys():
        if key.endswith("}name"):
          return key
      return None
    odf_element_name =  "%s_%s" % (base_name, iteration_index)
    result_list = element_tree.xpath(xpath, namespaces=element_tree.nsmap)
    if len(result_list) is 0:
      return
    target_element = result_list[0]
    name_attribute = getNameAttribute(target_element)
    if name_attribute is not None:
      target_element.set(name_attribute, odf_element_name)
 
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
524 525 526 527 528
  def _replaceXmlByFormbox(self,
                           element_tree=None,
                           field=None,
                           form=None,
                           extra_context=None,
529 530
                           ooo_builder=None,
                           iteration_index=0):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
531 532
    field_id = field.id
    enabled = field.get_value('enabled')
533
    draw_xpath = '//draw:frame[@draw:name="%s"]/draw:text-box/*' % field_id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
534
    text_list = element_tree.xpath(draw_xpath, namespaces=element_tree.nsmap)
535 536
    if len(text_list) == 0:
      return element_tree
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
537 538 539 540 541 542
    target_element = text_list[0]
    frame_paragraph = target_element.getparent()
    office_body = frame_paragraph.getparent()
    if not enabled:
      office_body.remove(frame_paragraph)
      return element_tree
543 544 545 546 547
    # set when using report section
    self._setUniqueElementName(base_name=field_id,
                               iteration_index=iteration_index,
                               xpath=draw_xpath,
                               element_tree=element_tree)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
548 549 550 551
    self._replaceXmlByForm(element_tree=frame_paragraph,
                           form=form,
                           here=extra_context['here'],
                           extra_context=extra_context,
552 553
                           ooo_builder=ooo_builder,
                           iteration_index=iteration_index)
554 555
    return element_tree

556 557 558 559 560
  def _replaceXmlByImageField(self,
                              element_tree=None,
                              image_field=None,
                              ooo_builder=None,
                              iteration_index=0):
561 562
    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
563
    image_list = element_tree.xpath(image_xpath, namespaces=element_tree.nsmap)
Tatuya Kamada's avatar
Tatuya Kamada committed
564 565 566
    if len(image_list) is 0:
      return element_tree
    path = image_field.get_value('default')
Tatuya Kamada's avatar
Tatuya Kamada committed
567 568
    if path is not None:
      path = path.encode()
Tatuya Kamada's avatar
Tatuya Kamada committed
569
    picture = self.getPortalObject().restrictedTraverse(path)
Tatuya Kamada's avatar
Tatuya Kamada committed
570 571 572 573 574 575 576 577 578 579
    picture_data = getattr(aq_base(picture), 'data', None)
    picture_type = picture.getContentType()
    picture_path = self._createOdfUniqueFileName(path=path, picture_type=picture_type)
    ooo_builder.addFileEntry(picture_path, media_type=picture_type, content=picture_data)
    image_node = image_list[0]
    picture_size = self._getPictureSize(picture, image_node)
    image_node.set('{%s}href' % element_tree.nsmap['xlink'], picture_path)
    image_frame = image_node.getparent()
    image_frame.set('{%s}width' % element_tree.nsmap['svg'], picture_size[0])
    image_frame.set('{%s}height' % element_tree.nsmap['svg'], picture_size[1])
580 581 582 583 584
    # set when using report section
    self._setUniqueElementName(base_name=image_field.id,
                               iteration_index=iteration_index,
                               xpath=image_xpath,
                               element_tree=element_tree)
585
    return element_tree
586

Tatuya Kamada's avatar
Tatuya Kamada committed
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  def _createOdfUniqueFileName(self, path='', picture_type=''):
    extension = guess_extension(picture_type)
    picture_path = 'Pictures/%s%s' % (quote_plus(path), extension)     
    if picture_path not in self.odf_existent_name_list:
      return picture_path
    number = 0
    while True:
      picture_path = 'Pictures/%s_%s%s' % (path, number, extension)
      if picture_path not in self.odf_existent_name_list:
        return picture_path
      number += 1

  def _getPictureSize(self, picture=None, image_node=None):
    if picture is None or image_node is None:
      return ('0cm', '0cm')
    draw_frame_node = image_node.getparent()
    svg_width = draw_frame_node.attrib.get('{%s}width' % draw_frame_node.nsmap['svg'])
    svg_height = draw_frame_node.attrib.get('{%s}height' % draw_frame_node.nsmap['svg'])
    if svg_width is None or svg_height is None:
      return ('0cm', '0cm')
    # if not match causes exception
    width_tuple = re.match("(\d[\d\.]*)(.*)", svg_width).groups()
    height_tuple = re.match("(\d[\d\.]*)(.*)", svg_height).groups()
    unit = width_tuple[1]
    w = Decimal(width_tuple[0])
    h = Decimal(height_tuple[0])
    aspect_ratio = 1
    try: # try image properties
      aspect_ratio = Decimal(picture.width) / Decimal(picture.height)
    except (TypeError, ZeroDivisionError):
      try: # try ERP5.Document.Image API
        height = Decimal(picture.getHeight())
        if height:
          aspect_ratio = Decimal(picture.getWidth()) / height
      except AttributeError: # fallback to Photo API
        height = float(picture.height())
        if height:
          aspect_ratio = Decimal(picture.width()) / height
Tatuya Kamada's avatar
Tatuya Kamada committed
625 626 627 628 629 630
    resize_w = h * aspect_ratio
    resize_h = w / aspect_ratio
    if resize_w < w:
      w = resize_w
    elif resize_h < h:
      h = resize_h
Tatuya Kamada's avatar
Tatuya Kamada committed
631 632 633
    return (str(w) + unit, str(h) + unit)
   
  
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
634 635 636
  def _appendTableByListbox(self,
                            element_tree=None, 
                            listbox=None,
637 638
                            REQUEST=None,
                            iteration_index=0):
639 640 641
    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
642
    target_table_list = element_tree.xpath(table_xpath, namespaces=element_tree.nsmap)
643
    if len(target_table_list) is 0:
644
      return element_tree
645 646 647

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

649 650
    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
651 652
    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)
653 654 655

    # copy row styles from ODF Document
    has_header_rows = len(table_header_rows_list) > 0
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
656 657
    (row_top, row_middle, row_bottom) = self._copyRowStyle(table_row_list,
                                                           has_header_rows=has_header_rows)
658 659 660 661

    # clear original table 
    parent_paragraph = target_table.getparent()
    target_index = parent_paragraph.index(target_table)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
662
    parent_paragraph.remove(target_table)
663 664 665 666 667 668 669
    # clear rows 
    for table_row in table_row_list:
      newtable.remove(table_row)

    listboxline_list = listbox.get_value('default',
                                         render_format='list',
                                         REQUEST=REQUEST, 
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
670
                                         render_prefix=None)
671
    
672 673
    # if ODF table has header rows, does not update the header rows
    # if does not have header rows, insert the listbox title line
674
    is_top = True
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
675
    last_index = len(listboxline_list) - 1
676 677 678 679
    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
680
        row = self._updateColumnValue(row, listbox_column_list)
681 682 683 684
        newtable.append(row)
        is_top = False       
      elif listboxline.isDataLine() and is_top:
        row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
685
        row = self._updateColumnValue(row, listbox_column_list)
686 687
        newtable.append(row)
        is_top = False
Tatuya Kamada's avatar
Tatuya Kamada committed
688
      elif listboxline.isStatLine() or (index is last_index and listboxline.isDataLine()):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
689
        row = deepcopy(row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
690
        row = self._updateColumnStatValue(row, listbox_column_list, row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
691
        newtable.append(row)
692 693
      elif index > 0 and listboxline.isDataLine():
        row = deepcopy(row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
694
        row = self._updateColumnValue(row, listbox_column_list)
695 696
        newtable.append(row)

697 698 699 700
    self._setUniqueElementName(base_name=table_id,
                               iteration_index=iteration_index,
                               xpath=table_xpath,
                               element_tree=newtable)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
701 702
    parent_paragraph.insert(target_index, newtable)
 
703
    return element_tree
704

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
705
  def _copyRowStyle(self, table_row_list=[], has_header_rows=False):
706 707 708 709 710 711
    def removeOfficeAttribute(row):
      if row is None or has_header_rows: return
      odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
      for odf_cell in odf_cell_list:
        self._removeColumnValue(odf_cell)
          
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
    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])
732 733 734

    # remove office attribute if create a new header row 
    removeOfficeAttribute(row_top)
735
    return (row_top, row_middle, row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
736 737 738

  def _updateColumnValue(self, row=None, listbox_column_list=[]):
    odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
739 740 741 742 743 744
    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
745
      self._setColumnValue(column, value)
746 747
    return row

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
748
  def _updateColumnStatValue(self, row=None, listbox_column_list=[], row_middle=None):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
749
    """stat line is capable of column span setting"""
750 751
    if row_middle is None:
      return row
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
752 753
    odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
    odf_column_span_list = self._getOdfColumnSpanList(row_middle)
754 755 756 757 758 759
    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
760 761 762 763 764
      self._setColumnValue(column, value)
      column_span = self._getColumnSpanSize(column)
      listbox_column_index = self._nextListboxColumnIndex(column_span,
                                                          listbox_column_index,
                                                          odf_column_span_list)
765 766
    return row

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
767 768
  def _setColumnValue(self, column, value):
    self._clearColumnValue(column)
769
    if value is None:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
770
      value = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
771 772 773
      self._removeColumnValue(column)
    if isinstance(value, DateTime):
      value = value.strftime('%Y-%m-%d')
774 775
    column_value = unicode(str(value),'utf-8')
    column_children = column.getchildren()
776
    first_child = None
777
    if len(column_children) > 0:
778 779 780 781
      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
782 783
    if first_child is not None:
      column.append(first_child)
784
    if column_value != '':
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
785
      value_attribute = self._getColumnValueAttribute(column)
786 787 788
      if value_attribute is not None:
        column.set(value_attribute, column_value)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
789
  def _removeColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
790 791 792 793 794
    # 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
795
      if key.startswith("{%s}" % column.nsmap['office']):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
796
        del attrib[key]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
797
    column.text = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
798 799 800 801
    column_children = column.getchildren()
    for child in column_children:
      column.remove(child)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
802
  def _clearColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
803 804
    attrib = column.attrib
    for key in attrib.keys():
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
805
      value_attribute = self._getColumnValueAttribute(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
806 807
      if value_attribute is not None:
        column.set(value_attribute, '')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
808
    column.text = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
809 810
    column_children = column.getchildren()
    for child in column_children:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
811
      # clear data except style
Tatuya Kamada's avatar
Tatuya Kamada committed
812
      style_attribute_tuple = self._getStyleAttributeTuple(child)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
813
      child.clear()
Tatuya Kamada's avatar
Tatuya Kamada committed
814 815
      if style_attribute_tuple is not None:
        child.set(style_attribute_tuple[0], style_attribute_tuple[1])
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
816 817 818 819 820 821

  def _getStyleAttributeTuple(self, element):
    attrib = element.attrib
    for key in attrib.keys():
      if key.endswith('style-name'):
        return (key, attrib[key])
Tatuya Kamada's avatar
Tatuya Kamada committed
822
    return None
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
823
  
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
824
  def _getColumnValueAttribute(self, column):
825 826 827 828 829
    attrib = column.attrib
    for key in attrib.keys():
      if key.endswith("value"):
        return key
    return None
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
830 831 832

  def _getColumnSpanSize(self, column=None):
    span_attribute = "{%s}number-columns-spanned" % column.nsmap['table']
833 834 835 836
    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
837 838

  def _nextListboxColumnIndex(self, span=0, current_index=0, column_span_list=[]):
839 840 841 842 843 844 845
    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
846 847

  def _getOdfColumnSpanList(self, row_middle=None):
848 849
    if row_middle is None:
      return []
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
850
    odf_cell_list = row_middle.findall("{%s}table-cell" % row_middle.nsmap['table'])
851 852
    column_span_list = []
    for column in odf_cell_list:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
853
      column_span = self._getColumnSpanSize(column)
854 855 856
      column_span_list.append(column_span)
    return column_span_list

Tatuya Kamada's avatar
Tatuya Kamada committed
857 858
  def _toUnicodeString(self, field_value = None):
    value = ''
Tatuya Kamada's avatar
Tatuya Kamada committed
859 860 861
    if isinstance(field_value, unicode):
      value = field_value
    elif field_value is not None:
Tatuya Kamada's avatar
Tatuya Kamada committed
862 863 864
      value = unicode(str(field_value), 'utf-8')
    return value

865 866 867
class ODTStrategy(ODFStrategy):
  """ODTStrategy create a ODT Document from a form and a ODT template"""
  pass