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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines