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.235 by root, Tue Apr 10 09:35:23 2007 UTC vs.
Revision 1.366 by root, Tue Sep 11 16:05:35 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines