LuckyCoinkydink/plugins/serendipity_event_textile/serendipity_event_textile.php
Ian a78094a7aa consistent plugin usage - textile
this and followup commits touches:
    use load_languiage API
    class method parenthesis "\n{\n    <code>\n}\n",
    case break switches,
    consistent boolean usage,
    append css to eventData
    and other cleanups
2016-01-26 14:08:24 +01:00

313 lines
11 KiB
PHP
Raw Blame History

<?php
if (IN_serendipity !== true) {
die ("Don't hack!");
}
@serendipity_plugin_api::load_language(dirname(__FILE__));
class serendipity_event_textile extends serendipity_event
{
var $title = PLUGIN_EVENT_TEXTILE_NAME;
function introspect(&$propbag)
{
global $serendipity;
$propbag->add('name', PLUGIN_EVENT_TEXTILE_NAME);
$propbag->add('description', PLUGIN_EVENT_TEXTILE_DESC);
$propbag->add('stackable', false);
$propbag->add('author', 'Serendipity Team', 'Lars Strojny');
$propbag->add('version', '1.8.3');
$propbag->add('requirements', array(
'serendipity' => '1.6',
'smarty' => '2.6.7',
'php' => '5.2.0'
));
$propbag->add('cachable_events', array('frontend_display' => true));
$propbag->add('event_hooks', array('frontend_display' => true, 'frontend_comment' => true));
$propbag->add('groups', array('MARKUP'));
$propbag->add('preserve_tags',
array(
'php',
'output',
'name'
)
);
$this->markup_elements = array(
array(
'name' => 'ENTRY_BODY',
'element' => 'body',
),
array(
'name' => 'EXTENDED_BODY',
'element' => 'extended',
),
array(
'name' => 'COMMENT',
'element' => 'comment',
),
array(
'name' => 'HTML_NUGGET',
'element' => 'html_nugget',
)
);
$conf_array = array();
foreach($this->markup_elements as $element) {
$conf_array[] = $element['name'];
}
$conf_array[] = 'textile_version';
$conf_array[] = 'textile_doctype';
// todo $conf_array[] = 'textile_restrict_comments';
$conf_array[] = 'unescape';
$propbag->add('configuration', $conf_array);
}
function generate_content(&$title)
{
$title = $this->title;
}
function install()
{
serendipity_plugin_api::hook_event('backend_cache_entries', $this->title);
}
function uninstall(&$propbag)
{
serendipity_plugin_api::hook_event('backend_cache_purge', $this->title);
serendipity_plugin_api::hook_event('backend_cache_entries', $this->title);
}
function example()
{
return '<p>'.PLUGIN_EVENT_TEXTILE_EXAMPLE_NOTE.'</p>';
}
function introspect_config_item($name, &$propbag)
{
switch($name) {
case 'textile_version':
$propbag->add('type', 'radio');
$propbag->add('name', PLUGIN_EVENT_TEXTILE_VERSION);
$propbag->add('description', PLUGIN_EVENT_TEXTILE_VERSION_DESCRIPTION);
$propbag->add('radio', array(
'value' => array(1, 2, 3),
'desc' => array('1.0', '2.0', '3.0'),
));
$propbag->add('default', 3);
break;
case 'textile_doctype':
$propbag->add('type', 'boolean');
$propbag->add('name', PLUGIN_EVENT_TEXTILE_DOCTYPE);
$propbag->add('description', PLUGIN_EVENT_TEXTILE_DOCTYPE_DESC);
$propbag->add('default', 'false');
break;
case 'textile_restrict_comments':
$propbag->add('type', 'boolean');
$propbag->add('name', PLUGIN_EVENT_TEXTILE_RESTRICTCOMMENTS);
$propbag->add('description', PLUGIN_EVENT_TEXTILE_RESTRICTCOMMENTS_DESC);
$propbag->add('default', 'true');
break;
case 'unescape':
$propbag->add('type', 'boolean');
$propbag->add('name', PLUGIN_EVENT_TEXTILE_UNESCAPE);
$propbag->add('description', PLUGIN_EVENT_TEXTILE_UNESCAPE_DESC);
$propbag->add('default', 'false');
break;
default:
$propbag->add('type', 'boolean');
$propbag->add('name', constant($name));
$propbag->add('description', sprintf(APPLY_MARKUP_TO, constant($name)));
$propbag->add('default', 'true');
break;
}
return true;
}
function event_hook($event, &$bag, &$eventData, $addData = null)
{
global $serendipity;
$hooks = &$bag->get('event_hooks');
if (isset($hooks[$event])) {
switch($event) {
case 'frontend_display':
$preserve_tags = &$bag->get('preserve_tags');
foreach ($this->markup_elements as $temp) {
if (serendipity_db_bool($this->get_config($temp['name'], 'true'))) {
if ($eventData['properties']['ep_disable_markup_' . $this->instance] ||
isset($serendipity['POST']['properties']['disable_markup_' . $this->instance])) {
continue;
}
$element = $temp['element'];
/* find all the tags and store them in $blocks */
$blocks = array();
foreach($preserve_tags as $tag) {
if (preg_match_all('/(<'.$tag.'[^>]?>.*<\/'.$tag.'>)/msU', $eventData[$element], $matches )) {
foreach($matches[1] as $match) {
$blocks[] = $match;
}
}
}
/* replace all the blocks with some code */
foreach($blocks as $id=>$block) {
$eventData[$element] = str_replace($block, '@BLOCK::'.$id.'@', $eventData[$element]);
}
/* textile it */
if (serendipity_db_bool($this->get_config('unescape'))) {
$eventData[$element] = str_replace('&quot;', '"', $eventData[$element]);
}
$eventData[$element] = $this->textile($eventData[$element]);
/* each block will now be "<code>BLOCK::2</code>"
* so look for those place holders and replace
* them with the original blocks */
if (preg_match_all('/<code>BLOCK::(\d+)<\/code>/', $eventData[$element], $matches )) {
foreach($matches[1] as $key=>$match) {
$eventData[$element] = str_replace($matches[0][$key], $blocks[$match], $eventData[$element]);
}
}
/* post-process each block */
foreach($preserve_tags as $tag) {
$method = '_process_tag_' . $tag;
if (method_exists($this,$method)) {
if (preg_match_all('/<'.$tag.'[^>]?>(.*)<\/'.$tag.'>/msU', $eventData[$element], $matches )) {
foreach($matches[1] as $key=>$match) {
$eventData[$element] = str_replace($matches[0][$key], $this->$method($match), $eventData[$element]);
}
}
}
}
/* end textile processing */
}
}
break;
case 'frontend_comment':
if (serendipity_db_bool($this->get_config('COMMENT', 'true'))) {
$url = $this->get_config('textile_version') == 1
? 'http://www.textism.com/tools/textile/'
: 'http://txstyle.org/article/43/a-short-introduction';
echo '<div class="serendipity_commentDirection serendipity_comment_textile">' . sprintf(PLUGIN_EVENT_TEXTILE_TRANSFORM, $url) . '</div>';
}
break;
default:
return false;
}
return true;
} else {
return false;
}
}
function _process_tag_php($text)
{
$code = "<?php\n" . trim($text) . "\n?>";
# Using OB, as highlight_string() only supports
# returning the result from 4.2.0
ob_start();
highlight_string($code);
$highlighted = ob_get_contents();
ob_end_clean();
# Fix output to use CSS classes and wrap well
$highlighted = '<p><div class="phpcode">' . str_replace(
array(
'&nbsp;',
'<br />',
'<font color="',
'</font>',
"\n ",
'<27> '
),
array(
' ',
"<br />\n",
'<span class="',
'</span>',
"\n&#160;",
'&#160; '
),
$highlighted
) . '</div></p>';
return $highlighted;
}
function _process_tag_output($text)
{
return '<p><pre class="output">' . $text . '</pre></p>';
}
function _process_tag_name($text)
{
return '<a name="'. $text . '"></a>';
}
function textile($string)
{
switch($this->get_config('textile_version')) {
case 3:
if (version_compare(PHP_VERSION, '5.3.0') >= 0) {
require_once S9Y_INCLUDE_PATH . 'plugins/serendipity_event_textile/lib3/src/Netcarver/Textile/Parser.php';
require_once S9Y_INCLUDE_PATH . 'plugins/serendipity_event_textile/lib3/src/Netcarver/Textile/DataBag.php';
require_once S9Y_INCLUDE_PATH . 'plugins/serendipity_event_textile/lib3/src/Netcarver/Textile/Tag.php';
include 'textile_namespace.inc.php'; // PHP 5.2 compat
// todo check for user-supplied output to restrict
# return $textile->textileRestricted($string);
if (is_object($textile)) return $textile->textileThis($string);
} else {
trigger_error(' Textile lib3 needs at least PHP 5.3.0 running. Update your PHP version or use lib2 instead.', E_USER_WARNING);
}
break;
case 2:
require_once S9Y_INCLUDE_PATH . 'plugins/serendipity_event_textile/lib2/classTextile.php';
$textile = new Textile();
return $textile->textileThis($string);
break;
case 1:
require_once S9Y_INCLUDE_PATH . 'plugins/serendipity_event_textile/lib1/textile.php';
return textile($string);
break;
}
}
}
/* vim: set sts=4 ts=4 expandtab : */
?>