include.pm 20.8 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
#
7
8
# Copyright 2019 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
# <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',
    'include_voot_group'        => 'Sympa::DataSource::VOOT',
);

IKEDA Soji's avatar
IKEDA Soji committed
60
# Internal function.
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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') {
76
        #FIXME: Use Sympa::Config.
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
        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') {
                @config = map { {name => $_, path => $_} } @config;
            }
            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';
96
        #FIXME: Use Sympa::Config.
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
        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') {
                @config = map { {name => $_, path => $_} } @config;
            }
            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'
        unless grep { $role and $role eq $_ } qw(member owner editor);

    my $dss = _get_data_sources($list, $role);
    return 0 unless $dss and @$dss;

    # Get an Exclusive lock.
131
132
    my $lock_file = $list->{'dir'} . '/' . $role . '.include';
    my $lock_fh = Sympa::LockedFile->new($lock_file, -1, '+>>');
133
    unless ($lock_fh) {
134
135
        $log->syslog('info', '%s: Locked, skip inclusion', $list);
        $self->add_stash($request, 'notice', 'include_skip',
136
137
138
139
            {listname => $list->{'name'}});
        return 0;
    }

IKEDA Soji's avatar
IKEDA Soji committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    # 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',
            {listname => $list->{'name'}});
        return 0;
    }

161
    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
162
    return undef unless $sdm;
163
    my $sth;
164
165
166
167
    my ($t, $r) =
          ($role eq 'member')
        ? ('subscriber', '')
        : ('admin', sprintf ' AND role_admin = %s', $sdm->quote($role));
168

169
170
171
    # II. Include new entries.

    my %result = (added => 0, deleted => 0, updated => 0, kept => 0);
172
173
174
    foreach my $ds (@{$dss || []}) {
        $lock_fh->extend;

175
        next unless $ds->is_allowed_to_sync;
IKEDA Soji's avatar
IKEDA Soji committed
176
        my %res = _update_users($ds, $start_time);
177
178
179
        next unless %res;

        # Update time of allowed and succeeded data sources.
IKEDA Soji's avatar
IKEDA Soji committed
180
181
182
183
184
        $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';
185
186
187
188
189
190
191
192
193
194
195
196

        $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'},
                id       => $ds->get_short_id,
                name     => $ds->name,
                result   => {%res}
197
            }
198
199
200
        );
        foreach my $key (keys %res) {
            $result{$key} += $res{$key} if exists $result{$key};
201
        }
202
    }
203

204
205
206
207
    # III. Expire outdated entries.

    # Choose most earlier time of succeeding inclusions (if any of
    # data sources have not succeeded yet, Unix epoch will be chosen).
IKEDA Soji's avatar
IKEDA Soji committed
208
    $last_start_time = $start_time;
209
    foreach my $id (map { $_->get_short_id } @$dss) {
IKEDA Soji's avatar
IKEDA Soji committed
210
211
        unless (defined $start_times{$id}) {
            undef $last_start_time;
212
            last;
IKEDA Soji's avatar
IKEDA Soji committed
213
214
        } elsif ($start_times{$id} < $last_start_time) {
            $last_start_time = $start_times{$id};
215
216
        }
    }
217

IKEDA Soji's avatar
IKEDA Soji committed
218
    if (defined $last_start_time) {
219
        $lock_fh->extend;
IKEDA Soji's avatar
IKEDA Soji committed
220
221
222

        my %res = _expire_users($list, $role, $last_start_time);
        unless (%res) {
IKEDA Soji's avatar
IKEDA Soji committed
223
            $self->add_stash($request, 'intern');
IKEDA Soji's avatar
IKEDA Soji committed
224
            #FIMXE: Report error.
225
226
            return undef;
        }
IKEDA Soji's avatar
IKEDA Soji committed
227
228
        foreach my $key (keys %res) {
            $result{$key} += $res{$key} if exists $result{$key};
229
        }
IKEDA Soji's avatar
IKEDA Soji committed
230

231
        # Special treatment for Sympa::DataSource::List.
IKEDA Soji's avatar
IKEDA Soji committed
232
        _expire_inclusion_table($list, $role, $last_start_time);
IKEDA Soji's avatar
IKEDA Soji committed
233
    }
234

235
    # IV. Update custom attributes.
236

IKEDA Soji's avatar
IKEDA Soji committed
237
    if ($role eq 'member') {
IKEDA Soji's avatar
IKEDA Soji committed
238
239
240
        foreach
            my $ds (@{_get_data_sources($list, 'custom_attribute') || []}) {
            next unless $ds->is_allowed_to_sync;
241

IKEDA Soji's avatar
IKEDA Soji committed
242
243
            $lock_fh->extend;
            _update_custom_attribute($ds);
244
245
246
        }
    }

247
    # V. Finish.
248

249
250
251
252
253
254
    # 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;
255
    }
256
    foreach my $id (map { $_->get_short_id } @$dss) {
IKEDA Soji's avatar
IKEDA Soji committed
257
258
        printf $ofh "%s %d\n", $id, $start_times{$id}
            if defined $start_times{$id};
259
260
261
262
263
264
265
266
267
268
    }
    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';
269

270
271
272
273
274
275
    $log->syslog(
        'info',   '%s: %d included, %d deleted, %d updated',
        $request, @result{qw(added deleted updated)}
    );
    $self->add_stash($request, 'notice', 'include_performed',
        {listname => $list->{'name'}, result => {%result}});
276
277
278
    return 1;
}

IKEDA Soji's avatar
IKEDA Soji committed
279
280
# Internal function.
sub _update_users {
281
    my $ds         = shift;
IKEDA Soji's avatar
IKEDA Soji committed
282
    my $start_time = shift;
283
284
285
286
287
288

    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
289
        my %res = __update_user($ds, $email, $other_value, $start_time);
290
291
292

        unless (%res) {
            $ds->close;
IKEDA Soji's avatar
IKEDA Soji committed
293
            $log->syslog('info', '%s: Aborted inclusion', $ds);
294
295
296
297
            return;
        }
        foreach my $res (keys %res) {
            $result{$res} += $res{$res} if exists $result{$res};
298
299
300
301
302
303
304
305
306
        }
    }

    $ds->close;

    return %result;
}

# Internal function.
IKEDA Soji's avatar
IKEDA Soji committed
307
sub __update_user {
308
309
310
    my $ds         = shift;
    my $email      = shift;
    my $gecos      = shift;
IKEDA Soji's avatar
IKEDA Soji committed
311
    my $start_time = shift;
312
313
314

    return (none => 0) unless Sympa::Tools::Text::valid_email($email);
    $email = Sympa::Tools::Text::canonic_email($email);
315
316
317
318
319
320

    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
321
    $time = $start_time unless $start_time <= time;
322

323
    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
324
    return undef unless $sdm;
325
326
327
328
329
    my $sth;
    my ($t, $r) =
          ($role eq 'member')
        ? ('subscriber', '')
        : ('admin', sprintf ' AND role_admin = %s', $sdm->quote($role));
330
331
    my $is_external_ds = not(ref $ds eq 'Sympa::DataSource::List'
        and [split /\@/, $ds->{listname}, 2]->[1] eq $list->{'domain'});
332
333
334
335
336
337

    # 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);

338
339
    # 2. If user has already been updated by the other data sources:
    #    Keep user.
340
341
342
343
344
345
346
    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
347
348
349
            $email, $list->{'name'}, $list->{'domain'},
            $start_time,
            $start_time
350
351
352
353
354
355
356
357
        );
    } 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
358
            $start_time
359
360
        );
    }
361
362
363
    my ($count) = $sth->fetchrow_array;
    $sth->finish;
    return (kept => 1) if $count;
364

365
366
    # 3. If user (has not been updated by the other data sources and) exists:
    #    UPDATE inclusion.
367
    if ($is_external_ds) {
368
369
370
371
372
373
374
375
376
377
378
        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;

379
380
381
382
383
384
385
        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},
            $time, $time,
            $email, $list->{'name'}, $list->{'domain'}
        );
386
        return (updated => 1) if $sth->rows;
387
388
389
390
391
392
393
394
    } else {
        return unless $sth = $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
               SET inclusion_$t = ?
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r},
            $time,
            $email, $list->{'name'}, $list->{'domain'}
        );
395
        return (updated => 1) if $sth->rows;
396
    }
397
398
399

    # 4. Otherwise, i.e. a new user:
    #    INSERT new user with:
400
401
    #    email, gecos, subscribed=0, date, update, inclusion and
    #    default attributes.
402
403
    my $user = {
        email       => $email,
404
        gecos       => $gecos,
405
        subscribed  => 0,
406
        date        => $time,
407
        update_date => $time,
408
        inclusion   => $time,
409
        ($is_external_ds ? (inclusion_ext => $time) : ()),
410
    };
411
412
    my @defkeys = @{$ds->{_defkeys} || []};
    my @defvals = @{$ds->{_defvals} || []};
413
    @{$user}{@defkeys} = @defvals if @defkeys;
414
415

    if ($role eq 'member') {
416
        $list->add_list_member($user);
417

418
419
420
421
422
        # 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);
423
424
425
            }
        }
    } else {
426
        $list->add_list_admin($role, $user);
427
    }
428
    return (added => 1);
429
430
}

IKEDA Soji's avatar
IKEDA Soji committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
sub _expire_users {
    my $list            = shift;
    my $role            = shift;
    my $last_start_time = shift;

    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));

    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
               SET inclusion_$t = NULL, inclusion_ext_$t = NULL
               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.
514
515
516
517
# 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 {
518
    my $ds         = shift;
IKEDA Soji's avatar
IKEDA Soji committed
519
    my $start_time = shift;
520
521
522
523
524
525

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

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

    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
530
    return undef unless $sdm;
531
532
533
    my $sth;

    unless (
IKEDA Soji's avatar
IKEDA Soji committed
534
        $sth = $sdm->do_prepared_query(
535
            q{UPDATE inclusion_table
IKEDA Soji's avatar
IKEDA Soji committed
536
537
538
539
540
541
              SET update_epoch_inclusion = ?
              WHERE target_inclusion = ? AND
                    role_inclusion = ? AND
                    source_inclusion = ? AND
                    (update_epoch_inclusion IS NULL OR
                     update_epoch_inclusion < ?)},
542
543
544
            $time, $list->get_id, $role, $inlist->get_id, $time
        )
        and $sth->rows
IKEDA Soji's avatar
IKEDA Soji committed
545
        or $sth = $sdm->do_prepared_query(
546
            q{INSERT INTO inclusion_table
IKEDA Soji's avatar
IKEDA Soji committed
547
548
549
              (target_inclusion, role_inclusion, source_inclusion,
               update_epoch_inclusion)
              VALUES (?, ?, ?, ?)},
550
551
552
553
554
555
556
557
558
559
560
            $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
561
# Internal function.
562
563
# Old name: (part of) Sympa::List::_update_inclusion_table().
# Related only to Sympa::DataSource::List class.
IKEDA Soji's avatar
IKEDA Soji committed
564
565
566
567
sub _expire_inclusion_table {
    my $list            = shift;
    my $role            = shift;
    my $last_start_time = shift;
568
569
570
571
572
573

    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
574
575
        $list->get_id, $role,
        $last_start_time
576
577
578
    );
}

IKEDA Soji's avatar
IKEDA Soji committed
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
# 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);
}

619
620
# Enforce uniqueness in a comma separated list of user source ID's.
# Old name: (part of) Sympa::List::add_source_id().
621
622
# No longer used.
#sub _add_source_id;
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641

# 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
642
Opens data sources, include or update list users with each of them and closes.
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
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
663
L<Sympa::Request::Hander::include> module appeared on Sympa 6.2.39b.1.
664
665

=cut