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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines