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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines