Skip to content

E
edx-platform
Commit e0c7228d by E. Kolpakov
Options

Quality, safe template linter and test fixes: 

* Safe template linter reports zero violations on modified files
* Removed some (or most) coffeescript-genereated returns
* Big HTML chunks in JS converted to underscore templates
* Markdown processor - safe tempate linter compatibility
* Fixed double escaping HTML tags in code blocks caused by passing it through postMathJaxProcessor twice
parent 8d1e10bd
Showing with 148 additions and 118 deletions
common/static/common/js/discussion/discussion_router.js
......@@ -93,20 +93,17 @@
DiscussionRouter.prototype.allThreads = function() {
this.nav.updateSidebar();
return this.nav.goHome();
this.nav.goHome();
};
DiscussionRouter.prototype.setActiveThread = function() {
if (this.thread) {
return this.nav.setActiveThread(this.thread.get("id"));
} else {
return this.nav.goHome();
this.nav.setActiveThread(this.thread.get("id"));
}
};
DiscussionRouter.prototype.showThread = function(forum_name, thread_id) {
var self;
self = this;
var self = this;
this.thread = this.discussion.get(thread_id);
if (this.thread) {
......@@ -124,11 +121,13 @@
self.renderThreadView();
}).fail(function(xhr) {
// otherwise display error message and navigate to all threads view
var errorMessage = (xhr.status === 404) ?
gettext("The thread you selected has been deleted. Please select another thread.") :
gettext("We had some trouble loading more responses. Please try again.");
DiscussionUtil.discussionAlert(gettext("Sorry"), errorMessage);
var errorMsg;
if (xhr.status === 404) {
errorMsg = gettext("The thread you selected has been deleted. Please select another thread.");
} else {
errorMsg = gettext("We had some trouble loading more responses. Please try again.");
}
DiscussionUtil.discussionAlert(gettext("Sorry"), errorMsg);
this.allThreads();
});
};
......@@ -162,23 +161,23 @@
this.main.on("thread:responses:rendered", function() {
return self.nav.updateSidebar();
});
return this.thread.on("thread:thread_type_updated", this.showMain);
this.thread.on("thread:thread_type_updated", this.showMain);
};
DiscussionRouter.prototype.navigateToThread = function(thread_id) {
var thread, targetThreadRoute;
thread = this.discussion.get(thread_id);
targetThreadRoute = getSingleThreadRoute(thread.get("commentable_id"), thread_id);
this.navigate(targetThreadRoute, { trigger: true});
this.navigate(targetThreadRoute, {trigger: true});
};
DiscussionRouter.prototype.navigateToAllThreads = function() {
this.navigate(allThreadsRoute, { trigger: true });
this.navigate(allThreadsRoute, {trigger: true});
};
DiscussionRouter.prototype.showNewPost = function() {
var self = this;
return $('.forum-content').fadeOut({
$('.forum-content').fadeOut({
duration: 200,
complete: function() {
return self.newPost.fadeIn(200).focus();
......@@ -187,7 +186,7 @@
};
DiscussionRouter.prototype.hideNewPost = function() {
return this.newPost.fadeOut({
this.newPost.fadeOut({
duration: 200,
complete: function() {
return $('.forum-content').fadeIn(200).find('.thread-wrapper').focus();
......
common/static/common/js/discussion/views/discussion_content_view.js
......@@ -271,20 +271,22 @@
return $button.toggleClass("is-checked", endorsed);
},
votes: function(votes) {
var button, numVotes, selector, votesHtml, votesCountMsg;
var button, numVotes, selector, votesText, votesCountMsg;
selector = ".action-vote";
this.updateButtonState(selector, window.user.voted(this.model));
button = this.$el.find(selector);
numVotes = votes.up_count;
votesCountMsg = ngettext(
"there is currently %(numVotes)s vote", "there are currently %(numVotes)s votes", numVotes
"there is currently {numVotes} vote", "there are currently {numVotes} votes", numVotes
);
button.find(".js-sr-vote-count").html(interpolate(votesCountMsg, {numVotes: numVotes }, true));
votesHtml = interpolate(ngettext("%(numVotes)s Vote", "%(numVotes)s Votes", numVotes), {
numVotes: numVotes
}, true);
button.find(".vote-count").html(votesHtml);
return this.$el.find('.display-vote .vote-count').html(votesHtml);
button.find(".js-sr-vote-count").empty().text(
edx.StringUtils.interpolate(votesCountMsg, {numVotes: numVotes })
);
votesText = edx.StringUtils.interpolate(
ngettext("{numVotes} Vote", "{numVotes} Votes", numVotes),
{ numVotes: numVotes });
button.find(".vote-count").empty().text(votesText);
this.$el.find('.display-vote .vote-count').empty().text(votesText);
},
pinned: function(pinned) {
this.updateButtonState(".action-pin", pinned);
......
common/static/common/js/discussion/views/discussion_thread_edit_view.js
......@@ -25,13 +25,14 @@
},
render: function() {
var threadTypeTemplate,
formId = _.uniqueId("form-");
this.template = _.template($('#thread-edit-template').html());
this.$el.html(this.template(this.model.toJSON())).appendTo(this.container);
this.submitBtn = this.$('.post-update');
threadTypeTemplate = _.template($("#thread-type-template").html());
this.addField(threadTypeTemplate({form_id: formId}));
var formId = _.uniqueId("form-"),
threadTypeTemplate = edx.HtmlUtils.template($("#thread-type-template").html()),
$threadTypeSelector = $(threadTypeTemplate({form_id: formId}).toString()),
mainTemplate = edx.HtmlUtils.template($('#thread-edit-template').html());
edx.HtmlUtils.setHtml(this.$el, mainTemplate(this.model.toJSON()));
this.container.append(this.$el);
this.$submitBtn = this.$('.post-update');
this.addField($threadTypeSelector);
this.$("#" + formId + "-post-type-" + this.threadType).attr('checked', true);
// Only allow the topic field for course threads, as standalone threads
// cannot be moved.
......@@ -46,8 +47,8 @@
return this;
},
addField: function(fieldView) {
this.$('.forum-edit-post-form-wrapper').append(fieldView);
addField: function($fieldView) {
this.$('.forum-edit-post-form-wrapper').append($fieldView);
return this;
},
......@@ -69,8 +70,8 @@
}
return DiscussionUtil.safeAjax({
$elem: this.submitBtn,
$loading: this.submitBtn,
$elem: this.$submitBtn,
$loading: this.$submitBtn,
url: DiscussionUtil.urlFor('update_thread', this.model.id),
type: 'POST',
dataType: 'json',
......
common/static/common/js/discussion/views/discussion_thread_profile_view.js
......@@ -28,7 +28,7 @@
}
DiscussionThreadProfileView.prototype.render = function() {
var element, params;
var params;
this.convertMath();
this.abbreviateBody();
params = $.extend(this.model.toJSON(), {
......@@ -42,26 +42,24 @@
}
});
}
this.$el.html(_.template($("#profile-thread-template").html())(params));
edx.HtmlUtils.setHtml(
this.$el,
edx.HtmlUtils.template($("#profile-thread-template").html())(params)
);
this.$("span.timeago").timeago();
element = this.$(".post-body");
if (typeof MathJax !== "undefined" && MathJax !== null) {
MathJax.Hub.Queue(["Typeset", MathJax.Hub, element[0]]);
}
DiscussionUtil.typesetMathJax(this.$(".post-body"));
return this;
};
DiscussionThreadProfileView.prototype.convertMath = function() {
return this.model.set(
'markdownBody',
DiscussionUtil.postMathJaxProcessor(DiscussionUtil.markdownWithHighlight(this.model.get('body')))
);
var htmlSnippet = DiscussionUtil.markdownWithHighlight(this.model.get('body'));
this.model.set('markdownBody', htmlSnippet);
};
DiscussionThreadProfileView.prototype.abbreviateBody = function() {
var abbreviated;
abbreviated = DiscussionUtil.abbreviateHTML(this.model.get('markdownBody'), 140);
return this.model.set('abbreviatedBody', abbreviated);
this.model.set('abbreviatedBody', abbreviated);
};
return DiscussionThreadProfileView;
......
common/static/common/js/discussion/views/discussion_thread_show_view.js
......@@ -38,7 +38,6 @@
DiscussionThreadShowView.prototype.renderTemplate = function() {
var context;
this.template = _.template($("#thread-show-template").html());
context = $.extend({
mode: this.mode,
flagged: this.model.isFlagged(),
......@@ -46,27 +45,25 @@
cid: this.model.cid,
readOnly: $('.discussion-module').data('read-only')
}, this.model.attributes);
return this.template(context);
return edx.HtmlUtils.template($("#thread-show-template").html())(context);
};
DiscussionThreadShowView.prototype.render = function() {
this.$el.html(this.renderTemplate());
edx.HtmlUtils.setHtml(
this.$el,
this.renderTemplate()
);
this.delegateEvents();
this.renderAttrs();
this.$("span.timeago").timeago();
this.convertMath();
this.highlight(this.$(".post-body"));
this.highlight(this.$("h1,h3"));
this.$(".post-body");
this.$("h1,h3");
return this;
};
DiscussionThreadShowView.prototype.convertMath = function() {
var element;
element = this.$(".post-body");
element.html(DiscussionUtil.postMathJaxProcessor(DiscussionUtil.markdownWithHighlight(element.text())));
if (typeof MathJax !== "undefined" && MathJax !== null) {
return MathJax.Hub.Queue(["Typeset", MathJax.Hub, element[0]]);
}
DiscussionUtil.convertMath(this.$(".post-body"));
};
DiscussionThreadShowView.prototype.edit = function(event) {
......@@ -77,12 +74,6 @@
return this.trigger("thread:_delete", event);
};
DiscussionThreadShowView.prototype.highlight = function(el) {
if (el.html()) {
return el.html(el.html().replace(/&lt;mark&gt;/g, "<mark>").replace(/&lt;\/mark&gt;/g, "</mark>"));
}
};
return DiscussionThreadShowView;
})(DiscussionContentShowView);
......
common/static/common/js/discussion/views/discussion_thread_view.js
......@@ -134,7 +134,9 @@
DiscussionThreadView.prototype.render = function() {
var self = this;
this.$el.html(this.renderTemplate());
var $element = $(this.renderTemplate());
this.$el.empty();
this.$el.append($element);
this.delegateEvents();
this.renderShowView();
this.renderAttrs();
......@@ -216,7 +218,7 @@
}
};
DiscussionThreadView.prototype.loadResponses = function(responseLimit, elem, firstLoad) {
DiscussionThreadView.prototype.loadResponses = function(responseLimit, $elem, firstLoad) {
var takeFocus,
self = this;
takeFocus = this.mode === "tab" ? false : true;
......@@ -228,8 +230,8 @@
resp_skip: this.responses.size(),
resp_limit: responseLimit ? responseLimit : void 0
},
$elem: elem,
$loading: elem,
$elem: $elem,
$loading: $elem,
takeFocus: takeFocus,
complete: function() {
self.responsesRequest = null;
......@@ -280,20 +282,20 @@
};
DiscussionThreadView.prototype.renderResponseCountAndPagination = function(responseTotal) {
var buttonText, loadMoreButton, responseCountFormat, responseLimit, responsePagination,
var buttonText, $loadMoreButton, responseCountFormat, responseLimit, responsePagination,
responsesRemaining, showingResponsesText, self = this;
if (this.isQuestion() && this.markedAnswers.length !== 0) {
responseCountFormat = ngettext(
"%(numResponses)s other response", "%(numResponses)s other responses", responseTotal
"{numResponses} other response", "{numResponses} other responses", responseTotal
);
} else {
responseCountFormat = ngettext(
"%(numResponses)s response", "%(numResponses)s responses", responseTotal
"{numResponses} response", "{numResponses} responses", responseTotal
);
}
this.$el.find(".response-count").html(interpolate(responseCountFormat, {
numResponses: responseTotal
}, true));
this.$el.find(".response-count").text(
edx.StringUtils.interpolate(responseCountFormat, {numResponses: responseTotal}, true)
);
responsePagination = this.$el.find(".response-pagination");
responsePagination.empty();
if (responseTotal > 0) {
......@@ -302,9 +304,9 @@
showingResponsesText = gettext("Showing all responses");
}
else {
showingResponsesText = interpolate(
showingResponsesText = edx.StringUtils.interpolate(
ngettext(
"Showing first response", "Showing first %(numResponses)s responses",
"Showing first response", "Showing first {numResponses} responses",
this.responses.size()
),
{ numResponses: this.responses.size() },
......@@ -313,22 +315,22 @@
}
responsePagination.append($("<span>")
.addClass("response-display-count").html(_.escape(showingResponsesText)));
.addClass("response-display-count").text(showingResponsesText));
if (responsesRemaining > 0) {
if (responsesRemaining < SUBSEQUENT_RESPONSE_PAGE_SIZE) {
responseLimit = null;
buttonText = gettext("Load all responses");
} else {
responseLimit = SUBSEQUENT_RESPONSE_PAGE_SIZE;
buttonText = interpolate(gettext("Load next %(numResponses)s responses"), {
buttonText = edx.StringUtils.interpolate(gettext("Load next {numResponses} responses"), {
numResponses: responseLimit
}, true);
}
loadMoreButton = $("<button>").addClass("load-response-button").html(_.escape(buttonText));
loadMoreButton.click(function() {
return self.loadResponses(responseLimit, loadMoreButton);
$loadMoreButton = $("<button>").addClass("load-response-button").text(buttonText);
$loadMoreButton.click(function() {
return self.loadResponses(responseLimit, $loadMoreButton);
});
return responsePagination.append(loadMoreButton);
return responsePagination.append($loadMoreButton);
}
}
};
......
common/static/common/js/discussion/views/response_comment_show_view.js
......@@ -37,12 +37,14 @@
ResponseCommentShowView.prototype.tagName = "li";
ResponseCommentShowView.prototype.render = function() {
this.template = _.template($("#response-comment-show-template").html());
this.$el.html(this.template(_.extend({
var template = edx.HtmlUtils.template($("#response-comment-show-template").html());
var context = _.extend({
cid: this.model.cid,
author_display: this.getAuthorDisplay(),
readOnly: $('.discussion-module').data('read-only')
}, this.model.attributes)));
}, this.model.attributes);
edx.HtmlUtils.setHtml(this.$el, template(context));
this.delegateEvents();
this.renderAttrs();
this.$el.find(".timeago").timeago();
......@@ -52,22 +54,25 @@
};
ResponseCommentShowView.prototype.addReplyLink = function() {
var html, name, p, _ref;
var html, name;
if (this.model.hasOwnProperty('parent')) {
name = (_ref = this.model.parent.get('username')) !== null ? _ref : gettext("anonymous");
html = "<a href='#comment_" + this.model.parent.id + "'>@" + name + "</a>: ";
p = this.$('.response-body p:first');
return p.prepend(html);
name = this.model.parent.get('username') || gettext("anonymous");
html = edx.HtmlUtils.interpolateHtml(
edx.HtmlUtils.HTML("<a href='#comment_{parent_id}'>@{name}</a>: "),
{
parent_id: this.model.parent.id,
name: name
}
);
return edx.HtmlUtils.prepend(
this.$('.response-body p:first'),
html
);
}
};
ResponseCommentShowView.prototype.convertMath = function() {
var body;
body = this.$el.find(".response-body");
body.html(DiscussionUtil.postMathJaxProcessor(DiscussionUtil.markdownWithHighlight(body.text())));
if (typeof MathJax !== "undefined" && MathJax !== null) {
return MathJax.Hub.Queue(["Typeset", MathJax.Hub, body[0]]);
}
DiscussionUtil.convertMath(this.$el.find(".response-body"));
};
ResponseCommentShowView.prototype._delete = function(event) {
......
common/static/common/js/discussion/views/thread_response_show_view.js
......@@ -33,19 +33,18 @@
};
ThreadResponseShowView.prototype.renderTemplate = function() {
var context;
this.template = _.template($("#thread-response-show-template").html());
var template = edx.HtmlUtils.template($("#thread-response-show-template").html()),
context = _.extend({
cid: this.model.cid,
author_display: this.getAuthorDisplay(),
endorser_display: this.getEndorserDisplay(),
readOnly: $('.discussion-module').data('read-only')
}, this.model.attributes);
return this.template(context);
return template(context);
};
ThreadResponseShowView.prototype.render = function() {
this.$el.html(this.renderTemplate());
edx.HtmlUtils.setHtml(this.$el, this.renderTemplate());
this.delegateEvents();
this.renderAttrs();
this.$el.find(".posted-details .timeago").timeago();
......@@ -54,12 +53,7 @@
};
ThreadResponseShowView.prototype.convertMath = function() {
var element;
element = this.$(".response-body");
element.html(DiscussionUtil.postMathJaxProcessor(DiscussionUtil.markdownWithHighlight(element.text())));
if (typeof MathJax !== "undefined" && MathJax !== null) {
return MathJax.Hub.Queue(["Typeset", MathJax.Hub, element[0]]);
}
DiscussionUtil.convertMath(this.$(".response-body"));
};
ThreadResponseShowView.prototype.edit = function(event) {
......
common/static/common/js/spec/discussion/view/discussion_thread_list_view_spec.js
......@@ -269,7 +269,7 @@
}).get()).toEqual(expectedMessages);
};
getAlertMessagesAndClasses = function () {
getAlertMessagesAndClasses = function() {
return $(".search-alert").map(function() {
return {
text: $('.message', this).html(),
......
common/static/common/js/spec_helpers/discussion_spec_helper.js
......@@ -72,12 +72,12 @@
'thread-response-edit', 'response-comment-show', 'response-comment-edit', 'thread-list-item',
'discussion-home', 'search-alert', 'new-post', 'thread-type', 'new-post-menu-entry',
'new-post-menu-category', 'topic', 'post-user-display', 'inline-discussion', 'pagination',
'user-profile', 'profile-thread'
'user-profile', 'profile-thread', 'customwmd-prompt', 'nav-loading'
];
templateNamesNoTrailingTemplate = [
'forum-action-endorse', 'forum-action-answer', 'forum-action-follow', 'forum-action-vote',
'forum-action-report', 'forum-action-pin', 'forum-action-close', 'forum-action-edit',
'forum-action-delete', 'forum-actions'
'forum-action-delete', 'forum-actions', 'alert-popup', 'nav-load-more-link'
];
for (_i = 0, _len = templateNames.length; _i < _len; _i++) {
templateName = templateNames[_i];
......
common/static/common/templates/discussion/alert-popup.underscore 0 → 100644
<div class='modal' role='alertdialog' id='discussion-alert' aria-describedby='discussion-alert-message'>
<div class='inner-wrapper discussion-alert-wrapper'>
<button class='close-modal dismiss' title='<%- gettext("Close") %>''>
<span class='icon fa fa-times' aria-hidden='true'></span>
</button>
<header>
<h2/></h2>
<hr/>
</header>
<p id='discussion-alert-message'></p>
<hr/>
<button class='dismiss'><%- gettext("OK") %></button>
</div>
</div>
common/static/common/templates/discussion/nav-load-more-link.underscore 0 → 100644
<li class='forum-nav-load-more'>
<a href='#' class='forum-nav-load-more-link'>
<%- gettext("Load more") %>
</a>
</li>
common/static/common/templates/discussion/nav-loading.underscore 0 → 100644
<div class="forum-nav-loading" tabindex="0">
<span class="icon fa fa-spinner fa-spin"/>
<span class="sr" role="alert"><%- srText %></span>
</div>
common/static/common/templates/discussion/search-alert.underscore
<div class="search-alert <%= css_class %>" id="search-alert-<%- cid %>">
<div class="search-alert <%- css_class %>" id="search-alert-<%- cid %>">
<div class="search-alert-content">
<p class="message"><%= message %></p>
<p class="message"><%= HtmlUtils.ensureHtml(messageHtml) %></p>
</div>
<div class="search-alert-controls">
......
common/static/karma_common.conf.js
......@@ -35,6 +35,8 @@ var options = {
{pattern: 'common/js/vendor/backbone.js', included: true},
{pattern: 'edx-ui-toolkit/js/utils/global-loader.js', included: true},
{pattern: 'edx-ui-toolkit/js/utils/string-utils.js', included: true},
{pattern: 'edx-ui-toolkit/js/utils/html-utils.js', included: true},
{pattern: 'js/vendor/jasmine-imagediff.js', included: true},
{pattern: 'common/js/spec_helpers/jasmine-extensions.js', included: true},
......
lms/templates/discussion/_underscore_templates.html
<%page expression_filter="h"/>
<%namespace name='static' file='../static_content.html'/>
<%! import json %>
<%! from openedx.core.djangolib.js_utils import js_escaped_string %>
<script type="text/javascript">
window.PLATFORM_NAME = ${json.dumps(settings.PLATFORM_NAME)};
window.ENABLE_DISCUSSION_HOME_PANEL = ${json.dumps(settings.FEATURES.get('ENABLE_DISCUSSION_HOME_PANEL', False))};
window.PLATFORM_NAME = "${settings.PLATFORM_NAME | n, js_escaped_string}";
% if settings.FEATURES.get('ENABLE_DISCUSSION_HOME_PANEL', False):
window.ENABLE_DISCUSSION_HOME_PANEL = true;
% else:
window.ENABLE_DISCUSSION_HOME_PANEL = false;
% endif
</script>
<%
......@@ -11,7 +16,14 @@ template_names = [
'thread', 'thread-show', 'thread-edit', 'thread-response', 'thread-response-show', 'thread-response-edit',
'response-comment-show', 'response-comment-edit', 'thread-list-item', 'discussion-home', 'search-alert',
'new-post', 'thread-type', 'new-post-menu-entry', 'new-post-menu-category', 'topic', 'post-user-display',
'inline-discussion', 'pagination', 'user-profile', 'profile-thread', 'customwmd-prompt'
'inline-discussion', 'pagination', 'user-profile', 'profile-thread', 'customwmd-prompt', 'nav-loading'
]
## same, but without trailing "-template" in script ID - these templates does not contain any free variables
template_names_no_suffix = [
'forum-action-endorse', 'forum-action-answer', 'forum-action-follow', 'forum-action-vote', 'forum-action-report',
'forum-action-pin', 'forum-action-close', 'forum-action-edit', 'forum-action-delete', 'forum-actions',
'alert-popup', 'nav-load-more-link'
]
%>
......@@ -21,8 +33,8 @@ template_names = [
</script>
% endfor
## same, but without trailing "-template" in script ID
% for template_name in ['forum-action-endorse', 'forum-action-answer', 'forum-action-follow', 'forum-action-vote', 'forum-action-report', 'forum-action-pin', 'forum-action-close', 'forum-action-edit', 'forum-action-delete', 'forum-actions']:
% for template_name in template_names_no_suffix:
<script aria-hidden="true" type="text/template" id="${template_name}">
<%static:include path="common/templates/discussion/${template_name}.underscore" />
</script>
......
lms/templates/discussion/user_profile.html
<%inherit file="../main.html" />
<%page expression_filter="h"/>
<%namespace name='static' file='../static_content.html'/>
<%!
from django.utils.translation import ugettext as _
......@@ -6,7 +7,7 @@ from django.template.defaultfilters import escapejs
%>
<%block name="bodyclass">discussion</%block>
<%block name="pagetitle">${_("Discussion - {course_number}").format(course_number=course.display_number_with_default) | h}</%block>
<%block name="pagetitle">${_("Discussion - {course_number}").format(course_number=course.display_number_with_default)}</%block>
<%block name="headextra">
<%static:css group='style-course-vendor'/>
......@@ -33,7 +34,7 @@ from django.template.defaultfilters import escapejs
</nav>
</section>
<section class="course-content container discussion-user-threads" data-course-id="${course.id | h}" data-course-name="${course.display_name_with_default_escaped | h}" data-threads="${threads | h}" data-user-info="${user_info | h}" data-page="${page | h}" data-num-pages="${num_pages | h}"/>
<section class="course-content container discussion-user-threads" data-course-id="${course.id}" data-course-name="${course.display_name_with_default}" data-threads="${threads}" data-user-info="${user_info}" data-page="${page}" data-num-pages="${num_pages}"/>
</div>
</section>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment