forked from robfig/cron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cron.go
419 lines (358 loc) · 8.92 KB
/
cron.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
package cron
import (
"log"
"runtime"
"sort"
"time"
)
// Cron keeps track of any number of entries, invoking the associated func as
// specified by the schedule. It may be started, stopped, and the entries may
// be inspected while running.
type Cron struct {
id int32
entries []*Entry
stop chan struct{}
add chan *Entry
snapshot chan []*Entry
remove chan int32
running bool
ErrorLog *log.Logger
location *time.Location
}
// Job is an interface for submitted cron jobs.
type Job interface {
Run(...interface{})
}
// The Schedule describes a job's duty cycle.
type Schedule interface {
// Return the next activation time, later than the given time.
// Next is invoked initially, and then each time the job is run.
Next(time.Time) time.Time
}
// Entry consists of a schedule and the func to execute on that schedule.
type Entry struct {
// The schedule on which this job should be run.
Schedule Schedule
// The next time the job will run. This is the zero time if Cron has not been
// started or this entry's schedule is unsatisfiable
Next time.Time
// The last time this job was run. This is the zero time if the job has never
// been run.
Prev time.Time
// The Job to run.
Job Job
// entry id
Id int32
// args
ArgLen int32
// tag for running
Tag string
//
Task string
//
Params string
}
// byTime is a wrapper for sorting the entry array by time
// (with zero time at the end).
type byTime []*Entry
func (s byTime) Len() int { return len(s) }
func (s byTime) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s byTime) Less(i, j int) bool {
// Two zero times should return false.
// Otherwise, zero is "greater" than any other time.
// (To sort it at the end of the list.)
if s[i].Next.IsZero() {
return false
}
if s[j].Next.IsZero() {
return true
}
return s[i].Next.Before(s[j].Next)
}
// New returns a new Cron job runner, in the Local time zone.
func New() *Cron {
return NewWithLocation(time.Now().Location())
}
// NewWithLocation returns a new Cron job runner.
func NewWithLocation(location *time.Location) *Cron {
return &Cron{
id: 0,
entries: nil,
add: make(chan *Entry),
stop: make(chan struct{}),
snapshot: make(chan []*Entry),
remove: make(chan int32),
running: false,
ErrorLog: nil,
location: location,
}
}
// A wrapper that turns a func() into a cron.Job
type FuncJob func(...interface{})
// func (f FuncJob) Run() { f() }
func (f FuncJob) Run(i...interface{}) { f(i...) }
// AddFunc adds a func to the Cron to be run on the given schedule.
func (c *Cron) AddFunc(spec string, cmd func(...interface{})) error {
return c.AddJob(spec, FuncJob(cmd))
}
func (c *Cron) AddFunc3(spec string, cmd func(...interface{}), n int32) error {
return c.AddJob(spec, FuncJob(cmd), n)
}
func (c *Cron) AddFunc4(spec string, cmd func(...interface{}), n int32, tag string) error {
return c.AddJob(spec, FuncJob(cmd), n, tag)
}
func (c *Cron) AddFunc5(spec string, cmd func(...interface{}), n int32, tag string, task string) error {
return c.AddJob(spec, FuncJob(cmd), n, tag, task)
}
func (c *Cron) AddFunc6(spec string, cmd func(...interface{}), n int32, tag string, task string, params string) error {
return c.AddJob(spec, FuncJob(cmd), n, tag, task, params)
}
// AddJob adds a Job to the Cron to be run on the given schedule.
func (c *Cron) AddJob(spec string, cmd Job, extArgs ...interface{}) error {
schedule, err := Parse(spec)
if err != nil {
return err
}
c.Schedule(schedule, cmd, extArgs)
return nil
}
// Schedule adds a Job to the Cron to be run on the given schedule.
func (c *Cron) Schedule(schedule Schedule, cmd Job, extArgs ...interface{}) {
entry := &Entry{
Schedule: schedule,
Job: cmd,
}
extArgsInner := extArgs[0].([]interface{})
switch len(extArgsInner) {
case 1:
entry.ArgLen = extArgsInner[0].(int32)
case 2:
entry.ArgLen = extArgsInner[0].(int32)
entry.Tag = extArgsInner[1].(string)
case 3:
entry.ArgLen = extArgsInner[0].(int32)
entry.Tag = extArgsInner[1].(string)
entry.Task = extArgsInner[2].(string)
case 4:
entry.ArgLen = extArgsInner[0].(int32)
entry.Tag = extArgsInner[1].(string)
entry.Task = extArgsInner[2].(string)
entry.Params = extArgsInner[3].(string)
}
if !c.running {
entry.Id = c.nextId()
c.entries = append(c.entries, entry)
return
}
c.add <- entry
}
// Entries returns a snapshot of the cron entries.
func (c *Cron) Entries() []*Entry {
if c.running {
c.snapshot <- nil
x := <-c.snapshot
return x
}
return c.entrySnapshot()
}
// Location gets the time zone location
func (c *Cron) Location() *time.Location {
return c.location
}
// Start the cron scheduler in its own go-routine, or no-op if already started.
func (c *Cron) Start() {
if c.running {
return
}
c.running = true
go c.run()
}
// Run the cron scheduler, or no-op if already running.
func (c *Cron) Run() {
if c.running {
return
}
c.running = true
c.run()
}
func (c *Cron) runWithRecovery(j Job, args ...interface{}) {
defer func() {
if r := recover(); r != nil {
const size = 64 << 10
buf := make([]byte, size)
buf = buf[:runtime.Stack(buf, false)]
c.logf("cron: panic running job: %v\n%s", r, buf)
}
}()
j.Run(args...)
}
// Run the scheduler. this is private just due to the need to synchronize
// access to the 'running' state variable.
func (c *Cron) run() {
// Figure out the next activation times for each entry.
now := c.now()
for _, entry := range c.entries {
entry.Next = entry.Schedule.Next(now)
}
for {
// Determine the next entry to run.
sort.Sort(byTime(c.entries))
var timer *time.Timer
if len(c.entries) == 0 || c.entries[0].Next.IsZero() {
// If there are no entries yet, just sleep - it still handles new entries
// and stop requests.
timer = time.NewTimer(100000 * time.Hour)
} else {
timer = time.NewTimer(c.entries[0].Next.Sub(now))
}
for {
select {
case now = <-timer.C:
now = now.In(c.location)
// Run every entry whose next time was less than now
for _, e := range c.entries {
if e.Next.After(now) || e.Next.IsZero() {
break
}
switch e.ArgLen {
case 0:
go c.runWithRecovery(e.Job)
case 1:
go c.runWithRecovery(e.Job, e.Id)
case 2:
go c.runWithRecovery(e.Job, e.Id, e.Tag)
case 3:
go c.runWithRecovery(e.Job, e.Id, e.Tag, e.Task)
case 4:
go c.runWithRecovery(e.Job, e.Id, e.Tag, e.Task, e.Params)
}
e.Prev = e.Next
e.Next = e.Schedule.Next(now)
}
case newEntry := <-c.add:
timer.Stop()
now = c.now()
newEntry.Next = newEntry.Schedule.Next(now)
newEntry.Id = c.nextId()
c.entries = append(c.entries, newEntry)
case <-c.snapshot:
c.snapshot <- c.entrySnapshot()
continue
case targetId := <-c.remove:
timer.Stop()
if len(c.entries) <= 0 {
continue
}
if targetId >= 0 {
newEntrys := []*Entry{}
for _,v := range c.entries {
if targetId != v.Id {
newEntrys = append(newEntrys, v)
}
}
c.entries = newEntrys
} else if -1 == targetId {
c.entries = []*Entry{}
} else if -2 == targetId {
c.entries = c.entries[1:]
} else if -3 == targetId {
c.entries = c.entries[:len(c.entries)-1]
}
case <-c.stop:
timer.Stop()
return
}
break
}
}
}
// Logs an error to stderr or to the configured error log
func (c *Cron) logf(format string, args ...interface{}) {
if c.ErrorLog != nil {
c.ErrorLog.Printf(format, args...)
} else {
log.Printf(format, args...)
}
}
// Stop stops the cron scheduler if it is running; otherwise it does nothing.
func (c *Cron) Stop() {
if !c.running {
return
}
c.stop <- struct{}{}
c.running = false
}
// remove all jobs
func (c *Cron) RemoveAll() {
if !c.running {
c.entries = []*Entry{}
return
}
c.remove <- -1
}
// remove spec id
func (c *Cron) Remove(id int32) {
if !c.running {
if len(c.entries) <= 0 {
return
}
newEntrys := []*Entry{}
if id >= 0 {
for _,v := range c.entries {
if id != v.Id {
newEntrys = append(newEntrys, v)
}
}
}
c.entries = newEntrys
return
}
c.remove <- id
}
// remove top
func (c *Cron) RemoveFirst() {
if !c.running {
if len(c.entries) <= 0 {
return
}
c.entries = c.entries[1:]
return
}
c.remove <- -2
}
// remove top
func (c *Cron) RemoveLast() {
if !c.running {
if len(c.entries) <= 0 {
return
}
c.entries = c.entries[:len(c.entries)-1]
return
}
c.remove <- -3
}
// entrySnapshot returns a copy of the current cron entry list.
func (c *Cron) entrySnapshot() []*Entry {
entries := []*Entry{}
for _, e := range c.entries {
entries = append(entries, &Entry{
Schedule: e.Schedule,
Next: e.Next,
Prev: e.Prev,
Job: e.Job,
Id: e.Id,
ArgLen: e.ArgLen,
Tag: e.Tag,
})
}
return entries
}
// now returns current time in c location
func (c *Cron) now() time.Time {
return time.Now().In(c.location)
}
func (c *Cron) nextId() int32 {
oid := c.id
c.id = c.id + 1
return oid
}