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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines