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.114 by root, Mon Jan 1 16:00:10 2007 UTC vs.
Revision 1.379 by root, Thu Oct 4 23:59:07 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines