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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines