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.198 by root, Sun Jan 28 01:58:37 2007 UTC vs.
Revision 1.345 by root, Tue Aug 28 19:30:11 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.5 (); 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 ();
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) = @_;
1180 1628
1181 $path = "$path"; # make sure its a string 1629 $path = "$path"; # make sure its a string
1630
1631 $path =~ s/\.map$//;
1182 1632
1183 # map plan: 1633 # map plan:
1184 # 1634 #
1185 # /! non-realised random map exit (special hack!) 1635 # /! non-realised random map exit (special hack!)
1186 # {... are special paths that are not being touched 1636 # {... are special paths that are not being touched
1223 $self->init; # pass $1 etc. 1673 $self->init; # pass $1 etc.
1224 return $self; 1674 return $self;
1225 } 1675 }
1226 } 1676 }
1227 1677
1228 Carp::carp "unable to resolve path '$path' (base '$base')."; 1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1229 () 1679 ()
1230} 1680}
1231 1681
1232sub init { 1682sub init {
1233 my ($self) = @_; 1683 my ($self) = @_;
1248 1698
1249# the original (read-only) location 1699# the original (read-only) location
1250sub load_path { 1700sub load_path {
1251 my ($self) = @_; 1701 my ($self) = @_;
1252 1702
1253 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1703 "$MAPDIR/$self->{path}.map"
1254} 1704}
1255 1705
1256# the temporary/swap location 1706# the temporary/swap location
1257sub save_path { 1707sub save_path {
1258 my ($self) = @_; 1708 my ($self) = @_;
1259 1709
1260 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1710 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1711 "$TMPDIR/$path.map"
1262} 1712}
1263 1713
1264# the unique path, undef == no special unique path 1714# the unique path, undef == no special unique path
1265sub uniq_path { 1715sub uniq_path {
1266 my ($self) = @_; 1716 my ($self) = @_;
1267 1717
1268 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1718 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1719 "$UNIQUEDIR/$path"
1270} 1720}
1271 1721
1272# and all this just because we cannot iterate over 1722# and all this just because we cannot iterate over
1273# all maps in C++... 1723# all maps in C++...
1274sub change_all_map_light { 1724sub change_all_map_light {
1276 1726
1277 $_->change_map_light ($change) 1727 $_->change_map_light ($change)
1278 for grep $_->outdoor, values %cf::MAP; 1728 for grep $_->outdoor, values %cf::MAP;
1279} 1729}
1280 1730
1731sub decay_objects {
1732 my ($self) = @_;
1733
1734 return if $self->{deny_reset};
1735
1736 $self->do_decay_objects;
1737}
1738
1281sub unlink_save { 1739sub unlink_save {
1282 my ($self) = @_; 1740 my ($self) = @_;
1283 1741
1284 utf8::encode (my $save = $self->save_path); 1742 utf8::encode (my $save = $self->save_path);
1285 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1743 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1288 1746
1289sub load_header_from($) { 1747sub load_header_from($) {
1290 my ($self, $path) = @_; 1748 my ($self, $path) = @_;
1291 1749
1292 utf8::encode $path; 1750 utf8::encode $path;
1293 aio_open $path, O_RDONLY, 0 1751 #aio_open $path, O_RDONLY, 0
1294 or return; 1752 # or return;
1295 1753
1296 $self->_load_header ($path) 1754 $self->_load_header ($path)
1297 or return; 1755 or return;
1298 1756
1299 $self->{load_path} = $path; 1757 $self->{load_path} = $path;
1341 $self->load_header_orig 1799 $self->load_header_orig
1342 or return; 1800 or return;
1343 $self->prepare_orig; 1801 $self->prepare_orig;
1344 } 1802 }
1345 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;
1809
1346 1 1810 1
1347} 1811}
1348 1812
1349sub find; 1813sub find;
1350sub find { 1814sub find {
1362 $map->{last_save} = $cf::RUNTIME; 1826 $map->{last_save} = $cf::RUNTIME;
1363 1827
1364 $map->load_header 1828 $map->load_header
1365 or return; 1829 or return;
1366 1830
1367 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1831 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368 # doing this can freeze the server in a sync job, obviously 1832 # doing this can freeze the server in a sync job, obviously
1369 #$cf::WAIT_FOR_TICK->wait; 1833 #$cf::WAIT_FOR_TICK->wait;
1370 $map->reset; 1834 $map->reset;
1371 undef $guard; 1835 undef $guard;
1372 return find $path; 1836 return find $path;
1383 my ($self) = @_; 1847 my ($self) = @_;
1384 1848
1385 local $self->{deny_reset} = 1; # loading can take a long time 1849 local $self->{deny_reset} = 1; # loading can take a long time
1386 1850
1387 my $path = $self->{path}; 1851 my $path = $self->{path};
1852
1853 {
1854 my $guard1 = cf::lock_acquire "map_data:$path";
1388 my $guard = cf::lock_acquire "map_load:$path"; 1855 my $guard2 = cf::lock_acquire "map_load:$path";
1389 1856
1390 return if $self->in_memory != cf::MAP_SWAPPED; 1857 return if $self->in_memory != cf::MAP_SWAPPED;
1391 1858
1392 $self->in_memory (cf::MAP_LOADING); 1859 $self->in_memory (cf::MAP_LOADING);
1393 1860
1394 $self->alloc; 1861 $self->alloc;
1395 1862
1396 $self->pre_load; 1863 $self->pre_load;
1397
1398 $self->_load_objects ($self->{load_path}, 1)
1399 or return;
1400
1401 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1402 if delete $self->{load_original};
1403
1404 if (my $uniq = $self->uniq_path) {
1405 utf8::encode $uniq;
1406 if (aio_open $uniq, O_RDONLY, 0) {
1407 $self->clear_unique_items;
1408 $self->_load_objects ($uniq, 0);
1409 }
1410 }
1411
1412 Coro::cede;
1413
1414 # now do the right thing for maps
1415 $self->link_multipart_objects;
1416
1417 unless ($self->{deny_activate}) {
1418 $self->decay_objects;
1419 $self->fix_auto_apply;
1420 $self->update_buttons;
1421 Coro::cede; 1864 Coro::cede;
1422 $self->set_darkness_map; 1865
1866 $self->_load_objects ($self->{load_path}, 1)
1867 or return;
1868
1869 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1870 if delete $self->{load_original};
1871
1872 if (my $uniq = $self->uniq_path) {
1873 utf8::encode $uniq;
1874 if (aio_open $uniq, O_RDONLY, 0) {
1875 $self->clear_unique_items;
1876 $self->_load_objects ($uniq, 0);
1877 }
1878 }
1879
1880 Coro::cede;
1881 # now do the right thing for maps
1882 $self->link_multipart_objects;
1423 $self->difficulty ($self->estimate_difficulty) 1883 $self->difficulty ($self->estimate_difficulty)
1424 unless $self->difficulty; 1884 unless $self->difficulty;
1425 Coro::cede; 1885 Coro::cede;
1886
1887 unless ($self->{deny_activate}) {
1888 $self->decay_objects;
1889 $self->fix_auto_apply;
1890 $self->update_buttons;
1891 Coro::cede;
1892 $self->set_darkness_map;
1893 Coro::cede;
1426 $self->activate; 1894 $self->activate;
1895 }
1896
1897 $self->{last_save} = $cf::RUNTIME;
1898 $self->last_access ($cf::RUNTIME);
1899
1900 $self->in_memory (cf::MAP_IN_MEMORY);
1427 } 1901 }
1428 1902
1429 $self->post_load; 1903 $self->post_load;
1430
1431 $self->in_memory (cf::MAP_IN_MEMORY);
1432} 1904}
1433 1905
1434sub customise_for { 1906sub customise_for {
1435 my ($self, $ob) = @_; 1907 my ($self, $ob) = @_;
1436 1908
1437 return find "~" . $ob->name . "/" . $self->{path} 1909 return find "~" . $ob->name . "/" . $self->{path}
1438 if $self->per_player; 1910 if $self->per_player;
1439 1911
1912# return find "?party/" . $ob->name . "/" . $self->{path}
1913# if $self->per_party;
1914
1440 $self 1915 $self
1441} 1916}
1442 1917
1443# find and load all maps in the 3x3 area around a map 1918# find and load all maps in the 3x3 area around a map
1444sub load_diag { 1919sub load_neighbours {
1445 my ($map) = @_; 1920 my ($map) = @_;
1446 1921
1447 my @diag; # diagonal neighbours 1922 my @neigh; # diagonal neighbours
1448 1923
1449 for (0 .. 3) { 1924 for (0 .. 3) {
1450 my $neigh = $map->tile_path ($_) 1925 my $neigh = $map->tile_path ($_)
1451 or next; 1926 or next;
1452 $neigh = find $neigh, $map 1927 $neigh = find $neigh, $map
1453 or next; 1928 or next;
1454 $neigh->load; 1929 $neigh->load;
1455 1930
1931 push @neigh,
1456 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1932 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1457 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1933 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1458 } 1934 }
1459 1935
1460 for (@diag) { 1936 for (grep defined $_->[0], @neigh) {
1937 my ($path, $origin) = @$_;
1461 my $neigh = find @$_ 1938 my $neigh = find $path, $origin
1462 or next; 1939 or next;
1463 $neigh->load; 1940 $neigh->load;
1464 } 1941 }
1465} 1942}
1466 1943
1471} 1948}
1472 1949
1473sub do_load_sync { 1950sub do_load_sync {
1474 my ($map) = @_; 1951 my ($map) = @_;
1475 1952
1953 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1954 if $Coro::current == $Coro::main;
1955
1476 cf::sync_job { $map->load }; 1956 cf::sync_job { $map->load };
1477} 1957}
1478 1958
1479our %MAP_PREFETCH; 1959our %MAP_PREFETCH;
1480our $MAP_PREFETCHER = undef; 1960our $MAP_PREFETCHER = undef;
1481 1961
1482sub find_async { 1962sub find_async {
1483 my ($path, $origin) = @_; 1963 my ($path, $origin, $load) = @_;
1484 1964
1485 $path = normalise $path, $origin && $origin->{path}; 1965 $path = normalise $path, $origin && $origin->{path};
1486 1966
1487 if (my $map = $cf::MAP{$path}) { 1967 if (my $map = $cf::MAP{$path}) {
1488 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1968 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1489 } 1969 }
1490 1970
1491 undef $MAP_PREFETCH{$path}; 1971 $MAP_PREFETCH{$path} |= $load;
1972
1492 $MAP_PREFETCHER ||= cf::async { 1973 $MAP_PREFETCHER ||= cf::async {
1493 while (%MAP_PREFETCH) { 1974 while (%MAP_PREFETCH) {
1494 for my $path (keys %MAP_PREFETCH) { 1975 while (my ($k, $v) = each %MAP_PREFETCH) {
1495 my $map = find $path 1976 if (my $map = find $k) {
1496 or next;
1497 $map->load; 1977 $map->load if $v;
1978 }
1498 1979
1499 delete $MAP_PREFETCH{$path}; 1980 delete $MAP_PREFETCH{$k};
1500 } 1981 }
1501 } 1982 }
1502 undef $MAP_PREFETCHER; 1983 undef $MAP_PREFETCHER;
1503 }; 1984 };
1504 $MAP_PREFETCHER->prio (6); 1985 $MAP_PREFETCHER->prio (6);
1507} 1988}
1508 1989
1509sub save { 1990sub save {
1510 my ($self) = @_; 1991 my ($self) = @_;
1511 1992
1512 my $lock = cf::lock_acquire "map_data:" . $self->path; 1993 my $lock = cf::lock_acquire "map_data:$self->{path}";
1513 1994
1514 $self->{last_save} = $cf::RUNTIME; 1995 $self->{last_save} = $cf::RUNTIME;
1515 1996
1516 return unless $self->dirty; 1997 return unless $self->dirty;
1517 1998
1540 my ($self) = @_; 2021 my ($self) = @_;
1541 2022
1542 # save first because save cedes 2023 # save first because save cedes
1543 $self->save; 2024 $self->save;
1544 2025
1545 my $lock = cf::lock_acquire "map_data:" . $self->path; 2026 my $lock = cf::lock_acquire "map_data:$self->{path}";
1546 2027
1547 return if $self->players; 2028 return if $self->players;
1548 return if $self->in_memory != cf::MAP_IN_MEMORY; 2029 return if $self->in_memory != cf::MAP_IN_MEMORY;
1549 return if $self->{deny_save}; 2030 return if $self->{deny_save};
1550 2031
1554 2035
1555sub reset_at { 2036sub reset_at {
1556 my ($self) = @_; 2037 my ($self) = @_;
1557 2038
1558 # TODO: safety, remove and allow resettable per-player maps 2039 # TODO: safety, remove and allow resettable per-player maps
1559 return 1e99 if $self->isa ("ext::map_per_player");#d#
1560 return 1e99 if $self->{deny_reset}; 2040 return 1e99 if $self->{deny_reset};
1561 2041
1562 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2042 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1563 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2043 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1564 2044
1575 my ($self) = @_; 2055 my ($self) = @_;
1576 2056
1577 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2057 my $lock = cf::lock_acquire "map_data:$self->{path}";
1578 2058
1579 return if $self->players; 2059 return if $self->players;
1580 return if $self->isa ("ext::map_per_player");#d#
1581 2060
1582 warn "resetting map ", $self->path;#d# 2061 warn "resetting map ", $self->path;
2062
2063 $self->in_memory (cf::MAP_SWAPPED);
2064
2065 # need to save uniques path
2066 unless ($self->{deny_save}) {
2067 my $uniq = $self->uniq_path; utf8::encode $uniq;
2068
2069 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2070 if $uniq;
2071 }
1583 2072
1584 delete $cf::MAP{$self->path}; 2073 delete $cf::MAP{$self->path};
1585 2074
1586 $self->in_memory (cf::MAP_SWAPPED);
1587 $self->clear; 2075 $self->clear;
1588 2076
1589 $_->clear_links_to ($self) for values %cf::MAP; 2077 $_->clear_links_to ($self) for values %cf::MAP;
1590 2078
1591 $self->unlink_save; 2079 $self->unlink_save;
1610 $cf::MAP{$self->path} = $self; 2098 $cf::MAP{$self->path} = $self;
1611 2099
1612 $self->reset; # polite request, might not happen 2100 $self->reset; # polite request, might not happen
1613} 2101}
1614 2102
2103=item $maps = cf::map::tmp_maps
2104
2105Returns an arrayref with all map paths of currently instantiated and saved
2106maps. May block.
2107
2108=cut
2109
2110sub tmp_maps() {
2111 [
2112 map {
2113 utf8::decode $_;
2114 /\.map$/
2115 ? normalise $_
2116 : ()
2117 } @{ aio_readdir $TMPDIR or [] }
2118 ]
2119}
2120
2121=item $maps = cf::map::random_maps
2122
2123Returns an arrayref with all map paths of currently instantiated and saved
2124random maps. May block.
2125
2126=cut
2127
2128sub random_maps() {
2129 [
2130 map {
2131 utf8::decode $_;
2132 /\.map$/
2133 ? normalise "?random/$_"
2134 : ()
2135 } @{ aio_readdir $RANDOMDIR or [] }
2136 ]
2137}
2138
1615=item cf::map::unique_maps 2139=item cf::map::unique_maps
1616 2140
1617Returns an arrayref of paths of all shared maps that have 2141Returns an arrayref of paths of all shared maps that have
1618instantiated unique items. May block. 2142instantiated unique items. May block.
1619 2143
1620=cut 2144=cut
1621 2145
1622sub unique_maps() { 2146sub unique_maps() {
1623 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2147 [
1624 or return; 2148 map {
1625
1626 my @paths;
1627
1628 for (@$files) {
1629 utf8::decode $_; 2149 utf8::decode $_;
1630 next if /\.pst$/;
1631 next unless /^$PATH_SEP/o;
1632
1633 s/\.map$//; 2150 /\.map$/
1634 push @paths, $_; 2151 ? normalise $_
2152 : ()
2153 } @{ aio_readdir $UNIQUEDIR or [] }
1635 } 2154 ]
1636
1637 \@paths
1638} 2155}
1639 2156
1640package cf; 2157package cf;
1641 2158
1642=back 2159=back
1688 2205
1689 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2206 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1690 2207
1691 if ($self->{record_replies}) { 2208 if ($self->{record_replies}) {
1692 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2209 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2210
1693 } else { 2211 } else {
2212 my $pl = $self->contr;
2213
2214 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2215 my $dialog = $pl->{npc_dialog};
2216 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2217
2218 } else {
1694 $msg = $npc->name . " says: $msg" if $npc; 2219 $msg = $npc->name . " says: $msg" if $npc;
1695 $self->message ($msg, $flags); 2220 $self->message ($msg, $flags);
2221 }
1696 } 2222 }
2223}
2224
2225=item $object->send_msg ($channel, $msg, $color, [extra...])
2226
2227=cut
2228
2229sub cf::object::send_msg {
2230 my $pl = shift->contr
2231 or return;
2232 $pl->send_msg (@_);
1697} 2233}
1698 2234
1699=item $player_object->may ("access") 2235=item $player_object->may ("access")
1700 2236
1701Returns wether the given player is authorized to access resource "access" 2237Returns wether the given player is authorized to access resource "access"
1748 $self->deactivate_recursive; 2284 $self->deactivate_recursive;
1749 2285
1750 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2286 return if UNIVERSAL::isa $self->map, "ext::map_link";
1751 2287
1752 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2288 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1753 if $self->map; 2289 if $self->map && $self->map->{path} ne "{link}";
1754 2290
1755 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2291 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1756} 2292}
1757 2293
1758sub cf::object::player::leave_link { 2294sub cf::object::player::leave_link {
1759 my ($self, $map, $x, $y) = @_; 2295 my ($self, $map, $x, $y) = @_;
2296
2297 return unless $self->contr->active;
1760 2298
1761 my $link_pos = delete $self->{_link_pos}; 2299 my $link_pos = delete $self->{_link_pos};
1762 2300
1763 unless ($map) { 2301 unless ($map) {
1764 # restore original map position 2302 # restore original map position
1778 # use -1 or undef as default coordinates, not 0, 0 2316 # use -1 or undef as default coordinates, not 0, 0
1779 ($x, $y) = ($map->enter_x, $map->enter_y) 2317 ($x, $y) = ($map->enter_x, $map->enter_y)
1780 if $x <=0 && $y <= 0; 2318 if $x <=0 && $y <= 0;
1781 2319
1782 $map->load; 2320 $map->load;
1783 $map->load_diag; 2321 $map->load_neighbours;
1784 2322
1785 return unless $self->contr->active; 2323 return unless $self->contr->active;
1786 $self->activate_recursive; 2324 $self->activate_recursive;
2325
2326 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1787 $self->enter_map ($map, $x, $y); 2327 $self->enter_map ($map, $x, $y);
1788} 2328}
1789 2329
1790cf::player->attach ( 2330=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1791 on_logout => sub {
1792 my ($pl) = @_;
1793 2331
1794 # abort map switching before logout 2332Moves the player to the given map-path and coordinates by first freezing
1795 if ($pl->ob->{_link_pos}) { 2333her, loading and preparing them map, calling the provided $check callback
1796 cf::sync_job { 2334that has to return the map if sucecssful, and then unfreezes the player on
1797 $pl->ob->leave_link 2335the new (success) or old (failed) map position. In either case, $done will
1798 }; 2336be called at the end of this process.
1799 }
1800 },
1801 on_login => sub {
1802 my ($pl) = @_;
1803 2337
1804 # try to abort aborted map switching on player login :)
1805 # should happen only on crashes
1806 if ($pl->ob->{_link_pos}) {
1807 $pl->ob->enter_link;
1808 (async {
1809 # we need this sleep as the login has a concurrent enter_exit running
1810 # and this sleep increases chances of the player not ending up in scorn
1811 $pl->ob->reply (undef,
1812 "There was an internal problem at your last logout, "
1813 . "the server will try to bring you to your intended destination in a second.",
1814 cf::NDI_RED);
1815 Coro::Timer::sleep 1;
1816 $pl->ob->leave_link;
1817 })->prio (2);
1818 }
1819 },
1820);
1821
1822=item $player_object->goto ($path, $x, $y)
1823
1824=cut 2338=cut
2339
2340our $GOTOGEN;
1825 2341
1826sub cf::object::player::goto { 2342sub cf::object::player::goto {
1827 my ($self, $path, $x, $y) = @_; 2343 my ($self, $path, $x, $y, $check, $done) = @_;
2344
2345 # do generation counting so two concurrent goto's will be executed in-order
2346 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1828 2347
1829 $self->enter_link; 2348 $self->enter_link;
1830 2349
1831 (async { 2350 (async {
1832 my $map = eval { 2351 my $map = eval {
1833 my $map = cf::map::find $path; 2352 my $map = cf::map::find $path;
2353
2354 if ($map) {
1834 $map = $map->customise_for ($self) if $map; 2355 $map = $map->customise_for ($self);
2356 $map = $check->($map) if $check && $map;
2357 } else {
2358 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2359 }
2360
1835 $map 2361 $map
2362 };
2363
2364 if ($@) {
2365 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2366 LOG llevError | logBacktrace, Carp::longmess $@;
1836 } or 2367 }
1837 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1838 2368
2369 if ($gen == $self->{_goto_generation}) {
2370 delete $self->{_goto_generation};
1839 $self->leave_link ($map, $x, $y); 2371 $self->leave_link ($map, $x, $y);
2372 }
2373
2374 $done->() if $done;
1840 })->prio (1); 2375 })->prio (1);
1841} 2376}
1842 2377
1843=item $player_object->enter_exit ($exit_object) 2378=item $player_object->enter_exit ($exit_object)
1844 2379
1883 2418
1884 $rmp->{random_seed} ||= $exit->random_seed; 2419 $rmp->{random_seed} ||= $exit->random_seed;
1885 2420
1886 my $data = cf::to_json $rmp; 2421 my $data = cf::to_json $rmp;
1887 my $md5 = Digest::MD5::md5_hex $data; 2422 my $md5 = Digest::MD5::md5_hex $data;
1888 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2423 my $meta = "$RANDOMDIR/$md5.meta";
1889 2424
1890 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2425 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1891 aio_write $fh, 0, (length $data), $data, 0; 2426 aio_write $fh, 0, (length $data), $data, 0;
1892 undef $fh; 2427 undef $fh;
1893 aio_rename "$meta~", $meta; 2428 aio_rename "$meta~", $meta;
1902 2437
1903 return unless $self->type == cf::PLAYER; 2438 return unless $self->type == cf::PLAYER;
1904 2439
1905 if ($exit->slaying eq "/!") { 2440 if ($exit->slaying eq "/!") {
1906 #TODO: this should de-fi-ni-te-ly not be a sync-job 2441 #TODO: this should de-fi-ni-te-ly not be a sync-job
2442 # the problem is that $exit might not survive long enough
2443 # so it needs to be done right now, right here
1907 cf::sync_job { prepare_random_map $exit }; 2444 cf::sync_job { prepare_random_map $exit };
1908 } 2445 }
1909 2446
1910 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2447 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1911 my $hp = $exit->stats->hp; 2448 my $hp = $exit->stats->hp;
1912 my $sp = $exit->stats->sp; 2449 my $sp = $exit->stats->sp;
1913 2450
1914 $self->enter_link; 2451 $self->enter_link;
2452
2453 # if exit is damned, update players death & WoR home-position
2454 $self->contr->savebed ($slaying, $hp, $sp)
2455 if $exit->flag (FLAG_DAMNED);
1915 2456
1916 (async { 2457 (async {
1917 $self->deactivate_recursive; # just to be sure 2458 $self->deactivate_recursive; # just to be sure
1918 unless (eval { 2459 unless (eval {
1919 $self->goto ($slaying, $hp, $sp); 2460 $self->goto ($slaying, $hp, $sp);
1920 2461
1921 1; 2462 1;
1922 }) { 2463 }) {
1923 $self->message ("Something went wrong deep within the crossfire server. " 2464 $self->message ("Something went wrong deep within the crossfire server. "
1924 . "I'll try to bring you back to the map you were before. " 2465 . "I'll try to bring you back to the map you were before. "
1925 . "Please report this to the dungeon master!", 2466 . "Please report this to the dungeon master!",
1926 cf::NDI_UNIQUE | cf::NDI_RED); 2467 cf::NDI_UNIQUE | cf::NDI_RED);
1927 2468
1928 warn "ERROR in enter_exit: $@"; 2469 warn "ERROR in enter_exit: $@";
1929 $self->leave_link; 2470 $self->leave_link;
1930 } 2471 }
1931 })->prio (1); 2472 })->prio (1);
1944 2485
1945sub cf::client::send_drawinfo { 2486sub cf::client::send_drawinfo {
1946 my ($self, $text, $flags) = @_; 2487 my ($self, $text, $flags) = @_;
1947 2488
1948 utf8::encode $text; 2489 utf8::encode $text;
1949 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2490 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1950} 2491}
1951 2492
2493=item $client->send_msg ($channel, $msg, $color, [extra...])
2494
2495Send a drawinfo or msg packet to the client, formatting the msg for the
2496client if neccessary. C<$type> should be a string identifying the type of
2497the message, with C<log> being the default. If C<$color> is negative, suppress
2498the message unless the client supports the msg packet.
2499
2500=cut
2501
2502sub cf::client::send_msg {
2503 my ($self, $channel, $msg, $color, @extra) = @_;
2504
2505 $msg = $self->pl->expand_cfpod ($msg);
2506
2507 $color &= cf::NDI_CLIENT_MASK; # just in case...
2508
2509 if (ref $channel) {
2510 # send meta info to client, if not yet sent
2511 unless (exists $self->{channel}{$channel->{id}}) {
2512 $self->{channel}{$channel->{id}} = $channel;
2513 $self->ext_msg (channel_info => $channel);
2514 }
2515
2516 $channel = $channel->{id};
2517 }
2518
2519 return unless @extra || length $msg;
2520
2521 if ($self->can_msg) {
2522 # default colour, mask it out
2523 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2524 if $color & cf::NDI_DEF;
2525
2526 $self->send_packet ("msg " . $self->{json_coder}->encode (
2527 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2528 } else {
2529 if ($color >= 0) {
2530 # replace some tags by gcfclient-compatible ones
2531 for ($msg) {
2532 1 while
2533 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2534 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2535 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2536 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2537 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2538 }
2539
2540 $color &= cf::NDI_COLOR_MASK;
2541
2542 utf8::encode $msg;
2543
2544 if (0 && $msg =~ /\[/) {
2545 # COMMAND/INFO
2546 $self->send_packet ("drawextinfo $color 10 8 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 if ($self->extcmd == 2) {
2565 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2566 } elsif ($self->extcmd == 1) { # TODO: remove
2567 push @msg, msgtype => "event_$type";
2568 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2569 }
2570}
2571
2572=item $client->ext_reply ($msgid, @msg)
2573
2574Sends an ext reply to the client.
2575
2576=cut
2577
2578sub cf::client::ext_reply($$@) {
2579 my ($self, $id, @msg) = @_;
2580
2581 if ($self->extcmd == 2) {
2582 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2583 } elsif ($self->extcmd == 1) {
2584 #TODO: version 1, remove
2585 unshift @msg, msgtype => "reply", msgid => $id;
2586 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2587 }
2588}
1952 2589
1953=item $success = $client->query ($flags, "text", \&cb) 2590=item $success = $client->query ($flags, "text", \&cb)
1954 2591
1955Queues a query to the client, calling the given callback with 2592Queues a query to the client, calling the given callback with
1956the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2593the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1957C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2594C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1958 2595
1959Queries can fail, so check the return code. Or don't, as queries will become 2596Queries can fail, so check the return code. Or don't, as queries will
1960reliable at some point in the future. 2597become reliable at some point in the future.
1961 2598
1962=cut 2599=cut
1963 2600
1964sub cf::client::query { 2601sub cf::client::query {
1965 my ($self, $flags, $text, $cb) = @_; 2602 my ($self, $flags, $text, $cb) = @_;
1973 utf8::encode $text; 2610 utf8::encode $text;
1974 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2611 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1975 2612
1976 $self->send_packet ($self->{query_queue}[0][0]) 2613 $self->send_packet ($self->{query_queue}[0][0])
1977 if @{ $self->{query_queue} } == 1; 2614 if @{ $self->{query_queue} } == 1;
2615
2616 1
1978} 2617}
1979 2618
1980cf::client->attach ( 2619cf::client->attach (
2620 on_connect => sub {
2621 my ($ns) = @_;
2622
2623 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2624 },
1981 on_reply => sub { 2625 on_reply => sub {
1982 my ($ns, $msg) = @_; 2626 my ($ns, $msg) = @_;
1983 2627
1984 # this weird shuffling is so that direct followup queries 2628 # this weird shuffling is so that direct followup queries
1985 # get handled first 2629 # get handled first
1986 my $queue = delete $ns->{query_queue} 2630 my $queue = delete $ns->{query_queue}
1987 or return; # be conservative, not sure how that can happen, but we saw a crash here 2631 or return; # be conservative, not sure how that can happen, but we saw a crash here
1988 2632
1989 (shift @$queue)->[1]->($msg); 2633 (shift @$queue)->[1]->($msg);
2634 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1990 2635
1991 push @{ $ns->{query_queue} }, @$queue; 2636 push @{ $ns->{query_queue} }, @$queue;
1992 2637
1993 if (@{ $ns->{query_queue} } == @$queue) { 2638 if (@{ $ns->{query_queue} } == @$queue) {
1994 if (@$queue) { 2639 if (@$queue) {
1996 } else { 2641 } else {
1997 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2642 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1998 } 2643 }
1999 } 2644 }
2000 }, 2645 },
2646 on_exticmd => sub {
2647 my ($ns, $buf) = @_;
2648
2649 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2650
2651 if (ref $msg) {
2652 my ($type, $reply, @payload) =
2653 "ARRAY" eq ref $msg
2654 ? @$msg
2655 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2656
2657 my @reply;
2658
2659 if (my $cb = $EXTICMD{$type}) {
2660 @reply = $cb->($ns, @payload);
2661 }
2662
2663 $ns->ext_reply ($reply, @reply)
2664 if $reply;
2665
2666 } else {
2667 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2668 }
2669
2670 cf::override;
2671 },
2001); 2672);
2002 2673
2003=item $client->async (\&cb) 2674=item $client->async (\&cb)
2004 2675
2005Create a new coroutine, running the specified callback. The coroutine will 2676Create a new coroutine, running the specified callback. The coroutine will
2046our $safe = new Safe "safe"; 2717our $safe = new Safe "safe";
2047our $safe_hole = new Safe::Hole; 2718our $safe_hole = new Safe::Hole;
2048 2719
2049$SIG{FPE} = 'IGNORE'; 2720$SIG{FPE} = 'IGNORE';
2050 2721
2051$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2722$safe->permit_only (Opcode::opset qw(
2723 :base_core :base_mem :base_orig :base_math
2724 grepstart grepwhile mapstart mapwhile
2725 sort time
2726));
2052 2727
2053# here we export the classes and methods available to script code 2728# here we export the classes and methods available to script code
2054 2729
2055=pod 2730=pod
2056 2731
2057The following fucntions and emthods are available within a safe environment: 2732The following functions and methods are available within a safe environment:
2058 2733
2059 cf::object contr pay_amount pay_player map 2734 cf::object
2735 contr pay_amount pay_player map x y force_find force_add
2736 insert remove name archname title slaying race decrease_ob_nr
2737
2060 cf::object::player player 2738 cf::object::player
2061 cf::player peaceful 2739 player
2062 cf::map trigger 2740
2741 cf::player
2742 peaceful
2743
2744 cf::map
2745 trigger
2063 2746
2064=cut 2747=cut
2065 2748
2066for ( 2749for (
2067 ["cf::object" => qw(contr pay_amount pay_player map)], 2750 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2751 insert remove inv name archname title slaying race
2752 decrease_ob_nr)],
2068 ["cf::object::player" => qw(player)], 2753 ["cf::object::player" => qw(player)],
2069 ["cf::player" => qw(peaceful)], 2754 ["cf::player" => qw(peaceful)],
2070 ["cf::map" => qw(trigger)], 2755 ["cf::map" => qw(trigger)],
2071) { 2756) {
2072 no strict 'refs'; 2757 no strict 'refs';
2143=back 2828=back
2144 2829
2145=cut 2830=cut
2146 2831
2147############################################################################# 2832#############################################################################
2833# the server's init and main functions
2148 2834
2149=head2 EXTENSION DATABASE SUPPORT 2835sub load_facedata($) {
2836 my ($path) = @_;
2150 2837
2151Crossfire maintains a very simple database for extension use. It can 2838 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2152currently store anything that can be serialised using Storable, which
2153excludes objects.
2154 2839
2155The parameter C<$family> should best start with the name of the extension 2840 warn "loading facedata from $path\n";
2156using it, it should be unique.
2157 2841
2158=over 4 2842 my $facedata;
2843 0 < aio_load $path, $facedata
2844 or die "$path: $!";
2159 2845
2160=item $hashref = cf::db_get $family 2846 $facedata = Coro::Storable::thaw $facedata;
2161 2847
2162Return a hashref for use by the extension C<$family>, which can be 2848 $facedata->{version} == 2
2163modified. After modifications, you have to call C<cf::db_dirty> or 2849 or cf::cleanup "$path: version mismatch, cannot proceed.";
2164C<cf::db_sync>.
2165 2850
2166=item $value = cf::db_get $family => $key 2851 # patch in the exptable
2167 2852 $facedata->{resource}{"res/exp_table"} = {
2168Returns a single value from the database 2853 type => FT_RSRC,
2169 2854 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2170=item cf::db_put $family => $hashref
2171
2172Stores the given family hashref into the database. Updates are delayed, if
2173you want the data to be synced to disk immediately, use C<cf::db_sync>.
2174
2175=item cf::db_put $family => $key => $value
2176
2177Stores the given C<$value> in the family hash. Updates are delayed, if you
2178want the data to be synced to disk immediately, use C<cf::db_sync>.
2179
2180=item cf::db_dirty
2181
2182Marks the database as dirty, to be updated at a later time.
2183
2184=item cf::db_sync
2185
2186Immediately write the database to disk I<if it is dirty>.
2187
2188=cut
2189
2190our $DB;
2191
2192{
2193 my $path = cf::localdir . "/database.pst";
2194
2195 sub db_load() {
2196 $DB = stat $path ? Storable::retrieve $path : { };
2197 } 2855 };
2856 cf::cede_to_tick;
2198 2857
2199 my $pid;
2200
2201 sub db_save() {
2202 waitpid $pid, 0 if $pid;
2203 if (0 == ($pid = fork)) {
2204 $DB->{_meta}{version} = 1;
2205 Storable::nstore $DB, "$path~";
2206 rename "$path~", $path;
2207 cf::_exit 0 if defined $pid;
2208 }
2209 } 2858 {
2859 my $faces = $facedata->{faceinfo};
2210 2860
2211 my $dirty; 2861 while (my ($face, $info) = each %$faces) {
2862 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2863 cf::face::set_visibility $idx, $info->{visibility};
2864 cf::face::set_magicmap $idx, $info->{magicmap};
2865 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2866 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2212 2867
2213 sub db_sync() { 2868 cf::cede_to_tick;
2214 db_save if $dirty;
2215 undef $dirty;
2216 }
2217
2218 my $idle = Event->idle (
2219 reentrant => 0,
2220 min => 10,
2221 max => 20,
2222 repeat => 0,
2223 data => WF_AUTOCANCEL,
2224 cb => \&db_sync,
2225 );
2226
2227 sub db_dirty() {
2228 $dirty = 1;
2229 $idle->start;
2230 }
2231
2232 sub db_get($;$) {
2233 @_ >= 2
2234 ? $DB->{$_[0]}{$_[1]}
2235 : ($DB->{$_[0]} ||= { })
2236 }
2237
2238 sub db_put($$;$) {
2239 if (@_ >= 3) {
2240 $DB->{$_[0]}{$_[1]} = $_[2];
2241 } else {
2242 $DB->{$_[0]} = $_[1];
2243 }
2244 db_dirty;
2245 }
2246
2247 cf::global->attach (
2248 prio => 10000,
2249 on_cleanup => sub {
2250 db_sync;
2251 }, 2869 }
2252 );
2253}
2254 2870
2255############################################################################# 2871 while (my ($face, $info) = each %$faces) {
2256# the server's main() 2872 next unless $info->{smooth};
2873 my $idx = cf::face::find $face
2874 or next;
2875 if (my $smooth = cf::face::find $info->{smooth}) {
2876 cf::face::set_smooth $idx, $smooth;
2877 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2878 } else {
2879 warn "smooth face '$info->{smooth}' not found for face '$face'";
2880 }
2257 2881
2258sub cfg_load { 2882 cf::cede_to_tick;
2883 }
2884 }
2885
2886 {
2887 my $anims = $facedata->{animinfo};
2888
2889 while (my ($anim, $info) = each %$anims) {
2890 cf::anim::set $anim, $info->{frames}, $info->{facings};
2891 cf::cede_to_tick;
2892 }
2893
2894 cf::anim::invalidate_all; # d'oh
2895 }
2896
2897 {
2898 # TODO: for gcfclient pleasure, we should give resources
2899 # that gcfclient doesn't grok a >10000 face index.
2900 my $res = $facedata->{resource};
2901
2902 my $soundconf = delete $res->{"res/sound.conf"};
2903
2904 while (my ($name, $info) = each %$res) {
2905 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2906 my $data;
2907
2908 if ($info->{type} & 1) {
2909 # prepend meta info
2910
2911 my $meta = $enc->encode ({
2912 name => $name,
2913 %{ $info->{meta} || {} },
2914 });
2915
2916 $data = pack "(w/a*)*", $meta, $info->{data};
2917 } else {
2918 $data = $info->{data};
2919 }
2920
2921 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2922 cf::face::set_type $idx, $info->{type};
2923
2924 cf::cede_to_tick;
2925 }
2926
2927 if ($soundconf) {
2928 $soundconf = $enc->decode (delete $soundconf->{data});
2929
2930 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2931 my $sound = $soundconf->{compat}[$_]
2932 or next;
2933
2934 my $face = cf::face::find "sound/$sound->[1]";
2935 cf::sound::set $sound->[0] => $face;
2936 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2937 }
2938
2939 while (my ($k, $v) = each %{$soundconf->{event}}) {
2940 my $face = cf::face::find "sound/$v";
2941 cf::sound::set $k => $face;
2942 }
2943 }
2944 }
2945
2946 1
2947}
2948
2949register_exticmd fx_want => sub {
2950 my ($ns, $want) = @_;
2951
2952 while (my ($k, $v) = each %$want) {
2953 $ns->fx_want ($k, $v);
2954 }
2955};
2956
2957sub reload_regions {
2958 load_resource_file "$MAPDIR/regions"
2959 or die "unable to load regions file\n";
2960
2961 for (cf::region::list) {
2962 $_->{match} = qr/$_->{match}/
2963 if exists $_->{match};
2964 }
2965}
2966
2967sub reload_facedata {
2968 load_facedata "$DATADIR/facedata"
2969 or die "unable to load facedata\n";
2970}
2971
2972sub reload_archetypes {
2973 load_resource_file "$DATADIR/archetypes"
2974 or die "unable to load archetypes\n";
2975 #d# NEED to laod twice to resolve forward references
2976 # this really needs to be done in an extra post-pass
2977 # (which needs to be synchronous, so solve it differently)
2978 load_resource_file "$DATADIR/archetypes"
2979 or die "unable to load archetypes\n";
2980}
2981
2982sub reload_treasures {
2983 load_resource_file "$DATADIR/treasures"
2984 or die "unable to load treasurelists\n";
2985}
2986
2987sub reload_resources {
2988 warn "reloading resource files...\n";
2989
2990 reload_regions;
2991 reload_facedata;
2992 #reload_archetypes;#d#
2993 reload_archetypes;
2994 reload_treasures;
2995
2996 warn "finished reloading resource files\n";
2997}
2998
2999sub init {
3000 reload_resources;
3001}
3002
3003sub reload_config {
2259 open my $fh, "<:utf8", cf::confdir . "/config" 3004 open my $fh, "<:utf8", "$CONFDIR/config"
2260 or return; 3005 or return;
2261 3006
2262 local $/; 3007 local $/;
2263 *CFG = YAML::Syck::Load <$fh>; 3008 *CFG = YAML::Syck::Load <$fh>;
2264 3009
2283 (async { 3028 (async {
2284 Event::one_event; 3029 Event::one_event;
2285 })->prio (Coro::PRIO_MAX); 3030 })->prio (Coro::PRIO_MAX);
2286 }; 3031 };
2287 3032
2288 cfg_load; 3033 reload_config;
2289 db_load; 3034 db_init;
2290 load_extensions; 3035 load_extensions;
2291 3036
2292 $TICK_WATCHER->start; 3037 $TICK_WATCHER->start;
2293 Event::loop; 3038 Event::loop;
2294} 3039}
2309 }, 3054 },
2310 ); 3055 );
2311 } 3056 }
2312} 3057}
2313 3058
3059sub write_runtime {
3060 my $runtime = "$LOCALDIR/runtime";
3061
3062 # first touch the runtime file to show we are still running:
3063 # the fsync below can take a very very long time.
3064
3065 IO::AIO::aio_utime $runtime, undef, undef;
3066
3067 my $guard = cf::lock_acquire "write_runtime";
3068
3069 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3070 or return;
3071
3072 my $value = $cf::RUNTIME + 90 + 10;
3073 # 10 is the runtime save interval, for a monotonic clock
3074 # 60 allows for the watchdog to kill the server.
3075
3076 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3077 and return;
3078
3079 # always fsync - this file is important
3080 aio_fsync $fh
3081 and return;
3082
3083 # touch it again to show we are up-to-date
3084 aio_utime $fh, undef, undef;
3085
3086 close $fh
3087 or return;
3088
3089 aio_rename "$runtime~", $runtime
3090 and return;
3091
3092 warn "runtime file written.\n";
3093
3094 1
3095}
3096
2314sub emergency_save() { 3097sub emergency_save() {
2315 my $freeze_guard = cf::freeze_mainloop; 3098 my $freeze_guard = cf::freeze_mainloop;
2316 3099
2317 warn "enter emergency perl save\n"; 3100 warn "enter emergency perl save\n";
2318 3101
2333 my $map = $cf::MAP{$path} or next; 3116 my $map = $cf::MAP{$path} or next;
2334 $map->valid or next; 3117 $map->valid or next;
2335 $map->save; 3118 $map->save;
2336 } 3119 }
2337 warn "end emergency map save\n"; 3120 warn "end emergency map save\n";
3121
3122 warn "begin emergency database checkpoint\n";
3123 BDB::db_env_txn_checkpoint $DB_ENV;
3124 warn "end emergency database checkpoint\n";
2338 }; 3125 };
2339 3126
2340 warn "leave emergency perl save\n"; 3127 warn "leave emergency perl save\n";
2341} 3128}
2342 3129
3130sub post_cleanup {
3131 my ($make_core) = @_;
3132
3133 warn Carp::longmess "post_cleanup backtrace"
3134 if $make_core;
3135}
3136
2343sub reload() { 3137sub do_reload_perl() {
2344 # can/must only be called in main 3138 # can/must only be called in main
2345 if ($Coro::current != $Coro::main) { 3139 if ($Coro::current != $Coro::main) {
2346 warn "can only reload from main coroutine"; 3140 warn "can only reload from main coroutine";
2347 return; 3141 return;
2348 } 3142 }
2349 3143
2350 warn "reloading..."; 3144 warn "reloading...";
2351 3145
2352 warn "cancelling server ticker"; 3146 warn "entering sync_job";
2353 $TICK_WATCHER->cancel;
2354 3147
3148 cf::sync_job {
3149 cf::write_runtime; # external watchdog should not bark
2355 cf::emergency_save; 3150 cf::emergency_save;
3151 cf::write_runtime; # external watchdog should not bark
2356 3152
2357 eval { 3153 warn "syncing database to disk";
3154 BDB::db_env_txn_checkpoint $DB_ENV;
3155
2358 # if anything goes wrong in here, we should simply crash as we already saved 3156 # if anything goes wrong in here, we should simply crash as we already saved
2359
2360 warn "syncing database to disk";
2361 cf::db_sync;
2362 3157
2363 warn "cancelling all WF_AUTOCANCEL watchers"; 3158 warn "cancelling all WF_AUTOCANCEL watchers";
2364 for (Event::all_watchers) { 3159 for (Event::all_watchers) {
2365 $_->cancel if $_->data & WF_AUTOCANCEL; 3160 $_->cancel if $_->data & WF_AUTOCANCEL;
2366 } 3161 }
2367 3162
2368 warn "flushing outstanding aio requests"; 3163 warn "flushing outstanding aio requests";
2369 for (;;) { 3164 for (;;) {
3165 BDB::flush;
2370 IO::AIO::flush; 3166 IO::AIO::flush;
2371 Coro::cede; 3167 Coro::cede;
2372 last unless IO::AIO::nreqs; 3168 last unless IO::AIO::nreqs || BDB::nreqs;
2373 warn "iterate..."; 3169 warn "iterate...";
2374 } 3170 }
3171
3172 ++$RELOAD;
2375 3173
2376 warn "cancelling all extension coros"; 3174 warn "cancelling all extension coros";
2377 $_->cancel for values %EXT_CORO; 3175 $_->cancel for values %EXT_CORO;
2378 %EXT_CORO = (); 3176 %EXT_CORO = ();
2379 3177
2380 warn "removing commands"; 3178 warn "removing commands";
2381 %COMMAND = (); 3179 %COMMAND = ();
2382 3180
2383 warn "removing ext commands"; 3181 warn "removing ext/exti commands";
2384 %EXTCMD = (); 3182 %EXTCMD = ();
3183 %EXTICMD = ();
2385 3184
2386 warn "unloading/nuking all extensions"; 3185 warn "unloading/nuking all extensions";
2387 for my $pkg (@EXTS) { 3186 for my $pkg (@EXTS) {
2388 warn "... unloading $pkg"; 3187 warn "... unloading $pkg";
2389 3188
2419 Symbol::delete_package "safe::$_" 3218 Symbol::delete_package "safe::$_"
2420 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3219 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2421 3220
2422 warn "unloading cf.pm \"a bit\""; 3221 warn "unloading cf.pm \"a bit\"";
2423 delete $INC{"cf.pm"}; 3222 delete $INC{"cf.pm"};
3223 delete $INC{"cf/pod.pm"};
2424 3224
2425 # don't, removes xs symbols, too, 3225 # don't, removes xs symbols, too,
2426 # and global variables created in xs 3226 # and global variables created in xs
2427 #Symbol::delete_package __PACKAGE__; 3227 #Symbol::delete_package __PACKAGE__;
2428 3228
2431 warn "reloading cf.pm"; 3231 warn "reloading cf.pm";
2432 require cf; 3232 require cf;
2433 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3233 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2434 3234
2435 warn "loading config and database again"; 3235 warn "loading config and database again";
2436 cf::cfg_load; 3236 cf::reload_config;
2437 cf::db_load;
2438 3237
2439 warn "loading extensions"; 3238 warn "loading extensions";
2440 cf::load_extensions; 3239 cf::load_extensions;
2441 3240
2442 warn "reattaching attachments to objects/players"; 3241 warn "reattaching attachments to objects/players";
2443 _global_reattach; 3242 _global_reattach; # objects, sockets
2444 warn "reattaching attachments to maps"; 3243 warn "reattaching attachments to maps";
2445 reattach $_ for values %MAP; 3244 reattach $_ for values %MAP;
3245 warn "reattaching attachments to players";
3246 reattach $_ for values %PLAYER;
2446 3247
2447 warn "restarting server ticker"; 3248 warn "leaving sync_job";
2448 3249
2449 $TICK_WATCHER->start; 3250 1
2450 }; 3251 } or do {
2451
2452 if ($@) {
2453 warn $@; 3252 warn $@;
2454 warn "error while reloading, exiting."; 3253 warn "error while reloading, exiting.";
2455 exit 1; 3254 exit 1;
2456 } 3255 };
2457 3256
2458 warn "reloaded"; 3257 warn "reloaded";
2459}; 3258};
2460 3259
2461our $RELOAD_WATCHER; # used only during reload 3260our $RELOAD_WATCHER; # used only during reload
2462 3261
3262sub reload_perl() {
3263 # doing reload synchronously and two reloads happen back-to-back,
3264 # coro crashes during coro_state_free->destroy here.
3265
3266 $RELOAD_WATCHER ||= Event->timer (
3267 reentrant => 0,
3268 after => 0,
3269 data => WF_AUTOCANCEL,
3270 cb => sub {
3271 do_reload_perl;
3272 undef $RELOAD_WATCHER;
3273 },
3274 );
3275}
3276
2463register_command "reload" => sub { 3277register_command "reload" => sub {
2464 my ($who, $arg) = @_; 3278 my ($who, $arg) = @_;
2465 3279
2466 if ($who->flag (FLAG_WIZ)) { 3280 if ($who->flag (FLAG_WIZ)) {
2467 $who->message ("reloading server."); 3281 $who->message ("reloading server.");
2468 3282 async { reload_perl };
2469 # doing reload synchronously and two reloads happen back-to-back,
2470 # coro crashes during coro_state_free->destroy here.
2471
2472 $RELOAD_WATCHER ||= Event->timer (
2473 reentrant => 0,
2474 after => 0,
2475 data => WF_AUTOCANCEL,
2476 cb => sub {
2477 reload;
2478 undef $RELOAD_WATCHER;
2479 },
2480 );
2481 } 3283 }
2482}; 3284};
2483 3285
2484unshift @INC, $LIBDIR; 3286unshift @INC, $LIBDIR;
2485 3287
2486my $bug_warning = 0; 3288my $bug_warning = 0;
2487 3289
3290our @WAIT_FOR_TICK;
3291our @WAIT_FOR_TICK_BEGIN;
3292
3293sub wait_for_tick {
3294 return unless $TICK_WATCHER->is_active;
3295 return if $Coro::current == $Coro::main;
3296
3297 my $signal = new Coro::Signal;
3298 push @WAIT_FOR_TICK, $signal;
3299 $signal->wait;
3300}
3301
3302sub wait_for_tick_begin {
3303 return unless $TICK_WATCHER->is_active;
3304 return if $Coro::current == $Coro::main;
3305
3306 my $signal = new Coro::Signal;
3307 push @WAIT_FOR_TICK_BEGIN, $signal;
3308 $signal->wait;
3309}
3310
3311 my $min = 1e6;#d#
3312 my $avg = 10;
2488$TICK_WATCHER = Event->timer ( 3313$TICK_WATCHER = Event->timer (
2489 reentrant => 0, 3314 reentrant => 0,
2490 parked => 1, 3315 parked => 1,
2491 prio => 0, 3316 prio => 0,
2492 at => $NEXT_TICK || $TICK, 3317 at => $NEXT_TICK || $TICK,
2496 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3321 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2497 unless ++$bug_warning > 10; 3322 unless ++$bug_warning > 10;
2498 return; 3323 return;
2499 } 3324 }
2500 3325
2501 $NOW = Event::time; 3326 $NOW = $tick_start = Event::time;
2502 3327
2503 cf::server_tick; # one server iteration 3328 cf::server_tick; # one server iteration
3329
3330 0 && sync_job {#d#
3331 for(1..10) {
3332 my $t = Event::time;
3333 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3334 or die;
3335
3336 $map->width (50);
3337 $map->height (50);
3338 $map->alloc;
3339 $map->_load_objects ("/tmp/x.map", 1);
3340 my $t = Event::time - $t;
3341
3342 #next unless $t < 0.0013;#d#
3343 if ($t < $min) {
3344 $min = $t;
3345 }
3346 $avg = $avg * 0.99 + $t * 0.01;
3347 }
3348 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3349 exit 0;
3350 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3351 };
3352
2504 $RUNTIME += $TICK; 3353 $RUNTIME += $TICK;
2505 $NEXT_TICK += $TICK; 3354 $NEXT_TICK += $TICK;
2506 3355
2507 $WAIT_FOR_TICK->broadcast; 3356 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2508 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3357 $NEXT_RUNTIME_WRITE = $NOW + 10;
2509 3358 Coro::async_pool {
2510 Event::sweep; 3359 write_runtime
2511 Coro::cede_notself; 3360 or warn "ERROR: unable to write runtime file: $!";
3361 };
2512 3362 }
3363
2513# my $AFTER = Event::time; 3364# my $AFTER = Event::time;
2514# warn $AFTER - $NOW;#d# 3365# warn $AFTER - $NOW;#d#
2515 3366
3367 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3368 $sig->send;
3369 }
3370 while (my $sig = shift @WAIT_FOR_TICK) {
3371 $sig->send;
3372 }
3373
3374 $NOW = Event::time;
3375
2516 # if we are delayed by four ticks or more, skip them all 3376 # if we are delayed by four ticks or more, skip them all
2517 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3377 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2518 3378
2519 $TICK_WATCHER->at ($NEXT_TICK); 3379 $TICK_WATCHER->at ($NEXT_TICK);
2520 $TICK_WATCHER->start; 3380 $TICK_WATCHER->start;
3381
3382 $LOAD = ($NOW - $tick_start) / $TICK;
3383 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3384
3385 _post_tick;
3386
3387
2521 }, 3388 },
2522); 3389);
2523 3390
3391{
3392 BDB::max_poll_time $TICK * 0.1;
3393 $BDB_POLL_WATCHER = Event->io (
3394 reentrant => 0,
3395 fd => BDB::poll_fileno,
3396 poll => 'r',
3397 prio => 0,
3398 data => WF_AUTOCANCEL,
3399 cb => \&BDB::poll_cb,
3400 );
3401 BDB::min_parallel 8;
3402
3403 BDB::set_sync_prepare {
3404 my $status;
3405 my $current = $Coro::current;
3406 (
3407 sub {
3408 $status = $!;
3409 $current->ready; undef $current;
3410 },
3411 sub {
3412 Coro::schedule while defined $current;
3413 $! = $status;
3414 },
3415 )
3416 };
3417
3418 unless ($DB_ENV) {
3419 $DB_ENV = BDB::db_env_create;
3420
3421 cf::sync_job {
3422 eval {
3423 BDB::db_env_open
3424 $DB_ENV,
3425 $BDBDIR,
3426 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3427 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3428 0666;
3429
3430 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3431
3432 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3433 $DB_ENV->set_lk_detect;
3434 };
3435
3436 cf::cleanup "db_env_open(db): $@" if $@;
3437 };
3438 }
3439}
3440
3441{
3442 IO::AIO::min_parallel 8;
3443
3444 undef $Coro::AIO::WATCHER;
2524IO::AIO::max_poll_time $TICK * 0.1; 3445 IO::AIO::max_poll_time $TICK * 0.1;
2525
2526undef $Coro::AIO::WATCHER;
2527$AIO_POLL_WATCHER = Event->io ( 3446 $AIO_POLL_WATCHER = Event->io (
2528 reentrant => 0, 3447 reentrant => 0,
3448 data => WF_AUTOCANCEL,
2529 fd => IO::AIO::poll_fileno, 3449 fd => IO::AIO::poll_fileno,
2530 poll => 'r', 3450 poll => 'r',
2531 prio => 6, 3451 prio => 6,
2532 data => WF_AUTOCANCEL,
2533 cb => \&IO::AIO::poll_cb, 3452 cb => \&IO::AIO::poll_cb,
2534); 3453 );
3454}
2535 3455
2536$WRITE_RUNTIME_WATCHER = Event->timer ( 3456my $_log_backtrace;
2537 reentrant => 0, 3457
2538 data => WF_AUTOCANCEL, 3458sub _log_backtrace {
2539 after => 1, 3459 my ($msg, @addr) = @_;
2540 interval => 10, 3460
2541 prio => 6, # keep it lowest so it acts like a watchdog 3461 $msg =~ s/\n//;
2542 cb => Coro::unblock_sub { 3462
2543 write_runtime 3463 # limit the # of concurrent backtraces
2544 or warn "ERROR: unable to write runtime file: $!"; 3464 if ($_log_backtrace < 2) {
3465 ++$_log_backtrace;
3466 async {
3467 my @bt = fork_call {
3468 @addr = map { sprintf "%x", $_ } @addr;
3469 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3470 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3471 or die "addr2line: $!";
3472
3473 my @funcs;
3474 my @res = <$fh>;
3475 chomp for @res;
3476 while (@res) {
3477 my ($func, $line) = splice @res, 0, 2, ();
3478 push @funcs, "[$func] $line";
3479 }
3480
3481 @funcs
3482 };
3483
3484 LOG llevInfo, "[ABT] $msg\n";
3485 LOG llevInfo, "[ABT] $_\n" for @bt;
3486 --$_log_backtrace;
3487 };
3488 } else {
3489 LOG llevInfo, "[ABT] $msg\n";
3490 LOG llevInfo, "[ABT] [suppressed]\n";
2545 }, 3491 }
2546); 3492}
3493
3494# load additional modules
3495use cf::pod;
2547 3496
2548END { cf::emergency_save } 3497END { cf::emergency_save }
2549 3498
25501 34991
2551 3500

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines