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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines