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.230 by root, Mon Apr 2 18:04:46 2007 UTC vs.
Revision 1.325 by root, Sat Jul 28 14:32:22 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[, $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
275=item cf::async { BLOCK } 383=item cf::async { BLOCK }
276 384
277Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
278C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
279thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
282 390
283BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
284 392
285=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
286 394
287The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 396is 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. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
290 399
291If it must be done, put the blocking parts into C<sync_job>. This will run 400If 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 401the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
294fast or be very important. 403fast or be very important.
297 406
298sub sync_job(&) { 407sub sync_job(&) {
299 my ($job) = @_; 408 my ($job) = @_;
300 409
301 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
302 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
304 415
305 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 417 # (but this is cancel-safe)
317 428
318 while ($busy) { 429 while ($busy) {
319 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
320 } 431 }
321 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
322 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
323 } else { 441 } else {
324 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
325 443
326 $job->() 444 $job->()
345 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
346 464
347 $coro 465 $coro
348} 466}
349 467
350sub write_runtime { 468=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 469
353 my $runtime = cf::localdir . "/runtime"; 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.
354 474
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
356 or return;
357 476
358 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
359 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
360 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
361 480 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 481 close $fh;
370 or return;
371 482
372 aio_rename "$runtime~", $runtime 483 $buf
373 and return; 484}
374 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;
375 1 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"
376} 644}
377 645
378=item cf::datalog type => key => value, ... 646=item cf::datalog type => key => value, ...
379 647
380Log a datalog packet of the given type with the given key-value pairs. 648Log 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") 666attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
400 668
401In 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>
402C<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
403crossfire+). 671Crossfire TRT).
404 672
405=over 4 673=over 4
406 674
407=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
408 676
571 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
572 840
573 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
574 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
575 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
576 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
577 845
578 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
579 my $pkg = shift @arg; 847 my $pkg = shift @arg;
580 848
581 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
610 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
611 } 879 }
612 880
613 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
614 } else { 882 } else {
615 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
616 } 884 }
617 885
618 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
619} 887}
620 888
622 if (ref $_[0]) { 890 if (ref $_[0]) {
623 _object_attach @_; 891 _object_attach @_;
624 } else { 892 } else {
625 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
626 } 894 }
895 _recalc_want;
627}; 896};
628 897
629# all those should be optimised 898# all those should be optimised
630sub cf::attachable::detach { 899sub cf::attachable::detach {
631 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
634 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
635 reattach ($obj); 904 reattach ($obj);
636 } else { 905 } else {
637 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
638 } 907 }
908 _recalc_want;
639}; 909};
640 910
641sub cf::attachable::attached { 911sub cf::attachable::attached {
642 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
643 913
658 "; 928 ";
659 die if $@; 929 die if $@;
660} 930}
661 931
662our $override; 932our $override;
663our @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?
664 934
665sub override { 935sub override {
666 $override = 1; 936 $override = 1;
667 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
668} 938}
669 939
670sub do_invoke { 940sub do_invoke {
671 my $event = shift; 941 my $event = shift;
672 my $callbacks = shift; 942 my $callbacks = shift;
673 943
674 @invoke_results = (); 944 @INVOKE_RESULTS = ();
675 945
676 local $override; 946 local $override;
677 947
678 for (@$callbacks) { 948 for (@$callbacks) {
679 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
696 966
697Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
698 968
699This 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
700removed 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
701results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
702 972
703=back 973=back
704 974
705=cut 975=cut
706 976
707############################################################################# 977#############################################################################
708# 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}
709 990
710sub reattach { 991sub reattach {
711 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
712 my ($obj) = @_; 993 my ($obj) = @_;
713 994
816 or return; 1097 or return;
817 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
818 } 1099 }
819 1100
820 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
821 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
822 return ($data, $av); 1103 return ($data, $av);
823} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
824 1111
825############################################################################# 1112#############################################################################
826# command handling &c 1113# command handling &c
827 1114
828=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
841 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
842} 1129}
843 1130
844=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
845 1132
846Register 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.
847 1138
848If 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
849called. 1140called.
850 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
851=cut 1153=cut
852 1154
853sub register_extcmd { 1155sub register_extcmd {
854 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
855 1157
856 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
857} 1165}
858 1166
859cf::player->attach ( 1167cf::player->attach (
860 on_command => sub { 1168 on_command => sub {
861 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
870 cf::override; 1178 cf::override;
871 }, 1179 },
872 on_extcmd => sub { 1180 on_extcmd => sub {
873 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
874 1182
875 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
876 1184
877 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
878 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
879 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
880 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
881 } 1195 if $reply;
882 } 1196 }
883 } else { 1197 } else {
884 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
885 } 1199 }
886 1200
887 cf::override; 1201 cf::override;
888 }, 1202 },
889); 1203);
890 1204
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 { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
926 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
927 next unless -r $ext; 1210 next unless -r $path;
928 eval { 1211
929 load_extension $ext; 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;
930 1 1269 }
931 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
932 } 1275 };
933} 1276}
934 1277
935############################################################################# 1278#############################################################################
936 1279
1280=back
1281
937=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
938 1283
939Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
940 1285
941=cut 1286=cut
953Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
954 1299
955=cut 1300=cut
956 1301
957sub playerdir($) { 1302sub playerdir($) {
958 cf::localdir 1303 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1305}
964 1306
965sub path($) { 1307sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
967 1309
968 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
969} 1311}
970 1312
971sub find_active($) { 1313sub find_active($) {
972 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
973 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
986 my $login = $_[0]; 1328 my $login = $_[0];
987 1329
988 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
989 1331
990 $cf::PLAYER{$_[0]} || do { 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
991 my $pl = load_pl path $login 1340 my $pl = load_pl path $login
992 or return; 1341 or return;
993 $cf::PLAYER{$login} = $pl 1342 $cf::PLAYER{$login} = $pl
994 } 1343 }
995 } 1344 }
1079while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1080 1429
1081=cut 1430=cut
1082 1431
1083sub list_logins { 1432sub list_logins {
1084 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1085 or return []; 1434 or return [];
1086 1435
1087 my @logins; 1436 my @logins;
1088 1437
1089 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1124 } 1473 }
1125 1474
1126 \@paths 1475 \@paths
1127} 1476}
1128 1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1129=item $player->ext_reply ($msgid, $msgtype, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1130 1529
1131Sends an ext reply to the player. 1530Sends an ext reply to the player.
1132 1531
1133=cut 1532=cut
1134 1533
1135sub ext_reply($$$%) { 1534sub ext_reply($$@) {
1136 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1137 1536
1138 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1139 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1140 $self->send ("ext " . cf::to_json \%msg); 1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1141} 1544}
1142 1545
1143package cf; 1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1144 1586
1145=back 1587=back
1146
1147 1588
1148=head3 cf::map 1589=head3 cf::map
1149 1590
1150=over 4 1591=over 4
1151 1592
1206 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1207 1648
1208 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1209 local $self->{path}; 1650 local $self->{path};
1210 local $self->{load_path}; 1651 local $self->{load_path};
1211 local $self->{deny_save};
1212 local $self->{deny_reset};
1213 1652
1214 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1215} 1654}
1216 1655
1217sub normalise { 1656sub normalise {
1264 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1265 return $self; 1704 return $self;
1266 } 1705 }
1267 } 1706 }
1268 1707
1269 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1270 () 1709 ()
1271} 1710}
1272 1711
1273sub init { 1712sub init {
1274 my ($self) = @_; 1713 my ($self) = @_;
1289 1728
1290# the original (read-only) location 1729# the original (read-only) location
1291sub load_path { 1730sub load_path {
1292 my ($self) = @_; 1731 my ($self) = @_;
1293 1732
1294 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1295} 1734}
1296 1735
1297# the temporary/swap location 1736# the temporary/swap location
1298sub save_path { 1737sub save_path {
1299 my ($self) = @_; 1738 my ($self) = @_;
1300 1739
1301 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1302 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1303} 1742}
1304 1743
1305# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1306sub uniq_path { 1745sub uniq_path {
1307 my ($self) = @_; 1746 my ($self) = @_;
1308 1747
1309 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1310 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1311} 1750}
1312 1751
1313# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1314# all maps in C++... 1753# all maps in C++...
1315sub change_all_map_light { 1754sub change_all_map_light {
1316 my ($change) = @_; 1755 my ($change) = @_;
1317 1756
1318 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1319 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1759}
1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1320} 1767}
1321 1768
1322sub unlink_save { 1769sub unlink_save {
1323 my ($self) = @_; 1770 my ($self) = @_;
1324 1771
1382 $self->load_header_orig 1829 $self->load_header_orig
1383 or return; 1830 or return;
1384 $self->prepare_orig; 1831 $self->prepare_orig;
1385 } 1832 }
1386 1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1839
1387 1 1840 1
1388} 1841}
1389 1842
1390sub find; 1843sub find;
1391sub find { 1844sub find {
1403 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1404 1857
1405 $map->load_header 1858 $map->load_header
1406 or return; 1859 or return;
1407 1860
1408 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1409 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1410 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1411 $map->reset; 1864 $map->reset;
1412 undef $guard; 1865 undef $guard;
1413 return find $path; 1866 return find $path;
1424 my ($self) = @_; 1877 my ($self) = @_;
1425 1878
1426 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1427 1880
1428 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1429 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1430 1885
1431 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1432 1887
1433 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1434 1889
1435 $self->alloc; 1890 $self->alloc;
1436 1891
1437 $self->pre_load; 1892 $self->pre_load;
1438
1439 $self->_load_objects ($self->{load_path}, 1)
1440 or return;
1441
1442 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1443 if delete $self->{load_original};
1444
1445 if (my $uniq = $self->uniq_path) {
1446 utf8::encode $uniq;
1447 if (aio_open $uniq, O_RDONLY, 0) {
1448 $self->clear_unique_items;
1449 $self->_load_objects ($uniq, 0);
1450 }
1451 }
1452
1453 Coro::cede;
1454
1455 # now do the right thing for maps
1456 $self->link_multipart_objects;
1457
1458 unless ($self->{deny_activate}) {
1459 $self->decay_objects;
1460 $self->fix_auto_apply;
1461 $self->update_buttons;
1462 Coro::cede; 1893 Coro::cede;
1463 $self->set_darkness_map; 1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
1906 }
1907 }
1908
1909 Coro::cede;
1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1464 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1465 unless $self->difficulty; 1913 unless $self->difficulty;
1466 Coro::cede; 1914 Coro::cede;
1915
1916 unless ($self->{deny_activate}) {
1917 $self->decay_objects;
1918 $self->fix_auto_apply;
1919 $self->update_buttons;
1920 Coro::cede;
1921 $self->set_darkness_map;
1922 Coro::cede;
1467 $self->activate; 1923 $self->activate;
1924 }
1925
1926 $self->{last_save} = $cf::RUNTIME;
1927 $self->last_access ($cf::RUNTIME);
1928
1929 $self->in_memory (cf::MAP_IN_MEMORY);
1468 } 1930 }
1469 1931
1470 $self->post_load; 1932 $self->post_load;
1471
1472 $self->in_memory (cf::MAP_IN_MEMORY);
1473} 1933}
1474 1934
1475sub customise_for { 1935sub customise_for {
1476 my ($self, $ob) = @_; 1936 my ($self, $ob) = @_;
1477 1937
1478 return find "~" . $ob->name . "/" . $self->{path} 1938 return find "~" . $ob->name . "/" . $self->{path}
1479 if $self->per_player; 1939 if $self->per_player;
1940
1941# return find "?party/" . $ob->name . "/" . $self->{path}
1942# if $self->per_party;
1480 1943
1481 $self 1944 $self
1482} 1945}
1483 1946
1484# find and load all maps in the 3x3 area around a map 1947# find and load all maps in the 3x3 area around a map
1531 1994
1532 undef $MAP_PREFETCH{$path}; 1995 undef $MAP_PREFETCH{$path};
1533 $MAP_PREFETCHER ||= cf::async { 1996 $MAP_PREFETCHER ||= cf::async {
1534 while (%MAP_PREFETCH) { 1997 while (%MAP_PREFETCH) {
1535 for my $path (keys %MAP_PREFETCH) { 1998 for my $path (keys %MAP_PREFETCH) {
1536 my $map = find $path 1999 if (my $map = find $path) {
1537 or next;
1538 $map->load; 2000 $map->load;
2001 }
1539 2002
1540 delete $MAP_PREFETCH{$path}; 2003 delete $MAP_PREFETCH{$path};
1541 } 2004 }
1542 } 2005 }
1543 undef $MAP_PREFETCHER; 2006 undef $MAP_PREFETCHER;
1595 2058
1596sub reset_at { 2059sub reset_at {
1597 my ($self) = @_; 2060 my ($self) = @_;
1598 2061
1599 # TODO: safety, remove and allow resettable per-player maps 2062 # TODO: safety, remove and allow resettable per-player maps
1600 return 1e99 if $self->isa ("ext::map_per_player");#d#
1601 return 1e99 if $self->{deny_reset}; 2063 return 1e99 if $self->{deny_reset};
1602 2064
1603 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2065 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1604 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2066 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1605 2067
1616 my ($self) = @_; 2078 my ($self) = @_;
1617 2079
1618 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2080 my $lock = cf::lock_acquire "map_data:$self->{path}";
1619 2081
1620 return if $self->players; 2082 return if $self->players;
1621 return if $self->isa ("ext::map_per_player");#d#
1622 2083
1623 warn "resetting map ", $self->path;#d# 2084 warn "resetting map ", $self->path;
1624 2085
1625 $self->in_memory (cf::MAP_SWAPPED); 2086 $self->in_memory (cf::MAP_SWAPPED);
1626 2087
1627 # need to save uniques path 2088 # need to save uniques path
1628 unless ($self->{deny_save}) { 2089 unless ($self->{deny_save}) {
1660 $cf::MAP{$self->path} = $self; 2121 $cf::MAP{$self->path} = $self;
1661 2122
1662 $self->reset; # polite request, might not happen 2123 $self->reset; # polite request, might not happen
1663} 2124}
1664 2125
2126=item $maps = cf::map::tmp_maps
2127
2128Returns an arrayref with all map paths of currently instantiated and saved
2129maps. May block.
2130
2131=cut
2132
2133sub tmp_maps() {
2134 [
2135 map {
2136 utf8::decode $_;
2137 /\.map$/
2138 ? normalise $_
2139 : ()
2140 } @{ aio_readdir $TMPDIR or [] }
2141 ]
2142}
2143
2144=item $maps = cf::map::random_maps
2145
2146Returns an arrayref with all map paths of currently instantiated and saved
2147random maps. May block.
2148
2149=cut
2150
2151sub random_maps() {
2152 [
2153 map {
2154 utf8::decode $_;
2155 /\.map$/
2156 ? normalise "?random/$_"
2157 : ()
2158 } @{ aio_readdir $RANDOMDIR or [] }
2159 ]
2160}
2161
1665=item cf::map::unique_maps 2162=item cf::map::unique_maps
1666 2163
1667Returns an arrayref of paths of all shared maps that have 2164Returns an arrayref of paths of all shared maps that have
1668instantiated unique items. May block. 2165instantiated unique items. May block.
1669 2166
1670=cut 2167=cut
1671 2168
1672sub unique_maps() { 2169sub unique_maps() {
1673 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2170 [
1674 or return; 2171 map {
1675
1676 my @paths;
1677
1678 for (@$files) {
1679 utf8::decode $_; 2172 utf8::decode $_;
1680 next if /\.pst$/; 2173 /\.map$/
1681 next unless /^$PATH_SEP/o; 2174 ? normalise $_
1682 2175 : ()
1683 push @paths, cf::map::normalise $_; 2176 } @{ aio_readdir $UNIQUEDIR or [] }
1684 } 2177 ]
1685
1686 \@paths
1687} 2178}
1688 2179
1689package cf; 2180package cf;
1690 2181
1691=back 2182=back
1737 2228
1738 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2229 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1739 2230
1740 if ($self->{record_replies}) { 2231 if ($self->{record_replies}) {
1741 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2232 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2233
1742 } else { 2234 } else {
2235 my $pl = $self->contr;
2236
2237 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2238 my $dialog = $pl->{npc_dialog};
2239 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2240
2241 } else {
1743 $msg = $npc->name . " says: $msg" if $npc; 2242 $msg = $npc->name . " says: $msg" if $npc;
1744 $self->message ($msg, $flags); 2243 $self->message ($msg, $flags);
2244 }
1745 } 2245 }
1746} 2246}
1747 2247
1748=item $player_object->may ("access") 2248=item $player_object->may ("access")
1749 2249
1797 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1798 2298
1799 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1800 2300
1801 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1802 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1803 2303
1804 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1805} 2305}
1806 2306
1807sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1808 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1809 2311
1810 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1811 2313
1812 unless ($map) { 2314 unless ($map) {
1813 # restore original map position 2315 # restore original map position
1836 2338
1837 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1838 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1839} 2341}
1840 2342
1841cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1842 on_logout => sub {
1843 my ($pl) = @_;
1844 2344
1845 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1846 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1847 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1848 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1849 }; 2349be called at the end of this process.
1850 }
1851 },
1852 on_login => sub {
1853 my ($pl) = @_;
1854 2350
1855 # try to abort aborted map switching on player login :)
1856 # should happen only on crashes
1857 if ($pl->ob->{_link_pos}) {
1858 $pl->ob->enter_link;
1859 (async {
1860 $pl->ob->reply (undef,
1861 "There was an internal problem at your last logout, "
1862 . "the server will try to bring you to your intended destination in a second.",
1863 cf::NDI_RED);
1864 # we need this sleep as the login has a concurrent enter_exit running
1865 # and this sleep increases chances of the player not ending up in scorn
1866 Coro::Timer::sleep 1;
1867 $pl->ob->leave_link;
1868 })->prio (2);
1869 }
1870 },
1871);
1872
1873=item $player_object->goto ($path, $x, $y)
1874
1875=cut 2351=cut
2352
2353our $GOTOGEN;
1876 2354
1877sub cf::object::player::goto { 2355sub cf::object::player::goto {
1878 my ($self, $path, $x, $y) = @_; 2356 my ($self, $path, $x, $y, $check, $done) = @_;
2357
2358 # do generation counting so two concurrent goto's will be executed in-order
2359 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1879 2360
1880 $self->enter_link; 2361 $self->enter_link;
1881 2362
1882 (async { 2363 (async {
1883 my $map = eval { 2364 my $map = eval {
1884 my $map = cf::map::find $path; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1885 $map = $map->customise_for ($self) if $map; 2368 $map = $map->customise_for ($self);
2369 $map = $check->($map) if $check && $map;
2370 } else {
2371 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2372 }
2373
1886 $map 2374 $map
2375 };
2376
2377 if ($@) {
2378 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2379 LOG llevError | logBacktrace, Carp::longmess $@;
1887 } or 2380 }
1888 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1889 2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1890 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1891 })->prio (1); 2388 })->prio (1);
1892} 2389}
1893 2390
1894=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1895 2392
1934 2431
1935 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1936 2433
1937 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1938 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
1939 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2436 my $meta = "$RANDOMDIR/$md5.meta";
1940 2437
1941 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1942 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
1943 undef $fh; 2440 undef $fh;
1944 aio_rename "$meta~", $meta; 2441 aio_rename "$meta~", $meta;
1953 2450
1954 return unless $self->type == cf::PLAYER; 2451 return unless $self->type == cf::PLAYER;
1955 2452
1956 if ($exit->slaying eq "/!") { 2453 if ($exit->slaying eq "/!") {
1957 #TODO: this should de-fi-ni-te-ly not be a sync-job 2454 #TODO: this should de-fi-ni-te-ly not be a sync-job
2455 # the problem is that $exit might not survive long enough
2456 # so it needs to be done right now, right here
1958 cf::sync_job { prepare_random_map $exit }; 2457 cf::sync_job { prepare_random_map $exit };
1959 } 2458 }
1960 2459
1961 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2460 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1962 my $hp = $exit->stats->hp; 2461 my $hp = $exit->stats->hp;
1963 my $sp = $exit->stats->sp; 2462 my $sp = $exit->stats->sp;
1964 2463
1965 $self->enter_link; 2464 $self->enter_link;
2465
2466 # if exit is damned, update players death & WoR home-position
2467 $self->contr->savebed ($slaying, $hp, $sp)
2468 if $exit->flag (FLAG_DAMNED);
1966 2469
1967 (async { 2470 (async {
1968 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
1969 unless (eval { 2472 unless (eval {
1970 $self->goto ($slaying, $hp, $sp); 2473 $self->goto ($slaying, $hp, $sp);
1971 2474
1972 1; 2475 1;
1973 }) { 2476 }) {
1974 $self->message ("Something went wrong deep within the crossfire server. " 2477 $self->message ("Something went wrong deep within the crossfire server. "
1975 . "I'll try to bring you back to the map you were before. " 2478 . "I'll try to bring you back to the map you were before. "
1976 . "Please report this to the dungeon master!", 2479 . "Please report this to the dungeon master!",
1977 cf::NDI_UNIQUE | cf::NDI_RED); 2480 cf::NDI_UNIQUE | cf::NDI_RED);
1978 2481
1979 warn "ERROR in enter_exit: $@"; 2482 warn "ERROR in enter_exit: $@";
1980 $self->leave_link; 2483 $self->leave_link;
1981 } 2484 }
1982 })->prio (1); 2485 })->prio (1);
1998 2501
1999 utf8::encode $text; 2502 utf8::encode $text;
2000 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2503 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2001} 2504}
2002 2505
2506=item $client->send_msg ($channel, $msg, $color, [extra...])
2507
2508Send a drawinfo or msg packet to the client, formatting the msg for the
2509client if neccessary. C<$type> should be a string identifying the type of
2510the message, with C<log> being the default. If C<$color> is negative, suppress
2511the message unless the client supports the msg packet.
2512
2513=cut
2514
2515sub cf::client::send_msg {
2516 my ($self, $channel, $msg, $color, @extra) = @_;
2517
2518 $msg = $self->pl->expand_cfpod ($msg);
2519
2520 $color &= cf::NDI_CLIENT_MASK; # just in case...
2521
2522 if (ref $channel) {
2523 # send meta info to client, if not yet sent
2524 unless (exists $self->{channel}{$channel->{id}}) {
2525 $self->{channel}{$channel->{id}} = $channel;
2526 $self->ext_msg (channel_info => $channel);
2527 }
2528
2529 $channel = $channel->{id};
2530 }
2531
2532 return unless @extra || length $msg;
2533
2534 if ($self->can_msg) {
2535 # default colour, mask it out
2536 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2537 if $color & cf::NDI_DEF;
2538
2539 $self->send_packet ("msg " . $self->{json_coder}->encode (
2540 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2541 } else {
2542 if ($color >= 0) {
2543 # replace some tags by gcfclient-compatible ones
2544 for ($msg) {
2545 1 while
2546 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2547 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2548 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2549 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2550 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2551 }
2552
2553 $color &= cf::NDI_COLOR_MASK;
2554
2555 if (0 && $msg =~ /\[/) {
2556 $self->send_packet ("drawextinfo $color 4 0 $msg")
2557 } else {
2558 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2559 $self->send_packet ("drawinfo $color $msg")
2560 }
2561 }
2562 }
2563}
2564
2565=item $client->ext_msg ($type, @msg)
2566
2567Sends an ext event to the client.
2568
2569=cut
2570
2571sub cf::client::ext_msg($$@) {
2572 my ($self, $type, @msg) = @_;
2573
2574 my $extcmd = $self->extcmd;
2575
2576 if ($extcmd == 2) {
2577 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2578 } elsif ($extcmd == 1) { # TODO: remove
2579 push @msg, msgtype => "event_$type";
2580 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2581 }
2582}
2003 2583
2004=item $success = $client->query ($flags, "text", \&cb) 2584=item $success = $client->query ($flags, "text", \&cb)
2005 2585
2006Queues a query to the client, calling the given callback with 2586Queues a query to the client, calling the given callback with
2007the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2587the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2008C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2588C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2009 2589
2010Queries can fail, so check the return code. Or don't, as queries will become 2590Queries can fail, so check the return code. Or don't, as queries will
2011reliable at some point in the future. 2591become reliable at some point in the future.
2012 2592
2013=cut 2593=cut
2014 2594
2015sub cf::client::query { 2595sub cf::client::query {
2016 my ($self, $flags, $text, $cb) = @_; 2596 my ($self, $flags, $text, $cb) = @_;
2024 utf8::encode $text; 2604 utf8::encode $text;
2025 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2605 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2026 2606
2027 $self->send_packet ($self->{query_queue}[0][0]) 2607 $self->send_packet ($self->{query_queue}[0][0])
2028 if @{ $self->{query_queue} } == 1; 2608 if @{ $self->{query_queue} } == 1;
2609
2610 1
2029} 2611}
2030 2612
2031cf::client->attach ( 2613cf::client->attach (
2614 on_connect => sub {
2615 my ($ns) = @_;
2616
2617 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2618 },
2032 on_reply => sub { 2619 on_reply => sub {
2033 my ($ns, $msg) = @_; 2620 my ($ns, $msg) = @_;
2034 2621
2035 # this weird shuffling is so that direct followup queries 2622 # this weird shuffling is so that direct followup queries
2036 # get handled first 2623 # get handled first
2048 } else { 2635 } else {
2049 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2636 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2050 } 2637 }
2051 } 2638 }
2052 }, 2639 },
2640 on_exticmd => sub {
2641 my ($ns, $buf) = @_;
2642
2643 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2644
2645 if (ref $msg) {
2646 my ($type, $reply, @payload) =
2647 "ARRAY" eq ref $msg
2648 ? @$msg
2649 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2650
2651 if (my $cb = $EXTICMD{$type}) {
2652 my @reply = $cb->($ns, @payload);
2653
2654 $ns->ext_reply ($reply, @reply)
2655 if $reply;
2656 }
2657 } else {
2658 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2659 }
2660
2661 cf::override;
2662 },
2053); 2663);
2054 2664
2055=item $client->async (\&cb) 2665=item $client->async (\&cb)
2056 2666
2057Create a new coroutine, running the specified callback. The coroutine will 2667Create a new coroutine, running the specified callback. The coroutine will
2106 2716
2107=pod 2717=pod
2108 2718
2109The following functions and methods are available within a safe environment: 2719The following functions and methods are available within a safe environment:
2110 2720
2111 cf::object contr pay_amount pay_player map 2721 cf::object
2722 contr pay_amount pay_player map x y force_find force_add
2723 insert remove
2724
2112 cf::object::player player 2725 cf::object::player
2113 cf::player peaceful 2726 player
2114 cf::map trigger 2727
2728 cf::player
2729 peaceful
2730
2731 cf::map
2732 trigger
2115 2733
2116=cut 2734=cut
2117 2735
2118for ( 2736for (
2119 ["cf::object" => qw(contr pay_amount pay_player map)], 2737 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2738 insert remove)],
2120 ["cf::object::player" => qw(player)], 2739 ["cf::object::player" => qw(player)],
2121 ["cf::player" => qw(peaceful)], 2740 ["cf::player" => qw(peaceful)],
2122 ["cf::map" => qw(trigger)], 2741 ["cf::map" => qw(trigger)],
2123) { 2742) {
2124 no strict 'refs'; 2743 no strict 'refs';
2195=back 2814=back
2196 2815
2197=cut 2816=cut
2198 2817
2199############################################################################# 2818#############################################################################
2200
2201=head2 EXTENSION DATABASE SUPPORT
2202
2203Crossfire maintains a very simple database for extension use. It can
2204currently store anything that can be serialised using Storable, which
2205excludes objects.
2206
2207The parameter C<$family> should best start with the name of the extension
2208using it, it should be unique.
2209
2210=over 4
2211
2212=item $value = cf::db_get $family => $key
2213
2214Returns a single value from the database.
2215
2216=item cf::db_put $family => $key => $value
2217
2218Stores the given C<$value> in the family.
2219
2220=cut
2221
2222our $DB;
2223
2224sub db_init {
2225 unless ($DB) {
2226 $DB = BDB::db_create $DB_ENV;
2227
2228 cf::sync_job {
2229 eval {
2230 $DB->set_flags (BDB::CHKSUM);
2231
2232 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2233 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2234 cf::cleanup "db_open(db): $!" if $!;
2235 };
2236 cf::cleanup "db_open(db): $@" if $@;
2237 };
2238
2239 my $path = cf::localdir . "/database.pst";
2240 if (stat $path) {
2241 cf::sync_job {
2242 my $pst = Storable::retrieve $path;
2243
2244 cf::db_put (board => data => $pst->{board});
2245 cf::db_put (guildrules => data => $pst->{guildrules});
2246 cf::db_put (rent => balance => $pst->{rent}{balance});
2247 BDB::db_env_txn_checkpoint $DB_ENV;
2248
2249 unlink $path;
2250 };
2251 }
2252 }
2253}
2254
2255sub db_get($$) {
2256 my $key = "$_[0]/$_[1]";
2257
2258 cf::sync_job {
2259 BDB::db_get $DB, undef, $key, my $data;
2260
2261 $! ? ()
2262 : Compress::LZF::sthaw $data
2263 }
2264}
2265
2266sub db_put($$$) {
2267 BDB::dbreq_pri 4;
2268 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2269}
2270
2271#############################################################################
2272# the server's init and main functions 2819# the server's init and main functions
2273 2820
2274sub load_facedata { 2821sub load_facedata($) {
2275 my $path = sprintf "%s/facedata", cf::datadir; 2822 my ($path) = @_;
2276 2823
2277 warn "loading facedata from $path\n"; 2824 warn "loading facedata from $path\n";
2278 2825
2279 my $faces; 2826 my $facedata;
2280 0 < aio_load $path, $faces 2827 0 < aio_load $path, $facedata
2281 or die "$path: $!"; 2828 or die "$path: $!";
2282 2829
2283 Coro::cede;
2284 $faces = Storable::thaw $faces; 2830 $facedata = Coro::Storable::thaw $facedata;
2285 Coro::cede;
2286 2831
2287 my $meta = delete $faces->{""};
2288 $meta->{version} == 1 2832 $facedata->{version} == 2
2289 or cf::cleanup "$path: version mismatch, cannot proceed."; 2833 or cf::cleanup "$path: version mismatch, cannot proceed.";
2290 2834
2835 {
2836 my $faces = $facedata->{faceinfo};
2837
2291 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2292 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2839 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2293 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2840 cf::face::set_visibility $idx, $info->{visibility};
2841 cf::face::set_magicmap $idx, $info->{magicmap};
2294 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2842 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2295 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2843 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2296 Coro::cede;
2297 }
2298 2844
2845 cf::cede_to_tick;
2846 }
2847
2299 while (my ($face, $info) = each %$faces) { 2848 while (my ($face, $info) = each %$faces) {
2300 next unless $info->{smooth}; 2849 next unless $info->{smooth};
2301 my $idx = cf::face::find $face 2850 my $idx = cf::face::find $face
2302 or next; 2851 or next;
2303 if (my $smooth = cf::face::find $info->{smooth}) { 2852 if (my $smooth = cf::face::find $info->{smooth}) {
2304 cf::face::set_smooth $idx, $smooth; 2853 cf::face::set_smooth $idx, $smooth;
2854 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2305 } else { 2855 } else {
2306 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2856 warn "smooth face '$info->{smooth}' not found for face '$face'";
2307 } 2857 }
2308 Coro::cede; 2858
2859 cf::cede_to_tick;
2860 }
2861 }
2862
2863 {
2864 my $anims = $facedata->{animinfo};
2865
2866 while (my ($anim, $info) = each %$anims) {
2867 cf::anim::set $anim, $info->{frames}, $info->{facings};
2868 cf::cede_to_tick;
2869 }
2870
2871 cf::anim::invalidate_all; # d'oh
2872 }
2873
2874 {
2875 # TODO: for gcfclient pleasure, we should give resources
2876 # that gcfclient doesn't grok a >10000 face index.
2877 my $res = $facedata->{resource};
2878 my $enc = JSON::XS->new->utf8->canonical;
2879
2880 my $soundconf = delete $res->{"res/sound.conf"};
2881
2882 while (my ($name, $info) = each %$res) {
2883 my $meta = $enc->encode ({
2884 name => $name,
2885 %{ $info->{meta} || {} },
2886 });
2887
2888 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2889
2890 if ($info->{type} & 1) {
2891 # prepend meta info
2892
2893 my $data = pack "(w/a*)*", $meta, $info->{data};
2894 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2895
2896 cf::face::set_data $idx, 0, $data, $chk;
2897 } else {
2898 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2899 }
2900
2901 cf::face::set_type $idx, $info->{type};
2902
2903 cf::cede_to_tick;
2904 }
2905
2906 if ($soundconf) {
2907 $soundconf = $enc->decode (delete $soundconf->{data});
2908
2909 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2910 my $sound = $soundconf->{compat}[$_]
2911 or next;
2912
2913 my $face = cf::face::find "sound/$sound->[1]";
2914
2915 cf::sound::set $sound->[0] => $face;
2916 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2917 }
2918
2919 #TODO
2920 }
2309 } 2921 }
2310 2922
2311 1 2923 1
2312} 2924}
2313 2925
2926register_exticmd fx_want => sub {
2927 my ($ns, $want) = @_;
2928
2929 while (my ($k, $v) = each %$want) {
2930 $ns->fx_want ($k, $v);
2931 }
2932};
2933
2934sub reload_regions {
2935 load_resource_file "$MAPDIR/regions"
2936 or die "unable to load regions file\n";
2937
2938 for (cf::region::list) {
2939 $_->{match} = qr/$_->{match}/
2940 if exists $_->{match};
2941 }
2942}
2943
2944sub reload_facedata {
2945 load_facedata "$DATADIR/facedata"
2946 or die "unable to load facedata\n";
2947}
2948
2949sub reload_archetypes {
2950 load_resource_file "$DATADIR/archetypes"
2951 or die "unable to load archetypes\n";
2952 #d# NEED to laod twice to resolve forward references
2953 # this really needs to be done in an extra post-pass
2954 # (which needs to be synchronous, so solve it differently)
2955 load_resource_file "$DATADIR/archetypes"
2956 or die "unable to load archetypes\n";
2957}
2958
2959sub reload_treasures {
2960 load_resource_file "$DATADIR/treasures"
2961 or die "unable to load treasurelists\n";
2962}
2963
2314sub reload_resources { 2964sub reload_resources {
2315 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2965 warn "reloading resource files...\n";
2316 or die "unable to load regions file\n";#d# 2966
2967 reload_regions;
2317 load_facedata 2968 reload_facedata;
2318 or die "unable to load facedata\n";#d# 2969 #reload_archetypes;#d#
2970 reload_archetypes;
2971 reload_treasures;
2972
2973 warn "finished reloading resource files\n";
2319} 2974}
2320 2975
2321sub init { 2976sub init {
2322 reload_resources; 2977 reload_resources;
2323} 2978}
2324 2979
2325sub cfg_load { 2980sub cfg_load {
2326 open my $fh, "<:utf8", cf::confdir . "/config" 2981 open my $fh, "<:utf8", "$CONFDIR/config"
2327 or return; 2982 or return;
2328 2983
2329 local $/; 2984 local $/;
2330 *CFG = YAML::Syck::Load <$fh>; 2985 *CFG = YAML::Syck::Load <$fh>;
2331 2986
2376 }, 3031 },
2377 ); 3032 );
2378 } 3033 }
2379} 3034}
2380 3035
3036sub write_runtime {
3037 my $runtime = "$LOCALDIR/runtime";
3038
3039 # first touch the runtime file to show we are still running:
3040 # the fsync below can take a very very long time.
3041
3042 IO::AIO::aio_utime $runtime, undef, undef;
3043
3044 my $guard = cf::lock_acquire "write_runtime";
3045
3046 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3047 or return;
3048
3049 my $value = $cf::RUNTIME + 90 + 10;
3050 # 10 is the runtime save interval, for a monotonic clock
3051 # 60 allows for the watchdog to kill the server.
3052
3053 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3054 and return;
3055
3056 # always fsync - this file is important
3057 aio_fsync $fh
3058 and return;
3059
3060 # touch it again to show we are up-to-date
3061 aio_utime $fh, undef, undef;
3062
3063 close $fh
3064 or return;
3065
3066 aio_rename "$runtime~", $runtime
3067 and return;
3068
3069 warn "runtime file written.\n";
3070
3071 1
3072}
3073
2381sub emergency_save() { 3074sub emergency_save() {
2382 my $freeze_guard = cf::freeze_mainloop; 3075 my $freeze_guard = cf::freeze_mainloop;
2383 3076
2384 warn "enter emergency perl save\n"; 3077 warn "enter emergency perl save\n";
2385 3078
2416 3109
2417 warn Carp::longmess "post_cleanup backtrace" 3110 warn Carp::longmess "post_cleanup backtrace"
2418 if $make_core; 3111 if $make_core;
2419} 3112}
2420 3113
2421sub reload() { 3114sub do_reload_perl() {
2422 # can/must only be called in main 3115 # can/must only be called in main
2423 if ($Coro::current != $Coro::main) { 3116 if ($Coro::current != $Coro::main) {
2424 warn "can only reload from main coroutine"; 3117 warn "can only reload from main coroutine";
2425 return; 3118 return;
2426 } 3119 }
2460 %EXT_CORO = (); 3153 %EXT_CORO = ();
2461 3154
2462 warn "removing commands"; 3155 warn "removing commands";
2463 %COMMAND = (); 3156 %COMMAND = ();
2464 3157
2465 warn "removing ext commands"; 3158 warn "removing ext/exti commands";
2466 %EXTCMD = (); 3159 %EXTCMD = ();
3160 %EXTICMD = ();
2467 3161
2468 warn "unloading/nuking all extensions"; 3162 warn "unloading/nuking all extensions";
2469 for my $pkg (@EXTS) { 3163 for my $pkg (@EXTS) {
2470 warn "... unloading $pkg"; 3164 warn "... unloading $pkg";
2471 3165
2501 Symbol::delete_package "safe::$_" 3195 Symbol::delete_package "safe::$_"
2502 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3196 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2503 3197
2504 warn "unloading cf.pm \"a bit\""; 3198 warn "unloading cf.pm \"a bit\"";
2505 delete $INC{"cf.pm"}; 3199 delete $INC{"cf.pm"};
3200 delete $INC{"cf/pod.pm"};
2506 3201
2507 # don't, removes xs symbols, too, 3202 # don't, removes xs symbols, too,
2508 # and global variables created in xs 3203 # and global variables created in xs
2509 #Symbol::delete_package __PACKAGE__; 3204 #Symbol::delete_package __PACKAGE__;
2510 3205
2525 warn "reattaching attachments to maps"; 3220 warn "reattaching attachments to maps";
2526 reattach $_ for values %MAP; 3221 reattach $_ for values %MAP;
2527 warn "reattaching attachments to players"; 3222 warn "reattaching attachments to players";
2528 reattach $_ for values %PLAYER; 3223 reattach $_ for values %PLAYER;
2529 3224
2530 warn "loading reloadable resources";
2531 reload_resources;
2532
2533 warn "leaving sync_job"; 3225 warn "leaving sync_job";
2534 3226
2535 1 3227 1
2536 } or do { 3228 } or do {
2537 warn $@; 3229 warn $@;
2542 warn "reloaded"; 3234 warn "reloaded";
2543}; 3235};
2544 3236
2545our $RELOAD_WATCHER; # used only during reload 3237our $RELOAD_WATCHER; # used only during reload
2546 3238
3239sub reload_perl() {
3240 # doing reload synchronously and two reloads happen back-to-back,
3241 # coro crashes during coro_state_free->destroy here.
3242
3243 $RELOAD_WATCHER ||= Event->timer (
3244 reentrant => 0,
3245 after => 0,
3246 data => WF_AUTOCANCEL,
3247 cb => sub {
3248 do_reload_perl;
3249 undef $RELOAD_WATCHER;
3250 },
3251 );
3252}
3253
2547register_command "reload" => sub { 3254register_command "reload" => sub {
2548 my ($who, $arg) = @_; 3255 my ($who, $arg) = @_;
2549 3256
2550 if ($who->flag (FLAG_WIZ)) { 3257 if ($who->flag (FLAG_WIZ)) {
2551 $who->message ("reloading server."); 3258 $who->message ("reloading server.");
2552 3259 async { reload_perl };
2553 # doing reload synchronously and two reloads happen back-to-back,
2554 # coro crashes during coro_state_free->destroy here.
2555
2556 $RELOAD_WATCHER ||= Event->timer (
2557 reentrant => 0,
2558 after => 0,
2559 data => WF_AUTOCANCEL,
2560 cb => sub {
2561 reload;
2562 undef $RELOAD_WATCHER;
2563 },
2564 );
2565 } 3260 }
2566}; 3261};
2567 3262
2568unshift @INC, $LIBDIR; 3263unshift @INC, $LIBDIR;
2569 3264
2570my $bug_warning = 0; 3265my $bug_warning = 0;
2571 3266
3267our @WAIT_FOR_TICK;
3268our @WAIT_FOR_TICK_BEGIN;
3269
3270sub wait_for_tick {
3271 return unless $TICK_WATCHER->is_active;
3272 return if $Coro::current == $Coro::main;
3273
3274 my $signal = new Coro::Signal;
3275 push @WAIT_FOR_TICK, $signal;
3276 $signal->wait;
3277}
3278
3279sub wait_for_tick_begin {
3280 return unless $TICK_WATCHER->is_active;
3281 return if $Coro::current == $Coro::main;
3282
3283 my $signal = new Coro::Signal;
3284 push @WAIT_FOR_TICK_BEGIN, $signal;
3285 $signal->wait;
3286}
3287
3288 my $min = 1e6;#d#
3289 my $avg = 10;
2572$TICK_WATCHER = Event->timer ( 3290$TICK_WATCHER = Event->timer (
2573 reentrant => 0, 3291 reentrant => 0,
2574 parked => 1, 3292 parked => 1,
2575 prio => 0, 3293 prio => 0,
2576 at => $NEXT_TICK || $TICK, 3294 at => $NEXT_TICK || $TICK,
2580 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3298 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2581 unless ++$bug_warning > 10; 3299 unless ++$bug_warning > 10;
2582 return; 3300 return;
2583 } 3301 }
2584 3302
2585 $NOW = Event::time; 3303 $NOW = $tick_start = Event::time;
2586 3304
2587 cf::server_tick; # one server iteration 3305 cf::server_tick; # one server iteration
3306
3307 0 && sync_job {#d#
3308 for(1..10) {
3309 my $t = Event::time;
3310 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3311 or die;
3312
3313 $map->width (50);
3314 $map->height (50);
3315 $map->alloc;
3316 $map->_load_objects ("/tmp/x.map", 1);
3317 my $t = Event::time - $t;
3318
3319 #next unless $t < 0.0013;#d#
3320 if ($t < $min) {
3321 $min = $t;
3322 }
3323 $avg = $avg * 0.99 + $t * 0.01;
3324 }
3325 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3326 exit 0;
3327 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3328 };
3329
2588 $RUNTIME += $TICK; 3330 $RUNTIME += $TICK;
2589 $NEXT_TICK += $TICK; 3331 $NEXT_TICK += $TICK;
2590 3332
2591 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3333 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2592 $NEXT_RUNTIME_WRITE = $NOW + 10; 3334 $NEXT_RUNTIME_WRITE = $NOW + 10;
2594 write_runtime 3336 write_runtime
2595 or warn "ERROR: unable to write runtime file: $!"; 3337 or warn "ERROR: unable to write runtime file: $!";
2596 }; 3338 };
2597 } 3339 }
2598 3340
2599 $WAIT_FOR_TICK->broadcast;
2600 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2601
2602# my $AFTER = Event::time; 3341# my $AFTER = Event::time;
2603# warn $AFTER - $NOW;#d# 3342# warn $AFTER - $NOW;#d#
2604 3343
3344 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3345 $sig->send;
3346 }
3347 while (my $sig = shift @WAIT_FOR_TICK) {
3348 $sig->send;
3349 }
3350
3351 $NOW = Event::time;
3352
2605 # if we are delayed by four ticks or more, skip them all 3353 # if we are delayed by four ticks or more, skip them all
2606 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3354 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2607 3355
2608 $TICK_WATCHER->at ($NEXT_TICK); 3356 $TICK_WATCHER->at ($NEXT_TICK);
2609 $TICK_WATCHER->start; 3357 $TICK_WATCHER->start;
3358
3359 $LOAD = ($NOW - $tick_start) / $TICK;
3360 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3361
3362 _post_tick;
3363
3364
2610 }, 3365 },
2611); 3366);
2612 3367
2613{ 3368{
2614 BDB::max_poll_time $TICK * 0.1; 3369 BDB::max_poll_time $TICK * 0.1;
2642 3397
2643 cf::sync_job { 3398 cf::sync_job {
2644 eval { 3399 eval {
2645 BDB::db_env_open 3400 BDB::db_env_open
2646 $DB_ENV, 3401 $DB_ENV,
2647 $BDB_ENV_DIR, 3402 $BDBDIR,
2648 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3403 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2649 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3404 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2650 0666; 3405 0666;
2651 3406
2652 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3407 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2653 3408
2654 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3409 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2655 $DB_ENV->set_lk_detect; 3410 $DB_ENV->set_lk_detect;
2656 }; 3411 };
2657 3412
2673 prio => 6, 3428 prio => 6,
2674 cb => \&IO::AIO::poll_cb, 3429 cb => \&IO::AIO::poll_cb,
2675 ); 3430 );
2676} 3431}
2677 3432
3433my $_log_backtrace;
3434
3435sub _log_backtrace {
3436 my ($msg, @addr) = @_;
3437
3438 $msg =~ s/\n//;
3439
3440 # limit the # of concurrent backtraces
3441 if ($_log_backtrace < 2) {
3442 ++$_log_backtrace;
3443 async {
3444 my @bt = fork_call {
3445 @addr = map { sprintf "%x", $_ } @addr;
3446 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3447 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3448 or die "addr2line: $!";
3449
3450 my @funcs;
3451 my @res = <$fh>;
3452 chomp for @res;
3453 while (@res) {
3454 my ($func, $line) = splice @res, 0, 2, ();
3455 push @funcs, "[$func] $line";
3456 }
3457
3458 @funcs
3459 };
3460
3461 LOG llevInfo, "[ABT] $msg\n";
3462 LOG llevInfo, "[ABT] $_\n" for @bt;
3463 --$_log_backtrace;
3464 };
3465 } else {
3466 LOG llevInfo, "[ABT] $msg\n";
3467 LOG llevInfo, "[ABT] [suppressed]\n";
3468 }
3469}
3470
3471# load additional modules
3472use cf::pod;
3473
2678END { cf::emergency_save } 3474END { cf::emergency_save }
2679 3475
26801 34761
2681 3477

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines