135 lines
4.2 KiB
Python
135 lines
4.2 KiB
Python
"""
|
|
This file contains view functions for wrapping the django-wiki.
|
|
"""
|
|
|
|
|
|
import logging
|
|
import re
|
|
|
|
from django.conf import settings
|
|
from django.shortcuts import redirect
|
|
from django.utils.translation import ugettext as _
|
|
from opaque_keys.edx.keys import CourseKey
|
|
from wiki.core.exceptions import NoRootURL
|
|
from wiki.models import Article, URLPath
|
|
|
|
from lms.djangoapps.course_wiki.utils import course_wiki_slug
|
|
from lms.djangoapps.courseware.courses import get_course_by_id
|
|
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
|
|
from openedx.core.djangolib.markup import Text
|
|
from openedx.features.enterprise_support.api import data_sharing_consent_required
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
def root_create(request):
|
|
"""
|
|
In the edX wiki, we don't show the root_create view. Instead, we
|
|
just create the root automatically if it doesn't exist.
|
|
"""
|
|
root = get_or_create_root()
|
|
return redirect('wiki:get', path=root.path)
|
|
|
|
|
|
@data_sharing_consent_required
|
|
def course_wiki_redirect(request, course_id, wiki_path=""):
|
|
"""
|
|
This redirects to whatever page on the wiki that the course designates
|
|
as it's home page. A course's wiki must be an article on the root (for
|
|
example, "/6.002x") to keep things simple.
|
|
"""
|
|
course = get_course_by_id(CourseKey.from_string(course_id))
|
|
course_slug = course_wiki_slug(course)
|
|
|
|
valid_slug = True
|
|
if not course_slug:
|
|
log.exception("This course is improperly configured. The slug cannot be empty.")
|
|
valid_slug = False
|
|
if re.match(r'^[-\w\.]+$', course_slug) is None:
|
|
log.exception("This course is improperly configured. The slug can only contain letters, numbers, periods or hyphens.") # lint-amnesty, pylint: disable=line-too-long
|
|
valid_slug = False
|
|
|
|
if not valid_slug:
|
|
return redirect("wiki:get", path="")
|
|
|
|
try:
|
|
urlpath = URLPath.get_by_path(wiki_path or course_slug, select_related=True)
|
|
|
|
results = list(Article.objects.filter(id=urlpath.article.id))
|
|
if results:
|
|
article = results[0]
|
|
else:
|
|
article = None
|
|
|
|
except (NoRootURL, URLPath.DoesNotExist):
|
|
# We will create it in the next block
|
|
urlpath = None
|
|
article = None
|
|
|
|
if not article:
|
|
# create it
|
|
root = get_or_create_root()
|
|
|
|
if urlpath:
|
|
# Somehow we got a urlpath without an article. Just delete it and
|
|
# recerate it.
|
|
urlpath.delete()
|
|
|
|
content = Text(
|
|
# Translators: this string includes wiki markup. Leave the ** and the _ alone.
|
|
_("This is the wiki for **{organization}**'s _{course_name}_.")
|
|
).format(
|
|
organization=course.display_org_with_default,
|
|
course_name=course.display_name_with_default,
|
|
)
|
|
urlpath = URLPath.create_article(
|
|
root,
|
|
course_slug,
|
|
title=course.display_name_with_default,
|
|
content=content,
|
|
user_message=_("Course page automatically created."),
|
|
user=None,
|
|
ip_address=None,
|
|
article_kwargs={'owner': None,
|
|
'group': None,
|
|
'group_read': True,
|
|
'group_write': True,
|
|
'other_read': True,
|
|
'other_write': True,
|
|
})
|
|
|
|
return redirect("wiki:get", path=urlpath.path)
|
|
|
|
|
|
def get_or_create_root():
|
|
"""
|
|
Returns the root article, or creates it if it doesn't exist.
|
|
"""
|
|
try:
|
|
root = URLPath.root()
|
|
if not root.article:
|
|
root.delete()
|
|
raise NoRootURL
|
|
return root
|
|
except NoRootURL:
|
|
pass
|
|
|
|
starting_content = "\n".join((
|
|
_("Welcome to the {platform_name} Wiki").format(
|
|
platform_name=configuration_helpers.get_value('PLATFORM_NAME', settings.PLATFORM_NAME),
|
|
),
|
|
"===",
|
|
_("Visit a course wiki to add an article."),
|
|
))
|
|
|
|
root = URLPath.create_root(title=_("Wiki"), content=starting_content)
|
|
article = root.article
|
|
article.group = None
|
|
article.group_read = True
|
|
article.group_write = False
|
|
article.other_read = True
|
|
article.other_write = False
|
|
article.save()
|
|
|
|
return root
|