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.104 by root, Sat Dec 30 16:56:16 2006 UTC vs.
Revision 1.328 by root, Wed Aug 8 06:24:30 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;
22use Coro::AIO;
23use Coro::Storable;
18 24
19use IO::AIO 2.3; 25use JSON::XS 1.4 ();
26use BDB ();
27use Data::Dumper;
28use Digest::MD5;
29use Fcntl;
20use YAML::Syck (); 30use YAML::Syck ();
31use IO::AIO 2.32 ();
21use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
22 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
41
23use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
24 43
25# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
26$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
27 46
28$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29 48
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31 50
32our %COMMAND = (); 51our %COMMAND = ();
33our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
53
54our @EXTS = (); # list of extension package names
34our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
57our %EXT_CORO = (); # coroutines bound to extensions
58our %EXT_MAP = (); # pluggable maps
35 59
60our $RELOAD; # number of reloads so far
36our @EVENT; 61our @EVENT;
37our $LIBDIR = datadir . "/ext";
38 62
39our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
40our $TICK_WATCHER; 76our $TICK_WATCHER;
77our $AIO_POLL_WATCHER;
78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
41our $NEXT_TICK; 79our $NEXT_TICK;
42our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
43 85
44our %CFG; 86our %CFG;
45 87
46our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
47our $RUNTIME; 89our $RUNTIME;
48 90
91our %PLAYER; # all users
49our %MAP; # all maps 92our %MAP; # all maps
50our $LINK_MAP; # the special {link} map 93our $LINK_MAP; # the special {link} map, which is always available
51our $FREEZE; 94
95# used to convert map paths into valid unix filenames by replacing / by ∕
96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
52 101
53binmode STDOUT; 102binmode STDOUT;
54binmode STDERR; 103binmode STDERR;
55 104
56# read virtual server time, if available 105# read virtual server time, if available
57unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
58 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
59 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
60 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
61} 110}
62 111
63mkdir cf::localdir; 112mkdir $_
64mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
65mkdir cf::localdir . "/" . cf::tmpdir;
66mkdir cf::localdir . "/" . cf::uniquedir;
67 114
68our %EXT_CORO; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
69 118
70############################################################################# 119#############################################################################
71 120
72=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
73 122
80=item $cf::RUNTIME 129=item $cf::RUNTIME
81 130
82The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
83every server tick. 132every server tick.
84 133
85=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
86 137
87The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
88be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
89 142
90=item $cf::NOW 143=item $cf::NOW
91 144
92The time of the last (current) server tick. 145The time of the last (current) server tick.
93 146
94=item $cf::TICK 147=item $cf::TICK
95 148
96The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
97 160
98=item %cf::CFG 161=item %cf::CFG
99 162
100Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
101from wherever your confdir points to. 164from wherever your confdir points to.
165
166=item cf::wait_for_tick, cf::wait_for_tick_begin
167
168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
169returns directly I<after> the tick processing (and consequently, can only wake one process
170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
102 177
103=back 178=back
104 179
105=cut 180=cut
106 181
107BEGIN { 182BEGIN {
108 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
109 my $msg = join "", @_; 184 my $msg = join "", @_;
110 utf8::encode $msg;
111 185
112 $msg .= "\n" 186 $msg .= "\n"
113 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
114 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
115 LOG llevError, "cfperl: $msg"; 192 LOG llevError, $msg;
116 }; 193 };
117} 194}
118 195
119@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
120@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
121@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
122@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
123@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
124@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
125 203
126# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
127# within the Safe compartment. 205# within the Safe compartment.
128for my $pkg (qw( 206for my $pkg (qw(
129 cf::global cf::attachable 207 cf::global cf::attachable
138 216
139$Event::DIED = sub { 217$Event::DIED = sub {
140 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
141}; 219};
142 220
143my %ext_pkg; 221#############################################################################
144my @exts;
145my @hook;
146 222
147=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
148 224
149=over 4 225=over 4
150 226
151=cut 227=item dumpval $ref
152 228
153use JSON::Syck (); # TODO# replace by JSON::PC once working 229=cut
230
231sub dumpval {
232 eval {
233 local $SIG{__DIE__};
234 my $d;
235 if (1) {
236 $d = new Data::Dumper([$_[0]], ["*var"]);
237 $d->Terse(1);
238 $d->Indent(2);
239 $d->Quotekeys(0);
240 $d->Useqq(1);
241 #$d->Bless(...);
242 $d->Seen($_[1]) if @_ > 1;
243 $d = $d->Dump();
244 }
245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
246 $d
247 } || "[unable to dump $_[0]: '$@']";
248}
154 249
155=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
156 251
157Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
158 253
159=cut
160
161sub from_json($) {
162 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
163 JSON::Syck::Load $_[0]
164}
165
166=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
167 255
168Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
169 257
170=cut 258=cut
171 259
172sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
173 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
174 JSON::Syck::Dump $_[0]
175}
176 261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
264
265=item cf::lock_wait $string
266
267Wait until the given lock is available. See cf::lock_acquire.
268
269=item my $lock = cf::lock_acquire $string
270
271Wait until the given lock is available and then acquires it and returns
272a Coro::guard object. If the guard object gets destroyed (goes out of scope,
273for example when the coroutine gets canceled), the lock is automatically
274returned.
275
276Lock names should begin with a unique identifier (for example, cf::map::find
277uses map_find and cf::map::load uses map_load).
278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
283=cut
284
285our %LOCK;
286
287sub lock_wait($) {
288 my ($key) = @_;
289
290 # wait for lock, if any
291 while ($LOCK{$key}) {
292 push @{ $LOCK{$key} }, $Coro::current;
293 Coro::schedule;
294 }
295}
296
297sub lock_acquire($) {
298 my ($key) = @_;
299
300 # wait, to be sure we are not locked
301 lock_wait $key;
302
303 $LOCK{$key} = [];
304
305 Coro::guard {
306 # wake up all waiters, to be on the safe side
307 $_->ready for @{ delete $LOCK{$key} };
308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
317sub freeze_mainloop {
318 return unless $TICK_WATCHER->is_active;
319
320 my $guard = Coro::guard {
321 $TICK_WATCHER->start;
322 };
323 $TICK_WATCHER->stop;
324 $guard
325}
326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
383=item cf::async { BLOCK }
384
385Currently the same as Coro::async_pool, meaning you cannot use
386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
387thing you are allowed to do is call C<prio> on it.
388
389=cut
390
391BEGIN { *async = \&Coro::async_pool }
392
393=item cf::sync_job { BLOCK }
394
395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
396is always able to handle events or runnable, as Crossfire TRT is only
397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
399
400If it must be done, put the blocking parts into C<sync_job>. This will run
401the given BLOCK in another coroutine while waiting for the result. The
402server will be frozen during this time, so the block should either finish
403fast or be very important.
404
405=cut
406
407sub sync_job(&) {
408 my ($job) = @_;
409
410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
413 # this is the main coro, too bad, we have to block
414 # till the operation succeeds, freezing the server :/
415
416 # TODO: use suspend/resume instead
417 # (but this is cancel-safe)
418 my $freeze_guard = freeze_mainloop;
419
420 my $busy = 1;
421 my @res;
422
423 (async {
424 @res = eval { $job->() };
425 warn $@ if $@;
426 undef $busy;
427 })->prio (Coro::PRIO_MAX);
428
429 while ($busy) {
430 Coro::cede or Event::one_event;
431 }
432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
440 wantarray ? @res : $res[0]
441 } else {
442 # we are in another coroutine, how wonderful, everything just works
443
444 $job->()
445 }
446}
447
177=item $coro = cf::coro { BLOCK } 448=item $coro = cf::async_ext { BLOCK }
178 449
179Creates and returns a new coro. This coro is automcatially being canceled 450Like async, but this coro is automatically being canceled when the
180when the extension calling this is being unloaded. 451extension calling this is being unloaded.
181 452
182=cut 453=cut
183 454
184sub coro(&) { 455sub async_ext(&) {
185 my $cb = shift; 456 my $cb = shift;
186 457
187 my $coro; $coro = async { 458 my $coro = &Coro::async ($cb);
188 eval {
189 $cb->();
190 };
191 warn $@ if $@;
192 };
193 459
194 $coro->on_destroy (sub { 460 $coro->on_destroy (sub {
195 delete $EXT_CORO{$coro+0}; 461 delete $EXT_CORO{$coro+0};
196 }); 462 });
197 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
198 464
199 $coro 465 $coro
200} 466}
201 467
468=item fork_call { }, $args
469
470Executes the given code block with the given arguments in a seperate
471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
474
475=cut
476
477sub _store_scalar {
478 open my $fh, ">", \my $buf
479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
481 close $fh;
482
483 $buf
484}
485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
655}
656
202=back 657=back
203 658
204=cut 659=cut
205 660
206############################################################################# 661#############################################################################
211attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
212to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
213 668
214In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
215C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
216crossfire+). 671Crossfire TRT).
217 672
218=over 4 673=over 4
219 674
220=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
221 676
335our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
336our @CB_MAP = (); 791our @CB_MAP = ();
337 792
338my %attachment; 793my %attachment;
339 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
340sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
341 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
342 803
343 use sort 'stable'; 804 use sort 'stable';
344 805
378 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
379 840
380 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
381 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
382 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
383 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
384 845
385 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
386 my $pkg = shift @arg; 847 my $pkg = shift @arg;
387 848
388 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
417 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
418 } 879 }
419 880
420 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
421 } else { 882 } else {
422 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
423 } 884 }
424 885
425 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
426} 887}
427 888
429 if (ref $_[0]) { 890 if (ref $_[0]) {
430 _object_attach @_; 891 _object_attach @_;
431 } else { 892 } else {
432 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
433 } 894 }
895 _recalc_want;
434}; 896};
435 897
436# all those should be optimised 898# all those should be optimised
437sub cf::attachable::detach { 899sub cf::attachable::detach {
438 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
441 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
442 reattach ($obj); 904 reattach ($obj);
443 } else { 905 } else {
444 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
445 } 907 }
908 _recalc_want;
446}; 909};
447 910
448sub cf::attachable::attached { 911sub cf::attachable::attached {
449 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
450 913
465 "; 928 ";
466 die if $@; 929 die if $@;
467} 930}
468 931
469our $override; 932our $override;
470our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
471 934
472sub override { 935sub override {
473 $override = 1; 936 $override = 1;
474 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
475} 938}
476 939
477sub do_invoke { 940sub do_invoke {
478 my $event = shift; 941 my $event = shift;
479 my $callbacks = shift; 942 my $callbacks = shift;
480 943
481 @invoke_results = (); 944 @INVOKE_RESULTS = ();
482 945
483 local $override; 946 local $override;
484 947
485 for (@$callbacks) { 948 for (@$callbacks) {
486 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
503 966
504Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
505 968
506This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
507removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
508results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
509 972
510=back 973=back
511 974
512=cut 975=cut
513 976
514############################################################################# 977#############################################################################
515# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
516 990
517sub reattach { 991sub reattach {
518 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
519 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
520 996
521 my $registry = $obj->registry; 997 my $registry = $obj->registry;
522 998
523 @$registry = (); 999 @$registry = ();
524 1000
563); 1039);
564 1040
565sub object_freezer_save { 1041sub object_freezer_save {
566 my ($filename, $rdata, $objs) = @_; 1042 my ($filename, $rdata, $objs) = @_;
567 1043
1044 sync_job {
568 if (length $$rdata) { 1045 if (length $$rdata) {
569 warn sprintf "saving %s (%d,%d)\n", 1046 warn sprintf "saving %s (%d,%d)\n",
570 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
571 1048
572 if (open my $fh, ">:raw", "$filename~") { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
573 chmod SAVE_MODE, $fh;
574 syswrite $fh, $$rdata;
575 close $fh;
576
577 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
578 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
579 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1052 aio_fsync $fh if $cf::USE_FSYNC;
580 close $fh; 1053 close $fh;
1054
1055 if (@$objs) {
1056 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
1057 chmod SAVE_MODE, $fh;
1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
1059 aio_write $fh, 0, (length $data), $data, 0;
1060 aio_fsync $fh if $cf::USE_FSYNC;
1061 close $fh;
581 rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
1063 }
1064 } else {
1065 aio_unlink "$filename.pst";
1066 }
1067
1068 aio_rename "$filename~", $filename;
582 } else { 1069 } else {
583 unlink "$filename.pst"; 1070 warn "FATAL: $filename~: $!\n";
584 } 1071 }
585
586 rename "$filename~", $filename;
587 } else { 1072 } else {
588 warn "FATAL: $filename~: $!\n";
589 }
590 } else {
591 unlink $filename; 1073 aio_unlink $filename;
592 unlink "$filename.pst"; 1074 aio_unlink "$filename.pst";
1075 }
593 } 1076 }
594} 1077}
595 1078
596sub object_freezer_as_string { 1079sub object_freezer_as_string {
597 my ($rdata, $objs) = @_; 1080 my ($rdata, $objs) = @_;
602} 1085}
603 1086
604sub object_thawer_load { 1087sub object_thawer_load {
605 my ($filename) = @_; 1088 my ($filename) = @_;
606 1089
607 local $/; 1090 my ($data, $av);
608 1091
609 my $av; 1092 (aio_load $filename, $data) >= 0
1093 or return;
610 1094
611 #TODO: use sysread etc. 1095 unless (aio_stat "$filename.pst") {
612 if (open my $data, "<:raw:perlio", $filename) { 1096 (aio_load "$filename.pst", $av) >= 0
613 $data = <$data>; 1097 or return;
614 if (open my $pst, "<:raw:perlio", "$filename.pst") {
615 $av = eval { (Storable::thaw <$pst>)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
616 } 1099 }
1100
1101 warn sprintf "loading %s (%d)\n",
1102 $filename, length $data, scalar @{$av || []};
617 return ($data, $av); 1103 return ($data, $av);
618 }
619
620 ()
621} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
622 1111
623############################################################################# 1112#############################################################################
624# command handling &c 1113# command handling &c
625 1114
626=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
639 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
640} 1129}
641 1130
642=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
643 1132
644Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
645 1138
646If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
647called. 1140called.
648 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
649=cut 1153=cut
650 1154
651sub register_extcmd { 1155sub register_extcmd {
652 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
653 1157
654 my $caller = caller;
655 #warn "registering extcmd '$name' to '$caller'";
656
657 $EXTCMD{$name} = [$cb, $caller]; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
658} 1165}
659 1166
660cf::player->attach ( 1167cf::player->attach (
661 on_command => sub { 1168 on_command => sub {
662 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
671 cf::override; 1178 cf::override;
672 }, 1179 },
673 on_extcmd => sub { 1180 on_extcmd => sub {
674 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
675 1182
676 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
677 1184
678 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
679 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
680 if (my %reply = $cb->[0]->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
681 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
682 } 1195 if $reply;
683 } 1196 }
684 } else { 1197 } else {
685 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
686 } 1199 }
687 1200
688 cf::override; 1201 cf::override;
689 }, 1202 },
690); 1203);
691 1204
1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
1209 for my $path (<$LIBDIR/*.ext>) {
1210 next unless -r $path;
1211
1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
1269 }
1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
1275 };
1276}
1277
1278#############################################################################
1279
1280=back
1281
1282=head2 CORE EXTENSIONS
1283
1284Functions and methods that extend core crossfire objects.
1285
1286=cut
1287
1288package cf::player;
1289
1290use Coro::AIO;
1291
1292=head3 cf::player
1293
1294=over 4
1295
1296=item cf::player::find $login
1297
1298Returns the given player object, loading it if necessary (might block).
1299
1300=cut
1301
1302sub playerdir($) {
1303 "$PLAYERDIR/"
1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1305}
1306
1307sub path($) {
1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1309
1310 (playerdir $login) . "/playerdata"
1311}
1312
1313sub find_active($) {
1314 $cf::PLAYER{$_[0]}
1315 and $cf::PLAYER{$_[0]}->active
1316 and $cf::PLAYER{$_[0]}
1317}
1318
1319sub exists($) {
1320 my ($login) = @_;
1321
1322 $cf::PLAYER{$login}
1323 or cf::sync_job { !aio_stat path $login }
1324}
1325
1326sub find($) {
1327 return $cf::PLAYER{$_[0]} || do {
1328 my $login = $_[0];
1329
1330 my $guard = cf::lock_acquire "user_find:$login";
1331
1332 $cf::PLAYER{$_[0]} || do {
1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
1340 my $pl = load_pl path $login
1341 or return;
1342 $cf::PLAYER{$login} = $pl
1343 }
1344 }
1345}
1346
1347sub save($) {
1348 my ($pl) = @_;
1349
1350 return if $pl->{deny_save};
1351
1352 my $path = path $pl;
1353 my $guard = cf::lock_acquire "user_save:$path";
1354
1355 return if $pl->{deny_save};
1356
1357 aio_mkdir playerdir $pl, 0770;
1358 $pl->{last_save} = $cf::RUNTIME;
1359
1360 $pl->save_pl ($path);
1361 Coro::cede;
1362}
1363
1364sub new($) {
1365 my ($login) = @_;
1366
1367 my $self = create;
1368
1369 $self->ob->name ($login);
1370 $self->{deny_save} = 1;
1371
1372 $cf::PLAYER{$login} = $self;
1373
1374 $self
1375}
1376
1377=item $pl->quit_character
1378
1379Nukes the player without looking back. If logged in, the connection will
1380be destroyed. May block for a long time.
1381
1382=cut
1383
1384sub quit_character {
1385 my ($pl) = @_;
1386
1387 my $name = $pl->ob->name;
1388
1389 $pl->{deny_save} = 1;
1390 $pl->password ("*"); # this should lock out the player until we nuked the dir
1391
1392 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1393 $pl->deactivate;
1394 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1395 $pl->ns->destroy if $pl->ns;
1396
1397 my $path = playerdir $pl;
1398 my $temp = "$path~$cf::RUNTIME~deleting~";
1399 aio_rename $path, $temp;
1400 delete $cf::PLAYER{$pl->ob->name};
1401 $pl->destroy;
1402
1403 my $prefix = qr<^~\Q$name\E/>;
1404
1405 # nuke player maps
1406 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1407
1408 IO::AIO::aio_rmtree $temp;
1409}
1410
1411=item $pl->kick
1412
1413Kicks a player out of the game. This destroys the connection.
1414
1415=cut
1416
1417sub kick {
1418 my ($pl, $kicker) = @_;
1419
1420 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1421 $pl->killer ("kicked");
1422 $pl->ns->destroy;
1423}
1424
1425=item cf::player::list_logins
1426
1427Returns am arrayref of all valid playernames in the system, can take a
1428while and may block, so not sync_job-capable, ever.
1429
1430=cut
1431
1432sub list_logins {
1433 my $dirs = aio_readdir $PLAYERDIR
1434 or return [];
1435
1436 my @logins;
1437
1438 for my $login (@$dirs) {
1439 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1440 aio_read $fh, 0, 512, my $buf, 0 or next;
1441 $buf !~ /^password -------------$/m or next; # official not-valid tag
1442
1443 utf8::decode $login;
1444 push @logins, $login;
1445 }
1446
1447 \@logins
1448}
1449
1450=item $player->maps
1451
1452Returns an arrayref of map paths that are private for this
1453player. May block.
1454
1455=cut
1456
1457sub maps($) {
1458 my ($pl) = @_;
1459
1460 $pl = ref $pl ? $pl->ob->name : $pl;
1461
1462 my $files = aio_readdir playerdir $pl
1463 or return;
1464
1465 my @paths;
1466
1467 for (@$files) {
1468 utf8::decode $_;
1469 next if /\.(?:pl|pst)$/;
1470 next unless /^$PATH_SEP/o;
1471
1472 push @paths, cf::map::normalise "~$pl/$_";
1473 }
1474
1475 \@paths
1476}
1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1528=item $player->ext_reply ($msgid, @msg)
1529
1530Sends an ext reply to the player.
1531
1532=cut
1533
1534sub ext_reply($$@) {
1535 my ($self, $id, @msg) = @_;
1536
1537 if ($self->ns->extcmd == 2) {
1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1544}
1545
1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1586
1587=back
1588
1589=head3 cf::map
1590
1591=over 4
1592
1593=cut
1594
1595package cf::map;
1596
1597use Fcntl;
1598use Coro::AIO;
1599
1600use overload
1601 '""' => \&as_string,
1602 fallback => 1;
1603
1604our $MAX_RESET = 3600;
1605our $DEFAULT_RESET = 3000;
1606
1607sub generate_random_map {
1608 my ($self, $rmp) = @_;
1609 # mit "rum" bekleckern, nicht
1610 $self->_create_random_map (
1611 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1612 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1613 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1614 $rmp->{exit_on_final_map},
1615 $rmp->{xsize}, $rmp->{ysize},
1616 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1617 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1618 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1619 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1620 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1621 (cf::region::find $rmp->{region}), $rmp->{custom}
1622 )
1623}
1624
1625=item cf::map->register ($regex, $prio)
1626
1627Register a handler for the map path matching the given regex at the
1628givne priority (higher is better, built-in handlers have priority 0, the
1629default).
1630
1631=cut
1632
692sub register { 1633sub register {
1634 my (undef, $regex, $prio) = @_;
1635 my $pkg = caller;
1636
1637 no strict;
1638 push @{"$pkg\::ISA"}, __PACKAGE__;
1639
1640 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1641}
1642
1643# also paths starting with '/'
1644$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1645
1646sub thawer_merge {
693 my ($base, $pkg) = @_; 1647 my ($self, $merge) = @_;
694 1648
695 #TODO 1649 # we have to keep some variables in memory intact
696} 1650 local $self->{path};
1651 local $self->{load_path};
697 1652
698sub load_extension { 1653 $self->SUPER::thawer_merge ($merge);
1654}
1655
1656sub normalise {
699 my ($path) = @_; 1657 my ($path, $base) = @_;
700 1658
701 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1659 $path = "$path"; # make sure its a string
702 my $base = $1;
703 my $pkg = $1;
704 $pkg =~ s/[^[:word:]]/_/g;
705 $pkg = "ext::$pkg";
706 1660
707 warn "loading '$path' into '$pkg'\n"; 1661 $path =~ s/\.map$//;
708 1662
709 open my $fh, "<:utf8", $path 1663 # map plan:
710 or die "$path: $!"; 1664 #
1665 # /! non-realised random map exit (special hack!)
1666 # {... are special paths that are not being touched
1667 # ?xxx/... are special absolute paths
1668 # ?random/... random maps
1669 # /... normal maps
1670 # ~user/... per-player map of a specific user
711 1671
712 my $source = 1672 $path =~ s/$PATH_SEP/\//go;
713 "package $pkg; use strict; use utf8;\n"
714 . "#line 1 \"$path\"\n{\n"
715 . (do { local $/; <$fh> })
716 . "\n};\n1";
717 1673
718 eval $source 1674 # treat it as relative path if it starts with
719 or die $@ ? "$path: $@\n" 1675 # something that looks reasonable
720 : "extension disabled.\n"; 1676 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1677 $base or Carp::carp "normalise called with relative path and no base: '$path'";
721 1678
722 push @exts, $pkg; 1679 $base =~ s{[^/]+/?$}{};
723 $ext_pkg{$base} = $pkg; 1680 $path = "$base/$path";
724
725# no strict 'refs';
726# @{"$pkg\::ISA"} = ext::;
727
728 register $base, $pkg;
729}
730
731sub unload_extension {
732 my ($pkg) = @_;
733
734 warn "removing extension $pkg\n";
735
736 # remove hooks
737 #TODO
738# for my $idx (0 .. $#PLUGIN_EVENT) {
739# delete $hook[$idx]{$pkg};
740# } 1681 }
741 1682
742 # remove commands 1683 for ($path) {
743 for my $name (keys %COMMAND) { 1684 redo if s{//}{/};
744 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1685 redo if s{/\.?/}{/};
1686 redo if s{/[^/]+/\.\./}{/};
1687 }
745 1688
746 if (@cb) { 1689 $path
747 $COMMAND{$name} = \@cb; 1690}
1691
1692sub new_from_path {
1693 my (undef, $path, $base) = @_;
1694
1695 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1696
1697 $path = normalise $path, $base;
1698
1699 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1700 if ($path =~ $EXT_MAP{$pkg}[1]) {
1701 my $self = bless cf::map::new, $pkg;
1702 $self->{path} = $path; $self->path ($path);
1703 $self->init; # pass $1 etc.
1704 return $self;
1705 }
1706 }
1707
1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1709 ()
1710}
1711
1712sub init {
1713 my ($self) = @_;
1714
1715 $self
1716}
1717
1718sub as_string {
1719 my ($self) = @_;
1720
1721 "$self->{path}"
1722}
1723
1724# the displayed name, this is a one way mapping
1725sub visible_name {
1726 &as_string
1727}
1728
1729# the original (read-only) location
1730sub load_path {
1731 my ($self) = @_;
1732
1733 "$MAPDIR/$self->{path}.map"
1734}
1735
1736# the temporary/swap location
1737sub save_path {
1738 my ($self) = @_;
1739
1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1741 "$TMPDIR/$path.map"
1742}
1743
1744# the unique path, undef == no special unique path
1745sub uniq_path {
1746 my ($self) = @_;
1747
1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1749 "$UNIQUEDIR/$path"
1750}
1751
1752# and all this just because we cannot iterate over
1753# all maps in C++...
1754sub change_all_map_light {
1755 my ($change) = @_;
1756
1757 $_->change_map_light ($change)
1758 for grep $_->outdoor, values %cf::MAP;
1759}
1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1767}
1768
1769sub unlink_save {
1770 my ($self) = @_;
1771
1772 utf8::encode (my $save = $self->save_path);
1773 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1774 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1775}
1776
1777sub load_header_from($) {
1778 my ($self, $path) = @_;
1779
1780 utf8::encode $path;
1781 #aio_open $path, O_RDONLY, 0
1782 # or return;
1783
1784 $self->_load_header ($path)
1785 or return;
1786
1787 $self->{load_path} = $path;
1788
1789 1
1790}
1791
1792sub load_header_orig {
1793 my ($self) = @_;
1794
1795 $self->load_header_from ($self->load_path)
1796}
1797
1798sub load_header_temp {
1799 my ($self) = @_;
1800
1801 $self->load_header_from ($self->save_path)
1802}
1803
1804sub prepare_temp {
1805 my ($self) = @_;
1806
1807 $self->last_access ((delete $self->{last_access})
1808 || $cf::RUNTIME); #d#
1809 # safety
1810 $self->{instantiate_time} = $cf::RUNTIME
1811 if $self->{instantiate_time} > $cf::RUNTIME;
1812}
1813
1814sub prepare_orig {
1815 my ($self) = @_;
1816
1817 $self->{load_original} = 1;
1818 $self->{instantiate_time} = $cf::RUNTIME;
1819 $self->last_access ($cf::RUNTIME);
1820 $self->instantiate;
1821}
1822
1823sub load_header {
1824 my ($self) = @_;
1825
1826 if ($self->load_header_temp) {
1827 $self->prepare_temp;
748 } else { 1828 } else {
749 delete $COMMAND{$name}; 1829 $self->load_header_orig
750 } 1830 or return;
1831 $self->prepare_orig;
1832 }
1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1839
751 } 1840 1
1841}
752 1842
753 # remove extcmds 1843sub find;
754 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1844sub find {
755 delete $EXTCMD{$name}; 1845 my ($path, $origin) = @_;
1846
1847 $path = normalise $path, $origin && $origin->path;
1848
1849 cf::lock_wait "map_find:$path";
1850
1851 $cf::MAP{$path} || do {
1852 my $guard = cf::lock_acquire "map_find:$path";
1853 my $map = new_from_path cf::map $path
1854 or return;
1855
1856 $map->{last_save} = $cf::RUNTIME;
1857
1858 $map->load_header
1859 or return;
1860
1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1862 # doing this can freeze the server in a sync job, obviously
1863 #$cf::WAIT_FOR_TICK->wait;
1864 $map->reset;
1865 undef $guard;
1866 return find $path;
1867 }
1868
1869 $cf::MAP{$path} = $map
1870 }
1871}
1872
1873sub pre_load { }
1874sub post_load { }
1875
1876sub load {
1877 my ($self) = @_;
1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1881 my $path = $self->{path};
1882
756 } 1883 {
1884 my $guard = cf::lock_acquire "map_load:$path";
757 1885
758 if (my $cb = $pkg->can ("unload")) { 1886 return if $self->in_memory != cf::MAP_SWAPPED;
759 eval { 1887
760 $cb->($pkg); 1888 $self->in_memory (cf::MAP_LOADING);
1889
1890 $self->alloc;
1891
1892 $self->pre_load;
1893 Coro::cede;
1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
761 1 1906 }
762 } or warn "$pkg unloaded, but with errors: $@"; 1907 }
763 }
764 1908
765 Symbol::delete_package $pkg; 1909 Coro::cede;
766} 1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1912 $self->difficulty ($self->estimate_difficulty)
1913 unless $self->difficulty;
1914 Coro::cede;
767 1915
768sub load_extensions { 1916 unless ($self->{deny_activate}) {
769 for my $ext (<$LIBDIR/*.ext>) { 1917 $self->decay_objects;
770 next unless -r $ext; 1918 $self->fix_auto_apply;
771 eval { 1919 $self->update_buttons;
772 load_extension $ext; 1920 Coro::cede;
773 1 1921 $self->set_darkness_map;
774 } or warn "$ext not loaded: $@"; 1922 Coro::cede;
775 } 1923 $self->activate;
776} 1924 }
777 1925
778############################################################################# 1926 $self->{last_save} = $cf::RUNTIME;
779# load/save/clean perl data associated with a map 1927 $self->last_access ($cf::RUNTIME);
780 1928
781*cf::mapsupport::on_clean = sub { 1929 $self->in_memory (cf::MAP_IN_MEMORY);
1930 }
1931
1932 $self->post_load;
1933}
1934
1935sub customise_for {
1936 my ($self, $ob) = @_;
1937
1938 return find "~" . $ob->name . "/" . $self->{path}
1939 if $self->per_player;
1940
1941# return find "?party/" . $ob->name . "/" . $self->{path}
1942# if $self->per_party;
1943
1944 $self
1945}
1946
1947# find and load all maps in the 3x3 area around a map
1948sub load_diag {
782 my ($map) = @_; 1949 my ($map) = @_;
783 1950
784 my $path = $map->tmpname; 1951 my @diag; # diagonal neighbours
785 defined $path or return;
786 1952
787 unlink "$path.pst"; 1953 for (0 .. 3) {
788}; 1954 my $neigh = $map->tile_path ($_)
1955 or next;
1956 $neigh = find $neigh, $map
1957 or next;
1958 $neigh->load;
789 1959
790cf::map->attach (prio => -10000, package => cf::mapsupport::); 1960 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1961 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1962 }
791 1963
792############################################################################# 1964 for (@diag) {
793# load/save perl data associated with player->ob objects 1965 my $neigh = find @$_
794 1966 or next;
795sub all_objects(@) { 1967 $neigh->load;
796 @_, map all_objects ($_->inv), @_ 1968 }
797} 1969}
798 1970
799# TODO: compatibility cruft, remove when no longer needed 1971sub find_sync {
800cf::player->attach ( 1972 my ($path, $origin) = @_;
801 on_load => sub {
802 my ($pl, $path) = @_;
803 1973
804 for my $o (all_objects $pl->ob) { 1974 cf::sync_job { find $path, $origin }
805 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1975}
806 $o->set_ob_key_value ("_perl_data");
807 1976
808 %$o = %{ Storable::thaw pack "H*", $value }; 1977sub do_load_sync {
1978 my ($map) = @_;
1979
1980 cf::sync_job { $map->load };
1981}
1982
1983our %MAP_PREFETCH;
1984our $MAP_PREFETCHER = undef;
1985
1986sub find_async {
1987 my ($path, $origin) = @_;
1988
1989 $path = normalise $path, $origin && $origin->{path};
1990
1991 if (my $map = $cf::MAP{$path}) {
1992 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1993 }
1994
1995 undef $MAP_PREFETCH{$path};
1996 $MAP_PREFETCHER ||= cf::async {
1997 while (%MAP_PREFETCH) {
1998 for my $path (keys %MAP_PREFETCH) {
1999 if (my $map = find $path) {
2000 $map->load;
2001 }
2002
2003 delete $MAP_PREFETCH{$path};
809 } 2004 }
810 } 2005 }
2006 undef $MAP_PREFETCHER;
2007 };
2008 $MAP_PREFETCHER->prio (6);
2009
2010 ()
2011}
2012
2013sub save {
2014 my ($self) = @_;
2015
2016 my $lock = cf::lock_acquire "map_data:" . $self->path;
2017
2018 $self->{last_save} = $cf::RUNTIME;
2019
2020 return unless $self->dirty;
2021
2022 my $save = $self->save_path; utf8::encode $save;
2023 my $uniq = $self->uniq_path; utf8::encode $uniq;
2024
2025 $self->{load_path} = $save;
2026
2027 return if $self->{deny_save};
2028
2029 local $self->{last_access} = $self->last_access;#d#
2030
2031 cf::async {
2032 $_->contr->save for $self->players;
2033 };
2034
2035 if ($uniq) {
2036 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2037 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2038 } else {
2039 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
811 }, 2040 }
812); 2041}
813 2042
814############################################################################# 2043sub swap_out {
2044 my ($self) = @_;
815 2045
816=head2 CORE EXTENSIONS 2046 # save first because save cedes
2047 $self->save;
817 2048
818Functions and methods that extend core crossfire objects. 2049 my $lock = cf::lock_acquire "map_data:" . $self->path;
819 2050
820=head3 cf::player 2051 return if $self->players;
2052 return if $self->in_memory != cf::MAP_IN_MEMORY;
2053 return if $self->{deny_save};
2054
2055 $self->clear;
2056 $self->in_memory (cf::MAP_SWAPPED);
2057}
2058
2059sub reset_at {
2060 my ($self) = @_;
2061
2062 # TODO: safety, remove and allow resettable per-player maps
2063 return 1e99 if $self->{deny_reset};
2064
2065 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2066 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2067
2068 $time + $to
2069}
2070
2071sub should_reset {
2072 my ($self) = @_;
2073
2074 $self->reset_at <= $cf::RUNTIME
2075}
2076
2077sub reset {
2078 my ($self) = @_;
2079
2080 my $lock = cf::lock_acquire "map_data:$self->{path}";
2081
2082 return if $self->players;
2083
2084 warn "resetting map ", $self->path;
2085
2086 $self->in_memory (cf::MAP_SWAPPED);
2087
2088 # need to save uniques path
2089 unless ($self->{deny_save}) {
2090 my $uniq = $self->uniq_path; utf8::encode $uniq;
2091
2092 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2093 if $uniq;
2094 }
2095
2096 delete $cf::MAP{$self->path};
2097
2098 $self->clear;
2099
2100 $_->clear_links_to ($self) for values %cf::MAP;
2101
2102 $self->unlink_save;
2103 $self->destroy;
2104}
2105
2106my $nuke_counter = "aaaa";
2107
2108sub nuke {
2109 my ($self) = @_;
2110
2111 delete $cf::MAP{$self->path};
2112
2113 $self->unlink_save;
2114
2115 bless $self, "cf::map";
2116 delete $self->{deny_reset};
2117 $self->{deny_save} = 1;
2118 $self->reset_timeout (1);
2119 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2120
2121 $cf::MAP{$self->path} = $self;
2122
2123 $self->reset; # polite request, might not happen
2124}
2125
2126=item $maps = cf::map::tmp_maps
2127
2128Returns an arrayref with all map paths of currently instantiated and saved
2129maps. May block.
2130
2131=cut
2132
2133sub tmp_maps() {
2134 [
2135 map {
2136 utf8::decode $_;
2137 /\.map$/
2138 ? normalise $_
2139 : ()
2140 } @{ aio_readdir $TMPDIR or [] }
2141 ]
2142}
2143
2144=item $maps = cf::map::random_maps
2145
2146Returns an arrayref with all map paths of currently instantiated and saved
2147random maps. May block.
2148
2149=cut
2150
2151sub random_maps() {
2152 [
2153 map {
2154 utf8::decode $_;
2155 /\.map$/
2156 ? normalise "?random/$_"
2157 : ()
2158 } @{ aio_readdir $RANDOMDIR or [] }
2159 ]
2160}
2161
2162=item cf::map::unique_maps
2163
2164Returns an arrayref of paths of all shared maps that have
2165instantiated unique items. May block.
2166
2167=cut
2168
2169sub unique_maps() {
2170 [
2171 map {
2172 utf8::decode $_;
2173 /\.map$/
2174 ? normalise $_
2175 : ()
2176 } @{ aio_readdir $UNIQUEDIR or [] }
2177 ]
2178}
2179
2180package cf;
2181
2182=back
2183
2184=head3 cf::object
2185
2186=cut
2187
2188package cf::object;
821 2189
822=over 4 2190=over 4
823 2191
824=item cf::player::exists $login 2192=item $ob->inv_recursive
825 2193
826Returns true when the given account exists. 2194Returns the inventory of the object _and_ their inventories, recursively.
827 2195
828=cut 2196=cut
829 2197
830sub cf::player::exists($) { 2198sub inv_recursive_;
831 cf::player::find $_[0] 2199sub inv_recursive_ {
832 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2200 map { $_, inv_recursive_ $_->inv } @_
833} 2201}
834 2202
835=item $player->ext_reply ($msgid, $msgtype, %msg) 2203sub inv_recursive {
836 2204 inv_recursive_ inv $_[0]
837Sends an ext reply to the player.
838
839=cut
840
841sub cf::player::ext_reply($$$%) {
842 my ($self, $id, %msg) = @_;
843
844 $msg{msgid} = $id;
845
846 $self->send ("ext " . to_json \%msg);
847} 2205}
2206
2207package cf;
848 2208
849=back 2209=back
850 2210
851=head3 cf::object::player 2211=head3 cf::object::player
852 2212
868 2228
869 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2229 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
870 2230
871 if ($self->{record_replies}) { 2231 if ($self->{record_replies}) {
872 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2232 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2233
873 } else { 2234 } else {
2235 my $pl = $self->contr;
2236
2237 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2238 my $dialog = $pl->{npc_dialog};
2239 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2240
2241 } else {
874 $msg = $npc->name . " says: $msg" if $npc; 2242 $msg = $npc->name . " says: $msg" if $npc;
875 $self->message ($msg, $flags); 2243 $self->message ($msg, $flags);
2244 }
876 } 2245 }
877} 2246}
878 2247
879=item $player_object->may ("access") 2248=item $player_object->may ("access")
880 2249
890 (ref $cf::CFG{"may_$access"} 2259 (ref $cf::CFG{"may_$access"}
891 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2260 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
892 : $cf::CFG{"may_$access"}) 2261 : $cf::CFG{"may_$access"})
893} 2262}
894 2263
2264=item $player_object->enter_link
2265
2266Freezes the player and moves him/her to a special map (C<{link}>).
2267
2268The player should be reasonably safe there for short amounts of time. You
2269I<MUST> call C<leave_link> as soon as possible, though.
2270
2271Will never block.
2272
2273=item $player_object->leave_link ($map, $x, $y)
2274
2275Moves the player out of the special C<{link}> map onto the specified
2276map. If the map is not valid (or omitted), the player will be moved back
2277to the location he/she was before the call to C<enter_link>, or, if that
2278fails, to the emergency map position.
2279
2280Might block.
2281
2282=cut
2283
2284sub link_map {
2285 unless ($LINK_MAP) {
2286 $LINK_MAP = cf::map::find "{link}"
2287 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2288 $LINK_MAP->load;
2289 }
2290
2291 $LINK_MAP
2292}
2293
2294sub cf::object::player::enter_link {
2295 my ($self) = @_;
2296
2297 $self->deactivate_recursive;
2298
2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
2300
2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2302 if $self->map && $self->map->{path} ne "{link}";
2303
2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2305}
2306
2307sub cf::object::player::leave_link {
2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
2311
2312 my $link_pos = delete $self->{_link_pos};
2313
2314 unless ($map) {
2315 # restore original map position
2316 ($map, $x, $y) = @{ $link_pos || [] };
2317 $map = cf::map::find $map;
2318
2319 unless ($map) {
2320 ($map, $x, $y) = @$EMERGENCY_POSITION;
2321 $map = cf::map::find $map
2322 or die "FATAL: cannot load emergency map\n";
2323 }
2324 }
2325
2326 ($x, $y) = (-1, -1)
2327 unless (defined $x) && (defined $y);
2328
2329 # use -1 or undef as default coordinates, not 0, 0
2330 ($x, $y) = ($map->enter_x, $map->enter_y)
2331 if $x <=0 && $y <= 0;
2332
2333 $map->load;
2334 $map->load_diag;
2335
2336 return unless $self->contr->active;
2337 $self->activate_recursive;
2338
2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2340 $self->enter_map ($map, $x, $y);
2341}
2342
2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2344
2345Moves the player to the given map-path and coordinates by first freezing
2346her, loading and preparing them map, calling the provided $check callback
2347that has to return the map if sucecssful, and then unfreezes the player on
2348the new (success) or old (failed) map position. In either case, $done will
2349be called at the end of this process.
2350
2351=cut
2352
2353our $GOTOGEN;
2354
2355sub cf::object::player::goto {
2356 my ($self, $path, $x, $y, $check, $done) = @_;
2357
2358 # do generation counting so two concurrent goto's will be executed in-order
2359 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2360
2361 $self->enter_link;
2362
2363 (async {
2364 my $map = eval {
2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
2368 $map = $map->customise_for ($self);
2369 $map = $check->($map) if $check && $map;
2370 } else {
2371 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2372 }
2373
2374 $map
2375 };
2376
2377 if ($@) {
2378 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2379 LOG llevError | logBacktrace, Carp::longmess $@;
2380 }
2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
2388 })->prio (1);
2389}
2390
2391=item $player_object->enter_exit ($exit_object)
2392
2393=cut
2394
2395sub parse_random_map_params {
2396 my ($spec) = @_;
2397
2398 my $rmp = { # defaults
2399 xsize => (cf::rndm 15, 40),
2400 ysize => (cf::rndm 15, 40),
2401 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2402 #layout => string,
2403 };
2404
2405 for (split /\n/, $spec) {
2406 my ($k, $v) = split /\s+/, $_, 2;
2407
2408 $rmp->{lc $k} = $v if (length $k) && (length $v);
2409 }
2410
2411 $rmp
2412}
2413
2414sub prepare_random_map {
2415 my ($exit) = @_;
2416
2417 my $guard = cf::lock_acquire "exit_prepare:$exit";
2418
2419 # all this does is basically replace the /! path by
2420 # a new random map path (?random/...) with a seed
2421 # that depends on the exit object
2422
2423 my $rmp = parse_random_map_params $exit->msg;
2424
2425 if ($exit->map) {
2426 $rmp->{region} = $exit->region->name;
2427 $rmp->{origin_map} = $exit->map->path;
2428 $rmp->{origin_x} = $exit->x;
2429 $rmp->{origin_y} = $exit->y;
2430 }
2431
2432 $rmp->{random_seed} ||= $exit->random_seed;
2433
2434 my $data = cf::to_json $rmp;
2435 my $md5 = Digest::MD5::md5_hex $data;
2436 my $meta = "$RANDOMDIR/$md5.meta";
2437
2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2439 aio_write $fh, 0, (length $data), $data, 0;
2440 undef $fh;
2441 aio_rename "$meta~", $meta;
2442
2443 $exit->slaying ("?random/$md5");
2444 $exit->msg (undef);
2445 }
2446}
2447
2448sub cf::object::player::enter_exit {
2449 my ($self, $exit) = @_;
2450
2451 return unless $self->type == cf::PLAYER;
2452
2453 if ($exit->slaying eq "/!") {
2454 #TODO: this should de-fi-ni-te-ly not be a sync-job
2455 # the problem is that $exit might not survive long enough
2456 # so it needs to be done right now, right here
2457 cf::sync_job { prepare_random_map $exit };
2458 }
2459
2460 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2461 my $hp = $exit->stats->hp;
2462 my $sp = $exit->stats->sp;
2463
2464 $self->enter_link;
2465
2466 # if exit is damned, update players death & WoR home-position
2467 $self->contr->savebed ($slaying, $hp, $sp)
2468 if $exit->flag (FLAG_DAMNED);
2469
2470 (async {
2471 $self->deactivate_recursive; # just to be sure
2472 unless (eval {
2473 $self->goto ($slaying, $hp, $sp);
2474
2475 1;
2476 }) {
2477 $self->message ("Something went wrong deep within the crossfire server. "
2478 . "I'll try to bring you back to the map you were before. "
2479 . "Please report this to the dungeon master!",
2480 cf::NDI_UNIQUE | cf::NDI_RED);
2481
2482 warn "ERROR in enter_exit: $@";
2483 $self->leave_link;
2484 }
2485 })->prio (1);
2486}
2487
895=head3 cf::client 2488=head3 cf::client
896 2489
897=over 4 2490=over 4
898 2491
899=item $client->send_drawinfo ($text, $flags) 2492=item $client->send_drawinfo ($text, $flags)
905 2498
906sub cf::client::send_drawinfo { 2499sub cf::client::send_drawinfo {
907 my ($self, $text, $flags) = @_; 2500 my ($self, $text, $flags) = @_;
908 2501
909 utf8::encode $text; 2502 utf8::encode $text;
910 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2503 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
911} 2504}
912 2505
2506=item $client->send_msg ($channel, $msg, $color, [extra...])
2507
2508Send a drawinfo or msg packet to the client, formatting the msg for the
2509client if neccessary. C<$type> should be a string identifying the type of
2510the message, with C<log> being the default. If C<$color> is negative, suppress
2511the message unless the client supports the msg packet.
2512
2513=cut
2514
2515sub cf::client::send_msg {
2516 my ($self, $channel, $msg, $color, @extra) = @_;
2517
2518 $msg = $self->pl->expand_cfpod ($msg);
2519
2520 $color &= cf::NDI_CLIENT_MASK; # just in case...
2521
2522 if (ref $channel) {
2523 # send meta info to client, if not yet sent
2524 unless (exists $self->{channel}{$channel->{id}}) {
2525 $self->{channel}{$channel->{id}} = $channel;
2526 $self->ext_msg (channel_info => $channel);
2527 }
2528
2529 $channel = $channel->{id};
2530 }
2531
2532 return unless @extra || length $msg;
2533
2534 if ($self->can_msg) {
2535 # default colour, mask it out
2536 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2537 if $color & cf::NDI_DEF;
2538
2539 $self->send_packet ("msg " . $self->{json_coder}->encode (
2540 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2541 } else {
2542 if ($color >= 0) {
2543 # replace some tags by gcfclient-compatible ones
2544 for ($msg) {
2545 1 while
2546 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2547 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2548 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2549 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2550 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2551 }
2552
2553 $color &= cf::NDI_COLOR_MASK;
2554
2555 utf8::encode $msg;
2556
2557 if (0 && $msg =~ /\[/) {
2558 $self->send_packet ("drawextinfo $color 4 0 $msg")
2559 } else {
2560 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2561 $self->send_packet ("drawinfo $color $msg")
2562 }
2563 }
2564 }
2565}
2566
2567=item $client->ext_msg ($type, @msg)
2568
2569Sends an ext event to the client.
2570
2571=cut
2572
2573sub cf::client::ext_msg($$@) {
2574 my ($self, $type, @msg) = @_;
2575
2576 my $extcmd = $self->extcmd;
2577
2578 if ($extcmd == 2) {
2579 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2580 } elsif ($extcmd == 1) { # TODO: remove
2581 push @msg, msgtype => "event_$type";
2582 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2583 }
2584}
913 2585
914=item $success = $client->query ($flags, "text", \&cb) 2586=item $success = $client->query ($flags, "text", \&cb)
915 2587
916Queues a query to the client, calling the given callback with 2588Queues a query to the client, calling the given callback with
917the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2589the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
918C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2590C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
919 2591
920Queries can fail, so check the return code. Or don't, as queries will become 2592Queries can fail, so check the return code. Or don't, as queries will
921reliable at some point in the future. 2593become reliable at some point in the future.
922 2594
923=cut 2595=cut
924 2596
925sub cf::client::query { 2597sub cf::client::query {
926 my ($self, $flags, $text, $cb) = @_; 2598 my ($self, $flags, $text, $cb) = @_;
934 utf8::encode $text; 2606 utf8::encode $text;
935 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2607 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
936 2608
937 $self->send_packet ($self->{query_queue}[0][0]) 2609 $self->send_packet ($self->{query_queue}[0][0])
938 if @{ $self->{query_queue} } == 1; 2610 if @{ $self->{query_queue} } == 1;
2611
2612 1
939} 2613}
940 2614
941cf::client->attach ( 2615cf::client->attach (
2616 on_connect => sub {
2617 my ($ns) = @_;
2618
2619 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2620 },
942 on_reply => sub { 2621 on_reply => sub {
943 my ($ns, $msg) = @_; 2622 my ($ns, $msg) = @_;
944 2623
945 # this weird shuffling is so that direct followup queries 2624 # this weird shuffling is so that direct followup queries
946 # get handled first 2625 # get handled first
947 my $queue = delete $ns->{query_queue}; 2626 my $queue = delete $ns->{query_queue}
2627 or return; # be conservative, not sure how that can happen, but we saw a crash here
948 2628
949 (shift @$queue)->[1]->($msg); 2629 (shift @$queue)->[1]->($msg);
2630 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
950 2631
951 push @{ $ns->{query_queue} }, @$queue; 2632 push @{ $ns->{query_queue} }, @$queue;
952 2633
953 if (@{ $ns->{query_queue} } == @$queue) { 2634 if (@{ $ns->{query_queue} } == @$queue) {
954 if (@$queue) { 2635 if (@$queue) {
956 } else { 2637 } else {
957 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2638 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
958 } 2639 }
959 } 2640 }
960 }, 2641 },
2642 on_exticmd => sub {
2643 my ($ns, $buf) = @_;
2644
2645 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2646
2647 if (ref $msg) {
2648 my ($type, $reply, @payload) =
2649 "ARRAY" eq ref $msg
2650 ? @$msg
2651 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2652
2653 if (my $cb = $EXTICMD{$type}) {
2654 my @reply = $cb->($ns, @payload);
2655
2656 $ns->ext_reply ($reply, @reply)
2657 if $reply;
2658 }
2659 } else {
2660 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2661 }
2662
2663 cf::override;
2664 },
961); 2665);
962 2666
963=item $client->coro (\&cb) 2667=item $client->async (\&cb)
964 2668
965Create a new coroutine, running the specified callback. The coroutine will 2669Create a new coroutine, running the specified callback. The coroutine will
966be automatically cancelled when the client gets destroyed (e.g. on logout, 2670be automatically cancelled when the client gets destroyed (e.g. on logout,
967or loss of connection). 2671or loss of connection).
968 2672
969=cut 2673=cut
970 2674
971sub cf::client::coro { 2675sub cf::client::async {
972 my ($self, $cb) = @_; 2676 my ($self, $cb) = @_;
973 2677
974 my $coro; $coro = async { 2678 my $coro = &Coro::async ($cb);
975 eval {
976 $cb->();
977 };
978 warn $@ if $@;
979 };
980 2679
981 $coro->on_destroy (sub { 2680 $coro->on_destroy (sub {
982 delete $self->{_coro}{$coro+0}; 2681 delete $self->{_coro}{$coro+0};
983 }); 2682 });
984 2683
1011our $safe = new Safe "safe"; 2710our $safe = new Safe "safe";
1012our $safe_hole = new Safe::Hole; 2711our $safe_hole = new Safe::Hole;
1013 2712
1014$SIG{FPE} = 'IGNORE'; 2713$SIG{FPE} = 'IGNORE';
1015 2714
1016$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2715$safe->permit_only (Opcode::opset qw(
2716 :base_core :base_mem :base_orig :base_math
2717 grepstart grepwhile mapstart mapwhile
2718 sort time
2719));
1017 2720
1018# here we export the classes and methods available to script code 2721# here we export the classes and methods available to script code
1019 2722
1020=pod 2723=pod
1021 2724
1022The following fucntions and emthods are available within a safe environment: 2725The following functions and methods are available within a safe environment:
1023 2726
1024 cf::object contr pay_amount pay_player map 2727 cf::object
2728 contr pay_amount pay_player map x y force_find force_add
2729 insert remove
2730
1025 cf::object::player player 2731 cf::object::player
1026 cf::player peaceful 2732 player
1027 cf::map trigger 2733
2734 cf::player
2735 peaceful
2736
2737 cf::map
2738 trigger
1028 2739
1029=cut 2740=cut
1030 2741
1031for ( 2742for (
1032 ["cf::object" => qw(contr pay_amount pay_player map)], 2743 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2744 insert remove inv)],
1033 ["cf::object::player" => qw(player)], 2745 ["cf::object::player" => qw(player)],
1034 ["cf::player" => qw(peaceful)], 2746 ["cf::player" => qw(peaceful)],
1035 ["cf::map" => qw(trigger)], 2747 ["cf::map" => qw(trigger)],
1036) { 2748) {
1037 no strict 'refs'; 2749 no strict 'refs';
1108=back 2820=back
1109 2821
1110=cut 2822=cut
1111 2823
1112############################################################################# 2824#############################################################################
2825# the server's init and main functions
1113 2826
1114=head2 EXTENSION DATABASE SUPPORT 2827sub load_facedata($) {
2828 my ($path) = @_;
1115 2829
1116Crossfire maintains a very simple database for extension use. It can 2830 warn "loading facedata from $path\n";
1117currently store anything that can be serialised using Storable, which
1118excludes objects.
1119 2831
1120The parameter C<$family> should best start with the name of the extension 2832 my $facedata;
1121using it, it should be unique. 2833 0 < aio_load $path, $facedata
2834 or die "$path: $!";
1122 2835
1123=over 4 2836 $facedata = Coro::Storable::thaw $facedata;
1124 2837
1125=item $hashref = cf::db_get $family 2838 $facedata->{version} == 2
2839 or cf::cleanup "$path: version mismatch, cannot proceed.";
1126 2840
1127Return a hashref for use by the extension C<$family>, which can be
1128modified. After modifications, you have to call C<cf::db_dirty> or
1129C<cf::db_sync>.
1130
1131=item $value = cf::db_get $family => $key
1132
1133Returns a single value from the database
1134
1135=item cf::db_put $family => $hashref
1136
1137Stores the given family hashref into the database. Updates are delayed, if
1138you want the data to be synced to disk immediately, use C<cf::db_sync>.
1139
1140=item cf::db_put $family => $key => $value
1141
1142Stores the given C<$value> in the family hash. Updates are delayed, if you
1143want the data to be synced to disk immediately, use C<cf::db_sync>.
1144
1145=item cf::db_dirty
1146
1147Marks the database as dirty, to be updated at a later time.
1148
1149=item cf::db_sync
1150
1151Immediately write the database to disk I<if it is dirty>.
1152
1153=cut
1154
1155our $DB;
1156
1157{
1158 my $path = cf::localdir . "/database.pst";
1159
1160 sub db_load() {
1161 warn "loading database $path\n";#d# remove later
1162 $DB = stat $path ? Storable::retrieve $path : { };
1163 } 2841 {
2842 my $faces = $facedata->{faceinfo};
1164 2843
1165 my $pid; 2844 while (my ($face, $info) = each %$faces) {
2845 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2846 cf::face::set_visibility $idx, $info->{visibility};
2847 cf::face::set_magicmap $idx, $info->{magicmap};
2848 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2849 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1166 2850
1167 sub db_save() { 2851 cf::cede_to_tick;
1168 warn "saving database $path\n";#d# remove later
1169 waitpid $pid, 0 if $pid;
1170 if (0 == ($pid = fork)) {
1171 $DB->{_meta}{version} = 1;
1172 Storable::nstore $DB, "$path~";
1173 rename "$path~", $path;
1174 cf::_exit 0 if defined $pid;
1175 }
1176 }
1177
1178 my $dirty;
1179
1180 sub db_sync() {
1181 db_save if $dirty;
1182 undef $dirty;
1183 }
1184
1185 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1186 db_sync;
1187 });
1188
1189 sub db_dirty() {
1190 $dirty = 1;
1191 $idle->start;
1192 }
1193
1194 sub db_get($;$) {
1195 @_ >= 2
1196 ? $DB->{$_[0]}{$_[1]}
1197 : ($DB->{$_[0]} ||= { })
1198 }
1199
1200 sub db_put($$;$) {
1201 if (@_ >= 3) {
1202 $DB->{$_[0]}{$_[1]} = $_[2];
1203 } else {
1204 $DB->{$_[0]} = $_[1];
1205 }
1206 db_dirty;
1207 }
1208
1209 cf::global->attach (
1210 prio => 10000,
1211 on_cleanup => sub {
1212 db_sync;
1213 }, 2852 }
1214 );
1215}
1216 2853
1217############################################################################# 2854 while (my ($face, $info) = each %$faces) {
1218# the server's main() 2855 next unless $info->{smooth};
2856 my $idx = cf::face::find $face
2857 or next;
2858 if (my $smooth = cf::face::find $info->{smooth}) {
2859 cf::face::set_smooth $idx, $smooth;
2860 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2861 } else {
2862 warn "smooth face '$info->{smooth}' not found for face '$face'";
2863 }
2864
2865 cf::cede_to_tick;
2866 }
2867 }
2868
2869 {
2870 my $anims = $facedata->{animinfo};
2871
2872 while (my ($anim, $info) = each %$anims) {
2873 cf::anim::set $anim, $info->{frames}, $info->{facings};
2874 cf::cede_to_tick;
2875 }
2876
2877 cf::anim::invalidate_all; # d'oh
2878 }
2879
2880 {
2881 # TODO: for gcfclient pleasure, we should give resources
2882 # that gcfclient doesn't grok a >10000 face index.
2883 my $res = $facedata->{resource};
2884 my $enc = JSON::XS->new->utf8->canonical;
2885
2886 my $soundconf = delete $res->{"res/sound.conf"};
2887
2888 while (my ($name, $info) = each %$res) {
2889 my $meta = $enc->encode ({
2890 name => $name,
2891 %{ $info->{meta} || {} },
2892 });
2893
2894 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2895
2896 if ($info->{type} & 1) {
2897 # prepend meta info
2898
2899 my $data = pack "(w/a*)*", $meta, $info->{data};
2900 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2901
2902 cf::face::set_data $idx, 0, $data, $chk;
2903 } else {
2904 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2905 }
2906
2907 cf::face::set_type $idx, $info->{type};
2908
2909 cf::cede_to_tick;
2910 }
2911
2912 if ($soundconf) {
2913 $soundconf = $enc->decode (delete $soundconf->{data});
2914
2915 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2916 my $sound = $soundconf->{compat}[$_]
2917 or next;
2918
2919 my $face = cf::face::find "sound/$sound->[1]";
2920 cf::sound::set $sound->[0] => $face;
2921 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2922 }
2923
2924 while (my ($k, $v) = each %{$soundconf->{event}}) {
2925 my $face = cf::face::find "sound/$v";
2926 cf::sound::set $k => $face;
2927 }
2928 }
2929 }
2930
2931 1
2932}
2933
2934register_exticmd fx_want => sub {
2935 my ($ns, $want) = @_;
2936
2937 while (my ($k, $v) = each %$want) {
2938 $ns->fx_want ($k, $v);
2939 }
2940};
2941
2942sub reload_regions {
2943 load_resource_file "$MAPDIR/regions"
2944 or die "unable to load regions file\n";
2945
2946 for (cf::region::list) {
2947 $_->{match} = qr/$_->{match}/
2948 if exists $_->{match};
2949 }
2950}
2951
2952sub reload_facedata {
2953 load_facedata "$DATADIR/facedata"
2954 or die "unable to load facedata\n";
2955}
2956
2957sub reload_archetypes {
2958 load_resource_file "$DATADIR/archetypes"
2959 or die "unable to load archetypes\n";
2960 #d# NEED to laod twice to resolve forward references
2961 # this really needs to be done in an extra post-pass
2962 # (which needs to be synchronous, so solve it differently)
2963 load_resource_file "$DATADIR/archetypes"
2964 or die "unable to load archetypes\n";
2965}
2966
2967sub reload_treasures {
2968 load_resource_file "$DATADIR/treasures"
2969 or die "unable to load treasurelists\n";
2970}
2971
2972sub reload_resources {
2973 warn "reloading resource files...\n";
2974
2975 reload_regions;
2976 reload_facedata;
2977 #reload_archetypes;#d#
2978 reload_archetypes;
2979 reload_treasures;
2980
2981 warn "finished reloading resource files\n";
2982}
2983
2984sub init {
2985 reload_resources;
2986}
1219 2987
1220sub cfg_load { 2988sub cfg_load {
1221 open my $fh, "<:utf8", cf::confdir . "/config" 2989 open my $fh, "<:utf8", "$CONFDIR/config"
1222 or return; 2990 or return;
1223 2991
1224 local $/; 2992 local $/;
1225 *CFG = YAML::Syck::Load <$fh>; 2993 *CFG = YAML::Syck::Load <$fh>;
2994
2995 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2996
2997 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2998 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2999
3000 if (exists $CFG{mlockall}) {
3001 eval {
3002 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3003 and die "WARNING: m(un)lockall failed: $!\n";
3004 };
3005 warn $@ if $@;
3006 }
1226} 3007}
1227 3008
1228sub main { 3009sub main {
3010 # we must not ever block the main coroutine
3011 local $Coro::idle = sub {
3012 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3013 (async {
3014 Event::one_event;
3015 })->prio (Coro::PRIO_MAX);
3016 };
3017
1229 cfg_load; 3018 cfg_load;
1230 db_load; 3019 db_init;
1231 load_extensions; 3020 load_extensions;
3021
3022 $TICK_WATCHER->start;
1232 Event::loop; 3023 Event::loop;
1233} 3024}
1234 3025
1235############################################################################# 3026#############################################################################
1236# initialisation 3027# initialisation and cleanup
1237 3028
1238sub _perl_reload() { 3029# install some emergency cleanup handlers
3030BEGIN {
3031 for my $signal (qw(INT HUP TERM)) {
3032 Event->signal (
3033 reentrant => 0,
3034 data => WF_AUTOCANCEL,
3035 signal => $signal,
3036 prio => 0,
3037 cb => sub {
3038 cf::cleanup "SIG$signal";
3039 },
3040 );
3041 }
3042}
3043
3044sub write_runtime {
3045 my $runtime = "$LOCALDIR/runtime";
3046
3047 # first touch the runtime file to show we are still running:
3048 # the fsync below can take a very very long time.
3049
3050 IO::AIO::aio_utime $runtime, undef, undef;
3051
3052 my $guard = cf::lock_acquire "write_runtime";
3053
3054 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3055 or return;
3056
3057 my $value = $cf::RUNTIME + 90 + 10;
3058 # 10 is the runtime save interval, for a monotonic clock
3059 # 60 allows for the watchdog to kill the server.
3060
3061 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3062 and return;
3063
3064 # always fsync - this file is important
3065 aio_fsync $fh
3066 and return;
3067
3068 # touch it again to show we are up-to-date
3069 aio_utime $fh, undef, undef;
3070
3071 close $fh
3072 or return;
3073
3074 aio_rename "$runtime~", $runtime
3075 and return;
3076
3077 warn "runtime file written.\n";
3078
3079 1
3080}
3081
3082sub emergency_save() {
3083 my $freeze_guard = cf::freeze_mainloop;
3084
3085 warn "enter emergency perl save\n";
3086
3087 cf::sync_job {
3088 # use a peculiar iteration method to avoid tripping on perl
3089 # refcount bugs in for. also avoids problems with players
3090 # and maps saved/destroyed asynchronously.
3091 warn "begin emergency player save\n";
3092 for my $login (keys %cf::PLAYER) {
3093 my $pl = $cf::PLAYER{$login} or next;
3094 $pl->valid or next;
3095 $pl->save;
3096 }
3097 warn "end emergency player save\n";
3098
3099 warn "begin emergency map save\n";
3100 for my $path (keys %cf::MAP) {
3101 my $map = $cf::MAP{$path} or next;
3102 $map->valid or next;
3103 $map->save;
3104 }
3105 warn "end emergency map save\n";
3106
3107 warn "begin emergency database checkpoint\n";
3108 BDB::db_env_txn_checkpoint $DB_ENV;
3109 warn "end emergency database checkpoint\n";
3110 };
3111
3112 warn "leave emergency perl save\n";
3113}
3114
3115sub post_cleanup {
3116 my ($make_core) = @_;
3117
3118 warn Carp::longmess "post_cleanup backtrace"
3119 if $make_core;
3120}
3121
3122sub do_reload_perl() {
3123 # can/must only be called in main
3124 if ($Coro::current != $Coro::main) {
3125 warn "can only reload from main coroutine";
3126 return;
3127 }
3128
1239 warn "reloading..."; 3129 warn "reloading...";
1240 3130
1241 eval { 3131 warn "entering sync_job";
1242 local $FREEZE = 1;
1243 3132
3133 cf::sync_job {
3134 cf::write_runtime; # external watchdog should not bark
1244 cf::emergency_save; 3135 cf::emergency_save;
3136 cf::write_runtime; # external watchdog should not bark
1245 3137
1246 # cancel all watchers 3138 warn "syncing database to disk";
3139 BDB::db_env_txn_checkpoint $DB_ENV;
3140
3141 # if anything goes wrong in here, we should simply crash as we already saved
3142
3143 warn "cancelling all WF_AUTOCANCEL watchers";
1247 for (Event::all_watchers) { 3144 for (Event::all_watchers) {
1248 $_->cancel if $_->data & WF_AUTOCANCEL; 3145 $_->cancel if $_->data & WF_AUTOCANCEL;
1249 } 3146 }
1250 3147
3148 warn "flushing outstanding aio requests";
3149 for (;;) {
3150 BDB::flush;
3151 IO::AIO::flush;
3152 Coro::cede;
3153 last unless IO::AIO::nreqs || BDB::nreqs;
3154 warn "iterate...";
3155 }
3156
3157 ++$RELOAD;
3158
1251 # cancel all extension coros 3159 warn "cancelling all extension coros";
1252 $_->cancel for values %EXT_CORO; 3160 $_->cancel for values %EXT_CORO;
1253 %EXT_CORO = (); 3161 %EXT_CORO = ();
1254 3162
1255 # unload all extensions 3163 warn "removing commands";
1256 for (@exts) { 3164 %COMMAND = ();
3165
3166 warn "removing ext/exti commands";
3167 %EXTCMD = ();
3168 %EXTICMD = ();
3169
3170 warn "unloading/nuking all extensions";
3171 for my $pkg (@EXTS) {
1257 warn "unloading <$_>"; 3172 warn "... unloading $pkg";
1258 unload_extension $_; 3173
3174 if (my $cb = $pkg->can ("unload")) {
3175 eval {
3176 $cb->($pkg);
3177 1
3178 } or warn "$pkg unloaded, but with errors: $@";
1259 } 3179 }
1260 3180
3181 warn "... nuking $pkg";
3182 Symbol::delete_package $pkg;
3183 }
3184
1261 # unload all modules loaded from $LIBDIR 3185 warn "unloading all perl modules loaded from $LIBDIR";
1262 while (my ($k, $v) = each %INC) { 3186 while (my ($k, $v) = each %INC) {
1263 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3187 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1264 3188
1265 warn "removing <$k>"; 3189 warn "... unloading $k";
1266 delete $INC{$k}; 3190 delete $INC{$k};
1267 3191
1268 $k =~ s/\.pm$//; 3192 $k =~ s/\.pm$//;
1269 $k =~ s/\//::/g; 3193 $k =~ s/\//::/g;
1270 3194
1273 } 3197 }
1274 3198
1275 Symbol::delete_package $k; 3199 Symbol::delete_package $k;
1276 } 3200 }
1277 3201
1278 # sync database to disk
1279 cf::db_sync;
1280 IO::AIO::flush;
1281
1282 # get rid of safe::, as good as possible 3202 warn "getting rid of safe::, as good as possible";
1283 Symbol::delete_package "safe::$_" 3203 Symbol::delete_package "safe::$_"
1284 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3204 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1285 3205
1286 # remove register_script_function callbacks
1287 # TODO
1288
1289 # unload cf.pm "a bit" 3206 warn "unloading cf.pm \"a bit\"";
1290 delete $INC{"cf.pm"}; 3207 delete $INC{"cf.pm"};
3208 delete $INC{"cf/pod.pm"};
1291 3209
1292 # don't, removes xs symbols, too, 3210 # don't, removes xs symbols, too,
1293 # and global variables created in xs 3211 # and global variables created in xs
1294 #Symbol::delete_package __PACKAGE__; 3212 #Symbol::delete_package __PACKAGE__;
1295 3213
1296 # reload cf.pm 3214 warn "unload completed, starting to reload now";
3215
1297 warn "reloading cf.pm"; 3216 warn "reloading cf.pm";
1298 require cf; 3217 require cf;
1299 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3218 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1300 3219
1301 # load config and database again 3220 warn "loading config and database again";
1302 cf::cfg_load; 3221 cf::cfg_load;
1303 cf::db_load;
1304 3222
1305 # load extensions
1306 warn "load extensions"; 3223 warn "loading extensions";
1307 cf::load_extensions; 3224 cf::load_extensions;
1308 3225
1309 # reattach attachments to objects 3226 warn "reattaching attachments to objects/players";
1310 warn "reattach"; 3227 _global_reattach; # objects, sockets
1311 _global_reattach; 3228 warn "reattaching attachments to maps";
3229 reattach $_ for values %MAP;
3230 warn "reattaching attachments to players";
3231 reattach $_ for values %PLAYER;
3232
3233 warn "leaving sync_job";
3234
3235 1
3236 } or do {
3237 warn $@;
3238 warn "error while reloading, exiting.";
3239 exit 1;
1312 }; 3240 };
1313 warn $@ if $@;
1314 3241
1315 warn "reloaded"; 3242 warn "reloaded";
1316}; 3243};
1317 3244
1318sub perl_reload() { 3245our $RELOAD_WATCHER; # used only during reload
1319 _perl_reload;
1320}
1321 3246
1322register "<global>", __PACKAGE__; 3247sub reload_perl() {
3248 # doing reload synchronously and two reloads happen back-to-back,
3249 # coro crashes during coro_state_free->destroy here.
1323 3250
3251 $RELOAD_WATCHER ||= Event->timer (
3252 reentrant => 0,
3253 after => 0,
3254 data => WF_AUTOCANCEL,
3255 cb => sub {
3256 do_reload_perl;
3257 undef $RELOAD_WATCHER;
3258 },
3259 );
3260}
3261
1324register_command "perl-reload" => sub { 3262register_command "reload" => sub {
1325 my ($who, $arg) = @_; 3263 my ($who, $arg) = @_;
1326 3264
1327 if ($who->flag (FLAG_WIZ)) { 3265 if ($who->flag (FLAG_WIZ)) {
1328 $who->message ("reloading..."); 3266 $who->message ("reloading server.");
1329 _perl_reload; 3267 async { reload_perl };
1330 } 3268 }
1331}; 3269};
1332 3270
1333unshift @INC, $LIBDIR; 3271unshift @INC, $LIBDIR;
1334 3272
3273my $bug_warning = 0;
3274
3275our @WAIT_FOR_TICK;
3276our @WAIT_FOR_TICK_BEGIN;
3277
3278sub wait_for_tick {
3279 return unless $TICK_WATCHER->is_active;
3280 return if $Coro::current == $Coro::main;
3281
3282 my $signal = new Coro::Signal;
3283 push @WAIT_FOR_TICK, $signal;
3284 $signal->wait;
3285}
3286
3287sub wait_for_tick_begin {
3288 return unless $TICK_WATCHER->is_active;
3289 return if $Coro::current == $Coro::main;
3290
3291 my $signal = new Coro::Signal;
3292 push @WAIT_FOR_TICK_BEGIN, $signal;
3293 $signal->wait;
3294}
3295
3296 my $min = 1e6;#d#
3297 my $avg = 10;
1335$TICK_WATCHER = Event->timer ( 3298$TICK_WATCHER = Event->timer (
1336 reentrant => 0, 3299 reentrant => 0,
3300 parked => 1,
1337 prio => 0, 3301 prio => 0,
1338 at => $NEXT_TICK || $TICK, 3302 at => $NEXT_TICK || $TICK,
1339 data => WF_AUTOCANCEL, 3303 data => WF_AUTOCANCEL,
1340 cb => sub { 3304 cb => sub {
1341 unless ($FREEZE) { 3305 if ($Coro::current != $Coro::main) {
3306 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3307 unless ++$bug_warning > 10;
3308 return;
3309 }
3310
3311 $NOW = $tick_start = Event::time;
3312
1342 cf::server_tick; # one server iteration 3313 cf::server_tick; # one server iteration
1343 $RUNTIME += $TICK; 3314
3315 0 && sync_job {#d#
3316 for(1..10) {
3317 my $t = Event::time;
3318 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3319 or die;
3320
3321 $map->width (50);
3322 $map->height (50);
3323 $map->alloc;
3324 $map->_load_objects ("/tmp/x.map", 1);
3325 my $t = Event::time - $t;
3326
3327 #next unless $t < 0.0013;#d#
3328 if ($t < $min) {
3329 $min = $t;
3330 }
3331 $avg = $avg * 0.99 + $t * 0.01;
3332 }
3333 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3334 exit 0;
3335 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1344 } 3336 };
1345 3337
3338 $RUNTIME += $TICK;
1346 $NEXT_TICK += $TICK; 3339 $NEXT_TICK += $TICK;
1347 3340
3341 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3342 $NEXT_RUNTIME_WRITE = $NOW + 10;
3343 Coro::async_pool {
3344 write_runtime
3345 or warn "ERROR: unable to write runtime file: $!";
3346 };
3347 }
3348
3349# my $AFTER = Event::time;
3350# warn $AFTER - $NOW;#d#
3351
3352 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3353 $sig->send;
3354 }
3355 while (my $sig = shift @WAIT_FOR_TICK) {
3356 $sig->send;
3357 }
3358
3359 $NOW = Event::time;
3360
1348 # if we are delayed by four ticks or more, skip them all 3361 # if we are delayed by four ticks or more, skip them all
1349 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3362 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1350 3363
1351 $TICK_WATCHER->at ($NEXT_TICK); 3364 $TICK_WATCHER->at ($NEXT_TICK);
1352 $TICK_WATCHER->start; 3365 $TICK_WATCHER->start;
3366
3367 $LOAD = ($NOW - $tick_start) / $TICK;
3368 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3369
3370 _post_tick;
3371
3372
1353 }, 3373 },
1354); 3374);
1355 3375
3376{
3377 BDB::max_poll_time $TICK * 0.1;
3378 $BDB_POLL_WATCHER = Event->io (
3379 reentrant => 0,
3380 fd => BDB::poll_fileno,
3381 poll => 'r',
3382 prio => 0,
3383 data => WF_AUTOCANCEL,
3384 cb => \&BDB::poll_cb,
3385 );
3386 BDB::min_parallel 8;
3387
3388 BDB::set_sync_prepare {
3389 my $status;
3390 my $current = $Coro::current;
3391 (
3392 sub {
3393 $status = $!;
3394 $current->ready; undef $current;
3395 },
3396 sub {
3397 Coro::schedule while defined $current;
3398 $! = $status;
3399 },
3400 )
3401 };
3402
3403 unless ($DB_ENV) {
3404 $DB_ENV = BDB::db_env_create;
3405
3406 cf::sync_job {
3407 eval {
3408 BDB::db_env_open
3409 $DB_ENV,
3410 $BDBDIR,
3411 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3412 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3413 0666;
3414
3415 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3416
3417 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3418 $DB_ENV->set_lk_detect;
3419 };
3420
3421 cf::cleanup "db_env_open(db): $@" if $@;
3422 };
3423 }
3424}
3425
3426{
3427 IO::AIO::min_parallel 8;
3428
3429 undef $Coro::AIO::WATCHER;
1356IO::AIO::max_poll_time $TICK * 0.2; 3430 IO::AIO::max_poll_time $TICK * 0.1;
1357 3431 $AIO_POLL_WATCHER = Event->io (
1358Event->io (fd => IO::AIO::poll_fileno, 3432 reentrant => 0,
1359 poll => 'r',
1360 prio => 5,
1361 data => WF_AUTOCANCEL, 3433 data => WF_AUTOCANCEL,
3434 fd => IO::AIO::poll_fileno,
3435 poll => 'r',
3436 prio => 6,
1362 cb => \&IO::AIO::poll_cb); 3437 cb => \&IO::AIO::poll_cb,
3438 );
3439}
1363 3440
1364# we must not ever block the main coroutine 3441my $_log_backtrace;
1365$Coro::idle = sub { 3442
1366 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3443sub _log_backtrace {
1367 warn "FATAL: Coro::idle was called, major BUG\n"; 3444 my ($msg, @addr) = @_;
1368 (Coro::unblock_sub { 3445
1369 Event::one_event; 3446 $msg =~ s/\n//;
1370 })->(); 3447
1371}; 3448 # limit the # of concurrent backtraces
3449 if ($_log_backtrace < 2) {
3450 ++$_log_backtrace;
3451 async {
3452 my @bt = fork_call {
3453 @addr = map { sprintf "%x", $_ } @addr;
3454 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3455 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3456 or die "addr2line: $!";
3457
3458 my @funcs;
3459 my @res = <$fh>;
3460 chomp for @res;
3461 while (@res) {
3462 my ($func, $line) = splice @res, 0, 2, ();
3463 push @funcs, "[$func] $line";
3464 }
3465
3466 @funcs
3467 };
3468
3469 LOG llevInfo, "[ABT] $msg\n";
3470 LOG llevInfo, "[ABT] $_\n" for @bt;
3471 --$_log_backtrace;
3472 };
3473 } else {
3474 LOG llevInfo, "[ABT] $msg\n";
3475 LOG llevInfo, "[ABT] [suppressed]\n";
3476 }
3477}
3478
3479# load additional modules
3480use cf::pod;
3481
3482END { cf::emergency_save }
1372 3483
13731 34841
1374 3485

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines