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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines