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.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.252 by root, Wed Apr 18 15:28:18 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;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use BDB ();
26use Data::Dumper;
27use Digest::MD5;
20use Fcntl; 28use Fcntl;
21use IO::AIO 2.31 ();
22use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
23use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
24 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
25use 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
26 41
27# 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?
28$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
29 44
30$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
31 46
32sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33 48
34our %COMMAND = (); 49our %COMMAND = ();
35our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
36our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
37 56
57our $RELOAD; # number of reloads so far
38our @EVENT; 58our @EVENT;
39our $LIBDIR = datadir . "/ext"; 59our $LIBDIR = datadir . "/ext";
40 60
41our $TICK = MAX_TIME * 1e-6; 61our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
42our $TICK_WATCHER; 62our $TICK_WATCHER;
63our $AIO_POLL_WATCHER;
64our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43our $NEXT_TICK; 65our $NEXT_TICK;
44our $NOW; 66our $NOW;
67our $USE_FSYNC = 1; # use fsync to write maps - default off
68
69our $BDB_POLL_WATCHER;
70our $DB_ENV;
45 71
46our %CFG; 72our %CFG;
47 73
48our $UPTIME; $UPTIME ||= time; 74our $UPTIME; $UPTIME ||= time;
49our $RUNTIME; 75our $RUNTIME;
50 76
77our %PLAYER; # all users
51our %MAP; # all maps 78our %MAP; # all maps
52our $LINK_MAP; # the special {link} map 79our $LINK_MAP; # the special {link} map, which is always available
53our $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
54 85
55binmode STDOUT; 86binmode STDOUT;
56binmode STDERR; 87binmode STDERR;
57 88
58# read virtual server time, if available 89# read virtual server time, if available
64 95
65mkdir cf::localdir; 96mkdir cf::localdir;
66mkdir cf::localdir . "/" . cf::playerdir; 97mkdir cf::localdir . "/" . cf::playerdir;
67mkdir cf::localdir . "/" . cf::tmpdir; 98mkdir cf::localdir . "/" . cf::tmpdir;
68mkdir cf::localdir . "/" . cf::uniquedir; 99mkdir cf::localdir . "/" . cf::uniquedir;
100mkdir $RANDOM_MAPS;
101mkdir $BDB_ENV_DIR;
69 102
70our %EXT_CORO; 103our $EMERGENCY_POSITION;
104
105sub cf::map::normalise;
71 106
72############################################################################# 107#############################################################################
73 108
74=head2 GLOBAL VARIABLES 109=head2 GLOBAL VARIABLES
75 110
99 134
100=item %cf::CFG 135=item %cf::CFG
101 136
102Configuration for the server, loaded from C</etc/crossfire/config>, or 137Configuration for the server, loaded from C</etc/crossfire/config>, or
103from 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.
104 145
105=back 146=back
106 147
107=cut 148=cut
108 149
109BEGIN { 150BEGIN {
110 *CORE::GLOBAL::warn = sub { 151 *CORE::GLOBAL::warn = sub {
111 my $msg = join "", @_; 152 my $msg = join "", @_;
112 utf8::encode $msg;
113 153
114 $msg .= "\n" 154 $msg .= "\n"
115 unless $msg =~ /\n$/; 155 unless $msg =~ /\n$/;
116 156
157 $msg =~ s/([\x00-\x09\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
158
159 utf8::encode $msg;
117 LOG llevError, "cfperl: $msg"; 160 LOG llevError, $msg;
118 }; 161 };
119} 162}
120 163
121@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 164@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 165@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
140 183
141$Event::DIED = sub { 184$Event::DIED = sub {
142 warn "error in event callback: @_"; 185 warn "error in event callback: @_";
143}; 186};
144 187
145my %ext_pkg;
146my @exts;
147my @hook;
148
149=head2 UTILITY FUNCTIONS 188=head2 UTILITY FUNCTIONS
150 189
151=over 4 190=over 4
152 191
153=cut 192=item dumpval $ref
154 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
155use JSON::Syck (); # TODO# replace by JSON::PC once working 215use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
156 216
157=item $ref = cf::from_json $json 217=item $ref = cf::from_json $json
158 218
159Converts a JSON string into the corresponding perl data structure. 219Converts a JSON string into the corresponding perl data structure.
160 220
161=cut
162
163sub from_json($) {
164 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
165 JSON::Syck::Load $_[0]
166}
167
168=item $json = cf::to_json $ref 221=item $json = cf::to_json $ref
169 222
170Converts a perl data structure into its JSON representation. 223Converts a perl data structure into its JSON representation.
171 224
172=cut 225=item cf::lock_wait $string
173 226
174sub to_json($) { 227Wait until the given lock is available. See cf::lock_acquire.
175 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
176 JSON::Syck::Dump $_[0]
177}
178 228
179# main coro must never ever "block" except in Event 229=item my $lock = cf::lock_acquire $string
180# sync_job ensures this by running the job in a coroutine 230
181# and waiting in Event while the server is otherwise frozen 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
182sub sync_job(&) { 300sub sync_job(&) {
183 my ($job) = @_; 301 my ($job) = @_;
184 302
185 my $busy = 1;
186 my @res;
187
188 local $FREEZE = 1;
189
190 my $coro = Coro::async {
191 @res = eval { $job->() };
192 warn $@ if $@;
193 undef $busy;
194 };
195
196 if ($Coro::current == $Coro::main) { 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;
197 $coro->prio (Coro::PRIO_MAX); 318 })->prio (Coro::PRIO_MAX);
319
198 while ($busy) { 320 while ($busy) {
199 Coro::cede_notself; 321 Coro::cede or Event::one_event;
200 Event::one_event unless Coro::nready;
201 } 322 }
323
324 wantarray ? @res : $res[0]
202 } else { 325 } else {
203 $coro->join; 326 # we are in another coroutine, how wonderful, everything just works
327
328 $job->()
204 } 329 }
205
206 wantarray ? @res : $res[0]
207} 330}
208 331
209=item $coro = cf::coro { BLOCK } 332=item $coro = cf::async_ext { BLOCK }
210 333
211Creates and returns a new coro. This coro is automcatially being canceled 334Like async, but this coro is automatically being canceled when the
212when the extension calling this is being unloaded. 335extension calling this is being unloaded.
213 336
214=cut 337=cut
215 338
216sub coro(&) { 339sub async_ext(&) {
217 my $cb = shift; 340 my $cb = shift;
218 341
219 my $coro; $coro = async { 342 my $coro = &Coro::async ($cb);
220 eval {
221 $cb->();
222 };
223 warn $@ if $@;
224 };
225 343
226 $coro->on_destroy (sub { 344 $coro->on_destroy (sub {
227 delete $EXT_CORO{$coro+0}; 345 delete $EXT_CORO{$coro+0};
228 }); 346 });
229 $EXT_CORO{$coro+0} = $coro; 347 $EXT_CORO{$coro+0} = $coro;
230 348
231 $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 });
232} 389}
233 390
234=back 391=back
235 392
236=cut 393=cut
367our @CB_TYPE = (); # registry for type (cf-object class) based events 524our @CB_TYPE = (); # registry for type (cf-object class) based events
368our @CB_MAP = (); 525our @CB_MAP = ();
369 526
370my %attachment; 527my %attachment;
371 528
529sub cf::attachable::thawer_merge {
530 # simply override everything except _meta
531 local $_[0]{_meta};
532 %{$_[0]} = %{$_[1]};
533}
534
372sub _attach_cb($$$$) { 535sub _attach_cb($$$$) {
373 my ($registry, $event, $prio, $cb) = @_; 536 my ($registry, $event, $prio, $cb) = @_;
374 537
375 use sort 'stable'; 538 use sort 'stable';
376 539
547# object support 710# object support
548 711
549sub reattach { 712sub reattach {
550 # basically do the same as instantiate, without calling instantiate 713 # basically do the same as instantiate, without calling instantiate
551 my ($obj) = @_; 714 my ($obj) = @_;
715
716 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
552 717
553 my $registry = $obj->registry; 718 my $registry = $obj->registry;
554 719
555 @$registry = (); 720 @$registry = ();
556 721
603 $filename, length $$rdata, scalar @$objs; 768 $filename, length $$rdata, scalar @$objs;
604 769
605 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 770 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
606 chmod SAVE_MODE, $fh; 771 chmod SAVE_MODE, $fh;
607 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 772 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
608 aio_fsync $fh; 773 aio_fsync $fh if $cf::USE_FSYNC;
609 close $fh; 774 close $fh;
610 775
611 if (@$objs) { 776 if (@$objs) {
612 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 777 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
613 chmod SAVE_MODE, $fh; 778 chmod SAVE_MODE, $fh;
614 my $data = Storable::nfreeze { version => 1, objs => $objs }; 779 my $data = Storable::nfreeze { version => 1, objs => $objs };
615 aio_write $fh, 0, (length $data), $data, 0; 780 aio_write $fh, 0, (length $data), $data, 0;
616 aio_fsync $fh; 781 aio_fsync $fh if $cf::USE_FSYNC;
617 close $fh; 782 close $fh;
618 aio_rename "$filename.pst~", "$filename.pst"; 783 aio_rename "$filename.pst~", "$filename.pst";
619 } 784 }
620 } else { 785 } else {
621 aio_unlink "$filename.pst"; 786 aio_unlink "$filename.pst";
649 or return; 814 or return;
650 815
651 unless (aio_stat "$filename.pst") { 816 unless (aio_stat "$filename.pst") {
652 (aio_load "$filename.pst", $av) >= 0 817 (aio_load "$filename.pst", $av) >= 0
653 or return; 818 or return;
654 $av = eval { (Storable::thaw <$av>)->{objs} }; 819 $av = eval { (Storable::thaw $av)->{objs} };
655 } 820 }
656 821
822 warn sprintf "loading %s (%d)\n",
823 $filename, length $data, scalar @{$av || []};#d#
657 return ($data, $av); 824 return ($data, $av);
658} 825}
659 826
660############################################################################# 827#############################################################################
661# command handling &c 828# command handling &c
686=cut 853=cut
687 854
688sub register_extcmd { 855sub register_extcmd {
689 my ($name, $cb) = @_; 856 my ($name, $cb) = @_;
690 857
691 my $caller = caller;
692 #warn "registering extcmd '$name' to '$caller'";
693
694 $EXTCMD{$name} = [$cb, $caller]; 858 $EXTCMD{$name} = $cb;
695} 859}
696 860
697cf::player->attach ( 861cf::player->attach (
698 on_command => sub { 862 on_command => sub {
699 my ($pl, $name, $params) = @_; 863 my ($pl, $name, $params) = @_;
712 876
713 my $msg = eval { from_json $buf }; 877 my $msg = eval { from_json $buf };
714 878
715 if (ref $msg) { 879 if (ref $msg) {
716 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 880 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
717 if (my %reply = $cb->[0]->($pl, $msg)) { 881 if (my %reply = $cb->($pl, $msg)) {
718 $pl->ext_reply ($msg->{msgid}, %reply); 882 $pl->ext_reply ($msg->{msgid}, %reply);
719 } 883 }
720 } 884 }
721 } else { 885 } else {
722 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 886 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
724 888
725 cf::override; 889 cf::override;
726 }, 890 },
727); 891);
728 892
729sub register {
730 my ($base, $pkg) = @_;
731
732 #TODO
733}
734
735sub load_extension { 893sub load_extension {
736 my ($path) = @_; 894 my ($path) = @_;
737 895
738 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 896 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
739 my $base = $1; 897 my $base = $1;
740 my $pkg = $1; 898 my $pkg = $1;
741 $pkg =~ s/[^[:word:]]/_/g; 899 $pkg =~ s/[^[:word:]]/_/g;
742 $pkg = "ext::$pkg"; 900 $pkg = "ext::$pkg";
743 901
744 warn "loading '$path' into '$pkg'\n"; 902 warn "... loading '$path' into '$pkg'\n";
745 903
746 open my $fh, "<:utf8", $path 904 open my $fh, "<:utf8", $path
747 or die "$path: $!"; 905 or die "$path: $!";
748 906
749 my $source = 907 my $source =
750 "package $pkg; use strict; use utf8;\n" 908 "package $pkg; use strict; use utf8;\n"
751 . "#line 1 \"$path\"\n{\n" 909 . "#line 1 \"$path\"\n{\n"
752 . (do { local $/; <$fh> }) 910 . (do { local $/; <$fh> })
753 . "\n};\n1"; 911 . "\n};\n1";
754 912
755 eval $source 913 unless (eval $source) {
756 or die $@ ? "$path: $@\n" 914 my $msg = $@ ? "$path: $@\n"
757 : "extension disabled.\n"; 915 : "extension disabled.\n";
758 916 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
759 push @exts, $pkg; 917 warn $@;
760 $ext_pkg{$base} = $pkg; 918 warn "mandatory extension failed to load, exiting.\n";
761 919 exit 1;
762# no strict 'refs'; 920 }
763# @{"$pkg\::ISA"} = ext::; 921 die $@;
764
765 register $base, $pkg;
766}
767
768sub unload_extension {
769 my ($pkg) = @_;
770
771 warn "removing extension $pkg\n";
772
773 # remove hooks
774 #TODO
775# for my $idx (0 .. $#PLUGIN_EVENT) {
776# delete $hook[$idx]{$pkg};
777# } 922 }
778 923
779 # remove commands 924 push @EXTS, $pkg;
780 for my $name (keys %COMMAND) {
781 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
782
783 if (@cb) {
784 $COMMAND{$name} = \@cb;
785 } else {
786 delete $COMMAND{$name};
787 }
788 }
789
790 # remove extcmds
791 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
792 delete $EXTCMD{$name};
793 }
794
795 if (my $cb = $pkg->can ("unload")) {
796 eval {
797 $cb->($pkg);
798 1
799 } or warn "$pkg unloaded, but with errors: $@";
800 }
801
802 Symbol::delete_package $pkg;
803} 925}
804 926
805sub load_extensions { 927sub load_extensions {
806 for my $ext (<$LIBDIR/*.ext>) { 928 for my $ext (<$LIBDIR/*.ext>) {
807 next unless -r $ext; 929 next unless -r $ext;
811 } or warn "$ext not loaded: $@"; 933 } or warn "$ext not loaded: $@";
812 } 934 }
813} 935}
814 936
815############################################################################# 937#############################################################################
816# load/save/clean perl data associated with a map
817 938
818*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 {
819 my ($map) = @_; 1539 my ($map) = @_;
820 1540
821 my $path = $map->tmpname; 1541 my @diag; # diagonal neighbours
822 defined $path or return;
823 1542
824 unlink "$path.pst"; 1543 for (0 .. 3) {
825}; 1544 my $neigh = $map->tile_path ($_)
1545 or next;
1546 $neigh = find $neigh, $map
1547 or next;
1548 $neigh->load;
826 1549
827cf::map->attach (prio => -10000, package => cf::mapsupport::); 1550 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1551 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1552 }
828 1553
829############################################################################# 1554 for (@diag) {
830# load/save perl data associated with player->ob objects 1555 my $neigh = find @$_
831 1556 or next;
832sub all_objects(@) { 1557 $neigh->load;
833 @_, map all_objects ($_->inv), @_ 1558 }
834} 1559}
835 1560
836# TODO: compatibility cruft, remove when no longer needed 1561sub find_sync {
837cf::player->attach ( 1562 my ($path, $origin) = @_;
838 on_load => sub {
839 my ($pl, $path) = @_;
840 1563
841 for my $o (all_objects $pl->ob) { 1564 cf::sync_job { find $path, $origin }
842 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1565}
843 $o->set_ob_key_value ("_perl_data");
844 1566
845 %$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};
846 } 1594 }
847 } 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);
848 }, 1630 }
849); 1631}
850 1632
851############################################################################# 1633sub swap_out {
1634 my ($self) = @_;
852 1635
853=head2 CORE EXTENSIONS 1636 # save first because save cedes
1637 $self->save;
854 1638
855Functions and methods that extend core crossfire objects. 1639 my $lock = cf::lock_acquire "map_data:" . $self->path;
856 1640
857=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;
858 1751
859=over 4 1752=over 4
860 1753
861=item cf::player::exists $login 1754=item $ob->inv_recursive
862 1755
863Returns true when the given account exists. 1756Returns the inventory of the object _and_ their inventories, recursively.
864 1757
865=cut 1758=cut
866 1759
867sub cf::player::exists($) { 1760sub inv_recursive_;
868 cf::player::find $_[0] 1761sub inv_recursive_ {
869 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1762 map { $_, inv_recursive_ $_->inv } @_
870} 1763}
871 1764
872=item $player->ext_reply ($msgid, $msgtype, %msg) 1765sub inv_recursive {
873 1766 inv_recursive_ inv $_[0]
874Sends an ext reply to the player.
875
876=cut
877
878sub cf::player::ext_reply($$$%) {
879 my ($self, $id, %msg) = @_;
880
881 $msg{msgid} = $id;
882
883 $self->send ("ext " . to_json \%msg);
884} 1767}
1768
1769package cf;
885 1770
886=back 1771=back
887 1772
888=head3 cf::object::player 1773=head3 cf::object::player
889 1774
927 (ref $cf::CFG{"may_$access"} 1812 (ref $cf::CFG{"may_$access"}
928 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1813 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
929 : $cf::CFG{"may_$access"}) 1814 : $cf::CFG{"may_$access"})
930} 1815}
931 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
932=head3 cf::client 2040=head3 cf::client
933 2041
934=over 4 2042=over 4
935 2043
936=item $client->send_drawinfo ($text, $flags) 2044=item $client->send_drawinfo ($text, $flags)
942 2050
943sub cf::client::send_drawinfo { 2051sub cf::client::send_drawinfo {
944 my ($self, $text, $flags) = @_; 2052 my ($self, $text, $flags) = @_;
945 2053
946 utf8::encode $text; 2054 utf8::encode $text;
947 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2055 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
948} 2056}
949 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}
950 2070
951=item $success = $client->query ($flags, "text", \&cb) 2071=item $success = $client->query ($flags, "text", \&cb)
952 2072
953Queues a query to the client, calling the given callback with 2073Queues a query to the client, calling the given callback with
954the 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>,
979 on_reply => sub { 2099 on_reply => sub {
980 my ($ns, $msg) = @_; 2100 my ($ns, $msg) = @_;
981 2101
982 # this weird shuffling is so that direct followup queries 2102 # this weird shuffling is so that direct followup queries
983 # get handled first 2103 # get handled first
984 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
985 2106
986 (shift @$queue)->[1]->($msg); 2107 (shift @$queue)->[1]->($msg);
2108 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
987 2109
988 push @{ $ns->{query_queue} }, @$queue; 2110 push @{ $ns->{query_queue} }, @$queue;
989 2111
990 if (@{ $ns->{query_queue} } == @$queue) { 2112 if (@{ $ns->{query_queue} } == @$queue) {
991 if (@$queue) { 2113 if (@$queue) {
995 } 2117 }
996 } 2118 }
997 }, 2119 },
998); 2120);
999 2121
1000=item $client->coro (\&cb) 2122=item $client->async (\&cb)
1001 2123
1002Create a new coroutine, running the specified callback. The coroutine will 2124Create a new coroutine, running the specified callback. The coroutine will
1003be automatically cancelled when the client gets destroyed (e.g. on logout, 2125be automatically cancelled when the client gets destroyed (e.g. on logout,
1004or loss of connection). 2126or loss of connection).
1005 2127
1006=cut 2128=cut
1007 2129
1008sub cf::client::coro { 2130sub cf::client::async {
1009 my ($self, $cb) = @_; 2131 my ($self, $cb) = @_;
1010 2132
1011 my $coro; $coro = async { 2133 my $coro = &Coro::async ($cb);
1012 eval {
1013 $cb->();
1014 };
1015 warn $@ if $@;
1016 };
1017 2134
1018 $coro->on_destroy (sub { 2135 $coro->on_destroy (sub {
1019 delete $self->{_coro}{$coro+0}; 2136 delete $self->{_coro}{$coro+0};
1020 }); 2137 });
1021 2138
1054 2171
1055# here we export the classes and methods available to script code 2172# here we export the classes and methods available to script code
1056 2173
1057=pod 2174=pod
1058 2175
1059The following fucntions and emthods are available within a safe environment: 2176The following functions and methods are available within a safe environment:
1060 2177
1061 cf::object contr pay_amount pay_player map 2178 cf::object contr pay_amount pay_player map
1062 cf::object::player player 2179 cf::object::player player
1063 cf::player peaceful 2180 cf::player peaceful
1064 cf::map trigger 2181 cf::map trigger
1149############################################################################# 2266#############################################################################
1150 2267
1151=head2 EXTENSION DATABASE SUPPORT 2268=head2 EXTENSION DATABASE SUPPORT
1152 2269
1153Crossfire maintains a very simple database for extension use. It can 2270Crossfire maintains a very simple database for extension use. It can
1154currently store anything that can be serialised using Storable, which 2271currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1155excludes objects. 2272convert to/from binary).
1156 2273
1157The 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
1158using it, it should be unique. 2275using it, it should be unique.
1159 2276
1160=over 4 2277=over 4
1161 2278
1162=item $hashref = cf::db_get $family
1163
1164Return a hashref for use by the extension C<$family>, which can be
1165modified. After modifications, you have to call C<cf::db_dirty> or
1166C<cf::db_sync>.
1167
1168=item $value = cf::db_get $family => $key 2279=item $value = cf::db_get $family => $key
1169 2280
1170Returns a single value from the database 2281Returns a single value from the database.
1171
1172=item cf::db_put $family => $hashref
1173
1174Stores the given family hashref into the database. Updates are delayed, if
1175you want the data to be synced to disk immediately, use C<cf::db_sync>.
1176 2282
1177=item cf::db_put $family => $key => $value 2283=item cf::db_put $family => $key => $value
1178 2284
1179Stores the given C<$value> in the family hash. Updates are delayed, if you 2285Stores the given C<$value> in the family.
1180want the data to be synced to disk immediately, use C<cf::db_sync>.
1181
1182=item cf::db_dirty
1183
1184Marks the database as dirty, to be updated at a later time.
1185
1186=item cf::db_sync
1187
1188Immediately write the database to disk I<if it is dirty>.
1189 2286
1190=cut 2287=cut
1191 2288
1192our $DB; 2289our $DB;
1193 2290
1194{ 2291sub db_init {
1195 my $path = cf::localdir . "/database.pst"; 2292 unless ($DB) {
2293 $DB = BDB::db_create $DB_ENV;
1196 2294
1197 sub db_load() { 2295 cf::sync_job {
1198 warn "loading database $path\n";#d# remove later 2296 eval {
1199 $DB = stat $path ? Storable::retrieve $path : { }; 2297 $DB->set_flags (BDB::CHKSUM);
1200 }
1201 2298
1202 my $pid; 2299 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1203 2300 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1204 sub db_save() { 2301 cf::cleanup "db_open(db): $!" if $!;
1205 warn "saving database $path\n";#d# remove later 2302 };
1206 waitpid $pid, 0 if $pid; 2303 cf::cleanup "db_open(db): $@" if $@;
1207 if (0 == ($pid = fork)) {
1208 $DB->{_meta}{version} = 1;
1209 Storable::nstore $DB, "$path~";
1210 rename "$path~", $path;
1211 cf::_exit 0 if defined $pid;
1212 } 2304 };
1213 }
1214
1215 my $dirty;
1216
1217 sub db_sync() {
1218 db_save if $dirty;
1219 undef $dirty;
1220 }
1221
1222 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1223 db_sync;
1224 }); 2305 }
2306}
1225 2307
1226 sub db_dirty() {
1227 $dirty = 1;
1228 $idle->start;
1229 }
1230
1231 sub db_get($;$) { 2308sub db_get($$) {
1232 @_ >= 2 2309 my $key = "$_[0]/$_[1]";
1233 ? $DB->{$_[0]}{$_[1]}
1234 : ($DB->{$_[0]} ||= { })
1235 }
1236 2310
2311 cf::sync_job {
2312 BDB::db_get $DB, undef, $key, my $data;
2313
2314 $! ? ()
2315 : $data
2316 }
2317}
2318
1237 sub db_put($$;$) { 2319sub db_put($$$) {
1238 if (@_ >= 3) { 2320 BDB::dbreq_pri 4;
1239 $DB->{$_[0]}{$_[1]} = $_[2]; 2321 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1240 } else { 2322}
1241 $DB->{$_[0]} = $_[1];
1242 }
1243 db_dirty;
1244 }
1245 2323
1246 cf::global->attach ( 2324=item cf::cache $id => [$paths...], $processversion => $process
1247 prio => 10000, 2325
1248 on_cleanup => sub { 2326Generic caching function that returns the value of the resource $id,
1249 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->[$_]: $!";
1250 }, 2356 }
1251 ); 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"
1252} 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 local $SIG{__WARN__};
2420 eval {
2421 local $SIG{__DIE__};
2422 close $fh1;
2423
2424 my @res = eval { $cb->(@args) };
2425 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2426 };
2427
2428 warn $@ if $@;
2429 _exit 0;
2430 }
2431}
2432
2433
1253 2434
1254############################################################################# 2435#############################################################################
1255# the server's main() 2436# the server's init and main functions
2437
2438sub load_facedata($) {
2439 my ($path) = @_;
2440
2441 warn "loading facedata from $path\n";
2442
2443 my $facedata;
2444 0 < aio_load $path, $facedata
2445 or die "$path: $!";
2446
2447 $facedata = Coro::Storable::thaw $facedata;
2448
2449 $facedata->{version} == 2
2450 or cf::cleanup "$path: version mismatch, cannot proceed.";
2451
2452 {
2453 my $faces = $facedata->{faceinfo};
2454
2455 while (my ($face, $info) = each %$faces) {
2456 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2457 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2458 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2459 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2460 Coro::cede;
2461 }
2462
2463 while (my ($face, $info) = each %$faces) {
2464 next unless $info->{smooth};
2465 my $idx = cf::face::find $face
2466 or next;
2467 if (my $smooth = cf::face::find $info->{smooth}) {
2468 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2469 } else {
2470 warn "smooth face '$info->{smooth}' not found for face '$face'";
2471 }
2472 Coro::cede;
2473 }
2474 }
2475
2476 {
2477 my $anims = $facedata->{animinfo};
2478
2479 while (my ($anim, $info) = each %$anims) {
2480 cf::anim::set $anim, $info->{frames}, $info->{facings};
2481 Coro::cede;
2482 }
2483
2484 cf::anim::invalidate_all; # d'oh
2485 }
2486
2487 1
2488}
2489
2490sub reload_facedata {
2491 load_facedata sprintf "%s/facedata", cf::datadir
2492 or die "unable to load facedata\n";
2493}
2494
2495sub reload_regions {
2496 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2497 or die "unable to load regions file\n";
2498}
2499
2500sub reload_archetypes {
2501 load_resource_file sprintf "%s/archetypes", cf::datadir
2502 or die "unable to load archetypes\n";
2503}
2504
2505sub reload_treasures {
2506 load_resource_file sprintf "%s/treasures", cf::datadir
2507 or die "unable to load treasurelists\n";
2508}
2509
2510sub reload_resources {
2511 warn "reloading resource files...\n";
2512
2513 reload_regions;
2514 reload_facedata;
2515 reload_archetypes;
2516 reload_treasures;
2517
2518 warn "finished reloading resource files\n";
2519}
2520
2521sub init {
2522 reload_resources;
2523}
1256 2524
1257sub cfg_load { 2525sub cfg_load {
1258 open my $fh, "<:utf8", cf::confdir . "/config" 2526 open my $fh, "<:utf8", cf::confdir . "/config"
1259 or return; 2527 or return;
1260 2528
1261 local $/; 2529 local $/;
1262 *CFG = YAML::Syck::Load <$fh>; 2530 *CFG = YAML::Syck::Load <$fh>;
2531
2532 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2533
2534 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2535 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2536
2537 if (exists $CFG{mlockall}) {
2538 eval {
2539 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2540 and die "WARNING: m(un)lockall failed: $!\n";
2541 };
2542 warn $@ if $@;
2543 }
1263} 2544}
1264 2545
1265sub main { 2546sub main {
2547 # we must not ever block the main coroutine
2548 local $Coro::idle = sub {
2549 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2550 (async {
2551 Event::one_event;
2552 })->prio (Coro::PRIO_MAX);
2553 };
2554
1266 cfg_load; 2555 cfg_load;
1267 db_load; 2556 db_init;
1268 load_extensions; 2557 load_extensions;
2558
2559 $TICK_WATCHER->start;
1269 Event::loop; 2560 Event::loop;
1270} 2561}
1271 2562
1272############################################################################# 2563#############################################################################
1273# initialisation 2564# initialisation and cleanup
1274 2565
1275sub _perl_reload() { 2566# install some emergency cleanup handlers
2567BEGIN {
2568 for my $signal (qw(INT HUP TERM)) {
2569 Event->signal (
2570 reentrant => 0,
2571 data => WF_AUTOCANCEL,
2572 signal => $signal,
2573 prio => 0,
2574 cb => sub {
2575 cf::cleanup "SIG$signal";
2576 },
2577 );
2578 }
2579}
2580
2581sub emergency_save() {
2582 my $freeze_guard = cf::freeze_mainloop;
2583
2584 warn "enter emergency perl save\n";
2585
2586 cf::sync_job {
2587 # use a peculiar iteration method to avoid tripping on perl
2588 # refcount bugs in for. also avoids problems with players
2589 # and maps saved/destroyed asynchronously.
2590 warn "begin emergency player save\n";
2591 for my $login (keys %cf::PLAYER) {
2592 my $pl = $cf::PLAYER{$login} or next;
2593 $pl->valid or next;
2594 $pl->save;
2595 }
2596 warn "end emergency player save\n";
2597
2598 warn "begin emergency map save\n";
2599 for my $path (keys %cf::MAP) {
2600 my $map = $cf::MAP{$path} or next;
2601 $map->valid or next;
2602 $map->save;
2603 }
2604 warn "end emergency map save\n";
2605
2606 warn "begin emergency database checkpoint\n";
2607 BDB::db_env_txn_checkpoint $DB_ENV;
2608 warn "end emergency database checkpoint\n";
2609 };
2610
2611 warn "leave emergency perl save\n";
2612}
2613
2614sub post_cleanup {
2615 my ($make_core) = @_;
2616
2617 warn Carp::longmess "post_cleanup backtrace"
2618 if $make_core;
2619}
2620
2621sub do_reload_perl() {
2622 # can/must only be called in main
2623 if ($Coro::current != $Coro::main) {
2624 warn "can only reload from main coroutine";
2625 return;
2626 }
2627
1276 warn "reloading..."; 2628 warn "reloading...";
1277 2629
1278 eval { 2630 warn "entering sync_job";
1279 local $FREEZE = 1;
1280 2631
2632 cf::sync_job {
2633 cf::write_runtime; # external watchdog should not bark
1281 cf::emergency_save; 2634 cf::emergency_save;
2635 cf::write_runtime; # external watchdog should not bark
1282 2636
1283 # cancel all watchers 2637 warn "syncing database to disk";
2638 BDB::db_env_txn_checkpoint $DB_ENV;
2639
2640 # if anything goes wrong in here, we should simply crash as we already saved
2641
2642 warn "cancelling all WF_AUTOCANCEL watchers";
1284 for (Event::all_watchers) { 2643 for (Event::all_watchers) {
1285 $_->cancel if $_->data & WF_AUTOCANCEL; 2644 $_->cancel if $_->data & WF_AUTOCANCEL;
1286 } 2645 }
1287 2646
2647 warn "flushing outstanding aio requests";
2648 for (;;) {
2649 BDB::flush;
2650 IO::AIO::flush;
2651 Coro::cede;
2652 last unless IO::AIO::nreqs || BDB::nreqs;
2653 warn "iterate...";
2654 }
2655
2656 ++$RELOAD;
2657
1288 # cancel all extension coros 2658 warn "cancelling all extension coros";
1289 $_->cancel for values %EXT_CORO; 2659 $_->cancel for values %EXT_CORO;
1290 %EXT_CORO = (); 2660 %EXT_CORO = ();
1291 2661
1292 # unload all extensions 2662 warn "removing commands";
1293 for (@exts) { 2663 %COMMAND = ();
2664
2665 warn "removing ext commands";
2666 %EXTCMD = ();
2667
2668 warn "unloading/nuking all extensions";
2669 for my $pkg (@EXTS) {
1294 warn "unloading <$_>"; 2670 warn "... unloading $pkg";
1295 unload_extension $_; 2671
2672 if (my $cb = $pkg->can ("unload")) {
2673 eval {
2674 $cb->($pkg);
2675 1
2676 } or warn "$pkg unloaded, but with errors: $@";
1296 } 2677 }
1297 2678
2679 warn "... nuking $pkg";
2680 Symbol::delete_package $pkg;
2681 }
2682
1298 # unload all modules loaded from $LIBDIR 2683 warn "unloading all perl modules loaded from $LIBDIR";
1299 while (my ($k, $v) = each %INC) { 2684 while (my ($k, $v) = each %INC) {
1300 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2685 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1301 2686
1302 warn "removing <$k>"; 2687 warn "... unloading $k";
1303 delete $INC{$k}; 2688 delete $INC{$k};
1304 2689
1305 $k =~ s/\.pm$//; 2690 $k =~ s/\.pm$//;
1306 $k =~ s/\//::/g; 2691 $k =~ s/\//::/g;
1307 2692
1310 } 2695 }
1311 2696
1312 Symbol::delete_package $k; 2697 Symbol::delete_package $k;
1313 } 2698 }
1314 2699
1315 # sync database to disk
1316 cf::db_sync;
1317 IO::AIO::flush;
1318
1319 # get rid of safe::, as good as possible 2700 warn "getting rid of safe::, as good as possible";
1320 Symbol::delete_package "safe::$_" 2701 Symbol::delete_package "safe::$_"
1321 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2702 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1322 2703
1323 # remove register_script_function callbacks
1324 # TODO
1325
1326 # unload cf.pm "a bit" 2704 warn "unloading cf.pm \"a bit\"";
1327 delete $INC{"cf.pm"}; 2705 delete $INC{"cf.pm"};
2706 delete $INC{"cf/pod.pm"};
1328 2707
1329 # don't, removes xs symbols, too, 2708 # don't, removes xs symbols, too,
1330 # and global variables created in xs 2709 # and global variables created in xs
1331 #Symbol::delete_package __PACKAGE__; 2710 #Symbol::delete_package __PACKAGE__;
1332 2711
1333 # reload cf.pm 2712 warn "unload completed, starting to reload now";
2713
1334 warn "reloading cf.pm"; 2714 warn "reloading cf.pm";
1335 require cf; 2715 require cf;
1336 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2716 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1337 2717
1338 # load config and database again 2718 warn "loading config and database again";
1339 cf::cfg_load; 2719 cf::cfg_load;
1340 cf::db_load;
1341 2720
1342 # load extensions
1343 warn "load extensions"; 2721 warn "loading extensions";
1344 cf::load_extensions; 2722 cf::load_extensions;
1345 2723
1346 # reattach attachments to objects 2724 warn "reattaching attachments to objects/players";
1347 warn "reattach"; 2725 _global_reattach; # objects, sockets
1348 _global_reattach; 2726 warn "reattaching attachments to maps";
2727 reattach $_ for values %MAP;
2728 warn "reattaching attachments to players";
2729 reattach $_ for values %PLAYER;
2730
2731 warn "leaving sync_job";
2732
2733 1
2734 } or do {
2735 warn $@;
2736 warn "error while reloading, exiting.";
2737 exit 1;
1349 }; 2738 };
1350 warn $@ if $@;
1351 2739
1352 warn "reloaded"; 2740 warn "reloaded";
1353}; 2741};
1354 2742
1355sub perl_reload() { 2743our $RELOAD_WATCHER; # used only during reload
1356 _perl_reload;
1357}
1358 2744
1359register "<global>", __PACKAGE__; 2745sub reload_perl() {
2746 # doing reload synchronously and two reloads happen back-to-back,
2747 # coro crashes during coro_state_free->destroy here.
1360 2748
2749 $RELOAD_WATCHER ||= Event->timer (
2750 reentrant => 0,
2751 after => 0,
2752 data => WF_AUTOCANCEL,
2753 cb => sub {
2754 do_reload_perl;
2755 undef $RELOAD_WATCHER;
2756 },
2757 );
2758}
2759
1361register_command "perl-reload" => sub { 2760register_command "reload" => sub {
1362 my ($who, $arg) = @_; 2761 my ($who, $arg) = @_;
1363 2762
1364 if ($who->flag (FLAG_WIZ)) { 2763 if ($who->flag (FLAG_WIZ)) {
1365 $who->message ("reloading..."); 2764 $who->message ("reloading server.");
1366 _perl_reload; 2765 async { reload_perl };
1367 } 2766 }
1368}; 2767};
1369 2768
1370unshift @INC, $LIBDIR; 2769unshift @INC, $LIBDIR;
2770
2771my $bug_warning = 0;
2772
2773our @WAIT_FOR_TICK;
2774our @WAIT_FOR_TICK_BEGIN;
2775
2776sub wait_for_tick {
2777 return unless $TICK_WATCHER->is_active;
2778 return if $Coro::current == $Coro::main;
2779
2780 my $signal = new Coro::Signal;
2781 push @WAIT_FOR_TICK, $signal;
2782 $signal->wait;
2783}
2784
2785sub wait_for_tick_begin {
2786 return unless $TICK_WATCHER->is_active;
2787 return if $Coro::current == $Coro::main;
2788
2789 my $signal = new Coro::Signal;
2790 push @WAIT_FOR_TICK_BEGIN, $signal;
2791 $signal->wait;
2792}
1371 2793
1372$TICK_WATCHER = Event->timer ( 2794$TICK_WATCHER = Event->timer (
1373 reentrant => 0, 2795 reentrant => 0,
2796 parked => 1,
1374 prio => 0, 2797 prio => 0,
1375 at => $NEXT_TICK || $TICK, 2798 at => $NEXT_TICK || $TICK,
1376 data => WF_AUTOCANCEL, 2799 data => WF_AUTOCANCEL,
1377 cb => sub { 2800 cb => sub {
1378 unless ($FREEZE) { 2801 if ($Coro::current != $Coro::main) {
2802 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2803 unless ++$bug_warning > 10;
2804 return;
2805 }
2806
2807 $NOW = Event::time;
2808
1379 cf::server_tick; # one server iteration 2809 cf::server_tick; # one server iteration
2810
1380 $RUNTIME += $TICK; 2811 $RUNTIME += $TICK;
1381 }
1382
1383 $NEXT_TICK += $TICK; 2812 $NEXT_TICK += $TICK;
2813
2814 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2815 $NEXT_RUNTIME_WRITE = $NOW + 10;
2816 Coro::async_pool {
2817 write_runtime
2818 or warn "ERROR: unable to write runtime file: $!";
2819 };
2820 }
2821
2822# my $AFTER = Event::time;
2823# warn $AFTER - $NOW;#d#
1384 2824
1385 # if we are delayed by four ticks or more, skip them all 2825 # if we are delayed by four ticks or more, skip them all
1386 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2826 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1387 2827
1388 $TICK_WATCHER->at ($NEXT_TICK); 2828 $TICK_WATCHER->at ($NEXT_TICK);
1389 $TICK_WATCHER->start; 2829 $TICK_WATCHER->start;
2830
2831 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2832 $sig->send;
2833 }
2834 while (my $sig = shift @WAIT_FOR_TICK) {
2835 $sig->send;
2836 }
2837
2838 _post_tick;
1390 }, 2839 },
1391); 2840);
1392 2841
2842{
2843 BDB::max_poll_time $TICK * 0.1;
2844 $BDB_POLL_WATCHER = Event->io (
2845 reentrant => 0,
2846 fd => BDB::poll_fileno,
2847 poll => 'r',
2848 prio => 0,
2849 data => WF_AUTOCANCEL,
2850 cb => \&BDB::poll_cb,
2851 );
2852 BDB::min_parallel 8;
2853
2854 BDB::set_sync_prepare {
2855 my $status;
2856 my $current = $Coro::current;
2857 (
2858 sub {
2859 $status = $!;
2860 $current->ready; undef $current;
2861 },
2862 sub {
2863 Coro::schedule while defined $current;
2864 $! = $status;
2865 },
2866 )
2867 };
2868
2869 unless ($DB_ENV) {
2870 $DB_ENV = BDB::db_env_create;
2871
2872 cf::sync_job {
2873 eval {
2874 BDB::db_env_open
2875 $DB_ENV,
2876 $BDB_ENV_DIR,
2877 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2878 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2879 0666;
2880
2881 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
2882
2883 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2884 $DB_ENV->set_lk_detect;
2885 };
2886
2887 cf::cleanup "db_env_open(db): $@" if $@;
2888 };
2889 }
2890}
2891
2892{
2893 IO::AIO::min_parallel 8;
2894
2895 undef $Coro::AIO::WATCHER;
1393IO::AIO::max_poll_time $TICK * 0.2; 2896 IO::AIO::max_poll_time $TICK * 0.1;
1394 2897 $AIO_POLL_WATCHER = Event->io (
1395Event->io (fd => IO::AIO::poll_fileno, 2898 reentrant => 0,
1396 poll => 'r',
1397 prio => 5,
1398 data => WF_AUTOCANCEL, 2899 data => WF_AUTOCANCEL,
2900 fd => IO::AIO::poll_fileno,
2901 poll => 'r',
2902 prio => 6,
1399 cb => \&IO::AIO::poll_cb); 2903 cb => \&IO::AIO::poll_cb,
2904 );
2905}
1400 2906
1401# we must not ever block the main coroutine 2907# load additional modules
1402$Coro::idle = sub { 2908use cf::pod;
1403 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2909
1404 warn "FATAL: Coro::idle was called, major BUG\n"; 2910END { cf::emergency_save }
1405 (Coro::unblock_sub {
1406 Event::one_event;
1407 })->();
1408};
1409 2911
14101 29121
1411 2913

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines