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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines