include.pm 23.6 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 2019, 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
# <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::Request::Handler::include;

use strict;
use warnings;

use Sympa;
use Sympa::DatabaseManager;
use Sympa::DataSource;
use Sympa::LockedFile;
use Sympa::Log;

use base qw(Sympa::Request::Handler);

my $log = Sympa::Log->instance;

use constant _action_scenario => undef;
use constant _context_class   => 'Sympa::List';

my %config_ca_map = (
    'include_ldap_ca'        => 'Sympa::DataSource::LDAP',
    'include_ldap_2level_ca' => 'Sympa::DataSource::LDAP2',
    'include_sql_ca'         => 'Sympa::DataSource::SQL',
);

my %config_user_map = (
    'include_file'              => 'Sympa::DataSource::File',
    'include_remote_file'       => 'Sympa::DataSource::RemoteFile',
    'include_list'              => 'Sympa::DataSource::List',      # Obsoleted
    'include_sympa_list'        => 'Sympa::DataSource::List',
    'include_remote_sympa_list' => 'Sympa::DataSource::RemoteDump',
    'include_ldap_query'        => 'Sympa::DataSource::LDAP',
    'include_ldap_2level_query' => 'Sympa::DataSource::LDAP2',
    'include_sql_query'         => 'Sympa::DataSource::SQL',
);

IKEDA Soji's avatar
IKEDA Soji committed
59
# Internal function.
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
sub _get_data_sources {
    my $list = shift;
    my $role = shift;

    my @dss;

    if ($role eq 'custom_attribute') {
        foreach my $ptype (sort keys %config_ca_map) {
            my @config = grep {$_} @{$list->{'admin'}{$ptype} || []};
            my $type = $config_ca_map{$ptype};
            push @dss, map {
                Sympa::DataSource->new($type, $role, context => $list, %$_)
            } @config;
        }
    } elsif ($role eq 'member') {
75
        #FIXME: Use Sympa::Config.
76
77
78
79
80
81
82
83
84
85
        my @config_files = map { $list->_load_include_admin_user_file($_) }
            @{$list->{'admin'}{'member_include'} || []};

        foreach my $ptype (sort keys %config_user_map) {
            my @config = grep {$_} (
                @{$list->{'admin'}{$ptype} || []},
                map { @{$_->{$ptype} || []} } @config_files
            );
            # Special case: include_file is not paragraph.
            if ($ptype eq 'include_file') {
86
87
88
89
                @config = map {
                    my $name = substr [split m{/}, $_]->[-1], 0, 15;
                    {name => $name, path => $_};
                } @config;
90
91
92
93
94
95
96
97
            }
            my $type = $config_user_map{$ptype};
            push @dss, map {
                Sympa::DataSource->new($type, $role, context => $list, %$_)
            } @config;
        }
    } else {
        my $pname = ($role eq 'owner') ? 'owner_include' : 'editor_include';
98
        #FIXME: Use Sympa::Config.
99
100
101
102
103
104
105
106
        my @config_files = map { $list->_load_include_admin_user_file($_) }
            @{$list->{'admin'}{$pname} || []};

        foreach my $ptype (sort keys %config_user_map) {
            my @config = grep {$_}
                map { @{$_->{$ptype} || []} } @config_files;
            # Special case: include_file is not paragraph.
            if ($ptype eq 'include_file') {
107
108
109
110
                @config = map {
                    my $name = substr [split m{/}, $_]->[-1], 0, 15;
                    {name => $name, path => $_};
                } @config;
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
            }
            my $type = $config_user_map{$ptype};
            push @dss, map {
                Sympa::DataSource->new($type, $role, context => $list, %$_)
            } @config;
        }
    }

    return [@dss];
}

sub _twist {
    my $self    = shift;
    my $request = shift;

    my $list = $request->{context};
    my $role = $request->{role};

    die 'bug in logic. Ask developer'
130
131
132
133
134
        unless $role and grep { $role eq $_ } qw(member owner editor);

    return 0
        unless $list->has_data_sources($role)
        or $list->has_included_users($role);
135
136
137
138

    my $dss = _get_data_sources($list, $role);

    # Get an Exclusive lock.
139
140
    my $lock_file = $list->{'dir'} . '/' . $role . '.include';
    my $lock_fh = Sympa::LockedFile->new($lock_file, -1, '+>>');
141
    unless ($lock_fh) {
142
143
        $log->syslog('info', '%s: Locked, skip inclusion', $list);
        $self->add_stash($request, 'notice', 'include_skip',
144
            {listname => $list->{'name'}, role => $role});
145
146
147
        return 0;
    }

IKEDA Soji's avatar
IKEDA Soji committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    # I. Start.

    my (%start_times, $last_start_time, $start_time);
    seek $lock_fh, 0, 0;
    while (my $line = <$lock_fh>) {
        next unless $line =~ /\A(\w+)\s+(\d+)/;
        my $t = $2 + 0;
        $start_times{$1} = $t;

        $last_start_time = $t
            if not defined $last_start_time or $t < $last_start_time;
    }
    $start_time = time;
    if (defined $last_start_time and $start_time < $last_start_time) {
        # Avoid retrace of clock e.g. by outage of NTP server.
        $log->syslog('info', '%s: Clock got behind, skip inclusion', $list);
        $self->add_stash($request, 'notice', 'include_skip',
165
            {listname => $list->{'name'}, role => $role});
IKEDA Soji's avatar
IKEDA Soji committed
166
167
168
        return 0;
    }

169
    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
170
    return undef unless $sdm;
171
    my $sth;
172
173
174
175
    my ($t, $r) =
          ($role eq 'member')
        ? ('subscriber', '')
        : ('admin', sprintf ' AND role_admin = %s', $sdm->quote($role));
176

177
178
    # II. Include new entries.

179
180
    my %result =
        (added => 0, deleted => 0, updated => 0, kept => 0, held => 0);
181
182
183
    foreach my $ds (@{$dss || []}) {
        $lock_fh->extend;

184
        next unless $ds->is_allowed_to_sync;
IKEDA Soji's avatar
IKEDA Soji committed
185
        my %res = _update_users($ds, $start_time);
186
187
188
189
190
191
192
193
194
195
196
197
        unless (%res) {
            $self->add_stash(
                $request, 'notice',
                'include_failed',
                {   listname => $list->{'name'},
                    role     => $role,
                    id       => $ds->get_short_id,
                    name     => $ds->name,
                }
            );
            next;
        }
198
199

        # Update time of allowed and succeeded data sources.
IKEDA Soji's avatar
IKEDA Soji committed
200
201
202
203
204
        $start_times{$ds->get_short_id} = $start_time;

        # Special treatment for Sympa::DataSource::List.
        _update_inclusion_table($ds, $start_time)
            if ref $ds eq 'Sympa::DataSource::List';
205
206
207
208
209
210
211
212
213

        $log->syslog(
            'info', '%s: %d included, %d deleted, %d updated, %d kept',
            $ds,    @res{qw(added deleted updated kept)}
        );
        $self->add_stash(
            $request, 'notice',
            'include',
            {   listname => $list->{'name'},
214
                role     => $role,
215
216
217
                id       => $ds->get_short_id,
                name     => $ds->name,
                result   => {%res}
218
            }
219
220
221
        );
        foreach my $key (keys %res) {
            $result{$key} += $res{$key} if exists $result{$key};
222
        }
223
    }
224

225
226
227
    # III. Expire outdated entries.

    # Choose most earlier time of succeeding inclusions (if any of
228
    # data sources have not succeeded yet, time is not defined).
IKEDA Soji's avatar
IKEDA Soji committed
229
    $last_start_time = $start_time;
230
    foreach my $id (map { $_->get_short_id } @$dss) {
IKEDA Soji's avatar
IKEDA Soji committed
231
232
        unless (defined $start_times{$id}) {
            undef $last_start_time;
233
            last;
IKEDA Soji's avatar
IKEDA Soji committed
234
235
        } elsif ($start_times{$id} < $last_start_time) {
            $last_start_time = $start_times{$id};
236
237
        }
    }
238

IKEDA Soji's avatar
IKEDA Soji committed
239
    if (defined $last_start_time) {
240
        $lock_fh->extend;
IKEDA Soji's avatar
IKEDA Soji committed
241
242
243

        my %res = _expire_users($list, $role, $last_start_time);
        unless (%res) {
IKEDA Soji's avatar
IKEDA Soji committed
244
            $self->add_stash($request, 'intern');
IKEDA Soji's avatar
IKEDA Soji committed
245
            #FIMXE: Report error.
246
247
            return undef;
        }
IKEDA Soji's avatar
IKEDA Soji committed
248
249
        foreach my $key (keys %res) {
            $result{$key} += $res{$key} if exists $result{$key};
250
        }
IKEDA Soji's avatar
IKEDA Soji committed
251

252
        # Special treatment for Sympa::DataSource::List.
IKEDA Soji's avatar
IKEDA Soji committed
253
        _expire_inclusion_table($list, $role, $last_start_time);
254
255
256
257
258
259
260
261
262
263
264
265
266
267
    } else {
        $lock_fh->extend;

        # Estimate number of held users, i.e. users not decided to
        # delete, update nor keep.
        my %res = _expire_users($list, $role, $start_time, dry_run => 1);
        unless (%res) {
            $self->add_stash($request, 'intern');
            #FIMXE: Report error.
            return undef;
        }
        foreach my $key (keys %res) {
            $result{$key} += $res{$key} if exists $result{$key};
        }
IKEDA Soji's avatar
IKEDA Soji committed
268
    }
269

270
    # IV. Update custom attributes.
271

IKEDA Soji's avatar
IKEDA Soji committed
272
    if ($role eq 'member') {
IKEDA Soji's avatar
IKEDA Soji committed
273
274
275
        foreach
            my $ds (@{_get_data_sources($list, 'custom_attribute') || []}) {
            next unless $ds->is_allowed_to_sync;
276

IKEDA Soji's avatar
IKEDA Soji committed
277
278
            $lock_fh->extend;
            _update_custom_attribute($ds);
279
280
281
        }
    }

282
    # V. Finish.
283

284
285
286
287
288
289
    # Write out updated times of succeeding inclusions.
    my $ofh;
    unless (open $ofh, '>', $lock_file . '.new') {
        $log->syslog('err', 'Can\'t open file %s: %m', $lock_file . '.new');
        $self->add_stash($request, 'intern');
        return undef;
290
    }
291
    foreach my $id (map { $_->get_short_id } @$dss) {
IKEDA Soji's avatar
IKEDA Soji committed
292
293
        printf $ofh "%s %d\n", $id, $start_times{$id}
            if defined $start_times{$id};
294
295
296
297
298
299
300
301
302
303
    }
    close $ofh;
    unlink $lock_file . '.old';
    unless ($lock_fh->rename($lock_file . '.old')
        and rename($lock_file . '.new', $lock_file)) {
        $log->syslog('err', 'Can\'t update file %s: %m', $lock_file);
        $self->add_stash($request, 'intern');
        return undef;
    }
    unlink $lock_file . '.old';
304

305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
    if (defined $last_start_time) {
        $log->syslog(
            'info',   '%s: %d added, %d deleted, %d updated',
            $request, @result{qw(added deleted updated)}
        );
        $self->add_stash($request, 'notice', 'include_performed',
            {listname => $list->{'name'}, role => $role, result => {%result}}
        );
    } else {
        $log->syslog(
            'info',   '%s: %d added, %d held, %d updated',
            $request, @result{qw(added held updated)}
        );
        $self->add_stash($request, 'notice', 'include_incomplete',
            {listname => $list->{'name'}, role => $role, result => {%result}}
        );
    }
322
323
324
    return 1;
}

IKEDA Soji's avatar
IKEDA Soji committed
325
326
# Internal function.
sub _update_users {
327
    my $ds         = shift;
IKEDA Soji's avatar
IKEDA Soji committed
328
    my $start_time = shift;
329
330
331
332
333
334

    return unless $ds->open;

    my %result = (added => 0, deleted => 0, updated => 0, kept => 0);
    while (my $entry = $ds->next) {
        my ($email, $other_value) = @$entry;
IKEDA Soji's avatar
IKEDA Soji committed
335
        my %res = __update_user($ds, $email, $other_value, $start_time);
336
337
338

        unless (%res) {
            $ds->close;
IKEDA Soji's avatar
IKEDA Soji committed
339
            $log->syslog('info', '%s: Aborted inclusion', $ds);
340
341
342
343
            return;
        }
        foreach my $res (keys %res) {
            $result{$res} += $res{$res} if exists $result{$res};
344
345
346
347
348
349
350
351
352
        }
    }

    $ds->close;

    return %result;
}

# Internal function.
IKEDA Soji's avatar
IKEDA Soji committed
353
sub __update_user {
354
355
356
    my $ds         = shift;
    my $email      = shift;
    my $gecos      = shift;
IKEDA Soji's avatar
IKEDA Soji committed
357
    my $start_time = shift;
358
359
360

    return (none => 0) unless Sympa::Tools::Text::valid_email($email);
    $email = Sympa::Tools::Text::canonic_email($email);
361
362
363
364
365
366

    my $list = $ds->{context};
    my $role = $ds->role;

    my $time = time;
    # Avoid retrace of clock e.g. by outage of NTP server.
IKEDA Soji's avatar
IKEDA Soji committed
367
    $time = $start_time unless $start_time <= time;
368

369
    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
370
    return undef unless $sdm;
371
372
373
374
375
    my $sth;
    my ($t, $r) =
          ($role eq 'member')
        ? ('subscriber', '')
        : ('admin', sprintf ' AND role_admin = %s', $sdm->quote($role));
376
377
    my $is_external_ds = not(ref $ds eq 'Sympa::DataSource::List'
        and [split /\@/, $ds->{listname}, 2]->[1] eq $list->{'domain'});
378
379
380
381
382
383

    # 1. If role of the data source is 'member' and the user is excluded:
    #    Do nothing.
    return (none => 0)
        if $role eq 'member' and $list->is_member_excluded($email);

384
385
    # 2. If user has already been updated by the other data sources:
    #    Keep user.
386
387
388
389
390
391
392
    if ($is_external_ds) {
        return unless $sth = $sdm->do_prepared_query(
            qq{SELECT COUNT(*)
               FROM ${t}_table
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r AND
                     inclusion_$t IS NOT NULL AND ? <= inclusion_$t AND
                     inclusion_ext_$t IS NOT NULL AND ? <= inclusion_ext_$t},
IKEDA Soji's avatar
IKEDA Soji committed
393
394
395
            $email, $list->{'name'}, $list->{'domain'},
            $start_time,
            $start_time
396
397
398
399
400
401
402
403
        );
    } else {
        return unless $sth = $sdm->do_prepared_query(
            qq{SELECT COUNT(*)
               FROM ${t}_table
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r AND
                     inclusion_$t IS NOT NULL AND ? <= inclusion_$t},
            $email, $list->{'name'}, $list->{'domain'},
IKEDA Soji's avatar
IKEDA Soji committed
404
            $start_time
405
406
        );
    }
407
408
409
    my ($count) = $sth->fetchrow_array;
    $sth->finish;
    return (kept => 1) if $count;
410

411
412
    # 3. If user (has not been updated by the other data sources and) exists:
    #    UPDATE inclusion.
413
    if ($is_external_ds) {
414
415
416
        # Already updated by the other non-external data source but not yet
        # by any other external ones:
        # Update inclusion_ext (and inclusion) field, but not inclusion_label.
417
418
419
420
421
422
423
424
425
426
427
        return unless $sth = $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
               SET inclusion_$t = ?, inclusion_ext_$t = ?
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r AND
                     inclusion_$t IS NOT NULL AND ? <= inclusion_$t},
            $time, $time,
            $email, $list->{'name'}, $list->{'domain'},
            $start_time
        );
        return (updated => 0) if $sth->rows;

428
429
        # Not yet updated by any other data sources:
        # Update inclusion_ext (and inclusion), and assign inclusion_label.
430
431
        return unless $sth = $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
432
               SET inclusion_$t = ?, inclusion_ext_$t = ?,
IKEDA Soji's avatar
IKEDA Soji committed
433
                   inclusion_label_$t = ?
434
435
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r},
            $time, $time,
436
            $ds->name,
437
438
            $email, $list->{'name'}, $list->{'domain'}
        );
439
        return (updated => 1) if $sth->rows;
440
    } else {
441
442
        # Not yet updated by any other data sources:
        # Update inclusion, and assign inclusion_label.
443
444
        return unless $sth = $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
445
446
               SET inclusion_$t = ?,
                   inclusion_label_$t = ?
447
448
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r},
            $time,
449
            $ds->name,
450
451
            $email, $list->{'name'}, $list->{'domain'}
        );
452
        return (updated => 1) if $sth->rows;
453
    }
454
455
456

    # 4. Otherwise, i.e. a new user:
    #    INSERT new user with:
457
458
    #    email, gecos, subscribed=0, date, update, inclusion,
    #    (optional) inclusion_ext, inclusion_label and
459
    #    default attributes.
460
461
    my $user = {
        email       => $email,
462
        gecos       => $gecos,
463
        subscribed  => 0,
464
        date        => $time,
465
        update_date => $time,
466
        inclusion   => $time,
467
        ($is_external_ds ? (inclusion_ext => $time) : ()),
468
        inclusion_label => $ds->name,
469
    };
470
471
    my @defkeys = @{$ds->{_defkeys} || []};
    my @defvals = @{$ds->{_defvals} || []};
472
    @{$user}{@defkeys} = @defvals if @defkeys;
473
474

    if ($role eq 'member') {
475
        $list->add_list_member($user);
476

477
478
479
480
481
        # Send notification if the list config authorizes it only.
        if ($list->{'admin'}{'inclusion_notification_feature'} eq 'on') {
            unless ($list->send_probe_to_user('welcome', $email)) {
                $log->syslog('err',
                    'Unable to send "welcome" probe to %s', $email);
482
483
484
            }
        }
    } else {
485
        $list->add_list_admin($role, $user);
486
    }
487
    return (added => 1);
488
489
}

IKEDA Soji's avatar
IKEDA Soji committed
490
491
492
493
sub _expire_users {
    my $list            = shift;
    my $role            = shift;
    my $last_start_time = shift;
494
    my %options         = @_;
IKEDA Soji's avatar
IKEDA Soji committed
495
496
497
498
499
500
501
502
503

    my $sdm = Sympa::DatabaseManager->instance;
    return unless $sdm;
    my $sth;
    my ($t, $r) =
          ($role eq 'member')
        ? ('subscriber', '')
        : ('admin', sprintf ' AND role_admin = %s', $sdm->quote($role));

504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
    if ($options{dry_run}) {
        unless (
            $sth = $sdm->do_prepared_query(
                qq{SELECT COUNT(*)
               FROM ${t}_table
               WHERE (subscribed_$t IS NULL OR subscribed_$t <> 1) AND
                     inclusion_$t IS NOT NULL AND inclusion_$t < ? AND
                     list_$t = ? AND robot_$t = ?$r},
                $last_start_time,
                $list->{'name'}, $list->{'domain'}
            )
        ) {
            return undef;
        }
        my ($count) = $sth->fetchrow_array;
        $sth->finish;

        return (held => ($count || 0));
    }

IKEDA Soji's avatar
IKEDA Soji committed
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
    my $deleted = 0;
    # Remove list users not subscribing (only included) and
    # not included anymore.
    unless (
        $sth = $sdm->do_prepared_query(
            qq{SELECT user_$t AS email
               FROM ${t}_table
               WHERE (subscribed_$t IS NULL OR subscribed_$t <> 1) AND
                     inclusion_$t IS NOT NULL AND inclusion_$t < ? AND
                     list_$t = ? AND robot_$t = ?$r},
            $last_start_time,
            $list->{'name'}, $list->{'domain'}
        )
    ) {
        return;
    } else {
        my @emails = map { $_->[0] } @{$sth->fetchall_arrayref || []};
        $sth->finish;

        foreach my $email (@emails) {
            next unless defined $email and length $email;

            if ($role eq 'member') {
                $list->delete_list_member(users => [$email]);

                # Send notification if the list config authorizes it only.
                if ($list->{'admin'}{'inclusion_notification_feature'} eq
                    'on') {
                    unless (Sympa::send_file($list, 'removed', $email, {})) {
                        $log->syslog('err',
                            'Unable to send template "removed" to %s',
                            $email);
                    }
                }
            } else {
                $list->delete_list_admin($role, $email);
            }
            $deleted += 1;
        }
    }

    # Cancel inclusion of users subscribing (and also included) and
    # not included anymore.
    unless (
        $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
570
571
               SET inclusion_$t = NULL, inclusion_ext_$t = NULL,
                   inclusion_label_$t = NULL
IKEDA Soji's avatar
IKEDA Soji committed
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
               WHERE subscribed_$t = 1 AND
                     inclusion_$t IS NOT NULL AND inclusion_$t < ? AND
                     list_$t = ? AND robot_$t = ?$r},
            $last_start_time,
            $list->{'name'}, $list->{'domain'}
        )
        and $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
               SET inclusion_ext_$t = NULL
               WHERE subscribed_$t = 1 AND
                     inclusion_ext_$t IS NOT NULL AND inclusion_ext_$t < ? AND
                     list_$t = ? AND robot_$t = ?$r},
            $last_start_time,
            $list->{'name'}, $list->{'domain'}
        )
    ) {
        #FIXME: report error
    }

    return (deleted => $deleted);
}

# Internal function.
595
596
597
598
# Update inclusion_table: This feature was added on 6.2.16.
# Related only to Sympa::DataSource::List class.
# Old name: (part of) Sympa::List::_update_inclusion_table().
sub _update_inclusion_table {
599
    my $ds         = shift;
IKEDA Soji's avatar
IKEDA Soji committed
600
    my $start_time = shift;
601
602
603
604
605
606

    my $list   = $ds->{context};
    my $role   = $ds->role;
    my $inlist = Sympa::List->new($ds->{listname});

    my $time = time;
607
    # Avoid retrace of clock e.g. by outage of NTP server.
IKEDA Soji's avatar
IKEDA Soji committed
608
    $time = $start_time unless $start_time <= $time;
609
610

    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
611
    return undef unless $sdm;
612
613
614
    my $sth;

    unless (
IKEDA Soji's avatar
IKEDA Soji committed
615
        $sth = $sdm->do_prepared_query(
616
            q{UPDATE inclusion_table
IKEDA Soji's avatar
IKEDA Soji committed
617
618
619
620
621
622
              SET update_epoch_inclusion = ?
              WHERE target_inclusion = ? AND
                    role_inclusion = ? AND
                    source_inclusion = ? AND
                    (update_epoch_inclusion IS NULL OR
                     update_epoch_inclusion < ?)},
623
624
625
            $time, $list->get_id, $role, $inlist->get_id, $time
        )
        and $sth->rows
IKEDA Soji's avatar
IKEDA Soji committed
626
        or $sth = $sdm->do_prepared_query(
627
            q{INSERT INTO inclusion_table
IKEDA Soji's avatar
IKEDA Soji committed
628
629
630
              (target_inclusion, role_inclusion, source_inclusion,
               update_epoch_inclusion)
              VALUES (?, ?, ?, ?)},
631
632
633
634
635
636
637
638
639
640
641
            $list->get_id, $role, $inlist->get_id, $time
        )
        and $sth->rows
    ) {
        $log->syslog('err', 'Unable to update list %s in database', $list);
        return undef;
    }

    return 1;
}

IKEDA Soji's avatar
IKEDA Soji committed
642
# Internal function.
643
644
# Old name: (part of) Sympa::List::_update_inclusion_table().
# Related only to Sympa::DataSource::List class.
IKEDA Soji's avatar
IKEDA Soji committed
645
646
647
648
sub _expire_inclusion_table {
    my $list            = shift;
    my $role            = shift;
    my $last_start_time = shift;
649
650
651
652
653
654

    my $sdm = Sympa::DatabaseManager->instance;
    $sdm and $sdm->do_prepared_query(
        q{DELETE FROM inclusion_table
          WHERE target_inclusion = ? AND role_inclusion = ? AND
                update_epoch_inclusion < ?},
IKEDA Soji's avatar
IKEDA Soji committed
655
656
        $list->get_id, $role,
        $last_start_time
657
658
659
    );
}

IKEDA Soji's avatar
IKEDA Soji committed
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# Internal function.
sub _update_custom_attribute {
    my $ds = shift;

    die 'bug in logic. Ask developer' unless $ds->role eq 'custom_attribute';

    return unless $ds->open;

    my $list = $ds->{context};

    my $updated = 0;
    while (my $entry = $ds->next) {
        my ($email, $ca_update) = @$entry;

        my $member = $list->get_list_member($email);
        next unless $member;
        my $ca = $member->{custom_attribute} || {};

        my $changed;
        foreach my $key (sort keys %{$ca_update || {}}) {
            my $cur = $ca->{$key};
            $cur = '' unless defined $cur;
            my $new = $ca_update->{$key};
            $new = '' unless defined $new;
            next if $cur eq $new;

            $ca->{$key} = $new;
            $changed = 1;
        }
        next unless $changed;

        $list->update_list_member($email, custom_attribute => $ca_update);
        $updated++;
    }

    $ds->close;

    return (updated => $updated);
}

700
701
# Enforce uniqueness in a comma separated list of user source ID's.
# Old name: (part of) Sympa::List::add_source_id().
702
703
# No longer used.
#sub _add_source_id;
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722

# Returns a real unique ID for an include datasource.
sub get_id {
    shift->{context};
}

1;
__END__

=encoding utf-8

=head1 NAME

Sympa::Request::Hander::include - include request handler

=head1 DESCRIPTION

Includes users from data sources to a list.

IKEDA Soji's avatar
IKEDA Soji committed
723
Opens data sources, include or update list users with each of them and closes.
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
TBD.

=head1 SEE ALSO

L<Sympa::DataSource>, L<Sympa::List>.

L<"admin_table"|sympa_database(5)/"admin_table">,
L<"exclusion_table"|sympa_database(5)/"exclusion_table">,
L<"inclusion_table"|sympa_database(5)/"inclusion_table"> and
L<"subscriber_table"|sympa_database(5)/"subscriber_table">
in L<sympa_database(5)>.

=head1 HISTORY

The feature to include subscribers from data sources was introduced on
Sympa 3.3.6b.4.
Inclusion of owners and moderators was introduced on Sympa 4.2b.5.

L<Datasource> module appeared on Sympa 5.3a.9.
Entirely rewritten and renamed L<Sympa::DataSource> module and
744
L<Sympa::Request::Hander::include> module appeared on Sympa 6.2.45b.
745
746

=cut