[410] | 1 | package LATMOS::Accounts::Maintenance; |
---|
| 2 | |
---|
| 3 | use strict; |
---|
| 4 | use warnings; |
---|
| 5 | use base qw(LATMOS::Accounts); |
---|
[711] | 6 | use LATMOS::Accounts::Log; |
---|
[1217] | 7 | use LATMOS::Accounts::Mail; |
---|
[410] | 8 | use FindBin qw($Bin); |
---|
[1735] | 9 | use DateTime; |
---|
| 10 | use Date::Calc; |
---|
| 11 | use Date::Parse; |
---|
[410] | 12 | |
---|
[1014] | 13 | =head1 NAME |
---|
| 14 | |
---|
| 15 | LATMOS::Accounts::Maintenance |
---|
| 16 | |
---|
[1023] | 17 | =head1 FUNCTIONS |
---|
| 18 | |
---|
[1014] | 19 | =cut |
---|
| 20 | |
---|
[410] | 21 | sub _base { |
---|
| 22 | my ($self) = @_; |
---|
[861] | 23 | return $self->{_maintenance_base} if ($self->{_maintenance_base}); |
---|
[1085] | 24 | my $base = $self->SUPER::base; |
---|
[410] | 25 | $base->type eq 'sql' or die "This module work only with SQL base type\n"; |
---|
[861] | 26 | return $self->{_maintenance_base} = $base |
---|
[410] | 27 | } |
---|
| 28 | |
---|
[1023] | 29 | =head2 find_next_expire_users ($expire) |
---|
| 30 | |
---|
| 31 | Return The list of users going to expire in C<$expire> delay. |
---|
| 32 | |
---|
| 33 | =cut |
---|
| 34 | |
---|
[410] | 35 | sub find_next_expire_users { |
---|
[850] | 36 | # Do not replace this code by $base->find_next_expire_users |
---|
[861] | 37 | # it does not exactly the same thing |
---|
[410] | 38 | my ($self, $expire) = @_; |
---|
| 39 | my $base = $self->_base; |
---|
| 40 | |
---|
| 41 | my $sth= $base->db->prepare(q{ |
---|
[1348] | 42 | select name, |
---|
[1763] | 43 | expire as appliedexpire, |
---|
[1735] | 44 | endcircuit, |
---|
| 45 | expire |
---|
[1348] | 46 | from "user" |
---|
| 47 | where |
---|
[1763] | 48 | expire < now() + ?::interval |
---|
| 49 | and expire > now() |
---|
| 50 | and expire is not null |
---|
[410] | 51 | and exported = True |
---|
| 52 | order by expire |
---|
| 53 | } |
---|
| 54 | ); |
---|
| 55 | $sth->execute($expire || '1 month'); |
---|
| 56 | my @users; |
---|
| 57 | while (my $res = $sth->fetchrow_hashref) { |
---|
[1735] | 58 | my $now = DateTime->now; |
---|
| 59 | my @expire = strptime($res->{appliedexpire}); |
---|
| 60 | |
---|
| 61 | my ($days) = Date::Calc::Delta_Days( |
---|
| 62 | $now->year, $now->month, $now->day, |
---|
| 63 | 1900 + $expire[5], $expire[4] +1, $expire[3], |
---|
| 64 | ); |
---|
| 65 | |
---|
| 66 | $res->{days} = $days; |
---|
| 67 | |
---|
[410] | 68 | $res->{obj} = $base->get_object('user', $res->{name}); |
---|
[788] | 69 | $res->{obj}->get_attributes('locked') and next; |
---|
[410] | 70 | push(@users, $res); |
---|
| 71 | } |
---|
| 72 | @users |
---|
| 73 | } |
---|
| 74 | |
---|
[417] | 75 | =head2 warn_next_expire_users(%options) |
---|
| 76 | |
---|
| 77 | Send a mail to user having account expiring soon |
---|
| 78 | |
---|
| 79 | C<%options are> |
---|
| 80 | |
---|
| 81 | =over 4 |
---|
| 82 | |
---|
| 83 | =item users => [] |
---|
| 84 | |
---|
| 85 | Warn only this users (if need) |
---|
| 86 | |
---|
| 87 | =item to |
---|
| 88 | |
---|
| 89 | Send the only to this person. |
---|
| 90 | |
---|
| 91 | =back |
---|
| 92 | |
---|
| 93 | =cut |
---|
| 94 | |
---|
[410] | 95 | sub warn_next_expire_users { |
---|
[417] | 96 | my ($self, %options) = @_; |
---|
[410] | 97 | |
---|
[1217] | 98 | require LATMOS::Accounts::Mail; |
---|
| 99 | my $lamail = LATMOS::Accounts::Mail->new( |
---|
[990] | 100 | $self, |
---|
| 101 | 'account_expire.mail', |
---|
[410] | 102 | ); |
---|
[990] | 103 | |
---|
[1958] | 104 | my $MailSubject = $self->val('_default_', 'mailSubject', 'LATMOS::Accounts'); |
---|
| 105 | |
---|
[775] | 106 | my @summary; |
---|
[704] | 107 | foreach my $user ($self->find_next_expire_users($options{delay})) { |
---|
[417] | 108 | if ($options{users} && ! grep { $_ eq $user->{name} } @{$options{users}}) { |
---|
| 109 | next; |
---|
| 110 | } |
---|
[1958] | 111 | |
---|
[410] | 112 | my %mail = ( |
---|
[423] | 113 | From => $self->val('_default_', 'mailFrom', 'nomail@localhost'), |
---|
[2331] | 114 | Subject => $user->{days} == 0 |
---|
| 115 | ? sprintf("$MailSubject: Account %s Expire today", $user->{name}) |
---|
| 116 | : sprintf("$MailSubject: Account %s Expire in %s days", $user->{name}, $user->{days}), |
---|
[410] | 117 | 'X-LATMOS-Reason' => 'Account expiration', |
---|
| 118 | ); |
---|
[1365] | 119 | my ($manager, $mail) = ($user->{obj}->get_c_field('manager'), |
---|
[410] | 120 | $user->{obj}->get_c_field('mail')); |
---|
[2537] | 121 | my $managermail; |
---|
| 122 | if ( $manager ) { |
---|
| 123 | if ( my $omanager = $user->{obj}->base->get_object('user', $manager) ) { |
---|
| 124 | $managermail = $omanager->get_c_field('mail'); |
---|
| 125 | } else { |
---|
| 126 | la_log( 'LA_ERR', "Cannot get manager %s for user %s", $manager, $user->{obj}->id ); |
---|
| 127 | } |
---|
| 128 | } |
---|
[775] | 129 | |
---|
[410] | 130 | # if user have no mail, mail only to manager, avoiding empty To |
---|
| 131 | # NB: at time, for testing purpose, mail is not really sent |
---|
[710] | 132 | my ($to, @cc) = grep { $_ } ($mail, $managermail, |
---|
| 133 | $self->val('_default_', 'allwayscc')); |
---|
[417] | 134 | if ($options{to}) { |
---|
| 135 | $mail{to} = $options{to}; |
---|
| 136 | } else { |
---|
| 137 | $mail{to} = $to; |
---|
| 138 | $mail{cc} = join(', ', @cc); |
---|
| 139 | } |
---|
[711] | 140 | $mail{to} or do { |
---|
| 141 | la_log(LA_ERR, |
---|
| 142 | "Cannot send expiration for `%s', no mail to send to", |
---|
| 143 | $user->{obj}->id, |
---|
| 144 | ); |
---|
| 145 | next; |
---|
| 146 | }; |
---|
[785] | 147 | my $mailcc = join(', ', @cc) || ''; |
---|
[786] | 148 | push(@summary, sprintf("%s : %s : %s\n", |
---|
[1735] | 149 | $user->{obj}->queryformat('%{sn} %{givenName} : %{name} : %{department} : %{manager} : %{expireText} : %{endcircuit}'), |
---|
[785] | 150 | $to || 'Not sent, no destination', |
---|
[786] | 151 | ($mailcc ? $mailcc : ''), |
---|
[785] | 152 | ) |
---|
| 153 | ); |
---|
[410] | 154 | my $message; |
---|
[1011] | 155 | if ($lamail->process(\%mail, $user)) { |
---|
[990] | 156 | la_log(LA_NOTICE, "Expiration mail for %s (%s) sent to %s; cc %s", |
---|
| 157 | $user->{obj}->id, |
---|
[1735] | 158 | $user->{days}, |
---|
[990] | 159 | $mail{to}, ($mail{cc} || '')); |
---|
| 160 | if ($options{to}) { |
---|
| 161 | la_log(LA_NOTICE,"\tbut sent to %s", $mail{to}); |
---|
[710] | 162 | } |
---|
[990] | 163 | } |
---|
[410] | 164 | } |
---|
| 165 | |
---|
[785] | 166 | if (@summary) { |
---|
| 167 | if ($options{test}) { |
---|
| 168 | print join('', @summary); |
---|
| 169 | } else { |
---|
| 170 | if ($self->val('_default_', 'expire_summary_to')) { |
---|
[1217] | 171 | my $summail = LATMOS::Accounts::Mail->new( |
---|
[990] | 172 | $self, |
---|
| 173 | \join('', @summary), |
---|
| 174 | ); |
---|
[785] | 175 | my %mail = ( |
---|
[990] | 176 | ); |
---|
[1011] | 177 | if ($summail->process({ |
---|
[1958] | 178 | Subject => "$MailSubject: account expiration summary", |
---|
[785] | 179 | To => $self->val('_default_', 'expire_summary_to'), |
---|
[990] | 180 | })) { |
---|
| 181 | la_log( |
---|
| 182 | LA_NOTICE, |
---|
| 183 | "Expiration summary mail sent to %s", |
---|
[785] | 184 | $self->val('_default_', 'expire_summary_to'), |
---|
| 185 | ); |
---|
| 186 | } |
---|
| 187 | } |
---|
| 188 | } |
---|
| 189 | } |
---|
| 190 | |
---|
[410] | 191 | 1; |
---|
| 192 | } |
---|
| 193 | |
---|
[1023] | 194 | =head2 find_expired_users ($expire) |
---|
| 195 | |
---|
| 196 | See L<LATMOS::Accounts::Base/find_expired_users> |
---|
| 197 | |
---|
| 198 | =cut |
---|
| 199 | |
---|
[850] | 200 | sub find_expired_users { |
---|
| 201 | my ($self, $expire) = @_; |
---|
| 202 | $self->_base->find_expired_users($expire); |
---|
| 203 | } |
---|
| 204 | |
---|
[1023] | 205 | =head2 expired_account_reminder ( %options) |
---|
| 206 | |
---|
| 207 | Search account expired for more than C<$options{delay}> (default is 6 month) |
---|
| 208 | send mail to manager and summary to admin to aknoledge destruction. |
---|
| 209 | |
---|
| 210 | =cut |
---|
| 211 | |
---|
[861] | 212 | sub expired_account_reminder { |
---|
| 213 | my ($self, %options) = @_; |
---|
| 214 | $options{delay} ||= '6 month'; |
---|
| 215 | |
---|
[990] | 216 | my $lamail = LATMOS::Accounts::Mail->new( |
---|
| 217 | $self, |
---|
| 218 | 'account_expired_reminder.mail', |
---|
[861] | 219 | ); |
---|
| 220 | |
---|
| 221 | my @users = $self->_base->find_expired_users($options{delay}); |
---|
| 222 | |
---|
| 223 | my %managers; |
---|
[1275] | 224 | |
---|
[1253] | 225 | foreach my $user (@users) { |
---|
| 226 | my $uobj = $self->_base->get_object('user', $user); |
---|
| 227 | $uobj->get_attributes('unexported') and next; # can't happend |
---|
[1365] | 228 | my $manager = $uobj->get_attributes('manager') || 'N/A'; |
---|
[1253] | 229 | push(@{$managers{$manager}{users}}, $uobj); |
---|
| 230 | |
---|
[861] | 231 | } |
---|
| 232 | |
---|
[1958] | 233 | my $MailSubject = $self->val('_default_', 'mailSubject', 'LATMOS::Accounts'); |
---|
| 234 | |
---|
[1100] | 235 | unless($options{test}) { |
---|
| 236 | foreach (keys %managers) { |
---|
| 237 | my $oman = $self->_base->get_object('user', $_) or next; # can't happend |
---|
| 238 | $managers{$_}{manager} = $oman; |
---|
| 239 | my $mail = $oman->get_attributes('mail') or next; |
---|
| 240 | |
---|
| 241 | my %mail = ( |
---|
[1958] | 242 | Subject => "$MailSubject: expired account", |
---|
[1100] | 243 | 'X-LATMOS-Reason' => 'Account destruction', |
---|
[990] | 244 | ); |
---|
[1100] | 245 | $mail{to} = $options{to} || $mail; |
---|
| 246 | if ($lamail->process(\%mail, $managers{$oman->id})) { |
---|
| 247 | la_log(LA_NOTICE, |
---|
| 248 | "Expired account reminder mail for %s sent to %s (cc: %s) for %s", |
---|
| 249 | $oman->id, |
---|
| 250 | $mail{to}, |
---|
| 251 | ($mail{cc} || ''), |
---|
| 252 | join(', ', map { $_->id } @{$managers{$oman->id}{users}}) |
---|
| 253 | ); |
---|
| 254 | } |
---|
[861] | 255 | } |
---|
| 256 | } |
---|
| 257 | my @summary; |
---|
| 258 | foreach my $manager (sort keys %managers) { |
---|
| 259 | push(@summary, "\n" . ( |
---|
| 260 | $managers{$manager}{manager} |
---|
| 261 | ? $managers{$manager}{manager}->get_attributes('displayName') |
---|
| 262 | : $manager) . "\n"); |
---|
| 263 | foreach (@{$managers{$manager}{users}}) { |
---|
| 264 | push(@summary, sprintf(" %s - %s (%s)\n", |
---|
| 265 | $_->id, |
---|
| 266 | $_->get_attributes('displayName'), |
---|
| 267 | $_->get_attributes('expireText'), |
---|
| 268 | )); |
---|
| 269 | } |
---|
| 270 | } |
---|
| 271 | |
---|
| 272 | if (@summary) { |
---|
| 273 | if ($options{test}) { |
---|
| 274 | print join('', @summary); |
---|
| 275 | } else { |
---|
| 276 | if ($self->val('_default_', 'expire_summary_to')) { |
---|
| 277 | my %mail = ( |
---|
[1958] | 278 | Subject => "$MailSubject: expired account (to disable)", |
---|
[861] | 279 | 'X-LATMOS-Reason' => 'Account expiration', |
---|
| 280 | To => $self->val('_default_', 'expire_summary_to'), |
---|
| 281 | ); |
---|
[1180] | 282 | my $summail = LATMOS::Accounts::Mail->new( |
---|
[990] | 283 | $self, \join('', @summary), {} |
---|
| 284 | ); |
---|
[1011] | 285 | if ($summail->process(\%mail)) { |
---|
[861] | 286 | la_log(LA_NOTICE, "Expiration summary mail sent to %s", |
---|
| 287 | $self->val('_default_', 'expire_summary_to'), |
---|
| 288 | ); |
---|
| 289 | } |
---|
| 290 | } |
---|
| 291 | } |
---|
| 292 | } |
---|
| 293 | } |
---|
| 294 | |
---|
[410] | 295 | 1; |
---|
[1023] | 296 | |
---|
| 297 | __END__ |
---|
| 298 | |
---|
| 299 | =head1 SEE ALSO |
---|
| 300 | |
---|
| 301 | L<LATMOS::Accounts::Bases> |
---|
| 302 | |
---|
| 303 | =head1 AUTHOR |
---|
| 304 | |
---|
| 305 | Thauvin Olivier, E<lt>olivier.thauvin@latmos.ipsl.frE<gt> |
---|
| 306 | |
---|
| 307 | =head1 COPYRIGHT AND LICENSE |
---|
| 308 | |
---|
| 309 | Copyright (C) 2009, 2010, 2011, 2012 by Thauvin Olivier |
---|
| 310 | |
---|
| 311 | This library is free software; you can redistribute it and/or modify |
---|
| 312 | it under the same terms as Perl itself, either Perl version 5.10.0 or, |
---|
| 313 | at your option, any later version of Perl 5 you may have available. |
---|
| 314 | |
---|
| 315 | =cut |
---|