CGI скрипты c Nginx в Debian Squeeze/Ubuntu 11.04

Звезда не активнаЗвезда не активнаЗвезда не активнаЗвезда не активнаЗвезда не активна
 

UbuntuЭтот наглядный пример даст Вам представление о том, как работать со CGI скриптами (Perl) на nginx в Debian Squeeze/Ubuntu 11.04. Хотя nginx сам по себе не обслуживает CGI, есть несколько способов обойти это. Далее предлагаются три пути решения: первый - прокси-запросы для CGI скриптов на Thttpd, небольшой веб-сервер с поддержкой CGI. Тогда как второй и третий способы довольно похожи - в обоих случаях используются оболочка CGI для обслуживания CGI скриптов.

1. Примечание перед началом работы

В данном примере используется вебсайт www.example.com расположеный в корневой папке /var/www/www.example.com/web/ и файл конфигурации Nginx хоста в /etc/nginx/sites-enabled/www.example.com.vhost.

Примечание для пользователей Ubuntu:

Поскольку все шаги данного примера Вы должны выполнять с правами суперпользователя, Вам нужно будет либо перед каждой командой в строке набирать sudo, либо Вы можете в самом начале перейти в режим суперпользователя, введя команду:

  • sudo su

2. Использование Thttpd

В этом разделе описано как настроить nginx для прокси-запросов для CGI скриптов (расширением .cgi или .pl) на Thttpd. В примере настроен Thttpd для порта 8000.

Для начала нужно установить Thttpd:

  • apt-get install thttpd

На сайте nginx ThttpdCGI написано, что Thttpd должен быть пропатчен - к счастью этот патч включен в Thttpd-пакет в Debian и Ubuntu, поэтому Вам не нужно этого делать.

Далее открываем /etc/default/thttpd...

  • nano /etc/default/thttpd

... и присваиваем ENABLED значение YES

[...]
ENABLED=yes

Затем делаем бекап исходного файла /etc/thttpd/thttpd.conf и создаем новый при помощи

  • mv /etc/thttpd/thttpd.conf /etc/thttpd/thttpd.conf_orig
  • nano /etc/thttpd/thttpd.conf
# BEWARE : No empty lines are allowed!
# This section overrides defaults
# This section _documents_ defaults in effect
# port=80
# nosymlink         # default = !chroot
# novhost
# nocgipat
# nothrottles
# host=0.0.0.0
# charset=iso-8859-1
host=127.0.0.1
port=8000
user=www-data
logfile=/var/log/thttpd.log
pidfile=/var/run/thttpd.pid
dir=/var/www
cgipat=**.cgi|**.pl

Это заставит Thttpd прослушивать порт 8000 на 127.0.0.1; его корневая директория находится в /var/www.

Запуск Thttpd:

  • /etc/init.d/thttpd start

Далее создаем /etc/nginx/proxy.conf:

  • nano /etc/nginx/proxy.conf
proxy_redirect          off;
proxy_set_header        Host            $host;
proxy_set_header        X-Real-IP       $remote_addr;
proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
client_max_body_size    10m;
client_body_buffer_size 128k;
proxy_connect_timeout   90;
proxy_send_timeout      90;
proxy_read_timeout      90;

Затем открываем файл конфигурации виртуального хоста...

  • nano /etc/nginx/sites-enabled/www.example.com.vhost

... и добавляем раздел location /cgi-bin {} в контейнер server {}

server {
[...]
   location /cgi-bin {
      include proxy.conf;
      proxy_pass http://127.0.0.1:8000;
   }
[...]
}

Перезапускаем nginx:

  • /etc/init.d/nginx reload

Поскольку корневая папка Thttpd расположена по пути /var/www, location/cgi-bin переводится в директорию /var/www/cgi-bin (это применяется ко всем доменам, что означает, что каждый домен должен располагать свои CGI скрипты в /var/www/cgi-bin). Это недостаток для виртуальных хостов, решением данной проблемы является использование не Thttpd, а CGI-оболочки, что будет описано разделах 3 и 4.

Создадим папку...

  • mkdir /var/www/cgi-bin

...и поместим туда CGI скрипты, делая их исполняемыми. Для тестирования создадим небольшой Hello World Perl скрипт (вместо hello_world.cgi Вы можете использовать расширение .pl -> hello_world.pl):

  • nano /var/www/cgi-bin/hello_world.cgi
#!/usr/bin/perl -w
   # Tell perl to send a html header.
   # So your browser gets the output
   # rather then <stdout>(command line
   # on the server.)
print "Content-type: text/html\n\n";
   # print your basic html tags.
   # and the content of them.
print "<html><head><title>Hello World!! </title></head>\n";
print "<body><h1>Hello world</h1></body></html>\n";
  • chmod 755 /var/www/cgi-bin/hello_world.cgi

Откройте браузер и проверьте скрипт:

http://www.example.com/cgi-bin/hello_world.cgi

Если все выполнено верно, Вы должны увидеть такой результат:

hello world


3. Использование Simple CGI

Другой подход заключается в использовании скрипта CGI оболочки,как описано здесь wiki.nginx.org/NginxSimpleCGI Преимущество данного метода заключается в том, что каждый виртуальный хост имеет свою собственную директорию cgi-bin. Оболочка CGI хорошо работает с простыми CGI скриптами, но при работе с более сложными сценариями могут возникнуть проблемы.

Установим пакеты для скрипта оболочки CGI:

  • apt-get install libfcgi-perl libfcgi-procmanager-perl

Далее создадим скрипт /usr/local/bin/cgiwrap-fcgi.pl (скрипт взят отсюда wiki.nginx.org/NginxSimpleCGI):

  • nano /usr/local/bin/cgiwrap-fcgi.pl
#!/usr/bin/perl
use FCGI;
use Socket;
use FCGI::ProcManager;
sub shutdown { FCGI::CloseSocket($socket); exit; }
sub restart  { FCGI::CloseSocket($socket); &main; }
use sigtrap 'handler', \&shutdown, 'normal-signals';
use sigtrap 'handler', \&restart,  'HUP';
require 'syscall.ph';
use POSIX qw(setsid);

END()   { }
BEGIN() { }
{
  no warnings;
  *CORE::GLOBAL::exit = sub { die "fakeexit\nrc=" . shift() . "\n"; };
};

eval q{exit};
if ($@) {
  exit unless $@ =~ /^fakeexit/;
}
&main;

sub daemonize() {
  chdir '/' or die "Can't chdir to /: $!";
  defined( my $pid = fork ) or die "Can't fork: $!";
  exit if $pid;
  setsid() or die "Can't start a new session: $!";
  umask 0;
}

sub main {
  $proc_manager = FCGI::ProcManager->new( {n_processes => 5} );
  $socket = FCGI::OpenSocket( "/var/run/nginx/cgiwrap-dispatch.sock", 10 )
  ; #use UNIX sockets - user running this script must have w access to the 'nginx' folder!!
  $request =
  FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%req_params, $socket,
  &FCGI::FAIL_ACCEPT_ON_INTR );
  $proc_manager->pm_manage();
  if ($request) { request_loop() }
  FCGI::CloseSocket($socket);
}

sub request_loop {
  while ( $request->Accept() >= 0 ) {
    $proc_manager->pm_pre_dispatch();

    #processing any STDIN input from WebServer (for CGI-POST actions)
    $stdin_passthrough = '';
    { no warnings; $req_len = 0 + $req_params{'CONTENT_LENGTH'}; };
    if ( ( $req_params{'REQUEST_METHOD'} eq 'POST' ) && ( $req_len != 0 ) ) {
      my $bytes_read = 0;
      while ( $bytes_read < $req_len ) {
        my $data = '';
        my $bytes = read( STDIN, $data, ( $req_len - $bytes_read ) );
        last if ( $bytes == 0 || !defined($bytes) );
        $stdin_passthrough .= $data;
        $bytes_read += $bytes;
      }
    }

    #running the cgi app
    if (
      ( -x $req_params{SCRIPT_FILENAME} ) &&    #can I execute this?
      ( -s $req_params{SCRIPT_FILENAME} ) &&    #Is this file empty?
      ( -r $req_params{SCRIPT_FILENAME} )       #can I read this file?
    ) {
      pipe( CHILD_RD,   PARENT_WR );
      pipe( PARENT_ERR, CHILD_ERR );
      my $pid = open( CHILD_O, "-|" );
      unless ( defined($pid) ) {
        print("Content-type: text/plain\r\n\r\n");
        print "Error: CGI app returned no output - Executing $req_params{SCRIPT_FILENAME} failed !\n";
        next;
      }
      $oldfh = select(PARENT_ERR);
      $|     = 1;
      select(CHILD_O);
      $| = 1;
      select($oldfh);
      if ( $pid > 0 ) {
        close(CHILD_RD);
        close(CHILD_ERR);
        print PARENT_WR $stdin_passthrough;
        close(PARENT_WR);
        $rin = $rout = $ein = $eout = '';
        vec( $rin, fileno(CHILD_O),    1 ) = 1;
        vec( $rin, fileno(PARENT_ERR), 1 ) = 1;
        $ein    = $rin;
        $nfound = 0;

        while ( $nfound = select( $rout = $rin, undef, $ein = $eout, 10 ) ) {
          die "$!" unless $nfound != -1;
          $r1 = vec( $rout, fileno(PARENT_ERR), 1 ) == 1;
          $r2 = vec( $rout, fileno(CHILD_O),    1 ) == 1;
          $e1 = vec( $eout, fileno(PARENT_ERR), 1 ) == 1;
          $e2 = vec( $eout, fileno(CHILD_O),    1 ) == 1;

          if ($r1) {
            while ( $bytes = read( PARENT_ERR, $errbytes, 4096 ) ) {
              print STDERR $errbytes;
            }
            if ($!) {
              $err = $!;
              die $!;
              vec( $rin, fileno(PARENT_ERR), 1 ) = 0
              unless ( $err == EINTR or $err == EAGAIN );
            }
          }
          if ($r2) {
            while ( $bytes = read( CHILD_O, $s, 4096 ) ) {
              print $s;
            }
            if ( !defined($bytes) ) {
              $err = $!;
              die $!;
              vec( $rin, fileno(CHILD_O), 1 ) = 0
              unless ( $err == EINTR or $err == EAGAIN );
            }
          }
          last if ( $e1 || $e2 );
        }
        close CHILD_RD;
        close PARENT_ERR;
        waitpid( $pid, 0 );
      } else {
        foreach $key ( keys %req_params ) {
          $ENV{$key} = $req_params{$key};
        }

        # cd to the script's local directory
        if ( $req_params{SCRIPT_FILENAME} =~ /^(.*)\/[^\/] +$/ ) {
          chdir $1;
        }
        close(PARENT_WR);
        #close(PARENT_ERR);
        close(STDIN);
        close(STDERR);

        #fcntl(CHILD_RD, F_DUPFD, 0);
        syscall( &SYS_dup2, fileno(CHILD_RD),  0 );
        syscall( &SYS_dup2, fileno(CHILD_ERR), 2 );

        #open(STDIN, "<&CHILD_RD");
        exec( $req_params{SCRIPT_FILENAME} );
        die("exec failed");
      }
    } else {
      print("Content-type: text/plain\r\n\r\n");
      print "Error: No such CGI app - $req_params{SCRIPT_FILENAME} may not exist or is not executable by this process.\n";
    }
  }
}

Делаем скрипт исполняемым...

  • chmod 755 /usr/local/bin/cgiwrap-fcgi.pl

... и создаем каталог /var/run/nginx/ где скрипт создаст сокет ( к которому будет подключаться nginx):

  • mkdir /var/run/nginx/

Поскольку по умолчанию nginx работает как пользователь www-data, он должен иметь права на чтение и запись в директории /var/run/nginx/, поэтому даем ему соответствующие права при помощи chown:

  • chown www-data:www-data /var/run/nginx/

Поскольку сокет /var/run/nginx/cgiwrap-dispatch.sock (который был создан при помощи оболочки) должен принадлежать пользователю www-data. Чтобы стать пользователем www-data, нужно использовать команду su (смена пользователя). :

  • su www-data
  • /usr/local/bin/cgiwrap-fcgi.pl &> /dev/null &

В результате этих манипуляций оболочка должна работать в качестве демона в фоновом режиме, поэтому Вы можете снова стать пользователем root:

  • exit

Теперь открываем файл конфигурации хоста...

  • nano /etc/nginx/sites-enabled/www.example.com.vhost

... и добавляем раздел location /cgi-bin {} в контейнер server {}

server {
[...]
   location /cgi-bin {
      root /var/www/www.example.com;
      gzip off; #gzip makes scripts feel slower since they have to complete before getting gzipped
      fastcgi_pass  unix:/var/run/nginx/cgiwrap-dispatch.sock;
      include /etc/nginx/fastcgi_params;
      fastcgi_index index.cgi;
      fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
   }
[...]

Перезапускаем ngnix:

  • /etc/init.d/nginx reload

Теперь создадим каталог cgi-bin - /var/www/www.example.com/cgi-bin, поскольку мы установили корень в /var/www/www.example.com; в контейнере location /cgi-bin {}

  • mkdir /var/www/www.example.com/cgi-bin

Далее помещаем туда CGI скрипты и делаем их исполняемыми. Для проверки создаем небольшой Hello World Perl скрипт (вместо расширения hello_world.cgi можно применять .pl -> hello_world.pl):

  • nano /var/www/www.example.com/cgi-bin/hello_world.cgi
#!/usr/bin/perl -w
   # Tell perl to send a html header.
   # So your browser gets the output
   # rather then <stdout>(command line
   # on the server.)
print "Content-type: text/html\n\n";
   # print your basic html tags.
   # and the content of them.
print "<html><head><title>Hello World!! </title></head>\n";
print "<body><h1>Hello world</h1></body></html>\n";
  • chmod 755 /var/www/www.example.com/cgi-bin/hello_world.cgi

Откройте браузер и протестируйте скрипт:

http://www.example.com/cgi-bin/hello_world.cgi

Если все выполнено верно, на экране появится страница

hello world

 

4. Использование Fcgiwrap

Fcgiwrap - это другая CGI оболочка, которая должна работать как с комплексными CGI скриптами, так и с простыми CGI, и может быть использована для виртуальной среды хостинга, поскольку она позволяет каждому домену использовать свой собственный каталог cgi-bin.

Устанавливаем пакет Fcgiwrap:

  • apt-get install fcgiwrap

После установки должен запуститься демон fcgiwrap, его сокет /var/run/fcgiwrap.socket. Если он не заработал, примените скрипт /etc/init.d/fcgiwrap.

После этого откройте файл конфигурации хоста...

  • nano /etc/nginx/sites-enabled/www.example.com.vhost

... и добавьте раздел location /cgi-bin {} в контейнер server {} :

server {
[...]
   location /cgi-bin/ {
     # Disable gzip (it makes scripts feel slower since they have to complete
     # before getting gzipped)
     gzip off;

     # Set the root to /usr/lib (inside this location this means that we are
     # giving access to the files under /usr/lib/cgi-bin)
     root  /var/www/www.example.com;

     # Fastcgi socket
     fastcgi_pass  unix:/var/run/fcgiwrap.socket;

     # Fastcgi parameters, include the standard ones
     include /etc/nginx/fastcgi_params;

     # Adjust non standard parameters (SCRIPT_FILENAME)
     fastcgi_param SCRIPT_FILENAME  $document_root$fastcgi_script_name;
   }
[...]
}

Перезагрузите nginx :

  • /etc/init.d/nginx reload

Далее создайте каталог cgi-bin - /var/www/www.example.com/cgi-bin, поскольку мы поместили корневой каталог /var/www/www.example.com; в контейнер location /cgi-bin {} :

  • mkdir /var/www/www.example.com/cgi-bin

Теперь помещаем туда CGI скрипты и делаем их исполняемыми. Для проверки создаем небольшой скрипт Hello World Perl (вместо hello_world.cgi допускается использовать расширение .pl -> hello_world.pl):

  • nano /var/www/www.example.com/cgi-bin/hello_world.cgi
#!/usr/bin/perl -w
   # Tell perl to send a html header.
   # So your browser gets the output
   # rather then <stdout>(command line
   # on the server.)
print "Content-type: text/html\n\n";
   # print your basic html tags.
   # and the content of them.
print "<html><head><title>Hello World!! </title></head>\n";
print "<body><h1>Hello world</h1></body></html>\n";
  • chmod 755 /var/www/www.example.com/cgi-bin/hello_world.cgi

Открываем браузер и тестируем скрипт:

http://www.example.com/cgi-bin/hello_world.cgi

Если все сделано верно, Вы увидите такую страницу:

hello world