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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.398 by root, Wed Dec 5 11:08:34 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines