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

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.382 by root, Thu Oct 11 00:34:31 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines