# $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 => "[],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!
$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/^{TYPE} eq 'telnet' ) { $output =~ s/
/\n/g; $output =~ s//\n/g; $output =~ s///g; $output =~ s/<\/table>//g; $output =~ s///g; $output =~ s/<\/t.>//g; $output =~ s///g; $output =~ s/<\/h.>//g; $output =~ s///g; $output =~ s///g; $output =~ s/

/\n/g; $output =~ s/<\/ul>/\n/g; $output =~ s/

/-/g; $output =~ s/<\/li>/\n/g; $output =~ s/

//g;
    $output =~ s/<\/code>//g;
    $output =~ s/

//ig;
    $output =~ s/<\/pre>//ig;
    $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 "$output";

  } 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[1] //= "";
      $a[1]  = "               $a[1]";
      $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/Fhem commands<\/b>/) {
	    $skip = 0;
     } elsif($l =~ m/<\/ul>/) {
        $skip = 1;
     } elsif(!$skip && $l !~ m//) {
        $l =~ s/\?\,help//;
        $l =~ s///;
        $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


?, help
  
    ? [<moduleName>] []

    help [<moduleName>] []

    

    
      Returns a list of available commands, when called without a
        moduleName.
      Returns a module dependent helptext, same as in commandref.
      language will be determined in following order: 
         
         valid parameter <language> given
         global attribute language
         nothing founde: return english
         
      
    
  

=end html

=begin html_DE


?, help
  
    ? [<moduleName>] []

    help [<moduleName>] []

    

    
      Liefert eine Liste aller Befehle mit einer Kurzbeschreibung zurück.
      Falls moduleName spezifiziert ist, wird die modul-spezifische Hilfe
          aus commandref zurückgeliefert.
      Die anzuzeigende Sprache wird in folgender Reihenfolge bestimmt: 
         
         gültiger Parameter <language> beim Aufruf übergeben
         globales Attribut language
         falls alles fehlt: englisch
         
      
    
  
=end html_DE

=cut