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.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.400 by root, Mon Dec 17 06:36:34 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines