Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Perform esacaping in the templates.

Browse Source 
Use new best practices.
This commit is contained in:
cahrens
2016-03-23 12:17:10 -04:00
parent 801bb288c2
commit 39dc8a5915
26 changed files with 166 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cms/static/js/spec/views/group_configuration_spec.js
View File

@@ -857,7 +857,7 @@ define([
beforeEach(function() {
TemplateHelpers.installTemplate('content-group-details', true);
this.model = new GroupModel({name: 'Content Group', id: 0});
this.model = new GroupModel({name: 'Content Group', id: 0, courseOutlineUrl: "CourseOutlineUrl"});
var saveableModel = new GroupConfigurationModel({
name: 'Content Group Configuration',
@@ -888,7 +888,7 @@ define([
it('should hide empty usage appropriately', function() {
this.view.$('.hide-groups').click();
assertHideEmptyUsages(this.view)
assertHideEmptyUsages(this.view);
});
it('should show non-empty usage appropriately', function() {
@@ -1001,7 +1001,7 @@ define([
'content-group-editor', 'content-group-details'
], true);
this.model = new GroupModel({name: 'Content Group', id: 0});
this.model = new GroupModel({name: 'Content Group', id: 0, courseOutlineUrl: 'CourseOutlineUrl'});
this.saveableModel = new GroupConfigurationModel({
name: 'Content Group Configuration',

3
cms/static/js/spec/views/pages/group_configurations_spec.js
View File

@@ -16,7 +16,8 @@ define([
experimentsEnabled: true,
experimentGroupConfigurations: new GroupConfigurationCollection({
id: 0,
name: 'Configuration 1'
name: 'Configuration 1',
courseOutlineUrl: "CourseOutlineUrl"
}),
contentGroupConfiguration: new GroupConfigurationModel({groups: []})
});

42
cms/static/js/views/content_group_details.js
View File

@@ -3,8 +3,9 @@
* It is expected to be backed by a Group model.
*/
define([
'js/views/baseview', 'underscore', 'gettext', 'underscore.string'
], function(BaseView, _, gettext, str) {
'js/views/baseview', 'underscore', 'gettext', 'underscore.string',
'edx-ui-toolkit/js/utils/string-utils', 'edx-ui-toolkit/js/utils/html-utils'
], function(BaseView, _, gettext, str, StringUtils, HtmlUtils) {
'use strict';
var ContentGroupDetailsView = BaseView.extend({
@@ -37,9 +38,10 @@ define([
render: function(showContentGroupUsages) {
var attrs = $.extend({}, this.model.attributes, {
usageCountMessage: this.getUsageCountTitle(),
outlineAnchorMessage: this.getOutlineAnchorMessage(),
courseOutlineUrl: this.model.collection.parents[0].outlineUrl,
index: this.model.collection.indexOf(this.model),
showContentGroupUsages: showContentGroupUsages || false
showContentGroupUsages: showContentGroupUsages || false,
HtmlUtils: HtmlUtils
});
this.$el.html(this.template(attrs));
return this;
@@ -56,41 +58,23 @@ define([
},
getUsageCountTitle: function () {
var count = this.model.get('usage').length, message;
var count = this.model.get('usage').length;
if (count === 0) {
message = gettext('Not in Use');
return gettext('Not in Use');
} else {
message = ngettext(
/* globals ngettext */
return StringUtils.interpolate(ngettext(
/*
Translators: 'count' is number of units that the group
configuration is used in.
*/
'Used in %(count)s unit', 'Used in %(count)s units',
'Used in {count} unit', 'Used in {count} units',
count
),
{count: count}
);
}
return interpolate(message, { count: count }, true);
},
getOutlineAnchorMessage: function () {
var message = _.escape(gettext(
/*
Translators: 'outlineAnchor' is an anchor pointing to
the course outline page.
*/
'This content group is not in use. Add a content group to any unit from the %(outlineAnchor)s.'
)),
anchor = str.sprintf(
'<a href="%(url)s" title="%(text)s">%(text)s</a>',
{
url: this.model.collection.parents[0].outlineUrl,
text: _.escape(gettext('Course Outline'))
}
);
return str.sprintf(message, {outlineAnchor: anchor});
}
});

4
cms/static/js/views/content_group_editor.js
View File

@@ -23,8 +23,8 @@ function(ListItemEditorView, _) {
getTemplateOptions: function() {
return {
id: this.model.escape('id'),
name: this.model.escape('name'),
id: this.model.get('id'),
name: this.model.get('name'),
index: this.model.collection.indexOf(this.model),
isNew: this.model.isNew(),
usage: this.model.get('usage'),

2
cms/static/js/views/experiment_group_edit.js
View File

@@ -32,7 +32,7 @@ function(BaseView, _, str, gettext) {
index = collection.indexOf(this.model);
this.$el.html(this.template({
name: this.model.escape('name'),
name: this.model.get('name'),
allocation: this.getAllocation(),
index: index,
error: this.model.validationError

49
cms/static/js/views/group_configuration_details.js
View File

@@ -3,9 +3,10 @@
* It is expected to be instantiated with a GroupConfiguration model.
*/
define([
'js/views/baseview', 'underscore', 'gettext', 'underscore.string'
'js/views/baseview', 'underscore', 'gettext', 'underscore.string',
'edx-ui-toolkit/js/utils/string-utils', 'edx-ui-toolkit/js/utils/html-utils'
],
function(BaseView, _, gettext, str) {
function(BaseView, _, gettext, str, StringUtils, HtmlUtils) {
'use strict';
var GroupConfigurationDetailsView = BaseView.extend({
tagName: 'div',
@@ -26,7 +27,7 @@ function(BaseView, _, gettext, str) {
},
initialize: function() {
this.template = _.template(
this.template = HtmlUtils.template(
$('#group-configuration-details-tpl').text()
);
this.listenTo(this.model, 'change', this.render);
@@ -36,11 +37,10 @@ function(BaseView, _, gettext, str) {
var attrs = $.extend({}, this.model.attributes, {
groupsCountMessage: this.getGroupsCountTitle(),
usageCountMessage: this.getUsageCountTitle(),
outlineAnchorMessage: this.getOutlineAnchorMessage(),
courseOutlineUrl: this.model.collection.outlineUrl,
index: this.model.collection.indexOf(this.model)
});
this.$el.html(this.template(attrs));
HtmlUtils.setHtml(this.$el, this.template(attrs));
return this;
},
@@ -61,54 +61,37 @@ function(BaseView, _, gettext, str) {
getGroupsCountTitle: function () {
var count = this.model.get('groups').length,
/* globals ngettext */
message = ngettext(
/*
Translators: 'count' is number of groups that the group
configuration contains.
*/
'Contains %(count)s group', 'Contains %(count)s groups',
'Contains {count} group', 'Contains {count} groups',
count
);
return interpolate(message, { count: count }, true);
return StringUtils.interpolate(message, { count: count });
},
getUsageCountTitle: function () {
var count = this.model.get('usage').length, message;
var count = this.model.get('usage').length;
if (count === 0) {
message = gettext('Not in Use');
return gettext('Not in Use');
} else {
message = ngettext(
return StringUtils.interpolate(ngettext(
/*
Translators: 'count' is number of units that the group
configuration is used in.
*/
'Used in %(count)s unit', 'Used in %(count)s units',
'Used in {count} unit', 'Used in {count} units',
count
),
{count: count}
);
}
return interpolate(message, { count: count }, true);
},
getOutlineAnchorMessage: function () {
var message = gettext(
/*
Translators: 'outlineAnchor' is an anchor pointing to
the course outline page.
*/
'This Group Configuration is not in use. Start by adding a content experiment to any Unit via the %(outlineAnchor)s.'
),
anchor = str.sprintf(
'<a href="%(url)s" title="%(text)s">%(text)s</a>',
{
url: this.model.collection.outlineUrl,
text: gettext('Course Outline')
}
);
return str.sprintf(message, {outlineAnchor: anchor});
}
});

4
cms/static/js/views/group_configuration_editor.js
View File

@@ -51,8 +51,8 @@ function(ListItemEditorView, _, $, gettext, ExperimentGroupEditView) {
return {
id: this.model.get('id'),
uniqueId: _.uniqueId(),
name: this.model.escape('name'),
description: this.model.escape('description'),
name: this.model.get('name'),
description: this.model.get('description'),
usage: this.model.get('usage'),
isNew: this.model.isNew()
};

6
cms/templates/group_configurations.html
View File

@@ -1,3 +1,4 @@
<%page expression_filter="h"/>
<%inherit file="base.html" />
<%def name="content_groups_help_token()"><% return "content_groups" %></%def>
<%def name="experiment_group_configurations_help_token()"><% return "group_configurations" %></%def>
@@ -8,6 +9,7 @@ from django.utils.translation import ugettext as _
from openedx.core.djangolib.js_utils import (
dump_js_escaped_json, js_escaped_string
)
from openedx.core.djangolib.markup import Text, HTML
%>
<%block name="title">${_("Group Configurations")}</%block>
@@ -76,7 +78,7 @@ from openedx.core.djangolib.js_utils import (
<h3 class="title-3">${_("Content Groups")}</h3>
<p>${_("If you have cohorts enabled in your course, you can use content groups to create cohort-specific courseware. In other words, you can customize the content that particular cohorts see in your course.")}</p>
<p>${_("Each content group that you create can be associated with one or more cohorts. In addition to course content that is intended for all students, you can designate some content as visible only to specified content groups. Only learners in the cohorts that are associated with the specified content groups see the additional content.")}</p>
<p>${_("Click {em_start}New content group{em_end} to add a new content group. To edit the name of a content group, hover over its box and click {em_start}Edit{em_end}. You can delete a content group only if it is not in use by a unit. To delete a content group, hover over its box and click the delete icon.").format(em_start="<strong>", em_end="</strong>")}</p>
<p>${Text(_("Click {em_start}New content group{em_end} to add a new content group. To edit the name of a content group, hover over its box and click {em_start}Edit{em_end}. You can delete a content group only if it is not in use by a unit. To delete a content group, hover over its box and click the delete icon.")).format(em_start=HTML("<strong>"), em_end=HTML("</strong>"))}</p>
<p><a href="${get_online_help_info(content_groups_help_token())['doc_url']}" target="_blank" class="button external-help-button">${_("Learn More")}</a></p>
</div>
</div>
@@ -85,7 +87,7 @@ from openedx.core.djangolib.js_utils import (
<div class="experiment-groups-doc">
<h3 class="title-3">${_("Experiment Group Configurations")}</h3>
<p>${_("Use experiment group configurations if you are conducting content experiments, also known as A/B testing, in your course. Experiment group configurations define how many groups of students are in a content experiment. When you create a content experiment for a course, you select the group configuration to use.")}</p>
<p>${_("Click {em_start}New Group Configuration{em_end} to add a new configuration. To edit a configuration, hover over its box and click {em_start}Edit{em_end}. You can delete a group configuration only if it is not in use in an experiment. To delete a configuration, hover over its box and click the delete icon.").format(em_start="<strong>", em_end="</strong>")}</p>
<p>${Text(_("Click {em_start}New Group Configuration{em_end} to add a new configuration. To edit a configuration, hover over its box and click {em_start}Edit{em_end}. You can delete a group configuration only if it is not in use in an experiment. To delete a configuration, hover over its box and click the delete icon.")).format(em_start=HTML("<strong>"), em_end=HTML("</strong>"))}</p>
<p><a href="${get_online_help_info(experiment_group_configurations_help_token())['doc_url']}" target="_blank" class="button external-help-button">${_("Learn More")}</a></p>
</div>
</div>

13
cms/templates/js/content-group-details.underscore
View File

@@ -51,9 +51,16 @@
</ol>
<% } else { %>
<p class="group-configuration-usage-text">
<!-- This contains an anchor link and therefore can't be escaped. -->
<%= outlineAnchorMessage %>
<%= HtmlUtils.interpolateHtml(
gettext('This content group is not in use. Add a content group to any unit from the {linkStart}Course Outline{linkEnd}.'),
{
linkStart: HtmlUtils.interpolateHtml(
HtmlUtils.HTML('<a href="{courseOutlineUrl}" title="{courseOutlineTitle}">'),
{courseOutlineUrl: courseOutlineUrl, courseOutlineTitle: gettext('Course Outline')}),
linkEnd: HtmlUtils.HTML('</a>')
})
%>
</p>
<% } %>
</div>
<% } %>
<% } %>

22
cms/templates/js/content-group-editor.underscore
View File

@@ -1,44 +1,44 @@
<form class="collection-edit-form">
<% if (error && error.message) { %>
<div class="content-group-edit-error message message-status message-status error is-shown">
<%= gettext(error.message) %>
<%- gettext(error.message) %>
</div>
<% } %>
<div class="wrapper-form">
<fieldset class="collection-fields">
<div class="input-wrap field text required add-collection-name <% if(error && error.attributes && error.attributes.name) { print('error'); } %>">
<label for="group-cohort-name-<%= uniqueId %>"><%= gettext("Content Group Name") %></label><%
<label for="group-cohort-name-<%- uniqueId %>"><%- gettext("Content Group Name") %></label><%
if (!_.isUndefined(id) && !_.isEmpty(id)) {
%><span class="group-configuration-id">
<span class="group-configuration-label"><%= gettext('Content Group ID') %></span>
<span class="group-configuration-value"><%= id %></span>
<span class="group-configuration-label"><%- gettext('Content Group ID') %></span>
<span class="group-configuration-value"><%- id %></span>
</span><%
}
%>
<input name="group-cohort-name" id="group-cohort-name-<%= uniqueId %>" class="collection-name-input input-text" value="<%- name %>" type="text" placeholder="<%= gettext("This is the name of the group") %>">
<input name="group-cohort-name" id="group-cohort-name-<%- uniqueId %>" class="collection-name-input input-text" value="<%- name %>" type="text" placeholder="<%- gettext("This is the name of the group") %>">
</div>
</fieldset>
<% if (!_.isEmpty(usage)) { %>
<div class="wrapper-group-configuration-validation usage-validation">
<i class="icon fa fa-warning"></i>
<p class="group-configuration-validation-text">
<%= gettext('This content group is used in one or more units.') %>
<%- gettext('This content group is used in one or more units.') %>
</p>
</div>
<% } %>
</div>
<div class="actions">
<button class="action action-primary" type="submit"><% if (isNew) { print(gettext("Create")) } else { print(gettext("Save")) } %></button>
<button class="action action-secondary action-cancel"><%= gettext("Cancel") %></button>
<button class="action action-secondary action-cancel"><%- gettext("Cancel") %></button>
<% if (!isNew) { %>
<% if (_.isEmpty(usage)) { %>
<span class="wrapper-delete-button" data-tooltip="<%= gettext("Delete") %>">
<a class="button action-delete delete" href="#"><%= gettext("Delete") %></a>
<span class="wrapper-delete-button" data-tooltip="<%- gettext("Delete") %>">
<a class="button action-delete delete" href="#"><%- gettext("Delete") %></a>
</span>
<% } else { %>
<span class="wrapper-delete-button" data-tooltip="<%= gettext('Cannot delete when in use by a unit') %>">
<a class="button action-delete delete is-disabled" href="#" aria-disabled="true" ><%= gettext("Delete") %></a>
<span class="wrapper-delete-button" data-tooltip="<%- gettext('Cannot delete when in use by a unit') %>">
<a class="button action-delete delete is-disabled" href="#" aria-disabled="true" ><%- gettext("Delete") %></a>
</span>
<% } %>
<% } %>

11
cms/templates/js/group-configuration-details.underscore
View File

@@ -80,8 +80,15 @@
</ol>
<% } else { %>
<p class="group-configuration-usage-text">
<!-- This contains an anchor link and therefore can't be escaped. -->
<%= outlineAnchorMessage %>
<%= HtmlUtils.interpolateHtml(
gettext('This Group Configuration is not in use. Start by adding a content experiment to any Unit via the {linkStart}Course Outline{linkEnd}.'),
{
linkStart: HtmlUtils.interpolateHtml(
HtmlUtils.HTML('<a href="{courseOutlineUrl}" title="{courseOutlineTitle}">'),
{ courseOutlineUrl: courseOutlineUrl, courseOutlineTitle: gettext('Course Outline')}),
linkEnd: HtmlUtils.HTML('</a>')
})
%>
</p>
<% } %>
</div>

38
cms/templates/js/group-configuration-editor.underscore
View File

@@ -1,57 +1,57 @@
<form class="collection-edit-form group-configuration-edit-form">
<% if (error && error.message) { %>
<div class="group-configuration-edit-error message message-status message-status error is-shown" name="group-configuration-edit-error">
<%= gettext(error.message) %>
<%- gettext(error.message) %>
</div>
<% } %>
<div class="wrapper-form">
<fieldset class="collection-fields group-configuration-fields">
<legend class="sr"><%= gettext("Group Configuration information") %></legend>
<legend class="sr"><%- gettext("Group Configuration information") %></legend>
<div class="input-wrap field text required add-collection-name add-group-configuration-name <% if(error && error.attributes && error.attributes.name) { print('error'); } %>">
<label for="group-configuration-name-<%= uniqueId %>"><%= gettext("Group Configuration Name") %></label><%
<label for="group-configuration-name-<%- uniqueId %>"><%- gettext("Group Configuration Name") %></label><%
if (!_.isUndefined(id)) {
%><span class="group-configuration-id">
<span class="group-configuration-label"><%= gettext('Group Configuration ID') %></span>
<span class="group-configuration-value"><%= id %></span>
<span class="group-configuration-label"><%- gettext('Group Configuration ID') %></span>
<span class="group-configuration-value"><%- id %></span>
</span><%
}
%>
<input id="group-configuration-name-<%= uniqueId %>" class="collection-name-input input-text" name="group-configuration-name" type="text" placeholder="<%= gettext("This is the Name of the Group Configuration") %>" value="<%= name %>">
<span class="tip tip-stacked"><%= gettext("Name or short description of the configuration") %></span>
<input id="group-configuration-name-<%- uniqueId %>" class="collection-name-input input-text" name="group-configuration-name" type="text" placeholder="<%- gettext("This is the Name of the Group Configuration") %>" value="<%- name %>">
<span class="tip tip-stacked"><%- gettext("Name or short description of the configuration") %></span>
</div>
<div class="input-wrap field text add-group-configuration-description">
<label for="group-configuration-description-<%= uniqueId %>"><%= gettext("Description") %></label>
<textarea id="group-configuration-description-<%= uniqueId %>" class="group-configuration-description-input text input-text" name="group-configuration-description" placeholder="<%= gettext("This is the Description of the Group Configuration") %>"><%= description %></textarea>
<span class="tip tip-stacked"><%= gettext("Optional long description") %></span>
<label for="group-configuration-description-<%- uniqueId %>"><%- gettext("Description") %></label>
<textarea id="group-configuration-description-<%- uniqueId %>" class="group-configuration-description-input text input-text" name="group-configuration-description" placeholder="<%- gettext("This is the Description of the Group Configuration") %>"><%- description %></textarea>
<span class="tip tip-stacked"><%- gettext("Optional long description") %></span>
</div>
</fieldset>
<fieldset class="groups-fields">
<legend class="sr"><%= gettext("Group information") %></legend>
<label class="groups-fields-label required"><%= gettext("Groups") %></label>
<span class="tip tip-stacked"><%= gettext("Name of the groups that students will be assigned to, for example, Control, Video, Problems. You must have two or more groups.") %></span>
<legend class="sr"><%- gettext("Group information") %></legend>
<label class="groups-fields-label required"><%- gettext("Groups") %></label>
<span class="tip tip-stacked"><%- gettext("Name of the groups that students will be assigned to, for example, Control, Video, Problems. You must have two or more groups.") %></span>
<ol class="groups list-input enum"></ol>
<button class="action action-add-group action-add-item"><i class="icon fa fa-plus"></i> <%= gettext("Add another group") %></button>
<button class="action action-add-group action-add-item"><i class="icon fa fa-plus"></i> <%- gettext("Add another group") %></button>
</fieldset>
<% if (!_.isEmpty(usage)) { %>
<div class="wrapper-group-configuration-validation usage-validation">
<i class="icon fa fa-warning"></i>
<p class="group-configuration-validation-text">
<%= gettext('This configuration is currently used in content experiments. If you make changes to the groups, you may need to edit those experiments.') %>
<%- gettext('This configuration is currently used in content experiments. If you make changes to the groups, you may need to edit those experiments.') %>
</p>
</div>
<% } %>
</div>
<div class="actions">
<button class="action action-primary" type="submit"><% if (isNew) { print(gettext("Create")) } else { print(gettext("Save")) } %></button>
<button class="action action-secondary action-cancel"><%= gettext("Cancel") %></button>
<button class="action action-secondary action-cancel"><%- gettext("Cancel") %></button>
<% if (!isNew) { %>
<% if (_.isEmpty(usage)) { %>
<span class="wrapper-delete-button">
<a class="button action-delete delete" href="#"><%= gettext("Delete") %></a>
<a class="button action-delete delete" href="#"><%- gettext("Delete") %></a>
</span>
<% } else { %>
<span class="wrapper-delete-button" data-tooltip="<%= gettext('Cannot delete when in use by an experiment') %>">
<a class="button action-delete delete is-disabled" href="#" aria-disabled="true" ><%= gettext("Delete") %></a>
<span class="wrapper-delete-button" data-tooltip="<%- gettext('Cannot delete when in use by an experiment') %>">
<a class="button action-delete delete is-disabled" href="#" aria-disabled="true" ><%- gettext("Delete") %></a>
</span>
<% } %>
<% } %>

8
cms/templates/js/group-edit.underscore
View File

@@ -1,4 +1,4 @@
<div class="input-wrap field long text required field-add-group-name group-<%= index %>-name
<% if (error && error.attributes && error.attributes.name) { print('error'); } %>"><input name="group-<%= index %>-name" class="group-name long" value="<%= name %>" type="text">
</div><div class="group-allocation"><%= allocation %>%</div>
<a href="" class="action action-close"><i class="icon fa fa-times-circle"></i> <span class="sr"><%= gettext("delete group") %></span></a>
<div class="input-wrap field long text required field-add-group-name group-<%- index %>-name
<% if (error && error.attributes && error.attributes.name) { print('error'); } %>"><input name="group-<%- index %>-name" class="group-name long" value="<%- name %>" type="text">
</div><div class="group-allocation"><%- allocation %>%</div>
<a href="" class="action action-close"><i class="icon fa fa-times-circle"></i> <span class="sr"><%- gettext("delete group") %></span></a>

2
cms/templates/js/list.underscore
View File

@@ -3,7 +3,7 @@
<p>
<%- emptyMessage %>
<a href="#" class="button new-button"><i class="icon fa fa-plus"></i>
<%= interpolate(
<%- interpolate(
gettext("%(new_item_message)s"), {new_item_message: newItemMessage}, true
) %></a>
</p>