avoid multiple ikiwiki cgi processes piling up, eating all memory, and thrashing
[ikiwiki.git] / IkiWiki / Wrapper.pm
1 #!/usr/bin/perl
2
3 package IkiWiki;
4
5 use warnings;
6 use strict;
7 use File::Spec;
8 use Data::Dumper;
9 use IkiWiki;
10
11 sub gen_wrapper () { #{{{
12         $config{srcdir}=File::Spec->rel2abs($config{srcdir});
13         $config{destdir}=File::Spec->rel2abs($config{destdir});
14         my $this=File::Spec->rel2abs($0);
15         if (! -x $this) {
16                 error(sprintf(gettext("%s doesn't seem to be executable"), $this));
17         }
18
19         if ($config{setup}) {
20                 error(gettext("cannot create a wrapper that uses a setup file"));
21         }
22         my $wrapper=possibly_foolish_untaint($config{wrapper});
23         if (! defined $wrapper || ! length $wrapper) {
24                 error(gettext("wrapper filename not specified"));
25         }
26         delete $config{wrapper};
27         
28         my @envsave;
29         push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
30                        CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
31                        HTTP_COOKIE REMOTE_USER HTTPS} if $config{cgi};
32         my $envsave="";
33         foreach my $var (@envsave) {
34                 $envsave.=<<"EOF";
35         if ((s=getenv("$var")))
36                 addenv("$var", s);
37 EOF
38         }
39
40         my $test_receive="";
41         if ($config{test_receive}) {
42                 require IkiWiki::Receive;
43                 $test_receive=IkiWiki::Receive::gen_wrapper();
44         }
45
46         my $check_commit_hook="";
47         my $pre_exec="";
48         if ($config{post_commit}) {
49                 # Optimise checking !commit_hook_enabled() , 
50                 # so that ikiwiki does not have to be started if the
51                 # hook is disabled.
52                 #
53                 # Note that perl's flock may be implemented using fcntl
54                 # or lockf on some systems. If so, and if there is no
55                 # interop between the locking systems, the true C flock will
56                 # always succeed, and this optimisation won't work.
57                 # The perl code will later correctly check the lock,
58                 # so the right thing will still happen, though without
59                 # the benefit of this optimisation.
60                 $check_commit_hook=<<"EOF";
61         {
62                 int fd=open("$config{wikistatedir}/commitlock", O_CREAT | O_RDWR);
63                 if (fd != -1) {
64                         if (flock(fd, LOCK_SH | LOCK_NB) != 0)
65                                 exit(0);
66                         close(fd);
67                 }
68         }
69 EOF
70         }
71         elsif ($config{cgi}) {
72                 # Avoid more than one ikiwiki cgi running at a time by
73                 # taking a cgi lock. Since ikiwiki uses several MB of
74                 # memory, a pile up of processes could cause thrashing
75                 # otherwise.
76                 $pre_exec=<<"EOF";
77         {
78                 int fd=open("$config{wikistatedir}/cgilock", O_CREAT | O_RDWR);
79                 if (fd != -1)
80                         flock(fd, LOCK_EX);
81         }
82 EOF
83         }
84
85         $Data::Dumper::Indent=0; # no newlines
86         my $configstring=Data::Dumper->Dump([\%config], ['*config']);
87         $configstring=~s/\\/\\\\/g;
88         $configstring=~s/"/\\"/g;
89         $configstring=~s/\n/\\n/g;
90         
91         #translators: The first parameter is a filename, and the second is
92         #translators: a (probably not translated) error message.
93         open(OUT, ">$wrapper.c") || error(sprintf(gettext("failed to write %s: %s"), "$wrapper.c", $!));;
94         print OUT <<"EOF";
95 /* A wrapper for ikiwiki, can be safely made suid. */
96 #include <stdio.h>
97 #include <sys/types.h>
98 #include <sys/stat.h>
99 #include <fcntl.h>
100 #include <unistd.h>
101 #include <stdlib.h>
102 #include <string.h>
103 #include <sys/file.h>
104
105 extern char **environ;
106 char *newenviron[$#envsave+6];
107 int i=0;
108
109 addenv(char *var, char *val) {
110         char *s=malloc(strlen(var)+1+strlen(val)+1);
111         if (!s)
112                 perror("malloc");
113         sprintf(s, "%s=%s", var, val);
114         newenviron[i++]=s;
115 }
116
117 int main (int argc, char **argv) {
118         char *s;
119
120 $check_commit_hook
121 $test_receive
122 $envsave
123         newenviron[i++]="HOME=$ENV{HOME}";
124         newenviron[i++]="WRAPPED_OPTIONS=$configstring";
125         newenviron[i]=NULL;
126         environ=newenviron;
127
128         if (setregid(getegid(), -1) != 0 &&
129             setregid(getegid(), -1) != 0) {
130                 perror("failed to drop real gid");
131                 exit(1);
132         }
133         if (setreuid(geteuid(), -1) != 0 &&
134             setreuid(geteuid(), -1) != 0) {
135                 perror("failed to drop real uid");
136                 exit(1);
137         }
138
139 $pre_exec
140         execl("$this", "$this", NULL);
141         perror("exec $this");
142         exit(1);
143 }
144 EOF
145         close OUT;
146
147         my $cc=exists $ENV{CC} ? possibly_foolish_untaint($ENV{CC}) : 'cc';
148         if (system($cc, "$wrapper.c", "-o", "$wrapper.new") != 0) {
149                 #translators: The parameter is a C filename.
150                 error(sprintf(gettext("failed to compile %s"), "$wrapper.c"));
151         }
152         unlink("$wrapper.c");
153         if (defined $config{wrappergroup}) {
154                 my $gid=(getgrnam($config{wrappergroup}))[2];
155                 if (! defined $gid) {
156                         error(sprintf("bad wrappergroup"));
157                 }
158                 if (! chown(-1, $gid, "$wrapper.new")) {
159                         error("chown $wrapper.new: $!");
160                 }
161         }
162         if (defined $config{wrappermode} &&
163             ! chmod(oct($config{wrappermode}), "$wrapper.new")) {
164                 error("chmod $wrapper.new: $!");
165         }
166         if (! rename("$wrapper.new", $wrapper)) {
167                 error("rename $wrapper.new $wrapper: $!");
168         }
169         #translators: The parameter is a filename.
170         printf(gettext("successfully generated %s"), $wrapper);
171         print "\n";
172 } #}}}
173
174 1