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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines