-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathsession.py
executable file
·1619 lines (1366 loc) · 54.2 KB
/
session.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
##
## Copyright 2016 SRI International
## See COPYING file distributed along with the package for the copyright and license terms
##
"""
Create the SIBIS Session Object
===============================
The SIBIS Session Object provides a single point of reference to access
multiple systems. For example, XNAT, REDDCap, and Github.
"""
from __future__ import print_function, absolute_import
from future import standard_library
standard_library.install_aliases()
from builtins import str
from builtins import object
from contextlib import contextmanager
import ast
import os
import time
import datetime
import requests
import hashlib
import pandas as pd
from pandas.io.sql import execute
import re
import warnings
from sibispy.svn_util import SibisSvnClient
from sibispy import sibislogger as slog
from sibispy import config_file_parser as cfg_parser
# --------------------------------------------
# this class was created to capture output from xnat
# if one cannot connect to server
from io import StringIO
import sys
from typing import Mapping
try:
from typing import Literal
except:
# for python < 3.8
from typing_extensions import Literal
class Capturing(list):
def __enter__(self):
self._stdout = sys.stdout
sys.stdout = self._stringio = StringIO()
return self
def __exit__(self, *args):
self.extend(self._stringio.getvalue().splitlines())
del self._stringio # free up some memory
sys.stdout = self._stdout
class StreamTee(object):
"""
Allows you to use a single file-like object to write to two file-like objects at the same time.
> import sys
> logfile = file("blah.txt", "w+")
> sys.stdout = StreamTee(sys.stdout, logfile)
"""
def __init__(self, stream1, stream2):
self.stream1 = stream1
self.stream2 = stream2
self.__missing_method_name = None
def __getattribute__(self, name):
return object.__getattribute__(self, name)
def __getattr__(self, name):
self.__missing_method_name = name
return getattr(self, "__methodmissing__")
def __methodmissing__(self, *args, **kwargs):
callable2 = getattr(self.stream2, self.__missing_method_name)
callable2(*args, **kwargs)
callable1 = getattr(self.stream1, self.__missing_method_name)
return callable1(*args, **kwargs)
class CapturingTee(list):
"""
Same thing as Capturing, however it doesn't block stdout from being written to console.
"""
def __enter__(self):
self._stdout = sys.stdout
self._stringio = StringIO()
sys.stdout = StreamTee(self._stdout, self._stringio)
return self
def __exit__(self, *args):
self.extend(self._stringio.getvalue().splitlines())
del self._stringio
sys.stdout = self._stdout
class ValueKeyDict(dict):
"""
Creates a `dict` with custom indexing behavior where when the requested index
value is `None`, the index key is returned.
Example:
> foo = ValueKeyDict({
> "alpha": None,
> "beta": "charlie"
> })
> foo.get("alpha") == None
True
> foo.get("beta") == "charlie"
True
> foo["alpha"] == "alpha"
True
> foo["beta"] == "charlie"
True
"""
def __getitem__(self, index):
val = super().__getitem__(index)
if val == None:
return index
else:
return val
SIBIS_DIRS = ValueKeyDict(
{
"beta": None,
"log": None,
"operations": None,
"cases": None,
"summaries": None,
"burn2dvd": None,
"datadict": None,
"laptops": None,
"laptops_svn": "ncanda",
"laptops_imported": "imported",
"XNAT": None,
"redcap": None,
}
)
# --------------------------------------------
# CLASS DEFINITION
class Session(object):
"""
SIBIS Session Object
====================
Main object that provides logging, data connections, and
issues management.
config_file: yml file specifying configuration
Or set path as SIBIS_CONFIG environment variable
(default: see cfg_parser.default_config_file)
connect: connects to all servers
(default: None)
assumes
from sibispy import sibislogger as slog
slog.init_log()
is called before
"""
def __init__(self, opt_api: Mapping = {}):
self.__config_usr_data = cfg_parser.config_file_parser()
self.__config_srv_data = None
self.api = {
"xnat": None,
"xnat_http": None,
"import_laptops": None,
"import_webcnp": None,
"data_entry": None,
"redcap_mysql_db": None,
"browser_penncnp": None,
"svn_laptop": None,
}
# redcap projects are import_laptops, import_webcnp, and data_entry
# Inject additional API options if required (to avoid depending on the
# hard-coded options above)
self.api.update(opt_api)
self.__active_redcap_project__ = None
self.__ordered_config_load = False
def configure(self, config_file=None, ordered_config_load_flag=False):
"""
Configures the session object by first checking for an
environment variable, then in the home directory.
"""
self.__ordered_config_load = ordered_config_load_flag
err_msg = self.__config_usr_data.configure(
config_file, ordered_load=self.__ordered_config_load
)
if err_msg:
slog.info("session.configure", str(err_msg), sibis_config_file=config_file)
return False
(sys_file_parser, err_msg) = self.get_config_sys_parser()
if err_msg:
slog.info("session.configure", str(err_msg))
return False
if sys_file_parser.has_category("sibis_dirs"):
sibis_dirs = sys_file_parser.get_category("sibis_dirs")
SIBIS_DIRS.update(sibis_dirs)
self.__config_srv_data = sys_file_parser.get_category("session")
return True
def connect_server(self, api_type, timeFlag=False, penncnp_HiddenBrowserFlag=True):
"""
Connect to servers, setting each property.
"""
if api_type not in self.api:
slog.info(
"session.connect_server",
"api type " + api_type + " not defined !",
api_types=str(list(self.api.keys())),
)
return None
if timeFlag:
slog.startTimer2()
if api_type == "xnat":
connectionPtr = self.__connect_xnat__()
elif api_type == "xnat_http":
connectionPtr = self.__connect_xnat_http__()
elif api_type == "browser_penncnp":
connectionPtr = self.__connect_penncnp__(penncnp_HiddenBrowserFlag)
elif api_type == "svn_laptop":
connectionPtr = self.__connect_svn_laptop__()
elif api_type == "redcap_mysql_db":
connectionPtr = self.__connect_redcap_mysql__()
else:
connectionPtr = self.__connect_redcap_project__(api_type)
if timeFlag:
slog.takeTimer2("connect_" + api_type)
return connectionPtr
# Access xnat directly through http calls
def __connect_xnat_http__(self):
import requests
cfg = self.__config_usr_data.get_category("xnat")
jsessionid = "".join([self.get_xnat_data_address(), "/JSESSIONID"])
http_session = requests.session()
http_session.auth = (cfg["user"], cfg["password"])
try:
http_session.get(jsessionid)
except Exception as err_msg:
slog.info(
"session.__connect_xnat_http__", str(err_msg), server=cfg.get("server")
)
return None
self.api["xnat_http"] = http_session
return http_session
# Access xnat through XnatUtil
def __connect_xnat__(self):
from .xnat_util import XnatUtil
cfg = self.__config_usr_data.get_category("xnat")
try:
util = XnatUtil(
server=cfg.get("server"),
user=cfg.get("user"),
password=cfg.get("password"),
)
raw_xnat = util.connect()
except Exception as err_msg:
slog.info(
"session.__connect_xnat__", str(err_msg), server=cfg.get("server")
)
return None
self.api["xnat"] = util
return util
def __list_running_process__(self, cmd):
from subprocess import Popen, PIPE
check_cmd = "ps -efww | grep '" + cmd + "' | awk '{print $2}'"
try:
p = Popen(check_cmd, shell=True, stdout=PIPE, stderr=PIPE)
return p.communicate()
except Exception as err_msg:
return (None, str(err_msg))
@contextmanager
def __connect_penncnp__(self, penncnp_HiddenBrowserFlag=True):
# Check that config file is correctly defined
if "penncnp" not in list(self.__config_srv_data.keys()):
slog.info(
"session.__connnect_penncnp__",
"ERROR: penncnp server info not defined!",
)
yield
return
penncnp_srv_data = self.__config_srv_data["penncnp"]
if "penncnp" not in list(self.__config_usr_data.keys()):
slog.info(
"session.__connnect_penncnp__", "ERROR: penncnp user info not defined!"
)
yield
return
penncnp_usr_data = self.__config_usr_data.get_category("penncnp")
if penncnp_HiddenBrowserFlag:
# Check if display is open
display = ":" + str(penncnp_srv_data["display"])
vfb_cmd = "vfb +extension RANDR " + display
check_cmd = "[X]" + vfb_cmd
(pip_list, err_msg) = self.__list_running_process__(check_cmd)
if err_msg:
slog.info(
"session.__connect_penncnp__",
"Checking if command %s is already running failed with the following error message: %s"
% (check_cmd, strcheck_err),
)
yield
return
if pip_list:
slog.info(
"session.__connect_penncnp__",
"Error: sessions with display "
+ display
+ " are already running ! Please execute 'kill -9 "
+ pip_list.decode("utf-8")
+ "' before proceeding!",
)
yield
return
# Open screen
import subprocess
display_cmd = "X" + vfb_cmd + " &> /dev/null"
try:
proc = subprocess.Popen(display_cmd, shell=True)
proc.poll()
if proc.returncode is not None:
(out, err_msg) = proc.communicate(timeout=30)
except Exception as err_msg:
pass
if err_msg:
slog.info(
"session.__connect_penncnp__",
"The following command failed %s with the following output %s"
% (display_cmd, str(err_msg)),
)
yield
self.disconnect_penncnp()
return
(pip, err_msg) = self.__list_running_process__(check_cmd)
if err_msg:
slog.info(
"session.__connect_penncnp__",
"Checking if command %s is already running failed with the following error message: %s"
% (check_cmd, strcheck_err),
)
yield
self.disconnect_penncnp()
return
# if multiple pips are returned (run outside the container)
pip=pip.decode("utf-8").split('\n')[0]
if not pip:
slog.info(
"session.__connect_penncnp__",
"Error: sessions with display " + display + " did not start up!",
)
yield
self.disconnect_penncnp()
return
os.environ["DISPLAY"] = display
else:
# Do not set display
display=""
pip=-1
# Set up Browser
# Configure Firefox profile for automated file download
from selenium import webdriver
fp = webdriver.FirefoxProfile()
fp.set_preference("browser.download.folderList", 2)
fp.set_preference("browser.download.manager.showWhenStarting", False)
fp.set_preference("browser.download.dir", os.getcwd())
fp.set_preference(
"browser.helperApps.neverAsk.saveToDisk", "application/vnd.ms-excel"
)
browser = webdriver.Firefox(
firefox_profile=fp, service_log_path="/tmp/geckodriver.log"
)
# Log into website
browser.get(penncnp_srv_data["server"])
browser.find_element_by_name("adminid").send_keys(penncnp_usr_data["user"])
browser.find_element_by_name("pwd").send_keys(penncnp_usr_data["password"])
browser.find_element_by_name("Login").click()
# Exit configuration
self.api["browser_penncnp"] = {
"browser": browser,
"pip": int(pip),
"display": display,
}
try:
yield browser
except:
raise
finally:
self.disconnect_penncnp()
def __connect_svn_laptop__(self):
# Check that config file is correctly defined
if "svn_laptop" not in list(self.__config_usr_data.keys()):
slog.info(
"session.__connnect_svn_laptop__",
"ERROR: svn laptop user info not defined!",
)
return None
usr_data = self.__config_usr_data.get_category("svn_laptop")
svnDir = self.get_laptop_svn_dir()
client = SibisSvnClient(
svnDir, username=usr_data["user"], password=usr_data["password"]
)
self.api["svn_laptop"] = {
"client": client,
"user": usr_data["user"],
"password": usr_data["password"],
}
return client
def __connect_redcap_project__(self, api_type):
import redcap
cfg = self.__config_usr_data.get_category("redcap")
if not cfg:
slog.info(
"session.__connect_redcap_project__",
"Error: config file does not contain section redcap",
config_file=self.__config_usr_data.get_config_file(),
)
return None
try:
data_entry = redcap.Project(
cfg.get("server"),
cfg.get(api_type + "_token"),
verify_ssl=cfg.get("verify_ssl"),
)
self.api[api_type] = data_entry
except KeyError as err:
slog.info(
"session.__connect_redcap_project__",
str(err),
server=cfg.get("server"),
api_type=api_type,
)
return None
except requests.RequestException as err:
slog.info(
"session.__connect_redcap_project__",
str(err),
server=cfg.get("server"),
api_type=api_type,
)
return None
self.__active_redcap_project__ = api_type
return data_entry
def __connect_redcap_mysql__(self):
from sqlalchemy import create_engine
cfg = self.__config_usr_data.get_category("redcap-mysql")
if not cfg:
slog.info(
"session.__connect_redcap_mysql__",
"Error: config file does not contain section redcap-mysql",
config_file=self.__config_usr_data.get_config_file(),
)
return None
# by default should be set to 3306
port = cfg.get("port")
if not port:
slog.info(
"session.__connect_redcap_mysql__",
"Error: config file does not define 'port' in section 'redcap-mysql'",
config_file=self.__config_usr_data.get_config_file(),
)
return None
user = cfg.get("user")
passwd = cfg.get("passwd")
db = cfg.get("db")
hostname = cfg.get("hostname")
connection_string = "mysql+pymysql://{0}:{1}@{2}:{3}/{4}".format(
user, passwd, hostname, port, db
)
try:
engine = create_engine(connection_string, pool_recycle=3600)
except Exception as err_msg:
slog.info(
"session.__connect_redcap_mysql__",
str(err_msg),
database=db,
hostname=hostname,
)
return None
self.api["redcap_mysql_db"] = engine
return engine
def __get_analysis_dir(self):
analysis_dir = self.__config_usr_data.get_value("analysis_dir")
if analysis_dir == None:
slog.info(
"session.__get_analysis_dir-"
+ hashlib.sha1(
str(self.__config_usr_data.get_config_file()).encode("utf-8")
).hexdigest()[0:6],
"ERROR: 'analysis_dir' is not defined in config file !",
config_file=self.__config_usr_data.get_config_file(),
)
return analysis_dir
def get_analysis_dir(self):
return self.__get_analysis_dir()
def get_import_dir(self):
import_dir = self.__config_usr_data.get_value("import_dir")
if import_dir == None:
slog.info(
"session.get_import_dir-"
+ hashlib.sha1(
str(self.__config_usr_data.get_config_file()).encode("utf-8")
).hexdigest()[0:6],
"ERROR: 'import_dir' is not defined in config file !",
config_file=self.__config_usr_data.get_config_file(),
)
return import_dir
def get_ordered_config_load(self):
return self.__ordered_config_load
def get_project_name(self):
return self.__config_usr_data.get_value("project_name")
def get_email(self):
return self.__config_usr_data.get_value("email")
def get_beta_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["beta"])
return None
def get_log_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["log"])
return None
def get_operations_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["operations"])
return None
def get_config_parser_for_file(self, key, filename):
oDir = self.get_operations_dir()
if not oDir:
return (None, "ERROR: could not retrieve operations directory")
sys_file = os.path.join(oDir, filename)
if not os.path.exists(sys_file):
return (None, "ERROR:" + sys_file + " does not exist!")
# Get project specific settings for test file
sys_file_parser = cfg_parser.config_file_parser()
err_msg = sys_file_parser.configure(
sys_file, ordered_load=self.__ordered_config_load
)
if err_msg:
return (None, "{0} ({1} : {2})".format(str(err_msg), key, str(sys_file)))
return (sys_file_parser, None)
def get_config_test_parser(self):
return self.get_config_parser_for_file(
"config_test_file", "sibis_test_config.yml"
)
def get_config_sys_parser(self):
return self.get_config_parser_for_file(
"config_sys_file", "sibis_sys_config.yml"
)
def get_cases_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["cases"])
return None
def get_summaries_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["summaries"])
return None
def get_dvd_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["burn2dvd"])
return None
def get_datadict_dir(self):
aDir = self.__get_analysis_dir()
if aDir:
return os.path.join(aDir, SIBIS_DIRS["datadict"])
return None
def __get_laptop_dir(self):
return os.path.join(
self.__config_usr_data.get_value("import_dir"), SIBIS_DIRS["laptops"]
)
# Kilian: Ommit ncanda from svn dir name
def get_laptop_svn_dir(self):
return os.path.join(self.__get_laptop_dir(), SIBIS_DIRS["laptops_svn"])
def get_laptop_imported_dir(self):
return os.path.join(self.__get_laptop_dir(), SIBIS_DIRS["laptops_imported"])
def get_xnat_dir(self):
return os.path.join(
self.__config_usr_data.get_value("import_dir"), SIBIS_DIRS["XNAT"]
)
# Important for redcap front end - not sibis programs
def get_redcap_uploads_dir(self):
return os.path.join(
self.__config_usr_data.get_value("import_dir"), SIBIS_DIRS["redcap"]
)
def get_xnat_server_address(self):
return self.__config_usr_data.get_value("xnat", "server")
def get_xnat_data_address(self):
return self.get_xnat_server_address() + "/data"
def get_xnat_experiments_address(self):
return self.get_xnat_data_address() + "/experiments"
def get_xnat_session_address(
self, experiment_id: str, output_format: Literal["html", "csv", "json"] = "html"
):
return (
self.get_xnat_experiments_address()
+ "/"
+ experiment_id
+ "?format="
+ output_format
)
def xnat_http_get_all_experiments(self):
xnat_http_api = self.__get_xnat_http_api__()
if not xnat_http_api:
return None
return xnat_http_api.get(self.get_xnat_experiments_address() + "?format=csv")
def xnat_http_get_experiment_xml(self, experiment_id):
xnat_http_api = self.__get_xnat_http_api__()
if not xnat_http_api:
return None
return xnat_http_api.get(self.get_xnat_session_address(experiment_id, "csv"))
def xnat_get_classes(self):
xnat_api = self.__get_xnat_api__()
if not xnat_api:
error_msg = ("XNAT API is not defined! Cannot retrieve classes!",)
slog.info(eid, error_msg, function="session.xnat_get_classes")
return None
return xnat_api.client.classes
# makes a difference where later saved file on disk how the function is called
def xnat_get_experiment(self, eid, project=None, subject_label=None):
xnat_api = self.__get_xnat_api__()
if not xnat_api:
error_msg = ("XNAT API is not defined! Cannot retrieve experiment!",)
slog.info(eid, error_msg, function="session.xnat_get_experiment")
return None
# makes a difference where later saved file on disk how the function is called
if project and subject_label:
select_object = self.xnat_get_subject(project, subject_label)
if not select_object:
slog.info(
subject_label,
"ERROR: session.xnat_get_experiment: subject "
+ subject_label
+ " not found !",
project=project,
)
return None
else:
select_object = xnat_api.select
try:
xnat_experiment = select_object.experiments[eid]
except KeyError as err_msg:
slog.info(
eid + "-" + hashlib.sha1(str(err_msg).encode("utf-8")).hexdigest()[0:6],
"WARNING: eid: {} does not exist!".format(eid),
err_msg=str(err_msg),
function="session.xnat_get_experiment",
)
return None
except Exception as err_msg:
slog.info(
eid + "-" + hashlib.sha1(str(err_msg).encode("utf-8")).hexdigest()[0:6],
"ERROR: problem with xnat api !",
err_msg=str(err_msg),
function="session.xnat_get_experiment",
)
return None
# not sure how this would ever happen
if not xnat_experiment:
slog.info(
eid,
"ERROR: session.xnat_get_experiment: experiment not created - problem with xnat api!",
)
return None
# if not xnat_experiment.exists() :
# slog.info(eid,"ERROR: session.xnat_get_experiment: experiment does not exist !")
# return None
return xnat_experiment
# replaces xnat_api.select.project(prj).subject( subject_label ).attrs.get(attribute)
def xnat_get_subject(self, project, subject_label):
xnat_api = self.__get_xnat_api__()
if not xnat_api:
error_msg = "XNAT API is not defined! Cannot retrieve subject !"
slog.info(
subject_label,
error_msg,
function="session.xnat_get_subject",
project=project,
)
return None
try:
xnat_project = xnat_api.select.projects[project]
except KeyError as err_msg:
slog.info(
subject_label
+ "-"
+ hashlib.sha1(str(err_msg).encode("utf-8")).hexdigest()[0:6],
"WARNING: project:{} could not be found!".format(project),
err_msg=str(err_msg),
function="session.xnat_get_subject",
project=project,
)
return None
except Exception as err_msg:
slog.info(
subject_label
+ "-"
+ hashlib.sha1(str(err_msg).encode("utf-8")).hexdigest()[0:6],
"ERROR: project could not be found!",
err_msg=str(err_msg),
function="session.xnat_get_subject",
project=project,
)
return None
if not xnat_project:
slog.info(
subject_label,
"ERROR: session.xnat_get_subject: project " + project + " not found !",
)
return None
try:
xnat_subject = xnat_project.subjects[subject_label]
except Exception as err_msg:
slog.info(
subject_label
+ "-"
+ hashlib.sha1(str(err_msg).encode("utf-8")).hexdigest()[0:6],
"ERROR: subject could not be found!",
err_msg=str(err_msg),
project=project,
function="session.xnat_get_subject",
subject=subject_label,
)
return None
return xnat_subject
def xnat_get_subject_attribute(self, project, subject_label, attribute):
xnat_subject = self.xnat_get_subject(project, subject_label)
if not xnat_subject:
issue_url = slog.info(
subject_label,
"ERROR: session.xnat_get_subject_attribute: subject "
+ subject_label
+ " not found !",
project=project,
)
return [None, issue_url]
try:
try:
return [getattr(xnat_subject, attribute), None]
except:
return [getattr(xnat_subject, attribute.lower()), None]
except Exception as err_msg:
issue_url = slog.info(
"session.xnat_get_subject_attribute"
+ hashlib.sha1(str(err_msg).encode("utf-8")).hexdigest()[0:6],
"ERROR: attribute could not be found!",
err_msg=str(err_msg),
project=project,
subject=subject_label,
function="session.xnat_get_subject_attribute",
info="Did subject change site ? Make sure that site of subject ID matches project !",
attribute=attribute,
)
return [None, issue_url]
# if time_label is set then will take the time of the operation
def xnat_export_general(self, form, fields, conditions, time_label=None):
xnat_api = self.__get_xnat_api__()
if not xnat_api:
return None
if time_label:
slog.startTimer2()
try:
# python if one cannot connect to server then
with Capturing() as xnat_output:
xnat_data = list(
xnat_api.search(form, fields).where(conditions).items()
)
except Exception as err_msg:
if xnat_output:
slog.info(
"session.xnat_export_general",
"ERROR: querying XNAT failed most likely due disconnect to server ({})".format(
time.asctime()
),
xnat_api_output=str(xnat_output),
form=str(form),
fields=str(fields),
conditions=str(conditions),
err_msg=str(err_msg),
)
else:
slog.info(
"session.xnat_export_general",
"ERROR: querying XNAT failed at {}".format(time.asctime()),
form=str(form),
fields=str(fields),
conditions=str(conditions),
err_msg=str(err_msg),
)
return None
if time_label:
slog.takeTimer2("xnat_export_" + time_label)
return xnat_data
def __get_xnat_api__(self):
if not self.api["xnat"]:
slog.info("__get_xnat_api__", "Error: XNAT api not defined")
return None
return self.api["xnat"]
def __get_xnat_http_api__(self):
if not self.api["xnat_http"]:
slog.info("__get_xnat_http_api__", "Error: XNAT_HTTP api not defined")
return None
return self.api["xnat_http"]
def initialize_penncnp_wait(self):
from selenium.webdriver.support.ui import WebDriverWait
return WebDriverWait(
self.api["browser_penncnp"]["browser"],
self.__config_srv_data["penncnp"]["wait"],
)
def get_penncnp_export_report(self, wait):
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.common.by import By
try:
report = wait.until(EC.element_to_be_clickable((By.NAME, "Export Report")))
except Exception as e:
slog.info(
"session.get_penncnp_export",
"ERROR: Timeout, could not find Export Report",
info="Try increasing wait time at WebDriverWait",
msg=str(e),
)
return None
return report
def disconnect_penncnp(self):
# Note, if python script is manually killed before reaching this function then the subprocesses (e.g. X display) are also automatically killed
if not self.api["browser_penncnp"]:
return
self.api["browser_penncnp"]["browser"].quit()
display=self.api["browser_penncnp"]["display"]
if display != "":
if ("DISPLAY" in list(os.environ.keys()) and os.environ["DISPLAY"] == display):
del os.environ["DISPLAY"]
pip=self.api["browser_penncnp"]["pip"]
if pip > 0 :
kill_cmd = "kill -9 " + str(pip)
try:
import subprocess
err_msg = subprocess.check_output(kill_cmd, shell=True)
except Exception as err:
err_msg = err
if err_msg:
slog.info(
"session.__connect_penncnp__",
"The following command failed %s with the following output %s"
% (kill_cmd, str(err_msg)),
)
return None
def get_redcap_server_address(self):
return self.__config_usr_data.get_value("redcap", "server")
def get_redcap_base_address(self):