This repository has been archived by the owner on May 14, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
omeroweb_settings.py
executable file
·1059 lines (960 loc) · 38.8 KB
/
omeroweb_settings.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
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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# # Django settings for OMERO.web project. # #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
#
#
# Copyright (c) 2008-2014 University of Dundee.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Author: Aleksandra Tarkowska <A(dot)Tarkowska(at)dundee(dot)ac(dot)uk>, 2008.
#
# Version: 1.0
#
import os.path
import sys
import logging
import omero
import omero.config
import omero.clients
import tempfile
import re
import json
from omero_ext import portalocker
logger = logging.getLogger(__name__)
# LOGS
# NEVER DEPLOY a site into production with DEBUG turned on.
# Debuging mode.
# A boolean that turns on/off debug mode.
# handler404 and handler500 works only when False
if 'OMERO_HOME' in os.environ:
OMERO_HOME = os.environ.get('OMERO_HOME')
else:
OMERO_HOME = os.path.join(os.path.dirname(__file__), '..', '..', '..')
OMERO_HOME = os.path.normpath(OMERO_HOME)
INSIGHT_JARS = os.path.join(OMERO_HOME, "lib", "insight").replace('\\', '/')
WEBSTART = False
if os.path.isdir(INSIGHT_JARS):
WEBSTART = True
# Logging
LOGDIR = os.path.join(OMERO_HOME, 'var', 'log').replace('\\', '/')
if not os.path.isdir(LOGDIR):
try:
os.makedirs(LOGDIR)
except Exception, x:
exctype, value = sys.exc_info()[:2]
raise exctype(value)
# DEBUG: Never deploy a site into production with DEBUG turned on.
# Logging levels: logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR
# logging.CRITICAL
# FORMAT: 2010-01-01 00:00:00,000 INFO [omeroweb.webadmin.webadmin_utils]
# (proc.1308 ) getGuestConnection:20 Open connection is not available
STANDARD_LOGFORMAT = (
'%(asctime)s %(levelname)5.5s [%(name)40.40s]'
' (proc.%(process)5.5d) %(funcName)s:%(lineno)d %(message)s')
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'standard': {
'format': STANDARD_LOGFORMAT
},
},
'handlers': {
'default': {
'level': 'DEBUG',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(
LOGDIR, 'OMEROweb.log').replace('\\', '/'),
'maxBytes': 1024*1024*5, # 5 MB
'backupCount': 5,
'formatter': 'standard',
},
'request_handler': {
'level': 'DEBUG',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(
LOGDIR, 'OMEROweb_request.log').replace('\\', '/'),
'maxBytes': 1024*1024*5, # 5 MB
'backupCount': 5,
'formatter': 'standard',
},
'null': {
'level': 'DEBUG',
'class': 'django.utils.log.NullHandler',
},
'console': {
'level': 'DEBUG',
'class': 'logging.StreamHandler',
'formatter': 'standard'
},
'mail_admins': {
'level': 'ERROR',
'class': 'django.utils.log.AdminEmailHandler'
}
},
'loggers': {
'django.request': { # Stop SQL debug from logging to main logger
'handlers': ['request_handler', 'mail_admins'],
'level': 'DEBUG',
'propagate': False
},
'django': {
'handlers': ['null'],
'level': 'DEBUG',
'propagate': True
},
'': {
'handlers': ['default'],
'level': 'DEBUG',
'propagate': True
}
}
}
# Load custom settings from etc/grid/config.xml
# Tue 2 Nov 2010 11:03:18 GMT -- ticket:3228
from omero.util.concurrency import get_event
CONFIG_XML = os.path.join(OMERO_HOME, 'etc', 'grid', 'config.xml')
count = 10
event = get_event("websettings")
while True:
try:
CUSTOM_SETTINGS = dict()
if os.path.exists(CONFIG_XML):
CONFIG_XML = omero.config.ConfigXml(CONFIG_XML, read_only=True)
CUSTOM_SETTINGS = CONFIG_XML.as_map()
CONFIG_XML.close()
break
except portalocker.LockException:
# logger.error("Exception while loading configuration retrying...",
# exc_info=True)
exctype, value = sys.exc_info()[:2]
count -= 1
if not count:
raise exctype(value)
else:
event.wait(1) # Wait a total of 10 seconds
except:
# logger.error("Exception while loading configuration...",
# exc_info=True)
exctype, value = sys.exc_info()[:2]
raise exctype(value)
del event
del count
del get_event
FASTCGI = "fastcgi"
FASTCGITCP = "fastcgi-tcp"
FASTCGI_TYPES = (FASTCGI, FASTCGITCP)
DEVELOPMENT = "development"
DEFAULT_SERVER_TYPE = FASTCGITCP
ALL_SERVER_TYPES = (FASTCGITCP, FASTCGI, DEVELOPMENT)
DEFAULT_SESSION_ENGINE = 'omeroweb.filesessionstore'
SESSION_ENGINE_VALUES = ('omeroweb.filesessionstore',
'django.contrib.sessions.backends.db',
'django.contrib.sessions.backends.file',
'django.contrib.sessions.backends.cache',
'django.contrib.sessions.backends.cached_db')
def parse_boolean(s):
s = s.strip().lower()
if s in ('true', '1', 't'):
return True
return False
def parse_paths(s):
return [os.path.normpath(path) for path in json.loads(s)]
def check_server_type(s):
if s not in ALL_SERVER_TYPES:
raise ValueError(
"Unknown server type: %s. Valid values are: %s"
% (s, ALL_SERVER_TYPES))
return s
def check_session_engine(s):
if s not in SESSION_ENGINE_VALUES:
raise ValueError(
"Unknown session engine: %s. Valid values are: %s"
% (s, SESSION_ENGINE_VALUES))
return s
def identity(x):
return x
def str_slash(s):
if s is not None:
s = str(s)
if s and not s.endswith("/"):
s += "/"
return s
class LeaveUnset(Exception):
pass
def leave_none_unset(s):
if s is None:
raise LeaveUnset()
return s
def leave_none_unset_int(s):
s = leave_none_unset(s)
if s is not None:
return int(s)
CUSTOM_HOST = CUSTOM_SETTINGS.get("Ice.Default.Host", "localhost")
# DO NOT EDIT!
INTERNAL_SETTINGS_MAPPING = {
"omero.qa.feedback":
["FEEDBACK_URL", "http://qa.openmicroscopy.org.uk", str, None],
"omero.web.upgrades.url":
["UPGRADES_URL", None, leave_none_unset, None],
# Allowed hosts:
# https://docs.djangoproject.com/en/1.6/ref/settings/#allowed-hosts
"omero.web.allowed_hosts":
["ALLOWED_HOSTS", '["*"]', json.loads, None],
# WEBSTART
"omero.web.webstart_template":
["WEBSTART_TEMPLATE", None, identity, None],
"omero.web.webstart_jar":
["WEBSTART_JAR", "omero.insight.jar", str, None],
"omero.web.webstart_icon":
["WEBSTART_ICON", "webstart/img/icon-omero-insight.png", str, None],
"omero.web.webstart_heap":
["WEBSTART_HEAP", "1024m", str, None],
"omero.web.webstart_host":
["WEBSTART_HOST", CUSTOM_HOST, str, None],
"omero.web.webstart_port":
["WEBSTART_PORT", "4064", str, None],
"omero.web.webstart_class":
["WEBSTART_CLASS", "org.openmicroscopy.shoola.Main", str, None],
"omero.web.webstart_title":
["WEBSTART_TITLE", "OMERO.insight", str, None],
"omero.web.webstart_vendor":
["WEBSTART_VENDOR", "The Open Microscopy Environment", str, None],
"omero.web.webstart_homepage":
["WEBSTART_HOMEPAGE", "http://www.openmicroscopy.org", str, None],
"omero.web.webstart_admins_only":
["WEBSTART_ADMINS_ONLY", "false", parse_boolean, None],
# Internal email notification for omero.web.admins,
# loaded from config.xml directly
"omero.mail.from":
["SERVER_EMAIL",
None,
identity,
("The email address that error messages come from, such as those"
" sent to :property:`omero.web.admins`. Requires EMAIL properties"
" below.")],
"omero.mail.host":
["EMAIL_HOST",
None,
identity,
"The SMTP server host to use for sending email."],
"omero.mail.password":
["EMAIL_HOST_PASSWORD",
None,
identity,
"Password to use for the SMTP server."],
"omero.mail.username":
["EMAIL_HOST_USER",
None,
identity,
"Username to use for the SMTP server."],
"omero.mail.port":
["EMAIL_PORT",
25,
identity,
"Port to use for the SMTP server."],
"omero.web.admins.email_subject_prefix":
["EMAIL_SUBJECT_PREFIX",
"[OMERO.web - admin notification]",
str,
"Subject-line prefix for email messages"],
"omero.mail.smtp.starttls.enable":
["EMAIL_USE_TLS",
"false",
parse_boolean,
("Whether to use a TLS (secure) connection when talking to the SMTP"
" server.")],
# Deprecated
"omero.web.send_broken_link_emails":
["SEND_BROKEN_LINK_EMAILS", "true", parse_boolean, None],
}
CUSTOM_SETTINGS_MAPPINGS = {
# Deployment configuration
"omero.web.debug":
["DEBUG",
"false",
parse_boolean,
"A boolean that turns on/off debug mode."],
"omero.web.admins":
["ADMINS",
'[]',
json.loads,
("A list of people who get code error notifications whenever the "
"application identify broken link or raises an unhandled exception "
"that results in an internal server error. This gives the "
"administrators immediate notification of any errors, "
"see :doc:`/sysadmins/mail`. "
"Example:``'[[\"Full Name\", \"email address\"]]'``.")],
"omero.web.application_server":
["APPLICATION_SERVER",
DEFAULT_SERVER_TYPE,
check_server_type,
("OMERO.web is configured to use FastCGI TCP by default. If you are "
"using a non-standard web server configuration you may wish to "
"change this before generating your web server configuration. "
"Available options \"fastcgi\" / \"fastcgi-tcp\"")],
"omero.web.application_server.host":
["APPLICATION_SERVER_HOST",
"127.0.0.1",
str,
"Upstream application host"],
"omero.web.application_server.port":
["APPLICATION_SERVER_PORT", "4080", str, "Upstream application port"],
"omero.web.application_server.max_requests":
["APPLICATION_SERVER_MAX_REQUESTS", 400, int, None],
"omero.web.prefix":
["FORCE_SCRIPT_NAME",
None,
leave_none_unset,
("Used as the value of the SCRIPT_NAME environment variable in any"
" HTTP request.")],
"omero.web.static_url":
["STATIC_URL",
"/static/",
str_slash,
("URL to use when referring to static files. Example: ``'/static/'``"
" or ``'http://static.example.com/'``. Used as the base path for"
" asset definitions (the Media class) and the staticfiles app. It"
" must end in a slash if set to a non-empty value.")],
"omero.web.session_engine":
["SESSION_ENGINE",
DEFAULT_SESSION_ENGINE,
check_session_engine,
("Controls where Django stores session data. See :djangodoc:"
"`Configuring the session engine for more details <ref/settings"
"/#session-engine>`.")],
"omero.web.session_expire_at_browser_close":
["SESSION_EXPIRE_AT_BROWSER_CLOSE",
"true",
parse_boolean,
("A boolean that determines whether to expire the session when the "
"user closes their browser. See :djangodoc:`Django Browser-length "
"sessions vs. persistent sessions documentation <topics/http/"
"sessions/#browser-length-vs-persistent-sessions>` for more "
"details.")],
"omero.web.caches":
["CACHES",
('{"default": {"BACKEND":'
' "django.core.cache.backends.dummy.DummyCache"}}'),
json.loads,
("OMERO.web offers alternative session backends to automatically"
" delete stale data using the cache session store backend, see "
":djangodoc:`Django cached session documentation <topics/http/"
"sessions/#using-cached-sessions>` for more details.")],
"omero.web.session_cookie_age":
["SESSION_COOKIE_AGE",
86400,
int,
"The age of session cookies, in seconds."],
"omero.web.session_cookie_domain":
["SESSION_COOKIE_DOMAIN",
None,
leave_none_unset,
"The domain to use for session cookies"],
"omero.web.session_cookie_name":
["SESSION_COOKIE_NAME",
None,
leave_none_unset,
"The name to use for session cookies"],
"omero.web.logdir":
["LOGDIR", LOGDIR, str, "A path to the custom log directory."],
# Public user
"omero.web.public.enabled":
["PUBLIC_ENABLED",
"false",
parse_boolean,
"Enable and disable the OMERO.web public user functionality."],
"omero.web.public.url_filter":
["PUBLIC_URL_FILTER",
r'^/(?!webadmin)',
re.compile,
("Set a URL filter for which the OMERO.web public user is allowed to"
" navigate. The idea is that you can create the public pages"
" yourself (see OMERO.web framework since we do not provide public"
" pages.")],
"omero.web.public.server_id":
["PUBLIC_SERVER_ID", 1, int, "Server to authenticate against."],
"omero.web.public.user":
["PUBLIC_USER",
None,
leave_none_unset,
"Username to use during authentication."],
"omero.web.public.password":
["PUBLIC_PASSWORD",
None,
leave_none_unset,
"Password to use during authentication."],
"omero.web.public.cache.enabled":
["PUBLIC_CACHE_ENABLED", "false", parse_boolean, None],
"omero.web.public.cache.key":
["PUBLIC_CACHE_KEY", "omero.web.public.cache.key", str, None],
"omero.web.public.cache.timeout":
["PUBLIC_CACHE_TIMEOUT", 60 * 60 * 24, int, None],
# Application configuration
"omero.web.server_list":
["SERVER_LIST",
'[["%s", 4064, "omero"]]' % CUSTOM_HOST,
json.loads,
"A list of servers the Web client can connect to."],
"omero.web.ping_interval":
["PING_INTERVAL", 60000, int, "description"],
"omero.web.webgateway_cache":
["WEBGATEWAY_CACHE", None, leave_none_unset, None],
# VIEWER
# the following parameters configure when to show/hide the 'Volume viewer'
# icon in the Image metadata panel
"omero.web.open_astex_max_side":
["OPEN_ASTEX_MAX_SIDE", 400, int, None],
"omero.web.open_astex_min_side":
["OPEN_ASTEX_MIN_SIDE", 20, int, None],
"omero.web.open_astex_max_voxels":
["OPEN_ASTEX_MAX_VOXELS", 27000000, int, None], # 300 x 300 x 300
# PIPELINE 1.3.20
# Pipeline is an asset packaging library for Django, providing both CSS
# and JavaScript concatenation and compression, built-in JavaScript
# template support, and optional data-URI image and font embedding.
"omero.web.pipeline_js_compressor":
["PIPELINE_JS_COMPRESSOR",
None,
identity,
("Compressor class to be applied to JavaScript files. If empty or "
"None, JavaScript files won't be compressed.")],
"omero.web.pipeline_css_compressor":
["PIPELINE_CSS_COMPRESSOR",
None,
identity,
("Compressor class to be applied to CSS files. If empty or None,"
" CSS files won't be compressed.")],
"omero.web.pipeline_staticfile_storage":
["STATICFILES_STORAGE",
"pipeline.storage.PipelineStorage",
str,
("The file storage engine to use when collecting static files with"
" the collectstatic management command. See `the documentation "
"<http://django-pipeline.readthedocs.org/en/latest/storages.html>`_"
" for more details.")],
# Customisation
"omero.web.login_logo":
["LOGIN_LOGO",
None,
leave_none_unset,
("Customize webclient login page with your own logo. Logo images "
"should ideally be 150 pixels high or less and will appear above "
"the OMERO logo. You will need to host the image somewhere else "
"and link to it with"
" ``\"http://www.openmicroscopy.org/site/logo.jpg\"``.")],
"omero.web.login_view":
["LOGIN_VIEW", "weblogin", str, None],
"omero.web.staticfile_dirs":
["STATICFILES_DIRS",
'[]',
json.loads,
("Defines the additional locations the staticfiles app will traverse"
" if the FileSystemFinder finder is enabled, e.g. if you use the"
" collectstatic or findstatic management command or use the static"
" file serving view.")],
"omero.web.template_dirs":
["TEMPLATE_DIRS",
'[]',
json.loads,
("List of locations of the template source files, in search order. "
"Note that these paths should use Unix-style forward slashes, even"
" on Windows.")],
"omero.web.index_template":
["INDEX_TEMPLATE",
None,
identity,
("Define template used as an index page ``http://your_host/omero/``."
"If None user is automaticaly redirected to the login page."
"For example use 'webstart/start.html'. ")],
"omero.web.login_redirect":
["LOGIN_REDIRECT",
'{}',
json.loads,
("Redirect to the givin location after loging in. It only support "
"arguments for :djangodoc:`Django reverse function"
" <ref/urlresolvers/#django.core.urlresolvers.reverse>`. "
"For example: ``'{\"redirect\": [\"webindex\"], \"viewname\":"
" \"load_template\", \"args\":[\"userdata\"], \"query_string\":"
" \"experimenter=-1\"}'``")],
"omero.web.apps":
["ADDITIONAL_APPS",
'[]',
json.loads,
("Add additional Django applications. For example, see"
" :doc:`/developers/Web/CreateApp`")],
"omero.web.databases":
["DATABASES", '{}', json.loads, None],
"omero.web.page_size":
["PAGE",
200,
int,
("Number of images displayed within a dataset or 'orphaned'"
" container to prevent from loading them all at once.")],
"omero.web.ui.top_links":
["TOP_LINKS",
('['
'["Data", "webindex", {"title": "Browse Data via Projects, Tags'
' etc"}],'
'["History", "history", {"title": "History"}],'
'["Help", "http://help.openmicroscopy.org/",'
'{"title":"Open OMERO user guide in a new tab", "target":"new"}]'
']'),
json.loads,
("Add links to the top header: links are ``['Link Text', 'link',"
" options]``, where "
"the url is reverse('link') OR simply 'link' (for external urls). "
"E.g. ``'[[\"Webtest\", \"webtest_index\"], [\"Homepage\","
" \"http://...\", {\"title\": \"Homepage\", \"target\": \"new\"}"
" ]]'``")],
"omero.web.ui.right_plugins":
["RIGHT_PLUGINS",
('[["Acquisition",'
' "webclient/data/includes/right_plugin.acquisition.js.html",'
' "metadata_tab"],'
# '["ROIs", "webtest/webclient_plugins/right_plugin.rois.js.html",
# "image_roi_tab"],'
'["Preview", "webclient/data/includes/right_plugin.preview.js.html"'
', "preview_tab"]]'),
json.loads,
("Add plugins to the right-hand panel. "
"Plugins are ``['Label', 'include.js', 'div_id']``. "
"The javascript loads data into ``$('#div_id')``.")],
"omero.web.ui.center_plugins":
["CENTER_PLUGINS",
('['
# '["Split View",
# "webtest/webclient_plugins/center_plugin.splitview.js.html",
# "split_view_panel"],'
']'),
json.loads,
("Add plugins to the center panels. Plugins are "
"``['Channel overlay',"
" 'webtest/webclient_plugins/center_plugin.overlay.js.html',"
" 'channel_overlay_panel']``. "
"The javascript loads data into ``$('#div_id')``.")],
"omero.web.viewer.initial_zoom_level":
["VIEWER_INITIAL_ZOOM_LEVEL",
None,
leave_none_unset_int,
("Configuration options for the viewer. -1: zoom in fully,"
" 0: zoom out fully, unset: zoom to fit window")],
}
DEPRECATED_SETTINGS_MAPPINGS = {
# Deprecated settings, description should indicate the replacement.
"omero.web.force_script_name":
["FORCE_SCRIPT_NAME",
None,
leave_none_unset,
("Use omero.web.prefix instead.")],
"omero.web.server_email":
["SERVER_EMAIL",
None,
identity,
("Use omero.mail.from instead.")],
"omero.web.email_host":
["EMAIL_HOST",
None,
identity,
("Use omero.mail.host instead.")],
"omero.web.email_host_password":
["EMAIL_HOST_PASSWORD",
None,
identity,
("Use omero.mail.password instead.")],
"omero.web.email_host_user":
["EMAIL_HOST_USER",
None,
identity,
("Use omero.mail.username instead.")],
"omero.web.email_port":
["EMAIL_PORT",
None,
identity,
("Use omero.mail.port instead.")],
"omero.web.email_subject_prefix":
["EMAIL_SUBJECT_PREFIX",
"[OMERO.web]",
str,
("Default email subject is no longer configurable.")],
"omero.web.email_use_tls":
["EMAIL_USE_TLS",
"false",
parse_boolean,
("Use omero.mail.smtp.* instead to set up"
" javax.mail.Session properties.")],
"omero.web.plate_download.enabled":
["PLATE_DOWNLOAD_ENABLED",
"false",
parse_boolean,
("Use omero.policy.binary_access instead to restrict download.")],
}
del CUSTOM_HOST
# DEVELOPMENT_SETTINGS_MAPPINGS - WARNING: For each setting developer MUST open
# a ticket that needs to be resolved before a release either by moving the
# setting to CUSTOM_SETTINGS_MAPPINGS or by removing the setting at all.
DEVELOPMENT_SETTINGS_MAPPINGS = {}
def map_deprecated_settings(settings):
m = {}
for key, values in settings.items():
try:
global_name = values[0]
m[global_name] = (CUSTOM_SETTINGS[key], key)
if len(values) < 5:
# Not using default (see process_custom_settings)
values.append(False)
except KeyError:
if len(values) < 5:
values.append(True)
return m
def process_custom_settings(
module, settings='CUSTOM_SETTINGS_MAPPINGS', deprecated=None):
logging.info('Processing custom settings for module %s' % module.__name__)
if deprecated:
deprecated_map = map_deprecated_settings(
getattr(module, deprecated, {}))
else:
deprecated_map = {}
for key, values in getattr(module, settings, {}).items():
# Django may import settings.py more than once, see:
# http://blog.dscpl.com.au/2010/03/improved-wsgi-script-for-use-with.html
# In that case, the custom settings have already been processed.
if len(values) == 5:
continue
global_name, default_value, mapping, description = values
try:
global_value = CUSTOM_SETTINGS[key]
values.append(False)
except KeyError:
global_value = default_value
values.append(True)
try:
using_default = values[-1]
if global_name in deprecated_map:
dep_value, dep_key = deprecated_map[global_name]
if using_default:
logging.warning(
'Setting %s is deprecated, use %s', dep_key, key)
global_value = dep_value
else:
logging.error(
'%s and its deprecated key %s are both set, using %s',
key, dep_key, key)
setattr(module, global_name, mapping(global_value))
except ValueError:
raise ValueError(
"Invalid %s JSON: %r" % (global_name, global_value))
except LeaveUnset:
pass
process_custom_settings(sys.modules[__name__], 'INTERNAL_SETTINGS_MAPPING')
process_custom_settings(sys.modules[__name__], 'CUSTOM_SETTINGS_MAPPINGS',
'DEPRECATED_SETTINGS_MAPPINGS')
process_custom_settings(sys.modules[__name__], 'DEVELOPMENT_SETTINGS_MAPPINGS')
if not DEBUG: # from CUSTOM_SETTINGS_MAPPINGS # noqa
LOGGING['loggers']['django.request']['level'] = 'INFO'
LOGGING['loggers']['django']['level'] = 'INFO'
LOGGING['loggers']['']['level'] = 'INFO'
# TEMPLATE_DEBUG: A boolean that turns on/off template debug mode. If this is
# True, the fancy error page will display a detailed report for any
# TemplateSyntaxError. This report contains
# the relevant snippet of the template, with the appropriate line highlighted.
# Note that Django only displays fancy error pages if DEBUG is True,
# alternatively error is handled by:
# handler404 = "omeroweb.feedback.views.handler404"
# handler500 = "omeroweb.feedback.views.handler500"
TEMPLATE_DEBUG = DEBUG # from CUSTOM_SETTINGS_MAPPINGS # noqa
def report_settings(module):
from django.views.debug import cleanse_setting
custom_settings_mappings = getattr(module, 'CUSTOM_SETTINGS_MAPPINGS', {})
for key in sorted(custom_settings_mappings):
values = custom_settings_mappings[key]
global_name, default_value, mapping, description, using_default = \
values
source = using_default and "default" or key
global_value = getattr(module, global_name, None)
if global_name.isupper():
logger.debug(
"%s = %r (source:%s)", global_name,
cleanse_setting(global_name, global_value), source)
deprecated_settings = getattr(module, 'DEPRECATED_SETTINGS_MAPPINGS', {})
for key in sorted(deprecated_settings):
values = deprecated_settings[key]
global_name, default_value, mapping, description, using_default = \
values
global_value = getattr(module, global_name, None)
if global_name.isupper() and not using_default:
logger.debug(
"%s = %r (deprecated:%s, %s)", global_name,
cleanse_setting(global_name, global_value), key, description)
report_settings(sys.modules[__name__])
SITE_ID = 1
# Local time zone for this installation. Choices can be found here:
# http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
# although not all variations may be possible on all operating systems.
# If running in a Windows environment this must be set to the same as your
# system time zone.
TIME_ZONE = 'Europe/London'
FIRST_DAY_OF_WEEK = 0 # 0-Monday, ... 6-Sunday
# LANGUAGE_CODE: A string representing the language code for this
# installation. This should be in standard language format. For example, U.S.
# English is "en-us".
LANGUAGE_CODE = 'en-gb'
# SECRET_KEY: A secret key for this particular Django installation. Used to
# provide a seed in secret-key hashing algorithms. Set this to a random string
# -- the longer, the better. django-admin.py startproject creates one
# automatically.
# Make this unique, and don't share it with anybody.
SECRET_KEY = '@@k%g#7=%4b6ib7yr1tloma&g0s2nni6ljf!m0h&x9c712c7yj'
# USE_I18N: A boolean that specifies whether Django's internationalization
# system should be enabled.
# This provides an easy way to turn it off, for performance. If this is set to
# False, Django will make some optimizations so as not to load the
# internationalization machinery.
USE_I18N = True
# MIDDLEWARE_CLASSES: A tuple of middleware classes to use.
# See https://docs.djangoproject.com/en/1.6/topics/http/middleware/.
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
)
# ROOT_URLCONF: A string representing the full Python import path to your root
# URLconf.
# For example: "mydjangoapps.urls". Can be overridden on a per-request basis
# by setting the attribute urlconf on the incoming HttpRequest object.
ROOT_URLCONF = 'omeroweb.urls'
# STATICFILES_FINDERS: The list of finder backends that know how to find
# static files in various locations. The default will find files stored in the
# STATICFILES_DIRS setting (using
# django.contrib.staticfiles.finders.FileSystemFinder) and in a static
# subdirectory of each app (using
# django.contrib.staticfiles.finders.AppDirectoriesFinder)
STATICFILES_FINDERS = (
"django.contrib.staticfiles.finders.FileSystemFinder",
"django.contrib.staticfiles.finders.AppDirectoriesFinder",
)
# STATIC_URL: URL to use when referring to static files located in
# STATIC_ROOT.
# Example: "/site_media/static/" or "http://static.example.com/".
# If not None, this will be used as the base path for media definitions and
# the staticfiles app. It must end in a slash if set to a non-empty value.
# This var is configurable by omero.web.static_url STATIC_URL = '/static/'
# STATIC_ROOT: The absolute path to the directory where collectstatic will
# collect static files for deployment. If the staticfiles contrib app is
# enabled (default) the collectstatic management command will collect static
# files into this directory.
STATIC_ROOT = os.path.join(os.path.dirname(__file__),
'static').replace('\\', '/')
# STATICFILES_DIRS: This setting defines the additional locations the
# staticfiles app will traverse if the FileSystemFinder finder is enabled,
# e.g. if you use the collectstatic or findstatic management command or use
# the static file serving view.
if WEBSTART:
# from CUSTOM_SETTINGS_MAPPINGS
STATICFILES_DIRS += (("webstart/jars", INSIGHT_JARS),) # noqa
# TEMPLATE_CONTEXT_PROCESSORS: A tuple of callables that are used to populate
# the context in RequestContext. These callables take a request object as
# their argument and return a dictionary of items to be merged into the
# context.
TEMPLATE_CONTEXT_PROCESSORS = (
"django.core.context_processors.debug",
"django.core.context_processors.i18n",
"django.core.context_processors.media",
"django.core.context_processors.static",
"django.contrib.messages.context_processors.messages",
"omeroweb.custom_context_processor.url_suffix"
)
# TEMPLATE_LOADERS: A tuple of template loader classes, specified as strings.
# Each Loader class knows how to import templates from a particular source.
# Optionally, a tuple can be used instead of a string. The first item in the
# tuple should be the Loader's module, subsequent items are passed to the
# Loader during initialization.
TEMPLATE_LOADERS = (
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
)
# INSTALLED_APPS: A tuple of strings designating all applications that are
# enabled in this Django installation. Each string should be a full Python
# path to a Python package that contains a Django application, as created by
# django-admin.py startapp.
INSTALLED_APPS = (
'django.contrib.staticfiles',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'omeroweb.feedback',
'omeroweb.webadmin',
'omeroweb.webclient',
'omeroweb.webgateway',
'omeroweb.webredirect',
'omeroweb.webstart',
'pipeline',
)
# ADDITONAL_APPS: We import any settings.py from apps. This allows them to
# modify settings.
# We're also processing any CUSTOM_SETTINGS_MAPPINGS defined there.
for app in ADDITIONAL_APPS: # from CUSTOM_SETTINGS_MAPPINGS # noqa
# Previously the app was added to INSTALLED_APPS as 'omeroweb.app', which
# then required the app to reside within or be symlinked from within
# omeroweb, instead of just having to be somewhere on the python path.
# To allow apps to just be on the path, but keep it backwards compatible,
# try to import as omeroweb.app, if it works, keep that in INSTALLED_APPS,
# otherwise add it to INSTALLED_APPS just with its own name.
try:
__import__('omeroweb.%s' % app)
INSTALLED_APPS += ('omeroweb.%s' % app,)
except ImportError:
INSTALLED_APPS += (app,)
try:
logger.debug(
'Attempting to import additional app settings for app: %s' % app)
module = __import__('%s.settings' % app)
process_custom_settings(module.settings)
report_settings(module.settings)
except ImportError:
logger.debug("Couldn't import settings from app: %s" % app)
logger.debug('INSTALLED_APPS=%s' % [INSTALLED_APPS])
DATABASE = {
"default" : {},
"omero_signup": {
"ENGINE": "django.db.backends.postgresql_psycopg2",
"NAME": "omero_signup_db",
"USER": "omero_signup_db_user",
"PASSWORD": "pkclpha",
"HOST": "localhost"
}
}
DATABASE_ROUTERS = ["omero_signup.router.OmerosignupRouter"]
PIPELINE_CSS = {
'webgateway_viewer': {
'source_filenames': (
'webgateway/css/reset.css',
'webgateway/css/ome.body.css',
'webclient/css/dusty.css',
'webgateway/css/ome.viewport.css',
'webgateway/css/ome.toolbar.css',
'webgateway/css/ome.gs_slider.css',
'webgateway/css/base.css',
'webgateway/css/ome.snippet_header_logo.css',
'webgateway/css/ome.postit.css',
'webgateway/css/ome.rangewidget.css',
'3rdparty/farbtastic-1.2/farbtastic.css',
'webgateway/css/ome.colorbtn.css',
'3rdparty/JQuerySpinBtn-1.3a/JQuerySpinBtn.css',
'3rdparty/jquery-ui-1.10.4/themes/base/jquery-ui.all.css',
'webgateway/css/omero_image.css',
'3rdparty/panojs-2.0.0/panojs.css',
),
'output_filename': 'omeroweb.viewer.min.css',
},
}
PIPELINE_JS = {
'webgateway_viewer': {
'source_filenames': (
'3rdparty/jquery-1.11.1.js',
'3rdparty/jquery-migrate-1.2.1.js',
'3rdparty/jquery-ui-1.10.4/js/jquery-ui.1.10.4.js',
'webgateway/js/ome.popup.js',
'3rdparty/aop-1.3.js',
'3rdparty/raphael-2.1.0/raphael.js',
'3rdparty/raphael-2.1.0/scale.raphael.js',
'3rdparty/panojs-2.0.0/utils.js',
'3rdparty/panojs-2.0.0/PanoJS.js',
'3rdparty/panojs-2.0.0/controls.js',
'3rdparty/panojs-2.0.0/pyramid_Bisque.js',
'3rdparty/panojs-2.0.0/pyramid_imgcnv.js',
'3rdparty/panojs-2.0.0/pyramid_Zoomify.js',
'3rdparty/panojs-2.0.0/control_thumbnail.js',
'3rdparty/panojs-2.0.0/control_info.js',
'3rdparty/panojs-2.0.0/control_svg.js',
'3rdparty/panojs-2.0.0/control_roi.js',
'3rdparty/panojs-2.0.0/control_scalebar.js',
'3rdparty/hammer-2.0.2/hammer.min.js',
'webgateway/js/ome.gs_utils.js',
'webgateway/js/ome.viewportImage.js',
'webgateway/js/ome.gs_slider.js',
'webgateway/js/ome.viewport.js',
'webgateway/js/omero_image.js',
'webgateway/js/ome.roidisplay.js',
'webgateway/js/ome.scalebardisplay.js',
'webgateway/js/ome.smartdialog.js',
'3rdparty/JQuerySpinBtn-1.3a/JQuerySpinBtn.js',
'webgateway/js/ome.colorbtn.js',
'webgateway/js/ome.postit.js',
'3rdparty/jquery.selectboxes-2.2.6.js',
'webgateway/js/ome.rangewidget.js',
'3rdparty/farbtastic-1.2/farbtastic.js',
'3rdparty/jquery.mousewheel-3.0.6.js',
),
'output_filename': 'omeroweb.viewer.min.js',
}
}
CSRF_FAILURE_VIEW = "omeroweb.feedback.views.csrf_failure"
# FEEDBACK - DO NOT MODIFY!
# FEEDBACK_URL: Is now configurable for testing purpuse only. Used in
# feedback.sendfeedback.SendFeedback class in order to submit errors or
# comment messages to http://qa.openmicroscopy.org.uk.