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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines