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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines