annotation tools

cms/envs/common.py

@@ -319,7 +319,9 @@
             'css/vendor/ui-lightness/jquery-ui-1.8.22.custom.css',
             'css/vendor/jquery.qtip.min.css',
             'js/vendor/markitup/skins/simple/style.css',
-            'js/vendor/markitup/sets/wiki/style.css'
+            'js/vendor/markitup/sets/wiki/style.css',
+            'css/vendor/ova/video-js.min.css',
+            'css/vendor/ova/token-input.css',
         ],
         'output_filename': 'css/cms-style-vendor.css',
     },

cms/templates/base.html

@@ -227,7 +227,7 @@
             "coffee/src/logger": {
                 exports: "Logger",
                 deps: ["coffee/src/ajax_prefix"]
-            }
+            },
         },
         // load jquery and gettext automatically
         deps: ["jquery", "gettext"],

common/djangoapps/student/tests/tests.py

@@ -25,7 +25,7 @@
 
 from student.models import anonymous_id_for_user, user_by_anonymous_id, CourseEnrollment, unique_id_for_user
 from student.views import (process_survey_link, _cert_info,
-                           change_enrollment, complete_course_mode_info, token)
+                           change_enrollment, complete_course_mode_info)
 from student.tests.factories import UserFactory, CourseModeFactory
 
 import shoppingcart
@@ -458,26 +458,3 @@ def test_roundtrip_for_logged_user(self):
         anonymous_id = anonymous_id_for_user(self.user, self.course.id)
         real_user = user_by_anonymous_id(anonymous_id)
         self.assertEqual(self.user, real_user)
-
-
-@override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE)
-class Token(ModuleStoreTestCase):
-    """
-    Test for the token generator. This creates a random course and passes it through the token file which generates the
-    token that will be passed in to the annotation_storage_url.
-    """
-    request_factory = RequestFactory()
-    COURSE_SLUG = "100"
-    COURSE_NAME = "test_course"
-    COURSE_ORG = "edx"
-
-    def setUp(self):
-        self.course = CourseFactory.create(org=self.COURSE_ORG, display_name=self.COURSE_NAME, number=self.COURSE_SLUG)
-        self.user = User.objects.create(username="username", email="username")
-        self.req = self.request_factory.post('/token?course_id=edx/100/test_course', {'user': self.user})
-        self.req.user = self.user
-
-    def test_token(self):
-        expected = HttpResponse("eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJpc3N1ZWRBdCI6ICIyMDE0LTAxLTIzVDE5OjM1OjE3LjUyMjEwNC01OjAwIiwgImNvbnN1bWVyS2V5IjogInh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsICJ1c2VySWQiOiAidXNlcm5hbWUiLCAidHRsIjogODY0MDB9.OjWz9mzqJnYuzX-f3uCBllqJUa8PVWJjcDy_McfxLvc", mimetype="text/plain")
-        response = token(self.req)
-        self.assertEqual(expected.content.split('.')[0], response.content.split('.')[0])

common/djangoapps/student/views.py

@@ -44,7 +44,6 @@
     create_comments_service_user, PasswordHistory
 )
 from student.forms import PasswordResetFormNoActive
-from student.firebase_token_generator import create_token
 
 from verify_student.models import SoftwareSecurePhotoVerification, MidcourseReverificationWindow
 from certificates.models import CertificateStatuses, certificate_status_for_student
@@ -1780,26 +1779,3 @@ def change_email_settings(request):
         track.views.server_track(request, "change-email-settings", {"receive_emails": "no", "course": course_id}, page='dashboard')
 
     return JsonResponse({"success": True})
-
-
-@login_required
-def token(request):
-    '''
-    Return a token for the backend of annotations.
-    It uses the course id to retrieve a variable that contains the secret
-    token found in inheritance.py. It also contains information of when
-    the token was issued. This will be stored with the user along with
-    the id for identification purposes in the backend.
-    '''
-    course_id = request.GET.get("course_id")
-    course = course_from_id(course_id)
-    dtnow = datetime.datetime.now()
-    dtutcnow = datetime.datetime.utcnow()
-    delta = dtnow - dtutcnow
-    newhour, newmin = divmod((delta.days * 24 * 60 * 60 + delta.seconds + 30) // 60, 60)
-    newtime = "%s%+02d:%02d" % (dtnow.isoformat(), newhour, newmin)
-    secret = course.annotation_token_secret
-    custom_data = {"issuedAt": newtime, "consumerKey": secret, "userId": request.user.email, "ttl": 86400}
-    newtoken = create_token(secret, custom_data)
-    response = HttpResponse(newtoken, mimetype="text/plain")
-    return response

common/lib/xmodule/xmodule/annotator_mixin.py

@@ -0,0 +1,56 @@
+"""
+Annotations Tool Mixin
+This file contains global variables and functions used in the various Annotation Tools.
+"""
+from pkg_resources import resource_string
+from lxml import etree
+from urlparse import urlparse
+from os.path import splitext, basename
+
+def get_instructions(xmltree):
+    """ Removes <instructions> from the xmltree and returns them as a string, otherwise None. """
+    instructions = xmltree.find('instructions')
+    if instructions is not None:
+        instructions.tag = 'div'
+        xmltree.remove(instructions)
+        return etree.tostring(instructions, encoding='unicode')
+    return None
+
+def get_extension(srcurl):
+    ''' get the extension of a given url '''
+    if 'youtu' in srcurl:
+        return 'video/youtube'
+    else:
+        disassembled = urlparse(srcurl)
+        file_ext = splitext(basename(disassembled.path))[1]
+        return 'video/' + file_ext.replace('.', '')
+
+ANNOTATOR_COMMON_JS = [
+    resource_string(__name__, 'js/src/ova/annotator-full.js'),
+    resource_string(__name__, 'js/src/ova/annotator-full-firebase-auth.js'),
+    resource_string(__name__, 'js/src/ova/video.dev.js'),
+    resource_string(__name__, 'js/src/ova/vjs.youtube.js'),
+    resource_string(__name__, 'js/src/ova/rangeslider.js'),
+    resource_string(__name__, 'js/src/ova/share-annotator.js'),
+    resource_string(__name__, 'js/src/ova/richText-annotator.js'),
+    resource_string(__name__, 'js/src/ova/reply-annotator.js'),
+    resource_string(__name__, 'js/src/ova/tags-annotator.js'),
+    resource_string(__name__, 'js/src/ova/flagging-annotator.js'),
+    resource_string(__name__, 'js/src/ova/jquery-Watch.js'),
+    resource_string(__name__, 'js/src/ova/diacritic-annotator.js'),
+    resource_string(__name__, 'js/src/ova/ova.js'),
+    resource_string(__name__, 'js/src/ova/catch/js/catch.js'),
+    resource_string(__name__, 'js/src/ova/catch/js/handlebars-1.1.2.js'),
+]
+
+ANNOTATOR_COMMON_CSS = [
+    resource_string(__name__, 'css/ova/edx-annotator.css'),
+    resource_string(__name__, 'css/ova/annotator.css'),
+    resource_string(__name__, 'css/ova/ova.css'),
+    resource_string(__name__, 'css/ova/rangeslider.css'),
+    resource_string(__name__, 'css/ova/share-annotator.css'),
+    resource_string(__name__, 'css/ova/richText-annotator.css'),
+    resource_string(__name__, 'css/ova/diacritic-annotator.css'),
+    resource_string(__name__, 'css/ova/flagging-annotator.css'),
+    resource_string(__name__, 'js/src/ova/catch/css/main.css'),
+]

common/lib/xmodule/xmodule/annotator_token.py

@@ -0,0 +1,26 @@
+'''
+This file contains a function used to retrieve the token for the annotation backend
+without having to create a view, but just returning a string instead.
+
+It can be called from other files by using the following:
+from xmodule.annotator_token import retrieve_token
+'''
+import datetime
+from firebase_token_generator import create_token
+
+def retrieve_token(userid, secret):
+    '''
+    Return a token for the backend of annotations.
+    It uses the course id to retrieve a variable that contains the secret
+    token found in inheritance.py. It also contains information of when
+    the token was issued. This will be stored with the user along with
+    the id for identification purposes in the backend.
+    '''
+    dtnow = datetime.datetime.now()
+    dtutcnow = datetime.datetime.utcnow()
+    delta = dtnow - dtutcnow
+    newhour, newmin = divmod((delta.days * 24 * 60 * 60 + delta.seconds + 30) // 60, 60)
+    newtime = "%s%+02d:%02d" % (dtnow.isoformat(), newhour, newmin)
+    custom_data = {"issuedAt": newtime, "consumerKey": secret, "userId": userid, "ttl": 86400}
+    newtoken = create_token(secret, custom_data)
+    return newtoken

common/lib/xmodule/xmodule/css/ova/diacritic-annotator.css

@@ -0,0 +1,6 @@
+.mark{
+    width:10px;
+    height:10px;   
+    position:absolute;
+    background-size:contain;   
+}

common/static/css/vendor/ova/edx-annotator.css → common/lib/xmodule/xmodule/css/ova/edx-annotator.css

@@ -1,4 +1,8 @@
 /*This is written to fix some design problems with edX*/
+.annotatable-wrapper .annotatable-header .annotatable-title{
+    padding-top: 20px !important;
+}
+
 .annotator-wrapper .annotator-adder button {
         opacity:0;
 }
@@ -27,6 +31,11 @@ span.annotator-hl{
 	display: none!important;
 }
 /*Catch*/
+
+#catchDIV{
+    margin-top:15px;
+}
+
 #mainCatch *{
 	-moz-box-sizing: border-box;
 	-webkit-box-sizing: border-box;

common/static/css/vendor/ova/richText-annotator.css → common/lib/xmodule/xmodule/css/ova/richText-annotator.css

@@ -20,6 +20,18 @@
 	z-index:3000000000!important; /*To fix full-screen problems*/
 }
 
+.mce-container-body {
+	min-width:400px;
+}
+
+iframe[id^="annotator-field"] {
+	width: inherit;
+	min-width: 400px;
+}
+
+div.mce-tinymce.mce-container.mce-panel {
+	min-width: 400px;
+}
 
 /* Some change in the design of Annotator */
 .annotator-editor .annotator-widget{
@@ -31,3 +43,4 @@
 	background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QkBBB07nraNoQAAAhZJREFUKM+NkstrE1EUxr+5c08ykztpJtVoazHBF8FgQQzonyBKEZS6FrQKLl0EXBRT0ZULJSs3oii4TyHgu90IlTaL6qouWlv7Ck1N0BSnmZk714WbPHz07M4534+Pw3eAHdTY8A9+Nd9/bshU1DpnO4HXjh2ZY2J9/OSTxHTrnP8PvJYf+BDQ6qEDaQBB43jrTusUFy4oPjsYWYzF+VS91nxLYfdhKgONaQT3W/KMxr1XY5e+qj86f8zsKYYsZ6AvjWFzA8ORHkAnwN8So7evzL/8pzMAXL/Hq8mMv1up371T7Z+/c3n9cKeuDS6Xy6dN07zLuZ56Onk2Ed2/ANJsnE/PQMpgyffle+kYzwazB1+3waVS6X48Hr9BRPB9H57nYXplFKeSt8D1Hriug9XKF0x+Lmw+ys8m2m42DOOn4zhQSsGyLOi6jqONm9isbmFVFlDbaGKx8QaB1rvdlbNhGLAsC0IIGIYBIQSy2ROQ0oOp7wOPraHXEugRvDtnzjmi0SiICEIIEBGklAB9B6cmbG0AUnrY5m73h+m6DsYYTNMEYwxEBMY0hGNVhHkcZigBO9qHlDHS7cwYg23bAIBQKAQigud7IH0XwtxDoHwEIQ9SLKx0wa7rPiaivYyxESklXNeFBg0mjyNQTQSuATMSm6ipuYt//eVcLhdeXl5+UKlUlur1upqamVAv3j3/VCyOD3VqfwF6uLp3q+vMcgAAAABJRU5ErkJggg==');
 	background-repeat: no-repeat;
 }
+

common/lib/xmodule/xmodule/js/src/ova/annotator-full-firebase-auth.js

@@ -0,0 +1,22 @@
+Annotator.Plugin.Auth.prototype.haveValidToken = function() {
+    var allFields;
+    allFields = this._unsafeToken && this._unsafeToken.d.issuedAt && this._unsafeToken.d.ttl && this._unsafeToken.d.consumerKey;
+    if (allFields && this.timeToExpiry() > 0) {
+      return true;
+    } else {
+      return false;
+    }
+};
+
+Annotator.Plugin.Auth.prototype.timeToExpiry = function() {
+    var expiry, issue, now, timeToExpiry;
+    now = new Date().getTime() / 1000;
+    issue = createDateFromISO8601(this._unsafeToken.d.issuedAt).getTime() / 1000;
+    expiry = issue + this._unsafeToken.d.ttl;
+    timeToExpiry = expiry - now;
+    if (timeToExpiry > 0) {
+      return timeToExpiry;
+    } else {
+      return 0;
+    }
+};