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.227 by root, Fri Mar 23 18:32:48 2007 UTC vs.
Revision 1.317 by root, Mon Jul 23 23:38:17 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"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
376} 655}
377 656
378=back 657=back
379 658
380=cut 659=cut
387attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
388to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
389 668
390In 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>
391C<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
392crossfire+). 671Crossfire TRT).
393 672
394=over 4 673=over 4
395 674
396=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
397 676
560 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
561 840
562 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
563 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
564 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
565 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
566 845
567 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
568 my $pkg = shift @arg; 847 my $pkg = shift @arg;
569 848
570 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
599 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
600 } 879 }
601 880
602 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
603 } else { 882 } else {
604 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
605 } 884 }
606 885
607 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
608} 887}
609 888
611 if (ref $_[0]) { 890 if (ref $_[0]) {
612 _object_attach @_; 891 _object_attach @_;
613 } else { 892 } else {
614 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
615 } 894 }
895 _recalc_want;
616}; 896};
617 897
618# all those should be optimised 898# all those should be optimised
619sub cf::attachable::detach { 899sub cf::attachable::detach {
620 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
623 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
624 reattach ($obj); 904 reattach ($obj);
625 } else { 905 } else {
626 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
627 } 907 }
908 _recalc_want;
628}; 909};
629 910
630sub cf::attachable::attached { 911sub cf::attachable::attached {
631 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
632 913
647 "; 928 ";
648 die if $@; 929 die if $@;
649} 930}
650 931
651our $override; 932our $override;
652our @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?
653 934
654sub override { 935sub override {
655 $override = 1; 936 $override = 1;
656 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
657} 938}
658 939
659sub do_invoke { 940sub do_invoke {
660 my $event = shift; 941 my $event = shift;
661 my $callbacks = shift; 942 my $callbacks = shift;
662 943
663 @invoke_results = (); 944 @INVOKE_RESULTS = ();
664 945
665 local $override; 946 local $override;
666 947
667 for (@$callbacks) { 948 for (@$callbacks) {
668 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
685 966
686Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
687 968
688This 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
689removed 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
690results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
691 972
692=back 973=back
693 974
694=cut 975=cut
695 976
696############################################################################# 977#############################################################################
697# 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}
698 990
699sub reattach { 991sub reattach {
700 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
701 my ($obj) = @_; 993 my ($obj) = @_;
702 994
805 or return; 1097 or return;
806 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
807 } 1099 }
808 1100
809 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
810 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
811 return ($data, $av); 1103 return ($data, $av);
812} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
813 1111
814############################################################################# 1112#############################################################################
815# command handling &c 1113# command handling &c
816 1114
817=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
830 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
831} 1129}
832 1130
833=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
834 1132
835Register 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.
836 1138
837If 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
838called. 1140called.
839 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
840=cut 1153=cut
841 1154
842sub register_extcmd { 1155sub register_extcmd {
843 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
844 1157
845 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
846} 1165}
847 1166
848cf::player->attach ( 1167cf::player->attach (
849 on_command => sub { 1168 on_command => sub {
850 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
859 cf::override; 1178 cf::override;
860 }, 1179 },
861 on_extcmd => sub { 1180 on_extcmd => sub {
862 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
863 1182
864 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
865 1184
866 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
867 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
868 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
869 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
870 } 1195 if $reply;
871 } 1196 }
872 } else { 1197 } else {
873 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
874 } 1199 }
875 1200
876 cf::override; 1201 cf::override;
877 }, 1202 },
878); 1203);
879 1204
880sub load_extension {
881 my ($path) = @_;
882
883 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
884 my $base = $1;
885 my $pkg = $1;
886 $pkg =~ s/[^[:word:]]/_/g;
887 $pkg = "ext::$pkg";
888
889 warn "... loading '$path' into '$pkg'\n";
890
891 open my $fh, "<:utf8", $path
892 or die "$path: $!";
893
894 my $source =
895 "package $pkg; use strict; use utf8;\n"
896 . "#line 1 \"$path\"\n{\n"
897 . (do { local $/; <$fh> })
898 . "\n};\n1";
899
900 unless (eval $source) {
901 my $msg = $@ ? "$path: $@\n"
902 : "extension disabled.\n";
903 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
904 warn $@;
905 warn "mandatory extension failed to load, exiting.\n";
906 exit 1;
907 }
908 die $@;
909 }
910
911 push @EXTS, $pkg;
912}
913
914sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
915 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
916 next unless -r $ext; 1210 next unless -r $path;
917 eval { 1211
918 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;
919 1 1269 }
920 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
921 } 1275 };
922} 1276}
923 1277
924############################################################################# 1278#############################################################################
925 1279
1280=back
1281
926=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
927 1283
928Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
929 1285
930=cut 1286=cut
942Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
943 1299
944=cut 1300=cut
945 1301
946sub playerdir($) { 1302sub playerdir($) {
947 cf::localdir 1303 "$PLAYERDIR/"
948 . "/"
949 . cf::playerdir
950 . "/"
951 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
952} 1305}
953 1306
954sub path($) { 1307sub path($) {
955 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
956 1309
957 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
958} 1311}
959 1312
960sub find_active($) { 1313sub find_active($) {
961 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
962 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
975 my $login = $_[0]; 1328 my $login = $_[0];
976 1329
977 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
978 1331
979 $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
980 my $pl = load_pl path $login 1340 my $pl = load_pl path $login
981 or return; 1341 or return;
982 $cf::PLAYER{$login} = $pl 1342 $cf::PLAYER{$login} = $pl
983 } 1343 }
984 } 1344 }
1068while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1069 1429
1070=cut 1430=cut
1071 1431
1072sub list_logins { 1432sub list_logins {
1073 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1074 or return []; 1434 or return [];
1075 1435
1076 my @logins; 1436 my @logins;
1077 1437
1078 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1113 } 1473 }
1114 1474
1115 \@paths 1475 \@paths
1116} 1476}
1117 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
1118=item $player->ext_reply ($msgid, $msgtype, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1119 1529
1120Sends an ext reply to the player. 1530Sends an ext reply to the player.
1121 1531
1122=cut 1532=cut
1123 1533
1124sub ext_reply($$$%) { 1534sub ext_reply($$@) {
1125 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1126 1536
1127 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1128 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1129 $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 }
1130} 1544}
1131 1545
1132package 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}
1133 1586
1134=back 1587=back
1135
1136 1588
1137=head3 cf::map 1589=head3 cf::map
1138 1590
1139=over 4 1591=over 4
1140 1592
1195 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1196 1648
1197 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1198 local $self->{path}; 1650 local $self->{path};
1199 local $self->{load_path}; 1651 local $self->{load_path};
1200 local $self->{deny_save};
1201 local $self->{deny_reset};
1202 1652
1203 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1204} 1654}
1205 1655
1206sub normalise { 1656sub normalise {
1253 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1254 return $self; 1704 return $self;
1255 } 1705 }
1256 } 1706 }
1257 1707
1258 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1259 () 1709 ()
1260} 1710}
1261 1711
1262sub init { 1712sub init {
1263 my ($self) = @_; 1713 my ($self) = @_;
1278 1728
1279# the original (read-only) location 1729# the original (read-only) location
1280sub load_path { 1730sub load_path {
1281 my ($self) = @_; 1731 my ($self) = @_;
1282 1732
1283 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1284} 1734}
1285 1735
1286# the temporary/swap location 1736# the temporary/swap location
1287sub save_path { 1737sub save_path {
1288 my ($self) = @_; 1738 my ($self) = @_;
1289 1739
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1292} 1742}
1293 1743
1294# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1295sub uniq_path { 1745sub uniq_path {
1296 my ($self) = @_; 1746 my ($self) = @_;
1297 1747
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1300} 1750}
1301 1751
1302# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1303# all maps in C++... 1753# all maps in C++...
1304sub change_all_map_light { 1754sub change_all_map_light {
1305 my ($change) = @_; 1755 my ($change) = @_;
1306 1756
1307 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1308 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;
1309} 1767}
1310 1768
1311sub unlink_save { 1769sub unlink_save {
1312 my ($self) = @_; 1770 my ($self) = @_;
1313 1771
1371 $self->load_header_orig 1829 $self->load_header_orig
1372 or return; 1830 or return;
1373 $self->prepare_orig; 1831 $self->prepare_orig;
1374 } 1832 }
1375 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
1376 1 1840 1
1377} 1841}
1378 1842
1379sub find; 1843sub find;
1380sub find { 1844sub find {
1392 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1393 1857
1394 $map->load_header 1858 $map->load_header
1395 or return; 1859 or return;
1396 1860
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1400 $map->reset; 1864 $map->reset;
1401 undef $guard; 1865 undef $guard;
1402 return find $path; 1866 return find $path;
1413 my ($self) = @_; 1877 my ($self) = @_;
1414 1878
1415 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1416 1880
1417 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1419 1885
1420 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1421 1887
1422 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1423 1889
1424 $self->alloc; 1890 $self->alloc;
1425 1891
1426 $self->pre_load; 1892 $self->pre_load;
1427
1428 $self->_load_objects ($self->{load_path}, 1)
1429 or return;
1430
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432 if delete $self->{load_original};
1433
1434 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) {
1437 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0);
1439 }
1440 }
1441
1442 Coro::cede;
1443
1444 # now do the right thing for maps
1445 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede; 1893 Coro::cede;
1452 $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;
1453 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 1913 unless $self->difficulty;
1455 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;
1456 $self->activate; 1923 $self->activate;
1924 }
1925
1926 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 1927 }
1458 1928
1459 $self->post_load; 1929 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 1930}
1463 1931
1464sub customise_for { 1932sub customise_for {
1465 my ($self, $ob) = @_; 1933 my ($self, $ob) = @_;
1466 1934
1467 return find "~" . $ob->name . "/" . $self->{path} 1935 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1469 1940
1470 $self 1941 $self
1471} 1942}
1472 1943
1473# find and load all maps in the 3x3 area around a map 1944# find and load all maps in the 3x3 area around a map
1520 1991
1521 undef $MAP_PREFETCH{$path}; 1992 undef $MAP_PREFETCH{$path};
1522 $MAP_PREFETCHER ||= cf::async { 1993 $MAP_PREFETCHER ||= cf::async {
1523 while (%MAP_PREFETCH) { 1994 while (%MAP_PREFETCH) {
1524 for my $path (keys %MAP_PREFETCH) { 1995 for my $path (keys %MAP_PREFETCH) {
1525 my $map = find $path 1996 if (my $map = find $path) {
1526 or next;
1527 $map->load; 1997 $map->load;
1998 }
1528 1999
1529 delete $MAP_PREFETCH{$path}; 2000 delete $MAP_PREFETCH{$path};
1530 } 2001 }
1531 } 2002 }
1532 undef $MAP_PREFETCHER; 2003 undef $MAP_PREFETCHER;
1584 2055
1585sub reset_at { 2056sub reset_at {
1586 my ($self) = @_; 2057 my ($self) = @_;
1587 2058
1588 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1591 2061
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 2064
1605 my ($self) = @_; 2075 my ($self) = @_;
1606 2076
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 2078
1609 return if $self->players; 2079 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 2080
1612 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
1613 2082
1614 $self->in_memory (cf::MAP_SWAPPED); 2083 $self->in_memory (cf::MAP_SWAPPED);
1615 2084
1616 # need to save uniques path 2085 # need to save uniques path
1617 unless ($self->{deny_save}) { 2086 unless ($self->{deny_save}) {
1649 $cf::MAP{$self->path} = $self; 2118 $cf::MAP{$self->path} = $self;
1650 2119
1651 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1652} 2121}
1653 2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
1654=item cf::map::unique_maps 2159=item cf::map::unique_maps
1655 2160
1656Returns an arrayref of paths of all shared maps that have 2161Returns an arrayref of paths of all shared maps that have
1657instantiated unique items. May block. 2162instantiated unique items. May block.
1658 2163
1659=cut 2164=cut
1660 2165
1661sub unique_maps() { 2166sub unique_maps() {
1662 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2167 [
1663 or return; 2168 map {
1664
1665 my @paths;
1666
1667 for (@$files) {
1668 utf8::decode $_; 2169 utf8::decode $_;
1669 next if /\.pst$/; 2170 /\.map$/
1670 next unless /^$PATH_SEP/o; 2171 ? normalise $_
1671 2172 : ()
1672 push @paths, cf::map::normalise $_; 2173 } @{ aio_readdir $UNIQUEDIR or [] }
1673 } 2174 ]
1674
1675 \@paths
1676} 2175}
1677 2176
1678package cf; 2177package cf;
1679 2178
1680=back 2179=back
1726 2225
1727 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728 2227
1729 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1730 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1731 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1732 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1733 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1734 } 2242 }
1735} 2243}
1736 2244
1737=item $player_object->may ("access") 2245=item $player_object->may ("access")
1738 2246
1786 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1787 2295
1788 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1789 2297
1790 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1792 2300
1793 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1794} 2302}
1795 2303
1796sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1797 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1798 2308
1799 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1800 2310
1801 unless ($map) { 2311 unless ($map) {
1802 # restore original map position 2312 # restore original map position
1825 2335
1826 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1828} 2338}
1829 2339
1830cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831 on_logout => sub {
1832 my ($pl) = @_;
1833 2341
1834 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1835 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1836 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1837 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1838 }; 2346be called at the end of this process.
1839 }
1840 },
1841 on_login => sub {
1842 my ($pl) = @_;
1843 2347
1844 # try to abort aborted map switching on player login :)
1845 # should happen only on crashes
1846 if ($pl->ob->{_link_pos}) {
1847 $pl->ob->enter_link;
1848 (async {
1849 $pl->ob->reply (undef,
1850 "There was an internal problem at your last logout, "
1851 . "the server will try to bring you to your intended destination in a second.",
1852 cf::NDI_RED);
1853 # we need this sleep as the login has a concurrent enter_exit running
1854 # and this sleep increases chances of the player not ending up in scorn
1855 Coro::Timer::sleep 1;
1856 $pl->ob->leave_link;
1857 })->prio (2);
1858 }
1859 },
1860);
1861
1862=item $player_object->goto ($path, $x, $y)
1863
1864=cut 2348=cut
2349
2350our $GOTOGEN;
1865 2351
1866sub cf::object::player::goto { 2352sub cf::object::player::goto {
1867 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868 2357
1869 $self->enter_link; 2358 $self->enter_link;
1870 2359
1871 (async { 2360 (async {
1872 my $map = eval { 2361 my $map = eval {
1873 my $map = cf::map::find $path; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1874 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
2366 $map = $check->($map) if $check && $map;
2367 } else {
2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
2370
1875 $map 2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
1876 } or 2377 }
1877 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878 2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1879 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1880 })->prio (1); 2385 })->prio (1);
1881} 2386}
1882 2387
1883=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1884 2389
1923 2428
1924 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1925 2430
1926 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1927 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
1928 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2433 my $meta = "$RANDOMDIR/$md5.meta";
1929 2434
1930 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931 aio_write $fh, 0, (length $data), $data, 0; 2436 aio_write $fh, 0, (length $data), $data, 0;
1932 undef $fh; 2437 undef $fh;
1933 aio_rename "$meta~", $meta; 2438 aio_rename "$meta~", $meta;
1942 2447
1943 return unless $self->type == cf::PLAYER; 2448 return unless $self->type == cf::PLAYER;
1944 2449
1945 if ($exit->slaying eq "/!") { 2450 if ($exit->slaying eq "/!") {
1946 #TODO: this should de-fi-ni-te-ly not be a sync-job 2451 #TODO: this should de-fi-ni-te-ly not be a sync-job
2452 # the problem is that $exit might not survive long enough
2453 # so it needs to be done right now, right here
1947 cf::sync_job { prepare_random_map $exit }; 2454 cf::sync_job { prepare_random_map $exit };
1948 } 2455 }
1949 2456
1950 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951 my $hp = $exit->stats->hp; 2458 my $hp = $exit->stats->hp;
1952 my $sp = $exit->stats->sp; 2459 my $sp = $exit->stats->sp;
1953 2460
1954 $self->enter_link; 2461 $self->enter_link;
2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
1955 2466
1956 (async { 2467 (async {
1957 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1958 unless (eval { 2469 unless (eval {
1959 $self->goto ($slaying, $hp, $sp); 2470 $self->goto ($slaying, $hp, $sp);
1960 2471
1961 1; 2472 1;
1962 }) { 2473 }) {
1963 $self->message ("Something went wrong deep within the crossfire server. " 2474 $self->message ("Something went wrong deep within the crossfire server. "
1964 . "I'll try to bring you back to the map you were before. " 2475 . "I'll try to bring you back to the map you were before. "
1965 . "Please report this to the dungeon master!", 2476 . "Please report this to the dungeon master!",
1966 cf::NDI_UNIQUE | cf::NDI_RED); 2477 cf::NDI_UNIQUE | cf::NDI_RED);
1967 2478
1968 warn "ERROR in enter_exit: $@"; 2479 warn "ERROR in enter_exit: $@";
1969 $self->leave_link; 2480 $self->leave_link;
1970 } 2481 }
1971 })->prio (1); 2482 })->prio (1);
1987 2498
1988 utf8::encode $text; 2499 utf8::encode $text;
1989 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990} 2501}
1991 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => %$channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2569 push @msg, msgtype => "event_$type";
2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2572}
1992 2573
1993=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
1994 2575
1995Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
1996the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998 2579
1999Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
2000reliable at some point in the future. 2581become reliable at some point in the future.
2001 2582
2002=cut 2583=cut
2003 2584
2004sub cf::client::query { 2585sub cf::client::query {
2005 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
2013 utf8::encode $text; 2594 utf8::encode $text;
2014 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015 2596
2016 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
2017 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
2018} 2601}
2019 2602
2020cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
2021 on_reply => sub { 2609 on_reply => sub {
2022 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
2023 2611
2024 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
2025 # get handled first 2613 # get handled first
2037 } else { 2625 } else {
2038 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039 } 2627 }
2040 } 2628 }
2041 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
2042); 2653);
2043 2654
2044=item $client->async (\&cb) 2655=item $client->async (\&cb)
2045 2656
2046Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
2093 2704
2094# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
2095 2706
2096=pod 2707=pod
2097 2708
2098The following fucntions and emthods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2099 2710
2100 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
2101 cf::object::player player 2715 cf::object::player
2102 cf::player peaceful 2716 player
2103 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2104 2723
2105=cut 2724=cut
2106 2725
2107for ( 2726for (
2108 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
2109 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2110 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2111 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2112) { 2732) {
2113 no strict 'refs'; 2733 no strict 'refs';
2184=back 2804=back
2185 2805
2186=cut 2806=cut
2187 2807
2188############################################################################# 2808#############################################################################
2189
2190=head2 EXTENSION DATABASE SUPPORT
2191
2192Crossfire maintains a very simple database for extension use. It can
2193currently store anything that can be serialised using Storable, which
2194excludes objects.
2195
2196The parameter C<$family> should best start with the name of the extension
2197using it, it should be unique.
2198
2199=over 4
2200
2201=item $value = cf::db_get $family => $key
2202
2203Returns a single value from the database.
2204
2205=item cf::db_put $family => $key => $value
2206
2207Stores the given C<$value> in the family.
2208
2209=cut
2210
2211our $DB;
2212
2213sub db_init {
2214 unless ($DB) {
2215 $DB = BDB::db_create $DB_ENV;
2216
2217 cf::sync_job {
2218 eval {
2219 $DB->set_flags (BDB::CHKSUM);
2220
2221 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223 cf::cleanup "db_open(db): $!" if $!;
2224 };
2225 cf::cleanup "db_open(db): $@" if $@;
2226 };
2227
2228 my $path = cf::localdir . "/database.pst";
2229 if (stat $path) {
2230 cf::sync_job {
2231 my $pst = Storable::retrieve $path;
2232
2233 cf::db_put (board => data => $pst->{board});
2234 cf::db_put (guildrules => data => $pst->{guildrules});
2235 cf::db_put (rent => balance => $pst->{rent}{balance});
2236 BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238 unlink $path;
2239 };
2240 }
2241 }
2242}
2243
2244sub db_get($$) {
2245 my $key = "$_[0]/$_[1]";
2246
2247 cf::sync_job {
2248 BDB::db_get $DB, undef, $key, my $data;
2249
2250 $! ? ()
2251 : Compress::LZF::sthaw $data
2252 }
2253}
2254
2255sub db_put($$$) {
2256 BDB::dbreq_pri 4;
2257 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258}
2259
2260#############################################################################
2261# the server's init and main functions 2809# the server's init and main functions
2262 2810
2263sub load_faces { 2811sub load_facedata($) {
2264 my $path = sprintf "%s/faces", cf::datadir; 2812 my ($path) = @_;
2265 2813
2266 warn "loading faces from $path\n"; 2814 warn "loading facedata from $path\n";
2267 2815
2268 my $faces; 2816 my $facedata;
2269 0 < aio_load $path, $faces 2817 0 < aio_load $path, $facedata
2270 or die "$path: $!"; 2818 or die "$path: $!";
2271 2819
2272 Coro::cede;
2273 $faces = Storable::thaw $faces; 2820 $facedata = Coro::Storable::thaw $facedata;
2274 Coro::cede;
2275 2821
2276 my $meta = delete $faces->{""};
2277 $meta->{version} == 1 2822 $facedata->{version} == 2
2278 or cf::cleanup "$path: version mismatch, cannot proceed."; 2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
2279 2824
2825 {
2826 my $faces = $facedata->{faceinfo};
2827
2280 while (my ($face, $info) = each %$faces) { 2828 while (my ($face, $info) = each %$faces) {
2281 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2282 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2283 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2284 Coro::cede; 2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2285 }
2286 2834
2835 cf::cede_to_tick;
2836 }
2837
2287 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2288 next unless $info->{smooth}; 2839 next unless $info->{smooth};
2289 my $idx = cf::face::find $face 2840 my $idx = cf::face::find $face
2290 or next; 2841 or next;
2291 if (my $smooth = cf::face::find $info->{smooth}) { 2842 if (my $smooth = cf::face::find $info->{smooth}) {
2292 cf::face::set_smooth $idx, $smooth; 2843 cf::face::set_smooth $idx, $smooth;
2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2293 } else { 2845 } else {
2294 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2295 } 2847 }
2296 Coro::cede; 2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 while (my ($name, $info) = each %$res) {
2871 my $meta = $enc->encode ({
2872 name => $name,
2873 type => $info->{type},
2874 copyright => $info->{copyright}, #TODO#
2875 });
2876
2877 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2878
2879 if ($name =~ /\.(?:jpg|png)$/) {
2880 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2881 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2882 } else {
2883 my $data = pack "(w/a*)*", $meta, $info->{data};
2884 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2885
2886 cf::face::set_type $idx, 1;
2887 cf::face::set_data $idx, 0, $data, $chk;
2888 }
2889
2890 cf::cede_to_tick;
2891 }
2297 } 2892 }
2298 2893
2299 1 2894 1
2300} 2895}
2301 2896
2897sub reload_regions {
2898 load_resource_file "$MAPDIR/regions"
2899 or die "unable to load regions file\n";
2900
2901 for (cf::region::list) {
2902 $_->{match} = qr/$_->{match}/
2903 if exists $_->{match};
2904 }
2905}
2906
2907sub reload_facedata {
2908 load_facedata "$DATADIR/facedata"
2909 or die "unable to load facedata\n";
2910}
2911
2912sub reload_archetypes {
2913 load_resource_file "$DATADIR/archetypes"
2914 or die "unable to load archetypes\n";
2915 #d# NEED to laod twice to resolve forward references
2916 # this really needs to be done in an extra post-pass
2917 # (which needs to be synchronous, so solve it differently)
2918 load_resource_file "$DATADIR/archetypes"
2919 or die "unable to load archetypes\n";
2920}
2921
2922sub reload_treasures {
2923 load_resource_file "$DATADIR/treasures"
2924 or die "unable to load treasurelists\n";
2925}
2926
2302sub reload_resources { 2927sub reload_resources {
2303 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2928 warn "reloading resource files...\n";
2304 or die "unable to load regions file\n";#d# 2929
2930 reload_regions;
2305 load_faces 2931 reload_facedata;
2306 or die "unable to load faces\n";#d# 2932 #reload_archetypes;#d#
2933 reload_archetypes;
2934 reload_treasures;
2935
2936 warn "finished reloading resource files\n";
2307} 2937}
2308 2938
2309sub init { 2939sub init {
2310 reload_resources; 2940 reload_resources;
2311} 2941}
2312 2942
2313sub cfg_load { 2943sub cfg_load {
2314 open my $fh, "<:utf8", cf::confdir . "/config" 2944 open my $fh, "<:utf8", "$CONFDIR/config"
2315 or return; 2945 or return;
2316 2946
2317 local $/; 2947 local $/;
2318 *CFG = YAML::Syck::Load <$fh>; 2948 *CFG = YAML::Syck::Load <$fh>;
2319 2949
2364 }, 2994 },
2365 ); 2995 );
2366 } 2996 }
2367} 2997}
2368 2998
2999sub write_runtime {
3000 my $runtime = "$LOCALDIR/runtime";
3001
3002 # first touch the runtime file to show we are still running:
3003 # the fsync below can take a very very long time.
3004
3005 IO::AIO::aio_utime $runtime, undef, undef;
3006
3007 my $guard = cf::lock_acquire "write_runtime";
3008
3009 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3010 or return;
3011
3012 my $value = $cf::RUNTIME + 90 + 10;
3013 # 10 is the runtime save interval, for a monotonic clock
3014 # 60 allows for the watchdog to kill the server.
3015
3016 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3017 and return;
3018
3019 # always fsync - this file is important
3020 aio_fsync $fh
3021 and return;
3022
3023 # touch it again to show we are up-to-date
3024 aio_utime $fh, undef, undef;
3025
3026 close $fh
3027 or return;
3028
3029 aio_rename "$runtime~", $runtime
3030 and return;
3031
3032 warn "runtime file written.\n";
3033
3034 1
3035}
3036
2369sub emergency_save() { 3037sub emergency_save() {
2370 my $freeze_guard = cf::freeze_mainloop; 3038 my $freeze_guard = cf::freeze_mainloop;
2371 3039
2372 warn "enter emergency perl save\n"; 3040 warn "enter emergency perl save\n";
2373 3041
2404 3072
2405 warn Carp::longmess "post_cleanup backtrace" 3073 warn Carp::longmess "post_cleanup backtrace"
2406 if $make_core; 3074 if $make_core;
2407} 3075}
2408 3076
2409sub reload() { 3077sub do_reload_perl() {
2410 # can/must only be called in main 3078 # can/must only be called in main
2411 if ($Coro::current != $Coro::main) { 3079 if ($Coro::current != $Coro::main) {
2412 warn "can only reload from main coroutine"; 3080 warn "can only reload from main coroutine";
2413 return; 3081 return;
2414 } 3082 }
2448 %EXT_CORO = (); 3116 %EXT_CORO = ();
2449 3117
2450 warn "removing commands"; 3118 warn "removing commands";
2451 %COMMAND = (); 3119 %COMMAND = ();
2452 3120
2453 warn "removing ext commands"; 3121 warn "removing ext/exti commands";
2454 %EXTCMD = (); 3122 %EXTCMD = ();
3123 %EXTICMD = ();
2455 3124
2456 warn "unloading/nuking all extensions"; 3125 warn "unloading/nuking all extensions";
2457 for my $pkg (@EXTS) { 3126 for my $pkg (@EXTS) {
2458 warn "... unloading $pkg"; 3127 warn "... unloading $pkg";
2459 3128
2489 Symbol::delete_package "safe::$_" 3158 Symbol::delete_package "safe::$_"
2490 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3159 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2491 3160
2492 warn "unloading cf.pm \"a bit\""; 3161 warn "unloading cf.pm \"a bit\"";
2493 delete $INC{"cf.pm"}; 3162 delete $INC{"cf.pm"};
3163 delete $INC{"cf/pod.pm"};
2494 3164
2495 # don't, removes xs symbols, too, 3165 # don't, removes xs symbols, too,
2496 # and global variables created in xs 3166 # and global variables created in xs
2497 #Symbol::delete_package __PACKAGE__; 3167 #Symbol::delete_package __PACKAGE__;
2498 3168
2513 warn "reattaching attachments to maps"; 3183 warn "reattaching attachments to maps";
2514 reattach $_ for values %MAP; 3184 reattach $_ for values %MAP;
2515 warn "reattaching attachments to players"; 3185 warn "reattaching attachments to players";
2516 reattach $_ for values %PLAYER; 3186 reattach $_ for values %PLAYER;
2517 3187
2518 warn "loading reloadable resources";
2519 reload_resources;
2520
2521 warn "leaving sync_job"; 3188 warn "leaving sync_job";
2522 3189
2523 1 3190 1
2524 } or do { 3191 } or do {
2525 warn $@; 3192 warn $@;
2530 warn "reloaded"; 3197 warn "reloaded";
2531}; 3198};
2532 3199
2533our $RELOAD_WATCHER; # used only during reload 3200our $RELOAD_WATCHER; # used only during reload
2534 3201
3202sub reload_perl() {
3203 # doing reload synchronously and two reloads happen back-to-back,
3204 # coro crashes during coro_state_free->destroy here.
3205
3206 $RELOAD_WATCHER ||= Event->timer (
3207 reentrant => 0,
3208 after => 0,
3209 data => WF_AUTOCANCEL,
3210 cb => sub {
3211 do_reload_perl;
3212 undef $RELOAD_WATCHER;
3213 },
3214 );
3215}
3216
2535register_command "reload" => sub { 3217register_command "reload" => sub {
2536 my ($who, $arg) = @_; 3218 my ($who, $arg) = @_;
2537 3219
2538 if ($who->flag (FLAG_WIZ)) { 3220 if ($who->flag (FLAG_WIZ)) {
2539 $who->message ("reloading server."); 3221 $who->message ("reloading server.");
2540 3222 async { reload_perl };
2541 # doing reload synchronously and two reloads happen back-to-back,
2542 # coro crashes during coro_state_free->destroy here.
2543
2544 $RELOAD_WATCHER ||= Event->timer (
2545 reentrant => 0,
2546 after => 0,
2547 data => WF_AUTOCANCEL,
2548 cb => sub {
2549 reload;
2550 undef $RELOAD_WATCHER;
2551 },
2552 );
2553 } 3223 }
2554}; 3224};
2555 3225
2556unshift @INC, $LIBDIR; 3226unshift @INC, $LIBDIR;
2557 3227
2558my $bug_warning = 0; 3228my $bug_warning = 0;
2559 3229
3230our @WAIT_FOR_TICK;
3231our @WAIT_FOR_TICK_BEGIN;
3232
3233sub wait_for_tick {
3234 return unless $TICK_WATCHER->is_active;
3235 return if $Coro::current == $Coro::main;
3236
3237 my $signal = new Coro::Signal;
3238 push @WAIT_FOR_TICK, $signal;
3239 $signal->wait;
3240}
3241
3242sub wait_for_tick_begin {
3243 return unless $TICK_WATCHER->is_active;
3244 return if $Coro::current == $Coro::main;
3245
3246 my $signal = new Coro::Signal;
3247 push @WAIT_FOR_TICK_BEGIN, $signal;
3248 $signal->wait;
3249}
3250
3251 my $min = 1e6;#d#
3252 my $avg = 10;
2560$TICK_WATCHER = Event->timer ( 3253$TICK_WATCHER = Event->timer (
2561 reentrant => 0, 3254 reentrant => 0,
2562 parked => 1, 3255 parked => 1,
2563 prio => 0, 3256 prio => 0,
2564 at => $NEXT_TICK || $TICK, 3257 at => $NEXT_TICK || $TICK,
2568 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3261 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2569 unless ++$bug_warning > 10; 3262 unless ++$bug_warning > 10;
2570 return; 3263 return;
2571 } 3264 }
2572 3265
2573 $NOW = Event::time; 3266 $NOW = $tick_start = Event::time;
2574 3267
2575 cf::server_tick; # one server iteration 3268 cf::server_tick; # one server iteration
3269
3270 0 && sync_job {#d#
3271 for(1..10) {
3272 my $t = Event::time;
3273 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3274 or die;
3275
3276 $map->width (50);
3277 $map->height (50);
3278 $map->alloc;
3279 $map->_load_objects ("/tmp/x.map", 1);
3280 my $t = Event::time - $t;
3281
3282 #next unless $t < 0.0013;#d#
3283 if ($t < $min) {
3284 $min = $t;
3285 }
3286 $avg = $avg * 0.99 + $t * 0.01;
3287 }
3288 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3289 exit 0;
3290 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3291 };
3292
2576 $RUNTIME += $TICK; 3293 $RUNTIME += $TICK;
2577 $NEXT_TICK += $TICK; 3294 $NEXT_TICK += $TICK;
2578 3295
2579 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3296 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2580 $NEXT_RUNTIME_WRITE = $NOW + 10; 3297 $NEXT_RUNTIME_WRITE = $NOW + 10;
2582 write_runtime 3299 write_runtime
2583 or warn "ERROR: unable to write runtime file: $!"; 3300 or warn "ERROR: unable to write runtime file: $!";
2584 }; 3301 };
2585 } 3302 }
2586 3303
2587 $WAIT_FOR_TICK->broadcast;
2588 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2589
2590# my $AFTER = Event::time; 3304# my $AFTER = Event::time;
2591# warn $AFTER - $NOW;#d# 3305# warn $AFTER - $NOW;#d#
2592 3306
3307 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3308 $sig->send;
3309 }
3310 while (my $sig = shift @WAIT_FOR_TICK) {
3311 $sig->send;
3312 }
3313
3314 $NOW = Event::time;
3315
2593 # if we are delayed by four ticks or more, skip them all 3316 # if we are delayed by four ticks or more, skip them all
2594 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3317 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2595 3318
2596 $TICK_WATCHER->at ($NEXT_TICK); 3319 $TICK_WATCHER->at ($NEXT_TICK);
2597 $TICK_WATCHER->start; 3320 $TICK_WATCHER->start;
3321
3322 $LOAD = ($NOW - $tick_start) / $TICK;
3323 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3324
3325 _post_tick;
3326
3327
2598 }, 3328 },
2599); 3329);
2600 3330
2601{ 3331{
2602 BDB::max_poll_time $TICK * 0.1; 3332 BDB::max_poll_time $TICK * 0.1;
2630 3360
2631 cf::sync_job { 3361 cf::sync_job {
2632 eval { 3362 eval {
2633 BDB::db_env_open 3363 BDB::db_env_open
2634 $DB_ENV, 3364 $DB_ENV,
2635 $BDB_ENV_DIR, 3365 $BDBDIR,
2636 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3366 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2637 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3367 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2638 0666; 3368 0666;
2639 3369
2640 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3370 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2641 3371
2642 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3372 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2643 $DB_ENV->set_lk_detect; 3373 $DB_ENV->set_lk_detect;
2644 }; 3374 };
2645 3375
2661 prio => 6, 3391 prio => 6,
2662 cb => \&IO::AIO::poll_cb, 3392 cb => \&IO::AIO::poll_cb,
2663 ); 3393 );
2664} 3394}
2665 3395
3396my $_log_backtrace;
3397
3398sub _log_backtrace {
3399 my ($msg, @addr) = @_;
3400
3401 $msg =~ s/\n//;
3402
3403 # limit the # of concurrent backtraces
3404 if ($_log_backtrace < 2) {
3405 ++$_log_backtrace;
3406 async {
3407 my @bt = fork_call {
3408 @addr = map { sprintf "%x", $_ } @addr;
3409 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3410 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3411 or die "addr2line: $!";
3412
3413 my @funcs;
3414 my @res = <$fh>;
3415 chomp for @res;
3416 while (@res) {
3417 my ($func, $line) = splice @res, 0, 2, ();
3418 push @funcs, "[$func] $line";
3419 }
3420
3421 @funcs
3422 };
3423
3424 LOG llevInfo, "[ABT] $msg\n";
3425 LOG llevInfo, "[ABT] $_\n" for @bt;
3426 --$_log_backtrace;
3427 };
3428 } else {
3429 LOG llevInfo, "[ABT] $msg\n";
3430 LOG llevInfo, "[ABT] [suppressed]\n";
3431 }
3432}
3433
3434# load additional modules
3435use cf::pod;
3436
2666END { cf::emergency_save } 3437END { cf::emergency_save }
2667 3438
26681 34391
2669 3440

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines