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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.235 by root, Tue Apr 10 09:35:23 2007 UTC vs.
Revision 1.377 by root, Thu Oct 4 11:36:38 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines