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.227 by root, Fri Mar 23 18:32:48 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 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;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.52 (); 15use Coro 3.61 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
21 24
25use JSON::XS 1.4 ();
22use BDB (); 26use BDB ();
23use Data::Dumper; 27use Data::Dumper;
24use Digest::MD5; 28use Digest::MD5;
25use Fcntl; 29use Fcntl;
26use YAML::Syck (); 30use YAML::Syck ();
27use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
28use Time::HiRes; 32use Time::HiRes;
29use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
30 35
31# configure various modules to our taste 36# configure various modules to our taste
32# 37#
38$Storable::canonical = 1; # reduce rsync transfers
33Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
34Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35 41
36$Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
37 43
45our %COMMAND = (); 51our %COMMAND = ();
46our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
47 53
48our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
49our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
50our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
52 59
53our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
54our @EVENT; 61our @EVENT;
55our $LIBDIR = datadir . "/ext";
56 62
57our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
58our $TICK_WATCHER; 76our $TICK_WATCHER;
59our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 79our $NEXT_TICK;
62our $NOW; 80our $NOW;
71our $RUNTIME; 89our $RUNTIME;
72 90
73our %PLAYER; # all users 91our %PLAYER; # all users
74our %MAP; # all maps 92our %MAP; # all maps
75our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 94
82# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
85binmode STDOUT; 102binmode STDOUT;
86binmode STDERR; 103binmode STDERR;
87 104
88# read virtual server time, if available 105# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
91 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
92 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
93} 110}
94 111
95mkdir cf::localdir; 112mkdir $_
96mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97mkdir cf::localdir . "/" . cf::tmpdir;
98mkdir cf::localdir . "/" . cf::uniquedir;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 114
102our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
103 116
104sub cf::map::normalise; 117sub cf::map::normalise;
105 118
116=item $cf::RUNTIME 129=item $cf::RUNTIME
117 130
118The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
119every server tick. 132every server tick.
120 133
121=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
122 137
123The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
124be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
125 142
126=item $cf::NOW 143=item $cf::NOW
127 144
128The time of the last (current) server tick. 145The time of the last (current) server tick.
129 146
130=item $cf::TICK 147=item $cf::TICK
131 148
132The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
133 160
134=item %cf::CFG 161=item %cf::CFG
135 162
136Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
137from wherever your confdir points to. 164from wherever your confdir points to.
138 165
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
140 167
141These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
142or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
143processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
144window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
145 177
146=back 178=back
147 179
148=cut 180=cut
149 181
150BEGIN { 182BEGIN {
151 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
152 my $msg = join "", @_; 184 my $msg = join "", @_;
153 utf8::encode $msg;
154 185
155 $msg .= "\n" 186 $msg .= "\n"
156 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
157 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
158 LOG llevError, $msg; 192 LOG llevError, $msg;
159 }; 193 };
160} 194}
161 195
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
167@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
168 203
169# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
170# within the Safe compartment. 205# within the Safe compartment.
171for my $pkg (qw( 206for my $pkg (qw(
172 cf::global cf::attachable 207 cf::global cf::attachable
180} 215}
181 216
182$Event::DIED = sub { 217$Event::DIED = sub {
183 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
184}; 219};
220
221#############################################################################
185 222
186=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
187 224
188=over 4 225=over 4
189 226
208 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
209 $d 246 $d
210 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
211} 248}
212 249
213use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
216 251
217Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
218 253
219=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
220 255
221Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
222 264
223=item cf::lock_wait $string 265=item cf::lock_wait $string
224 266
225Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
226 268
232returned. 274returned.
233 275
234Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
235uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
236 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
237=cut 283=cut
238 284
239our %LOCK; 285our %LOCK;
240 286
241sub lock_wait($) { 287sub lock_wait($) {
258 304
259 Coro::guard { 305 Coro::guard {
260 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
262 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
263} 315}
264 316
265sub freeze_mainloop { 317sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
267 319
270 }; 322 };
271 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
272 $guard 324 $guard
273} 325}
274 326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
275=item cf::async { BLOCK } 383=item cf::async { BLOCK }
276 384
277Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
278C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
279thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
282 390
283BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
284 392
285=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
286 394
287The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
290 399
291If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
294fast or be very important. 403fast or be very important.
297 406
298sub sync_job(&) { 407sub sync_job(&) {
299 my ($job) = @_; 408 my ($job) = @_;
300 409
301 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
302 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
304 415
305 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 417 # (but this is cancel-safe)
317 428
318 while ($busy) { 429 while ($busy) {
319 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
320 } 431 }
321 432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
322 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
323 } else { 441 } else {
324 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
325 443
326 $job->() 444 $job->()
345 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
346 464
347 $coro 465 $coro
348} 466}
349 467
350sub write_runtime { 468=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 469
353 my $runtime = cf::localdir . "/runtime"; 470Executes the given code block with the given arguments in a seperate
471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
354 474
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
356 or return;
357 476
358 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
359 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
360 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
361 480 Storable::store_fd $_[0], $fh;
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0
363 and return;
364
365 # always fsync - this file is important
366 aio_fsync $fh
367 and return;
368
369 close $fh 481 close $fh;
370 or return;
371 482
372 aio_rename "$runtime~", $runtime 483 $buf
373 and return; 484}
374 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
375 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
376} 655}
377 656
378=back 657=back
379 658
380=cut 659=cut
387attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
388to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
389 668
390In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
391C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
392crossfire+). 671Crossfire TRT).
393 672
394=over 4 673=over 4
395 674
396=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
397 676
560 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
561 840
562 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
563 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
564 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
565 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
566 845
567 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
568 my $pkg = shift @arg; 847 my $pkg = shift @arg;
569 848
570 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
599 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
600 } 879 }
601 880
602 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
603 } else { 882 } else {
604 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
605 } 884 }
606 885
607 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
608} 887}
609 888
611 if (ref $_[0]) { 890 if (ref $_[0]) {
612 _object_attach @_; 891 _object_attach @_;
613 } else { 892 } else {
614 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
615 } 894 }
895 _recalc_want;
616}; 896};
617 897
618# all those should be optimised 898# all those should be optimised
619sub cf::attachable::detach { 899sub cf::attachable::detach {
620 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
623 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
624 reattach ($obj); 904 reattach ($obj);
625 } else { 905 } else {
626 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
627 } 907 }
908 _recalc_want;
628}; 909};
629 910
630sub cf::attachable::attached { 911sub cf::attachable::attached {
631 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
632 913
647 "; 928 ";
648 die if $@; 929 die if $@;
649} 930}
650 931
651our $override; 932our $override;
652our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
653 934
654sub override { 935sub override {
655 $override = 1; 936 $override = 1;
656 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
657} 938}
658 939
659sub do_invoke { 940sub do_invoke {
660 my $event = shift; 941 my $event = shift;
661 my $callbacks = shift; 942 my $callbacks = shift;
662 943
663 @invoke_results = (); 944 @INVOKE_RESULTS = ();
664 945
665 local $override; 946 local $override;
666 947
667 for (@$callbacks) { 948 for (@$callbacks) {
668 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
685 966
686Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
687 968
688This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
689removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
690results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
691 972
692=back 973=back
693 974
694=cut 975=cut
695 976
696############################################################################# 977#############################################################################
697# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
698 990
699sub reattach { 991sub reattach {
700 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
701 my ($obj) = @_; 993 my ($obj) = @_;
702 994
805 or return; 1097 or return;
806 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
807 } 1099 }
808 1100
809 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
810 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
811 return ($data, $av); 1103 return ($data, $av);
812} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
813 1111
814############################################################################# 1112#############################################################################
815# command handling &c 1113# command handling &c
816 1114
817=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
830 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
831} 1129}
832 1130
833=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
834 1132
835Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
836 1138
837If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
838called. 1140called.
839 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
840=cut 1153=cut
841 1154
842sub register_extcmd { 1155sub register_extcmd {
843 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
844 1157
845 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
846} 1165}
847 1166
848cf::player->attach ( 1167cf::player->attach (
849 on_command => sub { 1168 on_command => sub {
850 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
859 cf::override; 1178 cf::override;
860 }, 1179 },
861 on_extcmd => sub { 1180 on_extcmd => sub {
862 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
863 1182
864 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
865 1184
866 if (ref $msg) { 1185 if (ref $msg) {
867 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
868 if (my %reply = $cb->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
869 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
875 1194
876 cf::override; 1195 cf::override;
877 }, 1196 },
878); 1197);
879 1198
880sub load_extension {
881 my ($path) = @_;
882
883 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
884 my $base = $1;
885 my $pkg = $1;
886 $pkg =~ s/[^[:word:]]/_/g;
887 $pkg = "ext::$pkg";
888
889 warn "... loading '$path' into '$pkg'\n";
890
891 open my $fh, "<:utf8", $path
892 or die "$path: $!";
893
894 my $source =
895 "package $pkg; use strict; use utf8;\n"
896 . "#line 1 \"$path\"\n{\n"
897 . (do { local $/; <$fh> })
898 . "\n};\n1";
899
900 unless (eval $source) {
901 my $msg = $@ ? "$path: $@\n"
902 : "extension disabled.\n";
903 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
904 warn $@;
905 warn "mandatory extension failed to load, exiting.\n";
906 exit 1;
907 }
908 die $@;
909 }
910
911 push @EXTS, $pkg;
912}
913
914sub load_extensions { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
915 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
916 next unless -r $ext; 1204 next unless -r $path;
917 eval { 1205
918 load_extension $ext; 1206 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1207 my $base = $1;
1208 my $pkg = $1;
1209 $pkg =~ s/[^[:word:]]/_/g;
1210 $pkg = "ext::$pkg";
1211
1212 open my $fh, "<:utf8", $path
1213 or die "$path: $!";
1214
1215 my $source = do { local $/; <$fh> };
1216
1217 my %ext = (
1218 path => $path,
1219 base => $base,
1220 pkg => $pkg,
1221 );
1222
1223 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1224 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1225
1226 $ext{source} =
1227 "package $pkg; use strict; use utf8;\n"
1228 . "#line 1 \"$path\"\n{\n"
1229 . $source
1230 . "\n};\n1";
1231
1232 $todo{$base} = \%ext;
1233 }
1234
1235 my %done;
1236 while (%todo) {
1237 my $progress;
1238
1239 while (my ($k, $v) = each %todo) {
1240 for (split /,\s*/, $v->{meta}{depends}) {
1241 goto skip
1242 unless exists $done{$_};
1243 }
1244
1245 warn "... loading '$k' into '$v->{pkg}'\n";
1246
1247 unless (eval $v->{source}) {
1248 my $msg = $@ ? "$v->{path}: $@\n"
1249 : "$v->{base}: extension inactive.\n";
1250
1251 if (exists $v->{meta}{mandatory}) {
1252 warn $msg;
1253 warn "mandatory extension failed to load, exiting.\n";
1254 exit 1;
1255 }
1256
1257 warn $msg;
1258 }
1259
1260 $done{$k} = delete $todo{$k};
1261 push @EXTS, $v->{pkg};
1262 $progress = 1;
919 1 1263 }
920 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
921 } 1269 };
922} 1270}
923 1271
924############################################################################# 1272#############################################################################
925 1273
1274=back
1275
926=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
927 1277
928Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
929 1279
930=cut 1280=cut
942Returns the given player object, loading it if necessary (might block). 1292Returns the given player object, loading it if necessary (might block).
943 1293
944=cut 1294=cut
945 1295
946sub playerdir($) { 1296sub playerdir($) {
947 cf::localdir 1297 "$PLAYERDIR/"
948 . "/"
949 . cf::playerdir
950 . "/"
951 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1298 . (ref $_[0] ? $_[0]->ob->name : $_[0])
952} 1299}
953 1300
954sub path($) { 1301sub path($) {
955 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1302 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
956 1303
957 (playerdir $login) . "/$login.pl" 1304 (playerdir $login) . "/playerdata"
958} 1305}
959 1306
960sub find_active($) { 1307sub find_active($) {
961 $cf::PLAYER{$_[0]} 1308 $cf::PLAYER{$_[0]}
962 and $cf::PLAYER{$_[0]}->active 1309 and $cf::PLAYER{$_[0]}->active
975 my $login = $_[0]; 1322 my $login = $_[0];
976 1323
977 my $guard = cf::lock_acquire "user_find:$login"; 1324 my $guard = cf::lock_acquire "user_find:$login";
978 1325
979 $cf::PLAYER{$_[0]} || do { 1326 $cf::PLAYER{$_[0]} || do {
1327 # rename old playerfiles to new ones
1328 #TODO: remove when no longer required
1329 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1330 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1331 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1332 aio_unlink +(playerdir $login) . "/$login.pl";
1333
980 my $pl = load_pl path $login 1334 my $pl = load_pl path $login
981 or return; 1335 or return;
982 $cf::PLAYER{$login} = $pl 1336 $cf::PLAYER{$login} = $pl
983 } 1337 }
984 } 1338 }
1068while and may block, so not sync_job-capable, ever. 1422while and may block, so not sync_job-capable, ever.
1069 1423
1070=cut 1424=cut
1071 1425
1072sub list_logins { 1426sub list_logins {
1073 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1427 my $dirs = aio_readdir $PLAYERDIR
1074 or return []; 1428 or return [];
1075 1429
1076 my @logins; 1430 my @logins;
1077 1431
1078 for my $login (@$dirs) { 1432 for my $login (@$dirs) {
1113 } 1467 }
1114 1468
1115 \@paths 1469 \@paths
1116} 1470}
1117 1471
1472=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1473
1474Expand crossfire pod fragments into protocol xml.
1475
1476=cut
1477
1478sub expand_cfpod {
1479 ((my $self), (local $_)) = @_;
1480
1481 # escape & and <
1482 s/&/&amp;/g;
1483 s/(?<![BIUGH])</&lt;/g;
1484
1485 # this is buggy, it needs to properly take care of nested <'s
1486
1487 1 while
1488 # replace B<>, I<>, U<> etc.
1489 s/B<([^\>]*)>/<b>$1<\/b>/
1490 || s/I<([^\>]*)>/<i>$1<\/i>/
1491 || s/U<([^\>]*)>/<u>$1<\/u>/
1492 # replace G<male|female> tags
1493 || s{G<([^>|]*)\|([^>]*)>}{
1494 $self->gender ? $2 : $1
1495 }ge
1496 # replace H<hint text>
1497 || s{H<([^\>]*)>}
1498 {
1499 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1500 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1501 "")
1502 [$self->{hintmode}]
1503 }ge;
1504
1505 # create single paragraphs (very hackish)
1506 s/(?<=\S)\n(?=\w)/ /g;
1507
1508 # compress some whitespace
1509 s/\s+\n/\n/g; # ws line-ends
1510 s/\n\n+/\n/g; # double lines
1511 s/^\n+//; # beginning lines
1512 s/\n+$//; # ending lines
1513
1514 $_
1515}
1516
1517sub hintmode {
1518 $_[0]{hintmode} = $_[1] if @_ > 1;
1519 $_[0]{hintmode}
1520}
1521
1118=item $player->ext_reply ($msgid, $msgtype, %msg) 1522=item $player->ext_reply ($msgid, %msg)
1119 1523
1120Sends an ext reply to the player. 1524Sends an ext reply to the player.
1121 1525
1122=cut 1526=cut
1123 1527
1124sub ext_reply($$$%) { 1528sub ext_reply($$%) {
1125 my ($self, $id, %msg) = @_; 1529 my ($self, $id, %msg) = @_;
1126 1530
1127 $msg{msgid} = $id; 1531 $msg{msgid} = $id;
1128 1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1129 $self->send ("ext " . cf::to_json \%msg);
1130} 1533}
1131 1534
1132package cf; 1535=item $player->ext_event ($type, %msg)
1536
1537Sends an ext event to the client.
1538
1539=cut
1540
1541sub ext_event($$%) {
1542 my ($self, $type, %msg) = @_;
1543
1544 $self->ns->ext_event ($type, %msg);
1545}
1546
1547=head3 cf::region
1548
1549=over 4
1550
1551=cut
1552
1553package cf::region;
1554
1555=item cf::region::find_by_path $path
1556
1557Tries to decuce the likely region for a map knowing only its path.
1558
1559=cut
1560
1561sub find_by_path($) {
1562 my ($path) = @_;
1563
1564 my ($match, $specificity);
1565
1566 for my $region (list) {
1567 if ($region->{match} && $path =~ $region->{match}) {
1568 ($match, $specificity) = ($region, $region->specificity)
1569 if $region->specificity > $specificity;
1570 }
1571 }
1572
1573 $match
1574}
1133 1575
1134=back 1576=back
1135
1136 1577
1137=head3 cf::map 1578=head3 cf::map
1138 1579
1139=over 4 1580=over 4
1140 1581
1195 my ($self, $merge) = @_; 1636 my ($self, $merge) = @_;
1196 1637
1197 # we have to keep some variables in memory intact 1638 # we have to keep some variables in memory intact
1198 local $self->{path}; 1639 local $self->{path};
1199 local $self->{load_path}; 1640 local $self->{load_path};
1200 local $self->{deny_save};
1201 local $self->{deny_reset};
1202 1641
1203 $self->SUPER::thawer_merge ($merge); 1642 $self->SUPER::thawer_merge ($merge);
1204} 1643}
1205 1644
1206sub normalise { 1645sub normalise {
1253 $self->init; # pass $1 etc. 1692 $self->init; # pass $1 etc.
1254 return $self; 1693 return $self;
1255 } 1694 }
1256 } 1695 }
1257 1696
1258 Carp::carp "unable to resolve path '$path' (base '$base')."; 1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1259 () 1698 ()
1260} 1699}
1261 1700
1262sub init { 1701sub init {
1263 my ($self) = @_; 1702 my ($self) = @_;
1278 1717
1279# the original (read-only) location 1718# the original (read-only) location
1280sub load_path { 1719sub load_path {
1281 my ($self) = @_; 1720 my ($self) = @_;
1282 1721
1283 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1722 "$MAPDIR/$self->{path}.map"
1284} 1723}
1285 1724
1286# the temporary/swap location 1725# the temporary/swap location
1287sub save_path { 1726sub save_path {
1288 my ($self) = @_; 1727 my ($self) = @_;
1289 1728
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1729 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1730 "$TMPDIR/$path.map"
1292} 1731}
1293 1732
1294# the unique path, undef == no special unique path 1733# the unique path, undef == no special unique path
1295sub uniq_path { 1734sub uniq_path {
1296 my ($self) = @_; 1735 my ($self) = @_;
1297 1736
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1737 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1738 "$UNIQUEDIR/$path"
1300} 1739}
1301 1740
1302# and all this just because we cannot iterate over 1741# and all this just because we cannot iterate over
1303# all maps in C++... 1742# all maps in C++...
1304sub change_all_map_light { 1743sub change_all_map_light {
1305 my ($change) = @_; 1744 my ($change) = @_;
1306 1745
1307 $_->change_map_light ($change) 1746 $_->change_map_light ($change)
1308 for grep $_->outdoor, values %cf::MAP; 1747 for grep $_->outdoor, values %cf::MAP;
1748}
1749
1750sub decay_objects {
1751 my ($self) = @_;
1752
1753 return if $self->{deny_reset};
1754
1755 $self->do_decay_objects;
1309} 1756}
1310 1757
1311sub unlink_save { 1758sub unlink_save {
1312 my ($self) = @_; 1759 my ($self) = @_;
1313 1760
1371 $self->load_header_orig 1818 $self->load_header_orig
1372 or return; 1819 or return;
1373 $self->prepare_orig; 1820 $self->prepare_orig;
1374 } 1821 }
1375 1822
1823 $self->{deny_reset} = 1
1824 if $self->no_reset;
1825
1826 $self->default_region (cf::region::find_by_path $self->{path})
1827 unless $self->default_region;
1828
1376 1 1829 1
1377} 1830}
1378 1831
1379sub find; 1832sub find;
1380sub find { 1833sub find {
1392 $map->{last_save} = $cf::RUNTIME; 1845 $map->{last_save} = $cf::RUNTIME;
1393 1846
1394 $map->load_header 1847 $map->load_header
1395 or return; 1848 or return;
1396 1849
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 1851 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 1852 #$cf::WAIT_FOR_TICK->wait;
1400 $map->reset; 1853 $map->reset;
1401 undef $guard; 1854 undef $guard;
1402 return find $path; 1855 return find $path;
1413 my ($self) = @_; 1866 my ($self) = @_;
1414 1867
1415 local $self->{deny_reset} = 1; # loading can take a long time 1868 local $self->{deny_reset} = 1; # loading can take a long time
1416 1869
1417 my $path = $self->{path}; 1870 my $path = $self->{path};
1871
1872 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 1873 my $guard = cf::lock_acquire "map_load:$path";
1419 1874
1420 return if $self->in_memory != cf::MAP_SWAPPED; 1875 return if $self->in_memory != cf::MAP_SWAPPED;
1421 1876
1422 $self->in_memory (cf::MAP_LOADING); 1877 $self->in_memory (cf::MAP_LOADING);
1423 1878
1424 $self->alloc; 1879 $self->alloc;
1425 1880
1426 $self->pre_load; 1881 $self->pre_load;
1427
1428 $self->_load_objects ($self->{load_path}, 1)
1429 or return;
1430
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432 if delete $self->{load_original};
1433
1434 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) {
1437 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0);
1439 }
1440 }
1441
1442 Coro::cede;
1443
1444 # now do the right thing for maps
1445 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede; 1882 Coro::cede;
1452 $self->set_darkness_map; 1883
1884 $self->_load_objects ($self->{load_path}, 1)
1885 or return;
1886
1887 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1888 if delete $self->{load_original};
1889
1890 if (my $uniq = $self->uniq_path) {
1891 utf8::encode $uniq;
1892 if (aio_open $uniq, O_RDONLY, 0) {
1893 $self->clear_unique_items;
1894 $self->_load_objects ($uniq, 0);
1895 }
1896 }
1897
1898 Coro::cede;
1899 # now do the right thing for maps
1900 $self->link_multipart_objects;
1453 $self->difficulty ($self->estimate_difficulty) 1901 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 1902 unless $self->difficulty;
1455 Coro::cede; 1903 Coro::cede;
1904
1905 unless ($self->{deny_activate}) {
1906 $self->decay_objects;
1907 $self->fix_auto_apply;
1908 $self->update_buttons;
1909 Coro::cede;
1910 $self->set_darkness_map;
1911 Coro::cede;
1456 $self->activate; 1912 $self->activate;
1913 }
1914
1915 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 1916 }
1458 1917
1459 $self->post_load; 1918 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 1919}
1463 1920
1464sub customise_for { 1921sub customise_for {
1465 my ($self, $ob) = @_; 1922 my ($self, $ob) = @_;
1466 1923
1467 return find "~" . $ob->name . "/" . $self->{path} 1924 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 1925 if $self->per_player;
1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1469 1929
1470 $self 1930 $self
1471} 1931}
1472 1932
1473# find and load all maps in the 3x3 area around a map 1933# find and load all maps in the 3x3 area around a map
1520 1980
1521 undef $MAP_PREFETCH{$path}; 1981 undef $MAP_PREFETCH{$path};
1522 $MAP_PREFETCHER ||= cf::async { 1982 $MAP_PREFETCHER ||= cf::async {
1523 while (%MAP_PREFETCH) { 1983 while (%MAP_PREFETCH) {
1524 for my $path (keys %MAP_PREFETCH) { 1984 for my $path (keys %MAP_PREFETCH) {
1525 my $map = find $path 1985 if (my $map = find $path) {
1526 or next;
1527 $map->load; 1986 $map->load;
1987 }
1528 1988
1529 delete $MAP_PREFETCH{$path}; 1989 delete $MAP_PREFETCH{$path};
1530 } 1990 }
1531 } 1991 }
1532 undef $MAP_PREFETCHER; 1992 undef $MAP_PREFETCHER;
1584 2044
1585sub reset_at { 2045sub reset_at {
1586 my ($self) = @_; 2046 my ($self) = @_;
1587 2047
1588 # TODO: safety, remove and allow resettable per-player maps 2048 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 2049 return 1e99 if $self->{deny_reset};
1591 2050
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 2053
1605 my ($self) = @_; 2064 my ($self) = @_;
1606 2065
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 2067
1609 return if $self->players; 2068 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 2069
1612 warn "resetting map ", $self->path;#d# 2070 warn "resetting map ", $self->path;
1613 2071
1614 $self->in_memory (cf::MAP_SWAPPED); 2072 $self->in_memory (cf::MAP_SWAPPED);
1615 2073
1616 # need to save uniques path 2074 # need to save uniques path
1617 unless ($self->{deny_save}) { 2075 unless ($self->{deny_save}) {
1649 $cf::MAP{$self->path} = $self; 2107 $cf::MAP{$self->path} = $self;
1650 2108
1651 $self->reset; # polite request, might not happen 2109 $self->reset; # polite request, might not happen
1652} 2110}
1653 2111
2112=item $maps = cf::map::tmp_maps
2113
2114Returns an arrayref with all map paths of currently instantiated and saved
2115maps. May block.
2116
2117=cut
2118
2119sub tmp_maps() {
2120 [
2121 map {
2122 utf8::decode $_;
2123 /\.map$/
2124 ? normalise $_
2125 : ()
2126 } @{ aio_readdir $TMPDIR or [] }
2127 ]
2128}
2129
2130=item $maps = cf::map::random_maps
2131
2132Returns an arrayref with all map paths of currently instantiated and saved
2133random maps. May block.
2134
2135=cut
2136
2137sub random_maps() {
2138 [
2139 map {
2140 utf8::decode $_;
2141 /\.map$/
2142 ? normalise "?random/$_"
2143 : ()
2144 } @{ aio_readdir $RANDOMDIR or [] }
2145 ]
2146}
2147
1654=item cf::map::unique_maps 2148=item cf::map::unique_maps
1655 2149
1656Returns an arrayref of paths of all shared maps that have 2150Returns an arrayref of paths of all shared maps that have
1657instantiated unique items. May block. 2151instantiated unique items. May block.
1658 2152
1659=cut 2153=cut
1660 2154
1661sub unique_maps() { 2155sub unique_maps() {
1662 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2156 [
1663 or return; 2157 map {
1664
1665 my @paths;
1666
1667 for (@$files) {
1668 utf8::decode $_; 2158 utf8::decode $_;
1669 next if /\.pst$/; 2159 /\.map$/
1670 next unless /^$PATH_SEP/o; 2160 ? normalise $_
1671 2161 : ()
1672 push @paths, cf::map::normalise $_; 2162 } @{ aio_readdir $UNIQUEDIR or [] }
1673 } 2163 ]
1674
1675 \@paths
1676} 2164}
1677 2165
1678package cf; 2166package cf;
1679 2167
1680=back 2168=back
1726 2214
1727 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728 2216
1729 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1730 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1731 } else { 2220 } else {
2221 my $pl = $self->contr;
2222
2223 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2224 my $diag = $pl->{npc_dialog};
2225 $diag->{pl}->ext_reply (
2226 $diag->{id},
2227 msgtype => "reply",
2228 msg => $diag->{pl}->expand_cfpod ($msg),
2229 add_topics => []
2230 );
2231
2232 } else {
1732 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1733 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1734 } 2236 }
1735} 2237}
1736 2238
1737=item $player_object->may ("access") 2239=item $player_object->may ("access")
1738 2240
1786 $self->deactivate_recursive; 2288 $self->deactivate_recursive;
1787 2289
1788 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2290 return if UNIVERSAL::isa $self->map, "ext::map_link";
1789 2291
1790 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2292 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791 if $self->map; 2293 if $self->map && $self->map->{path} ne "{link}";
1792 2294
1793 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2295 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1794} 2296}
1795 2297
1796sub cf::object::player::leave_link { 2298sub cf::object::player::leave_link {
1797 my ($self, $map, $x, $y) = @_; 2299 my ($self, $map, $x, $y) = @_;
2300
2301 return unless $self->contr->active;
1798 2302
1799 my $link_pos = delete $self->{_link_pos}; 2303 my $link_pos = delete $self->{_link_pos};
1800 2304
1801 unless ($map) { 2305 unless ($map) {
1802 # restore original map position 2306 # restore original map position
1825 2329
1826 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827 $self->enter_map ($map, $x, $y); 2331 $self->enter_map ($map, $x, $y);
1828} 2332}
1829 2333
1830cf::player->attach ( 2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831 on_logout => sub {
1832 my ($pl) = @_;
1833 2335
1834 # abort map switching before logout 2336Moves the player to the given map-path and coordinates by first freezing
1835 if ($pl->ob->{_link_pos}) { 2337her, loading and preparing them map, calling the provided $check callback
1836 cf::sync_job { 2338that has to return the map if sucecssful, and then unfreezes the player on
1837 $pl->ob->leave_link 2339the new (success) or old (failed) map position. In either case, $done will
1838 }; 2340be called at the end of this process.
1839 }
1840 },
1841 on_login => sub {
1842 my ($pl) = @_;
1843 2341
1844 # try to abort aborted map switching on player login :)
1845 # should happen only on crashes
1846 if ($pl->ob->{_link_pos}) {
1847 $pl->ob->enter_link;
1848 (async {
1849 $pl->ob->reply (undef,
1850 "There was an internal problem at your last logout, "
1851 . "the server will try to bring you to your intended destination in a second.",
1852 cf::NDI_RED);
1853 # we need this sleep as the login has a concurrent enter_exit running
1854 # and this sleep increases chances of the player not ending up in scorn
1855 Coro::Timer::sleep 1;
1856 $pl->ob->leave_link;
1857 })->prio (2);
1858 }
1859 },
1860);
1861
1862=item $player_object->goto ($path, $x, $y)
1863
1864=cut 2342=cut
2343
2344our $GOTOGEN;
1865 2345
1866sub cf::object::player::goto { 2346sub cf::object::player::goto {
1867 my ($self, $path, $x, $y) = @_; 2347 my ($self, $path, $x, $y, $check, $done) = @_;
2348
2349 # do generation counting so two concurrent goto's will be executed in-order
2350 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868 2351
1869 $self->enter_link; 2352 $self->enter_link;
1870 2353
1871 (async { 2354 (async {
1872 my $map = eval { 2355 my $map = eval {
1873 my $map = cf::map::find $path; 2356 my $map = cf::map::find $path;
2357
2358 if ($map) {
1874 $map = $map->customise_for ($self) if $map; 2359 $map = $map->customise_for ($self);
2360 $map = $check->($map) if $check && $map;
2361 } else {
2362 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2363 }
2364
1875 $map 2365 $map
2366 };
2367
2368 if ($@) {
2369 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2370 LOG llevError | logBacktrace, Carp::longmess $@;
1876 } or 2371 }
1877 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878 2372
2373 if ($gen == $self->{_goto_generation}) {
2374 delete $self->{_goto_generation};
1879 $self->leave_link ($map, $x, $y); 2375 $self->leave_link ($map, $x, $y);
2376 }
2377
2378 $done->() if $done;
1880 })->prio (1); 2379 })->prio (1);
1881} 2380}
1882 2381
1883=item $player_object->enter_exit ($exit_object) 2382=item $player_object->enter_exit ($exit_object)
1884 2383
1923 2422
1924 $rmp->{random_seed} ||= $exit->random_seed; 2423 $rmp->{random_seed} ||= $exit->random_seed;
1925 2424
1926 my $data = cf::to_json $rmp; 2425 my $data = cf::to_json $rmp;
1927 my $md5 = Digest::MD5::md5_hex $data; 2426 my $md5 = Digest::MD5::md5_hex $data;
1928 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2427 my $meta = "$RANDOMDIR/$md5.meta";
1929 2428
1930 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2429 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931 aio_write $fh, 0, (length $data), $data, 0; 2430 aio_write $fh, 0, (length $data), $data, 0;
1932 undef $fh; 2431 undef $fh;
1933 aio_rename "$meta~", $meta; 2432 aio_rename "$meta~", $meta;
1942 2441
1943 return unless $self->type == cf::PLAYER; 2442 return unless $self->type == cf::PLAYER;
1944 2443
1945 if ($exit->slaying eq "/!") { 2444 if ($exit->slaying eq "/!") {
1946 #TODO: this should de-fi-ni-te-ly not be a sync-job 2445 #TODO: this should de-fi-ni-te-ly not be a sync-job
2446 # the problem is that $exit might not survive long enough
2447 # so it needs to be done right now, right here
1947 cf::sync_job { prepare_random_map $exit }; 2448 cf::sync_job { prepare_random_map $exit };
1948 } 2449 }
1949 2450
1950 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2451 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951 my $hp = $exit->stats->hp; 2452 my $hp = $exit->stats->hp;
1952 my $sp = $exit->stats->sp; 2453 my $sp = $exit->stats->sp;
1953 2454
1954 $self->enter_link; 2455 $self->enter_link;
2456
2457 # if exit is damned, update players death & WoR home-position
2458 $self->contr->savebed ($slaying, $hp, $sp)
2459 if $exit->flag (FLAG_DAMNED);
1955 2460
1956 (async { 2461 (async {
1957 $self->deactivate_recursive; # just to be sure 2462 $self->deactivate_recursive; # just to be sure
1958 unless (eval { 2463 unless (eval {
1959 $self->goto ($slaying, $hp, $sp); 2464 $self->goto ($slaying, $hp, $sp);
1960 2465
1961 1; 2466 1;
1962 }) { 2467 }) {
1963 $self->message ("Something went wrong deep within the crossfire server. " 2468 $self->message ("Something went wrong deep within the crossfire server. "
1964 . "I'll try to bring you back to the map you were before. " 2469 . "I'll try to bring you back to the map you were before. "
1965 . "Please report this to the dungeon master!", 2470 . "Please report this to the dungeon master!",
1966 cf::NDI_UNIQUE | cf::NDI_RED); 2471 cf::NDI_UNIQUE | cf::NDI_RED);
1967 2472
1968 warn "ERROR in enter_exit: $@"; 2473 warn "ERROR in enter_exit: $@";
1969 $self->leave_link; 2474 $self->leave_link;
1970 } 2475 }
1971 })->prio (1); 2476 })->prio (1);
1987 2492
1988 utf8::encode $text; 2493 utf8::encode $text;
1989 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990} 2495}
1991 2496
2497=item $client->send_msg ($channel, $msg, $color, [extra...])
2498
2499Send a drawinfo or msg packet to the client, formatting the msg for the
2500client if neccessary. C<$type> should be a string identifying the type of
2501the message, with C<log> being the default. If C<$color> is negative, suppress
2502the message unless the client supports the msg packet.
2503
2504=cut
2505
2506sub cf::client::send_msg {
2507 my ($self, $channel, $msg, $color, @extra) = @_;
2508
2509 $msg = $self->pl->expand_cfpod ($msg);
2510
2511 $color &= ~cf::NDI_UNIQUE; # just in case...
2512
2513 if (ref $channel) {
2514 # send meta info to client, if not yet sent
2515 unless (exists $self->{channel}{$channel->{id}}) {
2516 $self->{channel}{$channel->{id}} = $channel;
2517 $self->ext_event (channel_info => %$channel);
2518 }
2519
2520 $channel = $channel->{id};
2521 }
2522
2523 return unless @extra || length $msg;
2524
2525 if ($self->can_msg) {
2526 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2527 } else {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 if ($color >= 0) {
2539 if (0 && $msg =~ /\[/) {
2540 $self->send_packet ("drawextinfo $color 4 0 $msg")
2541 } else {
2542 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2543 $self->send_packet ("drawinfo $color $msg")
2544 }
2545 }
2546 }
2547}
2548
2549=item $client->ext_event ($type, %msg)
2550
2551Sends an ext event to the client.
2552
2553=cut
2554
2555sub cf::client::ext_event($$%) {
2556 my ($self, $type, %msg) = @_;
2557
2558 return unless $self->extcmd;
2559
2560 $msg{msgtype} = "event_$type";
2561 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2562}
1992 2563
1993=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
1994 2565
1995Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
1996the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2567the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2568C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998 2569
1999Queries can fail, so check the return code. Or don't, as queries will become 2570Queries can fail, so check the return code. Or don't, as queries will
2000reliable at some point in the future. 2571become reliable at some point in the future.
2001 2572
2002=cut 2573=cut
2003 2574
2004sub cf::client::query { 2575sub cf::client::query {
2005 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
2013 utf8::encode $text; 2584 utf8::encode $text;
2014 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015 2586
2016 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
2017 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
2018} 2591}
2019 2592
2020cf::client->attach ( 2593cf::client->attach (
2594 on_connect => sub {
2595 my ($ns) = @_;
2596
2597 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2598 },
2021 on_reply => sub { 2599 on_reply => sub {
2022 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
2023 2601
2024 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
2025 # get handled first 2603 # get handled first
2037 } else { 2615 } else {
2038 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039 } 2617 }
2040 } 2618 }
2041 }, 2619 },
2620 on_exticmd => sub {
2621 my ($ns, $buf) = @_;
2622
2623 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2624
2625 if (ref $msg) {
2626 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2627 if (my %reply = $cb->($ns, $msg)) {
2628 $reply{msgid} = $msg->{msgid};
2629 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2630 }
2631 }
2632 } else {
2633 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2634 }
2635
2636 cf::override;
2637 },
2042); 2638);
2043 2639
2044=item $client->async (\&cb) 2640=item $client->async (\&cb)
2045 2641
2046Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
2093 2689
2094# here we export the classes and methods available to script code 2690# here we export the classes and methods available to script code
2095 2691
2096=pod 2692=pod
2097 2693
2098The following fucntions and emthods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
2099 2695
2100 cf::object contr pay_amount pay_player map 2696 cf::object
2697 contr pay_amount pay_player map x y force_find force_add
2698 insert remove
2699
2101 cf::object::player player 2700 cf::object::player
2102 cf::player peaceful 2701 player
2103 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
2104 2708
2105=cut 2709=cut
2106 2710
2107for ( 2711for (
2108 ["cf::object" => qw(contr pay_amount pay_player map)], 2712 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2713 insert remove)],
2109 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
2110 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
2111 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
2112) { 2717) {
2113 no strict 'refs'; 2718 no strict 'refs';
2184=back 2789=back
2185 2790
2186=cut 2791=cut
2187 2792
2188############################################################################# 2793#############################################################################
2189
2190=head2 EXTENSION DATABASE SUPPORT
2191
2192Crossfire maintains a very simple database for extension use. It can
2193currently store anything that can be serialised using Storable, which
2194excludes objects.
2195
2196The parameter C<$family> should best start with the name of the extension
2197using it, it should be unique.
2198
2199=over 4
2200
2201=item $value = cf::db_get $family => $key
2202
2203Returns a single value from the database.
2204
2205=item cf::db_put $family => $key => $value
2206
2207Stores the given C<$value> in the family.
2208
2209=cut
2210
2211our $DB;
2212
2213sub db_init {
2214 unless ($DB) {
2215 $DB = BDB::db_create $DB_ENV;
2216
2217 cf::sync_job {
2218 eval {
2219 $DB->set_flags (BDB::CHKSUM);
2220
2221 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223 cf::cleanup "db_open(db): $!" if $!;
2224 };
2225 cf::cleanup "db_open(db): $@" if $@;
2226 };
2227
2228 my $path = cf::localdir . "/database.pst";
2229 if (stat $path) {
2230 cf::sync_job {
2231 my $pst = Storable::retrieve $path;
2232
2233 cf::db_put (board => data => $pst->{board});
2234 cf::db_put (guildrules => data => $pst->{guildrules});
2235 cf::db_put (rent => balance => $pst->{rent}{balance});
2236 BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238 unlink $path;
2239 };
2240 }
2241 }
2242}
2243
2244sub db_get($$) {
2245 my $key = "$_[0]/$_[1]";
2246
2247 cf::sync_job {
2248 BDB::db_get $DB, undef, $key, my $data;
2249
2250 $! ? ()
2251 : Compress::LZF::sthaw $data
2252 }
2253}
2254
2255sub db_put($$$) {
2256 BDB::dbreq_pri 4;
2257 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258}
2259
2260#############################################################################
2261# the server's init and main functions 2794# the server's init and main functions
2262 2795
2263sub load_faces { 2796sub load_facedata($) {
2264 my $path = sprintf "%s/faces", cf::datadir; 2797 my ($path) = @_;
2265 2798
2266 warn "loading faces from $path\n"; 2799 warn "loading facedata from $path\n";
2267 2800
2268 my $faces; 2801 my $facedata;
2269 0 < aio_load $path, $faces 2802 0 < aio_load $path, $facedata
2270 or die "$path: $!"; 2803 or die "$path: $!";
2271 2804
2272 Coro::cede;
2273 $faces = Storable::thaw $faces; 2805 $facedata = Coro::Storable::thaw $facedata;
2274 Coro::cede;
2275 2806
2276 my $meta = delete $faces->{""};
2277 $meta->{version} == 1 2807 $facedata->{version} == 2
2278 or cf::cleanup "$path: version mismatch, cannot proceed."; 2808 or cf::cleanup "$path: version mismatch, cannot proceed.";
2279 2809
2810 {
2811 my $faces = $facedata->{faceinfo};
2812
2280 while (my ($face, $info) = each %$faces) { 2813 while (my ($face, $info) = each %$faces) {
2281 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2814 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2282 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2815 cf::face::set_visibility $idx, $info->{visibility};
2816 cf::face::set_magicmap $idx, $info->{magicmap};
2283 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2817 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2284 Coro::cede; 2818 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2285 }
2286 2819
2820 cf::cede_to_tick;
2821 }
2822
2287 while (my ($face, $info) = each %$faces) { 2823 while (my ($face, $info) = each %$faces) {
2288 next unless $info->{smooth}; 2824 next unless $info->{smooth};
2289 my $idx = cf::face::find $face 2825 my $idx = cf::face::find $face
2290 or next; 2826 or next;
2291 if (my $smooth = cf::face::find $info->{smooth}) { 2827 if (my $smooth = cf::face::find $info->{smooth}) {
2292 cf::face::set_smooth $idx, $smooth; 2828 cf::face::set_smooth $idx, $smooth;
2829 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2293 } else { 2830 } else {
2294 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2831 warn "smooth face '$info->{smooth}' not found for face '$face'";
2295 } 2832 }
2296 Coro::cede; 2833
2834 cf::cede_to_tick;
2835 }
2836 }
2837
2838 {
2839 my $anims = $facedata->{animinfo};
2840
2841 while (my ($anim, $info) = each %$anims) {
2842 cf::anim::set $anim, $info->{frames}, $info->{facings};
2843 cf::cede_to_tick;
2844 }
2845
2846 cf::anim::invalidate_all; # d'oh
2847 }
2848
2849 {
2850 # TODO: for gcfclient pleasure, we should give resources
2851 # that gcfclient doesn't grok a >10000 face index.
2852 my $res = $facedata->{resource};
2853 my $enc = JSON::XS->new->utf8->canonical;
2854
2855 while (my ($name, $info) = each %$res) {
2856 my $meta = $enc->encode ({
2857 name => $name,
2858 type => $info->{type},
2859 copyright => $info->{copyright}, #TODO#
2860 });
2861
2862 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2863
2864 if ($name =~ /\.jpg$/) {
2865 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2866 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2867 } else {
2868 my $data = pack "(w/a*)*", $meta, $info->{data};
2869 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2870
2871 cf::face::set_type $idx, 1;
2872 cf::face::set_data $idx, 0, $data, $chk;
2873 }
2874
2875 cf::cede_to_tick;
2876 }
2297 } 2877 }
2298 2878
2299 1 2879 1
2300} 2880}
2301 2881
2882sub reload_regions {
2883 load_resource_file "$MAPDIR/regions"
2884 or die "unable to load regions file\n";
2885
2886 for (cf::region::list) {
2887 $_->{match} = qr/$_->{match}/
2888 if exists $_->{match};
2889 }
2890}
2891
2892sub reload_facedata {
2893 load_facedata "$DATADIR/facedata"
2894 or die "unable to load facedata\n";
2895}
2896
2897sub reload_archetypes {
2898 load_resource_file "$DATADIR/archetypes"
2899 or die "unable to load archetypes\n";
2900 #d# NEED to laod twice to resolve forward references
2901 # this really needs to be done in an extra post-pass
2902 # (which needs to be synchronous, so solve it differently)
2903 load_resource_file "$DATADIR/archetypes"
2904 or die "unable to load archetypes\n";
2905}
2906
2907sub reload_treasures {
2908 load_resource_file "$DATADIR/treasures"
2909 or die "unable to load treasurelists\n";
2910}
2911
2302sub reload_resources { 2912sub reload_resources {
2303 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2913 warn "reloading resource files...\n";
2304 or die "unable to load regions file\n";#d# 2914
2915 reload_regions;
2305 load_faces 2916 reload_facedata;
2306 or die "unable to load faces\n";#d# 2917 #reload_archetypes;#d#
2918 reload_archetypes;
2919 reload_treasures;
2920
2921 warn "finished reloading resource files\n";
2307} 2922}
2308 2923
2309sub init { 2924sub init {
2310 reload_resources; 2925 reload_resources;
2311} 2926}
2312 2927
2313sub cfg_load { 2928sub cfg_load {
2314 open my $fh, "<:utf8", cf::confdir . "/config" 2929 open my $fh, "<:utf8", "$CONFDIR/config"
2315 or return; 2930 or return;
2316 2931
2317 local $/; 2932 local $/;
2318 *CFG = YAML::Syck::Load <$fh>; 2933 *CFG = YAML::Syck::Load <$fh>;
2319 2934
2364 }, 2979 },
2365 ); 2980 );
2366 } 2981 }
2367} 2982}
2368 2983
2984sub write_runtime {
2985 my $runtime = "$LOCALDIR/runtime";
2986
2987 # first touch the runtime file to show we are still running:
2988 # the fsync below can take a very very long time.
2989
2990 IO::AIO::aio_utime $runtime, undef, undef;
2991
2992 my $guard = cf::lock_acquire "write_runtime";
2993
2994 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2995 or return;
2996
2997 my $value = $cf::RUNTIME + 90 + 10;
2998 # 10 is the runtime save interval, for a monotonic clock
2999 # 60 allows for the watchdog to kill the server.
3000
3001 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3002 and return;
3003
3004 # always fsync - this file is important
3005 aio_fsync $fh
3006 and return;
3007
3008 # touch it again to show we are up-to-date
3009 aio_utime $fh, undef, undef;
3010
3011 close $fh
3012 or return;
3013
3014 aio_rename "$runtime~", $runtime
3015 and return;
3016
3017 warn "runtime file written.\n";
3018
3019 1
3020}
3021
2369sub emergency_save() { 3022sub emergency_save() {
2370 my $freeze_guard = cf::freeze_mainloop; 3023 my $freeze_guard = cf::freeze_mainloop;
2371 3024
2372 warn "enter emergency perl save\n"; 3025 warn "enter emergency perl save\n";
2373 3026
2404 3057
2405 warn Carp::longmess "post_cleanup backtrace" 3058 warn Carp::longmess "post_cleanup backtrace"
2406 if $make_core; 3059 if $make_core;
2407} 3060}
2408 3061
2409sub reload() { 3062sub do_reload_perl() {
2410 # can/must only be called in main 3063 # can/must only be called in main
2411 if ($Coro::current != $Coro::main) { 3064 if ($Coro::current != $Coro::main) {
2412 warn "can only reload from main coroutine"; 3065 warn "can only reload from main coroutine";
2413 return; 3066 return;
2414 } 3067 }
2448 %EXT_CORO = (); 3101 %EXT_CORO = ();
2449 3102
2450 warn "removing commands"; 3103 warn "removing commands";
2451 %COMMAND = (); 3104 %COMMAND = ();
2452 3105
2453 warn "removing ext commands"; 3106 warn "removing ext/exti commands";
2454 %EXTCMD = (); 3107 %EXTCMD = ();
3108 %EXTICMD = ();
2455 3109
2456 warn "unloading/nuking all extensions"; 3110 warn "unloading/nuking all extensions";
2457 for my $pkg (@EXTS) { 3111 for my $pkg (@EXTS) {
2458 warn "... unloading $pkg"; 3112 warn "... unloading $pkg";
2459 3113
2489 Symbol::delete_package "safe::$_" 3143 Symbol::delete_package "safe::$_"
2490 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3144 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2491 3145
2492 warn "unloading cf.pm \"a bit\""; 3146 warn "unloading cf.pm \"a bit\"";
2493 delete $INC{"cf.pm"}; 3147 delete $INC{"cf.pm"};
3148 delete $INC{"cf/pod.pm"};
2494 3149
2495 # don't, removes xs symbols, too, 3150 # don't, removes xs symbols, too,
2496 # and global variables created in xs 3151 # and global variables created in xs
2497 #Symbol::delete_package __PACKAGE__; 3152 #Symbol::delete_package __PACKAGE__;
2498 3153
2513 warn "reattaching attachments to maps"; 3168 warn "reattaching attachments to maps";
2514 reattach $_ for values %MAP; 3169 reattach $_ for values %MAP;
2515 warn "reattaching attachments to players"; 3170 warn "reattaching attachments to players";
2516 reattach $_ for values %PLAYER; 3171 reattach $_ for values %PLAYER;
2517 3172
2518 warn "loading reloadable resources";
2519 reload_resources;
2520
2521 warn "leaving sync_job"; 3173 warn "leaving sync_job";
2522 3174
2523 1 3175 1
2524 } or do { 3176 } or do {
2525 warn $@; 3177 warn $@;
2530 warn "reloaded"; 3182 warn "reloaded";
2531}; 3183};
2532 3184
2533our $RELOAD_WATCHER; # used only during reload 3185our $RELOAD_WATCHER; # used only during reload
2534 3186
3187sub reload_perl() {
3188 # doing reload synchronously and two reloads happen back-to-back,
3189 # coro crashes during coro_state_free->destroy here.
3190
3191 $RELOAD_WATCHER ||= Event->timer (
3192 reentrant => 0,
3193 after => 0,
3194 data => WF_AUTOCANCEL,
3195 cb => sub {
3196 do_reload_perl;
3197 undef $RELOAD_WATCHER;
3198 },
3199 );
3200}
3201
2535register_command "reload" => sub { 3202register_command "reload" => sub {
2536 my ($who, $arg) = @_; 3203 my ($who, $arg) = @_;
2537 3204
2538 if ($who->flag (FLAG_WIZ)) { 3205 if ($who->flag (FLAG_WIZ)) {
2539 $who->message ("reloading server."); 3206 $who->message ("reloading server.");
2540 3207 async { reload_perl };
2541 # doing reload synchronously and two reloads happen back-to-back,
2542 # coro crashes during coro_state_free->destroy here.
2543
2544 $RELOAD_WATCHER ||= Event->timer (
2545 reentrant => 0,
2546 after => 0,
2547 data => WF_AUTOCANCEL,
2548 cb => sub {
2549 reload;
2550 undef $RELOAD_WATCHER;
2551 },
2552 );
2553 } 3208 }
2554}; 3209};
2555 3210
2556unshift @INC, $LIBDIR; 3211unshift @INC, $LIBDIR;
2557 3212
2558my $bug_warning = 0; 3213my $bug_warning = 0;
2559 3214
3215our @WAIT_FOR_TICK;
3216our @WAIT_FOR_TICK_BEGIN;
3217
3218sub wait_for_tick {
3219 return unless $TICK_WATCHER->is_active;
3220 return if $Coro::current == $Coro::main;
3221
3222 my $signal = new Coro::Signal;
3223 push @WAIT_FOR_TICK, $signal;
3224 $signal->wait;
3225}
3226
3227sub wait_for_tick_begin {
3228 return unless $TICK_WATCHER->is_active;
3229 return if $Coro::current == $Coro::main;
3230
3231 my $signal = new Coro::Signal;
3232 push @WAIT_FOR_TICK_BEGIN, $signal;
3233 $signal->wait;
3234}
3235
3236 my $min = 1e6;#d#
3237 my $avg = 10;
2560$TICK_WATCHER = Event->timer ( 3238$TICK_WATCHER = Event->timer (
2561 reentrant => 0, 3239 reentrant => 0,
2562 parked => 1, 3240 parked => 1,
2563 prio => 0, 3241 prio => 0,
2564 at => $NEXT_TICK || $TICK, 3242 at => $NEXT_TICK || $TICK,
2568 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3246 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2569 unless ++$bug_warning > 10; 3247 unless ++$bug_warning > 10;
2570 return; 3248 return;
2571 } 3249 }
2572 3250
2573 $NOW = Event::time; 3251 $NOW = $tick_start = Event::time;
2574 3252
2575 cf::server_tick; # one server iteration 3253 cf::server_tick; # one server iteration
3254
3255 0 && sync_job {#d#
3256 for(1..10) {
3257 my $t = Event::time;
3258 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3259 or die;
3260
3261 $map->width (50);
3262 $map->height (50);
3263 $map->alloc;
3264 $map->_load_objects ("/tmp/x.map", 1);
3265 my $t = Event::time - $t;
3266
3267 #next unless $t < 0.0013;#d#
3268 if ($t < $min) {
3269 $min = $t;
3270 }
3271 $avg = $avg * 0.99 + $t * 0.01;
3272 }
3273 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3274 exit 0;
3275 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3276 };
3277
2576 $RUNTIME += $TICK; 3278 $RUNTIME += $TICK;
2577 $NEXT_TICK += $TICK; 3279 $NEXT_TICK += $TICK;
2578 3280
2579 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3281 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2580 $NEXT_RUNTIME_WRITE = $NOW + 10; 3282 $NEXT_RUNTIME_WRITE = $NOW + 10;
2582 write_runtime 3284 write_runtime
2583 or warn "ERROR: unable to write runtime file: $!"; 3285 or warn "ERROR: unable to write runtime file: $!";
2584 }; 3286 };
2585 } 3287 }
2586 3288
2587 $WAIT_FOR_TICK->broadcast;
2588 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2589
2590# my $AFTER = Event::time; 3289# my $AFTER = Event::time;
2591# warn $AFTER - $NOW;#d# 3290# warn $AFTER - $NOW;#d#
2592 3291
3292 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3293 $sig->send;
3294 }
3295 while (my $sig = shift @WAIT_FOR_TICK) {
3296 $sig->send;
3297 }
3298
3299 $NOW = Event::time;
3300
2593 # if we are delayed by four ticks or more, skip them all 3301 # if we are delayed by four ticks or more, skip them all
2594 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3302 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2595 3303
2596 $TICK_WATCHER->at ($NEXT_TICK); 3304 $TICK_WATCHER->at ($NEXT_TICK);
2597 $TICK_WATCHER->start; 3305 $TICK_WATCHER->start;
3306
3307 $LOAD = ($NOW - $tick_start) / $TICK;
3308 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3309
3310 _post_tick;
3311
3312
2598 }, 3313 },
2599); 3314);
2600 3315
2601{ 3316{
2602 BDB::max_poll_time $TICK * 0.1; 3317 BDB::max_poll_time $TICK * 0.1;
2630 3345
2631 cf::sync_job { 3346 cf::sync_job {
2632 eval { 3347 eval {
2633 BDB::db_env_open 3348 BDB::db_env_open
2634 $DB_ENV, 3349 $DB_ENV,
2635 $BDB_ENV_DIR, 3350 $BDBDIR,
2636 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3351 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2637 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3352 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2638 0666; 3353 0666;
2639 3354
2640 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3355 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2641 3356
2642 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3357 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2643 $DB_ENV->set_lk_detect; 3358 $DB_ENV->set_lk_detect;
2644 }; 3359 };
2645 3360
2661 prio => 6, 3376 prio => 6,
2662 cb => \&IO::AIO::poll_cb, 3377 cb => \&IO::AIO::poll_cb,
2663 ); 3378 );
2664} 3379}
2665 3380
3381my $_log_backtrace;
3382
3383sub _log_backtrace {
3384 my ($msg, @addr) = @_;
3385
3386 $msg =~ s/\n//;
3387
3388 # limit the # of concurrent backtraces
3389 if ($_log_backtrace < 2) {
3390 ++$_log_backtrace;
3391 async {
3392 my @bt = fork_call {
3393 @addr = map { sprintf "%x", $_ } @addr;
3394 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3395 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3396 or die "addr2line: $!";
3397
3398 my @funcs;
3399 my @res = <$fh>;
3400 chomp for @res;
3401 while (@res) {
3402 my ($func, $line) = splice @res, 0, 2, ();
3403 push @funcs, "[$func] $line";
3404 }
3405
3406 @funcs
3407 };
3408
3409 LOG llevInfo, "[ABT] $msg\n";
3410 LOG llevInfo, "[ABT] $_\n" for @bt;
3411 --$_log_backtrace;
3412 };
3413 } else {
3414 LOG llevInfo, "[ABT] $msg\n";
3415 LOG llevInfo, "[ABT] [suppressed]\n";
3416 }
3417}
3418
3419# load additional modules
3420use cf::pod;
3421
2666END { cf::emergency_save } 3422END { cf::emergency_save }
2667 3423
26681 34241
2669 3425

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines