ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.75 by root, Mon Oct 2 00:22:01 2006 UTC vs.
Revision 1.100 by root, Mon Dec 25 11:25:49 2006 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro;
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18
19use IO::AIO 2.3;
10use YAML::Syck (); 20use YAML::Syck ();
11use Time::HiRes; 21use Time::HiRes;
12use Event; 22
13$Event::Eval = 1; # no idea why this is required, but it is 23use Event; $Event::Eval = 1; # no idea why this is required, but it is
14 24
15# 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?
16$YAML::Syck::ImplicitUnicode = 1; 26$YAML::Syck::ImplicitUnicode = 1;
17 27
18use strict; 28$Coro::main->prio (Coro::PRIO_MIN);
19 29
20_init_vars; 30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
21 31
22our %COMMAND = (); 32our %COMMAND = ();
33our %COMMAND_TIME = ();
34our %EXTCMD = ();
35
23our @EVENT; 36our @EVENT;
24our $LIBDIR = maps_directory "perl"; 37our $LIBDIR = datadir . "/ext";
25 38
26our $TICK = MAX_TIME * 1e-6; 39our $TICK = MAX_TIME * 1e-6;
27our $TICK_WATCHER; 40our $TICK_WATCHER;
28our $NEXT_TICK; 41our $NEXT_TICK;
29 42
30our %CFG; 43our %CFG;
31 44
45our $UPTIME; $UPTIME ||= time;
46
32############################################################################# 47#############################################################################
33 48
34=head2 GLOBAL VARIABLES 49=head2 GLOBAL VARIABLES
35 50
36=over 4 51=over 4
52
53=item $cf::UPTIME
54
55The timestamp of the server start (so not actually an uptime).
37 56
38=item $cf::LIBDIR 57=item $cf::LIBDIR
39 58
40The perl library directory, where extensions and cf-specific modules can 59The perl library directory, where extensions and cf-specific modules can
41be found. It will be added to C<@INC> automatically. 60be found. It will be added to C<@INC> automatically.
62 print STDERR "cfperl: $msg"; 81 print STDERR "cfperl: $msg";
63 LOG llevError, "cfperl: $msg"; 82 LOG llevError, "cfperl: $msg";
64 }; 83 };
65} 84}
66 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';
67@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 91@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
68 92
69# 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
70# within the Safe compartment. 94# within the Safe compartment.
71for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 95for 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)) {
72 no strict 'refs'; 102 no strict 'refs';
73 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 103 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
74} 104}
75 105
76$Event::DIED = sub { 106$Event::DIED = sub {
78}; 108};
79 109
80my %ext_pkg; 110my %ext_pkg;
81my @exts; 111my @exts;
82my @hook; 112my @hook;
83my %command;
84my %extcmd;
85 113
86=head2 UTILITY FUNCTIONS 114=head2 UTILITY FUNCTIONS
87 115
88=over 4 116=over 4
89 117
117 145
118=cut 146=cut
119 147
120############################################################################# 148#############################################################################
121 149
122=head2 EVENTS AND OBJECT ATTACHMENTS 150=head2 ATTACHABLE OBJECTS
151
152Many objects in crossfire are so-called attachable objects. That means you can
153attach callbacks/event handlers (a collection of which is called an "attachment")
154to it. All such attachable objects support the following methods.
155
156In the following description, CLASS can be any of C<global>, C<object>
157C<player>, C<client> or C<map> (i.e. the attachable objects in
158crossfire+).
123 159
124=over 4 160=over 4
125 161
126=item $object->attach ($attachment, key => $value...)
127
128=item $object->detach ($attachment)
129
130Attach/detach a pre-registered attachment to an object.
131
132=item $player->attach ($attachment, key => $value...)
133
134=item $player->detach ($attachment)
135
136Attach/detach a pre-registered attachment to a player.
137
138=item $map->attach ($attachment, key => $value...) 162=item $attachable->attach ($attachment, key => $value...)
139 163
140=item $map->detach ($attachment) 164=item $attachable->detach ($attachment)
141 165
142Attach/detach a pre-registered attachment to a map. 166Attach/detach a pre-registered attachment to a specific object and give it
167the specified key/value pairs as arguments.
143 168
144=item $bool = $object->attached ($name) 169Example, attach a minesweeper attachment to the given object, making it a
17010x10 minesweeper game:
145 171
146=item $bool = $player->attached ($name) 172 $obj->attach (minesweeper => width => 10, height => 10);
147 173
148=item $bool = $map->attached ($name) 174=item $bool = $attachable->attached ($name)
149 175
150Checks wether the named attachment is currently attached to the object. 176Checks wether the named attachment is currently attached to the object.
151 177
152=item cf::attach_global ... 178=item cf::CLASS->attach ...
153 179
154Attach handlers for global events. 180=item cf::CLASS->detach ...
155 181
156This and all following C<attach_*>-functions expect any number of the 182Define an anonymous attachment and attach it to all objects of the given
157following handler/hook descriptions: 183CLASS. See the next function for an explanation of its arguments.
184
185You can attach to global events by using the C<cf::global> class.
186
187Example, log all player logins:
188
189 cf::player->attach (
190 on_login => sub {
191 my ($pl) = @_;
192 ...
193 },
194 );
195
196Example, 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
209Register an attachment by C<$name> through which attachable objects of the
210given CLASS can refer to this attachment.
211
212Some classes such as crossfire maps and objects can specify attachments
213that are attached at load/instantiate time, thus the need for a name.
214
215These calls expect any number of the following handler/hook descriptions:
158 216
159=over 4 217=over 4
160 218
161=item prio => $number 219=item prio => $number
162 220
164by another C<prio> setting). Lower priority handlers get executed 222by another C<prio> setting). Lower priority handlers get executed
165earlier. The default priority is C<0>, and many built-in handlers are 223earlier. The default priority is C<0>, and many built-in handlers are
166registered at priority C<-1000>, so lower priorities should not be used 224registered at priority C<-1000>, so lower priorities should not be used
167unless you know what you are doing. 225unless you know what you are doing.
168 226
227=item type => $type
228
229(Only for C<< cf::object->attach >> calls), limits the attachment to the
230given type of objects only (the additional parameter C<subtype> can be
231used to further limit to the given subtype).
232
169=item on_I<event> => \&cb 233=item on_I<event> => \&cb
170 234
171Call the given code reference whenever the named event happens (event is 235Call the given code reference whenever the named event happens (event is
172something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 236something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
173handlers are recognised generally depends on the type of object these 237handlers are recognised generally depends on the type of object these
182package and register them. Only handlers for eevents supported by the 246package and register them. Only handlers for eevents supported by the
183object/class are recognised. 247object/class are recognised.
184 248
185=back 249=back
186 250
187=item cf::attach_to_type $object_type, $subtype, ... 251Example, define an attachment called "sockpuppet" that calls the given
252event handler when a monster attacks:
188 253
189Attach handlers for a specific object type (e.g. TRANSPORT) and 254 cf::object::attachment sockpuppet =>
190subtype. If C<$subtype> is zero or undef, matches all objects of the given 255 on_skill_attack => sub {
191type. 256 my ($self, $victim) = @_;
192 257 ...
193=item cf::attach_to_objects ...
194
195Attach handlers to all objects. Do not use this except for debugging or
196very rare events, as handlers are (obviously) called for I<all> objects in
197the game.
198
199=item cf::attach_to_players ...
200
201Attach handlers to all players.
202
203=item cf::attach_to_maps ...
204
205Attach handlers to all maps.
206
207=item cf:register_attachment $name, ...
208
209Register an attachment by name through which objects can refer to this
210attachment.
211
212=item cf:register_player_attachment $name, ...
213
214Register an attachment by name through which players can refer to this
215attachment.
216
217=item cf:register_map_attachment $name, ...
218
219Register an attachment by name through which maps can refer to this
220attachment.
221
222=cut
223
224# the following variables are defined in .xs and must not be re-created
225our @CB_GLOBAL = (); # registry for all global events
226our @CB_OBJECT = (); # all objects (should not be used except in emergency)
227our @CB_PLAYER = ();
228our @CB_TYPE = (); # registry for type (cf-object class) based events
229our @CB_MAP = ();
230
231my %attachment;
232
233sub _attach_cb($\%$$$) {
234 my ($registry, $undo, $event, $prio, $cb) = @_;
235
236 use sort 'stable';
237
238 $cb = [$prio, $cb];
239
240 @{$registry->[$event]} = sort
241 { $a->[0] cmp $b->[0] }
242 @{$registry->[$event] || []}, $cb;
243
244 push @{$undo->{cb}}, [$event, $cb];
245}
246
247# attach handles attaching event callbacks
248# the only thing the caller has to do is pass the correct
249# registry (== where the callback attaches to).
250sub _attach(\@$@) {
251 my ($registry, $klass, @arg) = @_;
252
253 my $prio = 0;
254
255 my %undo = (
256 registry => $registry,
257 cb => [],
258 );
259
260 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
261
262 while (@arg) {
263 my $type = shift @arg;
264
265 if ($type eq "prio") {
266 $prio = shift @arg;
267
268 } elsif ($type eq "package") {
269 my $pkg = shift @arg;
270
271 while (my ($name, $id) = each %cb_id) {
272 if (my $cb = $pkg->can ($name)) {
273 _attach_cb $registry, %undo, $id, $prio, $cb;
274 }
275 } 258 }
276
277 } elsif (exists $cb_id{$type}) {
278 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
279
280 } elsif (ref $type) {
281 warn "attaching objects not supported, ignoring.\n";
282
283 } else {
284 shift @arg;
285 warn "attach argument '$type' not supported, ignoring.\n";
286 }
287 }
288
289 \%undo
290}
291
292sub _attach_attachment {
293 my ($obj, $name, %arg) = @_;
294
295 return if exists $obj->{_attachment}{$name};
296
297 my $res;
298
299 if (my $attach = $attachment{$name}) {
300 my $registry = $obj->registry;
301
302 for (@$attach) {
303 my ($klass, @attach) = @$_;
304 $res = _attach @$registry, $klass, @attach;
305 }
306
307 $obj->{$name} = \%arg;
308 } else {
309 warn "object uses attachment '$name' that is not available, postponing.\n";
310 }
311
312 $obj->{_attachment}{$name} = undef;
313
314 $res->{attachment} = $name;
315 $res
316}
317
318*cf::object::attach =
319*cf::player::attach =
320*cf::map::attach = sub {
321 my ($obj, $name, %arg) = @_;
322
323 _attach_attachment $obj, $name, %arg;
324};
325
326# all those should be optimised
327*cf::object::detach =
328*cf::player::detach =
329*cf::map::detach = sub {
330 my ($obj, $name) = @_;
331
332 delete $obj->{_attachment}{$name};
333 reattach ($obj);
334};
335
336*cf::object::attached =
337*cf::player::attached =
338*cf::map::attached = sub {
339 my ($obj, $name) = @_;
340
341 exists $obj->{_attachment}{$name}
342};
343
344sub attach_global {
345 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
346}
347
348sub attach_to_type {
349 my $type = shift;
350 my $subtype = shift;
351
352 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
353}
354
355sub attach_to_objects {
356 _attach @CB_OBJECT, KLASS_OBJECT, @_
357}
358
359sub attach_to_players {
360 _attach @CB_PLAYER, KLASS_PLAYER, @_
361}
362
363sub attach_to_maps {
364 _attach @CB_MAP, KLASS_MAP, @_
365}
366
367sub register_attachment {
368 my $name = shift;
369
370 $attachment{$name} = [[KLASS_OBJECT, @_]];
371}
372
373sub register_player_attachment {
374 my $name = shift;
375
376 $attachment{$name} = [[KLASS_PLAYER, @_]];
377}
378
379sub register_map_attachment {
380 my $name = shift;
381
382 $attachment{$name} = [[KLASS_MAP, @_]];
383}
384
385our $override;
386our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
387
388sub override {
389 $override = 1;
390 @invoke_results = ();
391}
392
393sub do_invoke {
394 my $event = shift;
395 my $callbacks = shift;
396
397 @invoke_results = ();
398
399 local $override;
400
401 for (@$callbacks) {
402 eval { &{$_->[1]} };
403
404 if ($@) {
405 warn "$@";
406 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
407 override;
408 }
409
410 return 1 if $override;
411 }
412
413 0 259 }
414}
415 260
416=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 261=item $attachable->valid
417
418=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
419
420=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
421
422=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
423
424Generate a global/object/player/map-specific event with the given arguments.
425
426This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
427removed in future versions), and there is no public API to access override
428results (if you must, access C<@cf::invoke_results> directly).
429
430=back
431
432=cut
433
434#############################################################################
435
436=head2 METHODS VALID FOR ALL CORE OBJECTS
437
438=over 4
439
440=item $object->valid, $player->valid, $map->valid
441 262
442Just because you have a perl object does not mean that the corresponding 263Just because you have a perl object does not mean that the corresponding
443C-level object still exists. If you try to access an object that has no 264C-level object still exists. If you try to access an object that has no
444valid C counterpart anymore you get an exception at runtime. This method 265valid C counterpart anymore you get an exception at runtime. This method
445can be used to test for existence of the C object part without causing an 266can be used to test for existence of the C object part without causing an
446exception. 267exception.
447 268
269=cut
270
271# the following variables are defined in .xs and must not be re-created
272our @CB_GLOBAL = (); # registry for all global events
273our @CB_ATTACHABLE = (); # registry for all attachables
274our @CB_OBJECT = (); # all objects (should not be used except in emergency)
275our @CB_PLAYER = ();
276our @CB_CLIENT = ();
277our @CB_TYPE = (); # registry for type (cf-object class) based events
278our @CB_MAP = ();
279
280my %attachment;
281
282sub _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
295my %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).
300sub _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
349sub _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
370sub 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
379sub 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
390sub cf::attachable::attached {
391 my ($obj, $name) = @_;
392
393 exists $obj->{_attachment}{$name}
394}
395
396for 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
411our $override;
412our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
413
414sub override {
415 $override = 1;
416 @invoke_results = ();
417}
418
419sub 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
446Generate an object-specific event with the given arguments.
447
448This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
449removed in future versions), and there is no public API to access override
450results (if you must, access C<@cf::invoke_results> directly).
451
448=back 452=back
449 453
450=cut 454=cut
451
452*cf::object::valid =
453*cf::player::valid =
454*cf::map::valid = \&cf::_valid;
455 455
456############################################################################# 456#############################################################################
457# object support 457# object support
458 458
459sub instantiate { 459cf::attachable->attach (
460 prio => -1000000,
461 on_instantiate => sub {
460 my ($obj, $data) = @_; 462 my ($obj, $data) = @_;
461 463
462 $data = from_json $data; 464 $data = from_json $data;
463 465
464 for (@$data) { 466 for (@$data) {
465 my ($name, $args) = @$_; 467 my ($name, $args) = @$_;
466 468
467 $obj->attach ($name, %{$args || {} }); 469 $obj->attach ($name, %{$args || {} });
470 }
468 } 471 },
469} 472 on_reattach => sub {
470
471# basically do the same as instantiate, without calling instantiate 473 # basically do the same as instantiate, without calling instantiate
472sub reattach {
473 my ($obj) = @_; 474 my ($obj) = @_;
474 my $registry = $obj->registry; 475 my $registry = $obj->registry;
475 476
476 @$registry = (); 477 @$registry = ();
477 478
478 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 479 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
479 480
480 for my $name (keys %{ $obj->{_attachment} || {} }) { 481 for my $name (keys %{ $obj->{_attachment} || {} }) {
481 if (my $attach = $attachment{$name}) { 482 if (my $attach = $attachment{$name}) {
482 for (@$attach) { 483 for (@$attach) {
483 my ($klass, @attach) = @$_; 484 my ($klass, @attach) = @$_;
484 _attach @$registry, $klass, @attach; 485 _attach $registry, $klass, @attach;
486 }
487 } else {
488 warn "object uses attachment '$name' that is not available, postponing.\n";
485 } 489 }
486 } else {
487 warn "object uses attachment '$name' that is not available, postponing.\n";
488 } 490 }
489 } 491 },
490} 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);
491 503
492sub object_freezer_save { 504sub object_freezer_save {
493 my ($filename, $rdata, $objs) = @_; 505 my ($filename, $rdata, $objs) = @_;
494 506
495 if (length $$rdata) { 507 if (length $$rdata) {
518 unlink $filename; 530 unlink $filename;
519 unlink "$filename.pst"; 531 unlink "$filename.pst";
520 } 532 }
521} 533}
522 534
535sub object_freezer_as_string {
536 my ($rdata, $objs) = @_;
537
538 use Data::Dumper;
539
540 $$rdata . Dumper $objs
541}
542
523sub object_thawer_load { 543sub object_thawer_load {
524 my ($filename) = @_; 544 my ($filename) = @_;
525 545
526 local $/; 546 local $/;
527 547
537 } 557 }
538 558
539 () 559 ()
540} 560}
541 561
542attach_to_objects
543 prio => -1000000,
544 on_clone => sub {
545 my ($src, $dst) = @_;
546
547 @{$dst->registry} = @{$src->registry};
548
549 %$dst = %$src;
550
551 %{$dst->{_attachment}} = %{$src->{_attachment}}
552 if exists $src->{_attachment};
553 },
554;
555
556############################################################################# 562#############################################################################
557# old plug-in events 563# command handling &c
558 564
559sub inject_event { 565=item cf::register_command $name => \&callback($ob,$args);
560 my $extension = shift;
561 my $event_code = shift;
562 566
563 my $cb = $hook[$event_code]{$extension} 567Register a callback for execution when the client sends the user command
564 or return; 568$name.
565 569
566 &$cb 570=cut
567}
568
569sub inject_global_event {
570 my $event = shift;
571
572 my $cb = $hook[$event]
573 or return;
574
575 List::Util::max map &$_, values %$cb
576}
577
578sub inject_command {
579 my ($name, $obj, $params) = @_;
580
581 for my $cmd (@{ $command{$name} }) {
582 $cmd->[1]->($obj, $params);
583 }
584
585 -1
586}
587 571
588sub register_command { 572sub register_command {
589 my ($name, $time, $cb) = @_; 573 my ($name, $cb) = @_;
590 574
591 my $caller = caller; 575 my $caller = caller;
592 #warn "registering command '$name/$time' to '$caller'"; 576 #warn "registering command '$name/$time' to '$caller'";
593 577
594 push @{ $command{$name} }, [$time, $cb, $caller]; 578 push @{ $COMMAND{$name} }, [$caller, $cb];
595 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
596} 579}
580
581=item cf::register_extcmd $name => \&callback($pl,$packet);
582
583Register a callbackf ro execution when the client sends an extcmd packet.
584
585If the callback returns something, it is sent back as if reply was being
586called.
587
588=cut
597 589
598sub register_extcmd { 590sub register_extcmd {
599 my ($name, $cb) = @_; 591 my ($name, $cb) = @_;
600 592
601 my $caller = caller; 593 my $caller = caller;
602 #warn "registering extcmd '$name' to '$caller'"; 594 #warn "registering extcmd '$name' to '$caller'";
603 595
604 $extcmd{$name} = [$cb, $caller]; 596 $EXTCMD{$name} = [$cb, $caller];
605} 597}
598
599cf::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);
606 630
607sub register { 631sub register {
608 my ($base, $pkg) = @_; 632 my ($base, $pkg) = @_;
609 633
610 #TODO 634 #TODO
629 . "#line 1 \"$path\"\n{\n" 653 . "#line 1 \"$path\"\n{\n"
630 . (do { local $/; <$fh> }) 654 . (do { local $/; <$fh> })
631 . "\n};\n1"; 655 . "\n};\n1";
632 656
633 eval $source 657 eval $source
634 or die "$path: $@"; 658 or die $@ ? "$path: $@\n"
659 : "extension disabled.\n";
635 660
636 push @exts, $pkg; 661 push @exts, $pkg;
637 $ext_pkg{$base} = $pkg; 662 $ext_pkg{$base} = $pkg;
638 663
639# no strict 'refs'; 664# no strict 'refs';
652# for my $idx (0 .. $#PLUGIN_EVENT) { 677# for my $idx (0 .. $#PLUGIN_EVENT) {
653# delete $hook[$idx]{$pkg}; 678# delete $hook[$idx]{$pkg};
654# } 679# }
655 680
656 # remove commands 681 # remove commands
657 for my $name (keys %command) { 682 for my $name (keys %COMMAND) {
658 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 683 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
659 684
660 if (@cb) { 685 if (@cb) {
661 $command{$name} = \@cb; 686 $COMMAND{$name} = \@cb;
662 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
663 } else { 687 } else {
664 delete $command{$name};
665 delete $COMMAND{"$name\000"}; 688 delete $COMMAND{$name};
666 } 689 }
667 } 690 }
668 691
669 # remove extcmds 692 # remove extcmds
670 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 693 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
671 delete $extcmd{$name}; 694 delete $EXTCMD{$name};
672 } 695 }
673 696
674 if (my $cb = $pkg->can ("unload")) { 697 if (my $cb = $pkg->can ("unload")) {
675 eval { 698 eval {
676 $cb->($pkg); 699 $cb->($pkg);
680 703
681 Symbol::delete_package $pkg; 704 Symbol::delete_package $pkg;
682} 705}
683 706
684sub load_extensions { 707sub load_extensions {
685 my $LIBDIR = maps_directory "perl";
686
687 for my $ext (<$LIBDIR/*.ext>) { 708 for my $ext (<$LIBDIR/*.ext>) {
688 next unless -r $ext; 709 next unless -r $ext;
689 eval { 710 eval {
690 load_extension $ext; 711 load_extension $ext;
691 1 712 1
692 } or warn "$ext not loaded: $@"; 713 } or warn "$ext not loaded: $@";
693 } 714 }
694} 715}
695 716
696############################################################################# 717#############################################################################
697# extcmd framework, basically convert ext <msg>
698# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
699
700attach_to_players
701 on_extcmd => sub {
702 my ($pl, $buf) = @_;
703
704 my $msg = eval { from_json $buf };
705
706 if (ref $msg) {
707 if (my $cb = $extcmd{$msg->{msgtype}}) {
708 if (my %reply = $cb->[0]->($pl, $msg)) {
709 $pl->ext_reply ($msg->{msgid}, %reply);
710 }
711 }
712 } else {
713 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
714 }
715
716 cf::override;
717 },
718;
719
720#############################################################################
721# load/save/clean perl data associated with a map 718# load/save/clean perl data associated with a map
722 719
723*cf::mapsupport::on_clean = sub { 720*cf::mapsupport::on_clean = sub {
724 my ($map) = @_; 721 my ($map) = @_;
725 722
727 defined $path or return; 724 defined $path or return;
728 725
729 unlink "$path.pst"; 726 unlink "$path.pst";
730}; 727};
731 728
732attach_to_maps prio => -10000, package => cf::mapsupport::; 729cf::map->attach (prio => -10000, package => cf::mapsupport::);
733 730
734############################################################################# 731#############################################################################
735# load/save perl data associated with player->ob objects 732# load/save perl data associated with player->ob objects
736 733
737sub all_objects(@) { 734sub all_objects(@) {
738 @_, map all_objects ($_->inv), @_ 735 @_, map all_objects ($_->inv), @_
739} 736}
740 737
741# TODO: compatibility cruft, remove when no longer needed 738# TODO: compatibility cruft, remove when no longer needed
742attach_to_players 739cf::player->attach (
743 on_load => sub { 740 on_load => sub {
744 my ($pl, $path) = @_; 741 my ($pl, $path) = @_;
745 742
746 for my $o (all_objects $pl->ob) { 743 for my $o (all_objects $pl->ob) {
747 if (my $value = $o->get_ob_key_value ("_perl_data")) { 744 if (my $value = $o->get_ob_key_value ("_perl_data")) {
749 746
750 %$o = %{ Storable::thaw pack "H*", $value }; 747 %$o = %{ Storable::thaw pack "H*", $value };
751 } 748 }
752 } 749 }
753 }, 750 },
754; 751);
755 752
756############################################################################# 753#############################################################################
757 754
758=head2 CORE EXTENSIONS 755=head2 CORE EXTENSIONS
759 756
760Functions and methods that extend core crossfire objects. 757Functions and methods that extend core crossfire objects.
758
759=head3 cf::player
761 760
762=over 4 761=over 4
763 762
764=item cf::player::exists $login 763=item cf::player::exists $login
765 764
770sub cf::player::exists($) { 769sub cf::player::exists($) {
771 cf::player::find $_[0] 770 cf::player::find $_[0]
772 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;
773} 772}
774 773
774=item $player->ext_reply ($msgid, $msgtype, %msg)
775
776Sends an ext reply to the player.
777
778=cut
779
780sub 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
775=item $object->reply ($npc, $msg[, $flags]) 794=item $player_object->reply ($npc, $msg[, $flags])
776 795
777Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 796Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
778can be C<undef>. Does the right thing when the player is currently in a 797can be C<undef>. Does the right thing when the player is currently in a
779dialogue with the given NPC character. 798dialogue with the given NPC character.
780 799
781=cut 800=cut
782 801
783# rough implementation of a future "reply" method that works 802# rough implementation of a future "reply" method that works
784# with dialog boxes. 803# with dialog boxes.
804#TODO: the first argument must go, split into a $npc->reply_to ( method
785sub cf::object::player::reply($$$;$) { 805sub cf::object::player::reply($$$;$) {
786 my ($self, $npc, $msg, $flags) = @_; 806 my ($self, $npc, $msg, $flags) = @_;
787 807
788 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
789 809
793 $msg = $npc->name . " says: $msg" if $npc; 813 $msg = $npc->name . " says: $msg" if $npc;
794 $self->message ($msg, $flags); 814 $self->message ($msg, $flags);
795 } 815 }
796} 816}
797 817
798=item $player->ext_reply ($msgid, $msgtype, %msg) 818=item $player_object->may ("access")
799 819
800Sends an ext reply to the player. 820Returns wether the given player is authorized to access resource "access"
821(e.g. "command_wizcast").
801 822
802=cut 823=cut
803 824
804sub cf::player::ext_reply($$$%) { 825sub cf::object::player::may {
826 my ($self, $access) = @_;
827
828 $self->flag (cf::FLAG_WIZ) ||
829 (ref $cf::CFG{"may_$access"}
830 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
831 : $cf::CFG{"may_$access"})
832}
833
834=head3 cf::client
835
836=over 4
837
838=item $client->send_drawinfo ($text, $flags)
839
840Sends a drawinfo packet to the client. Circumvents output buffering so
841should not be used under normal circumstances.
842
843=cut
844
845sub 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
855Queues a query to the client, calling the given callback with
856the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
857C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
858
859Queries can fail, so check the return code. Or don't, as queries will become
860reliable at some point in the future.
861
862=cut
863
864sub 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
880cf::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
904Create a new coroutine, running the specified callback. The coroutine will
905be automatically cancelled when the client gets destroyed (e.g. on logout,
906or loss of connection).
907
908=cut
909
910sub cf::client::coro {
805 my ($self, $id, %msg) = @_; 911 my ($self, $cb) = @_;
806 912
807 $msg{msgid} = $id; 913 my $coro; $coro = async {
914 eval {
915 $cb->();
916 };
917 warn $@ if $@;
918 delete $self->{_coro}{$coro+0};
919 };
808 920
809 $self->send ("ext " . to_json \%msg); 921 $self->{_coro}{$coro+0} = $coro;
810} 922}
923
924cf::client->attach (
925 on_destroy => sub {
926 my ($ns) = @_;
927
928 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
929 },
930);
811 931
812=back 932=back
813 933
814=cut
815
816#############################################################################
817 934
818=head2 SAFE SCRIPTING 935=head2 SAFE SCRIPTING
819 936
820Functions that provide a safe environment to compile and execute 937Functions that provide a safe environment to compile and execute
821snippets of perl code without them endangering the safety of the server 938snippets of perl code without them endangering the safety of the server
822itself. Looping constructs, I/O operators and other built-in functionality 939itself. Looping constructs, I/O operators and other built-in functionality
823is not available in the safe scripting environment, and the number of 940is not available in the safe scripting environment, and the number of
824functions and methods that cna be called is greatly reduced. 941functions and methods that can be called is greatly reduced.
825 942
826=cut 943=cut
827 944
828our $safe = new Safe "safe"; 945our $safe = new Safe "safe";
829our $safe_hole = new Safe::Hole; 946our $safe_hole = new Safe::Hole;
836 953
837=pod 954=pod
838 955
839The following fucntions and emthods are available within a safe environment: 956The following fucntions and emthods are available within a safe environment:
840 957
841 cf::object contr pay_amount pay_player 958 cf::object contr pay_amount pay_player map
842 cf::object::player player 959 cf::object::player player
843 cf::player peaceful 960 cf::player peaceful
961 cf::map trigger
844 962
845=cut 963=cut
846 964
847for ( 965for (
848 ["cf::object" => qw(contr pay_amount pay_player)], 966 ["cf::object" => qw(contr pay_amount pay_player map)],
849 ["cf::object::player" => qw(player)], 967 ["cf::object::player" => qw(player)],
850 ["cf::player" => qw(peaceful)], 968 ["cf::player" => qw(peaceful)],
969 ["cf::map" => qw(trigger)],
851) { 970) {
852 no strict 'refs'; 971 no strict 'refs';
853 my ($pkg, @funs) = @$_; 972 my ($pkg, @funs) = @$_;
854 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 973 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
855 for @funs; 974 for @funs;
965 1084
966Immediately write the database to disk I<if it is dirty>. 1085Immediately write the database to disk I<if it is dirty>.
967 1086
968=cut 1087=cut
969 1088
1089our $DB;
1090
970{ 1091{
971 my $db;
972 my $path = cf::localdir . "/database.pst"; 1092 my $path = cf::localdir . "/database.pst";
973 1093
974 sub db_load() { 1094 sub db_load() {
975 warn "loading database $path\n";#d# remove later 1095 warn "loading database $path\n";#d# remove later
976 $db = stat $path ? Storable::retrieve $path : { }; 1096 $DB = stat $path ? Storable::retrieve $path : { };
977 } 1097 }
978 1098
979 my $pid; 1099 my $pid;
980 1100
981 sub db_save() { 1101 sub db_save() {
982 warn "saving database $path\n";#d# remove later 1102 warn "saving database $path\n";#d# remove later
983 waitpid $pid, 0 if $pid; 1103 waitpid $pid, 0 if $pid;
984 if (0 == ($pid = fork)) { 1104 if (0 == ($pid = fork)) {
985 $db->{_meta}{version} = 1; 1105 $DB->{_meta}{version} = 1;
986 Storable::nstore $db, "$path~"; 1106 Storable::nstore $DB, "$path~";
987 rename "$path~", $path; 1107 rename "$path~", $path;
988 cf::_exit 0 if defined $pid; 1108 cf::_exit 0 if defined $pid;
989 } 1109 }
990 } 1110 }
991 1111
994 sub db_sync() { 1114 sub db_sync() {
995 db_save if $dirty; 1115 db_save if $dirty;
996 undef $dirty; 1116 undef $dirty;
997 } 1117 }
998 1118
999 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 {
1000 db_sync; 1120 db_sync;
1001 }); 1121 });
1002 1122
1003 sub db_dirty() { 1123 sub db_dirty() {
1004 $dirty = 1; 1124 $dirty = 1;
1005 $idle->start; 1125 $idle->start;
1006 } 1126 }
1007 1127
1008 sub db_get($;$) { 1128 sub db_get($;$) {
1009 @_ >= 2 1129 @_ >= 2
1010 ? $db->{$_[0]}{$_[1]} 1130 ? $DB->{$_[0]}{$_[1]}
1011 : ($db->{$_[0]} ||= { }) 1131 : ($DB->{$_[0]} ||= { })
1012 } 1132 }
1013 1133
1014 sub db_put($$;$) { 1134 sub db_put($$;$) {
1015 if (@_ >= 3) { 1135 if (@_ >= 3) {
1016 $db->{$_[0]}{$_[1]} = $_[2]; 1136 $DB->{$_[0]}{$_[1]} = $_[2];
1017 } else { 1137 } else {
1018 $db->{$_[0]} = $_[1]; 1138 $DB->{$_[0]} = $_[1];
1019 } 1139 }
1020 db_dirty; 1140 db_dirty;
1021 } 1141 }
1022 1142
1023 attach_global 1143 cf::global->attach (
1024 prio => 10000, 1144 prio => 10000,
1025 on_cleanup => sub { 1145 on_cleanup => sub {
1026 db_sync; 1146 db_sync;
1027 }, 1147 },
1028 ; 1148 );
1029} 1149}
1030 1150
1031############################################################################# 1151#############################################################################
1032# the server's main() 1152# the server's main()
1033 1153
1054 1174
1055 $msg->("reloading..."); 1175 $msg->("reloading...");
1056 1176
1057 eval { 1177 eval {
1058 # cancel all watchers 1178 # cancel all watchers
1059 $_->cancel for Event::all_watchers; 1179 for (Event::all_watchers) {
1180 $_->cancel if $_->data & WF_AUTOCANCEL;
1181 }
1060 1182
1061 # unload all extensions 1183 # unload all extensions
1062 for (@exts) { 1184 for (@exts) {
1063 $msg->("unloading <$_>"); 1185 $msg->("unloading <$_>");
1064 unload_extension $_; 1186 unload_extension $_;
1099 #Symbol::delete_package __PACKAGE__; 1221 #Symbol::delete_package __PACKAGE__;
1100 1222
1101 # reload cf.pm 1223 # reload cf.pm
1102 $msg->("reloading cf.pm"); 1224 $msg->("reloading cf.pm");
1103 require cf; 1225 require cf;
1226 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1227
1104 1228
1105 # load config and database again 1229 # load config and database again
1106 cf::cfg_load; 1230 cf::cfg_load;
1107 cf::db_load; 1231 cf::db_load;
1108 1232
1124 warn $_[0]; 1248 warn $_[0];
1125 print "$_[0]\n"; 1249 print "$_[0]\n";
1126 }; 1250 };
1127} 1251}
1128 1252
1253register "<global>", __PACKAGE__;
1254
1129register_command "perl-reload", 0, sub { 1255register_command "perl-reload" => sub {
1130 my ($who, $arg) = @_; 1256 my ($who, $arg) = @_;
1131 1257
1132 if ($who->flag (FLAG_WIZ)) { 1258 if ($who->flag (FLAG_WIZ)) {
1133 _perl_reload { 1259 _perl_reload {
1134 warn $_[0]; 1260 warn $_[0];
1135 $who->message ($_[0]); 1261 $who->message ($_[0]);
1136 }; 1262 };
1137 } 1263 }
1138}; 1264};
1139 1265
1140register "<global>", __PACKAGE__;
1141
1142unshift @INC, $LIBDIR; 1266unshift @INC, $LIBDIR;
1143 1267
1144$TICK_WATCHER = Event->timer ( 1268$TICK_WATCHER = Event->timer (
1145 prio => 1, 1269 prio => 0,
1146 at => $NEXT_TICK || 1, 1270 at => $NEXT_TICK || 1,
1271 data => WF_AUTOCANCEL,
1147 cb => sub { 1272 cb => sub {
1148 cf::server_tick; # one server iteration 1273 cf::server_tick; # one server iteration
1149 1274
1150 my $NOW = Event::time; 1275 my $NOW = Event::time;
1151 $NEXT_TICK += $TICK; 1276 $NEXT_TICK += $TICK;
1152 1277
1153 # if we are delayed by four ticks, skip them all 1278 # if we are delayed by four ticks or more, skip them all
1154 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1279 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1155 1280
1156 $TICK_WATCHER->at ($NEXT_TICK); 1281 $TICK_WATCHER->at ($NEXT_TICK);
1157 $TICK_WATCHER->start; 1282 $TICK_WATCHER->start;
1158 }, 1283 },
1159); 1284);
1160 1285
1286IO::AIO::max_poll_time $TICK * 0.2;
1287
1288Event->io (fd => IO::AIO::poll_fileno,
1289 poll => 'r',
1290 prio => 5,
1291 data => WF_AUTOCANCEL,
1292 cb => \&IO::AIO::poll_cb);
1293
11611 12941
1162 1295

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines