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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines