<?php

/**

* This file implements the Markdown plugin for b2evolution

*

* Markdown

*

* b2evolution - {@link http://b2evolution.net/}

* Released under GNU GPL License - {@link http://b2evolution.net/about/gnu-gpl-license}

* @copyright (c)2003-2015 by Francois Planque - {@link http://fplanque.com/}

*

* @package plugins

* @ignore

*/

if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );

/**

* @package plugins

*/

class markdown_plugin extends Plugin

{

var $code = 'b2evMark';

var $name = 'Markdown';

var $priority = 20;

var $version = '5.0.0';

var $group = 'rendering';

var $short_desc;

var $long_desc;

var $help_topic = 'markdown-plugin';

var $number_of_installs = 1;

/**

* Init

*/

function PluginInit( & $params )

{

require_once( dirname( __FILE__ ).'/_parsedown.inc.php' );

$this->short_desc = T_('Markdown');

$this->long_desc = T_('Accepted formats:<br />

# h1<br />

## h2<br />

### h3<br />

#### h4<br />

##### h5<br />

###### h6<br />

--- (horizontal rule)<br />

* * * (horizontal rule)<br />

- - - - (horizontal rule)<br />

`code spans`<br />

> blockquote');

}

/**

* Define here default collection/blog settings that are to be made available in the backoffice.

*

* @param array Associative array of parameters.

* @return array See {@link Plugin::get_coll_setting_definitions()}.

*/

function get_coll_setting_definitions( & $params )

{

$default_params = array_merge( $params, array(

'default_comment_rendering' => 'never',

'default_post_rendering' => 'opt-in'

) );

return array_merge( parent::get_coll_setting_definitions( $default_params ),

array(

'links' => array(

'label' => T_( 'Links' ),

'type' => 'checkbox',

'note' => T_( 'Detect and convert markdown link markup.' ),

'defaultvalue' => 0,

),

'images' => array(

'label' => T_( 'Images' ),

'type' => 'checkbox',

'note' => T_( 'Detect and convert markdown image markup.' ),

'defaultvalue' => 0,

),

'text_styles' => array(

'label' => T_( 'Italic & Bold styles' ),

'type' => 'checkbox',

'note' => T_( 'Detect and convert markdown italics and bold markup.' ),

'defaultvalue' => 0,

),

'min_h_level' => array(

'label' => T_( 'Top Heading Level' ),

'type' => 'integer',

'size' => 1,

'maxlength' => 1,

'note' => T_( 'This plugin will adjust headings so they always start at the level you want: 1 for &lt;H1&gt;, 2 for &lt;H2&gt;, etc.' ),

'defaultvalue' => 1,

'valid_range' => array(

'min' => 1, // from <h1>

'max' => 6, // to <h6>

),

),

)

);

}

/**

* Define here default message settings that are to be made available in the backoffice.

*

* @param array Associative array of parameters.

* @return array See {@link Plugin::GetDefaultSettings()}.

*/

function get_msg_setting_definitions( & $params )

{

// set params to allow rendering for messages by default

$default_params = array_merge( $params, array( 'default_msg_rendering' => 'opt-in' ) );

return parent::get_msg_setting_definitions( $default_params );

}

/**

* Perform rendering

*

* @param array Associative array of parameters

* 'data': the data (by reference). You probably want to modify this.

* 'format': see {@link format_to_output()}. Only 'htmlbody' and 'entityencoded' will arrive here.

* @return boolean true if we can render something for the required output format

*/

function RenderItemAsHtml( & $params )

{

$content = & $params['data'];

if( !empty( $params['Item'] ) )

{ // Get Item from params

$Item = & $params['Item'];

}

elseif( !empty( $params['Comment'] ) )

{ // Get Item from Comment

$Comment = & $params['Comment'];

$Item = & $Comment->get_Item();

}

if( ! empty( $Item ) )

{ // We are rendering Item or Comment now, Get the settings depending on Blog

$item_Blog = & $Item->get_Blog();

$text_styles_enabled = $this->get_coll_setting( 'text_styles', $item_Blog );

$links_enabled = $this->get_coll_setting( 'links', $item_Blog );

$images_enabled = $this->get_coll_setting( 'images', $item_Blog );

$min_h_level = $this->get_coll_setting( 'min_h_level', $item_Blog );

}

elseif( ! empty( $params['Message'] ) )

{ // We are rendering Message now, Use FALSE by default because we don't have the settings

$text_styles_enabled = false;

$links_enabled = false;

$images_enabled = false;

$min_h_level = 1; // Use default value

}

else

{ // Unknown call, Don't render this case

return;

}

// Init parser class with blog settings

$Parsedown = Parsedown::instance();

$Parsedown->parse_font_styles = $text_styles_enabled;

$Parsedown->parse_links = $links_enabled;

$Parsedown->parse_images = $images_enabled;

$Parsedown->min_h_level = $min_h_level;

// Parse markdown code to HTML

if( stristr( $content, '<code' ) !== false || stristr( $content, '<pre' ) !== false )

{ // Call replace_content() on everything outside code/pre:

$content = callback_on_non_matching_blocks( $content,

'~<(code|pre)[^>]*>.*?</\1>~is',

array( $Parsedown, 'parse' ) );

}

else

{ // No code/pre blocks, replace on the whole thing

$content = $Parsedown->parse( $content );

}

return true;

}

/**

* Event handler: Defines blog settings by its kind. Use {@link get_collection_kinds()} to return

* an array of available blog kinds and their names.

* Define new blog kinds in {@link Plugin::GetCollectionKinds()} method of your plugin.

*

* Note: You have to change $params['Blog'] (which gets passed by reference).

*

* @param array Associative array of parameters

* - 'Blog': created Blog (by reference)

* - 'kind': the kind of created blog (by reference)

*/

function InitCollectionKinds( & $params )

{

if( empty( $params['Blog'] ) || empty( $params['kind'] ) )

{ // Invalid data, Exit here

return;

}

switch( $params['kind'] )

{

case 'forum':

case 'manual':

$params['Blog']->set_setting( 'plugin'.$this->ID.'_coll_apply_rendering', 'opt-out' );

$params['Blog']->set_setting( 'plugin'.$this->ID.'_coll_apply_comment_rendering', 'opt-out' );

$params['Blog']->set_setting( 'plugin'.$this->ID.'_images', '1' );

$params['Blog']->set_setting( 'plugin'.$this->ID.'_links', '1' );

break;

}

}

/**

* Display a toolbar

*

* @todo dh> This seems to be a lot of Javascript. Please try exporting it in a

* (dynamically created) .js src file. Then we could use cache headers

* to let the browser cache it.

* @param array Associative array of parameters

* @return boolean did we display a toolbar?

*/

function AdminDisplayToolbar( & $params )

{

if( ! empty( $params['Item'] ) )

{ // Item is set, get Blog from post

$edited_Item = & $params['Item'];

$Blog = & $edited_Item->get_Blog();

}

if( empty( $Blog ) )

{ // Item is not set, try global Blog

global $Blog;

if( empty( $Blog ) )

{ // We can't get a Blog, this way "apply_rendering" plugin collection setting is not available

return false;

}

}

$coll_setting_name = ( $params['target_type'] == 'Comment' ) ? 'coll_apply_comment_rendering' : 'coll_apply_rendering';

$apply_rendering = $this->get_coll_setting( $coll_setting_name, $Blog );

if( empty( $apply_rendering ) || $apply_rendering == 'never' )

{ // Plugin is not enabled for current case, so don't display a toolbar:

return false;

}

// Print toolbar on screen

return $this->DisplayCodeToolbar( $Blog );

}

/**

* Event handler: Called when displaying editor toolbars.

*

* @param array Associative array of parameters

* @return boolean did we display a toolbar?

*/

function DisplayCommentToolbar( & $params )

{

if( ! empty( $params['Comment'] ) )

{ // Comment is set, get Blog from comment

$Comment = & $params['Comment'];

if( !empty( $Comment->item_ID ) )

{

$comment_Item = & $Comment->get_Item();

$Blog = & $comment_Item->get_Blog();

}

}

if( empty( $Blog ) )

{ // Comment is not set, try global Blog

global $Blog;

if( empty( $Blog ) )

{ // We can't get a Blog, this way "apply_comment_rendering" plugin collection setting is not available

return false;

}

}

$apply_rendering = $this->get_coll_setting( 'coll_apply_comment_rendering', $Blog );

if( empty( $apply_rendering ) || $apply_rendering == 'never' )

{ // Plugin is not enabled for current case, so don't display a toolbar:

return false;

}

// Print toolbar on screen

return $this->DisplayCodeToolbar( $Blog );

}

/**

* Event handler: Called when displaying editor toolbars for message.

*

* @param array Associative array of parameters

* @return boolean did we display a toolbar?

*/

function DisplayMessageToolbar( & $params )

{

$apply_rendering = $this->get_msg_setting( 'msg_apply_rendering' );

if( ! empty( $apply_rendering ) && $apply_rendering != 'never' )

{ // Print toolbar on screen

return $this->DisplayCodeToolbar( NULL, $params );

}

return false;

}

/**

* Display Toolbar

*

* @param object Blog

*/

function DisplayCodeToolbar( $Blog = NULL, $params = array() )

{

global $Hit;

if( $Hit->is_lynx() )

{ // let's deactivate toolbar on Lynx, because they don't work there.

return false;

}

if( empty( $Blog ) )

{ // Use FALSE by default because we don't have the settings for Message

$text_styles_enabled = false;

$links_enabled = false;

$images_enabled = false;

}

else

{ // Get plugin setting values depending on Blog

$text_styles_enabled = $this->get_coll_setting( 'text_styles', $Blog );

$links_enabled = $this->get_coll_setting( 'links', $Blog );

$images_enabled = $this->get_coll_setting( 'images', $Blog );

}

// Load js to work with textarea

require_js( 'functions.js', 'blog', true, true );

?><script type="text/javascript">

//<![CDATA[

var markdown_btns = new Array();

var markdown_open_tags = new Array();

function markdown_btn( id, text, title, tag_start, tag_end, style, open, grp_pos )

{

this.id = id; // used to name the toolbar button

this.text = text; // label on button

this.title = title; // title

this.tag_start = tag_start; // open tag

this.tag_end = tag_end; // close tag

this.style = style; // style on button

this.open = open; // set to -1 if tag does not need to be closed

this.grp_pos = grp_pos; // position in the group, e.g. 'last'

}

<?php

if( $text_styles_enabled )

{ // Show thess buttons only when plugin setting "Italic & Bold styles" is enabled ?>

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_bold','bold', '<?php echo TS_('Bold') ?>',

'**','**',

'font-weight:bold'

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_italic','italic', '<?php echo TS_('Italic') ?>',

'*','*',

'font-style:italic', -1, 'last'

);

<?php

}

if( $links_enabled )

{ // Show this button only when plugin setting "Links" is enabled ?>

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_link', 'link','<?php echo TS_('Link') ?>',

'','',

'text-decoration:underline', -1<?php echo ! $images_enabled ? ', \'last\'' : '' ?>

);

<?php

}

if( $images_enabled )

{ // Show this button only when plugin setting "Images" is enabled ?>

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_img', 'img','<?php echo TS_('Image') ?>',

'','',

'', -1, 'last'

);

<?php

} ?>

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_h1','H1', '<?php echo TS_('Header 1') ?>',

'\n# ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_h1','H2', '<?php echo TS_('Header 2') ?>',

'\n## ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_h1','H3', '<?php echo TS_('Header 3') ?>',

'\n### ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_h1','H4', '<?php echo TS_('Header 4') ?>',

'\n#### ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_h1','H5', '<?php echo TS_('Header 5') ?>',

'\n##### ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_h1','H6', '<?php echo TS_('Header 6') ?>',

'\n###### ','',

'', -1, 'last'

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_li','li', '<?php echo TS_('Unordered list item') ?>',

'\n* ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_ol','ol', '<?php echo TS_('Ordered list item') ?>',

'\n1. ','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_li','blockquote', '<?php echo TS_('Blockquote') ?>',

'\n> ','',

'', -1, 'last'

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_codespan','codespan', '<?php echo TS_('Codespan') ?>',

'`','`',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_preblock','preblock', '<?php echo TS_('Preformatted code block') ?>',

'\n\t','',

'', -1, 'last'

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_codeblock','codeblock', '<?php echo TS_('Highlighted code block') ?>',

'\n```\n','\n```\n',

'', -1, 'last'

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_hr','hr', '<?php echo TS_('Horizontal Rule') ?>',

'\n---\n','',

'', -1

);

markdown_btns[markdown_btns.length] = new markdown_btn(

'mrkdwn_br','<br>', '<?php echo TS_('Line Break') ?>',

' \n','',

'', -1

);

function markdown_show_btn( button, i )

{

if( button.id == 'mrkdwn_img' )

{ // Image

document.write('<input type="button" id="' + button.id + '" accesskey="' + button.access + '" title="' + button.title

+ '" style="' + button.style + '" class="<?php echo $this->get_template( 'toolbar_button_class' ); ?>" data-func="markdown_insert_lnkimg|b2evoCanvas|img" value="' + button.text + '" />');

}

else if( button.id == 'mrkdwn_link' )

{ // Link

document.write('<input type="button" id="' + button.id + '" accesskey="' + button.access + '" title="' + button.title

+ '" style="' + button.style + '" class="<?php echo $this->get_template( 'toolbar_button_class' ); ?>" data-func="markdown_insert_lnkimg|b2evoCanvas" value="' + button.text + '" />');

}

else

{ // Normal buttons:

document.write('<input type="button" id="' + button.id + '" accesskey="' + button.access + '" title="' + button.title

+ '" style="' + button.style + '" class="<?php echo $this->get_template( 'toolbar_button_class' ); ?>" data-func="markdown_insert_tag|b2evoCanvas|'+i+'" value="' + button.text + '" />');

}

}

// Memorize a new open tag

function markdown_add_tag( button )

{

if( markdown_btns[button].tag_end != '' )

{

markdown_open_tags[markdown_open_tags.length] = button;

document.getElementById( markdown_btns[button].id ).value = '/' + document.getElementById( markdown_btns[button].id ).value;

}

}

// Forget about an open tag

function markdown_remove_tag( button )

{

for( i = 0; i < markdown_open_tags.length; i++ )

{

if( markdown_open_tags[i] == button )

{

markdown_open_tags.splice( i, 1 );

document.getElementById( markdown_btns[button].id ).value = document.getElementById( markdown_btns[button].id ).value.replace( '/', '' );

}

}

}

function markdown_check_open_tags( button )

{

var tag = 0;

for( i = 0; i < markdown_open_tags.length; i++ )

{

if( markdown_open_tags[i] == button )

{

tag++;

}

}

if( tag > 0 )

{

return true; // tag found

}

else

{

return false; // tag not found

}

}

function markdown_close_all_tags()

{

var count = markdown_open_tags.length;

for( o = 0; o < count; o++ )

{

markdown_insert_tag( b2evoCanvas, markdown_open_tags[markdown_open_tags.length - 1] );

}

}

function markdown_toolbar( title )

{

document.write( '<?php echo $this->get_template( 'toolbar_title_before' ); ?>' + title + '<?php echo $this->get_template( 'toolbar_title_after' ); ?>' );

document.write( '<?php echo $this->get_template( 'toolbar_group_before' ); ?>' );

for( var i = 0; i < markdown_btns.length; i++ )

{

markdown_show_btn( markdown_btns[i], i );

if( markdown_btns[i].grp_pos == 'last' && i > 0 && i < markdown_btns.length - 1 )

{ // Separator between groups

document.write( '<?php echo $this->get_template( 'toolbar_group_after' ).$this->get_template( 'toolbar_group_before' ); ?>' );

}

}

document.write( '<?php echo $this->get_template( 'toolbar_group_after' ).$this->get_template( 'toolbar_group_before' ); ?>' );

document.write( '<input type="button" id="mrkdwn_close" class="<?php echo $this->get_template( 'toolbar_button_class' ); ?>" data-func="markdown_close_all_tags" title="<?php echo format_to_output( T_('Close all tags'), 'htmlattr' ); ?>" value="X" />' );

document.write( '<?php echo $this->get_template( 'toolbar_group_after' ); ?>' );

}

function markdown_insert_tag( field, i )

{

// we need to know if something is selected.

// First, ask plugins, then try IE and Mozilla.

var sel_text = b2evo_Callbacks.trigger_callback( "get_selected_text_for_" + field.id );

var focus_when_finished = false; // used for IE

if( sel_text == null )

{ // detect selection:

//IE support

if( document.selection )

{

field.focus();

var sel = document.selection.createRange();

sel_text = sel.text;

focus_when_finished = true;

}

//MOZILLA/NETSCAPE support

else if( field.selectionStart || field.selectionStart == '0' )

{

var startPos = field.selectionStart;

var endPos = field.selectionEnd;

sel_text = ( startPos != endPos );

}

}

if( sel_text )

{ // some text selected

textarea_wrap_selection( field, markdown_btns[i].tag_start, markdown_btns[i].tag_end, 0 );

}

else

{

if( !markdown_check_open_tags(i) || markdown_btns[i].tag_end == '' )

{

textarea_wrap_selection( field, markdown_btns[i].tag_start, '', 0 );

markdown_add_tag(i);

}

else

{

textarea_wrap_selection( field, '', markdown_btns[i].tag_end, 0 );

markdown_remove_tag(i);

}

}

if( focus_when_finished )

{

field.focus();

}

}

function markdown_insert_lnkimg( field, type )

{

var url = prompt( '<?php echo TS_('URL') ?>:', 'http://' );

if( url )

{

url = '[' + prompt('<?php echo TS_('Text') ?>:', '') + ']'

+ '(' + url;

var title = prompt( '<?php echo TS_('Title') ?>:', '' );

if( title != '' )

{

url += ' "' + title + '"';

}

url += ')';

if( typeof( type ) != 'undefined' && type == 'img' )

{ // for <img> tag

url = '!' + url;

}

textarea_wrap_selection( field, url, '', 1 );

}

}

//]]>

</script><?php

echo $this->get_template( 'toolbar_before', array( '$toolbar_class$' => $this->code.'_toolbar' ) );

?><script type="text/javascript">markdown_toolbar( '<?php echo T_('Markdown').': '; ?>' );</script><?php

echo $this->get_template( 'toolbar_after' );

return true;

}

}

?>