]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/UserInfo.pm
* Fix sending of commit mails when new pages are added via the web.
[ikiwiki.git] / 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($_, $userinfo->{$user}->{subscriptions}, "") }
108                         map pagename($_), @_) {
109                         push @ret, $userinfo->{$user}->{email};
110                 }
111         }
112         return @ret;
113 } #}}}
114
115 sub send_commit_mails ($$$@) { #{{{
116         my $messagesub=shift;
117         my $diffsub=shift;
118         my $user=shift;
119         my @changed_pages=@_;
120
121         return unless @changed_pages;
122
123         my @email_recipients=commit_notify_list($user, @changed_pages);
124         if (@email_recipients) {
125                 # TODO: if a commit spans multiple pages, this will send
126                 # subscribers a diff that might contain pages they did not
127                 # sign up for. Should separate the diff per page and
128                 # reassemble into one mail with just the pages subscribed to.
129                 my $diff=$diffsub->();
130                 my $message=$messagesub->();
131
132                 my $pagelist;
133                 if (@changed_pages > 2) {
134                         $pagelist="$changed_pages[0] $changed_pages[1] ...";
135                 }
136                 else {
137                         $pagelist.=join(" ", @changed_pages);
138                 }
139                 #translators: The three variables are the name of the wiki,
140                 #translators: A list of one or more pages that were changed,
141                 #translators: And the name of the user making the change.
142                 #translators: This is used as the subject of a commit email.
143                 my $subject=sprintf(gettext("update of %s's %s by %s"), 
144                         $config{wikiname}, $pagelist, $user);
145
146                 my $template=template("notifymail.tmpl");
147                 $template->param(
148                         wikiname => $config{wikiname},
149                         diff => $diff,
150                         user => $user,
151                         message => $message,
152                 );
153
154                 # Daemonize, in case the mail sending takes a while.
155                 defined(my $pid = fork) or error("Can't fork: $!");
156                 return if $pid;
157                 setsid() or error("Can't start a new session: $!");
158                 chdir '/';
159                 open STDIN, '/dev/null';
160                 open STDOUT, '>/dev/null';
161                 open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
162
163                 unlockwiki(); # don't need to keep a lock on the wiki
164
165                 eval q{use Mail::Sendmail};
166                 error($@) if $@;
167                 foreach my $email (@email_recipients) {
168                         sendmail(
169                                 To => $email,
170                                 From => "$config{wikiname} <$config{adminemail}>",
171                                 Subject => $subject,
172                                 Message => $template->output,
173                         );
174                 }
175
176                 exit 0; # daemon process done
177         }
178 } #}}}
179
180 1