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.220 by root, Sat Feb 17 23:54:35 2007 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines