IkiWiki/UserInfo.pm

   1 #!/usr/bin/perl
   2
   3 use warnings;
   4 use strict;
   5 use Storable;
   6 use IkiWiki;
   7
   8 package IkiWiki;
   9
  10 sub userinfo_retrieve () { #{{{
  11         my $userinfo=eval{ Storable::lock_retrieve("$config{wikistatedir}/userdb") };
  12         return $userinfo;
  13 } #}}}
  14
  15 sub userinfo_store ($) { #{{{
  16         my $userinfo=shift;
  17
  18         my $newfile="$config{wikistatedir}/userdb.new";
  19         my $oldmask=umask(077);
  20         my $ret=Storable::lock_store($userinfo, $newfile);
  21         umask($oldmask);
  22         if (defined $ret && $ret) {
  23                 if (! rename($newfile, "$config{wikistatedir}/userdb")) {
  24                         unlink($newfile);
  25                         $ret=undef;
  26                 }
  27         }
  28         return $ret;
  29 } #}}}
  30
  31 sub userinfo_get ($$) { #{{{
  32         my $user=shift;
  33         my $field=shift;
  34
  35         my $userinfo=userinfo_retrieve();
  36         if (! defined $userinfo ||
  37             ! exists $userinfo->{$user} || ! ref $userinfo->{$user} ||
  38             ! exists $userinfo->{$user}->{$field}) {
  39                 return "";
  40         }
  41         return $userinfo->{$user}->{$field};
  42 } #}}}
  43
  44 sub userinfo_set ($$$) { #{{{
  45         my $user=shift;
  46         my $field=shift;
  47         my $value=shift;
  48
  49         my $userinfo=userinfo_retrieve();
  50         if (! defined $userinfo ||
  51             ! exists $userinfo->{$user} || ! ref $userinfo->{$user}) {
  52                 return "";
  53         }
  54
  55         $userinfo->{$user}->{$field}=$value;
  56         return userinfo_store($userinfo);
  57 } #}}}
  58
  59 sub userinfo_setall ($$) { #{{{
  60         my $user=shift;
  61         my $info=shift;
  62
  63         my $userinfo=userinfo_retrieve();
  64         if (! defined $userinfo) {
  65                 $userinfo={};
  66         }
  67         $userinfo->{$user}=$info;
  68         return userinfo_store($userinfo);
  69 } #}}}
  70
  71 sub is_admin ($) { #{{{
  72         my $user_name=shift;
  73
  74         return grep { $_ eq $user_name } @{$config{adminuser}};
  75 } #}}}
  76
  77 sub get_banned_users () { #{{{
  78         my @ret;
  79         my $userinfo=userinfo_retrieve();
  80         foreach my $user (keys %{$userinfo}) {
  81                 push @ret, $user if $userinfo->{$user}->{banned};
  82         }
  83         return @ret;
  84 } #}}}
  85
  86 sub set_banned_users (@) { #{{{
  87         my %banned=map { $_ => 1 } @_;
  88         my $userinfo=userinfo_retrieve();
  89         foreach my $user (keys %{$userinfo}) {
  90                 $userinfo->{$user}->{banned} = $banned{$user};
  91         }
  92         return userinfo_store($userinfo);
  93 } #}}}
  94
  95 sub commit_notify_list ($@) { #{{{
  96         my $committer=shift;
  97         my @pages = map pagename($_), @_;
  98
  99         my @ret;
 100         my $userinfo=userinfo_retrieve();
 101         foreach my $user (keys %{$userinfo}) {
 102                 next if $user eq $committer;
 103                 if (exists $userinfo->{$user}->{subscriptions} &&
 104                     length $userinfo->{$user}->{subscriptions} &&
 105                     exists $userinfo->{$user}->{email} &&
 106                     length $userinfo->{$user}->{email} &&
 107                     grep { pagespec_match($_,
 108                                     $userinfo->{$user}->{subscriptions},
 109                                     user => $committer) }
 110                         map pagename($_), @_) {
 111                         push @ret, $userinfo->{$user}->{email};
 112                 }
 113         }
 114         return @ret;
 115 } #}}}
 116
 117 sub send_commit_mails ($$$@) { #{{{
 118         my $messagesub=shift;
 119         my $diffsub=shift;
 120         my $user=shift;
 121         my @changed_pages=@_;
 122
 123         return unless @changed_pages;
 124
 125         my @email_recipients=commit_notify_list($user, @changed_pages);
 126         if (@email_recipients) {
 127                 # TODO: if a commit spans multiple pages, this will send
 128                 # subscribers a diff that might contain pages they did not
 129                 # sign up for. Should separate the diff per page and
 130                 # reassemble into one mail with just the pages subscribed to.
 131                 my $diff=$diffsub->();
 132                 my $message=$messagesub->();
 133
 134                 my $pagelist;
 135                 if (@changed_pages > 2) {
 136                         $pagelist="$changed_pages[0] $changed_pages[1] ...";
 137                 }
 138                 else {
 139                         $pagelist.=join(" ", @changed_pages);
 140                 }
 141                 #translators: The three variables are the name of the wiki,
 142                 #translators: A list of one or more pages that were changed,
 143                 #translators: And the name of the user making the change.
 144                 #translators: This is used as the subject of a commit email.
 145                 my $subject=sprintf(gettext("update of %s's %s by %s"),
 146                         $config{wikiname}, $pagelist, $user);
 147
 148                 my $template=template("notifymail.tmpl");
 149                 $template->param(
 150                         wikiname => $config{wikiname},
 151                         diff => $diff,
 152                         user => $user,
 153                         message => $message,
 154                 );
 155
 156                 # Daemonize, in case the mail sending takes a while.
 157                 defined(my $pid = fork) or error("Can't fork: $!");
 158                 return if $pid;
 159                 setsid() or error("Can't start a new session: $!");
 160                 chdir '/';
 161                 open STDIN, '/dev/null';
 162                 open STDOUT, '>/dev/null';
 163                 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
 164
 165                 unlockwiki(); # don't need to keep a lock on the wiki
 166
 167                 eval q{use Mail::Sendmail};
 168                 error($@) if $@;
 169                 foreach my $email (@email_recipients) {
 170                         sendmail(
 171                                 To => $email,
 172                                 From => "$config{wikiname} <$config{adminemail}>",
 173                                 Subject => $subject,
 174                                 Message => $template->output,
 175                         );
 176                 }
 177
 178                 exit 0; # daemon process done
 179         }
 180 } #}}}
 181
 182 1