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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines