FormPrintout.py 30.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
##############################################################################
#
# Copyright (c) 2009 Nexedi KK and Contributors. All Rights Reserved.
#                    Tatuya Kamada <tatuya@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################
from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
30 31
from Products.CMFCore.utils import _checkPermission, getToolByName
from Products.PythonScripts.Utility import allow_class
32
from Products.ERP5Type import PropertySheet, Permissions
33 34 35
from Products.ERP5Form.ListBox import ListBox
from Products.ERP5Form.FormBox import FormBox
from Products.ERP5Form.ImageField import ImageField
36 37
from Products.ERP5OOo.OOoUtils import OOoBuilder

Tatuya Kamada's avatar
Tatuya Kamada committed
38
from Acquisition import Implicit, aq_base
39 40 41 42
from Globals import InitializeClass, DTMLFile, Persistent, get_request
from AccessControl import ClassSecurityInfo
from AccessControl.Role import RoleManager
from OFS.SimpleItem import Item, SimpleItem
Tatuya Kamada's avatar
Tatuya Kamada committed
43 44
from OFS.Image import File
from urllib import quote, quote_plus
45 46 47 48
from copy import deepcopy
from lxml import etree
from zLOG import LOG, DEBUG, INFO, WARNING
from mimetypes import guess_extension
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
49
from DateTime import DateTime
Tatuya Kamada's avatar
Tatuya Kamada committed
50 51
from decimal import Decimal
import re
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

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

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

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

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

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

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

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

  The Form Printout enables to create a ODF document.

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

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

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

  # Declarative Security
  security = ClassSecurityInfo()

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

  # Constructors
  constructors =   (manage_addFormPrintout, addFormPrintout)

  # Tabs in ZMI
  manage_options = ((
    {'label':'Edit', 'action':'manage_editFormPrintout'},
    {'label':'View', 'action': '' }, ) + Item.manage_options)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
133
  
134 135
  security.declareProtected('View management screens', 'manage_editFormPrintout')
  manage_editFormPrintout = PageTemplateFile('www/FormPrintout_manageEdit', globals(),
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
136
                                             __name__='manage_editFormPrintout')
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
  manage_editFormPrintout._owner = None
  
  # default attributes
  template = None
  form_name = None

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

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

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
157
  security.declareProtected('View', 'index_html')
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  def index_html(self, icon=0, preview=0, width=None, height=None, REQUEST=None):
    """Render and view a printout document."""
    
    obj = getattr(self, 'aq_parent', None)
    if obj is not None:
      container = obj.aq_inner.aq_parent
      if not _checkPermission(Permissions.View, obj):
        raise AccessControl_Unauthorized('This document is not authorized for view.')
      else:
        container = None
    form = getattr(obj, self.form_name)
    if self.template is None or self.template == '':
      raise ValueError, 'Can not create a ODF Document without a printout template'
    printout_template = getattr(obj, self.template)

    report_method = None
    if hasattr(form, 'report_method'):
      report_method = getattr(obj, form.report_method)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
176 177 178 179 180
    extra_context = dict(container=container,
                         printout_template=printout_template,
                         report_method=report_method,
                         form=form,
                         here=obj)
181 182
    # set property to aquisition
    content_type = printout_template.content_type
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
183
    self.strategy = self._createStrategy(content_type)
184
    printout = self.strategy.render(extra_context=extra_context)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
185 186 187 188
    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)))
189
    return printout
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
190

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
191 192
  security.declareProtected('View', '__call__')
  __call__ = index_html
193
                
194 195 196 197 198 199 200 201 202 203 204 205 206 207
  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
208
  def _createStrategy(slef, content_type=''):
209 210 211 212 213 214 215 216
    if guess_extension(content_type) == '.odt':
      return ODTStrategy()
    raise ValueError, 'Do not support the template type:%s' % content_type

InitializeClass(FormPrintout)

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

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

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

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

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

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

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

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

