refactor: added slugs to course and topics to make nice urls

- the slug is autogenerated from the title
- the slug of a topic is unique among all the topics of that course
This commit is contained in:
Anand Chitipothu
2021-04-06 15:49:17 +05:30
parent 6620ecf0c8
commit 175bd19a51
11 changed files with 121 additions and 83 deletions

View File

@@ -1,6 +1,5 @@
{% extends "templates/base.html" %}
{% block title %}{{ 'Courses' }}{% endblock %}
{% from "www/courses/macros/card.html" import course_card, topic_card %}
{% block head_include %}
<meta name="description" content="Courses" />
<meta name="keywords" content="Courses {{course.title}}" />
@@ -34,16 +33,16 @@
aria-selected="false">Discussions</a>
</li>
{% endif %}
</ul>
</ul>
</div>
<div class="tab-content">
<div class="tab-pane fade py-4 show active" role="tabpanel" id="home">
<div>{{ frappe.utils.md_to_html(course.description) }}</div>
<div class='container'>
<div>{{ frappe.utils.md_to_html(course.description) }}</div>
<div class="list-group">
{% for topic in course.topics %}
<div class="list-group-item">
<h5><a href="/courses/{{course.name}}/{{topic.name}}">{{topic.title}}</a></h5>
<h5><a href="/courses/{{course.slug}}/{{topic.slug}}">{{topic.title}}</a></h5>
<div>{{topic.preview | markdown }}</div>
</div>
{% endfor %}

View File

@@ -16,14 +16,15 @@ def get_context(context):
context.current_batch = context.memberships[0].batch
context.author = context.memberships[0].member
def get_course(name):
course = frappe.db.get_value('LMS Course', name,
['name', 'title', 'description'], as_dict=1)
def get_course(slug):
course = frappe.db.get_value('LMS Course', {"slug": slug},
['name', 'slug', 'title', 'description'], as_dict=1)
course['topics'] = frappe.db.get_all('LMS Topic',
filters={
'course': name
'course': course['name']
},
fields=['name', 'title', 'preview'],
fields=['name', 'slug', 'title', 'preview'],
order_by='creation'
)
return course

View File

@@ -1,24 +1,34 @@
{% extends "templates/base.html" %}
{% block title %}{{ 'Courses' }}{% endblock %}
{% from "www/courses/macros/card.html" import course_card %}
{% block head_include %}
<meta name="description" content="{{ 'Courses' }}" />
<meta name="keywords" content="Courses" />
<style>
</style>
<meta name="description" content="{{ 'Courses' }}" />
<meta name="keywords" content="Courses" />
<style>
</style>
{% endblock %}
{% block content %}
<section class="top-section" style="padding: 1rem 0rem;">
<div class='container pb-5'>
<h1>{{ 'Courses' }}</h1>
</div>
<div class='container'>
<div class="row mt-5">
{% for course in courses %}
{{ course_card(course) }}
{% endfor %}
</div>
</div>
<div class='container pb-5'>
<h1>{{ 'Courses' }}</h1>
</div>
<div class='container'>
<div class="row mt-5">
{% for course in courses %}
{{ course_card(course) }}
{% endfor %}
</div>
</div>
</section>
{% endblock %}
{% endblock %}
{% macro course_card(course) %}
<div class="card mb-5 w-100">
<div class="card-body">
<h5 class="card-title"><a href="/courses/{{course.slug}}">{{course.title}}</a></h5>
<p class="card-text">{{ frappe.utils.md_to_html(course.description[:250]) }}</p>
<a href="/courses/{{course.slug}}" class="card-link">See more &rarr;</a>
</div>
</div>
{% endmacro %}

View File

@@ -7,6 +7,6 @@ def get_context(context):
def get_courses():
courses = frappe.get_all(
"LMS Course",
fields=['name', 'title', 'description']
fields=['name', 'slug', 'title', 'description']
)
return courses

View File

@@ -1,19 +0,0 @@
{% macro course_card(course) %}
<div class="card mb-5 w-100">
<div class="card-body">
<h5 class="card-title"><a href="/courses/{{course.name}}">{{course.title}}</a></h5>
<p class="card-text">{{ frappe.utils.md_to_html(course.description[:250]) }}</p>
<a href="/courses/{{course.name}}" class="card-link">See more &rarr;</a>
</div>
</div>
{% endmacro %}
{% macro topic_card(course, topic) %}
<div class="card mb-5 w-100">
<div class="card-body">
<h5 class="card-title"><a href="/courses/{{course.name}}/{{topic.name}}">{{topic.title}}</a></h5>
<p class="card-text">{{topic.description}}</p>
</div>
</div>
{% endmacro %}

View File

@@ -24,7 +24,7 @@
<nav aria-label="breadcrumb">
<ol class="breadcrumb">
<li class="breadcrumb-item" aria-current="page"><a href="/courses">Courses</a></li>
<li class="breadcrumb-item" aria-current="page"><a href="/courses/{{course.name}}">{{course.title}}</a></li>
<li class="breadcrumb-item" aria-current="page"><a href="/courses/{{course.slug}}">{{course.title}}</a></li>
</ol>
</nav>

View File

@@ -4,38 +4,30 @@ def get_context(context):
context.no_cache = 1
try:
course_name = get_queryparam("course", '/courses')
context.course = get_course(course_name)
topic_name = get_queryparam("topic", '/courses/' + course_name)
context.topic = get_topic(course_name, topic_name)
context.livecode_url = get_livecode_url()
except frappe.DoesNotExistError:
course_slug = frappe.form_dict['course']
topic_slug = frappe.form_dict['topic']
except KeyError:
context.template = 'www/404.html'
return
course = get_course(course_slug)
topic = course and course.get_topic(topic_slug)
if not topic:
context.template = 'www/404.html'
return
context.course = course
context.topic = topic
context.livecode_url = get_livecode_url()
def notfound(context):
context.template = 'www/404.html'
def get_livecode_url():
doc = frappe.get_doc("LMS Settings")
return doc.livecode_url
def get_queryparam(name, redirect_when_not_found):
try:
return frappe.form_dict[name]
except KeyError:
frappe.local.flags.redirect_location = redirect_when_not_found
raise frappe.Redirect
def get_course(name):
try:
course = frappe.get_doc('LMS Course', name)
except frappe.DoesNotExistError:
raise
return course
def get_topic(course_name, topic_name):
try:
topic = frappe.get_doc('LMS Topic', topic_name)
except frappe.DoesNotExistError:
raise
if topic.course != course_name:
raise frappe.DoesNotExistError()
return topic
def get_course(slug):
course = frappe.db.get_value('LMS Course', {"slug": slug}, ["name"], as_dict=1)
return course and frappe.get_doc('LMS Course', course['name'])