InstallDocFormatter.php 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?php
  2. /**
  3. * Installer-specific wikitext formatting.
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License along
  16. * with this program; if not, write to the Free Software Foundation, Inc.,
  17. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18. * http://www.gnu.org/copyleft/gpl.html
  19. *
  20. * @file
  21. */
  22. class InstallDocFormatter {
  23. public static function format( $text ) {
  24. $obj = new self( $text );
  25. return $obj->execute();
  26. }
  27. protected function __construct( $text ) {
  28. $this->text = $text;
  29. }
  30. protected function execute() {
  31. $text = $this->text;
  32. // Use Unix line endings, escape some wikitext stuff
  33. $text = str_replace( [ '<', '{{', '[[', '__', "\r" ],
  34. [ '&lt;', '&#123;&#123;', '&#91;&#91;', '&#95;&#95;', '' ], $text );
  35. // join word-wrapped lines into one
  36. do {
  37. $prev = $text;
  38. $text = preg_replace( "/\n([\\*#\t])([^\n]*?)\n([^\n#\\*:]+)/", "\n\\1\\2 \\3", $text );
  39. } while ( $text != $prev );
  40. // Replace tab indents with colons
  41. $text = preg_replace( '/^\t\t/m', '::', $text );
  42. $text = preg_replace( '/^\t/m', ':', $text );
  43. $linkStart = '<span class="config-plainlink">[';
  44. $linkEnd = ' $0]</span>';
  45. // turn (Tnnnn) into links
  46. $text = preg_replace(
  47. '/T\d+/',
  48. "{$linkStart}https://phabricator.wikimedia.org/$0{$linkEnd}",
  49. $text
  50. );
  51. // turn (bug nnnn) into links
  52. $text = preg_replace(
  53. '/bug (\d+)/',
  54. "{$linkStart}https://bugzilla.wikimedia.org/$1{$linkEnd}",
  55. $text
  56. );
  57. // add links to manual to every global variable mentioned
  58. $text = preg_replace(
  59. '/\$wg[a-z0-9_]+/i',
  60. "{$linkStart}https://www.mediawiki.org/wiki/Manual:$0{$linkEnd}",
  61. $text
  62. );
  63. return $text;
  64. }
  65. }