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.237 by root, Fri Apr 13 05:08:51 2007 UTC vs.
Revision 1.320 by root, Tue Jul 24 22:49:40 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
1164package cf; 1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1165 1586
1166=back 1587=back
1167
1168 1588
1169=head3 cf::map 1589=head3 cf::map
1170 1590
1171=over 4 1591=over 4
1172 1592
1227 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1228 1648
1229 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1230 local $self->{path}; 1650 local $self->{path};
1231 local $self->{load_path}; 1651 local $self->{load_path};
1232 local $self->{deny_save};
1233 local $self->{deny_reset};
1234 1652
1235 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1236} 1654}
1237 1655
1238sub normalise { 1656sub normalise {
1285 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1286 return $self; 1704 return $self;
1287 } 1705 }
1288 } 1706 }
1289 1707
1290 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1291 () 1709 ()
1292} 1710}
1293 1711
1294sub init { 1712sub init {
1295 my ($self) = @_; 1713 my ($self) = @_;
1310 1728
1311# the original (read-only) location 1729# the original (read-only) location
1312sub load_path { 1730sub load_path {
1313 my ($self) = @_; 1731 my ($self) = @_;
1314 1732
1315 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1316} 1734}
1317 1735
1318# the temporary/swap location 1736# the temporary/swap location
1319sub save_path { 1737sub save_path {
1320 my ($self) = @_; 1738 my ($self) = @_;
1321 1739
1322 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1323 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1324} 1742}
1325 1743
1326# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1327sub uniq_path { 1745sub uniq_path {
1328 my ($self) = @_; 1746 my ($self) = @_;
1329 1747
1330 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1331 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1332} 1750}
1333 1751
1334# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1335# all maps in C++... 1753# all maps in C++...
1336sub change_all_map_light { 1754sub change_all_map_light {
1337 my ($change) = @_; 1755 my ($change) = @_;
1338 1756
1339 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1340 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;
1341} 1767}
1342 1768
1343sub unlink_save { 1769sub unlink_save {
1344 my ($self) = @_; 1770 my ($self) = @_;
1345 1771
1403 $self->load_header_orig 1829 $self->load_header_orig
1404 or return; 1830 or return;
1405 $self->prepare_orig; 1831 $self->prepare_orig;
1406 } 1832 }
1407 1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1839
1408 1 1840 1
1409} 1841}
1410 1842
1411sub find; 1843sub find;
1412sub find { 1844sub find {
1424 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1425 1857
1426 $map->load_header 1858 $map->load_header
1427 or return; 1859 or return;
1428 1860
1429 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1430 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1431 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1432 $map->reset; 1864 $map->reset;
1433 undef $guard; 1865 undef $guard;
1434 return find $path; 1866 return find $path;
1445 my ($self) = @_; 1877 my ($self) = @_;
1446 1878
1447 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1448 1880
1449 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1450 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1451 1885
1452 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1453 1887
1454 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1455 1889
1456 $self->alloc; 1890 $self->alloc;
1457 1891
1458 $self->pre_load; 1892 $self->pre_load;
1459
1460 $self->_load_objects ($self->{load_path}, 1)
1461 or return;
1462
1463 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1464 if delete $self->{load_original};
1465
1466 if (my $uniq = $self->uniq_path) {
1467 utf8::encode $uniq;
1468 if (aio_open $uniq, O_RDONLY, 0) {
1469 $self->clear_unique_items;
1470 $self->_load_objects ($uniq, 0);
1471 }
1472 }
1473
1474 Coro::cede;
1475
1476 # now do the right thing for maps
1477 $self->link_multipart_objects;
1478
1479 unless ($self->{deny_activate}) {
1480 $self->decay_objects;
1481 $self->fix_auto_apply;
1482 $self->update_buttons;
1483 Coro::cede; 1893 Coro::cede;
1484 $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;
1485 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1486 unless $self->difficulty; 1913 unless $self->difficulty;
1487 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;
1488 $self->activate; 1923 $self->activate;
1924 }
1925
1926 $self->in_memory (cf::MAP_IN_MEMORY);
1489 } 1927 }
1490 1928
1491 $self->post_load; 1929 $self->post_load;
1492
1493 $self->in_memory (cf::MAP_IN_MEMORY);
1494} 1930}
1495 1931
1496sub customise_for { 1932sub customise_for {
1497 my ($self, $ob) = @_; 1933 my ($self, $ob) = @_;
1498 1934
1499 return find "~" . $ob->name . "/" . $self->{path} 1935 return find "~" . $ob->name . "/" . $self->{path}
1500 if $self->per_player; 1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1501 1940
1502 $self 1941 $self
1503} 1942}
1504 1943
1505# find and load all maps in the 3x3 area around a map 1944# find and load all maps in the 3x3 area around a map
1552 1991
1553 undef $MAP_PREFETCH{$path}; 1992 undef $MAP_PREFETCH{$path};
1554 $MAP_PREFETCHER ||= cf::async { 1993 $MAP_PREFETCHER ||= cf::async {
1555 while (%MAP_PREFETCH) { 1994 while (%MAP_PREFETCH) {
1556 for my $path (keys %MAP_PREFETCH) { 1995 for my $path (keys %MAP_PREFETCH) {
1557 my $map = find $path 1996 if (my $map = find $path) {
1558 or next;
1559 $map->load; 1997 $map->load;
1998 }
1560 1999
1561 delete $MAP_PREFETCH{$path}; 2000 delete $MAP_PREFETCH{$path};
1562 } 2001 }
1563 } 2002 }
1564 undef $MAP_PREFETCHER; 2003 undef $MAP_PREFETCHER;
1616 2055
1617sub reset_at { 2056sub reset_at {
1618 my ($self) = @_; 2057 my ($self) = @_;
1619 2058
1620 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1621 return 1e99 if $self->isa ("ext::map_per_player");#d#
1622 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1623 2061
1624 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1625 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1626 2064
1637 my ($self) = @_; 2075 my ($self) = @_;
1638 2076
1639 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1640 2078
1641 return if $self->players; 2079 return if $self->players;
1642 return if $self->isa ("ext::map_per_player");#d#
1643 2080
1644 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
1645 2082
1646 $self->in_memory (cf::MAP_SWAPPED); 2083 $self->in_memory (cf::MAP_SWAPPED);
1647 2084
1648 # need to save uniques path 2085 # need to save uniques path
1649 unless ($self->{deny_save}) { 2086 unless ($self->{deny_save}) {
1681 $cf::MAP{$self->path} = $self; 2118 $cf::MAP{$self->path} = $self;
1682 2119
1683 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1684} 2121}
1685 2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
1686=item cf::map::unique_maps 2159=item cf::map::unique_maps
1687 2160
1688Returns an arrayref of paths of all shared maps that have 2161Returns an arrayref of paths of all shared maps that have
1689instantiated unique items. May block. 2162instantiated unique items. May block.
1690 2163
1691=cut 2164=cut
1692 2165
1693sub unique_maps() { 2166sub unique_maps() {
1694 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2167 [
1695 or return; 2168 map {
1696
1697 my @paths;
1698
1699 for (@$files) {
1700 utf8::decode $_; 2169 utf8::decode $_;
1701 next if /\.pst$/; 2170 /\.map$/
1702 next unless /^$PATH_SEP/o; 2171 ? normalise $_
1703 2172 : ()
1704 push @paths, cf::map::normalise $_; 2173 } @{ aio_readdir $UNIQUEDIR or [] }
1705 } 2174 ]
1706
1707 \@paths
1708} 2175}
1709 2176
1710package cf; 2177package cf;
1711 2178
1712=back 2179=back
1758 2225
1759 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1760 2227
1761 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1762 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1763 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1764 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1765 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1766 } 2242 }
1767} 2243}
1768 2244
1769=item $player_object->may ("access") 2245=item $player_object->may ("access")
1770 2246
1818 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1819 2295
1820 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1821 2297
1822 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1823 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1824 2300
1825 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1826} 2302}
1827 2303
1828sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1829 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1830 2308
1831 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1832 2310
1833 unless ($map) { 2311 unless ($map) {
1834 # restore original map position 2312 # restore original map position
1857 2335
1858 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1859 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1860} 2338}
1861 2339
1862cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1863 on_logout => sub {
1864 my ($pl) = @_;
1865 2341
1866 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1867 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1868 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1869 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1870 }; 2346be called at the end of this process.
1871 }
1872 },
1873 on_login => sub {
1874 my ($pl) = @_;
1875 2347
1876 # try to abort aborted map switching on player login :)
1877 # should happen only on crashes
1878 if ($pl->ob->{_link_pos}) {
1879 $pl->ob->enter_link;
1880 (async {
1881 $pl->ob->reply (undef,
1882 "There was an internal problem at your last logout, "
1883 . "the server will try to bring you to your intended destination in a second.",
1884 cf::NDI_RED);
1885 # we need this sleep as the login has a concurrent enter_exit running
1886 # and this sleep increases chances of the player not ending up in scorn
1887 Coro::Timer::sleep 1;
1888 $pl->ob->leave_link;
1889 })->prio (2);
1890 }
1891 },
1892);
1893
1894=item $player_object->goto ($path, $x, $y)
1895
1896=cut 2348=cut
2349
2350our $GOTOGEN;
1897 2351
1898sub cf::object::player::goto { 2352sub cf::object::player::goto {
1899 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1900 2357
1901 $self->enter_link; 2358 $self->enter_link;
1902 2359
1903 (async { 2360 (async {
1904 my $map = eval { 2361 my $map = eval {
1905 my $map = cf::map::find $path; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1906 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
2366 $map = $check->($map) if $check && $map;
2367 } else {
2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
2370
1907 $map 2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
1908 } or 2377 }
1909 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1910 2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1911 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1912 })->prio (1); 2385 })->prio (1);
1913} 2386}
1914 2387
1915=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1916 2389
1955 2428
1956 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1957 2430
1958 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1959 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
1960 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2433 my $meta = "$RANDOMDIR/$md5.meta";
1961 2434
1962 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1963 aio_write $fh, 0, (length $data), $data, 0; 2436 aio_write $fh, 0, (length $data), $data, 0;
1964 undef $fh; 2437 undef $fh;
1965 aio_rename "$meta~", $meta; 2438 aio_rename "$meta~", $meta;
1984 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1985 my $hp = $exit->stats->hp; 2458 my $hp = $exit->stats->hp;
1986 my $sp = $exit->stats->sp; 2459 my $sp = $exit->stats->sp;
1987 2460
1988 $self->enter_link; 2461 $self->enter_link;
2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
1989 2466
1990 (async { 2467 (async {
1991 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1992 unless (eval { 2469 unless (eval {
1993 $self->goto ($slaying, $hp, $sp); 2470 $self->goto ($slaying, $hp, $sp);
2021 2498
2022 utf8::encode $text; 2499 utf8::encode $text;
2023 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2024} 2501}
2025 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => $channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2026=item $client->ext_event ($type, %msg) 2555=item $client->ext_msg ($type, @msg)
2027 2556
2028Sends an exti event to the client. 2557Sends an ext event to the client.
2029 2558
2030=cut 2559=cut
2031 2560
2032sub cf::client::ext_event($$%) { 2561sub cf::client::ext_msg($$@) {
2033 my ($self, $type, %msg) = @_; 2562 my ($self, $type, @msg) = @_;
2034 2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2035 $msg{msgtype} = "event_$type"; 2569 push @msg, msgtype => "event_$type";
2036 $self->send_packet ("ext " . cf::to_json \%msg); 2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2037} 2572}
2038 2573
2039=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
2040 2575
2041Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
2042the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2043C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2044 2579
2045Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
2046reliable at some point in the future. 2581become reliable at some point in the future.
2047 2582
2048=cut 2583=cut
2049 2584
2050sub cf::client::query { 2585sub cf::client::query {
2051 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
2059 utf8::encode $text; 2594 utf8::encode $text;
2060 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2061 2596
2062 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
2063 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
2064} 2601}
2065 2602
2066cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
2067 on_reply => sub { 2609 on_reply => sub {
2068 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
2069 2611
2070 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
2071 # get handled first 2613 # get handled first
2083 } else { 2625 } else {
2084 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2085 } 2627 }
2086 } 2628 }
2087 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
2088); 2653);
2089 2654
2090=item $client->async (\&cb) 2655=item $client->async (\&cb)
2091 2656
2092Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
2141 2706
2142=pod 2707=pod
2143 2708
2144The following functions and methods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2145 2710
2146 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
2147 cf::object::player player 2715 cf::object::player
2148 cf::player peaceful 2716 player
2149 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2150 2723
2151=cut 2724=cut
2152 2725
2153for ( 2726for (
2154 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
2155 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2156 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2157 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2158) { 2732) {
2159 no strict 'refs'; 2733 no strict 'refs';
2230=back 2804=back
2231 2805
2232=cut 2806=cut
2233 2807
2234############################################################################# 2808#############################################################################
2235
2236=head2 EXTENSION DATABASE SUPPORT
2237
2238Crossfire maintains a very simple database for extension use. It can
2239currently store anything that can be serialised using Storable, which
2240excludes objects.
2241
2242The parameter C<$family> should best start with the name of the extension
2243using it, it should be unique.
2244
2245=over 4
2246
2247=item $value = cf::db_get $family => $key
2248
2249Returns a single value from the database.
2250
2251=item cf::db_put $family => $key => $value
2252
2253Stores the given C<$value> in the family.
2254
2255=cut
2256
2257our $DB;
2258
2259sub db_init {
2260 unless ($DB) {
2261 $DB = BDB::db_create $DB_ENV;
2262
2263 cf::sync_job {
2264 eval {
2265 $DB->set_flags (BDB::CHKSUM);
2266
2267 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2268 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2269 cf::cleanup "db_open(db): $!" if $!;
2270 };
2271 cf::cleanup "db_open(db): $@" if $@;
2272 };
2273
2274 my $path = cf::localdir . "/database.pst";
2275 if (stat $path) {
2276 cf::sync_job {
2277 my $pst = Storable::retrieve $path;
2278
2279 cf::db_put (board => data => $pst->{board});
2280 cf::db_put (guildrules => data => $pst->{guildrules});
2281 cf::db_put (rent => balance => $pst->{rent}{balance});
2282 BDB::db_env_txn_checkpoint $DB_ENV;
2283
2284 unlink $path;
2285 };
2286 }
2287 }
2288}
2289
2290sub db_get($$) {
2291 my $key = "$_[0]/$_[1]";
2292
2293 cf::sync_job {
2294 BDB::db_get $DB, undef, $key, my $data;
2295
2296 $! ? ()
2297 : Compress::LZF::sthaw $data
2298 }
2299}
2300
2301sub db_put($$$) {
2302 BDB::dbreq_pri 4;
2303 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2304}
2305
2306#############################################################################
2307# the server's init and main functions 2809# the server's init and main functions
2308 2810
2309sub load_facedata { 2811sub load_facedata($) {
2310 my $path = sprintf "%s/facedata", cf::datadir; 2812 my ($path) = @_;
2311 2813
2312 warn "loading facedata from $path\n"; 2814 warn "loading facedata from $path\n";
2313 2815
2314 my $facedata; 2816 my $facedata;
2315 0 < aio_load $path, $facedata 2817 0 < aio_load $path, $facedata
2323 { 2825 {
2324 my $faces = $facedata->{faceinfo}; 2826 my $faces = $facedata->{faceinfo};
2325 2827
2326 while (my ($face, $info) = each %$faces) { 2828 while (my ($face, $info) = each %$faces) {
2327 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2328 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2329 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2330 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2331 Coro::cede; 2834
2835 cf::cede_to_tick;
2332 } 2836 }
2333 2837
2334 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2335 next unless $info->{smooth}; 2839 next unless $info->{smooth};
2336 my $idx = cf::face::find $face 2840 my $idx = cf::face::find $face
2337 or next; 2841 or next;
2338 if (my $smooth = cf::face::find $info->{smooth}) { 2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2339 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2340 } else { 2845 } else {
2341 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2342 } 2847 }
2343 Coro::cede; 2848
2849 cf::cede_to_tick;
2344 } 2850 }
2345 } 2851 }
2346 2852
2347 { 2853 {
2348 my $anims = $facedata->{animinfo}; 2854 my $anims = $facedata->{animinfo};
2349 2855
2350 while (my ($anim, $info) = each %$anims) { 2856 while (my ($anim, $info) = each %$anims) {
2351 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2352 Coro::cede; 2858 cf::cede_to_tick;
2353 } 2859 }
2354 2860
2355 cf::anim::invalidate_all; # d'oh 2861 cf::anim::invalidate_all; # d'oh
2356 } 2862 }
2357 2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 if (my $soundconf = delete $res->{"res/sound.conf"}) {
2871 $soundconf = $enc->decode (delete $soundconf->{data});
2872 # todo
2873 }
2874
2875 while (my ($name, $info) = each %$res) {
2876 my $meta = $enc->encode ({
2877 name => $name,
2878 %{ $info->{meta} || {} },
2879 });
2880
2881 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2882
2883 if ($info->{type} & 1) {
2884 # prepend meta info
2885
2886 my $data = pack "(w/a*)*", $meta, $info->{data};
2887 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2888
2889 cf::face::set_data $idx, 0, $data, $chk;
2890 } else {
2891 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2892 }
2893
2894 cf::face::set_type $idx, $info->{type};
2895
2896 cf::cede_to_tick;
2897 }
2898 }
2899
2358 1 2900 1
2359} 2901}
2360 2902
2903register_exticmd fx_want => sub {
2904 my ($ns, $want) = @_;
2905
2906 while (my ($k, $v) = each %$want) {
2907 $ns->fx_want ($k, $v);
2908 }
2909};
2910
2911sub reload_regions {
2912 load_resource_file "$MAPDIR/regions"
2913 or die "unable to load regions file\n";
2914
2915 for (cf::region::list) {
2916 $_->{match} = qr/$_->{match}/
2917 if exists $_->{match};
2918 }
2919}
2920
2921sub reload_facedata {
2922 load_facedata "$DATADIR/facedata"
2923 or die "unable to load facedata\n";
2924}
2925
2926sub reload_archetypes {
2927 load_resource_file "$DATADIR/archetypes"
2928 or die "unable to load archetypes\n";
2929 #d# NEED to laod twice to resolve forward references
2930 # this really needs to be done in an extra post-pass
2931 # (which needs to be synchronous, so solve it differently)
2932 load_resource_file "$DATADIR/archetypes"
2933 or die "unable to load archetypes\n";
2934}
2935
2936sub reload_treasures {
2937 load_resource_file "$DATADIR/treasures"
2938 or die "unable to load treasurelists\n";
2939}
2940
2361sub reload_resources { 2941sub reload_resources {
2362 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2942 warn "reloading resource files...\n";
2363 or die "unable to load regions file\n";#d# 2943
2944 reload_regions;
2364 load_facedata 2945 reload_facedata;
2365 or die "unable to load facedata\n";#d# 2946 #reload_archetypes;#d#
2947 reload_archetypes;
2948 reload_treasures;
2949
2950 warn "finished reloading resource files\n";
2366} 2951}
2367 2952
2368sub init { 2953sub init {
2369 reload_resources; 2954 reload_resources;
2370} 2955}
2371 2956
2372sub cfg_load { 2957sub cfg_load {
2373 open my $fh, "<:utf8", cf::confdir . "/config" 2958 open my $fh, "<:utf8", "$CONFDIR/config"
2374 or return; 2959 or return;
2375 2960
2376 local $/; 2961 local $/;
2377 *CFG = YAML::Syck::Load <$fh>; 2962 *CFG = YAML::Syck::Load <$fh>;
2378 2963
2423 }, 3008 },
2424 ); 3009 );
2425 } 3010 }
2426} 3011}
2427 3012
3013sub write_runtime {
3014 my $runtime = "$LOCALDIR/runtime";
3015
3016 # first touch the runtime file to show we are still running:
3017 # the fsync below can take a very very long time.
3018
3019 IO::AIO::aio_utime $runtime, undef, undef;
3020
3021 my $guard = cf::lock_acquire "write_runtime";
3022
3023 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3024 or return;
3025
3026 my $value = $cf::RUNTIME + 90 + 10;
3027 # 10 is the runtime save interval, for a monotonic clock
3028 # 60 allows for the watchdog to kill the server.
3029
3030 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3031 and return;
3032
3033 # always fsync - this file is important
3034 aio_fsync $fh
3035 and return;
3036
3037 # touch it again to show we are up-to-date
3038 aio_utime $fh, undef, undef;
3039
3040 close $fh
3041 or return;
3042
3043 aio_rename "$runtime~", $runtime
3044 and return;
3045
3046 warn "runtime file written.\n";
3047
3048 1
3049}
3050
2428sub emergency_save() { 3051sub emergency_save() {
2429 my $freeze_guard = cf::freeze_mainloop; 3052 my $freeze_guard = cf::freeze_mainloop;
2430 3053
2431 warn "enter emergency perl save\n"; 3054 warn "enter emergency perl save\n";
2432 3055
2463 3086
2464 warn Carp::longmess "post_cleanup backtrace" 3087 warn Carp::longmess "post_cleanup backtrace"
2465 if $make_core; 3088 if $make_core;
2466} 3089}
2467 3090
2468sub reload() { 3091sub do_reload_perl() {
2469 # can/must only be called in main 3092 # can/must only be called in main
2470 if ($Coro::current != $Coro::main) { 3093 if ($Coro::current != $Coro::main) {
2471 warn "can only reload from main coroutine"; 3094 warn "can only reload from main coroutine";
2472 return; 3095 return;
2473 } 3096 }
2507 %EXT_CORO = (); 3130 %EXT_CORO = ();
2508 3131
2509 warn "removing commands"; 3132 warn "removing commands";
2510 %COMMAND = (); 3133 %COMMAND = ();
2511 3134
2512 warn "removing ext commands"; 3135 warn "removing ext/exti commands";
2513 %EXTCMD = (); 3136 %EXTCMD = ();
3137 %EXTICMD = ();
2514 3138
2515 warn "unloading/nuking all extensions"; 3139 warn "unloading/nuking all extensions";
2516 for my $pkg (@EXTS) { 3140 for my $pkg (@EXTS) {
2517 warn "... unloading $pkg"; 3141 warn "... unloading $pkg";
2518 3142
2548 Symbol::delete_package "safe::$_" 3172 Symbol::delete_package "safe::$_"
2549 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3173 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2550 3174
2551 warn "unloading cf.pm \"a bit\""; 3175 warn "unloading cf.pm \"a bit\"";
2552 delete $INC{"cf.pm"}; 3176 delete $INC{"cf.pm"};
3177 delete $INC{"cf/pod.pm"};
2553 3178
2554 # don't, removes xs symbols, too, 3179 # don't, removes xs symbols, too,
2555 # and global variables created in xs 3180 # and global variables created in xs
2556 #Symbol::delete_package __PACKAGE__; 3181 #Symbol::delete_package __PACKAGE__;
2557 3182
2572 warn "reattaching attachments to maps"; 3197 warn "reattaching attachments to maps";
2573 reattach $_ for values %MAP; 3198 reattach $_ for values %MAP;
2574 warn "reattaching attachments to players"; 3199 warn "reattaching attachments to players";
2575 reattach $_ for values %PLAYER; 3200 reattach $_ for values %PLAYER;
2576 3201
2577 warn "loading reloadable resources";
2578 reload_resources;
2579
2580 warn "leaving sync_job"; 3202 warn "leaving sync_job";
2581 3203
2582 1 3204 1
2583 } or do { 3205 } or do {
2584 warn $@; 3206 warn $@;
2589 warn "reloaded"; 3211 warn "reloaded";
2590}; 3212};
2591 3213
2592our $RELOAD_WATCHER; # used only during reload 3214our $RELOAD_WATCHER; # used only during reload
2593 3215
3216sub reload_perl() {
3217 # doing reload synchronously and two reloads happen back-to-back,
3218 # coro crashes during coro_state_free->destroy here.
3219
3220 $RELOAD_WATCHER ||= Event->timer (
3221 reentrant => 0,
3222 after => 0,
3223 data => WF_AUTOCANCEL,
3224 cb => sub {
3225 do_reload_perl;
3226 undef $RELOAD_WATCHER;
3227 },
3228 );
3229}
3230
2594register_command "reload" => sub { 3231register_command "reload" => sub {
2595 my ($who, $arg) = @_; 3232 my ($who, $arg) = @_;
2596 3233
2597 if ($who->flag (FLAG_WIZ)) { 3234 if ($who->flag (FLAG_WIZ)) {
2598 $who->message ("reloading server."); 3235 $who->message ("reloading server.");
2599 3236 async { reload_perl };
2600 # doing reload synchronously and two reloads happen back-to-back,
2601 # coro crashes during coro_state_free->destroy here.
2602
2603 $RELOAD_WATCHER ||= Event->timer (
2604 reentrant => 0,
2605 after => 0,
2606 data => WF_AUTOCANCEL,
2607 cb => sub {
2608 reload;
2609 undef $RELOAD_WATCHER;
2610 },
2611 );
2612 } 3237 }
2613}; 3238};
2614 3239
2615unshift @INC, $LIBDIR; 3240unshift @INC, $LIBDIR;
2616 3241
2617my $bug_warning = 0; 3242my $bug_warning = 0;
2618 3243
3244our @WAIT_FOR_TICK;
3245our @WAIT_FOR_TICK_BEGIN;
3246
3247sub wait_for_tick {
3248 return unless $TICK_WATCHER->is_active;
3249 return if $Coro::current == $Coro::main;
3250
3251 my $signal = new Coro::Signal;
3252 push @WAIT_FOR_TICK, $signal;
3253 $signal->wait;
3254}
3255
3256sub wait_for_tick_begin {
3257 return unless $TICK_WATCHER->is_active;
3258 return if $Coro::current == $Coro::main;
3259
3260 my $signal = new Coro::Signal;
3261 push @WAIT_FOR_TICK_BEGIN, $signal;
3262 $signal->wait;
3263}
3264
3265 my $min = 1e6;#d#
3266 my $avg = 10;
2619$TICK_WATCHER = Event->timer ( 3267$TICK_WATCHER = Event->timer (
2620 reentrant => 0, 3268 reentrant => 0,
2621 parked => 1, 3269 parked => 1,
2622 prio => 0, 3270 prio => 0,
2623 at => $NEXT_TICK || $TICK, 3271 at => $NEXT_TICK || $TICK,
2627 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3275 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2628 unless ++$bug_warning > 10; 3276 unless ++$bug_warning > 10;
2629 return; 3277 return;
2630 } 3278 }
2631 3279
2632 $NOW = Event::time; 3280 $NOW = $tick_start = Event::time;
2633 3281
2634 cf::server_tick; # one server iteration 3282 cf::server_tick; # one server iteration
3283
3284 0 && sync_job {#d#
3285 for(1..10) {
3286 my $t = Event::time;
3287 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3288 or die;
3289
3290 $map->width (50);
3291 $map->height (50);
3292 $map->alloc;
3293 $map->_load_objects ("/tmp/x.map", 1);
3294 my $t = Event::time - $t;
3295
3296 #next unless $t < 0.0013;#d#
3297 if ($t < $min) {
3298 $min = $t;
3299 }
3300 $avg = $avg * 0.99 + $t * 0.01;
3301 }
3302 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3303 exit 0;
3304 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3305 };
3306
2635 $RUNTIME += $TICK; 3307 $RUNTIME += $TICK;
2636 $NEXT_TICK += $TICK; 3308 $NEXT_TICK += $TICK;
2637 3309
2638 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3310 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2639 $NEXT_RUNTIME_WRITE = $NOW + 10; 3311 $NEXT_RUNTIME_WRITE = $NOW + 10;
2641 write_runtime 3313 write_runtime
2642 or warn "ERROR: unable to write runtime file: $!"; 3314 or warn "ERROR: unable to write runtime file: $!";
2643 }; 3315 };
2644 } 3316 }
2645 3317
2646 $WAIT_FOR_TICK->broadcast;
2647 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2648
2649# my $AFTER = Event::time; 3318# my $AFTER = Event::time;
2650# warn $AFTER - $NOW;#d# 3319# warn $AFTER - $NOW;#d#
2651 3320
3321 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3322 $sig->send;
3323 }
3324 while (my $sig = shift @WAIT_FOR_TICK) {
3325 $sig->send;
3326 }
3327
3328 $NOW = Event::time;
3329
2652 # if we are delayed by four ticks or more, skip them all 3330 # if we are delayed by four ticks or more, skip them all
2653 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3331 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2654 3332
2655 $TICK_WATCHER->at ($NEXT_TICK); 3333 $TICK_WATCHER->at ($NEXT_TICK);
2656 $TICK_WATCHER->start; 3334 $TICK_WATCHER->start;
3335
3336 $LOAD = ($NOW - $tick_start) / $TICK;
3337 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3338
3339 _post_tick;
3340
3341
2657 }, 3342 },
2658); 3343);
2659 3344
2660{ 3345{
2661 BDB::max_poll_time $TICK * 0.1; 3346 BDB::max_poll_time $TICK * 0.1;
2689 3374
2690 cf::sync_job { 3375 cf::sync_job {
2691 eval { 3376 eval {
2692 BDB::db_env_open 3377 BDB::db_env_open
2693 $DB_ENV, 3378 $DB_ENV,
2694 $BDB_ENV_DIR, 3379 $BDBDIR,
2695 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3380 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2696 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3381 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2697 0666; 3382 0666;
2698 3383
2699 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3384 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2700 3385
2701 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3386 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2702 $DB_ENV->set_lk_detect; 3387 $DB_ENV->set_lk_detect;
2703 }; 3388 };
2704 3389
2720 prio => 6, 3405 prio => 6,
2721 cb => \&IO::AIO::poll_cb, 3406 cb => \&IO::AIO::poll_cb,
2722 ); 3407 );
2723} 3408}
2724 3409
3410my $_log_backtrace;
3411
3412sub _log_backtrace {
3413 my ($msg, @addr) = @_;
3414
3415 $msg =~ s/\n//;
3416
3417 # limit the # of concurrent backtraces
3418 if ($_log_backtrace < 2) {
3419 ++$_log_backtrace;
3420 async {
3421 my @bt = fork_call {
3422 @addr = map { sprintf "%x", $_ } @addr;
3423 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3424 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3425 or die "addr2line: $!";
3426
3427 my @funcs;
3428 my @res = <$fh>;
3429 chomp for @res;
3430 while (@res) {
3431 my ($func, $line) = splice @res, 0, 2, ();
3432 push @funcs, "[$func] $line";
3433 }
3434
3435 @funcs
3436 };
3437
3438 LOG llevInfo, "[ABT] $msg\n";
3439 LOG llevInfo, "[ABT] $_\n" for @bt;
3440 --$_log_backtrace;
3441 };
3442 } else {
3443 LOG llevInfo, "[ABT] $msg\n";
3444 LOG llevInfo, "[ABT] [suppressed]\n";
3445 }
3446}
3447
3448# load additional modules
3449use cf::pod;
3450
2725END { cf::emergency_save } 3451END { cf::emergency_save }
2726 3452
27271 34531
2728 3454

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines