Merge pull request #7089 from nupplaphil/task/mod_help
Move mod/help to src/Module/Help
This commit is contained in:
GitHub
commit
0a8a614608
3 changed files with 123 additions and 115 deletions
115
mod/help.php
115
mod/help.php
|
|
@ -1,115 +0,0 @@
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* @file mod/help.php
|
|
||||||
*/
|
|
||||||
|
|
||||||
use Friendica\App;
|
|
||||||
use Friendica\Content\Nav;
|
|
||||||
use Friendica\Content\Text\Markdown;
|
|
||||||
use Friendica\Core\Config;
|
|
||||||
use Friendica\Core\L10n;
|
|
||||||
use Friendica\Core\Renderer;
|
|
||||||
use Friendica\Core\System;
|
|
||||||
use Friendica\Util\Strings;
|
|
||||||
|
|
||||||
function load_doc_file($s)
|
|
||||||
{
|
|
||||||
$lang = Config::get('system', 'language');
|
|
||||||
$b = basename($s);
|
|
||||||
$d = dirname($s);
|
|
||||||
if (file_exists("$d/$lang/$b")) {
|
|
||||||
return file_get_contents("$d/$lang/$b");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (file_exists($s)) {
|
|
||||||
return file_get_contents($s);
|
|
||||||
}
|
|
||||||
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
function help_content(App $a)
|
|
||||||
{
|
|
||||||
Nav::setSelected('help');
|
|
||||||
|
|
||||||
$text = '';
|
|
||||||
$filename = '';
|
|
||||||
|
|
||||||
if ($a->argc > 1) {
|
|
||||||
$path = '';
|
|
||||||
// looping through the argv keys bigger than 0 to build
|
|
||||||
// a path relative to /help
|
|
||||||
for ($x = 1; $x < $a->argc; $x ++) {
|
|
||||||
if (strlen($path)) {
|
|
||||||
$path .= '/';
|
|
||||||
}
|
|
||||||
|
|
||||||
$path .= $a->getArgumentValue($x);
|
|
||||||
}
|
|
||||||
$title = basename($path);
|
|
||||||
$filename = $path;
|
|
||||||
$text = load_doc_file('doc/' . $path . '.md');
|
|
||||||
$a->page['title'] = L10n::t('Help:') . ' ' . str_replace('-', ' ', Strings::escapeTags($title));
|
|
||||||
}
|
|
||||||
|
|
||||||
$home = load_doc_file('doc/Home.md');
|
|
||||||
if (!$text) {
|
|
||||||
$text = $home;
|
|
||||||
$filename = "Home";
|
|
||||||
$a->page['title'] = L10n::t('Help');
|
|
||||||
} else {
|
|
||||||
$a->page['aside'] = Markdown::convert($home, false);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!strlen($text)) {
|
|
||||||
throw new \Friendica\Network\HTTPException\NotFoundException();
|
|
||||||
}
|
|
||||||
|
|
||||||
$html = Markdown::convert($text, false);
|
|
||||||
|
|
||||||
if ($filename !== "Home") {
|
|
||||||
// create TOC but not for home
|
|
||||||
$lines = explode("\n", $html);
|
|
||||||
$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") {
|
|
||||||
$level = intval($level);
|
|
||||||
if ($level < $lastlevel) {
|
|
||||||
for ($k = $level; $k < $lastlevel; $k++) {
|
|
||||||
$toc .= "</ul></li>";
|
|
||||||
}
|
|
||||||
|
|
||||||
for ($k = $level + 1; $k < count($idnum); $k++) {
|
|
||||||
$idnum[$k] = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($level > $lastlevel) {
|
|
||||||
$toc .= "<li><ul>";
|
|
||||||
}
|
|
||||||
|
|
||||||
$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;
|
|
||||||
$lastlevel = $level;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for ($k = 0; $k < $lastlevel; $k++) {
|
|
||||||
$toc .= "</ul>";
|
|
||||||
}
|
|
||||||
|
|
||||||
$html = implode("\n", $lines);
|
|
||||||
|
|
||||||
$a->page['aside'] = '<div class="help-aside-wrapper widget"><div id="toc-wrapper">' . $toc . '</div>' . $a->page['aside'] . '</div>';
|
|
||||||
}
|
|
||||||
|
|
||||||
return $html;
|
|
||||||
}
|
|
||||||
|
|
@ -125,6 +125,7 @@ class Router
|
||||||
});
|
});
|
||||||
$this->routeCollector->addRoute(['GET'], '/hashtag', Module\Hashtag::class);
|
$this->routeCollector->addRoute(['GET'], '/hashtag', Module\Hashtag::class);
|
||||||
$this->routeCollector->addRoute(['GET'], '/home', Module\Home::class);
|
$this->routeCollector->addRoute(['GET'], '/home', Module\Home::class);
|
||||||
|
$this->routeCollector->addRoute(['GET'], '/help[/{doc:.+}]', Module\Help::class);
|
||||||
$this->routeCollector->addRoute(['GET'], '/inbox[/{nickname}]', Module\Inbox::class);
|
$this->routeCollector->addRoute(['GET'], '/inbox[/{nickname}]', Module\Inbox::class);
|
||||||
$this->routeCollector->addRoute(['GET', 'POST'], '/invite', Module\Invite::class);
|
$this->routeCollector->addRoute(['GET', 'POST'], '/invite', Module\Invite::class);
|
||||||
$this->routeCollector->addGroup('/install', function (RouteCollector $collector) {
|
$this->routeCollector->addGroup('/install', function (RouteCollector $collector) {
|
||||||
|
|
|
||||||
122
src/Module/Help.php
Normal file
122
src/Module/Help.php
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Friendica\Module;
|
||||||
|
|
||||||
|
use Friendica\BaseModule;
|
||||||
|
use Friendica\Content\Nav;
|
||||||
|
use Friendica\Content\Text\Markdown;
|
||||||
|
use Friendica\Core\L10n;
|
||||||
|
use Friendica\Network\HTTPException;
|
||||||
|
use Friendica\Util\Strings;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shows the friendica help based on the /doc/ directory
|
||||||
|
*/
|
||||||
|
class Help extends BaseModule
|
||||||
|
{
|
||||||
|
public static function content()
|
||||||
|
{
|
||||||
|
Nav::setSelected('help');
|
||||||
|
|
||||||
|
$text = '';
|
||||||
|
$filename = '';
|
||||||
|
|
||||||
|
$app = self::getApp();
|
||||||
|
$config = $app->getConfig();
|
||||||
|
$lang = $config->get('system', 'language');
|
||||||
|
|
||||||
|
// @TODO: Replace with parameter from router
|
||||||
|
if ($app->argc > 1) {
|
||||||
|
$path = '';
|
||||||
|
// looping through the argv keys bigger than 0 to build
|
||||||
|
// a path relative to /help
|
||||||
|
for ($x = 1; $x < $app->argc; $x ++) {
|
||||||
|
if (strlen($path)) {
|
||||||
|
$path .= '/';
|
||||||
|
}
|
||||||
|
|
||||||
|
$path .= $app->getArgumentValue($x);
|
||||||
|
}
|
||||||
|
$title = basename($path);
|
||||||
|
$filename = $path;
|
||||||
|
$text = self::loadDocFile('doc/' . $path . '.md', $lang);
|
||||||
|
$app->page['title'] = L10n::t('Help:') . ' ' . str_replace('-', ' ', Strings::escapeTags($title));
|
||||||
|
}
|
||||||
|
|
||||||
|
$home = self::loadDocFile('doc/Home.md', $lang);
|
||||||
|
if (!$text) {
|
||||||
|
$text = $home;
|
||||||
|
$filename = "Home";
|
||||||
|
$app->page['title'] = L10n::t('Help');
|
||||||
|
} else {
|
||||||
|
$app->page['aside'] = Markdown::convert($home, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!strlen($text)) {
|
||||||
|
throw new HTTPException\NotFoundException();
|
||||||
|
}
|
||||||
|
|
||||||
|
$html = Markdown::convert($text, false);
|
||||||
|
|
||||||
|
if ($filename !== "Home") {
|
||||||
|
// create TOC but not for home
|
||||||
|
$lines = explode("\n", $html);
|
||||||
|
$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") {
|
||||||
|
$level = intval($level);
|
||||||
|
if ($level < $lastLevel) {
|
||||||
|
for ($k = $level; $k < $lastLevel; $k++) {
|
||||||
|
$toc .= "</ul></li>";
|
||||||
|
}
|
||||||
|
|
||||||
|
for ($k = $level + 1; $k < count($idNum); $k++) {
|
||||||
|
$idNum[$k] = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($level > $lastLevel) {
|
||||||
|
$toc .= "<li><ul>";
|
||||||
|
}
|
||||||
|
|
||||||
|
$idNum[$level] ++;
|
||||||
|
$id = implode("_", array_slice($idNum, 1, $level));
|
||||||
|
$href = $app->getBaseURL() . "/help/{$filename}#{$id}";
|
||||||
|
$toc .= "<li><a href='{$href}'>" . strip_tags($line) . "</a></li>";
|
||||||
|
$line = "<a name='{$id}'></a>" . $line;
|
||||||
|
$lastLevel = $level;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for ($k = 0; $k < $lastLevel; $k++) {
|
||||||
|
$toc .= "</ul>";
|
||||||
|
}
|
||||||
|
|
||||||
|
$html = implode("\n", $lines);
|
||||||
|
|
||||||
|
$a->page['aside'] = '<div class="help-aside-wrapper widget"><div id="toc-wrapper">' . $toc . '</div>' . $a->page['aside'] . '</div>';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $html;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function loadDocFile($fileName, $lang = 'en')
|
||||||
|
{
|
||||||
|
$baseName = basename($fileName);
|
||||||
|
$dirName = dirname($fileName);
|
||||||
|
if (file_exists("$dirName/$lang/$baseName")) {
|
||||||
|
return file_get_contents("$dirName/$lang/$baseName");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (file_exists($fileName)) {
|
||||||
|
return file_get_contents($fileName);
|
||||||
|
}
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue