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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines