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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines