diff --git a/docs/uri-scheme-browse-origin.rst b/docs/uri-scheme-browse-origin.rst
index 8ba31c4f..158ccc92 100644
--- a/docs/uri-scheme-browse-origin.rst
+++ b/docs/uri-scheme-browse-origin.rst
@@ -1,491 +1,491 @@
Origin
^^^^^^
This describes the URI scheme when one wants to browse the Software Heritage
archive in the context of an origin (for instance, a repository crawled from
GitHub or a Debian source package). All the views pointed by that scheme
offer quick links to browse objects as found during the associated crawls
performed by Software Heritage:
* the root directory of the origin
* the list of branches of the origin
* the list of releases of the origin
Origin metadata
"""""""""""""""
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/
HTML view that displays a SWH origin identified by its type and url.
The view displays the origin metadata and contains links
for browsing its directories and contents for each SWH visit.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/`
:swh_web_browse:`origin/deb/url/deb://Debian-Security/packages/mediawiki/`
:swh_web_browse:`origin/git/url/https://gitorious.org/qt/qtbase.git`
Origin directory
""""""""""""""""
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/directory/[(path)/]
HTML view for browsing the content of a directory reachable from the root directory
- (including itself) associated to the latest visit of a SWH origin.
+ (including itself) associated to the latest full visit of a SWH origin.
The content of the directory is first sorted in lexicographical order
and the sub-directories are displayed before the regular files.
The view enables to navigate from the requested directory to
directories reachable from it in a recursive way but also
up to the origin root directory.
A breadcrumb located in the top part of the view allows
to keep track of the paths navigated so far.
The view also enables to easily switch between the origin branches
and releases through a dropdown menu.
The origin branch (default to master) from which to retrieve the directory
content can also be specified by using the branch query parameter.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string path: optional parameter used to specify the path of a directory
reachable from the origin root one
:query string branch: specify the origin branch name from which
to retrieve the directory
:query string release: specify the origin release name from which
to retrieve the directory
:query string revision: specify the origin revision, identified by the hexadecimal
representation of its *sha1_git* value, from which to retrieve the directory
:query int visit_id: specify a SWH visit id to retrieve the directory from instead
of using the latest visit by default
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
or the provided path does not exist from the origin root directory
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/directory/`
:swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/directory/net/ethernet/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/directory/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/directory/Python/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/directory/?branch=refs/heads/2.7`
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/directory/[(path)/]
HTML view for browsing the content of a directory reachable from
the root directory (including itself) associated to a visitof a SWH
origin closest to a provided timestamp.
The content of the directory is first sorted in lexicographical order
and the sub-directories are displayed before the regular files.
The view enables to navigate from the requested directory to
directories reachable from it in a recursive way but also
up to the origin root directory.
A breadcrumb located in the top part of the view allows
to keep track of the paths navigated so far.
The view also enables to easily switch between the origin branches
and releases through a dropdown menu.
The origin branch (default to master) from which to retrieve the directory
content can also be specified by using the branch query parameter.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_)
or Unix timestamp to parse in order to find the closest SWH visit.
:param path: optional parameter used to specify the path of a directory
reachable from the origin root one
:type path: string
:query string branch: specify the origin branch name from which
to retrieve the directory
:query string revision: specify the origin release name from which
to retrieve the directory
:query string revision: specify the origin revision, identified by the hexadecimal
representation of its *sha1_git* value, from which to retrieve the directory
:query int visit_id: specify a SWH visit id to retrieve the directory from instead
of using the provided timestamp
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive,
requested visit timestamp does not exist or the provided path does
not exist from the origin root directory
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/visit/1493926809/directory/`
:swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/visit/2016-09-14T10:36:21/directory/net/ethernet/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/visit/1474620651/directory/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/visit/2017-05-05/directory/Python/`
:swh_web_browse:`origin/git/url/https://github.com/python/cpython/visit/2015-08/directory/?branch=refs/heads/2.7`
Origin content
""""""""""""""
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/content/(path)/
HTML view that produces a display of a SWH content
- associated to the latest visit of a SWH origin.
+ associated to the latest full visit of a SWH origin.
If the content to display is textual, it will be highlighted client-side
if possible using highlightjs_. The procedure to perform that task is described
in :http:get:`/browse/content/[(algo_hash):](hash)/`.
It is also possible to highlight specific lines of a textual
content (not in terms of syntax highlighting but to emphasize
some relevant content part) by either:
* clicking on line numbers (holding shift to highlight a lines range)
* using an url fragment in the form '#Ln' or '#Lm-Ln'
The view displays a breadcrumb on top of the rendered
content in order to easily navigate up to the origin root directory.
The view also enables to easily switch between the origin branches
and releases through a dropdown menu.
The origin branch (default to master) from which to retrieve the content
can also be specified by using the branch query parameter.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string path: path of a content reachable from the origin root directory
:query string branch: specify the origin branch name from which
to retrieve the content
:query string release: specify the origin release name from which
to retrieve the content
:query string revision: specify the origin revision, identified by the hexadecimal
representation of its *sha1_git* value, from which to retrieve the content
:query int visit_id: specify a SWH visit id to retrieve the content from instead
of using the latest visit by default
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive,
or the provided content path does not exist from the origin root directory
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/git/git/content/git.c/`
:swh_web_browse:`origin/git/url/https://github.com/git/git/content/git.c/`
:swh_web_browse:`origin/git/url/https://github.com/mozilla/gecko-dev/content/js/src/json.cpp/`
:swh_web_browse:`origin/git/url/https://github.com/git/git/content/git.c/?branch=refs/heads/next`
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/content/(path)/
HTML view that produces a display of a SWH content associated to a
visit of a SWH origin closest to a provided timestamp.
If the content to display is textual, it will be highlighted client-side
if possible using highlightjs_. The procedure to perform that task is described
in :http:get:`/browse/content/[(algo_hash):](hash)/`.
It is also possible to highlight specific lines of a textual
content (not in terms of syntax highlighting but to emphasize
some relevant content part) by either:
* clicking on line numbers (holding shift to highlight a lines range)
* using an url fragment in the form '#Ln' or '#Lm-Ln'
The view displays a breadcrumb on top of the rendered
content in order to easily navigate up to the origin root directory.
The view also enables to easily switch between the origin branches
and releases through a dropdown menu.
The origin branch (default to master) from which to retrieve the content
can also be specified by using the branch query parameter.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_)
or Unix timestamp to parse in order to find the closest SWH visit.
:param string path: path of a content reachable from the origin root directory
:query string branch: specify the origin branch name from which
to retrieve the content
:query string release: specify the origin release name from which
to retrieve the content
:query string revision: specify the origin revision, identified by the hexadecimal
representation of its *sha1_git* value, from which to retrieve the content
:query int visit_id: specify a SWH visit id to retrieve the content from instead
of using the provided timestamp
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive,
requested visit timestamp does not exist or the provided content path does
not exist from the origin root directory
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/git/git/visit/1473933564/content/git.c/`
:swh_web_browse:`origin/git/url/https://github.com/git/git/visit/2016-05-05T00:0:00+00:00/content/git.c/`
:swh_web_browse:`origin/git/url/https://github.com/mozilla/gecko-dev/visit/1490126182/content/js/src/json.cpp/`
:swh_web_browse:`origin/git/url/https://github.com/mozilla/gecko-dev/visit/2017-03-21/content/js/src/json.cpp/#L904-L931`
:swh_web_browse:`origin/git/url/https://github.com/git/git/visit/2017-09-15/content/git.c/?branch=refs/heads/next`
Origin history
""""""""""""""
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/log/
HTML view that produces a display of revisions history heading
to the last revision found during the latest visit of a SWH origin.
In other words, it shows the commit log associated to the latest
- visit of a SWH origin.
+ full visit of a SWH origin.
The following data are displayed for each log entry:
* author of the revision
* link to the revision metadata
* message associated the revision
* date of the revision
* link to browse the associated source tree in the origin context
N log entries are displayed per page (default is 20). In order to navigate
in a large history, two buttons are present at the bottom of the view:
* *Newer*: fetch and display if available the N more recent log entries
than the ones currently displayed
* *Older*: fetch and display if available the N older log entries
than the ones currently displayed
The view also enables to easily switch between the origin branches
and releases through a dropdown menu.
The origin branch (default to master) from which to retrieve the content
can also be specified by using the branch query parameter.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:query string revs_breadcrumb: used internally to store
the navigation breadcrumbs (i.e. the list of descendant revisions
visited so far). It must be a string in the form
"(rev_1)[/(rev_2)/.../(rev_n)]" where rev_i corresponds to a
revision sha1_git.
:query int per_page: the number of log entries to display per page
(default is 20, max is 50)
:query string branch: specify the origin branch name from which
to retrieve the commit log
:query string release: specify the origin release name from which
to retrieve the commit log
:query string revision: specify the origin revision, identified by the hexadecimal
representation of its *sha1_git* value, from which to retrieve the commit log
:query int visit_id: specify a SWH visit id to retrieve the history log from instead
of using the latest visit by default
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/videolan/vlc/log/`
:swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/log/`
:swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/log/?branch=refs/heads/release`
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/log/
HTML view that produces a display of revisions history heading
to the last revision found during a visit of a SWH origin closest
to the provided timestamp.
In other words, it shows the commit log associated to a visit of
a SWH origin closest to a provided timestamp.
The following data are displayed for each log entry:
* author of the revision
* link to the revision metadata
* message associated the revision
* date of the revision
* link to browse the associated source tree in the origin context
N log entries are displayed per page (default is 20). In order to navigate
in a large history, two buttons are present at the bottom of the view:
* *Newer*: fetch and display if available the N more recent log entries
than the ones currently displayed
* *Older*: fetch and display if available the N older log entries
than the ones currently displayed
The view also enables to easily switch between the origin branches
and releases through a dropdown menu.
The origin branch (default to master) from which to retrieve the content
can also be specified by using the branch query parameter.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_)
or Unix timestamp to parse in order to find the closest SWH visit.
:query string revs_breadcrumb: used internally to store
the navigation breadcrumbs (i.e. the list of descendant revisions
visited so far). It must be a string in the form
"(rev_1)[/(rev_2)/.../(rev_n)]" where rev_i corresponds to a
revision sha1_git.
:query int per_page: the number of log entries to display per page
(default is 20, max is 50)
:query string branch: specify the origin branch name from which
to retrieve the commit log
:query string release: specify the origin release name from which
to retrieve the commit log
:query string revision: specify the origin revision, identified by the hexadecimal
representation of its *sha1_git* value, from which to retrieve the commit log
:query int visit_id: specify a SWH visit id to retrieve the history log from instead
of using the provided timestamp
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/videolan/vlc/visit/1459651262/log/`
:swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/2016-04-01/log/`
:swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/1438116814/log/?branch=refs/heads/release`
:swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/2017-05-05T03:14:23/log/?branch=refs/heads/release`
Origin branches
"""""""""""""""
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/branches/
HTML view that produces a display of the list of branches
- found during the latest visit of a SWH origin.
+ found during the latest full visit of a SWH origin.
The following data are displayed for each branch:
* its name
* a link to browse the associated directory
* a link to browse the associated revision
* last commit message
* last commit date
That list of branches is paginated, each page displaying a maximum of 20 branches.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/deb/url/deb://Debian/packages/linux/branches/`
:swh_web_browse:`origin/git/url/https://github.com/webpack/webpack/branches/`
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/branches/
HTML view that produces a display of the list of branches
found during a visit of a SWH origin closest to the provided timestamp.
The following data are displayed for each branch:
* its name
* a link to browse the associated directory
* a link to browse the associated revision
* last commit message
* last commit date
That list of branches is paginated, each page displaying a maximum of 20 branches.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_)
or Unix timestamp to parse in order to find the closest SWH visit.
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/kripken/emscripten/visit/2017-05-05T12:02:03/branches/`
:swh_web_browse:`origin/deb/url/deb://Debian/packages/apache2-mod-xforward/visit/2017-11-15T05:15:09/branches/`
Origin releases
"""""""""""""""
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/releases/
HTML view that produces a display of the list of releases
- found during the latest visit of a SWH origin.
+ found during the latest full visit of a SWH origin.
The following data are displayed for each release:
* its name
* a link to browse the release details
* its target type (revision, directory, content or release)
* its associated message
* its date
That list of releases is paginated, each page displaying a maximum of 20 releases.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/git/git/releases/`
:swh_web_browse:`origin/git/url/https://github.com/webpack/webpack/releases/`
.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/releases/
HTML view that produces a display of the list of releases
- found during the latest visit of a SWH origin.
+ found during a visit of a SWH origin closest to the provided timestamp.
The following data are displayed for each release:
* its name
* a link to browse the release details
* its target type (revision, directory, content or release)
* its associated message
* its date
That list of releases is paginated, each page displaying a maximum of 20 releases.
:param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...)
:param string origin_url: the url of the origin (e.g. https://github.com/user/repo)
:param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_)
or Unix timestamp to parse in order to find the closest SWH visit.
:statuscode 200: no error
:statuscode 404: requested origin can not be found in the SWH archive
**Examples:**
.. parsed-literal::
:swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/visit/2017-11-21T19:37:42/releases/`
:swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/2016-09-23T14:06:35/releases/`
.. _highlightjs: https://highlightjs.org/
.. _dateutil.parser.parse: http://dateutil.readthedocs.io/en/stable/parser.html
diff --git a/swh/web/browse/utils.py b/swh/web/browse/utils.py
index 7bf94bea..88bb2bca 100644
--- a/swh/web/browse/utils.py
+++ b/swh/web/browse/utils.py
@@ -1,838 +1,842 @@
# Copyright (C) 2017-2018 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
import base64
import magic
import math
import stat
from django.core.cache import cache
from django.utils.safestring import mark_safe
from importlib import reload
from swh.web.common import highlightjs, service
from swh.web.common.exc import NotFoundExc
from swh.web.common.utils import (
reverse, format_utc_iso_date, parse_timestamp
)
from swh.web.config import get_config
def get_directory_entries(sha1_git):
"""Function that retrieves the content of a SWH directory
from the SWH archive.
The directories entries are first sorted in lexicographical order.
Sub-directories and regular files are then extracted.
Args:
sha1_git: sha1_git identifier of the directory
Returns:
A tuple whose first member corresponds to the sub-directories list
and second member the regular files list
Raises:
NotFoundExc if the directory is not found
"""
cache_entry_id = 'directory_entries_%s' % sha1_git
cache_entry = cache.get(cache_entry_id)
if cache_entry:
return cache_entry
entries = list(service.lookup_directory(sha1_git))
entries = sorted(entries, key=lambda e: e['name'])
for entry in entries:
entry['perms'] = stat.filemode(entry['perms'])
dirs = [e for e in entries if e['type'] == 'dir']
files = [e for e in entries if e['type'] == 'file']
cache.set(cache_entry_id, (dirs, files))
return dirs, files
def get_mimetype_and_encoding_for_content(content):
"""Function that returns the mime type and the encoding associated to
a content buffer using the magic module under the hood.
Args:
content (bytes): a content buffer
Returns:
A tuple (mimetype, encoding), for instance ('text/plain', 'us-ascii'),
associated to the provided content.
"""
while True:
try:
magic_result = magic.detect_from_content(content)
mime_type = magic_result.mime_type
encoding = magic_result.encoding
break
except Exception as exc:
# workaround an issue with the magic module who can fail
# if detect_from_content is called multiple times in
# a short amount of time
reload(magic)
return mime_type, encoding
# maximum authorized content size in bytes for HTML display
# with code highlighting
content_display_max_size = get_config()['content_display_max_size']
def request_content(query_string, max_size=content_display_max_size):
"""Function that retrieves a SWH content from the SWH archive.
Raw bytes content is first retrieved, then the content mime type.
If the mime type is not stored in the archive, it will be computed
using Python magic module.
Args:
query_string: a string of the form "[ALGO_HASH:]HASH" where
optional ALGO_HASH can be either *sha1*, *sha1_git*, *sha256*,
or *blake2s256* (default to *sha1*) and HASH the hexadecimal
representation of the hash value
max_size: the maximum size for a content to retrieve (default to 1MB,
no size limit if None)
Returns:
A tuple whose first member corresponds to the content raw bytes
and second member the content mime type
Raises:
NotFoundExc if the content is not found
"""
content_data = service.lookup_content(query_string)
filetype = service.lookup_content_filetype(query_string)
language = service.lookup_content_language(query_string)
license = service.lookup_content_license(query_string)
mimetype = 'unknown'
encoding = 'unknown'
if filetype:
mimetype = filetype['mimetype']
encoding = filetype['encoding']
if not max_size or content_data['length'] < max_size:
content_raw = service.lookup_content_raw(query_string)
content_data['raw_data'] = content_raw['data']
if not filetype:
mimetype, encoding = \
get_mimetype_and_encoding_for_content(content_data['raw_data'])
# encode textual content to utf-8 if needed
if mimetype.startswith('text/'):
# probably a malformed UTF-8 content, reencode it
# by replacing invalid chars with a substitution one
if encoding == 'unknown-8bit':
content_data['raw_data'] = \
content_data['raw_data'].decode('utf-8', 'replace')\
.encode('utf-8')
elif 'ascii' not in encoding and encoding not in ['utf-8', 'binary']: # noqa
content_data['raw_data'] = \
content_data['raw_data'].decode(encoding, 'replace')\
.encode('utf-8')
else:
content_data['raw_data'] = None
content_data['mimetype'] = mimetype
content_data['encoding'] = encoding
if language:
content_data['language'] = language['lang']
else:
content_data['language'] = 'not detected'
if license:
content_data['licenses'] = ', '.join(license['licenses'])
else:
content_data['licenses'] = 'not detected'
return content_data
_browsers_supported_image_mimes = set(['image/gif', 'image/png',
'image/jpeg', 'image/bmp',
'image/webp'])
def prepare_content_for_display(content_data, mime_type, path):
"""Function that prepares a content for HTML display.
The function tries to associate a programming language to a
content in order to perform syntax highlighting client-side
using highlightjs. The language is determined using either
the content filename or its mime type.
If the mime type corresponds to an image format supported
by web browsers, the content will be encoded in base64
for displaying the image.
Args:
content_data (bytes): raw bytes of the content
mime_type (string): mime type of the content
path (string): path of the content including filename
Returns:
A dict containing the content bytes (possibly different from the one
provided as parameter if it is an image) under the key 'content_data
and the corresponding highlightjs language class under the
key 'language'.
"""
language = highlightjs.get_hljs_language_from_filename(path)
if not language:
language = highlightjs.get_hljs_language_from_mime_type(mime_type)
if not language:
language = 'nohighlight-swh'
elif mime_type.startswith('application/'):
mime_type = mime_type.replace('application/', 'text/')
if mime_type.startswith('image/'):
if mime_type in _browsers_supported_image_mimes:
content_data = base64.b64encode(content_data)
else:
content_data = None
return {'content_data': content_data,
'language': language}
def get_origin_visits(origin_info):
"""Function that returns the list of visits for a swh origin.
That list is put in cache in order to speedup the navigation
in the swh web browse ui.
Args:
origin_id (int): the id of the swh origin to fetch visits from
Returns:
A list of dict describing the origin visits::
[{'date': <UTC visit date in ISO format>,
'origin': <origin id>,
'status': <'full' | 'partial'>,
'visit': <visit id>
},
...
]
Raises:
NotFoundExc if the origin is not found
"""
cache_entry_id = 'origin_%s_visits' % origin_info['id']
cache_entry = cache.get(cache_entry_id)
if cache_entry:
return cache_entry
origin_visits = []
per_page = service.MAX_LIMIT
last_visit = None
while 1:
visits = list(service.lookup_origin_visits(origin_info['id'],
last_visit=last_visit,
per_page=per_page))
origin_visits += visits
if len(visits) < per_page:
break
else:
if not last_visit:
last_visit = per_page
else:
last_visit += per_page
def _visit_sort_key(visit):
ts = parse_timestamp(visit['date']).timestamp()
return ts + (float(visit['visit']) / 10e3)
for v in origin_visits:
if 'metadata' in v:
del v['metadata']
origin_visits = [dict(t) for t in set([tuple(d.items())
for d in origin_visits])]
origin_visits = sorted(origin_visits, key=lambda v: _visit_sort_key(v))
cache.set(cache_entry_id, origin_visits)
return origin_visits
def get_origin_visit(origin_info, visit_ts=None, visit_id=None):
"""Function that returns information about a SWH visit for
a given origin.
The visit is retrieved from a provided timestamp.
The closest visit from that timestamp is selected.
Args:
origin_info (dict): a dict filled with origin information
(id, url, type)
visit_ts (int or str): an ISO date string or Unix timestamp to parse
Returns:
A dict containing the visit info as described below::
{'origin': 2,
'date': '2017-10-08T11:54:25.582463+00:00',
'metadata': {},
'visit': 25,
'status': 'full'}
"""
visits = get_origin_visits(origin_info)
if not visits:
raise NotFoundExc('No SWH visit associated to origin with'
' type %s and url %s!' % (origin_info['type'],
origin_info['url']))
if visit_id:
visit = [v for v in visits if v['visit'] == int(visit_id)]
if len(visit) == 0:
raise NotFoundExc(
'Visit with id %s for origin with type %s'
' and url %s not found!' % (visit_id, origin_info['type'],
origin_info['url']))
return visit[0]
if not visit_ts:
+ # returns the latest full visit when no timestamp is provided
+ for v in reversed(visits):
+ if v['status'] == 'full':
+ return v
return visits[-1]
parsed_visit_ts = math.floor(parse_timestamp(visit_ts).timestamp())
visit_idx = None
for i, visit in enumerate(visits):
ts = math.floor(parse_timestamp(visit['date']).timestamp())
if i == 0 and parsed_visit_ts <= ts:
return visit
elif i == len(visits) - 1:
if parsed_visit_ts >= ts:
return visit
else:
next_ts = math.floor(
parse_timestamp(visits[i+1]['date']).timestamp())
if parsed_visit_ts >= ts and parsed_visit_ts < next_ts:
if (parsed_visit_ts - ts) < (next_ts - parsed_visit_ts):
visit_idx = i
break
else:
visit_idx = i+1
break
if visit_idx:
visit = visits[visit_idx]
while visit_idx < len(visits) - 1 and \
visit['date'] == visits[visit_idx+1]['date']:
visit_idx = visit_idx + 1
visit = visits[visit_idx]
return visit
else:
raise NotFoundExc(
'Visit with timestamp %s for origin with type %s and url %s not found!' % # noqa
(visit_ts, origin_info['type'], origin_info['url']))
def get_origin_visit_snapshot(origin_info, visit_ts=None, visit_id=None):
"""Function that returns the lists of branches and releases
associated to a swh origin for a given visit.
The visit is expressed by a timestamp. In the latter case,
the closest visit from the provided timestamp will be used.
If no visit parameter is provided, it returns the list of branches
found for the latest visit.
That list is put in cache in order to speedup the navigation
in the swh web browse ui.
Args:
origin_info (dict): a dict filled with origin information
(id, url, type)
visit_ts (int or str): an ISO date string or Unix timestamp to parse
visit_id (int): optional visit id for desambiguation in case
several visits have the same timestamp
Returns:
A tuple with two members. The first one is a list of dict describing
the origin branches for the given visit::
[{'name': <branch name>,
'revision': <sha1_git of the associated revision>,
'directory': <sha1_git of the associated root directory>
},
...
]
The second one is a list of dict describing the origin branches
for the given visit.
Raises:
NotFoundExc if the origin or its visit are not found
"""
visit_info = get_origin_visit(origin_info, visit_ts, visit_id)
visit = visit_info['visit']
cache_entry_id = 'origin_%s_visit_%s_snapshot' % (origin_info['id'],
visit)
cache_entry = cache.get(cache_entry_id)
if cache_entry:
return cache_entry['branches'], cache_entry['releases']
branches = []
releases = []
if visit_info['snapshot']:
revision_ids = []
releases_ids = []
origin_visit_snapshot = service.lookup_snapshot(visit_info['snapshot'])
snapshot_branches = origin_visit_snapshot['branches']
for key in sorted(snapshot_branches.keys()):
if not snapshot_branches[key]:
continue
if snapshot_branches[key]['target_type'] == 'revision':
branches.append({'name': key,
'revision': snapshot_branches[key]['target']})
revision_ids.append(snapshot_branches[key]['target'])
elif snapshot_branches[key]['target_type'] == 'release':
releases_ids.append(snapshot_branches[key]['target'])
releases_info = service.lookup_release_multiple(releases_ids)
for release in releases_info:
releases.append({'name': release['name'],
'date': format_utc_iso_date(release['date']),
'id': release['id'],
'message': release['message'],
'target_type': release['target_type'],
'target': release['target']})
revision_ids.append(release['target'])
revisions = service.lookup_revision_multiple(revision_ids)
branches_to_remove = []
for idx, revision in enumerate(revisions):
if idx < len(branches):
if revision:
branches[idx]['directory'] = revision['directory']
branches[idx]['date'] = format_utc_iso_date(revision['date']) # noqa
branches[idx]['message'] = revision['message']
else:
branches_to_remove.append(branches[idx])
else:
rel_idx = idx - len(branches)
if revision:
releases[rel_idx]['directory'] = revision['directory']
for b in branches_to_remove:
branches.remove(b)
cache.set(cache_entry_id, {'branches': branches, 'releases': releases})
return branches, releases
def gen_link(url, link_text, link_attrs={}):
"""
Utility function for generating an HTML link to insert
in Django templates.
Args:
url (str): an url
link_text (str): the text for the produced link
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form '<a href="url">link_text</a>'
"""
attrs = ' '
for k, v in link_attrs.items():
attrs += '%s="%s" ' % (k, v)
link = '<a%shref="%s">%s</a>' % (attrs, url, link_text)
return mark_safe(link)
def gen_person_link(person_id, person_name, link_attrs={}):
"""
Utility function for generating a link to a SWH person HTML view
to insert in Django templates.
Args:
person_id (int): a SWH person id
person_name (str): the associated person name
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form '<a href="person_view_url">person_name</a>'
"""
person_url = reverse('browse-person', kwargs={'person_id': person_id})
return gen_link(person_url, person_name, link_attrs)
def gen_revision_link(revision_id, shorten_id=False, origin_context=None,
link_text=None, link_attrs={}):
"""
Utility function for generating a link to a SWH revision HTML view
to insert in Django templates.
Args:
revision_id (str): a SWH revision id
shorten_id (boolean): wheter to shorten the revision id to 7
characters for the link text
origin_context (dict): if provided, generate origin-dependent browsing
link (see :func:`swh.web.browse.utils.get_origin_context`)
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form '<a href="revision_view_url">revision_id</a>'
"""
query_params = None
if origin_context:
origin_info = origin_context['origin_info']
query_params = {'origin_type': origin_info['type'],
'origin_url': origin_info['url']}
if 'timestamp' in origin_context['url_args']:
query_params['timestamp'] = \
origin_context['url_args']['timestamp']
if 'visit_id' in origin_context['query_params']:
query_params['visit_id'] = \
origin_context['query_params']['visit_id']
revision_url = reverse('browse-revision',
kwargs={'sha1_git': revision_id},
query_params=query_params)
if shorten_id:
return gen_link(revision_url, revision_id[:7], link_attrs)
else:
if not link_text:
link_text = revision_id
return gen_link(revision_url, link_text, link_attrs)
def gen_origin_link(origin_info, link_attrs={}):
"""
Utility function for generating a link to a SWH origin HTML view
to insert in Django templates.
Args:
origin_info (dict): a dicted filled with origin information
(id, type, url)
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form '<a href="origin_view_url">Origin: origin_url</a>'
""" # noqa
origin_browse_url = reverse('browse-origin',
kwargs={'origin_type': origin_info['type'],
'origin_url': origin_info['url']})
return gen_link(origin_browse_url,
'Origin: ' + origin_info['url'], link_attrs)
def gen_directory_link(sha1_git, link_text=None, link_attrs={}):
"""
Utility function for generating a link to a SWH directory HTML view
to insert in Django templates.
Args:
sha1_git (str): directory identifier
link_text (str): optional text for the generated link
(the generated url will be used by default)
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form '<a href="directory_view_url">link_text</a>'
"""
directory_url = reverse('browse-directory',
kwargs={'sha1_git': sha1_git})
if not link_text:
link_text = directory_url
return gen_link(directory_url, link_text, link_attrs)
def gen_origin_directory_link(origin_context, revision_id=None,
link_text=None, link_attrs={}):
"""
Utility function for generating a link to a SWH directory HTML view
in the context of an origin to insert in Django templates.
Args:
origin_info (dict): the origin information (type and url)
revision_id (str): optional revision identifier in order
to use the associated directory
link_text (str): optional text to use for the generated link
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form
'<a href="origin_directory_view_url">origin_directory_view_url</a>'
"""
origin_info = origin_context['origin_info']
url_args = {'origin_type': origin_info['type'],
'origin_url': origin_info['url']}
query_params = {'revision': revision_id}
if 'timestamp' in origin_context['url_args']:
url_args['timestamp'] = \
origin_context['url_args']['timestamp']
if 'visit_id' in origin_context['query_params']:
query_params['visit_id'] = \
origin_context['query_params']['visit_id']
directory_url = reverse('browse-origin-directory',
kwargs=url_args,
query_params=query_params)
if not link_text:
link_text = directory_url
return gen_link(directory_url, link_text, link_attrs)
def gen_content_link(sha1_git, link_text=None, link_attrs={}):
"""
Utility function for generating a link to a SWH content HTML view
to insert in Django templates.
Args:
sha1_git (str): content identifier
link_text (str): optional text for the generated link
(the generated url will be used by default)
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form '<a href="content_view_url">link_text</a>'
"""
content_url = reverse('browse-content',
kwargs={'query_string': 'sha1_git:' + sha1_git})
if not link_text:
link_text = content_url
return gen_link(content_url, link_text, link_attrs)
def get_revision_log_url(revision_id, origin_context=None):
"""
Utility function for getting the URL for a SWH revision log HTML view
(possibly in the context of an origin).
Args:
revision_id (str): revision identifier the history heads to
origin_context (dict): if provided, generate origin-dependent browsing
link (see :func:`swh.web.browse.utils.get_origin_context`)
Returns:
The SWH revision log view URL
"""
if origin_context:
origin_info = origin_context['origin_info']
url_args = {'origin_type': origin_info['type'],
'origin_url': origin_info['url']}
query_params = {'revision': revision_id}
if 'timestamp' in origin_context['url_args']:
url_args['timestamp'] = \
origin_context['url_args']['timestamp']
if 'visit_id' in origin_context['query_params']:
query_params['visit_id'] = \
origin_context['query_params']['visit_id']
revision_log_url = reverse('browse-origin-log',
kwargs=url_args,
query_params=query_params)
else:
revision_log_url = reverse('browse-revision-log',
kwargs={'sha1_git': revision_id})
return revision_log_url
def gen_revision_log_link(revision_id, origin_context=None, link_text=None,
link_attrs={}):
"""
Utility function for generating a link to a SWH revision log HTML view
(possibly in the context of an origin) to insert in Django templates.
Args:
revision_id (str): revision identifier the history heads to
origin_context (dict): if provided, generate origin-dependent browsing
link (see :func:`swh.web.browse.utils.get_origin_context`)
link_text (str): optional text to use for the generated link
link_attrs (dict): optional attributes (e.g. class)
to add to the link
Returns:
An HTML link in the form
'<a href="revision_log_view_url">link_text</a>'
"""
revision_log_url = get_revision_log_url(revision_id, origin_context)
if not link_text:
link_text = revision_log_url
return gen_link(revision_log_url, link_text, link_attrs)
def _format_log_entries(revision_log, per_page, origin_context=None):
revision_log_data = []
for i, log in enumerate(revision_log):
if i == per_page:
break
revision_log_data.append(
{'author': gen_person_link(log['author']['id'],
log['author']['name']),
'revision': gen_revision_link(log['id'], True, origin_context),
'message': log['message'],
'date': format_utc_iso_date(log['date']),
'directory': log['directory']})
return revision_log_data
def prepare_revision_log_for_display(revision_log, per_page, revs_breadcrumb,
origin_context=None):
"""
Utility functions that process raw revision log data for HTML display.
Its purpose is to:
* add links to relevant SWH browse views
* format date in human readable format
* truncate the message log
It also computes the data needed to generate the links for navigating back
and forth in the history log.
Args:
revision_log (list): raw revision log as returned by the SWH web api
per_page (int): number of log entries per page
revs_breadcrumb (str): breadcrumbs of revisions navigated so far,
in the form 'rev1[/rev2/../revN]'. Each revision corresponds to
the first one displayed in the HTML view for history log.
origin_context (boolean): wheter or not the revision log is browsed
from an origin view.
"""
current_rev = revision_log[0]['id']
next_rev = None
prev_rev = None
next_revs_breadcrumb = None
prev_revs_breadcrumb = None
if len(revision_log) == per_page + 1:
prev_rev = revision_log[-1]['id']
prev_rev_bc = current_rev
if origin_context:
prev_rev_bc = prev_rev
if revs_breadcrumb:
revs = revs_breadcrumb.split('/')
next_rev = revs[-1]
if len(revs) > 1:
next_revs_breadcrumb = '/'.join(revs[:-1])
if len(revision_log) == per_page + 1:
prev_revs_breadcrumb = revs_breadcrumb + '/' + prev_rev_bc
else:
prev_revs_breadcrumb = prev_rev_bc
return {'revision_log_data': _format_log_entries(revision_log, per_page,
origin_context),
'prev_rev': prev_rev,
'prev_revs_breadcrumb': prev_revs_breadcrumb,
'next_rev': next_rev,
'next_revs_breadcrumb': next_revs_breadcrumb}
def get_origin_context(origin_type, origin_url, timestamp, visit_id=None):
"""
Utility function to compute relevant information when navigating
the SWH archive in an origin context.
Args:
origin_type (str): the origin type (git, svn, deposit, ...)
origin_url (str): the origin_url (e.g. https://github.com/<user>/<repo>)
timestamp (str): a datetime string for retrieving the closest
SWH visit of the origin
visit_id (int): optional visit id for disambiguation in case
of several visits with the same timestamp
Returns:
A dict with the following entries:
* origin_info: dict containing origin information
* visit_info: dict containing SWH visit information
* branches: the list of branches for the origin found
during the visit
* releases: the list of releases for the origin found
during the visit
* origin_browse_url: the url to browse the origin
* origin_branches_url: the url to browse the origin branches
* origin_releases_url': the url to browse the origin releases
* origin_visit_url: the url to browse the snapshot of the origin
found during the visit
* url_args: dict containg url arguments to use when browsing in
the context of the origin and its visit
""" # noqa
origin_info = service.lookup_origin({'type': origin_type,
'url': origin_url})
visit_info = get_origin_visit(origin_info, timestamp, visit_id)
visit_info['fmt_date'] = format_utc_iso_date(visit_info['date'])
# provided timestamp is not necessarily equals to the one
# of the retrieved visit, so get the exact one in order
# use it in the urls generated below
if timestamp:
timestamp = visit_info['date']
branches, releases = \
get_origin_visit_snapshot(origin_info, timestamp, visit_id)
releases = list(reversed(releases))
url_args = {'origin_type': origin_info['type'],
'origin_url': origin_info['url']}
if timestamp:
url_args['timestamp'] = format_utc_iso_date(timestamp,
'%Y-%m-%dT%H:%M:%S')
origin_browse_url = reverse('browse-origin',
kwargs={'origin_type': origin_info['type'],
'origin_url': origin_info['url']})
origin_visit_url = reverse('browse-origin-directory',
kwargs=url_args,
query_params={'visit_id': visit_id})
origin_branches_url = reverse('browse-origin-branches',
kwargs=url_args,
query_params={'visit_id': visit_id})
origin_releases_url = reverse('browse-origin-releases',
kwargs=url_args,
query_params={'visit_id': visit_id})
return {
'origin_info': origin_info,
'visit_info': visit_info,
'branches': branches,
'releases': releases,
'branch': None,
'release': None,
'origin_browse_url': origin_browse_url,
'origin_branches_url': origin_branches_url,
'origin_releases_url': origin_releases_url,
'origin_visit_url': origin_visit_url,
'url_args': url_args,
'query_params': {'visit_id': visit_id}
}