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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines