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.97 by root, Fri Dec 22 06:03:20 2006 UTC vs.
Revision 1.238 by root, Sat Apr 14 07:23:00 2007 UTC

4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Storable; 8use Storable;
9use Event;
9use Opcode; 10use Opcode;
10use Safe; 11use Safe;
11use Safe::Hole; 12use Safe::Hole;
12 13
13use Coro; 14use Coro 3.52 ();
15use Coro::State;
14use Coro::Event; 16use Coro::Event;
15use Coro::Timer; 17use Coro::Timer;
16use Coro::Signal; 18use Coro::Signal;
17use Coro::Semaphore; 19use Coro::Semaphore;
18
19use IO::AIO; 20use Coro::AIO;
21use Coro::Storable;
22
23use BDB ();
24use Data::Dumper;
25use Digest::MD5;
26use Fcntl;
20use YAML::Syck (); 27use YAML::Syck ();
28use IO::AIO 2.32 ();
21use Time::HiRes; 29use Time::HiRes;
30use Compress::LZF;
22 31
32# configure various modules to our taste
33#
34$Storable::canonical = 1; # reduce rsync transfers
35Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
36Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
37
23use Event; $Event::Eval = 1; # no idea why this is required, but it is 38$Event::Eval = 1; # no idea why this is required, but it is
24 39
25# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 40# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
26$YAML::Syck::ImplicitUnicode = 1; 41$YAML::Syck::ImplicitUnicode = 1;
27 42
28$Coro::main->prio (Coro::PRIO_MIN); 43$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29 44
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 45sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31 46
32our %COMMAND = (); 47our %COMMAND = ();
33our %COMMAND_TIME = (); 48our %COMMAND_TIME = ();
49
50our @EXTS = (); # list of extension package names
34our %EXTCMD = (); 51our %EXTCMD = ();
52our %EXT_CORO = (); # coroutines bound to extensions
53our %EXT_MAP = (); # pluggable maps
35 54
36_init_vars; 55our $RELOAD; # number of reloads so far
37
38our @EVENT; 56our @EVENT;
39our $LIBDIR = datadir . "/ext"; 57our $LIBDIR = datadir . "/ext";
40 58
41our $TICK = MAX_TIME * 1e-6; 59our $TICK = MAX_TIME * 1e-6;
42our $TICK_WATCHER; 60our $TICK_WATCHER;
61our $AIO_POLL_WATCHER;
62our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43our $NEXT_TICK; 63our $NEXT_TICK;
64our $NOW;
65our $USE_FSYNC = 1; # use fsync to write maps - default off
66
67our $BDB_POLL_WATCHER;
68our $DB_ENV;
44 69
45our %CFG; 70our %CFG;
46 71
47our $UPTIME; $UPTIME ||= time; 72our $UPTIME; $UPTIME ||= time;
73our $RUNTIME;
74
75our %PLAYER; # all users
76our %MAP; # all maps
77our $LINK_MAP; # the special {link} map, which is always available
78our $RANDOM_MAPS = cf::localdir . "/random";
79our $BDB_ENV_DIR = cf::localdir . "/db";
80
81our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
82our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
83
84# used to convert map paths into valid unix filenames by replacing / by ∕
85our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
86
87binmode STDOUT;
88binmode STDERR;
89
90# read virtual server time, if available
91unless ($RUNTIME || !-e cf::localdir . "/runtime") {
92 open my $fh, "<", cf::localdir . "/runtime"
93 or die "unable to read runtime file: $!";
94 $RUNTIME = <$fh> + 0.;
95}
96
97mkdir cf::localdir;
98mkdir cf::localdir . "/" . cf::playerdir;
99mkdir cf::localdir . "/" . cf::tmpdir;
100mkdir cf::localdir . "/" . cf::uniquedir;
101mkdir $RANDOM_MAPS;
102mkdir $BDB_ENV_DIR;
103
104our $EMERGENCY_POSITION;
105
106sub cf::map::normalise;
48 107
49############################################################################# 108#############################################################################
50 109
51=head2 GLOBAL VARIABLES 110=head2 GLOBAL VARIABLES
52 111
53=over 4 112=over 4
54 113
55=item $cf::UPTIME 114=item $cf::UPTIME
56 115
57The timestamp of the server start (so not actually an uptime). 116The timestamp of the server start (so not actually an uptime).
117
118=item $cf::RUNTIME
119
120The time this server has run, starts at 0 and is increased by $cf::TICK on
121every server tick.
58 122
59=item $cf::LIBDIR 123=item $cf::LIBDIR
60 124
61The perl library directory, where extensions and cf-specific modules can 125The perl library directory, where extensions and cf-specific modules can
62be found. It will be added to C<@INC> automatically. 126be found. It will be added to C<@INC> automatically.
63 127
128=item $cf::NOW
129
130The time of the last (current) server tick.
131
64=item $cf::TICK 132=item $cf::TICK
65 133
66The interval between server ticks, in seconds. 134The interval between server ticks, in seconds.
67 135
68=item %cf::CFG 136=item %cf::CFG
69 137
70Configuration for the server, loaded from C</etc/crossfire/config>, or 138Configuration for the server, loaded from C</etc/crossfire/config>, or
71from wherever your confdir points to. 139from wherever your confdir points to.
140
141=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
142
143These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
144or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
145processing has been done. Call C<< ->wait >> on them to maximise the
146window of cpu time available, or simply to synchronise to the server tick.
72 147
73=back 148=back
74 149
75=cut 150=cut
76 151
77BEGIN { 152BEGIN {
78 *CORE::GLOBAL::warn = sub { 153 *CORE::GLOBAL::warn = sub {
79 my $msg = join "", @_; 154 my $msg = join "", @_;
155 utf8::encode $msg;
156
80 $msg .= "\n" 157 $msg .= "\n"
81 unless $msg =~ /\n$/; 158 unless $msg =~ /\n$/;
82 159
83 print STDERR "cfperl: $msg";
84 LOG llevError, "cfperl: $msg"; 160 LOG llevError, $msg;
85 }; 161 };
86} 162}
87 163
88@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 164@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
89@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 165@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
93@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 169@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
94 170
95# we bless all objects into (empty) derived classes to force a method lookup 171# we bless all objects into (empty) derived classes to force a method lookup
96# within the Safe compartment. 172# within the Safe compartment.
97for my $pkg (qw( 173for my $pkg (qw(
98 cf::global 174 cf::global cf::attachable
99 cf::object cf::object::player 175 cf::object cf::object::player
100 cf::client cf::player 176 cf::client cf::player
101 cf::arch cf::living 177 cf::arch cf::living
102 cf::map cf::party cf::region 178 cf::map cf::party cf::region
103)) { 179)) {
107 183
108$Event::DIED = sub { 184$Event::DIED = sub {
109 warn "error in event callback: @_"; 185 warn "error in event callback: @_";
110}; 186};
111 187
112my %ext_pkg;
113my @exts;
114my @hook;
115
116=head2 UTILITY FUNCTIONS 188=head2 UTILITY FUNCTIONS
117 189
118=over 4 190=over 4
119 191
120=cut 192=item dumpval $ref
121 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
122use JSON::Syck (); # TODO# replace by JSON::PC once working 215use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
123 216
124=item $ref = cf::from_json $json 217=item $ref = cf::from_json $json
125 218
126Converts a JSON string into the corresponding perl data structure. 219Converts a JSON string into the corresponding perl data structure.
127 220
128=cut
129
130sub from_json($) {
131 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
132 JSON::Syck::Load $_[0]
133}
134
135=item $json = cf::to_json $ref 221=item $json = cf::to_json $ref
136 222
137Converts a perl data structure into its JSON representation. 223Converts a perl data structure into its JSON representation.
138 224
139=cut 225=item cf::lock_wait $string
140 226
141sub to_json($) { 227Wait until the given lock is available. See cf::lock_acquire.
142 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 228
143 JSON::Syck::Dump $_[0] 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
332=item $coro = cf::async_ext { BLOCK }
333
334Like async, but this coro is automatically being canceled when the
335extension calling this is being unloaded.
336
337=cut
338
339sub async_ext(&) {
340 my $cb = shift;
341
342 my $coro = &Coro::async ($cb);
343
344 $coro->on_destroy (sub {
345 delete $EXT_CORO{$coro+0};
346 });
347 $EXT_CORO{$coro+0} = $coro;
348
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 });
144} 389}
145 390
146=back 391=back
147 392
148=cut 393=cut
269exception. 514exception.
270 515
271=cut 516=cut
272 517
273# the following variables are defined in .xs and must not be re-created 518# the following variables are defined in .xs and must not be re-created
274our @CB_GLOBAL = (); # registry for all global events 519our @CB_GLOBAL = (); # registry for all global events
520our @CB_ATTACHABLE = (); # registry for all attachables
275our @CB_OBJECT = (); # all objects (should not be used except in emergency) 521our @CB_OBJECT = (); # all objects (should not be used except in emergency)
276our @CB_PLAYER = (); 522our @CB_PLAYER = ();
277our @CB_CLIENT = (); 523our @CB_CLIENT = ();
278our @CB_TYPE = (); # registry for type (cf-object class) based events 524our @CB_TYPE = (); # registry for type (cf-object class) based events
279our @CB_MAP = (); 525our @CB_MAP = ();
280 526
281my %attachment; 527my %attachment;
528
529sub cf::attachable::thawer_merge {
530 # simply override everything except _meta
531 local $_[0]{_meta};
532 %{$_[0]} = %{$_[1]};
533}
282 534
283sub _attach_cb($$$$) { 535sub _attach_cb($$$$) {
284 my ($registry, $event, $prio, $cb) = @_; 536 my ($registry, $event, $prio, $cb) = @_;
285 537
286 use sort 'stable'; 538 use sort 'stable';
289 541
290 @{$registry->[$event]} = sort 542 @{$registry->[$event]} = sort
291 { $a->[0] cmp $b->[0] } 543 { $a->[0] cmp $b->[0] }
292 @{$registry->[$event] || []}, $cb; 544 @{$registry->[$event] || []}, $cb;
293} 545}
546
547# hack
548my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
294 549
295# attach handles attaching event callbacks 550# attach handles attaching event callbacks
296# the only thing the caller has to do is pass the correct 551# the only thing the caller has to do is pass the correct
297# registry (== where the callback attaches to). 552# registry (== where the callback attaches to).
298sub _attach { 553sub _attach {
300 555
301 my $object_type; 556 my $object_type;
302 my $prio = 0; 557 my $prio = 0;
303 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 558 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
304 559
560 #TODO: get rid of this hack
561 if ($attachable_klass{$klass}) {
562 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
563 }
564
305 while (@arg) { 565 while (@arg) {
306 my $type = shift @arg; 566 my $type = shift @arg;
307 567
308 if ($type eq "prio") { 568 if ($type eq "prio") {
309 $prio = shift @arg; 569 $prio = shift @arg;
384 my ($obj, $name) = @_; 644 my ($obj, $name) = @_;
385 645
386 exists $obj->{_attachment}{$name} 646 exists $obj->{_attachment}{$name}
387} 647}
388 648
389for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 649for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
390 eval "#line " . __LINE__ . " 'cf.pm' 650 eval "#line " . __LINE__ . " 'cf.pm'
391 sub cf::\L$klass\E::_attach_registry { 651 sub cf::\L$klass\E::_attach_registry {
392 (\\\@CB_$klass, KLASS_$klass) 652 (\\\@CB_$klass, KLASS_$klass)
393 } 653 }
394 654
447=cut 707=cut
448 708
449############################################################################# 709#############################################################################
450# object support 710# object support
451 711
452sub instantiate {
453 my ($obj, $data) = @_;
454
455 $data = from_json $data;
456
457 for (@$data) {
458 my ($name, $args) = @$_;
459
460 $obj->attach ($name, %{$args || {} });
461 }
462}
463
464# basically do the same as instantiate, without calling instantiate
465sub reattach { 712sub reattach {
713 # basically do the same as instantiate, without calling instantiate
466 my ($obj) = @_; 714 my ($obj) = @_;
715
716 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
717
467 my $registry = $obj->registry; 718 my $registry = $obj->registry;
468 719
469 @$registry = (); 720 @$registry = ();
470 721
471 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 722 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
480 warn "object uses attachment '$name' that is not available, postponing.\n"; 731 warn "object uses attachment '$name' that is not available, postponing.\n";
481 } 732 }
482 } 733 }
483} 734}
484 735
485sub object_freezer_save { 736cf::attachable->attach (
486 my ($filename, $rdata, $objs) = @_;
487
488 if (length $$rdata) {
489 warn sprintf "saving %s (%d,%d)\n",
490 $filename, length $$rdata, scalar @$objs;
491
492 if (open my $fh, ">:raw", "$filename~") {
493 chmod SAVE_MODE, $fh;
494 syswrite $fh, $$rdata;
495 close $fh;
496
497 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
498 chmod SAVE_MODE, $fh;
499 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
500 close $fh;
501 rename "$filename.pst~", "$filename.pst";
502 } else {
503 unlink "$filename.pst";
504 }
505
506 rename "$filename~", $filename;
507 } else {
508 warn "FATAL: $filename~: $!\n";
509 }
510 } else {
511 unlink $filename;
512 unlink "$filename.pst";
513 }
514}
515
516sub object_freezer_as_string {
517 my ($rdata, $objs) = @_;
518
519 use Data::Dumper;
520
521 $$rdata . Dumper $objs
522}
523
524sub object_thawer_load {
525 my ($filename) = @_;
526
527 local $/;
528
529 my $av;
530
531 #TODO: use sysread etc.
532 if (open my $data, "<:raw:perlio", $filename) {
533 $data = <$data>;
534 if (open my $pst, "<:raw:perlio", "$filename.pst") {
535 $av = eval { (Storable::thaw <$pst>)->{objs} };
536 }
537 return ($data, $av);
538 }
539
540 ()
541}
542
543cf::object->attach (
544 prio => -1000000, 737 prio => -1000000,
738 on_instantiate => sub {
739 my ($obj, $data) = @_;
740
741 $data = from_json $data;
742
743 for (@$data) {
744 my ($name, $args) = @$_;
745
746 $obj->attach ($name, %{$args || {} });
747 }
748 },
749 on_reattach => \&reattach,
545 on_clone => sub { 750 on_clone => sub {
546 my ($src, $dst) = @_; 751 my ($src, $dst) = @_;
547 752
548 @{$dst->registry} = @{$src->registry}; 753 @{$dst->registry} = @{$src->registry};
549 754
552 %{$dst->{_attachment}} = %{$src->{_attachment}} 757 %{$dst->{_attachment}} = %{$src->{_attachment}}
553 if exists $src->{_attachment}; 758 if exists $src->{_attachment};
554 }, 759 },
555); 760);
556 761
762sub object_freezer_save {
763 my ($filename, $rdata, $objs) = @_;
764
765 sync_job {
766 if (length $$rdata) {
767 warn sprintf "saving %s (%d,%d)\n",
768 $filename, length $$rdata, scalar @$objs;
769
770 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
771 chmod SAVE_MODE, $fh;
772 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
773 aio_fsync $fh if $cf::USE_FSYNC;
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;
783 aio_rename "$filename.pst~", "$filename.pst";
784 }
785 } else {
786 aio_unlink "$filename.pst";
787 }
788
789 aio_rename "$filename~", $filename;
790 } else {
791 warn "FATAL: $filename~: $!\n";
792 }
793 } else {
794 aio_unlink $filename;
795 aio_unlink "$filename.pst";
796 }
797 }
798}
799
800sub object_freezer_as_string {
801 my ($rdata, $objs) = @_;
802
803 use Data::Dumper;
804
805 $$rdata . Dumper $objs
806}
807
808sub object_thawer_load {
809 my ($filename) = @_;
810
811 my ($data, $av);
812
813 (aio_load $filename, $data) >= 0
814 or return;
815
816 unless (aio_stat "$filename.pst") {
817 (aio_load "$filename.pst", $av) >= 0
818 or return;
819 $av = eval { (Storable::thaw $av)->{objs} };
820 }
821
822 warn sprintf "loading %s (%d)\n",
823 $filename, length $data, scalar @{$av || []};#d#
824 return ($data, $av);
825}
826
557############################################################################# 827#############################################################################
558# command handling &c 828# command handling &c
559 829
560=item cf::register_command $name => \&callback($ob,$args); 830=item cf::register_command $name => \&callback($ob,$args);
561 831
583=cut 853=cut
584 854
585sub register_extcmd { 855sub register_extcmd {
586 my ($name, $cb) = @_; 856 my ($name, $cb) = @_;
587 857
588 my $caller = caller;
589 #warn "registering extcmd '$name' to '$caller'";
590
591 $EXTCMD{$name} = [$cb, $caller]; 858 $EXTCMD{$name} = $cb;
592} 859}
593 860
594cf::player->attach ( 861cf::player->attach (
595 on_command => sub { 862 on_command => sub {
596 my ($pl, $name, $params) = @_; 863 my ($pl, $name, $params) = @_;
609 876
610 my $msg = eval { from_json $buf }; 877 my $msg = eval { from_json $buf };
611 878
612 if (ref $msg) { 879 if (ref $msg) {
613 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 880 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
614 if (my %reply = $cb->[0]->($pl, $msg)) { 881 if (my %reply = $cb->($pl, $msg)) {
615 $pl->ext_reply ($msg->{msgid}, %reply); 882 $pl->ext_reply ($msg->{msgid}, %reply);
616 } 883 }
617 } 884 }
618 } else { 885 } else {
619 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 886 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
621 888
622 cf::override; 889 cf::override;
623 }, 890 },
624); 891);
625 892
626sub register {
627 my ($base, $pkg) = @_;
628
629 #TODO
630}
631
632sub load_extension { 893sub load_extension {
633 my ($path) = @_; 894 my ($path) = @_;
634 895
635 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 896 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
636 my $base = $1; 897 my $base = $1;
637 my $pkg = $1; 898 my $pkg = $1;
638 $pkg =~ s/[^[:word:]]/_/g; 899 $pkg =~ s/[^[:word:]]/_/g;
639 $pkg = "ext::$pkg"; 900 $pkg = "ext::$pkg";
640 901
641 warn "loading '$path' into '$pkg'\n"; 902 warn "... loading '$path' into '$pkg'\n";
642 903
643 open my $fh, "<:utf8", $path 904 open my $fh, "<:utf8", $path
644 or die "$path: $!"; 905 or die "$path: $!";
645 906
646 my $source = 907 my $source =
647 "package $pkg; use strict; use utf8;\n" 908 "package $pkg; use strict; use utf8;\n"
648 . "#line 1 \"$path\"\n{\n" 909 . "#line 1 \"$path\"\n{\n"
649 . (do { local $/; <$fh> }) 910 . (do { local $/; <$fh> })
650 . "\n};\n1"; 911 . "\n};\n1";
651 912
652 eval $source 913 unless (eval $source) {
653 or die $@ ? "$path: $@\n" 914 my $msg = $@ ? "$path: $@\n"
654 : "extension disabled.\n"; 915 : "extension disabled.\n";
655 916 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
656 push @exts, $pkg; 917 warn $@;
657 $ext_pkg{$base} = $pkg; 918 warn "mandatory extension failed to load, exiting.\n";
658 919 exit 1;
659# no strict 'refs'; 920 }
660# @{"$pkg\::ISA"} = ext::; 921 die $@;
661
662 register $base, $pkg;
663}
664
665sub unload_extension {
666 my ($pkg) = @_;
667
668 warn "removing extension $pkg\n";
669
670 # remove hooks
671 #TODO
672# for my $idx (0 .. $#PLUGIN_EVENT) {
673# delete $hook[$idx]{$pkg};
674# } 922 }
675 923
676 # remove commands 924 push @EXTS, $pkg;
677 for my $name (keys %COMMAND) {
678 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
679
680 if (@cb) {
681 $COMMAND{$name} = \@cb;
682 } else {
683 delete $COMMAND{$name};
684 }
685 }
686
687 # remove extcmds
688 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
689 delete $EXTCMD{$name};
690 }
691
692 if (my $cb = $pkg->can ("unload")) {
693 eval {
694 $cb->($pkg);
695 1
696 } or warn "$pkg unloaded, but with errors: $@";
697 }
698
699 Symbol::delete_package $pkg;
700} 925}
701 926
702sub load_extensions { 927sub load_extensions {
703 for my $ext (<$LIBDIR/*.ext>) { 928 for my $ext (<$LIBDIR/*.ext>) {
704 next unless -r $ext; 929 next unless -r $ext;
708 } or warn "$ext not loaded: $@"; 933 } or warn "$ext not loaded: $@";
709 } 934 }
710} 935}
711 936
712############################################################################# 937#############################################################################
713# load/save/clean perl data associated with a map
714 938
715*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
1489 $self->_load_objects ($self->{load_path}, 1)
1490 or return;
1491
1492 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1493 if delete $self->{load_original};
1494
1495 if (my $uniq = $self->uniq_path) {
1496 utf8::encode $uniq;
1497 if (aio_open $uniq, O_RDONLY, 0) {
1498 $self->clear_unique_items;
1499 $self->_load_objects ($uniq, 0);
1500 }
1501 }
1502
1503 Coro::cede;
1504
1505 # now do the right thing for maps
1506 $self->link_multipart_objects;
1507
1508 unless ($self->{deny_activate}) {
1509 $self->decay_objects;
1510 $self->fix_auto_apply;
1511 $self->update_buttons;
1512 Coro::cede;
1513 $self->set_darkness_map;
1514 $self->difficulty ($self->estimate_difficulty)
1515 unless $self->difficulty;
1516 Coro::cede;
1517 $self->activate;
1518 }
1519
1520 $self->post_load;
1521
1522 $self->in_memory (cf::MAP_IN_MEMORY);
1523}
1524
1525sub customise_for {
1526 my ($self, $ob) = @_;
1527
1528 return find "~" . $ob->name . "/" . $self->{path}
1529 if $self->per_player;
1530
1531 $self
1532}
1533
1534# find and load all maps in the 3x3 area around a map
1535sub load_diag {
716 my ($map) = @_; 1536 my ($map) = @_;
717 1537
718 my $path = $map->tmpname; 1538 my @diag; # diagonal neighbours
719 defined $path or return;
720 1539
721 unlink "$path.pst"; 1540 for (0 .. 3) {
722}; 1541 my $neigh = $map->tile_path ($_)
1542 or next;
1543 $neigh = find $neigh, $map
1544 or next;
1545 $neigh->load;
723 1546
724cf::map->attach (prio => -10000, package => cf::mapsupport::); 1547 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1548 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1549 }
725 1550
726############################################################################# 1551 for (@diag) {
727# load/save perl data associated with player->ob objects 1552 my $neigh = find @$_
728 1553 or next;
729sub all_objects(@) { 1554 $neigh->load;
730 @_, map all_objects ($_->inv), @_ 1555 }
731} 1556}
732 1557
733# TODO: compatibility cruft, remove when no longer needed 1558sub find_sync {
734cf::player->attach ( 1559 my ($path, $origin) = @_;
735 on_load => sub {
736 my ($pl, $path) = @_;
737 1560
738 for my $o (all_objects $pl->ob) { 1561 cf::sync_job { find $path, $origin }
739 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1562}
740 $o->set_ob_key_value ("_perl_data");
741 1563
742 %$o = %{ Storable::thaw pack "H*", $value }; 1564sub do_load_sync {
1565 my ($map) = @_;
1566
1567 cf::sync_job { $map->load };
1568}
1569
1570our %MAP_PREFETCH;
1571our $MAP_PREFETCHER = undef;
1572
1573sub find_async {
1574 my ($path, $origin) = @_;
1575
1576 $path = normalise $path, $origin && $origin->{path};
1577
1578 if (my $map = $cf::MAP{$path}) {
1579 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1580 }
1581
1582 undef $MAP_PREFETCH{$path};
1583 $MAP_PREFETCHER ||= cf::async {
1584 while (%MAP_PREFETCH) {
1585 for my $path (keys %MAP_PREFETCH) {
1586 my $map = find $path
1587 or next;
1588 $map->load;
1589
1590 delete $MAP_PREFETCH{$path};
743 } 1591 }
744 } 1592 }
1593 undef $MAP_PREFETCHER;
1594 };
1595 $MAP_PREFETCHER->prio (6);
1596
1597 ()
1598}
1599
1600sub save {
1601 my ($self) = @_;
1602
1603 my $lock = cf::lock_acquire "map_data:" . $self->path;
1604
1605 $self->{last_save} = $cf::RUNTIME;
1606
1607 return unless $self->dirty;
1608
1609 my $save = $self->save_path; utf8::encode $save;
1610 my $uniq = $self->uniq_path; utf8::encode $uniq;
1611
1612 $self->{load_path} = $save;
1613
1614 return if $self->{deny_save};
1615
1616 local $self->{last_access} = $self->last_access;#d#
1617
1618 cf::async {
1619 $_->contr->save for $self->players;
1620 };
1621
1622 if ($uniq) {
1623 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1624 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1625 } else {
1626 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
745 }, 1627 }
746); 1628}
747 1629
748############################################################################# 1630sub swap_out {
1631 my ($self) = @_;
749 1632
750=head2 CORE EXTENSIONS 1633 # save first because save cedes
1634 $self->save;
751 1635
752Functions and methods that extend core crossfire objects. 1636 my $lock = cf::lock_acquire "map_data:" . $self->path;
753 1637
754=head3 cf::player 1638 return if $self->players;
1639 return if $self->in_memory != cf::MAP_IN_MEMORY;
1640 return if $self->{deny_save};
1641
1642 $self->clear;
1643 $self->in_memory (cf::MAP_SWAPPED);
1644}
1645
1646sub reset_at {
1647 my ($self) = @_;
1648
1649 # TODO: safety, remove and allow resettable per-player maps
1650 return 1e99 if $self->isa ("ext::map_per_player");#d#
1651 return 1e99 if $self->{deny_reset};
1652
1653 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1654 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1655
1656 $time + $to
1657}
1658
1659sub should_reset {
1660 my ($self) = @_;
1661
1662 $self->reset_at <= $cf::RUNTIME
1663}
1664
1665sub reset {
1666 my ($self) = @_;
1667
1668 my $lock = cf::lock_acquire "map_data:$self->{path}";
1669
1670 return if $self->players;
1671 return if $self->isa ("ext::map_per_player");#d#
1672
1673 warn "resetting map ", $self->path;#d#
1674
1675 $self->in_memory (cf::MAP_SWAPPED);
1676
1677 # need to save uniques path
1678 unless ($self->{deny_save}) {
1679 my $uniq = $self->uniq_path; utf8::encode $uniq;
1680
1681 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1682 if $uniq;
1683 }
1684
1685 delete $cf::MAP{$self->path};
1686
1687 $self->clear;
1688
1689 $_->clear_links_to ($self) for values %cf::MAP;
1690
1691 $self->unlink_save;
1692 $self->destroy;
1693}
1694
1695my $nuke_counter = "aaaa";
1696
1697sub nuke {
1698 my ($self) = @_;
1699
1700 delete $cf::MAP{$self->path};
1701
1702 $self->unlink_save;
1703
1704 bless $self, "cf::map";
1705 delete $self->{deny_reset};
1706 $self->{deny_save} = 1;
1707 $self->reset_timeout (1);
1708 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1709
1710 $cf::MAP{$self->path} = $self;
1711
1712 $self->reset; # polite request, might not happen
1713}
1714
1715=item cf::map::unique_maps
1716
1717Returns an arrayref of paths of all shared maps that have
1718instantiated unique items. May block.
1719
1720=cut
1721
1722sub unique_maps() {
1723 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1724 or return;
1725
1726 my @paths;
1727
1728 for (@$files) {
1729 utf8::decode $_;
1730 next if /\.pst$/;
1731 next unless /^$PATH_SEP/o;
1732
1733 push @paths, cf::map::normalise $_;
1734 }
1735
1736 \@paths
1737}
1738
1739package cf;
1740
1741=back
1742
1743=head3 cf::object
1744
1745=cut
1746
1747package cf::object;
755 1748
756=over 4 1749=over 4
757 1750
758=item cf::player::exists $login 1751=item $ob->inv_recursive
759 1752
760Returns true when the given account exists. 1753Returns the inventory of the object _and_ their inventories, recursively.
761 1754
762=cut 1755=cut
763 1756
764sub cf::player::exists($) { 1757sub inv_recursive_;
765 cf::player::find $_[0] 1758sub inv_recursive_ {
766 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1759 map { $_, inv_recursive_ $_->inv } @_
767} 1760}
768 1761
769=item $player->ext_reply ($msgid, $msgtype, %msg) 1762sub inv_recursive {
770 1763 inv_recursive_ inv $_[0]
771Sends an ext reply to the player.
772
773=cut
774
775sub cf::player::ext_reply($$$%) {
776 my ($self, $id, %msg) = @_;
777
778 $msg{msgid} = $id;
779
780 $self->send ("ext " . to_json \%msg);
781} 1764}
1765
1766package cf;
782 1767
783=back 1768=back
784 1769
785=head3 cf::object::player 1770=head3 cf::object::player
786 1771
824 (ref $cf::CFG{"may_$access"} 1809 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1810 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"}) 1811 : $cf::CFG{"may_$access"})
827} 1812}
828 1813
1814=item $player_object->enter_link
1815
1816Freezes the player and moves him/her to a special map (C<{link}>).
1817
1818The player should be reasonably safe there for short amounts of time. You
1819I<MUST> call C<leave_link> as soon as possible, though.
1820
1821Will never block.
1822
1823=item $player_object->leave_link ($map, $x, $y)
1824
1825Moves the player out of the special C<{link}> map onto the specified
1826map. If the map is not valid (or omitted), the player will be moved back
1827to the location he/she was before the call to C<enter_link>, or, if that
1828fails, to the emergency map position.
1829
1830Might block.
1831
1832=cut
1833
1834sub link_map {
1835 unless ($LINK_MAP) {
1836 $LINK_MAP = cf::map::find "{link}"
1837 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1838 $LINK_MAP->load;
1839 }
1840
1841 $LINK_MAP
1842}
1843
1844sub cf::object::player::enter_link {
1845 my ($self) = @_;
1846
1847 $self->deactivate_recursive;
1848
1849 return if UNIVERSAL::isa $self->map, "ext::map_link";
1850
1851 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1852 if $self->map;
1853
1854 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1855}
1856
1857sub cf::object::player::leave_link {
1858 my ($self, $map, $x, $y) = @_;
1859
1860 my $link_pos = delete $self->{_link_pos};
1861
1862 unless ($map) {
1863 # restore original map position
1864 ($map, $x, $y) = @{ $link_pos || [] };
1865 $map = cf::map::find $map;
1866
1867 unless ($map) {
1868 ($map, $x, $y) = @$EMERGENCY_POSITION;
1869 $map = cf::map::find $map
1870 or die "FATAL: cannot load emergency map\n";
1871 }
1872 }
1873
1874 ($x, $y) = (-1, -1)
1875 unless (defined $x) && (defined $y);
1876
1877 # use -1 or undef as default coordinates, not 0, 0
1878 ($x, $y) = ($map->enter_x, $map->enter_y)
1879 if $x <=0 && $y <= 0;
1880
1881 $map->load;
1882 $map->load_diag;
1883
1884 return unless $self->contr->active;
1885 $self->activate_recursive;
1886
1887 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1888 $self->enter_map ($map, $x, $y);
1889}
1890
1891cf::player->attach (
1892 on_logout => sub {
1893 my ($pl) = @_;
1894
1895 # abort map switching before logout
1896 if ($pl->ob->{_link_pos}) {
1897 cf::sync_job {
1898 $pl->ob->leave_link
1899 };
1900 }
1901 },
1902 on_login => sub {
1903 my ($pl) = @_;
1904
1905 # try to abort aborted map switching on player login :)
1906 # should happen only on crashes
1907 if ($pl->ob->{_link_pos}) {
1908 $pl->ob->enter_link;
1909 (async {
1910 $pl->ob->reply (undef,
1911 "There was an internal problem at your last logout, "
1912 . "the server will try to bring you to your intended destination in a second.",
1913 cf::NDI_RED);
1914 # we need this sleep as the login has a concurrent enter_exit running
1915 # and this sleep increases chances of the player not ending up in scorn
1916 Coro::Timer::sleep 1;
1917 $pl->ob->leave_link;
1918 })->prio (2);
1919 }
1920 },
1921);
1922
1923=item $player_object->goto ($path, $x, $y)
1924
1925=cut
1926
1927sub cf::object::player::goto {
1928 my ($self, $path, $x, $y) = @_;
1929
1930 $self->enter_link;
1931
1932 (async {
1933 my $map = eval {
1934 my $map = cf::map::find $path;
1935 $map = $map->customise_for ($self) if $map;
1936 $map
1937 } or
1938 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1939
1940 $self->leave_link ($map, $x, $y);
1941 })->prio (1);
1942}
1943
1944=item $player_object->enter_exit ($exit_object)
1945
1946=cut
1947
1948sub parse_random_map_params {
1949 my ($spec) = @_;
1950
1951 my $rmp = { # defaults
1952 xsize => (cf::rndm 15, 40),
1953 ysize => (cf::rndm 15, 40),
1954 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1955 #layout => string,
1956 };
1957
1958 for (split /\n/, $spec) {
1959 my ($k, $v) = split /\s+/, $_, 2;
1960
1961 $rmp->{lc $k} = $v if (length $k) && (length $v);
1962 }
1963
1964 $rmp
1965}
1966
1967sub prepare_random_map {
1968 my ($exit) = @_;
1969
1970 my $guard = cf::lock_acquire "exit_prepare:$exit";
1971
1972 # all this does is basically replace the /! path by
1973 # a new random map path (?random/...) with a seed
1974 # that depends on the exit object
1975
1976 my $rmp = parse_random_map_params $exit->msg;
1977
1978 if ($exit->map) {
1979 $rmp->{region} = $exit->region->name;
1980 $rmp->{origin_map} = $exit->map->path;
1981 $rmp->{origin_x} = $exit->x;
1982 $rmp->{origin_y} = $exit->y;
1983 }
1984
1985 $rmp->{random_seed} ||= $exit->random_seed;
1986
1987 my $data = cf::to_json $rmp;
1988 my $md5 = Digest::MD5::md5_hex $data;
1989 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1990
1991 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1992 aio_write $fh, 0, (length $data), $data, 0;
1993 undef $fh;
1994 aio_rename "$meta~", $meta;
1995
1996 $exit->slaying ("?random/$md5");
1997 $exit->msg (undef);
1998 }
1999}
2000
2001sub cf::object::player::enter_exit {
2002 my ($self, $exit) = @_;
2003
2004 return unless $self->type == cf::PLAYER;
2005
2006 if ($exit->slaying eq "/!") {
2007 #TODO: this should de-fi-ni-te-ly not be a sync-job
2008 # the problem is that $exit might not survive long enough
2009 # so it needs to be done right now, right here
2010 cf::sync_job { prepare_random_map $exit };
2011 }
2012
2013 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2014 my $hp = $exit->stats->hp;
2015 my $sp = $exit->stats->sp;
2016
2017 $self->enter_link;
2018
2019 (async {
2020 $self->deactivate_recursive; # just to be sure
2021 unless (eval {
2022 $self->goto ($slaying, $hp, $sp);
2023
2024 1;
2025 }) {
2026 $self->message ("Something went wrong deep within the crossfire server. "
2027 . "I'll try to bring you back to the map you were before. "
2028 . "Please report this to the dungeon master!",
2029 cf::NDI_UNIQUE | cf::NDI_RED);
2030
2031 warn "ERROR in enter_exit: $@";
2032 $self->leave_link;
2033 }
2034 })->prio (1);
2035}
2036
829=head3 cf::client 2037=head3 cf::client
830 2038
831=over 4 2039=over 4
832 2040
833=item $client->send_drawinfo ($text, $flags) 2041=item $client->send_drawinfo ($text, $flags)
839 2047
840sub cf::client::send_drawinfo { 2048sub cf::client::send_drawinfo {
841 my ($self, $text, $flags) = @_; 2049 my ($self, $text, $flags) = @_;
842 2050
843 utf8::encode $text; 2051 utf8::encode $text;
844 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2052 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
845} 2053}
846 2054
2055=item $client->ext_event ($type, %msg)
2056
2057Sends an exti event to the client.
2058
2059=cut
2060
2061sub cf::client::ext_event($$%) {
2062 my ($self, $type, %msg) = @_;
2063
2064 $msg{msgtype} = "event_$type";
2065 $self->send_packet ("ext " . cf::to_json \%msg);
2066}
847 2067
848=item $success = $client->query ($flags, "text", \&cb) 2068=item $success = $client->query ($flags, "text", \&cb)
849 2069
850Queues a query to the client, calling the given callback with 2070Queues a query to the client, calling the given callback with
851the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2071the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
876 on_reply => sub { 2096 on_reply => sub {
877 my ($ns, $msg) = @_; 2097 my ($ns, $msg) = @_;
878 2098
879 # this weird shuffling is so that direct followup queries 2099 # this weird shuffling is so that direct followup queries
880 # get handled first 2100 # get handled first
881 my $queue = delete $ns->{query_queue}; 2101 my $queue = delete $ns->{query_queue}
2102 or return; # be conservative, not sure how that can happen, but we saw a crash here
882 2103
883 (shift @$queue)->[1]->($msg); 2104 (shift @$queue)->[1]->($msg);
2105 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
884 2106
885 push @{ $ns->{query_queue} }, @$queue; 2107 push @{ $ns->{query_queue} }, @$queue;
886 2108
887 if (@{ $ns->{query_queue} } == @$queue) { 2109 if (@{ $ns->{query_queue} } == @$queue) {
888 if (@$queue) { 2110 if (@$queue) {
889 $ns->send_packet ($ns->{query_queue}[0][0]); 2111 $ns->send_packet ($ns->{query_queue}[0][0]);
890 } else { 2112 } else {
891 $ns->state (ST_PLAYING); 2113 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
892 } 2114 }
893 } 2115 }
894 }, 2116 },
895); 2117);
896 2118
897=item $client->coro (\&cb) 2119=item $client->async (\&cb)
898 2120
899Create a new coroutine, running the specified callback. The coroutine will 2121Create a new coroutine, running the specified callback. The coroutine will
900be automatically cancelled when the client gets destroyed (e.g. on logout, 2122be automatically cancelled when the client gets destroyed (e.g. on logout,
901or loss of connection). 2123or loss of connection).
902 2124
903=cut 2125=cut
904 2126
905sub cf::client::coro { 2127sub cf::client::async {
906 my ($self, $cb) = @_; 2128 my ($self, $cb) = @_;
907 2129
908 my $coro; $coro = async { 2130 my $coro = &Coro::async ($cb);
909 eval { 2131
910 $cb->(); 2132 $coro->on_destroy (sub {
911 };
912 warn $@ if $@;
913 delete $self->{_coro}{$coro+0}; 2133 delete $self->{_coro}{$coro+0};
914 }; 2134 });
915 2135
916 $self->{_coro}{$coro+0} = $coro; 2136 $self->{_coro}{$coro+0} = $coro;
2137
2138 $coro
917} 2139}
918 2140
919cf::client->attach ( 2141cf::client->attach (
920 on_destroy => sub { 2142 on_destroy => sub {
921 my ($ns) = @_; 2143 my ($ns) = @_;
946 2168
947# here we export the classes and methods available to script code 2169# here we export the classes and methods available to script code
948 2170
949=pod 2171=pod
950 2172
951The following fucntions and emthods are available within a safe environment: 2173The following functions and methods are available within a safe environment:
952 2174
953 cf::object contr pay_amount pay_player map 2175 cf::object contr pay_amount pay_player map
954 cf::object::player player 2176 cf::object::player player
955 cf::player peaceful 2177 cf::player peaceful
956 cf::map trigger 2178 cf::map trigger
1049The parameter C<$family> should best start with the name of the extension 2271The parameter C<$family> should best start with the name of the extension
1050using it, it should be unique. 2272using it, it should be unique.
1051 2273
1052=over 4 2274=over 4
1053 2275
1054=item $hashref = cf::db_get $family
1055
1056Return a hashref for use by the extension C<$family>, which can be
1057modified. After modifications, you have to call C<cf::db_dirty> or
1058C<cf::db_sync>.
1059
1060=item $value = cf::db_get $family => $key 2276=item $value = cf::db_get $family => $key
1061 2277
1062Returns a single value from the database 2278Returns a single value from the database.
1063
1064=item cf::db_put $family => $hashref
1065
1066Stores the given family hashref into the database. Updates are delayed, if
1067you want the data to be synced to disk immediately, use C<cf::db_sync>.
1068 2279
1069=item cf::db_put $family => $key => $value 2280=item cf::db_put $family => $key => $value
1070 2281
1071Stores the given C<$value> in the family hash. Updates are delayed, if you 2282Stores the given C<$value> in the family.
1072want the data to be synced to disk immediately, use C<cf::db_sync>.
1073
1074=item cf::db_dirty
1075
1076Marks the database as dirty, to be updated at a later time.
1077
1078=item cf::db_sync
1079
1080Immediately write the database to disk I<if it is dirty>.
1081 2283
1082=cut 2284=cut
1083 2285
1084our $DB; 2286our $DB;
1085 2287
1086{ 2288sub db_init {
2289 unless ($DB) {
2290 $DB = BDB::db_create $DB_ENV;
2291
2292 cf::sync_job {
2293 eval {
2294 $DB->set_flags (BDB::CHKSUM);
2295
2296 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2297 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2298 cf::cleanup "db_open(db): $!" if $!;
2299 };
2300 cf::cleanup "db_open(db): $@" if $@;
2301 };
2302
1087 my $path = cf::localdir . "/database.pst"; 2303 my $path = cf::localdir . "/database.pst";
2304 if (stat $path) {
2305 cf::sync_job {
2306 my $pst = Storable::retrieve $path;
1088 2307
1089 sub db_load() { 2308 cf::db_put (board => data => $pst->{board});
1090 warn "loading database $path\n";#d# remove later 2309 cf::db_put (guildrules => data => $pst->{guildrules});
1091 $DB = stat $path ? Storable::retrieve $path : { }; 2310 cf::db_put (rent => balance => $pst->{rent}{balance});
1092 } 2311 BDB::db_env_txn_checkpoint $DB_ENV;
1093 2312
1094 my $pid; 2313 unlink $path;
1095
1096 sub db_save() {
1097 warn "saving database $path\n";#d# remove later
1098 waitpid $pid, 0 if $pid;
1099 if (0 == ($pid = fork)) {
1100 $DB->{_meta}{version} = 1;
1101 Storable::nstore $DB, "$path~";
1102 rename "$path~", $path;
1103 cf::_exit 0 if defined $pid;
1104 } 2314 };
1105 }
1106
1107 my $dirty;
1108
1109 sub db_sync() {
1110 db_save if $dirty;
1111 undef $dirty;
1112 }
1113
1114 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1115 db_sync;
1116 });
1117
1118 sub db_dirty() {
1119 $dirty = 1;
1120 $idle->start;
1121 }
1122
1123 sub db_get($;$) {
1124 @_ >= 2
1125 ? $DB->{$_[0]}{$_[1]}
1126 : ($DB->{$_[0]} ||= { })
1127 }
1128
1129 sub db_put($$;$) {
1130 if (@_ >= 3) {
1131 $DB->{$_[0]}{$_[1]} = $_[2];
1132 } else {
1133 $DB->{$_[0]} = $_[1];
1134 }
1135 db_dirty;
1136 }
1137
1138 cf::global->attach (
1139 prio => 10000,
1140 on_cleanup => sub {
1141 db_sync;
1142 }, 2315 }
1143 ); 2316 }
2317}
2318
2319sub db_get($$) {
2320 my $key = "$_[0]/$_[1]";
2321
2322 cf::sync_job {
2323 BDB::db_get $DB, undef, $key, my $data;
2324
2325 $! ? ()
2326 : Compress::LZF::sthaw $data
2327 }
2328}
2329
2330sub db_put($$$) {
2331 BDB::dbreq_pri 4;
2332 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
1144} 2333}
1145 2334
1146############################################################################# 2335#############################################################################
1147# the server's main() 2336# the server's init and main functions
2337
2338sub load_facedata {
2339 my $path = sprintf "%s/facedata", cf::datadir;
2340
2341 warn "loading facedata from $path\n";
2342
2343 my $facedata;
2344 0 < aio_load $path, $facedata
2345 or die "$path: $!";
2346
2347 $facedata = Coro::Storable::thaw $facedata;
2348
2349 $facedata->{version} == 2
2350 or cf::cleanup "$path: version mismatch, cannot proceed.";
2351
2352 {
2353 my $faces = $facedata->{faceinfo};
2354
2355 while (my ($face, $info) = each %$faces) {
2356 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2357 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2358 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2359 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2360 Coro::cede;
2361 }
2362
2363 while (my ($face, $info) = each %$faces) {
2364 next unless $info->{smooth};
2365 my $idx = cf::face::find $face
2366 or next;
2367 if (my $smooth = cf::face::find $info->{smooth}) {
2368 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2369 } else {
2370 warn "smooth face '$info->{smooth}' not found for face '$face'";
2371 }
2372 Coro::cede;
2373 }
2374 }
2375
2376 {
2377 my $anims = $facedata->{animinfo};
2378
2379 while (my ($anim, $info) = each %$anims) {
2380 cf::anim::set $anim, $info->{frames}, $info->{facings};
2381 Coro::cede;
2382 }
2383
2384 cf::anim::invalidate_all; # d'oh
2385 }
2386
2387 1
2388}
2389
2390sub reload_resources {
2391 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2392 or die "unable to load regions file\n";#d#
2393 load_facedata
2394 or die "unable to load facedata\n";#d#
2395}
2396
2397sub init {
2398 reload_resources;
2399}
1148 2400
1149sub cfg_load { 2401sub cfg_load {
1150 open my $fh, "<:utf8", cf::confdir . "/config" 2402 open my $fh, "<:utf8", cf::confdir . "/config"
1151 or return; 2403 or return;
1152 2404
1153 local $/; 2405 local $/;
1154 *CFG = YAML::Syck::Load <$fh>; 2406 *CFG = YAML::Syck::Load <$fh>;
2407
2408 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2409
2410 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2411 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2412
2413 if (exists $CFG{mlockall}) {
2414 eval {
2415 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2416 and die "WARNING: m(un)lockall failed: $!\n";
2417 };
2418 warn $@ if $@;
2419 }
1155} 2420}
1156 2421
1157sub main { 2422sub main {
2423 # we must not ever block the main coroutine
2424 local $Coro::idle = sub {
2425 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2426 (async {
2427 Event::one_event;
2428 })->prio (Coro::PRIO_MAX);
2429 };
2430
1158 cfg_load; 2431 cfg_load;
1159 db_load; 2432 db_init;
1160 load_extensions; 2433 load_extensions;
2434
2435 $TICK_WATCHER->start;
1161 Event::loop; 2436 Event::loop;
1162} 2437}
1163 2438
1164############################################################################# 2439#############################################################################
1165# initialisation 2440# initialisation and cleanup
1166 2441
2442# install some emergency cleanup handlers
2443BEGIN {
2444 for my $signal (qw(INT HUP TERM)) {
2445 Event->signal (
2446 reentrant => 0,
2447 data => WF_AUTOCANCEL,
2448 signal => $signal,
2449 prio => 0,
2450 cb => sub {
2451 cf::cleanup "SIG$signal";
2452 },
2453 );
2454 }
2455}
2456
2457sub emergency_save() {
2458 my $freeze_guard = cf::freeze_mainloop;
2459
2460 warn "enter emergency perl save\n";
2461
2462 cf::sync_job {
2463 # use a peculiar iteration method to avoid tripping on perl
2464 # refcount bugs in for. also avoids problems with players
2465 # and maps saved/destroyed asynchronously.
2466 warn "begin emergency player save\n";
2467 for my $login (keys %cf::PLAYER) {
2468 my $pl = $cf::PLAYER{$login} or next;
2469 $pl->valid or next;
2470 $pl->save;
2471 }
2472 warn "end emergency player save\n";
2473
2474 warn "begin emergency map save\n";
2475 for my $path (keys %cf::MAP) {
2476 my $map = $cf::MAP{$path} or next;
2477 $map->valid or next;
2478 $map->save;
2479 }
2480 warn "end emergency map save\n";
2481
2482 warn "begin emergency database checkpoint\n";
2483 BDB::db_env_txn_checkpoint $DB_ENV;
2484 warn "end emergency database checkpoint\n";
2485 };
2486
2487 warn "leave emergency perl save\n";
2488}
2489
2490sub post_cleanup {
2491 my ($make_core) = @_;
2492
2493 warn Carp::longmess "post_cleanup backtrace"
2494 if $make_core;
2495}
2496
1167sub _perl_reload(&) { 2497sub reload() {
1168 my ($msg) = @_; 2498 # can/must only be called in main
2499 if ($Coro::current != $Coro::main) {
2500 warn "can only reload from main coroutine";
2501 return;
2502 }
1169 2503
1170 $msg->("reloading..."); 2504 warn "reloading...";
1171 2505
1172 eval { 2506 warn "entering sync_job";
1173 # cancel all watchers 2507
2508 cf::sync_job {
2509 cf::write_runtime; # external watchdog should not bark
2510 cf::emergency_save;
2511 cf::write_runtime; # external watchdog should not bark
2512
2513 warn "syncing database to disk";
2514 BDB::db_env_txn_checkpoint $DB_ENV;
2515
2516 # if anything goes wrong in here, we should simply crash as we already saved
2517
2518 warn "cancelling all WF_AUTOCANCEL watchers";
1174 for (Event::all_watchers) { 2519 for (Event::all_watchers) {
1175 $_->cancel if $_->data & WF_AUTOCANCEL; 2520 $_->cancel if $_->data & WF_AUTOCANCEL;
1176 } 2521 }
1177 2522
1178 # unload all extensions 2523 warn "flushing outstanding aio requests";
1179 for (@exts) { 2524 for (;;) {
1180 $msg->("unloading <$_>"); 2525 BDB::flush;
1181 unload_extension $_; 2526 IO::AIO::flush;
2527 Coro::cede;
2528 last unless IO::AIO::nreqs || BDB::nreqs;
2529 warn "iterate...";
2530 }
2531
2532 ++$RELOAD;
2533
2534 warn "cancelling all extension coros";
2535 $_->cancel for values %EXT_CORO;
2536 %EXT_CORO = ();
2537
2538 warn "removing commands";
2539 %COMMAND = ();
2540
2541 warn "removing ext commands";
2542 %EXTCMD = ();
2543
2544 warn "unloading/nuking all extensions";
2545 for my $pkg (@EXTS) {
2546 warn "... unloading $pkg";
2547
2548 if (my $cb = $pkg->can ("unload")) {
2549 eval {
2550 $cb->($pkg);
2551 1
2552 } or warn "$pkg unloaded, but with errors: $@";
1182 } 2553 }
1183 2554
2555 warn "... nuking $pkg";
2556 Symbol::delete_package $pkg;
2557 }
2558
1184 # unload all modules loaded from $LIBDIR 2559 warn "unloading all perl modules loaded from $LIBDIR";
1185 while (my ($k, $v) = each %INC) { 2560 while (my ($k, $v) = each %INC) {
1186 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2561 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1187 2562
1188 $msg->("removing <$k>"); 2563 warn "... unloading $k";
1189 delete $INC{$k}; 2564 delete $INC{$k};
1190 2565
1191 $k =~ s/\.pm$//; 2566 $k =~ s/\.pm$//;
1192 $k =~ s/\//::/g; 2567 $k =~ s/\//::/g;
1193 2568
1196 } 2571 }
1197 2572
1198 Symbol::delete_package $k; 2573 Symbol::delete_package $k;
1199 } 2574 }
1200 2575
1201 # sync database to disk
1202 cf::db_sync;
1203
1204 # get rid of safe::, as good as possible 2576 warn "getting rid of safe::, as good as possible";
1205 Symbol::delete_package "safe::$_" 2577 Symbol::delete_package "safe::$_"
1206 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2578 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1207 2579
1208 # remove register_script_function callbacks
1209 # TODO
1210
1211 # unload cf.pm "a bit" 2580 warn "unloading cf.pm \"a bit\"";
1212 delete $INC{"cf.pm"}; 2581 delete $INC{"cf.pm"};
1213 2582
1214 # don't, removes xs symbols, too, 2583 # don't, removes xs symbols, too,
1215 # and global variables created in xs 2584 # and global variables created in xs
1216 #Symbol::delete_package __PACKAGE__; 2585 #Symbol::delete_package __PACKAGE__;
1217 2586
1218 # reload cf.pm 2587 warn "unload completed, starting to reload now";
2588
1219 $msg->("reloading cf.pm"); 2589 warn "reloading cf.pm";
1220 require cf; 2590 require cf;
2591 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1221 2592
1222 # load config and database again 2593 warn "loading config and database again";
1223 cf::cfg_load; 2594 cf::cfg_load;
1224 cf::db_load;
1225 2595
1226 # load extensions 2596 warn "loading extensions";
1227 $msg->("load extensions");
1228 cf::load_extensions; 2597 cf::load_extensions;
1229 2598
1230 # reattach attachments to objects 2599 warn "reattaching attachments to objects/players";
1231 $msg->("reattach"); 2600 _global_reattach; # objects, sockets
1232 _global_reattach; 2601 warn "reattaching attachments to maps";
2602 reattach $_ for values %MAP;
2603 warn "reattaching attachments to players";
2604 reattach $_ for values %PLAYER;
2605
2606 warn "loading reloadable resources";
2607 reload_resources;
2608
2609 warn "leaving sync_job";
2610
2611 1
2612 } or do {
2613 warn $@;
2614 warn "error while reloading, exiting.";
2615 exit 1;
1233 }; 2616 };
1234 $msg->($@) if $@;
1235 2617
1236 $msg->("reloaded"); 2618 warn "reloaded";
1237}; 2619};
1238 2620
1239sub perl_reload() { 2621our $RELOAD_WATCHER; # used only during reload
1240 _perl_reload {
1241 warn $_[0];
1242 print "$_[0]\n";
1243 };
1244}
1245 2622
1246register "<global>", __PACKAGE__;
1247
1248register_command "perl-reload" => sub { 2623register_command "reload" => sub {
1249 my ($who, $arg) = @_; 2624 my ($who, $arg) = @_;
1250 2625
1251 if ($who->flag (FLAG_WIZ)) { 2626 if ($who->flag (FLAG_WIZ)) {
1252 _perl_reload { 2627 $who->message ("reloading server.");
1253 warn $_[0]; 2628
1254 $who->message ($_[0]); 2629 # doing reload synchronously and two reloads happen back-to-back,
2630 # coro crashes during coro_state_free->destroy here.
2631
2632 $RELOAD_WATCHER ||= Event->timer (
2633 reentrant => 0,
2634 after => 0,
2635 data => WF_AUTOCANCEL,
2636 cb => sub {
2637 reload;
2638 undef $RELOAD_WATCHER;
2639 },
1255 }; 2640 );
1256 } 2641 }
1257}; 2642};
1258 2643
1259unshift @INC, $LIBDIR; 2644unshift @INC, $LIBDIR;
1260 2645
2646my $bug_warning = 0;
2647
1261$TICK_WATCHER = Event->timer ( 2648$TICK_WATCHER = Event->timer (
2649 reentrant => 0,
2650 parked => 1,
1262 prio => 0, 2651 prio => 0,
1263 at => $NEXT_TICK || 1, 2652 at => $NEXT_TICK || $TICK,
1264 data => WF_AUTOCANCEL, 2653 data => WF_AUTOCANCEL,
1265 cb => sub { 2654 cb => sub {
2655 if ($Coro::current != $Coro::main) {
2656 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2657 unless ++$bug_warning > 10;
2658 return;
2659 }
2660
2661 $NOW = Event::time;
2662
1266 cf::server_tick; # one server iteration 2663 cf::server_tick; # one server iteration
1267 2664 $RUNTIME += $TICK;
1268 my $NOW = Event::time;
1269 $NEXT_TICK += $TICK; 2665 $NEXT_TICK += $TICK;
1270 2666
2667 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2668 $NEXT_RUNTIME_WRITE = $NOW + 10;
2669 Coro::async_pool {
2670 write_runtime
2671 or warn "ERROR: unable to write runtime file: $!";
2672 };
2673 }
2674
2675 $WAIT_FOR_TICK->broadcast;
2676 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2677
2678# my $AFTER = Event::time;
2679# warn $AFTER - $NOW;#d#
2680
1271 # if we are delayed by four ticks or more, skip them all 2681 # if we are delayed by four ticks or more, skip them all
1272 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2682 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1273 2683
1274 $TICK_WATCHER->at ($NEXT_TICK); 2684 $TICK_WATCHER->at ($NEXT_TICK);
1275 $TICK_WATCHER->start; 2685 $TICK_WATCHER->start;
1276 }, 2686 },
1277); 2687);
1278 2688
2689{
2690 BDB::max_poll_time $TICK * 0.1;
2691 $BDB_POLL_WATCHER = Event->io (
2692 reentrant => 0,
2693 fd => BDB::poll_fileno,
2694 poll => 'r',
2695 prio => 0,
2696 data => WF_AUTOCANCEL,
2697 cb => \&BDB::poll_cb,
2698 );
2699 BDB::min_parallel 8;
2700
2701 BDB::set_sync_prepare {
2702 my $status;
2703 my $current = $Coro::current;
2704 (
2705 sub {
2706 $status = $!;
2707 $current->ready; undef $current;
2708 },
2709 sub {
2710 Coro::schedule while defined $current;
2711 $! = $status;
2712 },
2713 )
2714 };
2715
2716 unless ($DB_ENV) {
2717 $DB_ENV = BDB::db_env_create;
2718
2719 cf::sync_job {
2720 eval {
2721 BDB::db_env_open
2722 $DB_ENV,
2723 $BDB_ENV_DIR,
2724 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2725 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2726 0666;
2727
2728 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
2729
2730 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2731 $DB_ENV->set_lk_detect;
2732 };
2733
2734 cf::cleanup "db_env_open(db): $@" if $@;
2735 };
2736 }
2737}
2738
2739{
2740 IO::AIO::min_parallel 8;
2741
2742 undef $Coro::AIO::WATCHER;
1279IO::AIO::max_poll_time $TICK * 0.2; 2743 IO::AIO::max_poll_time $TICK * 0.1;
1280 2744 $AIO_POLL_WATCHER = Event->io (
1281Event->io (fd => IO::AIO::poll_fileno, 2745 reentrant => 0,
1282 poll => 'r',
1283 prio => 5,
1284 data => WF_AUTOCANCEL, 2746 data => WF_AUTOCANCEL,
2747 fd => IO::AIO::poll_fileno,
2748 poll => 'r',
2749 prio => 6,
1285 cb => \&IO::AIO::poll_cb); 2750 cb => \&IO::AIO::poll_cb,
2751 );
2752}
2753
2754END { cf::emergency_save }
1286 2755
12871 27561
1288 2757

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines