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.251 by root, Wed Apr 18 14:45:13 2007 UTC vs.
Revision 1.378 by root, Thu Oct 4 11:36:54 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines