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.315 by root, Mon Jul 23 17:53:55 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) {
878 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
879 if (my %reply = $cb->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
880 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
886 1194
887 cf::override; 1195 cf::override;
888 }, 1196 },
889); 1197);
890 1198
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 { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
926 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
927 next unless -r $ext; 1204 next unless -r $path;
928 eval { 1205
929 load_extension $ext; 1206 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1207 my $base = $1;
1208 my $pkg = $1;
1209 $pkg =~ s/[^[:word:]]/_/g;
1210 $pkg = "ext::$pkg";
1211
1212 open my $fh, "<:utf8", $path
1213 or die "$path: $!";
1214
1215 my $source = do { local $/; <$fh> };
1216
1217 my %ext = (
1218 path => $path,
1219 base => $base,
1220 pkg => $pkg,
1221 );
1222
1223 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1224 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1225
1226 $ext{source} =
1227 "package $pkg; use strict; use utf8;\n"
1228 . "#line 1 \"$path\"\n{\n"
1229 . $source
1230 . "\n};\n1";
1231
1232 $todo{$base} = \%ext;
1233 }
1234
1235 my %done;
1236 while (%todo) {
1237 my $progress;
1238
1239 while (my ($k, $v) = each %todo) {
1240 for (split /,\s*/, $v->{meta}{depends}) {
1241 goto skip
1242 unless exists $done{$_};
1243 }
1244
1245 warn "... loading '$k' into '$v->{pkg}'\n";
1246
1247 unless (eval $v->{source}) {
1248 my $msg = $@ ? "$v->{path}: $@\n"
1249 : "$v->{base}: extension inactive.\n";
1250
1251 if (exists $v->{meta}{mandatory}) {
1252 warn $msg;
1253 warn "mandatory extension failed to load, exiting.\n";
1254 exit 1;
1255 }
1256
1257 warn $msg;
1258 }
1259
1260 $done{$k} = delete $todo{$k};
1261 push @EXTS, $v->{pkg};
1262 $progress = 1;
930 1 1263 }
931 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
932 } 1269 };
933} 1270}
934 1271
935############################################################################# 1272#############################################################################
936 1273
1274=back
1275
937=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
938 1277
939Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
940 1279
941=cut 1280=cut
953Returns the given player object, loading it if necessary (might block). 1292Returns the given player object, loading it if necessary (might block).
954 1293
955=cut 1294=cut
956 1295
957sub playerdir($) { 1296sub playerdir($) {
958 cf::localdir 1297 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1298 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1299}
964 1300
965sub path($) { 1301sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1302 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
967 1303
968 (playerdir $login) . "/$login.pl" 1304 (playerdir $login) . "/playerdata"
969} 1305}
970 1306
971sub find_active($) { 1307sub find_active($) {
972 $cf::PLAYER{$_[0]} 1308 $cf::PLAYER{$_[0]}
973 and $cf::PLAYER{$_[0]}->active 1309 and $cf::PLAYER{$_[0]}->active
986 my $login = $_[0]; 1322 my $login = $_[0];
987 1323
988 my $guard = cf::lock_acquire "user_find:$login"; 1324 my $guard = cf::lock_acquire "user_find:$login";
989 1325
990 $cf::PLAYER{$_[0]} || do { 1326 $cf::PLAYER{$_[0]} || do {
1327 # rename old playerfiles to new ones
1328 #TODO: remove when no longer required
1329 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1330 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1331 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1332 aio_unlink +(playerdir $login) . "/$login.pl";
1333
991 my $pl = load_pl path $login 1334 my $pl = load_pl path $login
992 or return; 1335 or return;
993 $cf::PLAYER{$login} = $pl 1336 $cf::PLAYER{$login} = $pl
994 } 1337 }
995 } 1338 }
1079while and may block, so not sync_job-capable, ever. 1422while and may block, so not sync_job-capable, ever.
1080 1423
1081=cut 1424=cut
1082 1425
1083sub list_logins { 1426sub list_logins {
1084 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1427 my $dirs = aio_readdir $PLAYERDIR
1085 or return []; 1428 or return [];
1086 1429
1087 my @logins; 1430 my @logins;
1088 1431
1089 for my $login (@$dirs) { 1432 for my $login (@$dirs) {
1124 } 1467 }
1125 1468
1126 \@paths 1469 \@paths
1127} 1470}
1128 1471
1472=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1473
1474Expand crossfire pod fragments into protocol xml.
1475
1476=cut
1477
1478sub expand_cfpod {
1479 ((my $self), (local $_)) = @_;
1480
1481 # escape & and <
1482 s/&/&amp;/g;
1483 s/(?<![BIUGH])</&lt;/g;
1484
1485 # this is buggy, it needs to properly take care of nested <'s
1486
1487 1 while
1488 # replace B<>, I<>, U<> etc.
1489 s/B<([^\>]*)>/<b>$1<\/b>/
1490 || s/I<([^\>]*)>/<i>$1<\/i>/
1491 || s/U<([^\>]*)>/<u>$1<\/u>/
1492 # replace G<male|female> tags
1493 || s{G<([^>|]*)\|([^>]*)>}{
1494 $self->gender ? $2 : $1
1495 }ge
1496 # replace H<hint text>
1497 || s{H<([^\>]*)>}
1498 {
1499 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1500 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1501 "")
1502 [$self->{hintmode}]
1503 }ge;
1504
1505 # create single paragraphs (very hackish)
1506 s/(?<=\S)\n(?=\w)/ /g;
1507
1508 # compress some whitespace
1509 s/\s+\n/\n/g; # ws line-ends
1510 s/\n\n+/\n/g; # double lines
1511 s/^\n+//; # beginning lines
1512 s/\n+$//; # ending lines
1513
1514 $_
1515}
1516
1517sub hintmode {
1518 $_[0]{hintmode} = $_[1] if @_ > 1;
1519 $_[0]{hintmode}
1520}
1521
1129=item $player->ext_reply ($msgid, %msg) 1522=item $player->ext_reply ($msgid, %msg)
1130 1523
1131Sends an ext reply to the player. 1524Sends an ext reply to the player.
1132 1525
1133=cut 1526=cut
1134 1527
1135sub ext_reply($$%) { 1528sub ext_reply($$%) {
1136 my ($self, $id, %msg) = @_; 1529 my ($self, $id, %msg) = @_;
1137 1530
1138 $msg{msgid} = $id; 1531 $msg{msgid} = $id;
1139 1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1140 $self->send ("ext " . cf::to_json \%msg);
1141} 1533}
1142 1534
1143=item $player->ext_event ($type, %msg) 1535=item $player->ext_event ($type, %msg)
1144 1536
1145Sends an ext event to the client. 1537Sends an ext event to the client.
1147=cut 1539=cut
1148 1540
1149sub ext_event($$%) { 1541sub ext_event($$%) {
1150 my ($self, $type, %msg) = @_; 1542 my ($self, $type, %msg) = @_;
1151 1543
1152 delete $msg{msgid}; 1544 $self->ns->ext_event ($type, %msg);
1153 $msg{msgtype} = "event";
1154 $msg{eventtype} = $type;
1155
1156 $self->send ("ext " . cf::to_json \%msg);
1157} 1545}
1158 1546
1159package cf; 1547=head3 cf::region
1548
1549=over 4
1550
1551=cut
1552
1553package cf::region;
1554
1555=item cf::region::find_by_path $path
1556
1557Tries to decuce the likely region for a map knowing only its path.
1558
1559=cut
1560
1561sub find_by_path($) {
1562 my ($path) = @_;
1563
1564 my ($match, $specificity);
1565
1566 for my $region (list) {
1567 if ($region->{match} && $path =~ $region->{match}) {
1568 ($match, $specificity) = ($region, $region->specificity)
1569 if $region->specificity > $specificity;
1570 }
1571 }
1572
1573 $match
1574}
1160 1575
1161=back 1576=back
1162
1163 1577
1164=head3 cf::map 1578=head3 cf::map
1165 1579
1166=over 4 1580=over 4
1167 1581
1222 my ($self, $merge) = @_; 1636 my ($self, $merge) = @_;
1223 1637
1224 # we have to keep some variables in memory intact 1638 # we have to keep some variables in memory intact
1225 local $self->{path}; 1639 local $self->{path};
1226 local $self->{load_path}; 1640 local $self->{load_path};
1227 local $self->{deny_save};
1228 local $self->{deny_reset};
1229 1641
1230 $self->SUPER::thawer_merge ($merge); 1642 $self->SUPER::thawer_merge ($merge);
1231} 1643}
1232 1644
1233sub normalise { 1645sub normalise {
1280 $self->init; # pass $1 etc. 1692 $self->init; # pass $1 etc.
1281 return $self; 1693 return $self;
1282 } 1694 }
1283 } 1695 }
1284 1696
1285 Carp::carp "unable to resolve path '$path' (base '$base')."; 1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1286 () 1698 ()
1287} 1699}
1288 1700
1289sub init { 1701sub init {
1290 my ($self) = @_; 1702 my ($self) = @_;
1305 1717
1306# the original (read-only) location 1718# the original (read-only) location
1307sub load_path { 1719sub load_path {
1308 my ($self) = @_; 1720 my ($self) = @_;
1309 1721
1310 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1722 "$MAPDIR/$self->{path}.map"
1311} 1723}
1312 1724
1313# the temporary/swap location 1725# the temporary/swap location
1314sub save_path { 1726sub save_path {
1315 my ($self) = @_; 1727 my ($self) = @_;
1316 1728
1317 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1729 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1318 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1730 "$TMPDIR/$path.map"
1319} 1731}
1320 1732
1321# the unique path, undef == no special unique path 1733# the unique path, undef == no special unique path
1322sub uniq_path { 1734sub uniq_path {
1323 my ($self) = @_; 1735 my ($self) = @_;
1324 1736
1325 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1737 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1326 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1738 "$UNIQUEDIR/$path"
1327} 1739}
1328 1740
1329# and all this just because we cannot iterate over 1741# and all this just because we cannot iterate over
1330# all maps in C++... 1742# all maps in C++...
1331sub change_all_map_light { 1743sub change_all_map_light {
1332 my ($change) = @_; 1744 my ($change) = @_;
1333 1745
1334 $_->change_map_light ($change) 1746 $_->change_map_light ($change)
1335 for grep $_->outdoor, values %cf::MAP; 1747 for grep $_->outdoor, values %cf::MAP;
1748}
1749
1750sub decay_objects {
1751 my ($self) = @_;
1752
1753 return if $self->{deny_reset};
1754
1755 $self->do_decay_objects;
1336} 1756}
1337 1757
1338sub unlink_save { 1758sub unlink_save {
1339 my ($self) = @_; 1759 my ($self) = @_;
1340 1760
1398 $self->load_header_orig 1818 $self->load_header_orig
1399 or return; 1819 or return;
1400 $self->prepare_orig; 1820 $self->prepare_orig;
1401 } 1821 }
1402 1822
1823 $self->{deny_reset} = 1
1824 if $self->no_reset;
1825
1826 $self->default_region (cf::region::find_by_path $self->{path})
1827 unless $self->default_region;
1828
1403 1 1829 1
1404} 1830}
1405 1831
1406sub find; 1832sub find;
1407sub find { 1833sub find {
1419 $map->{last_save} = $cf::RUNTIME; 1845 $map->{last_save} = $cf::RUNTIME;
1420 1846
1421 $map->load_header 1847 $map->load_header
1422 or return; 1848 or return;
1423 1849
1424 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1425 # doing this can freeze the server in a sync job, obviously 1851 # doing this can freeze the server in a sync job, obviously
1426 #$cf::WAIT_FOR_TICK->wait; 1852 #$cf::WAIT_FOR_TICK->wait;
1427 $map->reset; 1853 $map->reset;
1428 undef $guard; 1854 undef $guard;
1429 return find $path; 1855 return find $path;
1440 my ($self) = @_; 1866 my ($self) = @_;
1441 1867
1442 local $self->{deny_reset} = 1; # loading can take a long time 1868 local $self->{deny_reset} = 1; # loading can take a long time
1443 1869
1444 my $path = $self->{path}; 1870 my $path = $self->{path};
1871
1872 {
1445 my $guard = cf::lock_acquire "map_load:$path"; 1873 my $guard = cf::lock_acquire "map_load:$path";
1446 1874
1447 return if $self->in_memory != cf::MAP_SWAPPED; 1875 return if $self->in_memory != cf::MAP_SWAPPED;
1448 1876
1449 $self->in_memory (cf::MAP_LOADING); 1877 $self->in_memory (cf::MAP_LOADING);
1450 1878
1451 $self->alloc; 1879 $self->alloc;
1452 1880
1453 $self->pre_load; 1881 $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; 1882 Coro::cede;
1479 $self->set_darkness_map; 1883
1884 $self->_load_objects ($self->{load_path}, 1)
1885 or return;
1886
1887 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1888 if delete $self->{load_original};
1889
1890 if (my $uniq = $self->uniq_path) {
1891 utf8::encode $uniq;
1892 if (aio_open $uniq, O_RDONLY, 0) {
1893 $self->clear_unique_items;
1894 $self->_load_objects ($uniq, 0);
1895 }
1896 }
1897
1898 Coro::cede;
1899 # now do the right thing for maps
1900 $self->link_multipart_objects;
1480 $self->difficulty ($self->estimate_difficulty) 1901 $self->difficulty ($self->estimate_difficulty)
1481 unless $self->difficulty; 1902 unless $self->difficulty;
1482 Coro::cede; 1903 Coro::cede;
1904
1905 unless ($self->{deny_activate}) {
1906 $self->decay_objects;
1907 $self->fix_auto_apply;
1908 $self->update_buttons;
1909 Coro::cede;
1910 $self->set_darkness_map;
1911 Coro::cede;
1483 $self->activate; 1912 $self->activate;
1913 }
1914
1915 $self->in_memory (cf::MAP_IN_MEMORY);
1484 } 1916 }
1485 1917
1486 $self->post_load; 1918 $self->post_load;
1487
1488 $self->in_memory (cf::MAP_IN_MEMORY);
1489} 1919}
1490 1920
1491sub customise_for { 1921sub customise_for {
1492 my ($self, $ob) = @_; 1922 my ($self, $ob) = @_;
1493 1923
1494 return find "~" . $ob->name . "/" . $self->{path} 1924 return find "~" . $ob->name . "/" . $self->{path}
1495 if $self->per_player; 1925 if $self->per_player;
1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1496 1929
1497 $self 1930 $self
1498} 1931}
1499 1932
1500# find and load all maps in the 3x3 area around a map 1933# find and load all maps in the 3x3 area around a map
1547 1980
1548 undef $MAP_PREFETCH{$path}; 1981 undef $MAP_PREFETCH{$path};
1549 $MAP_PREFETCHER ||= cf::async { 1982 $MAP_PREFETCHER ||= cf::async {
1550 while (%MAP_PREFETCH) { 1983 while (%MAP_PREFETCH) {
1551 for my $path (keys %MAP_PREFETCH) { 1984 for my $path (keys %MAP_PREFETCH) {
1552 my $map = find $path 1985 if (my $map = find $path) {
1553 or next;
1554 $map->load; 1986 $map->load;
1987 }
1555 1988
1556 delete $MAP_PREFETCH{$path}; 1989 delete $MAP_PREFETCH{$path};
1557 } 1990 }
1558 } 1991 }
1559 undef $MAP_PREFETCHER; 1992 undef $MAP_PREFETCHER;
1611 2044
1612sub reset_at { 2045sub reset_at {
1613 my ($self) = @_; 2046 my ($self) = @_;
1614 2047
1615 # TODO: safety, remove and allow resettable per-player maps 2048 # 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}; 2049 return 1e99 if $self->{deny_reset};
1618 2050
1619 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1620 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1621 2053
1632 my ($self) = @_; 2064 my ($self) = @_;
1633 2065
1634 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1635 2067
1636 return if $self->players; 2068 return if $self->players;
1637 return if $self->isa ("ext::map_per_player");#d#
1638 2069
1639 warn "resetting map ", $self->path;#d# 2070 warn "resetting map ", $self->path;
1640 2071
1641 $self->in_memory (cf::MAP_SWAPPED); 2072 $self->in_memory (cf::MAP_SWAPPED);
1642 2073
1643 # need to save uniques path 2074 # need to save uniques path
1644 unless ($self->{deny_save}) { 2075 unless ($self->{deny_save}) {
1676 $cf::MAP{$self->path} = $self; 2107 $cf::MAP{$self->path} = $self;
1677 2108
1678 $self->reset; # polite request, might not happen 2109 $self->reset; # polite request, might not happen
1679} 2110}
1680 2111
2112=item $maps = cf::map::tmp_maps
2113
2114Returns an arrayref with all map paths of currently instantiated and saved
2115maps. May block.
2116
2117=cut
2118
2119sub tmp_maps() {
2120 [
2121 map {
2122 utf8::decode $_;
2123 /\.map$/
2124 ? normalise $_
2125 : ()
2126 } @{ aio_readdir $TMPDIR or [] }
2127 ]
2128}
2129
2130=item $maps = cf::map::random_maps
2131
2132Returns an arrayref with all map paths of currently instantiated and saved
2133random maps. May block.
2134
2135=cut
2136
2137sub random_maps() {
2138 [
2139 map {
2140 utf8::decode $_;
2141 /\.map$/
2142 ? normalise "?random/$_"
2143 : ()
2144 } @{ aio_readdir $RANDOMDIR or [] }
2145 ]
2146}
2147
1681=item cf::map::unique_maps 2148=item cf::map::unique_maps
1682 2149
1683Returns an arrayref of paths of all shared maps that have 2150Returns an arrayref of paths of all shared maps that have
1684instantiated unique items. May block. 2151instantiated unique items. May block.
1685 2152
1686=cut 2153=cut
1687 2154
1688sub unique_maps() { 2155sub unique_maps() {
1689 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2156 [
1690 or return; 2157 map {
1691
1692 my @paths;
1693
1694 for (@$files) {
1695 utf8::decode $_; 2158 utf8::decode $_;
1696 next if /\.pst$/; 2159 /\.map$/
1697 next unless /^$PATH_SEP/o; 2160 ? normalise $_
1698 2161 : ()
1699 push @paths, cf::map::normalise $_; 2162 } @{ aio_readdir $UNIQUEDIR or [] }
1700 } 2163 ]
1701
1702 \@paths
1703} 2164}
1704 2165
1705package cf; 2166package cf;
1706 2167
1707=back 2168=back
1753 2214
1754 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1755 2216
1756 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1757 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1758 } else { 2220 } else {
2221 my $pl = $self->contr;
2222
2223 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2224 my $diag = $pl->{npc_dialog};
2225 $diag->{pl}->ext_reply (
2226 $diag->{id},
2227 msgtype => "reply",
2228 msg => $diag->{pl}->expand_cfpod ($msg),
2229 add_topics => []
2230 );
2231
2232 } else {
1759 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1760 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1761 } 2236 }
1762} 2237}
1763 2238
1764=item $player_object->may ("access") 2239=item $player_object->may ("access")
1765 2240
1813 $self->deactivate_recursive; 2288 $self->deactivate_recursive;
1814 2289
1815 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2290 return if UNIVERSAL::isa $self->map, "ext::map_link";
1816 2291
1817 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2292 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1818 if $self->map; 2293 if $self->map && $self->map->{path} ne "{link}";
1819 2294
1820 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2295 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1821} 2296}
1822 2297
1823sub cf::object::player::leave_link { 2298sub cf::object::player::leave_link {
1824 my ($self, $map, $x, $y) = @_; 2299 my ($self, $map, $x, $y) = @_;
2300
2301 return unless $self->contr->active;
1825 2302
1826 my $link_pos = delete $self->{_link_pos}; 2303 my $link_pos = delete $self->{_link_pos};
1827 2304
1828 unless ($map) { 2305 unless ($map) {
1829 # restore original map position 2306 # restore original map position
1852 2329
1853 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1854 $self->enter_map ($map, $x, $y); 2331 $self->enter_map ($map, $x, $y);
1855} 2332}
1856 2333
1857cf::player->attach ( 2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1858 on_logout => sub {
1859 my ($pl) = @_;
1860 2335
1861 # abort map switching before logout 2336Moves the player to the given map-path and coordinates by first freezing
1862 if ($pl->ob->{_link_pos}) { 2337her, loading and preparing them map, calling the provided $check callback
1863 cf::sync_job { 2338that has to return the map if sucecssful, and then unfreezes the player on
1864 $pl->ob->leave_link 2339the new (success) or old (failed) map position. In either case, $done will
1865 }; 2340be called at the end of this process.
1866 }
1867 },
1868 on_login => sub {
1869 my ($pl) = @_;
1870 2341
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 2342=cut
2343
2344our $GOTOGEN;
1892 2345
1893sub cf::object::player::goto { 2346sub cf::object::player::goto {
1894 my ($self, $path, $x, $y) = @_; 2347 my ($self, $path, $x, $y, $check, $done) = @_;
2348
2349 # do generation counting so two concurrent goto's will be executed in-order
2350 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1895 2351
1896 $self->enter_link; 2352 $self->enter_link;
1897 2353
1898 (async { 2354 (async {
1899 my $map = eval { 2355 my $map = eval {
1900 my $map = cf::map::find $path; 2356 my $map = cf::map::find $path;
2357
2358 if ($map) {
1901 $map = $map->customise_for ($self) if $map; 2359 $map = $map->customise_for ($self);
2360 $map = $check->($map) if $check && $map;
2361 } else {
2362 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2363 }
2364
1902 $map 2365 $map
2366 };
2367
2368 if ($@) {
2369 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2370 LOG llevError | logBacktrace, Carp::longmess $@;
1903 } or 2371 }
1904 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1905 2372
2373 if ($gen == $self->{_goto_generation}) {
2374 delete $self->{_goto_generation};
1906 $self->leave_link ($map, $x, $y); 2375 $self->leave_link ($map, $x, $y);
2376 }
2377
2378 $done->() if $done;
1907 })->prio (1); 2379 })->prio (1);
1908} 2380}
1909 2381
1910=item $player_object->enter_exit ($exit_object) 2382=item $player_object->enter_exit ($exit_object)
1911 2383
1950 2422
1951 $rmp->{random_seed} ||= $exit->random_seed; 2423 $rmp->{random_seed} ||= $exit->random_seed;
1952 2424
1953 my $data = cf::to_json $rmp; 2425 my $data = cf::to_json $rmp;
1954 my $md5 = Digest::MD5::md5_hex $data; 2426 my $md5 = Digest::MD5::md5_hex $data;
1955 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2427 my $meta = "$RANDOMDIR/$md5.meta";
1956 2428
1957 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2429 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1958 aio_write $fh, 0, (length $data), $data, 0; 2430 aio_write $fh, 0, (length $data), $data, 0;
1959 undef $fh; 2431 undef $fh;
1960 aio_rename "$meta~", $meta; 2432 aio_rename "$meta~", $meta;
1969 2441
1970 return unless $self->type == cf::PLAYER; 2442 return unless $self->type == cf::PLAYER;
1971 2443
1972 if ($exit->slaying eq "/!") { 2444 if ($exit->slaying eq "/!") {
1973 #TODO: this should de-fi-ni-te-ly not be a sync-job 2445 #TODO: this should de-fi-ni-te-ly not be a sync-job
2446 # the problem is that $exit might not survive long enough
2447 # so it needs to be done right now, right here
1974 cf::sync_job { prepare_random_map $exit }; 2448 cf::sync_job { prepare_random_map $exit };
1975 } 2449 }
1976 2450
1977 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2451 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1978 my $hp = $exit->stats->hp; 2452 my $hp = $exit->stats->hp;
1979 my $sp = $exit->stats->sp; 2453 my $sp = $exit->stats->sp;
1980 2454
1981 $self->enter_link; 2455 $self->enter_link;
2456
2457 # if exit is damned, update players death & WoR home-position
2458 $self->contr->savebed ($slaying, $hp, $sp)
2459 if $exit->flag (FLAG_DAMNED);
1982 2460
1983 (async { 2461 (async {
1984 $self->deactivate_recursive; # just to be sure 2462 $self->deactivate_recursive; # just to be sure
1985 unless (eval { 2463 unless (eval {
1986 $self->goto ($slaying, $hp, $sp); 2464 $self->goto ($slaying, $hp, $sp);
1987 2465
1988 1; 2466 1;
1989 }) { 2467 }) {
1990 $self->message ("Something went wrong deep within the crossfire server. " 2468 $self->message ("Something went wrong deep within the crossfire server. "
1991 . "I'll try to bring you back to the map you were before. " 2469 . "I'll try to bring you back to the map you were before. "
1992 . "Please report this to the dungeon master!", 2470 . "Please report this to the dungeon master!",
1993 cf::NDI_UNIQUE | cf::NDI_RED); 2471 cf::NDI_UNIQUE | cf::NDI_RED);
1994 2472
1995 warn "ERROR in enter_exit: $@"; 2473 warn "ERROR in enter_exit: $@";
1996 $self->leave_link; 2474 $self->leave_link;
1997 } 2475 }
1998 })->prio (1); 2476 })->prio (1);
2014 2492
2015 utf8::encode $text; 2493 utf8::encode $text;
2016 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2017} 2495}
2018 2496
2497=item $client->send_msg ($channel, $msg, $color, [extra...])
2498
2499Send a drawinfo or msg packet to the client, formatting the msg for the
2500client if neccessary. C<$type> should be a string identifying the type of
2501the message, with C<log> being the default. If C<$color> is negative, suppress
2502the message unless the client supports the msg packet.
2503
2504=cut
2505
2506sub cf::client::send_msg {
2507 my ($self, $channel, $msg, $color, @extra) = @_;
2508
2509 $msg = $self->pl->expand_cfpod ($msg);
2510
2511 $color &= ~cf::NDI_UNIQUE; # just in case...
2512
2513 if (ref $channel) {
2514 # send meta info to client, if not yet sent
2515 unless (exists $self->{channel}{$channel->{id}}) {
2516 $self->{channel}{$channel->{id}} = $channel;
2517 $self->ext_event (channel_info => %$channel);
2518 }
2519
2520 $channel = $channel->{id};
2521 }
2522
2523 return unless @extra || length $msg;
2524
2525 if ($self->can_msg) {
2526 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2527 } else {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 if ($color >= 0) {
2539 if (0 && $msg =~ /\[/) {
2540 $self->send_packet ("drawextinfo $color 4 0 $msg")
2541 } else {
2542 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2543 $self->send_packet ("drawinfo $color $msg")
2544 }
2545 }
2546 }
2547}
2548
2549=item $client->ext_event ($type, %msg)
2550
2551Sends an ext event to the client.
2552
2553=cut
2554
2555sub cf::client::ext_event($$%) {
2556 my ($self, $type, %msg) = @_;
2557
2558 return unless $self->extcmd;
2559
2560 $msg{msgtype} = "event_$type";
2561 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2562}
2019 2563
2020=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
2021 2565
2022Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
2023the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2567the 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>. 2568C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2025 2569
2026Queries can fail, so check the return code. Or don't, as queries will become 2570Queries can fail, so check the return code. Or don't, as queries will
2027reliable at some point in the future. 2571become reliable at some point in the future.
2028 2572
2029=cut 2573=cut
2030 2574
2031sub cf::client::query { 2575sub cf::client::query {
2032 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
2040 utf8::encode $text; 2584 utf8::encode $text;
2041 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2042 2586
2043 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
2044 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
2045} 2591}
2046 2592
2047cf::client->attach ( 2593cf::client->attach (
2594 on_connect => sub {
2595 my ($ns) = @_;
2596
2597 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2598 },
2048 on_reply => sub { 2599 on_reply => sub {
2049 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
2050 2601
2051 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
2052 # get handled first 2603 # get handled first
2064 } else { 2615 } else {
2065 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2066 } 2617 }
2067 } 2618 }
2068 }, 2619 },
2620 on_exticmd => sub {
2621 my ($ns, $buf) = @_;
2622
2623 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2624
2625 if (ref $msg) {
2626 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2627 if (my %reply = $cb->($ns, $msg)) {
2628 $reply{msgid} = $msg->{msgid};
2629 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2630 }
2631 }
2632 } else {
2633 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2634 }
2635
2636 cf::override;
2637 },
2069); 2638);
2070 2639
2071=item $client->async (\&cb) 2640=item $client->async (\&cb)
2072 2641
2073Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
2122 2691
2123=pod 2692=pod
2124 2693
2125The following functions and methods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
2126 2695
2127 cf::object contr pay_amount pay_player map 2696 cf::object
2697 contr pay_amount pay_player map x y force_find force_add
2698 insert remove
2699
2128 cf::object::player player 2700 cf::object::player
2129 cf::player peaceful 2701 player
2130 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
2131 2708
2132=cut 2709=cut
2133 2710
2134for ( 2711for (
2135 ["cf::object" => qw(contr pay_amount pay_player map)], 2712 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2713 insert remove)],
2136 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
2137 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
2138 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
2139) { 2717) {
2140 no strict 'refs'; 2718 no strict 'refs';
2211=back 2789=back
2212 2790
2213=cut 2791=cut
2214 2792
2215############################################################################# 2793#############################################################################
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 2794# the server's init and main functions
2289 2795
2290sub load_facedata { 2796sub load_facedata($) {
2291 my $path = sprintf "%s/facedata", cf::datadir; 2797 my ($path) = @_;
2292 2798
2293 warn "loading facedata from $path\n"; 2799 warn "loading facedata from $path\n";
2294 2800
2295 my $faces; 2801 my $facedata;
2296 0 < aio_load $path, $faces 2802 0 < aio_load $path, $facedata
2297 or die "$path: $!"; 2803 or die "$path: $!";
2298 2804
2299 Coro::cede;
2300 $faces = Storable::thaw $faces; 2805 $facedata = Coro::Storable::thaw $facedata;
2301 Coro::cede;
2302 2806
2303 my $meta = delete $faces->{""};
2304 $meta->{version} == 1 2807 $facedata->{version} == 2
2305 or cf::cleanup "$path: version mismatch, cannot proceed."; 2808 or cf::cleanup "$path: version mismatch, cannot proceed.";
2306 2809
2810 {
2811 my $faces = $facedata->{faceinfo};
2812
2307 while (my ($face, $info) = each %$faces) { 2813 while (my ($face, $info) = each %$faces) {
2308 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2814 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2309 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2815 cf::face::set_visibility $idx, $info->{visibility};
2816 cf::face::set_magicmap $idx, $info->{magicmap};
2310 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2817 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2311 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2818 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2312 Coro::cede;
2313 }
2314 2819
2820 cf::cede_to_tick;
2821 }
2822
2315 while (my ($face, $info) = each %$faces) { 2823 while (my ($face, $info) = each %$faces) {
2316 next unless $info->{smooth}; 2824 next unless $info->{smooth};
2317 my $idx = cf::face::find $face 2825 my $idx = cf::face::find $face
2318 or next; 2826 or next;
2319 if (my $smooth = cf::face::find $info->{smooth}) { 2827 if (my $smooth = cf::face::find $info->{smooth}) {
2320 cf::face::set_smooth $idx, $smooth; 2828 cf::face::set_smooth $idx, $smooth;
2829 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2321 } else { 2830 } else {
2322 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2831 warn "smooth face '$info->{smooth}' not found for face '$face'";
2323 } 2832 }
2324 Coro::cede; 2833
2834 cf::cede_to_tick;
2835 }
2836 }
2837
2838 {
2839 my $anims = $facedata->{animinfo};
2840
2841 while (my ($anim, $info) = each %$anims) {
2842 cf::anim::set $anim, $info->{frames}, $info->{facings};
2843 cf::cede_to_tick;
2844 }
2845
2846 cf::anim::invalidate_all; # d'oh
2847 }
2848
2849 {
2850 # TODO: for gcfclient pleasure, we should give resources
2851 # that gcfclient doesn't grok a >10000 face index.
2852 my $res = $facedata->{resource};
2853 my $enc = JSON::XS->new->utf8->canonical;
2854
2855 while (my ($name, $info) = each %$res) {
2856 my $meta = $enc->encode ({
2857 name => $name,
2858 type => $info->{type},
2859 copyright => $info->{copyright}, #TODO#
2860 });
2861
2862 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2863
2864 if ($name =~ /\.jpg$/) {
2865 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2866 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2867 } else {
2868 my $data = pack "(w/a*)*", $meta, $info->{data};
2869 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2870
2871 cf::face::set_type $idx, 1;
2872 cf::face::set_data $idx, 0, $data, $chk;
2873 }
2874
2875 cf::cede_to_tick;
2876 }
2325 } 2877 }
2326 2878
2327 1 2879 1
2328} 2880}
2329 2881
2882sub reload_regions {
2883 load_resource_file "$MAPDIR/regions"
2884 or die "unable to load regions file\n";
2885
2886 for (cf::region::list) {
2887 $_->{match} = qr/$_->{match}/
2888 if exists $_->{match};
2889 }
2890}
2891
2892sub reload_facedata {
2893 load_facedata "$DATADIR/facedata"
2894 or die "unable to load facedata\n";
2895}
2896
2897sub reload_archetypes {
2898 load_resource_file "$DATADIR/archetypes"
2899 or die "unable to load archetypes\n";
2900 #d# NEED to laod twice to resolve forward references
2901 # this really needs to be done in an extra post-pass
2902 # (which needs to be synchronous, so solve it differently)
2903 load_resource_file "$DATADIR/archetypes"
2904 or die "unable to load archetypes\n";
2905}
2906
2907sub reload_treasures {
2908 load_resource_file "$DATADIR/treasures"
2909 or die "unable to load treasurelists\n";
2910}
2911
2330sub reload_resources { 2912sub reload_resources {
2331 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2913 warn "reloading resource files...\n";
2332 or die "unable to load regions file\n";#d# 2914
2915 reload_regions;
2333 load_facedata 2916 reload_facedata;
2334 or die "unable to load facedata\n";#d# 2917 #reload_archetypes;#d#
2918 reload_archetypes;
2919 reload_treasures;
2920
2921 warn "finished reloading resource files\n";
2335} 2922}
2336 2923
2337sub init { 2924sub init {
2338 reload_resources; 2925 reload_resources;
2339} 2926}
2340 2927
2341sub cfg_load { 2928sub cfg_load {
2342 open my $fh, "<:utf8", cf::confdir . "/config" 2929 open my $fh, "<:utf8", "$CONFDIR/config"
2343 or return; 2930 or return;
2344 2931
2345 local $/; 2932 local $/;
2346 *CFG = YAML::Syck::Load <$fh>; 2933 *CFG = YAML::Syck::Load <$fh>;
2347 2934
2392 }, 2979 },
2393 ); 2980 );
2394 } 2981 }
2395} 2982}
2396 2983
2984sub write_runtime {
2985 my $runtime = "$LOCALDIR/runtime";
2986
2987 # first touch the runtime file to show we are still running:
2988 # the fsync below can take a very very long time.
2989
2990 IO::AIO::aio_utime $runtime, undef, undef;
2991
2992 my $guard = cf::lock_acquire "write_runtime";
2993
2994 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2995 or return;
2996
2997 my $value = $cf::RUNTIME + 90 + 10;
2998 # 10 is the runtime save interval, for a monotonic clock
2999 # 60 allows for the watchdog to kill the server.
3000
3001 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3002 and return;
3003
3004 # always fsync - this file is important
3005 aio_fsync $fh
3006 and return;
3007
3008 # touch it again to show we are up-to-date
3009 aio_utime $fh, undef, undef;
3010
3011 close $fh
3012 or return;
3013
3014 aio_rename "$runtime~", $runtime
3015 and return;
3016
3017 warn "runtime file written.\n";
3018
3019 1
3020}
3021
2397sub emergency_save() { 3022sub emergency_save() {
2398 my $freeze_guard = cf::freeze_mainloop; 3023 my $freeze_guard = cf::freeze_mainloop;
2399 3024
2400 warn "enter emergency perl save\n"; 3025 warn "enter emergency perl save\n";
2401 3026
2432 3057
2433 warn Carp::longmess "post_cleanup backtrace" 3058 warn Carp::longmess "post_cleanup backtrace"
2434 if $make_core; 3059 if $make_core;
2435} 3060}
2436 3061
2437sub reload() { 3062sub do_reload_perl() {
2438 # can/must only be called in main 3063 # can/must only be called in main
2439 if ($Coro::current != $Coro::main) { 3064 if ($Coro::current != $Coro::main) {
2440 warn "can only reload from main coroutine"; 3065 warn "can only reload from main coroutine";
2441 return; 3066 return;
2442 } 3067 }
2476 %EXT_CORO = (); 3101 %EXT_CORO = ();
2477 3102
2478 warn "removing commands"; 3103 warn "removing commands";
2479 %COMMAND = (); 3104 %COMMAND = ();
2480 3105
2481 warn "removing ext commands"; 3106 warn "removing ext/exti commands";
2482 %EXTCMD = (); 3107 %EXTCMD = ();
3108 %EXTICMD = ();
2483 3109
2484 warn "unloading/nuking all extensions"; 3110 warn "unloading/nuking all extensions";
2485 for my $pkg (@EXTS) { 3111 for my $pkg (@EXTS) {
2486 warn "... unloading $pkg"; 3112 warn "... unloading $pkg";
2487 3113
2517 Symbol::delete_package "safe::$_" 3143 Symbol::delete_package "safe::$_"
2518 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3144 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2519 3145
2520 warn "unloading cf.pm \"a bit\""; 3146 warn "unloading cf.pm \"a bit\"";
2521 delete $INC{"cf.pm"}; 3147 delete $INC{"cf.pm"};
3148 delete $INC{"cf/pod.pm"};
2522 3149
2523 # don't, removes xs symbols, too, 3150 # don't, removes xs symbols, too,
2524 # and global variables created in xs 3151 # and global variables created in xs
2525 #Symbol::delete_package __PACKAGE__; 3152 #Symbol::delete_package __PACKAGE__;
2526 3153
2541 warn "reattaching attachments to maps"; 3168 warn "reattaching attachments to maps";
2542 reattach $_ for values %MAP; 3169 reattach $_ for values %MAP;
2543 warn "reattaching attachments to players"; 3170 warn "reattaching attachments to players";
2544 reattach $_ for values %PLAYER; 3171 reattach $_ for values %PLAYER;
2545 3172
2546 warn "loading reloadable resources";
2547 reload_resources;
2548
2549 warn "leaving sync_job"; 3173 warn "leaving sync_job";
2550 3174
2551 1 3175 1
2552 } or do { 3176 } or do {
2553 warn $@; 3177 warn $@;
2558 warn "reloaded"; 3182 warn "reloaded";
2559}; 3183};
2560 3184
2561our $RELOAD_WATCHER; # used only during reload 3185our $RELOAD_WATCHER; # used only during reload
2562 3186
3187sub reload_perl() {
3188 # doing reload synchronously and two reloads happen back-to-back,
3189 # coro crashes during coro_state_free->destroy here.
3190
3191 $RELOAD_WATCHER ||= Event->timer (
3192 reentrant => 0,
3193 after => 0,
3194 data => WF_AUTOCANCEL,
3195 cb => sub {
3196 do_reload_perl;
3197 undef $RELOAD_WATCHER;
3198 },
3199 );
3200}
3201
2563register_command "reload" => sub { 3202register_command "reload" => sub {
2564 my ($who, $arg) = @_; 3203 my ($who, $arg) = @_;
2565 3204
2566 if ($who->flag (FLAG_WIZ)) { 3205 if ($who->flag (FLAG_WIZ)) {
2567 $who->message ("reloading server."); 3206 $who->message ("reloading server.");
2568 3207 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 } 3208 }
2582}; 3209};
2583 3210
2584unshift @INC, $LIBDIR; 3211unshift @INC, $LIBDIR;
2585 3212
2586my $bug_warning = 0; 3213my $bug_warning = 0;
2587 3214
3215our @WAIT_FOR_TICK;
3216our @WAIT_FOR_TICK_BEGIN;
3217
3218sub wait_for_tick {
3219 return unless $TICK_WATCHER->is_active;
3220 return if $Coro::current == $Coro::main;
3221
3222 my $signal = new Coro::Signal;
3223 push @WAIT_FOR_TICK, $signal;
3224 $signal->wait;
3225}
3226
3227sub wait_for_tick_begin {
3228 return unless $TICK_WATCHER->is_active;
3229 return if $Coro::current == $Coro::main;
3230
3231 my $signal = new Coro::Signal;
3232 push @WAIT_FOR_TICK_BEGIN, $signal;
3233 $signal->wait;
3234}
3235
3236 my $min = 1e6;#d#
3237 my $avg = 10;
2588$TICK_WATCHER = Event->timer ( 3238$TICK_WATCHER = Event->timer (
2589 reentrant => 0, 3239 reentrant => 0,
2590 parked => 1, 3240 parked => 1,
2591 prio => 0, 3241 prio => 0,
2592 at => $NEXT_TICK || $TICK, 3242 at => $NEXT_TICK || $TICK,
2596 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3246 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2597 unless ++$bug_warning > 10; 3247 unless ++$bug_warning > 10;
2598 return; 3248 return;
2599 } 3249 }
2600 3250
2601 $NOW = Event::time; 3251 $NOW = $tick_start = Event::time;
2602 3252
2603 cf::server_tick; # one server iteration 3253 cf::server_tick; # one server iteration
3254
3255 0 && sync_job {#d#
3256 for(1..10) {
3257 my $t = Event::time;
3258 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3259 or die;
3260
3261 $map->width (50);
3262 $map->height (50);
3263 $map->alloc;
3264 $map->_load_objects ("/tmp/x.map", 1);
3265 my $t = Event::time - $t;
3266
3267 #next unless $t < 0.0013;#d#
3268 if ($t < $min) {
3269 $min = $t;
3270 }
3271 $avg = $avg * 0.99 + $t * 0.01;
3272 }
3273 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3274 exit 0;
3275 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3276 };
3277
2604 $RUNTIME += $TICK; 3278 $RUNTIME += $TICK;
2605 $NEXT_TICK += $TICK; 3279 $NEXT_TICK += $TICK;
2606 3280
2607 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3281 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2608 $NEXT_RUNTIME_WRITE = $NOW + 10; 3282 $NEXT_RUNTIME_WRITE = $NOW + 10;
2610 write_runtime 3284 write_runtime
2611 or warn "ERROR: unable to write runtime file: $!"; 3285 or warn "ERROR: unable to write runtime file: $!";
2612 }; 3286 };
2613 } 3287 }
2614 3288
2615 $WAIT_FOR_TICK->broadcast;
2616 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2617
2618# my $AFTER = Event::time; 3289# my $AFTER = Event::time;
2619# warn $AFTER - $NOW;#d# 3290# warn $AFTER - $NOW;#d#
2620 3291
3292 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3293 $sig->send;
3294 }
3295 while (my $sig = shift @WAIT_FOR_TICK) {
3296 $sig->send;
3297 }
3298
3299 $NOW = Event::time;
3300
2621 # if we are delayed by four ticks or more, skip them all 3301 # if we are delayed by four ticks or more, skip them all
2622 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3302 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2623 3303
2624 $TICK_WATCHER->at ($NEXT_TICK); 3304 $TICK_WATCHER->at ($NEXT_TICK);
2625 $TICK_WATCHER->start; 3305 $TICK_WATCHER->start;
3306
3307 $LOAD = ($NOW - $tick_start) / $TICK;
3308 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3309
3310 _post_tick;
3311
3312
2626 }, 3313 },
2627); 3314);
2628 3315
2629{ 3316{
2630 BDB::max_poll_time $TICK * 0.1; 3317 BDB::max_poll_time $TICK * 0.1;
2658 3345
2659 cf::sync_job { 3346 cf::sync_job {
2660 eval { 3347 eval {
2661 BDB::db_env_open 3348 BDB::db_env_open
2662 $DB_ENV, 3349 $DB_ENV,
2663 $BDB_ENV_DIR, 3350 $BDBDIR,
2664 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3351 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2665 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3352 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2666 0666; 3353 0666;
2667 3354
2668 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3355 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2669 3356
2670 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3357 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2671 $DB_ENV->set_lk_detect; 3358 $DB_ENV->set_lk_detect;
2672 }; 3359 };
2673 3360
2689 prio => 6, 3376 prio => 6,
2690 cb => \&IO::AIO::poll_cb, 3377 cb => \&IO::AIO::poll_cb,
2691 ); 3378 );
2692} 3379}
2693 3380
3381my $_log_backtrace;
3382
3383sub _log_backtrace {
3384 my ($msg, @addr) = @_;
3385
3386 $msg =~ s/\n//;
3387
3388 # limit the # of concurrent backtraces
3389 if ($_log_backtrace < 2) {
3390 ++$_log_backtrace;
3391 async {
3392 my @bt = fork_call {
3393 @addr = map { sprintf "%x", $_ } @addr;
3394 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3395 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3396 or die "addr2line: $!";
3397
3398 my @funcs;
3399 my @res = <$fh>;
3400 chomp for @res;
3401 while (@res) {
3402 my ($func, $line) = splice @res, 0, 2, ();
3403 push @funcs, "[$func] $line";
3404 }
3405
3406 @funcs
3407 };
3408
3409 LOG llevInfo, "[ABT] $msg\n";
3410 LOG llevInfo, "[ABT] $_\n" for @bt;
3411 --$_log_backtrace;
3412 };
3413 } else {
3414 LOG llevInfo, "[ABT] $msg\n";
3415 LOG llevInfo, "[ABT] [suppressed]\n";
3416 }
3417}
3418
3419# load additional modules
3420use cf::pod;
3421
2694END { cf::emergency_save } 3422END { cf::emergency_save }
2695 3423
26961 34241
2697 3425

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines