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.244 by root, Mon Apr 16 13:28:00 2007 UTC vs.
Revision 1.326 by root, Tue Jul 31 17:33:15 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.61 (); 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 94
81# 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 ∕
82our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
83 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
84binmode STDOUT; 102binmode STDOUT;
85binmode STDERR; 103binmode STDERR;
86 104
87# read virtual server time, if available 105# read virtual server time, if available
88unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
89 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
90 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
91 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
92} 110}
93 111
94mkdir cf::localdir; 112mkdir $_
95mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
96mkdir cf::localdir . "/" . cf::tmpdir;
97mkdir cf::localdir . "/" . cf::uniquedir;
98mkdir $RANDOM_MAPS;
99mkdir $BDB_ENV_DIR;
100 114
101our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
102 116
103sub cf::map::normalise; 117sub cf::map::normalise;
104 118
115=item $cf::RUNTIME 129=item $cf::RUNTIME
116 130
117The 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
118every server tick. 132every server tick.
119 133
120=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
121 137
122The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
123be 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.
124 142
125=item $cf::NOW 143=item $cf::NOW
126 144
127The time of the last (current) server tick. 145The time of the last (current) server tick.
128 146
129=item $cf::TICK 147=item $cf::TICK
130 148
131The 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.
132 160
133=item %cf::CFG 161=item %cf::CFG
134 162
135Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
136from wherever your confdir points to. 164from wherever your confdir points to.
139 167
140These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
141returns directly I<after> the tick processing (and consequently, can only wake one process 169returns directly I<after> the tick processing (and consequently, can only wake one process
142per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
143 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.
177
144=back 178=back
145 179
146=cut 180=cut
147 181
148BEGIN { 182BEGIN {
149 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
150 my $msg = join "", @_; 184 my $msg = join "", @_;
151 utf8::encode $msg;
152 185
153 $msg .= "\n" 186 $msg .= "\n"
154 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
155 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
156 LOG llevError, $msg; 192 LOG llevError, $msg;
157 }; 193 };
158} 194}
159 195
160@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
161@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
162@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
163@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
164@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';
165@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)
166 203
167# 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
168# within the Safe compartment. 205# within the Safe compartment.
169for my $pkg (qw( 206for my $pkg (qw(
170 cf::global cf::attachable 207 cf::global cf::attachable
178} 215}
179 216
180$Event::DIED = sub { 217$Event::DIED = sub {
181 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
182}; 219};
220
221#############################################################################
183 222
184=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
185 224
186=over 4 225=over 4
187 226
206 $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;
207 $d 246 $d
208 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
209} 248}
210 249
211use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
212
213=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
214 251
215Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
216 253
217=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
218 255
219Converts 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]) }
220 264
221=item cf::lock_wait $string 265=item cf::lock_wait $string
222 266
223Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
224 268
230returned. 274returned.
231 275
232Lock 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
233uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
234 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
235=cut 283=cut
236 284
237our %LOCK; 285our %LOCK;
238 286
239sub lock_wait($) { 287sub lock_wait($) {
256 304
257 Coro::guard { 305 Coro::guard {
258 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
259 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
260 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
261} 315}
262 316
263sub freeze_mainloop { 317sub freeze_mainloop {
264 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
265 319
268 }; 322 };
269 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
270 $guard 324 $guard
271} 325}
272 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
273=item cf::async { BLOCK } 383=item cf::async { BLOCK }
274 384
275Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
276C<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
277thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
280 390
281BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
282 392
283=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
284 394
285The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
288 399
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 403fast or be very important.
295 406
296sub sync_job(&) { 407sub sync_job(&) {
297 my ($job) = @_; 408 my ($job) = @_;
298 409
299 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
300 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
302 415
303 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 417 # (but this is cancel-safe)
315 428
316 while ($busy) { 429 while ($busy) {
317 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
318 } 431 }
319 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
320 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
321 } else { 441 } else {
322 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
323 443
324 $job->() 444 $job->()
343 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
344 464
345 $coro 465 $coro
346} 466}
347 467
348sub write_runtime { 468=item fork_call { }, $args
349 my $guard = cf::lock_acquire "write_runtime";
350 469
351 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.
352 474
353 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
354 or return;
355 476
356 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
357 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
358 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
359 480 Storable::store_fd $_[0], $fh;
360 (aio_write $fh, 0, (length $value), $value, 0) <= 0
361 and return;
362
363 # always fsync - this file is important
364 aio_fsync $fh
365 and return;
366
367 close $fh 481 close $fh;
368 or return;
369 482
370 aio_rename "$runtime~", $runtime 483 $buf
371 and return; 484}
372 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;
373 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"
374} 644}
375 645
376=item cf::datalog type => key => value, ... 646=item cf::datalog type => key => value, ...
377 647
378Log 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.
396attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
397to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
398 668
399In 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>
400C<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
401crossfire+). 671Crossfire TRT).
402 672
403=over 4 673=over 4
404 674
405=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
406 676
569 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
570 840
571 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
572 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
573 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
574 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575 845
576 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
577 my $pkg = shift @arg; 847 my $pkg = shift @arg;
578 848
579 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
608 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
609 } 879 }
610 880
611 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
612 } else { 882 } else {
613 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
614 } 884 }
615 885
616 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
617} 887}
618 888
620 if (ref $_[0]) { 890 if (ref $_[0]) {
621 _object_attach @_; 891 _object_attach @_;
622 } else { 892 } else {
623 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
624 } 894 }
895 _recalc_want;
625}; 896};
626 897
627# all those should be optimised 898# all those should be optimised
628sub cf::attachable::detach { 899sub cf::attachable::detach {
629 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
632 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
633 reattach ($obj); 904 reattach ($obj);
634 } else { 905 } else {
635 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
636 } 907 }
908 _recalc_want;
637}; 909};
638 910
639sub cf::attachable::attached { 911sub cf::attachable::attached {
640 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
641 913
656 "; 928 ";
657 die if $@; 929 die if $@;
658} 930}
659 931
660our $override; 932our $override;
661our @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?
662 934
663sub override { 935sub override {
664 $override = 1; 936 $override = 1;
665 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
666} 938}
667 939
668sub do_invoke { 940sub do_invoke {
669 my $event = shift; 941 my $event = shift;
670 my $callbacks = shift; 942 my $callbacks = shift;
671 943
672 @invoke_results = (); 944 @INVOKE_RESULTS = ();
673 945
674 local $override; 946 local $override;
675 947
676 for (@$callbacks) { 948 for (@$callbacks) {
677 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
694 966
695Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
696 968
697This 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
698removed 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
699results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
700 972
701=back 973=back
702 974
703=cut 975=cut
704 976
705############################################################################# 977#############################################################################
706# 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}
707 990
708sub reattach { 991sub reattach {
709 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
710 my ($obj) = @_; 993 my ($obj) = @_;
711 994
814 or return; 1097 or return;
815 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
816 } 1099 }
817 1100
818 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
819 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
820 return ($data, $av); 1103 return ($data, $av);
821} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
822 1111
823############################################################################# 1112#############################################################################
824# command handling &c 1113# command handling &c
825 1114
826=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
839 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
840} 1129}
841 1130
842=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
843 1132
844Register 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.
845 1138
846If 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
847called. 1140called.
848 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
849=cut 1153=cut
850 1154
851sub register_extcmd { 1155sub register_extcmd {
852 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
853 1157
854 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
855} 1165}
856 1166
857cf::player->attach ( 1167cf::player->attach (
858 on_command => sub { 1168 on_command => sub {
859 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
868 cf::override; 1178 cf::override;
869 }, 1179 },
870 on_extcmd => sub { 1180 on_extcmd => sub {
871 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
872 1182
873 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874 1184
875 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
876 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
877 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
878 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
879 } 1195 if $reply;
880 } 1196 }
881 } else { 1197 } else {
882 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
883 } 1199 }
884 1200
885 cf::override; 1201 cf::override;
886 }, 1202 },
887); 1203);
888 1204
889sub load_extension {
890 my ($path) = @_;
891
892 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
893 my $base = $1;
894 my $pkg = $1;
895 $pkg =~ s/[^[:word:]]/_/g;
896 $pkg = "ext::$pkg";
897
898 warn "... loading '$path' into '$pkg'\n";
899
900 open my $fh, "<:utf8", $path
901 or die "$path: $!";
902
903 my $source =
904 "package $pkg; use strict; use utf8;\n"
905 . "#line 1 \"$path\"\n{\n"
906 . (do { local $/; <$fh> })
907 . "\n};\n1";
908
909 unless (eval $source) {
910 my $msg = $@ ? "$path: $@\n"
911 : "extension disabled.\n";
912 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
913 warn $@;
914 warn "mandatory extension failed to load, exiting.\n";
915 exit 1;
916 }
917 die $@;
918 }
919
920 push @EXTS, $pkg;
921}
922
923sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
924 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
925 next unless -r $ext; 1210 next unless -r $path;
926 eval { 1211
927 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;
928 1 1269 }
929 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
930 } 1275 };
931} 1276}
932 1277
933############################################################################# 1278#############################################################################
934 1279
1280=back
1281
935=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
936 1283
937Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
938 1285
939=cut 1286=cut
951Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
952 1299
953=cut 1300=cut
954 1301
955sub playerdir($) { 1302sub playerdir($) {
956 cf::localdir 1303 "$PLAYERDIR/"
957 . "/"
958 . cf::playerdir
959 . "/"
960 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
961} 1305}
962 1306
963sub path($) { 1307sub path($) {
964 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1084while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1085 1429
1086=cut 1430=cut
1087 1431
1088sub list_logins { 1432sub list_logins {
1089 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1090 or return []; 1434 or return [];
1091 1435
1092 my @logins; 1436 my @logins;
1093 1437
1094 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1129 } 1473 }
1130 1474
1131 \@paths 1475 \@paths
1132} 1476}
1133 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
1134=item $player->ext_reply ($msgid, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1135 1529
1136Sends an ext reply to the player. 1530Sends an ext reply to the player.
1137 1531
1138=cut 1532=cut
1139 1533
1140sub ext_reply($$%) { 1534sub ext_reply($$@) {
1141 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1142 1536
1143 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1144 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1145 $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 }
1146} 1544}
1147 1545
1148=item $player->ext_event ($type, %msg) 1546=item $player->ext_msg ($type, @msg)
1149 1547
1150Sends an ext event to the client. 1548Sends an ext event to the client.
1151 1549
1152=cut 1550=cut
1153 1551
1154sub ext_event($$%) { 1552sub ext_msg($$@) {
1155 my ($self, $type, %msg) = @_; 1553 my ($self, $type, @msg) = @_;
1156 1554
1157 $self->ns->ext_event ($type, %msg); 1555 $self->ns->ext_msg ($type, @msg);
1158} 1556}
1159 1557
1160=head3 cf::region 1558=head3 cf::region
1161 1559
1162=over 4 1560=over 4
1165 1563
1166package cf::region; 1564package cf::region;
1167 1565
1168=item cf::region::find_by_path $path 1566=item cf::region::find_by_path $path
1169 1567
1170Tries 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.
1171 1569
1172=cut 1570=cut
1173 1571
1174sub find_by_path($) { 1572sub find_by_path($) {
1175 my ($path) = @_; 1573 my ($path) = @_;
1176 1574
1177 my ($match, $specificity); 1575 my ($match, $specificity);
1178 1576
1179 for my $region (list) { 1577 for my $region (list) {
1180 if ($region->match && $path =~ $region->match) { 1578 if ($region->{match} && $path =~ $region->{match}) {
1181 ($match, $specificity) = ($region, $region->specificity) 1579 ($match, $specificity) = ($region, $region->specificity)
1182 if $region->specificity > $specificity; 1580 if $region->specificity > $specificity;
1183 } 1581 }
1184 } 1582 }
1185 1583
1249 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1250 1648
1251 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1252 local $self->{path}; 1650 local $self->{path};
1253 local $self->{load_path}; 1651 local $self->{load_path};
1254 local $self->{deny_save};
1255 local $self->{deny_reset};
1256 1652
1257 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1258} 1654}
1259 1655
1260sub normalise { 1656sub normalise {
1307 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1308 return $self; 1704 return $self;
1309 } 1705 }
1310 } 1706 }
1311 1707
1312 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1313 () 1709 ()
1314} 1710}
1315 1711
1316sub init { 1712sub init {
1317 my ($self) = @_; 1713 my ($self) = @_;
1332 1728
1333# the original (read-only) location 1729# the original (read-only) location
1334sub load_path { 1730sub load_path {
1335 my ($self) = @_; 1731 my ($self) = @_;
1336 1732
1337 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1338} 1734}
1339 1735
1340# the temporary/swap location 1736# the temporary/swap location
1341sub save_path { 1737sub save_path {
1342 my ($self) = @_; 1738 my ($self) = @_;
1343 1739
1344 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1345 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1346} 1742}
1347 1743
1348# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1349sub uniq_path { 1745sub uniq_path {
1350 my ($self) = @_; 1746 my ($self) = @_;
1351 1747
1352 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1353 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1354} 1750}
1355 1751
1356# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1357# all maps in C++... 1753# all maps in C++...
1358sub change_all_map_light { 1754sub change_all_map_light {
1359 my ($change) = @_; 1755 my ($change) = @_;
1360 1756
1361 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1362 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;
1363} 1767}
1364 1768
1365sub unlink_save { 1769sub unlink_save {
1366 my ($self) = @_; 1770 my ($self) = @_;
1367 1771
1425 $self->load_header_orig 1829 $self->load_header_orig
1426 or return; 1830 or return;
1427 $self->prepare_orig; 1831 $self->prepare_orig;
1428 } 1832 }
1429 1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1430 $self->default_region (cf::region::find_by_path $self->{path}) 1837 $self->default_region (cf::region::find_by_path $self->{path})
1431 unless $self->default_region; 1838 unless $self->default_region;
1432 1839
1433 1 1840 1
1434} 1841}
1449 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1450 1857
1451 $map->load_header 1858 $map->load_header
1452 or return; 1859 or return;
1453 1860
1454 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1455 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1456 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1457 $map->reset; 1864 $map->reset;
1458 undef $guard; 1865 undef $guard;
1459 return find $path; 1866 return find $path;
1470 my ($self) = @_; 1877 my ($self) = @_;
1471 1878
1472 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1473 1880
1474 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1475 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1476 1885
1477 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1478 1887
1479 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1480 1889
1481 $self->alloc; 1890 $self->alloc;
1482 1891
1483 $self->pre_load; 1892 $self->pre_load;
1484 Coro::cede;
1485
1486 $self->_load_objects ($self->{load_path}, 1)
1487 or return;
1488
1489 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1490 if delete $self->{load_original};
1491
1492 if (my $uniq = $self->uniq_path) {
1493 utf8::encode $uniq;
1494 if (aio_open $uniq, O_RDONLY, 0) {
1495 $self->clear_unique_items;
1496 $self->_load_objects ($uniq, 0);
1497 }
1498 }
1499
1500 Coro::cede;
1501 # now do the right thing for maps
1502 $self->link_multipart_objects;
1503 Coro::cede;
1504
1505 unless ($self->{deny_activate}) {
1506 $self->decay_objects;
1507 $self->fix_auto_apply;
1508 $self->update_buttons;
1509 Coro::cede; 1893 Coro::cede;
1510 $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;
1511 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1512 unless $self->difficulty; 1913 unless $self->difficulty;
1513 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;
1514 $self->activate; 1923 $self->activate;
1515 Coro::cede; 1924 }
1925
1926 $self->{last_save} = $cf::RUNTIME;
1927 $self->last_access ($cf::RUNTIME);
1928
1929 $self->in_memory (cf::MAP_IN_MEMORY);
1516 } 1930 }
1517 1931
1518 $self->post_load; 1932 $self->post_load;
1519 Coro::cede;
1520
1521 $self->in_memory (cf::MAP_IN_MEMORY);
1522} 1933}
1523 1934
1524sub customise_for { 1935sub customise_for {
1525 my ($self, $ob) = @_; 1936 my ($self, $ob) = @_;
1526 1937
1527 return find "~" . $ob->name . "/" . $self->{path} 1938 return find "~" . $ob->name . "/" . $self->{path}
1528 if $self->per_player; 1939 if $self->per_player;
1940
1941# return find "?party/" . $ob->name . "/" . $self->{path}
1942# if $self->per_party;
1529 1943
1530 $self 1944 $self
1531} 1945}
1532 1946
1533# 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
1580 1994
1581 undef $MAP_PREFETCH{$path}; 1995 undef $MAP_PREFETCH{$path};
1582 $MAP_PREFETCHER ||= cf::async { 1996 $MAP_PREFETCHER ||= cf::async {
1583 while (%MAP_PREFETCH) { 1997 while (%MAP_PREFETCH) {
1584 for my $path (keys %MAP_PREFETCH) { 1998 for my $path (keys %MAP_PREFETCH) {
1585 my $map = find $path 1999 if (my $map = find $path) {
1586 or next;
1587 $map->load; 2000 $map->load;
2001 }
1588 2002
1589 delete $MAP_PREFETCH{$path}; 2003 delete $MAP_PREFETCH{$path};
1590 } 2004 }
1591 } 2005 }
1592 undef $MAP_PREFETCHER; 2006 undef $MAP_PREFETCHER;
1644 2058
1645sub reset_at { 2059sub reset_at {
1646 my ($self) = @_; 2060 my ($self) = @_;
1647 2061
1648 # TODO: safety, remove and allow resettable per-player maps 2062 # TODO: safety, remove and allow resettable per-player maps
1649 return 1e99 if $self->isa ("ext::map_per_player");#d#
1650 return 1e99 if $self->{deny_reset}; 2063 return 1e99 if $self->{deny_reset};
1651 2064
1652 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2065 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1653 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;
1654 2067
1665 my ($self) = @_; 2078 my ($self) = @_;
1666 2079
1667 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2080 my $lock = cf::lock_acquire "map_data:$self->{path}";
1668 2081
1669 return if $self->players; 2082 return if $self->players;
1670 return if $self->isa ("ext::map_per_player");#d#
1671 2083
1672 warn "resetting map ", $self->path;#d# 2084 warn "resetting map ", $self->path;
1673 2085
1674 $self->in_memory (cf::MAP_SWAPPED); 2086 $self->in_memory (cf::MAP_SWAPPED);
1675 2087
1676 # need to save uniques path 2088 # need to save uniques path
1677 unless ($self->{deny_save}) { 2089 unless ($self->{deny_save}) {
1709 $cf::MAP{$self->path} = $self; 2121 $cf::MAP{$self->path} = $self;
1710 2122
1711 $self->reset; # polite request, might not happen 2123 $self->reset; # polite request, might not happen
1712} 2124}
1713 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
1714=item cf::map::unique_maps 2162=item cf::map::unique_maps
1715 2163
1716Returns an arrayref of paths of all shared maps that have 2164Returns an arrayref of paths of all shared maps that have
1717instantiated unique items. May block. 2165instantiated unique items. May block.
1718 2166
1719=cut 2167=cut
1720 2168
1721sub unique_maps() { 2169sub unique_maps() {
1722 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2170 [
1723 or return; 2171 map {
1724
1725 my @paths;
1726
1727 for (@$files) {
1728 utf8::decode $_; 2172 utf8::decode $_;
1729 next if /\.pst$/; 2173 /\.map$/
1730 next unless /^$PATH_SEP/o; 2174 ? normalise $_
1731 2175 : ()
1732 push @paths, cf::map::normalise $_; 2176 } @{ aio_readdir $UNIQUEDIR or [] }
1733 } 2177 ]
1734
1735 \@paths
1736} 2178}
1737 2179
1738package cf; 2180package cf;
1739 2181
1740=back 2182=back
1786 2228
1787 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2229 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1788 2230
1789 if ($self->{record_replies}) { 2231 if ($self->{record_replies}) {
1790 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2232 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2233
1791 } 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 {
1792 $msg = $npc->name . " says: $msg" if $npc; 2242 $msg = $npc->name . " says: $msg" if $npc;
1793 $self->message ($msg, $flags); 2243 $self->message ($msg, $flags);
2244 }
1794 } 2245 }
1795} 2246}
1796 2247
1797=item $player_object->may ("access") 2248=item $player_object->may ("access")
1798 2249
1846 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1847 2298
1848 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1849 2300
1850 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1851 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1852 2303
1853 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1854} 2305}
1855 2306
1856sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1857 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1858 2311
1859 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1860 2313
1861 unless ($map) { 2314 unless ($map) {
1862 # restore original map position 2315 # restore original map position
1885 2338
1886 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1887 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1888} 2341}
1889 2342
1890cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1891 on_logout => sub {
1892 my ($pl) = @_;
1893 2344
1894 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1895 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1896 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1897 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1898 }; 2349be called at the end of this process.
1899 }
1900 },
1901 on_login => sub {
1902 my ($pl) = @_;
1903 2350
1904 # try to abort aborted map switching on player login :)
1905 # should happen only on crashes
1906 if ($pl->ob->{_link_pos}) {
1907 $pl->ob->enter_link;
1908 (async {
1909 $pl->ob->reply (undef,
1910 "There was an internal problem at your last logout, "
1911 . "the server will try to bring you to your intended destination in a second.",
1912 cf::NDI_RED);
1913 # we need this sleep as the login has a concurrent enter_exit running
1914 # and this sleep increases chances of the player not ending up in scorn
1915 Coro::Timer::sleep 1;
1916 $pl->ob->leave_link;
1917 })->prio (2);
1918 }
1919 },
1920);
1921
1922=item $player_object->goto ($path, $x, $y)
1923
1924=cut 2351=cut
2352
2353our $GOTOGEN;
1925 2354
1926sub cf::object::player::goto { 2355sub cf::object::player::goto {
1927 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;
1928 2360
1929 $self->enter_link; 2361 $self->enter_link;
1930 2362
1931 (async { 2363 (async {
1932 my $map = eval { 2364 my $map = eval {
1933 my $map = cf::map::find $path; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1934 $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
1935 $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 $@;
1936 } or 2380 }
1937 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1938 2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1939 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1940 })->prio (1); 2388 })->prio (1);
1941} 2389}
1942 2390
1943=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1944 2392
1983 2431
1984 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1985 2433
1986 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1987 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
1988 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2436 my $meta = "$RANDOMDIR/$md5.meta";
1989 2437
1990 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1991 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
1992 undef $fh; 2440 undef $fh;
1993 aio_rename "$meta~", $meta; 2441 aio_rename "$meta~", $meta;
2012 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;
2013 my $hp = $exit->stats->hp; 2461 my $hp = $exit->stats->hp;
2014 my $sp = $exit->stats->sp; 2462 my $sp = $exit->stats->sp;
2015 2463
2016 $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);
2017 2469
2018 (async { 2470 (async {
2019 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
2020 unless (eval { 2472 unless (eval {
2021 $self->goto ($slaying, $hp, $sp); 2473 $self->goto ($slaying, $hp, $sp);
2049 2501
2050 utf8::encode $text; 2502 utf8::encode $text;
2051 $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);
2052} 2504}
2053 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 if (0 && $msg =~ /\[/) {
2556 $self->send_packet ("drawextinfo $color 4 0 $msg")
2557 } else {
2558 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2559 $self->send_packet ("drawinfo $color $msg")
2560 }
2561 }
2562 }
2563}
2564
2054=item $client->ext_event ($type, %msg) 2565=item $client->ext_msg ($type, @msg)
2055 2566
2056Sends an exti event to the client. 2567Sends an ext event to the client.
2057 2568
2058=cut 2569=cut
2059 2570
2060sub cf::client::ext_event($$%) { 2571sub cf::client::ext_msg($$@) {
2061 my ($self, $type, %msg) = @_; 2572 my ($self, $type, @msg) = @_;
2062 2573
2574 my $extcmd = $self->extcmd;
2575
2576 if ($extcmd == 2) {
2577 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2578 } elsif ($extcmd == 1) { # TODO: remove
2063 $msg{msgtype} = "event_$type"; 2579 push @msg, msgtype => "event_$type";
2064 $self->send_packet ("ext " . cf::to_json \%msg); 2580 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2581 }
2065} 2582}
2066 2583
2067=item $success = $client->query ($flags, "text", \&cb) 2584=item $success = $client->query ($flags, "text", \&cb)
2068 2585
2069Queues a query to the client, calling the given callback with 2586Queues a query to the client, calling the given callback with
2070the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2587the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2071C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2588C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2072 2589
2073Queries can fail, so check the return code. Or don't, as queries will become 2590Queries can fail, so check the return code. Or don't, as queries will
2074reliable at some point in the future. 2591become reliable at some point in the future.
2075 2592
2076=cut 2593=cut
2077 2594
2078sub cf::client::query { 2595sub cf::client::query {
2079 my ($self, $flags, $text, $cb) = @_; 2596 my ($self, $flags, $text, $cb) = @_;
2087 utf8::encode $text; 2604 utf8::encode $text;
2088 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2605 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2089 2606
2090 $self->send_packet ($self->{query_queue}[0][0]) 2607 $self->send_packet ($self->{query_queue}[0][0])
2091 if @{ $self->{query_queue} } == 1; 2608 if @{ $self->{query_queue} } == 1;
2609
2610 1
2092} 2611}
2093 2612
2094cf::client->attach ( 2613cf::client->attach (
2614 on_connect => sub {
2615 my ($ns) = @_;
2616
2617 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2618 },
2095 on_reply => sub { 2619 on_reply => sub {
2096 my ($ns, $msg) = @_; 2620 my ($ns, $msg) = @_;
2097 2621
2098 # this weird shuffling is so that direct followup queries 2622 # this weird shuffling is so that direct followup queries
2099 # get handled first 2623 # get handled first
2111 } else { 2635 } else {
2112 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2636 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2113 } 2637 }
2114 } 2638 }
2115 }, 2639 },
2640 on_exticmd => sub {
2641 my ($ns, $buf) = @_;
2642
2643 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2644
2645 if (ref $msg) {
2646 my ($type, $reply, @payload) =
2647 "ARRAY" eq ref $msg
2648 ? @$msg
2649 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2650
2651 if (my $cb = $EXTICMD{$type}) {
2652 my @reply = $cb->($ns, @payload);
2653
2654 $ns->ext_reply ($reply, @reply)
2655 if $reply;
2656 }
2657 } else {
2658 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2659 }
2660
2661 cf::override;
2662 },
2116); 2663);
2117 2664
2118=item $client->async (\&cb) 2665=item $client->async (\&cb)
2119 2666
2120Create a new coroutine, running the specified callback. The coroutine will 2667Create a new coroutine, running the specified callback. The coroutine will
2169 2716
2170=pod 2717=pod
2171 2718
2172The following functions and methods are available within a safe environment: 2719The following functions and methods are available within a safe environment:
2173 2720
2174 cf::object contr pay_amount pay_player map 2721 cf::object
2722 contr pay_amount pay_player map x y force_find force_add
2723 insert remove
2724
2175 cf::object::player player 2725 cf::object::player
2176 cf::player peaceful 2726 player
2177 cf::map trigger 2727
2728 cf::player
2729 peaceful
2730
2731 cf::map
2732 trigger
2178 2733
2179=cut 2734=cut
2180 2735
2181for ( 2736for (
2182 ["cf::object" => qw(contr pay_amount pay_player map)], 2737 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2738 insert remove)],
2183 ["cf::object::player" => qw(player)], 2739 ["cf::object::player" => qw(player)],
2184 ["cf::player" => qw(peaceful)], 2740 ["cf::player" => qw(peaceful)],
2185 ["cf::map" => qw(trigger)], 2741 ["cf::map" => qw(trigger)],
2186) { 2742) {
2187 no strict 'refs'; 2743 no strict 'refs';
2258=back 2814=back
2259 2815
2260=cut 2816=cut
2261 2817
2262############################################################################# 2818#############################################################################
2263
2264=head2 EXTENSION DATABASE SUPPORT
2265
2266Crossfire maintains a very simple database for extension use. It can
2267currently store anything that can be serialised using Storable, which
2268excludes objects.
2269
2270The parameter C<$family> should best start with the name of the extension
2271using it, it should be unique.
2272
2273=over 4
2274
2275=item $value = cf::db_get $family => $key
2276
2277Returns a single value from the database.
2278
2279=item cf::db_put $family => $key => $value
2280
2281Stores the given C<$value> in the family.
2282
2283=cut
2284
2285our $DB;
2286
2287sub db_init {
2288 unless ($DB) {
2289 $DB = BDB::db_create $DB_ENV;
2290
2291 cf::sync_job {
2292 eval {
2293 $DB->set_flags (BDB::CHKSUM);
2294
2295 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2296 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2297 cf::cleanup "db_open(db): $!" if $!;
2298 };
2299 cf::cleanup "db_open(db): $@" if $@;
2300 };
2301
2302 my $path = cf::localdir . "/database.pst";
2303 if (stat $path) {
2304 cf::sync_job {
2305 my $pst = Storable::retrieve $path;
2306
2307 cf::db_put (board => data => $pst->{board});
2308 cf::db_put (guildrules => data => $pst->{guildrules});
2309 cf::db_put (rent => balance => $pst->{rent}{balance});
2310 BDB::db_env_txn_checkpoint $DB_ENV;
2311
2312 unlink $path;
2313 };
2314 }
2315 }
2316}
2317
2318sub db_get($$) {
2319 my $key = "$_[0]/$_[1]";
2320
2321 cf::sync_job {
2322 BDB::db_get $DB, undef, $key, my $data;
2323
2324 $! ? ()
2325 : Compress::LZF::sthaw $data
2326 }
2327}
2328
2329sub db_put($$$) {
2330 BDB::dbreq_pri 4;
2331 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2332}
2333
2334#############################################################################
2335# the server's init and main functions 2819# the server's init and main functions
2336 2820
2337sub load_facedata { 2821sub load_facedata($) {
2338 my $path = sprintf "%s/facedata", cf::datadir; 2822 my ($path) = @_;
2339 2823
2340 warn "loading facedata from $path\n"; 2824 warn "loading facedata from $path\n";
2341 2825
2342 my $facedata; 2826 my $facedata;
2343 0 < aio_load $path, $facedata 2827 0 < aio_load $path, $facedata
2351 { 2835 {
2352 my $faces = $facedata->{faceinfo}; 2836 my $faces = $facedata->{faceinfo};
2353 2837
2354 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2355 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2839 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2356 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2840 cf::face::set_visibility $idx, $info->{visibility};
2841 cf::face::set_magicmap $idx, $info->{magicmap};
2357 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2842 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2358 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2843 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2359 Coro::cede; 2844
2845 cf::cede_to_tick;
2360 } 2846 }
2361 2847
2362 while (my ($face, $info) = each %$faces) { 2848 while (my ($face, $info) = each %$faces) {
2363 next unless $info->{smooth}; 2849 next unless $info->{smooth};
2364 my $idx = cf::face::find $face 2850 my $idx = cf::face::find $face
2365 or next; 2851 or next;
2366 if (my $smooth = cf::face::find $info->{smooth}) { 2852 if (my $smooth = cf::face::find $info->{smooth}) {
2853 cf::face::set_smooth $idx, $smooth;
2367 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2854 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2368 } else { 2855 } else {
2369 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2856 warn "smooth face '$info->{smooth}' not found for face '$face'";
2370 } 2857 }
2371 Coro::cede; 2858
2859 cf::cede_to_tick;
2372 } 2860 }
2373 } 2861 }
2374 2862
2375 { 2863 {
2376 my $anims = $facedata->{animinfo}; 2864 my $anims = $facedata->{animinfo};
2377 2865
2378 while (my ($anim, $info) = each %$anims) { 2866 while (my ($anim, $info) = each %$anims) {
2379 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2867 cf::anim::set $anim, $info->{frames}, $info->{facings};
2380 Coro::cede; 2868 cf::cede_to_tick;
2381 } 2869 }
2382 2870
2383 cf::anim::invalidate_all; # d'oh 2871 cf::anim::invalidate_all; # d'oh
2384 } 2872 }
2385 2873
2874 {
2875 # TODO: for gcfclient pleasure, we should give resources
2876 # that gcfclient doesn't grok a >10000 face index.
2877 my $res = $facedata->{resource};
2878 my $enc = JSON::XS->new->utf8->canonical;
2879
2880 my $soundconf = delete $res->{"res/sound.conf"};
2881
2882 while (my ($name, $info) = each %$res) {
2883 my $meta = $enc->encode ({
2884 name => $name,
2885 %{ $info->{meta} || {} },
2886 });
2887
2888 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2889
2890 if ($info->{type} & 1) {
2891 # prepend meta info
2892
2893 my $data = pack "(w/a*)*", $meta, $info->{data};
2894 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2895
2896 cf::face::set_data $idx, 0, $data, $chk;
2897 } else {
2898 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2899 }
2900
2901 cf::face::set_type $idx, $info->{type};
2902
2903 cf::cede_to_tick;
2904 }
2905
2906 if ($soundconf) {
2907 $soundconf = $enc->decode (delete $soundconf->{data});
2908
2909 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2910 my $sound = $soundconf->{compat}[$_]
2911 or next;
2912
2913 my $face = cf::face::find "sound/$sound->[1]";
2914 cf::sound::set $sound->[0] => $face;
2915 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2916 }
2917
2918 while (my ($k, $v) = each %{$soundconf->{event}}) {
2919 my $face = cf::face::find "sound/$v";
2920 cf::sound::set $k => $face;
2921 }
2922 }
2923 }
2924
2386 1 2925 1
2387} 2926}
2388 2927
2928register_exticmd fx_want => sub {
2929 my ($ns, $want) = @_;
2930
2931 while (my ($k, $v) = each %$want) {
2932 $ns->fx_want ($k, $v);
2933 }
2934};
2935
2936sub reload_regions {
2937 load_resource_file "$MAPDIR/regions"
2938 or die "unable to load regions file\n";
2939
2940 for (cf::region::list) {
2941 $_->{match} = qr/$_->{match}/
2942 if exists $_->{match};
2943 }
2944}
2945
2946sub reload_facedata {
2947 load_facedata "$DATADIR/facedata"
2948 or die "unable to load facedata\n";
2949}
2950
2389sub load_archetypes { 2951sub reload_archetypes {
2390 load_archetype_file sprintf "%s/archetypes", cf::datadir; # remove when stable 2952 load_resource_file "$DATADIR/archetypes"
2391 load_archetype_file sprintf "%s/archetypes", cf::datadir 2953 or die "unable to load archetypes\n";
2954 #d# NEED to laod twice to resolve forward references
2955 # this really needs to be done in an extra post-pass
2956 # (which needs to be synchronous, so solve it differently)
2957 load_resource_file "$DATADIR/archetypes"
2958 or die "unable to load archetypes\n";
2392} 2959}
2393 2960
2394sub load_treasures { 2961sub reload_treasures {
2395 load_treasure_file sprintf "%s/treasures", cf::datadir 2962 load_resource_file "$DATADIR/treasures"
2963 or die "unable to load treasurelists\n";
2396} 2964}
2397 2965
2398sub reload_resources { 2966sub reload_resources {
2399 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2967 warn "reloading resource files...\n";
2400 or die "unable to load regions file\n"; 2968
2969 reload_regions;
2401 load_facedata 2970 reload_facedata;
2402 or die "unable to load facedata\n"; 2971 #reload_archetypes;#d#
2403 load_archetypes 2972 reload_archetypes;
2404 or die "unable to load archetypes\n";
2405 load_treasures 2973 reload_treasures;
2406 or die "unable to load treasurelists\n"; 2974
2975 warn "finished reloading resource files\n";
2407} 2976}
2408 2977
2409sub init { 2978sub init {
2410 reload_resources; 2979 reload_resources;
2411} 2980}
2412 2981
2413sub cfg_load { 2982sub cfg_load {
2414 open my $fh, "<:utf8", cf::confdir . "/config" 2983 open my $fh, "<:utf8", "$CONFDIR/config"
2415 or return; 2984 or return;
2416 2985
2417 local $/; 2986 local $/;
2418 *CFG = YAML::Syck::Load <$fh>; 2987 *CFG = YAML::Syck::Load <$fh>;
2419 2988
2464 }, 3033 },
2465 ); 3034 );
2466 } 3035 }
2467} 3036}
2468 3037
3038sub write_runtime {
3039 my $runtime = "$LOCALDIR/runtime";
3040
3041 # first touch the runtime file to show we are still running:
3042 # the fsync below can take a very very long time.
3043
3044 IO::AIO::aio_utime $runtime, undef, undef;
3045
3046 my $guard = cf::lock_acquire "write_runtime";
3047
3048 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3049 or return;
3050
3051 my $value = $cf::RUNTIME + 90 + 10;
3052 # 10 is the runtime save interval, for a monotonic clock
3053 # 60 allows for the watchdog to kill the server.
3054
3055 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3056 and return;
3057
3058 # always fsync - this file is important
3059 aio_fsync $fh
3060 and return;
3061
3062 # touch it again to show we are up-to-date
3063 aio_utime $fh, undef, undef;
3064
3065 close $fh
3066 or return;
3067
3068 aio_rename "$runtime~", $runtime
3069 and return;
3070
3071 warn "runtime file written.\n";
3072
3073 1
3074}
3075
2469sub emergency_save() { 3076sub emergency_save() {
2470 my $freeze_guard = cf::freeze_mainloop; 3077 my $freeze_guard = cf::freeze_mainloop;
2471 3078
2472 warn "enter emergency perl save\n"; 3079 warn "enter emergency perl save\n";
2473 3080
2504 3111
2505 warn Carp::longmess "post_cleanup backtrace" 3112 warn Carp::longmess "post_cleanup backtrace"
2506 if $make_core; 3113 if $make_core;
2507} 3114}
2508 3115
2509sub reload() { 3116sub do_reload_perl() {
2510 # can/must only be called in main 3117 # can/must only be called in main
2511 if ($Coro::current != $Coro::main) { 3118 if ($Coro::current != $Coro::main) {
2512 warn "can only reload from main coroutine"; 3119 warn "can only reload from main coroutine";
2513 return; 3120 return;
2514 } 3121 }
2548 %EXT_CORO = (); 3155 %EXT_CORO = ();
2549 3156
2550 warn "removing commands"; 3157 warn "removing commands";
2551 %COMMAND = (); 3158 %COMMAND = ();
2552 3159
2553 warn "removing ext commands"; 3160 warn "removing ext/exti commands";
2554 %EXTCMD = (); 3161 %EXTCMD = ();
3162 %EXTICMD = ();
2555 3163
2556 warn "unloading/nuking all extensions"; 3164 warn "unloading/nuking all extensions";
2557 for my $pkg (@EXTS) { 3165 for my $pkg (@EXTS) {
2558 warn "... unloading $pkg"; 3166 warn "... unloading $pkg";
2559 3167
2589 Symbol::delete_package "safe::$_" 3197 Symbol::delete_package "safe::$_"
2590 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3198 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2591 3199
2592 warn "unloading cf.pm \"a bit\""; 3200 warn "unloading cf.pm \"a bit\"";
2593 delete $INC{"cf.pm"}; 3201 delete $INC{"cf.pm"};
3202 delete $INC{"cf/pod.pm"};
2594 3203
2595 # don't, removes xs symbols, too, 3204 # don't, removes xs symbols, too,
2596 # and global variables created in xs 3205 # and global variables created in xs
2597 #Symbol::delete_package __PACKAGE__; 3206 #Symbol::delete_package __PACKAGE__;
2598 3207
2613 warn "reattaching attachments to maps"; 3222 warn "reattaching attachments to maps";
2614 reattach $_ for values %MAP; 3223 reattach $_ for values %MAP;
2615 warn "reattaching attachments to players"; 3224 warn "reattaching attachments to players";
2616 reattach $_ for values %PLAYER; 3225 reattach $_ for values %PLAYER;
2617 3226
2618 warn "loading reloadable resources";
2619 reload_resources;
2620
2621 warn "leaving sync_job"; 3227 warn "leaving sync_job";
2622 3228
2623 1 3229 1
2624 } or do { 3230 } or do {
2625 warn $@; 3231 warn $@;
2630 warn "reloaded"; 3236 warn "reloaded";
2631}; 3237};
2632 3238
2633our $RELOAD_WATCHER; # used only during reload 3239our $RELOAD_WATCHER; # used only during reload
2634 3240
3241sub reload_perl() {
3242 # doing reload synchronously and two reloads happen back-to-back,
3243 # coro crashes during coro_state_free->destroy here.
3244
3245 $RELOAD_WATCHER ||= Event->timer (
3246 reentrant => 0,
3247 after => 0,
3248 data => WF_AUTOCANCEL,
3249 cb => sub {
3250 do_reload_perl;
3251 undef $RELOAD_WATCHER;
3252 },
3253 );
3254}
3255
2635register_command "reload" => sub { 3256register_command "reload" => sub {
2636 my ($who, $arg) = @_; 3257 my ($who, $arg) = @_;
2637 3258
2638 if ($who->flag (FLAG_WIZ)) { 3259 if ($who->flag (FLAG_WIZ)) {
2639 $who->message ("reloading server."); 3260 $who->message ("reloading server.");
2640 3261 async { reload_perl };
2641 # doing reload synchronously and two reloads happen back-to-back,
2642 # coro crashes during coro_state_free->destroy here.
2643
2644 $RELOAD_WATCHER ||= Event->timer (
2645 reentrant => 0,
2646 after => 0,
2647 data => WF_AUTOCANCEL,
2648 cb => sub {
2649 reload;
2650 undef $RELOAD_WATCHER;
2651 },
2652 );
2653 } 3262 }
2654}; 3263};
2655 3264
2656unshift @INC, $LIBDIR; 3265unshift @INC, $LIBDIR;
2657 3266
2676 my $signal = new Coro::Signal; 3285 my $signal = new Coro::Signal;
2677 push @WAIT_FOR_TICK_BEGIN, $signal; 3286 push @WAIT_FOR_TICK_BEGIN, $signal;
2678 $signal->wait; 3287 $signal->wait;
2679} 3288}
2680 3289
3290 my $min = 1e6;#d#
3291 my $avg = 10;
2681$TICK_WATCHER = Event->timer ( 3292$TICK_WATCHER = Event->timer (
2682 reentrant => 0, 3293 reentrant => 0,
2683 parked => 1, 3294 parked => 1,
2684 prio => 0, 3295 prio => 0,
2685 at => $NEXT_TICK || $TICK, 3296 at => $NEXT_TICK || $TICK,
2689 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3300 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2690 unless ++$bug_warning > 10; 3301 unless ++$bug_warning > 10;
2691 return; 3302 return;
2692 } 3303 }
2693 3304
2694 $NOW = Event::time; 3305 $NOW = $tick_start = Event::time;
2695 3306
2696 cf::server_tick; # one server iteration 3307 cf::server_tick; # one server iteration
3308
3309 0 && sync_job {#d#
3310 for(1..10) {
3311 my $t = Event::time;
3312 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3313 or die;
3314
3315 $map->width (50);
3316 $map->height (50);
3317 $map->alloc;
3318 $map->_load_objects ("/tmp/x.map", 1);
3319 my $t = Event::time - $t;
3320
3321 #next unless $t < 0.0013;#d#
3322 if ($t < $min) {
3323 $min = $t;
3324 }
3325 $avg = $avg * 0.99 + $t * 0.01;
3326 }
3327 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3328 exit 0;
3329 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3330 };
3331
2697 $RUNTIME += $TICK; 3332 $RUNTIME += $TICK;
2698 $NEXT_TICK += $TICK; 3333 $NEXT_TICK += $TICK;
2699 3334
2700 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3335 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2701 $NEXT_RUNTIME_WRITE = $NOW + 10; 3336 $NEXT_RUNTIME_WRITE = $NOW + 10;
2703 write_runtime 3338 write_runtime
2704 or warn "ERROR: unable to write runtime file: $!"; 3339 or warn "ERROR: unable to write runtime file: $!";
2705 }; 3340 };
2706 } 3341 }
2707 3342
3343# my $AFTER = Event::time;
3344# warn $AFTER - $NOW;#d#
3345
2708 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3346 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2709 $sig->send; 3347 $sig->send;
2710 } 3348 }
2711 while (my $sig = shift @WAIT_FOR_TICK) { 3349 while (my $sig = shift @WAIT_FOR_TICK) {
2712 $sig->send; 3350 $sig->send;
2713 } 3351 }
2714 3352
2715# my $AFTER = Event::time; 3353 $NOW = Event::time;
2716# warn $AFTER - $NOW;#d#
2717 3354
2718 # if we are delayed by four ticks or more, skip them all 3355 # if we are delayed by four ticks or more, skip them all
2719 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3356 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2720 3357
2721 $TICK_WATCHER->at ($NEXT_TICK); 3358 $TICK_WATCHER->at ($NEXT_TICK);
2722 $TICK_WATCHER->start; 3359 $TICK_WATCHER->start;
3360
3361 $LOAD = ($NOW - $tick_start) / $TICK;
3362 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3363
3364 _post_tick;
3365
3366
2723 }, 3367 },
2724); 3368);
2725 3369
2726{ 3370{
2727 BDB::max_poll_time $TICK * 0.1; 3371 BDB::max_poll_time $TICK * 0.1;
2755 3399
2756 cf::sync_job { 3400 cf::sync_job {
2757 eval { 3401 eval {
2758 BDB::db_env_open 3402 BDB::db_env_open
2759 $DB_ENV, 3403 $DB_ENV,
2760 $BDB_ENV_DIR, 3404 $BDBDIR,
2761 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3405 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2762 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3406 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2763 0666; 3407 0666;
2764 3408
2765 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3409 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2766 3410
2767 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3411 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2768 $DB_ENV->set_lk_detect; 3412 $DB_ENV->set_lk_detect;
2769 }; 3413 };
2770 3414
2786 prio => 6, 3430 prio => 6,
2787 cb => \&IO::AIO::poll_cb, 3431 cb => \&IO::AIO::poll_cb,
2788 ); 3432 );
2789} 3433}
2790 3434
3435my $_log_backtrace;
3436
3437sub _log_backtrace {
3438 my ($msg, @addr) = @_;
3439
3440 $msg =~ s/\n//;
3441
3442 # limit the # of concurrent backtraces
3443 if ($_log_backtrace < 2) {
3444 ++$_log_backtrace;
3445 async {
3446 my @bt = fork_call {
3447 @addr = map { sprintf "%x", $_ } @addr;
3448 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3449 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3450 or die "addr2line: $!";
3451
3452 my @funcs;
3453 my @res = <$fh>;
3454 chomp for @res;
3455 while (@res) {
3456 my ($func, $line) = splice @res, 0, 2, ();
3457 push @funcs, "[$func] $line";
3458 }
3459
3460 @funcs
3461 };
3462
3463 LOG llevInfo, "[ABT] $msg\n";
3464 LOG llevInfo, "[ABT] $_\n" for @bt;
3465 --$_log_backtrace;
3466 };
3467 } else {
3468 LOG llevInfo, "[ABT] $msg\n";
3469 LOG llevInfo, "[ABT] [suppressed]\n";
3470 }
3471}
3472
3473# load additional modules
3474use cf::pod;
3475
2791END { cf::emergency_save } 3476END { cf::emergency_save }
2792 3477
27931 34781
2794 3479

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines