hs.httpserver.hsminweb.cgilua

Имя файла запускаемого скрипта. Получено из cgilua.script_path.

• CGILua поддерживает вызов через URL, который представляет собой набор связанных путей и имён скриптов; это не обязательно для данного модуля, поэтому эти переменные могут несколько отличаться от настоящей установки CGILua; намерение переменной сохранено так близко, как я могу определить на данный момент. Если это изменится, изменится и эта документация.

Системный путь запускаемого скрипта. Эквивалент переменной среды CGI SCRIPT_FILENAME.

• CGILua поддерживает вызов через URL, который представляет собой набор связанных путей и имён скриптов; это не обязательно для данного модуля, поэтому эти переменные могут несколько отличаться от настоящей установки CGILua; намерение переменной сохранено так близко, как я могу определить на данный момент. Если это изменится, изменится и эта документация.

Директория выполняемого скрипта. Получена из cgilua.script_path.

• CGILua поддерживает вызов через URL, представляющий собой набор цепочек путей и имён скриптов; для данного модуля это не требуется, поэтому эти переменные могут несколько отличаться от истинной установки CGILua; намерение переменной сохранено насколько это возможно на данный момент. Если это изменится, изменится и данная документация.

Если PATH_INFO представляет собой директорию (т.е. заканчивается на "/"), то это равно cgilua.script_vpath. В противном случае содержит часть директории cgilua.script_vpath.

• CGILua поддерживает вызов через URL, представляющий собой набор цепочек путей и имён скриптов; для данного модуля это не требуется, поэтому эти переменные могут несколько отличаться от истинной установки CGILua; намерение переменной сохранено насколько это возможно на данный момент. Если это изменится, изменится и данная документация.

Эквивалентно переменной окружения CGI PATH_INFO или "/", если PATH_INFO не задана.

• CGILua поддерживает вызов через URL, представляющий собой набор цепочек путей и имён скриптов; для данного модуля это не требуется, поэтому эти переменные могут несколько отличаться от истинной установки CGILua; намерение переменной сохранено насколько это возможно на данный момент. Если это изменится, изменится и данная документация.

Директория, используемая cgilua.tmpfile

Имя скрипта, запрошенного в URL. Эквивалентно переменной окружения CGI SCRIPT_NAME.

• CGILua поддерживает вызов через URL, представляющий собой набор цепочек путей и имён скриптов; для данного модуля это не требуется, поэтому эти переменные могут несколько отличаться от истинной установки CGILua; намерение переменной сохранено насколько это возможно на данный момент. Если это изменится, изменится и данная документация.

Устанавливает тип HTTP-ответа для генерируемого содержимого на maintype/subtype.

• maintype - основной тип содержимого (например, "text")
• subtype - подтип содержимого (например, "plain")

• Ничего

• Это устанавливает поле заголовка Content-Type для генерируемого HTTP-ответа. Это переопределит любое предыдущее значение, включая значение по умолчанию "text/html".

Выполняет файл Lua (указанный filepath), если он существует.

• filepath - файл для интерпретации как код Lua

• значения, возвращаемые при выполнении, или nil и сообщение об ошибке, если файл не существует.

• Эта функция интерпретирует файл только в том случае, если он существует; если файл не существует, она возвращает ошибку вызывающему коду (а не веб-клиенту).
• Во время обработки веб-запроса локальный каталог временно изменяется, чтобы соответствовать локальному каталогу пути обслуживаемого файла, как определяется URL запроса. Обычно это отличается от стандартного каталога Hammerspoon, который соответствует каталогу, содержащему файл init.lua для Hammerspoon.

Выполняет файл lua (указанный в пути файла).

• filepath - файл, который следует интерпретировать как Lua-код

• значения, возвращенные при выполнении, или nil и сообщение об ошибке, если файл не существует.

• Если файл не существует, клиенту возвращается ошибка Internal Server, а в консоль Hammerspoon записывается сообщение об ошибке.
• Во время обработки веб-запроса локальный каталог временно меняется, чтобы соответствовать локальному каталогу пути к файлу, который обслуживается, как определяется URL запроса. Это обычно отличается от стандартного каталога Hammerspoon, который соответствует каталогу, содержащему файл init.lua для Hammerspoon.

Отправляет сообщение в журнал ошибок hs.httpserver.hsminweb с меткой "ошибка".

• msg - сообщение, которое нужно отправить в журнал ошибок модуля

• Ничего

• Доступна в файле шаблона lua как cgilua.errorlog
• По умолчанию сообщения, записанные этим методом, отображаются в консоли Hammerspoon и доступны в истории hs.logger.

Устанавливает заголовок HTTP ответа key в значение value

• key - заголовок HTTP ответа, которому нужно задать значение. Должен быть строкой.
• value - значение для заголовка. Должно быть строкой или значением, представимым как строка.

• Ничего

• Не следует использовать эту функцию для установки значения для ключа "Content-Type"; вместо этого используйте cgilua.contentheader или cgilua.htmlheader.

Устанавливает тип HTTP ответа в "text/html"

• Ничего

• Ничего

• Это устанавливает поле заголовка Content-Type для генерируемого ответа HTTP в "text/html". Это значение по умолчанию, поэтому, как правило, вызывать эту функцию не нужно, если вы ранее не изменили его функцией cgilua.contentheader.

Возвращает абсолютный URL для данного URI, добавив схему, имя хоста и порт этого веб-сервера к пути.

• URI - путь к ресурсу, обслуживаемому этим веб-сервером. Если путь не содержит "/", ему будет добавлен "/".

• Абсолютный URL для данного пути в формате "схема://хост:порт/путь", где scheme будет либо "http", либо "https", а имя хоста и порт будут соответствовать этому веб-серверу.

• Если вы хотите добавить параметры запроса к пути или расширить относительный путь до полного пути, см. cgilua.mkurlpath.

Создаёт полный URI документа из частичного URI, включая аргументы запроса, если они присутствуют.

• uri - полный или частичный URI (путь и компонент файла URL) документа
• args - необязательная таблица с парами ключ-значение, которые будут закодированы для формирования корректного запроса в конце URI (см. cgilua.urlcode.encodetable.

• Полный URI, включая любые аргументы запроса, если они присутствуют.

• Эта функция предназначена для использования совместно с cgilua.mkabsoluteurl для создания полного URL. Если предоставленный uri не начинается с "/", текущий путь каталога добавляется к uri, а любые аргументы запроса добавляются в конец.
• Например, cgilua.mkabsoluteurl(cgiurl.mkurlpath("file.lp", { key = value, ... })) вернёт полный URL, указывающий на файл file.lp в текущем каталоге с указанными парами ключ-значение в качестве аргументов запроса.

Добавляет переданные аргументы к телу ответа.

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

• Ничего

• Доступна в файле шаблона lua как cgilua.print
• Эта функция работает как встроенная lua команда print, преобразуя все аргументы в строки, разделяя их табуляцией (\t) и завершая строку новой строкой (\n) перед добавлением их к текущему телу ответа.

Добавляет переданные аргументы к телу ответа.

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

• Ничего

• Доступна в файле шаблона lua как cgilua.put
• Эта функция работает, расправляя таблицы и преобразуя все значения, кроме nil и false, в их строковое представление, а затем добавляя их в порядке к телу ответа. В отличие от cgilua.print, она не разделяет значения символом табуляции или не завершает строку символом новой строки.

Отправляет заголовки для перенаправления на указанный URL, добавляя параметры в таблице args к новому URL.

• url - URL, на который должен быть перенаправлен клиент
• args - необязательная таблица с парами ключ-значение, которые будут закодированы для формирования корректного запроса в конце URL (см. cgilua.urlcode.encodetable.

• Ничего

• Эта функция, как правило, должна быть последней в вашем lua-шаблоне, так как дополнительная обработка или вывод не должны выполняться, когда запрос должен быть перенаправлен.

Возвращает строку со значением переменной среды CGI, соответствующей имени varname.

• varname - имя переменной CGI для получения значения.

• значение переменной CGI в виде строки или nil, если такая переменная не существует.

• Переменные CGI включают значения, определённые сервером, которые обычно совместно используются со скриптами CGI, и заголовки HTTP запроса от веб-запроса. Переменные сервера включают следующие (обратите внимание, что в зависимости от запроса и типа ресурса, на который ссылается URL, не все значения могут существовать для каждого запроса):

  • "AUTH_TYPE" - Если сервер поддерживает аутентификацию пользователя и скрипт защищен, это метод аутентификации, специфичный для протокола, используемый для проверки пользователя.
  • "CONTENT_LENGTH" - Длина самого содержимого, предоставленная клиентом.
  • "CONTENT_TYPE" - Для запросов, к которым прикреплена информация, такая как HTTP POST и PUT, это тип содержимого данных.
  • "DOCUMENT_ROOT" - реальная директория на сервере, соответствующая DOCUMENT_URI "/". Это первая директория, которая содержит файлы или поддиректории, обслуживаемые веб-сервером.
  • "DOCUMENT_URI" - часть пути запрошенного URL HTTP.
  • "GATEWAY_INTERFACE" - Ревизия спецификации CGI, которой соответствует этот сервер. Формат: CGI/ревизия
  • "PATH_INFO" - Дополнительная информация о пути, предоставленная клиентом. Другими словами, к скриптам можно получить доступ по их виртуальному имени пути, за которым следует дополнительная информация в конце этого пути. Дополнительная информация передаётся как PATH_INFO. Эта информация должна быть декодирована сервером, если она получена из URL, перед передачей скрипту CGI.
  • "PATH_TRANSLATED" - Сервер предоставляет переведённую версию PATH_INFO, которая берёт путь и выполняет любое отображение виртуального пути на физический.
  • "QUERY_STRING" - Информация, которая следует за "?" в URL, который ссылался на этот скрипт. Это информация запроса. Её не следует декодировать никоим образом. Эта переменная всегда должна быть установлена, когда есть информация запроса, независимо от декодирования командной строки.
  • "REMOTE_ADDR" - IP-адрес удалённого хоста, делающего запрос.
  • "REMOTE_HOST" - имя хоста, производящего запрос. Если сервер не обладает этой информацией, он должен установить REMOTE_ADDR и оставить эту переменную не установленной.
  • "REMOTE_IDENT" - Если HTTP-сервер поддерживает идентификацию RFC 931, то эта переменная будет установлена на имя удалённого пользователя, полученное с сервера. Использование этой переменной должно быть ограничено только протоколированием.
  • "REMOTE_USER" - Если сервер поддерживает аутентификацию пользователя и скрипт защищён, это имя пользователя, под которым они аутентифицировались.
  • "REQUEST_METHOD" - Метод, с помощью которого был сделан запрос. Для HTTP это "GET", "HEAD", "POST" и т.д.
  • "REQUEST_TIME" - Время, когда сервер получил запрос, представленное в виде числа секунд с 00:00:00 UTC 1 января 1970 года. Используется с os.date для предоставления даты и времени в любом требуемом вами формате.
  • "REQUEST_URI" - DOCUMENT_URI с любым присутствующим в запросе строкой запроса. Обычно это соответствует URL без схемы или информации о хосте.
  • "SCRIPT_FILENAME" - фактический путь к выполняемому скрипту.
  • "SCRIPT_NAME" - виртуальный путь к выполняемому скрипту, используемый для самоссылок на URL.
  • "SERVER_NAME" - имя хоста, DNS-псевдоним или IP-адрес сервера, как он будет отображаться в URL самоссылок.
  • "SERVER_PORT" - номер порта, на который был отправлен запрос.
  • "SERVER_PROTOCOL" - Название и версия протокола информации, с которым пришёл этот запрос. Формат: протокол/ревизия
  • "SERVER_SOFTWARE" - Название и версия программного обеспечения веб-сервера, отвечающего на запрос (и запускающего шлюз). Формат: имя/версия

• Имена заголовков HTTP-запроса имеют префикс "HTTP_", преобразуются в верхний регистр и все дефисы преобразуются в подчёркивания. Общие заголовки (преобразованные в их формат CGI) могут включать, но не ограничиваются:

  • HTTP_ACCEPT, HTTP_ACCEPT_ENCODING, HTTP_ACCEPT_LANGUAGE, HTTP_CACHE_CONTROL, HTTP_CONNECTION, HTTP_DNT, HTTP_HOST, HTTP_USER_AGENT

• Этот сервер также определяет следующие (которые дублируются в переменных CGI выше, поэтому для переносимости следует использовать их):

  • HTTP_X_REMOTE_ADDR, HTTP_X_REMOTE_PORT, HTTP_X_SERVER_ADDR, HTTP_X_SERVER_PORT

• Список распространённых заголовков запросов и их определений можно найти на https://en.wikipedia.org/wiki/List_of_HTTP_header_fields

Возвращает две строки с "первой директорией" и "остальной частью пути", разделённые первой разделительной строкой ("/" или "").

• path - путь для разделения

• первый компонент директории, остаток пути

Возвращает две строки с "путем к директории" и "файлом", разделённые последней разделительной строкой ("/" или "").

• path - путь для разделения

• путь к директории, файл

• Эта функция раньше называлась cgilua.splitpath и по-прежнему доступна под этим именем для совместимости. cgilua.splitpath может быть устаревшей в будущих версиях.

Возвращает дескриптор файла временного файла для записи или nil и сообщение об ошибке, если файл не может быть создан по какой-либо причине.

• dir - системная директория, в которой должен быть создан временный файл. По умолчанию cgilua.tmp_path.
• namefunction - необязательная функция, используемая для генерации уникальных имён файлов для использования в качестве временных файлов. По умолчанию cgilua.tmpname.

• дескриптор созданного файла и имя файла или nil и сообщение об ошибке, если файл не может быть создан.

• Файл автоматически удаляется при завершении HTTP-запроса, поэтому, если вам нужно, чтобы данные сохранились, убедитесь, что вы io.flush или io.close дескриптор файла самостоятельно и скопируйте файл в более постоянное место.

Возвращает имя временного файла, используемого cgilua.tmpfile.

• Нет

• временное имя файла без пути.

• Эта функция использует hs.host.globallyUniqueString для генерации уникального имени файла.