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.115 by root, Mon Jan 1 16:50:10 2007 UTC vs.
Revision 1.372 by root, Sat Sep 15 13:25:33 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines