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.32 by root, Tue Aug 15 18:07:25 2006 UTC vs.
Revision 1.221 by pippijn, Fri Mar 2 13:32:52 2007 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 3.5 ();
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use BDB ();
21use Data::Dumper;
22use Digest::MD5;
23use Fcntl;
24use IO::AIO 2.32 ();
25use YAML::Syck ();
10use Time::HiRes; 26use Time::HiRes;
11use Event; 27use Compress::LZF;
28
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30
12$Event::Eval = 1; # no idea why this is required, but it is 31use Event; $Event::Eval = 1; # no idea why this is required, but it is
13 32
14use strict; 33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15 34
16our %COMMAND; 35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36$YAML::Syck::ImplicitUnicode = 1;
37
38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39
40our %COMMAND = ();
41our %COMMAND_TIME = ();
42
43our @EXTS = (); # list of extension package names
44our %EXTCMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps
47
17our @EVENT; 48our @EVENT;
18our %PROP_TYPE; 49our $LIBDIR = datadir . "/ext";
19our %PROP_IDX; 50
20our $LIBDIR = maps_directory "perl"; 51our $TICK = MAX_TIME * 1e-6;
52our $TICK_WATCHER;
53our $AIO_POLL_WATCHER;
54our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK;
56our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off
58
59our $BDB_POLL_WATCHER;
60our $DB_ENV;
61
62our %CFG;
63
64our $UPTIME; $UPTIME ||= time;
65our $RUNTIME;
66
67our %PLAYER; # all users
68our %MAP; # all maps
69our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75
76# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78
79binmode STDOUT;
80binmode STDERR;
81
82# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime"
85 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.;
87}
88
89mkdir cf::localdir;
90mkdir cf::localdir . "/" . cf::playerdir;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95
96our $EMERGENCY_POSITION;
97
98sub cf::map::normalise;
99
100#############################################################################
101
102=head2 GLOBAL VARIABLES
103
104=over 4
105
106=item $cf::UPTIME
107
108The timestamp of the server start (so not actually an uptime).
109
110=item $cf::RUNTIME
111
112The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick.
114
115=item $cf::LIBDIR
116
117The perl library directory, where extensions and cf-specific modules can
118be found. It will be added to C<@INC> automatically.
119
120=item $cf::NOW
121
122The time of the last (current) server tick.
123
124=item $cf::TICK
125
126The interval between server ticks, in seconds.
127
128=item %cf::CFG
129
130Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to.
132
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
134
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
137processing has been done. Call C<< ->wait >> on them to maximise the
138window of cpu time available, or simply to synchronise to the server tick.
139
140=back
141
142=cut
21 143
22BEGIN { 144BEGIN {
23 @EVENT = map lc, @EVENT;
24
25 *CORE::GLOBAL::warn = sub { 145 *CORE::GLOBAL::warn = sub {
26 my $msg = join "", @_; 146 my $msg = join "", @_;
147 utf8::encode $msg;
148
27 $msg .= "\n" 149 $msg .= "\n"
28 unless $msg =~ /\n$/; 150 unless $msg =~ /\n$/;
29 151
30 print STDERR "cfperl: $msg";
31 LOG llevError, "cfperl: $msg"; 152 LOG llevError, $msg;
32 }; 153 };
33} 154}
34 155
35my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
36 162
37# generate property mutators 163# we bless all objects into (empty) derived classes to force a method lookup
38sub prop_gen { 164# within the Safe compartment.
39 my ($prefix, $class) = @_; 165for my $pkg (qw(
40 166 cf::global cf::attachable
167 cf::object cf::object::player
168 cf::client cf::player
169 cf::arch cf::living
170 cf::map cf::party cf::region
171)) {
41 no strict 'refs'; 172 no strict 'refs';
42
43 for my $prop (keys %PROP_TYPE) {
44 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
45 my $sub = lc $1;
46
47 my $type = $PROP_TYPE{$prop};
48 my $idx = $PROP_IDX {$prop};
49
50 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
51 $_[0]->get_property ($type, $idx)
52 };
53
54 *{"$class\::set_$sub"} = sub {
55 $_[0]->set_property ($type, $idx, $_[1]);
56 } unless $ignore_set{$prop};
57 }
58}
59
60# auto-generate most of the API
61
62prop_gen OBJECT_PROP => "cf::object";
63# CFAPI_OBJECT_ANIMATION?
64prop_gen PLAYER_PROP => "cf::object::player";
65
66prop_gen MAP_PROP => "cf::map";
67prop_gen ARCH_PROP => "cf::arch";
68
69# guessed hierarchies
70
71@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
73
74# we bless all objects into derived classes to force a method lookup
75# within the Safe compartment.
76for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
77 no strict 'refs';
78 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 173 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79} 174}
80 175
81$Event::DIED = sub { 176$Event::DIED = sub {
82 warn "error in event callback: @_"; 177 warn "error in event callback: @_";
83}; 178};
84 179
85my %ext_pkg; 180=head2 UTILITY FUNCTIONS
86my @exts;
87my @hook;
88my %command;
89my %extcmd;
90 181
91sub inject_event { 182=over 4
92 my $extension = shift; 183
184=item dumpval $ref
185
186=cut
187
188sub dumpval {
189 eval {
190 local $SIG{__DIE__};
191 my $d;
192 if (1) {
193 $d = new Data::Dumper([$_[0]], ["*var"]);
194 $d->Terse(1);
195 $d->Indent(2);
196 $d->Quotekeys(0);
197 $d->Useqq(1);
198 #$d->Bless(...);
199 $d->Seen($_[1]) if @_ > 1;
200 $d = $d->Dump();
201 }
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d
204 } || "[unable to dump $_[0]: '$@']";
205}
206
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json
210
211Converts a JSON string into the corresponding perl data structure.
212
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref
221
222Converts a perl data structure into its JSON representation.
223
224=cut
225
226sub to_json($) {
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
228 JSON::Syck::Dump $_[0]
229}
230
231=item cf::lock_wait $string
232
233Wait until the given lock is available. See cf::lock_acquire.
234
235=item my $lock = cf::lock_acquire $string
236
237Wait until the given lock is available and then acquires it and returns
238a Coro::guard object. If the guard object gets destroyed (goes out of scope,
239for example when the coroutine gets canceled), the lock is automatically
240returned.
241
242Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load).
244
245=cut
246
247our %LOCK;
248
249sub lock_wait($) {
250 my ($key) = @_;
251
252 # wait for lock, if any
253 while ($LOCK{$key}) {
254 push @{ $LOCK{$key} }, $Coro::current;
255 Coro::schedule;
256 }
257}
258
259sub lock_acquire($) {
260 my ($key) = @_;
261
262 # wait, to be sure we are not locked
263 lock_wait $key;
264
265 $LOCK{$key} = [];
266
267 Coro::guard {
268 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} };
270 }
271}
272
273sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active;
275
276 my $guard = Coro::guard {
277 $TICK_WATCHER->start;
278 };
279 $TICK_WATCHER->stop;
280 $guard
281}
282
283=item cf::async { BLOCK }
284
285Currently the same as Coro::async_pool, meaning you cannot use
286C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
287thing you are allowed to do is call C<prio> on it.
288
289=cut
290
291BEGIN { *async = \&Coro::async_pool }
292
293=item cf::sync_job { BLOCK }
294
295The design of crossfire+ requires that the main coro ($Coro::main) is
296always able to handle events or runnable, as crossfire+ is only partly
297reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
298
299If it must be done, put the blocking parts into C<sync_job>. This will run
300the given BLOCK in another coroutine while waiting for the result. The
301server will be frozen during this time, so the block should either finish
302fast or be very important.
303
304=cut
305
306sub sync_job(&) {
307 my ($job) = @_;
308
309 if ($Coro::current == $Coro::main) {
310 # this is the main coro, too bad, we have to block
311 # till the operation succeeds, freezing the server :/
312
313 # TODO: use suspend/resume instead
314 # (but this is cancel-safe)
315 my $freeze_guard = freeze_mainloop;
316
317 my $busy = 1;
318 my @res;
319
320 (async {
321 @res = eval { $job->() };
322 warn $@ if $@;
323 undef $busy;
324 })->prio (Coro::PRIO_MAX);
325
326 while ($busy) {
327 Coro::cede or Event::one_event;
328 }
329
330 wantarray ? @res : $res[0]
331 } else {
332 # we are in another coroutine, how wonderful, everything just works
333
334 $job->()
335 }
336}
337
338=item $coro = cf::async_ext { BLOCK }
339
340Like async, but this coro is automatically being canceled when the
341extension calling this is being unloaded.
342
343=cut
344
345sub async_ext(&) {
93 my $event_code = shift; 346 my $cb = shift;
94 347
95 my $cb = $hook[$event_code]{$extension} 348 my $coro = &Coro::async ($cb);
349
350 $coro->on_destroy (sub {
351 delete $EXT_CORO{$coro+0};
352 });
353 $EXT_CORO{$coro+0} = $coro;
354
355 $coro
356}
357
358sub write_runtime {
359 my $guard = cf::lock_acquire "write_runtime";
360
361 my $runtime = cf::localdir . "/runtime";
362
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
96 or return; 364 or return;
97 365
98 &$cb 366 my $value = $cf::RUNTIME + 90 + 10;
99} 367 # 10 is the runtime save interval, for a monotonic clock
368 # 60 allows for the watchdog to kill the server.
100 369
101sub inject_global_event { 370 (aio_write $fh, 0, (length $value), $value, 0) <= 0
371 and return;
372
373 # always fsync - this file is important
374 aio_fsync $fh
375 and return;
376
377 close $fh
378 or return;
379
380 aio_rename "$runtime~", $runtime
381 and return;
382
383 1
384}
385
386=back
387
388=cut
389
390#############################################################################
391
392=head2 ATTACHABLE OBJECTS
393
394Many objects in crossfire are so-called attachable objects. That means you can
395attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods.
397
398In the following description, CLASS can be any of C<global>, C<object>
399C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+).
401
402=over 4
403
404=item $attachable->attach ($attachment, key => $value...)
405
406=item $attachable->detach ($attachment)
407
408Attach/detach a pre-registered attachment to a specific object and give it
409the specified key/value pairs as arguments.
410
411Example, attach a minesweeper attachment to the given object, making it a
41210x10 minesweeper game:
413
414 $obj->attach (minesweeper => width => 10, height => 10);
415
416=item $bool = $attachable->attached ($name)
417
418Checks wether the named attachment is currently attached to the object.
419
420=item cf::CLASS->attach ...
421
422=item cf::CLASS->detach ...
423
424Define an anonymous attachment and attach it to all objects of the given
425CLASS. See the next function for an explanation of its arguments.
426
427You can attach to global events by using the C<cf::global> class.
428
429Example, log all player logins:
430
431 cf::player->attach (
432 on_login => sub {
433 my ($pl) = @_;
434 ...
435 },
436 );
437
438Example, attach to the jeweler skill:
439
440 cf::object->attach (
441 type => cf::SKILL,
442 subtype => cf::SK_JEWELER,
443 on_use_skill => sub {
444 my ($sk, $ob, $part, $dir, $msg) = @_;
445 ...
446 },
447 );
448
449=item cf::CLASS::attachment $name, ...
450
451Register an attachment by C<$name> through which attachable objects of the
452given CLASS can refer to this attachment.
453
454Some classes such as crossfire maps and objects can specify attachments
455that are attached at load/instantiate time, thus the need for a name.
456
457These calls expect any number of the following handler/hook descriptions:
458
459=over 4
460
461=item prio => $number
462
463Set the priority for all following handlers/hooks (unless overwritten
464by another C<prio> setting). Lower priority handlers get executed
465earlier. The default priority is C<0>, and many built-in handlers are
466registered at priority C<-1000>, so lower priorities should not be used
467unless you know what you are doing.
468
469=item type => $type
470
471(Only for C<< cf::object->attach >> calls), limits the attachment to the
472given type of objects only (the additional parameter C<subtype> can be
473used to further limit to the given subtype).
474
475=item on_I<event> => \&cb
476
477Call the given code reference whenever the named event happens (event is
478something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
479handlers are recognised generally depends on the type of object these
480handlers attach to).
481
482See F<include/eventinc.h> for the full list of events supported, and their
483class.
484
485=item package => package::
486
487Look for sub functions of the name C<< on_I<event> >> in the given
488package and register them. Only handlers for eevents supported by the
489object/class are recognised.
490
491=back
492
493Example, define an attachment called "sockpuppet" that calls the given
494event handler when a monster attacks:
495
496 cf::object::attachment sockpuppet =>
497 on_skill_attack => sub {
498 my ($self, $victim) = @_;
499 ...
500 }
501 }
502
503=item $attachable->valid
504
505Just because you have a perl object does not mean that the corresponding
506C-level object still exists. If you try to access an object that has no
507valid C counterpart anymore you get an exception at runtime. This method
508can be used to test for existence of the C object part without causing an
509exception.
510
511=cut
512
513# the following variables are defined in .xs and must not be re-created
514our @CB_GLOBAL = (); # registry for all global events
515our @CB_ATTACHABLE = (); # registry for all attachables
516our @CB_OBJECT = (); # all objects (should not be used except in emergency)
517our @CB_PLAYER = ();
518our @CB_CLIENT = ();
519our @CB_TYPE = (); # registry for type (cf-object class) based events
520our @CB_MAP = ();
521
522my %attachment;
523
524sub cf::attachable::thawer_merge {
525 # simply override everything except _meta
526 local $_[0]{_meta};
527 %{$_[0]} = %{$_[1]};
528}
529
530sub _attach_cb($$$$) {
531 my ($registry, $event, $prio, $cb) = @_;
532
533 use sort 'stable';
534
535 $cb = [$prio, $cb];
536
537 @{$registry->[$event]} = sort
538 { $a->[0] cmp $b->[0] }
539 @{$registry->[$event] || []}, $cb;
540}
541
542# hack
543my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
544
545# attach handles attaching event callbacks
546# the only thing the caller has to do is pass the correct
547# registry (== where the callback attaches to).
548sub _attach {
549 my ($registry, $klass, @arg) = @_;
550
551 my $object_type;
552 my $prio = 0;
553 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
554
555 #TODO: get rid of this hack
556 if ($attachable_klass{$klass}) {
557 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
558 }
559
560 while (@arg) {
561 my $type = shift @arg;
562
563 if ($type eq "prio") {
564 $prio = shift @arg;
565
566 } elsif ($type eq "type") {
567 $object_type = shift @arg;
568 $registry = $CB_TYPE[$object_type] ||= [];
569
570 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
574
575 } elsif ($type eq "package") {
576 my $pkg = shift @arg;
577
578 while (my ($name, $id) = each %cb_id) {
579 if (my $cb = $pkg->can ($name)) {
580 _attach_cb $registry, $id, $prio, $cb;
581 }
582 }
583
584 } elsif (exists $cb_id{$type}) {
585 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
586
587 } elsif (ref $type) {
588 warn "attaching objects not supported, ignoring.\n";
589
590 } else {
591 shift @arg;
592 warn "attach argument '$type' not supported, ignoring.\n";
593 }
594 }
595}
596
597sub _object_attach {
598 my ($obj, $name, %arg) = @_;
599
600 return if exists $obj->{_attachment}{$name};
601
602 if (my $attach = $attachment{$name}) {
603 my $registry = $obj->registry;
604
605 for (@$attach) {
606 my ($klass, @attach) = @$_;
607 _attach $registry, $klass, @attach;
608 }
609
610 $obj->{$name} = \%arg;
611 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n";
613 }
614
615 $obj->{_attachment}{$name} = undef;
616}
617
618sub cf::attachable::attach {
619 if (ref $_[0]) {
620 _object_attach @_;
621 } else {
622 _attach shift->_attach_registry, @_;
623 }
624};
625
626# all those should be optimised
627sub cf::attachable::detach {
628 my ($obj, $name) = @_;
629
630 if (ref $obj) {
631 delete $obj->{_attachment}{$name};
632 reattach ($obj);
633 } else {
634 Carp::croak "cannot, currently, detach class attachments";
635 }
636};
637
638sub cf::attachable::attached {
639 my ($obj, $name) = @_;
640
641 exists $obj->{_attachment}{$name}
642}
643
644for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
645 eval "#line " . __LINE__ . " 'cf.pm'
646 sub cf::\L$klass\E::_attach_registry {
647 (\\\@CB_$klass, KLASS_$klass)
648 }
649
650 sub cf::\L$klass\E::attachment {
651 my \$name = shift;
652
653 \$attachment{\$name} = [[KLASS_$klass, \@_]];
654 }
655 ";
656 die if $@;
657}
658
659our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661
662sub override {
663 $override = 1;
664 @invoke_results = ();
665}
666
667sub do_invoke {
102 my $event = shift; 668 my $event = shift;
669 my $callbacks = shift;
103 670
104 my $cb = $hook[$event] 671 @invoke_results = ();
672
673 local $override;
674
675 for (@$callbacks) {
676 eval { &{$_->[1]} };
677
678 if ($@) {
679 warn "$@";
680 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
681 override;
682 }
683
684 return 1 if $override;
685 }
686
687 0
688}
689
690=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
691
692=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
693
694Generate an object-specific event with the given arguments.
695
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly).
699
700=back
701
702=cut
703
704#############################################################################
705# object support
706
707sub reattach {
708 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_;
710
711 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
712
713 my $registry = $obj->registry;
714
715 @$registry = ();
716
717 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
718
719 for my $name (keys %{ $obj->{_attachment} || {} }) {
720 if (my $attach = $attachment{$name}) {
721 for (@$attach) {
722 my ($klass, @attach) = @$_;
723 _attach $registry, $klass, @attach;
724 }
725 } else {
726 warn "object uses attachment '$name' that is not available, postponing.\n";
727 }
728 }
729}
730
731cf::attachable->attach (
732 prio => -1000000,
733 on_instantiate => sub {
734 my ($obj, $data) = @_;
735
736 $data = from_json $data;
737
738 for (@$data) {
739 my ($name, $args) = @$_;
740
741 $obj->attach ($name, %{$args || {} });
742 }
743 },
744 on_reattach => \&reattach,
745 on_clone => sub {
746 my ($src, $dst) = @_;
747
748 @{$dst->registry} = @{$src->registry};
749
750 %$dst = %$src;
751
752 %{$dst->{_attachment}} = %{$src->{_attachment}}
753 if exists $src->{_attachment};
754 },
755);
756
757sub object_freezer_save {
758 my ($filename, $rdata, $objs) = @_;
759
760 sync_job {
761 if (length $$rdata) {
762 warn sprintf "saving %s (%d,%d)\n",
763 $filename, length $$rdata, scalar @$objs;
764
765 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
766 chmod SAVE_MODE, $fh;
767 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
768 aio_fsync $fh if $cf::USE_FSYNC;
769 close $fh;
770
771 if (@$objs) {
772 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
773 chmod SAVE_MODE, $fh;
774 my $data = Storable::nfreeze { version => 1, objs => $objs };
775 aio_write $fh, 0, (length $data), $data, 0;
776 aio_fsync $fh if $cf::USE_FSYNC;
777 close $fh;
778 aio_rename "$filename.pst~", "$filename.pst";
779 }
780 } else {
781 aio_unlink "$filename.pst";
782 }
783
784 aio_rename "$filename~", $filename;
785 } else {
786 warn "FATAL: $filename~: $!\n";
787 }
788 } else {
789 aio_unlink $filename;
790 aio_unlink "$filename.pst";
791 }
792 }
793}
794
795sub object_freezer_as_string {
796 my ($rdata, $objs) = @_;
797
798 use Data::Dumper;
799
800 $$rdata . Dumper $objs
801}
802
803sub object_thawer_load {
804 my ($filename) = @_;
805
806 my ($data, $av);
807
808 (aio_load $filename, $data) >= 0
105 or return; 809 or return;
106 810
107 List::Util::max map &$_, values %$cb 811 unless (aio_stat "$filename.pst") {
108} 812 (aio_load "$filename.pst", $av) >= 0
109 813 or return;
110sub inject_command { 814 $av = eval { (Storable::thaw $av)->{objs} };
111 my ($name, $obj, $params) = @_;
112
113 for my $cmd (@{ $command{$name} }) {
114 $cmd->[1]->($obj, $params);
115 } 815 }
116 816
117 -1 817 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d#
819 return ($data, $av);
118} 820}
821
822#############################################################################
823# command handling &c
824
825=item cf::register_command $name => \&callback($ob,$args);
826
827Register a callback for execution when the client sends the user command
828$name.
829
830=cut
119 831
120sub register_command { 832sub register_command {
121 my ($name, $time, $cb) = @_; 833 my ($name, $cb) = @_;
122 834
123 my $caller = caller; 835 my $caller = caller;
124 #warn "registering command '$name/$time' to '$caller'"; 836 #warn "registering command '$name/$time' to '$caller'";
125 837
126 push @{ $command{$name} }, [$time, $cb, $caller]; 838 push @{ $COMMAND{$name} }, [$caller, $cb];
127 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
128} 839}
840
841=item cf::register_extcmd $name => \&callback($pl,$packet);
842
843Register a callbackf ro execution when the client sends an extcmd packet.
844
845If the callback returns something, it is sent back as if reply was being
846called.
847
848=cut
129 849
130sub register_extcmd { 850sub register_extcmd {
131 my ($name, $cb) = @_; 851 my ($name, $cb) = @_;
132 852
133 my $caller = caller; 853 $EXTCMD{$name} = $cb;
134 #warn "registering extcmd '$name' to '$caller'";
135
136 $extcmd{$name} = [$cb, $caller];
137} 854}
138 855
139sub register { 856cf::player->attach (
140 my ($base, $pkg) = @_; 857 on_command => sub {
858 my ($pl, $name, $params) = @_;
141 859
142 for my $idx (0 .. $#EVENT) { 860 my $cb = $COMMAND{$name}
143 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { 861 or return;
144 #warn "registering $EVENT[$idx] hook to '$pkg'\n"; 862
145 $hook[$idx]{$base} = $ref; 863 for my $cmd (@$cb) {
864 $cmd->[1]->($pl->ob, $params);
146 } 865 }
866
867 cf::override;
147 } 868 },
148} 869 on_extcmd => sub {
870 my ($pl, $buf) = @_;
871
872 my $msg = eval { from_json $buf };
873
874 if (ref $msg) {
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876 if (my %reply = $cb->($pl, $msg)) {
877 $pl->ext_reply ($msg->{msgid}, %reply);
878 }
879 }
880 } else {
881 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882 }
883
884 cf::override;
885 },
886);
149 887
150sub load_extension { 888sub load_extension {
151 my ($path) = @_; 889 my ($path) = @_;
152 890
153 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
154 my $base = $1; 892 my $base = $1;
155 my $pkg = $1; 893 my $pkg = $1;
156 $pkg =~ s/[^[:word:]]/_/g; 894 $pkg =~ s/[^[:word:]]/_/g;
157 $pkg = "cf::ext::$pkg"; 895 $pkg = "ext::$pkg";
158 896
159 warn "loading '$path' into '$pkg'\n"; 897 warn "... loading '$path' into '$pkg'\n";
160 898
161 open my $fh, "<:utf8", $path 899 open my $fh, "<:utf8", $path
162 or die "$path: $!"; 900 or die "$path: $!";
163 901
164 my $source = 902 my $source =
165 "package $pkg; use strict; use utf8;\n" 903 "package $pkg; use strict; use utf8;\n"
166 . "#line 1 \"$path\"\n{\n" 904 . "#line 1 \"$path\"\n{\n"
167 . (do { local $/; <$fh> }) 905 . (do { local $/; <$fh> })
168 . "\n};\n1"; 906 . "\n};\n1";
169 907
170 eval $source 908 unless (eval $source) {
171 or die "$path: $@"; 909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 }
916 die $@;
917 }
172 918
173 push @exts, $pkg; 919 push @EXTS, $pkg;
174 $ext_pkg{$base} = $pkg;
175
176# no strict 'refs';
177# @{"$pkg\::ISA"} = ext::;
178
179 register $base, $pkg;
180}
181
182sub unload_extension {
183 my ($pkg) = @_;
184
185 warn "removing extension $pkg\n";
186
187 # remove hooks
188 for my $idx (0 .. $#EVENT) {
189 delete $hook[$idx]{$pkg};
190 }
191
192 # remove commands
193 for my $name (keys %command) {
194 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
195
196 if (@cb) {
197 $command{$name} = \@cb;
198 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
199 } else {
200 delete $command{$name};
201 delete $COMMAND{"$name\000"};
202 }
203 }
204
205 # remove extcmds
206 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
207 delete $extcmd{$name};
208 }
209
210 if (my $cb = $pkg->can ("on_unload")) {
211 eval {
212 $cb->($pkg);
213 1
214 } or warn "$pkg unloaded, but with errors: $@";
215 }
216
217 Symbol::delete_package $pkg;
218} 920}
219 921
220sub load_extensions { 922sub load_extensions {
221 my $LIBDIR = maps_directory "perl";
222
223 for my $ext (<$LIBDIR/*.ext>) { 923 for my $ext (<$LIBDIR/*.ext>) {
224 next unless -r $ext; 924 next unless -r $ext;
225 eval { 925 eval {
226 load_extension $ext; 926 load_extension $ext;
227 1 927 1
228 } or warn "$ext not loaded: $@"; 928 } or warn "$ext not loaded: $@";
229 } 929 }
230} 930}
231 931
232register_command "perl-reload", 0, sub { 932#############################################################################
933
934=head2 CORE EXTENSIONS
935
936Functions and methods that extend core crossfire objects.
937
938=cut
939
940package cf::player;
941
942use Coro::AIO;
943
944=head3 cf::player
945
946=over 4
947
948=item cf::player::find $login
949
950Returns the given player object, loading it if necessary (might block).
951
952=cut
953
954sub playerdir($) {
955 cf::localdir
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960}
961
962sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964
965 (playerdir $login) . "/$login.pl"
966}
967
968sub find_active($) {
969 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active
971 and $cf::PLAYER{$_[0]}
972}
973
974sub exists($) {
975 my ($login) = @_;
976
977 $cf::PLAYER{$login}
978 or cf::sync_job { !aio_stat path $login }
979}
980
981sub find($) {
982 return $cf::PLAYER{$_[0]} || do {
983 my $login = $_[0];
984
985 my $guard = cf::lock_acquire "user_find:$login";
986
987 $cf::PLAYER{$_[0]} || do {
988 my $pl = load_pl path $login
989 or return;
990 $cf::PLAYER{$login} = $pl
991 }
992 }
993}
994
995sub save($) {
996 my ($pl) = @_;
997
998 return if $pl->{deny_save};
999
1000 my $path = path $pl;
1001 my $guard = cf::lock_acquire "user_save:$path";
1002
1003 return if $pl->{deny_save};
1004
1005 aio_mkdir playerdir $pl, 0770;
1006 $pl->{last_save} = $cf::RUNTIME;
1007
1008 $pl->save_pl ($path);
1009 Coro::cede;
1010}
1011
1012sub new($) {
1013 my ($login) = @_;
1014
1015 my $self = create;
1016
1017 $self->ob->name ($login);
1018 $self->{deny_save} = 1;
1019
1020 $cf::PLAYER{$login} = $self;
1021
1022 $self
1023}
1024
1025=item $pl->quit_character
1026
1027Nukes the player without looking back. If logged in, the connection will
1028be destroyed. May block for a long time.
1029
1030=cut
1031
1032sub quit_character {
1033 my ($pl) = @_;
1034
1035 my $name = $pl->ob->name;
1036
1037 $pl->{deny_save} = 1;
1038 $pl->password ("*"); # this should lock out the player until we nuked the dir
1039
1040 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1041 $pl->deactivate;
1042 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1043 $pl->ns->destroy if $pl->ns;
1044
1045 my $path = playerdir $pl;
1046 my $temp = "$path~$cf::RUNTIME~deleting~";
1047 aio_rename $path, $temp;
1048 delete $cf::PLAYER{$pl->ob->name};
1049 $pl->destroy;
1050
1051 my $prefix = qr<^~\Q$name\E/>;
1052
1053 # nuke player maps
1054 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1055
1056 IO::AIO::aio_rmtree $temp;
1057}
1058
1059=item $pl->kick
1060
1061Kicks a player out of the game. This destroys the connection.
1062
1063=cut
1064
1065sub kick {
1066 my ($pl, $kicker) = @_;
1067
1068 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1069 $pl->killer ("kicked");
1070 $pl->ns->destroy;
1071}
1072
1073=item cf::player::list_logins
1074
1075Returns am arrayref of all valid playernames in the system, can take a
1076while and may block, so not sync_job-capable, ever.
1077
1078=cut
1079
1080sub list_logins {
1081 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1082 or return [];
1083
1084 my @logins;
1085
1086 for my $login (@$dirs) {
1087 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1088 aio_read $fh, 0, 512, my $buf, 0 or next;
1089 $buf !~ /^password -------------$/m or next; # official not-valid tag
1090
1091 utf8::decode $login;
1092 push @logins, $login;
1093 }
1094
1095 \@logins
1096}
1097
1098=item $player->maps
1099
1100Returns an arrayref of map paths that are private for this
1101player. May block.
1102
1103=cut
1104
1105sub maps($) {
1106 my ($pl) = @_;
1107
1108 $pl = ref $pl ? $pl->ob->name : $pl;
1109
1110 my $files = aio_readdir playerdir $pl
1111 or return;
1112
1113 my @paths;
1114
1115 for (@$files) {
1116 utf8::decode $_;
1117 next if /\.(?:pl|pst)$/;
1118 next unless /^$PATH_SEP/o;
1119
1120 push @paths, cf::map::normalise "~$pl/$_";
1121 }
1122
1123 \@paths
1124}
1125
1126=item $player->ext_reply ($msgid, $msgtype, %msg)
1127
1128Sends an ext reply to the player.
1129
1130=cut
1131
1132sub ext_reply($$$%) {
1133 my ($self, $id, %msg) = @_;
1134
1135 $msg{msgid} = $id;
1136
1137 $self->send ("ext " . cf::to_json \%msg);
1138}
1139
1140package cf;
1141
1142=back
1143
1144
1145=head3 cf::map
1146
1147=over 4
1148
1149=cut
1150
1151package cf::map;
1152
1153use Fcntl;
1154use Coro::AIO;
1155
1156use overload
1157 '""' => \&as_string,
1158 fallback => 1;
1159
1160our $MAX_RESET = 3600;
1161our $DEFAULT_RESET = 3000;
1162
1163sub generate_random_map {
1164 my ($self, $rmp) = @_;
1165 # mit "rum" bekleckern, nicht
1166 $self->_create_random_map (
1167 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1168 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1169 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1170 $rmp->{exit_on_final_map},
1171 $rmp->{xsize}, $rmp->{ysize},
1172 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1173 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1174 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1175 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1176 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1177 (cf::region::find $rmp->{region}), $rmp->{custom}
1178 )
1179}
1180
1181=item cf::map->register ($regex, $prio)
1182
1183Register a handler for the map path matching the given regex at the
1184givne priority (higher is better, built-in handlers have priority 0, the
1185default).
1186
1187=cut
1188
1189sub register {
1190 my (undef, $regex, $prio) = @_;
1191 my $pkg = caller;
1192
1193 no strict;
1194 push @{"$pkg\::ISA"}, __PACKAGE__;
1195
1196 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1197}
1198
1199# also paths starting with '/'
1200$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1201
1202sub thawer_merge {
1203 my ($self, $merge) = @_;
1204
1205 # we have to keep some variables in memory intact
1206 local $self->{path};
1207 local $self->{load_path};
1208 local $self->{deny_save};
1209 local $self->{deny_reset};
1210
1211 $self->SUPER::thawer_merge ($merge);
1212}
1213
1214sub normalise {
233 my ($who, $arg) = @_; 1215 my ($path, $base) = @_;
234 1216
235 if ($who->flag (FLAG_WIZ)) { 1217 $path = "$path"; # make sure its a string
236 $who->message ("reloading...");
237 1218
238 warn "reloading...\n"; 1219 $path =~ s/\.map$//;
239 eval {
240 # 1. cancel all watchers
241 $_->cancel for Event::all_watchers;
242 1220
243 # 2. unload all extensions 1221 # map plan:
1222 #
1223 # /! non-realised random map exit (special hack!)
1224 # {... are special paths that are not being touched
1225 # ?xxx/... are special absolute paths
1226 # ?random/... random maps
1227 # /... normal maps
1228 # ~user/... per-player map of a specific user
1229
1230 $path =~ s/$PATH_SEP/\//go;
1231
1232 # treat it as relative path if it starts with
1233 # something that looks reasonable
1234 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1235 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1236
1237 $base =~ s{[^/]+/?$}{};
1238 $path = "$base/$path";
1239 }
1240
1241 for ($path) {
1242 redo if s{//}{/};
1243 redo if s{/\.?/}{/};
1244 redo if s{/[^/]+/\.\./}{/};
1245 }
1246
1247 $path
1248}
1249
1250sub new_from_path {
1251 my (undef, $path, $base) = @_;
1252
1253 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1254
1255 $path = normalise $path, $base;
1256
1257 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1258 if ($path =~ $EXT_MAP{$pkg}[1]) {
1259 my $self = bless cf::map::new, $pkg;
1260 $self->{path} = $path; $self->path ($path);
1261 $self->init; # pass $1 etc.
1262 return $self;
1263 }
1264 }
1265
1266 Carp::carp "unable to resolve path '$path' (base '$base').";
1267 ()
1268}
1269
1270sub init {
1271 my ($self) = @_;
1272
1273 $self
1274}
1275
1276sub as_string {
1277 my ($self) = @_;
1278
1279 "$self->{path}"
1280}
1281
1282# the displayed name, this is a one way mapping
1283sub visible_name {
1284 &as_string
1285}
1286
1287# the original (read-only) location
1288sub load_path {
1289 my ($self) = @_;
1290
1291 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
1292}
1293
1294# the temporary/swap location
1295sub save_path {
1296 my ($self) = @_;
1297
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
1300}
1301
1302# the unique path, undef == no special unique path
1303sub uniq_path {
1304 my ($self) = @_;
1305
1306 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1307 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1308}
1309
1310# and all this just because we cannot iterate over
1311# all maps in C++...
1312sub change_all_map_light {
1313 my ($change) = @_;
1314
1315 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP;
1317}
1318
1319sub unlink_save {
1320 my ($self) = @_;
1321
1322 utf8::encode (my $save = $self->save_path);
1323 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1324 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1325}
1326
1327sub load_header_from($) {
1328 my ($self, $path) = @_;
1329
1330 utf8::encode $path;
1331 #aio_open $path, O_RDONLY, 0
1332 # or return;
1333
1334 $self->_load_header ($path)
1335 or return;
1336
1337 $self->{load_path} = $path;
1338
1339 1
1340}
1341
1342sub load_header_orig {
1343 my ($self) = @_;
1344
1345 $self->load_header_from ($self->load_path)
1346}
1347
1348sub load_header_temp {
1349 my ($self) = @_;
1350
1351 $self->load_header_from ($self->save_path)
1352}
1353
1354sub prepare_temp {
1355 my ($self) = @_;
1356
1357 $self->last_access ((delete $self->{last_access})
1358 || $cf::RUNTIME); #d#
1359 # safety
1360 $self->{instantiate_time} = $cf::RUNTIME
1361 if $self->{instantiate_time} > $cf::RUNTIME;
1362}
1363
1364sub prepare_orig {
1365 my ($self) = @_;
1366
1367 $self->{load_original} = 1;
1368 $self->{instantiate_time} = $cf::RUNTIME;
1369 $self->last_access ($cf::RUNTIME);
1370 $self->instantiate;
1371}
1372
1373sub load_header {
1374 my ($self) = @_;
1375
1376 if ($self->load_header_temp) {
1377 $self->prepare_temp;
1378 } else {
1379 $self->load_header_orig
1380 or return;
1381 $self->prepare_orig;
1382 }
1383
1384 1
1385}
1386
1387sub find;
1388sub find {
1389 my ($path, $origin) = @_;
1390
1391 $path = normalise $path, $origin && $origin->path;
1392
1393 cf::lock_wait "map_find:$path";
1394
1395 $cf::MAP{$path} || do {
1396 my $guard = cf::lock_acquire "map_find:$path";
1397 my $map = new_from_path cf::map $path
1398 or return;
1399
1400 $map->{last_save} = $cf::RUNTIME;
1401
1402 $map->load_header
1403 or return;
1404
1405 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1406 # doing this can freeze the server in a sync job, obviously
1407 #$cf::WAIT_FOR_TICK->wait;
1408 $map->reset;
1409 undef $guard;
1410 return find $path;
1411 }
1412
1413 $cf::MAP{$path} = $map
1414 }
1415}
1416
1417sub pre_load { }
1418sub post_load { }
1419
1420sub load {
1421 my ($self) = @_;
1422
1423 local $self->{deny_reset} = 1; # loading can take a long time
1424
1425 my $path = $self->{path};
1426 my $guard = cf::lock_acquire "map_load:$path";
1427
1428 return if $self->in_memory != cf::MAP_SWAPPED;
1429
1430 $self->in_memory (cf::MAP_LOADING);
1431
1432 $self->alloc;
1433
1434 $self->pre_load;
1435
1436 $self->_load_objects ($self->{load_path}, 1)
1437 or return;
1438
1439 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1440 if delete $self->{load_original};
1441
1442 if (my $uniq = $self->uniq_path) {
1443 utf8::encode $uniq;
1444 if (aio_open $uniq, O_RDONLY, 0) {
1445 $self->clear_unique_items;
1446 $self->_load_objects ($uniq, 0);
1447 }
1448 }
1449
1450 Coro::cede;
1451
1452 # now do the right thing for maps
1453 $self->link_multipart_objects;
1454
1455 unless ($self->{deny_activate}) {
1456 $self->decay_objects;
1457 $self->fix_auto_apply;
1458 $self->update_buttons;
1459 Coro::cede;
1460 $self->set_darkness_map;
1461 $self->difficulty ($self->estimate_difficulty)
1462 unless $self->difficulty;
1463 Coro::cede;
1464 $self->activate;
1465 }
1466
1467 $self->post_load;
1468
1469 $self->in_memory (cf::MAP_IN_MEMORY);
1470}
1471
1472sub customise_for {
1473 my ($self, $ob) = @_;
1474
1475 return find "~" . $ob->name . "/" . $self->{path}
1476 if $self->per_player;
1477
1478 $self
1479}
1480
1481# find and load all maps in the 3x3 area around a map
1482sub load_diag {
1483 my ($map) = @_;
1484
1485 my @diag; # diagonal neighbours
1486
1487 for (0 .. 3) {
1488 my $neigh = $map->tile_path ($_)
244 for (@exts) { 1489 or next;
245 $who->message ("unloading <$_>"); 1490 $neigh = find $neigh, $map
246 unload_extension $_; 1491 or next;
1492 $neigh->load;
1493
1494 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1495 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1496 }
1497
1498 for (@diag) {
1499 my $neigh = find @$_
1500 or next;
1501 $neigh->load;
1502 }
1503}
1504
1505sub find_sync {
1506 my ($path, $origin) = @_;
1507
1508 cf::sync_job { find $path, $origin }
1509}
1510
1511sub do_load_sync {
1512 my ($map) = @_;
1513
1514 cf::sync_job { $map->load };
1515}
1516
1517our %MAP_PREFETCH;
1518our $MAP_PREFETCHER = undef;
1519
1520sub find_async {
1521 my ($path, $origin) = @_;
1522
1523 $path = normalise $path, $origin && $origin->{path};
1524
1525 if (my $map = $cf::MAP{$path}) {
1526 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1527 }
1528
1529 undef $MAP_PREFETCH{$path};
1530 $MAP_PREFETCHER ||= cf::async {
1531 while (%MAP_PREFETCH) {
1532 for my $path (keys %MAP_PREFETCH) {
1533 my $map = find $path
1534 or next;
1535 $map->load;
1536
1537 delete $MAP_PREFETCH{$path};
247 } 1538 }
248
249 # 3. unload all modules loaded from $LIBDIR
250 while (my ($k, $v) = each %INC) {
251 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
252
253 $who->message ("removing <$k>");
254 delete $INC{$k};
255
256 $k =~ s/\.pm$//;
257 $k =~ s/\//::/g;
258
259 if (my $cb = $k->can ("unload_module")) {
260 $cb->();
261 }
262
263 Symbol::delete_package $k;
264 }
265
266 # 4. get rid of ext::, as good as possible
267 Symbol::delete_package "ext::$_"
268 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
269
270 # 5. remove register_script_function callbacks
271 # TODO
272
273 # 6. unload cf.pm "a bit"
274 delete $INC{"cf.pm"};
275
276 # don't, removes xs symbols, too
277 #Symbol::delete_package __PACKAGE__;
278
279 # 7. reload cf.pm
280 $who->message ("reloading cf.pm");
281 require cf;
282 }; 1539 }
283 warn $@ if $@; 1540 undef $MAP_PREFETCHER;
284 $who->message ($@) if $@; 1541 };
285 warn "reloaded\n"; 1542 $MAP_PREFETCHER->prio (6);
286 1543
287 $who->message ("reloaded"); 1544 ()
1545}
1546
1547sub save {
1548 my ($self) = @_;
1549
1550 my $lock = cf::lock_acquire "map_data:" . $self->path;
1551
1552 $self->{last_save} = $cf::RUNTIME;
1553
1554 return unless $self->dirty;
1555
1556 my $save = $self->save_path; utf8::encode $save;
1557 my $uniq = $self->uniq_path; utf8::encode $uniq;
1558
1559 $self->{load_path} = $save;
1560
1561 return if $self->{deny_save};
1562
1563 local $self->{last_access} = $self->last_access;#d#
1564
1565 cf::async {
1566 $_->contr->save for $self->players;
1567 };
1568
1569 if ($uniq) {
1570 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1571 $self->_save_objects ($uniq, cf::IO_UNIQUES);
288 } else { 1572 } else {
289 $who->message ("Intruder Alert!"); 1573 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
290 }
291};
292
293#############################################################################
294# utility functions
295
296use JSON::Syck (); # TODO# replace by JSON::PC once working
297
298sub from_json($) {
299 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
300 JSON::Syck::Load $_[0]
301}
302
303sub to_json($) {
304 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
305 JSON::Syck::Dump $_[0]
306}
307
308#############################################################################
309# extcmd framework, basically convert ext <msg>
310# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
311
312sub on_extcmd {
313 my ($pl, $buf) = @_;
314
315 my $msg = eval { from_json $buf };
316
317 if (ref $msg) {
318 if (my $cb = $extcmd{$msg->{msgtype}}) {
319 if (my %reply = $cb->[0]->($pl, $msg)) {
320 $pl->ext_reply ($msg->{msgid}, %reply);
321 }
322 }
323 } else {
324 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
325 }
326
327 1 1574 }
328} 1575}
329 1576
330############################################################################# 1577sub swap_out {
331# load/save/clean perl data associated with a map
332
333*on_mapclean = sub {
334 my ($map) = @_; 1578 my ($self) = @_;
335 1579
336 my $path = $map->tmpname; 1580 # save first because save cedes
337 defined $path or return; 1581 $self->save;
338 1582
339 unlink "$path.cfperl"; 1583 my $lock = cf::lock_acquire "map_data:" . $self->path;
340};
341 1584
342*on_mapin = 1585 return if $self->players;
343*on_mapload = sub { 1586 return if $self->in_memory != cf::MAP_IN_MEMORY;
1587 return if $self->{deny_save};
1588
1589 $self->clear;
1590 $self->in_memory (cf::MAP_SWAPPED);
1591}
1592
1593sub reset_at {
344 my ($map) = @_; 1594 my ($self) = @_;
345 1595
346 my $path = $map->tmpname; 1596 # TODO: safety, remove and allow resettable per-player maps
347 $path = $map->path unless defined $path; 1597 return 1e99 if $self->isa ("ext::map_per_player");#d#
1598 return 1e99 if $self->{deny_reset};
348 1599
349 open my $fh, "<:raw", "$path.cfperl" 1600 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
350 or return; # no perl data 1601 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
351 1602
352 my $data = Storable::thaw do { local $/; <$fh> }; 1603 $time + $to
1604}
353 1605
354 $data->{version} <= 1 1606sub should_reset {
355 or return; # too new
356
357 $map->_set_obs ($data->{obs});
358};
359
360*on_mapout = sub {
361 my ($map) = @_; 1607 my ($self) = @_;
362 1608
363 my $path = $map->tmpname; 1609 $self->reset_at <= $cf::RUNTIME
364 $path = $map->path unless defined $path;
365
366 my $obs = $map->_get_obs;
367
368 if (defined $obs) {
369 open my $fh, ">:raw", "$path.cfperl"
370 or die "$path.cfperl: $!";
371
372 stat $path;
373
374 print $fh Storable::nfreeze {
375 size => (stat _)[7],
376 time => (stat _)[9],
377 version => 1,
378 obs => $obs,
379 };
380
381 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
382 } else {
383 unlink "$path.cfperl";
384 }
385};
386
387#############################################################################
388# load/save perl data associated with player->ob objects
389
390*on_player_load = sub {
391 my ($ob, $path) = @_;
392
393 for my $o ($ob, $ob->inv) {
394 if (my $value = $o->get_ob_key_value ("_perl_data")) {
395 $o->set_ob_key_value ("_perl_data");
396
397 %$o = %{ Storable::thaw pack "H*", $value };
398 }
399 }
400};
401
402*on_player_save = sub {
403 my ($ob, $path) = @_;
404
405 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
406 for grep %$_, $ob, $ob->inv;
407};
408
409#############################################################################
410# core extensions - in perl
411
412my $delta_timer = Event->timer (
413 parked => 1,
414 prio => Event::PRIO_HIGH,
415 cb => sub { Event::unloop (undef) },
416);
417
418sub sleep_delta($) {
419 $delta_timer->at (Event::time + $_[0]);
420 $delta_timer->start;
421 Event::loop;
422} 1610}
423 1611
424=item cf::player::exists $login 1612sub reset {
1613 my ($self) = @_;
425 1614
426Returns true when the given account exists. 1615 my $lock = cf::lock_acquire "map_data:$self->{path}";
427 1616
428=cut 1617 return if $self->players;
1618 return if $self->isa ("ext::map_per_player");#d#
429 1619
430sub cf::player::exists($) { 1620 warn "resetting map ", $self->path;#d#
431 cf::player::find $_[0]
432 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
433}
434 1621
1622 $self->in_memory (cf::MAP_SWAPPED);
1623
1624 # need to save uniques path
1625 unless ($self->{deny_save}) {
1626 my $uniq = $self->uniq_path; utf8::encode $uniq;
1627
1628 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1629 if $uniq;
1630 }
1631
1632 delete $cf::MAP{$self->path};
1633
1634 $self->clear;
1635
1636 $_->clear_links_to ($self) for values %cf::MAP;
1637
1638 $self->unlink_save;
1639 $self->destroy;
1640}
1641
1642my $nuke_counter = "aaaa";
1643
1644sub nuke {
1645 my ($self) = @_;
1646
1647 delete $cf::MAP{$self->path};
1648
1649 $self->unlink_save;
1650
1651 bless $self, "cf::map";
1652 delete $self->{deny_reset};
1653 $self->{deny_save} = 1;
1654 $self->reset_timeout (1);
1655 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1656
1657 $cf::MAP{$self->path} = $self;
1658
1659 $self->reset; # polite request, might not happen
1660}
1661
1662=item cf::map::unique_maps
1663
1664Returns an arrayref of paths of all shared maps that have
1665instantiated unique items. May block.
1666
1667=cut
1668
1669sub unique_maps() {
1670 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1671 or return;
1672
1673 my @paths;
1674
1675 for (@$files) {
1676 utf8::decode $_;
1677 next if /\.pst$/;
1678 next unless /^$PATH_SEP/o;
1679
1680 push @paths, cf::map::normalise $_;
1681 }
1682
1683 \@paths
1684}
1685
1686package cf;
1687
1688=back
1689
1690=head3 cf::object
1691
1692=cut
1693
1694package cf::object;
1695
1696=over 4
1697
1698=item $ob->inv_recursive
1699
1700Returns the inventory of the object _and_ their inventories, recursively.
1701
1702=cut
1703
1704sub inv_recursive_;
1705sub inv_recursive_ {
1706 map { $_, inv_recursive_ $_->inv } @_
1707}
1708
1709sub inv_recursive {
1710 inv_recursive_ inv $_[0]
1711}
1712
1713package cf;
1714
1715=back
1716
1717=head3 cf::object::player
1718
1719=over 4
1720
435=item $player->reply ($npc, $msg[, $flags]) 1721=item $player_object->reply ($npc, $msg[, $flags])
436 1722
437Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1723Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
438can be C<undef>. Does the right thing when the player is currently in a 1724can be C<undef>. Does the right thing when the player is currently in a
439dialogue with the given NPC character. 1725dialogue with the given NPC character.
440 1726
441=cut 1727=cut
442 1728
443# rough implementation of a future "reply" method that works 1729# rough implementation of a future "reply" method that works
444# with dialog boxes. 1730# with dialog boxes.
1731#TODO: the first argument must go, split into a $npc->reply_to ( method
445sub cf::object::player::reply($$$;$) { 1732sub cf::object::player::reply($$$;$) {
446 my ($self, $npc, $msg, $flags) = @_; 1733 my ($self, $npc, $msg, $flags) = @_;
447 1734
448 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
449 1736
453 $msg = $npc->name . " says: $msg" if $npc; 1740 $msg = $npc->name . " says: $msg" if $npc;
454 $self->message ($msg, $flags); 1741 $self->message ($msg, $flags);
455 } 1742 }
456} 1743}
457 1744
458=item $player->ext_reply ($msgid, $msgtype, %msg) 1745=item $player_object->may ("access")
459 1746
460Sends an ext reply to the player. 1747Returns wether the given player is authorized to access resource "access"
1748(e.g. "command_wizcast").
461 1749
462=cut 1750=cut
463 1751
464sub cf::player::ext_reply($$$%) { 1752sub cf::object::player::may {
1753 my ($self, $access) = @_;
1754
1755 $self->flag (cf::FLAG_WIZ) ||
1756 (ref $cf::CFG{"may_$access"}
1757 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1758 : $cf::CFG{"may_$access"})
1759}
1760
1761=item $player_object->enter_link
1762
1763Freezes the player and moves him/her to a special map (C<{link}>).
1764
1765The player should be reasonably safe there for short amounts of time. You
1766I<MUST> call C<leave_link> as soon as possible, though.
1767
1768Will never block.
1769
1770=item $player_object->leave_link ($map, $x, $y)
1771
1772Moves the player out of the special C<{link}> map onto the specified
1773map. If the map is not valid (or omitted), the player will be moved back
1774to the location he/she was before the call to C<enter_link>, or, if that
1775fails, to the emergency map position.
1776
1777Might block.
1778
1779=cut
1780
1781sub link_map {
1782 unless ($LINK_MAP) {
1783 $LINK_MAP = cf::map::find "{link}"
1784 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1785 $LINK_MAP->load;
1786 }
1787
1788 $LINK_MAP
1789}
1790
1791sub cf::object::player::enter_link {
1792 my ($self) = @_;
1793
1794 $self->deactivate_recursive;
1795
1796 return if UNIVERSAL::isa $self->map, "ext::map_link";
1797
1798 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1799 if $self->map;
1800
1801 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1802}
1803
1804sub cf::object::player::leave_link {
1805 my ($self, $map, $x, $y) = @_;
1806
1807 my $link_pos = delete $self->{_link_pos};
1808
1809 unless ($map) {
1810 # restore original map position
1811 ($map, $x, $y) = @{ $link_pos || [] };
1812 $map = cf::map::find $map;
1813
1814 unless ($map) {
1815 ($map, $x, $y) = @$EMERGENCY_POSITION;
1816 $map = cf::map::find $map
1817 or die "FATAL: cannot load emergency map\n";
1818 }
1819 }
1820
1821 ($x, $y) = (-1, -1)
1822 unless (defined $x) && (defined $y);
1823
1824 # use -1 or undef as default coordinates, not 0, 0
1825 ($x, $y) = ($map->enter_x, $map->enter_y)
1826 if $x <=0 && $y <= 0;
1827
1828 $map->load;
1829 $map->load_diag;
1830
1831 return unless $self->contr->active;
1832 $self->activate_recursive;
1833
1834 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1835 $self->enter_map ($map, $x, $y);
1836}
1837
1838cf::player->attach (
1839 on_logout => sub {
1840 my ($pl) = @_;
1841
1842 # abort map switching before logout
1843 if ($pl->ob->{_link_pos}) {
1844 cf::sync_job {
1845 $pl->ob->leave_link
1846 };
1847 }
1848 },
1849 on_login => sub {
1850 my ($pl) = @_;
1851
1852 # try to abort aborted map switching on player login :)
1853 # should happen only on crashes
1854 if ($pl->ob->{_link_pos}) {
1855 $pl->ob->enter_link;
1856 (async {
1857 $pl->ob->reply (undef,
1858 "There was an internal problem at your last logout, "
1859 . "the server will try to bring you to your intended destination in a second.",
1860 cf::NDI_RED);
1861 # we need this sleep as the login has a concurrent enter_exit running
1862 # and this sleep increases chances of the player not ending up in scorn
1863 Coro::Timer::sleep 1;
1864 $pl->ob->leave_link;
1865 })->prio (2);
1866 }
1867 },
1868);
1869
1870=item $player_object->goto ($path, $x, $y)
1871
1872=cut
1873
1874sub cf::object::player::goto {
1875 my ($self, $path, $x, $y) = @_;
1876
1877 $self->enter_link;
1878
1879 (async {
1880 my $map = eval {
1881 my $map = cf::map::find $path;
1882 $map = $map->customise_for ($self) if $map;
1883 $map
1884 } or
1885 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1886
1887 $self->leave_link ($map, $x, $y);
1888 })->prio (1);
1889}
1890
1891=item $player_object->enter_exit ($exit_object)
1892
1893=cut
1894
1895sub parse_random_map_params {
1896 my ($spec) = @_;
1897
1898 my $rmp = { # defaults
1899 xsize => (cf::rndm 15, 40),
1900 ysize => (cf::rndm 15, 40),
1901 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1902 #layout => string,
1903 };
1904
1905 for (split /\n/, $spec) {
1906 my ($k, $v) = split /\s+/, $_, 2;
1907
1908 $rmp->{lc $k} = $v if (length $k) && (length $v);
1909 }
1910
1911 $rmp
1912}
1913
1914sub prepare_random_map {
1915 my ($exit) = @_;
1916
1917 my $guard = cf::lock_acquire "exit_prepare:$exit";
1918
1919 # all this does is basically replace the /! path by
1920 # a new random map path (?random/...) with a seed
1921 # that depends on the exit object
1922
1923 my $rmp = parse_random_map_params $exit->msg;
1924
1925 if ($exit->map) {
1926 $rmp->{region} = $exit->region->name;
1927 $rmp->{origin_map} = $exit->map->path;
1928 $rmp->{origin_x} = $exit->x;
1929 $rmp->{origin_y} = $exit->y;
1930 }
1931
1932 $rmp->{random_seed} ||= $exit->random_seed;
1933
1934 my $data = cf::to_json $rmp;
1935 my $md5 = Digest::MD5::md5_hex $data;
1936 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1937
1938 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1939 aio_write $fh, 0, (length $data), $data, 0;
1940 undef $fh;
1941 aio_rename "$meta~", $meta;
1942
1943 $exit->slaying ("?random/$md5");
1944 $exit->msg (undef);
1945 }
1946}
1947
1948sub cf::object::player::enter_exit {
465 my ($self, $id, %msg) = @_; 1949 my ($self, $exit) = @_;
466 1950
467 $msg{msgid} = $id; 1951 return unless $self->type == cf::PLAYER;
468 1952
469 $self->send ("ext " . to_json \%msg); 1953 if ($exit->slaying eq "/!") {
470} 1954 #TODO: this should de-fi-ni-te-ly not be a sync-job
1955 cf::sync_job { prepare_random_map $exit };
1956 }
471 1957
472############################################################################# 1958 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
473# map scripting support 1959 my $hp = $exit->stats->hp;
1960 my $sp = $exit->stats->sp;
474 1961
1962 $self->enter_link;
1963
1964 (async {
1965 $self->deactivate_recursive; # just to be sure
1966 unless (eval {
1967 $self->goto ($slaying, $hp, $sp);
1968
1969 1;
1970 }) {
1971 $self->message ("Something went wrong deep within the crossfire server. "
1972 . "I'll try to bring you back to the map you were before. "
1973 . "Please report this to the dungeon master!",
1974 cf::NDI_UNIQUE | cf::NDI_RED);
1975
1976 warn "ERROR in enter_exit: $@";
1977 $self->leave_link;
1978 }
1979 })->prio (1);
1980}
1981
1982=head3 cf::client
1983
1984=over 4
1985
1986=item $client->send_drawinfo ($text, $flags)
1987
1988Sends a drawinfo packet to the client. Circumvents output buffering so
1989should not be used under normal circumstances.
1990
1991=cut
1992
1993sub cf::client::send_drawinfo {
1994 my ($self, $text, $flags) = @_;
1995
1996 utf8::encode $text;
1997 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1998}
1999
2000
2001=item $success = $client->query ($flags, "text", \&cb)
2002
2003Queues a query to the client, calling the given callback with
2004the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2005C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2006
2007Queries can fail, so check the return code. Or don't, as queries will become
2008reliable at some point in the future.
2009
2010=cut
2011
2012sub cf::client::query {
2013 my ($self, $flags, $text, $cb) = @_;
2014
2015 return unless $self->state == ST_PLAYING
2016 || $self->state == ST_SETUP
2017 || $self->state == ST_CUSTOM;
2018
2019 $self->state (ST_CUSTOM);
2020
2021 utf8::encode $text;
2022 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2023
2024 $self->send_packet ($self->{query_queue}[0][0])
2025 if @{ $self->{query_queue} } == 1;
2026}
2027
2028cf::client->attach (
2029 on_reply => sub {
2030 my ($ns, $msg) = @_;
2031
2032 # this weird shuffling is so that direct followup queries
2033 # get handled first
2034 my $queue = delete $ns->{query_queue}
2035 or return; # be conservative, not sure how that can happen, but we saw a crash here
2036
2037 (shift @$queue)->[1]->($msg);
2038 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2039
2040 push @{ $ns->{query_queue} }, @$queue;
2041
2042 if (@{ $ns->{query_queue} } == @$queue) {
2043 if (@$queue) {
2044 $ns->send_packet ($ns->{query_queue}[0][0]);
2045 } else {
2046 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2047 }
2048 }
2049 },
2050);
2051
2052=item $client->async (\&cb)
2053
2054Create a new coroutine, running the specified callback. The coroutine will
2055be automatically cancelled when the client gets destroyed (e.g. on logout,
2056or loss of connection).
2057
2058=cut
2059
2060sub cf::client::async {
2061 my ($self, $cb) = @_;
2062
2063 my $coro = &Coro::async ($cb);
2064
2065 $coro->on_destroy (sub {
2066 delete $self->{_coro}{$coro+0};
2067 });
2068
2069 $self->{_coro}{$coro+0} = $coro;
2070
2071 $coro
2072}
2073
2074cf::client->attach (
2075 on_destroy => sub {
2076 my ($ns) = @_;
2077
2078 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2079 },
2080);
2081
2082=back
2083
2084
2085=head2 SAFE SCRIPTING
2086
2087Functions that provide a safe environment to compile and execute
2088snippets of perl code without them endangering the safety of the server
2089itself. Looping constructs, I/O operators and other built-in functionality
2090is not available in the safe scripting environment, and the number of
2091functions and methods that can be called is greatly reduced.
2092
2093=cut
2094
475our $safe = new Safe "ext"; 2095our $safe = new Safe "safe";
476our $safe_hole = new Safe::Hole; 2096our $safe_hole = new Safe::Hole;
477 2097
478$SIG{FPE} = 'IGNORE'; 2098$SIG{FPE} = 'IGNORE';
479 2099
480$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2100$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
481 2101
482# here we export the classes and methods available to script code 2102# here we export the classes and methods available to script code
483 2103
2104=pod
2105
2106The following fucntions and emthods are available within a safe environment:
2107
2108 cf::object contr pay_amount pay_player map
2109 cf::object::player player
2110 cf::player peaceful
2111 cf::map trigger
2112
2113=cut
2114
484for ( 2115for (
485 ["cf::object" => qw(contr pay_amount pay_player)], 2116 ["cf::object" => qw(contr pay_amount pay_player map)],
486 ["cf::object::player" => qw(player)], 2117 ["cf::object::player" => qw(player)],
487 ["cf::player" => qw(peaceful)], 2118 ["cf::player" => qw(peaceful)],
2119 ["cf::map" => qw(trigger)],
488) { 2120) {
489 no strict 'refs'; 2121 no strict 'refs';
490 my ($pkg, @funs) = @$_; 2122 my ($pkg, @funs) = @$_;
491 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2123 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
492 for @funs; 2124 for @funs;
493} 2125}
2126
2127=over 4
2128
2129=item @retval = safe_eval $code, [var => value, ...]
2130
2131Compiled and executes the given perl code snippet. additional var/value
2132pairs result in temporary local (my) scalar variables of the given name
2133that are available in the code snippet. Example:
2134
2135 my $five = safe_eval '$first + $second', first => 1, second => 4;
2136
2137=cut
494 2138
495sub safe_eval($;@) { 2139sub safe_eval($;@) {
496 my ($code, %vars) = @_; 2140 my ($code, %vars) = @_;
497 2141
498 my $qcode = $code; 2142 my $qcode = $code;
499 $qcode =~ s/"/‟/g; # not allowed in #line filenames 2143 $qcode =~ s/"/‟/g; # not allowed in #line filenames
500 $qcode =~ s/\n/\\n/g; 2144 $qcode =~ s/\n/\\n/g;
501 2145
502 local $_; 2146 local $_;
503 local @ext::cf::_safe_eval_args = values %vars; 2147 local @safe::cf::_safe_eval_args = values %vars;
504 2148
505 $code = 2149 my $eval =
506 "do {\n" 2150 "do {\n"
507 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 2151 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
508 . "#line 0 \"{$qcode}\"\n" 2152 . "#line 0 \"{$qcode}\"\n"
509 . $code 2153 . $code
510 . "\n}" 2154 . "\n}"
511 ; 2155 ;
512 2156
513 sub_generation_inc; 2157 sub_generation_inc;
514 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 2158 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
515 sub_generation_inc; 2159 sub_generation_inc;
516 2160
2161 if ($@) {
2162 warn "$@";
2163 warn "while executing safe code '$code'\n";
2164 warn "with arguments " . (join " ", %vars) . "\n";
2165 }
2166
517 wantarray ? @res : $res[0] 2167 wantarray ? @res : $res[0]
518} 2168}
2169
2170=item cf::register_script_function $function => $cb
2171
2172Register a function that can be called from within map/npc scripts. The
2173function should be reasonably secure and should be put into a package name
2174like the extension.
2175
2176Example: register a function that gets called whenever a map script calls
2177C<rent::overview>, as used by the C<rent> extension.
2178
2179 cf::register_script_function "rent::overview" => sub {
2180 ...
2181 };
2182
2183=cut
519 2184
520sub register_script_function { 2185sub register_script_function {
521 my ($fun, $cb) = @_; 2186 my ($fun, $cb) = @_;
522 2187
523 no strict 'refs'; 2188 no strict 'refs';
524 *{"ext::$fun"} = $safe_hole->wrap ($cb); 2189 *{"safe::$fun"} = $safe_hole->wrap ($cb);
525} 2190}
2191
2192=back
2193
2194=cut
526 2195
527############################################################################# 2196#############################################################################
528# initialisation
529 2197
530register "<global>", __PACKAGE__; 2198=head2 EXTENSION DATABASE SUPPORT
2199
2200Crossfire maintains a very simple database for extension use. It can
2201currently store anything that can be serialised using Storable, which
2202excludes objects.
2203
2204The parameter C<$family> should best start with the name of the extension
2205using it, it should be unique.
2206
2207=over 4
2208
2209=item $value = cf::db_get $family => $key
2210
2211Returns a single value from the database.
2212
2213=item cf::db_put $family => $key => $value
2214
2215Stores the given C<$value> in the family.
2216
2217=cut
2218
2219our $DB;
2220
2221sub db_init {
2222 unless ($DB) {
2223 $DB = BDB::db_create $DB_ENV;
2224
2225 cf::sync_job {
2226 eval {
2227 $DB->set_flags (BDB::CHKSUM);
2228
2229 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2230 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2231 cf::cleanup "db_open(db): $!" if $!;
2232 };
2233 cf::cleanup "db_open(db): $@" if $@;
2234 };
2235
2236 my $path = cf::localdir . "/database.pst";
2237 if (stat $path) {
2238 cf::sync_job {
2239 my $pst = Storable::retrieve $path;
2240
2241 cf::db_put (board => data => $pst->{board});
2242 cf::db_put (guildrules => data => $pst->{guildrules});
2243 cf::db_put (rent => balance => $pst->{rent}{balance});
2244 BDB::db_env_txn_checkpoint $DB_ENV;
2245
2246 unlink $path;
2247 };
2248 }
2249 }
2250}
2251
2252sub db_get($$) {
2253 my $key = "$_[0]/$_[1]";
2254
2255 cf::sync_job {
2256 BDB::db_get $DB, undef, $key, my $data;
2257
2258 $! ? ()
2259 : Compress::LZF::sthaw $data
2260 }
2261}
2262
2263sub db_put($$$) {
2264 BDB::dbreq_pri 4;
2265 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2266}
2267
2268#############################################################################
2269# the server's init and main functions
2270
2271sub init_resources {
2272 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2273 or die "unable to load regions file\n";#d#
2274}
2275
2276sub cfg_load {
2277 open my $fh, "<:utf8", cf::confdir . "/config"
2278 or return;
2279
2280 local $/;
2281 *CFG = YAML::Syck::Load <$fh>;
2282
2283 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2284
2285 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2286 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2287
2288 if (exists $CFG{mlockall}) {
2289 eval {
2290 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291 and die "WARNING: m(un)lockall failed: $!\n";
2292 };
2293 warn $@ if $@;
2294 }
2295}
2296
2297sub init {
2298 init_resources;
2299}
2300
2301sub main {
2302 # we must not ever block the main coroutine
2303 local $Coro::idle = sub {
2304 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2305 (async {
2306 Event::one_event;
2307 })->prio (Coro::PRIO_MAX);
2308 };
2309
2310 cfg_load;
2311 db_init;
2312 load_extensions;
2313
2314 $TICK_WATCHER->start;
2315 Event::loop;
2316}
2317
2318#############################################################################
2319# initialisation and cleanup
2320
2321# install some emergency cleanup handlers
2322BEGIN {
2323 for my $signal (qw(INT HUP TERM)) {
2324 Event->signal (
2325 reentrant => 0,
2326 data => WF_AUTOCANCEL,
2327 signal => $signal,
2328 prio => 0,
2329 cb => sub {
2330 cf::cleanup "SIG$signal";
2331 },
2332 );
2333 }
2334}
2335
2336sub emergency_save() {
2337 my $freeze_guard = cf::freeze_mainloop;
2338
2339 warn "enter emergency perl save\n";
2340
2341 cf::sync_job {
2342 # use a peculiar iteration method to avoid tripping on perl
2343 # refcount bugs in for. also avoids problems with players
2344 # and maps saved/destroyed asynchronously.
2345 warn "begin emergency player save\n";
2346 for my $login (keys %cf::PLAYER) {
2347 my $pl = $cf::PLAYER{$login} or next;
2348 $pl->valid or next;
2349 $pl->save;
2350 }
2351 warn "end emergency player save\n";
2352
2353 warn "begin emergency map save\n";
2354 for my $path (keys %cf::MAP) {
2355 my $map = $cf::MAP{$path} or next;
2356 $map->valid or next;
2357 $map->save;
2358 }
2359 warn "end emergency map save\n";
2360
2361 warn "begin emergency database checkpoint\n";
2362 BDB::db_env_txn_checkpoint $DB_ENV;
2363 warn "end emergency database checkpoint\n";
2364 };
2365
2366 warn "leave emergency perl save\n";
2367}
2368
2369sub post_cleanup {
2370 my ($make_core) = @_;
2371
2372 warn Carp::longmess "post_cleanup backtrace"
2373 if $make_core;
2374}
2375
2376sub reload() {
2377 # can/must only be called in main
2378 if ($Coro::current != $Coro::main) {
2379 warn "can only reload from main coroutine";
2380 return;
2381 }
2382
2383 warn "reloading...";
2384
2385 warn "entering sync_job";
2386
2387 cf::sync_job {
2388 cf::write_runtime; # external watchdog should not bark
2389 cf::emergency_save;
2390 cf::write_runtime; # external watchdog should not bark
2391
2392 warn "syncing database to disk";
2393 BDB::db_env_txn_checkpoint $DB_ENV;
2394
2395 # if anything goes wrong in here, we should simply crash as we already saved
2396
2397 warn "cancelling all WF_AUTOCANCEL watchers";
2398 for (Event::all_watchers) {
2399 $_->cancel if $_->data & WF_AUTOCANCEL;
2400 }
2401
2402 warn "flushing outstanding aio requests";
2403 for (;;) {
2404 BDB::flush;
2405 IO::AIO::flush;
2406 Coro::cede;
2407 last unless IO::AIO::nreqs || BDB::nreqs;
2408 warn "iterate...";
2409 }
2410
2411 warn "cancelling all extension coros";
2412 $_->cancel for values %EXT_CORO;
2413 %EXT_CORO = ();
2414
2415 warn "removing commands";
2416 %COMMAND = ();
2417
2418 warn "removing ext commands";
2419 %EXTCMD = ();
2420
2421 warn "unloading/nuking all extensions";
2422 for my $pkg (@EXTS) {
2423 warn "... unloading $pkg";
2424
2425 if (my $cb = $pkg->can ("unload")) {
2426 eval {
2427 $cb->($pkg);
2428 1
2429 } or warn "$pkg unloaded, but with errors: $@";
2430 }
2431
2432 warn "... nuking $pkg";
2433 Symbol::delete_package $pkg;
2434 }
2435
2436 warn "unloading all perl modules loaded from $LIBDIR";
2437 while (my ($k, $v) = each %INC) {
2438 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2439
2440 warn "... unloading $k";
2441 delete $INC{$k};
2442
2443 $k =~ s/\.pm$//;
2444 $k =~ s/\//::/g;
2445
2446 if (my $cb = $k->can ("unload_module")) {
2447 $cb->();
2448 }
2449
2450 Symbol::delete_package $k;
2451 }
2452
2453 warn "getting rid of safe::, as good as possible";
2454 Symbol::delete_package "safe::$_"
2455 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2456
2457 warn "unloading cf.pm \"a bit\"";
2458 delete $INC{"cf.pm"};
2459
2460 # don't, removes xs symbols, too,
2461 # and global variables created in xs
2462 #Symbol::delete_package __PACKAGE__;
2463
2464 warn "unload completed, starting to reload now";
2465
2466 warn "reloading cf.pm";
2467 require cf;
2468 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2469
2470 warn "loading config and database again";
2471 cf::cfg_load;
2472
2473 warn "loading extensions";
2474 cf::load_extensions;
2475
2476 warn "reattaching attachments to objects/players";
2477 _global_reattach;
2478 warn "reattaching attachments to maps";
2479 reattach $_ for values %MAP;
2480
2481 warn "loading reloadable resources";
2482 init_resources;
2483
2484 warn "leaving sync_job";
2485
2486 1
2487 } or do {
2488 warn $@;
2489 warn "error while reloading, exiting.";
2490 exit 1;
2491 };
2492
2493 warn "reloaded";
2494};
2495
2496our $RELOAD_WATCHER; # used only during reload
2497
2498register_command "reload" => sub {
2499 my ($who, $arg) = @_;
2500
2501 if ($who->flag (FLAG_WIZ)) {
2502 $who->message ("reloading server.");
2503
2504 # doing reload synchronously and two reloads happen back-to-back,
2505 # coro crashes during coro_state_free->destroy here.
2506
2507 $RELOAD_WATCHER ||= Event->timer (
2508 reentrant => 0,
2509 after => 0,
2510 data => WF_AUTOCANCEL,
2511 cb => sub {
2512 reload;
2513 undef $RELOAD_WATCHER;
2514 },
2515 );
2516 }
2517};
531 2518
532unshift @INC, $LIBDIR; 2519unshift @INC, $LIBDIR;
533 2520
534load_extensions; 2521my $bug_warning = 0;
2522
2523$TICK_WATCHER = Event->timer (
2524 reentrant => 0,
2525 parked => 1,
2526 prio => 0,
2527 at => $NEXT_TICK || $TICK,
2528 data => WF_AUTOCANCEL,
2529 cb => sub {
2530 if ($Coro::current != $Coro::main) {
2531 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2532 unless ++$bug_warning > 10;
2533 return;
2534 }
2535
2536 $NOW = Event::time;
2537
2538 cf::server_tick; # one server iteration
2539 $RUNTIME += $TICK;
2540 $NEXT_TICK += $TICK;
2541
2542 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2543 $NEXT_RUNTIME_WRITE = $NOW + 10;
2544 Coro::async_pool {
2545 write_runtime
2546 or warn "ERROR: unable to write runtime file: $!";
2547 };
2548 }
2549
2550 $WAIT_FOR_TICK->broadcast;
2551 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2552
2553# my $AFTER = Event::time;
2554# warn $AFTER - $NOW;#d#
2555
2556 # if we are delayed by four ticks or more, skip them all
2557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2558
2559 $TICK_WATCHER->at ($NEXT_TICK);
2560 $TICK_WATCHER->start;
2561 },
2562);
2563
2564{
2565 BDB::max_poll_time $TICK * 0.1;
2566 $BDB_POLL_WATCHER = Event->io (
2567 reentrant => 0,
2568 fd => BDB::poll_fileno,
2569 poll => 'r',
2570 prio => 0,
2571 data => WF_AUTOCANCEL,
2572 cb => \&BDB::poll_cb,
2573 );
2574 BDB::min_parallel 8;
2575
2576 BDB::set_sync_prepare {
2577 my $status;
2578 my $current = $Coro::current;
2579 (
2580 sub {
2581 $status = $!;
2582 $current->ready; undef $current;
2583 },
2584 sub {
2585 Coro::schedule while defined $current;
2586 $! = $status;
2587 },
2588 )
2589 };
2590
2591 unless ($DB_ENV) {
2592 $DB_ENV = BDB::db_env_create;
2593
2594 cf::sync_job {
2595 eval {
2596 BDB::db_env_open
2597 $DB_ENV,
2598 $BDB_ENV_DIR,
2599 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2600 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2601 0666;
2602
2603 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
2604
2605 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2606 $DB_ENV->set_lk_detect;
2607 };
2608
2609 cf::cleanup "db_env_open(db): $@" if $@;
2610 };
2611 }
2612}
2613
2614{
2615 IO::AIO::min_parallel 8;
2616
2617 undef $Coro::AIO::WATCHER;
2618 IO::AIO::max_poll_time $TICK * 0.1;
2619 $AIO_POLL_WATCHER = Event->io (
2620 reentrant => 0,
2621 data => WF_AUTOCANCEL,
2622 fd => IO::AIO::poll_fileno,
2623 poll => 'r',
2624 prio => 6,
2625 cb => \&IO::AIO::poll_cb,
2626 );
2627}
2628
2629END { cf::emergency_save }
535 2630
5361 26311
537 2632

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines