# HG changeset patch
# User robcast
# Date 1351791491 -3600
# Node ID 7affda55c10e988dda08cf51fe1f4a0f2b351677
# Parent  121d3aadfa1e6216d190e1c584a293a90b62d160
using annotator in digilib works somewhat now.

diff -r 121d3aadfa1e -r 7affda55c10e webapp/src/main/webapp/jquery/jquery.digilib.annotator.js
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.annotator.js	Thu Nov 01 18:38:11 2012 +0100
@@ -0,0 +1,506 @@
+/**
+ digilib plugin for annotations.
+
+ currently only point-like annotations (like marks).
+ 
+ Annotations are stored on a Annotator http://annotateit.org compatible server.
+
+ */
+
+(function($) {
+
+    // affine geometry
+    var geom;
+    // plugin object with digilib data
+    var digilib;
+    // our Annotator instance
+    var annotator;
+
+    var FULL_AREA;
+
+    var buttons = {
+        annotations : {
+            onclick : "toggleAnnotations",
+            tooltip : "show or hide annotations",
+            icon : "annotations.png"
+        },
+        annotationuser : {
+            onclick : "setAnnotationUser",
+            tooltip : "set user account for annotations",
+            icon : "annotation-user.png"
+        },
+        annotationmark : {
+            onclick : "setAnnotationMark",
+            tooltip : "create an annotation for a point",
+            icon : "annotation-mark.png"
+        }
+    };
+
+    var defaults = {
+        'annotatorInstance' : null,
+        // are annotations active?
+        'isAnnotationsVisible' : true,
+        // buttonset of this plugin
+        'annotationSet' : ['annotations', 'annotationuser', 'annotationmark', 'lessoptions'],
+        // URL of annotation server
+        'annotationServerUrl' : 'http://virtuoso.mpiwg-berlin.mpg.de:8080/AnnotationManager/annotator',
+        // URL of authentication token server
+        'annotationTokenUrl' : 'http://localhost:8080/test/annotator/token',
+        // annotation user name
+        'annotationUser' : 'anonymous',
+        // function to translate user name from annotation server format 
+        'annotationServerUserString' : function() {
+            if (this.user && this.user.name) {
+                return this.user.name;
+            }
+            return this.user;
+        },
+
+    };
+
+    var actions = {
+        /**
+         * show/hide annotations
+         */
+        toggleAnnotations : function (data) {
+            var show = !data.settings.isAnnotationsVisible;
+            data.settings.isAnnotationsVisible = show;
+            digilib.fn.highlightButtons(data, 'annotations', show);
+            renderAnnotations(data);
+        },
+        
+        /**
+         * set user account for annotations
+         */
+        setAnnotationUser : function (data, user, password) {
+            var settings = data.settings;
+            if (user == null) {
+                // user name entered in JS-prompt
+                user = window.prompt("User name:", settings.annotationUser);
+                if (user != null) {
+                    // password entered in JS-prompt
+                    password = window.prompt("Password:", '');
+                    settings.annotationUser = user;
+                    data.dlOpts.annotationUser = user;
+                    digilib.fn.storeOptions(data);
+                    loadAnnotationToken(data, password);
+                }
+            } else {
+                settings.annotationUser = user;
+                data.dlOpts.annotationUser = user;
+                digilib.fn.storeOptions(data);
+                loadAnnotationToken(data, password);
+            }
+        },
+
+        /**
+         * set a mark-annotation by clicking (or giving a position and a text)
+         *
+         * @param data
+         * @param mpos
+         * @param text
+         */
+        setAnnotationMark : function (data, mpos, text) {
+            if (mpos == null) {
+                // interactive
+                setAnnotationMark(data);
+            } else {
+                // use position and text (and user-id)
+                var annotation = newAnnotation(data, mpos, text, null, null, data.settings.annotationUser);
+                storeAnnotation(data, annotation);
+                // TODO: replace with annotation returned by server
+                data.annotations.push(annotation);
+                digilib.fn.redisplay(data);
+            }
+        },
+    };
+
+    /**
+     * create a new annotation object
+     */
+    var newAnnotation = function (data, mpos, text, id, uri, user, permissions, tags) {
+        var annot = {
+            pos : mpos,
+            text : text,
+            id : id,
+            uri : uri,
+            user : user,
+            permissions : permissions,
+            tags : tags
+        };
+        // TODO: use prototype?
+        annot.getUserName = data.settings.annotationServerUserString;
+        return annot;
+    };
+
+    /**
+     * returns an annotatable url to this digilib image
+     */
+    var getAnnotationPageUrl = function(data) {
+        var url = data.settings.digilibBaseUrl + '/jquery/digilib.html?';
+        url += digilib.fn.getParamString(data.settings, ['fn', 'pn'], digilib.defaults);
+        return url;
+    };
+    
+    /**
+     * add a mark-annotation where clicked.
+     */
+    var setAnnotationMark = function(data) {
+        var $scaler = data.$scaler;
+        annotator = data.settings.annotatorInstance;
+        // unbind other handler TODO: do we need to do this?
+        $scaler.off(".dlZoomDrag");
+        // start event capturing
+        $scaler.one('mousedown.dlSetAnnotationMark', function(evt) {
+            // event handler adding a new mark
+            console.log("setAnnotationMark at=", evt);
+            var mpos = geom.position(evt);
+            var pos = data.imgTrafo.invtransform(mpos);
+            
+            console.debug("showing annotator editor!");
+            var annotation = annotator.createAnnotation();
+            annotation.areas = [geom.rectangle(pos)];
+            annotator.showEditor(annotation, mpos.getAsCss());
+
+            return false;            
+            // Annotation text entered in JS-prompt
+            var text = window.prompt("Annotation text:");
+            if (text == null) return false;
+            var annotation = newAnnotation(data, pos, text, null, null, data.settings.annotationUser);
+            storeAnnotation(data, annotation);
+            data.annotations.push(annotation);
+            digilib.fn.redisplay(data);
+            return false;
+        });
+    };
+
+    /**
+     * place annotations on the image
+     */
+    var renderAnnotations = function(data) {
+        console.debug("renderAnnotations: annotator=", annotator);
+        if (annotator == null || data.$img == null || data.imgTrafo == null)
+            return;
+		var annotations = annotator.plugins['Store'].annotations;
+        var cssPrefix = data.settings.cssPrefix;
+        var $elem = data.$elem;
+        // try to show annotation user state
+        $elem.find('div#'+cssPrefix+'button-annotationuser').attr('title', 'annotation user: '+data.settings.annotationUser);
+        // clear annotations
+        $elem.find('div.' + cssPrefix + 'annotationmark').remove();
+        if (!data.settings.isAnnotationsVisible) return;
+        for (var i = 0; i < annotations.length; i++) {
+            var annotation = annotations[i];
+            renderAnnotation(data, annotation);
+        }
+    };
+
+    /**
+     * place annotation on the image
+     */
+    var renderAnnotation = function(data, annotation) {
+        console.debug("renderAnnotation: annotation=", annotation);
+        if (annotation == null || data.$img == null || data.imgTrafo == null)
+            return;
+        var cssPrefix = data.settings.cssPrefix;
+        var $elem = data.$elem;
+        // try to show annotation user state
+        $elem.find('div#'+cssPrefix+'button-annotationuser').attr('title', 'annotation user: '+data.settings.annotationUser);
+        if (!data.settings.isAnnotationsVisible) return;
+        var pos = geom.position(annotation.areas[0]);
+        if (data.zoomArea.containsPosition(pos)) {
+            var mpos = data.imgTrafo.transform(pos);
+            console.debug("renderannotations: pos=", mpos);
+            // create annotation
+            var html = '<div class="' + cssPrefix + 'annotationmark ' + cssPrefix + 'overlay">?</div>';
+            // set text as tooltip
+            var $annotation = $(html);
+            $annotation.attr('title', "Annotation: " + annotation.text);
+            $elem.append($annotation);
+            mpos.adjustDiv($annotation);
+        }
+    };
+
+    /**
+     * Get an authentication token from the token server.
+     * 
+     * Stores the token and loads annotations on success.
+     */
+    var loadAnnotationToken = function(data, password) {
+        var settings = data.settings;
+        var url = settings.annotationTokenUrl;
+        var params = {'user': settings.annotationUser};
+        if (password != null) {
+            params.password = password;
+        }
+        // TODO: better error handling
+        $.post(url, params)
+            .done(function (authToken, authStatus) {
+                console.debug("got auth token data=", authToken);
+                data.annotationToken = authToken;
+                data.dlOpts.annotationToken = authToken;
+                digilib.fn.storeOptions(data);
+                //loadAnnotations(data);
+            })
+            .fail(function (xhr, status) {
+                console.error("got auth token error:", xhr);
+                data.annotationToken = null;
+                data.settings.annotationUser = "anonymous";
+                //loadAnnotations(data);
+            });
+    };
+
+    /**
+     * loads all annotations for this url from the annotation server.
+     */
+    var loadAnnotations = function(data) {
+        var settings = data.settings;
+        // we use the search API
+        var url = settings.annotationServerUrl + '/search';
+        var pageUrl = getAnnotationPageUrl(data);
+        // send authentication token in header
+        headers = {};
+        if (data.annotationToken != null) {
+            headers['x-annotator-auth-token'] = data.annotationToken;
+        }
+        // get only 20 annotations with this url
+        var query = {
+            limit : 20,
+            uri : pageUrl
+        };
+        $.ajax(url, {
+            dataType : 'json',
+            data : query,
+            headers : headers,
+            success : function(annotData, annotStatus) {
+                console.debug("got annotation data=", annotData);
+                data.annotationData = annotData;
+                parseAnnotations(data, annotData);
+                renderAnnotations(data);
+            }
+        });
+    };
+
+    /**
+     * parse all JSON-annotations in annotationData.rows and put in data.annotations
+     */
+    var parseAnnotations = function(data, annotationData) {
+        var annotations = [];
+        for (var i = 0; i < annotationData.rows.length; ++i) {
+            var ann = annotationData.rows[i];
+            var annot = parseAnnotation(data, ann);
+            if (annot != null) {
+                annotations.push(annot);
+            }
+        }
+        data.annotations = annotations;
+    };
+
+    /**
+     * Parse a JSON-annotation.
+     * 
+     * Returns an annotation object.
+     */
+    var parseAnnotation = function(data, ann) {
+        // TODO: check validity of annotation data
+        if (ann.areas != null && ann.areas.length > 0) {
+            var area = ann.areas[0];
+            // currently only point annotations
+            var pos = geom.position(area.x, area.y);
+            return newAnnotation(data, pos, ann.text, ann.id, ann.uri, ann.user, ann.permissions, ann.tags);
+        }
+        return null;
+    };
+
+    /**
+     * Store an annotation on the annotation server.
+     */
+    var storeAnnotation = function(data, annotation) {
+        console.debug("storeAnnotation:", annotation);
+        var settings = data.settings;
+        var url = settings.annotationServerUrl + '/annotations';
+        var pageUrl = getAnnotationPageUrl(data);
+        // send authentication token in header
+        headers = {
+            'x-annotator-auth-token' : data.annotationToken
+        };
+        // create annotation object to send
+        var annotData = {
+            areas : [{
+                x : annotation.pos.x,
+                y : annotation.pos.y
+            }],
+            text : annotation.text,
+            uri : pageUrl,
+            user : settings.annotationUser
+        };
+        var dataString = JSON.stringify(annotData);
+        $.ajax(url, {
+            type : 'POST',
+            dataType : 'json',
+            contentType : 'application/json',
+            data : dataString,
+            headers : headers,
+            success : function(annotData, annotStatus) {
+                console.debug("sent annotation data, got=", annotData, " status=" + annotStatus);
+                var annot = parseAnnotation(data, annotData);
+                // TODO: we have to add the returned data to the real annotation!
+                //renderAnnotations(data);
+            }
+        });
+
+    };
+    
+    /** 
+     * install additional buttons 
+     */
+    var installButtons = function(data) {
+        var settings = data.settings;
+        var mode = settings.interactionMode;
+        var buttonSettings = settings.buttonSettings[mode];
+        // configure buttons through digilib "annotationSet" option
+        var buttonSet = settings.annotationSet || annotationSet;
+        // set annotationSet to [] or '' for no buttons (when showing annotations only)
+        if (buttonSet.length && buttonSet.length > 0) {
+            buttonSettings.annotationSet = buttonSet;
+            buttonSettings.buttonSets.push('annotationSet');
+        }
+    };
+
+    /** 
+     * plugin installation. called by digilib on plugin object. 
+     */
+    var install = function(plugin) {
+        digilib = plugin;
+        console.debug('installing annotations plugin. digilib:', digilib);
+        // import geometry classes
+        geom = digilib.fn.geometry;
+        FULL_AREA = geom.rectangle(0, 0, 1, 1);
+        // add defaults, actins, buttons
+        $.extend(digilib.defaults, defaults);
+        $.extend(digilib.actions, actions);
+        $.extend(digilib.buttons, buttons);
+    };
+
+    /** plugin initialization */
+    var init = function(data) {
+        console.debug('initialising annotations plugin. data:', data);
+        var $data = $(data);
+        // set up
+        data.annotations = [];
+        if (digilib.plugins.buttons != null) {
+            installButtons(data);
+        }
+        if (data.dlOpts.annotationUser != null) {
+            // get annotation user from cookie
+            data.settings.annotationUser = data.dlOpts.annotationUser;
+        }
+        if (data.dlOpts.annotationToken != null) {
+            // get annotation token from cookie
+            data.annotationToken = data.dlOpts.annotationToken;
+        }
+        // install event handler
+        $data.bind('setup', handleSetup);
+        $data.bind('update', handleUpdate);
+    };
+
+    /**
+     * setup loads all annotations.
+     */
+    var handleSetup = function(evt) {
+        console.debug("annotations: handleSetup");
+        var data = this;
+        if (data.annotationToken ==  null) {
+            loadAnnotationToken(data);        
+        }
+        // set up annotator (after html has been set up)
+        var uri = getAnnotationPageUrl(data);
+        annotator = new Annotator(data.$elem.get(0))
+                  //.addPlugin('Tags')
+                  .addPlugin('Auth', {
+                  	token : data.annotationToken,
+                    //tokenUrl: 'http://annotateit.org/api/token'
+                    //tokenUrl: 'http://localhost:8080/test/annotator/token?user=anonymous'
+                    //autoFetch: false
+                  })
+                  .addPlugin('Permissions', {
+                    user: data.settings.annotationUser,
+                    userString: function (user) {
+                      if (user && user.name) {
+                        return user.name;
+                      }
+                      return user;
+                    },
+                    userId: function (user) {
+                      if (user && user.id) {
+                        return user.id;
+                      }
+                      return user;
+                    }
+                  })
+                  .addPlugin('Store', {
+                  	prefix : data.settings.annotationServerUrl,
+                    //prefix: 'http://localhost:18080/AnnotationManager/annotator',
+                    //prefix: 'http://tuxserve03.mpiwg-berlin.mpg.de/AnnotationManager/annotator',
+                    //prefix: 'http://annotateit.org/api',
+                    annotationData: {
+                      'uri': uri
+                    },
+                    loadFromSearch: {
+                      'limit': 20,
+                      'uri': uri
+                    }
+                  })
+                  ;
+
+		// monkey-patch Annotator.setupAnnotation
+		annotator.setupAnnotation = function(annotation, fireEvents) {
+		    if (fireEvents == null) {
+		      fireEvents = true;
+		    }
+		    
+		    renderAnnotation(data, annotation);
+		    
+		    if (fireEvents) {
+		      this.publish('annotationCreated', [annotation]);
+		    }
+		    return annotation;
+		};
+
+
+        data.settings.annotatorInstance = annotator;
+        /* load annotations from server
+        if (data.annotationToken !=  null) {
+            loadAnnotations(data);
+        } else {
+            loadAnnotationToken(data);        
+        } */
+    };
+
+    /**
+     * update renders all annotations.
+     */
+    var handleUpdate = function(evt) {
+        console.debug("annotations: handleUpdate");
+        var data = this;
+        renderAnnotations(data);
+    };
+
+    // plugin object with name and init
+    // shared objects filled by digilib on registration
+    var plugin = {
+        name : 'annotations',
+        install : install,
+        init : init,
+        buttons : {},
+        actions : {},
+        fn : {},
+        plugins : {}
+    };
+
+    if ($.fn.digilib == null) {
+        $.error("jquery.digilib.annotations must be loaded after jquery.digilib!");
+    } else {
+        $.fn.digilib('plugin', plugin);
+    }
+})(jQuery);
diff -r 121d3aadfa1e -r 7affda55c10e webapp/src/main/webapp/jquery/jquery.digilib.geometry.js
--- a/webapp/src/main/webapp/jquery/jquery.digilib.geometry.js	Tue Oct 30 20:23:24 2012 +0100
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.geometry.js	Thu Nov 01 18:38:11 2012 +0100
@@ -126,6 +126,13 @@
             var dy = pos.y - this.y;
             return Math.sqrt(dx * dx + dy * dy);
         };
+        // returns position in css-compatible format
+        that.getAsCss = function() {
+            return {
+                left : this.x,
+                top : this.y,
+            };
+        };
         that.toString = function() {
             return (this.x + "," + this.y);
         };