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; |
|
|
9 | use Opcode; |
|
|
10 | use Safe; |
|
|
11 | use Safe::Hole; |
|
|
12 | |
|
|
13 | use Coro 3.3; |
6 | use Event; |
14 | use Coro::Event; |
|
|
15 | use Coro::Timer; |
|
|
16 | use Coro::Signal; |
|
|
17 | use Coro::Semaphore; |
|
|
18 | use Coro::AIO; |
7 | |
19 | |
8 | use strict; |
20 | use Fcntl; |
|
|
21 | use IO::AIO 2.31 (); |
|
|
22 | use YAML::Syck (); |
|
|
23 | use Time::HiRes; |
9 | |
24 | |
10 | our %COMMAND; |
25 | use Event; $Event::Eval = 1; # no idea why this is required, but it is |
|
|
26 | |
|
|
27 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
|
|
28 | $YAML::Syck::ImplicitUnicode = 1; |
|
|
29 | |
|
|
30 | $Coro::main->prio (2); # run main coroutine ("the server") with very high priority |
|
|
31 | |
|
|
32 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
|
|
33 | |
|
|
34 | our %COMMAND = (); |
|
|
35 | our %COMMAND_TIME = (); |
|
|
36 | our %EXTCMD = (); |
|
|
37 | |
11 | our @EVENT; |
38 | our @EVENT; |
12 | our %PROP_TYPE; |
39 | our $LIBDIR = datadir . "/ext"; |
13 | our %PROP_IDX; |
40 | |
|
|
41 | our $TICK = MAX_TIME * 1e-6; |
|
|
42 | our $TICK_WATCHER; |
|
|
43 | our $NEXT_TICK; |
|
|
44 | our $NOW; |
|
|
45 | |
|
|
46 | our %CFG; |
|
|
47 | |
|
|
48 | our $UPTIME; $UPTIME ||= time; |
|
|
49 | our $RUNTIME; |
|
|
50 | |
|
|
51 | our %MAP; # all maps |
|
|
52 | our $LINK_MAP; # the special {link} map |
|
|
53 | our $FREEZE; |
|
|
54 | |
|
|
55 | binmode STDOUT; |
|
|
56 | binmode STDERR; |
|
|
57 | |
|
|
58 | # read virtual server time, if available |
|
|
59 | unless ($RUNTIME || !-e cf::localdir . "/runtime") { |
|
|
60 | open my $fh, "<", cf::localdir . "/runtime" |
|
|
61 | or die "unable to read runtime file: $!"; |
|
|
62 | $RUNTIME = <$fh> + 0.; |
|
|
63 | } |
|
|
64 | |
|
|
65 | mkdir cf::localdir; |
|
|
66 | mkdir cf::localdir . "/" . cf::playerdir; |
|
|
67 | mkdir cf::localdir . "/" . cf::tmpdir; |
|
|
68 | mkdir cf::localdir . "/" . cf::uniquedir; |
|
|
69 | |
|
|
70 | our %EXT_CORO; |
|
|
71 | |
|
|
72 | ############################################################################# |
|
|
73 | |
|
|
74 | =head2 GLOBAL VARIABLES |
|
|
75 | |
|
|
76 | =over 4 |
|
|
77 | |
|
|
78 | =item $cf::UPTIME |
|
|
79 | |
|
|
80 | The timestamp of the server start (so not actually an uptime). |
|
|
81 | |
|
|
82 | =item $cf::RUNTIME |
|
|
83 | |
|
|
84 | The time this server has run, starts at 0 and is increased by $cf::TICK on |
|
|
85 | every server tick. |
|
|
86 | |
|
|
87 | =item $cf::LIBDIR |
|
|
88 | |
|
|
89 | The perl library directory, where extensions and cf-specific modules can |
|
|
90 | be found. It will be added to C<@INC> automatically. |
|
|
91 | |
|
|
92 | =item $cf::NOW |
|
|
93 | |
|
|
94 | The time of the last (current) server tick. |
|
|
95 | |
|
|
96 | =item $cf::TICK |
|
|
97 | |
|
|
98 | The interval between server ticks, in seconds. |
|
|
99 | |
|
|
100 | =item %cf::CFG |
|
|
101 | |
|
|
102 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
|
|
103 | from wherever your confdir points to. |
|
|
104 | |
|
|
105 | =back |
|
|
106 | |
|
|
107 | =cut |
14 | |
108 | |
15 | BEGIN { |
109 | BEGIN { |
16 | @EVENT = map lc, @EVENT; |
|
|
17 | |
|
|
18 | *CORE::GLOBAL::warn = sub { |
110 | *CORE::GLOBAL::warn = sub { |
19 | my $msg = join "", @_; |
111 | my $msg = join "", @_; |
|
|
112 | utf8::encode $msg; |
|
|
113 | |
20 | $msg .= "\n" |
114 | $msg .= "\n" |
21 | unless $msg =~ /\n$/; |
115 | unless $msg =~ /\n$/; |
22 | |
116 | |
23 | print STDERR "cfperl: $msg"; |
|
|
24 | LOG llevError, "cfperl: $msg"; |
117 | LOG llevError, "cfperl: $msg"; |
25 | }; |
118 | }; |
26 | } |
119 | } |
27 | |
120 | |
28 | my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
121 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
|
|
122 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
|
|
123 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
|
|
124 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
|
|
125 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
|
|
126 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
29 | |
127 | |
30 | # generate property mutators |
128 | # we bless all objects into (empty) derived classes to force a method lookup |
31 | sub prop_gen { |
129 | # within the Safe compartment. |
32 | my ($prefix, $class) = @_; |
130 | for my $pkg (qw( |
33 | |
131 | cf::global cf::attachable |
|
|
132 | cf::object cf::object::player |
|
|
133 | cf::client cf::player |
|
|
134 | cf::arch cf::living |
|
|
135 | cf::map cf::party cf::region |
|
|
136 | )) { |
34 | no strict 'refs'; |
137 | no strict 'refs'; |
35 | |
138 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
36 | for my $prop (keys %PROP_TYPE) { |
|
|
37 | $prop =~ /^\Q$prefix\E_(.*$)/ or next; |
|
|
38 | my $sub = lc $1; |
|
|
39 | |
|
|
40 | my $type = $PROP_TYPE{$prop}; |
|
|
41 | my $idx = $PROP_IDX {$prop}; |
|
|
42 | |
|
|
43 | *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { |
|
|
44 | $_[0]->get_property ($type, $idx) |
|
|
45 | }; |
|
|
46 | |
|
|
47 | *{"$class\::set_$sub"} = sub { |
|
|
48 | $_[0]->set_property ($type, $idx, $_[1]); |
|
|
49 | } unless $ignore_set{$prop}; |
|
|
50 | } |
|
|
51 | } |
139 | } |
52 | |
|
|
53 | # auto-generate most of the API |
|
|
54 | |
|
|
55 | prop_gen OBJECT_PROP => "cf::object"; |
|
|
56 | # CFAPI_OBJECT_ANIMATION? |
|
|
57 | prop_gen PLAYER_PROP => "cf::object::player"; |
|
|
58 | |
|
|
59 | prop_gen MAP_PROP => "cf::map"; |
|
|
60 | prop_gen ARCH_PROP => "cf::arch"; |
|
|
61 | |
|
|
62 | # guessed hierarchies |
|
|
63 | |
|
|
64 | @cf::object::player::ISA = 'cf::object'; |
|
|
65 | @cf::object::map::ISA = 'cf::object'; |
|
|
66 | |
140 | |
67 | $Event::DIED = sub { |
141 | $Event::DIED = sub { |
68 | warn "error in event callback: @_"; |
142 | warn "error in event callback: @_"; |
69 | }; |
143 | }; |
70 | |
144 | |
71 | my %ext_pkg; |
145 | my %ext_pkg; |
72 | my @exts; |
146 | my @exts; |
73 | my @hook; |
147 | my @hook; |
74 | my %command; |
|
|
75 | my %extcmd; |
|
|
76 | |
148 | |
77 | sub inject_event { |
149 | =head2 UTILITY FUNCTIONS |
78 | my $extension = shift; |
150 | |
|
|
151 | =over 4 |
|
|
152 | |
|
|
153 | =cut |
|
|
154 | |
|
|
155 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
156 | |
|
|
157 | =item $ref = cf::from_json $json |
|
|
158 | |
|
|
159 | Converts a JSON string into the corresponding perl data structure. |
|
|
160 | |
|
|
161 | =cut |
|
|
162 | |
|
|
163 | sub from_json($) { |
|
|
164 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
|
|
165 | JSON::Syck::Load $_[0] |
|
|
166 | } |
|
|
167 | |
|
|
168 | =item $json = cf::to_json $ref |
|
|
169 | |
|
|
170 | Converts a perl data structure into its JSON representation. |
|
|
171 | |
|
|
172 | =cut |
|
|
173 | |
|
|
174 | sub to_json($) { |
|
|
175 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
|
|
176 | JSON::Syck::Dump $_[0] |
|
|
177 | } |
|
|
178 | |
|
|
179 | =item cf::sync_job { BLOCK } |
|
|
180 | |
|
|
181 | The design of crossfire+ requires that the main coro ($Coro::main) is |
|
|
182 | always able to handle events or runnable, as crossfire+ is only partly |
|
|
183 | reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. |
|
|
184 | |
|
|
185 | If it must be done, put the blocking parts into C<sync_job>. This will run |
|
|
186 | the given BLOCK in another coroutine while waiting for the result. The |
|
|
187 | server will be frozen during this time, so the block should either finish |
|
|
188 | fast or be very important. |
|
|
189 | |
|
|
190 | =cut |
|
|
191 | |
|
|
192 | sub sync_job(&) { |
|
|
193 | my ($job) = @_; |
|
|
194 | |
|
|
195 | my $busy = 1; |
|
|
196 | my @res; |
|
|
197 | |
|
|
198 | # TODO: use suspend/resume instead |
|
|
199 | local $FREEZE = 1; |
|
|
200 | |
|
|
201 | my $coro = Coro::async { |
|
|
202 | @res = eval { $job->() }; |
|
|
203 | warn $@ if $@; |
|
|
204 | undef $busy; |
|
|
205 | }; |
|
|
206 | |
|
|
207 | if ($Coro::current == $Coro::main) { |
|
|
208 | $coro->prio (Coro::PRIO_MAX); |
|
|
209 | while ($busy) { |
|
|
210 | Coro::cede_notself; |
|
|
211 | Event::one_event unless Coro::nready; |
|
|
212 | } |
|
|
213 | } else { |
|
|
214 | $coro->join; |
|
|
215 | } |
|
|
216 | |
|
|
217 | wantarray ? @res : $res[0] |
|
|
218 | } |
|
|
219 | |
|
|
220 | =item $coro = cf::coro { BLOCK } |
|
|
221 | |
|
|
222 | Creates and returns a new coro. This coro is automcatially being canceled |
|
|
223 | when the extension calling this is being unloaded. |
|
|
224 | |
|
|
225 | =cut |
|
|
226 | |
|
|
227 | sub coro(&) { |
|
|
228 | my $cb = shift; |
|
|
229 | |
|
|
230 | my $coro; $coro = async { |
|
|
231 | eval { |
|
|
232 | $cb->(); |
|
|
233 | }; |
|
|
234 | warn $@ if $@; |
|
|
235 | }; |
|
|
236 | |
|
|
237 | $coro->on_destroy (sub { |
|
|
238 | delete $EXT_CORO{$coro+0}; |
|
|
239 | }); |
|
|
240 | $EXT_CORO{$coro+0} = $coro; |
|
|
241 | |
|
|
242 | $coro |
|
|
243 | } |
|
|
244 | |
|
|
245 | =back |
|
|
246 | |
|
|
247 | =cut |
|
|
248 | |
|
|
249 | ############################################################################# |
|
|
250 | |
|
|
251 | =head2 ATTACHABLE OBJECTS |
|
|
252 | |
|
|
253 | Many objects in crossfire are so-called attachable objects. That means you can |
|
|
254 | attach callbacks/event handlers (a collection of which is called an "attachment") |
|
|
255 | to it. All such attachable objects support the following methods. |
|
|
256 | |
|
|
257 | In the following description, CLASS can be any of C<global>, C<object> |
|
|
258 | C<player>, C<client> or C<map> (i.e. the attachable objects in |
|
|
259 | crossfire+). |
|
|
260 | |
|
|
261 | =over 4 |
|
|
262 | |
|
|
263 | =item $attachable->attach ($attachment, key => $value...) |
|
|
264 | |
|
|
265 | =item $attachable->detach ($attachment) |
|
|
266 | |
|
|
267 | Attach/detach a pre-registered attachment to a specific object and give it |
|
|
268 | the specified key/value pairs as arguments. |
|
|
269 | |
|
|
270 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
271 | 10x10 minesweeper game: |
|
|
272 | |
|
|
273 | $obj->attach (minesweeper => width => 10, height => 10); |
|
|
274 | |
|
|
275 | =item $bool = $attachable->attached ($name) |
|
|
276 | |
|
|
277 | Checks wether the named attachment is currently attached to the object. |
|
|
278 | |
|
|
279 | =item cf::CLASS->attach ... |
|
|
280 | |
|
|
281 | =item cf::CLASS->detach ... |
|
|
282 | |
|
|
283 | Define an anonymous attachment and attach it to all objects of the given |
|
|
284 | CLASS. See the next function for an explanation of its arguments. |
|
|
285 | |
|
|
286 | You can attach to global events by using the C<cf::global> class. |
|
|
287 | |
|
|
288 | Example, log all player logins: |
|
|
289 | |
|
|
290 | cf::player->attach ( |
|
|
291 | on_login => sub { |
|
|
292 | my ($pl) = @_; |
|
|
293 | ... |
|
|
294 | }, |
|
|
295 | ); |
|
|
296 | |
|
|
297 | Example, attach to the jeweler skill: |
|
|
298 | |
|
|
299 | cf::object->attach ( |
|
|
300 | type => cf::SKILL, |
|
|
301 | subtype => cf::SK_JEWELER, |
|
|
302 | on_use_skill => sub { |
|
|
303 | my ($sk, $ob, $part, $dir, $msg) = @_; |
|
|
304 | ... |
|
|
305 | }, |
|
|
306 | ); |
|
|
307 | |
|
|
308 | =item cf::CLASS::attachment $name, ... |
|
|
309 | |
|
|
310 | Register an attachment by C<$name> through which attachable objects of the |
|
|
311 | given CLASS can refer to this attachment. |
|
|
312 | |
|
|
313 | Some classes such as crossfire maps and objects can specify attachments |
|
|
314 | that are attached at load/instantiate time, thus the need for a name. |
|
|
315 | |
|
|
316 | These calls expect any number of the following handler/hook descriptions: |
|
|
317 | |
|
|
318 | =over 4 |
|
|
319 | |
|
|
320 | =item prio => $number |
|
|
321 | |
|
|
322 | Set the priority for all following handlers/hooks (unless overwritten |
|
|
323 | by another C<prio> setting). Lower priority handlers get executed |
|
|
324 | earlier. The default priority is C<0>, and many built-in handlers are |
|
|
325 | registered at priority C<-1000>, so lower priorities should not be used |
|
|
326 | unless you know what you are doing. |
|
|
327 | |
|
|
328 | =item type => $type |
|
|
329 | |
|
|
330 | (Only for C<< cf::object->attach >> calls), limits the attachment to the |
|
|
331 | given type of objects only (the additional parameter C<subtype> can be |
|
|
332 | used to further limit to the given subtype). |
|
|
333 | |
|
|
334 | =item on_I<event> => \&cb |
|
|
335 | |
|
|
336 | Call the given code reference whenever the named event happens (event is |
|
|
337 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
|
|
338 | handlers are recognised generally depends on the type of object these |
|
|
339 | handlers attach to). |
|
|
340 | |
|
|
341 | See F<include/eventinc.h> for the full list of events supported, and their |
|
|
342 | class. |
|
|
343 | |
|
|
344 | =item package => package:: |
|
|
345 | |
|
|
346 | Look for sub functions of the name C<< on_I<event> >> in the given |
|
|
347 | package and register them. Only handlers for eevents supported by the |
|
|
348 | object/class are recognised. |
|
|
349 | |
|
|
350 | =back |
|
|
351 | |
|
|
352 | Example, define an attachment called "sockpuppet" that calls the given |
|
|
353 | event handler when a monster attacks: |
|
|
354 | |
|
|
355 | cf::object::attachment sockpuppet => |
|
|
356 | on_skill_attack => sub { |
|
|
357 | my ($self, $victim) = @_; |
|
|
358 | ... |
|
|
359 | } |
|
|
360 | } |
|
|
361 | |
|
|
362 | =item $attachable->valid |
|
|
363 | |
|
|
364 | Just because you have a perl object does not mean that the corresponding |
|
|
365 | C-level object still exists. If you try to access an object that has no |
|
|
366 | valid C counterpart anymore you get an exception at runtime. This method |
|
|
367 | can be used to test for existence of the C object part without causing an |
|
|
368 | exception. |
|
|
369 | |
|
|
370 | =cut |
|
|
371 | |
|
|
372 | # the following variables are defined in .xs and must not be re-created |
|
|
373 | our @CB_GLOBAL = (); # registry for all global events |
|
|
374 | our @CB_ATTACHABLE = (); # registry for all attachables |
|
|
375 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
376 | our @CB_PLAYER = (); |
|
|
377 | our @CB_CLIENT = (); |
|
|
378 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
379 | our @CB_MAP = (); |
|
|
380 | |
|
|
381 | my %attachment; |
|
|
382 | |
|
|
383 | sub _attach_cb($$$$) { |
|
|
384 | my ($registry, $event, $prio, $cb) = @_; |
|
|
385 | |
|
|
386 | use sort 'stable'; |
|
|
387 | |
|
|
388 | $cb = [$prio, $cb]; |
|
|
389 | |
|
|
390 | @{$registry->[$event]} = sort |
|
|
391 | { $a->[0] cmp $b->[0] } |
|
|
392 | @{$registry->[$event] || []}, $cb; |
|
|
393 | } |
|
|
394 | |
|
|
395 | # hack |
|
|
396 | my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP; |
|
|
397 | |
|
|
398 | # attach handles attaching event callbacks |
|
|
399 | # the only thing the caller has to do is pass the correct |
|
|
400 | # registry (== where the callback attaches to). |
|
|
401 | sub _attach { |
|
|
402 | my ($registry, $klass, @arg) = @_; |
|
|
403 | |
|
|
404 | my $object_type; |
|
|
405 | my $prio = 0; |
|
|
406 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
407 | |
|
|
408 | #TODO: get rid of this hack |
|
|
409 | if ($attachable_klass{$klass}) { |
|
|
410 | %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT); |
|
|
411 | } |
|
|
412 | |
|
|
413 | while (@arg) { |
|
|
414 | my $type = shift @arg; |
|
|
415 | |
|
|
416 | if ($type eq "prio") { |
|
|
417 | $prio = shift @arg; |
|
|
418 | |
|
|
419 | } elsif ($type eq "type") { |
|
|
420 | $object_type = shift @arg; |
|
|
421 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
422 | |
|
|
423 | } elsif ($type eq "subtype") { |
|
|
424 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
425 | my $object_subtype = shift @arg; |
|
|
426 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
|
|
427 | |
|
|
428 | } elsif ($type eq "package") { |
|
|
429 | my $pkg = shift @arg; |
|
|
430 | |
|
|
431 | while (my ($name, $id) = each %cb_id) { |
|
|
432 | if (my $cb = $pkg->can ($name)) { |
|
|
433 | _attach_cb $registry, $id, $prio, $cb; |
|
|
434 | } |
|
|
435 | } |
|
|
436 | |
|
|
437 | } elsif (exists $cb_id{$type}) { |
|
|
438 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
|
|
439 | |
|
|
440 | } elsif (ref $type) { |
|
|
441 | warn "attaching objects not supported, ignoring.\n"; |
|
|
442 | |
|
|
443 | } else { |
|
|
444 | shift @arg; |
|
|
445 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
446 | } |
|
|
447 | } |
|
|
448 | } |
|
|
449 | |
|
|
450 | sub _object_attach { |
|
|
451 | my ($obj, $name, %arg) = @_; |
|
|
452 | |
|
|
453 | return if exists $obj->{_attachment}{$name}; |
|
|
454 | |
|
|
455 | if (my $attach = $attachment{$name}) { |
|
|
456 | my $registry = $obj->registry; |
|
|
457 | |
|
|
458 | for (@$attach) { |
|
|
459 | my ($klass, @attach) = @$_; |
|
|
460 | _attach $registry, $klass, @attach; |
|
|
461 | } |
|
|
462 | |
|
|
463 | $obj->{$name} = \%arg; |
|
|
464 | } else { |
|
|
465 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
466 | } |
|
|
467 | |
|
|
468 | $obj->{_attachment}{$name} = undef; |
|
|
469 | } |
|
|
470 | |
|
|
471 | sub cf::attachable::attach { |
|
|
472 | if (ref $_[0]) { |
|
|
473 | _object_attach @_; |
|
|
474 | } else { |
|
|
475 | _attach shift->_attach_registry, @_; |
|
|
476 | } |
|
|
477 | }; |
|
|
478 | |
|
|
479 | # all those should be optimised |
|
|
480 | sub cf::attachable::detach { |
|
|
481 | my ($obj, $name) = @_; |
|
|
482 | |
|
|
483 | if (ref $obj) { |
|
|
484 | delete $obj->{_attachment}{$name}; |
|
|
485 | reattach ($obj); |
|
|
486 | } else { |
|
|
487 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
488 | } |
|
|
489 | }; |
|
|
490 | |
|
|
491 | sub cf::attachable::attached { |
|
|
492 | my ($obj, $name) = @_; |
|
|
493 | |
|
|
494 | exists $obj->{_attachment}{$name} |
|
|
495 | } |
|
|
496 | |
|
|
497 | for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) { |
|
|
498 | eval "#line " . __LINE__ . " 'cf.pm' |
|
|
499 | sub cf::\L$klass\E::_attach_registry { |
|
|
500 | (\\\@CB_$klass, KLASS_$klass) |
|
|
501 | } |
|
|
502 | |
|
|
503 | sub cf::\L$klass\E::attachment { |
|
|
504 | my \$name = shift; |
|
|
505 | |
|
|
506 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
507 | } |
|
|
508 | "; |
|
|
509 | die if $@; |
|
|
510 | } |
|
|
511 | |
|
|
512 | our $override; |
|
|
513 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
514 | |
|
|
515 | sub override { |
|
|
516 | $override = 1; |
|
|
517 | @invoke_results = (); |
|
|
518 | } |
|
|
519 | |
|
|
520 | sub do_invoke { |
79 | my $event_code = shift; |
521 | my $event = shift; |
|
|
522 | my $callbacks = shift; |
80 | |
523 | |
81 | my $cb = $hook[$event_code]{$extension} |
524 | @invoke_results = (); |
|
|
525 | |
|
|
526 | local $override; |
|
|
527 | |
|
|
528 | for (@$callbacks) { |
|
|
529 | eval { &{$_->[1]} }; |
|
|
530 | |
|
|
531 | if ($@) { |
|
|
532 | warn "$@"; |
|
|
533 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
534 | override; |
|
|
535 | } |
|
|
536 | |
|
|
537 | return 1 if $override; |
|
|
538 | } |
|
|
539 | |
|
|
540 | 0 |
|
|
541 | } |
|
|
542 | |
|
|
543 | =item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) |
|
|
544 | |
|
|
545 | =item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) |
|
|
546 | |
|
|
547 | Generate an object-specific event with the given arguments. |
|
|
548 | |
|
|
549 | This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be |
|
|
550 | removed in future versions), and there is no public API to access override |
|
|
551 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
552 | |
|
|
553 | =back |
|
|
554 | |
|
|
555 | =cut |
|
|
556 | |
|
|
557 | ############################################################################# |
|
|
558 | # object support |
|
|
559 | |
|
|
560 | sub reattach { |
|
|
561 | # basically do the same as instantiate, without calling instantiate |
|
|
562 | my ($obj) = @_; |
|
|
563 | |
|
|
564 | my $registry = $obj->registry; |
|
|
565 | |
|
|
566 | @$registry = (); |
|
|
567 | |
|
|
568 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
|
|
569 | |
|
|
570 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
|
|
571 | if (my $attach = $attachment{$name}) { |
|
|
572 | for (@$attach) { |
|
|
573 | my ($klass, @attach) = @$_; |
|
|
574 | _attach $registry, $klass, @attach; |
|
|
575 | } |
|
|
576 | } else { |
|
|
577 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
578 | } |
|
|
579 | } |
|
|
580 | } |
|
|
581 | |
|
|
582 | cf::attachable->attach ( |
|
|
583 | prio => -1000000, |
|
|
584 | on_instantiate => sub { |
|
|
585 | my ($obj, $data) = @_; |
|
|
586 | |
|
|
587 | $data = from_json $data; |
|
|
588 | |
|
|
589 | for (@$data) { |
|
|
590 | my ($name, $args) = @$_; |
|
|
591 | |
|
|
592 | $obj->attach ($name, %{$args || {} }); |
|
|
593 | } |
|
|
594 | }, |
|
|
595 | on_reattach => \&reattach, |
|
|
596 | on_clone => sub { |
|
|
597 | my ($src, $dst) = @_; |
|
|
598 | |
|
|
599 | @{$dst->registry} = @{$src->registry}; |
|
|
600 | |
|
|
601 | %$dst = %$src; |
|
|
602 | |
|
|
603 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
|
|
604 | if exists $src->{_attachment}; |
|
|
605 | }, |
|
|
606 | ); |
|
|
607 | |
|
|
608 | sub object_freezer_save { |
|
|
609 | my ($filename, $rdata, $objs) = @_; |
|
|
610 | |
|
|
611 | sync_job { |
|
|
612 | if (length $$rdata) { |
|
|
613 | warn sprintf "saving %s (%d,%d)\n", |
|
|
614 | $filename, length $$rdata, scalar @$objs; |
|
|
615 | |
|
|
616 | if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { |
|
|
617 | chmod SAVE_MODE, $fh; |
|
|
618 | aio_write $fh, 0, (length $$rdata), $$rdata, 0; |
|
|
619 | aio_fsync $fh; |
|
|
620 | close $fh; |
|
|
621 | |
|
|
622 | if (@$objs) { |
|
|
623 | if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { |
|
|
624 | chmod SAVE_MODE, $fh; |
|
|
625 | my $data = Storable::nfreeze { version => 1, objs => $objs }; |
|
|
626 | aio_write $fh, 0, (length $data), $data, 0; |
|
|
627 | aio_fsync $fh; |
|
|
628 | close $fh; |
|
|
629 | aio_rename "$filename.pst~", "$filename.pst"; |
|
|
630 | } |
|
|
631 | } else { |
|
|
632 | aio_unlink "$filename.pst"; |
|
|
633 | } |
|
|
634 | |
|
|
635 | aio_rename "$filename~", $filename; |
|
|
636 | } else { |
|
|
637 | warn "FATAL: $filename~: $!\n"; |
|
|
638 | } |
|
|
639 | } else { |
|
|
640 | aio_unlink $filename; |
|
|
641 | aio_unlink "$filename.pst"; |
|
|
642 | } |
|
|
643 | } |
|
|
644 | } |
|
|
645 | |
|
|
646 | sub object_freezer_as_string { |
|
|
647 | my ($rdata, $objs) = @_; |
|
|
648 | |
|
|
649 | use Data::Dumper; |
|
|
650 | |
|
|
651 | $$rdata . Dumper $objs |
|
|
652 | } |
|
|
653 | |
|
|
654 | sub object_thawer_load { |
|
|
655 | my ($filename) = @_; |
|
|
656 | |
|
|
657 | my ($data, $av); |
|
|
658 | |
|
|
659 | (aio_load $filename, $data) >= 0 |
82 | or return; |
660 | or return; |
83 | |
661 | |
84 | &$cb |
662 | unless (aio_stat "$filename.pst") { |
85 | } |
663 | (aio_load "$filename.pst", $av) >= 0 |
86 | |
|
|
87 | sub inject_global_event { |
|
|
88 | my $event = shift; |
|
|
89 | |
|
|
90 | my $cb = $hook[$event] |
|
|
91 | or return; |
664 | or return; |
92 | |
665 | $av = eval { (Storable::thaw <$av>)->{objs} }; |
93 | List::Util::max map &$_, values %$cb |
|
|
94 | } |
|
|
95 | |
|
|
96 | sub inject_command { |
|
|
97 | my ($name, $obj, $params) = @_; |
|
|
98 | |
|
|
99 | for my $cmd (@{ $command{$name} }) { |
|
|
100 | $cmd->[1]->($obj, $params); |
|
|
101 | } |
666 | } |
102 | |
667 | |
103 | -1 |
668 | return ($data, $av); |
104 | } |
669 | } |
|
|
670 | |
|
|
671 | ############################################################################# |
|
|
672 | # command handling &c |
|
|
673 | |
|
|
674 | =item cf::register_command $name => \&callback($ob,$args); |
|
|
675 | |
|
|
676 | Register a callback for execution when the client sends the user command |
|
|
677 | $name. |
|
|
678 | |
|
|
679 | =cut |
105 | |
680 | |
106 | sub register_command { |
681 | sub register_command { |
107 | my ($name, $time, $cb) = @_; |
682 | my ($name, $cb) = @_; |
108 | |
683 | |
109 | my $caller = caller; |
684 | my $caller = caller; |
110 | #warn "registering command '$name/$time' to '$caller'"; |
685 | #warn "registering command '$name/$time' to '$caller'"; |
111 | |
686 | |
112 | push @{ $command{$name} }, [$time, $cb, $caller]; |
687 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
113 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
114 | } |
688 | } |
|
|
689 | |
|
|
690 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
691 | |
|
|
692 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
693 | |
|
|
694 | If the callback returns something, it is sent back as if reply was being |
|
|
695 | called. |
|
|
696 | |
|
|
697 | =cut |
115 | |
698 | |
116 | sub register_extcmd { |
699 | sub register_extcmd { |
117 | my ($name, $cb) = @_; |
700 | my ($name, $cb) = @_; |
118 | |
701 | |
119 | my $caller = caller; |
702 | my $caller = caller; |
120 | #warn "registering extcmd '$name' to '$caller'"; |
703 | #warn "registering extcmd '$name' to '$caller'"; |
121 | |
704 | |
122 | $extcmd{$name} = [$cb, $caller]; |
705 | $EXTCMD{$name} = [$cb, $caller]; |
123 | } |
706 | } |
|
|
707 | |
|
|
708 | cf::player->attach ( |
|
|
709 | on_command => sub { |
|
|
710 | my ($pl, $name, $params) = @_; |
|
|
711 | |
|
|
712 | my $cb = $COMMAND{$name} |
|
|
713 | or return; |
|
|
714 | |
|
|
715 | for my $cmd (@$cb) { |
|
|
716 | $cmd->[1]->($pl->ob, $params); |
|
|
717 | } |
|
|
718 | |
|
|
719 | cf::override; |
|
|
720 | }, |
|
|
721 | on_extcmd => sub { |
|
|
722 | my ($pl, $buf) = @_; |
|
|
723 | |
|
|
724 | my $msg = eval { from_json $buf }; |
|
|
725 | |
|
|
726 | if (ref $msg) { |
|
|
727 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
728 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
729 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
730 | } |
|
|
731 | } |
|
|
732 | } else { |
|
|
733 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
734 | } |
|
|
735 | |
|
|
736 | cf::override; |
|
|
737 | }, |
|
|
738 | ); |
124 | |
739 | |
125 | sub register { |
740 | sub register { |
126 | my ($base, $pkg) = @_; |
741 | my ($base, $pkg) = @_; |
127 | |
742 | |
128 | for my $idx (0 .. $#EVENT) { |
743 | #TODO |
129 | if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { |
|
|
130 | #warn "registering $EVENT[$idx] hook to '$pkg'\n"; |
|
|
131 | $hook[$idx]{$base} = $ref; |
|
|
132 | } |
|
|
133 | } |
|
|
134 | } |
744 | } |
135 | |
745 | |
136 | sub load_extension { |
746 | sub load_extension { |
137 | my ($path) = @_; |
747 | my ($path) = @_; |
138 | |
748 | |
139 | $path =~ /([^\/\\]+)\.ext$/ or die "$path"; |
749 | $path =~ /([^\/\\]+)\.ext$/ or die "$path"; |
140 | my $base = $1; |
750 | my $base = $1; |
141 | my $pkg = $1; |
751 | my $pkg = $1; |
142 | $pkg =~ s/[^[:word:]]/_/g; |
752 | $pkg =~ s/[^[:word:]]/_/g; |
143 | $pkg = "cf::ext::$pkg"; |
753 | $pkg = "ext::$pkg"; |
144 | |
754 | |
145 | warn "loading '$path' into '$pkg'\n"; |
755 | warn "loading '$path' into '$pkg'\n"; |
146 | |
756 | |
147 | open my $fh, "<:utf8", $path |
757 | open my $fh, "<:utf8", $path |
148 | or die "$path: $!"; |
758 | or die "$path: $!"; |
… | |
… | |
152 | . "#line 1 \"$path\"\n{\n" |
762 | . "#line 1 \"$path\"\n{\n" |
153 | . (do { local $/; <$fh> }) |
763 | . (do { local $/; <$fh> }) |
154 | . "\n};\n1"; |
764 | . "\n};\n1"; |
155 | |
765 | |
156 | eval $source |
766 | eval $source |
157 | or die "$path: $@"; |
767 | or die $@ ? "$path: $@\n" |
|
|
768 | : "extension disabled.\n"; |
158 | |
769 | |
159 | push @exts, $pkg; |
770 | push @exts, $pkg; |
160 | $ext_pkg{$base} = $pkg; |
771 | $ext_pkg{$base} = $pkg; |
161 | |
772 | |
162 | # no strict 'refs'; |
773 | # no strict 'refs'; |
163 | # @{"$pkg\::ISA"} = cf::ext::; |
774 | # @{"$pkg\::ISA"} = ext::; |
164 | |
775 | |
165 | register $base, $pkg; |
776 | register $base, $pkg; |
166 | } |
777 | } |
167 | |
778 | |
168 | sub unload_extension { |
779 | sub unload_extension { |
169 | my ($pkg) = @_; |
780 | my ($pkg) = @_; |
170 | |
781 | |
171 | warn "removing extension $pkg\n"; |
782 | warn "removing extension $pkg\n"; |
172 | |
783 | |
173 | # remove hooks |
784 | # remove hooks |
|
|
785 | #TODO |
174 | for my $idx (0 .. $#EVENT) { |
786 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
175 | delete $hook[$idx]{$pkg}; |
787 | # delete $hook[$idx]{$pkg}; |
176 | } |
788 | # } |
177 | |
789 | |
178 | # remove commands |
790 | # remove commands |
179 | for my $name (keys %command) { |
791 | for my $name (keys %COMMAND) { |
180 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
792 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
181 | |
793 | |
182 | if (@cb) { |
794 | if (@cb) { |
183 | $command{$name} = \@cb; |
795 | $COMMAND{$name} = \@cb; |
184 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
185 | } else { |
796 | } else { |
186 | delete $command{$name}; |
|
|
187 | delete $COMMAND{"$name\000"}; |
797 | delete $COMMAND{$name}; |
188 | } |
798 | } |
189 | } |
799 | } |
190 | |
800 | |
191 | # remove extcmds |
801 | # remove extcmds |
192 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
802 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
193 | delete $extcmd{$name}; |
803 | delete $EXTCMD{$name}; |
|
|
804 | } |
|
|
805 | |
|
|
806 | if (my $cb = $pkg->can ("unload")) { |
|
|
807 | eval { |
|
|
808 | $cb->($pkg); |
|
|
809 | 1 |
|
|
810 | } or warn "$pkg unloaded, but with errors: $@"; |
194 | } |
811 | } |
195 | |
812 | |
196 | Symbol::delete_package $pkg; |
813 | Symbol::delete_package $pkg; |
197 | } |
814 | } |
198 | |
815 | |
199 | sub load_extensions { |
816 | sub load_extensions { |
200 | my $LIBDIR = maps_directory "perl"; |
|
|
201 | |
|
|
202 | for my $ext (<$LIBDIR/*.ext>) { |
817 | for my $ext (<$LIBDIR/*.ext>) { |
203 | next unless -r $ext; |
818 | next unless -r $ext; |
204 | eval { |
819 | eval { |
205 | load_extension $ext; |
820 | load_extension $ext; |
206 | 1 |
821 | 1 |
207 | } or warn "$ext not loaded: $@"; |
822 | } or warn "$ext not loaded: $@"; |
208 | } |
823 | } |
209 | } |
824 | } |
210 | |
825 | |
211 | register_command "perl-reload", 0, sub { |
826 | ############################################################################# |
|
|
827 | # load/save/clean perl data associated with a map |
|
|
828 | |
|
|
829 | *cf::mapsupport::on_clean = sub { |
212 | my ($who, $arg) = @_; |
830 | my ($map) = @_; |
213 | |
831 | |
214 | if ($who->flag (FLAG_WIZ)) { |
832 | my $path = $map->tmpname; |
215 | $who->message ("reloading..."); |
833 | defined $path or return; |
216 | |
834 | |
217 | warn "reloading...\n"; |
835 | unlink "$path.pst"; |
|
|
836 | }; |
|
|
837 | |
|
|
838 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
|
|
839 | |
|
|
840 | ############################################################################# |
|
|
841 | # load/save perl data associated with player->ob objects |
|
|
842 | |
|
|
843 | sub all_objects(@) { |
|
|
844 | @_, map all_objects ($_->inv), @_ |
|
|
845 | } |
|
|
846 | |
|
|
847 | # TODO: compatibility cruft, remove when no longer needed |
|
|
848 | cf::player->attach ( |
|
|
849 | on_load => sub { |
|
|
850 | my ($pl, $path) = @_; |
|
|
851 | |
|
|
852 | for my $o (all_objects $pl->ob) { |
|
|
853 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
|
|
854 | $o->set_ob_key_value ("_perl_data"); |
|
|
855 | |
|
|
856 | %$o = %{ Storable::thaw pack "H*", $value }; |
|
|
857 | } |
|
|
858 | } |
|
|
859 | }, |
|
|
860 | ); |
|
|
861 | |
|
|
862 | ############################################################################# |
|
|
863 | |
|
|
864 | =head2 CORE EXTENSIONS |
|
|
865 | |
|
|
866 | Functions and methods that extend core crossfire objects. |
|
|
867 | |
|
|
868 | =head3 cf::player |
|
|
869 | |
|
|
870 | =over 4 |
|
|
871 | |
|
|
872 | =item cf::player::exists $login |
|
|
873 | |
|
|
874 | Returns true when the given account exists. |
|
|
875 | |
|
|
876 | =cut |
|
|
877 | |
|
|
878 | sub cf::player::exists($) { |
|
|
879 | cf::player::find $_[0] |
|
|
880 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
|
|
881 | } |
|
|
882 | |
|
|
883 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
884 | |
|
|
885 | Sends an ext reply to the player. |
|
|
886 | |
|
|
887 | =cut |
|
|
888 | |
|
|
889 | sub cf::player::ext_reply($$$%) { |
|
|
890 | my ($self, $id, %msg) = @_; |
|
|
891 | |
|
|
892 | $msg{msgid} = $id; |
|
|
893 | |
|
|
894 | $self->send ("ext " . to_json \%msg); |
|
|
895 | } |
|
|
896 | |
|
|
897 | =back |
|
|
898 | |
|
|
899 | =head3 cf::object::player |
|
|
900 | |
|
|
901 | =over 4 |
|
|
902 | |
|
|
903 | =item $player_object->reply ($npc, $msg[, $flags]) |
|
|
904 | |
|
|
905 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
|
|
906 | can be C<undef>. Does the right thing when the player is currently in a |
|
|
907 | dialogue with the given NPC character. |
|
|
908 | |
|
|
909 | =cut |
|
|
910 | |
|
|
911 | # rough implementation of a future "reply" method that works |
|
|
912 | # with dialog boxes. |
|
|
913 | #TODO: the first argument must go, split into a $npc->reply_to ( method |
|
|
914 | sub cf::object::player::reply($$$;$) { |
|
|
915 | my ($self, $npc, $msg, $flags) = @_; |
|
|
916 | |
|
|
917 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
|
|
918 | |
|
|
919 | if ($self->{record_replies}) { |
|
|
920 | push @{ $self->{record_replies} }, [$npc, $msg, $flags]; |
|
|
921 | } else { |
|
|
922 | $msg = $npc->name . " says: $msg" if $npc; |
|
|
923 | $self->message ($msg, $flags); |
|
|
924 | } |
|
|
925 | } |
|
|
926 | |
|
|
927 | =item $player_object->may ("access") |
|
|
928 | |
|
|
929 | Returns wether the given player is authorized to access resource "access" |
|
|
930 | (e.g. "command_wizcast"). |
|
|
931 | |
|
|
932 | =cut |
|
|
933 | |
|
|
934 | sub cf::object::player::may { |
|
|
935 | my ($self, $access) = @_; |
|
|
936 | |
|
|
937 | $self->flag (cf::FLAG_WIZ) || |
|
|
938 | (ref $cf::CFG{"may_$access"} |
|
|
939 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
|
|
940 | : $cf::CFG{"may_$access"}) |
|
|
941 | } |
|
|
942 | |
|
|
943 | =head3 cf::client |
|
|
944 | |
|
|
945 | =over 4 |
|
|
946 | |
|
|
947 | =item $client->send_drawinfo ($text, $flags) |
|
|
948 | |
|
|
949 | Sends a drawinfo packet to the client. Circumvents output buffering so |
|
|
950 | should not be used under normal circumstances. |
|
|
951 | |
|
|
952 | =cut |
|
|
953 | |
|
|
954 | sub cf::client::send_drawinfo { |
|
|
955 | my ($self, $text, $flags) = @_; |
|
|
956 | |
|
|
957 | utf8::encode $text; |
|
|
958 | $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); |
|
|
959 | } |
|
|
960 | |
|
|
961 | |
|
|
962 | =item $success = $client->query ($flags, "text", \&cb) |
|
|
963 | |
|
|
964 | Queues a query to the client, calling the given callback with |
|
|
965 | the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, |
|
|
966 | C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. |
|
|
967 | |
|
|
968 | Queries can fail, so check the return code. Or don't, as queries will become |
|
|
969 | reliable at some point in the future. |
|
|
970 | |
|
|
971 | =cut |
|
|
972 | |
|
|
973 | sub cf::client::query { |
|
|
974 | my ($self, $flags, $text, $cb) = @_; |
|
|
975 | |
|
|
976 | return unless $self->state == ST_PLAYING |
|
|
977 | || $self->state == ST_SETUP |
|
|
978 | || $self->state == ST_CUSTOM; |
|
|
979 | |
|
|
980 | $self->state (ST_CUSTOM); |
|
|
981 | |
|
|
982 | utf8::encode $text; |
|
|
983 | push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; |
|
|
984 | |
|
|
985 | $self->send_packet ($self->{query_queue}[0][0]) |
|
|
986 | if @{ $self->{query_queue} } == 1; |
|
|
987 | } |
|
|
988 | |
|
|
989 | cf::client->attach ( |
|
|
990 | on_reply => sub { |
|
|
991 | my ($ns, $msg) = @_; |
|
|
992 | |
|
|
993 | # this weird shuffling is so that direct followup queries |
|
|
994 | # get handled first |
|
|
995 | my $queue = delete $ns->{query_queue}; |
|
|
996 | |
|
|
997 | (shift @$queue)->[1]->($msg); |
|
|
998 | |
|
|
999 | push @{ $ns->{query_queue} }, @$queue; |
|
|
1000 | |
|
|
1001 | if (@{ $ns->{query_queue} } == @$queue) { |
|
|
1002 | if (@$queue) { |
|
|
1003 | $ns->send_packet ($ns->{query_queue}[0][0]); |
|
|
1004 | } else { |
|
|
1005 | $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; |
|
|
1006 | } |
|
|
1007 | } |
|
|
1008 | }, |
|
|
1009 | ); |
|
|
1010 | |
|
|
1011 | =item $client->coro (\&cb) |
|
|
1012 | |
|
|
1013 | Create a new coroutine, running the specified callback. The coroutine will |
|
|
1014 | be automatically cancelled when the client gets destroyed (e.g. on logout, |
|
|
1015 | or loss of connection). |
|
|
1016 | |
|
|
1017 | =cut |
|
|
1018 | |
|
|
1019 | sub cf::client::coro { |
|
|
1020 | my ($self, $cb) = @_; |
|
|
1021 | |
|
|
1022 | my $coro; $coro = async { |
218 | eval { |
1023 | eval { |
219 | unload_extension $_ for @exts; |
1024 | $cb->(); |
220 | delete $INC{"cf.pm"}; |
|
|
221 | |
|
|
222 | # don't, removes xs symbols, too |
|
|
223 | #Symbol::delete_package $pkg; |
|
|
224 | |
|
|
225 | require cf; |
|
|
226 | }; |
1025 | }; |
227 | warn $@ if $@; |
1026 | warn $@ if $@; |
228 | $who->message ($@) if $@; |
|
|
229 | warn "reloaded\n"; |
|
|
230 | |
|
|
231 | $who->message ("reloaded"); |
|
|
232 | } else { |
|
|
233 | $who->message ("Intruder Alert!"); |
|
|
234 | } |
1027 | }; |
|
|
1028 | |
|
|
1029 | $coro->on_destroy (sub { |
|
|
1030 | delete $self->{_coro}{$coro+0}; |
|
|
1031 | }); |
|
|
1032 | |
|
|
1033 | $self->{_coro}{$coro+0} = $coro; |
|
|
1034 | |
|
|
1035 | $coro |
|
|
1036 | } |
|
|
1037 | |
|
|
1038 | cf::client->attach ( |
|
|
1039 | on_destroy => sub { |
|
|
1040 | my ($ns) = @_; |
|
|
1041 | |
|
|
1042 | $_->cancel for values %{ (delete $ns->{_coro}) || {} }; |
|
|
1043 | }, |
|
|
1044 | ); |
|
|
1045 | |
|
|
1046 | =back |
|
|
1047 | |
|
|
1048 | |
|
|
1049 | =head2 SAFE SCRIPTING |
|
|
1050 | |
|
|
1051 | Functions that provide a safe environment to compile and execute |
|
|
1052 | snippets of perl code without them endangering the safety of the server |
|
|
1053 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
1054 | is not available in the safe scripting environment, and the number of |
|
|
1055 | functions and methods that can be called is greatly reduced. |
|
|
1056 | |
|
|
1057 | =cut |
|
|
1058 | |
|
|
1059 | our $safe = new Safe "safe"; |
|
|
1060 | our $safe_hole = new Safe::Hole; |
|
|
1061 | |
|
|
1062 | $SIG{FPE} = 'IGNORE'; |
|
|
1063 | |
|
|
1064 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
|
|
1065 | |
|
|
1066 | # here we export the classes and methods available to script code |
|
|
1067 | |
|
|
1068 | =pod |
|
|
1069 | |
|
|
1070 | The following fucntions and emthods are available within a safe environment: |
|
|
1071 | |
|
|
1072 | cf::object contr pay_amount pay_player map |
|
|
1073 | cf::object::player player |
|
|
1074 | cf::player peaceful |
|
|
1075 | cf::map trigger |
|
|
1076 | |
|
|
1077 | =cut |
|
|
1078 | |
|
|
1079 | for ( |
|
|
1080 | ["cf::object" => qw(contr pay_amount pay_player map)], |
|
|
1081 | ["cf::object::player" => qw(player)], |
|
|
1082 | ["cf::player" => qw(peaceful)], |
|
|
1083 | ["cf::map" => qw(trigger)], |
|
|
1084 | ) { |
|
|
1085 | no strict 'refs'; |
|
|
1086 | my ($pkg, @funs) = @$_; |
|
|
1087 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
|
|
1088 | for @funs; |
|
|
1089 | } |
|
|
1090 | |
|
|
1091 | =over 4 |
|
|
1092 | |
|
|
1093 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
1094 | |
|
|
1095 | Compiled and executes the given perl code snippet. additional var/value |
|
|
1096 | pairs result in temporary local (my) scalar variables of the given name |
|
|
1097 | that are available in the code snippet. Example: |
|
|
1098 | |
|
|
1099 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
1100 | |
|
|
1101 | =cut |
|
|
1102 | |
|
|
1103 | sub safe_eval($;@) { |
|
|
1104 | my ($code, %vars) = @_; |
|
|
1105 | |
|
|
1106 | my $qcode = $code; |
|
|
1107 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
|
|
1108 | $qcode =~ s/\n/\\n/g; |
|
|
1109 | |
|
|
1110 | local $_; |
|
|
1111 | local @safe::cf::_safe_eval_args = values %vars; |
|
|
1112 | |
|
|
1113 | my $eval = |
|
|
1114 | "do {\n" |
|
|
1115 | . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
|
|
1116 | . "#line 0 \"{$qcode}\"\n" |
|
|
1117 | . $code |
|
|
1118 | . "\n}" |
|
|
1119 | ; |
|
|
1120 | |
|
|
1121 | sub_generation_inc; |
|
|
1122 | my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); |
|
|
1123 | sub_generation_inc; |
|
|
1124 | |
|
|
1125 | if ($@) { |
|
|
1126 | warn "$@"; |
|
|
1127 | warn "while executing safe code '$code'\n"; |
|
|
1128 | warn "with arguments " . (join " ", %vars) . "\n"; |
|
|
1129 | } |
|
|
1130 | |
|
|
1131 | wantarray ? @res : $res[0] |
|
|
1132 | } |
|
|
1133 | |
|
|
1134 | =item cf::register_script_function $function => $cb |
|
|
1135 | |
|
|
1136 | Register a function that can be called from within map/npc scripts. The |
|
|
1137 | function should be reasonably secure and should be put into a package name |
|
|
1138 | like the extension. |
|
|
1139 | |
|
|
1140 | Example: register a function that gets called whenever a map script calls |
|
|
1141 | C<rent::overview>, as used by the C<rent> extension. |
|
|
1142 | |
|
|
1143 | cf::register_script_function "rent::overview" => sub { |
|
|
1144 | ... |
|
|
1145 | }; |
|
|
1146 | |
|
|
1147 | =cut |
|
|
1148 | |
|
|
1149 | sub register_script_function { |
|
|
1150 | my ($fun, $cb) = @_; |
|
|
1151 | |
|
|
1152 | no strict 'refs'; |
|
|
1153 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
|
|
1154 | } |
|
|
1155 | |
|
|
1156 | =back |
|
|
1157 | |
|
|
1158 | =cut |
|
|
1159 | |
|
|
1160 | ############################################################################# |
|
|
1161 | |
|
|
1162 | =head2 EXTENSION DATABASE SUPPORT |
|
|
1163 | |
|
|
1164 | Crossfire maintains a very simple database for extension use. It can |
|
|
1165 | currently store anything that can be serialised using Storable, which |
|
|
1166 | excludes objects. |
|
|
1167 | |
|
|
1168 | The parameter C<$family> should best start with the name of the extension |
|
|
1169 | using it, it should be unique. |
|
|
1170 | |
|
|
1171 | =over 4 |
|
|
1172 | |
|
|
1173 | =item $hashref = cf::db_get $family |
|
|
1174 | |
|
|
1175 | Return a hashref for use by the extension C<$family>, which can be |
|
|
1176 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
1177 | C<cf::db_sync>. |
|
|
1178 | |
|
|
1179 | =item $value = cf::db_get $family => $key |
|
|
1180 | |
|
|
1181 | Returns a single value from the database |
|
|
1182 | |
|
|
1183 | =item cf::db_put $family => $hashref |
|
|
1184 | |
|
|
1185 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
1186 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
1187 | |
|
|
1188 | =item cf::db_put $family => $key => $value |
|
|
1189 | |
|
|
1190 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
1191 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
1192 | |
|
|
1193 | =item cf::db_dirty |
|
|
1194 | |
|
|
1195 | Marks the database as dirty, to be updated at a later time. |
|
|
1196 | |
|
|
1197 | =item cf::db_sync |
|
|
1198 | |
|
|
1199 | Immediately write the database to disk I<if it is dirty>. |
|
|
1200 | |
|
|
1201 | =cut |
|
|
1202 | |
|
|
1203 | our $DB; |
|
|
1204 | |
|
|
1205 | { |
|
|
1206 | my $path = cf::localdir . "/database.pst"; |
|
|
1207 | |
|
|
1208 | sub db_load() { |
|
|
1209 | warn "loading database $path\n";#d# remove later |
|
|
1210 | $DB = stat $path ? Storable::retrieve $path : { }; |
|
|
1211 | } |
|
|
1212 | |
|
|
1213 | my $pid; |
|
|
1214 | |
|
|
1215 | sub db_save() { |
|
|
1216 | warn "saving database $path\n";#d# remove later |
|
|
1217 | waitpid $pid, 0 if $pid; |
|
|
1218 | if (0 == ($pid = fork)) { |
|
|
1219 | $DB->{_meta}{version} = 1; |
|
|
1220 | Storable::nstore $DB, "$path~"; |
|
|
1221 | rename "$path~", $path; |
|
|
1222 | cf::_exit 0 if defined $pid; |
|
|
1223 | } |
|
|
1224 | } |
|
|
1225 | |
|
|
1226 | my $dirty; |
|
|
1227 | |
|
|
1228 | sub db_sync() { |
|
|
1229 | db_save if $dirty; |
|
|
1230 | undef $dirty; |
|
|
1231 | } |
|
|
1232 | |
|
|
1233 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
|
|
1234 | db_sync; |
|
|
1235 | }); |
|
|
1236 | |
|
|
1237 | sub db_dirty() { |
|
|
1238 | $dirty = 1; |
|
|
1239 | $idle->start; |
|
|
1240 | } |
|
|
1241 | |
|
|
1242 | sub db_get($;$) { |
|
|
1243 | @_ >= 2 |
|
|
1244 | ? $DB->{$_[0]}{$_[1]} |
|
|
1245 | : ($DB->{$_[0]} ||= { }) |
|
|
1246 | } |
|
|
1247 | |
|
|
1248 | sub db_put($$;$) { |
|
|
1249 | if (@_ >= 3) { |
|
|
1250 | $DB->{$_[0]}{$_[1]} = $_[2]; |
|
|
1251 | } else { |
|
|
1252 | $DB->{$_[0]} = $_[1]; |
|
|
1253 | } |
|
|
1254 | db_dirty; |
|
|
1255 | } |
|
|
1256 | |
|
|
1257 | cf::global->attach ( |
|
|
1258 | prio => 10000, |
|
|
1259 | on_cleanup => sub { |
|
|
1260 | db_sync; |
|
|
1261 | }, |
|
|
1262 | ); |
|
|
1263 | } |
|
|
1264 | |
|
|
1265 | ############################################################################# |
|
|
1266 | # the server's main() |
|
|
1267 | |
|
|
1268 | sub cfg_load { |
|
|
1269 | open my $fh, "<:utf8", cf::confdir . "/config" |
|
|
1270 | or return; |
|
|
1271 | |
|
|
1272 | local $/; |
|
|
1273 | *CFG = YAML::Syck::Load <$fh>; |
|
|
1274 | } |
|
|
1275 | |
|
|
1276 | sub main { |
|
|
1277 | cfg_load; |
|
|
1278 | db_load; |
|
|
1279 | load_extensions; |
|
|
1280 | Event::loop; |
|
|
1281 | } |
|
|
1282 | |
|
|
1283 | ############################################################################# |
|
|
1284 | # initialisation |
|
|
1285 | |
|
|
1286 | sub perl_reload() { |
|
|
1287 | # can/must only be called in main |
|
|
1288 | if ($Coro::current != $Coro::main) { |
|
|
1289 | warn "can only reload from main coroutine\n"; |
|
|
1290 | return; |
|
|
1291 | } |
|
|
1292 | |
|
|
1293 | warn "reloading..."; |
|
|
1294 | |
|
|
1295 | local $FREEZE = 1; |
|
|
1296 | cf::emergency_save; |
|
|
1297 | |
|
|
1298 | eval { |
|
|
1299 | # if anything goes wrong in here, we should simply crash as we already saved |
|
|
1300 | |
|
|
1301 | # cancel all watchers |
|
|
1302 | for (Event::all_watchers) { |
|
|
1303 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
1304 | } |
|
|
1305 | |
|
|
1306 | # cancel all extension coros |
|
|
1307 | $_->cancel for values %EXT_CORO; |
|
|
1308 | %EXT_CORO = (); |
|
|
1309 | |
|
|
1310 | # unload all extensions |
|
|
1311 | for (@exts) { |
|
|
1312 | warn "unloading <$_>"; |
|
|
1313 | unload_extension $_; |
|
|
1314 | } |
|
|
1315 | |
|
|
1316 | # unload all modules loaded from $LIBDIR |
|
|
1317 | while (my ($k, $v) = each %INC) { |
|
|
1318 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
1319 | |
|
|
1320 | warn "removing <$k>"; |
|
|
1321 | delete $INC{$k}; |
|
|
1322 | |
|
|
1323 | $k =~ s/\.pm$//; |
|
|
1324 | $k =~ s/\//::/g; |
|
|
1325 | |
|
|
1326 | if (my $cb = $k->can ("unload_module")) { |
|
|
1327 | $cb->(); |
|
|
1328 | } |
|
|
1329 | |
|
|
1330 | Symbol::delete_package $k; |
|
|
1331 | } |
|
|
1332 | |
|
|
1333 | # sync database to disk |
|
|
1334 | cf::db_sync; |
|
|
1335 | IO::AIO::flush; |
|
|
1336 | |
|
|
1337 | # get rid of safe::, as good as possible |
|
|
1338 | Symbol::delete_package "safe::$_" |
|
|
1339 | for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); |
|
|
1340 | |
|
|
1341 | # remove register_script_function callbacks |
|
|
1342 | # TODO |
|
|
1343 | |
|
|
1344 | # unload cf.pm "a bit" |
|
|
1345 | delete $INC{"cf.pm"}; |
|
|
1346 | |
|
|
1347 | # don't, removes xs symbols, too, |
|
|
1348 | # and global variables created in xs |
|
|
1349 | #Symbol::delete_package __PACKAGE__; |
|
|
1350 | |
|
|
1351 | # reload cf.pm |
|
|
1352 | warn "reloading cf.pm"; |
|
|
1353 | require cf; |
|
|
1354 | cf::_connect_to_perl; # nominally unnecessary, but cannot hurt |
|
|
1355 | |
|
|
1356 | # load config and database again |
|
|
1357 | cf::cfg_load; |
|
|
1358 | cf::db_load; |
|
|
1359 | |
|
|
1360 | # load extensions |
|
|
1361 | warn "load extensions"; |
|
|
1362 | cf::load_extensions; |
|
|
1363 | |
|
|
1364 | # reattach attachments to objects |
|
|
1365 | warn "reattach"; |
|
|
1366 | _global_reattach; |
|
|
1367 | }; |
|
|
1368 | |
|
|
1369 | if ($@) { |
|
|
1370 | warn $@; |
|
|
1371 | warn "error while reloading, exiting."; |
|
|
1372 | exit 1; |
|
|
1373 | } |
|
|
1374 | |
|
|
1375 | warn "reloaded successfully"; |
235 | }; |
1376 | }; |
236 | |
1377 | |
237 | ############################################################################# |
1378 | register "<global>", __PACKAGE__; |
238 | # extcmd framework, basically convert ext <id> <pkg> arg1 args |
|
|
239 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
240 | |
1379 | |
241 | sub on_extcmd { |
1380 | register_command "perl-reload" => sub { |
242 | my ($pl, $buf) = @_; |
1381 | my ($who, $arg) = @_; |
243 | |
1382 | |
244 | my ($type) = $buf =~ s/^(\S+) // ? $1 : ""; |
1383 | if ($who->flag (FLAG_WIZ)) { |
245 | |
1384 | $who->message ("start of reload."); |
246 | $extcmd{$type}[0]->($pl, $buf) |
1385 | perl_reload; |
247 | if $extcmd{$type}; |
1386 | $who->message ("end of reload."); |
248 | } |
1387 | } |
249 | |
|
|
250 | ############################################################################# |
|
|
251 | # load/save/clean perl data associated with a map |
|
|
252 | |
|
|
253 | *on_mapclean = sub { |
|
|
254 | my ($map) = @_; |
|
|
255 | |
|
|
256 | my $path = $map->tmpname; |
|
|
257 | defined $path or return; |
|
|
258 | |
|
|
259 | unlink "$path.cfperl"; |
|
|
260 | }; |
1388 | }; |
261 | |
1389 | |
262 | *on_mapin = |
1390 | unshift @INC, $LIBDIR; |
263 | *on_mapload = sub { |
|
|
264 | my ($map) = @_; |
|
|
265 | |
1391 | |
266 | my $path = $map->tmpname; |
1392 | $TICK_WATCHER = Event->timer ( |
267 | $path = $map->path unless defined $path; |
1393 | reentrant => 0, |
|
|
1394 | prio => 0, |
|
|
1395 | at => $NEXT_TICK || $TICK, |
|
|
1396 | data => WF_AUTOCANCEL, |
|
|
1397 | cb => sub { |
|
|
1398 | unless ($FREEZE) { |
|
|
1399 | cf::server_tick; # one server iteration |
|
|
1400 | $RUNTIME += $TICK; |
|
|
1401 | } |
268 | |
1402 | |
269 | open my $fh, "<:raw", "$path.cfperl" |
1403 | $NEXT_TICK += $TICK; |
270 | or return; # no perl data |
|
|
271 | |
1404 | |
272 | my $data = Storable::thaw do { local $/; <$fh> }; |
1405 | # if we are delayed by four ticks or more, skip them all |
|
|
1406 | $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; |
273 | |
1407 | |
274 | $data->{version} <= 1 |
1408 | $TICK_WATCHER->at ($NEXT_TICK); |
275 | or return; # too new |
1409 | $TICK_WATCHER->start; |
|
|
1410 | }, |
|
|
1411 | ); |
276 | |
1412 | |
277 | $map->_set_obs ($data->{obs}); |
1413 | IO::AIO::max_poll_time $TICK * 0.2; |
|
|
1414 | |
|
|
1415 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1416 | poll => 'r', |
|
|
1417 | prio => 5, |
|
|
1418 | data => WF_AUTOCANCEL, |
|
|
1419 | cb => \&IO::AIO::poll_cb); |
|
|
1420 | |
|
|
1421 | # we must not ever block the main coroutine |
|
|
1422 | $Coro::idle = sub { |
|
|
1423 | #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# |
|
|
1424 | warn "FATAL: Coro::idle was called, major BUG\n"; |
|
|
1425 | (Coro::unblock_sub { |
|
|
1426 | Event::one_event; |
|
|
1427 | })->(); |
278 | }; |
1428 | }; |
279 | |
1429 | |
280 | *on_mapout = sub { |
|
|
281 | my ($map) = @_; |
|
|
282 | |
|
|
283 | my $path = $map->tmpname; |
|
|
284 | $path = $map->path unless defined $path; |
|
|
285 | |
|
|
286 | my $obs = $map->_get_obs; |
|
|
287 | |
|
|
288 | if (defined $obs) { |
|
|
289 | open my $fh, ">:raw", "$path.cfperl" |
|
|
290 | or die "$path.cfperl: $!"; |
|
|
291 | |
|
|
292 | stat $path; |
|
|
293 | |
|
|
294 | print $fh Storable::nfreeze { |
|
|
295 | size => (stat _)[7], |
|
|
296 | time => (stat _)[9], |
|
|
297 | version => 1, |
|
|
298 | obs => $obs, |
|
|
299 | }; |
|
|
300 | |
|
|
301 | chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* |
|
|
302 | } else { |
|
|
303 | unlink "$path.cfperl"; |
|
|
304 | } |
|
|
305 | }; |
|
|
306 | |
|
|
307 | ############################################################################# |
|
|
308 | # load/save perl data associated with player->ob objects |
|
|
309 | |
|
|
310 | *on_player_load = sub { |
|
|
311 | my ($ob, $path) = @_; |
|
|
312 | |
|
|
313 | if (open my $fh, "<:raw", "$path.cfperl") { |
|
|
314 | |
|
|
315 | #d##TODO#remove |
|
|
316 | |
|
|
317 | my $data = Storable::thaw do { local $/; <$fh> }; |
|
|
318 | |
|
|
319 | $data->{version} <= 1 |
|
|
320 | or return; # too new |
|
|
321 | |
|
|
322 | %$ob = %{$data->{ob}}; |
|
|
323 | return; |
|
|
324 | } |
|
|
325 | |
|
|
326 | for my $o ($ob, $ob->inv) { |
|
|
327 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
|
|
328 | $o->set_ob_key_value ("_perl_data"); |
|
|
329 | |
|
|
330 | %$o = %{ Storable::thaw pack "H*", $value }; |
|
|
331 | } |
|
|
332 | } |
|
|
333 | }; |
|
|
334 | |
|
|
335 | *on_player_save = sub { |
|
|
336 | my ($ob, $path) = @_; |
|
|
337 | |
|
|
338 | $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) |
|
|
339 | for grep %$_, $ob, $ob->inv; |
|
|
340 | |
|
|
341 | unlink "$path.cfperl";#d##TODO#remove |
|
|
342 | }; |
|
|
343 | |
|
|
344 | register "<global>", __PACKAGE__; |
|
|
345 | |
|
|
346 | unshift @INC, maps_directory "perl"; |
|
|
347 | |
|
|
348 | load_extensions; |
|
|
349 | |
|
|
350 | 1 |
1430 | 1 |
351 | |
1431 | |