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.353 by root, Sun Sep 2 08:43:46 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; # all users
54our %MAP; # all maps 93our %MAP; # 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 (liekly 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
845 $filename, length $$rdata, scalar @$objs; 1013 $filename, length $$rdata, scalar @$objs;
846 1014
847 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
848 chmod SAVE_MODE, $fh; 1016 chmod SAVE_MODE, $fh;
849 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
850 aio_fsync $fh; 1018 aio_fsync $fh if $cf::USE_FSYNC;
851 close $fh; 1019 close $fh;
852 1020
853 if (@$objs) { 1021 if (@$objs) {
854 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1022 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
855 chmod SAVE_MODE, $fh; 1023 chmod SAVE_MODE, $fh;
856 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
857 aio_write $fh, 0, (length $data), $data, 0; 1025 aio_write $fh, 0, (length $data), $data, 0;
858 aio_fsync $fh; 1026 aio_fsync $fh if $cf::USE_FSYNC;
859 close $fh; 1027 close $fh;
860 aio_rename "$filename.pst~", "$filename.pst"; 1028 aio_rename "$filename.pst~", "$filename.pst";
861 } 1029 }
862 } else { 1030 } else {
863 aio_unlink "$filename.pst"; 1031 aio_unlink "$filename.pst";
895 or return; 1063 or return;
896 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
897 } 1065 }
898 1066
899 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
900 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
901 return ($data, $av); 1069 return ($data, $av);
902} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
903 1077
904############################################################################# 1078#############################################################################
905# command handling &c 1079# command handling &c
906 1080
907=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
920 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
921} 1095}
922 1096
923=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
924 1098
925Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
926 1104
927If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
928called. 1106called.
929 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
930=cut 1119=cut
931 1120
932sub register_extcmd { 1121sub register_extcmd {
933 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
934 1123
935 my $caller = caller;
936 #warn "registering extcmd '$name' to '$caller'";
937
938 $EXTCMD{$name} = [$cb, $caller]; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
939} 1131}
940 1132
941cf::player->attach ( 1133cf::player->attach (
942 on_command => sub { 1134 on_command => sub {
943 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
952 cf::override; 1144 cf::override;
953 }, 1145 },
954 on_extcmd => sub { 1146 on_extcmd => sub {
955 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
956 1148
957 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
958 1150
959 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
960 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
961 if (my %reply = $cb->[0]->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
962 $pl->ext_reply ($msg->{msgid}, %reply);
963 }
964 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
965 } else { 1166 } else {
966 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
967 } 1168 }
968 1169
969 cf::override; 1170 cf::override;
970 }, 1171 },
971); 1172);
972 1173
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 { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
1050 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
1051 next unless -r $ext; 1179 next unless -r $path;
1052 eval { 1180
1053 load_extension $ext; 1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
1054 1 1238 }
1055 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
1056 } 1244 };
1057} 1245}
1058 1246
1059############################################################################# 1247#############################################################################
1060# load/save/clean perl data associated with a map
1061 1248
1062*cf::mapsupport::on_clean = sub { 1249=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 1250
1097=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
1098 1252
1099Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
1100 1254
1113Returns the given player object, loading it if necessary (might block). 1267Returns the given player object, loading it if necessary (might block).
1114 1268
1115=cut 1269=cut
1116 1270
1117sub playerdir($) { 1271sub playerdir($) {
1118 cf::localdir 1272 "$PLAYERDIR/"
1119 . "/"
1120 . cf::playerdir
1121 . "/"
1122 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1123} 1274}
1124 1275
1125sub path($) { 1276sub path($) {
1126 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1127 1278
1128 (playerdir $login) . "/$login.pl" 1279 (playerdir $login) . "/playerdata"
1129} 1280}
1130 1281
1131sub find_active($) { 1282sub find_active($) {
1132 $cf::PLAYER{$_[0]} 1283 $cf::PLAYER{$_[0]}
1133 and $cf::PLAYER{$_[0]}->active 1284 and $cf::PLAYER{$_[0]}->active
1136 1287
1137sub exists($) { 1288sub exists($) {
1138 my ($login) = @_; 1289 my ($login) = @_;
1139 1290
1140 $cf::PLAYER{$login} 1291 $cf::PLAYER{$login}
1141 or cf::sync_job { !aio_stat $login } 1292 or cf::sync_job { !aio_stat path $login }
1142} 1293}
1143 1294
1144sub find($) { 1295sub find($) {
1145 return $cf::PLAYER{$_[0]} || do { 1296 return $cf::PLAYER{$_[0]} || do {
1146 my $login = $_[0]; 1297 my $login = $_[0];
1147 1298
1148 my $guard = cf::lock_acquire "user_find:$login"; 1299 my $guard = cf::lock_acquire "user_find:$login";
1149 1300
1150 $cf::PLAYER{$_[0]} || do { 1301 $cf::PLAYER{$_[0]} || do {
1302 # rename old playerfiles to new ones
1303 #TODO: remove when no longer required
1304 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1305 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1306 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1307 aio_unlink +(playerdir $login) . "/$login.pl";
1308
1151 my $pl = load_pl path $login 1309 my $pl = load_pl path $login
1152 or return; 1310 or return;
1153 $cf::PLAYER{$login} = $pl 1311 $cf::PLAYER{$login} = $pl
1154 } 1312 }
1155 } 1313 }
1167 1325
1168 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1169 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1170 1328
1171 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1172 Coro::cede; 1330 cf::cede_to_tick;
1173} 1331}
1174 1332
1175sub new($) { 1333sub new($) {
1176 my ($login) = @_; 1334 my ($login) = @_;
1177 1335
1183 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1184 1342
1185 $self 1343 $self
1186} 1344}
1187 1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1354}
1355
1188=item $pl->quit_character 1356=item $pl->quit_character
1189 1357
1190Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1191be destroyed. May block for a long time. 1359be destroyed. May block for a long time.
1192 1360
1193=cut 1361=cut
1194 1362
1195sub quit_character { 1363sub quit_character {
1196 my ($pl) = @_; 1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1197 1367
1198 $pl->{deny_save} = 1; 1368 $pl->{deny_save} = 1;
1199 $pl->password ("*"); # this should lock out the player until we nuked the dir 1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1200 1370
1201 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1206 my $path = playerdir $pl; 1376 my $path = playerdir $pl;
1207 my $temp = "$path~$cf::RUNTIME~deleting~"; 1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1208 aio_rename $path, $temp; 1378 aio_rename $path, $temp;
1209 delete $cf::PLAYER{$pl->ob->name}; 1379 delete $cf::PLAYER{$pl->ob->name};
1210 $pl->destroy; 1380 $pl->destroy;
1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1211 IO::AIO::aio_rmtree $temp; 1387 IO::AIO::aio_rmtree $temp;
1388}
1389
1390=item $pl->kick
1391
1392Kicks a player out of the game. This destroys the connection.
1393
1394=cut
1395
1396sub kick {
1397 my ($pl, $kicker) = @_;
1398
1399 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1400 $pl->killer ("kicked");
1401 $pl->ns->destroy;
1212} 1402}
1213 1403
1214=item cf::player::list_logins 1404=item cf::player::list_logins
1215 1405
1216Returns am arrayref of all valid playernames in the system, can take a 1406Returns am arrayref of all valid playernames in the system, can take a
1217while and may block, so not sync_job-capable, ever. 1407while and may block, so not sync_job-capable, ever.
1218 1408
1219=cut 1409=cut
1220 1410
1221sub list_logins { 1411sub list_logins {
1222 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1412 my $dirs = aio_readdir $PLAYERDIR
1223 or return []; 1413 or return [];
1224 1414
1225 my @logins; 1415 my @logins;
1226 1416
1227 for my $login (@$dirs) { 1417 for my $login (@$dirs) {
1228 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1418 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1229 aio_read $fh, 0, 512, my $buf, 0 or next; 1419 aio_read $fh, 0, 512, my $buf, 0 or next;
1230 $buf !~ /^password -------------$/ or next; # official not-valid tag 1420 $buf !~ /^password -------------$/m or next; # official not-valid tag
1231 1421
1232 utf8::decode $login; 1422 utf8::decode $login;
1233 push @logins, $login; 1423 push @logins, $login;
1234 } 1424 }
1235 1425
1236 \@logins 1426 \@logins
1237} 1427}
1238 1428
1239=item $player->maps 1429=item $player->maps
1240 1430
1241Returns an arrayref of cf::path's of all maps that are private for this 1431Returns an arrayref of map paths that are private for this
1242player. May block. 1432player. May block.
1243 1433
1244=cut 1434=cut
1245 1435
1246sub maps($) { 1436sub maps($) {
1247 my ($pl) = @_; 1437 my ($pl) = @_;
1438
1439 $pl = ref $pl ? $pl->ob->name : $pl;
1248 1440
1249 my $files = aio_readdir playerdir $pl 1441 my $files = aio_readdir playerdir $pl
1250 or return; 1442 or return;
1251 1443
1252 my @paths; 1444 my @paths;
1253 1445
1254 for (@$files) { 1446 for (@$files) {
1255 utf8::decode $_; 1447 utf8::decode $_;
1256 next if /\.(?:pl|pst)$/; 1448 next if /\.(?:pl|pst)$/;
1257 next unless /^$PATH_SEP/; 1449 next unless /^$PATH_SEP/o;
1258 1450
1259 s/$PATH_SEP/\//g; 1451 push @paths, cf::map::normalise "~$pl/$_";
1260 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1261 } 1452 }
1262 1453
1263 \@paths 1454 \@paths
1264} 1455}
1265 1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGHT])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1478 # replace G<male|female> tags
1479 || s{G<([^>|]*)\|([^>]*)>}{
1480 $self->gender ? $2 : $1
1481 }ge
1482 # replace H<hint text>
1483 || s{H<([^\>]*)>}
1484 {
1485 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1486 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1487 "")
1488 [$self->{hintmode}]
1489 }ge;
1490
1491 # create single paragraphs (very hackish)
1492 s/(?<=\S)\n(?=\w)/ /g;
1493
1494 # compress some whitespace
1495 s/\s+\n/\n/g; # ws line-ends
1496 s/\n\n+/\n/g; # double lines
1497 s/^\n+//; # beginning lines
1498 s/\n+$//; # ending lines
1499
1500 $_
1501}
1502
1503sub hintmode {
1504 $_[0]{hintmode} = $_[1] if @_ > 1;
1505 $_[0]{hintmode}
1506}
1507
1266=item $player->ext_reply ($msgid, $msgtype, %msg) 1508=item $player->ext_reply ($msgid, @msg)
1267 1509
1268Sends an ext reply to the player. 1510Sends an ext reply to the player.
1269 1511
1270=cut 1512=cut
1271 1513
1272sub ext_reply($$$%) { 1514sub ext_reply($$@) {
1273 my ($self, $id, %msg) = @_; 1515 my ($self, $id, @msg) = @_;
1274 1516
1275 $msg{msgid} = $id; 1517 $self->ns->ext_reply ($id, @msg)
1276
1277 $self->send ("ext " . cf::to_json \%msg);
1278} 1518}
1279 1519
1280package cf; 1520=item $player->ext_msg ($type, @msg)
1521
1522Sends an ext event to the client.
1523
1524=cut
1525
1526sub ext_msg($$@) {
1527 my ($self, $type, @msg) = @_;
1528
1529 $self->ns->ext_msg ($type, @msg);
1530}
1531
1532=head3 cf::region
1533
1534=over 4
1535
1536=cut
1537
1538package cf::region;
1539
1540=item cf::region::find_by_path $path
1541
1542Tries to decuce the likely region for a map knowing only its path.
1543
1544=cut
1545
1546sub find_by_path($) {
1547 my ($path) = @_;
1548
1549 my ($match, $specificity);
1550
1551 for my $region (list) {
1552 if ($region->{match} && $path =~ $region->{match}) {
1553 ($match, $specificity) = ($region, $region->specificity)
1554 if $region->specificity > $specificity;
1555 }
1556 }
1557
1558 $match
1559}
1281 1560
1282=back 1561=back
1283
1284 1562
1285=head3 cf::map 1563=head3 cf::map
1286 1564
1287=over 4 1565=over 4
1288 1566
1291package cf::map; 1569package cf::map;
1292 1570
1293use Fcntl; 1571use Fcntl;
1294use Coro::AIO; 1572use Coro::AIO;
1295 1573
1574use overload
1575 '""' => \&as_string,
1576 fallback => 1;
1577
1296our $MAX_RESET = 3600; 1578our $MAX_RESET = 3600;
1297our $DEFAULT_RESET = 3000; 1579our $DEFAULT_RESET = 3000;
1298 1580
1299sub generate_random_map { 1581sub generate_random_map {
1300 my ($path, $rmp) = @_; 1582 my ($self, $rmp) = @_;
1301
1302 # mit "rum" bekleckern, nicht 1583 # mit "rum" bekleckern, nicht
1303 cf::map::_create_random_map 1584 $self->_create_random_map (
1304 $path,
1305 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1585 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1306 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1586 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1307 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1587 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1308 $rmp->{exit_on_final_map}, 1588 $rmp->{exit_on_final_map},
1309 $rmp->{xsize}, $rmp->{ysize}, 1589 $rmp->{xsize}, $rmp->{ysize},
1310 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1590 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1311 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1591 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1312 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1592 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1313 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1593 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1314 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1594 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1315 (cf::region::find $rmp->{region}) 1595 (cf::region::find $rmp->{region}), $rmp->{custom}
1596 )
1597}
1598
1599=item cf::map->register ($regex, $prio)
1600
1601Register a handler for the map path matching the given regex at the
1602givne priority (higher is better, built-in handlers have priority 0, the
1603default).
1604
1605=cut
1606
1607sub register {
1608 my (undef, $regex, $prio) = @_;
1609 my $pkg = caller;
1610
1611 no strict;
1612 push @{"$pkg\::ISA"}, __PACKAGE__;
1613
1614 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1615}
1616
1617# also paths starting with '/'
1618$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1619
1620sub thawer_merge {
1621 my ($self, $merge) = @_;
1622
1623 # we have to keep some variables in memory intact
1624 local $self->{path};
1625 local $self->{load_path};
1626
1627 $self->SUPER::thawer_merge ($merge);
1628}
1629
1630sub normalise {
1631 my ($path, $base) = @_;
1632
1633 $path = "$path"; # make sure its a string
1634
1635 $path =~ s/\.map$//;
1636
1637 # map plan:
1638 #
1639 # /! non-realised random map exit (special hack!)
1640 # {... are special paths that are not being touched
1641 # ?xxx/... are special absolute paths
1642 # ?random/... random maps
1643 # /... normal maps
1644 # ~user/... per-player map of a specific user
1645
1646 $path =~ s/$PATH_SEP/\//go;
1647
1648 # treat it as relative path if it starts with
1649 # something that looks reasonable
1650 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1651 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1652
1653 $base =~ s{[^/]+/?$}{};
1654 $path = "$base/$path";
1655 }
1656
1657 for ($path) {
1658 redo if s{//}{/};
1659 redo if s{/\.?/}{/};
1660 redo if s{/[^/]+/\.\./}{/};
1661 }
1662
1663 $path
1664}
1665
1666sub new_from_path {
1667 my (undef, $path, $base) = @_;
1668
1669 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1670
1671 $path = normalise $path, $base;
1672
1673 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1674 if ($path =~ $EXT_MAP{$pkg}[1]) {
1675 my $self = bless cf::map::new, $pkg;
1676 $self->{path} = $path; $self->path ($path);
1677 $self->init; # pass $1 etc.
1678 return $self;
1679 }
1680 }
1681
1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1683 ()
1684}
1685
1686sub init {
1687 my ($self) = @_;
1688
1689 $self
1690}
1691
1692sub as_string {
1693 my ($self) = @_;
1694
1695 "$self->{path}"
1696}
1697
1698# the displayed name, this is a one way mapping
1699sub visible_name {
1700 &as_string
1701}
1702
1703# the original (read-only) location
1704sub load_path {
1705 my ($self) = @_;
1706
1707 "$MAPDIR/$self->{path}.map"
1708}
1709
1710# the temporary/swap location
1711sub save_path {
1712 my ($self) = @_;
1713
1714 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1715 "$TMPDIR/$path.map"
1716}
1717
1718# the unique path, undef == no special unique path
1719sub uniq_path {
1720 my ($self) = @_;
1721
1722 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1723 "$UNIQUEDIR/$path"
1316} 1724}
1317 1725
1318# and all this just because we cannot iterate over 1726# and all this just because we cannot iterate over
1319# all maps in C++... 1727# all maps in C++...
1320sub change_all_map_light { 1728sub change_all_map_light {
1322 1730
1323 $_->change_map_light ($change) 1731 $_->change_map_light ($change)
1324 for grep $_->outdoor, values %cf::MAP; 1732 for grep $_->outdoor, values %cf::MAP;
1325} 1733}
1326 1734
1735sub decay_objects {
1736 my ($self) = @_;
1737
1738 return if $self->{deny_reset};
1739
1740 $self->do_decay_objects;
1741}
1742
1743sub unlink_save {
1744 my ($self) = @_;
1745
1746 utf8::encode (my $save = $self->save_path);
1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1748 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1749}
1750
1327sub try_load_header($) { 1751sub load_header_from($) {
1328 my ($path) = @_; 1752 my ($self, $path) = @_;
1329 1753
1330 utf8::encode $path; 1754 utf8::encode $path;
1331 aio_open $path, O_RDONLY, 0 1755 #aio_open $path, O_RDONLY, 0
1756 # or return;
1757
1758 $self->_load_header ($path)
1332 or return; 1759 or return;
1333 1760
1334 my $map = cf::map::new 1761 $self->{load_path} = $path;
1762
1763 1
1764}
1765
1766sub load_header_orig {
1767 my ($self) = @_;
1768
1769 $self->load_header_from ($self->load_path)
1770}
1771
1772sub load_header_temp {
1773 my ($self) = @_;
1774
1775 $self->load_header_from ($self->save_path)
1776}
1777
1778sub prepare_temp {
1779 my ($self) = @_;
1780
1781 $self->last_access ((delete $self->{last_access})
1782 || $cf::RUNTIME); #d#
1783 # safety
1784 $self->{instantiate_time} = $cf::RUNTIME
1785 if $self->{instantiate_time} > $cf::RUNTIME;
1786}
1787
1788sub prepare_orig {
1789 my ($self) = @_;
1790
1791 $self->{load_original} = 1;
1792 $self->{instantiate_time} = $cf::RUNTIME;
1793 $self->last_access ($cf::RUNTIME);
1794 $self->instantiate;
1795}
1796
1797sub load_header {
1798 my ($self) = @_;
1799
1800 if ($self->load_header_temp) {
1801 $self->prepare_temp;
1802 } else {
1803 $self->load_header_orig
1335 or return; 1804 or return;
1805 $self->prepare_orig;
1806 }
1336 1807
1337 # for better error messages only, will be overwritten 1808 $self->{deny_reset} = 1
1338 $map->path ($path); 1809 if $self->no_reset;
1339 1810
1340 $map->load_header ($path) 1811 $self->default_region (cf::region::find_by_path $self->{path})
1341 or return; 1812 unless $self->default_region;
1342 1813
1343 $map->{load_path} = $path; 1814 1
1344
1345 $map
1346} 1815}
1347 1816
1348sub find; 1817sub find;
1349sub find { 1818sub find {
1350 my ($path, $origin) = @_; 1819 my ($path, $origin) = @_;
1351 1820
1352 #warn "find<$path,$origin>\n";#d#
1353
1354 $path = new cf::path $path, $origin && $origin->path; 1821 $path = normalise $path, $origin && $origin->path;
1355 my $key = $path->as_string;
1356 1822
1357 cf::lock_wait "map_find:$key"; 1823 cf::lock_wait "map_find:$path";
1358 1824
1359 $cf::MAP{$key} || do { 1825 $cf::MAP{$path} || do {
1360 my $guard = cf::lock_acquire "map_find:$key"; 1826 my $guard = cf::lock_acquire "map_find:$path";
1361 1827 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; 1828 or return;
1381 1829
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; 1830 $map->{last_save} = $cf::RUNTIME;
1394 1831
1395 Coro::cede; 1832 $map->load_header
1833 or return;
1396 1834
1397 if ($map->should_reset) { 1835 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1836 # doing this can freeze the server in a sync job, obviously
1837 #$cf::WAIT_FOR_TICK->wait;
1398 $map->reset; 1838 $map->reset;
1399 undef $guard; 1839 undef $guard;
1400 $map = find $path 1840 return find $path;
1401 or return;
1402 } 1841 }
1403 1842
1404 $cf::MAP{$key} = $map 1843 $cf::MAP{$path} = $map
1405 } 1844 }
1406} 1845}
1846
1847sub pre_load { }
1848sub post_load { }
1407 1849
1408sub load { 1850sub load {
1409 my ($self) = @_; 1851 my ($self) = @_;
1410 1852
1853 local $self->{deny_reset} = 1; # loading can take a long time
1854
1411 my $path = $self->{path}; 1855 my $path = $self->{path};
1856
1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1412 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1859 my $guard2 = cf::lock_acquire "map_load:$path";
1413 1860
1414 return if $self->in_memory != cf::MAP_SWAPPED; 1861 return if $self->in_memory != cf::MAP_SWAPPED;
1415 1862
1416 $self->in_memory (cf::MAP_LOADING); 1863 $self->in_memory (cf::MAP_LOADING);
1417 1864
1418 $self->alloc; 1865 $self->alloc;
1866
1867 $self->pre_load;
1868 cf::cede_to_tick;
1869
1419 $self->load_objects ($self->{load_path}, 1) 1870 $self->_load_objects ($self->{load_path}, 1)
1420 or return; 1871 or return;
1421 1872
1422 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1423 if delete $self->{load_original}; 1874 if delete $self->{load_original};
1424 1875
1425 if (my $uniq = $path->uniq_path) { 1876 if (my $uniq = $self->uniq_path) {
1426 utf8::encode $uniq; 1877 utf8::encode $uniq;
1427 if (aio_open $uniq, O_RDONLY, 0) { 1878 if (aio_open $uniq, O_RDONLY, 0) {
1428 $self->clear_unique_items; 1879 $self->clear_unique_items;
1429 $self->load_objects ($uniq, 0); 1880 $self->_load_objects ($uniq, 0);
1430 } 1881 }
1431 } 1882 }
1432 1883
1433 Coro::cede; 1884 cf::cede_to_tick;
1434
1435 # now do the right thing for maps 1885 # now do the right thing for maps
1436 $self->link_multipart_objects; 1886 $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) 1887 $self->difficulty ($self->estimate_difficulty)
1447 unless $self->difficulty; 1888 unless $self->difficulty;
1889 cf::cede_to_tick;
1890
1891 unless ($self->{deny_activate}) {
1892 $self->decay_objects;
1893 $self->fix_auto_apply;
1894 $self->update_buttons;
1895 cf::cede_to_tick;
1896 $self->set_darkness_map;
1897 cf::cede_to_tick;
1448 $self->activate; 1898 $self->activate;
1449 } 1899 }
1450 1900
1451 Coro::cede; 1901 $self->{last_save} = $cf::RUNTIME;
1902 $self->last_access ($cf::RUNTIME);
1452 1903
1453 $self->in_memory (cf::MAP_IN_MEMORY); 1904 $self->in_memory (cf::MAP_IN_MEMORY);
1905 }
1906
1907 $self->post_load;
1908}
1909
1910sub customise_for {
1911 my ($self, $ob) = @_;
1912
1913 return find "~" . $ob->name . "/" . $self->{path}
1914 if $self->per_player;
1915
1916# return find "?party/" . $ob->name . "/" . $self->{path}
1917# if $self->per_party;
1918
1919 $self
1920}
1921
1922# find and load all maps in the 3x3 area around a map
1923sub load_neighbours {
1924 my ($map) = @_;
1925
1926 my @neigh; # diagonal neighbours
1927
1928 for (0 .. 3) {
1929 my $neigh = $map->tile_path ($_)
1930 or next;
1931 $neigh = find $neigh, $map
1932 or next;
1933 $neigh->load;
1934
1935 push @neigh,
1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1938 }
1939
1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1942 my $neigh = find $path, $origin
1943 or next;
1944 $neigh->load;
1945 }
1454} 1946}
1455 1947
1456sub find_sync { 1948sub find_sync {
1457 my ($path, $origin) = @_; 1949 my ($path, $origin) = @_;
1458 1950
1459 cf::sync_job { cf::map::find $path, $origin } 1951 cf::sync_job { find $path, $origin }
1460} 1952}
1461 1953
1462sub do_load_sync { 1954sub do_load_sync {
1463 my ($map) = @_; 1955 my ($map) = @_;
1464 1956
1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1958 if $Coro::current == $Coro::main;
1959
1465 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1961}
1962
1963our %MAP_PREFETCH;
1964our $MAP_PREFETCHER = undef;
1965
1966sub find_async {
1967 my ($path, $origin, $load) = @_;
1968
1969 $path = normalise $path, $origin && $origin->{path};
1970
1971 if (my $map = $cf::MAP{$path}) {
1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1973 }
1974
1975 $MAP_PREFETCH{$path} |= $load;
1976
1977 $MAP_PREFETCHER ||= cf::async {
1978 while (%MAP_PREFETCH) {
1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1980 if (my $map = find $k) {
1981 $map->load if $v;
1982 }
1983
1984 delete $MAP_PREFETCH{$k};
1985 }
1986 }
1987 undef $MAP_PREFETCHER;
1988 };
1989 $MAP_PREFETCHER->prio (6);
1990
1991 ()
1466} 1992}
1467 1993
1468sub save { 1994sub save {
1469 my ($self) = @_; 1995 my ($self) = @_;
1470 1996
1471 my $lock = cf::lock_acquire "map_data:" . $self->path; 1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1472 1998
1473 $self->{last_save} = $cf::RUNTIME; 1999 $self->{last_save} = $cf::RUNTIME;
1474 2000
1475 return unless $self->dirty; 2001 return unless $self->dirty;
1476 2002
1477 my $save = $self->{path}->save_path; utf8::encode $save; 2003 my $save = $self->save_path; utf8::encode $save;
1478 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2004 my $uniq = $self->uniq_path; utf8::encode $uniq;
1479 2005
1480 $self->{load_path} = $save; 2006 $self->{load_path} = $save;
1481 2007
1482 return if $self->{deny_save}; 2008 return if $self->{deny_save};
1483 2009
1486 cf::async { 2012 cf::async {
1487 $_->contr->save for $self->players; 2013 $_->contr->save for $self->players;
1488 }; 2014 };
1489 2015
1490 if ($uniq) { 2016 if ($uniq) {
1491 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2017 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1492 $self->save_objects ($uniq, cf::IO_UNIQUES); 2018 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1493 } else { 2019 } else {
1494 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2020 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1495 } 2021 }
1496} 2022}
1497 2023
1498sub swap_out { 2024sub swap_out {
1499 my ($self) = @_; 2025 my ($self) = @_;
1500 2026
1501 # save first because save cedes 2027 # save first because save cedes
1502 $self->save; 2028 $self->save;
1503 2029
1504 my $lock = cf::lock_acquire "map_data:" . $self->path; 2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
1505 2031
1506 return if $self->players; 2032 return if $self->players;
1507 return if $self->in_memory != cf::MAP_IN_MEMORY; 2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
1508 return if $self->{deny_save}; 2034 return if $self->{deny_save};
1509 2035
1513 2039
1514sub reset_at { 2040sub reset_at {
1515 my ($self) = @_; 2041 my ($self) = @_;
1516 2042
1517 # TODO: safety, remove and allow resettable per-player maps 2043 # TODO: safety, remove and allow resettable per-player maps
1518 return 1e99 if $self->{path}{user_rel};
1519 return 1e99 if $self->{deny_reset}; 2044 return 1e99 if $self->{deny_reset};
1520 2045
1521 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2046 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1522 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2047 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1523 2048
1528 my ($self) = @_; 2053 my ($self) = @_;
1529 2054
1530 $self->reset_at <= $cf::RUNTIME 2055 $self->reset_at <= $cf::RUNTIME
1531} 2056}
1532 2057
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 { 2058sub reset {
1555 my ($self) = @_; 2059 my ($self) = @_;
1556 2060
1557 my $lock = cf::lock_acquire "map_data:" . $self->path; 2061 my $lock = cf::lock_acquire "map_data:$self->{path}";
1558 2062
1559 return if $self->players; 2063 return if $self->players;
1560 return if $self->{path}{user_rel};#d#
1561 2064
1562 warn "resetting map ", $self->path;#d# 2065 warn "resetting map ", $self->path;
2066
2067 $self->in_memory (cf::MAP_SWAPPED);
2068
2069 # need to save uniques path
2070 unless ($self->{deny_save}) {
2071 my $uniq = $self->uniq_path; utf8::encode $uniq;
2072
2073 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2074 if $uniq;
2075 }
1563 2076
1564 delete $cf::MAP{$self->path}; 2077 delete $cf::MAP{$self->path};
2078
2079 $self->clear;
1565 2080
1566 $_->clear_links_to ($self) for values %cf::MAP; 2081 $_->clear_links_to ($self) for values %cf::MAP;
1567 2082
1568 $self->unlink_save; 2083 $self->unlink_save;
1569 $self->destroy; 2084 $self->destroy;
1572my $nuke_counter = "aaaa"; 2087my $nuke_counter = "aaaa";
1573 2088
1574sub nuke { 2089sub nuke {
1575 my ($self) = @_; 2090 my ($self) = @_;
1576 2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
2095 delete $cf::MAP{$self->path};
2096
2097 $self->unlink_save;
2098
2099 bless $self, "cf::map";
2100 delete $self->{deny_reset};
1577 $self->{deny_save} = 1; 2101 $self->{deny_save} = 1;
1578 $self->reset_timeout (1); 2102 $self->reset_timeout (1);
1579 $self->rename ("{nuke}/" . ($nuke_counter++)); 2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2104
2105 $cf::MAP{$self->path} = $self;
2106 }
2107
1580 $self->reset; # polite request, might not happen 2108 $self->reset; # polite request, might not happen
1581} 2109}
1582 2110
1583sub customise_for { 2111=item $maps = cf::map::tmp_maps
1584 my ($map, $ob) = @_;
1585 2112
1586 if ($map->per_player) { 2113Returns an arrayref with all map paths of currently instantiated and saved
1587 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2114maps. May block.
2115
2116=cut
2117
2118sub tmp_maps() {
1588 } 2119 [
1589 2120 map {
1590 $map 2121 utf8::decode $_;
2122 /\.map$/
2123 ? normalise $_
2124 : ()
2125 } @{ aio_readdir $TMPDIR or [] }
2126 ]
1591} 2127}
1592 2128
1593sub emergency_save { 2129=item $maps = cf::map::random_maps
1594 my $freeze_guard = cf::freeze_mainloop;
1595 2130
1596 warn "enter emergency perl save\n"; 2131Returns an arrayref with all map paths of currently instantiated and saved
2132random maps. May block.
1597 2133
1598 cf::sync_job { 2134=cut
1599 warn "begin emergency player save\n";
1600 $_->save for values %cf::PLAYER;
1601 warn "end emergency player save\n";
1602 2135
1603 warn "begin emergency map save\n"; 2136sub random_maps() {
1604 $_->save for values %cf::MAP; 2137 [
1605 warn "end emergency map save\n"; 2138 map {
1606 }; 2139 utf8::decode $_;
2140 /\.map$/
2141 ? normalise "?random/$_"
2142 : ()
2143 } @{ aio_readdir $RANDOMDIR or [] }
2144 ]
2145}
1607 2146
1608 warn "leave emergency perl save\n"; 2147=item cf::map::unique_maps
2148
2149Returns an arrayref of paths of all shared maps that have
2150instantiated unique items. May block.
2151
2152=cut
2153
2154sub unique_maps() {
2155 [
2156 map {
2157 utf8::decode $_;
2158 /\.map$/
2159 ? normalise $_
2160 : ()
2161 } @{ aio_readdir $UNIQUEDIR or [] }
2162 ]
1609} 2163}
1610 2164
1611package cf; 2165package cf;
1612 2166
1613=back 2167=back
1614 2168
2169=head3 cf::object
2170
2171=cut
2172
2173package cf::object;
2174
2175=over 4
2176
2177=item $ob->inv_recursive
2178
2179Returns the inventory of the object _and_ their inventories, recursively.
2180
2181=cut
2182
2183sub inv_recursive_;
2184sub inv_recursive_ {
2185 map { $_, inv_recursive_ $_->inv } @_
2186}
2187
2188sub inv_recursive {
2189 inv_recursive_ inv $_[0]
2190}
2191
2192package cf;
2193
2194=back
1615 2195
1616=head3 cf::object::player 2196=head3 cf::object::player
1617 2197
1618=over 4 2198=over 4
1619 2199
1633 2213
1634 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1635 2215
1636 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
1637 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
1638 } else { 2219 } else {
2220 my $pl = $self->contr;
2221
2222 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2223 my $dialog = $pl->{npc_dialog};
2224 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2225
2226 } else {
1639 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1640 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1641 } 2230 }
2231}
2232
2233=item $object->send_msg ($channel, $msg, $color, [extra...])
2234
2235=cut
2236
2237sub cf::object::send_msg {
2238 my $pl = shift->contr
2239 or return;
2240 $pl->send_msg (@_);
1642} 2241}
1643 2242
1644=item $player_object->may ("access") 2243=item $player_object->may ("access")
1645 2244
1646Returns wether the given player is authorized to access resource "access" 2245Returns wether the given player is authorized to access resource "access"
1659 2258
1660=item $player_object->enter_link 2259=item $player_object->enter_link
1661 2260
1662Freezes the player and moves him/her to a special map (C<{link}>). 2261Freezes the player and moves him/her to a special map (C<{link}>).
1663 2262
1664The player should be reaosnably safe there for short amounts of time. You 2263The player should be reasonably safe there for short amounts of time. You
1665I<MUST> call C<leave_link> as soon as possible, though. 2264I<MUST> call C<leave_link> as soon as possible, though.
1666 2265
2266Will never block.
2267
1667=item $player_object->leave_link ($map, $x, $y) 2268=item $player_object->leave_link ($map, $x, $y)
1668 2269
1669Moves the player out of the specila link map onto the given map. If the 2270Moves 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 2271map. 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, 2272to the location he/she was before the call to C<enter_link>, or, if that
1672to the emergency map position. 2273fails, to the emergency map position.
1673 2274
1674Might block. 2275Might block.
1675 2276
1676=cut 2277=cut
2278
2279sub link_map {
2280 unless ($LINK_MAP) {
2281 $LINK_MAP = cf::map::find "{link}"
2282 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2283 $LINK_MAP->load;
2284 }
2285
2286 $LINK_MAP
2287}
1677 2288
1678sub cf::object::player::enter_link { 2289sub cf::object::player::enter_link {
1679 my ($self) = @_; 2290 my ($self) = @_;
1680 2291
1681 $self->deactivate_recursive; 2292 $self->deactivate_recursive;
1682 2293
1683 return if $self->map == $LINK_MAP; 2294 return if UNIVERSAL::isa $self->map, "ext::map_link";
1684 2295
1685 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2296 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1686 if $self->map; 2297 if $self->map && $self->map->{path} ne "{link}";
1687 2298
1688 $self->enter_map ($LINK_MAP, 20, 20); 2299 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1689} 2300}
1690 2301
1691sub cf::object::player::leave_link { 2302sub cf::object::player::leave_link {
1692 my ($self, $map, $x, $y) = @_; 2303 my ($self, $map, $x, $y) = @_;
2304
2305 return unless $self->contr->active;
1693 2306
1694 my $link_pos = delete $self->{_link_pos}; 2307 my $link_pos = delete $self->{_link_pos};
1695 2308
1696 unless ($map) { 2309 unless ($map) {
1697 # restore original map position 2310 # restore original map position
1711 # use -1 or undef as default coordinates, not 0, 0 2324 # use -1 or undef as default coordinates, not 0, 0
1712 ($x, $y) = ($map->enter_x, $map->enter_y) 2325 ($x, $y) = ($map->enter_x, $map->enter_y)
1713 if $x <=0 && $y <= 0; 2326 if $x <=0 && $y <= 0;
1714 2327
1715 $map->load; 2328 $map->load;
2329 $map->load_neighbours;
1716 2330
1717 return unless $self->contr->active; 2331 return unless $self->contr->active;
1718 $self->activate_recursive; 2332 $self->activate_recursive;
2333
2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1719 $self->enter_map ($map, $x, $y); 2335 $self->enter_map ($map, $x, $y);
1720} 2336}
1721 2337
1722cf::player->attach ( 2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1723 on_logout => sub {
1724 my ($pl) = @_;
1725 2339
1726 # abort map switching before logout 2340Moves the player to the given map-path and coordinates by first freezing
1727 if ($pl->ob->{_link_pos}) { 2341her, loading and preparing them map, calling the provided $check callback
1728 cf::sync_job { 2342that has to return the map if sucecssful, and then unfreezes the player on
1729 $pl->ob->leave_link 2343the new (success) or old (failed) map position. In either case, $done will
1730 }; 2344be called at the end of this process.
1731 }
1732 },
1733 on_login => sub {
1734 my ($pl) = @_;
1735 2345
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 2346=cut
2347
2348our $GOTOGEN;
1757 2349
1758sub cf::object::player::goto { 2350sub cf::object::player::goto {
1759 my ($self, $path, $x, $y) = @_; 2351 my ($self, $path, $x, $y, $check, $done) = @_;
1760 2352
1761 $path = new cf::path $path; 2353 # do generation counting so two concurrent goto's will be executed in-order
1762 $path ne "/" or Carp::cluck ("oy");#d# 2354 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1763 2355
1764 $self->enter_link; 2356 $self->enter_link;
1765 2357
1766 (async { 2358 (async {
2359 my $map = eval {
1767 my $map = cf::map::find $path->as_string; 2360 my $map = cf::map::find $path;
2361
2362 if ($map) {
1768 $map = $map->customise_for ($self) if $map; 2363 $map = $map->customise_for ($self);
1769 2364 $map = $check->($map) if $check && $map;
1770# warn "entering ", $map->path, " at ($x, $y)\n" 2365 } else {
1771# if $map;
1772
1773 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2366 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2367 }
1774 2368
2369 $map
2370 };
2371
2372 if ($@) {
2373 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2374 LOG llevError | logBacktrace, Carp::longmess $@;
2375 }
2376
2377 if ($gen == $self->{_goto_generation}) {
2378 delete $self->{_goto_generation};
1775 $self->leave_link ($map, $x, $y); 2379 $self->leave_link ($map, $x, $y);
2380 }
2381
2382 $done->() if $done;
1776 })->prio (1); 2383 })->prio (1);
1777} 2384}
1778 2385
1779=item $player_object->enter_exit ($exit_object) 2386=item $player_object->enter_exit ($exit_object)
1780 2387
1782 2389
1783sub parse_random_map_params { 2390sub parse_random_map_params {
1784 my ($spec) = @_; 2391 my ($spec) = @_;
1785 2392
1786 my $rmp = { # defaults 2393 my $rmp = { # defaults
1787 xsize => 10, 2394 xsize => (cf::rndm 15, 40),
1788 ysize => 10, 2395 ysize => (cf::rndm 15, 40),
2396 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2397 #layout => string,
1789 }; 2398 };
1790 2399
1791 for (split /\n/, $spec) { 2400 for (split /\n/, $spec) {
1792 my ($k, $v) = split /\s+/, $_, 2; 2401 my ($k, $v) = split /\s+/, $_, 2;
1793 2402
1797 $rmp 2406 $rmp
1798} 2407}
1799 2408
1800sub prepare_random_map { 2409sub prepare_random_map {
1801 my ($exit) = @_; 2410 my ($exit) = @_;
2411
2412 my $guard = cf::lock_acquire "exit_prepare:$exit";
1802 2413
1803 # all this does is basically replace the /! path by 2414 # all this does is basically replace the /! path by
1804 # a new random map path (?random/...) with a seed 2415 # a new random map path (?random/...) with a seed
1805 # that depends on the exit object 2416 # that depends on the exit object
1806 2417
1807 my $rmp = parse_random_map_params $exit->msg; 2418 my $rmp = parse_random_map_params $exit->msg;
1808 2419
1809 if ($exit->map) { 2420 if ($exit->map) {
1810 $rmp->{region} = $exit->map->region_name; 2421 $rmp->{region} = $exit->region->name;
1811 $rmp->{origin_map} = $exit->map->path; 2422 $rmp->{origin_map} = $exit->map->path;
1812 $rmp->{origin_x} = $exit->x; 2423 $rmp->{origin_x} = $exit->x;
1813 $rmp->{origin_y} = $exit->y; 2424 $rmp->{origin_y} = $exit->y;
1814 } 2425 }
1815 2426
1816 $rmp->{random_seed} ||= $exit->random_seed; 2427 $rmp->{random_seed} ||= $exit->random_seed;
1817 2428
1818 my $data = cf::to_json $rmp; 2429 my $data = cf::to_json $rmp;
1819 my $md5 = Digest::MD5::md5_hex $data; 2430 my $md5 = Digest::MD5::md5_hex $data;
2431 my $meta = "$RANDOMDIR/$md5.meta";
1820 2432
1821 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2433 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1822 aio_write $fh, 0, (length $data), $data, 0; 2434 aio_write $fh, 0, (length $data), $data, 0;
2435 undef $fh;
2436 aio_rename "$meta~", $meta;
1823 2437
1824 $exit->slaying ("?random/$md5"); 2438 $exit->slaying ("?random/$md5");
1825 $exit->msg (undef); 2439 $exit->msg (undef);
1826 } 2440 }
1827} 2441}
1829sub cf::object::player::enter_exit { 2443sub cf::object::player::enter_exit {
1830 my ($self, $exit) = @_; 2444 my ($self, $exit) = @_;
1831 2445
1832 return unless $self->type == cf::PLAYER; 2446 return unless $self->type == cf::PLAYER;
1833 2447
2448 if ($exit->slaying eq "/!") {
2449 #TODO: this should de-fi-ni-te-ly not be a sync-job
2450 # the problem is that $exit might not survive long enough
2451 # so it needs to be done right now, right here
2452 cf::sync_job { prepare_random_map $exit };
2453 }
2454
2455 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2456 my $hp = $exit->stats->hp;
2457 my $sp = $exit->stats->sp;
2458
1834 $self->enter_link; 2459 $self->enter_link;
2460
2461 # if exit is damned, update players death & WoR home-position
2462 $self->contr->savebed ($slaying, $hp, $sp)
2463 if $exit->flag (FLAG_DAMNED);
1835 2464
1836 (async { 2465 (async {
1837 $self->deactivate_recursive; # just to be sure 2466 $self->deactivate_recursive; # just to be sure
1838 unless (eval { 2467 unless (eval {
1839 prepare_random_map $exit 2468 $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 2469
1845 1; 2470 1;
1846 }) { 2471 }) {
1847 $self->message ("Something went wrong deep within the crossfire server. " 2472 $self->message ("Something went wrong deep within the crossfire server. "
1848 . "I'll try to bring you back to the map you were before. " 2473 . "I'll try to bring you back to the map you were before. "
1849 . "Please report this to the dungeon master", 2474 . "Please report this to the dungeon master!",
1850 cf::NDI_UNIQUE | cf::NDI_RED); 2475 cf::NDI_UNIQUE | cf::NDI_RED);
1851 2476
1852 warn "ERROR in enter_exit: $@"; 2477 warn "ERROR in enter_exit: $@";
1853 $self->leave_link; 2478 $self->leave_link;
1854 } 2479 }
1855 })->prio (1); 2480 })->prio (1);
1868 2493
1869sub cf::client::send_drawinfo { 2494sub cf::client::send_drawinfo {
1870 my ($self, $text, $flags) = @_; 2495 my ($self, $text, $flags) = @_;
1871 2496
1872 utf8::encode $text; 2497 utf8::encode $text;
1873 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1874} 2499}
1875 2500
2501=item $client->send_msg ($channel, $msg, $color, [extra...])
2502
2503Send a drawinfo or msg packet to the client, formatting the msg for the
2504client if neccessary. C<$type> should be a string identifying the type of
2505the message, with C<log> being the default. If C<$color> is negative, suppress
2506the message unless the client supports the msg packet.
2507
2508=cut
2509
2510our %CHANNEL = (
2511 "c/identify" => {
2512 id => "identify",
2513 title => "Identify",
2514 reply => undef,
2515 tooltip => "Items recently identified",
2516 },
2517 "c/examine" => {
2518 id => "examine",
2519 title => "Examine",
2520 reply => undef,
2521 tooltip => "Signs and other items you examined",
2522 },
2523);
2524
2525sub cf::client::send_msg {
2526 my ($self, $channel, $msg, $color, @extra) = @_;
2527
2528 $msg = $self->pl->expand_cfpod ($msg);
2529
2530 $color &= cf::NDI_CLIENT_MASK; # just in case...
2531
2532 # check predefined channels, for the benefit of C
2533 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2534
2535 if (ref $channel) {
2536 # send meta info to client, if not yet sent
2537 unless (exists $self->{channel}{$channel->{id}}) {
2538 $self->{channel}{$channel->{id}} = $channel;
2539 $self->ext_msg (channel_info => $channel)
2540 if $self->can_msg;
2541 }
2542
2543 $channel = $channel->{id};
2544 }
2545
2546 return unless @extra || length $msg;
2547
2548 if ($self->can_msg) {
2549 # default colour, mask it out
2550 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2551 if $color & cf::NDI_DEF;
2552
2553 $self->send_packet ("msg " . $self->{json_coder}->encode (
2554 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2555 } else {
2556 if ($color >= 0) {
2557 # replace some tags by gcfclient-compatible ones
2558 for ($msg) {
2559 1 while
2560 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2561 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2562 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2563 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2564 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2565 }
2566
2567 $color &= cf::NDI_COLOR_MASK;
2568
2569 utf8::encode $msg;
2570
2571 if (0 && $msg =~ /\[/) {
2572 # COMMAND/INFO
2573 $self->send_packet ("drawextinfo $color 10 8 $msg")
2574 } else {
2575 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2576 $self->send_packet ("drawinfo $color $msg")
2577 }
2578 }
2579 }
2580}
2581
2582=item $client->ext_msg ($type, @msg)
2583
2584Sends an ext event to the client.
2585
2586=cut
2587
2588sub cf::client::ext_msg($$@) {
2589 my ($self, $type, @msg) = @_;
2590
2591 if ($self->extcmd == 2) {
2592 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2593 } elsif ($self->extcmd == 1) { # TODO: remove
2594 push @msg, msgtype => "event_$type";
2595 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2596 }
2597}
2598
2599=item $client->ext_reply ($msgid, @msg)
2600
2601Sends an ext reply to the client.
2602
2603=cut
2604
2605sub cf::client::ext_reply($$@) {
2606 my ($self, $id, @msg) = @_;
2607
2608 if ($self->extcmd == 2) {
2609 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2610 } elsif ($self->extcmd == 1) {
2611 #TODO: version 1, remove
2612 unshift @msg, msgtype => "reply", msgid => $id;
2613 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2614 }
2615}
1876 2616
1877=item $success = $client->query ($flags, "text", \&cb) 2617=item $success = $client->query ($flags, "text", \&cb)
1878 2618
1879Queues a query to the client, calling the given callback with 2619Queues a query to the client, calling the given callback with
1880the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2620the 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>. 2621C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1882 2622
1883Queries can fail, so check the return code. Or don't, as queries will become 2623Queries can fail, so check the return code. Or don't, as queries will
1884reliable at some point in the future. 2624become reliable at some point in the future.
1885 2625
1886=cut 2626=cut
1887 2627
1888sub cf::client::query { 2628sub cf::client::query {
1889 my ($self, $flags, $text, $cb) = @_; 2629 my ($self, $flags, $text, $cb) = @_;
1897 utf8::encode $text; 2637 utf8::encode $text;
1898 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2638 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1899 2639
1900 $self->send_packet ($self->{query_queue}[0][0]) 2640 $self->send_packet ($self->{query_queue}[0][0])
1901 if @{ $self->{query_queue} } == 1; 2641 if @{ $self->{query_queue} } == 1;
2642
2643 1
1902} 2644}
1903 2645
1904cf::client->attach ( 2646cf::client->attach (
2647 on_connect => sub {
2648 my ($ns) = @_;
2649
2650 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2651 },
1905 on_reply => sub { 2652 on_reply => sub {
1906 my ($ns, $msg) = @_; 2653 my ($ns, $msg) = @_;
1907 2654
1908 # this weird shuffling is so that direct followup queries 2655 # this weird shuffling is so that direct followup queries
1909 # get handled first 2656 # get handled first
1910 my $queue = delete $ns->{query_queue} 2657 my $queue = delete $ns->{query_queue}
1911 or return; # be conservative, not sure how that can happen, but we saw a crash here 2658 or return; # be conservative, not sure how that can happen, but we saw a crash here
1912 2659
1913 (shift @$queue)->[1]->($msg); 2660 (shift @$queue)->[1]->($msg);
2661 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1914 2662
1915 push @{ $ns->{query_queue} }, @$queue; 2663 push @{ $ns->{query_queue} }, @$queue;
1916 2664
1917 if (@{ $ns->{query_queue} } == @$queue) { 2665 if (@{ $ns->{query_queue} } == @$queue) {
1918 if (@$queue) { 2666 if (@$queue) {
1920 } else { 2668 } else {
1921 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2669 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1922 } 2670 }
1923 } 2671 }
1924 }, 2672 },
2673 on_exticmd => sub {
2674 my ($ns, $buf) = @_;
2675
2676 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2677
2678 if (ref $msg) {
2679 my ($type, $reply, @payload) =
2680 "ARRAY" eq ref $msg
2681 ? @$msg
2682 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2683
2684 my @reply;
2685
2686 if (my $cb = $EXTICMD{$type}) {
2687 @reply = $cb->($ns, @payload);
2688 }
2689
2690 $ns->ext_reply ($reply, @reply)
2691 if $reply;
2692
2693 } else {
2694 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2695 }
2696
2697 cf::override;
2698 },
1925); 2699);
1926 2700
1927=item $client->async (\&cb) 2701=item $client->async (\&cb)
1928 2702
1929Create a new coroutine, running the specified callback. The coroutine will 2703Create a new coroutine, running the specified callback. The coroutine will
1970our $safe = new Safe "safe"; 2744our $safe = new Safe "safe";
1971our $safe_hole = new Safe::Hole; 2745our $safe_hole = new Safe::Hole;
1972 2746
1973$SIG{FPE} = 'IGNORE'; 2747$SIG{FPE} = 'IGNORE';
1974 2748
1975$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2749$safe->permit_only (Opcode::opset qw(
2750 :base_core :base_mem :base_orig :base_math
2751 grepstart grepwhile mapstart mapwhile
2752 sort time
2753));
1976 2754
1977# here we export the classes and methods available to script code 2755# here we export the classes and methods available to script code
1978 2756
1979=pod 2757=pod
1980 2758
1981The following fucntions and emthods are available within a safe environment: 2759The following functions and methods are available within a safe environment:
1982 2760
1983 cf::object contr pay_amount pay_player map 2761 cf::object
2762 contr pay_amount pay_player map x y force_find force_add
2763 insert remove name archname title slaying race decrease_ob_nr
2764
1984 cf::object::player player 2765 cf::object::player
1985 cf::player peaceful 2766 player
1986 cf::map trigger 2767
2768 cf::player
2769 peaceful
2770
2771 cf::map
2772 trigger
1987 2773
1988=cut 2774=cut
1989 2775
1990for ( 2776for (
1991 ["cf::object" => qw(contr pay_amount pay_player map)], 2777 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2778 insert remove inv name archname title slaying race
2779 decrease_ob_nr)],
1992 ["cf::object::player" => qw(player)], 2780 ["cf::object::player" => qw(player)],
1993 ["cf::player" => qw(peaceful)], 2781 ["cf::player" => qw(peaceful)],
1994 ["cf::map" => qw(trigger)], 2782 ["cf::map" => qw(trigger)],
1995) { 2783) {
1996 no strict 'refs'; 2784 no strict 'refs';
2067=back 2855=back
2068 2856
2069=cut 2857=cut
2070 2858
2071############################################################################# 2859#############################################################################
2860# the server's init and main functions
2072 2861
2073=head2 EXTENSION DATABASE SUPPORT 2862sub load_facedata($) {
2863 my ($path) = @_;
2074 2864
2075Crossfire maintains a very simple database for extension use. It can 2865 # HACK to clear player env face cache, we need some signal framework
2076currently store anything that can be serialised using Storable, which 2866 # for this (global event?)
2077excludes objects. 2867 %ext::player_env::MUSIC_FACE_CACHE = ();
2078 2868
2079The parameter C<$family> should best start with the name of the extension 2869 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2080using it, it should be unique.
2081 2870
2082=over 4 2871 warn "loading facedata from $path\n";
2083 2872
2084=item $hashref = cf::db_get $family 2873 my $facedata;
2874 0 < aio_load $path, $facedata
2875 or die "$path: $!";
2085 2876
2086Return a hashref for use by the extension C<$family>, which can be 2877 $facedata = Coro::Storable::thaw $facedata;
2087modified. After modifications, you have to call C<cf::db_dirty> or
2088C<cf::db_sync>.
2089 2878
2090=item $value = cf::db_get $family => $key 2879 $facedata->{version} == 2
2880 or cf::cleanup "$path: version mismatch, cannot proceed.";
2091 2881
2092Returns a single value from the database 2882 # patch in the exptable
2093 2883 $facedata->{resource}{"res/exp_table"} = {
2094=item cf::db_put $family => $hashref 2884 type => FT_RSRC,
2095 2885 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 }); 2886 };
2887 cf::cede_to_tick;
2145 2888
2146 sub db_dirty() {
2147 $dirty = 1;
2148 $idle->start;
2149 } 2889 {
2890 my $faces = $facedata->{faceinfo};
2150 2891
2151 sub db_get($;$) { 2892 while (my ($face, $info) = each %$faces) {
2152 @_ >= 2 2893 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2153 ? $DB->{$_[0]}{$_[1]} 2894 cf::face::set_visibility $idx, $info->{visibility};
2154 : ($DB->{$_[0]} ||= { }) 2895 cf::face::set_magicmap $idx, $info->{magicmap};
2155 } 2896 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2897 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2156 2898
2157 sub db_put($$;$) { 2899 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 }, 2900 }
2171 );
2172}
2173 2901
2174############################################################################# 2902 while (my ($face, $info) = each %$faces) {
2175# the server's main() 2903 next unless $info->{smooth};
2904 my $idx = cf::face::find $face
2905 or next;
2906 if (my $smooth = cf::face::find $info->{smooth}) {
2907 cf::face::set_smooth $idx, $smooth;
2908 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2909 } else {
2910 warn "smooth face '$info->{smooth}' not found for face '$face'";
2911 }
2176 2912
2177sub cfg_load { 2913 cf::cede_to_tick;
2914 }
2915 }
2916
2917 {
2918 my $anims = $facedata->{animinfo};
2919
2920 while (my ($anim, $info) = each %$anims) {
2921 cf::anim::set $anim, $info->{frames}, $info->{facings};
2922 cf::cede_to_tick;
2923 }
2924
2925 cf::anim::invalidate_all; # d'oh
2926 }
2927
2928 {
2929 # TODO: for gcfclient pleasure, we should give resources
2930 # that gcfclient doesn't grok a >10000 face index.
2931 my $res = $facedata->{resource};
2932
2933 my $soundconf = delete $res->{"res/sound.conf"};
2934
2935 while (my ($name, $info) = each %$res) {
2936 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2937 my $data;
2938
2939 if ($info->{type} & 1) {
2940 # prepend meta info
2941
2942 my $meta = $enc->encode ({
2943 name => $name,
2944 %{ $info->{meta} || {} },
2945 });
2946
2947 $data = pack "(w/a*)*", $meta, $info->{data};
2948 } else {
2949 $data = $info->{data};
2950 }
2951
2952 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2953 cf::face::set_type $idx, $info->{type};
2954
2955 cf::cede_to_tick;
2956 }
2957
2958 if ($soundconf) {
2959 $soundconf = $enc->decode (delete $soundconf->{data});
2960
2961 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2962 my $sound = $soundconf->{compat}[$_]
2963 or next;
2964
2965 my $face = cf::face::find "sound/$sound->[1]";
2966 cf::sound::set $sound->[0] => $face;
2967 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2968 }
2969
2970 while (my ($k, $v) = each %{$soundconf->{event}}) {
2971 my $face = cf::face::find "sound/$v";
2972 cf::sound::set $k => $face;
2973 }
2974 }
2975 }
2976
2977 1
2978}
2979
2980register_exticmd fx_want => sub {
2981 my ($ns, $want) = @_;
2982
2983 while (my ($k, $v) = each %$want) {
2984 $ns->fx_want ($k, $v);
2985 }
2986};
2987
2988sub reload_regions {
2989 # HACK to clear player env face cache, we need some signal framework
2990 # for this (global event?)
2991 %ext::player_env::MUSIC_FACE_CACHE = ();
2992
2993 load_resource_file "$MAPDIR/regions"
2994 or die "unable to load regions file\n";
2995
2996 for (cf::region::list) {
2997 $_->{match} = qr/$_->{match}/
2998 if exists $_->{match};
2999 }
3000}
3001
3002sub reload_facedata {
3003 load_facedata "$DATADIR/facedata"
3004 or die "unable to load facedata\n";
3005}
3006
3007sub reload_archetypes {
3008 load_resource_file "$DATADIR/archetypes"
3009 or die "unable to load archetypes\n";
3010 #d# NEED to laod twice to resolve forward references
3011 # this really needs to be done in an extra post-pass
3012 # (which needs to be synchronous, so solve it differently)
3013 load_resource_file "$DATADIR/archetypes"
3014 or die "unable to load archetypes\n";
3015}
3016
3017sub reload_treasures {
3018 load_resource_file "$DATADIR/treasures"
3019 or die "unable to load treasurelists\n";
3020}
3021
3022sub reload_resources {
3023 warn "reloading resource files...\n";
3024
3025 reload_regions;
3026 reload_facedata;
3027 #reload_archetypes;#d#
3028 reload_archetypes;
3029 reload_treasures;
3030
3031 warn "finished reloading resource files\n";
3032}
3033
3034sub init {
3035 reload_resources;
3036}
3037
3038sub reload_config {
2178 open my $fh, "<:utf8", cf::confdir . "/config" 3039 open my $fh, "<:utf8", "$CONFDIR/config"
2179 or return; 3040 or return;
2180 3041
2181 local $/; 3042 local $/;
2182 *CFG = YAML::Syck::Load <$fh>; 3043 *CFG = YAML::Syck::Load <$fh>;
2183 3044
2197 3058
2198sub main { 3059sub main {
2199 # we must not ever block the main coroutine 3060 # we must not ever block the main coroutine
2200 local $Coro::idle = sub { 3061 local $Coro::idle = sub {
2201 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3062 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3063 (async {
2202 async { Event::one_event }; 3064 Event::one_event;
3065 })->prio (Coro::PRIO_MAX);
2203 }; 3066 };
2204 3067
2205 cfg_load; 3068 reload_config;
2206 db_load; 3069 db_init;
2207 load_extensions; 3070 load_extensions;
3071
3072 $TICK_WATCHER->start;
2208 Event::loop; 3073 Event::loop;
2209} 3074}
2210 3075
2211############################################################################# 3076#############################################################################
2212# initialisation 3077# initialisation and cleanup
2213 3078
3079# install some emergency cleanup handlers
3080BEGIN {
3081 for my $signal (qw(INT HUP TERM)) {
3082 Event->signal (
3083 reentrant => 0,
3084 data => WF_AUTOCANCEL,
3085 signal => $signal,
3086 prio => 0,
3087 cb => sub {
3088 cf::cleanup "SIG$signal";
3089 },
3090 );
3091 }
3092}
3093
3094sub write_runtime {
3095 my $runtime = "$LOCALDIR/runtime";
3096
3097 # first touch the runtime file to show we are still running:
3098 # the fsync below can take a very very long time.
3099
3100 IO::AIO::aio_utime $runtime, undef, undef;
3101
3102 my $guard = cf::lock_acquire "write_runtime";
3103
3104 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3105 or return;
3106
3107 my $value = $cf::RUNTIME + 90 + 10;
3108 # 10 is the runtime save interval, for a monotonic clock
3109 # 60 allows for the watchdog to kill the server.
3110
3111 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3112 and return;
3113
3114 # always fsync - this file is important
3115 aio_fsync $fh
3116 and return;
3117
3118 # touch it again to show we are up-to-date
3119 aio_utime $fh, undef, undef;
3120
3121 close $fh
3122 or return;
3123
3124 aio_rename "$runtime~", $runtime
3125 and return;
3126
3127 warn "runtime file written.\n";
3128
3129 1
3130}
3131
3132sub emergency_save() {
3133 my $freeze_guard = cf::freeze_mainloop;
3134
3135 warn "enter emergency perl save\n";
3136
3137 cf::sync_job {
3138 # use a peculiar iteration method to avoid tripping on perl
3139 # refcount bugs in for. also avoids problems with players
3140 # and maps saved/destroyed asynchronously.
3141 warn "begin emergency player save\n";
3142 for my $login (keys %cf::PLAYER) {
3143 my $pl = $cf::PLAYER{$login} or next;
3144 $pl->valid or next;
3145 $pl->save;
3146 }
3147 warn "end emergency player save\n";
3148
3149 warn "begin emergency map save\n";
3150 for my $path (keys %cf::MAP) {
3151 my $map = $cf::MAP{$path} or next;
3152 $map->valid or next;
3153 $map->save;
3154 }
3155 warn "end emergency map save\n";
3156
3157 warn "begin emergency database checkpoint\n";
3158 BDB::db_env_txn_checkpoint $DB_ENV;
3159 warn "end emergency database checkpoint\n";
3160 };
3161
3162 warn "leave emergency perl save\n";
3163}
3164
3165sub post_cleanup {
3166 my ($make_core) = @_;
3167
3168 warn Carp::longmess "post_cleanup backtrace"
3169 if $make_core;
3170}
3171
2214sub reload() { 3172sub do_reload_perl() {
2215 # can/must only be called in main 3173 # can/must only be called in main
2216 if ($Coro::current != $Coro::main) { 3174 if ($Coro::current != $Coro::main) {
2217 warn "can only reload from main coroutine\n"; 3175 warn "can only reload from main coroutine";
2218 return; 3176 return;
2219 } 3177 }
2220 3178
2221 warn "reloading..."; 3179 warn "reloading...";
2222 3180
2223 my $guard = freeze_mainloop; 3181 warn "entering sync_job";
3182
3183 cf::sync_job {
3184 cf::write_runtime; # external watchdog should not bark
2224 cf::emergency_save; 3185 cf::emergency_save;
3186 cf::write_runtime; # external watchdog should not bark
2225 3187
2226 eval { 3188 warn "syncing database to disk";
3189 BDB::db_env_txn_checkpoint $DB_ENV;
3190
2227 # if anything goes wrong in here, we should simply crash as we already saved 3191 # if anything goes wrong in here, we should simply crash as we already saved
2228 3192
2229 # cancel all watchers 3193 warn "cancelling all WF_AUTOCANCEL watchers";
2230 for (Event::all_watchers) { 3194 for (Event::all_watchers) {
2231 $_->cancel if $_->data & WF_AUTOCANCEL; 3195 $_->cancel if $_->data & WF_AUTOCANCEL;
2232 } 3196 }
2233 3197
3198 warn "flushing outstanding aio requests";
3199 for (;;) {
3200 BDB::flush;
3201 IO::AIO::flush;
3202 Coro::cede;
3203 last unless IO::AIO::nreqs || BDB::nreqs;
3204 warn "iterate...";
3205 }
3206
3207 ++$RELOAD;
3208
2234 # cancel all extension coros 3209 warn "cancelling all extension coros";
2235 $_->cancel for values %EXT_CORO; 3210 $_->cancel for values %EXT_CORO;
2236 %EXT_CORO = (); 3211 %EXT_CORO = ();
2237 3212
2238 # unload all extensions 3213 warn "removing commands";
2239 for (@exts) { 3214 %COMMAND = ();
3215
3216 warn "removing ext/exti commands";
3217 %EXTCMD = ();
3218 %EXTICMD = ();
3219
3220 warn "unloading/nuking all extensions";
3221 for my $pkg (@EXTS) {
2240 warn "unloading <$_>"; 3222 warn "... unloading $pkg";
2241 unload_extension $_; 3223
3224 if (my $cb = $pkg->can ("unload")) {
3225 eval {
3226 $cb->($pkg);
3227 1
3228 } or warn "$pkg unloaded, but with errors: $@";
2242 } 3229 }
2243 3230
3231 warn "... nuking $pkg";
3232 Symbol::delete_package $pkg;
3233 }
3234
2244 # unload all modules loaded from $LIBDIR 3235 warn "unloading all perl modules loaded from $LIBDIR";
2245 while (my ($k, $v) = each %INC) { 3236 while (my ($k, $v) = each %INC) {
2246 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3237 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2247 3238
2248 warn "removing <$k>"; 3239 warn "... unloading $k";
2249 delete $INC{$k}; 3240 delete $INC{$k};
2250 3241
2251 $k =~ s/\.pm$//; 3242 $k =~ s/\.pm$//;
2252 $k =~ s/\//::/g; 3243 $k =~ s/\//::/g;
2253 3244
2256 } 3247 }
2257 3248
2258 Symbol::delete_package $k; 3249 Symbol::delete_package $k;
2259 } 3250 }
2260 3251
2261 # sync database to disk
2262 cf::db_sync;
2263 IO::AIO::flush;
2264
2265 # get rid of safe::, as good as possible 3252 warn "getting rid of safe::, as good as possible";
2266 Symbol::delete_package "safe::$_" 3253 Symbol::delete_package "safe::$_"
2267 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3254 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2268 3255
2269 # remove register_script_function callbacks
2270 # TODO
2271
2272 # unload cf.pm "a bit" 3256 warn "unloading cf.pm \"a bit\"";
2273 delete $INC{"cf.pm"}; 3257 delete $INC{"cf.pm"};
3258 delete $INC{"cf/pod.pm"};
2274 3259
2275 # don't, removes xs symbols, too, 3260 # don't, removes xs symbols, too,
2276 # and global variables created in xs 3261 # and global variables created in xs
2277 #Symbol::delete_package __PACKAGE__; 3262 #Symbol::delete_package __PACKAGE__;
2278 3263
2279 # reload cf.pm 3264 warn "unload completed, starting to reload now";
3265
2280 warn "reloading cf.pm"; 3266 warn "reloading cf.pm";
2281 require cf; 3267 require cf;
2282 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3268 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2283 3269
2284 # load config and database again 3270 warn "loading config and database again";
2285 cf::cfg_load; 3271 cf::reload_config;
2286 cf::db_load;
2287 3272
2288 # load extensions
2289 warn "load extensions"; 3273 warn "loading extensions";
2290 cf::load_extensions; 3274 cf::load_extensions;
2291 3275
2292 # reattach attachments to objects 3276 warn "reattaching attachments to objects/players";
2293 warn "reattach"; 3277 _global_reattach; # objects, sockets
2294 _global_reattach; 3278 warn "reattaching attachments to maps";
2295 reattach $_ for values %MAP; 3279 reattach $_ for values %MAP;
2296 }; 3280 warn "reattaching attachments to players";
3281 reattach $_ for values %PLAYER;
2297 3282
2298 if ($@) { 3283 warn "leaving sync_job";
3284
3285 1
3286 } or do {
2299 warn $@; 3287 warn $@;
2300 warn "error while reloading, exiting."; 3288 warn "error while reloading, exiting.";
2301 exit 1; 3289 exit 1;
2302 } 3290 };
2303 3291
2304 warn "reloaded successfully"; 3292 warn "reloaded";
2305}; 3293};
2306 3294
2307############################################################################# 3295our $RELOAD_WATCHER; # used only during reload
2308 3296
2309unless ($LINK_MAP) { 3297sub reload_perl() {
2310 $LINK_MAP = cf::map::new; 3298 # doing reload synchronously and two reloads happen back-to-back,
3299 # coro crashes during coro_state_free->destroy here.
2311 3300
2312 $LINK_MAP->width (41); 3301 $RELOAD_WATCHER ||= Event->timer (
2313 $LINK_MAP->height (41); 3302 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, 3303 after => 0,
3304 data => WF_AUTOCANCEL,
2322 cb => sub { 3305 cb => sub {
2323 $_[0]->w->cancel; 3306 do_reload_perl;
2324 3307 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 }); 3308 },
2343 3309 );
2344 $LINK_MAP->{deny_save} = 1;
2345 $LINK_MAP->{deny_reset} = 1;
2346
2347 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2348} 3310}
2349
2350register "<global>", __PACKAGE__;
2351 3311
2352register_command "reload" => sub { 3312register_command "reload" => sub {
2353 my ($who, $arg) = @_; 3313 my ($who, $arg) = @_;
2354 3314
2355 if ($who->flag (FLAG_WIZ)) { 3315 if ($who->flag (FLAG_WIZ)) {
2356 $who->message ("start of reload.");
2357 reload;
2358 $who->message ("end of reload."); 3316 $who->message ("reloading server.");
3317 async { reload_perl };
2359 } 3318 }
2360}; 3319};
2361 3320
2362unshift @INC, $LIBDIR; 3321unshift @INC, $LIBDIR;
2363 3322
3323my $bug_warning = 0;
3324
3325our @WAIT_FOR_TICK;
3326our @WAIT_FOR_TICK_BEGIN;
3327
3328sub wait_for_tick {
3329 return unless $TICK_WATCHER->is_active;
3330 return if $Coro::current == $Coro::main;
3331
3332 my $signal = new Coro::Signal;
3333 push @WAIT_FOR_TICK, $signal;
3334 $signal->wait;
3335}
3336
3337sub wait_for_tick_begin {
3338 return unless $TICK_WATCHER->is_active;
3339 return if $Coro::current == $Coro::main;
3340
3341 my $signal = new Coro::Signal;
3342 push @WAIT_FOR_TICK_BEGIN, $signal;
3343 $signal->wait;
3344}
3345
3346 my $min = 1e6;#d#
3347 my $avg = 10;
2364$TICK_WATCHER = Event->timer ( 3348$TICK_WATCHER = Event->timer (
2365 reentrant => 0, 3349 reentrant => 0,
3350 parked => 1,
2366 prio => 0, 3351 prio => 0,
2367 at => $NEXT_TICK || $TICK, 3352 at => $NEXT_TICK || $TICK,
2368 data => WF_AUTOCANCEL, 3353 data => WF_AUTOCANCEL,
2369 cb => sub { 3354 cb => sub {
3355 if ($Coro::current != $Coro::main) {
3356 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3357 unless ++$bug_warning > 10;
3358 return;
3359 }
3360
3361 $NOW = $tick_start = Event::time;
3362
2370 cf::server_tick; # one server iteration 3363 cf::server_tick; # one server iteration
3364
3365 0 && sync_job {#d#
3366 for(1..10) {
3367 my $t = Event::time;
3368 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3369 or die;
3370
3371 $map->width (50);
3372 $map->height (50);
3373 $map->alloc;
3374 $map->_load_objects ("/tmp/x.map", 1);
3375 my $t = Event::time - $t;
3376
3377 #next unless $t < 0.0013;#d#
3378 if ($t < $min) {
3379 $min = $t;
3380 }
3381 $avg = $avg * 0.99 + $t * 0.01;
3382 }
3383 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3384 exit 0;
3385 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3386 };
3387
2371 $RUNTIME += $TICK; 3388 $RUNTIME += $TICK;
2372 $NEXT_TICK += $TICK; 3389 $NEXT_TICK += $TICK;
2373 3390
3391 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3392 $NEXT_RUNTIME_WRITE = $NOW + 10;
3393 Coro::async_pool {
3394 write_runtime
3395 or warn "ERROR: unable to write runtime file: $!";
3396 };
3397 }
3398
3399# my $AFTER = Event::time;
3400# warn $AFTER - $NOW;#d#
3401
3402 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3403 $sig->send;
3404 }
3405 while (my $sig = shift @WAIT_FOR_TICK) {
3406 $sig->send;
3407 }
3408
3409 $NOW = Event::time;
3410
2374 # if we are delayed by four ticks or more, skip them all 3411 # if we are delayed by four ticks or more, skip them all
2375 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3412 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2376 3413
2377 $TICK_WATCHER->at ($NEXT_TICK); 3414 $TICK_WATCHER->at ($NEXT_TICK);
2378 $TICK_WATCHER->start; 3415 $TICK_WATCHER->start;
3416
3417 $LOAD = ($NOW - $tick_start) / $TICK;
3418 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3419
3420 _post_tick;
3421
3422
2379 }, 3423 },
2380); 3424);
2381 3425
3426{
2382IO::AIO::max_poll_time $TICK * 0.2; 3427 BDB::max_poll_time $TICK * 0.1;
2383 3428 $BDB_POLL_WATCHER = Event->io (
2384Event->io ( 3429 reentrant => 0,
2385 fd => IO::AIO::poll_fileno, 3430 fd => BDB::poll_fileno,
2386 poll => 'r', 3431 poll => 'r',
2387 prio => 5, 3432 prio => 0,
2388 data => WF_AUTOCANCEL,
2389 cb => \&IO::AIO::poll_cb,
2390);
2391
2392Event->timer (
2393 data => WF_AUTOCANCEL, 3433 data => WF_AUTOCANCEL,
2394 after => 0, 3434 cb => \&BDB::poll_cb,
2395 interval => 10, 3435 );
2396 cb => sub { 3436 BDB::min_parallel 8;
2397 (Coro::unblock_sub { 3437
2398 write_runtime 3438 BDB::set_sync_prepare {
2399 or warn "ERROR: unable to write runtime file: $!"; 3439 my $status;
3440 my $current = $Coro::current;
3441 (
3442 sub {
3443 $status = $!;
3444 $current->ready; undef $current;
3445 },
3446 sub {
3447 Coro::schedule while defined $current;
3448 $! = $status;
3449 },
3450 )
3451 };
3452
3453 unless ($DB_ENV) {
3454 $DB_ENV = BDB::db_env_create;
3455
3456 cf::sync_job {
3457 eval {
3458 BDB::db_env_open
3459 $DB_ENV,
3460 $BDBDIR,
3461 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3462 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3463 0666;
3464
3465 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3466
3467 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3468 $DB_ENV->set_lk_detect;
3469 };
3470
3471 cf::cleanup "db_env_open(db): $@" if $@;
2400 })->(); 3472 };
2401 }, 3473 }
2402); 3474}
3475
3476{
3477 IO::AIO::min_parallel 8;
3478
3479 undef $Coro::AIO::WATCHER;
3480 IO::AIO::max_poll_time $TICK * 0.1;
3481 $AIO_POLL_WATCHER = Event->io (
3482 reentrant => 0,
3483 data => WF_AUTOCANCEL,
3484 fd => IO::AIO::poll_fileno,
3485 poll => 'r',
3486 prio => 6,
3487 cb => \&IO::AIO::poll_cb,
3488 );
3489}
3490
3491my $_log_backtrace;
3492
3493sub _log_backtrace {
3494 my ($msg, @addr) = @_;
3495
3496 $msg =~ s/\n//;
3497
3498 # limit the # of concurrent backtraces
3499 if ($_log_backtrace < 2) {
3500 ++$_log_backtrace;
3501 async {
3502 my @bt = fork_call {
3503 @addr = map { sprintf "%x", $_ } @addr;
3504 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3505 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3506 or die "addr2line: $!";
3507
3508 my @funcs;
3509 my @res = <$fh>;
3510 chomp for @res;
3511 while (@res) {
3512 my ($func, $line) = splice @res, 0, 2, ();
3513 push @funcs, "[$func] $line";
3514 }
3515
3516 @funcs
3517 };
3518
3519 LOG llevInfo, "[ABT] $msg\n";
3520 LOG llevInfo, "[ABT] $_\n" for @bt;
3521 --$_log_backtrace;
3522 };
3523 } else {
3524 LOG llevInfo, "[ABT] $msg\n";
3525 LOG llevInfo, "[ABT] [suppressed]\n";
3526 }
3527}
3528
3529# load additional modules
3530use cf::pod;
2403 3531
2404END { cf::emergency_save } 3532END { cf::emergency_save }
2405 3533
24061 35341
2407 3535

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines