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.252 by root, Wed Apr 18 15:28:18 2007 UTC vs.
Revision 1.338 by root, Tue Aug 21 01:07:47 2007 UTC

10use Event; 10use Event;
11use Opcode; 11use Opcode;
12use Safe; 12use Safe;
13use Safe::Hole; 13use Safe::Hole;
14 14
15use Coro 3.61 (); 15use Coro 3.64 ();
16use Coro::State; 16use Coro::State;
17use Coro::Handle; 17use Coro::Handle;
18use Coro::Event; 18use Coro::Event;
19use Coro::Timer; 19use Coro::Timer;
20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
24 25
26use JSON::XS 1.4 ();
25use BDB (); 27use BDB ();
26use Data::Dumper; 28use Data::Dumper;
27use Digest::MD5; 29use Digest::MD5;
28use Fcntl; 30use Fcntl;
29use YAML::Syck (); 31use YAML::Syck ();
30use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
31use Time::HiRes; 33use Time::HiRes;
32use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
33 36
34# configure various modules to our taste 37# configure various modules to our taste
35# 38#
36$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 52our %COMMAND = ();
50our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
51 54
52our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
56 60
57our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
58our @EVENT; 62our @EVENT;
59our $LIBDIR = datadir . "/ext"; 63
64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
60 75
61our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!) 76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
62our $TICK_WATCHER; 77our $TICK_WATCHER;
63our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
64our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
75our $RUNTIME; 90our $RUNTIME;
76 91
77our %PLAYER; # all users 92our %PLAYER; # all users
78our %MAP; # all maps 93our %MAP; # all maps
79our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
80our $RANDOM_MAPS = cf::localdir . "/random";
81our $BDB_ENV_DIR = cf::localdir . "/db";
82 95
83# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
84our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
85 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
86binmode STDOUT; 103binmode STDOUT;
87binmode STDERR; 104binmode STDERR;
88 105
89# read virtual server time, if available 106# read virtual server time, if available
90unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
91 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
92 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
93 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
94} 111}
95 112
96mkdir cf::localdir; 113mkdir $_
97mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
98mkdir cf::localdir . "/" . cf::tmpdir;
99mkdir cf::localdir . "/" . cf::uniquedir;
100mkdir $RANDOM_MAPS;
101mkdir $BDB_ENV_DIR;
102 115
103our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
104 117
105sub cf::map::normalise; 118sub cf::map::normalise;
106 119
117=item $cf::RUNTIME 130=item $cf::RUNTIME
118 131
119The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
120every server tick. 133every server tick.
121 134
122=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
123 138
124The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
125be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
126 143
127=item $cf::NOW 144=item $cf::NOW
128 145
129The time of the last (current) server tick. 146The time of the last (current) server tick.
130 147
131=item $cf::TICK 148=item $cf::TICK
132 149
133The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
134 161
135=item %cf::CFG 162=item %cf::CFG
136 163
137Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
138from wherever your confdir points to. 165from wherever your confdir points to.
141 168
142These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
143returns directly I<after> the tick processing (and consequently, can only wake one process 170returns directly I<after> the tick processing (and consequently, can only wake one process
144per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
145 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
178
146=back 179=back
147 180
148=cut 181=cut
149 182
150BEGIN { 183BEGIN {
152 my $msg = join "", @_; 185 my $msg = join "", @_;
153 186
154 $msg .= "\n" 187 $msg .= "\n"
155 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
156 189
157 $msg =~ s/([\x00-\x09\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge; 190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
158 191
159 utf8::encode $msg; 192 utf8::encode $msg;
160 LOG llevError, $msg; 193 LOG llevError, $msg;
161 }; 194 };
162} 195}
164@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
165@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
166@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
167@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
168@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
169@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
170 204
171# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
172# within the Safe compartment. 206# within the Safe compartment.
173for my $pkg (qw( 207for my $pkg (qw(
174 cf::global cf::attachable 208 cf::global cf::attachable
182} 216}
183 217
184$Event::DIED = sub { 218$Event::DIED = sub {
185 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
186}; 220};
221
222#############################################################################
187 223
188=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
189 225
190=over 4 226=over 4
191 227
210 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
211 $d 247 $d
212 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
213} 249}
214 250
215use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
216
217=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
218 252
219Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
220 254
221=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
222 256
223Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
258
259=cut
260
261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
262
263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
224 265
225=item cf::lock_wait $string 266=item cf::lock_wait $string
226 267
227Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
228 269
234returned. 275returned.
235 276
236Lock names should begin with a unique identifier (for example, cf::map::find 277Lock names should begin with a unique identifier (for example, cf::map::find
237uses map_find and cf::map::load uses map_load). 278uses map_find and cf::map::load uses map_load).
238 279
280=item $locked = cf::lock_active $string
281
282Return true if the lock is currently active, i.e. somebody has locked it.
283
239=cut 284=cut
240 285
241our %LOCK; 286our %LOCK;
242 287
243sub lock_wait($) { 288sub lock_wait($) {
260 305
261 Coro::guard { 306 Coro::guard {
262 # wake up all waiters, to be on the safe side 307 # wake up all waiters, to be on the safe side
263 $_->ready for @{ delete $LOCK{$key} }; 308 $_->ready for @{ delete $LOCK{$key} };
264 } 309 }
310}
311
312sub lock_active($) {
313 my ($key) = @_;
314
315 ! ! $LOCK{$key}
265} 316}
266 317
267sub freeze_mainloop { 318sub freeze_mainloop {
268 return unless $TICK_WATCHER->is_active; 319 return unless $TICK_WATCHER->is_active;
269 320
272 }; 323 };
273 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
274 $guard 325 $guard
275} 326}
276 327
328=item cf::get_slot $time[, $priority[, $name]]
329
330Allocate $time seconds of blocking CPU time at priority C<$priority>:
331This call blocks and returns only when you have at least C<$time> seconds
332of cpu time till the next tick. The slot is only valid till the next cede.
333
334The optional C<$name> can be used to identify the job to run. It might be
335used for statistical purposes and should identify the same time-class.
336
337Useful for short background jobs.
338
339=cut
340
341our @SLOT_QUEUE;
342our $SLOT_QUEUE;
343
344$SLOT_QUEUE->cancel if $SLOT_QUEUE;
345$SLOT_QUEUE = Coro::async {
346 my $signal = new Coro::Signal;
347
348 while () {
349 next_job:
350 my $avail = cf::till_tick;
351 if ($avail > 0.01) {
352 for (0 .. $#SLOT_QUEUE) {
353 if ($SLOT_QUEUE[$_][0] < $avail) {
354 my $job = splice @SLOT_QUEUE, $_, 1, ();
355 $job->[2]->send;
356 Coro::cede;
357 goto next_job;
358 }
359 }
360 }
361
362 if (@SLOT_QUEUE) {
363 # we do not use wait_For_tick() as it returns immediately when tick is inactive
364 push @cf::WAIT_FOR_TICK, $signal;
365 $signal->wait;
366 } else {
367 Coro::schedule;
368 }
369 }
370};
371
372sub get_slot($;$$) {
373 my ($time, $pri, $name) = @_;
374
375 $time = $TICK * .6 if $time > $TICK * .6;
376 my $sig = new Coro::Signal;
377
378 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
379 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
380 $SLOT_QUEUE->ready;
381 $sig->wait;
382}
383
277=item cf::async { BLOCK } 384=item cf::async { BLOCK }
278 385
279Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
280C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 387C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
281thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
284 391
285BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
286 393
287=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
288 395
289The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
290always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
291reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 398partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
399acceptable.
292 400
293If it must be done, put the blocking parts into C<sync_job>. This will run 401If it must be done, put the blocking parts into C<sync_job>. This will run
294the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
295server will be frozen during this time, so the block should either finish 403server will be frozen during this time, so the block should either finish
296fast or be very important. 404fast or be very important.
299 407
300sub sync_job(&) { 408sub sync_job(&) {
301 my ($job) = @_; 409 my ($job) = @_;
302 410
303 if ($Coro::current == $Coro::main) { 411 if ($Coro::current == $Coro::main) {
412 my $time = Event::time;
413
304 # this is the main coro, too bad, we have to block 414 # this is the main coro, too bad, we have to block
305 # till the operation succeeds, freezing the server :/ 415 # till the operation succeeds, freezing the server :/
306 416
307 # TODO: use suspend/resume instead 417 # TODO: use suspend/resume instead
308 # (but this is cancel-safe) 418 # (but this is cancel-safe)
319 429
320 while ($busy) { 430 while ($busy) {
321 Coro::cede or Event::one_event; 431 Coro::cede or Event::one_event;
322 } 432 }
323 433
434 $time = Event::time - $time;
435
436 LOG llevError | logBacktrace, Carp::longmess "long sync job"
437 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
438
439 $tick_start += $time; # do not account sync jobs to server load
440
324 wantarray ? @res : $res[0] 441 wantarray ? @res : $res[0]
325 } else { 442 } else {
326 # we are in another coroutine, how wonderful, everything just works 443 # we are in another coroutine, how wonderful, everything just works
327 444
328 $job->() 445 $job->()
347 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
348 465
349 $coro 466 $coro
350} 467}
351 468
352sub write_runtime { 469=item fork_call { }, $args
353 my $guard = cf::lock_acquire "write_runtime";
354 470
355 my $runtime = cf::localdir . "/runtime"; 471Executes the given code block with the given arguments in a seperate
472process, returning the results. Everything must be serialisable with
473Coro::Storable. May, of course, block. Note that the executed sub may
474never block itself or use any form of Event handling.
356 475
357 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 476=cut
358 or return;
359 477
360 my $value = $cf::RUNTIME + 90 + 10; 478sub fork_call(&@) {
361 # 10 is the runtime save interval, for a monotonic clock 479 my ($cb, @args) = @_;
362 # 60 allows for the watchdog to kill the server.
363 480
364 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481 # we seemingly have to make a local copy of the whole thing,
365 and return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
366 484
367 # always fsync - this file is important 485 my @res = Coro::Util::fork_eval {
368 aio_fsync $fh 486 reset_signals;
369 and return; 487 &$cb
488 }, @args;
370 489
371 close $fh 490 wantarray ? @res : $res[-1]
372 or return; 491}
373 492
374 aio_rename "$runtime~", $runtime 493=item $value = cf::db_get $family => $key
375 and return;
376 494
495Returns a single value from the environment database.
496
497=item cf::db_put $family => $key => $value
498
499Stores the given C<$value> in the family. It can currently store binary
500data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
501
502=cut
503
504our $DB;
505
506sub db_init {
507 unless ($DB) {
508 $DB = BDB::db_create $DB_ENV;
509
510 cf::sync_job {
511 eval {
512 $DB->set_flags (BDB::CHKSUM);
513
514 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
515 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
516 cf::cleanup "db_open(db): $!" if $!;
517 };
518 cf::cleanup "db_open(db): $@" if $@;
519 };
377 1 520 }
521}
522
523sub db_get($$) {
524 my $key = "$_[0]/$_[1]";
525
526 cf::sync_job {
527 BDB::db_get $DB, undef, $key, my $data;
528
529 $! ? ()
530 : $data
531 }
532}
533
534sub db_put($$$) {
535 BDB::dbreq_pri 4;
536 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
537}
538
539=item cf::cache $id => [$paths...], $processversion => $process
540
541Generic caching function that returns the value of the resource $id,
542caching and regenerating as required.
543
544This function can block.
545
546=cut
547
548sub cache {
549 my ($id, $src, $processversion, $process) = @_;
550
551 my $meta =
552 join "\x00",
553 $processversion,
554 map {
555 aio_stat $_
556 and Carp::croak "$_: $!";
557
558 ($_, (stat _)[7,9])
559 } @$src;
560
561 my $dbmeta = db_get cache => "$id/meta";
562 if ($dbmeta ne $meta) {
563 # changed, we may need to process
564
565 my @data;
566 my $md5;
567
568 for (0 .. $#$src) {
569 0 <= aio_load $src->[$_], $data[$_]
570 or Carp::croak "$src->[$_]: $!";
571 }
572
573 # if processing is expensive, check
574 # checksum first
575 if (1) {
576 $md5 =
577 join "\x00",
578 $processversion,
579 map {
580 Coro::cede;
581 ($src->[$_], Digest::MD5::md5_hex $data[$_])
582 } 0.. $#$src;
583
584
585 my $dbmd5 = db_get cache => "$id/md5";
586 if ($dbmd5 eq $md5) {
587 db_put cache => "$id/meta", $meta;
588
589 return db_get cache => "$id/data";
590 }
591 }
592
593 my $t1 = Time::HiRes::time;
594 my $data = $process->(\@data);
595 my $t2 = Time::HiRes::time;
596
597 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
598
599 db_put cache => "$id/data", $data;
600 db_put cache => "$id/md5" , $md5;
601 db_put cache => "$id/meta", $meta;
602
603 return $data;
604 }
605
606 db_get cache => "$id/data"
378} 607}
379 608
380=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
381 610
382Log a datalog packet of the given type with the given key-value pairs. 611Log a datalog packet of the given type with the given key-value pairs.
400attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
401to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
402 631
403In the following description, CLASS can be any of C<global>, C<object> 632In the following description, CLASS can be any of C<global>, C<object>
404C<player>, C<client> or C<map> (i.e. the attachable objects in 633C<player>, C<client> or C<map> (i.e. the attachable objects in
405crossfire+). 634Crossfire TRT).
406 635
407=over 4 636=over 4
408 637
409=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
410 639
573 $registry = $CB_TYPE[$object_type] ||= []; 802 $registry = $CB_TYPE[$object_type] ||= [];
574 803
575 } elsif ($type eq "subtype") { 804 } elsif ($type eq "subtype") {
576 defined $object_type or Carp::croak "subtype specified without type"; 805 defined $object_type or Carp::croak "subtype specified without type";
577 my $object_subtype = shift @arg; 806 my $object_subtype = shift @arg;
578 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 807 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
579 808
580 } elsif ($type eq "package") { 809 } elsif ($type eq "package") {
581 my $pkg = shift @arg; 810 my $pkg = shift @arg;
582 811
583 while (my ($name, $id) = each %cb_id) { 812 while (my ($name, $id) = each %cb_id) {
612 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
613 } 842 }
614 843
615 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
616 } else { 845 } else {
617 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
618 } 847 }
619 848
620 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
621} 850}
622 851
624 if (ref $_[0]) { 853 if (ref $_[0]) {
625 _object_attach @_; 854 _object_attach @_;
626 } else { 855 } else {
627 _attach shift->_attach_registry, @_; 856 _attach shift->_attach_registry, @_;
628 } 857 }
858 _recalc_want;
629}; 859};
630 860
631# all those should be optimised 861# all those should be optimised
632sub cf::attachable::detach { 862sub cf::attachable::detach {
633 my ($obj, $name) = @_; 863 my ($obj, $name) = @_;
636 delete $obj->{_attachment}{$name}; 866 delete $obj->{_attachment}{$name};
637 reattach ($obj); 867 reattach ($obj);
638 } else { 868 } else {
639 Carp::croak "cannot, currently, detach class attachments"; 869 Carp::croak "cannot, currently, detach class attachments";
640 } 870 }
871 _recalc_want;
641}; 872};
642 873
643sub cf::attachable::attached { 874sub cf::attachable::attached {
644 my ($obj, $name) = @_; 875 my ($obj, $name) = @_;
645 876
660 "; 891 ";
661 die if $@; 892 die if $@;
662} 893}
663 894
664our $override; 895our $override;
665our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 896our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
666 897
667sub override { 898sub override {
668 $override = 1; 899 $override = 1;
669 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
670} 901}
671 902
672sub do_invoke { 903sub do_invoke {
673 my $event = shift; 904 my $event = shift;
674 my $callbacks = shift; 905 my $callbacks = shift;
675 906
676 @invoke_results = (); 907 @INVOKE_RESULTS = ();
677 908
678 local $override; 909 local $override;
679 910
680 for (@$callbacks) { 911 for (@$callbacks) {
681 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
698 929
699Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
700 931
701This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 932This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
702removed in future versions), and there is no public API to access override 933removed in future versions), and there is no public API to access override
703results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
704 935
705=back 936=back
706 937
707=cut 938=cut
708 939
709############################################################################# 940#############################################################################
710# object support 941# object support
942#
943
944sub _can_merge {
945 my ($ob1, $ob2) = @_;
946
947 local $Storable::canonical = 1;
948 my $fob1 = Storable::freeze $ob1;
949 my $fob2 = Storable::freeze $ob2;
950
951 $fob1 eq $fob2
952}
711 953
712sub reattach { 954sub reattach {
713 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
714 my ($obj) = @_; 956 my ($obj) = @_;
715 957
818 or return; 1060 or return;
819 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
820 } 1062 }
821 1063
822 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
823 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
824 return ($data, $av); 1066 return ($data, $av);
825} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
826 1074
827############################################################################# 1075#############################################################################
828# command handling &c 1076# command handling &c
829 1077
830=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
843 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
844} 1092}
845 1093
846=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
847 1095
848Register a callbackf ro execution when the client sends an extcmd packet. 1096Register a callback for execution when the client sends an (synchronous)
1097extcmd packet. Ext commands will be processed in the order they are
1098received by the server, like other user commands. The first argument is
1099the logged-in player. Ext commands can only be processed after a player
1100has logged in successfully.
849 1101
850If the callback returns something, it is sent back as if reply was being 1102If the callback returns something, it is sent back as if reply was being
851called. 1103called.
852 1104
1105=item cf::register_exticmd $name => \&callback($ns,$packet);
1106
1107Register a callback for execution when the client sends an (asynchronous)
1108exticmd packet. Exti commands are processed by the server as soon as they
1109are received, i.e. out of order w.r.t. other commands. The first argument
1110is a client socket. Exti commands can be received anytime, even before
1111log-in.
1112
1113If the callback returns something, it is sent back as if reply was being
1114called.
1115
853=cut 1116=cut
854 1117
855sub register_extcmd { 1118sub register_extcmd {
856 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
857 1120
858 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
859} 1128}
860 1129
861cf::player->attach ( 1130cf::player->attach (
862 on_command => sub { 1131 on_command => sub {
863 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
872 cf::override; 1141 cf::override;
873 }, 1142 },
874 on_extcmd => sub { 1143 on_extcmd => sub {
875 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
876 1145
877 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
878 1147
879 if (ref $msg) { 1148 if (ref $msg) {
1149 my ($type, $reply, @payload) =
1150 "ARRAY" eq ref $msg
1151 ? @$msg
1152 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1153
1154 my @reply;
1155
880 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1156 if (my $cb = $EXTCMD{$type}) {
881 if (my %reply = $cb->($pl, $msg)) { 1157 @reply = $cb->($pl, @payload);
882 $pl->ext_reply ($msg->{msgid}, %reply);
883 }
884 } 1158 }
1159
1160 $pl->ext_reply ($reply, @reply)
1161 if $reply;
1162
885 } else { 1163 } else {
886 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1164 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
887 } 1165 }
888 1166
889 cf::override; 1167 cf::override;
890 }, 1168 },
891); 1169);
892 1170
893sub load_extension {
894 my ($path) = @_;
895
896 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
897 my $base = $1;
898 my $pkg = $1;
899 $pkg =~ s/[^[:word:]]/_/g;
900 $pkg = "ext::$pkg";
901
902 warn "... loading '$path' into '$pkg'\n";
903
904 open my $fh, "<:utf8", $path
905 or die "$path: $!";
906
907 my $source =
908 "package $pkg; use strict; use utf8;\n"
909 . "#line 1 \"$path\"\n{\n"
910 . (do { local $/; <$fh> })
911 . "\n};\n1";
912
913 unless (eval $source) {
914 my $msg = $@ ? "$path: $@\n"
915 : "extension disabled.\n";
916 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
917 warn $@;
918 warn "mandatory extension failed to load, exiting.\n";
919 exit 1;
920 }
921 die $@;
922 }
923
924 push @EXTS, $pkg;
925}
926
927sub load_extensions { 1171sub load_extensions {
1172 cf::sync_job {
1173 my %todo;
1174
928 for my $ext (<$LIBDIR/*.ext>) { 1175 for my $path (<$LIBDIR/*.ext>) {
929 next unless -r $ext; 1176 next unless -r $path;
930 eval { 1177
931 load_extension $ext; 1178 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1179 my $base = $1;
1180 my $pkg = $1;
1181 $pkg =~ s/[^[:word:]]/_/g;
1182 $pkg = "ext::$pkg";
1183
1184 open my $fh, "<:utf8", $path
1185 or die "$path: $!";
1186
1187 my $source = do { local $/; <$fh> };
1188
1189 my %ext = (
1190 path => $path,
1191 base => $base,
1192 pkg => $pkg,
1193 );
1194
1195 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1196 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1197
1198 $ext{source} =
1199 "package $pkg; use strict; use utf8;\n"
1200 . "#line 1 \"$path\"\n{\n"
1201 . $source
1202 . "\n};\n1";
1203
1204 $todo{$base} = \%ext;
1205 }
1206
1207 my %done;
1208 while (%todo) {
1209 my $progress;
1210
1211 while (my ($k, $v) = each %todo) {
1212 for (split /,\s*/, $v->{meta}{depends}) {
1213 goto skip
1214 unless exists $done{$_};
1215 }
1216
1217 warn "... loading '$k' into '$v->{pkg}'\n";
1218
1219 unless (eval $v->{source}) {
1220 my $msg = $@ ? "$v->{path}: $@\n"
1221 : "$v->{base}: extension inactive.\n";
1222
1223 if (exists $v->{meta}{mandatory}) {
1224 warn $msg;
1225 warn "mandatory extension failed to load, exiting.\n";
1226 exit 1;
1227 }
1228
1229 warn $msg;
1230 }
1231
1232 $done{$k} = delete $todo{$k};
1233 push @EXTS, $v->{pkg};
1234 $progress = 1;
932 1 1235 }
933 } or warn "$ext not loaded: $@"; 1236
1237 skip:
1238 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1239 unless $progress;
1240 }
934 } 1241 };
935} 1242}
936 1243
937############################################################################# 1244#############################################################################
938 1245
1246=back
1247
939=head2 CORE EXTENSIONS 1248=head2 CORE EXTENSIONS
940 1249
941Functions and methods that extend core crossfire objects. 1250Functions and methods that extend core crossfire objects.
942 1251
943=cut 1252=cut
955Returns the given player object, loading it if necessary (might block). 1264Returns the given player object, loading it if necessary (might block).
956 1265
957=cut 1266=cut
958 1267
959sub playerdir($) { 1268sub playerdir($) {
960 cf::localdir 1269 "$PLAYERDIR/"
961 . "/"
962 . cf::playerdir
963 . "/"
964 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1270 . (ref $_[0] ? $_[0]->ob->name : $_[0])
965} 1271}
966 1272
967sub path($) { 1273sub path($) {
968 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1274 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1032 $cf::PLAYER{$login} = $self; 1338 $cf::PLAYER{$login} = $self;
1033 1339
1034 $self 1340 $self
1035} 1341}
1036 1342
1343=item $player->send_msg ($channel, $msg, $color, [extra...])
1344
1345=cut
1346
1347sub send_msg {
1348 my $ns = shift->ns
1349 or return;
1350 $ns->send_msg (@_);
1351}
1352
1037=item $pl->quit_character 1353=item $pl->quit_character
1038 1354
1039Nukes the player without looking back. If logged in, the connection will 1355Nukes the player without looking back. If logged in, the connection will
1040be destroyed. May block for a long time. 1356be destroyed. May block for a long time.
1041 1357
1088while and may block, so not sync_job-capable, ever. 1404while and may block, so not sync_job-capable, ever.
1089 1405
1090=cut 1406=cut
1091 1407
1092sub list_logins { 1408sub list_logins {
1093 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1409 my $dirs = aio_readdir $PLAYERDIR
1094 or return []; 1410 or return [];
1095 1411
1096 my @logins; 1412 my @logins;
1097 1413
1098 for my $login (@$dirs) { 1414 for my $login (@$dirs) {
1133 } 1449 }
1134 1450
1135 \@paths 1451 \@paths
1136} 1452}
1137 1453
1454=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1455
1456Expand crossfire pod fragments into protocol xml.
1457
1458=cut
1459
1460sub expand_cfpod {
1461 ((my $self), (local $_)) = @_;
1462
1463 # escape & and <
1464 s/&/&amp;/g;
1465 s/(?<![BIUGH])</&lt;/g;
1466
1467 # this is buggy, it needs to properly take care of nested <'s
1468
1469 1 while
1470 # replace B<>, I<>, U<> etc.
1471 s/B<([^\>]*)>/<b>$1<\/b>/
1472 || s/I<([^\>]*)>/<i>$1<\/i>/
1473 || s/U<([^\>]*)>/<u>$1<\/u>/
1474 # replace G<male|female> tags
1475 || s{G<([^>|]*)\|([^>]*)>}{
1476 $self->gender ? $2 : $1
1477 }ge
1478 # replace H<hint text>
1479 || s{H<([^\>]*)>}
1480 {
1481 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1482 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1483 "")
1484 [$self->{hintmode}]
1485 }ge;
1486
1487 # create single paragraphs (very hackish)
1488 s/(?<=\S)\n(?=\w)/ /g;
1489
1490 # compress some whitespace
1491 s/\s+\n/\n/g; # ws line-ends
1492 s/\n\n+/\n/g; # double lines
1493 s/^\n+//; # beginning lines
1494 s/\n+$//; # ending lines
1495
1496 $_
1497}
1498
1499sub hintmode {
1500 $_[0]{hintmode} = $_[1] if @_ > 1;
1501 $_[0]{hintmode}
1502}
1503
1138=item $player->ext_reply ($msgid, %msg) 1504=item $player->ext_reply ($msgid, @msg)
1139 1505
1140Sends an ext reply to the player. 1506Sends an ext reply to the player.
1141 1507
1142=cut 1508=cut
1143 1509
1144sub ext_reply($$%) { 1510sub ext_reply($$@) {
1145 my ($self, $id, %msg) = @_; 1511 my ($self, $id, @msg) = @_;
1146 1512
1147 $msg{msgid} = $id; 1513 $self->ns->ext_reply ($id, @msg)
1148
1149 $self->send ("ext " . cf::to_json \%msg);
1150} 1514}
1151 1515
1152=item $player->ext_event ($type, %msg) 1516=item $player->ext_msg ($type, @msg)
1153 1517
1154Sends an ext event to the client. 1518Sends an ext event to the client.
1155 1519
1156=cut 1520=cut
1157 1521
1158sub ext_event($$%) { 1522sub ext_msg($$@) {
1159 my ($self, $type, %msg) = @_; 1523 my ($self, $type, @msg) = @_;
1160 1524
1161 $self->ns->ext_event ($type, %msg); 1525 $self->ns->ext_msg ($type, @msg);
1162} 1526}
1163 1527
1164=head3 cf::region 1528=head3 cf::region
1165 1529
1166=over 4 1530=over 4
1169 1533
1170package cf::region; 1534package cf::region;
1171 1535
1172=item cf::region::find_by_path $path 1536=item cf::region::find_by_path $path
1173 1537
1174Tries to decuce the probable region for a map knowing only its path. 1538Tries to decuce the likely region for a map knowing only its path.
1175 1539
1176=cut 1540=cut
1177 1541
1178sub find_by_path($) { 1542sub find_by_path($) {
1179 my ($path) = @_; 1543 my ($path) = @_;
1180 1544
1181 my ($match, $specificity); 1545 my ($match, $specificity);
1182 1546
1183 for my $region (list) { 1547 for my $region (list) {
1184 if ($region->match && $path =~ $region->match) { 1548 if ($region->{match} && $path =~ $region->{match}) {
1185 ($match, $specificity) = ($region, $region->specificity) 1549 ($match, $specificity) = ($region, $region->specificity)
1186 if $region->specificity > $specificity; 1550 if $region->specificity > $specificity;
1187 } 1551 }
1188 } 1552 }
1189 1553
1253 my ($self, $merge) = @_; 1617 my ($self, $merge) = @_;
1254 1618
1255 # we have to keep some variables in memory intact 1619 # we have to keep some variables in memory intact
1256 local $self->{path}; 1620 local $self->{path};
1257 local $self->{load_path}; 1621 local $self->{load_path};
1258 local $self->{deny_save};
1259 local $self->{deny_reset};
1260 1622
1261 $self->SUPER::thawer_merge ($merge); 1623 $self->SUPER::thawer_merge ($merge);
1262} 1624}
1263 1625
1264sub normalise { 1626sub normalise {
1311 $self->init; # pass $1 etc. 1673 $self->init; # pass $1 etc.
1312 return $self; 1674 return $self;
1313 } 1675 }
1314 } 1676 }
1315 1677
1316 Carp::carp "unable to resolve path '$path' (base '$base')."; 1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1317 () 1679 ()
1318} 1680}
1319 1681
1320sub init { 1682sub init {
1321 my ($self) = @_; 1683 my ($self) = @_;
1336 1698
1337# the original (read-only) location 1699# the original (read-only) location
1338sub load_path { 1700sub load_path {
1339 my ($self) = @_; 1701 my ($self) = @_;
1340 1702
1341 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1703 "$MAPDIR/$self->{path}.map"
1342} 1704}
1343 1705
1344# the temporary/swap location 1706# the temporary/swap location
1345sub save_path { 1707sub save_path {
1346 my ($self) = @_; 1708 my ($self) = @_;
1347 1709
1348 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1710 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1349 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1711 "$TMPDIR/$path.map"
1350} 1712}
1351 1713
1352# the unique path, undef == no special unique path 1714# the unique path, undef == no special unique path
1353sub uniq_path { 1715sub uniq_path {
1354 my ($self) = @_; 1716 my ($self) = @_;
1355 1717
1356 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1718 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1357 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1719 "$UNIQUEDIR/$path"
1358} 1720}
1359 1721
1360# and all this just because we cannot iterate over 1722# and all this just because we cannot iterate over
1361# all maps in C++... 1723# all maps in C++...
1362sub change_all_map_light { 1724sub change_all_map_light {
1363 my ($change) = @_; 1725 my ($change) = @_;
1364 1726
1365 $_->change_map_light ($change) 1727 $_->change_map_light ($change)
1366 for grep $_->outdoor, values %cf::MAP; 1728 for grep $_->outdoor, values %cf::MAP;
1729}
1730
1731sub decay_objects {
1732 my ($self) = @_;
1733
1734 return if $self->{deny_reset};
1735
1736 $self->do_decay_objects;
1367} 1737}
1368 1738
1369sub unlink_save { 1739sub unlink_save {
1370 my ($self) = @_; 1740 my ($self) = @_;
1371 1741
1429 $self->load_header_orig 1799 $self->load_header_orig
1430 or return; 1800 or return;
1431 $self->prepare_orig; 1801 $self->prepare_orig;
1432 } 1802 }
1433 1803
1804 $self->{deny_reset} = 1
1805 if $self->no_reset;
1806
1434 $self->default_region (cf::region::find_by_path $self->{path}) 1807 $self->default_region (cf::region::find_by_path $self->{path})
1435 unless $self->default_region; 1808 unless $self->default_region;
1436 1809
1437 1 1810 1
1438} 1811}
1453 $map->{last_save} = $cf::RUNTIME; 1826 $map->{last_save} = $cf::RUNTIME;
1454 1827
1455 $map->load_header 1828 $map->load_header
1456 or return; 1829 or return;
1457 1830
1458 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1831 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459 # doing this can freeze the server in a sync job, obviously 1832 # doing this can freeze the server in a sync job, obviously
1460 #$cf::WAIT_FOR_TICK->wait; 1833 #$cf::WAIT_FOR_TICK->wait;
1461 $map->reset; 1834 $map->reset;
1462 undef $guard; 1835 undef $guard;
1463 return find $path; 1836 return find $path;
1474 my ($self) = @_; 1847 my ($self) = @_;
1475 1848
1476 local $self->{deny_reset} = 1; # loading can take a long time 1849 local $self->{deny_reset} = 1; # loading can take a long time
1477 1850
1478 my $path = $self->{path}; 1851 my $path = $self->{path};
1852
1853 {
1479 my $guard = cf::lock_acquire "map_load:$path"; 1854 my $guard = cf::lock_acquire "map_load:$path";
1480 1855
1481 return if $self->in_memory != cf::MAP_SWAPPED; 1856 return if $self->in_memory != cf::MAP_SWAPPED;
1482 1857
1483 $self->in_memory (cf::MAP_LOADING); 1858 $self->in_memory (cf::MAP_LOADING);
1484 1859
1485 $self->alloc; 1860 $self->alloc;
1486 1861
1487 $self->pre_load; 1862 $self->pre_load;
1488 Coro::cede;
1489
1490 $self->_load_objects ($self->{load_path}, 1)
1491 or return;
1492
1493 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1494 if delete $self->{load_original};
1495
1496 if (my $uniq = $self->uniq_path) {
1497 utf8::encode $uniq;
1498 if (aio_open $uniq, O_RDONLY, 0) {
1499 $self->clear_unique_items;
1500 $self->_load_objects ($uniq, 0);
1501 }
1502 }
1503
1504 Coro::cede;
1505 # now do the right thing for maps
1506 $self->link_multipart_objects;
1507 Coro::cede;
1508
1509 unless ($self->{deny_activate}) {
1510 $self->decay_objects;
1511 $self->fix_auto_apply;
1512 $self->update_buttons;
1513 Coro::cede; 1863 Coro::cede;
1514 $self->set_darkness_map; 1864
1865 $self->_load_objects ($self->{load_path}, 1)
1866 or return;
1867
1868 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1869 if delete $self->{load_original};
1870
1871 if (my $uniq = $self->uniq_path) {
1872 utf8::encode $uniq;
1873 if (aio_open $uniq, O_RDONLY, 0) {
1874 $self->clear_unique_items;
1875 $self->_load_objects ($uniq, 0);
1876 }
1877 }
1878
1879 Coro::cede;
1880 # now do the right thing for maps
1881 $self->link_multipart_objects;
1515 $self->difficulty ($self->estimate_difficulty) 1882 $self->difficulty ($self->estimate_difficulty)
1516 unless $self->difficulty; 1883 unless $self->difficulty;
1517 Coro::cede; 1884 Coro::cede;
1885
1886 unless ($self->{deny_activate}) {
1887 $self->decay_objects;
1888 $self->fix_auto_apply;
1889 $self->update_buttons;
1890 Coro::cede;
1891 $self->set_darkness_map;
1892 Coro::cede;
1518 $self->activate; 1893 $self->activate;
1519 Coro::cede; 1894 }
1895
1896 $self->{last_save} = $cf::RUNTIME;
1897 $self->last_access ($cf::RUNTIME);
1898
1899 $self->in_memory (cf::MAP_IN_MEMORY);
1520 } 1900 }
1521 1901
1522 $self->post_load; 1902 $self->post_load;
1523 Coro::cede;
1524
1525 $self->in_memory (cf::MAP_IN_MEMORY);
1526} 1903}
1527 1904
1528sub customise_for { 1905sub customise_for {
1529 my ($self, $ob) = @_; 1906 my ($self, $ob) = @_;
1530 1907
1531 return find "~" . $ob->name . "/" . $self->{path} 1908 return find "~" . $ob->name . "/" . $self->{path}
1532 if $self->per_player; 1909 if $self->per_player;
1533 1910
1911# return find "?party/" . $ob->name . "/" . $self->{path}
1912# if $self->per_party;
1913
1534 $self 1914 $self
1535} 1915}
1536 1916
1537# find and load all maps in the 3x3 area around a map 1917# find and load all maps in the 3x3 area around a map
1538sub load_diag { 1918sub load_neighbours {
1539 my ($map) = @_; 1919 my ($map) = @_;
1540 1920
1541 my @diag; # diagonal neighbours 1921 my @neigh; # diagonal neighbours
1542 1922
1543 for (0 .. 3) { 1923 for (0 .. 3) {
1544 my $neigh = $map->tile_path ($_) 1924 my $neigh = $map->tile_path ($_)
1545 or next; 1925 or next;
1546 $neigh = find $neigh, $map 1926 $neigh = find $neigh, $map
1547 or next; 1927 or next;
1548 $neigh->load; 1928 $neigh->load;
1549 1929
1930 push @neigh,
1550 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1931 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1551 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1932 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1552 } 1933 }
1553 1934
1554 for (@diag) { 1935 for (grep defined $_->[0], @neigh) {
1936 my ($path, $origin) = @$_;
1555 my $neigh = find @$_ 1937 my $neigh = find $path, $origin
1556 or next; 1938 or next;
1557 $neigh->load; 1939 $neigh->load;
1558 } 1940 }
1559} 1941}
1560 1942
1584 1966
1585 undef $MAP_PREFETCH{$path}; 1967 undef $MAP_PREFETCH{$path};
1586 $MAP_PREFETCHER ||= cf::async { 1968 $MAP_PREFETCHER ||= cf::async {
1587 while (%MAP_PREFETCH) { 1969 while (%MAP_PREFETCH) {
1588 for my $path (keys %MAP_PREFETCH) { 1970 for my $path (keys %MAP_PREFETCH) {
1589 my $map = find $path 1971 if (my $map = find $path) {
1590 or next;
1591 $map->load; 1972 $map->load;
1973 }
1592 1974
1593 delete $MAP_PREFETCH{$path}; 1975 delete $MAP_PREFETCH{$path};
1594 } 1976 }
1595 } 1977 }
1596 undef $MAP_PREFETCHER; 1978 undef $MAP_PREFETCHER;
1648 2030
1649sub reset_at { 2031sub reset_at {
1650 my ($self) = @_; 2032 my ($self) = @_;
1651 2033
1652 # TODO: safety, remove and allow resettable per-player maps 2034 # TODO: safety, remove and allow resettable per-player maps
1653 return 1e99 if $self->isa ("ext::map_per_player");#d#
1654 return 1e99 if $self->{deny_reset}; 2035 return 1e99 if $self->{deny_reset};
1655 2036
1656 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2037 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1657 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2038 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1658 2039
1669 my ($self) = @_; 2050 my ($self) = @_;
1670 2051
1671 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2052 my $lock = cf::lock_acquire "map_data:$self->{path}";
1672 2053
1673 return if $self->players; 2054 return if $self->players;
1674 return if $self->isa ("ext::map_per_player");#d#
1675 2055
1676 warn "resetting map ", $self->path;#d# 2056 warn "resetting map ", $self->path;
1677 2057
1678 $self->in_memory (cf::MAP_SWAPPED); 2058 $self->in_memory (cf::MAP_SWAPPED);
1679 2059
1680 # need to save uniques path 2060 # need to save uniques path
1681 unless ($self->{deny_save}) { 2061 unless ($self->{deny_save}) {
1713 $cf::MAP{$self->path} = $self; 2093 $cf::MAP{$self->path} = $self;
1714 2094
1715 $self->reset; # polite request, might not happen 2095 $self->reset; # polite request, might not happen
1716} 2096}
1717 2097
2098=item $maps = cf::map::tmp_maps
2099
2100Returns an arrayref with all map paths of currently instantiated and saved
2101maps. May block.
2102
2103=cut
2104
2105sub tmp_maps() {
2106 [
2107 map {
2108 utf8::decode $_;
2109 /\.map$/
2110 ? normalise $_
2111 : ()
2112 } @{ aio_readdir $TMPDIR or [] }
2113 ]
2114}
2115
2116=item $maps = cf::map::random_maps
2117
2118Returns an arrayref with all map paths of currently instantiated and saved
2119random maps. May block.
2120
2121=cut
2122
2123sub random_maps() {
2124 [
2125 map {
2126 utf8::decode $_;
2127 /\.map$/
2128 ? normalise "?random/$_"
2129 : ()
2130 } @{ aio_readdir $RANDOMDIR or [] }
2131 ]
2132}
2133
1718=item cf::map::unique_maps 2134=item cf::map::unique_maps
1719 2135
1720Returns an arrayref of paths of all shared maps that have 2136Returns an arrayref of paths of all shared maps that have
1721instantiated unique items. May block. 2137instantiated unique items. May block.
1722 2138
1723=cut 2139=cut
1724 2140
1725sub unique_maps() { 2141sub unique_maps() {
1726 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2142 [
1727 or return; 2143 map {
1728
1729 my @paths;
1730
1731 for (@$files) {
1732 utf8::decode $_; 2144 utf8::decode $_;
1733 next if /\.pst$/; 2145 /\.map$/
1734 next unless /^$PATH_SEP/o; 2146 ? normalise $_
1735 2147 : ()
1736 push @paths, cf::map::normalise $_; 2148 } @{ aio_readdir $UNIQUEDIR or [] }
1737 } 2149 ]
1738
1739 \@paths
1740} 2150}
1741 2151
1742package cf; 2152package cf;
1743 2153
1744=back 2154=back
1790 2200
1791 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2201 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1792 2202
1793 if ($self->{record_replies}) { 2203 if ($self->{record_replies}) {
1794 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2204 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2205
1795 } else { 2206 } else {
2207 my $pl = $self->contr;
2208
2209 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2210 my $dialog = $pl->{npc_dialog};
2211 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2212
2213 } else {
1796 $msg = $npc->name . " says: $msg" if $npc; 2214 $msg = $npc->name . " says: $msg" if $npc;
1797 $self->message ($msg, $flags); 2215 $self->message ($msg, $flags);
2216 }
1798 } 2217 }
2218}
2219
2220=item $object->send_msg ($channel, $msg, $color, [extra...])
2221
2222=cut
2223
2224sub cf::object::send_msg {
2225 my $pl = shift->contr
2226 or return;
2227 $pl->send_msg (@_);
1799} 2228}
1800 2229
1801=item $player_object->may ("access") 2230=item $player_object->may ("access")
1802 2231
1803Returns wether the given player is authorized to access resource "access" 2232Returns wether the given player is authorized to access resource "access"
1850 $self->deactivate_recursive; 2279 $self->deactivate_recursive;
1851 2280
1852 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2281 return if UNIVERSAL::isa $self->map, "ext::map_link";
1853 2282
1854 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2283 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1855 if $self->map; 2284 if $self->map && $self->map->{path} ne "{link}";
1856 2285
1857 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2286 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1858} 2287}
1859 2288
1860sub cf::object::player::leave_link { 2289sub cf::object::player::leave_link {
1861 my ($self, $map, $x, $y) = @_; 2290 my ($self, $map, $x, $y) = @_;
2291
2292 return unless $self->contr->active;
1862 2293
1863 my $link_pos = delete $self->{_link_pos}; 2294 my $link_pos = delete $self->{_link_pos};
1864 2295
1865 unless ($map) { 2296 unless ($map) {
1866 # restore original map position 2297 # restore original map position
1880 # use -1 or undef as default coordinates, not 0, 0 2311 # use -1 or undef as default coordinates, not 0, 0
1881 ($x, $y) = ($map->enter_x, $map->enter_y) 2312 ($x, $y) = ($map->enter_x, $map->enter_y)
1882 if $x <=0 && $y <= 0; 2313 if $x <=0 && $y <= 0;
1883 2314
1884 $map->load; 2315 $map->load;
1885 $map->load_diag; 2316 $map->load_neighbours;
1886 2317
1887 return unless $self->contr->active; 2318 return unless $self->contr->active;
1888 $self->activate_recursive; 2319 $self->activate_recursive;
1889 2320
1890 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2321 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1891 $self->enter_map ($map, $x, $y); 2322 $self->enter_map ($map, $x, $y);
1892} 2323}
1893 2324
1894cf::player->attach ( 2325=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1895 on_logout => sub {
1896 my ($pl) = @_;
1897 2326
1898 # abort map switching before logout 2327Moves the player to the given map-path and coordinates by first freezing
1899 if ($pl->ob->{_link_pos}) { 2328her, loading and preparing them map, calling the provided $check callback
1900 cf::sync_job { 2329that has to return the map if sucecssful, and then unfreezes the player on
1901 $pl->ob->leave_link 2330the new (success) or old (failed) map position. In either case, $done will
1902 }; 2331be called at the end of this process.
1903 }
1904 },
1905 on_login => sub {
1906 my ($pl) = @_;
1907 2332
1908 # try to abort aborted map switching on player login :)
1909 # should happen only on crashes
1910 if ($pl->ob->{_link_pos}) {
1911 $pl->ob->enter_link;
1912 (async {
1913 $pl->ob->reply (undef,
1914 "There was an internal problem at your last logout, "
1915 . "the server will try to bring you to your intended destination in a second.",
1916 cf::NDI_RED);
1917 # we need this sleep as the login has a concurrent enter_exit running
1918 # and this sleep increases chances of the player not ending up in scorn
1919 Coro::Timer::sleep 1;
1920 $pl->ob->leave_link;
1921 })->prio (2);
1922 }
1923 },
1924);
1925
1926=item $player_object->goto ($path, $x, $y)
1927
1928=cut 2333=cut
2334
2335our $GOTOGEN;
1929 2336
1930sub cf::object::player::goto { 2337sub cf::object::player::goto {
1931 my ($self, $path, $x, $y) = @_; 2338 my ($self, $path, $x, $y, $check, $done) = @_;
2339
2340 # do generation counting so two concurrent goto's will be executed in-order
2341 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1932 2342
1933 $self->enter_link; 2343 $self->enter_link;
1934 2344
1935 (async { 2345 (async {
1936 my $map = eval { 2346 my $map = eval {
1937 my $map = cf::map::find $path; 2347 my $map = cf::map::find $path;
2348
2349 if ($map) {
1938 $map = $map->customise_for ($self) if $map; 2350 $map = $map->customise_for ($self);
2351 $map = $check->($map) if $check && $map;
2352 } else {
2353 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2354 }
2355
1939 $map 2356 $map
2357 };
2358
2359 if ($@) {
2360 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2361 LOG llevError | logBacktrace, Carp::longmess $@;
1940 } or 2362 }
1941 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1942 2363
2364 if ($gen == $self->{_goto_generation}) {
2365 delete $self->{_goto_generation};
1943 $self->leave_link ($map, $x, $y); 2366 $self->leave_link ($map, $x, $y);
2367 }
2368
2369 $done->() if $done;
1944 })->prio (1); 2370 })->prio (1);
1945} 2371}
1946 2372
1947=item $player_object->enter_exit ($exit_object) 2373=item $player_object->enter_exit ($exit_object)
1948 2374
1987 2413
1988 $rmp->{random_seed} ||= $exit->random_seed; 2414 $rmp->{random_seed} ||= $exit->random_seed;
1989 2415
1990 my $data = cf::to_json $rmp; 2416 my $data = cf::to_json $rmp;
1991 my $md5 = Digest::MD5::md5_hex $data; 2417 my $md5 = Digest::MD5::md5_hex $data;
1992 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2418 my $meta = "$RANDOMDIR/$md5.meta";
1993 2419
1994 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2420 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1995 aio_write $fh, 0, (length $data), $data, 0; 2421 aio_write $fh, 0, (length $data), $data, 0;
1996 undef $fh; 2422 undef $fh;
1997 aio_rename "$meta~", $meta; 2423 aio_rename "$meta~", $meta;
2016 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2442 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2017 my $hp = $exit->stats->hp; 2443 my $hp = $exit->stats->hp;
2018 my $sp = $exit->stats->sp; 2444 my $sp = $exit->stats->sp;
2019 2445
2020 $self->enter_link; 2446 $self->enter_link;
2447
2448 # if exit is damned, update players death & WoR home-position
2449 $self->contr->savebed ($slaying, $hp, $sp)
2450 if $exit->flag (FLAG_DAMNED);
2021 2451
2022 (async { 2452 (async {
2023 $self->deactivate_recursive; # just to be sure 2453 $self->deactivate_recursive; # just to be sure
2024 unless (eval { 2454 unless (eval {
2025 $self->goto ($slaying, $hp, $sp); 2455 $self->goto ($slaying, $hp, $sp);
2053 2483
2054 utf8::encode $text; 2484 utf8::encode $text;
2055 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2485 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2056} 2486}
2057 2487
2488=item $client->send_msg ($channel, $msg, $color, [extra...])
2489
2490Send a drawinfo or msg packet to the client, formatting the msg for the
2491client if neccessary. C<$type> should be a string identifying the type of
2492the message, with C<log> being the default. If C<$color> is negative, suppress
2493the message unless the client supports the msg packet.
2494
2495=cut
2496
2497sub cf::client::send_msg {
2498 my ($self, $channel, $msg, $color, @extra) = @_;
2499
2500 $msg = $self->pl->expand_cfpod ($msg);
2501
2502 $color &= cf::NDI_CLIENT_MASK; # just in case...
2503
2504 if (ref $channel) {
2505 # send meta info to client, if not yet sent
2506 unless (exists $self->{channel}{$channel->{id}}) {
2507 $self->{channel}{$channel->{id}} = $channel;
2508 $self->ext_msg (channel_info => $channel);
2509 }
2510
2511 $channel = $channel->{id};
2512 }
2513
2514 return unless @extra || length $msg;
2515
2516 if ($self->can_msg) {
2517 # default colour, mask it out
2518 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2519 if $color & cf::NDI_DEF;
2520
2521 $self->send_packet ("msg " . $self->{json_coder}->encode (
2522 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2523 } else {
2524 if ($color >= 0) {
2525 # replace some tags by gcfclient-compatible ones
2526 for ($msg) {
2527 1 while
2528 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2529 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2530 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2531 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2532 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2533 }
2534
2535 $color &= cf::NDI_COLOR_MASK;
2536
2537 utf8::encode $msg;
2538
2539 if (0 && $msg =~ /\[/) {
2540 # COMMAND/INFO
2541 $self->send_packet ("drawextinfo $color 10 8 $msg")
2542 } else {
2543 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2544 $self->send_packet ("drawinfo $color $msg")
2545 }
2546 }
2547 }
2548}
2549
2058=item $client->ext_event ($type, %msg) 2550=item $client->ext_msg ($type, @msg)
2059 2551
2060Sends an exti event to the client. 2552Sends an ext event to the client.
2061 2553
2062=cut 2554=cut
2063 2555
2064sub cf::client::ext_event($$%) { 2556sub cf::client::ext_msg($$@) {
2065 my ($self, $type, %msg) = @_; 2557 my ($self, $type, @msg) = @_;
2066 2558
2559 my $extcmd = $self->extcmd;
2560
2561 if ($extcmd == 2) {
2562 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2563 } elsif ($extcmd == 1) { # TODO: remove
2067 $msg{msgtype} = "event_$type"; 2564 push @msg, msgtype => "event_$type";
2068 $self->send_packet ("ext " . cf::to_json \%msg); 2565 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2566 }
2567}
2568
2569=item $client->ext_reply ($msgid, @msg)
2570
2571Sends an ext reply to the client.
2572
2573=cut
2574
2575sub cf::client::ext_reply($$@) {
2576 my ($self, $id, @msg) = @_;
2577
2578 if ($self->extcmd == 2) {
2579 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2580 } elsif ($self->ns->extcmd == 1) {
2581 #TODO: version 1, remove
2582 unshift @msg, msgtype => "reply", msgid => $id;
2583 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2584 }
2069} 2585}
2070 2586
2071=item $success = $client->query ($flags, "text", \&cb) 2587=item $success = $client->query ($flags, "text", \&cb)
2072 2588
2073Queues a query to the client, calling the given callback with 2589Queues a query to the client, calling the given callback with
2074the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2590the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2075C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2591C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2076 2592
2077Queries can fail, so check the return code. Or don't, as queries will become 2593Queries can fail, so check the return code. Or don't, as queries will
2078reliable at some point in the future. 2594become reliable at some point in the future.
2079 2595
2080=cut 2596=cut
2081 2597
2082sub cf::client::query { 2598sub cf::client::query {
2083 my ($self, $flags, $text, $cb) = @_; 2599 my ($self, $flags, $text, $cb) = @_;
2091 utf8::encode $text; 2607 utf8::encode $text;
2092 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2608 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2093 2609
2094 $self->send_packet ($self->{query_queue}[0][0]) 2610 $self->send_packet ($self->{query_queue}[0][0])
2095 if @{ $self->{query_queue} } == 1; 2611 if @{ $self->{query_queue} } == 1;
2612
2613 1
2096} 2614}
2097 2615
2098cf::client->attach ( 2616cf::client->attach (
2617 on_connect => sub {
2618 my ($ns) = @_;
2619
2620 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2621 },
2099 on_reply => sub { 2622 on_reply => sub {
2100 my ($ns, $msg) = @_; 2623 my ($ns, $msg) = @_;
2101 2624
2102 # this weird shuffling is so that direct followup queries 2625 # this weird shuffling is so that direct followup queries
2103 # get handled first 2626 # get handled first
2115 } else { 2638 } else {
2116 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2639 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2117 } 2640 }
2118 } 2641 }
2119 }, 2642 },
2643 on_exticmd => sub {
2644 my ($ns, $buf) = @_;
2645
2646 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2647
2648 if (ref $msg) {
2649 my ($type, $reply, @payload) =
2650 "ARRAY" eq ref $msg
2651 ? @$msg
2652 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2653
2654 my @reply;
2655
2656 if (my $cb = $EXTICMD{$type}) {
2657 @reply = $cb->($ns, @payload);
2658 }
2659
2660 $ns->ext_reply ($reply, @reply)
2661 if $reply;
2662
2663 } else {
2664 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2665 }
2666
2667 cf::override;
2668 },
2120); 2669);
2121 2670
2122=item $client->async (\&cb) 2671=item $client->async (\&cb)
2123 2672
2124Create a new coroutine, running the specified callback. The coroutine will 2673Create a new coroutine, running the specified callback. The coroutine will
2165our $safe = new Safe "safe"; 2714our $safe = new Safe "safe";
2166our $safe_hole = new Safe::Hole; 2715our $safe_hole = new Safe::Hole;
2167 2716
2168$SIG{FPE} = 'IGNORE'; 2717$SIG{FPE} = 'IGNORE';
2169 2718
2170$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2719$safe->permit_only (Opcode::opset qw(
2720 :base_core :base_mem :base_orig :base_math
2721 grepstart grepwhile mapstart mapwhile
2722 sort time
2723));
2171 2724
2172# here we export the classes and methods available to script code 2725# here we export the classes and methods available to script code
2173 2726
2174=pod 2727=pod
2175 2728
2176The following functions and methods are available within a safe environment: 2729The following functions and methods are available within a safe environment:
2177 2730
2178 cf::object contr pay_amount pay_player map 2731 cf::object
2732 contr pay_amount pay_player map x y force_find force_add
2733 insert remove name archname title slaying race
2734
2179 cf::object::player player 2735 cf::object::player
2180 cf::player peaceful 2736 player
2181 cf::map trigger 2737
2738 cf::player
2739 peaceful
2740
2741 cf::map
2742 trigger
2182 2743
2183=cut 2744=cut
2184 2745
2185for ( 2746for (
2186 ["cf::object" => qw(contr pay_amount pay_player map)], 2747 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2748 insert remove inv name archname title slaying race)],
2187 ["cf::object::player" => qw(player)], 2749 ["cf::object::player" => qw(player)],
2188 ["cf::player" => qw(peaceful)], 2750 ["cf::player" => qw(peaceful)],
2189 ["cf::map" => qw(trigger)], 2751 ["cf::map" => qw(trigger)],
2190) { 2752) {
2191 no strict 'refs'; 2753 no strict 'refs';
2262=back 2824=back
2263 2825
2264=cut 2826=cut
2265 2827
2266############################################################################# 2828#############################################################################
2267
2268=head2 EXTENSION DATABASE SUPPORT
2269
2270Crossfire maintains a very simple database for extension use. It can
2271currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2272convert to/from binary).
2273
2274The parameter C<$family> should best start with the name of the extension
2275using it, it should be unique.
2276
2277=over 4
2278
2279=item $value = cf::db_get $family => $key
2280
2281Returns a single value from the database.
2282
2283=item cf::db_put $family => $key => $value
2284
2285Stores the given C<$value> in the family.
2286
2287=cut
2288
2289our $DB;
2290
2291sub db_init {
2292 unless ($DB) {
2293 $DB = BDB::db_create $DB_ENV;
2294
2295 cf::sync_job {
2296 eval {
2297 $DB->set_flags (BDB::CHKSUM);
2298
2299 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2300 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2301 cf::cleanup "db_open(db): $!" if $!;
2302 };
2303 cf::cleanup "db_open(db): $@" if $@;
2304 };
2305 }
2306}
2307
2308sub db_get($$) {
2309 my $key = "$_[0]/$_[1]";
2310
2311 cf::sync_job {
2312 BDB::db_get $DB, undef, $key, my $data;
2313
2314 $! ? ()
2315 : $data
2316 }
2317}
2318
2319sub db_put($$$) {
2320 BDB::dbreq_pri 4;
2321 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2322}
2323
2324=item cf::cache $id => [$paths...], $processversion => $process
2325
2326Generic caching function that returns the value of the resource $id,
2327caching and regenerating as required.
2328
2329This function can block.
2330
2331=cut
2332
2333sub cache {
2334 my ($id, $src, $processversion, $process) = @_;
2335
2336 my $meta =
2337 join "\x00",
2338 $processversion,
2339 map {
2340 aio_stat $_
2341 and Carp::croak "$_: $!";
2342
2343 ($_, (stat _)[7,9])
2344 } @$src;
2345
2346 my $dbmeta = db_get cache => "$id/meta";
2347 if ($dbmeta ne $meta) {
2348 # changed, we may need to process
2349
2350 my @data;
2351 my $md5;
2352
2353 for (0 .. $#$src) {
2354 0 <= aio_load $src->[$_], $data[$_]
2355 or Carp::croak "$src->[$_]: $!";
2356 }
2357
2358 # if processing is expensive, check
2359 # checksum first
2360 if (1) {
2361 $md5 =
2362 join "\x00",
2363 $processversion,
2364 map {
2365 Coro::cede;
2366 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2367 } 0.. $#$src;
2368
2369
2370 my $dbmd5 = db_get cache => "$id/md5";
2371 if ($dbmd5 eq $md5) {
2372 db_put cache => "$id/meta", $meta;
2373
2374 return db_get cache => "$id/data";
2375 }
2376 }
2377
2378 my $data = $process->(\@data);
2379
2380 db_put cache => "$id/data", $data;
2381 db_put cache => "$id/md5" , $md5;
2382 db_put cache => "$id/meta", $meta;
2383
2384 return $data;
2385 }
2386
2387 db_get cache => "$id/data"
2388}
2389
2390=item fork_call { }, $args
2391
2392Executes the given code block with the given arguments in a seperate
2393process, returning the results. Everything must be serialisable with
2394Coro::Storable. May, of course, block. Note that the executed sub may
2395never block itself or use any form of Event handling.
2396
2397=cut
2398
2399sub fork_call(&@) {
2400 my ($cb, @args) = @_;
2401
2402# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2403# or die "socketpair: $!";
2404 pipe my $fh1, my $fh2
2405 or die "pipe: $!";
2406
2407 if (my $pid = fork) {
2408 close $fh2;
2409
2410 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2411 $res = Coro::Storable::thaw $res;
2412
2413 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2414
2415 die $$res unless "ARRAY" eq ref $res;
2416
2417 return wantarray ? @$res : $res->[-1];
2418 } else {
2419 local $SIG{__WARN__};
2420 eval {
2421 local $SIG{__DIE__};
2422 close $fh1;
2423
2424 my @res = eval { $cb->(@args) };
2425 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2426 };
2427
2428 warn $@ if $@;
2429 _exit 0;
2430 }
2431}
2432
2433
2434
2435#############################################################################
2436# the server's init and main functions 2829# the server's init and main functions
2437 2830
2438sub load_facedata($) { 2831sub load_facedata($) {
2439 my ($path) = @_; 2832 my ($path) = @_;
2833
2834 my $enc = JSON::XS->new->utf8->canonical;
2440 2835
2441 warn "loading facedata from $path\n"; 2836 warn "loading facedata from $path\n";
2442 2837
2443 my $facedata; 2838 my $facedata;
2444 0 < aio_load $path, $facedata 2839 0 < aio_load $path, $facedata
2447 $facedata = Coro::Storable::thaw $facedata; 2842 $facedata = Coro::Storable::thaw $facedata;
2448 2843
2449 $facedata->{version} == 2 2844 $facedata->{version} == 2
2450 or cf::cleanup "$path: version mismatch, cannot proceed."; 2845 or cf::cleanup "$path: version mismatch, cannot proceed.";
2451 2846
2847 # patch in the exptable
2848 $facedata->{resource}{"res/exp_table"} = {
2849 type => FT_RSRC,
2850 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2851 };
2852 cf::cede_to_tick;
2853
2452 { 2854 {
2453 my $faces = $facedata->{faceinfo}; 2855 my $faces = $facedata->{faceinfo};
2454 2856
2455 while (my ($face, $info) = each %$faces) { 2857 while (my ($face, $info) = each %$faces) {
2456 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2858 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2457 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2859 cf::face::set_visibility $idx, $info->{visibility};
2860 cf::face::set_magicmap $idx, $info->{magicmap};
2458 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2861 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2459 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2862 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2460 Coro::cede; 2863
2864 cf::cede_to_tick;
2461 } 2865 }
2462 2866
2463 while (my ($face, $info) = each %$faces) { 2867 while (my ($face, $info) = each %$faces) {
2464 next unless $info->{smooth}; 2868 next unless $info->{smooth};
2465 my $idx = cf::face::find $face 2869 my $idx = cf::face::find $face
2466 or next; 2870 or next;
2467 if (my $smooth = cf::face::find $info->{smooth}) { 2871 if (my $smooth = cf::face::find $info->{smooth}) {
2872 cf::face::set_smooth $idx, $smooth;
2468 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2873 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2469 } else { 2874 } else {
2470 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2875 warn "smooth face '$info->{smooth}' not found for face '$face'";
2471 } 2876 }
2472 Coro::cede; 2877
2878 cf::cede_to_tick;
2473 } 2879 }
2474 } 2880 }
2475 2881
2476 { 2882 {
2477 my $anims = $facedata->{animinfo}; 2883 my $anims = $facedata->{animinfo};
2478 2884
2479 while (my ($anim, $info) = each %$anims) { 2885 while (my ($anim, $info) = each %$anims) {
2480 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2886 cf::anim::set $anim, $info->{frames}, $info->{facings};
2481 Coro::cede; 2887 cf::cede_to_tick;
2482 } 2888 }
2483 2889
2484 cf::anim::invalidate_all; # d'oh 2890 cf::anim::invalidate_all; # d'oh
2485 } 2891 }
2486 2892
2893 {
2894 # TODO: for gcfclient pleasure, we should give resources
2895 # that gcfclient doesn't grok a >10000 face index.
2896 my $res = $facedata->{resource};
2897
2898 my $soundconf = delete $res->{"res/sound.conf"};
2899
2900 while (my ($name, $info) = each %$res) {
2901 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2902 my $data;
2903
2904 if ($info->{type} & 1) {
2905 # prepend meta info
2906
2907 my $meta = $enc->encode ({
2908 name => $name,
2909 %{ $info->{meta} || {} },
2910 });
2911
2912 $data = pack "(w/a*)*", $meta, $info->{data};
2913 } else {
2914 $data = $info->{data};
2915 }
2916
2917 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2918 cf::face::set_type $idx, $info->{type};
2919
2920 cf::cede_to_tick;
2921 }
2922
2923 if ($soundconf) {
2924 $soundconf = $enc->decode (delete $soundconf->{data});
2925
2926 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2927 my $sound = $soundconf->{compat}[$_]
2928 or next;
2929
2930 my $face = cf::face::find "sound/$sound->[1]";
2931 cf::sound::set $sound->[0] => $face;
2932 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2933 }
2934
2935 while (my ($k, $v) = each %{$soundconf->{event}}) {
2936 my $face = cf::face::find "sound/$v";
2937 cf::sound::set $k => $face;
2938 }
2939 }
2940 }
2941
2487 1 2942 1
2488} 2943}
2489 2944
2945register_exticmd fx_want => sub {
2946 my ($ns, $want) = @_;
2947
2948 while (my ($k, $v) = each %$want) {
2949 $ns->fx_want ($k, $v);
2950 }
2951};
2952
2953sub reload_regions {
2954 load_resource_file "$MAPDIR/regions"
2955 or die "unable to load regions file\n";
2956
2957 for (cf::region::list) {
2958 $_->{match} = qr/$_->{match}/
2959 if exists $_->{match};
2960 }
2961}
2962
2490sub reload_facedata { 2963sub reload_facedata {
2491 load_facedata sprintf "%s/facedata", cf::datadir 2964 load_facedata "$DATADIR/facedata"
2492 or die "unable to load facedata\n"; 2965 or die "unable to load facedata\n";
2493} 2966}
2494 2967
2495sub reload_regions {
2496 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2497 or die "unable to load regions file\n";
2498}
2499
2500sub reload_archetypes { 2968sub reload_archetypes {
2501 load_resource_file sprintf "%s/archetypes", cf::datadir 2969 load_resource_file "$DATADIR/archetypes"
2502 or die "unable to load archetypes\n"; 2970 or die "unable to load archetypes\n";
2971 #d# NEED to laod twice to resolve forward references
2972 # this really needs to be done in an extra post-pass
2973 # (which needs to be synchronous, so solve it differently)
2974 load_resource_file "$DATADIR/archetypes"
2975 or die "unable to load archetypes\n";
2503} 2976}
2504 2977
2505sub reload_treasures { 2978sub reload_treasures {
2506 load_resource_file sprintf "%s/treasures", cf::datadir 2979 load_resource_file "$DATADIR/treasures"
2507 or die "unable to load treasurelists\n"; 2980 or die "unable to load treasurelists\n";
2508} 2981}
2509 2982
2510sub reload_resources { 2983sub reload_resources {
2511 warn "reloading resource files...\n"; 2984 warn "reloading resource files...\n";
2512 2985
2513 reload_regions; 2986 reload_regions;
2514 reload_facedata; 2987 reload_facedata;
2988 #reload_archetypes;#d#
2515 reload_archetypes; 2989 reload_archetypes;
2516 reload_treasures; 2990 reload_treasures;
2517 2991
2518 warn "finished reloading resource files\n"; 2992 warn "finished reloading resource files\n";
2519} 2993}
2521sub init { 2995sub init {
2522 reload_resources; 2996 reload_resources;
2523} 2997}
2524 2998
2525sub cfg_load { 2999sub cfg_load {
2526 open my $fh, "<:utf8", cf::confdir . "/config" 3000 open my $fh, "<:utf8", "$CONFDIR/config"
2527 or return; 3001 or return;
2528 3002
2529 local $/; 3003 local $/;
2530 *CFG = YAML::Syck::Load <$fh>; 3004 *CFG = YAML::Syck::Load <$fh>;
2531 3005
2576 }, 3050 },
2577 ); 3051 );
2578 } 3052 }
2579} 3053}
2580 3054
3055sub write_runtime {
3056 my $runtime = "$LOCALDIR/runtime";
3057
3058 # first touch the runtime file to show we are still running:
3059 # the fsync below can take a very very long time.
3060
3061 IO::AIO::aio_utime $runtime, undef, undef;
3062
3063 my $guard = cf::lock_acquire "write_runtime";
3064
3065 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3066 or return;
3067
3068 my $value = $cf::RUNTIME + 90 + 10;
3069 # 10 is the runtime save interval, for a monotonic clock
3070 # 60 allows for the watchdog to kill the server.
3071
3072 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3073 and return;
3074
3075 # always fsync - this file is important
3076 aio_fsync $fh
3077 and return;
3078
3079 # touch it again to show we are up-to-date
3080 aio_utime $fh, undef, undef;
3081
3082 close $fh
3083 or return;
3084
3085 aio_rename "$runtime~", $runtime
3086 and return;
3087
3088 warn "runtime file written.\n";
3089
3090 1
3091}
3092
2581sub emergency_save() { 3093sub emergency_save() {
2582 my $freeze_guard = cf::freeze_mainloop; 3094 my $freeze_guard = cf::freeze_mainloop;
2583 3095
2584 warn "enter emergency perl save\n"; 3096 warn "enter emergency perl save\n";
2585 3097
2660 %EXT_CORO = (); 3172 %EXT_CORO = ();
2661 3173
2662 warn "removing commands"; 3174 warn "removing commands";
2663 %COMMAND = (); 3175 %COMMAND = ();
2664 3176
2665 warn "removing ext commands"; 3177 warn "removing ext/exti commands";
2666 %EXTCMD = (); 3178 %EXTCMD = ();
3179 %EXTICMD = ();
2667 3180
2668 warn "unloading/nuking all extensions"; 3181 warn "unloading/nuking all extensions";
2669 for my $pkg (@EXTS) { 3182 for my $pkg (@EXTS) {
2670 warn "... unloading $pkg"; 3183 warn "... unloading $pkg";
2671 3184
2789 my $signal = new Coro::Signal; 3302 my $signal = new Coro::Signal;
2790 push @WAIT_FOR_TICK_BEGIN, $signal; 3303 push @WAIT_FOR_TICK_BEGIN, $signal;
2791 $signal->wait; 3304 $signal->wait;
2792} 3305}
2793 3306
3307 my $min = 1e6;#d#
3308 my $avg = 10;
2794$TICK_WATCHER = Event->timer ( 3309$TICK_WATCHER = Event->timer (
2795 reentrant => 0, 3310 reentrant => 0,
2796 parked => 1, 3311 parked => 1,
2797 prio => 0, 3312 prio => 0,
2798 at => $NEXT_TICK || $TICK, 3313 at => $NEXT_TICK || $TICK,
2802 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3317 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2803 unless ++$bug_warning > 10; 3318 unless ++$bug_warning > 10;
2804 return; 3319 return;
2805 } 3320 }
2806 3321
2807 $NOW = Event::time; 3322 $NOW = $tick_start = Event::time;
2808 3323
2809 cf::server_tick; # one server iteration 3324 cf::server_tick; # one server iteration
3325
3326 0 && sync_job {#d#
3327 for(1..10) {
3328 my $t = Event::time;
3329 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3330 or die;
3331
3332 $map->width (50);
3333 $map->height (50);
3334 $map->alloc;
3335 $map->_load_objects ("/tmp/x.map", 1);
3336 my $t = Event::time - $t;
3337
3338 #next unless $t < 0.0013;#d#
3339 if ($t < $min) {
3340 $min = $t;
3341 }
3342 $avg = $avg * 0.99 + $t * 0.01;
3343 }
3344 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3345 exit 0;
3346 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3347 };
2810 3348
2811 $RUNTIME += $TICK; 3349 $RUNTIME += $TICK;
2812 $NEXT_TICK += $TICK; 3350 $NEXT_TICK += $TICK;
2813 3351
2814 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3352 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2820 } 3358 }
2821 3359
2822# my $AFTER = Event::time; 3360# my $AFTER = Event::time;
2823# warn $AFTER - $NOW;#d# 3361# warn $AFTER - $NOW;#d#
2824 3362
3363 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3364 $sig->send;
3365 }
3366 while (my $sig = shift @WAIT_FOR_TICK) {
3367 $sig->send;
3368 }
3369
3370 $NOW = Event::time;
3371
2825 # if we are delayed by four ticks or more, skip them all 3372 # if we are delayed by four ticks or more, skip them all
2826 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3373 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2827 3374
2828 $TICK_WATCHER->at ($NEXT_TICK); 3375 $TICK_WATCHER->at ($NEXT_TICK);
2829 $TICK_WATCHER->start; 3376 $TICK_WATCHER->start;
2830 3377
2831 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3378 $LOAD = ($NOW - $tick_start) / $TICK;
2832 $sig->send; 3379 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2833 }
2834 while (my $sig = shift @WAIT_FOR_TICK) {
2835 $sig->send;
2836 }
2837 3380
2838 _post_tick; 3381 _post_tick;
3382
3383
2839 }, 3384 },
2840); 3385);
2841 3386
2842{ 3387{
2843 BDB::max_poll_time $TICK * 0.1; 3388 BDB::max_poll_time $TICK * 0.1;
2871 3416
2872 cf::sync_job { 3417 cf::sync_job {
2873 eval { 3418 eval {
2874 BDB::db_env_open 3419 BDB::db_env_open
2875 $DB_ENV, 3420 $DB_ENV,
2876 $BDB_ENV_DIR, 3421 $BDBDIR,
2877 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3422 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2878 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3423 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2879 0666; 3424 0666;
2880 3425
2881 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3426 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2882 3427
2883 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3428 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2884 $DB_ENV->set_lk_detect; 3429 $DB_ENV->set_lk_detect;
2885 }; 3430 };
2886 3431
2902 prio => 6, 3447 prio => 6,
2903 cb => \&IO::AIO::poll_cb, 3448 cb => \&IO::AIO::poll_cb,
2904 ); 3449 );
2905} 3450}
2906 3451
3452my $_log_backtrace;
3453
3454sub _log_backtrace {
3455 my ($msg, @addr) = @_;
3456
3457 $msg =~ s/\n//;
3458
3459 # limit the # of concurrent backtraces
3460 if ($_log_backtrace < 2) {
3461 ++$_log_backtrace;
3462 async {
3463 my @bt = fork_call {
3464 @addr = map { sprintf "%x", $_ } @addr;
3465 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3466 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3467 or die "addr2line: $!";
3468
3469 my @funcs;
3470 my @res = <$fh>;
3471 chomp for @res;
3472 while (@res) {
3473 my ($func, $line) = splice @res, 0, 2, ();
3474 push @funcs, "[$func] $line";
3475 }
3476
3477 @funcs
3478 };
3479
3480 LOG llevInfo, "[ABT] $msg\n";
3481 LOG llevInfo, "[ABT] $_\n" for @bt;
3482 --$_log_backtrace;
3483 };
3484 } else {
3485 LOG llevInfo, "[ABT] $msg\n";
3486 LOG llevInfo, "[ABT] [suppressed]\n";
3487 }
3488}
3489
2907# load additional modules 3490# load additional modules
2908use cf::pod; 3491use cf::pod;
2909 3492
2910END { cf::emergency_save } 3493END { cf::emergency_save }
2911 3494

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines