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.249 by root, Wed Apr 18 12:43:54 2007 UTC vs.
Revision 1.338 by root, Tue Aug 21 01:07:47 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.61 (); 15use Coro 3.64 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
21use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
22 25
26use JSON::XS 1.4 ();
23use BDB (); 27use BDB ();
24use Data::Dumper; 28use Data::Dumper;
25use Digest::MD5; 29use Digest::MD5;
26use Fcntl; 30use Fcntl;
27use YAML::Syck (); 31use YAML::Syck ();
28use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
29use Time::HiRes; 33use Time::HiRes;
30use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
31 36
32# configure various modules to our taste 37# configure various modules to our taste
33# 38#
34$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
35Coro::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
47our %COMMAND = (); 52our %COMMAND = ();
48our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
49 54
50our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
51our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
52our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
53our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
54 60
55our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
56our @EVENT; 62our @EVENT;
57our $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";
58 75
59our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!) 76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
60our $TICK_WATCHER; 77our $TICK_WATCHER;
61our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
62our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
73our $RUNTIME; 90our $RUNTIME;
74 91
75our %PLAYER; # all users 92our %PLAYER; # all users
76our %MAP; # all maps 93our %MAP; # all maps
77our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
78our $RANDOM_MAPS = cf::localdir . "/random";
79our $BDB_ENV_DIR = cf::localdir . "/db";
80 95
81# 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 ∕
82our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
83 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
84binmode STDOUT; 103binmode STDOUT;
85binmode STDERR; 104binmode STDERR;
86 105
87# read virtual server time, if available 106# read virtual server time, if available
88unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
89 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
90 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
91 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
92} 111}
93 112
94mkdir cf::localdir; 113mkdir $_
95mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
96mkdir cf::localdir . "/" . cf::tmpdir;
97mkdir cf::localdir . "/" . cf::uniquedir;
98mkdir $RANDOM_MAPS;
99mkdir $BDB_ENV_DIR;
100 115
101our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
102 117
103sub cf::map::normalise; 118sub cf::map::normalise;
104 119
115=item $cf::RUNTIME 130=item $cf::RUNTIME
116 131
117The 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
118every server tick. 133every server tick.
119 134
120=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
121 138
122The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
123be 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.
124 143
125=item $cf::NOW 144=item $cf::NOW
126 145
127The time of the last (current) server tick. 146The time of the last (current) server tick.
128 147
129=item $cf::TICK 148=item $cf::TICK
130 149
131The 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.
132 161
133=item %cf::CFG 162=item %cf::CFG
134 163
135Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
136from wherever your confdir points to. 165from wherever your confdir points to.
139 168
140These 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
141returns 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
142per 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.
143 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
144=back 179=back
145 180
146=cut 181=cut
147 182
148BEGIN { 183BEGIN {
149 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
150 my $msg = join "", @_; 185 my $msg = join "", @_;
151 utf8::encode $msg;
152 186
153 $msg .= "\n" 187 $msg .= "\n"
154 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
155 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
156 LOG llevError, $msg; 193 LOG llevError, $msg;
157 }; 194 };
158} 195}
159 196
160@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
161@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
162@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
163@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
164@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';
165@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)
166 204
167# 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
168# within the Safe compartment. 206# within the Safe compartment.
169for my $pkg (qw( 207for my $pkg (qw(
170 cf::global cf::attachable 208 cf::global cf::attachable
178} 216}
179 217
180$Event::DIED = sub { 218$Event::DIED = sub {
181 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
182}; 220};
221
222#############################################################################
183 223
184=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
185 225
186=over 4 226=over 4
187 227
206 $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;
207 $d 247 $d
208 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
209} 249}
210 250
211use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
212
213=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
214 252
215Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
216 254
217=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
218 256
219Converts 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]) }
220 265
221=item cf::lock_wait $string 266=item cf::lock_wait $string
222 267
223Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
224 269
230returned. 275returned.
231 276
232Lock 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
233uses map_find and cf::map::load uses map_load). 278uses map_find and cf::map::load uses map_load).
234 279
280=item $locked = cf::lock_active $string
281
282Return true if the lock is currently active, i.e. somebody has locked it.
283
235=cut 284=cut
236 285
237our %LOCK; 286our %LOCK;
238 287
239sub lock_wait($) { 288sub lock_wait($) {
256 305
257 Coro::guard { 306 Coro::guard {
258 # wake up all waiters, to be on the safe side 307 # wake up all waiters, to be on the safe side
259 $_->ready for @{ delete $LOCK{$key} }; 308 $_->ready for @{ delete $LOCK{$key} };
260 } 309 }
310}
311
312sub lock_active($) {
313 my ($key) = @_;
314
315 ! ! $LOCK{$key}
261} 316}
262 317
263sub freeze_mainloop { 318sub freeze_mainloop {
264 return unless $TICK_WATCHER->is_active; 319 return unless $TICK_WATCHER->is_active;
265 320
268 }; 323 };
269 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
270 $guard 325 $guard
271} 326}
272 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
273=item cf::async { BLOCK } 384=item cf::async { BLOCK }
274 385
275Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
276C<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
277thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
280 391
281BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
282 393
283=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
284 395
285The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 398partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
399acceptable.
288 400
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 404fast or be very important.
295 407
296sub sync_job(&) { 408sub sync_job(&) {
297 my ($job) = @_; 409 my ($job) = @_;
298 410
299 if ($Coro::current == $Coro::main) { 411 if ($Coro::current == $Coro::main) {
412 my $time = Event::time;
413
300 # this is the main coro, too bad, we have to block 414 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 415 # till the operation succeeds, freezing the server :/
302 416
303 # TODO: use suspend/resume instead 417 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 418 # (but this is cancel-safe)
315 429
316 while ($busy) { 430 while ($busy) {
317 Coro::cede or Event::one_event; 431 Coro::cede or Event::one_event;
318 } 432 }
319 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
320 wantarray ? @res : $res[0] 441 wantarray ? @res : $res[0]
321 } else { 442 } else {
322 # we are in another coroutine, how wonderful, everything just works 443 # we are in another coroutine, how wonderful, everything just works
323 444
324 $job->() 445 $job->()
343 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
344 465
345 $coro 466 $coro
346} 467}
347 468
348sub write_runtime { 469=item fork_call { }, $args
349 my $guard = cf::lock_acquire "write_runtime";
350 470
351 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.
352 475
353 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 476=cut
354 or return;
355 477
356 my $value = $cf::RUNTIME + 90 + 10; 478sub fork_call(&@) {
357 # 10 is the runtime save interval, for a monotonic clock 479 my ($cb, @args) = @_;
358 # 60 allows for the watchdog to kill the server.
359 480
360 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481 # we seemingly have to make a local copy of the whole thing,
361 and return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
362 484
363 # always fsync - this file is important 485 my @res = Coro::Util::fork_eval {
364 aio_fsync $fh 486 reset_signals;
365 and return; 487 &$cb
488 }, @args;
366 489
367 close $fh 490 wantarray ? @res : $res[-1]
368 or return; 491}
369 492
370 aio_rename "$runtime~", $runtime 493=item $value = cf::db_get $family => $key
371 and return;
372 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 };
373 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"
374} 607}
375 608
376=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
377 610
378Log 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.
396attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
397to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
398 631
399In 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>
400C<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
401crossfire+). 634Crossfire TRT).
402 635
403=over 4 636=over 4
404 637
405=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
406 639
569 $registry = $CB_TYPE[$object_type] ||= []; 802 $registry = $CB_TYPE[$object_type] ||= [];
570 803
571 } elsif ($type eq "subtype") { 804 } elsif ($type eq "subtype") {
572 defined $object_type or Carp::croak "subtype specified without type"; 805 defined $object_type or Carp::croak "subtype specified without type";
573 my $object_subtype = shift @arg; 806 my $object_subtype = shift @arg;
574 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 807 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575 808
576 } elsif ($type eq "package") { 809 } elsif ($type eq "package") {
577 my $pkg = shift @arg; 810 my $pkg = shift @arg;
578 811
579 while (my ($name, $id) = each %cb_id) { 812 while (my ($name, $id) = each %cb_id) {
608 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
609 } 842 }
610 843
611 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
612 } else { 845 } else {
613 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
614 } 847 }
615 848
616 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
617} 850}
618 851
620 if (ref $_[0]) { 853 if (ref $_[0]) {
621 _object_attach @_; 854 _object_attach @_;
622 } else { 855 } else {
623 _attach shift->_attach_registry, @_; 856 _attach shift->_attach_registry, @_;
624 } 857 }
858 _recalc_want;
625}; 859};
626 860
627# all those should be optimised 861# all those should be optimised
628sub cf::attachable::detach { 862sub cf::attachable::detach {
629 my ($obj, $name) = @_; 863 my ($obj, $name) = @_;
632 delete $obj->{_attachment}{$name}; 866 delete $obj->{_attachment}{$name};
633 reattach ($obj); 867 reattach ($obj);
634 } else { 868 } else {
635 Carp::croak "cannot, currently, detach class attachments"; 869 Carp::croak "cannot, currently, detach class attachments";
636 } 870 }
871 _recalc_want;
637}; 872};
638 873
639sub cf::attachable::attached { 874sub cf::attachable::attached {
640 my ($obj, $name) = @_; 875 my ($obj, $name) = @_;
641 876
656 "; 891 ";
657 die if $@; 892 die if $@;
658} 893}
659 894
660our $override; 895our $override;
661our @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?
662 897
663sub override { 898sub override {
664 $override = 1; 899 $override = 1;
665 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
666} 901}
667 902
668sub do_invoke { 903sub do_invoke {
669 my $event = shift; 904 my $event = shift;
670 my $callbacks = shift; 905 my $callbacks = shift;
671 906
672 @invoke_results = (); 907 @INVOKE_RESULTS = ();
673 908
674 local $override; 909 local $override;
675 910
676 for (@$callbacks) { 911 for (@$callbacks) {
677 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
694 929
695Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
696 931
697This 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
698removed 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
699results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
700 935
701=back 936=back
702 937
703=cut 938=cut
704 939
705############################################################################# 940#############################################################################
706# 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}
707 953
708sub reattach { 954sub reattach {
709 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
710 my ($obj) = @_; 956 my ($obj) = @_;
711 957
814 or return; 1060 or return;
815 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
816 } 1062 }
817 1063
818 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
819 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
820 return ($data, $av); 1066 return ($data, $av);
821} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
822 1074
823############################################################################# 1075#############################################################################
824# command handling &c 1076# command handling &c
825 1077
826=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
839 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
840} 1092}
841 1093
842=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
843 1095
844Register 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.
845 1101
846If 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
847called. 1103called.
848 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
849=cut 1116=cut
850 1117
851sub register_extcmd { 1118sub register_extcmd {
852 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
853 1120
854 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
855} 1128}
856 1129
857cf::player->attach ( 1130cf::player->attach (
858 on_command => sub { 1131 on_command => sub {
859 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
868 cf::override; 1141 cf::override;
869 }, 1142 },
870 on_extcmd => sub { 1143 on_extcmd => sub {
871 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
872 1145
873 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874 1147
875 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
876 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1156 if (my $cb = $EXTCMD{$type}) {
877 if (my %reply = $cb->($pl, $msg)) { 1157 @reply = $cb->($pl, @payload);
878 $pl->ext_reply ($msg->{msgid}, %reply);
879 }
880 } 1158 }
1159
1160 $pl->ext_reply ($reply, @reply)
1161 if $reply;
1162
881 } else { 1163 } else {
882 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1164 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
883 } 1165 }
884 1166
885 cf::override; 1167 cf::override;
886 }, 1168 },
887); 1169);
888 1170
889sub load_extension {
890 my ($path) = @_;
891
892 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
893 my $base = $1;
894 my $pkg = $1;
895 $pkg =~ s/[^[:word:]]/_/g;
896 $pkg = "ext::$pkg";
897
898 warn "... loading '$path' into '$pkg'\n";
899
900 open my $fh, "<:utf8", $path
901 or die "$path: $!";
902
903 my $source =
904 "package $pkg; use strict; use utf8;\n"
905 . "#line 1 \"$path\"\n{\n"
906 . (do { local $/; <$fh> })
907 . "\n};\n1";
908
909 unless (eval $source) {
910 my $msg = $@ ? "$path: $@\n"
911 : "extension disabled.\n";
912 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
913 warn $@;
914 warn "mandatory extension failed to load, exiting.\n";
915 exit 1;
916 }
917 die $@;
918 }
919
920 push @EXTS, $pkg;
921}
922
923sub load_extensions { 1171sub load_extensions {
1172 cf::sync_job {
1173 my %todo;
1174
924 for my $ext (<$LIBDIR/*.ext>) { 1175 for my $path (<$LIBDIR/*.ext>) {
925 next unless -r $ext; 1176 next unless -r $path;
926 eval { 1177
927 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;
928 1 1235 }
929 } or warn "$ext not loaded: $@"; 1236
1237 skip:
1238 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1239 unless $progress;
1240 }
930 } 1241 };
931} 1242}
932 1243
933############################################################################# 1244#############################################################################
934 1245
1246=back
1247
935=head2 CORE EXTENSIONS 1248=head2 CORE EXTENSIONS
936 1249
937Functions and methods that extend core crossfire objects. 1250Functions and methods that extend core crossfire objects.
938 1251
939=cut 1252=cut
951Returns the given player object, loading it if necessary (might block). 1264Returns the given player object, loading it if necessary (might block).
952 1265
953=cut 1266=cut
954 1267
955sub playerdir($) { 1268sub playerdir($) {
956 cf::localdir 1269 "$PLAYERDIR/"
957 . "/"
958 . cf::playerdir
959 . "/"
960 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1270 . (ref $_[0] ? $_[0]->ob->name : $_[0])
961} 1271}
962 1272
963sub path($) { 1273sub path($) {
964 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1274 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1028 $cf::PLAYER{$login} = $self; 1338 $cf::PLAYER{$login} = $self;
1029 1339
1030 $self 1340 $self
1031} 1341}
1032 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
1033=item $pl->quit_character 1353=item $pl->quit_character
1034 1354
1035Nukes the player without looking back. If logged in, the connection will 1355Nukes the player without looking back. If logged in, the connection will
1036be destroyed. May block for a long time. 1356be destroyed. May block for a long time.
1037 1357
1084while and may block, so not sync_job-capable, ever. 1404while and may block, so not sync_job-capable, ever.
1085 1405
1086=cut 1406=cut
1087 1407
1088sub list_logins { 1408sub list_logins {
1089 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1409 my $dirs = aio_readdir $PLAYERDIR
1090 or return []; 1410 or return [];
1091 1411
1092 my @logins; 1412 my @logins;
1093 1413
1094 for my $login (@$dirs) { 1414 for my $login (@$dirs) {
1129 } 1449 }
1130 1450
1131 \@paths 1451 \@paths
1132} 1452}
1133 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
1134=item $player->ext_reply ($msgid, %msg) 1504=item $player->ext_reply ($msgid, @msg)
1135 1505
1136Sends an ext reply to the player. 1506Sends an ext reply to the player.
1137 1507
1138=cut 1508=cut
1139 1509
1140sub ext_reply($$%) { 1510sub ext_reply($$@) {
1141 my ($self, $id, %msg) = @_; 1511 my ($self, $id, @msg) = @_;
1142 1512
1143 $msg{msgid} = $id; 1513 $self->ns->ext_reply ($id, @msg)
1144
1145 $self->send ("ext " . cf::to_json \%msg);
1146} 1514}
1147 1515
1148=item $player->ext_event ($type, %msg) 1516=item $player->ext_msg ($type, @msg)
1149 1517
1150Sends an ext event to the client. 1518Sends an ext event to the client.
1151 1519
1152=cut 1520=cut
1153 1521
1154sub ext_event($$%) { 1522sub ext_msg($$@) {
1155 my ($self, $type, %msg) = @_; 1523 my ($self, $type, @msg) = @_;
1156 1524
1157 $self->ns->ext_event ($type, %msg); 1525 $self->ns->ext_msg ($type, @msg);
1158} 1526}
1159 1527
1160=head3 cf::region 1528=head3 cf::region
1161 1529
1162=over 4 1530=over 4
1165 1533
1166package cf::region; 1534package cf::region;
1167 1535
1168=item cf::region::find_by_path $path 1536=item cf::region::find_by_path $path
1169 1537
1170Tries 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.
1171 1539
1172=cut 1540=cut
1173 1541
1174sub find_by_path($) { 1542sub find_by_path($) {
1175 my ($path) = @_; 1543 my ($path) = @_;
1176 1544
1177 my ($match, $specificity); 1545 my ($match, $specificity);
1178 1546
1179 for my $region (list) { 1547 for my $region (list) {
1180 if ($region->match && $path =~ $region->match) { 1548 if ($region->{match} && $path =~ $region->{match}) {
1181 ($match, $specificity) = ($region, $region->specificity) 1549 ($match, $specificity) = ($region, $region->specificity)
1182 if $region->specificity > $specificity; 1550 if $region->specificity > $specificity;
1183 } 1551 }
1184 } 1552 }
1185 1553
1249 my ($self, $merge) = @_; 1617 my ($self, $merge) = @_;
1250 1618
1251 # we have to keep some variables in memory intact 1619 # we have to keep some variables in memory intact
1252 local $self->{path}; 1620 local $self->{path};
1253 local $self->{load_path}; 1621 local $self->{load_path};
1254 local $self->{deny_save};
1255 local $self->{deny_reset};
1256 1622
1257 $self->SUPER::thawer_merge ($merge); 1623 $self->SUPER::thawer_merge ($merge);
1258} 1624}
1259 1625
1260sub normalise { 1626sub normalise {
1307 $self->init; # pass $1 etc. 1673 $self->init; # pass $1 etc.
1308 return $self; 1674 return $self;
1309 } 1675 }
1310 } 1676 }
1311 1677
1312 Carp::carp "unable to resolve path '$path' (base '$base')."; 1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1313 () 1679 ()
1314} 1680}
1315 1681
1316sub init { 1682sub init {
1317 my ($self) = @_; 1683 my ($self) = @_;
1332 1698
1333# the original (read-only) location 1699# the original (read-only) location
1334sub load_path { 1700sub load_path {
1335 my ($self) = @_; 1701 my ($self) = @_;
1336 1702
1337 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1703 "$MAPDIR/$self->{path}.map"
1338} 1704}
1339 1705
1340# the temporary/swap location 1706# the temporary/swap location
1341sub save_path { 1707sub save_path {
1342 my ($self) = @_; 1708 my ($self) = @_;
1343 1709
1344 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1710 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1345 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1711 "$TMPDIR/$path.map"
1346} 1712}
1347 1713
1348# the unique path, undef == no special unique path 1714# the unique path, undef == no special unique path
1349sub uniq_path { 1715sub uniq_path {
1350 my ($self) = @_; 1716 my ($self) = @_;
1351 1717
1352 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1718 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1353 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1719 "$UNIQUEDIR/$path"
1354} 1720}
1355 1721
1356# and all this just because we cannot iterate over 1722# and all this just because we cannot iterate over
1357# all maps in C++... 1723# all maps in C++...
1358sub change_all_map_light { 1724sub change_all_map_light {
1359 my ($change) = @_; 1725 my ($change) = @_;
1360 1726
1361 $_->change_map_light ($change) 1727 $_->change_map_light ($change)
1362 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;
1363} 1737}
1364 1738
1365sub unlink_save { 1739sub unlink_save {
1366 my ($self) = @_; 1740 my ($self) = @_;
1367 1741
1425 $self->load_header_orig 1799 $self->load_header_orig
1426 or return; 1800 or return;
1427 $self->prepare_orig; 1801 $self->prepare_orig;
1428 } 1802 }
1429 1803
1804 $self->{deny_reset} = 1
1805 if $self->no_reset;
1806
1430 $self->default_region (cf::region::find_by_path $self->{path}) 1807 $self->default_region (cf::region::find_by_path $self->{path})
1431 unless $self->default_region; 1808 unless $self->default_region;
1432 1809
1433 1 1810 1
1434} 1811}
1449 $map->{last_save} = $cf::RUNTIME; 1826 $map->{last_save} = $cf::RUNTIME;
1450 1827
1451 $map->load_header 1828 $map->load_header
1452 or return; 1829 or return;
1453 1830
1454 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1831 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1455 # doing this can freeze the server in a sync job, obviously 1832 # doing this can freeze the server in a sync job, obviously
1456 #$cf::WAIT_FOR_TICK->wait; 1833 #$cf::WAIT_FOR_TICK->wait;
1457 $map->reset; 1834 $map->reset;
1458 undef $guard; 1835 undef $guard;
1459 return find $path; 1836 return find $path;
1470 my ($self) = @_; 1847 my ($self) = @_;
1471 1848
1472 local $self->{deny_reset} = 1; # loading can take a long time 1849 local $self->{deny_reset} = 1; # loading can take a long time
1473 1850
1474 my $path = $self->{path}; 1851 my $path = $self->{path};
1852
1853 {
1475 my $guard = cf::lock_acquire "map_load:$path"; 1854 my $guard = cf::lock_acquire "map_load:$path";
1476 1855
1477 return if $self->in_memory != cf::MAP_SWAPPED; 1856 return if $self->in_memory != cf::MAP_SWAPPED;
1478 1857
1479 $self->in_memory (cf::MAP_LOADING); 1858 $self->in_memory (cf::MAP_LOADING);
1480 1859
1481 $self->alloc; 1860 $self->alloc;
1482 1861
1483 $self->pre_load; 1862 $self->pre_load;
1484 Coro::cede;
1485
1486 $self->_load_objects ($self->{load_path}, 1)
1487 or return;
1488
1489 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1490 if delete $self->{load_original};
1491
1492 if (my $uniq = $self->uniq_path) {
1493 utf8::encode $uniq;
1494 if (aio_open $uniq, O_RDONLY, 0) {
1495 $self->clear_unique_items;
1496 $self->_load_objects ($uniq, 0);
1497 }
1498 }
1499
1500 Coro::cede;
1501 # now do the right thing for maps
1502 $self->link_multipart_objects;
1503 Coro::cede;
1504
1505 unless ($self->{deny_activate}) {
1506 $self->decay_objects;
1507 $self->fix_auto_apply;
1508 $self->update_buttons;
1509 Coro::cede; 1863 Coro::cede;
1510 $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;
1511 $self->difficulty ($self->estimate_difficulty) 1882 $self->difficulty ($self->estimate_difficulty)
1512 unless $self->difficulty; 1883 unless $self->difficulty;
1513 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;
1514 $self->activate; 1893 $self->activate;
1515 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);
1516 } 1900 }
1517 1901
1518 $self->post_load; 1902 $self->post_load;
1519 Coro::cede;
1520
1521 $self->in_memory (cf::MAP_IN_MEMORY);
1522} 1903}
1523 1904
1524sub customise_for { 1905sub customise_for {
1525 my ($self, $ob) = @_; 1906 my ($self, $ob) = @_;
1526 1907
1527 return find "~" . $ob->name . "/" . $self->{path} 1908 return find "~" . $ob->name . "/" . $self->{path}
1528 if $self->per_player; 1909 if $self->per_player;
1529 1910
1911# return find "?party/" . $ob->name . "/" . $self->{path}
1912# if $self->per_party;
1913
1530 $self 1914 $self
1531} 1915}
1532 1916
1533# 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
1534sub load_diag { 1918sub load_neighbours {
1535 my ($map) = @_; 1919 my ($map) = @_;
1536 1920
1537 my @diag; # diagonal neighbours 1921 my @neigh; # diagonal neighbours
1538 1922
1539 for (0 .. 3) { 1923 for (0 .. 3) {
1540 my $neigh = $map->tile_path ($_) 1924 my $neigh = $map->tile_path ($_)
1541 or next; 1925 or next;
1542 $neigh = find $neigh, $map 1926 $neigh = find $neigh, $map
1543 or next; 1927 or next;
1544 $neigh->load; 1928 $neigh->load;
1545 1929
1930 push @neigh,
1546 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1931 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1547 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1932 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1548 } 1933 }
1549 1934
1550 for (@diag) { 1935 for (grep defined $_->[0], @neigh) {
1936 my ($path, $origin) = @$_;
1551 my $neigh = find @$_ 1937 my $neigh = find $path, $origin
1552 or next; 1938 or next;
1553 $neigh->load; 1939 $neigh->load;
1554 } 1940 }
1555} 1941}
1556 1942
1580 1966
1581 undef $MAP_PREFETCH{$path}; 1967 undef $MAP_PREFETCH{$path};
1582 $MAP_PREFETCHER ||= cf::async { 1968 $MAP_PREFETCHER ||= cf::async {
1583 while (%MAP_PREFETCH) { 1969 while (%MAP_PREFETCH) {
1584 for my $path (keys %MAP_PREFETCH) { 1970 for my $path (keys %MAP_PREFETCH) {
1585 my $map = find $path 1971 if (my $map = find $path) {
1586 or next;
1587 $map->load; 1972 $map->load;
1973 }
1588 1974
1589 delete $MAP_PREFETCH{$path}; 1975 delete $MAP_PREFETCH{$path};
1590 } 1976 }
1591 } 1977 }
1592 undef $MAP_PREFETCHER; 1978 undef $MAP_PREFETCHER;
1644 2030
1645sub reset_at { 2031sub reset_at {
1646 my ($self) = @_; 2032 my ($self) = @_;
1647 2033
1648 # TODO: safety, remove and allow resettable per-player maps 2034 # TODO: safety, remove and allow resettable per-player maps
1649 return 1e99 if $self->isa ("ext::map_per_player");#d#
1650 return 1e99 if $self->{deny_reset}; 2035 return 1e99 if $self->{deny_reset};
1651 2036
1652 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2037 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1653 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;
1654 2039
1665 my ($self) = @_; 2050 my ($self) = @_;
1666 2051
1667 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2052 my $lock = cf::lock_acquire "map_data:$self->{path}";
1668 2053
1669 return if $self->players; 2054 return if $self->players;
1670 return if $self->isa ("ext::map_per_player");#d#
1671 2055
1672 warn "resetting map ", $self->path;#d# 2056 warn "resetting map ", $self->path;
1673 2057
1674 $self->in_memory (cf::MAP_SWAPPED); 2058 $self->in_memory (cf::MAP_SWAPPED);
1675 2059
1676 # need to save uniques path 2060 # need to save uniques path
1677 unless ($self->{deny_save}) { 2061 unless ($self->{deny_save}) {
1709 $cf::MAP{$self->path} = $self; 2093 $cf::MAP{$self->path} = $self;
1710 2094
1711 $self->reset; # polite request, might not happen 2095 $self->reset; # polite request, might not happen
1712} 2096}
1713 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
1714=item cf::map::unique_maps 2134=item cf::map::unique_maps
1715 2135
1716Returns an arrayref of paths of all shared maps that have 2136Returns an arrayref of paths of all shared maps that have
1717instantiated unique items. May block. 2137instantiated unique items. May block.
1718 2138
1719=cut 2139=cut
1720 2140
1721sub unique_maps() { 2141sub unique_maps() {
1722 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2142 [
1723 or return; 2143 map {
1724
1725 my @paths;
1726
1727 for (@$files) {
1728 utf8::decode $_; 2144 utf8::decode $_;
1729 next if /\.pst$/; 2145 /\.map$/
1730 next unless /^$PATH_SEP/o; 2146 ? normalise $_
1731 2147 : ()
1732 push @paths, cf::map::normalise $_; 2148 } @{ aio_readdir $UNIQUEDIR or [] }
1733 } 2149 ]
1734
1735 \@paths
1736} 2150}
1737 2151
1738package cf; 2152package cf;
1739 2153
1740=back 2154=back
1786 2200
1787 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2201 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1788 2202
1789 if ($self->{record_replies}) { 2203 if ($self->{record_replies}) {
1790 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2204 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2205
1791 } 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 {
1792 $msg = $npc->name . " says: $msg" if $npc; 2214 $msg = $npc->name . " says: $msg" if $npc;
1793 $self->message ($msg, $flags); 2215 $self->message ($msg, $flags);
2216 }
1794 } 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 (@_);
1795} 2228}
1796 2229
1797=item $player_object->may ("access") 2230=item $player_object->may ("access")
1798 2231
1799Returns wether the given player is authorized to access resource "access" 2232Returns wether the given player is authorized to access resource "access"
1846 $self->deactivate_recursive; 2279 $self->deactivate_recursive;
1847 2280
1848 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2281 return if UNIVERSAL::isa $self->map, "ext::map_link";
1849 2282
1850 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2283 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1851 if $self->map; 2284 if $self->map && $self->map->{path} ne "{link}";
1852 2285
1853 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2286 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1854} 2287}
1855 2288
1856sub cf::object::player::leave_link { 2289sub cf::object::player::leave_link {
1857 my ($self, $map, $x, $y) = @_; 2290 my ($self, $map, $x, $y) = @_;
2291
2292 return unless $self->contr->active;
1858 2293
1859 my $link_pos = delete $self->{_link_pos}; 2294 my $link_pos = delete $self->{_link_pos};
1860 2295
1861 unless ($map) { 2296 unless ($map) {
1862 # restore original map position 2297 # restore original map position
1876 # use -1 or undef as default coordinates, not 0, 0 2311 # use -1 or undef as default coordinates, not 0, 0
1877 ($x, $y) = ($map->enter_x, $map->enter_y) 2312 ($x, $y) = ($map->enter_x, $map->enter_y)
1878 if $x <=0 && $y <= 0; 2313 if $x <=0 && $y <= 0;
1879 2314
1880 $map->load; 2315 $map->load;
1881 $map->load_diag; 2316 $map->load_neighbours;
1882 2317
1883 return unless $self->contr->active; 2318 return unless $self->contr->active;
1884 $self->activate_recursive; 2319 $self->activate_recursive;
1885 2320
1886 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2321 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1887 $self->enter_map ($map, $x, $y); 2322 $self->enter_map ($map, $x, $y);
1888} 2323}
1889 2324
1890cf::player->attach ( 2325=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1891 on_logout => sub {
1892 my ($pl) = @_;
1893 2326
1894 # abort map switching before logout 2327Moves the player to the given map-path and coordinates by first freezing
1895 if ($pl->ob->{_link_pos}) { 2328her, loading and preparing them map, calling the provided $check callback
1896 cf::sync_job { 2329that has to return the map if sucecssful, and then unfreezes the player on
1897 $pl->ob->leave_link 2330the new (success) or old (failed) map position. In either case, $done will
1898 }; 2331be called at the end of this process.
1899 }
1900 },
1901 on_login => sub {
1902 my ($pl) = @_;
1903 2332
1904 # try to abort aborted map switching on player login :)
1905 # should happen only on crashes
1906 if ($pl->ob->{_link_pos}) {
1907 $pl->ob->enter_link;
1908 (async {
1909 $pl->ob->reply (undef,
1910 "There was an internal problem at your last logout, "
1911 . "the server will try to bring you to your intended destination in a second.",
1912 cf::NDI_RED);
1913 # we need this sleep as the login has a concurrent enter_exit running
1914 # and this sleep increases chances of the player not ending up in scorn
1915 Coro::Timer::sleep 1;
1916 $pl->ob->leave_link;
1917 })->prio (2);
1918 }
1919 },
1920);
1921
1922=item $player_object->goto ($path, $x, $y)
1923
1924=cut 2333=cut
2334
2335our $GOTOGEN;
1925 2336
1926sub cf::object::player::goto { 2337sub cf::object::player::goto {
1927 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;
1928 2342
1929 $self->enter_link; 2343 $self->enter_link;
1930 2344
1931 (async { 2345 (async {
1932 my $map = eval { 2346 my $map = eval {
1933 my $map = cf::map::find $path; 2347 my $map = cf::map::find $path;
2348
2349 if ($map) {
1934 $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
1935 $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 $@;
1936 } or 2362 }
1937 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1938 2363
2364 if ($gen == $self->{_goto_generation}) {
2365 delete $self->{_goto_generation};
1939 $self->leave_link ($map, $x, $y); 2366 $self->leave_link ($map, $x, $y);
2367 }
2368
2369 $done->() if $done;
1940 })->prio (1); 2370 })->prio (1);
1941} 2371}
1942 2372
1943=item $player_object->enter_exit ($exit_object) 2373=item $player_object->enter_exit ($exit_object)
1944 2374
1983 2413
1984 $rmp->{random_seed} ||= $exit->random_seed; 2414 $rmp->{random_seed} ||= $exit->random_seed;
1985 2415
1986 my $data = cf::to_json $rmp; 2416 my $data = cf::to_json $rmp;
1987 my $md5 = Digest::MD5::md5_hex $data; 2417 my $md5 = Digest::MD5::md5_hex $data;
1988 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2418 my $meta = "$RANDOMDIR/$md5.meta";
1989 2419
1990 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2420 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1991 aio_write $fh, 0, (length $data), $data, 0; 2421 aio_write $fh, 0, (length $data), $data, 0;
1992 undef $fh; 2422 undef $fh;
1993 aio_rename "$meta~", $meta; 2423 aio_rename "$meta~", $meta;
2012 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;
2013 my $hp = $exit->stats->hp; 2443 my $hp = $exit->stats->hp;
2014 my $sp = $exit->stats->sp; 2444 my $sp = $exit->stats->sp;
2015 2445
2016 $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);
2017 2451
2018 (async { 2452 (async {
2019 $self->deactivate_recursive; # just to be sure 2453 $self->deactivate_recursive; # just to be sure
2020 unless (eval { 2454 unless (eval {
2021 $self->goto ($slaying, $hp, $sp); 2455 $self->goto ($slaying, $hp, $sp);
2049 2483
2050 utf8::encode $text; 2484 utf8::encode $text;
2051 $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);
2052} 2486}
2053 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
2054=item $client->ext_event ($type, %msg) 2550=item $client->ext_msg ($type, @msg)
2055 2551
2056Sends an exti event to the client. 2552Sends an ext event to the client.
2057 2553
2058=cut 2554=cut
2059 2555
2060sub cf::client::ext_event($$%) { 2556sub cf::client::ext_msg($$@) {
2061 my ($self, $type, %msg) = @_; 2557 my ($self, $type, @msg) = @_;
2062 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
2063 $msg{msgtype} = "event_$type"; 2564 push @msg, msgtype => "event_$type";
2064 $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 }
2065} 2585}
2066 2586
2067=item $success = $client->query ($flags, "text", \&cb) 2587=item $success = $client->query ($flags, "text", \&cb)
2068 2588
2069Queues a query to the client, calling the given callback with 2589Queues a query to the client, calling the given callback with
2070the 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>,
2071C<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>.
2072 2592
2073Queries 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
2074reliable at some point in the future. 2594become reliable at some point in the future.
2075 2595
2076=cut 2596=cut
2077 2597
2078sub cf::client::query { 2598sub cf::client::query {
2079 my ($self, $flags, $text, $cb) = @_; 2599 my ($self, $flags, $text, $cb) = @_;
2087 utf8::encode $text; 2607 utf8::encode $text;
2088 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2608 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2089 2609
2090 $self->send_packet ($self->{query_queue}[0][0]) 2610 $self->send_packet ($self->{query_queue}[0][0])
2091 if @{ $self->{query_queue} } == 1; 2611 if @{ $self->{query_queue} } == 1;
2612
2613 1
2092} 2614}
2093 2615
2094cf::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 },
2095 on_reply => sub { 2622 on_reply => sub {
2096 my ($ns, $msg) = @_; 2623 my ($ns, $msg) = @_;
2097 2624
2098 # this weird shuffling is so that direct followup queries 2625 # this weird shuffling is so that direct followup queries
2099 # get handled first 2626 # get handled first
2111 } else { 2638 } else {
2112 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2639 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2113 } 2640 }
2114 } 2641 }
2115 }, 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 },
2116); 2669);
2117 2670
2118=item $client->async (\&cb) 2671=item $client->async (\&cb)
2119 2672
2120Create a new coroutine, running the specified callback. The coroutine will 2673Create a new coroutine, running the specified callback. The coroutine will
2161our $safe = new Safe "safe"; 2714our $safe = new Safe "safe";
2162our $safe_hole = new Safe::Hole; 2715our $safe_hole = new Safe::Hole;
2163 2716
2164$SIG{FPE} = 'IGNORE'; 2717$SIG{FPE} = 'IGNORE';
2165 2718
2166$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));
2167 2724
2168# here we export the classes and methods available to script code 2725# here we export the classes and methods available to script code
2169 2726
2170=pod 2727=pod
2171 2728
2172The following functions and methods are available within a safe environment: 2729The following functions and methods are available within a safe environment:
2173 2730
2174 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
2175 cf::object::player player 2735 cf::object::player
2176 cf::player peaceful 2736 player
2177 cf::map trigger 2737
2738 cf::player
2739 peaceful
2740
2741 cf::map
2742 trigger
2178 2743
2179=cut 2744=cut
2180 2745
2181for ( 2746for (
2182 ["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)],
2183 ["cf::object::player" => qw(player)], 2749 ["cf::object::player" => qw(player)],
2184 ["cf::player" => qw(peaceful)], 2750 ["cf::player" => qw(peaceful)],
2185 ["cf::map" => qw(trigger)], 2751 ["cf::map" => qw(trigger)],
2186) { 2752) {
2187 no strict 'refs'; 2753 no strict 'refs';
2258=back 2824=back
2259 2825
2260=cut 2826=cut
2261 2827
2262############################################################################# 2828#############################################################################
2263
2264=head2 EXTENSION DATABASE SUPPORT
2265
2266Crossfire maintains a very simple database for extension use. It can
2267currently store anything that can be serialised using Storable, which
2268excludes objects.
2269
2270The parameter C<$family> should best start with the name of the extension
2271using it, it should be unique.
2272
2273=over 4
2274
2275=item $value = cf::db_get $family => $key
2276
2277Returns a single value from the database.
2278
2279=item cf::db_put $family => $key => $value
2280
2281Stores the given C<$value> in the family.
2282
2283=cut
2284
2285our $DB;
2286
2287sub db_init {
2288 unless ($DB) {
2289 $DB = BDB::db_create $DB_ENV;
2290
2291 cf::sync_job {
2292 eval {
2293 $DB->set_flags (BDB::CHKSUM);
2294
2295 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2296 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2297 cf::cleanup "db_open(db): $!" if $!;
2298 };
2299 cf::cleanup "db_open(db): $@" if $@;
2300 };
2301
2302 my $path = cf::localdir . "/database.pst";
2303 if (stat $path) {
2304 cf::sync_job {
2305 my $pst = Storable::retrieve $path;
2306
2307 cf::db_put (board => data => $pst->{board});
2308 cf::db_put (guildrules => data => $pst->{guildrules});
2309 cf::db_put (rent => balance => $pst->{rent}{balance});
2310 BDB::db_env_txn_checkpoint $DB_ENV;
2311
2312 unlink $path;
2313 };
2314 }
2315 }
2316}
2317
2318sub db_get($$) {
2319 my $key = "$_[0]/$_[1]";
2320
2321 cf::sync_job {
2322 BDB::db_get $DB, undef, $key, my $data;
2323
2324 $! ? ()
2325 : Compress::LZF::sthaw $data
2326 }
2327}
2328
2329sub db_put($$$) {
2330 BDB::dbreq_pri 4;
2331 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2332}
2333
2334=item cf::cache $id => ...
2335
2336Generic caching function that returns the value of the resource $id,
2337caching and regenerating as required.
2338
2339This function can block.
2340
2341 source => filename returning the data (must be a scalar)
2342 expensive => true == try to cache harder
2343 filter => sub that processes the data into a scalar
2344
2345=cut
2346
2347sub cache {
2348 my ($id, %arg) = @_;
2349
2350 aio_stat $arg{source}
2351 and Carp::croak "$arg{source}: $!";
2352
2353 my $meta = join ":", (stat _)[7,9];
2354 my $md5;
2355
2356 if ($arg{expensive}) {
2357 0 <= aio_load $arg{source}, my $buf
2358 or Carp::croak "$arg{source}: $!";
2359
2360 $md5 = Digest::MD5::md5_hex $buf;
2361 }
2362
2363 my $dbmeta = db_get "$id/meta";
2364 if ($dbmeta ne $meta) {
2365 # changed, we need to process
2366 } else {
2367 # just fetch
2368 }
2369
2370
2371}
2372
2373#############################################################################
2374# the server's init and main functions 2829# the server's init and main functions
2375 2830
2376sub load_facedata($) { 2831sub load_facedata($) {
2377 my ($path) = @_; 2832 my ($path) = @_;
2833
2834 my $enc = JSON::XS->new->utf8->canonical;
2378 2835
2379 warn "loading facedata from $path\n"; 2836 warn "loading facedata from $path\n";
2380 2837
2381 my $facedata; 2838 my $facedata;
2382 0 < aio_load $path, $facedata 2839 0 < aio_load $path, $facedata
2385 $facedata = Coro::Storable::thaw $facedata; 2842 $facedata = Coro::Storable::thaw $facedata;
2386 2843
2387 $facedata->{version} == 2 2844 $facedata->{version} == 2
2388 or cf::cleanup "$path: version mismatch, cannot proceed."; 2845 or cf::cleanup "$path: version mismatch, cannot proceed.";
2389 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
2390 { 2854 {
2391 my $faces = $facedata->{faceinfo}; 2855 my $faces = $facedata->{faceinfo};
2392 2856
2393 while (my ($face, $info) = each %$faces) { 2857 while (my ($face, $info) = each %$faces) {
2394 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2858 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2395 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2859 cf::face::set_visibility $idx, $info->{visibility};
2860 cf::face::set_magicmap $idx, $info->{magicmap};
2396 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2861 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2397 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2862 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2398 Coro::cede; 2863
2864 cf::cede_to_tick;
2399 } 2865 }
2400 2866
2401 while (my ($face, $info) = each %$faces) { 2867 while (my ($face, $info) = each %$faces) {
2402 next unless $info->{smooth}; 2868 next unless $info->{smooth};
2403 my $idx = cf::face::find $face 2869 my $idx = cf::face::find $face
2404 or next; 2870 or next;
2405 if (my $smooth = cf::face::find $info->{smooth}) { 2871 if (my $smooth = cf::face::find $info->{smooth}) {
2872 cf::face::set_smooth $idx, $smooth;
2406 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2873 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2407 } else { 2874 } else {
2408 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2875 warn "smooth face '$info->{smooth}' not found for face '$face'";
2409 } 2876 }
2410 Coro::cede; 2877
2878 cf::cede_to_tick;
2411 } 2879 }
2412 } 2880 }
2413 2881
2414 { 2882 {
2415 my $anims = $facedata->{animinfo}; 2883 my $anims = $facedata->{animinfo};
2416 2884
2417 while (my ($anim, $info) = each %$anims) { 2885 while (my ($anim, $info) = each %$anims) {
2418 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2886 cf::anim::set $anim, $info->{frames}, $info->{facings};
2419 Coro::cede; 2887 cf::cede_to_tick;
2420 } 2888 }
2421 2889
2422 cf::anim::invalidate_all; # d'oh 2890 cf::anim::invalidate_all; # d'oh
2423 } 2891 }
2424 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
2425 1 2942 1
2426} 2943}
2427 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
2428sub reload_facedata { 2963sub reload_facedata {
2429 load_facedata sprintf "%s/facedata", cf::datadir 2964 load_facedata "$DATADIR/facedata"
2430 or die "unable to load facedata\n"; 2965 or die "unable to load facedata\n";
2431} 2966}
2432 2967
2433sub reload_regions {
2434 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2435 or die "unable to load regions file\n";
2436}
2437
2438sub reload_archetypes { 2968sub reload_archetypes {
2439 load_resource_file sprintf "%s/archetypes", cf::datadir 2969 load_resource_file "$DATADIR/archetypes"
2440 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";
2441} 2976}
2442 2977
2443sub reload_treasures { 2978sub reload_treasures {
2444 load_resource_file sprintf "%s/treasures", cf::datadir 2979 load_resource_file "$DATADIR/treasures"
2445 or die "unable to load treasurelists\n"; 2980 or die "unable to load treasurelists\n";
2446} 2981}
2447 2982
2448sub reload_resources { 2983sub reload_resources {
2449 warn "reloading resource files...\n"; 2984 warn "reloading resource files...\n";
2450 2985
2451 reload_regions; 2986 reload_regions;
2452 reload_facedata; 2987 reload_facedata;
2988 #reload_archetypes;#d#
2453 reload_archetypes; 2989 reload_archetypes;
2454 reload_treasures; 2990 reload_treasures;
2455 2991
2456 warn "finished reloading resource files\n"; 2992 warn "finished reloading resource files\n";
2457} 2993}
2459sub init { 2995sub init {
2460 reload_resources; 2996 reload_resources;
2461} 2997}
2462 2998
2463sub cfg_load { 2999sub cfg_load {
2464 open my $fh, "<:utf8", cf::confdir . "/config" 3000 open my $fh, "<:utf8", "$CONFDIR/config"
2465 or return; 3001 or return;
2466 3002
2467 local $/; 3003 local $/;
2468 *CFG = YAML::Syck::Load <$fh>; 3004 *CFG = YAML::Syck::Load <$fh>;
2469 3005
2514 }, 3050 },
2515 ); 3051 );
2516 } 3052 }
2517} 3053}
2518 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
2519sub emergency_save() { 3093sub emergency_save() {
2520 my $freeze_guard = cf::freeze_mainloop; 3094 my $freeze_guard = cf::freeze_mainloop;
2521 3095
2522 warn "enter emergency perl save\n"; 3096 warn "enter emergency perl save\n";
2523 3097
2598 %EXT_CORO = (); 3172 %EXT_CORO = ();
2599 3173
2600 warn "removing commands"; 3174 warn "removing commands";
2601 %COMMAND = (); 3175 %COMMAND = ();
2602 3176
2603 warn "removing ext commands"; 3177 warn "removing ext/exti commands";
2604 %EXTCMD = (); 3178 %EXTCMD = ();
3179 %EXTICMD = ();
2605 3180
2606 warn "unloading/nuking all extensions"; 3181 warn "unloading/nuking all extensions";
2607 for my $pkg (@EXTS) { 3182 for my $pkg (@EXTS) {
2608 warn "... unloading $pkg"; 3183 warn "... unloading $pkg";
2609 3184
2639 Symbol::delete_package "safe::$_" 3214 Symbol::delete_package "safe::$_"
2640 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3215 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2641 3216
2642 warn "unloading cf.pm \"a bit\""; 3217 warn "unloading cf.pm \"a bit\"";
2643 delete $INC{"cf.pm"}; 3218 delete $INC{"cf.pm"};
3219 delete $INC{"cf/pod.pm"};
2644 3220
2645 # don't, removes xs symbols, too, 3221 # don't, removes xs symbols, too,
2646 # and global variables created in xs 3222 # and global variables created in xs
2647 #Symbol::delete_package __PACKAGE__; 3223 #Symbol::delete_package __PACKAGE__;
2648 3224
2726 my $signal = new Coro::Signal; 3302 my $signal = new Coro::Signal;
2727 push @WAIT_FOR_TICK_BEGIN, $signal; 3303 push @WAIT_FOR_TICK_BEGIN, $signal;
2728 $signal->wait; 3304 $signal->wait;
2729} 3305}
2730 3306
3307 my $min = 1e6;#d#
3308 my $avg = 10;
2731$TICK_WATCHER = Event->timer ( 3309$TICK_WATCHER = Event->timer (
2732 reentrant => 0, 3310 reentrant => 0,
2733 parked => 1, 3311 parked => 1,
2734 prio => 0, 3312 prio => 0,
2735 at => $NEXT_TICK || $TICK, 3313 at => $NEXT_TICK || $TICK,
2739 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"
2740 unless ++$bug_warning > 10; 3318 unless ++$bug_warning > 10;
2741 return; 3319 return;
2742 } 3320 }
2743 3321
2744 $NOW = Event::time; 3322 $NOW = $tick_start = Event::time;
2745 3323
2746 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 };
2747 3348
2748 $RUNTIME += $TICK; 3349 $RUNTIME += $TICK;
2749 $NEXT_TICK += $TICK; 3350 $NEXT_TICK += $TICK;
2750 3351
2751 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3352 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2757 } 3358 }
2758 3359
2759# my $AFTER = Event::time; 3360# my $AFTER = Event::time;
2760# warn $AFTER - $NOW;#d# 3361# warn $AFTER - $NOW;#d#
2761 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
2762 # 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
2763 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3373 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2764 3374
2765 $TICK_WATCHER->at ($NEXT_TICK); 3375 $TICK_WATCHER->at ($NEXT_TICK);
2766 $TICK_WATCHER->start; 3376 $TICK_WATCHER->start;
2767 3377
2768 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 3378 $LOAD = ($NOW - $tick_start) / $TICK;
2769 $sig->send; 3379 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2770 }
2771 while (my $sig = shift @WAIT_FOR_TICK) {
2772 $sig->send;
2773 }
2774 3380
2775 _post_tick; 3381 _post_tick;
3382
3383
2776 }, 3384 },
2777); 3385);
2778 3386
2779{ 3387{
2780 BDB::max_poll_time $TICK * 0.1; 3388 BDB::max_poll_time $TICK * 0.1;
2808 3416
2809 cf::sync_job { 3417 cf::sync_job {
2810 eval { 3418 eval {
2811 BDB::db_env_open 3419 BDB::db_env_open
2812 $DB_ENV, 3420 $DB_ENV,
2813 $BDB_ENV_DIR, 3421 $BDBDIR,
2814 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
2815 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3423 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2816 0666; 3424 0666;
2817 3425
2818 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3426 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2819 3427
2820 $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);
2821 $DB_ENV->set_lk_detect; 3429 $DB_ENV->set_lk_detect;
2822 }; 3430 };
2823 3431
2839 prio => 6, 3447 prio => 6,
2840 cb => \&IO::AIO::poll_cb, 3448 cb => \&IO::AIO::poll_cb,
2841 ); 3449 );
2842} 3450}
2843 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
2844# load additional modules 3490# load additional modules
2845use cf::pod; 3491use cf::pod;
2846 3492
2847END { cf::emergency_save } 3493END { cf::emergency_save }
2848 3494

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines