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.183 by root, Fri Jan 19 19:42:37 2007 UTC vs.
Revision 1.321 by root, Thu Jul 26 21:44:43 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.4 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use JSON::XS 1.4 ();
26use BDB ();
20use Data::Dumper; 27use Data::Dumper;
21use Digest::MD5; 28use Digest::MD5;
22use Fcntl; 29use Fcntl;
30use YAML::Syck ();
23use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
26 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
41
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 43
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
33 46
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
36our %COMMAND = (); 51our %COMMAND = ();
37our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
38 53
39our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
43 59
60our $RELOAD; # number of reloads so far
44our @EVENT; 61our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 62
47our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48our $TICK_WATCHER; 76our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 79our $NEXT_TICK;
52our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
53 85
54our %CFG; 86our %CFG;
55 87
56our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 89our $RUNTIME;
58 90
59our %PLAYER; # all users 91our %PLAYER; # all users
60our %MAP; # all maps 92our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 94
67# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
70binmode STDOUT; 102binmode STDOUT;
71binmode STDERR; 103binmode STDERR;
72 104
73# read virtual server time, if available 105# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
78} 110}
79 111
80mkdir cf::localdir; 112mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 114
86our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
87 118
88############################################################################# 119#############################################################################
89 120
90=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
91 122
98=item $cf::RUNTIME 129=item $cf::RUNTIME
99 130
100The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
101every server tick. 132every server tick.
102 133
103=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104 137
105The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
106be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
107 142
108=item $cf::NOW 143=item $cf::NOW
109 144
110The time of the last (current) server tick. 145The time of the last (current) server tick.
111 146
112=item $cf::TICK 147=item $cf::TICK
113 148
114The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
115 160
116=item %cf::CFG 161=item %cf::CFG
117 162
118Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
119from wherever your confdir points to. 164from wherever your confdir points to.
120 165
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
122 167
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
125processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
127 177
128=back 178=back
129 179
130=cut 180=cut
131 181
132BEGIN { 182BEGIN {
133 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 184 my $msg = join "", @_;
135 utf8::encode $msg;
136 185
137 $msg .= "\n" 186 $msg .= "\n"
138 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
139 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
140 LOG llevError, $msg; 192 LOG llevError, $msg;
141 }; 193 };
142} 194}
143 195
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150 203
151# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
152# within the Safe compartment. 205# within the Safe compartment.
153for my $pkg (qw( 206for my $pkg (qw(
154 cf::global cf::attachable 207 cf::global cf::attachable
162} 215}
163 216
164$Event::DIED = sub { 217$Event::DIED = sub {
165 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
166}; 219};
220
221#############################################################################
167 222
168=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
169 224
170=over 4 225=over 4
171 226
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d 246 $d
192 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
193} 248}
194 249
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
198 251
199Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
200 253
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
209 255
210Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
211 257
212=cut 258=cut
213 259
214sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
216 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
217} 263sub from_json ($) { $json_coder->decode ($_[0]) }
218 264
219=item cf::lock_wait $string 265=item cf::lock_wait $string
220 266
221Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
222 268
228returned. 274returned.
229 275
230Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
231uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
232 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
233=cut 283=cut
234 284
235our %LOCK; 285our %LOCK;
236 286
237sub lock_wait($) { 287sub lock_wait($) {
256 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
258 } 308 }
259} 309}
260 310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
261sub freeze_mainloop { 317sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
263 319
264 my $guard = Coro::guard { 320 my $guard = Coro::guard {
265 $TICK_WATCHER->start; 321 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 }; 322 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
270 $guard 324 $guard
325}
326
327=item cf::get_slot $time[, $priority[, $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;
271} 381}
272 382
273=item cf::async { BLOCK } 383=item cf::async { BLOCK }
274 384
275Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
280 390
281BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
282 392
283=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
284 394
285The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
288 399
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 403fast or be very important.
295 406
296sub sync_job(&) { 407sub sync_job(&) {
297 my ($job) = @_; 408 my ($job) = @_;
298 409
299 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
300 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
302 415
303 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 417 # (but this is cancel-safe)
315 428
316 while ($busy) { 429 while ($busy) {
317 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
318 } 431 }
319 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
320 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
321 } else { 441 } else {
322 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
323 443
324 $job->() 444 $job->()
343 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
344 464
345 $coro 465 $coro
346} 466}
347 467
348sub write_runtime { 468=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 469
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
352 or return; 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.
353 474
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 475=cut
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357 476
358 aio_fsync $fh 477sub _store_scalar {
359 and return; 478 open my $fh, ">", \my $buf
360 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
361 close $fh 481 close $fh;
362 or return;
363 482
364 aio_rename "$runtime~", $runtime 483 $buf
365 and return; 484}
366 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;
367 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 });
368} 655}
369 656
370=back 657=back
371 658
372=cut 659=cut
379attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
380to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
381 668
382In 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>
383C<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
384crossfire+). 671Crossfire TRT).
385 672
386=over 4 673=over 4
387 674
388=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
389 676
552 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
553 840
554 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
555 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
556 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
557 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558 845
559 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
560 my $pkg = shift @arg; 847 my $pkg = shift @arg;
561 848
562 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
591 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
592 } 879 }
593 880
594 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
595 } else { 882 } else {
596 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
597 } 884 }
598 885
599 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
600} 887}
601 888
603 if (ref $_[0]) { 890 if (ref $_[0]) {
604 _object_attach @_; 891 _object_attach @_;
605 } else { 892 } else {
606 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
607 } 894 }
895 _recalc_want;
608}; 896};
609 897
610# all those should be optimised 898# all those should be optimised
611sub cf::attachable::detach { 899sub cf::attachable::detach {
612 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
615 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
616 reattach ($obj); 904 reattach ($obj);
617 } else { 905 } else {
618 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
619 } 907 }
908 _recalc_want;
620}; 909};
621 910
622sub cf::attachable::attached { 911sub cf::attachable::attached {
623 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
624 913
639 "; 928 ";
640 die if $@; 929 die if $@;
641} 930}
642 931
643our $override; 932our $override;
644our @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?
645 934
646sub override { 935sub override {
647 $override = 1; 936 $override = 1;
648 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
649} 938}
650 939
651sub do_invoke { 940sub do_invoke {
652 my $event = shift; 941 my $event = shift;
653 my $callbacks = shift; 942 my $callbacks = shift;
654 943
655 @invoke_results = (); 944 @INVOKE_RESULTS = ();
656 945
657 local $override; 946 local $override;
658 947
659 for (@$callbacks) { 948 for (@$callbacks) {
660 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
677 966
678Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
679 968
680This 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
681removed 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
682results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683 972
684=back 973=back
685 974
686=cut 975=cut
687 976
688############################################################################# 977#############################################################################
689# 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}
690 990
691sub reattach { 991sub reattach {
692 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
693 my ($obj) = @_; 993 my ($obj) = @_;
694 994
747 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
748 1048
749 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
751 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
753 close $fh; 1053 close $fh;
754 1054
755 if (@$objs) { 1055 if (@$objs) {
756 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) {
757 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
758 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
759 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
760 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
761 close $fh; 1061 close $fh;
762 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
763 } 1063 }
764 } else { 1064 } else {
765 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
797 or return; 1097 or return;
798 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
799 } 1099 }
800 1100
801 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
802 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
803 return ($data, $av); 1103 return ($data, $av);
804} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
805 1111
806############################################################################# 1112#############################################################################
807# command handling &c 1113# command handling &c
808 1114
809=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
822 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
823} 1129}
824 1130
825=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
826 1132
827Register 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.
828 1138
829If 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
830called. 1140called.
831 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
832=cut 1153=cut
833 1154
834sub register_extcmd { 1155sub register_extcmd {
835 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
836 1157
837 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
838} 1165}
839 1166
840cf::player->attach ( 1167cf::player->attach (
841 on_command => sub { 1168 on_command => sub {
842 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
851 cf::override; 1178 cf::override;
852 }, 1179 },
853 on_extcmd => sub { 1180 on_extcmd => sub {
854 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
855 1182
856 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857 1184
858 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
859 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
860 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
861 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
862 } 1195 if $reply;
863 } 1196 }
864 } else { 1197 } else {
865 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
866 } 1199 }
867 1200
868 cf::override; 1201 cf::override;
869 }, 1202 },
870); 1203);
871 1204
872sub load_extension {
873 my ($path) = @_;
874
875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
876 my $base = $1;
877 my $pkg = $1;
878 $pkg =~ s/[^[:word:]]/_/g;
879 $pkg = "ext::$pkg";
880
881 warn "... loading '$path' into '$pkg'\n";
882
883 open my $fh, "<:utf8", $path
884 or die "$path: $!";
885
886 my $source =
887 "package $pkg; use strict; use utf8;\n"
888 . "#line 1 \"$path\"\n{\n"
889 . (do { local $/; <$fh> })
890 . "\n};\n1";
891
892 unless (eval $source) {
893 my $msg = $@ ? "$path: $@\n"
894 : "extension disabled.\n";
895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896 warn $@;
897 warn "mandatory extension failed to load, exiting.\n";
898 exit 1;
899 }
900 die $@;
901 }
902
903 push @EXTS, $pkg;
904}
905
906sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
907 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
908 next unless -r $ext; 1210 next unless -r $path;
909 eval { 1211
910 load_extension $ext; 1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
911 1 1269 }
912 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
913 } 1275 };
914} 1276}
915 1277
916############################################################################# 1278#############################################################################
917 1279
1280=back
1281
918=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
919 1283
920Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
921 1285
922=cut 1286=cut
934Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
935 1299
936=cut 1300=cut
937 1301
938sub playerdir($) { 1302sub playerdir($) {
939 cf::localdir 1303 "$PLAYERDIR/"
940 . "/"
941 . cf::playerdir
942 . "/"
943 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
944} 1305}
945 1306
946sub path($) { 1307sub path($) {
947 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948 1309
949 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
950} 1311}
951 1312
952sub find_active($) { 1313sub find_active($) {
953 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
954 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
967 my $login = $_[0]; 1328 my $login = $_[0];
968 1329
969 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
970 1331
971 $cf::PLAYER{$_[0]} || do { 1332 $cf::PLAYER{$_[0]} || do {
1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
972 my $pl = load_pl path $login 1340 my $pl = load_pl path $login
973 or return; 1341 or return;
974 $cf::PLAYER{$login} = $pl 1342 $cf::PLAYER{$login} = $pl
975 } 1343 }
976 } 1344 }
1013 1381
1014=cut 1382=cut
1015 1383
1016sub quit_character { 1384sub quit_character {
1017 my ($pl) = @_; 1385 my ($pl) = @_;
1386
1387 my $name = $pl->ob->name;
1018 1388
1019 $pl->{deny_save} = 1; 1389 $pl->{deny_save} = 1;
1020 $pl->password ("*"); # this should lock out the player until we nuked the dir 1390 $pl->password ("*"); # this should lock out the player until we nuked the dir
1021 1391
1022 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1392 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1027 my $path = playerdir $pl; 1397 my $path = playerdir $pl;
1028 my $temp = "$path~$cf::RUNTIME~deleting~"; 1398 my $temp = "$path~$cf::RUNTIME~deleting~";
1029 aio_rename $path, $temp; 1399 aio_rename $path, $temp;
1030 delete $cf::PLAYER{$pl->ob->name}; 1400 delete $cf::PLAYER{$pl->ob->name};
1031 $pl->destroy; 1401 $pl->destroy;
1402
1403 my $prefix = qr<^~\Q$name\E/>;
1404
1405 # nuke player maps
1406 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1407
1032 IO::AIO::aio_rmtree $temp; 1408 IO::AIO::aio_rmtree $temp;
1409}
1410
1411=item $pl->kick
1412
1413Kicks a player out of the game. This destroys the connection.
1414
1415=cut
1416
1417sub kick {
1418 my ($pl, $kicker) = @_;
1419
1420 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1421 $pl->killer ("kicked");
1422 $pl->ns->destroy;
1033} 1423}
1034 1424
1035=item cf::player::list_logins 1425=item cf::player::list_logins
1036 1426
1037Returns am arrayref of all valid playernames in the system, can take a 1427Returns am arrayref of all valid playernames in the system, can take a
1038while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1039 1429
1040=cut 1430=cut
1041 1431
1042sub list_logins { 1432sub list_logins {
1043 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1044 or return []; 1434 or return [];
1045 1435
1046 my @logins; 1436 my @logins;
1047 1437
1048 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1065=cut 1455=cut
1066 1456
1067sub maps($) { 1457sub maps($) {
1068 my ($pl) = @_; 1458 my ($pl) = @_;
1069 1459
1460 $pl = ref $pl ? $pl->ob->name : $pl;
1461
1070 my $files = aio_readdir playerdir $pl 1462 my $files = aio_readdir playerdir $pl
1071 or return; 1463 or return;
1072 1464
1073 my @paths; 1465 my @paths;
1074 1466
1075 for (@$files) { 1467 for (@$files) {
1076 utf8::decode $_; 1468 utf8::decode $_;
1077 next if /\.(?:pl|pst)$/; 1469 next if /\.(?:pl|pst)$/;
1078 next unless /^$PATH_SEP/o; 1470 next unless /^$PATH_SEP/o;
1079 1471
1080 s/\.map$//; 1472 push @paths, cf::map::normalise "~$pl/$_";
1081 push @paths, "~" . $pl->ob->name . "/" . $_;
1082 } 1473 }
1083 1474
1084 \@paths 1475 \@paths
1085} 1476}
1086 1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1087=item $player->ext_reply ($msgid, $msgtype, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1088 1529
1089Sends an ext reply to the player. 1530Sends an ext reply to the player.
1090 1531
1091=cut 1532=cut
1092 1533
1093sub ext_reply($$$%) { 1534sub ext_reply($$@) {
1094 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1095 1536
1096 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1097 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1098 $self->send ("ext " . cf::to_json \%msg); 1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1099} 1544}
1100 1545
1101package cf; 1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1102 1586
1103=back 1587=back
1104
1105 1588
1106=head3 cf::map 1589=head3 cf::map
1107 1590
1108=over 4 1591=over 4
1109 1592
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1620 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (cf::region::find $rmp->{region}), $rmp->{custom} 1621 (cf::region::find $rmp->{region}), $rmp->{custom}
1139 ) 1622 )
1140} 1623}
1141 1624
1625=item cf::map->register ($regex, $prio)
1626
1627Register a handler for the map path matching the given regex at the
1628givne priority (higher is better, built-in handlers have priority 0, the
1629default).
1630
1631=cut
1632
1142sub register { 1633sub register {
1143 my (undef, $regex) = @_; 1634 my (undef, $regex, $prio) = @_;
1144 my $pkg = caller; 1635 my $pkg = caller;
1145 1636
1146 no strict; 1637 no strict;
1147 push @{"$pkg\::ISA"}, __PACKAGE__; 1638 push @{"$pkg\::ISA"}, __PACKAGE__;
1148 1639
1149 $EXT_MAP{$pkg} = qr<$regex>; 1640 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150} 1641}
1151 1642
1152# also paths starting with '/' 1643# also paths starting with '/'
1153$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1644$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154 1645
1155sub thawer_merge { 1646sub thawer_merge {
1156 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1157 1648
1158 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1159 local $self->{path}; 1650 local $self->{path};
1160 local $self->{load_path}; 1651 local $self->{load_path};
1161 local $self->{deny_save};
1162 local $self->{deny_reset};
1163 1652
1164 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1165} 1654}
1166 1655
1167sub normalise { 1656sub normalise {
1168 my ($path, $base) = @_; 1657 my ($path, $base) = @_;
1658
1659 $path = "$path"; # make sure its a string
1660
1661 $path =~ s/\.map$//;
1169 1662
1170 # map plan: 1663 # map plan:
1171 # 1664 #
1172 # /! non-realised random map exit (special hack!) 1665 # /! non-realised random map exit (special hack!)
1173 # {... are special paths that are not being touched 1666 # {... are special paths that are not being touched
1201 1694
1202 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object 1695 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203 1696
1204 $path = normalise $path, $base; 1697 $path = normalise $path, $base;
1205 1698
1206 for my $pkg (keys %EXT_MAP) { 1699 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207 if ($path =~ $EXT_MAP{$pkg}) { 1700 if ($path =~ $EXT_MAP{$pkg}[1]) {
1208 my $self = bless cf::map::new, $pkg; 1701 my $self = bless cf::map::new, $pkg;
1209 $self->{path} = $path; $self->path ($path); 1702 $self->{path} = $path; $self->path ($path);
1210 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1211 return $self; 1704 return $self;
1212 } 1705 }
1213 } 1706 }
1214 1707
1215 Carp::carp "unable to resolve path '$path'."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1216 () 1709 ()
1217} 1710}
1218 1711
1219sub init { 1712sub init {
1220 my ($self) = @_; 1713 my ($self) = @_;
1235 1728
1236# the original (read-only) location 1729# the original (read-only) location
1237sub load_path { 1730sub load_path {
1238 my ($self) = @_; 1731 my ($self) = @_;
1239 1732
1240 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1241} 1734}
1242 1735
1243# the temporary/swap location 1736# the temporary/swap location
1244sub save_path { 1737sub save_path {
1245 my ($self) = @_; 1738 my ($self) = @_;
1246 1739
1247 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1249} 1742}
1250 1743
1251# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1252sub uniq_path { 1745sub uniq_path {
1253 my ($self) = @_; 1746 my ($self) = @_;
1254 1747
1255 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1257} 1750}
1258 1751
1259# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1260# all maps in C++... 1753# all maps in C++...
1261sub change_all_map_light { 1754sub change_all_map_light {
1263 1756
1264 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1265 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1266} 1759}
1267 1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1767}
1768
1268sub unlink_save { 1769sub unlink_save {
1269 my ($self) = @_; 1770 my ($self) = @_;
1270 1771
1271 utf8::encode (my $save = $self->save_path); 1772 utf8::encode (my $save = $self->save_path);
1272 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1773 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1275 1776
1276sub load_header_from($) { 1777sub load_header_from($) {
1277 my ($self, $path) = @_; 1778 my ($self, $path) = @_;
1278 1779
1279 utf8::encode $path; 1780 utf8::encode $path;
1280 aio_open $path, O_RDONLY, 0 1781 #aio_open $path, O_RDONLY, 0
1281 or return; 1782 # or return;
1282 1783
1283 $self->_load_header ($path) 1784 $self->_load_header ($path)
1284 or return; 1785 or return;
1285 1786
1286 $self->{load_path} = $path; 1787 $self->{load_path} = $path;
1287 1788
1288 1 1789 1
1289} 1790}
1290 1791
1291sub load_orig { 1792sub load_header_orig {
1292 my ($self) = @_; 1793 my ($self) = @_;
1293 1794
1294 $self->load_header_from ($self->load_path) 1795 $self->load_header_from ($self->load_path)
1295} 1796}
1296 1797
1297sub load_temp { 1798sub load_header_temp {
1298 my ($self) = @_; 1799 my ($self) = @_;
1299 1800
1300 $self->load_header_from ($self->save_path) 1801 $self->load_header_from ($self->save_path)
1802}
1803
1804sub prepare_temp {
1805 my ($self) = @_;
1806
1807 $self->last_access ((delete $self->{last_access})
1808 || $cf::RUNTIME); #d#
1809 # safety
1810 $self->{instantiate_time} = $cf::RUNTIME
1811 if $self->{instantiate_time} > $cf::RUNTIME;
1812}
1813
1814sub prepare_orig {
1815 my ($self) = @_;
1816
1817 $self->{load_original} = 1;
1818 $self->{instantiate_time} = $cf::RUNTIME;
1819 $self->last_access ($cf::RUNTIME);
1820 $self->instantiate;
1301} 1821}
1302 1822
1303sub load_header { 1823sub load_header {
1304 my ($self) = @_; 1824 my ($self) = @_;
1305 1825
1306 if ($self->load_temp) { 1826 if ($self->load_header_temp) {
1307 $self->last_access ((delete $self->{last_access}) 1827 $self->prepare_temp;
1308 || $cf::RUNTIME); #d#
1309 # safety
1310 $self->{instantiate_time} = $cf::RUNTIME
1311 if $self->{instantiate_time} > $cf::RUNTIME;
1312 } else { 1828 } else {
1313 $self->load_orig 1829 $self->load_header_orig
1314 or return; 1830 or return;
1315 1831 $self->prepare_orig;
1316 $self->{load_original} = 1;
1317 $self->{instantiate_time} = $cf::RUNTIME;
1318 $self->last_access ($cf::RUNTIME);
1319 $self->instantiate;
1320 } 1832 }
1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1321 1839
1322 1 1840 1
1323} 1841}
1324 1842
1325sub find; 1843sub find;
1338 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1339 1857
1340 $map->load_header 1858 $map->load_header
1341 or return; 1859 or return;
1342 1860
1343 if ($map->should_reset) { 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1862 # doing this can freeze the server in a sync job, obviously
1344 $cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1345 $map->reset; 1864 $map->reset;
1346 undef $guard; 1865 undef $guard;
1347 $map = find $path 1866 return find $path;
1348 or return;
1349 } 1867 }
1350 1868
1351 $cf::MAP{$path} = $map 1869 $cf::MAP{$path} = $map
1352 } 1870 }
1353} 1871}
1872
1873sub pre_load { }
1874sub post_load { }
1354 1875
1355sub load { 1876sub load {
1356 my ($self) = @_; 1877 my ($self) = @_;
1357 1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1358 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1359 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1360 1885
1361 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1362 1887
1363 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1364 1889
1365 $self->alloc; 1890 $self->alloc;
1366 $self->_load_objects ($self->{load_path}, 1)
1367 or return;
1368 1891
1369 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1892 $self->pre_load;
1370 if delete $self->{load_original};
1371
1372 if (my $uniq = $self->uniq_path) {
1373 utf8::encode $uniq;
1374 if (aio_open $uniq, O_RDONLY, 0) {
1375 $self->clear_unique_items;
1376 $self->_load_objects ($uniq, 0);
1377 }
1378 }
1379
1380 Coro::cede;
1381
1382 # now do the right thing for maps
1383 $self->link_multipart_objects;
1384
1385 unless ($self->{deny_activate}) {
1386 $self->decay_objects;
1387 $self->fix_auto_apply;
1388 $self->update_buttons;
1389 Coro::cede; 1893 Coro::cede;
1390 $self->set_darkness_map; 1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
1906 }
1907 }
1908
1909 Coro::cede;
1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1391 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1392 unless $self->difficulty; 1913 unless $self->difficulty;
1393 Coro::cede; 1914 Coro::cede;
1915
1916 unless ($self->{deny_activate}) {
1917 $self->decay_objects;
1918 $self->fix_auto_apply;
1919 $self->update_buttons;
1920 Coro::cede;
1921 $self->set_darkness_map;
1922 Coro::cede;
1394 $self->activate; 1923 $self->activate;
1395 } 1924 }
1396 1925
1397 $self->in_memory (cf::MAP_IN_MEMORY); 1926 $self->in_memory (cf::MAP_IN_MEMORY);
1927 }
1928
1929 $self->post_load;
1398} 1930}
1399 1931
1400sub customise_for { 1932sub customise_for {
1401 my ($self, $ob) = @_; 1933 my ($self, $ob) = @_;
1402 1934
1403 return find "~" . $ob->name . "/" . $self->{path} 1935 return find "~" . $ob->name . "/" . $self->{path}
1404 if $self->per_player; 1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1405 1940
1406 $self 1941 $self
1407} 1942}
1408 1943
1409# find and load all maps in the 3x3 area around a map 1944# find and load all maps in the 3x3 area around a map
1456 1991
1457 undef $MAP_PREFETCH{$path}; 1992 undef $MAP_PREFETCH{$path};
1458 $MAP_PREFETCHER ||= cf::async { 1993 $MAP_PREFETCHER ||= cf::async {
1459 while (%MAP_PREFETCH) { 1994 while (%MAP_PREFETCH) {
1460 for my $path (keys %MAP_PREFETCH) { 1995 for my $path (keys %MAP_PREFETCH) {
1461 warn "prefetching $path...\n";#d#
1462 my $map = find $path 1996 if (my $map = find $path) {
1463 or next;
1464 $map->load; 1997 $map->load;
1998 }
1465 1999
1466 delete $MAP_PREFETCH{$path}; 2000 delete $MAP_PREFETCH{$path};
1467 } 2001 }
1468 } 2002 }
1469 undef $MAP_PREFETCHER; 2003 undef $MAP_PREFETCHER;
1470 }; 2004 };
2005 $MAP_PREFETCHER->prio (6);
1471 2006
1472 () 2007 ()
1473} 2008}
1474 2009
1475sub save { 2010sub save {
1520 2055
1521sub reset_at { 2056sub reset_at {
1522 my ($self) = @_; 2057 my ($self) = @_;
1523 2058
1524 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1525 return 1e99 if $self->isa ("ext::map_per_player");#d#
1526 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1527 2061
1528 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1529 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1530 2064
1541 my ($self) = @_; 2075 my ($self) = @_;
1542 2076
1543 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1544 2078
1545 return if $self->players; 2079 return if $self->players;
1546 return if $self->isa ("ext::map_per_player");#d#
1547 2080
1548 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
2082
2083 $self->in_memory (cf::MAP_SWAPPED);
2084
2085 # need to save uniques path
2086 unless ($self->{deny_save}) {
2087 my $uniq = $self->uniq_path; utf8::encode $uniq;
2088
2089 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2090 if $uniq;
2091 }
1549 2092
1550 delete $cf::MAP{$self->path}; 2093 delete $cf::MAP{$self->path};
1551 2094
1552 $self->in_memory (cf::MAP_SWAPPED);
1553 $self->clear; 2095 $self->clear;
1554 2096
1555 $_->clear_links_to ($self) for values %cf::MAP; 2097 $_->clear_links_to ($self) for values %cf::MAP;
1556 2098
1557 $self->unlink_save; 2099 $self->unlink_save;
1576 $cf::MAP{$self->path} = $self; 2118 $cf::MAP{$self->path} = $self;
1577 2119
1578 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1579} 2121}
1580 2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
1581=item cf::map::unique_maps 2159=item cf::map::unique_maps
1582 2160
1583Returns an arrayref of paths of all shared maps that have 2161Returns an arrayref of paths of all shared maps that have
1584instantiated unique items. May block. 2162instantiated unique items. May block.
1585 2163
1586=cut 2164=cut
1587 2165
1588sub unique_maps() { 2166sub unique_maps() {
1589 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2167 [
1590 or return; 2168 map {
1591
1592 my @paths;
1593
1594 for (@$files) {
1595 utf8::decode $_; 2169 utf8::decode $_;
1596 next if /\.pst$/;
1597 next unless /^$PATH_SEP/o;
1598
1599 s/\.map$//; 2170 /\.map$/
1600 push @paths, $_; 2171 ? normalise $_
2172 : ()
2173 } @{ aio_readdir $UNIQUEDIR or [] }
1601 } 2174 ]
1602
1603 \@paths
1604} 2175}
1605 2176
1606package cf; 2177package cf;
1607 2178
1608=back 2179=back
1654 2225
1655 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1656 2227
1657 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1658 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1659 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1660 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1661 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1662 } 2242 }
1663} 2243}
1664 2244
1665=item $player_object->may ("access") 2245=item $player_object->may ("access")
1666 2246
1699=cut 2279=cut
1700 2280
1701sub link_map { 2281sub link_map {
1702 unless ($LINK_MAP) { 2282 unless ($LINK_MAP) {
1703 $LINK_MAP = cf::map::find "{link}" 2283 $LINK_MAP = cf::map::find "{link}"
1704 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2284 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1705 $LINK_MAP->load; 2285 $LINK_MAP->load;
1706 } 2286 }
1707 2287
1708 $LINK_MAP 2288 $LINK_MAP
1709} 2289}
1714 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1715 2295
1716 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1717 2297
1718 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1719 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1720 2300
1721 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1722} 2302}
1723 2303
1724sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1725 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1726 2308
1727 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1728 2310
1729 unless ($map) { 2311 unless ($map) {
1730 # restore original map position 2312 # restore original map position
1748 $map->load; 2330 $map->load;
1749 $map->load_diag; 2331 $map->load_diag;
1750 2332
1751 return unless $self->contr->active; 2333 return unless $self->contr->active;
1752 $self->activate_recursive; 2334 $self->activate_recursive;
2335
2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1753 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1754} 2338}
1755 2339
1756cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1757 on_logout => sub {
1758 my ($pl) = @_;
1759 2341
1760 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1761 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1762 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1763 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1764 }; 2346be called at the end of this process.
1765 }
1766 },
1767 on_login => sub {
1768 my ($pl) = @_;
1769 2347
1770 # try to abort aborted map switching on player login :)
1771 # should happen only on crashes
1772 if ($pl->ob->{_link_pos}) {
1773 $pl->ob->enter_link;
1774 (async {
1775 # we need this sleep as the login has a concurrent enter_exit running
1776 # and this sleep increases chances of the player not ending up in scorn
1777 $pl->ob->reply (undef,
1778 "There was an internal problem at your last logout, "
1779 . "the server will try to bring you to your intended destination in a second.",
1780 cf::NDI_RED);
1781 Coro::Timer::sleep 1;
1782 $pl->ob->leave_link;
1783 })->prio (2);
1784 }
1785 },
1786);
1787
1788=item $player_object->goto ($path, $x, $y)
1789
1790=cut 2348=cut
2349
2350our $GOTOGEN;
1791 2351
1792sub cf::object::player::goto { 2352sub cf::object::player::goto {
1793 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1794 2357
1795 $self->enter_link; 2358 $self->enter_link;
1796 2359
1797 (async { 2360 (async {
2361 my $map = eval {
1798 my $map = cf::map::find $path; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1799 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
1800 2366 $map = $check->($map) if $check && $map;
1801# warn "entering ", $map->path, " at ($x, $y)\n" 2367 } else {
1802# if $map;
1803
1804 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
1805 2370
2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
2377 }
2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1806 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1807 })->prio (1); 2385 })->prio (1);
1808} 2386}
1809 2387
1810=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1811 2389
1840 # that depends on the exit object 2418 # that depends on the exit object
1841 2419
1842 my $rmp = parse_random_map_params $exit->msg; 2420 my $rmp = parse_random_map_params $exit->msg;
1843 2421
1844 if ($exit->map) { 2422 if ($exit->map) {
1845 $rmp->{region} = $exit->map->region_name; 2423 $rmp->{region} = $exit->region->name;
1846 $rmp->{origin_map} = $exit->map->path; 2424 $rmp->{origin_map} = $exit->map->path;
1847 $rmp->{origin_x} = $exit->x; 2425 $rmp->{origin_x} = $exit->x;
1848 $rmp->{origin_y} = $exit->y; 2426 $rmp->{origin_y} = $exit->y;
1849 } 2427 }
1850 2428
1851 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1852 2430
1853 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1854 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
1855 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2433 my $meta = "$RANDOMDIR/$md5.meta";
1856 2434
1857 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1858 aio_write $fh, 0, (length $data), $data, 0; 2436 aio_write $fh, 0, (length $data), $data, 0;
1859 undef $fh; 2437 undef $fh;
1860 aio_rename "$meta~", $meta; 2438 aio_rename "$meta~", $meta;
1867sub cf::object::player::enter_exit { 2445sub cf::object::player::enter_exit {
1868 my ($self, $exit) = @_; 2446 my ($self, $exit) = @_;
1869 2447
1870 return unless $self->type == cf::PLAYER; 2448 return unless $self->type == cf::PLAYER;
1871 2449
2450 if ($exit->slaying eq "/!") {
2451 #TODO: this should de-fi-ni-te-ly not be a sync-job
2452 # the problem is that $exit might not survive long enough
2453 # so it needs to be done right now, right here
2454 cf::sync_job { prepare_random_map $exit };
2455 }
2456
2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2458 my $hp = $exit->stats->hp;
2459 my $sp = $exit->stats->sp;
2460
1872 $self->enter_link; 2461 $self->enter_link;
2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
1873 2466
1874 (async { 2467 (async {
1875 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1876 unless (eval { 2469 unless (eval {
1877 prepare_random_map $exit 2470 $self->goto ($slaying, $hp, $sp);
1878 if $exit->slaying eq "/!";
1879
1880 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1881 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1882 2471
1883 1; 2472 1;
1884 }) { 2473 }) {
1885 $self->message ("Something went wrong deep within the crossfire server. " 2474 $self->message ("Something went wrong deep within the crossfire server. "
1886 . "I'll try to bring you back to the map you were before. " 2475 . "I'll try to bring you back to the map you were before. "
1887 . "Please report this to the dungeon master!", 2476 . "Please report this to the dungeon master!",
1888 cf::NDI_UNIQUE | cf::NDI_RED); 2477 cf::NDI_UNIQUE | cf::NDI_RED);
1889 2478
1890 warn "ERROR in enter_exit: $@"; 2479 warn "ERROR in enter_exit: $@";
1891 $self->leave_link; 2480 $self->leave_link;
1892 } 2481 }
1893 })->prio (1); 2482 })->prio (1);
1906 2495
1907sub cf::client::send_drawinfo { 2496sub cf::client::send_drawinfo {
1908 my ($self, $text, $flags) = @_; 2497 my ($self, $text, $flags) = @_;
1909 2498
1910 utf8::encode $text; 2499 utf8::encode $text;
1911 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1912} 2501}
1913 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => $channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2569 push @msg, msgtype => "event_$type";
2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2572}
1914 2573
1915=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
1916 2575
1917Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
1918the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1919C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1920 2579
1921Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
1922reliable at some point in the future. 2581become reliable at some point in the future.
1923 2582
1924=cut 2583=cut
1925 2584
1926sub cf::client::query { 2585sub cf::client::query {
1927 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
1935 utf8::encode $text; 2594 utf8::encode $text;
1936 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1937 2596
1938 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
1939 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
1940} 2601}
1941 2602
1942cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
1943 on_reply => sub { 2609 on_reply => sub {
1944 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
1945 2611
1946 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
1947 # get handled first 2613 # get handled first
1948 my $queue = delete $ns->{query_queue} 2614 my $queue = delete $ns->{query_queue}
1949 or return; # be conservative, not sure how that can happen, but we saw a crash here 2615 or return; # be conservative, not sure how that can happen, but we saw a crash here
1950 2616
1951 (shift @$queue)->[1]->($msg); 2617 (shift @$queue)->[1]->($msg);
2618 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1952 2619
1953 push @{ $ns->{query_queue} }, @$queue; 2620 push @{ $ns->{query_queue} }, @$queue;
1954 2621
1955 if (@{ $ns->{query_queue} } == @$queue) { 2622 if (@{ $ns->{query_queue} } == @$queue) {
1956 if (@$queue) { 2623 if (@$queue) {
1958 } else { 2625 } else {
1959 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1960 } 2627 }
1961 } 2628 }
1962 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
1963); 2653);
1964 2654
1965=item $client->async (\&cb) 2655=item $client->async (\&cb)
1966 2656
1967Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
2014 2704
2015# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
2016 2706
2017=pod 2707=pod
2018 2708
2019The following fucntions and emthods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2020 2710
2021 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
2022 cf::object::player player 2715 cf::object::player
2023 cf::player peaceful 2716 player
2024 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2025 2723
2026=cut 2724=cut
2027 2725
2028for ( 2726for (
2029 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
2030 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2031 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2032 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2033) { 2732) {
2034 no strict 'refs'; 2733 no strict 'refs';
2105=back 2804=back
2106 2805
2107=cut 2806=cut
2108 2807
2109############################################################################# 2808#############################################################################
2809# the server's init and main functions
2110 2810
2111=head2 EXTENSION DATABASE SUPPORT 2811sub load_facedata($) {
2812 my ($path) = @_;
2112 2813
2113Crossfire maintains a very simple database for extension use. It can 2814 warn "loading facedata from $path\n";
2114currently store anything that can be serialised using Storable, which
2115excludes objects.
2116 2815
2117The parameter C<$family> should best start with the name of the extension 2816 my $facedata;
2118using it, it should be unique. 2817 0 < aio_load $path, $facedata
2818 or die "$path: $!";
2119 2819
2120=over 4 2820 $facedata = Coro::Storable::thaw $facedata;
2121 2821
2122=item $hashref = cf::db_get $family 2822 $facedata->{version} == 2
2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
2123 2824
2124Return a hashref for use by the extension C<$family>, which can be
2125modified. After modifications, you have to call C<cf::db_dirty> or
2126C<cf::db_sync>.
2127
2128=item $value = cf::db_get $family => $key
2129
2130Returns a single value from the database
2131
2132=item cf::db_put $family => $hashref
2133
2134Stores the given family hashref into the database. Updates are delayed, if
2135you want the data to be synced to disk immediately, use C<cf::db_sync>.
2136
2137=item cf::db_put $family => $key => $value
2138
2139Stores the given C<$value> in the family hash. Updates are delayed, if you
2140want the data to be synced to disk immediately, use C<cf::db_sync>.
2141
2142=item cf::db_dirty
2143
2144Marks the database as dirty, to be updated at a later time.
2145
2146=item cf::db_sync
2147
2148Immediately write the database to disk I<if it is dirty>.
2149
2150=cut
2151
2152our $DB;
2153
2154{
2155 my $path = cf::localdir . "/database.pst";
2156
2157 sub db_load() {
2158 $DB = stat $path ? Storable::retrieve $path : { };
2159 } 2825 {
2826 my $faces = $facedata->{faceinfo};
2160 2827
2161 my $pid; 2828 while (my ($face, $info) = each %$faces) {
2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2162 2834
2163 sub db_save() { 2835 cf::cede_to_tick;
2164 waitpid $pid, 0 if $pid;
2165 if (0 == ($pid = fork)) {
2166 $DB->{_meta}{version} = 1;
2167 Storable::nstore $DB, "$path~";
2168 rename "$path~", $path;
2169 cf::_exit 0 if defined $pid;
2170 }
2171 }
2172
2173 my $dirty;
2174
2175 sub db_sync() {
2176 db_save if $dirty;
2177 undef $dirty;
2178 }
2179
2180 my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2181 db_sync;
2182 });
2183
2184 sub db_dirty() {
2185 $dirty = 1;
2186 $idle->start;
2187 }
2188
2189 sub db_get($;$) {
2190 @_ >= 2
2191 ? $DB->{$_[0]}{$_[1]}
2192 : ($DB->{$_[0]} ||= { })
2193 }
2194
2195 sub db_put($$;$) {
2196 if (@_ >= 3) {
2197 $DB->{$_[0]}{$_[1]} = $_[2];
2198 } else {
2199 $DB->{$_[0]} = $_[1];
2200 }
2201 db_dirty;
2202 }
2203
2204 cf::global->attach (
2205 prio => 10000,
2206 on_cleanup => sub {
2207 db_sync;
2208 }, 2836 }
2209 );
2210}
2211 2837
2212############################################################################# 2838 while (my ($face, $info) = each %$faces) {
2213# the server's main() 2839 next unless $info->{smooth};
2840 my $idx = cf::face::find $face
2841 or next;
2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2845 } else {
2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2847 }
2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 my $soundconf = delete $res->{"res/sound.conf"};
2871
2872 while (my ($name, $info) = each %$res) {
2873 my $meta = $enc->encode ({
2874 name => $name,
2875 %{ $info->{meta} || {} },
2876 });
2877
2878 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2879
2880 if ($info->{type} & 1) {
2881 # prepend meta info
2882
2883 my $data = pack "(w/a*)*", $meta, $info->{data};
2884 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2885
2886 cf::face::set_data $idx, 0, $data, $chk;
2887 } else {
2888 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2889 }
2890
2891 cf::face::set_type $idx, $info->{type};
2892
2893 cf::cede_to_tick;
2894 }
2895
2896 if ($soundconf) {
2897 $soundconf = $enc->decode (delete $soundconf->{data});
2898
2899 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2900 my $sound = $soundconf->{compat}[$_]
2901 or next;
2902
2903 my $face = cf::face::find "sound/$sound->[1]";
2904 warn "$sound->[0]: $face\n";#d#
2905
2906 cf::sound::set $sound->[0] => $face;
2907 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2908 }
2909
2910 #TODO
2911 }
2912 }
2913
2914 1
2915}
2916
2917register_exticmd fx_want => sub {
2918 my ($ns, $want) = @_;
2919
2920 while (my ($k, $v) = each %$want) {
2921 $ns->fx_want ($k, $v);
2922 }
2923};
2924
2925sub reload_regions {
2926 load_resource_file "$MAPDIR/regions"
2927 or die "unable to load regions file\n";
2928
2929 for (cf::region::list) {
2930 $_->{match} = qr/$_->{match}/
2931 if exists $_->{match};
2932 }
2933}
2934
2935sub reload_facedata {
2936 load_facedata "$DATADIR/facedata"
2937 or die "unable to load facedata\n";
2938}
2939
2940sub reload_archetypes {
2941 load_resource_file "$DATADIR/archetypes"
2942 or die "unable to load archetypes\n";
2943 #d# NEED to laod twice to resolve forward references
2944 # this really needs to be done in an extra post-pass
2945 # (which needs to be synchronous, so solve it differently)
2946 load_resource_file "$DATADIR/archetypes"
2947 or die "unable to load archetypes\n";
2948}
2949
2950sub reload_treasures {
2951 load_resource_file "$DATADIR/treasures"
2952 or die "unable to load treasurelists\n";
2953}
2954
2955sub reload_resources {
2956 warn "reloading resource files...\n";
2957
2958 reload_regions;
2959 reload_facedata;
2960 #reload_archetypes;#d#
2961 reload_archetypes;
2962 reload_treasures;
2963
2964 warn "finished reloading resource files\n";
2965}
2966
2967sub init {
2968 reload_resources;
2969}
2214 2970
2215sub cfg_load { 2971sub cfg_load {
2216 open my $fh, "<:utf8", cf::confdir . "/config" 2972 open my $fh, "<:utf8", "$CONFDIR/config"
2217 or return; 2973 or return;
2218 2974
2219 local $/; 2975 local $/;
2220 *CFG = YAML::Syck::Load <$fh>; 2976 *CFG = YAML::Syck::Load <$fh>;
2221 2977
2241 Event::one_event; 2997 Event::one_event;
2242 })->prio (Coro::PRIO_MAX); 2998 })->prio (Coro::PRIO_MAX);
2243 }; 2999 };
2244 3000
2245 cfg_load; 3001 cfg_load;
2246 db_load; 3002 db_init;
2247 load_extensions; 3003 load_extensions;
2248 3004
2249 $TICK_WATCHER->start; 3005 $TICK_WATCHER->start;
2250 Event::loop; 3006 Event::loop;
2251} 3007}
2255 3011
2256# install some emergency cleanup handlers 3012# install some emergency cleanup handlers
2257BEGIN { 3013BEGIN {
2258 for my $signal (qw(INT HUP TERM)) { 3014 for my $signal (qw(INT HUP TERM)) {
2259 Event->signal ( 3015 Event->signal (
3016 reentrant => 0,
2260 data => WF_AUTOCANCEL, 3017 data => WF_AUTOCANCEL,
2261 signal => $signal, 3018 signal => $signal,
3019 prio => 0,
2262 cb => sub { 3020 cb => sub {
2263 cf::cleanup "SIG$signal"; 3021 cf::cleanup "SIG$signal";
2264 }, 3022 },
2265 ); 3023 );
2266 } 3024 }
3025}
3026
3027sub write_runtime {
3028 my $runtime = "$LOCALDIR/runtime";
3029
3030 # first touch the runtime file to show we are still running:
3031 # the fsync below can take a very very long time.
3032
3033 IO::AIO::aio_utime $runtime, undef, undef;
3034
3035 my $guard = cf::lock_acquire "write_runtime";
3036
3037 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3038 or return;
3039
3040 my $value = $cf::RUNTIME + 90 + 10;
3041 # 10 is the runtime save interval, for a monotonic clock
3042 # 60 allows for the watchdog to kill the server.
3043
3044 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3045 and return;
3046
3047 # always fsync - this file is important
3048 aio_fsync $fh
3049 and return;
3050
3051 # touch it again to show we are up-to-date
3052 aio_utime $fh, undef, undef;
3053
3054 close $fh
3055 or return;
3056
3057 aio_rename "$runtime~", $runtime
3058 and return;
3059
3060 warn "runtime file written.\n";
3061
3062 1
2267} 3063}
2268 3064
2269sub emergency_save() { 3065sub emergency_save() {
2270 my $freeze_guard = cf::freeze_mainloop; 3066 my $freeze_guard = cf::freeze_mainloop;
2271 3067
2288 my $map = $cf::MAP{$path} or next; 3084 my $map = $cf::MAP{$path} or next;
2289 $map->valid or next; 3085 $map->valid or next;
2290 $map->save; 3086 $map->save;
2291 } 3087 }
2292 warn "end emergency map save\n"; 3088 warn "end emergency map save\n";
3089
3090 warn "begin emergency database checkpoint\n";
3091 BDB::db_env_txn_checkpoint $DB_ENV;
3092 warn "end emergency database checkpoint\n";
2293 }; 3093 };
2294 3094
2295 warn "leave emergency perl save\n"; 3095 warn "leave emergency perl save\n";
2296} 3096}
2297 3097
3098sub post_cleanup {
3099 my ($make_core) = @_;
3100
3101 warn Carp::longmess "post_cleanup backtrace"
3102 if $make_core;
3103}
3104
2298sub reload() { 3105sub do_reload_perl() {
2299 # can/must only be called in main 3106 # can/must only be called in main
2300 if ($Coro::current != $Coro::main) { 3107 if ($Coro::current != $Coro::main) {
2301 warn "can only reload from main coroutine"; 3108 warn "can only reload from main coroutine";
2302 return; 3109 return;
2303 } 3110 }
2304 3111
2305 warn "reloading..."; 3112 warn "reloading...";
2306 3113
2307 warn "cancelling server ticker"; 3114 warn "entering sync_job";
2308 $TICK_WATCHER->cancel;
2309 3115
3116 cf::sync_job {
3117 cf::write_runtime; # external watchdog should not bark
2310 cf::emergency_save; 3118 cf::emergency_save;
3119 cf::write_runtime; # external watchdog should not bark
2311 3120
2312 eval { 3121 warn "syncing database to disk";
3122 BDB::db_env_txn_checkpoint $DB_ENV;
3123
2313 # if anything goes wrong in here, we should simply crash as we already saved 3124 # if anything goes wrong in here, we should simply crash as we already saved
2314
2315 warn "syncing database to disk";
2316 cf::db_sync;
2317 3125
2318 warn "cancelling all WF_AUTOCANCEL watchers"; 3126 warn "cancelling all WF_AUTOCANCEL watchers";
2319 for (Event::all_watchers) { 3127 for (Event::all_watchers) {
2320 $_->cancel if $_->data & WF_AUTOCANCEL; 3128 $_->cancel if $_->data & WF_AUTOCANCEL;
2321 } 3129 }
2322 3130
2323 warn "flushing outstanding aio requests"; 3131 warn "flushing outstanding aio requests";
2324 for (;;) { 3132 for (;;) {
3133 BDB::flush;
2325 IO::AIO::flush; 3134 IO::AIO::flush;
2326 Coro::cede; 3135 Coro::cede;
2327 last unless IO::AIO::nreqs; 3136 last unless IO::AIO::nreqs || BDB::nreqs;
2328 warn "iterate..."; 3137 warn "iterate...";
2329 } 3138 }
3139
3140 ++$RELOAD;
2330 3141
2331 warn "cancelling all extension coros"; 3142 warn "cancelling all extension coros";
2332 $_->cancel for values %EXT_CORO; 3143 $_->cancel for values %EXT_CORO;
2333 %EXT_CORO = (); 3144 %EXT_CORO = ();
2334 3145
2335 warn "removing commands"; 3146 warn "removing commands";
2336 %COMMAND = (); 3147 %COMMAND = ();
2337 3148
2338 warn "removing ext commands"; 3149 warn "removing ext/exti commands";
2339 %EXTCMD = (); 3150 %EXTCMD = ();
3151 %EXTICMD = ();
2340 3152
2341 warn "unloading/nuking all extensions"; 3153 warn "unloading/nuking all extensions";
2342 for my $pkg (@EXTS) { 3154 for my $pkg (@EXTS) {
2343 warn "... unloading $pkg"; 3155 warn "... unloading $pkg";
2344 3156
2374 Symbol::delete_package "safe::$_" 3186 Symbol::delete_package "safe::$_"
2375 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3187 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2376 3188
2377 warn "unloading cf.pm \"a bit\""; 3189 warn "unloading cf.pm \"a bit\"";
2378 delete $INC{"cf.pm"}; 3190 delete $INC{"cf.pm"};
3191 delete $INC{"cf/pod.pm"};
2379 3192
2380 # don't, removes xs symbols, too, 3193 # don't, removes xs symbols, too,
2381 # and global variables created in xs 3194 # and global variables created in xs
2382 #Symbol::delete_package __PACKAGE__; 3195 #Symbol::delete_package __PACKAGE__;
2383 3196
2387 require cf; 3200 require cf;
2388 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3201 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2389 3202
2390 warn "loading config and database again"; 3203 warn "loading config and database again";
2391 cf::cfg_load; 3204 cf::cfg_load;
2392 cf::db_load;
2393 3205
2394 warn "loading extensions"; 3206 warn "loading extensions";
2395 cf::load_extensions; 3207 cf::load_extensions;
2396 3208
2397 warn "reattaching attachments to objects/players"; 3209 warn "reattaching attachments to objects/players";
2398 _global_reattach; 3210 _global_reattach; # objects, sockets
2399 warn "reattaching attachments to maps"; 3211 warn "reattaching attachments to maps";
2400 reattach $_ for values %MAP; 3212 reattach $_ for values %MAP;
3213 warn "reattaching attachments to players";
3214 reattach $_ for values %PLAYER;
2401 3215
2402 warn "restarting server ticker"; 3216 warn "leaving sync_job";
2403 3217
2404 $TICK_WATCHER->start; 3218 1
2405 }; 3219 } or do {
2406
2407 if ($@) {
2408 warn $@; 3220 warn $@;
2409 warn "error while reloading, exiting."; 3221 warn "error while reloading, exiting.";
2410 exit 1; 3222 exit 1;
2411 } 3223 };
2412 3224
2413 warn "reloaded"; 3225 warn "reloaded";
2414}; 3226};
2415 3227
2416our $RELOAD_WATCHER; # used only during reload 3228our $RELOAD_WATCHER; # used only during reload
2417 3229
3230sub reload_perl() {
3231 # doing reload synchronously and two reloads happen back-to-back,
3232 # coro crashes during coro_state_free->destroy here.
3233
3234 $RELOAD_WATCHER ||= Event->timer (
3235 reentrant => 0,
3236 after => 0,
3237 data => WF_AUTOCANCEL,
3238 cb => sub {
3239 do_reload_perl;
3240 undef $RELOAD_WATCHER;
3241 },
3242 );
3243}
3244
2418register_command "reload" => sub { 3245register_command "reload" => sub {
2419 my ($who, $arg) = @_; 3246 my ($who, $arg) = @_;
2420 3247
2421 if ($who->flag (FLAG_WIZ)) { 3248 if ($who->flag (FLAG_WIZ)) {
2422 $who->message ("reloading server."); 3249 $who->message ("reloading server.");
2423 3250 async { reload_perl };
2424 # doing reload synchronously and two reloads happen back-to-back,
2425 # coro crashes during coro_state_free->destroy here.
2426
2427 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2428 reload;
2429 undef $RELOAD_WATCHER;
2430 });
2431 } 3251 }
2432}; 3252};
2433 3253
2434unshift @INC, $LIBDIR; 3254unshift @INC, $LIBDIR;
2435 3255
2436my $bug_warning = 0; 3256my $bug_warning = 0;
2437 3257
3258our @WAIT_FOR_TICK;
3259our @WAIT_FOR_TICK_BEGIN;
3260
3261sub wait_for_tick {
3262 return unless $TICK_WATCHER->is_active;
3263 return if $Coro::current == $Coro::main;
3264
3265 my $signal = new Coro::Signal;
3266 push @WAIT_FOR_TICK, $signal;
3267 $signal->wait;
3268}
3269
3270sub wait_for_tick_begin {
3271 return unless $TICK_WATCHER->is_active;
3272 return if $Coro::current == $Coro::main;
3273
3274 my $signal = new Coro::Signal;
3275 push @WAIT_FOR_TICK_BEGIN, $signal;
3276 $signal->wait;
3277}
3278
3279 my $min = 1e6;#d#
3280 my $avg = 10;
2438$TICK_WATCHER = Event->timer ( 3281$TICK_WATCHER = Event->timer (
2439 reentrant => 0, 3282 reentrant => 0,
2440 parked => 1, 3283 parked => 1,
2441 prio => 0, 3284 prio => 0,
2442 at => $NEXT_TICK || $TICK, 3285 at => $NEXT_TICK || $TICK,
2446 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3289 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2447 unless ++$bug_warning > 10; 3290 unless ++$bug_warning > 10;
2448 return; 3291 return;
2449 } 3292 }
2450 3293
2451 $NOW = Event::time; 3294 $NOW = $tick_start = Event::time;
2452 3295
2453 cf::server_tick; # one server iteration 3296 cf::server_tick; # one server iteration
3297
3298 0 && sync_job {#d#
3299 for(1..10) {
3300 my $t = Event::time;
3301 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3302 or die;
3303
3304 $map->width (50);
3305 $map->height (50);
3306 $map->alloc;
3307 $map->_load_objects ("/tmp/x.map", 1);
3308 my $t = Event::time - $t;
3309
3310 #next unless $t < 0.0013;#d#
3311 if ($t < $min) {
3312 $min = $t;
3313 }
3314 $avg = $avg * 0.99 + $t * 0.01;
3315 }
3316 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3317 exit 0;
3318 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3319 };
3320
2454 $RUNTIME += $TICK; 3321 $RUNTIME += $TICK;
2455 $NEXT_TICK += $TICK; 3322 $NEXT_TICK += $TICK;
2456 3323
2457 $WAIT_FOR_TICK->broadcast; 3324 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2458 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3325 $NEXT_RUNTIME_WRITE = $NOW + 10;
3326 Coro::async_pool {
3327 write_runtime
3328 or warn "ERROR: unable to write runtime file: $!";
3329 };
3330 }
3331
3332# my $AFTER = Event::time;
3333# warn $AFTER - $NOW;#d#
3334
3335 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3336 $sig->send;
3337 }
3338 while (my $sig = shift @WAIT_FOR_TICK) {
3339 $sig->send;
3340 }
3341
3342 $NOW = Event::time;
2459 3343
2460 # if we are delayed by four ticks or more, skip them all 3344 # if we are delayed by four ticks or more, skip them all
2461 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3345 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2462 3346
2463 $TICK_WATCHER->at ($NEXT_TICK); 3347 $TICK_WATCHER->at ($NEXT_TICK);
2464 $TICK_WATCHER->start; 3348 $TICK_WATCHER->start;
3349
3350 $LOAD = ($NOW - $tick_start) / $TICK;
3351 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3352
3353 _post_tick;
3354
3355
2465 }, 3356 },
2466); 3357);
2467 3358
3359{
3360 BDB::max_poll_time $TICK * 0.1;
3361 $BDB_POLL_WATCHER = Event->io (
3362 reentrant => 0,
3363 fd => BDB::poll_fileno,
3364 poll => 'r',
3365 prio => 0,
3366 data => WF_AUTOCANCEL,
3367 cb => \&BDB::poll_cb,
3368 );
3369 BDB::min_parallel 8;
3370
3371 BDB::set_sync_prepare {
3372 my $status;
3373 my $current = $Coro::current;
3374 (
3375 sub {
3376 $status = $!;
3377 $current->ready; undef $current;
3378 },
3379 sub {
3380 Coro::schedule while defined $current;
3381 $! = $status;
3382 },
3383 )
3384 };
3385
3386 unless ($DB_ENV) {
3387 $DB_ENV = BDB::db_env_create;
3388
3389 cf::sync_job {
3390 eval {
3391 BDB::db_env_open
3392 $DB_ENV,
3393 $BDBDIR,
3394 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3395 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3396 0666;
3397
3398 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3399
3400 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3401 $DB_ENV->set_lk_detect;
3402 };
3403
3404 cf::cleanup "db_env_open(db): $@" if $@;
3405 };
3406 }
3407}
3408
3409{
3410 IO::AIO::min_parallel 8;
3411
3412 undef $Coro::AIO::WATCHER;
2468IO::AIO::max_poll_time $TICK * 0.2; 3413 IO::AIO::max_poll_time $TICK * 0.1;
2469
2470$AIO_POLL_WATCHER = Event->io ( 3414 $AIO_POLL_WATCHER = Event->io (
2471 fd => IO::AIO::poll_fileno, 3415 reentrant => 0,
2472 poll => 'r',
2473 prio => 5,
2474 data => WF_AUTOCANCEL,
2475 cb => \&IO::AIO::poll_cb,
2476);
2477
2478$WRITE_RUNTIME_WATCHER = Event->timer (
2479 data => WF_AUTOCANCEL, 3416 data => WF_AUTOCANCEL,
2480 after => 1, 3417 fd => IO::AIO::poll_fileno,
2481 interval => 10, 3418 poll => 'r',
2482 cb => Coro::unblock_sub { 3419 prio => 6,
2483 write_runtime 3420 cb => \&IO::AIO::poll_cb,
2484 or warn "ERROR: unable to write runtime file: $!"; 3421 );
3422}
3423
3424my $_log_backtrace;
3425
3426sub _log_backtrace {
3427 my ($msg, @addr) = @_;
3428
3429 $msg =~ s/\n//;
3430
3431 # limit the # of concurrent backtraces
3432 if ($_log_backtrace < 2) {
3433 ++$_log_backtrace;
3434 async {
3435 my @bt = fork_call {
3436 @addr = map { sprintf "%x", $_ } @addr;
3437 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3438 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3439 or die "addr2line: $!";
3440
3441 my @funcs;
3442 my @res = <$fh>;
3443 chomp for @res;
3444 while (@res) {
3445 my ($func, $line) = splice @res, 0, 2, ();
3446 push @funcs, "[$func] $line";
3447 }
3448
3449 @funcs
3450 };
3451
3452 LOG llevInfo, "[ABT] $msg\n";
3453 LOG llevInfo, "[ABT] $_\n" for @bt;
3454 --$_log_backtrace;
3455 };
3456 } else {
3457 LOG llevInfo, "[ABT] $msg\n";
3458 LOG llevInfo, "[ABT] [suppressed]\n";
2485 }, 3459 }
2486); 3460}
3461
3462# load additional modules
3463use cf::pod;
2487 3464
2488END { cf::emergency_save } 3465END { cf::emergency_save }
2489 3466
24901 34671
2491 3468

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines