Changes for Wordpress Annatator plugin to support new authorization API

README.md

@@ -1,3 +1,5 @@
+# Docs update in progress ...
+
 # Annotator plugin for Wordpress
 
 Adds inline annotations to Wordpress using the amazing 
@@ -14,16 +16,15 @@ Adds inline annotations to Wordpress using the amazing
 
 ## Requirements
 
-PHP >= 5.\*.\*
+PHP >= 5.3.\*
 
 ## Install
 
 Just `git clone` this project into the `wp-content/plugins/` directory, then
 activate the plugin through the Wordpress administration panel accessible at `http://<blogaddress>/wp-admin/plugins.php`.
 
 You will also need to sign up at [AnnotateIt](http://annotateti.org) and 
-fill your _Account ID_ and _Auth Token_ details in the Plugin settings
-form.
+fill your _key_ and _secret_ details in the Plugin settings form.
 
 
 ## Demo

lib/okfn-annot-factory.php

@@ -1,55 +1,39 @@
 <?php
 
-/*
+/**
  * Dynamically generates the JavaScript code snippet needed for instantiating
  * the Annotator.
- *
- *
  */
 
+use \Firebase\JWT\JWT;
+
 class OkfnAnnotFactory extends OkfnBase {
   private $uri; //current wordpress page
-  private $annotator_content;
   private $template_vars;
   private $settings;
 
-  /*
+  /**
    * Public:
-   *
    * Class constructor
-   *
    * settings - an instance of OkfnAnnotSettings.
-   *
    */
-
   function __construct($settings) {
     $this->settings = $settings;
-    $this->annotator_content = $settings->get_option('annotator_content');
-
-    //todo: add load from search
-    $this->uri = $this->get_current_uri();
   }
 
 
-  /*
-   *
+  /**
    * Fetches the URI of the currently visited blog page
-   *
    * returns a uri string
-   *
    */
 
   private function get_current_uri(){
     return OkfnUtils::current_url();
   }
 
-  /*
+  /**
    * Wrapper method calling the Mustache template engine.
-   *
    * (Needed mostly for testing and mocking...)
-   *
-   *
-   *
    */
 
   function render_template($template_vars, $template='annotator-instance.js') {
@@ -60,15 +44,35 @@ function render_template($template_vars, $template='annotator-instance.js') {
 
 
   private function prepare_variables(){
-    $template_vars = array(
-      'annotator_content' => $this->annotator_content,
-      'uri' => $this->uri,
+    $template_vars = $this->settings->get_options_values();
+
+    $CONSUMER_TTL = 86400;
+
+    $secret = $template_vars["annotateit_secret"];
+    $objDateTime = new DateTime('NOW');
+    $issuedAt = $objDateTime->format(DateTime::ISO8601)."Z";
+
+    $user = true ? "" : wp_get_current_user()->user_login; //client 1.2 seems to be buggy, waiting for v2
+
+    $token = array(
+      'consumerKey'=> $template_vars["annotateit_key"],
+      'userId'=> $user,
+      'issuedAt'=> $issuedAt,
+      'ttl' => $CONSUMER_TTL
     );
 
+    $template_vars["token"] = JWT::encode($token, $secret);
+    $template_vars["user"] = $user;
+
+        //todo: add load from search
+    $template_vars['uri'] = $this->get_current_uri();
+
+    $template_vars['annotateit_secret'] = ""; //should never be published
+
     return $template_vars;
   }
 
-  /*
+  /**
    * Generates a code snippet containing a customised Javascript instantiation
    * code for the Annotator.
    *
@@ -79,4 +83,4 @@ function create_snippet() {
     return $this->render_template($this->prepare_variables());
   }
 }
-?>
+?>

lib/okfn-annot-injector.php

@@ -16,12 +16,14 @@ class OkfnAnnotInjector extends OkfnBase {
     // of the annotator (A more fine grained control through the settings can be implemented later).
 
     'javascripts' => array(
-      array(
+/*     todo deniso import jquery properly
+ *       array(
         'file' => 'javascripts/jquery.min.js'
       ),
+*/
       array(
         'file' => 'javascripts/annotator/annotator-full.min.js',
-        'dependencies' => array('json2','jquery'),
+        'dependencies' => array('json2',/*'jquery'*/),
       ),
     ),
 
@@ -50,7 +52,10 @@ function __construct($factory,$content_policy){
   function load_javascript_dependencies(){
     wp_enqueue_script('json2');
     //deregister the javascript version used by wordpress
-    wp_deregister_script('jquery');
+/*
+ *     todo deniso import jquery properly
+ *     wp_deregister_script('jquery');
+*/
   }
 
   /*

lib/okfn-annot-settings.php

@@ -16,6 +16,9 @@ class OkfnAnnotSettings extends OkfnBase {
     'default_options' => array(
       'annotator_content' => '.entry-content',
       'url_pattern' => '.*',
+      'annotateit_key' => '',
+      'annotateit_secret' => '',
+      'logged_in-only' => 'on',
     )
   );
 
@@ -93,17 +96,33 @@ function process_settings_form($params){
     $this->render_settings_form($is_submit=true);
   }
 
- /*
-  *
+ /**
+  * Returns values for current plugin options - stored or default
+  * is_prefix - boolean flag indicating add prefix before nme or not
+  * returns array with name-value options
+  */
+ function get_options_values() {
+   $prefix = $this->conf->forminput_prefix;
+   $options = array();
+
+   foreach($this->conf->default_options as $optname => $value) {
+     $stored_value = get_option("{$prefix}-{$optname}");
+     $options[$optname] = empty($stored_value) ? $value : $stored_value ;
+   }
+
+   //unescape backslashes automatically added by php for string sanitation
+   $options['url_pattern'] = stripslashes($options['url_pattern']);
+
+   $options['logged_in-only'] = $options['logged_in-only'] == 'on' ? 'on' : '';
+
+   return $options;
+ }
+
+ /**
   * Renders the HTML for the Annotator settings options page.
-  *
   * is_submit - boolean flag indicating whether data has been submitted
-  *
-  *
   * returns a rendered form template
-  *
   */
-
  function render_settings_form($is_submit=false) {
 
    $prefix = $this->conf->forminput_prefix;
@@ -116,28 +135,17 @@ function render_settings_form($is_submit=false) {
      'form_submitted' => $is_submit,
    );
 
-   foreach($this->conf->default_options as $optname => $value) {
-     $stored_value = get_option("{$prefix}-{$optname}");
-     $options[$optname] = empty($stored_value) ? $value : $stored_value ;
-   }
-
-   //unescape backslashes automatically added by php for string sanitation
-   $options['url_pattern'] = stripslashes($options['url_pattern']);
+   $options = array_merge($options, $this->get_options_values());
 
    $mustache = new Mustache;
    $template = OkfnUtils::get_template('settings.html');
    print $mustache->render($template, $options);
  }
 
- /*
+ /**
   * Public:
-  *
   * Logical switch determining whether to render or to process the setting form.
-  *
-  *
   * params - the request parameters (defaults to $_POST if not provided).
-  *
-  *
   * returns nothing
   */
 

okfn-annotator.php

@@ -20,25 +20,36 @@
 License: GPLv2 or later
 */
 
-
-foreach(array(
-  'lib/wp-pluggable',
-  'vendor/Mustache',
-  'lib/okfn-utils',
-  'lib/okfn-base',
-  'lib/okfn-annot-settings',
-  'lib/okfn-annot-content-policy',
-  'lib/okfn-annot-injector',
-  'lib/okfn-annot-factory',
-) as $lib) require_once("${lib}.php");
+foreach (array(
+             'lib/wp-pluggable',
+             'vendor/Mustache',
+             'vendor/php-jwt/src/JWT',
+             'lib/okfn-utils',
+             'lib/okfn-base',
+             'lib/okfn-annot-settings',
+             'lib/okfn-annot-content-policy',
+             'lib/okfn-annot-injector',
+             'lib/okfn-annot-factory',
+         ) as $lib) require_once("${lib}.php");
 
 $settings = new OkfnAnnotSettings;
 
+//todo make configurable
+$factory = new OkfnAnnotFactory($settings);
+$content_policy = new OkfnAnnotContentPolicy($settings);
+
+$init_factory = function () use ($factory, $content_policy, $settings){
+    $options_values = $settings->get_options_values();
+    $logged_in_only = $options_values["logged_in-only"] == "on";
+
+    if (!$logged_in_only || is_user_logged_in()) {
+        $injector = new OkfnAnnotInjector($factory, $content_policy);
+        $injector->inject();
+    }
+};
+
+//todo deniso make is_user_logged_in configurable
 if (!is_admin()) {
-  $factory  = new OkfnAnnotFactory($settings);
-  $content_policy  = new OkfnAnnotContentPolicy($settings);
-  $injector = new OkfnAnnotInjector($factory, $content_policy);
-  $injector->inject();
+    add_action('init', $init_factory);
 }
-
 ?>

readme.txt

@@ -1,8 +1,8 @@
 === Annotator ===
-Contributors: a-fiore
+Contributors: a-fiore, denis.obydennykh
 Tags: annotation, okf, annotate.it
 Requires at least: 3.2.0
-Tested up to: 3.2.0
+Tested up to: 4.3.1
 Stable tag: 0.4
 
 Adds inline annotations to Wordpress using the Open Knowledge

templates/annotator-instance.js

@@ -1,16 +1,25 @@
 jQuery(function ($) {
-  var element= $('{{annotator_content}}');
-
-  if (element) {
-    element.annotator()
-           .annotator('setupPlugins', null, {
-             Store: {
-               annotationData: {uri: '{{uri}}'},
-               loadFromSearch: {uri: '{{uri}}', limit: 200}
-             }
-           });
-  } else {
-    throw new Error("OkfnAnnotator: Unable to find a DOM element for selector '{{annotator_content}}'; cannot instantiate the Annotator");
-  }
+    var element = $('{{annotator_content}}');
+
+    if (element) {
+        var annotatorInstance = element.annotator();
+        annotatorInstance
+            .annotator('setupPlugins', null, {
+                Store: {
+                    annotationData: {uri: '{{uri}}'},
+                    loadFromSearch: {uri: '{{uri}}', limit: 200}
+                }
+                , Auth: {
+                    token: '{{token}}'
+                }
+/*
+                , Permissions: {
+                    user: '{{user}}'
+                }
+*/
+            })
+    } else {
+        throw new Error("OkfnAnnotator: Unable to find a DOM element for selector '{{annotator_content}}'; cannot instantiate the Annotator");
+    }
 
 });