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.238 by root, Sat Apr 14 07:23:00 2007 UTC vs.
Revision 1.328 by root, Wed Aug 8 06:24:30 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;
21use Coro::Storable; 23use Coro::Storable;
22 24
25use JSON::XS 1.4 ();
23use BDB (); 26use BDB ();
24use Data::Dumper; 27use Data::Dumper;
25use Digest::MD5; 28use Digest::MD5;
26use Fcntl; 29use Fcntl;
27use YAML::Syck (); 30use YAML::Syck ();
28use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
29use Time::HiRes; 32use Time::HiRes;
30use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
31 35
32# configure various modules to our taste 36# configure various modules to our taste
33# 37#
34$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
35Coro::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
47our %COMMAND = (); 51our %COMMAND = ();
48our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
49 53
50our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
51our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
52our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
53our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
54 59
55our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
56our @EVENT; 61our @EVENT;
57our $LIBDIR = datadir . "/ext";
58 62
59our $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(!)
60our $TICK_WATCHER; 76our $TICK_WATCHER;
61our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
62our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
63our $NEXT_TICK; 79our $NEXT_TICK;
64our $NOW; 80our $NOW;
73our $RUNTIME; 89our $RUNTIME;
74 90
75our %PLAYER; # all users 91our %PLAYER; # all users
76our %MAP; # all maps 92our %MAP; # all maps
77our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
78our $RANDOM_MAPS = cf::localdir . "/random";
79our $BDB_ENV_DIR = cf::localdir . "/db";
80
81our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
82our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
83 94
84# 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 ∕
85our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
86 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
87binmode STDOUT; 102binmode STDOUT;
88binmode STDERR; 103binmode STDERR;
89 104
90# read virtual server time, if available 105# read virtual server time, if available
91unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
92 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
93 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
94 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
95} 110}
96 111
97mkdir cf::localdir; 112mkdir $_
98mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
99mkdir cf::localdir . "/" . cf::tmpdir;
100mkdir cf::localdir . "/" . cf::uniquedir;
101mkdir $RANDOM_MAPS;
102mkdir $BDB_ENV_DIR;
103 114
104our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
105 116
106sub cf::map::normalise; 117sub cf::map::normalise;
107 118
118=item $cf::RUNTIME 129=item $cf::RUNTIME
119 130
120The 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
121every server tick. 132every server tick.
122 133
123=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
124 137
125The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
126be 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.
127 142
128=item $cf::NOW 143=item $cf::NOW
129 144
130The time of the last (current) server tick. 145The time of the last (current) server tick.
131 146
132=item $cf::TICK 147=item $cf::TICK
133 148
134The 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.
135 160
136=item %cf::CFG 161=item %cf::CFG
137 162
138Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
139from wherever your confdir points to. 164from wherever your confdir points to.
140 165
141=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
142 167
143These 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
144or 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
145processing 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.
146window 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.
147 177
148=back 178=back
149 179
150=cut 180=cut
151 181
152BEGIN { 182BEGIN {
153 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
154 my $msg = join "", @_; 184 my $msg = join "", @_;
155 utf8::encode $msg;
156 185
157 $msg .= "\n" 186 $msg .= "\n"
158 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
159 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
160 LOG llevError, $msg; 192 LOG llevError, $msg;
161 }; 193 };
162} 194}
163 195
164@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
165@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
166@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
167@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
168@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';
169@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)
170 203
171# 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
172# within the Safe compartment. 205# within the Safe compartment.
173for my $pkg (qw( 206for my $pkg (qw(
174 cf::global cf::attachable 207 cf::global cf::attachable
182} 215}
183 216
184$Event::DIED = sub { 217$Event::DIED = sub {
185 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
186}; 219};
220
221#############################################################################
187 222
188=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
189 224
190=over 4 225=over 4
191 226
210 $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;
211 $d 246 $d
212 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
213} 248}
214 249
215use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
216
217=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
218 251
219Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
220 253
221=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
222 255
223Converts 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]) }
224 264
225=item cf::lock_wait $string 265=item cf::lock_wait $string
226 266
227Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
228 268
234returned. 274returned.
235 275
236Lock 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
237uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
238 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
239=cut 283=cut
240 284
241our %LOCK; 285our %LOCK;
242 286
243sub lock_wait($) { 287sub lock_wait($) {
260 304
261 Coro::guard { 305 Coro::guard {
262 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
263 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
264 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
265} 315}
266 316
267sub freeze_mainloop { 317sub freeze_mainloop {
268 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
269 319
272 }; 322 };
273 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
274 $guard 324 $guard
275} 325}
276 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
277=item cf::async { BLOCK } 383=item cf::async { BLOCK }
278 384
279Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
280C<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
281thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
284 390
285BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
286 392
287=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
288 394
289The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
290always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
291reentrant. 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.
292 399
293If 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
294the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
295server 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
296fast or be very important. 403fast or be very important.
299 406
300sub sync_job(&) { 407sub sync_job(&) {
301 my ($job) = @_; 408 my ($job) = @_;
302 409
303 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
304 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
305 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
306 415
307 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
308 # (but this is cancel-safe) 417 # (but this is cancel-safe)
319 428
320 while ($busy) { 429 while ($busy) {
321 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
322 } 431 }
323 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
324 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
325 } else { 441 } else {
326 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
327 443
328 $job->() 444 $job->()
347 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
348 464
349 $coro 465 $coro
350} 466}
351 467
352sub write_runtime { 468=item fork_call { }, $args
353 my $guard = cf::lock_acquire "write_runtime";
354 469
355 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.
356 474
357 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
358 or return;
359 476
360 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
361 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
362 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
363 480 Storable::store_fd $_[0], $fh;
364 (aio_write $fh, 0, (length $value), $value, 0) <= 0
365 and return;
366
367 # always fsync - this file is important
368 aio_fsync $fh
369 and return;
370
371 close $fh 481 close $fh;
372 or return;
373 482
374 aio_rename "$runtime~", $runtime 483 $buf
375 and return; 484}
376 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;
377 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"
378} 644}
379 645
380=item cf::datalog type => key => value, ... 646=item cf::datalog type => key => value, ...
381 647
382Log a datalog packet of the given type with the given key-value pairs. 648Log a datalog packet of the given type with the given key-value pairs.
400attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
401to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
402 668
403In 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>
404C<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
405crossfire+). 671Crossfire TRT).
406 672
407=over 4 673=over 4
408 674
409=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
410 676
573 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
574 840
575 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
576 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
577 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
578 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
579 845
580 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
581 my $pkg = shift @arg; 847 my $pkg = shift @arg;
582 848
583 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
612 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
613 } 879 }
614 880
615 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
616 } else { 882 } else {
617 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
618 } 884 }
619 885
620 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
621} 887}
622 888
624 if (ref $_[0]) { 890 if (ref $_[0]) {
625 _object_attach @_; 891 _object_attach @_;
626 } else { 892 } else {
627 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
628 } 894 }
895 _recalc_want;
629}; 896};
630 897
631# all those should be optimised 898# all those should be optimised
632sub cf::attachable::detach { 899sub cf::attachable::detach {
633 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
636 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
637 reattach ($obj); 904 reattach ($obj);
638 } else { 905 } else {
639 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
640 } 907 }
908 _recalc_want;
641}; 909};
642 910
643sub cf::attachable::attached { 911sub cf::attachable::attached {
644 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
645 913
660 "; 928 ";
661 die if $@; 929 die if $@;
662} 930}
663 931
664our $override; 932our $override;
665our @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?
666 934
667sub override { 935sub override {
668 $override = 1; 936 $override = 1;
669 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
670} 938}
671 939
672sub do_invoke { 940sub do_invoke {
673 my $event = shift; 941 my $event = shift;
674 my $callbacks = shift; 942 my $callbacks = shift;
675 943
676 @invoke_results = (); 944 @INVOKE_RESULTS = ();
677 945
678 local $override; 946 local $override;
679 947
680 for (@$callbacks) { 948 for (@$callbacks) {
681 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
698 966
699Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
700 968
701This 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
702removed 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
703results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
704 972
705=back 973=back
706 974
707=cut 975=cut
708 976
709############################################################################# 977#############################################################################
710# 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}
711 990
712sub reattach { 991sub reattach {
713 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
714 my ($obj) = @_; 993 my ($obj) = @_;
715 994
818 or return; 1097 or return;
819 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
820 } 1099 }
821 1100
822 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
823 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
824 return ($data, $av); 1103 return ($data, $av);
825} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
826 1111
827############################################################################# 1112#############################################################################
828# command handling &c 1113# command handling &c
829 1114
830=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
843 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
844} 1129}
845 1130
846=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
847 1132
848Register 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.
849 1138
850If 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
851called. 1140called.
852 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
853=cut 1153=cut
854 1154
855sub register_extcmd { 1155sub register_extcmd {
856 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
857 1157
858 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
859} 1165}
860 1166
861cf::player->attach ( 1167cf::player->attach (
862 on_command => sub { 1168 on_command => sub {
863 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
872 cf::override; 1178 cf::override;
873 }, 1179 },
874 on_extcmd => sub { 1180 on_extcmd => sub {
875 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
876 1182
877 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
878 1184
879 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
880 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
881 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
882 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
883 } 1195 if $reply;
884 } 1196 }
885 } else { 1197 } else {
886 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
887 } 1199 }
888 1200
889 cf::override; 1201 cf::override;
890 }, 1202 },
891); 1203);
892 1204
893sub load_extension {
894 my ($path) = @_;
895
896 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
897 my $base = $1;
898 my $pkg = $1;
899 $pkg =~ s/[^[:word:]]/_/g;
900 $pkg = "ext::$pkg";
901
902 warn "... loading '$path' into '$pkg'\n";
903
904 open my $fh, "<:utf8", $path
905 or die "$path: $!";
906
907 my $source =
908 "package $pkg; use strict; use utf8;\n"
909 . "#line 1 \"$path\"\n{\n"
910 . (do { local $/; <$fh> })
911 . "\n};\n1";
912
913 unless (eval $source) {
914 my $msg = $@ ? "$path: $@\n"
915 : "extension disabled.\n";
916 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
917 warn $@;
918 warn "mandatory extension failed to load, exiting.\n";
919 exit 1;
920 }
921 die $@;
922 }
923
924 push @EXTS, $pkg;
925}
926
927sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
928 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
929 next unless -r $ext; 1210 next unless -r $path;
930 eval { 1211
931 load_extension $ext; 1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
932 1 1269 }
933 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
934 } 1275 };
935} 1276}
936 1277
937############################################################################# 1278#############################################################################
938 1279
1280=back
1281
939=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
940 1283
941Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
942 1285
943=cut 1286=cut
955Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
956 1299
957=cut 1300=cut
958 1301
959sub playerdir($) { 1302sub playerdir($) {
960 cf::localdir 1303 "$PLAYERDIR/"
961 . "/"
962 . cf::playerdir
963 . "/"
964 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
965} 1305}
966 1306
967sub path($) { 1307sub path($) {
968 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1088while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1089 1429
1090=cut 1430=cut
1091 1431
1092sub list_logins { 1432sub list_logins {
1093 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1094 or return []; 1434 or return [];
1095 1435
1096 my @logins; 1436 my @logins;
1097 1437
1098 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1133 } 1473 }
1134 1474
1135 \@paths 1475 \@paths
1136} 1476}
1137 1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1138=item $player->ext_reply ($msgid, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1139 1529
1140Sends an ext reply to the player. 1530Sends an ext reply to the player.
1141 1531
1142=cut 1532=cut
1143 1533
1144sub ext_reply($$%) { 1534sub ext_reply($$@) {
1145 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1146 1536
1147 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1148 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1149 $self->send ("ext " . cf::to_json \%msg); 1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1150} 1544}
1151 1545
1152=item $player->ext_event ($type, %msg) 1546=item $player->ext_msg ($type, @msg)
1153 1547
1154Sends an ext event to the client. 1548Sends an ext event to the client.
1155 1549
1156=cut 1550=cut
1157 1551
1158sub ext_event($$%) { 1552sub ext_msg($$@) {
1159 my ($self, $type, %msg) = @_; 1553 my ($self, $type, @msg) = @_;
1160 1554
1161 $self->ns->ext_event ($type, %msg); 1555 $self->ns->ext_msg ($type, @msg);
1162} 1556}
1163 1557
1164=head3 cf::region 1558=head3 cf::region
1165 1559
1166=over 4 1560=over 4
1169 1563
1170package cf::region; 1564package cf::region;
1171 1565
1172=item cf::region::find_by_path $path 1566=item cf::region::find_by_path $path
1173 1567
1174Tries to decuce the probable region for a map knowing only its path. 1568Tries to decuce the likely region for a map knowing only its path.
1175 1569
1176=cut 1570=cut
1177 1571
1178sub find_by_path($) { 1572sub find_by_path($) {
1179 my ($path) = @_; 1573 my ($path) = @_;
1180 1574
1181 my ($match, $specificity); 1575 my ($match, $specificity);
1182 1576
1183 for my $region (list) { 1577 for my $region (list) {
1184 if ($region->match && $path =~ $region->match) { 1578 if ($region->{match} && $path =~ $region->{match}) {
1185 ($match, $specificity) = ($region, $region->specificity) 1579 ($match, $specificity) = ($region, $region->specificity)
1186 if $region->specificity > $specificity; 1580 if $region->specificity > $specificity;
1187 } 1581 }
1188 } 1582 }
1189 1583
1253 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1254 1648
1255 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1256 local $self->{path}; 1650 local $self->{path};
1257 local $self->{load_path}; 1651 local $self->{load_path};
1258 local $self->{deny_save};
1259 local $self->{deny_reset};
1260 1652
1261 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1262} 1654}
1263 1655
1264sub normalise { 1656sub normalise {
1311 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1312 return $self; 1704 return $self;
1313 } 1705 }
1314 } 1706 }
1315 1707
1316 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1317 () 1709 ()
1318} 1710}
1319 1711
1320sub init { 1712sub init {
1321 my ($self) = @_; 1713 my ($self) = @_;
1336 1728
1337# the original (read-only) location 1729# the original (read-only) location
1338sub load_path { 1730sub load_path {
1339 my ($self) = @_; 1731 my ($self) = @_;
1340 1732
1341 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1342} 1734}
1343 1735
1344# the temporary/swap location 1736# the temporary/swap location
1345sub save_path { 1737sub save_path {
1346 my ($self) = @_; 1738 my ($self) = @_;
1347 1739
1348 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1349 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1350} 1742}
1351 1743
1352# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1353sub uniq_path { 1745sub uniq_path {
1354 my ($self) = @_; 1746 my ($self) = @_;
1355 1747
1356 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1357 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1358} 1750}
1359 1751
1360# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1361# all maps in C++... 1753# all maps in C++...
1362sub change_all_map_light { 1754sub change_all_map_light {
1363 my ($change) = @_; 1755 my ($change) = @_;
1364 1756
1365 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1366 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1759}
1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1367} 1767}
1368 1768
1369sub unlink_save { 1769sub unlink_save {
1370 my ($self) = @_; 1770 my ($self) = @_;
1371 1771
1429 $self->load_header_orig 1829 $self->load_header_orig
1430 or return; 1830 or return;
1431 $self->prepare_orig; 1831 $self->prepare_orig;
1432 } 1832 }
1433 1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1434 $self->default_region (cf::region::find_by_path $self->{path}) 1837 $self->default_region (cf::region::find_by_path $self->{path})
1435 unless $self->default_region; 1838 unless $self->default_region;
1436 1839
1437 1 1840 1
1438} 1841}
1453 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1454 1857
1455 $map->load_header 1858 $map->load_header
1456 or return; 1859 or return;
1457 1860
1458 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1460 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1461 $map->reset; 1864 $map->reset;
1462 undef $guard; 1865 undef $guard;
1463 return find $path; 1866 return find $path;
1474 my ($self) = @_; 1877 my ($self) = @_;
1475 1878
1476 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1477 1880
1478 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1479 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1480 1885
1481 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1482 1887
1483 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1484 1889
1485 $self->alloc; 1890 $self->alloc;
1486 1891
1487 $self->pre_load; 1892 $self->pre_load;
1488
1489 $self->_load_objects ($self->{load_path}, 1)
1490 or return;
1491
1492 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1493 if delete $self->{load_original};
1494
1495 if (my $uniq = $self->uniq_path) {
1496 utf8::encode $uniq;
1497 if (aio_open $uniq, O_RDONLY, 0) {
1498 $self->clear_unique_items;
1499 $self->_load_objects ($uniq, 0);
1500 }
1501 }
1502
1503 Coro::cede;
1504
1505 # now do the right thing for maps
1506 $self->link_multipart_objects;
1507
1508 unless ($self->{deny_activate}) {
1509 $self->decay_objects;
1510 $self->fix_auto_apply;
1511 $self->update_buttons;
1512 Coro::cede; 1893 Coro::cede;
1513 $self->set_darkness_map; 1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
1906 }
1907 }
1908
1909 Coro::cede;
1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1514 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1515 unless $self->difficulty; 1913 unless $self->difficulty;
1516 Coro::cede; 1914 Coro::cede;
1915
1916 unless ($self->{deny_activate}) {
1917 $self->decay_objects;
1918 $self->fix_auto_apply;
1919 $self->update_buttons;
1920 Coro::cede;
1921 $self->set_darkness_map;
1922 Coro::cede;
1517 $self->activate; 1923 $self->activate;
1924 }
1925
1926 $self->{last_save} = $cf::RUNTIME;
1927 $self->last_access ($cf::RUNTIME);
1928
1929 $self->in_memory (cf::MAP_IN_MEMORY);
1518 } 1930 }
1519 1931
1520 $self->post_load; 1932 $self->post_load;
1521
1522 $self->in_memory (cf::MAP_IN_MEMORY);
1523} 1933}
1524 1934
1525sub customise_for { 1935sub customise_for {
1526 my ($self, $ob) = @_; 1936 my ($self, $ob) = @_;
1527 1937
1528 return find "~" . $ob->name . "/" . $self->{path} 1938 return find "~" . $ob->name . "/" . $self->{path}
1529 if $self->per_player; 1939 if $self->per_player;
1940
1941# return find "?party/" . $ob->name . "/" . $self->{path}
1942# if $self->per_party;
1530 1943
1531 $self 1944 $self
1532} 1945}
1533 1946
1534# find and load all maps in the 3x3 area around a map 1947# find and load all maps in the 3x3 area around a map
1581 1994
1582 undef $MAP_PREFETCH{$path}; 1995 undef $MAP_PREFETCH{$path};
1583 $MAP_PREFETCHER ||= cf::async { 1996 $MAP_PREFETCHER ||= cf::async {
1584 while (%MAP_PREFETCH) { 1997 while (%MAP_PREFETCH) {
1585 for my $path (keys %MAP_PREFETCH) { 1998 for my $path (keys %MAP_PREFETCH) {
1586 my $map = find $path 1999 if (my $map = find $path) {
1587 or next;
1588 $map->load; 2000 $map->load;
2001 }
1589 2002
1590 delete $MAP_PREFETCH{$path}; 2003 delete $MAP_PREFETCH{$path};
1591 } 2004 }
1592 } 2005 }
1593 undef $MAP_PREFETCHER; 2006 undef $MAP_PREFETCHER;
1645 2058
1646sub reset_at { 2059sub reset_at {
1647 my ($self) = @_; 2060 my ($self) = @_;
1648 2061
1649 # TODO: safety, remove and allow resettable per-player maps 2062 # TODO: safety, remove and allow resettable per-player maps
1650 return 1e99 if $self->isa ("ext::map_per_player");#d#
1651 return 1e99 if $self->{deny_reset}; 2063 return 1e99 if $self->{deny_reset};
1652 2064
1653 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2065 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1654 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2066 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1655 2067
1666 my ($self) = @_; 2078 my ($self) = @_;
1667 2079
1668 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2080 my $lock = cf::lock_acquire "map_data:$self->{path}";
1669 2081
1670 return if $self->players; 2082 return if $self->players;
1671 return if $self->isa ("ext::map_per_player");#d#
1672 2083
1673 warn "resetting map ", $self->path;#d# 2084 warn "resetting map ", $self->path;
1674 2085
1675 $self->in_memory (cf::MAP_SWAPPED); 2086 $self->in_memory (cf::MAP_SWAPPED);
1676 2087
1677 # need to save uniques path 2088 # need to save uniques path
1678 unless ($self->{deny_save}) { 2089 unless ($self->{deny_save}) {
1710 $cf::MAP{$self->path} = $self; 2121 $cf::MAP{$self->path} = $self;
1711 2122
1712 $self->reset; # polite request, might not happen 2123 $self->reset; # polite request, might not happen
1713} 2124}
1714 2125
2126=item $maps = cf::map::tmp_maps
2127
2128Returns an arrayref with all map paths of currently instantiated and saved
2129maps. May block.
2130
2131=cut
2132
2133sub tmp_maps() {
2134 [
2135 map {
2136 utf8::decode $_;
2137 /\.map$/
2138 ? normalise $_
2139 : ()
2140 } @{ aio_readdir $TMPDIR or [] }
2141 ]
2142}
2143
2144=item $maps = cf::map::random_maps
2145
2146Returns an arrayref with all map paths of currently instantiated and saved
2147random maps. May block.
2148
2149=cut
2150
2151sub random_maps() {
2152 [
2153 map {
2154 utf8::decode $_;
2155 /\.map$/
2156 ? normalise "?random/$_"
2157 : ()
2158 } @{ aio_readdir $RANDOMDIR or [] }
2159 ]
2160}
2161
1715=item cf::map::unique_maps 2162=item cf::map::unique_maps
1716 2163
1717Returns an arrayref of paths of all shared maps that have 2164Returns an arrayref of paths of all shared maps that have
1718instantiated unique items. May block. 2165instantiated unique items. May block.
1719 2166
1720=cut 2167=cut
1721 2168
1722sub unique_maps() { 2169sub unique_maps() {
1723 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2170 [
1724 or return; 2171 map {
1725
1726 my @paths;
1727
1728 for (@$files) {
1729 utf8::decode $_; 2172 utf8::decode $_;
1730 next if /\.pst$/; 2173 /\.map$/
1731 next unless /^$PATH_SEP/o; 2174 ? normalise $_
1732 2175 : ()
1733 push @paths, cf::map::normalise $_; 2176 } @{ aio_readdir $UNIQUEDIR or [] }
1734 } 2177 ]
1735
1736 \@paths
1737} 2178}
1738 2179
1739package cf; 2180package cf;
1740 2181
1741=back 2182=back
1787 2228
1788 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2229 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1789 2230
1790 if ($self->{record_replies}) { 2231 if ($self->{record_replies}) {
1791 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2232 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2233
1792 } else { 2234 } else {
2235 my $pl = $self->contr;
2236
2237 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2238 my $dialog = $pl->{npc_dialog};
2239 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2240
2241 } else {
1793 $msg = $npc->name . " says: $msg" if $npc; 2242 $msg = $npc->name . " says: $msg" if $npc;
1794 $self->message ($msg, $flags); 2243 $self->message ($msg, $flags);
2244 }
1795 } 2245 }
1796} 2246}
1797 2247
1798=item $player_object->may ("access") 2248=item $player_object->may ("access")
1799 2249
1847 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1848 2298
1849 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1850 2300
1851 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1852 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1853 2303
1854 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1855} 2305}
1856 2306
1857sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1858 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1859 2311
1860 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1861 2313
1862 unless ($map) { 2314 unless ($map) {
1863 # restore original map position 2315 # restore original map position
1886 2338
1887 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1888 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1889} 2341}
1890 2342
1891cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1892 on_logout => sub {
1893 my ($pl) = @_;
1894 2344
1895 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1896 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1897 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1898 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1899 }; 2349be called at the end of this process.
1900 }
1901 },
1902 on_login => sub {
1903 my ($pl) = @_;
1904 2350
1905 # try to abort aborted map switching on player login :)
1906 # should happen only on crashes
1907 if ($pl->ob->{_link_pos}) {
1908 $pl->ob->enter_link;
1909 (async {
1910 $pl->ob->reply (undef,
1911 "There was an internal problem at your last logout, "
1912 . "the server will try to bring you to your intended destination in a second.",
1913 cf::NDI_RED);
1914 # we need this sleep as the login has a concurrent enter_exit running
1915 # and this sleep increases chances of the player not ending up in scorn
1916 Coro::Timer::sleep 1;
1917 $pl->ob->leave_link;
1918 })->prio (2);
1919 }
1920 },
1921);
1922
1923=item $player_object->goto ($path, $x, $y)
1924
1925=cut 2351=cut
2352
2353our $GOTOGEN;
1926 2354
1927sub cf::object::player::goto { 2355sub cf::object::player::goto {
1928 my ($self, $path, $x, $y) = @_; 2356 my ($self, $path, $x, $y, $check, $done) = @_;
2357
2358 # do generation counting so two concurrent goto's will be executed in-order
2359 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1929 2360
1930 $self->enter_link; 2361 $self->enter_link;
1931 2362
1932 (async { 2363 (async {
1933 my $map = eval { 2364 my $map = eval {
1934 my $map = cf::map::find $path; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1935 $map = $map->customise_for ($self) if $map; 2368 $map = $map->customise_for ($self);
2369 $map = $check->($map) if $check && $map;
2370 } else {
2371 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2372 }
2373
1936 $map 2374 $map
2375 };
2376
2377 if ($@) {
2378 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2379 LOG llevError | logBacktrace, Carp::longmess $@;
1937 } or 2380 }
1938 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1939 2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1940 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1941 })->prio (1); 2388 })->prio (1);
1942} 2389}
1943 2390
1944=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1945 2392
1984 2431
1985 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1986 2433
1987 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1988 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
1989 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2436 my $meta = "$RANDOMDIR/$md5.meta";
1990 2437
1991 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1992 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
1993 undef $fh; 2440 undef $fh;
1994 aio_rename "$meta~", $meta; 2441 aio_rename "$meta~", $meta;
2013 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2460 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2014 my $hp = $exit->stats->hp; 2461 my $hp = $exit->stats->hp;
2015 my $sp = $exit->stats->sp; 2462 my $sp = $exit->stats->sp;
2016 2463
2017 $self->enter_link; 2464 $self->enter_link;
2465
2466 # if exit is damned, update players death & WoR home-position
2467 $self->contr->savebed ($slaying, $hp, $sp)
2468 if $exit->flag (FLAG_DAMNED);
2018 2469
2019 (async { 2470 (async {
2020 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
2021 unless (eval { 2472 unless (eval {
2022 $self->goto ($slaying, $hp, $sp); 2473 $self->goto ($slaying, $hp, $sp);
2050 2501
2051 utf8::encode $text; 2502 utf8::encode $text;
2052 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2503 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2053} 2504}
2054 2505
2506=item $client->send_msg ($channel, $msg, $color, [extra...])
2507
2508Send a drawinfo or msg packet to the client, formatting the msg for the
2509client if neccessary. C<$type> should be a string identifying the type of
2510the message, with C<log> being the default. If C<$color> is negative, suppress
2511the message unless the client supports the msg packet.
2512
2513=cut
2514
2515sub cf::client::send_msg {
2516 my ($self, $channel, $msg, $color, @extra) = @_;
2517
2518 $msg = $self->pl->expand_cfpod ($msg);
2519
2520 $color &= cf::NDI_CLIENT_MASK; # just in case...
2521
2522 if (ref $channel) {
2523 # send meta info to client, if not yet sent
2524 unless (exists $self->{channel}{$channel->{id}}) {
2525 $self->{channel}{$channel->{id}} = $channel;
2526 $self->ext_msg (channel_info => $channel);
2527 }
2528
2529 $channel = $channel->{id};
2530 }
2531
2532 return unless @extra || length $msg;
2533
2534 if ($self->can_msg) {
2535 # default colour, mask it out
2536 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2537 if $color & cf::NDI_DEF;
2538
2539 $self->send_packet ("msg " . $self->{json_coder}->encode (
2540 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2541 } else {
2542 if ($color >= 0) {
2543 # replace some tags by gcfclient-compatible ones
2544 for ($msg) {
2545 1 while
2546 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2547 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2548 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2549 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2550 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2551 }
2552
2553 $color &= cf::NDI_COLOR_MASK;
2554
2555 utf8::encode $msg;
2556
2557 if (0 && $msg =~ /\[/) {
2558 $self->send_packet ("drawextinfo $color 4 0 $msg")
2559 } else {
2560 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2561 $self->send_packet ("drawinfo $color $msg")
2562 }
2563 }
2564 }
2565}
2566
2055=item $client->ext_event ($type, %msg) 2567=item $client->ext_msg ($type, @msg)
2056 2568
2057Sends an exti event to the client. 2569Sends an ext event to the client.
2058 2570
2059=cut 2571=cut
2060 2572
2061sub cf::client::ext_event($$%) { 2573sub cf::client::ext_msg($$@) {
2062 my ($self, $type, %msg) = @_; 2574 my ($self, $type, @msg) = @_;
2063 2575
2576 my $extcmd = $self->extcmd;
2577
2578 if ($extcmd == 2) {
2579 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2580 } elsif ($extcmd == 1) { # TODO: remove
2064 $msg{msgtype} = "event_$type"; 2581 push @msg, msgtype => "event_$type";
2065 $self->send_packet ("ext " . cf::to_json \%msg); 2582 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2583 }
2066} 2584}
2067 2585
2068=item $success = $client->query ($flags, "text", \&cb) 2586=item $success = $client->query ($flags, "text", \&cb)
2069 2587
2070Queues a query to the client, calling the given callback with 2588Queues a query to the client, calling the given callback with
2071the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2589the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2072C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2590C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2073 2591
2074Queries can fail, so check the return code. Or don't, as queries will become 2592Queries can fail, so check the return code. Or don't, as queries will
2075reliable at some point in the future. 2593become reliable at some point in the future.
2076 2594
2077=cut 2595=cut
2078 2596
2079sub cf::client::query { 2597sub cf::client::query {
2080 my ($self, $flags, $text, $cb) = @_; 2598 my ($self, $flags, $text, $cb) = @_;
2088 utf8::encode $text; 2606 utf8::encode $text;
2089 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2607 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2090 2608
2091 $self->send_packet ($self->{query_queue}[0][0]) 2609 $self->send_packet ($self->{query_queue}[0][0])
2092 if @{ $self->{query_queue} } == 1; 2610 if @{ $self->{query_queue} } == 1;
2611
2612 1
2093} 2613}
2094 2614
2095cf::client->attach ( 2615cf::client->attach (
2616 on_connect => sub {
2617 my ($ns) = @_;
2618
2619 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2620 },
2096 on_reply => sub { 2621 on_reply => sub {
2097 my ($ns, $msg) = @_; 2622 my ($ns, $msg) = @_;
2098 2623
2099 # this weird shuffling is so that direct followup queries 2624 # this weird shuffling is so that direct followup queries
2100 # get handled first 2625 # get handled first
2112 } else { 2637 } else {
2113 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2638 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2114 } 2639 }
2115 } 2640 }
2116 }, 2641 },
2642 on_exticmd => sub {
2643 my ($ns, $buf) = @_;
2644
2645 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2646
2647 if (ref $msg) {
2648 my ($type, $reply, @payload) =
2649 "ARRAY" eq ref $msg
2650 ? @$msg
2651 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2652
2653 if (my $cb = $EXTICMD{$type}) {
2654 my @reply = $cb->($ns, @payload);
2655
2656 $ns->ext_reply ($reply, @reply)
2657 if $reply;
2658 }
2659 } else {
2660 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2661 }
2662
2663 cf::override;
2664 },
2117); 2665);
2118 2666
2119=item $client->async (\&cb) 2667=item $client->async (\&cb)
2120 2668
2121Create a new coroutine, running the specified callback. The coroutine will 2669Create a new coroutine, running the specified callback. The coroutine will
2162our $safe = new Safe "safe"; 2710our $safe = new Safe "safe";
2163our $safe_hole = new Safe::Hole; 2711our $safe_hole = new Safe::Hole;
2164 2712
2165$SIG{FPE} = 'IGNORE'; 2713$SIG{FPE} = 'IGNORE';
2166 2714
2167$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2715$safe->permit_only (Opcode::opset qw(
2716 :base_core :base_mem :base_orig :base_math
2717 grepstart grepwhile mapstart mapwhile
2718 sort time
2719));
2168 2720
2169# here we export the classes and methods available to script code 2721# here we export the classes and methods available to script code
2170 2722
2171=pod 2723=pod
2172 2724
2173The following functions and methods are available within a safe environment: 2725The following functions and methods are available within a safe environment:
2174 2726
2175 cf::object contr pay_amount pay_player map 2727 cf::object
2728 contr pay_amount pay_player map x y force_find force_add
2729 insert remove
2730
2176 cf::object::player player 2731 cf::object::player
2177 cf::player peaceful 2732 player
2178 cf::map trigger 2733
2734 cf::player
2735 peaceful
2736
2737 cf::map
2738 trigger
2179 2739
2180=cut 2740=cut
2181 2741
2182for ( 2742for (
2183 ["cf::object" => qw(contr pay_amount pay_player map)], 2743 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2744 insert remove inv)],
2184 ["cf::object::player" => qw(player)], 2745 ["cf::object::player" => qw(player)],
2185 ["cf::player" => qw(peaceful)], 2746 ["cf::player" => qw(peaceful)],
2186 ["cf::map" => qw(trigger)], 2747 ["cf::map" => qw(trigger)],
2187) { 2748) {
2188 no strict 'refs'; 2749 no strict 'refs';
2259=back 2820=back
2260 2821
2261=cut 2822=cut
2262 2823
2263############################################################################# 2824#############################################################################
2264
2265=head2 EXTENSION DATABASE SUPPORT
2266
2267Crossfire maintains a very simple database for extension use. It can
2268currently store anything that can be serialised using Storable, which
2269excludes objects.
2270
2271The parameter C<$family> should best start with the name of the extension
2272using it, it should be unique.
2273
2274=over 4
2275
2276=item $value = cf::db_get $family => $key
2277
2278Returns a single value from the database.
2279
2280=item cf::db_put $family => $key => $value
2281
2282Stores the given C<$value> in the family.
2283
2284=cut
2285
2286our $DB;
2287
2288sub db_init {
2289 unless ($DB) {
2290 $DB = BDB::db_create $DB_ENV;
2291
2292 cf::sync_job {
2293 eval {
2294 $DB->set_flags (BDB::CHKSUM);
2295
2296 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2297 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2298 cf::cleanup "db_open(db): $!" if $!;
2299 };
2300 cf::cleanup "db_open(db): $@" if $@;
2301 };
2302
2303 my $path = cf::localdir . "/database.pst";
2304 if (stat $path) {
2305 cf::sync_job {
2306 my $pst = Storable::retrieve $path;
2307
2308 cf::db_put (board => data => $pst->{board});
2309 cf::db_put (guildrules => data => $pst->{guildrules});
2310 cf::db_put (rent => balance => $pst->{rent}{balance});
2311 BDB::db_env_txn_checkpoint $DB_ENV;
2312
2313 unlink $path;
2314 };
2315 }
2316 }
2317}
2318
2319sub db_get($$) {
2320 my $key = "$_[0]/$_[1]";
2321
2322 cf::sync_job {
2323 BDB::db_get $DB, undef, $key, my $data;
2324
2325 $! ? ()
2326 : Compress::LZF::sthaw $data
2327 }
2328}
2329
2330sub db_put($$$) {
2331 BDB::dbreq_pri 4;
2332 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2333}
2334
2335#############################################################################
2336# the server's init and main functions 2825# the server's init and main functions
2337 2826
2338sub load_facedata { 2827sub load_facedata($) {
2339 my $path = sprintf "%s/facedata", cf::datadir; 2828 my ($path) = @_;
2340 2829
2341 warn "loading facedata from $path\n"; 2830 warn "loading facedata from $path\n";
2342 2831
2343 my $facedata; 2832 my $facedata;
2344 0 < aio_load $path, $facedata 2833 0 < aio_load $path, $facedata
2352 { 2841 {
2353 my $faces = $facedata->{faceinfo}; 2842 my $faces = $facedata->{faceinfo};
2354 2843
2355 while (my ($face, $info) = each %$faces) { 2844 while (my ($face, $info) = each %$faces) {
2356 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2845 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2357 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2846 cf::face::set_visibility $idx, $info->{visibility};
2847 cf::face::set_magicmap $idx, $info->{magicmap};
2358 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2848 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2359 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2849 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2360 Coro::cede; 2850
2851 cf::cede_to_tick;
2361 } 2852 }
2362 2853
2363 while (my ($face, $info) = each %$faces) { 2854 while (my ($face, $info) = each %$faces) {
2364 next unless $info->{smooth}; 2855 next unless $info->{smooth};
2365 my $idx = cf::face::find $face 2856 my $idx = cf::face::find $face
2366 or next; 2857 or next;
2367 if (my $smooth = cf::face::find $info->{smooth}) { 2858 if (my $smooth = cf::face::find $info->{smooth}) {
2859 cf::face::set_smooth $idx, $smooth;
2368 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2860 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2369 } else { 2861 } else {
2370 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2862 warn "smooth face '$info->{smooth}' not found for face '$face'";
2371 } 2863 }
2372 Coro::cede; 2864
2865 cf::cede_to_tick;
2373 } 2866 }
2374 } 2867 }
2375 2868
2376 { 2869 {
2377 my $anims = $facedata->{animinfo}; 2870 my $anims = $facedata->{animinfo};
2378 2871
2379 while (my ($anim, $info) = each %$anims) { 2872 while (my ($anim, $info) = each %$anims) {
2380 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2873 cf::anim::set $anim, $info->{frames}, $info->{facings};
2381 Coro::cede; 2874 cf::cede_to_tick;
2382 } 2875 }
2383 2876
2384 cf::anim::invalidate_all; # d'oh 2877 cf::anim::invalidate_all; # d'oh
2385 } 2878 }
2386 2879
2880 {
2881 # TODO: for gcfclient pleasure, we should give resources
2882 # that gcfclient doesn't grok a >10000 face index.
2883 my $res = $facedata->{resource};
2884 my $enc = JSON::XS->new->utf8->canonical;
2885
2886 my $soundconf = delete $res->{"res/sound.conf"};
2887
2888 while (my ($name, $info) = each %$res) {
2889 my $meta = $enc->encode ({
2890 name => $name,
2891 %{ $info->{meta} || {} },
2892 });
2893
2894 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2895
2896 if ($info->{type} & 1) {
2897 # prepend meta info
2898
2899 my $data = pack "(w/a*)*", $meta, $info->{data};
2900 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2901
2902 cf::face::set_data $idx, 0, $data, $chk;
2903 } else {
2904 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2905 }
2906
2907 cf::face::set_type $idx, $info->{type};
2908
2909 cf::cede_to_tick;
2910 }
2911
2912 if ($soundconf) {
2913 $soundconf = $enc->decode (delete $soundconf->{data});
2914
2915 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2916 my $sound = $soundconf->{compat}[$_]
2917 or next;
2918
2919 my $face = cf::face::find "sound/$sound->[1]";
2920 cf::sound::set $sound->[0] => $face;
2921 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2922 }
2923
2924 while (my ($k, $v) = each %{$soundconf->{event}}) {
2925 my $face = cf::face::find "sound/$v";
2926 cf::sound::set $k => $face;
2927 }
2928 }
2929 }
2930
2387 1 2931 1
2388} 2932}
2389 2933
2934register_exticmd fx_want => sub {
2935 my ($ns, $want) = @_;
2936
2937 while (my ($k, $v) = each %$want) {
2938 $ns->fx_want ($k, $v);
2939 }
2940};
2941
2942sub reload_regions {
2943 load_resource_file "$MAPDIR/regions"
2944 or die "unable to load regions file\n";
2945
2946 for (cf::region::list) {
2947 $_->{match} = qr/$_->{match}/
2948 if exists $_->{match};
2949 }
2950}
2951
2952sub reload_facedata {
2953 load_facedata "$DATADIR/facedata"
2954 or die "unable to load facedata\n";
2955}
2956
2957sub reload_archetypes {
2958 load_resource_file "$DATADIR/archetypes"
2959 or die "unable to load archetypes\n";
2960 #d# NEED to laod twice to resolve forward references
2961 # this really needs to be done in an extra post-pass
2962 # (which needs to be synchronous, so solve it differently)
2963 load_resource_file "$DATADIR/archetypes"
2964 or die "unable to load archetypes\n";
2965}
2966
2967sub reload_treasures {
2968 load_resource_file "$DATADIR/treasures"
2969 or die "unable to load treasurelists\n";
2970}
2971
2390sub reload_resources { 2972sub reload_resources {
2391 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2973 warn "reloading resource files...\n";
2392 or die "unable to load regions file\n";#d# 2974
2975 reload_regions;
2393 load_facedata 2976 reload_facedata;
2394 or die "unable to load facedata\n";#d# 2977 #reload_archetypes;#d#
2978 reload_archetypes;
2979 reload_treasures;
2980
2981 warn "finished reloading resource files\n";
2395} 2982}
2396 2983
2397sub init { 2984sub init {
2398 reload_resources; 2985 reload_resources;
2399} 2986}
2400 2987
2401sub cfg_load { 2988sub cfg_load {
2402 open my $fh, "<:utf8", cf::confdir . "/config" 2989 open my $fh, "<:utf8", "$CONFDIR/config"
2403 or return; 2990 or return;
2404 2991
2405 local $/; 2992 local $/;
2406 *CFG = YAML::Syck::Load <$fh>; 2993 *CFG = YAML::Syck::Load <$fh>;
2407 2994
2452 }, 3039 },
2453 ); 3040 );
2454 } 3041 }
2455} 3042}
2456 3043
3044sub write_runtime {
3045 my $runtime = "$LOCALDIR/runtime";
3046
3047 # first touch the runtime file to show we are still running:
3048 # the fsync below can take a very very long time.
3049
3050 IO::AIO::aio_utime $runtime, undef, undef;
3051
3052 my $guard = cf::lock_acquire "write_runtime";
3053
3054 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3055 or return;
3056
3057 my $value = $cf::RUNTIME + 90 + 10;
3058 # 10 is the runtime save interval, for a monotonic clock
3059 # 60 allows for the watchdog to kill the server.
3060
3061 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3062 and return;
3063
3064 # always fsync - this file is important
3065 aio_fsync $fh
3066 and return;
3067
3068 # touch it again to show we are up-to-date
3069 aio_utime $fh, undef, undef;
3070
3071 close $fh
3072 or return;
3073
3074 aio_rename "$runtime~", $runtime
3075 and return;
3076
3077 warn "runtime file written.\n";
3078
3079 1
3080}
3081
2457sub emergency_save() { 3082sub emergency_save() {
2458 my $freeze_guard = cf::freeze_mainloop; 3083 my $freeze_guard = cf::freeze_mainloop;
2459 3084
2460 warn "enter emergency perl save\n"; 3085 warn "enter emergency perl save\n";
2461 3086
2492 3117
2493 warn Carp::longmess "post_cleanup backtrace" 3118 warn Carp::longmess "post_cleanup backtrace"
2494 if $make_core; 3119 if $make_core;
2495} 3120}
2496 3121
2497sub reload() { 3122sub do_reload_perl() {
2498 # can/must only be called in main 3123 # can/must only be called in main
2499 if ($Coro::current != $Coro::main) { 3124 if ($Coro::current != $Coro::main) {
2500 warn "can only reload from main coroutine"; 3125 warn "can only reload from main coroutine";
2501 return; 3126 return;
2502 } 3127 }
2536 %EXT_CORO = (); 3161 %EXT_CORO = ();
2537 3162
2538 warn "removing commands"; 3163 warn "removing commands";
2539 %COMMAND = (); 3164 %COMMAND = ();
2540 3165
2541 warn "removing ext commands"; 3166 warn "removing ext/exti commands";
2542 %EXTCMD = (); 3167 %EXTCMD = ();
3168 %EXTICMD = ();
2543 3169
2544 warn "unloading/nuking all extensions"; 3170 warn "unloading/nuking all extensions";
2545 for my $pkg (@EXTS) { 3171 for my $pkg (@EXTS) {
2546 warn "... unloading $pkg"; 3172 warn "... unloading $pkg";
2547 3173
2577 Symbol::delete_package "safe::$_" 3203 Symbol::delete_package "safe::$_"
2578 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3204 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2579 3205
2580 warn "unloading cf.pm \"a bit\""; 3206 warn "unloading cf.pm \"a bit\"";
2581 delete $INC{"cf.pm"}; 3207 delete $INC{"cf.pm"};
3208 delete $INC{"cf/pod.pm"};
2582 3209
2583 # don't, removes xs symbols, too, 3210 # don't, removes xs symbols, too,
2584 # and global variables created in xs 3211 # and global variables created in xs
2585 #Symbol::delete_package __PACKAGE__; 3212 #Symbol::delete_package __PACKAGE__;
2586 3213
2601 warn "reattaching attachments to maps"; 3228 warn "reattaching attachments to maps";
2602 reattach $_ for values %MAP; 3229 reattach $_ for values %MAP;
2603 warn "reattaching attachments to players"; 3230 warn "reattaching attachments to players";
2604 reattach $_ for values %PLAYER; 3231 reattach $_ for values %PLAYER;
2605 3232
2606 warn "loading reloadable resources";
2607 reload_resources;
2608
2609 warn "leaving sync_job"; 3233 warn "leaving sync_job";
2610 3234
2611 1 3235 1
2612 } or do { 3236 } or do {
2613 warn $@; 3237 warn $@;
2618 warn "reloaded"; 3242 warn "reloaded";
2619}; 3243};
2620 3244
2621our $RELOAD_WATCHER; # used only during reload 3245our $RELOAD_WATCHER; # used only during reload
2622 3246
3247sub reload_perl() {
3248 # doing reload synchronously and two reloads happen back-to-back,
3249 # coro crashes during coro_state_free->destroy here.
3250
3251 $RELOAD_WATCHER ||= Event->timer (
3252 reentrant => 0,
3253 after => 0,
3254 data => WF_AUTOCANCEL,
3255 cb => sub {
3256 do_reload_perl;
3257 undef $RELOAD_WATCHER;
3258 },
3259 );
3260}
3261
2623register_command "reload" => sub { 3262register_command "reload" => sub {
2624 my ($who, $arg) = @_; 3263 my ($who, $arg) = @_;
2625 3264
2626 if ($who->flag (FLAG_WIZ)) { 3265 if ($who->flag (FLAG_WIZ)) {
2627 $who->message ("reloading server."); 3266 $who->message ("reloading server.");
2628 3267 async { reload_perl };
2629 # doing reload synchronously and two reloads happen back-to-back,
2630 # coro crashes during coro_state_free->destroy here.
2631
2632 $RELOAD_WATCHER ||= Event->timer (
2633 reentrant => 0,
2634 after => 0,
2635 data => WF_AUTOCANCEL,
2636 cb => sub {
2637 reload;
2638 undef $RELOAD_WATCHER;
2639 },
2640 );
2641 } 3268 }
2642}; 3269};
2643 3270
2644unshift @INC, $LIBDIR; 3271unshift @INC, $LIBDIR;
2645 3272
2646my $bug_warning = 0; 3273my $bug_warning = 0;
2647 3274
3275our @WAIT_FOR_TICK;
3276our @WAIT_FOR_TICK_BEGIN;
3277
3278sub wait_for_tick {
3279 return unless $TICK_WATCHER->is_active;
3280 return if $Coro::current == $Coro::main;
3281
3282 my $signal = new Coro::Signal;
3283 push @WAIT_FOR_TICK, $signal;
3284 $signal->wait;
3285}
3286
3287sub wait_for_tick_begin {
3288 return unless $TICK_WATCHER->is_active;
3289 return if $Coro::current == $Coro::main;
3290
3291 my $signal = new Coro::Signal;
3292 push @WAIT_FOR_TICK_BEGIN, $signal;
3293 $signal->wait;
3294}
3295
3296 my $min = 1e6;#d#
3297 my $avg = 10;
2648$TICK_WATCHER = Event->timer ( 3298$TICK_WATCHER = Event->timer (
2649 reentrant => 0, 3299 reentrant => 0,
2650 parked => 1, 3300 parked => 1,
2651 prio => 0, 3301 prio => 0,
2652 at => $NEXT_TICK || $TICK, 3302 at => $NEXT_TICK || $TICK,
2656 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3306 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2657 unless ++$bug_warning > 10; 3307 unless ++$bug_warning > 10;
2658 return; 3308 return;
2659 } 3309 }
2660 3310
2661 $NOW = Event::time; 3311 $NOW = $tick_start = Event::time;
2662 3312
2663 cf::server_tick; # one server iteration 3313 cf::server_tick; # one server iteration
3314
3315 0 && sync_job {#d#
3316 for(1..10) {
3317 my $t = Event::time;
3318 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3319 or die;
3320
3321 $map->width (50);
3322 $map->height (50);
3323 $map->alloc;
3324 $map->_load_objects ("/tmp/x.map", 1);
3325 my $t = Event::time - $t;
3326
3327 #next unless $t < 0.0013;#d#
3328 if ($t < $min) {
3329 $min = $t;
3330 }
3331 $avg = $avg * 0.99 + $t * 0.01;
3332 }
3333 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3334 exit 0;
3335 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3336 };
3337
2664 $RUNTIME += $TICK; 3338 $RUNTIME += $TICK;
2665 $NEXT_TICK += $TICK; 3339 $NEXT_TICK += $TICK;
2666 3340
2667 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3341 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2668 $NEXT_RUNTIME_WRITE = $NOW + 10; 3342 $NEXT_RUNTIME_WRITE = $NOW + 10;
2670 write_runtime 3344 write_runtime
2671 or warn "ERROR: unable to write runtime file: $!"; 3345 or warn "ERROR: unable to write runtime file: $!";
2672 }; 3346 };
2673 } 3347 }
2674 3348
2675 $WAIT_FOR_TICK->broadcast;
2676 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2677
2678# my $AFTER = Event::time; 3349# my $AFTER = Event::time;
2679# warn $AFTER - $NOW;#d# 3350# warn $AFTER - $NOW;#d#
2680 3351
3352 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3353 $sig->send;
3354 }
3355 while (my $sig = shift @WAIT_FOR_TICK) {
3356 $sig->send;
3357 }
3358
3359 $NOW = Event::time;
3360
2681 # if we are delayed by four ticks or more, skip them all 3361 # if we are delayed by four ticks or more, skip them all
2682 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3362 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2683 3363
2684 $TICK_WATCHER->at ($NEXT_TICK); 3364 $TICK_WATCHER->at ($NEXT_TICK);
2685 $TICK_WATCHER->start; 3365 $TICK_WATCHER->start;
3366
3367 $LOAD = ($NOW - $tick_start) / $TICK;
3368 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3369
3370 _post_tick;
3371
3372
2686 }, 3373 },
2687); 3374);
2688 3375
2689{ 3376{
2690 BDB::max_poll_time $TICK * 0.1; 3377 BDB::max_poll_time $TICK * 0.1;
2718 3405
2719 cf::sync_job { 3406 cf::sync_job {
2720 eval { 3407 eval {
2721 BDB::db_env_open 3408 BDB::db_env_open
2722 $DB_ENV, 3409 $DB_ENV,
2723 $BDB_ENV_DIR, 3410 $BDBDIR,
2724 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3411 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2725 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3412 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2726 0666; 3413 0666;
2727 3414
2728 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3415 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2729 3416
2730 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3417 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2731 $DB_ENV->set_lk_detect; 3418 $DB_ENV->set_lk_detect;
2732 }; 3419 };
2733 3420
2749 prio => 6, 3436 prio => 6,
2750 cb => \&IO::AIO::poll_cb, 3437 cb => \&IO::AIO::poll_cb,
2751 ); 3438 );
2752} 3439}
2753 3440
3441my $_log_backtrace;
3442
3443sub _log_backtrace {
3444 my ($msg, @addr) = @_;
3445
3446 $msg =~ s/\n//;
3447
3448 # limit the # of concurrent backtraces
3449 if ($_log_backtrace < 2) {
3450 ++$_log_backtrace;
3451 async {
3452 my @bt = fork_call {
3453 @addr = map { sprintf "%x", $_ } @addr;
3454 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3455 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3456 or die "addr2line: $!";
3457
3458 my @funcs;
3459 my @res = <$fh>;
3460 chomp for @res;
3461 while (@res) {
3462 my ($func, $line) = splice @res, 0, 2, ();
3463 push @funcs, "[$func] $line";
3464 }
3465
3466 @funcs
3467 };
3468
3469 LOG llevInfo, "[ABT] $msg\n";
3470 LOG llevInfo, "[ABT] $_\n" for @bt;
3471 --$_log_backtrace;
3472 };
3473 } else {
3474 LOG llevInfo, "[ABT] $msg\n";
3475 LOG llevInfo, "[ABT] [suppressed]\n";
3476 }
3477}
3478
3479# load additional modules
3480use cf::pod;
3481
2754END { cf::emergency_save } 3482END { cf::emergency_save }
2755 3483
27561 34841
2757 3485

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines