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.88 by root, Fri Dec 15 19:29:18 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
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_socket 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)) {
89 no strict 'refs'; 102 no strict 'refs';
90 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 103 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
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...) 162=item $attachable->attach ($attachment, key => $value...)
154 163
155=item $map->detach ($attachment) 164=item $attachable->detach ($attachment)
156 165
157Attach/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.
158 168
159=item $bool = $object->attached ($name) 169Example, attach a minesweeper attachment to the given object, making it a
17010x10 minesweeper game:
160 171
161=item $bool = $player->attached ($name) 172 $obj->attach (minesweeper => width => 10, height => 10);
162 173
163=item $bool = $map->attached ($name) 174=item $bool = $attachable->attached ($name)
164 175
165Checks wether the named attachment is currently attached to the object. 176Checks wether the named attachment is currently attached to the object.
166 177
167=item cf::attach_global ... 178=item cf::CLASS->attach ...
168 179
169Attach handlers for global events. 180=item cf::CLASS->detach ...
170 181
171This and all following C<attach_*>-functions expect any number of the 182Define an anonymous attachment and attach it to all objects of the given
172following 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:
173 216
174=over 4 217=over 4
175 218
176=item prio => $number 219=item prio => $number
177 220
179by another C<prio> setting). Lower priority handlers get executed 222by another C<prio> setting). Lower priority handlers get executed
180earlier. 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
181registered at priority C<-1000>, so lower priorities should not be used 224registered at priority C<-1000>, so lower priorities should not be used
182unless you know what you are doing. 225unless you know what you are doing.
183 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
184=item on_I<event> => \&cb 233=item on_I<event> => \&cb
185 234
186Call the given code reference whenever the named event happens (event is 235Call the given code reference whenever the named event happens (event is
187something 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
188handlers are recognised generally depends on the type of object these 237handlers are recognised generally depends on the type of object these
197package and register them. Only handlers for eevents supported by the 246package and register them. Only handlers for eevents supported by the
198object/class are recognised. 247object/class are recognised.
199 248
200=back 249=back
201 250
202=item cf::attach_to_type $object_type, $subtype, ... 251Example, define an attachment called "sockpuppet" that calls the given
252event handler when a monster attacks:
203 253
204Attach handlers for a specific object type (e.g. TRANSPORT) and 254 cf::object::attachment sockpuppet =>
205subtype. If C<$subtype> is zero or undef, matches all objects of the given 255 on_skill_attack => sub {
206type. 256 my ($self, $victim) = @_;
207 257 ...
208=item cf::attach_to_objects ...
209
210Attach handlers to all objects. Do not use this except for debugging or
211very rare events, as handlers are (obviously) called for I<all> objects in
212the game.
213
214=item cf::attach_to_players ...
215
216Attach handlers to all players.
217
218=item cf::attach_to_maps ...
219
220Attach handlers to all maps.
221
222=item cf:register_attachment $name, ...
223
224Register an attachment by name through which objects can refer to this
225attachment.
226
227=item cf:register_player_attachment $name, ...
228
229Register an attachment by name through which players can refer to this
230attachment.
231
232=item cf:register_map_attachment $name, ...
233
234Register an attachment by name through which maps can refer to this
235attachment.
236
237=cut
238
239# the following variables are defined in .xs and must not be re-created
240our @CB_GLOBAL = (); # registry for all global events
241our @CB_OBJECT = (); # all objects (should not be used except in emergency)
242our @CB_PLAYER = ();
243our @CB_TYPE = (); # registry for type (cf-object class) based events
244our @CB_MAP = ();
245
246my %attachment;
247
248sub _attach_cb($\%$$$) {
249 my ($registry, $undo, $event, $prio, $cb) = @_;
250
251 use sort 'stable';
252
253 $cb = [$prio, $cb];
254
255 @{$registry->[$event]} = sort
256 { $a->[0] cmp $b->[0] }
257 @{$registry->[$event] || []}, $cb;
258
259 push @{$undo->{cb}}, [$event, $cb];
260}
261
262# attach handles attaching event callbacks
263# the only thing the caller has to do is pass the correct
264# registry (== where the callback attaches to).
265sub _attach(\@$@) {
266 my ($registry, $klass, @arg) = @_;
267
268 my $prio = 0;
269
270 my %undo = (
271 registry => $registry,
272 cb => [],
273 );
274
275 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
276
277 while (@arg) {
278 my $type = shift @arg;
279
280 if ($type eq "prio") {
281 $prio = shift @arg;
282
283 } elsif ($type eq "package") {
284 my $pkg = shift @arg;
285
286 while (my ($name, $id) = each %cb_id) {
287 if (my $cb = $pkg->can ($name)) {
288 _attach_cb $registry, %undo, $id, $prio, $cb;
289 }
290 } 258 }
291
292 } elsif (exists $cb_id{$type}) {
293 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
294
295 } elsif (ref $type) {
296 warn "attaching objects not supported, ignoring.\n";
297
298 } else {
299 shift @arg;
300 warn "attach argument '$type' not supported, ignoring.\n";
301 }
302 }
303
304 \%undo
305}
306
307sub _attach_attachment {
308 my ($obj, $name, %arg) = @_;
309
310 return if exists $obj->{_attachment}{$name};
311
312 my $res;
313
314 if (my $attach = $attachment{$name}) {
315 my $registry = $obj->registry;
316
317 for (@$attach) {
318 my ($klass, @attach) = @$_;
319 $res = _attach @$registry, $klass, @attach;
320 }
321
322 $obj->{$name} = \%arg;
323 } else {
324 warn "object uses attachment '$name' that is not available, postponing.\n";
325 }
326
327 $obj->{_attachment}{$name} = undef;
328
329 $res->{attachment} = $name;
330 $res
331}
332
333*cf::object::attach =
334*cf::player::attach =
335*cf::map::attach = sub {
336 my ($obj, $name, %arg) = @_;
337
338 _attach_attachment $obj, $name, %arg;
339};
340
341# all those should be optimised
342*cf::object::detach =
343*cf::player::detach =
344*cf::map::detach = sub {
345 my ($obj, $name) = @_;
346
347 delete $obj->{_attachment}{$name};
348 reattach ($obj);
349};
350
351*cf::object::attached =
352*cf::player::attached =
353*cf::map::attached = sub {
354 my ($obj, $name) = @_;
355
356 exists $obj->{_attachment}{$name}
357};
358
359sub attach_global {
360 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
361}
362
363sub attach_to_type {
364 my $type = shift;
365 my $subtype = shift;
366
367 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
368}
369
370sub attach_to_objects {
371 _attach @CB_OBJECT, KLASS_OBJECT, @_
372}
373
374sub attach_to_players {
375 _attach @CB_PLAYER, KLASS_PLAYER, @_
376}
377
378sub attach_to_maps {
379 _attach @CB_MAP, KLASS_MAP, @_
380}
381
382sub register_attachment {
383 my $name = shift;
384
385 $attachment{$name} = [[KLASS_OBJECT, @_]];
386}
387
388sub register_player_attachment {
389 my $name = shift;
390
391 $attachment{$name} = [[KLASS_PLAYER, @_]];
392}
393
394sub register_map_attachment {
395 my $name = shift;
396
397 $attachment{$name} = [[KLASS_MAP, @_]];
398}
399
400our $override;
401our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
402
403sub override {
404 $override = 1;
405 @invoke_results = ();
406}
407
408sub do_invoke {
409 my $event = shift;
410 my $callbacks = shift;
411
412 @invoke_results = ();
413
414 local $override;
415
416 for (@$callbacks) {
417 eval { &{$_->[1]} };
418
419 if ($@) {
420 warn "$@";
421 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
422 override;
423 }
424
425 return 1 if $override;
426 }
427
428 0 259 }
429}
430 260
431=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 261=item $attachable->valid
432
433=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
434
435=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
436
437=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
438
439Generate a global/object/player/map-specific event with the given arguments.
440
441This API is preliminary (most likely, the EVENT_KLASS_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
445=back
446
447=cut
448
449#############################################################################
450
451=head2 METHODS VALID FOR ALL CORE OBJECTS
452
453=over 4
454
455=item $object->valid, $player->valid, $map->valid
456 262
457Just 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
458C-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
459valid C counterpart anymore you get an exception at runtime. This method 265valid C counterpart anymore you get an exception at runtime. This method
460can 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
461exception. 267exception.
462 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
463=back 452=back
464 453
465=cut 454=cut
466
467*cf::object::valid =
468*cf::player::valid =
469*cf::map::valid = \&cf::_valid;
470 455
471############################################################################# 456#############################################################################
472# object support 457# object support
473 458
474sub instantiate { 459cf::attachable->attach (
460 prio => -1000000,
461 on_instantiate => sub {
475 my ($obj, $data) = @_; 462 my ($obj, $data) = @_;
476 463
477 $data = from_json $data; 464 $data = from_json $data;
478 465
479 for (@$data) { 466 for (@$data) {
480 my ($name, $args) = @$_; 467 my ($name, $args) = @$_;
481 468
482 $obj->attach ($name, %{$args || {} }); 469 $obj->attach ($name, %{$args || {} });
470 }
483 } 471 },
484} 472 on_reattach => sub {
485
486# basically do the same as instantiate, without calling instantiate 473 # basically do the same as instantiate, without calling instantiate
487sub reattach {
488 my ($obj) = @_; 474 my ($obj) = @_;
489 my $registry = $obj->registry; 475 my $registry = $obj->registry;
490 476
491 @$registry = (); 477 @$registry = ();
492 478
493 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 479 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494 480
495 for my $name (keys %{ $obj->{_attachment} || {} }) { 481 for my $name (keys %{ $obj->{_attachment} || {} }) {
496 if (my $attach = $attachment{$name}) { 482 if (my $attach = $attachment{$name}) {
497 for (@$attach) { 483 for (@$attach) {
498 my ($klass, @attach) = @$_; 484 my ($klass, @attach) = @$_;
499 _attach @$registry, $klass, @attach; 485 _attach $registry, $klass, @attach;
486 }
487 } else {
488 warn "object uses attachment '$name' that is not available, postponing.\n";
500 } 489 }
501 } else {
502 warn "object uses attachment '$name' that is not available, postponing.\n";
503 } 490 }
504 } 491 },
505} 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);
506 503
507sub object_freezer_save { 504sub object_freezer_save {
508 my ($filename, $rdata, $objs) = @_; 505 my ($filename, $rdata, $objs) = @_;
509 506
510 if (length $$rdata) { 507 if (length $$rdata) {
560 } 557 }
561 558
562 () 559 ()
563} 560}
564 561
565attach_to_objects
566 prio => -1000000,
567 on_clone => sub {
568 my ($src, $dst) = @_;
569
570 @{$dst->registry} = @{$src->registry};
571
572 %$dst = %$src;
573
574 %{$dst->{_attachment}} = %{$src->{_attachment}}
575 if exists $src->{_attachment};
576 },
577;
578
579############################################################################# 562#############################################################################
580# command handling &c 563# command handling &c
581 564
582=item cf::register_command $name => \&callback($ob,$args); 565=item cf::register_command $name => \&callback($ob,$args);
583 566
611 #warn "registering extcmd '$name' to '$caller'"; 594 #warn "registering extcmd '$name' to '$caller'";
612 595
613 $EXTCMD{$name} = [$cb, $caller]; 596 $EXTCMD{$name} = [$cb, $caller];
614} 597}
615 598
616attach_to_players 599cf::player->attach (
617 on_command => sub { 600 on_command => sub {
618 my ($pl, $name, $params) = @_; 601 my ($pl, $name, $params) = @_;
619 602
620 my $cb = $COMMAND{$name} 603 my $cb = $COMMAND{$name}
621 or return; 604 or return;
641 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 624 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642 } 625 }
643 626
644 cf::override; 627 cf::override;
645 }, 628 },
646; 629);
647 630
648sub register { 631sub register {
649 my ($base, $pkg) = @_; 632 my ($base, $pkg) = @_;
650 633
651 #TODO 634 #TODO
741 defined $path or return; 724 defined $path or return;
742 725
743 unlink "$path.pst"; 726 unlink "$path.pst";
744}; 727};
745 728
746attach_to_maps prio => -10000, package => cf::mapsupport::; 729cf::map->attach (prio => -10000, package => cf::mapsupport::);
747 730
748############################################################################# 731#############################################################################
749# load/save perl data associated with player->ob objects 732# load/save perl data associated with player->ob objects
750 733
751sub all_objects(@) { 734sub all_objects(@) {
752 @_, map all_objects ($_->inv), @_ 735 @_, map all_objects ($_->inv), @_
753} 736}
754 737
755# TODO: compatibility cruft, remove when no longer needed 738# TODO: compatibility cruft, remove when no longer needed
756attach_to_players 739cf::player->attach (
757 on_load => sub { 740 on_load => sub {
758 my ($pl, $path) = @_; 741 my ($pl, $path) = @_;
759 742
760 for my $o (all_objects $pl->ob) { 743 for my $o (all_objects $pl->ob) {
761 if (my $value = $o->get_ob_key_value ("_perl_data")) { 744 if (my $value = $o->get_ob_key_value ("_perl_data")) {
763 746
764 %$o = %{ Storable::thaw pack "H*", $value }; 747 %$o = %{ Storable::thaw pack "H*", $value };
765 } 748 }
766 } 749 }
767 }, 750 },
768; 751);
769 752
770############################################################################# 753#############################################################################
771 754
772=head2 CORE EXTENSIONS 755=head2 CORE EXTENSIONS
773 756
774Functions and methods that extend core crossfire objects. 757Functions and methods that extend core crossfire objects.
758
759=head3 cf::player
775 760
776=over 4 761=over 4
777 762
778=item cf::player::exists $login 763=item cf::player::exists $login
779 764
784sub cf::player::exists($) { 769sub cf::player::exists($) {
785 cf::player::find $_[0] 770 cf::player::find $_[0]
786 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;
787} 772}
788 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
789=item $player_object->reply ($npc, $msg[, $flags]) 794=item $player_object->reply ($npc, $msg[, $flags])
790 795
791Sends 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>
792can 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
793dialogue with the given NPC character. 798dialogue with the given NPC character.
794 799
795=cut 800=cut
796 801
797# rough implementation of a future "reply" method that works 802# rough implementation of a future "reply" method that works
798# with dialog boxes. 803# with dialog boxes.
804#TODO: the first argument must go, split into a $npc->reply_to ( method
799sub cf::object::player::reply($$$;$) { 805sub cf::object::player::reply($$$;$) {
800 my ($self, $npc, $msg, $flags) = @_; 806 my ($self, $npc, $msg, $flags) = @_;
801 807
802 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803 809
807 $msg = $npc->name . " says: $msg" if $npc; 813 $msg = $npc->name . " says: $msg" if $npc;
808 $self->message ($msg, $flags); 814 $self->message ($msg, $flags);
809 } 815 }
810} 816}
811 817
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") 818=item $player_object->may ("access")
827 819
828Returns wether the given player is authorized to access resource "access" 820Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast"). 821(e.g. "command_wizcast").
830 822
837 (ref $cf::CFG{"may_$access"} 829 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 830 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"}) 831 : $cf::CFG{"may_$access"})
840} 832}
841 833
842=cut 834=head3 cf::client
843 835
844############################################################################# 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 {
911 my ($self, $cb) = @_;
912
913 my $coro; $coro = async {
914 eval {
915 $cb->();
916 };
917 warn $@ if $@;
918 delete $self->{_coro}{$coro+0};
919 };
920
921 $self->{_coro}{$coro+0} = $coro;
922}
923
924cf::client->attach (
925 on_destroy => sub {
926 my ($ns) = @_;
927
928 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
929 },
930);
931
932=back
933
845 934
846=head2 SAFE SCRIPTING 935=head2 SAFE SCRIPTING
847 936
848Functions that provide a safe environment to compile and execute 937Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server 938snippets of perl code without them endangering the safety of the server
864 953
865=pod 954=pod
866 955
867The following fucntions and emthods are available within a safe environment: 956The following fucntions and emthods are available within a safe environment:
868 957
869 cf::object contr pay_amount pay_player 958 cf::object contr pay_amount pay_player map
870 cf::object::player player 959 cf::object::player player
871 cf::player peaceful 960 cf::player peaceful
961 cf::map trigger
872 962
873=cut 963=cut
874 964
875for ( 965for (
876 ["cf::object" => qw(contr pay_amount pay_player)], 966 ["cf::object" => qw(contr pay_amount pay_player map)],
877 ["cf::object::player" => qw(player)], 967 ["cf::object::player" => qw(player)],
878 ["cf::player" => qw(peaceful)], 968 ["cf::player" => qw(peaceful)],
969 ["cf::map" => qw(trigger)],
879) { 970) {
880 no strict 'refs'; 971 no strict 'refs';
881 my ($pkg, @funs) = @$_; 972 my ($pkg, @funs) = @$_;
882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 973 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883 for @funs; 974 for @funs;
1047 $DB->{$_[0]} = $_[1]; 1138 $DB->{$_[0]} = $_[1];
1048 } 1139 }
1049 db_dirty; 1140 db_dirty;
1050 } 1141 }
1051 1142
1052 attach_global 1143 cf::global->attach (
1053 prio => 10000, 1144 prio => 10000,
1054 on_cleanup => sub { 1145 on_cleanup => sub {
1055 db_sync; 1146 db_sync;
1056 }, 1147 },
1057 ; 1148 );
1058} 1149}
1059 1150
1060############################################################################# 1151#############################################################################
1061# the server's main() 1152# the server's main()
1062 1153
1130 #Symbol::delete_package __PACKAGE__; 1221 #Symbol::delete_package __PACKAGE__;
1131 1222
1132 # reload cf.pm 1223 # reload cf.pm
1133 $msg->("reloading cf.pm"); 1224 $msg->("reloading cf.pm");
1134 require cf; 1225 require cf;
1226 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1227
1135 1228
1136 # load config and database again 1229 # load config and database again
1137 cf::cfg_load; 1230 cf::cfg_load;
1138 cf::db_load; 1231 cf::db_load;
1139 1232
1171}; 1264};
1172 1265
1173unshift @INC, $LIBDIR; 1266unshift @INC, $LIBDIR;
1174 1267
1175$TICK_WATCHER = Event->timer ( 1268$TICK_WATCHER = Event->timer (
1176 prio => 1, 1269 prio => 0,
1177 async => 1,
1178 at => $NEXT_TICK || 1, 1270 at => $NEXT_TICK || 1,
1179 data => WF_AUTOCANCEL, 1271 data => WF_AUTOCANCEL,
1180 cb => sub { 1272 cb => sub {
1181 cf::server_tick; # one server iteration 1273 cf::server_tick; # one server iteration
1182 1274

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines