src/Module/Help.php

   1 <?php
   2
   3 namespace Friendica\Module;
   4
   5 use Friendica\BaseModule;
   6 use Friendica\Content\Nav;
   7 use Friendica\Content\Text\Markdown;
   8 use Friendica\Core\L10n;
   9 use Friendica\Network\HTTPException;
  10 use Friendica\Util\Strings;
  11
  12 /**
  13  * Shows the friendica help based on the /doc/ directory
  14  */
  15 class Help extends BaseModule
  16 {
  17         public static function content(array $parameters = [])
  18         {
  19                 Nav::setSelected('help');
  20
  21                 $text = '';
  22                 $filename = '';
  23
  24                 $a = self::getApp();
  25                 $config = $a->getConfig();
  26                 $lang = $config->get('system', 'language');
  27
  28                 // @TODO: Replace with parameter from router
  29                 if ($a->argc > 1) {
  30                         $path = '';
  31                         // looping through the argv keys bigger than 0 to build
  32                         // a path relative to /help
  33                         for ($x = 1; $x < $a->argc; $x ++) {
  34                                 if (strlen($path)) {
  35                                         $path .= '/';
  36                                 }
  37
  38                                 $path .= $a->getArgumentValue($x);
  39                         }
  40                         $title = basename($path);
  41                         $filename = $path;
  42                         $text = self::loadDocFile('doc/' . $path . '.md', $lang);
  43                         $a->page['title'] = L10n::t('Help:') . ' ' . str_replace('-', ' ', Strings::escapeTags($title));
  44                 }
  45
  46                 $home = self::loadDocFile('doc/Home.md', $lang);
  47                 if (!$text) {
  48                         $text = $home;
  49                         $filename = "Home";
  50                         $a->page['title'] = L10n::t('Help');
  51                 } else {
  52                         $a->page['aside'] = Markdown::convert($home, false);
  53                 }
  54
  55                 if (!strlen($text)) {
  56                         throw new HTTPException\NotFoundException();
  57                 }
  58
  59                 $html = Markdown::convert($text, false);
  60
  61                 if ($filename !== "Home") {
  62                         // create TOC but not for home
  63                         $lines = explode("\n", $html);
  64                         $toc = "<h2>TOC</h2><ul id='toc'>";
  65                         $lastLevel = 1;
  66                         $idNum = [0, 0, 0, 0, 0, 0, 0];
  67                         foreach ($lines as &$line) {
  68                                 if (substr($line, 0, 2) == "<h") {
  69                                         $level = substr($line, 2, 1);
  70                                         if ($level != "r") {
  71                                                 $level = intval($level);
  72                                                 if ($level < $lastLevel) {
  73                                                         for ($k = $level; $k < $lastLevel; $k++) {
  74                                                                 $toc .= "</ul></li>";
  75                                                         }
  76
  77                                                         for ($k = $level + 1; $k < count($idNum); $k++) {
  78                                                                 $idNum[$k] = 0;
  79                                                         }
  80                                                 }
  81
  82                                                 if ($level > $lastLevel) {
  83                                                         $toc .= "<li><ul>";
  84                                                 }
  85
  86                                                 $idNum[$level] ++;
  87                                                 $id = implode("_", array_slice($idNum, 1, $level));
  88                                                 $href = $a->getBaseURL() . "/help/{$filename}#{$id}";
  89                                                 $toc .= "<li><a href='{$href}'>" . strip_tags($line) . "</a></li>";
  90                                                 $line = "<a name='{$id}'></a>" . $line;
  91                                                 $lastLevel = $level;
  92                                         }
  93                                 }
  94                         }
  95
  96                         for ($k = 0; $k < $lastLevel; $k++) {
  97                                 $toc .= "</ul>";
  98                         }
  99
 100                         $html = implode("\n", $lines);
 101
 102                         $a->page['aside'] = '<div class="help-aside-wrapper widget"><div id="toc-wrapper">' . $toc . '</div>' . $a->page['aside'] . '</div>';
 103                 }
 104
 105                 return $html;
 106         }
 107
 108         private static function loadDocFile($fileName, $lang = 'en')
 109         {
 110                 $baseName = basename($fileName);
 111                 $dirName = dirname($fileName);
 112                 if (file_exists("$dirName/$lang/$baseName")) {
 113                         return file_get_contents("$dirName/$lang/$baseName");
 114                 }
 115
 116                 if (file_exists($fileName)) {
 117                         return file_get_contents($fileName);
 118                 }
 119
 120                 return '';
 121         }
 122 }