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