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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines