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.231 by root, Wed Apr 4 00:02:06 2007 UTC vs.
Revision 1.314 by root, Mon Jul 23 16:53:15 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;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.52 (); 15use Coro 3.61 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
21 24
25use JSON::XS 1.4 ();
22use BDB (); 26use BDB ();
23use Data::Dumper; 27use Data::Dumper;
24use Digest::MD5; 28use Digest::MD5;
25use Fcntl; 29use Fcntl;
26use YAML::Syck (); 30use YAML::Syck ();
27use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
28use Time::HiRes; 32use Time::HiRes;
29use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
30 35
31# configure various modules to our taste 36# configure various modules to our taste
32# 37#
38$Storable::canonical = 1; # reduce rsync transfers
33Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
34Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35 41
36$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
37 43
45our %COMMAND = (); 51our %COMMAND = ();
46our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
47 53
48our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
49our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
50our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
52 59
53our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
54our @EVENT; 61our @EVENT;
55our $LIBDIR = datadir . "/ext";
56 62
57our $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(!)
58our $TICK_WATCHER; 76our $TICK_WATCHER;
59our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 79our $NEXT_TICK;
62our $NOW; 80our $NOW;
71our $RUNTIME; 89our $RUNTIME;
72 90
73our %PLAYER; # all users 91our %PLAYER; # all users
74our %MAP; # all maps 92our %MAP; # all maps
75our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 94
82# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 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
101
85binmode STDOUT; 102binmode STDOUT;
86binmode STDERR; 103binmode STDERR;
87 104
88# read virtual server time, if available 105# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
91 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
92 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
93} 110}
94 111
95mkdir cf::localdir; 112mkdir $_
96mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97mkdir cf::localdir . "/" . cf::tmpdir;
98mkdir cf::localdir . "/" . cf::uniquedir;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 114
102our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
103 116
104sub cf::map::normalise; 117sub cf::map::normalise;
105 118
116=item $cf::RUNTIME 129=item $cf::RUNTIME
117 130
118The 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
119every server tick. 132every server tick.
120 133
121=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
122 137
123The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
124be 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.
125 142
126=item $cf::NOW 143=item $cf::NOW
127 144
128The time of the last (current) server tick. 145The time of the last (current) server tick.
129 146
130=item $cf::TICK 147=item $cf::TICK
131 148
132The 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.
133 160
134=item %cf::CFG 161=item %cf::CFG
135 162
136Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
137from wherever your confdir points to. 164from wherever your confdir points to.
138 165
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
140 167
141These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
142or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
143processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
144window of cpu time available, or simply to synchronise to the server tick. 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.
145 177
146=back 178=back
147 179
148=cut 180=cut
149 181
150BEGIN { 182BEGIN {
151 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
152 my $msg = join "", @_; 184 my $msg = join "", @_;
153 utf8::encode $msg;
154 185
155 $msg .= "\n" 186 $msg .= "\n"
156 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
157 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
158 LOG llevError, $msg; 192 LOG llevError, $msg;
159 }; 193 };
160} 194}
161 195
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@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';
167@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)
168 203
169# 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
170# within the Safe compartment. 205# within the Safe compartment.
171for my $pkg (qw( 206for my $pkg (qw(
172 cf::global cf::attachable 207 cf::global cf::attachable
180} 215}
181 216
182$Event::DIED = sub { 217$Event::DIED = sub {
183 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
184}; 219};
220
221#############################################################################
185 222
186=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
187 224
188=over 4 225=over 4
189 226
208 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
209 $d 246 $d
210 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
211} 248}
212 249
213use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
216 251
217Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
218 253
219=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
220 255
221Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
222 264
223=item cf::lock_wait $string 265=item cf::lock_wait $string
224 266
225Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
226 268
232returned. 274returned.
233 275
234Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
235uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
236 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
237=cut 283=cut
238 284
239our %LOCK; 285our %LOCK;
240 286
241sub lock_wait($) { 287sub lock_wait($) {
258 304
259 Coro::guard { 305 Coro::guard {
260 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
262 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
263} 315}
264 316
265sub freeze_mainloop { 317sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
267 319
270 }; 322 };
271 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
272 $guard 324 $guard
273} 325}
274 326
327=item cf::get_slot $time[, $priority]
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
333Useful for short background jobs.
334
335=cut
336
337our @SLOT_QUEUE;
338our $SLOT_QUEUE;
339
340$SLOT_QUEUE->cancel if $SLOT_QUEUE;
341$SLOT_QUEUE = Coro::async {
342 my $signal = new Coro::Signal;
343
344 while () {
345 next_job:
346 my $avail = cf::till_tick;
347 if ($avail > 0.01) {
348 for (0 .. $#SLOT_QUEUE) {
349 if ($SLOT_QUEUE[$_][0] < $avail) {
350 my $job = splice @SLOT_QUEUE, $_, 1, ();
351 $job->[2]->send;
352 Coro::cede;
353 goto next_job;
354 }
355 }
356 }
357
358 if (@SLOT_QUEUE) {
359 # we do not use wait_For_tick() as it returns immediately when tick is inactive
360 push @cf::WAIT_FOR_TICK, $signal;
361 $signal->wait;
362 } else {
363 Coro::schedule;
364 }
365 }
366};
367
368sub get_slot($;$) {
369 my ($time, $pri) = @_;
370
371 push @SLOT_QUEUE, [$time, $pri, my $sig = new Coro::Signal];
372 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
373 $SLOT_QUEUE->ready;
374 $sig->wait;
375}
376
275=item cf::async { BLOCK } 377=item cf::async { BLOCK }
276 378
277Currently the same as Coro::async_pool, meaning you cannot use 379Currently the same as Coro::async_pool, meaning you cannot use
278C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 380C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
279thing you are allowed to do is call C<prio> on it. 381thing you are allowed to do is call C<prio> on it.
282 384
283BEGIN { *async = \&Coro::async_pool } 385BEGIN { *async = \&Coro::async_pool }
284 386
285=item cf::sync_job { BLOCK } 387=item cf::sync_job { BLOCK }
286 388
287The design of crossfire+ requires that the main coro ($Coro::main) is 389The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 390is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 391partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
392acceptable.
290 393
291If it must be done, put the blocking parts into C<sync_job>. This will run 394If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 395the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 396server will be frozen during this time, so the block should either finish
294fast or be very important. 397fast or be very important.
297 400
298sub sync_job(&) { 401sub sync_job(&) {
299 my ($job) = @_; 402 my ($job) = @_;
300 403
301 if ($Coro::current == $Coro::main) { 404 if ($Coro::current == $Coro::main) {
405 my $time = Event::time;
406
302 # this is the main coro, too bad, we have to block 407 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 408 # till the operation succeeds, freezing the server :/
304 409
305 # TODO: use suspend/resume instead 410 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 411 # (but this is cancel-safe)
317 422
318 while ($busy) { 423 while ($busy) {
319 Coro::cede or Event::one_event; 424 Coro::cede or Event::one_event;
320 } 425 }
321 426
427 $time = Event::time - $time;
428
429 LOG llevError | logBacktrace, Carp::longmess "long sync job"
430 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
431
432 $tick_start += $time; # do not account sync jobs to server load
433
322 wantarray ? @res : $res[0] 434 wantarray ? @res : $res[0]
323 } else { 435 } else {
324 # we are in another coroutine, how wonderful, everything just works 436 # we are in another coroutine, how wonderful, everything just works
325 437
326 $job->() 438 $job->()
345 $EXT_CORO{$coro+0} = $coro; 457 $EXT_CORO{$coro+0} = $coro;
346 458
347 $coro 459 $coro
348} 460}
349 461
350sub write_runtime { 462=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 463
353 my $runtime = cf::localdir . "/runtime"; 464Executes the given code block with the given arguments in a seperate
465process, returning the results. Everything must be serialisable with
466Coro::Storable. May, of course, block. Note that the executed sub may
467never block itself or use any form of Event handling.
354 468
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 469=cut
356 or return;
357 470
358 my $value = $cf::RUNTIME + 90 + 10; 471sub _store_scalar {
359 # 10 is the runtime save interval, for a monotonic clock 472 open my $fh, ">", \my $buf
360 # 60 allows for the watchdog to kill the server. 473 or die "fork_call: cannot open fh-to-buf in child : $!";
361 474 Storable::store_fd $_[0], $fh;
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0
363 and return;
364
365 # always fsync - this file is important
366 aio_fsync $fh
367 and return;
368
369 close $fh 475 close $fh;
370 or return;
371 476
372 aio_rename "$runtime~", $runtime 477 $buf
373 and return; 478}
374 479
480sub fork_call(&@) {
481 my ($cb, @args) = @_;
482
483# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
484# or die "socketpair: $!";
485 pipe my $fh1, my $fh2
486 or die "pipe: $!";
487
488 if (my $pid = fork) {
489 close $fh2;
490
491 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
492 warn "pst<$res>" unless $res =~ /^pst/;
493 $res = Coro::Storable::thaw $res;
494
495 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
496
497 Carp::confess $$res unless "ARRAY" eq ref $res;
498
499 return wantarray ? @$res : $res->[-1];
500 } else {
501 reset_signals;
502 local $SIG{__WARN__};
503 local $SIG{__DIE__};
504 # just in case, this hack effectively disables event
505 # in the child. cleaner and slower would be canceling all watchers,
506 # but this works for the time being.
507 local $Coro::idle;
508 $Coro::current->prio (Coro::PRIO_MAX);
509
510 eval {
511 close $fh1;
512
513 my @res = eval { $cb->(@args) };
514
515 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
516 close $fh2;
517 };
518
519 warn $@ if $@;
520 _exit 0;
375 1 521 }
522}
523
524=item $value = cf::db_get $family => $key
525
526Returns a single value from the environment database.
527
528=item cf::db_put $family => $key => $value
529
530Stores the given C<$value> in the family. It can currently store binary
531data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
532
533=cut
534
535our $DB;
536
537sub db_init {
538 unless ($DB) {
539 $DB = BDB::db_create $DB_ENV;
540
541 cf::sync_job {
542 eval {
543 $DB->set_flags (BDB::CHKSUM);
544
545 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
546 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
547 cf::cleanup "db_open(db): $!" if $!;
548 };
549 cf::cleanup "db_open(db): $@" if $@;
550 };
551 }
552}
553
554sub db_get($$) {
555 my $key = "$_[0]/$_[1]";
556
557 cf::sync_job {
558 BDB::db_get $DB, undef, $key, my $data;
559
560 $! ? ()
561 : $data
562 }
563}
564
565sub db_put($$$) {
566 BDB::dbreq_pri 4;
567 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
568}
569
570=item cf::cache $id => [$paths...], $processversion => $process
571
572Generic caching function that returns the value of the resource $id,
573caching and regenerating as required.
574
575This function can block.
576
577=cut
578
579sub cache {
580 my ($id, $src, $processversion, $process) = @_;
581
582 my $meta =
583 join "\x00",
584 $processversion,
585 map {
586 aio_stat $_
587 and Carp::croak "$_: $!";
588
589 ($_, (stat _)[7,9])
590 } @$src;
591
592 my $dbmeta = db_get cache => "$id/meta";
593 if ($dbmeta ne $meta) {
594 # changed, we may need to process
595
596 my @data;
597 my $md5;
598
599 for (0 .. $#$src) {
600 0 <= aio_load $src->[$_], $data[$_]
601 or Carp::croak "$src->[$_]: $!";
602 }
603
604 # if processing is expensive, check
605 # checksum first
606 if (1) {
607 $md5 =
608 join "\x00",
609 $processversion,
610 map {
611 Coro::cede;
612 ($src->[$_], Digest::MD5::md5_hex $data[$_])
613 } 0.. $#$src;
614
615
616 my $dbmd5 = db_get cache => "$id/md5";
617 if ($dbmd5 eq $md5) {
618 db_put cache => "$id/meta", $meta;
619
620 return db_get cache => "$id/data";
621 }
622 }
623
624 my $t1 = Time::HiRes::time;
625 my $data = $process->(\@data);
626 my $t2 = Time::HiRes::time;
627
628 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
629
630 db_put cache => "$id/data", $data;
631 db_put cache => "$id/md5" , $md5;
632 db_put cache => "$id/meta", $meta;
633
634 return $data;
635 }
636
637 db_get cache => "$id/data"
376} 638}
377 639
378=item cf::datalog type => key => value, ... 640=item cf::datalog type => key => value, ...
379 641
380Log a datalog packet of the given type with the given key-value pairs. 642Log a datalog packet of the given type with the given key-value pairs.
398attach callbacks/event handlers (a collection of which is called an "attachment") 660attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 661to it. All such attachable objects support the following methods.
400 662
401In the following description, CLASS can be any of C<global>, C<object> 663In the following description, CLASS can be any of C<global>, C<object>
402C<player>, C<client> or C<map> (i.e. the attachable objects in 664C<player>, C<client> or C<map> (i.e. the attachable objects in
403crossfire+). 665Crossfire TRT).
404 666
405=over 4 667=over 4
406 668
407=item $attachable->attach ($attachment, key => $value...) 669=item $attachable->attach ($attachment, key => $value...)
408 670
571 $registry = $CB_TYPE[$object_type] ||= []; 833 $registry = $CB_TYPE[$object_type] ||= [];
572 834
573 } elsif ($type eq "subtype") { 835 } elsif ($type eq "subtype") {
574 defined $object_type or Carp::croak "subtype specified without type"; 836 defined $object_type or Carp::croak "subtype specified without type";
575 my $object_subtype = shift @arg; 837 my $object_subtype = shift @arg;
576 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 838 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
577 839
578 } elsif ($type eq "package") { 840 } elsif ($type eq "package") {
579 my $pkg = shift @arg; 841 my $pkg = shift @arg;
580 842
581 while (my ($name, $id) = each %cb_id) { 843 while (my ($name, $id) = each %cb_id) {
610 _attach $registry, $klass, @attach; 872 _attach $registry, $klass, @attach;
611 } 873 }
612 874
613 $obj->{$name} = \%arg; 875 $obj->{$name} = \%arg;
614 } else { 876 } else {
615 warn "object uses attachment '$name' that is not available, postponing.\n"; 877 warn "object uses attachment '$name' which is not available, postponing.\n";
616 } 878 }
617 879
618 $obj->{_attachment}{$name} = undef; 880 $obj->{_attachment}{$name} = undef;
619} 881}
620 882
622 if (ref $_[0]) { 884 if (ref $_[0]) {
623 _object_attach @_; 885 _object_attach @_;
624 } else { 886 } else {
625 _attach shift->_attach_registry, @_; 887 _attach shift->_attach_registry, @_;
626 } 888 }
889 _recalc_want;
627}; 890};
628 891
629# all those should be optimised 892# all those should be optimised
630sub cf::attachable::detach { 893sub cf::attachable::detach {
631 my ($obj, $name) = @_; 894 my ($obj, $name) = @_;
634 delete $obj->{_attachment}{$name}; 897 delete $obj->{_attachment}{$name};
635 reattach ($obj); 898 reattach ($obj);
636 } else { 899 } else {
637 Carp::croak "cannot, currently, detach class attachments"; 900 Carp::croak "cannot, currently, detach class attachments";
638 } 901 }
902 _recalc_want;
639}; 903};
640 904
641sub cf::attachable::attached { 905sub cf::attachable::attached {
642 my ($obj, $name) = @_; 906 my ($obj, $name) = @_;
643 907
658 "; 922 ";
659 die if $@; 923 die if $@;
660} 924}
661 925
662our $override; 926our $override;
663our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 927our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
664 928
665sub override { 929sub override {
666 $override = 1; 930 $override = 1;
667 @invoke_results = (); 931 @INVOKE_RESULTS = (@_);
668} 932}
669 933
670sub do_invoke { 934sub do_invoke {
671 my $event = shift; 935 my $event = shift;
672 my $callbacks = shift; 936 my $callbacks = shift;
673 937
674 @invoke_results = (); 938 @INVOKE_RESULTS = ();
675 939
676 local $override; 940 local $override;
677 941
678 for (@$callbacks) { 942 for (@$callbacks) {
679 eval { &{$_->[1]} }; 943 eval { &{$_->[1]} };
696 960
697Generate an object-specific event with the given arguments. 961Generate an object-specific event with the given arguments.
698 962
699This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 963This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
700removed in future versions), and there is no public API to access override 964removed in future versions), and there is no public API to access override
701results (if you must, access C<@cf::invoke_results> directly). 965results (if you must, access C<@cf::INVOKE_RESULTS> directly).
702 966
703=back 967=back
704 968
705=cut 969=cut
706 970
707############################################################################# 971#############################################################################
708# object support 972# object support
973#
974
975sub _can_merge {
976 my ($ob1, $ob2) = @_;
977
978 local $Storable::canonical = 1;
979 my $fob1 = Storable::freeze $ob1;
980 my $fob2 = Storable::freeze $ob2;
981
982 $fob1 eq $fob2
983}
709 984
710sub reattach { 985sub reattach {
711 # basically do the same as instantiate, without calling instantiate 986 # basically do the same as instantiate, without calling instantiate
712 my ($obj) = @_; 987 my ($obj) = @_;
713 988
816 or return; 1091 or return;
817 $av = eval { (Storable::thaw $av)->{objs} }; 1092 $av = eval { (Storable::thaw $av)->{objs} };
818 } 1093 }
819 1094
820 warn sprintf "loading %s (%d)\n", 1095 warn sprintf "loading %s (%d)\n",
821 $filename, length $data, scalar @{$av || []};#d# 1096 $filename, length $data, scalar @{$av || []};
822 return ($data, $av); 1097 return ($data, $av);
823} 1098}
1099
1100=head2 COMMAND CALLBACKS
1101
1102=over 4
1103
1104=cut
824 1105
825############################################################################# 1106#############################################################################
826# command handling &c 1107# command handling &c
827 1108
828=item cf::register_command $name => \&callback($ob,$args); 1109=item cf::register_command $name => \&callback($ob,$args);
841 push @{ $COMMAND{$name} }, [$caller, $cb]; 1122 push @{ $COMMAND{$name} }, [$caller, $cb];
842} 1123}
843 1124
844=item cf::register_extcmd $name => \&callback($pl,$packet); 1125=item cf::register_extcmd $name => \&callback($pl,$packet);
845 1126
846Register a callbackf ro execution when the client sends an extcmd packet. 1127Register a callback for execution when the client sends an (synchronous)
1128extcmd packet. Ext commands will be processed in the order they are
1129received by the server, like other user commands. The first argument is
1130the logged-in player. Ext commands can only be processed after a player
1131has logged in successfully.
847 1132
848If the callback returns something, it is sent back as if reply was being 1133If the callback returns something, it is sent back as if reply was being
849called. 1134called.
850 1135
1136=item cf::register_exticmd $name => \&callback($ns,$packet);
1137
1138Register a callback for execution when the client sends an (asynchronous)
1139exticmd packet. Exti commands are processed by the server as soon as they
1140are received, i.e. out of order w.r.t. other commands. The first argument
1141is a client socket. Exti commands can be received anytime, even before
1142log-in.
1143
1144If the callback returns something, it is sent back as if reply was being
1145called.
1146
851=cut 1147=cut
852 1148
853sub register_extcmd { 1149sub register_extcmd {
854 my ($name, $cb) = @_; 1150 my ($name, $cb) = @_;
855 1151
856 $EXTCMD{$name} = $cb; 1152 $EXTCMD{$name} = $cb;
1153}
1154
1155sub register_exticmd {
1156 my ($name, $cb) = @_;
1157
1158 $EXTICMD{$name} = $cb;
857} 1159}
858 1160
859cf::player->attach ( 1161cf::player->attach (
860 on_command => sub { 1162 on_command => sub {
861 my ($pl, $name, $params) = @_; 1163 my ($pl, $name, $params) = @_;
870 cf::override; 1172 cf::override;
871 }, 1173 },
872 on_extcmd => sub { 1174 on_extcmd => sub {
873 my ($pl, $buf) = @_; 1175 my ($pl, $buf) = @_;
874 1176
875 my $msg = eval { from_json $buf }; 1177 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
876 1178
877 if (ref $msg) { 1179 if (ref $msg) {
878 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1180 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
879 if (my %reply = $cb->($pl, $msg)) { 1181 if (my %reply = $cb->($pl, $msg)) {
880 $pl->ext_reply ($msg->{msgid}, %reply); 1182 $pl->ext_reply ($msg->{msgid}, %reply);
886 1188
887 cf::override; 1189 cf::override;
888 }, 1190 },
889); 1191);
890 1192
891sub load_extension {
892 my ($path) = @_;
893
894 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
895 my $base = $1;
896 my $pkg = $1;
897 $pkg =~ s/[^[:word:]]/_/g;
898 $pkg = "ext::$pkg";
899
900 warn "... loading '$path' into '$pkg'\n";
901
902 open my $fh, "<:utf8", $path
903 or die "$path: $!";
904
905 my $source =
906 "package $pkg; use strict; use utf8;\n"
907 . "#line 1 \"$path\"\n{\n"
908 . (do { local $/; <$fh> })
909 . "\n};\n1";
910
911 unless (eval $source) {
912 my $msg = $@ ? "$path: $@\n"
913 : "extension disabled.\n";
914 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
915 warn $@;
916 warn "mandatory extension failed to load, exiting.\n";
917 exit 1;
918 }
919 die $@;
920 }
921
922 push @EXTS, $pkg;
923}
924
925sub load_extensions { 1193sub load_extensions {
1194 cf::sync_job {
1195 my %todo;
1196
926 for my $ext (<$LIBDIR/*.ext>) { 1197 for my $path (<$LIBDIR/*.ext>) {
927 next unless -r $ext; 1198 next unless -r $path;
928 eval { 1199
929 load_extension $ext; 1200 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1201 my $base = $1;
1202 my $pkg = $1;
1203 $pkg =~ s/[^[:word:]]/_/g;
1204 $pkg = "ext::$pkg";
1205
1206 open my $fh, "<:utf8", $path
1207 or die "$path: $!";
1208
1209 my $source = do { local $/; <$fh> };
1210
1211 my %ext = (
1212 path => $path,
1213 base => $base,
1214 pkg => $pkg,
1215 );
1216
1217 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1218 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1219
1220 $ext{source} =
1221 "package $pkg; use strict; use utf8;\n"
1222 . "#line 1 \"$path\"\n{\n"
1223 . $source
1224 . "\n};\n1";
1225
1226 $todo{$base} = \%ext;
1227 }
1228
1229 my %done;
1230 while (%todo) {
1231 my $progress;
1232
1233 while (my ($k, $v) = each %todo) {
1234 for (split /,\s*/, $v->{meta}{depends}) {
1235 goto skip
1236 unless exists $done{$_};
1237 }
1238
1239 warn "... loading '$k' into '$v->{pkg}'\n";
1240
1241 unless (eval $v->{source}) {
1242 my $msg = $@ ? "$v->{path}: $@\n"
1243 : "$v->{base}: extension inactive.\n";
1244
1245 if (exists $v->{meta}{mandatory}) {
1246 warn $msg;
1247 warn "mandatory extension failed to load, exiting.\n";
1248 exit 1;
1249 }
1250
1251 warn $msg;
1252 }
1253
1254 $done{$k} = delete $todo{$k};
1255 push @EXTS, $v->{pkg};
1256 $progress = 1;
930 1 1257 }
931 } or warn "$ext not loaded: $@"; 1258
1259 skip:
1260 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1261 unless $progress;
1262 }
932 } 1263 };
933} 1264}
934 1265
935############################################################################# 1266#############################################################################
936 1267
1268=back
1269
937=head2 CORE EXTENSIONS 1270=head2 CORE EXTENSIONS
938 1271
939Functions and methods that extend core crossfire objects. 1272Functions and methods that extend core crossfire objects.
940 1273
941=cut 1274=cut
953Returns the given player object, loading it if necessary (might block). 1286Returns the given player object, loading it if necessary (might block).
954 1287
955=cut 1288=cut
956 1289
957sub playerdir($) { 1290sub playerdir($) {
958 cf::localdir 1291 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1292 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1293}
964 1294
965sub path($) { 1295sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1296 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
967 1297
968 (playerdir $login) . "/$login.pl" 1298 (playerdir $login) . "/playerdata"
969} 1299}
970 1300
971sub find_active($) { 1301sub find_active($) {
972 $cf::PLAYER{$_[0]} 1302 $cf::PLAYER{$_[0]}
973 and $cf::PLAYER{$_[0]}->active 1303 and $cf::PLAYER{$_[0]}->active
986 my $login = $_[0]; 1316 my $login = $_[0];
987 1317
988 my $guard = cf::lock_acquire "user_find:$login"; 1318 my $guard = cf::lock_acquire "user_find:$login";
989 1319
990 $cf::PLAYER{$_[0]} || do { 1320 $cf::PLAYER{$_[0]} || do {
1321 # rename old playerfiles to new ones
1322 #TODO: remove when no longer required
1323 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1324 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1325 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1326 aio_unlink +(playerdir $login) . "/$login.pl";
1327
991 my $pl = load_pl path $login 1328 my $pl = load_pl path $login
992 or return; 1329 or return;
993 $cf::PLAYER{$login} = $pl 1330 $cf::PLAYER{$login} = $pl
994 } 1331 }
995 } 1332 }
1079while and may block, so not sync_job-capable, ever. 1416while and may block, so not sync_job-capable, ever.
1080 1417
1081=cut 1418=cut
1082 1419
1083sub list_logins { 1420sub list_logins {
1084 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1421 my $dirs = aio_readdir $PLAYERDIR
1085 or return []; 1422 or return [];
1086 1423
1087 my @logins; 1424 my @logins;
1088 1425
1089 for my $login (@$dirs) { 1426 for my $login (@$dirs) {
1124 } 1461 }
1125 1462
1126 \@paths 1463 \@paths
1127} 1464}
1128 1465
1466=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1467
1468Expand crossfire pod fragments into protocol xml.
1469
1470=cut
1471
1472sub expand_cfpod {
1473 ((my $self), (local $_)) = @_;
1474
1475 # escape & and <
1476 s/&/&amp;/g;
1477 s/(?<![BIUGH])</&lt;/g;
1478
1479 # this is buggy, it needs to properly take care of nested <'s
1480
1481 1 while
1482 # replace B<>, I<>, U<> etc.
1483 s/B<([^\>]*)>/<b>$1<\/b>/
1484 || s/I<([^\>]*)>/<i>$1<\/i>/
1485 || s/U<([^\>]*)>/<u>$1<\/u>/
1486 # replace G<male|female> tags
1487 || s{G<([^>|]*)\|([^>]*)>}{
1488 $self->gender ? $2 : $1
1489 }ge
1490 # replace H<hint text>
1491 || s{H<([^\>]*)>}
1492 {
1493 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1494 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1495 "")
1496 [$self->{hintmode}]
1497 }ge;
1498
1499 # create single paragraphs (very hackish)
1500 s/(?<=\S)\n(?=\w)/ /g;
1501
1502 # compress some whitespace
1503 s/\s+\n/\n/g; # ws line-ends
1504 s/\n\n+/\n/g; # double lines
1505 s/^\n+//; # beginning lines
1506 s/\n+$//; # ending lines
1507
1508 $_
1509}
1510
1511sub hintmode {
1512 $_[0]{hintmode} = $_[1] if @_ > 1;
1513 $_[0]{hintmode}
1514}
1515
1129=item $player->ext_reply ($msgid, %msg) 1516=item $player->ext_reply ($msgid, %msg)
1130 1517
1131Sends an ext reply to the player. 1518Sends an ext reply to the player.
1132 1519
1133=cut 1520=cut
1134 1521
1135sub ext_reply($$%) { 1522sub ext_reply($$%) {
1136 my ($self, $id, %msg) = @_; 1523 my ($self, $id, %msg) = @_;
1137 1524
1138 $msg{msgid} = $id; 1525 $msg{msgid} = $id;
1139 1526 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1140 $self->send ("ext " . cf::to_json \%msg);
1141} 1527}
1142 1528
1143=item $player->ext_event ($type, %msg) 1529=item $player->ext_event ($type, %msg)
1144 1530
1145Sends an ext event to the client. 1531Sends an ext event to the client.
1147=cut 1533=cut
1148 1534
1149sub ext_event($$%) { 1535sub ext_event($$%) {
1150 my ($self, $type, %msg) = @_; 1536 my ($self, $type, %msg) = @_;
1151 1537
1152 delete $msg{msgid}; 1538 $self->ns->ext_event ($type, %msg);
1153 $msg{msgtype} = "event";
1154 $msg{eventtype} = $type;
1155
1156 $self->send ("ext " . cf::to_json \%msg);
1157} 1539}
1158 1540
1159package cf; 1541=head3 cf::region
1542
1543=over 4
1544
1545=cut
1546
1547package cf::region;
1548
1549=item cf::region::find_by_path $path
1550
1551Tries to decuce the likely region for a map knowing only its path.
1552
1553=cut
1554
1555sub find_by_path($) {
1556 my ($path) = @_;
1557
1558 my ($match, $specificity);
1559
1560 for my $region (list) {
1561 if ($region->{match} && $path =~ $region->{match}) {
1562 ($match, $specificity) = ($region, $region->specificity)
1563 if $region->specificity > $specificity;
1564 }
1565 }
1566
1567 $match
1568}
1160 1569
1161=back 1570=back
1162
1163 1571
1164=head3 cf::map 1572=head3 cf::map
1165 1573
1166=over 4 1574=over 4
1167 1575
1222 my ($self, $merge) = @_; 1630 my ($self, $merge) = @_;
1223 1631
1224 # we have to keep some variables in memory intact 1632 # we have to keep some variables in memory intact
1225 local $self->{path}; 1633 local $self->{path};
1226 local $self->{load_path}; 1634 local $self->{load_path};
1227 local $self->{deny_save};
1228 local $self->{deny_reset};
1229 1635
1230 $self->SUPER::thawer_merge ($merge); 1636 $self->SUPER::thawer_merge ($merge);
1231} 1637}
1232 1638
1233sub normalise { 1639sub normalise {
1280 $self->init; # pass $1 etc. 1686 $self->init; # pass $1 etc.
1281 return $self; 1687 return $self;
1282 } 1688 }
1283 } 1689 }
1284 1690
1285 Carp::carp "unable to resolve path '$path' (base '$base')."; 1691 Carp::cluck "unable to resolve path '$path' (base '$base').";
1286 () 1692 ()
1287} 1693}
1288 1694
1289sub init { 1695sub init {
1290 my ($self) = @_; 1696 my ($self) = @_;
1305 1711
1306# the original (read-only) location 1712# the original (read-only) location
1307sub load_path { 1713sub load_path {
1308 my ($self) = @_; 1714 my ($self) = @_;
1309 1715
1310 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1716 "$MAPDIR/$self->{path}.map"
1311} 1717}
1312 1718
1313# the temporary/swap location 1719# the temporary/swap location
1314sub save_path { 1720sub save_path {
1315 my ($self) = @_; 1721 my ($self) = @_;
1316 1722
1317 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1723 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1318 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1724 "$TMPDIR/$path.map"
1319} 1725}
1320 1726
1321# the unique path, undef == no special unique path 1727# the unique path, undef == no special unique path
1322sub uniq_path { 1728sub uniq_path {
1323 my ($self) = @_; 1729 my ($self) = @_;
1324 1730
1325 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1731 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1326 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1732 "$UNIQUEDIR/$path"
1327} 1733}
1328 1734
1329# and all this just because we cannot iterate over 1735# and all this just because we cannot iterate over
1330# all maps in C++... 1736# all maps in C++...
1331sub change_all_map_light { 1737sub change_all_map_light {
1332 my ($change) = @_; 1738 my ($change) = @_;
1333 1739
1334 $_->change_map_light ($change) 1740 $_->change_map_light ($change)
1335 for grep $_->outdoor, values %cf::MAP; 1741 for grep $_->outdoor, values %cf::MAP;
1742}
1743
1744sub decay_objects {
1745 my ($self) = @_;
1746
1747 return if $self->{deny_reset};
1748
1749 $self->do_decay_objects;
1336} 1750}
1337 1751
1338sub unlink_save { 1752sub unlink_save {
1339 my ($self) = @_; 1753 my ($self) = @_;
1340 1754
1398 $self->load_header_orig 1812 $self->load_header_orig
1399 or return; 1813 or return;
1400 $self->prepare_orig; 1814 $self->prepare_orig;
1401 } 1815 }
1402 1816
1817 $self->{deny_reset} = 1
1818 if $self->no_reset;
1819
1820 $self->default_region (cf::region::find_by_path $self->{path})
1821 unless $self->default_region;
1822
1403 1 1823 1
1404} 1824}
1405 1825
1406sub find; 1826sub find;
1407sub find { 1827sub find {
1419 $map->{last_save} = $cf::RUNTIME; 1839 $map->{last_save} = $cf::RUNTIME;
1420 1840
1421 $map->load_header 1841 $map->load_header
1422 or return; 1842 or return;
1423 1843
1424 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1844 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1425 # doing this can freeze the server in a sync job, obviously 1845 # doing this can freeze the server in a sync job, obviously
1426 #$cf::WAIT_FOR_TICK->wait; 1846 #$cf::WAIT_FOR_TICK->wait;
1427 $map->reset; 1847 $map->reset;
1428 undef $guard; 1848 undef $guard;
1429 return find $path; 1849 return find $path;
1440 my ($self) = @_; 1860 my ($self) = @_;
1441 1861
1442 local $self->{deny_reset} = 1; # loading can take a long time 1862 local $self->{deny_reset} = 1; # loading can take a long time
1443 1863
1444 my $path = $self->{path}; 1864 my $path = $self->{path};
1865
1866 {
1445 my $guard = cf::lock_acquire "map_load:$path"; 1867 my $guard = cf::lock_acquire "map_load:$path";
1446 1868
1447 return if $self->in_memory != cf::MAP_SWAPPED; 1869 return if $self->in_memory != cf::MAP_SWAPPED;
1448 1870
1449 $self->in_memory (cf::MAP_LOADING); 1871 $self->in_memory (cf::MAP_LOADING);
1450 1872
1451 $self->alloc; 1873 $self->alloc;
1452 1874
1453 $self->pre_load; 1875 $self->pre_load;
1454
1455 $self->_load_objects ($self->{load_path}, 1)
1456 or return;
1457
1458 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1459 if delete $self->{load_original};
1460
1461 if (my $uniq = $self->uniq_path) {
1462 utf8::encode $uniq;
1463 if (aio_open $uniq, O_RDONLY, 0) {
1464 $self->clear_unique_items;
1465 $self->_load_objects ($uniq, 0);
1466 }
1467 }
1468
1469 Coro::cede;
1470
1471 # now do the right thing for maps
1472 $self->link_multipart_objects;
1473
1474 unless ($self->{deny_activate}) {
1475 $self->decay_objects;
1476 $self->fix_auto_apply;
1477 $self->update_buttons;
1478 Coro::cede; 1876 Coro::cede;
1479 $self->set_darkness_map; 1877
1878 $self->_load_objects ($self->{load_path}, 1)
1879 or return;
1880
1881 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1882 if delete $self->{load_original};
1883
1884 if (my $uniq = $self->uniq_path) {
1885 utf8::encode $uniq;
1886 if (aio_open $uniq, O_RDONLY, 0) {
1887 $self->clear_unique_items;
1888 $self->_load_objects ($uniq, 0);
1889 }
1890 }
1891
1892 Coro::cede;
1893 # now do the right thing for maps
1894 $self->link_multipart_objects;
1480 $self->difficulty ($self->estimate_difficulty) 1895 $self->difficulty ($self->estimate_difficulty)
1481 unless $self->difficulty; 1896 unless $self->difficulty;
1482 Coro::cede; 1897 Coro::cede;
1898
1899 unless ($self->{deny_activate}) {
1900 $self->decay_objects;
1901 $self->fix_auto_apply;
1902 $self->update_buttons;
1903 Coro::cede;
1904 $self->set_darkness_map;
1905 Coro::cede;
1483 $self->activate; 1906 $self->activate;
1907 }
1908
1909 $self->in_memory (cf::MAP_IN_MEMORY);
1484 } 1910 }
1485 1911
1486 $self->post_load; 1912 $self->post_load;
1487
1488 $self->in_memory (cf::MAP_IN_MEMORY);
1489} 1913}
1490 1914
1491sub customise_for { 1915sub customise_for {
1492 my ($self, $ob) = @_; 1916 my ($self, $ob) = @_;
1493 1917
1494 return find "~" . $ob->name . "/" . $self->{path} 1918 return find "~" . $ob->name . "/" . $self->{path}
1495 if $self->per_player; 1919 if $self->per_player;
1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1496 1923
1497 $self 1924 $self
1498} 1925}
1499 1926
1500# find and load all maps in the 3x3 area around a map 1927# find and load all maps in the 3x3 area around a map
1547 1974
1548 undef $MAP_PREFETCH{$path}; 1975 undef $MAP_PREFETCH{$path};
1549 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1550 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1551 for my $path (keys %MAP_PREFETCH) { 1978 for my $path (keys %MAP_PREFETCH) {
1552 my $map = find $path 1979 if (my $map = find $path) {
1553 or next;
1554 $map->load; 1980 $map->load;
1981 }
1555 1982
1556 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$path};
1557 } 1984 }
1558 } 1985 }
1559 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1611 2038
1612sub reset_at { 2039sub reset_at {
1613 my ($self) = @_; 2040 my ($self) = @_;
1614 2041
1615 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1616 return 1e99 if $self->isa ("ext::map_per_player");#d#
1617 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1618 2044
1619 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1620 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1621 2047
1632 my ($self) = @_; 2058 my ($self) = @_;
1633 2059
1634 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1635 2061
1636 return if $self->players; 2062 return if $self->players;
1637 return if $self->isa ("ext::map_per_player");#d#
1638 2063
1639 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
1640 2065
1641 $self->in_memory (cf::MAP_SWAPPED); 2066 $self->in_memory (cf::MAP_SWAPPED);
1642 2067
1643 # need to save uniques path 2068 # need to save uniques path
1644 unless ($self->{deny_save}) { 2069 unless ($self->{deny_save}) {
1676 $cf::MAP{$self->path} = $self; 2101 $cf::MAP{$self->path} = $self;
1677 2102
1678 $self->reset; # polite request, might not happen 2103 $self->reset; # polite request, might not happen
1679} 2104}
1680 2105
2106=item $maps = cf::map::tmp_maps
2107
2108Returns an arrayref with all map paths of currently instantiated and saved
2109maps. May block.
2110
2111=cut
2112
2113sub tmp_maps() {
2114 [
2115 map {
2116 utf8::decode $_;
2117 /\.map$/
2118 ? normalise $_
2119 : ()
2120 } @{ aio_readdir $TMPDIR or [] }
2121 ]
2122}
2123
2124=item $maps = cf::map::random_maps
2125
2126Returns an arrayref with all map paths of currently instantiated and saved
2127random maps. May block.
2128
2129=cut
2130
2131sub random_maps() {
2132 [
2133 map {
2134 utf8::decode $_;
2135 /\.map$/
2136 ? normalise "?random/$_"
2137 : ()
2138 } @{ aio_readdir $RANDOMDIR or [] }
2139 ]
2140}
2141
1681=item cf::map::unique_maps 2142=item cf::map::unique_maps
1682 2143
1683Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1684instantiated unique items. May block. 2145instantiated unique items. May block.
1685 2146
1686=cut 2147=cut
1687 2148
1688sub unique_maps() { 2149sub unique_maps() {
1689 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2150 [
1690 or return; 2151 map {
1691
1692 my @paths;
1693
1694 for (@$files) {
1695 utf8::decode $_; 2152 utf8::decode $_;
1696 next if /\.pst$/; 2153 /\.map$/
1697 next unless /^$PATH_SEP/o; 2154 ? normalise $_
1698 2155 : ()
1699 push @paths, cf::map::normalise $_; 2156 } @{ aio_readdir $UNIQUEDIR or [] }
1700 } 2157 ]
1701
1702 \@paths
1703} 2158}
1704 2159
1705package cf; 2160package cf;
1706 2161
1707=back 2162=back
1753 2208
1754 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1755 2210
1756 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1757 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1758 } else { 2214 } else {
2215 my $pl = $self->contr;
2216
2217 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2218 my $diag = $pl->{npc_dialog};
2219 $diag->{pl}->ext_reply (
2220 $diag->{id},
2221 msgtype => "reply",
2222 msg => $diag->{pl}->expand_cfpod ($msg),
2223 add_topics => []
2224 );
2225
2226 } else {
1759 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1760 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1761 } 2230 }
1762} 2231}
1763 2232
1764=item $player_object->may ("access") 2233=item $player_object->may ("access")
1765 2234
1813 $self->deactivate_recursive; 2282 $self->deactivate_recursive;
1814 2283
1815 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2284 return if UNIVERSAL::isa $self->map, "ext::map_link";
1816 2285
1817 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2286 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1818 if $self->map; 2287 if $self->map && $self->map->{path} ne "{link}";
1819 2288
1820 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2289 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1821} 2290}
1822 2291
1823sub cf::object::player::leave_link { 2292sub cf::object::player::leave_link {
1824 my ($self, $map, $x, $y) = @_; 2293 my ($self, $map, $x, $y) = @_;
2294
2295 return unless $self->contr->active;
1825 2296
1826 my $link_pos = delete $self->{_link_pos}; 2297 my $link_pos = delete $self->{_link_pos};
1827 2298
1828 unless ($map) { 2299 unless ($map) {
1829 # restore original map position 2300 # restore original map position
1852 2323
1853 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1854 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1855} 2326}
1856 2327
1857cf::player->attach ( 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1858 on_logout => sub {
1859 my ($pl) = @_;
1860 2329
1861 # abort map switching before logout 2330Moves the player to the given map-path and coordinates by first freezing
1862 if ($pl->ob->{_link_pos}) { 2331her, loading and preparing them map, calling the provided $check callback
1863 cf::sync_job { 2332that has to return the map if sucecssful, and then unfreezes the player on
1864 $pl->ob->leave_link 2333the new (success) or old (failed) map position. In either case, $done will
1865 }; 2334be called at the end of this process.
1866 }
1867 },
1868 on_login => sub {
1869 my ($pl) = @_;
1870 2335
1871 # try to abort aborted map switching on player login :)
1872 # should happen only on crashes
1873 if ($pl->ob->{_link_pos}) {
1874 $pl->ob->enter_link;
1875 (async {
1876 $pl->ob->reply (undef,
1877 "There was an internal problem at your last logout, "
1878 . "the server will try to bring you to your intended destination in a second.",
1879 cf::NDI_RED);
1880 # we need this sleep as the login has a concurrent enter_exit running
1881 # and this sleep increases chances of the player not ending up in scorn
1882 Coro::Timer::sleep 1;
1883 $pl->ob->leave_link;
1884 })->prio (2);
1885 }
1886 },
1887);
1888
1889=item $player_object->goto ($path, $x, $y)
1890
1891=cut 2336=cut
2337
2338our $GOTOGEN;
1892 2339
1893sub cf::object::player::goto { 2340sub cf::object::player::goto {
1894 my ($self, $path, $x, $y) = @_; 2341 my ($self, $path, $x, $y, $check, $done) = @_;
2342
2343 # do generation counting so two concurrent goto's will be executed in-order
2344 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1895 2345
1896 $self->enter_link; 2346 $self->enter_link;
1897 2347
1898 (async { 2348 (async {
1899 my $map = eval { 2349 my $map = eval {
1900 my $map = cf::map::find $path; 2350 my $map = cf::map::find $path;
2351
2352 if ($map) {
1901 $map = $map->customise_for ($self) if $map; 2353 $map = $map->customise_for ($self);
2354 $map = $check->($map) if $check && $map;
2355 } else {
2356 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2357 }
2358
1902 $map 2359 $map
2360 };
2361
2362 if ($@) {
2363 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2364 LOG llevError | logBacktrace, Carp::longmess $@;
1903 } or 2365 }
1904 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1905 2366
2367 if ($gen == $self->{_goto_generation}) {
2368 delete $self->{_goto_generation};
1906 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
2370 }
2371
2372 $done->() if $done;
1907 })->prio (1); 2373 })->prio (1);
1908} 2374}
1909 2375
1910=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1911 2377
1950 2416
1951 $rmp->{random_seed} ||= $exit->random_seed; 2417 $rmp->{random_seed} ||= $exit->random_seed;
1952 2418
1953 my $data = cf::to_json $rmp; 2419 my $data = cf::to_json $rmp;
1954 my $md5 = Digest::MD5::md5_hex $data; 2420 my $md5 = Digest::MD5::md5_hex $data;
1955 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2421 my $meta = "$RANDOMDIR/$md5.meta";
1956 2422
1957 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2423 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1958 aio_write $fh, 0, (length $data), $data, 0; 2424 aio_write $fh, 0, (length $data), $data, 0;
1959 undef $fh; 2425 undef $fh;
1960 aio_rename "$meta~", $meta; 2426 aio_rename "$meta~", $meta;
1969 2435
1970 return unless $self->type == cf::PLAYER; 2436 return unless $self->type == cf::PLAYER;
1971 2437
1972 if ($exit->slaying eq "/!") { 2438 if ($exit->slaying eq "/!") {
1973 #TODO: this should de-fi-ni-te-ly not be a sync-job 2439 #TODO: this should de-fi-ni-te-ly not be a sync-job
2440 # the problem is that $exit might not survive long enough
2441 # so it needs to be done right now, right here
1974 cf::sync_job { prepare_random_map $exit }; 2442 cf::sync_job { prepare_random_map $exit };
1975 } 2443 }
1976 2444
1977 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2445 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1978 my $hp = $exit->stats->hp; 2446 my $hp = $exit->stats->hp;
1979 my $sp = $exit->stats->sp; 2447 my $sp = $exit->stats->sp;
1980 2448
1981 $self->enter_link; 2449 $self->enter_link;
2450
2451 # if exit is damned, update players death & WoR home-position
2452 $self->contr->savebed ($slaying, $hp, $sp)
2453 if $exit->flag (FLAG_DAMNED);
1982 2454
1983 (async { 2455 (async {
1984 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
1985 unless (eval { 2457 unless (eval {
1986 $self->goto ($slaying, $hp, $sp); 2458 $self->goto ($slaying, $hp, $sp);
1987 2459
1988 1; 2460 1;
1989 }) { 2461 }) {
1990 $self->message ("Something went wrong deep within the crossfire server. " 2462 $self->message ("Something went wrong deep within the crossfire server. "
1991 . "I'll try to bring you back to the map you were before. " 2463 . "I'll try to bring you back to the map you were before. "
1992 . "Please report this to the dungeon master!", 2464 . "Please report this to the dungeon master!",
1993 cf::NDI_UNIQUE | cf::NDI_RED); 2465 cf::NDI_UNIQUE | cf::NDI_RED);
1994 2466
1995 warn "ERROR in enter_exit: $@"; 2467 warn "ERROR in enter_exit: $@";
1996 $self->leave_link; 2468 $self->leave_link;
1997 } 2469 }
1998 })->prio (1); 2470 })->prio (1);
2014 2486
2015 utf8::encode $text; 2487 utf8::encode $text;
2016 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2017} 2489}
2018 2490
2491=item $client->send_msg ($channel, $msg, $color, [extra...])
2492
2493Send a drawinfo or msg packet to the client, formatting the msg for the
2494client if neccessary. C<$type> should be a string identifying the type of
2495the message, with C<log> being the default. If C<$color> is negative, suppress
2496the message unless the client supports the msg packet.
2497
2498=cut
2499
2500sub cf::client::send_msg {
2501 my ($self, $channel, $msg, $color, @extra) = @_;
2502
2503 $msg = $self->pl->expand_cfpod ($msg);
2504
2505 $color &= ~cf::NDI_UNIQUE; # just in case...
2506
2507 if (ref $channel) {
2508 # send meta info to client, if not yet sent
2509 unless (exists $self->{channel}{$channel->{id}}) {
2510 $self->{channel}{$channel->{id}} = $channel;
2511 $self->ext_event (channel_info => %$channel);
2512 }
2513
2514 $channel = $channel->{id};
2515 }
2516
2517 return unless @extra || length $msg;
2518
2519 if ($self->can_msg) {
2520 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2521 } else {
2522 # replace some tags by gcfclient-compatible ones
2523 for ($msg) {
2524 1 while
2525 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2526 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2527 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2528 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2529 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2530 }
2531
2532 if ($color >= 0) {
2533 if (0 && $msg =~ /\[/) {
2534 $self->send_packet ("drawextinfo $color 4 0 $msg")
2535 } else {
2536 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2537 $self->send_packet ("drawinfo $color $msg")
2538 }
2539 }
2540 }
2541}
2542
2543=item $client->ext_event ($type, %msg)
2544
2545Sends an ext event to the client.
2546
2547=cut
2548
2549sub cf::client::ext_event($$%) {
2550 my ($self, $type, %msg) = @_;
2551
2552 return unless $self->extcmd;
2553
2554 $msg{msgtype} = "event_$type";
2555 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2556}
2019 2557
2020=item $success = $client->query ($flags, "text", \&cb) 2558=item $success = $client->query ($flags, "text", \&cb)
2021 2559
2022Queues a query to the client, calling the given callback with 2560Queues a query to the client, calling the given callback with
2023the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2561the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2024C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2562C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2025 2563
2026Queries can fail, so check the return code. Or don't, as queries will become 2564Queries can fail, so check the return code. Or don't, as queries will
2027reliable at some point in the future. 2565become reliable at some point in the future.
2028 2566
2029=cut 2567=cut
2030 2568
2031sub cf::client::query { 2569sub cf::client::query {
2032 my ($self, $flags, $text, $cb) = @_; 2570 my ($self, $flags, $text, $cb) = @_;
2040 utf8::encode $text; 2578 utf8::encode $text;
2041 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2579 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2042 2580
2043 $self->send_packet ($self->{query_queue}[0][0]) 2581 $self->send_packet ($self->{query_queue}[0][0])
2044 if @{ $self->{query_queue} } == 1; 2582 if @{ $self->{query_queue} } == 1;
2583
2584 1
2045} 2585}
2046 2586
2047cf::client->attach ( 2587cf::client->attach (
2588 on_connect => sub {
2589 my ($ns) = @_;
2590
2591 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2592 },
2048 on_reply => sub { 2593 on_reply => sub {
2049 my ($ns, $msg) = @_; 2594 my ($ns, $msg) = @_;
2050 2595
2051 # this weird shuffling is so that direct followup queries 2596 # this weird shuffling is so that direct followup queries
2052 # get handled first 2597 # get handled first
2064 } else { 2609 } else {
2065 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2610 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2066 } 2611 }
2067 } 2612 }
2068 }, 2613 },
2614 on_exticmd => sub {
2615 my ($ns, $buf) = @_;
2616
2617 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2618
2619 if (ref $msg) {
2620 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2621 if (my %reply = $cb->($ns, $msg)) {
2622 $reply{msgid} = $msg->{msgid};
2623 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2624 }
2625 }
2626 } else {
2627 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2628 }
2629
2630 cf::override;
2631 },
2069); 2632);
2070 2633
2071=item $client->async (\&cb) 2634=item $client->async (\&cb)
2072 2635
2073Create a new coroutine, running the specified callback. The coroutine will 2636Create a new coroutine, running the specified callback. The coroutine will
2122 2685
2123=pod 2686=pod
2124 2687
2125The following functions and methods are available within a safe environment: 2688The following functions and methods are available within a safe environment:
2126 2689
2127 cf::object contr pay_amount pay_player map 2690 cf::object
2691 contr pay_amount pay_player map x y force_find force_add
2692 insert remove
2693
2128 cf::object::player player 2694 cf::object::player
2129 cf::player peaceful 2695 player
2130 cf::map trigger 2696
2697 cf::player
2698 peaceful
2699
2700 cf::map
2701 trigger
2131 2702
2132=cut 2703=cut
2133 2704
2134for ( 2705for (
2135 ["cf::object" => qw(contr pay_amount pay_player map)], 2706 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2707 insert remove)],
2136 ["cf::object::player" => qw(player)], 2708 ["cf::object::player" => qw(player)],
2137 ["cf::player" => qw(peaceful)], 2709 ["cf::player" => qw(peaceful)],
2138 ["cf::map" => qw(trigger)], 2710 ["cf::map" => qw(trigger)],
2139) { 2711) {
2140 no strict 'refs'; 2712 no strict 'refs';
2211=back 2783=back
2212 2784
2213=cut 2785=cut
2214 2786
2215############################################################################# 2787#############################################################################
2216
2217=head2 EXTENSION DATABASE SUPPORT
2218
2219Crossfire maintains a very simple database for extension use. It can
2220currently store anything that can be serialised using Storable, which
2221excludes objects.
2222
2223The parameter C<$family> should best start with the name of the extension
2224using it, it should be unique.
2225
2226=over 4
2227
2228=item $value = cf::db_get $family => $key
2229
2230Returns a single value from the database.
2231
2232=item cf::db_put $family => $key => $value
2233
2234Stores the given C<$value> in the family.
2235
2236=cut
2237
2238our $DB;
2239
2240sub db_init {
2241 unless ($DB) {
2242 $DB = BDB::db_create $DB_ENV;
2243
2244 cf::sync_job {
2245 eval {
2246 $DB->set_flags (BDB::CHKSUM);
2247
2248 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2249 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2250 cf::cleanup "db_open(db): $!" if $!;
2251 };
2252 cf::cleanup "db_open(db): $@" if $@;
2253 };
2254
2255 my $path = cf::localdir . "/database.pst";
2256 if (stat $path) {
2257 cf::sync_job {
2258 my $pst = Storable::retrieve $path;
2259
2260 cf::db_put (board => data => $pst->{board});
2261 cf::db_put (guildrules => data => $pst->{guildrules});
2262 cf::db_put (rent => balance => $pst->{rent}{balance});
2263 BDB::db_env_txn_checkpoint $DB_ENV;
2264
2265 unlink $path;
2266 };
2267 }
2268 }
2269}
2270
2271sub db_get($$) {
2272 my $key = "$_[0]/$_[1]";
2273
2274 cf::sync_job {
2275 BDB::db_get $DB, undef, $key, my $data;
2276
2277 $! ? ()
2278 : Compress::LZF::sthaw $data
2279 }
2280}
2281
2282sub db_put($$$) {
2283 BDB::dbreq_pri 4;
2284 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2285}
2286
2287#############################################################################
2288# the server's init and main functions 2788# the server's init and main functions
2289 2789
2290sub load_facedata { 2790sub load_facedata($) {
2291 my $path = sprintf "%s/facedata", cf::datadir; 2791 my ($path) = @_;
2292 2792
2293 warn "loading facedata from $path\n"; 2793 warn "loading facedata from $path\n";
2294 2794
2295 my $faces; 2795 my $facedata;
2296 0 < aio_load $path, $faces 2796 0 < aio_load $path, $facedata
2297 or die "$path: $!"; 2797 or die "$path: $!";
2298 2798
2299 Coro::cede;
2300 $faces = Storable::thaw $faces; 2799 $facedata = Coro::Storable::thaw $facedata;
2301 Coro::cede;
2302 2800
2303 my $meta = delete $faces->{""};
2304 $meta->{version} == 1 2801 $facedata->{version} == 2
2305 or cf::cleanup "$path: version mismatch, cannot proceed."; 2802 or cf::cleanup "$path: version mismatch, cannot proceed.";
2306 2803
2804 {
2805 my $faces = $facedata->{faceinfo};
2806
2307 while (my ($face, $info) = each %$faces) { 2807 while (my ($face, $info) = each %$faces) {
2308 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2808 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2309 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2809 cf::face::set_visibility $idx, $info->{visibility};
2810 cf::face::set_magicmap $idx, $info->{magicmap};
2310 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2811 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2311 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2812 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2312 Coro::cede;
2313 }
2314 2813
2814 cf::cede_to_tick;
2815 }
2816
2315 while (my ($face, $info) = each %$faces) { 2817 while (my ($face, $info) = each %$faces) {
2316 next unless $info->{smooth}; 2818 next unless $info->{smooth};
2317 my $idx = cf::face::find $face 2819 my $idx = cf::face::find $face
2318 or next; 2820 or next;
2319 if (my $smooth = cf::face::find $info->{smooth}) { 2821 if (my $smooth = cf::face::find $info->{smooth}) {
2320 cf::face::set_smooth $idx, $smooth; 2822 cf::face::set_smooth $idx, $smooth;
2823 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2321 } else { 2824 } else {
2322 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2825 warn "smooth face '$info->{smooth}' not found for face '$face'";
2323 } 2826 }
2324 Coro::cede; 2827
2828 cf::cede_to_tick;
2829 }
2830 }
2831
2832 {
2833 my $anims = $facedata->{animinfo};
2834
2835 while (my ($anim, $info) = each %$anims) {
2836 cf::anim::set $anim, $info->{frames}, $info->{facings};
2837 cf::cede_to_tick;
2838 }
2839
2840 cf::anim::invalidate_all; # d'oh
2841 }
2842
2843 {
2844 # TODO: for gcfclient pleasure, we should give resources
2845 # that gcfclient doesn't grok a >10000 face index.
2846 my $res = $facedata->{resource};
2847 my $enc = JSON::XS->new->utf8->canonical;
2848
2849 while (my ($name, $info) = each %$res) {
2850 my $meta = $enc->encode ({
2851 name => $name,
2852 type => $info->{type},
2853 copyright => $info->{copyright}, #TODO#
2854 });
2855
2856 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2857
2858 if ($name =~ /\.jpg$/) {
2859 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2860 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2861 } else {
2862 my $data = pack "(w/a*)*", $meta, $info->{data};
2863 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2864
2865 cf::face::set_type $idx, 1;
2866 cf::face::set_data $idx, 0, $data, $chk;
2867 }
2868
2869 cf::cede_to_tick;
2870 }
2325 } 2871 }
2326 2872
2327 1 2873 1
2328} 2874}
2329 2875
2876sub reload_regions {
2877 load_resource_file "$MAPDIR/regions"
2878 or die "unable to load regions file\n";
2879
2880 for (cf::region::list) {
2881 $_->{match} = qr/$_->{match}/
2882 if exists $_->{match};
2883 }
2884}
2885
2886sub reload_facedata {
2887 load_facedata "$DATADIR/facedata"
2888 or die "unable to load facedata\n";
2889}
2890
2891sub reload_archetypes {
2892 load_resource_file "$DATADIR/archetypes"
2893 or die "unable to load archetypes\n";
2894 #d# NEED to laod twice to resolve forward references
2895 # this really needs to be done in an extra post-pass
2896 # (which needs to be synchronous, so solve it differently)
2897 load_resource_file "$DATADIR/archetypes"
2898 or die "unable to load archetypes\n";
2899}
2900
2901sub reload_treasures {
2902 load_resource_file "$DATADIR/treasures"
2903 or die "unable to load treasurelists\n";
2904}
2905
2330sub reload_resources { 2906sub reload_resources {
2331 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2907 warn "reloading resource files...\n";
2332 or die "unable to load regions file\n";#d# 2908
2909 reload_regions;
2333 load_facedata 2910 reload_facedata;
2334 or die "unable to load facedata\n";#d# 2911 #reload_archetypes;#d#
2912 reload_archetypes;
2913 reload_treasures;
2914
2915 warn "finished reloading resource files\n";
2335} 2916}
2336 2917
2337sub init { 2918sub init {
2338 reload_resources; 2919 reload_resources;
2339} 2920}
2340 2921
2341sub cfg_load { 2922sub cfg_load {
2342 open my $fh, "<:utf8", cf::confdir . "/config" 2923 open my $fh, "<:utf8", "$CONFDIR/config"
2343 or return; 2924 or return;
2344 2925
2345 local $/; 2926 local $/;
2346 *CFG = YAML::Syck::Load <$fh>; 2927 *CFG = YAML::Syck::Load <$fh>;
2347 2928
2392 }, 2973 },
2393 ); 2974 );
2394 } 2975 }
2395} 2976}
2396 2977
2978sub write_runtime {
2979 my $runtime = "$LOCALDIR/runtime";
2980
2981 # first touch the runtime file to show we are still running:
2982 # the fsync below can take a very very long time.
2983
2984 IO::AIO::aio_utime $runtime, undef, undef;
2985
2986 my $guard = cf::lock_acquire "write_runtime";
2987
2988 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2989 or return;
2990
2991 my $value = $cf::RUNTIME + 90 + 10;
2992 # 10 is the runtime save interval, for a monotonic clock
2993 # 60 allows for the watchdog to kill the server.
2994
2995 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2996 and return;
2997
2998 # always fsync - this file is important
2999 aio_fsync $fh
3000 and return;
3001
3002 # touch it again to show we are up-to-date
3003 aio_utime $fh, undef, undef;
3004
3005 close $fh
3006 or return;
3007
3008 aio_rename "$runtime~", $runtime
3009 and return;
3010
3011 warn "runtime file written.\n";
3012
3013 1
3014}
3015
2397sub emergency_save() { 3016sub emergency_save() {
2398 my $freeze_guard = cf::freeze_mainloop; 3017 my $freeze_guard = cf::freeze_mainloop;
2399 3018
2400 warn "enter emergency perl save\n"; 3019 warn "enter emergency perl save\n";
2401 3020
2432 3051
2433 warn Carp::longmess "post_cleanup backtrace" 3052 warn Carp::longmess "post_cleanup backtrace"
2434 if $make_core; 3053 if $make_core;
2435} 3054}
2436 3055
2437sub reload() { 3056sub do_reload_perl() {
2438 # can/must only be called in main 3057 # can/must only be called in main
2439 if ($Coro::current != $Coro::main) { 3058 if ($Coro::current != $Coro::main) {
2440 warn "can only reload from main coroutine"; 3059 warn "can only reload from main coroutine";
2441 return; 3060 return;
2442 } 3061 }
2476 %EXT_CORO = (); 3095 %EXT_CORO = ();
2477 3096
2478 warn "removing commands"; 3097 warn "removing commands";
2479 %COMMAND = (); 3098 %COMMAND = ();
2480 3099
2481 warn "removing ext commands"; 3100 warn "removing ext/exti commands";
2482 %EXTCMD = (); 3101 %EXTCMD = ();
3102 %EXTICMD = ();
2483 3103
2484 warn "unloading/nuking all extensions"; 3104 warn "unloading/nuking all extensions";
2485 for my $pkg (@EXTS) { 3105 for my $pkg (@EXTS) {
2486 warn "... unloading $pkg"; 3106 warn "... unloading $pkg";
2487 3107
2517 Symbol::delete_package "safe::$_" 3137 Symbol::delete_package "safe::$_"
2518 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3138 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2519 3139
2520 warn "unloading cf.pm \"a bit\""; 3140 warn "unloading cf.pm \"a bit\"";
2521 delete $INC{"cf.pm"}; 3141 delete $INC{"cf.pm"};
3142 delete $INC{"cf/pod.pm"};
2522 3143
2523 # don't, removes xs symbols, too, 3144 # don't, removes xs symbols, too,
2524 # and global variables created in xs 3145 # and global variables created in xs
2525 #Symbol::delete_package __PACKAGE__; 3146 #Symbol::delete_package __PACKAGE__;
2526 3147
2541 warn "reattaching attachments to maps"; 3162 warn "reattaching attachments to maps";
2542 reattach $_ for values %MAP; 3163 reattach $_ for values %MAP;
2543 warn "reattaching attachments to players"; 3164 warn "reattaching attachments to players";
2544 reattach $_ for values %PLAYER; 3165 reattach $_ for values %PLAYER;
2545 3166
2546 warn "loading reloadable resources";
2547 reload_resources;
2548
2549 warn "leaving sync_job"; 3167 warn "leaving sync_job";
2550 3168
2551 1 3169 1
2552 } or do { 3170 } or do {
2553 warn $@; 3171 warn $@;
2558 warn "reloaded"; 3176 warn "reloaded";
2559}; 3177};
2560 3178
2561our $RELOAD_WATCHER; # used only during reload 3179our $RELOAD_WATCHER; # used only during reload
2562 3180
3181sub reload_perl() {
3182 # doing reload synchronously and two reloads happen back-to-back,
3183 # coro crashes during coro_state_free->destroy here.
3184
3185 $RELOAD_WATCHER ||= Event->timer (
3186 reentrant => 0,
3187 after => 0,
3188 data => WF_AUTOCANCEL,
3189 cb => sub {
3190 do_reload_perl;
3191 undef $RELOAD_WATCHER;
3192 },
3193 );
3194}
3195
2563register_command "reload" => sub { 3196register_command "reload" => sub {
2564 my ($who, $arg) = @_; 3197 my ($who, $arg) = @_;
2565 3198
2566 if ($who->flag (FLAG_WIZ)) { 3199 if ($who->flag (FLAG_WIZ)) {
2567 $who->message ("reloading server."); 3200 $who->message ("reloading server.");
2568 3201 async { reload_perl };
2569 # doing reload synchronously and two reloads happen back-to-back,
2570 # coro crashes during coro_state_free->destroy here.
2571
2572 $RELOAD_WATCHER ||= Event->timer (
2573 reentrant => 0,
2574 after => 0,
2575 data => WF_AUTOCANCEL,
2576 cb => sub {
2577 reload;
2578 undef $RELOAD_WATCHER;
2579 },
2580 );
2581 } 3202 }
2582}; 3203};
2583 3204
2584unshift @INC, $LIBDIR; 3205unshift @INC, $LIBDIR;
2585 3206
2586my $bug_warning = 0; 3207my $bug_warning = 0;
2587 3208
3209our @WAIT_FOR_TICK;
3210our @WAIT_FOR_TICK_BEGIN;
3211
3212sub wait_for_tick {
3213 return unless $TICK_WATCHER->is_active;
3214 return if $Coro::current == $Coro::main;
3215
3216 my $signal = new Coro::Signal;
3217 push @WAIT_FOR_TICK, $signal;
3218 $signal->wait;
3219}
3220
3221sub wait_for_tick_begin {
3222 return unless $TICK_WATCHER->is_active;
3223 return if $Coro::current == $Coro::main;
3224
3225 my $signal = new Coro::Signal;
3226 push @WAIT_FOR_TICK_BEGIN, $signal;
3227 $signal->wait;
3228}
3229
3230 my $min = 1e6;#d#
3231 my $avg = 10;
2588$TICK_WATCHER = Event->timer ( 3232$TICK_WATCHER = Event->timer (
2589 reentrant => 0, 3233 reentrant => 0,
2590 parked => 1, 3234 parked => 1,
2591 prio => 0, 3235 prio => 0,
2592 at => $NEXT_TICK || $TICK, 3236 at => $NEXT_TICK || $TICK,
2596 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3240 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2597 unless ++$bug_warning > 10; 3241 unless ++$bug_warning > 10;
2598 return; 3242 return;
2599 } 3243 }
2600 3244
2601 $NOW = Event::time; 3245 $NOW = $tick_start = Event::time;
2602 3246
2603 cf::server_tick; # one server iteration 3247 cf::server_tick; # one server iteration
3248
3249 0 && sync_job {#d#
3250 for(1..10) {
3251 my $t = Event::time;
3252 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3253 or die;
3254
3255 $map->width (50);
3256 $map->height (50);
3257 $map->alloc;
3258 $map->_load_objects ("/tmp/x.map", 1);
3259 my $t = Event::time - $t;
3260
3261 #next unless $t < 0.0013;#d#
3262 if ($t < $min) {
3263 $min = $t;
3264 }
3265 $avg = $avg * 0.99 + $t * 0.01;
3266 }
3267 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3268 exit 0;
3269 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3270 };
3271
2604 $RUNTIME += $TICK; 3272 $RUNTIME += $TICK;
2605 $NEXT_TICK += $TICK; 3273 $NEXT_TICK += $TICK;
2606 3274
2607 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3275 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2608 $NEXT_RUNTIME_WRITE = $NOW + 10; 3276 $NEXT_RUNTIME_WRITE = $NOW + 10;
2610 write_runtime 3278 write_runtime
2611 or warn "ERROR: unable to write runtime file: $!"; 3279 or warn "ERROR: unable to write runtime file: $!";
2612 }; 3280 };
2613 } 3281 }
2614 3282
2615 $WAIT_FOR_TICK->broadcast;
2616 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2617
2618# my $AFTER = Event::time; 3283# my $AFTER = Event::time;
2619# warn $AFTER - $NOW;#d# 3284# warn $AFTER - $NOW;#d#
2620 3285
3286 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3287 $sig->send;
3288 }
3289 while (my $sig = shift @WAIT_FOR_TICK) {
3290 $sig->send;
3291 }
3292
3293 $NOW = Event::time;
3294
2621 # if we are delayed by four ticks or more, skip them all 3295 # if we are delayed by four ticks or more, skip them all
2622 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3296 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2623 3297
2624 $TICK_WATCHER->at ($NEXT_TICK); 3298 $TICK_WATCHER->at ($NEXT_TICK);
2625 $TICK_WATCHER->start; 3299 $TICK_WATCHER->start;
3300
3301 $LOAD = ($NOW - $tick_start) / $TICK;
3302 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3303
3304 _post_tick;
3305
3306
2626 }, 3307 },
2627); 3308);
2628 3309
2629{ 3310{
2630 BDB::max_poll_time $TICK * 0.1; 3311 BDB::max_poll_time $TICK * 0.1;
2658 3339
2659 cf::sync_job { 3340 cf::sync_job {
2660 eval { 3341 eval {
2661 BDB::db_env_open 3342 BDB::db_env_open
2662 $DB_ENV, 3343 $DB_ENV,
2663 $BDB_ENV_DIR, 3344 $BDBDIR,
2664 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3345 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2665 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3346 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2666 0666; 3347 0666;
2667 3348
2668 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3349 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2669 3350
2670 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3351 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2671 $DB_ENV->set_lk_detect; 3352 $DB_ENV->set_lk_detect;
2672 }; 3353 };
2673 3354
2689 prio => 6, 3370 prio => 6,
2690 cb => \&IO::AIO::poll_cb, 3371 cb => \&IO::AIO::poll_cb,
2691 ); 3372 );
2692} 3373}
2693 3374
3375my $_log_backtrace;
3376
3377sub _log_backtrace {
3378 my ($msg, @addr) = @_;
3379
3380 $msg =~ s/\n//;
3381
3382 # limit the # of concurrent backtraces
3383 if ($_log_backtrace < 2) {
3384 ++$_log_backtrace;
3385 async {
3386 my @bt = fork_call {
3387 @addr = map { sprintf "%x", $_ } @addr;
3388 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3389 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3390 or die "addr2line: $!";
3391
3392 my @funcs;
3393 my @res = <$fh>;
3394 chomp for @res;
3395 while (@res) {
3396 my ($func, $line) = splice @res, 0, 2, ();
3397 push @funcs, "[$func] $line";
3398 }
3399
3400 @funcs
3401 };
3402
3403 LOG llevInfo, "[ABT] $msg\n";
3404 LOG llevInfo, "[ABT] $_\n" for @bt;
3405 --$_log_backtrace;
3406 };
3407 } else {
3408 LOG llevInfo, "[ABT] $msg\n";
3409 LOG llevInfo, "[ABT] [suppressed]\n";
3410 }
3411}
3412
3413# load additional modules
3414use cf::pod;
3415
2694END { cf::emergency_save } 3416END { cf::emergency_save }
2695 3417
26961 34181
2697 3419

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines