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.187 by root, Sat Jan 20 21:06:52 2007 UTC vs.
Revision 1.338 by root, Tue Aug 21 01:07:47 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines