updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / IkiWiki / Wrapper.pm

diff --git a/IkiWiki/Wrapper.pm b/IkiWiki/Wrapper.pm
index 7a1529119ce76be003564297f76b2ce02cd4f11c..1b8c558e5a46ae55aa14be4f09e59ef5ad5a504b 100644 (file)
--- a/IkiWiki/Wrapper.pm
+++ b/IkiWiki/Wrapper.pm
@@ -8,10 +8,31 @@ use File::Spec;
 use Data::Dumper;
 use IkiWiki;
 
 use Data::Dumper;
 use IkiWiki;
 

+sub gen_wrappers () {
+       debug(gettext("generating wrappers.."));
+       my %origconfig=(%config);
+       foreach my $wrapper (@{$config{wrappers}}) {
+               %config=(%origconfig, %{$wrapper});
+               $config{verbose}=$config{setupverbose}
+                       if exists $config{setupverbose};
+               $config{syslog}=$config{setupsyslog}
+                       if exists $config{setupsyslog};
+               delete @config{qw(setupsyslog setupverbose wrappers genwrappers rebuild)};
+               checkconfig();
+               if (! $config{cgi} && ! $config{post_commit} &&
+                   ! $config{test_receive}) {
+                       $config{post_commit}=1;
+               }
+               gen_wrapper();
+       }
+       %config=(%origconfig);
+}
+
+our $program_to_wrap = $0;

 sub gen_wrapper () {
        $config{srcdir}=File::Spec->rel2abs($config{srcdir});
        $config{destdir}=File::Spec->rel2abs($config{destdir});
 sub gen_wrapper () {
        $config{srcdir}=File::Spec->rel2abs($config{srcdir});
        $config{destdir}=File::Spec->rel2abs($config{destdir});

-       my $this=File::Spec->rel2abs($0);
+       my $this=File::Spec->rel2abs($program_to_wrap);

        if (! -x $this) {
                error(sprintf(gettext("%s doesn't seem to be executable"), $this));
        }
        if (! -x $this) {
                error(sprintf(gettext("%s doesn't seem to be executable"), $this));
        }


@@ -29,7 +50,10 @@ sub gen_wrapper () {
        push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
                       CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
                       HTTP_COOKIE REMOTE_USER HTTPS REDIRECT_STATUS
        push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
                       CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
                       HTTP_COOKIE REMOTE_USER HTTPS REDIRECT_STATUS

+                      HTTP_HOST SERVER_PORT HTTPS HTTP_ACCEPT

                       REDIRECT_URL} if $config{cgi};
                       REDIRECT_URL} if $config{cgi};

+       push @envsave, qw{GIT_OBJECT_DIRECTORY GIT_QUARANTINE_PATH
+                      GIT_ALTERNATE_OBJECT_DIRECTORIES} if $config{test_receive};

        my $envsave="";
        foreach my $var (@envsave) {
                $envsave.=<<"EOF";
        my $envsave="";
        foreach my $var (@envsave) {
                $envsave.=<<"EOF";


@@ -37,6 +61,17 @@ sub gen_wrapper () {
                addenv("$var", s);
 EOF
        }
                addenv("$var", s);
 EOF
        }

+       if (ref $config{ENV} eq 'HASH') {
+               foreach my $key (keys %{$config{ENV}}) {
+                       my $val=$config{ENV}{$key};
+                       utf8::encode($val) if utf8::is_utf8($val);
+                       $val =~ s/([^A-Za-z0-9])/sprintf '""\\x%02x""', ord($1)/ge;
+                       $envsave.=<<"EOF";
+       addenv("$key", "$val");
+EOF
+               }
+               delete $config{ENV};
+       }

        
        my @wrapper_hooks;
        run_hooks(genwrapper => sub { push @wrapper_hooks, shift->() });
        
        my @wrapper_hooks;
        run_hooks(genwrapper => sub { push @wrapper_hooks, shift->() });


@@ -72,18 +107,65 @@ EOF
                # memory, a pile up of processes could cause thrashing
                # otherwise. The fd of the lock is stored in
                # IKIWIKI_CGILOCK_FD so unlockwiki can close it.
                # memory, a pile up of processes could cause thrashing
                # otherwise. The fd of the lock is stored in
                # IKIWIKI_CGILOCK_FD so unlockwiki can close it.

-               $pre_exec=<<"EOF";
-       {
-               int fd=open("$config{wikistatedir}/cgilock", O_CREAT | O_RDWR, 0666);
-               if (fd != -1 && flock(fd, LOCK_EX) == 0) {
-                       char *fd_s;
-                       asprintf(&fd_s, "%i", fd);
-                       setenv("IKIWIKI_CGILOCK_FD", fd_s, 1);
+               #
+               # A lot of cgi wrapper processes can potentially build
+               # up and clog an otherwise unloaded web server. To
+               # partially avoid this, when a GET comes in and the lock
+               # is already held, rather than blocking a html page is
+               # constructed that retries. This is enabled by setting
+               # cgi_overload_delay.
+               if (defined $config{cgi_overload_delay} &&
+                   $config{cgi_overload_delay} =~/^[0-9]+/) {
+                       my $i=int($config{cgi_overload_delay});
+                       $pre_exec.="#define CGI_OVERLOAD_DELAY $i\n"
+                               if $i > 0;
+                       my $msg=gettext("Please wait");
+                       $msg=~s/"/\\"/g;
+                       $pre_exec.='#define CGI_PLEASE_WAIT_TITLE "'.$msg."\"\n";
+                       if (defined $config{cgi_overload_message} && length $config{cgi_overload_message}) {
+                               $msg=$config{cgi_overload_message};
+                               $msg=~s/"/\\"/g;
+                       }
+                       $pre_exec.='#define CGI_PLEASE_WAIT_BODY "'.$msg."\"\n";
+               }
+               $pre_exec.=<<"EOF";
+       lockfd=open("$config{wikistatedir}/cgilock", O_CREAT | O_RDWR, 0666);
+       if (lockfd != -1) {
+#ifdef CGI_OVERLOAD_DELAY
+               char *request_method = getenv("REQUEST_METHOD");
+               if (request_method && strcmp(request_method, "GET") == 0) {
+                       if (lockf(lockfd, F_TLOCK, 0) == 0) {
+                               set_cgilock_fd(lockfd);
+                       }
+                       else {
+                               printf("Content-Type: text/html\\nRefresh: %i; URL=%s\\n\\n<html><head><title>%s</title><head><body><p>%s</p></body></html>",
+                                       CGI_OVERLOAD_DELAY,
+                                       getenv("REQUEST_URI"),
+                                       CGI_PLEASE_WAIT_TITLE,
+                                       CGI_PLEASE_WAIT_BODY);
+                               exit(0);
+                       }

                }
                }

+               else if (lockf(lockfd, F_LOCK, 0) == 0) {
+                       set_cgilock_fd(lockfd);
+               }
+#else
+               if (lockf(lockfd, F_LOCK, 0) == 0) {
+                       set_cgilock_fd(lockfd);
+               }
+#endif

        }
 EOF
        }
 
        }
 EOF
        }
 

+       my $set_background_command='';
+       if (defined $config{wrapper_background_command} &&
+           length $config{wrapper_background_command}) {
+               my $background_command=delete $config{wrapper_background_command};
+               $background_command=~s/"/\\"/g;
+               $set_background_command='#define BACKGROUND_COMMAND "'.$background_command.'"';
+       }
+

        $Data::Dumper::Indent=0; # no newlines
        my $configstring=Data::Dumper->Dump([\%config], ['*config']);
        $configstring=~s/\\/\\\\/g;
        $Data::Dumper::Indent=0; # no newlines
        my $configstring=Data::Dumper->Dump([\%config], ['*config']);
        $configstring=~s/\\/\\\\/g;


@@ -100,29 +182,71 @@ EOF
 #include <stdlib.h>
 #include <string.h>
 #include <sys/file.h>
 #include <stdlib.h>
 #include <string.h>
 #include <sys/file.h>

+#include <sys/wait.h>

 
 extern char **environ;
 
 extern char **environ;

-char *newenviron[$#envsave+6];
-int i=0;
+int newenvironlen=0;
+/* Array of length newenvironlen+1 (+1 for NULL) */
+char **newenviron=NULL;
+
+void addenv(char *var, char *val) {
+       char *s;

 
 

-addenv(char *var, char *val) {
-       char *s=malloc(strlen(var)+1+strlen(val)+1);
-       if (!s)
+       if (newenviron) {
+               newenviron=realloc(newenviron, (newenvironlen+2) * sizeof(char *));
+       }
+       else {
+               newenviron=calloc(newenvironlen+2, sizeof(char *));
+       }
+
+       if (!newenviron) {
+               perror("realloc");
+               exit(1);
+       }
+
+       s=malloc(strlen(var)+1+strlen(val)+1);
+       if (!s) {

                perror("malloc");
                perror("malloc");

-       sprintf(s, "%s=%s", var, val);
-       newenviron[i++]=s;
+               exit(1);
+       }
+       else {
+               sprintf(s, "%s=%s", var, val);
+               newenviron[newenvironlen++]=s;
+       }
+}
+
+void set_cgilock_fd (int lockfd) {
+       char fd_s[12];
+       sprintf(fd_s, "%i", lockfd);
+       if (setenv("IKIWIKI_CGILOCK_FD", fd_s, 1) != 0) {
+               perror("setenv");
+               exit(1);
+       }

 }
 
 int main (int argc, char **argv) {
 }
 
 int main (int argc, char **argv) {

+       int lockfd=-1;

        char *s;
 
 $check_commit_hook
 @wrapper_hooks
 $envsave
        char *s;
 
 $check_commit_hook
 @wrapper_hooks
 $envsave

-       newenviron[i++]="HOME=$ENV{HOME}";
-       newenviron[i++]="WRAPPED_OPTIONS=$configstring";
-       newenviron[i]=NULL;
+       addenv("HOME", "$ENV{HOME}");
+       addenv("PATH", "$ENV{PATH}");
+       addenv("WRAPPED_OPTIONS", "$configstring");
+
+#ifdef __TINYC__
+       /* old tcc versions do not support modifying environ directly */
+       if (clearenv() != 0) {
+               perror("clearenv");
+               exit(1);
+       }
+       for (; newenvironlen>0; newenvironlen--)
+               putenv(newenviron[newenvironlen-1]);
+#else
+       newenviron[newenvironlen]=NULL;

        environ=newenviron;
        environ=newenviron;

+#endif

 
        if (setregid(getegid(), -1) != 0 &&
            setregid(getegid(), -1) != 0) {
 
        if (setregid(getegid(), -1) != 0 &&
            setregid(getegid(), -1) != 0) {


@@ -136,15 +260,46 @@ $envsave
        }
 
 $pre_exec
        }
 
 $pre_exec

+
+$set_background_command
+#ifdef BACKGROUND_COMMAND
+       if (lockfd != -1) {
+               close(lockfd);
+       }
+
+       pid_t pid=fork();
+       if (pid == -1) {
+               perror("fork");
+               exit(1);
+       }
+       else if (pid == 0) {
+               execl("$this", "$this", NULL);
+               perror("exec $this");
+               exit(1);                
+       }
+       else {
+               waitpid(pid, NULL, 0);
+
+               if (daemon(1, 0) == 0) {
+                       system(BACKGROUND_COMMAND);
+                       exit(0);
+               }
+               else {
+                       perror("daemon");
+                       exit(1);
+               }
+       }
+#else

        execl("$this", "$this", NULL);
        perror("exec $this");
        exit(1);
        execl("$this", "$this", NULL);
        perror("exec $this");
        exit(1);

+#endif

 }
 EOF
 
 }
 EOF
 

-       my $cc=exists $ENV{CC} ? possibly_foolish_untaint($ENV{CC}) : 'cc';
-       my $cflags=exists $ENV{CFLAGS} ? possibly_foolish_untaint($ENV{CFLAGS}) : '-O';
-       if (system($cc, $cflags, "$wrapper.c", "-o", "$wrapper.new") != 0) {
+       my @cc=exists $ENV{CC} ? possibly_foolish_untaint($ENV{CC}) : 'cc';
+       push @cc, split(' ', possibly_foolish_untaint($ENV{CFLAGS})) if exists $ENV{CFLAGS};
+       if (system(@cc, "$wrapper.c", "-o", "$wrapper.new") != 0) {

                #translators: The parameter is a C filename.
                error(sprintf(gettext("failed to compile %s"), "$wrapper.c"));
        }
                #translators: The parameter is a C filename.
                error(sprintf(gettext("failed to compile %s"), "$wrapper.c"));
        }


@@ -166,8 +321,7 @@ EOF
                error("rename $wrapper.new $wrapper: $!");
        }
        #translators: The parameter is a filename.
                error("rename $wrapper.new $wrapper: $!");
        }
        #translators: The parameter is a filename.

-       printf(gettext("successfully generated %s"), $wrapper);
-       print "\n";
+       debug(sprintf(gettext("successfully generated %s"), $wrapper));

 }
 
 1
 }
 
 1