collective.documentgenerator 3.46__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- collective/documentgenerator/AT_renderer.py +98 -0
- collective/documentgenerator/DX_renderer.py +52 -0
- collective/documentgenerator/__init__.py +17 -0
- collective/documentgenerator/adapters.py +23 -0
- collective/documentgenerator/browser/__init__.py +0 -0
- collective/documentgenerator/browser/actionspanel.py +19 -0
- collective/documentgenerator/browser/check_pod_templates.pt +63 -0
- collective/documentgenerator/browser/children_pod_template.pt +16 -0
- collective/documentgenerator/browser/configure.zcml +220 -0
- collective/documentgenerator/browser/controlpanel.py +159 -0
- collective/documentgenerator/browser/converter.py +43 -0
- collective/documentgenerator/browser/generation_view.py +532 -0
- collective/documentgenerator/browser/overrides.py +9 -0
- collective/documentgenerator/browser/resources/css/documentgenerator.css +133 -0
- collective/documentgenerator/browser/static/.gitkeep +0 -0
- collective/documentgenerator/browser/static/configurable.svg +1232 -0
- collective/documentgenerator/browser/static/csv.svg +521 -0
- collective/documentgenerator/browser/static/doc.svg +23 -0
- collective/documentgenerator/browser/static/docx.svg +20 -0
- collective/documentgenerator/browser/static/download_icon.svg +54 -0
- collective/documentgenerator/browser/static/libreoffice-blanck.svg +481 -0
- collective/documentgenerator/browser/static/mailinglooptemplate.svg +1207 -0
- collective/documentgenerator/browser/static/missing_use.svg +42 -0
- collective/documentgenerator/browser/static/nok.svg +38 -0
- collective/documentgenerator/browser/static/nok_use.svg +38 -0
- collective/documentgenerator/browser/static/nok_used.svg +38 -0
- collective/documentgenerator/browser/static/odp.svg +1264 -0
- collective/documentgenerator/browser/static/ods.svg +1354 -0
- collective/documentgenerator/browser/static/odt.svg +1347 -0
- collective/documentgenerator/browser/static/ok.svg +38 -0
- collective/documentgenerator/browser/static/ok_use.svg +38 -0
- collective/documentgenerator/browser/static/ok_used.svg +38 -0
- collective/documentgenerator/browser/static/pdf.svg +557 -0
- collective/documentgenerator/browser/static/podtemplate.svg +1197 -0
- collective/documentgenerator/browser/static/rtf.svg +521 -0
- collective/documentgenerator/browser/static/style.svg +1207 -0
- collective/documentgenerator/browser/static/subtemplate.svg +1250 -0
- collective/documentgenerator/browser/static/xls.svg +159 -0
- collective/documentgenerator/browser/static/xlsx.svg +48 -0
- collective/documentgenerator/browser/table.py +277 -0
- collective/documentgenerator/browser/templates_listing.pt +23 -0
- collective/documentgenerator/browser/views.py +365 -0
- collective/documentgenerator/config.py +162 -0
- collective/documentgenerator/configure.zcml +41 -0
- collective/documentgenerator/content/__init__.py +0 -0
- collective/documentgenerator/content/condition.py +60 -0
- collective/documentgenerator/content/conditions.zcml +29 -0
- collective/documentgenerator/content/configure.zcml +25 -0
- collective/documentgenerator/content/document_factory.py +73 -0
- collective/documentgenerator/content/file_representation.py +73 -0
- collective/documentgenerator/content/file_representation.zcml +28 -0
- collective/documentgenerator/content/merge_templates.py +15 -0
- collective/documentgenerator/content/merge_templates.zcml +10 -0
- collective/documentgenerator/content/pod_template.py +547 -0
- collective/documentgenerator/content/style_template.py +52 -0
- collective/documentgenerator/content/vocabulary.py +315 -0
- collective/documentgenerator/content/vocabulary.zcml +104 -0
- collective/documentgenerator/demo/__init__.py +0 -0
- collective/documentgenerator/demo/archetypes.zcml +10 -0
- collective/documentgenerator/demo/configure.zcml +19 -0
- collective/documentgenerator/demo/helper.py +198 -0
- collective/documentgenerator/events/__init__.py +0 -0
- collective/documentgenerator/events/configure.zcml +30 -0
- collective/documentgenerator/events/pod_templates_events.py +66 -0
- collective/documentgenerator/events/styles_events.py +122 -0
- collective/documentgenerator/helper/__init__.py +9 -0
- collective/documentgenerator/helper/archetypes-adapter.zcml +10 -0
- collective/documentgenerator/helper/archetypes-page.zcml +9 -0
- collective/documentgenerator/helper/archetypes.py +67 -0
- collective/documentgenerator/helper/base.py +266 -0
- collective/documentgenerator/helper/configure.zcml +38 -0
- collective/documentgenerator/helper/dexterity.py +174 -0
- collective/documentgenerator/interfaces.py +165 -0
- collective/documentgenerator/locales/collective.documentgenerator.pot +564 -0
- collective/documentgenerator/locales/es/LC_MESSAGES/collective.documentgenerator.po +572 -0
- collective/documentgenerator/locales/es/LC_MESSAGES/plone.po +32 -0
- collective/documentgenerator/locales/fr/LC_MESSAGES/collective.documentgenerator.po +566 -0
- collective/documentgenerator/locales/fr/LC_MESSAGES/plone.po +27 -0
- collective/documentgenerator/locales/manual.pot +30 -0
- collective/documentgenerator/locales/plone-manual.pot +22 -0
- collective/documentgenerator/locales/plone.pot +30 -0
- collective/documentgenerator/locales/update.sh +22 -0
- collective/documentgenerator/migrations/__init__.py +0 -0
- collective/documentgenerator/migrations/migrate_to_11.py +53 -0
- collective/documentgenerator/migrations/migrate_to_12.py +30 -0
- collective/documentgenerator/migrations/migrate_to_13.py +37 -0
- collective/documentgenerator/migrations/migrate_to_3.py +36 -0
- collective/documentgenerator/migrations/migrate_to_5.py +30 -0
- collective/documentgenerator/migrations/migrate_to_6.py +27 -0
- collective/documentgenerator/migrations/migrate_to_7.py +32 -0
- collective/documentgenerator/migrations/migrate_to_8.py +34 -0
- collective/documentgenerator/migrations/migrate_to_9.py +48 -0
- collective/documentgenerator/profiles/base/browserlayer.xml +7 -0
- collective/documentgenerator/profiles/base/controlpanel.xml +20 -0
- collective/documentgenerator/profiles/base/metadata.xml +7 -0
- collective/documentgenerator/profiles/base/types/ConfigurablePODTemplate.xml +43 -0
- collective/documentgenerator/profiles/base/types/MailingLoopTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types/PODTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types/StyleTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types/SubTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types.xml +10 -0
- collective/documentgenerator/profiles/base/viewlets.xml +6 -0
- collective/documentgenerator/profiles/demo/browserlayer.xml +7 -0
- collective/documentgenerator/profiles/demo/collectivedocumentgenerator_demo_marker.txt +0 -0
- collective/documentgenerator/profiles/demo/import_steps.xml +11 -0
- collective/documentgenerator/profiles/demo/metadata.xml +7 -0
- collective/documentgenerator/profiles/demo/registry.xml +13 -0
- collective/documentgenerator/profiles/demo/templates/mailing.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/modele_general.ods +0 -0
- collective/documentgenerator/profiles/demo/templates/modele_general.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/mod/303/250le_collection.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/possibly_mailed_model.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/styles.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/styles_2.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/sub_template.odt +0 -0
- collective/documentgenerator/profiles/demo/viewlets.xml +3 -0
- collective/documentgenerator/profiles/plone4/collectivedocumentgenerator_marker.txt +0 -0
- collective/documentgenerator/profiles/plone4/cssregistry.xml +11 -0
- collective/documentgenerator/profiles/plone4/metadata.xml +7 -0
- collective/documentgenerator/profiles/plone4/registry.xml +6 -0
- collective/documentgenerator/profiles/plone5/metadata.xml +7 -0
- collective/documentgenerator/profiles/plone5/registry.xml +15 -0
- collective/documentgenerator/profiles/testing/metadata.xml +7 -0
- collective/documentgenerator/profiles/testing/propertiestool.xml +5 -0
- collective/documentgenerator/profiles/testing/types/member.xml +85 -0
- collective/documentgenerator/profiles/testing/types.xml +5 -0
- collective/documentgenerator/profiles.zcml +186 -0
- collective/documentgenerator/renderer.zcml +145 -0
- collective/documentgenerator/search_replace/__init__.py +0 -0
- collective/documentgenerator/search_replace/configure.zcml +19 -0
- collective/documentgenerator/search_replace/pod_template.py +146 -0
- collective/documentgenerator/search_replace/search_result_form.pt +48 -0
- collective/documentgenerator/search_replace/searchreplace_panel.pt +22 -0
- collective/documentgenerator/search_replace/searchreplace_panel.py +261 -0
- collective/documentgenerator/setuphandlers.py +287 -0
- collective/documentgenerator/testing.py +324 -0
- collective/documentgenerator/testing.zcml +16 -0
- collective/documentgenerator/tests/__init__.py +0 -0
- collective/documentgenerator/tests/failing_template.odt +0 -0
- collective/documentgenerator/tests/robot/.gitkeep +0 -0
- collective/documentgenerator/tests/template_to_clean.odt +0 -0
- collective/documentgenerator/tests/template_without_style_page.odt +0 -0
- collective/documentgenerator/tests/test_AT_helper_view.py +276 -0
- collective/documentgenerator/tests/test_DX_helper_view.py +355 -0
- collective/documentgenerator/tests/test_base_helper_view.py +128 -0
- collective/documentgenerator/tests/test_check_podtemplates_view.py +138 -0
- collective/documentgenerator/tests/test_config.py +106 -0
- collective/documentgenerator/tests/test_configurable_pod_template.py +383 -0
- collective/documentgenerator/tests/test_demo_profile.py +115 -0
- collective/documentgenerator/tests/test_events.py +169 -0
- collective/documentgenerator/tests/test_file.odt +0 -0
- collective/documentgenerator/tests/test_generation_view.py +652 -0
- collective/documentgenerator/tests/test_mailing.odt +0 -0
- collective/documentgenerator/tests/test_mailing_loop_template.py +48 -0
- collective/documentgenerator/tests/test_pod_template.py +178 -0
- collective/documentgenerator/tests/test_robot.py +26 -0
- collective/documentgenerator/tests/test_search_replace.py +419 -0
- collective/documentgenerator/tests/test_setup.py +49 -0
- collective/documentgenerator/tests/test_style_template.py +19 -0
- collective/documentgenerator/tests/test_sub_template.py +49 -0
- collective/documentgenerator/tests/test_templates_listing_view.py +91 -0
- collective/documentgenerator/tests/test_utils.py +244 -0
- collective/documentgenerator/tests/test_vocabulary.py +154 -0
- collective/documentgenerator/utils.py +396 -0
- collective/documentgenerator/viewlets/__init__.py +0 -0
- collective/documentgenerator/viewlets/batchactions.py +14 -0
- collective/documentgenerator/viewlets/configure.zcml +16 -0
- collective/documentgenerator/viewlets/generationlinks.pt +28 -0
- collective/documentgenerator/viewlets/generationlinks.py +58 -0
- collective.documentgenerator-3.46-py3.13-nspkg.pth +1 -0
- collective_documentgenerator-3.46.dist-info/METADATA +1142 -0
- collective_documentgenerator-3.46.dist-info/RECORD +176 -0
- collective_documentgenerator-3.46.dist-info/WHEEL +5 -0
- collective_documentgenerator-3.46.dist-info/entry_points.txt +5 -0
- collective_documentgenerator-3.46.dist-info/namespace_packages.txt +1 -0
- collective_documentgenerator-3.46.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
from appy.bin.odfsub import Sub
|
|
4
|
+
from collective.documentgenerator.events.styles_events import update_PODtemplate_styles
|
|
5
|
+
from collective.documentgenerator.utils import clean_notes
|
|
6
|
+
from collective.documentgenerator.utils import create_temporary_file
|
|
7
|
+
from collective.documentgenerator.utils import remove_tmp_file
|
|
8
|
+
from imio.helpers.content import get_modified_attrs
|
|
9
|
+
from plone import api
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def podtemplate_created(pod_template, event):
|
|
13
|
+
set_initial_md5(pod_template, event)
|
|
14
|
+
# clean notes, will only update odt_file if any notes cleaned
|
|
15
|
+
clean_notes(pod_template)
|
|
16
|
+
pod_template.add_parent_pod_annotation()
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def podtemplate_modified(pod_template, event):
|
|
20
|
+
# add or remove annotation from pod template is managed in the setter
|
|
21
|
+
update_PODtemplate_styles(pod_template, event)
|
|
22
|
+
# clean notes, will only update odt_file if any notes cleaned
|
|
23
|
+
# only clean if odt_file changed, as it is a file, for now even
|
|
24
|
+
# when not changed, it is in mod_attrs... maybe working better newer versions...
|
|
25
|
+
mod_attrs = get_modified_attrs(event)
|
|
26
|
+
if "odt_file" in mod_attrs:
|
|
27
|
+
clean_notes(pod_template)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
def podtemplate_will_be_removed(pod_template, event):
|
|
31
|
+
pod_template.del_parent_pod_annotation()
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def set_initial_md5(pod_template, event):
|
|
35
|
+
"""
|
|
36
|
+
Set the md5 of the initial document template in 'initial_md5' field.
|
|
37
|
+
"""
|
|
38
|
+
md5 = pod_template.current_md5
|
|
39
|
+
if not pod_template.initial_md5:
|
|
40
|
+
pod_template.initial_md5 = md5
|
|
41
|
+
pod_template.style_modification_md5 = md5
|
|
42
|
+
update_PODtemplate_styles(pod_template, event)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
def apply_default_page_style_for_mailing(pod_template, event):
|
|
46
|
+
"""
|
|
47
|
+
"""
|
|
48
|
+
force_style = api.portal.get_registry_record(
|
|
49
|
+
'collective.documentgenerator.browser.controlpanel.'
|
|
50
|
+
'IDocumentGeneratorControlPanelSchema.force_default_page_style_for_mailing'
|
|
51
|
+
)
|
|
52
|
+
if not force_style or not getattr(pod_template, 'mailing_loop_template', None):
|
|
53
|
+
return
|
|
54
|
+
|
|
55
|
+
filename = pod_template.odt_file.filename
|
|
56
|
+
# copy the pod template on the file system.
|
|
57
|
+
template_file = create_temporary_file(initial_file=pod_template.odt_file, base_name=filename)
|
|
58
|
+
|
|
59
|
+
appy_sub = Sub(check=False, path=template_file.name)
|
|
60
|
+
appy_sub.run()
|
|
61
|
+
|
|
62
|
+
with open(template_file.name, "r") as new_template_file:
|
|
63
|
+
pod_template.odt_file.data = new_template_file.read()
|
|
64
|
+
|
|
65
|
+
# Delete the temp folder
|
|
66
|
+
remove_tmp_file(template_file.name)
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
from appy.shared.utils import executeCommand
|
|
4
|
+
from collective.documentgenerator import _
|
|
5
|
+
from collective.documentgenerator import config
|
|
6
|
+
from collective.documentgenerator.content.pod_template import IPODTemplate
|
|
7
|
+
from collective.documentgenerator.utils import create_temporary_file
|
|
8
|
+
from collective.documentgenerator.utils import remove_tmp_file
|
|
9
|
+
from plone import api
|
|
10
|
+
from plone.namedfile.file import NamedBlobFile
|
|
11
|
+
from Products.CMFPlone.utils import safe_unicode
|
|
12
|
+
from zExceptions import Redirect
|
|
13
|
+
from zope.i18n import translate
|
|
14
|
+
|
|
15
|
+
import appy.pod
|
|
16
|
+
import logging
|
|
17
|
+
import os
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
logger = logging.getLogger('collective.documentgenerator: styles update')
|
|
21
|
+
|
|
22
|
+
CONVSCRIPT = '{}/converter.py'.format(os.path.dirname(appy.pod.__file__))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def update_styles_of_all_PODtemplate(style_template, event):
|
|
26
|
+
"""
|
|
27
|
+
Update all pod templates using 'style_template'.
|
|
28
|
+
"""
|
|
29
|
+
style_odt = style_template.odt_file
|
|
30
|
+
# template style is modify, update all template with style.
|
|
31
|
+
style_template_file = create_temporary_file(style_odt, '-style_template.odt')
|
|
32
|
+
if style_template_file:
|
|
33
|
+
catalog = api.portal.get_tool('portal_catalog')
|
|
34
|
+
pod_templates = catalog(object_provides=IPODTemplate.__identifier__)
|
|
35
|
+
for brain in pod_templates:
|
|
36
|
+
pod_template = brain.getObject()
|
|
37
|
+
if pod_template.has_linked_template() or \
|
|
38
|
+
pod_template.odt_file.contentType != 'application/vnd.oasis.opendocument.text':
|
|
39
|
+
continue
|
|
40
|
+
if pod_template.get_style_template() == style_template:
|
|
41
|
+
_update_template_styles(pod_template, style_template_file.name)
|
|
42
|
+
logger.info('"{}" => updated'.format(pod_template.Title()))
|
|
43
|
+
|
|
44
|
+
# delete temporary styles files
|
|
45
|
+
remove_tmp_file(style_template_file.name)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def styletemplate_created(style_template, event):
|
|
49
|
+
"""
|
|
50
|
+
Set the md5 of the initial style template in 'initial_md5' field.
|
|
51
|
+
"""
|
|
52
|
+
if not style_template.initial_md5:
|
|
53
|
+
style_template.initial_md5 = style_template.current_md5
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
def update_PODtemplate_styles(pod_template, event):
|
|
57
|
+
"""
|
|
58
|
+
Update styles on a pod_template using external styles only if not reusing an other template file.
|
|
59
|
+
"""
|
|
60
|
+
if not pod_template.has_linked_template():
|
|
61
|
+
style_template = pod_template.get_style_template()
|
|
62
|
+
if not style_template or pod_template.odt_file.contentType != 'application/vnd.oasis.opendocument.text':
|
|
63
|
+
return
|
|
64
|
+
style_odt = style_template.odt_file
|
|
65
|
+
style_template_file = create_temporary_file(style_odt, 'style_template.odt')
|
|
66
|
+
_update_template_styles(pod_template, style_template_file.name)
|
|
67
|
+
logger.info('"{}" => updated'.format(pod_template.Title()))
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
def _update_template_styles(pod_template, style_template_filename):
|
|
71
|
+
"""
|
|
72
|
+
Update template pod_template by templateStyle.
|
|
73
|
+
"""
|
|
74
|
+
# we check if the pod_template has been modified except by style only
|
|
75
|
+
style_changes_only = \
|
|
76
|
+
pod_template.style_modification_md5 and pod_template.current_md5 == pod_template.style_modification_md5
|
|
77
|
+
# save in temporary file, the template
|
|
78
|
+
temp_file = create_temporary_file(pod_template.odt_file, 'pod_template.odt')
|
|
79
|
+
with open(temp_file.name, 'w') as new_template:
|
|
80
|
+
new_template.write(pod_template.odt_file.data)
|
|
81
|
+
|
|
82
|
+
# merge style from templateStyle in template
|
|
83
|
+
cmd = '{path} {script} {tmp_file} {extension} -e ' \
|
|
84
|
+
'{libreoffice_host} -p {port} ' \
|
|
85
|
+
'-t {style_template} -v -a {stream}'.format(path=config.get_uno_path(),
|
|
86
|
+
script=CONVSCRIPT,
|
|
87
|
+
tmp_file=temp_file.name,
|
|
88
|
+
extension='odt',
|
|
89
|
+
libreoffice_host=config.get_oo_server(),
|
|
90
|
+
port=config.get_oo_port_list()[-1], # the last one should be the less busy
|
|
91
|
+
style_template=style_template_filename,
|
|
92
|
+
stream=config.get_use_stream())
|
|
93
|
+
(stdout, stderr) = executeCommand(cmd.split())
|
|
94
|
+
if stderr:
|
|
95
|
+
logger.error("Error during command '%s'" % cmd)
|
|
96
|
+
logger.error("Error is '%s'" % stderr)
|
|
97
|
+
portal = api.portal.get()
|
|
98
|
+
request = portal.REQUEST
|
|
99
|
+
api.portal.show_message(message=_(u"Problem during styles update on template '${tmpl}': ${err}",
|
|
100
|
+
mapping={'tmpl': safe_unicode(pod_template.absolute_url_path()),
|
|
101
|
+
'err': safe_unicode(stderr)}),
|
|
102
|
+
request=request,
|
|
103
|
+
type='error')
|
|
104
|
+
raise Redirect(request.get('ACTUAL_URL'),
|
|
105
|
+
translate(_(u"Problem during styles update on template '${tmpl}': ${err}",
|
|
106
|
+
mapping={'tmpl': safe_unicode(pod_template.absolute_url_path()),
|
|
107
|
+
'err': safe_unicode(stderr)})))
|
|
108
|
+
|
|
109
|
+
# read the merged file
|
|
110
|
+
resTempFileName = '.res.'.join(temp_file.name.rsplit('.', 1))
|
|
111
|
+
if os.path.isfile(resTempFileName):
|
|
112
|
+
with open(resTempFileName, 'rb') as resTemplate:
|
|
113
|
+
# update template
|
|
114
|
+
result = NamedBlobFile(data=resTemplate.read(),
|
|
115
|
+
contentType='application/vnd.oasis.opendocument.text',
|
|
116
|
+
filename=pod_template.odt_file.filename)
|
|
117
|
+
pod_template.odt_file = result
|
|
118
|
+
# if only styles were modified: update the style_modification_md5 attribute
|
|
119
|
+
if style_changes_only:
|
|
120
|
+
pod_template.style_modification_md5 = pod_template.current_md5
|
|
121
|
+
remove_tmp_file(resTempFileName)
|
|
122
|
+
remove_tmp_file(temp_file.name)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
# flake8: noqa
|
|
3
|
+
|
|
4
|
+
from collective.documentgenerator.helper.archetypes import ATDisplayProxyObject
|
|
5
|
+
from collective.documentgenerator.helper.archetypes import ATDocumentGenerationHelperView
|
|
6
|
+
from collective.documentgenerator.helper.base import DisplayProxyObject
|
|
7
|
+
from collective.documentgenerator.helper.base import DocumentGenerationHelperView
|
|
8
|
+
from collective.documentgenerator.helper.dexterity import DXDisplayProxyObject
|
|
9
|
+
from collective.documentgenerator.helper.dexterity import DXDocumentGenerationHelperView
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<adapter
|
|
2
|
+
xmlns="http://namespaces.zope.org/zope"
|
|
3
|
+
xmlns:browser="http://namespaces.zope.org/browser"
|
|
4
|
+
xmlns:i18n="http://namespaces.zope.org/i18n"
|
|
5
|
+
for="Products.Archetypes.interfaces.IBaseObject
|
|
6
|
+
zope.interface.Interface"
|
|
7
|
+
provides="collective.documentgenerator.interfaces.IDisplayProxyObject"
|
|
8
|
+
factory="collective.documentgenerator.helper.archetypes.ATDisplayProxyObject"
|
|
9
|
+
permission="zope2.View"
|
|
10
|
+
/>
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
<browser:page
|
|
2
|
+
xmlns="http://namespaces.zope.org/zope"
|
|
3
|
+
xmlns:browser="http://namespaces.zope.org/browser"
|
|
4
|
+
xmlns:i18n="http://namespaces.zope.org/i18n"
|
|
5
|
+
for="Products.Archetypes.interfaces.IBaseObject"
|
|
6
|
+
class="collective.documentgenerator.helper.archetypes.ATDocumentGenerationHelperView"
|
|
7
|
+
permission="zope2.View"
|
|
8
|
+
name="document_generation_helper_view"
|
|
9
|
+
/>
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
from collective.documentgenerator.helper.base import DisplayProxyObject
|
|
4
|
+
from collective.documentgenerator.helper.base import DocumentGenerationHelperView
|
|
5
|
+
from collective.documentgenerator.interfaces import IFieldRendererForDocument
|
|
6
|
+
from zope.component import getMultiAdapter
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class ATDocumentGenerationHelperView(DocumentGenerationHelperView):
|
|
10
|
+
"""
|
|
11
|
+
Archetypes implementation of document generation helper methods.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
def display(self, field_name, no_value='', bypass_check_permission=False):
|
|
15
|
+
if bypass_check_permission or self.check_permission(field_name):
|
|
16
|
+
field_renderer = self.get_AT_field_renderer(field_name)
|
|
17
|
+
display_value = field_renderer.render(no_value=no_value)
|
|
18
|
+
else:
|
|
19
|
+
display_value = u''
|
|
20
|
+
|
|
21
|
+
return display_value
|
|
22
|
+
|
|
23
|
+
def check_permission(self, field_name):
|
|
24
|
+
return bool(self.real_context.getField(field_name).checkPermission('r', self.real_context))
|
|
25
|
+
|
|
26
|
+
def get_AT_field_renderer(self, field_name):
|
|
27
|
+
field = self.real_context.getField(field_name)
|
|
28
|
+
widget = field.widget
|
|
29
|
+
renderer = getMultiAdapter((field, widget, self.real_context), IFieldRendererForDocument)
|
|
30
|
+
renderer.helper_view = self
|
|
31
|
+
|
|
32
|
+
return renderer
|
|
33
|
+
|
|
34
|
+
def get_value(self, field_name, default=None, as_utf8=False):
|
|
35
|
+
field = self.real_context.getField(field_name)
|
|
36
|
+
value = field.getAccessor(self.real_context)()
|
|
37
|
+
if value is None:
|
|
38
|
+
return default
|
|
39
|
+
if as_utf8 and isinstance(value, unicode):
|
|
40
|
+
value = value.encode('utf8')
|
|
41
|
+
return value
|
|
42
|
+
|
|
43
|
+
def display_voc(self, field_name, separator=', '):
|
|
44
|
+
display_value = self.real_context.restrictedTraverse('@@at_utils').translate
|
|
45
|
+
|
|
46
|
+
field = self.real_context.getField(field_name)
|
|
47
|
+
raw_values = field.getAccessor(self.real_context)()
|
|
48
|
+
voc = field.Vocabulary(self.real_context)
|
|
49
|
+
values = [display_value(voc, val) for val in raw_values]
|
|
50
|
+
display = separator.join(values)
|
|
51
|
+
|
|
52
|
+
return display
|
|
53
|
+
|
|
54
|
+
def get_file_binary(self, file_obj):
|
|
55
|
+
""" """
|
|
56
|
+
data = file_obj.getPrimaryField().get(file_obj).data
|
|
57
|
+
return data
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
class ATDisplayProxyObject(DisplayProxyObject):
|
|
61
|
+
"""
|
|
62
|
+
Archetypes implementation of DisplayProxyObject.
|
|
63
|
+
"""
|
|
64
|
+
|
|
65
|
+
def is_field(self, attr_name):
|
|
66
|
+
is_field = bool(self.context.getField(attr_name))
|
|
67
|
+
return is_field
|
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
from collective.documentgenerator.interfaces import IDisplayProxyObject
|
|
3
|
+
from collective.documentgenerator.interfaces import IDocumentGenerationHelper
|
|
4
|
+
from collective.documentgenerator.utils import ulocalized_time
|
|
5
|
+
from plone import api
|
|
6
|
+
from plone.api.validation import mutually_exclusive_parameters
|
|
7
|
+
from Products.CMFPlone.utils import safe_unicode
|
|
8
|
+
from zope.component import getMultiAdapter
|
|
9
|
+
from zope.i18n import translate
|
|
10
|
+
from zope.interface import implementer
|
|
11
|
+
|
|
12
|
+
import copy
|
|
13
|
+
import datetime
|
|
14
|
+
import phonenumbers
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
@implementer(IDocumentGenerationHelper)
|
|
18
|
+
class DocumentGenerationHelperView(object):
|
|
19
|
+
"""
|
|
20
|
+
See IDocumentGenerationHelper.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
def __init__(self, context, request):
|
|
24
|
+
super(DocumentGenerationHelperView, self).__init__(context, request)
|
|
25
|
+
self.real_context = context
|
|
26
|
+
self.request = request
|
|
27
|
+
self.context = self._get_proxy_object()
|
|
28
|
+
self.appy_renderer = None
|
|
29
|
+
self.plone = getMultiAdapter((context, request), name=u'plone')
|
|
30
|
+
self.plone_portal_state = getMultiAdapter((context, request), name=u'plone_portal_state')
|
|
31
|
+
self.portal = self.plone_portal_state.portal()
|
|
32
|
+
|
|
33
|
+
def _get_proxy_object(self):
|
|
34
|
+
proxy_obj = getMultiAdapter((self.real_context, self.display), IDisplayProxyObject)
|
|
35
|
+
proxy_obj.helper_view = self
|
|
36
|
+
return proxy_obj
|
|
37
|
+
|
|
38
|
+
def get_value(self, field_name, default=None, as_utf8=False): # pragma: no cover
|
|
39
|
+
"""See IDocumentGenerationHelper. To implements."""
|
|
40
|
+
raise NotImplementedError()
|
|
41
|
+
|
|
42
|
+
def display(self, field_name, no_value=''): # pragma: no cover
|
|
43
|
+
"""See IDocumentGenerationHelper. To implements."""
|
|
44
|
+
raise NotImplementedError()
|
|
45
|
+
|
|
46
|
+
@mutually_exclusive_parameters('field_name', 'date')
|
|
47
|
+
def display_date(self, field_name=None, date=None, long_format=None, time_only=None, custom_format=None,
|
|
48
|
+
domain='plonelocales', target_language=None, month_lc=True, day_lc=True):
|
|
49
|
+
if field_name:
|
|
50
|
+
date = self.get_value(field_name)
|
|
51
|
+
|
|
52
|
+
if date is None:
|
|
53
|
+
return u''
|
|
54
|
+
|
|
55
|
+
if type(date) == datetime.date:
|
|
56
|
+
date = datetime.datetime(date.year, date.month, date.day)
|
|
57
|
+
|
|
58
|
+
return ulocalized_time(date, long_format=long_format, time_only=time_only, custom_format=custom_format,
|
|
59
|
+
domain=domain, target_language=target_language, context=self.context,
|
|
60
|
+
request=self.request, month_lc=month_lc, day_lc=day_lc)
|
|
61
|
+
|
|
62
|
+
@mutually_exclusive_parameters('field_name', 'phone')
|
|
63
|
+
def display_phone(self, field_name=None, phone=None, country='BE', check=True, format='', pattern=''):
|
|
64
|
+
"""
|
|
65
|
+
Return a formatted localized phone number.
|
|
66
|
+
country = 2 letters country code
|
|
67
|
+
check = check the validity of the given phone
|
|
68
|
+
format = 'nat' or 'int'
|
|
69
|
+
pattern = space replacing separators in rtl order
|
|
70
|
+
* list of 2 lists for nat and int formats => [['/', '.'], ['-', '.']]
|
|
71
|
+
* string or 2 strings (pipe separator) for nat and int formats '/.|-.'
|
|
72
|
+
"""
|
|
73
|
+
if field_name:
|
|
74
|
+
phone = self.get_value(field_name)
|
|
75
|
+
if not phone:
|
|
76
|
+
return u''
|
|
77
|
+
try:
|
|
78
|
+
number = phonenumbers.parse(phone, country)
|
|
79
|
+
except phonenumbers.NumberParseException:
|
|
80
|
+
return translate(u"Bad phone number: '${nb}'", domain='collective.documentgenerator',
|
|
81
|
+
mapping={'nb': phone}, context=self.request)
|
|
82
|
+
return safe_unicode(phone)
|
|
83
|
+
if check and not phonenumbers.is_valid_number(number):
|
|
84
|
+
return translate(u"Invalid phone number: '${nb}'", domain='collective.documentgenerator',
|
|
85
|
+
mapping={'nb': phone}, context=self.request)
|
|
86
|
+
|
|
87
|
+
def format_with_pattern(nb):
|
|
88
|
+
if not pattern:
|
|
89
|
+
return nb
|
|
90
|
+
index = 0
|
|
91
|
+
if nb.startswith('+'):
|
|
92
|
+
index = 1
|
|
93
|
+
if isinstance(pattern, list):
|
|
94
|
+
pat = len(pattern) > index and pattern[index] or ''
|
|
95
|
+
else:
|
|
96
|
+
lst = pattern.split('|')
|
|
97
|
+
pat = len(lst) > index and lst[index] or ''
|
|
98
|
+
if not pat:
|
|
99
|
+
return nb
|
|
100
|
+
nbl = []
|
|
101
|
+
for i, part in enumerate(nb.split()):
|
|
102
|
+
nbl.append(part)
|
|
103
|
+
nbl.append((pat[i:i + 1] + pat[-1:])[0])
|
|
104
|
+
return ''.join(nbl[:-1])
|
|
105
|
+
if format:
|
|
106
|
+
ret = format_with_pattern(phonenumbers.format_number(number, format == 'int' and 1 or 2))
|
|
107
|
+
elif country in phonenumbers.data._COUNTRY_CODE_TO_REGION_CODE.get(number.country_code, []):
|
|
108
|
+
ret = format_with_pattern(phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.NATIONAL))
|
|
109
|
+
else:
|
|
110
|
+
ret = format_with_pattern(phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL))
|
|
111
|
+
return ret
|
|
112
|
+
|
|
113
|
+
def display_voc(self, field_name, separator=','): # pragma: no cover
|
|
114
|
+
"""See IDocumentGenerationHelper. To implements."""
|
|
115
|
+
raise NotImplementedError()
|
|
116
|
+
|
|
117
|
+
@mutually_exclusive_parameters('field_name', 'text')
|
|
118
|
+
def display_text_as_html(self, field_name=None, text=None):
|
|
119
|
+
if field_name:
|
|
120
|
+
text = self.get_value(field_name)
|
|
121
|
+
return self.portal.portal_transforms.convert('web_intelligent_plain_text_to_html', text).getData()
|
|
122
|
+
|
|
123
|
+
@mutually_exclusive_parameters('field_name', 'html')
|
|
124
|
+
def display_html_as_text(self, field_name=None, html=None):
|
|
125
|
+
if field_name:
|
|
126
|
+
html = self.get_value(field_name)
|
|
127
|
+
return self.portal.portal_transforms.convert('html_to_web_intelligent_plain_text', html).getData().strip('\n ')
|
|
128
|
+
|
|
129
|
+
def render_xhtml(self, field_name):
|
|
130
|
+
if not self.appy_renderer:
|
|
131
|
+
return ''
|
|
132
|
+
html_text = self.get_value(field_name)
|
|
133
|
+
display = self.appy_renderer.renderXhtml(html_text)
|
|
134
|
+
return display
|
|
135
|
+
|
|
136
|
+
def display_widget(self, fieldname, clean=True, soup=False): # pragma: no cover
|
|
137
|
+
"""See IDocumentGenerationHelper. To implements."""
|
|
138
|
+
raise NotImplementedError()
|
|
139
|
+
|
|
140
|
+
def display_list(self, field_name, separator=', '):
|
|
141
|
+
values = self.get_value(field_name)
|
|
142
|
+
display = separator.join(values)
|
|
143
|
+
return display
|
|
144
|
+
|
|
145
|
+
def list(self, field_name):
|
|
146
|
+
return self.get_value(field_name)
|
|
147
|
+
|
|
148
|
+
def list_voc(self, field_name, list_keys=False, list_values=True): # pragma: no cover
|
|
149
|
+
"""See IDocumentGenerationHelper. To implements."""
|
|
150
|
+
raise NotImplementedError()
|
|
151
|
+
|
|
152
|
+
def _set_appy_renderer(self, appy_renderer):
|
|
153
|
+
self.appy_renderer = appy_renderer
|
|
154
|
+
|
|
155
|
+
def translate(self, msgid, domain='plone', mapping={}, target_language=None, default=None):
|
|
156
|
+
"""Let's translate a given msgid in given domain."""
|
|
157
|
+
return translate(msgid,
|
|
158
|
+
domain,
|
|
159
|
+
mapping=mapping,
|
|
160
|
+
context=self.request,
|
|
161
|
+
target_language=target_language,
|
|
162
|
+
default=default)
|
|
163
|
+
|
|
164
|
+
def getDGHV(self, obj):
|
|
165
|
+
""" get another object 'document_generation_helper_view' view """
|
|
166
|
+
view = getMultiAdapter((obj, self.request), name=u'document_generation_helper_view')
|
|
167
|
+
view.appy_renderer = self.appy_renderer
|
|
168
|
+
return view
|
|
169
|
+
|
|
170
|
+
def get_state(self, title=True):
|
|
171
|
+
""" Return state of object. """
|
|
172
|
+
obj = self.real_context
|
|
173
|
+
state = api.content.get_state(obj, default=None)
|
|
174
|
+
if not state:
|
|
175
|
+
return '-'
|
|
176
|
+
if title:
|
|
177
|
+
wtool = api.portal.get_tool('portal_workflow')
|
|
178
|
+
state = wtool.getTitleForStateOnType(state, obj.portal_type)
|
|
179
|
+
return state
|
|
180
|
+
|
|
181
|
+
def context_var(self, name, default=''):
|
|
182
|
+
""" Test if a context variable is defined and return it or return default """
|
|
183
|
+
ctx = self.appy_renderer.contentParser.env.context
|
|
184
|
+
if name in ctx and ctx[name] is not None:
|
|
185
|
+
return ctx[name]
|
|
186
|
+
else:
|
|
187
|
+
return default
|
|
188
|
+
|
|
189
|
+
def mailing_list(self, gen_context=None): # pragma: no cover
|
|
190
|
+
"""
|
|
191
|
+
Return a mailing list (that will be added to generation context in "loop" view) to loop on.
|
|
192
|
+
Improvement using from plone.memoize import view ?
|
|
193
|
+
"""
|
|
194
|
+
return []
|
|
195
|
+
|
|
196
|
+
def mailed_context(self, mailed_data):
|
|
197
|
+
""" Modify current context to remove mailing_list and add mailed_data """
|
|
198
|
+
try:
|
|
199
|
+
new_context = copy.copy(self.appy_renderer.contentParser.env.context)
|
|
200
|
+
for key in ('mailing_list', 'mailed_doc'):
|
|
201
|
+
if key in new_context:
|
|
202
|
+
del new_context[key]
|
|
203
|
+
new_context['mailed_data'] = mailed_data
|
|
204
|
+
return new_context
|
|
205
|
+
except AttributeError: # in case one object is None starting with self.appy_renderer
|
|
206
|
+
return {'mailed_data': mailed_data}
|
|
207
|
+
|
|
208
|
+
def do_mailing(self):
|
|
209
|
+
""" Check if mailing data must be replaced in template """
|
|
210
|
+
ctx = self.appy_renderer.contentParser.env.context
|
|
211
|
+
return 'mailed_data' in ctx
|
|
212
|
+
|
|
213
|
+
def iterable_in_columns(self, iterable, cols=1):
|
|
214
|
+
"""Transform an iterable in list of list.
|
|
215
|
+
|
|
216
|
+
Useful for labels document...
|
|
217
|
+
:param iterable: input iterable
|
|
218
|
+
:param cols: number of columns in the sublists
|
|
219
|
+
:return: list of lists
|
|
220
|
+
"""
|
|
221
|
+
res = []
|
|
222
|
+
sublist = []
|
|
223
|
+
for i, item in enumerate(iterable or [], start=1):
|
|
224
|
+
sublist.append(item)
|
|
225
|
+
if not i % cols:
|
|
226
|
+
if sublist:
|
|
227
|
+
res.append(sublist)
|
|
228
|
+
sublist = []
|
|
229
|
+
# put the last sublist in res
|
|
230
|
+
if sublist:
|
|
231
|
+
res.append(sublist)
|
|
232
|
+
return res
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
@implementer(IDisplayProxyObject)
|
|
236
|
+
class DisplayProxyObject(object):
|
|
237
|
+
"""
|
|
238
|
+
See IDisplayProxyObject.
|
|
239
|
+
"""
|
|
240
|
+
|
|
241
|
+
# (IDisplayProxyObject)
|
|
242
|
+
|
|
243
|
+
def __init__(self, context, display_method):
|
|
244
|
+
self.context = context
|
|
245
|
+
self.display = display_method
|
|
246
|
+
self.helper_view = None
|
|
247
|
+
|
|
248
|
+
def __getattr__(self, attr_name):
|
|
249
|
+
"""
|
|
250
|
+
Delegate field attribute access to display() method.
|
|
251
|
+
"""
|
|
252
|
+
if self.is_field(attr_name):
|
|
253
|
+
display_value = self.display(field_name=attr_name)
|
|
254
|
+
return display_value
|
|
255
|
+
|
|
256
|
+
attr = getattr(self.context, attr_name)
|
|
257
|
+
return attr
|
|
258
|
+
|
|
259
|
+
def __str__(self):
|
|
260
|
+
return self.context.__str__()
|
|
261
|
+
|
|
262
|
+
def __unicode__(self):
|
|
263
|
+
return unicode(self.context)
|
|
264
|
+
|
|
265
|
+
def is_field(self, attr_name):
|
|
266
|
+
"""To Override."""
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
<configure
|
|
2
|
+
xmlns="http://namespaces.zope.org/zope"
|
|
3
|
+
xmlns:browser="http://namespaces.zope.org/browser"
|
|
4
|
+
xmlns:i18n="http://namespaces.zope.org/i18n"
|
|
5
|
+
xmlns:zcml="http://namespaces.zope.org/zcml"
|
|
6
|
+
i18n_domain="collective.documentgenerator">
|
|
7
|
+
|
|
8
|
+
<!-- default proxy object for any content type -->
|
|
9
|
+
<adapter
|
|
10
|
+
for="zope.interface.Interface
|
|
11
|
+
zope.interface.Interface"
|
|
12
|
+
provides="collective.documentgenerator.interfaces.IDisplayProxyObject"
|
|
13
|
+
factory="collective.documentgenerator.helper.DisplayProxyObject"
|
|
14
|
+
permission="zope2.View"
|
|
15
|
+
/>
|
|
16
|
+
|
|
17
|
+
<!-- helper view and default proxy object for Archetypes -->
|
|
18
|
+
|
|
19
|
+
<include zcml:condition="not-have plone-52" file="archetypes-page.zcml" />
|
|
20
|
+
<include zcml:condition="not-have plone-52" file="archetypes-adapter.zcml" />
|
|
21
|
+
|
|
22
|
+
<!-- helper view and default proxy object for Dexterity -->
|
|
23
|
+
<browser:page
|
|
24
|
+
for="plone.dexterity.interfaces.IDexterityContent"
|
|
25
|
+
class="collective.documentgenerator.helper.DXDocumentGenerationHelperView"
|
|
26
|
+
permission="zope2.View"
|
|
27
|
+
name="document_generation_helper_view"
|
|
28
|
+
/>
|
|
29
|
+
|
|
30
|
+
<adapter
|
|
31
|
+
for="plone.dexterity.interfaces.IDexterityContent
|
|
32
|
+
zope.interface.Interface"
|
|
33
|
+
provides="collective.documentgenerator.interfaces.IDisplayProxyObject"
|
|
34
|
+
factory="collective.documentgenerator.helper.dexterity.DXDisplayProxyObject"
|
|
35
|
+
permission="zope2.View"
|
|
36
|
+
/>
|
|
37
|
+
|
|
38
|
+
</configure>
|