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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.110 by root, Mon Jan 1 11:21:55 2007 UTC vs.
Revision 1.377 by root, Thu Oct 4 11:36:38 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines