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.334 by root, Mon Aug 20 22:09:04 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
880 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1154 if (my $cb = $EXTCMD{$type}) {
881 if (my %reply = $cb->($pl, $msg)) { 1155 my @reply = $cb->($pl, @payload);
1156
882 $pl->ext_reply ($msg->{msgid}, %reply); 1157 $pl->ext_reply ($reply, @reply)
883 } 1158 if $reply;
884 } 1159 }
885 } else { 1160 } else {
886 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1161 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
887 } 1162 }
888 1163
889 cf::override; 1164 cf::override;
890 }, 1165 },
891); 1166);
892 1167
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 { 1168sub load_extensions {
1169 cf::sync_job {
1170 my %todo;
1171
928 for my $ext (<$LIBDIR/*.ext>) { 1172 for my $path (<$LIBDIR/*.ext>) {
929 next unless -r $ext; 1173 next unless -r $path;
930 eval { 1174
931 load_extension $ext; 1175 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1176 my $base = $1;
1177 my $pkg = $1;
1178 $pkg =~ s/[^[:word:]]/_/g;
1179 $pkg = "ext::$pkg";
1180
1181 open my $fh, "<:utf8", $path
1182 or die "$path: $!";
1183
1184 my $source = do { local $/; <$fh> };
1185
1186 my %ext = (
1187 path => $path,
1188 base => $base,
1189 pkg => $pkg,
1190 );
1191
1192 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1193 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1194
1195 $ext{source} =
1196 "package $pkg; use strict; use utf8;\n"
1197 . "#line 1 \"$path\"\n{\n"
1198 . $source
1199 . "\n};\n1";
1200
1201 $todo{$base} = \%ext;
1202 }
1203
1204 my %done;
1205 while (%todo) {
1206 my $progress;
1207
1208 while (my ($k, $v) = each %todo) {
1209 for (split /,\s*/, $v->{meta}{depends}) {
1210 goto skip
1211 unless exists $done{$_};
1212 }
1213
1214 warn "... loading '$k' into '$v->{pkg}'\n";
1215
1216 unless (eval $v->{source}) {
1217 my $msg = $@ ? "$v->{path}: $@\n"
1218 : "$v->{base}: extension inactive.\n";
1219
1220 if (exists $v->{meta}{mandatory}) {
1221 warn $msg;
1222 warn "mandatory extension failed to load, exiting.\n";
1223 exit 1;
1224 }
1225
1226 warn $msg;
1227 }
1228
1229 $done{$k} = delete $todo{$k};
1230 push @EXTS, $v->{pkg};
1231 $progress = 1;
932 1 1232 }
933 } or warn "$ext not loaded: $@"; 1233
1234 skip:
1235 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1236 unless $progress;
1237 }
934 } 1238 };
935} 1239}
936 1240
937############################################################################# 1241#############################################################################
938 1242
1243=back
1244
939=head2 CORE EXTENSIONS 1245=head2 CORE EXTENSIONS
940 1246
941Functions and methods that extend core crossfire objects. 1247Functions and methods that extend core crossfire objects.
942 1248
943=cut 1249=cut
955Returns the given player object, loading it if necessary (might block). 1261Returns the given player object, loading it if necessary (might block).
956 1262
957=cut 1263=cut
958 1264
959sub playerdir($) { 1265sub playerdir($) {
960 cf::localdir 1266 "$PLAYERDIR/"
961 . "/"
962 . cf::playerdir
963 . "/"
964 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1267 . (ref $_[0] ? $_[0]->ob->name : $_[0])
965} 1268}
966 1269
967sub path($) { 1270sub path($) {
968 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1271 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1032 $cf::PLAYER{$login} = $self; 1335 $cf::PLAYER{$login} = $self;
1033 1336
1034 $self 1337 $self
1035} 1338}
1036 1339
1340=item $player->send_msg ($channel, $msg, $color, [extra...])
1341
1342=cut
1343
1344sub send_msg {
1345 my $ns = shift->ns
1346 or return;
1347 $ns->send_msg (@_);
1348}
1349
1037=item $pl->quit_character 1350=item $pl->quit_character
1038 1351
1039Nukes the player without looking back. If logged in, the connection will 1352Nukes the player without looking back. If logged in, the connection will
1040be destroyed. May block for a long time. 1353be destroyed. May block for a long time.
1041 1354
1088while and may block, so not sync_job-capable, ever. 1401while and may block, so not sync_job-capable, ever.
1089 1402
1090=cut 1403=cut
1091 1404
1092sub list_logins { 1405sub list_logins {
1093 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1406 my $dirs = aio_readdir $PLAYERDIR
1094 or return []; 1407 or return [];
1095 1408
1096 my @logins; 1409 my @logins;
1097 1410
1098 for my $login (@$dirs) { 1411 for my $login (@$dirs) {
1133 } 1446 }
1134 1447
1135 \@paths 1448 \@paths
1136} 1449}
1137 1450
1451=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1452
1453Expand crossfire pod fragments into protocol xml.
1454
1455=cut
1456
1457sub expand_cfpod {
1458 ((my $self), (local $_)) = @_;
1459
1460 # escape & and <
1461 s/&/&amp;/g;
1462 s/(?<![BIUGH])</&lt;/g;
1463
1464 # this is buggy, it needs to properly take care of nested <'s
1465
1466 1 while
1467 # replace B<>, I<>, U<> etc.
1468 s/B<([^\>]*)>/<b>$1<\/b>/
1469 || s/I<([^\>]*)>/<i>$1<\/i>/
1470 || s/U<([^\>]*)>/<u>$1<\/u>/
1471 # replace G<male|female> tags
1472 || s{G<([^>|]*)\|([^>]*)>}{
1473 $self->gender ? $2 : $1
1474 }ge
1475 # replace H<hint text>
1476 || s{H<([^\>]*)>}
1477 {
1478 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1479 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1480 "")
1481 [$self->{hintmode}]
1482 }ge;
1483
1484 # create single paragraphs (very hackish)
1485 s/(?<=\S)\n(?=\w)/ /g;
1486
1487 # compress some whitespace
1488 s/\s+\n/\n/g; # ws line-ends
1489 s/\n\n+/\n/g; # double lines
1490 s/^\n+//; # beginning lines
1491 s/\n+$//; # ending lines
1492
1493 $_
1494}
1495
1496sub hintmode {
1497 $_[0]{hintmode} = $_[1] if @_ > 1;
1498 $_[0]{hintmode}
1499}
1500
1138=item $player->ext_reply ($msgid, %msg) 1501=item $player->ext_reply ($msgid, @msg)
1139 1502
1140Sends an ext reply to the player. 1503Sends an ext reply to the player.
1141 1504
1142=cut 1505=cut
1143 1506
1144sub ext_reply($$%) { 1507sub ext_reply($$@) {
1145 my ($self, $id, %msg) = @_; 1508 my ($self, $id, @msg) = @_;
1146 1509
1147 $msg{msgid} = $id; 1510 if ($self->ns->extcmd == 2) {
1148 1511 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1149 $self->send ("ext " . cf::to_json \%msg); 1512 } elsif ($self->ns->extcmd == 1) {
1513 #TODO: version 1, remove
1514 unshift @msg, msgtype => "reply", msgid => $id;
1515 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1516 }
1150} 1517}
1151 1518
1152=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1153 1520
1154Sends an ext event to the client. 1521Sends an ext event to the client.
1155 1522
1156=cut 1523=cut
1157 1524
1158sub ext_event($$%) { 1525sub ext_msg($$@) {
1159 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1160 1527
1161 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1162} 1529}
1163 1530
1164=head3 cf::region 1531=head3 cf::region
1165 1532
1166=over 4 1533=over 4
1169 1536
1170package cf::region; 1537package cf::region;
1171 1538
1172=item cf::region::find_by_path $path 1539=item cf::region::find_by_path $path
1173 1540
1174Tries to decuce the probable region for a map knowing only its path. 1541Tries to decuce the likely region for a map knowing only its path.
1175 1542
1176=cut 1543=cut
1177 1544
1178sub find_by_path($) { 1545sub find_by_path($) {
1179 my ($path) = @_; 1546 my ($path) = @_;
1180 1547
1181 my ($match, $specificity); 1548 my ($match, $specificity);
1182 1549
1183 for my $region (list) { 1550 for my $region (list) {
1184 if ($region->match && $path =~ $region->match) { 1551 if ($region->{match} && $path =~ $region->{match}) {
1185 ($match, $specificity) = ($region, $region->specificity) 1552 ($match, $specificity) = ($region, $region->specificity)
1186 if $region->specificity > $specificity; 1553 if $region->specificity > $specificity;
1187 } 1554 }
1188 } 1555 }
1189 1556
1253 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1254 1621
1255 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1256 local $self->{path}; 1623 local $self->{path};
1257 local $self->{load_path}; 1624 local $self->{load_path};
1258 local $self->{deny_save};
1259 local $self->{deny_reset};
1260 1625
1261 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1262} 1627}
1263 1628
1264sub normalise { 1629sub normalise {
1311 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1312 return $self; 1677 return $self;
1313 } 1678 }
1314 } 1679 }
1315 1680
1316 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1317 () 1682 ()
1318} 1683}
1319 1684
1320sub init { 1685sub init {
1321 my ($self) = @_; 1686 my ($self) = @_;
1336 1701
1337# the original (read-only) location 1702# the original (read-only) location
1338sub load_path { 1703sub load_path {
1339 my ($self) = @_; 1704 my ($self) = @_;
1340 1705
1341 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1342} 1707}
1343 1708
1344# the temporary/swap location 1709# the temporary/swap location
1345sub save_path { 1710sub save_path {
1346 my ($self) = @_; 1711 my ($self) = @_;
1347 1712
1348 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1349 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1350} 1715}
1351 1716
1352# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1353sub uniq_path { 1718sub uniq_path {
1354 my ($self) = @_; 1719 my ($self) = @_;
1355 1720
1356 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1357 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1358} 1723}
1359 1724
1360# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1361# all maps in C++... 1726# all maps in C++...
1362sub change_all_map_light { 1727sub change_all_map_light {
1363 my ($change) = @_; 1728 my ($change) = @_;
1364 1729
1365 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1366 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1732}
1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1367} 1740}
1368 1741
1369sub unlink_save { 1742sub unlink_save {
1370 my ($self) = @_; 1743 my ($self) = @_;
1371 1744
1429 $self->load_header_orig 1802 $self->load_header_orig
1430 or return; 1803 or return;
1431 $self->prepare_orig; 1804 $self->prepare_orig;
1432 } 1805 }
1433 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1434 $self->default_region (cf::region::find_by_path $self->{path}) 1810 $self->default_region (cf::region::find_by_path $self->{path})
1435 unless $self->default_region; 1811 unless $self->default_region;
1436 1812
1437 1 1813 1
1438} 1814}
1453 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1454 1830
1455 $map->load_header 1831 $map->load_header
1456 or return; 1832 or return;
1457 1833
1458 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1460 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1461 $map->reset; 1837 $map->reset;
1462 undef $guard; 1838 undef $guard;
1463 return find $path; 1839 return find $path;
1474 my ($self) = @_; 1850 my ($self) = @_;
1475 1851
1476 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1477 1853
1478 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1479 my $guard = cf::lock_acquire "map_load:$path"; 1857 my $guard = cf::lock_acquire "map_load:$path";
1480 1858
1481 return if $self->in_memory != cf::MAP_SWAPPED; 1859 return if $self->in_memory != cf::MAP_SWAPPED;
1482 1860
1483 $self->in_memory (cf::MAP_LOADING); 1861 $self->in_memory (cf::MAP_LOADING);
1484 1862
1485 $self->alloc; 1863 $self->alloc;
1486 1864
1487 $self->pre_load; 1865 $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; 1866 Coro::cede;
1514 $self->set_darkness_map; 1867
1868 $self->_load_objects ($self->{load_path}, 1)
1869 or return;
1870
1871 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1872 if delete $self->{load_original};
1873
1874 if (my $uniq = $self->uniq_path) {
1875 utf8::encode $uniq;
1876 if (aio_open $uniq, O_RDONLY, 0) {
1877 $self->clear_unique_items;
1878 $self->_load_objects ($uniq, 0);
1879 }
1880 }
1881
1882 Coro::cede;
1883 # now do the right thing for maps
1884 $self->link_multipart_objects;
1515 $self->difficulty ($self->estimate_difficulty) 1885 $self->difficulty ($self->estimate_difficulty)
1516 unless $self->difficulty; 1886 unless $self->difficulty;
1517 Coro::cede; 1887 Coro::cede;
1888
1889 unless ($self->{deny_activate}) {
1890 $self->decay_objects;
1891 $self->fix_auto_apply;
1892 $self->update_buttons;
1893 Coro::cede;
1894 $self->set_darkness_map;
1895 Coro::cede;
1518 $self->activate; 1896 $self->activate;
1519 Coro::cede; 1897 }
1898
1899 $self->{last_save} = $cf::RUNTIME;
1900 $self->last_access ($cf::RUNTIME);
1901
1902 $self->in_memory (cf::MAP_IN_MEMORY);
1520 } 1903 }
1521 1904
1522 $self->post_load; 1905 $self->post_load;
1523 Coro::cede;
1524
1525 $self->in_memory (cf::MAP_IN_MEMORY);
1526} 1906}
1527 1907
1528sub customise_for { 1908sub customise_for {
1529 my ($self, $ob) = @_; 1909 my ($self, $ob) = @_;
1530 1910
1531 return find "~" . $ob->name . "/" . $self->{path} 1911 return find "~" . $ob->name . "/" . $self->{path}
1532 if $self->per_player; 1912 if $self->per_player;
1533 1913
1914# return find "?party/" . $ob->name . "/" . $self->{path}
1915# if $self->per_party;
1916
1534 $self 1917 $self
1535} 1918}
1536 1919
1537# find and load all maps in the 3x3 area around a map 1920# find and load all maps in the 3x3 area around a map
1538sub load_diag { 1921sub load_neighbours {
1539 my ($map) = @_; 1922 my ($map) = @_;
1540 1923
1541 my @diag; # diagonal neighbours 1924 my @neigh; # diagonal neighbours
1542 1925
1543 for (0 .. 3) { 1926 for (0 .. 3) {
1544 my $neigh = $map->tile_path ($_) 1927 my $neigh = $map->tile_path ($_)
1545 or next; 1928 or next;
1546 $neigh = find $neigh, $map 1929 $neigh = find $neigh, $map
1547 or next; 1930 or next;
1548 $neigh->load; 1931 $neigh->load;
1549 1932
1933 push @neigh,
1550 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1934 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1551 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1935 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1552 } 1936 }
1553 1937
1554 for (@diag) { 1938 for (grep defined $_->[0], @neigh) {
1939 my ($path, $origin) = @$_;
1555 my $neigh = find @$_ 1940 my $neigh = find $path, $origin
1556 or next; 1941 or next;
1557 $neigh->load; 1942 $neigh->load;
1558 } 1943 }
1559} 1944}
1560 1945
1584 1969
1585 undef $MAP_PREFETCH{$path}; 1970 undef $MAP_PREFETCH{$path};
1586 $MAP_PREFETCHER ||= cf::async { 1971 $MAP_PREFETCHER ||= cf::async {
1587 while (%MAP_PREFETCH) { 1972 while (%MAP_PREFETCH) {
1588 for my $path (keys %MAP_PREFETCH) { 1973 for my $path (keys %MAP_PREFETCH) {
1589 my $map = find $path 1974 if (my $map = find $path) {
1590 or next;
1591 $map->load; 1975 $map->load;
1976 }
1592 1977
1593 delete $MAP_PREFETCH{$path}; 1978 delete $MAP_PREFETCH{$path};
1594 } 1979 }
1595 } 1980 }
1596 undef $MAP_PREFETCHER; 1981 undef $MAP_PREFETCHER;
1648 2033
1649sub reset_at { 2034sub reset_at {
1650 my ($self) = @_; 2035 my ($self) = @_;
1651 2036
1652 # TODO: safety, remove and allow resettable per-player maps 2037 # 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}; 2038 return 1e99 if $self->{deny_reset};
1655 2039
1656 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2040 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1657 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2041 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1658 2042
1669 my ($self) = @_; 2053 my ($self) = @_;
1670 2054
1671 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2055 my $lock = cf::lock_acquire "map_data:$self->{path}";
1672 2056
1673 return if $self->players; 2057 return if $self->players;
1674 return if $self->isa ("ext::map_per_player");#d#
1675 2058
1676 warn "resetting map ", $self->path;#d# 2059 warn "resetting map ", $self->path;
1677 2060
1678 $self->in_memory (cf::MAP_SWAPPED); 2061 $self->in_memory (cf::MAP_SWAPPED);
1679 2062
1680 # need to save uniques path 2063 # need to save uniques path
1681 unless ($self->{deny_save}) { 2064 unless ($self->{deny_save}) {
1713 $cf::MAP{$self->path} = $self; 2096 $cf::MAP{$self->path} = $self;
1714 2097
1715 $self->reset; # polite request, might not happen 2098 $self->reset; # polite request, might not happen
1716} 2099}
1717 2100
2101=item $maps = cf::map::tmp_maps
2102
2103Returns an arrayref with all map paths of currently instantiated and saved
2104maps. May block.
2105
2106=cut
2107
2108sub tmp_maps() {
2109 [
2110 map {
2111 utf8::decode $_;
2112 /\.map$/
2113 ? normalise $_
2114 : ()
2115 } @{ aio_readdir $TMPDIR or [] }
2116 ]
2117}
2118
2119=item $maps = cf::map::random_maps
2120
2121Returns an arrayref with all map paths of currently instantiated and saved
2122random maps. May block.
2123
2124=cut
2125
2126sub random_maps() {
2127 [
2128 map {
2129 utf8::decode $_;
2130 /\.map$/
2131 ? normalise "?random/$_"
2132 : ()
2133 } @{ aio_readdir $RANDOMDIR or [] }
2134 ]
2135}
2136
1718=item cf::map::unique_maps 2137=item cf::map::unique_maps
1719 2138
1720Returns an arrayref of paths of all shared maps that have 2139Returns an arrayref of paths of all shared maps that have
1721instantiated unique items. May block. 2140instantiated unique items. May block.
1722 2141
1723=cut 2142=cut
1724 2143
1725sub unique_maps() { 2144sub unique_maps() {
1726 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2145 [
1727 or return; 2146 map {
1728
1729 my @paths;
1730
1731 for (@$files) {
1732 utf8::decode $_; 2147 utf8::decode $_;
1733 next if /\.pst$/; 2148 /\.map$/
1734 next unless /^$PATH_SEP/o; 2149 ? normalise $_
1735 2150 : ()
1736 push @paths, cf::map::normalise $_; 2151 } @{ aio_readdir $UNIQUEDIR or [] }
1737 } 2152 ]
1738
1739 \@paths
1740} 2153}
1741 2154
1742package cf; 2155package cf;
1743 2156
1744=back 2157=back
1790 2203
1791 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2204 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1792 2205
1793 if ($self->{record_replies}) { 2206 if ($self->{record_replies}) {
1794 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2207 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2208
1795 } else { 2209 } else {
2210 my $pl = $self->contr;
2211
2212 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2213 my $dialog = $pl->{npc_dialog};
2214 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2215
2216 } else {
1796 $msg = $npc->name . " says: $msg" if $npc; 2217 $msg = $npc->name . " says: $msg" if $npc;
1797 $self->message ($msg, $flags); 2218 $self->message ($msg, $flags);
2219 }
1798 } 2220 }
2221}
2222
2223=item $object->send_msg ($channel, $msg, $color, [extra...])
2224
2225=cut
2226
2227sub cf::object::send_msg {
2228 my $pl = shift->contr
2229 or return;
2230 $pl->send_msg (@_);
1799} 2231}
1800 2232
1801=item $player_object->may ("access") 2233=item $player_object->may ("access")
1802 2234
1803Returns wether the given player is authorized to access resource "access" 2235Returns wether the given player is authorized to access resource "access"
1850 $self->deactivate_recursive; 2282 $self->deactivate_recursive;
1851 2283
1852 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2284 return if UNIVERSAL::isa $self->map, "ext::map_link";
1853 2285
1854 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2286 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1855 if $self->map; 2287 if $self->map && $self->map->{path} ne "{link}";
1856 2288
1857 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2289 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1858} 2290}
1859 2291
1860sub cf::object::player::leave_link { 2292sub cf::object::player::leave_link {
1861 my ($self, $map, $x, $y) = @_; 2293 my ($self, $map, $x, $y) = @_;
2294
2295 return unless $self->contr->active;
1862 2296
1863 my $link_pos = delete $self->{_link_pos}; 2297 my $link_pos = delete $self->{_link_pos};
1864 2298
1865 unless ($map) { 2299 unless ($map) {
1866 # restore original map position 2300 # restore original map position
1880 # use -1 or undef as default coordinates, not 0, 0 2314 # use -1 or undef as default coordinates, not 0, 0
1881 ($x, $y) = ($map->enter_x, $map->enter_y) 2315 ($x, $y) = ($map->enter_x, $map->enter_y)
1882 if $x <=0 && $y <= 0; 2316 if $x <=0 && $y <= 0;
1883 2317
1884 $map->load; 2318 $map->load;
1885 $map->load_diag; 2319 $map->load_neighbours;
1886 2320
1887 return unless $self->contr->active; 2321 return unless $self->contr->active;
1888 $self->activate_recursive; 2322 $self->activate_recursive;
1889 2323
1890 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1891 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1892} 2326}
1893 2327
1894cf::player->attach ( 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1895 on_logout => sub {
1896 my ($pl) = @_;
1897 2329
1898 # abort map switching before logout 2330Moves the player to the given map-path and coordinates by first freezing
1899 if ($pl->ob->{_link_pos}) { 2331her, loading and preparing them map, calling the provided $check callback
1900 cf::sync_job { 2332that has to return the map if sucecssful, and then unfreezes the player on
1901 $pl->ob->leave_link 2333the new (success) or old (failed) map position. In either case, $done will
1902 }; 2334be called at the end of this process.
1903 }
1904 },
1905 on_login => sub {
1906 my ($pl) = @_;
1907 2335
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 2336=cut
2337
2338our $GOTOGEN;
1929 2339
1930sub cf::object::player::goto { 2340sub cf::object::player::goto {
1931 my ($self, $path, $x, $y) = @_; 2341 my ($self, $path, $x, $y, $check, $done) = @_;
2342
2343 # do generation counting so two concurrent goto's will be executed in-order
2344 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1932 2345
1933 $self->enter_link; 2346 $self->enter_link;
1934 2347
1935 (async { 2348 (async {
1936 my $map = eval { 2349 my $map = eval {
1937 my $map = cf::map::find $path; 2350 my $map = cf::map::find $path;
2351
2352 if ($map) {
1938 $map = $map->customise_for ($self) if $map; 2353 $map = $map->customise_for ($self);
2354 $map = $check->($map) if $check && $map;
2355 } else {
2356 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2357 }
2358
1939 $map 2359 $map
2360 };
2361
2362 if ($@) {
2363 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2364 LOG llevError | logBacktrace, Carp::longmess $@;
1940 } or 2365 }
1941 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1942 2366
2367 if ($gen == $self->{_goto_generation}) {
2368 delete $self->{_goto_generation};
1943 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
2370 }
2371
2372 $done->() if $done;
1944 })->prio (1); 2373 })->prio (1);
1945} 2374}
1946 2375
1947=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1948 2377
1987 2416
1988 $rmp->{random_seed} ||= $exit->random_seed; 2417 $rmp->{random_seed} ||= $exit->random_seed;
1989 2418
1990 my $data = cf::to_json $rmp; 2419 my $data = cf::to_json $rmp;
1991 my $md5 = Digest::MD5::md5_hex $data; 2420 my $md5 = Digest::MD5::md5_hex $data;
1992 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2421 my $meta = "$RANDOMDIR/$md5.meta";
1993 2422
1994 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2423 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1995 aio_write $fh, 0, (length $data), $data, 0; 2424 aio_write $fh, 0, (length $data), $data, 0;
1996 undef $fh; 2425 undef $fh;
1997 aio_rename "$meta~", $meta; 2426 aio_rename "$meta~", $meta;
2016 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2445 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2017 my $hp = $exit->stats->hp; 2446 my $hp = $exit->stats->hp;
2018 my $sp = $exit->stats->sp; 2447 my $sp = $exit->stats->sp;
2019 2448
2020 $self->enter_link; 2449 $self->enter_link;
2450
2451 # if exit is damned, update players death & WoR home-position
2452 $self->contr->savebed ($slaying, $hp, $sp)
2453 if $exit->flag (FLAG_DAMNED);
2021 2454
2022 (async { 2455 (async {
2023 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
2024 unless (eval { 2457 unless (eval {
2025 $self->goto ($slaying, $hp, $sp); 2458 $self->goto ($slaying, $hp, $sp);
2053 2486
2054 utf8::encode $text; 2487 utf8::encode $text;
2055 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2056} 2489}
2057 2490
2491=item $client->send_msg ($channel, $msg, $color, [extra...])
2492
2493Send a drawinfo or msg packet to the client, formatting the msg for the
2494client if neccessary. C<$type> should be a string identifying the type of
2495the message, with C<log> being the default. If C<$color> is negative, suppress
2496the message unless the client supports the msg packet.
2497
2498=cut
2499
2500sub cf::client::send_msg {
2501 my ($self, $channel, $msg, $color, @extra) = @_;
2502
2503 $msg = $self->pl->expand_cfpod ($msg);
2504
2505 $color &= cf::NDI_CLIENT_MASK; # just in case...
2506
2507 if (ref $channel) {
2508 # send meta info to client, if not yet sent
2509 unless (exists $self->{channel}{$channel->{id}}) {
2510 $self->{channel}{$channel->{id}} = $channel;
2511 $self->ext_msg (channel_info => $channel);
2512 }
2513
2514 $channel = $channel->{id};
2515 }
2516
2517 return unless @extra || length $msg;
2518
2519 if ($self->can_msg) {
2520 # default colour, mask it out
2521 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2522 if $color & cf::NDI_DEF;
2523
2524 $self->send_packet ("msg " . $self->{json_coder}->encode (
2525 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2526 } else {
2527 if ($color >= 0) {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 $color &= cf::NDI_COLOR_MASK;
2539
2540 utf8::encode $msg;
2541
2542 if (0 && $msg =~ /\[/) {
2543 # COMMAND/INFO
2544 $self->send_packet ("drawextinfo $color 10 8 $msg")
2545 } else {
2546 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2547 $self->send_packet ("drawinfo $color $msg")
2548 }
2549 }
2550 }
2551}
2552
2058=item $client->ext_event ($type, %msg) 2553=item $client->ext_msg ($type, @msg)
2059 2554
2060Sends an exti event to the client. 2555Sends an ext event to the client.
2061 2556
2062=cut 2557=cut
2063 2558
2064sub cf::client::ext_event($$%) { 2559sub cf::client::ext_msg($$@) {
2065 my ($self, $type, %msg) = @_; 2560 my ($self, $type, @msg) = @_;
2066 2561
2562 my $extcmd = $self->extcmd;
2563
2564 if ($extcmd == 2) {
2565 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2566 } elsif ($extcmd == 1) { # TODO: remove
2067 $msg{msgtype} = "event_$type"; 2567 push @msg, msgtype => "event_$type";
2068 $self->send_packet ("ext " . cf::to_json \%msg); 2568 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2569 }
2069} 2570}
2070 2571
2071=item $success = $client->query ($flags, "text", \&cb) 2572=item $success = $client->query ($flags, "text", \&cb)
2072 2573
2073Queues a query to the client, calling the given callback with 2574Queues a query to the client, calling the given callback with
2074the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2575the 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>. 2576C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2076 2577
2077Queries can fail, so check the return code. Or don't, as queries will become 2578Queries can fail, so check the return code. Or don't, as queries will
2078reliable at some point in the future. 2579become reliable at some point in the future.
2079 2580
2080=cut 2581=cut
2081 2582
2082sub cf::client::query { 2583sub cf::client::query {
2083 my ($self, $flags, $text, $cb) = @_; 2584 my ($self, $flags, $text, $cb) = @_;
2091 utf8::encode $text; 2592 utf8::encode $text;
2092 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2593 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2093 2594
2094 $self->send_packet ($self->{query_queue}[0][0]) 2595 $self->send_packet ($self->{query_queue}[0][0])
2095 if @{ $self->{query_queue} } == 1; 2596 if @{ $self->{query_queue} } == 1;
2597
2598 1
2096} 2599}
2097 2600
2098cf::client->attach ( 2601cf::client->attach (
2602 on_connect => sub {
2603 my ($ns) = @_;
2604
2605 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2606 },
2099 on_reply => sub { 2607 on_reply => sub {
2100 my ($ns, $msg) = @_; 2608 my ($ns, $msg) = @_;
2101 2609
2102 # this weird shuffling is so that direct followup queries 2610 # this weird shuffling is so that direct followup queries
2103 # get handled first 2611 # get handled first
2115 } else { 2623 } else {
2116 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2624 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2117 } 2625 }
2118 } 2626 }
2119 }, 2627 },
2628 on_exticmd => sub {
2629 my ($ns, $buf) = @_;
2630
2631 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2632
2633 if (ref $msg) {
2634 my ($type, $reply, @payload) =
2635 "ARRAY" eq ref $msg
2636 ? @$msg
2637 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2638
2639 if (my $cb = $EXTICMD{$type}) {
2640 my @reply = $cb->($ns, @payload);
2641
2642 $ns->ext_reply ($reply, @reply)
2643 if $reply;
2644 }
2645 } else {
2646 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2647 }
2648
2649 cf::override;
2650 },
2120); 2651);
2121 2652
2122=item $client->async (\&cb) 2653=item $client->async (\&cb)
2123 2654
2124Create a new coroutine, running the specified callback. The coroutine will 2655Create a new coroutine, running the specified callback. The coroutine will
2165our $safe = new Safe "safe"; 2696our $safe = new Safe "safe";
2166our $safe_hole = new Safe::Hole; 2697our $safe_hole = new Safe::Hole;
2167 2698
2168$SIG{FPE} = 'IGNORE'; 2699$SIG{FPE} = 'IGNORE';
2169 2700
2170$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2701$safe->permit_only (Opcode::opset qw(
2702 :base_core :base_mem :base_orig :base_math
2703 grepstart grepwhile mapstart mapwhile
2704 sort time
2705));
2171 2706
2172# here we export the classes and methods available to script code 2707# here we export the classes and methods available to script code
2173 2708
2174=pod 2709=pod
2175 2710
2176The following functions and methods are available within a safe environment: 2711The following functions and methods are available within a safe environment:
2177 2712
2178 cf::object contr pay_amount pay_player map 2713 cf::object
2714 contr pay_amount pay_player map x y force_find force_add
2715 insert remove name archname title slaying race
2716
2179 cf::object::player player 2717 cf::object::player
2180 cf::player peaceful 2718 player
2181 cf::map trigger 2719
2720 cf::player
2721 peaceful
2722
2723 cf::map
2724 trigger
2182 2725
2183=cut 2726=cut
2184 2727
2185for ( 2728for (
2186 ["cf::object" => qw(contr pay_amount pay_player map)], 2729 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2730 insert remove inv name archname title slaying race)],
2187 ["cf::object::player" => qw(player)], 2731 ["cf::object::player" => qw(player)],
2188 ["cf::player" => qw(peaceful)], 2732 ["cf::player" => qw(peaceful)],
2189 ["cf::map" => qw(trigger)], 2733 ["cf::map" => qw(trigger)],
2190) { 2734) {
2191 no strict 'refs'; 2735 no strict 'refs';
2262=back 2806=back
2263 2807
2264=cut 2808=cut
2265 2809
2266############################################################################# 2810#############################################################################
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 2811# the server's init and main functions
2437 2812
2438sub load_facedata($) { 2813sub load_facedata($) {
2439 my ($path) = @_; 2814 my ($path) = @_;
2815
2816 my $enc = JSON::XS->new->utf8->canonical;
2440 2817
2441 warn "loading facedata from $path\n"; 2818 warn "loading facedata from $path\n";
2442 2819
2443 my $facedata; 2820 my $facedata;
2444 0 < aio_load $path, $facedata 2821 0 < aio_load $path, $facedata
2447 $facedata = Coro::Storable::thaw $facedata; 2824 $facedata = Coro::Storable::thaw $facedata;
2448 2825
2449 $facedata->{version} == 2 2826 $facedata->{version} == 2
2450 or cf::cleanup "$path: version mismatch, cannot proceed."; 2827 or cf::cleanup "$path: version mismatch, cannot proceed.";
2451 2828
2829 # patch in the exptable
2830 cf::cede_to_tick;
2831 $facedata->{resource}{"res/exp_table"} = {
2832 type => FT_RSRC,
2833 data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
2834 };
2835 cf::cede_to_tick;
2836
2452 { 2837 {
2453 my $faces = $facedata->{faceinfo}; 2838 my $faces = $facedata->{faceinfo};
2454 2839
2455 while (my ($face, $info) = each %$faces) { 2840 while (my ($face, $info) = each %$faces) {
2456 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2841 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2457 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2842 cf::face::set_visibility $idx, $info->{visibility};
2843 cf::face::set_magicmap $idx, $info->{magicmap};
2458 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2844 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2459 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2845 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2460 Coro::cede; 2846
2847 cf::cede_to_tick;
2461 } 2848 }
2462 2849
2463 while (my ($face, $info) = each %$faces) { 2850 while (my ($face, $info) = each %$faces) {
2464 next unless $info->{smooth}; 2851 next unless $info->{smooth};
2465 my $idx = cf::face::find $face 2852 my $idx = cf::face::find $face
2466 or next; 2853 or next;
2467 if (my $smooth = cf::face::find $info->{smooth}) { 2854 if (my $smooth = cf::face::find $info->{smooth}) {
2855 cf::face::set_smooth $idx, $smooth;
2468 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2856 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2469 } else { 2857 } else {
2470 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2858 warn "smooth face '$info->{smooth}' not found for face '$face'";
2471 } 2859 }
2472 Coro::cede; 2860
2861 cf::cede_to_tick;
2473 } 2862 }
2474 } 2863 }
2475 2864
2476 { 2865 {
2477 my $anims = $facedata->{animinfo}; 2866 my $anims = $facedata->{animinfo};
2478 2867
2479 while (my ($anim, $info) = each %$anims) { 2868 while (my ($anim, $info) = each %$anims) {
2480 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2869 cf::anim::set $anim, $info->{frames}, $info->{facings};
2481 Coro::cede; 2870 cf::cede_to_tick;
2482 } 2871 }
2483 2872
2484 cf::anim::invalidate_all; # d'oh 2873 cf::anim::invalidate_all; # d'oh
2485 } 2874 }
2486 2875
2876 {
2877 # TODO: for gcfclient pleasure, we should give resources
2878 # that gcfclient doesn't grok a >10000 face index.
2879 my $res = $facedata->{resource};
2880
2881 my $soundconf = delete $res->{"res/sound.conf"};
2882
2883 while (my ($name, $info) = each %$res) {
2884 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2885 my $data;
2886
2887 if ($info->{type} & 1) {
2888 # prepend meta info
2889
2890 my $meta = $enc->encode ({
2891 name => $name,
2892 %{ $info->{meta} || {} },
2893 });
2894
2895 $data = pack "(w/a*)*", $meta, $info->{data};
2896 }
2897
2898 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2899 cf::face::set_type $idx, $info->{type};
2900
2901 cf::cede_to_tick;
2902 }
2903
2904 if ($soundconf) {
2905 $soundconf = $enc->decode (delete $soundconf->{data});
2906
2907 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2908 my $sound = $soundconf->{compat}[$_]
2909 or next;
2910
2911 my $face = cf::face::find "sound/$sound->[1]";
2912 cf::sound::set $sound->[0] => $face;
2913 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2914 }
2915
2916 while (my ($k, $v) = each %{$soundconf->{event}}) {
2917 my $face = cf::face::find "sound/$v";
2918 cf::sound::set $k => $face;
2919 }
2920 }
2921 }
2922
2487 1 2923 1
2488} 2924}
2489 2925
2926register_exticmd fx_want => sub {
2927 my ($ns, $want) = @_;
2928
2929 while (my ($k, $v) = each %$want) {
2930 $ns->fx_want ($k, $v);
2931 }
2932};
2933
2934sub reload_regions {
2935 load_resource_file "$MAPDIR/regions"
2936 or die "unable to load regions file\n";
2937
2938 for (cf::region::list) {
2939 $_->{match} = qr/$_->{match}/
2940 if exists $_->{match};
2941 }
2942}
2943
2490sub reload_facedata { 2944sub reload_facedata {
2491 load_facedata sprintf "%s/facedata", cf::datadir 2945 load_facedata "$DATADIR/facedata"
2492 or die "unable to load facedata\n"; 2946 or die "unable to load facedata\n";
2493} 2947}
2494 2948
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 { 2949sub reload_archetypes {
2501 load_resource_file sprintf "%s/archetypes", cf::datadir 2950 load_resource_file "$DATADIR/archetypes"
2502 or die "unable to load archetypes\n"; 2951 or die "unable to load archetypes\n";
2952 #d# NEED to laod twice to resolve forward references
2953 # this really needs to be done in an extra post-pass
2954 # (which needs to be synchronous, so solve it differently)
2955 load_resource_file "$DATADIR/archetypes"
2956 or die "unable to load archetypes\n";
2503} 2957}
2504 2958
2505sub reload_treasures { 2959sub reload_treasures {
2506 load_resource_file sprintf "%s/treasures", cf::datadir 2960 load_resource_file "$DATADIR/treasures"
2507 or die "unable to load treasurelists\n"; 2961 or die "unable to load treasurelists\n";
2508} 2962}
2509 2963
2510sub reload_resources { 2964sub reload_resources {
2511 warn "reloading resource files...\n"; 2965 warn "reloading resource files...\n";
2512 2966
2513 reload_regions; 2967 reload_regions;
2514 reload_facedata; 2968 reload_facedata;
2969 #reload_archetypes;#d#
2515 reload_archetypes; 2970 reload_archetypes;
2516 reload_treasures; 2971 reload_treasures;
2517 2972
2518 warn "finished reloading resource files\n"; 2973 warn "finished reloading resource files\n";
2519} 2974}
2521sub init { 2976sub init {
2522 reload_resources; 2977 reload_resources;
2523} 2978}
2524 2979
2525sub cfg_load { 2980sub cfg_load {
2526 open my $fh, "<:utf8", cf::confdir . "/config" 2981 open my $fh, "<:utf8", "$CONFDIR/config"
2527 or return; 2982 or return;
2528 2983
2529 local $/; 2984 local $/;
2530 *CFG = YAML::Syck::Load <$fh>; 2985 *CFG = YAML::Syck::Load <$fh>;
2531 2986
2576 }, 3031 },
2577 ); 3032 );
2578 } 3033 }
2579} 3034}
2580 3035
3036sub write_runtime {
3037 my $runtime = "$LOCALDIR/runtime";
3038
3039 # first touch the runtime file to show we are still running:
3040 # the fsync below can take a very very long time.
3041
3042 IO::AIO::aio_utime $runtime, undef, undef;
3043
3044 my $guard = cf::lock_acquire "write_runtime";
3045
3046 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3047 or return;
3048
3049 my $value = $cf::RUNTIME + 90 + 10;
3050 # 10 is the runtime save interval, for a monotonic clock
3051 # 60 allows for the watchdog to kill the server.
3052
3053 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3054 and return;
3055
3056 # always fsync - this file is important
3057 aio_fsync $fh
3058 and return;
3059
3060 # touch it again to show we are up-to-date
3061 aio_utime $fh, undef, undef;
3062
3063 close $fh
3064 or return;
3065
3066 aio_rename "$runtime~", $runtime
3067 and return;
3068
3069 warn "runtime file written.\n";
3070
3071 1
3072}
3073
2581sub emergency_save() { 3074sub emergency_save() {
2582 my $freeze_guard = cf::freeze_mainloop; 3075 my $freeze_guard = cf::freeze_mainloop;
2583 3076
2584 warn "enter emergency perl save\n"; 3077 warn "enter emergency perl save\n";
2585 3078
2660 %EXT_CORO = (); 3153 %EXT_CORO = ();
2661 3154
2662 warn "removing commands"; 3155 warn "removing commands";
2663 %COMMAND = (); 3156 %COMMAND = ();
2664 3157
2665 warn "removing ext commands"; 3158 warn "removing ext/exti commands";
2666 %EXTCMD = (); 3159 %EXTCMD = ();
3160 %EXTICMD = ();
2667 3161
2668 warn "unloading/nuking all extensions"; 3162 warn "unloading/nuking all extensions";
2669 for my $pkg (@EXTS) { 3163 for my $pkg (@EXTS) {
2670 warn "... unloading $pkg"; 3164 warn "... unloading $pkg";
2671 3165
2789 my $signal = new Coro::Signal; 3283 my $signal = new Coro::Signal;
2790 push @WAIT_FOR_TICK_BEGIN, $signal; 3284 push @WAIT_FOR_TICK_BEGIN, $signal;
2791 $signal->wait; 3285 $signal->wait;
2792} 3286}
2793 3287
3288 my $min = 1e6;#d#
3289 my $avg = 10;
2794$TICK_WATCHER = Event->timer ( 3290$TICK_WATCHER = Event->timer (
2795 reentrant => 0, 3291 reentrant => 0,
2796 parked => 1, 3292 parked => 1,
2797 prio => 0, 3293 prio => 0,
2798 at => $NEXT_TICK || $TICK, 3294 at => $NEXT_TICK || $TICK,
2802 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3298 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2803 unless ++$bug_warning > 10; 3299 unless ++$bug_warning > 10;
2804 return; 3300 return;
2805 } 3301 }
2806 3302
2807 $NOW = Event::time; 3303 $NOW = $tick_start = Event::time;
2808 3304
2809 cf::server_tick; # one server iteration 3305 cf::server_tick; # one server iteration
3306
3307 0 && sync_job {#d#
3308 for(1..10) {
3309 my $t = Event::time;
3310 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3311 or die;
3312
3313 $map->width (50);
3314 $map->height (50);
3315 $map->alloc;
3316 $map->_load_objects ("/tmp/x.map", 1);
3317 my $t = Event::time - $t;
3318
3319 #next unless $t < 0.0013;#d#
3320 if ($t < $min) {
3321 $min = $t;
3322 }
3323 $avg = $avg * 0.99 + $t * 0.01;
3324 }
3325 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3326 exit 0;
3327 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3328 };
2810 3329
2811 $RUNTIME += $TICK; 3330 $RUNTIME += $TICK;
2812 $NEXT_TICK += $TICK; 3331 $NEXT_TICK += $TICK;
2813 3332
2814 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3333 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2820 } 3339 }
2821 3340
2822# my $AFTER = Event::time; 3341# my $AFTER = Event::time;
2823# warn $AFTER - $NOW;#d# 3342# warn $AFTER - $NOW;#d#
2824 3343
3344 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3345 $sig->send;
3346 }
3347 while (my $sig = shift @WAIT_FOR_TICK) {
3348 $sig->send;
3349 }
3350
3351 $NOW = Event::time;
3352
2825 # if we are delayed by four ticks or more, skip them all 3353 # if we are delayed by four ticks or more, skip them all
2826 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3354 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2827 3355
2828 $TICK_WATCHER->at ($NEXT_TICK); 3356 $TICK_WATCHER->at ($NEXT_TICK);
2829 $TICK_WATCHER->start; 3357 $TICK_WATCHER->start;
2830 3358
2831 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3359 $LOAD = ($NOW - $tick_start) / $TICK;
2832 $sig->send; 3360 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2833 }
2834 while (my $sig = shift @WAIT_FOR_TICK) {
2835 $sig->send;
2836 }
2837 3361
2838 _post_tick; 3362 _post_tick;
3363
3364
2839 }, 3365 },
2840); 3366);
2841 3367
2842{ 3368{
2843 BDB::max_poll_time $TICK * 0.1; 3369 BDB::max_poll_time $TICK * 0.1;
2871 3397
2872 cf::sync_job { 3398 cf::sync_job {
2873 eval { 3399 eval {
2874 BDB::db_env_open 3400 BDB::db_env_open
2875 $DB_ENV, 3401 $DB_ENV,
2876 $BDB_ENV_DIR, 3402 $BDBDIR,
2877 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3403 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2878 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3404 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2879 0666; 3405 0666;
2880 3406
2881 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3407 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2882 3408
2883 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3409 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2884 $DB_ENV->set_lk_detect; 3410 $DB_ENV->set_lk_detect;
2885 }; 3411 };
2886 3412
2902 prio => 6, 3428 prio => 6,
2903 cb => \&IO::AIO::poll_cb, 3429 cb => \&IO::AIO::poll_cb,
2904 ); 3430 );
2905} 3431}
2906 3432
3433my $_log_backtrace;
3434
3435sub _log_backtrace {
3436 my ($msg, @addr) = @_;
3437
3438 $msg =~ s/\n//;
3439
3440 # limit the # of concurrent backtraces
3441 if ($_log_backtrace < 2) {
3442 ++$_log_backtrace;
3443 async {
3444 my @bt = fork_call {
3445 @addr = map { sprintf "%x", $_ } @addr;
3446 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3447 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3448 or die "addr2line: $!";
3449
3450 my @funcs;
3451 my @res = <$fh>;
3452 chomp for @res;
3453 while (@res) {
3454 my ($func, $line) = splice @res, 0, 2, ();
3455 push @funcs, "[$func] $line";
3456 }
3457
3458 @funcs
3459 };
3460
3461 LOG llevInfo, "[ABT] $msg\n";
3462 LOG llevInfo, "[ABT] $_\n" for @bt;
3463 --$_log_backtrace;
3464 };
3465 } else {
3466 LOG llevInfo, "[ABT] $msg\n";
3467 LOG llevInfo, "[ABT] [suppressed]\n";
3468 }
3469}
3470
2907# load additional modules 3471# load additional modules
2908use cf::pod; 3472use cf::pod;
2909 3473
2910END { cf::emergency_save } 3474END { cf::emergency_save }
2911 3475

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines