FormPrintout.py 45.4 KB
Newer Older
Nicolas Delaby's avatar
Nicolas Delaby committed
1
# -*- coding: utf-8 -*-
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
##############################################################################
#
# 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
26 27
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301,
# USA.
28 29
##############################################################################
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
30
from Products.CMFCore.utils import _checkPermission
31
from Products.ERP5Type import PropertySheet, Permissions
32 33
from Products.ERP5Form.ListBox import ListBox
from Products.ERP5Form.FormBox import FormBox
34
from Products.ERP5Form.ReportBox import ReportBox
35
from Products.ERP5Form.ImageField import ImageField
36
from Products.ERP5OOo.OOoUtils import OOoBuilder
37
from Products.CMFCore.exceptions import AccessControl_Unauthorized
Tatuya Kamada's avatar
Tatuya Kamada committed
38
from Acquisition import Implicit, aq_base
39
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, Persistent
40 41
from AccessControl import ClassSecurityInfo
from AccessControl.Role import RoleManager
42
from OFS.SimpleItem import Item
43
from OFS.PropertyManager import PropertyManager
Tatuya Kamada's avatar
Tatuya Kamada committed
44
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
from decimal import Decimal
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
51
from xml.sax.saxutils import escape
Tatuya Kamada's avatar
Tatuya Kamada committed
52
import re
53 54 55 56 57 58 59

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

60 61 62 63 64 65

DRAW_URI = 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0'
TEXT_URI = 'urn:oasis:names:tc:opendocument:xmlns:text:1.0'
XLINK_URI = 'http://www.w3.org/1999/xlink'
SVG_URI = 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0'
TABLE_URI = 'urn:oasis:names:tc:opendocument:xmlns:table:1.0'
66 67
OFFICE_URI = 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'
STYLE_URI = 'urn:oasis:names:tc:opendocument:xmlns:style:1.0'
68 69 70 71 72 73 74 75


NSMAP = {
          'draw': DRAW_URI,
          'text': TEXT_URI,
          'xlink': XLINK_URI,
          'svg': SVG_URI,
          'table': TABLE_URI,
76 77
          'office': OFFICE_URI,
          'style': STYLE_URI,
78 79 80
        }


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

84 85
def addFormPrintout(self, id, title="", form_name='', template='',
                    REQUEST=None, filename='object/title_or_id'):
86 87 88 89 90 91 92 93 94
  """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
95
  id = self._setObject(id, FormPrintout(id, title, form_name, template, filename))
96 97 98 99 100 101 102 103 104
  # 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:
105
  id -- the id of the object we just added
106 107 108 109 110 111 112 113 114 115
  """
  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
116

117
class FormPrintout(Implicit, Persistent, RoleManager, Item, PropertyManager):
118 119
  """Form Printout

Fabien Morin's avatar
Fabien Morin committed
120 121 122
  FormPrintout is one of a reporting system in ERP5.
  It enables to create a Printout, using an Open Document Format(ODF)
  document as its design, an ERP5Form as its contents.
123

Tatuya Kamada's avatar
Tatuya Kamada committed
124
  The functions status:
Fabien Morin's avatar
Fabien Morin committed
125

Tatuya Kamada's avatar
Tatuya Kamada committed
126 127
  Fields -> Paragraphs:      supported
  ListBox -> Table:          supported
128 129
  Report Section
      -> Frames or Sections: supported
Tatuya Kamada's avatar
Tatuya Kamada committed
130 131 132 133
  FormBox -> Frame:          experimentally supported
  ImageField -> Photo:       supported
  styles.xml:                supported
  meta.xml:                  not supported yet
134
  """
Fabien Morin's avatar
Fabien Morin committed
135

136
  meta_type = "ERP5 Form Printout"
137
  icon = "www/form_printout_icon.png"
138 139 140 141 142 143 144 145

  # Declarative Security
  security = ClassSecurityInfo()

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

146 147 148 149 150 151 152 153 154
  _properties = ( {'id': 'template',
                   'type': 'string',
                   'mode': 'w'},
                  {'id': 'form_name',
                   'type': 'string',
                   'mode': 'w'},
                  {'id': 'filename',
                   'type': 'tales',
                   'mode': 'w',},)
155 156 157 158 159 160 161
  # Constructors
  constructors =   (manage_addFormPrintout, addFormPrintout)

  # Tabs in ZMI
  manage_options = ((
    {'label':'Edit', 'action':'manage_editFormPrintout'},
    {'label':'View', 'action': '' }, ) + Item.manage_options)
Nicolas Delaby's avatar
Nicolas Delaby committed
162

163 164
  security.declareProtected('View management screens', 'manage_editFormPrintout')
  manage_editFormPrintout = PageTemplateFile('www/FormPrintout_manageEdit', globals(),
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
165
                                             __name__='manage_editFormPrintout')
166
  manage_editFormPrintout._owner = None
167 168 169 170

  # alias definition to do 'add_and_edit'
  security.declareProtected('View management screens', 'manage_main')
  manage_main = manage_editFormPrintout
Nicolas Delaby's avatar
Nicolas Delaby committed
171

172 173 174
  # default attributes
  template = None
  form_name = None
175
  filename = 'object/title_or_id'
176

177 178
  def __init__(self, id, title='', form_name='', template='',
               filename='object/title_or_id'):
179 180 181 182 183 184 185
    """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
186 187
    filename -- Tales expression which return the filename of
    downloadable file.
188 189 190 191 192
    """
    self.id = id
    self.title = title
    self.form_name = form_name
    self.template = template
193
    self.filename = filename
194

195 196 197 198
  security.declareProtected(Permissions.AccessContentsInformation, 'SearchableText')
  def SearchableText(self):
    return ' '.join((self.id, self.title, self.form_name, self.template, self.filename))

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
199
  security.declareProtected('View', 'index_html')
200 201
  def index_html(self, REQUEST, RESPONSE=None, template_relative_url=None,
                 format=None, batch_mode=False):
202 203 204 205 206 207
    """Render and view a printout document.

    format: conversion format requested by User.
            take precedence of format in REQUEST
    batch_mode: if True then avoid overriding response headers.
    """
Nicolas Delaby's avatar
Nicolas Delaby committed
208

209 210 211 212 213 214 215 216
    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)
217 218 219 220 221 222
    if template_relative_url:
      printout_template = obj.getPortalObject().\
                                      restrictedTraverse(template_relative_url)
    elif self.template:
      printout_template = getattr(obj, self.template)
    else:
223 224 225 226 227
      raise ValueError, 'Can not create a ODF Document without a printout template'

    report_method = None
    if hasattr(form, 'report_method'):
      report_method = getattr(obj, form.report_method)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
228 229 230 231 232
    extra_context = dict(container=container,
                         printout_template=printout_template,
                         report_method=report_method,
                         form=form,
                         here=obj)
Tatuya Kamada's avatar
Tatuya Kamada committed
233
    # set property to do aquisition
234
    content_type = printout_template.content_type
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
235
    self.strategy = self._createStrategy(content_type)
236
    printout = self.strategy.render(extra_context=extra_context)
237
    return self._oooConvertByFormat(printout, content_type,
238 239
                                    extra_context, REQUEST, 
                                    format, batch_mode)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
240

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
241 242
  security.declareProtected('View', '__call__')
  __call__ = index_html
Nicolas Delaby's avatar
Nicolas Delaby committed
243

244
  security.declareProtected('Manage properties', 'doSettings')
245 246
  def doSettings(self, REQUEST, title='', form_name='', template='', filename='object/title_or_id'):
    """Change title, form_name, template, filename."""
247 248 249 250 251
    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
252
    self.filename = filename
253 254 255 256 257 258
    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
259
  def _createStrategy(slef, content_type=''):
260 261
    if guess_extension(content_type) == '.odt':
      return ODTStrategy()
262 263 264
    if guess_extension(content_type) == '.odg':
      return ODGStrategy()
    raise ValueError, 'Template type: %s is not supported' % content_type
265

266 267
  def _oooConvertByFormat(self, printout, content_type, extra_context,
                          REQUEST, format, batch_mode):
268 269 270 271 272 273 274 275
    """
    Convert the ODF document into the given format.

    Keyword arguments:
    printout -- ODF document
    content_type -- the content type of the printout
    extra_context -- extra_context including a format
    REQUEST -- Request object
276 277
    format -- requested output format
    batch_mode -- Disable headers overriding
278
    """
279
    if REQUEST is not None and not format:
280
      format = REQUEST.get('format', None)
281
    filename = self.getProperty('filename')
282 283 284 285 286 287 288 289 290 291 292 293 294
    # Call refresh through cloudooo
    # XXX This is a temporary implementation:
    # Calling a webservice must be done through a WebServiceMethod
    # and a WebServiceConnection
    from Products.ERP5OOo.Document.OOoDocument import OOoServerProxy, enc, dec
    server_proxy = OOoServerProxy(self)
    extension = guess_extension(content_type).strip('.')
    printout = dec(server_proxy.convertFile(enc(printout),
                                        extension, # source_format
                                        extension, # destination_format
                                        False, # zip
                                        True)) # refresh
    # End of temporary implementation
295 296
    if not format:
      if REQUEST is not None and not batch_mode:
297
        REQUEST.RESPONSE.setHeader('Content-Length', len(printout))
298
        REQUEST.RESPONSE.setHeader('Content-Type','%s' % content_type)
299
        REQUEST.RESPONSE.setHeader('Content-disposition',
300 301
                                   'inline;filename="%s%s"' % \
                                     (filename, guess_extension(content_type) or ''))
302 303 304
      return printout
    from Products.ERP5Type.Document import newTempOOoDocument
    tmp_ooo = newTempOOoDocument(self, self.title_or_id())
305
    tmp_ooo.edit(data=printout,
306
                 base_data=printout,
307
                 filename=self.title_or_id(),
308 309
                 content_type=content_type,
                 base_content_type=content_type)
310
    mime, data = tmp_ooo.convert(format)
311
    if REQUEST is not None and not batch_mode:
312
      REQUEST.RESPONSE.setHeader('Content-Length', len(data))
313 314
      REQUEST.RESPONSE.setHeader('Content-type', mime)
      REQUEST.RESPONSE.setHeader('Content-disposition',
315
          'attachment;filename="%s.%s"' % (filename, format))
316
    return str(data)
317

318 319 320 321
InitializeClass(FormPrintout)

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

Tatuya Kamada's avatar
Tatuya Kamada committed
323
  odf_existent_name_list = []
Nicolas Delaby's avatar
Nicolas Delaby committed
324

325
  def render(self, extra_context={}):
326
    """Render a odf document, form as a content, template as a template.
327 328

    Keyword arguments:
329
    extra_context -- a dictionary, expected:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
330 331 332 333
      '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
334 335 336 337 338
    """
    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']
339 340
    if not extra_context.has_key('printout_template') or \
        extra_context['printout_template'] is None:
341 342 343
      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
344

345
    # First, render the Template if it has a pt_render method
346 347 348 349
    ooo_document = None
    if hasattr(odf_template, 'pt_render'):
      ooo_document = odf_template.pt_render(here, extra_context=extra_context)
    else:
350
      # File object can be a template
351
      ooo_document = odf_template
352 353 354

    # Create a new builder instance
    ooo_builder = OOoBuilder(ooo_document)
Tatuya Kamada's avatar
Tatuya Kamada committed
355
    self.odf_existent_name_list = ooo_builder.getNameList()
Nicolas Delaby's avatar
Nicolas Delaby committed
356

357
    # content.xml
358
    self._replaceContentXml(ooo_builder, extra_context)
359
    # styles.xml
360
    self._replaceStylesXml(ooo_builder, extra_context)
361
    # meta.xml is not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
362 363
    # ooo_builder = self._replaceMetaXml(ooo_builder=ooo_builder, extra_context=extra_context)

364 365 366
    # Update the META informations
    ooo_builder.updateManifest()

367
    ooo = ooo_builder.render()
368 369
    return ooo

370
  def _replaceContentXml(self, ooo_builder, extra_context):
371 372 373
    """
    Replace the content.xml in an ODF document using an ERP5Form data.
    """
374
    content_xml = ooo_builder.extract('content.xml')
375 376 377 378
    # mapping ERP5Form to ODF
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)

379
    content_element_tree = etree.XML(content_xml)
380 381
    self._replaceXmlByForm(content_element_tree, form, here, extra_context,
                           ooo_builder)
382
    # mapping ERP5Report report method to ODF
383
    report_method=extra_context.get('report_method')
384 385 386
    base_name = getattr(report_method, '__name__', None)
    self._replaceXmlByReportSection(content_element_tree, extra_context,
                                    report_method, base_name, ooo_builder)
Nicolas Delaby's avatar
Nicolas Delaby committed
387

388
    content_xml = etree.tostring(content_element_tree, encoding='utf-8')
389
    # Replace content.xml in master openoffice template
390
    ooo_builder.replace('content.xml', content_xml)
391 392

  # this method not supported yet
393
  def _replaceStylesXml(self, ooo_builder, extra_context):
394
    """
395
    Replace the styles.xml file in an ODF document.
396
    """
397
    styles_xml = ooo_builder.extract('styles.xml')
398 399
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)
400
    styles_element_tree = etree.XML(styles_xml)
401 402
    self._replaceXmlByForm(styles_element_tree, form, here, extra_context,
                           ooo_builder)
Tatuya Kamada's avatar
Tatuya Kamada committed
403
    styles_xml = etree.tostring(styles_element_tree, encoding='utf-8')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
404

405
    ooo_builder.replace('styles.xml', styles_xml)
406 407

  # this method not implemented yet
408
  def _replaceMetaXml(self, ooo_builder, extra_context):
409
    """
410
    Replace meta.xml file in an ODF document.
411 412 413
    """
    return ooo_builder

414 415
  def _replaceXmlByForm(self, element_tree, form, here, extra_context,
                        ooo_builder, iteration_index=0):
416 417 418 419 420 421 422 423 424 425
    """
    Replace an element_tree object using an ERP5 form.

    Keyword arguments:
    element_tree -- the element_tree of a XML file in an ODF document.
    form -- an ERP5 form
    here -- called context
    extra_context -- extra_context
    ooo_builder -- the OOoBuilder object which have an ODF document.
    iteration_index -- the index which is used when iterating the group of items using ReportSection.
Nicolas Delaby's avatar
Nicolas Delaby committed
426

427
    Need to be overloaded in OD?Strategy Class
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
428
    """
429
    raise NotImplementedError
Nicolas Delaby's avatar
Nicolas Delaby committed
430

431 432
  def _replaceXmlByReportSection(self, element_tree, extra_context, report_method,
                                 base_name, ooo_builder):
433 434 435 436 437
    """
    Replace xml using ERP5Report ReportSection.
    Keyword arguments:
    element_tree -- the element tree object which have an xml document in an ODF document.
    extra_context -- the extra context
Fabien Morin's avatar
Fabien Morin committed
438 439
    report_method -- the report method object which is used in an ReportBox
    base_name -- the name of a ReportBox field which is used to specify the target
440 441
    ooo_builder -- the OOo Builder object which has ODF document.
    """
442
    if report_method is None:
443
      return
444 445
    report_section_list = report_method()
    portal_object = self.getPortalObject()
Tatuya Kamada's avatar
Tatuya Kamada committed
446

447
    target_tuple = self._pickUpTargetSection(base_name=base_name,
448 449 450
                                             report_section_list=report_section_list,
                                             element_tree=element_tree)
    if target_tuple is None:
451
      return
452 453 454 455
    target_xpath, original_target = target_tuple
    office_body = original_target.getparent()
    target_index = office_body.index(original_target)
    temporary_element_tree = deepcopy(original_target)
456
    for (index, report_item) in enumerate(report_section_list):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
457
      report_item.pushReport(portal_object, render_prefix=None)
458 459 460
      here = report_item.getObject(portal_object)
      form_id = report_item.getFormId()
      form = getattr(here, form_id)
Nicolas Delaby's avatar
Nicolas Delaby committed
461

462
      target_element_tree = deepcopy(temporary_element_tree)
463
      # remove original target in the ODF template
464
      if index == 0:
465
        office_body.remove(original_target)
Tatuya Kamada's avatar
Tatuya Kamada committed
466
      else:
467
        self._setUniqueElementName(base_name=base_name,
468
                                   iteration_index=index,
469 470 471
                                   xpath=target_xpath,
                                   element_tree=target_element_tree)

472 473
      self._replaceXmlByForm(target_element_tree, form, here, extra_context,
                             ooo_builder, iteration_index=index)
474 475
      office_body.insert(target_index, target_element_tree)
      target_index += 1
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
476
      report_item.popReport(portal_object, render_prefix=None)
477

478
  def _pickUpTargetSection(self, base_name='', report_section_list=[], element_tree=None):
479
    """pick up a ODF target object to iterate ReportSection
480
    base_name -- the target name to replace in an ODF document
481 482 483
    report_section_list -- ERP5Form ReportSection List which was created by a report method
    element_tree -- XML ElementTree object
    """
484
    frame_xpath = '//draw:frame[@draw:name="%s"]' % base_name
485 486
    frame_list = element_tree.xpath(frame_xpath, namespaces=element_tree.nsmap)
    # <text:section text:style-name="Sect2" text:name="Section2">
487
    section_xpath = '//text:section[@text:name="%s"]' % base_name
488
    section_list = element_tree.xpath(section_xpath, namespaces=element_tree.nsmap)
Nicolas Delaby's avatar
Nicolas Delaby committed
489 490
    if not frame_list and not section_list:
      return
491 492 493 494

    office_body = None
    original_target = None
    target_xpath = ''
Nicolas Delaby's avatar
Nicolas Delaby committed
495
    if frame_list:
496 497 498
      frame = frame_list[0]
      original_target = frame.getparent()
      target_xpath = frame_xpath
Nicolas Delaby's avatar
Nicolas Delaby committed
499
    elif section_list:
500 501 502 503
      original_target = section_list[0]
      target_xpath = section_xpath
    office_body = original_target.getparent()
    # remove if no report section
Nicolas Delaby's avatar
Nicolas Delaby committed
504
    if not report_section_list:
505
      office_body.remove(original_target)
Nicolas Delaby's avatar
Nicolas Delaby committed
506
      return
Nicolas Delaby's avatar
Nicolas Delaby committed
507

508
    return (target_xpath, original_target)
Nicolas Delaby's avatar
Nicolas Delaby committed
509

510 511 512 513 514 515 516 517 518
  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
    """
519
    if iteration_index == 0:
Tatuya Kamada's avatar
Tatuya Kamada committed
520
      return
521
    def getNameAttribute(target_element):
522 523 524 525 526 527 528
      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)
529
    if not result_list:
530 531 532
      return
    target_element = result_list[0]
    name_attribute = getNameAttribute(target_element)
Nicolas Delaby's avatar
Nicolas Delaby committed
533
    if name_attribute:
534
      target_element.set(name_attribute, odf_element_name)
Nicolas Delaby's avatar
Nicolas Delaby committed
535

536 537
  def _replaceXmlByFormbox(self, element_tree, field, form, extra_context,
                           ooo_builder, iteration_index=0):
538 539
    """
    Replace an ODF frame using an ERP5Form form box field.
540

541
    Note: This method is incompleted yet. This function is intended to
Fabien Morin's avatar
Fabien Morin committed
542
    make an frame hide/show. But it has not such a feature currently.
543
    """
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
544 545
    field_id = field.id
    enabled = field.get_value('enabled')
546
    draw_xpath = '//draw:frame[@draw:name="%s"]/draw:text-box/*' % field_id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
547
    text_list = element_tree.xpath(draw_xpath, namespaces=element_tree.nsmap)
548 549
    if not text_list:
      return
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
550 551 552 553 554
    target_element = text_list[0]
    frame_paragraph = target_element.getparent()
    office_body = frame_paragraph.getparent()
    if not enabled:
      office_body.remove(frame_paragraph)
555
      return
556
    # set when using report section
557 558 559 560 561
    self._setUniqueElementName(field_id, iteration_index, draw_xpath, element_tree)
    self._replaceXmlByForm(frame_paragraph, form, extra_context['here'], extra_context,
                           ooo_builder, iteration_index=iteration_index)

  def _replaceXmlByImageField(self, element_tree, image_field, ooo_builder, iteration_index=0):
562 563 564
    """
    Replace an ODF draw:frame using an ERP5Form image field.
    """
565 566
    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
567
    image_list = element_tree.xpath(image_xpath, namespaces=element_tree.nsmap)
568 569
    if not image_list:
      return
Tatuya Kamada's avatar
Tatuya Kamada committed
570
    path = image_field.get_value('default')
571 572
    image_node = image_list[0]
    image_frame = image_node.getparent()
Tatuya Kamada's avatar
Tatuya Kamada committed
573 574
    if path is not None:
      path = path.encode()
Tatuya Kamada's avatar
Tatuya Kamada committed
575
    picture = self.getPortalObject().restrictedTraverse(path)
Tatuya Kamada's avatar
Tatuya Kamada committed
576
    picture_data = getattr(aq_base(picture), 'data', None)
577 578 579
    if picture_data is None:
      image_frame = image_node.getparent()
      image_frame.remove(image_node)
580
      return
Tatuya Kamada's avatar
Tatuya Kamada committed
581 582 583
    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)
584 585 586 587
    width, height = self._getPictureSize(picture, image_frame)
    image_node.set('{%s}href' % XLINK_URI, picture_path)
    image_frame.set('{%s}width' % SVG_URI, str(width))
    image_frame.set('{%s}height' % SVG_URI, str(height))
588
    # set when using report section
589
    self._setUniqueElementName(image_field.id, iteration_index, image_xpath, element_tree)
590

Tatuya Kamada's avatar
Tatuya Kamada committed
591 592
  def _createOdfUniqueFileName(self, path='', picture_type=''):
    extension = guess_extension(picture_type)
593 594 595
    # here, it's needed to use quote_plus to escape '/' caracters to make valid
    # paths in the odf archive.
    picture_path = 'Pictures/%s%s' % (quote_plus(path), extension)
Tatuya Kamada's avatar
Tatuya Kamada committed
596 597 598 599
    if picture_path not in self.odf_existent_name_list:
      return picture_path
    number = 0
    while True:
600
      picture_path = 'Pictures/%s_%s%s' % (quote_plus(path), number, extension)
Tatuya Kamada's avatar
Tatuya Kamada committed
601 602 603 604
      if picture_path not in self.odf_existent_name_list:
        return picture_path
      number += 1

605 606 607 608
  # XXX this method should not be used anymore. This should be made by the
  # render_od*
  def _getPictureSize(self, picture=None, draw_frame_node=None):
    if picture is None or draw_frame_node is None:
Tatuya Kamada's avatar
Tatuya Kamada committed
609
      return ('0cm', '0cm')
610 611
    svg_width = draw_frame_node.attrib.get('{%s}width' % SVG_URI)
    svg_height = draw_frame_node.attrib.get('{%s}height' % SVG_URI)
Tatuya Kamada's avatar
Tatuya Kamada committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
    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
632 633 634 635 636 637
    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
638
    return (str(w) + unit, str(h) + unit)
Nicolas Delaby's avatar
Nicolas Delaby committed
639 640


641
  def _appendTableByListbox(self, element_tree, listbox, REQUEST, iteration_index=0):
642 643 644
    """
    Append a ODF table using an ERP5 Form listbox.
    """
645 646 647
    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
648
    target_table_list = element_tree.xpath(table_xpath, namespaces=element_tree.nsmap)
649
    if not target_table_list:
650
      return element_tree
651 652 653

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

655 656
    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
657
    table_header_rows_list = newtable.xpath(table_header_rows_xpath,  namespaces=element_tree.nsmap)
Nicolas Delaby's avatar
Nicolas Delaby committed
658
    table_row_list = newtable.xpath(table_row_xpath, namespaces=element_tree.nsmap)
659 660 661

    # copy row styles from ODF Document
    has_header_rows = len(table_header_rows_list) > 0
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
662 663
    (row_top, row_middle, row_bottom) = self._copyRowStyle(table_row_list,
                                                           has_header_rows=has_header_rows)
664 665
    # create style-name and table-row dictionary if a reference name is set
    style_name_row_dictionary = self._createStyleNameRowDictionary(table_row_list)
Fabien Morin's avatar
Fabien Morin committed
666
    # clear original table
667
    parent_paragraph = target_table.getparent()
Fabien Morin's avatar
Fabien Morin committed
668
    # clear rows
Nicolas Delaby's avatar
Nicolas Delaby committed
669
    [newtable.remove(table_row) for table_row in table_row_list]
670 671 672

    listboxline_list = listbox.get_value('default',
                                         render_format='list',
Fabien Morin's avatar
Fabien Morin committed
673
                                         REQUEST=REQUEST,
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
674
                                         render_prefix=None)
675 676
    # if ODF table has header rows, does not update the header rows
    # if does not have header rows, insert the listbox title line
677
    is_top = True
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
678
    last_index = len(listboxline_list) - 1
679 680
    for (index, listboxline) in enumerate(listboxline_list):
      listbox_column_list = listboxline.getColumnItemList()
681
      row_style_name = listboxline.getRowCSSClassName()
682 683
      if listboxline.isTitleLine() and not has_header_rows:
        row = deepcopy(row_top)
Nicolas Delaby's avatar
Nicolas Delaby committed
684
        self._updateColumnValue(row, listbox_column_list)
685
        newtable.append(row)
686
        is_top = False
687
      elif listboxline.isDataLine() and is_top:
Nicolas Delaby's avatar
Nicolas Delaby committed
688 689
        row = deepcopy(style_name_row_dictionary.get(row_style_name, row_top))
        self._updateColumnValue(row, listbox_column_list)
690 691
        newtable.append(row)
        is_top = False
Tatuya Kamada's avatar
Tatuya Kamada committed
692
      elif listboxline.isStatLine() or (index is last_index and listboxline.isDataLine()):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
693
        row = deepcopy(row_bottom)
Nicolas Delaby's avatar
Nicolas Delaby committed
694
        self._updateColumnStatValue(row, listbox_column_list, row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
695
        newtable.append(row)
696
      elif index > 0 and listboxline.isDataLine():
Nicolas Delaby's avatar
Nicolas Delaby committed
697 698
        row = deepcopy(style_name_row_dictionary.get(row_style_name, row_middle))
        self._updateColumnValue(row, listbox_column_list)
699 700
        newtable.append(row)

701
    self._setUniqueElementName(table_id, iteration_index, table_xpath, newtable)
Nicolas Delaby's avatar
Nicolas Delaby committed
702
    parent_paragraph.replace(target_table, newtable)
Nicolas Delaby's avatar
Nicolas Delaby committed
703

704
  def _copyRowStyle(self, table_row_list=None, has_header_rows=False):
705 706 707
    """
    Copy ODF table row styles.
    """
708 709
    if table_row_list is None:
      table_row_list = []
710 711
    def removeOfficeAttribute(row):
      if row is None or has_header_rows: return
712
      odf_cell_list = row.findall("{%s}table-cell" % TABLE_URI)
713 714
      for odf_cell in odf_cell_list:
        self._removeColumnValue(odf_cell)
Nicolas Delaby's avatar
Nicolas Delaby committed
715

716 717 718
    row_top = None
    row_middle = None
    row_bottom = None
Nicolas Delaby's avatar
Nicolas Delaby committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
    len_table_row_list = len(table_row_list)
    if len_table_row_list == 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 == 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 == 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])
736

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

741

Nicolas Delaby's avatar
Nicolas Delaby committed
742
  def _createStyleNameRowDictionary(self, table_row_list):
743 744 745
    """create stylename and table row dictionary if a style name reference is set"""
    style_name_row_dictionary = {}
    for table_row in table_row_list:
Nicolas Delaby's avatar
Nicolas Delaby committed
746
      reference_element = table_row.find('.//*[@%s]' % self._name_attribute_name)
747
      if reference_element is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
748
        name = reference_element.attrib[self._name_attribute_name]
749 750
        style_name_row_dictionary[name] = deepcopy(table_row)
    return style_name_row_dictionary
Nicolas Delaby's avatar
Nicolas Delaby committed
751

Nicolas Delaby's avatar
Nicolas Delaby committed
752
  def _updateColumnValue(self, row, listbox_column_list):
753
    odf_cell_list = row.findall("{%s}table-cell" % TABLE_URI)
754 755 756 757 758 759
    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
760
      self._setColumnValue(column, value)
761

Nicolas Delaby's avatar
Nicolas Delaby committed
762
  def _updateColumnStatValue(self, row, listbox_column_list, row_middle):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
763
    """stat line is capable of column span setting"""
764
    if row_middle is None:
Nicolas Delaby's avatar
Nicolas Delaby committed
765
      return
766
    odf_cell_list = row.findall("{%s}table-cell" % TABLE_URI)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
767
    odf_column_span_list = self._getOdfColumnSpanList(row_middle)
768 769 770 771 772 773
    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
774 775 776 777 778
      self._setColumnValue(column, value)
      column_span = self._getColumnSpanSize(column)
      listbox_column_index = self._nextListboxColumnIndex(column_span,
                                                          listbox_column_index,
                                                          odf_column_span_list)
779

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
780 781
  def _setColumnValue(self, column, value):
    self._clearColumnValue(column)
782
    if value is None:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
783
      self._removeColumnValue(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
784
    column_value, table_content = self._translateValueIntoColumnContent(value, column)
Nicolas Delaby's avatar
Nicolas Delaby committed
785
    [column.remove(child) for child in column]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
786 787 788 789 790 791 792 793 794
    if table_content is not None:
      column.append(table_content)
    value_attribute = self._getColumnValueAttribute(column)
    if value_attribute is not None and column_value is not None:
       column.set(value_attribute, column_value)

  def _translateValueIntoColumnContent(self, value, column):
    """translate a value as a table content"""
    table_content = None
Nicolas Delaby's avatar
Nicolas Delaby committed
795 796
    if len(column):
      table_content = deepcopy(column[0])
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
797 798 799 800 801
    # create a tempolaly etree object to generate a content paragraph
    fragment = self._valueAsOdfXmlElement(value=value, element_tree=column)
    column_value = None
    if table_content is not None:
      table_content.text = fragment.text
Nicolas Delaby's avatar
Nicolas Delaby committed
802
      for element in fragment:
Nicolas Delaby's avatar
Nicolas Delaby committed
803 804
        table_content.append(element)
      column_value = " ".join(table_content.itertext())
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
805 806 807 808
    return (column_value, table_content)

  def _valueAsOdfXmlElement(self, value=None, element_tree=None):
    """values as ODF XML element
Nicolas Delaby's avatar
Nicolas Delaby committed
809

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
810 811 812 813 814 815 816 817 818 819 820
    replacing:
      \t -> tabs
      \n -> line-breaks
      DateTime -> Y-m-d
    """
    if value is None:
      value = ''
    translated_value = str(value)
    if isinstance(value, DateTime):
      translated_value = value.strftime('%Y-%m-%d')
    translated_value = escape(translated_value)
821 822
    tab_element_str = '<text:tab xmlns:text="%s"/>' % TEXT_URI
    line_break_element_str ='<text:line-break xmlns:text="%s"/>' % TEXT_URI
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
823 824 825 826 827 828
    translated_value = translated_value.replace('\t', tab_element_str)
    translated_value = translated_value.replace('\r', '')
    translated_value = translated_value.replace('\n', line_break_element_str)
    translated_value = unicode(str(translated_value),'utf-8')
    # create a paragraph
    template = '<text:p xmlns:text="%s">%s</text:p>'
829
    fragment_element_tree = etree.XML(template % (TEXT_URI, translated_value))
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
830
    return fragment_element_tree
Nicolas Delaby's avatar
Nicolas Delaby committed
831

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
832
  def _removeColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
833 834 835 836 837
    # 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():
838
      if 'office' in column.nsmap and key.startswith("{%s}" % column.nsmap['office']):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
839
        del attrib[key]
Nicolas Delaby's avatar
Nicolas Delaby committed
840 841
    column.text = None
    [column.remove(child) for child in column]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
842

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
843
  def _clearColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
844 845
    attrib = column.attrib
    for key in attrib.keys():
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
846
      value_attribute = self._getColumnValueAttribute(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
847 848
      if value_attribute is not None:
        column.set(value_attribute, '')
Nicolas Delaby's avatar
Nicolas Delaby committed
849 850
    column.text = None
    for child in column:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
851
      # clear data except style
Nicolas Delaby's avatar
Nicolas Delaby committed
852
      style_value = child.attrib.get(self._style_attribute_name)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
853
      child.clear()
Nicolas Delaby's avatar
Nicolas Delaby committed
854
      if style_value:
Nicolas Delaby's avatar
Nicolas Delaby committed
855
        child.set(self._style_attribute_name, style_value)
Nicolas Delaby's avatar
Nicolas Delaby committed
856

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
857
  def _getColumnValueAttribute(self, column):
858 859 860 861 862
    attrib = column.attrib
    for key in attrib.keys():
      if key.endswith("value"):
        return key
    return None
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
863 864

  def _getColumnSpanSize(self, column=None):
865
    span_attribute = "{%s}number-columns-spanned" % TABLE_URI
Nicolas Delaby's avatar
Nicolas Delaby committed
866
    return int(column.attrib.get(span_attribute, 1))
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
867 868

  def _nextListboxColumnIndex(self, span=0, current_index=0, column_span_list=[]):
869 870 871 872 873 874 875
    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
876 877

  def _getOdfColumnSpanList(self, row_middle=None):
878 879
    if row_middle is None:
      return []
880
    odf_cell_list = row_middle.findall("{%s}table-cell" % TABLE_URI)
881 882
    column_span_list = []
    for column in odf_cell_list:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
883
      column_span = self._getColumnSpanSize(column)
884 885 886
      column_span_list.append(column_span)
    return column_span_list

Tatuya Kamada's avatar
Tatuya Kamada committed
887 888
  def _toUnicodeString(self, field_value = None):
    value = ''
Tatuya Kamada's avatar
Tatuya Kamada committed
889 890 891
    if isinstance(field_value, unicode):
      value = field_value
    elif field_value is not None:
Tatuya Kamada's avatar
Tatuya Kamada committed
892 893 894
      value = unicode(str(field_value), 'utf-8')
    return value

895 896
class ODTStrategy(ODFStrategy):
  """ODTStrategy create a ODT Document from a form and a ODT template"""
Nicolas Delaby's avatar
Nicolas Delaby committed
897 898

  _style_attribute_name = '{urn:oasis:names:tc:opendocument:xmlns:text:1.0}style-name'
Nicolas Delaby's avatar
Nicolas Delaby committed
899
  _name_attribute_name = '{urn:oasis:names:tc:opendocument:xmlns:text:1.0}name'
Nicolas Delaby's avatar
Nicolas Delaby committed
900

901 902
  def _replaceXmlByForm(self, element_tree, form, here, extra_context,
                        ooo_builder, iteration_index=0):
903 904 905 906 907 908 909 910 911 912 913
    """
    Replace an element_tree object using an ERP5 form.

    Keyword arguments:
    element_tree -- the element_tree of a XML file in an ODF document.
    form -- an ERP5 form
    here -- called context
    extra_context -- extra_context
    ooo_builder -- the OOoBuilder object which have an ODF document.
    iteration_index -- the index which is used when iterating the group of items using ReportSection.
    """
Nicolas Delaby's avatar
Nicolas Delaby committed
914
    field_list = form.get_fields()
915
    REQUEST = here.REQUEST
916 917
    for (count, field) in enumerate(field_list):
      if isinstance(field, ListBox):
918 919
        self._appendTableByListbox(element_tree, field, REQUEST,
                                   iteration_index=iteration_index)
920 921 922 923
      elif isinstance(field, FormBox):
        if not hasattr(here, field.get_value('formbox_target_id')):
          continue
        sub_form = getattr(here, field.get_value('formbox_target_id'))
924 925
        content = self._replaceXmlByFormbox(element_tree, field, sub_form,
                                            extra_context, ooo_builder,
926 927 928
                                            iteration_index=iteration_index)
      elif isinstance(field, ReportBox):
         report_method = getattr(field, field.get_value('report_method'), None)
929 930
         self._replaceXmlByReportSection(element_tree, extra_context,
                                         report_method, field.id, ooo_builder)
931
      elif isinstance(field, ImageField):
932 933
        self._replaceXmlByImageField(element_tree, field,
                                     ooo_builder, iteration_index=iteration_index)
934
      else:
935
        self._replaceNodeViaReference(element_tree, field)
936

937
  def _replaceNodeViaReference(self, element_tree, field):
938
    """replace nodes (e.g. paragraphs) via ODF reference"""
939 940
    self._replaceNodeViaRangeReference(element_tree, field)
    self._replaceNodeViaPointReference(element_tree, field)
941
    self._replaceNodeViaFormName(element_tree, field)
942
    self._replaceNodeViaVariable(element_tree, field)
943

944
  def _replaceNodeViaPointReference(self, element_tree, field, iteration_index=0):
945 946 947 948 949 950 951 952
    """Replace text node via an ODF point reference.

    point reference example:
     <text:reference-mark text:name="invoice-date"/>
    """
    field_id = field.id
    reference_xpath = '//text:reference-mark[@text:name="%s"]' % field_id
    reference_list = element_tree.xpath(reference_xpath, namespaces=element_tree.nsmap)
Nicolas Delaby's avatar
Nicolas Delaby committed
953 954 955 956 957 958
    for target_node in reference_list:
      node_to_replace = target_node.xpath('ancestor::text:p[1]', namespaces=element_tree.nsmap)[0]
      attr_dict = {}
      style_value = node_to_replace.attrib.get(self._style_attribute_name)
      if style_value:
        attr_dict.update({self._style_attribute_name: style_value})
959
      new_node = field.render_odt(as_string=False, attr_dict=attr_dict)
Nicolas Delaby's avatar
Nicolas Delaby committed
960
      node_to_replace.getparent().replace(node_to_replace, new_node)
961 962 963 964 965 966
    # set when using report section
    self._setUniqueElementName(base_name=field.id,
                               iteration_index=iteration_index,
                               xpath=reference_xpath,
                               element_tree=element_tree)

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
  def _replaceNodeViaVariable(self, element_tree, field, iteration_index=0):
    """Replace text node via an ODF variable name.
    <text:variable-set text:name="my_title" 
                    office:value-type="string">Title</text:variable-set>
    """
    field_id = field.id
    reference_xpath = '//text:variable-set[@text:name="%s"]' % field_id
    node_list = element_tree.xpath(reference_xpath,
                                   namespaces=element_tree.nsmap)
    for target_node in node_list:
      attr_dict = {}
      style_attribute_id = '{%s}data-style-name' % STYLE_URI
      style_value = target_node.attrib.get(style_attribute_id)
      if style_value:
        attr_dict.update({style_attribute_id: style_value})
982 983 984 985
      display_attribute_id = '{%s}display' % TEXT_URI
      display_value = target_node.attrib.get(display_attribute_id)
      if display_value:
        attr_dict.update({display_attribute_id: display_value})
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
      formula_attribute_id = '{%s}formula' % TEXT_URI
      formula_value = target_node.attrib.get(formula_attribute_id)
      if formula_value:
        attr_dict.update({formula_attribute_id: formula_value})
      name_attribute_id = '{%s}name' % TEXT_URI
      attr_dict[name_attribute_id] = target_node.get(name_attribute_id)
      value_type_attribute_id = '{%s}value-type' % OFFICE_URI
      attr_dict[value_type_attribute_id] = target_node.get(
                                                       value_type_attribute_id)
      new_node = field.render_odt_variable(as_string=False,
                                           attr_dict=attr_dict)
      target_node.getparent().replace(target_node, new_node)
    # set when using report section
    self._setUniqueElementName(base_name=field_id,
                               iteration_index=iteration_index,
                               xpath=reference_xpath,
                               element_tree=element_tree)

1004
  def _replaceNodeViaRangeReference(self, element_tree, field, iteration_index=0):
1005 1006 1007 1008 1009
    """Replace text node via an ODF ranged reference.

    range reference example:
    <text:reference-mark-start text:name="week"/>Monday<text:reference-mark-end text:name="week"/>
    or
Nicolas Delaby's avatar
Nicolas Delaby committed
1010 1011
    <text:reference-mark-start text:name="my_title"/>
      <text:span text:style-name="T1">title</text:span>
1012 1013 1014
    <text:reference-mark-end text:name="my_title"/>

    """
Nicolas Delaby's avatar
Nicolas Delaby committed
1015
    field_id = field.id
1016 1017
    range_reference_xpath = '//text:reference-mark-start[@text:name="%s"]' % (field_id,)
    node_to_remove_list_xpath = '//text:reference-mark-start[@text:name="%s"]/'\
Nicolas Delaby's avatar
Nicolas Delaby committed
1018 1019
                            'following-sibling::*[node()/'\
                            'following::text:reference-mark-end[@text:name="%s"]]' % (field_id, field_id)
1020
    node_to_remove_list = element_tree.xpath(node_to_remove_list_xpath, namespaces=element_tree.nsmap)
1021
    reference_list = element_tree.xpath(range_reference_xpath, namespaces=element_tree.nsmap)
Nicolas Delaby's avatar
Nicolas Delaby committed
1022
    if not reference_list:
1023
      return element_tree
1024
    referenced_node = reference_list[0]
1025
    referenced_node.tail = None
1026
    parent_node = referenced_node.getparent()
1027
    text_reference_position = parent_node.index(referenced_node)
Nicolas Delaby's avatar
Nicolas Delaby committed
1028 1029 1030 1031

    #Delete all contents between <text:reference-mark-start/> and <text:reference-mark-end/>
    #Try to fetch style-name
    attr_dict = {}
1032
    [(attr_dict.update(target_node.attrib), parent_node.remove(target_node)) for target_node in node_to_remove_list]
1033 1034
    new_node = field.render_odt(local_name='span', attr_dict=attr_dict,
                                as_string=False)
Nicolas Delaby's avatar
Nicolas Delaby committed
1035
    parent_node.insert(text_reference_position+1, new_node)
1036 1037 1038 1039 1040
    # set when using report section
    self._setUniqueElementName(base_name=field.id,
                               iteration_index=iteration_index,
                               xpath=range_reference_xpath,
                               element_tree=element_tree)
1041

1042 1043 1044 1045 1046 1047
  def _replaceNodeViaFormName(self, element_tree, field, iteration_index=0):
    """
    Used to replace field in ODT document like checkboxes
    """
    field_id = field.id
    reference_xpath = '//*[@form:name = "%s"]' % field_id
1048 1049 1050 1051
    # if form name space is not in the name space dict of element tree,
    # it means that there is no form in the tree. Then do nothing and return.
    if not 'form' in element_tree.nsmap:
      return
1052 1053 1054 1055
    reference_list = element_tree.xpath(reference_xpath, namespaces=element_tree.nsmap)
    for target_node in reference_list:
      attr_dict = {}
      attr_dict.update(target_node.attrib)
1056
      new_node = field.render_odt(as_string=False, attr_dict=attr_dict)
1057 1058
      target_node.getparent().replace(target_node, new_node)

1059 1060 1061
class ODGStrategy(ODFStrategy):
  """ODGStrategy create a ODG Document from a form and a ODG template"""

1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
  def _recursiveGetAttributeDict(self, node, attr_dict):
    '''return a dictionnary corresponding with node attributes. Tag as key
       and a list corresponding to the atributes values by apparence order.
       Example, for a listbox, you will have something like :
       { tabe.tag: [table.attrib,],
         row.tag: [row.attrib,
                   row.attrib],
         cell.tag: [cell.attrib,
                    cell.attrib,
                    cell.attrib,
                    cell.attrib,
                    cell.attrib,
                    cell.attrib,],

    '''
    attr_dict.setdefault(node.tag, []).append(dict(node.attrib))
    for child in node:
      self._recursiveGetAttributeDict(child, attr_dict)

  def _recursiveApplyAttributeDict(self, node, attr_dict):
    '''recursively apply given attributes to node
    '''
    image_tag_name = '{%s}%s' % (DRAW_URI, 'image')
    if len(attr_dict[node.tag]):
      attribute_to_update_dict = attr_dict[node.tag].pop(0)
      # in case of images, we don't want to update image path
      # because they were calculated by render_odg
      if node.tag != image_tag_name:
        node.attrib.update(attribute_to_update_dict)
    for child in node:
      self._recursiveApplyAttributeDict(child, attr_dict)

Fabien Morin's avatar
Fabien Morin committed
1094 1095
  def _replaceXmlByForm(self, element_tree, form, here, extra_context,
                        ooo_builder, iteration_index=0):
Nicolas Delaby's avatar
Nicolas Delaby committed
1096
    field_list = form.get_fields()
1097
    for (count, field) in enumerate(field_list):
1098
      text_xpath = '//draw:frame[@draw:name="%s"]' % field.id
1099
      node_list = element_tree.xpath(text_xpath, namespaces=element_tree.nsmap)
1100
      value = field.get_value('default')
1101 1102
      if isinstance(value, str):
        value = value.decode('utf-8')
Fabien Morin's avatar
Fabien Morin committed
1103
      for target_node in node_list:
1104
        # render the field in odg xml node format
1105 1106 1107 1108 1109
        attr_dict = {}
        self._recursiveGetAttributeDict(target_node, attr_dict)
        new_node = field.render_odg(value=value, as_string=False, ooo_builder=ooo_builder,
            REQUEST=self.REQUEST, attr_dict=attr_dict)

1110
        if new_node is not None:
1111
          # replace the target node by the generated node
1112 1113 1114 1115
          target_node.getparent().replace(target_node, new_node)
        else:
          # if the render return None, remove the node
          target_node.getparent().remove(target_node)