Show a progress bar while data indexation

Added badge notification when the index is out of sync
Documentation fix

Author: Alban Jubert

README.md

@@ -106,8 +106,8 @@ If your Elasticsearch index becomes out of sync with your sites contents, you ca
 
 ## Elasticsearch plugin Roadmap
 
-* Handel dependencies update 
-* Handel multi-sites configurations
+* Handle dependencies update 
+* Handle multi-sites configurations
 * Detect need for re-indexation
 
 Brought to you by ![LHS Logo](resources/img/lhs.png) [La Haute Société](https://www.lahautesociete.com)

src/Elasticsearch.php

@@ -66,17 +66,7 @@ class Elasticsearch extends Plugin
     // Public Methods
     // =========================================================================
 
-    /**
-     * Set our $plugin static property to this class so that it can be accessed via
-     * Elasticsearch::$plugin
-     *
-     * Called after the plugin class is instantiated; do any one-time initialization
-     * here such as hooks and events.
-     *
-     * If you have a '/vendor/autoload.php' file, it will be loaded for you automatically;
-     * you do not need to load it in your init() method.
-     *
-     */
+
     public function init()
     {
         parent::init();
@@ -165,35 +155,22 @@ function (RegisterComponentTypesEvent $event) {
             }
         );
 
-        // Do something after we're installed
         Event::on(
             Plugins::class,
-            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
+            Plugins::EVENT_AFTER_SAVE_PLUGIN_SETTINGS,
             function (PluginEvent $event) {
                 if ($event->plugin === $this) {
-                    // We were just installed
+                    $this->elasticsearch->reindexAll();
                 }
             }
         );
 
-        /**
-         * Logging in Craft involves using one of the following methods:
-         *
-         * Craft::trace(): record a message to trace how a piece of code runs. This is mainly for development use.
-         * Craft::info(): record a message that conveys some useful information.
-         * Craft::warning(): record a warning message that indicates something unexpected has happened.
-         * Craft::error(): record a fatal error that should be investigated as soon as possible.
-         *
-         * Unless `devMode` is on, only Craft::warning() & Craft::error() will log to `craft/storage/logs/web.log`
-         *
-         * It's recommended that you pass in the magic constant `__METHOD__` as the second parameter, which sets
-         * the category to the method (prefixed with the fully qualified class name) where the constant appears.
-         *
-         * To enable the Yii debug toolbar, go to your user account in the AdminCP and check the
-         * [] Show the debug toolbar on the front end & [] Show the debug toolbar on the Control Panel
-         *
-         * http://www.yiiframework.com/doc-2.0/guide-runtime-logging.html
-         */
+        //        Event::on(UserPermissions::class, UserPermissions::EVENT_REGISTER_PERMISSIONS, function(RegisterUserPermissionsEvent $event) {
+        //            $event->permissions[\Craft::t('elasticsearch', 'Elasticsearch')] = [
+        //                'some-thing' => ['label' => \Craft::t('elasticsearch', 'Something')],
+        //            ];
+        //        });
+
         Craft::info(
             Craft::t(
                 'elasticsearch',

src/assetbundles/elasticsearch/dist/js/Elasticsearch.js

@@ -9,3 +9,5 @@
  * @package   Elasticsearch
  * @since     1.0.0
  */
+
+

src/assetbundles/elasticsearchutility/dist/js/Elasticsearch.js

@@ -9,3 +9,91 @@
  * @package   Elasticsearch
  * @since     1.0.0
  */
+
+(function($) {
+
+    Craft.ElasticsearchUtility = Garnish.Base.extend(
+        {
+            $trigger: null,
+            $form: null,
+
+            init: function(formId) {
+                this.$form = $('#' + formId);
+                this.$trigger = $('input.submit', this.$form);
+                this.$status = $('.utility-status', this.$form);
+
+                this.addListener(this.$form, 'submit', 'onSubmit');
+            },
+
+            onSubmit: function(ev) {
+                ev.preventDefault();
+
+                if (!this.$trigger.hasClass('disabled')) {
+                    if (!this.progressBar) {
+                        this.progressBar = new Craft.ProgressBar(this.$status);
+                    }
+                    else {
+                        this.progressBar.resetProgressBar();
+                    }
+
+                    this.progressBar.$progressBar.removeClass('hidden');
+
+                    this.progressBar.$progressBar.velocity('stop').velocity(
+                        {
+                            opacity: 1
+                        },
+                        {
+                            complete: $.proxy(function() {
+                                var postData = Garnish.getPostData(this.$form),
+                                    params = Craft.expandPostArray(postData);
+
+                                var data = {};
+
+                                Craft.postActionRequest(params.action, data, $.proxy(function(response, textStatus) {
+                                        if (response && response.error) {
+                                            alert(response.error);
+                                        }
+
+                                        this.updateProgressBar();
+
+                                        setTimeout($.proxy(this, 'onComplete'), 300);
+
+                                    }, this),
+                                    {
+                                        complete: $.noop
+                                    });
+
+                            }, this)
+                        });
+
+                    if (this.$allDone) {
+                        this.$allDone.css('opacity', 0);
+                    }
+
+                    this.$trigger.addClass('disabled');
+                    this.$trigger.trigger('blur');
+                }
+            },
+
+            updateProgressBar: function() {
+                var width = 100;
+                this.progressBar.setProgressPercentage(width);
+            },
+
+            onComplete: function() {
+                if (!this.$allDone) {
+                    this.$allDone = $('<div class="alldone" data-icon="done" />').appendTo(this.$status);
+                    this.$allDone.css('opacity', 0);
+                }
+
+                this.progressBar.$progressBar.velocity({opacity: 0}, {
+                    duration: 'fast', complete: $.proxy(function() {
+                        this.$allDone.velocity({opacity: 1}, {duration: 'fast'});
+                        this.$trigger.removeClass('disabled');
+                        this.$trigger.trigger('focus');
+                    }, this)
+                });
+            }
+        });
+
+})(jQuery);

src/console/controllers/ElasticsearchController.php

@@ -11,31 +11,10 @@
 namespace lhs\elasticsearch\console\controllers;
 
 use lhs\elasticsearch\Elasticsearch;
-
-use Craft;
 use yii\console\Controller;
-use yii\helpers\Console;
 
 /**
- * Elasticsearch Command
- *
- * The first line of this class docblock is displayed as the description
- * of the Console Command in ./craft help
- *
- * Craft can be invoked via commandline console by using the `./craft` command
- * from the project root.
- *
- * Console Commands are just controllers that are invoked to handle console
- * actions. The segment routing is plugin-name/controller-name/action-name
- *
- * The actionIndex() method is what is executed if no sub-commands are supplied, e.g.:
- *
- * ./craft elasticsearch/elasticsearch
- *
- * Actions must be in 'kebab-case' so actionDoSomething() maps to 'do-something',
- * and would be invoked via:
- *
- * ./craft elasticsearch/elasticsearch/do-something
+ * Allow various operation for elastisearch index
  *
  * @author    Alban Jubert
  * @package   Elasticsearch
@@ -47,36 +26,12 @@ class ElasticsearchController extends Controller
     // =========================================================================
 
     /**
-     * Handle elasticsearch/elasticsearch console commands
-     *
-     * The first line of this method docblock is displayed as the description
-     * of the Console Command in ./craft help
+     * Reindex Craft entries into elasticsearch
      *
      * @return mixed
      */
-    public function actionIndex()
+    public function actionReindexAll()
     {
-        $result = 'something';
-
-        echo "Welcome to the console ElasticsearchController actionIndex() method\n";
-
-        return $result;
-    }
-
-    /**
-     * Handle elasticsearch/elasticsearch/do-something console commands
-     *
-     * The first line of this method docblock is displayed as the description
-     * of the Console Command in ./craft help
-     *
-     * @return mixed
-     */
-    public function actionDoSomething()
-    {
-        $result = 'something';
-
-        echo "Welcome to the console ElasticsearchController actionDoSomething() method\n";
-
-        return $result;
+        return Elasticsearch::$plugin->elasticsearch->reindexAll();
     }
 }

src/controllers/ElasticsearchController.php

@@ -52,27 +52,37 @@ class ElasticsearchController extends Controller
     // =========================================================================
 
     /**
-     * Handle a request going to our plugin's actionDoSomething URL,
-     * e.g.: actions/elasticsearch/elasticsearch/do-something
+     * Test the elasticsearch connection
      *
      * @return mixed
      */
     public function actionTestConnection()
     {
         if(Elasticsearch::$plugin->elasticsearch->testConnection() === true) {
-            Craft::$app->session->setFlash('notice', Craft::t('elasticsearch', 'Successfully connected to {http_address}', ['http_address' => $this->module->settings->http_address]));
+            Craft::$app->session->setNotice(Craft::t('elasticsearch', 'Successfully connected to {http_address}', ['http_address' => $this->module->settings->http_address]));
         }
         else {
-            Craft::$app->session->setFlash('error', Craft::t('elasticsearch', 'Could not establish connection with {http_address}', ['http_address' => $this->module->settings->http_address]));
+            Craft::$app->session->setError(Craft::t('elasticsearch', 'Could not establish connection with {http_address}', ['http_address' => $this->module->settings->http_address]));
         }
 
         return $this->redirect(UrlHelper::cpUrl('utilities/elasticsearch-utilities'));
     }
 
+    /**
+     * Reindex Craft entries into elasticsearch (called from utility panel)
+     *
+     * @return \yii\web\Response
+     */
     public function actionReindexAll()
     {
         Elasticsearch::$plugin->elasticsearch->reindexAll();
-        Craft::$app->session->setFlash('notice', Craft::t('elasticsearch', 'Elasticsearch indexing in progress...'));
+
+        if (\Craft::$app->getRequest()->getAcceptsJson()) {
+            return $this->asJson([
+                'success' => true
+            ]);
+        }
+
         return $this->redirect(UrlHelper::cpUrl('utilities/elasticsearch-utilities'));
     }
 }

src/models/Settings.php

@@ -12,7 +12,6 @@
 
 use Craft;
 use craft\base\Model;
-use lhs\elasticsearch\Elasticsearch;
 
 /**
  * Elasticsearch Settings Model
@@ -67,12 +66,4 @@ public function rules()
             [['auth_username', 'auth_password'], 'trim']
         ];
     }
-
-    public function afterValidate()
-    {
-        if (Elasticsearch::$plugin->elasticsearch->testConnection() !== true) {
-            $this->addError('http_address', Craft::t('elasticsearch', 'Could not establish connection with {http_address}', ['http_address' => $this->http_address]));
-        }
-        parent::afterValidate();
-    }
 }