-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathconfig.py
More file actions
4365 lines (4181 loc) · 171 KB
/
Copy pathconfig.py
File metadata and controls
4365 lines (4181 loc) · 171 KB
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SPDX-FileCopyrightText: Fondation RERO+
# SPDX-FileCopyrightText: UCLouvain
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Default configuration for rero-ils.
You overwrite and set instance-specific configuration by either:
- Configuration file: ``<virtualenv prefix>/var/instance/invenio.cfg``
- Environment variables: ``APP_<variable name>``
"""
from __future__ import absolute_import, print_function
import os
from functools import partial
from celery import schedules
from flask import request
from invenio_circulation.pidstore.pids import (
CIRCULATION_LOAN_FETCHER,
CIRCULATION_LOAN_MINTER,
CIRCULATION_LOAN_PID_TYPE,
)
from invenio_circulation.transitions.transitions import (
CreatedToPending,
ItemAtDeskToItemOnLoan,
ItemInTransitHouseToItemReturned,
ItemOnLoanToItemInTransitHouse,
ItemOnLoanToItemOnLoan,
ItemOnLoanToItemReturned,
PendingToItemAtDesk,
PendingToItemInTransitPickup,
ToCancelled,
ToItemOnLoan,
)
from invenio_records_rest.facets import range_filter, terms_filter
from invenio_records_rest.utils import allow_all, deny_all
from rero_ils.modules.acquisition.acq_accounts.api import AcqAccount
from rero_ils.modules.acquisition.acq_accounts.permissions import (
AcqAccountPermissionPolicy,
)
from rero_ils.modules.acquisition.acq_order_lines.api import AcqOrderLine
from rero_ils.modules.acquisition.acq_order_lines.permissions import (
AcqOrderLinePermissionPolicy,
)
from rero_ils.modules.acquisition.acq_orders.api import AcqOrder
from rero_ils.modules.acquisition.acq_orders.permissions import AcqOrderPermissionPolicy
from rero_ils.modules.acquisition.acq_receipt_lines.api import AcqReceiptLine
from rero_ils.modules.acquisition.acq_receipt_lines.permissions import (
AcqReceiptLinePermissionPolicy,
)
from rero_ils.modules.acquisition.acq_receipts.api import AcqReceipt
from rero_ils.modules.acquisition.acq_receipts.permissions import (
AcqReceiptPermissionPolicy,
)
from rero_ils.modules.acquisition.budgets.api import Budget
from rero_ils.modules.acquisition.budgets.permissions import BudgetPermissionPolicy
from rero_ils.modules.entities.local_entities.api import LocalEntity
from rero_ils.modules.entities.local_entities.permissions import (
LocalEntityPermissionPolicy,
)
from rero_ils.modules.entities.models import EntityFieldWithRef, EntityType
from rero_ils.modules.entities.remote_entities.api import RemoteEntity
from rero_ils.modules.entities.remote_entities.permissions import (
RemoteEntityPermissionPolicy,
)
from rero_ils.modules.loans.api import LoansSearch
#: User profile
from rero_ils.modules.users.schemas import UserProfile
from .modules.circ_policies.api import CircPolicy
from .modules.circ_policies.permissions import CirculationPolicyPermissionPolicy
from .modules.collections.api import Collection
from .modules.collections.permissions import CollectionPermissionPolicy
from .modules.documents.api import Document
from .modules.documents.permissions import DocumentPermissionPolicy
from .modules.documents.query import acquisition_filter, nested_identified_filter
from .modules.holdings.api import Holding
from .modules.holdings.models import HoldingCirculationAction
from .modules.holdings.permissions import HoldingsPermissionPolicy
from .modules.ill_requests.api import ILLRequest
from .modules.ill_requests.permissions import ILLRequestPermissionPolicy
from .modules.item_types.api import ItemType
from .modules.item_types.permissions import ItemTypePermissionPolicy
from .modules.items.api import Item
from .modules.items.models import ItemCirculationAction
from .modules.items.permissions import ItemPermissionPolicy
from .modules.items.utils import item_location_retriever, same_location_validator
from .modules.libraries.api import Library
from .modules.libraries.permissions import LibraryPermissionPolicy
from .modules.loans.api import Loan
from .modules.loans.models import LoanState
from .modules.loans.permissions import LoanPermissionPolicy
from .modules.loans.query import misc_status_filter
from .modules.loans.utils import (
can_be_requested,
get_default_loan_duration,
get_extension_params,
loan_build_document_ref,
loan_build_item_ref,
loan_build_patron_ref,
validate_item_pickup_transaction_locations,
validate_loan_duration,
)
from .modules.local_fields.api import LocalField
from .modules.local_fields.permissions import LocalFieldPermissionPolicy
from .modules.locations.api import Location
from .modules.locations.permissions import LocationPermissionPolicy
from .modules.notifications.api import Notification
from .modules.notifications.dispatcher import Dispatcher as NotificationDispatcher
from .modules.notifications.models import NotificationType
from .modules.notifications.permissions import NotificationPermissionPolicy
from .modules.operation_logs.api import OperationLog
from .modules.operation_logs.permissions import OperationLogPermissionPolicy
from .modules.organisations.api import Organisation
from .modules.organisations.permissions import OrganisationPermissionPolicy
from .modules.patron_transaction_events.api import PatronTransactionEvent
from .modules.patron_transaction_events.permissions import (
PatronTransactionEventPermissionPolicy,
)
from .modules.patron_transaction_events.utils import total_facet_filter_builder
from .modules.patron_transactions.api import PatronTransaction
from .modules.patron_transactions.permissions import PatronTransactionPermissionPolicy
from .modules.patron_types.api import PatronType
from .modules.patron_types.permissions import PatronTypePermissionPolicy
from .modules.patrons.api import Patron
from .modules.patrons.models import CommunicationChannel
from .modules.patrons.permissions import PatronPermissionPolicy
from .modules.patrons.query import patron_expiration_filter
from .modules.selfcheck.permissions import seflcheck_permission_factory
from .modules.stats.api.api import Stat
from .modules.stats.permissions import StatisticsPermissionPolicy
from .modules.stats_cfg.api import StatConfiguration
from .modules.stats_cfg.permissions import StatisticsConfigurationPermissionPolicy
from .modules.templates.permissions import TemplatePermissionPolicy
from .modules.users.api import get_profile_countries, get_readonly_profile_fields
from .modules.users.models import UserRole
from .modules.vendors.api import Vendor
from .modules.vendors.permissions import VendorPermissionPolicy
from .permissions import (
librarian_delete_permission_factory,
librarian_permission_factory,
librarian_update_permission_factory,
wiki_edit_ui_permission,
wiki_edit_view_permission,
)
from .query import (
and_i18n_term_filter,
and_term_filter,
exclude_terms_filter,
i18n_terms_filter,
or_terms_filter_by_criteria,
)
from .theme.forms import LoginForm
from .utils import TranslatedList, get_current_language
APP_THEME = ["bootstrap3"]
def _(x):
"""Identity function used to trigger string extraction."""
return x
# Personalized homepage
RERO_ILS_PERSONALIZED_CSS_BY_VIEW = True
RERO_ILS_HOMEPAGE_GENERAL_BLOCK = "rero_ils/_frontpage_block_test.html"
RERO_ILS_HOMEPAGE_GENERAL_SLOGAN = "rero_ils/_frontpage_slogan_test.html"
#: Link to privacy and data protection policy for the instance
RERO_ILS_PRIVACY_POLICY_URL = (
"https://www.rero.ch/legal/privacy/declaration_protection_donnees_RERO-ILS.pdf"
)
# ILL Request config
RERO_ILS_ILL_REQUEST_ON_GLOBAL_VIEW = True
RERO_ILS_ILL_DEFAULT_SOURCE = "RERO +"
RERO_ILS_ILL_HIDE_MONTHS = 6
# DOCUMENT ADVANCED SEARCH
RERO_ILS_DOCUMENT_ADVANCED_SEARCH = True
# Rate limiting
# =============
#: Storage for ratelimiter.
RATELIMIT_STORAGE_URI = "redis://localhost:6379/3"
RATELIMIT_DEFAULT = "5000/second"
RATELIMIT_ENABLED = False
# I18N
# ====
#: Default language
BABEL_DEFAULT_LANGUAGE = "en"
RERO_ILS_DEFAULT_LANGUAGE = "eng"
#: Default time zone
BABEL_DEFAULT_TIMEZONE = "Europe/Zurich"
#: Other supported languages (do not include the default language in list).
I18N_LANGUAGES = [
("fr", _("French")),
("de", _("German")),
("it", _("Italian")),
]
# Define the default system currency in used. Each organisation can override
# this parameter using the "default_currency" field
RERO_ILS_DEFAULT_CURRENCY = "CHF"
# Base templates
# ==============
#: Global base template.
BASE_TEMPLATE = "rero_ils/page.html"
#: Cover page base template (used for e.g. login/sign-up).
COVER_TEMPLATE = "rero_ils/page_cover.html"
#: Footer base template.
FOOTER_TEMPLATE = "rero_ils/footer.html"
#: Header base template.
HEADER_TEMPLATE = "rero_ils/header.html"
#: Settings base template
SETTINGS_TEMPLATE = "rero_ils/page_settings.html"
#: Admin base template
# ADMIN_BASE_TEMPLATE = BASE_TEMPLATE
# Google
# =======================
# THEME_GOOGLE_SITE_VERIFICATION = []
# Example of id: UA-XXXXXX-XX
# RERO_ILS_GOOGLE_ANALYTICS_TAG_ID =
# Miscellaneous variable around templates
# =======================
#: Template for security pages.
SECURITY_LOGIN_USER_TEMPLATE = "rero_ils/login_user.html"
SECURITY_REGISTER_USER_TEMPLATE = "rero_ils/register_user.html"
SECURITY_FORGOT_PASSWORD_TEMPLATE = "rero_ils/forgot_password.html"
SECURITY_RESET_PASSWORD_TEMPLATE = "rero_ils/reset_password.html"
RERO_ILS_SEARCH_TEMPLATE = "rero_ils/search.html"
# Theme configuration
# ===================
#: Brand logo.
THEME_LOGO = "images/logo-rero-plus.svg"
#: Site name
THEME_SITENAME = _("rero-ils")
#: Use default frontpage.
THEME_FRONTPAGE = False
#: Frontpage title.
THEME_FRONTPAGE_TITLE = _("rero-ils")
#: Frontpage template.
THEME_FRONTPAGE_TEMPLATE = "rero_ils/frontpage.html"
#: Theme base template.
THEME_BASE_TEMPLATE = BASE_TEMPLATE
#: Cover page theme template (used for e.g. login/sign-up).
THEME_COVER_TEMPLATE = COVER_TEMPLATE
#: Footer theme template.
THEME_FOOTER_TEMPLATE = FOOTER_TEMPLATE
#: Header theme template.
THEME_HEADER_TEMPLATE = HEADER_TEMPLATE
#: Settings page template used for e.g. display user settings views.
THEME_SETTINGS_TEMPLATE = SETTINGS_TEMPLATE
#: Template for error pages.
THEME_ERROR_TEMPLATE = "rero_ils/page_error.html"
#: Local path for organisation-specific CSS customization files.
#: CSS files are served from static assets (e.g., aoste.css, global.css).
RERO_ILS_THEME_ORGANISATION_CSS_ENDPOINT = "/static/themes/css/"
#: Template for including a tracking code for web analytics.
THEME_TRACKINGCODE_TEMPLATE = "rero_ils/trackingcode.html"
THEME_JAVASCRIPT_TEMPLATE = "rero_ils/javascript.html"
# Email configuration
# ===================
#: Email address for support.
SUPPORT_EMAIL = "software@rero.ch"
#: Disable email sending by default.
MAIL_SUPPRESS_SEND = True
#: Default sender email
DEFAULT_SENDER_EMAIL = "noreply@rero.ch"
# Assets
# ======
#: Static files collection method (defaults to symbolic link to files).
COLLECT_STORAGE = "flask_collect.storage.link"
# Accounts
# ========
#: Email address used as sender of account registration emails.
SECURITY_EMAIL_SENDER = SUPPORT_EMAIL
#: Email subject for account registration emails.
SECURITY_EMAIL_SUBJECT_REGISTER = _("Welcome")
#: Email subjects for password reset
SECURITY_EMAIL_SUBJECT_PASSWORD_RESET = _("RERO ID password reset")
SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE = _("Your RERO ID password has been reset")
#: Custom login form to support username login
SECURITY_LOGIN_FORM = LoginForm
#: Redis session storage URL.
ACCOUNTS_SESSION_REDIS_URL = "redis://localhost:6379/1"
#: Redis instances to expose via the monitoring API, keyed by display name.
#: Values are config keys; instances whose URL is absent or non-Redis are skipped.
RERO_ILS_MONITORING_REDIS_INSTANCES = {
"cache": "CACHE_REDIS_URL",
"sessions": "ACCOUNTS_SESSION_REDIS_URL",
"celery_results": "CELERY_RESULT_BACKEND",
"ratelimit": "RATELIMIT_STORAGE_URI",
"celery_scheduler": "CELERY_REDIS_SCHEDULER_URL",
"import_cache": "RERO_ILS_IMPORT_CACHE",
"sip2": "SIP2_DATASTORE_REDIS_URL",
}
#: Enable session/user id request tracing. This feature will add X-Session-ID
#: and X-User-ID headers to HTTP response. You MUST ensure that NGINX (or other
#: proxies) removes these headers again before sending the response to the
#: client. Set to False, in case of doubt.
ACCOUNTS_USERINFO_HEADERS = False
#: The regular expression used for validating usernames
#: Note: should support barcode .
ACCOUNTS_USERNAME_REGEX = r"^[a-zA-Z0-9-_]{2,255}$"
#: Description of username validation rules.
ACCOUNTS_USERNAME_RULES_TEXT = _(
"Username must start with a letter or a number, be at least three"
" characters long and only contain alphanumeric characters, dashes"
" and underscores."
)
ACCOUNTS_USER_PROFILE_SCHEMA = UserProfile
RERO_ILS_PUBLIC_USERPROFILES_READONLY = False
RERO_ILS_PUBLIC_USERPROFILES_READONLY_FIELDS = ["first_name", "last_name", "birth_date"]
#: USER PROFILES
USERPROFILES_READ_ONLY = False
# Disable User Profiles
USERPROFILES = True
USERPROFILES_COUNTRIES = get_profile_countries
USERPROFILES_DEFAULT_COUNTRY = "sz"
USERPROFILES_READONLY_FIELDS = get_readonly_profile_fields
# Custom login view
ACCOUNTS_REST_AUTH_VIEWS = {
"login": "rero_ils.accounts_views:LoginView",
"logout": "rero_ils.accounts_views:DisabledAuthApiView",
"user_info": "rero_ils.accounts_views:DisabledAuthApiView",
"register": "rero_ils.accounts_views:DisabledAuthApiView",
"forgot_password": "rero_ils.accounts_views:DisabledAuthApiView",
"reset_password": "rero_ils.accounts_views:DisabledAuthApiView",
"change_password": "rero_ils.accounts_views:ChangePasswordView",
"send_confirmation": "rero_ils.accounts_views:DisabledAuthApiView",
"confirm_email": "rero_ils.accounts_views:DisabledAuthApiView",
"sessions_list": "rero_ils.accounts_views:DisabledAuthApiView",
"sessions_item": "rero_ils.accounts_views:DisabledAuthApiView",
}
ACCOUNTS_REGISTER_BLUEPRINT = True
"""Needed to generate reset password link."""
SECURITY_LOGIN_URL = "/signin/"
"""URL endpoint for login."""
SECURITY_LOGOUT_URL = "/signout/"
"""URL endpoint for logout."""
# Celery configuration
# ====================
#: URL of message broker for Celery (default is RabbitMQ).
CELERY_BROKER_URL = "amqp://guest:guest@localhost:5672/"
#: URL of backend for result storage (default is Redis).
CELERY_RESULT_BACKEND = "redis://localhost:6379/2"
#: Scheduled tasks configuration (aka cronjobs).
CELERY_BEAT_SCHEDULE = {
"celery.scheduler-timestamp": {
"task": ("rero_ils.modules.tasks.scheduler_timestamp"),
"schedule": schedules.timedelta(minutes=1),
"enabled": False,
# Save a timestamp so we can externally test the timestamp changed every minute. If the timestamp is not
# changing the scheduler is not working.
},
"celery.bulk-indexer": {
"task": "rero_ils.modules.tasks.process_bulk_queue",
"schedule": schedules.timedelta(minutes=1),
"enabled": False,
},
"celery.accounts": {
"task": "invenio_accounts.tasks.clean_session_table",
"schedule": schedules.timedelta(minutes=60),
"enabled": False,
},
"celery.notification-creation": {
"task": "rero_ils.modules.notifications.tasks.create_notifications",
"schedule": schedules.crontab(minute=0, hour=3), # Every day at 05:00 UTC,
"kwargs": {"types": [NotificationType.DUE_SOON, NotificationType.OVERDUE]},
"enabled": False,
# TODO: in production set this up once a day
},
"celery.notification-dispatch-availability": {
"task": "rero_ils.modules.notifications.tasks.process_notifications",
"schedule": schedules.timedelta(minutes=15),
"kwargs": {"notification_type": NotificationType.AVAILABILITY},
"enabled": False,
},
"celery.notification-dispatch-recall": {
"task": "rero_ils.modules.notifications.tasks.process_notifications",
"schedule": schedules.timedelta(minutes=15),
"kwargs": {"notification_type": NotificationType.RECALL},
"enabled": False,
},
"celery.claims-creation": {
"task": "rero_ils.modules.items.tasks.process_late_issues",
"schedule": schedules.crontab(minute=0, hour=6), # Every day at 06:00 UTC,
"enabled": False,
},
"celery.clean-obsolete-temporary-item-types-and-locations": {
"task": (
"rero_ils.modules.items.tasks"
".clean_obsolete_temporary_item_types_and_locations"
),
"schedule": schedules.crontab(minute=15, hour=2), # Every day at 02:15 UTC,
"enabled": False,
},
"celery.cancel-expired-request": {
"task": "rero_ils.modules.loans.tasks.cancel_expired_request_task",
"schedule": schedules.crontab(minute=15, hour=3), # Every day at 03:15 UTC,
"enabled": False,
},
"celery.automatic-renewal": {
"task": "rero_ils.modules.loans.tasks.automatic_renewal",
"schedule": schedules.crontab(minute=30, hour=3), # Every day at 03:30 UTC
"enabled": False,
},
"celery.anonymize-loans": {
"task": "rero_ils.modules.loans.tasks.loan_anonymizer",
"schedule": schedules.crontab(minute=0, hour=7), # Every day at 07:00 UTC,
"enabled": False,
},
"celery.clear-and-renew-subscriptions": {
"task": "rero_ils.modules.patrons.tasks.task_clear_and_renew_subscriptions",
"schedule": schedules.crontab(minute=2, hour=2), # Every day at 02:02 UTC,
"enabled": False,
},
"celery.delete-inactive-patrons": {
"task": "rero_ils.modules.patrons.tasks.task_delete_inactive_patrons",
"schedule": schedules.crontab(minute=0, hour=4, day_of_month="1"), # 1st of each month at 04:00 UTC
"enabled": False,
},
"celery.delete-standard-holdings-having-no-items": {
"task": (
"rero_ils.modules.holdings.tasks.delete_standard_holdings_having_no_items"
),
"schedule": schedules.crontab(minute=30, hour=4), # Every day at 04:30 UTC,
"enabled": False,
},
"celery.collect-stats-billing": {
"task": ("rero_ils.modules.stats.tasks.collect_stats_billing"),
"schedule": schedules.crontab(minute=0, hour=1), # Every day at 01:00 UTC,
"enabled": False,
},
"celery.collect-stats-librarian": {
"task": ("rero_ils.modules.stats.tasks.collect_stats_librarian"),
"schedule": schedules.crontab(
minute=30, hour=1, day_of_month="1"
), # First day of the month at 01:30 UTC,
"enabled": False,
},
"celery.collect-stats-report-month": {
"task": ("rero_ils.modules.stats.tasks.collect_stats_reports"),
"schedule": schedules.crontab(
minute=0, hour=1, day_of_month="1"
), # First day of the month at 01:30 UTC,
"kwargs": {"frequency": "month"},
"enabled": False,
},
"celery.collect-stats-report-year": {
"task": ("rero_ils.modules.stats.tasks.collect_stats_reports"),
"schedule": schedules.crontab(
minute=0, hour=1, day_of_month="1", month_of_year="1"
), # First day of the month at 01:30 UTC,
"kwargs": {"frequency": "year"},
"enabled": False,
},
"celery.delete-provisional-items": {
"task": "rero_ils.modules.items.tasks.delete_provisional_items",
"schedule": schedules.crontab(minute=0, hour=3), # Every day at 03:00 UTC,
"enabled": False,
},
"celery.delete-loans-created": {
"task": "rero_ils.modules.loans.tasks.delete_loans_created",
"schedule": schedules.crontab(minute=0, hour=5), # Every day at 05:00 UTC,
"enabled": False,
},
"celery.sync-entities": {
"task": "rero_ils.modules.entities.remote_entities.tasks.sync_entities",
"schedule": schedules.crontab(minute=0, hour=1), # Every day at 01:00 UTC,
"enabled": False,
},
"celery.add-cover-urls": {
"task": "rero_ils.modules.documents.tasks.add_cover_urls",
"schedule": schedules.crontab(
minute=0, hour=22, day_of_week=6
), # Every Sunday at 22:00 UTC,
"kwargs": {"commit": True, "verbose": False, "cached": True, "delay": 1},
"enabled": False,
},
"celery.replace-identified-by": {
"task": "rero_ils.modules.entities.remote_entities.tasks.replace_identified_by",
"schedule": schedules.crontab(
minute=0, hour=3, day_of_week=6
), # Every Sunday at 03:00 UTC,
"enabled": False,
},
"celery.delete-drafts": {
"task": "rero_ils.modules.documents.tasks.delete_drafts",
"schedule": schedules.crontab(
minute=0, hour=4, day_of_week=6
), # Every Sunday at 04:00 UTC,
"kwargs": {"delete": True},
"enabled": False,
},
"celery.delete-orphan-harvested": {
"task": "rero_ils.modules.documents.tasks.delete_orphan_harvested",
"schedule": schedules.crontab(
minute=0, hour=5, day_of_week=6
), # Every Sunday at 05:00 UTC,
"kwargs": {"delete": True},
"enabled": False,
},
"celery.harvest-vs-cantook": {
"task": "rero_ils.modules.api_harvester.tasks.harvest_records",
"schedule": schedules.crontab(minute=33, hour=3), # Every day at 03:33 UTC,
"kwargs": {"name": "VS-CANTOOK"},
"enabled": False,
},
"celery.harvest-nj-cantook": {
"task": "rero_ils.modules.api_harvester.tasks.harvest_records",
"schedule": schedules.crontab(minute=44, hour=4), # Every day at 04:44 UTC,
"kwargs": {"name": "NJ-CANTOOK"},
"enabled": False,
},
}
INDEXER_BULK_REQUEST_TIMEOUT = 60
RERO_ILS_IMPORT_CACHE = "redis://localhost:6379/5"
RERO_ILS_IMPORT_CACHE_EXPIRE = 10
SIP2_DATASTORE_REDIS_URL = "redis://localhost:6379/6"
# Database
# ========
#: Database URI including user and password
SQLALCHEMY_DATABASE_URI = "postgresql+psycopg2://rero-ils:rero-ils@localhost/rero-ils"
#: Disable Versioning due to Bad Performance
DB_VERSIONING = False
#: Disable warning
SQLALCHEMY_TRACK_MODIFICATIONS = False
# Celery
CELERY_BROKER_HEARTBEAT = 60
CELERY_BROKER_CONNECTION_RETRY_ON_STARTUP = True
CELERY_BROKER_CONNECTION_MAX_RETRIES = 10
CELERY_BEAT_SCHEDULER = "rero_ils.schedulers.DatabaseScheduler"
# Flask configuration
# ===================
# See details on
# http://flask.pocoo.org/docs/0.12/config/#builtin-configuration-values
#: Secret key - each installation (dev, production, ...) needs a separate key.
#: It should be changed before deploying.
SECRET_KEY = "CHANGE_ME"
#: Max upload size for form data via application/mulitpart-formdata.
MAX_CONTENT_LENGTH = 100 * 1024 * 1024 # 100 MiB
#: For dev. Set to false when testing on localhost in no debug mode
APP_ENABLE_SECURE_HEADERS = True
# TODO: review theses rules for security purposes
APP_DEFAULT_SECURE_HEADERS = {
# disabled as https is not used by the application:
# https is done by the haproxy
"force_https": False,
"force_https_permanent": False,
"force_file_save": False,
"frame_options": "sameorigin",
"frame_options_allow_from": None,
"strict_transport_security": True,
"strict_transport_security_preload": False,
"strict_transport_security_max_age": 31556926, # One year in seconds
"strict_transport_security_include_subdomains": True,
"content_security_policy": {
"default-src": ["*"],
"font-src": ["*", "data:"],
"img-src": ["*", "'self'", "data:", "blob:"],
"style-src": ["*", "'self'", "'unsafe-inline'"],
"script-src": [
"'self'",
"'unsafe-eval'",
"'unsafe-inline'",
# "*.rero.ch",
"https://www.googletagmanager.com",
"https://www.google-analytics.com",
"https://services.test.rero.ch",
"https://services.rero.ch",
"https://cdn.jsdelivr.net",
"https://www.babelio.com",
],
},
"content_security_policy_report_uri": None,
"content_security_policy_report_only": False,
"session_cookie_secure": True,
"session_cookie_http_only": True,
}
#: Sets cookie with the secure flag
SESSION_COOKIE_SECURE = True
#: Since HAProxy and Nginx route all requests no matter the host header
#: provided, the allowed hosts variable is set to localhost. In production it
#: should be set to the correct host and it is strongly recommended to only
#: route correct hosts to the application.
TRUSTED_HOSTS = ["localhost", "127.0.0.1"]
# Previewers
# ==========
PREVIEWER_RECORD_FILE_FACOTRY = (
"rero_invenio_files.records.previewer.record_file_factory"
)
PREVIEWER_MAX_IMAGE_SIZE_BYTES = 5 * 1024 * 1024
"""Maximum file size in bytes for image files."""
PREVIEWER_MAX_FILE_SIZE_BYTES = 5 * 1024 * 1024
"""Maximum file size in bytes for JSON/XML files."""
# Debug
# =====
# Flask-DebugToolbar is by default enabled when the application is running in
# debug mode. More configuration options are available at
# https://flask-debugtoolbar.readthedocs.io/en/latest/#configuration
#: Switches off incept of redirects by Flask-DebugToolbar.
DEBUG_TB_INTERCEPT_REDIRECTS = False
#: Enable DB logging (level)
# RERO_ILS_DB_LOGGING = 1
#: Enable Indexer logging (level)
# RERO_ILS_SEARCH_LOGGING = 1
# REST API Configuration
# ======================
RERO_ILS_DISABLE_PERMISSION_CHECKS = False
"""Disable permission checks during API calls. Useful when API is test from
command line or progams like postman."""
RECORDS_REST_DEFAULT_CREATE_PERMISSION_FACTORY = librarian_permission_factory
"""Default create permission factory: reject any request."""
RECORDS_REST_DEFAULT_LIST_PERMISSION_FACTORY = librarian_permission_factory
"""Default list permission factory: allow all requests"""
RECORDS_REST_DEFAULT_READ_PERMISSION_FACTORY = librarian_permission_factory
"""Default read permission factory: check if the record exists."""
RECORDS_REST_DEFAULT_UPDATE_PERMISSION_FACTORY = librarian_update_permission_factory
"""Default update permission factory: reject any request."""
RECORDS_REST_DEFAULT_DELETE_PERMISSION_FACTORY = librarian_delete_permission_factory
"""Default delete permission factory: reject any request."""
REST_MIMETYPE_QUERY_ARG_NAME = "format"
"""Name of the query argument to specify the mimetype wanted for the output."""
MAX_RESULT_WINDOW = 100000
"""max result window for search, must be the same in json mapping files."""
RECORDS_REST_ENDPOINTS = dict(
coll=dict(
pid_type="coll",
pid_minter="collection_id",
pid_fetcher="collection_id",
search_class="rero_ils.modules.collections.api:CollectionsSearch",
search_index="collections",
indexer_class="rero_ils.modules.collections.api:CollectionsIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response"
},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search",
"application/rero+json": "rero_ils.modules.collections.serializers:json_coll_search",
},
record_loaders={
"application/json": lambda: Collection(request.get_json()),
},
record_class="rero_ils.modules.collections.api:Collection",
list_route="/collections/",
item_route="/collections/<pid(coll, record_class='rero_ils.modules.collections.api:Collection'):pid_value>",
default_media_type="application/json",
max_result_window=MAX_RESULT_WINDOW,
search_factory_imp="rero_ils.query:view_search_collection_factory",
list_permission_factory_imp=lambda record: CollectionPermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: CollectionPermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: CollectionPermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: CollectionPermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: CollectionPermissionPolicy(
"delete", record=record
),
),
doc=dict(
pid_type="doc",
pid_minter="document_id",
pid_fetcher="document_id",
search_class="rero_ils.modules.documents.api:DocumentsSearch",
search_index="documents",
indexer_class="rero_ils.modules.documents.api:DocumentsIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response",
"application/rero+json": "rero_ils.modules.documents.serializers:json_doc_response",
"application/export+json": "rero_ils.modules.documents.serializers:json_export_doc_response",
"application/x-research-info-systems": "rero_ils.modules.documents.serializers:ris_doc_response",
},
record_serializers_aliases={
"json": "application/json",
"rero": "application/rero+json",
"raw": "application/export+json",
"ris": "application/x-research-info-systems",
},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search",
"application/rero+json": "rero_ils.modules.documents.serializers:json_doc_search",
"application/export+json": "rero_ils.modules.documents.serializers:json_export_doc_search",
"application/x-research-info-systems": "rero_ils.modules.documents.serializers:ris_doc_search",
},
search_serializers_aliases={
"json": "application/json",
"rero": "application/rero+json",
"raw": "application/export+json",
"ris": "application/x-research-info-systems",
},
record_loaders={
"application/marcxml+xml": "rero_ils.modules.documents.loaders:marcxml_loader",
"application/json": lambda: Document(request.get_json()),
},
list_route="/documents/",
record_class="rero_ils.modules.documents.api:Document",
item_route=(
"/documents/<pid(doc, record_class='rero_ils.modules.documents.api:Document'):pid_value>"
),
# suggesters=dict(
# title={
# "completion": {
# "field": "title_suggest",
# "size": 10,
# "skip_duplicates": True
# }
# },
# ),
default_media_type="application/json",
max_result_window=MAX_RESULT_WINDOW,
search_factory_imp="rero_ils.query:documents_search_factory",
list_permission_factory_imp=lambda record: DocumentPermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: DocumentPermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: DocumentPermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: DocumentPermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: DocumentPermissionPolicy(
"delete", record=record
),
),
illr=dict(
pid_type="illr",
pid_minter="ill_request_id",
pid_fetcher="ill_request_id",
search_class="rero_ils.modules.ill_requests.api:ILLRequestsSearch",
search_index="ill_requests",
indexer_class="rero_ils.modules.ill_requests.api:ILLRequestsIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response",
"application/rero+json": "rero_ils.modules.ill_requests.serializers:json_ill_request_response",
},
search_serializers_aliases={
"json": "application/json",
"rero+json": "application/rero+json",
},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search",
"application/rero+json": "rero_ils.modules.ill_requests.serializers:json_ill_request_search",
},
record_loaders={
"application/json": lambda: ILLRequest(request.get_json()),
},
record_class="rero_ils.modules.ill_requests.api:ILLRequest",
list_route="/ill_requests/",
item_route="/ill_requests/<pid(illr, record_class='rero_ils.modules.ill_requests.api:ILLRequest'):pid_value>",
default_media_type="application/json",
max_result_window=MAX_RESULT_WINDOW,
search_factory_imp="rero_ils.query:ill_request_search_factory",
list_permission_factory_imp=lambda record: ILLRequestPermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: ILLRequestPermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: ILLRequestPermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: ILLRequestPermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: ILLRequestPermissionPolicy(
"delete", record=record
),
),
item=dict(
pid_type="item",
pid_minter="item_id",
pid_fetcher="item_id",
search_class="rero_ils.modules.items.api:ItemsSearch",
search_index="items",
indexer_class="rero_ils.modules.items.api:ItemsIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response",
"application/rero+json": "rero_ils.modules.items.serializers:json_item_response",
},
search_serializers_aliases={
"json": "application/json",
"rero": "application/rero+json",
"csv": "text/csv",
},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search",
"application/rero+json": "rero_ils.modules.items.serializers:json_item_search",
"text/csv": "rero_ils.modules.items.serializers:csv_item_search",
},
list_route="/items/",
record_loaders={
"application/json": lambda: Item(request.get_json()),
},
record_class="rero_ils.modules.items.api:Item",
item_route="/items/<pid(item, record_class='rero_ils.modules.items.api:Item'):pid_value>",
default_media_type="application/json",
max_result_window=MAX_RESULT_WINDOW,
search_factory_imp="rero_ils.query:items_search_factory",
list_permission_factory_imp=lambda record: ItemPermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: ItemPermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: ItemPermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: ItemPermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: ItemPermissionPolicy(
"delete", record=record
),
),
itty=dict(
pid_type="itty",
pid_minter="item_type_id",
pid_fetcher="item_type_id",
search_class="rero_ils.modules.item_types.api:ItemTypesSearch",
search_index="item_types",
indexer_class="rero_ils.modules.item_types.api:ItemTypesIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response"
},
record_serializers_aliases={
"json": "application/json",
},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search"
},
list_route="/item_types/",
record_loaders={
"application/json": lambda: ItemType(request.get_json()),
},
record_class="rero_ils.modules.item_types.api:ItemType",
item_route=(
"/item_types/<pid(itty, record_class='rero_ils.modules.item_types.api:ItemType'):pid_value>"
),
default_media_type="application/json",
max_result_window=MAX_RESULT_WINDOW,
search_factory_imp="rero_ils.query:organisation_search_factory",
list_permission_factory_imp=lambda record: ItemTypePermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: ItemTypePermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: ItemTypePermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: ItemTypePermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: ItemTypePermissionPolicy(
"delete", record=record
),
),
stat=dict(
pid_type="stat",
pid_minter="stat_id",
pid_fetcher="stat_id",
search_class="rero_ils.modules.stats.api.api:StatsSearch",
search_index="stats",
indexer_class="rero_ils.modules.stats.api.api:StatsIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response",
"text/csv": "rero_ils.modules.stats.serializers:csv_v1_response",
},
record_serializers_aliases={"json": "application/json", "csv": "text/csv"},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search"
},
list_route="/stats/",
record_loaders={
"application/json": lambda: Stat(request.get_json()),
},
record_class="rero_ils.modules.stats.api.api:Stat",
item_route="/stats/<pid(stat, record_class='rero_ils.modules.stats.api.api:Stat'):pid_value>",
default_media_type="application/json",
search_factory_imp="rero_ils.query:organisation_search_factory",
max_result_window=MAX_RESULT_WINDOW,
list_permission_factory_imp=lambda record: StatisticsPermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: StatisticsPermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: StatisticsPermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: StatisticsPermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: StatisticsPermissionPolicy(
"delete", record=record
),
),
stacfg=dict(
pid_type="stacfg",
pid_minter="stat_cfg_id",
pid_fetcher="stat_cfg_id",
search_class="rero_ils.modules.stats_cfg.api:StatsConfigurationSearch",
search_index="stats_cfg",
indexer_class="rero_ils.modules.stats_cfg.api:StatsConfigurationIndexer",
record_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_response"
},
record_serializers_aliases={"json": "application/json"},
search_serializers_aliases={
"json": "application/json",
"rero+json": "application/json",
},
search_serializers={
"application/json": "rero_ils.modules.serializers:json_v1_search",
"application/rero+json": "rero_ils.modules.stats_cfg.serializers:json_search",
},
list_route="/stats_cfg/",
record_loaders={
"application/json": lambda: StatConfiguration(request.get_json()),
},
record_class="rero_ils.modules.stats_cfg.api:StatConfiguration",
item_route=(
"/stats_cfg/<pid(stacfg, record_class='rero_ils.modules.stats_cfg.api:StatConfiguration'):pid_value>"
),
default_media_type="application/json",
max_result_window=MAX_RESULT_WINDOW,
search_factory_imp="rero_ils.query:organisation_search_factory",
list_permission_factory_imp=lambda record: StatisticsConfigurationPermissionPolicy(
"search", record=record
),
read_permission_factory_imp=lambda record: StatisticsConfigurationPermissionPolicy(
"read", record=record
),
create_permission_factory_imp=lambda record: StatisticsConfigurationPermissionPolicy(
"create", record=record
),
update_permission_factory_imp=lambda record: StatisticsConfigurationPermissionPolicy(
"update", record=record
),
delete_permission_factory_imp=lambda record: StatisticsConfigurationPermissionPolicy(
"delete", record=record
),
),
hold=dict(
pid_type="hold",
pid_minter="holding_id",
pid_fetcher="holding_id",
search_class="rero_ils.modules.holdings.api:HoldingsSearch",