mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-05-04 22:19:38 +00:00
5c96b528ba
Forum:34645 Bug:5 git-svn-id: https://svn.fhem.de/fhem/trunk@8148 2b470e98-0d58-463d-a4d8-8e2adae1ed80
252 lines
6.3 KiB
Perl
252 lines
6.3 KiB
Perl
# $Id$
|
|
#
|
|
package main;
|
|
use strict;
|
|
use warnings;
|
|
use Data::Dumper;
|
|
|
|
my $ret;
|
|
|
|
sub CommandHelp;
|
|
sub cref_search;
|
|
sub cref_search_cmd;
|
|
|
|
sub help_Initialize($$) {
|
|
my %hash = ( Fn => "CommandHelp",
|
|
Hlp => "[<moduleName>],get help (this screen or module dependent docu)",
|
|
InternalCmds => "attributes,command,commands,devspec,global,perl" );
|
|
$cmds{help} = \%hash;
|
|
}
|
|
|
|
sub CommandHelp {
|
|
my ($cl, $arg) = @_;
|
|
|
|
my ($mod,$lang) = split(" ",$arg);
|
|
|
|
$lang //= AttrVal('global','language','en');
|
|
$lang = (lc($lang) eq 'de') ? '_DE' : '';
|
|
|
|
$mod =~ s/\?/help/;
|
|
|
|
if($mod) {
|
|
|
|
my $internals = "attributes,command,commands,devspec,global,perl";
|
|
$mod = lc($mod);
|
|
my $modPath = AttrVal('global','modpath','.');
|
|
my $output = '';
|
|
|
|
if($cmds{help}{InternalCmds} !~ m/$mod\,/) {
|
|
my %mods;
|
|
my @modDir = ("$modPath/FHEM");
|
|
|
|
$mod = $cmds{$mod}{ModuleName} if defined($cmds{$mod}{ModuleName});
|
|
|
|
foreach my $modDir (@modDir) {
|
|
eval { opendir(DH, $modDir); }; # || die "Cant open $modDir: $!\n";
|
|
while(my $l = readdir DH) {
|
|
next if($l !~ m/^\d\d_.*\.pm$/);
|
|
my $of = $l;
|
|
$l =~ s/.pm$//;
|
|
$l =~ s/^[0-9][0-9]_//;
|
|
$mods{lc($l)} = "$modDir/$of";
|
|
}
|
|
}
|
|
|
|
return "Module $mod not found" unless defined($mods{$mod});
|
|
|
|
# read commandref docu from file
|
|
$output = cref_search($mods{$mod},$lang);
|
|
|
|
unless($output) {
|
|
$output = cref_search($mods{$mod},"");
|
|
$output = "Keine deutsche Hilfe gefunden!<br/>$output" if $output;
|
|
}
|
|
|
|
$output = "No help found for module: $mod" unless $output;
|
|
|
|
} else {
|
|
|
|
$output = '';
|
|
my $i;
|
|
my $f = "$modPath/docs/commandref_frame$lang.html";
|
|
my $skip = 1;
|
|
my ($err,@text) = FileRead({FileName => $f, ForceType => 'file'});
|
|
return $err if $err;
|
|
|
|
foreach my $l (@text) {
|
|
if($l =~ m/^<a name=\"$mod\"/) {
|
|
$skip = 0;
|
|
} elsif($l =~ m/^<!-- $mod.end/) {
|
|
$skip = 1;
|
|
} elsif (!$skip) {
|
|
$output .= $l;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
if( $cl && $cl->{TYPE} eq 'telnet' ) {
|
|
$output =~ s/<br>/\n/g;
|
|
$output =~ s/<br\/>/\n/g;
|
|
$output =~ s/<table>//g;
|
|
$output =~ s/<\/table>//g;
|
|
$output =~ s/<t.>//g;
|
|
$output =~ s/<\/t.>//g;
|
|
$output =~ s/<h.>//g;
|
|
$output =~ s/<\/h.>//g;
|
|
$output =~ s/<a href.*\/a>//g;
|
|
$output =~ s/<a name.*\/a>//g;
|
|
$output =~ s/<ul>/\n/g;
|
|
$output =~ s/<\/ul>/\n/g;
|
|
$output =~ s/<li>/-/g;
|
|
$output =~ s/<\/li>/\n/g;
|
|
$output =~ s/<code>//g;
|
|
$output =~ s/<\/code>//g;
|
|
$output =~ s/<pre>//ig;
|
|
$output =~ s/<\/pre>//ig;
|
|
$output =~ s/</</g;
|
|
$output =~ s/>/>/g;
|
|
$output =~ s/<[bui]>//g;
|
|
$output =~ s/<\/[bui]>//g;
|
|
$output =~ tr/ / /s;
|
|
$output =~ s/\n\n\ /\n/g;
|
|
$output =~ s/ä/ä/g;
|
|
$output =~ s/Ä/Ä/g;
|
|
$output =~ s/ö/ö/g;
|
|
$output =~ s/Ö/Ö/g;
|
|
$output =~ s/ü/ü/g;
|
|
$output =~ s/Ü/Ü/g;
|
|
$output =~ s/ß/ß/g;
|
|
|
|
return $output;
|
|
}
|
|
|
|
return "<html>$output</html>";
|
|
|
|
} else { # mod
|
|
|
|
cref_search_cmd(undef);
|
|
|
|
my $str = "Possible commands:\n\n" .
|
|
"Command Parameter\n" .
|
|
" Description\n" .
|
|
"----------------------------------------------------------------------\n";
|
|
|
|
for my $cmd (sort keys %cmds) {
|
|
next if(!$cmds{$cmd}{Hlp});
|
|
next if($cl && $cmds{$cmd}{ClientFilter} &&
|
|
$cl->{TYPE} !~ m/$cmds{$cmd}{ClientFilter}/);
|
|
my @a = split(",", $cmds{$cmd}{Hlp}, 2);
|
|
# $a[0] =~ s/</</g;
|
|
# $a[0] =~ s/>/>/g;
|
|
$a[1] //= "";
|
|
$a[1] = " $a[1]";
|
|
$a[1] =~ s/</</g;
|
|
$a[1] =~ s/>/>/g;
|
|
$str .= sprintf("%-15s%-50s\n%s\n", $cmd, $a[0], $a[1]);
|
|
}
|
|
|
|
return $str;
|
|
|
|
}
|
|
}
|
|
|
|
sub cref_search {
|
|
my ($mod,$lang) = @_;
|
|
my $output = "";
|
|
my $skip = 1;
|
|
my ($err,@text) = FileRead({FileName => $mod, ForceType => 'file'});
|
|
return $err if $err;
|
|
foreach my $l (@text) {
|
|
if($l =~ m/^=begin html$lang$/) {
|
|
$skip = 0;
|
|
} elsif($l =~ m/^=end html$lang$/) {
|
|
$skip = 1;
|
|
} elsif(!$skip) {
|
|
$output .= "$l\n";
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
sub cref_search_cmd {
|
|
my $skip = 1;
|
|
my $mod = "./docs/commandref_frame.html";
|
|
my ($err,@text) = FileRead({FileName => $mod, ForceType => 'file'});
|
|
return $err if $err;
|
|
foreach my $l (@text) {
|
|
if($l =~ m/<b>Fhem commands<\/b>/) {
|
|
$skip = 0;
|
|
} elsif($l =~ m/<\/ul>/) {
|
|
$skip = 1;
|
|
} elsif(!$skip && $l !~ m/<ul>/) {
|
|
$l =~ s/\?\,help//;
|
|
$l =~ s/<a.*">//;
|
|
$l =~ s/<\/a>.*//;
|
|
$l =~ s/ //g;
|
|
unless (defined($cmds{$l}{Hlp}) && $cmds{$l}{Hlp}) {
|
|
my %hash = ( Hlp => "use \"help $l\" for more help");
|
|
$cmds{$l} = \%hash if $l;
|
|
}
|
|
}
|
|
}
|
|
foreach my $i (split(",",$cmds{help}{InternalCmds})) {
|
|
my %hash = ( Hlp => "use \"help $i\" for more help");
|
|
$cmds{$i} = \%hash if $i;
|
|
}
|
|
return;
|
|
}
|
|
|
|
|
|
1;
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="help"></a>
|
|
<h3>?, help</h3>
|
|
<ul>
|
|
<code>? [<moduleName>] [<language>]</code><br/>
|
|
<code>help [<moduleName>] [<language>]</code><br/>
|
|
<br/>
|
|
<ul>
|
|
<li>Returns a list of available commands, when called without a
|
|
moduleName.</li>
|
|
<li>Returns a module dependent helptext, same as in commandref.</li>
|
|
<li>language will be determined in following order:
|
|
<ul>
|
|
<li>valid parameter <language> given</li>
|
|
<li>global attribute language</li>
|
|
<li>nothing founde: return english</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
=end html
|
|
|
|
=begin html_DE
|
|
|
|
<a name="help"></a>
|
|
<h3>?, help</h3>
|
|
<ul>
|
|
<code>? [<moduleName>] [<language>]</code><br/>
|
|
<code>help [<moduleName>] [<language>]</code><br/>
|
|
<br>
|
|
<ul>
|
|
<li>Liefert eine Liste aller Befehle mit einer Kurzbeschreibung zurück.</li>
|
|
<li>Falls moduleName spezifiziert ist, wird die modul-spezifische Hilfe
|
|
aus commandref zurückgeliefert.</li>
|
|
<li>Die anzuzeigende Sprache wird in folgender Reihenfolge bestimmt:
|
|
<ul>
|
|
<li>gültiger Parameter <language> beim Aufruf übergeben</li>
|
|
<li>globales Attribut language</li>
|
|
<li>falls alles fehlt: englisch</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
=end html_DE
|
|
|
|
=cut
|