enhance nl2br plugin to also use p tags
This commit is contained in:
Garvin Hicking
parent
742df8af16
commit
b6b3ee78bc
@ -3,6 +3,8 @@
|
||||
Version 1.5 ()
|
||||
------------------------------------------------------------------------
|
||||
|
||||
* Enhanced nl2br plugin to also use <p> tags, by onli
|
||||
|
||||
* Added possibility for templates to register a central function
|
||||
serendipity_plugin_api_event_hook() and
|
||||
serendipity_plugin_api_pre_event_hook() that can be used to
|
||||
|
||||
@ -3,4 +3,6 @@
|
||||
@define('PLUGIN_EVENT_NL2BR_NAME', 'Textformatierung: NL2BR');
|
||||
@define('PLUGIN_EVENT_NL2BR_DESC', 'Konvertiert Zeilenumbrüche zu HTML');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS', 'Eine Liste von HTML-Tags, innerhalb derer keine Umbrüche konvertiert werden');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS_DESC', 'Konfigurationsvorschlag: "code,pre,geshi,textarea". Trennen Sie mehrere HTML-Tags mit Komma. Hinweis: Die eingegebenen Tags sind reguläre Ausdrücke!');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS_DESC', 'Konfigurationsvorschlag: "code,pre,geshi,textarea". Trennen Sie mehrere HTML-Tags mit Komma. Hinweis: Die eingegebenen Tags sind reguläre Ausdrücke!');
|
||||
@define('PLUGIN_EVENT_NL2BR_PTAGS', 'Nutze P-Tags');
|
||||
@define('PLUGIN_EVENT_NL2BR_PTAGS_DESC', 'Setze statt br-Tags p-Tags ein.');
|
||||
|
||||
@ -3,4 +3,6 @@
|
||||
@define('PLUGIN_EVENT_NL2BR_NAME', 'Textformatierung: NL2BR');
|
||||
@define('PLUGIN_EVENT_NL2BR_DESC', 'Konvertiert Zeilenumbrüche zu HTML');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS', 'Eine Liste von HTML-Tags, innerhalb derer keine Umbrüche konvertiert werden');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS_DESC', 'Konfigurationsvorschlag: "code,pre,geshi,textarea". Trennen Sie mehrere HTML-Tags mit Komma. Hinweis: Die eingegebenen Tags sind reguläre Ausdrücke!');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS_DESC', 'Konfigurationsvorschlag: "code,pre,geshi,textarea". Trennen Sie mehrere HTML-Tags mit Komma. Hinweis: Die eingegebenen Tags sind reguläre Ausdrücke!');
|
||||
@define('PLUGIN_EVENT_NL2BR_PTAGS', 'Nutze P-Tags');
|
||||
@define('PLUGIN_EVENT_NL2BR_PTAGS_DESC', 'Setze statt br-Tags p-Tags ein.');
|
||||
|
||||
@ -10,4 +10,6 @@
|
||||
@define('PLUGIN_EVENT_NL2BR_DESC', 'Convert newlines to BR tags');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS', 'A list of HTML-tags where no breaks shall be converted');
|
||||
@define('PLUGIN_EVENT_NL2BR_ISOLATE_TAGS_DESC', 'Suggestion: "code,pre,geshi,textarea". Seperate multiple tags with a comma. Hint: The entered tags are evaluated as regular expressions.');
|
||||
@define('PLUGIN_EVENT_NL2BR_PTAGS', 'Use P-Tags');
|
||||
@define('PLUGIN_EVENT_NL2BR_PTAGS_DESC', 'Insert p-tags instead of br.');
|
||||
?>
|
||||
|
||||
@ -25,14 +25,16 @@ class serendipity_event_nl2br extends serendipity_event
|
||||
$propbag->add('description', PLUGIN_EVENT_NL2BR_DESC);
|
||||
$propbag->add('stackable', false);
|
||||
$propbag->add('author', 'Serendipity Team');
|
||||
$propbag->add('version', '1.7');
|
||||
$propbag->add('version', '2.0');
|
||||
$propbag->add('requirements', array(
|
||||
'serendipity' => '0.8',
|
||||
'smarty' => '2.6.7',
|
||||
'php' => '4.1.0'
|
||||
));
|
||||
$propbag->add('cachable_events', array('frontend_display' => true));
|
||||
$propbag->add('event_hooks', array('frontend_display' => true));
|
||||
$propbag->add('event_hooks', array('frontend_display' => true,
|
||||
'css' => true)
|
||||
);
|
||||
$propbag->add('groups', array('MARKUP'));
|
||||
|
||||
$this->markup_elements = array(
|
||||
@ -54,8 +56,7 @@ class serendipity_event_nl2br extends serendipity_event
|
||||
)
|
||||
);
|
||||
|
||||
$conf_array = array();
|
||||
$conf_array[] = 'isolate';
|
||||
$conf_array = array('isolate', 'p_tags');
|
||||
foreach($this->markup_elements as $element) {
|
||||
$conf_array[] = $element['name'];
|
||||
}
|
||||
@ -85,6 +86,13 @@ class serendipity_event_nl2br extends serendipity_event
|
||||
$propbag->add('default', '');
|
||||
break;
|
||||
|
||||
case 'p_tags':
|
||||
$propbag->add('type', 'boolean');
|
||||
$propbag->add('name', PLUGIN_EVENT_NL2BR_PTAGS);
|
||||
$propbag->add('description', PLUGIN_EVENT_NL2BR_PTAGS_DESC);
|
||||
$propbag->add('default', 'false');
|
||||
break;
|
||||
|
||||
default:
|
||||
$propbag->add('type', 'boolean');
|
||||
$propbag->add('name', constant($name));
|
||||
@ -109,10 +117,15 @@ class serendipity_event_nl2br extends serendipity_event
|
||||
function event_hook($event, &$bag, &$eventData) {
|
||||
global $serendipity;
|
||||
static $isolate = null;
|
||||
static $p_tags = null;
|
||||
global $_buf;
|
||||
|
||||
$hooks = &$bag->get('event_hooks');
|
||||
|
||||
if ($p_tags === null) {
|
||||
$p_tags = serendipity_db_bool($this->get_config('p_tags'));
|
||||
}
|
||||
|
||||
if (isset($hooks[$event])) {
|
||||
switch($event) {
|
||||
case 'frontend_display':
|
||||
@ -139,18 +152,37 @@ class serendipity_event_nl2br extends serendipity_event
|
||||
!isset($serendipity['POST']['properties']['ep_no_nl2br'])) {
|
||||
|
||||
$element = $temp['element'];
|
||||
if ($isolate) {
|
||||
$eventData[$element] = $this->isolate($eventData[$element], '~[<\[](' . implode('|', $isolate) . ').*?[>\]].*?[<\[]/\1[>\]]~si');
|
||||
$eventData[$element] = nl2br($eventData[$element]);
|
||||
$eventData[$element] = $this->restore($eventData[$element]);
|
||||
if ($p_tags) {
|
||||
$eventData[$element] = $this->nl2p($eventData[$element]);
|
||||
} else if ($isolate) {
|
||||
$eventData[$element] = $this->isolate($eventData[$element], '~[<\[](' . implode('|', $isolate) . ').*?[>\]].*?[<\[]/\1[>\]]~si');
|
||||
$eventData[$element] = nl2br($eventData[$element]);
|
||||
$eventData[$element] = $this->restore($eventData[$element]);
|
||||
} else {
|
||||
$eventData[$element] = nl2br($eventData[$element]);
|
||||
$eventData[$element] = nl2br($eventData[$element]);
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
break;
|
||||
|
||||
case 'css':
|
||||
?>
|
||||
|
||||
p.whiteline {
|
||||
margin-top: 0em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
p.break {
|
||||
margin-top: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
<?php
|
||||
return true;
|
||||
break;
|
||||
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
@ -159,6 +191,207 @@ class serendipity_event_nl2br extends serendipity_event
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/* Insert <p class="whiteline" at paragraphs ending with two newlines
|
||||
* Insert <p class="break" at paragraphs ending with one nl
|
||||
* @param string text
|
||||
* @param boolean complex operations (not necessary when text is flat)
|
||||
* @return string
|
||||
* */
|
||||
function nl2p(&$text, $complex=true) {
|
||||
if (empty($text)) {
|
||||
return $text;
|
||||
}
|
||||
//Standardize line endings:
|
||||
//DOS to Unix and Mac to Unix
|
||||
$text = str_replace(array("\r\n", "\r"), "\n", $text);
|
||||
$text = str_split($text);
|
||||
|
||||
$big_p = '<p class="whiteline">';
|
||||
$small_p = '<p class="break">';
|
||||
|
||||
$insert = true;
|
||||
$i = count($text);
|
||||
$whiteline = false;
|
||||
if ($text[$i-1] == "\n") {
|
||||
//prevent unnexessary p-tag at the end
|
||||
unset($text[$i-1]);
|
||||
}
|
||||
|
||||
//main operation: convert \n to big_p and small_p
|
||||
while ($i > 0) {
|
||||
if ($insert) {
|
||||
$i = $this->next_nl_block($i, $text);
|
||||
if ($i == 0) {
|
||||
//prevent replacing of first character
|
||||
break;
|
||||
}
|
||||
if ($whiteline == true) {
|
||||
$text[$i] = '</p>' . $big_p;
|
||||
} else {
|
||||
$text[$i] = '</p>' . $small_p;
|
||||
}
|
||||
$whiteline = false;
|
||||
$insert = false;
|
||||
} else {
|
||||
if ($text[$i-1] === "\n") {
|
||||
//newline is follower of a newline
|
||||
$whiteline = true;
|
||||
}
|
||||
$insert = true;
|
||||
}
|
||||
}
|
||||
if ($whiteline) {
|
||||
$start_tag = $big_p;
|
||||
} else {
|
||||
$start_tag = $small_p;
|
||||
}
|
||||
if ($complex) {
|
||||
$textstring = $this->tidy_block_elements($text);
|
||||
$textstring = $this->formate_block_elements($textstring);
|
||||
$textstring = $this->isolate_block_elements($textstring);
|
||||
$textstring = $start_tag . $textstring . '</p>';
|
||||
return $this->clean_code($textstring);
|
||||
}
|
||||
return $start_tag . implode($text) . '</p>';
|
||||
}
|
||||
|
||||
/*
|
||||
* Remove unnecessary paragraphs
|
||||
* Unnecessary are those which start and end immediately.
|
||||
* They only get created by isolate_block_elements
|
||||
* @param mixed text
|
||||
* @return string
|
||||
* */
|
||||
function clean_code ($text) {
|
||||
if (is_array($text)) {
|
||||
$text = implode($text);
|
||||
}
|
||||
return str_replace(array('<p class="whiteline"></p>','<p class="break"></p>', '<p></p>'),"", $text);
|
||||
}
|
||||
|
||||
function purge_p($text) {
|
||||
$text = str_replace('</p>', "", $text);
|
||||
return str_replace(array('<p class="whiteline">','<p class="break">', '<p>', '</p>'),"\n", $text);
|
||||
}
|
||||
|
||||
/*
|
||||
* Use nl2p on text within blockelements, useful e.g. with blockquotes
|
||||
* @param array text
|
||||
* @return string
|
||||
* */
|
||||
function formate_block_elements($textstring) {
|
||||
$block_elements = array('<blockquote');
|
||||
foreach ($block_elements as $start_tag) {
|
||||
$end_tag = $this->end_tags($start_tag);
|
||||
//first see if block-element really exists
|
||||
$start_tag_position = strpos($textstring, $start_tag);
|
||||
while ($start_tag_position !== false) {
|
||||
$start_tag_end = strpos($textstring, '>', $start_tag_position)+1;
|
||||
$blocktext = $this->get_string_till($textstring, $end_tag, $start_tag_end);
|
||||
$blocktext_length = strlen($blocktext);
|
||||
$formatted_blocktext = $this->nl2p($blocktext);
|
||||
//insert formatted_blocktext into old blockelement
|
||||
$textstring = substr_replace($textstring, $formatted_blocktext, $start_tag_end, $blocktext_length);
|
||||
|
||||
//next blockelement
|
||||
$start_tag_position = strpos($textstring, $start_tag, $start_tag_end+strlen($formatted_blocktext));
|
||||
}
|
||||
}
|
||||
return $textstring;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure none of these block_elements are within a <p>
|
||||
* @param string text
|
||||
* @return string
|
||||
* */
|
||||
function isolate_block_elements($textstring) {
|
||||
$block_elements = array('<table','<ul','<ol','<pre', '<dir', '<dl',
|
||||
'<h1', '<h2', '<h3', '<h4', '<h5', '<h6',
|
||||
'<menu', '<blockquote');
|
||||
$block_elements_amount = count($block_elements);
|
||||
|
||||
for($i=0;$i<$block_elements_amount;$i++) {
|
||||
$start_tag = $block_elements[$i];
|
||||
//first see if block-element really exists
|
||||
$tag_position = strpos($textstring, $start_tag);
|
||||
if ($tag_position === false) {
|
||||
continue;
|
||||
} else {
|
||||
$end_tag = $this->end_tags($start_tag);
|
||||
$textstring = str_replace("$start_tag", "</p>$start_tag", $textstring);
|
||||
$textstring = str_replace("$end_tag", "$end_tag<p>", $textstring);
|
||||
}
|
||||
}
|
||||
return $textstring;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove all <p>-tags from block-elements
|
||||
* Note: Walking from left to right
|
||||
* @param array text
|
||||
* @return string
|
||||
* */
|
||||
function tidy_block_elements($text) {
|
||||
$remove = false;
|
||||
$textstring = implode($text);
|
||||
$block_elements = array('<table','<ul','<ol','<pre', '<dir', '<dl',
|
||||
'<h1', '<h2', '<h3', '<h4', '<h5', '<h6',
|
||||
'<menu', '<blockquote');
|
||||
foreach ($block_elements as $start_tag) {
|
||||
$end_tag = $this->end_tags($start_tag);
|
||||
//first see if block-element really exists
|
||||
$start_tag_position = strpos($textstring, $start_tag);
|
||||
while ($start_tag_position !== false) {
|
||||
$start_tag_end = strpos($textstring, '>', $start_tag_position)+1;
|
||||
$blocktext = $this->get_string_till($textstring, $end_tag, $start_tag_end);
|
||||
$blocktext_length = strlen($blocktext);
|
||||
$formatted_blocktext = $this->purge_p($blocktext);
|
||||
//insert formatted_blocktext into old blockelement
|
||||
$textstring = substr_replace($textstring, $formatted_blocktext, $start_tag_end, $blocktext_length);
|
||||
|
||||
//next blockelement
|
||||
$start_tag_position = strpos($textstring, $start_tag, $start_tag_end+strlen($formatted_blocktext));
|
||||
}
|
||||
}
|
||||
return $textstring;
|
||||
}
|
||||
|
||||
function get_string_till($text, $end_tag, $offset=0){
|
||||
if (strpos($text, $end_tag, $offset) === false) {
|
||||
return "";
|
||||
}
|
||||
$len = strpos($text, $end_tag, $offset) - $offset;
|
||||
return substr($text, $offset, $len);
|
||||
}
|
||||
|
||||
/*
|
||||
* Return corresponding end-tag: <p -> </p>
|
||||
*/
|
||||
function end_tags($start_tag) {
|
||||
return str_replace("<", "</", $start_tag).">";
|
||||
}
|
||||
|
||||
/**
|
||||
* Find next newline seperated by text from current position
|
||||
* @param int start
|
||||
* $param array text
|
||||
*/
|
||||
function next_nl_block($i, $text) {
|
||||
$skipped = false;
|
||||
for ($i--; $i>0; $i-- ) {
|
||||
if (!$skipped){
|
||||
//see if you skipped over a non-newline (heading to the next block)
|
||||
if (strpos($text[$i], "\n") === false) {
|
||||
$skipped = true;
|
||||
}
|
||||
}else if (strpos($text[$i], "\n") !== false) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return $i;
|
||||
}
|
||||
}
|
||||
|
||||
/* vim: set sts=4 ts=4 expandtab : */
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user