Предисловие...

Содержание

Об установке и настройке



Необходимые переменные для настройки



ПеременнаяОписание
 
CFG_CASHE_LIVEТип: Ссылка на массив целых чисел.
Время хранения кэша для разных секций, в секундах.
( Только для mod_perl'а. )
0Время хранения кэша групп
1Время хранения кэша пользователей
2Время хранения кэша *.src файлов
3Время хранения кэша файлов forum.cfg
4Время хранения кэша файлов messages.cfg
5Время хранения кеша файлов colors.cfg
CFG_CASHE_SIZEТип: Ссылка на массив целых чисел.
Размер кэша для разных секций, в количестве переменных.
( Только для mod_perl'а. )
0Размер кэша групп
1Размер кэша пользователей
2Размер кэша *.src файлов
3Размер кэша файлов forum.cfg
4Размер кэша файлов messages.cfg
5Размер кеша файлов colors.cfg
CFG_HOME_DIRТип: Строка.
Директория в которой лежат поддиректории схем (файлы *.src) и прочие конфиги.
CFG_MAX_DATA_SIZEТип: Целое число.
Максимальный размер данных принимаемый из формы, в байтах.
CFG_PAGE_SIZEТип: Целое число.
Размер страницы при выводе списка групп.
CFG_PSWD_LIVEТип: Целое число.
Время действия временного пароля, в секундах.
CFG_READ_ONLY_IDТип: Целое число больше 0.
Идентификатор пользователя с доступом рид онли.
DB_DATE_FORMAT_ARGТип: Ссылка на массив строк.
Набор форматов дат.
DB_DATE_FORMAT_STRТип: Строка.
Процедура для вашей БД для преобразования даты в выбранный формат.
DB_DBDТип: Строка.
Описание опций для соединения с базой данных т.е. драйвер БД, сервер и т.д.
DB_PSWDТип: Строка.
Пароль пользователя для соединения с БД
DB_USERТип: Строка.
Имя пользователя для соединения с БД
HTML_NOT_CLOSE_TEGТип: Ссылка на хеш.
Не закрывающиеся HTML тэги. Используется при разрешении показа некоторых HTML тегов в схеме. Все остальные не закрытые HTML теги автоматически закрываются.
MAX_SUBSCRIBEТип: Целое число.
Максимальное число групп на которые одновременно может подписаться пользователь.
SKIN_CHECK_TIMEOUTТип: Целое число.
Интервал для поиска/удаления схем.
SKIN_DEFAULTТип: Строка.
Схема по умолчанию.
DB_CHECK_TIMEOUTТип: Целое число.
Интервал времени через который пингуется БД, в секундах.
( Только для mod_perl'а )
CFG_POST_TIME_LIMITТип: Целое число.
Минимальный интервал времени через который через который возможно повторное обращение к БД на запись (новая группа, новое сообщение, ответ)
CFG_SOURCE_CPТип: Строка.
Кодировка в которой хранятся данные на сервере.
CFG_DEST_CPТип: Строка.
Кодировка в которой данные отдаются клиенту.


Схема дерева команд (cmd)



??? 
| 
+------->14----->22 
| 
+->1000-+--------------->1--+-->15--->25
 | ^ ^ | 
 | | |_____| 
 +->4------5 
 | 
 +->2--+-->3--->26 
 | ^ | 
 | |___| 
 | 
 +->11----->24 
 | 
 +->12----->21 
 | 
 +->31------+---->33 
 | ^ | 
 | |_______| 
 | 
 +->32------+---->34 
 | ^ | 
 | |_______| 
 | 
 +->6--+ 
 | ^ | 
 | |___| 
 | 
 +->13----->23 
 | 
 +->35----->36 
 | 
 +->37----->38 
 | 
 +->39----->40 
 | 
 +->41 
 


Параметры команды cmd



КодИмя процедурыОписание
 
??? Регистрация в форуме
1000default_menuГлавная страница (не криптованный пароль)
1001default_menuГлавная страница (криптованный пароль)
1002redirectРедирект
1read_msgЧтение сообщений
2groups_infoИнформация о группах
3group_infoИнформация о группе
4find_msgПараметры поиска
5find_msg_goСтарт поиска
6user_infoПросмотр информации о пользователях
11questionНовый вопрос
12new_groupНовая группа
13new_user_profileИзменить настройки пользователя
14user_addНовый юзер
15answerОтвет на сообщение
21new_group_saveЗаписать данные о новой группе
22user_add_saveЗаписать данные о пользователе
23new_user_profile_saveЗаписать новые настройки пользователя
24question_saveЗаписать новый вопрос
25answer_saveЗаписать ответ на вопрос
26group_satusЗаписать изменения в статусе подписки на чтение сообщений группы
31adminУдаление сообщения
32adminВосстановление сообщения
33admin_saveЗапись удаления
34admin_saveЗапись восстановления
35edit_cfgРедактирование конфигурационного файла схемы.
36edit_cfg_saveЗапись данных редактирования конфигурационного файла схемы.
37edit_group_cfgРедактирование конфигурации группы.
38edit_group_cfg_saveЗапись конфигурации группы.
39upload_fileВыбор файла для закачи на сервер.
40upload_file_saveЗапись файла на сервере.
41skin_addСоздать новую схему.


Аргументы процедур







Допустимые вложения в файлах .src





Типы данных аргументов процедур



АргументТип данных и описание
 
access_cfgТекст. Список форматов ( через запятую ) которыми можно пользоваться при просмотре сообщений в данной схеме.
access_cmdТекст. Список комманд ( через запятую ) разрешенных для выполнения в данной схеме.
access_groupТекст. Список групп ( через запятую ) разрешенных для работы в данной схеме.
access_html_tagТекст. Список ( через запятую ) HTML тегов которые можно использовать с данной схемой.
access_skinТекст. Список схем ( через запятую ) в которых разрешено работать с данной группой.
access_userТекст. Список ( через запятую ) идентификаторов пользователей которым разрешено работать с данной схемой/группой.
access_tidТекст. Список ( через запятую ) идентификаторов открытых тредов группы.
anti_matЧисло 0 или 1. Включить/выключить цензуру.
adminТекст. Nike администратора группы.
ageЦелое число. Возраст.
cfgЦелое число. Варианты 0,1,2,3,4,5,6,7,8. Указывает в каком виде выводить список сообщенийю Для cfg= (7 || 8) необходим параметр id.
cmdЦелое число. Номер команды.
dataЗависит от процедуры, обычно текст.
dateДата в формате: 'год-месяц-день час:мин:сек'.
date_formatЦелое число. Номер формата даты в котором она быдет отображаться в данной схеме.
default_gruopЦелое число. Идентификатор группы 'по умолчанию'.
deny_groupТекст. Список групп ( через запятую ) запрещенных для работы в данной схеме.
deny_skinТекст. Список схем ( через запятую ) в которых запрещено работать с данной группой.
deny_userТекст. Список ( через запятую ) идентификаторов пользователей которым запрещено работать с данной схемой/группой.
deny_tidТекст. Список ( через запятую ) идентификаторов закрытых тредов группы.
descriptionТекст. Расказ пользователя о себе, или описание группы.
emailТекст. E mail адрес пользователя
fileФайл для закачки на сервер.
find_groupТекст. Имя группы для поиска.
find_userТекст. Псевдоним пользователя для поиска.
firstЦелое число. Используется для определения первого индекса группы при просмотре данных о группах.
fromТекст. Псевдоним отправителя сообщения.
full_nameТекст. Полное имя пользователя.
groupЦелое число. Идентификатор группы.
group_nameТекст. Имя группы.
group_rule_accessЦелое число. 0 - всем группам кроме ACCESS_GROUP (или всем из DENY_GROUP) доступ только ридонли
1 - всем группам кроме ACCESS_GROUP (или всем из DENY_GROUP) вообще ни какого доступа.
idЦелое число. Номер сообщения.
lastЦелое число. Используется для определения последнего индекса группы при просмотре данных о группах.
new_cmdЦелое число. Номер команды. Используется при редиректе, т.е. чтобы например зайти с первой страници (регистрации) сразу на чтение сообщений можно пользовать что то типа: ?cmd=1002&nike=gosha&raw_pswd=pass&new_cmd=1&cfg=1&group=2
new_pswdТекст. Новый пароль.
nikeВ зависимости от процедуры. При регистрации и добавлении пользователя это ТЕКСТ т.е. псевдоним пользователя.Во всех остальных случаях Целое число т.е. идентификатор пользователя.
pswdТЕКСТ временного пароля (7 бит без пробелов).
raw_pswdТЕКСТ. пароль пользователя.
real_skinТекст. Имя схемы из которой реально берутся файлы *.src.
reg1Целое число. Используется для задания типа поиска по колонке номер сообщения.
reg2Целое число. Используется для задания типа поиска по колонке тема сообщения.
reg3Целое число. Используется для задания типа поиска по колонке автор сообщения.
reg4Целое число. Используется для задания типа поиска по колонке адресат сообщения.
reg5Целое число. Используется для задания типа поиска по колонке дата отправки сообщения.
reg6Целое число. Используется для задания типа поиска по колонке 'ответ_на_сообщение' сообщения.
reply_toЦелое число. Номер сообщения на которое есть ответы...
skin_adminЦелое число. Идентификатор администратора схемы.
skin7 битный текст без пробела. Имя схемы.
subjТекст. Тема сообщения. Используется для поиска сообщений соответствующей темы.
toТекст. Псевдоним пользователя которому предназначается сообщение.
user_rule_accessЦелое число. 0 - всем пользователям кроме ACCESS_USER (или всем из DENY_USER) доступ только ридонли
1 - всем пользователям кроме ACCESS_USER (или всем из DENY_USER) вообще ни какого доступа.
skin_rule_accessЦелое число. 0 - из всех схем кроме ACCESS_SKIN (или всем из DENY_SKIN) доступ только ридонли
1 - из всех схем кроме ACCESS_SKIN (или всем из DENY_SKIN) вообще ни какого доступа.


Типы данных вложений в файлах .src



ВложениеТип данных
 
ACCESS_CFGHTML текст.
ACCESS_HTMLHTML текст.
ACCESS_GROUPHTML текст.
ACCESS_HTML_TAGHTML текст.
ACCESS_TIDHTML текст.
ACCESS_SKINHTML текст.
ACCESS_USERHTML текст.
ANTI_MATЦелое число 0 или 1. Включть выключить проверку на 'мат'
ACTIONТекст.
ADMINПри редактировании файла конфигурации схемы - целое число, во всех остальных случаях HTML текст.
AGEЦелое число.
AUTHORHTML текст.
CFGЦелое число. Возможны варианты : 0,1,2,3,4,5,6.
CNTЦелое число.
COLORЦвет заданный в colors.cfg (Например #f8f8f8).
DATAЗависит от процедуры. В большинстве случаев HTML text.
DATEДата в формате заданном в DATE_FORMAT.
DATE_FORMATЦелое число.
DEFAULT_GROUPЦелое число.
DENY_GROUPHTML текст.
DENY_TIDHTML текст.
DENY_SKINHTML текст.
DENY_USERHTML текст.
DESCRIPTIONHTML текст.
EMAILHTML текст.
ERROR_NUMЦелое число.
FIND_GROUPИли ескейпт последовательность или HTML текст.
FIND_USERHTML текст.
FIRSTЦелое число.
FROMHTML Текст.
FULL_NAMEHTML текст.
GROUPЦелое число.
GROUP_NAMEHTML Текст.
GROUP_RULE_ACCESSЦелое число.
GROUPSHTML код.
IDЦелое число.
JS_TIMEСтрока вида LH,HH,LM,HM,LS,HS где
L - старший разряд
H - младший разряд
H - часы
M - минуты
S - секунды
LASTЦелое число.
LINKSHTML Текст (вида <a href='....'>0001-0009</a>).
LOCAL_TIMEВремя в формате: Sun Mar 11 20:54:04 2001.
NIKEЦелое число.
PACK_SUBJЭскейпт последовательность (%61%20...).
PSWD_LIVEЦелое число.
PSWD7 битный текст без пробелов.
RAW_NIKEHTML текст.
REAL_SKINHTML текст.
SKIN_ALLHTML код.
SKIN_ADMINЦелое число.
SKIN7 битный текст без пробелов.
STATUSHTML текст. (groups_info.src секция 4,5).
STYLE_CLASSСтиль заданный в colors.cfg.
SUBJHTML Текст.
TO_NIKEHTML текст.
TOHTML Текст.
UPLOADHTML текст.
USER_CNTЦелое число.
USER_RULE_ACCESSЦелое число.
TIDЦелое число.
SKIN_RULE_ACCESSЦелое число.


Файл forum.cfg



В этом файле описываются права на выполнение команд, просмотра групп, формата просмотра сообщений и тд. Команда разделяется символом '^' аргументы между собой разделяются запятыми

ACCESS_CFGесли не закоментированно то разрешено чтение сообщений только в формате перечисленных через запятую.
0Вывод дерева всех сообщений данной группы
1Вывод дерева сообщений данной группы и данной темы
2Вывод сообщения по ID
3Вывод всех сообщений данной группы
4Вывод сообщений данной группы и данной темы
5Вывод заголовков сообщений с последующим вызовом с параметром cfg=1
6Вывод заголовков сообщений с последующим вызовом с параметром cfg=4
ACCESS_CMDесли не закоментированно то разрешено выполнение всех команд перечисленных через запятую.
ACCESS_CONFIGUREСписок параметров ( через запятую ) конфигурации которые можно редактировать через WEB форму. Т.е. значения из этого файла ( например ^ACCESS_USER,DENY_USER ). Через WEB не меняются два параметра ACCESS_CONFIGURE и ACCESS_UPLOAD.
ACCESS_GROUPесли не закоментированно то разрешена работа с этим skin'ом только с группами перечисленными через запятую.
ACCESS_HTML_TAGесли не закоментированно то разрешено использование HTML тегов перечисленных через запятую. '*' - вообще ничего не квотится.
ACCESS_UPLOADСписок файлов ( через запятую ) разрешенных к закачке на сервер, для данной схемы. Файлы *src или message.cfg, color.cfg.
ACCESS_USERесли не закоментированно то разрешена работа с данным skin'ом пользователям (ID) перечисленным через запятую.
DATE_FORMATнастраивает формат вывода времени для данной схемы. это должно быть целое число. значение соответствует порядковому номеру элемента массива {DATE_FORMATS}, и конкретно он настройки.
DEFAULT_GROUPгруппа используемая по умолчанию.
DENY_GROUPесли не закоментированно то запрещена работа этот skin с группами перечисленными через запятую.
DENY_USERесли не закоментированно то запрещена работа с данным skin'ом пользователям (ID) перечисленным через запятую.
GROUP_RULE_ACCESSТеже значения что и для USER_RULE_ACCESS только права для групп
REAL_SKINимя skina, те в идеале в forum.cfg можно записать только права на выполнение чего либо а сами .src лежат в схеме REAL_NAME.
USER_RULE_ACCESSМожет принимать два значения:
0 - всем пользователям кроме ACCESS_USER (или всем из DENY_USER) доступ только ридонли
1 - всем пользователям кроме ACCESS_USER (или всем из DENY_USER) вообще ни какого доступа.


Файл colors.cfg



Описывает комбинации цветов и стилей при цитировании сообщения т.е. пример '1^red' значит что все строки в сообщении начинающиеся на > выделяются цветом 'red' (см соответствующие вложения) разделен на две секции ^COLORS и ^STYLES в первой цвета во второй стили

Глубина цитирования сообщенияСоответствующий цвет/стиль
0red
1#ff00ff
......
 
0name_1
1name_2
......


Файл messages.cfg



Сообщения вставляемые в при обработки файлов message.src и error.src при определенных условиях

0Выводится при неудачном обращении к базе данных.
1Выводится если не опознано nike/id пользователя.
2Выводится если введен неверный пароль или закончилось действие временного пароля.
3Выводится если не опознан идентификатор группы.
4Выводится если не опознано значение параметра cfg при чтении сообщений.
5Выводится если пользователь без прав на это пытается администрировать данную группу.
6Выводится если пытаются отправить сообщение несуществующему пользователю.
7Выводится если в процедуру передаются не все запросы. В конец строки добавляется имя недастающего аргумента.
8Выводится при успешном отправлении сообщения.В конец добавляется имя адресата.
9Выводится если пытаются ответить на приватное сообщение оставленное не для этого пользователя.
10Выводится при попытке завести псевдоним уже используемый.
11Сообщение выводимое при успешной регистрации _НОВОГО_ пользователя.
12Сообщение выводимое при успешно прошедшей смене конфигурации пользователя.
13Сообщение выводимое если доступ к запрашиваемому ресурсу закрыт.
14Сообщение выводимое при успешно прошедшей конфигурации группы.
15Сообщение выводимое при успешно прошедшей конфигурации схемы.
16Сообщение выводимое выводимое при успешном выполнении удаления сообщения.
17Сообщение выводимое выводимое при успешном выполнения восстановления сообщения.
18Сообщение выводимое при смене статуса подписки на группу.
19Сообщение выводимое при попытку зарегистрировать группу с существующим названием.
20Сообщение выводимое при успешной регистрации группы.
21Сообщение выводимое если сообщение не найдено.
22Сообщение выводимое если из списка групп пользователя GROUPS_LIST пытаются удалить последнюю группу.
23Сообщение выводимое при вводе некорректного email адреса.
24Сообщение выводимое при попытке администрировать схему не являясь ее администратором.
25Сообщение выводимое при превышении лимита максимальной подписки на группы.
26Сообщение выводимое при слишком частом обращении к форуму для записи данных.
27Сообщение выводимое при успешно прошедшей закачки файлова схемы.
28Выводится выводимое при успешно прошедшей регистрации новой схемы. В конец строки добавляется ID созданной схемы.
29Выводится выводимое при попытке ответа на закрытый тред.


Другие ветки...





Автор



Copyright (C) Okunev Igor gosha@prv.mts-nn.ru
 
Last updated: $Date: 2001/09/28 22:02:02 $