Finished first production-ready release.

marxarelli · marxarelli · commit a5e8c9fc0b2a · 2011-09-24T20:40:53.000-07:00
Added dependency checking upon activation.

Implemented language filter and fixed problems with WPML modifying post
queries by default.

Added support for tags and translation of categories and tags.

Finished first complete draft of the readme.
diff --git a/lib/wpml_json_api.php b/lib/wpml_json_api.php
@@ -4,6 +4,8 @@
 require_once WPML_JSON_API_PATH.'/models/translation.php';
 
 class WPML_JSON_API {
+  protected $plugin_path;
+
   /**
    * @var JSON_API
    */
@@ -14,12 +16,33 @@ class WPML_JSON_API {
    */
   private $_sp;
 
+  /**
+   * Constructs a new api for the specified plugin.
+   */
+  function __construct($plugin_path) {
+    if (strpos($plugin_path, WP_PLUGIN_DIR) === 0) {
+      $this->plugin_path = ltrim(substr($plugin_path, strlen(WP_PLUGIN_DIR)), DIRECTORY_SEPARATOR);
+    }
+    else {
+      $this->plugin_path = $plugin_path;
+    }
+  }
+
   /**
    * Registers all filters and actions.
    */
   function register() {
-    add_filter('json_api_encode', array($this, 'dispatch_translate_resource_filter'));
+    // Trick WPML by hardcoding the 'lang' GET parameter. Otherwise, it will 
+    // rewrite post queries to only return those in the default language. This 
+    // would interfere with the retrieval of explicitly requested JSON-API 
+    // objects.
+    $_GET['lang'] = 'all';
+
     add_filter('json_api_encode', array($this, 'dispatch_add_translations_filter'));
+    add_filter('json_api_encode', array($this, 'dispatch_filter_for_language_filter'));
+    add_filter('json_api_encode', array($this, 'dispatch_translate_resource_filter'));
+
+    add_action('activate_'.$this->plugin_path, array($this, 'ensure_plugin_dependencies'));
   }
 
   /**
@@ -34,15 +57,17 @@ function dispatch_filter($filter, $arguments) {
       $error = null;
 
       // Resolve the object to filter and filter it.
-      foreach ($response as $type => $value) {
-        if (is_object($value)) {
-          $resources = array($value);
+      foreach (array_keys($response) as $type) {
+        if (is_object($response[$type])) {
+          $resources = array($response[$type]);
           $error = $this->$filter($type, $resources);
           break;
         }
-        elseif (is_array($value) && is_object($value[0])) {
-          $error = $this->$filter($type, $value);
-          break;
+        elseif (is_array($response[$type]) && isset($response[$type][0])) {
+          if (is_object($response[$type][0])) {
+            $error = $this->$filter($type, $response[$type]);
+            break;
+          }
         }
       }
 
@@ -53,6 +78,28 @@ function dispatch_filter($filter, $arguments) {
     return $response;
   }
 
+  /**
+   * Ensures that the plugin dependencies are fulfilled. If the WPML plugin is 
+   * enabled network wide than this plugin must be as well.
+   */
+  function ensure_plugin_dependencies($network_wide) {
+    if (!is_plugin_active('json-api/json-api.php')) {
+      trigger_error('This plugin requires JSON-API!', E_USER_ERROR);
+    }
+
+    if (!is_plugin_active('sitepress-multilingual-cms/sitepress.php')) {
+      trigger_error('This plugin requires WPML Multilingual CMS!', E_USER_ERROR);
+    }
+    elseif (!$network_wide) {
+      $plugins = get_site_option('active_sitewide_plugins', array(), false);
+      if (is_plugin_active_for_network('sitepress-multilingual-cms/sitepress.php')) {
+        trigger_error(
+          'WPML Multilingual CMS is enabled network wide. '.
+          'You must enable this plugin network wide as well.', E_USER_ERROR);
+      }
+    }
+  }
+
   /**
    * Returns the requested query parameter value.
    *
@@ -86,6 +133,37 @@ function language_is_supported($language_code) {
     return false;
   }
 
+  /**
+   * Filters the response resources to only include those for the specified 
+   * language.
+   */
+  function filter_for_language($type, &$resources) {
+    $numeric_keys = false;
+    $modified = false;
+
+    foreach (array_keys($resources) as $k) {
+      $numeric_keys = is_numeric($k);
+
+      if (($language = $this->json->query->language) && isset($resources[$k]->language)) {
+        if ($this->language_is_supported($language)) {
+          if ($language != 'all' && $language != $resources[$k]->language) {
+            unset($resources[$k]);
+            $modified = true;
+          }
+        }
+        else {
+          return array('status' => 'error', 'error' => 'Language not supported.');
+        }
+      }
+    }
+
+    // If array has numeric keys and we deleted something, we have to reset 
+    // the key order so it will be properly JSON encoded as an array.
+    if ($modified && $numeric_keys) {
+      $resources = array_values($resources);
+    }
+  }
+
   /**
    * Augments the response resource with the languages and translations.
    */
@@ -112,11 +190,11 @@ function add_translations($type, &$resources) {
    * available.
    */
   function translate_resource($type, &$resources) {
-    if ($to_lang = $this->get_param('to_lang')) {
-      if ($this->language_is_supported($to_lang)) {
+    if ($to_language = $this->json->query->to_language) {
+      if ($this->language_is_supported($to_language)) {
         foreach ($resources as $resource) {
           if ($wpml_resource = WPML_JSON_API_Resource::create($type, $resource)) {
-            $wpml_resource->translate_resource($resource, $to_lang);
+            $wpml_resource->translate_resource($resource, $to_language);
           }
           else {
             return array('status' => 'error', 'error' => "Type `$type' is not translatable.");
@@ -159,4 +237,8 @@ function __call($method, $arguments) {
       return $this->dispatch_filter($m[1], $arguments);
     }
   }
+
+  private function find_plugin_in($plugins, $names) {
+    return array_search(implode(DIRECTORY_SEPARATOR, (array) $names), array_keys($plugins));
+  }
 }
diff --git a/models/category.php b/models/category.php
@@ -3,6 +3,11 @@
 require_once WPML_JSON_API_PATH.'/models/resource.php';
 
 class WPML_JSON_API_Category extends WPML_JSON_API_Resource {
+  public $translatable_properties = array(
+    'slug',
+    'title',
+    'description',
+  );
   protected $type = 'category';
   protected $wpml_type = 'tax_category';
 }
diff --git a/models/tag.php b/models/tag.php
@@ -0,0 +1,8 @@
+<?php
+
+require_once WPML_JSON_API_PATH.'/models/category.php';
+
+class WPML_JSON_API_Tag extends WPML_JSON_API_Category {
+  protected $type = 'tag';
+  protected $wpml_type = 'tax_post_tag';
+}
diff --git a/models/tag_translation.php b/models/tag_translation.php
@@ -0,0 +1,34 @@
+<?php
+
+require_once WPML_JSON_API_PATH.'/models/translation.php';
+
+/**
+ * A translation of a WPML_JSON_API_Tag.
+ */
+class WPML_JSON_API_TagTranslation extends WPML_JSON_API_Translation {
+  public $name;
+  public $term_id;
+  public $post_count;
+
+  function __construct($tag, $translation) {
+    parent::__construct($tag, $translation);
+
+    $this->name = $translation->name;
+    $this->term_id = (integer) $translation->term_id;
+    $this->post_count = (integer) $translation->instances;
+  }
+
+  /**
+   * Returns the tag for this translation.
+   *
+   * @return JSON_API_Tag
+   */
+  function resolve_resource() {
+    $wp_tag = get_term_by('id', $this->resource_id, 'post_tag');
+
+    if (!is_null($wp_tag)) {
+      return $this->_resource = new JSON_API_Tag($wp_tag);
+    }
+  }
+
+}
diff --git a/readme.txt b/readme.txt
diff --git a/wpml-json-api.php b/wpml-json-api.php
