1 |
root |
1.18 |
#! perl # mandatory depends=doclet |
2 |
pippijn |
1.1 |
|
3 |
root |
1.2 |
our $TOPIC; |
4 |
root |
1.18 |
our %DOCLET; |
5 |
root |
1.2 |
|
6 |
root |
1.12 |
our $HELP_CHANNEL = { |
7 |
|
|
id => "help", |
8 |
|
|
title => "Help", |
9 |
|
|
reply => "help ", |
10 |
|
|
tooltip => "Online Help", |
11 |
|
|
}; |
12 |
|
|
|
13 |
root |
1.18 |
# considerable duplication between load_doclets and load_topics |
14 |
|
|
sub load_doclets { |
15 |
|
|
%DOCLET = (); |
16 |
|
|
|
17 |
|
|
my @command_list; |
18 |
|
|
|
19 |
|
|
for ( |
20 |
|
|
[0, "command_help"], |
21 |
|
|
[1, "emote_help"], |
22 |
|
|
[2, "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 |
|
|
@command_list = sort { |
62 |
|
|
$a->[0] <=> $b->[0] |
63 |
|
|
or $a->[1] cmp $b->[1] |
64 |
|
|
} @command_list; |
65 |
|
|
|
66 |
|
|
cf::cede_to_tick; |
67 |
|
|
|
68 |
root |
1.19 |
cf::face::set |
69 |
|
|
"res/command_list" => cf::FT_RSRC, |
70 |
|
|
JSON::XS->new->utf8->encode (\@command_list); |
71 |
root |
1.18 |
} |
72 |
|
|
|
73 |
|
|
our $DOCLET_HANDLER = ext::doclet::register command => sub { |
74 |
|
|
my ($pl, $category, $command) = @_; |
75 |
|
|
|
76 |
|
|
my $guard = cf::lock_acquire "ext::help::loading"; |
77 |
|
|
|
78 |
|
|
$DOCLET{$command} |
79 |
|
|
|| "B<No documentation available for '$category/$command'>" |
80 |
|
|
}; |
81 |
|
|
|
82 |
root |
1.3 |
sub load_topics($$) { |
83 |
|
|
my ($type, $path) = @_; |
84 |
root |
1.2 |
|
85 |
|
|
my $paragraphs = cf::pod::load_pod "$PODDIR/$path.pod" |
86 |
|
|
or die "unable to load $path"; |
87 |
|
|
|
88 |
|
|
my @topics; |
89 |
|
|
my $level = 1e9; |
90 |
|
|
|
91 |
|
|
for my $par (@$paragraphs) { |
92 |
root |
1.11 |
cf::cede_to_tick; |
93 |
root |
1.2 |
if ($par->{type} eq "head2") { |
94 |
|
|
if ($par->{markup} =~ /^(\S+)/) { |
95 |
root |
1.3 |
push @topics, $1 => [$type => $par]; |
96 |
root |
1.2 |
$level = $par->{level}; |
97 |
|
|
} |
98 |
|
|
} elsif ($par->{level} > $level) { |
99 |
|
|
push @{ $topics[-1] }, $par; |
100 |
|
|
} |
101 |
|
|
} |
102 |
|
|
|
103 |
|
|
@topics |
104 |
|
|
} |
105 |
|
|
|
106 |
|
|
sub reload() { |
107 |
root |
1.18 |
my $guard1 = cf::lock_acquire "ext::help::loading"; |
108 |
|
|
my $guard2 = cf::lock_acquire "ext::resource"; |
109 |
root |
1.15 |
|
110 |
|
|
local $Coro::current->{desc} = "help loader"; |
111 |
|
|
|
112 |
root |
1.2 |
$TOPIC = { |
113 |
root |
1.3 |
(load_topics "DM Commands" => "dmcommand_help"), |
114 |
|
|
(load_topics "Emotes" => "emote_help"), |
115 |
|
|
(load_topics "Commands" => "command_help"), |
116 |
|
|
(load_topics "Generic Help Topics" => "generic_help"), |
117 |
root |
1.2 |
}; |
118 |
root |
1.18 |
|
119 |
|
|
load_doclets; |
120 |
root |
1.13 |
|
121 |
|
|
() |
122 |
root |
1.2 |
} |
123 |
|
|
|
124 |
root |
1.15 |
cf::post_init { |
125 |
root |
1.17 |
cf::async_ext { reload }; |
126 |
root |
1.18 |
Coro::cede; # make sure reload acquires the lock(s) |
127 |
root |
1.2 |
}; |
128 |
|
|
|
129 |
root |
1.3 |
cf::register_command help => sub { |
130 |
root |
1.2 |
my ($pl, $topic) = @_; |
131 |
|
|
|
132 |
|
|
if (cf::lock_active "ext::help::loading") { |
133 |
root |
1.12 |
$pl->send_msg ($HELP_CHANNEL => "help files are being loaded currently, try again in a few seconds.", cf::NDI_REPLY | cf::NDI_CLEAR); |
134 |
root |
1.2 |
return; |
135 |
|
|
} |
136 |
root |
1.3 |
|
137 |
|
|
$topic = $1 if $topic =~ /(\S+)/; |
138 |
|
|
|
139 |
|
|
if (!length $topic) { |
140 |
|
|
# sort.. |
141 |
|
|
|
142 |
|
|
my %topics; |
143 |
|
|
while (my ($k, $v) = each %$TOPIC) { |
144 |
|
|
push @{$topics{$v->[0]}}, $k; |
145 |
|
|
} |
146 |
|
|
|
147 |
|
|
my $res; |
148 |
|
|
while (my ($k, $v) = each %topics) { |
149 |
root |
1.14 |
$res .= "T<$k:>\n\n" . (join " ", sort @$v) . "\n\n"; |
150 |
root |
1.3 |
} |
151 |
|
|
|
152 |
root |
1.12 |
$pl->send_msg ($HELP_CHANNEL => $res, cf::NDI_REPLY | cf::NDI_CLEAR); |
153 |
root |
1.3 |
|
154 |
root |
1.7 |
} elsif (my $item = $TOPIC->{$topic}) { |
155 |
|
|
my ($type, @pars) = @$item; |
156 |
root |
1.12 |
$pl->send_msg ($HELP_CHANNEL => (cf::pod::as_cfpod \@pars), cf::NDI_REPLY | cf::NDI_CLEAR); |
157 |
root |
1.3 |
|
158 |
|
|
} else { |
159 |
root |
1.12 |
$pl->send_msg ($HELP_CHANNEL => "'$topic' no such help topic, try just 'help' to get a list of topics.", cf::NDI_REPLY); |
160 |
root |
1.3 |
} |
161 |
root |
1.2 |
}; |
162 |
root |
1.3 |
|