WebScript.Ru
C:\   главная  ::   о сайте  ::  каталог скриптов  ::  гнездо  ::  форум  ::   авторам  :: Новостройки ::   ХОСТИНГ  ::

|| разделы::
|| поиск по сайту::

|| реклама::
|| новости почтой::
Рассылки Subscribe.Ru ::



Новости сайта WebScript.Ru
Популярные статьи

Hot 5 Stories

|| рекомендуем::




Template Toolkit для веб разработчика.


Прислал: Бурмистров Андрей [ 09.01.2003 @ 11:55 ]
Раздел:: [ Статьи по Perl ]


Template Toolkit (TT) — это мощная система обработки шаблонов, написана на Perl. Использование шаблонов для генерации веб страниц позволяет убрать из cgi скрипта весь html код в отдельный файл (шаблон), где его сможет редактировать дизайнер. Скрипт при этом становися более читабельным. Нечитабельные скрипты тоже имеют свои преимущества: если вас уволят, другие программисты будут до старости разбираться в написаной вами матершине, а начальство десять раз пожалеет о том, что поспешило с вами расстаться.


Как это выглядит — простой пример.

Вот пример скрипта, использующего ’TT’ (script.pl):
#!/usr/bin/perl

use strict;
use CGI qw(:cgi);
use Template;

my $scalar = 'a';
my @list = ('b', 'c');
my %hash = (key => 'uuu');
sub code { scalar (localtime) }
my $object = CGI->new;

my $parser = Template->new (INCLUDE_PATH => '/home/my-project.ru/tpl');
print header ();
$parser->process('page.tpl', { scalar  => $scalar,
list    => \@list,
hash    => \%hash,
code    => \&code,
cgi     => $object })  or die $parser->error;
А это шаблон (page.tpl):

<body>
Our varibles: [% scalar %], [% list.0 %], [% list.1 %], [% hash.key %]
Time: [% code %]
User: [% cgi.param('user') %]
</body>

Теперь наберём //my-project.ru/cgi-bin/script.pl?user=VASIA и получим страничку:
<body>
Our varibles: a, b, c, uuu
Time: Sun Jan 5 16:52:56 2003
User: VASIA
</body>

Что TT может - какие директивы используются в шаблонах.

1. Использование переменных
[% GET var %] или просто [% var %] - TT подставляет значение переменной var.
[% SET var = 'value' %] или просто [% var = 'value' %] - TT присваивает значение переменной var.
Переменная в TT - это скаляр, содержащий либо обычную строку, либо ссылку на список, хэш, объект или функцию. Инициализируются переменные также, как в Perl:
[% scalar = 'hello' %], [% scalar = 10 %]
[% list = [1, 2, 'world'] %], [% list = [1..9] %]
[% hash = {
a => 'b',
c => 'd'
}
%]
Чтобы передать переменные из скрипта в шаблон, служит 2ой аргумент метода process класса Template (см. script.pl).
В директивах [%GET%] и [%SET%] можно использовать арифметические (+ - * / % mod div) и логические (and, or, not, ?: ) операторы:
[% a = b*c + 10 %]
[% (a) ? b : c %]
Подробно об использовании переменных в TT:
//www.template-toolkit.org/docs/default/Manual/Variables.html
И о дерективах для доступа к переменным:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Accessing_and_Updating_Template_Variables


2. Включение других шаблонов.
[% BLOCK blockname %] ... [% END %] - Определение блока blockname. Блок в TT - аналог функции в Perl. Тело блока -это шаблон. Блок может 'вызываться' директивами [% INCLUDE %] и [% PROCESS %]. Допустима рекурсия.

[% INCLUDE tplname %] - TT включает шаблон tplname. tplname - это либо шаблон, определённый директивой [% BLOCK %], либо имя файла. Cначала проверяется наличее блока tplname, если такого нет, ищется файл. INCLUDE_PATH - мы использовали эту переменную присоздании объекта Template, это список директорий, в которых TT ищет файлы шаблонов. Все наши переменные включаемому tplname видны. И все переменные перед включением tplname локализуются:
[% BLOCK dummy %]
[% a = '1' %][% a %]
[% END %]

[% a = 0 %][% a %]
[% INCLUDE dummy %]
[% a %]
результатом будет 0 1 0.
Важно заметить: при локализации в TT создаются новые копии всех переменных, но не создаются копии объектов, на которые переменные могут ссылаться. Т.е. если переменная содержит строку — всё ок, получим новую копию строки. Если переменная содержит ссылку на, скажем, список — получим новую ссылку на тот же список:
[% BLOCK dummy %]
[% a.0 = '1' %][% a.0 %]
[% END %]

[% a.0 = '0' %][% a.0 %]
[% INCLUDE dummy %]
[% a.0 %]
результатом будет 0 1 1.
Авторы TT называют это явление 'skin deep localization', красиво звучит, правда? :)
Передать параметры во включаемый шаблон можно следующим очевидным образом:
[% INCLUDE dummy a=1 b=2 %]

[% PROCESS tplname %] - то же, что и [% INCLUDE %], только без локализации переменных. Соответсятвенно работает немного быстрее.

[% INSERT file %] - TT включает указаный файл, не обрабатывая его как шаблон.

Подробно об этом:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Processing_Other_Template_Files_and_Blocks


3. Управление 'выполнением'.
[% IF %] [% UNLESS %] [% ELSIF %] [% ELSE %]
[% SWITCH %] [% CASE %]
[% FOREACH %]
[% WHILE %]
- всё это рабортает. Роль '}' выполняет [% END %]. В циклах можно спользовать [% NEXT %] и [% LAST %].
Подробно:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Conditional_Processing
//www.template-toolkit.org/docs/default/Manual/Directives.html#Loop_Processing


4. Фильтры.
Очень удобная и полезная осбенность TT.
[% FILTER filtername %] data to filter [% END %]
[% INCLUDE sometemplate FILTER filtername %]
[% INCLUDE sometemplate FILTER filtername FILTER otherfiltername %]
- TT обрабатывает указаный текст или результат включения sometemplate фильтром filtername. Фильтр - это некоторая функция обработки текста. TT содержит пару десятков встроеных фильтров, например:
html - заменяет < > & на &lt; &gt; &amp;
upper (lower) - преобразует символы текста в заглавные (строчные)
uri - заменяет буквы, которых не должно быть в урле, на %хх последовательности
полный список встроеных фильтров:
//www.template-toolkit.org/docs/default/Manual/Filters.html
Можно создавать свои фильтры. Подробно о фильтрах здесь:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Filters_Plugins_Macros_and_Perl


5. Плагины и Perl код в шаблонах.
ТТ содержит набор модулей - плагинов - //www.template-toolkit.org/docs/default/Manual/Plugins.html.
Чтобы использовать функциональность плагина в шаблоне, нужно включить его:
[% USE PluginName(param1, param2, ...) %].
С помощью директивы [% PERL %] в шаблон можно внедрить Perl код.
Но зачем нужны эти директивы??? Мы же собирались держать Perl отдельно, а html отдельно!!
Возможность включить Perl код в шаблон есть, но пользоваться ей не обязательно :).
Подробно:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Filters_Plugins_Macros_and_Perl


6. Обработка исключений.
Имеется в TT и механизм обработки исключений, устал я уже писать, поэтому просто дам ссылку:
//www.template-toolkit.org/docs/default/Manual/Directives.html#Exception_Handling_and_Flow_Control



Производительность — как быстро всё это рулит.

Вы, наверное, думаете, что такая мощная штука сильно тормозит. Не совсем так… Давайте посмотрим, на что тратится время при вызове нашего script.pl:
  1. компилируется script.pl и модули. Модуль Template.pm включает много других модулей (попробуйте напечатать %INC в script.pl, чтобы увидеть, насколько много), все они также компилируются.
  2. выполняется код script.pl до вызова метода process.
  3. вызван метод process. TT компилирует шаблон page.tpl. Откомпилированый шаблон предсталяет собой Perl функцию, печатающую html страничку. Объект класса Template имеет кэш откомпилированых шаблонов.
  4. Откомпилированый шаблон вызывается с параметрами, которые мы передали методу process.
У нас имеется одна система на хостинге мастерхост, использующая TT. Между мышиным кликом и отображением странички проходит <= 1сек. Часто такой производительности недостаточно. Можно съэкономить время, не выполняя при каждом запросе 1 и 3 этапы. Время в таком случае будет тратиться лишь на выполнение кода скрипта и на выполнение функции, печатающей html. Как это сделать:
  1. mod_perl - технология, позволяющая не компилировать скрипты и включаемые модули при каждом запросе — от 1 этапа мы тем самым избавляемся. Кроме того, глобальные переменные скрипта сохраняются от запроса к запросу. Для нас это хорошо тем, что можно хранить объект класса Template и следовательно кэш откомпилированых шаблонов. бобышка Так мы избавились от 3 этапа. Возможно у вашего хостера нет mod_perl. Тогда:
  2. вы делите Ваш скрипт на 2 части: часть 1, использующая Template.pm, работает постоянно отдельным процессом. часть 2, реализующая всё остальное, рождается как обычно при каждом запросе и общается с частью 1 через UNIX socet.

О чём ещё нужно сказать

Где взять
//www.template-toolkit.org/download.html#stable
//www.cpan.org/modules/by-module/Template/Template-Toolkit-2.08.tar.gz
Документация
//www.template-toolkit.org/docs/default/index.html
Кто использует
//www.openinteract.org/
//slashcode.org/
//openframe.fotango.com/
//pcmt.sf.net/



 :::::  Роман пишет 09.01.2003 @ 15:01 
Молодец Андрей, хорошая статья, давно пора было про ТТ написать, т.к тема актуальная !
 :::::   пишет 11.01.2003 @ 15:11 
А в сравнении с Mason. Сильные и слабые стороны этого решения.

Спасибо за статью.
 :::::  Ernest пишет 11.01.2003 @ 21:07 
Очень поезная и нужная статья. Класс!
 :::::  Arkady пишет 13.01.2003 @ 08:32 
Весело, не знал. А я тоже нечто подобное накропал :-] Назвал kernel. Тока там упор на MySQL и используемые без переделки перловые модули. Наша контора сайты на нём теперь лепит - получается полноценный сайт с веб-интерфейсом за 1-4 дня. Основное время уходит на нарезку. Ну и на написание новых модулей (если таких уже нет) - до 2 недель. Еси кому интересно - arkady@magmarket.ru
 :::::  Arkady пишет 13.01.2003 @ 08:52 
А вообще-то, извините, писать [пока] не имеет смысла - доки всё равно нет :(
Сайты на kernel'е можно посмотреть тут - 62.102.136.166. Из них не на kernel'е - www.fxplunge.com, mof.mgn.ru (на php nuke). Газетные порталы - наглядный пример многократного использования модулей (только чё-то клиенты-газетчики про них, похоже, забыли :) ), т.е. все газеты, "исполняются одним скриптом".
 :::::  APL пишет 16.01.2003 @ 17:52 
Я кстати тоже написал такое. Причем, что удивительно, по фунциям абсолютно аналогичный.

Можно посмотреть например на http://www.fotocenter.spb.ru
 :::::  IlyaM пишет 04.02.2003 @ 14:08 
Не хочу быть занудой, но пример в статье с XSS дыркой (http://www.cgisecurity.com/articles/xss-faq.shtml ).

По правильному нужно было проэскейпить ввод юзера которой показывается на странице. То есть page.tpl из примера должен выглядеть так:

<body>
Our varibles: [% scalar %], [% list.0 %], [% list.1 %], [% hash.key %]
Time: [% code %]
User: [% cgi.param('user') | html %]
</body>

| html - это стандартый фильтр в TT чтобы эскейпить output.
 :::::  Бурмистров Андрей пишет 04.02.2003 @ 14:46 
Вы правы.
Но дыркой я бы это не назвал: Сам себе user пусть показывает какую хочет страницу, например такую:
http://my-project.ru?user=&lt;script src=http://cool.hackers.home.ru/kill-IE.js&gt;
 :::::  IlyaM пишет 05.02.2003 @ 14:02 
Не все так просто. XSS основана на идее, что модель безопсатности в client side scripting (то есть javascript) основана на доменах. Наличие одной XSS дырки на сайте делает уязвимым *все* остальные части сайта.

Пример: у тебя есть eshop с авторизацией на куках. Кроме того, есть где то тестовый скриптик с такой дыркой на этом же домене. Соотв. "хакер" может сконстрировать url на этот тестовый скриптик который будет выдавать через javascript куку для авторизации. Единственной вопрос, как заставить юзера сходить на этот URL, для чего существет social engineering.
 :::::  Бурмистров Андрей пишет 05.02.2003 @ 14:44 
Да, пожалуй это всё же дырка :)
А как бы вы заставили юзера сходить на этот линк?
 :::::  IlyaM пишет 05.02.2003 @ 14:53 
Ну social engineering требует творческого подхода и зависит от конкретной ситуации. Представь себе, например, что у магазина есть форум для поддержки. Можно туда под видом работника магазина запостить эту ссылку и написать, что каждый кликнувший получит подарок от магазина. Или, если знать email'ы "жертв" сделать им аналогичную рассылку. Вариантов множество :)
 :::::  IlyaM пишет 05.02.2003 @ 15:01 
Кстати этот сайт похоже не без греха:

http://www.webscript.ru/profiles.php3?Author=<script>alert('XSS hole')</script>
 :::::  Бурмистров Андрей пишет 05.02.2003 @ 15:23 
:)
 :::::  NAS пишет 05.02.2003 @ 15:24 
2IlyaM: Спасибо. Поправил.
 :::::  Кока пишет 17.07.2003 @ 16:26 
Нехочу огорчать, но многие поисковые сервера не индексируют динамические страницы. И поэтому если для вас важна не легкость создания а кол-во посетителей, лучше сделать так, чтобы скрипт генерировал страницы не на выход а в файл а затем делать редирект.

 :::::  Кашалот пишет 25.07.2003 @ 00:22 
Товарищи!!! Очень заинтересовала статья. Я только начинаю писать всякие вещички и Perl очень нравится. Но вот последнее сообщение от Кока действительно огорчило. Как я понял, придется всё-таки создавать кучу страниц и отказаться от шаблонов. Можно ли как-нибудь угнаться за двумя зайцами???
 :::::  funky_dennis пишет 14.04.2004 @ 15:49 
Я юзал TT еще до того как прочитал эту статью, и особенно меня поразила фраза про быструю скорость TT - ничо подобного я у себя не встретил - фсё тормозило - просто ужас!!!
 :::::  lio пишет 11.06.2004 @ 09:49 
funky_dennis читайте документацию по TT, про то, где можно поднять производительность. Если вы используете CGI+TT скорость будет небольшая (хотя и здесь есть задел для оптимизации - предкомпиляция шаблонов), но ведь есть fastcgi и mod_perl. в комбинации с ними скорость впечатляющая.

всем рекомендую - появился сайт с переводом доки по Template Toolkit http://www.template-toolkit.ru/ - правда похоже только кусками, но некоторые интересные разделы переведены.
Имя:
Email:
URL

Введите сумму двух чисел девять и шесть (девять+шесть=?)
Запомнить мою информацию

* Html запрещен* Ваш E-mail опубликован не будет.

Copyright © 2000-2001 WebScript.Ru nas@webscript.ru
Design © 2001 by Parallax Design Studio (aka Spectator.ru)
Все торговые марки и авторские права на эту страницу принадлежат их соответствующим владельцам.
Сгенерировано за: 0.0246520