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.249 by root, Wed Apr 18 12:43:54 2007 UTC vs.
Revision 1.384 by root, Fri Oct 12 18:17:16 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.61 (); 15use Coro 4.1 ();
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;
21use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
22 25
26use JSON::XS ();
23use BDB (); 27use BDB ();
24use Data::Dumper; 28use Data::Dumper;
25use Digest::MD5; 29use Digest::MD5;
26use Fcntl; 30use Fcntl;
27use YAML::Syck (); 31use YAML::Syck ();
28use IO::AIO 2.32 (); 32use IO::AIO 2.51 ();
29use Time::HiRes; 33use Time::HiRes;
30use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
31 36
32# configure various modules to our taste 37# configure various modules to our taste
33# 38#
34$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
35Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
47our %COMMAND = (); 52our %COMMAND = ();
48our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
49 54
50our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
51our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
52our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
53our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
54 60
55our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
56our @EVENT; 62our @EVENT;
57our $LIBDIR = datadir . "/ext"; 63
64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
58 75
59our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!) 76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
60our $TICK_WATCHER; 77our $TICK_WATCHER;
61our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
62our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
63our $NEXT_TICK; 80our $NEXT_TICK;
64our $NOW; 81our $NOW;
65our $USE_FSYNC = 1; # use fsync to write maps - default off 82our $USE_FSYNC = 1; # use fsync to write maps - default off
66 83
67our $BDB_POLL_WATCHER; 84our $BDB_POLL_WATCHER;
85our $BDB_DEADLOCK_WATCHER;
86our $BDB_CHECKPOINT_WATCHER;
87our $BDB_TRICKLE_WATCHER;
68our $DB_ENV; 88our $DB_ENV;
69 89
70our %CFG; 90our %CFG;
71 91
72our $UPTIME; $UPTIME ||= time; 92our $UPTIME; $UPTIME ||= time;
73our $RUNTIME; 93our $RUNTIME;
74 94
75our %PLAYER; # all users 95our (%PLAYER, %PLAYER_LOADING); # all users
76our %MAP; # all maps 96our (%MAP, %MAP_LOADING ); # all maps
77our $LINK_MAP; # the special {link} map, which is always available 97our $LINK_MAP; # the special {link} map, which is always available
78our $RANDOM_MAPS = cf::localdir . "/random";
79our $BDB_ENV_DIR = cf::localdir . "/db";
80 98
81# used to convert map paths into valid unix filenames by replacing / by ∕ 99# used to convert map paths into valid unix filenames by replacing / by ∕
82our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 100our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
83 101
102our $LOAD; # a number between 0 (idle) and 1 (too many objects)
103our $LOADAVG; # same thing, but with alpha-smoothing
104our $tick_start; # for load detecting purposes
105
84binmode STDOUT; 106binmode STDOUT;
85binmode STDERR; 107binmode STDERR;
86 108
87# read virtual server time, if available 109# read virtual server time, if available
88unless ($RUNTIME || !-e cf::localdir . "/runtime") { 110unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
89 open my $fh, "<", cf::localdir . "/runtime" 111 open my $fh, "<", "$LOCALDIR/runtime"
90 or die "unable to read runtime file: $!"; 112 or die "unable to read runtime file: $!";
91 $RUNTIME = <$fh> + 0.; 113 $RUNTIME = <$fh> + 0.;
92} 114}
93 115
94mkdir cf::localdir; 116mkdir $_
95mkdir cf::localdir . "/" . cf::playerdir; 117 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
96mkdir cf::localdir . "/" . cf::tmpdir;
97mkdir cf::localdir . "/" . cf::uniquedir;
98mkdir $RANDOM_MAPS;
99mkdir $BDB_ENV_DIR;
100 118
101our $EMERGENCY_POSITION; 119our $EMERGENCY_POSITION;
102 120
103sub cf::map::normalise; 121sub cf::map::normalise;
104 122
115=item $cf::RUNTIME 133=item $cf::RUNTIME
116 134
117The time this server has run, starts at 0 and is increased by $cf::TICK on 135The time this server has run, starts at 0 and is increased by $cf::TICK on
118every server tick. 136every server tick.
119 137
120=item $cf::LIBDIR 138=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
139$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
140$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
121 141
122The perl library directory, where extensions and cf-specific modules can 142Various directories - "/etc", read-only install directory, perl-library
123be found. It will be added to C<@INC> automatically. 143directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
144unique-items directory, player file directory, random maps directory and
145database environment.
124 146
125=item $cf::NOW 147=item $cf::NOW
126 148
127The time of the last (current) server tick. 149The time of the last (current) server tick.
128 150
129=item $cf::TICK 151=item $cf::TICK
130 152
131The interval between server ticks, in seconds. 153The interval between server ticks, in seconds.
154
155=item $cf::LOADAVG
156
157The current CPU load on the server (alpha-smoothed), as a value between 0
158(none) and 1 (overloaded), indicating how much time is spent on processing
159objects per tick. Healthy values are < 0.5.
160
161=item $cf::LOAD
162
163The raw value load value from the last tick.
132 164
133=item %cf::CFG 165=item %cf::CFG
134 166
135Configuration for the server, loaded from C</etc/crossfire/config>, or 167Configuration for the server, loaded from C</etc/crossfire/config>, or
136from wherever your confdir points to. 168from wherever your confdir points to.
139 171
140These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 172These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
141returns directly I<after> the tick processing (and consequently, can only wake one process 173returns directly I<after> the tick processing (and consequently, can only wake one process
142per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 174per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
143 175
176=item @cf::INVOKE_RESULTS
177
178This array contains the results of the last C<invoke ()> call. When
179C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
180that call.
181
144=back 182=back
145 183
146=cut 184=cut
147 185
148BEGIN { 186BEGIN {
149 *CORE::GLOBAL::warn = sub { 187 *CORE::GLOBAL::warn = sub {
150 my $msg = join "", @_; 188 my $msg = join "", @_;
151 utf8::encode $msg;
152 189
153 $msg .= "\n" 190 $msg .= "\n"
154 unless $msg =~ /\n$/; 191 unless $msg =~ /\n$/;
192
193 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
155 194
156 LOG llevError, $msg; 195 LOG llevError, $msg;
157 }; 196 };
158} 197}
159 198
160@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 199@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
161@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 200@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
162@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 201@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
163@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 202@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
164@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 203@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
204@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
165@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 205@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
166 206
167# we bless all objects into (empty) derived classes to force a method lookup 207# we bless all objects into (empty) derived classes to force a method lookup
168# within the Safe compartment. 208# within the Safe compartment.
169for my $pkg (qw( 209for my $pkg (qw(
170 cf::global cf::attachable 210 cf::global cf::attachable
178} 218}
179 219
180$Event::DIED = sub { 220$Event::DIED = sub {
181 warn "error in event callback: @_"; 221 warn "error in event callback: @_";
182}; 222};
223
224#############################################################################
183 225
184=head2 UTILITY FUNCTIONS 226=head2 UTILITY FUNCTIONS
185 227
186=over 4 228=over 4
187 229
206 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 248 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
207 $d 249 $d
208 } || "[unable to dump $_[0]: '$@']"; 250 } || "[unable to dump $_[0]: '$@']";
209} 251}
210 252
211use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
212
213=item $ref = cf::from_json $json 253=item $ref = cf::from_json $json
214 254
215Converts a JSON string into the corresponding perl data structure. 255Converts a JSON string into the corresponding perl data structure.
216 256
217=item $json = cf::to_json $ref 257=item $json = cf::to_json $ref
218 258
219Converts a perl data structure into its JSON representation. 259Converts a perl data structure into its JSON representation.
260
261=cut
262
263our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
264
265sub to_json ($) { $json_coder->encode ($_[0]) }
266sub from_json ($) { $json_coder->decode ($_[0]) }
220 267
221=item cf::lock_wait $string 268=item cf::lock_wait $string
222 269
223Wait until the given lock is available. See cf::lock_acquire. 270Wait until the given lock is available. See cf::lock_acquire.
224 271
227Wait until the given lock is available and then acquires it and returns 274Wait until the given lock is available and then acquires it and returns
228a Coro::guard object. If the guard object gets destroyed (goes out of scope, 275a Coro::guard object. If the guard object gets destroyed (goes out of scope,
229for example when the coroutine gets canceled), the lock is automatically 276for example when the coroutine gets canceled), the lock is automatically
230returned. 277returned.
231 278
279Locks are *not* recursive, locking from the same coro twice results in a
280deadlocked coro.
281
232Lock names should begin with a unique identifier (for example, cf::map::find 282Lock names should begin with a unique identifier (for example, cf::map::find
233uses map_find and cf::map::load uses map_load). 283uses map_find and cf::map::load uses map_load).
234 284
285=item $locked = cf::lock_active $string
286
287Return true if the lock is currently active, i.e. somebody has locked it.
288
235=cut 289=cut
236 290
237our %LOCK; 291our %LOCK;
292our %LOCKER;#d#
238 293
239sub lock_wait($) { 294sub lock_wait($) {
240 my ($key) = @_; 295 my ($key) = @_;
296
297 if ($LOCKER{$key} == $Coro::current) {#d#
298 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
299 return;#d#
300 }#d#
241 301
242 # wait for lock, if any 302 # wait for lock, if any
243 while ($LOCK{$key}) { 303 while ($LOCK{$key}) {
244 push @{ $LOCK{$key} }, $Coro::current; 304 push @{ $LOCK{$key} }, $Coro::current;
245 Coro::schedule; 305 Coro::schedule;
251 311
252 # wait, to be sure we are not locked 312 # wait, to be sure we are not locked
253 lock_wait $key; 313 lock_wait $key;
254 314
255 $LOCK{$key} = []; 315 $LOCK{$key} = [];
316 $LOCKER{$key} = $Coro::current;#d#
256 317
257 Coro::guard { 318 Coro::guard {
319 delete $LOCKER{$key};#d#
258 # wake up all waiters, to be on the safe side 320 # wake up all waiters, to be on the safe side
259 $_->ready for @{ delete $LOCK{$key} }; 321 $_->ready for @{ delete $LOCK{$key} };
260 } 322 }
323}
324
325sub lock_active($) {
326 my ($key) = @_;
327
328 ! ! $LOCK{$key}
261} 329}
262 330
263sub freeze_mainloop { 331sub freeze_mainloop {
264 return unless $TICK_WATCHER->is_active; 332 return unless $TICK_WATCHER->is_active;
265 333
268 }; 336 };
269 $TICK_WATCHER->stop; 337 $TICK_WATCHER->stop;
270 $guard 338 $guard
271} 339}
272 340
341=item cf::get_slot $time[, $priority[, $name]]
342
343Allocate $time seconds of blocking CPU time at priority C<$priority>:
344This call blocks and returns only when you have at least C<$time> seconds
345of cpu time till the next tick. The slot is only valid till the next cede.
346
347The optional C<$name> can be used to identify the job to run. It might be
348used for statistical purposes and should identify the same time-class.
349
350Useful for short background jobs.
351
352=cut
353
354our @SLOT_QUEUE;
355our $SLOT_QUEUE;
356
357$SLOT_QUEUE->cancel if $SLOT_QUEUE;
358$SLOT_QUEUE = Coro::async {
359 $Coro::current->desc ("timeslot manager");
360
361 my $signal = new Coro::Signal;
362
363 while () {
364 next_job:
365 my $avail = cf::till_tick;
366 if ($avail > 0.01) {
367 for (0 .. $#SLOT_QUEUE) {
368 if ($SLOT_QUEUE[$_][0] < $avail) {
369 my $job = splice @SLOT_QUEUE, $_, 1, ();
370 $job->[2]->send;
371 Coro::cede;
372 goto next_job;
373 }
374 }
375 }
376
377 if (@SLOT_QUEUE) {
378 # we do not use wait_for_tick() as it returns immediately when tick is inactive
379 push @cf::WAIT_FOR_TICK, $signal;
380 $signal->wait;
381 } else {
382 Coro::schedule;
383 }
384 }
385};
386
387sub get_slot($;$$) {
388 my ($time, $pri, $name) = @_;
389
390 $time = $TICK * .6 if $time > $TICK * .6;
391 my $sig = new Coro::Signal;
392
393 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
394 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
395 $SLOT_QUEUE->ready;
396 $sig->wait;
397}
398
273=item cf::async { BLOCK } 399=item cf::async { BLOCK }
274 400
275Currently the same as Coro::async_pool, meaning you cannot use 401Currently the same as Coro::async_pool, meaning you cannot use
276C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 402C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
277thing you are allowed to do is call C<prio> on it. 403thing you are allowed to do is call C<prio> on it.
280 406
281BEGIN { *async = \&Coro::async_pool } 407BEGIN { *async = \&Coro::async_pool }
282 408
283=item cf::sync_job { BLOCK } 409=item cf::sync_job { BLOCK }
284 410
285The design of crossfire+ requires that the main coro ($Coro::main) is 411The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 412is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 413partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
414acceptable.
288 415
289If it must be done, put the blocking parts into C<sync_job>. This will run 416If it must be done, put the blocking parts into C<sync_job>. This will run
290the given BLOCK in another coroutine while waiting for the result. The 417the given BLOCK in another coroutine while waiting for the result. The
291server will be frozen during this time, so the block should either finish 418server will be frozen during this time, so the block should either finish
292fast or be very important. 419fast or be very important.
295 422
296sub sync_job(&) { 423sub sync_job(&) {
297 my ($job) = @_; 424 my ($job) = @_;
298 425
299 if ($Coro::current == $Coro::main) { 426 if ($Coro::current == $Coro::main) {
427 my $time = Event::time;
428
300 # this is the main coro, too bad, we have to block 429 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 430 # till the operation succeeds, freezing the server :/
302 431
432 LOG llevError | logBacktrace, Carp::longmess "sync job";#d#
433
303 # TODO: use suspend/resume instead 434 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 435 # (but this is cancel-safe)
305 my $freeze_guard = freeze_mainloop; 436 my $freeze_guard = freeze_mainloop;
306 437
307 my $busy = 1; 438 my $busy = 1;
308 my @res; 439 my @res;
309 440
310 (async { 441 (async {
442 $Coro::current->desc ("sync job coro");
311 @res = eval { $job->() }; 443 @res = eval { $job->() };
312 warn $@ if $@; 444 warn $@ if $@;
313 undef $busy; 445 undef $busy;
314 })->prio (Coro::PRIO_MAX); 446 })->prio (Coro::PRIO_MAX);
315 447
316 while ($busy) { 448 while ($busy) {
317 Coro::cede or Event::one_event; 449 Coro::cede or Event::one_event;
318 } 450 }
451
452 $time = Event::time - $time;
453
454 LOG llevError | logBacktrace, Carp::longmess "long sync job"
455 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
456
457 $tick_start += $time; # do not account sync jobs to server load
319 458
320 wantarray ? @res : $res[0] 459 wantarray ? @res : $res[0]
321 } else { 460 } else {
322 # we are in another coroutine, how wonderful, everything just works 461 # we are in another coroutine, how wonderful, everything just works
323 462
343 $EXT_CORO{$coro+0} = $coro; 482 $EXT_CORO{$coro+0} = $coro;
344 483
345 $coro 484 $coro
346} 485}
347 486
348sub write_runtime { 487=item fork_call { }, $args
349 my $guard = cf::lock_acquire "write_runtime";
350 488
351 my $runtime = cf::localdir . "/runtime"; 489Executes the given code block with the given arguments in a seperate
490process, returning the results. Everything must be serialisable with
491Coro::Storable. May, of course, block. Note that the executed sub may
492never block itself or use any form of Event handling.
352 493
353 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 494=cut
354 or return;
355 495
356 my $value = $cf::RUNTIME + 90 + 10; 496sub fork_call(&@) {
357 # 10 is the runtime save interval, for a monotonic clock 497 my ($cb, @args) = @_;
358 # 60 allows for the watchdog to kill the server.
359 498
360 (aio_write $fh, 0, (length $value), $value, 0) <= 0 499 # we seemingly have to make a local copy of the whole thing,
361 and return; 500 # otherwise perl prematurely frees the stuff :/
501 # TODO: investigate and fix (likely this will be rather laborious)
362 502
363 # always fsync - this file is important 503 my @res = Coro::Util::fork_eval {
364 aio_fsync $fh 504 reset_signals;
365 and return; 505 &$cb
506 }, @args;
366 507
367 close $fh 508 wantarray ? @res : $res[-1]
368 or return; 509}
369 510
370 aio_rename "$runtime~", $runtime 511=item $value = cf::db_get $family => $key
371 and return;
372 512
513Returns a single value from the environment database.
514
515=item cf::db_put $family => $key => $value
516
517Stores the given C<$value> in the family. It can currently store binary
518data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
519
520=item $db = cf::db_table "name"
521
522Create and/or open a new database table. The string must not be "db" and must be unique
523within each server.
524
525=cut
526
527sub db_table($) {
528 my ($name) = @_;
529 my $db = BDB::db_create $DB_ENV;
530
531 eval {
532 $db->set_flags (BDB::CHKSUM);
533
534 utf8::encode $name;
535 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
536 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
537 cf::cleanup "db_open(db): $!" if $!;
538 };
539 cf::cleanup "db_open(db): $@" if $@;
540
541 $db
542}
543
544our $DB;
545
546sub db_init {
547 cf::sync_job {
548 $DB ||= db_table "db";
549 };
550}
551
552sub db_get($$) {
553 my $key = "$_[0]/$_[1]";
554
555 cf::sync_job {
556 BDB::db_get $DB, undef, $key, my $data;
557
558 $! ? ()
559 : $data
373 1 560 }
561}
562
563sub db_put($$$) {
564 BDB::dbreq_pri 4;
565 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
566}
567
568=item cf::cache $id => [$paths...], $processversion => $process
569
570Generic caching function that returns the value of the resource $id,
571caching and regenerating as required.
572
573This function can block.
574
575=cut
576
577sub cache {
578 my ($id, $src, $processversion, $process) = @_;
579
580 my $meta =
581 join "\x00",
582 $processversion,
583 map {
584 aio_stat $_
585 and Carp::croak "$_: $!";
586
587 ($_, (stat _)[7,9])
588 } @$src;
589
590 my $dbmeta = db_get cache => "$id/meta";
591 if ($dbmeta ne $meta) {
592 # changed, we may need to process
593
594 my @data;
595 my $md5;
596
597 for (0 .. $#$src) {
598 0 <= aio_load $src->[$_], $data[$_]
599 or Carp::croak "$src->[$_]: $!";
600 }
601
602 # if processing is expensive, check
603 # checksum first
604 if (1) {
605 $md5 =
606 join "\x00",
607 $processversion,
608 map {
609 cf::cede_to_tick;
610 ($src->[$_], Digest::MD5::md5_hex $data[$_])
611 } 0.. $#$src;
612
613
614 my $dbmd5 = db_get cache => "$id/md5";
615 if ($dbmd5 eq $md5) {
616 db_put cache => "$id/meta", $meta;
617
618 return db_get cache => "$id/data";
619 }
620 }
621
622 my $t1 = Time::HiRes::time;
623 my $data = $process->(\@data);
624 my $t2 = Time::HiRes::time;
625
626 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
627
628 db_put cache => "$id/data", $data;
629 db_put cache => "$id/md5" , $md5;
630 db_put cache => "$id/meta", $meta;
631
632 return $data;
633 }
634
635 db_get cache => "$id/data"
374} 636}
375 637
376=item cf::datalog type => key => value, ... 638=item cf::datalog type => key => value, ...
377 639
378Log a datalog packet of the given type with the given key-value pairs. 640Log a datalog packet of the given type with the given key-value pairs.
396attach callbacks/event handlers (a collection of which is called an "attachment") 658attach callbacks/event handlers (a collection of which is called an "attachment")
397to it. All such attachable objects support the following methods. 659to it. All such attachable objects support the following methods.
398 660
399In the following description, CLASS can be any of C<global>, C<object> 661In the following description, CLASS can be any of C<global>, C<object>
400C<player>, C<client> or C<map> (i.e. the attachable objects in 662C<player>, C<client> or C<map> (i.e. the attachable objects in
401crossfire+). 663Crossfire TRT).
402 664
403=over 4 665=over 4
404 666
405=item $attachable->attach ($attachment, key => $value...) 667=item $attachable->attach ($attachment, key => $value...)
406 668
569 $registry = $CB_TYPE[$object_type] ||= []; 831 $registry = $CB_TYPE[$object_type] ||= [];
570 832
571 } elsif ($type eq "subtype") { 833 } elsif ($type eq "subtype") {
572 defined $object_type or Carp::croak "subtype specified without type"; 834 defined $object_type or Carp::croak "subtype specified without type";
573 my $object_subtype = shift @arg; 835 my $object_subtype = shift @arg;
574 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 836 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575 837
576 } elsif ($type eq "package") { 838 } elsif ($type eq "package") {
577 my $pkg = shift @arg; 839 my $pkg = shift @arg;
578 840
579 while (my ($name, $id) = each %cb_id) { 841 while (my ($name, $id) = each %cb_id) {
608 _attach $registry, $klass, @attach; 870 _attach $registry, $klass, @attach;
609 } 871 }
610 872
611 $obj->{$name} = \%arg; 873 $obj->{$name} = \%arg;
612 } else { 874 } else {
613 warn "object uses attachment '$name' that is not available, postponing.\n"; 875 warn "object uses attachment '$name' which is not available, postponing.\n";
614 } 876 }
615 877
616 $obj->{_attachment}{$name} = undef; 878 $obj->{_attachment}{$name} = undef;
617} 879}
618 880
620 if (ref $_[0]) { 882 if (ref $_[0]) {
621 _object_attach @_; 883 _object_attach @_;
622 } else { 884 } else {
623 _attach shift->_attach_registry, @_; 885 _attach shift->_attach_registry, @_;
624 } 886 }
887 _recalc_want;
625}; 888};
626 889
627# all those should be optimised 890# all those should be optimised
628sub cf::attachable::detach { 891sub cf::attachable::detach {
629 my ($obj, $name) = @_; 892 my ($obj, $name) = @_;
632 delete $obj->{_attachment}{$name}; 895 delete $obj->{_attachment}{$name};
633 reattach ($obj); 896 reattach ($obj);
634 } else { 897 } else {
635 Carp::croak "cannot, currently, detach class attachments"; 898 Carp::croak "cannot, currently, detach class attachments";
636 } 899 }
900 _recalc_want;
637}; 901};
638 902
639sub cf::attachable::attached { 903sub cf::attachable::attached {
640 my ($obj, $name) = @_; 904 my ($obj, $name) = @_;
641 905
656 "; 920 ";
657 die if $@; 921 die if $@;
658} 922}
659 923
660our $override; 924our $override;
661our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 925our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
662 926
663sub override { 927sub override {
664 $override = 1; 928 $override = 1;
665 @invoke_results = (); 929 @INVOKE_RESULTS = (@_);
666} 930}
667 931
668sub do_invoke { 932sub do_invoke {
669 my $event = shift; 933 my $event = shift;
670 my $callbacks = shift; 934 my $callbacks = shift;
671 935
672 @invoke_results = (); 936 @INVOKE_RESULTS = ();
673 937
674 local $override; 938 local $override;
675 939
676 for (@$callbacks) { 940 for (@$callbacks) {
677 eval { &{$_->[1]} }; 941 eval { &{$_->[1]} };
694 958
695Generate an object-specific event with the given arguments. 959Generate an object-specific event with the given arguments.
696 960
697This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 961This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
698removed in future versions), and there is no public API to access override 962removed in future versions), and there is no public API to access override
699results (if you must, access C<@cf::invoke_results> directly). 963results (if you must, access C<@cf::INVOKE_RESULTS> directly).
700 964
701=back 965=back
702 966
703=cut 967=cut
704 968
705############################################################################# 969#############################################################################
706# object support 970# object support
971#
972
973sub _can_merge {
974 my ($ob1, $ob2) = @_;
975
976 local $Storable::canonical = 1;
977 my $fob1 = Storable::freeze $ob1;
978 my $fob2 = Storable::freeze $ob2;
979
980 $fob1 eq $fob2
981}
707 982
708sub reattach { 983sub reattach {
709 # basically do the same as instantiate, without calling instantiate 984 # basically do the same as instantiate, without calling instantiate
710 my ($obj) = @_; 985 my ($obj) = @_;
711 986
758sub object_freezer_save { 1033sub object_freezer_save {
759 my ($filename, $rdata, $objs) = @_; 1034 my ($filename, $rdata, $objs) = @_;
760 1035
761 sync_job { 1036 sync_job {
762 if (length $$rdata) { 1037 if (length $$rdata) {
1038 utf8::decode (my $decname = $filename);
763 warn sprintf "saving %s (%d,%d)\n", 1039 warn sprintf "saving %s (%d,%d)\n",
764 $filename, length $$rdata, scalar @$objs; 1040 $decname, length $$rdata, scalar @$objs;
765 1041
766 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1042 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
767 chmod SAVE_MODE, $fh; 1043 chmod SAVE_MODE, $fh;
768 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1044 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
769 aio_fsync $fh if $cf::USE_FSYNC; 1045 aio_fsync $fh if $cf::USE_FSYNC;
770 close $fh; 1046 close $fh;
771 1047
772 if (@$objs) { 1048 if (@$objs) {
773 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
774 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
775 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1051 my $data = Coro::Storable::blocking_nfreeze { version => 1, objs => $objs };
776 aio_write $fh, 0, (length $data), $data, 0; 1052 aio_write $fh, 0, (length $data), $data, 0;
777 aio_fsync $fh if $cf::USE_FSYNC; 1053 aio_fsync $fh if $cf::USE_FSYNC;
778 close $fh; 1054 close $fh;
779 aio_rename "$filename.pst~", "$filename.pst"; 1055 aio_rename "$filename.pst~", "$filename.pst";
780 } 1056 }
788 } 1064 }
789 } else { 1065 } else {
790 aio_unlink $filename; 1066 aio_unlink $filename;
791 aio_unlink "$filename.pst"; 1067 aio_unlink "$filename.pst";
792 } 1068 }
793 } 1069 };
794} 1070}
795 1071
796sub object_freezer_as_string { 1072sub object_freezer_as_string {
797 my ($rdata, $objs) = @_; 1073 my ($rdata, $objs) = @_;
798 1074
810 or return; 1086 or return;
811 1087
812 unless (aio_stat "$filename.pst") { 1088 unless (aio_stat "$filename.pst") {
813 (aio_load "$filename.pst", $av) >= 0 1089 (aio_load "$filename.pst", $av) >= 0
814 or return; 1090 or return;
815 $av = eval { (Storable::thaw $av)->{objs} };
816 }
817 1091
1092 my $st = eval { Coro::Storable::thaw $av }
1093 || eval { my $guard = Coro::Storable::guard; Storable::thaw $av }; #d# compatibility, remove
1094 $av = $st->{objs};
1095 }
1096
1097 utf8::decode (my $decname = $filename);
818 warn sprintf "loading %s (%d)\n", 1098 warn sprintf "loading %s (%d,%d)\n",
819 $filename, length $data, scalar @{$av || []};#d# 1099 $decname, length $data, scalar @{$av || []};
1100
820 return ($data, $av); 1101 ($data, $av)
821} 1102}
1103
1104=head2 COMMAND CALLBACKS
1105
1106=over 4
1107
1108=cut
822 1109
823############################################################################# 1110#############################################################################
824# command handling &c 1111# command handling &c
825 1112
826=item cf::register_command $name => \&callback($ob,$args); 1113=item cf::register_command $name => \&callback($ob,$args);
839 push @{ $COMMAND{$name} }, [$caller, $cb]; 1126 push @{ $COMMAND{$name} }, [$caller, $cb];
840} 1127}
841 1128
842=item cf::register_extcmd $name => \&callback($pl,$packet); 1129=item cf::register_extcmd $name => \&callback($pl,$packet);
843 1130
844Register a callbackf ro execution when the client sends an extcmd packet. 1131Register a callback for execution when the client sends an (synchronous)
1132extcmd packet. Ext commands will be processed in the order they are
1133received by the server, like other user commands. The first argument is
1134the logged-in player. Ext commands can only be processed after a player
1135has logged in successfully.
845 1136
846If the callback returns something, it is sent back as if reply was being 1137If the callback returns something, it is sent back as if reply was being
847called. 1138called.
848 1139
1140=item cf::register_exticmd $name => \&callback($ns,$packet);
1141
1142Register a callback for execution when the client sends an (asynchronous)
1143exticmd packet. Exti commands are processed by the server as soon as they
1144are received, i.e. out of order w.r.t. other commands. The first argument
1145is a client socket. Exti commands can be received anytime, even before
1146log-in.
1147
1148If the callback returns something, it is sent back as if reply was being
1149called.
1150
849=cut 1151=cut
850 1152
851sub register_extcmd { 1153sub register_extcmd {
852 my ($name, $cb) = @_; 1154 my ($name, $cb) = @_;
853 1155
854 $EXTCMD{$name} = $cb; 1156 $EXTCMD{$name} = $cb;
1157}
1158
1159sub register_exticmd {
1160 my ($name, $cb) = @_;
1161
1162 $EXTICMD{$name} = $cb;
855} 1163}
856 1164
857cf::player->attach ( 1165cf::player->attach (
858 on_command => sub { 1166 on_command => sub {
859 my ($pl, $name, $params) = @_; 1167 my ($pl, $name, $params) = @_;
868 cf::override; 1176 cf::override;
869 }, 1177 },
870 on_extcmd => sub { 1178 on_extcmd => sub {
871 my ($pl, $buf) = @_; 1179 my ($pl, $buf) = @_;
872 1180
873 my $msg = eval { from_json $buf }; 1181 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874 1182
875 if (ref $msg) { 1183 if (ref $msg) {
1184 my ($type, $reply, @payload) =
1185 "ARRAY" eq ref $msg
1186 ? @$msg
1187 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1188
1189 my @reply;
1190
876 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
877 if (my %reply = $cb->($pl, $msg)) { 1192 @reply = $cb->($pl, @payload);
878 $pl->ext_reply ($msg->{msgid}, %reply);
879 }
880 } 1193 }
1194
1195 $pl->ext_reply ($reply, @reply)
1196 if $reply;
1197
881 } else { 1198 } else {
882 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1199 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
883 } 1200 }
884 1201
885 cf::override; 1202 cf::override;
886 }, 1203 },
887); 1204);
888 1205
889sub load_extension {
890 my ($path) = @_;
891
892 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
893 my $base = $1;
894 my $pkg = $1;
895 $pkg =~ s/[^[:word:]]/_/g;
896 $pkg = "ext::$pkg";
897
898 warn "... loading '$path' into '$pkg'\n";
899
900 open my $fh, "<:utf8", $path
901 or die "$path: $!";
902
903 my $source =
904 "package $pkg; use strict; use utf8;\n"
905 . "#line 1 \"$path\"\n{\n"
906 . (do { local $/; <$fh> })
907 . "\n};\n1";
908
909 unless (eval $source) {
910 my $msg = $@ ? "$path: $@\n"
911 : "extension disabled.\n";
912 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
913 warn $@;
914 warn "mandatory extension failed to load, exiting.\n";
915 exit 1;
916 }
917 die $@;
918 }
919
920 push @EXTS, $pkg;
921}
922
923sub load_extensions { 1206sub load_extensions {
1207 cf::sync_job {
1208 my %todo;
1209
924 for my $ext (<$LIBDIR/*.ext>) { 1210 for my $path (<$LIBDIR/*.ext>) {
925 next unless -r $ext; 1211 next unless -r $path;
926 eval { 1212
927 load_extension $ext; 1213 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1214 my $base = $1;
1215 my $pkg = $1;
1216 $pkg =~ s/[^[:word:]]/_/g;
1217 $pkg = "ext::$pkg";
1218
1219 open my $fh, "<:utf8", $path
1220 or die "$path: $!";
1221
1222 my $source = do { local $/; <$fh> };
1223
1224 my %ext = (
1225 path => $path,
1226 base => $base,
1227 pkg => $pkg,
1228 );
1229
1230 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1231 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1232
1233 $ext{source} =
1234 "package $pkg; use strict; use utf8;\n"
1235 . "#line 1 \"$path\"\n{\n"
1236 . $source
1237 . "\n};\n1";
1238
1239 $todo{$base} = \%ext;
1240 }
1241
1242 my %done;
1243 while (%todo) {
1244 my $progress;
1245
1246 while (my ($k, $v) = each %todo) {
1247 for (split /,\s*/, $v->{meta}{depends}) {
1248 goto skip
1249 unless exists $done{$_};
1250 }
1251
1252 warn "... loading '$k' into '$v->{pkg}'\n";
1253
1254 unless (eval $v->{source}) {
1255 my $msg = $@ ? "$v->{path}: $@\n"
1256 : "$v->{base}: extension inactive.\n";
1257
1258 if (exists $v->{meta}{mandatory}) {
1259 warn $msg;
1260 warn "mandatory extension failed to load, exiting.\n";
1261 exit 1;
1262 }
1263
1264 warn $msg;
1265 }
1266
1267 $done{$k} = delete $todo{$k};
1268 push @EXTS, $v->{pkg};
1269 $progress = 1;
928 1 1270 }
929 } or warn "$ext not loaded: $@"; 1271
1272 skip:
1273 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1274 unless $progress;
1275 }
930 } 1276 };
931} 1277}
932 1278
933############################################################################# 1279#############################################################################
934 1280
1281=back
1282
935=head2 CORE EXTENSIONS 1283=head2 CORE EXTENSIONS
936 1284
937Functions and methods that extend core crossfire objects. 1285Functions and methods that extend core crossfire objects.
938 1286
939=cut 1287=cut
944 1292
945=head3 cf::player 1293=head3 cf::player
946 1294
947=over 4 1295=over 4
948 1296
1297=item cf::player::num_playing
1298
1299Returns the official number of playing players, as per the Crossfire metaserver rules.
1300
1301=cut
1302
1303sub num_playing {
1304 scalar grep
1305 $_->ob->map
1306 && !$_->hidden
1307 && !$_->ob->flag (cf::FLAG_WIZ),
1308 cf::player::list
1309}
1310
949=item cf::player::find $login 1311=item cf::player::find $login
950 1312
951Returns the given player object, loading it if necessary (might block). 1313Returns the given player object, loading it if necessary (might block).
952 1314
953=cut 1315=cut
954 1316
955sub playerdir($) { 1317sub playerdir($) {
956 cf::localdir 1318 "$PLAYERDIR/"
957 . "/"
958 . cf::playerdir
959 . "/"
960 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1319 . (ref $_[0] ? $_[0]->ob->name : $_[0])
961} 1320}
962 1321
963sub path($) { 1322sub path($) {
964 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1323 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
991 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1350 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
992 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1351 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
993 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1352 aio_unlink +(playerdir $login) . "/$login.pl.pst";
994 aio_unlink +(playerdir $login) . "/$login.pl"; 1353 aio_unlink +(playerdir $login) . "/$login.pl";
995 1354
996 my $pl = load_pl path $login 1355 my $f = new_from_file cf::object::thawer path $login
997 or return; 1356 or return;
1357
1358 my $pl = cf::player::load_pl $f
1359 or return;
1360 local $cf::PLAYER_LOADING{$login} = $pl;
1361 $f->resolve_delayed_derefs;
998 $cf::PLAYER{$login} = $pl 1362 $cf::PLAYER{$login} = $pl
999 } 1363 }
1000 } 1364 }
1001} 1365}
1002 1366
1012 1376
1013 aio_mkdir playerdir $pl, 0770; 1377 aio_mkdir playerdir $pl, 0770;
1014 $pl->{last_save} = $cf::RUNTIME; 1378 $pl->{last_save} = $cf::RUNTIME;
1015 1379
1016 $pl->save_pl ($path); 1380 $pl->save_pl ($path);
1017 Coro::cede; 1381 cf::cede_to_tick;
1018} 1382}
1019 1383
1020sub new($) { 1384sub new($) {
1021 my ($login) = @_; 1385 my ($login) = @_;
1022 1386
1026 $self->{deny_save} = 1; 1390 $self->{deny_save} = 1;
1027 1391
1028 $cf::PLAYER{$login} = $self; 1392 $cf::PLAYER{$login} = $self;
1029 1393
1030 $self 1394 $self
1395}
1396
1397=item $player->send_msg ($channel, $msg, $color, [extra...])
1398
1399=cut
1400
1401sub send_msg {
1402 my $ns = shift->ns
1403 or return;
1404 $ns->send_msg (@_);
1031} 1405}
1032 1406
1033=item $pl->quit_character 1407=item $pl->quit_character
1034 1408
1035Nukes the player without looking back. If logged in, the connection will 1409Nukes the player without looking back. If logged in, the connection will
1084while and may block, so not sync_job-capable, ever. 1458while and may block, so not sync_job-capable, ever.
1085 1459
1086=cut 1460=cut
1087 1461
1088sub list_logins { 1462sub list_logins {
1089 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1463 my $dirs = aio_readdir $PLAYERDIR
1090 or return []; 1464 or return [];
1091 1465
1092 my @logins; 1466 my @logins;
1093 1467
1094 for my $login (@$dirs) { 1468 for my $login (@$dirs) {
1469 my $path = path $login;
1470
1471 # a .pst is a dead give-away for a valid player
1472 unless (-e "$path.pst") {
1095 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1473 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1096 aio_read $fh, 0, 512, my $buf, 0 or next; 1474 aio_read $fh, 0, 512, my $buf, 0 or next;
1097 $buf !~ /^password -------------$/m or next; # official not-valid tag 1475 $buf !~ /^password -------------$/m or next; # official not-valid tag
1476 }
1098 1477
1099 utf8::decode $login; 1478 utf8::decode $login;
1100 push @logins, $login; 1479 push @logins, $login;
1101 } 1480 }
1102 1481
1129 } 1508 }
1130 1509
1131 \@paths 1510 \@paths
1132} 1511}
1133 1512
1513=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1514
1515Expand crossfire pod fragments into protocol xml.
1516
1517=cut
1518
1519sub expand_cfpod {
1520 ((my $self), (local $_)) = @_;
1521
1522 # escape & and <
1523 s/&/&amp;/g;
1524 s/(?<![BIUGHT])</&lt;/g;
1525
1526 # this is buggy, it needs to properly take care of nested <'s
1527
1528 1 while
1529 # replace B<>, I<>, U<> etc.
1530 s/B<([^\>]*)>/<b>$1<\/b>/
1531 || s/I<([^\>]*)>/<i>$1<\/i>/
1532 || s/U<([^\>]*)>/<u>$1<\/u>/
1533 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1534 # replace G<male|female> tags
1535 || s{G<([^>|]*)\|([^>]*)>}{
1536 $self->gender ? $2 : $1
1537 }ge
1538 # replace H<hint text>
1539 || s{H<([^\>]*)>}
1540 {
1541 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1542 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1543 "")
1544 [$self->{hintmode}]
1545 }ge;
1546
1547 # create single paragraphs (very hackish)
1548 s/(?<=\S)\n(?=\w)/ /g;
1549
1550 # compress some whitespace
1551 s/\s+\n/\n/g; # ws line-ends
1552 s/\n\n+/\n/g; # double lines
1553 s/^\n+//; # beginning lines
1554 s/\n+$//; # ending lines
1555
1556 $_
1557}
1558
1559sub hintmode {
1560 $_[0]{hintmode} = $_[1] if @_ > 1;
1561 $_[0]{hintmode}
1562}
1563
1134=item $player->ext_reply ($msgid, %msg) 1564=item $player->ext_reply ($msgid, @msg)
1135 1565
1136Sends an ext reply to the player. 1566Sends an ext reply to the player.
1137 1567
1138=cut 1568=cut
1139 1569
1140sub ext_reply($$%) { 1570sub ext_reply($$@) {
1141 my ($self, $id, %msg) = @_; 1571 my ($self, $id, @msg) = @_;
1142 1572
1143 $msg{msgid} = $id; 1573 $self->ns->ext_reply ($id, @msg)
1144
1145 $self->send ("ext " . cf::to_json \%msg);
1146} 1574}
1147 1575
1148=item $player->ext_event ($type, %msg) 1576=item $player->ext_msg ($type, @msg)
1149 1577
1150Sends an ext event to the client. 1578Sends an ext event to the client.
1151 1579
1152=cut 1580=cut
1153 1581
1154sub ext_event($$%) { 1582sub ext_msg($$@) {
1155 my ($self, $type, %msg) = @_; 1583 my ($self, $type, @msg) = @_;
1156 1584
1157 $self->ns->ext_event ($type, %msg); 1585 $self->ns->ext_msg ($type, @msg);
1158} 1586}
1159 1587
1160=head3 cf::region 1588=head3 cf::region
1161 1589
1162=over 4 1590=over 4
1165 1593
1166package cf::region; 1594package cf::region;
1167 1595
1168=item cf::region::find_by_path $path 1596=item cf::region::find_by_path $path
1169 1597
1170Tries to decuce the probable region for a map knowing only its path. 1598Tries to decuce the likely region for a map knowing only its path.
1171 1599
1172=cut 1600=cut
1173 1601
1174sub find_by_path($) { 1602sub find_by_path($) {
1175 my ($path) = @_; 1603 my ($path) = @_;
1176 1604
1177 my ($match, $specificity); 1605 my ($match, $specificity);
1178 1606
1179 for my $region (list) { 1607 for my $region (list) {
1180 if ($region->match && $path =~ $region->match) { 1608 if ($region->{match} && $path =~ $region->{match}) {
1181 ($match, $specificity) = ($region, $region->specificity) 1609 ($match, $specificity) = ($region, $region->specificity)
1182 if $region->specificity > $specificity; 1610 if $region->specificity > $specificity;
1183 } 1611 }
1184 } 1612 }
1185 1613
1249 my ($self, $merge) = @_; 1677 my ($self, $merge) = @_;
1250 1678
1251 # we have to keep some variables in memory intact 1679 # we have to keep some variables in memory intact
1252 local $self->{path}; 1680 local $self->{path};
1253 local $self->{load_path}; 1681 local $self->{load_path};
1254 local $self->{deny_save};
1255 local $self->{deny_reset};
1256 1682
1257 $self->SUPER::thawer_merge ($merge); 1683 $self->SUPER::thawer_merge ($merge);
1258} 1684}
1259 1685
1260sub normalise { 1686sub normalise {
1307 $self->init; # pass $1 etc. 1733 $self->init; # pass $1 etc.
1308 return $self; 1734 return $self;
1309 } 1735 }
1310 } 1736 }
1311 1737
1312 Carp::carp "unable to resolve path '$path' (base '$base')."; 1738 Carp::cluck "unable to resolve path '$path' (base '$base').";
1313 () 1739 ()
1314} 1740}
1315 1741
1316sub init { 1742sub init {
1317 my ($self) = @_; 1743 my ($self) = @_;
1332 1758
1333# the original (read-only) location 1759# the original (read-only) location
1334sub load_path { 1760sub load_path {
1335 my ($self) = @_; 1761 my ($self) = @_;
1336 1762
1337 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1763 "$MAPDIR/$self->{path}.map"
1338} 1764}
1339 1765
1340# the temporary/swap location 1766# the temporary/swap location
1341sub save_path { 1767sub save_path {
1342 my ($self) = @_; 1768 my ($self) = @_;
1343 1769
1344 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1770 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1345 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1771 "$TMPDIR/$path.map"
1346} 1772}
1347 1773
1348# the unique path, undef == no special unique path 1774# the unique path, undef == no special unique path
1349sub uniq_path { 1775sub uniq_path {
1350 my ($self) = @_; 1776 my ($self) = @_;
1351 1777
1352 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1778 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1353 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1779 "$UNIQUEDIR/$path"
1354} 1780}
1355 1781
1356# and all this just because we cannot iterate over 1782# and all this just because we cannot iterate over
1357# all maps in C++... 1783# all maps in C++...
1358sub change_all_map_light { 1784sub change_all_map_light {
1360 1786
1361 $_->change_map_light ($change) 1787 $_->change_map_light ($change)
1362 for grep $_->outdoor, values %cf::MAP; 1788 for grep $_->outdoor, values %cf::MAP;
1363} 1789}
1364 1790
1791sub decay_objects {
1792 my ($self) = @_;
1793
1794 return if $self->{deny_reset};
1795
1796 $self->do_decay_objects;
1797}
1798
1365sub unlink_save { 1799sub unlink_save {
1366 my ($self) = @_; 1800 my ($self) = @_;
1367 1801
1368 utf8::encode (my $save = $self->save_path); 1802 utf8::encode (my $save = $self->save_path);
1369 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1803 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1372 1806
1373sub load_header_from($) { 1807sub load_header_from($) {
1374 my ($self, $path) = @_; 1808 my ($self, $path) = @_;
1375 1809
1376 utf8::encode $path; 1810 utf8::encode $path;
1377 #aio_open $path, O_RDONLY, 0 1811 my $f = new_from_file cf::object::thawer $path
1378 # or return;
1379
1380 $self->_load_header ($path)
1381 or return; 1812 or return;
1813
1814 $self->_load_header ($f)
1815 or return;
1816
1817 local $MAP_LOADING{$self->{path}} = $self;
1818 $f->resolve_delayed_derefs;
1382 1819
1383 $self->{load_path} = $path; 1820 $self->{load_path} = $path;
1384 1821
1385 1 1822 1
1386} 1823}
1425 $self->load_header_orig 1862 $self->load_header_orig
1426 or return; 1863 or return;
1427 $self->prepare_orig; 1864 $self->prepare_orig;
1428 } 1865 }
1429 1866
1867 $self->{deny_reset} = 1
1868 if $self->no_reset;
1869
1430 $self->default_region (cf::region::find_by_path $self->{path}) 1870 $self->default_region (cf::region::find_by_path $self->{path})
1431 unless $self->default_region; 1871 unless $self->default_region;
1432 1872
1433 1 1873 1
1434} 1874}
1437sub find { 1877sub find {
1438 my ($path, $origin) = @_; 1878 my ($path, $origin) = @_;
1439 1879
1440 $path = normalise $path, $origin && $origin->path; 1880 $path = normalise $path, $origin && $origin->path;
1441 1881
1882 cf::lock_wait "map_data:$path";#d#remove
1442 cf::lock_wait "map_find:$path"; 1883 cf::lock_wait "map_find:$path";
1443 1884
1444 $cf::MAP{$path} || do { 1885 $cf::MAP{$path} || do {
1445 my $guard = cf::lock_acquire "map_find:$path"; 1886 my $guard1 = cf::lock_acquire "map_find:$path";
1887 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1888
1446 my $map = new_from_path cf::map $path 1889 my $map = new_from_path cf::map $path
1447 or return; 1890 or return;
1448 1891
1449 $map->{last_save} = $cf::RUNTIME; 1892 $map->{last_save} = $cf::RUNTIME;
1450 1893
1451 $map->load_header 1894 $map->load_header
1452 or return; 1895 or return;
1453 1896
1454 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1897 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1455 # doing this can freeze the server in a sync job, obviously 1898 # doing this can freeze the server in a sync job, obviously
1456 #$cf::WAIT_FOR_TICK->wait; 1899 #$cf::WAIT_FOR_TICK->wait;
1900 undef $guard1;
1901 undef $guard2;
1457 $map->reset; 1902 $map->reset;
1458 undef $guard;
1459 return find $path; 1903 return find $path;
1460 } 1904 }
1461 1905
1462 $cf::MAP{$path} = $map 1906 $cf::MAP{$path} = $map
1463 } 1907 }
1470 my ($self) = @_; 1914 my ($self) = @_;
1471 1915
1472 local $self->{deny_reset} = 1; # loading can take a long time 1916 local $self->{deny_reset} = 1; # loading can take a long time
1473 1917
1474 my $path = $self->{path}; 1918 my $path = $self->{path};
1919
1920 {
1475 my $guard = cf::lock_acquire "map_load:$path"; 1921 my $guard = cf::lock_acquire "map_data:$path";
1476 1922
1923 return unless $self->valid;
1477 return if $self->in_memory != cf::MAP_SWAPPED; 1924 return unless $self->in_memory == cf::MAP_SWAPPED;
1478 1925
1479 $self->in_memory (cf::MAP_LOADING); 1926 $self->in_memory (cf::MAP_LOADING);
1480 1927
1481 $self->alloc; 1928 $self->alloc;
1482 1929
1483 $self->pre_load; 1930 $self->pre_load;
1484 Coro::cede; 1931 cf::cede_to_tick;
1485 1932
1486 $self->_load_objects ($self->{load_path}, 1) 1933 my $f = new_from_file cf::object::thawer $self->{load_path};
1934 $f->skip_block;
1935 $self->_load_objects ($f)
1487 or return; 1936 or return;
1488 1937
1489 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1938 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1490 if delete $self->{load_original}; 1939 if delete $self->{load_original};
1491 1940
1492 if (my $uniq = $self->uniq_path) { 1941 if (my $uniq = $self->uniq_path) {
1493 utf8::encode $uniq; 1942 utf8::encode $uniq;
1494 if (aio_open $uniq, O_RDONLY, 0) { 1943 unless (aio_stat $uniq) {
1944 if (my $f = new_from_file cf::object::thawer $uniq) {
1495 $self->clear_unique_items; 1945 $self->clear_unique_items;
1496 $self->_load_objects ($uniq, 0); 1946 $self->_load_objects ($f);
1947 $f->resolve_delayed_derefs;
1948 }
1497 } 1949 }
1498 } 1950 }
1499 1951
1500 Coro::cede; 1952 $f->resolve_delayed_derefs;
1953
1954 cf::cede_to_tick;
1501 # now do the right thing for maps 1955 # now do the right thing for maps
1502 $self->link_multipart_objects; 1956 $self->link_multipart_objects;
1503 Coro::cede;
1504
1505 unless ($self->{deny_activate}) {
1506 $self->decay_objects;
1507 $self->fix_auto_apply;
1508 $self->update_buttons;
1509 Coro::cede;
1510 $self->set_darkness_map;
1511 $self->difficulty ($self->estimate_difficulty) 1957 $self->difficulty ($self->estimate_difficulty)
1512 unless $self->difficulty; 1958 unless $self->difficulty;
1513 Coro::cede; 1959 cf::cede_to_tick;
1960
1961 unless ($self->{deny_activate}) {
1962 $self->decay_objects;
1963 $self->fix_auto_apply;
1964 $self->update_buttons;
1965 cf::cede_to_tick;
1966 $self->set_darkness_map;
1967 cf::cede_to_tick;
1514 $self->activate; 1968 $self->activate;
1515 Coro::cede; 1969 }
1970
1971 $self->{last_save} = $cf::RUNTIME;
1972 $self->last_access ($cf::RUNTIME);
1973
1974 $self->in_memory (cf::MAP_IN_MEMORY);
1516 } 1975 }
1517 1976
1518 $self->post_load; 1977 $self->post_load;
1519 Coro::cede;
1520
1521 $self->in_memory (cf::MAP_IN_MEMORY);
1522} 1978}
1523 1979
1524sub customise_for { 1980sub customise_for {
1525 my ($self, $ob) = @_; 1981 my ($self, $ob) = @_;
1526 1982
1527 return find "~" . $ob->name . "/" . $self->{path} 1983 return find "~" . $ob->name . "/" . $self->{path}
1528 if $self->per_player; 1984 if $self->per_player;
1529 1985
1986# return find "?party/" . $ob->name . "/" . $self->{path}
1987# if $self->per_party;
1988
1530 $self 1989 $self
1531} 1990}
1532 1991
1533# find and load all maps in the 3x3 area around a map 1992# find and load all maps in the 3x3 area around a map
1534sub load_diag { 1993sub load_neighbours {
1535 my ($map) = @_; 1994 my ($map) = @_;
1536 1995
1537 my @diag; # diagonal neighbours 1996 my @neigh; # diagonal neighbours
1538 1997
1539 for (0 .. 3) { 1998 for (0 .. 3) {
1540 my $neigh = $map->tile_path ($_) 1999 my $neigh = $map->tile_path ($_)
1541 or next; 2000 or next;
1542 $neigh = find $neigh, $map 2001 $neigh = find $neigh, $map
1543 or next; 2002 or next;
1544 $neigh->load; 2003 $neigh->load;
1545 2004
2005 push @neigh,
1546 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2006 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1547 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2007 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1548 } 2008 }
1549 2009
1550 for (@diag) { 2010 for (grep defined $_->[0], @neigh) {
2011 my ($path, $origin) = @$_;
1551 my $neigh = find @$_ 2012 my $neigh = find $path, $origin
1552 or next; 2013 or next;
1553 $neigh->load; 2014 $neigh->load;
1554 } 2015 }
1555} 2016}
1556 2017
1561} 2022}
1562 2023
1563sub do_load_sync { 2024sub do_load_sync {
1564 my ($map) = @_; 2025 my ($map) = @_;
1565 2026
2027 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2028 if $Coro::current == $Coro::main;
2029
1566 cf::sync_job { $map->load }; 2030 cf::sync_job { $map->load };
1567} 2031}
1568 2032
1569our %MAP_PREFETCH; 2033our %MAP_PREFETCH;
1570our $MAP_PREFETCHER = undef; 2034our $MAP_PREFETCHER = undef;
1571 2035
1572sub find_async { 2036sub find_async {
1573 my ($path, $origin) = @_; 2037 my ($path, $origin, $load) = @_;
1574 2038
1575 $path = normalise $path, $origin && $origin->{path}; 2039 $path = normalise $path, $origin && $origin->{path};
1576 2040
1577 if (my $map = $cf::MAP{$path}) { 2041 if (my $map = $cf::MAP{$path}) {
1578 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2042 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1579 } 2043 }
1580 2044
1581 undef $MAP_PREFETCH{$path}; 2045 $MAP_PREFETCH{$path} |= $load;
2046
1582 $MAP_PREFETCHER ||= cf::async { 2047 $MAP_PREFETCHER ||= cf::async {
2048 $Coro::current->{desc} = "map prefetcher";
2049
1583 while (%MAP_PREFETCH) { 2050 while (%MAP_PREFETCH) {
1584 for my $path (keys %MAP_PREFETCH) { 2051 while (my ($k, $v) = each %MAP_PREFETCH) {
1585 my $map = find $path 2052 if (my $map = find $k) {
1586 or next;
1587 $map->load; 2053 $map->load if $v;
2054 }
1588 2055
1589 delete $MAP_PREFETCH{$path}; 2056 delete $MAP_PREFETCH{$k};
1590 } 2057 }
1591 } 2058 }
1592 undef $MAP_PREFETCHER; 2059 undef $MAP_PREFETCHER;
1593 }; 2060 };
1594 $MAP_PREFETCHER->prio (6); 2061 $MAP_PREFETCHER->prio (6);
1597} 2064}
1598 2065
1599sub save { 2066sub save {
1600 my ($self) = @_; 2067 my ($self) = @_;
1601 2068
1602 my $lock = cf::lock_acquire "map_data:" . $self->path; 2069 my $lock = cf::lock_acquire "map_data:$self->{path}";
1603 2070
1604 $self->{last_save} = $cf::RUNTIME; 2071 $self->{last_save} = $cf::RUNTIME;
1605 2072
1606 return unless $self->dirty; 2073 return unless $self->dirty;
1607 2074
1613 return if $self->{deny_save}; 2080 return if $self->{deny_save};
1614 2081
1615 local $self->{last_access} = $self->last_access;#d# 2082 local $self->{last_access} = $self->last_access;#d#
1616 2083
1617 cf::async { 2084 cf::async {
2085 $Coro::current->{desc} = "map player save";
1618 $_->contr->save for $self->players; 2086 $_->contr->save for $self->players;
1619 }; 2087 };
1620 2088
1621 if ($uniq) { 2089 if ($uniq) {
1622 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2090 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1630 my ($self) = @_; 2098 my ($self) = @_;
1631 2099
1632 # save first because save cedes 2100 # save first because save cedes
1633 $self->save; 2101 $self->save;
1634 2102
1635 my $lock = cf::lock_acquire "map_data:" . $self->path; 2103 my $lock = cf::lock_acquire "map_data:$self->{path}";
1636 2104
1637 return if $self->players; 2105 return if $self->players;
1638 return if $self->in_memory != cf::MAP_IN_MEMORY; 2106 return if $self->in_memory != cf::MAP_IN_MEMORY;
1639 return if $self->{deny_save}; 2107 return if $self->{deny_save};
1640 2108
2109 $self->in_memory (cf::MAP_SWAPPED);
2110
2111 $self->deactivate;
2112 $_->clear_links_to ($self) for values %cf::MAP;
1641 $self->clear; 2113 $self->clear;
1642 $self->in_memory (cf::MAP_SWAPPED);
1643} 2114}
1644 2115
1645sub reset_at { 2116sub reset_at {
1646 my ($self) = @_; 2117 my ($self) = @_;
1647 2118
1648 # TODO: safety, remove and allow resettable per-player maps 2119 # TODO: safety, remove and allow resettable per-player maps
1649 return 1e99 if $self->isa ("ext::map_per_player");#d#
1650 return 1e99 if $self->{deny_reset}; 2120 return 1e99 if $self->{deny_reset};
1651 2121
1652 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2122 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1653 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2123 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1654 2124
1665 my ($self) = @_; 2135 my ($self) = @_;
1666 2136
1667 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2137 my $lock = cf::lock_acquire "map_data:$self->{path}";
1668 2138
1669 return if $self->players; 2139 return if $self->players;
1670 return if $self->isa ("ext::map_per_player");#d#
1671 2140
1672 warn "resetting map ", $self->path;#d# 2141 warn "resetting map ", $self->path;
1673 2142
1674 $self->in_memory (cf::MAP_SWAPPED); 2143 $self->in_memory (cf::MAP_SWAPPED);
1675 2144
1676 # need to save uniques path 2145 # need to save uniques path
1677 unless ($self->{deny_save}) { 2146 unless ($self->{deny_save}) {
1681 if $uniq; 2150 if $uniq;
1682 } 2151 }
1683 2152
1684 delete $cf::MAP{$self->path}; 2153 delete $cf::MAP{$self->path};
1685 2154
2155 $self->deactivate;
2156 $_->clear_links_to ($self) for values %cf::MAP;
1686 $self->clear; 2157 $self->clear;
1687
1688 $_->clear_links_to ($self) for values %cf::MAP;
1689 2158
1690 $self->unlink_save; 2159 $self->unlink_save;
1691 $self->destroy; 2160 $self->destroy;
1692} 2161}
1693 2162
1694my $nuke_counter = "aaaa"; 2163my $nuke_counter = "aaaa";
1695 2164
1696sub nuke { 2165sub nuke {
1697 my ($self) = @_; 2166 my ($self) = @_;
1698 2167
2168 {
2169 my $lock = cf::lock_acquire "map_data:$self->{path}";
2170
1699 delete $cf::MAP{$self->path}; 2171 delete $cf::MAP{$self->path};
1700 2172
1701 $self->unlink_save; 2173 $self->unlink_save;
1702 2174
1703 bless $self, "cf::map"; 2175 bless $self, "cf::map";
1704 delete $self->{deny_reset}; 2176 delete $self->{deny_reset};
1705 $self->{deny_save} = 1; 2177 $self->{deny_save} = 1;
1706 $self->reset_timeout (1); 2178 $self->reset_timeout (1);
1707 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2179 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1708 2180
1709 $cf::MAP{$self->path} = $self; 2181 $cf::MAP{$self->path} = $self;
2182 }
1710 2183
1711 $self->reset; # polite request, might not happen 2184 $self->reset; # polite request, might not happen
2185}
2186
2187=item $maps = cf::map::tmp_maps
2188
2189Returns an arrayref with all map paths of currently instantiated and saved
2190maps. May block.
2191
2192=cut
2193
2194sub tmp_maps() {
2195 [
2196 map {
2197 utf8::decode $_;
2198 /\.map$/
2199 ? normalise $_
2200 : ()
2201 } @{ aio_readdir $TMPDIR or [] }
2202 ]
2203}
2204
2205=item $maps = cf::map::random_maps
2206
2207Returns an arrayref with all map paths of currently instantiated and saved
2208random maps. May block.
2209
2210=cut
2211
2212sub random_maps() {
2213 [
2214 map {
2215 utf8::decode $_;
2216 /\.map$/
2217 ? normalise "?random/$_"
2218 : ()
2219 } @{ aio_readdir $RANDOMDIR or [] }
2220 ]
1712} 2221}
1713 2222
1714=item cf::map::unique_maps 2223=item cf::map::unique_maps
1715 2224
1716Returns an arrayref of paths of all shared maps that have 2225Returns an arrayref of paths of all shared maps that have
1717instantiated unique items. May block. 2226instantiated unique items. May block.
1718 2227
1719=cut 2228=cut
1720 2229
1721sub unique_maps() { 2230sub unique_maps() {
1722 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2231 [
1723 or return; 2232 map {
1724
1725 my @paths;
1726
1727 for (@$files) {
1728 utf8::decode $_; 2233 utf8::decode $_;
1729 next if /\.pst$/; 2234 /\.map$/
1730 next unless /^$PATH_SEP/o; 2235 ? normalise $_
1731 2236 : ()
1732 push @paths, cf::map::normalise $_; 2237 } @{ aio_readdir $UNIQUEDIR or [] }
1733 } 2238 ]
1734
1735 \@paths
1736} 2239}
1737 2240
1738package cf; 2241package cf;
1739 2242
1740=back 2243=back
1758 map { $_, inv_recursive_ $_->inv } @_ 2261 map { $_, inv_recursive_ $_->inv } @_
1759} 2262}
1760 2263
1761sub inv_recursive { 2264sub inv_recursive {
1762 inv_recursive_ inv $_[0] 2265 inv_recursive_ inv $_[0]
2266}
2267
2268=item $ref = $ob->ref
2269
2270creates and returns a persistent reference to an objetc that can be stored as a string.
2271
2272=item $ob = cf::object::deref ($refstring)
2273
2274returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2275even if the object actually exists. May block.
2276
2277=cut
2278
2279sub deref {
2280 my ($ref) = @_;
2281
2282 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2283 my ($uuid, $name) = ($1, $2);
2284 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2285 or return;
2286 $pl->ob->uuid eq $uuid
2287 or return;
2288
2289 $pl->ob
2290 } else {
2291 warn "$ref: cannot resolve object reference\n";
2292 undef
2293 }
1763} 2294}
1764 2295
1765package cf; 2296package cf;
1766 2297
1767=back 2298=back
1786 2317
1787 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2318 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1788 2319
1789 if ($self->{record_replies}) { 2320 if ($self->{record_replies}) {
1790 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2321 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2322
1791 } else { 2323 } else {
2324 my $pl = $self->contr;
2325
2326 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2327 my $dialog = $pl->{npc_dialog};
2328 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2329
2330 } else {
1792 $msg = $npc->name . " says: $msg" if $npc; 2331 $msg = $npc->name . " says: $msg" if $npc;
1793 $self->message ($msg, $flags); 2332 $self->message ($msg, $flags);
2333 }
1794 } 2334 }
2335}
2336
2337=item $object->send_msg ($channel, $msg, $color, [extra...])
2338
2339=cut
2340
2341sub cf::object::send_msg {
2342 my $pl = shift->contr
2343 or return;
2344 $pl->send_msg (@_);
1795} 2345}
1796 2346
1797=item $player_object->may ("access") 2347=item $player_object->may ("access")
1798 2348
1799Returns wether the given player is authorized to access resource "access" 2349Returns wether the given player is authorized to access resource "access"
1846 $self->deactivate_recursive; 2396 $self->deactivate_recursive;
1847 2397
1848 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2398 return if UNIVERSAL::isa $self->map, "ext::map_link";
1849 2399
1850 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2400 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1851 if $self->map; 2401 if $self->map && $self->map->{path} ne "{link}";
1852 2402
1853 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2403 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1854} 2404}
1855 2405
1856sub cf::object::player::leave_link { 2406sub cf::object::player::leave_link {
1857 my ($self, $map, $x, $y) = @_; 2407 my ($self, $map, $x, $y) = @_;
2408
2409 return unless $self->contr->active;
1858 2410
1859 my $link_pos = delete $self->{_link_pos}; 2411 my $link_pos = delete $self->{_link_pos};
1860 2412
1861 unless ($map) { 2413 unless ($map) {
1862 # restore original map position 2414 # restore original map position
1876 # use -1 or undef as default coordinates, not 0, 0 2428 # use -1 or undef as default coordinates, not 0, 0
1877 ($x, $y) = ($map->enter_x, $map->enter_y) 2429 ($x, $y) = ($map->enter_x, $map->enter_y)
1878 if $x <=0 && $y <= 0; 2430 if $x <=0 && $y <= 0;
1879 2431
1880 $map->load; 2432 $map->load;
1881 $map->load_diag; 2433 $map->load_neighbours;
1882 2434
1883 return unless $self->contr->active; 2435 return unless $self->contr->active;
1884 $self->activate_recursive; 2436 $self->activate_recursive;
1885 2437
1886 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2438 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1887 $self->enter_map ($map, $x, $y); 2439 $self->enter_map ($map, $x, $y);
1888} 2440}
1889 2441
1890cf::player->attach ( 2442=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1891 on_logout => sub {
1892 my ($pl) = @_;
1893 2443
1894 # abort map switching before logout 2444Moves the player to the given map-path and coordinates by first freezing
1895 if ($pl->ob->{_link_pos}) { 2445her, loading and preparing them map, calling the provided $check callback
1896 cf::sync_job { 2446that has to return the map if sucecssful, and then unfreezes the player on
1897 $pl->ob->leave_link 2447the new (success) or old (failed) map position. In either case, $done will
1898 }; 2448be called at the end of this process.
1899 }
1900 },
1901 on_login => sub {
1902 my ($pl) = @_;
1903 2449
1904 # try to abort aborted map switching on player login :)
1905 # should happen only on crashes
1906 if ($pl->ob->{_link_pos}) {
1907 $pl->ob->enter_link;
1908 (async {
1909 $pl->ob->reply (undef,
1910 "There was an internal problem at your last logout, "
1911 . "the server will try to bring you to your intended destination in a second.",
1912 cf::NDI_RED);
1913 # we need this sleep as the login has a concurrent enter_exit running
1914 # and this sleep increases chances of the player not ending up in scorn
1915 Coro::Timer::sleep 1;
1916 $pl->ob->leave_link;
1917 })->prio (2);
1918 }
1919 },
1920);
1921
1922=item $player_object->goto ($path, $x, $y)
1923
1924=cut 2450=cut
2451
2452our $GOTOGEN;
1925 2453
1926sub cf::object::player::goto { 2454sub cf::object::player::goto {
1927 my ($self, $path, $x, $y) = @_; 2455 my ($self, $path, $x, $y, $check, $done) = @_;
2456
2457 # do generation counting so two concurrent goto's will be executed in-order
2458 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1928 2459
1929 $self->enter_link; 2460 $self->enter_link;
1930 2461
1931 (async { 2462 (async {
2463 $Coro::current->{desc} = "player::goto $path $x $y";
2464
2465 # *tag paths override both path and x|y
2466 if ($path =~ /^\*(.*)$/) {
2467 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2468 my $ob = $obs[rand @obs];
2469
2470 # see if we actually can go there
2471 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2472 $ob = $obs[rand @obs];
2473 } else {
2474 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2475 }
2476 # else put us there anyways for now #d#
2477
2478 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2479 } else {
2480 ($path, $x, $y) = (undef, undef, undef);
2481 }
2482 }
2483
1932 my $map = eval { 2484 my $map = eval {
1933 my $map = cf::map::find $path; 2485 my $map = defined $path ? cf::map::find $path : undef;
2486
2487 if ($map) {
1934 $map = $map->customise_for ($self) if $map; 2488 $map = $map->customise_for ($self);
2489 $map = $check->($map) if $check && $map;
2490 } else {
2491 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2492 }
2493
1935 $map 2494 $map
2495 };
2496
2497 if ($@) {
2498 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2499 LOG llevError | logBacktrace, Carp::longmess $@;
1936 } or 2500 }
1937 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1938 2501
2502 if ($gen == $self->{_goto_generation}) {
2503 delete $self->{_goto_generation};
1939 $self->leave_link ($map, $x, $y); 2504 $self->leave_link ($map, $x, $y);
2505 }
2506
2507 $done->() if $done;
1940 })->prio (1); 2508 })->prio (1);
1941} 2509}
1942 2510
1943=item $player_object->enter_exit ($exit_object) 2511=item $player_object->enter_exit ($exit_object)
1944 2512
1983 2551
1984 $rmp->{random_seed} ||= $exit->random_seed; 2552 $rmp->{random_seed} ||= $exit->random_seed;
1985 2553
1986 my $data = cf::to_json $rmp; 2554 my $data = cf::to_json $rmp;
1987 my $md5 = Digest::MD5::md5_hex $data; 2555 my $md5 = Digest::MD5::md5_hex $data;
1988 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2556 my $meta = "$RANDOMDIR/$md5.meta";
1989 2557
1990 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2558 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1991 aio_write $fh, 0, (length $data), $data, 0; 2559 aio_write $fh, 0, (length $data), $data, 0;
1992 undef $fh; 2560 undef $fh;
1993 aio_rename "$meta~", $meta; 2561 aio_rename "$meta~", $meta;
2013 my $hp = $exit->stats->hp; 2581 my $hp = $exit->stats->hp;
2014 my $sp = $exit->stats->sp; 2582 my $sp = $exit->stats->sp;
2015 2583
2016 $self->enter_link; 2584 $self->enter_link;
2017 2585
2586 # if exit is damned, update players death & WoR home-position
2587 $self->contr->savebed ($slaying, $hp, $sp)
2588 if $exit->flag (FLAG_DAMNED);
2589
2018 (async { 2590 (async {
2591 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2592
2019 $self->deactivate_recursive; # just to be sure 2593 $self->deactivate_recursive; # just to be sure
2020 unless (eval { 2594 unless (eval {
2021 $self->goto ($slaying, $hp, $sp); 2595 $self->goto ($slaying, $hp, $sp);
2022 2596
2023 1; 2597 1;
2049 2623
2050 utf8::encode $text; 2624 utf8::encode $text;
2051 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2625 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2052} 2626}
2053 2627
2628=item $client->send_msg ($channel, $msg, $color, [extra...])
2629
2630Send a drawinfo or msg packet to the client, formatting the msg for the
2631client if neccessary. C<$type> should be a string identifying the type of
2632the message, with C<log> being the default. If C<$color> is negative, suppress
2633the message unless the client supports the msg packet.
2634
2635=cut
2636
2637our %CHANNEL = (
2638 "c/identify" => {
2639 id => "infobox",
2640 title => "Identify",
2641 reply => undef,
2642 tooltip => "Items recently identified",
2643 },
2644 "c/examine" => {
2645 id => "infobox",
2646 title => "Examine",
2647 reply => undef,
2648 tooltip => "Signs and other items you examined",
2649 },
2650 "c/lookat" => {
2651 id => "infobox",
2652 title => "Look",
2653 reply => undef,
2654 tooltip => "What you saw there",
2655 },
2656);
2657
2658sub cf::client::send_msg {
2659 my ($self, $channel, $msg, $color, @extra) = @_;
2660
2661 $msg = $self->pl->expand_cfpod ($msg);
2662
2663 $color &= cf::NDI_CLIENT_MASK; # just in case...
2664
2665 # check predefined channels, for the benefit of C
2666 if ($CHANNEL{$channel}) {
2667 $channel = $CHANNEL{$channel};
2668
2669 $self->ext_msg (channel_info => $channel)
2670 if $self->can_msg;
2671
2672 $channel = $channel->{id};
2673
2674 } elsif (ref $channel) {
2675 # send meta info to client, if not yet sent
2676 unless (exists $self->{channel}{$channel->{id}}) {
2677 $self->{channel}{$channel->{id}} = $channel;
2678 $self->ext_msg (channel_info => $channel)
2679 if $self->can_msg;
2680 }
2681
2682 $channel = $channel->{id};
2683 }
2684
2685 return unless @extra || length $msg;
2686
2687 if ($self->can_msg) {
2688 # default colour, mask it out
2689 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2690 if $color & cf::NDI_DEF;
2691
2692 $self->send_packet ("msg " . $self->{json_coder}->encode (
2693 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2694 } else {
2695 if ($color >= 0) {
2696 # replace some tags by gcfclient-compatible ones
2697 for ($msg) {
2698 1 while
2699 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2700 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2701 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2702 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2703 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2704 }
2705
2706 $color &= cf::NDI_COLOR_MASK;
2707
2708 utf8::encode $msg;
2709
2710 if (0 && $msg =~ /\[/) {
2711 # COMMAND/INFO
2712 $self->send_packet ("drawextinfo $color 10 8 $msg")
2713 } else {
2714 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2715 $self->send_packet ("drawinfo $color $msg")
2716 }
2717 }
2718 }
2719}
2720
2054=item $client->ext_event ($type, %msg) 2721=item $client->ext_msg ($type, @msg)
2055 2722
2056Sends an exti event to the client. 2723Sends an ext event to the client.
2057 2724
2058=cut 2725=cut
2059 2726
2060sub cf::client::ext_event($$%) { 2727sub cf::client::ext_msg($$@) {
2061 my ($self, $type, %msg) = @_; 2728 my ($self, $type, @msg) = @_;
2062 2729
2730 if ($self->extcmd == 2) {
2731 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2732 } elsif ($self->extcmd == 1) { # TODO: remove
2063 $msg{msgtype} = "event_$type"; 2733 push @msg, msgtype => "event_$type";
2064 $self->send_packet ("ext " . cf::to_json \%msg); 2734 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2735 }
2736}
2737
2738=item $client->ext_reply ($msgid, @msg)
2739
2740Sends an ext reply to the client.
2741
2742=cut
2743
2744sub cf::client::ext_reply($$@) {
2745 my ($self, $id, @msg) = @_;
2746
2747 if ($self->extcmd == 2) {
2748 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2749 } elsif ($self->extcmd == 1) {
2750 #TODO: version 1, remove
2751 unshift @msg, msgtype => "reply", msgid => $id;
2752 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2753 }
2065} 2754}
2066 2755
2067=item $success = $client->query ($flags, "text", \&cb) 2756=item $success = $client->query ($flags, "text", \&cb)
2068 2757
2069Queues a query to the client, calling the given callback with 2758Queues a query to the client, calling the given callback with
2070the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2759the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2071C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2760C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2072 2761
2073Queries can fail, so check the return code. Or don't, as queries will become 2762Queries can fail, so check the return code. Or don't, as queries will
2074reliable at some point in the future. 2763become reliable at some point in the future.
2075 2764
2076=cut 2765=cut
2077 2766
2078sub cf::client::query { 2767sub cf::client::query {
2079 my ($self, $flags, $text, $cb) = @_; 2768 my ($self, $flags, $text, $cb) = @_;
2087 utf8::encode $text; 2776 utf8::encode $text;
2088 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2777 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2089 2778
2090 $self->send_packet ($self->{query_queue}[0][0]) 2779 $self->send_packet ($self->{query_queue}[0][0])
2091 if @{ $self->{query_queue} } == 1; 2780 if @{ $self->{query_queue} } == 1;
2781
2782 1
2092} 2783}
2093 2784
2094cf::client->attach ( 2785cf::client->attach (
2786 on_connect => sub {
2787 my ($ns) = @_;
2788
2789 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2790 },
2095 on_reply => sub { 2791 on_reply => sub {
2096 my ($ns, $msg) = @_; 2792 my ($ns, $msg) = @_;
2097 2793
2098 # this weird shuffling is so that direct followup queries 2794 # this weird shuffling is so that direct followup queries
2099 # get handled first 2795 # get handled first
2111 } else { 2807 } else {
2112 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2808 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2113 } 2809 }
2114 } 2810 }
2115 }, 2811 },
2812 on_exticmd => sub {
2813 my ($ns, $buf) = @_;
2814
2815 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2816
2817 if (ref $msg) {
2818 my ($type, $reply, @payload) =
2819 "ARRAY" eq ref $msg
2820 ? @$msg
2821 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2822
2823 my @reply;
2824
2825 if (my $cb = $EXTICMD{$type}) {
2826 @reply = $cb->($ns, @payload);
2827 }
2828
2829 $ns->ext_reply ($reply, @reply)
2830 if $reply;
2831
2832 } else {
2833 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2834 }
2835
2836 cf::override;
2837 },
2116); 2838);
2117 2839
2118=item $client->async (\&cb) 2840=item $client->async (\&cb)
2119 2841
2120Create a new coroutine, running the specified callback. The coroutine will 2842Create a new coroutine, running the specified callback. The coroutine will
2161our $safe = new Safe "safe"; 2883our $safe = new Safe "safe";
2162our $safe_hole = new Safe::Hole; 2884our $safe_hole = new Safe::Hole;
2163 2885
2164$SIG{FPE} = 'IGNORE'; 2886$SIG{FPE} = 'IGNORE';
2165 2887
2166$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2888$safe->permit_only (Opcode::opset qw(
2889 :base_core :base_mem :base_orig :base_math
2890 grepstart grepwhile mapstart mapwhile
2891 sort time
2892));
2167 2893
2168# here we export the classes and methods available to script code 2894# here we export the classes and methods available to script code
2169 2895
2170=pod 2896=pod
2171 2897
2172The following functions and methods are available within a safe environment: 2898The following functions and methods are available within a safe environment:
2173 2899
2174 cf::object contr pay_amount pay_player map 2900 cf::object
2901 contr pay_amount pay_player map x y force_find force_add destroy
2902 insert remove name archname title slaying race decrease_ob_nr
2903
2175 cf::object::player player 2904 cf::object::player
2176 cf::player peaceful 2905 player
2177 cf::map trigger 2906
2907 cf::player
2908 peaceful
2909
2910 cf::map
2911 trigger
2178 2912
2179=cut 2913=cut
2180 2914
2181for ( 2915for (
2182 ["cf::object" => qw(contr pay_amount pay_player map)], 2916 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2917 insert remove inv name archname title slaying race
2918 decrease_ob_nr destroy)],
2183 ["cf::object::player" => qw(player)], 2919 ["cf::object::player" => qw(player)],
2184 ["cf::player" => qw(peaceful)], 2920 ["cf::player" => qw(peaceful)],
2185 ["cf::map" => qw(trigger)], 2921 ["cf::map" => qw(trigger)],
2186) { 2922) {
2187 no strict 'refs'; 2923 no strict 'refs';
2258=back 2994=back
2259 2995
2260=cut 2996=cut
2261 2997
2262############################################################################# 2998#############################################################################
2263
2264=head2 EXTENSION DATABASE SUPPORT
2265
2266Crossfire maintains a very simple database for extension use. It can
2267currently store anything that can be serialised using Storable, which
2268excludes objects.
2269
2270The parameter C<$family> should best start with the name of the extension
2271using it, it should be unique.
2272
2273=over 4
2274
2275=item $value = cf::db_get $family => $key
2276
2277Returns a single value from the database.
2278
2279=item cf::db_put $family => $key => $value
2280
2281Stores the given C<$value> in the family.
2282
2283=cut
2284
2285our $DB;
2286
2287sub db_init {
2288 unless ($DB) {
2289 $DB = BDB::db_create $DB_ENV;
2290
2291 cf::sync_job {
2292 eval {
2293 $DB->set_flags (BDB::CHKSUM);
2294
2295 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2296 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2297 cf::cleanup "db_open(db): $!" if $!;
2298 };
2299 cf::cleanup "db_open(db): $@" if $@;
2300 };
2301
2302 my $path = cf::localdir . "/database.pst";
2303 if (stat $path) {
2304 cf::sync_job {
2305 my $pst = Storable::retrieve $path;
2306
2307 cf::db_put (board => data => $pst->{board});
2308 cf::db_put (guildrules => data => $pst->{guildrules});
2309 cf::db_put (rent => balance => $pst->{rent}{balance});
2310 BDB::db_env_txn_checkpoint $DB_ENV;
2311
2312 unlink $path;
2313 };
2314 }
2315 }
2316}
2317
2318sub db_get($$) {
2319 my $key = "$_[0]/$_[1]";
2320
2321 cf::sync_job {
2322 BDB::db_get $DB, undef, $key, my $data;
2323
2324 $! ? ()
2325 : Compress::LZF::sthaw $data
2326 }
2327}
2328
2329sub db_put($$$) {
2330 BDB::dbreq_pri 4;
2331 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2332}
2333
2334=item cf::cache $id => ...
2335
2336Generic caching function that returns the value of the resource $id,
2337caching and regenerating as required.
2338
2339This function can block.
2340
2341 source => filename returning the data (must be a scalar)
2342 expensive => true == try to cache harder
2343 filter => sub that processes the data into a scalar
2344
2345=cut
2346
2347sub cache {
2348 my ($id, %arg) = @_;
2349
2350 aio_stat $arg{source}
2351 and Carp::croak "$arg{source}: $!";
2352
2353 my $meta = join ":", (stat _)[7,9];
2354 my $md5;
2355
2356 if ($arg{expensive}) {
2357 0 <= aio_load $arg{source}, my $buf
2358 or Carp::croak "$arg{source}: $!";
2359
2360 $md5 = Digest::MD5::md5_hex $buf;
2361 }
2362
2363 my $dbmeta = db_get "$id/meta";
2364 if ($dbmeta ne $meta) {
2365 # changed, we need to process
2366 } else {
2367 # just fetch
2368 }
2369
2370
2371}
2372
2373#############################################################################
2374# the server's init and main functions 2999# the server's init and main functions
2375 3000
2376sub load_facedata($) { 3001sub load_facedata($) {
2377 my ($path) = @_; 3002 my ($path) = @_;
3003
3004 # HACK to clear player env face cache, we need some signal framework
3005 # for this (global event?)
3006 %ext::player_env::MUSIC_FACE_CACHE = ();
3007
3008 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2378 3009
2379 warn "loading facedata from $path\n"; 3010 warn "loading facedata from $path\n";
2380 3011
2381 my $facedata; 3012 my $facedata;
2382 0 < aio_load $path, $facedata 3013 0 < aio_load $path, $facedata
2385 $facedata = Coro::Storable::thaw $facedata; 3016 $facedata = Coro::Storable::thaw $facedata;
2386 3017
2387 $facedata->{version} == 2 3018 $facedata->{version} == 2
2388 or cf::cleanup "$path: version mismatch, cannot proceed."; 3019 or cf::cleanup "$path: version mismatch, cannot proceed.";
2389 3020
3021 # patch in the exptable
3022 $facedata->{resource}{"res/exp_table"} = {
3023 type => FT_RSRC,
3024 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3025 };
3026 cf::cede_to_tick;
3027
2390 { 3028 {
2391 my $faces = $facedata->{faceinfo}; 3029 my $faces = $facedata->{faceinfo};
2392 3030
2393 while (my ($face, $info) = each %$faces) { 3031 while (my ($face, $info) = each %$faces) {
2394 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3032 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2395 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 3033 cf::face::set_visibility $idx, $info->{visibility};
3034 cf::face::set_magicmap $idx, $info->{magicmap};
2396 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3035 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2397 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 3036 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2398 Coro::cede; 3037
3038 cf::cede_to_tick;
2399 } 3039 }
2400 3040
2401 while (my ($face, $info) = each %$faces) { 3041 while (my ($face, $info) = each %$faces) {
2402 next unless $info->{smooth}; 3042 next unless $info->{smooth};
2403 my $idx = cf::face::find $face 3043 my $idx = cf::face::find $face
2404 or next; 3044 or next;
2405 if (my $smooth = cf::face::find $info->{smooth}) { 3045 if (my $smooth = cf::face::find $info->{smooth}) {
3046 cf::face::set_smooth $idx, $smooth;
2406 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 3047 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2407 } else { 3048 } else {
2408 warn "smooth face '$info->{smooth}' not found for face '$face'"; 3049 warn "smooth face '$info->{smooth}' not found for face '$face'";
2409 } 3050 }
2410 Coro::cede; 3051
3052 cf::cede_to_tick;
2411 } 3053 }
2412 } 3054 }
2413 3055
2414 { 3056 {
2415 my $anims = $facedata->{animinfo}; 3057 my $anims = $facedata->{animinfo};
2416 3058
2417 while (my ($anim, $info) = each %$anims) { 3059 while (my ($anim, $info) = each %$anims) {
2418 cf::anim::set $anim, $info->{frames}, $info->{facings}; 3060 cf::anim::set $anim, $info->{frames}, $info->{facings};
2419 Coro::cede; 3061 cf::cede_to_tick;
2420 } 3062 }
2421 3063
2422 cf::anim::invalidate_all; # d'oh 3064 cf::anim::invalidate_all; # d'oh
2423 } 3065 }
2424 3066
3067 {
3068 # TODO: for gcfclient pleasure, we should give resources
3069 # that gcfclient doesn't grok a >10000 face index.
3070 my $res = $facedata->{resource};
3071
3072 my $soundconf = delete $res->{"res/sound.conf"};
3073
3074 while (my ($name, $info) = each %$res) {
3075 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3076 my $data;
3077
3078 if ($info->{type} & 1) {
3079 # prepend meta info
3080
3081 my $meta = $enc->encode ({
3082 name => $name,
3083 %{ $info->{meta} || {} },
3084 });
3085
3086 $data = pack "(w/a*)*", $meta, $info->{data};
3087 } else {
3088 $data = $info->{data};
3089 }
3090
3091 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3092 cf::face::set_type $idx, $info->{type};
3093
3094 cf::cede_to_tick;
3095 }
3096
3097 if ($soundconf) {
3098 $soundconf = $enc->decode (delete $soundconf->{data});
3099
3100 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3101 my $sound = $soundconf->{compat}[$_]
3102 or next;
3103
3104 my $face = cf::face::find "sound/$sound->[1]";
3105 cf::sound::set $sound->[0] => $face;
3106 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3107 }
3108
3109 while (my ($k, $v) = each %{$soundconf->{event}}) {
3110 my $face = cf::face::find "sound/$v";
3111 cf::sound::set $k => $face;
3112 }
3113 }
3114 }
3115
2425 1 3116 1
2426} 3117}
2427 3118
3119register_exticmd fx_want => sub {
3120 my ($ns, $want) = @_;
3121
3122 while (my ($k, $v) = each %$want) {
3123 $ns->fx_want ($k, $v);
3124 }
3125};
3126
3127sub reload_regions {
3128 # HACK to clear player env face cache, we need some signal framework
3129 # for this (global event?)
3130 %ext::player_env::MUSIC_FACE_CACHE = ();
3131
3132 load_resource_file "$MAPDIR/regions"
3133 or die "unable to load regions file\n";
3134
3135 for (cf::region::list) {
3136 $_->{match} = qr/$_->{match}/
3137 if exists $_->{match};
3138 }
3139}
3140
2428sub reload_facedata { 3141sub reload_facedata {
2429 load_facedata sprintf "%s/facedata", cf::datadir 3142 load_facedata "$DATADIR/facedata"
2430 or die "unable to load facedata\n"; 3143 or die "unable to load facedata\n";
2431} 3144}
2432 3145
2433sub reload_regions {
2434 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2435 or die "unable to load regions file\n";
2436}
2437
2438sub reload_archetypes { 3146sub reload_archetypes {
2439 load_resource_file sprintf "%s/archetypes", cf::datadir 3147 load_resource_file "$DATADIR/archetypes"
2440 or die "unable to load archetypes\n"; 3148 or die "unable to load archetypes\n";
3149 #d# NEED to laod twice to resolve forward references
3150 # this really needs to be done in an extra post-pass
3151 # (which needs to be synchronous, so solve it differently)
3152 load_resource_file "$DATADIR/archetypes"
3153 or die "unable to load archetypes\n";
2441} 3154}
2442 3155
2443sub reload_treasures { 3156sub reload_treasures {
2444 load_resource_file sprintf "%s/treasures", cf::datadir 3157 load_resource_file "$DATADIR/treasures"
2445 or die "unable to load treasurelists\n"; 3158 or die "unable to load treasurelists\n";
2446} 3159}
2447 3160
2448sub reload_resources { 3161sub reload_resources {
2449 warn "reloading resource files...\n"; 3162 warn "reloading resource files...\n";
2450 3163
2451 reload_regions; 3164 reload_regions;
2452 reload_facedata; 3165 reload_facedata;
3166 #reload_archetypes;#d#
2453 reload_archetypes; 3167 reload_archetypes;
2454 reload_treasures; 3168 reload_treasures;
2455 3169
2456 warn "finished reloading resource files\n"; 3170 warn "finished reloading resource files\n";
2457} 3171}
2458 3172
2459sub init { 3173sub init {
2460 reload_resources; 3174 reload_resources;
2461} 3175}
2462 3176
2463sub cfg_load { 3177sub reload_config {
2464 open my $fh, "<:utf8", cf::confdir . "/config" 3178 open my $fh, "<:utf8", "$CONFDIR/config"
2465 or return; 3179 or return;
2466 3180
2467 local $/; 3181 local $/;
2468 *CFG = YAML::Syck::Load <$fh>; 3182 *CFG = YAML::Syck::Load <$fh>;
2469 3183
2484sub main { 3198sub main {
2485 # we must not ever block the main coroutine 3199 # we must not ever block the main coroutine
2486 local $Coro::idle = sub { 3200 local $Coro::idle = sub {
2487 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3201 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2488 (async { 3202 (async {
3203 $Coro::current->{desc} = "IDLE BUG HANDLER";
2489 Event::one_event; 3204 Event::one_event;
2490 })->prio (Coro::PRIO_MAX); 3205 })->prio (Coro::PRIO_MAX);
2491 }; 3206 };
2492 3207
2493 cfg_load; 3208 reload_config;
2494 db_init; 3209 db_init;
2495 load_extensions; 3210 load_extensions;
2496 3211
2497 $TICK_WATCHER->start; 3212 $TICK_WATCHER->start;
2498 Event::loop; 3213 Event::loop;
2514 }, 3229 },
2515 ); 3230 );
2516 } 3231 }
2517} 3232}
2518 3233
3234sub write_runtime {
3235 my $runtime = "$LOCALDIR/runtime";
3236
3237 # first touch the runtime file to show we are still running:
3238 # the fsync below can take a very very long time.
3239
3240 IO::AIO::aio_utime $runtime, undef, undef;
3241
3242 my $guard = cf::lock_acquire "write_runtime";
3243
3244 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3245 or return;
3246
3247 my $value = $cf::RUNTIME + 90 + 10;
3248 # 10 is the runtime save interval, for a monotonic clock
3249 # 60 allows for the watchdog to kill the server.
3250
3251 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3252 and return;
3253
3254 # always fsync - this file is important
3255 aio_fsync $fh
3256 and return;
3257
3258 # touch it again to show we are up-to-date
3259 aio_utime $fh, undef, undef;
3260
3261 close $fh
3262 or return;
3263
3264 aio_rename "$runtime~", $runtime
3265 and return;
3266
3267 warn "runtime file written.\n";
3268
3269 1
3270}
3271
2519sub emergency_save() { 3272sub emergency_save() {
2520 my $freeze_guard = cf::freeze_mainloop; 3273 my $freeze_guard = cf::freeze_mainloop;
2521 3274
2522 warn "enter emergency perl save\n"; 3275 warn "enter emergency perl save\n";
2523 3276
2527 # and maps saved/destroyed asynchronously. 3280 # and maps saved/destroyed asynchronously.
2528 warn "begin emergency player save\n"; 3281 warn "begin emergency player save\n";
2529 for my $login (keys %cf::PLAYER) { 3282 for my $login (keys %cf::PLAYER) {
2530 my $pl = $cf::PLAYER{$login} or next; 3283 my $pl = $cf::PLAYER{$login} or next;
2531 $pl->valid or next; 3284 $pl->valid or next;
3285 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2532 $pl->save; 3286 $pl->save;
2533 } 3287 }
2534 warn "end emergency player save\n"; 3288 warn "end emergency player save\n";
2535 3289
2536 warn "begin emergency map save\n"; 3290 warn "begin emergency map save\n";
2598 %EXT_CORO = (); 3352 %EXT_CORO = ();
2599 3353
2600 warn "removing commands"; 3354 warn "removing commands";
2601 %COMMAND = (); 3355 %COMMAND = ();
2602 3356
2603 warn "removing ext commands"; 3357 warn "removing ext/exti commands";
2604 %EXTCMD = (); 3358 %EXTCMD = ();
3359 %EXTICMD = ();
2605 3360
2606 warn "unloading/nuking all extensions"; 3361 warn "unloading/nuking all extensions";
2607 for my $pkg (@EXTS) { 3362 for my $pkg (@EXTS) {
2608 warn "... unloading $pkg"; 3363 warn "... unloading $pkg";
2609 3364
2639 Symbol::delete_package "safe::$_" 3394 Symbol::delete_package "safe::$_"
2640 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3395 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2641 3396
2642 warn "unloading cf.pm \"a bit\""; 3397 warn "unloading cf.pm \"a bit\"";
2643 delete $INC{"cf.pm"}; 3398 delete $INC{"cf.pm"};
3399 delete $INC{"cf/pod.pm"};
2644 3400
2645 # don't, removes xs symbols, too, 3401 # don't, removes xs symbols, too,
2646 # and global variables created in xs 3402 # and global variables created in xs
2647 #Symbol::delete_package __PACKAGE__; 3403 #Symbol::delete_package __PACKAGE__;
2648 3404
2651 warn "reloading cf.pm"; 3407 warn "reloading cf.pm";
2652 require cf; 3408 require cf;
2653 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3409 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2654 3410
2655 warn "loading config and database again"; 3411 warn "loading config and database again";
2656 cf::cfg_load; 3412 cf::reload_config;
2657 3413
2658 warn "loading extensions"; 3414 warn "loading extensions";
2659 cf::load_extensions; 3415 cf::load_extensions;
2660 3416
2661 warn "reattaching attachments to objects/players"; 3417 warn "reattaching attachments to objects/players";
2697register_command "reload" => sub { 3453register_command "reload" => sub {
2698 my ($who, $arg) = @_; 3454 my ($who, $arg) = @_;
2699 3455
2700 if ($who->flag (FLAG_WIZ)) { 3456 if ($who->flag (FLAG_WIZ)) {
2701 $who->message ("reloading server."); 3457 $who->message ("reloading server.");
3458 async {
3459 $Coro::current->{desc} = "perl_reload";
2702 async { reload_perl }; 3460 reload_perl;
3461 };
2703 } 3462 }
2704}; 3463};
2705 3464
2706unshift @INC, $LIBDIR; 3465unshift @INC, $LIBDIR;
2707 3466
2739 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3498 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2740 unless ++$bug_warning > 10; 3499 unless ++$bug_warning > 10;
2741 return; 3500 return;
2742 } 3501 }
2743 3502
2744 $NOW = Event::time; 3503 $NOW = $tick_start = Event::time;
2745 3504
2746 cf::server_tick; # one server iteration 3505 cf::server_tick; # one server iteration
2747 3506
2748 $RUNTIME += $TICK; 3507 $RUNTIME += $TICK;
2749 $NEXT_TICK += $TICK; 3508 $NEXT_TICK += $TICK;
2750 3509
2751 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3510 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2752 $NEXT_RUNTIME_WRITE = $NOW + 10; 3511 $NEXT_RUNTIME_WRITE = $NOW + 10;
2753 Coro::async_pool { 3512 Coro::async_pool {
3513 $Coro::current->{desc} = "runtime saver";
2754 write_runtime 3514 write_runtime
2755 or warn "ERROR: unable to write runtime file: $!"; 3515 or warn "ERROR: unable to write runtime file: $!";
2756 }; 3516 };
2757 } 3517 }
2758 3518
2759# my $AFTER = Event::time; 3519 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2760# warn $AFTER - $NOW;#d# 3520 $sig->send;
3521 }
3522 while (my $sig = shift @WAIT_FOR_TICK) {
3523 $sig->send;
3524 }
3525
3526 $NOW = Event::time;
2761 3527
2762 # if we are delayed by four ticks or more, skip them all 3528 # if we are delayed by four ticks or more, skip them all
2763 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3529 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2764 3530
2765 $TICK_WATCHER->at ($NEXT_TICK); 3531 $TICK_WATCHER->at ($NEXT_TICK);
2766 $TICK_WATCHER->start; 3532 $TICK_WATCHER->start;
2767 3533
2768 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3534 $LOAD = ($NOW - $tick_start) / $TICK;
2769 $sig->send; 3535 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2770 }
2771 while (my $sig = shift @WAIT_FOR_TICK) {
2772 $sig->send;
2773 }
2774 3536
2775 _post_tick; 3537 _post_tick;
2776 }, 3538 },
2777); 3539);
2778 3540
2779{ 3541{
3542 BDB::min_parallel 8;
2780 BDB::max_poll_time $TICK * 0.1; 3543 BDB::max_poll_time $TICK * 0.1;
2781 $BDB_POLL_WATCHER = Event->io ( 3544 $BDB_POLL_WATCHER = Event->io (
2782 reentrant => 0, 3545 reentrant => 0,
2783 fd => BDB::poll_fileno, 3546 fd => BDB::poll_fileno,
2784 poll => 'r', 3547 poll => 'r',
2785 prio => 0, 3548 prio => 0,
2786 data => WF_AUTOCANCEL, 3549 data => WF_AUTOCANCEL,
2787 cb => \&BDB::poll_cb, 3550 cb => \&BDB::poll_cb,
2788 ); 3551 );
2789 BDB::min_parallel 8;
2790 3552
2791 BDB::set_sync_prepare { 3553 BDB::set_sync_prepare {
2792 my $status; 3554 my $status;
2793 my $current = $Coro::current; 3555 my $current = $Coro::current;
2794 ( 3556 (
2803 ) 3565 )
2804 }; 3566 };
2805 3567
2806 unless ($DB_ENV) { 3568 unless ($DB_ENV) {
2807 $DB_ENV = BDB::db_env_create; 3569 $DB_ENV = BDB::db_env_create;
3570 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3571 | BDB::LOG_AUTOREMOVE, 1);
3572 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3573 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2808 3574
2809 cf::sync_job { 3575 cf::sync_job {
2810 eval { 3576 eval {
2811 BDB::db_env_open 3577 BDB::db_env_open
2812 $DB_ENV, 3578 $DB_ENV,
2813 $BDB_ENV_DIR, 3579 $BDBDIR,
2814 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3580 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2815 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3581 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2816 0666; 3582 0666;
2817 3583
2818 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3584 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2819
2820 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2821 $DB_ENV->set_lk_detect;
2822 }; 3585 };
2823 3586
2824 cf::cleanup "db_env_open(db): $@" if $@; 3587 cf::cleanup "db_env_open(db): $@" if $@;
2825 }; 3588 };
2826 } 3589 }
3590
3591 $BDB_DEADLOCK_WATCHER = Event->timer (
3592 after => 3,
3593 interval => 1,
3594 hard => 1,
3595 prio => 0,
3596 data => WF_AUTOCANCEL,
3597 cb => sub {
3598 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3599 },
3600 );
3601 $BDB_CHECKPOINT_WATCHER = Event->timer (
3602 after => 11,
3603 interval => 60,
3604 hard => 1,
3605 prio => 0,
3606 data => WF_AUTOCANCEL,
3607 cb => sub {
3608 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3609 },
3610 );
3611 $BDB_TRICKLE_WATCHER = Event->timer (
3612 after => 5,
3613 interval => 10,
3614 hard => 1,
3615 prio => 0,
3616 data => WF_AUTOCANCEL,
3617 cb => sub {
3618 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3619 },
3620 );
2827} 3621}
2828 3622
2829{ 3623{
2830 IO::AIO::min_parallel 8; 3624 IO::AIO::min_parallel 8;
2831 3625
2834 $AIO_POLL_WATCHER = Event->io ( 3628 $AIO_POLL_WATCHER = Event->io (
2835 reentrant => 0, 3629 reentrant => 0,
2836 data => WF_AUTOCANCEL, 3630 data => WF_AUTOCANCEL,
2837 fd => IO::AIO::poll_fileno, 3631 fd => IO::AIO::poll_fileno,
2838 poll => 'r', 3632 poll => 'r',
2839 prio => 6, 3633 prio => 0,
2840 cb => \&IO::AIO::poll_cb, 3634 cb => \&IO::AIO::poll_cb,
2841 ); 3635 );
2842} 3636}
2843 3637
3638my $_log_backtrace;
3639
3640sub _log_backtrace {
3641 my ($msg, @addr) = @_;
3642
3643 $msg =~ s/\n//;
3644
3645 # limit the # of concurrent backtraces
3646 if ($_log_backtrace < 2) {
3647 ++$_log_backtrace;
3648 async {
3649 $Coro::current->{desc} = "abt $msg";
3650
3651 my @bt = fork_call {
3652 @addr = map { sprintf "%x", $_ } @addr;
3653 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3654 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3655 or die "addr2line: $!";
3656
3657 my @funcs;
3658 my @res = <$fh>;
3659 chomp for @res;
3660 while (@res) {
3661 my ($func, $line) = splice @res, 0, 2, ();
3662 push @funcs, "[$func] $line";
3663 }
3664
3665 @funcs
3666 };
3667
3668 LOG llevInfo, "[ABT] $msg\n";
3669 LOG llevInfo, "[ABT] $_\n" for @bt;
3670 --$_log_backtrace;
3671 };
3672 } else {
3673 LOG llevInfo, "[ABT] $msg\n";
3674 LOG llevInfo, "[ABT] [suppressed]\n";
3675 }
3676}
3677
2844# load additional modules 3678# load additional modules
2845use cf::pod; 3679use cf::pod;
2846 3680
2847END { cf::emergency_save } 3681END { cf::emergency_save }
2848 3682

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines