Configuración y uso de Server Side Includes (SSI) en Linux <author>Paco Brufal, <<htmlurl url="mailto:pbrufal@ctv.es" name="pbrufal@ctv.es">> <date>Versión 0.1, Octubre 1999 <abstract> Este pequeño documento explica de manera sencilla cómo configurar y usar las instrucciones Server Side Includes (SSI) para crear documentos HTML de forma dinámica y sencilla. Asi mismo, este documento se distribuye SIN NINGUNA GARANTIA bajo licencia GPL. No hace falta decir que se admiten sugerencias, ejemplos, correcciones, etc. para posteriores revisiones. </abstract> <toc> <sect>Introducción. El "lenguaje" SSI (Server Side Includes) son una serie de "tags" o etiquetas con un formato determinado, que se incluyen dentro del código HTML de una página, dándole dinamismo y ahorrándonos algo de trabajo. El formato de los tags tiene esta forma: <tscreen><code> [codigo HTML...] Hora local:  [codigo HMTL...] </code></tscreen> El servidor, al enviar esa orden, la sustituiria por la variable $DATE_LOCAL, quedando más o menos así: <tscreen><code> Hora local: Tuesday, 14-Sep-1999 09:35:23 CEST </code></tscreen> El servidor web, antes de enviar éstas páginas, sustituye las etiquetas SSI por sus valores correspondientes, es decir, crea las páginas "on-the-fly" y las envía al navegador. No voy a extenderme más, puesto que el SSI no tiene demasiada dificultad de aprendizaje. Si deseas saber más sobre SSI, visita http://www.apache.org. <sect>Configuración de Apache Vamos a configurar el servidor Apache. La distribución de Linux que he usado yo es Debian 2.1 (Slink), aunque no creo que difiera mucho de otras distribuciones. Revisa los ficheros de configuración de tu servidor y familiarizate con ellos. Si ves que algo de los que pongo no lo tienes en tus ficheros, añadelo. En caso que lo tengas, pero comentado, descomentalo. Lo primero que necesitamos es decirle que acepte etiquetas SSI descomentando la siguiente linea en la sección de los LoadModule, en el fichero /etc/apache/httpd.conf: <tscreen><code> LoadModule includes_module /usr/lib/apache/1.3/mod_include.so </code></tscreen> Para que el servidor reconozca la extensión .shtml (la que llevan las páginas que incluyen SSI), añadiremos esto al fichero /etc/apache/srm.conf: <tscreen><code> # To use server-parsed HTML files AddType text/html .shtml AddHandler server-parsed .shtml </code></tscreen> También podemos poner la opción "XBitHack". Poniendo esta opción, y haciendo ejecutables los ficheros HTML, el servidor comprobará si esos fichero tienen código SSI. Ahora vamos al fichero /etc/apache/access.conf. Miramos dentro del bloque "<Directory /var/www>" (o lo que es lo mismo, el DocumentRoot, donde se alojan las páginas del servidor) y buscamos una linea que empiece por "Options", que estará al principio del bloque. Bien, pues si esa linea es algo parecido a esto: <tscreen><code> Options Indexes FollowSymLinks </code></tscreen> la dejaremos así <tscreen><code> Options Indexes FollowSymLinks +Includes </code></tscreen> Con esto ya podemos incluir etiquetas SSI en nuestras páginas web. Para hacer este documento un poco más util ;) voy a poner unos ejemplos de uso del SSI: <enum> <item>Datos de la conexión <item>Restringir el acceso a determinadas partes del servidor <item>Personalizar las páginas de error </enum> <sect1>Datos de la conexión Este ejemplo servirá para familiarizarnos con SSI. Se trata de una simple página en la que pondremos todos los tags SSI que queramos, y al verla desde un navegador, el servidor sustituirá cada variable por su valor correspondiente, así sabremos qué es y para que sirve cada variable. <tscreen><code> DATE_GMT  DATE_LOCAL  DOCUMENT_NAME  DOCUMENT_PATH_INFO  DOCUMENT_ROOT  DOCUMENT_URI  LAST_MODIFIED  GATEWAY_INTERFACE  HTTP_ACCEPT  HTTP_ACCEPT_CHARSET  HTTP_ACCEPT_ENCODING  HTTP_ACCEPT_LANGUAGE  HTTP_CONNECTION  HTTP_COOKIE  HTTP_HOST  HTTP_IF_MODIFIED_SINCE  HTTP_PRAGMA  HTTP_USER_AGENT  PATH  QUERY_STRING  REMOTE_ADDR  REMOTE_HOST  REMOTE_PORT  REQUEST_METHOD  SCRIPT_FILENAME  SERVER_ADMIN  SERVER_NAME  SERVER_PORT  SERVER_PROTOCOL  SERVER_SIGNATURE  SERVER_SOFTWARE  SCRIPT_NAME  USER_NAME  </code></tscreen> <sect1>Restringir el acceso a determinadas partes del servidor Con este pequeño trozo de código podemos ocultar un enlace según desde donde venga la petición de la página. Es decir, si alguien de nuestra red local solicita una página, el servidor comprobará la IP, y si cumple con la regla SSI, mostrará el enlace en la página web. En caso contrario, no lo mostrará. El código sería algo así: <tscreen><code> [...resto de la página...]  <a href="boletin_interno.html">Boletin Interno de la Empresa</a>  [...resto de la página...] </code></tscreen> Si la IP que solicita la página está en el rango 192.168.1.xxx, podrá ver el enlace. En cambio, si la IP 212.23.125.56 (p. ej.) solicita la misma página, no verá el enlace. <sect1>Personalizar las páginas de error. Con este ejemplo, lo que pretendemos es que cada vez que se produzca un error, el servidor nos diga qué clase de error se ha producido de una manera que cualquier persona lo pueda entender, y no con el típico error "Error 404" y esas cosas. Además, las haremos en varios idiomas, para que cada persona que vea un error, lo pueda leer según con el idioma preferente que tenga definido en el navegador. Lo primero que haremos será añadir este bloque al final del fichero /etc/apache/srm.conf <tscreen><code> # Asignamos un alias a la ruta /var/errordocs/, # es decir, que el path /var/errordocs/ será # la URL http://localhost/errordocs # (al igual que /usr/lib/cgi-bin/ es http://localhost/cgi-bin/...) Alias /errordocs /var/errordocs # Definimos las propiedades de ese directorio <Directory /var/errordocs> AllowOverride none Options MultiViews IncludesNoExec FollowSymLinks AddType text/html .shtml AddHandler server-parsed .shtml </Directory> # Asignamos un documento por cada error (puedes poner tantos como errores # existan). ErrorDocument 403 /errordocs/403.shtml ErrorDocument 404 /errordocs/404.shtml ErrorDocument 500 /errordocs/500.shtml ErrorDocument 400 /errordocs/400.shtml </code></tscreen> Ahora vamos a crear las páginas de error, que se alojarán en el directorio /var/errordocs. Los nombres de los ficheros han de ser los que definimos en el fichero /etc/apache/srm.conf. El diseño de la página es común, lo único que cambia es el cuerpo y el pie de página. Para elegir el idioma del mensaje, usaremos algo así: <tscreen><code>       [...todas las condiciones que desees...] </code></tscreen> Al final de cada página de error, incluiremos la orden <tscreen><code>  </code></tscreen> para que en el pie de página aparezcan una serie de datos variables y comunes a todas las páginas de error. Con esto lo que nos ahorramos es trabajo, ya que lo escribimos una vez, y lo podemos usar en todos las páginas de error. Aqui pongo un pequeño fichero de ejemplo, concretamente el fichero /var/errordocs/404.shtml, que saldrá cuando alguien pida una página que no existe: <tscreen><code> <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta name="Author" content="Paco Brufal"> <title>Error!</title> </head> <body text="#000000" bgcolor="#000000" link="#0000EF" vlink="#51188E" alink="#FF0000"> <center>  <img src="/errordocs/error.jpg" width="320" height="89" alt="Error!" border="0" align="top"> <hr WIDTH="100%">           </center> </body> </html> </code></tscreen> El contenido del fichero foot.shtml es este: <tscreen><code> <a href="mailto:webmaster@dominio.com">WebMaster</a> Dirección remota:  [] Hora local:  </center> </code></tscreen> Los ficheros de error en distintos idiomas han de ser nombrados siguiendo el patrón "<numero-de-error>_<idioma>.html", como por ejemplo: 404_es.html (mensaje de error 404 en castellano), o 500_en.html (mensaje de error 500 en inglés). Ver Anexo C para los códigos de idioma. El fichero 404_es.html podría ser así: <tscreen><code> Error 404 Página no encontrada La página que usted solicita no se encuentra en este servidor. <hr WIDTH="100%"> <center> Si está seguro que este error es fallo del servidor, y no suyo, contacte con </code></tscreen> Ahora solo nos falta hacer un buen diseño de las páginas, traducir los mensajes a sus respectivos idiomas y reiniciar el servidor Apache para que acepte los cambios. <sect1>Consideraciones Lo explicado aqui es muy básico, las posibilidades que ofrece SSI son muy grandes, así que te recomiendo que visites http://www.apache.org para informarte más ampliamente. <sect>Anexos <sect1>Anexo A.- Algunas etiquetas interesantes de SSI <tscreen><code> SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: SSI: </code></tscreen> <sect1>Anexo B.- Algunas variables que se pueden usar con SSI <tscreen><code> Variables:$DATE_GMT Variables:$DATE_LOCAL Variables:$DOCUMENT_NAME Variables:$DOCUMENT_PATH_INFO Variables:$DOCUMENT_ROOT Variables:$DOCUMENT_URI Variables:$LAST_MODIFIED Variables:$GATEWAY_INTERFACE Variables:$HTTP_ACCEPT Variables:$HTTP_ACCEPT_CHARSET Variables:$HTTP_ACCEPT_ENCODING Variables:$HTTP_ACCEPT_LANGUAGE Variables:$HTTP_CONNECTION Variables:$HTTP_COOKIE Variables:$HTTP_HOST Variables:$HTTP_IF_MODIFIED_SINCE Variables:$HTTP_PRAGMA Variables:$HTTP_USER_AGENT Variables:$PATH Variables:$QUERY_STRING Variables:$REMOTE_ADDR Variables:$REMOTE_HOST Variables:$REMOTE_PORT Variables:$REQUEST_METHOD Variables:$SCRIPT_FILENAME Variables:$SERVER_ADMIN Variables:$SERVER_NAME Variables:$SERVER_PORT Variables:$SERVER_PROTOCOL Variables:$SERVER_SIGNATURE Variables:$SERVER_SOFTWARE Variables:$SCRIPT_NAME Variables:$USER_NAME </code></tscreen> <sect1>Anexo C.- Códigos de Idioma <tscreen><code> afrikaans af albanian sq basque eu bulgarian bg byelorussian be catalan ca chinese zh chinese/China zh-CN chinese/Taiwan zh-TW croatian hr czech cs danish da dutch nl dutch/Belgium bl-BE english en english/UK en-GB english/USA en-US fearoese fo finnish fi french fr french/belgium fr-BE french/canada fr-CA french/france fr-FR french/switzerland fr-CH galician gl german de german/austria de-AT german/germanny de-DE german/switzerland de-CH greek el hungarian hu icelandic is indonesian id irish ga italian it japanese ja korean ko macedonia mk norwegian no polish pl portuguese pt portuguese/brazil pt-BR romanian ro russian ru scots gaelic gd serbian sr slovak sk slovenian sl spanish es spanish/argentina es-AR spanish/colombia es-CO spanish/mexico es-MX spanish/spain es-ES swedish sv turkish tr ukrainian uk </code></tscreen> </article>