302
    ooo_builder.replace('styles.xml', styles_xml)
303 304 305
    return ooo_builder

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

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

315
    ooo_builder.replace('meta.xml', meta_xml)
316 317
    return ooo_builder

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
318
  def _replaceXmlByForm(self, element_tree=None, form=None, here=None,
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
319
                           extra_context=None, ooo_builder=None):
320
    field_list = form.get_fields() 
321
    REQUEST = get_request()
322
    for (count, field) in enumerate(field_list):
323
      if isinstance(field, ListBox):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
324 325
        element_tree = self._appendTableByListbox(element_tree=element_tree,
                                                  listbox=field,
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
326
                                                  REQUEST=REQUEST)
327 328
      elif isinstance(field, FormBox):
        sub_form = getattr(here, field.get_value('formbox_target_id'))
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
329 330 331 332
        content = self._replaceXmlByFormbox(element_tree=element_tree,
                                            field_id=field.id,
                                            form = sub_form,
                                            REQUEST=REQUEST)
Tatuya Kamada's avatar
Tatuya Kamada committed
333 334 335 336
      elif isinstance(field, ImageField):
        element_tree = self._replaceXmlByImageField(element_tree=element_tree,
                                                    image_field=field,
                                                    ooo_builder=ooo_builder)
337
      else:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
338
        element_tree = self._replaceNodeViaReference(element_tree=element_tree,
Tatuya Kamada's avatar
Tatuya Kamada committed
339
                                                     field=field)
340
    return element_tree
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
341 342

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

Tatuya Kamada's avatar
Tatuya Kamada committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    range reference example:
    <text:reference-mark-start text:name="week"/>Monday<text:reference-mark-end text:name="week"/>
    """
    field_value = field.get_value('default')
    value = self._toUnicodeString(field_value)
    range_reference_xpath = '//text:reference-mark-start[@text:name="%s"]' % field.id
    reference_list = element_tree.xpath(range_reference_xpath, namespaces=element_tree.nsmap)
    if len(reference_list) is 0:
      return element_tree
    target_node = reference_list[0]
    target_node.tail = value
    for node in target_node.itersiblings():
      end_tag_name = '{%s}reference-mark-end' % element_tree.nsmap['text']
      name_attribute = '{%s}name' % element_tree.nsmap['text']
      if node.tag == end_tag_name and node.get(name_attribute) == field.id:
         break
      node.tail = ''
    return element_tree
  
Tatuya Kamada's avatar
Tatuya Kamada committed
390
  def _replaceXmlByReportSection(self, element_tree=None, extra_context=None, ooo_builder=None):
391
    if not extra_context.has_key('report_method') or extra_context['report_method'] is None:
392
      return element_tree
393 394 395 396 397 398
    report_method = extra_context['report_method']
    report_section_list = report_method()
    portal_object = self.getPortalObject()
    REQUEST = get_request()
    request = extra_context.get('REQUEST', REQUEST)
    render_prefix = None
Tatuya Kamada's avatar
Tatuya Kamada committed
399

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413
    report_section_frame_xpath = '//draw:frame[@draw:name="%s"]' % report_method.__name__
    frame_list = element_tree.xpath(report_section_frame_xpath, namespaces=element_tree.nsmap)
    if len(frame_list) is 0:
      return element_tree
    frame = frame_list[0]
    frame_paragraph = frame.getparent()
    office_body = frame_paragraph.getparent()
    # remove if no report section
    if len(report_section_list) is 0:
      office_body.remove(frame_paragraph)
      return element_tree
    frame_paragraph_element_tree = deepcopy(frame_paragraph)
    frame_paragraph_index = office_body.index(frame_paragraph)
    temporary_element_tree = deepcopy(frame_paragraph)
414
    for (index, report_item) in enumerate(report_section_list):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
415
      render_prefix = 'x%s' % index
416 417 418 419
      report_item.pushReport(portal_object, render_prefix = render_prefix)
      here = report_item.getObject(portal_object)
      form_id = report_item.getFormId()
      form = getattr(here, form_id)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
420 421 422 423
      
      frame_paragraph_element_tree = deepcopy(temporary_element_tree)
      if index is 0:
        office_body.remove(frame_paragraph)
Tatuya Kamada's avatar
Tatuya Kamada committed
424
      else:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
425 426
        self._setReportSectionFrameName(report_method_name=report_method.__name__,
                                        frame_paragraph_index=index,
Tatuya Kamada's avatar
Tatuya Kamada committed
427 428
                                        frame_paragraph_element_tree=frame_paragraph_element_tree)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
429

Tatuya Kamada's avatar
Tatuya Kamada committed
430 431 432 433 434
      frame_paragraph_element_tree = self._replaceXmlByForm(element_tree=frame_paragraph_element_tree,
                                                            form=form,
                                                            here=here,
                                                            extra_context=extra_context,
                                                            ooo_builder=ooo_builder)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
435 436
      office_body.insert(frame_paragraph_index, frame_paragraph_element_tree)
      frame_paragraph_index += 1
437
      report_item.popReport(portal_object, render_prefix = render_prefix)
438 439
    return element_tree

Tatuya Kamada's avatar
Tatuya Kamada committed
440
  def _setReportSectionFrameName(self,
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
441
                                 report_method_name='',
Tatuya Kamada's avatar
Tatuya Kamada committed
442 443
                                 frame_paragraph_index=0,
                                 frame_paragraph_element_tree=None):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
444
    report_section_frame_name =  "%s_%s" % (report_method_name, frame_paragraph_index)
Tatuya Kamada's avatar
Tatuya Kamada committed
445
    draw_name_attribute = '{%s}name' % frame_paragraph_element_tree.nsmap['draw']
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
446 447 448
    report_section_frame = frame_paragraph_element_tree.xpath(
      'draw:frame[@draw:name="%s"]' % report_method_name,
      namespaces=frame_paragraph_element_tree.nsmap)
Tatuya Kamada's avatar
Tatuya Kamada committed
449 450 451 452
    if len(report_section_frame) is 0:
      return
    report_section_frame[0].set(draw_name_attribute, report_section_frame_name)
  
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
453
  def _replaceXmlByFormbox(self, element_tree=None, field_id=None, form=None, REQUEST=None):
454
    draw_xpath = '//draw:frame[@draw:name="%s"]/draw:text-box/*' % field_id
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
455
    text_list = element_tree.xpath(draw_xpath, namespaces=element_tree.nsmap)
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
    if len(text_list) == 0:
      return element_tree
    parent = text_list[0].getparent()
    parent.clear()
    # this form.__call__() possibly has a side effect,
    # so must clear the 'here' context for listBox.get_value()
    box = form(REQUEST=REQUEST);
    REQUEST.set('here', None)
    node = etree.XML(box)
    # TODO style_copy
    if node is not None:
      for child in node.getchildren():
        parent.append(child)
    return element_tree

Tatuya Kamada's avatar
Tatuya Kamada committed
471
  def _replaceXmlByImageField(self, element_tree=None, image_field=None, ooo_builder=None):
472 473
    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
474
    image_list = element_tree.xpath(image_xpath, namespaces=element_tree.nsmap)
Tatuya Kamada's avatar
Tatuya Kamada committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488
    if len(image_list) is 0:
      return element_tree
    path = image_field.get_value('default')
    picture = self.getPortalObject().unrestrictedTraverse(path)
    picture_data = getattr(aq_base(picture), 'data', None)
    picture_type = picture.getContentType()
    picture_path = self._createOdfUniqueFileName(path=path, picture_type=picture_type)
    ooo_builder.addFileEntry(picture_path, media_type=picture_type, content=picture_data)
    image_node = image_list[0]
    picture_size = self._getPictureSize(picture, image_node)
    image_node.set('{%s}href' % element_tree.nsmap['xlink'], picture_path)
    image_frame = image_node.getparent()
    image_frame.set('{%s}width' % element_tree.nsmap['svg'], picture_size[0])
    image_frame.set('{%s}height' % element_tree.nsmap['svg'], picture_size[1])
489
    return element_tree
490

Tatuya Kamada's avatar
Tatuya Kamada committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
  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
    w = h * aspect_ratio
    return (str(w) + unit, str(h) + unit)
   
  
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
533 534 535
  def _appendTableByListbox(self,
                            element_tree=None, 
                            listbox=None,
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
536
                            REQUEST=None):
537 538 539
    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
540
    target_table_list = element_tree.xpath(table_xpath, namespaces=element_tree.nsmap)
541
    if len(target_table_list) is 0:
542
      return element_tree
543 544 545

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

547 548
    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
549 550
    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)
551 552 553

    # copy row styles from ODF Document
    has_header_rows = len(table_header_rows_list) > 0
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
554 555
    (row_top, row_middle, row_bottom) = self._copyRowStyle(table_row_list,
                                                           has_header_rows=has_header_rows)
556 557 558 559

    # clear original table 
    parent_paragraph = target_table.getparent()
    target_index = parent_paragraph.index(target_table)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
560
    parent_paragraph.remove(target_table)
561 562 563 564 565 566 567
    # 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
568
                                         render_prefix=None)
569
    
570 571
    # if ODF table has header rows, does not update the header rows
    # if does not have header rows, insert the listbox title line
572
    is_top = True
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
573
    last_index = len(listboxline_list) - 1
574 575 576 577
    for (index, listboxline) in enumerate(listboxline_list):
      listbox_column_list = listboxline.getColumnItemList()
      if listboxline.isTitleLine() and not has_header_rows:
        row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
578
        row = self._updateColumnValue(row, listbox_column_list)
579 580 581 582
        newtable.append(row)
        is_top = False       
      elif listboxline.isDataLine() and is_top:
        row = deepcopy(row_top)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
583
        row = self._updateColumnValue(row, listbox_column_list)
584 585
        newtable.append(row)
        is_top = False
Tatuya Kamada's avatar
Tatuya Kamada committed
586
      elif listboxline.isStatLine() or (index is last_index and listboxline.isDataLine()):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
587
        row = deepcopy(row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
588
        row = self._updateColumnStatValue(row, listbox_column_list, row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
589
        newtable.append(row)
590 591
      elif index > 0 and listboxline.isDataLine():
        row = deepcopy(row_middle)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
592
        row = self._updateColumnValue(row, listbox_column_list)
593 594
        newtable.append(row)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
595 596
    parent_paragraph.insert(target_index, newtable)
 
597
    return element_tree
598

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
599
  def _copyRowStyle(self, table_row_list=[], has_header_rows=False):
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
    row_top = None
    row_middle = None
    row_bottom = None
    if len(table_row_list) > 0:
      if len(table_row_list) is 1:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[0])
        row_bottom = deepcopy(table_row_list[0])
      elif len(table_row_list) is 2 and has_header_rows:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[0])
        row_bottom = deepcopy(table_row_list[-1])
      elif len(table_row_list) is 2 and not has_header_rows:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[1])
        row_bottom = deepcopy(table_row_list[-1])
      elif len(table_row_list) >= 2:
        row_top = deepcopy(table_row_list[0])
        row_middle = deepcopy(table_row_list[1])
        row_bottom = deepcopy(table_row_list[-1])
    return (row_top, row_middle, row_bottom)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
621 622 623

  def _updateColumnValue(self, row=None, listbox_column_list=[]):
    odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
624 625 626 627 628 629
    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
630
      self._setColumnValue(column, value)
631 632
    return row

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
633
  def _updateColumnStatValue(self, row=None, listbox_column_list=[], row_middle=None):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
634
    """stat line is capable of column span setting"""
635 636
    if row_middle is None:
      return row
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
637 638
    odf_cell_list = row.findall("{%s}table-cell" % row.nsmap['table'])
    odf_column_span_list = self._getOdfColumnSpanList(row_middle)
639 640 641 642 643 644
    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
645 646 647 648 649
      self._setColumnValue(column, value)
      column_span = self._getColumnSpanSize(column)
      listbox_column_index = self._nextListboxColumnIndex(column_span,
                                                          listbox_column_index,
                                                          odf_column_span_list)
650 651
    return row

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
652 653
  def _setColumnValue(self, column, value):
    self._clearColumnValue(column)
654
    if value is None:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
655
      value = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
656 657 658
      self._removeColumnValue(column)
    if isinstance(value, DateTime):
      value = value.strftime('%Y-%m-%d')
659 660
    column_value = unicode(str(value),'utf-8')
    column_children = column.getchildren()
661
    first_child = None
662
    if len(column_children) > 0:
663 664 665 666
      first_child = deepcopy(column_children[0])
      first_child.text = column_value
    for child in column_children:
      column.remove(child)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
667 668
    if first_child is not None:
      column.append(first_child)
669
    if column_value != '':
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
670
      value_attribute = self._getColumnValueAttribute(column)
671 672 673
      if value_attribute is not None:
        column.set(value_attribute, column_value)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
674
  def _removeColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
675 676 677 678 679
    # 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
680
      if key.startswith("{%s}" % column.nsmap['office']):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
681
        del attrib[key]
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
682
    column.text = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
683 684 685 686
    column_children = column.getchildren()
    for child in column_children:
      column.remove(child)

Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
687
  def _clearColumnValue(self, column):
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
688 689
    attrib = column.attrib
    for key in attrib.keys():
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
690
      value_attribute = self._getColumnValueAttribute(column)
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
691 692
      if value_attribute is not None:
        column.set(value_attribute, '')
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
693
    column.text = ''
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
694 695
    column_children = column.getchildren()
    for child in column_children:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
696 697 698 699 700 701 702 703 704 705 706 707 708
      # clear data except style
      style_attribute_tuple = self._getStyleAttributeTuple(child)
      child.clear()
      if style_attribute_tuple is not None:
        child.set(style_attribute_tuple[0], style_attribute_tuple[1])

  def _getStyleAttributeTuple(self, element):
    attrib = element.attrib
    for key in attrib.keys():
      if key.endswith('style-name'):
        return (key, attrib[key])
    return None
  
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
709
  def _getColumnValueAttribute(self, column):
710 711 712 713 714
    attrib = column.attrib
    for key in attrib.keys():
      if key.endswith("value"):
        return key
    return None
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
715 716 717

  def _getColumnSpanSize(self, column=None):
    span_attribute = "{%s}number-columns-spanned" % column.nsmap['table']
718 719 720 721
    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
722 723

  def _nextListboxColumnIndex(self, span=0, current_index=0, column_span_list=[]):
724 725 726 727 728 729 730
    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
731 732

  def _getOdfColumnSpanList(self, row_middle=None):
733 734
    if row_middle is None:
      return []
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
735
    odf_cell_list = row_middle.findall("{%s}table-cell" % row_middle.nsmap['table'])
736 737
    column_span_list = []
    for column in odf_cell_list:
Tatuya Kamada's avatar
* Fix  
Tatuya Kamada committed
738
      column_span = self._getColumnSpanSize(column)
739 740 741
      column_span_list.append(column_span)
    return column_span_list

Tatuya Kamada's avatar
Tatuya Kamada committed
742 743 744 745 746 747
  def _toUnicodeString(self, field_value = None):
    value = ''
    if field_value is not None:
      value = unicode(str(field_value), 'utf-8')
    return value

748 749 750
class ODTStrategy(ODFStrategy):
  """ODTStrategy create a ODT Document from a form and a ODT template"""
  pass