# SSI Фильтр, обрабатывающий команды SSI (Server Side Includes) в проходящих через него ответах. ## Пример конфигурации ```nginx location / { ssi on; # ... } ``` ## Директивы ### ssi | [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile) | `ssi` `on` | `off`; | |------------------------------------------------------------------------------------------|---------------------------------------| | По умолчанию | `ssi off;` | | [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location, if в location | Разрешает или запрещает обработку команд SSI в ответах. ### ssi_last_modified | [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile) | `ssi_last_modified` `on` | `off`; | |------------------------------------------------------------------------------------------|-------------------------------------| | По умолчанию | `ssi_last_modified off;` | | [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | Позволяет сохранить поле заголовка `Last-Modified` исходного ответа во время обработки SSI для лучшего кэширования ответов. По умолчанию поле заголовка удаляется, так как содержимое ответа изменяется во время обработки и может содержать динамически созданные элементы или части, которые изменились независимо от исходного ответа. ### ssi_min_file_chunk | [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile) | `ssi_min_file_chunk` размер; | |------------------------------------------------------------------------------------------|--------------------------------| | По умолчанию | `ssi_min_file_chunk 1k;` | | [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | Задает минимальный размер частей ответа, хранящихся на диске, начиная с которого имеет смысл посылать их с помощью [sendfile](https://angie.software//angie/docs/configuration/modules/http/index.md#sendfile). ### ssi_silent_errors | [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile) | `ssi_silent_errors` `on` | `off`; | |------------------------------------------------------------------------------------------|-------------------------------------| | По умолчанию | `ssi_silent_errors off;` | | [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | Разрешает не выводить строку "[an error occurred while processing the directive]", если во время обработки SSI произошла ошибка. ### ssi_types | [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile) | `ssi_types` mime-тип ...; | |------------------------------------------------------------------------------------------|-----------------------------| | По умолчанию | `ssi_types text/html;` | | [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | Разрешает обработку команд SSI в ответах с указанными MIME-типами в дополнение к `text/html`. Специальное значение "\*" соответствует любому MIME-типу. ### ssi_value_length | [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile) | `ssi_value_length` длина; | |------------------------------------------------------------------------------------------|-----------------------------| | По умолчанию | `ssi_value_length 256;` | | [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile) | http, server, location | Задает максимальную длину значений параметров в SSI-командах. ## Команды SSI Общий формат команд SSI такой: ```html ``` Поддерживаются следующие команды: ### `block` Описывает блок, который можно использовать как заглушку в команде include. Внутри блока могут быть другие команды SSI. Параметр команды: #### `name` имя блока. Пример: ```html заглушка ``` ### `config` Задает некоторые параметры, используемые при обработке SSI, а именно: #### `errmsg` строка, выводящаяся при ошибке во время обработки SSI. По умолчанию выводится такая строка: ```none `[an error occurred while processing the directive]` ``` #### `timefmt` строка формата, передаваемая функции `strftime()` для вывода даты и времени. По умолчанию используется такой формат: ```none `"%A, %d-%b-%Y %H:%M:%S %Z"` ``` Для вывода времени в секундах подходит формат "%s". ### `echo` Выводит значение переменной. Параметры команды: #### `var` имя переменной. #### `encoding` способ кодирования. Возможны три значения — `none`, `url` и `entity`. По умолчанию используется `entity`. #### `default` нестандартный параметр, задающий строку, которая выводится, если переменная не определена. По умолчанию выводится строка `(none)`. Команда ```html ``` заменяет такую последовательность команд: ```html нет ``` ### `if` Выполняет условное включение. Поддерживаются следующие команды: ```html ... ... ... ``` На данный момент поддерживается только один уровень вложенности. Параметр команды: #### `expr` выражение. В выражении может быть: * проверка существования переменной: ```html ``` * сравнение переменной с текстом: ```html ``` * сравнение переменной с регулярным выражением: ```html ``` Если в text встречаются переменные, то производится подстановка их значений. В регулярном выражении можно задать позиционные и именованные группы захвата, а затем использовать их через переменные, например: ```html ``` ### `include` Включает в ответ результат другого запроса. Параметры команды: #### `file` задает включаемый файл, например: ```html ``` #### `virtual` задает включаемый запрос, например: ```html ``` Несколько запросов, указанных на одной странице и обрабатываемых проксируемыми или FastCGI/uwsgi/SCGI/gRPC-серверами, работают параллельно. Если нужна последовательная обработка, следует воспользоваться параметром wait. #### `stub` нестандартный параметр, задающий имя блока, содержимое которого будет выведено, если тело ответа на включаемый запрос пустое или если при исполнении запроса произошла ошибка, например: ```html   ``` Содержимое замещающего блока обрабатывается в контексте включаемого запроса. #### `wait` нестандартный параметр, указывающий, нужно ли ждать полного исполнения данного запроса, прежде чем продолжать выполнение SSI, например: ```html ``` #### `set` нестандартный параметр, указывающий, что удачный результат выполнения запроса нужно записать в заданную переменную, например: ```html ``` Максимальный размер ответа задается директивой [subrequest_output_buffer_size](https://angie.software//angie/docs/configuration/modules/http/index.md#subrequest-output-buffer-size): ```nginx location /remote/ { subrequest_output_buffer_size 64k; # ... } ``` ### `set` Присваивает значение переменной. Параметры команды: #### `var` имя переменной. #### `value` значение переменной. Если в присваиваемом значении есть переменные, то производится подстановка их значений. ## Встроенные переменные ### `$date_local` текущее время в локальной временной зоне. Формат задается командой config с параметром timefmt. ### `$date_gmt` текущее время в GMT. Формат задается командой config с параметром timefmt.