2011-04-13 14:07:21 +00:00
|
|
|
<?php
|
2018-01-15 19:51:56 +00:00
|
|
|
/**
|
|
|
|
* @file mod/help.php
|
|
|
|
*/
|
2018-07-10 01:53:19 +00:00
|
|
|
|
2017-04-30 04:07:00 +00:00
|
|
|
use Friendica\App;
|
2018-01-15 19:51:56 +00:00
|
|
|
use Friendica\Content\Nav;
|
2018-01-14 23:59:08 +00:00
|
|
|
use Friendica\Content\Text\Markdown;
|
2018-07-10 02:37:51 +00:00
|
|
|
use Friendica\Core\Config;
|
2018-01-22 12:29:50 +00:00
|
|
|
use Friendica\Core\L10n;
|
2018-10-31 14:35:50 +00:00
|
|
|
use Friendica\Core\Renderer;
|
2017-08-26 06:04:21 +00:00
|
|
|
use Friendica\Core\System;
|
2018-11-08 15:14:37 +00:00
|
|
|
use Friendica\Util\Strings;
|
2017-04-30 04:07:00 +00:00
|
|
|
|
2018-07-10 01:53:19 +00:00
|
|
|
function load_doc_file($s)
|
|
|
|
{
|
2018-07-10 02:37:51 +00:00
|
|
|
$lang = Config::get('system', 'language');
|
2018-07-10 01:53:19 +00:00
|
|
|
$b = basename($s);
|
|
|
|
$d = dirname($s);
|
|
|
|
if (file_exists("$d/$lang/$b")) {
|
|
|
|
return file_get_contents("$d/$lang/$b");
|
2012-11-09 08:56:45 +00:00
|
|
|
}
|
|
|
|
|
2018-07-10 01:53:19 +00:00
|
|
|
if (file_exists($s)) {
|
|
|
|
return file_get_contents($s);
|
|
|
|
}
|
2011-04-13 14:07:21 +00:00
|
|
|
|
2018-07-10 01:53:19 +00:00
|
|
|
return '';
|
|
|
|
}
|
2015-02-23 22:56:44 +00:00
|
|
|
|
2018-07-10 01:53:19 +00:00
|
|
|
function help_content(App $a)
|
|
|
|
{
|
2018-01-15 19:51:56 +00:00
|
|
|
Nav::setSelected('help');
|
2011-04-13 14:07:21 +00:00
|
|
|
|
|
|
|
$text = '';
|
2019-01-07 17:51:48 +00:00
|
|
|
$filename = '';
|
2011-04-13 14:07:21 +00:00
|
|
|
|
2012-11-09 08:56:45 +00:00
|
|
|
if ($a->argc > 1) {
|
2015-12-26 15:06:38 +00:00
|
|
|
$path = '';
|
2015-12-28 02:17:55 +00:00
|
|
|
// looping through the argv keys bigger than 0 to build
|
|
|
|
// a path relative to /help
|
2018-10-13 16:57:31 +00:00
|
|
|
for ($x = 1; $x < $a->argc; $x ++) {
|
2018-07-10 01:53:19 +00:00
|
|
|
if (strlen($path)) {
|
2015-12-26 15:06:38 +00:00
|
|
|
$path .= '/';
|
2018-07-10 01:53:19 +00:00
|
|
|
}
|
|
|
|
|
2018-10-13 16:57:31 +00:00
|
|
|
$path .= $a->getArgumentValue($x);
|
2015-12-26 15:06:38 +00:00
|
|
|
}
|
|
|
|
$title = basename($path);
|
2015-12-28 09:13:28 +00:00
|
|
|
$filename = $path;
|
2015-12-26 15:06:38 +00:00
|
|
|
$text = load_doc_file('doc/' . $path . '.md');
|
2018-11-09 18:29:42 +00:00
|
|
|
$a->page['title'] = L10n::t('Help:') . ' ' . str_replace('-', ' ', Strings::escapeTags($title));
|
2011-04-14 09:34:43 +00:00
|
|
|
}
|
2018-07-10 01:53:19 +00:00
|
|
|
|
2012-11-09 08:56:45 +00:00
|
|
|
$home = load_doc_file('doc/Home.md');
|
|
|
|
if (!$text) {
|
|
|
|
$text = $home;
|
2015-12-28 09:13:28 +00:00
|
|
|
$filename = "Home";
|
2018-01-22 12:29:50 +00:00
|
|
|
$a->page['title'] = L10n::t('Help');
|
2012-11-09 08:56:45 +00:00
|
|
|
} else {
|
2018-01-14 23:59:08 +00:00
|
|
|
$a->page['aside'] = Markdown::convert($home, false);
|
2011-04-13 14:07:21 +00:00
|
|
|
}
|
2012-11-09 08:56:45 +00:00
|
|
|
|
|
|
|
if (!strlen($text)) {
|
2018-01-22 12:29:50 +00:00
|
|
|
header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . L10n::t('Not Found'));
|
2018-10-31 14:44:06 +00:00
|
|
|
$tpl = Renderer::getMarkupTemplate("404.tpl");
|
2018-10-31 14:35:50 +00:00
|
|
|
return Renderer::replaceMacros($tpl, [
|
2018-07-10 01:53:19 +00:00
|
|
|
'$message' => L10n::t('Page not found.')
|
|
|
|
]);
|
2011-08-16 03:16:00 +00:00
|
|
|
}
|
2015-02-23 22:56:44 +00:00
|
|
|
|
2018-01-14 23:59:08 +00:00
|
|
|
$html = Markdown::convert($text, false);
|
2015-12-28 09:13:28 +00:00
|
|
|
|
2015-12-28 09:21:34 +00:00
|
|
|
if ($filename !== "Home") {
|
|
|
|
// create TOC but not for home
|
|
|
|
$lines = explode("\n", $html);
|
2018-07-10 01:53:19 +00:00
|
|
|
$toc = "<h2>TOC</h2><ul id='toc'>";
|
|
|
|
$lastlevel = 1;
|
|
|
|
$idnum = [0, 0, 0, 0, 0, 0, 0];
|
|
|
|
foreach ($lines as &$line) {
|
|
|
|
if (substr($line, 0, 2) == "<h") {
|
|
|
|
$level = substr($line, 2, 1);
|
|
|
|
if ($level != "r") {
|
2015-12-28 09:21:34 +00:00
|
|
|
$level = intval($level);
|
2018-07-10 01:53:19 +00:00
|
|
|
if ($level < $lastlevel) {
|
|
|
|
for ($k = $level; $k < $lastlevel; $k++) {
|
|
|
|
$toc .= "</ul>";
|
|
|
|
}
|
|
|
|
|
|
|
|
for ($k = $level + 1; $k < count($idnum); $k++) {
|
|
|
|
$idnum[$k] = 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($level > $lastlevel) {
|
|
|
|
$toc .= "<ul>";
|
2015-12-28 09:21:34 +00:00
|
|
|
}
|
2018-07-10 01:53:19 +00:00
|
|
|
|
|
|
|
$idnum[$level] ++;
|
|
|
|
$id = implode("_", array_slice($idnum, 1, $level));
|
|
|
|
$href = System::baseUrl() . "/help/{$filename}#{$id}";
|
|
|
|
$toc .= "<li><a href='{$href}'>" . strip_tags($line) . "</a></li>";
|
|
|
|
$line = "<a name='{$id}'></a>" . $line;
|
2015-12-28 09:21:34 +00:00
|
|
|
$lastlevel = $level;
|
2015-12-28 09:13:28 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2018-07-10 01:53:19 +00:00
|
|
|
|
|
|
|
for ($k = 0; $k < $lastlevel; $k++) {
|
|
|
|
$toc .= "</ul>";
|
|
|
|
}
|
|
|
|
|
|
|
|
$html = implode("\n", $lines);
|
2015-12-28 09:13:28 +00:00
|
|
|
|
2018-04-25 21:30:56 +00:00
|
|
|
$a->page['aside'] = '<div class="help-aside-wrapper widget"><div id="toc-wrapper">' . $toc . '</div>' . $a->page['aside'] . '</div>';
|
2015-12-28 09:21:34 +00:00
|
|
|
}
|
2015-12-28 09:13:28 +00:00
|
|
|
|
2012-11-09 08:56:45 +00:00
|
|
|
return $html;
|
2011-08-17 16:36:24 +00:00
|
|
|
}
|