From 632607dafc77a31b6698dff74a40bd813ec8c581 Mon Sep 17 00:00:00 2001
From: Dominik Przybyl <przybyl.dominik@gmail.com>
Date: Wed, 18 Oct 2023 15:58:06 +0200
Subject: [PATCH] added cron support

---
 .../launchers/ScheduledScriptLauncher.java    | 100 ------------------
 .../apm/core/scripts/ScriptFilters.java       |  35 +++---
 .../ScriptsResourceChangeListener.java        |  30 ++++--
 3 files changed, 40 insertions(+), 125 deletions(-)
 delete mode 100644 app/aem/core/src/main/java/com/cognifide/apm/core/launchers/ScheduledScriptLauncher.java

diff --git a/app/aem/core/src/main/java/com/cognifide/apm/core/launchers/ScheduledScriptLauncher.java b/app/aem/core/src/main/java/com/cognifide/apm/core/launchers/ScheduledScriptLauncher.java
deleted file mode 100644
index 85b213ffc..000000000
--- a/app/aem/core/src/main/java/com/cognifide/apm/core/launchers/ScheduledScriptLauncher.java
+++ /dev/null
@@ -1,100 +0,0 @@
-/*-
- * ========================LICENSE_START=================================
- * AEM Permission Management
- * %%
- * Copyright (C) 2013 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * =========================LICENSE_END==================================
- */
-package com.cognifide.apm.core.launchers;
-
-import static com.cognifide.apm.core.scripts.ScriptFilters.onSchedule;
-
-import com.cognifide.apm.api.scripts.LaunchEnvironment;
-import com.cognifide.apm.api.scripts.Script;
-import com.cognifide.apm.api.services.RunModesProvider;
-import com.cognifide.apm.api.services.ScriptFinder;
-import com.cognifide.apm.api.services.ScriptManager;
-import com.cognifide.apm.core.Property;
-import com.cognifide.apm.core.launchers.ScheduledScriptLauncher.ScheduleExecutorConfiguration;
-import com.cognifide.apm.core.services.ResourceResolverProvider;
-import com.cognifide.apm.core.utils.sling.SlingHelper;
-import java.util.Date;
-import java.util.List;
-import org.apache.sling.api.resource.PersistenceException;
-import org.apache.sling.api.resource.ResourceResolver;
-import org.osgi.service.component.annotations.Activate;
-import org.osgi.service.component.annotations.Component;
-import org.osgi.service.component.annotations.Modified;
-import org.osgi.service.component.annotations.Reference;
-import org.osgi.service.metatype.annotations.AttributeDefinition;
-import org.osgi.service.metatype.annotations.Designate;
-import org.osgi.service.metatype.annotations.ObjectClassDefinition;
-
-@Component(
-    property = {
-        Property.DESCRIPTION + "APM Launches scheduled scripts",
-        Property.VENDOR,
-        Property.SCHEDULER + "0 * * * * ?"
-    }
-)
-@Designate(ocd = ScheduleExecutorConfiguration.class)
-public class ScheduledScriptLauncher extends AbstractLauncher implements Runnable {
-
-  @Reference
-  private ScriptManager scriptManager;
-
-  @Reference
-  private ScriptFinder scriptFinder;
-
-  @Reference
-  private RunModesProvider runModesProvider;
-
-  @Reference
-  private ResourceResolverProvider resolverProvider;
-
-  private boolean enabled = true;
-
-  @Activate
-  @Modified
-  public void activate(ScheduleExecutorConfiguration config) {
-    enabled = !config.disableScheduleExecutor();
-  }
-
-  @Override
-  public void run() {
-    if (enabled) {
-      SlingHelper.operateTraced(resolverProvider, this::runScheduled);
-    }
-  }
-
-  private void runScheduled(ResourceResolver resolver) throws PersistenceException {
-    LaunchEnvironment environment = LaunchEnvironment.of(runModesProvider);
-    List<Script> scripts = scriptFinder.findAll(onSchedule(environment, runModesProvider, new Date()), resolver);
-    processScripts(scripts, resolver);
-  }
-
-  @Override
-  public ScriptManager getScriptManager() {
-    return scriptManager;
-  }
-
-  @ObjectClassDefinition(name = "AEM Permission Management - Schedule Launcher Configuration")
-  public @interface ScheduleExecutorConfiguration {
-
-    @AttributeDefinition(name = "Disable Schedule Launcher", defaultValue = "false")
-    boolean disableScheduleExecutor();
-  }
-
-}
\ No newline at end of file
diff --git a/app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptFilters.java b/app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptFilters.java
index ebed1fca3..c5326ce85 100644
--- a/app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptFilters.java
+++ b/app/aem/core/src/main/java/com/cognifide/apm/core/scripts/ScriptFilters.java
@@ -23,7 +23,6 @@
 import com.cognifide.apm.api.scripts.LaunchMode;
 import com.cognifide.apm.api.scripts.Script;
 import com.cognifide.apm.api.services.RunModesProvider;
-import java.util.Date;
 import java.util.Set;
 import java.util.function.Predicate;
 import org.apache.commons.lang3.StringUtils;
@@ -50,18 +49,10 @@ public static Predicate<Script> onInstallIfModified(LaunchEnvironment environmen
         .and(withLaunchHook(currentHook));
   }
 
-  public static Predicate<Script> onSchedule(LaunchEnvironment environment, RunModesProvider runModesProvider, Date date) {
+  public static Predicate<Script> onScheduleOrCronExpression(RunModesProvider runModesProvider) {
     return enabled()
-        .and(withLaunchMode(LaunchMode.ON_SCHEDULE))
-        .and(withLaunchEnvironment(environment))
-        .and(withLaunchRunModes(runModesProvider.getRunModes()))
-        .and(script -> script.getLastExecuted() == null && script.getLaunchSchedule().before(date));
-  }
-
-  public static Predicate<Script> onCronExpression(LaunchEnvironment environment, RunModesProvider runModesProvider) {
-    return enabled()
-        .and(withLaunchMode(LaunchMode.ON_CRON_EXPRESSION))
-        .and(withLaunchEnvironment(environment))
+        .and(withSchedule().or(withCronExpression()))
+        .and(withLaunchEnvironment(runModesProvider))
         .and(withLaunchRunModes(runModesProvider.getRunModes()));
   }
 
@@ -88,16 +79,30 @@ private static Predicate<Script> withLaunchEnvironment(LaunchEnvironment environ
         || environment == script.getLaunchEnvironment();
   }
 
-  private static Predicate<? super Script> withLaunchRunModes(Set<String> runModes) {
+  private static Predicate<Script> withLaunchEnvironment(RunModesProvider runModesProvider) {
+    LaunchEnvironment environment = LaunchEnvironment.of(runModesProvider);
+    return script -> script.getLaunchEnvironment() == LaunchEnvironment.ALL
+        || environment == script.getLaunchEnvironment();
+  }
+
+  private static Predicate<Script> withLaunchRunModes(Set<String> runModes) {
     return script -> script.getLaunchRunModes() == null
         || runModes.containsAll(script.getLaunchRunModes());
   }
 
-  private static Predicate<Script> withLaunchMode(final LaunchMode mode) {
+  private static Predicate<Script> withLaunchMode(LaunchMode mode) {
     return script -> script.getLaunchMode() == mode;
   }
 
+  private static Predicate<Script> withSchedule() {
+    return script -> script.getLaunchMode() == LaunchMode.ON_SCHEDULE && script.getLaunchSchedule() != null;
+  }
+
+  private static Predicate<Script> withCronExpression() {
+    return script -> script.getLaunchMode() == LaunchMode.ON_CRON_EXPRESSION && StringUtils.isNotEmpty(script.getCronExpression());
+  }
+
   private static Predicate<Script> enabled() {
-    return script -> script.isLaunchEnabled();
+    return Script::isLaunchEnabled;
   }
 }
diff --git a/app/aem/core/src/main/java/com/cognifide/apm/core/services/ScriptsResourceChangeListener.java b/app/aem/core/src/main/java/com/cognifide/apm/core/services/ScriptsResourceChangeListener.java
index 90e845599..8efc34cff 100644
--- a/app/aem/core/src/main/java/com/cognifide/apm/core/services/ScriptsResourceChangeListener.java
+++ b/app/aem/core/src/main/java/com/cognifide/apm/core/services/ScriptsResourceChangeListener.java
@@ -1,7 +1,10 @@
 package com.cognifide.apm.core.services;
 
+import static com.cognifide.apm.core.scripts.ScriptFilters.onScheduleOrCronExpression;
+
 import com.cognifide.apm.api.scripts.LaunchMode;
 import com.cognifide.apm.api.scripts.Script;
+import com.cognifide.apm.api.services.RunModesProvider;
 import com.cognifide.apm.api.services.ScriptFinder;
 import com.cognifide.apm.api.services.ScriptManager;
 import com.cognifide.apm.core.Apm;
@@ -24,6 +27,7 @@
 import org.osgi.framework.ServiceRegistration;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
 import org.osgi.service.component.annotations.Reference;
 
 @Component(
@@ -47,6 +51,9 @@ public class ScriptsResourceChangeListener implements ResourceChangeListener {
   @Reference
   private ScriptManager scriptManager;
 
+  @Reference
+  private RunModesProvider runModesProvider;
+
   private Map<String, RegisterScript> registeredScripts;
 
   @Activate
@@ -56,15 +63,18 @@ public void activate() {
     BundleContext bundleContext = currentBundle.getBundleContext();
 
     SlingHelper.operateTraced(resolverProvider, resolver ->
-        scriptFinder.findAll(script -> {
-              LaunchMode launchMode = script.getLaunchMode();
-              return launchMode == LaunchMode.ON_SCHEDULE && script.getLaunchSchedule() != null
-                  || launchMode == LaunchMode.ON_CRON_EXPRESSION && StringUtils.isNotEmpty(script.getCronExpression());
-            }, resolver)
+        scriptFinder.findAll(onScheduleOrCronExpression(runModesProvider), resolver)
             .forEach(script -> registerService(script, bundleContext))
     );
   }
 
+  @Deactivate
+  public void deactivate() {
+    registeredScripts.values()
+        .forEach(registeredScript -> registeredScript.registration.unregister());
+    registeredScripts.clear();
+  }
+
   @Override
   public void onChange(List<ResourceChange> list) {
     Bundle currentBundle = FrameworkUtil.getBundle(ScriptsResourceChangeListener.class);
@@ -76,7 +86,7 @@ public void onChange(List<ResourceChange> list) {
             .forEach(resourceChange -> {
               if (resourceChange.getType() == ResourceChange.ChangeType.ADDED) {
                 Script script = scriptFinder.find(resourceChange.getPath(), resolver);
-                if (script != null) {
+                if (onScheduleOrCronExpression(runModesProvider).test(script)) {
                   registerService(script, bundleContext);
                 }
               } else if (resourceChange.getType() == ResourceChange.ChangeType.REMOVED) {
@@ -88,7 +98,7 @@ public void onChange(List<ResourceChange> list) {
               } else if (resourceChange.getType() == ResourceChange.ChangeType.CHANGED) {
                 Script script = scriptFinder.find(resourceChange.getPath(), resolver);
                 RegisterScript registeredScript = registeredScripts.get(resourceChange.getPath());
-                if (script != null && !Objects.equals(script, registeredScript.script)) {
+                if (onScheduleOrCronExpression(runModesProvider).test(script) && !Objects.equals(script, registeredScript.script)) {
                   registeredScript.registration.unregister();
                   registeredScripts.remove(resourceChange.getPath());
                   registerService(script, bundleContext);
@@ -111,11 +121,11 @@ private void registerService(Script script, BundleContext bundleContext) {
     registeredScripts.put(script.getPath(), new RegisterScript(script, registration));
   }
 
-  private class RegisterScript {
+  private static class RegisterScript {
 
-    private Script script;
+    private final Script script;
 
-    private ServiceRegistration<Runnable> registration;
+    private final ServiceRegistration<Runnable> registration;
 
     public RegisterScript(Script script, ServiceRegistration<Runnable> registration) {
       this.script = script;