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.167 by root, Sat Jan 13 23:32:43 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines