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.257 by root, Sat Apr 21 17:34:24 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines