<?xml version="1.0"?>

<!--
  Copyright (C) Nginx, Inc.
  -->

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Модуль ngx_http_js_module"
        link="/ru/docs/http/ngx_http_js_module.html"
        lang="ru"
        rev="10">

<section id="summary">

<para>
Модуль <literal>ngx_http_js_module</literal> позволяет задавать
обработчики location и переменных
на <link doc="../njs_about.xml">njs</link> —
подмножестве языка JavaScript.
</para>

<para>
По умолчанию этот модуль не собирается, его необходимо собрать с
модулем njs с помощью конфигурационного параметра
<literal>--add-module</literal>:
<example>
./configure --add-module=<value>path-to-njs</value>/nginx
</example>
<link url="http://hg.nginx.org/njs">Репозиторий</link>
модуля njs можно клонировать следующей командой
(необходим клиент <link url="https://www.mercurial-scm.org">Mercurial</link>):
<example>
hg clone http://hg.nginx.org/njs
</example>
Модуль также можно собрать как
<link doc="../ngx_core_module.xml" id="load_module">динамический</link>:
<example>
./configure --add-dynamic-module=<value>path-to-njs</value>/nginx
</example>
</para>

</section>


<section id="example" name="Пример конфигурации">

<para>
<example>
js_include http.js;

js_set $foo     foo;
js_set $summary summary;

server {
    listen 8000;

    location / {
        add_header X-Foo $foo;
        js_content baz;
    }

    location /summary {
        return 200 $summary;
    }
}
</example>
</para>

<para>
Файл <path>http.js</path>:
<example>
function foo(req, res) {
    req.log("hello from foo() handler");
    return "foo";
}

function summary(req, res) {
    var a, s, h;

    s = "JS summary\n\n";

    s += "Method: " + req.method + "\n";
    s += "HTTP version: " + req.httpVersion + "\n";
    s += "Host: " + req.headers.host + "\n";
    s += "Remote Address: " + req.remoteAddress + "\n";
    s += "URI: " + req.uri + "\n";

    s += "Headers:\n";
    for (h in req.headers) {
        s += "  header '" + h + "' is '" + req.headers[h] + "'\n";
    }

    s += "Args:\n";
    for (a in req.args) {
        s += "  arg '" + a + "' is '" + req.args[a] + "'\n";
    }

    return s;
}

function baz(req, res) {
    res.headers.foo = 1234;
    res.status = 200;
    res.contentType = "text/plain; charset=utf-8";
    res.contentLength = 15;
    res.sendHeader();
    res.send("nginx");
    res.send("java");
    res.send("script");

    res.finish();
}
</example>
</para>

</section>


<section id="directives" name="Директивы">

<directive name="js_content">
<syntax><value>функция</value></syntax>
<default/>
<context>location</context>
<context>limit_except</context>

<para>
Задаёт функцию njs в качестве обработчика содержимого location.
</para>

</directive>


<directive name="js_include">
<syntax><value>файл</value></syntax>
<default/>
<context>http</context>

<para>
Задаёт файл, позволяющий задавать обработчики location и переменных
на njs.
</para>

</directive>


<directive name="js_set">
<syntax>
<value>$переменная</value> <value>функция</value></syntax>
<default/>
<context>http</context>

<para>
Задаёт функцию njs для указанной переменной.
</para>

</directive>

</section>


<section id="arguments" name="Аргументы запроса и ответа">
<para>
Каждый HTTP-обработчик njs получает два аргумента: запрос и ответ.
</para>

<para>
Объект запроса имеет следующие свойства:
<list type="tag">

<tag-name><literal>uri</literal></tag-name>
<tag-desc>
текущий URI запроса, только чтение
</tag-desc>

<tag-name><literal>method</literal></tag-name>
<tag-desc>
метод запроса, только чтение
</tag-desc>

<tag-name><literal>httpVersion</literal></tag-name>
<tag-desc>
версия HTTP, только чтение
</tag-desc>

<tag-name><literal>remoteAddress</literal></tag-name>
<tag-desc>
адрес клиента, только чтение
</tag-desc>

<tag-name><literal>headers{}</literal></tag-name>
<tag-desc>
объект заголовков запроса, только чтение.
<para>
Например, доступ к заголовку <literal>Header-Name</literal>
можно получить при помощи синтаксиса <literal>headers['Header-Name']</literal>
или <literal>headers.Header_name</literal>
</para>
</tag-desc>

<tag-name><literal>args{}</literal></tag-name>
<tag-desc>
объект аргументов запроса, только чтение
</tag-desc>

<tag-name><literal>variables{}</literal></tag-name>
<tag-desc>
объект переменных nginx, только чтение
</tag-desc>

<tag-name><literal>response</literal></tag-name>
<tag-desc>
объект ответа (0.2.0), только чтение
</tag-desc>
</list>
</para>

<para>
Объект запроса имеет следующие свойства:
<list type="tag">

<tag-name><literal>log(<value>строка</value>)</literal></tag-name>
<tag-desc>
записывает <literal>строку</literal> в лог-файл ошибок
на уровне лога <literal>info</literal>
</tag-desc>

<tag-name><literal>warn(<value>строка</value>)</literal></tag-name>
<tag-desc>
записывает <literal>строку</literal> в лог-файл ошибок
на уровне лога <literal>warning</literal> (0.2.0)
</tag-desc>

<tag-name><literal>error(<value>строка</value>)</literal></tag-name>
<tag-desc>
записывает <literal>строку</literal> в лог-файл ошибок
на уровне лога <literal>error</literal> (0.2.0)
</tag-desc>

<tag-name><literal>subrequest(<value>uri</value>[, <value>options</value>[,
<value>callback</value>]])</literal></tag-name>
<tag-desc>
создаёт подзапрос с заданными <literal>uri</literal> и
<literal>options</literal> и
устанавливает необязательный <literal>callback</literal> завершения (0.2.0).

<para>
Если <literal>options</literal> является строкой, то в ней
содержится срока аргументов подзапроса.
В противном случае ожидается, что <literal>options</literal> является объектом
со следующими ключами:
<list type="tag">
<tag-name><literal>args</literal></tag-name>
<tag-desc>строка с аргументами</tag-desc>

<tag-name><literal>body</literal></tag-name>
<tag-desc>тело запроса</tag-desc>

<tag-name><literal>method</literal></tag-name>
<tag-desc>метод HTTP</tag-desc>
</list>
</para>

<para>
<literal>callback</literal> получает объект ответа
со следующими свойствами:
<literal>uri</literal>, <literal>method</literal>,
<literal>status</literal>, <literal>contentType</literal>,
<literal>contentLength</literal>, <literal>headers</literal>,
<literal>args</literal>.
Эти свойства имеют те же значения, что и свойства объекта запроса.
Дополнительно у объекта ответа есть свойство <literal>body</literal>,
содержащее тело ответа подзапроса,
и свойство <literal>parent</literal>,
ссылающееся на родительский объект запроса.
</para>
</tag-desc>
</list>
</para>

<para>
Объект ответа имеет следующие свойства:
<list type="tag">

<tag-name><literal>status</literal></tag-name>
<tag-desc>
статус ответа, доступно для записи
</tag-desc>

<tag-name><literal>headers{}</literal></tag-name>
<tag-desc>
объект заголовков ответа
</tag-desc>

<tag-name><literal>contentType</literal></tag-name>
<tag-desc>
значение поля <header>Content-Type</header> заголовка ответа,
доступно для записи
</tag-desc>

<tag-name><literal>contentLength</literal></tag-name>
<tag-desc>
значение поля <header>Content-Length</header> заголовка ответа,
доступно для записи
</tag-desc>
</list>
</para>

<para>
Объект ответа имеет следующие методы:
<list type="tag">

<tag-name><literal>sendHeader()</literal></tag-name>
<tag-desc>
отправляет заголовок HTTP клиенту
</tag-desc>

<tag-name><literal>send(<value>строка</value>)</literal></tag-name>
<tag-desc>
отправляет часть тела ответа клиенту
</tag-desc>

<tag-name><literal>finish()</literal></tag-name>
<tag-desc>
завершает отправку ответа клиенту
</tag-desc>

<tag-name><literal>return(код[, строка])</literal></tag-name>
<tag-desc>
отправляет
клиенту полный ответ с указанным <literal>кодом</literal> (0.2.0)
<para>
Можно задать или URL перенаправления
(для кодов 301, 302, 303, 307 и 308),
или текст тела ответа (для остальных кодов) в качестве второго аргумента.
</para>
</tag-desc>

</list>
</para>

</section>

</module>