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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines