Bug 33108: Teach koha-list filter elasticsearch

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

debian/docs/koha-list.xml

@@ -25,6 +25,7 @@
     <cmdsynopsis>
       <command>koha-list</command>
       <arg><option>--enabled</option>|<option>--disabled</option></arg>
+      <arg><option>--elasticsearch</option>|<option>--noelasticsearch</option></arg>
       <arg><option>--email</option>|<option>--noemail</option></arg>
       <arg><option>--sip</option>|<option>--nosip</option></arg>
       <arg><option>--plack</option>|<option>--noplack</option></arg>
@@ -47,6 +48,18 @@
         <para>Only show instances that are disabled.</para>
       </listitem>
     </varlistentry>
+    <varlistentry>
+      <term><option>--elasticsearch</option></term>
+        <listitem>
+          <para>Only show instances that have elasticsearch enabled.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--noelasticsearch</option></term>
+        <listitem>
+          <para>Only show instances that do not have elasticsearch enabled.</para>
+        </listitem>
+      </varlistentry>
     <varlistentry>
       <term><option>--email</option></term>
       <listitem>

debian/koha-common.bash-completion

@@ -131,7 +131,7 @@ _koha_list()
 
     COMPREPLY=()
     _get_comp_words_by_ref cur
-    opts="--enabled --disabled --email --noemail --plack --noplack --sip --nosip --help -h"
+    opts="--enabled --disabled --email --noemail --plack --noplack --sip --nosip --help -h --elasticsearch --noelasticsearch"
 
     # Build a list of the already used option switches
     for (( i=0; i < ${#COMP_WORDS[@]}-1; i++ )); do
@@ -141,6 +141,10 @@ _koha_list()
                     substract="$substract -e --enabled"; ;;
                 --enabled)
                     substract="$substract -e --disabled"; ;;
+                --elasticsearch)
+                    substract="$substract -e --noelasticsearch"; ;;
+                --noelasticsearch)
+                    substract="$substract -e --elasticsearch"; ;;
                 --email)
                     substract="$substract -e --noemail"; ;;
                 --noemail)

debian/koha-core.bash-completion

@@ -131,7 +131,7 @@ _koha_list()
 
     COMPREPLY=()
     _get_comp_words_by_ref cur
-    opts="--enabled --disabled --email --noemail --plack --noplack --sip --nosip --help -h"
+    opts="--enabled --disabled --email --noemail --plack --noplack --sip --nosip --help -h --elasticsearch --noelasticsearch"
 
     # Build a list of the already used option switches
     for (( i=0; i < ${#COMP_WORDS[@]}-1; i++ )); do
@@ -141,6 +141,10 @@ _koha_list()
                     substract="$substract -e --enabled"; ;;
                 --enabled)
                     substract="$substract -e --disabled"; ;;
+                --elasticsearch)
+                    substract="$substract -e --noelasticsearch"; ;;
+                --noelasticsearch)
+                    substract="$substract -e --elasticsearch"; ;;
                 --email)
                     substract="$substract -e --noemail"; ;;
                 --noemail)

debian/scripts/koha-list

@@ -29,37 +29,21 @@ fi
 
 show_instances()
 {
-    local show=$1
-    local show_email=$2
-    local show_sip=$3
-
     for instance in $( get_instances ); do
         case $show in
           "all")
-              if instance_filter_email       $instance $show_email && \
+              if filter_ok $instance; then
-                 instance_filter_letsencrypt $instance $show_letsencrypt && \
-                 instance_filter_plack       $instance $show_plack && \
-                 instance_filter_z3950       $instance $show_z3950 && \
-                 instance_filter_sip         $instance $show_sip; then
                   echo $instance
               fi ;;
           "enabled")
               if is_enabled $instance; then
-                  if instance_filter_email       $instance $show_email && \
+                  if filter_ok $instance; then
-                     instance_filter_letsencrypt $instance $show_letsencrypt && \
-                     instance_filter_plack       $instance $show_plack && \
-                     instance_filter_z3950       $instance $show_z3950 && \
-                     instance_filter_sip         $instance $show_sip; then
                       echo $instance
                   fi
               fi ;;
           "disabled")
               if ! is_enabled $instance; then
-                  if instance_filter_email       $instance $show_email && \
+                  if filter_ok $instance; then
-                     instance_filter_letsencrypt $instance $show_letsencrypt && \
-                     instance_filter_plack       $instance $show_plack && \
-                     instance_filter_z3950       $instance $show_z3950 && \
-                     instance_filter_sip         $instance $show_sip; then
                       echo $instance
                   fi
               fi ;;
@@ -67,21 +51,35 @@ show_instances()
     done
 }
 
+filter_ok()
+{
+    local instance=$1
+
+    if instance_filter_email         $instance && \
+       instance_filter_elasticsearch $instance && \
+       instance_filter_letsencrypt   $instance && \
+       instance_filter_plack         $instance && \
+       instance_filter_z3950         $instance && \
+       instance_filter_sip           $instance; then
+        return 0;
+    else
+        return 1;
+    fi
+}
 
 instance_filter_sip()
 {
-    local instancename=$1
+    local instance=$1
-    local show_sip=$2;
 
     case $show_sip in
         "all")
             return 0 ;;
         "enabled")
-            if is_sip_enabled $instancename; then
+            if is_sip_enabled $instance; then
                 return 0
             fi ;;
         "disabled")
-            if ! is_sip_enabled $instancename; then
+            if ! is_sip_enabled $instance; then
                 return 0
             fi ;;
     esac
@@ -92,18 +90,17 @@ instance_filter_sip()
 
 instance_filter_plack()
 {
-    local instancename=$1
+    local instance=$1
-    local show_plack=$2;
 
     case $show_plack in
         "all")
             return 0 ;;
         "enabled")
-            if is_plack_enabled $instancename; then
+            if is_plack_enabled $instance; then
                 return 0
             fi ;;
         "disabled")
-            if ! is_plack_enabled $instancename; then
+            if ! is_plack_enabled $instance; then
                 return 0
             fi ;;
     esac
@@ -114,18 +111,17 @@ instance_filter_plack()
 
 instance_filter_letsencrypt()
 {
-    local instancename=$1
+    local instance=$1
-    local show_letsencrypt=$2;
 
     case $show_letsencrypt in
         "all")
             return 0 ;;
         "enabled")
-            if is_letsencrypt_enabled $instancename; then
+            if is_letsencrypt_enabled $instance; then
                 return 0
             fi ;;
         "disabled")
-            if ! is_letsencrypt_enabled $instancename; then
+            if ! is_letsencrypt_enabled $instance; then
                 return 0
             fi ;;
     esac
@@ -136,18 +132,17 @@ instance_filter_letsencrypt()
 
 instance_filter_email()
 {
-    local instancename=$1
+    local instance=$1
-    local show_email=$2;
 
     case $show_email in
         "all")
             return 0 ;;
         "enabled")
-            if is_email_enabled $instancename; then
+            if is_email_enabled $instance; then
                 return 0
             fi ;;
         "disabled")
-            if ! is_email_enabled $instancename; then
+            if ! is_email_enabled $instance; then
                 return 0
             fi ;;
     esac
@@ -158,18 +153,38 @@ instance_filter_email()
 
 instance_filter_z3950()
 {
-    local instancename=$1
+    local instance=$1
-    local show_z3950=$2;
 
     case $show_z3950 in
         "all")
             return 0 ;;
         "enabled")
-            if is_z3950_enabled $instancename; then
+            if is_z3950_enabled $instance; then
                 return 0
             fi ;;
         "disabled")
-            if ! is_z3950_enabled $instancename; then
+            if ! is_z3950_enabled $instance; then
+                return 0
+            fi ;;
+    esac
+
+    # Didn't match any criteria
+    return 1
+}
+
+instance_filter_elasticsearch()
+{
+    local instance=$1
+
+    case $show_elasticsearch in
+        "all")
+            return 0 ;;
+        "enabled")
+            if is_elasticsearch_enabled $instance; then
+                return 0
+            fi ;;
+        "disabled")
+            if ! is_elasticsearch_enabled $instance; then
                 return 0
             fi ;;
     esac
@@ -189,6 +204,17 @@ set_show()
     fi
 }
 
+set_show_elasticsearch()
+{
+    local elasticsearch_param=$1
+
+    if [ "$show_elasticsearch" = "all" ]; then
+        show_elasticsearch=$elasticsearch_param
+    else
+        die "Error: --elasticsearch and --noelasticsearch are mutually exclusive."
+    fi
+}
+
 set_show_email()
 {
     local email_param=$1
@@ -256,6 +282,8 @@ Usage: $scriptname [--enabled|--disabled] [--email|--noemail] [--sip|--nosip] [-
 Options:
     --enabled        Show enabled instances
     --disabled       Show disabled instances
+    --elasticsearch  Show instances with Elasticsearch enabled
+    --noelasticsarch Show instances with Elasticsearch disabled
     --email          Show instances with email enabled
     --noemail        Show instances with email disabled
     --sip            Show instances with SIP enabled
@@ -274,13 +302,14 @@ EOH
 }
 
 show="all"
+show_elasticsearch="all"
 show_email="all"
 show_sip="all"
 show_plack="all"
 show_letsencrypt="all"
 show_z3950="all"
 
-args=$(getopt -l help,enabled,disabled,email,noemail,sip,nosip,plack,noplack,letsencrypt,noletsencrypt,z3950,noz3950 -o h -n $0 -- "$@")
+args=$(getopt -l help,enabled,disabled,elasticsearch,noelasticsearch,email,noemail,sip,nosip,plack,noplack,letsencrypt,noletsencrypt,z3950,noz3950 -o h -n $0 -- "$@")
 set -- $args
 
 while [ ! -z "$1" ]
@@ -297,6 +326,8 @@ do
   --noletsencrypt) set_show_letsencrypt "disabled" ;;
           --z3950) set_show_z3950 "enabled" ;;
         --noz3950) set_show_z3950 "disabled" ;;
+  --elasticsearch) set_show_elasticsearch "enabled" ;;
+--noelasticsearch) set_show_elasticsearch "disabled" ;;
         --enabled) set_show "enabled" ;;
        --disabled) set_show "disabled" ;;
                 *) break;;
@@ -304,6 +335,6 @@ do
     shift
 done
 
-show_instances $show $show_email $show_sip
+show_instances
 
 exit 0