Server Side Includes

SSI шагает по планете и становится все более популярным в силу своей безмерной простоты. Перспективы, которые открывает использование серверных включений, очень заманчивы. Например, Вам больше не придется заменять панель навигации на каждой странице, ибо в SSI такая проблема решается одним тыком. Мы создаем некий файл menu.html, где прописываем тэги нашей панели. Затем открываем исходный index.html, вырезаем оттуда меню и ставим вместо него следующее: <!--#include virtual="menu.html" -->. Для верности я рекомендую сменить расширение каждой страницы на shtml, хотя у многих хостеров таких проблем не возникает.

Ну вот, казалось бы на этом наше изучение можно прекратить, ибо главной цели мы все-таки добились. Но синтаксис SSI по-прежнему остается для нас загадкой за исключением пары атрибутов рассмотренных выше. Давайте ознакомимся со всеми преимуществами SSI:

• размещение повторяющихся элементов. Если необходимо на каждой странице проекта вставить определенное для всего сайта меню, то реализовать это можно средствами всего лишь одной команды, рассмотренной выше.
• возможность включения на страницу информации, предоставленной посетителем без изменения ими HTML-кода. При этом весь контент прописывается в определенный файл, подгружаемый с помощью директив SSI.
• вывод даты и времени последнего обновления.
• размещение на странице динамического, то есть постоянно изменяющегося элемента.

Это далеко не все, но самые распространенные области применения SSI. А теперь я предлагаю Вам рассмотреть основные атрибуты языка, которые используются повсеместно:

CONFIG

ERRMSG - задает по умолчанию сообщение, которое передается при обнаружении ошибки во время синтаксического анализа документа.

<!-- #config errmsg = " Error: file not found " -->

SIZEFMT - устанавливает формат, используемый при отображении размера файла. Допустимы значения - bytes или abbrev, которое округляет размер до ближайшего килобайта.

<!-- #config sizefmt = "abbrev" -->

TIMEFMT - устанавливает формат отображения даты и времени.

<!-- #config timefmt = " %A, %B, %e, %Y " -->

ECHO

VAR - выводит на страницу значение переменной.

<!-- #echo var = " DATE_GMT " -->

EXEC

CGI - указывает относительный путь к сценарию.

<!-- #exec cgi = " /cgi-bin/script.pl " -->

FSIZE

FILE - задает месторасположение файла в виде пут, относительно каталога, в котором находится анализируемый документ.

VIRTUAL - задает путь относительно текущего документа. Если он не начинается со слэша (/), то считается относящимся к данному документу.

The size of this file is <!-- #fsize file = " somefile.html " -->

INCLUDE

FILE - см. выше.

VIRTUAL - см. выше. Всегда стоит использовать именно этот параметр.

<!-- #include virtual = " somefile.html " -->

SET

VAR - имя переменной.

VALUE - значение, присваиваемое переменной.

<!-- #set var = "int" value = "544" -->

Теперь рассмотрим переменные включений, которые используются наиболее часто.

DATE_GMT - текущая дата по Гринвичу.

DATE_LOCAL - текущая дата по местному времени.

DOCUMENT_NAME - имя текущего файла (исключая путь).

DOCUMENT_URL - путь url текущего файла.

LAST_MODIFIED - дата и время последнего изменения текущего файла.

REMOTE_ADDR - удаленный IP-адрес, с которого пользователь делает запрос.

REMOTE_HOST - имя удаленного хоста, с которого пользователь делает запрос.

"Includes" (англ. "включать") означает, что SSI добавляет что-то на ваши страницы.

"Server Side" означает то, что SSI обслуживаются сервером, а не браузером. В то время как сервер посылает вашу страницу в браузер посетителя, он сканирует страницу, ища специальные теги, которые сообщают о том, что надо включать вместо них. Когда он находит такие теги, он включает блоки кода вместо этого тега и отсылает результат.

Где Вы бы не использовали один и тот же код на страницах сайта (такой как панели навигации, формы подписки и т.д.), используйте SSI и Вам придется поменять только один файл, чтобы внести изменения на все страницы, где используется SSI.

Но если это так просто, то почему не каждый использует SSI? Ответов два:

 1) эта процедура занимает несколько наносекунд у Вашего сервера на сканирование и добавление;

 2) не каждый знает о том как использовать SSI.

Большинство хостинговых компаний позволяет использовать SSI. Обычным требованием в таком случае является расширение .shtml для таких страниц. Это вызвано тем, что использование SSI занимает часть ресурсов сервера и определенный период времени. Таким образом Вы будете использовать .shtml расширение для SSI-страниц и расширения .html and .htm для всех остальных.

Загрузите эти два файла на сервер и посмотрите файл mytest.shtml в браузере. Если Вы видите фразу "It goes here. Here I am!", то это значит, что сервер поддерживает SSI.

Заметьте, что теги SSI находятся внутри тегов комментария. Некоторые серверы будут работать нормально если есть пробел после <!-- и пробел перед --> . Но некоторые серверы будут давать ошибку. Пример:

<!-- #include _________ -->

возможно будет работать на некоторых серверах, но не на всех. Чтобы быть уверенным в работоспособности SSI пишите так:

<!--#include _________-->

А теперь мы покажем примеры того, как правильно использовать SSI:

Тег: <!--#include file="__________"-->

Замените подчеркивание на имя файла который Вы хотите включить на страницу. Имя файла может быть любым (обычно расширения таких файлов .txt .html), но это должен быть текст. Это может быть простой текст, код HTML, JavaScript, и т.п. Однако нельзя использовать графические и звуковые файлы.

Файл который Вы включаете может иметь HTML код для графики и звука, но вы не можете вставлять их напрямую. Файл должен находится в той же директории что и .shtml страница.

(2) Тег: <!--#include virtual="__________"-->

Тоже самое что и file="__________" за исключением того что файл может находится в другой директории.

Примеры:

"../filename.txt" 
"nextdir/filename.txt"

(3) Тег: <!--#exec cgi="__________"-->

Замените подчеркивание на имя CGI-скрипта. Имя файла может быть любым, но не допускается наличие адреса http://... . CGI-скрипт должен возвращать текст, но этот тектс может быть JavaScript или HTML-код для графики и звука или другого кода, который обрабатывается браузером

Используя эти 3 простых тега у Вас будет один кусок кода который будет включен на все страницы вашего сайта.

Так же вы можете добавлять результаты работы CGI-скриптов, включая счетчики, баннеры, новости и погоду с других сайтов и многое другое, что умеют делать CGI-скрипты.

Вся эта конструкция займет несколько секунд на загрузку, но это всего лишь демонстрация свободы творчеcтва при использовании SSI.

Что сулит нам SSI?

Для того чтобы сервер в HTML-документах распознавал SSI-директивы, необходимо дать ему на то указания. Наиболее распространенный способ, позволяющий это сделать, состоит в изменении расширения файла с .html на .shtml.

Даже если вы не собираетесь использовать возможности SSI прямо сейчас, все равно имеет смысл дать всем страничным файлам такое расширение, чтобы потом не пришлось переправлять ссылки. Файлы переименовать, конечно же, просто, но ссылки на них стоят на других сайтах, — поди найди их все и исправь. Так что лучше сразу использовать SSI, тем более что это очень просто.

Однако не все так безоблачно, как кажется на первый взгляд. Каждая директива обрабатывается сервером отдельно, поэтому если вы поместите на странице слишком много директив, то производительность последнего может значительно снизиться. Но большинство современных web-серверов имеют достаточно большую мощность, и замедление узла, связанное с выполнением SSI-директив, будет не очень заметным.

Что ж, теперь давайте посмотрим, какие же возможности предоставляет нам эта технология. Любая SSI-вставка имеет следующий вид:

<!--#команда параметр=”значение”-->,

Причем между символами <!--# и --> не должно быть пробелов. Такой тэг, только без знака #, служит комментарием в HTML-коде. Если по какой-то причине на сервере отключена поддержка SSI, то директивы не будут выполняться, соответственно, не будут и отображаться их результаты работы в окне браузера.

Начнем с самой полезной и часто используемой директивы #include. С ее помощью web-мастера экономят много сил и времени. Она позволяет вставлять в заданное место страницы содержание внешнего файла и имеет два параметра: file и virtual.

Параметр file определяет расположение вставляемого файла относительно текущего документа. Допустим, вы хотите SSI-вставкой включить в страницу ваше авторское право. Нет ничего проще. Записываем его в отдельный файл, сохраняем в данном каталоге и подгружаем директивой

<!--#include file=”author.txt”-->

Но лучше это сделать с помощью параметра virtual, который предназначен для указания абсолютного пути к файлу:

<!--#include virtual=”/path/author.txt”-->.

Следующей не менее популярной командой является команда установки значения переменной #set:

<!--#set var=”имя_переменной” value=”значение_переменной”-->.

Используя эту SSI-вставку с варьирующимися значениями определенной в ней переменной, вы можете получать различные результаты. Для того чтобы переменная могла участвовать в выражении, перед ее значением ставится знак $, который показывает, что это действительно переменная, а не просто текст.

Наряду с директивой #set с переменными еще работает команда #echo, которая печатает значение переменной. Например:

<!--#set var=”number” value=”&2002”--> <!--#echo var=”number”-->

После выполнения этих директив в окне браузера отобразится число 2002.

Имя переменной может быть произвольным, как в приведенном выше примере, а может быть и специально определенным для SSI. Такие зарезервированные переменные перечислены в Табл. 1. Кроме этого переменные могут использоваться в сложных конструкциях с

использованием условных операторов, имеющих следующий синтаксис:

<!--#if expr=”условие1”--> <p>Выполнено условие №1</p> <!--#elif expr=”условие2”--> <p>Выполнено условие №2</p> <!--#else--> <p>Ни одно из условий не выполнено</p> <!--#endif-->

Для того чтобы вставить в страницу результат работы внешней программы, используют директиву #exec. В зависимости от того, каким из параметров вы воспользуетесь —cmd или cgi, в страницу будет вставляться результат обычного приложения или CGI-программы.

Допустим, вы хотите вывести список всех файлов, находящихся в данной директории. В среде Windows за это отвечает команда dir, соответствующая директива имеет следующий вид:

<!--#exec cmd=”dir”-->

А если вам нужно вставить в страницу результаты программы Hello.cgi, то директиву #exec следует написать несколько иначе:

<!--#exec cgi=”Hello.cgi”-->

Следующая директива #flastmod вставляет в страницу дату последнего изменения файла, указанного в параметре file. Например:

<!--#flastmod file=”News.html”-->

Эта директива просто незаменима в тех случаях, когда нужно указать дату последнего обновления, зависящего от времени последнего изменения файла, т.е. дать знать пользователю, насколько в нем устарели данные. Такими, к примеру, являются файлы, содержащие в себе сводку погоды, курс валют, разные новости и пр. Данные, возвращаемые этой командой, могут быть заданы в определенном формате директивой #config, которую мы рассмотрим ниже.

Еще одной директивой, формат данных которой задается с помощью #config, является директива #fsize. Она возвращает размер файла, указанного в параметре file. По умолчанию размер выводится в байтах. Дабы вставить в страничку размер файла index.html, нужно прописать следующее:

<!--#fsize file=”index.html”-->

Как я говорил, формат данных, возвращаемых этими командами, может задаваться с помощью директивы #config, у которой есть три параметра: sizefmt, errmsg и timefmt.

Параметр sizefmt задает формат для данных, выдаваемых директивой #fsize. Можно сделать так, чтобы значение размера выводилось не в байтах, а округлялось до ближайшего значения в килобайтах:

<!--#config sizefmt=”abbrev”--> <!--#fsize file=”index.html”-->.

Размер файла index.html будет возвращен в килобайтах. Чтобы вернуться к стандартному формату, параметру нужно присвоить значение "bytes".

С помощью параметра errmsg можно создать сообщение об ошибке, которое будет выводиться в случае неправильного выполнения директив SSI. Допустим, вы попытались директивой #include вставить в страницу несуществующий файл. В этом случае сервер выдаст вам сообщение об ошибке. Например, Apache выдает такое сообщение: [an error occurred while processing this directive] — согласитесь, не совсем то, что хотелось бы видеть у себя на странице в случае ошибки.

Давайте создадим другое сообщение, более понятное — например, такое:

<!--#config errmsg=”К сожалению, этот файл отсутствует. ”-->

Параметр timefmt позволяет изменять формат отображения времени, которое выводится с

помощью директив SSI. В частности, запись

<!--#config timefmt=”%A, %H:%M”-->

приведет к тому, что время в окне браузера будет выглядеть следующим образом: Sunday, 21:33. Задавать формат времени можно как угодно, используя при этом специальные коды, которые замещаются соответствующими данными времени и даты. Совмещая эти коды с текстом, можно добиться довольно изощренных сообщений. Список таких кодов приведен в Табл. 2. Как вы, наверное, уже успели заметить, технология SSI очень проста и удобна в обращении, при этом она предоставляет поистине огромные возможности, из которых можно выделить мгновенное изменение дизайна, не требующее переделки всех страничек вашего узла — достаточно переписать директивы SSI, отвечающие за внешний вид сайта. В данной статье были вкратце рассмотрены наиболее часто используемые директивы, на самом деле их насчитывается более десятка, и зачастую они представляют собой достаточно большие и сложные конструкции.