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.388 by root, Thu Oct 18 02:56:13 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines