Metoda lomítko - homepage
O deklaraci dostupných metod, resp. přiřazení handlerů se
stará soubor dispatch_table.py popsaný ve
starším článku. Parametr obslužné funkce (handleru) je
objekt Request. Ten je popsán
v dokumentaci mod_pythonu nebo
v dokumentaci poor_http. Poor Http se snaží být
kompatibilní a tak případné chybějící metody a vlastnosti
objektu budou na podněty uživatelů doplněny. Funkce
obsluhující požadavek má tyto tři základní úkoly:
- Nastavit hlavičky a správný content_type. V hlavičkách se
skrývá celá řada užitečných informací, které zpracovává
klient, tedy browser. Ty nejčastěji používané jsou například
cookie, pomocí něž se identifikuje přihlášení uživatele.
Mohou zde být například i další speciální hodnoty, informace
pro proxy servery atd.
- Vygenerovat datový obsah, který je společně s odpovědí
vrácen http klientu (browseru). V případě ui metod to budou
zejména html stránky, doplněné o data z databází atd. Tento
výstup je možné provést různými způsoby, nejčastěji to bude
ale pomocí metody write, která se volá obdobně jako metoda
write objektu File. Data ja možné posílat jak binární, tak
textová. Před tím než se začnou zapisovat data, je důležité
nastavit právě hlavičku a správný content_type, poté, to již
nebude možné.
- Vrátit správnou návratovou hodnotu, případně skončit
svojí činnost vyvoláním správné výjimky. Funkce by měla
vracet hodnotu http.DONE, případně http.OK. Server Apache
ještě tyto dvě metody rozeznává a v případě http.OK, resp
apache.OK je možné, že výstup bude dále zpracován. Funkci je
možné korektně ukončit pomocí výjimky SERVER_RETURN s
parametrem http statusu. Díky tomu je možné vyvolat korektní
http chybu a o nic dalšího se nestarat. Ve všech ostatních
případech dojde k neočekávanému chování, které bude ukončeno
chybou 500 Internal Server Error.
def light(req):
if False:
# k toto chybe nastesti nikdy nedojde
raise SERVER_RETURN, http.HTTP_NOT_ACCEPTABLE
req.content_type = "text/html" # nastavi content_type
req.headers_out.add("X-My-Info", "Moje vlastni hlavicka") # nastavi hlavicku
html = [
"<html>",
" <head>",
" <title>Jednoduchy priklad</title>",
" </head>",
" <body>",
" <h1>Toto je jednoduchy priklad metody lomitko</h1>",
" <p>Ahoj, tato stranka obsahuje velmi jednoduchy html kod.",
" Dnes je <code>%s</code> a je " % strftime("%Y-%m-%d"),
" <code>%s</code>." % strftime("%H:%M:%S"),
" </p>",
" Dekujeme za navstevu.",
" </body>",
"</html>",
]
for line in html:
req.write(line + '\n') # vystup html kodu
return http.DONE # korektni ukonceni
Error handler
Obdobně jako lze definovat funkci, která se postará o obsluhu
metody aplikace, lze definovat i funkci, která se stará o
obsluhu http chyby, resp. http statusu jiného než 200 Ok.
Rozdíl je především v tom, že taková funkce má navíc za úkol
nastavit správný http kód, na který bude browser správně
reagovat.
def forbidden(req):
content = \
"<html>\n"\
" <head>\n"\
" <title>403 - Pristup odepren</title>\n"\
" <style>\n"\
" body {width: 80%%; margin: auto; padding-top: 30px;}\n"\
" h1 {text-align: center; color: #ff0000;}\n"\
" p {text-indent: 30px; margin-top: 30px; margin-bottom: 30px;}\n"\
" </style>\n"\
" <head>\n" \
" <body>\n"\
" <h1>403 - Pristup odepren</h1>\n"\
" <p>Nemate prava k pristupu k <code>%s</code> na tomto serveru.</p>\n"\
" </body>\n"\
"</html>" % req.uri
req.content_type = "text/html" # nastavi content type
req.status = HTTP_FORBIDDEN # nastavi status kod
req.write(content)
return DONE
Datový vstup
Každá z metod aplikací samozřejmě může zpracovávat
uživatelský vstup, a to odeslaný jak GET tak POST formou. O
ten se v jazyku python stará třída FieldStorage. Poor Http
resp. Poor Publisher tuto třídu sjednocuje a tak je její
použití shodné. Stačí tuto třídu vytvořit s příslušnými
parametry a volat patřičné metody. Jedna ze základních se
jmenuje getfirst a Poor Api ji rozšiřuje o funkci, která je
volána nad získanou metodou.
form = FieldStorage(req, keep_blank_values = True)
nick = form.getfirst(‚nick‘, ‚anonym‘, str)
message = form.getfirst(‚message‘, ‚‘, str)
age = form.getfirst(‚age‘, 0, int)
Toho může být využito například při získávání číselné
hodnoty, nebo získání správného typu stringu (Apache vrací
string ve vlastní třídě, to pak může působit problémy).
Příště
V dalším článku věnovaném webové službě napsané v jazyku
python ukážu jak naprogramovat tzv. sezení. To budeme
vytvářet pomocí samonosné cookie, která je v Poor Api
definovaná třídou PoorSession.