Merge pull request #914 from ruflin/nicolassing-master

FileScript implementaiton

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file based on the
 ### Bugfixes
 
 ### Added
+- Add Script File feature #902 #914
 
 ### Improvements
 

Makefile

@@ -119,10 +119,6 @@ gource:
 
 ## DOCKER IMAGES
 
-
-# This creates the base image locally for local development. In case no local development is done anymore, make sure to remove this image.
-all: nginx-image elasticsearch-image elastica-dev-image elastica-image elastica-data
-	# elastica image has to be built after elastica-dev image as it depends on it. Otherwise the remote image is fetched.
 
 elastica-image:
 	docker build -t ruflin/elastica .

ansible/roles/elasticsearch/tasks/main.yml

@@ -87,6 +87,14 @@
     - config-1.yml
     - logging.yml
   notify: restart elasticsearch
+
+- name: Assures scripts dir exists
+  file: path=/etc/elasticsearch/scripts/ state=directory
+- name: create custom config scripts
+  template: >
+    dest=/etc/elasticsearch/scripts/
+    src=calculate-distance.groovy
+  notify: restart elasticsearch
 
 - name: create elasticsearch service script
   template: >

ansible/roles/elasticsearch/templates/calculate-distance.groovy

@@ -0,0 +1 @@
+doc['location'].arcDistanceInKm(lat,lon)

ansible/roles/elasticsearch/templates/config-default.yml

@@ -17,6 +17,8 @@ bulk.udp.bulk_actions: 5
 script.inline: on
 script.indexed: on
 
+script.engine.groovy.file: on
+
 # Disable dynamic memory allocation
 bootstrap.mlockall: true
 
@@ -33,6 +35,8 @@ node.name: Elastica
 # Added for snapshot tests
 path.repo: ["/tmp/backups"]
 
+script.engine.groovy.file: on
+
 {% endblock %}
 
 {% block config %}

env/elasticsearch/Dockerfile

@@ -21,6 +21,8 @@ RUN ${ES_PLUGIN_BIN} -install mobz/elasticsearch-head
 
 # Copy config files
 COPY *.yml /usr/share/elasticsearch/config/
+COPY scripts/* /usr/share/elasticsearch/config/scripts/
+
 
 RUN mkdir -p /tmp/backups/backup1
 RUN mkdir -p /tmp/backups/backup2

env/elasticsearch/elasticsearch.yml

@@ -16,6 +16,8 @@ bulk.udp.bulk_actions: 5
 script.inline: on
 script.indexed: on
 
+script.engine.groovy.file: on
+
 # Disable dynamic memory allocation
 bootstrap.mlockall: true
 

env/elasticsearch/scripts/calculate-distance.groovy

@@ -0,0 +1 @@
+doc['location'].arcDistanceInKm(lat,lon)

lib/Elastica/AbstractScript.php

@@ -0,0 +1,27 @@
+<?php
+namespace Elastica;
+
+/**
+ * Base class for Script object.
+ *
+ * @author Nicolas Assing <[email protected]>
+ *
+ * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
+ */
+abstract class AbstractScript extends AbstractUpdateAction
+{
+    /**
+     * @param array|null $params
+     * @param string     $id
+     */
+    public function __construct(array $params = null, $id = null)
+    {
+        if ($params) {
+            $this->setParams($params);
+        }
+
+        if ($id) {
+            $this->setId($id);
+        }
+    }
+}

lib/Elastica/Query.php

@@ -306,12 +306,12 @@ public function setScriptFields($scriptFields)
     /**
      * Adds a Script to the query.
      *
-     * @param string           $name
-     * @param \Elastica\Script $script Script object
+     * @param string                   $name
+     * @param \Elastica\AbstractScript $script Script object
      *
      * @return $this
      */
-    public function addScriptField($name, Script $script)
+    public function addScriptField($name, AbstractScript $script)
     {
         $this->_params['script_fields'][$name] = $script->toArray();
 

lib/Elastica/Script.php

@@ -10,7 +10,7 @@
  *
  * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
  */
-class Script extends AbstractUpdateAction
+class Script extends AbstractScript
 {
     const LANG_MVEL = 'mvel';
     const LANG_JS = 'js';
@@ -35,19 +35,13 @@ class Script extends AbstractUpdateAction
      */
     public function __construct($script, array $params = null, $lang = null, $id = null)
     {
-        $this->setScript($script);
+        parent::__construct($params, $id);
 
-        if ($params) {
-            $this->setParams($params);
-        }
+        $this->setScript($script);
 
         if ($lang) {
             $this->setLang($lang);
         }
-
-        if ($id) {
-            $this->setId($id);
-        }
     }
 
     /**

lib/Elastica/ScriptFile.php

@@ -0,0 +1,115 @@
+<?php
+namespace Elastica;
+
+use Elastica\Exception\InvalidException;
+
+/**
+ * Script objects, containing script internals.
+ *
+ * @author avasilenko <[email protected]>
+ * @author Nicolas Assing <[email protected]>
+ *
+ * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
+ */
+class ScriptFile extends AbstractScript
+{
+    /**
+     * @var string
+     */
+    private $_scriptFile;
+
+    /**
+     * @param string     $scriptFile
+     * @param array|null $params
+     * @param null       $id
+     */
+    public function __construct($scriptFile, array $params = null, $id = null)
+    {
+        parent::__construct($params, $id);
+
+        $this->setScriptFile($scriptFile);
+    }
+
+    /**
+     * @param string $scriptFile
+     *
+     * @return $this
+     */
+    public function setScriptFile($scriptFile)
+    {
+        $this->_scriptFile = $scriptFile;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getScriptFile()
+    {
+        return $this->_scriptFile;
+    }
+
+    /**
+     * @param string|array|\Elastica\Script $data
+     *
+     * @throws \Elastica\Exception\InvalidException
+     *
+     * @return self
+     */
+    public static function create($data)
+    {
+        if ($data instanceof self) {
+            $scriptFile = $data;
+        } elseif (is_array($data)) {
+            $scriptFile = self::_createFromArray($data);
+        } elseif (is_string($data)) {
+            $scriptFile = new self($data);
+        } else {
+            throw new InvalidException('Failed to create scriptFile. Invalid data passed.');
+        }
+
+        return $scriptFile;
+    }
+
+    /**
+     * @param array $data
+     *
+     * @throws \Elastica\Exception\InvalidException
+     *
+     * @return self
+     */
+    protected static function _createFromArray(array $data)
+    {
+        if (!isset($data['script_file'])) {
+            throw new InvalidException("\$data['script_file'] is required");
+        }
+
+        $scriptFile = new self($data['script_file']);
+
+        if (isset($data['params'])) {
+            if (!is_array($data['params'])) {
+                throw new InvalidException("\$data['params'] should be array");
+            }
+            $scriptFile->setParams($data['params']);
+        }
+
+        return $scriptFile;
+    }
+
+    /**
+     * @return array
+     */
+    public function toArray()
+    {
+        $array = array(
+            'script_file' => $this->_scriptFile,
+        );
+
+        if (!empty($this->_params)) {
+            $array['params'] = $this->_params;
+        }
+
+        return $array;
+    }
+}