-
-
Notifications
You must be signed in to change notification settings - Fork 144
/
setuphandlers.py
551 lines (462 loc) · 19 KB
/
setuphandlers.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE.
#
# SENAITE.CORE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright 2018-2021 by it's authors.
# Some rights reserved, see README and LICENSE.
import itertools
from Acquisition import aq_base
from bika.lims import api
from bika.lims import logger
from bika.lims.catalog import auditlog_catalog
from bika.lims.catalog import getCatalogDefinitions
from bika.lims.catalog import setup_catalogs
from bika.lims.catalog.catalog_utilities import addZCTextIndex
from plone import api as ploneapi
from plone.app.controlpanel.filter import IFilterSchema
PROFILE_ID = "profile-bika.lims:default"
GROUPS = [
{
"id": "Analysts",
"title": "Analysts",
"roles": ["Analyst"],
}, {
"id": "Clients",
"title": "Clients",
"roles": ["Client"],
}, {
"id": "LabClerks",
"title": "Lab Clerks",
"roles": ["LabClerk"],
}, {
"id": "LabManagers",
"title": "Lab Managers",
"roles": ["LabManager"],
}, {
"id": "Preservers",
"title": "Preservers",
"roles": ["Preserver"],
}, {
"id": "Publishers",
"title": "Publishers",
"roles": ["Publisher"],
}, {
"id": "Verifiers",
"title": "Verifiers",
"roles": ["Verifier"],
}, {
"id": "Samplers",
"title": "Samplers",
"roles": ["Sampler"],
}, {
"id": "RegulatoryInspectors",
"title": "Regulatory Inspectors",
"roles": ["RegulatoryInspector"],
}, {
"id": "SamplingCoordinators",
"title": "Sampling Coordinator",
"roles": ["SamplingCoordinator"],
}
]
NAV_BAR_ITEMS_TO_HIDE = (
# List of items to hide from navigation bar
"pricelists",
"supplyorders",
)
CONTENTS_TO_DELETE = (
# List of items to delete
"Members",
"news",
"events",
)
CATALOG_MAPPINGS = (
# portal_type, catalog_ids
("ARTemplate", ["bika_setup_catalog", "portal_catalog"]),
("AnalysisCategory", ["bika_setup_catalog"]),
("AnalysisProfile", ["bika_setup_catalog", "portal_catalog"]),
("AnalysisService", ["bika_setup_catalog", "portal_catalog"]),
("AnalysisSpec", ["bika_setup_catalog"]),
("Attachment", ["portal_catalog"]),
("AttachmentType", ["bika_setup_catalog"]),
("Batch", ["bika_catalog", "portal_catalog"]),
("BatchLabel", ["bika_setup_catalog"]),
("Calculation", ["bika_setup_catalog", "portal_catalog"]),
("Container", ["bika_setup_catalog"]),
("ContainerType", ["bika_setup_catalog"]),
("Department", ["bika_setup_catalog", "portal_catalog"]),
("Instrument", ["bika_setup_catalog", "portal_catalog"]),
("InstrumentLocation", ["bika_setup_catalog", "portal_catalog"]),
("InstrumentType", ["bika_setup_catalog", "portal_catalog"]),
("LabContact", ["bika_setup_catalog", "portal_catalog"]),
("LabProduct", ["bika_setup_catalog", "portal_catalog"]),
("Manufacturer", ["bika_setup_catalog", "portal_catalog"]),
("Method", ["bika_setup_catalog", "portal_catalog"]),
("Multifile", ["bika_setup_catalog"]),
("Preservation", ["bika_setup_catalog"]),
("ReferenceDefinition", ["bika_setup_catalog", "portal_catalog"]),
("ReferenceSample", ["bika_catalog", "portal_catalog"]),
("SampleCondition", ["bika_setup_catalog"]),
("SampleMatrix", ["bika_setup_catalog"]),
("SamplePoint", ["bika_setup_catalog", "portal_catalog"]),
("SampleType", ["bika_setup_catalog", "portal_catalog"]),
("SamplingDeviation", ["bika_setup_catalog"]),
("StorageLocation", ["bika_setup_catalog", "portal_catalog"]),
("SubGroup", ["bika_setup_catalog"]),
("Supplier", ["bika_setup_catalog", "portal_catalog"]),
("WorksheetTemplate", ["bika_setup_catalog", "portal_catalog"]),
)
INDEXES = (
# catalog, id, indexed attribute, type
("bika_catalog", "BatchDate", "", "DateIndex"),
("bika_catalog", "Creator", "", "FieldIndex"),
("bika_catalog", "Description", "", "ZCTextIndex"),
("bika_catalog", "Title", "", "ZCTextIndex"),
("bika_catalog", "Type", "", "FieldIndex"),
("bika_catalog", "UID", "", "FieldIndex"),
("bika_catalog", "allowedRolesAndUsers", "", "KeywordIndex"),
("bika_catalog", "created", "", "DateIndex"),
("bika_catalog", "getBlank", "", "BooleanIndex"),
("bika_catalog", "getClientBatchID", "", "FieldIndex"),
("bika_catalog", "getClientID", "", "FieldIndex"),
("bika_catalog", "getClientTitle", "", "FieldIndex"),
("bika_catalog", "getClientUID", "", "FieldIndex"),
("bika_catalog", "getDateReceived", "", "DateIndex"),
("bika_catalog", "getDateSampled", "", "DateIndex"),
("bika_catalog", "getDueDate", "", "DateIndex"),
("bika_catalog", "getExpiryDate", "", "DateIndex"),
("bika_catalog", "getId", "", "FieldIndex"),
("bika_catalog", "getReferenceDefinitionUID", "", "FieldIndex"),
("bika_catalog", "getSupportedServices", "", "KeywordIndex"),
("bika_catalog", "id", "getId", "FieldIndex"),
("bika_catalog", "isValid", "", "BooleanIndex"),
("bika_catalog", "is_active", "", "BooleanIndex"),
("bika_catalog", "path", "getPhysicalPath", "ExtendedPathIndex"),
("bika_catalog", "portal_type", "", "FieldIndex"),
("bika_catalog", "review_state", "", "FieldIndex"),
("bika_catalog", "sortable_title", "", "FieldIndex"),
("bika_catalog", "title", "", "FieldIndex"),
("bika_catalog", "listing_searchable_text", "", "TextIndexNG3"),
("bika_setup_catalog", "Creator", "", "FieldIndex"),
("bika_setup_catalog", "Description", "", "ZCTextIndex"),
("bika_setup_catalog", "Title", "", "ZCTextIndex"),
("bika_setup_catalog", "Type", "", "FieldIndex"),
("bika_setup_catalog", "UID", "", "FieldIndex"),
("bika_setup_catalog", "allowedRolesAndUsers", "", "KeywordIndex"),
("bika_setup_catalog", "category_uid", "", "KeywordIndex"),
("bika_setup_catalog", "created", "", "DateIndex"),
("bika_setup_catalog", "department_title", "", "KeywordIndex"),
("bika_setup_catalog", "department_uid", "", "KeywordIndex"),
("bika_setup_catalog", "getClientUID", "", "FieldIndex"),
("bika_setup_catalog", "getId", "", "FieldIndex"),
("bika_setup_catalog", "getKeyword", "", "FieldIndex"),
("bika_setup_catalog", "id", "getId", "FieldIndex"),
("bika_setup_catalog", "instrument_title", "", "KeywordIndex"),
("bika_setup_catalog", "instrumenttype_title", "", "KeywordIndex"),
("bika_setup_catalog", "is_active", "", "BooleanIndex"),
("bika_setup_catalog", "listing_searchable_text", "", "TextIndexNG3"),
("bika_setup_catalog", "method_available_uid", "", "KeywordIndex"),
("bika_setup_catalog", "path", "getPhysicalPath", "ExtendedPathIndex"),
("bika_setup_catalog", "point_of_capture", "", "FieldIndex"),
("bika_setup_catalog", "portal_type", "", "FieldIndex"),
("bika_setup_catalog", "price", "", "FieldIndex"),
("bika_setup_catalog", "price_total", "", "FieldIndex"),
("bika_setup_catalog", "review_state", "", "FieldIndex"),
("bika_setup_catalog", "sampletype_title", "", "KeywordIndex"),
("bika_setup_catalog", "sampletype_uid", "", "KeywordIndex"),
("bika_setup_catalog", "sortable_title", "", "FieldIndex"),
("bika_setup_catalog", "title", "", "FieldIndex"),
("portal_catalog", "Analyst", "", "FieldIndex"),
("portal_catalog", "sample_uid", "", "KeywordIndex"),
)
COLUMNS = (
# catalog, column name
("bika_catalog", "path"),
("bika_catalog", "UID"),
("bika_catalog", "id"),
("bika_catalog", "getId"),
("bika_catalog", "Type"),
("bika_catalog", "portal_type"),
("bika_catalog", "creator"),
("bika_catalog", "Created"),
("bika_catalog", "Title"),
("bika_catalog", "Description"),
("bika_catalog", "sortable_title"),
("bika_catalog", "getClientTitle"),
("bika_catalog", "getClientID"),
("bika_catalog", "getClientBatchID"),
("bika_catalog", "getDateReceived"),
("bika_catalog", "getDateSampled"),
("bika_catalog", "review_state"),
("bika_catalog", "getProgress"),
("bika_setup_catalog", "path"),
("bika_setup_catalog", "UID"),
("bika_setup_catalog", "id"),
("bika_setup_catalog", "getId"),
("bika_setup_catalog", "Type"),
("bika_setup_catalog", "portal_type"),
("bika_setup_catalog", "Title"),
("bika_setup_catalog", "Description"),
("bika_setup_catalog", "title"),
("bika_setup_catalog", "sortable_title"),
("bika_setup_catalog", "description"),
("bika_setup_catalog", "review_state"),
("bika_setup_catalog", "getCategoryTitle"),
("bika_setup_catalog", "getCategoryUID"),
("bika_setup_catalog", "getClientUID"),
("bika_setup_catalog", "getKeyword"),
("portal_catalog", "Analyst"),
)
ALLOWED_STYLES = [
"color",
"background-color"
]
def pre_install(portal_setup):
"""Runs before the first import step of the *default* profile
This handler is registered as a *pre_handler* in the generic setup profile
:param portal_setup: SetupTool
"""
logger.info("SENAITE PRE-INSTALL handler [BEGIN]")
# https://docs.plone.org/develop/addons/components/genericsetup.html#custom-installer-code-setuphandlers-py
profile_id = PROFILE_ID
context = portal_setup._getImportContext(profile_id)
portal = context.getSite() # noqa
logger.info("SENAITE PRE-INSTALL handler [DONE]")
def post_install(portal_setup):
"""Runs after the last import step of the *default* profile
This handler is registered as a *post_handler* in the generic setup profile
:param portal_setup: SetupTool
"""
logger.info("SENAITE POST-INSTALL handler [BEGIN]")
# https://docs.plone.org/develop/addons/components/genericsetup.html#custom-installer-code-setuphandlers-py
profile_id = PROFILE_ID
context = portal_setup._getImportContext(profile_id)
portal = context.getSite() # noqa
logger.info("SENAITE POST-INSTALL handler [DONE]")
def setup_handler(context):
"""SENAITE setup handler
"""
if context.readDataFile("bika.lims_various.txt") is None:
return
logger.info("SENAITE setup handler [BEGIN]")
portal = context.getSite()
# Run Installers
remove_default_content(portal)
hide_navbar_items(portal)
reindex_content_structure(portal)
setup_groups(portal)
setup_catalog_mappings(portal)
setup_core_catalogs(portal)
add_dexterity_setup_items(portal)
setup_html_filter(portal)
# Setting up all LIMS catalogs defined in catalog folder
setup_catalogs(portal, getCatalogDefinitions())
# Run after all catalogs have been setup
setup_auditlog_catalog(portal)
# Set CMF Form actions
setup_form_controller_actions(portal)
logger.info("SENAITE setup handler [DONE]")
def remove_default_content(portal):
"""Remove default Plone contents
"""
logger.info("*** Delete Default Content ***")
# Get the list of object ids for portal
object_ids = portal.objectIds()
delete_ids = filter(lambda id: id in object_ids, CONTENTS_TO_DELETE)
portal.manage_delObjects(ids=delete_ids)
def hide_navbar_items(portal):
"""Hide root items in navigation
"""
logger.info("*** Hide Navigation Items ***")
# Get the list of object ids for portal
object_ids = portal.objectIds()
object_ids = filter(lambda id: id in object_ids, NAV_BAR_ITEMS_TO_HIDE)
for object_id in object_ids:
item = portal[object_id]
item.setExcludeFromNav(True)
item.reindexObject()
def reindex_content_structure(portal):
"""Reindex contents generated by Generic Setup
"""
logger.info("*** Reindex content structure ***")
def reindex(obj, recurse=False):
# skip catalog tools etc.
if api.is_object(obj):
obj.reindexObject()
if recurse and hasattr(aq_base(obj), "objectValues"):
map(reindex, obj.objectValues())
setup = api.get_setup()
setupitems = setup.objectValues()
rootitems = portal.objectValues()
for obj in itertools.chain(setupitems, rootitems):
logger.info("Reindexing {}".format(repr(obj)))
reindex(obj)
def setup_groups(portal):
"""Setup roles and groups
"""
logger.info("*** Setup Roles and Groups ***")
portal_groups = api.get_tool("portal_groups")
for gdata in GROUPS:
group_id = gdata["id"]
# create the group and grant the roles
if group_id not in portal_groups.listGroupIds():
logger.info("+++ Adding group {title} ({id})".format(**gdata))
portal_groups.addGroup(group_id,
title=gdata["title"],
roles=gdata["roles"])
# grant the roles to the existing group
else:
ploneapi.group.grant_roles(
groupname=gdata["id"],
roles=gdata["roles"],)
logger.info("+++ Granted group {title} ({id}) the roles {roles}"
.format(**gdata))
def setup_catalog_mappings(portal):
"""Setup portal_type -> catalog mappings
"""
logger.info("*** Setup Catalog Mappings ***")
at = api.get_tool("archetype_tool")
for portal_type, catalogs in CATALOG_MAPPINGS:
at.setCatalogsByType(portal_type, catalogs)
def setup_core_catalogs(portal):
"""Setup core catalogs
"""
logger.info("*** Setup Core Catalogs ***")
to_reindex = []
for catalog, name, attribute, meta_type in INDEXES:
c = api.get_tool(catalog)
indexes = c.indexes()
if name in indexes:
logger.info("*** Index '%s' already in Catalog [SKIP]" % name)
continue
logger.info("*** Adding Index '%s' for field '%s' to catalog ..."
% (meta_type, name))
# do we still need ZCTextIndexes?
if meta_type == "ZCTextIndex":
addZCTextIndex(c, name)
else:
c.addIndex(name, meta_type)
# get the new created index
index = c._catalog.getIndex(name)
# set the indexed attributes
if hasattr(index, "indexed_attrs"):
index.indexed_attrs = [attribute or name]
to_reindex.append((c, name))
logger.info("*** Added Index '%s' for field '%s' to catalog [DONE]"
% (meta_type, name))
# catalog columns
for catalog, name in COLUMNS:
c = api.get_tool(catalog)
if name not in c.schema():
logger.info("*** Adding Column '%s' to catalog '%s' ..."
% (name, catalog))
c.addColumn(name)
logger.info("*** Added Column '%s' to catalog '%s' [DONE]"
% (name, catalog))
else:
logger.info("*** Column '%s' already in catalog '%s' [SKIP]"
% (name, catalog))
continue
for catalog, name in to_reindex:
logger.info("*** Indexing new index '%s' ..." % name)
catalog.manage_reindexIndex(name)
logger.info("*** Indexing new index '%s' [DONE]" % name)
def setup_auditlog_catalog(portal):
"""Setup auditlog catalog
"""
logger.info("*** Setup Audit Log Catalog ***")
catalog_id = auditlog_catalog.CATALOG_AUDITLOG
catalog = api.get_tool(catalog_id)
for name, meta_type in auditlog_catalog._indexes.iteritems():
indexes = catalog.indexes()
if name in indexes:
logger.info("*** Index '%s' already in Catalog [SKIP]" % name)
continue
logger.info("*** Adding Index '%s' for field '%s' to catalog ..."
% (meta_type, name))
catalog.addIndex(name, meta_type)
# Setup TextIndexNG3 for listings
# XXX is there another way to do this?
if meta_type == "TextIndexNG3":
index = catalog._catalog.getIndex(name)
index.index.default_encoding = "utf-8"
index.index.query_parser = "txng.parsers.en"
index.index.autoexpand = "always"
index.index.autoexpand_limit = 3
logger.info("*** Added Index '%s' for field '%s' to catalog [DONE]"
% (meta_type, name))
# Attach the catalog to all known portal types
at = api.get_tool("archetype_tool")
pt = api.get_tool("portal_types")
for portal_type in pt.listContentTypes():
catalogs = at.getCatalogsByType(portal_type)
if catalog not in catalogs:
new_catalogs = map(lambda c: c.getId(), catalogs) + [catalog_id]
at.setCatalogsByType(portal_type, new_catalogs)
logger.info("*** Adding catalog '{}' for '{}'".format(
catalog_id, portal_type))
def setup_form_controller_actions(portal):
"""Setup custom CMF Form actions
"""
logger.info("*** Setup Form Controller custom actions ***")
fc_tool = api.get_tool("portal_form_controller")
# Redirect the user to Worksheets listing view after the "remove" action
# from inside Worksheet context is pressed
# https://github.com/senaite/senaite.core/pull/1480
fc_tool.addFormAction(
object_id="content_status_modify",
status="success",
context_type="Worksheet",
button=None,
action_type="redirect_to",
action_arg="python:object.aq_inner.aq_parent.absolute_url()")
def add_dexterity_setup_items(portal):
"""Adds the Dexterity Container in the Setup Folder
N.B.: We do this in code, because adding this as Generic Setup Profile in
`profiles/default/structure` flushes the contents on every import.
"""
setup = api.get_setup()
pt = api.get_tool("portal_types")
ti = pt.getTypeInfo(setup)
# Disable content type filtering
ti.filter_content_types = False
# Tuples of ID, Title, FTI
items = [
("dynamic_analysisspecs", # ID
"Dynamic Analysis Specifications", # Title
"DynamicAnalysisSpecs"), # FTI
]
for id, title, fti in items:
obj = setup.get(id)
if setup.get(id) is None:
logger.info("Adding Setup Item for '{}'".format(id))
setup.invokeFactory(fti, id, title=title)
else:
obj.setTitle(title)
obj.reindexObject()
# Enable content type filtering
ti.filter_content_types = True
def setup_html_filter(portal):
"""Setup HTML filtering for resultsinterpretations
"""
logger.info("*** Setup HTML Filter ***")
# bypass the broken API from portal_transforms
adapter = IFilterSchema(portal)
style_whitelist = adapter.style_whitelist
for style in ALLOWED_STYLES:
logger.info("Allow style '{}'".format(style))
if style not in style_whitelist:
style_whitelist.append(style)
adapter.style_whitelist = style_whitelist