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.102 by root, Wed Dec 27 15:20:54 2006 UTC vs.
Revision 1.262 by root, Sat Apr 28 05:55:55 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro; 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::Storable;
18 24
19use IO::AIO 2.3; 25use BDB ();
26use Data::Dumper;
27use Digest::MD5;
28use Fcntl;
20use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
21use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
22 33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
23use Event; $Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
24 41
25# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
26$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
27 44
28$Coro::main->prio (Coro::PRIO_MIN); 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29 46
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31 48
32our %COMMAND = (); 49our %COMMAND = ();
33our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
34our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
35 56
57our $RELOAD; # number of reloads so far
36our @EVENT; 58our @EVENT;
37our $LIBDIR = datadir . "/ext";
38 59
39our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
40our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
41our $NEXT_TICK; 76our $NEXT_TICK;
77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
42 82
43our %CFG; 83our %CFG;
44 84
45our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
86our $RUNTIME;
87
88our %PLAYER; # all users
89our %MAP; # all maps
90our $LINK_MAP; # the special {link} map, which is always available
91
92# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95binmode STDOUT;
96binmode STDERR;
97
98# read virtual server time, if available
99unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
100 open my $fh, "<", "$LOCALDIR/runtime"
101 or die "unable to read runtime file: $!";
102 $RUNTIME = <$fh> + 0.;
103}
104
105mkdir $_
106 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
107
108our $EMERGENCY_POSITION;
109
110sub cf::map::normalise;
46 111
47############################################################################# 112#############################################################################
48 113
49=head2 GLOBAL VARIABLES 114=head2 GLOBAL VARIABLES
50 115
52 117
53=item $cf::UPTIME 118=item $cf::UPTIME
54 119
55The timestamp of the server start (so not actually an uptime). 120The timestamp of the server start (so not actually an uptime).
56 121
57=item $cf::LIBDIR 122=item $cf::RUNTIME
58 123
59The perl library directory, where extensions and cf-specific modules can 124The time this server has run, starts at 0 and is increased by $cf::TICK on
60be found. It will be added to C<@INC> automatically. 125every server tick.
126
127=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
128$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
129$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
130
131Various directories - "/etc", read-only install directory, perl-library
132directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
133unique-items directory, player file directory, random maps directory and
134database environment.
135
136=item $cf::NOW
137
138The time of the last (current) server tick.
61 139
62=item $cf::TICK 140=item $cf::TICK
63 141
64The interval between server ticks, in seconds. 142The interval between server ticks, in seconds.
65 143
66=item %cf::CFG 144=item %cf::CFG
67 145
68Configuration for the server, loaded from C</etc/crossfire/config>, or 146Configuration for the server, loaded from C</etc/crossfire/config>, or
69from wherever your confdir points to. 147from wherever your confdir points to.
148
149=item cf::wait_for_tick, cf::wait_for_tick_begin
150
151These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
152returns directly I<after> the tick processing (and consequently, can only wake one process
153per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
70 154
71=back 155=back
72 156
73=cut 157=cut
74 158
75BEGIN { 159BEGIN {
76 *CORE::GLOBAL::warn = sub { 160 *CORE::GLOBAL::warn = sub {
77 my $msg = join "", @_; 161 my $msg = join "", @_;
162
78 $msg .= "\n" 163 $msg .= "\n"
79 unless $msg =~ /\n$/; 164 unless $msg =~ /\n$/;
80 165
81 print STDERR "cfperl: $msg"; 166 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
167
168 utf8::encode $msg;
82 LOG llevError, "cfperl: $msg"; 169 LOG llevError, $msg;
83 }; 170 };
84} 171}
85 172
86@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 173@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
87@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 174@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
105 192
106$Event::DIED = sub { 193$Event::DIED = sub {
107 warn "error in event callback: @_"; 194 warn "error in event callback: @_";
108}; 195};
109 196
110my %ext_pkg;
111my @exts;
112my @hook;
113
114=head2 UTILITY FUNCTIONS 197=head2 UTILITY FUNCTIONS
115 198
116=over 4 199=over 4
117 200
118=cut 201=item dumpval $ref
119 202
203=cut
204
205sub dumpval {
206 eval {
207 local $SIG{__DIE__};
208 my $d;
209 if (1) {
210 $d = new Data::Dumper([$_[0]], ["*var"]);
211 $d->Terse(1);
212 $d->Indent(2);
213 $d->Quotekeys(0);
214 $d->Useqq(1);
215 #$d->Bless(...);
216 $d->Seen($_[1]) if @_ > 1;
217 $d = $d->Dump();
218 }
219 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
220 $d
221 } || "[unable to dump $_[0]: '$@']";
222}
223
120use JSON::Syck (); # TODO# replace by JSON::PC once working 224use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
121 225
122=item $ref = cf::from_json $json 226=item $ref = cf::from_json $json
123 227
124Converts a JSON string into the corresponding perl data structure. 228Converts a JSON string into the corresponding perl data structure.
125 229
126=cut
127
128sub from_json($) {
129 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
130 JSON::Syck::Load $_[0]
131}
132
133=item $json = cf::to_json $ref 230=item $json = cf::to_json $ref
134 231
135Converts a perl data structure into its JSON representation. 232Converts a perl data structure into its JSON representation.
136 233
137=cut 234=item cf::lock_wait $string
138 235
139sub to_json($) { 236Wait until the given lock is available. See cf::lock_acquire.
140 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 237
141 JSON::Syck::Dump $_[0] 238=item my $lock = cf::lock_acquire $string
239
240Wait until the given lock is available and then acquires it and returns
241a Coro::guard object. If the guard object gets destroyed (goes out of scope,
242for example when the coroutine gets canceled), the lock is automatically
243returned.
244
245Lock names should begin with a unique identifier (for example, cf::map::find
246uses map_find and cf::map::load uses map_load).
247
248=item $locked = cf::lock_active $string
249
250Return true if the lock is currently active, i.e. somebody has locked it.
251
252=cut
253
254our %LOCK;
255
256sub lock_wait($) {
257 my ($key) = @_;
258
259 # wait for lock, if any
260 while ($LOCK{$key}) {
261 push @{ $LOCK{$key} }, $Coro::current;
262 Coro::schedule;
263 }
264}
265
266sub lock_acquire($) {
267 my ($key) = @_;
268
269 # wait, to be sure we are not locked
270 lock_wait $key;
271
272 $LOCK{$key} = [];
273
274 Coro::guard {
275 # wake up all waiters, to be on the safe side
276 $_->ready for @{ delete $LOCK{$key} };
277 }
278}
279
280sub lock_active($) {
281 my ($key) = @_;
282
283 ! ! $LOCK{$key}
284}
285
286sub freeze_mainloop {
287 return unless $TICK_WATCHER->is_active;
288
289 my $guard = Coro::guard {
290 $TICK_WATCHER->start;
291 };
292 $TICK_WATCHER->stop;
293 $guard
294}
295
296=item cf::async { BLOCK }
297
298Currently the same as Coro::async_pool, meaning you cannot use
299C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
300thing you are allowed to do is call C<prio> on it.
301
302=cut
303
304BEGIN { *async = \&Coro::async_pool }
305
306=item cf::sync_job { BLOCK }
307
308The design of crossfire+ requires that the main coro ($Coro::main) is
309always able to handle events or runnable, as crossfire+ is only partly
310reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
311
312If it must be done, put the blocking parts into C<sync_job>. This will run
313the given BLOCK in another coroutine while waiting for the result. The
314server will be frozen during this time, so the block should either finish
315fast or be very important.
316
317=cut
318
319sub sync_job(&) {
320 my ($job) = @_;
321
322 if ($Coro::current == $Coro::main) {
323 # this is the main coro, too bad, we have to block
324 # till the operation succeeds, freezing the server :/
325
326 # TODO: use suspend/resume instead
327 # (but this is cancel-safe)
328 my $freeze_guard = freeze_mainloop;
329
330 my $busy = 1;
331 my @res;
332
333 (async {
334 @res = eval { $job->() };
335 warn $@ if $@;
336 undef $busy;
337 })->prio (Coro::PRIO_MAX);
338
339 while ($busy) {
340 Coro::cede or Event::one_event;
341 }
342
343 wantarray ? @res : $res[0]
344 } else {
345 # we are in another coroutine, how wonderful, everything just works
346
347 $job->()
348 }
349}
350
351=item $coro = cf::async_ext { BLOCK }
352
353Like async, but this coro is automatically being canceled when the
354extension calling this is being unloaded.
355
356=cut
357
358sub async_ext(&) {
359 my $cb = shift;
360
361 my $coro = &Coro::async ($cb);
362
363 $coro->on_destroy (sub {
364 delete $EXT_CORO{$coro+0};
365 });
366 $EXT_CORO{$coro+0} = $coro;
367
368 $coro
369}
370
371sub write_runtime {
372 my $guard = cf::lock_acquire "write_runtime";
373
374 my $runtime = "$LOCALDIR/runtime";
375
376 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
377 or return;
378
379 my $value = $cf::RUNTIME + 90 + 10;
380 # 10 is the runtime save interval, for a monotonic clock
381 # 60 allows for the watchdog to kill the server.
382
383 (aio_write $fh, 0, (length $value), $value, 0) <= 0
384 and return;
385
386 # always fsync - this file is important
387 aio_fsync $fh
388 and return;
389
390 close $fh
391 or return;
392
393 aio_rename "$runtime~", $runtime
394 and return;
395
396 1
397}
398
399=item cf::datalog type => key => value, ...
400
401Log a datalog packet of the given type with the given key-value pairs.
402
403=cut
404
405sub datalog($@) {
406 my ($type, %kv) = @_;
407 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
142} 408}
143 409
144=back 410=back
145 411
146=cut 412=cut
277our @CB_TYPE = (); # registry for type (cf-object class) based events 543our @CB_TYPE = (); # registry for type (cf-object class) based events
278our @CB_MAP = (); 544our @CB_MAP = ();
279 545
280my %attachment; 546my %attachment;
281 547
548sub cf::attachable::thawer_merge {
549 # simply override everything except _meta
550 local $_[0]{_meta};
551 %{$_[0]} = %{$_[1]};
552}
553
282sub _attach_cb($$$$) { 554sub _attach_cb($$$$) {
283 my ($registry, $event, $prio, $cb) = @_; 555 my ($registry, $event, $prio, $cb) = @_;
284 556
285 use sort 'stable'; 557 use sort 'stable';
286 558
457# object support 729# object support
458 730
459sub reattach { 731sub reattach {
460 # basically do the same as instantiate, without calling instantiate 732 # basically do the same as instantiate, without calling instantiate
461 my ($obj) = @_; 733 my ($obj) = @_;
734
735 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
462 736
463 my $registry = $obj->registry; 737 my $registry = $obj->registry;
464 738
465 @$registry = (); 739 @$registry = ();
466 740
505); 779);
506 780
507sub object_freezer_save { 781sub object_freezer_save {
508 my ($filename, $rdata, $objs) = @_; 782 my ($filename, $rdata, $objs) = @_;
509 783
784 sync_job {
510 if (length $$rdata) { 785 if (length $$rdata) {
511 warn sprintf "saving %s (%d,%d)\n", 786 warn sprintf "saving %s (%d,%d)\n",
512 $filename, length $$rdata, scalar @$objs; 787 $filename, length $$rdata, scalar @$objs;
513 788
514 if (open my $fh, ">:raw", "$filename~") { 789 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
515 chmod SAVE_MODE, $fh;
516 syswrite $fh, $$rdata;
517 close $fh;
518
519 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520 chmod SAVE_MODE, $fh; 790 chmod SAVE_MODE, $fh;
521 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 791 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
792 aio_fsync $fh if $cf::USE_FSYNC;
522 close $fh; 793 close $fh;
794
795 if (@$objs) {
796 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
797 chmod SAVE_MODE, $fh;
798 my $data = Storable::nfreeze { version => 1, objs => $objs };
799 aio_write $fh, 0, (length $data), $data, 0;
800 aio_fsync $fh if $cf::USE_FSYNC;
801 close $fh;
523 rename "$filename.pst~", "$filename.pst"; 802 aio_rename "$filename.pst~", "$filename.pst";
803 }
804 } else {
805 aio_unlink "$filename.pst";
806 }
807
808 aio_rename "$filename~", $filename;
524 } else { 809 } else {
525 unlink "$filename.pst"; 810 warn "FATAL: $filename~: $!\n";
526 } 811 }
527
528 rename "$filename~", $filename;
529 } else { 812 } else {
530 warn "FATAL: $filename~: $!\n";
531 }
532 } else {
533 unlink $filename; 813 aio_unlink $filename;
534 unlink "$filename.pst"; 814 aio_unlink "$filename.pst";
815 }
535 } 816 }
536} 817}
537 818
538sub object_freezer_as_string { 819sub object_freezer_as_string {
539 my ($rdata, $objs) = @_; 820 my ($rdata, $objs) = @_;
544} 825}
545 826
546sub object_thawer_load { 827sub object_thawer_load {
547 my ($filename) = @_; 828 my ($filename) = @_;
548 829
549 local $/; 830 my ($data, $av);
550 831
551 my $av; 832 (aio_load $filename, $data) >= 0
833 or return;
552 834
553 #TODO: use sysread etc. 835 unless (aio_stat "$filename.pst") {
554 if (open my $data, "<:raw:perlio", $filename) { 836 (aio_load "$filename.pst", $av) >= 0
555 $data = <$data>; 837 or return;
556 if (open my $pst, "<:raw:perlio", "$filename.pst") {
557 $av = eval { (Storable::thaw <$pst>)->{objs} }; 838 $av = eval { (Storable::thaw $av)->{objs} };
558 } 839 }
840
841 warn sprintf "loading %s (%d)\n",
842 $filename, length $data, scalar @{$av || []};#d#
559 return ($data, $av); 843 return ($data, $av);
560 }
561
562 ()
563} 844}
564 845
565############################################################################# 846#############################################################################
566# command handling &c 847# command handling &c
567 848
591=cut 872=cut
592 873
593sub register_extcmd { 874sub register_extcmd {
594 my ($name, $cb) = @_; 875 my ($name, $cb) = @_;
595 876
596 my $caller = caller;
597 #warn "registering extcmd '$name' to '$caller'";
598
599 $EXTCMD{$name} = [$cb, $caller]; 877 $EXTCMD{$name} = $cb;
600} 878}
601 879
602cf::player->attach ( 880cf::player->attach (
603 on_command => sub { 881 on_command => sub {
604 my ($pl, $name, $params) = @_; 882 my ($pl, $name, $params) = @_;
617 895
618 my $msg = eval { from_json $buf }; 896 my $msg = eval { from_json $buf };
619 897
620 if (ref $msg) { 898 if (ref $msg) {
621 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 899 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
622 if (my %reply = $cb->[0]->($pl, $msg)) { 900 if (my %reply = $cb->($pl, $msg)) {
623 $pl->ext_reply ($msg->{msgid}, %reply); 901 $pl->ext_reply ($msg->{msgid}, %reply);
624 } 902 }
625 } 903 }
626 } else { 904 } else {
627 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 905 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
629 907
630 cf::override; 908 cf::override;
631 }, 909 },
632); 910);
633 911
634sub register {
635 my ($base, $pkg) = @_;
636
637 #TODO
638}
639
640sub load_extension { 912sub load_extension {
641 my ($path) = @_; 913 my ($path) = @_;
642 914
643 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 915 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
644 my $base = $1; 916 my $base = $1;
645 my $pkg = $1; 917 my $pkg = $1;
646 $pkg =~ s/[^[:word:]]/_/g; 918 $pkg =~ s/[^[:word:]]/_/g;
647 $pkg = "ext::$pkg"; 919 $pkg = "ext::$pkg";
648 920
649 warn "loading '$path' into '$pkg'\n"; 921 warn "... loading '$path' into '$pkg'\n";
650 922
651 open my $fh, "<:utf8", $path 923 open my $fh, "<:utf8", $path
652 or die "$path: $!"; 924 or die "$path: $!";
653 925
654 my $source = 926 my $source =
655 "package $pkg; use strict; use utf8;\n" 927 "package $pkg; use strict; use utf8;\n"
656 . "#line 1 \"$path\"\n{\n" 928 . "#line 1 \"$path\"\n{\n"
657 . (do { local $/; <$fh> }) 929 . (do { local $/; <$fh> })
658 . "\n};\n1"; 930 . "\n};\n1";
659 931
660 eval $source 932 unless (eval $source) {
661 or die $@ ? "$path: $@\n" 933 my $msg = $@ ? "$path: $@\n"
662 : "extension disabled.\n"; 934 : "extension disabled.\n";
663 935 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
664 push @exts, $pkg; 936 warn $@;
665 $ext_pkg{$base} = $pkg; 937 warn "mandatory extension failed to load, exiting.\n";
666 938 exit 1;
667# no strict 'refs'; 939 }
668# @{"$pkg\::ISA"} = ext::; 940 die $@;
669
670 register $base, $pkg;
671}
672
673sub unload_extension {
674 my ($pkg) = @_;
675
676 warn "removing extension $pkg\n";
677
678 # remove hooks
679 #TODO
680# for my $idx (0 .. $#PLUGIN_EVENT) {
681# delete $hook[$idx]{$pkg};
682# } 941 }
683 942
684 # remove commands 943 push @EXTS, $pkg;
685 for my $name (keys %COMMAND) {
686 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
687
688 if (@cb) {
689 $COMMAND{$name} = \@cb;
690 } else {
691 delete $COMMAND{$name};
692 }
693 }
694
695 # remove extcmds
696 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
697 delete $EXTCMD{$name};
698 }
699
700 if (my $cb = $pkg->can ("unload")) {
701 eval {
702 $cb->($pkg);
703 1
704 } or warn "$pkg unloaded, but with errors: $@";
705 }
706
707 Symbol::delete_package $pkg;
708} 944}
709 945
710sub load_extensions { 946sub load_extensions {
711 for my $ext (<$LIBDIR/*.ext>) { 947 for my $ext (<$LIBDIR/*.ext>) {
712 next unless -r $ext; 948 next unless -r $ext;
716 } or warn "$ext not loaded: $@"; 952 } or warn "$ext not loaded: $@";
717 } 953 }
718} 954}
719 955
720############################################################################# 956#############################################################################
721# load/save/clean perl data associated with a map
722 957
723*cf::mapsupport::on_clean = sub { 958=head2 CORE EXTENSIONS
959
960Functions and methods that extend core crossfire objects.
961
962=cut
963
964package cf::player;
965
966use Coro::AIO;
967
968=head3 cf::player
969
970=over 4
971
972=item cf::player::find $login
973
974Returns the given player object, loading it if necessary (might block).
975
976=cut
977
978sub playerdir($) {
979 "$PLAYERDIR/"
980 . (ref $_[0] ? $_[0]->ob->name : $_[0])
981}
982
983sub path($) {
984 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
985
986 (playerdir $login) . "/playerdata"
987}
988
989sub find_active($) {
990 $cf::PLAYER{$_[0]}
991 and $cf::PLAYER{$_[0]}->active
992 and $cf::PLAYER{$_[0]}
993}
994
995sub exists($) {
996 my ($login) = @_;
997
998 $cf::PLAYER{$login}
999 or cf::sync_job { !aio_stat path $login }
1000}
1001
1002sub find($) {
1003 return $cf::PLAYER{$_[0]} || do {
1004 my $login = $_[0];
1005
1006 my $guard = cf::lock_acquire "user_find:$login";
1007
1008 $cf::PLAYER{$_[0]} || do {
1009 # rename old playerfiles to new ones
1010 #TODO: remove when no longer required
1011 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1012 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1013 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1014 aio_unlink +(playerdir $login) . "/$login.pl";
1015
1016 my $pl = load_pl path $login
1017 or return;
1018 $cf::PLAYER{$login} = $pl
1019 }
1020 }
1021}
1022
1023sub save($) {
1024 my ($pl) = @_;
1025
1026 return if $pl->{deny_save};
1027
1028 my $path = path $pl;
1029 my $guard = cf::lock_acquire "user_save:$path";
1030
1031 return if $pl->{deny_save};
1032
1033 aio_mkdir playerdir $pl, 0770;
1034 $pl->{last_save} = $cf::RUNTIME;
1035
1036 $pl->save_pl ($path);
1037 Coro::cede;
1038}
1039
1040sub new($) {
1041 my ($login) = @_;
1042
1043 my $self = create;
1044
1045 $self->ob->name ($login);
1046 $self->{deny_save} = 1;
1047
1048 $cf::PLAYER{$login} = $self;
1049
1050 $self
1051}
1052
1053=item $pl->quit_character
1054
1055Nukes the player without looking back. If logged in, the connection will
1056be destroyed. May block for a long time.
1057
1058=cut
1059
1060sub quit_character {
1061 my ($pl) = @_;
1062
1063 my $name = $pl->ob->name;
1064
1065 $pl->{deny_save} = 1;
1066 $pl->password ("*"); # this should lock out the player until we nuked the dir
1067
1068 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1069 $pl->deactivate;
1070 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1071 $pl->ns->destroy if $pl->ns;
1072
1073 my $path = playerdir $pl;
1074 my $temp = "$path~$cf::RUNTIME~deleting~";
1075 aio_rename $path, $temp;
1076 delete $cf::PLAYER{$pl->ob->name};
1077 $pl->destroy;
1078
1079 my $prefix = qr<^~\Q$name\E/>;
1080
1081 # nuke player maps
1082 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1083
1084 IO::AIO::aio_rmtree $temp;
1085}
1086
1087=item $pl->kick
1088
1089Kicks a player out of the game. This destroys the connection.
1090
1091=cut
1092
1093sub kick {
1094 my ($pl, $kicker) = @_;
1095
1096 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1097 $pl->killer ("kicked");
1098 $pl->ns->destroy;
1099}
1100
1101=item cf::player::list_logins
1102
1103Returns am arrayref of all valid playernames in the system, can take a
1104while and may block, so not sync_job-capable, ever.
1105
1106=cut
1107
1108sub list_logins {
1109 my $dirs = aio_readdir $PLAYERDIR
1110 or return [];
1111
1112 my @logins;
1113
1114 for my $login (@$dirs) {
1115 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1116 aio_read $fh, 0, 512, my $buf, 0 or next;
1117 $buf !~ /^password -------------$/m or next; # official not-valid tag
1118
1119 utf8::decode $login;
1120 push @logins, $login;
1121 }
1122
1123 \@logins
1124}
1125
1126=item $player->maps
1127
1128Returns an arrayref of map paths that are private for this
1129player. May block.
1130
1131=cut
1132
1133sub maps($) {
1134 my ($pl) = @_;
1135
1136 $pl = ref $pl ? $pl->ob->name : $pl;
1137
1138 my $files = aio_readdir playerdir $pl
1139 or return;
1140
1141 my @paths;
1142
1143 for (@$files) {
1144 utf8::decode $_;
1145 next if /\.(?:pl|pst)$/;
1146 next unless /^$PATH_SEP/o;
1147
1148 push @paths, cf::map::normalise "~$pl/$_";
1149 }
1150
1151 \@paths
1152}
1153
1154=item $player->ext_reply ($msgid, %msg)
1155
1156Sends an ext reply to the player.
1157
1158=cut
1159
1160sub ext_reply($$%) {
1161 my ($self, $id, %msg) = @_;
1162
1163 $msg{msgid} = $id;
1164
1165 $self->send ("ext " . cf::to_json \%msg);
1166}
1167
1168=item $player->ext_event ($type, %msg)
1169
1170Sends an ext event to the client.
1171
1172=cut
1173
1174sub ext_event($$%) {
1175 my ($self, $type, %msg) = @_;
1176
1177 $self->ns->ext_event ($type, %msg);
1178}
1179
1180=head3 cf::region
1181
1182=over 4
1183
1184=cut
1185
1186package cf::region;
1187
1188=item cf::region::find_by_path $path
1189
1190Tries to decuce the probable region for a map knowing only its path.
1191
1192=cut
1193
1194sub find_by_path($) {
1195 my ($path) = @_;
1196
1197 my ($match, $specificity);
1198
1199 for my $region (list) {
1200 if ($region->match && $path =~ $region->match) {
1201 ($match, $specificity) = ($region, $region->specificity)
1202 if $region->specificity > $specificity;
1203 }
1204 }
1205
1206 $match
1207}
1208
1209=back
1210
1211=head3 cf::map
1212
1213=over 4
1214
1215=cut
1216
1217package cf::map;
1218
1219use Fcntl;
1220use Coro::AIO;
1221
1222use overload
1223 '""' => \&as_string,
1224 fallback => 1;
1225
1226our $MAX_RESET = 3600;
1227our $DEFAULT_RESET = 3000;
1228
1229sub generate_random_map {
1230 my ($self, $rmp) = @_;
1231 # mit "rum" bekleckern, nicht
1232 $self->_create_random_map (
1233 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1234 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1235 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1236 $rmp->{exit_on_final_map},
1237 $rmp->{xsize}, $rmp->{ysize},
1238 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1239 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1240 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1241 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1242 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1243 (cf::region::find $rmp->{region}), $rmp->{custom}
1244 )
1245}
1246
1247=item cf::map->register ($regex, $prio)
1248
1249Register a handler for the map path matching the given regex at the
1250givne priority (higher is better, built-in handlers have priority 0, the
1251default).
1252
1253=cut
1254
1255sub register {
1256 my (undef, $regex, $prio) = @_;
1257 my $pkg = caller;
1258
1259 no strict;
1260 push @{"$pkg\::ISA"}, __PACKAGE__;
1261
1262 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1263}
1264
1265# also paths starting with '/'
1266$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1267
1268sub thawer_merge {
1269 my ($self, $merge) = @_;
1270
1271 # we have to keep some variables in memory intact
1272 local $self->{path};
1273 local $self->{load_path};
1274 local $self->{deny_save};
1275 local $self->{deny_reset};
1276
1277 $self->SUPER::thawer_merge ($merge);
1278}
1279
1280sub normalise {
1281 my ($path, $base) = @_;
1282
1283 $path = "$path"; # make sure its a string
1284
1285 $path =~ s/\.map$//;
1286
1287 # map plan:
1288 #
1289 # /! non-realised random map exit (special hack!)
1290 # {... are special paths that are not being touched
1291 # ?xxx/... are special absolute paths
1292 # ?random/... random maps
1293 # /... normal maps
1294 # ~user/... per-player map of a specific user
1295
1296 $path =~ s/$PATH_SEP/\//go;
1297
1298 # treat it as relative path if it starts with
1299 # something that looks reasonable
1300 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1301 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1302
1303 $base =~ s{[^/]+/?$}{};
1304 $path = "$base/$path";
1305 }
1306
1307 for ($path) {
1308 redo if s{//}{/};
1309 redo if s{/\.?/}{/};
1310 redo if s{/[^/]+/\.\./}{/};
1311 }
1312
1313 $path
1314}
1315
1316sub new_from_path {
1317 my (undef, $path, $base) = @_;
1318
1319 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1320
1321 $path = normalise $path, $base;
1322
1323 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1324 if ($path =~ $EXT_MAP{$pkg}[1]) {
1325 my $self = bless cf::map::new, $pkg;
1326 $self->{path} = $path; $self->path ($path);
1327 $self->init; # pass $1 etc.
1328 return $self;
1329 }
1330 }
1331
1332 Carp::carp "unable to resolve path '$path' (base '$base').";
1333 ()
1334}
1335
1336sub init {
1337 my ($self) = @_;
1338
1339 $self
1340}
1341
1342sub as_string {
1343 my ($self) = @_;
1344
1345 "$self->{path}"
1346}
1347
1348# the displayed name, this is a one way mapping
1349sub visible_name {
1350 &as_string
1351}
1352
1353# the original (read-only) location
1354sub load_path {
1355 my ($self) = @_;
1356
1357 "$MAPDIR/$self->{path}.map"
1358}
1359
1360# the temporary/swap location
1361sub save_path {
1362 my ($self) = @_;
1363
1364 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1365 "$TMPDIR/$path.map"
1366}
1367
1368# the unique path, undef == no special unique path
1369sub uniq_path {
1370 my ($self) = @_;
1371
1372 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1373 "$UNIQUEDIR/$path"
1374}
1375
1376# and all this just because we cannot iterate over
1377# all maps in C++...
1378sub change_all_map_light {
1379 my ($change) = @_;
1380
1381 $_->change_map_light ($change)
1382 for grep $_->outdoor, values %cf::MAP;
1383}
1384
1385sub unlink_save {
1386 my ($self) = @_;
1387
1388 utf8::encode (my $save = $self->save_path);
1389 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1390 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1391}
1392
1393sub load_header_from($) {
1394 my ($self, $path) = @_;
1395
1396 utf8::encode $path;
1397 #aio_open $path, O_RDONLY, 0
1398 # or return;
1399
1400 $self->_load_header ($path)
1401 or return;
1402
1403 $self->{load_path} = $path;
1404
1405 1
1406}
1407
1408sub load_header_orig {
1409 my ($self) = @_;
1410
1411 $self->load_header_from ($self->load_path)
1412}
1413
1414sub load_header_temp {
1415 my ($self) = @_;
1416
1417 $self->load_header_from ($self->save_path)
1418}
1419
1420sub prepare_temp {
1421 my ($self) = @_;
1422
1423 $self->last_access ((delete $self->{last_access})
1424 || $cf::RUNTIME); #d#
1425 # safety
1426 $self->{instantiate_time} = $cf::RUNTIME
1427 if $self->{instantiate_time} > $cf::RUNTIME;
1428}
1429
1430sub prepare_orig {
1431 my ($self) = @_;
1432
1433 $self->{load_original} = 1;
1434 $self->{instantiate_time} = $cf::RUNTIME;
1435 $self->last_access ($cf::RUNTIME);
1436 $self->instantiate;
1437}
1438
1439sub load_header {
1440 my ($self) = @_;
1441
1442 if ($self->load_header_temp) {
1443 $self->prepare_temp;
1444 } else {
1445 $self->load_header_orig
1446 or return;
1447 $self->prepare_orig;
1448 }
1449
1450 $self->default_region (cf::region::find_by_path $self->{path})
1451 unless $self->default_region;
1452
1453 1
1454}
1455
1456sub find;
1457sub find {
1458 my ($path, $origin) = @_;
1459
1460 $path = normalise $path, $origin && $origin->path;
1461
1462 cf::lock_wait "map_find:$path";
1463
1464 $cf::MAP{$path} || do {
1465 my $guard = cf::lock_acquire "map_find:$path";
1466 my $map = new_from_path cf::map $path
1467 or return;
1468
1469 $map->{last_save} = $cf::RUNTIME;
1470
1471 $map->load_header
1472 or return;
1473
1474 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1475 # doing this can freeze the server in a sync job, obviously
1476 #$cf::WAIT_FOR_TICK->wait;
1477 $map->reset;
1478 undef $guard;
1479 return find $path;
1480 }
1481
1482 $cf::MAP{$path} = $map
1483 }
1484}
1485
1486sub pre_load { }
1487sub post_load { }
1488
1489sub load {
1490 my ($self) = @_;
1491
1492 local $self->{deny_reset} = 1; # loading can take a long time
1493
1494 my $path = $self->{path};
1495
1496 {
1497 my $guard = cf::lock_acquire "map_load:$path";
1498
1499 return if $self->in_memory != cf::MAP_SWAPPED;
1500
1501 $self->in_memory (cf::MAP_LOADING);
1502
1503 $self->alloc;
1504
1505 $self->pre_load;
1506 Coro::cede;
1507
1508 $self->_load_objects ($self->{load_path}, 1)
1509 or return;
1510
1511 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1512 if delete $self->{load_original};
1513
1514 if (my $uniq = $self->uniq_path) {
1515 utf8::encode $uniq;
1516 if (aio_open $uniq, O_RDONLY, 0) {
1517 $self->clear_unique_items;
1518 $self->_load_objects ($uniq, 0);
1519 }
1520 }
1521
1522 Coro::cede;
1523 # now do the right thing for maps
1524 $self->link_multipart_objects;
1525 $self->difficulty ($self->estimate_difficulty)
1526 unless $self->difficulty;
1527 Coro::cede;
1528
1529 unless ($self->{deny_activate}) {
1530 $self->decay_objects;
1531 $self->fix_auto_apply;
1532 $self->update_buttons;
1533 Coro::cede;
1534 $self->set_darkness_map;
1535 Coro::cede;
1536 $self->activate;
1537 }
1538
1539 $self->in_memory (cf::MAP_IN_MEMORY);
1540 }
1541
1542 $self->post_load;
1543}
1544
1545sub customise_for {
1546 my ($self, $ob) = @_;
1547
1548 return find "~" . $ob->name . "/" . $self->{path}
1549 if $self->per_player;
1550
1551 $self
1552}
1553
1554# find and load all maps in the 3x3 area around a map
1555sub load_diag {
724 my ($map) = @_; 1556 my ($map) = @_;
725 1557
726 my $path = $map->tmpname; 1558 my @diag; # diagonal neighbours
727 defined $path or return;
728 1559
729 unlink "$path.pst"; 1560 for (0 .. 3) {
730}; 1561 my $neigh = $map->tile_path ($_)
1562 or next;
1563 $neigh = find $neigh, $map
1564 or next;
1565 $neigh->load;
731 1566
732cf::map->attach (prio => -10000, package => cf::mapsupport::); 1567 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1568 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1569 }
733 1570
734############################################################################# 1571 for (@diag) {
735# load/save perl data associated with player->ob objects 1572 my $neigh = find @$_
736 1573 or next;
737sub all_objects(@) { 1574 $neigh->load;
738 @_, map all_objects ($_->inv), @_ 1575 }
739} 1576}
740 1577
741# TODO: compatibility cruft, remove when no longer needed 1578sub find_sync {
742cf::player->attach ( 1579 my ($path, $origin) = @_;
743 on_load => sub {
744 my ($pl, $path) = @_;
745 1580
746 for my $o (all_objects $pl->ob) { 1581 cf::sync_job { find $path, $origin }
747 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1582}
748 $o->set_ob_key_value ("_perl_data");
749 1583
750 %$o = %{ Storable::thaw pack "H*", $value }; 1584sub do_load_sync {
1585 my ($map) = @_;
1586
1587 cf::sync_job { $map->load };
1588}
1589
1590our %MAP_PREFETCH;
1591our $MAP_PREFETCHER = undef;
1592
1593sub find_async {
1594 my ($path, $origin) = @_;
1595
1596 $path = normalise $path, $origin && $origin->{path};
1597
1598 if (my $map = $cf::MAP{$path}) {
1599 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1600 }
1601
1602 undef $MAP_PREFETCH{$path};
1603 $MAP_PREFETCHER ||= cf::async {
1604 while (%MAP_PREFETCH) {
1605 for my $path (keys %MAP_PREFETCH) {
1606 my $map = find $path
1607 or next;
1608 $map->load;
1609
1610 delete $MAP_PREFETCH{$path};
751 } 1611 }
752 } 1612 }
1613 undef $MAP_PREFETCHER;
1614 };
1615 $MAP_PREFETCHER->prio (6);
1616
1617 ()
1618}
1619
1620sub save {
1621 my ($self) = @_;
1622
1623 my $lock = cf::lock_acquire "map_data:" . $self->path;
1624
1625 $self->{last_save} = $cf::RUNTIME;
1626
1627 return unless $self->dirty;
1628
1629 my $save = $self->save_path; utf8::encode $save;
1630 my $uniq = $self->uniq_path; utf8::encode $uniq;
1631
1632 $self->{load_path} = $save;
1633
1634 return if $self->{deny_save};
1635
1636 local $self->{last_access} = $self->last_access;#d#
1637
1638 cf::async {
1639 $_->contr->save for $self->players;
1640 };
1641
1642 if ($uniq) {
1643 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1644 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1645 } else {
1646 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
753 }, 1647 }
754); 1648}
755 1649
756############################################################################# 1650sub swap_out {
1651 my ($self) = @_;
757 1652
758=head2 CORE EXTENSIONS 1653 # save first because save cedes
1654 $self->save;
759 1655
760Functions and methods that extend core crossfire objects. 1656 my $lock = cf::lock_acquire "map_data:" . $self->path;
761 1657
762=head3 cf::player 1658 return if $self->players;
1659 return if $self->in_memory != cf::MAP_IN_MEMORY;
1660 return if $self->{deny_save};
1661
1662 $self->clear;
1663 $self->in_memory (cf::MAP_SWAPPED);
1664}
1665
1666sub reset_at {
1667 my ($self) = @_;
1668
1669 # TODO: safety, remove and allow resettable per-player maps
1670 return 1e99 if $self->isa ("ext::map_per_player");#d#
1671 return 1e99 if $self->{deny_reset};
1672
1673 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1674 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1675
1676 $time + $to
1677}
1678
1679sub should_reset {
1680 my ($self) = @_;
1681
1682 $self->reset_at <= $cf::RUNTIME
1683}
1684
1685sub reset {
1686 my ($self) = @_;
1687
1688 my $lock = cf::lock_acquire "map_data:$self->{path}";
1689
1690 return if $self->players;
1691 return if $self->isa ("ext::map_per_player");#d#
1692
1693 warn "resetting map ", $self->path;#d#
1694
1695 $self->in_memory (cf::MAP_SWAPPED);
1696
1697 # need to save uniques path
1698 unless ($self->{deny_save}) {
1699 my $uniq = $self->uniq_path; utf8::encode $uniq;
1700
1701 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1702 if $uniq;
1703 }
1704
1705 delete $cf::MAP{$self->path};
1706
1707 $self->clear;
1708
1709 $_->clear_links_to ($self) for values %cf::MAP;
1710
1711 $self->unlink_save;
1712 $self->destroy;
1713}
1714
1715my $nuke_counter = "aaaa";
1716
1717sub nuke {
1718 my ($self) = @_;
1719
1720 delete $cf::MAP{$self->path};
1721
1722 $self->unlink_save;
1723
1724 bless $self, "cf::map";
1725 delete $self->{deny_reset};
1726 $self->{deny_save} = 1;
1727 $self->reset_timeout (1);
1728 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1729
1730 $cf::MAP{$self->path} = $self;
1731
1732 $self->reset; # polite request, might not happen
1733}
1734
1735=item cf::map::unique_maps
1736
1737Returns an arrayref of paths of all shared maps that have
1738instantiated unique items. May block.
1739
1740=cut
1741
1742sub unique_maps() {
1743 my $files = aio_readdir $UNIQUEDIR
1744 or return;
1745
1746 my @paths;
1747
1748 for (@$files) {
1749 utf8::decode $_;
1750 next if /\.pst$/;
1751 next unless /^$PATH_SEP/o;
1752
1753 push @paths, cf::map::normalise $_;
1754 }
1755
1756 \@paths
1757}
1758
1759package cf;
1760
1761=back
1762
1763=head3 cf::object
1764
1765=cut
1766
1767package cf::object;
763 1768
764=over 4 1769=over 4
765 1770
766=item cf::player::exists $login 1771=item $ob->inv_recursive
767 1772
768Returns true when the given account exists. 1773Returns the inventory of the object _and_ their inventories, recursively.
769 1774
770=cut 1775=cut
771 1776
772sub cf::player::exists($) { 1777sub inv_recursive_;
773 cf::player::find $_[0] 1778sub inv_recursive_ {
774 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1779 map { $_, inv_recursive_ $_->inv } @_
775} 1780}
776 1781
777=item $player->ext_reply ($msgid, $msgtype, %msg) 1782sub inv_recursive {
778 1783 inv_recursive_ inv $_[0]
779Sends an ext reply to the player.
780
781=cut
782
783sub cf::player::ext_reply($$$%) {
784 my ($self, $id, %msg) = @_;
785
786 $msg{msgid} = $id;
787
788 $self->send ("ext " . to_json \%msg);
789} 1784}
1785
1786package cf;
790 1787
791=back 1788=back
792 1789
793=head3 cf::object::player 1790=head3 cf::object::player
794 1791
832 (ref $cf::CFG{"may_$access"} 1829 (ref $cf::CFG{"may_$access"}
833 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1830 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
834 : $cf::CFG{"may_$access"}) 1831 : $cf::CFG{"may_$access"})
835} 1832}
836 1833
1834=item $player_object->enter_link
1835
1836Freezes the player and moves him/her to a special map (C<{link}>).
1837
1838The player should be reasonably safe there for short amounts of time. You
1839I<MUST> call C<leave_link> as soon as possible, though.
1840
1841Will never block.
1842
1843=item $player_object->leave_link ($map, $x, $y)
1844
1845Moves the player out of the special C<{link}> map onto the specified
1846map. If the map is not valid (or omitted), the player will be moved back
1847to the location he/she was before the call to C<enter_link>, or, if that
1848fails, to the emergency map position.
1849
1850Might block.
1851
1852=cut
1853
1854sub link_map {
1855 unless ($LINK_MAP) {
1856 $LINK_MAP = cf::map::find "{link}"
1857 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1858 $LINK_MAP->load;
1859 }
1860
1861 $LINK_MAP
1862}
1863
1864sub cf::object::player::enter_link {
1865 my ($self) = @_;
1866
1867 $self->deactivate_recursive;
1868
1869 return if UNIVERSAL::isa $self->map, "ext::map_link";
1870
1871 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1872 if $self->map;
1873
1874 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1875}
1876
1877sub cf::object::player::leave_link {
1878 my ($self, $map, $x, $y) = @_;
1879
1880 my $link_pos = delete $self->{_link_pos};
1881
1882 unless ($map) {
1883 # restore original map position
1884 ($map, $x, $y) = @{ $link_pos || [] };
1885 $map = cf::map::find $map;
1886
1887 unless ($map) {
1888 ($map, $x, $y) = @$EMERGENCY_POSITION;
1889 $map = cf::map::find $map
1890 or die "FATAL: cannot load emergency map\n";
1891 }
1892 }
1893
1894 ($x, $y) = (-1, -1)
1895 unless (defined $x) && (defined $y);
1896
1897 # use -1 or undef as default coordinates, not 0, 0
1898 ($x, $y) = ($map->enter_x, $map->enter_y)
1899 if $x <=0 && $y <= 0;
1900
1901 $map->load;
1902 $map->load_diag;
1903
1904 return unless $self->contr->active;
1905 $self->activate_recursive;
1906
1907 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1908 $self->enter_map ($map, $x, $y);
1909}
1910
1911cf::player->attach (
1912 on_logout => sub {
1913 my ($pl) = @_;
1914
1915 # abort map switching before logout
1916 if ($pl->ob->{_link_pos}) {
1917 cf::sync_job {
1918 $pl->ob->leave_link
1919 };
1920 }
1921 },
1922 on_login => sub {
1923 my ($pl) = @_;
1924
1925 # try to abort aborted map switching on player login :)
1926 # should happen only on crashes
1927 if ($pl->ob->{_link_pos}) {
1928 $pl->ob->enter_link;
1929 (async {
1930 $pl->ob->reply (undef,
1931 "There was an internal problem at your last logout, "
1932 . "the server will try to bring you to your intended destination in a second.",
1933 cf::NDI_RED);
1934 # we need this sleep as the login has a concurrent enter_exit running
1935 # and this sleep increases chances of the player not ending up in scorn
1936 Coro::Timer::sleep 1;
1937 $pl->ob->leave_link;
1938 })->prio (2);
1939 }
1940 },
1941);
1942
1943=item $player_object->goto ($path, $x, $y)
1944
1945=cut
1946
1947sub cf::object::player::goto {
1948 my ($self, $path, $x, $y) = @_;
1949
1950 $self->enter_link;
1951
1952 (async {
1953 my $map = eval {
1954 my $map = cf::map::find $path;
1955 $map = $map->customise_for ($self) if $map;
1956 $map
1957 } or
1958 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1959
1960 $self->leave_link ($map, $x, $y);
1961 })->prio (1);
1962}
1963
1964=item $player_object->enter_exit ($exit_object)
1965
1966=cut
1967
1968sub parse_random_map_params {
1969 my ($spec) = @_;
1970
1971 my $rmp = { # defaults
1972 xsize => (cf::rndm 15, 40),
1973 ysize => (cf::rndm 15, 40),
1974 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1975 #layout => string,
1976 };
1977
1978 for (split /\n/, $spec) {
1979 my ($k, $v) = split /\s+/, $_, 2;
1980
1981 $rmp->{lc $k} = $v if (length $k) && (length $v);
1982 }
1983
1984 $rmp
1985}
1986
1987sub prepare_random_map {
1988 my ($exit) = @_;
1989
1990 my $guard = cf::lock_acquire "exit_prepare:$exit";
1991
1992 # all this does is basically replace the /! path by
1993 # a new random map path (?random/...) with a seed
1994 # that depends on the exit object
1995
1996 my $rmp = parse_random_map_params $exit->msg;
1997
1998 if ($exit->map) {
1999 $rmp->{region} = $exit->region->name;
2000 $rmp->{origin_map} = $exit->map->path;
2001 $rmp->{origin_x} = $exit->x;
2002 $rmp->{origin_y} = $exit->y;
2003 }
2004
2005 $rmp->{random_seed} ||= $exit->random_seed;
2006
2007 my $data = cf::to_json $rmp;
2008 my $md5 = Digest::MD5::md5_hex $data;
2009 my $meta = "$RANDOMDIR/$md5.meta";
2010
2011 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2012 aio_write $fh, 0, (length $data), $data, 0;
2013 undef $fh;
2014 aio_rename "$meta~", $meta;
2015
2016 $exit->slaying ("?random/$md5");
2017 $exit->msg (undef);
2018 }
2019}
2020
2021sub cf::object::player::enter_exit {
2022 my ($self, $exit) = @_;
2023
2024 return unless $self->type == cf::PLAYER;
2025
2026 if ($exit->slaying eq "/!") {
2027 #TODO: this should de-fi-ni-te-ly not be a sync-job
2028 # the problem is that $exit might not survive long enough
2029 # so it needs to be done right now, right here
2030 cf::sync_job { prepare_random_map $exit };
2031 }
2032
2033 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2034 my $hp = $exit->stats->hp;
2035 my $sp = $exit->stats->sp;
2036
2037 $self->enter_link;
2038
2039 (async {
2040 $self->deactivate_recursive; # just to be sure
2041 unless (eval {
2042 $self->goto ($slaying, $hp, $sp);
2043
2044 1;
2045 }) {
2046 $self->message ("Something went wrong deep within the crossfire server. "
2047 . "I'll try to bring you back to the map you were before. "
2048 . "Please report this to the dungeon master!",
2049 cf::NDI_UNIQUE | cf::NDI_RED);
2050
2051 warn "ERROR in enter_exit: $@";
2052 $self->leave_link;
2053 }
2054 })->prio (1);
2055}
2056
837=head3 cf::client 2057=head3 cf::client
838 2058
839=over 4 2059=over 4
840 2060
841=item $client->send_drawinfo ($text, $flags) 2061=item $client->send_drawinfo ($text, $flags)
847 2067
848sub cf::client::send_drawinfo { 2068sub cf::client::send_drawinfo {
849 my ($self, $text, $flags) = @_; 2069 my ($self, $text, $flags) = @_;
850 2070
851 utf8::encode $text; 2071 utf8::encode $text;
852 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2072 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
853} 2073}
854 2074
2075=item $client->ext_event ($type, %msg)
2076
2077Sends an exti event to the client.
2078
2079=cut
2080
2081sub cf::client::ext_event($$%) {
2082 my ($self, $type, %msg) = @_;
2083
2084 $msg{msgtype} = "event_$type";
2085 $self->send_packet ("ext " . cf::to_json \%msg);
2086}
855 2087
856=item $success = $client->query ($flags, "text", \&cb) 2088=item $success = $client->query ($flags, "text", \&cb)
857 2089
858Queues a query to the client, calling the given callback with 2090Queues a query to the client, calling the given callback with
859the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2091the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
884 on_reply => sub { 2116 on_reply => sub {
885 my ($ns, $msg) = @_; 2117 my ($ns, $msg) = @_;
886 2118
887 # this weird shuffling is so that direct followup queries 2119 # this weird shuffling is so that direct followup queries
888 # get handled first 2120 # get handled first
889 my $queue = delete $ns->{query_queue}; 2121 my $queue = delete $ns->{query_queue}
2122 or return; # be conservative, not sure how that can happen, but we saw a crash here
890 2123
891 (shift @$queue)->[1]->($msg); 2124 (shift @$queue)->[1]->($msg);
2125 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
892 2126
893 push @{ $ns->{query_queue} }, @$queue; 2127 push @{ $ns->{query_queue} }, @$queue;
894 2128
895 if (@{ $ns->{query_queue} } == @$queue) { 2129 if (@{ $ns->{query_queue} } == @$queue) {
896 if (@$queue) { 2130 if (@$queue) {
900 } 2134 }
901 } 2135 }
902 }, 2136 },
903); 2137);
904 2138
905=item $client->coro (\&cb) 2139=item $client->async (\&cb)
906 2140
907Create a new coroutine, running the specified callback. The coroutine will 2141Create a new coroutine, running the specified callback. The coroutine will
908be automatically cancelled when the client gets destroyed (e.g. on logout, 2142be automatically cancelled when the client gets destroyed (e.g. on logout,
909or loss of connection). 2143or loss of connection).
910 2144
911=cut 2145=cut
912 2146
913sub cf::client::coro { 2147sub cf::client::async {
914 my ($self, $cb) = @_; 2148 my ($self, $cb) = @_;
915 2149
916 my $coro; $coro = async { 2150 my $coro = &Coro::async ($cb);
917 eval { 2151
918 $cb->(); 2152 $coro->on_destroy (sub {
919 };
920 warn $@ if $@;
921 delete $self->{_coro}{$coro+0}; 2153 delete $self->{_coro}{$coro+0};
922 }; 2154 });
923 2155
924 $self->{_coro}{$coro+0} = $coro; 2156 $self->{_coro}{$coro+0} = $coro;
2157
2158 $coro
925} 2159}
926 2160
927cf::client->attach ( 2161cf::client->attach (
928 on_destroy => sub { 2162 on_destroy => sub {
929 my ($ns) = @_; 2163 my ($ns) = @_;
954 2188
955# here we export the classes and methods available to script code 2189# here we export the classes and methods available to script code
956 2190
957=pod 2191=pod
958 2192
959The following fucntions and emthods are available within a safe environment: 2193The following functions and methods are available within a safe environment:
960 2194
961 cf::object contr pay_amount pay_player map 2195 cf::object contr pay_amount pay_player map
962 cf::object::player player 2196 cf::object::player player
963 cf::player peaceful 2197 cf::player peaceful
964 cf::map trigger 2198 cf::map trigger
1049############################################################################# 2283#############################################################################
1050 2284
1051=head2 EXTENSION DATABASE SUPPORT 2285=head2 EXTENSION DATABASE SUPPORT
1052 2286
1053Crossfire maintains a very simple database for extension use. It can 2287Crossfire maintains a very simple database for extension use. It can
1054currently store anything that can be serialised using Storable, which 2288currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1055excludes objects. 2289convert to/from binary).
1056 2290
1057The parameter C<$family> should best start with the name of the extension 2291The parameter C<$family> should best start with the name of the extension
1058using it, it should be unique. 2292using it, it should be unique.
1059 2293
1060=over 4 2294=over 4
1061 2295
1062=item $hashref = cf::db_get $family
1063
1064Return a hashref for use by the extension C<$family>, which can be
1065modified. After modifications, you have to call C<cf::db_dirty> or
1066C<cf::db_sync>.
1067
1068=item $value = cf::db_get $family => $key 2296=item $value = cf::db_get $family => $key
1069 2297
1070Returns a single value from the database 2298Returns a single value from the database.
1071
1072=item cf::db_put $family => $hashref
1073
1074Stores the given family hashref into the database. Updates are delayed, if
1075you want the data to be synced to disk immediately, use C<cf::db_sync>.
1076 2299
1077=item cf::db_put $family => $key => $value 2300=item cf::db_put $family => $key => $value
1078 2301
1079Stores the given C<$value> in the family hash. Updates are delayed, if you 2302Stores the given C<$value> in the family.
1080want the data to be synced to disk immediately, use C<cf::db_sync>.
1081
1082=item cf::db_dirty
1083
1084Marks the database as dirty, to be updated at a later time.
1085
1086=item cf::db_sync
1087
1088Immediately write the database to disk I<if it is dirty>.
1089 2303
1090=cut 2304=cut
1091 2305
1092our $DB; 2306our $DB;
1093 2307
1094{ 2308sub db_init {
1095 my $path = cf::localdir . "/database.pst"; 2309 unless ($DB) {
2310 $DB = BDB::db_create $DB_ENV;
1096 2311
1097 sub db_load() { 2312 cf::sync_job {
1098 warn "loading database $path\n";#d# remove later 2313 eval {
1099 $DB = stat $path ? Storable::retrieve $path : { }; 2314 $DB->set_flags (BDB::CHKSUM);
1100 }
1101 2315
1102 my $pid; 2316 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1103 2317 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1104 sub db_save() { 2318 cf::cleanup "db_open(db): $!" if $!;
1105 warn "saving database $path\n";#d# remove later 2319 };
1106 waitpid $pid, 0 if $pid; 2320 cf::cleanup "db_open(db): $@" if $@;
1107 if (0 == ($pid = fork)) {
1108 $DB->{_meta}{version} = 1;
1109 Storable::nstore $DB, "$path~";
1110 rename "$path~", $path;
1111 cf::_exit 0 if defined $pid;
1112 } 2321 };
1113 }
1114
1115 my $dirty;
1116
1117 sub db_sync() {
1118 db_save if $dirty;
1119 undef $dirty;
1120 }
1121
1122 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1123 db_sync;
1124 }); 2322 }
2323}
1125 2324
1126 sub db_dirty() {
1127 $dirty = 1;
1128 $idle->start;
1129 }
1130
1131 sub db_get($;$) { 2325sub db_get($$) {
1132 @_ >= 2 2326 my $key = "$_[0]/$_[1]";
1133 ? $DB->{$_[0]}{$_[1]}
1134 : ($DB->{$_[0]} ||= { })
1135 }
1136 2327
2328 cf::sync_job {
2329 BDB::db_get $DB, undef, $key, my $data;
2330
2331 $! ? ()
2332 : $data
2333 }
2334}
2335
1137 sub db_put($$;$) { 2336sub db_put($$$) {
1138 if (@_ >= 3) { 2337 BDB::dbreq_pri 4;
1139 $DB->{$_[0]}{$_[1]} = $_[2]; 2338 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1140 } else { 2339}
1141 $DB->{$_[0]} = $_[1];
1142 }
1143 db_dirty;
1144 }
1145 2340
1146 cf::global->attach ( 2341=item cf::cache $id => [$paths...], $processversion => $process
1147 prio => 10000, 2342
1148 on_cleanup => sub { 2343Generic caching function that returns the value of the resource $id,
1149 db_sync; 2344caching and regenerating as required.
2345
2346This function can block.
2347
2348=cut
2349
2350sub cache {
2351 my ($id, $src, $processversion, $process) = @_;
2352
2353 my $meta =
2354 join "\x00",
2355 $processversion,
2356 map {
2357 aio_stat $_
2358 and Carp::croak "$_: $!";
2359
2360 ($_, (stat _)[7,9])
2361 } @$src;
2362
2363 my $dbmeta = db_get cache => "$id/meta";
2364 if ($dbmeta ne $meta) {
2365 # changed, we may need to process
2366
2367 my @data;
2368 my $md5;
2369
2370 for (0 .. $#$src) {
2371 0 <= aio_load $src->[$_], $data[$_]
2372 or Carp::croak "$src->[$_]: $!";
1150 }, 2373 }
1151 ); 2374
2375 # if processing is expensive, check
2376 # checksum first
2377 if (1) {
2378 $md5 =
2379 join "\x00",
2380 $processversion,
2381 map {
2382 Coro::cede;
2383 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2384 } 0.. $#$src;
2385
2386
2387 my $dbmd5 = db_get cache => "$id/md5";
2388 if ($dbmd5 eq $md5) {
2389 db_put cache => "$id/meta", $meta;
2390
2391 return db_get cache => "$id/data";
2392 }
2393 }
2394
2395 my $t1 = Time::HiRes::time;
2396 my $data = $process->(\@data);
2397 my $t2 = Time::HiRes::time;
2398
2399 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2400
2401 db_put cache => "$id/data", $data;
2402 db_put cache => "$id/md5" , $md5;
2403 db_put cache => "$id/meta", $meta;
2404
2405 return $data;
2406 }
2407
2408 db_get cache => "$id/data"
1152} 2409}
2410
2411=item fork_call { }, $args
2412
2413Executes the given code block with the given arguments in a seperate
2414process, returning the results. Everything must be serialisable with
2415Coro::Storable. May, of course, block. Note that the executed sub may
2416never block itself or use any form of Event handling.
2417
2418=cut
2419
2420sub fork_call(&@) {
2421 my ($cb, @args) = @_;
2422
2423# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2424# or die "socketpair: $!";
2425 pipe my $fh1, my $fh2
2426 or die "pipe: $!";
2427
2428 if (my $pid = fork) {
2429 close $fh2;
2430
2431 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2432 $res = Coro::Storable::thaw $res;
2433
2434 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2435
2436 die $$res unless "ARRAY" eq ref $res;
2437
2438 return wantarray ? @$res : $res->[-1];
2439 } else {
2440 reset_signals;
2441 local $SIG{__WARN__};
2442 local $SIG{__DIE__};
2443 eval {
2444 close $fh1;
2445
2446 my @res = eval { $cb->(@args) };
2447 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2448 };
2449
2450 warn $@ if $@;
2451 _exit 0;
2452 }
2453}
2454
2455
1153 2456
1154############################################################################# 2457#############################################################################
1155# the server's main() 2458# the server's init and main functions
2459
2460sub load_facedata($) {
2461 my ($path) = @_;
2462
2463 warn "loading facedata from $path\n";
2464
2465 my $facedata;
2466 0 < aio_load $path, $facedata
2467 or die "$path: $!";
2468
2469 $facedata = Coro::Storable::thaw $facedata;
2470
2471 $facedata->{version} == 2
2472 or cf::cleanup "$path: version mismatch, cannot proceed.";
2473
2474 {
2475 my $faces = $facedata->{faceinfo};
2476
2477 while (my ($face, $info) = each %$faces) {
2478 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2479 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2480 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2481 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2482 Coro::cede;
2483 }
2484
2485 while (my ($face, $info) = each %$faces) {
2486 next unless $info->{smooth};
2487 my $idx = cf::face::find $face
2488 or next;
2489 if (my $smooth = cf::face::find $info->{smooth}) {
2490 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2491 } else {
2492 warn "smooth face '$info->{smooth}' not found for face '$face'";
2493 }
2494 Coro::cede;
2495 }
2496 }
2497
2498 {
2499 my $anims = $facedata->{animinfo};
2500
2501 while (my ($anim, $info) = each %$anims) {
2502 cf::anim::set $anim, $info->{frames}, $info->{facings};
2503 Coro::cede;
2504 }
2505
2506 cf::anim::invalidate_all; # d'oh
2507 }
2508
2509 1
2510}
2511
2512sub reload_regions {
2513 load_resource_file "$MAPDIR/regions"
2514 or die "unable to load regions file\n";
2515}
2516
2517sub reload_facedata {
2518 load_facedata "$DATADIR/facedata"
2519 or die "unable to load facedata\n";
2520}
2521
2522sub reload_archetypes {
2523 load_resource_file "$DATADIR/archetypes"
2524 or die "unable to load archetypes\n";
2525}
2526
2527sub reload_treasures {
2528 load_resource_file "$DATADIR/treasures"
2529 or die "unable to load treasurelists\n";
2530}
2531
2532sub reload_resources {
2533 warn "reloading resource files...\n";
2534
2535 reload_regions;
2536 reload_facedata;
2537 reload_archetypes;
2538 reload_treasures;
2539
2540 warn "finished reloading resource files\n";
2541}
2542
2543sub init {
2544 reload_resources;
2545}
1156 2546
1157sub cfg_load { 2547sub cfg_load {
1158 open my $fh, "<:utf8", cf::confdir . "/config" 2548 open my $fh, "<:utf8", "$CONFDIR/config"
1159 or return; 2549 or return;
1160 2550
1161 local $/; 2551 local $/;
1162 *CFG = YAML::Syck::Load <$fh>; 2552 *CFG = YAML::Syck::Load <$fh>;
2553
2554 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2555
2556 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2557 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2558
2559 if (exists $CFG{mlockall}) {
2560 eval {
2561 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2562 and die "WARNING: m(un)lockall failed: $!\n";
2563 };
2564 warn $@ if $@;
2565 }
1163} 2566}
1164 2567
1165sub main { 2568sub main {
2569 # we must not ever block the main coroutine
2570 local $Coro::idle = sub {
2571 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2572 (async {
2573 Event::one_event;
2574 })->prio (Coro::PRIO_MAX);
2575 };
2576
1166 cfg_load; 2577 cfg_load;
1167 db_load; 2578 db_init;
1168 load_extensions; 2579 load_extensions;
2580
2581 $TICK_WATCHER->start;
1169 Event::loop; 2582 Event::loop;
1170} 2583}
1171 2584
1172############################################################################# 2585#############################################################################
1173# initialisation 2586# initialisation and cleanup
1174 2587
1175sub _perl_reload(&) { 2588# install some emergency cleanup handlers
2589BEGIN {
2590 for my $signal (qw(INT HUP TERM)) {
2591 Event->signal (
2592 reentrant => 0,
2593 data => WF_AUTOCANCEL,
2594 signal => $signal,
2595 prio => 0,
2596 cb => sub {
2597 cf::cleanup "SIG$signal";
2598 },
2599 );
2600 }
2601}
2602
2603sub emergency_save() {
2604 my $freeze_guard = cf::freeze_mainloop;
2605
2606 warn "enter emergency perl save\n";
2607
2608 cf::sync_job {
2609 # use a peculiar iteration method to avoid tripping on perl
2610 # refcount bugs in for. also avoids problems with players
2611 # and maps saved/destroyed asynchronously.
2612 warn "begin emergency player save\n";
2613 for my $login (keys %cf::PLAYER) {
2614 my $pl = $cf::PLAYER{$login} or next;
2615 $pl->valid or next;
2616 $pl->save;
2617 }
2618 warn "end emergency player save\n";
2619
2620 warn "begin emergency map save\n";
2621 for my $path (keys %cf::MAP) {
2622 my $map = $cf::MAP{$path} or next;
2623 $map->valid or next;
2624 $map->save;
2625 }
2626 warn "end emergency map save\n";
2627
2628 warn "begin emergency database checkpoint\n";
2629 BDB::db_env_txn_checkpoint $DB_ENV;
2630 warn "end emergency database checkpoint\n";
2631 };
2632
2633 warn "leave emergency perl save\n";
2634}
2635
2636sub post_cleanup {
1176 my ($msg) = @_; 2637 my ($make_core) = @_;
1177 2638
1178 $msg->("reloading..."); 2639 warn Carp::longmess "post_cleanup backtrace"
2640 if $make_core;
2641}
1179 2642
1180 eval { 2643sub do_reload_perl() {
1181 # cancel all watchers 2644 # can/must only be called in main
2645 if ($Coro::current != $Coro::main) {
2646 warn "can only reload from main coroutine";
2647 return;
2648 }
2649
2650 warn "reloading...";
2651
2652 warn "entering sync_job";
2653
2654 cf::sync_job {
2655 cf::write_runtime; # external watchdog should not bark
2656 cf::emergency_save;
2657 cf::write_runtime; # external watchdog should not bark
2658
2659 warn "syncing database to disk";
2660 BDB::db_env_txn_checkpoint $DB_ENV;
2661
2662 # if anything goes wrong in here, we should simply crash as we already saved
2663
2664 warn "cancelling all WF_AUTOCANCEL watchers";
1182 for (Event::all_watchers) { 2665 for (Event::all_watchers) {
1183 $_->cancel if $_->data & WF_AUTOCANCEL; 2666 $_->cancel if $_->data & WF_AUTOCANCEL;
1184 } 2667 }
1185 2668
1186 # unload all extensions 2669 warn "flushing outstanding aio requests";
1187 for (@exts) { 2670 for (;;) {
1188 $msg->("unloading <$_>"); 2671 BDB::flush;
1189 unload_extension $_; 2672 IO::AIO::flush;
2673 Coro::cede;
2674 last unless IO::AIO::nreqs || BDB::nreqs;
2675 warn "iterate...";
2676 }
2677
2678 ++$RELOAD;
2679
2680 warn "cancelling all extension coros";
2681 $_->cancel for values %EXT_CORO;
2682 %EXT_CORO = ();
2683
2684 warn "removing commands";
2685 %COMMAND = ();
2686
2687 warn "removing ext commands";
2688 %EXTCMD = ();
2689
2690 warn "unloading/nuking all extensions";
2691 for my $pkg (@EXTS) {
2692 warn "... unloading $pkg";
2693
2694 if (my $cb = $pkg->can ("unload")) {
2695 eval {
2696 $cb->($pkg);
2697 1
2698 } or warn "$pkg unloaded, but with errors: $@";
1190 } 2699 }
1191 2700
2701 warn "... nuking $pkg";
2702 Symbol::delete_package $pkg;
2703 }
2704
1192 # unload all modules loaded from $LIBDIR 2705 warn "unloading all perl modules loaded from $LIBDIR";
1193 while (my ($k, $v) = each %INC) { 2706 while (my ($k, $v) = each %INC) {
1194 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2707 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1195 2708
1196 $msg->("removing <$k>"); 2709 warn "... unloading $k";
1197 delete $INC{$k}; 2710 delete $INC{$k};
1198 2711
1199 $k =~ s/\.pm$//; 2712 $k =~ s/\.pm$//;
1200 $k =~ s/\//::/g; 2713 $k =~ s/\//::/g;
1201 2714
1204 } 2717 }
1205 2718
1206 Symbol::delete_package $k; 2719 Symbol::delete_package $k;
1207 } 2720 }
1208 2721
1209 # sync database to disk
1210 cf::db_sync;
1211
1212 # get rid of safe::, as good as possible 2722 warn "getting rid of safe::, as good as possible";
1213 Symbol::delete_package "safe::$_" 2723 Symbol::delete_package "safe::$_"
1214 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2724 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1215 2725
1216 # remove register_script_function callbacks
1217 # TODO
1218
1219 # unload cf.pm "a bit" 2726 warn "unloading cf.pm \"a bit\"";
1220 delete $INC{"cf.pm"}; 2727 delete $INC{"cf.pm"};
2728 delete $INC{"cf/pod.pm"};
1221 2729
1222 # don't, removes xs symbols, too, 2730 # don't, removes xs symbols, too,
1223 # and global variables created in xs 2731 # and global variables created in xs
1224 #Symbol::delete_package __PACKAGE__; 2732 #Symbol::delete_package __PACKAGE__;
1225 2733
1226 # reload cf.pm 2734 warn "unload completed, starting to reload now";
2735
1227 $msg->("reloading cf.pm"); 2736 warn "reloading cf.pm";
1228 require cf; 2737 require cf;
1229 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2738 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1230 2739
1231 # load config and database again 2740 warn "loading config and database again";
1232 cf::cfg_load; 2741 cf::cfg_load;
1233 cf::db_load;
1234 2742
1235 # load extensions 2743 warn "loading extensions";
1236 $msg->("load extensions");
1237 cf::load_extensions; 2744 cf::load_extensions;
1238 2745
1239 # reattach attachments to objects 2746 warn "reattaching attachments to objects/players";
1240 $msg->("reattach"); 2747 _global_reattach; # objects, sockets
1241 _global_reattach; 2748 warn "reattaching attachments to maps";
2749 reattach $_ for values %MAP;
2750 warn "reattaching attachments to players";
2751 reattach $_ for values %PLAYER;
2752
2753 warn "leaving sync_job";
2754
2755 1
2756 } or do {
2757 warn $@;
2758 warn "error while reloading, exiting.";
2759 exit 1;
1242 }; 2760 };
1243 $msg->($@) if $@;
1244 2761
1245 $msg->("reloaded"); 2762 warn "reloaded";
1246}; 2763};
1247 2764
1248sub perl_reload() { 2765our $RELOAD_WATCHER; # used only during reload
1249 _perl_reload { 2766
1250 warn $_[0]; 2767sub reload_perl() {
1251 print "$_[0]\n"; 2768 # doing reload synchronously and two reloads happen back-to-back,
2769 # coro crashes during coro_state_free->destroy here.
2770
2771 $RELOAD_WATCHER ||= Event->timer (
2772 reentrant => 0,
2773 after => 0,
2774 data => WF_AUTOCANCEL,
2775 cb => sub {
2776 do_reload_perl;
2777 undef $RELOAD_WATCHER;
2778 },
1252 }; 2779 );
1253} 2780}
1254 2781
1255register "<global>", __PACKAGE__;
1256
1257register_command "perl-reload" => sub { 2782register_command "reload" => sub {
1258 my ($who, $arg) = @_; 2783 my ($who, $arg) = @_;
1259 2784
1260 if ($who->flag (FLAG_WIZ)) { 2785 if ($who->flag (FLAG_WIZ)) {
1261 _perl_reload { 2786 $who->message ("reloading server.");
1262 warn $_[0]; 2787 async { reload_perl };
1263 $who->message ($_[0]);
1264 };
1265 } 2788 }
1266}; 2789};
1267 2790
1268unshift @INC, $LIBDIR; 2791unshift @INC, $LIBDIR;
1269 2792
2793my $bug_warning = 0;
2794
2795our @WAIT_FOR_TICK;
2796our @WAIT_FOR_TICK_BEGIN;
2797
2798sub wait_for_tick {
2799 return unless $TICK_WATCHER->is_active;
2800 return if $Coro::current == $Coro::main;
2801
2802 my $signal = new Coro::Signal;
2803 push @WAIT_FOR_TICK, $signal;
2804 $signal->wait;
2805}
2806
2807sub wait_for_tick_begin {
2808 return unless $TICK_WATCHER->is_active;
2809 return if $Coro::current == $Coro::main;
2810
2811 my $signal = new Coro::Signal;
2812 push @WAIT_FOR_TICK_BEGIN, $signal;
2813 $signal->wait;
2814}
2815
1270$TICK_WATCHER = Event->timer ( 2816$TICK_WATCHER = Event->timer (
2817 reentrant => 0,
2818 parked => 1,
1271 prio => 0, 2819 prio => 0,
1272 at => $NEXT_TICK || 1, 2820 at => $NEXT_TICK || $TICK,
1273 data => WF_AUTOCANCEL, 2821 data => WF_AUTOCANCEL,
1274 cb => sub { 2822 cb => sub {
2823 if ($Coro::current != $Coro::main) {
2824 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2825 unless ++$bug_warning > 10;
2826 return;
2827 }
2828
2829 $NOW = Event::time;
2830
1275 cf::server_tick; # one server iteration 2831 cf::server_tick; # one server iteration
1276 2832
1277 my $NOW = Event::time; 2833 $RUNTIME += $TICK;
1278 $NEXT_TICK += $TICK; 2834 $NEXT_TICK += $TICK;
1279 2835
2836 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2837 $NEXT_RUNTIME_WRITE = $NOW + 10;
2838 Coro::async_pool {
2839 write_runtime
2840 or warn "ERROR: unable to write runtime file: $!";
2841 };
2842 }
2843
2844# my $AFTER = Event::time;
2845# warn $AFTER - $NOW;#d#
2846
1280 # if we are delayed by four ticks or more, skip them all 2847 # if we are delayed by four ticks or more, skip them all
1281 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2848 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1282 2849
1283 $TICK_WATCHER->at ($NEXT_TICK); 2850 $TICK_WATCHER->at ($NEXT_TICK);
1284 $TICK_WATCHER->start; 2851 $TICK_WATCHER->start;
2852
2853 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2854 $sig->send;
2855 }
2856 while (my $sig = shift @WAIT_FOR_TICK) {
2857 $sig->send;
2858 }
2859
2860 _post_tick;
1285 }, 2861 },
1286); 2862);
1287 2863
2864{
2865 BDB::max_poll_time $TICK * 0.1;
2866 $BDB_POLL_WATCHER = Event->io (
2867 reentrant => 0,
2868 fd => BDB::poll_fileno,
2869 poll => 'r',
2870 prio => 0,
2871 data => WF_AUTOCANCEL,
2872 cb => \&BDB::poll_cb,
2873 );
2874 BDB::min_parallel 8;
2875
2876 BDB::set_sync_prepare {
2877 my $status;
2878 my $current = $Coro::current;
2879 (
2880 sub {
2881 $status = $!;
2882 $current->ready; undef $current;
2883 },
2884 sub {
2885 Coro::schedule while defined $current;
2886 $! = $status;
2887 },
2888 )
2889 };
2890
2891 unless ($DB_ENV) {
2892 $DB_ENV = BDB::db_env_create;
2893
2894 cf::sync_job {
2895 eval {
2896 BDB::db_env_open
2897 $DB_ENV,
2898 $BDBDIR,
2899 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2900 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2901 0666;
2902
2903 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2904
2905 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2906 $DB_ENV->set_lk_detect;
2907 };
2908
2909 cf::cleanup "db_env_open(db): $@" if $@;
2910 };
2911 }
2912}
2913
2914{
2915 IO::AIO::min_parallel 8;
2916
2917 undef $Coro::AIO::WATCHER;
1288IO::AIO::max_poll_time $TICK * 0.2; 2918 IO::AIO::max_poll_time $TICK * 0.1;
1289 2919 $AIO_POLL_WATCHER = Event->io (
1290Event->io (fd => IO::AIO::poll_fileno, 2920 reentrant => 0,
1291 poll => 'r',
1292 prio => 5,
1293 data => WF_AUTOCANCEL, 2921 data => WF_AUTOCANCEL,
2922 fd => IO::AIO::poll_fileno,
2923 poll => 'r',
2924 prio => 6,
1294 cb => \&IO::AIO::poll_cb); 2925 cb => \&IO::AIO::poll_cb,
2926 );
2927}
2928
2929my $_log_backtrace;
2930
2931sub _log_backtrace {
2932 my ($msg, @addr) = @_;
2933
2934 $msg =~ s/\n//;
2935
2936 # limit the # of concurrent backtraces
2937 if ($_log_backtrace < 2) {
2938 ++$_log_backtrace;
2939 async {
2940 my @bt = fork_call {
2941 @addr = map { sprintf "%x", $_ } @addr;
2942 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
2943 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
2944 or die "addr2line: $!";
2945
2946 my @funcs;
2947 my @res = <$fh>;
2948 chomp for @res;
2949 while (@res) {
2950 my ($func, $line) = splice @res, 0, 2, ();
2951 push @funcs, "[$func] $line";
2952 }
2953
2954 @funcs
2955 };
2956
2957 LOG llevInfo, "[ABT] $msg\n";
2958 LOG llevInfo, "[ABT] $_\n" for @bt;
2959 --$_log_backtrace;
2960 };
2961 } else {
2962 LOG llevInfo, "[ABT] $msg\n";
2963 LOG llevInfo, "[ABT] [suppressed]\n";
2964 }
2965}
2966
2967# load additional modules
2968use cf::pod;
2969
2970END { cf::emergency_save }
1295 2971
12961 29721
1297 2973

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines