def project_wiki_view(auth, wname, path=None, **kwargs):
node = kwargs['node'] or kwargs['project']
anonymous = has_anonymous_link(node, auth)
wiki_name = (wname or '').strip()
wiki_key = to_mongo_key(wiki_name)
wiki_page = node.get_wiki_page(wiki_name)
wiki_settings = node.get_addon('wiki')
can_edit = (
auth.logged_in
and not node.is_registration
and (
node.has_permission(auth.user, 'write')
or wiki_settings.is_publicly_editable
)
)
versions = _get_wiki_versions(node, wiki_name, anonymous=anonymous)
# Determine panels used in view
panels = {'view', 'edit', 'compare', 'menu'}
if request.args and set(request.args).intersection(panels):
panels_used = [panel for panel in request.args if panel in panels]
num_columns = len(set(panels_used).intersection({'view', 'edit', 'compare'}))
if num_columns == 0:
panels_used.append('view')
num_columns = 1
else:
panels_used = ['view', 'menu']
num_columns = 1
try:
view = wiki_utils.format_wiki_version(
version=request.args.get('view'),
num_versions=len(versions),
allow_preview=True,
)
compare = wiki_utils.format_wiki_version(
version=request.args.get('compare'),
num_versions=len(versions),
allow_preview=False,
)
except InvalidVersionError:
raise WIKI_INVALID_VERSION_ERROR
# Default versions for view and compare
version_settings = {
'view': view or ('preview' if 'edit' in panels_used else 'current'),
'compare': compare or 'previous',
}
# ensure home is always lower case since it cannot be renamed
if wiki_name.lower() == 'home':
wiki_name = 'home'
if wiki_page:
version = wiki_page.version
is_current = wiki_page.is_current
content = wiki_page.html(node)
use_python_render = wiki_page.rendered_before_update
else:
version = 'NA'
is_current = False
content = ''
use_python_render = False
if can_edit:
if wiki_key not in node.wiki_private_uuids:
wiki_utils.generate_private_uuid(node, wiki_name)
sharejs_uuid = wiki_utils.get_sharejs_uuid(node, wiki_name)
else:
if wiki_key not in node.wiki_pages_current and wiki_key != 'home':
raise WIKI_PAGE_NOT_FOUND_ERROR
if 'edit' in request.args:
if wiki_settings.is_publicly_editable:
raise HTTPError(http.UNAUTHORIZED)
raise HTTPError(http.FORBIDDEN)
sharejs_uuid = None
# Opens 'edit' panel when home wiki is empty
if not content and can_edit and wiki_name == 'home':
panels_used.append('edit')
ret = {
'wiki_id': wiki_page._primary_key if wiki_page else None,
'wiki_name': wiki_page.page_name if wiki_page else wiki_name,
'wiki_content': content,
'use_python_render': use_python_render,
'page': wiki_page,
'version': version,
'versions': versions,
'sharejs_uuid': sharejs_uuid or '',
'sharejs_url': settings.SHAREJS_URL,
'is_current': is_current,
'version_settings': version_settings,
'pages_current': _get_wiki_pages_current(node),
'category': node.category,
'panels_used': panels_used,
'num_columns': num_columns,
'urls': {
'api': _get_wiki_api_urls(node, wiki_name, {
'content': node.api_url_for('wiki_page_content', wname=wiki_name),
'draft': node.api_url_for('wiki_page_draft', wname=wiki_name),
}),
'web': _get_wiki_web_urls(node, wiki_name),
'gravatar': get_gravatar(auth.user, 25),
},
}
ret.update(_view_project(node, auth, primary=True))
ret['user']['can_edit_wiki_body'] = can_edit
return ret
def project_wiki_view(auth, wname, path=None, **kwargs):
node = kwargs['node'] or kwargs['project']
anonymous = has_anonymous_link(node, auth)
wiki_name = (wname or '').strip()
wiki_key = to_mongo_key(wiki_name)
wiki_page = node.get_wiki_page(wiki_name)
wiki_settings = node.get_addon('wiki')
can_edit = (
auth.logged_in
and not node.is_registration
and (
node.has_permission(auth.user, 'write')
or wiki_settings.is_publicly_editable
)
)
versions = _get_wiki_versions(node, wiki_name, anonymous=anonymous)
# Determine panels used in view
panels = {'view', 'edit', 'compare', 'menu'}
if request.args and set(request.args).intersection(panels):
panels_used = [panel for panel in request.args if panel in panels]
num_columns = len(set(panels_used).intersection({'view', 'edit', 'compare'}))
if num_columns == 0:
panels_used.append('view')
num_columns = 1
else:
panels_used = ['view', 'menu']
num_columns = 1
try:
view = wiki_utils.format_wiki_version(
version=request.args.get('view'),
num_versions=len(versions),
allow_preview=True,
)
compare = wiki_utils.format_wiki_version(
version=request.args.get('compare'),
num_versions=len(versions),
allow_preview=False,
)
except InvalidVersionError:
raise WIKI_INVALID_VERSION_ERROR
# ensure home is always lower case since it cannot be renamed
if wiki_name.lower() == 'home':
wiki_name = 'home'
if wiki_page:
version = wiki_page.version
is_current = wiki_page.is_current
content = wiki_page.html(node)
rendered_before_update = wiki_page.rendered_before_update
else:
version = 'NA'
is_current = False
content = ''
rendered_before_update = False
if can_edit:
if wiki_key not in node.wiki_private_uuids:
wiki_utils.generate_private_uuid(node, wiki_name)
sharejs_uuid = wiki_utils.get_sharejs_uuid(node, wiki_name)
else:
if wiki_key not in node.wiki_pages_current and wiki_key != 'home':
raise WIKI_PAGE_NOT_FOUND_ERROR
if 'edit' in request.args:
if wiki_settings.is_publicly_editable:
raise HTTPError(http.UNAUTHORIZED)
raise HTTPError(http.FORBIDDEN)
sharejs_uuid = None
# Opens 'edit' panel when home wiki is empty
if not content and can_edit and wiki_name == 'home':
panels_used.append('edit')
# Default versions for view and compare
version_settings = {
'view': view or ('preview' if 'edit' in panels_used else 'current'),
'compare': compare or 'previous',
}
ret = {
'wiki_id': wiki_page._primary_key if wiki_page else None,
'wiki_name': wiki_page.page_name if wiki_page else wiki_name,
'wiki_content': content,
'rendered_before_update': rendered_before_update,
'page': wiki_page,
'version': version,
'versions': versions,
'sharejs_uuid': sharejs_uuid or '',
'sharejs_url': settings.SHAREJS_URL,
'is_current': is_current,
'version_settings': version_settings,
'pages_current': _get_wiki_pages_current(node),
'category': node.category,
'panels_used': panels_used,
'num_columns': num_columns,
'urls': {
'api': _get_wiki_api_urls(node, wiki_name, {
'content': node.api_url_for('wiki_page_content', wname=wiki_name),
'draft': node.api_url_for('wiki_page_draft', wname=wiki_name),
}),
'web': _get_wiki_web_urls(node, wiki_name),
'gravatar': get_gravatar(auth.user, 25),
},
}
ret.update(_view_project(node, auth, primary=True))
ret['user']['can_edit_wiki_body'] = can_edit
return ret
def test_format_wiki_version(self):
assert_is_none(format_wiki_version(None, 5, False))
assert_is_none(format_wiki_version('', 5, False))
assert_equal(format_wiki_version('3', 5, False), 3)
assert_equal(format_wiki_version('4', 5, False), 'previous')
assert_equal(format_wiki_version('5', 5, False), 'current')
assert_equal(format_wiki_version('previous', 5, False), 'previous')
assert_equal(format_wiki_version('current', 5, False), 'current')
assert_equal(format_wiki_version('preview', 5, True), 'preview')
assert_equal(format_wiki_version('current', 0, False), 'current')
assert_equal(format_wiki_version('preview', 0, True), 'preview')
with assert_raises(InvalidVersionError):
format_wiki_version('1', 0, False)
with assert_raises(InvalidVersionError):
format_wiki_version('previous', 0, False)
with assert_raises(InvalidVersionError):
format_wiki_version('6', 5, False)
with assert_raises(InvalidVersionError):
format_wiki_version('0', 5, False)
with assert_raises(InvalidVersionError):
format_wiki_version('preview', 5, False)
with assert_raises(InvalidVersionError):
format_wiki_version('nonsense', 5, True)
def project_wiki_view(auth, wname, path=None, **kwargs):
node = kwargs["node"] or kwargs["project"]
anonymous = has_anonymous_link(node, auth)
wiki_name = (wname or "").strip()
wiki_key = to_mongo_key(wiki_name)
wiki_page = node.get_wiki_page(wiki_name)
wiki_settings = node.get_addon("wiki")
can_edit = (
auth.logged_in
and not node.is_registration
and (node.has_permission(auth.user, "write") or wiki_settings.is_publicly_editable)
)
versions = _get_wiki_versions(node, wiki_name, anonymous=anonymous)
# Determine panels used in view
panels = {"view", "edit", "compare", "menu"}
if request.args and set(request.args).intersection(panels):
panels_used = [panel for panel in request.args if panel in panels]
num_columns = len(set(panels_used).intersection({"view", "edit", "compare"}))
if num_columns == 0:
panels_used.append("view")
num_columns = 1
else:
panels_used = ["view", "menu"]
num_columns = 1
try:
view = wiki_utils.format_wiki_version(
version=request.args.get("view"), num_versions=len(versions), allow_preview=True
)
compare = wiki_utils.format_wiki_version(
version=request.args.get("compare"), num_versions=len(versions), allow_preview=False
)
except InvalidVersionError:
raise WIKI_INVALID_VERSION_ERROR
# Default versions for view and compare
version_settings = {
"view": view or ("preview" if "edit" in panels_used else "current"),
"compare": compare or "previous",
}
# ensure home is always lower case since it cannot be renamed
if wiki_name.lower() == "home":
wiki_name = "home"
if wiki_page:
version = wiki_page.version
is_current = wiki_page.is_current
content = wiki_page.html(node)
use_python_render = wiki_page.rendered_before_update
else:
version = "NA"
is_current = False
content = ""
use_python_render = False
if can_edit:
if wiki_key not in node.wiki_private_uuids:
wiki_utils.generate_private_uuid(node, wiki_name)
sharejs_uuid = wiki_utils.get_sharejs_uuid(node, wiki_name)
else:
if wiki_key not in node.wiki_pages_current and wiki_key != "home":
raise WIKI_PAGE_NOT_FOUND_ERROR
if "edit" in request.args:
if wiki_settings.is_publicly_editable:
raise HTTPError(http.UNAUTHORIZED)
raise HTTPError(http.FORBIDDEN)
sharejs_uuid = None
ret = {
"wiki_id": wiki_page._primary_key if wiki_page else None,
"wiki_name": wiki_page.page_name if wiki_page else wiki_name,
"wiki_content": content,
"use_python_render": use_python_render,
"page": wiki_page,
"version": version,
"versions": versions,
"sharejs_uuid": sharejs_uuid or "",
"sharejs_url": settings.SHAREJS_URL,
"is_current": is_current,
"version_settings": version_settings,
"pages_current": _get_wiki_pages_current(node),
"category": node.category,
"panels_used": panels_used,
"num_columns": num_columns,
"urls": {
"api": _get_wiki_api_urls(
node,
wiki_name,
{
"content": node.api_url_for("wiki_page_content", wname=wiki_name),
"draft": node.api_url_for("wiki_page_draft", wname=wiki_name),
},
),
"web": _get_wiki_web_urls(node, wiki_name),
"gravatar": get_gravatar(auth.user, 25),
},
}
ret.update(_view_project(node, auth, primary=True))
ret["user"]["can_edit_wiki_body"] = can_edit
return ret
def test_format_wiki_version(self):
assert_is_none(format_wiki_version(None, 5, False))
assert_is_none(format_wiki_version('', 5, False))
assert_equal(format_wiki_version('3', 5, False), 3)
assert_equal(format_wiki_version('4', 5, False), 'previous')
assert_equal(format_wiki_version('5', 5, False), 'current')
assert_equal(format_wiki_version('previous', 5, False), 'previous')
assert_equal(format_wiki_version('current', 5, False), 'current')
assert_equal(format_wiki_version('preview', 5, True), 'preview')
assert_equal(format_wiki_version('current', 0, False), 'current')
assert_equal(format_wiki_version('preview', 0, True), 'preview')
with assert_raises(InvalidVersionError):
format_wiki_version('1', 0, False)
with assert_raises(InvalidVersionError):
format_wiki_version('previous', 0, False)
with assert_raises(InvalidVersionError):
format_wiki_version('6', 5, False)
with assert_raises(InvalidVersionError):
format_wiki_version('0', 5, False)
with assert_raises(InvalidVersionError):
format_wiki_version('preview', 5, False)
with assert_raises(InvalidVersionError):
format_wiki_version('nonsense', 5, True)