def view_history(name, gitref):
"""Serve a page name from git repo (an old version of a page).
.. note:: this is a bottle view
* this is a GET only method : you can not change a committed page
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
:gitref: (str) -- hexsha of the git commit to look into
Returns:
bottle response object or 404 error page
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
content = read_committed_file(gitref, name + '.rst')
if content:
html_body = publish_parts(content,
writer=AttowikiWriter(),
settings=None,
settings_overrides=None)['html_body']
history = commit_history(name + '.rst')
return template('page',
type="history",
name=name,
extended_name=None,
is_repo=check_repo(),
history=history,
gitref=gitref,
content=html_body)
else:
return abort(404)
def view_history(name, gitref):
"""serve a page name from git repo (an old version of a page)
.. note:: this is a bottle view
* this is a GET only method : you can not change a committed page
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
:gitref: (str) -- hexsha of the git commit to look into
Returns:
bottle response object or 404 error page
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
content = read_committed_file(gitref, name + '.rst')
if content:
html_body = publish_parts(content,
writer=HisWriter(),
settings=None,
settings_overrides=None)['html_body']
history = commit_history(name + '.rst')
return template('page',
type="history",
name=name,
extended_name=None,
is_repo=check_repo(),
history=history,
gitref=gitref,
content=html_body)
else:
return abort(404)
def view_edit(name=None):
"""Edit or creates a new page.
.. note:: this is a bottle view
if no page name is given, creates a new page.
Keyword Arguments:
:name: (str) -- name of the page (OPTIONAL)
Returns:
bottle response object
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
if name is None:
# new page
return template('edit',
type="edit",
name=name,
extended_name=None,
is_repo=check_repo(),
history=[],
gitref=None,
today=datetime.datetime.now().strftime("%Y%m%d"),
content="")
else:
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
return template('edit',
type="edit",
name=name,
extended_name=None,
is_repo=check_repo(),
history=[],
gitref=None,
today=datetime.datetime.now().strftime("%Y%m%d"),
content=file_handle.read())
else:
return abort(404)
def view_edit(name=None):
"""edit or creates a new page
.. note:: this is a bottle view
if no page name is given, creates a new page.
Keyword Arguments:
:name: (str) -- name of the page (OPTIONAL)
Returns:
bottle response object
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
if name is None:
# new page
return template('edit',
type="edit",
name=name,
extended_name=None,
is_repo=check_repo(),
history=[],
gitref=None,
today=datetime.datetime.now().strftime("%Y%m%d"),
content="")
else:
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
return template('edit',
type="edit",
name=name,
extended_name=None,
is_repo=check_repo(),
history=[],
gitref=None,
today=datetime.datetime.now().strftime("%Y%m%d"),
content=file_handle.read())
else:
return abort(404)
def view_meta_index():
"""List all the available .rst files in the directory.
view_meta_index is called by the 'meta' url : /__index__
"""
rst_files = [filename[2:-4] for filename in sorted(glob.glob("./*.rst"))]
rst_files.reverse()
return template('index',
type="view",
filelist=rst_files,
name="__index__",
extended_name=None,
history=[],
gitref=None,
is_repo=check_repo())
def view_meta_index():
"""List all the available .rst files in the directory
view_meta_index is called by the 'meta' url : /__index__
"""
rst_files = [filename[2:-4] for filename in sorted(glob.glob("./*.rst"))]
rst_files.reverse()
return template('index',
type="view",
filelist=rst_files,
name="__index__",
extended_name=None,
history=[],
gitref=None,
is_repo=check_repo())
def view_history_diff(name, gitref):
"""Serve a page name from git repo (an old version of a page).
then return the diff between current source and the old commited source
This function does not use any template it returns only plain text
.. note:: this is a bottle view
* this is a GET only method : you can not change a committed page
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
:gitref: (str) -- hexsha of the git commit to look into
Returns:
bottle response object or 404 error page
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
response.set_header('Content-Type', 'text/html; charset=utf-8')
old_content = read_committed_file(gitref, name + '.rst')
if old_content:
old_content = old_content.decode('utf-8')
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
current_content = file_handle.read().decode('utf-8')
differ = difflib.Differ()
result = list(
differ.compare(old_content.splitlines(),
current_content.splitlines()))
return template('diff_view',
type="history",
name=name,
extended_name='__diff__',
is_repo=check_repo(),
history=commit_history("{0}.rst".format(name)),
gitref=gitref,
content=result)
else:
return abort(404)
else:
return abort(404)
def view_history_diff(name, gitref):
"""Serve a page name from git repo (an old version of a page).
then return the diff between current source and the old commited source
This function does not use any template it returns only plain text
.. note:: this is a bottle view
* this is a GET only method : you can not change a committed page
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
:gitref: (str) -- hexsha of the git commit to look into
Returns:
bottle response object or 404 error page
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
response.set_header('Content-Type', 'text/html; charset=utf-8')
old_content = read_committed_file(gitref, name + '.rst')
if old_content:
old_content = old_content.decode('utf-8')
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
current_content = file_handle.read().decode('utf-8')
differ = difflib.Differ()
result = list(differ.compare(old_content.splitlines(),
current_content.splitlines()))
return template('diff_view',
type="history",
name=name,
extended_name='__diff__',
is_repo=check_repo(),
history=commit_history("{0}.rst".format(name)),
gitref=gitref,
content=result)
else:
return abort(404)
else:
return abort(404)
def view_history_source(name, gitref=None):
"""Serve a page name from git repo (an old version of a page).
then return the reST source code
This function does not use any template it returns only plain text
.. note:: this is a bottle view
* this is a GET only method : you can not change a committed page
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
:gitref: (str) -- hexsha of the git commit to look into
Returns:
bottle response object or 404 error page
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
response.set_header('Content-Type', 'text/html; charset=utf-8')
if gitref is None:
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
content = file_handle.read()
else:
return abort(404)
else:
content = read_committed_file(gitref, name + '.rst')
if content:
return template('source_view',
type="history",
name=name,
extended_name='__source__',
is_repo=check_repo(),
history=commit_history("{0}.rst".format(name)),
gitref=gitref,
content=content.decode('utf-8'))
else:
return abort(404)
def view_history_source(name, gitref=None):
"""Serve a page name from git repo (an old version of a page).
then return the reST source code
This function does not use any template it returns only plain text
.. note:: this is a bottle view
* this is a GET only method : you can not change a committed page
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
:gitref: (str) -- hexsha of the git commit to look into
Returns:
bottle response object or 404 error page
"""
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
response.set_header('Content-Type', 'text/html; charset=utf-8')
if gitref is None:
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
content = file_handle.read()
else:
return abort(404)
else:
content = read_committed_file(gitref, name + '.rst')
if content:
return template('source_view',
type="history",
name=name,
extended_name='__source__',
is_repo=check_repo(),
history=commit_history("{0}.rst".format(name)),
gitref=gitref,
content=content.decode('utf-8'))
else:
return abort(404)
def view_meta_admonition(admonition_name, name=None):
"""List all found admonition from all the rst files found in directory.
view_meta_admonition is called by the 'meta' url: /__XXXXXXX__
where XXXXXXX represents and admonition name, like:
* todo
* warning
* danger
* ...
.. note:: this function may works for any docutils node, not only
admonition
Keyword Arguments:
:admonition_name: (str) -- name of the admonition
"""
print("meta admo: %s - %s" % (admonition_name, name))
admonition = None
if admonition_name == 'todo':
admonition = todo
elif admonition_name == 'done':
admonition = done
elif hasattr(nodes, admonition_name):
admonition = getattr(nodes, admonition_name)
else:
return abort(404)
doc2_content = ""
doc2_output, doc2_pub = docutils.core.publish_programmatically(
source_class=io.StringInput,
source=doc2_content,
source_path=None,
destination_class=io.StringOutput,
destination=None,
destination_path=None,
reader=None,
reader_name='standalone',
parser=None,
parser_name='restructuredtext',
writer=AttowikiWriter(),
writer_name=None,
settings=None,
settings_spec=None,
settings_overrides=None,
config_section=None,
enable_exit_status=False)
section1 = nodes.section("{0}_list_file".format(admonition_name))
doc2_pub.reader.document.append(section1)
title1 = nodes.title("{0} LIST".format(admonition_name.upper()),
"{0} LIST".format(admonition_name.upper()))
doc2_pub.reader.document.append(title1)
if name is None:
rst_files = [
filename[2:-4] for filename in sorted(glob.glob("./*.rst"))
]
rst_files.reverse()
else:
rst_files = [
filename[2:-4]
for filename in sorted(glob.glob("./{0}.rst".format(name)))
]
for file in rst_files:
file_title = False
file_handle = open(file + '.rst', 'r')
file_content = file_handle.read()
file_handle.close()
file_content = file_content.decode('utf-8')
output, pub = docutils.core.publish_programmatically(
source_class=io.StringInput,
source=file_content,
source_path=None,
destination_class=io.StringOutput,
destination=None,
destination_path=None,
reader=None,
reader_name='standalone',
parser=None,
parser_name='restructuredtext',
writer=None,
writer_name='html',
settings=None,
settings_spec=None,
settings_overrides=None,
config_section=None,
enable_exit_status=False)
my_settings = pub.get_settings()
parser = docutils.parsers.rst.Parser()
document = docutils.utils.new_document('test', my_settings)
parser.parse(file_content, document)
for node in document.traverse(admonition):
if not file_title:
file_title = True
# new section
section2 = nodes.section(file)
doc2_pub.reader.document.append(section2)
# add link to the originating file
paragraph = nodes.paragraph()
file_target = nodes.target(ids=[file],
names=[file],
refuri="/" + file)
file_ref = nodes.reference(file,
file,
name=file,
refuri="/" + file)
paragraph.append(nodes.Text("in "))
paragraph.append(file_ref)
paragraph.append(file_target)
paragraph.append(nodes.Text(":"))
doc2_pub.reader.document.append(paragraph)
# doc2_pub.reader.document.append(file_target)
doc2_pub.reader.document.append(node)
doc2_pub.apply_transforms()
doc2_pub.writer.write(doc2_pub.document, doc2_pub.destination)
doc2_pub.writer.assemble_parts()
if name is None:
display_file_name = '__{0}__'.format(admonition_name)
extended_name = None
else:
display_file_name = '{0}'.format(name)
extended_name = '__{0}__'.format(admonition_name)
return template('page',
type="view",
name=display_file_name,
extended_name=extended_name,
is_repo=check_repo(),
history=[],
gitref=None,
content=doc2_pub.writer.parts['html_body'])
def view_page(name=None):
"""Serve a page name.
.. note:: this is a bottle view
* if the view is called with the POST method, write the new page
content to the file, commit the modification and then display the
html rendering of the restructured text file
* if the view is called with the GET method, directly display the html
rendering of the restructured text file
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
OPTIONAL
if no filename is given, first try to find a "index.rst" file in the
directory and serve it. If not found, serve the meta page __index__
Returns:
bottle response object
"""
if request.method == 'POST':
if name is None:
# new file
if len(request.forms.filename) > 0:
name = request.forms.filename
if name is not None:
filename = "{0}.rst".format(name)
file_handle = open(filename, 'w')
file_handle.write(request.forms.content.encode('utf-8'))
file_handle.close()
add_file_to_repo(filename)
commit(filename)
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
if name is None:
# we try to find an index file
index_files = glob.glob("./[Ii][Nn][Dd][Ee][Xx].rst")
if len(index_files) == 0:
# not found
# redirect to __index__
return view_meta_index()
else:
name = index_files[0][2:-4]
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
html_body = publish_parts(file_handle.read(),
writer=AttowikiWriter(),
settings=None,
settings_overrides=None)['html_body']
history = commit_history("{0}.rst".format(name))
return template('page',
type="view",
name=name,
extended_name=None,
is_repo=check_repo(),
history=history,
gitref=None,
content=html_body)
else:
return static_file(name, '')
def view_meta_admonition(admonition_name, name=None):
"""List all found admonition from all the rst files found in directory
view_meta_admonition is called by the 'meta' url: /__XXXXXXX__
where XXXXXXX represents and admonition name, like:
* todo
* warning
* danger
* ...
.. note:: this function may works for any docutils node, not only
admonition
Keyword Arguments:
:admonition_name: (str) -- name of the admonition
"""
print("meta admo: %s - %s" % (admonition_name, name))
admonition = None
if admonition_name == 'todo':
admonition = todo
elif admonition_name == 'done':
admonition = done
elif hasattr(nodes, admonition_name):
admonition = getattr(nodes, admonition_name)
else:
return abort(404)
doc2_content = ""
doc2_output, doc2_pub = docutils.core.publish_programmatically(
source_class=io.StringInput,
source=doc2_content,
source_path=None,
destination_class=io.StringOutput,
destination=None, destination_path=None,
reader=None, reader_name='standalone',
parser=None, parser_name='restructuredtext',
writer=HisWriter(), writer_name=None,
settings=None, settings_spec=None,
settings_overrides=None,
config_section=None,
enable_exit_status=False)
section1 = nodes.section("{0}_list_file".format(admonition_name))
doc2_pub.reader.document.append(section1)
title1 = nodes.title("{0} LIST".format(admonition_name.upper()),
"{0} LIST".format(admonition_name.upper()))
doc2_pub.reader.document.append(title1)
if name is None:
rst_files = [filename[2:-4] for filename in sorted(
glob.glob("./*.rst"))]
rst_files.reverse()
else:
rst_files = [filename[2:-4] for filename in
sorted(glob.glob("./{0}.rst".format(name)))]
for file in rst_files:
file_title = False
file_handle = open(file + '.rst', 'r')
file_content = file_handle.read()
file_handle.close()
file_content = file_content.decode('utf-8')
output, pub = docutils.core.publish_programmatically(
source_class=io.StringInput, source=file_content,
source_path=None,
destination_class=io.StringOutput,
destination=None, destination_path=None,
reader=None, reader_name='standalone',
parser=None, parser_name='restructuredtext',
writer=None, writer_name='html',
settings=None, settings_spec=None,
settings_overrides=None,
config_section=None,
enable_exit_status=False)
my_settings = pub.get_settings()
parser = docutils.parsers.rst.Parser()
document = docutils.utils.new_document('test', my_settings)
parser.parse(file_content, document)
for node in document.traverse(admonition):
if not file_title:
file_title = True
# new section
section2 = nodes.section(file)
doc2_pub.reader.document.append(section2)
# add link to the originating file
paragraph = nodes.paragraph()
file_target = nodes.target(ids=[file],
names=[file],
refuri="/" + file)
file_ref = nodes.reference(file, file,
name=file,
refuri="/" + file)
paragraph.append(nodes.Text("in "))
paragraph.append(file_ref)
paragraph.append(file_target)
paragraph.append(nodes.Text(":"))
doc2_pub.reader.document.append(paragraph)
#doc2_pub.reader.document.append(file_target)
doc2_pub.reader.document.append(node)
doc2_pub.apply_transforms()
doc2_pub.writer.write(doc2_pub.document, doc2_pub.destination)
doc2_pub.writer.assemble_parts()
if name is None:
display_file_name = '__{0}__'.format(admonition_name)
extended_name = None
else:
display_file_name = '{0}'.format(name)
extended_name = '__{0}__'.format(admonition_name)
return template('page',
type="view",
name=display_file_name,
extended_name=extended_name,
is_repo=check_repo(),
history=[],
gitref=None,
content=doc2_pub.writer.parts['html_body'])
def view_page(name=None):
"""serve a page name
.. note:: this is a bottle view
* if the view is called with the POST method, write the new page
content to the file, commit the modification and then display the
html rendering of the restructured text file
* if the view is called with the GET method, directly display the html
rendering of the restructured text file
Keyword Arguments:
:name: (str) -- name of the rest file (without the .rst extension)
OPTIONAL
if no filename is given, first try to find a "index.rst" file in the
directory and serve it. If not found, serve the meta page __index__
Returns:
bottle response object
"""
if request.method == 'POST':
if name is None:
# new file
if len(request.forms.filename) > 0:
name = request.forms.filename
if name is not None:
filename = "{0}.rst".format(name)
file_handle = open(filename, 'w')
file_handle.write(request.forms.content.encode('utf-8'))
file_handle.close()
add_file_to_repo(filename)
commit(filename)
response.set_header('Cache-control', 'no-cache')
response.set_header('Pragma', 'no-cache')
if name is None:
# we try to find an index file
index_files = glob.glob("./[Ii][Nn][Dd][Ee][Xx].rst")
if len(index_files) == 0:
# not found
# redirect to __index__
return view_meta_index()
else:
name = index_files[0][2:-4]
files = glob.glob("{0}.rst".format(name))
if len(files) > 0:
file_handle = open(files[0], 'r')
html_body = publish_parts(file_handle.read(),
writer=HisWriter(),
settings=None,
settings_overrides=None)['html_body']
history = commit_history("{0}.rst".format(name))
return template('page',
type="view",
name=name,
extended_name=None,
is_repo=check_repo(),
history=history,
gitref=None,
content=html_body)
else:
return static_file(name, '')