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