Task.pm 5.26 KB
Newer Older
1
2
3
4
5
6
# -*- indent-tabs-mode: nil; -*-
# vim:ft=perl:et:sw=4
# $Id$

# Sympa - SYsteme de Multi-Postage Automatique
#
IKEDA Soji's avatar
IKEDA Soji committed
7
8
# Copyright 2018, 2020 The Sympa Community. See the AUTHORS.md
# file at the top-level directory of this distribution and at
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
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

package Sympa::Spool::Task;

use strict;
use warnings;

use Conf;
use Sympa::List;

use base qw(Sympa::Spool);

sub _directories {
    return {directory => $Conf::Conf{'queuetask'},};
}

use constant _generator => 'Sympa::Task';

use constant _marshal_format => '%ld.%s.%s.%s@%s';
use constant _marshal_keys   => [qw(date label model localpart domainpart)];
use constant _marshal_regexp =>
    qr{\A(\d+)[.](\w*)[.](\w+)[.](?:([^\s\@]*)\@([\w\.\-*]*)|_global)\z};

sub _filter {
    my $self     = shift;
    my $metadata = shift;

    return undef unless $metadata and defined $metadata->{date};
    return 0 if time < $metadata->{date};
    return 1;
}

sub _load {
    my $self = shift;

    unless ($self->{_glob_pattern}) {
        $self->_create_all_tasks();
    }
    $self->SUPER::_load();
}

sub quarantine {
    my $self   = shift;
    my $handle = shift;

    $self->remove($handle);
}

# Private function to create all necessary tasks.
sub _create_all_tasks {
    my $self = shift;

    my $current_date = time;

    my $existing_tasks = $self->_existing_tasks;

    # Create global tasks.
    foreach my $model (keys %{Sympa::Task::site_models()}) {
        next if ${$existing_tasks->{'*'} || {}}{$model};

        my $task = $self->_generator->new(
            context => '*',
            date    => $current_date,
            model   => $model
        );
        next unless $task;
        $self->store($task);
    }

    # Create list tasks.
    foreach my $robot (Sympa::List::get_robots()) {
        my $all_lists = Sympa::List::get_lists($robot);

        foreach my $list (@{$all_lists || []}) {
            foreach my $model (keys %{Sympa::Task::list_models()}) {
                next if ${$existing_tasks->{$list->get_id} || {}}{$model};

                next unless $list->{'admin'}{'status'} eq 'open';
                if ($model eq 'sync_include') {
101
                    # Create tasks only when they are required.
IKEDA Soji's avatar
IKEDA Soji committed
102
103
                    next
                        unless $list->has_data_sources
104
                        or $list->has_included_users;
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
                }

                my $task = $self->_generator->new(
                    context => $list,
                    date    => $current_date,
                    model   => $model
                );
                next unless $task;
                $self->store($task);
            }
        }
    }
}

# Private function to list all existing tasks.
# Old name: Sympa::Task::list_tasks().
sub _existing_tasks {
    my $self = shift;

    my $existing_tasks = {};

    # Get all entries.
    $self->{_metadatas} = $self->SUPER::_load()
        or return {};
    while (1) {
        my ($task, $handle) = $self->next(no_filter => 1, no_lock => 1);

        if ($task and $handle) {
            my $id =
                (ref $task->{context} eq 'Sympa::List')
                ? $task->{context}->get_id
                : '*';
            my $model = $task->{model};

            $existing_tasks->{$id}{$model} = 1;
        } elsif ($handle) {
            next;
        } else {
            last;
        }
    }

    return $existing_tasks;
}

1;
__END__

=encoding utf-8

=head1 NAME

Sympa::Spool::Task - Spool for tasks

=head1 SYNOPSIS

  use Sympa::Spool::Task;
  my $spool = Sympa::Spool::Task->new;

  $spool->store($task);

  my ($task, $handle) = $spool->next;

=head1 DESCRIPTION

L<Sympa::Spool::Task> implements the spool for tasks.

=head2 Methods

See also L<Sympa::Spool/"Public methods">.

=over

=item next ( [ no_filter =E<gt> 1 ], [ no_lock =E<gt> 1 ] )

Order is controlled by date element of file name.
if C<no_filter> is I<not> set,
messages with date newer than current time are skipped.

All necessary tasks are created and stored into spool in advance.

=item quarantine ( $handle )

Removes a task: The same as remove().
This spool does not have C<bad/> subdirectory.

=back

=head2 Context and metadata

See also L<Sympa::Spool/"Marshaling and unmarshaling metadata">.

This class particularly gives following metadata:

=over

=item {date}

Unix time when task will be executed at the next time.

=item {label}

=item {model}

TBD.

=back

=head1 CONFIGURATION PARAMETERS

Following site configuration parameters in sympa.conf will be referred.

=over

=item queuetask

Directory path of task spool.

=back

=head1 SEE ALSO

L<task_manager(8)>, L<Sympa::Spool>, L<Sympa::Task>.

=head1 HISTORY

IKEDA Soji's avatar
IKEDA Soji committed
231
L<Sympa::Spool::Task> appeared on Sympa 6.2.37b.2.
232
233

=cut