1 # Blosxom Plugin: interpolate_fancy
2 # Author: Rael Dornfest <rael@oreilly.com>,
3 # Modified by: Matthijs Kooijman <m.kooijman@student.utwente.nl>
4 # and Barijaona Ramaholimihaso
6 # Documentation: See the bottom of this file or type:
7 # perldoc interpolate_fancy
9 package interpolate_fancy;
11 # --- Configurable variables -----
13 # Do you want me to recursively interpolate into the story $title
14 # and $body? Consider and reconsider carefully before turning this
15 # on as if anyone other than you has the ability to post stories,
16 # there's a chance of some tomfoolery, exposing variables and calling
17 # actions/subroutines you might not want called.
18 # 0 = No (default), 1 = Yes
19 our $recurse_into_story = 0;
21 # --------------------------------
23 my $parsing_story = 0 ;
31 # (Recursively) resolve conditinal includes <?...>...</?>.
32 # Expects two arguments: The (part of the) template we are expanding and
33 # wether or not this part will be displayed. When this last argument is false,
34 # this part of the template will not be displayed, but is still parsed to
35 # properly resolve nested conditions.
37 # This will resolve and substitute all conditionals on the "current level".
38 # This effectively means, the routine will search for and resolve all tags it
39 # finds (with proper nesting), until it finds a closing tag (</?>) for which
40 # it has not seen the opening tag, or there are no more opening tags in the
43 # This function will return the template with all conditionals on the current
44 # level resolved. This will guarantee that if there are any opening or closing
45 # tags left in the template, the first one will be a closing tag (which can
46 # then be resolved in the upper level).
52 if ($template !~ /(.*?)<\?(\!?\$\w+(?:::\w+)*)(?:\s+?(.+?))?>(.*)/s) {
53 return $template; # No open tags, normal text
61 if ($head =~ /<\/\?>/s) {
62 return $template; # There is a closing tag before the first open tag,
66 my $displayitem = $display;
67 if ($displayitem) { # Don't care about these tests if we're not displayed anyway.
68 my $negated = ($var =~ s/^\!//); # Remove negation mark
69 if ($negated || !$attr) {
71 warn("<?!$var $attr>: Negated expression can't have attributes, ignoring them.");
73 $displayitem = eval("defined $var");
74 if ($negated) { $displayitem = !$displayitem; }
76 $displayitem = _test(eval($var), $attr);
81 $tail = _resolve_nested($tail, $displayitem);
83 if ($tail !~ /<\/\?>/s) { # Is there no closing tag?
84 warn("Invalid nesting: <?$var $attr> missing closing tag.");
88 $tail =~ s/<\/\?>//s; # Remove the closing tag
90 $tail =~ s/.*?<\/\?>//s; # Remove up to the closing tag
92 $template = $head . $tail;
103 # Halt recursive interpolation of story $body
104 # by mangling interpolation tags (to be unmangled in a moment)
105 unless ($recurse_into_story) {
106 $blosxom::title =~ s/<(\@|\??\$)/<#INTERPOLATE_FANCY_DEFANG#$1/gsi;
107 $blosxom::body =~ s/<(\@|\??\$)/<#INTERPOLATE_FANCY_DEFANG#$1/gsi;
110 my $template = shift;
112 # Backward Compatibility with core Blosxom style interpolation
113 unless ($parsing_story)
114 {$template =~ s#(?<!<)(?<!<\?)(?<!<\?!)(\$\w+(?:::\w+)*)#<$1 />#gs; };
117 # Conditional inclusion
119 # e.g. <?$var>display if defined</?>
121 # e.g. <?!$var>display if not defined</?>
123 # eq (eq), ne (ne), lt (<), gt (>), like (=~), unlike (!~)
124 # e.g. <?$var lt="123">display if $var less than 123</?>
125 $template = interpolate_fancy::_resolve_nested($template, 1);
128 # Variable expansion (unconditional, recursive)
131 while( $template =~ s/<\$([a-zA-Z?]\w+(?:::\w+)*)\s+?\/>/"defined \$$1 ? \$$1 : undef"/gsee ) { }
136 # e.g. <@plugin.subroutine arg1="a" output="no" />
137 # e.g. <@plugin.subroutine encoding="Latin1" output="yes">pass content</@>
138 $template =~ s#<\@((?:\w|::)+?)\.(\w+?)\s+?(.+?)?(?:>(.*?)<\/\@\1\.\2>|\s+?\/>)#&interpolate_fancy::_action($1,$2,$3,$4)#gse;
140 # Unmangle mangled interpolation tags in story $title and $body
141 # (by now in the template itself)
142 unless ($recurse_into_story) {
143 $template =~ s/<#INTERPOLATE_FANCY_DEFANG#(\@|\??\$)/<$1/gsi;
152 my($variable, $attr) = @_;
153 my $attributes = interpolate_fancy::_attributes($attr);
155 defined $attributes->{eq} and return $variable eq $attributes->{eq};
156 defined $attributes->{ne} and return $variable ne $attributes->{ne};
157 defined $attributes->{gt} and return $variable > $attributes->{gt};
158 defined $attributes->{lt} and return $variable < $attributes->{lt};
159 defined $attributes->{like} and return $variable =~ /$attributes->{like}/;
160 defined $attributes->{unlike} and return $variable !~ /$attributes->{unlike}/;
166 my($plugin, $action, $attr, $content) = @_;
169 $content =~ s#<\@((?:\w|::)+?)\.(\w+?)\s+?(.+?)?(?:>(.*?)<\/\@\1\.\2>|\s+?\/>)#&interpolate_fancy::_action($1,$2,$3,$4)#gse;
171 my $attributes = interpolate_fancy::_attributes($attr);
173 $blosxom::plugins{$plugin} > 0
174 and $plugin->can($action)
175 and $result = $plugin->$action($attributes, $content);
177 return $attributes->{'output'} =~ /yes/i ? $result : undef;
184 while ( $attr =~ /\b(\w+?)\s*?=\s*?(["'])(.*?)\2/g ) {
185 $attributes->{$1} = $3;
192 my($pkg, $path, $filename, $story_ref, $title_ref, $body_ref) = @_;
194 if ($recurse_into_story) {
196 $$title_ref =&$blosxom::interpolate($$title_ref);
197 $$body_ref =&$blosxom::interpolate($$body_ref);
209 Blosxom Plug-in: interpolate_fancy
213 Overrides Blosxom's far simpler to use, but more limited, default interpolate() subroutine.
215 * Include bits of text and template variable values in templates, either conditionally or unconditionally;
217 * Perform actions (i.e. call plug-in subroutines) at any point in your page, whether to act on current content and return results or not.
219 =head2 Inclusions of bits of text and variables
221 This syntax will expand to the value of the referenced variable and can be used to include dynamic content in your pages.
225 =item Unconditionally and recursively
227 e.g. include a link to the story's path using various template variables.
229 <a href="<$url /><$path />"><$path /></a>
231 Limited by the $recurse_into_story configuration directive (see the CONFIGURATION below).
233 =item Unconditionally (backward compatibility with Blosxom's standard interpolation)
235 e.g. include a link to the story's path using various template variables (non-recursive, and only inside templates).
237 <a href="$url$path">$path</a>
239 =item If the template variable has a value (i.e. is defined)
241 e.g. include a hyperlink to the story's path if it has a path (i.e. $path is defined).
243 <?$path><a href="<$url /><$path />"><$path /></a></?>
245 =item If the template variable doesn't have a value (i.e. is NOT defined)
247 e.g. include a hyperlink to home if path is undefined.
249 <?!$path><a href="<$url />">home</a></?>
251 =item If the template variable is equal (=) to a particular value
253 e.g. include "1 writeback" (singular) if the value of writeback count is 1
255 <$writeback::count /> <?$writeback::count eq="1">writeback</?>
257 =item If the template variable is not equal (!=) to a particular value
259 e.g. include "x writebacks" (plural) if the value of Writeback count (x) is not 1
261 <$writeback::count /> <?$writeback::count ne="1">writebacks</?>
263 =item If the template variable is less than (<) a particular value
265 e.g. include "no writebacks" if the value of writeback count is < 1
267 <?$writeback::count lt="1">no writebacks</?>
269 =item If the template variable is greater than (>) a particular value
271 e.g. include "oodles of writebacks" if the value of writeback count is > 50
273 <?$writeback::count gt="50">oodles of writebacks</?>
275 =item If the template variable is like (=~) a particular regular expression
277 e.g. Greet a visitor properly, depending on their courtesy title
280 <?$user::courtesy like="^(Mr\.?|Sir)$">Sir</?>
281 <?$user::courtesy like="^(Mr?s\.?|Miss)$">M'am</?>
283 =item If the template variable is unlike (!~) a particular regular expression
285 e.g. The posting is neither a film nor a book
287 <?$path unlike="/(Film|Literature)">no review</?>
293 Performs an action (i.e. calls a plug-in's subroutine) at any point in your page. Optionally passes arguments as key/value pairs stated as XML-style attributes.
297 <@thePlugin.subroutine arg1="a" arg2="bee" />
299 calls &Blosxom::Plugin::ThePlugin::subroutine( {'arg1'=>'a', 'arg2'=>'bee' } ).
301 Specify that results should be sent to the browser using the output="yes" attribute like so:
302 <@thePlugin.subroutine arg1="a" arg2="bee" output="yes" />
304 Otherwise, subroutines will still have their effect, but the results will be tossed out.
306 Content wrapped in the action call is sent as another argument to the subroutine:
308 <@thePlugin.subroutine encoding="Latin1" output="yes">
310 </@thePlugin.subroutine>
312 This calls &thePlugin::subroutine( {'encoding'=>'Latin1', 'output'=>'yes' }, "pass this content" ).
314 Actions are recursive, meaning that you can embed an action inside another, and so on and so on and so on. Actions are unfolded from the inside out, with the most deeply embedded first, second deepest second, and so forth until the outermost action is performed last.
316 Recursion is limited by the $recurse_into_story configuration directive (see the CONFIGURATION below).
320 For those of you interested in writing plugin actions or using some of the
321 more advanced features in your Blosxom blog templates, here are a couple of
326 # For the sake of this example, assume these actions live in a "myplugin" plugin
328 # This action strips HTML from its content
331 my($self, $attributes, $content) = @_;
332 $content =~ s!</?.+?>!!g;
336 # This action foreshortens its content to a length specified in the call to action's length attribute
339 my($self, $attributes, $content) = @_;
340 my $default_length = 144;
341 return substr($content, 0, $attributes->{'length'}||$default_length);
346 Calling these individually in a Blosxom flavour template looks something like:
348 The following bit of text is devoid of HTML:
350 <@myplugin.strip_html output="Yes">
351 Silly <a href="http://www.raelity.org/">me</a>, I plumb
352 <em>forgot</em> to remove the HTML.
353 </@myplugin.strip_html>
355 The following bit of text is only 20 characters in length:
357 <@myplugin.foreshorten length="20" output="Yes">This text is far longer than 20 characters on the page, but will only appear as "This text is far lon" in the
359 </@myplugin.foreshorten>
361 And in combination, stripping the HTML _before_ foreshortening (notice
362 the strip_html action is embedded inside the foreshorten action and
365 The following bit of text is only 20 characters in length and devoid of HTML:
367 <@myplugin.foreshorten length="20" output="Yes"><@myplugin.strip_html output="Yes">Silly <a href="http://www.raelity.org/">me</a>, I plumb
368 <em>forgot</em> to remove the HTML.
369 </@myplugin.strip_html>
370 </@myplugin.foreshorten>
374 Drop the interpolate_fancy plug-in into your Blosxom plugins folder.
378 None necessary; interpolate_fancy will run out of the box with no need
379 of additional configuration or fiddling on your part (caveat: see
380 BACKWARD COMPATILITY below).
382 The interpolate_fancy plugin does sport one configuration directive
383 which you should very much consider leaving alone.
385 # 0 = No (default), 1 = Yes
386 my $recurse_into_story = 0;
388 $recurse_into_story decides whether or not the interpolation engine
389 should respect and interpolate (swap for the associated value)
390 variables and actions embedded in story $title and $body themselves.
392 Off by default, you should consider and reconsider carefully before
393 turning this on as if anyone other than you has the ability to post
394 stories to your blog, there's a chance of some tomfoolery, exposing
395 variables and calling actions/subroutines you might not want called.
397 =head1 BACKWARD COMPATIBILITY
399 If you've been using core Blosxom's interpolation style
400 (e.g. $title), this plugin will provide backward compatibility,
401 requiring no template rewriting on your part.
403 If you've been using the interpolate_conditional plugin,
404 the conditional bits won't be respected by default. You should
405 run your templates through the interpolate2fancy utility
406 [http://www.blosxom.com/downloads/utilities/interpolate2fancy.py].
412 =head1 VERSION HISTORY
414 2007-09-27 : enables more than one :: in variable names
416 2007-09-13 : corrects the $recurse_into_story feature in XML flavours
418 v20061114 : fixes from Matthijs Kooijman (including properly support for nested
423 Rael Dornfest <rael@oreilly.com>, http://www.raelity.org/
424 Modified by Matthijs Kooijman <m.kooijman@student.utwente.nl>, http://katherina.student.utwente.nl/~matthijs/blog
426 This plugin is now maintained by the Blosxom Sourceforge Team,
427 <blosxom-devel@lists.sourceforge.net>.
431 Blosxom Home/Docs/Licensing: http://blosxom.sourceforge.net/
433 Blosxom Plugin Docs: http://blosxom.sourceforge.net/documentation/users/plugins.html
437 None known; please send bug reports and feedback to the Blosxom
438 development mailing list <blosxom-devel@lists.sourceforge.net>.
442 Blosxom and this Blosxom Plug-in
443 Copyright 2003, Rael Dornfest
445 Permission is hereby granted, free of charge, to any person obtaining a
446 copy of this software and associated documentation files (the "Software"),
447 to deal in the Software without restriction, including without limitation
448 the rights to use, copy, modify, merge, publish, distribute, sublicense,
449 and/or sell copies of the Software, and to permit persons to whom the
450 Software is furnished to do so, subject to the following conditions:
452 The above copyright notice and this permission notice shall be included
453 in all copies or substantial portions of the Software.
455 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
456 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
457 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
458 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
459 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
460 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
461 OTHER DEALINGS IN THE SOFTWARE.