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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines