Ver código fonte para SHTML (SSI)


'''SHTML''', também chamado de '''HTML com''' '''Server Side Include''' ('''SSI''') é uma [[Linguagem de marcação|linguagem de marcação de hipertexto]] (códigos aplicados a um [[texto]] na internet) com suporte [[Linguagem server-side|script no servidor]],<ref name="Não_nomeado-yFGE-1">{{Citar web|url=https://oque-e.com/o-que-e-shtml/|titulo=O que é SHTML?|acessodata=2022-07-05|publicado=O que é}}</ref> ou seja, uma linguagem de programação de websites que executa comandos no [[Servidor web|servidor Web]], onde em seguida o resultado é exibido nos [[Navegador (informática)|navegadores de internet]]. SHTML é baseado no servidor [[NCSA HTTPd]].<ref name="ncsa-ssi">{{Citar web|url=http://hoohoo.ncsa.uiuc.edu/docs/tutorials/includes.html|titulo=Server Side Includes (SSI)|acessodata=24 de março de 2019|website=NCSA HTTPd Tutorial|arquivourl=https://web.archive.org/web/19970303194503/http://hoohoo.ncsa.uiuc.edu/docs/tutorials/includes.html|arquivodata=3 de março de 1997|urlmorta=dead}}</ref> Útil para incluir o conteúdo de vários arquivos diferentes em uma página da Web, usando a diretiva <code>#include</code>, geralmente pode ser um código comum em todo as páginas de um portal, como um cabeçalho de página, rodapé de página e, menu de navegação. O SSI também contém diretivas de controle para recursos condicionais e diretivas para chamar programas externos. É suportado pelo [[Servidor Apache|Apache]], LiteSpeed, [[nginx]], [[Internet Information Services|IIS]] e, Jigsaw ([[W3C]]).<ref name="jig">{{Citar web|url=https://www.w3.org/Jigsaw/Doc/User/SSI.html|titulo=SSI Commands|acessodata=24/03/2019|website=W3C}}</ref>

Para que um servidor da Web reconheça um arquivo [[HTML]] habilitado para SSI e, portanto, execute essas instruções, o nome do arquivo deve terminar com uma [[Extensão de nome de ficheiro|extensão]] especial: <code>.stm</code>, <code>.shtm</code>, <code>.shtml</code>,<ref name="Não_nomeado-yFGE-1"/> ou, se o servidor estiver configurado para definir o bit de execução dos comandos.<ref>{{Citar web|url=http://httpd.apache.org/docs/current/howto/ssi.html#configuring|titulo=Configuring your server to permit SSI|acessodata=24 de junho de 2015|website=Apache Tutorial: Introduction to Server Side Includes|publicado=The Apache Software Foundation}}</ref>

== Projeto ==
Por ser uma linguagem de programação e de marcação com design simples, o SSI suporta apenas um [[Tipo de dado|tipo de variável]]: o formato texto e, possui um [[Estrutura de controle|fluxo de controle]] simples com suporte a comandos de escolha, mas os [[Estrutura de controle|loops]] não são suportados, só podem ser feitos por recursão usando include ou [[Redirecionamento de URL|redirecionamento HTTP]].{{Nre|Nevertheless found in some implementations, including Jigsaw.}} Sendo de fácil aprendizado e uso, o SSI é [[Turing completude|Turing-completo]], diferente do processamento complicado [[Linguagem server-side|das linguagens de programação mais ricas em recursos]].<ref>{{Citar web|url=http://www.janschejbal.de/projekte/ssituring/|titulo=Server Side Includes Turing machine, Jan Schejbal.|acessodata=2012-12-06|publicado=Janschejbal.de}}</ref>

O SSI tem uma sintaxe simples: <!--#directive parameter=value parameter=value --> como por exemplo, usar um rodapé repetitivo <!--#include virtual="/footer.html" -->.<ref name=":0">{{Citar web|url=https://httpd.apache.org/docs/current/howto/ssi.html.en|titulo=Apache httpd Tutorial: Introduction to Server Side Includes - Apache HTTP Server Version 2.4|acessodata=2022-07-05|website=httpd.apache.org}}</ref> Uma página da web que exibe uma cotação diária, pode incluir um arquivo de cotação colocando o seguinte código na página: <!--#include virtual="../quote.txt" -->. Onde qualquer alteração no arquivo quote.txt, será exibido em todas as páginas que o incluem, exibirão a cotação diária mais recente.<ref name=":0" /> A inclusão não se limita a arquivos, também pode ser a saída de texto de um programa ou o valor de uma variável do sistema, como a hora atual por exemplo.

As diretivas são colocadas na forma de comentários HTML. Mas se o SSI não estiver habilitado, os usuários não verão os resultados das diretivas SSI na página web.<ref>{{Citar web|url=http://httpd.apache.org/docs/current/howto/ssi.html#basic|titulo=Basic SSI Directives and Syntax|data=2018-02-09|acessodata=2018-02-09}}</ref>


== Diretivas ==

=== Comum ===
A seguir estão as diretivas SSI dos tempos do [[NCSA HTTPd]] (década de 1990).<ref name="ncsa-ssi">{{Citar web|url=http://hoohoo.ncsa.uiuc.edu/docs/tutorials/includes.html|titulo=Server Side Includes (SSI)|acessodata=24 de março de 2019|website=NCSA HTTPd Tutorial|arquivourl=https://web.archive.org/web/19970303194503/http://hoohoo.ncsa.uiuc.edu/docs/tutorials/includes.html|arquivodata=3 de março de 1997|urlmorta=dead}}</ref> Algumas implementações não suportam todas.<ref name="nginx-ssi">{{Citar web|url=http://nginx.org/en/docs/http/ngx_http_ssi_module.html|titulo=Module ngx_http_ssi_module|acessodata=16 de novembro de 2021|website=nginx documentation}}</ref>
{| class="wikitable"
|+Diretivas NCSA HTTPd SSI
! Diretiva
! Parâmetros
! Descrição
! Exemplo
|-
| <code>include</code>
| arquivo ou virtual
| Esta é a diretiva SSI mais usada. Permite que o conteúdo de um documento seja [[Transclusão|transcluído]] (adicionado integralmente) em outro. Este também pode ser um arquivo habilitado para SSI. O <code>file</code> ou parâmetros <code>virtual</code> especificam o arquivo (página [[HTML]], arquivo de texto, script, etc.) a ser incluído. O Apache HTTPd suporta <code>include</code>.<ref name="apache-httpd-doc-mod-include">{{Citar web|url=http://httpd.apache.org/docs/current/mod/mod_include.html#element.include|titulo=Apache Module mod_include|acessodata=2021-09-07|website=Apache HTTP Server Version 2.4 Documentation|publicado=Apache Software Foundation}}</ref> Se o processo não tiver acesso para ler o arquivo ou executar o script, a inclusão falhará. O parâmetro  <code>virtual</code> trata de qualquer caminho de diretório como se fosse parte da URL, enquanto <code>file</code> trata de qualquer caminho de diretório como no sistema de arquivos subjacente. Ao usa-lo é proibido referenciar caminhos absolutos ou <code>../</code> para acessar um diretório pai. O Apache recomenda neste caso usar <code>virtual</code>.<ref name="apache-httpd-doc-mod-include" />
|<pre style="white-space:pre"><nowiki><!--#include virtual="menu.cgi" -->
<!--#include file="footer.html" --></nowiki></pre>
|-
| <code>exec</code>
| cgi ou cmd
| Esta diretiva executa um programa, script ou comando shell no servidor. O parâmetro cmd especifica um comando do lado do servidor; o parâmetro cgi especifica o caminho para um script [[CGI]]. The PATH_INFO and QUERY_STRING of the current SSI script will be passed to the CGI script, as a result "exec cgi" should be used instead of "include virtual".<ref name="apache-httpd-doc-mod-include" />
|<pre style="white-space:pre"><nowiki>
<!--#exec cgi="/cgi-bin/foo.cgi" -->
<!--#exec cmd="ls -l" --></nowiki></pre>
|-
| <code>echo</code>
| var
| Esta diretiva exibe o conteúdo de uma [[variável de ambiente]] [[Hypertext Transfer Protocol|HTTP]] especificada. Variables include HTTP_USER_AGENT, LAST_MODIFIED, and HTTP_ACCEPT.<ref name="apache-httpd-doc-mod-include" />
|<pre style="white-space:pre"><nowiki>Your IP address is:
<!--#echo var="REMOTE_ADDR" --></nowiki></pre>
|-
| <code>config</code>
| timefmt, sizefmt ou errmsg
| Esta diretiva configura os formatos de exibição para a data, hora, tamanho do arquivo e mensagem de erro (retornada quando um comando SSI falha).
|<pre style="white-space:pre"><nowiki><!--#config timefmt="%y %m %d" -->
<!--#config sizefmt="bytes" -->
<!--#config errmsg="SSI command failed!" --></nowiki></pre>
|-
| <code>flastmod</code> e <code>fsize</code>
| arquivo ou virtual
| Essas diretivas exibem a data em que o documento especificado foi modificado a última vez, ou o tamanho do documento especificado. O parâmetros virtuais especificam o documento a ser usado. O parâmetro file define o documento em relação ao caminho do documento; o parâmetro virtual define o documento em relação à raiz do documento.
|<pre style="white-space:pre"><nowiki><!--#flastmod virtual="index.html" -->
<!--#fsize file="script.pl" --></nowiki></pre>
|}

=== Diretivas de controle ===
As diretivas de controle são posteriormente adicionadas ao SSI. Eles incluem o onipresente controle de fluxo if-elif-else-endif e escrita de variáveis, bem como recursos mais exóticos, como loops encontrados apenas em algumas implementações.
{| class="wikitable"
!Diretiva
! Parâmetros
! Descrição
! Exemplo
! Encontrado em
|-
|{{Lista simples|* if
* elif
* else
* endif}}
| exp
| [[Estrutura de seleção|instrução if]] usada para testes de condição que podem determinar e gerar várias páginas lógicas a partir de uma única página física. <code>elif</code> é uma abreviação para else-if aninhado. <code>else</code> e <code>endif</code> não aceitam parâmetros.
A sintaxe de expressão varia entre as implementações. Verificações de existência de variável e igualdade/regex são comumente suportadas. O Jigsaw usa expressões divididas em vários atributos.<ref name="jig">{{Citar web|url=https://www.w3.org/Jigsaw/Doc/User/SSI.html|titulo=SSI Commands|acessodata=24/03/2019|website=W3C}}</ref>
|<pre style="white-space:pre"><nowiki>
<!--#if expr="${Sec_Nav}" -->
<!--#include virtual="secondary_nav.txt" -->
<!--#elif expr="${Pri_Nav}" -->
<!--#include virtual="primary_nav.txt" -->
<!--#else -->
<!--#include virtual="article.txt" -->
<!--#endif -->
</nowiki></pre>
|Onipresente.
|-
| definir
| var, valor
| Define o valor de uma variável SSI. O Apache fornece parâmetros adicionais para [[Codificação|codificações]] .<ref name="apache-inc" />
|<pre style="white-space:pre"><nowiki><!--#set var="foo" value="bar" --></nowiki></pre>
| Apache,<ref name="apache-inc">{{Citar web|url=https://httpd.apache.org/docs/current/mod/mod_include.html|titulo=mod_include|acessodata=25 de março de 2019|website=Apache HTTP Server}}</ref> Nginx<ref name="nginx">{{Citar web|url=https://nginx.org/en/docs/http/ngx_http_ssi_module.html|titulo=ngx_http_ssi_module|acessodata=25 de março de 2019|website=nginx.org}}</ref>
|-
| <code>printenv</code>
|
| Esta diretiva gera uma lista de todas as variáveis SSI e seus valores, incluindo variáveis ambientais e definidas pelo usuário. Não possui atributos.
|<pre style="white-space:pre"><nowiki><!--#printenv --></nowiki></pre>
| Apache<ref name="apache-inc" />
|}

== Ver também ==

* [[Exemplos de Máquinas de Turing]]
* [[Linguagem client-side]]

{{notas}}
<references group="lower-alpha"/>
== Referências ==
{{Reflist}}
== Ligações externas ==
** [http://httpd.apache.org/docs/current/mod/mod_include.html Referência do mod_include no Apache], chama diretivas "elementos" (em inglês)
** [https://nginx.org/en/docs/http/ngx_http_ssi_module.html Referência do módulo ngx_http_ssi_module no Nginx], chama as diretivas "comandos".
** [https://web.archive.org/web/19971210170837/http://hoohoo.ncsa.uiuc.edu/docs/tutorials/includes.html Referência do NCSA HTTPd SSI original], chama as diretivas "comandos".
** [https://www.w3.org/Jigsaw/Doc/User/SSI.html Comandos de inclusão do lado do servidor no W3C Jigsaw], chama diretivas "elementos",  expandido com [[servlet]]s, [[JDBC]], [[Cookie (informática)|cookie HTTP]] e loops.
* Tutoriais:
** [https://httpd.apache.org/docs/current/es/howto/ssi.html Tutorial Apache SSI] (em espanhol)
** [http://www.andreas.com/faq-ssi.html Guia simples sobre SSI] (em inglês)
** [http://www.ssi-developer.net/ssi/ Desenvolvedor SSI, Apache Server Side Includes]

[[Categoria:Tecnologia web]]
[[Categoria:Linguagens de script]]
[[Categoria:HTML semântica]]
[[Categoria:Linguagens de marcação]]