Merge pull request #294 from wttech/feature/make-auto-run-script-feat…

…ure-to-take-run-modes-into-account

added run modes into account to auto-run script feature

app/aem/api/src/main/java/com/cognifide/apm/api/scripts/Script.java

@@ -20,6 +20,7 @@
 package com.cognifide.apm.api.scripts;
 
 import java.util.Date;
+import java.util.Set;
 
 public interface Script {
 
@@ -40,6 +41,8 @@ public interface Script {
 
 	LaunchEnvironment getLaunchEnvironment();
 
+	Set<String> getLaunchRunModes();
+
 	String getLaunchHook();
 
 	/**

app/aem/api/src/main/java/com/cognifide/apm/api/scripts/TransientScript.java

@@ -20,6 +20,7 @@
 package com.cognifide.apm.api.scripts;
 
 import java.util.Date;
+import java.util.Set;
 
 public class TransientScript implements MutableScript {
 
@@ -66,6 +67,11 @@ public LaunchEnvironment getLaunchEnvironment() {
     return LaunchEnvironment.ALL;
   }
 
+  @Override
+  public Set<String> getLaunchRunModes() {
+    return null;
+  }
+
   @Override
   public String getLaunchHook() {
     return null;

app/aem/core/src/main/java/com/cognifide/apm/core/launchers/ScheduledScriptLauncher.java

@@ -36,6 +36,7 @@
 import org.apache.sling.api.resource.PersistenceException;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ResourceResolverFactory;
+import org.apache.sling.settings.SlingSettingsService;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Modified;
@@ -65,6 +66,9 @@ public class ScheduledScriptLauncher extends AbstractLauncher implements Runnabl
   @Reference
   private InstanceTypeProvider instanceTypeProvider;
 
+  @Reference
+  private SlingSettingsService slingSettings;
+
   @Reference
   private ResourceResolverFactory resolverFactory;
 
@@ -85,7 +89,7 @@ public void run() {
 
   private void runScheduled(ResourceResolver resolver) throws PersistenceException {
     LaunchEnvironment environment = instanceTypeProvider.isOnAuthor() ? AUTHOR : PUBLISH;
-    List<Script> scripts = scriptFinder.findAll(onSchedule(environment, new Date()), resolver);
+    List<Script> scripts = scriptFinder.findAll(onSchedule(environment, slingSettings, new Date()), resolver);
     processScripts(scripts, resolver, LauncherType.SCHEDULED);
   }
 

app/aem/core/src/main/java/com/cognifide/apm/core/launchers/StartupScriptLauncher.java

@@ -41,6 +41,7 @@
 import org.apache.sling.api.resource.PersistenceException;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ResourceResolverFactory;
+import org.apache.sling.settings.SlingSettingsService;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
@@ -66,6 +67,9 @@ public class StartupScriptLauncher extends AbstractLauncher {
   @Reference
   private InstanceTypeProvider instanceTypeProvider;
 
+  @Reference
+  private SlingSettingsService slingSettings;
+
   @Reference
   private VersionService versionService;
 
@@ -84,8 +88,8 @@ private void process(ResourceResolver resolver) {
 
   private void executeScripts(LaunchEnvironment currentEnvironment, ResourceResolver resolver) {
     List<Script> scripts = new ArrayList<>();
-    scripts.addAll(scriptFinder.findAll(onStartup(currentEnvironment), resolver));
-    scripts.addAll(modifiedScriptFinder.findAll(onStartupIfModified(currentEnvironment), resolver));
+    scripts.addAll(scriptFinder.findAll(onStartup(currentEnvironment, slingSettings), resolver));
+    scripts.addAll(modifiedScriptFinder.findAll(onStartupIfModified(currentEnvironment, slingSettings), resolver));
 
     scripts.forEach(script -> {
       try {

app/aem/core/src/main/java/com/cognifide/apm/core/scripts/LaunchMetadata.java

@@ -29,38 +29,16 @@ public class LaunchMetadata {
   private final boolean executionEnabled;
   private final LaunchMode launchMode;
   private final LaunchEnvironment launchEnvironment;
+  private final String[] launchRunModes;
   private final String executionHook;
   private final LocalDateTime executionSchedule;
 
-  public static LaunchMetadata disabled() {
-    return new LaunchMetadata(false, LaunchMode.ON_DEMAND, null, null, null);
-  }
-
-  public static LaunchMetadata onDemand() {
-    return new LaunchMetadata(true, LaunchMode.ON_DEMAND, null, null, null);
-  }
-
-  public static LaunchMetadata onModify() {
-    return new LaunchMetadata(true, LaunchMode.ON_STARTUP_IF_MODIFIED, null, null, null);
-  }
-
-  public static LaunchMetadata onStart() {
-    return new LaunchMetadata(true, LaunchMode.ON_STARTUP, null, null, null);
-  }
-
-  public static LaunchMetadata onHook(LaunchEnvironment launchEnvironment, String executionHook) {
-    return new LaunchMetadata(true, LaunchMode.ON_DEMAND, launchEnvironment, executionHook, null);
-  }
-
-  public static LaunchMetadata onSchedule(LocalDateTime executionSchedule) {
-    return new LaunchMetadata(true, LaunchMode.ON_DEMAND, null, null, executionSchedule);
-  }
-
-  public LaunchMetadata(boolean executionEnabled, LaunchMode launchMode,
-      LaunchEnvironment launchEnvironment, String executionHook, LocalDateTime executionSchedule) {
+  public LaunchMetadata(boolean executionEnabled, LaunchMode launchMode, LaunchEnvironment launchEnvironment,
+                        String[] launchRunModes, String executionHook, LocalDateTime executionSchedule) {
     this.executionEnabled = executionEnabled;
     this.launchMode = launchMode;
     this.launchEnvironment = launchEnvironment;
+    this.launchRunModes = launchRunModes;
     this.executionHook = executionHook;
     this.executionSchedule = executionSchedule;
   }
@@ -77,6 +55,10 @@ public LaunchEnvironment getLaunchEnvironment() {
     return launchEnvironment;
   }
 
+  public String[] getLaunchRunModes() {
+    return launchRunModes;
+  }
+
   public String getExecutionHook() {
     return executionHook;
   }

app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptFilters.java

@@ -23,46 +23,53 @@
 import com.cognifide.apm.api.scripts.LaunchMode;
 import com.cognifide.apm.api.scripts.Script;
 import java.util.Date;
+import java.util.Set;
 import java.util.function.Predicate;
 import org.apache.commons.lang.StringUtils;
+import org.apache.sling.settings.SlingSettingsService;
 
 /**
  * Due to the ResourceResolver dependency these filters should not be used lazy
  * i.e. in a context where the resolver passed as an argument is no longer alive.
  */
 public class ScriptFilters {
 
-  public static Predicate<Script> onInstall(LaunchEnvironment environment, String currentHook) {
+  public static Predicate<Script> onInstall(LaunchEnvironment environment, SlingSettingsService slingSettings, String currentHook) {
     return enabled()
         .and(withLaunchMode(LaunchMode.ON_INSTALL))
         .and(withLaunchEnvironment(environment))
+        .and(withLaunchRunModes(slingSettings.getRunModes()))
         .and(withLaunchHook(currentHook));
   }
 
-  public static Predicate<Script> onInstallIfModified(LaunchEnvironment environment, String currentHook) {
+  public static Predicate<Script> onInstallIfModified(LaunchEnvironment environment, SlingSettingsService slingSettings, String currentHook) {
     return enabled()
         .and(withLaunchMode(LaunchMode.ON_INSTALL_IF_MODIFIED))
         .and(withLaunchEnvironment(environment))
+        .and(withLaunchRunModes(slingSettings.getRunModes()))
         .and(withLaunchHook(currentHook));
   }
 
-  public static Predicate<Script> onSchedule(LaunchEnvironment environment, Date date) {
+  public static Predicate<Script> onSchedule(LaunchEnvironment environment, SlingSettingsService slingSettings, Date date) {
     return enabled()
         .and(withLaunchMode(LaunchMode.ON_SCHEDULE))
         .and(withLaunchEnvironment(environment))
+        .and(withLaunchRunModes(slingSettings.getRunModes()))
         .and(script -> script.getLastExecuted() == null && script.getLaunchSchedule().before(date));
   }
 
-  public static Predicate<Script> onStartup(LaunchEnvironment environment) {
+  public static Predicate<Script> onStartup(LaunchEnvironment environment, SlingSettingsService slingSettings) {
     return enabled()
         .and(withLaunchMode(LaunchMode.ON_STARTUP))
-        .and(withLaunchEnvironment(environment));
+        .and(withLaunchEnvironment(environment))
+        .and(withLaunchRunModes(slingSettings.getRunModes()));
   }
 
-  public static Predicate<Script> onStartupIfModified(LaunchEnvironment environment) {
+  public static Predicate<Script> onStartupIfModified(LaunchEnvironment environment, SlingSettingsService slingSettings) {
     return enabled()
         .and(withLaunchMode(LaunchMode.ON_STARTUP_IF_MODIFIED))
-        .and(withLaunchEnvironment(environment));
+        .and(withLaunchEnvironment(environment))
+        .and(withLaunchRunModes(slingSettings.getRunModes()));
   }
 
   private static Predicate<Script> withLaunchHook(String currentHook) {
@@ -74,6 +81,11 @@ private static Predicate<Script> withLaunchEnvironment(LaunchEnvironment environ
         || environment == script.getLaunchEnvironment();
   }
 
+  private static Predicate<? super Script> withLaunchRunModes(Set<String> runModes) {
+    return script -> script.getLaunchRunModes() == null
+        || runModes.containsAll(script.getLaunchRunModes());
+  }
+
   private static Predicate<Script> withLaunchMode(final LaunchMode mode) {
     return script -> script.getLaunchMode() == mode;
   }

app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptModel.java

@@ -25,10 +25,13 @@
 import com.cognifide.apm.core.utils.ResourceMixinUtil;
 import com.day.cq.commons.jcr.JcrConstants;
 import com.google.common.collect.Lists;
+import com.google.common.collect.Sets;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.GregorianCalendar;
 import java.util.List;
+import java.util.Set;
+import javax.annotation.PostConstruct;
 import javax.inject.Inject;
 import javax.inject.Named;
 import org.apache.commons.lang.BooleanUtils;
@@ -66,6 +69,11 @@ public class ScriptModel implements MutableScript {
   @Optional
   private String launchEnvironment;
 
+  @Inject
+  @Named(ScriptNode.APM_LAUNCH_RUN_MODES)
+  @Optional
+  private String[] launchRunModes;
+
   @Inject
   @Named(ScriptNode.APM_LAUNCH_HOOK)
   @Optional
@@ -145,6 +153,11 @@ public LaunchEnvironment getLaunchEnvironment() {
         });
   }
 
+  @Override
+  public Set<String> getLaunchRunModes() {
+    return launchRunModes == null ? null : Sets.newHashSet(launchRunModes);
+  }
+
   @Override
   public Date getLaunchSchedule() {
     return launchSchedule;

app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptNode.java

@@ -31,6 +31,8 @@ public final class ScriptNode {
 
   public static final String APM_LAUNCH_ENVIRONMENT = "apm:launchEnvironment";
 
+  public static final String APM_LAUNCH_RUN_MODES = "apm:launchRunModes";
+
   public static final String APM_LAUNCH_HOOK = "apm:launchHook";
 
   public static final String APM_LAUNCH_SCHEDULE = "apm:launchSchedule";

app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptStorageImpl.java

@@ -113,6 +113,7 @@ private Script saveScript(FileDescriptor descriptor, LaunchMetadata launchMetada
       fileNode.setProperty(ScriptNode.APM_LAUNCH_ENABLED, launchMetadata.isExecutionEnabled());
       setOrRemoveProperty(fileNode, ScriptNode.APM_LAUNCH_MODE, launchMetadata.getLaunchMode());
       setOrRemoveProperty(fileNode, ScriptNode.APM_LAUNCH_ENVIRONMENT, launchMetadata.getLaunchEnvironment());
+      setOrRemoveProperty(fileNode, ScriptNode.APM_LAUNCH_RUN_MODES, launchMetadata.getLaunchRunModes());
       setOrRemoveProperty(fileNode, ScriptNode.APM_LAUNCH_HOOK, launchMetadata.getExecutionHook());
       setOrRemoveProperty(fileNode, ScriptNode.APM_LAUNCH_SCHEDULE, launchMetadata.getExecutionSchedule());
       removeProperty(fileNode, ScriptNode.APM_LAST_EXECUTED);
@@ -135,6 +136,8 @@ private void setOrRemoveProperty(Node node, String name, Object value) throws Re
       calendar.set(localDateTime.getYear(), localDateTime.getMonthValue() - 1, localDateTime.getDayOfMonth(),
           localDateTime.getHour(), localDateTime.getMinute(), localDateTime.getSecond());
       node.setProperty(name, calendar);
+    } else if (value instanceof String[]) {
+      node.setProperty(name, (String[]) value);
     } else {
       node.setProperty(name, value.toString());
     }

app/aem/core/src/main/java/com/cognifide/apm/core/ui/models/ScriptsRowModel.java

@@ -37,6 +37,7 @@
 import javax.annotation.PostConstruct;
 import javax.inject.Inject;
 import lombok.Getter;
+import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang.StringUtils;
 import org.apache.commons.lang.WordUtils;
 import org.apache.sling.api.resource.Resource;
@@ -100,6 +101,9 @@ protected void afterCreated() {
         this.runs.add(createScriptRun("runOnPublish", script, scriptHistory.getLastRemoteRun()));
         this.launchMode = label(script.getLaunchMode());
         this.launchEnvironment = label(script.getLaunchEnvironment());
+        if (CollectionUtils.isNotEmpty(script.getLaunchRunModes())) {
+          this.launchEnvironment += "+" + StringUtils.join(script.getLaunchRunModes(), ",");
+        }
         this.isLaunchEnabled = script.isLaunchEnabled();
       });
     }

app/aem/core/src/main/kotlin/com/cognifide/apm/core/endpoints/ScriptUploadForm.kt

@@ -42,10 +42,11 @@ class ScriptUploadForm @Inject constructor(
         @param:RequestParameter(ScriptNode.APM_LAUNCH_ENABLED) val launchEnabled: Boolean,
         @param:RequestParameter(ScriptNode.APM_LAUNCH_MODE) val launchMode: LaunchMode,
         @param:RequestParameter(ScriptNode.APM_LAUNCH_ENVIRONMENT) val launchEnvironment: LaunchEnvironment?,
+        @param:RequestParameter(ScriptNode.APM_LAUNCH_RUN_MODES) val launchRunModes: Array<String>?,
         @param:RequestParameter(ScriptNode.APM_LAUNCH_HOOK) val launchHook: String?,
         @param:RequestParameter(ScriptNode.APM_LAUNCH_SCHEDULE) @param:DateFormat("yyyy-MM-dd'T'HH:mm:ss") val launchSchedule: LocalDateTime?
 ) {
     fun toLaunchMetadata(): LaunchMetadata {
-        return LaunchMetadata(launchEnabled, launchMode, launchEnvironment, launchHook, launchSchedule)
+        return LaunchMetadata(launchEnabled, launchMode, launchEnvironment, launchRunModes, launchHook, launchSchedule)
     }
 }

app/aem/core/src/main/kotlin/com/cognifide/apm/core/endpoints/params/RequestParameterInjector.kt

@@ -20,7 +20,6 @@
 
 package com.cognifide.apm.core.endpoints.params
 
-
 import com.cognifide.apm.core.Property
 import com.google.common.primitives.Ints
 import org.apache.commons.lang.StringUtils
@@ -77,6 +76,7 @@ class RequestParameterInjector : Injector, StaticInjectAnnotationProcessorFactor
             fieldClass == InputStream::class.java -> parameterValue.inputStream
             fieldClass == LocalDateTime::class.java -> toLocalDateTime(annotatedElement, parameterValue)
             Enum::class.java.isAssignableFrom(fieldClass) -> toEnum(fieldClass, parameterValue)
+            fieldClass.canonicalName == "java.lang.String[]" -> parameterValue.string.split(",").toTypedArray()
             else -> parameterValue.string
         }
     }

app/aem/core/src/main/kotlin/com/cognifide/apm/core/grammar/ReferenceFinder.kt

@@ -148,6 +148,8 @@ class ReferenceFinder(
 
         override fun getLaunchEnvironment(): LaunchEnvironment? = null
 
+        override fun getLaunchRunModes(): Set<String>? = null
+
         override fun getLaunchHook(): String? = null
 
         override fun getLaunchSchedule(): Date? = null

app/aem/core/src/main/kotlin/com/cognifide/apm/core/tools/ApmInstallHook.kt

@@ -39,6 +39,7 @@ import org.apache.jackrabbit.vault.packaging.InstallContext
 import org.apache.jackrabbit.vault.packaging.PackageException
 import org.apache.sling.api.resource.ResourceResolver
 import org.apache.sling.api.resource.ResourceResolverFactory
+import org.apache.sling.settings.SlingSettingsService
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import java.util.*
@@ -75,10 +76,11 @@ class ApmInstallHook : OsgiAwareInstallHook() {
         val scriptManager = getService(ScriptManager::class.java)
         val scriptFinder = getService(ScriptFinder::class.java)
         val modifiedScriptFinder = getService(ModifiedScriptFinder::class.java)
+        val slingSettings = getService(SlingSettingsService::class.java)
 
         val scripts = mutableListOf<Script>()
-        scripts.addAll(scriptFinder.findAll(onInstall(currentEnvironment, currentHook), resolver))
-        scripts.addAll(modifiedScriptFinder.findAll(onInstallIfModified(currentEnvironment, currentHook), resolver))
+        scripts.addAll(scriptFinder.findAll(onInstall(currentEnvironment, slingSettings, currentHook), resolver))
+        scripts.addAll(modifiedScriptFinder.findAll(onInstallIfModified(currentEnvironment, slingSettings, currentHook), resolver))
         scripts.forEach { script ->
             val result: ExecutionResult = scriptManager.process(script, ExecutionMode.AUTOMATIC_RUN, resolver)
             logStatus(context, script.path, result)

app/aem/core/src/main/resources/CQ-INF/nodetypes/apm_nodetypes.cnd

@@ -24,6 +24,7 @@
   - apm:launchEnabled (boolean)
   - apm:launchMode (string)
   - apm:launchEnvironment (string)
+  - apm:launchRunModes (string) multiple
   - apm:launchHook (string)
   - apm:launchSchedule (date)
   - apm:lastExecuted (date)

app/aem/ui.apps/src/main/content/jcr_root/apps/apm/clientlibs/views/editor/js/apm-editor.js

@@ -38,6 +38,7 @@
       'apm:launchEnabled',
       'apm:launchMode',
       'apm:launchEnvironment',
+      'apm:launchRunModes',
       'apm:launchHook',
       'apm:launchSchedule',
     ];
@@ -97,7 +98,9 @@
 
         const formData = new FormData();
         $.each(fieldNames, (index, fieldName) => {
-          const originalValue = originalFormData.get(fieldName);
+          const originalValue = fieldName === 'apm:launchRunModes'
+              ? originalFormData.getAll(fieldName)
+              : originalFormData.get(fieldName);
           if (originalValue) {
             formData.set(fieldName, originalValue);
           }