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.139 by root, Fri Jan 5 19:12:03 2007 UTC vs.
Revision 1.342 by root, Sun Aug 26 15:31:02 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.3 (); 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 ();
28use Data::Dumper;
20use Digest::MD5; 29use Digest::MD5;
21use Fcntl; 30use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 31use YAML::Syck ();
32use IO::AIO 2.32 ();
24use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
25 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
26use 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
27 44
28# 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?
29$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
30 47
31$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
32 49
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 51
35our %COMMAND = (); 52our %COMMAND = ();
36our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
54
55our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
58our %EXT_CORO = (); # coroutines bound to extensions
59our %EXT_MAP = (); # pluggable maps
38 60
61our $RELOAD; # number of reloads so far
39our @EVENT; 62our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 63
42our $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(!)
43our $TICK_WATCHER; 77our $TICK_WATCHER;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 80our $NEXT_TICK;
45our $NOW; 81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $DB_ENV;
46 86
47our %CFG; 87our %CFG;
48 88
49our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 90our $RUNTIME;
51 91
92our %PLAYER; # all users
52our %MAP; # all maps 93our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 94our $LINK_MAP; # the special {link} map, which is always available
54our $RANDOM_MAPS = cf::localdir . "/random"; 95
55our %EXT_CORO; 96# used to convert map paths into valid unix filenames by replacing / by ∕
97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
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
56 102
57binmode STDOUT; 103binmode STDOUT;
58binmode STDERR; 104binmode STDERR;
59 105
60# read virtual server time, if available 106# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
63 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
64 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
65} 111}
66 112
67mkdir cf::localdir; 113mkdir $_
68mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 115
73# a special map that is always available
74our $LINK_MAP;
75our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
117
118sub cf::map::normalise;
76 119
77############################################################################# 120#############################################################################
78 121
79=head2 GLOBAL VARIABLES 122=head2 GLOBAL VARIABLES
80 123
87=item $cf::RUNTIME 130=item $cf::RUNTIME
88 131
89The 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
90every server tick. 133every server tick.
91 134
92=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
93 138
94The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 143
97=item $cf::NOW 144=item $cf::NOW
98 145
99The time of the last (current) server tick. 146The time of the last (current) server tick.
100 147
101=item $cf::TICK 148=item $cf::TICK
102 149
103The 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.
104 161
105=item %cf::CFG 162=item %cf::CFG
106 163
107Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
108from wherever your confdir points to. 165from wherever your confdir points to.
166
167=item cf::wait_for_tick, cf::wait_for_tick_begin
168
169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
170returns directly I<after> the tick processing (and consequently, can only wake one process
171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
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.
109 178
110=back 179=back
111 180
112=cut 181=cut
113 182
114BEGIN { 183BEGIN {
115 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 185 my $msg = join "", @_;
117 utf8::encode $msg;
118 186
119 $msg .= "\n" 187 $msg .= "\n"
120 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
121 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
122 LOG llevError, "cfperl: $msg"; 193 LOG llevError, $msg;
123 }; 194 };
124} 195}
125 196
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 204
133# 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
134# within the Safe compartment. 206# within the Safe compartment.
135for my $pkg (qw( 207for my $pkg (qw(
136 cf::global cf::attachable 208 cf::global cf::attachable
145 217
146$Event::DIED = sub { 218$Event::DIED = sub {
147 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
148}; 220};
149 221
150my %ext_pkg; 222#############################################################################
151my @exts;
152my @hook;
153 223
154=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
155 225
156=over 4 226=over 4
157 227
158=cut 228=item dumpval $ref
159 229
160use JSON::Syck (); # TODO# replace by JSON::PC once working 230=cut
231
232sub dumpval {
233 eval {
234 local $SIG{__DIE__};
235 my $d;
236 if (1) {
237 $d = new Data::Dumper([$_[0]], ["*var"]);
238 $d->Terse(1);
239 $d->Indent(2);
240 $d->Quotekeys(0);
241 $d->Useqq(1);
242 #$d->Bless(...);
243 $d->Seen($_[1]) if @_ > 1;
244 $d = $d->Dump();
245 }
246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
247 $d
248 } || "[unable to dump $_[0]: '$@']";
249}
161 250
162=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
163 252
164Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
165 254
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
174 256
175Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
176 258
177=cut 259=cut
178 260
179sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
181 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
182} 264sub from_json ($) { $json_coder->decode ($_[0]) }
183 265
184=item cf::lock_wait $string 266=item cf::lock_wait $string
185 267
186Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
187 269
193returned. 275returned.
194 276
195Lock 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
196uses map_find and cf::map::load uses map_load). 278uses map_find and cf::map::load uses map_load).
197 279
280=item $locked = cf::lock_active $string
281
282Return true if the lock is currently active, i.e. somebody has locked it.
283
198=cut 284=cut
199 285
200our %LOCK; 286our %LOCK;
201 287
202sub lock_wait($) { 288sub lock_wait($) {
221 # wake up all waiters, to be on the safe side 307 # wake up all waiters, to be on the safe side
222 $_->ready for @{ delete $LOCK{$key} }; 308 $_->ready for @{ delete $LOCK{$key} };
223 } 309 }
224} 310}
225 311
312sub lock_active($) {
313 my ($key) = @_;
314
315 ! ! $LOCK{$key}
316}
317
226sub freeze_mainloop { 318sub freeze_mainloop {
227 return unless $TICK_WATCHER->is_active; 319 return unless $TICK_WATCHER->is_active;
228 320
229 my $guard = Coro::guard { $TICK_WATCHER->start }; 321 my $guard = Coro::guard {
322 $TICK_WATCHER->start;
323 };
230 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
231 $guard 325 $guard
232} 326}
233 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;
382}
383
384=item cf::async { BLOCK }
385
386Currently the same as Coro::async_pool, meaning you cannot use
387C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
388thing you are allowed to do is call C<prio> on it.
389
390=cut
391
392BEGIN { *async = \&Coro::async_pool }
393
234=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
235 395
236The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
237always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
238reentrant. 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.
239 400
240If 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
241the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
242server 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
243fast or be very important. 404fast or be very important.
246 407
247sub sync_job(&) { 408sub sync_job(&) {
248 my ($job) = @_; 409 my ($job) = @_;
249 410
250 if ($Coro::current == $Coro::main) { 411 if ($Coro::current == $Coro::main) {
412 my $time = Event::time;
413
251 # this is the main coro, too bad, we have to block 414 # this is the main coro, too bad, we have to block
252 # till the operation succeeds, freezing the server :/ 415 # till the operation succeeds, freezing the server :/
253 416
254 # TODO: use suspend/resume instead 417 # TODO: use suspend/resume instead
255 # (but this is cancel-safe) 418 # (but this is cancel-safe)
256 my $freeze_guard = freeze_mainloop; 419 my $freeze_guard = freeze_mainloop;
257 420
258 my $busy = 1; 421 my $busy = 1;
259 my @res; 422 my @res;
260 423
261 (Coro::async_pool { 424 (async {
262 @res = eval { $job->() }; 425 @res = eval { $job->() };
263 warn $@ if $@; 426 warn $@ if $@;
264 undef $busy; 427 undef $busy;
265 })->prio (Coro::PRIO_MAX); 428 })->prio (Coro::PRIO_MAX);
266 429
267 while ($busy) { 430 while ($busy) {
268 unless (Coro::cede) { 431 Coro::cede or Event::one_event;
269 Coro::nready ? Event::one_event 0 : Event::one_event;
270 Coro::cede_notself unless Coro::cede;
271 } 432 }
272 } 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
273 440
274 wantarray ? @res : $res[0] 441 wantarray ? @res : $res[0]
275 } else { 442 } else {
276 # we are in another coroutine, how wonderful, everything just works 443 # we are in another coroutine, how wonderful, everything just works
277 444
278 $job->() 445 $job->()
279 } 446 }
280} 447}
281 448
282=item $coro = cf::coro { BLOCK } 449=item $coro = cf::async_ext { BLOCK }
283 450
284Creates (and readies) and returns a new coro. This coro is automcatially 451Like async, but this coro is automatically being canceled when the
285being canceled when the extension calling this is being unloaded. 452extension calling this is being unloaded.
286 453
287=cut 454=cut
288 455
289sub coro(&) { 456sub async_ext(&) {
290 my $cb = shift; 457 my $cb = shift;
291 458
292 my $coro = &Coro::async_pool ($cb); 459 my $coro = &Coro::async ($cb);
293 460
294 $coro->on_destroy (sub { 461 $coro->on_destroy (sub {
295 delete $EXT_CORO{$coro+0}; 462 delete $EXT_CORO{$coro+0};
296 }); 463 });
297 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
298 465
299 $coro 466 $coro
300} 467}
301 468
302sub write_runtime { 469=item fork_call { }, $args
303 my $runtime = cf::localdir . "/runtime";
304 470
305 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 471Executes the given code block with the given arguments in a seperate
306 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.
307 475
308 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 476=cut
309 (aio_write $fh, 0, (length $value), $value, 0) <= 0
310 and return;
311 477
312 aio_fsync $fh 478sub fork_call(&@) {
313 and return; 479 my ($cb, @args) = @_;
314 480
315 close $fh 481 # we seemingly have to make a local copy of the whole thing,
316 or return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
317 484
318 aio_rename "$runtime~", $runtime 485 my @res = Coro::Util::fork_eval {
319 and return; 486 reset_signals;
487 &$cb
488 }, @args;
320 489
490 wantarray ? @res : $res[-1]
491}
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 };
321 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 });
322} 618}
323 619
324=back 620=back
325 621
326=cut 622=cut
327
328#############################################################################
329
330package cf::path;
331
332sub new {
333 my ($class, $path, $base) = @_;
334
335 $path = $path->as_string if ref $path;
336
337 my $self = bless { }, $class;
338
339 # {... are special paths that are not touched
340 # ?xxx/... are special absolute paths
341 # ?random/... random maps
342 # /! non-realised random map exit
343 # /... normal maps
344 # ~/... per-player maps without a specific player (DO NOT USE)
345 # ~user/... per-player map of a specific user
346
347 if ($path =~ /^{/) {
348 # fine as it is
349 } elsif ($path =~ s{^\?random/}{}) {
350 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
351 $self->{random} = cf::from_json $data;
352 } else {
353 if ($path =~ s{^~([^/]+)?}{}) {
354 $self->{user_rel} = 1;
355
356 if (defined $1) {
357 $self->{user} = $1;
358 } elsif ($base =~ m{^~([^/]+)/}) {
359 $self->{user} = $1;
360 } else {
361 warn "cannot resolve user-relative path without user <$path,$base>\n";
362 }
363 } elsif ($path =~ /^\//) {
364 # already absolute
365 } else {
366 $base =~ s{[^/]+/?$}{};
367 return $class->new ("$base/$path");
368 }
369
370 for ($path) {
371 redo if s{/\.?/}{/};
372 redo if s{/[^/]+/\.\./}{/};
373 }
374 }
375
376 $self->{path} = $path;
377
378 $self
379}
380
381# the name / primary key / in-game path
382sub as_string {
383 my ($self) = @_;
384
385 $self->{user_rel} ? "~$self->{user}$self->{path}"
386 : $self->{random} ? "?random/$self->{path}"
387 : $self->{path}
388}
389
390# the displayed name, this is a one way mapping
391sub visible_name {
392 my ($self) = @_;
393
394# if (my $rmp = $self->{random}) {
395# # todo: be more intelligent about this
396# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
397# } else {
398 $self->as_string
399# }
400}
401
402# escape the /'s in the path
403sub _escaped_path {
404 # ∕ is U+2215
405 (my $path = $_[0]{path}) =~ s/\//∕/g;
406 $path
407}
408
409# the original (read-only) location
410sub load_path {
411 my ($self) = @_;
412
413 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
414}
415
416# the temporary/swap location
417sub save_path {
418 my ($self) = @_;
419
420 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
421 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
422 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
423}
424
425# the unique path, might be eq to save_path
426sub uniq_path {
427 my ($self) = @_;
428
429 $self->{user_rel} || $self->{random}
430 ? undef
431 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
432}
433
434# return random map parameters, or undef
435sub random_map_params {
436 my ($self) = @_;
437
438 $self->{random}
439}
440
441# this is somewhat ugly, but style maps do need special treatment
442sub is_style_map {
443 $_[0]{path} =~ m{^/styles/}
444}
445
446package cf;
447 623
448############################################################################# 624#############################################################################
449 625
450=head2 ATTACHABLE OBJECTS 626=head2 ATTACHABLE OBJECTS
451 627
453attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
455 631
456In 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>
457C<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
458crossfire+). 634Crossfire TRT).
459 635
460=over 4 636=over 4
461 637
462=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
463 639
577our @CB_TYPE = (); # registry for type (cf-object class) based events 753our @CB_TYPE = (); # registry for type (cf-object class) based events
578our @CB_MAP = (); 754our @CB_MAP = ();
579 755
580my %attachment; 756my %attachment;
581 757
758sub cf::attachable::thawer_merge {
759 # simply override everything except _meta
760 local $_[0]{_meta};
761 %{$_[0]} = %{$_[1]};
762}
763
582sub _attach_cb($$$$) { 764sub _attach_cb($$$$) {
583 my ($registry, $event, $prio, $cb) = @_; 765 my ($registry, $event, $prio, $cb) = @_;
584 766
585 use sort 'stable'; 767 use sort 'stable';
586 768
620 $registry = $CB_TYPE[$object_type] ||= []; 802 $registry = $CB_TYPE[$object_type] ||= [];
621 803
622 } elsif ($type eq "subtype") { 804 } elsif ($type eq "subtype") {
623 defined $object_type or Carp::croak "subtype specified without type"; 805 defined $object_type or Carp::croak "subtype specified without type";
624 my $object_subtype = shift @arg; 806 my $object_subtype = shift @arg;
625 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 807 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
626 808
627 } elsif ($type eq "package") { 809 } elsif ($type eq "package") {
628 my $pkg = shift @arg; 810 my $pkg = shift @arg;
629 811
630 while (my ($name, $id) = each %cb_id) { 812 while (my ($name, $id) = each %cb_id) {
659 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
660 } 842 }
661 843
662 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
663 } else { 845 } else {
664 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
665 } 847 }
666 848
667 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
668} 850}
669 851
671 if (ref $_[0]) { 853 if (ref $_[0]) {
672 _object_attach @_; 854 _object_attach @_;
673 } else { 855 } else {
674 _attach shift->_attach_registry, @_; 856 _attach shift->_attach_registry, @_;
675 } 857 }
858 _recalc_want;
676}; 859};
677 860
678# all those should be optimised 861# all those should be optimised
679sub cf::attachable::detach { 862sub cf::attachable::detach {
680 my ($obj, $name) = @_; 863 my ($obj, $name) = @_;
683 delete $obj->{_attachment}{$name}; 866 delete $obj->{_attachment}{$name};
684 reattach ($obj); 867 reattach ($obj);
685 } else { 868 } else {
686 Carp::croak "cannot, currently, detach class attachments"; 869 Carp::croak "cannot, currently, detach class attachments";
687 } 870 }
871 _recalc_want;
688}; 872};
689 873
690sub cf::attachable::attached { 874sub cf::attachable::attached {
691 my ($obj, $name) = @_; 875 my ($obj, $name) = @_;
692 876
707 "; 891 ";
708 die if $@; 892 die if $@;
709} 893}
710 894
711our $override; 895our $override;
712our @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?
713 897
714sub override { 898sub override {
715 $override = 1; 899 $override = 1;
716 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
717} 901}
718 902
719sub do_invoke { 903sub do_invoke {
720 my $event = shift; 904 my $event = shift;
721 my $callbacks = shift; 905 my $callbacks = shift;
722 906
723 @invoke_results = (); 907 @INVOKE_RESULTS = ();
724 908
725 local $override; 909 local $override;
726 910
727 for (@$callbacks) { 911 for (@$callbacks) {
728 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
745 929
746Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
747 931
748This 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
749removed 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
750results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
751 935
752=back 936=back
753 937
754=cut 938=cut
755 939
756############################################################################# 940#############################################################################
757# 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}
758 953
759sub reattach { 954sub reattach {
760 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
761 my ($obj) = @_; 956 my ($obj) = @_;
957
958 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
762 959
763 my $registry = $obj->registry; 960 my $registry = $obj->registry;
764 961
765 @$registry = (); 962 @$registry = ();
766 963
813 $filename, length $$rdata, scalar @$objs; 1010 $filename, length $$rdata, scalar @$objs;
814 1011
815 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1012 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
816 chmod SAVE_MODE, $fh; 1013 chmod SAVE_MODE, $fh;
817 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1014 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
818 aio_fsync $fh; 1015 aio_fsync $fh if $cf::USE_FSYNC;
819 close $fh; 1016 close $fh;
820 1017
821 if (@$objs) { 1018 if (@$objs) {
822 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) {
823 chmod SAVE_MODE, $fh; 1020 chmod SAVE_MODE, $fh;
824 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1021 my $data = Storable::nfreeze { version => 1, objs => $objs };
825 aio_write $fh, 0, (length $data), $data, 0; 1022 aio_write $fh, 0, (length $data), $data, 0;
826 aio_fsync $fh; 1023 aio_fsync $fh if $cf::USE_FSYNC;
827 close $fh; 1024 close $fh;
828 aio_rename "$filename.pst~", "$filename.pst"; 1025 aio_rename "$filename.pst~", "$filename.pst";
829 } 1026 }
830 } else { 1027 } else {
831 aio_unlink "$filename.pst"; 1028 aio_unlink "$filename.pst";
863 or return; 1060 or return;
864 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
865 } 1062 }
866 1063
867 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
868 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
869 return ($data, $av); 1066 return ($data, $av);
870} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
871 1074
872############################################################################# 1075#############################################################################
873# command handling &c 1076# command handling &c
874 1077
875=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
888 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
889} 1092}
890 1093
891=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
892 1095
893Register 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.
894 1101
895If 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
896called. 1103called.
897 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
898=cut 1116=cut
899 1117
900sub register_extcmd { 1118sub register_extcmd {
901 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
902 1120
903 my $caller = caller;
904 #warn "registering extcmd '$name' to '$caller'";
905
906 $EXTCMD{$name} = [$cb, $caller]; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
907} 1128}
908 1129
909cf::player->attach ( 1130cf::player->attach (
910 on_command => sub { 1131 on_command => sub {
911 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
920 cf::override; 1141 cf::override;
921 }, 1142 },
922 on_extcmd => sub { 1143 on_extcmd => sub {
923 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
924 1145
925 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
926 1147
927 if (ref $msg) { 1148 if (ref $msg) {
1149 my ($type, $reply, @payload) =
1150 "ARRAY" eq ref $msg
1151 ? @$msg
1152 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1153
1154 my @reply;
1155
928 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1156 if (my $cb = $EXTCMD{$type}) {
929 if (my %reply = $cb->[0]->($pl, $msg)) { 1157 @reply = $cb->($pl, @payload);
930 $pl->ext_reply ($msg->{msgid}, %reply);
931 }
932 } 1158 }
1159
1160 $pl->ext_reply ($reply, @reply)
1161 if $reply;
1162
933 } else { 1163 } else {
934 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1164 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
935 } 1165 }
936 1166
937 cf::override; 1167 cf::override;
938 }, 1168 },
939); 1169);
940 1170
941sub register {
942 my ($base, $pkg) = @_;
943
944 #TODO
945}
946
947sub load_extension { 1171sub load_extensions {
1172 cf::sync_job {
1173 my %todo;
1174
1175 for my $path (<$LIBDIR/*.ext>) {
1176 next unless -r $path;
1177
1178 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1179 my $base = $1;
1180 my $pkg = $1;
1181 $pkg =~ s/[^[:word:]]/_/g;
1182 $pkg = "ext::$pkg";
1183
1184 open my $fh, "<:utf8", $path
1185 or die "$path: $!";
1186
1187 my $source = do { local $/; <$fh> };
1188
1189 my %ext = (
1190 path => $path,
1191 base => $base,
1192 pkg => $pkg,
1193 );
1194
1195 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1196 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1197
1198 $ext{source} =
1199 "package $pkg; use strict; use utf8;\n"
1200 . "#line 1 \"$path\"\n{\n"
1201 . $source
1202 . "\n};\n1";
1203
1204 $todo{$base} = \%ext;
1205 }
1206
1207 my %done;
1208 while (%todo) {
1209 my $progress;
1210
1211 while (my ($k, $v) = each %todo) {
1212 for (split /,\s*/, $v->{meta}{depends}) {
1213 goto skip
1214 unless exists $done{$_};
1215 }
1216
1217 warn "... loading '$k' into '$v->{pkg}'\n";
1218
1219 unless (eval $v->{source}) {
1220 my $msg = $@ ? "$v->{path}: $@\n"
1221 : "$v->{base}: extension inactive.\n";
1222
1223 if (exists $v->{meta}{mandatory}) {
1224 warn $msg;
1225 warn "mandatory extension failed to load, exiting.\n";
1226 exit 1;
1227 }
1228
1229 warn $msg;
1230 }
1231
1232 $done{$k} = delete $todo{$k};
1233 push @EXTS, $v->{pkg};
1234 $progress = 1;
1235 }
1236
1237 skip:
1238 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1239 unless $progress;
1240 }
1241 };
1242}
1243
1244#############################################################################
1245
1246=back
1247
1248=head2 CORE EXTENSIONS
1249
1250Functions and methods that extend core crossfire objects.
1251
1252=cut
1253
1254package cf::player;
1255
1256use Coro::AIO;
1257
1258=head3 cf::player
1259
1260=over 4
1261
1262=item cf::player::find $login
1263
1264Returns the given player object, loading it if necessary (might block).
1265
1266=cut
1267
1268sub playerdir($) {
1269 "$PLAYERDIR/"
1270 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1271}
1272
1273sub path($) {
1274 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1275
1276 (playerdir $login) . "/playerdata"
1277}
1278
1279sub find_active($) {
1280 $cf::PLAYER{$_[0]}
1281 and $cf::PLAYER{$_[0]}->active
1282 and $cf::PLAYER{$_[0]}
1283}
1284
1285sub exists($) {
1286 my ($login) = @_;
1287
1288 $cf::PLAYER{$login}
1289 or cf::sync_job { !aio_stat path $login }
1290}
1291
1292sub find($) {
1293 return $cf::PLAYER{$_[0]} || do {
1294 my $login = $_[0];
1295
1296 my $guard = cf::lock_acquire "user_find:$login";
1297
1298 $cf::PLAYER{$_[0]} || do {
1299 # rename old playerfiles to new ones
1300 #TODO: remove when no longer required
1301 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1302 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1303 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1304 aio_unlink +(playerdir $login) . "/$login.pl";
1305
1306 my $pl = load_pl path $login
1307 or return;
1308 $cf::PLAYER{$login} = $pl
1309 }
1310 }
1311}
1312
1313sub save($) {
1314 my ($pl) = @_;
1315
1316 return if $pl->{deny_save};
1317
1318 my $path = path $pl;
1319 my $guard = cf::lock_acquire "user_save:$path";
1320
1321 return if $pl->{deny_save};
1322
1323 aio_mkdir playerdir $pl, 0770;
1324 $pl->{last_save} = $cf::RUNTIME;
1325
1326 $pl->save_pl ($path);
1327 Coro::cede;
1328}
1329
1330sub new($) {
1331 my ($login) = @_;
1332
1333 my $self = create;
1334
1335 $self->ob->name ($login);
1336 $self->{deny_save} = 1;
1337
1338 $cf::PLAYER{$login} = $self;
1339
1340 $self
1341}
1342
1343=item $player->send_msg ($channel, $msg, $color, [extra...])
1344
1345=cut
1346
1347sub send_msg {
1348 my $ns = shift->ns
1349 or return;
1350 $ns->send_msg (@_);
1351}
1352
1353=item $pl->quit_character
1354
1355Nukes the player without looking back. If logged in, the connection will
1356be destroyed. May block for a long time.
1357
1358=cut
1359
1360sub quit_character {
1361 my ($pl) = @_;
1362
1363 my $name = $pl->ob->name;
1364
1365 $pl->{deny_save} = 1;
1366 $pl->password ("*"); # this should lock out the player until we nuked the dir
1367
1368 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1369 $pl->deactivate;
1370 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1371 $pl->ns->destroy if $pl->ns;
1372
1373 my $path = playerdir $pl;
1374 my $temp = "$path~$cf::RUNTIME~deleting~";
1375 aio_rename $path, $temp;
1376 delete $cf::PLAYER{$pl->ob->name};
1377 $pl->destroy;
1378
1379 my $prefix = qr<^~\Q$name\E/>;
1380
1381 # nuke player maps
1382 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1383
1384 IO::AIO::aio_rmtree $temp;
1385}
1386
1387=item $pl->kick
1388
1389Kicks a player out of the game. This destroys the connection.
1390
1391=cut
1392
1393sub kick {
1394 my ($pl, $kicker) = @_;
1395
1396 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1397 $pl->killer ("kicked");
1398 $pl->ns->destroy;
1399}
1400
1401=item cf::player::list_logins
1402
1403Returns am arrayref of all valid playernames in the system, can take a
1404while and may block, so not sync_job-capable, ever.
1405
1406=cut
1407
1408sub list_logins {
1409 my $dirs = aio_readdir $PLAYERDIR
1410 or return [];
1411
1412 my @logins;
1413
1414 for my $login (@$dirs) {
1415 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1416 aio_read $fh, 0, 512, my $buf, 0 or next;
1417 $buf !~ /^password -------------$/m or next; # official not-valid tag
1418
1419 utf8::decode $login;
1420 push @logins, $login;
1421 }
1422
1423 \@logins
1424}
1425
1426=item $player->maps
1427
1428Returns an arrayref of map paths that are private for this
1429player. May block.
1430
1431=cut
1432
1433sub maps($) {
1434 my ($pl) = @_;
1435
1436 $pl = ref $pl ? $pl->ob->name : $pl;
1437
1438 my $files = aio_readdir playerdir $pl
1439 or return;
1440
1441 my @paths;
1442
1443 for (@$files) {
1444 utf8::decode $_;
1445 next if /\.(?:pl|pst)$/;
1446 next unless /^$PATH_SEP/o;
1447
1448 push @paths, cf::map::normalise "~$pl/$_";
1449 }
1450
1451 \@paths
1452}
1453
1454=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1455
1456Expand crossfire pod fragments into protocol xml.
1457
1458=cut
1459
1460sub expand_cfpod {
1461 ((my $self), (local $_)) = @_;
1462
1463 # escape & and <
1464 s/&/&amp;/g;
1465 s/(?<![BIUGH])</&lt;/g;
1466
1467 # this is buggy, it needs to properly take care of nested <'s
1468
1469 1 while
1470 # replace B<>, I<>, U<> etc.
1471 s/B<([^\>]*)>/<b>$1<\/b>/
1472 || s/I<([^\>]*)>/<i>$1<\/i>/
1473 || s/U<([^\>]*)>/<u>$1<\/u>/
1474 # replace G<male|female> tags
1475 || s{G<([^>|]*)\|([^>]*)>}{
1476 $self->gender ? $2 : $1
1477 }ge
1478 # replace H<hint text>
1479 || s{H<([^\>]*)>}
1480 {
1481 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1482 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1483 "")
1484 [$self->{hintmode}]
1485 }ge;
1486
1487 # create single paragraphs (very hackish)
1488 s/(?<=\S)\n(?=\w)/ /g;
1489
1490 # compress some whitespace
1491 s/\s+\n/\n/g; # ws line-ends
1492 s/\n\n+/\n/g; # double lines
1493 s/^\n+//; # beginning lines
1494 s/\n+$//; # ending lines
1495
1496 $_
1497}
1498
1499sub hintmode {
1500 $_[0]{hintmode} = $_[1] if @_ > 1;
1501 $_[0]{hintmode}
1502}
1503
1504=item $player->ext_reply ($msgid, @msg)
1505
1506Sends an ext reply to the player.
1507
1508=cut
1509
1510sub ext_reply($$@) {
1511 my ($self, $id, @msg) = @_;
1512
1513 $self->ns->ext_reply ($id, @msg)
1514}
1515
1516=item $player->ext_msg ($type, @msg)
1517
1518Sends an ext event to the client.
1519
1520=cut
1521
1522sub ext_msg($$@) {
1523 my ($self, $type, @msg) = @_;
1524
1525 $self->ns->ext_msg ($type, @msg);
1526}
1527
1528=head3 cf::region
1529
1530=over 4
1531
1532=cut
1533
1534package cf::region;
1535
1536=item cf::region::find_by_path $path
1537
1538Tries to decuce the likely region for a map knowing only its path.
1539
1540=cut
1541
1542sub find_by_path($) {
948 my ($path) = @_; 1543 my ($path) = @_;
949 1544
950 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1545 my ($match, $specificity);
951 my $base = $1;
952 my $pkg = $1;
953 $pkg =~ s/[^[:word:]]/_/g;
954 $pkg = "ext::$pkg";
955 1546
956 warn "loading '$path' into '$pkg'\n"; 1547 for my $region (list) {
957 1548 if ($region->{match} && $path =~ $region->{match}) {
958 open my $fh, "<:utf8", $path 1549 ($match, $specificity) = ($region, $region->specificity)
959 or die "$path: $!"; 1550 if $region->specificity > $specificity;
960 1551 }
961 my $source =
962 "package $pkg; use strict; use utf8;\n"
963 . "#line 1 \"$path\"\n{\n"
964 . (do { local $/; <$fh> })
965 . "\n};\n1";
966
967 eval $source
968 or die $@ ? "$path: $@\n"
969 : "extension disabled.\n";
970
971 push @exts, $pkg;
972 $ext_pkg{$base} = $pkg;
973
974# no strict 'refs';
975# @{"$pkg\::ISA"} = ext::;
976
977 register $base, $pkg;
978}
979
980sub unload_extension {
981 my ($pkg) = @_;
982
983 warn "removing extension $pkg\n";
984
985 # remove hooks
986 #TODO
987# for my $idx (0 .. $#PLUGIN_EVENT) {
988# delete $hook[$idx]{$pkg};
989# } 1552 }
990 1553
991 # remove commands 1554 $match
992 for my $name (keys %COMMAND) {
993 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
994
995 if (@cb) {
996 $COMMAND{$name} = \@cb;
997 } else {
998 delete $COMMAND{$name};
999 }
1000 }
1001
1002 # remove extcmds
1003 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1004 delete $EXTCMD{$name};
1005 }
1006
1007 if (my $cb = $pkg->can ("unload")) {
1008 eval {
1009 $cb->($pkg);
1010 1
1011 } or warn "$pkg unloaded, but with errors: $@";
1012 }
1013
1014 Symbol::delete_package $pkg;
1015}
1016
1017sub load_extensions {
1018 for my $ext (<$LIBDIR/*.ext>) {
1019 next unless -r $ext;
1020 eval {
1021 load_extension $ext;
1022 1
1023 } or warn "$ext not loaded: $@";
1024 }
1025}
1026
1027#############################################################################
1028# load/save/clean perl data associated with a map
1029
1030*cf::mapsupport::on_clean = sub {
1031 my ($map) = @_;
1032
1033 my $path = $map->tmpname;
1034 defined $path or return;
1035
1036 unlink "$path.pst";
1037};
1038
1039cf::map->attach (prio => -10000, package => cf::mapsupport::);
1040
1041#############################################################################
1042# load/save perl data associated with player->ob objects
1043
1044sub all_objects(@) {
1045 @_, map all_objects ($_->inv), @_
1046}
1047
1048# TODO: compatibility cruft, remove when no longer needed
1049cf::player->attach (
1050 on_load => sub {
1051 my ($pl, $path) = @_;
1052
1053 for my $o (all_objects $pl->ob) {
1054 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1055 $o->set_ob_key_value ("_perl_data");
1056
1057 %$o = %{ Storable::thaw pack "H*", $value };
1058 }
1059 }
1060 },
1061);
1062
1063#############################################################################
1064
1065=head2 CORE EXTENSIONS
1066
1067Functions and methods that extend core crossfire objects.
1068
1069=head3 cf::player
1070
1071=over 4
1072
1073=item cf::player::exists $login
1074
1075Returns true when the given account exists.
1076
1077=cut
1078
1079sub cf::player::exists($) {
1080 cf::player::find $_[0]
1081 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1082}
1083
1084=item $player->ext_reply ($msgid, $msgtype, %msg)
1085
1086Sends an ext reply to the player.
1087
1088=cut
1089
1090sub cf::player::ext_reply($$$%) {
1091 my ($self, $id, %msg) = @_;
1092
1093 $msg{msgid} = $id;
1094
1095 $self->send ("ext " . to_json \%msg);
1096} 1555}
1097 1556
1098=back 1557=back
1099
1100 1558
1101=head3 cf::map 1559=head3 cf::map
1102 1560
1103=over 4 1561=over 4
1104 1562
1107package cf::map; 1565package cf::map;
1108 1566
1109use Fcntl; 1567use Fcntl;
1110use Coro::AIO; 1568use Coro::AIO;
1111 1569
1570use overload
1571 '""' => \&as_string,
1572 fallback => 1;
1573
1112our $MAX_RESET = 3600; 1574our $MAX_RESET = 3600;
1113our $DEFAULT_RESET = 3000; 1575our $DEFAULT_RESET = 3000;
1114 1576
1115sub generate_random_map { 1577sub generate_random_map {
1116 my ($path, $rmp) = @_; 1578 my ($self, $rmp) = @_;
1117
1118 # mit "rum" bekleckern, nicht 1579 # mit "rum" bekleckern, nicht
1119 cf::map::_create_random_map 1580 $self->_create_random_map (
1120 $path,
1121 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1581 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1122 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1582 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1123 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1583 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1124 $rmp->{exit_on_final_map}, 1584 $rmp->{exit_on_final_map},
1125 $rmp->{xsize}, $rmp->{ysize}, 1585 $rmp->{xsize}, $rmp->{ysize},
1126 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1586 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1127 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1587 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1128 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1588 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1129 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1589 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1130 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1590 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1131 (cf::region::find $rmp->{region}) 1591 (cf::region::find $rmp->{region}), $rmp->{custom}
1592 )
1593}
1594
1595=item cf::map->register ($regex, $prio)
1596
1597Register a handler for the map path matching the given regex at the
1598givne priority (higher is better, built-in handlers have priority 0, the
1599default).
1600
1601=cut
1602
1603sub register {
1604 my (undef, $regex, $prio) = @_;
1605 my $pkg = caller;
1606
1607 no strict;
1608 push @{"$pkg\::ISA"}, __PACKAGE__;
1609
1610 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1611}
1612
1613# also paths starting with '/'
1614$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1615
1616sub thawer_merge {
1617 my ($self, $merge) = @_;
1618
1619 # we have to keep some variables in memory intact
1620 local $self->{path};
1621 local $self->{load_path};
1622
1623 $self->SUPER::thawer_merge ($merge);
1624}
1625
1626sub normalise {
1627 my ($path, $base) = @_;
1628
1629 $path = "$path"; # make sure its a string
1630
1631 $path =~ s/\.map$//;
1632
1633 # map plan:
1634 #
1635 # /! non-realised random map exit (special hack!)
1636 # {... are special paths that are not being touched
1637 # ?xxx/... are special absolute paths
1638 # ?random/... random maps
1639 # /... normal maps
1640 # ~user/... per-player map of a specific user
1641
1642 $path =~ s/$PATH_SEP/\//go;
1643
1644 # treat it as relative path if it starts with
1645 # something that looks reasonable
1646 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1647 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1648
1649 $base =~ s{[^/]+/?$}{};
1650 $path = "$base/$path";
1651 }
1652
1653 for ($path) {
1654 redo if s{//}{/};
1655 redo if s{/\.?/}{/};
1656 redo if s{/[^/]+/\.\./}{/};
1657 }
1658
1659 $path
1660}
1661
1662sub new_from_path {
1663 my (undef, $path, $base) = @_;
1664
1665 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1666
1667 $path = normalise $path, $base;
1668
1669 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1670 if ($path =~ $EXT_MAP{$pkg}[1]) {
1671 my $self = bless cf::map::new, $pkg;
1672 $self->{path} = $path; $self->path ($path);
1673 $self->init; # pass $1 etc.
1674 return $self;
1675 }
1676 }
1677
1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1679 ()
1680}
1681
1682sub init {
1683 my ($self) = @_;
1684
1685 $self
1686}
1687
1688sub as_string {
1689 my ($self) = @_;
1690
1691 "$self->{path}"
1692}
1693
1694# the displayed name, this is a one way mapping
1695sub visible_name {
1696 &as_string
1697}
1698
1699# the original (read-only) location
1700sub load_path {
1701 my ($self) = @_;
1702
1703 "$MAPDIR/$self->{path}.map"
1704}
1705
1706# the temporary/swap location
1707sub save_path {
1708 my ($self) = @_;
1709
1710 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1711 "$TMPDIR/$path.map"
1712}
1713
1714# the unique path, undef == no special unique path
1715sub uniq_path {
1716 my ($self) = @_;
1717
1718 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1719 "$UNIQUEDIR/$path"
1132} 1720}
1133 1721
1134# and all this just because we cannot iterate over 1722# and all this just because we cannot iterate over
1135# all maps in C++... 1723# all maps in C++...
1136sub change_all_map_light { 1724sub change_all_map_light {
1138 1726
1139 $_->change_map_light ($change) 1727 $_->change_map_light ($change)
1140 for grep $_->outdoor, values %cf::MAP; 1728 for grep $_->outdoor, values %cf::MAP;
1141} 1729}
1142 1730
1731sub decay_objects {
1732 my ($self) = @_;
1733
1734 return if $self->{deny_reset};
1735
1736 $self->do_decay_objects;
1737}
1738
1739sub unlink_save {
1740 my ($self) = @_;
1741
1742 utf8::encode (my $save = $self->save_path);
1743 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1744 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1745}
1746
1143sub try_load_header($) { 1747sub load_header_from($) {
1144 my ($path) = @_; 1748 my ($self, $path) = @_;
1145 1749
1146 utf8::encode $path; 1750 utf8::encode $path;
1147 aio_open $path, O_RDONLY, 0 1751 #aio_open $path, O_RDONLY, 0
1752 # or return;
1753
1754 $self->_load_header ($path)
1148 or return; 1755 or return;
1149 1756
1150 my $map = cf::map::new 1757 $self->{load_path} = $path;
1758
1759 1
1760}
1761
1762sub load_header_orig {
1763 my ($self) = @_;
1764
1765 $self->load_header_from ($self->load_path)
1766}
1767
1768sub load_header_temp {
1769 my ($self) = @_;
1770
1771 $self->load_header_from ($self->save_path)
1772}
1773
1774sub prepare_temp {
1775 my ($self) = @_;
1776
1777 $self->last_access ((delete $self->{last_access})
1778 || $cf::RUNTIME); #d#
1779 # safety
1780 $self->{instantiate_time} = $cf::RUNTIME
1781 if $self->{instantiate_time} > $cf::RUNTIME;
1782}
1783
1784sub prepare_orig {
1785 my ($self) = @_;
1786
1787 $self->{load_original} = 1;
1788 $self->{instantiate_time} = $cf::RUNTIME;
1789 $self->last_access ($cf::RUNTIME);
1790 $self->instantiate;
1791}
1792
1793sub load_header {
1794 my ($self) = @_;
1795
1796 if ($self->load_header_temp) {
1797 $self->prepare_temp;
1798 } else {
1799 $self->load_header_orig
1151 or return; 1800 or return;
1801 $self->prepare_orig;
1802 }
1152 1803
1153 # for better error messages only, will be overwritten 1804 $self->{deny_reset} = 1
1154 $map->path ($path); 1805 if $self->no_reset;
1155 1806
1156 $map->load_header ($path) 1807 $self->default_region (cf::region::find_by_path $self->{path})
1157 or return; 1808 unless $self->default_region;
1158 1809
1159 $map->{load_path} = $path; 1810 1
1160
1161 $map
1162} 1811}
1163 1812
1164sub find; 1813sub find;
1165sub find { 1814sub find {
1166 my ($path, $origin) = @_; 1815 my ($path, $origin) = @_;
1167 1816
1168 #warn "find<$path,$origin>\n";#d#
1169
1170 $path = new cf::path $path, $origin && $origin->path; 1817 $path = normalise $path, $origin && $origin->path;
1171 my $key = $path->as_string;
1172 1818
1173 cf::lock_wait "map_find:$key"; 1819 cf::lock_wait "map_find:$path";
1174 1820
1175 $cf::MAP{$key} || do { 1821 $cf::MAP{$path} || do {
1176 my $guard = cf::lock_acquire "map_find:$key"; 1822 my $guard = cf::lock_acquire "map_find:$path";
1177 1823 my $map = new_from_path cf::map $path
1178 # do it the slow way
1179 my $map = try_load_header $path->save_path;
1180
1181 Coro::cede;
1182
1183 if ($map) {
1184 $map->last_access ((delete $map->{last_access})
1185 || $cf::RUNTIME); #d#
1186 # safety
1187 $map->{instantiate_time} = $cf::RUNTIME
1188 if $map->{instantiate_time} > $cf::RUNTIME;
1189 } else {
1190 if (my $rmp = $path->random_map_params) {
1191 $map = generate_random_map $key, $rmp;
1192 } else {
1193 $map = try_load_header $path->load_path;
1194 }
1195
1196 $map or return; 1824 or return;
1197 1825
1198 $map->{load_original} = 1;
1199 $map->{instantiate_time} = $cf::RUNTIME;
1200 $map->last_access ($cf::RUNTIME);
1201 $map->instantiate;
1202
1203 # per-player maps become, after loading, normal maps
1204 $map->per_player (0) if $path->{user_rel};
1205 }
1206
1207 $map->path ($key);
1208 $map->{path} = $path;
1209 $map->{last_save} = $cf::RUNTIME; 1826 $map->{last_save} = $cf::RUNTIME;
1210 1827
1211 Coro::cede; 1828 $map->load_header
1829 or return;
1212 1830
1213 if ($map->should_reset) { 1831 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1832 # doing this can freeze the server in a sync job, obviously
1833 #$cf::WAIT_FOR_TICK->wait;
1214 $map->reset; 1834 $map->reset;
1215 undef $guard; 1835 undef $guard;
1216 $map = find $path 1836 return find $path;
1217 or return;
1218 } 1837 }
1219 1838
1220 $cf::MAP{$key} = $map 1839 $cf::MAP{$path} = $map
1221 } 1840 }
1222} 1841}
1842
1843sub pre_load { }
1844sub post_load { }
1223 1845
1224sub load { 1846sub load {
1225 my ($self) = @_; 1847 my ($self) = @_;
1226 1848
1849 local $self->{deny_reset} = 1; # loading can take a long time
1850
1227 my $path = $self->{path}; 1851 my $path = $self->{path};
1852
1853 {
1228 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1854 my $guard = cf::lock_acquire "map_load:$path";
1229 1855
1230 return if $self->in_memory != cf::MAP_SWAPPED; 1856 return if $self->in_memory != cf::MAP_SWAPPED;
1231 1857
1232 $self->in_memory (cf::MAP_LOADING); 1858 $self->in_memory (cf::MAP_LOADING);
1233 1859
1234 $self->alloc; 1860 $self->alloc;
1861
1862 $self->pre_load;
1863 Coro::cede;
1864
1235 $self->load_objects ($self->{load_path}, 1) 1865 $self->_load_objects ($self->{load_path}, 1)
1236 or return; 1866 or return;
1237 1867
1238 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1868 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1239 if delete $self->{load_original}; 1869 if delete $self->{load_original};
1240 1870
1241 if (my $uniq = $path->uniq_path) { 1871 if (my $uniq = $self->uniq_path) {
1242 utf8::encode $uniq; 1872 utf8::encode $uniq;
1243 if (aio_open $uniq, O_RDONLY, 0) { 1873 if (aio_open $uniq, O_RDONLY, 0) {
1244 $self->clear_unique_items; 1874 $self->clear_unique_items;
1245 $self->load_objects ($uniq, 0); 1875 $self->_load_objects ($uniq, 0);
1246 } 1876 }
1247 } 1877 }
1248 1878
1249 Coro::cede; 1879 Coro::cede;
1250
1251 # now do the right thing for maps 1880 # now do the right thing for maps
1252 $self->link_multipart_objects; 1881 $self->link_multipart_objects;
1253
1254 if ($self->{path}->is_style_map) {
1255 $self->{deny_save} = 1;
1256 $self->{deny_reset} = 1;
1257 } else {
1258 $self->fix_auto_apply;
1259 $self->decay_objects;
1260 $self->update_buttons;
1261 $self->set_darkness_map;
1262 $self->difficulty ($self->estimate_difficulty) 1882 $self->difficulty ($self->estimate_difficulty)
1263 unless $self->difficulty; 1883 unless $self->difficulty;
1884 Coro::cede;
1885
1886 unless ($self->{deny_activate}) {
1887 $self->decay_objects;
1888 $self->fix_auto_apply;
1889 $self->update_buttons;
1890 Coro::cede;
1891 $self->set_darkness_map;
1892 Coro::cede;
1264 $self->activate; 1893 $self->activate;
1265 } 1894 }
1266 1895
1267 Coro::cede; 1896 $self->{last_save} = $cf::RUNTIME;
1897 $self->last_access ($cf::RUNTIME);
1268 1898
1269 $self->in_memory (cf::MAP_IN_MEMORY); 1899 $self->in_memory (cf::MAP_IN_MEMORY);
1900 }
1901
1902 $self->post_load;
1903}
1904
1905sub customise_for {
1906 my ($self, $ob) = @_;
1907
1908 return find "~" . $ob->name . "/" . $self->{path}
1909 if $self->per_player;
1910
1911# return find "?party/" . $ob->name . "/" . $self->{path}
1912# if $self->per_party;
1913
1914 $self
1915}
1916
1917# find and load all maps in the 3x3 area around a map
1918sub load_neighbours {
1919 my ($map) = @_;
1920
1921 my @neigh; # diagonal neighbours
1922
1923 for (0 .. 3) {
1924 my $neigh = $map->tile_path ($_)
1925 or next;
1926 $neigh = find $neigh, $map
1927 or next;
1928 $neigh->load;
1929
1930 push @neigh,
1931 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1932 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1933 }
1934
1935 for (grep defined $_->[0], @neigh) {
1936 my ($path, $origin) = @$_;
1937 my $neigh = find $path, $origin
1938 or next;
1939 $neigh->load;
1940 }
1270} 1941}
1271 1942
1272sub find_sync { 1943sub find_sync {
1273 my ($path, $origin) = @_; 1944 my ($path, $origin) = @_;
1274 1945
1275 cf::sync_job { 1946 cf::sync_job { find $path, $origin }
1276 my $map = cf::map::find $path, $origin;
1277 $map
1278 }
1279} 1947}
1280 1948
1281sub do_load_sync { 1949sub do_load_sync {
1282 my ($map) = @_; 1950 my ($map) = @_;
1283 1951
1952 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1953 if $Coro::current == $Coro::main;
1954
1284 cf::sync_job { $map->load }; 1955 cf::sync_job { $map->load };
1956}
1957
1958our %MAP_PREFETCH;
1959our $MAP_PREFETCHER = undef;
1960
1961sub find_async {
1962 my ($path, $origin, $load) = @_;
1963
1964 $path = normalise $path, $origin && $origin->{path};
1965
1966 if (my $map = $cf::MAP{$path}) {
1967 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1968 }
1969
1970 $MAP_PREFETCH{$path} |= $load;
1971
1972 $MAP_PREFETCHER ||= cf::async {
1973 while (%MAP_PREFETCH) {
1974 while (my ($k, $v) = each %MAP_PREFETCH) {
1975 if (my $map = find $k) {
1976 $map->load if $v;
1977 }
1978
1979 delete $MAP_PREFETCH{$k};
1980 }
1981 }
1982 undef $MAP_PREFETCHER;
1983 };
1984 $MAP_PREFETCHER->prio (6);
1985
1986 ()
1285} 1987}
1286 1988
1287sub save { 1989sub save {
1288 my ($self) = @_; 1990 my ($self) = @_;
1289 1991
1291 1993
1292 $self->{last_save} = $cf::RUNTIME; 1994 $self->{last_save} = $cf::RUNTIME;
1293 1995
1294 return unless $self->dirty; 1996 return unless $self->dirty;
1295 1997
1296 my $save = $self->{path}->save_path; utf8::encode $save; 1998 my $save = $self->save_path; utf8::encode $save;
1297 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1999 my $uniq = $self->uniq_path; utf8::encode $uniq;
1298 2000
1299 $self->{load_path} = $save; 2001 $self->{load_path} = $save;
1300 2002
1301 return if $self->{deny_save}; 2003 return if $self->{deny_save};
1302 2004
1303 local $self->{last_access} = $self->last_access;#d# 2005 local $self->{last_access} = $self->last_access;#d#
1304 2006
2007 cf::async {
2008 $_->contr->save for $self->players;
2009 };
2010
1305 if ($uniq) { 2011 if ($uniq) {
1306 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2012 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1307 $self->save_objects ($uniq, cf::IO_UNIQUES); 2013 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1308 } else { 2014 } else {
1309 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2015 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1310 } 2016 }
1311} 2017}
1312 2018
1313sub swap_out { 2019sub swap_out {
1314 my ($self) = @_; 2020 my ($self) = @_;
1328 2034
1329sub reset_at { 2035sub reset_at {
1330 my ($self) = @_; 2036 my ($self) = @_;
1331 2037
1332 # TODO: safety, remove and allow resettable per-player maps 2038 # TODO: safety, remove and allow resettable per-player maps
1333 return 1e99 if $self->{path}{user_rel};
1334 return 1e99 if $self->{deny_reset}; 2039 return 1e99 if $self->{deny_reset};
1335 2040
1336 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2041 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1337 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2042 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1338 2043
1343 my ($self) = @_; 2048 my ($self) = @_;
1344 2049
1345 $self->reset_at <= $cf::RUNTIME 2050 $self->reset_at <= $cf::RUNTIME
1346} 2051}
1347 2052
1348sub unlink_save {
1349 my ($self) = @_;
1350
1351 utf8::encode (my $save = $self->{path}->save_path);
1352 aioreq_pri 3; IO::AIO::aio_unlink $save;
1353 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1354}
1355
1356sub rename {
1357 my ($self, $new_path) = @_;
1358
1359 $self->unlink_save;
1360
1361 delete $cf::MAP{$self->path};
1362 $self->{path} = new cf::path $new_path;
1363 $self->path ($self->{path}->as_string);
1364 $cf::MAP{$self->path} = $self;
1365
1366 $self->save;
1367}
1368
1369sub reset { 2053sub reset {
1370 my ($self) = @_; 2054 my ($self) = @_;
1371 2055
1372 my $lock = cf::lock_acquire "map_data:" . $self->path; 2056 my $lock = cf::lock_acquire "map_data:$self->{path}";
1373 2057
1374 return if $self->players; 2058 return if $self->players;
1375 return if $self->{path}{user_rel};#d#
1376 2059
1377 warn "resetting map ", $self->path;#d# 2060 warn "resetting map ", $self->path;
2061
2062 $self->in_memory (cf::MAP_SWAPPED);
2063
2064 # need to save uniques path
2065 unless ($self->{deny_save}) {
2066 my $uniq = $self->uniq_path; utf8::encode $uniq;
2067
2068 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2069 if $uniq;
2070 }
1378 2071
1379 delete $cf::MAP{$self->path}; 2072 delete $cf::MAP{$self->path};
2073
2074 $self->clear;
1380 2075
1381 $_->clear_links_to ($self) for values %cf::MAP; 2076 $_->clear_links_to ($self) for values %cf::MAP;
1382 2077
1383 $self->unlink_save; 2078 $self->unlink_save;
1384 $self->destroy; 2079 $self->destroy;
1387my $nuke_counter = "aaaa"; 2082my $nuke_counter = "aaaa";
1388 2083
1389sub nuke { 2084sub nuke {
1390 my ($self) = @_; 2085 my ($self) = @_;
1391 2086
2087 delete $cf::MAP{$self->path};
2088
2089 $self->unlink_save;
2090
2091 bless $self, "cf::map";
2092 delete $self->{deny_reset};
1392 $self->{deny_save} = 1; 2093 $self->{deny_save} = 1;
1393 $self->reset_timeout (1); 2094 $self->reset_timeout (1);
1394 $self->rename ("{nuke}/" . ($nuke_counter++)); 2095 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2096
2097 $cf::MAP{$self->path} = $self;
2098
1395 $self->reset; # polite request, might not happen 2099 $self->reset; # polite request, might not happen
1396} 2100}
1397 2101
1398sub customise_for { 2102=item $maps = cf::map::tmp_maps
1399 my ($map, $ob) = @_;
1400 2103
1401 if ($map->per_player) { 2104Returns an arrayref with all map paths of currently instantiated and saved
1402 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2105maps. May block.
2106
2107=cut
2108
2109sub tmp_maps() {
1403 } 2110 [
1404 2111 map {
1405 $map 2112 utf8::decode $_;
2113 /\.map$/
2114 ? normalise $_
2115 : ()
2116 } @{ aio_readdir $TMPDIR or [] }
2117 ]
1406} 2118}
1407 2119
1408sub emergency_save { 2120=item $maps = cf::map::random_maps
1409 my $freeze_guard = cf::freeze_mainloop;
1410 2121
1411 warn "enter emergency map save\n"; 2122Returns an arrayref with all map paths of currently instantiated and saved
2123random maps. May block.
1412 2124
1413 cf::sync_job { 2125=cut
1414 warn "begin emergency map save\n";
1415 $_->save for values %cf::MAP;
1416 };
1417 2126
1418 warn "end emergency map save\n"; 2127sub random_maps() {
2128 [
2129 map {
2130 utf8::decode $_;
2131 /\.map$/
2132 ? normalise "?random/$_"
2133 : ()
2134 } @{ aio_readdir $RANDOMDIR or [] }
2135 ]
2136}
2137
2138=item cf::map::unique_maps
2139
2140Returns an arrayref of paths of all shared maps that have
2141instantiated unique items. May block.
2142
2143=cut
2144
2145sub unique_maps() {
2146 [
2147 map {
2148 utf8::decode $_;
2149 /\.map$/
2150 ? normalise $_
2151 : ()
2152 } @{ aio_readdir $UNIQUEDIR or [] }
2153 ]
1419} 2154}
1420 2155
1421package cf; 2156package cf;
1422 2157
1423=back 2158=back
1424 2159
2160=head3 cf::object
2161
2162=cut
2163
2164package cf::object;
2165
2166=over 4
2167
2168=item $ob->inv_recursive
2169
2170Returns the inventory of the object _and_ their inventories, recursively.
2171
2172=cut
2173
2174sub inv_recursive_;
2175sub inv_recursive_ {
2176 map { $_, inv_recursive_ $_->inv } @_
2177}
2178
2179sub inv_recursive {
2180 inv_recursive_ inv $_[0]
2181}
2182
2183package cf;
2184
2185=back
1425 2186
1426=head3 cf::object::player 2187=head3 cf::object::player
1427 2188
1428=over 4 2189=over 4
1429 2190
1443 2204
1444 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2205 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1445 2206
1446 if ($self->{record_replies}) { 2207 if ($self->{record_replies}) {
1447 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2208 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2209
1448 } else { 2210 } else {
2211 my $pl = $self->contr;
2212
2213 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2214 my $dialog = $pl->{npc_dialog};
2215 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2216
2217 } else {
1449 $msg = $npc->name . " says: $msg" if $npc; 2218 $msg = $npc->name . " says: $msg" if $npc;
1450 $self->message ($msg, $flags); 2219 $self->message ($msg, $flags);
2220 }
1451 } 2221 }
2222}
2223
2224=item $object->send_msg ($channel, $msg, $color, [extra...])
2225
2226=cut
2227
2228sub cf::object::send_msg {
2229 my $pl = shift->contr
2230 or return;
2231 $pl->send_msg (@_);
1452} 2232}
1453 2233
1454=item $player_object->may ("access") 2234=item $player_object->may ("access")
1455 2235
1456Returns wether the given player is authorized to access resource "access" 2236Returns wether the given player is authorized to access resource "access"
1469 2249
1470=item $player_object->enter_link 2250=item $player_object->enter_link
1471 2251
1472Freezes the player and moves him/her to a special map (C<{link}>). 2252Freezes the player and moves him/her to a special map (C<{link}>).
1473 2253
1474The player should be reaosnably safe there for short amounts of time. You 2254The player should be reasonably safe there for short amounts of time. You
1475I<MUST> call C<leave_link> as soon as possible, though. 2255I<MUST> call C<leave_link> as soon as possible, though.
1476 2256
2257Will never block.
2258
1477=item $player_object->leave_link ($map, $x, $y) 2259=item $player_object->leave_link ($map, $x, $y)
1478 2260
1479Moves the player out of the specila link map onto the given map. If the 2261Moves the player out of the special C<{link}> map onto the specified
1480map is not valid (or omitted), the player will be moved back to the 2262map. If the map is not valid (or omitted), the player will be moved back
1481location he/she was before the call to C<enter_link>, or, if that fails, 2263to the location he/she was before the call to C<enter_link>, or, if that
1482to the emergency map position. 2264fails, to the emergency map position.
1483 2265
1484Might block. 2266Might block.
1485 2267
1486=cut 2268=cut
2269
2270sub link_map {
2271 unless ($LINK_MAP) {
2272 $LINK_MAP = cf::map::find "{link}"
2273 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2274 $LINK_MAP->load;
2275 }
2276
2277 $LINK_MAP
2278}
1487 2279
1488sub cf::object::player::enter_link { 2280sub cf::object::player::enter_link {
1489 my ($self) = @_; 2281 my ($self) = @_;
1490 2282
1491 $self->deactivate_recursive; 2283 $self->deactivate_recursive;
1492 2284
1493 return if $self->map == $LINK_MAP; 2285 return if UNIVERSAL::isa $self->map, "ext::map_link";
1494 2286
1495 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2287 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1496 if $self->map; 2288 if $self->map && $self->map->{path} ne "{link}";
1497 2289
1498 $self->enter_map ($LINK_MAP, 20, 20); 2290 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1499} 2291}
1500 2292
1501sub cf::object::player::leave_link { 2293sub cf::object::player::leave_link {
1502 my ($self, $map, $x, $y) = @_; 2294 my ($self, $map, $x, $y) = @_;
2295
2296 return unless $self->contr->active;
1503 2297
1504 my $link_pos = delete $self->{_link_pos}; 2298 my $link_pos = delete $self->{_link_pos};
1505 2299
1506 unless ($map) { 2300 unless ($map) {
1507 # restore original map position 2301 # restore original map position
1521 # use -1 or undef as default coordinates, not 0, 0 2315 # use -1 or undef as default coordinates, not 0, 0
1522 ($x, $y) = ($map->enter_x, $map->enter_y) 2316 ($x, $y) = ($map->enter_x, $map->enter_y)
1523 if $x <=0 && $y <= 0; 2317 if $x <=0 && $y <= 0;
1524 2318
1525 $map->load; 2319 $map->load;
2320 $map->load_neighbours;
1526 2321
2322 return unless $self->contr->active;
1527 $self->activate_recursive; 2323 $self->activate_recursive;
2324
2325 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1528 $self->enter_map ($map, $x, $y); 2326 $self->enter_map ($map, $x, $y);
1529} 2327}
1530 2328
1531cf::player->attach ( 2329=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1532 on_logout => sub {
1533 my ($pl) = @_;
1534 2330
1535 # abort map switching before logout 2331Moves the player to the given map-path and coordinates by first freezing
1536 if ($pl->ob->{_link_pos}) { 2332her, loading and preparing them map, calling the provided $check callback
1537 cf::sync_job { 2333that has to return the map if sucecssful, and then unfreezes the player on
1538 $pl->ob->leave_link 2334the new (success) or old (failed) map position. In either case, $done will
1539 }; 2335be called at the end of this process.
1540 }
1541 },
1542 on_login => sub {
1543 my ($pl) = @_;
1544 2336
1545 # try to abort aborted map switching on player login :)
1546 # should happen only on crashes
1547 if ($pl->ob->{_link_pos}) {
1548
1549 $pl->ob->enter_link;
1550 (Coro::async_pool {
1551 # we need this sleep as the login has a concurrent enter_exit running
1552 # and this sleep increases chances of the player not ending up in scorn
1553 Coro::Timer::sleep 1;
1554 $pl->ob->leave_link;
1555 })->prio (2);
1556 }
1557 },
1558);
1559
1560=item $player_object->goto ($path, $x, $y)
1561
1562=cut 2337=cut
2338
2339our $GOTOGEN;
1563 2340
1564sub cf::object::player::goto { 2341sub cf::object::player::goto {
1565 my ($self, $path, $x, $y) = @_; 2342 my ($self, $path, $x, $y, $check, $done) = @_;
2343
2344 # do generation counting so two concurrent goto's will be executed in-order
2345 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1566 2346
1567 $self->enter_link; 2347 $self->enter_link;
1568 2348
1569 (Coro::async_pool { 2349 (async {
1570 $path = new cf::path $path; 2350 my $map = eval {
1571
1572 my $map = cf::map::find $path->as_string; 2351 my $map = cf::map::find $path;
2352
2353 if ($map) {
1573 $map = $map->customise_for ($self) if $map; 2354 $map = $map->customise_for ($self);
1574 2355 $map = $check->($map) if $check && $map;
1575# warn "entering ", $map->path, " at ($x, $y)\n" 2356 } else {
1576# if $map;
1577
1578 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2357 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2358 }
1579 2359
2360 $map
2361 };
2362
2363 if ($@) {
2364 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2365 LOG llevError | logBacktrace, Carp::longmess $@;
2366 }
2367
2368 if ($gen == $self->{_goto_generation}) {
2369 delete $self->{_goto_generation};
1580 $self->leave_link ($map, $x, $y); 2370 $self->leave_link ($map, $x, $y);
2371 }
2372
2373 $done->() if $done;
1581 })->prio (1); 2374 })->prio (1);
1582} 2375}
1583 2376
1584=item $player_object->enter_exit ($exit_object) 2377=item $player_object->enter_exit ($exit_object)
1585 2378
1587 2380
1588sub parse_random_map_params { 2381sub parse_random_map_params {
1589 my ($spec) = @_; 2382 my ($spec) = @_;
1590 2383
1591 my $rmp = { # defaults 2384 my $rmp = { # defaults
1592 xsize => 10, 2385 xsize => (cf::rndm 15, 40),
1593 ysize => 10, 2386 ysize => (cf::rndm 15, 40),
2387 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2388 #layout => string,
1594 }; 2389 };
1595 2390
1596 for (split /\n/, $spec) { 2391 for (split /\n/, $spec) {
1597 my ($k, $v) = split /\s+/, $_, 2; 2392 my ($k, $v) = split /\s+/, $_, 2;
1598 2393
1602 $rmp 2397 $rmp
1603} 2398}
1604 2399
1605sub prepare_random_map { 2400sub prepare_random_map {
1606 my ($exit) = @_; 2401 my ($exit) = @_;
2402
2403 my $guard = cf::lock_acquire "exit_prepare:$exit";
1607 2404
1608 # all this does is basically replace the /! path by 2405 # all this does is basically replace the /! path by
1609 # a new random map path (?random/...) with a seed 2406 # a new random map path (?random/...) with a seed
1610 # that depends on the exit object 2407 # that depends on the exit object
1611 2408
1612 my $rmp = parse_random_map_params $exit->msg; 2409 my $rmp = parse_random_map_params $exit->msg;
1613 2410
1614 if ($exit->map) { 2411 if ($exit->map) {
1615 $rmp->{region} = $exit->map->region_name; 2412 $rmp->{region} = $exit->region->name;
1616 $rmp->{origin_map} = $exit->map->path; 2413 $rmp->{origin_map} = $exit->map->path;
1617 $rmp->{origin_x} = $exit->x; 2414 $rmp->{origin_x} = $exit->x;
1618 $rmp->{origin_y} = $exit->y; 2415 $rmp->{origin_y} = $exit->y;
1619 } 2416 }
1620 2417
1621 $rmp->{random_seed} ||= $exit->random_seed; 2418 $rmp->{random_seed} ||= $exit->random_seed;
1622 2419
1623 my $data = cf::to_json $rmp; 2420 my $data = cf::to_json $rmp;
1624 my $md5 = Digest::MD5::md5_hex $data; 2421 my $md5 = Digest::MD5::md5_hex $data;
2422 my $meta = "$RANDOMDIR/$md5.meta";
1625 2423
1626 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2424 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1627 aio_write $fh, 0, (length $data), $data, 0; 2425 aio_write $fh, 0, (length $data), $data, 0;
2426 undef $fh;
2427 aio_rename "$meta~", $meta;
1628 2428
1629 $exit->slaying ("?random/$md5"); 2429 $exit->slaying ("?random/$md5");
1630 $exit->msg (undef); 2430 $exit->msg (undef);
1631 } 2431 }
1632} 2432}
1634sub cf::object::player::enter_exit { 2434sub cf::object::player::enter_exit {
1635 my ($self, $exit) = @_; 2435 my ($self, $exit) = @_;
1636 2436
1637 return unless $self->type == cf::PLAYER; 2437 return unless $self->type == cf::PLAYER;
1638 2438
2439 if ($exit->slaying eq "/!") {
2440 #TODO: this should de-fi-ni-te-ly not be a sync-job
2441 # the problem is that $exit might not survive long enough
2442 # so it needs to be done right now, right here
2443 cf::sync_job { prepare_random_map $exit };
2444 }
2445
2446 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2447 my $hp = $exit->stats->hp;
2448 my $sp = $exit->stats->sp;
2449
1639 $self->enter_link; 2450 $self->enter_link;
1640 2451
1641 (Coro::async_pool { 2452 # if exit is damned, update players death & WoR home-position
2453 $self->contr->savebed ($slaying, $hp, $sp)
2454 if $exit->flag (FLAG_DAMNED);
2455
2456 (async {
1642 $self->deactivate_recursive; # just to be sure 2457 $self->deactivate_recursive; # just to be sure
1643 unless (eval { 2458 unless (eval {
1644 prepare_random_map $exit 2459 $self->goto ($slaying, $hp, $sp);
1645 if $exit->slaying eq "/!";
1646
1647 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1648 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1649 2460
1650 1; 2461 1;
1651 }) { 2462 }) {
1652 $self->message ("Something went wrong deep within the crossfire server. " 2463 $self->message ("Something went wrong deep within the crossfire server. "
1653 . "I'll try to bring you back to the map you were before. " 2464 . "I'll try to bring you back to the map you were before. "
1654 . "Please report this to the dungeon master", 2465 . "Please report this to the dungeon master!",
1655 cf::NDI_UNIQUE | cf::NDI_RED); 2466 cf::NDI_UNIQUE | cf::NDI_RED);
1656 2467
1657 warn "ERROR in enter_exit: $@"; 2468 warn "ERROR in enter_exit: $@";
1658 $self->leave_link; 2469 $self->leave_link;
1659 } 2470 }
1660 })->prio (1); 2471 })->prio (1);
1673 2484
1674sub cf::client::send_drawinfo { 2485sub cf::client::send_drawinfo {
1675 my ($self, $text, $flags) = @_; 2486 my ($self, $text, $flags) = @_;
1676 2487
1677 utf8::encode $text; 2488 utf8::encode $text;
1678 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2489 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1679} 2490}
1680 2491
2492=item $client->send_msg ($channel, $msg, $color, [extra...])
2493
2494Send a drawinfo or msg packet to the client, formatting the msg for the
2495client if neccessary. C<$type> should be a string identifying the type of
2496the message, with C<log> being the default. If C<$color> is negative, suppress
2497the message unless the client supports the msg packet.
2498
2499=cut
2500
2501sub cf::client::send_msg {
2502 my ($self, $channel, $msg, $color, @extra) = @_;
2503
2504 $msg = $self->pl->expand_cfpod ($msg);
2505
2506 $color &= cf::NDI_CLIENT_MASK; # just in case...
2507
2508 if (ref $channel) {
2509 # send meta info to client, if not yet sent
2510 unless (exists $self->{channel}{$channel->{id}}) {
2511 $self->{channel}{$channel->{id}} = $channel;
2512 $self->ext_msg (channel_info => $channel);
2513 }
2514
2515 $channel = $channel->{id};
2516 }
2517
2518 return unless @extra || length $msg;
2519
2520 if ($self->can_msg) {
2521 # default colour, mask it out
2522 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2523 if $color & cf::NDI_DEF;
2524
2525 $self->send_packet ("msg " . $self->{json_coder}->encode (
2526 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2527 } else {
2528 if ($color >= 0) {
2529 # replace some tags by gcfclient-compatible ones
2530 for ($msg) {
2531 1 while
2532 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2533 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2534 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2535 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2536 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2537 }
2538
2539 $color &= cf::NDI_COLOR_MASK;
2540
2541 utf8::encode $msg;
2542
2543 if (0 && $msg =~ /\[/) {
2544 # COMMAND/INFO
2545 $self->send_packet ("drawextinfo $color 10 8 $msg")
2546 } else {
2547 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2548 $self->send_packet ("drawinfo $color $msg")
2549 }
2550 }
2551 }
2552}
2553
2554=item $client->ext_msg ($type, @msg)
2555
2556Sends an ext event to the client.
2557
2558=cut
2559
2560sub cf::client::ext_msg($$@) {
2561 my ($self, $type, @msg) = @_;
2562
2563 my $extcmd = $self->extcmd;
2564
2565 if ($extcmd == 2) {
2566 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2567 } elsif ($extcmd == 1) { # TODO: remove
2568 push @msg, msgtype => "event_$type";
2569 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2570 }
2571}
2572
2573=item $client->ext_reply ($msgid, @msg)
2574
2575Sends an ext reply to the client.
2576
2577=cut
2578
2579sub cf::client::ext_reply($$@) {
2580 my ($self, $id, @msg) = @_;
2581
2582 if ($self->extcmd == 2) {
2583 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2584 } elsif ($self->ns->extcmd == 1) {
2585 #TODO: version 1, remove
2586 unshift @msg, msgtype => "reply", msgid => $id;
2587 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2588 }
2589}
1681 2590
1682=item $success = $client->query ($flags, "text", \&cb) 2591=item $success = $client->query ($flags, "text", \&cb)
1683 2592
1684Queues a query to the client, calling the given callback with 2593Queues a query to the client, calling the given callback with
1685the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2594the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1686C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2595C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1687 2596
1688Queries can fail, so check the return code. Or don't, as queries will become 2597Queries can fail, so check the return code. Or don't, as queries will
1689reliable at some point in the future. 2598become reliable at some point in the future.
1690 2599
1691=cut 2600=cut
1692 2601
1693sub cf::client::query { 2602sub cf::client::query {
1694 my ($self, $flags, $text, $cb) = @_; 2603 my ($self, $flags, $text, $cb) = @_;
1702 utf8::encode $text; 2611 utf8::encode $text;
1703 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2612 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1704 2613
1705 $self->send_packet ($self->{query_queue}[0][0]) 2614 $self->send_packet ($self->{query_queue}[0][0])
1706 if @{ $self->{query_queue} } == 1; 2615 if @{ $self->{query_queue} } == 1;
2616
2617 1
1707} 2618}
1708 2619
1709cf::client->attach ( 2620cf::client->attach (
2621 on_connect => sub {
2622 my ($ns) = @_;
2623
2624 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2625 },
1710 on_reply => sub { 2626 on_reply => sub {
1711 my ($ns, $msg) = @_; 2627 my ($ns, $msg) = @_;
1712 2628
1713 # this weird shuffling is so that direct followup queries 2629 # this weird shuffling is so that direct followup queries
1714 # get handled first 2630 # get handled first
1715 my $queue = delete $ns->{query_queue} 2631 my $queue = delete $ns->{query_queue}
1716 or return; # be conservative, not sure how that can happen, but we saw a crash here 2632 or return; # be conservative, not sure how that can happen, but we saw a crash here
1717 2633
1718 (shift @$queue)->[1]->($msg); 2634 (shift @$queue)->[1]->($msg);
2635 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1719 2636
1720 push @{ $ns->{query_queue} }, @$queue; 2637 push @{ $ns->{query_queue} }, @$queue;
1721 2638
1722 if (@{ $ns->{query_queue} } == @$queue) { 2639 if (@{ $ns->{query_queue} } == @$queue) {
1723 if (@$queue) { 2640 if (@$queue) {
1725 } else { 2642 } else {
1726 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2643 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1727 } 2644 }
1728 } 2645 }
1729 }, 2646 },
2647 on_exticmd => sub {
2648 my ($ns, $buf) = @_;
2649
2650 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2651
2652 if (ref $msg) {
2653 my ($type, $reply, @payload) =
2654 "ARRAY" eq ref $msg
2655 ? @$msg
2656 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2657
2658 my @reply;
2659
2660 if (my $cb = $EXTICMD{$type}) {
2661 @reply = $cb->($ns, @payload);
2662 }
2663
2664 $ns->ext_reply ($reply, @reply)
2665 if $reply;
2666
2667 } else {
2668 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2669 }
2670
2671 cf::override;
2672 },
1730); 2673);
1731 2674
1732=item $client->coro (\&cb) 2675=item $client->async (\&cb)
1733 2676
1734Create a new coroutine, running the specified callback. The coroutine will 2677Create a new coroutine, running the specified callback. The coroutine will
1735be automatically cancelled when the client gets destroyed (e.g. on logout, 2678be automatically cancelled when the client gets destroyed (e.g. on logout,
1736or loss of connection). 2679or loss of connection).
1737 2680
1738=cut 2681=cut
1739 2682
1740sub cf::client::coro { 2683sub cf::client::async {
1741 my ($self, $cb) = @_; 2684 my ($self, $cb) = @_;
1742 2685
1743 my $coro = &Coro::async_pool ($cb); 2686 my $coro = &Coro::async ($cb);
1744 2687
1745 $coro->on_destroy (sub { 2688 $coro->on_destroy (sub {
1746 delete $self->{_coro}{$coro+0}; 2689 delete $self->{_coro}{$coro+0};
1747 }); 2690 });
1748 2691
1775our $safe = new Safe "safe"; 2718our $safe = new Safe "safe";
1776our $safe_hole = new Safe::Hole; 2719our $safe_hole = new Safe::Hole;
1777 2720
1778$SIG{FPE} = 'IGNORE'; 2721$SIG{FPE} = 'IGNORE';
1779 2722
1780$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2723$safe->permit_only (Opcode::opset qw(
2724 :base_core :base_mem :base_orig :base_math
2725 grepstart grepwhile mapstart mapwhile
2726 sort time
2727));
1781 2728
1782# here we export the classes and methods available to script code 2729# here we export the classes and methods available to script code
1783 2730
1784=pod 2731=pod
1785 2732
1786The following fucntions and emthods are available within a safe environment: 2733The following functions and methods are available within a safe environment:
1787 2734
1788 cf::object contr pay_amount pay_player map 2735 cf::object
2736 contr pay_amount pay_player map x y force_find force_add
2737 insert remove name archname title slaying race decrease_ob_nr
2738
1789 cf::object::player player 2739 cf::object::player
1790 cf::player peaceful 2740 player
1791 cf::map trigger 2741
2742 cf::player
2743 peaceful
2744
2745 cf::map
2746 trigger
1792 2747
1793=cut 2748=cut
1794 2749
1795for ( 2750for (
1796 ["cf::object" => qw(contr pay_amount pay_player map)], 2751 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2752 insert remove inv name archname title slaying race
2753 decrease_ob_nr)],
1797 ["cf::object::player" => qw(player)], 2754 ["cf::object::player" => qw(player)],
1798 ["cf::player" => qw(peaceful)], 2755 ["cf::player" => qw(peaceful)],
1799 ["cf::map" => qw(trigger)], 2756 ["cf::map" => qw(trigger)],
1800) { 2757) {
1801 no strict 'refs'; 2758 no strict 'refs';
1872=back 2829=back
1873 2830
1874=cut 2831=cut
1875 2832
1876############################################################################# 2833#############################################################################
2834# the server's init and main functions
1877 2835
1878=head2 EXTENSION DATABASE SUPPORT 2836sub load_facedata($) {
2837 my ($path) = @_;
1879 2838
1880Crossfire maintains a very simple database for extension use. It can 2839 my $enc = JSON::XS->new->utf8->canonical;
1881currently store anything that can be serialised using Storable, which
1882excludes objects.
1883 2840
1884The parameter C<$family> should best start with the name of the extension 2841 warn "loading facedata from $path\n";
1885using it, it should be unique.
1886 2842
1887=over 4 2843 my $facedata;
2844 0 < aio_load $path, $facedata
2845 or die "$path: $!";
1888 2846
1889=item $hashref = cf::db_get $family 2847 $facedata = Coro::Storable::thaw $facedata;
1890 2848
1891Return a hashref for use by the extension C<$family>, which can be 2849 $facedata->{version} == 2
1892modified. After modifications, you have to call C<cf::db_dirty> or 2850 or cf::cleanup "$path: version mismatch, cannot proceed.";
1893C<cf::db_sync>.
1894 2851
1895=item $value = cf::db_get $family => $key 2852 # patch in the exptable
1896 2853 $facedata->{resource}{"res/exp_table"} = {
1897Returns a single value from the database 2854 type => FT_RSRC,
1898 2855 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1899=item cf::db_put $family => $hashref
1900
1901Stores the given family hashref into the database. Updates are delayed, if
1902you want the data to be synced to disk immediately, use C<cf::db_sync>.
1903
1904=item cf::db_put $family => $key => $value
1905
1906Stores the given C<$value> in the family hash. Updates are delayed, if you
1907want the data to be synced to disk immediately, use C<cf::db_sync>.
1908
1909=item cf::db_dirty
1910
1911Marks the database as dirty, to be updated at a later time.
1912
1913=item cf::db_sync
1914
1915Immediately write the database to disk I<if it is dirty>.
1916
1917=cut
1918
1919our $DB;
1920
1921{
1922 my $path = cf::localdir . "/database.pst";
1923
1924 sub db_load() {
1925 $DB = stat $path ? Storable::retrieve $path : { };
1926 }
1927
1928 my $pid;
1929
1930 sub db_save() {
1931 waitpid $pid, 0 if $pid;
1932 if (0 == ($pid = fork)) {
1933 $DB->{_meta}{version} = 1;
1934 Storable::nstore $DB, "$path~";
1935 rename "$path~", $path;
1936 cf::_exit 0 if defined $pid;
1937 }
1938 }
1939
1940 my $dirty;
1941
1942 sub db_sync() {
1943 db_save if $dirty;
1944 undef $dirty;
1945 }
1946
1947 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1948 db_sync;
1949 }); 2856 };
2857 cf::cede_to_tick;
1950 2858
1951 sub db_dirty() {
1952 $dirty = 1;
1953 $idle->start;
1954 } 2859 {
2860 my $faces = $facedata->{faceinfo};
1955 2861
1956 sub db_get($;$) { 2862 while (my ($face, $info) = each %$faces) {
1957 @_ >= 2 2863 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1958 ? $DB->{$_[0]}{$_[1]} 2864 cf::face::set_visibility $idx, $info->{visibility};
1959 : ($DB->{$_[0]} ||= { }) 2865 cf::face::set_magicmap $idx, $info->{magicmap};
1960 } 2866 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2867 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1961 2868
1962 sub db_put($$;$) { 2869 cf::cede_to_tick;
1963 if (@_ >= 3) {
1964 $DB->{$_[0]}{$_[1]} = $_[2];
1965 } else {
1966 $DB->{$_[0]} = $_[1];
1967 }
1968 db_dirty;
1969 }
1970
1971 cf::global->attach (
1972 prio => 10000,
1973 on_cleanup => sub {
1974 db_sync;
1975 }, 2870 }
1976 );
1977}
1978 2871
1979############################################################################# 2872 while (my ($face, $info) = each %$faces) {
1980# the server's main() 2873 next unless $info->{smooth};
2874 my $idx = cf::face::find $face
2875 or next;
2876 if (my $smooth = cf::face::find $info->{smooth}) {
2877 cf::face::set_smooth $idx, $smooth;
2878 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2879 } else {
2880 warn "smooth face '$info->{smooth}' not found for face '$face'";
2881 }
2882
2883 cf::cede_to_tick;
2884 }
2885 }
2886
2887 {
2888 my $anims = $facedata->{animinfo};
2889
2890 while (my ($anim, $info) = each %$anims) {
2891 cf::anim::set $anim, $info->{frames}, $info->{facings};
2892 cf::cede_to_tick;
2893 }
2894
2895 cf::anim::invalidate_all; # d'oh
2896 }
2897
2898 {
2899 # TODO: for gcfclient pleasure, we should give resources
2900 # that gcfclient doesn't grok a >10000 face index.
2901 my $res = $facedata->{resource};
2902
2903 my $soundconf = delete $res->{"res/sound.conf"};
2904
2905 while (my ($name, $info) = each %$res) {
2906 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2907 my $data;
2908
2909 if ($info->{type} & 1) {
2910 # prepend meta info
2911
2912 my $meta = $enc->encode ({
2913 name => $name,
2914 %{ $info->{meta} || {} },
2915 });
2916
2917 $data = pack "(w/a*)*", $meta, $info->{data};
2918 } else {
2919 $data = $info->{data};
2920 }
2921
2922 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2923 cf::face::set_type $idx, $info->{type};
2924
2925 cf::cede_to_tick;
2926 }
2927
2928 if ($soundconf) {
2929 $soundconf = $enc->decode (delete $soundconf->{data});
2930
2931 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2932 my $sound = $soundconf->{compat}[$_]
2933 or next;
2934
2935 my $face = cf::face::find "sound/$sound->[1]";
2936 cf::sound::set $sound->[0] => $face;
2937 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2938 }
2939
2940 while (my ($k, $v) = each %{$soundconf->{event}}) {
2941 my $face = cf::face::find "sound/$v";
2942 cf::sound::set $k => $face;
2943 }
2944 }
2945 }
2946
2947 1
2948}
2949
2950register_exticmd fx_want => sub {
2951 my ($ns, $want) = @_;
2952
2953 while (my ($k, $v) = each %$want) {
2954 $ns->fx_want ($k, $v);
2955 }
2956};
2957
2958sub reload_regions {
2959 load_resource_file "$MAPDIR/regions"
2960 or die "unable to load regions file\n";
2961
2962 for (cf::region::list) {
2963 $_->{match} = qr/$_->{match}/
2964 if exists $_->{match};
2965 }
2966}
2967
2968sub reload_facedata {
2969 load_facedata "$DATADIR/facedata"
2970 or die "unable to load facedata\n";
2971}
2972
2973sub reload_archetypes {
2974 load_resource_file "$DATADIR/archetypes"
2975 or die "unable to load archetypes\n";
2976 #d# NEED to laod twice to resolve forward references
2977 # this really needs to be done in an extra post-pass
2978 # (which needs to be synchronous, so solve it differently)
2979 load_resource_file "$DATADIR/archetypes"
2980 or die "unable to load archetypes\n";
2981}
2982
2983sub reload_treasures {
2984 load_resource_file "$DATADIR/treasures"
2985 or die "unable to load treasurelists\n";
2986}
2987
2988sub reload_resources {
2989 warn "reloading resource files...\n";
2990
2991 reload_regions;
2992 reload_facedata;
2993 #reload_archetypes;#d#
2994 reload_archetypes;
2995 reload_treasures;
2996
2997 warn "finished reloading resource files\n";
2998}
2999
3000sub init {
3001 reload_resources;
3002}
1981 3003
1982sub cfg_load { 3004sub cfg_load {
1983 open my $fh, "<:utf8", cf::confdir . "/config" 3005 open my $fh, "<:utf8", "$CONFDIR/config"
1984 or return; 3006 or return;
1985 3007
1986 local $/; 3008 local $/;
1987 *CFG = YAML::Syck::Load <$fh>; 3009 *CFG = YAML::Syck::Load <$fh>;
1988 3010
1991 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3013 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
1992 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3014 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
1993 3015
1994 if (exists $CFG{mlockall}) { 3016 if (exists $CFG{mlockall}) {
1995 eval { 3017 eval {
1996 $CFG{mlockall} ? &mlockall : &munlockall 3018 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1997 and die "WARNING: m(un)lockall failed: $!\n"; 3019 and die "WARNING: m(un)lockall failed: $!\n";
1998 }; 3020 };
1999 warn $@ if $@; 3021 warn $@ if $@;
2000 } 3022 }
2001} 3023}
2002 3024
2003sub main { 3025sub main {
2004 # we must not ever block the main coroutine 3026 # we must not ever block the main coroutine
2005 local $Coro::idle = sub { 3027 local $Coro::idle = sub {
2006 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3028 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2007 Coro::async_pool { Event::one_event }; 3029 (async {
3030 Event::one_event;
3031 })->prio (Coro::PRIO_MAX);
2008 }; 3032 };
2009 3033
2010 cfg_load; 3034 cfg_load;
2011 db_load; 3035 db_init;
2012 load_extensions; 3036 load_extensions;
3037
3038 $TICK_WATCHER->start;
2013 Event::loop; 3039 Event::loop;
2014} 3040}
2015 3041
2016############################################################################# 3042#############################################################################
2017# initialisation 3043# initialisation and cleanup
2018 3044
3045# install some emergency cleanup handlers
3046BEGIN {
3047 for my $signal (qw(INT HUP TERM)) {
3048 Event->signal (
3049 reentrant => 0,
3050 data => WF_AUTOCANCEL,
3051 signal => $signal,
3052 prio => 0,
3053 cb => sub {
3054 cf::cleanup "SIG$signal";
3055 },
3056 );
3057 }
3058}
3059
3060sub write_runtime {
3061 my $runtime = "$LOCALDIR/runtime";
3062
3063 # first touch the runtime file to show we are still running:
3064 # the fsync below can take a very very long time.
3065
3066 IO::AIO::aio_utime $runtime, undef, undef;
3067
3068 my $guard = cf::lock_acquire "write_runtime";
3069
3070 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3071 or return;
3072
3073 my $value = $cf::RUNTIME + 90 + 10;
3074 # 10 is the runtime save interval, for a monotonic clock
3075 # 60 allows for the watchdog to kill the server.
3076
3077 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3078 and return;
3079
3080 # always fsync - this file is important
3081 aio_fsync $fh
3082 and return;
3083
3084 # touch it again to show we are up-to-date
3085 aio_utime $fh, undef, undef;
3086
3087 close $fh
3088 or return;
3089
3090 aio_rename "$runtime~", $runtime
3091 and return;
3092
3093 warn "runtime file written.\n";
3094
3095 1
3096}
3097
3098sub emergency_save() {
3099 my $freeze_guard = cf::freeze_mainloop;
3100
3101 warn "enter emergency perl save\n";
3102
3103 cf::sync_job {
3104 # use a peculiar iteration method to avoid tripping on perl
3105 # refcount bugs in for. also avoids problems with players
3106 # and maps saved/destroyed asynchronously.
3107 warn "begin emergency player save\n";
3108 for my $login (keys %cf::PLAYER) {
3109 my $pl = $cf::PLAYER{$login} or next;
3110 $pl->valid or next;
3111 $pl->save;
3112 }
3113 warn "end emergency player save\n";
3114
3115 warn "begin emergency map save\n";
3116 for my $path (keys %cf::MAP) {
3117 my $map = $cf::MAP{$path} or next;
3118 $map->valid or next;
3119 $map->save;
3120 }
3121 warn "end emergency map save\n";
3122
3123 warn "begin emergency database checkpoint\n";
3124 BDB::db_env_txn_checkpoint $DB_ENV;
3125 warn "end emergency database checkpoint\n";
3126 };
3127
3128 warn "leave emergency perl save\n";
3129}
3130
3131sub post_cleanup {
3132 my ($make_core) = @_;
3133
3134 warn Carp::longmess "post_cleanup backtrace"
3135 if $make_core;
3136}
3137
2019sub reload() { 3138sub do_reload_perl() {
2020 # can/must only be called in main 3139 # can/must only be called in main
2021 if ($Coro::current != $Coro::main) { 3140 if ($Coro::current != $Coro::main) {
2022 warn "can only reload from main coroutine\n"; 3141 warn "can only reload from main coroutine";
2023 return; 3142 return;
2024 } 3143 }
2025 3144
2026 warn "reloading..."; 3145 warn "reloading...";
2027 3146
2028 my $guard = freeze_mainloop; 3147 warn "entering sync_job";
3148
3149 cf::sync_job {
3150 cf::write_runtime; # external watchdog should not bark
2029 cf::emergency_save; 3151 cf::emergency_save;
3152 cf::write_runtime; # external watchdog should not bark
2030 3153
2031 eval { 3154 warn "syncing database to disk";
3155 BDB::db_env_txn_checkpoint $DB_ENV;
3156
2032 # if anything goes wrong in here, we should simply crash as we already saved 3157 # if anything goes wrong in here, we should simply crash as we already saved
2033 3158
2034 # cancel all watchers 3159 warn "cancelling all WF_AUTOCANCEL watchers";
2035 for (Event::all_watchers) { 3160 for (Event::all_watchers) {
2036 $_->cancel if $_->data & WF_AUTOCANCEL; 3161 $_->cancel if $_->data & WF_AUTOCANCEL;
2037 } 3162 }
2038 3163
3164 warn "flushing outstanding aio requests";
3165 for (;;) {
3166 BDB::flush;
3167 IO::AIO::flush;
3168 Coro::cede;
3169 last unless IO::AIO::nreqs || BDB::nreqs;
3170 warn "iterate...";
3171 }
3172
3173 ++$RELOAD;
3174
2039 # cancel all extension coros 3175 warn "cancelling all extension coros";
2040 $_->cancel for values %EXT_CORO; 3176 $_->cancel for values %EXT_CORO;
2041 %EXT_CORO = (); 3177 %EXT_CORO = ();
2042 3178
2043 # unload all extensions 3179 warn "removing commands";
2044 for (@exts) { 3180 %COMMAND = ();
3181
3182 warn "removing ext/exti commands";
3183 %EXTCMD = ();
3184 %EXTICMD = ();
3185
3186 warn "unloading/nuking all extensions";
3187 for my $pkg (@EXTS) {
2045 warn "unloading <$_>"; 3188 warn "... unloading $pkg";
2046 unload_extension $_; 3189
3190 if (my $cb = $pkg->can ("unload")) {
3191 eval {
3192 $cb->($pkg);
3193 1
3194 } or warn "$pkg unloaded, but with errors: $@";
2047 } 3195 }
2048 3196
3197 warn "... nuking $pkg";
3198 Symbol::delete_package $pkg;
3199 }
3200
2049 # unload all modules loaded from $LIBDIR 3201 warn "unloading all perl modules loaded from $LIBDIR";
2050 while (my ($k, $v) = each %INC) { 3202 while (my ($k, $v) = each %INC) {
2051 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3203 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2052 3204
2053 warn "removing <$k>"; 3205 warn "... unloading $k";
2054 delete $INC{$k}; 3206 delete $INC{$k};
2055 3207
2056 $k =~ s/\.pm$//; 3208 $k =~ s/\.pm$//;
2057 $k =~ s/\//::/g; 3209 $k =~ s/\//::/g;
2058 3210
2061 } 3213 }
2062 3214
2063 Symbol::delete_package $k; 3215 Symbol::delete_package $k;
2064 } 3216 }
2065 3217
2066 # sync database to disk
2067 cf::db_sync;
2068 IO::AIO::flush;
2069
2070 # get rid of safe::, as good as possible 3218 warn "getting rid of safe::, as good as possible";
2071 Symbol::delete_package "safe::$_" 3219 Symbol::delete_package "safe::$_"
2072 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3220 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2073 3221
2074 # remove register_script_function callbacks
2075 # TODO
2076
2077 # unload cf.pm "a bit" 3222 warn "unloading cf.pm \"a bit\"";
2078 delete $INC{"cf.pm"}; 3223 delete $INC{"cf.pm"};
3224 delete $INC{"cf/pod.pm"};
2079 3225
2080 # don't, removes xs symbols, too, 3226 # don't, removes xs symbols, too,
2081 # and global variables created in xs 3227 # and global variables created in xs
2082 #Symbol::delete_package __PACKAGE__; 3228 #Symbol::delete_package __PACKAGE__;
2083 3229
2084 # reload cf.pm 3230 warn "unload completed, starting to reload now";
3231
2085 warn "reloading cf.pm"; 3232 warn "reloading cf.pm";
2086 require cf; 3233 require cf;
2087 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3234 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2088 3235
2089 # load config and database again 3236 warn "loading config and database again";
2090 cf::cfg_load; 3237 cf::cfg_load;
2091 cf::db_load;
2092 3238
2093 # load extensions
2094 warn "load extensions"; 3239 warn "loading extensions";
2095 cf::load_extensions; 3240 cf::load_extensions;
2096 3241
2097 # reattach attachments to objects 3242 warn "reattaching attachments to objects/players";
2098 warn "reattach"; 3243 _global_reattach; # objects, sockets
2099 _global_reattach; 3244 warn "reattaching attachments to maps";
2100 }; 3245 reattach $_ for values %MAP;
3246 warn "reattaching attachments to players";
3247 reattach $_ for values %PLAYER;
2101 3248
2102 if ($@) { 3249 warn "leaving sync_job";
3250
3251 1
3252 } or do {
2103 warn $@; 3253 warn $@;
2104 warn "error while reloading, exiting."; 3254 warn "error while reloading, exiting.";
2105 exit 1; 3255 exit 1;
2106 } 3256 };
2107 3257
2108 warn "reloaded successfully"; 3258 warn "reloaded";
2109}; 3259};
2110 3260
2111############################################################################# 3261our $RELOAD_WATCHER; # used only during reload
2112 3262
2113unless ($LINK_MAP) { 3263sub reload_perl() {
2114 $LINK_MAP = cf::map::new; 3264 # doing reload synchronously and two reloads happen back-to-back,
3265 # coro crashes during coro_state_free->destroy here.
2115 3266
2116 $LINK_MAP->width (41); 3267 $RELOAD_WATCHER ||= Event->timer (
2117 $LINK_MAP->height (41); 3268 reentrant => 0,
2118 $LINK_MAP->alloc;
2119 $LINK_MAP->path ("{link}");
2120 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2121 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2122
2123 # dirty hack because... archetypes are not yet loaded
2124 Event->timer (
2125 after => 2, 3269 after => 0,
3270 data => WF_AUTOCANCEL,
2126 cb => sub { 3271 cb => sub {
2127 $_[0]->w->cancel; 3272 do_reload_perl;
2128 3273 undef $RELOAD_WATCHER;
2129 # provide some exits "home"
2130 my $exit = cf::object::new "exit";
2131
2132 $exit->slaying ($EMERGENCY_POSITION->[0]);
2133 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2134 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2135
2136 $LINK_MAP->insert ($exit->clone, 19, 19);
2137 $LINK_MAP->insert ($exit->clone, 19, 20);
2138 $LINK_MAP->insert ($exit->clone, 19, 21);
2139 $LINK_MAP->insert ($exit->clone, 20, 19);
2140 $LINK_MAP->insert ($exit->clone, 20, 21);
2141 $LINK_MAP->insert ($exit->clone, 21, 19);
2142 $LINK_MAP->insert ($exit->clone, 21, 20);
2143 $LINK_MAP->insert ($exit->clone, 21, 21);
2144
2145 $exit->destroy;
2146 }); 3274 },
2147 3275 );
2148 $LINK_MAP->{deny_save} = 1;
2149 $LINK_MAP->{deny_reset} = 1;
2150
2151 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2152} 3276}
2153
2154register "<global>", __PACKAGE__;
2155 3277
2156register_command "reload" => sub { 3278register_command "reload" => sub {
2157 my ($who, $arg) = @_; 3279 my ($who, $arg) = @_;
2158 3280
2159 if ($who->flag (FLAG_WIZ)) { 3281 if ($who->flag (FLAG_WIZ)) {
2160 $who->message ("start of reload.");
2161 reload;
2162 $who->message ("end of reload."); 3282 $who->message ("reloading server.");
3283 async { reload_perl };
2163 } 3284 }
2164}; 3285};
2165 3286
2166unshift @INC, $LIBDIR; 3287unshift @INC, $LIBDIR;
2167 3288
3289my $bug_warning = 0;
3290
3291our @WAIT_FOR_TICK;
3292our @WAIT_FOR_TICK_BEGIN;
3293
3294sub wait_for_tick {
3295 return unless $TICK_WATCHER->is_active;
3296 return if $Coro::current == $Coro::main;
3297
3298 my $signal = new Coro::Signal;
3299 push @WAIT_FOR_TICK, $signal;
3300 $signal->wait;
3301}
3302
3303sub wait_for_tick_begin {
3304 return unless $TICK_WATCHER->is_active;
3305 return if $Coro::current == $Coro::main;
3306
3307 my $signal = new Coro::Signal;
3308 push @WAIT_FOR_TICK_BEGIN, $signal;
3309 $signal->wait;
3310}
3311
3312 my $min = 1e6;#d#
3313 my $avg = 10;
2168$TICK_WATCHER = Event->timer ( 3314$TICK_WATCHER = Event->timer (
2169 reentrant => 0, 3315 reentrant => 0,
3316 parked => 1,
2170 prio => 0, 3317 prio => 0,
2171 at => $NEXT_TICK || $TICK, 3318 at => $NEXT_TICK || $TICK,
2172 data => WF_AUTOCANCEL, 3319 data => WF_AUTOCANCEL,
2173 cb => sub { 3320 cb => sub {
3321 if ($Coro::current != $Coro::main) {
3322 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3323 unless ++$bug_warning > 10;
3324 return;
3325 }
3326
3327 $NOW = $tick_start = Event::time;
3328
2174 cf::server_tick; # one server iteration 3329 cf::server_tick; # one server iteration
3330
3331 0 && sync_job {#d#
3332 for(1..10) {
3333 my $t = Event::time;
3334 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3335 or die;
3336
3337 $map->width (50);
3338 $map->height (50);
3339 $map->alloc;
3340 $map->_load_objects ("/tmp/x.map", 1);
3341 my $t = Event::time - $t;
3342
3343 #next unless $t < 0.0013;#d#
3344 if ($t < $min) {
3345 $min = $t;
3346 }
3347 $avg = $avg * 0.99 + $t * 0.01;
3348 }
3349 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3350 exit 0;
3351 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3352 };
3353
2175 $RUNTIME += $TICK; 3354 $RUNTIME += $TICK;
2176 $NEXT_TICK += $TICK; 3355 $NEXT_TICK += $TICK;
2177 3356
3357 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3358 $NEXT_RUNTIME_WRITE = $NOW + 10;
3359 Coro::async_pool {
3360 write_runtime
3361 or warn "ERROR: unable to write runtime file: $!";
3362 };
3363 }
3364
3365# my $AFTER = Event::time;
3366# warn $AFTER - $NOW;#d#
3367
3368 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3369 $sig->send;
3370 }
3371 while (my $sig = shift @WAIT_FOR_TICK) {
3372 $sig->send;
3373 }
3374
3375 $NOW = Event::time;
3376
2178 # if we are delayed by four ticks or more, skip them all 3377 # if we are delayed by four ticks or more, skip them all
2179 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3378 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2180 3379
2181 $TICK_WATCHER->at ($NEXT_TICK); 3380 $TICK_WATCHER->at ($NEXT_TICK);
2182 $TICK_WATCHER->start; 3381 $TICK_WATCHER->start;
3382
3383 $LOAD = ($NOW - $tick_start) / $TICK;
3384 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3385
3386 _post_tick;
3387
3388
2183 }, 3389 },
2184); 3390);
2185 3391
3392{
2186IO::AIO::max_poll_time $TICK * 0.2; 3393 BDB::max_poll_time $TICK * 0.1;
2187 3394 $BDB_POLL_WATCHER = Event->io (
2188Event->io ( 3395 reentrant => 0,
2189 fd => IO::AIO::poll_fileno, 3396 fd => BDB::poll_fileno,
2190 poll => 'r', 3397 poll => 'r',
2191 prio => 5, 3398 prio => 0,
2192 data => WF_AUTOCANCEL,
2193 cb => \&IO::AIO::poll_cb,
2194);
2195
2196Event->timer (
2197 data => WF_AUTOCANCEL, 3399 data => WF_AUTOCANCEL,
2198 after => 0, 3400 cb => \&BDB::poll_cb,
2199 interval => 10, 3401 );
2200 cb => sub { 3402 BDB::min_parallel 8;
2201 (Coro::unblock_sub { 3403
2202 write_runtime 3404 BDB::set_sync_prepare {
2203 or warn "ERROR: unable to write runtime file: $!"; 3405 my $status;
3406 my $current = $Coro::current;
3407 (
3408 sub {
3409 $status = $!;
3410 $current->ready; undef $current;
3411 },
3412 sub {
3413 Coro::schedule while defined $current;
3414 $! = $status;
3415 },
3416 )
3417 };
3418
3419 unless ($DB_ENV) {
3420 $DB_ENV = BDB::db_env_create;
3421
3422 cf::sync_job {
3423 eval {
3424 BDB::db_env_open
3425 $DB_ENV,
3426 $BDBDIR,
3427 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3428 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3429 0666;
3430
3431 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3432
3433 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3434 $DB_ENV->set_lk_detect;
3435 };
3436
3437 cf::cleanup "db_env_open(db): $@" if $@;
2204 })->(); 3438 };
2205 }, 3439 }
2206); 3440}
3441
3442{
3443 IO::AIO::min_parallel 8;
3444
3445 undef $Coro::AIO::WATCHER;
3446 IO::AIO::max_poll_time $TICK * 0.1;
3447 $AIO_POLL_WATCHER = Event->io (
3448 reentrant => 0,
3449 data => WF_AUTOCANCEL,
3450 fd => IO::AIO::poll_fileno,
3451 poll => 'r',
3452 prio => 6,
3453 cb => \&IO::AIO::poll_cb,
3454 );
3455}
3456
3457my $_log_backtrace;
3458
3459sub _log_backtrace {
3460 my ($msg, @addr) = @_;
3461
3462 $msg =~ s/\n//;
3463
3464 # limit the # of concurrent backtraces
3465 if ($_log_backtrace < 2) {
3466 ++$_log_backtrace;
3467 async {
3468 my @bt = fork_call {
3469 @addr = map { sprintf "%x", $_ } @addr;
3470 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3471 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3472 or die "addr2line: $!";
3473
3474 my @funcs;
3475 my @res = <$fh>;
3476 chomp for @res;
3477 while (@res) {
3478 my ($func, $line) = splice @res, 0, 2, ();
3479 push @funcs, "[$func] $line";
3480 }
3481
3482 @funcs
3483 };
3484
3485 LOG llevInfo, "[ABT] $msg\n";
3486 LOG llevInfo, "[ABT] $_\n" for @bt;
3487 --$_log_backtrace;
3488 };
3489 } else {
3490 LOG llevInfo, "[ABT] $msg\n";
3491 LOG llevInfo, "[ABT] [suppressed]\n";
3492 }
3493}
3494
3495# load additional modules
3496use cf::pod;
2207 3497
2208END { cf::emergency_save } 3498END { cf::emergency_save }
2209 3499
22101 35001
2211 3501

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines