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.234 by root, Thu Apr 5 13:44:31 2007 UTC vs.
Revision 1.328 by root, Wed Aug 8 06:24:30 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.52 (); 15use Coro 3.61 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
21 24
25use JSON::XS 1.4 ();
22use BDB (); 26use BDB ();
23use Data::Dumper; 27use Data::Dumper;
24use Digest::MD5; 28use Digest::MD5;
25use Fcntl; 29use Fcntl;
26use YAML::Syck (); 30use YAML::Syck ();
27use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
28use Time::HiRes; 32use Time::HiRes;
29use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
30 35
31# configure various modules to our taste 36# configure various modules to our taste
32# 37#
38$Storable::canonical = 1; # reduce rsync transfers
33Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
34Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35 41
36$Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
37 43
45our %COMMAND = (); 51our %COMMAND = ();
46our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
47 53
48our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
49our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
50our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
52 59
53our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
54our @EVENT; 61our @EVENT;
55our $LIBDIR = datadir . "/ext";
56 62
57our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
58our $TICK_WATCHER; 76our $TICK_WATCHER;
59our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 79our $NEXT_TICK;
62our $NOW; 80our $NOW;
71our $RUNTIME; 89our $RUNTIME;
72 90
73our %PLAYER; # all users 91our %PLAYER; # all users
74our %MAP; # all maps 92our %MAP; # all maps
75our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 94
82# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
85binmode STDOUT; 102binmode STDOUT;
86binmode STDERR; 103binmode STDERR;
87 104
88# read virtual server time, if available 105# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
91 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
92 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
93} 110}
94 111
95mkdir cf::localdir; 112mkdir $_
96mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97mkdir cf::localdir . "/" . cf::tmpdir;
98mkdir cf::localdir . "/" . cf::uniquedir;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 114
102our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
103 116
104sub cf::map::normalise; 117sub cf::map::normalise;
105 118
116=item $cf::RUNTIME 129=item $cf::RUNTIME
117 130
118The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
119every server tick. 132every server tick.
120 133
121=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
122 137
123The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
124be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
125 142
126=item $cf::NOW 143=item $cf::NOW
127 144
128The time of the last (current) server tick. 145The time of the last (current) server tick.
129 146
130=item $cf::TICK 147=item $cf::TICK
131 148
132The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
133 160
134=item %cf::CFG 161=item %cf::CFG
135 162
136Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
137from wherever your confdir points to. 164from wherever your confdir points to.
138 165
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
140 167
141These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
142or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
143processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
144window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
145 177
146=back 178=back
147 179
148=cut 180=cut
149 181
150BEGIN { 182BEGIN {
151 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
152 my $msg = join "", @_; 184 my $msg = join "", @_;
153 utf8::encode $msg;
154 185
155 $msg .= "\n" 186 $msg .= "\n"
156 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
157 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
158 LOG llevError, $msg; 192 LOG llevError, $msg;
159 }; 193 };
160} 194}
161 195
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
167@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
168 203
169# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
170# within the Safe compartment. 205# within the Safe compartment.
171for my $pkg (qw( 206for my $pkg (qw(
172 cf::global cf::attachable 207 cf::global cf::attachable
180} 215}
181 216
182$Event::DIED = sub { 217$Event::DIED = sub {
183 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
184}; 219};
220
221#############################################################################
185 222
186=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
187 224
188=over 4 225=over 4
189 226
208 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
209 $d 246 $d
210 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
211} 248}
212 249
213use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
216 251
217Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
218 253
219=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
220 255
221Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
222 264
223=item cf::lock_wait $string 265=item cf::lock_wait $string
224 266
225Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
226 268
232returned. 274returned.
233 275
234Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
235uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
236 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
237=cut 283=cut
238 284
239our %LOCK; 285our %LOCK;
240 286
241sub lock_wait($) { 287sub lock_wait($) {
258 304
259 Coro::guard { 305 Coro::guard {
260 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
262 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
263} 315}
264 316
265sub freeze_mainloop { 317sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
267 319
270 }; 322 };
271 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
272 $guard 324 $guard
273} 325}
274 326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
275=item cf::async { BLOCK } 383=item cf::async { BLOCK }
276 384
277Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
278C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
279thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
282 390
283BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
284 392
285=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
286 394
287The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
290 399
291If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
294fast or be very important. 403fast or be very important.
297 406
298sub sync_job(&) { 407sub sync_job(&) {
299 my ($job) = @_; 408 my ($job) = @_;
300 409
301 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
302 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
304 415
305 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 417 # (but this is cancel-safe)
317 428
318 while ($busy) { 429 while ($busy) {
319 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
320 } 431 }
321 432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
322 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
323 } else { 441 } else {
324 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
325 443
326 $job->() 444 $job->()
345 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
346 464
347 $coro 465 $coro
348} 466}
349 467
350sub write_runtime { 468=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 469
353 my $runtime = cf::localdir . "/runtime"; 470Executes the given code block with the given arguments in a seperate
471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
354 474
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
356 or return;
357 476
358 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
359 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
360 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
361 480 Storable::store_fd $_[0], $fh;
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0
363 and return;
364
365 # always fsync - this file is important
366 aio_fsync $fh
367 and return;
368
369 close $fh 481 close $fh;
370 or return;
371 482
372 aio_rename "$runtime~", $runtime 483 $buf
373 and return; 484}
374 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
375 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
376} 644}
377 645
378=item cf::datalog type => key => value, ... 646=item cf::datalog type => key => value, ...
379 647
380Log 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.
398attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
400 668
401In 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>
402C<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
403crossfire+). 671Crossfire TRT).
404 672
405=over 4 673=over 4
406 674
407=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
408 676
571 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
572 840
573 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
574 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
575 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
576 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
577 845
578 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
579 my $pkg = shift @arg; 847 my $pkg = shift @arg;
580 848
581 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
610 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
611 } 879 }
612 880
613 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
614 } else { 882 } else {
615 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
616 } 884 }
617 885
618 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
619} 887}
620 888
622 if (ref $_[0]) { 890 if (ref $_[0]) {
623 _object_attach @_; 891 _object_attach @_;
624 } else { 892 } else {
625 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
626 } 894 }
895 _recalc_want;
627}; 896};
628 897
629# all those should be optimised 898# all those should be optimised
630sub cf::attachable::detach { 899sub cf::attachable::detach {
631 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
634 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
635 reattach ($obj); 904 reattach ($obj);
636 } else { 905 } else {
637 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
638 } 907 }
908 _recalc_want;
639}; 909};
640 910
641sub cf::attachable::attached { 911sub cf::attachable::attached {
642 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
643 913
658 "; 928 ";
659 die if $@; 929 die if $@;
660} 930}
661 931
662our $override; 932our $override;
663our @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?
664 934
665sub override { 935sub override {
666 $override = 1; 936 $override = 1;
667 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
668} 938}
669 939
670sub do_invoke { 940sub do_invoke {
671 my $event = shift; 941 my $event = shift;
672 my $callbacks = shift; 942 my $callbacks = shift;
673 943
674 @invoke_results = (); 944 @INVOKE_RESULTS = ();
675 945
676 local $override; 946 local $override;
677 947
678 for (@$callbacks) { 948 for (@$callbacks) {
679 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
696 966
697Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
698 968
699This 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
700removed 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
701results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
702 972
703=back 973=back
704 974
705=cut 975=cut
706 976
707############################################################################# 977#############################################################################
708# 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}
709 990
710sub reattach { 991sub reattach {
711 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
712 my ($obj) = @_; 993 my ($obj) = @_;
713 994
816 or return; 1097 or return;
817 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
818 } 1099 }
819 1100
820 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
821 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
822 return ($data, $av); 1103 return ($data, $av);
823} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
824 1111
825############################################################################# 1112#############################################################################
826# command handling &c 1113# command handling &c
827 1114
828=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
841 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
842} 1129}
843 1130
844=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
845 1132
846Register 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.
847 1138
848If 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
849called. 1140called.
850 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
851=cut 1153=cut
852 1154
853sub register_extcmd { 1155sub register_extcmd {
854 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
855 1157
856 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
857} 1165}
858 1166
859cf::player->attach ( 1167cf::player->attach (
860 on_command => sub { 1168 on_command => sub {
861 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
870 cf::override; 1178 cf::override;
871 }, 1179 },
872 on_extcmd => sub { 1180 on_extcmd => sub {
873 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
874 1182
875 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
876 1184
877 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
878 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
879 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
880 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
881 } 1195 if $reply;
882 } 1196 }
883 } else { 1197 } else {
884 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
885 } 1199 }
886 1200
887 cf::override; 1201 cf::override;
888 }, 1202 },
889); 1203);
890 1204
891sub load_extension {
892 my ($path) = @_;
893
894 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
895 my $base = $1;
896 my $pkg = $1;
897 $pkg =~ s/[^[:word:]]/_/g;
898 $pkg = "ext::$pkg";
899
900 warn "... loading '$path' into '$pkg'\n";
901
902 open my $fh, "<:utf8", $path
903 or die "$path: $!";
904
905 my $source =
906 "package $pkg; use strict; use utf8;\n"
907 . "#line 1 \"$path\"\n{\n"
908 . (do { local $/; <$fh> })
909 . "\n};\n1";
910
911 unless (eval $source) {
912 my $msg = $@ ? "$path: $@\n"
913 : "extension disabled.\n";
914 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
915 warn $@;
916 warn "mandatory extension failed to load, exiting.\n";
917 exit 1;
918 }
919 die $@;
920 }
921
922 push @EXTS, $pkg;
923}
924
925sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
926 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
927 next unless -r $ext; 1210 next unless -r $path;
928 eval { 1211
929 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;
930 1 1269 }
931 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
932 } 1275 };
933} 1276}
934 1277
935############################################################################# 1278#############################################################################
936 1279
1280=back
1281
937=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
938 1283
939Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
940 1285
941=cut 1286=cut
953Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
954 1299
955=cut 1300=cut
956 1301
957sub playerdir($) { 1302sub playerdir($) {
958 cf::localdir 1303 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1305}
964 1306
965sub path($) { 1307sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1086while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1087 1429
1088=cut 1430=cut
1089 1431
1090sub list_logins { 1432sub list_logins {
1091 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1092 or return []; 1434 or return [];
1093 1435
1094 my @logins; 1436 my @logins;
1095 1437
1096 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1131 } 1473 }
1132 1474
1133 \@paths 1475 \@paths
1134} 1476}
1135 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
1136=item $player->ext_reply ($msgid, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1137 1529
1138Sends an ext reply to the player. 1530Sends an ext reply to the player.
1139 1531
1140=cut 1532=cut
1141 1533
1142sub ext_reply($$%) { 1534sub ext_reply($$@) {
1143 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1144 1536
1145 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1146 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1147 $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 }
1148} 1544}
1149 1545
1150=item $player->ext_event ($type, %msg) 1546=item $player->ext_msg ($type, @msg)
1151 1547
1152Sends an ext event to the client. 1548Sends an ext event to the client.
1153 1549
1154=cut 1550=cut
1155 1551
1156sub ext_event($$%) { 1552sub ext_msg($$@) {
1157 my ($self, $type, %msg) = @_; 1553 my ($self, $type, @msg) = @_;
1158 1554
1159 $self->ns->ext_event ($type, %msg); 1555 $self->ns->ext_msg ($type, @msg);
1160} 1556}
1161 1557
1162package 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}
1163 1586
1164=back 1587=back
1165
1166 1588
1167=head3 cf::map 1589=head3 cf::map
1168 1590
1169=over 4 1591=over 4
1170 1592
1225 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1226 1648
1227 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1228 local $self->{path}; 1650 local $self->{path};
1229 local $self->{load_path}; 1651 local $self->{load_path};
1230 local $self->{deny_save};
1231 local $self->{deny_reset};
1232 1652
1233 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1234} 1654}
1235 1655
1236sub normalise { 1656sub normalise {
1283 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1284 return $self; 1704 return $self;
1285 } 1705 }
1286 } 1706 }
1287 1707
1288 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1289 () 1709 ()
1290} 1710}
1291 1711
1292sub init { 1712sub init {
1293 my ($self) = @_; 1713 my ($self) = @_;
1308 1728
1309# the original (read-only) location 1729# the original (read-only) location
1310sub load_path { 1730sub load_path {
1311 my ($self) = @_; 1731 my ($self) = @_;
1312 1732
1313 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1314} 1734}
1315 1735
1316# the temporary/swap location 1736# the temporary/swap location
1317sub save_path { 1737sub save_path {
1318 my ($self) = @_; 1738 my ($self) = @_;
1319 1739
1320 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1321 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1322} 1742}
1323 1743
1324# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1325sub uniq_path { 1745sub uniq_path {
1326 my ($self) = @_; 1746 my ($self) = @_;
1327 1747
1328 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1329 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1330} 1750}
1331 1751
1332# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1333# all maps in C++... 1753# all maps in C++...
1334sub change_all_map_light { 1754sub change_all_map_light {
1335 my ($change) = @_; 1755 my ($change) = @_;
1336 1756
1337 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1338 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;
1339} 1767}
1340 1768
1341sub unlink_save { 1769sub unlink_save {
1342 my ($self) = @_; 1770 my ($self) = @_;
1343 1771
1401 $self->load_header_orig 1829 $self->load_header_orig
1402 or return; 1830 or return;
1403 $self->prepare_orig; 1831 $self->prepare_orig;
1404 } 1832 }
1405 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
1406 1 1840 1
1407} 1841}
1408 1842
1409sub find; 1843sub find;
1410sub find { 1844sub find {
1422 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1423 1857
1424 $map->load_header 1858 $map->load_header
1425 or return; 1859 or return;
1426 1860
1427 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1428 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1429 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1430 $map->reset; 1864 $map->reset;
1431 undef $guard; 1865 undef $guard;
1432 return find $path; 1866 return find $path;
1443 my ($self) = @_; 1877 my ($self) = @_;
1444 1878
1445 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1446 1880
1447 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1448 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1449 1885
1450 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1451 1887
1452 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1453 1889
1454 $self->alloc; 1890 $self->alloc;
1455 1891
1456 $self->pre_load; 1892 $self->pre_load;
1457
1458 $self->_load_objects ($self->{load_path}, 1)
1459 or return;
1460
1461 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1462 if delete $self->{load_original};
1463
1464 if (my $uniq = $self->uniq_path) {
1465 utf8::encode $uniq;
1466 if (aio_open $uniq, O_RDONLY, 0) {
1467 $self->clear_unique_items;
1468 $self->_load_objects ($uniq, 0);
1469 }
1470 }
1471
1472 Coro::cede;
1473
1474 # now do the right thing for maps
1475 $self->link_multipart_objects;
1476
1477 unless ($self->{deny_activate}) {
1478 $self->decay_objects;
1479 $self->fix_auto_apply;
1480 $self->update_buttons;
1481 Coro::cede; 1893 Coro::cede;
1482 $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;
1483 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1484 unless $self->difficulty; 1913 unless $self->difficulty;
1485 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;
1486 $self->activate; 1923 $self->activate;
1924 }
1925
1926 $self->{last_save} = $cf::RUNTIME;
1927 $self->last_access ($cf::RUNTIME);
1928
1929 $self->in_memory (cf::MAP_IN_MEMORY);
1487 } 1930 }
1488 1931
1489 $self->post_load; 1932 $self->post_load;
1490
1491 $self->in_memory (cf::MAP_IN_MEMORY);
1492} 1933}
1493 1934
1494sub customise_for { 1935sub customise_for {
1495 my ($self, $ob) = @_; 1936 my ($self, $ob) = @_;
1496 1937
1497 return find "~" . $ob->name . "/" . $self->{path} 1938 return find "~" . $ob->name . "/" . $self->{path}
1498 if $self->per_player; 1939 if $self->per_player;
1940
1941# return find "?party/" . $ob->name . "/" . $self->{path}
1942# if $self->per_party;
1499 1943
1500 $self 1944 $self
1501} 1945}
1502 1946
1503# 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
1550 1994
1551 undef $MAP_PREFETCH{$path}; 1995 undef $MAP_PREFETCH{$path};
1552 $MAP_PREFETCHER ||= cf::async { 1996 $MAP_PREFETCHER ||= cf::async {
1553 while (%MAP_PREFETCH) { 1997 while (%MAP_PREFETCH) {
1554 for my $path (keys %MAP_PREFETCH) { 1998 for my $path (keys %MAP_PREFETCH) {
1555 my $map = find $path 1999 if (my $map = find $path) {
1556 or next;
1557 $map->load; 2000 $map->load;
2001 }
1558 2002
1559 delete $MAP_PREFETCH{$path}; 2003 delete $MAP_PREFETCH{$path};
1560 } 2004 }
1561 } 2005 }
1562 undef $MAP_PREFETCHER; 2006 undef $MAP_PREFETCHER;
1614 2058
1615sub reset_at { 2059sub reset_at {
1616 my ($self) = @_; 2060 my ($self) = @_;
1617 2061
1618 # TODO: safety, remove and allow resettable per-player maps 2062 # TODO: safety, remove and allow resettable per-player maps
1619 return 1e99 if $self->isa ("ext::map_per_player");#d#
1620 return 1e99 if $self->{deny_reset}; 2063 return 1e99 if $self->{deny_reset};
1621 2064
1622 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2065 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1623 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;
1624 2067
1635 my ($self) = @_; 2078 my ($self) = @_;
1636 2079
1637 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2080 my $lock = cf::lock_acquire "map_data:$self->{path}";
1638 2081
1639 return if $self->players; 2082 return if $self->players;
1640 return if $self->isa ("ext::map_per_player");#d#
1641 2083
1642 warn "resetting map ", $self->path;#d# 2084 warn "resetting map ", $self->path;
1643 2085
1644 $self->in_memory (cf::MAP_SWAPPED); 2086 $self->in_memory (cf::MAP_SWAPPED);
1645 2087
1646 # need to save uniques path 2088 # need to save uniques path
1647 unless ($self->{deny_save}) { 2089 unless ($self->{deny_save}) {
1679 $cf::MAP{$self->path} = $self; 2121 $cf::MAP{$self->path} = $self;
1680 2122
1681 $self->reset; # polite request, might not happen 2123 $self->reset; # polite request, might not happen
1682} 2124}
1683 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
1684=item cf::map::unique_maps 2162=item cf::map::unique_maps
1685 2163
1686Returns an arrayref of paths of all shared maps that have 2164Returns an arrayref of paths of all shared maps that have
1687instantiated unique items. May block. 2165instantiated unique items. May block.
1688 2166
1689=cut 2167=cut
1690 2168
1691sub unique_maps() { 2169sub unique_maps() {
1692 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2170 [
1693 or return; 2171 map {
1694
1695 my @paths;
1696
1697 for (@$files) {
1698 utf8::decode $_; 2172 utf8::decode $_;
1699 next if /\.pst$/; 2173 /\.map$/
1700 next unless /^$PATH_SEP/o; 2174 ? normalise $_
1701 2175 : ()
1702 push @paths, cf::map::normalise $_; 2176 } @{ aio_readdir $UNIQUEDIR or [] }
1703 } 2177 ]
1704
1705 \@paths
1706} 2178}
1707 2179
1708package cf; 2180package cf;
1709 2181
1710=back 2182=back
1756 2228
1757 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2229 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1758 2230
1759 if ($self->{record_replies}) { 2231 if ($self->{record_replies}) {
1760 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2232 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2233
1761 } 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 {
1762 $msg = $npc->name . " says: $msg" if $npc; 2242 $msg = $npc->name . " says: $msg" if $npc;
1763 $self->message ($msg, $flags); 2243 $self->message ($msg, $flags);
2244 }
1764 } 2245 }
1765} 2246}
1766 2247
1767=item $player_object->may ("access") 2248=item $player_object->may ("access")
1768 2249
1816 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1817 2298
1818 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1819 2300
1820 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1821 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1822 2303
1823 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1824} 2305}
1825 2306
1826sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1827 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1828 2311
1829 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1830 2313
1831 unless ($map) { 2314 unless ($map) {
1832 # restore original map position 2315 # restore original map position
1855 2338
1856 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1857 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1858} 2341}
1859 2342
1860cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1861 on_logout => sub {
1862 my ($pl) = @_;
1863 2344
1864 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1865 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1866 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1867 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1868 }; 2349be called at the end of this process.
1869 }
1870 },
1871 on_login => sub {
1872 my ($pl) = @_;
1873 2350
1874 # try to abort aborted map switching on player login :)
1875 # should happen only on crashes
1876 if ($pl->ob->{_link_pos}) {
1877 $pl->ob->enter_link;
1878 (async {
1879 $pl->ob->reply (undef,
1880 "There was an internal problem at your last logout, "
1881 . "the server will try to bring you to your intended destination in a second.",
1882 cf::NDI_RED);
1883 # we need this sleep as the login has a concurrent enter_exit running
1884 # and this sleep increases chances of the player not ending up in scorn
1885 Coro::Timer::sleep 1;
1886 $pl->ob->leave_link;
1887 })->prio (2);
1888 }
1889 },
1890);
1891
1892=item $player_object->goto ($path, $x, $y)
1893
1894=cut 2351=cut
2352
2353our $GOTOGEN;
1895 2354
1896sub cf::object::player::goto { 2355sub cf::object::player::goto {
1897 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;
1898 2360
1899 $self->enter_link; 2361 $self->enter_link;
1900 2362
1901 (async { 2363 (async {
1902 my $map = eval { 2364 my $map = eval {
1903 my $map = cf::map::find $path; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1904 $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
1905 $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 $@;
1906 } or 2380 }
1907 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1908 2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1909 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1910 })->prio (1); 2388 })->prio (1);
1911} 2389}
1912 2390
1913=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1914 2392
1953 2431
1954 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1955 2433
1956 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1957 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
1958 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2436 my $meta = "$RANDOMDIR/$md5.meta";
1959 2437
1960 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1961 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
1962 undef $fh; 2440 undef $fh;
1963 aio_rename "$meta~", $meta; 2441 aio_rename "$meta~", $meta;
1982 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;
1983 my $hp = $exit->stats->hp; 2461 my $hp = $exit->stats->hp;
1984 my $sp = $exit->stats->sp; 2462 my $sp = $exit->stats->sp;
1985 2463
1986 $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);
1987 2469
1988 (async { 2470 (async {
1989 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
1990 unless (eval { 2472 unless (eval {
1991 $self->goto ($slaying, $hp, $sp); 2473 $self->goto ($slaying, $hp, $sp);
2019 2501
2020 utf8::encode $text; 2502 utf8::encode $text;
2021 $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);
2022} 2504}
2023 2505
2506=item $client->send_msg ($channel, $msg, $color, [extra...])
2507
2508Send a drawinfo or msg packet to the client, formatting the msg for the
2509client if neccessary. C<$type> should be a string identifying the type of
2510the message, with C<log> being the default. If C<$color> is negative, suppress
2511the message unless the client supports the msg packet.
2512
2513=cut
2514
2515sub cf::client::send_msg {
2516 my ($self, $channel, $msg, $color, @extra) = @_;
2517
2518 $msg = $self->pl->expand_cfpod ($msg);
2519
2520 $color &= cf::NDI_CLIENT_MASK; # just in case...
2521
2522 if (ref $channel) {
2523 # send meta info to client, if not yet sent
2524 unless (exists $self->{channel}{$channel->{id}}) {
2525 $self->{channel}{$channel->{id}} = $channel;
2526 $self->ext_msg (channel_info => $channel);
2527 }
2528
2529 $channel = $channel->{id};
2530 }
2531
2532 return unless @extra || length $msg;
2533
2534 if ($self->can_msg) {
2535 # default colour, mask it out
2536 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2537 if $color & cf::NDI_DEF;
2538
2539 $self->send_packet ("msg " . $self->{json_coder}->encode (
2540 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2541 } else {
2542 if ($color >= 0) {
2543 # replace some tags by gcfclient-compatible ones
2544 for ($msg) {
2545 1 while
2546 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2547 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2548 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2549 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2550 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2551 }
2552
2553 $color &= cf::NDI_COLOR_MASK;
2554
2555 utf8::encode $msg;
2556
2557 if (0 && $msg =~ /\[/) {
2558 $self->send_packet ("drawextinfo $color 4 0 $msg")
2559 } else {
2560 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2561 $self->send_packet ("drawinfo $color $msg")
2562 }
2563 }
2564 }
2565}
2566
2024=item $client->ext_event ($type, %msg) 2567=item $client->ext_msg ($type, @msg)
2025 2568
2026Sends an exti event to the client. 2569Sends an ext event to the client.
2027 2570
2028=cut 2571=cut
2029 2572
2030sub cf::client::ext_event($$%) { 2573sub cf::client::ext_msg($$@) {
2031 my ($self, $type, %msg) = @_; 2574 my ($self, $type, @msg) = @_;
2032 2575
2576 my $extcmd = $self->extcmd;
2577
2578 if ($extcmd == 2) {
2579 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2580 } elsif ($extcmd == 1) { # TODO: remove
2033 $msg{msgtype} = "event_$type"; 2581 push @msg, msgtype => "event_$type";
2034 $self->send_packet ("ext " . cf::to_json \%msg); 2582 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2583 }
2035} 2584}
2036 2585
2037=item $success = $client->query ($flags, "text", \&cb) 2586=item $success = $client->query ($flags, "text", \&cb)
2038 2587
2039Queues a query to the client, calling the given callback with 2588Queues a query to the client, calling the given callback with
2040the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2589the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2041C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2590C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2042 2591
2043Queries can fail, so check the return code. Or don't, as queries will become 2592Queries can fail, so check the return code. Or don't, as queries will
2044reliable at some point in the future. 2593become reliable at some point in the future.
2045 2594
2046=cut 2595=cut
2047 2596
2048sub cf::client::query { 2597sub cf::client::query {
2049 my ($self, $flags, $text, $cb) = @_; 2598 my ($self, $flags, $text, $cb) = @_;
2057 utf8::encode $text; 2606 utf8::encode $text;
2058 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2607 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2059 2608
2060 $self->send_packet ($self->{query_queue}[0][0]) 2609 $self->send_packet ($self->{query_queue}[0][0])
2061 if @{ $self->{query_queue} } == 1; 2610 if @{ $self->{query_queue} } == 1;
2611
2612 1
2062} 2613}
2063 2614
2064cf::client->attach ( 2615cf::client->attach (
2616 on_connect => sub {
2617 my ($ns) = @_;
2618
2619 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2620 },
2065 on_reply => sub { 2621 on_reply => sub {
2066 my ($ns, $msg) = @_; 2622 my ($ns, $msg) = @_;
2067 2623
2068 # this weird shuffling is so that direct followup queries 2624 # this weird shuffling is so that direct followup queries
2069 # get handled first 2625 # get handled first
2081 } else { 2637 } else {
2082 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2638 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2083 } 2639 }
2084 } 2640 }
2085 }, 2641 },
2642 on_exticmd => sub {
2643 my ($ns, $buf) = @_;
2644
2645 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2646
2647 if (ref $msg) {
2648 my ($type, $reply, @payload) =
2649 "ARRAY" eq ref $msg
2650 ? @$msg
2651 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2652
2653 if (my $cb = $EXTICMD{$type}) {
2654 my @reply = $cb->($ns, @payload);
2655
2656 $ns->ext_reply ($reply, @reply)
2657 if $reply;
2658 }
2659 } else {
2660 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2661 }
2662
2663 cf::override;
2664 },
2086); 2665);
2087 2666
2088=item $client->async (\&cb) 2667=item $client->async (\&cb)
2089 2668
2090Create a new coroutine, running the specified callback. The coroutine will 2669Create a new coroutine, running the specified callback. The coroutine will
2131our $safe = new Safe "safe"; 2710our $safe = new Safe "safe";
2132our $safe_hole = new Safe::Hole; 2711our $safe_hole = new Safe::Hole;
2133 2712
2134$SIG{FPE} = 'IGNORE'; 2713$SIG{FPE} = 'IGNORE';
2135 2714
2136$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2715$safe->permit_only (Opcode::opset qw(
2716 :base_core :base_mem :base_orig :base_math
2717 grepstart grepwhile mapstart mapwhile
2718 sort time
2719));
2137 2720
2138# here we export the classes and methods available to script code 2721# here we export the classes and methods available to script code
2139 2722
2140=pod 2723=pod
2141 2724
2142The following functions and methods are available within a safe environment: 2725The following functions and methods are available within a safe environment:
2143 2726
2144 cf::object contr pay_amount pay_player map 2727 cf::object
2728 contr pay_amount pay_player map x y force_find force_add
2729 insert remove
2730
2145 cf::object::player player 2731 cf::object::player
2146 cf::player peaceful 2732 player
2147 cf::map trigger 2733
2734 cf::player
2735 peaceful
2736
2737 cf::map
2738 trigger
2148 2739
2149=cut 2740=cut
2150 2741
2151for ( 2742for (
2152 ["cf::object" => qw(contr pay_amount pay_player map)], 2743 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2744 insert remove inv)],
2153 ["cf::object::player" => qw(player)], 2745 ["cf::object::player" => qw(player)],
2154 ["cf::player" => qw(peaceful)], 2746 ["cf::player" => qw(peaceful)],
2155 ["cf::map" => qw(trigger)], 2747 ["cf::map" => qw(trigger)],
2156) { 2748) {
2157 no strict 'refs'; 2749 no strict 'refs';
2228=back 2820=back
2229 2821
2230=cut 2822=cut
2231 2823
2232############################################################################# 2824#############################################################################
2233
2234=head2 EXTENSION DATABASE SUPPORT
2235
2236Crossfire maintains a very simple database for extension use. It can
2237currently store anything that can be serialised using Storable, which
2238excludes objects.
2239
2240The parameter C<$family> should best start with the name of the extension
2241using it, it should be unique.
2242
2243=over 4
2244
2245=item $value = cf::db_get $family => $key
2246
2247Returns a single value from the database.
2248
2249=item cf::db_put $family => $key => $value
2250
2251Stores the given C<$value> in the family.
2252
2253=cut
2254
2255our $DB;
2256
2257sub db_init {
2258 unless ($DB) {
2259 $DB = BDB::db_create $DB_ENV;
2260
2261 cf::sync_job {
2262 eval {
2263 $DB->set_flags (BDB::CHKSUM);
2264
2265 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2266 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2267 cf::cleanup "db_open(db): $!" if $!;
2268 };
2269 cf::cleanup "db_open(db): $@" if $@;
2270 };
2271
2272 my $path = cf::localdir . "/database.pst";
2273 if (stat $path) {
2274 cf::sync_job {
2275 my $pst = Storable::retrieve $path;
2276
2277 cf::db_put (board => data => $pst->{board});
2278 cf::db_put (guildrules => data => $pst->{guildrules});
2279 cf::db_put (rent => balance => $pst->{rent}{balance});
2280 BDB::db_env_txn_checkpoint $DB_ENV;
2281
2282 unlink $path;
2283 };
2284 }
2285 }
2286}
2287
2288sub db_get($$) {
2289 my $key = "$_[0]/$_[1]";
2290
2291 cf::sync_job {
2292 BDB::db_get $DB, undef, $key, my $data;
2293
2294 $! ? ()
2295 : Compress::LZF::sthaw $data
2296 }
2297}
2298
2299sub db_put($$$) {
2300 BDB::dbreq_pri 4;
2301 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2302}
2303
2304#############################################################################
2305# the server's init and main functions 2825# the server's init and main functions
2306 2826
2307sub load_facedata { 2827sub load_facedata($) {
2308 my $path = sprintf "%s/facedata", cf::datadir; 2828 my ($path) = @_;
2309 2829
2310 warn "loading facedata from $path\n"; 2830 warn "loading facedata from $path\n";
2311 2831
2312 my $faces; 2832 my $facedata;
2313 0 < aio_load $path, $faces 2833 0 < aio_load $path, $facedata
2314 or die "$path: $!"; 2834 or die "$path: $!";
2315 2835
2316 Coro::cede;
2317 $faces = Storable::thaw $faces; 2836 $facedata = Coro::Storable::thaw $facedata;
2318 Coro::cede;
2319 2837
2320 my $meta = delete $faces->{""};
2321 $meta->{version} == 1 2838 $facedata->{version} == 2
2322 or cf::cleanup "$path: version mismatch, cannot proceed."; 2839 or cf::cleanup "$path: version mismatch, cannot proceed.";
2323 2840
2841 {
2842 my $faces = $facedata->{faceinfo};
2843
2324 while (my ($face, $info) = each %$faces) { 2844 while (my ($face, $info) = each %$faces) {
2325 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2845 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2326 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2846 cf::face::set_visibility $idx, $info->{visibility};
2847 cf::face::set_magicmap $idx, $info->{magicmap};
2327 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2848 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2328 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2849 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2329 Coro::cede;
2330 }
2331 2850
2851 cf::cede_to_tick;
2852 }
2853
2332 while (my ($face, $info) = each %$faces) { 2854 while (my ($face, $info) = each %$faces) {
2333 next unless $info->{smooth}; 2855 next unless $info->{smooth};
2334 my $idx = cf::face::find $face 2856 my $idx = cf::face::find $face
2335 or next; 2857 or next;
2336 if (my $smooth = cf::face::find $info->{smooth}) { 2858 if (my $smooth = cf::face::find $info->{smooth}) {
2337 cf::face::set_smooth $idx, $smooth; 2859 cf::face::set_smooth $idx, $smooth;
2860 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2338 } else { 2861 } else {
2339 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2862 warn "smooth face '$info->{smooth}' not found for face '$face'";
2340 } 2863 }
2341 Coro::cede; 2864
2865 cf::cede_to_tick;
2866 }
2867 }
2868
2869 {
2870 my $anims = $facedata->{animinfo};
2871
2872 while (my ($anim, $info) = each %$anims) {
2873 cf::anim::set $anim, $info->{frames}, $info->{facings};
2874 cf::cede_to_tick;
2875 }
2876
2877 cf::anim::invalidate_all; # d'oh
2878 }
2879
2880 {
2881 # TODO: for gcfclient pleasure, we should give resources
2882 # that gcfclient doesn't grok a >10000 face index.
2883 my $res = $facedata->{resource};
2884 my $enc = JSON::XS->new->utf8->canonical;
2885
2886 my $soundconf = delete $res->{"res/sound.conf"};
2887
2888 while (my ($name, $info) = each %$res) {
2889 my $meta = $enc->encode ({
2890 name => $name,
2891 %{ $info->{meta} || {} },
2892 });
2893
2894 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2895
2896 if ($info->{type} & 1) {
2897 # prepend meta info
2898
2899 my $data = pack "(w/a*)*", $meta, $info->{data};
2900 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2901
2902 cf::face::set_data $idx, 0, $data, $chk;
2903 } else {
2904 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2905 }
2906
2907 cf::face::set_type $idx, $info->{type};
2908
2909 cf::cede_to_tick;
2910 }
2911
2912 if ($soundconf) {
2913 $soundconf = $enc->decode (delete $soundconf->{data});
2914
2915 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2916 my $sound = $soundconf->{compat}[$_]
2917 or next;
2918
2919 my $face = cf::face::find "sound/$sound->[1]";
2920 cf::sound::set $sound->[0] => $face;
2921 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2922 }
2923
2924 while (my ($k, $v) = each %{$soundconf->{event}}) {
2925 my $face = cf::face::find "sound/$v";
2926 cf::sound::set $k => $face;
2927 }
2928 }
2342 } 2929 }
2343 2930
2344 1 2931 1
2345} 2932}
2346 2933
2934register_exticmd fx_want => sub {
2935 my ($ns, $want) = @_;
2936
2937 while (my ($k, $v) = each %$want) {
2938 $ns->fx_want ($k, $v);
2939 }
2940};
2941
2942sub reload_regions {
2943 load_resource_file "$MAPDIR/regions"
2944 or die "unable to load regions file\n";
2945
2946 for (cf::region::list) {
2947 $_->{match} = qr/$_->{match}/
2948 if exists $_->{match};
2949 }
2950}
2951
2952sub reload_facedata {
2953 load_facedata "$DATADIR/facedata"
2954 or die "unable to load facedata\n";
2955}
2956
2957sub reload_archetypes {
2958 load_resource_file "$DATADIR/archetypes"
2959 or die "unable to load archetypes\n";
2960 #d# NEED to laod twice to resolve forward references
2961 # this really needs to be done in an extra post-pass
2962 # (which needs to be synchronous, so solve it differently)
2963 load_resource_file "$DATADIR/archetypes"
2964 or die "unable to load archetypes\n";
2965}
2966
2967sub reload_treasures {
2968 load_resource_file "$DATADIR/treasures"
2969 or die "unable to load treasurelists\n";
2970}
2971
2347sub reload_resources { 2972sub reload_resources {
2348 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2973 warn "reloading resource files...\n";
2349 or die "unable to load regions file\n";#d# 2974
2975 reload_regions;
2350 load_facedata 2976 reload_facedata;
2351 or die "unable to load facedata\n";#d# 2977 #reload_archetypes;#d#
2978 reload_archetypes;
2979 reload_treasures;
2980
2981 warn "finished reloading resource files\n";
2352} 2982}
2353 2983
2354sub init { 2984sub init {
2355 reload_resources; 2985 reload_resources;
2356} 2986}
2357 2987
2358sub cfg_load { 2988sub cfg_load {
2359 open my $fh, "<:utf8", cf::confdir . "/config" 2989 open my $fh, "<:utf8", "$CONFDIR/config"
2360 or return; 2990 or return;
2361 2991
2362 local $/; 2992 local $/;
2363 *CFG = YAML::Syck::Load <$fh>; 2993 *CFG = YAML::Syck::Load <$fh>;
2364 2994
2409 }, 3039 },
2410 ); 3040 );
2411 } 3041 }
2412} 3042}
2413 3043
3044sub write_runtime {
3045 my $runtime = "$LOCALDIR/runtime";
3046
3047 # first touch the runtime file to show we are still running:
3048 # the fsync below can take a very very long time.
3049
3050 IO::AIO::aio_utime $runtime, undef, undef;
3051
3052 my $guard = cf::lock_acquire "write_runtime";
3053
3054 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3055 or return;
3056
3057 my $value = $cf::RUNTIME + 90 + 10;
3058 # 10 is the runtime save interval, for a monotonic clock
3059 # 60 allows for the watchdog to kill the server.
3060
3061 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3062 and return;
3063
3064 # always fsync - this file is important
3065 aio_fsync $fh
3066 and return;
3067
3068 # touch it again to show we are up-to-date
3069 aio_utime $fh, undef, undef;
3070
3071 close $fh
3072 or return;
3073
3074 aio_rename "$runtime~", $runtime
3075 and return;
3076
3077 warn "runtime file written.\n";
3078
3079 1
3080}
3081
2414sub emergency_save() { 3082sub emergency_save() {
2415 my $freeze_guard = cf::freeze_mainloop; 3083 my $freeze_guard = cf::freeze_mainloop;
2416 3084
2417 warn "enter emergency perl save\n"; 3085 warn "enter emergency perl save\n";
2418 3086
2449 3117
2450 warn Carp::longmess "post_cleanup backtrace" 3118 warn Carp::longmess "post_cleanup backtrace"
2451 if $make_core; 3119 if $make_core;
2452} 3120}
2453 3121
2454sub reload() { 3122sub do_reload_perl() {
2455 # can/must only be called in main 3123 # can/must only be called in main
2456 if ($Coro::current != $Coro::main) { 3124 if ($Coro::current != $Coro::main) {
2457 warn "can only reload from main coroutine"; 3125 warn "can only reload from main coroutine";
2458 return; 3126 return;
2459 } 3127 }
2493 %EXT_CORO = (); 3161 %EXT_CORO = ();
2494 3162
2495 warn "removing commands"; 3163 warn "removing commands";
2496 %COMMAND = (); 3164 %COMMAND = ();
2497 3165
2498 warn "removing ext commands"; 3166 warn "removing ext/exti commands";
2499 %EXTCMD = (); 3167 %EXTCMD = ();
3168 %EXTICMD = ();
2500 3169
2501 warn "unloading/nuking all extensions"; 3170 warn "unloading/nuking all extensions";
2502 for my $pkg (@EXTS) { 3171 for my $pkg (@EXTS) {
2503 warn "... unloading $pkg"; 3172 warn "... unloading $pkg";
2504 3173
2534 Symbol::delete_package "safe::$_" 3203 Symbol::delete_package "safe::$_"
2535 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3204 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2536 3205
2537 warn "unloading cf.pm \"a bit\""; 3206 warn "unloading cf.pm \"a bit\"";
2538 delete $INC{"cf.pm"}; 3207 delete $INC{"cf.pm"};
3208 delete $INC{"cf/pod.pm"};
2539 3209
2540 # don't, removes xs symbols, too, 3210 # don't, removes xs symbols, too,
2541 # and global variables created in xs 3211 # and global variables created in xs
2542 #Symbol::delete_package __PACKAGE__; 3212 #Symbol::delete_package __PACKAGE__;
2543 3213
2558 warn "reattaching attachments to maps"; 3228 warn "reattaching attachments to maps";
2559 reattach $_ for values %MAP; 3229 reattach $_ for values %MAP;
2560 warn "reattaching attachments to players"; 3230 warn "reattaching attachments to players";
2561 reattach $_ for values %PLAYER; 3231 reattach $_ for values %PLAYER;
2562 3232
2563 warn "loading reloadable resources";
2564 reload_resources;
2565
2566 warn "leaving sync_job"; 3233 warn "leaving sync_job";
2567 3234
2568 1 3235 1
2569 } or do { 3236 } or do {
2570 warn $@; 3237 warn $@;
2575 warn "reloaded"; 3242 warn "reloaded";
2576}; 3243};
2577 3244
2578our $RELOAD_WATCHER; # used only during reload 3245our $RELOAD_WATCHER; # used only during reload
2579 3246
3247sub reload_perl() {
3248 # doing reload synchronously and two reloads happen back-to-back,
3249 # coro crashes during coro_state_free->destroy here.
3250
3251 $RELOAD_WATCHER ||= Event->timer (
3252 reentrant => 0,
3253 after => 0,
3254 data => WF_AUTOCANCEL,
3255 cb => sub {
3256 do_reload_perl;
3257 undef $RELOAD_WATCHER;
3258 },
3259 );
3260}
3261
2580register_command "reload" => sub { 3262register_command "reload" => sub {
2581 my ($who, $arg) = @_; 3263 my ($who, $arg) = @_;
2582 3264
2583 if ($who->flag (FLAG_WIZ)) { 3265 if ($who->flag (FLAG_WIZ)) {
2584 $who->message ("reloading server."); 3266 $who->message ("reloading server.");
2585 3267 async { reload_perl };
2586 # doing reload synchronously and two reloads happen back-to-back,
2587 # coro crashes during coro_state_free->destroy here.
2588
2589 $RELOAD_WATCHER ||= Event->timer (
2590 reentrant => 0,
2591 after => 0,
2592 data => WF_AUTOCANCEL,
2593 cb => sub {
2594 reload;
2595 undef $RELOAD_WATCHER;
2596 },
2597 );
2598 } 3268 }
2599}; 3269};
2600 3270
2601unshift @INC, $LIBDIR; 3271unshift @INC, $LIBDIR;
2602 3272
2603my $bug_warning = 0; 3273my $bug_warning = 0;
2604 3274
3275our @WAIT_FOR_TICK;
3276our @WAIT_FOR_TICK_BEGIN;
3277
3278sub wait_for_tick {
3279 return unless $TICK_WATCHER->is_active;
3280 return if $Coro::current == $Coro::main;
3281
3282 my $signal = new Coro::Signal;
3283 push @WAIT_FOR_TICK, $signal;
3284 $signal->wait;
3285}
3286
3287sub wait_for_tick_begin {
3288 return unless $TICK_WATCHER->is_active;
3289 return if $Coro::current == $Coro::main;
3290
3291 my $signal = new Coro::Signal;
3292 push @WAIT_FOR_TICK_BEGIN, $signal;
3293 $signal->wait;
3294}
3295
3296 my $min = 1e6;#d#
3297 my $avg = 10;
2605$TICK_WATCHER = Event->timer ( 3298$TICK_WATCHER = Event->timer (
2606 reentrant => 0, 3299 reentrant => 0,
2607 parked => 1, 3300 parked => 1,
2608 prio => 0, 3301 prio => 0,
2609 at => $NEXT_TICK || $TICK, 3302 at => $NEXT_TICK || $TICK,
2613 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3306 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2614 unless ++$bug_warning > 10; 3307 unless ++$bug_warning > 10;
2615 return; 3308 return;
2616 } 3309 }
2617 3310
2618 $NOW = Event::time; 3311 $NOW = $tick_start = Event::time;
2619 3312
2620 cf::server_tick; # one server iteration 3313 cf::server_tick; # one server iteration
3314
3315 0 && sync_job {#d#
3316 for(1..10) {
3317 my $t = Event::time;
3318 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3319 or die;
3320
3321 $map->width (50);
3322 $map->height (50);
3323 $map->alloc;
3324 $map->_load_objects ("/tmp/x.map", 1);
3325 my $t = Event::time - $t;
3326
3327 #next unless $t < 0.0013;#d#
3328 if ($t < $min) {
3329 $min = $t;
3330 }
3331 $avg = $avg * 0.99 + $t * 0.01;
3332 }
3333 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3334 exit 0;
3335 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3336 };
3337
2621 $RUNTIME += $TICK; 3338 $RUNTIME += $TICK;
2622 $NEXT_TICK += $TICK; 3339 $NEXT_TICK += $TICK;
2623 3340
2624 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3341 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2625 $NEXT_RUNTIME_WRITE = $NOW + 10; 3342 $NEXT_RUNTIME_WRITE = $NOW + 10;
2627 write_runtime 3344 write_runtime
2628 or warn "ERROR: unable to write runtime file: $!"; 3345 or warn "ERROR: unable to write runtime file: $!";
2629 }; 3346 };
2630 } 3347 }
2631 3348
2632 $WAIT_FOR_TICK->broadcast;
2633 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2634
2635# my $AFTER = Event::time; 3349# my $AFTER = Event::time;
2636# warn $AFTER - $NOW;#d# 3350# warn $AFTER - $NOW;#d#
2637 3351
3352 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3353 $sig->send;
3354 }
3355 while (my $sig = shift @WAIT_FOR_TICK) {
3356 $sig->send;
3357 }
3358
3359 $NOW = Event::time;
3360
2638 # if we are delayed by four ticks or more, skip them all 3361 # if we are delayed by four ticks or more, skip them all
2639 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3362 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2640 3363
2641 $TICK_WATCHER->at ($NEXT_TICK); 3364 $TICK_WATCHER->at ($NEXT_TICK);
2642 $TICK_WATCHER->start; 3365 $TICK_WATCHER->start;
3366
3367 $LOAD = ($NOW - $tick_start) / $TICK;
3368 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3369
3370 _post_tick;
3371
3372
2643 }, 3373 },
2644); 3374);
2645 3375
2646{ 3376{
2647 BDB::max_poll_time $TICK * 0.1; 3377 BDB::max_poll_time $TICK * 0.1;
2675 3405
2676 cf::sync_job { 3406 cf::sync_job {
2677 eval { 3407 eval {
2678 BDB::db_env_open 3408 BDB::db_env_open
2679 $DB_ENV, 3409 $DB_ENV,
2680 $BDB_ENV_DIR, 3410 $BDBDIR,
2681 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3411 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2682 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3412 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2683 0666; 3413 0666;
2684 3414
2685 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3415 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2686 3416
2687 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3417 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2688 $DB_ENV->set_lk_detect; 3418 $DB_ENV->set_lk_detect;
2689 }; 3419 };
2690 3420
2706 prio => 6, 3436 prio => 6,
2707 cb => \&IO::AIO::poll_cb, 3437 cb => \&IO::AIO::poll_cb,
2708 ); 3438 );
2709} 3439}
2710 3440
3441my $_log_backtrace;
3442
3443sub _log_backtrace {
3444 my ($msg, @addr) = @_;
3445
3446 $msg =~ s/\n//;
3447
3448 # limit the # of concurrent backtraces
3449 if ($_log_backtrace < 2) {
3450 ++$_log_backtrace;
3451 async {
3452 my @bt = fork_call {
3453 @addr = map { sprintf "%x", $_ } @addr;
3454 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3455 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3456 or die "addr2line: $!";
3457
3458 my @funcs;
3459 my @res = <$fh>;
3460 chomp for @res;
3461 while (@res) {
3462 my ($func, $line) = splice @res, 0, 2, ();
3463 push @funcs, "[$func] $line";
3464 }
3465
3466 @funcs
3467 };
3468
3469 LOG llevInfo, "[ABT] $msg\n";
3470 LOG llevInfo, "[ABT] $_\n" for @bt;
3471 --$_log_backtrace;
3472 };
3473 } else {
3474 LOG llevInfo, "[ABT] $msg\n";
3475 LOG llevInfo, "[ABT] [suppressed]\n";
3476 }
3477}
3478
3479# load additional modules
3480use cf::pod;
3481
2711END { cf::emergency_save } 3482END { cf::emergency_save }
2712 3483
27131 34841
2714 3485

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines