@@ -110,10 +110,16 @@ from openedx.core.lib.js_utils import escape_json_dumps
% if xblock.category == 'split_test':
${_("Adding components")}
-
${_("Select a component type under {em_start}Add New Component{em_end}. Then select a template.").format(em_start='', em_end="") | h}
+
${_("Select a component type under {strong_start}Add New Component{strong_end}. Then select a template.").format(
+ strong_start=HTML(''),
+ strong_end=HTML(""),
+ )}
${_("The new component is added at the bottom of the page or group. You can then edit and move the component.")}
${_("Editing components")}
-
${_("Click the {em_start}Edit{em_end} icon in a component to edit its content.").format(em_start='', em_end="") | h}
+
${_("Click the {strong_start}Edit{strong_end} icon in a component to edit its content.").format(
+ strong_start=HTML(''),
+ strong_end=HTML(""),
+ )}
${_("Reorganizing components")}
${_("Drag components to new locations within this component.")}
${_("For content experiments, you can drag components to other groups.")}
<%- gettext('Specify any additional rules or rule exceptions that the proctoring review team should enforce when reviewing the videos. For example, you could specify that calculators are allowed.') %>
diff --git a/cms/templates/library.html b/cms/templates/library.html
index f55c745ec3..cf8eebcbd7 100644
--- a/cms/templates/library.html
+++ b/cms/templates/library.html
@@ -5,7 +5,7 @@ from contentstore.views.helpers import xblock_studio_url, xblock_type_display_na
from django.utils.translation import ugettext as _
from openedx.core.lib.js_utils import escape_json_dumps
%>
-<%block name="title">${context_library.display_name_with_default} ${xblock_type_display_name(context_library)}
+<%block name="title">${context_library.display_name_with_default_escaped} ${xblock_type_display_name(context_library)}
<%block name="bodyclass">is-signedin course container view-container view-library
<%namespace name='static' file='static_content.html'/>
@@ -45,7 +45,7 @@ from openedx.core.lib.js_utils import escape_json_dumps
${_("Content Library")}
<%
email_subject = urllib.quote(_("Enroll in {course_display_name}").format(
- course_display_name = context_course.display_name_with_default
+ course_display_name = context_course.display_name_with_default_escaped
).encode("utf-8"))
email_body = urllib.quote(_('The course "{course_display_name}", provided by {platform_name}, is open for enrollment. Please navigate to this course at {link_for_about_page} to enroll.').format(
- course_display_name = context_course.display_name_with_default,
+ course_display_name = context_course.display_name_with_default_escaped,
platform_name = settings.PLATFORM_NAME,
link_for_about_page = link_for_about_page
).encode("utf-8"))
diff --git a/cms/templates/studio_xblock_wrapper.html b/cms/templates/studio_xblock_wrapper.html
index 129f5775b2..fb826bee0d 100644
--- a/cms/templates/studio_xblock_wrapper.html
+++ b/cms/templates/studio_xblock_wrapper.html
@@ -9,7 +9,7 @@ xblock_url = xblock_studio_url(xblock)
show_inline = xblock.has_children and not xblock_url
section_class = "level-nesting" if show_inline else "level-element"
collapsible_class = "is-collapsible" if xblock.has_children else ""
-label = xblock.display_name_with_default or xblock.scope_ids.block_type
+label = xblock.display_name_with_default_escaped or xblock.scope_ids.block_type
messages = xblock.validate().to_json()
%>
diff --git a/cms/templates/widgets/header.html b/cms/templates/widgets/header.html
index a7b2d2dff6..6f229fe86a 100644
--- a/cms/templates/widgets/header.html
+++ b/cms/templates/widgets/header.html
@@ -38,7 +38,7 @@
${_("Current Course:")}${context_course.display_org_with_default | h}${context_course.display_number_with_default | h}
- ${context_course.display_name_with_default}
+ ${context_course.display_name_with_default_escaped}
@@ -141,7 +141,7 @@
${_("Current Library:")}${context_library.display_org_with_default | h}${context_library.display_number_with_default | h}
- ${context_library.display_name_with_default}
+ ${context_library.display_name_with_default_escaped}
diff --git a/common/djangoapps/course_modes/migrations/0005_auto_20151217_0958.py b/common/djangoapps/course_modes/migrations/0005_auto_20151217_0958.py
new file mode 100644
index 0000000000..0cc768b1c0
--- /dev/null
+++ b/common/djangoapps/course_modes/migrations/0005_auto_20151217_0958.py
@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('course_modes', '0004_auto_20151113_1457'),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name='coursemode',
+ name='expiration_datetime',
+ ),
+ migrations.AddField(
+ model_name='coursemode',
+ name='_expiration_datetime',
+ field=models.DateTimeField(db_column=b'expiration_datetime', default=None, blank=True, help_text='OPTIONAL: After this date/time, users will no longer be able to enroll in this mode. Leave this blank if users can enroll in this mode until enrollment closes for the course.', null=True, verbose_name='Upgrade Deadline'),
+ ),
+ ]
diff --git a/common/djangoapps/course_modes/models.py b/common/djangoapps/course_modes/models.py
index b256dc44c2..c8c07eae0a 100644
--- a/common/djangoapps/course_modes/models.py
+++ b/common/djangoapps/course_modes/models.py
@@ -159,7 +159,9 @@ class CourseMode(models.Model):
@expiration_datetime.setter
def expiration_datetime(self, new_datetime):
""" Saves datetime to _expiration_datetime and sets the explicit flag. """
- self.expiration_datetime_is_explicit = True
+ # Only set explicit flag if we are setting an actual date.
+ if new_datetime is not None:
+ self.expiration_datetime_is_explicit = True
self._expiration_datetime = new_datetime
@classmethod
diff --git a/common/djangoapps/course_modes/tests/test_models.py b/common/djangoapps/course_modes/tests/test_models.py
index c83ed6a00e..c6406e75ed 100644
--- a/common/djangoapps/course_modes/tests/test_models.py
+++ b/common/djangoapps/course_modes/tests/test_models.py
@@ -421,3 +421,12 @@ class CourseModeModelTest(TestCase):
self.assertFalse(verified_mode.expiration_datetime_is_explicit)
self.assertEqual(verified_mode.expiration_datetime, now)
+
+ def test_expiration_datetime_explicitly_set_to_none(self):
+ """ Verify that setting the _expiration_date property does not set the explicit flag. """
+ verified_mode, __ = self.create_mode('verified', 'Verified Certificate')
+ self.assertFalse(verified_mode.expiration_datetime_is_explicit)
+
+ verified_mode.expiration_datetime = None
+ self.assertFalse(verified_mode.expiration_datetime_is_explicit)
+ self.assertIsNone(verified_mode.expiration_datetime)
diff --git a/common/djangoapps/course_modes/views.py b/common/djangoapps/course_modes/views.py
index 58dbf8839c..ddbf571587 100644
--- a/common/djangoapps/course_modes/views.py
+++ b/common/djangoapps/course_modes/views.py
@@ -120,7 +120,7 @@ class ChooseModeView(View):
"course_modes_choose_url": reverse("course_modes_choose", kwargs={'course_id': course_key.to_deprecated_string()}),
"modes": modes,
"has_credit_upsell": has_credit_upsell,
- "course_name": course.display_name_with_default,
+ "course_name": course.display_name_with_default_escaped,
"course_org": course.display_org_with_default,
"course_num": course.display_number_with_default,
"chosen_price": chosen_price,
diff --git a/common/djangoapps/enrollment/data.py b/common/djangoapps/enrollment/data.py
index 68880e1a3e..ab82543be0 100644
--- a/common/djangoapps/enrollment/data.py
+++ b/common/djangoapps/enrollment/data.py
@@ -8,11 +8,12 @@ from django.contrib.auth.models import User
from opaque_keys.edx.keys import CourseKey
from enrollment.errors import (
- CourseNotFoundError, CourseEnrollmentClosedError, CourseEnrollmentFullError,
+ CourseEnrollmentClosedError, CourseEnrollmentFullError,
CourseEnrollmentExistsError, UserNotFoundError, InvalidEnrollmentAttribute
)
from enrollment.serializers import CourseEnrollmentSerializer, CourseSerializer
from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
+from openedx.core.lib.exceptions import CourseNotFoundError
from student.models import (
CourseEnrollment, NonExistentCourseError, EnrollmentClosedError,
CourseFullError, AlreadyEnrolledError, CourseEnrollmentAttribute
diff --git a/common/djangoapps/enrollment/errors.py b/common/djangoapps/enrollment/errors.py
index cc66e86ed3..36d6f827b9 100644
--- a/common/djangoapps/enrollment/errors.py
+++ b/common/djangoapps/enrollment/errors.py
@@ -13,10 +13,6 @@ class CourseEnrollmentError(Exception):
self.data = data
-class CourseNotFoundError(CourseEnrollmentError):
- pass
-
-
class UserNotFoundError(CourseEnrollmentError):
pass
diff --git a/common/djangoapps/enrollment/tests/test_data.py b/common/djangoapps/enrollment/tests/test_data.py
index 6702ac7e2d..f4ce7b001a 100644
--- a/common/djangoapps/enrollment/tests/test_data.py
+++ b/common/djangoapps/enrollment/tests/test_data.py
@@ -11,9 +11,10 @@ from django.conf import settings
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
from xmodule.modulestore.tests.factories import CourseFactory
from enrollment.errors import (
- CourseNotFoundError, UserNotFoundError, CourseEnrollmentClosedError,
+ UserNotFoundError, CourseEnrollmentClosedError,
CourseEnrollmentFullError, CourseEnrollmentExistsError,
)
+from openedx.core.lib.exceptions import CourseNotFoundError
from student.tests.factories import UserFactory, CourseModeFactory
from student.models import CourseEnrollment, EnrollmentClosedError, CourseFullError, AlreadyEnrolledError
from enrollment import data
diff --git a/common/djangoapps/enrollment/urls.py b/common/djangoapps/enrollment/urls.py
index 438ad259df..397d99b652 100644
--- a/common/djangoapps/enrollment/urls.py
+++ b/common/djangoapps/enrollment/urls.py
@@ -11,24 +11,24 @@ from .views import (
EnrollmentCourseDetailView
)
-USERNAME_PATTERN = '(?P[\w.@+-]+)'
urlpatterns = patterns(
'enrollment.views',
url(
- r'^enrollment/{username},{course_key}$'.format(username=USERNAME_PATTERN,
- course_key=settings.COURSE_ID_PATTERN),
+ r'^enrollment/{username},{course_key}/$'.format(
+ username=settings.USERNAME_PATTERN, course_key=settings.COURSE_ID_PATTERN
+ ),
EnrollmentView.as_view(),
name='courseenrollment'
),
url(
- r'^enrollment/{course_key}$'.format(course_key=settings.COURSE_ID_PATTERN),
+ r'^enrollment/{course_key}/$'.format(course_key=settings.COURSE_ID_PATTERN),
EnrollmentView.as_view(),
name='courseenrollment'
),
url(r'^enrollment$', EnrollmentListView.as_view(), name='courseenrollments'),
url(
- r'^course/{course_key}$'.format(course_key=settings.COURSE_ID_PATTERN),
+ r'^course/{course_key}/$'.format(course_key=settings.COURSE_ID_PATTERN),
EnrollmentCourseDetailView.as_view(),
name='courseenrollmentdetails'
),
diff --git a/common/djangoapps/enrollment/views.py b/common/djangoapps/enrollment/views.py
index 69aea5996c..796e183b94 100644
--- a/common/djangoapps/enrollment/views.py
+++ b/common/djangoapps/enrollment/views.py
@@ -24,11 +24,13 @@ from openedx.core.lib.api.authentication import (
SessionAuthenticationAllowInactiveUser,
OAuth2AuthenticationAllowInactiveUser,
)
+from openedx.core.lib.exceptions import CourseNotFoundError
from util.disable_rate_limit import can_disable_rate_limit
from enrollment import api
from enrollment.errors import (
- CourseNotFoundError, CourseEnrollmentError,
- CourseModeNotFoundError, CourseEnrollmentExistsError
+ CourseEnrollmentError,
+ CourseModeNotFoundError,
+ CourseEnrollmentExistsError
)
from student.auth import user_has_role
from student.models import User
diff --git a/common/djangoapps/pipeline_mako/templates/static_content.html b/common/djangoapps/pipeline_mako/templates/static_content.html
index 88686c4e07..f3c5ee4a51 100644
--- a/common/djangoapps/pipeline_mako/templates/static_content.html
+++ b/common/djangoapps/pipeline_mako/templates/static_content.html
@@ -5,6 +5,7 @@ from django.utils.translation import get_language_bidi
from mako.exceptions import TemplateLookupException
from microsite_configuration import microsite
+from certificates.api import get_asset_url_by_slug
%>
<%def name='url(file, raw=False)'><%
@@ -14,6 +15,13 @@ except:
url = file
%>${url}${"?raw" if raw else ""}
+<%def name='certificate_asset_url(slug)'><%
+try:
+ url = get_asset_url_by_slug(slug)
+except:
+ url = ''
+%>${url}
+
<%def name='css(group, raw=False)'>
<%
rtl_group = '{}-rtl'.format(group)
diff --git a/common/djangoapps/student/models.py b/common/djangoapps/student/models.py
index b2fd02a7ff..64d21af18b 100644
--- a/common/djangoapps/student/models.py
+++ b/common/djangoapps/student/models.py
@@ -504,8 +504,29 @@ class Registration(models.Model):
def activate(self):
self.user.is_active = True
+ self._track_activation()
self.user.save()
+ def _track_activation(self):
+ """ Update the isActive flag in mailchimp for activated users."""
+ has_segment_key = getattr(settings, 'LMS_SEGMENT_KEY', None)
+ has_mailchimp_id = hasattr(settings, 'MAILCHIMP_NEW_USER_LIST_ID')
+ if has_segment_key and has_mailchimp_id:
+ identity_args = [
+ self.user.id, # pylint: disable=no-member
+ {
+ 'email': self.user.email,
+ 'username': self.user.username,
+ 'activated': 1,
+ },
+ {
+ "MailChimp": {
+ "listId": settings.MAILCHIMP_NEW_USER_LIST_ID
+ }
+ }
+ ]
+ analytics.identify(*identity_args)
+
class PendingNameChange(models.Model):
user = models.OneToOneField(User, unique=True, db_index=True)
diff --git a/common/djangoapps/student/tests/test_activate_account.py b/common/djangoapps/student/tests/test_activate_account.py
new file mode 100644
index 0000000000..56f9b052b5
--- /dev/null
+++ b/common/djangoapps/student/tests/test_activate_account.py
@@ -0,0 +1,78 @@
+"""Tests for account activation"""
+from mock import patch
+import unittest
+
+from django.conf import settings
+from django.contrib.auth.models import User
+from django.test import TestCase, override_settings
+
+from student.models import Registration
+
+
+@unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
+class TestActivateAccount(TestCase):
+ """Tests for account creation"""
+
+ def setUp(self):
+ super(TestActivateAccount, self).setUp()
+ self.username = "jack"
+ self.email = "jack@fake.edx.org"
+ self.user = User.objects.create(username=self.username, email=self.email, is_active=False)
+
+ # Set Up Registration
+ self.registration = Registration()
+ self.registration.register(self.user)
+ self.registration.save()
+
+ def assert_no_tracking(self, mock_segment_identify):
+ """ Assert that activate sets the flag but does not call segment. """
+ # Ensure that the user starts inactive
+ self.assertFalse(self.user.is_active)
+
+ # Until you explicitly activate it
+ self.registration.activate()
+ self.assertTrue(self.user.is_active)
+ self.assertFalse(mock_segment_identify.called)
+
+ @override_settings(
+ LMS_SEGMENT_KEY="testkey",
+ MAILCHIMP_NEW_USER_LIST_ID="listid"
+ )
+ @patch('student.models.analytics.identify')
+ def test_activation_with_keys(self, mock_segment_identify):
+ expected_segment_payload = {
+ 'email': self.email,
+ 'username': self.username,
+ 'activated': 1,
+ }
+ expected_segment_mailchimp_list = {
+ "MailChimp": {
+ "listId": settings.MAILCHIMP_NEW_USER_LIST_ID
+ }
+ }
+
+ # Ensure that the user starts inactive
+ self.assertFalse(self.user.is_active)
+
+ # Until you explicitly activate it
+ self.registration.activate()
+ self.assertTrue(self.user.is_active)
+ mock_segment_identify.assert_called_with(
+ self.user.id,
+ expected_segment_payload,
+ expected_segment_mailchimp_list
+ )
+
+ @override_settings(LMS_SEGMENT_KEY="testkey")
+ @patch('student.models.analytics.identify')
+ def test_activation_without_mailchimp_key(self, mock_segment_identify):
+ self.assert_no_tracking(mock_segment_identify)
+
+ @override_settings(MAILCHIMP_NEW_USER_LIST_ID="listid")
+ @patch('student.models.analytics.identify')
+ def test_activation_without_segment_key(self, mock_segment_identify):
+ self.assert_no_tracking(mock_segment_identify)
+
+ @patch('student.models.analytics.identify')
+ def test_activation_without_keys(self, mock_segment_identify):
+ self.assert_no_tracking(mock_segment_identify)
diff --git a/common/djangoapps/student/views.py b/common/djangoapps/student/views.py
index 7f15b12f78..4083954f77 100644
--- a/common/djangoapps/student/views.py
+++ b/common/djangoapps/student/views.py
@@ -133,6 +133,9 @@ AUDIT_LOG = logging.getLogger("audit")
ReverifyInfo = namedtuple('ReverifyInfo', 'course_id course_name course_number date status display') # pylint: disable=invalid-name
SETTING_CHANGE_INITIATED = 'edx.user.settings.change_initiated'
+# Disable this warning because it doesn't make sense to completely refactor tests to appease Pylint
+# pylint: disable=logging-format-interpolation
+
def csrf_token(context):
"""A csrf token that can be included in a form."""
@@ -156,13 +159,9 @@ def index(request, extra_context=None, user=AnonymousUser()):
"""
if extra_context is None:
extra_context = {}
- # The course selection work is done in courseware.courses.
- domain = settings.FEATURES.get('FORCE_UNIVERSITY_DOMAIN') # normally False
- # do explicit check, because domain=None is valid
- if domain is False:
- domain = request.META.get('HTTP_HOST')
- courses = get_courses(user, domain=domain)
+ courses = get_courses(user)
+
if microsite.get_value("ENABLE_COURSE_SORTING_BY_START_DATE",
settings.FEATURES["ENABLE_COURSE_SORTING_BY_START_DATE"]):
courses = sort_by_start_date(courses)
@@ -300,12 +299,13 @@ def _cert_info(user, course_overview, cert_status, course_mode): # pylint: disa
default_status = 'processing'
- default_info = {'status': default_status,
- 'show_disabled_download_button': False,
- 'show_download_url': False,
- 'show_survey_button': False,
- 'can_unenroll': True
- }
+ default_info = {
+ 'status': default_status,
+ 'show_disabled_download_button': False,
+ 'show_download_url': False,
+ 'show_survey_button': False,
+ 'can_unenroll': True,
+ }
if cert_status is None:
return default_info
@@ -504,9 +504,14 @@ def is_course_blocked(request, redeemed_registration_codes, course_key):
u"User %s (%s) opted out of receiving emails from course %s",
request.user.username,
request.user.email,
- course_key
+ course_key,
+ )
+ track.views.server_track(
+ request,
+ "change-email1-settings",
+ {"receive_emails": "no", "course": course_key.to_deprecated_string()},
+ page='dashboard',
)
- track.views.server_track(request, "change-email1-settings", {"receive_emails": "no", "course": course_key.to_deprecated_string()}, page='dashboard')
break
return blocked
@@ -729,7 +734,7 @@ def _create_recent_enrollment_message(course_enrollments, course_modes): # pyli
recently_enrolled_courses = _get_recently_enrolled_courses(course_enrollments)
if recently_enrolled_courses:
- messages = [
+ enroll_messages = [
{
"course_id": enrollment.course_overview.id,
"course_name": enrollment.course_overview.display_name,
@@ -742,7 +747,7 @@ def _create_recent_enrollment_message(course_enrollments, course_modes): # pyli
return render_to_string(
'enrollment/course_enrollment_message.html',
- {'course_enrollment_messages': messages, 'platform_name': platform_name}
+ {'course_enrollment_messages': enroll_messages, 'platform_name': platform_name}
)
@@ -781,7 +786,11 @@ def _allow_donation(course_modes, course_id, enrollment):
"""
donations_enabled = DonationConfiguration.current().enabled
- return donations_enabled and enrollment.mode in course_modes[course_id] and course_modes[course_id][enrollment.mode].min_price == 0
+ return (
+ donations_enabled and
+ enrollment.mode in course_modes[course_id] and
+ course_modes[course_id][enrollment.mode].min_price == 0
+ )
def _update_email_opt_in(request, org):
@@ -1015,7 +1024,7 @@ def change_enrollment(request, check_access=True):
enroll_mode = CourseMode.auto_enroll_mode(course_id, available_modes)
if enroll_mode:
CourseEnrollment.enroll(user, course_id, check_access=check_access, mode=enroll_mode)
- except Exception:
+ except Exception: # pylint: disable=broad-except
return HttpResponseBadRequest(_("Could not enroll"))
# If we have more than one course mode or professional ed is enabled,
@@ -1077,32 +1086,43 @@ def login_user(request, error=""): # pylint: disable=too-many-statements,unused
third_party_auth_successful = True
except User.DoesNotExist:
AUDIT_LOG.warning(
- u'Login failed - user with username {username} has no social auth with backend_name {backend_name}'.format(
- username=username, backend_name=backend_name))
- return HttpResponse(
- _("You've successfully logged into your {provider_name} account, but this account isn't linked with an {platform_name} account yet.").format(
- platform_name=platform_name, provider_name=requested_provider.name
- )
- + "
" +
- _("Use your {platform_name} username and password to log into {platform_name} below, "
- "and then link your {platform_name} account with {provider_name} from your dashboard.").format(
- platform_name=platform_name, provider_name=requested_provider.name
- )
- + "
" +
- _("If you don't have an {platform_name} account yet, "
- "click Register at the top of the page.").format(
- platform_name=platform_name),
- content_type="text/plain",
- status=403
+ u"Login failed - user with username {username} has no social auth "
+ "with backend_name {backend_name}".format(
+ username=username, backend_name=backend_name)
)
+ message = _(
+ "You've successfully logged into your {provider_name} account, "
+ "but this account isn't linked with an {platform_name} account yet."
+ ).format(
+ platform_name=platform_name,
+ provider_name=requested_provider.name,
+ )
+ message += "
"
+ message += _(
+ "Use your {platform_name} username and password to log into {platform_name} below, "
+ "and then link your {platform_name} account with {provider_name} from your dashboard."
+ ).format(
+ platform_name=platform_name,
+ provider_name=requested_provider.name,
+ )
+ message += "
"
+ message += _(
+ "If you don't have an {platform_name} account yet, "
+ "click Register at the top of the page."
+ ).format(
+ platform_name=platform_name
+ )
+
+ return HttpResponse(message, content_type="text/plain", status=403)
else:
if 'email' not in request.POST or 'password' not in request.POST:
return JsonResponse({
"success": False,
- "value": _('There was an error receiving your login information. Please email us.'), # TODO: User error message
- }) # TODO: this should be status code 400 # pylint: disable=fixme
+ # TODO: User error message
+ "value": _('There was an error receiving your login information. Please email us.'),
+ }) # TODO: this should be status code 400
email = request.POST['email']
password = request.POST['password']
@@ -1133,9 +1153,11 @@ def login_user(request, error=""): # pylint: disable=too-many-statements,unused
user_found_by_email_lookup = user
if user_found_by_email_lookup and LoginFailures.is_feature_enabled():
if LoginFailures.is_user_locked_out(user_found_by_email_lookup):
+ lockout_message = _('This account has been temporarily locked due '
+ 'to excessive login failures. Try again later.')
return JsonResponse({
"success": False,
- "value": _('This account has been temporarily locked due to excessive login failures. Try again later.'),
+ "value": lockout_message,
}) # TODO: this should be status code 429 # pylint: disable=fixme
# see if the user must reset his/her password due to any policy settings
@@ -1243,7 +1265,8 @@ def login_user(request, error=""): # pylint: disable=too-many-statements,unused
AUDIT_LOG.warning(u"Login failed - Account not active for user {0}, resending activation".format(username))
reactivation_email_for_user(user)
- not_activated_msg = _("This account has not been activated. We have sent another activation message. Please check your email for the activation instructions.")
+ not_activated_msg = _("This account has not been activated. We have sent another activation "
+ "message. Please check your email for the activation instructions.")
return JsonResponse({
"success": False,
"value": not_activated_msg,
@@ -1612,7 +1635,7 @@ def create_account_with_params(request, params):
if settings.FEATURES.get('ENABLE_DISCUSSION_EMAIL_DIGEST'):
try:
enable_notifications(user)
- except Exception:
+ except Exception: # pylint: disable=broad-except
log.exception("Enable discussion notifications failed for user {id}.".format(id=user.id))
dog_stats_api.increment("common.student.account_created")
@@ -2014,9 +2037,9 @@ def password_reset(request):
def password_reset_confirm_wrapper(
- request,
- uidb36=None,
- token=None,
+ request,
+ uidb36=None,
+ token=None,
):
""" A wrapper around django.contrib.auth.views.password_reset_confirm.
Needed because we want to set the user as active at this step.
@@ -2050,6 +2073,8 @@ def password_reset_confirm_wrapper(
num_distinct = settings.ADVANCED_SECURITY_CONFIG['MIN_DIFFERENT_STAFF_PASSWORDS_BEFORE_REUSE']
else:
num_distinct = settings.ADVANCED_SECURITY_CONFIG['MIN_DIFFERENT_STUDENT_PASSWORDS_BEFORE_REUSE']
+ # Because of how ngettext is, splitting the following into shorter lines would be ugly.
+ # pylint: disable=line-too-long
err_msg = ungettext(
"You are re-using a password that you have used recently. You must have {num} distinct password before reusing a previous password.",
"You are re-using a password that you have used recently. You must have {num} distinct passwords before reusing a previous password.",
@@ -2059,6 +2084,8 @@ def password_reset_confirm_wrapper(
# also, check to see if passwords are getting reset too frequent
if PasswordHistory.is_password_reset_too_soon(user):
num_days = settings.ADVANCED_SECURITY_CONFIG['MIN_TIME_IN_DAYS_BETWEEN_ALLOWED_RESETS']
+ # Because of how ngettext is, splitting the following into shorter lines would be ugly.
+ # pylint: disable=line-too-long
err_msg = ungettext(
"You are resetting passwords too frequently. Due to security policies, {num} day must elapse between password resets.",
"You are resetting passwords too frequently. Due to security policies, {num} days must elapse between password resets.",
@@ -2291,18 +2318,28 @@ def change_email_settings(request):
u"User %s (%s) opted in to receive emails from course %s",
user.username,
user.email,
- course_id
+ course_id,
+ )
+ track.views.server_track(
+ request,
+ "change-email-settings",
+ {"receive_emails": "yes", "course": course_id},
+ page='dashboard',
)
- track.views.server_track(request, "change-email-settings", {"receive_emails": "yes", "course": course_id}, page='dashboard')
else:
Optout.objects.get_or_create(user=user, course_id=course_key)
log.info(
u"User %s (%s) opted out of receiving emails from course %s",
user.username,
user.email,
- course_id
+ course_id,
+ )
+ track.views.server_track(
+ request,
+ "change-email-settings",
+ {"receive_emails": "no", "course": course_id},
+ page='dashboard',
)
- track.views.server_track(request, "change-email-settings", {"receive_emails": "no", "course": course_id}, page='dashboard')
return JsonResponse({"success": True})
diff --git a/common/djangoapps/track/backends/logger.py b/common/djangoapps/track/backends/logger.py
index a48ee1cf42..da9b960d0f 100644
--- a/common/djangoapps/track/backends/logger.py
+++ b/common/djangoapps/track/backends/logger.py
@@ -38,8 +38,7 @@ class LoggerBackend(BaseBackend):
event_str = json.dumps(event, cls=DateTimeJSONEncoder)
except UnicodeDecodeError:
application_log.exception(
- "UnicodeDecodeError Event_type: %r, Event_source: %r, Page: %r, Referer: %r",
- event.get('event_type'), event.get('event_source'), event.get('page'), event.get('referer')
+ "UnicodeDecodeError Event_data: %r", event
)
raise
diff --git a/common/djangoapps/util/markup.py b/common/djangoapps/util/markup.py
new file mode 100644
index 0000000000..304533de32
--- /dev/null
+++ b/common/djangoapps/util/markup.py
@@ -0,0 +1,51 @@
+"""
+Utilities for use in Mako markup.
+"""
+
+from django.utils.translation import ugettext as django_ugettext
+from django.utils.translation import ungettext as django_ungettext
+import markupsafe
+
+
+# So that we can use escape() imported from here.
+escape = markupsafe.escape # pylint: disable=invalid-name
+
+
+def ugettext(text):
+ """Translate a string, and escape it as plain text.
+
+ Use like this in Mako::
+
+ <% from util.markup import ugettext as _ %>
+
${_("Hello, world!")}
+
+ Or with formatting::
+
+ <% from util.markup import HTML, ugettext as _ %>
+ ${_("Write & send {start}email{end}").format(
+ start=HTML(""),
+ end=HTML(""),
+ )}
+
+ """
+ return markupsafe.escape(django_ugettext(text))
+
+
+def ungettext(text1, text2, num):
+ """Translate a number-sensitive string, and escape it as plain text."""
+ return markupsafe.escape(django_ungettext(text1, text2, num))
+
+
+def HTML(html): # pylint: disable=invalid-name
+ """Mark a string as already HTML, so that it won't be escaped before output.
+
+ Use this when formatting HTML into other strings::
+
+ <% from util.markup import HTML, ugettext as _ %>
+ ${_("Write & send {start}email{end}").format(
+ start=HTML(""),
+ end=HTML(""),
+ )}
+
+ """
+ return markupsafe.Markup(html)
diff --git a/common/djangoapps/util/milestones_helpers.py b/common/djangoapps/util/milestones_helpers.py
index 8c627b5a79..839b9519d9 100644
--- a/common/djangoapps/util/milestones_helpers.py
+++ b/common/djangoapps/util/milestones_helpers.py
@@ -186,7 +186,13 @@ def fulfill_course_milestone(course_key, user):
if not settings.FEATURES.get('MILESTONES_APP', False):
return None
from milestones import api as milestones_api
- course_milestones = milestones_api.get_course_milestones(course_key=course_key, relationship="fulfills")
+ from milestones.exceptions import InvalidMilestoneRelationshipTypeException
+ try:
+ course_milestones = milestones_api.get_course_milestones(course_key=course_key, relationship="fulfills")
+ except InvalidMilestoneRelationshipTypeException:
+ # we have not seeded milestone relationship types
+ seed_milestone_relationship_types()
+ course_milestones = milestones_api.get_course_milestones(course_key=course_key, relationship="fulfills")
for milestone in course_milestones:
milestones_api.add_user_milestone({'id': user.id}, milestone)
diff --git a/common/djangoapps/util/tests/test_markup.py b/common/djangoapps/util/tests/test_markup.py
new file mode 100644
index 0000000000..d700df57f8
--- /dev/null
+++ b/common/djangoapps/util/tests/test_markup.py
@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+"""
+Tests for util.markup
+"""
+
+import unittest
+
+import ddt
+
+from edxmako.template import Template
+from util.markup import escape, HTML, ugettext as _, ungettext
+
+
+@ddt.ddt
+class FormatHtmlTest(unittest.TestCase):
+ """Test that we can format plain strings and HTML into them properly."""
+
+ @ddt.data(
+ (u"hello", u"hello"),
+ (u"", u"<hello>"),
+ (u"It's cool", u"It's cool"),
+ (u'"cool," she said.', u'"cool," she said.'),
+ (u"Stop & Shop", u"Stop & Shop"),
+ (u"нтмℓ-єѕ¢αρє∂", u"<a>нтмℓ-єѕ¢αρє∂</a>"),
+ )
+ def test_simple(self, (before, after)):
+ self.assertEqual(unicode(_(before)), after) # pylint: disable=translation-of-non-string
+ self.assertEqual(unicode(escape(before)), after)
+
+ def test_formatting(self):
+ # The whole point of this function is to make sure this works:
+ out = _(u"Point & click {start}here{end}!").format(
+ start=HTML(""),
+ end=HTML(""),
+ )
+ self.assertEqual(
+ unicode(out),
+ u"Point & click here!",
+ )
+
+ def test_nested_formatting(self):
+ # Sometimes, you have plain text, with html inserted, and the html has
+ # plain text inserted. It gets twisty...
+ out = _(u"Send {start}email{end}").format(
+ start=HTML("").format(email="A&B"),
+ end=HTML(""),
+ )
+ self.assertEqual(
+ unicode(out),
+ u"Send email",
+ )
+
+ def test_mako(self):
+ # The default_filters used here have to match the ones in edxmako.
+ template = Template(
+ """
+ <%! from util.markup import HTML, ugettext as _ %>
+ ${_(u"A & {BC}").format(BC=HTML("B & C"))}
+ """,
+ default_filters=['decode.utf8', 'h'],
+ )
+ out = template.render({})
+ self.assertEqual(out.strip(), u"A & B & C")
+
+ def test_ungettext(self):
+ for i in [1, 2]:
+ out = ungettext("1 & {}", "2 & {}", i).format(HTML("<>"))
+ self.assertEqual(out, "{} & <>".format(i))
diff --git a/common/lib/capa/capa/responsetypes.py b/common/lib/capa/capa/responsetypes.py
index 2609bdd047..14f5069a0b 100644
--- a/common/lib/capa/capa/responsetypes.py
+++ b/common/lib/capa/capa/responsetypes.py
@@ -7,7 +7,8 @@ of a variety of types.
Used by capa_problem.py
"""
-
+# TODO: Refactor this code and fix this issue.
+# pylint: disable=attribute-defined-outside-init
# standard library imports
import abc
import cgi
@@ -541,7 +542,7 @@ class LoncapaResponse(object):
# If we can't do that, create the
and set the message
# as the text of the
- except:
+ except Exception: # pylint: disable=broad-except
response_msg_div = etree.Element('div')
response_msg_div.text = str(response_msg)
@@ -1225,7 +1226,6 @@ class MultipleChoiceResponse(LoncapaResponse):
i = 0
for response in self.xml.xpath("choicegroup"):
# Is Masking enabled? -- check for shuffle or answer-pool features
- ans_str = response.get("answer-pool")
# Masking (self._has_mask) is off, to be re-enabled with a future PR.
rtype = response.get('type')
if rtype not in ["MultipleChoice"]:
@@ -1240,12 +1240,15 @@ class MultipleChoiceResponse(LoncapaResponse):
i += 1
# If using the masked name, e.g. mask_0, save the regular name
# to support unmasking later (for the logs).
- if self.has_mask():
- mask_name = "mask_" + str(mask_ids.pop())
- self._mask_dict[mask_name] = name
- choice.set("name", mask_name)
- else:
- choice.set("name", name)
+ # Masking is currently disabled so this code is commented, as
+ # the variable `mask_ids` is not defined. (the feature appears to not be fully implemented)
+ # The original work for masking was done by Nick Parlante as part of the OLI Hinting feature.
+ # if self.has_mask():
+ # mask_name = "mask_" + str(mask_ids.pop())
+ # self._mask_dict[mask_name] = name
+ # choice.set("name", mask_name)
+ # else:
+ choice.set("name", name)
def late_transforms(self, problem):
"""
@@ -1338,12 +1341,13 @@ class MultipleChoiceResponse(LoncapaResponse):
Given a masked name, e.g. mask_2, returns the regular name, e.g. choice_0.
Fails with LoncapaProblemError if called on a response that is not masking.
"""
- if not self.has_mask():
- _ = self.capa_system.i18n.ugettext
- # Translators: 'unmask_name' is a method name and should not be translated.
- msg = _("unmask_name called on response that is not masked")
- raise LoncapaProblemError(msg)
- return self._mask_dict[name]
+ # if not self.has_mask():
+ # _ = self.capa_system.i18n.ugettext
+ # # Translators: 'unmask_name' is a method name and should not be translated.
+ # msg = "unmask_name called on response that is not masked"
+ # raise LoncapaProblemError(msg)
+ # return self._mask_dict[name] # TODO: this is not defined
+ raise NotImplementedError()
def unmask_order(self):
"""
@@ -1750,7 +1754,9 @@ class NumericalResponse(LoncapaResponse):
student_float = evaluator({}, {}, student_answer)
except UndefinedVariable as undef_var:
raise StudentInputError(
- _(u"You may not use variables ({bad_variables}) in numerical problems.").format(bad_variables=undef_var.message)
+ _(u"You may not use variables ({bad_variables}) in numerical problems.").format(
+ bad_variables=undef_var.message,
+ )
)
except ValueError as val_err:
if 'factorial' in val_err.message:
@@ -1802,13 +1808,17 @@ class NumericalResponse(LoncapaResponse):
for inclusion, answer in zip(self.inclusion, self.answer_range):
boundary = self.get_staff_ans(answer)
if boundary.imag != 0:
- # Translators: This is an error message for a math problem. If the instructor provided a boundary
- # (end limit) for a variable that is a complex number (a + bi), this message displays.
- raise StudentInputError(_("There was a problem with the staff answer to this problem: complex boundary."))
+ raise StudentInputError(
+ # Translators: This is an error message for a math problem. If the instructor provided a
+ # boundary (end limit) for a variable that is a complex number (a + bi), this message displays.
+ _("There was a problem with the staff answer to this problem: complex boundary.")
+ )
if isnan(boundary):
- # Translators: This is an error message for a math problem. If the instructor did not provide
- # a boundary (end limit) for a variable, this message displays.
- raise StudentInputError(_("There was a problem with the staff answer to this problem: empty boundary."))
+ raise StudentInputError(
+ # Translators: This is an error message for a math problem. If the instructor did not
+ # provide a boundary (end limit) for a variable, this message displays.
+ _("There was a problem with the staff answer to this problem: empty boundary.")
+ )
boundaries.append(boundary.real)
if compare_with_tolerance(
student_float,
@@ -2164,7 +2174,8 @@ class StringResponse(LoncapaResponse):
def get_answers(self):
_ = self.capa_system.i18n.ugettext
- # Translators: Separator used in StringResponse to display multiple answers. Example: "Answer: Answer_1 or Answer_2 or Answer_3".
+ # Translators: Separator used in StringResponse to display multiple answers.
+ # Example: "Answer: Answer_1 or Answer_2 or Answer_3".
separator = u' {} '.format(_('or'))
return {self.answer_id: separator.join(self.correct_answer)}
@@ -2280,7 +2291,9 @@ class CustomResponse(LoncapaResponse):
submission = [student_answers[k] for k in idset]
except Exception as err:
msg = u"[courseware.capa.responsetypes.customresponse] {message}\n idset = {idset}, error = {err}".format(
- message=_("error getting student answer from {student_answers}").format(student_answers=student_answers),
+ message=_("error getting student answer from {student_answers}").format(
+ student_answers=student_answers,
+ ),
idset=idset,
err=err
)
@@ -2392,20 +2405,20 @@ class CustomResponse(LoncapaResponse):
random_seed=self.context['seed'],
unsafely=self.capa_system.can_execute_unsafe_code(),
)
- except Exception as err:
+ except Exception as err: # pylint: disable=broad-except
self._handle_exec_exception(err)
else:
# self.code is not a string; it's a function we created earlier.
# this is an interface to the Tutor2 check functions
- fn = self.code
+ tutor_cfn = self.code
answer_given = submission[0] if (len(idset) == 1) else submission
kwnames = self.xml.get("cfn_extra_args", "").split()
kwargs = {n: self.context.get(n) for n in kwnames}
log.debug(" submission = %s", submission)
try:
- ret = fn(self.expect, answer_given, **kwargs)
+ ret = tutor_cfn(self.expect, answer_given, **kwargs)
except Exception as err: # pylint: disable=broad-except
self._handle_exec_exception(err)
log.debug(
@@ -2928,15 +2941,17 @@ class CodeResponse(LoncapaResponse):
# Next, we need to check that the contents of the external grader message is safe for the LMS.
# 1) Make sure that the message is valid XML (proper opening/closing tags)
- # 2) If it is not valid XML, make sure it is valid HTML. Note: html5lib parser will try to repair any broken HTML
- # For example: will become .
+ # 2) If it is not valid XML, make sure it is valid HTML.
+ # Note: html5lib parser will try to repair any broken HTML
+ # For example: will become .
msg = score_result['msg']
try:
etree.fromstring(msg)
except etree.XMLSyntaxError as _err:
# If `html` contains attrs with no values, like `controls` in ,
- # XML parser will raise exception, so wee fallback to html5parser, which will set empty "" values for such attrs.
+ # XML parser will raise exception, so wee fallback to html5parser,
+ # which will set empty "" values for such attrs.
try:
parsed = html5lib.parseFragment(msg, treebuilder='lxml', namespaceHTMLElements=False)
except ValueError:
@@ -3612,11 +3627,13 @@ class AnnotationResponse(LoncapaResponse):
def _find_options(self, inputfield):
"""Returns an array of dicts where each dict represents an option. """
elements = inputfield.findall('./options/option')
- return [{
+ return [
+ {
'id': index,
'description': option.text,
'choice': option.get('choice')
- } for (index, option) in enumerate(elements)]
+ } for (index, option) in enumerate(elements)
+ ]
def _find_option_with_choice(self, inputfield, choice):
"""Returns the option with the given choice value, otherwise None. """
@@ -3663,10 +3680,11 @@ class ChoiceTextResponse(LoncapaResponse):
human_name = _('Checkboxes With Text Input')
tags = ['choicetextresponse']
max_inputfields = 1
- allowed_inputfields = ['choicetextgroup',
- 'checkboxtextgroup',
- 'radiotextgroup'
- ]
+ allowed_inputfields = [
+ 'choicetextgroup',
+ 'checkboxtextgroup',
+ 'radiotextgroup',
+ ]
def __init__(self, *args, **kwargs):
self.correct_inputs = {}
@@ -3771,9 +3789,8 @@ class ChoiceTextResponse(LoncapaResponse):
"""
- for index, choice in enumerate(
- self.xml.xpath('//*[@id=$id]//choice', id=self.xml.get('id'))
- ):
+ choices = self.xml.xpath('//*[@id=$id]//choice', id=self.xml.get('id'))
+ for index, choice in enumerate(choices):
# Set the name attribute for
# "bc" is appended at the end to indicate that this is a
# binary choice as opposed to a numtolerance_input, this convention
diff --git a/common/lib/chem/chem/tests.py b/common/lib/chem/chem/tests.py
index 4087016e41..75a044c7ee 100644
--- a/common/lib/chem/chem/tests.py
+++ b/common/lib/chem/chem/tests.py
@@ -9,16 +9,17 @@ from .chemcalc import (
chemical_equations_equal,
)
-import miller
+import chem.miller
-local_debug = None
+LOCAL_DEBUG = None
-def log(s, output_type=None):
- if local_debug:
- print s
+def log(msg, output_type=None):
+ """Logging function for tests"""
+ if LOCAL_DEBUG:
+ print msg
if output_type == 'html':
- f.write(s + '\n \n')
+ f.write(msg + '\n \n')
class Test_Compare_Equations(unittest.TestCase):
@@ -132,10 +133,6 @@ class Test_Compare_Expressions(unittest.TestCase):
self.assertFalse(compare_chemical_expression(
"H2O(s) + CO2", "H2O+CO2"))
- def test_compare_phases_not_ignored_explicitly(self):
- self.assertTrue(compare_chemical_expression(
- "H2O(s) + CO2", "H2O(s)+CO2", ignore_state=False))
-
# all in one cases
def test_complex_additivity(self):
self.assertTrue(compare_chemical_expression(
@@ -223,247 +220,250 @@ class Test_Divide_Expressions(unittest.TestCase):
class Test_Render_Equations(unittest.TestCase):
-
+ """
+ Tests to validate the HTML rendering of plaintext (input) equations
+ """
+ # pylint: disable=line-too-long
def test_render1(self):
- s = "H2O + CO2"
- out = render_to_html(s)
+ test_string = "H2O + CO2"
+ out = render_to_html(test_string)
correct = u'H2O+CO2'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render_uncorrect_reaction(self):
- s = "O2C + OH2"
- out = render_to_html(s)
+ test_string = "O2C + OH2"
+ out = render_to_html(test_string)
correct = u'O2C+OH2'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render2(self):
- s = "CO2 + H2O + Fe(OH)3"
- out = render_to_html(s)
+ test_string = "CO2 + H2O + Fe(OH)3"
+ out = render_to_html(test_string)
correct = u'CO2+H2O+Fe(OH)3'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render3(self):
- s = "3H2O + 2CO2"
- out = render_to_html(s)
+ test_string = "3H2O + 2CO2"
+ out = render_to_html(test_string)
correct = u'3H2O+2CO2'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render4(self):
- s = "H^+ + OH^-"
- out = render_to_html(s)
+ test_string = "H^+ + OH^-"
+ out = render_to_html(test_string)
correct = u'H++OH-'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render5(self):
- s = "Fe(OH)^2- + (OH)^-"
- out = render_to_html(s)
+ test_string = "Fe(OH)^2- + (OH)^-"
+ out = render_to_html(test_string)
correct = u'Fe(OH)2-+(OH)-'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render6(self):
- s = "7/2H^+ + 3/5OH^-"
- out = render_to_html(s)
+ test_string = "7/2H^+ + 3/5OH^-"
+ out = render_to_html(test_string)
correct = u'7⁄2H++3⁄5OH-'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render7(self):
- s = "5(H1H212)^70010- + 2H2O + 7/2HCl + H2O"
- out = render_to_html(s)
+ test_string = "5(H1H212)^70010- + 2H2O + 7/2HCl + H2O"
+ out = render_to_html(test_string)
correct = u'5(H1H212)70010-+2H2O+7⁄2HCl+H2O'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render8(self):
- s = "H2O(s) + CO2"
- out = render_to_html(s)
+ test_string = "H2O(s) + CO2"
+ out = render_to_html(test_string)
correct = u'H2O(s)+CO2'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render9(self):
- s = "5[Ni(NH3)4]^2+ + 5/2SO4^2-"
- out = render_to_html(s)
+ test_string = "5[Ni(NH3)4]^2+ + 5/2SO4^2-"
+ out = render_to_html(test_string)
correct = u'5[Ni(NH3)4]2++5⁄2SO42-'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render_error(self):
- s = "5.2H20"
- out = render_to_html(s)
+ test_string = "5.2H20"
+ out = render_to_html(test_string)
correct = u'5.2H20'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render_simple_brackets(self):
- s = "(Ar)"
- out = render_to_html(s)
+ test_string = "(Ar)"
+ out = render_to_html(test_string)
correct = u'(Ar)'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render_eq1(self):
- s = "H^+ + OH^- -> H2O"
- out = render_to_html(s)
+ test_string = "H^+ + OH^- -> H2O"
+ out = render_to_html(test_string)
correct = u'H++OH-\u2192H2O'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render_eq2(self):
- s = "H^+ + OH^- <-> H2O"
- out = render_to_html(s)
+ test_string = "H^+ + OH^- <-> H2O"
+ out = render_to_html(test_string)
correct = u'H++OH-\u2194H2O'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
def test_render_eq3(self):
- s = "H^+ + OH^- <= H2O" # unsupported arrow
- out = render_to_html(s)
+ test_string = "H^+ + OH^- <= H2O" # unsupported arrow
+ out = render_to_html(test_string)
correct = u'H^+ + OH^- <= H2O'
log(out + ' ------- ' + correct, 'html')
self.assertEqual(out, correct)
class Test_Crystallography_Miller(unittest.TestCase):
- ''' Tests for crystallography grade function.'''
-
+ """Tests for crystallography grade function."""
+ # pylint: disable=line-too-long
def test_empty_points(self):
user_input = '{"lattice": "bcc", "points": []}'
- self.assertFalse(miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
+ self.assertFalse(chem.miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
def test_only_one_point(self):
user_input = '{"lattice": "bcc", "points": [["0.50", "0.00", "0.00"]]}'
- self.assertFalse(miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
+ self.assertFalse(chem.miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
def test_only_two_points(self):
user_input = '{"lattice": "bcc", "points": [["0.50", "0.00", "0.00"], ["0.00", "0.50", "0.00"]]}'
- self.assertFalse(miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
+ self.assertFalse(chem.miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
def test_1(self):
user_input = '{"lattice": "bcc", "points": [["0.50", "0.00", "0.00"], ["0.00", "0.50", "0.00"], ["0.00", "0.00", "0.50"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
def test_2(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "0.00"], ["0.00", "1.00", "0.00"], ["0.00", "0.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,1,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,1,1)', 'lattice': 'bcc'}))
def test_3(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.50", "1.00"], ["1.00", "1.00", "0.50"], ["0.50", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(2,2,2)', 'lattice': 'bcc'}))
def test_4(self):
user_input = '{"lattice": "bcc", "points": [["0.33", "1.00", "0.00"], ["0.00", "0.664", "0.00"], ["0.00", "1.00", "0.33"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(-3, 3, -3)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(-3, 3, -3)', 'lattice': 'bcc'}))
def test_5(self):
""" return true only in case points coordinates are exact.
But if they transform to closest 0.05 value it is not true"""
user_input = '{"lattice": "bcc", "points": [["0.33", "1.00", "0.00"], ["0.00", "0.33", "0.00"], ["0.00", "1.00", "0.33"]]}'
- self.assertFalse(miller.grade(user_input, {'miller': '(-6,3,-6)', 'lattice': 'bcc'}))
+ self.assertFalse(chem.miller.grade(user_input, {'miller': '(-6,3,-6)', 'lattice': 'bcc'}))
def test_6(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.25", "0.00"], ["0.25", "0.00", "0.00"], ["0.00", "0.00", "0.25"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(4,4,4)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(4,4,4)', 'lattice': 'bcc'}))
def test_7(self): # goes throug origin
user_input = '{"lattice": "bcc", "points": [["0.00", "1.00", "0.00"], ["1.00", "0.00", "0.00"], ["0.50", "1.00", "0.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,0,-1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,0,-1)', 'lattice': 'bcc'}))
def test_8(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "1.00", "0.50"], ["1.00", "0.00", "0.50"], ["0.50", "1.00", "0.50"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,0,2)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,0,2)', 'lattice': 'bcc'}))
def test_9(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "1.00"], ["0.00", "1.00", "1.00"], ["1.00", "0.00", "0.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,1,0)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,1,0)', 'lattice': 'bcc'}))
def test_10(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "1.00"], ["0.00", "0.00", "0.00"], ["0.00", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,1,-1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,1,-1)', 'lattice': 'bcc'}))
def test_11(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "0.50"], ["1.00", "1.00", "0.00"], ["0.00", "1.00", "0.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,1,2)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,1,2)', 'lattice': 'bcc'}))
def test_12(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "0.50"], ["0.00", "0.00", "0.50"], ["1.00", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,1,-2)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,1,-2)', 'lattice': 'bcc'}))
def test_13(self):
user_input = '{"lattice": "bcc", "points": [["0.50", "0.00", "0.00"], ["0.50", "1.00", "0.00"], ["0.00", "0.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(2,0,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(2,0,1)', 'lattice': 'bcc'}))
def test_14(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["0.00", "0.00", "1.00"], ["0.50", "1.00", "0.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(2,-1,0)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(2,-1,0)', 'lattice': 'bcc'}))
def test_15(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["1.00", "1.00", "0.00"], ["0.00", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,-1,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,-1,1)', 'lattice': 'bcc'}))
def test_16(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "0.00"], ["0.00", "1.00", "0.00"], ["1.00", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,1,-1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,1,-1)', 'lattice': 'bcc'}))
def test_17(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["1.00", "0.00", "1.00"], ["1.00", "1.00", "0.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(-1,1,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(-1,1,1)', 'lattice': 'bcc'}))
def test_18(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["1.00", "1.00", "0.00"], ["0.00", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,-1,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,-1,1)', 'lattice': 'bcc'}))
def test_19(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["1.00", "1.00", "0.00"], ["0.00", "0.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(-1,1,0)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(-1,1,0)', 'lattice': 'bcc'}))
def test_20(self):
user_input = '{"lattice": "bcc", "points": [["1.00", "0.00", "0.00"], ["1.00", "1.00", "0.00"], ["0.00", "0.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,0,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,0,1)', 'lattice': 'bcc'}))
def test_21(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["0.00", "1.00", "0.00"], ["1.00", "0.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(-1,0,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(-1,0,1)', 'lattice': 'bcc'}))
def test_22(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "1.00", "0.00"], ["1.00", "1.00", "0.00"], ["0.00", "0.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,1,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,1,1)', 'lattice': 'bcc'}))
def test_23(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["1.00", "0.00", "0.00"], ["1.00", "1.00", "1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,-1,1)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,-1,1)', 'lattice': 'bcc'}))
def test_24(self):
user_input = '{"lattice": "bcc", "points": [["0.66", "0.00", "0.00"], ["0.00", "0.66", "0.00"], ["0.00", "0.00", "0.66"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(3,3,3)', 'lattice': 'bcc'}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(3,3,3)', 'lattice': 'bcc'}))
def test_25(self):
user_input = u'{"lattice":"","points":[["0.00","0.00","0.01"],["1.00","1.00","0.01"],["0.00","1.00","1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(1,-1,1)', 'lattice': ''}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(1,-1,1)', 'lattice': ''}))
def test_26(self):
user_input = u'{"lattice":"","points":[["0.00","0.01","0.00"],["1.00","0.00","0.00"],["0.00","0.00","1.00"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(0,-1,0)', 'lattice': ''}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(0,-1,0)', 'lattice': ''}))
def test_27(self):
""" rounding to 0.35"""
user_input = u'{"lattice":"","points":[["0.33","0.00","0.00"],["0.00","0.33","0.00"],["0.00","0.00","0.33"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(3,3,3)', 'lattice': ''}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(3,3,3)', 'lattice': ''}))
def test_28(self):
""" rounding to 0.30"""
user_input = u'{"lattice":"","points":[["0.30","0.00","0.00"],["0.00","0.30","0.00"],["0.00","0.00","0.30"]]}'
- self.assertTrue(miller.grade(user_input, {'miller': '(10,10,10)', 'lattice': ''}))
+ self.assertTrue(chem.miller.grade(user_input, {'miller': '(10,10,10)', 'lattice': ''}))
def test_wrong_lattice(self):
user_input = '{"lattice": "bcc", "points": [["0.00", "0.00", "0.00"], ["1.00", "0.00", "0.00"], ["1.00", "1.00", "1.00"]]}'
- self.assertFalse(miller.grade(user_input, {'miller': '(3,3,3)', 'lattice': 'fcc'}))
+ self.assertFalse(chem.miller.grade(user_input, {'miller': '(3,3,3)', 'lattice': 'fcc'}))
def suite():
@@ -478,7 +478,7 @@ def suite():
return unittest.TestSuite(suites)
if __name__ == "__main__":
- local_debug = True
+ LOCAL_DEBUG = True
with codecs.open('render.html', 'w', encoding='utf-8') as f:
unittest.TextTestRunner(verbosity=2).run(suite())
# open render.html to look at rendered equations
diff --git a/common/lib/xmodule/setup.py b/common/lib/xmodule/setup.py
index 1bf6ce5324..d697067efe 100644
--- a/common/lib/xmodule/setup.py
+++ b/common/lib/xmodule/setup.py
@@ -28,7 +28,6 @@ XMODULES = [
"static_tab = xmodule.html_module:StaticTabDescriptor",
"custom_tag_template = xmodule.raw_module:RawDescriptor",
"about = xmodule.html_module:AboutDescriptor",
- "graphical_slider_tool = xmodule.gst_module:GraphicalSliderToolDescriptor",
"annotatable = xmodule.annotatable_module:AnnotatableDescriptor",
"textannotation = xmodule.textannotation_module:TextAnnotationDescriptor",
"videoannotation = xmodule.videoannotation_module:VideoAnnotationDescriptor",
diff --git a/common/lib/xmodule/xmodule/annotatable_module.py b/common/lib/xmodule/xmodule/annotatable_module.py
index dff30f937a..0799f3cfdd 100644
--- a/common/lib/xmodule/xmodule/annotatable_module.py
+++ b/common/lib/xmodule/xmodule/annotatable_module.py
@@ -150,7 +150,7 @@ class AnnotatableModule(AnnotatableFields, XModule):
def get_html(self):
""" Renders parameters to template. """
context = {
- 'display_name': self.display_name_with_default,
+ 'display_name': self.display_name_with_default_escaped,
'element_id': self.element_id,
'instructions_html': self.instructions,
'content_html': self._render_content()
diff --git a/common/lib/xmodule/xmodule/capa_base.py b/common/lib/xmodule/xmodule/capa_base.py
index a3fe7d8381..64e9729c2a 100644
--- a/common/lib/xmodule/xmodule/capa_base.py
+++ b/common/lib/xmodule/xmodule/capa_base.py
@@ -658,7 +658,7 @@ class CapaMixin(CapaFields):
check_button_checking = False
content = {
- 'name': self.display_name_with_default,
+ 'name': self.display_name_with_default_escaped,
'html': html,
'weight': self.weight,
}
@@ -1116,10 +1116,11 @@ class CapaMixin(CapaFields):
if dog_stats_api:
dog_stats_api.increment(metric_name('checks'), tags=[u'result:success'])
- dog_stats_api.histogram(
- metric_name('correct_pct'),
- float(published_grade['grade']) / published_grade['max_grade'],
- )
+ if published_grade['max_grade'] != 0:
+ dog_stats_api.histogram(
+ metric_name('correct_pct'),
+ float(published_grade['grade']) / published_grade['max_grade'],
+ )
dog_stats_api.histogram(
metric_name('attempts'),
self.attempts,
diff --git a/common/lib/xmodule/xmodule/contentstore/content.py b/common/lib/xmodule/xmodule/contentstore/content.py
index 544cef6b61..9337b176e8 100644
--- a/common/lib/xmodule/xmodule/contentstore/content.py
+++ b/common/lib/xmodule/xmodule/contentstore/content.py
@@ -39,13 +39,23 @@ class StaticContent(object):
return self.location.category == 'thumbnail'
@staticmethod
- def generate_thumbnail_name(original_name):
+ def generate_thumbnail_name(original_name, dimensions=None):
+ """
+ - original_name: Name of the asset (typically its location.name)
+ - dimensions: `None` or a tuple of (width, height) in pixels
+ """
name_root, ext = os.path.splitext(original_name)
if not ext == XASSET_THUMBNAIL_TAIL_NAME:
name_root = name_root + ext.replace(u'.', u'-')
+
+ if dimensions:
+ width, height = dimensions # pylint: disable=unpacking-non-sequence
+ name_root += "-{}x{}".format(width, height)
+
return u"{name_root}{extension}".format(
name_root=name_root,
- extension=XASSET_THUMBNAIL_TAIL_NAME,)
+ extension=XASSET_THUMBNAIL_TAIL_NAME,
+ )
@staticmethod
def compute_location(course_key, path, revision=None, is_thumbnail=False):
@@ -248,11 +258,25 @@ class ContentStore(object):
"""
raise NotImplementedError
- def generate_thumbnail(self, content, tempfile_path=None):
+ def generate_thumbnail(self, content, tempfile_path=None, dimensions=None):
+ """Create a thumbnail for a given image.
+
+ Returns a tuple of (StaticContent, AssetKey)
+
+ `content` is the StaticContent representing the image you want to make a
+ thumbnail out of.
+
+ `tempfile_path` is a string path to the location of a file to read from
+ in order to grab the image data, instead of relying on `content.data`
+
+ `dimensions` is an optional param that represents (width, height) in
+ pixels. It defaults to None.
+ """
thumbnail_content = None
# use a naming convention to associate originals with the thumbnail
- thumbnail_name = StaticContent.generate_thumbnail_name(content.location.name)
-
+ thumbnail_name = StaticContent.generate_thumbnail_name(
+ content.location.name, dimensions=dimensions
+ )
thumbnail_file_location = StaticContent.compute_location(
content.location.course_key, thumbnail_name, is_thumbnail=True
)
@@ -273,8 +297,11 @@ class ContentStore(object):
# I've seen some exceptions from the PIL library when trying to save palletted
# PNG files to JPEG. Per the google-universe, they suggest converting to RGB first.
im = im.convert('RGB')
- size = 128, 128
- im.thumbnail(size, Image.ANTIALIAS)
+
+ if not dimensions:
+ dimensions = (128, 128)
+
+ im.thumbnail(dimensions, Image.ANTIALIAS)
thumbnail_file = StringIO.StringIO()
im.save(thumbnail_file, 'JPEG')
thumbnail_file.seek(0)
diff --git a/common/lib/xmodule/xmodule/course_metadata_utils.py b/common/lib/xmodule/xmodule/course_metadata_utils.py
index 500ef8485f..0a6a3ba73c 100644
--- a/common/lib/xmodule/xmodule/course_metadata_utils.py
+++ b/common/lib/xmodule/xmodule/course_metadata_utils.py
@@ -57,15 +57,51 @@ def display_name_with_default(course):
like to just pass course.display_name and course.url_name as arguments to
this function, we can't do so without breaking those tests.
+ Note: This method no longer escapes as it once did, so the caller must
+ ensure it is properly escaped where necessary.
+
Arguments:
course (CourseDescriptor|CourseOverview): descriptor or overview of
said course.
"""
- # TODO: Consider changing this to use something like xml.sax.saxutils.escape
return (
course.display_name if course.display_name is not None
else course.url_name.replace('_', ' ')
- ).replace('<', '<').replace('>', '>')
+ )
+
+
+def display_name_with_default_escaped(course):
+ """
+ DEPRECATED: use display_name_with_default
+
+ Calculates the display name for a course with some HTML escaping.
+ This follows the same logic as display_name_with_default, with
+ the addition of the escaping.
+
+ Here is an example of how to move away from this method in Mako html:
+ Before:
+ ${course.display_name_with_default_escaped}
+
+ After:
+ ${course.display_name_with_default | h}
+ If the context is Javascript in Mako, you'll need to follow other best practices.
+
+ Note: Switch to display_name_with_default, and ensure the caller
+ properly escapes where necessary.
+
+ Note: This newly introduced method should not be used. It was only
+ introduced to enable a quick search/replace and the ability to slowly
+ migrate and test switching to display_name_with_default, which is no
+ longer escaped.
+
+ Arguments:
+ course (CourseDescriptor|CourseOverview): descriptor or overview of
+ said course.
+ """
+ # This escaping is incomplete. However, rather than switching this to use
+ # markupsafe.escape() and fixing issues, better to put that energy toward
+ # migrating away from this method altogether.
+ return course.display_name_with_default.replace('<', '<').replace('>', '>')
def number_for_course_location(location):
diff --git a/common/lib/xmodule/xmodule/course_module.py b/common/lib/xmodule/xmodule/course_module.py
index c91ed60fb1..c4a187f670 100644
--- a/common/lib/xmodule/xmodule/course_module.py
+++ b/common/lib/xmodule/xmodule/course_module.py
@@ -1367,3 +1367,56 @@ class CourseDescriptor(CourseFields, SequenceDescriptor, LicenseMixin):
bool: False if the course has already started, True otherwise.
"""
return datetime.now(UTC()) <= self.start
+
+
+class CourseSummary(object):
+ """
+ A lightweight course summary class, which constructs split/mongo course summary without loading
+ the course. It is used at cms for listing courses to global staff user.
+ """
+ course_info_fields = ['display_name', 'display_coursenumber', 'display_organization']
+
+ def __init__(self, course_locator, display_name=u"Empty", display_coursenumber=None, display_organization=None):
+ """
+ Initialize and construct course summary
+
+ Arguments:
+ course_locator (CourseLocator): CourseLocator object of the course.
+
+ display_name (unicode): display name of the course. When you create a course from console, display_name
+ isn't set (course block has no key `display_name`). "Empty" name is returned when we load the course.
+ If `display_name` isn't present in the course block, use the `Empty` as default display name.
+ We can set None as a display_name in Course Advance Settings; Do not use "Empty" when display_name is
+ set to None.
+
+ display_coursenumber (unicode|None): Course number that is specified & appears in the courseware
+
+ display_organization (unicode|None): Course organization that is specified & appears in the courseware
+
+ """
+ self.display_coursenumber = display_coursenumber
+ self.display_organization = display_organization
+ self.display_name = display_name
+
+ self.id = course_locator # pylint: disable=invalid-name
+ self.location = course_locator.make_usage_key('course', 'course')
+
+ @property
+ def display_org_with_default(self):
+ """
+ Return a display organization if it has been specified, otherwise return the 'org' that
+ is in the location
+ """
+ if self.display_organization:
+ return self.display_organization
+ return self.location.org
+
+ @property
+ def display_number_with_default(self):
+ """
+ Return a display course number if it has been specified, otherwise return the 'course' that
+ is in the location
+ """
+ if self.display_coursenumber:
+ return self.display_coursenumber
+ return self.location.course
diff --git a/common/lib/xmodule/xmodule/css/gst/display.scss b/common/lib/xmodule/xmodule/css/gst/display.scss
deleted file mode 100644
index 83ca4650f0..0000000000
--- a/common/lib/xmodule/xmodule/css/gst/display.scss
+++ /dev/null
@@ -1,44 +0,0 @@
-// In the LMS sliders use built-in styles from jquery-ui-1.8.22.custom.css.
-// CMS uses its own sliders styles.
-// These styles we use only to sure, that slider in GST module
-// will be render correctly (just like a duplication some from jquery-ui-1.8.22.custom.css).
-// Cause, for example, CMS overwrites many jquery-ui-1.8.22.custom.css styles,
-// and we must overwrite them again.
-
-.ui-widget-content {
- border: 1px solid #dddddd;
- color: #333333;
-}
-
-.ui-widget {
- font-family: Trebuchet MS, Tahoma, Verdana, Arial, sans-serif;
- font-size: 1.1em;
-}
-
-.ui-corner-all, .ui-corner-top, .ui-corner-left, .ui-corner-tl {
- -moz-border-radius-topleft: 4px;
- -webkit-border-top-left-radius: 4px;
- -khtml-border-top-left-radius: 4px;
- border-top-left-radius: 4px;
-}
-
-.ui-corner-all, .ui-corner-top, .ui-corner-right, .ui-corner-tr {
- -moz-border-radius-topright: 4px;
- -webkit-border-top-right-radius: 4px;
- -khtml-border-top-right-radius: 4px;
- border-top-right-radius: 4px;
-}
-
-.ui-corner-all, .ui-corner-bottom, .ui-corner-left, .ui-corner-bl {
- -moz-border-radius-bottomleft: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -khtml-border-bottom-left-radius: 4px;
- border-bottom-left-radius: 4px;
-}
-
-.ui-corner-all, .ui-corner-bottom, .ui-corner-right, .ui-corner-br {
- -moz-border-radius-bottomright: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -khtml-border-bottom-right-radius: 4px;
- border-bottom-right-radius: 4px;
-}
\ No newline at end of file
diff --git a/common/lib/xmodule/xmodule/css/sequence/display.scss b/common/lib/xmodule/xmodule/css/sequence/display.scss
index d184499477..c86ff553f5 100644
--- a/common/lib/xmodule/xmodule/css/sequence/display.scss
+++ b/common/lib/xmodule/xmodule/css/sequence/display.scss
@@ -1,5 +1,5 @@
$sequence--border-color: #C8C8C8;
-
+$link-color: rgb(26, 161, 222);
// repeated extends - needed since LMS styling was referenced
.block-link {
border-left: 1px solid lighten($sequence--border-color, 10%);
@@ -36,7 +36,7 @@ $sequence--border-color: #C8C8C8;
// TODO (cpennington): This doesn't work anymore. XModules aren't able to
// import from external sources.
@extend .topbar;
- margin: -4px 0 ($baseline*1.5);
+ margin: -4px 0 $baseline;
position: relative;
border-bottom: none;
z-index: 0;
@@ -119,6 +119,10 @@ $sequence--border-color: #C8C8C8;
-webkit-font-smoothing: antialiased; // Clear up the lines on the icons
}
+ i.fa-bookmark {
+ color: $link-color;
+ }
+
&.inactive {
.icon {
@@ -142,6 +146,10 @@ $sequence--border-color: #C8C8C8;
.icon {
color: rgb(10, 10, 10);
}
+
+ i.fa-bookmark {
+ color: $link-color;
+ }
}
}
@@ -295,3 +303,4 @@ nav.sequence-bottom {
outline: none;
}
}
+
diff --git a/common/lib/xmodule/xmodule/css/video/display.scss b/common/lib/xmodule/xmodule/css/video/display.scss
index c54591a7ff..a0ac08bf06 100644
--- a/common/lib/xmodule/xmodule/css/video/display.scss
+++ b/common/lib/xmodule/xmodule/css/video/display.scss
@@ -247,6 +247,22 @@ html:not('.afontgarde') .icon-fallback-img {
}
}
+ .closed-captions {
+ position: absolute;
+ width: 85%;
+ left: 5%;
+ top: 70%;
+ text-align: center;
+ }
+
+ .closed-captions.is-visible {
+ max-height: ($baseline * 3);
+ border-radius: ($baseline / 5);
+ padding: 8px ($baseline / 2) 8px ($baseline * 1.5);
+ background: rgba(0, 0, 0, .75);
+ color: $yellow;
+ }
+
.video-player {
overflow: hidden;
min-height: 300px;
@@ -701,39 +717,44 @@ html:not('.afontgarde') .icon-fallback-img {
.subtitles {
@include float(left);
overflow: auto;
- margin: 0;
max-height: 460px;
width: flex-grid(3, 9);
padding: 0;
font-size: 14px;
- list-style: none;
visibility: visible;
- li {
- @extend %ui-fake-link;
- margin-bottom: 8px;
- border: 0;
+ .subtitles-menu {
+ height: 100%;
+ margin: 0;
padding: 0;
- color: #0074b5; // AA compliant
- line-height: lh();
+ list-style: none;
- &.current {
- color: #333;
- font-weight: 700;
- }
+ li {
+ @extend %ui-fake-link;
+ margin-bottom: 8px;
+ border: 0;
+ padding: 0;
+ color: #0074b5; // AA compliant
+ line-height: lh();
- &.focused {
- outline: #000 dotted thin;
- outline-offset: -1px;
- }
+ &.current {
+ color: #333;
+ font-weight: 700;
+ }
- &:hover,
- &:focus {
- text-decoration: underline;
- }
+ &.focused {
+ outline: #000 dotted thin;
+ outline-offset: -1px;
+ }
- &:empty {
- margin-bottom: 0;
+ &:hover,
+ &:focus {
+ text-decoration: underline;
+ }
+
+ &:empty {
+ margin-bottom: 0;
+ }
}
}
}
diff --git a/common/lib/xmodule/xmodule/gst_module.py b/common/lib/xmodule/xmodule/gst_module.py
deleted file mode 100644
index 27ba362db5..0000000000
--- a/common/lib/xmodule/xmodule/gst_module.py
+++ /dev/null
@@ -1,241 +0,0 @@
-"""
-Graphical slider tool module is ungraded xmodule used by students to
-understand functional dependencies.
-"""
-
-import json
-import logging
-from lxml import etree
-from lxml import html
-import xmltodict
-
-from xmodule.editing_module import XMLEditingDescriptor
-from xmodule.xml_module import XmlDescriptor
-from xmodule.x_module import XModule
-from xmodule.stringify import stringify_children
-from pkg_resources import resource_string
-from xblock.fields import String, Scope
-
-log = logging.getLogger(__name__)
-
-DEFAULT_RENDER = """
-
Graphic slider tool: Dynamic range and implicit functions.
-
-
You can make the range of the x axis (but not ticks of x axis) of
- functions depend on a parameter value. This can be useful when the
- function domain needs to be variable.
-
Implicit functions like a circle can be plotted as 2 separate
- functions of the same color.
-
-
-
-
-
-"""
-
-DEFAULT_CONFIGURATION = """
-
-
-
-
- Math.sqrt(r * r - x * x)
- -Math.sqrt(r * r - x * x)
- Math.sqrt(r * r / 20 - Math.pow(x-r/2.5, 2)) + r/8
- -Math.sqrt(r * r / 20 - Math.pow(x-r/2.5, 2)) + r/5.5
- Math.sqrt(r * r / 20 - Math.pow(x+r/2.5, 2)) + r/8
- -Math.sqrt(r * r / 20 - Math.pow(x+r/2.5, 2)) + r/5.5
- -Math.sqrt(r * r / 5 - x * x) - r/5.5
-
-
-
-
- -r
- r
-
- 1000
- -30, 6, 30
- -30, 6, 30
-
-"""
-
-
-class GraphicalSliderToolFields(object):
- data = String(
- help="Html contents to display for this module",
- default='{}{}'.format(
- DEFAULT_RENDER, DEFAULT_CONFIGURATION),
- scope=Scope.content
- )
-
-
-class GraphicalSliderToolModule(GraphicalSliderToolFields, XModule):
- ''' Graphical-Slider-Tool Module
- '''
-
- js = {
- 'coffee': [resource_string(__name__, 'js/src/javascript_loader.coffee')],
- 'js': [
- # 3rd party libraries used by graphic slider tool.
- # TODO - where to store them - outside xmodule?
- resource_string(__name__, 'js/src/graphical_slider_tool/gst_main.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/state.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/general_methods.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/sliders.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/inputs.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/graph.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/el_output.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/g_label_el_output.js'),
- resource_string(__name__, 'js/src/graphical_slider_tool/gst.js')
- ]
- }
- css = {'scss': [resource_string(__name__, 'css/gst/display.scss')]}
- js_module_name = "GraphicalSliderTool"
-
- @property
- def configuration(self):
- return stringify_children(
- html.fromstring(self.data).xpath('configuration')[0]
- )
-
- @property
- def render(self):
- return stringify_children(
- html.fromstring(self.data).xpath('render')[0]
- )
-
- def get_html(self):
- """ Renders parameters to template. """
-
- # these 3 will be used in class methods
- self.html_id = self.location.html_id()
- self.html_class = self.location.category
-
- self.configuration_json = self.build_configuration_json()
- params = {
- 'gst_html': self.substitute_controls(self.render),
- 'element_id': self.html_id,
- 'element_class': self.html_class,
- 'configuration_json': self.configuration_json
- }
- content = self.system.render_template(
- 'graphical_slider_tool.html', params
- )
- return content
-
- def substitute_controls(self, html_string):
- """ Substitutes control elements (slider, textbox and plot) in
- html_string with their divs. Html_string is content of tag
- inside tag. Documentation on how information in
- tag is organized and processed is located in:
- edx-platform/docs/build/html/graphical_slider_tool.html.
-
- Args:
- html_string: content of tag, with controls as xml tags,
- e.g. .
-
- Returns:
- html_string with control tags replaced by proper divs
- ( ->
'
- slider_els = xml.xpath('//slider')
- for slider_el in slider_els:
- slider_el.getparent().replace(slider_el, html.fromstring(
- slider_div.format(
- element_class=self.html_class,
- element_id=self.html_id,
- var=slider_el.get('var', ""),
- style=slider_el.get('style', ""))))
-
- # substitute inputs aka textboxes
- input_div = ''
- input_els = xml.xpath('//textbox')
- for input_index, input_el in enumerate(input_els):
- input_el.getparent().replace(input_el, html.fromstring(
- input_div.format(
- element_class=self.html_class,
- element_id=self.html_id,
- var=input_el.get('var', ""),
- style=input_el.get('style', ""),
- input_index=input_index)))
-
- return html.tostring(xml)
-
- def build_configuration_json(self):
- """Creates json element from xml element (with aim to transfer later
- directly to javascript via hidden field in template). Steps:
-
- 1. Convert xml tree to python dict.
-
- 2. Dump dict to json.
-
- """
- # added for interface compatibility with xmltodict.parse
- # class added for javascript's part purposes
- root = '{}'.format(
- self.html_class,
- self.configuration)
- return json.dumps(xmltodict.parse(root))
-
-
-class GraphicalSliderToolDescriptor(GraphicalSliderToolFields, XMLEditingDescriptor, XmlDescriptor):
- module_class = GraphicalSliderToolModule
-
- @classmethod
- def definition_from_xml(cls, xml_object, system):
- """
- Pull out the data into dictionary.
-
- Args:
- xml_object: xml from file.
-
- Returns:
- dict
- """
- # check for presense of required tags in xml
- expected_children_level_0 = ['render', 'configuration']
- for child in expected_children_level_0:
- if len(xml_object.xpath(child)) != 1:
- raise ValueError(u"Graphical Slider Tool definition must include \
- exactly one '{0}' tag".format(child))
-
- expected_children_level_1 = ['functions']
- for child in expected_children_level_1:
- if len(xml_object.xpath('configuration')[0].xpath(child)) != 1:
- raise ValueError(u"Graphical Slider Tool definition must include \
- exactly one '{0}' tag".format(child))
- # finished
-
- return {
- 'data': stringify_children(xml_object)
- }, []
-
- def definition_to_xml(self, resource_fs):
- '''Return an xml element representing this definition.'''
- data = u'<{tag}>{body}'.format(
- tag='graphical_slider_tool',
- body=self.data)
- xml_object = etree.fromstring(data)
- return xml_object
diff --git a/common/lib/xmodule/xmodule/imageannotation_module.py b/common/lib/xmodule/xmodule/imageannotation_module.py
index da0f563548..aa5a0f1ee8 100644
--- a/common/lib/xmodule/xmodule/imageannotation_module.py
+++ b/common/lib/xmodule/xmodule/imageannotation_module.py
@@ -127,7 +127,7 @@ class ImageAnnotationModule(AnnotatableFields, XModule):
def student_view(self, context):
""" Renders parameters to template. """
context = {
- 'display_name': self.display_name_with_default,
+ 'display_name': self.display_name_with_default_escaped,
'instructions_html': self.instructions,
'token': retrieve_token(self.user_email, self.annotation_token_secret),
'tag': self.instructor_tags,
diff --git a/common/lib/xmodule/xmodule/js/fixtures/problem_content.html b/common/lib/xmodule/xmodule/js/fixtures/problem_content.html
index dcc0a31491..3e7d2107b7 100644
--- a/common/lib/xmodule/xmodule/js/fixtures/problem_content.html
+++ b/common/lib/xmodule/xmodule/js/fixtures/problem_content.html
@@ -12,7 +12,7 @@
-
+
diff --git a/common/lib/xmodule/xmodule/js/fixtures/video_all.html b/common/lib/xmodule/xmodule/js/fixtures/video_all.html
index 5b20840630..40fe28548e 100644
--- a/common/lib/xmodule/xmodule/js/fixtures/video_all.html
+++ b/common/lib/xmodule/xmodule/js/fixtures/video_all.html
@@ -17,6 +17,7 @@
+
diff --git a/common/lib/xmodule/xmodule/js/js_test.yml b/common/lib/xmodule/xmodule/js/js_test.yml
index 9ae74330c8..9c9afca868 100644
--- a/common/lib/xmodule/xmodule/js/js_test.yml
+++ b/common/lib/xmodule/xmodule/js/js_test.yml
@@ -47,7 +47,7 @@ lib_paths:
- common_static/js/vendor/json2.js
- common_static/js/vendor/underscore-min.js
- common_static/js/vendor/backbone-min.js
- - common_static/js/vendor/jquery.leanModal.min.js
+ - common_static/js/vendor/jquery.leanModal.js
- common_static/js/vendor/CodeMirror/codemirror.js
- common_static/js/vendor/tinymce/js/tinymce/jquery.tinymce.min.js
- common_static/js/vendor/tinymce/js/tinymce/tinymce.full.min.js
diff --git a/common/lib/xmodule/xmodule/js/spec/capa/display_spec.coffee b/common/lib/xmodule/xmodule/js/spec/capa/display_spec.coffee
index 690c748cde..bc23566d18 100644
--- a/common/lib/xmodule/xmodule/js/spec/capa/display_spec.coffee
+++ b/common/lib/xmodule/xmodule/js/spec/capa/display_spec.coffee
@@ -198,17 +198,55 @@ describe 'Problem', ->
expect(@problem.el.html()).toEqual 'Incorrect!'
expect(window.SR.readElts).toHaveBeenCalled()
+ it 'tests if all the capa buttons are disabled while checking', ->
+ runs ->
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ callback(success: 'incorrect', contents: 'Incorrect!')
+ promise =
+ always: (callable) -> callable()
+ done: (callable) -> callable()
+ spyOn @problem, 'enableAllButtons'
+ @problem.check()
+ expect(@problem.enableAllButtons).toHaveBeenCalledWith false, true
+ waitsFor (->
+ return jQuery.active == 0
+ ), "jQuery requests finished", 1000
+
+ runs ->
+ expect(@problem.enableAllButtons).toHaveBeenCalledWith true, true
+
+ it 'tests the expected change in text of check button', ->
+ runs ->
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ promise =
+ always: (callable) -> callable()
+ done: (callable) -> callable()
+ spyOn @problem.checkButtonLabel, 'text'
+ @problem.check()
+ expect(@problem.checkButtonLabel.text).toHaveBeenCalledWith 'Checking...'
+ waitsFor (->
+ return jQuery.active == 0
+ ), "jQuery requests finished", 1000
+
+ runs ->
+ expect(@problem.checkButtonLabel.text).toHaveBeenCalledWith 'Check'
+
describe 'reset', ->
beforeEach ->
@problem = new Problem($('.xblock-student_view'))
it 'log the problem_reset event', ->
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ promise =
+ always: (callable) -> callable()
@problem.answers = 'foo=1&bar=2'
@problem.reset()
expect(Logger.log).toHaveBeenCalledWith 'problem_reset', 'foo=1&bar=2'
it 'POST to the problem reset page', ->
- spyOn $, 'postWithPrefix'
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ promise =
+ always: (callable) -> callable()
@problem.reset()
expect($.postWithPrefix).toHaveBeenCalledWith '/problem/Problem1/problem_reset',
{ id: 'i4x://edX/101/problem/Problem1' }, jasmine.any(Function)
@@ -216,9 +254,28 @@ describe 'Problem', ->
it 'render the returned content', ->
spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
callback html: "Reset!"
+ promise =
+ always: (callable) -> callable()
@problem.reset()
expect(@problem.el.html()).toEqual 'Reset!'
+ it 'tests if all the buttons are disabled and the text of check button remains same while resetting', ->
+ runs ->
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ promise =
+ always: (callable) -> callable()
+ spyOn @problem, 'enableAllButtons'
+ @problem.reset()
+ expect(@problem.enableAllButtons).toHaveBeenCalledWith false, false
+ expect(@problem.checkButtonLabel).toHaveText 'Check'
+ waitsFor (->
+ return jQuery.active == 0
+ ), "jQuery requests finished", 1000
+
+ runs ->
+ expect(@problem.enableAllButtons).toHaveBeenCalledWith true, false
+ expect(@problem.checkButtonLabel).toHaveText 'Check'
+
describe 'show', ->
beforeEach ->
@problem = new Problem($('.xblock-student_view'))
@@ -518,18 +575,26 @@ describe 'Problem', ->
@problem.answers = 'foo=1&bar=2'
it 'log the problem_save event', ->
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ promise =
+ always: (callable) -> callable()
@problem.save()
expect(Logger.log).toHaveBeenCalledWith 'problem_save', 'foo=1&bar=2'
it 'POST to save problem', ->
- spyOn $, 'postWithPrefix'
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ promise =
+ always: (callable) -> callable()
@problem.save()
expect($.postWithPrefix).toHaveBeenCalledWith '/problem/Problem1/problem_save',
'foo=1&bar=2', jasmine.any(Function)
it 'reads the save message', ->
runs ->
- spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) -> callback(success: 'OK')
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ callback(success: 'OK')
+ promise =
+ always: (callable) -> callable()
@problem.save()
waitsFor (->
return jQuery.active == 0
@@ -538,6 +603,24 @@ describe 'Problem', ->
runs ->
expect(window.SR.readElts).toHaveBeenCalled()
+ it 'tests if all the buttons are disabled and the text of check button does not change while saving.', ->
+ runs ->
+ spyOn($, 'postWithPrefix').andCallFake (url, answers, callback) ->
+ callback(success: 'OK')
+ promise =
+ always: (callable) -> callable()
+ spyOn @problem, 'enableAllButtons'
+ @problem.save()
+ expect(@problem.enableAllButtons).toHaveBeenCalledWith false, false
+ expect(@problem.checkButtonLabel).toHaveText 'Check'
+ waitsFor (->
+ return jQuery.active == 0
+ ), "jQuery requests finished", 1000
+
+ runs ->
+ expect(@problem.enableAllButtons).toHaveBeenCalledWith true, false
+ expect(@problem.checkButtonLabel).toHaveText 'Check'
+
describe 'refreshMath', ->
beforeEach ->
@problem = new Problem($('.xblock-student_view'))
diff --git a/common/lib/xmodule/xmodule/js/spec/video/video_caption_spec.js b/common/lib/xmodule/xmodule/js/spec/video/video_caption_spec.js
index 9d822bd8c1..c190933177 100644
--- a/common/lib/xmodule/xmodule/js/spec/video/video_caption_spec.js
+++ b/common/lib/xmodule/xmodule/js/spec/video/video_caption_spec.js
@@ -48,6 +48,12 @@
});
});
+ it('adds the captioning control to the video player', function() {
+ state = jasmine.initializePlayer();
+ expect($('.video')).toContain('.toggle-captions');
+ expect($('.video')).toContain('.closed-captions');
+ });
+
it('fetch the transcript in HTML5 mode', function () {
runs(function () {
state = jasmine.initializePlayer();
@@ -122,16 +128,16 @@
it('bind the mouse movement', function () {
state = jasmine.initializePlayer();
- expect($('.subtitles')).toHandle('mouseover');
- expect($('.subtitles')).toHandle('mouseout');
- expect($('.subtitles')).toHandle('mousemove');
- expect($('.subtitles')).toHandle('mousewheel');
- expect($('.subtitles')).toHandle('DOMMouseScroll');
+ expect($('.subtitles-menu')).toHandle('mouseover');
+ expect($('.subtitles-menu')).toHandle('mouseout');
+ expect($('.subtitles-menu')).toHandle('mousemove');
+ expect($('.subtitles-menu')).toHandle('mousewheel');
+ expect($('.subtitles-menu')).toHandle('DOMMouseScroll');
});
it('bind the scroll', function () {
state = jasmine.initializePlayer();
- expect($('.subtitles'))
+ expect($('.subtitles-menu'))
.toHandleWith('scroll', state.videoControl.showControls);
});
@@ -158,14 +164,61 @@
});
});
+ describe('renderCaptions', function() {
+
+ describe('is rendered', function() {
+ var KEY = $.ui.keyCode,
+
+ keyPressEvent = function(key) {
+ return $.Event('keydown', { keyCode: key });
+ };
+
+ it('toggles the captions on control click', function() {
+ state = jasmine.initializePlayer();
+
+ $('.toggle-captions').click();
+ expect($('.toggle-captions')).toHaveClass('is-active');
+ expect($('.closed-captions')).toHaveClass('is-visible');
+
+ $('.toggle-captions').click();
+ expect($('.toggle-captions')).not.toHaveClass('is-active');
+ expect($('.closed-captions')).not.toHaveClass('is-visible');
+ });
+
+ it('toggles the captions on keypress ENTER', function() {
+ state = jasmine.initializePlayer();
+
+ $('.toggle-captions').focus().trigger(keyPressEvent(KEY.ENTER));
+ expect($('.toggle-captions')).toHaveClass('is-active');
+ expect($('.closed-captions')).toHaveClass('is-visible');
+
+ $('.toggle-captions').focus().trigger(keyPressEvent(KEY.ENTER));
+ expect($('.toggle-captions')).not.toHaveClass('is-active');
+ expect($('.closed-captions')).not.toHaveClass('is-visible');
+ });
+
+ it('toggles the captions on keypress SPACE', function() {
+ state = jasmine.initializePlayer();
+
+ $('.toggle-captions').focus().trigger(keyPressEvent(KEY.SPACE));
+ expect($('.toggle-captions')).toHaveClass('is-active');
+ expect($('.closed-captions')).toHaveClass('is-visible');
+
+ $('.toggle-captions').focus().trigger(keyPressEvent(KEY.SPACE));
+ expect($('.toggle-captions')).not.toHaveClass('is-active');
+ expect($('.closed-captions')).not.toHaveClass('is-visible');
+ });
+ });
+ });
+
describe('renderLanguageMenu', function () {
describe('is rendered', function () {
var KEY = $.ui.keyCode,
- keyPressEvent = function(key) {
- return $.Event('keydown', { keyCode: key });
- };
+ keyPressEvent = function(key) {
+ return $.Event('keydown', { keyCode: key });
+ };
it('if languages more than 1', function () {
state = jasmine.initializePlayer();
@@ -364,9 +417,8 @@
});
it('show explanation message', function () {
- expect($('.subtitles li')).toHaveHtml(
- 'Caption will be displayed when you start playing ' +
- 'the video.'
+ expect($('.subtitles-menu li')).toHaveHtml(
+ 'Transcript will be displayed when you start playing the video.'
);
});
@@ -444,7 +496,7 @@
runs(function () {
$(window).trigger(jQuery.Event('mousemove'));
jasmine.Clock.tick(state.config.captionsFreezeTime);
- $('.subtitles').trigger(jQuery.Event('mouseenter'));
+ $('.subtitles-menu').trigger(jQuery.Event('mouseenter'));
jasmine.Clock.tick(state.config.captionsFreezeTime);
});
});
@@ -459,7 +511,7 @@
describe('when the cursor is moving', function () {
it('reset the freezing timeout', function () {
runs(function () {
- $('.subtitles').trigger(jQuery.Event('mousemove'));
+ $('.subtitles-menu').trigger(jQuery.Event('mousemove'));
expect(window.clearTimeout).toHaveBeenCalled();
});
});
@@ -468,7 +520,7 @@
describe('when the mouse is scrolling', function () {
it('reset the freezing timeout', function () {
runs(function () {
- $('.subtitles').trigger(jQuery.Event('mousewheel'));
+ $('.subtitles-menu').trigger(jQuery.Event('mousewheel'));
expect(window.clearTimeout).toHaveBeenCalled();
});
});
@@ -486,7 +538,7 @@
describe('always', function () {
beforeEach(function () {
- $('.subtitles').trigger(jQuery.Event('mouseout'));
+ $('.subtitles-menu').trigger(jQuery.Event('mouseout'));
});
it('reset the freezing timeout', function () {
@@ -501,9 +553,9 @@
describe('when the player is playing', function () {
beforeEach(function () {
state.videoCaption.playing = true;
- $('.subtitles li[data-index]:first')
+ $('.subtitles-menu li[data-index]:first')
.addClass('current');
- $('.subtitles').trigger(jQuery.Event('mouseout'));
+ $('.subtitles-menu').trigger(jQuery.Event('mouseout'));
});
it('scroll the transcript', function () {
@@ -514,7 +566,7 @@
describe('when the player is not playing', function () {
beforeEach(function () {
state.videoCaption.playing = false;
- $('.subtitles').trigger(jQuery.Event('mouseout'));
+ $('.subtitles-menu').trigger(jQuery.Event('mouseout'));
});
it('does not scroll the transcript', function () {
diff --git a/common/lib/xmodule/xmodule/js/spec/video/video_player_spec.js b/common/lib/xmodule/xmodule/js/spec/video/video_player_spec.js
index e521282ec8..922908b743 100644
--- a/common/lib/xmodule/xmodule/js/spec/video/video_player_spec.js
+++ b/common/lib/xmodule/xmodule/js/spec/video/video_player_spec.js
@@ -92,7 +92,8 @@ function (VideoPlayer) {
showinfo: 0,
enablejsapi: 1,
modestbranding: 1,
- html5: 1
+ html5: 1,
+ cc_load_policy: 0
},
videoId: 'cogebirgzzM',
events: events
@@ -118,7 +119,8 @@ function (VideoPlayer) {
rel: 0,
showinfo: 0,
enablejsapi: 1,
- modestbranding: 1
+ modestbranding: 1,
+ cc_load_policy: 0
},
videoId: 'abcdefghijkl',
events: jasmine.any(Object)
diff --git a/common/lib/xmodule/xmodule/js/src/capa/display.coffee b/common/lib/xmodule/xmodule/js/src/capa/display.coffee
index b2130efff9..ecd85d9226 100644
--- a/common/lib/xmodule/xmodule/js/src/capa/display.coffee
+++ b/common/lib/xmodule/xmodule/js/src/capa/display.coffee
@@ -32,11 +32,15 @@ class @Problem
@checkButtonCheckText = @checkButtonLabel.text()
@checkButtonCheckingText = @checkButton.data('checking')
@checkButton.click @check_fd
+ @hintButton = @$('div.action button.hint-button')
+ @hintButton.click @hint_button
+ @resetButton = @$('div.action button.reset')
+ @resetButton.click @reset
+ @showButton = @$('div.action button.show')
+ @showButton.click @show
+ @saveButton = @$('div.action button.save')
+ @saveButton.click @save
- @$('div.action button.hint-button').click @hint_button
- @$('div.action button.reset').click @reset
- @$('div.action button.show').click @show
- @$('div.action button.save').click @save
# Accessibility helper for sighted keyboard users to show tooltips on focus:
@$('.clarification').focus (ev) =>
icon = $(ev.target).children "i"
@@ -301,16 +305,11 @@ class @Problem
check: =>
if not @check_save_waitfor(@check_internal)
- @check_internal()
+ @disableAllButtonsWhileRunning @check_internal, true
check_internal: =>
- @enableCheckButton false
-
- timeout_id = @enableCheckButtonAfterTimeout()
-
Logger.log 'problem_check', @answers
-
- $.postWithPrefix("#{@url}/problem_check", @answers, (response) =>
+ $.postWithPrefix "#{@url}/problem_check", @answers, (response) =>
switch response.success
when 'incorrect', 'correct'
window.SR.readElts($(response.contents).find('.status'))
@@ -322,9 +321,11 @@ class @Problem
else
@gentle_alert response.success
Logger.log 'problem_graded', [@answers, response.contents], @id
- ).always(@enableCheckButtonAfterResponse)
reset: =>
+ @disableAllButtonsWhileRunning @reset_internal, false
+
+ reset_internal: =>
Logger.log 'problem_reset', @answers
$.postWithPrefix "#{@url}/problem_reset", id: @id, (response) =>
@render(response.html)
@@ -409,7 +410,7 @@ class @Problem
save: =>
if not @check_save_waitfor(@save_internal)
- @save_internal()
+ @disableAllButtonsWhileRunning @save_internal, false
save_internal: =>
Logger.log 'problem_save', @answers
@@ -674,16 +675,56 @@ class @Problem
element = $(element)
element.find("section[id^='forinput']").removeClass('choicetextgroup_show_correct')
- enableCheckButton: (enable) =>
+ disableAllButtonsWhileRunning: (operationCallback, isFromCheckOperation) =>
+ # Used to keep the buttons disabled while operationCallback is running.
+ # params:
+ # 'operationCallback' is an operation to be run.
+ # 'isFromCheckOperation' is a boolean to keep track if 'operationCallback' was
+ # @check, if so then text of check button will be changed as well.
+ @enableAllButtons false, isFromCheckOperation
+ operationCallback().always =>
+ @enableAllButtons true, isFromCheckOperation
+
+ enableAllButtons: (enable, isFromCheckOperation) =>
+ # Used to enable/disable all buttons in problem.
+ # params:
+ # 'enable' is a boolean to determine enabling/disabling of buttons.
+ # 'isFromCheckOperation' is a boolean to keep track if operation was initiated
+ # from @check so that text of check button will also be changed while disabling/enabling
+ # the check button.
+ if enable
+ @resetButton
+ .add(@saveButton)
+ .add(@hintButton)
+ .add(@showButton)
+ .removeClass('is-disabled')
+ .attr({'aria-disabled': 'false'})
+ else
+ @resetButton
+ .add(@saveButton)
+ .add(@hintButton)
+ .add(@showButton)
+ .addClass('is-disabled')
+ .attr({'aria-disabled': 'true'})
+
+ @enableCheckButton enable, isFromCheckOperation
+
+ enableCheckButton: (enable, changeText = true) =>
# Used to disable check button to reduce chance of accidental double-submissions.
+ # params:
+ # 'enable' is a boolean to determine enabling/disabling of check button.
+ # 'changeText' is a boolean to determine if there is need to change the
+ # text of check button as well.
if enable
@checkButton.removeClass 'is-disabled'
@checkButton.attr({'aria-disabled': 'false'})
- @checkButtonLabel.text(@checkButtonCheckText)
+ if changeText
+ @checkButtonLabel.text(@checkButtonCheckText)
else
@checkButton.addClass 'is-disabled'
@checkButton.attr({'aria-disabled': 'true'})
- @checkButtonLabel.text(@checkButtonCheckingText)
+ if changeText
+ @checkButtonLabel.text(@checkButtonCheckingText)
enableCheckButtonAfterResponse: =>
@has_response = true
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/.gitignore b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/.gitignore
deleted file mode 100644
index d4aa116a26..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-!*.js
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/el_output.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/el_output.js
deleted file mode 100644
index f81cdc000b..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/el_output.js
+++ /dev/null
@@ -1,141 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define('ElOutput', [], function () {
-
- return ElOutput;
-
- function ElOutput(config, state) {
-
- if ($.isPlainObject(config.functions["function"])) {
- processFuncObj(config.functions["function"]);
- } else if ($.isArray(config.functions["function"])) {
- (function (c1) {
- while (c1 < config.functions["function"].length) {
- if ($.isPlainObject(config.functions["function"][c1])) {
- processFuncObj(config.functions["function"][c1]);
- }
-
- c1 += 1;
- }
- }(0));
- }
-
- return;
-
- function processFuncObj(obj) {
- var paramNames, funcString, func, el, disableAutoReturn, updateOnEvent;
-
- // We are only interested in functions that are meant for output to an
- // element.
- if (
- (typeof obj['@output'] !== 'string') ||
- ((obj['@output'].toLowerCase() !== 'element') && (obj['@output'].toLowerCase() !== 'none'))
- ) {
- return;
- }
-
- if (typeof obj['@el_id'] !== 'string') {
- console.log('ERROR: You specified "output" as "element", but did not spify "el_id".');
-
- return;
- }
-
- if (typeof obj['#text'] !== 'string') {
- console.log('ERROR: Function body is not defined.');
-
- return;
- }
-
- updateOnEvent = 'slide';
- if (
- (obj.hasOwnProperty('@update_on') === true) &&
- (typeof obj['@update_on'] === 'string') &&
- ((obj['@update_on'].toLowerCase() === 'slide') || (obj['@update_on'].toLowerCase() === 'change'))
- ) {
- updateOnEvent = obj['@update_on'].toLowerCase();
- }
-
- disableAutoReturn = obj['@disable_auto_return'];
-
- funcString = obj['#text'];
-
- if (
- (disableAutoReturn === undefined) ||
- (
- (typeof disableAutoReturn === 'string') &&
- (disableAutoReturn.toLowerCase() !== 'true')
- )
- ) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- // Make sure that all HTML entities are converted to their proper
- // ASCII text equivalents.
- funcString = $('
').html(funcString).text();
-
- paramNames = state.getAllParameterNames();
- paramNames.push(funcString);
-
- try {
- func = Function.apply(null, paramNames);
- } catch (err) {
- console.log(
- 'ERROR: The function body "' +
- funcString +
- '" was not converted by the Function constructor.'
- );
- console.log('Error message: "' + err.message + '".');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not create a function from string "' + funcString + '".' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- paramNames.pop();
-
- return;
- }
-
- paramNames.pop();
-
- if (obj['@output'].toLowerCase() !== 'none') {
- el = $('#' + obj['@el_id']);
-
- if (el.length !== 1) {
- console.log(
- 'ERROR: DOM element with ID "' + obj['@el_id'] + '" ' +
- 'not found. Dynamic element not created.'
- );
-
- return;
- }
-
- el.html(func.apply(window, state.getAllParameterValues()));
- } else {
- el = null;
- func.apply(window, state.getAllParameterValues());
- }
-
- state.addDynamicEl(el, func, obj['@el_id'], updateOnEvent);
- }
-
- }
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/g_label_el_output.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/g_label_el_output.js
deleted file mode 100644
index 3ad264d9eb..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/g_label_el_output.js
+++ /dev/null
@@ -1,115 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define('GLabelElOutput', [], function () {
- return GLabelElOutput;
-
- function GLabelElOutput(config, state) {
- if ($.isPlainObject(config.functions["function"])) {
- processFuncObj(config.functions["function"]);
- } else if ($.isArray(config.functions["function"])) {
- (function (c1) {
- while (c1 < config.functions["function"].length) {
- if ($.isPlainObject(config.functions["function"][c1])) {
- processFuncObj(config.functions["function"][c1]);
- }
-
- c1 += 1;
- }
- }(0));
- }
-
- return;
-
- function processFuncObj(obj) {
- var paramNames, funcString, func, disableAutoReturn;
-
- // We are only interested in functions that are meant for output to an
- // element.
- if (
- (typeof obj['@output'] !== 'string') ||
- (obj['@output'].toLowerCase() !== 'plot_label')
- ) {
- return;
- }
-
- if (typeof obj['@el_id'] !== 'string') {
- console.log('ERROR: You specified "output" as "plot_label", but did not spify "el_id".');
-
- return;
- }
-
- if (typeof obj['#text'] !== 'string') {
- console.log('ERROR: Function body is not defined.');
-
- return;
- }
-
- disableAutoReturn = obj['@disable_auto_return'];
-
- funcString = obj['#text'];
-
- if (
- (disableAutoReturn === undefined) ||
- (
- (typeof disableAutoReturn === 'string') &&
- (disableAutoReturn.toLowerCase() !== 'true')
- )
- ) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- // Make sure that all HTML entities are converted to their proper
- // ASCII text equivalents.
- funcString = $('
').html(funcString).text();
-
- paramNames = state.getAllParameterNames();
- paramNames.push(funcString);
-
- try {
- func = Function.apply(null, paramNames);
- } catch (err) {
- console.log(
- 'ERROR: The function body "' +
- funcString +
- '" was not converted by the Function constructor.'
- );
- console.log('Error message: "' + err.message + '".');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not create a function from string "' + funcString + '".' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- paramNames.pop();
-
- return;
- }
-
- paramNames.pop();
-
- state.plde.push({
- 'elId': obj['@el_id'],
- 'func': func
- });
- }
-
- }
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/general_methods.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/general_methods.js
deleted file mode 100644
index 9cdd4fff0f..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/general_methods.js
+++ /dev/null
@@ -1,23 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define('GeneralMethods', [], function () {
- if (!String.prototype.trim) {
- // http://blog.stevenlevithan.com/archives/faster-trim-javascript
- String.prototype.trim = function trim(str) {
- return str.replace(/^\s\s*/, '').replace(/\s\s*$/, '');
- };
- }
-
- return {
- 'module_name': 'GeneralMethods',
- 'module_status': 'OK'
- };
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/graph.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/graph.js
deleted file mode 100644
index cc221490eb..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/graph.js
+++ /dev/null
@@ -1,1512 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define('Graph', [], function () {
-
- return Graph;
-
- function Graph(gstId, config, state) {
- var plotDiv, dataSeries, functions, xaxis, yaxis, numPoints, xrange,
- asymptotes, movingLabels, xTicksNames, yTicksNames, graphBarWidth, graphBarAlign;
-
- // We need plot configuration settings. Without them we can't continue.
- if ($.isPlainObject(config.plot) === false) {
- return;
- }
-
- // We must have a graph container DIV element available in order to
- // proceed.
- plotDiv = $('#' + gstId + '_plot');
- if (plotDiv.length === 0) {
- console.log('ERROR: Could not find the plot DIV with ID "' + gstId + '_plot".');
-
- return;
- }
-
- if (plotDiv.width() === 0) {
- plotDiv.width(300);
- }
-
- // Sometimes, when height is not explicitly set via CSS (or by some
- // other means), it is 0 pixels by default. When Flot will try to plot
- // a graph in this DIV with 0 height, then it will raise an error. To
- // prevent this, we will set it to be equal to the width.
- if (plotDiv.height() === 0) {
- plotDiv.height(plotDiv.width());
- }
-
- plotDiv.css('position', 'relative');
-
- // Configure some settings for the graph.
- if (setGraphXRange() === false) {
- console.log('ERROR: Could not configure the xrange. Will not continue.');
-
- return;
- }
-
- if (setGraphAxes() === false) {
- console.log('ERROR: Could not process configuration for the axes.');
-
- return;
- }
-
- graphBarWidth = 1;
- graphBarAlign = null;
-
- getBarWidth();
- getBarAlign();
-
- // Get the user defined functions. If there aren't any, don't do
- // anything else.
- createFunctions();
-
- if (functions.length === 0) {
- console.log('ERROR: No functions were specified, or something went wrong.');
-
- return;
- }
-
- if (createMarkingsFunctions() === false) {
- return;
- }
- if (createMovingLabelFunctions() === false) {
- return;
- }
-
- // Create the initial graph and plot it for the user to see.
- if (generateData() === true) {
- updatePlot();
- }
-
- // Bind an event. Whenever some constant changes, the graph will be
- // redrawn
- state.bindUpdatePlotEvent(plotDiv, onUpdatePlot);
-
- return;
-
- function getBarWidth() {
- if (config.plot.hasOwnProperty('bar_width') === false) {
- return;
- }
-
- if (typeof config.plot.bar_width !== 'string') {
- console.log('ERROR: The parameter config.plot.bar_width must be a string.');
-
- return;
- }
-
- if (isFinite(graphBarWidth = parseFloat(config.plot.bar_width)) === false) {
- console.log('ERROR: The parameter config.plot.bar_width is not a valid floating number.');
- graphBarWidth = 1;
-
- return;
- }
-
- return;
- }
-
- function getBarAlign() {
- if (config.plot.hasOwnProperty('bar_align') === false) {
- return;
- }
-
- if (typeof config.plot.bar_align !== 'string') {
- console.log('ERROR: The parameter config.plot.bar_align must be a string.');
-
- return;
- }
-
- if (
- (config.plot.bar_align.toLowerCase() !== 'left') &&
- (config.plot.bar_align.toLowerCase() !== 'center')
- ) {
- console.log('ERROR: Property config.plot.bar_align can be one of "left", or "center".');
-
- return;
- }
-
- graphBarAlign = config.plot.bar_align.toLowerCase();
-
- return;
- }
-
- function createMovingLabelFunctions() {
- var c1, returnStatus;
-
- returnStatus = true;
- movingLabels = [];
-
- if (config.plot.hasOwnProperty('moving_label') !== true) {
- returnStatus = true;
- } else if ($.isPlainObject(config.plot.moving_label) === true) {
- if (processMovingLabel(config.plot.moving_label) === false) {
- returnStatus = false;
- }
- } else if ($.isArray(config.plot.moving_label) === true) {
- for (c1 = 0; c1 < config.plot.moving_label.length; c1++) {
- if (processMovingLabel(config.plot.moving_label[c1]) === false) {
- returnStatus = false;
- }
- }
- }
-
- return returnStatus;
- }
-
- function processMovingLabel(obj) {
- var labelText, funcString, disableAutoReturn, paramNames, func,
- fontWeight, fontColor;
-
- if (obj.hasOwnProperty('@text') === false) {
- console.log('ERROR: You did not define a "text" attribute for the moving_label.');
-
- return false;
- }
- if (typeof obj['@text'] !== 'string') {
- console.log('ERROR: "text" attribute is not a string.');
-
- return false;
- }
- labelText = obj['@text'];
-
- if (obj.hasOwnProperty('#text') === false) {
- console.log('ERROR: moving_label is missing function declaration.');
-
- return false;
- }
- if (typeof obj['#text'] !== 'string') {
- console.log('ERROR: Function declaration is not a string.');
-
- return false;
- }
- funcString = obj['#text'];
-
- fontColor = 'black';
- if (
- (obj.hasOwnProperty('@color') === true) &&
- (typeof obj['@color'] === 'string')
- ) {
- fontColor = obj['@color'];
- }
-
- fontWeight = 'normal';
- if (
- (obj.hasOwnProperty('@weight') === true) &&
- (typeof obj['@weight'] === 'string')
- ) {
- if (
- (obj['@weight'].toLowerCase() === 'normal') ||
- (obj['@weight'].toLowerCase() === 'bold')
- ) {
- fontWeight = obj['@weight'];
- } else {
- console.log('ERROR: Moving label can have a weight property of "normal" or "bold".');
- }
- }
-
- disableAutoReturn = obj['@disable_auto_return'];
-
- funcString = $('
').html(funcString).text();
-
- if (
- (disableAutoReturn === undefined) ||
- (
- (typeof disableAutoReturn === 'string') &&
- (disableAutoReturn.toLowerCase() !== 'true')
- )
- ) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- paramNames = state.getAllParameterNames();
- paramNames.push(funcString);
-
- try {
- func = Function.apply(null, paramNames);
- } catch (err) {
- console.log(
- 'ERROR: The function body "' +
- funcString +
- '" was not converted by the Function constructor.'
- );
- console.log('Error message: "' + err.message + '"');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not create a function from the string "' + funcString + '".' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- paramNames.pop();
-
- return false;
- }
-
- paramNames.pop();
-
- movingLabels.push({
- 'labelText': labelText,
- 'func': func,
- 'el': null,
- 'fontColor': fontColor,
- 'fontWeight': fontWeight
- });
-
- return true;
- }
-
- function createMarkingsFunctions() {
- var c1, paramNames, returnStatus;
-
- returnStatus = true;
-
- asymptotes = [];
- paramNames = state.getAllParameterNames();
-
- if ($.isPlainObject(config.plot.asymptote)) {
- if (processAsymptote(config.plot.asymptote) === false) {
- returnStatus = false;
- }
- } else if ($.isArray(config.plot.asymptote)) {
- for (c1 = 0; c1 < config.plot.asymptote.length; c1 += 1) {
- if (processAsymptote(config.plot.asymptote[c1]) === false) {
- returnStatus = false;
- }
- }
- }
-
- return returnStatus;
-
- // Read configuration options for asymptotes, and store them as
- // an array of objects. Each object will have 3 properties:
- //
- // - color: the color of the asymptote line
- // - type: 'x' (vertical), or 'y' (horizontal)
- // - func: the function that will generate the value at which
- // the asymptote will be plotted; i.e. x = func(), or
- // y = func(); for now only horizontal and vertical
- // asymptotes are supported
- //
- // Since each asymptote can have a variable function - function
- // that relies on some parameter specified in the config - we will
- // generate each asymptote just before we draw the graph. See:
- //
- // function updatePlot()
- // function generateMarkings()
- //
- // Asymptotes are really thin rectangles implemented via the Flot's
- // markings option.
- function processAsymptote(asyObj) {
- var newAsyObj, funcString, func;
-
- newAsyObj = {};
-
- if (typeof asyObj['@type'] === 'string') {
- if (asyObj['@type'].toLowerCase() === 'x') {
- newAsyObj.type = 'x';
- } else if (asyObj['@type'].toLowerCase() === 'y') {
- newAsyObj.type = 'y';
- } else {
- console.log('ERROR: Attribute "type" for asymptote can be "x" or "y".');
-
- return false;
- }
- } else {
- console.log('ERROR: Attribute "type" for asymptote is not specified.');
-
- return false;
- }
-
- if (typeof asyObj['#text'] === 'string') {
- funcString = asyObj['#text'];
- } else {
- console.log('ERROR: Function body for asymptote is not specified.');
-
- return false;
- }
-
- newAsyObj.color = '#000';
- if (typeof asyObj['@color'] === 'string') {
- newAsyObj.color = asyObj['@color'];
- }
-
- newAsyObj.label = false;
- if (
- (asyObj.hasOwnProperty('@label') === true) &&
- (typeof asyObj['@label'] === 'string')
- ) {
- newAsyObj.label = asyObj['@label'];
- }
-
- funcString = $('
').html(funcString).text();
-
- disableAutoReturn = asyObj['@disable_auto_return'];
- if (
- (disableAutoReturn === undefined) ||
- (
- (typeof disableAutoReturn === 'string') &&
- (disableAutoReturn.toLowerCase() !== 'true')
- )
- ) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- paramNames.push(funcString);
-
- try {
- func = Function.apply(null, paramNames);
- } catch (err) {
- console.log('ERROR: Asymptote function body could not be converted to function object.');
- console.log('Error message: "".' + err.message);
-
- return false;
- }
-
- paramNames.pop();
-
- newAsyObj.func = func;
- asymptotes.push(newAsyObj);
-
- return true;
- }
- }
-
- function setGraphAxes() {
- xaxis = {
- 'tickFormatter': null
- };
-
- if (typeof config.plot['xticks'] === 'string') {
- if (processTicks(config.plot['xticks'], xaxis, 'xunits') === false) {
- console.log('ERROR: Could not process the ticks for x-axis.');
-
- return false;
- }
- } else {
- // console.log('MESSAGE: "xticks" were not specified. Using defaults.');
-
- return false;
- }
-
- yaxis = {
- 'tickFormatter': null
- };
- if (typeof config.plot['yticks'] === 'string') {
- if (processTicks(config.plot['yticks'], yaxis, 'yunits') === false) {
- console.log('ERROR: Could not process the ticks for y-axis.');
-
- return false;
- }
- } else {
- // console.log('MESSAGE: "yticks" were not specified. Using defaults.');
-
- return false;
- }
-
- xTicksNames = null;
- yTicksNames = null;
-
- if (checkForTicksNames('x') === false) {
- return false;
- }
-
- if (checkForTicksNames('y') === false) {
- return false;
- }
-
- return true;
-
- //
- // function checkForTicksNames(axisName)
- //
- // The parameter "axisName" can be either "x" or "y" (string). Depending on it, the function
- // will set "xTicksNames" or "yTicksNames" private variable.
- //
- // This function does not return anything. It sets the private variable "xTicksNames" ("yTicksNames")
- // to the object converted by JSON.parse from the XML parameter "plot.xticks_names" ("plot.yticks_names").
- // If the "plot.xticks_names" ("plot.yticks_names") is missing or it is not a valid JSON string, then
- // "xTicksNames" ("yTicksNames") will be set to "null".
- //
- // Depending on the "xTicksNames" ("yTicksNames") being "null" or an object, the plot will either draw
- // number ticks, or use the names specified by the opbject.
- //
- function checkForTicksNames(axisName) {
- var tmpObj;
-
- if ((axisName !== 'x') && (axisName !== 'y')) {
- // This is not an error. This funcion should simply stop executing.
-
- return true;
- }
-
- if (
- (config.plot.hasOwnProperty(axisName + 'ticks_names') === true) ||
- (typeof config.plot[axisName + 'ticks_names'] === 'string')
- ) {
- try {
- tmpObj = JSON.parse(config.plot[axisName + 'ticks_names']);
- } catch (err) {
- console.log(
- 'ERROR: plot.' + axisName + 'ticks_names is not a valid JSON string.',
- 'Error message: "' + err.message + '".'
- );
-
- return false;
- }
-
- if (axisName === 'x') {
- xTicksNames = tmpObj;
- xaxis.tickFormatter = xAxisTickFormatter;
- }
- // At this point, we are certain that axisName = 'y'.
- else {
- yTicksNames = tmpObj;
- yaxis.tickFormatter = yAxisTickFormatter;
- }
- }
- }
-
- function processTicks(ticksStr, ticksObj, unitsType) {
- var ticksBlobs, tempFloat, tempTicks, c1, c2;
-
- // The 'ticks' setting is a string containing 3 floating-point
- // numbers.
- ticksBlobs = ticksStr.split(',');
-
- if (ticksBlobs.length !== 3) {
- console.log('ERROR: Did not get 3 blobs from ticksStr = "' + ticksStr + '".');
-
- return false;
- }
-
- tempFloat = parseFloat(ticksBlobs[0]);
- if (isNaN(tempFloat) === false) {
- ticksObj.min = tempFloat;
- } else {
- console.log('ERROR: Invalid "min". ticksBlobs[0] = ', ticksBlobs[0]);
-
- return false;
- }
-
- tempFloat = parseFloat(ticksBlobs[1]);
- if (isNaN(tempFloat) === false) {
- ticksObj.tickSize = tempFloat;
- } else {
- console.log('ERROR: Invalid "tickSize". ticksBlobs[1] = ', ticksBlobs[1]);
-
- return false;
- }
-
- tempFloat = parseFloat(ticksBlobs[2]);
- if (isNaN(tempFloat) === false) {
- ticksObj.max = tempFloat;
- } else {
- console.log('ERROR: Invalid "max". ticksBlobs[2] = ', ticksBlobs[2]);
-
- return false;
- }
-
- // Is the starting tick to the left of the ending tick (on the
- // x-axis)? If not, set default starting and ending tick.
- if (ticksObj.min >= ticksObj.max) {
- console.log('ERROR: Ticks min >= max.');
-
- return false;
- }
-
- // Make sure the range makes sense - i.e. that there are at
- // least 3 ticks. If not, set a tickSize which will produce
- // 11 ticks. tickSize is the spacing between the ticks.
- if (ticksObj.tickSize > ticksObj.max - ticksObj.min) {
- console.log('ERROR: tickSize > max - min.');
-
- return false;
- }
-
- // units: change last tick to units
- if (typeof config.plot[unitsType] === 'string') {
- tempTicks = [];
-
- for (c1 = ticksObj.min; c1 <= ticksObj.max; c1 += ticksObj.tickSize) {
- c2 = roundToPrec(c1, ticksObj.tickSize);
- tempTicks.push([c2, c2]);
- }
-
- tempTicks.pop();
- tempTicks.push([
- roundToPrec(ticksObj.max, ticksObj.tickSize),
- config.plot[unitsType]
- ]);
-
- ticksObj.tickSize = null;
- ticksObj.ticks = tempTicks;
- }
-
- return true;
-
- function roundToPrec(num, prec) {
- var c1, tn1, tn2, digitsBefore, digitsAfter;
-
- tn1 = Math.abs(num);
- tn2 = Math.abs(prec);
-
- // Find out number of digits BEFORE the decimal point.
- c1 = 0;
- tn1 = Math.abs(num);
- while (tn1 >= 1) {
- c1 += 1;
-
- tn1 /= 10;
- }
- digitsBefore = c1;
-
- // Find out number of digits AFTER the decimal point.
- c1 = 0;
- tn1 = Math.abs(num);
- while (Math.round(tn1) !== tn1) {
- c1 += 1;
-
- tn1 *= 10;
- }
- digitsAfter = c1;
-
- // For precision, find out number of digits AFTER the
- // decimal point.
- c1 = 0;
- while (Math.round(tn2) !== tn2) {
- c1 += 1;
-
- tn2 *= 10;
- }
-
- // If precision is more than 1 (no digits after decimal
- // points).
- if (c1 === 0) {
- return num;
- }
-
- // If the precision contains digits after the decimal
- // point, we apply special rules.
- else {
- tn1 = Math.abs(num);
-
- // if (digitsAfter > c1) {
- tn1 = tn1.toFixed(c1);
- // } else {
- // tn1 = tn1.toPrecision(digitsBefore + digitsAfter);
- // }
- }
-
- if (num < 0) {
- return -tn1;
- }
-
- return tn1;
- }
- }
- }
-
- function setGraphXRange() {
- var xRangeStr, xRangeBlobs, tempNum, allParamNames, funcString,
- disableAutoReturn;
-
- xrange = {};
-
- if ($.isPlainObject(config.plot.xrange) === false) {
- console.log(
- 'ERROR: Expected config.plot.xrange to be an object. ' +
- 'It is not.'
- );
- console.log('config.plot.xrange = ', config.plot.xrange);
-
- return false;
- }
-
- if (config.plot.xrange.hasOwnProperty('min') === false) {
- console.log(
- 'ERROR: Expected config.plot.xrange.min to be ' +
- 'present. It is not.'
- );
-
- return false;
- }
-
- disableAutoReturn = false;
- if (typeof config.plot.xrange.min === 'string') {
- funcString = config.plot.xrange.min;
- } else if (
- ($.isPlainObject(config.plot.xrange.min) === true) &&
- (config.plot.xrange.min.hasOwnProperty('#text') === true) &&
- (typeof config.plot.xrange.min['#text'] === 'string')
- ) {
- funcString = config.plot.xrange.min['#text'];
-
- disableAutoReturn =
- config.plot.xrange.min['@disable_auto_return'];
- if (
- (disableAutoReturn === undefined) ||
- (
- (typeof disableAutoReturn === 'string') &&
- (disableAutoReturn.toLowerCase() !== 'true')
- )
- ) {
- disableAutoReturn = false;
- } else {
- disableAutoReturn = true;
- }
- } else {
- console.log(
- 'ERROR: Could not get a function definition for ' +
- 'xrange.min property.'
- );
-
- return false;
- }
-
- funcString = $('
').html(funcString).text();
-
- if (disableAutoReturn === false) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- allParamNames = state.getAllParameterNames();
-
- allParamNames.push(funcString);
- try {
- xrange.min = Function.apply(null, allParamNames);
- } catch (err) {
- console.log(
- 'ERROR: could not create a function from the string "' +
- funcString + '" for xrange.min.'
- );
- console.log('Error message: "' + err.message + '"');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html(
- '
' + 'ERROR IN ' +
- 'XML: Could not create a function from the string "' +
- funcString + '" for xrange.min.' + '
').html(funcString).text();
-
- if (disableAutoReturn === false) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- allParamNames.push(funcString);
- try {
- xrange.max = Function.apply(null, allParamNames);
- } catch (err) {
- console.log(
- 'ERROR: could not create a function from the string "' +
- funcString + '" for xrange.max.'
- );
- console.log('Error message: "' + err.message + '"');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html(
- '
' + 'ERROR IN ' +
- 'XML: Could not create a function from the string "' +
- funcString + '" for xrange.max.' + '
'
- );
- $('#' + gstId).append(
- '
' + 'Error message: "' +
- err.message + '".' + '
'
- );
- }
-
- return false;
- }
- allParamNames.pop();
-
- tempNum = parseInt(config.plot.num_points, 10);
- if (isFinite(tempNum) === false) {
- tempNum = plotDiv.width() / 5.0;
- }
-
- if (
- (tempNum < 2) &&
- (tempNum > 1000)
- ) {
- console.log(
- 'ERROR: Number of points is outside the allowed range ' +
- '[2, 1000]'
- );
- console.log('config.plot.num_points = ' + tempNum);
-
- return false;
- }
-
- numPoints = tempNum;
-
- return true;
- }
-
- function createFunctions() {
- var c1;
-
- functions = [];
-
- if (typeof config.functions === 'undefined') {
- console.log('ERROR: config.functions is undefined.');
-
- return;
- }
-
- if (typeof config.functions["function"] === 'string') {
-
- // If just one function string is present.
- addFunction(config.functions["function"]);
-
- } else if ($.isPlainObject(config.functions["function"]) === true) {
-
- // If a function is present, but it also has properties
- // defined.
- callAddFunction(config.functions["function"]);
-
- } else if ($.isArray(config.functions["function"])) {
-
- // If more than one function is defined.
- for (c1 = 0; c1 < config.functions["function"].length; c1 += 1) {
-
- // For each definition, we must check if it is a simple
- // string definition, or a complex one with properties.
- if (typeof config.functions["function"][c1] === 'string') {
-
- // Simple string.
- addFunction(config.functions["function"][c1]);
-
- } else if ($.isPlainObject(config.functions["function"][c1])) {
-
- // Properties are present.
- callAddFunction(config.functions["function"][c1]);
-
- }
- }
- } else {
- console.log('ERROR: config.functions.function is of an unsupported type.');
-
- return;
- }
-
- return;
-
- // This function will reduce code duplication. We have to call
- // the function addFunction() several times passing object
- // properties as parameters. Rather than writing them out every
- // time, we will have a single place where it is done.
- function callAddFunction(obj) {
- if (
- (obj.hasOwnProperty('@output')) &&
- (typeof obj['@output'] === 'string')
- ) {
-
- // If this function is meant to be calculated for an
- // element then skip it.
- if ((obj['@output'].toLowerCase() === 'element') ||
- (obj['@output'].toLowerCase() === 'none')) {
- return;
- }
-
- // If this function is meant to be calculated for a
- // dynamic element in a label then skip it.
- else if (obj['@output'].toLowerCase() === 'plot_label') {
- return;
- }
-
- // It is an error if '@output' is not 'element',
- // 'plot_label', or 'graph'. However, if the '@output'
- // attribute is omitted, we will not have reached this.
- else if (obj['@output'].toLowerCase() !== 'graph') {
- console.log(
- 'ERROR: Function "output" attribute can be ' +
- 'either "element", "plot_label", "none" or "graph".'
- );
-
- return;
- }
-
- }
-
- // The user did not specify an "output" attribute, or it is
- // "graph".
- addFunction(
- obj['#text'],
- obj['@color'],
- obj['@line'],
- obj['@dot'],
- obj['@label'],
- obj['@point_size'],
- obj['@fill_area'],
- obj['@bar'],
- obj['@disable_auto_return']
- );
- }
-
- function addFunction(funcString, color, line, dot, label,
- pointSize, fillArea, bar, disableAutoReturn) {
-
- var newFunctionObject, func, paramNames, c1, rgxp;
-
- // The main requirement is function string. Without it we can't
- // create a function, and the series cannot be calculated.
- if (typeof funcString !== 'string') {
- return;
- }
-
- // Make sure that any HTML entities that were escaped will be
- // unescaped. This is done because if a string with escaped
- // HTML entities is passed to the Function() constructor, it
- // will break.
- funcString = $('
').html(funcString).text();
-
- // If the user did not specifically turn off this feature,
- // check if the function string contains a 'return', and
- // prepend a 'return ' to the string if one, or more, is not
- // found.
- if (
- (disableAutoReturn === undefined) ||
- (
- (typeof disableAutoReturn === 'string') &&
- (disableAutoReturn.toLowerCase() !== 'true')
- )
- ) {
- if (funcString.search(/return/i) === -1) {
- funcString = 'return ' + funcString;
- }
- } else {
- if (funcString.search(/return/i) === -1) {
- console.log(
- 'ERROR: You have specified a JavaScript ' +
- 'function without a "return" statemnt. Your ' +
- 'function will return "undefined" by default.'
- );
- }
- }
-
- // Some defaults. If no options are set for the graph, we will
- // make sure that at least a line is drawn for a function.
- newFunctionObject = {
- 'line': true,
- 'dot': false,
- 'bars': false
- };
-
- // Get all of the parameter names defined by the user in the
- // XML.
- paramNames = state.getAllParameterNames();
-
- // The 'x' is always one of the function parameters.
- paramNames.push('x');
-
- // Must make sure that the function body also gets passed to
- // the Function constructor.
- paramNames.push(funcString);
-
- // Create the function from the function string, and all of the
- // available parameters AND the 'x' variable as it's parameters.
- // For this we will use the built-in Function object
- // constructor.
- //
- // If something goes wrong during this step, most
- // likely the user supplied an invalid JavaScript function body
- // string. In this case we will not proceed.
- try {
- func = Function.apply(null, paramNames);
- } catch (err) {
- console.log(
- 'ERROR: The function body "' +
- funcString +
- '" was not converted by the Function constructor.'
- );
- console.log('Error message: "' + err.message + '"');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not create a function from the string "' + funcString + '".' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- paramNames.pop();
- paramNames.pop();
-
- return;
- }
-
- // Return the array back to original state. Remember that it is
- // a pointer to original array which is stored in state object.
- paramNames.pop();
- paramNames.pop();
-
- newFunctionObject['func'] = func;
-
- if (typeof color === 'string') {
- newFunctionObject['color'] = color;
- }
-
- if (typeof line === 'string') {
- if (line.toLowerCase() === 'true') {
- newFunctionObject['line'] = true;
- } else if (line.toLowerCase() === 'false') {
- newFunctionObject['line'] = false;
- }
- }
-
- if (typeof dot === 'string') {
- if (dot.toLowerCase() === 'true') {
- newFunctionObject['dot'] = true;
- } else if (dot.toLowerCase() === 'false') {
- newFunctionObject['dot'] = false;
- }
- }
-
- if (typeof pointSize === 'string') {
- newFunctionObject['pointSize'] = pointSize;
- }
-
- if (typeof bar === 'string') {
- if (bar.toLowerCase() === 'true') {
- newFunctionObject['bars'] = true;
- } else if (bar.toLowerCase() === 'false') {
- newFunctionObject['bars'] = false;
- }
- }
-
- if (newFunctionObject['bars'] === true) {
- newFunctionObject['line'] = false;
- newFunctionObject['dot'] = false;
- // To do: See if need to do anything here.
- } else if (
- (newFunctionObject['dot'] === false) &&
- (newFunctionObject['line'] === false)
- ) {
- newFunctionObject['line'] = true;
- }
-
- if (newFunctionObject['line'] === true) {
- if (typeof fillArea === 'string') {
- if (fillArea.toLowerCase() === 'true') {
- newFunctionObject['fillArea'] = true;
- } else if (fillArea.toLowerCase() === 'false') {
- newFunctionObject['fillArea'] = false;
- } else {
- console.log('ERROR: The attribute fill_area should be either "true" or "false".');
- console.log('fill_area = "' + fillArea + '".');
-
- return;
- }
- }
- }
-
- if (typeof label === 'string') {
-
- newFunctionObject.specialLabel = false;
- newFunctionObject.pldeHash = [];
-
- // Let's check the label against all of the plde objects.
- // plde is an abbreviation for Plot Label Dynamic Elements.
- for (c1 = 0; c1 < state.plde.length; c1 += 1) {
- rgxp = new RegExp(state.plde[c1].elId, 'g');
-
- // If we find a dynamic element in the label, we will
- // hash the current plde object, and indicate that this
- // is a special label.
- if (rgxp.test(label) === true) {
- newFunctionObject.specialLabel = true;
- newFunctionObject.pldeHash.push(state.plde[c1]);
- }
- }
-
- newFunctionObject.label = label;
- } else {
- newFunctionObject.label = false;
- }
-
- functions.push(newFunctionObject);
- }
- }
-
- // The callback that will be called whenever a constant changes (gets
- // updated via a slider or a text input).
- function onUpdatePlot(event) {
- if (generateData() === true) {
- updatePlot();
- }
- }
-
- function generateData() {
- var c0, c1, c3, functionObj, seriesObj, dataPoints, paramValues, x, y,
- start, end, step, numNotUndefined;
-
- paramValues = state.getAllParameterValues();
-
- dataSeries = [];
-
- for (c0 = 0; c0 < functions.length; c0 += 1) {
- functionObj = functions[c0];
-
- try {
- start = xrange.min.apply(window, paramValues);
- } catch (err) {
- console.log('ERROR: Could not determine xrange start.');
- console.log('Error message: "' + err.message + '".');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not determine xrange start from defined function.' + '
' + 'ERROR IN XML: Could not determine xrange end from defined function.' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- return false;
- }
-
- seriesObj = {};
- dataPoints = [];
-
- // For counting number of points added. In the end we will
- // compare this number to 'numPoints' specified in the config
- // JSON.
- c1 = 0;
-
- step = (end - start) / (numPoints - 1);
-
- // Generate the data points.
- for (x = start; x <= end; x += step) {
-
- // Push the 'x' variable to the end of the parameter array.
- paramValues.push(x);
-
- // We call the user defined function, passing all of the
- // available parameter values. Inside this function they
- // will be accessible by their names.
- try {
- y = functionObj.func.apply(window, paramValues);
- } catch (err) {
- console.log('ERROR: Could not generate data.');
- console.log('Error message: "' + err.message + '".');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not generate data from defined function.' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- return false;
- }
-
- // Return the paramValues array to how it was before we
- // added 'x' variable to the end of it.
- paramValues.pop();
-
- // Add the generated point to the data points set.
- dataPoints.push([x, y]);
-
- c1 += 1;
-
- }
-
- // If the last point did not get included because of rounding
- // of floating-point number addition, then we will include it
- // manually.
- if (c1 != numPoints) {
- x = end;
- paramValues.push(x);
- try {
- y = functionObj.func.apply(window, paramValues);
- } catch (err) {
- console.log('ERROR: Could not generate data.');
- console.log('Error message: "' + err.message + '".');
-
- if (state.showDebugInfo) {
- $('#' + gstId).html('
' + 'ERROR IN XML: Could not generate data from function.' + '
');
- $('#' + gstId).append('
' + 'Error message: "' + err.message + '".' + '
');
- }
-
- return false;
- }
- paramValues.pop();
- dataPoints.push([x, y]);
- }
-
- // Put the entire data points set into the series object.
- seriesObj.data = dataPoints;
-
- // See if user defined a specific color for this function.
- if (functionObj.hasOwnProperty('color') === true) {
- seriesObj.color = functionObj.color;
- }
-
- // See if a user defined a label for this function.
- if (functionObj.label !== false) {
- if (functionObj.specialLabel === true) {
- (function (c1) {
- var tempLabel;
-
- tempLabel = functionObj.label;
-
- while (c1 < functionObj.pldeHash.length) {
- tempLabel = tempLabel.replace(
- functionObj.pldeHash[c1].elId,
- functionObj.pldeHash[c1].func.apply(
- window,
- state.getAllParameterValues()
- )
- );
-
- c1 += 1;
- }
-
- seriesObj.label = tempLabel;
- }(0));
- } else {
- seriesObj.label = functionObj.label;
- }
- }
-
- // Should the data points be connected by a line?
- seriesObj.lines = {
- 'show': functionObj.line
- };
-
- if (functionObj.hasOwnProperty('fillArea') === true) {
- seriesObj.lines.fill = functionObj.fillArea;
- }
-
- // Should each data point be represented by a point on the
- // graph?
- seriesObj.points = {
- 'show': functionObj.dot
- };
-
- seriesObj.bars = {
- 'show': functionObj.bars,
- 'barWidth': graphBarWidth
- };
-
- if (graphBarAlign !== null) {
- seriesObj.bars.align = graphBarAlign;
- }
-
- if (functionObj.hasOwnProperty('pointSize')) {
- seriesObj.points.radius = functionObj.pointSize;
- }
-
- // Add the newly created series object to the series set which
- // will be plotted by Flot.
- dataSeries.push(seriesObj);
- }
-
- if (graphBarAlign === null) {
- for (c0 = 0; c0 < numPoints; c0 += 1) {
- // Number of points that have a value other than 'undefined' (undefined).
- numNotUndefined = 0;
-
- for (c1 = 0; c1 < dataSeries.length; c1 += 1) {
- if (dataSeries[c1].bars.show === false) {
- continue;
- }
-
- if (isFinite(parseInt(dataSeries[c1].data[c0][1])) === true) {
- numNotUndefined += 1;
- }
- }
-
- c3 = 0;
- for (c1 = 0; c1 < dataSeries.length; c1 += 1) {
- if (dataSeries[c1].bars.show === false) {
- continue;
- }
-
- dataSeries[c1].data[c0][0] -= graphBarWidth * (0.5 * numNotUndefined - c3);
-
- if (isFinite(parseInt(dataSeries[c1].data[c0][1])) === true) {
- c3 += 1;
- }
- }
- }
- }
-
- for (c0 = 0; c0 < asymptotes.length; c0 += 1) {
-
- // If the user defined a label for this asympote, then the
- // property 'label' will be a string (in the other case it is
- // a boolean value 'false'). We will create an empty data set,
- // and add to it a label. This solution is a bit _wrong_ , but
- // it will have to do for now. Flot JS does not provide a way
- // to add labels to markings, and we use markings to generate
- // asymptotes.
- if (asymptotes[c0].label !== false) {
- dataSeries.push({
- 'data': [],
- 'label': asymptotes[c0].label,
- 'color': asymptotes[c0].color
- });
- }
-
- }
-
- return true;
- } // End-of: function generateData
-
- function updatePlot() {
- var paramValues, plotObj;
-
- paramValues = state.getAllParameterValues();
-
- if (xaxis.tickFormatter !== null) {
- xaxis.ticks = null;
- }
-
- if (yaxis.tickFormatter !== null) {
- yaxis.ticks = null;
- }
-
- // Tell Flot to draw the graph to our specification.
- plotObj = $.plot(
- plotDiv,
- dataSeries,
- {
- 'xaxis': xaxis,
- 'yaxis': yaxis,
- 'legend': {
-
- // To show the legend or not. Note, even if 'show' is
- // 'true', the legend will only show if labels are
- // provided for at least one of the series that are
- // going to be plotted.
- 'show': true,
-
- // A floating point number in the range [0, 1]. The
- // smaller the number, the more transparent will the
- // legend background become.
- 'backgroundOpacity': 0
-
- },
- 'grid': {
- 'markings': generateMarkings()
- }
- }
- );
-
- updateMovingLabels();
-
- // The first time that the graph gets added to the page, the legend
- // is created from scratch. When it appears, MathJax works some
- // magic, and all of the specially marked TeX gets rendered nicely.
- // The next time when we update the graph, no such thing happens.
- // We must ask MathJax to typeset the legend again (well, we will
- // ask it to look at our entire graph DIV), the next time it's
- // worker queue is available.
- MathJax.Hub.Queue([
- 'Typeset',
- MathJax.Hub,
- plotDiv.attr('id')
- ]);
-
- return;
-
- function updateMovingLabels() {
- var c1, labelCoord, pointOffset;
-
- for (c1 = 0; c1 < movingLabels.length; c1 += 1) {
- if (movingLabels[c1].el === null) {
- movingLabels[c1].el = $(
- '
' +
- movingLabels[c1].labelText +
- '
'
- );
- movingLabels[c1].el.css('position', 'absolute');
- movingLabels[c1].el.css('color', movingLabels[c1].fontColor);
- movingLabels[c1].el.css('font-weight', movingLabels[c1].fontWeight);
- movingLabels[c1].el.appendTo(plotDiv);
-
- movingLabels[c1].elWidth = movingLabels[c1].el.width();
- movingLabels[c1].elHeight = movingLabels[c1].el.height();
- } else {
- movingLabels[c1].el.detach();
- movingLabels[c1].el.appendTo(plotDiv);
- }
-
- labelCoord = movingLabels[c1].func.apply(window, paramValues);
-
- pointOffset = plotObj.pointOffset({'x': labelCoord.x, 'y': labelCoord.y});
-
- movingLabels[c1].el.css('left', pointOffset.left - 0.5 * movingLabels[c1].elWidth);
- movingLabels[c1].el.css('top', pointOffset.top - 0.5 * movingLabels[c1].elHeight);
- }
- }
-
- // Generate markings to represent asymptotes defined by the user.
- // See the following function for more details:
- //
- // function processAsymptote()
- //
- function generateMarkings() {
- var c1, asymptote, markings, val;
-
- markings = [];
-
- for (c1 = 0; c1 < asymptotes.length; c1 += 1) {
- asymptote = asymptotes[c1];
-
- try {
- val = asymptote.func.apply(window, paramValues);
- } catch (err) {
- console.log('ERROR: Could not generate value from asymptote function.');
- console.log('Error message: ', err.message);
-
- continue;
- }
-
- if (asymptote.type === 'x') {
- markings.push({
- 'color': asymptote.color,
- 'lineWidth': 2,
- 'xaxis': {
- 'from': val,
- 'to': val
- }
- });
- } else {
- markings.push({
- 'color': asymptote.color,
- 'lineWidth': 2,
- 'yaxis': {
- 'from': val,
- 'to': val
- }
- });
-
- }
- }
-
- return markings;
- }
- }
-
- function xAxisTickFormatter(val, axis) {
- if (xTicksNames.hasOwnProperty(val.toFixed(axis.tickDecimals)) === true) {
- return xTicksNames[val.toFixed(axis.tickDecimals)];
- }
-
- return '';
- }
-
- function yAxisTickFormatter(val, axis) {
- if (yTicksNames.hasOwnProperty(val.toFixed(axis.tickDecimals)) === true) {
- return yTicksNames[val.toFixed(axis.tickDecimals)];
- }
-
- return '';
- }
- }
-
-
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/gst.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/gst.js
deleted file mode 100644
index 73252455d0..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/gst.js
+++ /dev/null
@@ -1,22 +0,0 @@
-/*
- * We will add a function that will be called for all GraphicalSliderTool
- * xmodule module instances. It must be available globally by design of
- * xmodule.
- */
-window.GraphicalSliderTool = function (el) {
- // All the work will be performed by the GstMain module. We will get access
- // to it, and all it's dependencies, via Require JS. Currently Require JS
- // is namespaced and is available via a global object RequireJS.
- RequireJS.require(['GstMain'], function (GstMain) {
- // The GstMain module expects the DOM ID of a Graphical Slider Tool
- // element. Since we are given a element which might in
- // theory contain multiple graphical_slider_tool
elements (each
- // with a unique DOM ID), we will iterate over all children, and for
- // each match, we will call GstMain module.
- $(el).children('.graphical_slider_tool').each(function (index, value) {
- JavascriptLoader.executeModuleScripts($(value), function(){
- GstMain($(value).attr('id'));
- });
- });
- });
-};
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/gst_main.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/gst_main.js
deleted file mode 100644
index 733e570333..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/gst_main.js
+++ /dev/null
@@ -1,86 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define(
- 'GstMain',
-
- // Even though it is not explicitly in this module, we have to specify
- // 'GeneralMethods' as a dependency. It expands some of the core JS objects
- // with additional useful methods that are used in other modules.
- ['State', 'GeneralMethods', 'Sliders', 'Inputs', 'Graph', 'ElOutput', 'GLabelElOutput'],
- function (State, GeneralMethods, Sliders, Inputs, Graph, ElOutput, GLabelElOutput) {
-
- return GstMain;
-
- function GstMain(gstId) {
- var config, gstClass, state;
-
- if ($('#' + gstId).attr('data-processed') !== 'processed') {
- $('#' + gstId).attr('data-processed', 'processed');
- } else {
- // console.log('MESSAGE: Already processed GST with ID ' + gstId + '. Skipping.');
-
- return;
- }
-
- // Get the JSON configuration, parse it, and store as an object.
- try {
- config = JSON.parse($('#' + gstId + '_json').html()).root;
- } catch (err) {
- console.log('ERROR: could not parse config JSON.');
- console.log('$("#" + gstId + "_json").html() = ', $('#' + gstId + '_json').html());
- console.log('JSON.parse(...) = ', JSON.parse($('#' + gstId + '_json').html()));
- console.log('config = ', config);
-
- return;
- }
-
- // Get the class name of the GST. All elements are assigned a class
- // name that is based on the class name of the GST. For example, inputs
- // are assigned a class name '{GST class name}_input'.
- if (typeof config['@class'] !== 'string') {
- console.log('ERROR: Could not get the class name of GST.');
- console.log('config["@class"] = ', config['@class']);
-
- return;
- }
- gstClass = config['@class'];
-
- // Parse the configuration settings for parameters, and store them in a
- // state object.
- state = State(gstId, config);
-
- state.showDebugInfo = false;
-
- // It is possible that something goes wrong while extracting parameters
- // from the JSON config object. In this case, we will not continue.
- if (state === undefined) {
- console.log('ERROR: The state object was not initialized properly.');
-
- return;
- }
-
- // Create the sliders and the text inputs, attaching them to
- // appropriate parameters.
- Sliders(gstId, state);
- Inputs(gstId, gstClass, state);
-
- // Configure functions that output to an element instead of the graph.
- ElOutput(config, state);
-
- // Configure functions that output to an element instead of the graph
- // label.
- GLabelElOutput(config, state);
-
- // Configure and display the graph. Attach event for the graph to be
- // updated on any change of a slider or a text input.
- Graph(gstId, config, state);
- }
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/inputs.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/inputs.js
deleted file mode 100644
index 531a939aec..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/inputs.js
+++ /dev/null
@@ -1,88 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define('Inputs', [], function () {
- return Inputs;
-
- function Inputs(gstId, gstClass, state) {
- var c1, paramName, allParamNames;
-
- allParamNames = state.getAllParameterNames();
-
- for (c1 = 0; c1 < allParamNames.length; c1 += 1) {
- $('#' + gstId).find('.' + gstClass + '_input').each(function (index, value) {
- var inputDiv, paramName;
-
- paramName = allParamNames[c1];
- inputDiv = $(value);
-
- if (paramName === inputDiv.data('var')) {
- createInput(inputDiv, paramName);
- }
- });
- }
-
- return;
-
- function createInput(inputDiv, paramName) {
- var paramObj;
-
- paramObj = state.getParamObj(paramName);
-
- // Check that the retrieval went OK.
- if (paramObj === undefined) {
- console.log('ERROR: Could not get a paramObj for parameter "' + paramName + '".');
-
- return;
- }
-
- // Bind a function to the 'change' event. Whenever the user changes
- // the value of this text input, and presses 'enter' (or clicks
- // somewhere else on the page), this event will be triggered, and
- // our callback will be called.
- inputDiv.bind('change', inputOnChange);
-
- inputDiv.val(paramObj.value);
-
- // Lets style the input element nicely. We will use the button()
- // widget for this since there is no native widget for the text
- // input.
- inputDiv.button().css({
- 'font': 'inherit',
- 'color': 'inherit',
- 'text-align': 'left',
- 'outline': 'none',
- 'cursor': 'text',
- 'height': '15px'
- });
-
- // Tell the parameter object from state that we are attaching a
- // text input to it. Next time the parameter will be updated with
- // a new value, tis input will also be updated.
- paramObj.inputDivs.push(inputDiv);
-
- return;
-
- // Update the 'state' - i.e. set the value of the parameter this
- // input is attached to to a new value.
- //
- // This will cause the plot to be redrawn each time after the user
- // changes the value in the input. Note that he has to either press
- // 'Enter', or click somewhere else on the page in order for the
- // 'change' event to be tiggered.
- function inputOnChange(event) {
- var inputDiv;
-
- inputDiv = $(this);
- state.setParameterValue(paramName, inputDiv.val(), inputDiv);
- }
- }
- }
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/jstat-1.0.0.min.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/jstat-1.0.0.min.js
deleted file mode 100644
index 7f9cd4a124..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/jstat-1.0.0.min.js
+++ /dev/null
@@ -1,236 +0,0 @@
-function jstat(){}
-j=jstat;(function(){var initializing=false,fnTest=/xyz/.test(function(){xyz;})?/\b_super\b/:/.*/;this.Class=function(){};Class.extend=function(prop){var _super=this.prototype;initializing=true;var prototype=new this();initializing=false;for(var name in prop){prototype[name]=typeof prop[name]=="function"&&typeof _super[name]=="function"&&fnTest.test(prop[name])?(function(name,fn){return function(){var tmp=this._super;this._super=_super[name];var ret=fn.apply(this,arguments);this._super=tmp;return ret;};})(name,prop[name]):prop[name];}
-function Class(){if(!initializing&&this.init)
-this.init.apply(this,arguments);}
-Class.prototype=prototype;Class.constructor=Class;Class.extend=arguments.callee;return Class;};})();jstat.ONE_SQRT_2PI=0.3989422804014327;jstat.LN_SQRT_2PI=0.9189385332046727417803297;jstat.LN_SQRT_PId2=0.225791352644727432363097614947;jstat.DBL_MIN=2.22507e-308;jstat.DBL_EPSILON=2.220446049250313e-16;jstat.SQRT_32=5.656854249492380195206754896838;jstat.TWO_PI=6.283185307179586;jstat.DBL_MIN_EXP=-999;jstat.SQRT_2dPI=0.79788456080287;jstat.LN_SQRT_PI=0.5723649429247;jstat.seq=function(min,max,length){var r=new Range(min,max,length);return r.getPoints();}
-jstat.dnorm=function(x,mean,sd,log){if(mean==null)mean=0;if(sd==null)sd=1;if(log==null)log=false;var n=new NormalDistribution(mean,sd);if(!isNaN(x)){return n._pdf(x,log);}else if(x.length){var res=[];for(var i=0;i
').css({position:'absolute',display:'none',top:y+15,'font-size':'small',left:x+5,border:'1px solid '+color[1],color:color[2],padding:'5px','background-color':color[0],opacity:0.80}).appendTo("body").show();}
-var previousPoint=null;$(this._container).bind("plothover",function(event,pos,item){$("#x").text(pos.x.toFixed(2));$("#y").text(pos.y.toFixed(2));if(item){if(previousPoint!=item.datapoint){previousPoint=item.datapoint;$("#jstat_tooltip").remove();var x=jstat.toSigFig(item.datapoint[0],2),y=jstat.toSigFig(item.datapoint[1],2);var text=null;var color=item.series.color;if(item.series.label=='PDF'){text="P("+x+") = "+y;color=["#fee","#fdd","#C05F5F"];}else{text="F("+x+") = "+y;color=["#eef","#ddf","#4A4AC0"];}
-showTooltip(item.pageX,item.pageY,text,color);}}
-else{$("#jstat_tooltip").remove();previousPoint=null;}});$(this._container).bind("mouseleave",function(){if($('#jstat_tooltip').is(':visible')){$('#jstat_tooltip').remove();previousPoint=null;}});}else{if(this._options.grid==null){this._options.grid={hoverable:false}}else{this._options.grid.hoverable=false}
-$(this._container).unbind("plothover");}
-this.render();},setType:function(type){this._plotType=type;var lines={};var points={};if(this._plotType=='line'){lines.show=true;points.show=false;}else if(this._plotType=='points'){lines.show=false;points.show=true;}else if(this._plotType=='both'){lines.show=true;points.show=true;}
-if(this._options.series==null){this._options.series={lines:lines,points:points}}else{if(this._options.series.lines==null){this._options.series.lines=lines;}else{this._options.series.lines.show=lines.show;}
-if(this._options.series.points==null){this._options.series.points=points;}else{this._options.series.points.show=points.show;}}
-this.render();},setFill:function(bool){this._fill=bool;if(this._options.series==null){this._options.series={lines:{fill:bool}}}else{if(this._options.series.lines==null){this._options.series.lines={fill:bool}}else{this._options.series.lines.fill=bool;}}
-this.render();},clear:function(){this._super();this._distribution=null;this._pdfValues=[];this._cdfValues=[];this.render();},_generateValues:function(){this._cdfValues=[];this._pdfValues=[];var xs=this._range.getPoints();this._options.xaxis={min:xs[0],max:xs[xs.length-1]}
-var pdfs=this._distribution.density(this._range);var cdfs=this._distribution.cumulativeDensity(this._range);for(var i=0;i 1) {
- console.log('ERROR: Found more than one slider for the parameter "' + paramName + '".');
- console.log('sliderDiv.length = ', sliderDiv.length);
- } // else {
- // console.log('MESSAGE: Did not find a slider for the parameter "' + paramName + '".');
- // }
- }
-
- function createSlider(sliderDiv, paramName) {
- var paramObj;
-
- paramObj = state.getParamObj(paramName);
-
- // Check that the retrieval went OK.
- if (paramObj === undefined) {
- console.log('ERROR: Could not get a paramObj for parameter "' + paramName + '".');
-
- return;
- }
-
- // Create a jQuery UI slider from the slider DIV. We will set
- // starting parameters, and will also attach a handler to update
- // the 'state' on the 'slide' event.
- sliderDiv.slider({
- 'min': paramObj.min,
- 'max': paramObj.max,
- 'value': paramObj.value,
- 'step': paramObj.step
- });
-
- // Tell the parameter object stored in state that we have a slider
- // that is attached to it. Next time when the parameter changes, it
- // will also update the value of this slider.
- paramObj.sliderDiv = sliderDiv;
-
- // Atach callbacks to update the slider's parameter.
- paramObj.sliderDiv.on('slide', sliderOnSlide);
- paramObj.sliderDiv.on('slidechange', sliderOnChange);
-
- return;
-
- // Update the 'state' - i.e. set the value of the parameter this
- // slider is attached to to a new value.
- //
- // This will cause the plot to be redrawn each time after the user
- // drags the slider handle and releases it.
- function sliderOnSlide(event, ui) {
- // Last parameter passed to setParameterValue() will be 'true'
- // so that the function knows we are a slider, and it can
- // change the our value back in the case when the new value is
- // invalid for some reason.
- if (state.setParameterValue(paramName, ui.value, sliderDiv, true, 'slide') === undefined) {
- console.log('ERROR: Could not update the parameter named "' + paramName + '" with the value "' + ui.value + '".');
- }
- }
-
- function sliderOnChange(event, ui) {
- if (state.setParameterValue(paramName, ui.value, sliderDiv, true, 'change') === undefined) {
- console.log('ERROR: Could not update the parameter named "' + paramName + '" with the value "' + ui.value + '".');
- }
- }
- }
- }
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/state.js b/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/state.js
deleted file mode 100644
index 2a4536a8f9..0000000000
--- a/common/lib/xmodule/xmodule/js/src/graphical_slider_tool/state.js
+++ /dev/null
@@ -1,395 +0,0 @@
-// Wrapper for RequireJS. It will make the standard requirejs(), require(), and
-// define() functions from Require JS available inside the anonymous function.
-(function (requirejs, require, define) {
-
-define('State', [], function () {
- var stateInst;
-
- // Since there will be (can be) multiple GST on a page, and each will have
- // a separate state, we will create a factory constructor function. The
- // constructor will expect the ID of the DIV with the GST contents, and the
- // configuration object (parsed from a JSON string). It will return an
- // object containing methods to set and get the private state properties.
-
- stateInst = 0;
-
- // This module defines and returns a factory constructor.
- return State;
-
- function State(gstId, config) {
- var parameters, allParameterNames, allParameterValues,
- plotDiv, dynamicEl, dynamicElByElId;
-
- dynamicEl = [];
- dynamicElByElId = {};
-
- stateInst += 1;
- // console.log('MESSAGE: Creating state instance # ' + stateInst + '.');
-
- // Initially, there are no parameters to track. So, we will instantiate
- // an empty object.
- //
- // As we parse the JSON config object, we will add parameters as
- // named properties. For example
- //
- // parameters.a = {...};
- //
- // will be created for the parameter 'a'.
- parameters = {};
-
- // Check that the required parameters config object is available.
- if ($.isPlainObject(config.parameters) === false) {
- console.log('ERROR: Expected config.parameters to be an object. It is not.');
- console.log('config.parameters = ', config.parameters);
-
- return;
- }
-
- // If config.parameters.param is an array, pass it to the processor
- // element by element.
- if ($.isArray(config.parameters.param) === true) {
- (function (c1) {
- while (c1 < config.parameters.param.length) {
- processParameter(config.parameters.param[c1]);
- c1 += 1;
- }
- }(0));
- }
-
- // If config.parameters.param is an object, pass this object to the
- // processor directly.
- else if ($.isPlainObject(config.parameters.param) === true) {
- processParameter(config.parameters.param);
- }
-
- // If config.parameters.param is some other type, report an error and
- // do not continue.
- else {
- console.log('ERROR: config.parameters.param is of an unsupported type.');
- console.log('config.parameters.param = ', config.parameters.param);
-
- return;
- }
-
- // Instead of building these arrays every time when some component
- // requests them, we will create them in the beginning, and then update
- // each element individually when some parameter's value changes.
- //
- // Then we can just return the required array, instead of iterating
- // over all of the properties of the 'parameters' object, and
- // extracting their names/values one by one.
- allParameterNames = [];
- allParameterValues = [];
-
- // Populate 'allParameterNames', and 'allParameterValues' with data.
- generateHelperArrays();
-
- // The constructor will return an object with methods to operate on
- // it's private properties.
- return {
- 'getParameterValue': getParameterValue,
- 'setParameterValue': setParameterValue,
-
- 'getParamObj': getParamObj,
-
- 'getAllParameterNames': getAllParameterNames,
- 'getAllParameterValues': getAllParameterValues,
-
- 'bindUpdatePlotEvent': bindUpdatePlotEvent,
- 'addDynamicEl': addDynamicEl,
-
- // plde is an abbreviation for Plot Label Dynamic Elements.
- plde: []
- };
-
- function getAllParameterNames() {
- return allParameterNames;
- }
-
- function getAllParameterValues() {
- return allParameterValues;
- }
-
- function getParamObj(paramName) {
- if (parameters.hasOwnProperty(paramName) === false) {
- console.log('ERROR: Object parameters does not have a property named "' + paramName + '".');
-
- return;
- }
-
- return parameters[paramName];
- }
-
- function bindUpdatePlotEvent(newPlotDiv, callback) {
- plotDiv = newPlotDiv;
-
- plotDiv.bind('update_plot', callback);
- }
-
- function addDynamicEl(el, func, elId, updateOnEvent) {
- var newLength;
-
- newLength = dynamicEl.push({
- 'el': el,
- 'func': func,
- 'elId': elId,
- 'updateOnEvent': updateOnEvent
- });
-
- if (typeof dynamicElByElId[elId] !== 'undefined') {
- console.log(
- 'ERROR: Duplicate dynamic element ID "' + elId + '" found.'
- );
- } else {
- dynamicElByElId[elId] = dynamicEl[newLength - 1];
- }
- }
-
- function getParameterValue(paramName) {
-
- // If the name of the constant is not tracked by state, return an
- // 'undefined' value.
- if (parameters.hasOwnProperty(paramName) === false) {
- console.log('ERROR: Object parameters does not have a property named "' + paramName + '".');
-
- return;
- }
-
- return parameters[paramname].value;
- }
-
- // ####################################################################
- //
- // Function: setParameterValue(paramName, paramValue, element)
- // --------------------------------------------------
- //
- //
- // This function can be called from a callback, registered by a slider
- // or a text input, when specific events ('slide' or 'change') are
- // triggered.
- //
- // The 'paramName' is the name of the parameter in 'parameters' object
- // whose value must be updated to the new value of 'paramValue'.
- //
- // Before we update the value, we must check that:
- //
- // 1.) the parameter named as 'paramName' actually exists in the
- // 'parameters' object;
- // 2.) the value 'paramValue' is a valid floating-point number, and
- // it lies within the range specified by the 'min' and 'max'
- // properties of the stored parameter object.
- //
- // If 'paramName' and 'paramValue' turn out to be valid, we will update
- // the stored value in the parameter with the new value, and also
- // update all of the text inputs and the slider that correspond to this
- // parameter (if any), so that they reflect the new parameter's value.
- // Finally, the helper array 'allParameterValues' will also be updated
- // to reflect the change.
- //
- // If something went wrong (for example the new value is outside the
- // allowed range), then we will reset the 'element' to display the
- // original value.
- //
- // ####################################################################
- function setParameterValue(paramName, paramValue, element, slider, updateOnEvent) {
- var paramValueNum, c1;
-
- // If a parameter with the name specified by the 'paramName'
- // parameter is not tracked by state, do not do anything.
- if (parameters.hasOwnProperty(paramName) === false) {
- console.log('ERROR: Object parameters does not have a property named "' + paramName + '".');
-
- return;
- }
-
- // Try to convert the passed value to a valid floating-point
- // number.
- paramValueNum = parseFloat(paramValue);
-
- // We are interested only in valid float values. NaN, -INF,
- // +INF we will disregard.
- if (isFinite(paramValueNum) === false) {
- console.log('ERROR: New parameter value is not a floating-point number.');
- console.log('paramValue = ', paramValue);
-
- return;
- }
-
- if (paramValueNum < parameters[paramName].min) {
- paramValueNum = parameters[paramName].min;
- } else if (paramValueNum > parameters[paramName].max) {
- paramValueNum = parameters[paramName].max;
- }
-
- parameters[paramName].value = paramValueNum;
-
- // Update all text inputs with the new parameter's value.
- for (c1 = 0; c1 < parameters[paramName].inputDivs.length; c1 += 1) {
- parameters[paramName].inputDivs[c1].val(paramValueNum);
- }
-
- // Update the single slider with the new parameter's value.
- if ((slider === false) && (parameters[paramName].sliderDiv !== null)) {
- parameters[paramName].sliderDiv.slider('value', paramValueNum);
- }
-
- // Update the helper array with the new parameter's value.
- allParameterValues[parameters[paramName].helperArrayIndex] = paramValueNum;
-
- for (c1 = 0; c1 < dynamicEl.length; c1++) {
- if (
- ((updateOnEvent !== undefined) && (dynamicEl[c1].updateOnEvent === updateOnEvent)) ||
- (updateOnEvent === undefined)
- ) {
- // If we have a DOM element, call the function "paste" the answer into the DIV.
- if (dynamicEl[c1].el !== null) {
- dynamicEl[c1].el.html(dynamicEl[c1].func.apply(window, allParameterValues));
- }
- // If we DO NOT have an element, simply call the function. The function can then
- // manipulate all the DOM elements it wants, without the fear of them being overwritten
- // by us afterwards.
- else {
- dynamicEl[c1].func.apply(window, allParameterValues);
- }
- }
- }
-
- // If we have a plot DIV to work with, tell to update.
- if (plotDiv !== undefined) {
- plotDiv.trigger('update_plot');
- }
-
- return true;
- } // End-of: function setParameterValue
-
- // ####################################################################
- //
- // Function: processParameter(obj)
- // -------------------------------
- //
- //
- // This function will be run once for each instance of a GST when
- // parsing the JSON config object.
- //
- // 'newParamObj' must be empty from the start for each invocation of
- // this function, that's why we will declare it locally.
- //
- // We will parse the passed object 'obj' and populate the 'newParamObj'
- // object with required properties.
- //
- // Since there will be many properties that are of type floating-point
- // number, we will have a separate function for parsing them.
- //
- // processParameter() will fail right away if 'obj' does not have a
- // '@var' property which represents the name of the parameter we want
- // to process.
- //
- // If, after all of the properties have been processed, we reached the
- // end of the function successfully, the 'newParamObj' will be added to
- // the 'parameters' object (that is defined in the scope of State()
- // function) as a property named as the name of the parameter.
- //
- // If at least one of the properties from 'obj' does not get correctly
- // parsed, then the parameter represented by 'obj' will be disregarded.
- // It will not be available to user-defined plotting functions, and
- // things will most likely break. We will notify the user about this.
- //
- // ####################################################################
- function processParameter(obj) {
- var paramName, newParamObj;
-
- if (typeof obj['@var'] !== 'string') {
- console.log('ERROR: Expected obj["@var"] to be a string. It is not.');
- console.log('obj["@var"] = ', obj['@var']);
-
- return;
- }
-
- paramName = obj['@var'];
- newParamObj = {};
-
- if (
- (processFloat('@min', 'min') === false) ||
- (processFloat('@max', 'max') === false) ||
- (processFloat('@step', 'step') === false) ||
- (processFloat('@initial', 'value') === false)
- ) {
- console.log('ERROR: A required property is missing. Not creating parameter "' + paramName + '"');
-
- return;
- }
-
- // Pointers to text input and slider DIV elements that this
- // parameter will be attached to. Initially there are none. When we
- // will create text inputs and sliders, we will update these
- // properties.
- newParamObj.inputDivs = [];
- newParamObj.sliderDiv = null;
-
- // Everything went well, so save the new parameter object.
- parameters[paramName] = newParamObj;
-
- return;
-
- function processFloat(attrName, newAttrName) {
- var attrValue;
-
- if (typeof obj[attrName] !== 'string') {
- console.log('ERROR: Expected obj["' + attrName + '"] to be a string. It is not.');
- console.log('obj["' + attrName + '"] = ', obj[attrName]);
-
- return false;
- } else {
- attrValue = parseFloat(obj[attrName]);
-
- if (isFinite(attrValue) === false) {
- console.log('ERROR: Expected obj["' + attrName + '"] to be a valid floating-point number. It is not.');
- console.log('obj["' + attrName + '"] = ', obj[attrName]);
-
- return false;
- }
- }
-
- newParamObj[newAttrName] = attrValue;
-
- return true;
- } // End-of: function processFloat
- } // End-of: function processParameter
-
- // ####################################################################
- //
- // Function: generateHelperArrays()
- // -------------------------------
- //
- //
- // Populate 'allParameterNames' and 'allParameterValues' with data.
- // Link each parameter object with the corresponding helper array via
- // an index 'helperArrayIndex'. It will be the same for both of the
- // arrays.
- //
- // NOTE: It is important to remember to update these helper arrays
- // whenever a new parameter is added (or one is removed), or when a
- // parameter's value changes.
- //
- // ####################################################################
- function generateHelperArrays() {
- var paramName, c1;
-
- c1 = 0;
- for (paramName in parameters) {
- allParameterNames.push(paramName);
- allParameterValues.push(parameters[paramName].value);
-
- parameters[paramName].helperArrayIndex = c1;
-
- c1 += 1;
- }
- }
- } // End-of: function State
-});
-
-// End of wrapper for RequireJS. As you can see, we are passing
-// namespaced Require JS variables to an anonymous function. Within
-// it, you can use the standard requirejs(), require(), and define()
-// functions as if they were in the global namespace.
-}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); // End-of: (function (requirejs, require, define)
diff --git a/common/lib/xmodule/xmodule/js/src/html/edit.coffee b/common/lib/xmodule/xmodule/js/src/html/edit.coffee
index efe107bd32..4ba4f2bb54 100644
--- a/common/lib/xmodule/xmodule/js/src/html/edit.coffee
+++ b/common/lib/xmodule/xmodule/js/src/html/edit.coffee
@@ -82,12 +82,13 @@ class @HTMLEditingDescriptor
image_advtab: true,
# We may want to add "styleselect" when we collect all styles used throughout the LMS
toolbar: "formatselect | fontselect | bold italic underline forecolor wrapAsCode | bullist numlist outdent indent blockquote | link unlink image | code",
- block_formats: interpolate("%(paragraph)s=p;%(preformatted)s=pre;%(heading1)s=h1;%(heading2)s=h2;%(heading3)s=h3", {
+ block_formats: interpolate("%(paragraph)s=p;%(preformatted)s=pre;%(heading3)s=h3;%(heading4)s=h4;%(heading5)s=h5;%(heading6)s=h6", {
paragraph: gettext("Paragraph"),
preformatted: gettext("Preformatted"),
- heading1: gettext("Heading 1"),
- heading2: gettext("Heading 2"),
- heading3: gettext("Heading 3")
+ heading3: gettext("Heading 3"),
+ heading4: gettext("Heading 4"),
+ heading5: gettext("Heading 5"),
+ heading6: gettext("Heading 6")
}, true),
width: '100%',
height: '400px',
diff --git a/common/lib/xmodule/xmodule/js/src/sequence/display.coffee b/common/lib/xmodule/xmodule/js/src/sequence/display.coffee
index 959ed75343..b5445a4c03 100644
--- a/common/lib/xmodule/xmodule/js/src/sequence/display.coffee
+++ b/common/lib/xmodule/xmodule/js/src/sequence/display.coffee
@@ -18,6 +18,8 @@ class @Sequence
bind: ->
@$('#sequence-list a').click @goto
+ @el.on 'bookmark:add', @addBookmarkIconToActiveNavItem
+ @el.on 'bookmark:remove', @removeBookmarkIconFromActiveNavItem
initProgress: ->
@progressTable = {} # "#problem_#{id}" -> progress
@@ -102,8 +104,9 @@ class @Sequence
@mark_active new_position
current_tab = @contents.eq(new_position - 1)
- @content_container.html(current_tab.text()).attr("aria-labelledby", current_tab.attr("aria-labelledby"))
+ bookmarked = if @el.find('.active .bookmark-icon').hasClass('bookmarked') then true else false
+ @content_container.html(current_tab.text()).attr("aria-labelledby", current_tab.attr("aria-labelledby")).data('bookmarked', bookmarked)
XBlock.initializeBlocks(@content_container, @requestToken)
window.update_schematics() # For embedded circuit simulator exercises in 6.002x
@@ -116,6 +119,8 @@ class @Sequence
sequence_links = @content_container.find('a.seqnav')
sequence_links.click @goto
+ @el.find('.path').html(@el.find('.nav-item.active').data('path'))
+
@sr_container.focus();
# @$("a.active").blur()
@@ -180,3 +185,13 @@ class @Sequence
element.removeClass("inactive")
.removeClass("visited")
.addClass("active")
+
+ addBookmarkIconToActiveNavItem: (event) =>
+ event.preventDefault()
+ @el.find('.nav-item.active .bookmark-icon').removeClass('is-hidden').addClass('bookmarked')
+ @el.find('.nav-item.active .bookmark-icon-sr').text(gettext('Bookmarked'))
+
+ removeBookmarkIconFromActiveNavItem: (event) =>
+ event.preventDefault()
+ @el.find('.nav-item.active .bookmark-icon').removeClass('bookmarked').addClass('is-hidden')
+ @el.find('.nav-item.active .bookmark-icon-sr').text('')
diff --git a/common/lib/xmodule/xmodule/js/src/video/03_video_player.js b/common/lib/xmodule/xmodule/js/src/video/03_video_player.js
index 0efdcd629b..ea1e4e4755 100644
--- a/common/lib/xmodule/xmodule/js/src/video/03_video_player.js
+++ b/common/lib/xmodule/xmodule/js/src/video/03_video_player.js
@@ -139,7 +139,8 @@ function (HTML5Video, Resizer) {
rel: 0,
showinfo: 0,
enablejsapi: 1,
- modestbranding: 1
+ modestbranding: 1,
+ cc_load_policy: 0
};
if (!state.isFlashMode()) {
diff --git a/common/lib/xmodule/xmodule/js/src/video/09_video_caption.js b/common/lib/xmodule/xmodule/js/src/video/09_video_caption.js
index 5ff6f49d4c..e25f968659 100644
--- a/common/lib/xmodule/xmodule/js/src/video/09_video_caption.js
+++ b/common/lib/xmodule/xmodule/js/src/video/09_video_caption.js
@@ -1,11 +1,12 @@
(function (define) {
- // VideoCaption module.
+// VideoCaption module.
'use strict';
define(
'video/09_video_caption.js',
['video/00_sjson.js', 'video/00_async_process.js'],
function (Sjson, AsyncProcess) {
+
/**
* @desc VideoCaption module exports a function.
*
@@ -29,11 +30,14 @@
'onContainerMouseEnter', 'onContainerMouseLeave', 'fetchCaption',
'onResize', 'pause', 'play', 'onCaptionUpdate', 'onCaptionHandler', 'destroy',
'handleKeypress', 'handleKeypressLink', 'openLanguageMenu', 'closeLanguageMenu',
- 'previousLanguageMenuItem', 'nextLanguageMenuItem'
+ 'previousLanguageMenuItem', 'nextLanguageMenuItem', 'handleCaptionToggle',
+ 'showClosedCaptions', 'hideClosedCaptions', 'toggleClosedCaptions',
+ 'updateCaptioningCookie', 'handleCaptioningCookie', 'handleTranscriptToggle'
);
this.state = state;
this.state.videoCaption = this;
this.renderElements();
+ this.handleCaptioningCookie();
return $.Deferred().resolve().promise();
};
@@ -41,6 +45,14 @@
VideoCaption.prototype = {
langTemplate: [
'
')
.height(this.topSpacingHeight())
@@ -936,6 +980,7 @@
.addClass('current');
this.currentIndex = newIndex;
+ this.captionDisplayEl.text(this.subtitlesEl.find("li[data-index='" + newIndex + "']").text());
this.scrollCaption();
}
}
@@ -1017,6 +1062,82 @@
}
},
+ handleCaptioningCookie: function() {
+ if ($.cookie('show_closed_captions') === 'true') {
+ this.state.showClosedCaptions = true;
+ this.showClosedCaptions();
+
+ // keep it going until turned off
+ $.cookie('show_closed_captions', 'true', {
+ expires: 3650,
+ path: '/'
+ });
+ } else {
+ this.hideClosedCaptions();
+ }
+ },
+
+ toggleClosedCaptions: function(event) {
+ event.preventDefault();
+
+ if (this.state.el.hasClass('has-captions')) {
+ this.state.showClosedCaptions = false;
+ this.updateCaptioningCookie(false);
+ this.hideClosedCaptions();
+ } else {
+ this.state.showClosedCaptions = true;
+ this.updateCaptioningCookie(true);
+ this.showClosedCaptions();
+ }
+ },
+
+ showClosedCaptions: function() {
+ this.state.el.addClass('has-captions');
+
+ this.captionDisplayEl
+ .show()
+ .addClass('is-visible');
+
+ this.captionControlEl
+ .addClass('is-active')
+ .find('.control-text')
+ .text(gettext('Hide closed captions'));
+
+ if (this.subtitlesEl.find('.current').text()) {
+ this.captionDisplayEl
+ .text(this.subtitlesEl.find('.current').text());
+ } else {
+ this.captionDisplayEl
+ .text(gettext('(Caption will be displayed when you start playing the video.)'));
+ }
+ },
+
+ hideClosedCaptions: function() {
+ this.state.el.removeClass('has-captions');
+
+ this.captionDisplayEl
+ .hide()
+ .removeClass('is-visible');
+
+ this.captionControlEl
+ .removeClass('is-active')
+ .find('.control-text')
+ .text(gettext('Turn on closed captioning'));
+ },
+
+ updateCaptioningCookie: function(method) {
+ if (method) {
+ $.cookie('show_closed_captions', 'true', {
+ expires: 3650,
+ path: '/'
+ });
+ } else {
+ $.cookie('show_closed_captions', null, {
+ path: '/'
+ });
+ }
+ },
+
/**
* @desc Shows/Hides captions and updates the cookie.
*
diff --git a/common/lib/xmodule/xmodule/library_content_module.py b/common/lib/xmodule/xmodule/library_content_module.py
index 9eae5e4ec9..9a5593274e 100644
--- a/common/lib/xmodule/xmodule/library_content_module.py
+++ b/common/lib/xmodule/xmodule/library_content_module.py
@@ -316,6 +316,7 @@ class LibraryContentModule(LibraryContentFields, XModule, StudioEditableModule):
fragment.add_content(self.system.render_template('vert_module.html', {
'items': contents,
'xblock_context': context,
+ 'show_bookmark_button': False,
}))
return fragment
diff --git a/common/lib/xmodule/xmodule/modulestore/exceptions.py b/common/lib/xmodule/xmodule/modulestore/exceptions.py
index 12be4c398b..10ac1fe858 100644
--- a/common/lib/xmodule/xmodule/modulestore/exceptions.py
+++ b/common/lib/xmodule/xmodule/modulestore/exceptions.py
@@ -11,6 +11,13 @@ class ItemWriteConflictError(Exception):
pass
+class MultipleCourseBlocksFound(Exception):
+ """
+ Raise this exception when Iterating over the course blocks return multiple course blocks.
+ """
+ pass
+
+
class InsufficientSpecificationError(Exception):
pass
diff --git a/common/lib/xmodule/xmodule/modulestore/mixed.py b/common/lib/xmodule/xmodule/modulestore/mixed.py
index ac20f7ad64..3beb3970d5 100644
--- a/common/lib/xmodule/xmodule/modulestore/mixed.py
+++ b/common/lib/xmodule/xmodule/modulestore/mixed.py
@@ -265,6 +265,26 @@ class MixedModuleStore(ModuleStoreDraftAndPublished, ModuleStoreWriteBase):
store = self._get_modulestore_for_courselike(course_key)
return store.get_items(course_key, **kwargs)
+ @strip_key
+ def get_course_summaries(self, **kwargs):
+ """
+ Returns a list containing the course information in CourseSummary objects.
+ Information contains `location`, `display_name`, `locator` of the courses in this modulestore.
+ """
+ course_summaries = {}
+ for store in self.modulestores:
+ for course_summary in store.get_course_summaries(**kwargs):
+ course_id = self._clean_locator_for_mapping(locator=course_summary.id)
+
+ # Check if course is indeed unique. Save it in result if unique
+ if course_id in course_summaries:
+ log.warning(
+ u"Modulestore %s have duplicate courses %s; skipping from result.", store, course_id
+ )
+ else:
+ course_summaries[course_id] = course_summary
+ return course_summaries.values()
+
@strip_key
def get_courses(self, **kwargs):
'''
diff --git a/common/lib/xmodule/xmodule/modulestore/mongo/base.py b/common/lib/xmodule/xmodule/modulestore/mongo/base.py
index 4bcdfa15a8..840fd48c03 100644
--- a/common/lib/xmodule/xmodule/modulestore/mongo/base.py
+++ b/common/lib/xmodule/xmodule/modulestore/mongo/base.py
@@ -39,6 +39,7 @@ from xblock.fields import Scope, ScopeIds, Reference, ReferenceList, ReferenceVa
from xblock.runtime import KvsFieldData
from xmodule.assetstore import AssetMetadata, CourseAssetsFromStorage
+from xmodule.course_module import CourseSummary
from xmodule.error_module import ErrorDescriptor
from xmodule.errortracker import null_error_tracker, exc_info_to_str
from xmodule.exceptions import HeartbeatFailure
@@ -268,8 +269,8 @@ class CachingDescriptorSystem(MakoDescriptorSystem, EditInfoRuntimeMixin):
)
if parent_url:
parent = self._convert_reference_to_key(parent_url)
- if not parent and category != 'course':
- # try looking it up just-in-time (but not if we're working with a root node (course).
+ if not parent and category not in _DETACHED_CATEGORIES + ['course']:
+ # try looking it up just-in-time (but not if we're working with a detached block).
parent = self.modulestore.get_parent_location(
as_published(location),
ModuleStoreEnum.RevisionOption.published_only if location.revision is None
@@ -968,6 +969,40 @@ class MongoModuleStore(ModuleStoreDraftAndPublished, ModuleStoreWriteBase, Mongo
not (category == 'course' and depth == 0)
return apply_cached_metadata
+ @autoretry_read()
+ def get_course_summaries(self, **kwargs):
+ """
+ Returns a list of `CourseSummary`. This accepts an optional parameter of 'org' which
+ will apply an efficient filter to only get courses with the specified ORG
+ """
+ def extract_course_summary(course):
+ """
+ Extract course information from the course block for mongo.
+ """
+ return {
+ field: course['metadata'][field]
+ for field in CourseSummary.course_info_fields
+ if field in course['metadata']
+ }
+
+ course_org_filter = kwargs.get('org')
+ query = {'_id.category': 'course'}
+
+ if course_org_filter:
+ query['_id.org'] = course_org_filter
+
+ course_records = self.collection.find(query, {'metadata': True})
+
+ courses_summaries = []
+ for course in course_records:
+ if not (course['_id']['org'] == 'edx' and course['_id']['course'] == 'templates'):
+ locator = SlashSeparatedCourseKey(course['_id']['org'], course['_id']['course'], course['_id']['name'])
+ course_summary = extract_course_summary(course)
+ courses_summaries.append(
+ CourseSummary(locator, **course_summary)
+ )
+ return courses_summaries
+
@autoretry_read()
def get_courses(self, **kwargs):
'''
diff --git a/common/lib/xmodule/xmodule/modulestore/search.py b/common/lib/xmodule/xmodule/modulestore/search.py
index 0ee4e37d41..307ed51a05 100644
--- a/common/lib/xmodule/xmodule/modulestore/search.py
+++ b/common/lib/xmodule/xmodule/modulestore/search.py
@@ -6,7 +6,7 @@ from .exceptions import (ItemNotFoundError, NoPathToItem)
LOGGER = getLogger(__name__)
-def path_to_location(modulestore, usage_key):
+def path_to_location(modulestore, usage_key, full_path=False):
'''
Try to find a course_id/chapter/section[/position] path to location in
modulestore. The courseware insists that the first level in the course is
@@ -15,6 +15,7 @@ def path_to_location(modulestore, usage_key):
Args:
modulestore: which store holds the relevant objects
usage_key: :class:`UsageKey` the id of the location to which to generate the path
+ full_path: :class:`Bool` if True, return the full path to location. Default is False.
Raises
ItemNotFoundError if the location doesn't exist.
@@ -81,6 +82,9 @@ def path_to_location(modulestore, usage_key):
if path is None:
raise NoPathToItem(usage_key)
+ if full_path:
+ return path
+
n = len(path)
course_id = path[0].course_key
# pull out the location names
diff --git a/common/lib/xmodule/xmodule/modulestore/split_mongo/caching_descriptor_system.py b/common/lib/xmodule/xmodule/modulestore/split_mongo/caching_descriptor_system.py
index d5e1bbdea9..995ec6fe2c 100644
--- a/common/lib/xmodule/xmodule/modulestore/split_mongo/caching_descriptor_system.py
+++ b/common/lib/xmodule/xmodule/modulestore/split_mongo/caching_descriptor_system.py
@@ -209,20 +209,20 @@ class CachingDescriptorSystem(MakoDescriptorSystem, EditInfoRuntimeMixin):
parent = course_key.make_usage_key(parent_key.type, parent_key.id)
else:
parent = None
- kvs = SplitMongoKVS(
- definition_loader,
- converted_fields,
- converted_defaults,
- parent=parent,
- field_decorator=kwargs.get('field_decorator')
- )
-
- if InheritanceMixin in self.modulestore.xblock_mixins:
- field_data = inheriting_field_data(kvs)
- else:
- field_data = KvsFieldData(kvs)
-
try:
+ kvs = SplitMongoKVS(
+ definition_loader,
+ converted_fields,
+ converted_defaults,
+ parent=parent,
+ field_decorator=kwargs.get('field_decorator')
+ )
+
+ if InheritanceMixin in self.modulestore.xblock_mixins:
+ field_data = inheriting_field_data(kvs)
+ else:
+ field_data = KvsFieldData(kvs)
+
module = self.construct_xblock_from_class(
class_,
ScopeIds(None, block_key.type, definition_id, block_locator),
diff --git a/common/lib/xmodule/xmodule/modulestore/split_mongo/mongo_connection.py b/common/lib/xmodule/xmodule/modulestore/split_mongo/mongo_connection.py
index 1352ee95cd..d675de85ed 100644
--- a/common/lib/xmodule/xmodule/modulestore/split_mongo/mongo_connection.py
+++ b/common/lib/xmodule/xmodule/modulestore/split_mongo/mongo_connection.py
@@ -353,6 +353,26 @@ class MongoConnection(object):
tagger.measure("structures", len(docs))
return docs
+ @autoretry_read()
+ def find_course_blocks_by_id(self, ids, course_context=None):
+ """
+ Find all structures that specified in `ids`. Among the blocks only return block whose type is `course`.
+
+ Arguments:
+ ids (list): A list of structure ids
+ """
+ with TIMER.timer("find_course_blocks_by_id", course_context) as tagger:
+ tagger.measure("requested_ids", len(ids))
+ docs = [
+ structure_from_mongo(structure, course_context)
+ for structure in self.structures.find(
+ {'_id': {'$in': ids}},
+ {'blocks': {'$elemMatch': {'block_type': 'course'}}, 'root': 1}
+ )
+ ]
+ tagger.measure("structures", len(docs))
+ return docs
+
@autoretry_read()
def find_structures_derived_from(self, ids, course_context=None):
"""
diff --git a/common/lib/xmodule/xmodule/modulestore/split_mongo/split.py b/common/lib/xmodule/xmodule/modulestore/split_mongo/split.py
index e59e52666b..95a913255f 100644
--- a/common/lib/xmodule/xmodule/modulestore/split_mongo/split.py
+++ b/common/lib/xmodule/xmodule/modulestore/split_mongo/split.py
@@ -66,13 +66,14 @@ from bson.objectid import ObjectId
from xblock.core import XBlock
from xblock.fields import Scope, Reference, ReferenceList, ReferenceValueDict
+from xmodule.course_module import CourseSummary
from xmodule.errortracker import null_error_tracker
from opaque_keys.edx.locator import (
BlockUsageLocator, DefinitionLocator, CourseLocator, LibraryLocator, VersionTree, LocalId,
)
from ccx_keys.locator import CCXLocator, CCXBlockUsageLocator
from xmodule.modulestore.exceptions import InsufficientSpecificationError, VersionConflictError, DuplicateItemError, \
- DuplicateCourseError
+ DuplicateCourseError, MultipleCourseBlocksFound
from xmodule.modulestore import (
inheritance, ModuleStoreWriteBase, ModuleStoreEnum,
BulkOpsRecord, BulkOperationsMixin, SortedAssetList, BlockData
@@ -539,6 +540,17 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
return indexes
+ def find_course_blocks_by_id(self, ids):
+ """
+ Find all structures that specified in `ids`. Filter the course blocks to only return whose
+ `block_type` is `course`
+
+ Arguments:
+ ids (list): A list of structure ids
+ """
+ ids = set(ids)
+ return self.db_connection.find_course_blocks_by_id(list(ids))
+
def find_structures_by_id(self, ids):
"""
Return all structures that specified in ``ids``.
@@ -849,15 +861,39 @@ class SplitMongoModuleStore(SplitBulkWriteMixin, ModuleStoreWriteBase):
# add it in the envelope for the structure.
return CourseEnvelope(course_key.replace(version_guid=version_guid), entry)
+ def _get_course_blocks_for_branch(self, branch, **kwargs):
+ """
+ Internal generator for fetching lists of courses without loading them.
+ """
+ version_guids, id_version_map = self.collect_ids_from_matching_indexes(branch, **kwargs)
+
+ if not version_guids:
+ return
+
+ for entry in self.find_course_blocks_by_id(version_guids):
+ for course_index in id_version_map[entry['_id']]:
+ yield entry, course_index
+
def _get_structures_for_branch(self, branch, **kwargs):
"""
Internal generator for fetching lists of courses, libraries, etc.
"""
+ version_guids, id_version_map = self.collect_ids_from_matching_indexes(branch, **kwargs)
- # if we pass in a 'org' parameter that means to
- # only get the course which match the passed in
- # ORG
+ if not version_guids:
+ return
+ for entry in self.find_structures_by_id(version_guids):
+ for course_index in id_version_map[entry['_id']]:
+ yield entry, course_index
+
+ def collect_ids_from_matching_indexes(self, branch, **kwargs):
+ """
+ Find the course_indexes which have the specified branch. if `kwargs` contains `org`
+ to apply an ORG filter to return only the courses that are part of that ORG. Extract `version_guids`
+ from the course_indexes.
+
+ """
matching_indexes = self.find_matching_course_indexes(
branch,
search_targets=None,
@@ -871,13 +907,7 @@ class SplitMongoModuleStore(SplitBulkWriteMixin, ModuleStoreWriteBase):
version_guid = course_index['versions'][branch]
version_guids.append(version_guid)
id_version_map[version_guid].append(course_index)
-
- if not version_guids:
- return
-
- for entry in self.find_structures_by_id(version_guids):
- for course_index in id_version_map[entry['_id']]:
- yield entry, course_index
+ return version_guids, id_version_map
def _get_structures_for_branch_and_locator(self, branch, locator_factory, **kwargs):
@@ -933,6 +963,50 @@ class SplitMongoModuleStore(SplitBulkWriteMixin, ModuleStoreWriteBase):
# get the blocks for each course index (s/b the root)
return self._get_structures_for_branch_and_locator(branch, self._create_course_locator, **kwargs)
+ @autoretry_read()
+ def get_course_summaries(self, branch, **kwargs):
+ """
+ Returns a list of `CourseSummary` which matching any given qualifiers.
+
+ qualifiers should be a dict of keywords matching the db fields or any
+ legal query for mongo to use against the active_versions collection.
+
+ Note, this is to find the current head of the named branch type.
+ To get specific versions via guid use get_course.
+
+ :param branch: the branch for which to return courses.
+ """
+ def extract_course_summary(course):
+ """
+ Extract course information from the course block for split.
+ """
+ return {
+ field: course.fields[field]
+ for field in CourseSummary.course_info_fields
+ if field in course.fields
+ }
+
+ courses_summaries = []
+ for entry, structure_info in self._get_course_blocks_for_branch(branch, **kwargs):
+ course_locator = self._create_course_locator(structure_info, branch=None)
+ course_block = [
+ block_data
+ for block_key, block_data in entry['blocks'].items()
+ if block_key.type == "course"
+ ]
+ if not course_block:
+ raise ItemNotFoundError
+
+ if len(course_block) > 1:
+ raise MultipleCourseBlocksFound(
+ "Expected 1 course block to be found in the course, but found {0}".format(len(course_block))
+ )
+ course_summary = extract_course_summary(course_block[0])
+ courses_summaries.append(
+ CourseSummary(course_locator, **course_summary)
+ )
+ return courses_summaries
+
def get_libraries(self, branch="library", **kwargs):
"""
Returns a list of "library" root blocks matching any given qualifiers.
diff --git a/common/lib/xmodule/xmodule/modulestore/split_mongo/split_draft.py b/common/lib/xmodule/xmodule/modulestore/split_mongo/split_draft.py
index 8f2554eab1..dc25acf7ac 100644
--- a/common/lib/xmodule/xmodule/modulestore/split_mongo/split_draft.py
+++ b/common/lib/xmodule/xmodule/modulestore/split_mongo/split_draft.py
@@ -74,6 +74,22 @@ class DraftVersioningModuleStore(SplitMongoModuleStore, ModuleStoreDraftAndPubli
source_course_id, dest_course_id, user_id, fields=fields, **kwargs
)
+ def get_course_summaries(self, **kwargs):
+ """
+ Returns course summaries on the Draft or Published branch depending on the branch setting.
+ """
+ branch_setting = self.get_branch_setting()
+ if branch_setting == ModuleStoreEnum.Branch.draft_preferred:
+ return super(DraftVersioningModuleStore, self).get_course_summaries(
+ ModuleStoreEnum.BranchName.draft, **kwargs
+ )
+ elif branch_setting == ModuleStoreEnum.Branch.published_only:
+ return super(DraftVersioningModuleStore, self).get_course_summaries(
+ ModuleStoreEnum.BranchName.published, **kwargs
+ )
+ else:
+ raise InsufficientSpecificationError()
+
def get_courses(self, **kwargs):
"""
Returns all the courses on the Draft or Published branch depending on the branch setting.
diff --git a/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py b/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py
index 224a1dbc22..8d3224db2a 100644
--- a/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py
+++ b/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py
@@ -18,10 +18,12 @@ from openedx.core.lib.tempdir import mkdtemp_clean
from xmodule.contentstore.django import _CONTENTSTORE
from xmodule.modulestore import ModuleStoreEnum
-from xmodule.modulestore.django import modulestore, clear_existing_modulestores
+from xmodule.modulestore.django import modulestore, clear_existing_modulestores, SignalHandler
from xmodule.modulestore.tests.mongo_connection import MONGO_PORT_NUM, MONGO_HOST
from xmodule.modulestore.tests.factories import XMODULE_FACTORY_LOCK
+from openedx.core.djangoapps.bookmarks.signals import trigger_update_xblocks_cache_task
+
class StoreConstructors(object):
"""Enumeration of store constructor types."""
@@ -405,6 +407,8 @@ class ModuleStoreTestCase(TestCase):
super(ModuleStoreTestCase, self).setUp()
+ SignalHandler.course_published.disconnect(trigger_update_xblocks_cache_task)
+
self.store = modulestore()
uname = 'testuser'
diff --git a/common/lib/xmodule/xmodule/modulestore/tests/test_semantics.py b/common/lib/xmodule/xmodule/modulestore/tests/test_semantics.py
index 5a3fd41689..fab98f1acd 100644
--- a/common/lib/xmodule/xmodule/modulestore/tests/test_semantics.py
+++ b/common/lib/xmodule/xmodule/modulestore/tests/test_semantics.py
@@ -5,6 +5,7 @@ Tests of modulestore semantics: How do the interfaces methods of ModuleStore rel
import ddt
import itertools
from collections import namedtuple
+from xmodule.course_module import CourseSummary
from xmodule.modulestore.tests.utils import (
PureModulestoreTestCase, MongoModulestoreBuilder,
@@ -177,6 +178,20 @@ class DirectOnlyCategorySemantics(PureModulestoreTestCase):
"""
self.assertNotParentOf(self.course.scope_ids.usage_id, block_usage_key, draft=draft)
+ def assertCourseSummaryFields(self, course_summaries):
+ """
+ Assert that the `course_summary` of a course has all expected fields.
+
+ Arguments:
+ course_summaries: list of CourseSummary class objects.
+ """
+ def verify_course_summery_fields(course_summary):
+ """ Verify that every `course_summary` object has all the required fields """
+ expected_fields = CourseSummary.course_info_fields + ['id', 'location']
+ return all([hasattr(course_summary, field) for field in expected_fields])
+
+ self.assertTrue(all(verify_course_summery_fields(course_summary) for course_summary in course_summaries))
+
def is_detached(self, block_type):
"""
Return True if ``block_type`` is a detached block.
@@ -259,6 +274,21 @@ class DirectOnlyCategorySemantics(PureModulestoreTestCase):
self.assertCourseDoesntPointToBlock(block_usage_key)
self.assertBlockDoesntExist(block_usage_key)
+ @ddt.data(ModuleStoreEnum.Branch.draft_preferred, ModuleStoreEnum.Branch.published_only)
+ def test_course_summaries(self, branch):
+ """ Test that `get_course_summaries` method in modulestore work as expected. """
+ with self.store.branch_setting(branch_setting=branch):
+ course_summaries = self.store.get_course_summaries()
+
+ # Verify course summaries
+ self.assertEqual(len(course_summaries), 1)
+
+ # Verify that all course summary objects have the required attributes.
+ self.assertCourseSummaryFields(course_summaries)
+
+ # Verify fetched accessible courses list is a list of CourseSummery instances
+ self.assertTrue(all(isinstance(course, CourseSummary) for course in course_summaries))
+
@ddt.data(*itertools.product(['chapter', 'sequential'], [True, False]))
@ddt.unpack
def test_delete_child(self, block_type, child_published):
diff --git a/common/lib/xmodule/xmodule/modulestore/xml.py b/common/lib/xmodule/xmodule/modulestore/xml.py
index 7cd2c615fe..7ea73be558 100644
--- a/common/lib/xmodule/xmodule/modulestore/xml.py
+++ b/common/lib/xmodule/xmodule/modulestore/xml.py
@@ -835,6 +835,12 @@ class XMLModuleStore(ModuleStoreReadBase):
"""
return self.courses.values()
+ def get_course_summaries(self, **kwargs):
+ """
+ Returns `self.get_courses()`. Use to list courses to the global staff user.
+ """
+ return self.get_courses(**kwargs)
+
def get_errored_courses(self):
"""
Return a dictionary of course_dir -> [(msg, exception_str)], for each
@@ -917,6 +923,14 @@ class XMLModuleStore(ModuleStoreReadBase):
log.warning("get_all_asset_metadata request of XML modulestore - not implemented.")
return []
+ def fill_in_run(self, course_key):
+ """
+ A no-op.
+
+ Added to simplify tests which use the XML-store directly.
+ """
+ return course_key
+
class LibraryXMLModuleStore(XMLModuleStore):
"""
diff --git a/common/lib/xmodule/xmodule/public/js/vertical_student_view.js b/common/lib/xmodule/xmodule/public/js/vertical_student_view.js
new file mode 100644
index 0000000000..7efd1342d0
--- /dev/null
+++ b/common/lib/xmodule/xmodule/public/js/vertical_student_view.js
@@ -0,0 +1,17 @@
+/* JavaScript for Vertical Student View. */
+window.VerticalStudentView = function (runtime, element) {
+
+ 'use strict';
+ RequireJS.require(['js/bookmarks/views/bookmark_button'], function (BookmarkButton) {
+ var $element = $(element);
+ var $bookmarkButtonElement = $element.find('.bookmark-button');
+
+ return new BookmarkButton({
+ el: $bookmarkButtonElement,
+ bookmarkId: $bookmarkButtonElement.data('bookmarkId'),
+ usageId: $element.data('usageId'),
+ bookmarked: $element.parent('#seq_content').data('bookmarked'),
+ apiUrl: $(".courseware-bookmarks-button").data('bookmarksApiUrl')
+ });
+ });
+};
diff --git a/common/lib/xmodule/xmodule/seq_module.py b/common/lib/xmodule/xmodule/seq_module.py
index 6b41659bc5..2c125231bb 100644
--- a/common/lib/xmodule/xmodule/seq_module.py
+++ b/common/lib/xmodule/xmodule/seq_module.py
@@ -3,7 +3,7 @@ xModule implementation of a learning sequence
"""
# pylint: disable=abstract-method
-
+import collections
import json
import logging
from pkg_resources import resource_string
@@ -11,8 +11,9 @@ import warnings
from lxml import etree
from xblock.core import XBlock
-from xblock.fields import Integer, Scope, Boolean
+from xblock.fields import Integer, Scope, Boolean, String
from xblock.fragment import Fragment
+import newrelic.agent
from .exceptions import NotFoundError
from .fields import Date
@@ -88,6 +89,15 @@ class ProctoringFields(object):
scope=Scope.settings,
)
+ exam_review_rules = String(
+ display_name=_("Software Secure Review Rules"),
+ help=_(
+ "This setting indicates what rules the proctoring team should follow when viewing the videos."
+ ),
+ default='',
+ scope=Scope.settings,
+ )
+
is_practice_exam = Boolean(
display_name=_("Is Practice Exam"),
help=_(
@@ -110,9 +120,12 @@ class ProctoringFields(object):
@XBlock.wants('proctoring')
@XBlock.wants('credit')
+@XBlock.needs("user")
+@XBlock.needs("bookmarks")
class SequenceModule(SequenceFields, ProctoringFields, XModule):
- ''' Layout module which lays out content in a temporal sequence
- '''
+ """
+ Layout module which lays out content in a temporal sequence
+ """
js = {
'coffee': [resource_string(__name__, 'js/src/sequence/display.coffee')],
'js': [resource_string(__name__, 'js/src/sequence/display/jquery.sequence.js')],
@@ -173,6 +186,16 @@ class SequenceModule(SequenceFields, ProctoringFields, XModule):
contents = []
fragment = Fragment()
+ context = context or {}
+
+ bookmarks_service = self.runtime.service(self, "bookmarks")
+ context["username"] = self.runtime.service(self, "user").get_current_user().opt_attrs['edx-platform.username']
+
+ display_names = [self.get_parent().display_name or '', self.display_name or '']
+
+ # We do this up here because proctored exam functionality could bypass
+ # rendering after this section.
+ self._capture_basic_metrics()
# Is this sequential part of a timed or proctored exam?
if self.is_time_limited:
@@ -184,7 +207,11 @@ class SequenceModule(SequenceFields, ProctoringFields, XModule):
fragment.add_content(view_html)
return fragment
- for child in self.get_display_items():
+ display_items = self.get_display_items()
+ for child in display_items:
+ is_bookmarked = bookmarks_service.is_bookmarked(usage_key=child.scope_ids.usage_id)
+ context["bookmarked"] = is_bookmarked
+
progress = child.get_progress()
rendered_child = child.render(STUDENT_VIEW, context)
fragment.add_frag_resources(rendered_child)
@@ -200,9 +227,11 @@ class SequenceModule(SequenceFields, ProctoringFields, XModule):
'progress_detail': Progress.to_js_detail_str(progress),
'type': child.get_icon_class(),
'id': child.scope_ids.usage_id.to_deprecated_string(),
+ 'bookmarked': is_bookmarked,
+ 'path': " > ".join(display_names + [child.display_name or '']),
}
if childinfo['title'] == '':
- childinfo['title'] = child.display_name_with_default
+ childinfo['title'] = child.display_name_with_default_escaped
contents.append(childinfo)
params = {
@@ -216,8 +245,78 @@ class SequenceModule(SequenceFields, ProctoringFields, XModule):
fragment.add_content(self.system.render_template("seq_module.html", params))
+ self._capture_full_seq_item_metrics(display_items)
+ self._capture_current_unit_metrics(display_items)
+
+ # Get all descendant XBlock types and counts
return fragment
+ def _locations_in_subtree(self, node):
+ """
+ The usage keys for all descendants of an XBlock/XModule as a flat list.
+
+ Includes the location of the node passed in.
+ """
+ stack = [node]
+ locations = []
+
+ while stack:
+ curr = stack.pop()
+ locations.append(curr.location)
+ if curr.has_children:
+ stack.extend(curr.get_children())
+
+ return locations
+
+ def _capture_basic_metrics(self):
+ """
+ Capture basic information about this sequence in New Relic.
+ """
+ newrelic.agent.add_custom_parameter('seq.block_id', unicode(self.location))
+ newrelic.agent.add_custom_parameter('seq.display_name', self.display_name or '')
+ newrelic.agent.add_custom_parameter('seq.position', self.position)
+ newrelic.agent.add_custom_parameter('seq.is_time_limited', self.is_time_limited)
+
+ def _capture_full_seq_item_metrics(self, display_items):
+ """
+ Capture information about the number and types of XBlock content in
+ the sequence as a whole. We send this information to New Relic so that
+ we can do better performance analysis of courseware.
+ """
+ # Basic count of the number of Units (a.k.a. VerticalBlocks) we have in
+ # this learning sequence
+ newrelic.agent.add_custom_parameter('seq.num_units', len(display_items))
+
+ # Count of all modules (leaf nodes) in this sequence (e.g. videos,
+ # problems, etc.) The units (verticals) themselves are not counted.
+ all_item_keys = self._locations_in_subtree(self)
+ newrelic.agent.add_custom_parameter('seq.num_items', len(all_item_keys))
+
+ # Count of all modules by block_type (e.g. "video": 2, "discussion": 4)
+ block_counts = collections.Counter(usage_key.block_type for usage_key in all_item_keys)
+ for block_type, count in block_counts.items():
+ newrelic.agent.add_custom_parameter('seq.block_counts.{}'.format(block_type), count)
+
+ def _capture_current_unit_metrics(self, display_items):
+ """
+ Capture information about the current selected Unit within the Sequence.
+ """
+ # Positions are stored with indexing starting at 1. If we get into a
+ # weird state where the saved position is out of bounds (e.g. the
+ # content was changed), avoid going into any details about this unit.
+ if 1 <= self.position <= len(display_items):
+ # Basic info about the Unit...
+ current = display_items[self.position - 1]
+ newrelic.agent.add_custom_parameter('seq.current.block_id', unicode(current.location))
+ newrelic.agent.add_custom_parameter('seq.current.display_name', current.display_name or '')
+
+ # Examining all items inside the Unit (or split_test, conditional, etc.)
+ child_locs = self._locations_in_subtree(current)
+ newrelic.agent.add_custom_parameter('seq.current.num_items', len(child_locs))
+ curr_block_counts = collections.Counter(usage_key.block_type for usage_key in child_locs)
+ for block_type, count in curr_block_counts.items():
+ newrelic.agent.add_custom_parameter('seq.current.block_counts.{}'.format(block_type), count)
+
def _time_limited_student_view(self, context):
"""
Delegated rendering of a student view when in a time
diff --git a/common/lib/xmodule/xmodule/tests/test_capa_module.py b/common/lib/xmodule/xmodule/tests/test_capa_module.py
index 354629cbd7..ad130868f8 100644
--- a/common/lib/xmodule/xmodule/tests/test_capa_module.py
+++ b/common/lib/xmodule/xmodule/tests/test_capa_module.py
@@ -731,6 +731,20 @@ class CapaModuleTest(unittest.TestCase):
# Expect an AJAX alert message in 'success'
self.assertIn(error_msg, result['success'])
+ def test_check_problem_zero_max_grade(self):
+ """
+ Test that a capa problem with a max grade of zero doesn't generate an error.
+ """
+ # Create the module
+ module = CapaFactory.create(attempts=1)
+
+ # Override the problem score to have a total of zero.
+ module.lcp.get_score = lambda: {'score': 0, 'total': 0}
+
+ # Check the problem
+ get_request_dict = {CapaFactory.input_key(): '3.14'}
+ module.check_problem(get_request_dict)
+
def test_check_problem_error_nonascii(self):
# Try each exception that capa_module should handle
diff --git a/common/lib/xmodule/xmodule/tests/test_course_metadata_utils.py b/common/lib/xmodule/xmodule/tests/test_course_metadata_utils.py
index 5e8d4ec203..7feeda2c1a 100644
--- a/common/lib/xmodule/xmodule/tests/test_course_metadata_utils.py
+++ b/common/lib/xmodule/xmodule/tests/test_course_metadata_utils.py
@@ -11,6 +11,7 @@ from xmodule.course_metadata_utils import (
clean_course_key,
url_name_for_course_location,
display_name_with_default,
+ display_name_with_default_escaped,
number_for_course_location,
has_course_started,
has_course_ended,
@@ -133,12 +134,18 @@ class CourseMetadataUtilsTestCase(TestCase):
TestScenario((self.demo_course.location,), self.demo_course.location.name),
TestScenario((self.html_course.location,), self.html_course.location.name),
]),
- FunctionTest(display_name_with_default, [
+ FunctionTest(display_name_with_default_escaped, [
# Test course with no display name.
TestScenario((self.demo_course,), "Empty"),
# Test course with a display name that contains characters that need escaping.
TestScenario((self.html_course,), "Intro to <html>"),
]),
+ FunctionTest(display_name_with_default, [
+ # Test course with no display name.
+ TestScenario((self.demo_course,), "Empty"),
+ # Test course with a display name that contains characters that need escaping.
+ TestScenario((self.html_course,), "Intro to "),
+ ]),
FunctionTest(number_for_course_location, [
TestScenario((self.demo_course.location,), "DemoX.1"),
TestScenario((self.html_course.location,), "CS-203"),
diff --git a/common/lib/xmodule/xmodule/tests/test_export.py b/common/lib/xmodule/xmodule/tests/test_export.py
index b9f361d4b0..b4da1df061 100644
--- a/common/lib/xmodule/xmodule/tests/test_export.py
+++ b/common/lib/xmodule/xmodule/tests/test_export.py
@@ -82,7 +82,6 @@ class RoundTripTestCase(unittest.TestCase):
"conditional_and_poll",
"conditional",
"self_assessment",
- "graphic_slider_tool",
"test_exam_registration",
"word_cloud",
"pure_xblock",
diff --git a/common/lib/xmodule/xmodule/tests/test_import.py b/common/lib/xmodule/xmodule/tests/test_import.py
index a061780477..54a7a662c1 100644
--- a/common/lib/xmodule/xmodule/tests/test_import.py
+++ b/common/lib/xmodule/xmodule/tests/test_import.py
@@ -614,22 +614,6 @@ class ImportTestCase(BaseCourseTestCase):
self.assertRaises(etree.XMLSyntaxError, system.process_xml, bad_xml)
- def test_graphicslidertool_import(self):
- '''
- Check to see if definition_from_xml in gst_module.py
- works properly. Pulls data from the graphic_slider_tool directory
- in the test data directory.
- '''
- modulestore = XMLModuleStore(DATA_DIR, source_dirs=['graphic_slider_tool'])
-
- sa_id = SlashSeparatedCourseKey("edX", "gst_test", "2012_Fall")
- location = sa_id.make_usage_key("graphical_slider_tool", "sample_gst")
- gst_sample = modulestore.get_item(location)
- render_string_from_sample_gst_xml = """
- \
-""".strip()
- self.assertIn(render_string_from_sample_gst_xml, gst_sample.data)
-
def test_word_cloud_import(self):
modulestore = XMLModuleStore(DATA_DIR, source_dirs=['word_cloud'])
diff --git a/common/lib/xmodule/xmodule/tests/test_vertical.py b/common/lib/xmodule/xmodule/tests/test_vertical.py
index 5997b2324c..f381f7dda7 100644
--- a/common/lib/xmodule/xmodule/tests/test_vertical.py
+++ b/common/lib/xmodule/xmodule/tests/test_vertical.py
@@ -37,18 +37,31 @@ class BaseVerticalBlockTest(XModuleXmlImportTest):
self.vertical = course_seq.get_children()[0]
self.vertical.xmodule_runtime = self.module_system
+ self.username = "bilbo"
+ self.default_context = {"bookmarked": False, "username": self.username}
+
class VerticalBlockTestCase(BaseVerticalBlockTest):
"""
Tests for the VerticalBlock.
"""
+ def assert_bookmark_info_in(self, content):
+ """
+ Assert content has all the bookmark info.
+ """
+ self.assertIn('bookmark_id', content)
+ self.assertIn('{},{}'.format(self.username, unicode(self.vertical.location)), content)
+ self.assertIn('bookmarked', content)
+ self.assertIn('show_bookmark_button', content)
+
def test_render_student_view(self):
"""
Test the rendering of the student view.
"""
- html = self.module_system.render(self.vertical, STUDENT_VIEW, {}).content
+ html = self.module_system.render(self.vertical, STUDENT_VIEW, self.default_context).content
self.assertIn(self.test_html_1, html)
self.assertIn(self.test_html_2, html)
+ self.assert_bookmark_info_in(html)
def test_render_studio_view(self):
"""
diff --git a/common/lib/xmodule/xmodule/tests/test_xblock_wrappers.py b/common/lib/xmodule/xmodule/tests/test_xblock_wrappers.py
index 214ce621db..e66b6ae5a2 100644
--- a/common/lib/xmodule/xmodule/tests/test_xblock_wrappers.py
+++ b/common/lib/xmodule/xmodule/tests/test_xblock_wrappers.py
@@ -32,7 +32,6 @@ from xmodule.annotatable_module import AnnotatableDescriptor
from xmodule.capa_module import CapaDescriptor
from xmodule.course_module import CourseDescriptor
from xmodule.discussion_module import DiscussionDescriptor
-from xmodule.gst_module import GraphicalSliderToolDescriptor
from xmodule.html_module import HtmlDescriptor
from xmodule.poll_module import PollDescriptor
from xmodule.word_cloud_module import WordCloudDescriptor
@@ -53,7 +52,6 @@ LEAF_XMODULES = {
AnnotatableDescriptor: [{}],
CapaDescriptor: [{}],
DiscussionDescriptor: [{}],
- GraphicalSliderToolDescriptor: [{}],
HtmlDescriptor: [{}],
PollDescriptor: [{'display_name': 'Poll Display Name'}],
WordCloudDescriptor: [{}],
@@ -75,10 +73,9 @@ CONTAINER_XMODULES = {
WrapperBlock: [{}],
}
-# These modules are editable in studio yet
+# These modules are not editable in studio yet
NOT_STUDIO_EDITABLE = (
CrowdsourceHinterDescriptor,
- GraphicalSliderToolDescriptor,
PollDescriptor
)
diff --git a/common/lib/xmodule/xmodule/textannotation_module.py b/common/lib/xmodule/xmodule/textannotation_module.py
index 605e18e5c7..2f447f5229 100644
--- a/common/lib/xmodule/xmodule/textannotation_module.py
+++ b/common/lib/xmodule/xmodule/textannotation_module.py
@@ -121,7 +121,7 @@ class TextAnnotationModule(AnnotatableFields, XModule):
""" Renders parameters to template. """
context = {
'course_key': self.runtime.course_id,
- 'display_name': self.display_name_with_default,
+ 'display_name': self.display_name_with_default_escaped,
'tag': self.instructor_tags,
'source': self.source,
'instructions_html': self.instructions,
diff --git a/common/lib/xmodule/xmodule/vertical_block.py b/common/lib/xmodule/xmodule/vertical_block.py
index edeccd9b75..252735f8ba 100644
--- a/common/lib/xmodule/xmodule/vertical_block.py
+++ b/common/lib/xmodule/xmodule/vertical_block.py
@@ -54,7 +54,14 @@ class VerticalBlock(SequenceFields, XModuleFields, StudioEditableBlock, XmlParse
fragment.add_content(self.system.render_template('vert_module.html', {
'items': contents,
'xblock_context': context,
+ 'show_bookmark_button': True,
+ 'bookmarked': child_context['bookmarked'],
+ 'bookmark_id': "{},{}".format(child_context['username'], unicode(self.location))
}))
+
+ fragment.add_javascript_url(self.runtime.local_resource_url(self, 'public/js/vertical_student_view.js'))
+ fragment.initialize_js('VerticalStudentView')
+
return fragment
def author_view(self, context):
diff --git a/common/lib/xmodule/xmodule/video_module/video_module.py b/common/lib/xmodule/xmodule/video_module/video_module.py
index 85e56d40ad..2bc608bef6 100644
--- a/common/lib/xmodule/xmodule/video_module/video_module.py
+++ b/common/lib/xmodule/xmodule/video_module/video_module.py
@@ -334,7 +334,7 @@ class VideoModule(VideoFields, VideoTranscriptsMixin, VideoStudentViewHandlers,
'cdn_eval': cdn_eval,
'cdn_exp_group': cdn_exp_group,
'id': self.location.html_id(),
- 'display_name': self.display_name_with_default,
+ 'display_name': self.display_name_with_default_escaped,
'handout': self.handout,
'download_video_link': download_video_link,
'track': track_url,
diff --git a/common/lib/xmodule/xmodule/videoannotation_module.py b/common/lib/xmodule/xmodule/videoannotation_module.py
index af0fd4ad97..9d3c10efe7 100644
--- a/common/lib/xmodule/xmodule/videoannotation_module.py
+++ b/common/lib/xmodule/xmodule/videoannotation_module.py
@@ -128,7 +128,7 @@ class VideoAnnotationModule(AnnotatableFields, XModule):
context = {
'course_key': self.runtime.course_id,
- 'display_name': self.display_name_with_default,
+ 'display_name': self.display_name_with_default_escaped,
'instructions_html': self.instructions,
'sourceUrl': self.sourceurl,
'typeSource': extension,
diff --git a/common/lib/xmodule/xmodule/x_module.py b/common/lib/xmodule/xmodule/x_module.py
index 6bea61a777..8060a71004 100644
--- a/common/lib/xmodule/xmodule/x_module.py
+++ b/common/lib/xmodule/xmodule/x_module.py
@@ -348,6 +348,21 @@ class XModuleMixin(XModuleFields, XBlock):
"""
return course_metadata_utils.display_name_with_default(self)
+ @property
+ def display_name_with_default_escaped(self):
+ """
+ DEPRECATED: use display_name_with_default
+
+ Return an html escaped display name for the module: use display_name if
+ defined in metadata, otherwise convert the url name.
+
+ Note: This newly introduced method should not be used. It was only
+ introduced to enable a quick search/replace and the ability to slowly
+ migrate and test switching to display_name_with_default, which is no
+ longer escaped.
+ """
+ return course_metadata_utils.display_name_with_default_escaped(self)
+
@property
def xblock_kvs(self):
"""
@@ -424,7 +439,7 @@ class XModuleMixin(XModuleFields, XBlock):
if self.has_children:
return sum((child.get_content_titles() for child in self.get_children()), [])
else:
- return [self.display_name_with_default]
+ return [self.display_name_with_default_escaped]
def get_children(self, usage_id_filter=None, usage_key_filter=None): # pylint: disable=arguments-differ
"""Returns a list of XBlock instances for the children of
diff --git a/common/static/common/js/components/utils/view_utils.js b/common/static/common/js/components/utils/view_utils.js
index c99625d9ed..60226adaae 100644
--- a/common/static/common/js/components/utils/view_utils.js
+++ b/common/static/common/js/components/utils/view_utils.js
@@ -1,272 +1,294 @@
/**
* Provides useful utilities for views.
*/
-;(function (define) {
+;(function (define, require) {
'use strict';
+
define(["jquery", "underscore", "gettext", "common/js/components/views/feedback_notification",
- "common/js/components/views/feedback_prompt"],
- function ($, _, gettext, NotificationView, PromptView) {
- var toggleExpandCollapse, showLoadingIndicator, hideLoadingIndicator, confirmThenRunOperation,
- runOperationShowingMessage, withDisabledElement, disableElementWhileRunning,
- getScrollOffset, setScrollOffset, setScrollTop, redirect, reload, hasChangedAttributes, deleteNotificationHandler,
- validateRequiredField, validateURLItemEncoding, validateTotalKeyLength, checkTotalKeyLengthViolations;
+ "common/js/components/views/feedback_prompt"],
+ function ($, _, gettext, NotificationView, PromptView) {
+ var toggleExpandCollapse, showLoadingIndicator, hideLoadingIndicator, confirmThenRunOperation,
+ runOperationShowingMessage, withDisabledElement, disableElementWhileRunning,
+ getScrollOffset, setScrollOffset, setScrollTop, redirect, reload, hasChangedAttributes,
+ deleteNotificationHandler, validateRequiredField, validateURLItemEncoding,
+ validateTotalKeyLength, checkTotalKeyLengthViolations, loadJavaScript;
- // see https://openedx.atlassian.net/browse/TNL-889 for what is it and why it's 65
- var MAX_SUM_KEY_LENGTH = 65;
+ // see https://openedx.atlassian.net/browse/TNL-889 for what is it and why it's 65
+ var MAX_SUM_KEY_LENGTH = 65;
- /**
- * Toggles the expanded state of the current element.
- */
- toggleExpandCollapse = function(target, collapsedClass) {
- // Support the old 'collapsed' option until fully switched over to is-collapsed
- if (!collapsedClass) {
- collapsedClass = 'collapsed';
- }
- target.closest('.expand-collapse').toggleClass('expand collapse');
- target.closest('.is-collapsible, .window').toggleClass(collapsedClass);
- target.closest('.is-collapsible').children('article').slideToggle();
- };
+ /**
+ * Toggles the expanded state of the current element.
+ */
+ toggleExpandCollapse = function(target, collapsedClass) {
+ // Support the old 'collapsed' option until fully switched over to is-collapsed
+ if (!collapsedClass) {
+ collapsedClass = 'collapsed';
+ }
+ target.closest('.expand-collapse').toggleClass('expand collapse');
+ target.closest('.is-collapsible, .window').toggleClass(collapsedClass);
+ target.closest('.is-collapsible').children('article').slideToggle();
+ };
- /**
- * Show the page's loading indicator.
- */
- showLoadingIndicator = function() {
- $('.ui-loading').show();
- };
+ /**
+ * Show the page's loading indicator.
+ */
+ showLoadingIndicator = function() {
+ $('.ui-loading').show();
+ };
- /**
- * Hide the page's loading indicator.
- */
- hideLoadingIndicator = function() {
- $('.ui-loading').hide();
- };
+ /**
+ * Hide the page's loading indicator.
+ */
+ hideLoadingIndicator = function() {
+ $('.ui-loading').hide();
+ };
- /**
- * Confirms with the user whether to run an operation or not, and then runs it if desired.
- */
- confirmThenRunOperation = function(title, message, actionLabel, operation, onCancelCallback) {
- return new PromptView.Warning({
- title: title,
- message: message,
- actions: {
- primary: {
- text: actionLabel,
- click: function(prompt) {
- prompt.hide();
- operation();
- }
- },
- secondary: {
- text: gettext('Cancel'),
- click: function(prompt) {
- if (onCancelCallback) {
- onCancelCallback();
+ /**
+ * Confirms with the user whether to run an operation or not, and then runs it if desired.
+ */
+ confirmThenRunOperation = function(title, message, actionLabel, operation, onCancelCallback) {
+ return new PromptView.Warning({
+ title: title,
+ message: message,
+ actions: {
+ primary: {
+ text: actionLabel,
+ click: function(prompt) {
+ prompt.hide();
+ operation();
+ }
+ },
+ secondary: {
+ text: gettext('Cancel'),
+ click: function(prompt) {
+ if (onCancelCallback) {
+ onCancelCallback();
+ }
+ return prompt.hide();
}
- return prompt.hide();
}
}
+ }).show();
+ };
+
+ /**
+ * Shows a progress message for the duration of an asynchronous operation.
+ * Note: this does not remove the notification upon failure because an error
+ * will be shown that shouldn't be removed.
+ * @param message The message to show.
+ * @param operation A function that returns a promise representing the operation.
+ */
+ runOperationShowingMessage = function(message, operation) {
+ var notificationView;
+ notificationView = new NotificationView.Mini({
+ title: gettext(message)
+ });
+ notificationView.show();
+ return operation().done(function() {
+ notificationView.hide();
+ });
+ };
+
+ /**
+ * Wraps a Backbone event callback to disable the event's target element.
+ *
+ * This paradigm is designed to be used in Backbone event maps where
+ * multiple events firing simultaneously is not desired.
+ *
+ * @param functionName the function to execute, as a string.
+ * The function must return a jQuery promise and be able to take an event
+ */
+ withDisabledElement = function(functionName) {
+ return function(event) {
+ var view = this;
+ disableElementWhileRunning($(event.currentTarget), function() {
+ //call view.functionName(event), with view as the current this
+ return view[functionName].apply(view, [event]);
+ });
+ };
+ };
+
+ /**
+ * Disables a given element when a given operation is running.
+ * @param {jQuery} element the element to be disabled.
+ * @param operation the operation during whose duration the
+ * element should be disabled. The operation should return
+ * a JQuery promise.
+ */
+ disableElementWhileRunning = function(element, operation) {
+ element.addClass("is-disabled").attr('aria-disabled', true);
+ return operation().always(function() {
+ element.removeClass("is-disabled").attr('aria-disabled', false);
+ });
+ };
+
+ /**
+ * Returns a handler that removes a notification, both dismissing it and deleting it from the database.
+ * @param callback function to call when deletion succeeds
+ */
+ deleteNotificationHandler = function(callback) {
+ return function (event) {
+ event.preventDefault();
+ $.ajax({
+ url: $(this).data('dismiss-link'),
+ type: 'DELETE',
+ success: callback
+ });
+ };
+ };
+
+ /**
+ * Performs an animated scroll so that the window has the specified scroll top.
+ * @param scrollTop The desired scroll top for the window.
+ */
+ setScrollTop = function(scrollTop) {
+ $('html, body').animate({
+ scrollTop: scrollTop
+ }, 500);
+ };
+
+ /**
+ * Returns the relative position that the element is scrolled from the top of the view port.
+ * @param element The element in question.
+ */
+ getScrollOffset = function(element) {
+ var elementTop = element.offset().top;
+ return elementTop - $(window).scrollTop();
+ };
+
+ /**
+ * Scrolls the window so that the element is scrolled down to the specified relative position
+ * from the top of the view port.
+ * @param element The element in question.
+ * @param offset The amount by which the element should be scrolled from the top of the view port.
+ */
+ setScrollOffset = function(element, offset) {
+ var elementTop = element.offset().top,
+ newScrollTop = elementTop - offset;
+ setScrollTop(newScrollTop);
+ };
+
+ /**
+ * Redirects to the specified URL. This is broken out as its own function for unit testing.
+ */
+ redirect = function(url) {
+ window.location = url;
+ };
+
+ /**
+ * Reloads the page. This is broken out as its own function for unit testing.
+ */
+ reload = function() {
+ window.location.reload();
+ };
+
+ /**
+ * Returns true if a model has changes to at least one of the specified attributes.
+ * @param model The model in question.
+ * @param attributes The list of attributes to be compared.
+ * @returns {boolean} Returns true if attribute changes are found.
+ */
+ hasChangedAttributes = function(model, attributes) {
+ var i, changedAttributes = model.changedAttributes();
+ if (!changedAttributes) {
+ return false;
+ }
+ for (i=0; i < attributes.length; i++) {
+ if (_.has(changedAttributes, attributes[i])) {
+ return true;
+ }
}
- }).show();
- };
-
- /**
- * Shows a progress message for the duration of an asynchronous operation.
- * Note: this does not remove the notification upon failure because an error
- * will be shown that shouldn't be removed.
- * @param message The message to show.
- * @param operation A function that returns a promise representing the operation.
- */
- runOperationShowingMessage = function(message, operation) {
- var notificationView;
- notificationView = new NotificationView.Mini({
- title: gettext(message)
- });
- notificationView.show();
- return operation().done(function() {
- notificationView.hide();
- });
- };
-
- /**
- * Wraps a Backbone event callback to disable the event's target element.
- *
- * This paradigm is designed to be used in Backbone event maps where
- * multiple events firing simultaneously is not desired.
- *
- * @param functionName the function to execute, as a string.
- * The function must return a jQuery promise and be able to take an event
- */
- withDisabledElement = function(functionName) {
- return function(event) {
- var view = this;
- disableElementWhileRunning($(event.currentTarget), function() {
- //call view.functionName(event), with view as the current this
- return view[functionName].apply(view, [event]);
- });
- };
- };
-
- /**
- * Disables a given element when a given operation is running.
- * @param {jQuery} element the element to be disabled.
- * @param operation the operation during whose duration the
- * element should be disabled. The operation should return
- * a JQuery promise.
- */
- disableElementWhileRunning = function(element, operation) {
- element.addClass("is-disabled").attr('aria-disabled', true);
- return operation().always(function() {
- element.removeClass("is-disabled").attr('aria-disabled', false);
- });
- };
-
- /**
- * Returns a handler that removes a notification, both dismissing it and deleting it from the database.
- * @param callback function to call when deletion succeeds
- */
- deleteNotificationHandler = function(callback) {
- return function (event) {
- event.preventDefault();
- $.ajax({
- url: $(this).data('dismiss-link'),
- type: 'DELETE',
- success: callback
- });
- };
- };
-
- /**
- * Performs an animated scroll so that the window has the specified scroll top.
- * @param scrollTop The desired scroll top for the window.
- */
- setScrollTop = function(scrollTop) {
- $('html, body').animate({
- scrollTop: scrollTop
- }, 500);
- };
-
- /**
- * Returns the relative position that the element is scrolled from the top of the view port.
- * @param element The element in question.
- */
- getScrollOffset = function(element) {
- var elementTop = element.offset().top;
- return elementTop - $(window).scrollTop();
- };
-
- /**
- * Scrolls the window so that the element is scrolled down to the specified relative position
- * from the top of the view port.
- * @param element The element in question.
- * @param offset The amount by which the element should be scrolled from the top of the view port.
- */
- setScrollOffset = function(element, offset) {
- var elementTop = element.offset().top,
- newScrollTop = elementTop - offset;
- setScrollTop(newScrollTop);
- };
-
- /**
- * Redirects to the specified URL. This is broken out as its own function for unit testing.
- */
- redirect = function(url) {
- window.location = url;
- };
-
- /**
- * Reloads the page. This is broken out as its own function for unit testing.
- */
- reload = function() {
- window.location.reload();
- };
-
- /**
- * Returns true if a model has changes to at least one of the specified attributes.
- * @param model The model in question.
- * @param attributes The list of attributes to be compared.
- * @returns {boolean} Returns true if attribute changes are found.
- */
- hasChangedAttributes = function(model, attributes) {
- var i, changedAttributes = model.changedAttributes();
- if (!changedAttributes) {
return false;
- }
- for (i=0; i < attributes.length; i++) {
- if (_.has(changedAttributes, attributes[i])) {
- return true;
+ };
+
+ /**
+ * Helper method for course/library creation - verifies a required field is not blank.
+ */
+ validateRequiredField = function (msg) {
+ return msg.length === 0 ? gettext('Required field.') : '';
+ };
+
+ /**
+ * Helper method for course/library creation.
+ * Check that a course (org, number, run) doesn't use any special characters
+ */
+ validateURLItemEncoding = function (item, allowUnicode) {
+ var required = validateRequiredField(item);
+ if (required) {
+ return required;
}
- }
- return false;
- };
-
- /**
- * Helper method for course/library creation - verifies a required field is not blank.
- */
- validateRequiredField = function (msg) {
- return msg.length === 0 ? gettext('Required field.') : '';
- };
-
- /**
- * Helper method for course/library creation.
- * Check that a course (org, number, run) doesn't use any special characters
- */
- validateURLItemEncoding = function (item, allowUnicode) {
- var required = validateRequiredField(item);
- if (required) {
- return required;
- }
- if (allowUnicode) {
- if (/\s/g.test(item)) {
- return gettext('Please do not use any spaces in this field.');
+ if (allowUnicode) {
+ if (/\s/g.test(item)) {
+ return gettext('Please do not use any spaces in this field.');
+ }
}
- }
- else {
- if (item !== encodeURIComponent(item) || item.match(/[!'()*]/)) {
- return gettext('Please do not use any spaces or special characters in this field.');
+ else {
+ if (item !== encodeURIComponent(item) || item.match(/[!'()*]/)) {
+ return gettext('Please do not use any spaces or special characters in this field.');
+ }
}
- }
- return '';
- };
+ return '';
+ };
- // Ensure that sum length of key field values <= ${MAX_SUM_KEY_LENGTH} chars.
- validateTotalKeyLength = function (key_field_selectors) {
- var totalLength = _.reduce(
- key_field_selectors,
- function (sum, ele) { return sum + $(ele).val().length;},
- 0
- );
- return totalLength <= MAX_SUM_KEY_LENGTH;
- };
+ // Ensure that sum length of key field values <= ${MAX_SUM_KEY_LENGTH} chars.
+ validateTotalKeyLength = function (key_field_selectors) {
+ var totalLength = _.reduce(
+ key_field_selectors,
+ function (sum, ele) { return sum + $(ele).val().length;},
+ 0
+ );
+ return totalLength <= MAX_SUM_KEY_LENGTH;
+ };
- checkTotalKeyLengthViolations = function(selectors, classes, key_field_selectors, message_tpl) {
- if (!validateTotalKeyLength(key_field_selectors)) {
- $(selectors.errorWrapper).addClass(classes.shown).removeClass(classes.hiding);
- $(selectors.errorMessage).html('