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.92 by root, Thu Dec 21 06:42:28 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 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 2.3;
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);
20 29
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 31
23our %COMMAND = (); 32our %COMMAND = ();
24our %COMMAND_TIME = (); 33our %COMMAND_TIME = ();
25our %EXTCMD = (); 34our %EXTCMD = ();
26
27_init_vars;
28 35
29our @EVENT; 36our @EVENT;
30our $LIBDIR = datadir . "/ext"; 37our $LIBDIR = datadir . "/ext";
31 38
32our $TICK = MAX_TIME * 1e-6; 39our $TICK = MAX_TIME * 1e-6;
74 print STDERR "cfperl: $msg"; 81 print STDERR "cfperl: $msg";
75 LOG llevError, "cfperl: $msg"; 82 LOG llevError, "cfperl: $msg";
76 }; 83 };
77} 84}
78 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';
79@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 91@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80 92
81# 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
82# within the Safe compartment. 94# within the Safe compartment.
83for my $pkg (qw( 95for my $pkg (qw(
96 cf::global cf::attachable
84 cf::object cf::object::player 97 cf::object cf::object::player
85 cf::client cf::player 98 cf::client cf::player
86 cf::arch cf::living 99 cf::arch cf::living
87 cf::map cf::party cf::region 100 cf::map cf::party cf::region
88)) { 101)) {
132 145
133=cut 146=cut
134 147
135############################################################################# 148#############################################################################
136 149
137=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+).
138 159
139=over 4 160=over 4
140 161
141=item $object->attach ($attachment, key => $value...)
142
143=item $object->detach ($attachment)
144
145Attach/detach a pre-registered attachment to an object.
146
147=item $player->attach ($attachment, key => $value...)
148
149=item $player->detach ($attachment)
150
151Attach/detach a pre-registered attachment to a player.
152
153=item $map->attach ($attachment, key => $value...)
154
155=item $map->detach ($attachment)
156
157Attach/detach a pre-registered attachment to a client.
158
159=item $client->attach ($attachment, key => $value...) 162=item $attachable->attach ($attachment, key => $value...)
160 163
161=item $client->detach ($attachment) 164=item $attachable->detach ($attachment)
162 165
163Attach/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.
164 168
165=item $bool = $object->attached ($name) 169Example, attach a minesweeper attachment to the given object, making it a
17010x10 minesweeper game:
166 171
167=item $bool = $player->attached ($name) 172 $obj->attach (minesweeper => width => 10, height => 10);
168 173
169=item $bool = $client->attached ($name) 174=item $bool = $attachable->attached ($name)
170
171=item $bool = $map->attached ($name)
172 175
173Checks wether the named attachment is currently attached to the object. 176Checks wether the named attachment is currently attached to the object.
174 177
175=item cf::attach_global ... 178=item cf::CLASS->attach ...
176 179
177Attach handlers for global events. 180=item cf::CLASS->detach ...
178 181
179This and all following C<attach_*>-functions expect any number of the 182Define an anonymous attachment and attach it to all objects of the given
180following 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:
181 216
182=over 4 217=over 4
183 218
184=item prio => $number 219=item prio => $number
185 220
187by another C<prio> setting). Lower priority handlers get executed 222by another C<prio> setting). Lower priority handlers get executed
188earlier. 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
189registered at priority C<-1000>, so lower priorities should not be used 224registered at priority C<-1000>, so lower priorities should not be used
190unless you know what you are doing. 225unless you know what you are doing.
191 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
192=item on_I<event> => \&cb 233=item on_I<event> => \&cb
193 234
194Call the given code reference whenever the named event happens (event is 235Call the given code reference whenever the named event happens (event is
195something 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
196handlers are recognised generally depends on the type of object these 237handlers are recognised generally depends on the type of object these
205package and register them. Only handlers for eevents supported by the 246package and register them. Only handlers for eevents supported by the
206object/class are recognised. 247object/class are recognised.
207 248
208=back 249=back
209 250
210=item cf::attach_to_type $object_type, $subtype, ... 251Example, define an attachment called "sockpuppet" that calls the given
252event handler when a monster attacks:
211 253
212Attach handlers for a specific object type (e.g. TRANSPORT) and 254 cf::object::attachment sockpuppet =>
213subtype. If C<$subtype> is zero or undef, matches all objects of the given 255 on_skill_attack => sub {
214type. 256 my ($self, $victim) = @_;
215 257 ...
216=item cf::attach_to_objects ...
217
218Attach handlers to all objects. Do not use this except for debugging or
219very rare events, as handlers are (obviously) called for I<all> objects in
220the game.
221
222=item cf::attach_to_players ...
223
224Attach handlers to all players.
225
226=item cf::attach_to_clients ...
227
228Attach handlers to all players.
229
230=item cf::attach_to_maps ...
231
232Attach handlers to all maps.
233
234=item cf:register_attachment $name, ...
235
236Register an attachment by name through which objects can refer to this
237attachment.
238
239=item cf:register_player_attachment $name, ...
240
241Register an attachment by name through which players can refer to this
242attachment.
243
244=item cf:register_map_attachment $name, ...
245
246Register an attachment by name through which maps can refer to this
247attachment.
248
249=cut
250
251# the following variables are defined in .xs and must not be re-created
252our @CB_GLOBAL = (); # registry for all global events
253our @CB_OBJECT = (); # all objects (should not be used except in emergency)
254our @CB_PLAYER = ();
255our @CB_CLIENT = ();
256our @CB_TYPE = (); # registry for type (cf-object class) based events
257our @CB_MAP = ();
258
259my %attachment;
260
261sub _attach_cb($\%$$$) {
262 my ($registry, $undo, $event, $prio, $cb) = @_;
263
264 use sort 'stable';
265
266 $cb = [$prio, $cb];
267
268 @{$registry->[$event]} = sort
269 { $a->[0] cmp $b->[0] }
270 @{$registry->[$event] || []}, $cb;
271
272 push @{$undo->{cb}}, [$event, $cb];
273}
274
275# attach handles attaching event callbacks
276# the only thing the caller has to do is pass the correct
277# registry (== where the callback attaches to).
278sub _attach(\@$@) {
279 my ($registry, $klass, @arg) = @_;
280
281 my $prio = 0;
282
283 my %undo = (
284 registry => $registry,
285 cb => [],
286 );
287
288 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
289
290 while (@arg) {
291 my $type = shift @arg;
292
293 if ($type eq "prio") {
294 $prio = shift @arg;
295
296 } elsif ($type eq "package") {
297 my $pkg = shift @arg;
298
299 while (my ($name, $id) = each %cb_id) {
300 if (my $cb = $pkg->can ($name)) {
301 _attach_cb $registry, %undo, $id, $prio, $cb;
302 }
303 } 258 }
304
305 } elsif (exists $cb_id{$type}) {
306 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
307
308 } elsif (ref $type) {
309 warn "attaching objects not supported, ignoring.\n";
310
311 } else {
312 shift @arg;
313 warn "attach argument '$type' not supported, ignoring.\n";
314 }
315 }
316
317 \%undo
318}
319
320sub _attach_attachment {
321 my ($obj, $name, %arg) = @_;
322
323 return if exists $obj->{_attachment}{$name};
324
325 my $res;
326
327 if (my $attach = $attachment{$name}) {
328 my $registry = $obj->registry;
329
330 for (@$attach) {
331 my ($klass, @attach) = @$_;
332 $res = _attach @$registry, $klass, @attach;
333 }
334
335 $obj->{$name} = \%arg;
336 } else {
337 warn "object uses attachment '$name' that is not available, postponing.\n";
338 }
339
340 $obj->{_attachment}{$name} = undef;
341
342 $res->{attachment} = $name;
343 $res
344}
345
346*cf::object::attach =
347*cf::player::attach =
348*cf::client::attach =
349*cf::map::attach = sub {
350 my ($obj, $name, %arg) = @_;
351
352 _attach_attachment $obj, $name, %arg;
353};
354
355# all those should be optimised
356*cf::object::detach =
357*cf::player::detach =
358*cf::client::detach =
359*cf::map::detach = sub {
360 my ($obj, $name) = @_;
361
362 delete $obj->{_attachment}{$name};
363 reattach ($obj);
364};
365
366*cf::object::attached =
367*cf::player::attached =
368*cf::client::attached =
369*cf::map::attached = sub {
370 my ($obj, $name) = @_;
371
372 exists $obj->{_attachment}{$name}
373};
374
375sub attach_global {
376 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
377}
378
379sub attach_to_type {
380 my $type = shift;
381 my $subtype = shift;
382
383 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
384}
385
386sub attach_to_objects {
387 _attach @CB_OBJECT, KLASS_OBJECT, @_
388}
389
390sub attach_to_players {
391 _attach @CB_PLAYER, KLASS_PLAYER, @_
392}
393
394sub attach_to_clients {
395 _attach @CB_CLIENT, KLASS_CLIENT, @_
396}
397
398sub attach_to_maps {
399 _attach @CB_MAP, KLASS_MAP, @_
400}
401
402sub register_attachment {
403 my $name = shift;
404
405 $attachment{$name} = [[KLASS_OBJECT, @_]];
406}
407
408sub register_player_attachment {
409 my $name = shift;
410
411 $attachment{$name} = [[KLASS_PLAYER, @_]];
412}
413
414sub register_client_attachment {
415 my $name = shift;
416
417 $attachment{$name} = [[KLASS_CLIENT, @_]];
418}
419
420sub register_map_attachment {
421 my $name = shift;
422
423 $attachment{$name} = [[KLASS_MAP, @_]];
424}
425
426our $override;
427our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
428
429sub override {
430 $override = 1;
431 @invoke_results = ();
432}
433
434sub do_invoke {
435 my $event = shift;
436 my $callbacks = shift;
437
438 @invoke_results = ();
439
440 local $override;
441
442 for (@$callbacks) {
443 eval { &{$_->[1]} };
444
445 if ($@) {
446 warn "$@";
447 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
448 override;
449 }
450
451 return 1 if $override;
452 }
453
454 0 259 }
455}
456 260
457=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 261=item $attachable->valid
458
459=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
460
461=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
462
463=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
464
465=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
466
467Generate a global/object/player/map-specific event with the given arguments.
468
469This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
470removed in future versions), and there is no public API to access override
471results (if you must, access C<@cf::invoke_results> directly).
472
473=back
474
475=cut
476
477#############################################################################
478
479=head2 METHODS VALID FOR ALL CORE OBJECTS
480
481=over 4
482
483=item $object->valid, $player->valid, $client->valid, $map->valid
484 262
485Just 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
486C-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
487valid C counterpart anymore you get an exception at runtime. This method 265valid C counterpart anymore you get an exception at runtime. This method
488can 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
489exception. 267exception.
490 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
491=back 452=back
492 453
493=cut 454=cut
494
495*cf::object::valid =
496*cf::player::valid =
497*cf::client::valid =
498*cf::map::valid = \&cf::_valid;
499 455
500############################################################################# 456#############################################################################
501# object support 457# object support
502 458
503sub instantiate {
504 my ($obj, $data) = @_;
505
506 $data = from_json $data;
507
508 for (@$data) {
509 my ($name, $args) = @$_;
510
511 $obj->attach ($name, %{$args || {} });
512 }
513}
514
515# basically do the same as instantiate, without calling instantiate
516sub reattach { 459sub reattach {
460 # basically do the same as instantiate, without calling instantiate
517 my ($obj) = @_; 461 my ($obj) = @_;
462
518 my $registry = $obj->registry; 463 my $registry = $obj->registry;
519 464
520 @$registry = (); 465 @$registry = ();
521 466
522 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 467 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
523 468
524 for my $name (keys %{ $obj->{_attachment} || {} }) { 469 for my $name (keys %{ $obj->{_attachment} || {} }) {
525 if (my $attach = $attachment{$name}) { 470 if (my $attach = $attachment{$name}) {
526 for (@$attach) { 471 for (@$attach) {
527 my ($klass, @attach) = @$_; 472 my ($klass, @attach) = @$_;
528 _attach @$registry, $klass, @attach; 473 _attach $registry, $klass, @attach;
529 } 474 }
530 } else { 475 } else {
531 warn "object uses attachment '$name' that is not available, postponing.\n"; 476 warn "object uses attachment '$name' that is not available, postponing.\n";
532 } 477 }
533 } 478 }
534} 479}
480
481cf::attachable->attach (
482 prio => -1000000,
483 on_instantiate => sub {
484 my ($obj, $data) = @_;
485
486 $data = from_json $data;
487
488 for (@$data) {
489 my ($name, $args) = @$_;
490
491 $obj->attach ($name, %{$args || {} });
492 }
493 },
494 on_reattach => \&reattach,
495 on_clone => sub {
496 my ($src, $dst) = @_;
497
498 @{$dst->registry} = @{$src->registry};
499
500 %$dst = %$src;
501
502 %{$dst->{_attachment}} = %{$src->{_attachment}}
503 if exists $src->{_attachment};
504 },
505);
535 506
536sub object_freezer_save { 507sub object_freezer_save {
537 my ($filename, $rdata, $objs) = @_; 508 my ($filename, $rdata, $objs) = @_;
538 509
539 if (length $$rdata) { 510 if (length $$rdata) {
589 } 560 }
590 561
591 () 562 ()
592} 563}
593 564
594attach_to_objects
595 prio => -1000000,
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############################################################################# 565#############################################################################
609# command handling &c 566# command handling &c
610 567
611=item cf::register_command $name => \&callback($ob,$args); 568=item cf::register_command $name => \&callback($ob,$args);
612 569
640 #warn "registering extcmd '$name' to '$caller'"; 597 #warn "registering extcmd '$name' to '$caller'";
641 598
642 $EXTCMD{$name} = [$cb, $caller]; 599 $EXTCMD{$name} = [$cb, $caller];
643} 600}
644 601
645attach_to_players 602cf::player->attach (
646 on_command => sub { 603 on_command => sub {
647 my ($pl, $name, $params) = @_; 604 my ($pl, $name, $params) = @_;
648 605
649 my $cb = $COMMAND{$name} 606 my $cb = $COMMAND{$name}
650 or return; 607 or return;
670 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 627 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
671 } 628 }
672 629
673 cf::override; 630 cf::override;
674 }, 631 },
675; 632);
676 633
677sub register { 634sub register {
678 my ($base, $pkg) = @_; 635 my ($base, $pkg) = @_;
679 636
680 #TODO 637 #TODO
770 defined $path or return; 727 defined $path or return;
771 728
772 unlink "$path.pst"; 729 unlink "$path.pst";
773}; 730};
774 731
775attach_to_maps prio => -10000, package => cf::mapsupport::; 732cf::map->attach (prio => -10000, package => cf::mapsupport::);
776 733
777############################################################################# 734#############################################################################
778# load/save perl data associated with player->ob objects 735# load/save perl data associated with player->ob objects
779 736
780sub all_objects(@) { 737sub all_objects(@) {
781 @_, map all_objects ($_->inv), @_ 738 @_, map all_objects ($_->inv), @_
782} 739}
783 740
784# TODO: compatibility cruft, remove when no longer needed 741# TODO: compatibility cruft, remove when no longer needed
785attach_to_players 742cf::player->attach (
786 on_load => sub { 743 on_load => sub {
787 my ($pl, $path) = @_; 744 my ($pl, $path) = @_;
788 745
789 for my $o (all_objects $pl->ob) { 746 for my $o (all_objects $pl->ob) {
790 if (my $value = $o->get_ob_key_value ("_perl_data")) { 747 if (my $value = $o->get_ob_key_value ("_perl_data")) {
792 749
793 %$o = %{ Storable::thaw pack "H*", $value }; 750 %$o = %{ Storable::thaw pack "H*", $value };
794 } 751 }
795 } 752 }
796 }, 753 },
797; 754);
798 755
799############################################################################# 756#############################################################################
800 757
801=head2 CORE EXTENSIONS 758=head2 CORE EXTENSIONS
802 759
803Functions and methods that extend core crossfire objects. 760Functions and methods that extend core crossfire objects.
761
762=head3 cf::player
804 763
805=over 4 764=over 4
806 765
807=item cf::player::exists $login 766=item cf::player::exists $login
808 767
813sub cf::player::exists($) { 772sub cf::player::exists($) {
814 cf::player::find $_[0] 773 cf::player::find $_[0]
815 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 774 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
816} 775}
817 776
777=item $player->ext_reply ($msgid, $msgtype, %msg)
778
779Sends an ext reply to the player.
780
781=cut
782
783sub cf::player::ext_reply($$$%) {
784 my ($self, $id, %msg) = @_;
785
786 $msg{msgid} = $id;
787
788 $self->send ("ext " . to_json \%msg);
789}
790
791=back
792
793=head3 cf::object::player
794
795=over 4
796
818=item $player_object->reply ($npc, $msg[, $flags]) 797=item $player_object->reply ($npc, $msg[, $flags])
819 798
820Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 799Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
821can be C<undef>. Does the right thing when the player is currently in a 800can be C<undef>. Does the right thing when the player is currently in a
822dialogue with the given NPC character. 801dialogue with the given NPC character.
823 802
824=cut 803=cut
825 804
826# rough implementation of a future "reply" method that works 805# rough implementation of a future "reply" method that works
827# with dialog boxes. 806# with dialog boxes.
807#TODO: the first argument must go, split into a $npc->reply_to ( method
828sub cf::object::player::reply($$$;$) { 808sub cf::object::player::reply($$$;$) {
829 my ($self, $npc, $msg, $flags) = @_; 809 my ($self, $npc, $msg, $flags) = @_;
830 810
831 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 811 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
832 812
836 $msg = $npc->name . " says: $msg" if $npc; 816 $msg = $npc->name . " says: $msg" if $npc;
837 $self->message ($msg, $flags); 817 $self->message ($msg, $flags);
838 } 818 }
839} 819}
840 820
841=item $player->ext_reply ($msgid, $msgtype, %msg)
842
843Sends an ext reply to the player.
844
845=cut
846
847sub cf::player::ext_reply($$$%) {
848 my ($self, $id, %msg) = @_;
849
850 $msg{msgid} = $id;
851
852 $self->send ("ext " . to_json \%msg);
853}
854
855=item $player_object->may ("access") 821=item $player_object->may ("access")
856 822
857Returns wether the given player is authorized to access resource "access" 823Returns wether the given player is authorized to access resource "access"
858(e.g. "command_wizcast"). 824(e.g. "command_wizcast").
859 825
866 (ref $cf::CFG{"may_$access"} 832 (ref $cf::CFG{"may_$access"}
867 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 833 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
868 : $cf::CFG{"may_$access"}) 834 : $cf::CFG{"may_$access"})
869} 835}
870 836
871=cut 837=head3 cf::client
872 838
873############################################################################# 839=over 4
840
841=item $client->send_drawinfo ($text, $flags)
842
843Sends a drawinfo packet to the client. Circumvents output buffering so
844should not be used under normal circumstances.
845
846=cut
847
848sub cf::client::send_drawinfo {
849 my ($self, $text, $flags) = @_;
850
851 utf8::encode $text;
852 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
853}
854
855
856=item $success = $client->query ($flags, "text", \&cb)
857
858Queues a query to the client, calling the given callback with
859the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
860C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
861
862Queries can fail, so check the return code. Or don't, as queries will become
863reliable at some point in the future.
864
865=cut
866
867sub cf::client::query {
868 my ($self, $flags, $text, $cb) = @_;
869
870 return unless $self->state == ST_PLAYING
871 || $self->state == ST_SETUP
872 || $self->state == ST_CUSTOM;
873
874 $self->state (ST_CUSTOM);
875
876 utf8::encode $text;
877 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
878
879 $self->send_packet ($self->{query_queue}[0][0])
880 if @{ $self->{query_queue} } == 1;
881}
882
883cf::client->attach (
884 on_reply => sub {
885 my ($ns, $msg) = @_;
886
887 # this weird shuffling is so that direct followup queries
888 # get handled first
889 my $queue = delete $ns->{query_queue};
890
891 (shift @$queue)->[1]->($msg);
892
893 push @{ $ns->{query_queue} }, @$queue;
894
895 if (@{ $ns->{query_queue} } == @$queue) {
896 if (@$queue) {
897 $ns->send_packet ($ns->{query_queue}[0][0]);
898 } else {
899 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
900 }
901 }
902 },
903);
904
905=item $client->coro (\&cb)
906
907Create a new coroutine, running the specified callback. The coroutine will
908be automatically cancelled when the client gets destroyed (e.g. on logout,
909or loss of connection).
910
911=cut
912
913sub cf::client::coro {
914 my ($self, $cb) = @_;
915
916 my $coro; $coro = async {
917 eval {
918 $cb->();
919 };
920 warn $@ if $@;
921 delete $self->{_coro}{$coro+0};
922 };
923
924 $self->{_coro}{$coro+0} = $coro;
925}
926
927cf::client->attach (
928 on_destroy => sub {
929 my ($ns) = @_;
930
931 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
932 },
933);
934
935=back
936
874 937
875=head2 SAFE SCRIPTING 938=head2 SAFE SCRIPTING
876 939
877Functions that provide a safe environment to compile and execute 940Functions that provide a safe environment to compile and execute
878snippets of perl code without them endangering the safety of the server 941snippets of perl code without them endangering the safety of the server
1078 $DB->{$_[0]} = $_[1]; 1141 $DB->{$_[0]} = $_[1];
1079 } 1142 }
1080 db_dirty; 1143 db_dirty;
1081 } 1144 }
1082 1145
1083 attach_global 1146 cf::global->attach (
1084 prio => 10000, 1147 prio => 10000,
1085 on_cleanup => sub { 1148 on_cleanup => sub {
1086 db_sync; 1149 db_sync;
1087 }, 1150 },
1088 ; 1151 );
1089} 1152}
1090 1153
1091############################################################################# 1154#############################################################################
1092# the server's main() 1155# the server's main()
1093 1156
1161 #Symbol::delete_package __PACKAGE__; 1224 #Symbol::delete_package __PACKAGE__;
1162 1225
1163 # reload cf.pm 1226 # reload cf.pm
1164 $msg->("reloading cf.pm"); 1227 $msg->("reloading cf.pm");
1165 require cf; 1228 require cf;
1229 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1166 1230
1167 # load config and database again 1231 # load config and database again
1168 cf::cfg_load; 1232 cf::cfg_load;
1169 cf::db_load; 1233 cf::db_load;
1170 1234

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines