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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.111 by root, Mon Jan 1 12:28:47 2007 UTC vs.
Revision 1.379 by root, Thu Oct 4 23:59:07 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines