Header...
60 | 61 | Paragraph: p. (also applied by default) 62 | Example: p. Text ->Text
63 | 64 | Blockquote: bq. 65 | Example: bq. Block quotation... ->Block quotation...66 | 67 | Blockquote with citation: bq.:http://citation.url 68 | Example: bq.:http://example.com/ Text... 69 | ->
Text...70 | 71 | Footnote: fn(1-100). 72 | Example: fn1. Footnote... ->
Footnote...
73 | 74 | Numeric list: #, ## 75 | Consecutive paragraphs beginning with # are wrapped in ordered list tags. 76 | Example:- ordered list
- unordered list
- term
- definition
computer code
105 | %(bob)span% -> span
106 |
107 | ==notextile== -> leave text alone (do not format)
108 |
109 | "linktext":url -> linktext
110 | "linktext(title)":url -> linktext
111 | "$":url -> url
112 | "$(title)":url -> url
113 |
114 | !imageurl! -> Scientists say1 the moon is small.
190 | 191 | 196 | 197 | The 'a b c' backlink characters can be altered too. 198 | For example if you wanted the notes to have numeric backlinks starting from 1: 199 | 200 | notelist:1. 201 | 202 | Table syntax: 203 | 204 | Simple tables: 205 | 206 | |a|simple|table|row| 207 | |And|Another|table|row| 208 | |With an||empty|cell| 209 | 210 | |=. My table caption goes here 211 | |_. A|_. table|_. header|_.row| 212 | |A|simple|table|row| 213 | 214 | Note: Table captions *must* be the first line of the table else treated as a center-aligned cell. 215 | 216 | Tables with attributes: 217 | 218 | table{border:1px solid black}. My table summary here 219 | {background:#ddd;color:red}. |{}| | | | 220 | 221 | To specify thead / tfoot / tbody groups, add one of these on its own line 222 | above the row(s) you wish to wrap (you may specify attributes before the dot): 223 | 224 | |^. # thead 225 | |-. # tbody 226 | |~. # tfoot 227 | 228 | Column groups: 229 | 230 | |:\3. 100| 231 | 232 | Becomes: 233 |paragraph
274 | 275 | p(#fluid). paragraph ->paragraph
276 | 277 | (classes and ids can be combined) 278 | p(hector#fluid). paragraph ->paragraph
279 | 280 | Curly {brackets} insert arbitrary css style 281 | 282 | p{line-height:18px}. paragraph ->paragraph
283 | 284 | h3{color:red}. header 3 ->header 3
285 | 286 | Square [brackets] insert language attributes 287 | 288 | p[no]. paragraph ->paragraph
289 | 290 | %[fr]phrase% -> phrase 291 | 292 | Usually Textile block element syntax requires a dot and space before the block 293 | begins, but since lists don't, they can be styled just using braces 294 | 295 | #{color:blue} one ->-
296 | # big
- one 297 | # list
- big 298 |
- list 299 |
Hello World!
337 | * 338 | * The functionality of the parser can be customized with the setters: 339 | * 340 | * bc. $parser = new \Netcarver\Textile\Parser(); 341 | * $parser->setImages(false)->parse('!no-image.jpg!'); 342 | * 343 | * The Parser class can also be extended to create pre-configured classes: 344 | * 345 | * bc.. namespace MyApp; 346 | * 347 | * use \Netcarver\Textile\Parser; 348 | * 349 | * class CommentParser extends Parser 350 | * { 351 | * protected function configure() 352 | * { 353 | * $this->setImages(false)->setRestricted(true)->setLite(true); 354 | * } 355 | * } 356 | * 357 | * p. Keep in mind that the classes' protected methods and properties should be 358 | * considered part of the private API and depending on them should be avoided. 359 | * Instead try to only use the public methods marked as being part of the 360 | * public API. 361 | * 362 | * @see Parser::__construct() 363 | * @see Parser::parse() 364 | */ 365 | 366 | class Parser 367 | { 368 | /** 369 | * HTML5 document type. 370 | * 371 | * @since 3.8.0 372 | */ 373 | const DOCTYPE_HTML5 = 'html5'; 374 | 375 | /** 376 | * XHTML document type. 377 | * 378 | * @since 3.8.0 379 | */ 380 | const DOCTYPE_XHTML = 'xhtml'; 381 | 382 | /** 383 | * Version number. 384 | * 385 | * @var string 386 | */ 387 | protected $ver = '4.1.4-dev'; 388 | 389 | /** 390 | * Regular expression snippets. 391 | * 392 | * @var string[] 393 | */ 394 | protected $regex_snippets = array(); 395 | 396 | /** 397 | * Pattern for horizontal align. 398 | * 399 | * @var string 400 | */ 401 | protected $hlgn = "(?:\<(?!>)|<>|>|<|(?|\<\>|\=|[()]+(?! ))"; 402 | 403 | /** 404 | * Pattern for vertical align. 405 | * 406 | * @var string 407 | */ 408 | protected $vlgn = "[\-^~]"; 409 | 410 | /** 411 | * Pattern for HTML classes and IDs. 412 | * 413 | * Does not allow classes/ids/languages/styles to span across 414 | * newlines if used in a dotall regular expression. 415 | * 416 | * @var string 417 | */ 418 | protected $clas = "(?:\([^)\n]+\))"; 419 | 420 | /** 421 | * Pattern for language attribute. 422 | * 423 | * @var string 424 | */ 425 | protected $lnge = "(?:\[[^]\n]+\])"; 426 | 427 | /** 428 | * Pattern for style attribute. 429 | * 430 | * @var string 431 | */ 432 | protected $styl = "(?:\{[^}\n]+\})"; 433 | 434 | /** 435 | * Regular expression pattern for column spans in tables. 436 | * 437 | * @var string 438 | */ 439 | protected $cspn = "(?:\\\\[0-9]+)"; 440 | 441 | /** 442 | * Regular expression for row spans in tables. 443 | * 444 | * @var string 445 | */ 446 | protected $rspn = "(?:\/[0-9]+)"; 447 | 448 | /** 449 | * Regular expression for horizontal or vertical alignment. 450 | * 451 | * @var string 452 | */ 453 | protected $a; 454 | 455 | /** 456 | * Regular expression for column or row spans in tables. 457 | * 458 | * @var string 459 | */ 460 | protected $s; 461 | 462 | /** 463 | * Pattern that matches a class, style, language and horizontal alignment attributes. 464 | * 465 | * @var string 466 | */ 467 | protected $c; 468 | 469 | /** 470 | * Pattern that matches class, style and language attributes. 471 | * 472 | * Allows all 16 possible permutations of class, style and language attributes. 473 | * No attribute, c, cl, cs, cls, csl, l, lc, ls, lcs, lsc, s, sc, sl, scl or slc. 474 | * 475 | * @var string 476 | */ 477 | protected $cls; 478 | 479 | /** 480 | * Whitelisted block tags. 481 | * 482 | * @var string[] 483 | */ 484 | protected $blocktag_whitelist = array(); 485 | 486 | /** 487 | * Whether raw blocks are enabled. 488 | * 489 | * @var bool 490 | * @since 3.7.0 491 | */ 492 | protected $rawBlocksEnabled = false; 493 | 494 | /** 495 | * An array of patterns used for matching phrasing tags. 496 | * 497 | * Phrasing tags, unline others, are wrapped in a paragraph even if they 498 | * already wrap the block. 499 | * 500 | * @var string[] 501 | * @since 3.7.0 502 | */ 503 | protected $phrasingContent = array( 504 | 'a', 505 | 'abbr', 506 | 'acronym', 507 | 'area', 508 | 'audio', 509 | 'b', 510 | 'bdo', 511 | 'br', 512 | 'button', 513 | 'canvas', 514 | 'cite', 515 | 'code', 516 | 'command', 517 | 'data', 518 | 'datalist', 519 | 'del', 520 | 'dfn', 521 | 'em', 522 | 'embed', 523 | 'i', 524 | 'iframe', 525 | 'img', 526 | 'input', 527 | 'ins', 528 | 'kbd', 529 | 'keygen', 530 | 'label', 531 | 'link', 532 | 'map', 533 | 'mark', 534 | 'math', 535 | 'meta', 536 | 'meter', 537 | 'noscript', 538 | 'object', 539 | 'output', 540 | 'progress', 541 | 'q', 542 | 'ruby', 543 | 'samp', 544 | 'script', 545 | 'select', 546 | 'small', 547 | 'span', 548 | 'strong', 549 | 'sub', 550 | 'sup', 551 | 'svg', 552 | 'textarea', 553 | 'time', 554 | 'var', 555 | 'video', 556 | 'wbr', 557 | ); 558 | 559 | /** 560 | * An array of patterns used to match divider tags. 561 | * 562 | * Blocks containing only self-closing divider tags are not wrapped in 563 | * paragraph tags. 564 | * 565 | * @var string[] 566 | * @since 3.7.0 567 | */ 568 | protected $dividerContent = array( 569 | 'br', 570 | 'hr', 571 | 'img', 572 | ); 573 | 574 | /** 575 | * An array of patterns used to match unwrappable block tags. 576 | * 577 | * Blocks containing any of these unwrappable tags will not be wrapped in 578 | * paragraphs. 579 | * 580 | * @var string[] 581 | * @since 3.7.0 582 | */ 583 | protected $blockContent = array( 584 | 'address', 585 | 'article', 586 | 'aside', 587 | 'blockquote', 588 | 'details', 589 | 'div', 590 | 'dl', 591 | 'fieldset', 592 | 'figure', 593 | 'footer', 594 | 'form', 595 | 'h1', 596 | 'h2', 597 | 'h3', 598 | 'h4', 599 | 'h5', 600 | 'h6', 601 | 'header', 602 | 'hgroup', 603 | 'main', 604 | 'menu', 605 | 'nav', 606 | 'ol', 607 | 'p', 608 | 'pre', 609 | 's', 610 | 'section', 611 | 'table', 612 | 'template', 613 | 'ul', 614 | ); 615 | 616 | /** 617 | * An array of built patterns. 618 | * 619 | * @var arrayh1. Headings are disabled too
1265 | * 1266 | * This doesn't prevent unsafe input values. If you wish to parse untrusted 1267 | * user-given Textile input, also enable the restricted parser mode with 1268 | * Parser::setRestricted(). 1269 | * 1270 | * bc. $parser = new \Netcarver\Textile\Parser(); 1271 | * echo $parser 1272 | * ->setRestricted(true) 1273 | * ->setLite(true) 1274 | * ->parse('h1. Hello World!'); 1275 | * 1276 | * @param bool $lite TRUE to enable 1277 | * @return Parser This instance 1278 | * @since 3.6.0 1279 | * @see Parser::isLiteModeEnabled() 1280 | * @see Parser::setRestricted() 1281 | * @api 1282 | */ 1283 | public function setLite($lite) 1284 | { 1285 | $this->lite = (bool) $lite; 1286 | return $this; 1287 | } 1288 | 1289 | /** 1290 | * Gets the lite mode status. 1291 | * 1292 | * bc. $parser = new \Netcarver\Textile\Parser(); 1293 | * if ($parser->isLiteModeEnabled() === true) { 1294 | * echo 'Lite mode is enabled.'; 1295 | * } 1296 | * 1297 | * @return bool TRUE if enabled, FALSE otherwise 1298 | * @since 3.6.0 1299 | * @see Parser::setLite() 1300 | * @api 1301 | */ 1302 | public function isLiteModeEnabled() 1303 | { 1304 | return (bool) $this->lite; 1305 | } 1306 | 1307 | /** 1308 | * Disables and enables images. 1309 | * 1310 | * If disabled, image tags are not generated. This option is ideal for 1311 | * minimalist output such as text-only comments. 1312 | * 1313 | * bc. $parser = new \Netcarver\Textile\Parser(); 1314 | * echo $parser 1315 | * ->setImages(true) 1316 | * ->parse('!image.png!'); 1317 | * 1318 | * Generates: 1319 | * 1320 | * bc.!image.png!
1321 | * 1322 | * @param bool $enabled TRUE to enable, FALSE to disable 1323 | * @return Parser This instance 1324 | * @since 3.6.0 1325 | * @see Parser::isImageTagEnabled() 1326 | * @api 1327 | */ 1328 | public function setImages($enabled) 1329 | { 1330 | $this->noimage = !$enabled; 1331 | return $this; 1332 | } 1333 | 1334 | /** 1335 | * Whether images are enabled. 1336 | * 1337 | * bc. $parser = new \Netcarver\Textile\Parser(); 1338 | * if ($parser->isImageTagEnabled() === true) { 1339 | * echo 'Images are enabled.'; 1340 | * } 1341 | * 1342 | * @return bool TRUE if enabled, FALSE otherwise 1343 | * @since 3.6.0 1344 | * @see Parser::setImages() 1345 | * @api 1346 | */ 1347 | public function isImageTagEnabled() 1348 | { 1349 | return !$this->noimage; 1350 | } 1351 | 1352 | /** 1353 | * Sets link relationship status value. 1354 | * 1355 | * This method sets the HTML relationship tokens that are applied to links 1356 | * generated by PHP-Textile. 1357 | * 1358 | * bc. $parser = new \Netcarver\Textile\Parser(); 1359 | * echo $parser 1360 | * ->setLinkRelationShip('nofollow') 1361 | * ->parse('"Link":http://example.com/'); 1362 | * 1363 | * Generates: 1364 | * 1365 | * bc. 1366 | * 1367 | * @param string|arrayInnocent looking “link”:javacript:window.alert().
1417 | * 1418 | * If left disabled, the parser allows users to mix raw HTML and Textile. 1419 | * Using the parser in non-restricted on untrusted input, like comments 1420 | * and forum posts, will lead to XSS issues, as users will be able to use 1421 | * any HTML code, JavaScript links and Textile attributes in their input. 1422 | * 1423 | * @param bool $enabled TRUE to enable, FALSE to disable 1424 | * @return Parser This instance 1425 | * @since 3.6.0 1426 | * @see Parser::isRestrictedModeEnabled() 1427 | * @api 1428 | */ 1429 | public function setRestricted($enabled) 1430 | { 1431 | if ($enabled) { 1432 | $this->url_schemes = $this->restricted_url_schemes; 1433 | $this->restricted = true; 1434 | } else { 1435 | $this->url_schemes = $this->unrestricted_url_schemes; 1436 | $this->restricted = false; 1437 | } 1438 | 1439 | return $this; 1440 | } 1441 | 1442 | /** 1443 | * Whether restricted parser mode is enabled. 1444 | * 1445 | * bc. $parser = new \Netcarver\Textile\Parser(); 1446 | * if ($parser->isRestrictedModeEnabled() === true) { 1447 | * echo 'PHP-Textile is in restricted mode.'; 1448 | * } 1449 | * 1450 | * @return bool TRUE if enabled, FALSE otherwise 1451 | * @since 3.6.0 1452 | * @see Parser::setRestricted() 1453 | * @api 1454 | */ 1455 | public function isRestrictedModeEnabled() 1456 | { 1457 | return (bool) $this->restricted; 1458 | } 1459 | 1460 | /** 1461 | * Enables and disables raw blocks. 1462 | * 1463 | * When raw blocks are enabled, any paragraph blocks wrapped in a tag 1464 | * not matching Parser::$blockContent or Parser::$phrasingContent will not 1465 | * be parsed, and instead is left as is. 1466 | * 1467 | * bc. $parser = new \Netcarver\Textile\Parser(); 1468 | * echo $parser 1469 | * ->setRawBlocks(true) 1470 | * ->parse('A *raw* block.
');
1471 | *
1472 | * The above generates:
1473 | *
1474 | * bc. A *raw* block.
1475 | *
1476 | * @param bool $enabled TRUE to enable, FALSE to disable
1477 | * @return Parser This instance
1478 | * @since 3.7.0
1479 | * @see Parser::isRawBlocksEnabled()
1480 | * @see Parser::isRawBlock()
1481 | * @api
1482 | */
1483 | public function setRawBlocks($enabled)
1484 | {
1485 | $this->rawBlocksEnabled = (bool) $enabled;
1486 | return $this;
1487 | }
1488 |
1489 | /**
1490 | * Whether raw blocks are enabled.
1491 | *
1492 | * bc. $parser = new \Netcarver\Textile\Parser();
1493 | * if ($parser->isRawBlocksEnabled() === true) {
1494 | * echo 'Raw blocks are enabled';
1495 | * }
1496 | *
1497 | * @return bool TRUE if enabled, FALSE otherwise
1498 | * @since 3.7.0
1499 | * @see Parser::setRawBlocks()
1500 | * @api
1501 | */
1502 | public function isRawBlocksEnabled()
1503 | {
1504 | return (bool) $this->rawBlocksEnabled;
1505 | }
1506 |
1507 | /**
1508 | * Sets class alignment mode independent of the document type.
1509 | *
1510 | * In HTML5 document type, img elements are generated with align-left,
1511 | * align-center and align-right class selectors rather than align
1512 | * attribute being added to the image.
1513 | *
1514 | * With this option you can enable that functionality in XHTML document type mode too.
1515 | *
1516 | * bc. $parser = new \Netcarver\Textile\Parser();
1517 | * $parser
1518 | * ->setAlignClasses(true)
1519 | * ->parse(!
1524 | *
1525 | * @param bool $enabled TRUE to enable, FALSE to disable
1526 | * @return Parser This instance
1527 | * @since 3.8.0
1528 | * @api
1529 | */
1530 | public function setAlignClasses($enabled)
1531 | {
1532 | $this->isAlignClassesEnabled = (bool) $enabled;
1533 | return $this;
1534 | }
1535 |
1536 | /**
1537 | * Whether class alignment mode is enabled.
1538 | *
1539 | * bc. $parser = new \Netcarver\Textile\Parser();
1540 | * if ($parser->isAlignClassesEnabled() === true) {
1541 | * echo 'Images are aligned with class instead of align attribute';
1542 | * }
1543 | *
1544 | * @return bool TRUE if enabled, FALSE otherwise
1545 | * @since 3.8.0
1546 | * @see Parser::setAlignClasses()
1547 | * @api
1548 | */
1549 | public function isAlignClassesEnabled()
1550 | {
1551 | if ($this->isAlignClassesEnabled === null
1552 | && $this->getDocumentType() === self::DOCTYPE_HTML5
1553 | ) {
1554 | return true;
1555 | }
1556 |
1557 | return (bool) $this->isAlignClassesEnabled;
1558 | }
1559 |
1560 | /**
1561 | * Enables and disables block-level tags and formatting features.
1562 | *
1563 | * When disabled, block-level tags aren't rendered. This allows PHP-Textile
1564 | * to operate on a single line of text, rather than blocks of text and does
1565 | * not wrap the output in paragraph tags.
1566 | *
1567 | * bc. $parser = new \Netcarving\Textile\Parser();
1568 | * echo $parser
1569 | * ->setBlockTags(false)
1570 | * ->parse('h1. Hello *strong* world!');
1571 | *
1572 | * The above generates:
1573 | *
1574 | * bc. h1. Hello strong world!
1575 | *
1576 | * @param bool $enabled TRUE to enable, FALSE to disable
1577 | * @return Parser This instance
1578 | * @since 3.6.0
1579 | * @see Parser::isBlockTagEnabled()
1580 | * @api
1581 | */
1582 | public function setBlockTags($enabled)
1583 | {
1584 | $this->blockTagsEnabled = (bool) $enabled;
1585 | return $this;
1586 | }
1587 |
1588 | /**
1589 | * Whether block-level tags are enabled and parsed.
1590 | *
1591 | * bc. $parser = new \Netcarving\Textile\Parser();
1592 | * if ($parser->isBlockTagAllowed() === true) {
1593 | * echo 'Block tags are enabled.';
1594 | * }
1595 | *
1596 | * @return bool TRUE if enabled, FALSE otherwise
1597 | * @since 3.6.0
1598 | * @see Parser::setBlockTags()
1599 | * @api
1600 | */
1601 | public function isBlockTagEnabled()
1602 | {
1603 | return (bool) $this->blockTagsEnabled;
1604 | }
1605 |
1606 | /**
1607 | * Enables and disables line-wrapping.
1608 | *
1609 | * If enabled, line-breaks are replaced by target document's break tag. If
1610 | * disabled, input document's line-breaks are ignored. This setting can be
1611 | * used if the the input document's lines are pre-wrapped. For instance,
1612 | * in case the input is from CLI content, or source code documentation.
1613 | *
1614 | * bc. $parser = new \Netcarving\Textile\Parser();
1615 | * echo $parser
1616 | * ->setLineWrap(false)
1617 | * ->parse("Hello\nworld!");
1618 | *
1619 | * The above generates:
1620 | *
1621 | * bc. Hello world!
1622 | * 1623 | * @param bool $enabled TRUE to enable, FALSE to disable 1624 | * @return Parser This instance 1625 | * @since 3.6.0 1626 | * @see Parser::isLineWrapEnabled() 1627 | * @api 1628 | */ 1629 | public function setLineWrap($enabled) 1630 | { 1631 | $this->lineWrapEnabled = (bool) $enabled; 1632 | return $this; 1633 | } 1634 | 1635 | /** 1636 | * Whether line-wrapping is enabled. 1637 | * 1638 | * bc. $parser = new \Netcarving\Textile\Parser(); 1639 | * if ($parser->isLineWrapEnabled() === true) { 1640 | * echo 'Line-wrapping is enabled.'; 1641 | * } 1642 | * 1643 | * @return bool TRUE if enabled, FALSE otherwise 1644 | * @see Parser::setLineWrap() 1645 | * @since 3.6.0 1646 | * @api 1647 | */ 1648 | public function isLineWrapEnabled() 1649 | { 1650 | return (bool) $this->lineWrapEnabled; 1651 | } 1652 | 1653 | /** 1654 | * Sets a substitution symbol. 1655 | * 1656 | * This method lets you to redefine a substitution symbol. The following 1657 | * sets the 'half' glyph: 1658 | * 1659 | * bc. $parser = new \Netcarver\Textile\Parser(); 1660 | * echo $parser 1661 | * ->setSymbol('half', '1⁄2') 1662 | * ->parse('Hello [1/2] World!'); 1663 | * 1664 | * Generates: 1665 | * 1666 | * bc.Hello 1&#⁄2 World!
1667 | * 1668 | * Symbol can be set to FALSE to disable it: 1669 | * 1670 | * bc. $parser = new \Netcarver\Textile\Parser(); 1671 | * $parser->setSymbol('dimension', false); 1672 | * 1673 | * See Parser::getSymbol() to find out all available symbols. 1674 | * 1675 | * @param string $name Name of the symbol to assign a new value to 1676 | * @param string|bool $value New value for the symbol, or FALSE to disable 1677 | * @return Parser This instance 1678 | * @see Parser::getSymbol() 1679 | * @api 1680 | */ 1681 | public function setSymbol($name, $value) 1682 | { 1683 | if ($value !== false) { 1684 | $value = (string) $value; 1685 | } 1686 | 1687 | $this->symbols[(string) $name] = $value; 1688 | $this->rebuild_glyphs = true; 1689 | return $this; 1690 | } 1691 | 1692 | /** 1693 | * Gets a symbol definitions. 1694 | * 1695 | * This method gets a symbol definition by name, or the full symbol table 1696 | * as an array. 1697 | * 1698 | * bc. $parser = new \Netcarver\Textile\Parser(); 1699 | * echo $parser->getSymbol('dimension'); 1700 | * 1701 | * To get all available symbol definitions: 1702 | * 1703 | * bc. $parser = new \Netcarver\Textile\Parser(); 1704 | * print_r($parser->getSymbol()); 1705 | * 1706 | * @param string|null $name The name of the symbol, or NULL if requesting the symbol table 1707 | * @return arrayHello World!
1913 | * 1914 | * Additionally the parser can be run in safe, restricted mode using the 1915 | * Parser::setRestricted() method. 1916 | * 1917 | * bc. $parser = new \Netcarver\Textile\Parser(); 1918 | * echo $parser 1919 | * ->setRestricted(true) 1920 | * ->parse('h1. Hello World!'); 1921 | * 1922 | * This enables restricted mode and allows safe parsing of untrusted input. 1923 | * PHP-Textile will disable unsafe attributes, links and escapes any raw 1924 | * HTML input. This option should be enabled when parsing untrusted user 1925 | * input. 1926 | * 1927 | * If restricted mode is disabled, the parser allows users to mix raw HTML 1928 | * and Textile. 1929 | * 1930 | * @param string $text The Textile input to parse 1931 | * @return string Parsed Textile input 1932 | * @since 3.6.0 1933 | * @api 1934 | */ 1935 | public function parse($text) 1936 | { 1937 | $this->prepare(); 1938 | $text = (string) $text; 1939 | 1940 | if ($this->isRestrictedModeEnabled()) { 1941 | // Escape any raw HTML. 1942 | $text = $this->encodeHTML($text, false); 1943 | } 1944 | 1945 | $text = $this->cleanWhiteSpace($text); 1946 | $text = $this->cleanUniqueTokens($text); 1947 | 1948 | if ($this->isBlockTagEnabled()) { 1949 | if ($this->isLiteModeEnabled()) { 1950 | $this->blocktag_whitelist = array('bq', 'p'); 1951 | $text = $this->blocks($text."\n\n"); 1952 | } else { 1953 | $this->blocktag_whitelist = array( 1954 | 'bq', 1955 | 'p', 1956 | 'bc', 1957 | 'notextile', 1958 | 'pre', 1959 | 'h[1-6]', 1960 | 'fn'.$this->regex_snippets['digit'].'+', 1961 | '###', 1962 | ); 1963 | $text = $this->blocks($text); 1964 | $text = $this->placeNoteLists($text); 1965 | } 1966 | } else { 1967 | $text .= "\n\n"; 1968 | 1969 | // Treat quoted quote as a special glyph. 1970 | $text = $this->glyphQuotedQuote($text); 1971 | 1972 | // Inline markup (em, strong, sup, sub, del etc). 1973 | $text = $this->spans($text); 1974 | 1975 | // Generate links. 1976 | $text = $this->links($text); 1977 | 1978 | // Glyph level substitutions (mainly typographic -- " & ' => curly quotes, -- => em-dash etc. 1979 | $text = $this->glyphs($text); 1980 | } 1981 | 1982 | $text = $this->retrieve($text); 1983 | $text = $this->replaceGlyphs($text); 1984 | $text = $this->retrieveTags($text); 1985 | $text = $this->retrieveURLs($text); 1986 | 1987 | // Replace shelved instances that were inside tag and link attributes. 1988 | $text = $this->retrieve($text); 1989 | 1990 | $text = str_replace($this->getLineBreak(), $this->getLineBreak()."\n", $text); 1991 | 1992 | return $text; 1993 | } 1994 | 1995 | /** 1996 | * Parses the given Textile input in un-restricted mode. 1997 | * 1998 | * This method is deprecated, use Parser::parse() method instead. 1999 | * This method is equivalent of: 2000 | * 2001 | * bc. $parser = new \Netcarver\Textile\Parser(); 2002 | * echo $parser->parse('h1. Hello World!'); 2003 | * 2004 | * Additional arguments can be passed with setter methods: 2005 | * 2006 | * bc. $parser = new \Netcarver\Textile\Parser(); 2007 | * echo $parser 2008 | * ->setLite(true) 2009 | * ->setImages(true) 2010 | * ->setLinkRelationShip('nofollow') 2011 | * ->parse('h1. Hello World!'); 2012 | * 2013 | * @param string $text The Textile input to parse 2014 | * @param bool $lite Switch to lite mode 2015 | * @param bool $encode Encode input and return 2016 | * @param bool $noimage Disables images 2017 | * @param bool $strict This argument is ignored 2018 | * @param string $rel Relationship attribute applied to generated links 2019 | * @return string Parsed $text 2020 | * @see Parser::parse() 2021 | * @deprecated in 3.6.0 2022 | * @api 2023 | */ 2024 | public function textileThis($text, $lite = false, $encode = false, $noimage = false, $strict = false, $rel = '') 2025 | { 2026 | if ($encode) { 2027 | trigger_error( 2028 | '$encode argument is deprecated. Use Parser::textileEncode() instead.', 2029 | \E_USER_DEPRECATED 2030 | ); 2031 | 2032 | return $this->textileEncode($text); 2033 | } 2034 | 2035 | trigger_error( 2036 | 'Parser::textileThis() is deprecated. Use Parser::parse() instead.', 2037 | \E_USER_DEPRECATED 2038 | ); 2039 | 2040 | return $this 2041 | ->setRestricted(false) 2042 | ->setLite($lite) 2043 | ->setBlockTags(true) 2044 | ->setImages(!$noimage) 2045 | ->setLinkRelationShip($rel) 2046 | ->parse($text); 2047 | } 2048 | 2049 | /** 2050 | * Parses the given Textile input in restricted mode. 2051 | * 2052 | * This method is deprecated, use Parser::parse() method with 2053 | * Parser::setRestricted() and Parser::setLite() enabled, and 2054 | * Parser::setImages() disabled. 2055 | * 2056 | * This method's defaults are identical to: 2057 | * 2058 | * bc. $parser = new \Netcarver\Textile\Parser(); 2059 | * echo $parser 2060 | * ->setRestricted(true) 2061 | * ->setLite(true) 2062 | * ->setImages(false) 2063 | * ->setLinkRelationShip('nofollow') 2064 | * ->parse('h1. Hello World!'); 2065 | * 2066 | * As in the above, restricted mode should be used when parsing any 2067 | * untrusted user input, including comments or forum posts. 2068 | * 2069 | * @param string $text The Textile input to parse 2070 | * @param bool $lite Controls lite mode, allowing extra formatting 2071 | * @param bool $noimage Allow images 2072 | * @param string $rel Relationship attribute applied to generated links 2073 | * @return string Parsed input 2074 | * @see Parser::setRestricted() 2075 | * @see Parser::setLite() 2076 | * @see Parser::setImages() 2077 | * @see Parser::setLinkRelationShip() 2078 | * @see Parser::parse() 2079 | * @deprecated in 3.6.0 2080 | * @api 2081 | */ 2082 | public function textileRestricted($text, $lite = true, $noimage = true, $rel = 'nofollow') 2083 | { 2084 | trigger_error( 2085 | 'Parser::textileRestricted() is deprecated. Use Parser::parse() with Parser::setRestricted() instead.', 2086 | E_USER_DEPRECATED 2087 | ); 2088 | 2089 | return $this 2090 | ->setRestricted(true) 2091 | ->setLite($lite) 2092 | ->setBlockTags(true) 2093 | ->setImages(!$noimage) 2094 | ->setLinkRelationShip($rel) 2095 | ->parse($text); 2096 | } 2097 | 2098 | /** 2099 | * Parses Textile syntax. 2100 | * 2101 | * This method performs common parse actions. 2102 | * 2103 | * @param string $text The input to parse 2104 | * @param bool $lite Enables lite mode 2105 | * @return string Parsed input 2106 | * @deprecated in 3.6.0 2107 | */ 2108 | protected function textileCommon($text, $lite) 2109 | { 2110 | trigger_error('Parser::textileCommon() is deprecated.', E_USER_DEPRECATED); 2111 | return $this->setLite($lite)->parse($text); 2112 | } 2113 | 2114 | /** 2115 | * Output line break according to document type. 2116 | * 2117 | * @return string The break tag 2118 | * @since 4.0.0 2119 | * @see Parser::getDocumentType() 2120 | */ 2121 | protected function getLineBreak() 2122 | { 2123 | return ($this->getDocumentType() === self::DOCTYPE_HTML5) ? '' : '
'; 2124 | } 2125 | 2126 | /** 2127 | * Prepares the glyph patterns from the symbol table. 2128 | * 2129 | * @return void 2130 | * @see Parser::setSymbol() 2131 | * @see Parser::getSymbol() 2132 | */ 2133 | protected function prepGlyphs() 2134 | { 2135 | if ($this->rebuild_glyphs === false) { 2136 | return; 2137 | } 2138 | 2139 | $pnc = '[[:punct:]]'; 2140 | $cur = ''; 2141 | 2142 | if ($this->regex_snippets['cur']) { 2143 | $cur = '(?:['.$this->regex_snippets['cur'].']'.$this->regex_snippets['space'].'*)?'; 2144 | } 2145 | 2146 | $this->glyph_search = array(); 2147 | $this->glyph_replace = array(); 2148 | 2149 | // Dimension sign 2150 | if ($this->symbols['dimension'] !== false) { 2151 | $this->glyph_search[] = '/(?<=\b|x)([0-9]++[\])]?[\'"]? ?)[x]( ?[\[(]?)(?=[+-]?'.$cur.'[0-9]*\.?[0-9]++)/i'. 2152 | $this->regex_snippets['mod']; 2153 | $this->glyph_replace[] = '$1'.$this->symbols['dimension'].'$2'; 2154 | } 2155 | 2156 | // Apostrophe 2157 | if ($this->symbols['apostrophe'] !== false) { 2158 | $this->glyph_search[] = '/('.$this->regex_snippets['wrd'].'|\))\''. 2159 | '('.$this->regex_snippets['wrd'].')/'.$this->regex_snippets['mod']; 2160 | $this->glyph_replace[] = '$1'.$this->symbols['apostrophe'].'$2'; 2161 | 2162 | // Back in '88/the '90s but not in his '90s', '1', '1.' '10m' or '5.png' 2163 | $this->glyph_search[] = '/('.$this->regex_snippets['space'].')\''. 2164 | '(\d+'.$this->regex_snippets['wrd'].'?)\b(?![.]?['.$this->regex_snippets['wrd'].']*?\')/'. 2165 | $this->regex_snippets['mod']; 2166 | $this->glyph_replace[] = '$1'.$this->symbols['apostrophe'].'$2'; 2167 | } 2168 | 2169 | // Single open following open bracket 2170 | if ($this->symbols['quote_single_open'] !== false) { 2171 | $this->glyph_search[] = "/([([{])'(?=\S)/".$this->regex_snippets['mod']; 2172 | $this->glyph_replace[] = '$1'.$this->symbols['quote_single_open']; 2173 | } 2174 | 2175 | // Single closing 2176 | if ($this->symbols['quote_single_close'] !== false) { 2177 | $this->glyph_search[] = '/(\S)\'(?='.$this->regex_snippets['space'].'|'.$pnc.'|<|$)/'. 2178 | $this->regex_snippets['mod']; 2179 | $this->glyph_replace[] = '$1'.$this->symbols['quote_single_close']; 2180 | } 2181 | 2182 | // Default single opening 2183 | if ($this->symbols['quote_single_open'] !== false) { 2184 | $this->glyph_search[] = "/'/"; 2185 | $this->glyph_replace[] = $this->symbols['quote_single_open']; 2186 | } 2187 | 2188 | // Double open following an open bracket. Allows things like Hello ["(Mum) & dad"] 2189 | if ($this->symbols['quote_double_open'] !== false) { 2190 | $this->glyph_search[] = '/([([{])"(?=\S)/'.$this->regex_snippets['mod']; 2191 | $this->glyph_replace[] = '$1'.$this->symbols['quote_double_open']; 2192 | } 2193 | 2194 | // Double closing 2195 | if ($this->symbols['quote_double_close'] !== false) { 2196 | $this->glyph_search[] = '/(\S)"(?='.$this->regex_snippets['space'].'|'.$pnc.'|<|$)/'. 2197 | $this->regex_snippets['mod']; 2198 | $this->glyph_replace[] = '$1'.$this->symbols['quote_double_close']; 2199 | } 2200 | 2201 | // Default double opening 2202 | if ($this->symbols['quote_double_open'] !== false) { 2203 | $this->glyph_search[] = '/"/'; 2204 | $this->glyph_replace[] = $this->symbols['quote_double_open']; 2205 | } 2206 | 2207 | if ($this->symbols['acronym'] === null) { 2208 | if ($this->getDocumentType() === 'html5') { 2209 | $acronym = '{content}'; 2210 | } else { 2211 | $acronym = '{content}'; 2212 | } 2213 | } else { 2214 | $acronym = $this->symbols['acronym']; 2215 | } 2216 | 2217 | // 3+ uppercase acronym 2218 | if ($acronym !== false) { 2219 | $this->glyph_search[] = '/\b(['.$this->regex_snippets['abr'].']['. 2220 | $this->regex_snippets['acr'].']{2,})\b(?:[(]([^)]*)[)])/'.$this->regex_snippets['mod']; 2221 | $this->glyph_replace[] = $this->replaceMarkers((string) $acronym, array( 2222 | 'title' => '$2', 2223 | 'content' => '$1', 2224 | )); 2225 | } 2226 | 2227 | // 3+ uppercase 2228 | if ($this->symbols['caps'] !== false) { 2229 | $this->glyph_search[] = '/('.$this->regex_snippets['space'].'|^|[>(;-])'. 2230 | '(['.$this->regex_snippets['abr'].']{3,})'. 2231 | '(['.$this->regex_snippets['nab'].']*)(?='. 2232 | $this->regex_snippets['space'].'|'.$pnc.'|<|$)'. 2233 | '(?=[^">]*?(<|$))/'.$this->regex_snippets['mod']; 2234 | $this->glyph_replace[] = $this->replaceMarkers('$1'.$this->symbols['caps'].'$3', array( 2235 | 'content' => $this->uid.':glyph:$2', 2236 | )); 2237 | } 2238 | 2239 | // Ellipsis 2240 | if ($this->symbols['ellipsis'] !== false) { 2241 | $this->glyph_search[] = '/([^.]?)\.{3}/'; 2242 | $this->glyph_replace[] = '$1'.$this->symbols['ellipsis']; 2243 | } 2244 | 2245 | // em dash 2246 | if ($this->symbols['emdash'] !== false) { 2247 | $this->glyph_search[] = '/--/'; 2248 | $this->glyph_replace[] = $this->symbols['emdash']; 2249 | } 2250 | 2251 | // en dash 2252 | if ($this->symbols['endash'] !== false) { 2253 | $this->glyph_search[] = '/ - /'; 2254 | $this->glyph_replace[] = ' '.$this->symbols['endash'].' '; 2255 | } 2256 | 2257 | // Trademark 2258 | if ($this->symbols['trademark'] !== false) { 2259 | $this->glyph_search[] = '/(\b ?|'.$this->regex_snippets['space'].'|^)[([]TM[])]/i'. 2260 | $this->regex_snippets['mod']; 2261 | $this->glyph_replace[] = '$1'.$this->symbols['trademark']; 2262 | } 2263 | 2264 | // Registered 2265 | if ($this->symbols['registered'] !== false) { 2266 | $this->glyph_search[] = '/(\b ?|'.$this->regex_snippets['space'].'|^)[([]R[])]/i'. 2267 | $this->regex_snippets['mod']; 2268 | $this->glyph_replace[] = '$1'.$this->symbols['registered']; 2269 | } 2270 | 2271 | // Copyright 2272 | if ($this->symbols['copyright'] !== false) { 2273 | $this->glyph_search[] = '/(\b ?|'.$this->regex_snippets['space'].'|^)[([]C[])]/i'. 2274 | $this->regex_snippets['mod']; 2275 | $this->glyph_replace[] = '$1'.$this->symbols['copyright']; 2276 | } 2277 | 2278 | // 1/4 2279 | if ($this->symbols['quarter'] !== false) { 2280 | $this->glyph_search[] = '/[([]1\/4[])]/'; 2281 | $this->glyph_replace[] = $this->symbols['quarter']; 2282 | } 2283 | 2284 | // 1/2 2285 | if ($this->symbols['half'] !== false) { 2286 | $this->glyph_search[] = '/[([]1\/2[])]/'; 2287 | $this->glyph_replace[] = $this->symbols['half']; 2288 | } 2289 | 2290 | // 3/4 2291 | if ($this->symbols['threequarters'] !== false) { 2292 | $this->glyph_search[] = '/[([]3\/4[])]/'; 2293 | $this->glyph_replace[] = $this->symbols['threequarters']; 2294 | } 2295 | 2296 | // Degrees -- that's a small 'oh' 2297 | if ($this->symbols['degrees'] !== false) { 2298 | $this->glyph_search[] = '/[([]o[])]/'; 2299 | $this->glyph_replace[] = $this->symbols['degrees']; 2300 | } 2301 | 2302 | // Plus minus 2303 | if ($this->symbols['plusminus'] !== false) { 2304 | $this->glyph_search[] = '/[([]\+\/-[])]/'; 2305 | $this->glyph_replace[] = $this->symbols['plusminus']; 2306 | } 2307 | 2308 | // No need to rebuild next run unless a symbol is redefined 2309 | $this->rebuild_glyphs = false; 2310 | } 2311 | 2312 | /** 2313 | * Gets the maximum allowed link index. 2314 | * 2315 | * @return int Maximum link index 2316 | * @since 3.5.5 2317 | */ 2318 | protected function getMaxLinkIndex() 2319 | { 2320 | return 1000000; 2321 | } 2322 | 2323 | /** 2324 | * Prepares the parser for parsing. 2325 | * 2326 | * This method prepares the transient internal state of 2327 | * Textile parser in preparation for parsing a new document. 2328 | * 2329 | * @param bool|null $lite Controls lite mode 2330 | * @param bool|null $noimage Disallow images 2331 | * @param string|null $rel A relationship attribute applied to links 2332 | * @return void 2333 | */ 2334 | protected function prepare($lite = null, $noimage = null, $rel = null) 2335 | { 2336 | if ($this->linkIndex >= $this->getMaxLinkIndex()) { 2337 | $this->linkPrefix .= '-'; 2338 | $this->linkIndex = 1; 2339 | } 2340 | 2341 | $this->unreferencedNotes = array(); 2342 | $this->notelist_cache = array(); 2343 | $this->notes = array(); 2344 | $this->urlrefs = array(); 2345 | $this->shelf = array(); 2346 | $this->fn = array(); 2347 | $this->span_depth = 0; 2348 | $this->refIndex = 1; 2349 | $this->refCache = array(); 2350 | $this->note_index = 1; 2351 | 2352 | if ($lite !== null) { 2353 | trigger_error( 2354 | '$lite argument is deprecated. Use Parser::setLite() instead.', 2355 | E_USER_DEPRECATED 2356 | ); 2357 | 2358 | $this->setLite($lite); 2359 | } 2360 | 2361 | if ($noimage !== null) { 2362 | trigger_error( 2363 | '$noimage argument is deprecated. Use Parser::setImages() instead.', 2364 | E_USER_DEPRECATED 2365 | ); 2366 | 2367 | $this->setImages(!$noimage); 2368 | } 2369 | 2370 | if ($rel !== null) { 2371 | trigger_error( 2372 | '$rel argument is deprecated. Use Parser::setRelative() instead.', 2373 | E_USER_DEPRECATED 2374 | ); 2375 | 2376 | $this->setLinkRelationShip($rel); 2377 | } 2378 | 2379 | if ($this->patterns === null) { 2380 | $block = implode('|', $this->blockContent); 2381 | $divider = implode('|', $this->dividerContent); 2382 | $phrasing = implode('|', $this->phrasingContent); 2383 | 2384 | $this->patterns = array( 2385 | 'block' => '/^(?:'.$block.')$/i', 2386 | 'contained' => '/^<\/?(?P
- ';
2943 | }
2944 | }
2945 |
2946 | if ($term !== '') {
2947 | $pos = strpos($def, "\n");
2948 | $def = trim($def);
2949 |
2950 | if ($this->isLineWrapEnabled()) {
2951 | $def = str_replace("\n", $this->getLineBreak(), $def);
2952 | }
2953 |
2954 | if ($pos === 0) {
2955 | $def = '
- $def "; 2969 | } 2970 | } 2971 | } 2972 | } 2973 | 2974 | $out[] = '
' . $def . '
'; 2956 | } 2957 | 2958 | if ($this->isLineWrapEnabled()) { 2959 | $term = str_replace("\n", $this->getLineBreak(), $term); 2960 | } 2961 | 2962 | $term = $this->graf($term); 2963 | $def = $this->graf($def); 2964 | 2965 | $out[] = "\t\n instances that are not followed by white-space, 3196 | // or at end, with single LF. 3197 | $m['content'] = preg_replace( 3198 | "~
or a space. 3205 | $m['content'] = preg_replace( 3206 | "/\n(?![\s|])/", 3207 | $this->isLineWrapEnabled() ? $this->getLineBreak() : ' ', 3208 | (string) $m['content'] 3209 | ); 3210 | 3211 | return '<'.$m['tag'].$m['atts'].'>'.$m['content'].$m['closetag']; 3212 | } 3213 | 3214 | /** 3215 | * Formats line breaks. 3216 | * 3217 | * @param array
|||)\n(?![\s|])@", 3224 | $this->isLineWrapEnabled() ? '$1'.$this->getLineBreak() : '$1 ', 3225 | $m['content'] 3226 | ); 3227 | 3228 | return '<'.$m['tag'].$m['atts'].'>'.$content.$m['closetag']; 3229 | } 3230 | 3231 | /** 3232 | * Splits the given input into blocks. 3233 | * 3234 | * Blocks are separated by double line-break boundaries, and processed 3235 | * the blocks one by one. 3236 | * 3237 | * @param string $text Textile source text 3238 | * @return string Input text with blocks processed 3239 | */ 3240 | protected function blocks($text) 3241 | { 3242 | $regex = '/^(?P
', '
', $block); 3330 | } 3331 | 3332 | // @phpstan-ignore-next-line 3333 | if ($ext && $anonymous_block) { 3334 | $out[count($out)-1] .= $block; 3335 | } elseif (!$eat) { 3336 | $out[] = $block; 3337 | } 3338 | 3339 | if ($eat) { 3340 | $eatWhitespace = true; 3341 | } else { 3342 | $whitespace = ''; 3343 | } 3344 | } 3345 | 3346 | // @phpstan-ignore-next-line 3347 | if ($ext) { 3348 | $out[count($out)-1] .= $c1; 3349 | } 3350 | 3351 | return join('', $out); 3352 | } 3353 | 3354 | /** 3355 | * Formats the given block. 3356 | * 3357 | * Adds block tags and formats the text content inside 3358 | * the block. 3359 | * 3360 | * @param array