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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines