implemented small scheduler engine

scm-webapp/src/main/java/sonia/scm/ScmContextListener.java

@@ -60,6 +60,7 @@ import java.util.List;
 import javax.servlet.ServletContext;
 import javax.servlet.ServletContextEvent;
 import sonia.scm.repository.HealthCheckContextListener;
+import sonia.scm.schedule.Scheduler;
 
 /**
  *
@@ -79,6 +80,8 @@ public class ScmContextListener extends GuiceServletContextListener
   {
     if ((globalInjector != null) &&!startupError)
     {
+      // close Scheduler
+      IOUtil.close(globalInjector.getInstance(Scheduler.class));
 
       // close RepositoryManager
       IOUtil.close(globalInjector.getInstance(RepositoryManager.class));

scm-webapp/src/main/java/sonia/scm/ScmServletModule.java

@@ -164,6 +164,8 @@ import sonia.scm.net.ahc.ContentTransformer;
 import sonia.scm.net.ahc.DefaultAdvancedHttpClient;
 import sonia.scm.net.ahc.JsonContentTransformer;
 import sonia.scm.net.ahc.XmlContentTransformer;
+import sonia.scm.schedule.QuartzScheduler;
+import sonia.scm.schedule.Scheduler;
 import sonia.scm.security.XsrfProtectionFilter;
 import sonia.scm.web.UserAgentParser;
 
@@ -282,6 +284,9 @@ public class ScmServletModule extends ServletModule
     bind(PluginLoader.class).toInstance(pluginLoader);
     bind(PluginManager.class, DefaultPluginManager.class);
 
+    // bind scheduler
+    bind(Scheduler.class).to(QuartzScheduler.class);
+    
     // note CipherUtil uses an other generator
     bind(KeyGenerator.class).to(DefaultKeyGenerator.class);
     bind(CipherHandler.class).toInstance(cu.getCipherHandler());

scm-webapp/src/main/java/sonia/scm/schedule/InjectionEnabledJob.java

@@ -0,0 +1,90 @@
+/***
+ * Copyright (c) 2015, Sebastian Sdorra
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * https://bitbucket.org/sdorra/scm-manager
+ * 
+ */
+
+package sonia.scm.schedule;
+
+import com.google.common.base.Preconditions;
+import com.google.inject.Injector;
+import com.google.inject.Provider;
+import org.quartz.Job;
+import org.quartz.JobDataMap;
+import org.quartz.JobDetail;
+import org.quartz.JobExecutionContext;
+import org.quartz.JobExecutionException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.web.security.AdministrationContext;
+import sonia.scm.web.security.PrivilegedAction;
+
+/**
+ * InjectionEnabledJob allows the execution of quartz jobs and enable injection on them.
+ * 
+ * @author Sebastian Sdorra <sebastian.sdorra@triology.de>
+ * @since 1.47
+ */
+public class InjectionEnabledJob implements Job {
+
+    private static final Logger logger = LoggerFactory.getLogger(InjectionEnabledJob.class);
+  
+    @Override
+    public void execute(JobExecutionContext jec) throws JobExecutionException {
+        Preconditions.checkNotNull(jec, "execution context is null");
+      
+        JobDetail detail = jec.getJobDetail();
+        Preconditions.checkNotNull(detail, "job detail not provided");
+        
+        JobDataMap dataMap = detail.getJobDataMap();
+        Preconditions.checkNotNull(dataMap, "job detail does not contain data map");
+        
+        Injector injector = (Injector) dataMap.get(Injector.class.getName());
+        Preconditions.checkNotNull(injector, "data map does not contain injector");
+           
+        final Provider<Runnable> runnableProvider = (Provider<Runnable>) dataMap.get(Runnable.class.getName());
+        if (runnableProvider == null) {
+            throw new JobExecutionException("could not find runnable provider");
+        }
+
+        AdministrationContext ctx = injector.getInstance(AdministrationContext.class);
+        ctx.runAsAdmin(new PrivilegedAction()
+        {
+          @Override
+          public void run()
+          {
+            logger.trace("create runnable from provider");
+            Runnable runnable = runnableProvider.get();
+            logger.debug("execute injection enabled job {}", runnable.getClass());
+            runnable.run();
+          }
+        });
+    }
+
+
+}

scm-webapp/src/main/java/sonia/scm/schedule/QuartzScheduler.java

@@ -0,0 +1,175 @@
+/***
+ * Copyright (c) 2015, Sebastian Sdorra
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * https://bitbucket.org/sdorra/scm-manager
+ * 
+ */
+
+package sonia.scm.schedule;
+
+import com.google.common.base.Throwables;
+import com.google.inject.Injector;
+import com.google.inject.Provider;
+import com.google.inject.Singleton;
+import java.io.IOException;
+import javax.inject.Inject;
+import org.quartz.CronScheduleBuilder;
+import org.quartz.JobBuilder;
+import org.quartz.JobDataMap;
+import org.quartz.JobDetail;
+import org.quartz.SchedulerException;
+import org.quartz.Trigger;
+import org.quartz.TriggerBuilder;
+import org.quartz.impl.StdSchedulerFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.Initable;
+import sonia.scm.SCMContextProvider;
+
+/**
+ * {@link Scheduler} which uses the quartz scheduler.
+ * 
+ * @author Sebastian Sdorra
+ * @since 1.47
+ * 
+ * @see <a href="http://www.quartz-scheduler.org/">Quartz Job Scheduler</a>
+ */
+@Singleton
+public class QuartzScheduler implements Scheduler, Initable {
+  
+  private static final Logger logger = LoggerFactory.getLogger(QuartzScheduler.class);
+  
+  private final Injector injector;
+  private final org.quartz.Scheduler scheduler;
+
+  /**
+   * Creates a new quartz scheduler.
+   * 
+   * @param injector injector
+   */
+  @Inject
+  public QuartzScheduler(Injector injector)
+  {
+    this.injector = injector;
+    
+    // get default scheduler
+    try {
+        scheduler = StdSchedulerFactory.getDefaultScheduler();
+    } catch (SchedulerException ex) {
+        throw Throwables.propagate(ex);
+    }
+  }
+
+  /**
+   * Creates a new quartz scheduler. This constructor is only for testing.
+   * 
+   * @param injector injector
+   * @param scheduler quartz scheduler
+   */
+  QuartzScheduler(Injector injector, org.quartz.Scheduler scheduler)
+  {
+    this.injector = injector;
+    this.scheduler = scheduler;
+  }
+  
+  @Override
+  public void init(SCMContextProvider context)
+  {
+    try 
+    {
+      if (!scheduler.isStarted())
+      {
+        scheduler.start();
+      }
+    } 
+    catch (SchedulerException ex)
+    {
+      logger.error("can not start scheduler", ex);
+    }
+  }
+
+  @Override
+  public void close() throws IOException
+  {
+    try
+    {
+      if (scheduler.isStarted()){
+        scheduler.shutdown();
+      }
+    } 
+    catch (SchedulerException ex)
+    {
+      logger.error("can not stop scheduler", ex);
+    }
+  }
+  
+  @Override
+  public Task schedule(String expression, final Runnable runnable)
+  {
+    return schedule(expression, new Provider<Runnable>(){
+      @Override
+      public Runnable get()
+      {
+        return runnable;
+      }
+    });
+  }
+
+  @Override
+  public Task schedule(String expression, Class<? extends Runnable> runnable)
+  {
+    return schedule(expression, injector.getProvider(runnable));
+  }
+
+  private Task schedule(String expression, Provider<? extends Runnable> provider){
+    // create data map with injection provider for InjectionEnabledJob
+    JobDataMap map = new JobDataMap();
+    map.put(Runnable.class.getName(), provider);
+    map.put(Injector.class.getName(), injector);
+
+    // create job detail for InjectionEnabledJob with the provider for the annotated class
+    JobDetail detail = JobBuilder.newJob(InjectionEnabledJob.class)
+            .usingJobData(map)
+            .build();
+
+    // create a trigger with the cron expression from the annotation
+    Trigger trigger = TriggerBuilder.newTrigger()
+            .forJob(detail)
+            .withSchedule(CronScheduleBuilder.cronSchedule(expression))
+            .build();
+
+    try {
+        scheduler.scheduleJob(detail, trigger);
+    } catch (SchedulerException ex) {
+        throw Throwables.propagate(ex);
+    }
+    
+    return new QuartzTask(scheduler, trigger.getJobKey());
+  }
+
+
+}

scm-webapp/src/main/java/sonia/scm/schedule/QuartzTask.java

@@ -0,0 +1,68 @@
+/***
+ * Copyright (c) 2015, Sebastian Sdorra
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * https://bitbucket.org/sdorra/scm-manager
+ * 
+ */
+
+package sonia.scm.schedule;
+
+import com.google.common.base.Throwables;
+import org.quartz.JobKey;
+import org.quartz.Scheduler;
+import org.quartz.SchedulerException;
+
+/**
+ * Task implementation for the {@link QuartzScheduler}.
+ * 
+ * @author Sebastian Sdorra
+ */
+public class QuartzTask implements Task {
+
+  private final org.quartz.Scheduler scheduler;
+  private final JobKey jobKey;
+
+  QuartzTask(Scheduler scheduler, JobKey jobKey)
+  {
+    this.scheduler = scheduler;
+    this.jobKey = jobKey;
+  }
+  
+  @Override
+  public void cancel()
+  {
+    try
+    {
+      scheduler.deleteJob(jobKey);
+    } 
+    catch (SchedulerException ex)
+    {
+      throw Throwables.propagate(ex);
+    }
+  }
+
+}