FormPrintout.py 43.7 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, get_request
40 41
from AccessControl import ClassSecurityInfo
from AccessControl.Role import RoleManager
42
from OFS.SimpleItem import Item
Tatuya Kamada's avatar
Tatuya Kamada committed
43
from urllib import quote, quote_plus
44 45
from copy import deepcopy
from lxml import etree
Nicolas Delaby's avatar
Nicolas Delaby committed
46
from lxml.etree import _Element, _ElementStringResult
47 48
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 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
  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
class FormPrintout(Implicit, Persistent, RoleManager, Item):
  """Form Printout

98 99 100
  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. 
101 102

  WARNING: The Form Printout currently supports only ODT format document.
Tatuya Kamada's avatar
Tatuya Kamada committed
103 104

  The functions status:
105
  
Tatuya Kamada's avatar
Tatuya Kamada committed
106 107
  Fields -> Paragraphs:      supported
  ListBox -> Table:          supported
108 109
  Report Section
      -> Frames or Sections: supported
Tatuya Kamada's avatar
Tatuya Kamada committed
110 111 112 113
  FormBox -> Frame:          experimentally supported
  ImageField -> Photo:       supported
  styles.xml:                supported
  meta.xml:                  not supported yet
114 115 116
  """
  
  meta_type = "ERP5 Form Printout"
117
  icon = "www/form_printout_icon.png"
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

  # 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)
Nicolas Delaby's avatar
Nicolas Delaby 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
Nicolas Delaby's avatar
Nicolas Delaby committed
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
  def index_html(self, icon=0, preview=0, width=None, height=None, REQUEST=None):
    """Render and view a printout document."""
Nicolas Delaby's avatar
Nicolas Delaby committed
164

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    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)
189 190 191 192
    return self._oooConvertByFormat(printout,
                                    content_type=content_type, 
                                    extra_context=extra_context,
                                    REQUEST=REQUEST)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
193

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
194 195
  security.declareProtected('View', '__call__')
  __call__ = index_html
Nicolas Delaby's avatar
Nicolas Delaby committed
196

197 198 199 200 201 202 203 204 205 206 207 208 209 210
  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
211
  def _createStrategy(slef, content_type=''):
212 213
    if guess_extension(content_type) == '.odt':
      return ODTStrategy()
214 215 216
    if guess_extension(content_type) == '.odg':
      return ODGStrategy()
    raise ValueError, 'Template type: %s is not supported' % content_type
217

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  def _oooConvertByFormat(self, printout, content_type=None, extra_context={}, REQUEST=None):
    """
    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
    """
    options = extra_context.get('options', {})
    format = None
    if REQUEST is not None:
      format = options.get('format', REQUEST.get('format', None))
    if format is None:
      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)))
      return printout
    from Products.ERP5Type.Document import newTempOOoDocument
    tmp_ooo = newTempOOoDocument(self, self.title_or_id())
    tmp_ooo.edit(base_data=printout,
                 fname=self.title_or_id(),
                 source_reference=self.title_or_id(),
                 base_content_type=content_type)
    tmp_ooo.oo_data = printout
    mime, data = tmp_ooo.convert(format)
    if REQUEST is not None:
      REQUEST.RESPONSE.setHeader('Content-type', mime)
      REQUEST.RESPONSE.setHeader('Content-disposition',
          'attachment;filename="%s.%s"' % (self.title_or_id(), format))
    return data

252 253 254 255
InitializeClass(FormPrintout)

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

Tatuya Kamada's avatar
Tatuya Kamada committed
257
  odf_existent_name_list = []
Nicolas Delaby's avatar
Nicolas Delaby committed
258

259
  def render(self, extra_context={}):
260
    """Render a odf document, form as a content, template as a template.
261 262

    Keyword arguments:
263
    extra_context -- a dictionary, expected:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
264 265 266 267
      '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
268 269 270 271 272 273 274 275 276
    """
    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
277

278
    # First, render the Template if it has a pt_render method
279 280 281 282
    ooo_document = None
    if hasattr(odf_template, 'pt_render'):
      ooo_document = odf_template.pt_render(here, extra_context=extra_context)
    else:
283
      # File object can be a template
284 285 286 287
      ooo_document = odf_template 

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

290
    # content.xml
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
291
    ooo_builder = self._replaceContentXml(ooo_builder=ooo_builder, extra_context=extra_context)
292
    # styles.xml
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
293
    ooo_builder = self._replaceStylesXml(ooo_builder=ooo_builder, extra_context=extra_context)
294
    # meta.xml is not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
295 296
    # ooo_builder = self._replaceMetaXml(ooo_builder=ooo_builder, extra_context=extra_context)

297 298 299 300 301 302
    # 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
303
  def _replaceContentXml(self, ooo_builder=None, extra_context=None):
304 305 306
    """
    Replace the content.xml in an ODF document using an ERP5Form data.
    """
307
    content_xml = ooo_builder.extract('content.xml')
308 309 310 311
    # mapping ERP5Form to ODF
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)

312
    content_element_tree = etree.XML(content_xml)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
313 314 315
    content_element_tree = self._replaceXmlByForm(element_tree=content_element_tree,
                                                  form=form,
                                                  here=here,
Tatuya Kamada's avatar
Tatuya Kamada committed
316 317
                                                  extra_context=extra_context,
                                                  ooo_builder=ooo_builder)
318
    # mapping ERP5Report report method to ODF
319 320
    report_method=extra_context.get('report_method')
    base_name = (report_method is not None) and report_method.__name__ or None 
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
321
    content_element_tree = self._replaceXmlByReportSection(element_tree=content_element_tree,
Tatuya Kamada's avatar
Tatuya Kamada committed
322
                                                           extra_context=extra_context,
323 324
                                                           report_method=report_method,
                                                           base_name=base_name,
Tatuya Kamada's avatar
Tatuya Kamada committed
325
                                                           ooo_builder=ooo_builder)
Tatuya Kamada's avatar
Tatuya Kamada committed
326
    content_xml = etree.tostring(content_element_tree, encoding='utf-8')
Nicolas Delaby's avatar
Nicolas Delaby committed
327

328
    # Replace content.xml in master openoffice template
329
    ooo_builder.replace('content.xml', content_xml)
330 331 332
    return ooo_builder

  # this method not supported yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
333
  def _replaceStylesXml(self, ooo_builder=None, extra_context=None):
334
    """
335
    Replace the styles.xml file in an ODF document.
336
    """
337
    styles_xml = ooo_builder.extract('styles.xml')
338 339
    form = extra_context['form']
    here = getattr(self, 'aq_parent', None)
340
    styles_element_tree = etree.XML(styles_xml)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
341 342 343
    styles_element_tree = self._replaceXmlByForm(element_tree=styles_element_tree,
                                                 form=form,
                                                 here=here,
Tatuya Kamada's avatar
Tatuya Kamada committed
344 345
                                                 extra_context=extra_context,
                                                 ooo_builder=ooo_builder)
Tatuya Kamada's avatar
Tatuya Kamada committed
346
    styles_xml = etree.tostring(styles_element_tree, encoding='utf-8')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
347

348
    ooo_builder.replace('styles.xml', styles_xml)
349 350 351
    return ooo_builder

  # this method not implemented yet
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
352
  def _replaceMetaXml(self, ooo_builder=None, extra_context=None):
353
    """
354
    Replace meta.xml file in an ODF document.
355 356 357
    """
    return ooo_builder

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
358
  def _replaceXmlByForm(self, element_tree=None, form=None, here=None,
359
                           extra_context=None, ooo_builder=None, iteration_index=0):
360 361 362 363 364 365 366 367 368 369
    """
    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
370

371
    Need to be overloaded in OD?Strategy Class
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
372
    """
373
    raise NotImplementedError
Nicolas Delaby's avatar
Nicolas Delaby committed
374

375 376 377
  def _replaceXmlByReportSection(self, element_tree=None, extra_context=None, 
                                 report_method=None, base_name=None, 
                                 ooo_builder=None):
378 379 380 381 382 383 384 385 386
    """
    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
    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 
    ooo_builder -- the OOo Builder object which has ODF document.
    """
387
    if report_method is None:
388
      return element_tree
389 390
    report_section_list = report_method()
    portal_object = self.getPortalObject()
Tatuya Kamada's avatar
Tatuya Kamada committed
391

392
    target_tuple = self._pickUpTargetSection(base_name=base_name,
393 394 395
                                             report_section_list=report_section_list,
                                             element_tree=element_tree)
    if target_tuple is None:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
396
      return element_tree
397 398 399 400
    target_xpath, original_target = target_tuple
    office_body = original_target.getparent()
    target_index = office_body.index(original_target)
    temporary_element_tree = deepcopy(original_target)
401
    for (index, report_item) in enumerate(report_section_list):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
402
      report_item.pushReport(portal_object, render_prefix=None)
403 404 405
      here = report_item.getObject(portal_object)
      form_id = report_item.getFormId()
      form = getattr(here, form_id)
Nicolas Delaby's avatar
Nicolas Delaby committed
406

407 408
      target_element_tree = deepcopy(temporary_element_tree)
      # remove original target in the ODF template 
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
409
      if index is 0:
410
        office_body.remove(original_target)
Tatuya Kamada's avatar
Tatuya Kamada committed
411
      else:
412
        self._setUniqueElementName(base_name=base_name,
413
                                   iteration_index=index,
414 415 416 417 418 419 420 421 422 423 424
                                   xpath=target_xpath,
                                   element_tree=target_element_tree)

      target_element_tree = self._replaceXmlByForm(element_tree=target_element_tree,
                                                   form=form,
                                                   here=here,
                                                   extra_context=extra_context,
                                                   ooo_builder=ooo_builder,
                                                   iteration_index=index)
      office_body.insert(target_index, target_element_tree)
      target_index += 1
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
425
      report_item.popReport(portal_object, render_prefix=None)
426 427
    return element_tree

428
  def _pickUpTargetSection(self, base_name='', report_section_list=[], element_tree=None):
429
    """pick up a ODF target object to iterate ReportSection
430
    base_name -- the target name to replace in an ODF document
431 432 433
    report_section_list -- ERP5Form ReportSection List which was created by a report method
    element_tree -- XML ElementTree object
    """
434
    frame_xpath = '//draw:frame[@draw:name="%s"]' % base_name
435 436
    frame_list = element_tree.xpath(frame_xpath, namespaces=element_tree.nsmap)
    # <text:section text:style-name="Sect2" text:name="Section2">
437
    section_xpath = '//text:section[@text:name="%s"]' % base_name
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
    section_list = element_tree.xpath(section_xpath, namespaces=element_tree.nsmap)
    if len(frame_list) is 0 and len(section_list) is 0:
      return None

    office_body = None
    original_target = None
    target_xpath = ''
    if len(frame_list) > 0:
      frame = frame_list[0]
      original_target = frame.getparent()
      target_xpath = frame_xpath
    elif len(section_list) > 0:
      original_target = section_list[0]
      target_xpath = section_xpath
    office_body = original_target.getparent()
    # remove if no report section
    if len(report_section_list) is 0:
      office_body.remove(original_target)
      return None  
Nicolas Delaby's avatar
Nicolas Delaby committed
457

458
    return (target_xpath, original_target)
Nicolas Delaby's avatar
Nicolas Delaby committed
459

460 461 462 463 464 465 466 467 468 469
  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
470
      return
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
    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)
Nicolas Delaby's avatar
Nicolas Delaby committed
487

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
488 489 490 491 492
  def _replaceXmlByFormbox(self,
                           element_tree=None,
                           field=None,
                           form=None,
                           extra_context=None,
493 494
                           ooo_builder=None,
                           iteration_index=0):
495 496 497 498 499 500
    """
    Replace an ODF frame using an ERP5Form form box field.
   
    Note: This method is incompleted yet. This function is intended to
    make an frame hide/show. But it has not such a feature currently. 
    """
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
501 502
    field_id = field.id
    enabled = field.get_value('enabled')
503
    draw_xpath = '//draw:frame[@draw:name="%s"]/draw:text-box/*' % field_id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
504
    text_list = element_tree.xpath(draw_xpath, namespaces=element_tree.nsmap)
505 506
    if len(text_list) == 0:
      return element_tree
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
507 508 509 510 511 512
    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
513 514 515 516 517
    # 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
518 519 520 521
    self._replaceXmlByForm(element_tree=frame_paragraph,
                           form=form,
                           here=extra_context['here'],
                           extra_context=extra_context,
522 523
                           ooo_builder=ooo_builder,
                           iteration_index=iteration_index)
524 525
    return element_tree

526 527 528 529 530
  def _replaceXmlByImageField(self,
                              element_tree=None,
                              image_field=None,
                              ooo_builder=None,
                              iteration_index=0):
531 532 533
    """
    Replace an ODF draw:frame using an ERP5Form image field.
    """
534 535
    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
536
    image_list = element_tree.xpath(image_xpath, namespaces=element_tree.nsmap)
Tatuya Kamada's avatar
Tatuya Kamada committed
537 538 539
    if len(image_list) is 0:
      return element_tree
    path = image_field.get_value('default')
540 541
    image_node = image_list[0]
    image_frame = image_node.getparent()
Tatuya Kamada's avatar
Tatuya Kamada committed
542 543
    if path is not None:
      path = path.encode()
Tatuya Kamada's avatar
Tatuya Kamada committed
544
    picture = self.getPortalObject().restrictedTraverse(path)
Tatuya Kamada's avatar
Tatuya Kamada committed
545
    picture_data = getattr(aq_base(picture), 'data', None)
546 547 548 549
    if picture_data is None:
      image_frame = image_node.getparent()
      image_frame.remove(image_node)
      return element_tree
Tatuya Kamada's avatar
Tatuya Kamada committed
550 551 552 553 554 555 556
    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)
    picture_size = self._getPictureSize(picture, image_node)
    image_node.set('{%s}href' % element_tree.nsmap['xlink'], picture_path)
    image_frame.set('{%s}width' % element_tree.nsmap['svg'], picture_size[0])
    image_frame.set('{%s}height' % element_tree.nsmap['svg'], picture_size[1])
557 558 559 560 561
    # set when using report section
    self._setUniqueElementName(base_name=image_field.id,
                               iteration_index=iteration_index,
                               xpath=image_xpath,
                               element_tree=element_tree)
562
    return element_tree
563

Tatuya Kamada's avatar
Tatuya Kamada committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
  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
602 603 604 605 606 607
    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
608
    return (str(w) + unit, str(h) + unit)
Nicolas Delaby's avatar
Nicolas Delaby committed
609 610


Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
611 612 613
  def _appendTableByListbox(self,
                            element_tree=None, 
                            listbox=None,
614 615
                            REQUEST=None,
                            iteration_index=0):
616 617 618
    """
    Append a ODF table using an ERP5 Form listbox.
    """
619 620 621
    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
622
    target_table_list = element_tree.xpath(table_xpath, namespaces=element_tree.nsmap)
623
    if len(target_table_list) is 0:
624
      return element_tree
625 626 627

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

629 630
    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
631 632
    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)
633 634 635

    # copy row styles from ODF Document
    has_header_rows = len(table_header_rows_list) > 0
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
636 637
    (row_top, row_middle, row_bottom) = self._copyRowStyle(table_row_list,
                                                           has_header_rows=has_header_rows)
638 639
    # create style-name and table-row dictionary if a reference name is set
    style_name_row_dictionary = self._createStyleNameRowDictionary(table_row_list)
640 641 642
    # clear original table 
    parent_paragraph = target_table.getparent()
    target_index = parent_paragraph.index(target_table)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
643
    parent_paragraph.remove(target_table)
644 645 646 647 648 649 650
    # 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
651
                                         render_prefix=None)
652 653
    # if ODF table has header rows, does not update the header rows
    # if does not have header rows, insert the listbox title line
654
    is_top = True
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
655
    last_index = len(listboxline_list) - 1
656 657
    for (index, listboxline) in enumerate(listboxline_list):
      listbox_column_list = listboxline.getColumnItemList()
658
      row_style_name = listboxline.getRowCSSClassName()
659 660
      if listboxline.isTitleLine() and not has_header_rows:
        row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
661
        row = self._updateColumnValue(row, listbox_column_list)
662 663 664
        newtable.append(row)
        is_top = False       
      elif listboxline.isDataLine() and is_top:
665 666 667 668
        if style_name_row_dictionary.has_key(row_style_name):
          row = deepcopy(style_name_row_dictionary[row_style_name])
        else:
          row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
669
        row = self._updateColumnValue(row, listbox_column_list)
670 671
        newtable.append(row)
        is_top = False
Tatuya Kamada's avatar
Tatuya Kamada committed
672
      elif listboxline.isStatLine() or (index is last_index and listboxline.isDataLine()):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
673
        row = deepcopy(row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
674
        row = self._updateColumnStatValue(row, listbox_column_list, row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
675
        newtable.append(row)
676
      elif index > 0 and listboxline.isDataLine():
677 678 679 680
        if style_name_row_dictionary.has_key(row_style_name):
          row = deepcopy(style_name_row_dictionary[row_style_name])
        else:
          row = deepcopy(row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
681
        row = self._updateColumnValue(row, listbox_column_list)
682 683
        newtable.append(row)

684 685 686 687
    self._setUniqueElementName(base_name=table_id,
                               iteration_index=iteration_index,
                               xpath=table_xpath,
                               element_tree=newtable)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
688
    parent_paragraph.insert(target_index, newtable)
Nicolas Delaby's avatar
Nicolas Delaby committed
689

690
    return element_tree
691

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
692
  def _copyRowStyle(self, table_row_list=[], has_header_rows=False):
693 694 695
    """
    Copy ODF table row styles.
    """
696 697 698 699 700
    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)
Nicolas Delaby's avatar
Nicolas Delaby committed
701

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
    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])
722 723 724

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

727 728 729 730 731 732 733 734 735 736

  def _createStyleNameRowDictionary(self, table_row_list=[]):
    """create stylename and table row dictionary if a style name reference is set"""
    style_name_row_dictionary = {}
    for table_row in table_row_list:
      reference_element = table_row.find('.//*[@{%s}name]' % table_row.nsmap['text'])
      if reference_element is not None:
        name = reference_element.attrib['{%s}name' % table_row.nsmap['text']]
        style_name_row_dictionary[name] = deepcopy(table_row)
    return style_name_row_dictionary
Nicolas Delaby's avatar
Nicolas Delaby committed
737

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

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

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
768 769
  def _setColumnValue(self, column, value):
    self._clearColumnValue(column)
770
    if value is None:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
771
      self._removeColumnValue(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
772 773 774 775 776 777 778 779 780 781 782 783
    column_value, table_content = self._translateValueIntoColumnContent(value, column)
    for child in column.getchildren():
      column.remove(child)
    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
784 785
    column_children = column.getchildren()
    if len(column_children) > 0:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
786 787 788 789 790 791 792 793 794 795 796 797 798
      table_content = deepcopy(column_children[0])
    # 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
      for element in fragment.getchildren():
        table_content.append(element)
      column_value = " ".join([x for x in table_content.itertext()])
    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
799

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
    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)
    text_namespace = element_tree.nsmap['text']
    tab_element_str = '<text:tab xmlns:text="%s"/>' % text_namespace
    line_break_element_str ='<text:line-break xmlns:text="%s"/>' % text_namespace
    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>'
    fragment_element_tree = etree.XML(template % (text_namespace, translated_value))
    return fragment_element_tree
