openwferu-scheduler 0.9.15.1110 → 0.9.15.1127

data/lib/openwfe/util/scheduler.rb

@@ -1,4 +1,4 @@
-#
+
 #--
 # Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
@@ -102,8 +102,7 @@ module OpenWFE
     # This attribute is best used indirectly : the method 
     # join_until_no_more_jobs() wraps it.
     #
-    # Since OpenWFEru 0.9.13, the :scheduler_precision can be set when
-    # instantiating the scheduler.
+    # The :scheduler_precision can be set when instantiating the scheduler.
     #
     #     scheduler = OpenWFE::Scheduler.new(:scheduler_precision => 0.500)
     #     scheduler.start
@@ -111,6 +110,29 @@ module OpenWFE
     #         # instatiates a scheduler that checks its jobs twice per second
     #         # (the default is 4 times per second (0.250))
     #
+    #
+    # Since OpenWFEru 0.9.16, tags can be attached to jobs scheduled :
+    #
+    #     scheduler.schedule_in "2h", :tags => "backup" do
+    #         init_backup_sequence()
+    #     end
+    #
+    #     scheduler.schedule "0 24 * * *", :tags => "new_day" do
+    #         do_this_or_that()
+    #     end
+    #
+    #     jobs = find_jobs 'backup'
+    #
+    # Multiple tags may be attached to a single job :
+    #
+    #     scheduler.schedule_in "2h", :tags => [ "backup", "important" ]  do
+    #         init_backup_sequence()
+    #     end
+    #
+    # The vanilla case for tags assume they are String instances, but nothing
+    # prevents you from using anything else. The scheduler has no persistence
+    # by itself, so no serialization issue.
+    #
     class Scheduler
         include MonitorMixin
 
@@ -131,7 +153,7 @@ module OpenWFE
             super()
 
             @pending_jobs = []
-            @cron_entries = {}
+            @cron_jobs = {}
 
             @scheduler_thread = nil
 
@@ -161,8 +183,11 @@ module OpenWFE
             @scheduler_thread = Thread.new do
 
                 if defined?(JRUBY_VERSION)
+
                     require 'java'
-                    java.lang.Thread.current_thread.name = "openwferu scheduler (Ruby Thread)"
+
+                    java.lang.Thread.current_thread.name = \
+                        "openwferu scheduler (Ruby Thread)"
                 end
 
                 while true
@@ -298,7 +323,7 @@ module OpenWFE
             synchronize do
 
                 for i in 0...@pending_jobs.length
-                    if @pending_jobs[i].eid == job_id
+                    if @pending_jobs[i].job_id == job_id
                         @pending_jobs.delete_at i
                         return true
                     end
@@ -313,8 +338,8 @@ module OpenWFE
         #
         def unschedule_cron_job (job_id)
             synchronize do
-                if @cron_entries.has_key?(job_id)
-                    @cron_entries.delete job_id
+                if @cron_jobs.has_key?(job_id)
+                    @cron_jobs.delete job_id
                     return true
                 end
                 false
@@ -359,28 +384,30 @@ module OpenWFE
 
                 unschedule(cron_id) if cron_id
 
+                tags = params[:tags]
+
                 #
                 # schedule
 
                 b = to_block(params, &block)
-                entry = CronEntry.new(cron_id, cron_line, &b)
-                @cron_entries[entry.eid] = entry
+                job = CronJob.new(cron_id, cron_line, tags, &b)
+                @cron_jobs[job.job_id] = job
 
-                entry.eid
+                job.job_id
             end
         end
 
         #
-        # Returns the job corresponding to job_id, an instance of AtEntry
-        # or CronEntry will be returned.
+        # Returns the job corresponding to job_id, an instance of AtJob
+        # or CronJob will be returned.
         #
         def get_job (job_id)
 
-            entry = @cron_entries[job_id]
-            return entry if entry
+            job = @cron_jobs[job_id]
+            return job if job
 
-            @pending_jobs.find do |entry|
-                entry.eid == job_id
+            @pending_jobs.find do |job|
+                job.job_id == job_id
             end
         end
 
@@ -394,11 +421,44 @@ module OpenWFE
 
             j = get_job(job_id)
 
-            return j.schedulable if j.respond_to? :schedulable
+            return j.schedulable if j.respond_to?(:schedulable)
 
             nil
         end
 
+        #
+        # Returns an array of jobs that have the given tag.
+        #
+        def find_jobs (tag)
+
+            result = @cron_jobs.values.find_all do |job|
+                job.has_tag?(tag)
+            end
+
+            result + @pending_jobs.find_all do |job|
+                job.has_tag?(tag)
+            end
+        end
+
+        #
+        # Finds the jobs with the given tag and then returns an array of 
+        # the wrapped Schedulable objects.
+        # Jobs that haven't a wrapped Schedulable won't be included in the
+        # result.
+        #
+        def find_schedulables (tag)
+
+            jobs = find_jobs(tag)
+
+            result = []
+
+            jobs.each do |job|
+                result.push(job.schedulable) if job.respond_to?(:schedulable)
+            end
+
+            result
+        end
+
         #
         # Returns the number of currently pending jobs in this scheduler
         # ('at' jobs and 'every' jobs).
@@ -411,21 +471,21 @@ module OpenWFE
         # Returns the number of cron jobs currently active in this scheduler.
         #
         def cron_job_count
-            @cron_entries.size
+            @cron_jobs.size
         end
 
         #
         # Returns the current count of 'every' jobs scheduled.
         #
         def every_job_count
-            @pending_jobs.select { |j| j.is_a?(EveryEntry) }.size
+            @pending_jobs.select { |j| j.is_a?(EveryJob) }.size
         end
 
         #
         # Returns the current count of 'at' jobs scheduled (not 'every').
         #
         def at_job_count
-            @pending_jobs.select { |j| j.instance_of?(AtEntry) }.size
+            @pending_jobs.select { |j| j.instance_of?(AtJob) }.size
         end
 
         #
@@ -467,15 +527,16 @@ module OpenWFE
                     #puts "1 at is '#{at.to_s}' (#{at.class})"}"
 
                     jobClass = if params[:every]
-                        EveryEntry
+                        EveryJob
                     else
-                        AtEntry
+                        AtJob
                     end
 
                     job_id = params[:job_id]
+                    tags = params[:tags]
 
                     b = to_block(params, &block)
-                    job = jobClass.new(at, job_id, &b)
+                    job = jobClass.new(at, job_id, tags, &b)
 
                     unschedule(job_id) if job_id 
 
@@ -561,7 +622,7 @@ module OpenWFE
 
                 #puts "push() at '#{Time.at(job.at)}'"
 
-                job.eid
+                job.job_id
             end
 
             #
@@ -587,20 +648,20 @@ module OpenWFE
                     end
 
                     #
-                    # cron entries
+                    # cron jobs
 
                     if now.sec == 0 and now.min != @last_cron_minute
                         #
-                        # only consider cron entries at the second 0 of a 
+                        # only consider cron jobs at the second 0 of a 
                         # minute
 
                         @last_cron_minute = now.min
 
-                        #puts "step() @cron_entries.size #{@cron_entries.size}"
+                        #puts "step() @cron_jobs.size #{@cron_jobs.size}"
 
-                        @cron_entries.each do |cron_id, cron_entry|
+                        @cron_jobs.each do |cron_id, cron_job|
                             #puts "step() cron_id : #{cron_id}"
-                            trigger(cron_entry) if cron_entry.matches?(now)
+                            trigger(cron_job) if cron_job.matches?(now)
                         end
                     end
 
@@ -635,11 +696,11 @@ module OpenWFE
                 end
             end
 
-            def trigger (entry)
+            def trigger (job)
 
                 Thread.new do
                     begin
-                        entry.trigger
+                        job.trigger
                     rescue Exception => e
                         message =
                             "trigger() caught exception\n" + 
@@ -672,8 +733,11 @@ module OpenWFE
     protected
 
         JOB_ID_LOCK = Monitor.new
+            #
+            # would it be better to use a Mutex instead of a full-blown
+            # Monitor ?
 
-        class Entry
+        class Job
 
             @@last_given_id = 0
                 #
@@ -681,51 +745,60 @@ module OpenWFE
                 # have persistent ids, a simple counter is sufficient
 
             attr_accessor \
-                :eid, :block
+                :job_id, :tags, :block 
+            
+            def initialize (job_id, tags, &block)
 
-            def initialize (entry_id=nil, &block)
                 @block = block
-                if entry_id
-                    @eid = entry_id
+
+                if job_id
+                    @job_id = job_id
                 else
                     JOB_ID_LOCK.synchronize do
-                        @eid = @@last_given_id
-                        @@last_given_id = @eid + 1
+                        @job_id = @@last_given_id
+                        @@last_given_id = @job_id + 1
                     end
                 end
+
+                #@tags = Array(tags).collect { |tag| tag.to_s }
+                    # making sure we have an array of String tags
+
+                @tags = Array(tags)
+                    # any tag is OK
             end
 
-            #def trigger
-            #    @block.call @eid
-            #end
+            #
+            # Returns true if this job sports the given tag
+            #
+            def has_tag? (tag)
+                @tags.include?(tag)
+            end
         end
 
-        class AtEntry < Entry
+        class AtJob < Job
 
-            attr_accessor \
-                :at
+            attr_accessor :at
 
-            def initialize (at, at_id, &block)
-                super(at_id, &block)
+            def initialize (at, at_id, tags, &block)
+                super(at_id, tags, &block)
                 @at = at
             end
 
             def trigger
-                @block.call @eid, @at
+                @block.call @job_id, @at
             end
         end
 
-        class EveryEntry < AtEntry
+        class EveryJob < AtJob
         end
 
-        class CronEntry < Entry
+        class CronJob < Job
 
-            attr_accessor \
-                :cron_line
+            attr_accessor :cron_line
 
-            def initialize (cron_id, line, &block)
+            def initialize (cron_id, line, tags, &block)
 
-                super(cron_id, &block)
+                super(cron_id, tags, &block)
 
                 if line.kind_of?(String)
                     @cron_line = CronLine.new(line)
@@ -733,7 +806,7 @@ module OpenWFE
                     @cron_line = line
                 else
                     raise \
-                        "Cannot initialize a CronEntry " +
+                        "Cannot initialize a CronJob " +
                         "with a param of class #{line.class}"
                 end
             end
@@ -743,7 +816,7 @@ module OpenWFE
             end
 
             def trigger
-                @block.call @eid, @cron_line
+                @block.call @job_id, @cron_line
             end
         end
 
@@ -793,7 +866,7 @@ module OpenWFE
                 return false if no_match?(time.month, @months)
                 return false if no_match?(time.wday, @weekdays)
 
-                return true
+                true
             end
 
             #
@@ -835,7 +908,7 @@ module OpenWFE
                         item = item.gsub(day, "#{index+1}")
                     end
 
-                    return parse_item(item, 1, 7)
+                    parse_item(item, 1, 7)
                 end
 
                 def parse_item (item, min, max)
@@ -852,7 +925,7 @@ module OpenWFE
                     i = min if i < min
                     i = max if i > max
 
-                    return [ i ]
+                    [ i ]
                 end
 
                 def parse_list (item, min, max)
@@ -864,7 +937,7 @@ module OpenWFE
                         i = max if i > max
                         result << i
                     end
-                    return result
+                    result
                 end
 
                 def parse_range (item, min, max)
@@ -905,7 +978,7 @@ module OpenWFE
                         break if value > iend
                     end
 
-                    return result
+                    result
                 end
 
                 def no_match? (value, cron_values)
@@ -916,7 +989,7 @@ module OpenWFE
                         return false if value == v
                     end
 
-                    return true
+                    true
                 end
         end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: openwferu-scheduler
 version: !ruby/object:Gem::Version 
-  version: 0.9.15.1110
-date: 2007-09-28 00:00:00 +09:00
+  version: 0.9.15.1127
+date: 2007-10-07 00:00:00 +09:00
 summary: OpenWFEru scheduler for Ruby (at, cron and every)
 require_paths: 
 - lib