# -*- coding: utf-8 -*-
"""
(c) 2014 - Copyright Red Hat Inc
Authors:
Pierre-Yves Chibon <pingou@pingoured.fr>
"""
import flask
import os
from math import ceil
import pygit2
from sqlalchemy.exc import SQLAlchemyError
from pygments import highlight
from pygments.lexers import guess_lexer
from pygments.lexers.text import DiffLexer
from pygments.formatters import HtmlFormatter
import progit.doc_utils
import progit.exceptions
import progit.lib
import progit.forms
from progit import APP, SESSION, LOG, cla_required
def __get_tree(repo_obj, tree, filepath, index=0, extended=False):
''' Retrieve the entry corresponding to the provided filename in a
given tree.
'''
filename = filepath[index]
if isinstance(tree, pygit2.Blob): # pragma: no cover
# If we were given a blob, then let's just return it
return (tree, None)
cnt = 0
for el in tree:
if el.name == filename or el.name.startswith('index'):
# If we have a folder we must go one level deeper
if el.filemode == 16384:
if (index + 1) == len(filepath):
filepath.append('')
return __get_tree(
repo_obj, repo_obj[el.oid], filepath, index=index + 1,
extended=True)
else:
return (el, tree, False)
if filename == '':
return (None, tree, extended)
else:
raise progit.exceptions.FileNotFoundException(
'File %s not found' % ('/'.join(filepath),))
def __get_tree_and_content(repo_obj, commit, path, startswith):
''' Return the tree and the content of the specified file. '''
(blob_or_tree, tree_obj, extended) = __get_tree(
repo_obj, commit.tree, path)
if blob_or_tree is None:
return (tree_obj, None, extended)
if not repo_obj[blob_or_tree.oid]:
# Not tested and no idea how to test it, but better safe than sorry
flask.abort(404, 'File not found')
if isinstance(blob_or_tree, pygit2.TreeEntry): # Returned a file
name, ext = os.path.splitext(blob_or_tree.name)
blob_obj = repo_obj[blob_or_tree.oid]
content = progit.doc_utils.convert_readme(blob_obj.data, ext)
tree = sorted(tree_obj, key=lambda x: x.filemode)
return (tree, content, extended)
# URLs
@APP.route('/<repo>/docs')
@APP.route('/<repo>/docs/<path:filename>')
@APP.route('/<repo>/docs/<branchname>')
@APP.route('/<repo>/docs/<branchname>/<path:filename>')
@APP.route('/fork/<username>/<repo>/docs')
@APP.route('/fork/<username>/<repo>/docs/<path:filename>')
@APP.route('/fork/<username>/<repo>/docs/<branchname>')
@APP.route('/fork/<username>/<repo>/docs/<branchname>/<path:filename>')
def view_docs(repo, username=None, branchname=None, filename=None):
""" Display the documentation
"""
status = flask.request.args.get('status', None)
repo = progit.lib.get_project(SESSION, repo, user=username)
if not repo:
flask.abort(404, 'Project not found')
if not repo.project_docs:
flask.abort(404, 'No documentation found for this project')
reponame = os.path.join(APP.config['DOCS_FOLDER'], repo.path)
if not os.path.exists(reponame):
flask.flash(
'No docs repository could be found, please contact an admin',
'error')
return flask.redirect(flask.url_for(
'view_repo', repo=repo.name, username=username))
repo_obj = pygit2.Repository(reponame)
if branchname in repo_obj.listall_branches():
branch = repo_obj.lookup_branch(branchname)
commit = branch.get_object()
else:
if not repo_obj.is_empty:
commit = repo_obj[repo_obj.head.target]
else:
commit = None
branchname = 'master'
content = None
tree = None
startswith = False
if not filename:
path = ['']
startswith = True
else:
path = [it for it in filename.split('/') if it]
if commit:
try:
(tree, content, extended) = __get_tree_and_content(
repo_obj, commit, path, startswith=True)
if extended:
filename += '/'
except progit.exceptions.FileNotFoundException as err:
flask.flash(err.message, 'error')
return flask.render_template(
'docs.html',
select='docs',
repo_obj=repo_obj,
repo=repo,
username=username,
branchname=branchname,
filename=filename,
tree=tree,
content=content,
)