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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines