CGI

• Co to je CGI
• Instalace
• Odpověď prohlížeči
• Požadavek prohlížeče
• Proměnné prostředí

Co to je CGI

CGI je zkratka pro Common Gateway Interface, což je rozhraní specfikující, jakým způsobem předávají Vaše webovské prohlížeče informace serveru. Toho se využívá především při generování dynamických www stránek. Tyto informace spracovává nějaký (cgi) program.

Zde se dozvíte jak Váš program napsaný v Pythonu tyto informace získá od serveru a jakým způsobem je předá zpět prohlížeči.

Instalace

Je třeba, aby jste měli nainstalovaný nějaký server. Vzhledem k tomu, že používám server apache, popíšu zde některé "konfigurační záležitosti".

1. Apache je třeba nejdříve nainstalovat a zkonfigurovat internetové připojení; pokud internet nemáte tak loopback. Tím se zde zabývat nebudu.
2. Je třeba vědět, kde můžete cgi programy mít. Server apache povoluje (vzhledem k bezpečnosti) spouštět cgi programy jen ze speciálních adresářů. Které to jsou najdete v souboru /etc/apache/httpd.conf. Tento soubor se může v různých distribucích Linuxu jmenovat různě (například /etc/httpd/httpd.conf). V tomto souboru najďete řádku s klíčovým slovem ScriptAlias.
   ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/.
   Zde vydíte, že je možné cgi programy je ukládat do adresáře /usr/lib/cgi-bin/ a v html dokumentu se na ně odkazujete cestou "/cgi-bin/program.cgi". Těchto ScriptAliasů můžete zadat více.
3. Je třeba apache zkonfigurovat. Konfigurace se nejlépe provede příkazem apacheconfig. Odpovíte na pár jednoduchých dotazů (pokud nevíte na co se vás to ptá, věřte implicitně nastaveným hodnotám).

Odpověď prohlížeči

Začneme tak trochu od konce a nejdříve si ukážeme, co je třeba udělat, aby cgi program komunikoval s prohlížečem. Budu předpokládat, že Vaše cgi programy jsou spouštěny serverem z adresáře /usr/lib/cgi-bin/ a ScriptAlias tohoto adresáře je /cgi-bin/. CGI program by měl mít koncovku .cgi, ovšem není to povinné. Apache může být zkonfigurován tak, aby obyčejný uživatel mohl vytvářet cgi programy v podadresáři domovského adresáře public_html. Pokud nemáte přístup do /usr/lib/cgi-bin/ vyzkoušejte tuto možnost.

Nejdříve je třeba poslat prohlížeči hlavičku HTTP, aby prohlížeč věděl, co má od serveru očekávat. První řádek určuje, jaká data budou následovat. Například:

• Content-type: text/plain - bude posílán obyčejný text.
• Content-type: text/html - text ve formátu HTML
• Content-type: image/jpg - bude následovat obrázek ve formátu jpg

Další důležitou informací v hlavičce by mělo být, jaký typ kódování používáte. V Linuxu to bude nejspíš iso-8859-2, ve Windows windows-1250.

• Charset="iso-8859-2"
• Charset="windows-1250"
• Charset="us-asci"
• atd.

Hlavička může obsahovat více informací než jenom jestli posíláme text či obrázek, ale zatím se s tím spokojíme. Hlavičku ukončí prázdný řádek.

Teď jste již schopni napsat jednoduchý cgi program. V adresáři /usr/lib/cgi-bin/ vytvořte soubor pokus.cgi a zapište do něj následující:

#!/usr/bin/python
#
# prvni cgi progarm v pythonu

print 'Content-type: text/plain; Charset="iso-8859-2"'
print ''              # hlavicka ukoncena prazdnym radkem
print 'Hello World'

Souboru nastavte příslušná práva ke spouštění. Více k vytvoření spustitelného programu v Pythonu najdete v kapitole Hello World. Aby mohli Váš program spouštět lidé na internetu, je třeba nastavit právo spuštění nejen uživateli, ale i ostatním uživatelům: chmod o+x pokus.cgi.

Požadavek prohlížeče

Teď jen stačí do Vašeho prohlížeče zadat adresu

http://localhost/cgi-bin/pokus.cgi

Localhost reprezentuje Váš počítač (počítač, na kterém běží server apache), při vstupu z internetu jej nahradíte svou internetovou adresou. Pokud máte soubor uložen v adresáři public_html a Váš login (tedy jméno, pod kterým se přihlašujete k počítači) je rimmer, zadejte

http://localhost/~rimmer/pokus.cgi

Váš prohlížeč by měl zobrazit Hello World. Pokud se nezobrazí nic, pak jste zadali adresu špatně. Skontrolujte si Vaší konfiguraci apache. Pokud se Vám vrátí zdrojový text programu pokus.cgi, pak je buď v adresáři ve kterém server neumožňuje programy spouštět, nebo jste nezadali správně práva spuštění k souboru pokus.cgi. Třetí možností chyby by bylo, kdyby jste v cgi programu zadali špatně hlavičku - pro jistotu dbejte na velikost písmen. Pokud uděláte chybu v programu Pythonu (třeba v syntaxi, nebo když dojde k nějaké výjimce), vrátí Vám server Internal Server Error.

Proměnné prostředí

Pokud se Vám program pokus.cgi podařilo spustit, máte vyhráno. Můžete tvořit dynamické stránky, můžete si například zaznamenávat kdy si někdo tento cgi program vyžádal (třeba pomocí Modulu DateTime), sčítat kolikrát (oblíbené počítadla) a vše si zaznamenávat do textového souboru, nebo třeba databáze PostgreSQL.

Možná Vás však budou zajímat informace, jako například který webovský prohlížeč si informace žádá, z jakého počítače atd. Tyto informace server předává programu jako proměnné prostředí. Kdesi v paměti vytvoří takovou tabulku, která má dva sloupce: NÁZEV+HODNOTA. Například pod názvem HTTP_USER_AGENT se krývá identifikace prohlížeče, který si žádá od programu data.

Tyto informace získáte pomocí Pythonovského modulu os a jeho instance environ. Spusťte Python v interaktivním režimu, načtěte modul os a vytiskněte environ.

rimmer: $ python
Python 2.1.3 (#1, Apr 20 2002, 10:14:34)
[GCC 2.95.4 20011002 (Debian prerelease)] on linux2
Type "copyright", "credits" or "license" for more information.
>>> import os
>>> print os.environ
{'HOME': '/home/rimmer', '_': '/usr/bin/python', 'PS1': '\\u: \\$ ', 'LS_OPTION
S': '--color', 'MAIL': '/var/mail/rimmer', 'USER': 'rimmer', 'LOGNAME': 'rimmer
', 'HUSHLOGIN': 'FALSE', 'PATH': '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr
/bin:/sbin:/bin:/usr/bin/X11', 'OLDPWD': '/usr/lib', 'SHLVL': '1', 'PWD': '/usr
/lib/cgi-bin','SHELL': '/bin/bash', 'TERM': 'linux', 'HZ': '100'}
>>>

Hodnoty jsou v instanci environ uloženy jako slovník. Všimněte si, že environ neobsahuje slibovanou hodnotu HTTP_USER_AGENT. Tuto a jí podobné hodnoty totiž do proměnných prostředí přidává server. Upravte cgi program pokus.cgi tak, aby vypisoval všechny klíče a proměnné:

#!/usr/bin/python
#

print 'Content-type: text/html; Charset="iso-8859-2"'
print '' # hlavicka ukoncena prazdnym radkem

print '<.phpl><body>'
import os
for i in os.environ.keys():
        print '<b>',i,'</b>',os.environ[i],'<br>'

print '</body></html>'

<-- Python -->