mod/help.php

   1 <?php
   2 /**
   3  * @file mod/help.php
   4  */
   5
   6 use Friendica\App;
   7 use Friendica\Content\Nav;
   8 use Friendica\Content\Text\Markdown;
   9 use Friendica\Core\Config;
  10 use Friendica\Core\L10n;
  11 use Friendica\Core\Renderer;
  12 use Friendica\Core\System;
  13
  14 function load_doc_file($s)
  15 {
  16         $lang = Config::get('system', 'language');
  17         $b = basename($s);
  18         $d = dirname($s);
  19         if (file_exists("$d/$lang/$b")) {
  20                 return file_get_contents("$d/$lang/$b");
  21         }
  22
  23         if (file_exists($s)) {
  24                 return file_get_contents($s);
  25         }
  26
  27         return '';
  28 }
  29
  30 function help_content(App $a)
  31 {
  32         Nav::setSelected('help');
  33
  34         $text = '';
  35
  36         if ($a->argc > 1) {
  37                 $path = '';
  38                 // looping through the argv keys bigger than 0 to build
  39                 // a path relative to /help
  40                 for ($x = 1; $x < $a->argc; $x ++) {
  41                         if (strlen($path)) {
  42                                 $path .= '/';
  43                         }
  44
  45                         $path .= $a->getArgumentValue($x);
  46                 }
  47                 $title = basename($path);
  48                 $filename = $path;
  49                 $text = load_doc_file('doc/' . $path . '.md');
  50                 $a->page['title'] = L10n::t('Help:') . ' ' . str_replace('-', ' ', notags($title));
  51         }
  52
  53         $home = load_doc_file('doc/Home.md');
  54         if (!$text) {
  55                 $text = $home;
  56                 $filename = "Home";
  57                 $a->page['title'] = L10n::t('Help');
  58         } else {
  59                 $a->page['aside'] = Markdown::convert($home, false);
  60         }
  61
  62         if (!strlen($text)) {
  63                 header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . L10n::t('Not Found'));
  64                 $tpl = Renderer::getMarkupTemplate("404.tpl");
  65                 return Renderer::replaceMacros($tpl, [
  66                         '$message' => L10n::t('Page not found.')
  67                 ]);
  68         }
  69
  70         $html = Markdown::convert($text, false);
  71
  72         if ($filename !== "Home") {
  73                 // create TOC but not for home
  74                 $lines = explode("\n", $html);
  75                 $toc = "<h2>TOC</h2><ul id='toc'>";
  76                 $lastlevel = 1;
  77                 $idnum = [0, 0, 0, 0, 0, 0, 0];
  78                 foreach ($lines as &$line) {
  79                         if (substr($line, 0, 2) == "<h") {
  80                                 $level = substr($line, 2, 1);
  81                                 if ($level != "r") {
  82                                         $level = intval($level);
  83                                         if ($level < $lastlevel) {
  84                                                 for ($k = $level; $k < $lastlevel; $k++) {
  85                                                         $toc .= "</ul>";
  86                                                 }
  87
  88                                                 for ($k = $level + 1; $k < count($idnum); $k++) {
  89                                                         $idnum[$k] = 0;
  90                                                 }
  91                                         }
  92
  93                                         if ($level > $lastlevel) {
  94                                                 $toc .= "<ul>";
  95                                         }
  96
  97                                         $idnum[$level] ++;
  98                                         $id = implode("_", array_slice($idnum, 1, $level));
  99                                         $href = System::baseUrl() . "/help/{$filename}#{$id}";
 100                                         $toc .= "<li><a href='{$href}'>" . strip_tags($line) . "</a></li>";
 101                                         $line = "<a name='{$id}'></a>" . $line;
 102                                         $lastlevel = $level;
 103                                 }
 104                         }
 105                 }
 106
 107                 for ($k = 0; $k < $lastlevel; $k++) {
 108                         $toc .= "</ul>";
 109                 }
 110
 111                 $html = implode("\n", $lines);
 112
 113                 $a->page['aside'] = '<div class="help-aside-wrapper widget"><div id="toc-wrapper">' . $toc . '</div>' . $a->page['aside'] . '</div>';
 114         }
 115
 116         return $html;
 117 }