forked from galaxyproject/galaxy
/
admin_toolshed.py
1268 lines (1242 loc) · 89.5 KB
/
admin_toolshed.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
import json
import logging
import os
from six import string_types
from sqlalchemy import or_
import tool_shed.repository_types.util as rt_util
from galaxy import util, web
from galaxy.tool_shed.galaxy_install import install_manager
from galaxy.tool_shed.galaxy_install.repository_dependencies import repository_dependency_manager
from galaxy.tool_shed.galaxy_install.tools import tool_panel_manager
from galaxy.tool_util.deps import views
from galaxy.util import unicodify
from galaxy.web.form_builder import CheckboxField
from tool_shed.galaxy_install import dependency_display
from tool_shed.galaxy_install.grids import admin_toolshed_grids
from tool_shed.util import (
common_util,
encoding_util,
hg_util,
readme_util,
repository_util,
shed_util_common as suc,
tool_dependency_util,
tool_util,
)
from tool_shed.util.web_util import escape
from .admin import AdminGalaxy
log = logging.getLogger(__name__)
class AdminToolshed(AdminGalaxy):
installed_repository_grid = admin_toolshed_grids.InstalledRepositoryGrid()
@web.expose
@web.require_admin
def activate_repository(self, trans, **kwd):
"""Activate a repository that was deactivated but not uninstalled."""
repository_id = kwd['id']
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
try:
trans.app.installed_repository_manager.activate_repository(repository)
message = 'The <b>%s</b> repository has been activated.' % escape(repository.name)
status = 'done'
except Exception as e:
error_message = "Error activating repository %s: %s" % (escape(repository.name), unicodify(e))
log.exception(error_message)
message = '%s.<br/>You may be able to resolve this by uninstalling and then reinstalling the repository. Click <a href="%s">here</a> to uninstall the repository.' \
% (error_message, web.url_for(controller='admin_toolshed', action='deactivate_or_uninstall_repository', id=trans.security.encode_id(repository.id)))
status = 'error'
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='manage_repository',
id=repository_id,
message=message,
status=status))
@web.legacy_expose_api
@web.require_admin
def browse_repositories(self, trans, **kwd):
message = kwd.get('message', '')
status = kwd.get('status', '')
if 'operation' in kwd:
operation = kwd.pop('operation').lower()
if operation == "update tool shed status":
message, status = repository_util.check_for_updates(trans.app, trans.install_model, kwd.get('id'))
if message and status:
kwd['message'] = util.sanitize_text(message)
kwd['status'] = 'success' if status in ['ok', 'done', 'success'] else 'error'
return self.installed_repository_grid(trans, **kwd)
@web.expose
@web.require_admin
def restore_repository(self, trans, **kwd):
repository_id = kwd['id']
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
if repository.uninstalled:
# Since we're reinstalling the repository we need to find the latest changeset revision to which it can
# be updated so that we can reset the metadata if necessary. This will ensure that information about
# repository dependencies and tool dependencies will be current. Only allow selecting a different section
# in the tool panel if the repository was uninstalled and it contained tools that should be displayed in
# the tool panel.
changeset_revision_dict = trans.app.update_repository_manager.get_update_to_changeset_revision_and_ctx_rev(repository)
current_changeset_revision = changeset_revision_dict.get('changeset_revision', None)
current_ctx_rev = changeset_revision_dict.get('ctx_rev', None)
if current_changeset_revision and current_ctx_rev:
if current_ctx_rev == repository.ctx_rev:
# The uninstalled repository is current.
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='reselect_tool_panel_section',
**kwd))
else:
# The uninstalled repository has updates available in the tool shed.
updated_repo_info_dict = \
self.get_updated_repository_information(trans=trans,
repository_id=trans.security.encode_id(repository.id),
repository_name=repository.name,
repository_owner=repository.owner,
changeset_revision=current_changeset_revision)
json_repo_info_dict = json.dumps(updated_repo_info_dict)
encoded_repo_info_dict = encoding_util.tool_shed_encode(json_repo_info_dict)
kwd['latest_changeset_revision'] = current_changeset_revision
kwd['latest_ctx_rev'] = current_ctx_rev
kwd['updated_repo_info_dict'] = encoded_repo_info_dict
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='reselect_tool_panel_section',
**kwd))
else:
message = "Unable to get latest revision for repository <b>%s</b> from " % escape(str(repository.name))
message += "the Tool Shed, so repository re-installation is not possible at this time."
status = "error"
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='manage_repository',
id=repository_id,
message=message,
status=status))
else:
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='activate_repository',
**kwd))
@web.expose
def display_image_in_repository(self, trans, **kwd):
"""
Open an image file that is contained in an installed tool shed repository or that is referenced by a URL for display. The
image can be defined in either a README.rst file contained in the repository or the help section of a Galaxy tool config that
is contained in the repository. The following image definitions are all supported. The former $PATH_TO_IMAGES is no longer
required, and is now ignored.
.. image:: https://raw.github.com/galaxy/some_image.png
.. image:: $PATH_TO_IMAGES/some_image.png
.. image:: /static/images/some_image.gif
.. image:: some_image.jpg
.. image:: /deep/some_image.png
"""
repository_id = kwd.get('repository_id', None)
relative_path_to_image_file = kwd.get('image_file', None)
if repository_id and relative_path_to_image_file:
repository = repository_util.get_tool_shed_repository_by_id(trans.app, repository_id)
if repository:
repo_files_dir = repository.repo_files_directory(trans.app)
# The following line sometimes returns None. TODO: Figure out why.
path_to_file = repository_util.get_absolute_path_to_file_in_repository(repo_files_dir, relative_path_to_image_file)
if path_to_file and os.path.exists(path_to_file):
file_name = os.path.basename(relative_path_to_image_file)
try:
extension = file_name.split('.')[-1]
except Exception:
extension = None
if extension:
mimetype = trans.app.datatypes_registry.get_mimetype_by_extension(extension)
if mimetype:
trans.response.set_content_type(mimetype)
return open(path_to_file, 'rb')
return None
@web.expose
@web.require_admin
def view_tool_metadata(self, trans, repository_id, tool_id, **kwd):
message = escape(kwd.get('message', ''))
status = kwd.get('status', 'done')
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
repository_metadata = repository.metadata
shed_config_dict = repository.get_shed_config_dict(trans.app)
tool_metadata = {}
tool_lineage = []
tool = None
if 'tools' in repository_metadata:
for tool_metadata_dict in repository_metadata['tools']:
if tool_metadata_dict['id'] == tool_id:
tool_metadata = tool_metadata_dict
tool_config = tool_metadata['tool_config']
if shed_config_dict and shed_config_dict.get('tool_path'):
tool_config = os.path.join(shed_config_dict.get('tool_path'), tool_config)
tool = trans.app.toolbox.get_tool(tool_id=tool_metadata['guid'], exact=True)
if not tool:
tool = trans.app.toolbox.load_tool(os.path.abspath(tool_config), guid=tool_metadata['guid'])
if tool:
tool._lineage = trans.app.toolbox._lineage_map.register(tool)
if tool:
tool_lineage = tool.lineage.get_version_ids(reverse=True)
break
return trans.fill_template("/admin/tool_shed_repository/view_tool_metadata.mako",
repository=repository,
repository_metadata=repository_metadata,
tool=tool,
tool_metadata=tool_metadata,
tool_lineage=tool_lineage,
message=message,
status=status)
@web.json
@web.require_admin
def get_file_contents(self, trans, file_path, repository_id):
# Avoid caching
trans.response.headers['Pragma'] = 'no-cache'
trans.response.headers['Expires'] = '0'
return suc.get_repository_file_contents(trans.app, file_path, repository_id, is_admin=True)
@web.expose
@web.require_admin
def get_tool_dependencies(self, trans, repository_id, repository_name, repository_owner, changeset_revision):
"""
Send a request to the appropriate tool shed to retrieve the dictionary of tool dependencies defined for
the received repository name, owner and changeset revision. The received repository_id is the encoded id
of the installed tool shed repository in Galaxy. We need it so that we can derive the tool shed from which
it was installed.
"""
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
tool_shed_url = common_util.get_tool_shed_url_from_tool_shed_registry(trans.app, str(repository.tool_shed))
if tool_shed_url is None or repository_name is None or repository_owner is None or changeset_revision is None:
message = "Unable to retrieve tool dependencies from the Tool Shed because one or more of the following required "
message += "parameters is None: tool_shed_url: %s, repository_name: %s, repository_owner: %s, changeset_revision: %s " % \
(str(tool_shed_url), str(repository_name), str(repository_owner), str(changeset_revision))
raise Exception(message)
params = dict(name=repository_name, owner=repository_owner, changeset_revision=changeset_revision)
pathspec = ['repository', 'get_tool_dependencies']
raw_text = util.url_get(tool_shed_url, password_mgr=self.app.tool_shed_registry.url_auth(tool_shed_url), pathspec=pathspec, params=params)
if len(raw_text) > 2:
encoded_text = json.loads(raw_text)
text = encoding_util.tool_shed_decode(encoded_text)
else:
text = ''
return text
@web.expose
@web.require_admin
def get_updated_repository_information(self, trans, repository_id, repository_name, repository_owner, changeset_revision):
"""
Send a request to the appropriate tool shed to retrieve the dictionary of information required to reinstall
an updated revision of an uninstalled tool shed repository.
"""
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
tool_shed_url = common_util.get_tool_shed_url_from_tool_shed_registry(trans.app, str(repository.tool_shed))
if tool_shed_url is None or repository_name is None or repository_owner is None or changeset_revision is None:
message = "Unable to retrieve updated repository information from the Tool Shed because one or more of the following "
message += "required parameters is None: tool_shed_url: %s, repository_name: %s, repository_owner: %s, changeset_revision: %s " % \
(str(tool_shed_url), str(repository_name), str(repository_owner), str(changeset_revision))
raise Exception(message)
params = dict(name=str(repository_name),
owner=str(repository_owner),
changeset_revision=changeset_revision)
pathspec = ['repository', 'get_updated_repository_information']
raw_text = util.url_get(tool_shed_url, password_mgr=self.app.tool_shed_registry.url_auth(tool_shed_url), pathspec=pathspec, params=params)
repo_information_dict = json.loads(raw_text)
return repo_information_dict
@web.expose
@web.require_admin
def initiate_tool_dependency_installation(self, trans, tool_dependencies, **kwd):
"""
Install specified dependencies for repository tools. The received list of tool_dependencies
are the database records for those dependencies defined in the tool_dependencies.xml file
(contained in the repository) that should be installed. This allows for filtering out dependencies
that have not been checked for installation on the 'Manage tool dependencies' page for an installed
tool shed repository.
"""
# Get the tool_shed_repository from one of the tool_dependencies.
message = str(escape(kwd.get('message', '')))
status = kwd.get('status', 'done')
err_msg = ''
tool_shed_repository = tool_dependencies[0].tool_shed_repository
# Get the tool_dependencies.xml file from the repository.
tool_dependencies_config = hg_util.get_config_from_disk(rt_util.TOOL_DEPENDENCY_DEFINITION_FILENAME,
tool_shed_repository.repo_path(trans.app))
itdm = install_manager.InstallToolDependencyManager(trans.app)
installed_tool_dependencies = itdm.install_specified_tool_dependencies(tool_shed_repository=tool_shed_repository,
tool_dependencies_config=tool_dependencies_config,
tool_dependencies=tool_dependencies,
from_tool_migration_manager=False)
for installed_tool_dependency in installed_tool_dependencies:
if installed_tool_dependency.status == trans.app.install_model.ToolDependency.installation_status.ERROR:
text = unicodify(installed_tool_dependency.error_message)
if text is not None:
err_msg += ' %s' % text
if err_msg:
message += err_msg
status = 'error'
message += "Installed tool dependencies: %s" % ', '.join(td.name for td in installed_tool_dependencies)
td_ids = [trans.security.encode_id(td.id) for td in tool_shed_repository.tool_dependencies]
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='manage_tool_dependencies',
tool_dependency_ids=td_ids,
message=message,
status=status))
@web.expose
@web.require_admin
def install_latest_repository_revision(self, trans, **kwd):
"""Install the latest installable revision of a repository that has been previously installed."""
repository_id = kwd.get('id', None)
if repository_id is not None:
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
if repository is not None:
tool_shed_url = common_util.get_tool_shed_url_from_tool_shed_registry(trans.app, str(repository.tool_shed))
name = str(repository.name)
owner = str(repository.owner)
params = dict(galaxy_url=web.url_for('/', qualified=True),
name=name,
owner=owner)
pathspec = ['repository', 'get_latest_downloadable_changeset_revision']
raw_text = util.url_get(tool_shed_url, password_mgr=self.app.tool_shed_registry.url_auth(tool_shed_url), pathspec=pathspec, params=params)
url = util.build_url(tool_shed_url, pathspec=pathspec, params=params)
latest_downloadable_revision = json.loads(raw_text)
if latest_downloadable_revision == hg_util.INITIAL_CHANGELOG_HASH:
return trans.show_error_message('Error retrieving the latest downloadable revision for this repository via the url <b>%s</b>.' % url)
else:
# Make sure the latest changeset_revision of the repository has not already been installed.
# Updates to installed repository revisions may have occurred, so make sure to locate the
# appropriate repository revision if one exists. We need to create a temporary repo_info_tuple
# with the following entries to handle this.
# ( description, clone_url, changeset_revision, ctx_rev, owner, repository_dependencies, tool_dependencies )
tmp_clone_url = util.build_url(tool_shed_url, pathspec=['repos', owner, name])
tmp_repo_info_tuple = (None, tmp_clone_url, latest_downloadable_revision, None, owner, None, None)
installed_repository, installed_changeset_revision = \
repository_util.repository_was_previously_installed(trans.app, tool_shed_url, name, tmp_repo_info_tuple, from_tip=False)
if installed_repository:
current_changeset_revision = str(installed_repository.changeset_revision)
message = 'Revision <b>%s</b> of repository <b>%s</b> owned by <b>%s</b> has already been installed.' % \
(latest_downloadable_revision, name, owner)
if current_changeset_revision != latest_downloadable_revision:
message += ' The current changeset revision is <b>%s</b>.' % current_changeset_revision
return trans.show_error_message(message)
else:
# Install the latest downloadable revision of the repository.
params = dict(name=name,
owner=owner,
changeset_revisions=str(latest_downloadable_revision),
galaxy_url=web.url_for('/', qualified=True))
pathspec = ['repository', 'install_repositories_by_revision']
url = util.build_url(tool_shed_url, pathspec=pathspec, params=params)
return trans.response.send_redirect(url)
else:
return trans.show_error_message('Cannot locate installed tool shed repository with encoded id <b>%s</b>.' % str(repository_id))
else:
return trans.show_error_message('The request parameters did not include the required encoded <b>id</b> of installed repository.')
@web.expose
@web.require_admin
def install_tool_dependencies_with_update(self, trans, **kwd):
"""
Updating an installed tool shed repository where new tool dependencies but no new repository
dependencies are included in the updated revision.
"""
updating_repository_id = kwd.get('updating_repository_id', None)
repository = repository_util.get_installed_tool_shed_repository(trans.app, updating_repository_id)
# All received dependencies need to be installed - confirmed by the caller.
encoded_tool_dependencies_dict = kwd.get('encoded_tool_dependencies_dict', None)
if encoded_tool_dependencies_dict is not None:
tool_dependencies_dict = encoding_util.tool_shed_decode(encoded_tool_dependencies_dict)
else:
tool_dependencies_dict = {}
encoded_relative_install_dir = kwd.get('encoded_relative_install_dir', None)
if encoded_relative_install_dir is not None:
relative_install_dir = encoding_util.tool_shed_decode(encoded_relative_install_dir)
else:
relative_install_dir = ''
updating_to_changeset_revision = kwd.get('updating_to_changeset_revision', None)
updating_to_ctx_rev = kwd.get('updating_to_ctx_rev', None)
encoded_updated_metadata = kwd.get('encoded_updated_metadata', None)
message = escape(kwd.get('message', ''))
status = kwd.get('status', 'done')
if 'install_tool_dependencies_with_update_button' in kwd:
# Now that the user has chosen whether to install tool dependencies or not, we can
# update the repository record with the changes in the updated revision.
if encoded_updated_metadata:
updated_metadata = encoding_util.tool_shed_decode(encoded_updated_metadata)
else:
updated_metadata = None
repository = trans.app.update_repository_manager.update_repository_record(repository=repository,
updated_metadata_dict=updated_metadata,
updated_changeset_revision=updating_to_changeset_revision,
updated_ctx_rev=updating_to_ctx_rev)
if tool_dependencies_dict:
tool_dependencies = tool_dependency_util.create_tool_dependency_objects(trans.app,
repository,
relative_install_dir,
set_status=False)
message = "The installed repository named '%s' has been updated to change set revision '%s'. " % \
(escape(str(repository.name)), updating_to_changeset_revision)
self.initiate_tool_dependency_installation(trans, tool_dependencies, message=message, status=status)
# Handle tool dependencies check box.
if not trans.app.toolbox.dependency_manager.uses_tool_shed_dependencies:
if tool_dependencies_dict:
message = ("Tool dependencies defined in this repository can be automatically installed if you set "
"the value of your <b>tool_dependency_dir</b> setting in your Galaxy config file "
"(galaxy.yml) and restart your Galaxy server.")
status = "warning"
install_tool_dependencies_check_box_checked = False
else:
install_tool_dependencies_check_box_checked = True
install_tool_dependencies_check_box = CheckboxField('install_tool_dependencies',
value=install_tool_dependencies_check_box_checked)
view = views.DependencyResolversView(self.app)
if view.installable_resolvers:
install_resolver_dependencies_check_box = CheckboxField('install_resolver_dependencies', value=True)
else:
install_resolver_dependencies_check_box = None
return trans.fill_template('/admin/tool_shed_repository/install_tool_dependencies_with_update.mako',
repository=repository,
updating_repository_id=updating_repository_id,
updating_to_ctx_rev=updating_to_ctx_rev,
updating_to_changeset_revision=updating_to_changeset_revision,
encoded_updated_metadata=encoded_updated_metadata,
encoded_relative_install_dir=encoded_relative_install_dir,
encoded_tool_dependencies_dict=encoded_tool_dependencies_dict,
install_resolver_dependencies_check_box=install_resolver_dependencies_check_box,
install_tool_dependencies_check_box=install_tool_dependencies_check_box,
tool_dependencies_dict=tool_dependencies_dict,
message=message,
status=status)
@web.expose
@web.require_admin
def install_repositories(self, trans, **kwd):
reinstalling = util.string_as_bool(kwd.get('reinstalling', False))
encoded_kwd = kwd.get('encoded_kwd')
decoded_kwd = encoding_util.tool_shed_decode(encoded_kwd) if encoded_kwd else {}
install_resolver_dependencies = CheckboxField.is_checked(decoded_kwd.get('install_resolver_dependencies', ''))
install_tool_dependencies = CheckboxField.is_checked(decoded_kwd.get('install_tool_dependencies', ''))
decoded_kwd['install_resolver_dependencies'] = install_resolver_dependencies
decoded_kwd['install_tool_dependencies'] = install_tool_dependencies
tsr_ids = decoded_kwd.get('tool_shed_repository_ids')
if not tsr_ids:
return self.message_exception(trans, 'Repository ids missing.')
irm = install_manager.InstallRepositoryManager(trans.app)
try:
tool_shed_repositories = irm.install_repositories(
tsr_ids=tsr_ids,
decoded_kwd=decoded_kwd,
reinstalling=reinstalling,
)
tsr_ids_for_monitoring = [trans.security.encode_id(tsr.id) for tsr in tool_shed_repositories]
return json.dumps(tsr_ids_for_monitoring)
except install_manager.RepositoriesInstalledException as e:
return self.message_exception(trans, unicodify(e))
@web.expose
@web.require_admin
def manage_repository(self, trans, **kwd):
message = escape(kwd.get('message', ''))
status = kwd.get('status', 'done')
repository_id = kwd.get('id', None)
if repository_id is None:
return trans.show_error_message('Missing required encoded repository id.')
if repository_id and isinstance(repository_id, list):
# FIXME: This is a hack that avoids unhandled and duplicate url parameters leaking in.
# This should be handled somewhere in the grids system, but given the legacy status
# this should be OK.
repository_id = [r for r in repository_id if '=' not in r][0] # This method only work for a single repo id
operation = kwd.get('operation', None)
repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
if repository is None:
return trans.show_error_message('Invalid repository specified.')
tool_shed_url = common_util.get_tool_shed_url_from_tool_shed_registry(trans.app, str(repository.tool_shed))
name = str(repository.name)
owner = str(repository.owner)
installed_changeset_revision = str(repository.installed_changeset_revision)
if repository.status in [trans.install_model.ToolShedRepository.installation_status.CLONING]:
tool_shed_repository_ids = [repository_id]
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='monitor_repository_installation',
tool_shed_repository_ids=tool_shed_repository_ids))
if repository.can_install and operation == 'install':
# Send a request to the tool shed to install the repository.
params = dict(name=name,
owner=owner,
changeset_revisions=installed_changeset_revision,
galaxy_url=web.url_for('/', qualified=True))
pathspec = ['repository', 'install_repositories_by_revision']
url = util.build_url(tool_shed_url, pathspec=pathspec, params=params)
return trans.response.send_redirect(url)
description = kwd.get('description', repository.description)
shed_tool_conf, tool_path, relative_install_dir = suc.get_tool_panel_config_tool_path_install_dir(trans.app, repository)
if relative_install_dir:
repo_files_dir = os.path.abspath(os.path.join(tool_path, relative_install_dir, name))
else:
repo_files_dir = None
if repository.in_error_state:
message = "This repository is not installed correctly (see the <b>Repository installation error</b> below). Choose "
message += "<b>Reset to install</b> from the <b>Repository Actions</b> menu, correct problems if necessary and try "
message += "installing the repository again."
status = "error"
elif repository.can_install:
message = "This repository is not installed. You can install it by choosing <b>Install</b> from the <b>Repository Actions</b> menu."
status = "error"
elif kwd.get('edit_repository_button', False):
if description != repository.description:
repository.description = description
trans.install_model.context.add(repository)
trans.install_model.context.flush()
message = "The repository information has been updated."
dd = dependency_display.DependencyDisplayer(trans.app)
containers_dict = dd.populate_containers_dict_from_repository_metadata(tool_shed_url=tool_shed_url,
tool_path=tool_path,
repository=repository,
reinstalling=False,
required_repo_info_dicts=None)
view = views.DependencyResolversView(self.app)
tool_requirements_d = suc.get_requirements_from_repository(repository)
requirements_status = view.get_requirements_status(tool_requirements_d, repository.installed_tool_dependencies)
return trans.fill_template('/admin/tool_shed_repository/manage_repository.mako',
repository=repository,
description=description,
repo_files_dir=repo_files_dir,
containers_dict=containers_dict,
requirements_status=requirements_status,
message=message,
status=status)
@web.expose
@web.require_admin
def monitor_repository_installation(self, trans, **kwd):
tsr_ids = common_util.get_tool_shed_repository_ids(**kwd)
if not tsr_ids:
tsr_ids = repository_util.get_ids_of_tool_shed_repositories_being_installed(trans.app, as_string=False)
tsr_ids = [trans.security.decode_id(tsr_id) for tsr_id in tsr_ids]
tool_shed_repositories = []
for tsr_id in tsr_ids:
tsr = trans.install_model.context.query(trans.install_model.ToolShedRepository).get(tsr_id)
tool_shed_repositories.append(tsr)
clause_list = []
for tsr_id in tsr_ids:
clause_list.append(trans.install_model.ToolShedRepository.table.c.id == tsr_id)
query = trans.install_model.context.current.query(trans.install_model.ToolShedRepository).filter(or_(*clause_list))
return trans.fill_template('admin/tool_shed_repository/monitor_repository_installation.mako',
tool_shed_repositories=tool_shed_repositories,
query=query,
message=escape(kwd.get('message', '')),
status=kwd.get('status'))
@web.expose
@web.require_admin
def prepare_for_install(self, trans, **kwd):
if not suc.have_shed_tool_conf_for_install(trans.app):
message = 'The <b>tool_config_file</b> setting in <b>galaxy.ini</b> must include at least one '
message += 'shed tool configuration file name with a <b><toolbox></b> tag that includes a <b>tool_path</b> '
message += 'attribute value which is a directory relative to the Galaxy installation directory in order '
message += 'to automatically install tools from a Galaxy Tool Shed (e.g., the file name <b>shed_tool_conf.xml</b> '
message += 'whose <b><toolbox></b> tag is <b><toolbox tool_path="database/shed_tools"></b>).<p/>See the '
message += '<a href="https://galaxyproject.org/installing-repositories-to-galaxy/" target="_blank">Installation '
message += 'of Galaxy Tool Shed repository tools into a local Galaxy instance</a> section of the Galaxy Tool '
message += 'Shed wiki for all of the details.'
return trans.show_error_message(message)
message = escape(kwd.get('message', ''))
status = kwd.get('status', 'done')
shed_tool_conf = kwd.get('shed_tool_conf', None)
tool_shed_url = kwd.get('tool_shed_url', '')
tool_shed_url = common_util.get_tool_shed_url_from_tool_shed_registry(trans.app, tool_shed_url)
# Handle repository dependencies, which do not include those that are required only for compiling a dependent
# repository's tool dependencies.
has_repository_dependencies = util.string_as_bool(kwd.get('has_repository_dependencies', False))
install_repository_dependencies = kwd.get('install_repository_dependencies', '')
# Every repository will be installed into the same tool panel section or all will be installed outside of any sections.
new_tool_panel_section_label = kwd.get('new_tool_panel_section_label', '')
tool_panel_section_id = kwd.get('tool_panel_section_id', '')
tool_panel_section_keys = []
# One or more repositories may include tools, but not necessarily all of them.
includes_tools = util.string_as_bool(kwd.get('includes_tools', False))
# Some tools should not be displayed in the tool panel (e.g., DataManager tools and datatype converters).
includes_tools_for_display_in_tool_panel = util.string_as_bool(kwd.get('includes_tools_for_display_in_tool_panel', False))
includes_tool_dependencies = util.string_as_bool(kwd.get('includes_tool_dependencies', False))
install_resolver_dependencies = kwd.get('install_resolver_dependencies', '')
install_tool_dependencies = kwd.get('install_tool_dependencies', '')
# In addition to installing new repositories, this method is called when updating an installed repository
# to a new changeset_revision where the update includes newly defined repository dependencies.
updating = util.asbool(kwd.get('updating', False))
updating_repository_id = kwd.get('updating_repository_id', None)
updating_to_changeset_revision = kwd.get('updating_to_changeset_revision', None)
updating_to_ctx_rev = kwd.get('updating_to_ctx_rev', None)
encoded_updated_metadata = kwd.get('encoded_updated_metadata', None)
encoded_repo_info_dicts = kwd.get('encoded_repo_info_dicts', '')
if encoded_repo_info_dicts:
encoded_repo_info_dicts = encoded_repo_info_dicts.split(encoding_util.encoding_sep)
if not encoded_repo_info_dicts:
# The request originated in the tool shed via a tool search or from this controller's
# update_to_changeset_revision() method.
repository_ids = kwd.get('repository_ids', None)
if updating:
# We have updated an installed repository where the updates included newly defined repository
# and possibly tool dependencies. We will have arrived here only if the updates include newly
# defined repository dependencies. We're preparing to allow the user to elect to install these
# dependencies. At this point, the repository has been updated to the latest changeset revision,
# but the received repository id is from the Galaxy side (the caller is this controller's
# update_to_changeset_revision() method. We need to get the id of the same repository from the
# Tool Shed side.
repository = repository_util.get_tool_shed_repository_by_id(trans.app, updating_repository_id)
# For backward compatibility to the 12/20/12 Galaxy release.
try:
params = dict(name=str(repository.name), owner=str(repository.owner))
pathspec = ['repository', 'get_repository_id']
repository_ids = util.url_get(tool_shed_url, password_mgr=self.app.tool_shed_registry.url_auth(tool_shed_url), pathspec=pathspec, params=params)
except Exception as e:
# The Tool Shed cannot handle the get_repository_id request, so the code must be older than the
# 04/2014 Galaxy release when it was introduced. It will be safest to error out and let the
# Tool Shed admin update the Tool Shed to a later release.
message = 'The updates available for the repository <b>%s</b> ' % escape(str(repository.name))
message += 'include newly defined repository or tool dependency definitions, and attempting '
message += 'to update the repository resulted in the following error. Contact the Tool Shed '
message += 'administrator if necessary.<br/>%s' % unicodify(e)
return trans.show_error_message(message)
changeset_revisions = updating_to_changeset_revision
else:
changeset_revisions = kwd.get('changeset_revisions', None)
# Get the information necessary to install each repository.
params = dict(repository_ids=str(repository_ids), changeset_revisions=str(changeset_revisions))
pathspec = ['repository', 'get_repository_information']
raw_text = util.url_get(tool_shed_url, password_mgr=self.app.tool_shed_registry.url_auth(tool_shed_url), pathspec=pathspec, params=params)
repo_information_dict = json.loads(raw_text)
for encoded_repo_info_dict in repo_information_dict.get('repo_info_dicts', []):
decoded_repo_info_dict = encoding_util.tool_shed_decode(encoded_repo_info_dict)
if not includes_tools:
includes_tools = util.string_as_bool(decoded_repo_info_dict.get('includes_tools', False))
if not includes_tools_for_display_in_tool_panel:
includes_tools_for_display_in_tool_panel = \
util.string_as_bool(decoded_repo_info_dict.get('includes_tools_for_display_in_tool_panel', False))
if not has_repository_dependencies:
has_repository_dependencies = util.string_as_bool(repo_information_dict.get('has_repository_dependencies', False))
if not includes_tool_dependencies:
includes_tool_dependencies = util.string_as_bool(repo_information_dict.get('includes_tool_dependencies', False))
encoded_repo_info_dicts = util.listify(repo_information_dict.get('repo_info_dicts', []))
repo_info_dicts = [encoding_util.tool_shed_decode(encoded_repo_info_dict) for encoded_repo_info_dict in encoded_repo_info_dicts]
dd = dependency_display.DependencyDisplayer(trans.app)
install_repository_manager = install_manager.InstallRepositoryManager(trans.app)
if kwd.get('select_tool_panel_section_button', False):
if updating:
repository = repository_util.get_tool_shed_repository_by_id(trans.app, updating_repository_id)
decoded_updated_metadata = encoding_util.tool_shed_decode(encoded_updated_metadata)
# Now that the user has decided whether they will handle dependencies, we can update
# the repository to the latest revision.
repository = trans.app.update_repository_manager.update_repository_record(repository=repository,
updated_metadata_dict=decoded_updated_metadata,
updated_changeset_revision=updating_to_changeset_revision,
updated_ctx_rev=updating_to_ctx_rev)
install_repository_dependencies = CheckboxField.is_checked(install_repository_dependencies)
if includes_tool_dependencies:
install_tool_dependencies = CheckboxField.is_checked(install_tool_dependencies)
else:
install_tool_dependencies = False
install_resolver_dependencies = CheckboxField.is_checked(install_resolver_dependencies)
tool_path = suc.get_tool_path_by_shed_tool_conf_filename(trans.app, shed_tool_conf)
installation_dict = dict(install_repository_dependencies=install_repository_dependencies,
new_tool_panel_section_label=new_tool_panel_section_label,
no_changes_checked=False,
repo_info_dicts=repo_info_dicts,
tool_panel_section_id=tool_panel_section_id,
tool_path=tool_path,
tool_shed_url=tool_shed_url)
created_or_updated_tool_shed_repositories, tool_panel_section_keys, repo_info_dicts, filtered_repo_info_dicts = \
install_repository_manager.handle_tool_shed_repositories(installation_dict)
if created_or_updated_tool_shed_repositories:
installation_dict = dict(created_or_updated_tool_shed_repositories=created_or_updated_tool_shed_repositories,
filtered_repo_info_dicts=filtered_repo_info_dicts,
has_repository_dependencies=has_repository_dependencies,
includes_tool_dependencies=includes_tool_dependencies,
includes_tools=includes_tools,
includes_tools_for_display_in_tool_panel=includes_tools_for_display_in_tool_panel,
install_repository_dependencies=install_repository_dependencies,
install_resolver_dependencies=install_resolver_dependencies,
install_tool_dependencies=install_tool_dependencies,
message=message,
new_tool_panel_section_label=new_tool_panel_section_label,
shed_tool_conf=shed_tool_conf,
status=status,
tool_panel_section_id=tool_panel_section_id,
tool_panel_section_keys=tool_panel_section_keys,
tool_path=tool_path,
tool_shed_url=tool_shed_url)
encoded_kwd, query, tool_shed_repositories, encoded_repository_ids = \
install_repository_manager.initiate_repository_installation(installation_dict)
return trans.fill_template('admin/tool_shed_repository/monitor_repository_installation.mako',
encoded_kwd=encoded_kwd,
query=query,
tool_shed_repositories=tool_shed_repositories,
initiate_repository_installation_ids=encoded_repository_ids,
reinstalling=False)
else:
kwd['message'] = message if message else 'Repository has already been installed.'
kwd['status'] = status
return trans.response.send_redirect(web.url_for(controller='admin_toolshed',
action='monitor_repository_installation',
**kwd))
shed_tool_conf_select_field = tool_util.build_shed_tool_conf_select_field(trans.app)
tool_path = suc.get_tool_path_by_shed_tool_conf_filename(trans.app, shed_tool_conf)
tool_panel_section_select_field = tool_util.build_tool_panel_section_select_field(trans.app)
tool_requirements = suc.get_tool_shed_repo_requirements(app=trans.app,
tool_shed_url=tool_shed_url,
repo_info_dicts=repo_info_dicts)
view = views.DependencyResolversView(self.app)
requirements_status = view.get_requirements_status(tool_requirements)
if len(repo_info_dicts) == 1:
# If we're installing or updating a single repository, see if it contains a readme or
# dependencies that we can display.
repo_info_dict = repo_info_dicts[0]
dependencies_for_repository_dict = \
trans.app.installed_repository_manager.get_dependencies_for_repository(tool_shed_url,
repo_info_dict,
includes_tool_dependencies,
updating=updating)
if not has_repository_dependencies:
has_repository_dependencies = dependencies_for_repository_dict.get('has_repository_dependencies', False)
if not includes_tool_dependencies:
includes_tool_dependencies = dependencies_for_repository_dict.get('includes_tool_dependencies', False)
if not includes_tools:
includes_tools = dependencies_for_repository_dict.get('includes_tools', False)
if not includes_tools_for_display_in_tool_panel:
includes_tools_for_display_in_tool_panel = \
dependencies_for_repository_dict.get('includes_tools_for_display_in_tool_panel', False)
installed_repository_dependencies = dependencies_for_repository_dict.get('installed_repository_dependencies', None)
installed_tool_dependencies = dependencies_for_repository_dict.get('installed_tool_dependencies', None)
missing_repository_dependencies = dependencies_for_repository_dict.get('missing_repository_dependencies', None)
missing_tool_dependencies = dependencies_for_repository_dict.get('missing_tool_dependencies', None)
readme_files_dict = readme_util.get_readme_files_dict_for_display(trans.app, tool_shed_url, repo_info_dict)
# We're handling 1 of 3 scenarios here: (1) we're installing a tool shed repository for the first time, so we've
# retrieved the list of installed and missing repository dependencies from the database (2) we're handling the
# scenario where an error occurred during the installation process, so we have a tool_shed_repository record in
# the database with associated repository dependency records. Since we have the repository dependencies in both
# of the above 2 cases, we'll merge the list of missing repository dependencies into the list of installed
# repository dependencies since each displayed repository dependency will display a status, whether installed or
# missing. The 3rd scenario is where we're updating an installed repository and the updates include newly
# defined repository (and possibly tool) dependencies. In this case, merging will result in newly defined
# dependencies to be lost. We pass the updating parameter to make sure merging occurs only when appropriate.
containers_dict = \
dd.populate_containers_dict_for_new_install(tool_shed_url=tool_shed_url,
tool_path=tool_path,
readme_files_dict=readme_files_dict,
installed_repository_dependencies=installed_repository_dependencies,
missing_repository_dependencies=missing_repository_dependencies,
installed_tool_dependencies=installed_tool_dependencies,
missing_tool_dependencies=missing_tool_dependencies,
updating=updating)
else:
# We're installing a list of repositories, each of which may have tool dependencies or repository dependencies.
containers_dicts = []
for repo_info_dict in repo_info_dicts:
dependencies_for_repository_dict = \
trans.app.installed_repository_manager.get_dependencies_for_repository(tool_shed_url,
repo_info_dict,
includes_tool_dependencies,
updating=updating)
if not has_repository_dependencies:
has_repository_dependencies = dependencies_for_repository_dict.get('has_repository_dependencies', False)
if not includes_tool_dependencies:
includes_tool_dependencies = dependencies_for_repository_dict.get('includes_tool_dependencies', False)
if not includes_tools:
includes_tools = dependencies_for_repository_dict.get('includes_tools', False)
if not includes_tools_for_display_in_tool_panel:
includes_tools_for_display_in_tool_panel = \
dependencies_for_repository_dict.get('includes_tools_for_display_in_tool_panel', False)
installed_repository_dependencies = dependencies_for_repository_dict.get('installed_repository_dependencies', None)
installed_tool_dependencies = dependencies_for_repository_dict.get('installed_tool_dependencies', None)
missing_repository_dependencies = dependencies_for_repository_dict.get('missing_repository_dependencies', None)
missing_tool_dependencies = dependencies_for_repository_dict.get('missing_tool_dependencies', None)
containers_dict = dd.populate_containers_dict_for_new_install(
tool_shed_url=tool_shed_url,
tool_path=tool_path,
readme_files_dict=None,
installed_repository_dependencies=installed_repository_dependencies,
missing_repository_dependencies=missing_repository_dependencies,
installed_tool_dependencies=installed_tool_dependencies,
missing_tool_dependencies=missing_tool_dependencies,
updating=updating
)
containers_dicts.append(containers_dict)
# Merge all containers into a single container.
containers_dict = dd.merge_containers_dicts_for_new_install(containers_dicts)
# Handle tool dependencies check box.
if not trans.app.toolbox.dependency_manager.uses_tool_shed_dependencies:
if includes_tool_dependencies:
message = "Tool dependencies defined in this repository can be automatically installed if you set "
message += "the value of your <b>tool_dependency_dir</b> setting in your Galaxy config file "
message += "(galaxy.yml) and restart your Galaxy server before installing the repository."
status = "warning"
install_tool_dependencies_check_box_checked = False
else:
install_tool_dependencies_check_box_checked = True
install_tool_dependencies_check_box = CheckboxField('install_tool_dependencies',
value=install_tool_dependencies_check_box_checked)
# Handle repository dependencies check box.
install_repository_dependencies_check_box = CheckboxField('install_repository_dependencies', value=True)
view = views.DependencyResolversView(self.app)
if view.installable_resolvers:
install_resolver_dependencies_check_box = CheckboxField('install_resolver_dependencies', value=True)
else:
install_resolver_dependencies_check_box = None
encoded_repo_info_dicts = encoding_util.encoding_sep.join(encoded_repo_info_dicts)
tool_shed_url = kwd['tool_shed_url']
return trans.fill_template('/admin/tool_shed_repository/select_tool_panel_section.mako',
encoded_repo_info_dicts=encoded_repo_info_dicts,
updating=updating,
updating_repository_id=updating_repository_id,
updating_to_ctx_rev=updating_to_ctx_rev,
updating_to_changeset_revision=updating_to_changeset_revision,
encoded_updated_metadata=encoded_updated_metadata,
includes_tools=includes_tools,
includes_tools_for_display_in_tool_panel=includes_tools_for_display_in_tool_panel,
includes_tool_dependencies=includes_tool_dependencies,
install_tool_dependencies_check_box=install_tool_dependencies_check_box,
install_resolver_dependencies_check_box=install_resolver_dependencies_check_box,
has_repository_dependencies=has_repository_dependencies,
install_repository_dependencies_check_box=install_repository_dependencies_check_box,
new_tool_panel_section_label=new_tool_panel_section_label,
containers_dict=containers_dict,
shed_tool_conf=shed_tool_conf,
shed_tool_conf_select_field=shed_tool_conf_select_field,
tool_panel_section_select_field=tool_panel_section_select_field,
tool_shed_url=tool_shed_url,
requirements_status=requirements_status,
message=message,
status=status)
@web.expose
@web.require_admin
def reinstall_repository(self, trans, **kwd):
"""
Reinstall a tool shed repository that has been previously uninstalled, making sure to handle all repository
and tool dependencies of the repository.
"""
rdim = repository_dependency_manager.RepositoryDependencyInstallManager(trans.app)
message = escape(kwd.get('message', ''))
status = kwd.get('status', 'done')
repository_id = kwd['id']
tool_shed_repository = repository_util.get_installed_tool_shed_repository(trans.app, repository_id)
no_changes = kwd.get('no_changes', '')
no_changes_checked = CheckboxField.is_checked(no_changes)
install_repository_dependencies = CheckboxField.is_checked(kwd.get('install_repository_dependencies', ''))
install_tool_dependencies = CheckboxField.is_checked(kwd.get('install_tool_dependencies', ''))
install_resolver_dependencies = CheckboxField.is_checked(kwd.get('install_resolver_dependencies', ''))
if not suc.have_shed_tool_conf_for_install(trans.app):
raise Exception("No valid shed tool configuration file available, please configure one")
shed_tool_conf, tool_path, relative_install_dir = \
suc.get_tool_panel_config_tool_path_install_dir(trans.app, tool_shed_repository)
repository_clone_url = common_util.generate_clone_url_for_installed_repository(trans.app, tool_shed_repository)
tool_shed_url = common_util.get_tool_shed_url_from_tool_shed_registry(trans.app, tool_shed_repository.tool_shed)
tool_section = None
tool_panel_section_id = kwd.get('tool_panel_section_id', '')
new_tool_panel_section_label = kwd.get('new_tool_panel_section_label', '')
tool_panel_section_key = None
tool_panel_section_keys = []
metadata = tool_shed_repository.metadata
# Keep track of tool dependencies defined for the current repository or those defined for any of
# its repository dependencies.
includes_tool_dependencies = tool_shed_repository.includes_tool_dependencies
if tool_shed_repository.includes_tools_for_display_in_tool_panel:
tpm = tool_panel_manager.ToolPanelManager(trans.app)
# Handle the selected tool panel location for loading tools included in the tool shed repository.
tool_section, tool_panel_section_key = \
tpm.handle_tool_panel_selection(toolbox=trans.app.toolbox,
metadata=metadata,
no_changes_checked=no_changes_checked,
tool_panel_section_id=tool_panel_section_id,
new_tool_panel_section_label=new_tool_panel_section_label)
if tool_section is not None:
# Just in case the tool_section.id differs from tool_panel_section_id, which it shouldn't...
tool_panel_section_id = str(tool_section.id)
if tool_shed_repository.status == trans.install_model.ToolShedRepository.installation_status.UNINSTALLED:
repository_type = suc.get_repository_type_from_tool_shed(trans.app,
tool_shed_url,
tool_shed_repository.name,
tool_shed_repository.owner)
if repository_type == rt_util.TOOL_DEPENDENCY_DEFINITION:
# Repositories of type tool_dependency_definition must get the latest
# metadata from the Tool Shed since they have only a single installable
# revision.
raw_text = suc.get_tool_dependency_definition_metadata_from_tool_shed(trans.app,
tool_shed_url,
tool_shed_repository.name,
tool_shed_repository.owner)
new_meta = json.loads(raw_text)
# Clean up old repository dependency and tool dependency relationships.
suc.clean_dependency_relationships(trans, new_meta, tool_shed_repository, tool_shed_url)
# The repository's status must be updated from 'Uninstalled' to 'New' when initiating reinstall
# so the repository_installation_updater will function.
tool_shed_repository = repository_util.create_or_update_tool_shed_repository(app=trans.app,
name=tool_shed_repository.name,
description=tool_shed_repository.description,
installed_changeset_revision=tool_shed_repository.installed_changeset_revision,
ctx_rev=tool_shed_repository.ctx_rev,
repository_clone_url=repository_clone_url,
status=trans.install_model.ToolShedRepository.installation_status.NEW,
metadata_dict=metadata,
current_changeset_revision=tool_shed_repository.changeset_revision,
owner=tool_shed_repository.owner,
dist_to_shed=tool_shed_repository.dist_to_shed)
ctx_rev = suc.get_ctx_rev(trans.app,
tool_shed_url,
tool_shed_repository.name,
tool_shed_repository.owner,
tool_shed_repository.installed_changeset_revision)
repo_info_dicts = []
repo_info_dict = kwd.get('repo_info_dict', None)
if repo_info_dict:
if isinstance(repo_info_dict, string_types):
repo_info_dict = encoding_util.tool_shed_decode(repo_info_dict)
else:
# Entering this else block occurs only if the tool_shed_repository does not include any valid tools.
if install_repository_dependencies:
repository_dependencies = \
rdim.get_repository_dependencies_for_installed_tool_shed_repository(trans.app,
tool_shed_repository)
else:
repository_dependencies = None
if metadata:
tool_dependencies = metadata.get('tool_dependencies', None)
else:
tool_dependencies = None
repo_info_dict = repository_util.create_repo_info_dict(trans.app,
repository_clone_url=repository_clone_url,
changeset_revision=tool_shed_repository.changeset_revision,
ctx_rev=ctx_rev,
repository_owner=tool_shed_repository.owner,
repository_name=tool_shed_repository.name,
tool_dependencies=tool_dependencies,
repository_dependencies=repository_dependencies)
if repo_info_dict not in repo_info_dicts:
repo_info_dicts.append(repo_info_dict)
# Make sure all tool_shed_repository records exist.
created_or_updated_tool_shed_repositories, tool_panel_section_keys, repo_info_dicts, filtered_repo_info_dicts = \
rdim.create_repository_dependency_objects(tool_path=tool_path,
tool_shed_url=tool_shed_url,
repo_info_dicts=repo_info_dicts,
install_repository_dependencies=install_repository_dependencies,
no_changes_checked=no_changes_checked,
tool_panel_section_id=tool_panel_section_id)
# Default the selected tool panel location for loading tools included in each newly installed required
# tool shed repository to the location selected for the repository selected for re-installation.
for index, tps_key in enumerate(tool_panel_section_keys):
if tps_key is None:
tool_panel_section_keys[index] = tool_panel_section_key
encoded_repository_ids = [trans.security.encode_id(r.id) for r in created_or_updated_tool_shed_repositories]
new_kwd = dict(includes_tool_dependencies=includes_tool_dependencies,
includes_tools=tool_shed_repository.includes_tools,
includes_tools_for_display_in_tool_panel=tool_shed_repository.includes_tools_for_display_in_tool_panel,
install_tool_dependencies=install_tool_dependencies,
install_resolver_dependencies=install_resolver_dependencies,
repo_info_dicts=filtered_repo_info_dicts,
message=message,
new_tool_panel_section_label=new_tool_panel_section_label,
shed_tool_conf=shed_tool_conf,
status=status,
tool_panel_section_id=tool_panel_section_id,
tool_path=tool_path,
tool_panel_section_keys=tool_panel_section_keys,
tool_shed_repository_ids=encoded_repository_ids,
tool_shed_url=tool_shed_url)
encoded_kwd = encoding_util.tool_shed_encode(new_kwd)
tsr_ids = [r.id for r in created_or_updated_tool_shed_repositories]
tool_shed_repositories = []
for tsr_id in tsr_ids:
tsr = trans.install_model.context.query(trans.install_model.ToolShedRepository).get(tsr_id)
tool_shed_repositories.append(tsr)
clause_list = []
for tsr_id in tsr_ids:
clause_list.append(trans.install_model.ToolShedRepository.table.c.id == tsr_id)
query = trans.install_model.context.current.query(trans.install_model.ToolShedRepository) \
.filter(or_(*clause_list))
return trans.fill_template('admin/tool_shed_repository/monitor_repository_installation.mako',
encoded_kwd=encoded_kwd,
query=query,
tool_shed_repositories=tool_shed_repositories,
initiate_repository_installation_ids=encoded_repository_ids,
reinstalling=True)
@web.json
def repository_installation_status_updates(self, trans, ids=None, status_list=None):
# Avoid caching
trans.response.headers['Pragma'] = 'no-cache'
trans.response.headers['Expires'] = '0'
# Create new HTML for any ToolShedRepository records whose status that has changed.
rval = []
if ids is not None and status_list is not None:
ids = util.listify(ids)
status_list = util.listify(status_list)
for tup in zip(ids, status_list):
id, status = tup
repository = trans.install_model.context.query(trans.install_model.ToolShedRepository).get(trans.security.decode_id(id))
if repository.status != status:
rval.append(dict(id=id,
status=repository.status,
html_status=unicodify(trans.fill_template("admin/tool_shed_repository/repository_installation_status.mako",
repository=repository),
'utf-8')))
return rval
@web.expose
@web.require_admin
def reselect_tool_panel_section(self, trans, **kwd):
"""
Select or change the tool panel section to contain the tools included in the tool shed repository
being reinstalled. If there are updates available for the repository in the tool shed, the
tool_dependencies and repository_dependencies associated with the updated changeset revision will
have been retrieved from the tool shed and passed in the received kwd. In this case, the stored
tool shed repository metadata from the Galaxy database will not be used since it is outdated.
"""
message = ''
status = 'done'
repository_id = kwd.get('id', None)
latest_changeset_revision = kwd.get('latest_changeset_revision', None)
latest_ctx_rev = kwd.get('latest_ctx_rev', None)