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.111 by root, Mon Jan 1 12:28:47 2007 UTC vs.
Revision 1.396 by root, Wed Nov 14 08:09:46 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines