ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.105 by root, Sun Dec 31 17:17:23 2006 UTC vs.
Revision 1.271 by root, Fri Jun 1 06:04:08 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines