1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>CGILua: geração de scripts para a Web usando Lua</title>
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"><a href="http://www.keplerproject.org"><img alt="Logotipo do CGILua" src="cgi-128.gif"/></a></div>
<div id="product_name"><big><strong>CGILua</strong></big></div>
<div id="product_description">Geração de scripts para a Web usando Lua</div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>CGILua</h1>
<ul>
<li><a href="index.html">Início</a>
<ul>
<li><a href="index.html#overview">Visão geral</a></li>
<li><a href="index.html#status">Status</a></li>
<li><a href="index.html#download">Download</a></li>
<li><a href="index.html#history">Histórico</a></li>
<li><a href="index.html#incompatibility">Incompatibilidades</a></li>
<li><a href="index.html#credits">Créditos</a></li>
<li><a href="index.html#contact">Fale conosco</a></li>
</ul>
</li>
<li><a href="manual.html">Manual</a>
<ul>
<li><a href="manual.html#intro">Introdução</a></li>
<li><a href="manual.html#installation">Instalação</a></li>
<li><a href="manual.html#config">Configuração</a></li>
<li><a href="manual.html#scripts">Lua Scripts</a></li>
<li><a href="manual.html#templates">Lua Pages</a></li>
<li><a href="manual.html#parameters">Parâmetros</a></li>
</ul>
</li>
<li><a href="reference.html">Referência</a>
<ul>
<li><a href="reference.html#headers">Cabeçalhos</a></li>
<li><a href="reference.html#contents">Geração de conteúdo</a></li>
<li><a href="reference.html#prep">Lua Pages</a></li>
<li><a href="reference.html#variables">Variáveis do CGILua</a></li>
<li><a href="reference.html#error_handling">Tratamento de erros</a></li>
<li><a href="reference.html#behavior">Comportamento do CGILua</a></li>
<li><a href="reference.html#urlcode">Codificação de URL</a></li>
<li><a href="reference.html#auxiliar">Funções auxiliares</a></li>
<li><a href="reference.html#index">Índice alfabético</a></li>
</ul>
</li>
<li><a href="libraries.html">Bibliotecas</a>
<ul>
<li><a href="libraries.html#cookies">Cookies</a></li>
<li><a href="libraries.html#serialize">Serialize</a></li>
<li><a href="libraries.html#session">Session</a></li>
</ul>
</li>
<li><strong>SAPI</strong></li>
<li><a href="license.html">Licenças</a></li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h2>API do servidor</h2>
<p>A API do servidor (SAPI) é um conjunto de funções que abstrai o servidor Web e o disparador usado. Um disparador de SAPI é o mecanismo que permite a um servidor Web executar e comunicar-se com o CGILua e os aplicativos Web. A SAPI permite a abstração de uma série de detalhes internos, fazendo com que o CGILua seja muito mais portátil, já que transportar o CGILua para uma nova plataforma significa simplesmente escrever um disparador de SAPI para a plataforma de destino.</p>
<p>No momento, o CGILua oferece suporte a Apache, Microsoft IIS, Tomcat e Xavante como servidores Web, e a CGI, FastCGI, mod_lua, ISAPI e servlets como disparadores.</p>
<p>As funções são separadas em dois pacotes: <code>SAPI.Request</code> e <code>SAPI.Response</code>:</p>
<dl class="reference">
<dt><strong><code>SAPI.Request.getpostdata ([n])</code></strong></dt>
<dd>Obtém um bloco de <em>dados de POST</em>. O parâmetro opcional <em>n</em> é o número de bytes para ler (o tamanho de bloco padrão será usado se nenhum parâmetro for informado).<br /> Retorna o bloco como uma string Lua.</dd>
<dt><a href="#servervariable"><strong><code>SAPI.Request.servervariable (string)</code></strong></a></dt>
<dd>Obtém o valor de uma variável de ambiente do servidor. O argumento pode ser uma das <a href="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">variáveis CGI</a> definidas, embora nem todos os servidores implementem o conjunto completo de variáveis. O conjunto consiste em:<br />
<ul>
<li><strong><code>AUTH_TYPE</code></strong> - se o servidor suportar autenticação de usuário e o script estiver protegido, este é o método de autenticação específico ao protocolo usado para validar o usuário.</li>
<li><strong><code>CONTENT_LENGTH</code></strong> - o tamanho do conteúdo como fornecido pelo cliente.</li>
<li><strong><code>CONTENT_TYPE</code></strong> - para consultas que têm informações anexadas, por exemplo, HTTP POST e PUT, este é o tipo de conteúdo dos dados.</li>
<li><strong><code>GATEWAY_INTERFACE</code></strong> - a revisão da especificação CGI com a qual esse servidor é compatível. Formato: CGI/revisão</li>
<li><strong><code>PATH_INFO</code></strong> - informações adicionais sobre o caminho, conforme fornecidas pelo cliente. Em outras palavras, os scripts podem ser acessados por meio dos respectivos nomes de caminho virtual, seguidos de informações adicionais no final desse caminho. As informações adicionais são enviadas como PATH_INFO. Essas informações devem ser decodificadas pelo servidor se vierem de uma URL antes de serem passadas para o script CGI.</li>
<li><strong><code>PATH_TRANSLATED</code></strong> - o servidor fornece uma versão convertida de PATH_INFO, que realiza quaisquer mapeamentos de virtual para físico no caminho.</li>
<li><strong><code>QUERY_STRING</code></strong> - as informações inseridas após o "?" na URL que fez referência a esse script. Essas são as informações da consulta e não devem ser decodificadas. Esta variável deve ser sempre definida quando houver informações da consulta, qualquer que seja a decodificação da linha de comando.</li>
<li><strong><code>REMOTE_ADDR</code></strong> - o endereço IP do host remoto que faz o pedido.</li>
<li><strong><code>REMOTE_HOST</code></strong> - o nome do host que faz o pedido. Se o servidor não tiver essas informações, ele define REMOTE_ADDR e não define esta variável.</li>
<li><strong><code>REMOTE_IDENT</code></strong> - se o servidor HTTP oferecer suporte à identificação RFC 931, esta variável será definida com o nome do usuário remoto recuperado do servidor. O uso desta variável deve ser limitado apenas à conexão.</li>
<li><strong><code>REMOTE_USER</code></strong> - se o servidor oferecer suporte à autenticação de usuário e o script estiver protegido, este é o nome de usuário com o qual eles foram autenticados.</li>
<li><strong><code>REQUEST_METHOD</code></strong> - o método com o qual o pedido foi feito. Para HTTP, isto equivale a "GET", "HEAD", "POST" etc.</li>
<li><strong><code>SCRIPT_NAME</code></strong> - um caminho virtual para o script em execução, usado em URLs auto-referentes.</li>
<li><strong><code>SERVER_NAME</code></strong> - o nome do host do servidor, o alias do DNS ou o endereço IP como exibido em URLs auto-referentes.</li>
<li><strong><code>SERVER_PORT</code></strong> - o número da porta à qual o pedido foi enviado.</li>
<li><strong><code>SERVER_PROTOCOL</code></strong> - o nome e a revisão do protocolo de informações com o qual este pedido foi enviado. Formato: protocolo/revisão</li>
<li><strong><code>SERVER_SOFTWARE</code></strong> - o nome e a versão do software do servidor Web que responde ao pedido (e executa o gateway). Formato: nome/versão</li>
</ul>
Além desses, as linhas do cabeçalho recebidas do cliente, se houver, são colocadas no ambiente com o prefixo <code>HTTP_</code> seguido do nome do cabeçalho. Quaisquer caracteres <code>-</code> (hífen) no nome do cabeçalho são alterados para caracteres <code>_</code> (sublinhado). O servidor pode excluir quaisquer cabeçalhos que já tenha processado, por exemplo, <em>Authorization</em>, <em>Content-type</em> e <em>Content-length</em>. Se necessário, o servidor pode optar por excluir todos ou qualquer um desses cabeçalhos se a inclusão exceder algum limite do ambiente do sistema.<br />
Retorna uma string.</dd>
<dt><strong><code>SAPI.Response.contenttype (string)</code></strong></dt>
<dd>Envia o cabeçalho <em>Content-type</em> para o cliente. A string fornecida está na forma "<em>tipo</em>/<em>subtipo</em>". Esta função deve ser chamada antes que qualquer saída seja enviada com o uso de <code>SAPI.Response.write</code>.<br /> Não retorna nada.</dd>
<dt><strong><code>SAPI.Response.errorlog (string)</code></strong></dt>
<dd>Gera uma saída de erro usando a string fornecida.<br /> Não retorna nada.</dd>
<dt><strong><code>SAPI.Response.header (header, value)</code></strong></dt>
<dd>Envia um cabeçalho genérico para o cliente. O primeiro argumento deve ser o nome do cabeçalho, por exemplo, "Set-Cookie". O segundo deve ser o valor. Esta função não deve ser usada em substituição às funções <code>SAPI.Response.contenttype</code> ou <code>SAPI.Response.redirect</code>.<br /> Não retorna nada.</dd>
<dt><strong><code>SAPI.Response.redirect (url)</code></strong></dt>
<dd>Envia o cabeçalho <em>Location</em> para o cliente. A <code>url</code> fornecida deve ser uma string.<br /> Não retorna nada.</dd>
<dt><strong><code>SAPI.Response.write (string)</code></strong></dt>
<dd>Gera uma saída usando a string fornecida.<br /> Não retorna nada.</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer">valid</a></p>
<p><small>$Id: sapi.html,v 1.3 2005/11/03 18:48:57 carregal Exp $</small></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
