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.98 by root, Fri Dec 22 16:34:00 2006 UTC vs.
Revision 1.237 by root, Fri Apr 13 05:08:51 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
1164package cf;
1165
1166=back
1167
1168
1169=head3 cf::map
1170
1171=over 4
1172
1173=cut
1174
1175package cf::map;
1176
1177use Fcntl;
1178use Coro::AIO;
1179
1180use overload
1181 '""' => \&as_string,
1182 fallback => 1;
1183
1184our $MAX_RESET = 3600;
1185our $DEFAULT_RESET = 3000;
1186
1187sub generate_random_map {
1188 my ($self, $rmp) = @_;
1189 # mit "rum" bekleckern, nicht
1190 $self->_create_random_map (
1191 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1192 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1193 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1194 $rmp->{exit_on_final_map},
1195 $rmp->{xsize}, $rmp->{ysize},
1196 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1197 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1198 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1199 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1200 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1201 (cf::region::find $rmp->{region}), $rmp->{custom}
1202 )
1203}
1204
1205=item cf::map->register ($regex, $prio)
1206
1207Register a handler for the map path matching the given regex at the
1208givne priority (higher is better, built-in handlers have priority 0, the
1209default).
1210
1211=cut
1212
1213sub register {
1214 my (undef, $regex, $prio) = @_;
1215 my $pkg = caller;
1216
1217 no strict;
1218 push @{"$pkg\::ISA"}, __PACKAGE__;
1219
1220 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1221}
1222
1223# also paths starting with '/'
1224$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1225
1226sub thawer_merge {
1227 my ($self, $merge) = @_;
1228
1229 # we have to keep some variables in memory intact
1230 local $self->{path};
1231 local $self->{load_path};
1232 local $self->{deny_save};
1233 local $self->{deny_reset};
1234
1235 $self->SUPER::thawer_merge ($merge);
1236}
1237
1238sub normalise {
1239 my ($path, $base) = @_;
1240
1241 $path = "$path"; # make sure its a string
1242
1243 $path =~ s/\.map$//;
1244
1245 # map plan:
1246 #
1247 # /! non-realised random map exit (special hack!)
1248 # {... are special paths that are not being touched
1249 # ?xxx/... are special absolute paths
1250 # ?random/... random maps
1251 # /... normal maps
1252 # ~user/... per-player map of a specific user
1253
1254 $path =~ s/$PATH_SEP/\//go;
1255
1256 # treat it as relative path if it starts with
1257 # something that looks reasonable
1258 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1259 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1260
1261 $base =~ s{[^/]+/?$}{};
1262 $path = "$base/$path";
1263 }
1264
1265 for ($path) {
1266 redo if s{//}{/};
1267 redo if s{/\.?/}{/};
1268 redo if s{/[^/]+/\.\./}{/};
1269 }
1270
1271 $path
1272}
1273
1274sub new_from_path {
1275 my (undef, $path, $base) = @_;
1276
1277 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1278
1279 $path = normalise $path, $base;
1280
1281 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1282 if ($path =~ $EXT_MAP{$pkg}[1]) {
1283 my $self = bless cf::map::new, $pkg;
1284 $self->{path} = $path; $self->path ($path);
1285 $self->init; # pass $1 etc.
1286 return $self;
1287 }
1288 }
1289
1290 Carp::carp "unable to resolve path '$path' (base '$base').";
1291 ()
1292}
1293
1294sub init {
1295 my ($self) = @_;
1296
1297 $self
1298}
1299
1300sub as_string {
1301 my ($self) = @_;
1302
1303 "$self->{path}"
1304}
1305
1306# the displayed name, this is a one way mapping
1307sub visible_name {
1308 &as_string
1309}
1310
1311# the original (read-only) location
1312sub load_path {
1313 my ($self) = @_;
1314
1315 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
1316}
1317
1318# the temporary/swap location
1319sub save_path {
1320 my ($self) = @_;
1321
1322 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1323 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
1324}
1325
1326# the unique path, undef == no special unique path
1327sub uniq_path {
1328 my ($self) = @_;
1329
1330 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1331 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1332}
1333
1334# and all this just because we cannot iterate over
1335# all maps in C++...
1336sub change_all_map_light {
1337 my ($change) = @_;
1338
1339 $_->change_map_light ($change)
1340 for grep $_->outdoor, values %cf::MAP;
1341}
1342
1343sub unlink_save {
1344 my ($self) = @_;
1345
1346 utf8::encode (my $save = $self->save_path);
1347 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1348 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1349}
1350
1351sub load_header_from($) {
1352 my ($self, $path) = @_;
1353
1354 utf8::encode $path;
1355 #aio_open $path, O_RDONLY, 0
1356 # or return;
1357
1358 $self->_load_header ($path)
1359 or return;
1360
1361 $self->{load_path} = $path;
1362
1363 1
1364}
1365
1366sub load_header_orig {
1367 my ($self) = @_;
1368
1369 $self->load_header_from ($self->load_path)
1370}
1371
1372sub load_header_temp {
1373 my ($self) = @_;
1374
1375 $self->load_header_from ($self->save_path)
1376}
1377
1378sub prepare_temp {
1379 my ($self) = @_;
1380
1381 $self->last_access ((delete $self->{last_access})
1382 || $cf::RUNTIME); #d#
1383 # safety
1384 $self->{instantiate_time} = $cf::RUNTIME
1385 if $self->{instantiate_time} > $cf::RUNTIME;
1386}
1387
1388sub prepare_orig {
1389 my ($self) = @_;
1390
1391 $self->{load_original} = 1;
1392 $self->{instantiate_time} = $cf::RUNTIME;
1393 $self->last_access ($cf::RUNTIME);
1394 $self->instantiate;
1395}
1396
1397sub load_header {
1398 my ($self) = @_;
1399
1400 if ($self->load_header_temp) {
1401 $self->prepare_temp;
1402 } else {
1403 $self->load_header_orig
1404 or return;
1405 $self->prepare_orig;
1406 }
1407
1408 1
1409}
1410
1411sub find;
1412sub find {
1413 my ($path, $origin) = @_;
1414
1415 $path = normalise $path, $origin && $origin->path;
1416
1417 cf::lock_wait "map_find:$path";
1418
1419 $cf::MAP{$path} || do {
1420 my $guard = cf::lock_acquire "map_find:$path";
1421 my $map = new_from_path cf::map $path
1422 or return;
1423
1424 $map->{last_save} = $cf::RUNTIME;
1425
1426 $map->load_header
1427 or return;
1428
1429 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1430 # doing this can freeze the server in a sync job, obviously
1431 #$cf::WAIT_FOR_TICK->wait;
1432 $map->reset;
1433 undef $guard;
1434 return find $path;
1435 }
1436
1437 $cf::MAP{$path} = $map
1438 }
1439}
1440
1441sub pre_load { }
1442sub post_load { }
1443
1444sub load {
1445 my ($self) = @_;
1446
1447 local $self->{deny_reset} = 1; # loading can take a long time
1448
1449 my $path = $self->{path};
1450 my $guard = cf::lock_acquire "map_load:$path";
1451
1452 return if $self->in_memory != cf::MAP_SWAPPED;
1453
1454 $self->in_memory (cf::MAP_LOADING);
1455
1456 $self->alloc;
1457
1458 $self->pre_load;
1459
1460 $self->_load_objects ($self->{load_path}, 1)
1461 or return;
1462
1463 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1464 if delete $self->{load_original};
1465
1466 if (my $uniq = $self->uniq_path) {
1467 utf8::encode $uniq;
1468 if (aio_open $uniq, O_RDONLY, 0) {
1469 $self->clear_unique_items;
1470 $self->_load_objects ($uniq, 0);
1471 }
1472 }
1473
1474 Coro::cede;
1475
1476 # now do the right thing for maps
1477 $self->link_multipart_objects;
1478
1479 unless ($self->{deny_activate}) {
1480 $self->decay_objects;
1481 $self->fix_auto_apply;
1482 $self->update_buttons;
1483 Coro::cede;
1484 $self->set_darkness_map;
1485 $self->difficulty ($self->estimate_difficulty)
1486 unless $self->difficulty;
1487 Coro::cede;
1488 $self->activate;
1489 }
1490
1491 $self->post_load;
1492
1493 $self->in_memory (cf::MAP_IN_MEMORY);
1494}
1495
1496sub customise_for {
1497 my ($self, $ob) = @_;
1498
1499 return find "~" . $ob->name . "/" . $self->{path}
1500 if $self->per_player;
1501
1502 $self
1503}
1504
1505# find and load all maps in the 3x3 area around a map
1506sub load_diag {
716 my ($map) = @_; 1507 my ($map) = @_;
717 1508
718 my $path = $map->tmpname; 1509 my @diag; # diagonal neighbours
719 defined $path or return;
720 1510
721 unlink "$path.pst"; 1511 for (0 .. 3) {
722}; 1512 my $neigh = $map->tile_path ($_)
1513 or next;
1514 $neigh = find $neigh, $map
1515 or next;
1516 $neigh->load;
723 1517
724cf::map->attach (prio => -10000, package => cf::mapsupport::); 1518 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1519 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1520 }
725 1521
726############################################################################# 1522 for (@diag) {
727# load/save perl data associated with player->ob objects 1523 my $neigh = find @$_
728 1524 or next;
729sub all_objects(@) { 1525 $neigh->load;
730 @_, map all_objects ($_->inv), @_ 1526 }
731} 1527}
732 1528
733# TODO: compatibility cruft, remove when no longer needed 1529sub find_sync {
734cf::player->attach ( 1530 my ($path, $origin) = @_;
735 on_load => sub {
736 my ($pl, $path) = @_;
737 1531
738 for my $o (all_objects $pl->ob) { 1532 cf::sync_job { find $path, $origin }
739 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1533}
740 $o->set_ob_key_value ("_perl_data");
741 1534
742 %$o = %{ Storable::thaw pack "H*", $value }; 1535sub do_load_sync {
1536 my ($map) = @_;
1537
1538 cf::sync_job { $map->load };
1539}
1540
1541our %MAP_PREFETCH;
1542our $MAP_PREFETCHER = undef;
1543
1544sub find_async {
1545 my ($path, $origin) = @_;
1546
1547 $path = normalise $path, $origin && $origin->{path};
1548
1549 if (my $map = $cf::MAP{$path}) {
1550 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1551 }
1552
1553 undef $MAP_PREFETCH{$path};
1554 $MAP_PREFETCHER ||= cf::async {
1555 while (%MAP_PREFETCH) {
1556 for my $path (keys %MAP_PREFETCH) {
1557 my $map = find $path
1558 or next;
1559 $map->load;
1560
1561 delete $MAP_PREFETCH{$path};
743 } 1562 }
744 } 1563 }
1564 undef $MAP_PREFETCHER;
1565 };
1566 $MAP_PREFETCHER->prio (6);
1567
1568 ()
1569}
1570
1571sub save {
1572 my ($self) = @_;
1573
1574 my $lock = cf::lock_acquire "map_data:" . $self->path;
1575
1576 $self->{last_save} = $cf::RUNTIME;
1577
1578 return unless $self->dirty;
1579
1580 my $save = $self->save_path; utf8::encode $save;
1581 my $uniq = $self->uniq_path; utf8::encode $uniq;
1582
1583 $self->{load_path} = $save;
1584
1585 return if $self->{deny_save};
1586
1587 local $self->{last_access} = $self->last_access;#d#
1588
1589 cf::async {
1590 $_->contr->save for $self->players;
1591 };
1592
1593 if ($uniq) {
1594 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1595 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1596 } else {
1597 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
745 }, 1598 }
746); 1599}
747 1600
748############################################################################# 1601sub swap_out {
1602 my ($self) = @_;
749 1603
750=head2 CORE EXTENSIONS 1604 # save first because save cedes
1605 $self->save;
751 1606
752Functions and methods that extend core crossfire objects. 1607 my $lock = cf::lock_acquire "map_data:" . $self->path;
753 1608
754=head3 cf::player 1609 return if $self->players;
1610 return if $self->in_memory != cf::MAP_IN_MEMORY;
1611 return if $self->{deny_save};
1612
1613 $self->clear;
1614 $self->in_memory (cf::MAP_SWAPPED);
1615}
1616
1617sub reset_at {
1618 my ($self) = @_;
1619
1620 # TODO: safety, remove and allow resettable per-player maps
1621 return 1e99 if $self->isa ("ext::map_per_player");#d#
1622 return 1e99 if $self->{deny_reset};
1623
1624 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1625 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1626
1627 $time + $to
1628}
1629
1630sub should_reset {
1631 my ($self) = @_;
1632
1633 $self->reset_at <= $cf::RUNTIME
1634}
1635
1636sub reset {
1637 my ($self) = @_;
1638
1639 my $lock = cf::lock_acquire "map_data:$self->{path}";
1640
1641 return if $self->players;
1642 return if $self->isa ("ext::map_per_player");#d#
1643
1644 warn "resetting map ", $self->path;#d#
1645
1646 $self->in_memory (cf::MAP_SWAPPED);
1647
1648 # need to save uniques path
1649 unless ($self->{deny_save}) {
1650 my $uniq = $self->uniq_path; utf8::encode $uniq;
1651
1652 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1653 if $uniq;
1654 }
1655
1656 delete $cf::MAP{$self->path};
1657
1658 $self->clear;
1659
1660 $_->clear_links_to ($self) for values %cf::MAP;
1661
1662 $self->unlink_save;
1663 $self->destroy;
1664}
1665
1666my $nuke_counter = "aaaa";
1667
1668sub nuke {
1669 my ($self) = @_;
1670
1671 delete $cf::MAP{$self->path};
1672
1673 $self->unlink_save;
1674
1675 bless $self, "cf::map";
1676 delete $self->{deny_reset};
1677 $self->{deny_save} = 1;
1678 $self->reset_timeout (1);
1679 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1680
1681 $cf::MAP{$self->path} = $self;
1682
1683 $self->reset; # polite request, might not happen
1684}
1685
1686=item cf::map::unique_maps
1687
1688Returns an arrayref of paths of all shared maps that have
1689instantiated unique items. May block.
1690
1691=cut
1692
1693sub unique_maps() {
1694 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1695 or return;
1696
1697 my @paths;
1698
1699 for (@$files) {
1700 utf8::decode $_;
1701 next if /\.pst$/;
1702 next unless /^$PATH_SEP/o;
1703
1704 push @paths, cf::map::normalise $_;
1705 }
1706
1707 \@paths
1708}
1709
1710package cf;
1711
1712=back
1713
1714=head3 cf::object
1715
1716=cut
1717
1718package cf::object;
755 1719
756=over 4 1720=over 4
757 1721
758=item cf::player::exists $login 1722=item $ob->inv_recursive
759 1723
760Returns true when the given account exists. 1724Returns the inventory of the object _and_ their inventories, recursively.
761 1725
762=cut 1726=cut
763 1727
764sub cf::player::exists($) { 1728sub inv_recursive_;
765 cf::player::find $_[0] 1729sub inv_recursive_ {
766 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1730 map { $_, inv_recursive_ $_->inv } @_
767} 1731}
768 1732
769=item $player->ext_reply ($msgid, $msgtype, %msg) 1733sub inv_recursive {
770 1734 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} 1735}
1736
1737package cf;
782 1738
783=back 1739=back
784 1740
785=head3 cf::object::player 1741=head3 cf::object::player
786 1742
824 (ref $cf::CFG{"may_$access"} 1780 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1781 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"}) 1782 : $cf::CFG{"may_$access"})
827} 1783}
828 1784
1785=item $player_object->enter_link
1786
1787Freezes the player and moves him/her to a special map (C<{link}>).
1788
1789The player should be reasonably safe there for short amounts of time. You
1790I<MUST> call C<leave_link> as soon as possible, though.
1791
1792Will never block.
1793
1794=item $player_object->leave_link ($map, $x, $y)
1795
1796Moves the player out of the special C<{link}> map onto the specified
1797map. If the map is not valid (or omitted), the player will be moved back
1798to the location he/she was before the call to C<enter_link>, or, if that
1799fails, to the emergency map position.
1800
1801Might block.
1802
1803=cut
1804
1805sub link_map {
1806 unless ($LINK_MAP) {
1807 $LINK_MAP = cf::map::find "{link}"
1808 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1809 $LINK_MAP->load;
1810 }
1811
1812 $LINK_MAP
1813}
1814
1815sub cf::object::player::enter_link {
1816 my ($self) = @_;
1817
1818 $self->deactivate_recursive;
1819
1820 return if UNIVERSAL::isa $self->map, "ext::map_link";
1821
1822 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1823 if $self->map;
1824
1825 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1826}
1827
1828sub cf::object::player::leave_link {
1829 my ($self, $map, $x, $y) = @_;
1830
1831 my $link_pos = delete $self->{_link_pos};
1832
1833 unless ($map) {
1834 # restore original map position
1835 ($map, $x, $y) = @{ $link_pos || [] };
1836 $map = cf::map::find $map;
1837
1838 unless ($map) {
1839 ($map, $x, $y) = @$EMERGENCY_POSITION;
1840 $map = cf::map::find $map
1841 or die "FATAL: cannot load emergency map\n";
1842 }
1843 }
1844
1845 ($x, $y) = (-1, -1)
1846 unless (defined $x) && (defined $y);
1847
1848 # use -1 or undef as default coordinates, not 0, 0
1849 ($x, $y) = ($map->enter_x, $map->enter_y)
1850 if $x <=0 && $y <= 0;
1851
1852 $map->load;
1853 $map->load_diag;
1854
1855 return unless $self->contr->active;
1856 $self->activate_recursive;
1857
1858 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1859 $self->enter_map ($map, $x, $y);
1860}
1861
1862cf::player->attach (
1863 on_logout => sub {
1864 my ($pl) = @_;
1865
1866 # abort map switching before logout
1867 if ($pl->ob->{_link_pos}) {
1868 cf::sync_job {
1869 $pl->ob->leave_link
1870 };
1871 }
1872 },
1873 on_login => sub {
1874 my ($pl) = @_;
1875
1876 # try to abort aborted map switching on player login :)
1877 # should happen only on crashes
1878 if ($pl->ob->{_link_pos}) {
1879 $pl->ob->enter_link;
1880 (async {
1881 $pl->ob->reply (undef,
1882 "There was an internal problem at your last logout, "
1883 . "the server will try to bring you to your intended destination in a second.",
1884 cf::NDI_RED);
1885 # we need this sleep as the login has a concurrent enter_exit running
1886 # and this sleep increases chances of the player not ending up in scorn
1887 Coro::Timer::sleep 1;
1888 $pl->ob->leave_link;
1889 })->prio (2);
1890 }
1891 },
1892);
1893
1894=item $player_object->goto ($path, $x, $y)
1895
1896=cut
1897
1898sub cf::object::player::goto {
1899 my ($self, $path, $x, $y) = @_;
1900
1901 $self->enter_link;
1902
1903 (async {
1904 my $map = eval {
1905 my $map = cf::map::find $path;
1906 $map = $map->customise_for ($self) if $map;
1907 $map
1908 } or
1909 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1910
1911 $self->leave_link ($map, $x, $y);
1912 })->prio (1);
1913}
1914
1915=item $player_object->enter_exit ($exit_object)
1916
1917=cut
1918
1919sub parse_random_map_params {
1920 my ($spec) = @_;
1921
1922 my $rmp = { # defaults
1923 xsize => (cf::rndm 15, 40),
1924 ysize => (cf::rndm 15, 40),
1925 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1926 #layout => string,
1927 };
1928
1929 for (split /\n/, $spec) {
1930 my ($k, $v) = split /\s+/, $_, 2;
1931
1932 $rmp->{lc $k} = $v if (length $k) && (length $v);
1933 }
1934
1935 $rmp
1936}
1937
1938sub prepare_random_map {
1939 my ($exit) = @_;
1940
1941 my $guard = cf::lock_acquire "exit_prepare:$exit";
1942
1943 # all this does is basically replace the /! path by
1944 # a new random map path (?random/...) with a seed
1945 # that depends on the exit object
1946
1947 my $rmp = parse_random_map_params $exit->msg;
1948
1949 if ($exit->map) {
1950 $rmp->{region} = $exit->region->name;
1951 $rmp->{origin_map} = $exit->map->path;
1952 $rmp->{origin_x} = $exit->x;
1953 $rmp->{origin_y} = $exit->y;
1954 }
1955
1956 $rmp->{random_seed} ||= $exit->random_seed;
1957
1958 my $data = cf::to_json $rmp;
1959 my $md5 = Digest::MD5::md5_hex $data;
1960 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1961
1962 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1963 aio_write $fh, 0, (length $data), $data, 0;
1964 undef $fh;
1965 aio_rename "$meta~", $meta;
1966
1967 $exit->slaying ("?random/$md5");
1968 $exit->msg (undef);
1969 }
1970}
1971
1972sub cf::object::player::enter_exit {
1973 my ($self, $exit) = @_;
1974
1975 return unless $self->type == cf::PLAYER;
1976
1977 if ($exit->slaying eq "/!") {
1978 #TODO: this should de-fi-ni-te-ly not be a sync-job
1979 # the problem is that $exit might not survive long enough
1980 # so it needs to be done right now, right here
1981 cf::sync_job { prepare_random_map $exit };
1982 }
1983
1984 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1985 my $hp = $exit->stats->hp;
1986 my $sp = $exit->stats->sp;
1987
1988 $self->enter_link;
1989
1990 (async {
1991 $self->deactivate_recursive; # just to be sure
1992 unless (eval {
1993 $self->goto ($slaying, $hp, $sp);
1994
1995 1;
1996 }) {
1997 $self->message ("Something went wrong deep within the crossfire server. "
1998 . "I'll try to bring you back to the map you were before. "
1999 . "Please report this to the dungeon master!",
2000 cf::NDI_UNIQUE | cf::NDI_RED);
2001
2002 warn "ERROR in enter_exit: $@";
2003 $self->leave_link;
2004 }
2005 })->prio (1);
2006}
2007
829=head3 cf::client 2008=head3 cf::client
830 2009
831=over 4 2010=over 4
832 2011
833=item $client->send_drawinfo ($text, $flags) 2012=item $client->send_drawinfo ($text, $flags)
839 2018
840sub cf::client::send_drawinfo { 2019sub cf::client::send_drawinfo {
841 my ($self, $text, $flags) = @_; 2020 my ($self, $text, $flags) = @_;
842 2021
843 utf8::encode $text; 2022 utf8::encode $text;
844 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2023 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
845} 2024}
846 2025
2026=item $client->ext_event ($type, %msg)
2027
2028Sends an exti event to the client.
2029
2030=cut
2031
2032sub cf::client::ext_event($$%) {
2033 my ($self, $type, %msg) = @_;
2034
2035 $msg{msgtype} = "event_$type";
2036 $self->send_packet ("ext " . cf::to_json \%msg);
2037}
847 2038
848=item $success = $client->query ($flags, "text", \&cb) 2039=item $success = $client->query ($flags, "text", \&cb)
849 2040
850Queues a query to the client, calling the given callback with 2041Queues a query to the client, calling the given callback with
851the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2042the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
876 on_reply => sub { 2067 on_reply => sub {
877 my ($ns, $msg) = @_; 2068 my ($ns, $msg) = @_;
878 2069
879 # this weird shuffling is so that direct followup queries 2070 # this weird shuffling is so that direct followup queries
880 # get handled first 2071 # get handled first
881 my $queue = delete $ns->{query_queue}; 2072 my $queue = delete $ns->{query_queue}
2073 or return; # be conservative, not sure how that can happen, but we saw a crash here
882 2074
883 (shift @$queue)->[1]->($msg); 2075 (shift @$queue)->[1]->($msg);
2076 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
884 2077
885 push @{ $ns->{query_queue} }, @$queue; 2078 push @{ $ns->{query_queue} }, @$queue;
886 2079
887 if (@{ $ns->{query_queue} } == @$queue) { 2080 if (@{ $ns->{query_queue} } == @$queue) {
888 if (@$queue) { 2081 if (@$queue) {
892 } 2085 }
893 } 2086 }
894 }, 2087 },
895); 2088);
896 2089
897=item $client->coro (\&cb) 2090=item $client->async (\&cb)
898 2091
899Create a new coroutine, running the specified callback. The coroutine will 2092Create a new coroutine, running the specified callback. The coroutine will
900be automatically cancelled when the client gets destroyed (e.g. on logout, 2093be automatically cancelled when the client gets destroyed (e.g. on logout,
901or loss of connection). 2094or loss of connection).
902 2095
903=cut 2096=cut
904 2097
905sub cf::client::coro { 2098sub cf::client::async {
906 my ($self, $cb) = @_; 2099 my ($self, $cb) = @_;
907 2100
908 my $coro; $coro = async { 2101 my $coro = &Coro::async ($cb);
909 eval { 2102
910 $cb->(); 2103 $coro->on_destroy (sub {
911 };
912 warn $@ if $@;
913 delete $self->{_coro}{$coro+0}; 2104 delete $self->{_coro}{$coro+0};
914 }; 2105 });
915 2106
916 $self->{_coro}{$coro+0} = $coro; 2107 $self->{_coro}{$coro+0} = $coro;
2108
2109 $coro
917} 2110}
918 2111
919cf::client->attach ( 2112cf::client->attach (
920 on_destroy => sub { 2113 on_destroy => sub {
921 my ($ns) = @_; 2114 my ($ns) = @_;
946 2139
947# here we export the classes and methods available to script code 2140# here we export the classes and methods available to script code
948 2141
949=pod 2142=pod
950 2143
951The following fucntions and emthods are available within a safe environment: 2144The following functions and methods are available within a safe environment:
952 2145
953 cf::object contr pay_amount pay_player map 2146 cf::object contr pay_amount pay_player map
954 cf::object::player player 2147 cf::object::player player
955 cf::player peaceful 2148 cf::player peaceful
956 cf::map trigger 2149 cf::map trigger
1049The parameter C<$family> should best start with the name of the extension 2242The parameter C<$family> should best start with the name of the extension
1050using it, it should be unique. 2243using it, it should be unique.
1051 2244
1052=over 4 2245=over 4
1053 2246
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 2247=item $value = cf::db_get $family => $key
1061 2248
1062Returns a single value from the database 2249Returns 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 2250
1069=item cf::db_put $family => $key => $value 2251=item cf::db_put $family => $key => $value
1070 2252
1071Stores the given C<$value> in the family hash. Updates are delayed, if you 2253Stores 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 2254
1082=cut 2255=cut
1083 2256
1084our $DB; 2257our $DB;
1085 2258
1086{ 2259sub db_init {
2260 unless ($DB) {
2261 $DB = BDB::db_create $DB_ENV;
2262
2263 cf::sync_job {
2264 eval {
2265 $DB->set_flags (BDB::CHKSUM);
2266
2267 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2268 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2269 cf::cleanup "db_open(db): $!" if $!;
2270 };
2271 cf::cleanup "db_open(db): $@" if $@;
2272 };
2273
1087 my $path = cf::localdir . "/database.pst"; 2274 my $path = cf::localdir . "/database.pst";
2275 if (stat $path) {
2276 cf::sync_job {
2277 my $pst = Storable::retrieve $path;
1088 2278
1089 sub db_load() { 2279 cf::db_put (board => data => $pst->{board});
1090 warn "loading database $path\n";#d# remove later 2280 cf::db_put (guildrules => data => $pst->{guildrules});
1091 $DB = stat $path ? Storable::retrieve $path : { }; 2281 cf::db_put (rent => balance => $pst->{rent}{balance});
1092 } 2282 BDB::db_env_txn_checkpoint $DB_ENV;
1093 2283
1094 my $pid; 2284 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 } 2285 };
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 }, 2286 }
1143 ); 2287 }
2288}
2289
2290sub db_get($$) {
2291 my $key = "$_[0]/$_[1]";
2292
2293 cf::sync_job {
2294 BDB::db_get $DB, undef, $key, my $data;
2295
2296 $! ? ()
2297 : Compress::LZF::sthaw $data
2298 }
2299}
2300
2301sub db_put($$$) {
2302 BDB::dbreq_pri 4;
2303 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
1144} 2304}
1145 2305
1146############################################################################# 2306#############################################################################
1147# the server's main() 2307# the server's init and main functions
2308
2309sub load_facedata {
2310 my $path = sprintf "%s/facedata", cf::datadir;
2311
2312 warn "loading facedata from $path\n";
2313
2314 my $facedata;
2315 0 < aio_load $path, $facedata
2316 or die "$path: $!";
2317
2318 $facedata = Coro::Storable::thaw $facedata;
2319
2320 $facedata->{version} == 2
2321 or cf::cleanup "$path: version mismatch, cannot proceed.";
2322
2323 {
2324 my $faces = $facedata->{faceinfo};
2325
2326 while (my ($face, $info) = each %$faces) {
2327 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2328 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2329 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2330 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2331 Coro::cede;
2332 }
2333
2334 while (my ($face, $info) = each %$faces) {
2335 next unless $info->{smooth};
2336 my $idx = cf::face::find $face
2337 or next;
2338 if (my $smooth = cf::face::find $info->{smooth}) {
2339 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2340 } else {
2341 warn "smooth face '$info->{smooth}' not found for face '$face'";
2342 }
2343 Coro::cede;
2344 }
2345 }
2346
2347 {
2348 my $anims = $facedata->{animinfo};
2349
2350 while (my ($anim, $info) = each %$anims) {
2351 cf::anim::set $anim, $info->{frames}, $info->{facings};
2352 Coro::cede;
2353 }
2354
2355 cf::anim::invalidate_all; # d'oh
2356 }
2357
2358 1
2359}
2360
2361sub reload_resources {
2362 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2363 or die "unable to load regions file\n";#d#
2364 load_facedata
2365 or die "unable to load facedata\n";#d#
2366}
2367
2368sub init {
2369 reload_resources;
2370}
1148 2371
1149sub cfg_load { 2372sub cfg_load {
1150 open my $fh, "<:utf8", cf::confdir . "/config" 2373 open my $fh, "<:utf8", cf::confdir . "/config"
1151 or return; 2374 or return;
1152 2375
1153 local $/; 2376 local $/;
1154 *CFG = YAML::Syck::Load <$fh>; 2377 *CFG = YAML::Syck::Load <$fh>;
2378
2379 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2380
2381 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2382 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2383
2384 if (exists $CFG{mlockall}) {
2385 eval {
2386 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2387 and die "WARNING: m(un)lockall failed: $!\n";
2388 };
2389 warn $@ if $@;
2390 }
1155} 2391}
1156 2392
1157sub main { 2393sub main {
2394 # we must not ever block the main coroutine
2395 local $Coro::idle = sub {
2396 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2397 (async {
2398 Event::one_event;
2399 })->prio (Coro::PRIO_MAX);
2400 };
2401
1158 cfg_load; 2402 cfg_load;
1159 db_load; 2403 db_init;
1160 load_extensions; 2404 load_extensions;
2405
2406 $TICK_WATCHER->start;
1161 Event::loop; 2407 Event::loop;
1162} 2408}
1163 2409
1164############################################################################# 2410#############################################################################
1165# initialisation 2411# initialisation and cleanup
1166 2412
2413# install some emergency cleanup handlers
2414BEGIN {
2415 for my $signal (qw(INT HUP TERM)) {
2416 Event->signal (
2417 reentrant => 0,
2418 data => WF_AUTOCANCEL,
2419 signal => $signal,
2420 prio => 0,
2421 cb => sub {
2422 cf::cleanup "SIG$signal";
2423 },
2424 );
2425 }
2426}
2427
2428sub emergency_save() {
2429 my $freeze_guard = cf::freeze_mainloop;
2430
2431 warn "enter emergency perl save\n";
2432
2433 cf::sync_job {
2434 # use a peculiar iteration method to avoid tripping on perl
2435 # refcount bugs in for. also avoids problems with players
2436 # and maps saved/destroyed asynchronously.
2437 warn "begin emergency player save\n";
2438 for my $login (keys %cf::PLAYER) {
2439 my $pl = $cf::PLAYER{$login} or next;
2440 $pl->valid or next;
2441 $pl->save;
2442 }
2443 warn "end emergency player save\n";
2444
2445 warn "begin emergency map save\n";
2446 for my $path (keys %cf::MAP) {
2447 my $map = $cf::MAP{$path} or next;
2448 $map->valid or next;
2449 $map->save;
2450 }
2451 warn "end emergency map save\n";
2452
2453 warn "begin emergency database checkpoint\n";
2454 BDB::db_env_txn_checkpoint $DB_ENV;
2455 warn "end emergency database checkpoint\n";
2456 };
2457
2458 warn "leave emergency perl save\n";
2459}
2460
2461sub post_cleanup {
2462 my ($make_core) = @_;
2463
2464 warn Carp::longmess "post_cleanup backtrace"
2465 if $make_core;
2466}
2467
1167sub _perl_reload(&) { 2468sub reload() {
1168 my ($msg) = @_; 2469 # can/must only be called in main
2470 if ($Coro::current != $Coro::main) {
2471 warn "can only reload from main coroutine";
2472 return;
2473 }
1169 2474
1170 $msg->("reloading..."); 2475 warn "reloading...";
1171 2476
1172 eval { 2477 warn "entering sync_job";
1173 # cancel all watchers 2478
2479 cf::sync_job {
2480 cf::write_runtime; # external watchdog should not bark
2481 cf::emergency_save;
2482 cf::write_runtime; # external watchdog should not bark
2483
2484 warn "syncing database to disk";
2485 BDB::db_env_txn_checkpoint $DB_ENV;
2486
2487 # if anything goes wrong in here, we should simply crash as we already saved
2488
2489 warn "cancelling all WF_AUTOCANCEL watchers";
1174 for (Event::all_watchers) { 2490 for (Event::all_watchers) {
1175 $_->cancel if $_->data & WF_AUTOCANCEL; 2491 $_->cancel if $_->data & WF_AUTOCANCEL;
1176 } 2492 }
1177 2493
1178 # unload all extensions 2494 warn "flushing outstanding aio requests";
1179 for (@exts) { 2495 for (;;) {
1180 $msg->("unloading <$_>"); 2496 BDB::flush;
1181 unload_extension $_; 2497 IO::AIO::flush;
2498 Coro::cede;
2499 last unless IO::AIO::nreqs || BDB::nreqs;
2500 warn "iterate...";
2501 }
2502
2503 ++$RELOAD;
2504
2505 warn "cancelling all extension coros";
2506 $_->cancel for values %EXT_CORO;
2507 %EXT_CORO = ();
2508
2509 warn "removing commands";
2510 %COMMAND = ();
2511
2512 warn "removing ext commands";
2513 %EXTCMD = ();
2514
2515 warn "unloading/nuking all extensions";
2516 for my $pkg (@EXTS) {
2517 warn "... unloading $pkg";
2518
2519 if (my $cb = $pkg->can ("unload")) {
2520 eval {
2521 $cb->($pkg);
2522 1
2523 } or warn "$pkg unloaded, but with errors: $@";
1182 } 2524 }
1183 2525
2526 warn "... nuking $pkg";
2527 Symbol::delete_package $pkg;
2528 }
2529
1184 # unload all modules loaded from $LIBDIR 2530 warn "unloading all perl modules loaded from $LIBDIR";
1185 while (my ($k, $v) = each %INC) { 2531 while (my ($k, $v) = each %INC) {
1186 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2532 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1187 2533
1188 $msg->("removing <$k>"); 2534 warn "... unloading $k";
1189 delete $INC{$k}; 2535 delete $INC{$k};
1190 2536
1191 $k =~ s/\.pm$//; 2537 $k =~ s/\.pm$//;
1192 $k =~ s/\//::/g; 2538 $k =~ s/\//::/g;
1193 2539
1196 } 2542 }
1197 2543
1198 Symbol::delete_package $k; 2544 Symbol::delete_package $k;
1199 } 2545 }
1200 2546
1201 # sync database to disk
1202 cf::db_sync;
1203
1204 # get rid of safe::, as good as possible 2547 warn "getting rid of safe::, as good as possible";
1205 Symbol::delete_package "safe::$_" 2548 Symbol::delete_package "safe::$_"
1206 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2549 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1207 2550
1208 # remove register_script_function callbacks
1209 # TODO
1210
1211 # unload cf.pm "a bit" 2551 warn "unloading cf.pm \"a bit\"";
1212 delete $INC{"cf.pm"}; 2552 delete $INC{"cf.pm"};
1213 2553
1214 # don't, removes xs symbols, too, 2554 # don't, removes xs symbols, too,
1215 # and global variables created in xs 2555 # and global variables created in xs
1216 #Symbol::delete_package __PACKAGE__; 2556 #Symbol::delete_package __PACKAGE__;
1217 2557
1218 # reload cf.pm 2558 warn "unload completed, starting to reload now";
2559
1219 $msg->("reloading cf.pm"); 2560 warn "reloading cf.pm";
1220 require cf; 2561 require cf;
2562 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1221 2563
1222 # load config and database again 2564 warn "loading config and database again";
1223 cf::cfg_load; 2565 cf::cfg_load;
1224 cf::db_load;
1225 2566
1226 # load extensions 2567 warn "loading extensions";
1227 $msg->("load extensions");
1228 cf::load_extensions; 2568 cf::load_extensions;
1229 2569
1230 # reattach attachments to objects 2570 warn "reattaching attachments to objects/players";
1231 $msg->("reattach"); 2571 _global_reattach; # objects, sockets
1232 _global_reattach; 2572 warn "reattaching attachments to maps";
2573 reattach $_ for values %MAP;
2574 warn "reattaching attachments to players";
2575 reattach $_ for values %PLAYER;
2576
2577 warn "loading reloadable resources";
2578 reload_resources;
2579
2580 warn "leaving sync_job";
2581
2582 1
2583 } or do {
2584 warn $@;
2585 warn "error while reloading, exiting.";
2586 exit 1;
1233 }; 2587 };
1234 $msg->($@) if $@;
1235 2588
1236 $msg->("reloaded"); 2589 warn "reloaded";
1237}; 2590};
1238 2591
1239sub perl_reload() { 2592our $RELOAD_WATCHER; # used only during reload
1240 _perl_reload {
1241 warn $_[0];
1242 print "$_[0]\n";
1243 };
1244}
1245 2593
1246register "<global>", __PACKAGE__;
1247
1248register_command "perl-reload" => sub { 2594register_command "reload" => sub {
1249 my ($who, $arg) = @_; 2595 my ($who, $arg) = @_;
1250 2596
1251 if ($who->flag (FLAG_WIZ)) { 2597 if ($who->flag (FLAG_WIZ)) {
1252 _perl_reload { 2598 $who->message ("reloading server.");
1253 warn $_[0]; 2599
1254 $who->message ($_[0]); 2600 # doing reload synchronously and two reloads happen back-to-back,
2601 # coro crashes during coro_state_free->destroy here.
2602
2603 $RELOAD_WATCHER ||= Event->timer (
2604 reentrant => 0,
2605 after => 0,
2606 data => WF_AUTOCANCEL,
2607 cb => sub {
2608 reload;
2609 undef $RELOAD_WATCHER;
2610 },
1255 }; 2611 );
1256 } 2612 }
1257}; 2613};
1258 2614
1259unshift @INC, $LIBDIR; 2615unshift @INC, $LIBDIR;
1260 2616
2617my $bug_warning = 0;
2618
1261$TICK_WATCHER = Event->timer ( 2619$TICK_WATCHER = Event->timer (
2620 reentrant => 0,
2621 parked => 1,
1262 prio => 0, 2622 prio => 0,
1263 at => $NEXT_TICK || 1, 2623 at => $NEXT_TICK || $TICK,
1264 data => WF_AUTOCANCEL, 2624 data => WF_AUTOCANCEL,
1265 cb => sub { 2625 cb => sub {
2626 if ($Coro::current != $Coro::main) {
2627 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2628 unless ++$bug_warning > 10;
2629 return;
2630 }
2631
2632 $NOW = Event::time;
2633
1266 cf::server_tick; # one server iteration 2634 cf::server_tick; # one server iteration
1267 2635 $RUNTIME += $TICK;
1268 my $NOW = Event::time;
1269 $NEXT_TICK += $TICK; 2636 $NEXT_TICK += $TICK;
1270 2637
2638 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2639 $NEXT_RUNTIME_WRITE = $NOW + 10;
2640 Coro::async_pool {
2641 write_runtime
2642 or warn "ERROR: unable to write runtime file: $!";
2643 };
2644 }
2645
2646 $WAIT_FOR_TICK->broadcast;
2647 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2648
2649# my $AFTER = Event::time;
2650# warn $AFTER - $NOW;#d#
2651
1271 # if we are delayed by four ticks or more, skip them all 2652 # if we are delayed by four ticks or more, skip them all
1272 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2653 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1273 2654
1274 $TICK_WATCHER->at ($NEXT_TICK); 2655 $TICK_WATCHER->at ($NEXT_TICK);
1275 $TICK_WATCHER->start; 2656 $TICK_WATCHER->start;
1276 }, 2657 },
1277); 2658);
1278 2659
2660{
2661 BDB::max_poll_time $TICK * 0.1;
2662 $BDB_POLL_WATCHER = Event->io (
2663 reentrant => 0,
2664 fd => BDB::poll_fileno,
2665 poll => 'r',
2666 prio => 0,
2667 data => WF_AUTOCANCEL,
2668 cb => \&BDB::poll_cb,
2669 );
2670 BDB::min_parallel 8;
2671
2672 BDB::set_sync_prepare {
2673 my $status;
2674 my $current = $Coro::current;
2675 (
2676 sub {
2677 $status = $!;
2678 $current->ready; undef $current;
2679 },
2680 sub {
2681 Coro::schedule while defined $current;
2682 $! = $status;
2683 },
2684 )
2685 };
2686
2687 unless ($DB_ENV) {
2688 $DB_ENV = BDB::db_env_create;
2689
2690 cf::sync_job {
2691 eval {
2692 BDB::db_env_open
2693 $DB_ENV,
2694 $BDB_ENV_DIR,
2695 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2696 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2697 0666;
2698
2699 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
2700
2701 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2702 $DB_ENV->set_lk_detect;
2703 };
2704
2705 cf::cleanup "db_env_open(db): $@" if $@;
2706 };
2707 }
2708}
2709
2710{
2711 IO::AIO::min_parallel 8;
2712
2713 undef $Coro::AIO::WATCHER;
1279IO::AIO::max_poll_time $TICK * 0.2; 2714 IO::AIO::max_poll_time $TICK * 0.1;
1280 2715 $AIO_POLL_WATCHER = Event->io (
1281Event->io (fd => IO::AIO::poll_fileno, 2716 reentrant => 0,
1282 poll => 'r',
1283 prio => 5,
1284 data => WF_AUTOCANCEL, 2717 data => WF_AUTOCANCEL,
2718 fd => IO::AIO::poll_fileno,
2719 poll => 'r',
2720 prio => 6,
1285 cb => \&IO::AIO::poll_cb); 2721 cb => \&IO::AIO::poll_cb,
2722 );
2723}
2724
2725END { cf::emergency_save }
1286 2726
12871 27271
1288 2728

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines