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.239 by root, Mon Apr 16 06:23:42 2007 UTC vs.
Revision 1.329 by root, Fri Aug 10 05:38:16 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.52 (); 15use Coro 3.61 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
21use Coro::Storable; 23use Coro::Storable;
22 24
25use JSON::XS 1.4 ();
23use BDB (); 26use BDB ();
24use Data::Dumper; 27use Data::Dumper;
25use Digest::MD5; 28use Digest::MD5;
26use Fcntl; 29use Fcntl;
27use YAML::Syck (); 30use YAML::Syck ();
28use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
29use Time::HiRes; 32use Time::HiRes;
30use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
31 35
32# configure various modules to our taste 36# configure various modules to our taste
33# 37#
34$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
35Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
47our %COMMAND = (); 51our %COMMAND = ();
48our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
49 53
50our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
51our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
52our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
53our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
54 59
55our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
56our @EVENT; 61our @EVENT;
57our $LIBDIR = datadir . "/ext";
58 62
59our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
60our $TICK_WATCHER; 76our $TICK_WATCHER;
61our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
62our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
63our $NEXT_TICK; 79our $NEXT_TICK;
64our $NOW; 80our $NOW;
73our $RUNTIME; 89our $RUNTIME;
74 90
75our %PLAYER; # all users 91our %PLAYER; # all users
76our %MAP; # all maps 92our %MAP; # all maps
77our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
78our $RANDOM_MAPS = cf::localdir . "/random";
79our $BDB_ENV_DIR = cf::localdir . "/db";
80 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];
1028 $cf::PLAYER{$login} = $self; 1372 $cf::PLAYER{$login} = $self;
1029 1373
1030 $self 1374 $self
1031} 1375}
1032 1376
1377=item $player->send_msg ($channel, $msg, $color, [extra...])
1378
1379=cut
1380
1381sub send_msg {
1382 my $ns = shift->ns
1383 or return;
1384 $ns->send_msg (@_);
1385}
1386
1033=item $pl->quit_character 1387=item $pl->quit_character
1034 1388
1035Nukes the player without looking back. If logged in, the connection will 1389Nukes the player without looking back. If logged in, the connection will
1036be destroyed. May block for a long time. 1390be destroyed. May block for a long time.
1037 1391
1084while and may block, so not sync_job-capable, ever. 1438while and may block, so not sync_job-capable, ever.
1085 1439
1086=cut 1440=cut
1087 1441
1088sub list_logins { 1442sub list_logins {
1089 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1443 my $dirs = aio_readdir $PLAYERDIR
1090 or return []; 1444 or return [];
1091 1445
1092 my @logins; 1446 my @logins;
1093 1447
1094 for my $login (@$dirs) { 1448 for my $login (@$dirs) {
1129 } 1483 }
1130 1484
1131 \@paths 1485 \@paths
1132} 1486}
1133 1487
1488=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1489
1490Expand crossfire pod fragments into protocol xml.
1491
1492=cut
1493
1494sub expand_cfpod {
1495 ((my $self), (local $_)) = @_;
1496
1497 # escape & and <
1498 s/&/&amp;/g;
1499 s/(?<![BIUGH])</&lt;/g;
1500
1501 # this is buggy, it needs to properly take care of nested <'s
1502
1503 1 while
1504 # replace B<>, I<>, U<> etc.
1505 s/B<([^\>]*)>/<b>$1<\/b>/
1506 || s/I<([^\>]*)>/<i>$1<\/i>/
1507 || s/U<([^\>]*)>/<u>$1<\/u>/
1508 # replace G<male|female> tags
1509 || s{G<([^>|]*)\|([^>]*)>}{
1510 $self->gender ? $2 : $1
1511 }ge
1512 # replace H<hint text>
1513 || s{H<([^\>]*)>}
1514 {
1515 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1516 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1517 "")
1518 [$self->{hintmode}]
1519 }ge;
1520
1521 # create single paragraphs (very hackish)
1522 s/(?<=\S)\n(?=\w)/ /g;
1523
1524 # compress some whitespace
1525 s/\s+\n/\n/g; # ws line-ends
1526 s/\n\n+/\n/g; # double lines
1527 s/^\n+//; # beginning lines
1528 s/\n+$//; # ending lines
1529
1530 $_
1531}
1532
1533sub hintmode {
1534 $_[0]{hintmode} = $_[1] if @_ > 1;
1535 $_[0]{hintmode}
1536}
1537
1134=item $player->ext_reply ($msgid, %msg) 1538=item $player->ext_reply ($msgid, @msg)
1135 1539
1136Sends an ext reply to the player. 1540Sends an ext reply to the player.
1137 1541
1138=cut 1542=cut
1139 1543
1140sub ext_reply($$%) { 1544sub ext_reply($$@) {
1141 my ($self, $id, %msg) = @_; 1545 my ($self, $id, @msg) = @_;
1142 1546
1143 $msg{msgid} = $id; 1547 if ($self->ns->extcmd == 2) {
1144 1548 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1145 $self->send ("ext " . cf::to_json \%msg); 1549 } elsif ($self->ns->extcmd == 1) {
1550 #TODO: version 1, remove
1551 unshift @msg, msgtype => "reply", msgid => $id;
1552 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1553 }
1146} 1554}
1147 1555
1148=item $player->ext_event ($type, %msg) 1556=item $player->ext_msg ($type, @msg)
1149 1557
1150Sends an ext event to the client. 1558Sends an ext event to the client.
1151 1559
1152=cut 1560=cut
1153 1561
1154sub ext_event($$%) { 1562sub ext_msg($$@) {
1155 my ($self, $type, %msg) = @_; 1563 my ($self, $type, @msg) = @_;
1156 1564
1157 $self->ns->ext_event ($type, %msg); 1565 $self->ns->ext_msg ($type, @msg);
1158} 1566}
1159 1567
1160=head3 cf::region 1568=head3 cf::region
1161 1569
1162=over 4 1570=over 4
1165 1573
1166package cf::region; 1574package cf::region;
1167 1575
1168=item cf::region::find_by_path $path 1576=item cf::region::find_by_path $path
1169 1577
1170Tries to decuce the probable region for a map knowing only its path. 1578Tries to decuce the likely region for a map knowing only its path.
1171 1579
1172=cut 1580=cut
1173 1581
1174sub find_by_path($) { 1582sub find_by_path($) {
1175 my ($path) = @_; 1583 my ($path) = @_;
1176 1584
1177 my ($match, $specificity); 1585 my ($match, $specificity);
1178 1586
1179 for my $region (list) { 1587 for my $region (list) {
1180 if ($region->match && $path =~ $region->match) { 1588 if ($region->{match} && $path =~ $region->{match}) {
1181 ($match, $specificity) = ($region, $region->specificity) 1589 ($match, $specificity) = ($region, $region->specificity)
1182 if $region->specificity > $specificity; 1590 if $region->specificity > $specificity;
1183 } 1591 }
1184 } 1592 }
1185 1593
1249 my ($self, $merge) = @_; 1657 my ($self, $merge) = @_;
1250 1658
1251 # we have to keep some variables in memory intact 1659 # we have to keep some variables in memory intact
1252 local $self->{path}; 1660 local $self->{path};
1253 local $self->{load_path}; 1661 local $self->{load_path};
1254 local $self->{deny_save};
1255 local $self->{deny_reset};
1256 1662
1257 $self->SUPER::thawer_merge ($merge); 1663 $self->SUPER::thawer_merge ($merge);
1258} 1664}
1259 1665
1260sub normalise { 1666sub normalise {
1307 $self->init; # pass $1 etc. 1713 $self->init; # pass $1 etc.
1308 return $self; 1714 return $self;
1309 } 1715 }
1310 } 1716 }
1311 1717
1312 Carp::carp "unable to resolve path '$path' (base '$base')."; 1718 Carp::cluck "unable to resolve path '$path' (base '$base').";
1313 () 1719 ()
1314} 1720}
1315 1721
1316sub init { 1722sub init {
1317 my ($self) = @_; 1723 my ($self) = @_;
1332 1738
1333# the original (read-only) location 1739# the original (read-only) location
1334sub load_path { 1740sub load_path {
1335 my ($self) = @_; 1741 my ($self) = @_;
1336 1742
1337 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1743 "$MAPDIR/$self->{path}.map"
1338} 1744}
1339 1745
1340# the temporary/swap location 1746# the temporary/swap location
1341sub save_path { 1747sub save_path {
1342 my ($self) = @_; 1748 my ($self) = @_;
1343 1749
1344 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1750 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1345 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1751 "$TMPDIR/$path.map"
1346} 1752}
1347 1753
1348# the unique path, undef == no special unique path 1754# the unique path, undef == no special unique path
1349sub uniq_path { 1755sub uniq_path {
1350 my ($self) = @_; 1756 my ($self) = @_;
1351 1757
1352 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1758 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1353 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1759 "$UNIQUEDIR/$path"
1354} 1760}
1355 1761
1356# and all this just because we cannot iterate over 1762# and all this just because we cannot iterate over
1357# all maps in C++... 1763# all maps in C++...
1358sub change_all_map_light { 1764sub change_all_map_light {
1359 my ($change) = @_; 1765 my ($change) = @_;
1360 1766
1361 $_->change_map_light ($change) 1767 $_->change_map_light ($change)
1362 for grep $_->outdoor, values %cf::MAP; 1768 for grep $_->outdoor, values %cf::MAP;
1769}
1770
1771sub decay_objects {
1772 my ($self) = @_;
1773
1774 return if $self->{deny_reset};
1775
1776 $self->do_decay_objects;
1363} 1777}
1364 1778
1365sub unlink_save { 1779sub unlink_save {
1366 my ($self) = @_; 1780 my ($self) = @_;
1367 1781
1425 $self->load_header_orig 1839 $self->load_header_orig
1426 or return; 1840 or return;
1427 $self->prepare_orig; 1841 $self->prepare_orig;
1428 } 1842 }
1429 1843
1844 $self->{deny_reset} = 1
1845 if $self->no_reset;
1846
1430 $self->default_region (cf::region::find_by_path $self->{path}) 1847 $self->default_region (cf::region::find_by_path $self->{path})
1431 unless $self->default_region; 1848 unless $self->default_region;
1432 1849
1433 1 1850 1
1434} 1851}
1449 $map->{last_save} = $cf::RUNTIME; 1866 $map->{last_save} = $cf::RUNTIME;
1450 1867
1451 $map->load_header 1868 $map->load_header
1452 or return; 1869 or return;
1453 1870
1454 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1871 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1455 # doing this can freeze the server in a sync job, obviously 1872 # doing this can freeze the server in a sync job, obviously
1456 #$cf::WAIT_FOR_TICK->wait; 1873 #$cf::WAIT_FOR_TICK->wait;
1457 $map->reset; 1874 $map->reset;
1458 undef $guard; 1875 undef $guard;
1459 return find $path; 1876 return find $path;
1470 my ($self) = @_; 1887 my ($self) = @_;
1471 1888
1472 local $self->{deny_reset} = 1; # loading can take a long time 1889 local $self->{deny_reset} = 1; # loading can take a long time
1473 1890
1474 my $path = $self->{path}; 1891 my $path = $self->{path};
1892
1893 {
1475 my $guard = cf::lock_acquire "map_load:$path"; 1894 my $guard = cf::lock_acquire "map_load:$path";
1476 1895
1477 return if $self->in_memory != cf::MAP_SWAPPED; 1896 return if $self->in_memory != cf::MAP_SWAPPED;
1478 1897
1479 $self->in_memory (cf::MAP_LOADING); 1898 $self->in_memory (cf::MAP_LOADING);
1480 1899
1481 $self->alloc; 1900 $self->alloc;
1482 1901
1483 $self->pre_load; 1902 $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; 1903 Coro::cede;
1510 $self->set_darkness_map; 1904
1905 $self->_load_objects ($self->{load_path}, 1)
1906 or return;
1907
1908 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1909 if delete $self->{load_original};
1910
1911 if (my $uniq = $self->uniq_path) {
1912 utf8::encode $uniq;
1913 if (aio_open $uniq, O_RDONLY, 0) {
1914 $self->clear_unique_items;
1915 $self->_load_objects ($uniq, 0);
1916 }
1917 }
1918
1919 Coro::cede;
1920 # now do the right thing for maps
1921 $self->link_multipart_objects;
1511 $self->difficulty ($self->estimate_difficulty) 1922 $self->difficulty ($self->estimate_difficulty)
1512 unless $self->difficulty; 1923 unless $self->difficulty;
1513 Coro::cede; 1924 Coro::cede;
1925
1926 unless ($self->{deny_activate}) {
1927 $self->decay_objects;
1928 $self->fix_auto_apply;
1929 $self->update_buttons;
1930 Coro::cede;
1931 $self->set_darkness_map;
1932 Coro::cede;
1514 $self->activate; 1933 $self->activate;
1515 Coro::cede; 1934 }
1935
1936 $self->{last_save} = $cf::RUNTIME;
1937 $self->last_access ($cf::RUNTIME);
1938
1939 $self->in_memory (cf::MAP_IN_MEMORY);
1516 } 1940 }
1517 1941
1518 $self->post_load; 1942 $self->post_load;
1519 Coro::cede;
1520
1521 $self->in_memory (cf::MAP_IN_MEMORY);
1522} 1943}
1523 1944
1524sub customise_for { 1945sub customise_for {
1525 my ($self, $ob) = @_; 1946 my ($self, $ob) = @_;
1526 1947
1527 return find "~" . $ob->name . "/" . $self->{path} 1948 return find "~" . $ob->name . "/" . $self->{path}
1528 if $self->per_player; 1949 if $self->per_player;
1950
1951# return find "?party/" . $ob->name . "/" . $self->{path}
1952# if $self->per_party;
1529 1953
1530 $self 1954 $self
1531} 1955}
1532 1956
1533# find and load all maps in the 3x3 area around a map 1957# find and load all maps in the 3x3 area around a map
1580 2004
1581 undef $MAP_PREFETCH{$path}; 2005 undef $MAP_PREFETCH{$path};
1582 $MAP_PREFETCHER ||= cf::async { 2006 $MAP_PREFETCHER ||= cf::async {
1583 while (%MAP_PREFETCH) { 2007 while (%MAP_PREFETCH) {
1584 for my $path (keys %MAP_PREFETCH) { 2008 for my $path (keys %MAP_PREFETCH) {
1585 my $map = find $path 2009 if (my $map = find $path) {
1586 or next;
1587 $map->load; 2010 $map->load;
2011 }
1588 2012
1589 delete $MAP_PREFETCH{$path}; 2013 delete $MAP_PREFETCH{$path};
1590 } 2014 }
1591 } 2015 }
1592 undef $MAP_PREFETCHER; 2016 undef $MAP_PREFETCHER;
1644 2068
1645sub reset_at { 2069sub reset_at {
1646 my ($self) = @_; 2070 my ($self) = @_;
1647 2071
1648 # TODO: safety, remove and allow resettable per-player maps 2072 # 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}; 2073 return 1e99 if $self->{deny_reset};
1651 2074
1652 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2075 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1653 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2076 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1654 2077
1665 my ($self) = @_; 2088 my ($self) = @_;
1666 2089
1667 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2090 my $lock = cf::lock_acquire "map_data:$self->{path}";
1668 2091
1669 return if $self->players; 2092 return if $self->players;
1670 return if $self->isa ("ext::map_per_player");#d#
1671 2093
1672 warn "resetting map ", $self->path;#d# 2094 warn "resetting map ", $self->path;
1673 2095
1674 $self->in_memory (cf::MAP_SWAPPED); 2096 $self->in_memory (cf::MAP_SWAPPED);
1675 2097
1676 # need to save uniques path 2098 # need to save uniques path
1677 unless ($self->{deny_save}) { 2099 unless ($self->{deny_save}) {
1709 $cf::MAP{$self->path} = $self; 2131 $cf::MAP{$self->path} = $self;
1710 2132
1711 $self->reset; # polite request, might not happen 2133 $self->reset; # polite request, might not happen
1712} 2134}
1713 2135
2136=item $maps = cf::map::tmp_maps
2137
2138Returns an arrayref with all map paths of currently instantiated and saved
2139maps. May block.
2140
2141=cut
2142
2143sub tmp_maps() {
2144 [
2145 map {
2146 utf8::decode $_;
2147 /\.map$/
2148 ? normalise $_
2149 : ()
2150 } @{ aio_readdir $TMPDIR or [] }
2151 ]
2152}
2153
2154=item $maps = cf::map::random_maps
2155
2156Returns an arrayref with all map paths of currently instantiated and saved
2157random maps. May block.
2158
2159=cut
2160
2161sub random_maps() {
2162 [
2163 map {
2164 utf8::decode $_;
2165 /\.map$/
2166 ? normalise "?random/$_"
2167 : ()
2168 } @{ aio_readdir $RANDOMDIR or [] }
2169 ]
2170}
2171
1714=item cf::map::unique_maps 2172=item cf::map::unique_maps
1715 2173
1716Returns an arrayref of paths of all shared maps that have 2174Returns an arrayref of paths of all shared maps that have
1717instantiated unique items. May block. 2175instantiated unique items. May block.
1718 2176
1719=cut 2177=cut
1720 2178
1721sub unique_maps() { 2179sub unique_maps() {
1722 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2180 [
1723 or return; 2181 map {
1724
1725 my @paths;
1726
1727 for (@$files) {
1728 utf8::decode $_; 2182 utf8::decode $_;
1729 next if /\.pst$/; 2183 /\.map$/
1730 next unless /^$PATH_SEP/o; 2184 ? normalise $_
1731 2185 : ()
1732 push @paths, cf::map::normalise $_; 2186 } @{ aio_readdir $UNIQUEDIR or [] }
1733 } 2187 ]
1734
1735 \@paths
1736} 2188}
1737 2189
1738package cf; 2190package cf;
1739 2191
1740=back 2192=back
1786 2238
1787 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2239 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1788 2240
1789 if ($self->{record_replies}) { 2241 if ($self->{record_replies}) {
1790 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2242 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2243
1791 } else { 2244 } else {
2245 my $pl = $self->contr;
2246
2247 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2248 my $dialog = $pl->{npc_dialog};
2249 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2250
2251 } else {
1792 $msg = $npc->name . " says: $msg" if $npc; 2252 $msg = $npc->name . " says: $msg" if $npc;
1793 $self->message ($msg, $flags); 2253 $self->message ($msg, $flags);
2254 }
1794 } 2255 }
2256}
2257
2258=item $object->send_msg ($channel, $msg, $color, [extra...])
2259
2260=cut
2261
2262sub cf::object::send_msg {
2263 my $pl = shift->contr
2264 or return;
2265 $pl->send_msg (@_);
1795} 2266}
1796 2267
1797=item $player_object->may ("access") 2268=item $player_object->may ("access")
1798 2269
1799Returns wether the given player is authorized to access resource "access" 2270Returns wether the given player is authorized to access resource "access"
1846 $self->deactivate_recursive; 2317 $self->deactivate_recursive;
1847 2318
1848 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2319 return if UNIVERSAL::isa $self->map, "ext::map_link";
1849 2320
1850 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2321 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1851 if $self->map; 2322 if $self->map && $self->map->{path} ne "{link}";
1852 2323
1853 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2324 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1854} 2325}
1855 2326
1856sub cf::object::player::leave_link { 2327sub cf::object::player::leave_link {
1857 my ($self, $map, $x, $y) = @_; 2328 my ($self, $map, $x, $y) = @_;
2329
2330 return unless $self->contr->active;
1858 2331
1859 my $link_pos = delete $self->{_link_pos}; 2332 my $link_pos = delete $self->{_link_pos};
1860 2333
1861 unless ($map) { 2334 unless ($map) {
1862 # restore original map position 2335 # restore original map position
1885 2358
1886 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2359 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1887 $self->enter_map ($map, $x, $y); 2360 $self->enter_map ($map, $x, $y);
1888} 2361}
1889 2362
1890cf::player->attach ( 2363=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1891 on_logout => sub {
1892 my ($pl) = @_;
1893 2364
1894 # abort map switching before logout 2365Moves the player to the given map-path and coordinates by first freezing
1895 if ($pl->ob->{_link_pos}) { 2366her, loading and preparing them map, calling the provided $check callback
1896 cf::sync_job { 2367that has to return the map if sucecssful, and then unfreezes the player on
1897 $pl->ob->leave_link 2368the new (success) or old (failed) map position. In either case, $done will
1898 }; 2369be called at the end of this process.
1899 }
1900 },
1901 on_login => sub {
1902 my ($pl) = @_;
1903 2370
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 2371=cut
2372
2373our $GOTOGEN;
1925 2374
1926sub cf::object::player::goto { 2375sub cf::object::player::goto {
1927 my ($self, $path, $x, $y) = @_; 2376 my ($self, $path, $x, $y, $check, $done) = @_;
2377
2378 # do generation counting so two concurrent goto's will be executed in-order
2379 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1928 2380
1929 $self->enter_link; 2381 $self->enter_link;
1930 2382
1931 (async { 2383 (async {
1932 my $map = eval { 2384 my $map = eval {
1933 my $map = cf::map::find $path; 2385 my $map = cf::map::find $path;
2386
2387 if ($map) {
1934 $map = $map->customise_for ($self) if $map; 2388 $map = $map->customise_for ($self);
2389 $map = $check->($map) if $check && $map;
2390 } else {
2391 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2392 }
2393
1935 $map 2394 $map
2395 };
2396
2397 if ($@) {
2398 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2399 LOG llevError | logBacktrace, Carp::longmess $@;
1936 } or 2400 }
1937 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1938 2401
2402 if ($gen == $self->{_goto_generation}) {
2403 delete $self->{_goto_generation};
1939 $self->leave_link ($map, $x, $y); 2404 $self->leave_link ($map, $x, $y);
2405 }
2406
2407 $done->() if $done;
1940 })->prio (1); 2408 })->prio (1);
1941} 2409}
1942 2410
1943=item $player_object->enter_exit ($exit_object) 2411=item $player_object->enter_exit ($exit_object)
1944 2412
1983 2451
1984 $rmp->{random_seed} ||= $exit->random_seed; 2452 $rmp->{random_seed} ||= $exit->random_seed;
1985 2453
1986 my $data = cf::to_json $rmp; 2454 my $data = cf::to_json $rmp;
1987 my $md5 = Digest::MD5::md5_hex $data; 2455 my $md5 = Digest::MD5::md5_hex $data;
1988 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2456 my $meta = "$RANDOMDIR/$md5.meta";
1989 2457
1990 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2458 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1991 aio_write $fh, 0, (length $data), $data, 0; 2459 aio_write $fh, 0, (length $data), $data, 0;
1992 undef $fh; 2460 undef $fh;
1993 aio_rename "$meta~", $meta; 2461 aio_rename "$meta~", $meta;
2012 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2480 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2013 my $hp = $exit->stats->hp; 2481 my $hp = $exit->stats->hp;
2014 my $sp = $exit->stats->sp; 2482 my $sp = $exit->stats->sp;
2015 2483
2016 $self->enter_link; 2484 $self->enter_link;
2485
2486 # if exit is damned, update players death & WoR home-position
2487 $self->contr->savebed ($slaying, $hp, $sp)
2488 if $exit->flag (FLAG_DAMNED);
2017 2489
2018 (async { 2490 (async {
2019 $self->deactivate_recursive; # just to be sure 2491 $self->deactivate_recursive; # just to be sure
2020 unless (eval { 2492 unless (eval {
2021 $self->goto ($slaying, $hp, $sp); 2493 $self->goto ($slaying, $hp, $sp);
2049 2521
2050 utf8::encode $text; 2522 utf8::encode $text;
2051 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2523 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2052} 2524}
2053 2525
2526=item $client->send_msg ($channel, $msg, $color, [extra...])
2527
2528Send a drawinfo or msg packet to the client, formatting the msg for the
2529client if neccessary. C<$type> should be a string identifying the type of
2530the message, with C<log> being the default. If C<$color> is negative, suppress
2531the message unless the client supports the msg packet.
2532
2533=cut
2534
2535sub cf::client::send_msg {
2536 my ($self, $channel, $msg, $color, @extra) = @_;
2537
2538 $msg = $self->pl->expand_cfpod ($msg);
2539
2540 $color &= cf::NDI_CLIENT_MASK; # just in case...
2541
2542 if (ref $channel) {
2543 # send meta info to client, if not yet sent
2544 unless (exists $self->{channel}{$channel->{id}}) {
2545 $self->{channel}{$channel->{id}} = $channel;
2546 $self->ext_msg (channel_info => $channel);
2547 }
2548
2549 $channel = $channel->{id};
2550 }
2551
2552 return unless @extra || length $msg;
2553
2554 if ($self->can_msg) {
2555 # default colour, mask it out
2556 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2557 if $color & cf::NDI_DEF;
2558
2559 $self->send_packet ("msg " . $self->{json_coder}->encode (
2560 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2561 } else {
2562 if ($color >= 0) {
2563 # replace some tags by gcfclient-compatible ones
2564 for ($msg) {
2565 1 while
2566 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2567 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2568 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2569 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2570 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2571 }
2572
2573 $color &= cf::NDI_COLOR_MASK;
2574
2575 utf8::encode $msg;
2576
2577 if (0 && $msg =~ /\[/) {
2578 $self->send_packet ("drawextinfo $color 4 0 $msg")
2579 } else {
2580 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2581 $self->send_packet ("drawinfo $color $msg")
2582 }
2583 }
2584 }
2585}
2586
2054=item $client->ext_event ($type, %msg) 2587=item $client->ext_msg ($type, @msg)
2055 2588
2056Sends an exti event to the client. 2589Sends an ext event to the client.
2057 2590
2058=cut 2591=cut
2059 2592
2060sub cf::client::ext_event($$%) { 2593sub cf::client::ext_msg($$@) {
2061 my ($self, $type, %msg) = @_; 2594 my ($self, $type, @msg) = @_;
2062 2595
2596 my $extcmd = $self->extcmd;
2597
2598 if ($extcmd == 2) {
2599 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2600 } elsif ($extcmd == 1) { # TODO: remove
2063 $msg{msgtype} = "event_$type"; 2601 push @msg, msgtype => "event_$type";
2064 $self->send_packet ("ext " . cf::to_json \%msg); 2602 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2603 }
2065} 2604}
2066 2605
2067=item $success = $client->query ($flags, "text", \&cb) 2606=item $success = $client->query ($flags, "text", \&cb)
2068 2607
2069Queues a query to the client, calling the given callback with 2608Queues a query to the client, calling the given callback with
2070the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2609the 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>. 2610C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2072 2611
2073Queries can fail, so check the return code. Or don't, as queries will become 2612Queries can fail, so check the return code. Or don't, as queries will
2074reliable at some point in the future. 2613become reliable at some point in the future.
2075 2614
2076=cut 2615=cut
2077 2616
2078sub cf::client::query { 2617sub cf::client::query {
2079 my ($self, $flags, $text, $cb) = @_; 2618 my ($self, $flags, $text, $cb) = @_;
2087 utf8::encode $text; 2626 utf8::encode $text;
2088 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2627 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2089 2628
2090 $self->send_packet ($self->{query_queue}[0][0]) 2629 $self->send_packet ($self->{query_queue}[0][0])
2091 if @{ $self->{query_queue} } == 1; 2630 if @{ $self->{query_queue} } == 1;
2631
2632 1
2092} 2633}
2093 2634
2094cf::client->attach ( 2635cf::client->attach (
2636 on_connect => sub {
2637 my ($ns) = @_;
2638
2639 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2640 },
2095 on_reply => sub { 2641 on_reply => sub {
2096 my ($ns, $msg) = @_; 2642 my ($ns, $msg) = @_;
2097 2643
2098 # this weird shuffling is so that direct followup queries 2644 # this weird shuffling is so that direct followup queries
2099 # get handled first 2645 # get handled first
2111 } else { 2657 } else {
2112 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2658 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2113 } 2659 }
2114 } 2660 }
2115 }, 2661 },
2662 on_exticmd => sub {
2663 my ($ns, $buf) = @_;
2664
2665 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2666
2667 if (ref $msg) {
2668 my ($type, $reply, @payload) =
2669 "ARRAY" eq ref $msg
2670 ? @$msg
2671 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2672
2673 if (my $cb = $EXTICMD{$type}) {
2674 my @reply = $cb->($ns, @payload);
2675
2676 $ns->ext_reply ($reply, @reply)
2677 if $reply;
2678 }
2679 } else {
2680 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2681 }
2682
2683 cf::override;
2684 },
2116); 2685);
2117 2686
2118=item $client->async (\&cb) 2687=item $client->async (\&cb)
2119 2688
2120Create a new coroutine, running the specified callback. The coroutine will 2689Create a new coroutine, running the specified callback. The coroutine will
2161our $safe = new Safe "safe"; 2730our $safe = new Safe "safe";
2162our $safe_hole = new Safe::Hole; 2731our $safe_hole = new Safe::Hole;
2163 2732
2164$SIG{FPE} = 'IGNORE'; 2733$SIG{FPE} = 'IGNORE';
2165 2734
2166$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2735$safe->permit_only (Opcode::opset qw(
2736 :base_core :base_mem :base_orig :base_math
2737 grepstart grepwhile mapstart mapwhile
2738 sort time
2739));
2167 2740
2168# here we export the classes and methods available to script code 2741# here we export the classes and methods available to script code
2169 2742
2170=pod 2743=pod
2171 2744
2172The following functions and methods are available within a safe environment: 2745The following functions and methods are available within a safe environment:
2173 2746
2174 cf::object contr pay_amount pay_player map 2747 cf::object
2748 contr pay_amount pay_player map x y force_find force_add
2749 insert remove
2750
2175 cf::object::player player 2751 cf::object::player
2176 cf::player peaceful 2752 player
2177 cf::map trigger 2753
2754 cf::player
2755 peaceful
2756
2757 cf::map
2758 trigger
2178 2759
2179=cut 2760=cut
2180 2761
2181for ( 2762for (
2182 ["cf::object" => qw(contr pay_amount pay_player map)], 2763 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2764 insert remove inv)],
2183 ["cf::object::player" => qw(player)], 2765 ["cf::object::player" => qw(player)],
2184 ["cf::player" => qw(peaceful)], 2766 ["cf::player" => qw(peaceful)],
2185 ["cf::map" => qw(trigger)], 2767 ["cf::map" => qw(trigger)],
2186) { 2768) {
2187 no strict 'refs'; 2769 no strict 'refs';
2258=back 2840=back
2259 2841
2260=cut 2842=cut
2261 2843
2262############################################################################# 2844#############################################################################
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 2845# the server's init and main functions
2336 2846
2337sub load_facedata { 2847sub load_facedata($) {
2338 my $path = sprintf "%s/facedata", cf::datadir; 2848 my ($path) = @_;
2339 2849
2340 warn "loading facedata from $path\n"; 2850 warn "loading facedata from $path\n";
2341 2851
2342 my $facedata; 2852 my $facedata;
2343 0 < aio_load $path, $facedata 2853 0 < aio_load $path, $facedata
2351 { 2861 {
2352 my $faces = $facedata->{faceinfo}; 2862 my $faces = $facedata->{faceinfo};
2353 2863
2354 while (my ($face, $info) = each %$faces) { 2864 while (my ($face, $info) = each %$faces) {
2355 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2865 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2356 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2866 cf::face::set_visibility $idx, $info->{visibility};
2867 cf::face::set_magicmap $idx, $info->{magicmap};
2357 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2868 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2358 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2869 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2359 Coro::cede; 2870
2871 cf::cede_to_tick;
2360 } 2872 }
2361 2873
2362 while (my ($face, $info) = each %$faces) { 2874 while (my ($face, $info) = each %$faces) {
2363 next unless $info->{smooth}; 2875 next unless $info->{smooth};
2364 my $idx = cf::face::find $face 2876 my $idx = cf::face::find $face
2365 or next; 2877 or next;
2366 if (my $smooth = cf::face::find $info->{smooth}) { 2878 if (my $smooth = cf::face::find $info->{smooth}) {
2879 cf::face::set_smooth $idx, $smooth;
2367 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2880 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2368 } else { 2881 } else {
2369 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2882 warn "smooth face '$info->{smooth}' not found for face '$face'";
2370 } 2883 }
2371 Coro::cede; 2884
2885 cf::cede_to_tick;
2372 } 2886 }
2373 } 2887 }
2374 2888
2375 { 2889 {
2376 my $anims = $facedata->{animinfo}; 2890 my $anims = $facedata->{animinfo};
2377 2891
2378 while (my ($anim, $info) = each %$anims) { 2892 while (my ($anim, $info) = each %$anims) {
2379 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2893 cf::anim::set $anim, $info->{frames}, $info->{facings};
2380 Coro::cede; 2894 cf::cede_to_tick;
2381 } 2895 }
2382 2896
2383 cf::anim::invalidate_all; # d'oh 2897 cf::anim::invalidate_all; # d'oh
2384 } 2898 }
2385 2899
2900 {
2901 # TODO: for gcfclient pleasure, we should give resources
2902 # that gcfclient doesn't grok a >10000 face index.
2903 my $res = $facedata->{resource};
2904 my $enc = JSON::XS->new->utf8->canonical;
2905
2906 my $soundconf = delete $res->{"res/sound.conf"};
2907
2908 while (my ($name, $info) = each %$res) {
2909 my $meta = $enc->encode ({
2910 name => $name,
2911 %{ $info->{meta} || {} },
2912 });
2913
2914 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2915
2916 if ($info->{type} & 1) {
2917 # prepend meta info
2918
2919 my $data = pack "(w/a*)*", $meta, $info->{data};
2920 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2921
2922 cf::face::set_data $idx, 0, $data, $chk;
2923 } else {
2924 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2925 }
2926
2927 cf::face::set_type $idx, $info->{type};
2928
2929 cf::cede_to_tick;
2930 }
2931
2932 if ($soundconf) {
2933 $soundconf = $enc->decode (delete $soundconf->{data});
2934
2935 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2936 my $sound = $soundconf->{compat}[$_]
2937 or next;
2938
2939 my $face = cf::face::find "sound/$sound->[1]";
2940 cf::sound::set $sound->[0] => $face;
2941 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2942 }
2943
2944 while (my ($k, $v) = each %{$soundconf->{event}}) {
2945 my $face = cf::face::find "sound/$v";
2946 cf::sound::set $k => $face;
2947 }
2948 }
2949 }
2950
2386 1 2951 1
2387} 2952}
2388 2953
2954register_exticmd fx_want => sub {
2955 my ($ns, $want) = @_;
2956
2957 while (my ($k, $v) = each %$want) {
2958 $ns->fx_want ($k, $v);
2959 }
2960};
2961
2962sub reload_regions {
2963 load_resource_file "$MAPDIR/regions"
2964 or die "unable to load regions file\n";
2965
2966 for (cf::region::list) {
2967 $_->{match} = qr/$_->{match}/
2968 if exists $_->{match};
2969 }
2970}
2971
2972sub reload_facedata {
2973 load_facedata "$DATADIR/facedata"
2974 or die "unable to load facedata\n";
2975}
2976
2977sub reload_archetypes {
2978 load_resource_file "$DATADIR/archetypes"
2979 or die "unable to load archetypes\n";
2980 #d# NEED to laod twice to resolve forward references
2981 # this really needs to be done in an extra post-pass
2982 # (which needs to be synchronous, so solve it differently)
2983 load_resource_file "$DATADIR/archetypes"
2984 or die "unable to load archetypes\n";
2985}
2986
2987sub reload_treasures {
2988 load_resource_file "$DATADIR/treasures"
2989 or die "unable to load treasurelists\n";
2990}
2991
2389sub reload_resources { 2992sub reload_resources {
2390 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2993 warn "reloading resource files...\n";
2391 or die "unable to load regions file\n";#d# 2994
2995 reload_regions;
2392 load_facedata 2996 reload_facedata;
2393 or die "unable to load facedata\n";#d# 2997 #reload_archetypes;#d#
2998 reload_archetypes;
2999 reload_treasures;
3000
3001 warn "finished reloading resource files\n";
2394} 3002}
2395 3003
2396sub init { 3004sub init {
2397 reload_resources; 3005 reload_resources;
2398} 3006}
2399 3007
2400sub cfg_load { 3008sub cfg_load {
2401 open my $fh, "<:utf8", cf::confdir . "/config" 3009 open my $fh, "<:utf8", "$CONFDIR/config"
2402 or return; 3010 or return;
2403 3011
2404 local $/; 3012 local $/;
2405 *CFG = YAML::Syck::Load <$fh>; 3013 *CFG = YAML::Syck::Load <$fh>;
2406 3014
2451 }, 3059 },
2452 ); 3060 );
2453 } 3061 }
2454} 3062}
2455 3063
3064sub write_runtime {
3065 my $runtime = "$LOCALDIR/runtime";
3066
3067 # first touch the runtime file to show we are still running:
3068 # the fsync below can take a very very long time.
3069
3070 IO::AIO::aio_utime $runtime, undef, undef;
3071
3072 my $guard = cf::lock_acquire "write_runtime";
3073
3074 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3075 or return;
3076
3077 my $value = $cf::RUNTIME + 90 + 10;
3078 # 10 is the runtime save interval, for a monotonic clock
3079 # 60 allows for the watchdog to kill the server.
3080
3081 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3082 and return;
3083
3084 # always fsync - this file is important
3085 aio_fsync $fh
3086 and return;
3087
3088 # touch it again to show we are up-to-date
3089 aio_utime $fh, undef, undef;
3090
3091 close $fh
3092 or return;
3093
3094 aio_rename "$runtime~", $runtime
3095 and return;
3096
3097 warn "runtime file written.\n";
3098
3099 1
3100}
3101
2456sub emergency_save() { 3102sub emergency_save() {
2457 my $freeze_guard = cf::freeze_mainloop; 3103 my $freeze_guard = cf::freeze_mainloop;
2458 3104
2459 warn "enter emergency perl save\n"; 3105 warn "enter emergency perl save\n";
2460 3106
2491 3137
2492 warn Carp::longmess "post_cleanup backtrace" 3138 warn Carp::longmess "post_cleanup backtrace"
2493 if $make_core; 3139 if $make_core;
2494} 3140}
2495 3141
2496sub reload() { 3142sub do_reload_perl() {
2497 # can/must only be called in main 3143 # can/must only be called in main
2498 if ($Coro::current != $Coro::main) { 3144 if ($Coro::current != $Coro::main) {
2499 warn "can only reload from main coroutine"; 3145 warn "can only reload from main coroutine";
2500 return; 3146 return;
2501 } 3147 }
2535 %EXT_CORO = (); 3181 %EXT_CORO = ();
2536 3182
2537 warn "removing commands"; 3183 warn "removing commands";
2538 %COMMAND = (); 3184 %COMMAND = ();
2539 3185
2540 warn "removing ext commands"; 3186 warn "removing ext/exti commands";
2541 %EXTCMD = (); 3187 %EXTCMD = ();
3188 %EXTICMD = ();
2542 3189
2543 warn "unloading/nuking all extensions"; 3190 warn "unloading/nuking all extensions";
2544 for my $pkg (@EXTS) { 3191 for my $pkg (@EXTS) {
2545 warn "... unloading $pkg"; 3192 warn "... unloading $pkg";
2546 3193
2576 Symbol::delete_package "safe::$_" 3223 Symbol::delete_package "safe::$_"
2577 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3224 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2578 3225
2579 warn "unloading cf.pm \"a bit\""; 3226 warn "unloading cf.pm \"a bit\"";
2580 delete $INC{"cf.pm"}; 3227 delete $INC{"cf.pm"};
3228 delete $INC{"cf/pod.pm"};
2581 3229
2582 # don't, removes xs symbols, too, 3230 # don't, removes xs symbols, too,
2583 # and global variables created in xs 3231 # and global variables created in xs
2584 #Symbol::delete_package __PACKAGE__; 3232 #Symbol::delete_package __PACKAGE__;
2585 3233
2600 warn "reattaching attachments to maps"; 3248 warn "reattaching attachments to maps";
2601 reattach $_ for values %MAP; 3249 reattach $_ for values %MAP;
2602 warn "reattaching attachments to players"; 3250 warn "reattaching attachments to players";
2603 reattach $_ for values %PLAYER; 3251 reattach $_ for values %PLAYER;
2604 3252
2605 warn "loading reloadable resources";
2606 reload_resources;
2607
2608 warn "leaving sync_job"; 3253 warn "leaving sync_job";
2609 3254
2610 1 3255 1
2611 } or do { 3256 } or do {
2612 warn $@; 3257 warn $@;
2617 warn "reloaded"; 3262 warn "reloaded";
2618}; 3263};
2619 3264
2620our $RELOAD_WATCHER; # used only during reload 3265our $RELOAD_WATCHER; # used only during reload
2621 3266
3267sub reload_perl() {
3268 # doing reload synchronously and two reloads happen back-to-back,
3269 # coro crashes during coro_state_free->destroy here.
3270
3271 $RELOAD_WATCHER ||= Event->timer (
3272 reentrant => 0,
3273 after => 0,
3274 data => WF_AUTOCANCEL,
3275 cb => sub {
3276 do_reload_perl;
3277 undef $RELOAD_WATCHER;
3278 },
3279 );
3280}
3281
2622register_command "reload" => sub { 3282register_command "reload" => sub {
2623 my ($who, $arg) = @_; 3283 my ($who, $arg) = @_;
2624 3284
2625 if ($who->flag (FLAG_WIZ)) { 3285 if ($who->flag (FLAG_WIZ)) {
2626 $who->message ("reloading server."); 3286 $who->message ("reloading server.");
2627 3287 async { reload_perl };
2628 # doing reload synchronously and two reloads happen back-to-back,
2629 # coro crashes during coro_state_free->destroy here.
2630
2631 $RELOAD_WATCHER ||= Event->timer (
2632 reentrant => 0,
2633 after => 0,
2634 data => WF_AUTOCANCEL,
2635 cb => sub {
2636 reload;
2637 undef $RELOAD_WATCHER;
2638 },
2639 );
2640 } 3288 }
2641}; 3289};
2642 3290
2643unshift @INC, $LIBDIR; 3291unshift @INC, $LIBDIR;
2644 3292
2646 3294
2647our @WAIT_FOR_TICK; 3295our @WAIT_FOR_TICK;
2648our @WAIT_FOR_TICK_BEGIN; 3296our @WAIT_FOR_TICK_BEGIN;
2649 3297
2650sub wait_for_tick { 3298sub wait_for_tick {
3299 return unless $TICK_WATCHER->is_active;
3300 return if $Coro::current == $Coro::main;
3301
2651 my $signal = new Coro::Signal; 3302 my $signal = new Coro::Signal;
2652 push @WAIT_FOR_TICK, $signal; 3303 push @WAIT_FOR_TICK, $signal;
2653 $signal->wait; 3304 $signal->wait;
2654} 3305}
2655 3306
2656sub wait_for_tick_begin { 3307sub wait_for_tick_begin {
3308 return unless $TICK_WATCHER->is_active;
3309 return if $Coro::current == $Coro::main;
3310
2657 my $signal = new Coro::Signal; 3311 my $signal = new Coro::Signal;
2658 push @WAIT_FOR_TICK_BEGIN, $signal; 3312 push @WAIT_FOR_TICK_BEGIN, $signal;
2659 $signal->wait; 3313 $signal->wait;
2660} 3314}
2661 3315
3316 my $min = 1e6;#d#
3317 my $avg = 10;
2662$TICK_WATCHER = Event->timer ( 3318$TICK_WATCHER = Event->timer (
2663 reentrant => 0, 3319 reentrant => 0,
2664 parked => 1, 3320 parked => 1,
2665 prio => 0, 3321 prio => 0,
2666 at => $NEXT_TICK || $TICK, 3322 at => $NEXT_TICK || $TICK,
2670 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3326 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2671 unless ++$bug_warning > 10; 3327 unless ++$bug_warning > 10;
2672 return; 3328 return;
2673 } 3329 }
2674 3330
2675 $NOW = Event::time; 3331 $NOW = $tick_start = Event::time;
2676 3332
2677 cf::server_tick; # one server iteration 3333 cf::server_tick; # one server iteration
3334
3335 0 && sync_job {#d#
3336 for(1..10) {
3337 my $t = Event::time;
3338 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3339 or die;
3340
3341 $map->width (50);
3342 $map->height (50);
3343 $map->alloc;
3344 $map->_load_objects ("/tmp/x.map", 1);
3345 my $t = Event::time - $t;
3346
3347 #next unless $t < 0.0013;#d#
3348 if ($t < $min) {
3349 $min = $t;
3350 }
3351 $avg = $avg * 0.99 + $t * 0.01;
3352 }
3353 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3354 exit 0;
3355 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3356 };
3357
2678 $RUNTIME += $TICK; 3358 $RUNTIME += $TICK;
2679 $NEXT_TICK += $TICK; 3359 $NEXT_TICK += $TICK;
2680 3360
2681 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3361 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2682 $NEXT_RUNTIME_WRITE = $NOW + 10; 3362 $NEXT_RUNTIME_WRITE = $NOW + 10;
2684 write_runtime 3364 write_runtime
2685 or warn "ERROR: unable to write runtime file: $!"; 3365 or warn "ERROR: unable to write runtime file: $!";
2686 }; 3366 };
2687 } 3367 }
2688 3368
3369# my $AFTER = Event::time;
3370# warn $AFTER - $NOW;#d#
3371
2689 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3372 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2690 $sig->send; 3373 $sig->send;
2691 } 3374 }
2692 while (my $sig = shift @WAIT_FOR_TICK) { 3375 while (my $sig = shift @WAIT_FOR_TICK) {
2693 $sig->send; 3376 $sig->send;
2694 } 3377 }
2695 3378
2696# my $AFTER = Event::time; 3379 $NOW = Event::time;
2697# warn $AFTER - $NOW;#d#
2698 3380
2699 # if we are delayed by four ticks or more, skip them all 3381 # if we are delayed by four ticks or more, skip them all
2700 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3382 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2701 3383
2702 $TICK_WATCHER->at ($NEXT_TICK); 3384 $TICK_WATCHER->at ($NEXT_TICK);
2703 $TICK_WATCHER->start; 3385 $TICK_WATCHER->start;
3386
3387 $LOAD = ($NOW - $tick_start) / $TICK;
3388 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3389
3390 _post_tick;
3391
3392
2704 }, 3393 },
2705); 3394);
2706 3395
2707{ 3396{
2708 BDB::max_poll_time $TICK * 0.1; 3397 BDB::max_poll_time $TICK * 0.1;
2736 3425
2737 cf::sync_job { 3426 cf::sync_job {
2738 eval { 3427 eval {
2739 BDB::db_env_open 3428 BDB::db_env_open
2740 $DB_ENV, 3429 $DB_ENV,
2741 $BDB_ENV_DIR, 3430 $BDBDIR,
2742 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3431 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2743 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3432 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2744 0666; 3433 0666;
2745 3434
2746 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3435 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2747 3436
2748 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3437 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2749 $DB_ENV->set_lk_detect; 3438 $DB_ENV->set_lk_detect;
2750 }; 3439 };
2751 3440
2767 prio => 6, 3456 prio => 6,
2768 cb => \&IO::AIO::poll_cb, 3457 cb => \&IO::AIO::poll_cb,
2769 ); 3458 );
2770} 3459}
2771 3460
3461my $_log_backtrace;
3462
3463sub _log_backtrace {
3464 my ($msg, @addr) = @_;
3465
3466 $msg =~ s/\n//;
3467
3468 # limit the # of concurrent backtraces
3469 if ($_log_backtrace < 2) {
3470 ++$_log_backtrace;
3471 async {
3472 my @bt = fork_call {
3473 @addr = map { sprintf "%x", $_ } @addr;
3474 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3475 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3476 or die "addr2line: $!";
3477
3478 my @funcs;
3479 my @res = <$fh>;
3480 chomp for @res;
3481 while (@res) {
3482 my ($func, $line) = splice @res, 0, 2, ();
3483 push @funcs, "[$func] $line";
3484 }
3485
3486 @funcs
3487 };
3488
3489 LOG llevInfo, "[ABT] $msg\n";
3490 LOG llevInfo, "[ABT] $_\n" for @bt;
3491 --$_log_backtrace;
3492 };
3493 } else {
3494 LOG llevInfo, "[ABT] $msg\n";
3495 LOG llevInfo, "[ABT] [suppressed]\n";
3496 }
3497}
3498
3499# load additional modules
3500use cf::pod;
3501
2772END { cf::emergency_save } 3502END { cf::emergency_save }
2773 3503
27741 35041
2775 3505

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines