Описание функций библиотеки:


Методы объекта среды разработки (env):

env:complete(sql)
В случае верного синтаксиса SQL команды возвращает true, иначе возвращает false.


env:open(filename) или env:connect(filename)
Открывает (или создаёт, если не создана) SQLite базу с именем filename и возвращает её хендл, который имеет lua тип userdata (возвращаемый данной функцией объект в дальнейшем используется для вызовов всех методов для данного соединения с базой данных). Пример:



В случае ошибки, функция возвращает nil, код ошибки и сообщение об ошибке.


env:open_memory()
Открывает временную базу данных (в памяти) и возвращает хендл, который имеет lua тип userdata. В случае ошибки, функция возвращает nil, код ошибки и сообщение об ошибке. (В памяти база данных изменяется, но никогда не сохраняется на диск.)


env:close()
Закрывает текущую среду разработки (env).


env._VERSION
Возвращает строку с информацией о версии SQLite (в формате "x.y[.z]").



Методы объекта соединения (con):
После открытия базы данных при помощи метода env:open() или env:open_memory() возвращается хендл этой базы. Открытые базы данных поддерживают следующие методы:


con:busy_handler([func [, udata]])
Этот вызов позволяет указать lua функцию-обработчик, которая будет вызываться в случае, если файл базы данных был заблокирован другим процессом или потоком. Если func равен nil, то удаляется ранее установленная функция и любой вызов метода exec вернет состояние занятости env.BUSY немедленно при доступе к заблокированной таблице. Если функция-обработчик указана, то она вызовется с двумя аргументами. Первый аргумент - это указанный в методе busy_handler аргумент udata. Второй аргумент – предыдущее количество вызовов обработчика, при доступе к заблокированному ресурсу. Если обработчик вернул nil, false или 0, то метод exec вернет env.BUSY, в противном случае, метод exec будет пытаться открыть в цикле выполнить свой запрос.
По умолчанию обработчика нету.
Sqlite реентерабельна, и в обработчике возможно выполнять запросы. Не совсем понятно, зачем это может пригодиться, но в теории это возможно. Обработчик не должен закрывать файл базы данных. Закрытие базы из обработчика вызовет удаление структур вышестоящего запроса и может привести к аварийному завершению.


con:busy_timeout(t)
Этот вызов позволяет установить время t в миллисекундах, которое нужно подождать в случае если транзакция не была завершена (файл базы данных был заблокирован другим процессом или потоком). Вызов этого метода удалит все функции-обработчики, установленные методом busy_handler. Вызов этого метода с аргументом меньше либо равном 0 отключит все функции-обработчики.


con:close()
Закрывает базу данных. Все sql запросы, использующие con:prepare() завершаются при вызове данного метода. Метод возвращает env.OK в случае успеха, и числовой код ошибки в случае неудачи.


con:create_aggregate(name, nargs, step, final)
Этот метод создаёт функцию обратного вызова. Функция вызывается для каждой строки запроса. Аргумент name - это строка, которая содержит имя создаваемой sql функции. Аргумент nargs - это число аргументов у sql функции. Аргумент step - это непосредственно lua функция, которая будет выполняться для каждой строки запроса, эта функция вызывается с аргументом context и аргументами sql функции. Аргумент final - это функция, которая будет вызываться один раз в самом конце запроса, эта функция вызывается с один аргументом - context.

Пример использования:



В результате на экране увидим следующее:


con:create_collation(name, func)
Этот метод создают сортирующую функцию обратного вызова. Функция обратного вызова нужна для установки порядка сортировки, по большей части за счёт сравнения строк. Аргумент name - это строка, содержащая имя sql сортировки. Аргумент func - это непосредственно lua функция сортировки, принимающая 2 строковых аргумента и возвращающая 0, если строковые аргументы равны, -1 - если первый аргумент "меньше" второго, и 1 - если первый аргумент "больше" второго.

Пример использования:




con:create_function(name, nargs, func)
Этот метод создаёт функцию обратного вызова. Функция вызывается для каждой строки запроса. Аргумент name - это строка, которая содержит имя создаваемой sql функции. Аргумент nargs - это число аргументов у sql функции. Аргумент func - это непосредственно lua функция, которая будет выполняться для каждой строки запроса, эта функция вызывается с аргументом context и аргументами sql функции.

Пример использования:




con:errcode() или con:error_code()
Возвращает числовой код (или расширенный код) для недавнего неудавшегося вызова метода базы данных.


con:errmsg() или con:error_message()
Возвращает сообщение с ошибкой для недавнего неудавшегося вызова метода базы данных.


con:exec(sql [, func [, udata]]) или con:execute(sql [, func [, udata]]) или con:query(sql [, func [, udata]])
Составляет и выполняет sql запрос, указанный в первом аргументе этого метода. Запросы просто выполняются друг за другом не сохраняясь. Функция возвращает env.OK в случае успеха и числовой код ошибки в случае неудачи.

Если один или несколько утверждений являются запросами, и если во втором параметре данного метода указана функция func, то эта функция выполнится для каждой строки результатов запроса. Эта функция будет вызываться с 4 аргументами: udata (третий аргумент метода exec), числом колонок в строке(cols), таблицей (values), содержащей все данные всех колонок, и другой таблицей (names), содержащей имена всех колонок. Эта функция должна возвратить 0. Если она вернёт не 0, то запрос будет считаться прерванным. Все последующие запросы не будут выполняться, а метод exec вернёт код env.ABORT.

Пример использования:




con:interrupt()
Этот метод прерывает выполнение операции базы данных. Метод ничего не возвращает.


con:isopen() или con:isconnect()
Этот метод возвращает true, если база открыта, иначе возвращает false.


con:last_insert_rowid()
Этот метод возвращает идентификатор строки последнего INSERT запроса. Если INSERT запрос никогда не выполнялся, то метод возвращает 0. Каждая строка в SQLite таблице имеет уникальный 64-битный целочисленный ключ 'rowid'. Этот идентификатор всегда доступен по имени ROWID, OID, или _ROWID_. Если таблица имеет поле с типом INTEGER PRIMARY KEY, то эта колонка является псевонимом для 'rowid'.
Если INSERT выполняется внутри триггера, то идентификатор rowid вносимой строки будет возвращаться так долго, как долго будет работать тригер. Как только триггер завершит свою работу вернётся то значение, которое было до работы триггера.


con:nrows(sql)
Метод создаёт итератор, который возвращает последующие строки, выбирая их из запроса sql. Каждый вызов итератора возвращает таблицу, ключами которой являются поля таблицы, а значениями - значения этих полей.

Пример использования:



Результаты работы:




con:prepare(sql)
Данный метод компилирует sql утверждение во внутренне представление и возвращает cur объект (курсор) типа userdata для дальнейших операций.


con:progress_handler(n, func, udata)
Этот метод устанавливает функцию обратного вызова func, которая выполняется периодически в течение длинных вызовов метода con:exec() или cur:step(). Вызов функции происходит каждые n операций, где n передаётся в качестве первого аргумента в указанную функцию. udata передаётся в качестве второго аргумента. Если действий в методе con:exec() или cur:step() меньше n, то функция обратного вызова не будет выполняться. Только одна функция обратного вызова может быть зарегистрирована для каждой открытой базы данных. Повторный вызов данного метода перезапишет прежде установленную функцию. Для того, чтобы удалить функцию обратного вызова, достаточно в методе вторым аргументом указать nil.
Если функция обратного вызова возвращает значение, отличное от 0, то текущий запрос незамедлительно прерывается и база данных откатывается назад, а метод con:exec() или cur:step() вернёт число env.INTERRUPT. Данный метод может быть использован для отмены длительных запросов.


con:rows(sql)
Метод создаёт итератор, который возвращает последующие строки, выбирая их из запроса sql. Каждый вызов итератора возвращает таблицу, ключами которой являются номера полей таблицы, а значениями - значения этих полей.

Пример использования:



Результаты работы:




con:total_changes()
Этот метод возвращает общее число строк, которое было модифицировано при помощи INSERT, UPDATE или DELETE, за всё время, в течение которого база была открытой. Сюда также включаются операции в триггерах. Изменения записываются как только выполняется любой из вызовов cur:reset() или cur:finalize().


con:trace(func, udata)
Этот метод устанавливает функцию трассировки. func - это lua функция, которую вызывает SQLite до разбора sql утверждения. В эту функцию передаются 2 аргумента. Первый - это аргумент udata, второй - это строка с sql утверждением.


con:urows(sql)
Метод создаёт итератор, который возвращает последующие строки, выбирая их из запроса sql. Каждый вызов итератора возвращает значения всех полей данной строки.

Пример использования:



Результаты работы:




con:commit()
Метод выполнения (завершения) текущей транзакции. Возвращает true в случае успеха, nil и сообщение ошибки - в случае, когда транзакция не может быть завершина или база данных не поддерживает транзакции.


con:rollback()
Метод отката на предыдущую транзакцию. Возвращает true в случае успеха, nil и сообщение ошибки - в случае, когда операция не может быть выполнена или база данных не поддерживает транзакции.


con:setautocommit(boolean)
Метод включения/отключения автоматических транзакций. Эта функция не может работать в базах, на которых не осуществляются транзакции. В базах данных, на которых нет понятия режима автоматических транзакций, этот механизм осуществляется драйвером. Метод возвращает true в случае успеха, и вызывает ошибку - в случае невыполнимости или неосуществимости.



Методы объекта курсор (cur):
После создания подзапроса при помощи метода con:prepare(), к этому подзапросу можно применять следующие методы:


cur:bind(n [, value])
Связывает данные value с переменной n в запросе. Если тип данных value является строкой или числом, то эти данные связываются как text или double соответственно. Если типом данных переменной value является тип boolean или эта переменная равна nil или вовсе отсутствует missing, то предыдущая связь удаляется. Данный метод возвращает env.OK в случае успеха или численный код ошибки в случае неудачи.


cur:bind_blob(n, blob)
Связывает строку blob (которая может быть бинарной строкой) с параметром n. Данный метод возвращает env.OK в случае успеха или численный код ошибки в случае неудачи.


cur:bind_names(nametable)
Связывает параметры запроса с данными таблицы nametable. Если есть параметры запроса вида ":AAA" или "$AAA", то ищутся соответствующие поля таблицы, если параметры в запросе не именованные, то ищутся числовые поля таблицы nametable. Данный метод возвращает env.OK в случае успеха или численный код ошибки в случае неудачи.


cur:bind_parameter_count()
Возвращает максимальный индекс подзапроса. Если параметры подзапроса имеют вид ":AAA" или вид "?", то назначается последовательно увеличивающееся число, начинающиеся с 1, так что возвращаемая величина является количеством параметров. Тем не менее если одно и тоже имя используется в подзапросе несколько раз, то все повторные имена не считаются, то есть возвращается величина, являющаяся числом уникальных параметров в подзапросе.
Если какой-либо параметр подзапроса имеет вид "?NNN" (где NNN - целое число), то могут быть промежутки в нумерации и возвращаемая величина будет равна индексу параметра подзапроса с самой большой индексной величиной.


cur:bind_parameter_name(n)
Возвращает имя n-го параметра подзапроса stmt. Параметры ":AAA", "@AAA", "$VVV" будут иметь имена ":AAA", "@AAA", "$VVV", соответственно. Другими словами, символы ":", "$" и "@" включаются в имя. Параметры "?" и "?NNN" не имеют имени. Первый связанный параметр имеет индекс 1. Если величина n за допустимыми рамками, или если n-ый параметр не имеет имени, то возвращается nil. Данный метод возвращает env.OK в случае успеха или численный код ошибки в случае неудачи.


cur:bind_values(value1, value2, ..., valueN)
Связывает указанные данные с параметрами подзапроса. Данный метод возвращает env.OK в случае успеха или численный код ошибки в случае неудачи.


cur:columns() или cur:numcols()
Возвращает количество колонок в результатах запроса, или 0, если подзапрос не возвращает ничего.


cur:finalize()
Эта функция завершает подзапрос. Если поздапрос выполнился успешно или не выполнился, то функция возвращает env.OK, в случае неудачи возвращает численный код ошибки.


cur:get_name(n) или cur:getcolname(n)
Возвращает имя n-ого столбца в результатах подзапроа (номер самого левого столбца - 0).


cur:get_named_types() или cur:getcolntypes()
Возвращает таблицу с именами и типами всех столбцов подзапроса.


cur:get_named_values() или cur:getcolnvalues()
Возвращает таблицу с именами и данными текущей строки результатов подзапроса.


cur:get_names() или cur:getcolnames()
Возвращает массив с именами всех столбцов в результатах подзапроса.


cur:get_type(n) или cur:getcoltype(n)
Возвращает тип n-ого столбца подзапроса (номер самого левого столбца - 0).


cur:get_types() или cur:getcoltypes()
Возвращает массив с типами всех столбцов подзапроса.


cur:get_unames() или cur:getcolunames()
Возвращает имена всех столбцов подзапроса.


cur:get_utypes() или cur:getcolutypes()
Возвращает типы всех столбцов подзапроса.


cur:get_uvalues() или cur:getcoluvalues()
Возвращает данные всех столбцов текущей сроки подзапроса.


cur:get_value(n) или cur:getcolvalue(n)
Возвращает данные n-ого столбца подзапроса (номер самого левого столбца - 0).


cur:get_values() или cur:getcolvalues()
Возвращает массив данных всех столбцов подзапроса.


cur:isopen() или cur:isconnect()
Возвращает true, если запрос ещё открыт (не заверщён при помощи метода finalize), иначе возвращает false.


cur:close()
Закрывает текущий курсор (cur).


cur:nrows()
Возвращает итератор, который возвращает последующие строки, выбирая их из подзапроса. Каждый вызов итератора возвращает таблицу, ключами которой являются поля таблицы, а значениями - значения этих полей.


cur:reset()
Этот метод восстанавливает подзапрос, для того чтобы он был выполнен. Переменные, которые были связаны при помощи методов cur:bind*() сохраняют свои значения.


cur:rows()
Возвращает итератор, который возвращает последующие строки, выбирая их из подзапроса. Каждый вызов итератора возвращает таблицу, ключами которой являются номера полей таблицы, а значениями - значения этих полей.


cur:step()
Этот метод должен быть вызван для того чтобы оценить следующую итерацию подзапроса. Она возвращает одо из следующих значений:

env.BUSY: база данных была занята. Если подзапрос подтверждён (COMMIT), то вы можете повторить запрос, в противном случае можно откатиться на предыдущую транзакцию.

env.DONE: подзапрос успешно завершил работу (finalize). Метод cur:step() не должен вызываться заново, без вызова метода cur:reset(), который сбросит всё на начальное состояние.

env.ROW: возвращается всякий раз, когда новая строка с данными готова для обработки вызывающим оператором. Данные могут быть доступны использованием функций доступа к строкам. cur:step(), может вызываться снова, чтобы извлекать следующую строку с данными.

env.ERROR: ошибка во время выполнения (например, нарушение ограничений). Метод cur:step() не должен вызываться снова. Более детальную информацию можно посмотреть, вызвав метод con:errmsg(). Более специфический код ошибки может быть получен при вызове метода cur:reset().

env.MISUSE: вызвана неподходящая функция. Такое возможно если предыдущий подзапрос завершил работу (finalize), или предыдущий вызов метода cur:step() вернул env.ERROR или env.DONE.


cur:urows()
Возвращает итератор, который возвращает последующие строки, выбирая их из подзапроса. Каждый вызов итератора возвращает значения всех полей данной строки.



Методы объекта context функций обратного вызова:
Объекта context доступен как параметр в функциях обратного вызова методов con:create_aggregate() и con:create_function(). Этот объект обладает следующими методами:


ctx:aggregate_count()
Метод возвращает число вызовов функции обратного вызова.


ctx:get_aggregate_data()
Возвращает данные определенного пользователем поля.


ctx:set_aggregate_data(udata)
Устанавливает данные для определённого пользователем поля.


ctx:result(res)
Устанавливает результат функции обратного вызова в res. Тип результата зависит от типа res и является числом, или строкой или nil. Все другие величины поднимают сообщение ошибки.


ctx:result_null()
Устанавливает результат функции обратного вызова в nil. Метод ничего не возвращает.


ctx:result_number(number) или ctx:result_double(number)
Устанавливает результат функции обратного вызова как число number. Метод ничего не возвращает.


ctx:result_int(number)
Устанавливает результат функции обратного вызова как целое число number. Метод ничего не возвращает.


ctx:result_text(str)
Устанавливает результат функции обратного вызова как строку str. Метод ничего не возвращает.


ctx:result_blob(blob)
Устанавливает результат функции обратного вызова как бинарную строку blob. Метод ничего не возвращает.


ctx:result_error(err)
Устанавливает результат функции обратного вызова как ошибку err. Метод ничего не возвращает.


ctx:user_data()
Возвращает userdata параметр поступивший при вызове, чтобы устанавливать функцию возврата (см. описания методов con:create_aggregate() и con:create_function()).


В заключении приведу числовые коды ошибок:

botname = "Последние 10 сообщений в чате" -- Имя бота
BadChars = {".","?","!","+","-",} --На какие префиксы скрипт не будет реагировать
maxhistory = 20 -- Максимум линий для чата в кеше
chatfile = "chathistory.dat"-- куда будут записываться логи чата

GetChat = "+история" -- Команда для показа последних сообщений; Например, +история 10 покажет последние 10 сообщений

-- Выбираем, для каких профилей будет доступна команда:
-- индекс профиля, история чата [0=нет 1=да], "Название профиля"
HistoryProfiles = {
[-1] = {0,"Незарегистрированные пользователи"},
[0] = {1,"Мастер"},
[1] = {1,"Оп"},
[2] = {1,"Вип"},
[3] = {1,"Зарегистрированные пользователи"},
}

--------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------

function OnStartup()
if loadfile(chatfile) == nil then
chathistory = {}
local when = os.date(" %B %d %Y в: %X")
local chat = "Файл лога главного чата создан: "
table.insert(chathistory,when..chat)
local f,e = io.open( chatfile, "w+" )
f:write( "return {\n"..string.format("%q",chat..when)..",\n}" )
f:close()
end
chathistory = dofile(chatfile)
--frmHub:RegBot(botname)
end

function OnExit()
savehistory()
end

function UserConnected(user)
Core.GetUserAllData(user)
if HistoryProfiles[user.iProfile] and HistoryProfiles[user.iProfile][1] == 1 then
local n = #chathistory
local str = ""
for i = 1, n do str = str.."\r\n"..chathistory[i] end
Core.SendToNick(user.sNick,"<"..botname.."> "..str.."\r\n")
end
end

OpConnected = UserConnected

function ChatArrival(user,data)
Core.GetUserAllData(user)
local s,e,pre = string.find(data, "^%b<> (.)")
local s,e,cmd,lines = string.find(data, "^%b<>%s+(%S+)%s+(%d+)|$")
local when = os.date("[%H:%M] ")
local chat = string.sub(data, 1, -2)
if cmd and cmd == GetChat then
if lines ~= e then
GetChatLines(user, lines)
return true
else
Core.SendToNick(user.sNick,"<".."Пожалуйста.."> ".. укажите, сколько сообщений из лога главного чата вы хотите увидеть. Максимальное значение: "..maxhistory..".")
return true
end
else
for k,v in ipairs(BadChars) do
if pre == v then
return
end
end
table.insert(chathistory,when..chat)
if #chathistory > maxhistory then table.remove(chathistory, 1) end
savehistory()
end
end

function GetChatLines(user, linecount)
local n1 = #chathistory
local n2 = linecount
local n3 = n1 - (n2-1)
local str = ""
for i =n3,n1 do str = str.."\r\n"..chathistory[i] end
Core.SendPmToNick(user.sNick,botname,str.."\r\n")
end

function savehistory()
local f,e = io.open( chatfile, "w+" )
if f then
f:write("return {\n")
for i = 1, #chathistory do
f:write( "\t"..string.format("%q", chathistory[i])..",\r\n" )
end
f:write("}" )
f:close()
return 1
else
return nil
end
end
RegConnected = UserConnected

sAddresses - адреса хаба (указываются через пробел)
bAdcOn - включить режим работы хаба по протоколу ADC
sHubName - имя хаба
sTopic - топик хаба (приписка к имени хаба)
sHubBot - ник основного бота хаба.
sLocale - языковая локаль. По умолчанию устанавливается локаль системы (для России устанавливаем Russian_Russia.1251)
bSendUserIp - отсылать ip адреса пользователей, то есть использовать ли характеристики UserIP и UserIP2 (1 - да, 0 - нет).
bDelayedMyINFO - отсылать команды $MyINFO и $Quit с задержкой. Из-за отсутствия пока задержки входа рекомендуется установить этот параметр в 0.
bCheckSRNick - проверять ник в $SR команде.
bCheckRctmNick - проверять ли ник в RCTM команде (1 - проверять, 0 - не проверять).
bCheckCTMIp - проверять ip в CTM команде
bCheckSearchIp - проверять ip при активном поиске
bDelayedLogin - записывать пользователя только после полной отсылки ему списка всех пользователей (на больших хабах список всех пользователей может не отправиться за один раз, поэтому для таких хабов рекомендуется включить эту опцию).
bNicklistOnLogin - при входе на хаб отправлять список всех пользователей во время записи пользователя, а не по команде $GetNickList.
iTimeoutAny - время на получение от пользователя какой-либо команды (таймаут соединения)
iTimeoutLogon - максимальное время входа на хаб (в сек.).
iMaxPassiveRes - количество возвращаемых хабом результатов при пассивном поиске.
iTimerConnPeriod - период таймера соединения в мсек. (системная настройка, не рекомендуется изменять).
iTimerServPeriod - период таймера сервера в мсек. (системная настройка, не рекомендуется изменять).
iStepDelay - задержка в мсек на каждом цикле (системная настройка, не рекомендуется изменять).
iStrSizeMax - максимальная длина команды, отправленной на хаб пользователем.
iStartPing - время начала пинга пользователя в сек (отсчитывается от момента входа на хаб).
iPingInterval - период, через который пингуется пользователь.
iMaxLevel - уровень логирования событий хаба (от 0 до 6). По умолчанию 0 - не логировать события.
iMaxErrLevel - уровень логирования ошибок хаба (от 0 до 2). По умолчанию 2 - логировать все ошибки.
iSysLoading - коэффициент загруженности системы (системная настройка, не рекомендуется изменять).
iMaxNickLen - максимальная длина ника (проверяется только у пользователей с профилем -1).
iMinNickLen - минимальная длина ника (проверяется только у пользователей с профилем -1).
bDisableNoDCCmd - запретить использование команд, которые не относятся к NMDC командам (не начинаются со знака $, за исключением команды пинга и команды чата).
iFloodTime... и iFloodCount... - параметры флуда (количество iFloodCount за время iFloodTime (в сек.))
bRegMainBot - регистрировать основного бота.
bMainBotKey - ключ у основного бота.
sMainBotMyINFO - MyINFO основного бота.
sMainBotIP - ip основного бота.
bWebServer - включить веб-сервер (по умолчанию отключен).
sWebAddresses - адреса веб сервера (указываются через пробел). Через ; можно указывать порт.
iWebTimeout - тайм-аут соединения с веб сервером (в сек.). Время бездействия, по истечению которого веб-сервер закрывает соединение с клиентом.
iWebStrSizeMax - максимальный размер сообщения отсылаемого клиентом.
bMAC - включить определение MAC адреса (по умолчанию отключено).
iUsersLimit - глобальное ограничение числа пользователей (по умолчанию -1 - проверка отключена)
bUDPServer - включить udp сервер (1 - включить, 0 - отключить)
sUDPAddresses - udp адреса хаба
sMainPath - основная директория хаба
sPluginPath - директория плагинов
sLogPath - директория логов
sLangPath - директория языковых настроек
sLang - текущая языковая настройка (имя файла без расширения)
iMaxSendSize - настройка, отвечающая за максимальный размер буфера отсылки (по умолчанию 2818047). При превышении этого размера пользователь отключается от хаба.

UID - идентификатор пользователя, который отослал команду.
UID представляет из себя указатель на реальную структуру соединения пользователя (type(UID) = "userdata"). Введён с целью оптимизации выбора пользователя без нагрузки lua стека.

OnStartup()
Описание: Функция выполняется при старте скрипта.
Возвращаемое значение: любое



OnExit()
Описание: Функция выполняется при остановке скрипта
Возвращаемое значение: любое



OnError(sErrMsg)
Описание: Функция выполняется при ошибке в скрипте
Возвращаемое значение: true или 1 - не останавливать скрипт при ошибке во время выполнения
Исключения составляют таймерные функции, которые останавливают скрипт при ошибке, дабы не загружать систему и не прийти к переполнению лога



OnScriptError(sScriptName, sErrMsg, bStoped)
Описание: Функция выполняется при возникновении ошибки в скрипте sScriptName. sErrMsg - сообщение с ошибкой. Флаг bStoped равен true если скрипт, в котором возникла ошибка, был остановлен, в противном случае флаг bStoped равен false.
Функция не вызывается для текущего скрипта. Для отслеживания ошибок в текущем скрипте нужно использовать функцию OnError(sErrMsg).
Напомню, что по умолчанию скрипт отключается при ошибке, отключение скрипта можно предотвратить возвратом true в функции OnError этого скрипта.
Возвращаемое значение: true или 1 - не вызывать это событие в ниже стоящих скриптах (т.е. прекращение действия события).



OnScriptStart(sScriptName)
Описание: Функция выполняется при старте скрипта sScriptName.
Возвращаемое значение: true или 1 - не вызывать это событие в ниже стоящих скриптах (т.е. прекращение действия события).



OnScriptStop(sScriptName)
Описание: Функция выполняется при остановке скрипта sScriptName.
Возвращаемое значение: true или 1 - не вызывать это событие в ниже стоящих скриптах (т.е. прекращение действия события).



OnUserConnected(UID)
Описание: Функция выполняется при входе пользователя.
Функция выполняется после отправки пользователю первичной команды $Lock и до любого другого действия на хабе.
На данном этапе определён только IP адрес, порт и мак пользователя.
Возвращаемое значение: true или 1 - не отправлять при входе надпись: "Этот хаб работает под управлением..."



OnUserDisconnected(UID)
Описание: Функция выполняется после закрытия соедиения с пользователем.
Функция является последней функцией перед окончательным удалением соединения.
На данном этапе определён только IP адрес, порт и мак пользователя, все остальные данные уже удалены.
Возвращаемое значение: любое



OnUserEnter(UID)
Описание: Функция выполняется при окончательном входе пользователя, после добавления пользователя в списки.
Функция является последним этапом входа на хаб.
Возвращаемое значение: любое


OnUserExit(UID)
Описание: Функция выполняется при выходе пользователя, перед удаление пользователя из списков.
Функция является первым этапом выхода.
Возвращаемое значение: любое



OnSupports(UID, sData)
Описание: Функция выполняется при обмене характеристиками между клиентом и сервером.
Функция не будет выполняться, если клиент не поддерживает никаких дополнений и характеристик.
Возвращаемое значение: true или 1 - не отправлять характеристики хаба клиенту.



OnKey(UID, sData)
Описание: Функция выполняется при получении ключа от клиента.
Возвращаемое значение: true или 1 - проверять ключ.



OnValidateNick(UID, sData)
Описание: Функция выполняется после проверки ника и до проверки необходимости пароля. Ник пользователя уже определён.
Возвращаемое значение: true или 1 - отправить запрос на получение пароля.
Позволяет проводить регистрацию по средствам скриптов.



OnMyPass(UID, sData)
Описание: Функция выполняется после поступления на хаб пароля от пользователя.
Возвращаемое значение: true или 1 - вход оператора (отправка команды $LogedIn).



OnVersion(UID, sData)
Описание: Функция выполняется после поступления на хаб версии протокола.
Возвращаемое значение: true или 1 - проверять равенство версии 1,0091.



OnGetNickList(UID, sData)
Описание: Функция выполняется до отсылки списка пользователей.
Возвращаемое значение: true или 1 - не отсылать список.



OnMyINFO(UID, sData)
Описание: Функция выполняется при отправке на хаб MyINFO строки.
Функция выполняется после всех проверок параметров и до рассылки всем пользователям.
Возвращаемое значение (игнорируется при первой отправке, а работает только при последующих):
1) return false, return nil, return 0 - безусловное выполнение события
2) return true, return 1 - блокировка события
3) return 2 - выполнеие события и блокировка после обхода всех скриптов
4) return 3 - выполнение публичного события для всех соединений, кроме соединения, породившего это событие
5) return 4 - выполнение публичного события для всех соединений, кроме соединений, имеющих такой же ip адрес, что и соединение, породившее это событие
Примечание: Возвращаемое значение игнорируется при первой отправке на хаб MyINFO строки, так как в случае блокировки события пользователь будет скрыт (возможно эту политику следует пересмотреть (опустить) в дальнейшем).


OnChat(UID, sData)
Описание: Функция выполняется при отправке в чат сообщения пользователем.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение:
1) return false, return nil, return 0 - безусловное выполнение события
2) return true, return 1 - блокировка события
3) return 2 - выполнеие события и блокировка после обхода всех скриптов
4) return 3 - выполнение публичного события для всех соединений, кроме соединения, породившего это событие
5) return 4 - выполнение публичного события для всех соединений, кроме соединений, имеющих такой же ip адрес, что и соединение, породившее это событие



OnTo(UID, sData)
Описание: Функция выполняется при отправке в сообщения приват.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение: true или 1 - не отсылать сообщение.



OnConnectToMe(UID, sData)
Описание: Функция выполняется при попытке активного соединения.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение: true или 1 - не соединять пользователей.



OnRevConnectToMe(UID, sData)
Описание: Функция выполняется при попытке пассивного соединения.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение: true или 1 - не соединять пользователей.



OnSearch(UID, sData)
Описание: Функция выполняется при поиске.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение:
1) return false, return nil, return 0 - безусловное выполнение события
2) return true, return 1 - блокировка события
3) return 2 - выполнеие события и блокировка после обхода всех скриптов
4) return 3 - выполнение публичного события для всех соединений, кроме соединения, породившего это событие
5) return 4 - выполнение публичного события для всех соединений, кроме соединений, имеющих такой же ip адрес, что и соединение, породившее это событие



OnSR(UID, sData)
Описание: Функция выполняется при поступлении на хаб результатов пассивного поиска.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение: true или 1 - блокировать результаты поиска.



OnAny(UID, sData, iType)
Описание: Функция выполняется при поступлении на хаб любой команды.
Возвращаемое значение: true или 1 - блокировать команду.



OnUnknown(UID, sData)
Описание: Функция выполняется при поступлении на хаб любой не известной команды.
Возвращаемое значение: true или 1 - не блокировать команду.



OnKick(UID, sData)
Описание: Функция выполняется при поступлении на хаб команды кика.
Возвращаемое значение: любое.



OnOpForceMove(UID, sData)
Описание: Функция выполняется при поступлении на хаб команды перенаправления.
Возвращаемое значение: любое.



OnGetINFO(UID, sData)
Описание: Функция выполняется при поступлении на хаб команды $GetINFO.
Возвращаемое значение: true или 1 - не отсылать пользователю MyINFO запрошенного пользователя.



OnFlood(UID, iType, iNum)
Описание: Функция выполняется при обнаружении флуда со стороны пользователя. Может служить для устаноки бана за флуд или для разрешения флуда ОПераторам хаба. Параметр iType указывает тип команды, которой флудили. Параметр iNum указывает номер срабатываемого флуда 1 или 2 (см. настройки флуда).
Возвращаемое значение: true или 1 - не отключать пользователя.



OnWebData(WebID, sData)
Описание: Функция выполняется при поступлении данных на веб-сервер.
Возвращаемое значение: true или 1 - не разъединять пользователя по окончанию работы данного события.



OnConfigChange(sName, sValue)
Описание: Функция выполняется при изменении настройки. Параметр sName - название измененной настройки, sValue - новое значение настройки
Возвращаемое значение: любое.
Событие срабатывает только после изменения настройки при помощи объекта Config.



OnMCTo(UID, sData)
Описание: Функция выполняется при отправке приватного сообщения в чат.
Функция выполняется после всех проверок и до отправки.
Возвращаемое значение: true или 1 - не отсылать сообщение.

Core.SendToAll(sData, sNick, sFrom)
Описание: Функция отправляет данные sData всем пользователям, которые находятся на хабе.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SendToUser(UID/sToNick/tNicks, sData, sNick, sFrom)
Описание: Функция отправляет данные sData пользователю с идентификатором UID (User ID) или с ником sToNick или таблице ников tNicks.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SendToAllExceptNicks(tExcept, sData, sNick, sFrom)
Описание: Функция отправляет данные sData всем пользователям, которые находятся на хабе, кроме пользователей, ники которых указаны в таблице tExcept, если таковые находится на хабе.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SendToProfile(iProfile/tProfiles, sData, sNick, sFrom)
Описание: Функция отправляет данные sData профилю/профилям. Если в первом аргументе функции указано число, то данные отправляются указанному профилю, если в первом аргументе указана таблица, то данные отправляются профилям, которые указаны в этой таблице.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SendToNicks(tNicks, sData, sNick, sFrom)
Описание: Функция отправляет данные sData всем пользователям, ники которых указаны в таблице tNicks, если таковые находится на хабе.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.
Функция устарела. Используйте вместо неё функцию Core.SendToUser(tNicks, sData, sNick, sFrom)


Core.GetUser(UID/sNick, iByte)
Описание: Функция возвращает UID пользователя по нику sNick.


Core.SetUser(UID/sNick, iType, Value)
Описание: Функция устанавливает значение Value для данных типа iType для пользователя с ником sNick.
Описание типов данных iType:
1 - профиль (iProfile)
2 - MyINFO строка (sMyINFO)
3 - пользовательские данные (sData)
4 - пользователь в оп-листе, то есть имеет ключик (bInOpList)
5 - пользователь скрыт в ник-листе (bHide)
6 - пользователь в ip-листе, то есть ему отсылаются ip адреса всх пользователей (bInIpList)
Функция устарела. Используйте вместо неё прямую установку параметров: UID[sName] = Value или Core.GetUser(sNick)[sName] = Value, где sName - это одна из строк: "iProfile", "sMyINFO", "sData" и тд.


Core.GetUsersCount()
Описание: Функция возвращает текущее количество онлайн пользователей.


Core.GetTotalShare()
Описание: Функция возвращает текущую суммарную шару всех пользователей хаба.


Core.Disconnect(UID/sNick)
Описание: Функция отключает пользователя по идентификатору UID, или по нику sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.DisconnectIP(sIP, iProfile/tProfiles)
Описание: Функция отключает всех пользователей с указанным IP.
Если указан профиль/таблица с профилями iProfile/tProfiles, то отключаются только пользователи с указанным профилем/профилями.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.RestartScripts(iType)
Описание: Функция перезапускает все скрипты. Если параметр iType отсутствует, равен nil или равен 0, то перезагружаются все скрипты без исключения. Если параметр iType равен 1, то перезагружаются все скрипты, кроме работающих на данный момент. Если параметр iType равен 2, то перезагружаются все скрипты, кроме текущего скрипта (из которого была вызвана данная функция).
Возвращает true.


Core.RestartScript(sScriptName)
Описание: Функция перезапускает скрипт с именем sScriptName. Если параметр sScriptName отсутствует или равен nil, то функция перезапускает текущий скрипт.
Возвращает true в случае успеха, nil в случае неудачи, nil и сообщение об ошибке в случае синтаксической ошибки.


Core.StopScript(sScriptName)
Описание: Функция останавливает скрипт с именем sScriptName. Если параметр sScriptName отсутствует или равен nil, то функция останавливает текущий скрипт.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.StartScript(sScriptName)
Описание: Функция запускает скрипт с именем sScriptName.
Возвращает true в случае успеха, nil в случае неудачи, nil и сообщение об ошибке в случае синтаксической ошибки.


Core.MoveUpScript(sScriptName)
Описание: Функция поднимает скрипт с именем sScriptName в дереве выполнения.
Если параметр не указан, то поднимается текущий скрипт.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.MoveDownScript(sScriptName)
Описание: Функция опускает скрипт с именем sScriptName в дереве выполнения.
Если параметр не указан, то опускается текущий скрипт.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.GetScripts()
Описание: Функция возвращает таблицу со скриптами как таблицы с полями sName, bEnabled, iMemUsage.


Core.GetScript(sScriptName)
Описание: Функция возвращает таблицу со скриптом таблицу с полями sName, bEnabled, iMemUsage.
Если имя не указано, то возвращается таблица текущего скрипта.


Core.GetGVal(sScriptName, sParam)
Описание: Функция возвращает значение глобальной переменной с именем sParam скрипта sScriptName.
Функция работает только с переменными типов: string, number, boolean, lightuserdata и table, для остальных типов будет возвращать nil.
Возвращает значение в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SetGVal(sScriptName, sParam, Value)
Описание: Функция устанавливает значение глобальной переменной с именем sParam скрипта sScriptName.
Функция работает только с переменными типов: string, number, boolean, lightuserdata и table.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SetCmd(sData)
Описание: Функция устанавливает новую команду для функций последующих скриптов.
Устанавливаемая команда должна быть синтаксически правильной, то есть соответствовать по синтаксису команде текущего события (API функции события). В противном случае функция не изменит команду и вернёт nil и соответствующее сообщение.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.GetUsers(sIP, bAll)
Описание: При отсутствии аргументов функция возвращает таблицу со всеми уже полностью вошедшими на хаб пользователями (с UID-ми всех вошедших пользователей хаба).
Core.GetUsers(true) - таблица со всеми пользователями хаба, даже которые только входят и ещё не вошли.
Core.GetUsers(sIP) - таблица с UID'ми вошедших пользователей с указанным IP
Core.GetUsers(sIP, true) - таблица со всеми пользователями с указанным IP.


Core.AddTimer(iId, iInterval, sFunc)
Описание: Функция добавляет таймер с идентификатором iId и интервалом срабатывания iInterval (в мсек). Если указано имя глобальной функции sFunc, то эта функция и будет выполняться, если имя функции не указано, то скрипт ищет глобальную функцию OnTimer (в параметр функции передаётся идентификатор). Идентификатор может повторяться.
Возвращает количество зарегистрированных таймеров с таким iId в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.DelTimer(iId)
Описание: Функция удаляет таймер по идентификатору iId.
Идентификатор может повторяться, однако, удаляется таймер по идентификатору, поэтому удалятся все таймеры с указанным идентификатором. Удаляются таймеры только текущего скрипта! Таймеры с таким же идентификатором других скриптов не удаляются!
Возвращает количество удалённых таймеров в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.GetUpTime()
Описание: Функция возвращает время работы хаба (в сек.)


Core.GetConfig(sName)
Описание: Функция возвращает настройку хаба sName. Какого бы типа не была настройка, всегда возвращается строковый тип.
В случае неудачи возвращает nil и сообщение об ошибке.
Функция устарела. Используйте вместо неё объект: Config[sName]


Core.SetConfig(sName, sValue)
Описание: Функция устанавливает настройку хаба sName в значение sValue.
Однако, исключения составляют настройки sHubIP, iMainPort, sSubPorts, которые нельзя изменить.
При изменении настройки sHubName или sTopic отправляется соответствующая команда. После изменения, настройки сохраняются.
При изменении sHubBot и/или bRegMainBot - автоматически перерегистрируется бот.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.
Функция устарела. Используйте вместо неё прямую установку параметров: Config[sName] = sValue


Core.GetLang(sName)
Описание: Функция возвращает "языковую" настройку sName.
В случае неудачи возвращает nil и сообщение об ошибке.


Core.SetLang(sName, sValue)
Описание: Функция устанавливает "языковую" настройку хаба sName в значение sValue.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.Call(sScriptName, sFunc, ...)
Описание: Функция вызывает функцию sFunc другого скрипта sScriptName с параметрами, которые указываются в аргументе 3, 4 и тд.
Параметры функции и возвращаемые значения функции могут быть только следующих типов: string, number, boolean, table и userlightdata.
Функция Core.Call возвращает все те значения, которые возвращает функция sFunc скрипта sScriptName.
В случае ошибки функция возвращает nil и сообщение об ошибке.


Core.SendToAllExceptIPs(tExcept, sData, sNick, sFrom)
Описание: Функция отправляет сообщение всем пользователям, за исключением пользователей с ip адресами, которые указаны в таблице tExcept.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SendToIP(sIP, sData, sNick, sFrom, iProfile/tProfiles)
Описание: Функция отправляет сообщение sData всем пользователям с указанным IP адресом sIP.
Если указан параметр sNick, то сообщение sData отправляется в чат от ника sNick.
Если указаны параметры sNick и sFrom, то сообщение sData отправляется в приват от отправителя sFrom с ником sNick.
Если указан профиль/таблица с профилями iProfile/tProfiles, то сообщение отправляется только указанным профилям с данным IP адресом.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.RegBot(sNick, bKey, sMyINFO, sIP)
Описание: Функция регистрирует бота с ником sNick. Если bKey равен true, то бот регистрируется с ключиком. sMyINFO - это часть MyINFO строки (часть после ника, начиная с описания и до конца MyINFO). sIP - возможный ip адрес для бота. Обязательным параметром является только первый параметр - sNick.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.UnregBot(sNick)
Описание: Функция удаляет регистрацию бота с ником sNick из списка.
Возвращает true в случае успеха, nil и сообщение об ошибке в случае неудачи.


Core.SetHubState(iNum)
Описание: Функция устанавливает состояние хаба.
iNum = nil или iNum = 0 - остановка хаба. iNum = 1 - рестарт хаба. Остальные значения заразервированы на будущее


Core.Redirect(UID/sNick, sAddress[, sReason])
Описание: Перенаправляет пользователя на адрес sAddress с причиной sReason. Причину указывать не обязательно.
Возвращает true в случае успеха, nil и сообщение с ошибкой - в случае неудачи


Config - объект конфигурационных настроек хаба
Config.table() - таблица с названиями всех возможных настроек хаба
Core.sMainDir - основной путь, по которому располагается хаб
Core.sScriptsDir - абсолютный путь, по которому располагается директория скриптов
Core.sHubVersion - название и версия хаба
Core.sLuaPluginVersion - название и версия плагина
Core.sSystem - название и версия ОС
_TRACEBACK = debug.traceback - способ включить stack trace для скрипта

UID.sNick - ник
UID.sIP - ip
UID.iProfile - профиль
UID.bInOpList - пользователь в оп-листе, то есть имеет ключик
UID.bInIpList - пользователь в ip-листе, то есть ему отсылаются ip адреса всех пользователей
UID.bInUserList - пользователь полностью вошёл и добавлен в список пользователей
UID.bHide - пользователь скрыт в ник-листе
UID.iPort - порт хаба
UID.iPortConn - порт соединения
UID.sMacAddress - мак адрес
UID.sVersion - версия протокола
UID.sData - вспомогательное текстовое поле для различных нужд
UID.UID - UID юзера (lightuserdate)
UID.sSupports - параметр $Suppurts команды
UID.sMyINFO - MyINFO строка
UID.sDesc - описание
UID.sTag - тэг
UID.sClientName - название клиента
UID.sClientVersion - версия клиента
UID.sMode - режим
UID.iUsHubs - обычные хабы
UID.iRegHubs - рег хабы
UID.iOpHubs - оп хабы
UID.iSlots - слоты
UID.iLimit - ограничитель скорости скачивания с пользователя (L:x)
UID.iOpen - открытые экстра слоты (O:x)
UID.iBandwidth - ограничитель скорости скачивания с пользователя (B:x)
UID.iDownload - ограничитель скорости скачивания пользователем (D:x)
UID.sFraction - ограничитель скорости скачивания пользователем/с пользователя (F:x/y)
UID.sConn - соединение
UID.iByte - магический байт
UID.sEmail - email
UID.iShare - шара в байтах
UID.iEnterTime - время входа на хаб (время отсылки на хаб команды $Key)
UID.sIPConn - ip адрес (хост) хаба, на который был принят пользователь
UID.bKick - способность ОПератора к кику
UID.bRedirect - способность ОПератора к перенаправлению