Nicolas Delaby's avatar
Nicolas Delaby committed
822

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
823
  def _removeColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
824 825 826 827 828
    # 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
829
      if key.startswith("{%s}" % column.nsmap['office']):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
830
        del attrib[key]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
831
    column.text = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
832 833 834 835
    column_children = column.getchildren()
    for child in column_children:
      column.remove(child)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
836
  def _clearColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
837 838
    attrib = column.attrib
    for key in attrib.keys():
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
839
      value_attribute = self._getColumnValueAttribute(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
840 841
      if value_attribute is not None:
        column.set(value_attribute, '')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
842
    column.text = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
843 844
    column_children = column.getchildren()
    for child in column_children:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
845
      # clear data except style
Tatuya Kamada's avatar
Tatuya Kamada committed
846
      style_attribute_tuple = self._getStyleAttributeTuple(child)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
847
      child.clear()
Tatuya Kamada's avatar
Tatuya Kamada committed
848 849
      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
850 851 852 853 854 855

  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
856
    return None
Nicolas Delaby's avatar
Nicolas Delaby committed
857

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

  def _getColumnSpanSize(self, column=None):
    span_attribute = "{%s}number-columns-spanned" % column.nsmap['table']
867 868 869 870
    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
871 872

  def _nextListboxColumnIndex(self, span=0, current_index=0, column_span_list=[]):
873 874 875 876 877 878 879
    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
880 881

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

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

899 900
class ODTStrategy(ODFStrategy):
  """ODTStrategy create a ODT Document from a form and a ODT template"""
Nicolas Delaby's avatar
Nicolas Delaby committed
901 902 903

  _style_attribute_name = '{urn:oasis:names:tc:opendocument:xmlns:text:1.0}style-name'

904 905 906 907 908 909 910 911 912 913 914 915 916 917
  def _replaceXmlByForm(self, element_tree=None, form=None, here=None,
                           extra_context=None, ooo_builder=None, iteration_index=0):
    """
    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.
    """
    field_list = form.get_fields(include_disabled=1) 
Nicolas Delaby's avatar
Nicolas Delaby committed
918
    REQUEST = here.REQUEST
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    for (count, field) in enumerate(field_list):
      if isinstance(field, ListBox):
        element_tree = self._appendTableByListbox(element_tree=element_tree,
                                                  listbox=field,
                                                  REQUEST=REQUEST,
                                                  iteration_index=iteration_index)
      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'))
        content = self._replaceXmlByFormbox(element_tree=element_tree,
                                            field=field,
                                            form=sub_form,
                                            extra_context=extra_context,
                                            ooo_builder=ooo_builder,
                                            iteration_index=iteration_index)
      elif isinstance(field, ReportBox):
         report_method = getattr(field, field.get_value('report_method'), None)
         element_tree = self._replaceXmlByReportSection(element_tree=element_tree,
                                                        extra_context=extra_context,
                                                        report_method=report_method,
                                                        base_name=field.id,
                                                        ooo_builder=ooo_builder)
      elif isinstance(field, ImageField):
        element_tree = self._replaceXmlByImageField(element_tree=element_tree,
                                                    image_field=field,
                                                    ooo_builder=ooo_builder,
                                                    iteration_index=iteration_index)
      else:
        element_tree = self._replaceNodeViaReference(element_tree=element_tree,
                                                     field=field, iteration_index=iteration_index)
    return element_tree

  def _replaceNodeViaReference(self, element_tree=None, field=None, iteration_index=0):
    """replace nodes (e.g. paragraphs) via ODF reference"""
Nicolas Delaby's avatar
Nicolas Delaby committed
954 955
    self._replaceNodeViaRangeReference(element_tree=element_tree, field=field)
    self._replaceNodeViaPointReference(element_tree=element_tree, field=field)
956
    self._replaceNodeViaFormName(element_tree, field)
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
    return element_tree

  def _renderField(self, field):
    # XXX It looks ugly to use render_pdf to extract text. Probably
    # it should be renamed to render_text.
    return field.render_pdf(field.get_value('default'))

  def _replaceNodeViaPointReference(self, element_tree=None, field=None, iteration_index=0):
    """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
973 974 975 976 977 978 979 980
    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})
      new_node = field.render_odt(attr_dict=attr_dict)
      node_to_replace.getparent().replace(node_to_replace, new_node)
981 982 983 984 985 986 987 988 989 990 991 992
    # set when using report section
    self._setUniqueElementName(base_name=field.id,
                               iteration_index=iteration_index,
                               xpath=reference_xpath,
                               element_tree=element_tree)

  def _replaceNodeViaRangeReference(self, element_tree=None, field=None, iteration_index=0):
    """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
993 994
    <text:reference-mark-start text:name="my_title"/>
      <text:span text:style-name="T1">title</text:span>
995 996 997
    <text:reference-mark-end text:name="my_title"/>

    """
Nicolas Delaby's avatar
Nicolas Delaby committed
998 999 1000 1001
    field_id = field.id
    range_reference_xpath = '//text:reference-mark-start[@text:name="%s"]/'\
                            'following-sibling::*[node()/'\
                            'following::text:reference-mark-end[@text:name="%s"]]' % (field_id, field_id)
1002
    reference_list = element_tree.xpath(range_reference_xpath, namespaces=element_tree.nsmap)
Nicolas Delaby's avatar
Nicolas Delaby committed
1003
    if not reference_list:
1004
      return element_tree
Nicolas Delaby's avatar
Nicolas Delaby committed
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
    parent_node_xpath = '//text:reference-mark-start[@text:name="%s"]/parent::*[1]' % field_id
    parent_node = element_tree.xpath(parent_node_xpath, namespaces=element_tree.nsmap)[0]
    text_reference_position = int(parent_node.xpath('count(preceding-sibling::text:reference-mark-start)', namespaces=element_tree.nsmap))

    #Delete all contents between <text:reference-mark-start/> and <text:reference-mark-end/>
    #Try to fetch style-name
    attr_dict = {}
    [(attr_dict.update(target_node.attrib), parent_node.remove(target_node)) for target_node in reference_list]
    new_node = field.render_odt(local_name='span', attr_dict=attr_dict)
    parent_node.insert(text_reference_position+1, new_node)
1015 1016 1017 1018 1019
    # set when using report section
    self._setUniqueElementName(base_name=field.id,
                               iteration_index=iteration_index,
                               xpath=range_reference_xpath,
                               element_tree=element_tree)
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
  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
    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)
      new_node = field.render_odt(attr_dict=attr_dict)
      target_node.getparent().replace(target_node, new_node)

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
class ODGStrategy(ODFStrategy):
  """ODGStrategy create a ODG Document from a form and a ODG template"""

  def _replaceXmlByForm(self, element_tree=None, form=None, here=None,
                           extra_context=None, ooo_builder=None, iteration_index=0):

    field_list = form.get_fields(include_disabled=1)
    REQUEST = get_request()
    for (count, field) in enumerate(field_list):
      field_value = self._renderField(field)
      value = self._toUnicodeString(field_value)
      text_xpath = '//draw:frame[@draw:name="%s"]/*' % field.id
      node_list = element_tree.xpath(text_xpath, namespaces=element_tree.nsmap)
      if len(node_list) is 0:
        return element_tree

      new_node = field.widget.render_odg(field, as_string=False)
      for node in node_list:
        if new_node is not None:
          parent_node = node.getparent()
          parent_node.replace(node, new_node)

      return element_tree