Commit 14209c67 by David Baumgold

Merge pull request #5667 from lduarte1991/lduarte-harvardx-pr33

Annotation Tools: Upgrading Share plugin from v1.0 to v1.1
parents 46b2f0d7 976c3cb1
/* /*
Share Annotation Plugin v1.0 (https://github.com/danielcebrian/share-annotator) Share Annotation Plugin v1.1 (https://github.com/danielcebrian/share-annotator)
Copyright (C) 2014 Daniel Cebrian Robles Copyright (C) 2014 Daniel Cebrian Robles
License: https://github.com/danielcebrian/share-annotator/blob/master/License.rst License: https://github.com/danielcebrian/share-annotator/blob/master/License.rst
...@@ -29,13 +29,13 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -29,13 +29,13 @@ Annotator.Plugin.Share = (function(_super) {
Share.prototype.options = { Share.prototype.options = {
shareIn: ['facebook', 'twitter', 'email', 'google'], shareIn: ['facebook', 'twitter', 'email', 'google'],
getUrl: { getUrl: {
'facebook':function(title, link, noteText){ 'facebook': function(title, link, noteText) {
return 'https://www.facebook.com/sharer/sharer.php?s=100&p[url]=' + link + '&p[title]=' + encodeURIComponent('Open Video Annotation') + '&p[summary]=' + noteText; return 'https://www.facebook.com/sharer/sharer.php?s=100&p[url]=' + link + '&p[title]=' + encodeURIComponent('Open Video Annotation') + '&p[summary]=' + noteText;
}, },
'twitter':function(title, link, noteText){ 'twitter': function(title, link, noteText) {
return 'https://twitter.com/intent/tweet?original_referer=' + link + '&source=tweetbutton&url=' + link + "&via=OpenVideoAnnotation&text=" + encodeURIComponent('I want to share the following Open Video Annotation: '); return 'https://twitter.com/intent/tweet?original_referer=' + link + '&source=tweetbutton&url=' + link + "&via=OpenVideoAnnotation&text=" + encodeURIComponent('I want to share the following Open Video Annotation: ');
}, },
'google':function(title, link, noteText){ 'google': function(title, link, noteText) {
return 'https://plus.google.com/share?url=' + link; return 'https://plus.google.com/share?url=' + link;
}, },
'email': function(title, link, noteText){ 'email': function(title, link, noteText){
...@@ -46,8 +46,9 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -46,8 +46,9 @@ Annotator.Plugin.Share = (function(_super) {
}; };
function Share(element, options) { function Share(element, options) {
if (typeof options!='undefined') if (typeof options !== 'undefined') {
this.options.shareIn = typeof options.shareIn!='undefined'?options.shareIn:this.options.shareIn; this.options.shareIn = typeof options.shareIn !== 'undefined' ? options.shareIn : this.options.shareIn;
}
this.buildHTMLShareButton = __bind(this.buildHTMLShareButton, this); this.buildHTMLShareButton = __bind(this.buildHTMLShareButton, this);
this.runningAPI = __bind(this.runningAPI, this); this.runningAPI = __bind(this.runningAPI, this);
this.updateViewer = __bind(this.updateViewer, this); this.updateViewer = __bind(this.updateViewer, this);
...@@ -74,7 +75,6 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -74,7 +75,6 @@ Annotator.Plugin.Share = (function(_super) {
var newfield = Annotator.$('<li class="annotator-item">' + this.buildHTMLShareButton('Share without saving:') + '</li>'); var newfield = Annotator.$('<li class="annotator-item">' + this.buildHTMLShareButton('Share without saving:') + '</li>');
Annotator.$(this.field).replaceWith(newfield); Annotator.$(this.field).replaceWith(newfield);
this.field=newfield[0]; this.field=newfield[0];
// Create the actions for the buttons // Create the actions for the buttons
this.buttonsActions(this.field, 2, this.options.baseUrl); // 2 is the method of the API that will be for share without saving this.buttonsActions(this.field, 2, this.options.baseUrl); // 2 is the method of the API that will be for share without saving
...@@ -94,25 +94,26 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -94,25 +94,26 @@ Annotator.Plugin.Share = (function(_super) {
// Share button HTML // Share button HTML
Share.prototype.buildHTMLShareButton = function(title, id) { Share.prototype.buildHTMLShareButton = function(title, id) {
var title = title || ''; var title = title || '';
var id = typeof id!='undefined'?'annotationId="' + id + '"':''; var id = typeof id !== 'undefined' ? 'annotationId="' + id + '"' : '';
var titleText = title!=''?'<div class="share-text-annotator">' + title + '</div>':''; var titleText = title !== '' ? '<div class="share-text-annotator">' + title + '</div>' : '';
var shareButton = '<div class="share-button-annotator share-button" ' + id + '></div>'; var shareButton = '<div class="share-button-annotator share-button" ' + id + '></div>';
var popup = '<div class="share-popup-overlay-bg" style="z-index:30000000000"><div class="share-popup"><div class="share-popup-items"></div><div class="close-btn">Close</div></div></div>'; var popup = '<div class="share-popup-overlay-bg" style="z-index:30000000000"><div class="share-popup"><div class="share-popup-items"></div><div class="close-btn">Close</div></div></div>';
// checks to make sure that no popup overlay already exists (though hidden) and creates a new one if it does not exist // checks to make sure that no popup overlay already exists (though hidden) and creates a new one if it does not exist
if($('.share-popup-overlay-bg').length === 0) if ($('.share-popup-overlay-bg').length === 0) {
$('.annotator-wrapper').append(popup); $('.annotator-wrapper').append(popup);
}
return '<div class="share-container-annotator">' + titleText + shareButton + '</div>'; return '<div class="share-container-annotator">' + titleText + shareButton + '</div>';
} }
// template for the design of the Share Plugin // template for the design of the Share Plugin
Share.prototype.buildHTMLPopup = function(title) { Share.prototype.buildHTMLPopup = function(title) {
var buttons = ''; var buttons = '';
if (typeof this.options.shareIn != 'undefined'){ if (typeof this.options.shareIn !== 'undefined'){
this.options.shareIn.forEach(function(item) { this.options.shareIn.forEach(function(item) {
buttons += '<div class="share-' + item + '-annotator share-button">' + item.charAt(0).toUpperCase() + item.slice(1) + '</div>'; buttons += '<div class="share-' + item + '-annotator share-button">' + item.charAt(0).toUpperCase() + item.slice(1) + '</div>';
}); });
} }
this.uri = (typeof this.uri != 'undefined') ? this.uri : ''; this.uri = (typeof this.uri !== 'undefined') ? this.uri : '';
var title = '<div class="share-popup-title">' + title.replace(":", "") + '</div>'; var title = '<div class="share-popup-title">' + title.replace(":", "") + '</div>';
var copy = '<div class="share-popup-copy">Copy and Share:</div>'; var copy = '<div class="share-popup-copy">Copy and Share:</div>';
var uri = '<input type="text" class="share-popup-uri" onclick="javascript:this.select();" readonly="true" value="' + this.uri + '">'; var uri = '<input type="text" class="share-popup-uri" onclick="javascript:this.select();" readonly="true" value="' + this.uri + '">';
...@@ -121,7 +122,7 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -121,7 +122,7 @@ Annotator.Plugin.Share = (function(_super) {
} }
// Create the actions for the buttons // Create the actions for the buttons
Share.prototype.buttonsActions = function(field, method, url, annotation) { Share.prototype.buttonsActions = function(field, method, url) {
var share = this; var share = this;
// hide popup when user clicks on close button // hide popup when user clicks on close button
...@@ -139,18 +140,12 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -139,18 +140,12 @@ Annotator.Plugin.Share = (function(_super) {
// Share button // Share button
$(field).find('.share-button-annotator.share-button').click(function(event) { $(field).find('.share-button-annotator.share-button').click(function(event) {
event.preventDefault(); // disable normal link function so that it doesn't refresh the page event.preventDefault(); // disable normal link function so that it doesn't refresh the page
annotation = share.getAnnotationFromId(event.currentTarget.attributes.annotationid);
var _field = this; var _field = this;
var ovaId = annotation.id; var ovaId = $(this).attr('annotationId');
var title; var title = method === 1 ? 'Share' : 'Share without saving';
if (method == 1) {
title = 'Share';
} else {
title = 'Share without saving';
}
// share.uri will be useful for buildHTMLPopup functions // share.uri will be useful for buildHTMLPopup functions
share.uri = share.createAPIURL(method, ovaId, url, annotation); share.uri = share.createAPIURL(method, ovaId, url);
// display your popup // display your popup
$('.share-popup-overlay-bg').show(); $('.share-popup-overlay-bg').show();
...@@ -159,22 +154,23 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -159,22 +154,23 @@ Annotator.Plugin.Share = (function(_super) {
$('.share-popup-items').html(share.buildHTMLPopup(title)); $('.share-popup-items').html(share.buildHTMLPopup(title));
// buttons actions // buttons actions
if (typeof share.options.shareIn!='undefined'){ if (typeof share.options.shareIn !== 'undefined') {
share.options.shareIn.forEach(function(item) { share.options.shareIn.forEach(function(item) {
$('.share-' + item + '-annotator.share-button').click(function() { $('.share-' + item + '-annotator.share-button').click(function() {
var url = share.createAPIURL(method, ovaId, url, annotation); var url = share.createAPIURL(method, ovaId, url);
var title = "Sharing a annotation with Open Video Annotation"; var title = "Sharing a annotation with Open Video Annotation";
var link = encodeURIComponent(url); var link = encodeURIComponent(url);
var noteText = share.getSource('ovaText'); var noteText = share.getSource('ovaText');
var finalUrl = ''; var finalUrl = '';
if (method==1){ if (method === 1) {
var viewer = share.annotator.viewer; var viewer = share.annotator.viewer;
var textarea = $(viewer.element).find('div:first').html(); var textarea = $(viewer.element).find('div:first').html();
noteText = encodeURIComponent(textarea); noteText = encodeURIComponent(textarea);
} }
finalUrl = typeof share.options.getUrl[item]!='undefined'?share.options.getUrl[item](title, link, noteText):''; finalUrl = typeof share.options.getUrl[item] !== 'undefined' ? share.options.getUrl[item](title, link, noteText) : '';
if (typeof share.options.getUrl[item]!='undefined') if (typeof share.options.getUrl[item] !== 'undefined') {
window.open(finalUrl); window.open(finalUrl);
}
}); });
}); });
} }
...@@ -182,34 +178,59 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -182,34 +178,59 @@ Annotator.Plugin.Share = (function(_super) {
}; };
Share.prototype.createAPIURL = function(method, ovaId, url, annotation) { Share.prototype.createAPIURL = function(method, ovaId, url) {
var annotator = this.annotator; var annotator = this.annotator;
var editor = annotator.editor; var editor = annotator.editor;
var method = method || 1; var method = method || 1;
var url = annotation.uri || window.location.href; var url = url || window.location.href;
url += (url.indexOf('?') >= 0)? '&' : '?'; url += (url.indexOf('?') >= 0) ? '&' : '?';
if (method === 1){ if (method === 1) {
var ovaId = (typeof ovaId !='undefined') ? ovaId : ''; var ovaId = (typeof ovaId !== 'undefined') ? ovaId : '';
url += 'ovaId=' + ovaId; url += 'ovaId=' + ovaId;
} else if (method === 2){ } else if (method === 2) {
var ovaStart = this.getSource('ovaStart'); var ovaText = this.getSource('ovaText') || " ";
var ovaEnd = this.getSource('ovaEnd'); url += 'ovaText=' + ovaText;
var ovaText = this.getSource('ovaText'); if (typeof editor.VideoJS !== 'undefined' && editor.VideoJS !== -1) { // Video Annotation
var ovaStart = this.getSource('ovaStart') || " ";
url += 'ovaStart=' + ovaStart var ovaEnd = this.getSource('ovaEnd') || " ";
var ovaContainer = this.getSource('ovaContainer') || " ";
var ovaSrc = this.getSource('ovaSrc') || " ";
url += '&ovaStart=' + ovaStart
+ '&ovaEnd=' + ovaEnd + '&ovaEnd=' + ovaEnd
+ '&ovaText=' + ovaText; + '&ovaContainer=' + ovaContainer
if (typeof editor.VideoJS != 'undefined' && editor.VideoJS !== -1){// Video Annotation + '&ovaSrc=' + ovaSrc;
var ovaContainer = this.getSource('ovaContainer'); } else if (typeof editor.OpenSeaDragon !== 'undefined' && editor.OpenSeaDragon !== -1) { // Image Annotation
var ovaSrc = this.getSource('ovaSrc'); var ovaLeft = this.getSource('ovaLeft') || " ";
url += '&ovaContainer=' + ovaContainer var ovaTop = this.getSource('ovaTop') || " ";
var ovaWidth = this.getSource('ovaWidth') || " ";
var ovaHeight = this.getSource('ovaHeight') || " ";
var ovaLeftZoom = this.getSource('ovaLeftZoom') || " ";
var ovaTopZoom = this.getSource('ovaTopZoom') || " ";
var ovaWidthZoom = this.getSource('ovaWidthZoom') || " ";
var ovaHeightZoom = this.getSource('ovaHeightZoom') || " ";
var ovaContainer = this.getSource('ovaContainer') || " ";
var ovaSrc = this.getSource('ovaSrc') || " ";
url += '&ovaLeft=' + ovaLeft
+ '&ovaTop=' + ovaTop
+ '&ovaWidth=' + ovaWidth
+ '&ovaHeight=' + ovaHeight
+ '&ovaLeftZoom=' + ovaLeftZoom
+ '&ovaTopZoom=' + ovaTopZoom
+ '&ovaWidthZoom=' + ovaWidthZoom
+ '&ovaHeightZoom=' + ovaHeightZoom
+ '&ovaContainer=' + ovaContainer
+ '&ovaSrc=' + ovaSrc; + '&ovaSrc=' + ovaSrc;
} else {// Text Annotation } else { // Text Annotation
var ovastartOffset = this.getSource('ovastartOffset'); var ovaStart = this.getSource('ovaStart') || " ";
var ovaendOffset = this.getSource('ovaendOffset'); var ovaEnd = this.getSource('ovaEnd') || " ";
url += '&ovastartOffset=' + ovastartOffset + '&ovaendOffset=' + ovaendOffset; var ovastartOffset = this.getSource('ovastartOffset') || " ";
var ovaendOffset = this.getSource('ovaendOffset') || " ";
url += '&ovaStart=' + ovaStart
+ '&ovaEnd=' + ovaEnd
+ '&ovastartOffset=' + ovastartOffset
+ '&ovaendOffset=' + ovaendOffset;
} }
} }
return url; return url;
...@@ -217,38 +238,70 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -217,38 +238,70 @@ Annotator.Plugin.Share = (function(_super) {
Share.prototype.getSource = function(source) { Share.prototype.getSource = function(source) {
var source = source || ''; var source = source || '';
if (source == 'ovaId') {// method 1 if (source === 'ovaId') { // method 1
source=this.annotation.id; source = this.annotation.id;
} else {// method 2 } else { // method 2
var annotator = this.annotator; var annotator = this.annotator;
var editor = annotator.editor; var editor = annotator.editor;
var textarea = $(editor.element).find('textarea')[0]; var textarea = $(editor.element).find('textarea')[0];
if (source == 'ovaText') if (source === 'ovaText') {
source = textarea.value; source = textarea.value;
}
if (typeof editor.VideoJS!='undefined' && editor.VideoJS !== -1){// Video Annotation if (typeof editor.VideoJS !== 'undefined' && editor.VideoJS !== -1) { // Video Annotation
if (source == 'ovaContainer') if (source === 'ovaContainer') {
source = editor.VideoJS; source = editor.VideoJS;
else if (source == 'ovaSrc') }
else if (source === 'ovaSrc') {
source = annotator.mplayer[editor.VideoJS].tech.options_.source.src; source = annotator.mplayer[editor.VideoJS].tech.options_.source.src;
else if (source == 'ovaStart') } else if (source === 'ovaStart') {
source = annotator.mplayer[editor.VideoJS].rangeslider.getValues().start; source = annotator.mplayer[editor.VideoJS].rangeslider.getValues().start;
else if (source == 'ovaEnd') } else if (source === 'ovaEnd') {
source = annotator.mplayer[editor.VideoJS].rangeslider.getValues().end; source = annotator.mplayer[editor.VideoJS].rangeslider.getValues().end;
}
} else {// Text Annotation } else if (typeof editor.OpenSeaDragon !== 'undefined' && editor.OpenSeaDragon !== -1) { // Image Annotation
var annotation = editor.annotation;
if (source === 'ovaLeft') {
source = annotator.osda.rectPosition ? annotator.osda.rectPosition.left : annotation.rangePosition.left;
} else if (source === 'ovaTop') {
source = annotator.osda.rectPosition ? annotator.osda.rectPosition.top : annotation.rangePosition.top;
} else if (source === 'ovaWidth') {
source = annotator.osda.rectPosition ? annotator.osda.rectPosition.width : annotation.rangePosition.width;
} else if (source ==='ovaHeight') {
source = annotator.osda.rectPosition ? annotator.osda.rectPosition.height : annotation.rangePosition.height;
} else if (source === 'ovaLeftZoom') {
source = annotator.osda.viewer.drawer.viewport.getBounds().x;
} else if (source === 'ovaTopZoom') {
source = annotator.osda.viewer.drawer.viewport.getBounds().y;
} else if (source === 'ovaWidthZoom') {
source = annotator.osda.viewer.drawer.viewport.getBounds().width;
} else if (source === 'ovaHeightZoom') {
source = annotator.osda.viewer.drawer.viewport.getBounds().height;
} else if (source === 'ovaContainer') {
source = annotator.osda.viewer.id;
} else if (source === 'ovaSrc') {
var source = annotator.osda.viewer.source;
var tilesUrl = typeof source.tilesUrl !== 'undefined' ? source.tilesUrl : '';
var functionUrl = typeof source.getTileUrl !== 'undefined' ? source.getTileUrl : '';
source = tilesUrl !== '' ? tilesUrl : ('' + functionUrl).replace(/\s+/g, ' '); // - target.src (media source)
}
} else { // Text Annotation
var annotation = editor.annotation; var annotation = editor.annotation;
if(source == 'ovastartOffset') // if ranges is 0 then it is a comment
if (annotation.ranges.length > 0) {
if(source === 'ovastartOffset') {
source = annotation.ranges[0].startOffset; source = annotation.ranges[0].startOffset;
else if (source == 'ovaendOffset') } else if (source === 'ovaendOffset') {
source = annotation.ranges[0].endOffset; source = annotation.ranges[0].endOffset;
else if (source == 'ovaStart') } else if (source === 'ovaStart') {
source = annotation.ranges[0].start; source = annotation.ranges[0].start;
else if (source == 'ovaEnd') } else if (source === 'ovaEnd') {
source = annotation.ranges[0].end; source = annotation.ranges[0].end;
} }
} }
}
}
return encodeURIComponent(source); return encodeURIComponent(source);
}; };
...@@ -266,36 +319,54 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -266,36 +319,54 @@ Annotator.Plugin.Share = (function(_super) {
var src = this.getParameterByName('ovaSrc'); // Method 2 (Obligatory) var src = this.getParameterByName('ovaSrc'); // Method 2 (Obligatory)
var text = this.getParameterByName('ovaText'); // Method 2 var text = this.getParameterByName('ovaText'); // Method 2
var user = this.getParameterByName('ovaUser'); // Method 2 var user = this.getParameterByName('ovaUser'); // Method 2
var Left = this.getParameterByName('ovaLeft'); // Method 2
var Top = this.getParameterByName('ovaTop'); // Method 2
var Width = this.getParameterByName('ovaWidth'); // Method 2
var Height = this.getParameterByName('ovaHeight'); // Method 2
var leftZoom = this.getParameterByName('ovaLeftZoom'); // Method 2
var topZoom = this.getParameterByName('ovaTopZoom'); // Method 2
var widthZoom = this.getParameterByName('ovaWidthZoom'); // Method 2
var heightZoom = this.getParameterByName('ovaHeightZoom'); // Method 2
var startOffset = this.getParameterByName('ovastartOffset'); // Method 2 var startOffset = this.getParameterByName('ovastartOffset'); // Method 2
var endOffset = this.getParameterByName('ovaendOffset');// Method 2 var endOffset = this.getParameterByName('ovaendOffset'); // Method 2
// remove the variables from the url browser // remove the variables from the url browser
var stripped_url = top.location.href; var stripped_url = top.location.href;
if (ovaId != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaId'); if (ovaId !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaId');
if (start != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaStart'); if (start !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaStart');
if (end != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaEnd'); if (end !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaEnd');
if (container != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaContainer'); if (container !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaContainer');
if (src != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaSrc'); if (src !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaSrc');
if (text != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaText'); if (text !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaText');
if (user != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaUser'); if (user !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaUser');
if (startOffset != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovastartOffset'); if (Left !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaLeft');
if (endOffset != '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaendOffset'); if (Top !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaTop');
if (Width !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaWidth');
if (Height !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaHeight');
if (leftZoom !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaLeftZoom');
if (topZoom !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaTopZoom');
if (widthZoom !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaWidthZoom');
if (heightZoom !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaHeightZoom');
if (startOffset !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovastartOffset');
if (endOffset !== '') stripped_url = this.removeVariableFromURL(stripped_url, 'ovaendOffset');
window.history.pushState("object or string", "Title", stripped_url); window.history.pushState("object or string", "Title", stripped_url);
// Method 1 API with the Id of the annotation // Method 1 API with the Id of the annotation
// Example: http://danielcebrian.com/annotations/demo.html?&ovaId=wtva_SjnQb2HtqppDihKug // Example: http://danielcebrian.com/annotations/demo.html?&ovaId=wtva_SjnQb2HtqppDihKug
if (ovaId != '') { if (ovaId !== '') {
$.extend(API, {method:1, ovaId:ovaId}); $.extend(API, {method: 1, ovaId: ovaId});
} }
// Method 2 API with all the parameter to load the annotation // Method 2 API with all the parameter to load the annotation
// Example with video: http://danielcebrian.com/annotations/demo.html?ovaContainer=vid1&ovaSrc=http%3A%2F%2Fvideo-js.zencoder.com%2Foceans-clip.mp4&ovaStart=2&ovaEnd=10&ovaText=This%20is%20test&ovaUser=Test%20User // Example with video: http://danielcebrian.com/annotations/demo.html?ovaContainer=vid1&ovaSrc=http%3A%2F%2Fvideo-js.zencoder.com%2Foceans-clip.mp4&ovaStart=2&ovaEnd=10&ovaText=This%20is%20test&ovaUser=Test%20User
// Example with text: http://danielcebrian.com/annotations/demo.html?ovaStart=%2Fp%5B1%5D&ovaEnd=%2Fp%5B1%5D&ovastartOffset=542&ovaendOffset=572&ovaText=API // Example with text: http://danielcebrian.com/annotations/demo.html?ovaStart=%2Fp%5B1%5D&ovaEnd=%2Fp%5B1%5D&ovastartOffset=542&ovaendOffset=572&ovaText=API
if (start!='' && end!='' && container!='' && src!='') {// video api if (start !== '' && end !== '' && container !== '' && src !== '') { // video api
$.extend(API, {method:2, start:start, end:end, container:container, src:src, text:text, user:user}); $.extend(API, {method: 2, start: start, end: end, container: container, src: src, text: text, user: user});
} else if(start!='' && end!='' && startOffset!='' && endOffset!='') {// text api } else if (Left !== '' && Top !== '' && Width !== '' && Height !== '' && leftZoom !== '' && topZoom !== '' && widthZoom !== '' && heightZoom !== '') { // image api
$.extend(API, {method:2, start:start, end:end, startOffset:startOffset, endOffset:endOffset, text:text, user:user}); $.extend(API, {method: 2, Left: Left, Top: Top, Width: Width, Height: Height, leftZoom: leftZoom, topZoom: topZoom, widthZoom: widthZoom, heightZoom: heightZoom, container: container, src: src, text: text, user: user});
} else if (start !== '' && end !== '' && startOffset !== '' && endOffset !== '') { // text api
$.extend(API, {method: 2, start: start, end: end, startOffset: startOffset, endOffset: endOffset, text: text, user: user});
} }
return API; return API;
} }
...@@ -303,30 +374,31 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -303,30 +374,31 @@ Annotator.Plugin.Share = (function(_super) {
var wrapper = $('.annotator-wrapper').parent()[0]; var wrapper = $('.annotator-wrapper').parent()[0];
var mplayer; var mplayer;
var osda; var osda;
var self=this; var self = this;
// Set Annotator in wrapper to fix quick DOM // Set Annotator in wrapper to fix quick DOM
$.data(wrapper, 'annotator', self.annotator);// Set the object in the span $.data(wrapper, 'annotator', self.annotator);// Set the object in the span
annotator = window.annotator = $.data(wrapper, 'annotator'); annotator = window.annotator = $.data(wrapper, 'annotator');
mplayer = (typeof annotator.mplayer != 'undefined') ? annotator.mplayer : []; mplayer = (typeof annotator.mplayer !== 'undefined') ? annotator.mplayer : [];
osda = (typeof annotator.osda != 'undefined') ? annotator.osda : []; osda = (typeof annotator.osda !== 'undefined') ? annotator.osda : [];
// Detect if the URL has an API element // Detect if the URL has an API element
if (typeof API != 'undefined' && typeof API.method != 'undefined' && (API.method == '1' || API.method == '2')) { if (typeof API !== 'undefined' && typeof API.method !== 'undefined' && (parseInt(API.method, 10) === 1 || parseInt(API.method, 10) === 2)) {
if (API.method=='1'){ if (parseInt(API.method, 10) === 1) {
var allannotations = annotator.plugins['Store'].annotations; var allannotations = annotator.plugins['Store'].annotations;
var ovaId = decodeURIComponent(API.ovaId); var ovaId = parseInt(decodeURIComponent(API.ovaId), 10);
for (var item in allannotations) { for (var item in allannotations) {
var an = allannotations[item]; var an = allannotations[item];
if (typeof an.id!='undefined' && an.id == ovaId){// this is the annotation var olditem;
if (self._isVideo(an)){// It is a video if (typeof an.id !== 'undefined' && parseInt(an.id, 10) === ovaId) { // this is the annotation
if (typeof mplayer[an.target.container] != 'undefined'){ if (self._isVideo(an)) {// It is a video
if (typeof mplayer[an.target.container] !== 'undefined') {
var player = mplayer[an.target.container]; var player = mplayer[an.target.container];
if (player.id_ == an.target.container){ if (player.id_ === an.target.container) {
var anFound = an; var anFound = an;
videojs(player.id_).ready(function(){ videojs(player.id_).ready(function() {
if (player.techName != 'Youtube'){ if (player.techName !== 'Youtube') {
player.preload('auto'); player.preload('auto');
} }
player.autoPlayAPI = anFound; player.autoPlayAPI = anFound;
...@@ -334,49 +406,84 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -334,49 +406,84 @@ Annotator.Plugin.Share = (function(_super) {
}); });
} }
} }
} else if (self._isImage(an)) {// It is a OpenSeaDragon Annotation } else if (an.media === "image") { // It is a OpenSeaDragon Annotation
var bounds = new OpenSeadragon.Rect(an.bounds.x, an.bounds.y, an.bounds.width, an.bounds.height); if ($("div#" + an.target.container).length) {
setTimeout(function() { var isOpenViewer = typeof annotator.osda !== "undefined" && typeof annotator.osda.viewer !== "undefined";
osda.viewer.viewport.fitBounds(bounds, false); function waitingOsda(){
$('html, body').animate( { isOpenViewer = typeof annotator.osda !== "undefined" && typeof annotator.osda.viewer !== "undefined";
scrollTop: $("#" + an.target.container).offset().top if (typeof olditem === "undefined") {
olditem = item;
}
if (!isOpenViewer) {
setTimeout(waitingOsda, 200);
} else {
an = allannotations[olditem];
$(an.highlights).parent().find('.annotator-hl').removeClass('api');
// change the color
$(an.highlights).addClass('api');
// change zoom
if (typeof annotator !== 'undefined' && typeof annotator.osda !== 'undefined') {
var currentBounds = annotator.osda.viewer.drawer.viewport.getBounds();
var bounds = typeof an.bounds !== 'undefined' ? an.bounds : {};
if (typeof bounds.x !== 'undefined') {
currentBounds.x = bounds.x;
}
if (typeof bounds.y !== 'undefined') {
currentBounds.y = bounds.y;
}
if (typeof bounds.width !== 'undefined') {
currentBounds.width = bounds.width;
}
if (typeof bounds.height !== 'undefined') {
currentBounds.height = bounds.height;
}
annotator.osda.viewer.drawer.viewport.fitBounds(currentBounds);
}
// animate to the annotation
$('html,body').animate({
scrollTop: $(annotator.osda.viewer.element).offset().top
}, 'slow'); }, 'slow');
}, 250); }
} else {// It is a text }
var hasRanges = typeof an.ranges != 'undefined' && typeof an.ranges[0] != 'undefined'; waitingOsda();
var startOffset = hasRanges?an.ranges[0].startOffset:''; }
var endOffset = hasRanges?an.ranges[0].endOffset:''; } else { // It is a text
var hasRanges = typeof an.ranges !== 'undefined' && typeof an.ranges[0] !== 'undefined';
var startOffset = hasRanges ? an.ranges[0].startOffset : '';
var endOffset = hasRanges ? an.ranges[0].endOffset : '';
if (typeof startOffset != 'undefined' && typeof endOffset != 'undefined'){ if (typeof startOffset !== 'undefined' && typeof endOffset !== 'undefined') {
// change the color // change the color
$(an.highlights).addClass('api'); $(an.highlights).addClass('api');
// animate to the annotation // animate to the annotation
$('html, body').animate({ $('html,body').animate({
scrollTop: $(an.highlights[0]).offset().top}, 'slow'); scrollTop: $(an.highlights[0]).offset().top
}, 'slow');
} }
} }
} }
} }
} else if (API.method == '2'){ } else if (parseInt(API.method, 10) === 2) {
if (typeof mplayer != 'undefined'){ if (typeof mplayer !== 'undefined') {
// variable for Video // variable for Video
var container = decodeURIComponent(API.container); var container = decodeURIComponent(API.container);
var player = mplayer[container]; var player = mplayer[container];
var isVideo = (typeof player != 'undefined' && container == player.id_); var isVideo = (typeof player !== 'undefined' && container === player.id_);
var isNumber = (!isNaN(parseFloat(API.start)) && isFinite(API.start) && !isNaN(parseFloat(API.end)) && isFinite(API.end)); var isNumber = (!isNaN(parseFloat(API.start)) && isFinite(API.start) && !isNaN(parseFloat(API.end)) && isFinite(API.end));
var isSource = false; var isSource = false;
if (isVideo){ if (isVideo) {
// Compare without extension // Compare without extension
var src = decodeURIComponent(API.src); var src = decodeURIComponent(API.src);
var targetSrc = src.substring(0, src.lastIndexOf(".")); var targetSrc = src.substring(0, src.lastIndexOf("."));
var playerSrc = (player.tech.options_.source.src == '') ? player.tag.currentSrc : player.tech.options_.source.src; var playerSrc = (player.tech.options_.source.src === '') ? player.tag.currentSrc : player.tech.options_.source.src;
playerSrc = playerSrc.substring(0, playerSrc.lastIndexOf(".")) playerSrc = playerSrc.substring(0, playerSrc.lastIndexOf("."));
isSource = (targetSrc == playerSrc); isSource = (targetSrc === playerSrc);
} }
// Open Video Annotation // Open Video Annotation
if (isVideo && isNumber && isSource){ if (isVideo && isNumber && isSource) {
var annotation = { var annotation = {
rangeTime: { rangeTime: {
start: API.start, start: API.start,
...@@ -393,7 +500,7 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -393,7 +500,7 @@ Annotator.Plugin.Share = (function(_super) {
user: decodeURIComponent(API.user) user: decodeURIComponent(API.user)
}; };
videojs(player.id_).ready(function(){ videojs(player.id_).ready(function(){
if (player.techName != 'Youtube'){ if (player.techName !== 'Youtube'){
player.preload('auto'); player.preload('auto');
} }
player.autoPlayAPI = annotation; player.autoPlayAPI = annotation;
...@@ -406,7 +513,7 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -406,7 +513,7 @@ Annotator.Plugin.Share = (function(_super) {
var endOffset = API.endOffset; var endOffset = API.endOffset;
// Text Annotation // Text Annotation
if (!isVideo && typeof startOffset != 'undefined' && typeof endOffset != 'undefined'){ if (!isVideo && typeof startOffset !== 'undefined' && typeof endOffset !== 'undefined') {
var annotation = { var annotation = {
ranges: [{ ranges: [{
start: decodeURIComponent(API.start), start: decodeURIComponent(API.start),
...@@ -426,8 +533,79 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -426,8 +533,79 @@ Annotator.Plugin.Share = (function(_super) {
$(annotation.highlights).addClass('api'); $(annotation.highlights).addClass('api');
// animate to the annotation // animate to the annotation
$('html, body').animate({ $('html, body').animate({
scrollTop: $(annotation.highlights[0]).offset().top}, scrollTop: $(annotation.highlights[0]).offset().top
'slow'); }, 'slow');
}
// variables for images
var Left = API.Left;
var Top = API.Top;
var Width = API.Width;
var Height = API.Height;
var leftZoom = API.leftZoom;
var topZoom = API.topZoom;
var widthZoom = API.widthZoom;
var heightZoom = API.heightZoom;
// Image Annotation
if (!isVideo && typeof Left !== 'undefined' && typeof Top !== 'undefined' && typeof Width !== 'undefined' && typeof Height !== 'undefined' && typeof leftZoom !== 'undefined' && typeof topZoom !== 'undefined' && typeof widthZoom !== 'undefined' && typeof heightZoom !== 'undefined') {
var an = {
rangePosition: {
width: parseFloat(decodeURIComponent(API.Width)),
top: parseFloat(decodeURIComponent(API.Top)),
left: parseFloat(decodeURIComponent(API.Left)),
height: parseFloat(decodeURIComponent(API.Height)),
},
bounds: {
width: parseFloat(decodeURIComponent(API.widthZoom)),
x: parseFloat(decodeURIComponent(API.leftZoom)),
y: parseFloat(decodeURIComponent(API.topZoom)),
height: parseFloat(decodeURIComponent(API.heightZoom)),
},
target:{
container: API.container,
src: API.src
},
created: new Date().toISOString(),
updated: new Date().toISOString(),
media: 'image',
text: decodeURIComponent(API.text),
user: decodeURIComponent(API.user)
};
var isOpenViewer = typeof annotator.osda !== "undefined" && typeof annotator.osda.viewer !== "undefined";
function waitingOsda() {
isOpenViewer = typeof annotator.osda !== "undefined" && typeof annotator.osda.viewer !== "undefined";
if (!isOpenViewer) {
setTimeout(waitingOsda, 200);
} else {
// show the annotation
annotator.plugins['Store'].annotations.push(an);
annotator.osda.viewer.annotationInstance.drawRect(an);
// change the color
$(an.highlights).addClass('api');
// change zoom
var currentBounds = annotator.osda.viewer.drawer.viewport.getBounds();
var bounds = typeof an.bounds !== 'undefined' ? an.bounds : {};
if (typeof bounds.x !== 'undefined') {
currentBounds.x = bounds.x;
}
if (typeof bounds.y !== 'undefined') {
currentBounds.y = bounds.y;
}
if (typeof bounds.width !== 'undefined') {
currentBounds.width = bounds.width;
}
if (typeof bounds.height !== 'undefined') {
currentBounds.height = bounds.height;
}
annotator.osda.viewer.drawer.viewport.fitBounds(currentBounds);
// animate to the annotation
$('html,body').animate({
scrollTop: $(annotator.osda.viewer.element).offset().top
}, 'slow');
}
}
waitingOsda();
} }
} }
...@@ -447,25 +625,32 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -447,25 +625,32 @@ Annotator.Plugin.Share = (function(_super) {
.subscribe("annotationsLoaded", func); .subscribe("annotationsLoaded", func);
} }
Share.prototype._isVideo = function(an){ Share.prototype._isVideo = function(an) {
// Detect if the annotation is a Open Video Annotation // Detect if the annotation is a Open Video Annotation
var an = an || {}; var an = an || {};
var rt = an.rangeTime; var rt = an.rangeTime;
var isVideo = (typeof an.media != 'undefined' && an.media == 'video'); var isVideo = (typeof an.media !== 'undefined' && an.media === 'video');
var hasContainer = (typeof an.target != 'undefined' && typeof an.target.container != 'undefined' ); var hasContainer = (typeof an.target !== 'undefined' && typeof an.target.container !== 'undefined' );
var isNumber = (typeof rt != 'undefined' && !isNaN(parseFloat(rt.start)) && isFinite(rt.start) && !isNaN(parseFloat(rt.end)) && isFinite(rt.end)); var isNumber = (typeof rt !== 'undefined' && !isNaN(parseFloat(rt.start)) && isFinite(rt.start) && !isNaN(parseFloat(rt.end)) && isFinite(rt.end));
return (isVideo && hasContainer && isNumber); return (isVideo && hasContainer && isNumber);
} }
Share.prototype._isImage = function(annotation) { Share.prototype._isImage = function(annotation) {
return annotation.media === 'image'; var wrapper = $('.annotator-wrapper').parent()[0];
var annotator = window.annotator = $.data(wrapper, 'annotator');
var rp = an.rangePosition;
var isOpenSeaDragon = (typeof annotator.osda !== 'undefined');
var isContainer = (typeof an.target !== 'undefined' && typeof an.target.container !== 'undefined');
var isImage = (typeof an.media !== 'undefined' && an.media === 'image');
var isRP = (typeof rp !== 'undefined');
return (isOpenSeaDragon && isContainer && isImage && isRP);
} }
Share.prototype.getParameterByName = function(name) { Share.prototype.getParameterByName = function(name) {
name = name.replace(/[\[]/, "\\\[").replace(/[\]]/, "\\\]"); name = name.replace(/[\[]/, "\\\[").replace(/[\]]/, "\\\]");
var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"); var regex = new RegExp("[\\?&]" + name + "=([^&#]*)");
var results = regex.exec('?' + window.location.href.split('?')[1]); var results = regex.exec('?' + window.location.href.split('?')[1]);
return results == null ? "" : decodeURIComponent(results[1].replace(/\ + /g, " ")); return results === null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
}; };
Share.prototype.removeVariableFromURL = function(url_string, variable_name) { Share.prototype.removeVariableFromURL = function(url_string, variable_name) {
...@@ -479,28 +664,21 @@ Annotator.Plugin.Share = (function(_super) { ...@@ -479,28 +664,21 @@ Annotator.Plugin.Share = (function(_super) {
return URL; return URL;
} }
Share.prototype.getAnnotationFromId = function(ovaId) {
var annotationList = this.annotator.plugins.Store.annotations;
return $.grep(annotationList, function(elementOfArray, indexInArray){
return parseInt(elementOfArray.id, 10) === parseInt(ovaId.nodeValue, 10);
})[0];
}
Share.prototype.updateViewer = function(field, annotation) { Share.prototype.updateViewer = function(field, annotation) {
this.annotation = annotation; this.annotation = annotation;
var self = this; var self = this;
var field = $(field); var field = $(field);
var ret = field.addClass('share-viewer-annotator').html(function() { var ret = field.addClass('share-viewer-annotator').html(function() {
var string;
return self.buildHTMLShareButton('Share:', self.getSource('ovaId')); return self.buildHTMLShareButton('Share:', self.getSource('ovaId'));
}); });
// Create the actions for the buttons // Create the actions for the buttons
this.buttonsActions(field[0], 1, this.options.baseUrl, annotation); // 1 is the method of the API that will be for share some annotation in the database this.buttonsActions(field[0], 1, this.options.baseUrl); // 1 is the method of the API that will be for share some annotation in the database
return ret; return ret;
}; };
return Share; return Share;
})(Annotator.Plugin); })(Annotator.Plugin);
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment