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.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.387 by root, Mon Oct 15 23:49:10 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines