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

# Sympa - SYsteme de Multi-Postage Automatique
#
# Copyright (c) 1997, 1998, 1999 Institut Pasteur & Christophe Wolfhugel
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
10
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#
# 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::Robot;

use strict;
use warnings;
use Encode qw();

31
use Sympa;
32
use Conf;
33
use Sympa::DatabaseManager;
34
use Sympa::Language;
35
use Sympa::ListDef;
36
use Sympa::Log;
37
use Sympa::Tools::Data;
38
use Sympa::Tools::File;
39
40

my $language = Sympa::Language->instance;
41
my $log      = Sympa::Log->instance;
42
43
44
45
46
47
48
49
50
51

## Database and SQL statement handlers
my ($sth, @sth_stack);

our %list_of_topics = ();
## Last modification times
our %mtime;

our %listmaster_messages_stack;

52
# MOVED: Use Sympa::send_file(), or Sympa::Message::Template::new() with
53
# Sympa::Mailer::send_message().
54
# sub send_global_file($tpl, $who, $robot, $context, $options);
55

56
# MOVED: Use Sympa::send_notify_to_listmaster() or Sympa::Alarm::flush().
57
# sub send_notify_to_listmaster($operation, $robot, $data, $checkstack, $purge);
58
59

## Is the user listmaster
60
61
# MOVED: Use Sympa::is_listmaster().
#sub is_listmaster;
62
63
64
65
66
67

## get idp xref to locally validated email address
sub get_netidtoemail_db {
    my $robot   = shift;
    my $netid   = shift;
    my $idpname = shift;
68
    $log->syslog('debug', '(%s, %s)', $netid, $idpname);
69
70
71
72
73

    my ($l, %which, $email);

    push @sth_stack, $sth;

74
    my $sdm = Sympa::DatabaseManager->instance;
75
    unless (
76
77
78
79
80
81
82
83
        $sdm
        and $sth = $sdm->do_prepared_query(
            q{SELECT email_netidmap
              FROM netidmap_table
              WHERE netid_netidmap = ? and serviceid_netidmap = ? and
                    robot_netidmap = ?},
            $netid, $idpname,
            $robot
84
85
        )
        ) {
86
        $log->syslog(
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
            'err',
            'Unable to get email address from netidmap_table for id %s, service %s, robot %s',
            $netid,
            $idpname,
            $robot
        );
        return undef;
    }

    $email = $sth->fetchrow;

    $sth->finish();

    $sth = pop @sth_stack;

    return $email;
}

## set idp xref to locally validated email address
sub set_netidtoemail_db {
    my $robot   = shift;
    my $netid   = shift;
    my $idpname = shift;
    my $email   = shift;
111
    $log->syslog('debug', '(%s, %s, %s)', $netid, $idpname, $email);
112
113
114

    my ($l, %which);

115
    my $sdm = Sympa::DatabaseManager->instance;
116
    unless (
117
118
119
120
121
122
123
        $sdm
        and $sdm->do_prepared_query(
            q{INSERT INTO netidmap_table
              (netid_netidmap, serviceid_netidmap, email_netidmap,
               robot_netidmap)
              VALUES (?, ?, ?, ?)},
            $netid, $idpname, $email, $robot
124
125
        )
        ) {
126
        $log->syslog(
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
            'err',
            'Unable to set email address %s in netidmap_table for id %s, service %s, robot %s',
            $email,
            $netid,
            $idpname,
            $robot
        );
        return undef;
    }

    return 1;
}

## Update netidmap table when user email address changes
sub update_email_netidmap_db {
    my ($robot, $old_email, $new_email) = @_;

    unless (defined $robot
        && defined $old_email
        && defined $new_email) {
147
        $log->syslog('err', 'Missing parameter');
148
149
150
        return undef;
    }

151
    my $sdm = Sympa::DatabaseManager->instance;
152
    unless (
153
154
155
156
157
158
159
        $sdm
        and $sdm->do_prepared_query(
            q{UPDATE netidmap_table
              SET email_netidmap = ?
              WHERE email_netidmap = ? AND robot_netidmap = ?},
            $new_email,
            $old_email, $robot
160
161
        )
        ) {
162
        $log->syslog(
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
            'err',
            'Unable to set new email address %s in netidmap_table to replace old address %s for robot %s',
            $new_email,
            $old_email,
            $robot
        );
        return undef;
    }

    return 1;
}

## Loads the list of topics if updated
## FIXME: This might be moved to Robot package.
sub load_topics {
    my $robot = shift;
179
    $log->syslog('debug2', '(%s)', $robot);
180

181
    my $conf_file = Sympa::search_fullpath($robot, 'topics.conf');
182
183

    unless ($conf_file) {
184
        $log->syslog('err', 'No topics.conf defined');
185
186
187
188
189
190
191
        return undef;
    }

    my $topics = {};

    ## Load if not loaded or changed on disk
    if (!$list_of_topics{$robot}
192
193
        or Sympa::Tools::File::get_mtime($conf_file) >
        $mtime{'topics'}{$robot}) {
194
195
196
197
198

        ## delete previous list of topics
        %list_of_topics = ();

        unless (-r $conf_file) {
199
            $log->syslog('err', 'Unable to read %s', $conf_file);
200
201
202
203
            return undef;
        }

        unless (open(FILE, "<", $conf_file)) {
204
            $log->syslog('err', 'Unable to open config file %s', $conf_file);
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
            return undef;
        }

        ## Rough parsing
        my $index = 0;
        my (@rough_data, $topic);
        while (<FILE>) {
            Encode::from_to($_, $Conf::Conf{'filesystem_encoding'}, 'utf8');
            if (/^([\-\w\/]+)\s*$/) {
                $index++;
                $topic = {
                    'name'  => $1,
                    'order' => $index
                };
            } elsif (/^([\w\.]+)\s+(.+)\s*$/) {
                next unless (defined $topic->{'name'});

                $topic->{$1} = $2;
            } elsif (/^\s*$/) {
                next unless defined $topic->{'name'};

                push @rough_data, $topic;
                $topic = {};
            }
        }
        close FILE;

        ## Last topic
        if (defined $topic->{'name'}) {
            push @rough_data, $topic;
            $topic = {};
        }

238
        $mtime{'topics'}{$robot} = Sympa::Tools::File::get_mtime($conf_file);
239
240

        unless ($#rough_data > -1) {
241
            $log->syslog('notice', 'No topic defined in %s', $conf_file);
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
            return undef;
        }

        ## Analysis
        foreach my $topic (@rough_data) {
            my @tree = split '/', $topic->{'name'};

            if ($#tree == 0) {
                my $title = _get_topic_titles($topic);
                $list_of_topics{$robot}{$tree[0]}{'title'} = $title;
                $list_of_topics{$robot}{$tree[0]}{'visibility'} =
                    $topic->{'visibility'} || 'default';
                #$list_of_topics{$robot}{$tree[0]}{'visibility'} = _load_scenario_file('topics_visibility', $robot,$topic->{'visibility'}||'default');
                $list_of_topics{$robot}{$tree[0]}{'order'} =
                    $topic->{'order'};
            } else {
                my $subtopic = join('/', @tree[1 .. $#tree]);
                my $title = _get_topic_titles($topic);
260
                my $visibility = $topic->{'visibility'} || 'default';
261
                $list_of_topics{$robot}{$tree[0]}{'sub'}{$subtopic} =
262
                    _add_topic($subtopic, $title, $visibility);
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
            }
        }

        ## Set undefined Topic (defined via subtopic)
        foreach my $t (keys %{$list_of_topics{$robot}}) {
            unless (defined $list_of_topics{$robot}{$t}{'visibility'}) {
                #$list_of_topics{$robot}{$t}{'visibility'} = _load_scenario_file('topics_visibility', $robot,'default');
            }

            unless (defined $list_of_topics{$robot}{$t}{'title'}) {
                $list_of_topics{$robot}{$t}{'title'} = {'default' => $t};
            }
        }
    }

    ## Set the title in the current language
    my $lang = $language->get_lang;
    foreach my $top (keys %{$list_of_topics{$robot}}) {
        my $topic = $list_of_topics{$robot}{$top};
        foreach my $l (Sympa::Language::implicated_langs($lang)) {
            if (exists $topic->{'title'}{$l}) {
                $topic->{'current_title'} = $topic->{'title'}{$l};
            }
        }
        unless (exists $topic->{'current_title'}) {
            if (exists $topic->{'title'}{'gettext'}) {
                $topic->{'current_title'} =
                    $language->gettext($topic->{'title'}{'gettext'});
            } else {
                $topic->{'current_title'} = $topic->{'title'}{'default'}
                    || $top;
            }
        }

        foreach my $subtop (keys %{$topic->{'sub'}}) {
            foreach my $l (Sympa::Language::implicated_langs($lang)) {
                if (exists $topic->{'sub'}{$subtop}{'title'}{$l}) {
                    $topic->{'sub'}{$subtop}{'current_title'} =
                        $topic->{'sub'}{$subtop}{'title'}{$l};
                }
            }
            unless (exists $topic->{'sub'}{$subtop}{'current_title'}) {
                if (exists $topic->{'sub'}{$subtop}{'title'}{'gettext'}) {
                    $topic->{'sub'}{$subtop}{'current_title'} =
                        $language->gettext(
                        $topic->{'sub'}{$subtop}{'title'}{'gettext'});
                } else {
                    $topic->{'sub'}{$subtop}{'current_title'} =
                           $topic->{'sub'}{$subtop}{'title'}{'default'}
                        || $subtop;
                }
            }
        }
    }

    return %{$list_of_topics{$robot}};
}

sub _get_topic_titles {
    my $topic = shift;

    my $title;
    foreach my $key (%{$topic}) {
        if ($key =~ /^title\.gettext$/i) {
            $title->{'gettext'} = $topic->{$key};
        } elsif ($key =~ /^title\.(\S+)$/i) {
            my $lang = $1;
            # canonicalize lang if possible.
            $lang = Sympa::Language::canonic_lang($lang) || $lang;
            $title->{$lang} = $topic->{$key};
        } elsif ($key =~ /^title$/i) {
            $title->{'default'} = $topic->{$key};
        }
    }

    return $title;
}

## Inner sub used by load_topics()
sub _add_topic {
343
    my ($name, $title, $visibility) = @_;
344
345
346
347
    my $topic = {};

    my @tree = split '/', $name;
    if ($#tree == 0) {
348
        return {'title' => $title, 'visibility' => $visibility};
349
350
    } else {
        $topic->{'sub'}{$name} =
351
            _add_topic(join('/', @tree[1 .. $#tree]), $title, $visibility);
352
353
354
355
        return $topic;
    }
}

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
=over 4

=item list_params

I<Getter>.
Returns hashref to list parameter information.

=back

=cut

# Old name: tools::get_list_params().
sub list_params {
    my $robot_id = shift;

371
    my $pinfo = Sympa::Tools::Data::clone_var(\%Sympa::ListDef::pinfo);
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
    $pinfo->{lang}{format} = [Sympa::get_supported_languages($robot_id)];

    my %topics = Sympa::Robot::load_topics($robot_id);
    my @topics = map {
        my $topic = $_;
        if ($topics{$topic}->{sub}) {
            (   $topic,
                map { $topic . '/' . $_ } sort keys %{$topics{$topic}->{sub}}
            );
        } else {
            ($topic);
        }
    } sort keys %topics;
    $pinfo->{topics}{format} = [@topics];
    # Compat.
    $pinfo->{topics}{file_format} = sprintf '(%s)(,(%s))*',
        join('|', @topics),
        join('|', @topics);
390
391
392
393

    return $pinfo;
}

394
1;