Создание встроенного модуля CMS

Материал из School Portal Wiki
Перейти к: навигация, поиск

Сейчас мы с вами напишем встроенный модуль для CMS, который максимально прост и делает одну вещь: говорит «Hello World!».

Предстоит редактировать файл cms.pl, в установленном портале он находится здесь:

/var/www/cgi-bin/sp/cms/

Главный принцип, о котором нужно помнить всегда: модули не имеют право ничего печатать на экран (использовать "print"), они должны только возвращать ("return") сгенерированный html-текст.

Это нужно для того, чтобы пользователь мог выбрать, в каком блоке расположены модули и в каком порядке они срабатывают.

Название

Первое, что нужно сделать, это придумать имя для будущего модуля.

Имени у модуля два:

  1. Внутреннее
  2. Для людей

Внутренне имя должно состоять только из латинских символов и чисел.

Имя для людей можно (и по возможности рекомендуется) назначать на русском языке.

Длина имён ограничена 100 символами, постарайтесь назвать модуль как можно короче, но так, чтобы было понятно, что он делает.

Я выбрал внутреннее имя "hello" и человеческое название "Привет, мир!".

Регистрация в базе

CMS портала должна знать, что у нее появился новый модуль. Для этого выполняем (один раз!) SQL-запрос на базе CMS.gdb:

INSERT INTO MODULES (MODULENAME, VISIBLE_NAME, M_DEF_LINK, ACCESS, M_PLACE)
VALUES ('hello', 'Привет, мир!', 'mod=hello', ',6,,2,,4,', 'center');

Красным отмечено то, что нужно заменить на выбранные вами названия модуля.

Список софта для работы с БД Firebird: http://www.ibase.ru/d_tools.htm

Для новичков: http://www.firebirdnews.org/docs/fb2min_ru.html

Кодировка базы и файла cms.pl — cp1251.

Как узнать аттрибуты доступа к базе

После этого можно видеть, что модуль появился в списке модулей (пункт меню Сайт → Компоненты). Он расположен в блоке center, по умолчанию опубликован и доступен для добавления в меню.

Module hello in list.png

Код модуля

Открывайте cms.pl в своём любимом редакторе и дописывайте процедуру.

Название процедуры должно совпадать с названием модуля.

sub hello()
{
	return "Hello, World!";
}

Добавление в список встроенных модулей

Открывайте common.pl (он живёт на уровень выше) найдите:

our @modules = ...

и допишите внутреннее латинское имя вашего модуля к этому массиву.

Использование

Поздравляем, ваш первый модуль готов!

Давайте добавим его в главное меню сайта. Для этого в админке идём по адресу: Сайт → Компоненты и жмём кнопку Добавить напротив вашего нового компонента. После этого вы попадёте в редактор меню, который покажет вам, что получилось. А получилось у нас следующее: ваш модуль автоматически представлен пунктом меню с человеческим названием, находится ниже всех остальных пунктов и по умолчанию включен.

Переходите на сайт, щёлкните в меню по созданному только что пункту и смотрите, ваш модуль работает! :)

Module test on site.png

Кеширование

Ваш модуль выполнится при первом запуске (или после правки cms.pl), а в дальнейшем результат его работы закешируется в память и будет выдаваться только оттуда, чтобы снизить нагрузку. Это поведение по умолчанию.

Если ваш модуль показывает нечто, что меняется чаще, чем раз в сутки, кеширование для него нужно выключить. Это гарантирует, что код модуля будет выполнен при каждом вызове.

Делается это в cms.pl в процедуре Kernel: дописать внутреннее латинское имя в массив @ex_mod

Сделаем что-то поинтереснее

Наш простейший пример на вид от статьи почти не отличается, давайте добавим динамики, например, сделаем так, чтобы модуль показывал календарь.

Снова откройте cms.pl и измените процедуру вашего модуля:

sub hello()
{
	return '<pre>' . `cal -y` . '&lt;/pre>';
}

Смотрите, что получилось:

Give me some dynamic.png

Обратите внимание, для вашего модуля ЧПУ создан автоматически.

Вся мощь языка Perl к вашим услугам :) Дальнейшее поведение вашего модуля будет зависеть только от вашей фантазии. Дерзайте!

Конфигурация

Чтобы добавить к модулю собственные настройки (их можно увидеть и изменить по клику на имени модуля в списке модулей (пункт меню Сайт → Компоненты)), следует выполнить два условия:

  1. В строке модуля в таблице MODULES должно быть заполнено поле M_CONFIG.
  2. Должна существавать функция имя_модуляConfig.

Пример поля M_CONFIG (без кавычек): ",option1=123,option2=456,".

# Конфигурация модуля hello
sub helloConfig()
{
	# so = Save Options
	if ( param('edt') eq 'so' )
	{
		my $mod_id  = param('i_id');
		my $option1 = param('option1'); 
		my $option2 = param('option2'); 
		sqlcms(qq[update modules_cnf_users set m_config = ',option1=$option1,option2=$option2,' where i_id = '$mod_id' and owner = '$owner']);
		return;
	}
 
	my $html = 'Настройки, например: <input type="text" name="hello_option">';
	return $html;
}

Использовать конфигурацию просто: достаточно вызвать GetConfig() с именем модуля и читать хеш $MOD_CONFIG.

# чтение конфигурации в модуле
sub hello
{
	# чтение конфигурации
	GetConfig('hello');
 
	# чтение параметров
	my $option1 = $MOD_CONFIG{'option1'};
	my $option2 = $MOD_CONFIG{'option2'};
 
	my $html = '...';
 
	return $html;
}

Репозиторий

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

См. далее

Создание встроенного модуля CMS. Часть 2