def get_ordered_installable_revisions(self, trans, name=None, owner=None, **kwd):
"""
GET /api/repositories/get_ordered_installable_revisions
:param name: the name of the Repository
:param owner: the owner of the Repository
Returns the ordered list of changeset revision hash strings that are associated with installable revisions.
As in the changelog, the list is ordered oldest to newest.
"""
# Example URL: http://localhost:9009/api/repositories/get_ordered_installable_revisions?name=add_column&owner=test
if name is None:
name = kwd.get("name", None)
if owner is None:
owner = kwd.get("owner", None)
tsr_id = kwd.get("tsr_id", None)
if None not in [name, owner]:
# Get the repository information.
repository = repository_util.get_repository_by_name_and_owner(self.app, name, owner)
if repository is None:
trans.response.status = 404
return {"status": "error", "message": "No repository named %s found with owner %s" % (name, owner)}
elif tsr_id is not None:
repository = repository_util.get_repository_in_tool_shed(self.app, tsr_id)
else:
error_message = "Error in the Tool Shed repositories API in get_ordered_installable_revisions: "
error_message += "invalid parameters received."
log.debug(error_message)
return []
return [revision[1] for revision in repository.installable_revisions(self.app, sort_revisions=True)]
def handle_request(self, trans, **kwd):
# The os command that results in this method being called will look something like:
# hg clone http://[email protected]:9009/repos/test/convert_characters1
hgweb_config = trans.app.hgweb_config_manager.hgweb_config
def make_web_app():
hgwebapp = hgwebdir(hgweb_config.encode('utf-8'))
return hgwebapp
wsgi_app = wsgiapplication(make_web_app)
repository = None
path_info = kwd.get('path_info', None)
if path_info and len(path_info.split('/')) == 2:
owner, name = path_info.split('/')
repository = get_repository_by_name_and_owner(
trans.app, name, owner)
if repository:
if repository.deprecated:
raise ObjectNotFound(
"Requested repository not found or deprecated.")
cmd = kwd.get('cmd', None)
if cmd == 'getbundle':
times_downloaded = repository.times_downloaded
times_downloaded += 1
repository.times_downloaded = times_downloaded
trans.sa_session.add(repository)
trans.sa_session.flush()
return wsgi_app
def handle_request(self, trans, **kwd):
# The os command that results in this method being called will look something like:
# hg clone http://[email protected]:9009/repos/test/convert_characters1
hg_version = mercurial.__version__.version
cmd = kwd.get("cmd", None)
hgweb_config = trans.app.hgweb_config_manager.hgweb_config
def make_web_app():
hgwebapp = hgwebdir(hgweb_config)
return hgwebapp
wsgi_app = wsgiapplication(make_web_app)
if hg_version >= "2.2.3" and cmd == "pushkey":
# When doing an "hg push" from the command line, the following commands, in order, will be
# retrieved from environ, depending upon the mercurial version being used. In mercurial
# version 2.2.3, section 15.2. Command changes includes a new feature:
# pushkey: add hooks for pushkey/listkeys
# (see http://mercurial.selenic.com/wiki/WhatsNew#Mercurial_2.2.3_.282012-07-01.29).
# We require version 2.2.3 since the pushkey hook was added in that version.
# If mercurial version >= '2.2.3': capabilities -> batch -> branchmap -> unbundle -> listkeys -> pushkey
path_info = kwd.get("path_info", None)
if path_info:
owner, name = path_info.split("/")
repository = get_repository_by_name_and_owner(trans.app, name, owner)
if repository:
if hg_version >= "2.2.3":
# Update the repository on disk to the tip revision, because the web upload
# form uses the on-disk working directory. If the repository is not updated
# on disk, pushing from the command line and then uploading via the web
# interface will result in a new head being created.
repo = hg.repository(ui.ui(), repository.repo_path(trans.app))
update_repository(repo, ctx_rev=None)
repository_clone_url = generate_clone_url_for_repository_in_tool_shed(trans.user, repository)
# Set metadata using the repository files on disk.
rmm = repository_metadata_manager.RepositoryMetadataManager(
app=trans.app,
user=trans.user,
repository=repository,
changeset_revision=repository.tip(trans.app),
repository_clone_url=repository_clone_url,
relative_install_dir=repository.repo_path(trans.app),
repository_files_dir=None,
resetting_all_metadata_on_repository=False,
updating_installed_repository=False,
persist=False,
)
error_message, status = rmm.set_repository_metadata(trans.request.host)
if status == "ok" and error_message:
log.debug(
"Successfully reset metadata on repository %s owned by %s, but encountered problem: %s"
% (str(repository.name), str(repository.user.username), error_message)
)
elif status != "ok" and error_message:
log.debug(
"Error resetting metadata on repository %s owned by %s: %s"
% (str(repository.name), str(repository.user.username), error_message)
)
return wsgi_app
def handle_request( self, trans, **kwd ):
# The os command that results in this method being called will look something like:
# hg clone http://[email protected]:9009/repos/test/convert_characters1
hg_version = mercurial.__version__.version
cmd = kwd.get( 'cmd', None )
hgweb_config = trans.app.hgweb_config_manager.hgweb_config
def make_web_app():
hgwebapp = hgwebdir( hgweb_config )
return hgwebapp
wsgi_app = wsgiapplication( make_web_app )
if hg_version >= '2.2.3' and cmd == 'pushkey':
# When doing an "hg push" from the command line, the following commands, in order, will be
# retrieved from environ, depending upon the mercurial version being used. In mercurial
# version 2.2.3, section 15.2. Command changes includes a new feature:
# pushkey: add hooks for pushkey/listkeys
# (see http://mercurial.selenic.com/wiki/WhatsNew#Mercurial_2.2.3_.282012-07-01.29).
# We require version 2.2.3 since the pushkey hook was added in that version.
# If mercurial version >= '2.2.3': capabilities -> batch -> branchmap -> unbundle -> listkeys -> pushkey
path_info = kwd.get( 'path_info', None )
if path_info:
owner, name = path_info.split( '/' )
repository = get_repository_by_name_and_owner( trans.app, name, owner )
if repository:
if hg_version >= '2.2.3':
# Update the repository on disk to the tip revision, because the web upload
# form uses the on-disk working directory. If the repository is not updated
# on disk, pushing from the command line and then uploading via the web
# interface will result in a new head being created.
repo = hg.repository( ui.ui(), repository.repo_path( trans.app ) )
update_repository( repo, ctx_rev=None )
repository_clone_url = generate_clone_url_for_repository_in_tool_shed( trans.user, repository )
# Set metadata using the repository files on disk.
rmm = repository_metadata_manager.RepositoryMetadataManager( app=trans.app,
user=trans.user,
repository=repository,
changeset_revision=repository.tip( trans.app ),
repository_clone_url=repository_clone_url,
relative_install_dir=repository.repo_path( trans.app ),
repository_files_dir=None,
resetting_all_metadata_on_repository=False,
updating_installed_repository=False,
persist=False )
error_message, status = rmm.set_repository_metadata( trans.request.host )
if status == 'ok' and error_message:
log.debug( "Successfully reset metadata on repository %s owned by %s, but encountered problem: %s" %
( str( repository.name ), str( repository.user.username ), error_message ) )
elif status != 'ok' and error_message:
log.debug( "Error resetting metadata on repository %s owned by %s: %s" %
( str( repository.name ), str( repository.user.username ), error_message ) )
return wsgi_app
def export(self, trans, payload, **kwd):
"""
POST /api/repository_revisions/export
Creates and saves a gzip compressed tar archive of a repository and optionally all of its repository dependencies.
The following parameters are included in the payload.
:param tool_shed_url (required): the base URL of the Tool Shed from which the Repository is to be exported
:param name (required): the name of the Repository
:param owner (required): the owner of the Repository
:param changeset_revision (required): the changeset_revision of the RepositoryMetadata object associated with the Repository
:param export_repository_dependencies (optional): whether to export repository dependencies - defaults to False
:param download_dir (optional): the local directory to which to download the archive - defaults to /tmp
"""
tool_shed_url = payload.get('tool_shed_url', '')
if not tool_shed_url:
raise HTTPBadRequest(
detail="Missing required parameter 'tool_shed_url'.")
tool_shed_url = tool_shed_url.rstrip('/')
name = payload.get('name', '')
if not name:
raise HTTPBadRequest(detail="Missing required parameter 'name'.")
owner = payload.get('owner', '')
if not owner:
raise HTTPBadRequest(detail="Missing required parameter 'owner'.")
changeset_revision = payload.get('changeset_revision', '')
if not changeset_revision:
raise HTTPBadRequest(
detail="Missing required parameter 'changeset_revision'.")
export_repository_dependencies = payload.get(
'export_repository_dependencies', False)
# We'll currently support only gzip-compressed tar archives.
export_repository_dependencies = util.asbool(
export_repository_dependencies)
# Get the repository information.
repository = repository_util.get_repository_by_name_and_owner(
trans.app, name, owner)
if repository is None:
error_message = 'Cannot locate repository with name %s and owner %s,' % (
str(name), str(owner))
log.debug(error_message)
return None, error_message
erm = capsule_manager.ExportRepositoryManager(
app=trans.app,
user=trans.user,
tool_shed_url=tool_shed_url,
repository=repository,
changeset_revision=changeset_revision,
export_repository_dependencies=export_repository_dependencies,
using_api=True)
return erm.export_repository()
def remove_repository_registry_entry(self, trans, payload, **kwd):
"""
POST /api/repositories/remove_repository_registry_entry
Removes appropriate entries from the repository registry for the repository defined by the received name and owner.
:param key: the user's API key
The following parameters are included in the payload.
:param tool_shed_url (required): the base URL of the Tool Shed containing the Repository
:param name (required): the name of the Repository
:param owner (required): the owner of the Repository
"""
response_dict = {}
if not trans.user_is_admin():
response_dict["status"] = "error"
response_dict[
"message"
] = "You are not authorized to remove entries from this Tool Shed's repository registry."
return response_dict
tool_shed_url = payload.get("tool_shed_url", "")
if not tool_shed_url:
raise HTTPBadRequest(detail="Missing required parameter 'tool_shed_url'.")
tool_shed_url = tool_shed_url.rstrip("/")
name = payload.get("name", "")
if not name:
raise HTTPBadRequest(detail="Missing required parameter 'name'.")
owner = payload.get("owner", "")
if not owner:
raise HTTPBadRequest(detail="Missing required parameter 'owner'.")
repository = repository_util.get_repository_by_name_and_owner(self.app, name, owner)
if repository is None:
error_message = "Cannot locate repository with name %s and owner %s," % (str(name), str(owner))
log.debug(error_message)
response_dict["status"] = "error"
response_dict["message"] = error_message
return response_dict
# Update the repository registry.
self.app.repository_registry.remove_entry(repository)
response_dict["status"] = "ok"
response_dict["message"] = (
"Entries for repository %s owned by %s have been removed from the Tool Shed repository registry."
% (name, owner)
)
return response_dict
def export(self, trans, payload, **kwd):
"""
POST /api/repository_revisions/export
Creates and saves a gzip compressed tar archive of a repository and optionally all of its repository dependencies.
The following parameters are included in the payload.
:param tool_shed_url (required): the base URL of the Tool Shed from which the Repository is to be exported
:param name (required): the name of the Repository
:param owner (required): the owner of the Repository
:param changeset_revision (required): the changeset_revision of the RepositoryMetadata object associated with the Repository
:param export_repository_dependencies (optional): whether to export repository dependencies - defaults to False
:param download_dir (optional): the local directory to which to download the archive - defaults to /tmp
"""
tool_shed_url = payload.get('tool_shed_url', '')
if not tool_shed_url:
raise HTTPBadRequest(detail="Missing required parameter 'tool_shed_url'.")
tool_shed_url = tool_shed_url.rstrip('/')
name = payload.get('name', '')
if not name:
raise HTTPBadRequest(detail="Missing required parameter 'name'.")
owner = payload.get('owner', '')
if not owner:
raise HTTPBadRequest(detail="Missing required parameter 'owner'.")
changeset_revision = payload.get('changeset_revision', '')
if not changeset_revision:
raise HTTPBadRequest(detail="Missing required parameter 'changeset_revision'.")
export_repository_dependencies = payload.get('export_repository_dependencies', False)
# We'll currently support only gzip-compressed tar archives.
export_repository_dependencies = util.asbool(export_repository_dependencies)
# Get the repository information.
repository = repository_util.get_repository_by_name_and_owner(trans.app, name, owner)
if repository is None:
error_message = 'Cannot locate repository with name %s and owner %s,' % (str(name), str(owner))
log.debug(error_message)
return None, error_message
erm = capsule_manager.ExportRepositoryManager(app=trans.app,
user=trans.user,
tool_shed_url=tool_shed_url,
repository=repository,
changeset_revision=changeset_revision,
export_repository_dependencies=export_repository_dependencies,
using_api=True)
return erm.export_repository()
def handle_request(self, trans, **kwd):
# The os command that results in this method being called will look something like:
# hg clone http://[email protected]:9009/repos/test/convert_characters1
hgweb_config = trans.app.hgweb_config_manager.hgweb_config
cmd = kwd.get('cmd', None)
def make_web_app():
hgwebapp = hgwebdir(hgweb_config)
return hgwebapp
wsgi_app = wsgiapplication(make_web_app)
if cmd == 'getbundle':
path_info = kwd.get('path_info', None)
if path_info:
owner, name = path_info.split('/')
repository = get_repository_by_name_and_owner(trans.app, name, owner)
if repository:
times_downloaded = repository.times_downloaded
times_downloaded += 1
repository.times_downloaded = times_downloaded
trans.sa_session.add(repository)
trans.sa_session.flush()
return wsgi_app
def handle_request(self, trans, **kwd):
# The os command that results in this method being called will look something like:
# hg clone http://[email protected]:9009/repos/test/convert_characters1
hgweb_config = trans.app.hgweb_config_manager.hgweb_config
cmd = kwd.get('cmd', None)
def make_web_app():
hgwebapp = hgwebdir(hgweb_config)
return hgwebapp
wsgi_app = wsgiapplication(make_web_app)
if cmd == 'getbundle':
path_info = kwd.get('path_info', None)
if path_info:
owner, name = path_info.split('/')
repository = get_repository_by_name_and_owner(
trans.app, name, owner)
if repository:
times_downloaded = repository.times_downloaded
times_downloaded += 1
repository.times_downloaded = times_downloaded
trans.sa_session.add(repository)
trans.sa_session.flush()
return wsgi_app
def handle_elem(self, elem):
"""Populate or unpopulate the changeset_revision and toolshed attributes of repository tags."""
# <repository name="molecule_datatypes" owner="test" changeset_revision="1a070566e9c6" />
# <repository changeset_revision="xxx" name="package_xorg_macros_1_17_1" owner="test" toolshed="yyy">
# <package name="xorg_macros" version="1.17.1" />
# </repository>
error_message = ''
name = elem.get('name')
owner = elem.get('owner')
# The name and owner attributes are always required, so if either are missing, return the error message.
if not name or not owner:
error_message = self.check_tag_attributes(elem)
return False, elem, error_message
altered = False
toolshed = elem.get('toolshed')
changeset_revision = elem.get('changeset_revision')
# Over a short period of time a bug existed which caused the prior_installation_required attribute
# to be set to False and included in the <repository> tag when a repository was exported along with
# its dependencies. The following will eliminate this problematic attribute upon import.
prior_installation_required = elem.get('prior_installation_required')
if prior_installation_required is not None and not asbool(prior_installation_required):
del elem.attrib['prior_installation_required']
sub_elems = [child_elem for child_elem in list(elem)]
if len(sub_elems) > 0:
# At this point, a <repository> tag will point only to a package.
# <package name="xorg_macros" version="1.17.1" />
# Coerce the list to an odict().
sub_elements = odict()
packages = []
for sub_elem in sub_elems:
sub_elem_type = sub_elem.tag
sub_elem_name = sub_elem.get('name')
sub_elem_version = sub_elem.get('version')
if sub_elem_type and sub_elem_name and sub_elem_version:
packages.append((sub_elem_name, sub_elem_version))
sub_elements['packages'] = packages
else:
# Set to None.
sub_elements = None
if self.unpopulate:
# We're exporting the repository, so eliminate all toolshed and changeset_revision attributes
# from the <repository> tag.
if toolshed or changeset_revision:
attributes = odict()
attributes['name'] = name
attributes['owner'] = owner
prior_installation_required = elem.get('prior_installation_required')
if asbool(prior_installation_required):
attributes['prior_installation_required'] = 'True'
new_elem = xml_util.create_element('repository', attributes=attributes, sub_elements=sub_elements)
altered = True
return altered, new_elem, error_message
# From here on we're populating the toolshed and changeset_revision attributes if necessary.
if not toolshed:
# Default the setting to the current tool shed.
toolshed = str(url_for('/', qualified=True)).rstrip('/')
elem.attrib['toolshed'] = toolshed
altered = True
if not changeset_revision:
# Populate the changeset_revision attribute with the latest installable metadata revision for
# the defined repository. We use the latest installable revision instead of the latest metadata
# revision to ensure that the contents of the revision are valid.
repository = repository_util.get_repository_by_name_and_owner(self.app, name, owner)
if repository:
lastest_installable_changeset_revision = \
metadata_util.get_latest_downloadable_changeset_revision(self.app, repository)
if lastest_installable_changeset_revision != hg_util.INITIAL_CHANGELOG_HASH:
elem.attrib['changeset_revision'] = lastest_installable_changeset_revision
altered = True
else:
error_message = 'Invalid latest installable changeset_revision %s ' % \
str(lastest_installable_changeset_revision)
error_message += 'retrieved for repository %s owned by %s. ' % (str(name), str(owner))
else:
error_message = 'Unable to locate repository with name %s and owner %s. ' % (str(name), str(owner))
return altered, elem, error_message
def repository_dependencies(self, trans, id, **kwd):
"""
GET /api/repository_revisions/{encoded repository_metadata id}/repository_dependencies
Returns a list of dictionaries that each define a specific downloadable revision of a
repository in the Tool Shed. This method returns dictionaries with more information in
them than other methods in this controller. The information about repository_metdata is
enhanced to include information about the repository (e.g., name, owner, etc) associated
with the repository_metadata record.
:param id: the encoded id of the `RepositoryMetadata` object
"""
# Example URL: http://localhost:9009/api/repository_revisions/repository_dependencies/bb125606ff9ea620
repository_dependencies_dicts = []
repository_metadata = metadata_util.get_repository_metadata_by_id(trans.app, id)
if repository_metadata is None:
log.debug('Invalid repository_metadata id received: %s' % str(id))
return repository_dependencies_dicts
metadata = repository_metadata.metadata
if metadata is None:
log.debug('The repository_metadata record with id %s has no metadata.' % str(id))
return repository_dependencies_dicts
if 'repository_dependencies' in metadata:
rd_tups = metadata['repository_dependencies']['repository_dependencies']
for rd_tup in rd_tups:
tool_shed, name, owner, changeset_revision = rd_tup[0:4]
repository_dependency = repository_util.get_repository_by_name_and_owner(trans.app, name, owner)
if repository_dependency is None:
log.dbug('Cannot locate repository dependency %s owned by %s.' % (name, owner))
continue
repository_dependency_id = trans.security.encode_id(repository_dependency.id)
repository_dependency_repository_metadata = \
metadata_util.get_repository_metadata_by_changeset_revision(trans.app, repository_dependency_id, changeset_revision)
if repository_dependency_repository_metadata is None:
# The changeset_revision column in the repository_metadata table has been updated with a new
# value value, so find the changeset_revision to which we need to update.
repo = hg_util.get_repo_for_repository(trans.app,
repository=repository_dependency,
repo_path=None,
create=False)
new_changeset_revision = metadata_util.get_next_downloadable_changeset_revision(repository_dependency,
repo,
changeset_revision)
if new_changeset_revision != changeset_revision:
repository_dependency_repository_metadata = \
metadata_util.get_repository_metadata_by_changeset_revision(trans.app,
repository_dependency_id,
new_changeset_revision)
changeset_revision = new_changeset_revision
else:
decoded_repository_dependency_id = trans.security.decode_id(repository_dependency_id)
debug_msg = 'Cannot locate repository_metadata with id %d for repository dependency %s owned by %s ' % \
(decoded_repository_dependency_id, str(name), str(owner))
debug_msg += 'using either of these changeset_revisions: %s, %s.' % \
(str(changeset_revision), str(new_changeset_revision))
log.debug(debug_msg)
continue
repository_dependency_metadata_dict = \
repository_dependency_repository_metadata.to_dict(view='element',
value_mapper=self.__get_value_mapper(trans))
repository_dependency_dict = repository_dependency.to_dict(view='element',
value_mapper=self.__get_value_mapper(trans))
# We need to be careful with the entries in our repository_dependency_dict here since this Tool Shed API
# controller is working with repository_metadata records. The above to_dict() method returns a dictionary
# with an id entry for the repository record. However, all of the other methods in this controller have
# the id entry associated with a repository_metadata record id. To avoid confusion, we'll update the
# repository_dependency_metadata_dict with entries from the repository_dependency_dict without using the
# Python dictionary update() method because we do not want to overwrite existing entries.
for k, v in repository_dependency_dict.items():
if k not in repository_dependency_metadata_dict:
repository_dependency_metadata_dict[k] = v
repository_dependency_metadata_dict['url'] = web.url_for(controller='repositories',
action='show',
id=repository_dependency_id)
repository_dependencies_dicts.append(repository_dependency_metadata_dict)
return repository_dependencies_dicts
def repository_dependencies(self, trans, id, **kwd):
"""
GET /api/repository_revisions/{encoded repository_metadata id}/repository_dependencies
Returns a list of dictionaries that each define a specific downloadable revision of a
repository in the Tool Shed. This method returns dictionaries with more information in
them than other methods in this controller. The information about repository_metdata is
enhanced to include information about the repository (e.g., name, owner, etc) associated
with the repository_metadata record.
:param id: the encoded id of the `RepositoryMetadata` object
"""
# Example URL: http://localhost:9009/api/repository_revisions/repository_dependencies/bb125606ff9ea620
repository_dependencies_dicts = []
repository_metadata = metadata_util.get_repository_metadata_by_id(
trans.app, id)
if repository_metadata is None:
log.debug('Invalid repository_metadata id received: %s' % str(id))
return repository_dependencies_dicts
metadata = repository_metadata.metadata
if metadata is None:
log.debug(
'The repository_metadata record with id %s has no metadata.' %
str(id))
return repository_dependencies_dicts
if 'repository_dependencies' in metadata:
rd_tups = metadata['repository_dependencies'][
'repository_dependencies']
for rd_tup in rd_tups:
tool_shed, name, owner, changeset_revision = rd_tup[0:4]
repository_dependency = repository_util.get_repository_by_name_and_owner(
trans.app, name, owner)
if repository_dependency is None:
log.dbug(
'Cannot locate repository dependency %s owned by %s.' %
(name, owner))
continue
repository_dependency_id = trans.security.encode_id(
repository_dependency.id)
repository_dependency_repository_metadata = \
metadata_util.get_repository_metadata_by_changeset_revision(trans.app, repository_dependency_id, changeset_revision)
if repository_dependency_repository_metadata is None:
# The changeset_revision column in the repository_metadata table has been updated with a new
# value value, so find the changeset_revision to which we need to update.
new_changeset_revision = metadata_util.get_next_downloadable_changeset_revision(
trans.app, repository_dependency, changeset_revision)
if new_changeset_revision != changeset_revision:
repository_dependency_repository_metadata = \
metadata_util.get_repository_metadata_by_changeset_revision(trans.app,
repository_dependency_id,
new_changeset_revision)
changeset_revision = new_changeset_revision
else:
decoded_repository_dependency_id = trans.security.decode_id(
repository_dependency_id)
debug_msg = 'Cannot locate repository_metadata with id %d for repository dependency %s owned by %s ' % \
(decoded_repository_dependency_id, str(name), str(owner))
debug_msg += 'using either of these changeset_revisions: %s, %s.' % \
(str(changeset_revision), str(new_changeset_revision))
log.debug(debug_msg)
continue
repository_dependency_metadata_dict = \
repository_dependency_repository_metadata.to_dict(view='element',
value_mapper=self.__get_value_mapper(trans))
repository_dependency_dict = repository_dependency.to_dict(
view='element',
value_mapper=self.__get_value_mapper(trans))
# We need to be careful with the entries in our repository_dependency_dict here since this Tool Shed API
# controller is working with repository_metadata records. The above to_dict() method returns a dictionary
# with an id entry for the repository record. However, all of the other methods in this controller have
# the id entry associated with a repository_metadata record id. To avoid confusion, we'll update the
# repository_dependency_metadata_dict with entries from the repository_dependency_dict without using the
# Python dictionary update() method because we do not want to overwrite existing entries.
for k, v in repository_dependency_dict.items():
if k not in repository_dependency_metadata_dict:
repository_dependency_metadata_dict[k] = v
repository_dependency_metadata_dict['url'] = web.url_for(
controller='repositories',
action='show',
id=repository_dependency_id)
repository_dependencies_dicts.append(
repository_dependency_metadata_dict)
return repository_dependencies_dicts
def get_repository_revision_install_info(self, trans, name, owner, changeset_revision, **kwd):
"""
GET /api/repositories/get_repository_revision_install_info
:param name: the name of the Repository
:param owner: the owner of the Repository
:param changeset_revision: the changeset_revision of the RepositoryMetadata object associated with the Repository
Returns a list of the following dictionaries::
- a dictionary defining the Repository. For example:
{
"deleted": false,
"deprecated": false,
"description": "add_column hello",
"id": "f9cad7b01a472135",
"long_description": "add_column hello",
"name": "add_column",
"owner": "test",
"private": false,
"times_downloaded": 6,
"url": "/api/repositories/f9cad7b01a472135",
"user_id": "f9cad7b01a472135"
}
- a dictionary defining the Repository revision (RepositoryMetadata). For example:
{
"changeset_revision": "3a08cc21466f",
"downloadable": true,
"has_repository_dependencies": false,
"has_repository_dependencies_only_if_compiling_contained_td": false,
"id": "f9cad7b01a472135",
"includes_datatypes": false,
"includes_tool_dependencies": false,
"includes_tools": true,
"includes_tools_for_display_in_tool_panel": true,
"includes_workflows": false,
"malicious": false,
"repository_id": "f9cad7b01a472135",
"url": "/api/repository_revisions/f9cad7b01a472135",
"valid_tools": [{u'add_to_tool_panel': True,
u'description': u'data on any column using simple expressions',
u'guid': u'localhost:9009/repos/enis/sample_repo_1/Filter1/2.2.0',
u'id': u'Filter1',
u'name': u'Filter',
u'requirements': [],
u'tests': [{u'inputs': [[u'input', u'1.bed'], [u'cond', u"c1=='chr22'"]],
u'name': u'Test-1',
u'outputs': [[u'out_file1', u'filter1_test1.bed']],
u'required_files': [u'1.bed', u'filter1_test1.bed']}],
u'tool_config': u'database/community_files/000/repo_1/filtering.xml',
u'tool_type': u'default',
u'version': u'2.2.0',
u'version_string_cmd': None}]
}
- a dictionary including the additional information required to install the repository. For example:
{
"add_column": [
"add_column hello",
"http://test@localhost:9009/repos/test/add_column",
"3a08cc21466f",
"1",
"test",
{},
{}
]
}
"""
# Example URL:
# http://<xyz>/api/repositories/get_repository_revision_install_info?name=<n>&owner=<o>&changeset_revision=<cr>
if name and owner and changeset_revision:
# Get the repository information.
repository = repository_util.get_repository_by_name_and_owner(self.app, name, owner)
if repository is None:
log.debug("Cannot locate repository %s owned by %s" % (str(name), str(owner)))
return {}, {}, {}
encoded_repository_id = trans.security.encode_id(repository.id)
repository_dict = repository.to_dict(view="element", value_mapper=self.__get_value_mapper(trans))
repository_dict["url"] = web.url_for(controller="repositories", action="show", id=encoded_repository_id)
# Get the repository_metadata information.
repository_metadata = metadata_util.get_repository_metadata_by_changeset_revision(
self.app, encoded_repository_id, changeset_revision
)
if repository_metadata is None:
# The changeset_revision column in the repository_metadata table has been updated with a new
# value value, so find the changeset_revision to which we need to update.
repo = hg_util.get_repo_for_repository(self.app, repository=repository, repo_path=None, create=False)
new_changeset_revision = metadata_util.get_next_downloadable_changeset_revision(
repository, repo, changeset_revision
)
repository_metadata = metadata_util.get_repository_metadata_by_changeset_revision(
self.app, encoded_repository_id, new_changeset_revision
)
changeset_revision = new_changeset_revision
if repository_metadata is not None:
encoded_repository_metadata_id = trans.security.encode_id(repository_metadata.id)
repository_metadata_dict = repository_metadata.to_dict(
view="collection", value_mapper=self.__get_value_mapper(trans)
)
repository_metadata_dict["url"] = web.url_for(
controller="repository_revisions", action="show", id=encoded_repository_metadata_id
)
if "tools" in repository_metadata.metadata:
repository_metadata_dict["valid_tools"] = repository_metadata.metadata["tools"]
# Get the repo_info_dict for installing the repository.
repo_info_dict, includes_tools, includes_tool_dependencies, includes_tools_for_display_in_tool_panel, has_repository_dependencies, has_repository_dependencies_only_if_compiling_contained_td = repository_util.get_repo_info_dict(
self.app, trans.user, encoded_repository_id, changeset_revision
)
return repository_dict, repository_metadata_dict, repo_info_dict
else:
log.debug(
"Unable to locate repository_metadata record for repository id %s and changeset_revision %s"
% (str(repository.id), str(changeset_revision))
)
return repository_dict, {}, {}
else:
debug_msg = "Error in the Tool Shed repositories API in get_repository_revision_install_info: "
debug_msg += "Invalid name %s or owner %s or changeset_revision %s received." % (
str(name),
str(owner),
str(changeset_revision),
)
log.debug(debug_msg)
return {}, {}, {}
