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,680 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from AccessControl import Unauthorized
4
+ from appy.utils.zip import unzip
5
+ from collective.documentgenerator.config import get_column_modifier
6
+ from collective.documentgenerator.config import get_raiseOnError_for_non_managers
7
+ from collective.documentgenerator.config import set_column_modifier
8
+ from collective.documentgenerator.content.pod_template import MailingLoopTemplate
9
+ from collective.documentgenerator.content.pod_template import SubTemplate
10
+ from collective.documentgenerator.interfaces import CyclicMergeTemplatesException
11
+ from collective.documentgenerator.interfaces import PODTemplateNotFoundError
12
+ from collective.documentgenerator.testing import POD_TEMPLATE_INTEGRATION
13
+ from collective.documentgenerator.testing import PODTemplateIntegrationTest
14
+ from collective.documentgenerator.testing import TEST_INSTALL_INTEGRATION
15
+ from collective.documentgenerator.utils import create_temporary_file
16
+ from collective.documentgenerator.utils import translate as _
17
+ from plone import api
18
+ from plone.app.testing import login
19
+ from plone.app.testing import TEST_USER_NAME
20
+ from plone.app.textfield.value import RichTextValue
21
+ from plone.namedfile.file import NamedBlobFile
22
+ from Products.CMFPlone.utils import base_hasattr
23
+ from zope.annotation.interfaces import IAnnotations
24
+
25
+ import os
26
+ import tempfile
27
+ import unittest
28
+
29
+
30
+ class TestGenerationView(unittest.TestCase):
31
+ """
32
+ Test document generation view.
33
+ """
34
+
35
+ layer = TEST_INSTALL_INTEGRATION
36
+
37
+ def test_view_registration(self):
38
+ from collective.documentgenerator.browser.generation_view import DocumentGenerationView
39
+
40
+ portal = api.portal.getSite()
41
+ generation_view = portal.restrictedTraverse("@@document-generation")
42
+ self.assertTrue(generation_view)
43
+ self.assertTrue(isinstance(generation_view, DocumentGenerationView))
44
+
45
+
46
+ class TestGenerationViewMethods(PODTemplateIntegrationTest):
47
+ """ """
48
+
49
+ def test_get_pod_template_uid(self):
50
+ """
51
+ By default, this will get the 'template_uid' from the request.
52
+ """
53
+ test_UID = "12345"
54
+ view = self.portal.restrictedTraverse("@@document-generation")
55
+ view.request.set("template_uid", test_UID)
56
+ self.assertTrue(view.get_pod_template_uid() == test_UID)
57
+
58
+ def test_get_generation_format(self):
59
+ """
60
+ By default, this will get the 'output_format' from the request.
61
+ """
62
+ output_format = "odt"
63
+ view = self.portal.restrictedTraverse("@@document-generation")
64
+ view.request.set("output_format", output_format)
65
+ self.assertTrue(view.get_generation_format() == output_format)
66
+
67
+ def test__call__params_not_given(self):
68
+ """
69
+ __call__ receives 'template_uid' and 'output_format' as params, if it is None,
70
+ it tries to get it using 'get_pod_template_uid' and 'get_generation_format' methods.
71
+ """
72
+ pod_template = self.test_podtemplate
73
+ template_uid = pod_template.UID()
74
+ view = self.portal.podtemplates.restrictedTraverse("@@document-generation")
75
+ self.assertRaises(
76
+ PODTemplateNotFoundError, view, template_uid=None, output_format=None
77
+ )
78
+ # set parameters in REQUEST as it is default implementation of
79
+ # 'get_pod_template_uid' and 'get_generation_format' methods
80
+ view.request.set("template_uid", template_uid)
81
+ view.request.set("output_format", "odt")
82
+ self.assertTrue(view())
83
+
84
+ def test_get_pod_template(self):
85
+ """
86
+ When passing a real template UID, get_pod_template() should return this
87
+ template.
88
+ """
89
+ pod_template = self.test_podtemplate
90
+ template_uid = pod_template.UID()
91
+ view = self.portal.restrictedTraverse("@@document-generation")
92
+ self.assertTrue(view.get_pod_template(template_uid) == pod_template)
93
+
94
+ def test_get_pod_template_not_found(self):
95
+ """
96
+ When a template cannot be found, a PODTemplateNotFoundError should be raised.
97
+ """
98
+ from collective.documentgenerator.interfaces import PODTemplateNotFoundError
99
+
100
+ template_uid = "TROLOLO"
101
+ view = self.portal.restrictedTraverse("@@document-generation")
102
+ error_raised = False
103
+ try:
104
+ view.get_pod_template(template_uid)
105
+ except PODTemplateNotFoundError:
106
+ error_raised = True
107
+ self.assertTrue(error_raised)
108
+
109
+ def test_document_generation_call(self):
110
+ """
111
+ Check if documents are rendered correctly.
112
+ """
113
+ pod_template = self.test_podtemplate
114
+ template_uid = pod_template.UID()
115
+ view = self.portal.podtemplates.restrictedTraverse("@@document-generation")
116
+ # an 'output_format' must be given or it raises an Exception
117
+ with self.assertRaises(Exception) as cm:
118
+ view(template_uid, output_format="")
119
+ self.assertEqual(
120
+ str(cm.exception), "No 'output_format' found to generate this document"
121
+ )
122
+ # if 'output_format' is not in available pod_formats of template, it raises an Exception
123
+ self.assertNotIn("pdf", pod_template.get_available_formats())
124
+ self.assertRaises(Exception, view)
125
+ with self.assertRaises(Exception) as cm:
126
+ view(template_uid, "pdf")
127
+ self.assertEqual(
128
+ str(cm.exception),
129
+ "Asked output format 'pdf' is not available for template 'test_template'!",
130
+ )
131
+
132
+ # right, ask available format
133
+ self.assertIn("odt", pod_template.get_available_formats())
134
+ generated_doc = view(template_uid, "odt")
135
+ self.assertIn("application/vnd.oasis.opendocument.text", str(generated_doc))
136
+
137
+ def test_unauthorized_generation(self):
138
+ """
139
+ If a template generation condition is not matched, an Unauthorized
140
+ exception should be raised when trying to generate that document.
141
+ """
142
+ pod_template = self.test_podtemplate
143
+ template_uid = pod_template.UID()
144
+ # Make sure can_be_generated will return False.
145
+ pod_template.can_be_generated = lambda x: False
146
+ self.assertTrue(not pod_template.can_be_generated(self.portal))
147
+
148
+ view = self.portal.restrictedTraverse("@@document-generation")
149
+ unauthorized_raised = False
150
+ try:
151
+ view(template_uid, "odt")
152
+ except Unauthorized:
153
+ unauthorized_raised = True
154
+ self.assertTrue(unauthorized_raised)
155
+
156
+ def test_persistent_document_generation_call(self):
157
+ """
158
+ Check if documents are rendered correctly.
159
+ """
160
+ pod_template = self.test_podtemplate
161
+ template_uid = pod_template.UID()
162
+ generation_context = api.content.create(
163
+ type="Folder",
164
+ title=u"Folder title > 200m² to test – filename generation 1.2.3.4 with accent héhé "
165
+ u"actually we test with a title that is longer than 120 characters so we may "
166
+ u"evaluate cropText method that is sensitive to some characters like -",
167
+ id="test_folder",
168
+ container=self.portal,
169
+ )
170
+ generation_view = generation_context.restrictedTraverse(
171
+ "@@persistent-document-generation"
172
+ )
173
+ generation_view(template_uid, "odt")
174
+ generated_id = "general-template"
175
+ msg = "File {0} should have been created in folder.".format(generated_id)
176
+ self.assertTrue(generated_id in generation_context.objectIds(), msg)
177
+
178
+ persistent_doc = generation_context.get(generated_id)
179
+ generated_doc = persistent_doc.file
180
+ filename = persistent_doc.file.filename
181
+ content_type = persistent_doc.file.contentType
182
+ self.assertIn(
183
+ "application/vnd.oasis.opendocument.text", str(generated_doc.data)
184
+ )
185
+
186
+ self.assertEqual(filename, u"General template.odt")
187
+ self.assertEqual(content_type, "application/vnd.oasis.opendocument.text")
188
+ self.assertEqual(persistent_doc.Title(), pod_template.Title())
189
+
190
+ # customize the title
191
+ custom_title = "my awesome title"
192
+ generation_view(
193
+ template_uid=template_uid,
194
+ output_format="odt",
195
+ generated_doc_title=custom_title,
196
+ )
197
+ docgen_file = generation_context.objectValues()[1]
198
+ self.assertEqual(docgen_file.Title(), custom_title)
199
+
200
+ def test_persistent_document_generation_on_non_folderish_context(self):
201
+ """
202
+ If the generation view is called on a non folderish the document file should be created
203
+ on the parent.
204
+ """
205
+ from collective.documentgenerator.interfaces import isNotFolderishError
206
+
207
+ pod_template = self.test_podtemplate
208
+ template_uid = pod_template.UID()
209
+ non_folderish = api.content.create(
210
+ type="Document", id="doc", container=self.portal
211
+ )
212
+ generation_view = non_folderish.restrictedTraverse(
213
+ "@@persistent-document-generation"
214
+ )
215
+
216
+ error_raised = False
217
+ try:
218
+ generation_view(template_uid, "odt")
219
+ except isNotFolderishError:
220
+ error_raised = True
221
+
222
+ msg = "A 'isNotFolderishError' exception should have been raised."
223
+ self.assertTrue(error_raised, msg)
224
+
225
+ def test__get_generation_context(self):
226
+ pod_template = self.portal.podtemplates["test_template_bis"]
227
+ view = self.portal.podtemplates.restrictedTraverse("@@document-generation")
228
+ view(template_uid=pod_template.UID(), output_format="odt")
229
+ hpv = view.get_generation_context_helper()
230
+ # Check context variables
231
+ self.assertDictEqual(
232
+ view._get_generation_context(hpv, pod_template),
233
+ {
234
+ "details": "1",
235
+ "portal": self.portal,
236
+ "context": hpv.context,
237
+ "view": hpv,
238
+ },
239
+ )
240
+ # Check configurable pod template
241
+ self.assertDictEqual(
242
+ view._get_generation_context(hpv, self.test_podtemplate),
243
+ {"context": hpv.context, "portal": self.portal, "view": hpv},
244
+ )
245
+
246
+ rendered, filename, gen_context = view._generate_doc(pod_template, "odt")
247
+
248
+ # The gotten helper view (hpv) is not the used one at generation
249
+ self.assertNotEqual(hpv, gen_context["view"])
250
+
251
+ # Check generation context subtemplates without pre-rendering
252
+ self.assertEqual(pod_template.merge_templates[0]["do_rendering"], False)
253
+ self.assertIn("header", gen_context)
254
+ self.assertIsInstance(gen_context["header"], SubTemplate)
255
+
256
+ # Check generation context subtemplates with pre-rendering
257
+ mt_conf = pod_template.merge_templates
258
+ mt_conf[0]["do_rendering"] = True
259
+ pod_template.merge_templates = mt_conf
260
+ self.assertEqual(pod_template.merge_templates[0]["do_rendering"], True)
261
+ # We call rendering to get new gen_context
262
+ rendered, filename, gen_context = view._generate_doc(pod_template, "odt")
263
+ self.assertIsInstance(gen_context["header"], str)
264
+ self.assertRegex(gen_context["header"], r".+(\.odt)$")
265
+
266
+ def test_raiseOnError_for_non_managers(self):
267
+ # create a POD template that will fail in every case
268
+ current_path = os.path.dirname(__file__)
269
+ failing_template_data = open(
270
+ os.path.join(current_path, "failing_template.odt"), "rb"
271
+ ).read()
272
+ failing_template = api.content.create(
273
+ type="ConfigurablePODTemplate",
274
+ id="failing_template",
275
+ title=_(u"Failing template"),
276
+ odt_file=NamedBlobFile(
277
+ data=failing_template_data,
278
+ contentType="application/vnd.oasis.opendocument.text",
279
+ filename=u"modele_general.odt",
280
+ ),
281
+ pod_formats=["odt"],
282
+ container=self.portal.podtemplates,
283
+ exclude_from_nav=True,
284
+ )
285
+ # create a user that is not Manager
286
+ api.user.create(
287
+ email="test@test.be",
288
+ username="user",
289
+ password="12345678910",
290
+ roles=["Member"],
291
+ properties={},
292
+ )
293
+
294
+ # disabled by default
295
+ self.assertFalse(get_raiseOnError_for_non_managers())
296
+ # when disabled, generating by anybody will always produce a document
297
+ view = failing_template.restrictedTraverse("@@document-generation")
298
+ template_UID = failing_template.UID()
299
+ # generated for 'Manager'
300
+ self.assertTrue("Manager" in api.user.get_current().getRoles())
301
+ self.assertTrue(
302
+ b"mimetypeapplication/vnd.oasis.opendocument.text"
303
+ in view(template_uid=template_UID, output_format="odt")
304
+ )
305
+ # generated for non 'Manager'
306
+ login(self.portal, "user")
307
+ self.assertFalse("Manager" in api.user.get_current().getRoles())
308
+ self.assertTrue(
309
+ b"mimetypeapplication/vnd.oasis.opendocument.text"
310
+ in view(template_uid=template_UID, output_format="odt")
311
+ )
312
+
313
+ # enable raiseOnError_for_non_managers and test again
314
+ login(self.portal, TEST_USER_NAME)
315
+ api.portal.set_registry_record(
316
+ "collective.documentgenerator.browser.controlpanel."
317
+ "IDocumentGeneratorControlPanelSchema.raiseOnError_for_non_managers",
318
+ True,
319
+ )
320
+ self.assertTrue(
321
+ b"mimetypeapplication/vnd.oasis.opendocument.text"
322
+ in view(template_uid=template_UID, output_format="odt")
323
+ )
324
+ login(self.portal, "user")
325
+ # raises an error instead generating the document
326
+ with self.assertRaises(Exception) as cm:
327
+ view(template_uid=template_UID, output_format="odt")
328
+ self.assertTrue(
329
+ 'Error while evaluating expression "view.unknown_method()".'
330
+ in str(cm.exception)
331
+ )
332
+
333
+ def test_mailing_loop_persistent_document_generation(self):
334
+ pod_template = self.portal.podtemplates.get("test_template_possibly_mailed")
335
+ template_uid = pod_template.UID()
336
+ folder = api.content.create(
337
+ type="Folder", title=u"Folder", id="test_folder", container=self.portal
338
+ )
339
+ # Check dexterity values
340
+ orig_registry = api.portal.get_registry_record(
341
+ "collective.documentgenerator.mailing_list"
342
+ )
343
+
344
+ def get_content(blob_file):
345
+ tmpdir = tempfile.mkdtemp()
346
+ temp_file = create_temporary_file(blob_file)
347
+ info = unzip(temp_file.name, tmpdir, odf=True)
348
+ os.remove(temp_file.name)
349
+ return info
350
+
351
+ # First we generate a persistent document with only one element in mailing list
352
+ api.portal.set_registry_record(
353
+ "collective.documentgenerator.mailing_list", orig_registry[0:1]
354
+ )
355
+ generation_view = folder.restrictedTraverse("@@persistent-document-generation")
356
+ generation_view(template_uid, "odt")
357
+ generated_id = "possibly-mailed-template"
358
+ msg = "File {0} should have been created in folder.".format(generated_id)
359
+ self.assertTrue(generated_id in folder.objectIds(), msg)
360
+ persistent_doc = folder.get(generated_id)
361
+ annot = IAnnotations(persistent_doc)
362
+ self.assertIn("documentgenerator", annot)
363
+ self.assertIn("template_uid", annot["documentgenerator"])
364
+ self.assertNotIn("context_uid", annot["documentgenerator"])
365
+ self.assertEqual(annot["documentgenerator"]["need_mailing"], False)
366
+ generated_doc = persistent_doc.file
367
+ info = get_content(generated_doc)
368
+ self.assertNotIn(b"mailed_data", info["content.xml"])
369
+ self.assertIn(b"General template", info["content.xml"])
370
+ self.assertIn(b"test_template", info["content.xml"])
371
+
372
+ # Secondly we generate a persistent document with multiple element in mailing list
373
+ api.portal.set_registry_record(
374
+ "collective.documentgenerator.mailing_list", orig_registry
375
+ )
376
+ generation_view = folder.restrictedTraverse("@@persistent-document-generation")
377
+ generation_view(template_uid, "odt")
378
+ generated_id = "possibly-mailed-template-1"
379
+ msg = "File {0} should have been created in folder.".format(generated_id)
380
+ self.assertTrue(generated_id in folder.objectIds(), msg)
381
+ persistent_doc = folder.get(generated_id)
382
+ annot = IAnnotations(persistent_doc)
383
+ self.assertIn("documentgenerator", annot)
384
+ self.assertIn("template_uid", annot["documentgenerator"])
385
+ self.assertIn("context_uid", annot["documentgenerator"])
386
+ self.assertEqual(annot["documentgenerator"]["need_mailing"], True)
387
+ generated_doc = persistent_doc.file
388
+ info = get_content(generated_doc)
389
+ self.assertNotIn(b"General template", info["content.xml"])
390
+ self.assertNotIn(b"test_template", info["content.xml"])
391
+ self.assertIn(b"mailed_data.title", info["content.xml"])
392
+ self.assertIn(b"mailed_data.id", info["content.xml"])
393
+ # check context variables
394
+ gen_context = generation_view._get_generation_context(
395
+ generation_view.get_generation_context_helper(), pod_template
396
+ )
397
+ self.assertIn("details", gen_context)
398
+ self.assertEqual(gen_context["details"], "1")
399
+
400
+ # the mailing loop view is called on the folder context !
401
+ generation_view = folder.restrictedTraverse(
402
+ "@@mailing-loop-persistent-document-generation"
403
+ )
404
+ generation_view(document_uid=persistent_doc.UID())
405
+ generation_view(document_url_path=persistent_doc.absolute_url_path())
406
+ generated_id = "mailing-loop-template"
407
+ generated_id_2 = "mailing-loop-template-1"
408
+ msg = "File {0} should have been created in folder.".format(generated_id)
409
+ self.assertTrue(generated_id in folder.objectIds(), msg)
410
+ msg = "File {0} should have been created in folder.".format(generated_id_2)
411
+ self.assertTrue(generated_id_2 in folder.objectIds(), msg)
412
+ persistent_doc = folder.get(generated_id)
413
+ annot = IAnnotations(persistent_doc)
414
+ self.assertIn("documentgenerator", annot)
415
+ self.assertIn("template_uid", annot["documentgenerator"])
416
+ self.assertNotIn("context_uid", annot["documentgenerator"])
417
+ self.assertEqual(annot["documentgenerator"]["need_mailing"], False)
418
+ generated_doc = persistent_doc.file
419
+ info = get_content(generated_doc)
420
+ self.assertNotIn(b"mailed_data.title", info["content.xml"])
421
+ self.assertIn(b"General template", info["content.xml"])
422
+ self.assertIn(b"test_template", info["content.xml"])
423
+ self.assertIn(b"Multiple format template", info["content.xml"])
424
+ self.assertIn(b"test_template_multiple", info["content.xml"])
425
+ self.assertIn(b"Collection template", info["content.xml"])
426
+ self.assertIn(b"test_template_bis", info["content.xml"])
427
+ # check that context variables from original template are also in mailing generation context
428
+ self.assertTrue(isinstance(generation_view.pod_template, MailingLoopTemplate))
429
+ gen_context = generation_view._get_generation_context(
430
+ generation_view.get_generation_context_helper(),
431
+ generation_view.pod_template,
432
+ )
433
+ self.assertIn("details", gen_context)
434
+ self.assertEqual(gen_context["details"], "1")
435
+
436
+ def test_table_column_modifier(self):
437
+ """ """
438
+ pod_template = self.portal.podtemplates.get("test_template_multiple")
439
+ # do not limit portal_type the POD template is generatable on
440
+ pod_template.pod_portal_types = []
441
+ template_uid = pod_template.UID()
442
+ doc = self.portal
443
+ # add a table to check if it is optimized or not
444
+ text = u"<table><tr><td>Text1</td><td>Text2</td></tr><tr><td>Text3</td><td>Text4</td></tr></table>"
445
+ textNone = (
446
+ u'<table style="table-layout:none"><tr><td>Text1</td><td>Text2</td></tr>'
447
+ u"<tr><td>Text3</td><td>Text4</td></tr></table>"
448
+ )
449
+ textAuto = (
450
+ u'<table style="table-layout:auto"><tr><td>Text1</td><td>Text2</td></tr>'
451
+ u"<tr><td>Text3</td><td>Text4</td></tr></table>"
452
+ )
453
+ textFixed = (
454
+ u'<table style="table-layout:fixed"><tr><td>Text1</td><td>Text2</td></tr>'
455
+ u"<tr><td>Text3</td><td>Text4</td></tr></table>"
456
+ )
457
+
458
+ generation_view = doc.restrictedTraverse("@@document-generation")
459
+
460
+ def set_text(text):
461
+ if base_hasattr(doc, "setText"):
462
+ # Archetypes
463
+ doc.setText(text)
464
+ else:
465
+ # Dexterity
466
+ doc.text = RichTextValue(text)
467
+
468
+ def assert_result(ocw_in_xml, dc_in_xml):
469
+ generated_doc = generation_view(template_uid, "odt")
470
+ content_xml = self.get_odt_content_xml(generated_doc)
471
+ self.assertEqual(
472
+ ocw_in_xml, b"OCW" in content_xml, "OCW not in content_xml"
473
+ )
474
+ self.assertEqual(dc_in_xml, b"DC" in content_xml, "DC not in content_xml")
475
+
476
+ # By default : column_modifier disabled globally, CSS override enabled globally
477
+ # and pod_template using global parameter
478
+ self.assertEqual(get_column_modifier(), "nothing")
479
+ self.assertEqual(pod_template.get_column_modifier(), -1)
480
+
481
+ set_text(text)
482
+ assert_result(False, False)
483
+ set_text(textNone)
484
+ assert_result(False, False)
485
+ set_text(textAuto)
486
+ assert_result(True, False)
487
+ set_text(textFixed)
488
+ assert_result(False, True)
489
+
490
+ # disable optimize locally, still disabled globally
491
+ pod_template.column_modifier = "disabled"
492
+ set_text(text)
493
+ assert_result(False, False)
494
+ set_text(textNone)
495
+ assert_result(False, False)
496
+ set_text(textAuto)
497
+ assert_result(False, False)
498
+ set_text(textFixed)
499
+ assert_result(False, False)
500
+
501
+ # enable optimize locally, still disabled globally
502
+ pod_template.column_modifier = "optimize"
503
+ set_text(text)
504
+ assert_result(True, False)
505
+ set_text(textNone)
506
+ assert_result(False, False)
507
+ set_text(textAuto)
508
+ assert_result(True, False)
509
+ set_text(textFixed)
510
+ assert_result(False, True)
511
+
512
+ # enable distribute locally, still disabled globally
513
+ pod_template.column_modifier = "distribute"
514
+ set_text(text)
515
+ assert_result(False, True)
516
+ set_text(textNone)
517
+ assert_result(False, False)
518
+ set_text(textAuto)
519
+ assert_result(True, False)
520
+ set_text(textFixed)
521
+ assert_result(False, True)
522
+
523
+ # reset local parameter
524
+ pod_template.column_modifier = -1
525
+
526
+ # CSS override enabled
527
+ set_column_modifier("nothing")
528
+ set_text(text)
529
+ assert_result(False, False)
530
+ set_text(textNone)
531
+ assert_result(False, False)
532
+ set_text(textAuto)
533
+ assert_result(True, False)
534
+ set_text(textFixed)
535
+ assert_result(False, True)
536
+
537
+ # disable all column modifier globally
538
+ set_column_modifier("disabled")
539
+ set_text(text)
540
+ assert_result(False, False)
541
+ set_text(textNone)
542
+ assert_result(False, False)
543
+ set_text(textAuto)
544
+ assert_result(False, False)
545
+ set_text(textFixed)
546
+ assert_result(False, False)
547
+
548
+ # optimize column_modifier enabled globally and pod_template using global parameter
549
+ set_column_modifier("optimize")
550
+ set_text(text)
551
+ assert_result(True, False)
552
+ set_text(textNone)
553
+ assert_result(False, False)
554
+ set_text(textAuto)
555
+ assert_result(True, False)
556
+ set_text(textFixed)
557
+ assert_result(False, True)
558
+
559
+ # distribute column_modifier enabled globally and pod_template using global parameter
560
+ set_column_modifier("distribute")
561
+ set_text(text)
562
+ assert_result(False, True)
563
+ set_text(textNone)
564
+ assert_result(False, False)
565
+ set_text(textAuto)
566
+ assert_result(True, False)
567
+ set_text(textFixed)
568
+ assert_result(False, True)
569
+
570
+
571
+ class TestCyclicMergesDetection(unittest.TestCase):
572
+ """ """
573
+
574
+ layer = POD_TEMPLATE_INTEGRATION
575
+
576
+ def setUp(self):
577
+ super(TestCyclicMergesDetection, self).setUp()
578
+
579
+ portal = api.portal.get()
580
+ self.generation_view = portal.restrictedTraverse("@@document-generation")
581
+
582
+ self.template_a = api.content.create(
583
+ type="ConfigurablePODTemplate",
584
+ id="template_a",
585
+ title="Modèle A",
586
+ container=portal.podtemplates,
587
+ )
588
+
589
+ self.template_b = api.content.create(
590
+ type="ConfigurablePODTemplate",
591
+ id="template_b",
592
+ title="Modèle B",
593
+ container=portal.podtemplates,
594
+ )
595
+
596
+ self.template_c = api.content.create(
597
+ type="ConfigurablePODTemplate",
598
+ id="template_c",
599
+ title="Modèle C",
600
+ container=portal.podtemplates,
601
+ )
602
+
603
+ self.template_d = api.content.create(
604
+ type="ConfigurablePODTemplate",
605
+ id="template_d",
606
+ title="Modèle D",
607
+ container=portal.podtemplates,
608
+ )
609
+
610
+ def _test_detect_cycle(self, template, should_raise, msg=""):
611
+ exception_raised = False
612
+ try:
613
+ self.generation_view._check_cyclic_merges(template)
614
+ except CyclicMergeTemplatesException:
615
+ exception_raised = True
616
+
617
+ self.assertTrue(exception_raised == should_raise, msg)
618
+
619
+ def test_detect_cycle_when_no_merge(self):
620
+ template = self.template_a
621
+ self.assertTrue(template.merge_templates == [])
622
+
623
+ msg = "Cyclic merge detection should not raise anything when no subtemplates to merge."
624
+ self._test_detect_cycle(template, should_raise=False, msg=msg)
625
+
626
+ def test_detect_cycle_on_linear_merge(self):
627
+ template_a = self.template_a
628
+ template_b = self.template_b
629
+ template_c = self.template_c
630
+ # set a chain such as template_a -> template_b -> template_c
631
+ template_a.set_merge_templates(template_b, "pod_b")
632
+ template_b.set_merge_templates(template_c, "pod_c")
633
+
634
+ msg = "Cyclic merge detection should not raise anything when import chain is not cyclic."
635
+ self._test_detect_cycle(template_a, should_raise=False, msg=msg)
636
+
637
+ def test_detect_cycle_on_linear_merge_with_duplicates(self):
638
+ template_a = self.template_a
639
+ template_b = self.template_b
640
+ template_c = self.template_c
641
+ # set a chain such as template_a -> template_b -> template_c
642
+ # \_> template c
643
+ template_a.set_merge_templates(template_b, "pod_b")
644
+ template_a.set_merge_templates(template_c, "pod_c")
645
+ template_b.set_merge_templates(template_c, "pod_c")
646
+
647
+ msg = "Cyclic merge detection should not raise anything when import chain is not cyclic."
648
+ self._test_detect_cycle(template_a, should_raise=False, msg=msg)
649
+
650
+ def test_detect_cycle_on_self_reference(self):
651
+ template = self.template_a
652
+ # import a configurable template on itself
653
+ template.set_merge_templates(template, "a")
654
+
655
+ msg = "Cyclic merge detection should raise Exception when a template tries to import itself."
656
+ self._test_detect_cycle(template, should_raise=True, msg=msg)
657
+
658
+ def test_detect_cycle_on_simple_cycle(self):
659
+ template_a = self.template_a
660
+ template_b = self.template_b
661
+ template_c = self.template_c
662
+ # set a cyclic chain such as (template_a -> template_b -> template_c -> template_a)
663
+ template_a.set_merge_templates(template_b, "pod_b")
664
+ template_b.set_merge_templates(template_c, "pod_c")
665
+ template_c.set_merge_templates(template_a, "pod_a")
666
+
667
+ msg = "Cyclic merge detection should raise Exception with cycle a -> b -> c -> a ."
668
+ self._test_detect_cycle(template_a, should_raise=True, msg=msg)
669
+
670
+ def test_detect_cycle_on_inner_cycle(self):
671
+ template_a = self.template_a
672
+ template_b = self.template_b
673
+ template_c = self.template_c
674
+ # set a an inner cyclic chain such as template_a -> (template_b -> template_c -> template_b)
675
+ template_a.set_merge_templates(template_b, "pod_b")
676
+ template_b.set_merge_templates(template_c, "pod_c")
677
+ template_c.set_merge_templates(template_b, "pod_b")
678
+
679
+ msg = "Cyclic merge detection should raise Exception with cycle b -> c -> b ."
680
+ self._test_detect_cycle(template_a, should_raise=True, msg=msg)