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.186 by root, Sat Jan 20 01:12:39 2007 UTC vs.
Revision 1.333 by root, Sun Aug 19 09:14:50 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines