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.191 by root, Tue Jan 23 01:05:18 2007 UTC vs.
Revision 1.344 by root, Mon Aug 27 02:43:38 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines