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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines