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.167 by root, Sat Jan 13 23:32:43 2007 UTC vs.
Revision 1.386 by root, Mon Oct 15 17:50:27 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines