1<?php 2/** 3 * Box Plugin: Draw highlighting boxes around wiki markup 4 * 5 * Syntax: <box width% classes|title> 6 * width% width of the box, must use % unit 7 * classes one or more classes used to style the box, several predefined styles included in style.css 8 * title (optional) all text after '|' will be rendered above the main code text with a 9 * different style. 10 * 11 * Acknowledgements: 12 * Rounded corners based on snazzy borders by Stu Nicholls (http://www.cssplay.co.uk/boxes/snazzy) 13 * which is in turn based on nifty corners by Alessandro Fulciniti (http://pro.html.it/esempio/nifty/) 14 * 15 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 16 * @author Christopher Smith <chris@jalakai.co.uk> 17 * @author i-net software <tools@inetsoftware.de> 18 */ 19 20if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/'); 21if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/'); 22require_once(DOKU_PLUGIN.'syntax.php'); 23 24/** 25 * All DokuWiki plugins to extend the parser/rendering mechanism 26 * need to inherit from this class 27 */ 28class syntax_plugin_box extends DokuWiki_Syntax_Plugin { 29 30 var $title_mode = false; 31 var $title_pos = array(); 32 var $title_name = array(); 33 34 // the following are used in rendering and are set by _xhtml_boxopen() 35 var $_xb_colours = array(); 36 var $_content_colours = ''; 37 var $_title_colours = ''; 38 39 function getType(){ return 'protected';} 40 function getAllowedTypes() { return array('container','substition','protected','disabled','formatting','paragraphs'); } 41 function getPType(){ return 'block';} 42 43 // must return a number lower than returned by native 'code' mode (200) 44 function getSort(){ return 195; } 45 46 // override default accepts() method to allow nesting 47 // - ie, to get the plugin accepts its own entry syntax 48 function accepts($mode) { 49 if ($mode == substr(get_class($this), 7)) return true; 50 51 return parent::accepts($mode); 52 } 53 54 /** 55 * Connect pattern to lexer 56 */ 57 function connectTo($mode) { 58 $this->Lexer->addEntryPattern('<box>(?=.*?</box.*?>)',$mode,'plugin_box'); 59 $this->Lexer->addEntryPattern('<box\s[^\r\n\|]*?>(?=.*?</box.*?>)',$mode,'plugin_box'); 60 $this->Lexer->addEntryPattern('<box\|(?=[^\r\n]*?\>.*?</box.*?\>)',$mode,'plugin_box'); 61 $this->Lexer->addEntryPattern('<box\s[^\r\n\|]*?\|(?=[^\r\n]*?>.*?</box.*?>)',$mode,'plugin_box'); 62 } 63 64 function postConnect() { 65 $this->Lexer->addPattern('>', 'plugin_box'); 66 $this->Lexer->addExitPattern('</box.*?>', 'plugin_box'); 67 } 68 69 /** 70 * Handle the match 71 */ 72 function handle($match, $state, $pos, Doku_Handler $handler){ 73 74 switch ($state) { 75 case DOKU_LEXER_ENTER: 76 $data = $this->_boxstyle(trim(substr($match, 4, -1))); 77 if (substr($match, -1) == '|') { 78 $this->title_mode = true; 79 return array('title_open',$data, $pos); 80 } else { 81 return array('box_open',$data, $pos); 82 } 83 84 case DOKU_LEXER_MATCHED: 85 if ($this->title_mode) { 86 $this->title_mode = false; 87 return array('box_open','', $pos); 88 } else { 89 return array('data', $match, $pos); 90 } 91 92 case DOKU_LEXER_UNMATCHED: 93 if ($this->title_mode) { 94 return array('data', $match, $pos); 95 } 96 97 $handler->_addCall('cdata',array($match), $pos); 98 return false; 99 case DOKU_LEXER_EXIT: 100 $pos += strlen($match); // has to be done becvause the ending tag comes after $pos 101 $data = trim(substr($match, 5, -1)); 102 $title = ($data && $data{0} == "|") ? substr($data,1) : ''; 103 104 return array('box_close', $title, $pos); 105 106 } 107 return false; 108 } 109 110 /** 111 * Create output 112 */ 113 function render($mode, Doku_Renderer $renderer, $indata) { 114 global $ID, $ACT; 115 116 // $pos is for the current position in the wiki page 117 if (empty($indata)) return false; 118 list($instr, $data, $pos) = $indata; 119 120 if($mode == 'xhtml'){ 121 switch ($instr) { 122 case 'title_open' : 123 $this->title_mode = true; 124 $this->title_pos[] = $pos; // Start Position for Section Editing 125 $renderer->doc .= $this->_xhtml_boxopen($data); 126 $renderer->doc .= "<h2 class='box_title " . (method_exists($renderer, "finishSectionEdit") ? $renderer->startSectionEdit($pos, 'section', 'box') : "") . " '{$this->_title_colours}>"; 127 break; 128 129 case 'box_open' : 130 if ($this->title_mode) { 131 $this->title_mode = false; 132 $renderer->doc .= "</h2>\n<div class='box_content'{$this->_content_colours}>"; 133 } else { 134 $this->title_pos[] = $pos; // Start Position for Section Editing 135 $this->title_name[] = 'box_' . 'no-title' . '_' . md5(time()); 136 $renderer->doc .= $this->_xhtml_boxopen($data)."<div class='box_content'{$this->_content_colours}>"; 137 } 138 break; 139 140 case 'data' : 141 $output = $renderer->_xmlEntities($data); 142 143 if ( $this->title_mode ) { 144 $this->title_name[] = 'box_' . cleanID($output) . '_' . md5($output); 145 $hid = $renderer->_headerToLink($output,true); 146 $renderer->doc .= '<a id="' . $hid . '" name="' . $hid . '">' . $output . '</a>'; 147 break; 148 } 149 150 $renderer->doc .= $output; 151 break; 152 153 case 'box_close' : 154 $renderer->doc .= "</div>\n"; 155 156 if ($data) { 157 $renderer->doc .= "<p class='box_caption'{$this->_title_colours}>".$renderer->_xmlEntities($data)."</p>\n"; 158 } 159 160 // insert the section edit button befor the box is closed - array_pop makes sure we take the last box 161 if ( $this->getConf('allowSectionEdit') && $ACT != 'preview' ) { 162 $renderer->nocache(); 163 164 165 if ( auth_quickaclcheck($ID) > AUTH_READ ) { 166 $title = array_pop($this->title_name); // Clean up 167 if ( method_exists($renderer, "finishSectionEdit") ) { 168 $renderer->finishSectionEdit($pos); 169 } 170 } 171 } 172 173 $renderer->doc .= $this->_xhtml_boxclose(); 174 175 break; 176 } 177 178 return true; 179 } 180 return false; 181 } 182 183 function _boxstyle($str) { 184 if (!strlen($str)) return array(); 185 186 $styles = array(); 187 188 $tokens = preg_split('/\s+/', $str, 9); // limit is defensive 189 foreach ($tokens as $token) { 190 if (preg_match('/^\d*\.?\d+(%|px|em|ex|pt|cm|mm|pi|in)$/', $token)) { 191 $styles['width'] = $token; 192 continue; 193 } 194 195 if (preg_match('/^( 196 (\#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}))| #colorvalue 197 (rgb\(([0-9]{1,3}%?,){2}[0-9]{1,3}%?\)) #rgb triplet 198 )$/x', $token)) { 199 $styles['colour'][] = $token; 200 continue; 201 } 202 203 // restrict token (class names) characters to prevent any malicious data 204 if (preg_match('/[^A-Za-z0-9_-]/',$token)) continue; 205 $styles['class'] = (isset($styles['class']) ? $styles['class'].' ' : '').$token; 206 } 207 if (!empty($styles['colour'])) { 208 $styles['colour'] = $this->_box_colours($styles['colour']); 209 } 210 211 return $styles; 212 } 213 214 function _box_colours($colours) { 215 $triplets = array(); 216 217 // only need the first four colours 218 if (count($colours) > 4) $colours = array_slice($colours,0,4); 219 foreach ($colours as $colour) { 220 $triplet[] = $this->_colourToTriplet($colour); 221 } 222 223 // there must be one colour to get here - the primary background 224 // calculate title background colour if not present 225 if (empty($triplet[1])) { 226 $triplet[1] = $triplet[0]; 227 } 228 229 // calculate outer background colour if not present 230 if (empty($triplet[2])) { 231 $triplet[2] = $triplet[0]; 232 } 233 234 // calculate border colour if not present 235 if (empty($triplet[3])) { 236 $triplet[3] = $triplet[0]; 237 } 238 239 // convert triplets back to style sheet colours 240 $style_colours['content_background'] = 'rgb('.join(',',$triplet[0]).')'; 241 $style_colours['title_background'] = 'rgb('.join(',',$triplet[1]).')'; 242 $style_colours['outer_background'] = 'rgb('.join(',',$triplet[2]).')'; 243 $style_colours['borders'] = 'rgb('.join(',',$triplet[3]).')'; 244 245 return $style_colours; 246 } 247 248 function _colourToTriplet($colour) { 249 if ($colour{0} == '#') { 250 if (strlen($colour) == 4) { 251 // format #FFF 252 return array(hexdec($colour{1}.$colour{1}),hexdec($colour{2}.$colour{2}),hexdec($colour{3}.$colour{3})); 253 } else { 254 // format #FFFFFF 255 return array(hexdec(substr($colour,1,2)),hexdec(substr($colour,3,2)), hexdec(substr($colour,5,2))); 256 } 257 } else { 258 // format rgb(x,y,z) 259 return explode(',',substr($colour,4,-1)); 260 } 261 } 262 263 function _xhtml_boxopen($styles) { 264 $class = 'class="box' . (isset($styles['class']) ? ' '.$styles['class'] : '') . '"'; 265 $style = isset($styles['width']) ? "width: {$styles['width']};" : ''; 266 267 if (isset($styles['colour'])) { 268 $colours = 'background-color: '.$styles['colour']['outer_background'].'; '; 269 $colours .= 'border-color: '.$styles['colour']['borders'].';'; 270 271 $this->_content_colours = 'style="background-color: '.$styles['colour']['content_background'].'; border-color: '.$styles['colour']['borders'].'"'; 272 $this->_title_colours = 'style="background-color: '.$styles['colour']['title_background'].';"'; 273 274 } else { 275 $colours = ''; 276 277 $this->_content_colours = ''; 278 $this->_title_colours = ''; 279 } 280 281 if ($style || $colours) $style = ' style="'.$style.' '.$colours.'"'; 282 if ($colours) $colours = ' style="'.$colours.'"'; 283 284 $this->_xb_colours[] = $colours; 285 286 $html = "<div $class$style>\n"; 287 288 // Don't do box extras if there is no style for them 289 if ( !empty($colours) ) { 290 $html .=" <b class='xtop'><b class='xb1'$colours> </b><b class='xb2'$colours> </b><b class='xb3'$colours> </b><b class='xb4'$colours> </b></b>\n"; 291 $html .=" <div class='xbox'$colours>\n"; 292 } 293 294 return $html; 295 } 296 297 function _xhtml_boxclose() { 298 299 $colours = array_pop($this->_xb_colours); 300 301 // Don't do box extras if there is no style for them 302 if ( !empty($colours) ) { 303 $html = " </div>\n"; 304 $html .= " <b class='xbottom'><b class='xb4'$colours> </b><b class='xb3'$colours> </b><b class='xb2'$colours> </b><b class='xb1'$colours> </b></b>\n"; 305 } 306 $html .= "</div> <!-- Extras -->\n"; 307 308 return $html; 309 } 310 311} 312 313//Setup VIM: ex: et ts=4 enc=utf-8 :