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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines