ScribusUtils.py 85.6 KB
Newer Older
Kevin Deldycke's avatar
Kevin Deldycke committed
1 2 3 4
##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
#               Guy Oswald OBAMA <guy@nexedi.com>
5
#               thomas <thomas@nexedi.com>
6
#               Mame C.Sall <mame@nexedi.com>
Kevin Deldycke's avatar
Kevin Deldycke committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
#
# 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.
#
##############################################################################

24 25 26
# This code is under refactoring. This code will change in near future
# with a lot of cleanups. This is stored only for a temporary purpose.
# Do not rely on the real implementation. It is assumed that the code is
27 28
# improved and modified significantly.
# UPDATE => the code is almost refactored and supports
29

Kevin Deldycke's avatar
Kevin Deldycke committed
30 31
from Products.PythonScripts.Utility import allow_class
from ZPublisher.HTTPRequest import FileUpload
32
from xml.dom.ext.reader import PyExpat
Kevin Deldycke's avatar
Kevin Deldycke committed
33 34 35 36 37 38 39 40
from xml.dom import Node, minidom
from AccessControl import ClassSecurityInfo
from Globals import InitializeClass, get_request
from zipfile import ZipFile, ZIP_DEFLATED
from StringIO import StringIO
from zLOG import LOG
import imghdr
import random
41
import getopt, sys, os
Kevin Deldycke's avatar
Kevin Deldycke committed
42 43
from urllib import quote

44
from Products.ERP5.ERP5Site import ERP5Site
45
from Products.Formulator.TALESField import TALESMethod
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
# defining global variables
# ANFLAG tag
# these values can be found in the Scribus document format
# (www.scribus.org.uk)
def_noScroll = '8388608'
def_noSpellCheck = '4194304'
def_editable = '262144'
def_password = '8192'
def_multiLine = '4096'
def_noExport = '4'
def_required = '2'
def_readOnly = '1'
# SCRIPT CONFIGURATION
# define if the script uses personal properties or create a
# PropertySheet and a Document model to save data.
# used in 'setPropertySheetAndDocument', 'setObjectPortalType'
# and 'setPDFForm' 
def_usePropertySheet = 0
Kevin Deldycke's avatar
Kevin Deldycke committed
64

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

class ManageModule:
  """
  Manage the module that will contain the form
  """
  security = ClassSecurityInfo()

  security.declarePublic('setObjectNames')
  def setObjectNames(self, object_portal_type_id, object_title):
    """
    initialize object names view_pdf, view_list, etc. to be able
    to create correctly all objects in the module.
    return a dict of names.
    """
    temp_portal_type = object_portal_type_id.replace(' ','')
    object_names = {}
81
    real_object_names={}
82 83 84 85
    # declaring object that generate pdf output
    object_names['view_pdf'] = temp_portal_type + '_view' +\
                    temp_portal_type + 'AsPdf'
    # declaring form to list the objects of a module
86
    # TODO: use module portal type, not "object title + Module"
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
    object_names['view_list'] = object_title.replace(' ','') +\
                    'Module_view' + temp_portal_type + 'List'
    # declaring main object form
    object_names['view_id'] = temp_portal_type + '_view'
    # declaring object that holds the CSS data
    object_names['css'] = temp_portal_type + '_css.css'
    # declaring object name containing the background pictures
    object_names['page'] = temp_portal_type + '_background_'
    # return object declaration
    return object_names


  security.declarePublic('setSkinFolder')
  def setSkinFolder(self,
                    portal,
                    portal_skins_folder):
    """
    create and manage skin folder according to the skin folder
    name specified by the user (as portal_skin_folder).
    returns skin_folder, recovered from portal.portal_skins
    """
    portal_skins_folder_name = portal_skins_folder
    portal_skins = portal.portal_skins
    if not portal_skins_folder_name in portal.portal_skins.objectIds():
      # create new folder if does not exist yet
      portal_skins.manage_addFolder(portal_skins_folder_name)
    skin_folder = portal.portal_skins[portal_skins_folder_name]
    for skin_name, selection in portal_skins.getSkinPaths():
      selection = selection.split (',')
      if portal_skins_folder_name not in selection:
        new_selection = [portal_skins_folder_name,]
118
        new_selection.extend(selection)
119
        portal_skins.manage_skinLayers(skinpath = tuple(new_selection),
120
                                       skinname = skin_name,
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
                                       add_skin = 1)
    return skin_folder


  security.declarePublic('setModuleForm')
  def setModuleForm(self,
                    object_title,
                    skin_folder,
                    #portal,
                    #portal_skins_folder,
                    form_view_list,
                    module_title,
                    module_id,
                    def_lineNumberInList
                    ):
    """
    Manage ERP5 Form to handle and view the Module. then process
    the list inside this form. This procedure does not need to
    parse the scribus file as the ModuleForm is always present
    and generated the same way
    returns nothing
    """
    # the form is already existing and has been created through
    # setERP5Form. getting form object to update properties
    form_view_list_object = skin_folder[form_view_list]
    form_list_id = form_view_list_object.id
    form_list = form_view_list_object.restrictedTraverse(form_list_id)
    # defining groups for objects listing
149 150
    form_view_list_object.rename_group('Default','bottom')
    default_groups = []
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    # adding groups
    for group in default_groups:
      form_view_list_object.add_group(group)
    # defining module title
    title_module = ''
    for word in module_title.split():
      title_module += str(word.capitalize() + ' ')
    # add listbox field to list the created objects
    id = 'listbox'
    title = title_module
    field_type = 'ListBox'
    form_view_list_object.manage_addField(id,title,field_type)
    # manage ListBox settings
    values_settings = {}
    values_settings['pt'] = "form_list"
    values_settings['action'] = "Base_doSelect"
    # set the form settings
    for key, value in values_settings.items():
      setattr(form_view_list_object, key, value)
    # manage edit property of ListBox
    field_attributes = getattr(form_view_list_object,id)
    field_attributes.values['lines'] = def_lineNumberInList
    # adding field columns
    field_attributes.values['columns'] = [('id','ID'),
                                          ('title','Title'),
176 177
                                          ('description','Description'),
					  ('translated_simulation_state','State')]
178 179 180 181 182 183 184 185 186 187 188 189
    field_attributes.values['list_action'] = 'list'
    field_attributes.values['search'] = 1
    field_attributes.values['select'] = 1
    field_attributes.values['list_method'] = 'searchFolder'
    field_attributes.values['selection_name'] = '%s_selection' % module_id

  security.declarePublic('setObjectForm')
  def setObjectForm(self,
                    skin_folder,
                    object_names,
                    option_html,
                    global_properties,
190
                    object_portal_type
191 192 193 194 195 196 197 198 199 200 201
                    ):
    """
    create and manage erp5 form to handle object, and update its
    properties (groups, values, etc.)
    return list of groups in form (used afterwards when creating
    fields).
    """
    # getting form object
    form_view_id_object = skin_folder[object_names['view_id']]
    form_id = form_view_id_object.id
    form = form_view_id_object.restrictedTraverse(form_id)
202
    #get the scaling factor
203 204 205 206 207 208 209 210 211
    # managing form groups
    default_groups = []
    if option_html !=1:
      # using default ERP5 positioning convention
      # based on 'left'/'right'/etc.
      default_groups = ['left','right','center','bottom','hidden']
    else:
      # using special page positioning convention for
      # pdf-like rendering
212
      del default_groups[0:]
213 214
      for page_iterator in range(global_properties['page']):
        page_number = 'page_%s' % str(page_iterator)
215 216 217
        
	
	default_groups.append(page_number)
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
    # default_groups list completed, need to update the form_groups
    # renaming form default group with list's first item
    form_view_id_object.rename_group('Default',
                                     default_groups[0]
                                     )
    # adding all other items
    for group in default_groups[0:]:
      form_view_id_object.add_group(group)
    # updating form settings
    # building dict containing (property, value)
    values = {}
    values['title'] = str(object_portal_type)
    values['row_length'] = 4
    values['name'] = object_names['view_id']
    if option_html ==1:
      # this is the name of the new form, compatible either with html_style
      # and xhtml_style.
      values['pt'] = "form_render_PDFeForm"
    else:
      values['pt'] = "form_view"
    values['action'] = "Base_edit"
    values['update_action'] = ""
    values['method'] = 'POST'
    values['enctype'] = 'multipart/form-data'
    values['encoding'] = "UTF-8"
    values['stored_encoding'] = 'UTF-8'
    values['unicode_mode'] = 0
    # using the dict declared just above to set the attributes
    for key, value in values.items():
      setattr(form,key,value)
248
    return (default_groups)
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

  security.declarePublic('setFieldsInObjectForm')
  def setFieldsInObjectForm(self,
                            skin_folder,
                            object_names,
                            default_groups,
                            global_properties,
                            option_html
                            ):
    """
    create fields in form according to the page_objects
    recovered from the scribus document file. fields are
    then moved to their corresponding group, and are given
    their properties
    """
    form_view_id_object = skin_folder[object_names['view_id']]
    # iterating field a first time to get creation order
    # based on the 'nb' value
    field_nb_dict = {}
    # this dict will handle all the information about the field_names and
    # their creation order (field_nb).

    if option_html :
      # render is PDF-like, need to take care of the page holding the field
      for field_id in global_properties['object'].keys():
        field_nb = int(global_properties['object'][field_id]['nb'])
        #field_order =  global_properties['object'][field_id]['order']
        field_order = \
         int(global_properties['object'][field_id]['order'].split('page_')[1])
        # creating sub dict if does not exist yet
        if field_order not in field_nb_dict:
          field_nb_dict[field_order] = {}
        field_nb_dict[field_order][field_nb] = field_id
      # now field_nb_dict holds all the information about the
      # fields and their creation order: just need to create
      # them.

      for field_order_id in field_nb_dict.keys():
        # iterating pages
        for field_nb in range(len(field_nb_dict[field_order_id].keys())):
          field_id = field_nb_dict[field_order_id][field_nb + 1]
          # recovering field information
          field_values = global_properties['object'][field_id]
          field_type = field_values['erp_type']
          field_title = field_values['title']
          field_order = field_values['order']
295
          #field_tales = field_values['tales']
296 297 298 299 300 301 302 303 304 305
          # creating new field in form
          form_view_id_object.manage_addField(field_id,
                                            field_title,
                                            field_type)
          # move fields to destination group
          form_view_id_object.move_field_group(field_id,
                                             default_groups[0],
                                             field_order)
          # recover field
          access_field = getattr(form_view_id_object,field_id)
306 307 308 309 310 311 312 313 314
          if field_type == 'CheckBoxField':
            test_name= field_id[3:]
            tales = {field_id : {'default' : 'here'+ '/'+ test_name}}

            forms = [object_names['view_id']]
            form = form_view_id_object.restrictedTraverse(forms[0])
            for k, v in tales.items() :
              if hasattr(form, k) :
                form[k].manage_tales_xmlrpc(v)
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
          #if field_type == 'CheckBoxField':
          #  print "    dir(%s) > %s" % (field_id,dir(access_field))
          #  print "---manage_tales > %s \n\n" % dir(access_field.manage_tales)
          #  print "---manage_talesForm > %s \n\n" % \
          #         dir(access_field.manage_talesForm)
          #  print "---manage_talesForm__roles__ > %s\n\n " % \
          #         dir(access_field.manage_talesForm__roles__)
          #  print "---manage_tales__roles__ > %s" % \
          #         dir(access_field.manage_tales__roles__)
          #  print "--- 5 > %s" % dir(access_field.manage_tales_xmlrpc)
          #  print "--- 6 > %s" % \
          #         dir(access_field.manage_tales_xmlrpc__roles__)

    else:
      # rendering as basic ERP5 form : processing all
      # fields without taking care of their 'order'.
      for field_id in global_properties['object'].keys():
        field_nb = int(global_properties['object'][field_id]['nb'])
        if field_nb in field_nb_dict.keys():
          # field_nb is already used by another field. this can appen
          # when there are several pages in the document. In such case
          # the script find automatically the closest available value.
          print "  can not add %s to dict : %s already used by %s " % \
                (field_id,field_nb,field_nb_dict[field_nb])
          field_nb = field_nb +1
          while field_nb in field_nb_dict.keys():
            # trying next value
            field_nb = field_nb + 1
        print "  add %s to %s" % (field_id,field_nb)
        # value is available, no problem to link field_id to this field_nb
        field_nb_dict[field_nb] = field_id

      for field_nb in range(len(field_nb_dict.keys())):
        field_nb = field_nb +1
        field_id = field_nb_dict[field_nb]
        # recovering field information
        field_values = global_properties['object'][field_id]
        field_type = field_values['erp_type']
        field_title = field_values['title']
        field_order = field_values['order']
        # create field
        form_view_id_object.manage_addField(field_id,
                                            field_title,
                                            field_type)
        # move field to relative group
        form_view_id_object.move_field_group(field_id,
                                             default_groups[0],
                                             field_order)

    # field creation is complete
    form_id = form_view_id_object.id
    form = form_view_id_object.restrictedTraverse(form_id)
    # updating field properties
    # iterating fields
    for field_id in global_properties['object'].keys():
      field_attributes = getattr(form,field_id)
      #print "   %s => %s" % (field_id,field_attributes.values.keys())
      for attr_id, attr_val in \
         global_properties['object'][field_id]['attributes'].items():
        field_attributes.values[attr_id] = attr_val



  security.declarePublic('setModulePortalType')
  def setModulePortalType(self,portal_types,
                    object_portal_type_id,
                    module_portal_type,
                    object_names):
    """
    set portal_type for the module containing objects.
    returns nothing
    """
    portal_types.manage_addTypeInformation('ERP5 Type Information'
                ,typeinfo_name = 'ERP5Type: ERP5 Folder'
                ,id = module_portal_type)
    # getting portal_type access to be able to modify attributes
    module_portal_type_value = portal_types[module_portal_type]
    # set alowed content type
    module_portal_type_value.allowed_content_types = (object_portal_type_id,)
    module_portal_type_value.filter_content_types = 1
    # making a list of all the portal_type actions to be able to delete them
    action_list = module_portal_type_value.listActions()
    # cleaning all portal_types actions
    module_portal_type_value.deleteActions(
                selections = range(0, len(action_list)))
    # adding usefull actions (in our case the view action)
    module_portal_type_value.addAction( "view"
          , "View"
          , "string:${object_url}/%s"%object_names['view_list']
          , ""
          , "View"
          , "object_view"
          )



  security.declarePublic('setObjectPortalType')
  def setObjectPortalType(self,
                          portal_types,
                          object_portal_type_id,
                          object_portal_type,
                          object_names):
    name = ''
    if def_usePropertySheet:
      # generating 'typeinfo_name' property for the new portal type.
      # if class exists, then using it, otherwize using default ERP5
      # Document type.
      name = 'ERP5Type: ERP5 ' + object_portal_type # use with PropertySheet
    else:
      name = 'ERP5Type: ERP5 Document'  # use with local properties
    portal_types.manage_addTypeInformation('ERP5 Type Information',
                                          typeinfo_name = name,
                                          id = object_portal_type_id)
    object_portal_type_value = portal_types[object_portal_type_id]

    # cleaning all default actions
    action_list = object_portal_type_value.listActions()
    object_portal_type_value.deleteActions(
              selections = range(0, len(action_list)))
    # adding usefull actions (in our case the view action)
    object_portal_type_value.addAction( "view",
          "View",
          "string:${object_url}/%s" % object_names['view_id'],
          "",
          "View",
          "object_view"
          )
    object_portal_type_value.addAction( "print"
          , "Print"
444
          , "string:${object_url}/%s" % object_names['view_pdf']
445 446 447
          , ""
          , "View"
          , "object_print"
448
          , priority=2.0
449 450 451 452 453 454 455
          )
    object_portal_type_value.addAction( "history"
          , "History"
          , "string:${object_url}/Base_viewHistory"
          , ""
          , "View"
          , "object_view"
456
          , priority=99.0
457 458 459 460 461 462 463
          )
    object_portal_type_value.addAction( "metadata"
          , "Metadata"
          , "string:${object_url}/Base_viewMetadata"
          , ""
          , "Manage properties"
          , "object_view"
464
          , priority=100.0
465 466 467 468 469 470 471 472
          )


  security.declarePublic('registerModule')
  def registerModule(self,
                           portal,
                           module_id,
                           module_portal_type,
473 474
                           object_portal_type,
                           module_title):
475 476 477 478 479
    """
    register Module inside ERP5 instance
    """
    portal.newContent( id          = str(module_id),
                       portal_type = str(module_portal_type),
480
                       title       = module_title)
481

482
   
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
class ManageFiles:
  """
  Manages PDF file, by importing the PDF document and then getting
  the TALES expressions
  """
  security = ClassSecurityInfo()



  security.declarePublic('setERP5Form')
  def setERP5Form(self,
                  factory,
                  form_name,
                  form_title):
    """
    create an ERP5 Form by using the factory
    """
    factory.addERP5Form(form_name,
501
                        form_title)
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 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548



  security.declarePublic('setCSSFile')
  def setCSSFile(self,
                 factory,
                 form_css_id,
                 form_css_content,
                 ):
    """
    create an ERP5 DTML Document in the folder related
    to factory and save the content of the CSS string
    """
    factory.addDTMLDocument(form_css_id,"css",form_css_content)


  security.declarePublic('importFile')
  def setPDFForm(self,
                 factory,
                 skin_folder,
                 object_names,
                 object_title,
                 pdf_file
                 ):
    """
    imports PDF file as a PDFForm in ERP5 and updates its TALES
    expressions
    """
    pdf_file.seek(0)
    factory.addPDFForm(object_names['view_pdf'],object_title,pdf_file)
    # iterating objects in skin_folder
    for c in skin_folder.objectValues():
      if c.getId() == object_names['view_pdf']:
        # current object is PDF Form
        cell_name_list = c.getCellNames()
        for cell_name in cell_name_list:
          if cell_name[0:3] == 'my_':
            cell_process_name_list = []
            for word in cell_name[3:].split('_'):
              word = word.capitalize()
              cell_process_name_list.append(word)
            if def_usePropertySheet == 1:
              # generating PropertySheet and Document, no need to use them to
              # get field data
              if cell_process_name_list[-1] == 'List':
                TALES = "python: " + ", ".join(
                     "here.get" + "".join(cell_process_name_list) + "()" )
549

550 551 552
              else:
                TALES = "python: here.get" + "".join(
                     cell_process_name_list) + "()"
553

554 555 556 557 558
            else:
              # PropertySheet and Document 
              if cell_process_name_list[-1] == 'List':
                TALES = "python: " + ", ".join(
                      "here.getProperty('" + cell_name[3:] + "')")
559

560 561 562 563 564
              else:
                TALES = "python: here.getProperty('" + cell_name[3:] +"')"
            print "   %s > %s " % (cell_name,TALES)
            c.setCellTALES(cell_name,TALES)

565 566 567
  def getPDFFile(self, file_descriptor):
    """ Get file content """
    return file_descriptor.open()
568 569 570 571 572

  security.declarePublic('setBackgroundPictures')
  def setBackgroundPictures(self,
                            pdf_file,
                            object_names,
573
                            skin_folder,
574 575 576
                            desired_height,
                            desired_width,
                            resolution
577 578 579 580 581 582 583 584 585 586 587 588 589 590
                            ):
    """
    extract background pictures from pdf file and convert them
    in the right format (JPEG) and save them in the corresponding
    folder (skin_folder).
    to work, this procedure needs to have pdftoppm (from Xpdf)
    and convert (from ImageMagick) installed on the server
    otherwise nothing is created.
    Temp files are created in the '/tmp/' folder, and are deleted
    once the job is done.
    At the end, get the properties (size_x, size_y) of the first
    image (i.e page_0) and returns them.
    """
    import commands
591 592
    import tempfile
    from tempfile import NamedTemporaryFile
593
    # opening new file on HDD to save PDF content
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
    #temp_test= NamedTemporaryFile(mode= "w+b")
    #tempFile= NamedTemporaryFile().name
    ScribusUtilsTempPDF= NamedTemporaryFile(mode= "w+b")
    ScribusUtilstempsPDFName= NamedTemporaryFile().name
    # going to the begining of the input file

    # XXX - this is really bad because the appropriate 
    # way to run zope is to create a local instance
    # it should be removed XXX - some people
    # do this just to make sure "it works" 
    # but it is not even multiplatform
    os.putenv('TMPDIR', '/tmp')
    # saving content
    temp_pdf = open(ScribusUtilstempsPDFName,'w')

609 610 611
    # going to the begining of the input file
    pdf_file.seek(0)
    # saving content
612
    # saving content
613 614
    temp_pdf.write(pdf_file.read())
    temp_pdf.close()
615

616
    # launching first soft to convert from PDF to PPM
617 618 619
    ScribusUtilstempsPPM = NamedTemporaryFile(mode="w+b")
    ScribusUtilstempsPPMName = NamedTemporaryFile().name
    result = commands.getstatusoutput('pdftoppm -r %s %s %s' % (resolution, ScribusUtilstempsPDFName, ScribusUtilstempsPPMName))
620
    # launching second soft to convert from PPM to JPEG
621 622
    ScribusUtilstempsJPG = NamedTemporaryFile(mode="w+b")
    ScribusUtilstempsJPGName = NamedTemporaryFile().name
623

624 625
    original_result= commands.getstatusoutput('identify %s' % (ScribusUtilstempsPDFName))
    result = commands.getstatusoutput('convert -density %s -resize %sx%s %s %s' % (resolution,desired_width,desired_height,ScribusUtilstempsPPMName + '*', 'jpg:' + ScribusUtilstempsJPGName))
626

627 628 629
    number = ScribusUtilstempsJPGName.find('tmp')
    directory_tmp= ScribusUtilstempsJPGName[:(number+4)]

630
    # getting list of JPG output files
631 632 633 634 635
    result = commands.getstatusoutput('ls %s | grep  %s' % (directory_tmp, ScribusUtilstempsJPGName.split('/')[-1]))
    # deleting all temporary files
    # getting the original size of the file
    real_size_x= 0
    real_size_y= 0
636 637 638 639 640 641 642 643 644 645 646 647
    image_number = 0
    if result[1] != '':
      # result[1] contains the output string from the command,
      # in our case the result of the ls.
      # splitting this string to get the list of objects
      for image in result[1].split('\n'):
        temp_jpg = open('/tmp/%s' % image, 'r')
        form_page_id = object_names['page'] + str(image_number)
        addImage = skin_folder.manage_addProduct['OFSP'].manage_addImage
        addImage(form_page_id,temp_jpg,"background image")
        image_number += 1
    # deleting all temporary files
648
    result = commands.getstatusoutput('rm -f /tmp/tmp*') # JPS-XXX Extremely dangerous
649 650
    # open page_0's final background picture to recover size_x and size_y
    final_image = getattr(skin_folder, object_names['page'] + '0')
651 652
    size_x = desired_height
    size_y = desired_width
653

654
    return (size_x, size_y,real_size_x,real_size_y)
655

656 657
  security.declarePublic('getPageattributes')
  def getPageattributes (self,
658 659 660
                         global_properties,
                         pdf_file
                        ):
661 662 663 664 665
    import commands
    from tempfile import NamedTemporaryFile
    # opening new file on HDD to save PDF content
    ScribusUtilsOriginalTempPDF= NamedTemporaryFile(mode= "w+b")
    ScribusUtilsOriginaltempsPDFName= NamedTemporaryFile().name
666

667
    # going to the begining of the input file
668

669 670 671 672 673 674 675 676 677 678 679 680 681 682
    # saving content
    temp_pdf = open(ScribusUtilsOriginaltempsPDFName,'w')
    # going to the begining of the input file
    pdf_file.seek(0)
    # saving content
    temp_pdf.write(pdf_file.read())
    temp_pdf.close()	  
    width_groups = []
    height_groups = []
    # launching first soft to convert from PDF to PPM
    ScribusUtilsOriginaltempsPPM = NamedTemporaryFile(mode="w+b")
    ScribusUtilsOriginaltempsPPMName = NamedTemporaryFile().name
    original_result = commands.getstatusoutput('pdftoppm -r %s %s %s' % (72, ScribusUtilsOriginaltempsPDFName, ScribusUtilsOriginaltempsPPMName))
    original_result= commands.getstatusoutput('identify %s' % (ScribusUtilsOriginaltempsPPMName + '*'))
683

684 685 686 687 688 689 690 691 692 693 694 695 696 697
    pg_nbr = len(original_result[1].split('\n'))
    real_size_x = {}
    real_size_y = {}
    for i in range(0,pg_nbr):
      real_size_x[i]= \
         float(original_result[1].split('\n')[i].split(' ')[2].split('x')[1])
      real_size_y[i]= \
         float(original_result[1].split('\n')[i].split(' ')[2].split('x')[0])
    for page_iterator in range(global_properties['page']):  
      actual_page_height = real_size_x[page_iterator]
      actual_page_width = real_size_y[page_iterator]
      width_groups.append(actual_page_width)
      height_groups.append(actual_page_height)
    return (width_groups,height_groups)
698

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
  security.declarePublic('setPropertySheetAndDocument')
  def setPropertySheetAndDocument(self,
                       global_properties,
                       object_portal_type,
                       generator,
                       skin_folder,
                       object_names
                       ):
    """
    recover personal properties from dict global_properties
    and save them in a propertysheet
    then create the Document related to the object.
    PropertySheetRegistry and DocumentRegistry have to be
    reinitialized after this procedure has been called.
    """
    if def_usePropertySheet:    
      print " object_names = %s" % object_names['view_id']
      #property_form = getattr(skin_folder,object_names['view_id'])
      # defining file name for Property Sheet
      name_file =''
      for word in object_portal_type.split():
        name_file += word.capitalize()
      # building list containing properties
      personal_properties_list = []
      for field_id in global_properties['object'].keys():
        if field_id.startswith('my_') and not (
           field_id.startswith('my_source') or
           field_id.startswith('my_destination') or
           field_id in ('my_start_date','my_stop_date')):
          field_type = global_properties['object'][field_id]['data_type']
          field_default = global_properties['object'][field_id]['default']
          personal_properties = { 'id' : field_id[3:],
                                  'description' : '',
                                  'type' : field_type,
                                  'mode' : 'w'}
          ## FOLLOWING QUOTED LINES CAN BE DELETED IF NOT USES
          ## just left in case : can be usefull to create a smart
          ## script that would be able to automatically create the
          ## local properties and associate them the good type (int,
          ## string, float, date, etc.)
          #print "   (field_id,field_default_value,field_type) = \
          #   (%s,%s,%s) " % (field_id[3:], field_default, field_type)
          #property_form.manage_addProperty(field_id[3:],
          #                                 field_default,
          #                                 field_type)
          personal_properties_list.append(personal_properties)
      # the following lines create the PropertySheet and the Document for the
      # new object. Must be uncoted when such files are needed, in such case
      # you must also specify Document type to comply with class declared in 
      # the Document. For that see 'setObjectPortalType' method 
      ## generate PropertySheet
      generator.generateLocalPropertySheet(name_file,personal_properties_list)
      ## generate Document
      generator.generateLocalDocument(name_file,object_portal_type)


class ManageCSS:
  """
  Manages all CSS information to generate the css file used in the
  PDF-like rendering
  """
  security = ClassSecurityInfo()

  security.declarePublic('setInit')
  def setInit(self):
    """
    initialize various containers (dicts) used to store attributes
    in a main dict.
    returns global dict containing all the sub-dicts
    """
    # declaring dicts used to generate CSS file
    # css_dict_head contains all the 'global' class, reffering to PAGE
    properties_css_dict_head = {}
    # css_dict_standard contains all the fields classes, when no error occurs
    properties_css_dict_standard = {}
    # css_dict_error contains the same thing, but in case error occurs.
    # there background is different so that users can see where the problem
    # is on the graphic view
    properties_css_dict_error = {}
    # css_dict_err_d contains coordinates and color to display text-error
    properties_css_dict_err_d = {}
    # declaring main container for all sub_dicts
    properties_css_dict = {}
    properties_css_dict['head'] = properties_css_dict_head
    properties_css_dict['standard'] = properties_css_dict_standard
    properties_css_dict['error'] = properties_css_dict_error
    properties_css_dict['err_d'] = properties_css_dict_err_d
    # return dict
    return properties_css_dict

  security.declarePublic('setPageProperties')
  def setPageProperties(self
791 792
          ,properties_css_dict
          ,page_iterator
793
          ,page_id
794
          ,page_height
Jérome Perrin's avatar
Jérome Perrin committed
795
          ,page_width
796 797 798
          ,original_page_width
          ,original_page_height
          ,width_groups,height_groups):
799 800 801 802 803 804 805
    """
    recover all CSS data relative to the current page and save these
    information in the output dict
    """
    # Processing current page for CSS data
    # getting properties
    properties_css_page = {}
806
    properties_page = {}
807 808 809 810 811 812 813 814 815 816 817
    properties_css_page['position'] = 'relative'
    # creating image class for background
    properties_css_background = {}
    # making background id
    background_id =  page_id + '_background'
    #getting properties
    properties_css_background['position'] = 'absolute'
    #creating corresponding page group to form
    if page_iterator == 0:
      # margin-top = 0 (first page)
      properties_css_page['margin-top'] = "0px"
818 819 820 821 822 823 824 825 826 827 828 829
      properties_css_background['height'] = \
        str(page_height) + 'px'
      properties_css_background['width']= \
        str (page_width) + 'px'
      properties_page['actual_width'] = width_groups[page_iterator]
      properties_page['actual_height'] = height_groups[page_iterator]
      actual_width = width_groups[page_iterator]
      actual_height = height_groups[page_iterator] 	
      #properties_css_background['margin-top'] = \
      #   str((y_pos -10))+ 'px'
      #properties_css_background['margin-left']= \
      #   str((x_pos- 5))+   'px'	
830 831
    else:
      # margin-top = page height
832 833 834 835 836 837 838 839 840
      properties_css_page['margin-top'] = "%spx" %(page_height + 20)
      properties_page['actual_width'] = width_groups[page_iterator]
      properties_page['actual_height'] = height_groups[page_iterator] 
      actual_width = width_groups[page_iterator-1]
      actual_height = height_groups[page_iterator -1]
      properties_css_background['height'] = \
        str(page_height) + 'px'
      properties_css_background['width']= \
        str (page_width) + 'px'
841 842 843 844
    # adding properties dict to global dicts
    properties_css_dict['head'][page_id] = properties_css_page
    properties_css_dict['head'][background_id] = properties_css_background
    # return updated dict
845
    return (properties_css_dict,properties_page,actual_width,actual_height)
846 847 848 849 850 851 852 853 854 855





  security.declarePublic('setFieldProperties')
  def setFieldProperties(self
            ,properties_css_dict
            ,field
            ,page_width
856 857
            ,page_height
            ,page_iterator
858
            ,page_gap
Jérome Perrin's avatar
Jérome Perrin committed
859
            ,keep_page
860 861 862
            ,original_page_width
            ,original_page_height
            ,properties_page,actual_width,actual_height):
863 864 865 866 867 868
    """
    recover all CSS data relative to the current page_object (field)
    and save these informations in the output dict
    """
    (field_name, properties_field) = field
    print "   => %s : %s" % (field_name,properties_field['rendering'])
869

870 871 872 873 874 875
    # updating field properties if necessary
    if keep_page == 1:
      # document format is 1.3.* and define object position from the top-left
      # corner of the first page, whereas the field position is expected to
      # be found from the current's page top left corner.
      # that's why Y position must be updated
876

877 878
      scaling_factor1= (page_width)/(properties_page['actual_width'])		
      scaling_factor2= (page_height)/(properties_page['actual_height'])
879

880 881
      properties_field['position_y'] = \
         str(float(properties_field['position_y']) - \
882 883
         (actual_height + page_gap)* page_iterator)

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
    # Processing object for CSS data
    # declaring dict containing all css data
    # _stand for general display
    field_dict = {}
    properties_css_object_stand = {}
    # _error when an error occurs
    properties_css_object_error = {}
    # _err_d to diplay the text error
    properties_css_object_err_d = {}
    #defining global properties
    properties_css_object_stand['position'] = 'absolute'
    properties_css_object_error['position'] = 'absolute'
    properties_css_object_err_d['position'] = 'absolute'
    properties_css_object_stand['padding'] = '0px'
    properties_css_object_error['padding'] = '0px'
    properties_css_object_err_d['padding'] = '0px'
    # getting field height
    properties_css_object_stand['height'] = \
902
        str(scaling_factor2 *float(properties_field['size_y'])) + 'px'
903
    properties_css_object_error['height'] = \
904
        str(scaling_factor2 *float(properties_field['size_y'])) + 'px'
905 906 907 908
    # defining font-size from height - 2 (this value seems to have a good
    # rendering on Mozilla and Konqueror)
    # do not match for TextArea (as it is a multiline object)
    if properties_field['type'] != 'TextAreaField':
909
      if float(properties_field['size_y']) > 8.0:
910 911 912 913 914
        properties_css_object_stand['font-size'] = \
          str((scaling_factor2 *float(properties_field['size_y']))-5.5 ) + 'px'
        properties_css_object_error['font-size'] = \
          str((scaling_factor2 *float(properties_field['size_y']))-5.5) + 'px'
      else:
915
        properties_css_object_stand['font-size'] = \
916 917
          str((scaling_factor2 *float(properties_field['size_y']))-3.5 ) + 'px'
        properties_css_object_error['font-size'] = \
918
          str((scaling_factor2 *float(properties_field['size_y']))-3.5) + 'px'
919
    else:
920
      properties_css_object_stand['font-size'] = \
921
        str(12) + 'px'
922
      properties_css_object_error['font-size'] = \
923
        str(12) + 'px'
924 925
    properties_css_object_err_d['margin-left'] = str(page_width + 20 ) + 'px'
    properties_css_object_stand['margin-top'] = \
926
      str((scaling_factor2 *float(properties_field['position_y']))) + 'px'
927
    properties_css_object_error['margin-top'] = \
928
      str((scaling_factor2 *float(properties_field['position_y']))) + 'px'
929
    properties_css_object_err_d['margin-top'] = \
930
      str((scaling_factor2 *float(properties_field['position_y']))) + 'px'
931 932 933 934 935 936 937 938 939
    # adding special text_color for text error
    properties_css_object_err_d['color'] = 'rgb(255,0,0)'
    # then getting additional properties
    if properties_field['required'] ==1:
      # field is required: using special color
      # color is specified as light-blue when standard
      # color = 'green' when error
      properties_css_object_stand['background'] = 'rgb(192,192,255)'
      properties_css_object_error['background'] = 'rgb(128,128,255)'
940 941
    elif properties_field['type'] != 'TextAreaField':
      properties_css_object_stand['background'] = '#F5F5DC'
942
      properties_css_object_error['background'] = 'rgb(255,64,64)' # Previously #B9D9D4 - should become a parameter
943
    else:
944
      properties_css_object_stand['background'] = '#F5F5DC' # Previously #B9D9D4 - should become a parameter
945 946 947 948 949 950 951 952 953 954 955 956 957
      properties_css_object_error['background'] = 'rgb(255,64,64)'

    # add completed properties (in our case only the class rendering the text
    # beside an error) to the return dict
    properties_css_dict['err_d'][field_name] = properties_css_object_err_d
    # the following variable take the number of field to render for this object
    field_nb = 1

    # now processing special rendering
    if properties_field['rendering']=='single':
      # single rendering (like StringField, TextArea, etc.).
      # Do not need any special treatment
      properties_css_object_stand['width'] = \
958
        str(scaling_factor1 *float(properties_field['size_x'])) + 'px'
959
      properties_css_object_error['width'] = \
960
        str(scaling_factor1 *float(properties_field['size_x'])) + 'px'
961
      properties_css_object_stand['margin-left'] = \
962
        str((scaling_factor1 *float(properties_field['position_x']))) + 'px'
963
      properties_css_object_error['margin-left'] = \
964
        str((scaling_factor1 *float(properties_field['position_x']))) + 'px'
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
      # in case of checkboxfield, '_class_2' is used because field is rendered
      # as two fields, the first one hidden. (supports xhtml_style)
      # UPDATE : modified because need to keep compatibility with html_style
      #if properties_field['type'] == 'CheckBoxField':
      #  field_id = field_name + '_class_2'
      #else:
      field_id = field_name + '_class'
      # adding all these properties to the global dicts
      properties_css_dict['standard'][field_id] = properties_css_object_stand
      properties_css_dict['error'][field_id] = properties_css_object_error
    else:
      sub_field_dict = {}
      field_dict = {}
      if properties_field['type'] == 'RelationStringField':
        # rendering a relationStringField, based on two input areas
        # processing rendering of the two input fields. for that
        # each has to be evaluated and the values will be saved in
        # a dict

        # uptading number of fields to render
        field_nb = 2

        #field_1 = field_name + '_class_1'
        # processing main StringField
        field_dict[1] = {}
        field_dict[1]['width'] = \
991
           str(scaling_factor1*(float(properties_field['size_x']) / 2)) + 'px'
992
        field_dict[1]['margin-left'] = \
993
           str(scaling_factor1*float(properties_field['position_x'])) + 'px'
994 995 996

        # processing secondary input picture
        field_dict[2] = {}
997
        field_dict[2]['width'] = str(scaling_factor1*(float(properties_field['size_x']) /2)) + 'px'
998
        field_dict[2]['margin-left'] = \
999 1000
              str(scaling_factor1*(float(properties_field['size_x']) /2  +\
              float(properties_field['position_x']))) + 'px'
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
      elif properties_field['type'] == 'DateTimeField':
        # rendering DateTimeField, composed at least of three input
        # areas, and their order can be changed
        print "  Type DateTimeField"

        # getting the number of fields to render and their size unit
        if properties_field['date_only'] == '0':
          print "   Option : Not Date Only"
          field_nb = 5
          # defining counting unit for fields
          # total = 6.1 units:
          # 2 > year
          # 1 > month
          # 1 > day
          # 0.1 > space between date and time
          # 1 > hour
          # 1 > minutes
          width_part = int(float(properties_field['size_x']) / 6.1)
        else: 
          print "   Option : Date Only"
          field_nb = 3
          # same as before but without hours and minutes
1023
          width_part = int((float(properties_field['size_x']) / 4))
1024 1025 1026 1027 1028 1029


        print "  input_order=%s" % properties_field['input_order']
        # defining global field rendering (for Date), ignoring for the moment
        # the whole part about the time
        if properties_field['input_order'] in \
1030
             ['day/month/year','dmy','month/day/year','mdy']:
1031 1032 1033 1034
          # specified input order. must be dd/mm/yyyy or mm/dd/yyyy (year is
          # the last field).
          # processing first field
          field_dict[1] = {}
1035
          field_dict[1]['width'] = str(scaling_factor1*float(width_part)) + 'px'
1036
          field_dict[1]['margin-left'] = \
1037
             str(scaling_factor1 *float(properties_field['position_x'])) + 'px'
1038 1039 1040

          # processing second field
          field_dict[2] = {}
1041
          field_dict[2]['width'] = str(scaling_factor1*float(width_part)) + 'px'
1042
          field_dict[2]['margin-left'] = \
1043
             str(scaling_factor1 *(float(properties_field['position_x']) + width_part)) + 'px'
1044 1045 1046

          # processing last field
          field_dict[3] = {}
1047
          field_dict[3]['width'] = str(scaling_factor1*float(width_part*2)) + 'px'
1048
          field_dict[3]['margin-left'] = \
1049
             str(scaling_factor1 *(float(properties_field['position_x']) + width_part*2)) + 'px'
1050 1051 1052 1053 1054 1055
        else:
          # all other cases, including default one (year/month/day)
          width_part = int(int(properties_field['size_x']) / 4)

          # processing year field
          field_dict[1] = {}
1056
          field_dict[1]['width'] = str(scaling_factor1*float(width_part *2)) + 'px'
1057
          field_dict[1]['margin-left'] = \
1058
             str(scaling_factor1 *float(properties_field['position_x'])) + 'px'
1059 1060 1061

          # processing second field (two digits only)
          field_dict[2] = {}
1062
          field_dict[2]['width'] = str(scaling_factor1*float(width_part)) + 'px'
1063
          field_dict[2]['margin-left'] = \
1064
            str(scaling_factor1 *(float(properties_field['position_x']) + width_part*2)) + 'px'
1065 1066 1067

          # processing day field
          field_dict[3] = {}
1068
          field_dict[3]['width'] = str(scaling_factor1*float(width_part)) + 'px'
1069
          field_dict[3]['margin-left'] = \
1070
            str(scaling_factor1 *(float(properties_field['position_x']) + width_part*3)) + 'px'
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126


        # rendering time if necessary
        if properties_field['date_only'] == '0':
          # date is specified
          print "   position_x=%s" % properties_field['position_x']
          print "   size_x=%s" % properties_field['size_x']
          field_dict[4] = {}
          field_dict[4]['width'] = str(width_part) + 'px'
          field_dict[4]['margin-left'] = \
             str(int(properties_field['position_x']) +\
             int(properties_field['size_x']) - width_part*2) + 'px'

          field_dict[5] = {}
          field_dict[5]['width'] = str(width_part) + 'px'
          field_dict[5]['margin-left'] = \
             str(int(properties_field['position_x']) +\
             int(properties_field['size_x']) - width_part) + 'px'

      # number of fields to generate
      print "\n   field_number = %s" % field_nb

      field_nb_range = field_nb + 1
      field_range = range(field_nb_range)
      field_range = field_range[1:]
      for iterator in field_range:
        # iterator take the field_id according to the field_nb
        # ie (0..field_nb)
        #iterator = it + 1
        print "   sub_field_id=%s" % iterator
        class_name = field_name + '_class_' + str(iterator)
        print "   class_name=%s" % class_name

        # managing standard class properties
        properties_css_dict['standard'][class_name] = {}
        for prop_id in properties_css_object_stand.keys():
          # saving global class properties into final dict
          properties_css_dict['standard'][class_name][prop_id] = properties_css_object_stand[prop_id]
        for prop_id in field_dict[iterator].keys():
          # then adding special field properties (usually width and position_x)
          properties_css_dict['standard'][class_name][prop_id] = field_dict[iterator][prop_id]

        # managing class error properties
        properties_css_dict['error'][class_name] = {}
        for prop_id in properties_css_object_error.keys():
          properties_css_dict['error'][class_name][prop_id] = properties_css_object_error[prop_id]
        for prop_id in field_dict[iterator].keys():
          properties_css_dict['error'][class_name][prop_id] = field_dict[iterator][prop_id]

      # final printing for testing
      print "\n\n   final printing"
      for iterator in field_range:
        class_name = field_name + '_class_' + str(iterator)
        print "    class=%s" % class_name
        for prop_id in properties_css_dict['standard'][class_name].keys():
          print "      prop:%s=%s" % (prop_id,properties_css_dict['standard'][class_name][prop_id])
1127 1128


1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
    return properties_css_dict

  security.declarePublic('setFinalProperties')
  def setFinalProperties(self
                        ,properties_css_dict
                        ,page_height):
    """
    adding 'page_end' class to add a div at the end of the last page
    in order to display the full last page under Konqueror
    Otherwize last page is cut and the user is not able to see the
    bottom of the document
    """
    properties_css_page = {}
    properties_css_page['position'] = 'relative'
    properties_css_page['margin-top'] = "%spx" % str( page_height)
    properties_css_dict['head']['page_end'] = properties_css_page
    return properties_css_dict
1146

1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
  security.declarePublic('generateOutputContent')
  def generateOutputContent(self
                     ,properties_css_dict
                     ):
    """
    return a string containing the whole content of the CSS output
    from properties_css_dict
    """
    print " createmodule > printing output from css_class_generator"
    form_css_content =  "/*-- special css form generated through ScribusUtils module     --*/\n"
    form_css_content += "/*-- to have a graphic rendering with 'form_html' page template --*/\n\n"
    form_css_content += "/* head : classes declared for general purpose */\n"
    # iterating classes in document's head
    for class_name in properties_css_dict['head'].keys():
      # getting class properties_dict
      class_properties = properties_css_dict['head'][class_name]
      # joining exerything
      output_string = "." + str(class_name) + " {" \
                      + "; ".join(["%s:%s" % (id, val) for id, val in class_properties.items()]) \
                      + "}"
      # adding current line to css_content_object
      form_css_content += output_string + "\n"
    form_css_content += "\n/* standard field classes */ \n"
    # adding standard classes
    for class_name in properties_css_dict['standard'].keys():
      class_properties = properties_css_dict['standard'][class_name]
      output_string = "." + str(class_name) + " {" \
                      + "; ".join(["%s:%s" % (id,val) for id,val in class_properties.items()]) \
                      + "}"
      form_css_content += output_string + "\n"
    form_css_content += "\n/* error field classes */\n"
    # adding error classes
    for class_name in properties_css_dict['error'].keys():
      class_properties = properties_css_dict['error'][class_name]
      output_string = "." + str(class_name) + "_error {" \
                      + "; ".join(["%s:%s" % (id,val) for id, val in class_properties.items()]) \
                      + "}"
      form_css_content += output_string + "\n"
    form_css_content += "\n/* text_error field classes */ \n"
    # adding field error classes
    for class_name in properties_css_dict['err_d'].keys():
      class_properties = properties_css_dict['err_d'][class_name]
      output_string = "." + str(class_name) + "_error_display {" \
                      + "; ".join(["%s:%s" % (id,val) for id,val in class_properties.items()]) \
                      + "}"
      form_css_content += output_string + "\n"
    # return final String
    return form_css_content
1195

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
  security.declarePublic('createOutputFile')
  def createOutputFile(self
                      ,form_css_content
                      ,form_css_id
                      ,factory):
    """
    add a new file_object in zope, named form_css_id and containing
    the form_css_content
    """
    factory.addDTMLDocument(form_css_id,"css",form_css_content)
1206 1207


Kevin Deldycke's avatar
Kevin Deldycke committed
1208 1209
class ScribusParser:
  """
1210
  Parses a Scribus file (pda) with PDF-elements inside
Kevin Deldycke's avatar
Kevin Deldycke committed
1211
  """
1212
  #declare security
Kevin Deldycke's avatar
Kevin Deldycke committed
1213
  security = ClassSecurityInfo()
1214

1215 1216 1217 1218 1219
  security.declarePublic('getObjectTooltipProperty')
  def getObjectTooltipProperty(self, check_key, default_value, object_name, object_dict):
    """
    check if 'check_key' exists in 'object_dict' and has a value
    if true, then returns this value, else returns 'default_value' and log 'object_name'
1220 1221 1222

    This function is used to get attributes'values in an object_dict and to be sure
    a compatible value is returned (for that use default value)
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
    """
    #return object_dict.get(check_key, None) or default_value
    if object_dict.has_key(check_key):
      # 'check_key' exists
      if len(object_dict[check_key]) != 0:
        # check_key corresponding value is not null
        # returning this value
        return object_dict[check_key]
      else:
        # check_key is null, logging and asigning default value
        LOG("WARNING : " + str(object_name),0,"invalid " + str(check_key) \
        + ": using " + str(default_value))
        return default_value
    else:
      # check_key is null, logging and asigning default value
      LOG("WARNING : " + str(object_name),0,"no " + str(check_key) \
      + ": using " + str(default_value))
      return default_value

1242 1243
  security.declarePublic('getXmlObjectPropertiesDict')
  def getXmlObjectsPropertiesDict(self, xml_string):
1244 1245 1246 1247 1248
    """
    takes a string containing a whole document and returns
    a full dict of 'PAGE', containing a dict of 'PAGEOBJECT',
    containing a dict of all the relative attributes
    """
1249

Kevin Deldycke's avatar
Kevin Deldycke committed
1250
    # Create DOM tree from the xml string
1251
    print " > create DOM tree"
1252
    dom_tree = minidom.parseString(xml_string)
1253

1254
    # creating the root from the input file
Kevin Deldycke's avatar
Kevin Deldycke committed
1255
    dom_root = dom_tree.documentElement
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272


    # Here two cases are possible :
    # - if the Scribus Document format is 1.2.* or less, then
    #   the 'PAGE' contains all its 'PAGEOBJECT' elements so
    # - if the Scribus Document format is 1.3.*, then the 'PAGE'
    #   does not contain any other object, and each 'PAGEOBJECT'
    #   refers to its relative page_number using its 'OwnPage'
    #   property
    keep_page = 0
    if "Version" not in dom_root.attributes.keys():
      # no version propery is contained in the document
      # the content does not comply with the Scribus document
      # specification
      print " Bad Scribus document format : no 'Version' property "
      return (None,keep_page,0)
    else:  
1273

1274 1275 1276 1277
      version = dom_root.attributes["Version"].value
      if version[:3] == "1.2" :
        # Scribus document format is 1.2
        print " found Scribus document format 1.2"
1278

1279 1280 1281
        #making a listing of all the PAGE objects
        print " > making listing of all PAGE objects"
        page_list = dom_root.getElementsByTagName("PAGE")
1282

1283
        returned_page_dict = {}
1284

1285 1286
        #for each PAGE object, searching for PAGEOBJECT
        for page in page_list:
1287

1288 1289 1290 1291 1292
          # getting page number
          # parsing method from the previous ScribusUtils
          page_number = -1
          if 'NUM' in page.attributes.keys():
            page_number = str(page.attributes['NUM'].value)
1293

1294
          print "  > PAGE NUM=" + str(page_number)
1295

1296 1297
          # making a listing of all PAGEOBJECT in a specified PAGE
          page_object_list = page.getElementsByTagName("PAGEOBJECT")
1298

1299 1300
          # initialising global output dictionary containing pages of elements
          returned_page_object_list = []
1301

1302 1303
          # for each PAGEOBJECT, building dict with atributes
          for page_object in page_object_list:
1304

1305 1306 1307 1308 1309 1310 1311
            # initialising 
            returned_page_object = {}
            field_name = ''

            #iterating PAGEOBJECT attributes
            #old parsing method employed also here
            for node_id in page_object.attributes.keys():
1312 1313
              node_name = node_id.encode('utf8')
              node_value = page_object.attributes[node_id].value.encode('utf8')
1314

1315
              returned_page_object[node_name] = node_value
1316 1317 1318 1319

              if node_name == 'ANNAME':
                if node_value != '':
                  field_name = node_value.replace(' ','_')
1320

1321 1322 1323 1324 1325
            if field_name != '' :
              #if 'PAGEOBJECT' has a valid name, then adding it to the global
              #dictionary containing all the 'PAGEOBJECT' of the 'PAGE'
              returned_page_object_list.append(returned_page_object)
              print "    > PAGEOBJECT = " + str(field_name)
1326

1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
          #after having scanned all 'PAGEOBJECT' from a 'PAGE', adding the
          #relative informations to the list of 'PAGE' before going to the next one
          #in case the page is not empty
          if len(returned_page_object_list) != 0: 
            returned_page_dict[page_number] = returned_page_object_list

        print "=> end ScribusParser.getXmlObjectPropertiesDict"
        return (returned_page_dict,keep_page,0)

        # end parsing document version 1.2.*
1337

1338 1339 1340 1341
      else:
        print " found Scribus Doucment format 1.3"
        # assuming version is compliant with 1.3.* specifications

1342
        keep_page = 1
1343

1344 1345 1346 1347
        # first of all getting DOCUMENT element to recover Scratch coordinates
        document_list = dom_root.getElementsByTagName("DOCUMENT")
        scratch_left = int(float(document_list[0].attributes["ScratchLeft"].value))
        scratch_top  = int(float(document_list[0].attributes["ScratchTop"].value))
1348 1349 1350 1351
        page_gap = int(float(document_list[0].attributes["BORDERTOP"].value))
        scribus_page_width= int(float(document_list[0].attributes["PAGEWIDTH"].value))
        scribus_page_height = \
           int(float(document_list[0].attributes["PAGEHEIGHT"].value)) 
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
        print " DOCUMENT > scratch_left = %s      scratch_top = %s" % (scratch_left,scratch_top)
        #page_list = dom_root.getElementsByTagName("PAGE")
        page_object_list = dom_root.getElementsByTagName("PAGEOBJECT")

        # iterating 'PAGE' to build the first layer of the output structure
        #for page in page_list:
        #  page_number = page

        # iterating 'PAGEOBJECT' to check compatibility (need a 'ANNAME' property)
        # and recover the related 'PAGE'
        returned_page_dict = {}
        for page_object in page_object_list:
          returned_page_object = {}
          field_name = ''
          field_OwnPage = ''
          # iterating field attributes
          for node_id in page_object.attributes.keys():
1369 1370
            node_name = node_id.encode('utf8')
            node_value = page_object.attributes[node_id].value.encode('utf8')
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396

            if node_name == 'ANNAME':
              if node_value != '':
                field_name = node_value.replace(' ','_')
                print "> found field : %s" % field_name
            elif node_name == 'OwnPage':
              field_OwnPage = node_value
            elif node_name == 'XPOS':
              print "   > updating Xpos : %s - %s = %s" % (scratch_left+int(float(node_value)),scratch_left,node_value)
              node_value = str(int(float(node_value)) - scratch_left)
            elif node_name == 'YPOS':
              print "   > updating Ypos : %s - %s = %s" % (scratch_top+int(float(node_value)),scratch_top,node_value)
              node_value = str(int(float(node_value)) - scratch_top)

            returned_page_object[node_name] = node_value

          if field_name != '':
            print " > field has the name : %s" % field_name
            # field seems to be ok, just need to check if the related page
            # already exists in the 'returned_page_dict'
            if not field_OwnPage in returned_page_dict.keys():
              # page does not exists, need to create it before adding the field
              print "  > adding new page"
              returned_page_dict[field_OwnPage] = []
            returned_page_dict[field_OwnPage].append(returned_page_object)
        return (returned_page_dict,keep_page,page_gap)
1397

Kevin Deldycke's avatar
Kevin Deldycke committed
1398

1399 1400
  security.declarePublic('getPropertiesConversionDict')
  def getPropertiesConversionDict(self, text_page_dict):
1401
    """
1402 1403 1404 1405
    takes a dict generated from 'getXmlObjectsProperties' method
    and returns a dict of PAGE including a list with usefull
    'PAGEOBJECT' attributes updated with standard attributes
    and special informations contained in the
1406
    'ANTOOLTIP' attribute.
1407

1408 1409 1410 1411 1412 1413 1414 1415
    usefull attributes are
    - position & size
    - type & inputformat (for erp5 and html)
    - creation order (using 'nb' property)
    - erp5 relative position (left, right, etc.)
    - title information
    - other properties (read_only, multiline, etc.)
    - etc.
1416

1417 1418 1419 1420 1421 1422
    for each PAGE, all PAGEOBJECT are sorted according to their creation order
    'nb'
    """

    print "\n  => ScribusParser.getPropertiesConversion"
    returned_page_dict = {}
1423

1424 1425
    # declaring ScribusParser object to run other functions
    sp = ScribusParser()
1426

1427 1428 1429 1430 1431
    for page_number in text_page_dict.keys():
      # iterating through 'PAGE' object of the document
      # id = page_number
      # content = page_content
      page_content = text_page_dict[page_number]
1432

1433
      print " => PAGE = %s" % str(page_number)
1434

1435 1436 1437 1438 1439 1440
      # declaring special lists used to generate nb for all objects
      # this 'nb' property is usefull to define the object creation order
      # all objects are sorted (has nb / has no nb) and all objects without
      # nb attribte are added t othe end of the 'has nb' list
      nb_property_nbkey_list = []
      nb_property_nonbkey_list = []
1441

1442 1443
      # declaring output object
      returned_object_dict = {}
1444

1445 1446
      # if page_content.haskey('my_fax_field')
      # print "my_fax_field"
1447
      for object_data in page_content:
1448 1449 1450
        # iterating through 'PAGEOBJECT' of the page
        # id = object_name
        # content = object_content
1451

1452 1453 1454
        object_name = object_data['ANNAME']
        del object_data['ANNAME']
        object_content = object_data
1455 1456
        multiline_field= 0
        #multiline_field= object_content['ANFLAG']
1457
        print "  => PAGEOBJECT = " + str(object_name)
1458 1459 1460
        # recovering other attributes list (string format) from 'ANTOOLTIP'
        text_tooltipfield_properties = \
           sp.getObjectTooltipProperty('ANTOOLTIP','',object_name,object_content)
1461 1462
        #recovering the page attributes

1463 1464 1465
        #declaring output file
        tooltipfield_properties_dict = {}
        #splitting the different attributes
1466 1467
        tooltipfield_properties_list =  \
                    text_tooltipfield_properties.split('#')
1468

1469
        print "      " + str(tooltipfield_properties_list)
1470

1471 1472 1473
        # test if first argument is nb according to previous
        # naming-conventions i.e composed of three digits without
        # id 'nb:' written
1474
        if  str(tooltipfield_properties_list[0]).isdigit():
1475 1476 1477
          # first value of tooltilfield is digit : assuming this is
          # a creation-order information compliant with the previous
          # naming convention
1478
          # modifying this field to make it compatible with new convention
1479 1480 1481
          print "        => first element = " + \
                str(tooltipfield_properties_list[0] + " is digit...")
          LOG("WARNING : " + str(object_name),0,"out-of-date " \
1482 1483 1484 1485 1486
             + "for tooltipfield, please check naming_conventions")
          temp_nb = tooltipfield_properties_list[0]
          # deleting actual entry
          tooltipfield_properties_list.remove(temp_nb)
          # adding new entry to the list
1487
          tooltipfield_properties_list.append( "nb:" + str(temp_nb))
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
          # end of translating work to get new standard compliant code
        for tooltipfield_property in tooltipfield_properties_list:
          #printing each property before spliting
          print "         " + str(tooltipfield_property)
          # splitting attribute_id / attribute_value
          tooltipfield_properties_split = tooltipfield_property.split(':')
          if len(tooltipfield_properties_split) == 2:
            tooltipfield_id = tooltipfield_properties_split[0]
            tooltipfield_value = tooltipfield_properties_split[1]
            # making dictionary from 'ANTOOLTIP' attributes
1498 1499
            tooltipfield_properties_dict[tooltipfield_id] = \
                        tooltipfield_value
1500
        # end of 'ANTOOLTIP' parsing
1501

1502 1503 1504 1505
        # getting usefull attributes from scribus 'PAGEOBJECT
        #and 'ANTOOLTIP'
        #
        object_properties = {} 
1506
	page_properties = {}
1507
        # getting object position and size
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
        object_properties['position_x'] = \
              sp.getObjectTooltipProperty('XPOS',
                                          '0',
                                          object_name,
                                          object_content)
        object_properties['position_y'] = \
              sp.getObjectTooltipProperty('YPOS',
                                          '0',
                                          object_name,
                                          object_content)
        object_properties['size_x'] = \
             sp.getObjectTooltipProperty('WIDTH',
                                         '100',
                                         object_name,
                                         object_content)
        object_properties['size_y'] = \
              sp.getObjectTooltipProperty('HEIGHT',
1525
                                           '17',
1526 1527
                                          object_name,
                                          object_content)
1528

1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
        # converting values to integer-compliant to prevent errors
        # when using them for that converting from 'str' -> 'float'
        # -> 'int' -> 'str'
        object_properties['position_x'] = \
              str(int(float(object_properties['position_x'])))
        object_properties['position_x'] = \
              str(int(float(object_properties['position_x'])))
        object_properties['position_y'] = \
              str(int(float(object_properties['position_y'])))
        object_properties['size_x'] = \
              str(int(float(object_properties['size_x'])))
        object_properties['size_y'] = \
              str(int(float(object_properties['size_y'])))
1542

1543 1544
        # getting object title
        # object title can only be user-specified in the 'tooltip' dict
1545 1546 1547 1548 1549
        object_properties['title'] = \
              sp.getObjectTooltipProperty('title',
                                          object_name,
                                          object_name,
                                          tooltipfield_properties_dict)
1550

1551
        # getting object order position for erp5 form
1552 1553 1554 1555 1556 1557
        temp_order = \
            sp.getObjectTooltipProperty('order',
                                        'none',
                                        object_name,
                                        tooltipfield_properties_dict)

1558 1559
        if temp_order not in  ['left','right']:
          # temp_order invalid
1560 1561
          # trying to get it from its position in original Scribus file
          if int(object_properties['position_x']) > 280.0 :
1562 1563 1564 1565 1566 1567
            temp_order = 'right'
          else :
            temp_order = 'left'
        object_properties['order'] =  temp_order

        # getting special ANFLAG sub-properties
1568 1569 1570 1571
        temp_ANFLAG = long(sp.getObjectTooltipProperty('ANFLAG',
                                                       0,
                                                       object_name,
                                                       object_content))
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
        # initialising results
        anflag_properties = {}
        anflag_properties['noScroll'] = 0
        anflag_properties['noSpellCheck'] = 0
        anflag_properties['editable'] = 0
        anflag_properties['password'] = 0
        anflag_properties['multiline'] = 0
        anflag_properties['noExport'] = 0
        anflag_properties['required'] = 0
        anflag_properties['readOnly'] = 0
        # analysing result
1583 1584 1585 1586
        print "      => ANFLAG = " + str(temp_ANFLAG)
        # These tests uses some special variables
        # defined at the begining of the script
        if temp_ANFLAG - long(def_noScroll) >= 0:
1587
          # substracting value
1588
          temp_ANFLAG = temp_ANFLAG - long(def_noScroll)
1589 1590 1591
          # 'do not scroll' field
          # adding property
          anflag_properties['noscroll'] = 1
1592 1593
        if temp_ANFLAG - long(def_noSpellCheck) >= 0:
          temp_ANFLAG = temp_ANFLAG - long(def_noSpellCheck)
1594 1595
          # 'do not spell check' field
          anflag_properties['noSpellCheck'] = 1
1596 1597
        if temp_ANFLAG - long(def_editable) >= 0:
          temp_ANFLAG = temp_ANFLAG - long(def_editable)
1598 1599
          # 'editable' field
          anflag_properties['editable'] = 1
1600 1601
        if temp_ANFLAG - long(def_password) >= 0:
          temp_ANFLAG = temp_ANFLAG - long(def_password)
1602 1603
          # 'password' field
          anflag_properties['password'] = 1
1604 1605
        if temp_ANFLAG - long(def_multiLine) >= 0:
          temp_ANFLAG = temp_ANFLAG - long(def_multiLine)
1606 1607
          # 'multiline' field
          anflag_properties['multiline'] = 1
1608 1609
        if temp_ANFLAG - long(def_noExport) >= 0:
          temp_ANFLAG = temp_ANFLAG - long(def_noExport)
1610 1611
          # 'do not export data' field
          anflag_properties['noExport'] = 1
1612 1613
        if temp_ANFLAG - long(def_required) >= 0:
          temp_ANFLAG = temp_ANFLAG - long(def_required)
1614 1615
          # 'required field
          anflag_properties['required'] = 1
1616
        if temp_ANFLAG == long(def_readOnly):
1617 1618
          # 'read only" field
          anflag_properties['readOnly'] = 1
Kevin Deldycke's avatar
Kevin Deldycke committed
1619

1620
        # getting maximum number of caracters the field can hold
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
        # note : only used for textfields ('StringField', 'IntegerField',
        # 'FloatField', etc.)
        # first checking user specifications in tooltipfield
        object_properties['maximum_input'] = \
              sp.getObjectTooltipProperty('maximum_input',
                                        0,
                                        object_name,
                                        tooltipfield_properties_dict)
        # if returned value is empty, then trying 'ANMC' Scribus property
        if object_properties['maximum_input'] == 0:
          object_properties['maximum_input'] = \
                sp.getObjectTooltipProperty('ANMC',
                                            '0',
                                            object_name,
                                            object_content)
1636
        print "      => MaxInput = %s" % object_properties['maximum_input']
1637

1638 1639 1640
        # getting object type :
        # first checking for user-specified type in 'tooltip' properties
        if tooltipfield_properties_dict.has_key('type'):
1641 1642
          # 'type' id in tooltip : using it and ignoring other 'type'
          # information in scribus properties
1643
          object_properties['type'] = tooltipfield_properties_dict['type']
1644 1645 1646 1647 1648 1649
        elif tooltipfield_properties_dict.has_key('title_item'):
          # if page_object has a special attribute 'title_item' this means
          # the field is a CheckBoxField
          object_properties['type'] = 'CheckBoxField'
        # if no user-specified type has been found, trying to
        # find scribus-type  
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
        elif object_content.has_key('ANTYPE'):
          # from scribus type (selected in the scribus PDF-form properties)
          object_type = str(object_content['ANTYPE'])
          if object_type == '2':
            #type 2 = PDF-Button
            object_properties['type'] = 'Button'
          elif object_type == '3':
            #type 3 = PDF-Text : Stringfield by default
            object_properties['type'] = 'StringField'
            if anflag_properties['multiline'] == 1:
              # Stringfield is multiline, converting to TextAreaField
              object_properties['type'] = 'TextAreaField'
            elif object_content.has_key('ANFORMAT'):
              object_format = str(object_content['ANFORMAT'])
              # checking kind of Stringfield
              if object_format == '1':
                #type is number
                object_properties['type'] = 'IntegerField'
              elif object_format == '2':
                #type is percentage
                object_properties['type'] = 'FloatField'
              elif object_format == '3':
                #type is date
                object_properties['type'] = 'DateTimeField'
              elif object_format == '4':
                #type is time
                object_properties['type'] = 'DateTimeField'
          elif object_type == '4':
            # type 4 = PDF-Checkbox
            object_properties['type'] = 'CheckBoxField'
          elif object_type == '5':
            # type 5 = PDF-Combobox
            object_properties['type'] = 'ComboBox'
          elif object_type == '6':
            # type 6 = PDF-ListBox
            object_properties['type'] = 'ListBox'
        else:
1687 1688 1689 1690 1691 1692 1693
          # object type not found in user-properties neither in
          # document-properties. logging and initialising with
          # default type
          LOG("WARNING : " + str(object_name),
              0,
              "no 'type' found, please check your document properties")
          print "      => no type specified :  default = StringField" 
1694 1695
          object_properties['type'] = 'StringField'
        print "      type = " + str(object_properties['type'])
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711


        # getting data_type relative to object type (used in
        # object property_sheet to save field value.
        object_properties['data_type'] = 'string'
        object_properties['default_data'] = ''
        if object_properties['type'] == 'IntegerField':
          object_properties['data_type'] = 'int'
          object_properties['default_data'] = 0
        if object_properties['type'] == 'CheckBoxField':
          object_properties['data_type'] = 'boolean'
          object_properties['default_data'] = 0
        if object_properties['type'] == 'DateTimeField':
          object_properties['data_type'] = 'date'
          object_properties['default_data'] = '1970/01/01'

1712
        # getting 'required' property
1713 1714 1715 1716 1717 1718 1719
        # checking for user data in tooltipfield. if nothing found then
        # taking hard-written value in anflag properties
        object_properties['required'] = \
            sp.getObjectTooltipProperty('required',
                                        anflag_properties['required'],
                                        object_name,
                                        tooltipfield_properties_dict)
1720

1721
        # getting type properties for special types
1722 1723
        object_properties['rendering'] = 'single'
        # Stringfields handle properties
1724 1725 1726
        # checkbox objects belongs to a group of checkbox
        if str(object_properties['type']) == 'CheckBox' :
          # checking if THIS checkbox is in a group
1727 1728 1729 1730 1731 1732 1733 1734 1735
          object_properties['group'] = \
                sp.getObjectTooltipProperty('group',
                                            '0',
                                            object_name,
                                            tooltipfield_properties_dict)
          print "      group = " + str(object_properties['group'])  
        # object is listbox, and listbox have several possible values
        # WARNING listbox have not been tested in graphic rendering for
        # the moment. is there any use for listbox in PDF-like rendering ?
1736
        if str(object_properties['type']) == 'ListBox' :
1737 1738 1739 1740 1741 1742 1743
          # checking if this listbox has different possible values
          object_properties['items'] = \
                sp.getObjectTooltipProperty('items',
                                            '',
                                            object_name,
                                            tooltipfield_properties_dict)
        # object is datetimefield and need several informations
1744
        if str(object_properties['type']) == 'DateTimeField':
1745 1746 1747 1748 1749 1750 1751 1752
          # has been tested successfully
          object_properties['rendering'] = 'multiple'
          # checking if field has input_order property
          object_properties['input_order'] = \
                sp.getObjectTooltipProperty('input_order',
                                            'ymd',
                                            object_name,
                                            tooltipfield_properties_dict)
1753

1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
          # checking if field has date_only property
          object_properties['date_only'] = \
                sp.getObjectTooltipProperty('date_only',
                                            '1',
                                            object_name,
                                            tooltipfield_properties_dict)

          # checking if special date separator is specified
          # most of PDF forms already have '/' character to differenciate
          # date fields, in this case no separator is needed and the script
          # will automatically insert ' ' between element.
          # > this value is not used in ScribusUtils.py , but in PDFForm.py
          # when creating the fdf file to fill the PDF form.
          object_properties['date_separator'] = \
                sp.getObjectTooltipProperty('date_separator',
                                            '  ',
                                            object_name,
                                            tooltipfield_properties_dict)
          object_properties['time_separator'] = \
                sp.getObjectTooltipProperty('time_separator',
                                            '  ',
                                            object_name,
                                            tooltipfield_properties_dict)
1777

1778
        # object is relationstringfield and needs some information
1779
        if str(object_properties['type']) == 'RelationStringField':
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
          # has been tested successfully
          object_properties['rendering'] = 'multiple'
          object_properties['portal_type'] = \
                sp.getObjectTooltipProperty('portal_type',
                                            '0',
                                            object_name,
                                            tooltipfield_properties_dict)
          object_properties['base_category'] = \
                sp.getObjectTooltipProperty('base_category',
                                            '0',
                                            object_name,
                                            tooltipfield_properties_dict)
          object_properties['catalog_index'] = \
                sp.getObjectTooltipProperty('catalog_index',
                                            '0',
                                            object_name,
                                            tooltipfield_properties_dict)
          object_properties['default_module'] = \
                sp.getObjectTooltipProperty('default_module',
                                            '0',
                                            object_name,
                                            tooltipfield_properties_dict)
1802

1803 1804
        # getting creation order from 'tooltip' properties
        # used to create ERP5 objects in a special order
1805 1806
        if tooltipfield_properties_dict.has_key('nb') and \
           str(tooltipfield_properties_dict['nb']).isdigit():
1807 1808 1809
          # object has a nb properties containing its creation position
          # adding the object in the ordered list
          nb_value = int(tooltipfield_properties_dict['nb'])
1810 1811
          print "      =>'nb' property specified : using it"
          print "         > len(list)=%s" % len(nb_property_nbkey_list)
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
          # iterating through existing list to find right position
          # before inserting value
          if len(nb_property_nbkey_list) == 0:
            print "    => 'nb' list empty : adding without sorting"
            # list is empty : adding value without sort
            nb_property_nbkey_list.insert(0,(nb_value,object_name))
          elif nb_property_nbkey_list[len(nb_property_nbkey_list)-1][0] <= nb_value:
            print "    => 'nb' end : adding at the end"
            # last element is smaller than new element : adding at the end
            nb_property_nbkey_list.append((nb_value,object_name))
          else:
            print "    => checking for place to add the element"
            # searching where to insert the element in the ordered list
            for temp_key in range(len(nb_property_nbkey_list)):
              temp_value = nb_property_nbkey_list[temp_key][0]
              temp_content = nb_property_nbkey_list[temp_key][1]
              print "      @" + str(temp_key) + " temp=" + str(temp_value) + "/" + str(nb_value)
              if nb_value < temp_value:
                #first position where actual 'nb' is smaller than temp 'nb'
                # inserting new couple (nb_value,object_name) here
                print "      inserting here : " + str(temp_value) + "/" + str(nb_value)
                nb_property_nbkey_list.insert(temp_key,(nb_value,object_name))
                # element has been insered , no need to continue the search => breaking
                break
        else:
          # object has no nb property. logging and adding it to the list of
          # nb-less objects. Script will automatically find a 'nb' value for this element
          LOG("WARNING : " + str(object_name),0,"no 'nb' defined : finding a free slot")
          print "      => no 'nb' property specified : post-processing will try to define one"
          nb_property_nonbkey_list.append(object_name)
1842

1843 1844 1845
        # adding current object with its relative properties to the dict
        # before going to the next page_object
        returned_object_dict[object_name] = object_properties
1846

1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
      # final processing before returning full page with modified
      # page_object_properties : setting 'nb' property to all objects
      # without user-specified 'nb' property
      for object_name in nb_property_nonbkey_list:
        # listing all objects with no 'nb' declared
        # defining final position in output list : absolute pos + relative pos
        object_position = len(nb_property_nbkey_list) + 1 
        # and addind it to the end of the final nb-list
        # to give them a 'nb' property
        nb_property_nbkey_list.append((object_position,object_name))
1857
        print "    => 'nb' found for %s : %s" % (object_name,object_position)
1858

1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869
      # now all page_object are referenced in the list, we just need to sort
      # the elements in the good order. for that a new list of objects is needed
      returned_object_list = []
      for nb_ind in range(len(nb_property_nbkey_list)):
        # iterating through final nb-list
        # getting list-object information
        (nb_key, nb_value) = nb_property_nbkey_list[nb_ind]
        # setting object's 'nb' property
        returned_object_dict[nb_value]['nb'] = nb_ind + 1
        # add the object at the end of the new list
        returned_object_list.append((nb_value,returned_object_dict[nb_value]))
1870

1871 1872 1873
      # adding returned list of object to the page dict
      # before going to the next page
      returned_page_dict[page_number] = returned_object_list
1874

1875 1876
    # returning final dict containing all the modified data
    print "  => end ScribusParser.getPropertiesConversion"
1877
    return (returned_page_dict)
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891

  security.declarePublic('initFieldDict')
  def initFieldDict(self):
    """
    initialize the global_properties dict. this dict will be filled
    with Field attributes (from getFieldAttributes)
    """
    # initializing sub dicts and attributes
    global_object_dict = {}
    global_page_number = 0
    # defining main dict
    global_properties = {}
    global_properties['object'] = global_object_dict
    global_properties['page'] = global_page_number
1892 1893
    global_properties['page_width']= 595
    global_properties['page_height']= 842
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
    # return final main dict
    return global_properties




  security.declarePublic('getFieldAttributes')
  def getFieldAttributes(self,
                         field,
                         option_html,
                         page_id,
                         global_properties
                         ):
    """
    get only useful field attributes from properties_field
    and save them in global_properties
    """
    (id,properties_field) = field
    # declaring dict to store data
    object_dict = {}
    # getting usefull properties for field generation
    object_dict['title'] = str(properties_field['title'])
    object_dict['erp_type'] = str(properties_field['type'])
    object_dict['data_type'] = str(properties_field['data_type'])
    object_dict['default'] = properties_field['default_data']
    object_dict['nb'] = str(properties_field['nb'])
    object_dict['attributes'] = {}
    if option_html ==1:
      # pdf-like rendering
      object_dict['order'] = page_id
    else:
      # erp rendering
      object_dict['order'] = properties_field['order']
    # recovering attributes
    # required attribute specify if the user has to fill this field
    object_dict['attributes']['required'] =\
               properties_field['required']
    # max number of caracters that can be entered in a field
    # only used with String fieds (including Integer and Float fields)
    if 'maximum_input' in properties_field.keys():
      if 'display_maxwidth' in object_dict['attributes'].keys():
        object_dict['attributes']['display_maxwidth'] = \
                 int(properties_field['maximum_input'])
        # can only be effective without css class, i.e only effective
        # in a ERP5-like rendering
      if 'display_width' in object_dict['attributes'].keys():
        object_dict['attributes']['display_width'] = \
                 int(properties_field['maximum_width'])

    # getting special properties for DateTimeField objects
    if object_dict['erp_type'] == 'DateTimeField':
      # recovering ERP equivalent for user's input_order
      if properties_field['input_order'] in ['day/month/year','dmy']:
        object_dict['attributes']['input_order'] = 'dmy'
      elif properties_field['input_order'] in ['month/day/year','mdy']:
        object_dict['attributes']['input_order'] = 'mdy'
      elif properties_field['input_order'] in ['year/month/day','ymd']:
        object_dict['attributes']['input_order'] = 'ymd'
      else:
        print "   found incompatible 'input_order', assuming default ymd"
        object_dict['attributes']['input_order'] = 'ymd'
      # checking if date only or date + time
      object_dict['attributes']['date_only'] = int(properties_field['date_only'])
      if option_html == 1:
        # defining default separators to '' to prevent bug when rendering in
        # graphic mode
        object_dict['attributes']['date_separator'] = ''
        object_dict['attributes']['time_separator'] = ''
      else:
        # rendering is ERP5 type, can keep the final date and time separators
        object_dict['attributes']['date_separator'] = properties_field['date_separator']
        object_dict['attributes']['time_separator'] = properties_field['time_separator']
    # getting special attributes for RelationStringField
    elif object_dict['erp_type'] == 'RelationStringField':
      portal_type_item = properties_field['portal_type'].capitalize()
      object_dict['attributes']['portal_type'] =\
                 [(portal_type_item,portal_type_item)]
      object_dict['attributes']['base_category'] =\
                 properties_field['base_category']
      object_dict['attributes']['catalog_index'] =\
                 properties_field['catalog_index']
      object_dict['attributes']['default_module'] =\
                 properties_field['default_module']
    # idem : special field concerning RadioField (not tested)
    elif object_dict['erp_type'] == 'RadioField':
      # radio fields have not been tested for the moment
      items = []
      for word_item in properties_field['item'].split('|'):
        items.append((word_item,word_item.capitalize()))
      object_dict['attributes'] = items
    #elif object_dict['erp_type'] == 'CheckBoxField':
      # checkboxfield needs to have their field data updated
      # this is not done automatically so it is needed to do
      # it manually

    # save attributes to the global_properties dict
    global_properties['object'][id] = object_dict

Kevin Deldycke's avatar
Kevin Deldycke committed
1992 1993 1994 1995
  security.declareProtected('Import/Export objects', 'getContentFile')
  def getContentFile(self, file_descriptor):
    """ Get file content """
    return file_descriptor.read()
1996 1997 1998 1999
  security.declareProtected('Import/Export objects', 'getFileOpen')
  def getFileOpen(self, file_descriptor):
    """ Get file content """
    return file_descriptor.open('r')
Kevin Deldycke's avatar
Kevin Deldycke committed
2000 2001 2002
  
InitializeClass(ScribusParser)
allow_class(ScribusParser)  
2003 2004 2005 2006 2007 2008 2009 2010 2011

InitializeClass(ManageCSS)
allow_class(ManageCSS)

InitializeClass(ManageFiles)
allow_class(ManageFiles)

InitializeClass(ManageModule)
allow_class(ManageModule)