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.168 by root, Sun Jan 14 00:37:14 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;
49our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 79our $NEXT_TICK;
52our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
53 85
54our %CFG; 86our %CFG;
55 87
56our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 89our $RUNTIME;
58 90
59our %PLAYER; # all users 91our %PLAYER; # all users
60our %MAP; # all maps 92our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 94
67# 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 ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 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
70binmode STDOUT; 102binmode STDOUT;
71binmode STDERR; 103binmode STDERR;
72 104
73# read virtual server time, if available 105# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
78} 110}
79 111
80mkdir cf::localdir; 112mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 114
86our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
87 118
88############################################################################# 119#############################################################################
89 120
90=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
91 122
98=item $cf::RUNTIME 129=item $cf::RUNTIME
99 130
100The 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
101every server tick. 132every server tick.
102 133
103=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
104 137
105The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
106be 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.
107 142
108=item $cf::NOW 143=item $cf::NOW
109 144
110The time of the last (current) server tick. 145The time of the last (current) server tick.
111 146
112=item $cf::TICK 147=item $cf::TICK
113 148
114The 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.
115 160
116=item %cf::CFG 161=item %cf::CFG
117 162
118Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
119from wherever your confdir points to. 164from wherever your confdir points to.
120 165
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
122 167
123These 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
124or 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
125processing 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.
126window 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.
127 177
128=back 178=back
129 179
130=cut 180=cut
131 181
132BEGIN { 182BEGIN {
133 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 184 my $msg = join "", @_;
135 utf8::encode $msg;
136 185
137 $msg .= "\n" 186 $msg .= "\n"
138 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
139 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
140 LOG llevError, $msg; 192 LOG llevError, $msg;
141 }; 193 };
142} 194}
143 195
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@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';
149@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)
150 203
151# 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
152# within the Safe compartment. 205# within the Safe compartment.
153for my $pkg (qw( 206for my $pkg (qw(
154 cf::global cf::attachable 207 cf::global cf::attachable
162} 215}
163 216
164$Event::DIED = sub { 217$Event::DIED = sub {
165 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
166}; 219};
220
221#############################################################################
167 222
168=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
169 224
170=over 4 225=over 4
171 226
190 $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;
191 $d 246 $d
192 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
193} 248}
194 249
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
198 251
199Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
200 253
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
209 255
210Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
211 257
212=cut 258=cut
213 259
214sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
216 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
217} 263sub from_json ($) { $json_coder->decode ($_[0]) }
218 264
219=item cf::lock_wait $string 265=item cf::lock_wait $string
220 266
221Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
222 268
228returned. 274returned.
229 275
230Lock 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
231uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
232 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
233=cut 283=cut
234 284
235our %LOCK; 285our %LOCK;
236 286
237sub lock_wait($) { 287sub lock_wait($) {
256 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
258 } 308 }
259} 309}
260 310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
261sub freeze_mainloop { 317sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
263 319
264 my $guard = Coro::guard { 320 my $guard = Coro::guard {
265 $TICK_WATCHER->start; 321 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 }; 322 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
270 $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;
271} 375}
272 376
273=item cf::async { BLOCK } 377=item cf::async { BLOCK }
274 378
275Currently the same as Coro::async_pool, meaning you cannot use 379Currently the same as Coro::async_pool, meaning you cannot use
280 384
281BEGIN { *async = \&Coro::async_pool } 385BEGIN { *async = \&Coro::async_pool }
282 386
283=item cf::sync_job { BLOCK } 387=item cf::sync_job { BLOCK }
284 388
285The design of crossfire+ requires that the main coro ($Coro::main) is 389The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 390is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. 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.
288 393
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 395the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 397fast or be very important.
295 400
296sub sync_job(&) { 401sub sync_job(&) {
297 my ($job) = @_; 402 my ($job) = @_;
298 403
299 if ($Coro::current == $Coro::main) { 404 if ($Coro::current == $Coro::main) {
405 my $time = Event::time;
406
300 # this is the main coro, too bad, we have to block 407 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 408 # till the operation succeeds, freezing the server :/
302 409
303 # TODO: use suspend/resume instead 410 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 411 # (but this is cancel-safe)
315 422
316 while ($busy) { 423 while ($busy) {
317 Coro::cede or Event::one_event; 424 Coro::cede or Event::one_event;
318 } 425 }
319 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
320 wantarray ? @res : $res[0] 434 wantarray ? @res : $res[0]
321 } else { 435 } else {
322 # we are in another coroutine, how wonderful, everything just works 436 # we are in another coroutine, how wonderful, everything just works
323 437
324 $job->() 438 $job->()
343 $EXT_CORO{$coro+0} = $coro; 457 $EXT_CORO{$coro+0} = $coro;
344 458
345 $coro 459 $coro
346} 460}
347 461
348sub write_runtime { 462=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 463
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 464Executes the given code block with the given arguments in a seperate
352 or return; 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.
353 468
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 469=cut
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357 470
358 aio_fsync $fh 471sub _store_scalar {
359 and return; 472 open my $fh, ">", \my $buf
360 473 or die "fork_call: cannot open fh-to-buf in child : $!";
474 Storable::store_fd $_[0], $fh;
361 close $fh 475 close $fh;
362 or return;
363 476
364 aio_rename "$runtime~", $runtime 477 $buf
365 and return; 478}
366 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;
367 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 });
368} 649}
369 650
370=back 651=back
371 652
372=cut 653=cut
379attach callbacks/event handlers (a collection of which is called an "attachment") 660attach callbacks/event handlers (a collection of which is called an "attachment")
380to it. All such attachable objects support the following methods. 661to it. All such attachable objects support the following methods.
381 662
382In 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>
383C<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
384crossfire+). 665Crossfire TRT).
385 666
386=over 4 667=over 4
387 668
388=item $attachable->attach ($attachment, key => $value...) 669=item $attachable->attach ($attachment, key => $value...)
389 670
503our @CB_TYPE = (); # registry for type (cf-object class) based events 784our @CB_TYPE = (); # registry for type (cf-object class) based events
504our @CB_MAP = (); 785our @CB_MAP = ();
505 786
506my %attachment; 787my %attachment;
507 788
789sub cf::attachable::thawer_merge {
790 # simply override everything except _meta
791 local $_[0]{_meta};
792 %{$_[0]} = %{$_[1]};
793}
794
508sub _attach_cb($$$$) { 795sub _attach_cb($$$$) {
509 my ($registry, $event, $prio, $cb) = @_; 796 my ($registry, $event, $prio, $cb) = @_;
510 797
511 use sort 'stable'; 798 use sort 'stable';
512 799
546 $registry = $CB_TYPE[$object_type] ||= []; 833 $registry = $CB_TYPE[$object_type] ||= [];
547 834
548 } elsif ($type eq "subtype") { 835 } elsif ($type eq "subtype") {
549 defined $object_type or Carp::croak "subtype specified without type"; 836 defined $object_type or Carp::croak "subtype specified without type";
550 my $object_subtype = shift @arg; 837 my $object_subtype = shift @arg;
551 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 838 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
552 839
553 } elsif ($type eq "package") { 840 } elsif ($type eq "package") {
554 my $pkg = shift @arg; 841 my $pkg = shift @arg;
555 842
556 while (my ($name, $id) = each %cb_id) { 843 while (my ($name, $id) = each %cb_id) {
585 _attach $registry, $klass, @attach; 872 _attach $registry, $klass, @attach;
586 } 873 }
587 874
588 $obj->{$name} = \%arg; 875 $obj->{$name} = \%arg;
589 } else { 876 } else {
590 warn "object uses attachment '$name' that is not available, postponing.\n"; 877 warn "object uses attachment '$name' which is not available, postponing.\n";
591 } 878 }
592 879
593 $obj->{_attachment}{$name} = undef; 880 $obj->{_attachment}{$name} = undef;
594} 881}
595 882
597 if (ref $_[0]) { 884 if (ref $_[0]) {
598 _object_attach @_; 885 _object_attach @_;
599 } else { 886 } else {
600 _attach shift->_attach_registry, @_; 887 _attach shift->_attach_registry, @_;
601 } 888 }
889 _recalc_want;
602}; 890};
603 891
604# all those should be optimised 892# all those should be optimised
605sub cf::attachable::detach { 893sub cf::attachable::detach {
606 my ($obj, $name) = @_; 894 my ($obj, $name) = @_;
609 delete $obj->{_attachment}{$name}; 897 delete $obj->{_attachment}{$name};
610 reattach ($obj); 898 reattach ($obj);
611 } else { 899 } else {
612 Carp::croak "cannot, currently, detach class attachments"; 900 Carp::croak "cannot, currently, detach class attachments";
613 } 901 }
902 _recalc_want;
614}; 903};
615 904
616sub cf::attachable::attached { 905sub cf::attachable::attached {
617 my ($obj, $name) = @_; 906 my ($obj, $name) = @_;
618 907
633 "; 922 ";
634 die if $@; 923 die if $@;
635} 924}
636 925
637our $override; 926our $override;
638our @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?
639 928
640sub override { 929sub override {
641 $override = 1; 930 $override = 1;
642 @invoke_results = (); 931 @INVOKE_RESULTS = (@_);
643} 932}
644 933
645sub do_invoke { 934sub do_invoke {
646 my $event = shift; 935 my $event = shift;
647 my $callbacks = shift; 936 my $callbacks = shift;
648 937
649 @invoke_results = (); 938 @INVOKE_RESULTS = ();
650 939
651 local $override; 940 local $override;
652 941
653 for (@$callbacks) { 942 for (@$callbacks) {
654 eval { &{$_->[1]} }; 943 eval { &{$_->[1]} };
671 960
672Generate an object-specific event with the given arguments. 961Generate an object-specific event with the given arguments.
673 962
674This 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
675removed 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
676results (if you must, access C<@cf::invoke_results> directly). 965results (if you must, access C<@cf::INVOKE_RESULTS> directly).
677 966
678=back 967=back
679 968
680=cut 969=cut
681 970
682############################################################################# 971#############################################################################
683# 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}
684 984
685sub reattach { 985sub reattach {
686 # basically do the same as instantiate, without calling instantiate 986 # basically do the same as instantiate, without calling instantiate
687 my ($obj) = @_; 987 my ($obj) = @_;
988
989 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
688 990
689 my $registry = $obj->registry; 991 my $registry = $obj->registry;
690 992
691 @$registry = (); 993 @$registry = ();
692 994
739 $filename, length $$rdata, scalar @$objs; 1041 $filename, length $$rdata, scalar @$objs;
740 1042
741 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1043 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
742 chmod SAVE_MODE, $fh; 1044 chmod SAVE_MODE, $fh;
743 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1045 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
744 aio_fsync $fh; 1046 aio_fsync $fh if $cf::USE_FSYNC;
745 close $fh; 1047 close $fh;
746 1048
747 if (@$objs) { 1049 if (@$objs) {
748 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) {
749 chmod SAVE_MODE, $fh; 1051 chmod SAVE_MODE, $fh;
750 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1052 my $data = Storable::nfreeze { version => 1, objs => $objs };
751 aio_write $fh, 0, (length $data), $data, 0; 1053 aio_write $fh, 0, (length $data), $data, 0;
752 aio_fsync $fh; 1054 aio_fsync $fh if $cf::USE_FSYNC;
753 close $fh; 1055 close $fh;
754 aio_rename "$filename.pst~", "$filename.pst"; 1056 aio_rename "$filename.pst~", "$filename.pst";
755 } 1057 }
756 } else { 1058 } else {
757 aio_unlink "$filename.pst"; 1059 aio_unlink "$filename.pst";
789 or return; 1091 or return;
790 $av = eval { (Storable::thaw $av)->{objs} }; 1092 $av = eval { (Storable::thaw $av)->{objs} };
791 } 1093 }
792 1094
793 warn sprintf "loading %s (%d)\n", 1095 warn sprintf "loading %s (%d)\n",
794 $filename, length $data, scalar @{$av || []};#d# 1096 $filename, length $data, scalar @{$av || []};
795 return ($data, $av); 1097 return ($data, $av);
796} 1098}
1099
1100=head2 COMMAND CALLBACKS
1101
1102=over 4
1103
1104=cut
797 1105
798############################################################################# 1106#############################################################################
799# command handling &c 1107# command handling &c
800 1108
801=item cf::register_command $name => \&callback($ob,$args); 1109=item cf::register_command $name => \&callback($ob,$args);
814 push @{ $COMMAND{$name} }, [$caller, $cb]; 1122 push @{ $COMMAND{$name} }, [$caller, $cb];
815} 1123}
816 1124
817=item cf::register_extcmd $name => \&callback($pl,$packet); 1125=item cf::register_extcmd $name => \&callback($pl,$packet);
818 1126
819Register 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.
820 1132
821If 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
822called. 1134called.
823 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
824=cut 1147=cut
825 1148
826sub register_extcmd { 1149sub register_extcmd {
827 my ($name, $cb) = @_; 1150 my ($name, $cb) = @_;
828 1151
829 $EXTCMD{$name} = $cb; 1152 $EXTCMD{$name} = $cb;
1153}
1154
1155sub register_exticmd {
1156 my ($name, $cb) = @_;
1157
1158 $EXTICMD{$name} = $cb;
830} 1159}
831 1160
832cf::player->attach ( 1161cf::player->attach (
833 on_command => sub { 1162 on_command => sub {
834 my ($pl, $name, $params) = @_; 1163 my ($pl, $name, $params) = @_;
843 cf::override; 1172 cf::override;
844 }, 1173 },
845 on_extcmd => sub { 1174 on_extcmd => sub {
846 my ($pl, $buf) = @_; 1175 my ($pl, $buf) = @_;
847 1176
848 my $msg = eval { from_json $buf }; 1177 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
849 1178
850 if (ref $msg) { 1179 if (ref $msg) {
851 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1180 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
852 if (my %reply = $cb->($pl, $msg)) { 1181 if (my %reply = $cb->($pl, $msg)) {
853 $pl->ext_reply ($msg->{msgid}, %reply); 1182 $pl->ext_reply ($msg->{msgid}, %reply);
859 1188
860 cf::override; 1189 cf::override;
861 }, 1190 },
862); 1191);
863 1192
864sub load_extension {
865 my ($path) = @_;
866
867 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
868 my $base = $1;
869 my $pkg = $1;
870 $pkg =~ s/[^[:word:]]/_/g;
871 $pkg = "ext::$pkg";
872
873 warn "... loading '$path' into '$pkg'\n";
874
875 open my $fh, "<:utf8", $path
876 or die "$path: $!";
877
878 my $source =
879 "package $pkg; use strict; use utf8;\n"
880 . "#line 1 \"$path\"\n{\n"
881 . (do { local $/; <$fh> })
882 . "\n};\n1";
883
884 unless (eval $source) {
885 my $msg = $@ ? "$path: $@\n"
886 : "extension disabled.\n";
887 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
888 warn $@;
889 warn "mandatory extension failed to load, exiting.\n";
890 exit 1;
891 }
892 die $@;
893 }
894
895 push @EXTS, $pkg;
896}
897
898sub load_extensions { 1193sub load_extensions {
1194 cf::sync_job {
1195 my %todo;
1196
899 for my $ext (<$LIBDIR/*.ext>) { 1197 for my $path (<$LIBDIR/*.ext>) {
900 next unless -r $ext; 1198 next unless -r $path;
901 eval { 1199
902 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;
903 1 1257 }
904 } or warn "$ext not loaded: $@"; 1258
1259 skip:
1260 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1261 unless $progress;
1262 }
905 } 1263 };
906} 1264}
907 1265
908############################################################################# 1266#############################################################################
909 1267
1268=back
1269
910=head2 CORE EXTENSIONS 1270=head2 CORE EXTENSIONS
911 1271
912Functions and methods that extend core crossfire objects. 1272Functions and methods that extend core crossfire objects.
913 1273
914=cut 1274=cut
926Returns the given player object, loading it if necessary (might block). 1286Returns the given player object, loading it if necessary (might block).
927 1287
928=cut 1288=cut
929 1289
930sub playerdir($) { 1290sub playerdir($) {
931 cf::localdir 1291 "$PLAYERDIR/"
932 . "/"
933 . cf::playerdir
934 . "/"
935 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1292 . (ref $_[0] ? $_[0]->ob->name : $_[0])
936} 1293}
937 1294
938sub path($) { 1295sub path($) {
939 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1296 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
940 1297
941 (playerdir $login) . "/$login.pl" 1298 (playerdir $login) . "/playerdata"
942} 1299}
943 1300
944sub find_active($) { 1301sub find_active($) {
945 $cf::PLAYER{$_[0]} 1302 $cf::PLAYER{$_[0]}
946 and $cf::PLAYER{$_[0]}->active 1303 and $cf::PLAYER{$_[0]}->active
949 1306
950sub exists($) { 1307sub exists($) {
951 my ($login) = @_; 1308 my ($login) = @_;
952 1309
953 $cf::PLAYER{$login} 1310 $cf::PLAYER{$login}
954 or cf::sync_job { !aio_stat $login } 1311 or cf::sync_job { !aio_stat path $login }
955} 1312}
956 1313
957sub find($) { 1314sub find($) {
958 return $cf::PLAYER{$_[0]} || do { 1315 return $cf::PLAYER{$_[0]} || do {
959 my $login = $_[0]; 1316 my $login = $_[0];
960 1317
961 my $guard = cf::lock_acquire "user_find:$login"; 1318 my $guard = cf::lock_acquire "user_find:$login";
962 1319
963 $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
964 my $pl = load_pl path $login 1328 my $pl = load_pl path $login
965 or return; 1329 or return;
966 $cf::PLAYER{$login} = $pl 1330 $cf::PLAYER{$login} = $pl
967 } 1331 }
968 } 1332 }
1005 1369
1006=cut 1370=cut
1007 1371
1008sub quit_character { 1372sub quit_character {
1009 my ($pl) = @_; 1373 my ($pl) = @_;
1374
1375 my $name = $pl->ob->name;
1010 1376
1011 $pl->{deny_save} = 1; 1377 $pl->{deny_save} = 1;
1012 $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
1013 1379
1014 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1380 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1019 my $path = playerdir $pl; 1385 my $path = playerdir $pl;
1020 my $temp = "$path~$cf::RUNTIME~deleting~"; 1386 my $temp = "$path~$cf::RUNTIME~deleting~";
1021 aio_rename $path, $temp; 1387 aio_rename $path, $temp;
1022 delete $cf::PLAYER{$pl->ob->name}; 1388 delete $cf::PLAYER{$pl->ob->name};
1023 $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
1024 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;
1025} 1411}
1026 1412
1027=item cf::player::list_logins 1413=item cf::player::list_logins
1028 1414
1029Returns 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
1030while and may block, so not sync_job-capable, ever. 1416while and may block, so not sync_job-capable, ever.
1031 1417
1032=cut 1418=cut
1033 1419
1034sub list_logins { 1420sub list_logins {
1035 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1421 my $dirs = aio_readdir $PLAYERDIR
1036 or return []; 1422 or return [];
1037 1423
1038 my @logins; 1424 my @logins;
1039 1425
1040 for my $login (@$dirs) { 1426 for my $login (@$dirs) {
1057=cut 1443=cut
1058 1444
1059sub maps($) { 1445sub maps($) {
1060 my ($pl) = @_; 1446 my ($pl) = @_;
1061 1447
1448 $pl = ref $pl ? $pl->ob->name : $pl;
1449
1062 my $files = aio_readdir playerdir $pl 1450 my $files = aio_readdir playerdir $pl
1063 or return; 1451 or return;
1064 1452
1065 my @paths; 1453 my @paths;
1066 1454
1067 for (@$files) { 1455 for (@$files) {
1068 utf8::decode $_; 1456 utf8::decode $_;
1069 next if /\.(?:pl|pst)$/; 1457 next if /\.(?:pl|pst)$/;
1070 next unless /^$PATH_SEP/o; 1458 next unless /^$PATH_SEP/o;
1071 1459
1072 s/\.map$//; 1460 push @paths, cf::map::normalise "~$pl/$_";
1073 push @paths, "~" . $pl->ob->name . "/" . $_;
1074 } 1461 }
1075 1462
1076 \@paths 1463 \@paths
1077} 1464}
1078 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
1079=item $player->ext_reply ($msgid, $msgtype, %msg) 1516=item $player->ext_reply ($msgid, %msg)
1080 1517
1081Sends an ext reply to the player. 1518Sends an ext reply to the player.
1082 1519
1083=cut 1520=cut
1084 1521
1085sub ext_reply($$$%) { 1522sub ext_reply($$%) {
1086 my ($self, $id, %msg) = @_; 1523 my ($self, $id, %msg) = @_;
1087 1524
1088 $msg{msgid} = $id; 1525 $msg{msgid} = $id;
1089 1526 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1090 $self->send ("ext " . cf::to_json \%msg);
1091} 1527}
1092 1528
1093package 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}
1094 1569
1095=back 1570=back
1096
1097 1571
1098=head3 cf::map 1572=head3 cf::map
1099 1573
1100=over 4 1574=over 4
1101 1575
1105 1579
1106use Fcntl; 1580use Fcntl;
1107use Coro::AIO; 1581use Coro::AIO;
1108 1582
1109use overload 1583use overload
1110 '""' => \&as_string; 1584 '""' => \&as_string,
1585 fallback => 1;
1111 1586
1112our $MAX_RESET = 3600; 1587our $MAX_RESET = 3600;
1113our $DEFAULT_RESET = 3000; 1588our $DEFAULT_RESET = 3000;
1114 1589
1115sub generate_random_map { 1590sub generate_random_map {
1116 my ($self, $rmp) = @_; 1591 my ($self, $rmp) = @_;
1117
1118 # mit "rum" bekleckern, nicht 1592 # mit "rum" bekleckern, nicht
1119 $self->_create_random_map ( 1593 $self->_create_random_map (
1120 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1594 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1121 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1595 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1122 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1596 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1129 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1603 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1130 (cf::region::find $rmp->{region}), $rmp->{custom} 1604 (cf::region::find $rmp->{region}), $rmp->{custom}
1131 ) 1605 )
1132} 1606}
1133 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
1134sub register { 1616sub register {
1135 my (undef, $regex) = @_; 1617 my (undef, $regex, $prio) = @_;
1136 my $pkg = caller; 1618 my $pkg = caller;
1137 1619
1138 no strict; 1620 no strict;
1139 push @{"$pkg\::ISA"}, __PACKAGE__; 1621 push @{"$pkg\::ISA"}, __PACKAGE__;
1140 1622
1141 $EXT_MAP{$pkg} = qr<$regex>; 1623 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1142} 1624}
1143 1625
1144# also paths starting with '/' 1626# also paths starting with '/'
1145$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}
1146 1638
1147sub normalise { 1639sub normalise {
1148 my ($path, $base) = @_; 1640 my ($path, $base) = @_;
1641
1642 $path = "$path"; # make sure its a string
1643
1644 $path =~ s/\.map$//;
1149 1645
1150 # map plan: 1646 # map plan:
1151 # 1647 #
1152 # /! non-realised random map exit (special hack!) 1648 # /! non-realised random map exit (special hack!)
1153 # {... are special paths that are not being touched 1649 # {... are special paths that are not being touched
1181 1677
1182 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
1183 1679
1184 $path = normalise $path, $base; 1680 $path = normalise $path, $base;
1185 1681
1186 for my $pkg (keys %EXT_MAP) { 1682 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1187 if ($path =~ $EXT_MAP{$pkg}) { 1683 if ($path =~ $EXT_MAP{$pkg}[1]) {
1188 my $self = bless cf::map::new, $pkg; 1684 my $self = bless cf::map::new, $pkg;
1189 $self->{path} = $path; $self->path ($path); 1685 $self->{path} = $path; $self->path ($path);
1190 $self->init; # pass $1 etc. 1686 $self->init; # pass $1 etc.
1191 return $self; 1687 return $self;
1192 } 1688 }
1193 } 1689 }
1194 1690
1195 Carp::carp "unable to resolve path '$path'."; 1691 Carp::cluck "unable to resolve path '$path' (base '$base').";
1196 () 1692 ()
1197} 1693}
1198 1694
1199sub init { 1695sub init {
1200 my ($self) = @_; 1696 my ($self) = @_;
1215 1711
1216# the original (read-only) location 1712# the original (read-only) location
1217sub load_path { 1713sub load_path {
1218 my ($self) = @_; 1714 my ($self) = @_;
1219 1715
1220 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1716 "$MAPDIR/$self->{path}.map"
1221} 1717}
1222 1718
1223# the temporary/swap location 1719# the temporary/swap location
1224sub save_path { 1720sub save_path {
1225 my ($self) = @_; 1721 my ($self) = @_;
1226 1722
1227 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1723 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1228 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1724 "$TMPDIR/$path.map"
1229} 1725}
1230 1726
1231# the unique path, undef == no special unique path 1727# the unique path, undef == no special unique path
1232sub uniq_path { 1728sub uniq_path {
1233 my ($self) = @_; 1729 my ($self) = @_;
1234 1730
1235 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1731 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1236 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1732 "$UNIQUEDIR/$path"
1237} 1733}
1238 1734
1239# and all this just because we cannot iterate over 1735# and all this just because we cannot iterate over
1240# all maps in C++... 1736# all maps in C++...
1241sub change_all_map_light { 1737sub change_all_map_light {
1243 1739
1244 $_->change_map_light ($change) 1740 $_->change_map_light ($change)
1245 for grep $_->outdoor, values %cf::MAP; 1741 for grep $_->outdoor, values %cf::MAP;
1246} 1742}
1247 1743
1744sub decay_objects {
1745 my ($self) = @_;
1746
1747 return if $self->{deny_reset};
1748
1749 $self->do_decay_objects;
1750}
1751
1248sub unlink_save { 1752sub unlink_save {
1249 my ($self) = @_; 1753 my ($self) = @_;
1250 1754
1251 utf8::encode (my $save = $self->save_path); 1755 utf8::encode (my $save = $self->save_path);
1252 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1756 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1253 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1757 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1254} 1758}
1255 1759
1256sub load_header_from($) { 1760sub load_header_from($) {
1257 my ($self, $path) = @_; 1761 my ($self, $path) = @_;
1258 1762
1259 utf8::encode $path; 1763 utf8::encode $path;
1260 aio_open $path, O_RDONLY, 0 1764 #aio_open $path, O_RDONLY, 0
1261 or return; 1765 # or return;
1262 1766
1263 $self->_load_header ($path) 1767 $self->_load_header ($path)
1264 or return; 1768 or return;
1265 1769
1266 $self->{load_path} = $path; 1770 $self->{load_path} = $path;
1267 1771
1268 1 1772 1
1269} 1773}
1270 1774
1271sub load_orig { 1775sub load_header_orig {
1272 my ($self) = @_; 1776 my ($self) = @_;
1273 1777
1274 $self->load_header_from ($self->load_path) 1778 $self->load_header_from ($self->load_path)
1275} 1779}
1276 1780
1277sub load_temp { 1781sub load_header_temp {
1278 my ($self) = @_; 1782 my ($self) = @_;
1279 1783
1280 $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;
1281} 1804}
1282 1805
1283sub load_header { 1806sub load_header {
1284 my ($self) = @_; 1807 my ($self) = @_;
1285 1808
1286 if ($self->load_temp) { 1809 if ($self->load_header_temp) {
1287 $self->last_access ((delete $self->{last_access}) 1810 $self->prepare_temp;
1288 || $cf::RUNTIME); #d#
1289 # safety
1290 $self->{instantiate_time} = $cf::RUNTIME
1291 if $self->{instantiate_time} > $cf::RUNTIME;
1292 } else { 1811 } else {
1293 $self->load_orig 1812 $self->load_header_orig
1294 or return; 1813 or return;
1295 1814 $self->prepare_orig;
1296 $self->{load_original} = 1;
1297 $self->{instantiate_time} = $cf::RUNTIME;
1298 $self->last_access ($cf::RUNTIME);
1299 $self->instantiate;
1300 } 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;
1301 1822
1302 1 1823 1
1303} 1824}
1304 1825
1305sub find; 1826sub find;
1318 $map->{last_save} = $cf::RUNTIME; 1839 $map->{last_save} = $cf::RUNTIME;
1319 1840
1320 $map->load_header 1841 $map->load_header
1321 or return; 1842 or return;
1322 1843
1323 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;
1324 $map->reset; 1847 $map->reset;
1325 undef $guard; 1848 undef $guard;
1326 $map = find $path 1849 return find $path;
1327 or return;
1328 } 1850 }
1329 1851
1330 $cf::MAP{$path} = $map 1852 $cf::MAP{$path} = $map
1331 } 1853 }
1332} 1854}
1855
1856sub pre_load { }
1857sub post_load { }
1333 1858
1334sub load { 1859sub load {
1335 my ($self) = @_; 1860 my ($self) = @_;
1336 1861
1862 local $self->{deny_reset} = 1; # loading can take a long time
1863
1337 my $path = $self->{path}; 1864 my $path = $self->{path};
1865
1866 {
1338 my $guard = cf::lock_acquire "map_load:$path"; 1867 my $guard = cf::lock_acquire "map_load:$path";
1339 1868
1340 return if $self->in_memory != cf::MAP_SWAPPED; 1869 return if $self->in_memory != cf::MAP_SWAPPED;
1341 1870
1342 $self->in_memory (cf::MAP_LOADING); 1871 $self->in_memory (cf::MAP_LOADING);
1343 1872
1344 $self->alloc; 1873 $self->alloc;
1345 $self->_load_objects ($self->{load_path}, 1)
1346 or return;
1347 1874
1348 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1875 $self->pre_load;
1349 if delete $self->{load_original};
1350
1351 if (my $uniq = $self->uniq_path) {
1352 utf8::encode $uniq;
1353 if (aio_open $uniq, O_RDONLY, 0) {
1354 $self->clear_unique_items;
1355 $self->_load_objects ($uniq, 0);
1356 }
1357 }
1358
1359 Coro::cede;
1360
1361 # now do the right thing for maps
1362 $self->link_multipart_objects;
1363
1364 unless ($self->{deny_activate}) {
1365 $self->decay_objects;
1366 $self->fix_auto_apply;
1367 $self->update_buttons;
1368 Coro::cede; 1876 Coro::cede;
1369 $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;
1370 $self->difficulty ($self->estimate_difficulty) 1895 $self->difficulty ($self->estimate_difficulty)
1371 unless $self->difficulty; 1896 unless $self->difficulty;
1372 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;
1373 $self->activate; 1906 $self->activate;
1374 } 1907 }
1375 1908
1376 $self->in_memory (cf::MAP_IN_MEMORY); 1909 $self->in_memory (cf::MAP_IN_MEMORY);
1910 }
1911
1912 $self->post_load;
1377} 1913}
1378 1914
1379sub customise_for { 1915sub customise_for {
1380 my ($self, $ob) = @_; 1916 my ($self, $ob) = @_;
1381 1917
1382 return find "~" . $ob->name . "/" . $self->{path} 1918 return find "~" . $ob->name . "/" . $self->{path}
1383 if $self->per_player; 1919 if $self->per_player;
1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1384 1923
1385 $self 1924 $self
1386} 1925}
1387 1926
1388# 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
1420 1959
1421 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1422} 1961}
1423 1962
1424our %MAP_PREFETCH; 1963our %MAP_PREFETCH;
1425our $MAP_PREFETCHER = Coro::async { 1964our $MAP_PREFETCHER = undef;
1426 while () {
1427 for my $path (keys %MAP_PREFETCH) {
1428 my $map = find $path
1429 or next;
1430 $map->load;
1431
1432 delete $MAP_PREFETCH{$path};
1433 }
1434 Coro::schedule;
1435 }
1436};
1437 1965
1438sub find_async { 1966sub find_async {
1439 my ($path, $origin) = @_; 1967 my ($path, $origin) = @_;
1440 1968
1441 $path = normalise $path, $origin && $origin->{path}; 1969 $path = normalise $path, $origin && $origin->{path};
1442 1970
1443 if (my $map = $cf::MAP{$path}) { 1971 if (my $map = $cf::MAP{$path}) {
1444 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1972 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1445 } 1973 }
1446 1974
1447 $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 };
1448 $MAP_PREFETCHER->ready; 1988 $MAP_PREFETCHER->prio (6);
1449 1989
1450 () 1990 ()
1451} 1991}
1452 1992
1453sub save { 1993sub save {
1498 2038
1499sub reset_at { 2039sub reset_at {
1500 my ($self) = @_; 2040 my ($self) = @_;
1501 2041
1502 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1503 return 1e99 if $self->isa ("ext::map_per_player");
1504 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1505 2044
1506 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1507 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;
1508 2047
1513 my ($self) = @_; 2052 my ($self) = @_;
1514 2053
1515 $self->reset_at <= $cf::RUNTIME 2054 $self->reset_at <= $cf::RUNTIME
1516} 2055}
1517 2056
1518sub rename {
1519 my ($self, $new_path) = @_;
1520
1521 normalise $new_path;
1522
1523 $self->unlink_save;
1524
1525 delete $cf::MAP{$self->path};
1526 $self->{path} = $new_path; $self->path ($self->{path});
1527 $cf::MAP{$self->path} = $self;
1528
1529 $self->save;
1530}
1531
1532sub reset { 2057sub reset {
1533 my ($self) = @_; 2058 my ($self) = @_;
1534 2059
1535 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1536 2061
1537 return if $self->players; 2062 return if $self->players;
1538 return if $self->isa ("ext::map_per_player");#d#
1539 2063
1540 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 }
1541 2075
1542 delete $cf::MAP{$self->path}; 2076 delete $cf::MAP{$self->path};
1543 2077
1544 $self->in_memory (cf::MAP_SWAPPED);
1545 $self->clear; 2078 $self->clear;
1546 2079
1547 $_->clear_links_to ($self) for values %cf::MAP; 2080 $_->clear_links_to ($self) for values %cf::MAP;
1548 2081
1549 $self->unlink_save; 2082 $self->unlink_save;
1553my $nuke_counter = "aaaa"; 2086my $nuke_counter = "aaaa";
1554 2087
1555sub nuke { 2088sub nuke {
1556 my ($self) = @_; 2089 my ($self) = @_;
1557 2090
2091 delete $cf::MAP{$self->path};
2092
2093 $self->unlink_save;
2094
2095 bless $self, "cf::map";
2096 delete $self->{deny_reset};
1558 $self->{deny_save} = 1; 2097 $self->{deny_save} = 1;
1559 $self->reset_timeout (1); 2098 $self->reset_timeout (1);
1560 $self->rename ("{nuke}/" . ($nuke_counter++)); 2099 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2100
2101 $cf::MAP{$self->path} = $self;
2102
1561 $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 ]
1562} 2140}
1563 2141
1564=item cf::map::unique_maps 2142=item cf::map::unique_maps
1565 2143
1566Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1567instantiated unique items. May block. 2145instantiated unique items. May block.
1568 2146
1569=cut 2147=cut
1570 2148
1571sub unique_maps() { 2149sub unique_maps() {
1572 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2150 [
1573 or return; 2151 map {
1574
1575 my @paths;
1576
1577 for (@$files) {
1578 utf8::decode $_; 2152 utf8::decode $_;
1579 next if /\.pst$/;
1580 next unless /^$PATH_SEP/o;
1581
1582 s/\.map$//; 2153 /\.map$/
1583 push @paths, $_; 2154 ? normalise $_
2155 : ()
2156 } @{ aio_readdir $UNIQUEDIR or [] }
1584 } 2157 ]
1585
1586 \@paths
1587} 2158}
1588 2159
1589package cf; 2160package cf;
1590 2161
1591=back 2162=back
1637 2208
1638 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1639 2210
1640 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1641 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1642 } 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 {
1643 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1644 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1645 } 2230 }
1646} 2231}
1647 2232
1648=item $player_object->may ("access") 2233=item $player_object->may ("access")
1649 2234
1682=cut 2267=cut
1683 2268
1684sub link_map { 2269sub link_map {
1685 unless ($LINK_MAP) { 2270 unless ($LINK_MAP) {
1686 $LINK_MAP = cf::map::find "{link}" 2271 $LINK_MAP = cf::map::find "{link}"
1687 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2272 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1688 $LINK_MAP->load; 2273 $LINK_MAP->load;
1689 } 2274 }
1690 2275
1691 $LINK_MAP 2276 $LINK_MAP
1692} 2277}
1697 $self->deactivate_recursive; 2282 $self->deactivate_recursive;
1698 2283
1699 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2284 return if UNIVERSAL::isa $self->map, "ext::map_link";
1700 2285
1701 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2286 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1702 if $self->map; 2287 if $self->map && $self->map->{path} ne "{link}";
1703 2288
1704 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2289 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1705} 2290}
1706 2291
1707sub cf::object::player::leave_link { 2292sub cf::object::player::leave_link {
1708 my ($self, $map, $x, $y) = @_; 2293 my ($self, $map, $x, $y) = @_;
2294
2295 return unless $self->contr->active;
1709 2296
1710 my $link_pos = delete $self->{_link_pos}; 2297 my $link_pos = delete $self->{_link_pos};
1711 2298
1712 unless ($map) { 2299 unless ($map) {
1713 # restore original map position 2300 # restore original map position
1731 $map->load; 2318 $map->load;
1732 $map->load_diag; 2319 $map->load_diag;
1733 2320
1734 return unless $self->contr->active; 2321 return unless $self->contr->active;
1735 $self->activate_recursive; 2322 $self->activate_recursive;
2323
2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1736 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1737} 2326}
1738 2327
1739cf::player->attach ( 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1740 on_logout => sub {
1741 my ($pl) = @_;
1742 2329
1743 # abort map switching before logout 2330Moves the player to the given map-path and coordinates by first freezing
1744 if ($pl->ob->{_link_pos}) { 2331her, loading and preparing them map, calling the provided $check callback
1745 cf::sync_job { 2332that has to return the map if sucecssful, and then unfreezes the player on
1746 $pl->ob->leave_link 2333the new (success) or old (failed) map position. In either case, $done will
1747 }; 2334be called at the end of this process.
1748 }
1749 },
1750 on_login => sub {
1751 my ($pl) = @_;
1752 2335
1753 # try to abort aborted map switching on player login :)
1754 # should happen only on crashes
1755 if ($pl->ob->{_link_pos}) {
1756 $pl->ob->enter_link;
1757 (async {
1758 # we need this sleep as the login has a concurrent enter_exit running
1759 # and this sleep increases chances of the player not ending up in scorn
1760 $pl->ob->reply (undef,
1761 "There was an internal problem at your last logout, "
1762 . "the server will try to bring you to your intended destination in a second.",
1763 cf::NDI_RED);
1764 Coro::Timer::sleep 1;
1765 $pl->ob->leave_link;
1766 })->prio (2);
1767 }
1768 },
1769);
1770
1771=item $player_object->goto ($path, $x, $y)
1772
1773=cut 2336=cut
2337
2338our $GOTOGEN;
1774 2339
1775sub cf::object::player::goto { 2340sub cf::object::player::goto {
1776 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;
1777 2345
1778 $self->enter_link; 2346 $self->enter_link;
1779 2347
1780 (async { 2348 (async {
2349 my $map = eval {
1781 my $map = cf::map::find $path; 2350 my $map = cf::map::find $path;
2351
2352 if ($map) {
1782 $map = $map->customise_for ($self) if $map; 2353 $map = $map->customise_for ($self);
1783 2354 $map = $check->($map) if $check && $map;
1784# warn "entering ", $map->path, " at ($x, $y)\n" 2355 } else {
1785# if $map;
1786
1787 $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 }
1788 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};
1789 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
2370 }
2371
2372 $done->() if $done;
1790 })->prio (1); 2373 })->prio (1);
1791} 2374}
1792 2375
1793=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1794 2377
1796 2379
1797sub parse_random_map_params { 2380sub parse_random_map_params {
1798 my ($spec) = @_; 2381 my ($spec) = @_;
1799 2382
1800 my $rmp = { # defaults 2383 my $rmp = { # defaults
1801 xsize => 10, 2384 xsize => (cf::rndm 15, 40),
1802 ysize => 10, 2385 ysize => (cf::rndm 15, 40),
2386 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2387 #layout => string,
1803 }; 2388 };
1804 2389
1805 for (split /\n/, $spec) { 2390 for (split /\n/, $spec) {
1806 my ($k, $v) = split /\s+/, $_, 2; 2391 my ($k, $v) = split /\s+/, $_, 2;
1807 2392
1811 $rmp 2396 $rmp
1812} 2397}
1813 2398
1814sub prepare_random_map { 2399sub prepare_random_map {
1815 my ($exit) = @_; 2400 my ($exit) = @_;
2401
2402 my $guard = cf::lock_acquire "exit_prepare:$exit";
1816 2403
1817 # all this does is basically replace the /! path by 2404 # all this does is basically replace the /! path by
1818 # a new random map path (?random/...) with a seed 2405 # a new random map path (?random/...) with a seed
1819 # that depends on the exit object 2406 # that depends on the exit object
1820 2407
1821 my $rmp = parse_random_map_params $exit->msg; 2408 my $rmp = parse_random_map_params $exit->msg;
1822 2409
1823 if ($exit->map) { 2410 if ($exit->map) {
1824 $rmp->{region} = $exit->map->region_name; 2411 $rmp->{region} = $exit->region->name;
1825 $rmp->{origin_map} = $exit->map->path; 2412 $rmp->{origin_map} = $exit->map->path;
1826 $rmp->{origin_x} = $exit->x; 2413 $rmp->{origin_x} = $exit->x;
1827 $rmp->{origin_y} = $exit->y; 2414 $rmp->{origin_y} = $exit->y;
1828 } 2415 }
1829 2416
1830 $rmp->{random_seed} ||= $exit->random_seed; 2417 $rmp->{random_seed} ||= $exit->random_seed;
1831 2418
1832 my $data = cf::to_json $rmp; 2419 my $data = cf::to_json $rmp;
1833 my $md5 = Digest::MD5::md5_hex $data; 2420 my $md5 = Digest::MD5::md5_hex $data;
2421 my $meta = "$RANDOMDIR/$md5.meta";
1834 2422
1835 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) {
1836 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;
1837 2427
1838 $exit->slaying ("?random/$md5"); 2428 $exit->slaying ("?random/$md5");
1839 $exit->msg (undef); 2429 $exit->msg (undef);
1840 } 2430 }
1841} 2431}
1843sub cf::object::player::enter_exit { 2433sub cf::object::player::enter_exit {
1844 my ($self, $exit) = @_; 2434 my ($self, $exit) = @_;
1845 2435
1846 return unless $self->type == cf::PLAYER; 2436 return unless $self->type == cf::PLAYER;
1847 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
1848 $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);
1849 2454
1850 (async { 2455 (async {
1851 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
1852 unless (eval { 2457 unless (eval {
1853 prepare_random_map $exit 2458 $self->goto ($slaying, $hp, $sp);
1854 if $exit->slaying eq "/!";
1855
1856 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1857 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1858 2459
1859 1; 2460 1;
1860 }) { 2461 }) {
1861 $self->message ("Something went wrong deep within the crossfire server. " 2462 $self->message ("Something went wrong deep within the crossfire server. "
1862 . "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. "
1863 . "Please report this to the dungeon master!", 2464 . "Please report this to the dungeon master!",
1864 cf::NDI_UNIQUE | cf::NDI_RED); 2465 cf::NDI_UNIQUE | cf::NDI_RED);
1865 2466
1866 warn "ERROR in enter_exit: $@"; 2467 warn "ERROR in enter_exit: $@";
1867 $self->leave_link; 2468 $self->leave_link;
1868 } 2469 }
1869 })->prio (1); 2470 })->prio (1);
1882 2483
1883sub cf::client::send_drawinfo { 2484sub cf::client::send_drawinfo {
1884 my ($self, $text, $flags) = @_; 2485 my ($self, $text, $flags) = @_;
1885 2486
1886 utf8::encode $text; 2487 utf8::encode $text;
1887 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1888} 2489}
1889 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}
1890 2557
1891=item $success = $client->query ($flags, "text", \&cb) 2558=item $success = $client->query ($flags, "text", \&cb)
1892 2559
1893Queues a query to the client, calling the given callback with 2560Queues a query to the client, calling the given callback with
1894the 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>,
1895C<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>.
1896 2563
1897Queries 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
1898reliable at some point in the future. 2565become reliable at some point in the future.
1899 2566
1900=cut 2567=cut
1901 2568
1902sub cf::client::query { 2569sub cf::client::query {
1903 my ($self, $flags, $text, $cb) = @_; 2570 my ($self, $flags, $text, $cb) = @_;
1911 utf8::encode $text; 2578 utf8::encode $text;
1912 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2579 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1913 2580
1914 $self->send_packet ($self->{query_queue}[0][0]) 2581 $self->send_packet ($self->{query_queue}[0][0])
1915 if @{ $self->{query_queue} } == 1; 2582 if @{ $self->{query_queue} } == 1;
2583
2584 1
1916} 2585}
1917 2586
1918cf::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 },
1919 on_reply => sub { 2593 on_reply => sub {
1920 my ($ns, $msg) = @_; 2594 my ($ns, $msg) = @_;
1921 2595
1922 # this weird shuffling is so that direct followup queries 2596 # this weird shuffling is so that direct followup queries
1923 # get handled first 2597 # get handled first
1924 my $queue = delete $ns->{query_queue} 2598 my $queue = delete $ns->{query_queue}
1925 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
1926 2600
1927 (shift @$queue)->[1]->($msg); 2601 (shift @$queue)->[1]->($msg);
2602 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1928 2603
1929 push @{ $ns->{query_queue} }, @$queue; 2604 push @{ $ns->{query_queue} }, @$queue;
1930 2605
1931 if (@{ $ns->{query_queue} } == @$queue) { 2606 if (@{ $ns->{query_queue} } == @$queue) {
1932 if (@$queue) { 2607 if (@$queue) {
1934 } else { 2609 } else {
1935 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2610 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1936 } 2611 }
1937 } 2612 }
1938 }, 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 },
1939); 2632);
1940 2633
1941=item $client->async (\&cb) 2634=item $client->async (\&cb)
1942 2635
1943Create a new coroutine, running the specified callback. The coroutine will 2636Create a new coroutine, running the specified callback. The coroutine will
1990 2683
1991# here we export the classes and methods available to script code 2684# here we export the classes and methods available to script code
1992 2685
1993=pod 2686=pod
1994 2687
1995The following fucntions and emthods are available within a safe environment: 2688The following functions and methods are available within a safe environment:
1996 2689
1997 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
1998 cf::object::player player 2694 cf::object::player
1999 cf::player peaceful 2695 player
2000 cf::map trigger 2696
2697 cf::player
2698 peaceful
2699
2700 cf::map
2701 trigger
2001 2702
2002=cut 2703=cut
2003 2704
2004for ( 2705for (
2005 ["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)],
2006 ["cf::object::player" => qw(player)], 2708 ["cf::object::player" => qw(player)],
2007 ["cf::player" => qw(peaceful)], 2709 ["cf::player" => qw(peaceful)],
2008 ["cf::map" => qw(trigger)], 2710 ["cf::map" => qw(trigger)],
2009) { 2711) {
2010 no strict 'refs'; 2712 no strict 'refs';
2081=back 2783=back
2082 2784
2083=cut 2785=cut
2084 2786
2085############################################################################# 2787#############################################################################
2788# the server's init and main functions
2086 2789
2087=head2 EXTENSION DATABASE SUPPORT 2790sub load_facedata($) {
2791 my ($path) = @_;
2088 2792
2089Crossfire maintains a very simple database for extension use. It can 2793 warn "loading facedata from $path\n";
2090currently store anything that can be serialised using Storable, which
2091excludes objects.
2092 2794
2093The parameter C<$family> should best start with the name of the extension 2795 my $facedata;
2094using it, it should be unique. 2796 0 < aio_load $path, $facedata
2797 or die "$path: $!";
2095 2798
2096=over 4 2799 $facedata = Coro::Storable::thaw $facedata;
2097 2800
2098=item $hashref = cf::db_get $family 2801 $facedata->{version} == 2
2802 or cf::cleanup "$path: version mismatch, cannot proceed.";
2099 2803
2100Return a hashref for use by the extension C<$family>, which can be
2101modified. After modifications, you have to call C<cf::db_dirty> or
2102C<cf::db_sync>.
2103
2104=item $value = cf::db_get $family => $key
2105
2106Returns a single value from the database
2107
2108=item cf::db_put $family => $hashref
2109
2110Stores the given family hashref into the database. Updates are delayed, if
2111you want the data to be synced to disk immediately, use C<cf::db_sync>.
2112
2113=item cf::db_put $family => $key => $value
2114
2115Stores the given C<$value> in the family hash. Updates are delayed, if you
2116want the data to be synced to disk immediately, use C<cf::db_sync>.
2117
2118=item cf::db_dirty
2119
2120Marks the database as dirty, to be updated at a later time.
2121
2122=item cf::db_sync
2123
2124Immediately write the database to disk I<if it is dirty>.
2125
2126=cut
2127
2128our $DB;
2129
2130{
2131 my $path = cf::localdir . "/database.pst";
2132
2133 sub db_load() {
2134 $DB = stat $path ? Storable::retrieve $path : { };
2135 } 2804 {
2805 my $faces = $facedata->{faceinfo};
2136 2806
2137 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};
2138 2813
2139 sub db_save() { 2814 cf::cede_to_tick;
2140 waitpid $pid, 0 if $pid;
2141 if (0 == ($pid = fork)) {
2142 $DB->{_meta}{version} = 1;
2143 Storable::nstore $DB, "$path~";
2144 rename "$path~", $path;
2145 cf::_exit 0 if defined $pid;
2146 }
2147 }
2148
2149 my $dirty;
2150
2151 sub db_sync() {
2152 db_save if $dirty;
2153 undef $dirty;
2154 }
2155
2156 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2157 db_sync;
2158 });
2159
2160 sub db_dirty() {
2161 $dirty = 1;
2162 $idle->start;
2163 }
2164
2165 sub db_get($;$) {
2166 @_ >= 2
2167 ? $DB->{$_[0]}{$_[1]}
2168 : ($DB->{$_[0]} ||= { })
2169 }
2170
2171 sub db_put($$;$) {
2172 if (@_ >= 3) {
2173 $DB->{$_[0]}{$_[1]} = $_[2];
2174 } else {
2175 $DB->{$_[0]} = $_[1];
2176 }
2177 db_dirty;
2178 }
2179
2180 cf::global->attach (
2181 prio => 10000,
2182 on_cleanup => sub {
2183 db_sync;
2184 }, 2815 }
2185 );
2186}
2187 2816
2188############################################################################# 2817 while (my ($face, $info) = each %$faces) {
2189# 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}
2190 2921
2191sub cfg_load { 2922sub cfg_load {
2192 open my $fh, "<:utf8", cf::confdir . "/config" 2923 open my $fh, "<:utf8", "$CONFDIR/config"
2193 or return; 2924 or return;
2194 2925
2195 local $/; 2926 local $/;
2196 *CFG = YAML::Syck::Load <$fh>; 2927 *CFG = YAML::Syck::Load <$fh>;
2197 2928
2211 2942
2212sub main { 2943sub main {
2213 # we must not ever block the main coroutine 2944 # we must not ever block the main coroutine
2214 local $Coro::idle = sub { 2945 local $Coro::idle = sub {
2215 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 {
2216 async { Event::one_event }; 2948 Event::one_event;
2949 })->prio (Coro::PRIO_MAX);
2217 }; 2950 };
2218 2951
2219 cfg_load; 2952 cfg_load;
2220 db_load; 2953 db_init;
2221 load_extensions; 2954 load_extensions;
2955
2956 $TICK_WATCHER->start;
2222 Event::loop; 2957 Event::loop;
2223} 2958}
2224 2959
2225############################################################################# 2960#############################################################################
2226# initialisation and cleanup 2961# initialisation and cleanup
2227 2962
2228# install some emergency cleanup handlers 2963# install some emergency cleanup handlers
2229BEGIN { 2964BEGIN {
2230 for my $signal (qw(INT HUP TERM)) { 2965 for my $signal (qw(INT HUP TERM)) {
2231 Event->signal ( 2966 Event->signal (
2967 reentrant => 0,
2232 data => WF_AUTOCANCEL, 2968 data => WF_AUTOCANCEL,
2233 signal => $signal, 2969 signal => $signal,
2970 prio => 0,
2234 cb => sub { 2971 cb => sub {
2235 cf::cleanup "SIG$signal"; 2972 cf::cleanup "SIG$signal";
2236 }, 2973 },
2237 ); 2974 );
2238 } 2975 }
2976}
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
2239} 3014}
2240 3015
2241sub emergency_save() { 3016sub emergency_save() {
2242 my $freeze_guard = cf::freeze_mainloop; 3017 my $freeze_guard = cf::freeze_mainloop;
2243 3018
2260 my $map = $cf::MAP{$path} or next; 3035 my $map = $cf::MAP{$path} or next;
2261 $map->valid or next; 3036 $map->valid or next;
2262 $map->save; 3037 $map->save;
2263 } 3038 }
2264 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";
2265 }; 3044 };
2266 3045
2267 warn "leave emergency perl save\n"; 3046 warn "leave emergency perl save\n";
2268} 3047}
2269 3048
3049sub post_cleanup {
3050 my ($make_core) = @_;
3051
3052 warn Carp::longmess "post_cleanup backtrace"
3053 if $make_core;
3054}
3055
2270sub reload() { 3056sub do_reload_perl() {
2271 # can/must only be called in main 3057 # can/must only be called in main
2272 if ($Coro::current != $Coro::main) { 3058 if ($Coro::current != $Coro::main) {
2273 warn "can only reload from main coroutine\n"; 3059 warn "can only reload from main coroutine";
2274 return; 3060 return;
2275 } 3061 }
2276 3062
2277 warn "reloading..."; 3063 warn "reloading...";
2278 3064
2279 warn "freezing server"; 3065 warn "entering sync_job";
2280 my $guard = freeze_mainloop; 3066
3067 cf::sync_job {
3068 cf::write_runtime; # external watchdog should not bark
2281 cf::emergency_save; 3069 cf::emergency_save;
3070 cf::write_runtime; # external watchdog should not bark
2282 3071
2283 warn "sync database to disk"; 3072 warn "syncing database to disk";
2284 cf::db_sync; 3073 BDB::db_env_txn_checkpoint $DB_ENV;
2285 IO::AIO::flush;
2286 3074
2287 eval {
2288 # 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
2289 3076
2290 warn "cancel all watchers"; 3077 warn "cancelling all WF_AUTOCANCEL watchers";
2291 for (Event::all_watchers) { 3078 for (Event::all_watchers) {
2292 $_->cancel if $_->data & WF_AUTOCANCEL; 3079 $_->cancel if $_->data & WF_AUTOCANCEL;
2293 } 3080 }
2294 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
2295 warn "cancel all extension coros"; 3093 warn "cancelling all extension coros";
2296 $_->cancel for values %EXT_CORO; 3094 $_->cancel for values %EXT_CORO;
2297 %EXT_CORO = (); 3095 %EXT_CORO = ();
2298 3096
2299 warn "remove commands"; 3097 warn "removing commands";
2300 %COMMAND = (); 3098 %COMMAND = ();
2301 3099
2302 warn "remove ext commands"; 3100 warn "removing ext/exti commands";
2303 %EXTCMD = (); 3101 %EXTCMD = ();
3102 %EXTICMD = ();
2304 3103
2305 warn "unload/nuke all extensions"; 3104 warn "unloading/nuking all extensions";
2306 for my $pkg (@EXTS) { 3105 for my $pkg (@EXTS) {
2307 warn "... unloading $pkg"; 3106 warn "... unloading $pkg";
2308 3107
2309 if (my $cb = $pkg->can ("unload")) { 3108 if (my $cb = $pkg->can ("unload")) {
2310 eval { 3109 eval {
2315 3114
2316 warn "... nuking $pkg"; 3115 warn "... nuking $pkg";
2317 Symbol::delete_package $pkg; 3116 Symbol::delete_package $pkg;
2318 } 3117 }
2319 3118
2320 warn "unload all perl modules loaded from $LIBDIR"; 3119 warn "unloading all perl modules loaded from $LIBDIR";
2321 while (my ($k, $v) = each %INC) { 3120 while (my ($k, $v) = each %INC) {
2322 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3121 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2323 3122
2324 warn "removing <$k>"; 3123 warn "... unloading $k";
2325 delete $INC{$k}; 3124 delete $INC{$k};
2326 3125
2327 $k =~ s/\.pm$//; 3126 $k =~ s/\.pm$//;
2328 $k =~ s/\//::/g; 3127 $k =~ s/\//::/g;
2329 3128
2332 } 3131 }
2333 3132
2334 Symbol::delete_package $k; 3133 Symbol::delete_package $k;
2335 } 3134 }
2336 3135
2337 warn "get rid of safe::, as good as possible"; 3136 warn "getting rid of safe::, as good as possible";
2338 Symbol::delete_package "safe::$_" 3137 Symbol::delete_package "safe::$_"
2339 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);
2340 3139
2341 warn "unload cf.pm \"a bit\""; 3140 warn "unloading cf.pm \"a bit\"";
2342 delete $INC{"cf.pm"}; 3141 delete $INC{"cf.pm"};
3142 delete $INC{"cf/pod.pm"};
2343 3143
2344 # don't, removes xs symbols, too, 3144 # don't, removes xs symbols, too,
2345 # and global variables created in xs 3145 # and global variables created in xs
2346 #Symbol::delete_package __PACKAGE__; 3146 #Symbol::delete_package __PACKAGE__;
2347 3147
3148 warn "unload completed, starting to reload now";
3149
2348 warn "reloading cf.pm"; 3150 warn "reloading cf.pm";
2349 require cf; 3151 require cf;
2350 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3152 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2351 3153
2352 warn "load config and database again"; 3154 warn "loading config and database again";
2353 cf::cfg_load; 3155 cf::cfg_load;
2354 cf::db_load;
2355 3156
2356 warn "load extensions"; 3157 warn "loading extensions";
2357 cf::load_extensions; 3158 cf::load_extensions;
2358 3159
2359 warn "reattach attachments to objects/players"; 3160 warn "reattaching attachments to objects/players";
2360 _global_reattach; 3161 _global_reattach; # objects, sockets
2361 warn "reattach attachments to maps"; 3162 warn "reattaching attachments to maps";
2362 reattach $_ for values %MAP; 3163 reattach $_ for values %MAP;
2363 }; 3164 warn "reattaching attachments to players";
3165 reattach $_ for values %PLAYER;
2364 3166
2365 if ($@) { 3167 warn "leaving sync_job";
3168
3169 1
3170 } or do {
2366 warn $@; 3171 warn $@;
2367 warn "error while reloading, exiting."; 3172 warn "error while reloading, exiting.";
2368 exit 1; 3173 exit 1;
2369 } 3174 };
2370 3175
2371 warn "reloaded"; 3176 warn "reloaded";
2372}; 3177};
2373 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
2374register_command "reload" => sub { 3196register_command "reload" => sub {
2375 my ($who, $arg) = @_; 3197 my ($who, $arg) = @_;
2376 3198
2377 if ($who->flag (FLAG_WIZ)) { 3199 if ($who->flag (FLAG_WIZ)) {
2378 $who->message ("start of reload.");
2379 reload;
2380 $who->message ("end of reload."); 3200 $who->message ("reloading server.");
3201 async { reload_perl };
2381 } 3202 }
2382}; 3203};
2383 3204
2384unshift @INC, $LIBDIR; 3205unshift @INC, $LIBDIR;
2385 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;
2386$TICK_WATCHER = Event->timer ( 3232$TICK_WATCHER = Event->timer (
2387 reentrant => 0, 3233 reentrant => 0,
3234 parked => 1,
2388 prio => 0, 3235 prio => 0,
2389 at => $NEXT_TICK || $TICK, 3236 at => $NEXT_TICK || $TICK,
2390 data => WF_AUTOCANCEL, 3237 data => WF_AUTOCANCEL,
2391 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
2392 $NOW = Event::time; 3245 $NOW = $tick_start = Event::time;
2393 3246
2394 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
2395 $RUNTIME += $TICK; 3272 $RUNTIME += $TICK;
2396 $NEXT_TICK += $TICK; 3273 $NEXT_TICK += $TICK;
2397 3274
2398 $WAIT_FOR_TICK->broadcast; 3275 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2399 $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;
2400 3294
2401 # 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
2402 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3296 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2403 3297
2404 $TICK_WATCHER->at ($NEXT_TICK); 3298 $TICK_WATCHER->at ($NEXT_TICK);
2405 $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
2406 }, 3307 },
2407); 3308);
2408 3309
3310{
3311 BDB::max_poll_time $TICK * 0.1;
3312 $BDB_POLL_WATCHER = Event->io (
3313 reentrant => 0,
3314 fd => BDB::poll_fileno,
3315 poll => 'r',
3316 prio => 0,
3317 data => WF_AUTOCANCEL,
3318 cb => \&BDB::poll_cb,
3319 );
3320 BDB::min_parallel 8;
3321
3322 BDB::set_sync_prepare {
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 $@;
3356 };
3357 }
3358}
3359
3360{
3361 IO::AIO::min_parallel 8;
3362
3363 undef $Coro::AIO::WATCHER;
2409IO::AIO::max_poll_time $TICK * 0.2; 3364 IO::AIO::max_poll_time $TICK * 0.1;
2410
2411$AIO_POLL_WATCHER = Event->io ( 3365 $AIO_POLL_WATCHER = Event->io (
2412 fd => IO::AIO::poll_fileno, 3366 reentrant => 0,
2413 poll => 'r',
2414 prio => 5,
2415 data => WF_AUTOCANCEL,
2416 cb => \&IO::AIO::poll_cb,
2417);
2418
2419$WRITE_RUNTIME_WATCHER = Event->timer (
2420 data => WF_AUTOCANCEL, 3367 data => WF_AUTOCANCEL,
2421 after => 0, 3368 fd => IO::AIO::poll_fileno,
2422 interval => 10, 3369 poll => 'r',
2423 cb => sub { 3370 prio => 6,
2424 (Coro::unblock_sub { 3371 cb => \&IO::AIO::poll_cb,
2425 write_runtime 3372 );
2426 or warn "ERROR: unable to write runtime file: $!"; 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;
2427 })->(); 3406 };
3407 } else {
3408 LOG llevInfo, "[ABT] $msg\n";
3409 LOG llevInfo, "[ABT] [suppressed]\n";
2428 }, 3410 }
2429); 3411}
3412
3413# load additional modules
3414use cf::pod;
2430 3415
2431END { cf::emergency_save } 3416END { cf::emergency_save }
2432 3417
24331 34181
2434 3419

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines