include.pm 21.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
#
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
# <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
130
131
132
133
134
135
            }
            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.
136
137
    my $lock_file = $list->{'dir'} . '/' . $role . '.include';
    my $lock_fh = Sympa::LockedFile->new($lock_file, -1, '+>>');
138
    unless ($lock_fh) {
139
140
        $log->syslog('info', '%s: Locked, skip inclusion', $list);
        $self->add_stash($request, 'notice', 'include_skip',
141
142
143
144
            {listname => $list->{'name'}});
        return 0;
    }

IKEDA Soji's avatar
IKEDA Soji committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
    # 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;
    }

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

174
175
176
    # II. Include new entries.

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

180
        next unless $ds->is_allowed_to_sync;
IKEDA Soji's avatar
IKEDA Soji committed
181
        my %res = _update_users($ds, $start_time);
182
183
184
        next unless %res;

        # Update time of allowed and succeeded data sources.
IKEDA Soji's avatar
IKEDA Soji committed
185
186
187
188
189
        $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';
190
191
192
193
194
195
196
197
198
199
200
201

        $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}
202
            }
203
204
205
        );
        foreach my $key (keys %res) {
            $result{$key} += $res{$key} if exists $result{$key};
206
        }
207
    }
208

209
210
211
    # III. Expire outdated entries.

    # Choose most earlier time of succeeding inclusions (if any of
212
    # data sources have not succeeded yet, time is not defined).
IKEDA Soji's avatar
IKEDA Soji committed
213
    $last_start_time = $start_time;
214
    foreach my $id (map { $_->get_short_id } @$dss) {
IKEDA Soji's avatar
IKEDA Soji committed
215
216
        unless (defined $start_times{$id}) {
            undef $last_start_time;
217
            last;
IKEDA Soji's avatar
IKEDA Soji committed
218
219
        } elsif ($start_times{$id} < $last_start_time) {
            $last_start_time = $start_times{$id};
220
221
        }
    }
222

IKEDA Soji's avatar
IKEDA Soji committed
223
    if (defined $last_start_time) {
224
        $lock_fh->extend;
IKEDA Soji's avatar
IKEDA Soji committed
225
226
227

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

236
        # Special treatment for Sympa::DataSource::List.
IKEDA Soji's avatar
IKEDA Soji committed
237
        _expire_inclusion_table($list, $role, $last_start_time);
IKEDA Soji's avatar
IKEDA Soji committed
238
    }
239

240
    # IV. Update custom attributes.
241

IKEDA Soji's avatar
IKEDA Soji committed
242
    if ($role eq 'member') {
IKEDA Soji's avatar
IKEDA Soji committed
243
244
245
        foreach
            my $ds (@{_get_data_sources($list, 'custom_attribute') || []}) {
            next unless $ds->is_allowed_to_sync;
246

IKEDA Soji's avatar
IKEDA Soji committed
247
248
            $lock_fh->extend;
            _update_custom_attribute($ds);
249
250
251
        }
    }

252
    # V. Finish.
253

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

275
276
277
278
279
280
    $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}});
281
282
283
    return 1;
}

IKEDA Soji's avatar
IKEDA Soji committed
284
285
# Internal function.
sub _update_users {
286
    my $ds         = shift;
IKEDA Soji's avatar
IKEDA Soji committed
287
    my $start_time = shift;
288
289
290
291
292
293

    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
294
        my %res = __update_user($ds, $email, $other_value, $start_time);
295
296
297

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

    $ds->close;

    return %result;
}

# Internal function.
IKEDA Soji's avatar
IKEDA Soji committed
312
sub __update_user {
313
314
315
    my $ds         = shift;
    my $email      = shift;
    my $gecos      = shift;
IKEDA Soji's avatar
IKEDA Soji committed
316
    my $start_time = shift;
317
318
319

    return (none => 0) unless Sympa::Tools::Text::valid_email($email);
    $email = Sympa::Tools::Text::canonic_email($email);
320
321
322
323
324
325

    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
326
    $time = $start_time unless $start_time <= time;
327

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

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

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

370
371
    # 3. If user (has not been updated by the other data sources and) exists:
    #    UPDATE inclusion.
372
    if ($is_external_ds) {
373
374
375
        # 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.
376
377
378
379
380
381
382
383
384
385
386
        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;

387
388
        # Not yet updated by any other data sources:
        # Update inclusion_ext (and inclusion), and assign inclusion_label.
389
390
        return unless $sth = $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
391
               SET inclusion_$t = ?, inclusion_ext_$t = ?,
IKEDA Soji's avatar
IKEDA Soji committed
392
                   inclusion_label_$t = ?
393
394
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r},
            $time, $time,
395
            $ds->name,
396
397
            $email, $list->{'name'}, $list->{'domain'}
        );
398
        return (updated => 1) if $sth->rows;
399
    } else {
400
401
        # Not yet updated by any other data sources:
        # Update inclusion, and assign inclusion_label.
402
403
        return unless $sth = $sdm->do_prepared_query(
            qq{UPDATE ${t}_table
404
405
               SET inclusion_$t = ?,
                   inclusion_label_$t = ?
406
407
               WHERE user_$t = ? AND list_$t = ? AND robot_$t = ?$r},
            $time,
408
            $ds->name,
409
410
            $email, $list->{'name'}, $list->{'domain'}
        );
411
        return (updated => 1) if $sth->rows;
412
    }
413
414
415

    # 4. Otherwise, i.e. a new user:
    #    INSERT new user with:
416
417
    #    email, gecos, subscribed=0, date, update, inclusion,
    #    (optional) inclusion_ext, inclusion_label and
418
    #    default attributes.
419
420
    my $user = {
        email       => $email,
421
        gecos       => $gecos,
422
        subscribed  => 0,
423
        date        => $time,
424
        update_date => $time,
425
        inclusion   => $time,
426
        ($is_external_ds ? (inclusion_ext => $time) : ()),
427
        inclusion_label => $ds->name,
428
    };
429
430
    my @defkeys = @{$ds->{_defkeys} || []};
    my @defvals = @{$ds->{_defvals} || []};
431
    @{$user}{@defkeys} = @defvals if @defkeys;
432
433

    if ($role eq 'member') {
434
        $list->add_list_member($user);
435

436
437
438
439
440
        # 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);
441
442
443
            }
        }
    } else {
444
        $list->add_list_admin($role, $user);
445
    }
446
    return (added => 1);
447
448
}

IKEDA Soji's avatar
IKEDA Soji committed
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
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
508
509
               SET inclusion_$t = NULL, inclusion_ext_$t = NULL,
                   inclusion_label_$t = NULL
IKEDA Soji's avatar
IKEDA Soji committed
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
               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.
533
534
535
536
# 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 {
537
    my $ds         = shift;
IKEDA Soji's avatar
IKEDA Soji committed
538
    my $start_time = shift;
539
540
541
542
543
544

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

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

    my $sdm = Sympa::DatabaseManager->instance;
IKEDA Soji's avatar
IKEDA Soji committed
549
    return undef unless $sdm;
550
551
552
    my $sth;

    unless (
IKEDA Soji's avatar
IKEDA Soji committed
553
        $sth = $sdm->do_prepared_query(
554
            q{UPDATE inclusion_table
IKEDA Soji's avatar
IKEDA Soji committed
555
556
557
558
559
560
              SET update_epoch_inclusion = ?
              WHERE target_inclusion = ? AND
                    role_inclusion = ? AND
                    source_inclusion = ? AND
                    (update_epoch_inclusion IS NULL OR
                     update_epoch_inclusion < ?)},
561
562
563
            $time, $list->get_id, $role, $inlist->get_id, $time
        )
        and $sth->rows
IKEDA Soji's avatar
IKEDA Soji committed
564
        or $sth = $sdm->do_prepared_query(
565
            q{INSERT INTO inclusion_table
IKEDA Soji's avatar
IKEDA Soji committed
566
567
568
              (target_inclusion, role_inclusion, source_inclusion,
               update_epoch_inclusion)
              VALUES (?, ?, ?, ?)},
569
570
571
572
573
574
575
576
577
578
579
            $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
580
# Internal function.
581
582
# Old name: (part of) Sympa::List::_update_inclusion_table().
# Related only to Sympa::DataSource::List class.
IKEDA Soji's avatar
IKEDA Soji committed
583
584
585
586
sub _expire_inclusion_table {
    my $list            = shift;
    my $role            = shift;
    my $last_start_time = shift;
587
588
589
590
591
592

    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
593
594
        $list->get_id, $role,
        $last_start_time
595
596
597
    );
}

IKEDA Soji's avatar
IKEDA Soji committed
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
# 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);
}

638
639
# Enforce uniqueness in a comma separated list of user source ID's.
# Old name: (part of) Sympa::List::add_source_id().
640
641
# No longer used.
#sub _add_source_id;
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660

# 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
661
Opens data sources, include or update list users with each of them and closes.
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
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
682
L<Sympa::Request::Hander::include> module appeared on Sympa 6.2.45b.
683
684

=cut