| 1 |
#! perl # mandatory depends=doclet |
| 2 |
|
| 3 |
our $TOPIC; |
| 4 |
our %DOCLET; |
| 5 |
|
| 6 |
our $HELP_CHANNEL = { |
| 7 |
id => "help", |
| 8 |
title => "Help", |
| 9 |
reply => "help ", |
| 10 |
tooltip => "Online Help", |
| 11 |
}; |
| 12 |
|
| 13 |
# considerable duplication between load_doclets and load_topics |
| 14 |
sub load_doclets { |
| 15 |
%DOCLET = (); |
| 16 |
|
| 17 |
my %command_list; |
| 18 |
|
| 19 |
for ( |
| 20 |
[standard => "command_help"], |
| 21 |
[emote => "emote_help"], |
| 22 |
[dm => "dmcommand_help"], |
| 23 |
) { |
| 24 |
my ($type, $path) = @$_; |
| 25 |
|
| 26 |
my $paragraphs = cf::pod::load_pod "$PODDIR/$path.pod" |
| 27 |
or die "unable to load $path"; |
| 28 |
|
| 29 |
my $level = 1e9; |
| 30 |
my $rpar; |
| 31 |
|
| 32 |
for my $par (@$paragraphs) { |
| 33 |
if ($par->{type} eq "head2") { |
| 34 |
# this code taken almost verbatim from DC/Protocol.pm |
| 35 |
|
| 36 |
if ($par->{markup} =~ /^(\S+) (?:\s+ \( ([^\)]*) \) )?/x) { |
| 37 |
my $cmd = $1; |
| 38 |
my @args = split /\|/, $2; |
| 39 |
@args = (".*") unless @args; |
| 40 |
|
| 41 |
$_ = $_ eq ".*" ? "" : " $_" |
| 42 |
for @args; |
| 43 |
|
| 44 |
my @variants = map "$cmd$_", sort { (length $a) <=> (length $b) } @args; |
| 45 |
|
| 46 |
$rpar = \($DOCLET{$cmd} = &cf::pod::as_cfpod ([$par])); |
| 47 |
|
| 48 |
push @{ $command_list{$type} }, @variants; |
| 49 |
$level = $par->{level}; |
| 50 |
} else { |
| 51 |
cf::error "$par->{markup}: unparsable command heading"; |
| 52 |
} |
| 53 |
} elsif ($par->{level} > $level) { |
| 54 |
$$rpar .= &cf::pod::as_cfpod ([$par]); |
| 55 |
} |
| 56 |
|
| 57 |
cf::cede_to_tick; |
| 58 |
} |
| 59 |
} |
| 60 |
|
| 61 |
cf::cede_to_tick; |
| 62 |
|
| 63 |
while (my ($k, $v) = each %command_list) { |
| 64 |
cf::client::set_command_face $k, $v |
| 65 |
} |
| 66 |
} |
| 67 |
|
| 68 |
our $DOCLET_HANDLER = ext::doclet::register command => sub { |
| 69 |
my ($pl, $category, $command) = @_; |
| 70 |
|
| 71 |
my $guard = cf::lock_acquire "ext::help::loading"; |
| 72 |
|
| 73 |
$DOCLET{$command} |
| 74 |
|| "B<No documentation available for '$category/$command'>" |
| 75 |
}; |
| 76 |
|
| 77 |
sub load_topics($$) { |
| 78 |
my ($type, $path) = @_; |
| 79 |
|
| 80 |
my $paragraphs = cf::pod::load_pod "$PODDIR/$path.pod" |
| 81 |
or die "unable to load $path"; |
| 82 |
|
| 83 |
my @topics; |
| 84 |
my $level = 1e9; |
| 85 |
|
| 86 |
for my $par (@$paragraphs) { |
| 87 |
cf::cede_to_tick; |
| 88 |
if ($par->{type} eq "head2") { |
| 89 |
if ($par->{markup} =~ /^(\S+)/) { |
| 90 |
push @topics, $1 => [$type => $par]; |
| 91 |
$level = $par->{level}; |
| 92 |
} |
| 93 |
} elsif ($par->{level} > $level) { |
| 94 |
push @{ $topics[-1] }, $par; |
| 95 |
} |
| 96 |
} |
| 97 |
|
| 98 |
@topics |
| 99 |
} |
| 100 |
|
| 101 |
sub reload() { |
| 102 |
my $guard1 = cf::lock_acquire "ext::help::loading"; |
| 103 |
my $guard2 = cf::lock_acquire "ext::resource"; |
| 104 |
|
| 105 |
local $Coro::current->{desc} = "help loader"; |
| 106 |
|
| 107 |
$TOPIC = { |
| 108 |
(load_topics "DM Commands" => "dmcommand_help"), |
| 109 |
(load_topics "Emotes" => "emote_help"), |
| 110 |
(load_topics "Commands" => "command_help"), |
| 111 |
(load_topics "Generic Help Topics" => "generic_help"), |
| 112 |
}; |
| 113 |
|
| 114 |
load_doclets; |
| 115 |
|
| 116 |
() |
| 117 |
} |
| 118 |
|
| 119 |
cf::post_init { |
| 120 |
cf::async_ext { reload }; |
| 121 |
Coro::cede; # make sure reload acquires the lock(s) |
| 122 |
}; |
| 123 |
|
| 124 |
cf::register_command help => sub { |
| 125 |
my ($pl, $topic) = @_; |
| 126 |
|
| 127 |
if (cf::lock_active "ext::help::loading") { |
| 128 |
$pl->send_msg ($HELP_CHANNEL => "help files are being loaded currently, try again in a few seconds.", cf::NDI_REPLY | cf::NDI_CLEAR); |
| 129 |
return; |
| 130 |
} |
| 131 |
|
| 132 |
$topic = $1 if $topic =~ /(\S+)/; |
| 133 |
|
| 134 |
if (!length $topic) { |
| 135 |
# sort.. |
| 136 |
|
| 137 |
my %topics; |
| 138 |
while (my ($k, $v) = each %$TOPIC) { |
| 139 |
push @{$topics{$v->[0]}}, $k; |
| 140 |
} |
| 141 |
|
| 142 |
my $res; |
| 143 |
while (my ($k, $v) = each %topics) { |
| 144 |
$res .= "T<$k:>\n\n" . (join " ", sort @$v) . "\n\n"; |
| 145 |
} |
| 146 |
|
| 147 |
$pl->send_msg ($HELP_CHANNEL => $res, cf::NDI_REPLY | cf::NDI_CLEAR); |
| 148 |
|
| 149 |
} elsif (my $item = $TOPIC->{$topic}) { |
| 150 |
my ($type, @pars) = @$item; |
| 151 |
$pl->send_msg ($HELP_CHANNEL => (cf::pod::as_cfpod \@pars), cf::NDI_REPLY | cf::NDI_CLEAR); |
| 152 |
|
| 153 |
} else { |
| 154 |
$pl->send_msg ($HELP_CHANNEL => "'$topic' no such help topic, try just 'help' to get a list of topics.", cf::NDI_REPLY); |
| 155 |
} |
| 156 |
}; |
| 157 |
|
