ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.224 by root, Mon Mar 12 21:42:12 2007 UTC vs.
Revision 1.367 by root, Wed Sep 12 11:10:11 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines