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.331 by root, Mon Aug 13 13:10:01 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 $player->send_msg ($channel, $msg, $color, [extra...])
1378
1379=cut
1380
1381sub send_msg {
1382 my $ns = shift->ns
1383 or return;
1384 $ns->send_msg (@_);
1385}
1386
1387=item $pl->quit_character
1388
1389Nukes the player without looking back. If logged in, the connection will
1390be destroyed. May block for a long time.
1391
1392=cut
1393
1394sub quit_character {
1395 my ($pl) = @_;
1396
1397 my $name = $pl->ob->name;
1398
1399 $pl->{deny_save} = 1;
1400 $pl->password ("*"); # this should lock out the player until we nuked the dir
1401
1402 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1403 $pl->deactivate;
1404 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1405 $pl->ns->destroy if $pl->ns;
1406
1407 my $path = playerdir $pl;
1408 my $temp = "$path~$cf::RUNTIME~deleting~";
1409 aio_rename $path, $temp;
1410 delete $cf::PLAYER{$pl->ob->name};
1411 $pl->destroy;
1412
1413 my $prefix = qr<^~\Q$name\E/>;
1414
1415 # nuke player maps
1416 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1417
1418 IO::AIO::aio_rmtree $temp;
1419}
1420
1421=item $pl->kick
1422
1423Kicks a player out of the game. This destroys the connection.
1424
1425=cut
1426
1427sub kick {
1428 my ($pl, $kicker) = @_;
1429
1430 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1431 $pl->killer ("kicked");
1432 $pl->ns->destroy;
1433}
1434
1435=item cf::player::list_logins
1436
1437Returns am arrayref of all valid playernames in the system, can take a
1438while and may block, so not sync_job-capable, ever.
1439
1440=cut
1441
1442sub list_logins {
1443 my $dirs = aio_readdir $PLAYERDIR
1444 or return [];
1445
1446 my @logins;
1447
1448 for my $login (@$dirs) {
1449 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1450 aio_read $fh, 0, 512, my $buf, 0 or next;
1451 $buf !~ /^password -------------$/m or next; # official not-valid tag
1452
1453 utf8::decode $login;
1454 push @logins, $login;
1455 }
1456
1457 \@logins
1458}
1459
1460=item $player->maps
1461
1462Returns an arrayref of map paths that are private for this
1463player. May block.
1464
1465=cut
1466
1467sub maps($) {
1468 my ($pl) = @_;
1469
1470 $pl = ref $pl ? $pl->ob->name : $pl;
1471
1472 my $files = aio_readdir playerdir $pl
1473 or return;
1474
1475 my @paths;
1476
1477 for (@$files) {
1478 utf8::decode $_;
1479 next if /\.(?:pl|pst)$/;
1480 next unless /^$PATH_SEP/o;
1481
1482 push @paths, cf::map::normalise "~$pl/$_";
1483 }
1484
1485 \@paths
1486}
1487
1488=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1489
1490Expand crossfire pod fragments into protocol xml.
1491
1492=cut
1493
1494sub expand_cfpod {
1495 ((my $self), (local $_)) = @_;
1496
1497 # escape & and <
1498 s/&/&amp;/g;
1499 s/(?<![BIUGH])</&lt;/g;
1500
1501 # this is buggy, it needs to properly take care of nested <'s
1502
1503 1 while
1504 # replace B<>, I<>, U<> etc.
1505 s/B<([^\>]*)>/<b>$1<\/b>/
1506 || s/I<([^\>]*)>/<i>$1<\/i>/
1507 || s/U<([^\>]*)>/<u>$1<\/u>/
1508 # replace G<male|female> tags
1509 || s{G<([^>|]*)\|([^>]*)>}{
1510 $self->gender ? $2 : $1
1511 }ge
1512 # replace H<hint text>
1513 || s{H<([^\>]*)>}
1514 {
1515 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1516 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1517 "")
1518 [$self->{hintmode}]
1519 }ge;
1520
1521 # create single paragraphs (very hackish)
1522 s/(?<=\S)\n(?=\w)/ /g;
1523
1524 # compress some whitespace
1525 s/\s+\n/\n/g; # ws line-ends
1526 s/\n\n+/\n/g; # double lines
1527 s/^\n+//; # beginning lines
1528 s/\n+$//; # ending lines
1529
1530 $_
1531}
1532
1533sub hintmode {
1534 $_[0]{hintmode} = $_[1] if @_ > 1;
1535 $_[0]{hintmode}
1536}
1537
1538=item $player->ext_reply ($msgid, @msg)
1539
1540Sends an ext reply to the player.
1541
1542=cut
1543
1544sub ext_reply($$@) {
1545 my ($self, $id, @msg) = @_;
1546
1547 if ($self->ns->extcmd == 2) {
1548 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1549 } elsif ($self->ns->extcmd == 1) {
1550 #TODO: version 1, remove
1551 unshift @msg, msgtype => "reply", msgid => $id;
1552 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1553 }
1554}
1555
1556=item $player->ext_msg ($type, @msg)
1557
1558Sends an ext event to the client.
1559
1560=cut
1561
1562sub ext_msg($$@) {
1563 my ($self, $type, @msg) = @_;
1564
1565 $self->ns->ext_msg ($type, @msg);
1566}
1567
1568=head3 cf::region
1569
1570=over 4
1571
1572=cut
1573
1574package cf::region;
1575
1576=item cf::region::find_by_path $path
1577
1578Tries to decuce the likely region for a map knowing only its path.
1579
1580=cut
1581
1582sub find_by_path($) {
1583 my ($path) = @_;
1584
1585 my ($match, $specificity);
1586
1587 for my $region (list) {
1588 if ($region->{match} && $path =~ $region->{match}) {
1589 ($match, $specificity) = ($region, $region->specificity)
1590 if $region->specificity > $specificity;
1591 }
1592 }
1593
1594 $match
1595}
1596
1597=back
1598
1599=head3 cf::map
1600
1601=over 4
1602
1603=cut
1604
1605package cf::map;
1606
1607use Fcntl;
1608use Coro::AIO;
1609
1610use overload
1611 '""' => \&as_string,
1612 fallback => 1;
1613
1614our $MAX_RESET = 3600;
1615our $DEFAULT_RESET = 3000;
1616
1617sub generate_random_map {
1618 my ($self, $rmp) = @_;
1619 # mit "rum" bekleckern, nicht
1620 $self->_create_random_map (
1621 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1622 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1623 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1624 $rmp->{exit_on_final_map},
1625 $rmp->{xsize}, $rmp->{ysize},
1626 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1627 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1628 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1629 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1630 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1631 (cf::region::find $rmp->{region}), $rmp->{custom}
1632 )
1633}
1634
1635=item cf::map->register ($regex, $prio)
1636
1637Register a handler for the map path matching the given regex at the
1638givne priority (higher is better, built-in handlers have priority 0, the
1639default).
1640
1641=cut
1642
692sub register { 1643sub register {
1644 my (undef, $regex, $prio) = @_;
1645 my $pkg = caller;
1646
1647 no strict;
1648 push @{"$pkg\::ISA"}, __PACKAGE__;
1649
1650 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1651}
1652
1653# also paths starting with '/'
1654$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1655
1656sub thawer_merge {
693 my ($base, $pkg) = @_; 1657 my ($self, $merge) = @_;
694 1658
695 #TODO 1659 # we have to keep some variables in memory intact
696} 1660 local $self->{path};
1661 local $self->{load_path};
697 1662
698sub load_extension { 1663 $self->SUPER::thawer_merge ($merge);
1664}
1665
1666sub normalise {
699 my ($path) = @_; 1667 my ($path, $base) = @_;
700 1668
701 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1669 $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 1670
707 warn "loading '$path' into '$pkg'\n"; 1671 $path =~ s/\.map$//;
708 1672
709 open my $fh, "<:utf8", $path 1673 # map plan:
710 or die "$path: $!"; 1674 #
1675 # /! non-realised random map exit (special hack!)
1676 # {... are special paths that are not being touched
1677 # ?xxx/... are special absolute paths
1678 # ?random/... random maps
1679 # /... normal maps
1680 # ~user/... per-player map of a specific user
711 1681
712 my $source = 1682 $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 1683
718 eval $source 1684 # treat it as relative path if it starts with
719 or die $@ ? "$path: $@\n" 1685 # something that looks reasonable
720 : "extension disabled.\n"; 1686 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1687 $base or Carp::carp "normalise called with relative path and no base: '$path'";
721 1688
722 push @exts, $pkg; 1689 $base =~ s{[^/]+/?$}{};
723 $ext_pkg{$base} = $pkg; 1690 $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# } 1691 }
741 1692
742 # remove commands 1693 for ($path) {
743 for my $name (keys %COMMAND) { 1694 redo if s{//}{/};
744 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1695 redo if s{/\.?/}{/};
1696 redo if s{/[^/]+/\.\./}{/};
1697 }
745 1698
746 if (@cb) { 1699 $path
747 $COMMAND{$name} = \@cb; 1700}
1701
1702sub new_from_path {
1703 my (undef, $path, $base) = @_;
1704
1705 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1706
1707 $path = normalise $path, $base;
1708
1709 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1710 if ($path =~ $EXT_MAP{$pkg}[1]) {
1711 my $self = bless cf::map::new, $pkg;
1712 $self->{path} = $path; $self->path ($path);
1713 $self->init; # pass $1 etc.
1714 return $self;
1715 }
1716 }
1717
1718 Carp::cluck "unable to resolve path '$path' (base '$base').";
1719 ()
1720}
1721
1722sub init {
1723 my ($self) = @_;
1724
1725 $self
1726}
1727
1728sub as_string {
1729 my ($self) = @_;
1730
1731 "$self->{path}"
1732}
1733
1734# the displayed name, this is a one way mapping
1735sub visible_name {
1736 &as_string
1737}
1738
1739# the original (read-only) location
1740sub load_path {
1741 my ($self) = @_;
1742
1743 "$MAPDIR/$self->{path}.map"
1744}
1745
1746# the temporary/swap location
1747sub save_path {
1748 my ($self) = @_;
1749
1750 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1751 "$TMPDIR/$path.map"
1752}
1753
1754# the unique path, undef == no special unique path
1755sub uniq_path {
1756 my ($self) = @_;
1757
1758 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1759 "$UNIQUEDIR/$path"
1760}
1761
1762# and all this just because we cannot iterate over
1763# all maps in C++...
1764sub change_all_map_light {
1765 my ($change) = @_;
1766
1767 $_->change_map_light ($change)
1768 for grep $_->outdoor, values %cf::MAP;
1769}
1770
1771sub decay_objects {
1772 my ($self) = @_;
1773
1774 return if $self->{deny_reset};
1775
1776 $self->do_decay_objects;
1777}
1778
1779sub unlink_save {
1780 my ($self) = @_;
1781
1782 utf8::encode (my $save = $self->save_path);
1783 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1784 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1785}
1786
1787sub load_header_from($) {
1788 my ($self, $path) = @_;
1789
1790 utf8::encode $path;
1791 #aio_open $path, O_RDONLY, 0
1792 # or return;
1793
1794 $self->_load_header ($path)
1795 or return;
1796
1797 $self->{load_path} = $path;
1798
1799 1
1800}
1801
1802sub load_header_orig {
1803 my ($self) = @_;
1804
1805 $self->load_header_from ($self->load_path)
1806}
1807
1808sub load_header_temp {
1809 my ($self) = @_;
1810
1811 $self->load_header_from ($self->save_path)
1812}
1813
1814sub prepare_temp {
1815 my ($self) = @_;
1816
1817 $self->last_access ((delete $self->{last_access})
1818 || $cf::RUNTIME); #d#
1819 # safety
1820 $self->{instantiate_time} = $cf::RUNTIME
1821 if $self->{instantiate_time} > $cf::RUNTIME;
1822}
1823
1824sub prepare_orig {
1825 my ($self) = @_;
1826
1827 $self->{load_original} = 1;
1828 $self->{instantiate_time} = $cf::RUNTIME;
1829 $self->last_access ($cf::RUNTIME);
1830 $self->instantiate;
1831}
1832
1833sub load_header {
1834 my ($self) = @_;
1835
1836 if ($self->load_header_temp) {
1837 $self->prepare_temp;
748 } else { 1838 } else {
749 delete $COMMAND{$name}; 1839 $self->load_header_orig
750 } 1840 or return;
1841 $self->prepare_orig;
1842 }
1843
1844 $self->{deny_reset} = 1
1845 if $self->no_reset;
1846
1847 $self->default_region (cf::region::find_by_path $self->{path})
1848 unless $self->default_region;
1849
751 } 1850 1
1851}
752 1852
753 # remove extcmds 1853sub find;
754 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1854sub find {
755 delete $EXTCMD{$name}; 1855 my ($path, $origin) = @_;
1856
1857 $path = normalise $path, $origin && $origin->path;
1858
1859 cf::lock_wait "map_find:$path";
1860
1861 $cf::MAP{$path} || do {
1862 my $guard = cf::lock_acquire "map_find:$path";
1863 my $map = new_from_path cf::map $path
1864 or return;
1865
1866 $map->{last_save} = $cf::RUNTIME;
1867
1868 $map->load_header
1869 or return;
1870
1871 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1872 # doing this can freeze the server in a sync job, obviously
1873 #$cf::WAIT_FOR_TICK->wait;
1874 $map->reset;
1875 undef $guard;
1876 return find $path;
1877 }
1878
1879 $cf::MAP{$path} = $map
1880 }
1881}
1882
1883sub pre_load { }
1884sub post_load { }
1885
1886sub load {
1887 my ($self) = @_;
1888
1889 local $self->{deny_reset} = 1; # loading can take a long time
1890
1891 my $path = $self->{path};
1892
756 } 1893 {
1894 my $guard = cf::lock_acquire "map_load:$path";
757 1895
758 if (my $cb = $pkg->can ("unload")) { 1896 return if $self->in_memory != cf::MAP_SWAPPED;
759 eval { 1897
760 $cb->($pkg); 1898 $self->in_memory (cf::MAP_LOADING);
1899
1900 $self->alloc;
1901
1902 $self->pre_load;
1903 Coro::cede;
1904
1905 $self->_load_objects ($self->{load_path}, 1)
1906 or return;
1907
1908 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1909 if delete $self->{load_original};
1910
1911 if (my $uniq = $self->uniq_path) {
1912 utf8::encode $uniq;
1913 if (aio_open $uniq, O_RDONLY, 0) {
1914 $self->clear_unique_items;
1915 $self->_load_objects ($uniq, 0);
761 1 1916 }
762 } or warn "$pkg unloaded, but with errors: $@"; 1917 }
763 }
764 1918
765 Symbol::delete_package $pkg; 1919 Coro::cede;
766} 1920 # now do the right thing for maps
1921 $self->link_multipart_objects;
1922 $self->difficulty ($self->estimate_difficulty)
1923 unless $self->difficulty;
1924 Coro::cede;
767 1925
768sub load_extensions { 1926 unless ($self->{deny_activate}) {
769 for my $ext (<$LIBDIR/*.ext>) { 1927 $self->decay_objects;
770 next unless -r $ext; 1928 $self->fix_auto_apply;
771 eval { 1929 $self->update_buttons;
772 load_extension $ext; 1930 Coro::cede;
773 1 1931 $self->set_darkness_map;
774 } or warn "$ext not loaded: $@"; 1932 Coro::cede;
775 } 1933 $self->activate;
776} 1934 }
777 1935
778############################################################################# 1936 $self->{last_save} = $cf::RUNTIME;
779# load/save/clean perl data associated with a map 1937 $self->last_access ($cf::RUNTIME);
780 1938
781*cf::mapsupport::on_clean = sub { 1939 $self->in_memory (cf::MAP_IN_MEMORY);
1940 }
1941
1942 $self->post_load;
1943}
1944
1945sub customise_for {
1946 my ($self, $ob) = @_;
1947
1948 return find "~" . $ob->name . "/" . $self->{path}
1949 if $self->per_player;
1950
1951# return find "?party/" . $ob->name . "/" . $self->{path}
1952# if $self->per_party;
1953
1954 $self
1955}
1956
1957# find and load all maps in the 3x3 area around a map
1958sub load_diag {
782 my ($map) = @_; 1959 my ($map) = @_;
783 1960
784 my $path = $map->tmpname; 1961 my @diag; # diagonal neighbours
785 defined $path or return;
786 1962
787 unlink "$path.pst"; 1963 for (0 .. 3) {
788}; 1964 my $neigh = $map->tile_path ($_)
1965 or next;
1966 $neigh = find $neigh, $map
1967 or next;
1968 $neigh->load;
789 1969
790cf::map->attach (prio => -10000, package => cf::mapsupport::); 1970 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1971 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1972 }
791 1973
792############################################################################# 1974 for (@diag) {
793# load/save perl data associated with player->ob objects 1975 my $neigh = find @$_
794 1976 or next;
795sub all_objects(@) { 1977 $neigh->load;
796 @_, map all_objects ($_->inv), @_ 1978 }
797} 1979}
798 1980
799# TODO: compatibility cruft, remove when no longer needed 1981sub find_sync {
800cf::player->attach ( 1982 my ($path, $origin) = @_;
801 on_load => sub {
802 my ($pl, $path) = @_;
803 1983
804 for my $o (all_objects $pl->ob) { 1984 cf::sync_job { find $path, $origin }
805 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1985}
806 $o->set_ob_key_value ("_perl_data");
807 1986
808 %$o = %{ Storable::thaw pack "H*", $value }; 1987sub do_load_sync {
1988 my ($map) = @_;
1989
1990 cf::sync_job { $map->load };
1991}
1992
1993our %MAP_PREFETCH;
1994our $MAP_PREFETCHER = undef;
1995
1996sub find_async {
1997 my ($path, $origin) = @_;
1998
1999 $path = normalise $path, $origin && $origin->{path};
2000
2001 if (my $map = $cf::MAP{$path}) {
2002 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
2003 }
2004
2005 undef $MAP_PREFETCH{$path};
2006 $MAP_PREFETCHER ||= cf::async {
2007 while (%MAP_PREFETCH) {
2008 for my $path (keys %MAP_PREFETCH) {
2009 if (my $map = find $path) {
2010 $map->load;
2011 }
2012
2013 delete $MAP_PREFETCH{$path};
809 } 2014 }
810 } 2015 }
2016 undef $MAP_PREFETCHER;
2017 };
2018 $MAP_PREFETCHER->prio (6);
2019
2020 ()
2021}
2022
2023sub save {
2024 my ($self) = @_;
2025
2026 my $lock = cf::lock_acquire "map_data:" . $self->path;
2027
2028 $self->{last_save} = $cf::RUNTIME;
2029
2030 return unless $self->dirty;
2031
2032 my $save = $self->save_path; utf8::encode $save;
2033 my $uniq = $self->uniq_path; utf8::encode $uniq;
2034
2035 $self->{load_path} = $save;
2036
2037 return if $self->{deny_save};
2038
2039 local $self->{last_access} = $self->last_access;#d#
2040
2041 cf::async {
2042 $_->contr->save for $self->players;
2043 };
2044
2045 if ($uniq) {
2046 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2047 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2048 } else {
2049 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
811 }, 2050 }
812); 2051}
813 2052
814############################################################################# 2053sub swap_out {
2054 my ($self) = @_;
815 2055
816=head2 CORE EXTENSIONS 2056 # save first because save cedes
2057 $self->save;
817 2058
818Functions and methods that extend core crossfire objects. 2059 my $lock = cf::lock_acquire "map_data:" . $self->path;
819 2060
820=head3 cf::player 2061 return if $self->players;
2062 return if $self->in_memory != cf::MAP_IN_MEMORY;
2063 return if $self->{deny_save};
2064
2065 $self->clear;
2066 $self->in_memory (cf::MAP_SWAPPED);
2067}
2068
2069sub reset_at {
2070 my ($self) = @_;
2071
2072 # TODO: safety, remove and allow resettable per-player maps
2073 return 1e99 if $self->{deny_reset};
2074
2075 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2076 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2077
2078 $time + $to
2079}
2080
2081sub should_reset {
2082 my ($self) = @_;
2083
2084 $self->reset_at <= $cf::RUNTIME
2085}
2086
2087sub reset {
2088 my ($self) = @_;
2089
2090 my $lock = cf::lock_acquire "map_data:$self->{path}";
2091
2092 return if $self->players;
2093
2094 warn "resetting map ", $self->path;
2095
2096 $self->in_memory (cf::MAP_SWAPPED);
2097
2098 # need to save uniques path
2099 unless ($self->{deny_save}) {
2100 my $uniq = $self->uniq_path; utf8::encode $uniq;
2101
2102 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2103 if $uniq;
2104 }
2105
2106 delete $cf::MAP{$self->path};
2107
2108 $self->clear;
2109
2110 $_->clear_links_to ($self) for values %cf::MAP;
2111
2112 $self->unlink_save;
2113 $self->destroy;
2114}
2115
2116my $nuke_counter = "aaaa";
2117
2118sub nuke {
2119 my ($self) = @_;
2120
2121 delete $cf::MAP{$self->path};
2122
2123 $self->unlink_save;
2124
2125 bless $self, "cf::map";
2126 delete $self->{deny_reset};
2127 $self->{deny_save} = 1;
2128 $self->reset_timeout (1);
2129 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2130
2131 $cf::MAP{$self->path} = $self;
2132
2133 $self->reset; # polite request, might not happen
2134}
2135
2136=item $maps = cf::map::tmp_maps
2137
2138Returns an arrayref with all map paths of currently instantiated and saved
2139maps. May block.
2140
2141=cut
2142
2143sub tmp_maps() {
2144 [
2145 map {
2146 utf8::decode $_;
2147 /\.map$/
2148 ? normalise $_
2149 : ()
2150 } @{ aio_readdir $TMPDIR or [] }
2151 ]
2152}
2153
2154=item $maps = cf::map::random_maps
2155
2156Returns an arrayref with all map paths of currently instantiated and saved
2157random maps. May block.
2158
2159=cut
2160
2161sub random_maps() {
2162 [
2163 map {
2164 utf8::decode $_;
2165 /\.map$/
2166 ? normalise "?random/$_"
2167 : ()
2168 } @{ aio_readdir $RANDOMDIR or [] }
2169 ]
2170}
2171
2172=item cf::map::unique_maps
2173
2174Returns an arrayref of paths of all shared maps that have
2175instantiated unique items. May block.
2176
2177=cut
2178
2179sub unique_maps() {
2180 [
2181 map {
2182 utf8::decode $_;
2183 /\.map$/
2184 ? normalise $_
2185 : ()
2186 } @{ aio_readdir $UNIQUEDIR or [] }
2187 ]
2188}
2189
2190package cf;
2191
2192=back
2193
2194=head3 cf::object
2195
2196=cut
2197
2198package cf::object;
821 2199
822=over 4 2200=over 4
823 2201
824=item cf::player::exists $login 2202=item $ob->inv_recursive
825 2203
826Returns true when the given account exists. 2204Returns the inventory of the object _and_ their inventories, recursively.
827 2205
828=cut 2206=cut
829 2207
830sub cf::player::exists($) { 2208sub inv_recursive_;
831 cf::player::find $_[0] 2209sub inv_recursive_ {
832 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2210 map { $_, inv_recursive_ $_->inv } @_
833} 2211}
834 2212
835=item $player->ext_reply ($msgid, $msgtype, %msg) 2213sub inv_recursive {
836 2214 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} 2215}
2216
2217package cf;
848 2218
849=back 2219=back
850 2220
851=head3 cf::object::player 2221=head3 cf::object::player
852 2222
868 2238
869 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2239 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
870 2240
871 if ($self->{record_replies}) { 2241 if ($self->{record_replies}) {
872 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2242 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2243
873 } else { 2244 } else {
2245 my $pl = $self->contr;
2246
2247 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2248 my $dialog = $pl->{npc_dialog};
2249 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2250
2251 } else {
874 $msg = $npc->name . " says: $msg" if $npc; 2252 $msg = $npc->name . " says: $msg" if $npc;
875 $self->message ($msg, $flags); 2253 $self->message ($msg, $flags);
2254 }
876 } 2255 }
2256}
2257
2258=item $object->send_msg ($channel, $msg, $color, [extra...])
2259
2260=cut
2261
2262sub cf::object::send_msg {
2263 my $pl = shift->contr
2264 or return;
2265 $pl->send_msg (@_);
877} 2266}
878 2267
879=item $player_object->may ("access") 2268=item $player_object->may ("access")
880 2269
881Returns wether the given player is authorized to access resource "access" 2270Returns wether the given player is authorized to access resource "access"
890 (ref $cf::CFG{"may_$access"} 2279 (ref $cf::CFG{"may_$access"}
891 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2280 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
892 : $cf::CFG{"may_$access"}) 2281 : $cf::CFG{"may_$access"})
893} 2282}
894 2283
2284=item $player_object->enter_link
2285
2286Freezes the player and moves him/her to a special map (C<{link}>).
2287
2288The player should be reasonably safe there for short amounts of time. You
2289I<MUST> call C<leave_link> as soon as possible, though.
2290
2291Will never block.
2292
2293=item $player_object->leave_link ($map, $x, $y)
2294
2295Moves the player out of the special C<{link}> map onto the specified
2296map. If the map is not valid (or omitted), the player will be moved back
2297to the location he/she was before the call to C<enter_link>, or, if that
2298fails, to the emergency map position.
2299
2300Might block.
2301
2302=cut
2303
2304sub link_map {
2305 unless ($LINK_MAP) {
2306 $LINK_MAP = cf::map::find "{link}"
2307 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2308 $LINK_MAP->load;
2309 }
2310
2311 $LINK_MAP
2312}
2313
2314sub cf::object::player::enter_link {
2315 my ($self) = @_;
2316
2317 $self->deactivate_recursive;
2318
2319 return if UNIVERSAL::isa $self->map, "ext::map_link";
2320
2321 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2322 if $self->map && $self->map->{path} ne "{link}";
2323
2324 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2325}
2326
2327sub cf::object::player::leave_link {
2328 my ($self, $map, $x, $y) = @_;
2329
2330 return unless $self->contr->active;
2331
2332 my $link_pos = delete $self->{_link_pos};
2333
2334 unless ($map) {
2335 # restore original map position
2336 ($map, $x, $y) = @{ $link_pos || [] };
2337 $map = cf::map::find $map;
2338
2339 unless ($map) {
2340 ($map, $x, $y) = @$EMERGENCY_POSITION;
2341 $map = cf::map::find $map
2342 or die "FATAL: cannot load emergency map\n";
2343 }
2344 }
2345
2346 ($x, $y) = (-1, -1)
2347 unless (defined $x) && (defined $y);
2348
2349 # use -1 or undef as default coordinates, not 0, 0
2350 ($x, $y) = ($map->enter_x, $map->enter_y)
2351 if $x <=0 && $y <= 0;
2352
2353 $map->load;
2354 $map->load_diag;
2355
2356 return unless $self->contr->active;
2357 $self->activate_recursive;
2358
2359 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2360 $self->enter_map ($map, $x, $y);
2361}
2362
2363=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2364
2365Moves the player to the given map-path and coordinates by first freezing
2366her, loading and preparing them map, calling the provided $check callback
2367that has to return the map if sucecssful, and then unfreezes the player on
2368the new (success) or old (failed) map position. In either case, $done will
2369be called at the end of this process.
2370
2371=cut
2372
2373our $GOTOGEN;
2374
2375sub cf::object::player::goto {
2376 my ($self, $path, $x, $y, $check, $done) = @_;
2377
2378 # do generation counting so two concurrent goto's will be executed in-order
2379 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2380
2381 $self->enter_link;
2382
2383 (async {
2384 my $map = eval {
2385 my $map = cf::map::find $path;
2386
2387 if ($map) {
2388 $map = $map->customise_for ($self);
2389 $map = $check->($map) if $check && $map;
2390 } else {
2391 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2392 }
2393
2394 $map
2395 };
2396
2397 if ($@) {
2398 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2399 LOG llevError | logBacktrace, Carp::longmess $@;
2400 }
2401
2402 if ($gen == $self->{_goto_generation}) {
2403 delete $self->{_goto_generation};
2404 $self->leave_link ($map, $x, $y);
2405 }
2406
2407 $done->() if $done;
2408 })->prio (1);
2409}
2410
2411=item $player_object->enter_exit ($exit_object)
2412
2413=cut
2414
2415sub parse_random_map_params {
2416 my ($spec) = @_;
2417
2418 my $rmp = { # defaults
2419 xsize => (cf::rndm 15, 40),
2420 ysize => (cf::rndm 15, 40),
2421 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2422 #layout => string,
2423 };
2424
2425 for (split /\n/, $spec) {
2426 my ($k, $v) = split /\s+/, $_, 2;
2427
2428 $rmp->{lc $k} = $v if (length $k) && (length $v);
2429 }
2430
2431 $rmp
2432}
2433
2434sub prepare_random_map {
2435 my ($exit) = @_;
2436
2437 my $guard = cf::lock_acquire "exit_prepare:$exit";
2438
2439 # all this does is basically replace the /! path by
2440 # a new random map path (?random/...) with a seed
2441 # that depends on the exit object
2442
2443 my $rmp = parse_random_map_params $exit->msg;
2444
2445 if ($exit->map) {
2446 $rmp->{region} = $exit->region->name;
2447 $rmp->{origin_map} = $exit->map->path;
2448 $rmp->{origin_x} = $exit->x;
2449 $rmp->{origin_y} = $exit->y;
2450 }
2451
2452 $rmp->{random_seed} ||= $exit->random_seed;
2453
2454 my $data = cf::to_json $rmp;
2455 my $md5 = Digest::MD5::md5_hex $data;
2456 my $meta = "$RANDOMDIR/$md5.meta";
2457
2458 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2459 aio_write $fh, 0, (length $data), $data, 0;
2460 undef $fh;
2461 aio_rename "$meta~", $meta;
2462
2463 $exit->slaying ("?random/$md5");
2464 $exit->msg (undef);
2465 }
2466}
2467
2468sub cf::object::player::enter_exit {
2469 my ($self, $exit) = @_;
2470
2471 return unless $self->type == cf::PLAYER;
2472
2473 if ($exit->slaying eq "/!") {
2474 #TODO: this should de-fi-ni-te-ly not be a sync-job
2475 # the problem is that $exit might not survive long enough
2476 # so it needs to be done right now, right here
2477 cf::sync_job { prepare_random_map $exit };
2478 }
2479
2480 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2481 my $hp = $exit->stats->hp;
2482 my $sp = $exit->stats->sp;
2483
2484 $self->enter_link;
2485
2486 # if exit is damned, update players death & WoR home-position
2487 $self->contr->savebed ($slaying, $hp, $sp)
2488 if $exit->flag (FLAG_DAMNED);
2489
2490 (async {
2491 $self->deactivate_recursive; # just to be sure
2492 unless (eval {
2493 $self->goto ($slaying, $hp, $sp);
2494
2495 1;
2496 }) {
2497 $self->message ("Something went wrong deep within the crossfire server. "
2498 . "I'll try to bring you back to the map you were before. "
2499 . "Please report this to the dungeon master!",
2500 cf::NDI_UNIQUE | cf::NDI_RED);
2501
2502 warn "ERROR in enter_exit: $@";
2503 $self->leave_link;
2504 }
2505 })->prio (1);
2506}
2507
895=head3 cf::client 2508=head3 cf::client
896 2509
897=over 4 2510=over 4
898 2511
899=item $client->send_drawinfo ($text, $flags) 2512=item $client->send_drawinfo ($text, $flags)
905 2518
906sub cf::client::send_drawinfo { 2519sub cf::client::send_drawinfo {
907 my ($self, $text, $flags) = @_; 2520 my ($self, $text, $flags) = @_;
908 2521
909 utf8::encode $text; 2522 utf8::encode $text;
910 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2523 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
911} 2524}
912 2525
2526=item $client->send_msg ($channel, $msg, $color, [extra...])
2527
2528Send a drawinfo or msg packet to the client, formatting the msg for the
2529client if neccessary. C<$type> should be a string identifying the type of
2530the message, with C<log> being the default. If C<$color> is negative, suppress
2531the message unless the client supports the msg packet.
2532
2533=cut
2534
2535sub cf::client::send_msg {
2536 my ($self, $channel, $msg, $color, @extra) = @_;
2537
2538 $msg = $self->pl->expand_cfpod ($msg);
2539
2540 $color &= cf::NDI_CLIENT_MASK; # just in case...
2541
2542 if (ref $channel) {
2543 # send meta info to client, if not yet sent
2544 unless (exists $self->{channel}{$channel->{id}}) {
2545 $self->{channel}{$channel->{id}} = $channel;
2546 $self->ext_msg (channel_info => $channel);
2547 }
2548
2549 $channel = $channel->{id};
2550 }
2551
2552 return unless @extra || length $msg;
2553
2554 if ($self->can_msg) {
2555 # default colour, mask it out
2556 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2557 if $color & cf::NDI_DEF;
2558
2559 $self->send_packet ("msg " . $self->{json_coder}->encode (
2560 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2561 } else {
2562 if ($color >= 0) {
2563 # replace some tags by gcfclient-compatible ones
2564 for ($msg) {
2565 1 while
2566 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2567 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2568 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2569 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2570 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2571 }
2572
2573 $color &= cf::NDI_COLOR_MASK;
2574
2575 utf8::encode $msg;
2576
2577 if (0 && $msg =~ /\[/) {
2578 # COMMAND/INFO
2579 $self->send_packet ("drawextinfo $color 10 8 $msg")
2580 } else {
2581 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2582 $self->send_packet ("drawinfo $color $msg")
2583 }
2584 }
2585 }
2586}
2587
2588=item $client->ext_msg ($type, @msg)
2589
2590Sends an ext event to the client.
2591
2592=cut
2593
2594sub cf::client::ext_msg($$@) {
2595 my ($self, $type, @msg) = @_;
2596
2597 my $extcmd = $self->extcmd;
2598
2599 if ($extcmd == 2) {
2600 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2601 } elsif ($extcmd == 1) { # TODO: remove
2602 push @msg, msgtype => "event_$type";
2603 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2604 }
2605}
913 2606
914=item $success = $client->query ($flags, "text", \&cb) 2607=item $success = $client->query ($flags, "text", \&cb)
915 2608
916Queues a query to the client, calling the given callback with 2609Queues a query to the client, calling the given callback with
917the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2610the 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>. 2611C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
919 2612
920Queries can fail, so check the return code. Or don't, as queries will become 2613Queries can fail, so check the return code. Or don't, as queries will
921reliable at some point in the future. 2614become reliable at some point in the future.
922 2615
923=cut 2616=cut
924 2617
925sub cf::client::query { 2618sub cf::client::query {
926 my ($self, $flags, $text, $cb) = @_; 2619 my ($self, $flags, $text, $cb) = @_;
934 utf8::encode $text; 2627 utf8::encode $text;
935 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2628 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
936 2629
937 $self->send_packet ($self->{query_queue}[0][0]) 2630 $self->send_packet ($self->{query_queue}[0][0])
938 if @{ $self->{query_queue} } == 1; 2631 if @{ $self->{query_queue} } == 1;
2632
2633 1
939} 2634}
940 2635
941cf::client->attach ( 2636cf::client->attach (
2637 on_connect => sub {
2638 my ($ns) = @_;
2639
2640 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2641 },
942 on_reply => sub { 2642 on_reply => sub {
943 my ($ns, $msg) = @_; 2643 my ($ns, $msg) = @_;
944 2644
945 # this weird shuffling is so that direct followup queries 2645 # this weird shuffling is so that direct followup queries
946 # get handled first 2646 # get handled first
947 my $queue = delete $ns->{query_queue}; 2647 my $queue = delete $ns->{query_queue}
2648 or return; # be conservative, not sure how that can happen, but we saw a crash here
948 2649
949 (shift @$queue)->[1]->($msg); 2650 (shift @$queue)->[1]->($msg);
2651 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
950 2652
951 push @{ $ns->{query_queue} }, @$queue; 2653 push @{ $ns->{query_queue} }, @$queue;
952 2654
953 if (@{ $ns->{query_queue} } == @$queue) { 2655 if (@{ $ns->{query_queue} } == @$queue) {
954 if (@$queue) { 2656 if (@$queue) {
956 } else { 2658 } else {
957 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2659 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
958 } 2660 }
959 } 2661 }
960 }, 2662 },
2663 on_exticmd => sub {
2664 my ($ns, $buf) = @_;
2665
2666 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2667
2668 if (ref $msg) {
2669 my ($type, $reply, @payload) =
2670 "ARRAY" eq ref $msg
2671 ? @$msg
2672 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2673
2674 if (my $cb = $EXTICMD{$type}) {
2675 my @reply = $cb->($ns, @payload);
2676
2677 $ns->ext_reply ($reply, @reply)
2678 if $reply;
2679 }
2680 } else {
2681 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2682 }
2683
2684 cf::override;
2685 },
961); 2686);
962 2687
963=item $client->coro (\&cb) 2688=item $client->async (\&cb)
964 2689
965Create a new coroutine, running the specified callback. The coroutine will 2690Create a new coroutine, running the specified callback. The coroutine will
966be automatically cancelled when the client gets destroyed (e.g. on logout, 2691be automatically cancelled when the client gets destroyed (e.g. on logout,
967or loss of connection). 2692or loss of connection).
968 2693
969=cut 2694=cut
970 2695
971sub cf::client::coro { 2696sub cf::client::async {
972 my ($self, $cb) = @_; 2697 my ($self, $cb) = @_;
973 2698
974 my $coro; $coro = async { 2699 my $coro = &Coro::async ($cb);
975 eval {
976 $cb->();
977 };
978 warn $@ if $@;
979 };
980 2700
981 $coro->on_destroy (sub { 2701 $coro->on_destroy (sub {
982 delete $self->{_coro}{$coro+0}; 2702 delete $self->{_coro}{$coro+0};
983 }); 2703 });
984 2704
1011our $safe = new Safe "safe"; 2731our $safe = new Safe "safe";
1012our $safe_hole = new Safe::Hole; 2732our $safe_hole = new Safe::Hole;
1013 2733
1014$SIG{FPE} = 'IGNORE'; 2734$SIG{FPE} = 'IGNORE';
1015 2735
1016$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2736$safe->permit_only (Opcode::opset qw(
2737 :base_core :base_mem :base_orig :base_math
2738 grepstart grepwhile mapstart mapwhile
2739 sort time
2740));
1017 2741
1018# here we export the classes and methods available to script code 2742# here we export the classes and methods available to script code
1019 2743
1020=pod 2744=pod
1021 2745
1022The following fucntions and emthods are available within a safe environment: 2746The following functions and methods are available within a safe environment:
1023 2747
1024 cf::object contr pay_amount pay_player map 2748 cf::object
2749 contr pay_amount pay_player map x y force_find force_add
2750 insert remove name archname title slaying race
2751
1025 cf::object::player player 2752 cf::object::player
1026 cf::player peaceful 2753 player
1027 cf::map trigger 2754
2755 cf::player
2756 peaceful
2757
2758 cf::map
2759 trigger
1028 2760
1029=cut 2761=cut
1030 2762
1031for ( 2763for (
1032 ["cf::object" => qw(contr pay_amount pay_player map)], 2764 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2765 insert remove inv name archname title slaying race)],
1033 ["cf::object::player" => qw(player)], 2766 ["cf::object::player" => qw(player)],
1034 ["cf::player" => qw(peaceful)], 2767 ["cf::player" => qw(peaceful)],
1035 ["cf::map" => qw(trigger)], 2768 ["cf::map" => qw(trigger)],
1036) { 2769) {
1037 no strict 'refs'; 2770 no strict 'refs';
1108=back 2841=back
1109 2842
1110=cut 2843=cut
1111 2844
1112############################################################################# 2845#############################################################################
2846# the server's init and main functions
1113 2847
1114=head2 EXTENSION DATABASE SUPPORT 2848sub load_facedata($) {
2849 my ($path) = @_;
1115 2850
1116Crossfire maintains a very simple database for extension use. It can 2851 warn "loading facedata from $path\n";
1117currently store anything that can be serialised using Storable, which
1118excludes objects.
1119 2852
1120The parameter C<$family> should best start with the name of the extension 2853 my $facedata;
1121using it, it should be unique. 2854 0 < aio_load $path, $facedata
2855 or die "$path: $!";
1122 2856
1123=over 4 2857 $facedata = Coro::Storable::thaw $facedata;
1124 2858
1125=item $hashref = cf::db_get $family 2859 $facedata->{version} == 2
2860 or cf::cleanup "$path: version mismatch, cannot proceed.";
1126 2861
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 } 2862 {
2863 my $faces = $facedata->{faceinfo};
1164 2864
1165 my $pid; 2865 while (my ($face, $info) = each %$faces) {
2866 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2867 cf::face::set_visibility $idx, $info->{visibility};
2868 cf::face::set_magicmap $idx, $info->{magicmap};
2869 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2870 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1166 2871
1167 sub db_save() { 2872 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 }, 2873 }
1214 );
1215}
1216 2874
1217############################################################################# 2875 while (my ($face, $info) = each %$faces) {
1218# the server's main() 2876 next unless $info->{smooth};
2877 my $idx = cf::face::find $face
2878 or next;
2879 if (my $smooth = cf::face::find $info->{smooth}) {
2880 cf::face::set_smooth $idx, $smooth;
2881 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2882 } else {
2883 warn "smooth face '$info->{smooth}' not found for face '$face'";
2884 }
2885
2886 cf::cede_to_tick;
2887 }
2888 }
2889
2890 {
2891 my $anims = $facedata->{animinfo};
2892
2893 while (my ($anim, $info) = each %$anims) {
2894 cf::anim::set $anim, $info->{frames}, $info->{facings};
2895 cf::cede_to_tick;
2896 }
2897
2898 cf::anim::invalidate_all; # d'oh
2899 }
2900
2901 {
2902 # TODO: for gcfclient pleasure, we should give resources
2903 # that gcfclient doesn't grok a >10000 face index.
2904 my $res = $facedata->{resource};
2905 my $enc = JSON::XS->new->utf8->canonical;
2906
2907 my $soundconf = delete $res->{"res/sound.conf"};
2908
2909 while (my ($name, $info) = each %$res) {
2910 my $meta = $enc->encode ({
2911 name => $name,
2912 %{ $info->{meta} || {} },
2913 });
2914
2915 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2916
2917 if ($info->{type} & 1) {
2918 # prepend meta info
2919
2920 my $data = pack "(w/a*)*", $meta, $info->{data};
2921 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2922
2923 cf::face::set_data $idx, 0, $data, $chk;
2924 } else {
2925 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2926 }
2927
2928 cf::face::set_type $idx, $info->{type};
2929
2930 cf::cede_to_tick;
2931 }
2932
2933 if ($soundconf) {
2934 $soundconf = $enc->decode (delete $soundconf->{data});
2935
2936 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2937 my $sound = $soundconf->{compat}[$_]
2938 or next;
2939
2940 my $face = cf::face::find "sound/$sound->[1]";
2941 cf::sound::set $sound->[0] => $face;
2942 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2943 }
2944
2945 while (my ($k, $v) = each %{$soundconf->{event}}) {
2946 my $face = cf::face::find "sound/$v";
2947 cf::sound::set $k => $face;
2948 }
2949 }
2950 }
2951
2952 1
2953}
2954
2955register_exticmd fx_want => sub {
2956 my ($ns, $want) = @_;
2957
2958 while (my ($k, $v) = each %$want) {
2959 $ns->fx_want ($k, $v);
2960 }
2961};
2962
2963sub reload_regions {
2964 load_resource_file "$MAPDIR/regions"
2965 or die "unable to load regions file\n";
2966
2967 for (cf::region::list) {
2968 $_->{match} = qr/$_->{match}/
2969 if exists $_->{match};
2970 }
2971}
2972
2973sub reload_facedata {
2974 load_facedata "$DATADIR/facedata"
2975 or die "unable to load facedata\n";
2976}
2977
2978sub reload_archetypes {
2979 load_resource_file "$DATADIR/archetypes"
2980 or die "unable to load archetypes\n";
2981 #d# NEED to laod twice to resolve forward references
2982 # this really needs to be done in an extra post-pass
2983 # (which needs to be synchronous, so solve it differently)
2984 load_resource_file "$DATADIR/archetypes"
2985 or die "unable to load archetypes\n";
2986}
2987
2988sub reload_treasures {
2989 load_resource_file "$DATADIR/treasures"
2990 or die "unable to load treasurelists\n";
2991}
2992
2993sub reload_resources {
2994 warn "reloading resource files...\n";
2995
2996 reload_regions;
2997 reload_facedata;
2998 #reload_archetypes;#d#
2999 reload_archetypes;
3000 reload_treasures;
3001
3002 warn "finished reloading resource files\n";
3003}
3004
3005sub init {
3006 reload_resources;
3007}
1219 3008
1220sub cfg_load { 3009sub cfg_load {
1221 open my $fh, "<:utf8", cf::confdir . "/config" 3010 open my $fh, "<:utf8", "$CONFDIR/config"
1222 or return; 3011 or return;
1223 3012
1224 local $/; 3013 local $/;
1225 *CFG = YAML::Syck::Load <$fh>; 3014 *CFG = YAML::Syck::Load <$fh>;
3015
3016 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3017
3018 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3019 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3020
3021 if (exists $CFG{mlockall}) {
3022 eval {
3023 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3024 and die "WARNING: m(un)lockall failed: $!\n";
3025 };
3026 warn $@ if $@;
3027 }
1226} 3028}
1227 3029
1228sub main { 3030sub main {
3031 # we must not ever block the main coroutine
3032 local $Coro::idle = sub {
3033 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3034 (async {
3035 Event::one_event;
3036 })->prio (Coro::PRIO_MAX);
3037 };
3038
1229 cfg_load; 3039 cfg_load;
1230 db_load; 3040 db_init;
1231 load_extensions; 3041 load_extensions;
3042
3043 $TICK_WATCHER->start;
1232 Event::loop; 3044 Event::loop;
1233} 3045}
1234 3046
1235############################################################################# 3047#############################################################################
1236# initialisation 3048# initialisation and cleanup
1237 3049
1238sub _perl_reload() { 3050# install some emergency cleanup handlers
3051BEGIN {
3052 for my $signal (qw(INT HUP TERM)) {
3053 Event->signal (
3054 reentrant => 0,
3055 data => WF_AUTOCANCEL,
3056 signal => $signal,
3057 prio => 0,
3058 cb => sub {
3059 cf::cleanup "SIG$signal";
3060 },
3061 );
3062 }
3063}
3064
3065sub write_runtime {
3066 my $runtime = "$LOCALDIR/runtime";
3067
3068 # first touch the runtime file to show we are still running:
3069 # the fsync below can take a very very long time.
3070
3071 IO::AIO::aio_utime $runtime, undef, undef;
3072
3073 my $guard = cf::lock_acquire "write_runtime";
3074
3075 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3076 or return;
3077
3078 my $value = $cf::RUNTIME + 90 + 10;
3079 # 10 is the runtime save interval, for a monotonic clock
3080 # 60 allows for the watchdog to kill the server.
3081
3082 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3083 and return;
3084
3085 # always fsync - this file is important
3086 aio_fsync $fh
3087 and return;
3088
3089 # touch it again to show we are up-to-date
3090 aio_utime $fh, undef, undef;
3091
3092 close $fh
3093 or return;
3094
3095 aio_rename "$runtime~", $runtime
3096 and return;
3097
3098 warn "runtime file written.\n";
3099
3100 1
3101}
3102
3103sub emergency_save() {
3104 my $freeze_guard = cf::freeze_mainloop;
3105
3106 warn "enter emergency perl save\n";
3107
3108 cf::sync_job {
3109 # use a peculiar iteration method to avoid tripping on perl
3110 # refcount bugs in for. also avoids problems with players
3111 # and maps saved/destroyed asynchronously.
3112 warn "begin emergency player save\n";
3113 for my $login (keys %cf::PLAYER) {
3114 my $pl = $cf::PLAYER{$login} or next;
3115 $pl->valid or next;
3116 $pl->save;
3117 }
3118 warn "end emergency player save\n";
3119
3120 warn "begin emergency map save\n";
3121 for my $path (keys %cf::MAP) {
3122 my $map = $cf::MAP{$path} or next;
3123 $map->valid or next;
3124 $map->save;
3125 }
3126 warn "end emergency map save\n";
3127
3128 warn "begin emergency database checkpoint\n";
3129 BDB::db_env_txn_checkpoint $DB_ENV;
3130 warn "end emergency database checkpoint\n";
3131 };
3132
3133 warn "leave emergency perl save\n";
3134}
3135
3136sub post_cleanup {
3137 my ($make_core) = @_;
3138
3139 warn Carp::longmess "post_cleanup backtrace"
3140 if $make_core;
3141}
3142
3143sub do_reload_perl() {
3144 # can/must only be called in main
3145 if ($Coro::current != $Coro::main) {
3146 warn "can only reload from main coroutine";
3147 return;
3148 }
3149
1239 warn "reloading..."; 3150 warn "reloading...";
1240 3151
1241 eval { 3152 warn "entering sync_job";
1242 local $FREEZE = 1;
1243 3153
3154 cf::sync_job {
3155 cf::write_runtime; # external watchdog should not bark
1244 cf::emergency_save; 3156 cf::emergency_save;
3157 cf::write_runtime; # external watchdog should not bark
1245 3158
1246 # cancel all watchers 3159 warn "syncing database to disk";
3160 BDB::db_env_txn_checkpoint $DB_ENV;
3161
3162 # if anything goes wrong in here, we should simply crash as we already saved
3163
3164 warn "cancelling all WF_AUTOCANCEL watchers";
1247 for (Event::all_watchers) { 3165 for (Event::all_watchers) {
1248 $_->cancel if $_->data & WF_AUTOCANCEL; 3166 $_->cancel if $_->data & WF_AUTOCANCEL;
1249 } 3167 }
1250 3168
3169 warn "flushing outstanding aio requests";
3170 for (;;) {
3171 BDB::flush;
3172 IO::AIO::flush;
3173 Coro::cede;
3174 last unless IO::AIO::nreqs || BDB::nreqs;
3175 warn "iterate...";
3176 }
3177
3178 ++$RELOAD;
3179
1251 # cancel all extension coros 3180 warn "cancelling all extension coros";
1252 $_->cancel for values %EXT_CORO; 3181 $_->cancel for values %EXT_CORO;
1253 %EXT_CORO = (); 3182 %EXT_CORO = ();
1254 3183
1255 # unload all extensions 3184 warn "removing commands";
1256 for (@exts) { 3185 %COMMAND = ();
3186
3187 warn "removing ext/exti commands";
3188 %EXTCMD = ();
3189 %EXTICMD = ();
3190
3191 warn "unloading/nuking all extensions";
3192 for my $pkg (@EXTS) {
1257 warn "unloading <$_>"; 3193 warn "... unloading $pkg";
1258 unload_extension $_; 3194
3195 if (my $cb = $pkg->can ("unload")) {
3196 eval {
3197 $cb->($pkg);
3198 1
3199 } or warn "$pkg unloaded, but with errors: $@";
1259 } 3200 }
1260 3201
3202 warn "... nuking $pkg";
3203 Symbol::delete_package $pkg;
3204 }
3205
1261 # unload all modules loaded from $LIBDIR 3206 warn "unloading all perl modules loaded from $LIBDIR";
1262 while (my ($k, $v) = each %INC) { 3207 while (my ($k, $v) = each %INC) {
1263 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3208 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1264 3209
1265 warn "removing <$k>"; 3210 warn "... unloading $k";
1266 delete $INC{$k}; 3211 delete $INC{$k};
1267 3212
1268 $k =~ s/\.pm$//; 3213 $k =~ s/\.pm$//;
1269 $k =~ s/\//::/g; 3214 $k =~ s/\//::/g;
1270 3215
1273 } 3218 }
1274 3219
1275 Symbol::delete_package $k; 3220 Symbol::delete_package $k;
1276 } 3221 }
1277 3222
1278 # sync database to disk
1279 cf::db_sync;
1280 IO::AIO::flush;
1281
1282 # get rid of safe::, as good as possible 3223 warn "getting rid of safe::, as good as possible";
1283 Symbol::delete_package "safe::$_" 3224 Symbol::delete_package "safe::$_"
1284 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3225 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1285 3226
1286 # remove register_script_function callbacks
1287 # TODO
1288
1289 # unload cf.pm "a bit" 3227 warn "unloading cf.pm \"a bit\"";
1290 delete $INC{"cf.pm"}; 3228 delete $INC{"cf.pm"};
3229 delete $INC{"cf/pod.pm"};
1291 3230
1292 # don't, removes xs symbols, too, 3231 # don't, removes xs symbols, too,
1293 # and global variables created in xs 3232 # and global variables created in xs
1294 #Symbol::delete_package __PACKAGE__; 3233 #Symbol::delete_package __PACKAGE__;
1295 3234
1296 # reload cf.pm 3235 warn "unload completed, starting to reload now";
3236
1297 warn "reloading cf.pm"; 3237 warn "reloading cf.pm";
1298 require cf; 3238 require cf;
1299 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3239 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1300 3240
1301 # load config and database again 3241 warn "loading config and database again";
1302 cf::cfg_load; 3242 cf::cfg_load;
1303 cf::db_load;
1304 3243
1305 # load extensions
1306 warn "load extensions"; 3244 warn "loading extensions";
1307 cf::load_extensions; 3245 cf::load_extensions;
1308 3246
1309 # reattach attachments to objects 3247 warn "reattaching attachments to objects/players";
1310 warn "reattach"; 3248 _global_reattach; # objects, sockets
1311 _global_reattach; 3249 warn "reattaching attachments to maps";
3250 reattach $_ for values %MAP;
3251 warn "reattaching attachments to players";
3252 reattach $_ for values %PLAYER;
3253
3254 warn "leaving sync_job";
3255
3256 1
3257 } or do {
3258 warn $@;
3259 warn "error while reloading, exiting.";
3260 exit 1;
1312 }; 3261 };
1313 warn $@ if $@;
1314 3262
1315 warn "reloaded"; 3263 warn "reloaded";
1316}; 3264};
1317 3265
1318sub perl_reload() { 3266our $RELOAD_WATCHER; # used only during reload
1319 _perl_reload;
1320}
1321 3267
1322register "<global>", __PACKAGE__; 3268sub reload_perl() {
3269 # doing reload synchronously and two reloads happen back-to-back,
3270 # coro crashes during coro_state_free->destroy here.
1323 3271
3272 $RELOAD_WATCHER ||= Event->timer (
3273 reentrant => 0,
3274 after => 0,
3275 data => WF_AUTOCANCEL,
3276 cb => sub {
3277 do_reload_perl;
3278 undef $RELOAD_WATCHER;
3279 },
3280 );
3281}
3282
1324register_command "perl-reload" => sub { 3283register_command "reload" => sub {
1325 my ($who, $arg) = @_; 3284 my ($who, $arg) = @_;
1326 3285
1327 if ($who->flag (FLAG_WIZ)) { 3286 if ($who->flag (FLAG_WIZ)) {
1328 $who->message ("reloading..."); 3287 $who->message ("reloading server.");
1329 _perl_reload; 3288 async { reload_perl };
1330 } 3289 }
1331}; 3290};
1332 3291
1333unshift @INC, $LIBDIR; 3292unshift @INC, $LIBDIR;
1334 3293
3294my $bug_warning = 0;
3295
3296our @WAIT_FOR_TICK;
3297our @WAIT_FOR_TICK_BEGIN;
3298
3299sub wait_for_tick {
3300 return unless $TICK_WATCHER->is_active;
3301 return if $Coro::current == $Coro::main;
3302
3303 my $signal = new Coro::Signal;
3304 push @WAIT_FOR_TICK, $signal;
3305 $signal->wait;
3306}
3307
3308sub wait_for_tick_begin {
3309 return unless $TICK_WATCHER->is_active;
3310 return if $Coro::current == $Coro::main;
3311
3312 my $signal = new Coro::Signal;
3313 push @WAIT_FOR_TICK_BEGIN, $signal;
3314 $signal->wait;
3315}
3316
3317 my $min = 1e6;#d#
3318 my $avg = 10;
1335$TICK_WATCHER = Event->timer ( 3319$TICK_WATCHER = Event->timer (
1336 reentrant => 0, 3320 reentrant => 0,
3321 parked => 1,
1337 prio => 0, 3322 prio => 0,
1338 at => $NEXT_TICK || $TICK, 3323 at => $NEXT_TICK || $TICK,
1339 data => WF_AUTOCANCEL, 3324 data => WF_AUTOCANCEL,
1340 cb => sub { 3325 cb => sub {
1341 unless ($FREEZE) { 3326 if ($Coro::current != $Coro::main) {
3327 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3328 unless ++$bug_warning > 10;
3329 return;
3330 }
3331
3332 $NOW = $tick_start = Event::time;
3333
1342 cf::server_tick; # one server iteration 3334 cf::server_tick; # one server iteration
1343 $RUNTIME += $TICK; 3335
3336 0 && sync_job {#d#
3337 for(1..10) {
3338 my $t = Event::time;
3339 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3340 or die;
3341
3342 $map->width (50);
3343 $map->height (50);
3344 $map->alloc;
3345 $map->_load_objects ("/tmp/x.map", 1);
3346 my $t = Event::time - $t;
3347
3348 #next unless $t < 0.0013;#d#
3349 if ($t < $min) {
3350 $min = $t;
3351 }
3352 $avg = $avg * 0.99 + $t * 0.01;
3353 }
3354 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3355 exit 0;
3356 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1344 } 3357 };
1345 3358
3359 $RUNTIME += $TICK;
1346 $NEXT_TICK += $TICK; 3360 $NEXT_TICK += $TICK;
1347 3361
3362 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3363 $NEXT_RUNTIME_WRITE = $NOW + 10;
3364 Coro::async_pool {
3365 write_runtime
3366 or warn "ERROR: unable to write runtime file: $!";
3367 };
3368 }
3369
3370# my $AFTER = Event::time;
3371# warn $AFTER - $NOW;#d#
3372
3373 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3374 $sig->send;
3375 }
3376 while (my $sig = shift @WAIT_FOR_TICK) {
3377 $sig->send;
3378 }
3379
3380 $NOW = Event::time;
3381
1348 # if we are delayed by four ticks or more, skip them all 3382 # if we are delayed by four ticks or more, skip them all
1349 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3383 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1350 3384
1351 $TICK_WATCHER->at ($NEXT_TICK); 3385 $TICK_WATCHER->at ($NEXT_TICK);
1352 $TICK_WATCHER->start; 3386 $TICK_WATCHER->start;
3387
3388 $LOAD = ($NOW - $tick_start) / $TICK;
3389 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3390
3391 _post_tick;
3392
3393
1353 }, 3394 },
1354); 3395);
1355 3396
3397{
3398 BDB::max_poll_time $TICK * 0.1;
3399 $BDB_POLL_WATCHER = Event->io (
3400 reentrant => 0,
3401 fd => BDB::poll_fileno,
3402 poll => 'r',
3403 prio => 0,
3404 data => WF_AUTOCANCEL,
3405 cb => \&BDB::poll_cb,
3406 );
3407 BDB::min_parallel 8;
3408
3409 BDB::set_sync_prepare {
3410 my $status;
3411 my $current = $Coro::current;
3412 (
3413 sub {
3414 $status = $!;
3415 $current->ready; undef $current;
3416 },
3417 sub {
3418 Coro::schedule while defined $current;
3419 $! = $status;
3420 },
3421 )
3422 };
3423
3424 unless ($DB_ENV) {
3425 $DB_ENV = BDB::db_env_create;
3426
3427 cf::sync_job {
3428 eval {
3429 BDB::db_env_open
3430 $DB_ENV,
3431 $BDBDIR,
3432 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3433 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3434 0666;
3435
3436 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3437
3438 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3439 $DB_ENV->set_lk_detect;
3440 };
3441
3442 cf::cleanup "db_env_open(db): $@" if $@;
3443 };
3444 }
3445}
3446
3447{
3448 IO::AIO::min_parallel 8;
3449
3450 undef $Coro::AIO::WATCHER;
1356IO::AIO::max_poll_time $TICK * 0.2; 3451 IO::AIO::max_poll_time $TICK * 0.1;
1357 3452 $AIO_POLL_WATCHER = Event->io (
1358Event->io (fd => IO::AIO::poll_fileno, 3453 reentrant => 0,
1359 poll => 'r',
1360 prio => 5,
1361 data => WF_AUTOCANCEL, 3454 data => WF_AUTOCANCEL,
3455 fd => IO::AIO::poll_fileno,
3456 poll => 'r',
3457 prio => 6,
1362 cb => \&IO::AIO::poll_cb); 3458 cb => \&IO::AIO::poll_cb,
3459 );
3460}
1363 3461
1364# we must not ever block the main coroutine 3462my $_log_backtrace;
1365$Coro::idle = sub { 3463
1366 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3464sub _log_backtrace {
1367 warn "FATAL: Coro::idle was called, major BUG\n"; 3465 my ($msg, @addr) = @_;
1368 (Coro::unblock_sub { 3466
1369 Event::one_event; 3467 $msg =~ s/\n//;
1370 })->(); 3468
1371}; 3469 # limit the # of concurrent backtraces
3470 if ($_log_backtrace < 2) {
3471 ++$_log_backtrace;
3472 async {
3473 my @bt = fork_call {
3474 @addr = map { sprintf "%x", $_ } @addr;
3475 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3476 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3477 or die "addr2line: $!";
3478
3479 my @funcs;
3480 my @res = <$fh>;
3481 chomp for @res;
3482 while (@res) {
3483 my ($func, $line) = splice @res, 0, 2, ();
3484 push @funcs, "[$func] $line";
3485 }
3486
3487 @funcs
3488 };
3489
3490 LOG llevInfo, "[ABT] $msg\n";
3491 LOG llevInfo, "[ABT] $_\n" for @bt;
3492 --$_log_backtrace;
3493 };
3494 } else {
3495 LOG llevInfo, "[ABT] $msg\n";
3496 LOG llevInfo, "[ABT] [suppressed]\n";
3497 }
3498}
3499
3500# load additional modules
3501use cf::pod;
3502
3503END { cf::emergency_save }
1372 3504
13731 35051
1374 3506

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines