1 | package cf; |
1 | package cf; |
|
|
2 | |
|
|
3 | use utf8; |
|
|
4 | use strict; |
2 | |
5 | |
3 | use Symbol; |
6 | use Symbol; |
4 | use List::Util; |
7 | use List::Util; |
5 | use Storable; |
8 | use Storable; |
6 | use Opcode; |
9 | use Opcode; |
7 | use Safe; |
10 | use Safe; |
8 | use Safe::Hole; |
11 | use Safe::Hole; |
9 | |
12 | |
|
|
13 | use Coro; |
|
|
14 | use Coro::Event; |
|
|
15 | use Coro::Timer; |
|
|
16 | use Coro::Signal; |
|
|
17 | use Coro::Semaphore; |
|
|
18 | |
10 | use IO::AIO (); |
19 | use IO::AIO 2.3; |
11 | use YAML::Syck (); |
20 | use YAML::Syck (); |
12 | use Time::HiRes; |
21 | use Time::HiRes; |
13 | use Event; |
22 | |
14 | $Event::Eval = 1; # no idea why this is required, but it is |
23 | use Event; $Event::Eval = 1; # no idea why this is required, but it is |
15 | |
24 | |
16 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
25 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
17 | $YAML::Syck::ImplicitUnicode = 1; |
26 | $YAML::Syck::ImplicitUnicode = 1; |
18 | |
27 | |
19 | use strict; |
28 | $Coro::main->prio (Coro::PRIO_MIN); |
20 | |
29 | |
21 | _init_vars; |
30 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
22 | |
31 | |
23 | our %COMMAND = (); |
32 | our %COMMAND = (); |
|
|
33 | our %COMMAND_TIME = (); |
|
|
34 | our %EXTCMD = (); |
|
|
35 | |
24 | our @EVENT; |
36 | our @EVENT; |
25 | our $LIBDIR = maps_directory "perl"; |
37 | our $LIBDIR = datadir . "/ext"; |
26 | |
38 | |
27 | our $TICK = MAX_TIME * 1e-6; |
39 | our $TICK = MAX_TIME * 1e-6; |
28 | our $TICK_WATCHER; |
40 | our $TICK_WATCHER; |
29 | our $NEXT_TICK; |
41 | our $NEXT_TICK; |
30 | |
42 | |
31 | our %CFG; |
43 | our %CFG; |
32 | |
44 | |
33 | our $uptime;#d# |
45 | our $UPTIME; $UPTIME ||= time; |
34 | our $UPTIME; |
|
|
35 | $UPTIME ||= $uptime;#d# |
|
|
36 | $UPTIME ||= time; |
|
|
37 | |
46 | |
38 | ############################################################################# |
47 | ############################################################################# |
39 | |
48 | |
40 | =head2 GLOBAL VARIABLES |
49 | =head2 GLOBAL VARIABLES |
41 | |
50 | |
… | |
… | |
72 | print STDERR "cfperl: $msg"; |
81 | print STDERR "cfperl: $msg"; |
73 | LOG llevError, "cfperl: $msg"; |
82 | LOG llevError, "cfperl: $msg"; |
74 | }; |
83 | }; |
75 | } |
84 | } |
76 | |
85 | |
|
|
86 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
|
|
87 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
|
|
88 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
|
|
89 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
|
|
90 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
77 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
91 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
78 | |
92 | |
79 | # we bless all objects into (empty) derived classes to force a method lookup |
93 | # we bless all objects into (empty) derived classes to force a method lookup |
80 | # within the Safe compartment. |
94 | # within the Safe compartment. |
81 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
95 | for my $pkg (qw( |
|
|
96 | cf::global cf::attachable |
|
|
97 | cf::object cf::object::player |
|
|
98 | cf::client cf::player |
|
|
99 | cf::arch cf::living |
|
|
100 | cf::map cf::party cf::region |
|
|
101 | )) { |
82 | no strict 'refs'; |
102 | no strict 'refs'; |
83 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
103 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
84 | } |
104 | } |
85 | |
105 | |
86 | $Event::DIED = sub { |
106 | $Event::DIED = sub { |
… | |
… | |
88 | }; |
108 | }; |
89 | |
109 | |
90 | my %ext_pkg; |
110 | my %ext_pkg; |
91 | my @exts; |
111 | my @exts; |
92 | my @hook; |
112 | my @hook; |
93 | my %command; |
|
|
94 | my %extcmd; |
|
|
95 | |
113 | |
96 | =head2 UTILITY FUNCTIONS |
114 | =head2 UTILITY FUNCTIONS |
97 | |
115 | |
98 | =over 4 |
116 | =over 4 |
99 | |
117 | |
… | |
… | |
127 | |
145 | |
128 | =cut |
146 | =cut |
129 | |
147 | |
130 | ############################################################################# |
148 | ############################################################################# |
131 | |
149 | |
132 | =head2 EVENTS AND OBJECT ATTACHMENTS |
150 | =head2 ATTACHABLE OBJECTS |
|
|
151 | |
|
|
152 | Many objects in crossfire are so-called attachable objects. That means you can |
|
|
153 | attach callbacks/event handlers (a collection of which is called an "attachment") |
|
|
154 | to it. All such attachable objects support the following methods. |
|
|
155 | |
|
|
156 | In the following description, CLASS can be any of C<global>, C<object> |
|
|
157 | C<player>, C<client> or C<map> (i.e. the attachable objects in |
|
|
158 | crossfire+). |
133 | |
159 | |
134 | =over 4 |
160 | =over 4 |
135 | |
161 | |
136 | =item $object->attach ($attachment, key => $value...) |
|
|
137 | |
|
|
138 | =item $object->detach ($attachment) |
|
|
139 | |
|
|
140 | Attach/detach a pre-registered attachment to an object. |
|
|
141 | |
|
|
142 | =item $player->attach ($attachment, key => $value...) |
|
|
143 | |
|
|
144 | =item $player->detach ($attachment) |
|
|
145 | |
|
|
146 | Attach/detach a pre-registered attachment to a player. |
|
|
147 | |
|
|
148 | =item $map->attach ($attachment, key => $value...) |
162 | =item $attachable->attach ($attachment, key => $value...) |
149 | |
163 | |
150 | =item $map->detach ($attachment) |
164 | =item $attachable->detach ($attachment) |
151 | |
165 | |
152 | Attach/detach a pre-registered attachment to a map. |
166 | Attach/detach a pre-registered attachment to a specific object and give it |
|
|
167 | the specified key/value pairs as arguments. |
153 | |
168 | |
154 | =item $bool = $object->attached ($name) |
169 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
170 | 10x10 minesweeper game: |
155 | |
171 | |
156 | =item $bool = $player->attached ($name) |
172 | $obj->attach (minesweeper => width => 10, height => 10); |
157 | |
173 | |
158 | =item $bool = $map->attached ($name) |
174 | =item $bool = $attachable->attached ($name) |
159 | |
175 | |
160 | Checks wether the named attachment is currently attached to the object. |
176 | Checks wether the named attachment is currently attached to the object. |
161 | |
177 | |
162 | =item cf::attach_global ... |
178 | =item cf::CLASS->attach ... |
163 | |
179 | |
164 | Attach handlers for global events. |
180 | =item cf::CLASS->detach ... |
165 | |
181 | |
166 | This and all following C<attach_*>-functions expect any number of the |
182 | Define an anonymous attachment and attach it to all objects of the given |
167 | following handler/hook descriptions: |
183 | CLASS. See the next function for an explanation of its arguments. |
|
|
184 | |
|
|
185 | You can attach to global events by using the C<cf::global> class. |
|
|
186 | |
|
|
187 | Example, log all player logins: |
|
|
188 | |
|
|
189 | cf::player->attach ( |
|
|
190 | on_login => sub { |
|
|
191 | my ($pl) = @_; |
|
|
192 | ... |
|
|
193 | }, |
|
|
194 | ); |
|
|
195 | |
|
|
196 | Example, attach to the jeweler skill: |
|
|
197 | |
|
|
198 | cf::object->attach ( |
|
|
199 | type => cf::SKILL, |
|
|
200 | subtype => cf::SK_JEWELER, |
|
|
201 | on_use_skill => sub { |
|
|
202 | my ($sk, $ob, $part, $dir, $msg) = @_; |
|
|
203 | ... |
|
|
204 | }, |
|
|
205 | ); |
|
|
206 | |
|
|
207 | =item cf::CLASS::attachment $name, ... |
|
|
208 | |
|
|
209 | Register an attachment by C<$name> through which attachable objects of the |
|
|
210 | given CLASS can refer to this attachment. |
|
|
211 | |
|
|
212 | Some classes such as crossfire maps and objects can specify attachments |
|
|
213 | that are attached at load/instantiate time, thus the need for a name. |
|
|
214 | |
|
|
215 | These calls expect any number of the following handler/hook descriptions: |
168 | |
216 | |
169 | =over 4 |
217 | =over 4 |
170 | |
218 | |
171 | =item prio => $number |
219 | =item prio => $number |
172 | |
220 | |
… | |
… | |
174 | by another C<prio> setting). Lower priority handlers get executed |
222 | by another C<prio> setting). Lower priority handlers get executed |
175 | earlier. The default priority is C<0>, and many built-in handlers are |
223 | earlier. The default priority is C<0>, and many built-in handlers are |
176 | registered at priority C<-1000>, so lower priorities should not be used |
224 | registered at priority C<-1000>, so lower priorities should not be used |
177 | unless you know what you are doing. |
225 | unless you know what you are doing. |
178 | |
226 | |
|
|
227 | =item type => $type |
|
|
228 | |
|
|
229 | (Only for C<< cf::object->attach >> calls), limits the attachment to the |
|
|
230 | given type of objects only (the additional parameter C<subtype> can be |
|
|
231 | used to further limit to the given subtype). |
|
|
232 | |
179 | =item on_I<event> => \&cb |
233 | =item on_I<event> => \&cb |
180 | |
234 | |
181 | Call the given code reference whenever the named event happens (event is |
235 | Call the given code reference whenever the named event happens (event is |
182 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
236 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
183 | handlers are recognised generally depends on the type of object these |
237 | handlers are recognised generally depends on the type of object these |
… | |
… | |
192 | package and register them. Only handlers for eevents supported by the |
246 | package and register them. Only handlers for eevents supported by the |
193 | object/class are recognised. |
247 | object/class are recognised. |
194 | |
248 | |
195 | =back |
249 | =back |
196 | |
250 | |
197 | =item cf::attach_to_type $object_type, $subtype, ... |
251 | Example, define an attachment called "sockpuppet" that calls the given |
|
|
252 | event handler when a monster attacks: |
198 | |
253 | |
199 | Attach handlers for a specific object type (e.g. TRANSPORT) and |
254 | cf::object::attachment sockpuppet => |
200 | subtype. If C<$subtype> is zero or undef, matches all objects of the given |
255 | on_skill_attack => sub { |
201 | type. |
256 | my ($self, $victim) = @_; |
202 | |
257 | ... |
203 | =item cf::attach_to_objects ... |
|
|
204 | |
|
|
205 | Attach handlers to all objects. Do not use this except for debugging or |
|
|
206 | very rare events, as handlers are (obviously) called for I<all> objects in |
|
|
207 | the game. |
|
|
208 | |
|
|
209 | =item cf::attach_to_players ... |
|
|
210 | |
|
|
211 | Attach handlers to all players. |
|
|
212 | |
|
|
213 | =item cf::attach_to_maps ... |
|
|
214 | |
|
|
215 | Attach handlers to all maps. |
|
|
216 | |
|
|
217 | =item cf:register_attachment $name, ... |
|
|
218 | |
|
|
219 | Register an attachment by name through which objects can refer to this |
|
|
220 | attachment. |
|
|
221 | |
|
|
222 | =item cf:register_player_attachment $name, ... |
|
|
223 | |
|
|
224 | Register an attachment by name through which players can refer to this |
|
|
225 | attachment. |
|
|
226 | |
|
|
227 | =item cf:register_map_attachment $name, ... |
|
|
228 | |
|
|
229 | Register an attachment by name through which maps can refer to this |
|
|
230 | attachment. |
|
|
231 | |
|
|
232 | =cut |
|
|
233 | |
|
|
234 | # the following variables are defined in .xs and must not be re-created |
|
|
235 | our @CB_GLOBAL = (); # registry for all global events |
|
|
236 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
237 | our @CB_PLAYER = (); |
|
|
238 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
239 | our @CB_MAP = (); |
|
|
240 | |
|
|
241 | my %attachment; |
|
|
242 | |
|
|
243 | sub _attach_cb($\%$$$) { |
|
|
244 | my ($registry, $undo, $event, $prio, $cb) = @_; |
|
|
245 | |
|
|
246 | use sort 'stable'; |
|
|
247 | |
|
|
248 | $cb = [$prio, $cb]; |
|
|
249 | |
|
|
250 | @{$registry->[$event]} = sort |
|
|
251 | { $a->[0] cmp $b->[0] } |
|
|
252 | @{$registry->[$event] || []}, $cb; |
|
|
253 | |
|
|
254 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
255 | } |
|
|
256 | |
|
|
257 | # attach handles attaching event callbacks |
|
|
258 | # the only thing the caller has to do is pass the correct |
|
|
259 | # registry (== where the callback attaches to). |
|
|
260 | sub _attach(\@$@) { |
|
|
261 | my ($registry, $klass, @arg) = @_; |
|
|
262 | |
|
|
263 | my $prio = 0; |
|
|
264 | |
|
|
265 | my %undo = ( |
|
|
266 | registry => $registry, |
|
|
267 | cb => [], |
|
|
268 | ); |
|
|
269 | |
|
|
270 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
271 | |
|
|
272 | while (@arg) { |
|
|
273 | my $type = shift @arg; |
|
|
274 | |
|
|
275 | if ($type eq "prio") { |
|
|
276 | $prio = shift @arg; |
|
|
277 | |
|
|
278 | } elsif ($type eq "package") { |
|
|
279 | my $pkg = shift @arg; |
|
|
280 | |
|
|
281 | while (my ($name, $id) = each %cb_id) { |
|
|
282 | if (my $cb = $pkg->can ($name)) { |
|
|
283 | _attach_cb $registry, %undo, $id, $prio, $cb; |
|
|
284 | } |
|
|
285 | } |
258 | } |
286 | |
|
|
287 | } elsif (exists $cb_id{$type}) { |
|
|
288 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; |
|
|
289 | |
|
|
290 | } elsif (ref $type) { |
|
|
291 | warn "attaching objects not supported, ignoring.\n"; |
|
|
292 | |
|
|
293 | } else { |
|
|
294 | shift @arg; |
|
|
295 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
296 | } |
|
|
297 | } |
|
|
298 | |
|
|
299 | \%undo |
|
|
300 | } |
|
|
301 | |
|
|
302 | sub _attach_attachment { |
|
|
303 | my ($obj, $name, %arg) = @_; |
|
|
304 | |
|
|
305 | return if exists $obj->{_attachment}{$name}; |
|
|
306 | |
|
|
307 | my $res; |
|
|
308 | |
|
|
309 | if (my $attach = $attachment{$name}) { |
|
|
310 | my $registry = $obj->registry; |
|
|
311 | |
|
|
312 | for (@$attach) { |
|
|
313 | my ($klass, @attach) = @$_; |
|
|
314 | $res = _attach @$registry, $klass, @attach; |
|
|
315 | } |
|
|
316 | |
|
|
317 | $obj->{$name} = \%arg; |
|
|
318 | } else { |
|
|
319 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
320 | } |
|
|
321 | |
|
|
322 | $obj->{_attachment}{$name} = undef; |
|
|
323 | |
|
|
324 | $res->{attachment} = $name; |
|
|
325 | $res |
|
|
326 | } |
|
|
327 | |
|
|
328 | *cf::object::attach = |
|
|
329 | *cf::player::attach = |
|
|
330 | *cf::map::attach = sub { |
|
|
331 | my ($obj, $name, %arg) = @_; |
|
|
332 | |
|
|
333 | _attach_attachment $obj, $name, %arg; |
|
|
334 | }; |
|
|
335 | |
|
|
336 | # all those should be optimised |
|
|
337 | *cf::object::detach = |
|
|
338 | *cf::player::detach = |
|
|
339 | *cf::map::detach = sub { |
|
|
340 | my ($obj, $name) = @_; |
|
|
341 | |
|
|
342 | delete $obj->{_attachment}{$name}; |
|
|
343 | reattach ($obj); |
|
|
344 | }; |
|
|
345 | |
|
|
346 | *cf::object::attached = |
|
|
347 | *cf::player::attached = |
|
|
348 | *cf::map::attached = sub { |
|
|
349 | my ($obj, $name) = @_; |
|
|
350 | |
|
|
351 | exists $obj->{_attachment}{$name} |
|
|
352 | }; |
|
|
353 | |
|
|
354 | sub attach_global { |
|
|
355 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
356 | } |
|
|
357 | |
|
|
358 | sub attach_to_type { |
|
|
359 | my $type = shift; |
|
|
360 | my $subtype = shift; |
|
|
361 | |
|
|
362 | _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ |
|
|
363 | } |
|
|
364 | |
|
|
365 | sub attach_to_objects { |
|
|
366 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
|
|
367 | } |
|
|
368 | |
|
|
369 | sub attach_to_players { |
|
|
370 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
|
|
371 | } |
|
|
372 | |
|
|
373 | sub attach_to_maps { |
|
|
374 | _attach @CB_MAP, KLASS_MAP, @_ |
|
|
375 | } |
|
|
376 | |
|
|
377 | sub register_attachment { |
|
|
378 | my $name = shift; |
|
|
379 | |
|
|
380 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
|
|
381 | } |
|
|
382 | |
|
|
383 | sub register_player_attachment { |
|
|
384 | my $name = shift; |
|
|
385 | |
|
|
386 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
387 | } |
|
|
388 | |
|
|
389 | sub register_map_attachment { |
|
|
390 | my $name = shift; |
|
|
391 | |
|
|
392 | $attachment{$name} = [[KLASS_MAP, @_]]; |
|
|
393 | } |
|
|
394 | |
|
|
395 | our $override; |
|
|
396 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
397 | |
|
|
398 | sub override { |
|
|
399 | $override = 1; |
|
|
400 | @invoke_results = (); |
|
|
401 | } |
|
|
402 | |
|
|
403 | sub do_invoke { |
|
|
404 | my $event = shift; |
|
|
405 | my $callbacks = shift; |
|
|
406 | |
|
|
407 | @invoke_results = (); |
|
|
408 | |
|
|
409 | local $override; |
|
|
410 | |
|
|
411 | for (@$callbacks) { |
|
|
412 | eval { &{$_->[1]} }; |
|
|
413 | |
|
|
414 | if ($@) { |
|
|
415 | warn "$@"; |
|
|
416 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
417 | override; |
|
|
418 | } |
|
|
419 | |
|
|
420 | return 1 if $override; |
|
|
421 | } |
|
|
422 | |
|
|
423 | 0 |
259 | } |
424 | } |
|
|
425 | |
260 | |
426 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
261 | =item $attachable->valid |
427 | |
|
|
428 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
429 | |
|
|
430 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
431 | |
|
|
432 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
433 | |
|
|
434 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
435 | |
|
|
436 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
437 | removed in future versions), and there is no public API to access override |
|
|
438 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
439 | |
|
|
440 | =back |
|
|
441 | |
|
|
442 | =cut |
|
|
443 | |
|
|
444 | ############################################################################# |
|
|
445 | |
|
|
446 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
|
|
447 | |
|
|
448 | =over 4 |
|
|
449 | |
|
|
450 | =item $object->valid, $player->valid, $map->valid |
|
|
451 | |
262 | |
452 | Just because you have a perl object does not mean that the corresponding |
263 | Just because you have a perl object does not mean that the corresponding |
453 | C-level object still exists. If you try to access an object that has no |
264 | C-level object still exists. If you try to access an object that has no |
454 | valid C counterpart anymore you get an exception at runtime. This method |
265 | valid C counterpart anymore you get an exception at runtime. This method |
455 | can be used to test for existence of the C object part without causing an |
266 | can be used to test for existence of the C object part without causing an |
456 | exception. |
267 | exception. |
457 | |
268 | |
|
|
269 | =cut |
|
|
270 | |
|
|
271 | # the following variables are defined in .xs and must not be re-created |
|
|
272 | our @CB_GLOBAL = (); # registry for all global events |
|
|
273 | our @CB_ATTACHABLE = (); # registry for all attachables |
|
|
274 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
275 | our @CB_PLAYER = (); |
|
|
276 | our @CB_CLIENT = (); |
|
|
277 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
278 | our @CB_MAP = (); |
|
|
279 | |
|
|
280 | my %attachment; |
|
|
281 | |
|
|
282 | sub _attach_cb($$$$) { |
|
|
283 | my ($registry, $event, $prio, $cb) = @_; |
|
|
284 | |
|
|
285 | use sort 'stable'; |
|
|
286 | |
|
|
287 | $cb = [$prio, $cb]; |
|
|
288 | |
|
|
289 | @{$registry->[$event]} = sort |
|
|
290 | { $a->[0] cmp $b->[0] } |
|
|
291 | @{$registry->[$event] || []}, $cb; |
|
|
292 | } |
|
|
293 | |
|
|
294 | # hack |
|
|
295 | my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP; |
|
|
296 | |
|
|
297 | # attach handles attaching event callbacks |
|
|
298 | # the only thing the caller has to do is pass the correct |
|
|
299 | # registry (== where the callback attaches to). |
|
|
300 | sub _attach { |
|
|
301 | my ($registry, $klass, @arg) = @_; |
|
|
302 | |
|
|
303 | my $object_type; |
|
|
304 | my $prio = 0; |
|
|
305 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
306 | |
|
|
307 | #TODO: get rid of this hack |
|
|
308 | if ($attachable_klass{$klass}) { |
|
|
309 | %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT); |
|
|
310 | } |
|
|
311 | |
|
|
312 | while (@arg) { |
|
|
313 | my $type = shift @arg; |
|
|
314 | |
|
|
315 | if ($type eq "prio") { |
|
|
316 | $prio = shift @arg; |
|
|
317 | |
|
|
318 | } elsif ($type eq "type") { |
|
|
319 | $object_type = shift @arg; |
|
|
320 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
321 | |
|
|
322 | } elsif ($type eq "subtype") { |
|
|
323 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
324 | my $object_subtype = shift @arg; |
|
|
325 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
|
|
326 | |
|
|
327 | } elsif ($type eq "package") { |
|
|
328 | my $pkg = shift @arg; |
|
|
329 | |
|
|
330 | while (my ($name, $id) = each %cb_id) { |
|
|
331 | if (my $cb = $pkg->can ($name)) { |
|
|
332 | _attach_cb $registry, $id, $prio, $cb; |
|
|
333 | } |
|
|
334 | } |
|
|
335 | |
|
|
336 | } elsif (exists $cb_id{$type}) { |
|
|
337 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
|
|
338 | |
|
|
339 | } elsif (ref $type) { |
|
|
340 | warn "attaching objects not supported, ignoring.\n"; |
|
|
341 | |
|
|
342 | } else { |
|
|
343 | shift @arg; |
|
|
344 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
345 | } |
|
|
346 | } |
|
|
347 | } |
|
|
348 | |
|
|
349 | sub _object_attach { |
|
|
350 | my ($obj, $name, %arg) = @_; |
|
|
351 | |
|
|
352 | return if exists $obj->{_attachment}{$name}; |
|
|
353 | |
|
|
354 | if (my $attach = $attachment{$name}) { |
|
|
355 | my $registry = $obj->registry; |
|
|
356 | |
|
|
357 | for (@$attach) { |
|
|
358 | my ($klass, @attach) = @$_; |
|
|
359 | _attach $registry, $klass, @attach; |
|
|
360 | } |
|
|
361 | |
|
|
362 | $obj->{$name} = \%arg; |
|
|
363 | } else { |
|
|
364 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
365 | } |
|
|
366 | |
|
|
367 | $obj->{_attachment}{$name} = undef; |
|
|
368 | } |
|
|
369 | |
|
|
370 | sub cf::attachable::attach { |
|
|
371 | if (ref $_[0]) { |
|
|
372 | _object_attach @_; |
|
|
373 | } else { |
|
|
374 | _attach shift->_attach_registry, @_; |
|
|
375 | } |
|
|
376 | }; |
|
|
377 | |
|
|
378 | # all those should be optimised |
|
|
379 | sub cf::attachable::detach { |
|
|
380 | my ($obj, $name) = @_; |
|
|
381 | |
|
|
382 | if (ref $obj) { |
|
|
383 | delete $obj->{_attachment}{$name}; |
|
|
384 | reattach ($obj); |
|
|
385 | } else { |
|
|
386 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
387 | } |
|
|
388 | }; |
|
|
389 | |
|
|
390 | sub cf::attachable::attached { |
|
|
391 | my ($obj, $name) = @_; |
|
|
392 | |
|
|
393 | exists $obj->{_attachment}{$name} |
|
|
394 | } |
|
|
395 | |
|
|
396 | for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) { |
|
|
397 | eval "#line " . __LINE__ . " 'cf.pm' |
|
|
398 | sub cf::\L$klass\E::_attach_registry { |
|
|
399 | (\\\@CB_$klass, KLASS_$klass) |
|
|
400 | } |
|
|
401 | |
|
|
402 | sub cf::\L$klass\E::attachment { |
|
|
403 | my \$name = shift; |
|
|
404 | |
|
|
405 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
406 | } |
|
|
407 | "; |
|
|
408 | die if $@; |
|
|
409 | } |
|
|
410 | |
|
|
411 | our $override; |
|
|
412 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
413 | |
|
|
414 | sub override { |
|
|
415 | $override = 1; |
|
|
416 | @invoke_results = (); |
|
|
417 | } |
|
|
418 | |
|
|
419 | sub do_invoke { |
|
|
420 | my $event = shift; |
|
|
421 | my $callbacks = shift; |
|
|
422 | |
|
|
423 | @invoke_results = (); |
|
|
424 | |
|
|
425 | local $override; |
|
|
426 | |
|
|
427 | for (@$callbacks) { |
|
|
428 | eval { &{$_->[1]} }; |
|
|
429 | |
|
|
430 | if ($@) { |
|
|
431 | warn "$@"; |
|
|
432 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
433 | override; |
|
|
434 | } |
|
|
435 | |
|
|
436 | return 1 if $override; |
|
|
437 | } |
|
|
438 | |
|
|
439 | 0 |
|
|
440 | } |
|
|
441 | |
|
|
442 | =item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) |
|
|
443 | |
|
|
444 | =item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) |
|
|
445 | |
|
|
446 | Generate an object-specific event with the given arguments. |
|
|
447 | |
|
|
448 | This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be |
|
|
449 | removed in future versions), and there is no public API to access override |
|
|
450 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
451 | |
458 | =back |
452 | =back |
459 | |
453 | |
460 | =cut |
454 | =cut |
461 | |
|
|
462 | *cf::object::valid = |
|
|
463 | *cf::player::valid = |
|
|
464 | *cf::map::valid = \&cf::_valid; |
|
|
465 | |
455 | |
466 | ############################################################################# |
456 | ############################################################################# |
467 | # object support |
457 | # object support |
468 | |
458 | |
469 | sub instantiate { |
459 | cf::attachable->attach ( |
|
|
460 | prio => -1000000, |
|
|
461 | on_instantiate => sub { |
470 | my ($obj, $data) = @_; |
462 | my ($obj, $data) = @_; |
471 | |
463 | |
472 | $data = from_json $data; |
464 | $data = from_json $data; |
473 | |
465 | |
474 | for (@$data) { |
466 | for (@$data) { |
475 | my ($name, $args) = @$_; |
467 | my ($name, $args) = @$_; |
476 | |
468 | |
477 | $obj->attach ($name, %{$args || {} }); |
469 | $obj->attach ($name, %{$args || {} }); |
|
|
470 | } |
478 | } |
471 | }, |
479 | } |
472 | on_reattach => sub { |
480 | |
|
|
481 | # basically do the same as instantiate, without calling instantiate |
473 | # basically do the same as instantiate, without calling instantiate |
482 | sub reattach { |
|
|
483 | my ($obj) = @_; |
474 | my ($obj) = @_; |
484 | my $registry = $obj->registry; |
475 | my $registry = $obj->registry; |
485 | |
476 | |
486 | @$registry = (); |
477 | @$registry = (); |
487 | |
478 | |
488 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
479 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
489 | |
480 | |
490 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
481 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
491 | if (my $attach = $attachment{$name}) { |
482 | if (my $attach = $attachment{$name}) { |
492 | for (@$attach) { |
483 | for (@$attach) { |
493 | my ($klass, @attach) = @$_; |
484 | my ($klass, @attach) = @$_; |
494 | _attach @$registry, $klass, @attach; |
485 | _attach $registry, $klass, @attach; |
|
|
486 | } |
|
|
487 | } else { |
|
|
488 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
495 | } |
489 | } |
496 | } else { |
|
|
497 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
498 | } |
490 | } |
499 | } |
491 | }, |
500 | } |
492 | on_clone => sub { |
|
|
493 | my ($src, $dst) = @_; |
|
|
494 | |
|
|
495 | @{$dst->registry} = @{$src->registry}; |
|
|
496 | |
|
|
497 | %$dst = %$src; |
|
|
498 | |
|
|
499 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
|
|
500 | if exists $src->{_attachment}; |
|
|
501 | }, |
|
|
502 | ); |
501 | |
503 | |
502 | sub object_freezer_save { |
504 | sub object_freezer_save { |
503 | my ($filename, $rdata, $objs) = @_; |
505 | my ($filename, $rdata, $objs) = @_; |
504 | |
506 | |
505 | if (length $$rdata) { |
507 | if (length $$rdata) { |
… | |
… | |
555 | } |
557 | } |
556 | |
558 | |
557 | () |
559 | () |
558 | } |
560 | } |
559 | |
561 | |
560 | attach_to_objects |
|
|
561 | prio => -1000000, |
|
|
562 | on_clone => sub { |
|
|
563 | my ($src, $dst) = @_; |
|
|
564 | |
|
|
565 | @{$dst->registry} = @{$src->registry}; |
|
|
566 | |
|
|
567 | %$dst = %$src; |
|
|
568 | |
|
|
569 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
|
|
570 | if exists $src->{_attachment}; |
|
|
571 | }, |
|
|
572 | ; |
|
|
573 | |
|
|
574 | ############################################################################# |
562 | ############################################################################# |
575 | # old plug-in events |
563 | # command handling &c |
576 | |
564 | |
577 | sub inject_event { |
565 | =item cf::register_command $name => \&callback($ob,$args); |
578 | my $extension = shift; |
|
|
579 | my $event_code = shift; |
|
|
580 | |
566 | |
581 | my $cb = $hook[$event_code]{$extension} |
567 | Register a callback for execution when the client sends the user command |
582 | or return; |
568 | $name. |
583 | |
569 | |
584 | &$cb |
570 | =cut |
585 | } |
|
|
586 | |
|
|
587 | sub inject_global_event { |
|
|
588 | my $event = shift; |
|
|
589 | |
|
|
590 | my $cb = $hook[$event] |
|
|
591 | or return; |
|
|
592 | |
|
|
593 | List::Util::max map &$_, values %$cb |
|
|
594 | } |
|
|
595 | |
|
|
596 | sub inject_command { |
|
|
597 | my ($name, $obj, $params) = @_; |
|
|
598 | |
|
|
599 | for my $cmd (@{ $command{$name} }) { |
|
|
600 | $cmd->[1]->($obj, $params); |
|
|
601 | } |
|
|
602 | |
|
|
603 | -1 |
|
|
604 | } |
|
|
605 | |
571 | |
606 | sub register_command { |
572 | sub register_command { |
607 | my ($name, $time, $cb) = @_; |
573 | my ($name, $cb) = @_; |
608 | |
574 | |
609 | my $caller = caller; |
575 | my $caller = caller; |
610 | #warn "registering command '$name/$time' to '$caller'"; |
576 | #warn "registering command '$name/$time' to '$caller'"; |
611 | |
577 | |
612 | push @{ $command{$name} }, [$time, $cb, $caller]; |
578 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
613 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
614 | } |
579 | } |
|
|
580 | |
|
|
581 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
582 | |
|
|
583 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
584 | |
|
|
585 | If the callback returns something, it is sent back as if reply was being |
|
|
586 | called. |
|
|
587 | |
|
|
588 | =cut |
615 | |
589 | |
616 | sub register_extcmd { |
590 | sub register_extcmd { |
617 | my ($name, $cb) = @_; |
591 | my ($name, $cb) = @_; |
618 | |
592 | |
619 | my $caller = caller; |
593 | my $caller = caller; |
620 | #warn "registering extcmd '$name' to '$caller'"; |
594 | #warn "registering extcmd '$name' to '$caller'"; |
621 | |
595 | |
622 | $extcmd{$name} = [$cb, $caller]; |
596 | $EXTCMD{$name} = [$cb, $caller]; |
623 | } |
597 | } |
|
|
598 | |
|
|
599 | cf::player->attach ( |
|
|
600 | on_command => sub { |
|
|
601 | my ($pl, $name, $params) = @_; |
|
|
602 | |
|
|
603 | my $cb = $COMMAND{$name} |
|
|
604 | or return; |
|
|
605 | |
|
|
606 | for my $cmd (@$cb) { |
|
|
607 | $cmd->[1]->($pl->ob, $params); |
|
|
608 | } |
|
|
609 | |
|
|
610 | cf::override; |
|
|
611 | }, |
|
|
612 | on_extcmd => sub { |
|
|
613 | my ($pl, $buf) = @_; |
|
|
614 | |
|
|
615 | my $msg = eval { from_json $buf }; |
|
|
616 | |
|
|
617 | if (ref $msg) { |
|
|
618 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
619 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
620 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
621 | } |
|
|
622 | } |
|
|
623 | } else { |
|
|
624 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
625 | } |
|
|
626 | |
|
|
627 | cf::override; |
|
|
628 | }, |
|
|
629 | ); |
624 | |
630 | |
625 | sub register { |
631 | sub register { |
626 | my ($base, $pkg) = @_; |
632 | my ($base, $pkg) = @_; |
627 | |
633 | |
628 | #TODO |
634 | #TODO |
… | |
… | |
671 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
677 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
672 | # delete $hook[$idx]{$pkg}; |
678 | # delete $hook[$idx]{$pkg}; |
673 | # } |
679 | # } |
674 | |
680 | |
675 | # remove commands |
681 | # remove commands |
676 | for my $name (keys %command) { |
682 | for my $name (keys %COMMAND) { |
677 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
683 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
678 | |
684 | |
679 | if (@cb) { |
685 | if (@cb) { |
680 | $command{$name} = \@cb; |
686 | $COMMAND{$name} = \@cb; |
681 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
682 | } else { |
687 | } else { |
683 | delete $command{$name}; |
|
|
684 | delete $COMMAND{"$name\000"}; |
688 | delete $COMMAND{$name}; |
685 | } |
689 | } |
686 | } |
690 | } |
687 | |
691 | |
688 | # remove extcmds |
692 | # remove extcmds |
689 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
693 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
690 | delete $extcmd{$name}; |
694 | delete $EXTCMD{$name}; |
691 | } |
695 | } |
692 | |
696 | |
693 | if (my $cb = $pkg->can ("unload")) { |
697 | if (my $cb = $pkg->can ("unload")) { |
694 | eval { |
698 | eval { |
695 | $cb->($pkg); |
699 | $cb->($pkg); |
… | |
… | |
699 | |
703 | |
700 | Symbol::delete_package $pkg; |
704 | Symbol::delete_package $pkg; |
701 | } |
705 | } |
702 | |
706 | |
703 | sub load_extensions { |
707 | sub load_extensions { |
704 | my $LIBDIR = maps_directory "perl"; |
|
|
705 | |
|
|
706 | for my $ext (<$LIBDIR/*.ext>) { |
708 | for my $ext (<$LIBDIR/*.ext>) { |
707 | next unless -r $ext; |
709 | next unless -r $ext; |
708 | eval { |
710 | eval { |
709 | load_extension $ext; |
711 | load_extension $ext; |
710 | 1 |
712 | 1 |
711 | } or warn "$ext not loaded: $@"; |
713 | } or warn "$ext not loaded: $@"; |
712 | } |
714 | } |
713 | } |
715 | } |
714 | |
716 | |
715 | ############################################################################# |
717 | ############################################################################# |
716 | # extcmd framework, basically convert ext <msg> |
|
|
717 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
718 | |
|
|
719 | attach_to_players |
|
|
720 | on_extcmd => sub { |
|
|
721 | my ($pl, $buf) = @_; |
|
|
722 | |
|
|
723 | my $msg = eval { from_json $buf }; |
|
|
724 | |
|
|
725 | if (ref $msg) { |
|
|
726 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
727 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
728 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
729 | } |
|
|
730 | } |
|
|
731 | } else { |
|
|
732 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
733 | } |
|
|
734 | |
|
|
735 | cf::override; |
|
|
736 | }, |
|
|
737 | ; |
|
|
738 | |
|
|
739 | ############################################################################# |
|
|
740 | # load/save/clean perl data associated with a map |
718 | # load/save/clean perl data associated with a map |
741 | |
719 | |
742 | *cf::mapsupport::on_clean = sub { |
720 | *cf::mapsupport::on_clean = sub { |
743 | my ($map) = @_; |
721 | my ($map) = @_; |
744 | |
722 | |
… | |
… | |
746 | defined $path or return; |
724 | defined $path or return; |
747 | |
725 | |
748 | unlink "$path.pst"; |
726 | unlink "$path.pst"; |
749 | }; |
727 | }; |
750 | |
728 | |
751 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
729 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
752 | |
730 | |
753 | ############################################################################# |
731 | ############################################################################# |
754 | # load/save perl data associated with player->ob objects |
732 | # load/save perl data associated with player->ob objects |
755 | |
733 | |
756 | sub all_objects(@) { |
734 | sub all_objects(@) { |
757 | @_, map all_objects ($_->inv), @_ |
735 | @_, map all_objects ($_->inv), @_ |
758 | } |
736 | } |
759 | |
737 | |
760 | # TODO: compatibility cruft, remove when no longer needed |
738 | # TODO: compatibility cruft, remove when no longer needed |
761 | attach_to_players |
739 | cf::player->attach ( |
762 | on_load => sub { |
740 | on_load => sub { |
763 | my ($pl, $path) = @_; |
741 | my ($pl, $path) = @_; |
764 | |
742 | |
765 | for my $o (all_objects $pl->ob) { |
743 | for my $o (all_objects $pl->ob) { |
766 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
744 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
… | |
… | |
768 | |
746 | |
769 | %$o = %{ Storable::thaw pack "H*", $value }; |
747 | %$o = %{ Storable::thaw pack "H*", $value }; |
770 | } |
748 | } |
771 | } |
749 | } |
772 | }, |
750 | }, |
773 | ; |
751 | ); |
774 | |
752 | |
775 | ############################################################################# |
753 | ############################################################################# |
776 | |
754 | |
777 | =head2 CORE EXTENSIONS |
755 | =head2 CORE EXTENSIONS |
778 | |
756 | |
779 | Functions and methods that extend core crossfire objects. |
757 | Functions and methods that extend core crossfire objects. |
|
|
758 | |
|
|
759 | =head3 cf::player |
780 | |
760 | |
781 | =over 4 |
761 | =over 4 |
782 | |
762 | |
783 | =item cf::player::exists $login |
763 | =item cf::player::exists $login |
784 | |
764 | |
… | |
… | |
789 | sub cf::player::exists($) { |
769 | sub cf::player::exists($) { |
790 | cf::player::find $_[0] |
770 | cf::player::find $_[0] |
791 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
771 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
792 | } |
772 | } |
793 | |
773 | |
|
|
774 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
775 | |
|
|
776 | Sends an ext reply to the player. |
|
|
777 | |
|
|
778 | =cut |
|
|
779 | |
|
|
780 | sub cf::player::ext_reply($$$%) { |
|
|
781 | my ($self, $id, %msg) = @_; |
|
|
782 | |
|
|
783 | $msg{msgid} = $id; |
|
|
784 | |
|
|
785 | $self->send ("ext " . to_json \%msg); |
|
|
786 | } |
|
|
787 | |
|
|
788 | =back |
|
|
789 | |
|
|
790 | =head3 cf::object::player |
|
|
791 | |
|
|
792 | =over 4 |
|
|
793 | |
794 | =item $player_object->reply ($npc, $msg[, $flags]) |
794 | =item $player_object->reply ($npc, $msg[, $flags]) |
795 | |
795 | |
796 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
796 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
797 | can be C<undef>. Does the right thing when the player is currently in a |
797 | can be C<undef>. Does the right thing when the player is currently in a |
798 | dialogue with the given NPC character. |
798 | dialogue with the given NPC character. |
799 | |
799 | |
800 | =cut |
800 | =cut |
801 | |
801 | |
802 | # rough implementation of a future "reply" method that works |
802 | # rough implementation of a future "reply" method that works |
803 | # with dialog boxes. |
803 | # with dialog boxes. |
|
|
804 | #TODO: the first argument must go, split into a $npc->reply_to ( method |
804 | sub cf::object::player::reply($$$;$) { |
805 | sub cf::object::player::reply($$$;$) { |
805 | my ($self, $npc, $msg, $flags) = @_; |
806 | my ($self, $npc, $msg, $flags) = @_; |
806 | |
807 | |
807 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
808 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
808 | |
809 | |
… | |
… | |
812 | $msg = $npc->name . " says: $msg" if $npc; |
813 | $msg = $npc->name . " says: $msg" if $npc; |
813 | $self->message ($msg, $flags); |
814 | $self->message ($msg, $flags); |
814 | } |
815 | } |
815 | } |
816 | } |
816 | |
817 | |
817 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
818 | |
|
|
819 | Sends an ext reply to the player. |
|
|
820 | |
|
|
821 | =cut |
|
|
822 | |
|
|
823 | sub cf::player::ext_reply($$$%) { |
|
|
824 | my ($self, $id, %msg) = @_; |
|
|
825 | |
|
|
826 | $msg{msgid} = $id; |
|
|
827 | |
|
|
828 | $self->send ("ext " . to_json \%msg); |
|
|
829 | } |
|
|
830 | |
|
|
831 | =item $player_object->may ("access") |
818 | =item $player_object->may ("access") |
832 | |
819 | |
833 | Returns wether the given player is authorized to access resource "access" |
820 | Returns wether the given player is authorized to access resource "access" |
834 | (e.g. "command_wizcast"). |
821 | (e.g. "command_wizcast"). |
835 | |
822 | |
… | |
… | |
842 | (ref $cf::CFG{"may_$access"} |
829 | (ref $cf::CFG{"may_$access"} |
843 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
830 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
844 | : $cf::CFG{"may_$access"}) |
831 | : $cf::CFG{"may_$access"}) |
845 | } |
832 | } |
846 | |
833 | |
847 | =cut |
834 | =head3 cf::client |
848 | |
835 | |
849 | ############################################################################# |
836 | =over 4 |
|
|
837 | |
|
|
838 | =item $client->send_drawinfo ($text, $flags) |
|
|
839 | |
|
|
840 | Sends a drawinfo packet to the client. Circumvents output buffering so |
|
|
841 | should not be used under normal circumstances. |
|
|
842 | |
|
|
843 | =cut |
|
|
844 | |
|
|
845 | sub cf::client::send_drawinfo { |
|
|
846 | my ($self, $text, $flags) = @_; |
|
|
847 | |
|
|
848 | utf8::encode $text; |
|
|
849 | $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); |
|
|
850 | } |
|
|
851 | |
|
|
852 | |
|
|
853 | =item $success = $client->query ($flags, "text", \&cb) |
|
|
854 | |
|
|
855 | Queues a query to the client, calling the given callback with |
|
|
856 | the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, |
|
|
857 | C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. |
|
|
858 | |
|
|
859 | Queries can fail, so check the return code. Or don't, as queries will become |
|
|
860 | reliable at some point in the future. |
|
|
861 | |
|
|
862 | =cut |
|
|
863 | |
|
|
864 | sub cf::client::query { |
|
|
865 | my ($self, $flags, $text, $cb) = @_; |
|
|
866 | |
|
|
867 | return unless $self->state == ST_PLAYING |
|
|
868 | || $self->state == ST_SETUP |
|
|
869 | || $self->state == ST_CUSTOM; |
|
|
870 | |
|
|
871 | $self->state (ST_CUSTOM); |
|
|
872 | |
|
|
873 | utf8::encode $text; |
|
|
874 | push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; |
|
|
875 | |
|
|
876 | $self->send_packet ($self->{query_queue}[0][0]) |
|
|
877 | if @{ $self->{query_queue} } == 1; |
|
|
878 | } |
|
|
879 | |
|
|
880 | cf::client->attach ( |
|
|
881 | on_reply => sub { |
|
|
882 | my ($ns, $msg) = @_; |
|
|
883 | |
|
|
884 | # this weird shuffling is so that direct followup queries |
|
|
885 | # get handled first |
|
|
886 | my $queue = delete $ns->{query_queue}; |
|
|
887 | |
|
|
888 | (shift @$queue)->[1]->($msg); |
|
|
889 | |
|
|
890 | push @{ $ns->{query_queue} }, @$queue; |
|
|
891 | |
|
|
892 | if (@{ $ns->{query_queue} } == @$queue) { |
|
|
893 | if (@$queue) { |
|
|
894 | $ns->send_packet ($ns->{query_queue}[0][0]); |
|
|
895 | } else { |
|
|
896 | $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; |
|
|
897 | } |
|
|
898 | } |
|
|
899 | }, |
|
|
900 | ); |
|
|
901 | |
|
|
902 | =item $client->coro (\&cb) |
|
|
903 | |
|
|
904 | Create a new coroutine, running the specified callback. The coroutine will |
|
|
905 | be automatically cancelled when the client gets destroyed (e.g. on logout, |
|
|
906 | or loss of connection). |
|
|
907 | |
|
|
908 | =cut |
|
|
909 | |
|
|
910 | sub cf::client::coro { |
|
|
911 | my ($self, $cb) = @_; |
|
|
912 | |
|
|
913 | my $coro; $coro = async { |
|
|
914 | eval { |
|
|
915 | $cb->(); |
|
|
916 | }; |
|
|
917 | warn $@ if $@; |
|
|
918 | delete $self->{_coro}{$coro+0}; |
|
|
919 | }; |
|
|
920 | |
|
|
921 | $self->{_coro}{$coro+0} = $coro; |
|
|
922 | } |
|
|
923 | |
|
|
924 | cf::client->attach ( |
|
|
925 | on_destroy => sub { |
|
|
926 | my ($ns) = @_; |
|
|
927 | |
|
|
928 | $_->cancel for values %{ (delete $ns->{_coro}) || {} }; |
|
|
929 | }, |
|
|
930 | ); |
|
|
931 | |
|
|
932 | =back |
|
|
933 | |
850 | |
934 | |
851 | =head2 SAFE SCRIPTING |
935 | =head2 SAFE SCRIPTING |
852 | |
936 | |
853 | Functions that provide a safe environment to compile and execute |
937 | Functions that provide a safe environment to compile and execute |
854 | snippets of perl code without them endangering the safety of the server |
938 | snippets of perl code without them endangering the safety of the server |
… | |
… | |
869 | |
953 | |
870 | =pod |
954 | =pod |
871 | |
955 | |
872 | The following fucntions and emthods are available within a safe environment: |
956 | The following fucntions and emthods are available within a safe environment: |
873 | |
957 | |
874 | cf::object contr pay_amount pay_player |
958 | cf::object contr pay_amount pay_player map |
875 | cf::object::player player |
959 | cf::object::player player |
876 | cf::player peaceful |
960 | cf::player peaceful |
|
|
961 | cf::map trigger |
877 | |
962 | |
878 | =cut |
963 | =cut |
879 | |
964 | |
880 | for ( |
965 | for ( |
881 | ["cf::object" => qw(contr pay_amount pay_player)], |
966 | ["cf::object" => qw(contr pay_amount pay_player map)], |
882 | ["cf::object::player" => qw(player)], |
967 | ["cf::object::player" => qw(player)], |
883 | ["cf::player" => qw(peaceful)], |
968 | ["cf::player" => qw(peaceful)], |
|
|
969 | ["cf::map" => qw(trigger)], |
884 | ) { |
970 | ) { |
885 | no strict 'refs'; |
971 | no strict 'refs'; |
886 | my ($pkg, @funs) = @$_; |
972 | my ($pkg, @funs) = @$_; |
887 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
973 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
888 | for @funs; |
974 | for @funs; |
… | |
… | |
1028 | sub db_sync() { |
1114 | sub db_sync() { |
1029 | db_save if $dirty; |
1115 | db_save if $dirty; |
1030 | undef $dirty; |
1116 | undef $dirty; |
1031 | } |
1117 | } |
1032 | |
1118 | |
1033 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
1119 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
1034 | db_sync; |
1120 | db_sync; |
1035 | }); |
1121 | }); |
1036 | |
1122 | |
1037 | sub db_dirty() { |
1123 | sub db_dirty() { |
1038 | $dirty = 1; |
1124 | $dirty = 1; |
… | |
… | |
1052 | $DB->{$_[0]} = $_[1]; |
1138 | $DB->{$_[0]} = $_[1]; |
1053 | } |
1139 | } |
1054 | db_dirty; |
1140 | db_dirty; |
1055 | } |
1141 | } |
1056 | |
1142 | |
1057 | attach_global |
1143 | cf::global->attach ( |
1058 | prio => 10000, |
1144 | prio => 10000, |
1059 | on_cleanup => sub { |
1145 | on_cleanup => sub { |
1060 | db_sync; |
1146 | db_sync; |
1061 | }, |
1147 | }, |
1062 | ; |
1148 | ); |
1063 | } |
1149 | } |
1064 | |
1150 | |
1065 | ############################################################################# |
1151 | ############################################################################# |
1066 | # the server's main() |
1152 | # the server's main() |
1067 | |
1153 | |
… | |
… | |
1088 | |
1174 | |
1089 | $msg->("reloading..."); |
1175 | $msg->("reloading..."); |
1090 | |
1176 | |
1091 | eval { |
1177 | eval { |
1092 | # cancel all watchers |
1178 | # cancel all watchers |
1093 | $_->cancel for Event::all_watchers; |
1179 | for (Event::all_watchers) { |
|
|
1180 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
1181 | } |
1094 | |
1182 | |
1095 | # unload all extensions |
1183 | # unload all extensions |
1096 | for (@exts) { |
1184 | for (@exts) { |
1097 | $msg->("unloading <$_>"); |
1185 | $msg->("unloading <$_>"); |
1098 | unload_extension $_; |
1186 | unload_extension $_; |
… | |
… | |
1133 | #Symbol::delete_package __PACKAGE__; |
1221 | #Symbol::delete_package __PACKAGE__; |
1134 | |
1222 | |
1135 | # reload cf.pm |
1223 | # reload cf.pm |
1136 | $msg->("reloading cf.pm"); |
1224 | $msg->("reloading cf.pm"); |
1137 | require cf; |
1225 | require cf; |
|
|
1226 | cf::_connect_to_perl; # nominally unnecessary, but cannot hurt |
|
|
1227 | |
1138 | |
1228 | |
1139 | # load config and database again |
1229 | # load config and database again |
1140 | cf::cfg_load; |
1230 | cf::cfg_load; |
1141 | cf::db_load; |
1231 | cf::db_load; |
1142 | |
1232 | |
… | |
… | |
1158 | warn $_[0]; |
1248 | warn $_[0]; |
1159 | print "$_[0]\n"; |
1249 | print "$_[0]\n"; |
1160 | }; |
1250 | }; |
1161 | } |
1251 | } |
1162 | |
1252 | |
|
|
1253 | register "<global>", __PACKAGE__; |
|
|
1254 | |
1163 | register_command "perl-reload", 0, sub { |
1255 | register_command "perl-reload" => sub { |
1164 | my ($who, $arg) = @_; |
1256 | my ($who, $arg) = @_; |
1165 | |
1257 | |
1166 | if ($who->flag (FLAG_WIZ)) { |
1258 | if ($who->flag (FLAG_WIZ)) { |
1167 | _perl_reload { |
1259 | _perl_reload { |
1168 | warn $_[0]; |
1260 | warn $_[0]; |
1169 | $who->message ($_[0]); |
1261 | $who->message ($_[0]); |
1170 | }; |
1262 | }; |
1171 | } |
1263 | } |
1172 | }; |
1264 | }; |
1173 | |
1265 | |
1174 | register "<global>", __PACKAGE__; |
|
|
1175 | |
|
|
1176 | unshift @INC, $LIBDIR; |
1266 | unshift @INC, $LIBDIR; |
1177 | |
1267 | |
1178 | $TICK_WATCHER = Event->timer ( |
1268 | $TICK_WATCHER = Event->timer ( |
1179 | prio => 1, |
1269 | prio => 0, |
1180 | async => 1, |
|
|
1181 | at => $NEXT_TICK || 1, |
1270 | at => $NEXT_TICK || 1, |
|
|
1271 | data => WF_AUTOCANCEL, |
1182 | cb => sub { |
1272 | cb => sub { |
1183 | cf::server_tick; # one server iteration |
1273 | cf::server_tick; # one server iteration |
1184 | |
1274 | |
1185 | my $NOW = Event::time; |
1275 | my $NOW = Event::time; |
1186 | $NEXT_TICK += $TICK; |
1276 | $NEXT_TICK += $TICK; |
… | |
… | |
1196 | IO::AIO::max_poll_time $TICK * 0.2; |
1286 | IO::AIO::max_poll_time $TICK * 0.2; |
1197 | |
1287 | |
1198 | Event->io (fd => IO::AIO::poll_fileno, |
1288 | Event->io (fd => IO::AIO::poll_fileno, |
1199 | poll => 'r', |
1289 | poll => 'r', |
1200 | prio => 5, |
1290 | prio => 5, |
|
|
1291 | data => WF_AUTOCANCEL, |
1201 | cb => \&IO::AIO::poll_cb); |
1292 | cb => \&IO::AIO::poll_cb); |
1202 | |
1293 | |
1203 | 1 |
1294 | 1 |
1204 | |
1295 | |