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.221 by pippijn, Fri Mar 2 13:32:52 2007 UTC vs.
Revision 1.314 by root, Mon Jul 23 16:53:15 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;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.5 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use JSON::XS 1.4 ();
20use BDB (); 26use BDB ();
21use Data::Dumper; 27use Data::Dumper;
22use Digest::MD5; 28use Digest::MD5;
23use Fcntl; 29use Fcntl;
30use YAML::Syck ();
24use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 32use Time::HiRes;
27use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
28 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 41
31use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 43
35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
37 46
38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
40our %COMMAND = (); 51our %COMMAND = ();
41our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
42 53
43our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
47 59
60our $RELOAD; # number of reloads so far
48our @EVENT; 61our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 62
51our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52our $TICK_WATCHER; 76our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
54our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 79our $NEXT_TICK;
56our $NOW; 80our $NOW;
65our $RUNTIME; 89our $RUNTIME;
66 90
67our %PLAYER; # all users 91our %PLAYER; # all users
68our %MAP; # all maps 92our %MAP; # all maps
69our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 94
76# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
79binmode STDOUT; 102binmode STDOUT;
80binmode STDERR; 103binmode STDERR;
81 104
82# read virtual server time, if available 105# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
87} 110}
88 111
89mkdir cf::localdir; 112mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 114
96our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
97 116
98sub cf::map::normalise; 117sub cf::map::normalise;
99 118
110=item $cf::RUNTIME 129=item $cf::RUNTIME
111 130
112The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick. 132every server tick.
114 133
115=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116 137
117The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
118be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
119 142
120=item $cf::NOW 143=item $cf::NOW
121 144
122The time of the last (current) server tick. 145The time of the last (current) server tick.
123 146
124=item $cf::TICK 147=item $cf::TICK
125 148
126The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
127 160
128=item %cf::CFG 161=item %cf::CFG
129 162
130Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 164from wherever your confdir points to.
132 165
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
134 167
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
137processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
139 177
140=back 178=back
141 179
142=cut 180=cut
143 181
144BEGIN { 182BEGIN {
145 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 184 my $msg = join "", @_;
147 utf8::encode $msg;
148 185
149 $msg .= "\n" 186 $msg .= "\n"
150 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
151 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
152 LOG llevError, $msg; 192 LOG llevError, $msg;
153 }; 193 };
154} 194}
155 195
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162 203
163# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
164# within the Safe compartment. 205# within the Safe compartment.
165for my $pkg (qw( 206for my $pkg (qw(
166 cf::global cf::attachable 207 cf::global cf::attachable
174} 215}
175 216
176$Event::DIED = sub { 217$Event::DIED = sub {
177 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
178}; 219};
220
221#############################################################################
179 222
180=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
181 224
182=over 4 225=over 4
183 226
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 246 $d
204 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
205} 248}
206 249
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
210 251
211Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
212 253
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
221 255
222Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
223 257
224=cut 258=cut
225 259
226sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
228 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
229} 263sub from_json ($) { $json_coder->decode ($_[0]) }
230 264
231=item cf::lock_wait $string 265=item cf::lock_wait $string
232 266
233Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
234 268
240returned. 274returned.
241 275
242Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
244 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
245=cut 283=cut
246 284
247our %LOCK; 285our %LOCK;
248 286
249sub lock_wait($) { 287sub lock_wait($) {
266 304
267 Coro::guard { 305 Coro::guard {
268 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
270 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
271} 315}
272 316
273sub freeze_mainloop { 317sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
275 319
278 }; 322 };
279 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
280 $guard 324 $guard
281} 325}
282 326
327=item cf::get_slot $time[, $priority]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333Useful for short background jobs.
334
335=cut
336
337our @SLOT_QUEUE;
338our $SLOT_QUEUE;
339
340$SLOT_QUEUE->cancel if $SLOT_QUEUE;
341$SLOT_QUEUE = Coro::async {
342 my $signal = new Coro::Signal;
343
344 while () {
345 next_job:
346 my $avail = cf::till_tick;
347 if ($avail > 0.01) {
348 for (0 .. $#SLOT_QUEUE) {
349 if ($SLOT_QUEUE[$_][0] < $avail) {
350 my $job = splice @SLOT_QUEUE, $_, 1, ();
351 $job->[2]->send;
352 Coro::cede;
353 goto next_job;
354 }
355 }
356 }
357
358 if (@SLOT_QUEUE) {
359 # we do not use wait_For_tick() as it returns immediately when tick is inactive
360 push @cf::WAIT_FOR_TICK, $signal;
361 $signal->wait;
362 } else {
363 Coro::schedule;
364 }
365 }
366};
367
368sub get_slot($;$) {
369 my ($time, $pri) = @_;
370
371 push @SLOT_QUEUE, [$time, $pri, my $sig = new Coro::Signal];
372 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
373 $SLOT_QUEUE->ready;
374 $sig->wait;
375}
376
283=item cf::async { BLOCK } 377=item cf::async { BLOCK }
284 378
285Currently the same as Coro::async_pool, meaning you cannot use 379Currently the same as Coro::async_pool, meaning you cannot use
286C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 380C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
287thing you are allowed to do is call C<prio> on it. 381thing you are allowed to do is call C<prio> on it.
290 384
291BEGIN { *async = \&Coro::async_pool } 385BEGIN { *async = \&Coro::async_pool }
292 386
293=item cf::sync_job { BLOCK } 387=item cf::sync_job { BLOCK }
294 388
295The design of crossfire+ requires that the main coro ($Coro::main) is 389The design of Crossfire TRT requires that the main coroutine ($Coro::main)
296always able to handle events or runnable, as crossfire+ is only partly 390is always able to handle events or runnable, as Crossfire TRT is only
297reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 391partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
392acceptable.
298 393
299If it must be done, put the blocking parts into C<sync_job>. This will run 394If it must be done, put the blocking parts into C<sync_job>. This will run
300the given BLOCK in another coroutine while waiting for the result. The 395the given BLOCK in another coroutine while waiting for the result. The
301server will be frozen during this time, so the block should either finish 396server will be frozen during this time, so the block should either finish
302fast or be very important. 397fast or be very important.
305 400
306sub sync_job(&) { 401sub sync_job(&) {
307 my ($job) = @_; 402 my ($job) = @_;
308 403
309 if ($Coro::current == $Coro::main) { 404 if ($Coro::current == $Coro::main) {
405 my $time = Event::time;
406
310 # this is the main coro, too bad, we have to block 407 # this is the main coro, too bad, we have to block
311 # till the operation succeeds, freezing the server :/ 408 # till the operation succeeds, freezing the server :/
312 409
313 # TODO: use suspend/resume instead 410 # TODO: use suspend/resume instead
314 # (but this is cancel-safe) 411 # (but this is cancel-safe)
325 422
326 while ($busy) { 423 while ($busy) {
327 Coro::cede or Event::one_event; 424 Coro::cede or Event::one_event;
328 } 425 }
329 426
427 $time = Event::time - $time;
428
429 LOG llevError | logBacktrace, Carp::longmess "long sync job"
430 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
431
432 $tick_start += $time; # do not account sync jobs to server load
433
330 wantarray ? @res : $res[0] 434 wantarray ? @res : $res[0]
331 } else { 435 } else {
332 # we are in another coroutine, how wonderful, everything just works 436 # we are in another coroutine, how wonderful, everything just works
333 437
334 $job->() 438 $job->()
353 $EXT_CORO{$coro+0} = $coro; 457 $EXT_CORO{$coro+0} = $coro;
354 458
355 $coro 459 $coro
356} 460}
357 461
358sub write_runtime { 462=item fork_call { }, $args
359 my $guard = cf::lock_acquire "write_runtime";
360 463
361 my $runtime = cf::localdir . "/runtime"; 464Executes the given code block with the given arguments in a seperate
465process, returning the results. Everything must be serialisable with
466Coro::Storable. May, of course, block. Note that the executed sub may
467never block itself or use any form of Event handling.
362 468
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 469=cut
364 or return;
365 470
366 my $value = $cf::RUNTIME + 90 + 10; 471sub _store_scalar {
367 # 10 is the runtime save interval, for a monotonic clock 472 open my $fh, ">", \my $buf
368 # 60 allows for the watchdog to kill the server. 473 or die "fork_call: cannot open fh-to-buf in child : $!";
369 474 Storable::store_fd $_[0], $fh;
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0
371 and return;
372
373 # always fsync - this file is important
374 aio_fsync $fh
375 and return;
376
377 close $fh 475 close $fh;
378 or return;
379 476
380 aio_rename "$runtime~", $runtime 477 $buf
381 and return; 478}
382 479
480sub fork_call(&@) {
481 my ($cb, @args) = @_;
482
483# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
484# or die "socketpair: $!";
485 pipe my $fh1, my $fh2
486 or die "pipe: $!";
487
488 if (my $pid = fork) {
489 close $fh2;
490
491 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
492 warn "pst<$res>" unless $res =~ /^pst/;
493 $res = Coro::Storable::thaw $res;
494
495 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
496
497 Carp::confess $$res unless "ARRAY" eq ref $res;
498
499 return wantarray ? @$res : $res->[-1];
500 } else {
501 reset_signals;
502 local $SIG{__WARN__};
503 local $SIG{__DIE__};
504 # just in case, this hack effectively disables event
505 # in the child. cleaner and slower would be canceling all watchers,
506 # but this works for the time being.
507 local $Coro::idle;
508 $Coro::current->prio (Coro::PRIO_MAX);
509
510 eval {
511 close $fh1;
512
513 my @res = eval { $cb->(@args) };
514
515 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
516 close $fh2;
517 };
518
519 warn $@ if $@;
520 _exit 0;
383 1 521 }
522}
523
524=item $value = cf::db_get $family => $key
525
526Returns a single value from the environment database.
527
528=item cf::db_put $family => $key => $value
529
530Stores the given C<$value> in the family. It can currently store binary
531data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
532
533=cut
534
535our $DB;
536
537sub db_init {
538 unless ($DB) {
539 $DB = BDB::db_create $DB_ENV;
540
541 cf::sync_job {
542 eval {
543 $DB->set_flags (BDB::CHKSUM);
544
545 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
546 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
547 cf::cleanup "db_open(db): $!" if $!;
548 };
549 cf::cleanup "db_open(db): $@" if $@;
550 };
551 }
552}
553
554sub db_get($$) {
555 my $key = "$_[0]/$_[1]";
556
557 cf::sync_job {
558 BDB::db_get $DB, undef, $key, my $data;
559
560 $! ? ()
561 : $data
562 }
563}
564
565sub db_put($$$) {
566 BDB::dbreq_pri 4;
567 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
568}
569
570=item cf::cache $id => [$paths...], $processversion => $process
571
572Generic caching function that returns the value of the resource $id,
573caching and regenerating as required.
574
575This function can block.
576
577=cut
578
579sub cache {
580 my ($id, $src, $processversion, $process) = @_;
581
582 my $meta =
583 join "\x00",
584 $processversion,
585 map {
586 aio_stat $_
587 and Carp::croak "$_: $!";
588
589 ($_, (stat _)[7,9])
590 } @$src;
591
592 my $dbmeta = db_get cache => "$id/meta";
593 if ($dbmeta ne $meta) {
594 # changed, we may need to process
595
596 my @data;
597 my $md5;
598
599 for (0 .. $#$src) {
600 0 <= aio_load $src->[$_], $data[$_]
601 or Carp::croak "$src->[$_]: $!";
602 }
603
604 # if processing is expensive, check
605 # checksum first
606 if (1) {
607 $md5 =
608 join "\x00",
609 $processversion,
610 map {
611 Coro::cede;
612 ($src->[$_], Digest::MD5::md5_hex $data[$_])
613 } 0.. $#$src;
614
615
616 my $dbmd5 = db_get cache => "$id/md5";
617 if ($dbmd5 eq $md5) {
618 db_put cache => "$id/meta", $meta;
619
620 return db_get cache => "$id/data";
621 }
622 }
623
624 my $t1 = Time::HiRes::time;
625 my $data = $process->(\@data);
626 my $t2 = Time::HiRes::time;
627
628 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
629
630 db_put cache => "$id/data", $data;
631 db_put cache => "$id/md5" , $md5;
632 db_put cache => "$id/meta", $meta;
633
634 return $data;
635 }
636
637 db_get cache => "$id/data"
638}
639
640=item cf::datalog type => key => value, ...
641
642Log a datalog packet of the given type with the given key-value pairs.
643
644=cut
645
646sub datalog($@) {
647 my ($type, %kv) = @_;
648 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 649}
385 650
386=back 651=back
387 652
388=cut 653=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 660attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 661to it. All such attachable objects support the following methods.
397 662
398In the following description, CLASS can be any of C<global>, C<object> 663In the following description, CLASS can be any of C<global>, C<object>
399C<player>, C<client> or C<map> (i.e. the attachable objects in 664C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 665Crossfire TRT).
401 666
402=over 4 667=over 4
403 668
404=item $attachable->attach ($attachment, key => $value...) 669=item $attachable->attach ($attachment, key => $value...)
405 670
568 $registry = $CB_TYPE[$object_type] ||= []; 833 $registry = $CB_TYPE[$object_type] ||= [];
569 834
570 } elsif ($type eq "subtype") { 835 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 836 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 837 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 838 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 839
575 } elsif ($type eq "package") { 840 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 841 my $pkg = shift @arg;
577 842
578 while (my ($name, $id) = each %cb_id) { 843 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 872 _attach $registry, $klass, @attach;
608 } 873 }
609 874
610 $obj->{$name} = \%arg; 875 $obj->{$name} = \%arg;
611 } else { 876 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 877 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 878 }
614 879
615 $obj->{_attachment}{$name} = undef; 880 $obj->{_attachment}{$name} = undef;
616} 881}
617 882
619 if (ref $_[0]) { 884 if (ref $_[0]) {
620 _object_attach @_; 885 _object_attach @_;
621 } else { 886 } else {
622 _attach shift->_attach_registry, @_; 887 _attach shift->_attach_registry, @_;
623 } 888 }
889 _recalc_want;
624}; 890};
625 891
626# all those should be optimised 892# all those should be optimised
627sub cf::attachable::detach { 893sub cf::attachable::detach {
628 my ($obj, $name) = @_; 894 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 897 delete $obj->{_attachment}{$name};
632 reattach ($obj); 898 reattach ($obj);
633 } else { 899 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 900 Carp::croak "cannot, currently, detach class attachments";
635 } 901 }
902 _recalc_want;
636}; 903};
637 904
638sub cf::attachable::attached { 905sub cf::attachable::attached {
639 my ($obj, $name) = @_; 906 my ($obj, $name) = @_;
640 907
655 "; 922 ";
656 die if $@; 923 die if $@;
657} 924}
658 925
659our $override; 926our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 927our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661 928
662sub override { 929sub override {
663 $override = 1; 930 $override = 1;
664 @invoke_results = (); 931 @INVOKE_RESULTS = (@_);
665} 932}
666 933
667sub do_invoke { 934sub do_invoke {
668 my $event = shift; 935 my $event = shift;
669 my $callbacks = shift; 936 my $callbacks = shift;
670 937
671 @invoke_results = (); 938 @INVOKE_RESULTS = ();
672 939
673 local $override; 940 local $override;
674 941
675 for (@$callbacks) { 942 for (@$callbacks) {
676 eval { &{$_->[1]} }; 943 eval { &{$_->[1]} };
693 960
694Generate an object-specific event with the given arguments. 961Generate an object-specific event with the given arguments.
695 962
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 963This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697removed in future versions), and there is no public API to access override 964removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly). 965results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 966
700=back 967=back
701 968
702=cut 969=cut
703 970
704############################################################################# 971#############################################################################
705# object support 972# object support
973#
974
975sub _can_merge {
976 my ($ob1, $ob2) = @_;
977
978 local $Storable::canonical = 1;
979 my $fob1 = Storable::freeze $ob1;
980 my $fob2 = Storable::freeze $ob2;
981
982 $fob1 eq $fob2
983}
706 984
707sub reattach { 985sub reattach {
708 # basically do the same as instantiate, without calling instantiate 986 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_; 987 my ($obj) = @_;
710 988
813 or return; 1091 or return;
814 $av = eval { (Storable::thaw $av)->{objs} }; 1092 $av = eval { (Storable::thaw $av)->{objs} };
815 } 1093 }
816 1094
817 warn sprintf "loading %s (%d)\n", 1095 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1096 $filename, length $data, scalar @{$av || []};
819 return ($data, $av); 1097 return ($data, $av);
820} 1098}
1099
1100=head2 COMMAND CALLBACKS
1101
1102=over 4
1103
1104=cut
821 1105
822############################################################################# 1106#############################################################################
823# command handling &c 1107# command handling &c
824 1108
825=item cf::register_command $name => \&callback($ob,$args); 1109=item cf::register_command $name => \&callback($ob,$args);
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1122 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1123}
840 1124
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1125=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1126
843Register a callbackf ro execution when the client sends an extcmd packet. 1127Register a callback for execution when the client sends an (synchronous)
1128extcmd packet. Ext commands will be processed in the order they are
1129received by the server, like other user commands. The first argument is
1130the logged-in player. Ext commands can only be processed after a player
1131has logged in successfully.
844 1132
845If the callback returns something, it is sent back as if reply was being 1133If the callback returns something, it is sent back as if reply was being
846called. 1134called.
847 1135
1136=item cf::register_exticmd $name => \&callback($ns,$packet);
1137
1138Register a callback for execution when the client sends an (asynchronous)
1139exticmd packet. Exti commands are processed by the server as soon as they
1140are received, i.e. out of order w.r.t. other commands. The first argument
1141is a client socket. Exti commands can be received anytime, even before
1142log-in.
1143
1144If the callback returns something, it is sent back as if reply was being
1145called.
1146
848=cut 1147=cut
849 1148
850sub register_extcmd { 1149sub register_extcmd {
851 my ($name, $cb) = @_; 1150 my ($name, $cb) = @_;
852 1151
853 $EXTCMD{$name} = $cb; 1152 $EXTCMD{$name} = $cb;
1153}
1154
1155sub register_exticmd {
1156 my ($name, $cb) = @_;
1157
1158 $EXTICMD{$name} = $cb;
854} 1159}
855 1160
856cf::player->attach ( 1161cf::player->attach (
857 on_command => sub { 1162 on_command => sub {
858 my ($pl, $name, $params) = @_; 1163 my ($pl, $name, $params) = @_;
867 cf::override; 1172 cf::override;
868 }, 1173 },
869 on_extcmd => sub { 1174 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1175 my ($pl, $buf) = @_;
871 1176
872 my $msg = eval { from_json $buf }; 1177 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1178
874 if (ref $msg) { 1179 if (ref $msg) {
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1180 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876 if (my %reply = $cb->($pl, $msg)) { 1181 if (my %reply = $cb->($pl, $msg)) {
877 $pl->ext_reply ($msg->{msgid}, %reply); 1182 $pl->ext_reply ($msg->{msgid}, %reply);
883 1188
884 cf::override; 1189 cf::override;
885 }, 1190 },
886); 1191);
887 1192
888sub load_extension {
889 my ($path) = @_;
890
891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
892 my $base = $1;
893 my $pkg = $1;
894 $pkg =~ s/[^[:word:]]/_/g;
895 $pkg = "ext::$pkg";
896
897 warn "... loading '$path' into '$pkg'\n";
898
899 open my $fh, "<:utf8", $path
900 or die "$path: $!";
901
902 my $source =
903 "package $pkg; use strict; use utf8;\n"
904 . "#line 1 \"$path\"\n{\n"
905 . (do { local $/; <$fh> })
906 . "\n};\n1";
907
908 unless (eval $source) {
909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 }
916 die $@;
917 }
918
919 push @EXTS, $pkg;
920}
921
922sub load_extensions { 1193sub load_extensions {
1194 cf::sync_job {
1195 my %todo;
1196
923 for my $ext (<$LIBDIR/*.ext>) { 1197 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1198 next unless -r $path;
925 eval { 1199
926 load_extension $ext; 1200 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1201 my $base = $1;
1202 my $pkg = $1;
1203 $pkg =~ s/[^[:word:]]/_/g;
1204 $pkg = "ext::$pkg";
1205
1206 open my $fh, "<:utf8", $path
1207 or die "$path: $!";
1208
1209 my $source = do { local $/; <$fh> };
1210
1211 my %ext = (
1212 path => $path,
1213 base => $base,
1214 pkg => $pkg,
1215 );
1216
1217 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1218 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1219
1220 $ext{source} =
1221 "package $pkg; use strict; use utf8;\n"
1222 . "#line 1 \"$path\"\n{\n"
1223 . $source
1224 . "\n};\n1";
1225
1226 $todo{$base} = \%ext;
1227 }
1228
1229 my %done;
1230 while (%todo) {
1231 my $progress;
1232
1233 while (my ($k, $v) = each %todo) {
1234 for (split /,\s*/, $v->{meta}{depends}) {
1235 goto skip
1236 unless exists $done{$_};
1237 }
1238
1239 warn "... loading '$k' into '$v->{pkg}'\n";
1240
1241 unless (eval $v->{source}) {
1242 my $msg = $@ ? "$v->{path}: $@\n"
1243 : "$v->{base}: extension inactive.\n";
1244
1245 if (exists $v->{meta}{mandatory}) {
1246 warn $msg;
1247 warn "mandatory extension failed to load, exiting.\n";
1248 exit 1;
1249 }
1250
1251 warn $msg;
1252 }
1253
1254 $done{$k} = delete $todo{$k};
1255 push @EXTS, $v->{pkg};
1256 $progress = 1;
927 1 1257 }
928 } or warn "$ext not loaded: $@"; 1258
1259 skip:
1260 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1261 unless $progress;
1262 }
929 } 1263 };
930} 1264}
931 1265
932############################################################################# 1266#############################################################################
933 1267
1268=back
1269
934=head2 CORE EXTENSIONS 1270=head2 CORE EXTENSIONS
935 1271
936Functions and methods that extend core crossfire objects. 1272Functions and methods that extend core crossfire objects.
937 1273
938=cut 1274=cut
950Returns the given player object, loading it if necessary (might block). 1286Returns the given player object, loading it if necessary (might block).
951 1287
952=cut 1288=cut
953 1289
954sub playerdir($) { 1290sub playerdir($) {
955 cf::localdir 1291 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1292 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1293}
961 1294
962sub path($) { 1295sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1296 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1297
965 (playerdir $login) . "/$login.pl" 1298 (playerdir $login) . "/playerdata"
966} 1299}
967 1300
968sub find_active($) { 1301sub find_active($) {
969 $cf::PLAYER{$_[0]} 1302 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1303 and $cf::PLAYER{$_[0]}->active
983 my $login = $_[0]; 1316 my $login = $_[0];
984 1317
985 my $guard = cf::lock_acquire "user_find:$login"; 1318 my $guard = cf::lock_acquire "user_find:$login";
986 1319
987 $cf::PLAYER{$_[0]} || do { 1320 $cf::PLAYER{$_[0]} || do {
1321 # rename old playerfiles to new ones
1322 #TODO: remove when no longer required
1323 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1324 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1325 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1326 aio_unlink +(playerdir $login) . "/$login.pl";
1327
988 my $pl = load_pl path $login 1328 my $pl = load_pl path $login
989 or return; 1329 or return;
990 $cf::PLAYER{$login} = $pl 1330 $cf::PLAYER{$login} = $pl
991 } 1331 }
992 } 1332 }
1076while and may block, so not sync_job-capable, ever. 1416while and may block, so not sync_job-capable, ever.
1077 1417
1078=cut 1418=cut
1079 1419
1080sub list_logins { 1420sub list_logins {
1081 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1421 my $dirs = aio_readdir $PLAYERDIR
1082 or return []; 1422 or return [];
1083 1423
1084 my @logins; 1424 my @logins;
1085 1425
1086 for my $login (@$dirs) { 1426 for my $login (@$dirs) {
1121 } 1461 }
1122 1462
1123 \@paths 1463 \@paths
1124} 1464}
1125 1465
1466=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1467
1468Expand crossfire pod fragments into protocol xml.
1469
1470=cut
1471
1472sub expand_cfpod {
1473 ((my $self), (local $_)) = @_;
1474
1475 # escape & and <
1476 s/&/&amp;/g;
1477 s/(?<![BIUGH])</&lt;/g;
1478
1479 # this is buggy, it needs to properly take care of nested <'s
1480
1481 1 while
1482 # replace B<>, I<>, U<> etc.
1483 s/B<([^\>]*)>/<b>$1<\/b>/
1484 || s/I<([^\>]*)>/<i>$1<\/i>/
1485 || s/U<([^\>]*)>/<u>$1<\/u>/
1486 # replace G<male|female> tags
1487 || s{G<([^>|]*)\|([^>]*)>}{
1488 $self->gender ? $2 : $1
1489 }ge
1490 # replace H<hint text>
1491 || s{H<([^\>]*)>}
1492 {
1493 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1494 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1495 "")
1496 [$self->{hintmode}]
1497 }ge;
1498
1499 # create single paragraphs (very hackish)
1500 s/(?<=\S)\n(?=\w)/ /g;
1501
1502 # compress some whitespace
1503 s/\s+\n/\n/g; # ws line-ends
1504 s/\n\n+/\n/g; # double lines
1505 s/^\n+//; # beginning lines
1506 s/\n+$//; # ending lines
1507
1508 $_
1509}
1510
1511sub hintmode {
1512 $_[0]{hintmode} = $_[1] if @_ > 1;
1513 $_[0]{hintmode}
1514}
1515
1126=item $player->ext_reply ($msgid, $msgtype, %msg) 1516=item $player->ext_reply ($msgid, %msg)
1127 1517
1128Sends an ext reply to the player. 1518Sends an ext reply to the player.
1129 1519
1130=cut 1520=cut
1131 1521
1132sub ext_reply($$$%) { 1522sub ext_reply($$%) {
1133 my ($self, $id, %msg) = @_; 1523 my ($self, $id, %msg) = @_;
1134 1524
1135 $msg{msgid} = $id; 1525 $msg{msgid} = $id;
1136 1526 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1137 $self->send ("ext " . cf::to_json \%msg);
1138} 1527}
1139 1528
1140package cf; 1529=item $player->ext_event ($type, %msg)
1530
1531Sends an ext event to the client.
1532
1533=cut
1534
1535sub ext_event($$%) {
1536 my ($self, $type, %msg) = @_;
1537
1538 $self->ns->ext_event ($type, %msg);
1539}
1540
1541=head3 cf::region
1542
1543=over 4
1544
1545=cut
1546
1547package cf::region;
1548
1549=item cf::region::find_by_path $path
1550
1551Tries to decuce the likely region for a map knowing only its path.
1552
1553=cut
1554
1555sub find_by_path($) {
1556 my ($path) = @_;
1557
1558 my ($match, $specificity);
1559
1560 for my $region (list) {
1561 if ($region->{match} && $path =~ $region->{match}) {
1562 ($match, $specificity) = ($region, $region->specificity)
1563 if $region->specificity > $specificity;
1564 }
1565 }
1566
1567 $match
1568}
1141 1569
1142=back 1570=back
1143
1144 1571
1145=head3 cf::map 1572=head3 cf::map
1146 1573
1147=over 4 1574=over 4
1148 1575
1203 my ($self, $merge) = @_; 1630 my ($self, $merge) = @_;
1204 1631
1205 # we have to keep some variables in memory intact 1632 # we have to keep some variables in memory intact
1206 local $self->{path}; 1633 local $self->{path};
1207 local $self->{load_path}; 1634 local $self->{load_path};
1208 local $self->{deny_save};
1209 local $self->{deny_reset};
1210 1635
1211 $self->SUPER::thawer_merge ($merge); 1636 $self->SUPER::thawer_merge ($merge);
1212} 1637}
1213 1638
1214sub normalise { 1639sub normalise {
1261 $self->init; # pass $1 etc. 1686 $self->init; # pass $1 etc.
1262 return $self; 1687 return $self;
1263 } 1688 }
1264 } 1689 }
1265 1690
1266 Carp::carp "unable to resolve path '$path' (base '$base')."; 1691 Carp::cluck "unable to resolve path '$path' (base '$base').";
1267 () 1692 ()
1268} 1693}
1269 1694
1270sub init { 1695sub init {
1271 my ($self) = @_; 1696 my ($self) = @_;
1286 1711
1287# the original (read-only) location 1712# the original (read-only) location
1288sub load_path { 1713sub load_path {
1289 my ($self) = @_; 1714 my ($self) = @_;
1290 1715
1291 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1716 "$MAPDIR/$self->{path}.map"
1292} 1717}
1293 1718
1294# the temporary/swap location 1719# the temporary/swap location
1295sub save_path { 1720sub save_path {
1296 my ($self) = @_; 1721 my ($self) = @_;
1297 1722
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1723 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1724 "$TMPDIR/$path.map"
1300} 1725}
1301 1726
1302# the unique path, undef == no special unique path 1727# the unique path, undef == no special unique path
1303sub uniq_path { 1728sub uniq_path {
1304 my ($self) = @_; 1729 my ($self) = @_;
1305 1730
1306 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1731 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1307 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1732 "$UNIQUEDIR/$path"
1308} 1733}
1309 1734
1310# and all this just because we cannot iterate over 1735# and all this just because we cannot iterate over
1311# all maps in C++... 1736# all maps in C++...
1312sub change_all_map_light { 1737sub change_all_map_light {
1313 my ($change) = @_; 1738 my ($change) = @_;
1314 1739
1315 $_->change_map_light ($change) 1740 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP; 1741 for grep $_->outdoor, values %cf::MAP;
1742}
1743
1744sub decay_objects {
1745 my ($self) = @_;
1746
1747 return if $self->{deny_reset};
1748
1749 $self->do_decay_objects;
1317} 1750}
1318 1751
1319sub unlink_save { 1752sub unlink_save {
1320 my ($self) = @_; 1753 my ($self) = @_;
1321 1754
1379 $self->load_header_orig 1812 $self->load_header_orig
1380 or return; 1813 or return;
1381 $self->prepare_orig; 1814 $self->prepare_orig;
1382 } 1815 }
1383 1816
1817 $self->{deny_reset} = 1
1818 if $self->no_reset;
1819
1820 $self->default_region (cf::region::find_by_path $self->{path})
1821 unless $self->default_region;
1822
1384 1 1823 1
1385} 1824}
1386 1825
1387sub find; 1826sub find;
1388sub find { 1827sub find {
1400 $map->{last_save} = $cf::RUNTIME; 1839 $map->{last_save} = $cf::RUNTIME;
1401 1840
1402 $map->load_header 1841 $map->load_header
1403 or return; 1842 or return;
1404 1843
1405 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1844 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1406 # doing this can freeze the server in a sync job, obviously 1845 # doing this can freeze the server in a sync job, obviously
1407 #$cf::WAIT_FOR_TICK->wait; 1846 #$cf::WAIT_FOR_TICK->wait;
1408 $map->reset; 1847 $map->reset;
1409 undef $guard; 1848 undef $guard;
1410 return find $path; 1849 return find $path;
1421 my ($self) = @_; 1860 my ($self) = @_;
1422 1861
1423 local $self->{deny_reset} = 1; # loading can take a long time 1862 local $self->{deny_reset} = 1; # loading can take a long time
1424 1863
1425 my $path = $self->{path}; 1864 my $path = $self->{path};
1865
1866 {
1426 my $guard = cf::lock_acquire "map_load:$path"; 1867 my $guard = cf::lock_acquire "map_load:$path";
1427 1868
1428 return if $self->in_memory != cf::MAP_SWAPPED; 1869 return if $self->in_memory != cf::MAP_SWAPPED;
1429 1870
1430 $self->in_memory (cf::MAP_LOADING); 1871 $self->in_memory (cf::MAP_LOADING);
1431 1872
1432 $self->alloc; 1873 $self->alloc;
1433 1874
1434 $self->pre_load; 1875 $self->pre_load;
1435
1436 $self->_load_objects ($self->{load_path}, 1)
1437 or return;
1438
1439 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1440 if delete $self->{load_original};
1441
1442 if (my $uniq = $self->uniq_path) {
1443 utf8::encode $uniq;
1444 if (aio_open $uniq, O_RDONLY, 0) {
1445 $self->clear_unique_items;
1446 $self->_load_objects ($uniq, 0);
1447 }
1448 }
1449
1450 Coro::cede;
1451
1452 # now do the right thing for maps
1453 $self->link_multipart_objects;
1454
1455 unless ($self->{deny_activate}) {
1456 $self->decay_objects;
1457 $self->fix_auto_apply;
1458 $self->update_buttons;
1459 Coro::cede; 1876 Coro::cede;
1460 $self->set_darkness_map; 1877
1878 $self->_load_objects ($self->{load_path}, 1)
1879 or return;
1880
1881 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1882 if delete $self->{load_original};
1883
1884 if (my $uniq = $self->uniq_path) {
1885 utf8::encode $uniq;
1886 if (aio_open $uniq, O_RDONLY, 0) {
1887 $self->clear_unique_items;
1888 $self->_load_objects ($uniq, 0);
1889 }
1890 }
1891
1892 Coro::cede;
1893 # now do the right thing for maps
1894 $self->link_multipart_objects;
1461 $self->difficulty ($self->estimate_difficulty) 1895 $self->difficulty ($self->estimate_difficulty)
1462 unless $self->difficulty; 1896 unless $self->difficulty;
1463 Coro::cede; 1897 Coro::cede;
1898
1899 unless ($self->{deny_activate}) {
1900 $self->decay_objects;
1901 $self->fix_auto_apply;
1902 $self->update_buttons;
1903 Coro::cede;
1904 $self->set_darkness_map;
1905 Coro::cede;
1464 $self->activate; 1906 $self->activate;
1907 }
1908
1909 $self->in_memory (cf::MAP_IN_MEMORY);
1465 } 1910 }
1466 1911
1467 $self->post_load; 1912 $self->post_load;
1468
1469 $self->in_memory (cf::MAP_IN_MEMORY);
1470} 1913}
1471 1914
1472sub customise_for { 1915sub customise_for {
1473 my ($self, $ob) = @_; 1916 my ($self, $ob) = @_;
1474 1917
1475 return find "~" . $ob->name . "/" . $self->{path} 1918 return find "~" . $ob->name . "/" . $self->{path}
1476 if $self->per_player; 1919 if $self->per_player;
1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1477 1923
1478 $self 1924 $self
1479} 1925}
1480 1926
1481# find and load all maps in the 3x3 area around a map 1927# find and load all maps in the 3x3 area around a map
1528 1974
1529 undef $MAP_PREFETCH{$path}; 1975 undef $MAP_PREFETCH{$path};
1530 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1531 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1532 for my $path (keys %MAP_PREFETCH) { 1978 for my $path (keys %MAP_PREFETCH) {
1533 my $map = find $path 1979 if (my $map = find $path) {
1534 or next;
1535 $map->load; 1980 $map->load;
1981 }
1536 1982
1537 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$path};
1538 } 1984 }
1539 } 1985 }
1540 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1592 2038
1593sub reset_at { 2039sub reset_at {
1594 my ($self) = @_; 2040 my ($self) = @_;
1595 2041
1596 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1597 return 1e99 if $self->isa ("ext::map_per_player");#d#
1598 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1599 2044
1600 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1601 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1602 2047
1613 my ($self) = @_; 2058 my ($self) = @_;
1614 2059
1615 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1616 2061
1617 return if $self->players; 2062 return if $self->players;
1618 return if $self->isa ("ext::map_per_player");#d#
1619 2063
1620 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
1621 2065
1622 $self->in_memory (cf::MAP_SWAPPED); 2066 $self->in_memory (cf::MAP_SWAPPED);
1623 2067
1624 # need to save uniques path 2068 # need to save uniques path
1625 unless ($self->{deny_save}) { 2069 unless ($self->{deny_save}) {
1657 $cf::MAP{$self->path} = $self; 2101 $cf::MAP{$self->path} = $self;
1658 2102
1659 $self->reset; # polite request, might not happen 2103 $self->reset; # polite request, might not happen
1660} 2104}
1661 2105
2106=item $maps = cf::map::tmp_maps
2107
2108Returns an arrayref with all map paths of currently instantiated and saved
2109maps. May block.
2110
2111=cut
2112
2113sub tmp_maps() {
2114 [
2115 map {
2116 utf8::decode $_;
2117 /\.map$/
2118 ? normalise $_
2119 : ()
2120 } @{ aio_readdir $TMPDIR or [] }
2121 ]
2122}
2123
2124=item $maps = cf::map::random_maps
2125
2126Returns an arrayref with all map paths of currently instantiated and saved
2127random maps. May block.
2128
2129=cut
2130
2131sub random_maps() {
2132 [
2133 map {
2134 utf8::decode $_;
2135 /\.map$/
2136 ? normalise "?random/$_"
2137 : ()
2138 } @{ aio_readdir $RANDOMDIR or [] }
2139 ]
2140}
2141
1662=item cf::map::unique_maps 2142=item cf::map::unique_maps
1663 2143
1664Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1665instantiated unique items. May block. 2145instantiated unique items. May block.
1666 2146
1667=cut 2147=cut
1668 2148
1669sub unique_maps() { 2149sub unique_maps() {
1670 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2150 [
1671 or return; 2151 map {
1672
1673 my @paths;
1674
1675 for (@$files) {
1676 utf8::decode $_; 2152 utf8::decode $_;
1677 next if /\.pst$/; 2153 /\.map$/
1678 next unless /^$PATH_SEP/o; 2154 ? normalise $_
1679 2155 : ()
1680 push @paths, cf::map::normalise $_; 2156 } @{ aio_readdir $UNIQUEDIR or [] }
1681 } 2157 ]
1682
1683 \@paths
1684} 2158}
1685 2159
1686package cf; 2160package cf;
1687 2161
1688=back 2162=back
1734 2208
1735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1736 2210
1737 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1738 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1739 } else { 2214 } else {
2215 my $pl = $self->contr;
2216
2217 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2218 my $diag = $pl->{npc_dialog};
2219 $diag->{pl}->ext_reply (
2220 $diag->{id},
2221 msgtype => "reply",
2222 msg => $diag->{pl}->expand_cfpod ($msg),
2223 add_topics => []
2224 );
2225
2226 } else {
1740 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1741 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1742 } 2230 }
1743} 2231}
1744 2232
1745=item $player_object->may ("access") 2233=item $player_object->may ("access")
1746 2234
1794 $self->deactivate_recursive; 2282 $self->deactivate_recursive;
1795 2283
1796 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2284 return if UNIVERSAL::isa $self->map, "ext::map_link";
1797 2285
1798 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2286 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1799 if $self->map; 2287 if $self->map && $self->map->{path} ne "{link}";
1800 2288
1801 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2289 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1802} 2290}
1803 2291
1804sub cf::object::player::leave_link { 2292sub cf::object::player::leave_link {
1805 my ($self, $map, $x, $y) = @_; 2293 my ($self, $map, $x, $y) = @_;
2294
2295 return unless $self->contr->active;
1806 2296
1807 my $link_pos = delete $self->{_link_pos}; 2297 my $link_pos = delete $self->{_link_pos};
1808 2298
1809 unless ($map) { 2299 unless ($map) {
1810 # restore original map position 2300 # restore original map position
1833 2323
1834 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1835 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1836} 2326}
1837 2327
1838cf::player->attach ( 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1839 on_logout => sub {
1840 my ($pl) = @_;
1841 2329
1842 # abort map switching before logout 2330Moves the player to the given map-path and coordinates by first freezing
1843 if ($pl->ob->{_link_pos}) { 2331her, loading and preparing them map, calling the provided $check callback
1844 cf::sync_job { 2332that has to return the map if sucecssful, and then unfreezes the player on
1845 $pl->ob->leave_link 2333the new (success) or old (failed) map position. In either case, $done will
1846 }; 2334be called at the end of this process.
1847 }
1848 },
1849 on_login => sub {
1850 my ($pl) = @_;
1851 2335
1852 # try to abort aborted map switching on player login :)
1853 # should happen only on crashes
1854 if ($pl->ob->{_link_pos}) {
1855 $pl->ob->enter_link;
1856 (async {
1857 $pl->ob->reply (undef,
1858 "There was an internal problem at your last logout, "
1859 . "the server will try to bring you to your intended destination in a second.",
1860 cf::NDI_RED);
1861 # we need this sleep as the login has a concurrent enter_exit running
1862 # and this sleep increases chances of the player not ending up in scorn
1863 Coro::Timer::sleep 1;
1864 $pl->ob->leave_link;
1865 })->prio (2);
1866 }
1867 },
1868);
1869
1870=item $player_object->goto ($path, $x, $y)
1871
1872=cut 2336=cut
2337
2338our $GOTOGEN;
1873 2339
1874sub cf::object::player::goto { 2340sub cf::object::player::goto {
1875 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;
1876 2345
1877 $self->enter_link; 2346 $self->enter_link;
1878 2347
1879 (async { 2348 (async {
1880 my $map = eval { 2349 my $map = eval {
1881 my $map = cf::map::find $path; 2350 my $map = cf::map::find $path;
2351
2352 if ($map) {
1882 $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
1883 $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 $@;
1884 } or 2365 }
1885 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1886 2366
2367 if ($gen == $self->{_goto_generation}) {
2368 delete $self->{_goto_generation};
1887 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
2370 }
2371
2372 $done->() if $done;
1888 })->prio (1); 2373 })->prio (1);
1889} 2374}
1890 2375
1891=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1892 2377
1931 2416
1932 $rmp->{random_seed} ||= $exit->random_seed; 2417 $rmp->{random_seed} ||= $exit->random_seed;
1933 2418
1934 my $data = cf::to_json $rmp; 2419 my $data = cf::to_json $rmp;
1935 my $md5 = Digest::MD5::md5_hex $data; 2420 my $md5 = Digest::MD5::md5_hex $data;
1936 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2421 my $meta = "$RANDOMDIR/$md5.meta";
1937 2422
1938 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2423 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1939 aio_write $fh, 0, (length $data), $data, 0; 2424 aio_write $fh, 0, (length $data), $data, 0;
1940 undef $fh; 2425 undef $fh;
1941 aio_rename "$meta~", $meta; 2426 aio_rename "$meta~", $meta;
1950 2435
1951 return unless $self->type == cf::PLAYER; 2436 return unless $self->type == cf::PLAYER;
1952 2437
1953 if ($exit->slaying eq "/!") { 2438 if ($exit->slaying eq "/!") {
1954 #TODO: this should de-fi-ni-te-ly not be a sync-job 2439 #TODO: this should de-fi-ni-te-ly not be a sync-job
2440 # the problem is that $exit might not survive long enough
2441 # so it needs to be done right now, right here
1955 cf::sync_job { prepare_random_map $exit }; 2442 cf::sync_job { prepare_random_map $exit };
1956 } 2443 }
1957 2444
1958 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;
1959 my $hp = $exit->stats->hp; 2446 my $hp = $exit->stats->hp;
1960 my $sp = $exit->stats->sp; 2447 my $sp = $exit->stats->sp;
1961 2448
1962 $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);
1963 2454
1964 (async { 2455 (async {
1965 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
1966 unless (eval { 2457 unless (eval {
1967 $self->goto ($slaying, $hp, $sp); 2458 $self->goto ($slaying, $hp, $sp);
1968 2459
1969 1; 2460 1;
1970 }) { 2461 }) {
1971 $self->message ("Something went wrong deep within the crossfire server. " 2462 $self->message ("Something went wrong deep within the crossfire server. "
1972 . "I'll try to bring you back to the map you were before. " 2463 . "I'll try to bring you back to the map you were before. "
1973 . "Please report this to the dungeon master!", 2464 . "Please report this to the dungeon master!",
1974 cf::NDI_UNIQUE | cf::NDI_RED); 2465 cf::NDI_UNIQUE | cf::NDI_RED);
1975 2466
1976 warn "ERROR in enter_exit: $@"; 2467 warn "ERROR in enter_exit: $@";
1977 $self->leave_link; 2468 $self->leave_link;
1978 } 2469 }
1979 })->prio (1); 2470 })->prio (1);
1992 2483
1993sub cf::client::send_drawinfo { 2484sub cf::client::send_drawinfo {
1994 my ($self, $text, $flags) = @_; 2485 my ($self, $text, $flags) = @_;
1995 2486
1996 utf8::encode $text; 2487 utf8::encode $text;
1997 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1998} 2489}
1999 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_UNIQUE; # 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_event (channel_info => %$channel);
2512 }
2513
2514 $channel = $channel->{id};
2515 }
2516
2517 return unless @extra || length $msg;
2518
2519 if ($self->can_msg) {
2520 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2521 } else {
2522 # replace some tags by gcfclient-compatible ones
2523 for ($msg) {
2524 1 while
2525 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2526 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2527 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2528 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2529 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2530 }
2531
2532 if ($color >= 0) {
2533 if (0 && $msg =~ /\[/) {
2534 $self->send_packet ("drawextinfo $color 4 0 $msg")
2535 } else {
2536 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2537 $self->send_packet ("drawinfo $color $msg")
2538 }
2539 }
2540 }
2541}
2542
2543=item $client->ext_event ($type, %msg)
2544
2545Sends an ext event to the client.
2546
2547=cut
2548
2549sub cf::client::ext_event($$%) {
2550 my ($self, $type, %msg) = @_;
2551
2552 return unless $self->extcmd;
2553
2554 $msg{msgtype} = "event_$type";
2555 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2556}
2000 2557
2001=item $success = $client->query ($flags, "text", \&cb) 2558=item $success = $client->query ($flags, "text", \&cb)
2002 2559
2003Queues a query to the client, calling the given callback with 2560Queues a query to the client, calling the given callback with
2004the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2561the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2005C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2562C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2006 2563
2007Queries can fail, so check the return code. Or don't, as queries will become 2564Queries can fail, so check the return code. Or don't, as queries will
2008reliable at some point in the future. 2565become reliable at some point in the future.
2009 2566
2010=cut 2567=cut
2011 2568
2012sub cf::client::query { 2569sub cf::client::query {
2013 my ($self, $flags, $text, $cb) = @_; 2570 my ($self, $flags, $text, $cb) = @_;
2021 utf8::encode $text; 2578 utf8::encode $text;
2022 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2579 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2023 2580
2024 $self->send_packet ($self->{query_queue}[0][0]) 2581 $self->send_packet ($self->{query_queue}[0][0])
2025 if @{ $self->{query_queue} } == 1; 2582 if @{ $self->{query_queue} } == 1;
2583
2584 1
2026} 2585}
2027 2586
2028cf::client->attach ( 2587cf::client->attach (
2588 on_connect => sub {
2589 my ($ns) = @_;
2590
2591 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2592 },
2029 on_reply => sub { 2593 on_reply => sub {
2030 my ($ns, $msg) = @_; 2594 my ($ns, $msg) = @_;
2031 2595
2032 # this weird shuffling is so that direct followup queries 2596 # this weird shuffling is so that direct followup queries
2033 # get handled first 2597 # get handled first
2045 } else { 2609 } else {
2046 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2610 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2047 } 2611 }
2048 } 2612 }
2049 }, 2613 },
2614 on_exticmd => sub {
2615 my ($ns, $buf) = @_;
2616
2617 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2618
2619 if (ref $msg) {
2620 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2621 if (my %reply = $cb->($ns, $msg)) {
2622 $reply{msgid} = $msg->{msgid};
2623 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2624 }
2625 }
2626 } else {
2627 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2628 }
2629
2630 cf::override;
2631 },
2050); 2632);
2051 2633
2052=item $client->async (\&cb) 2634=item $client->async (\&cb)
2053 2635
2054Create a new coroutine, running the specified callback. The coroutine will 2636Create a new coroutine, running the specified callback. The coroutine will
2101 2683
2102# here we export the classes and methods available to script code 2684# here we export the classes and methods available to script code
2103 2685
2104=pod 2686=pod
2105 2687
2106The following fucntions and emthods are available within a safe environment: 2688The following functions and methods are available within a safe environment:
2107 2689
2108 cf::object contr pay_amount pay_player map 2690 cf::object
2691 contr pay_amount pay_player map x y force_find force_add
2692 insert remove
2693
2109 cf::object::player player 2694 cf::object::player
2110 cf::player peaceful 2695 player
2111 cf::map trigger 2696
2697 cf::player
2698 peaceful
2699
2700 cf::map
2701 trigger
2112 2702
2113=cut 2703=cut
2114 2704
2115for ( 2705for (
2116 ["cf::object" => qw(contr pay_amount pay_player map)], 2706 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2707 insert remove)],
2117 ["cf::object::player" => qw(player)], 2708 ["cf::object::player" => qw(player)],
2118 ["cf::player" => qw(peaceful)], 2709 ["cf::player" => qw(peaceful)],
2119 ["cf::map" => qw(trigger)], 2710 ["cf::map" => qw(trigger)],
2120) { 2711) {
2121 no strict 'refs'; 2712 no strict 'refs';
2192=back 2783=back
2193 2784
2194=cut 2785=cut
2195 2786
2196############################################################################# 2787#############################################################################
2197
2198=head2 EXTENSION DATABASE SUPPORT
2199
2200Crossfire maintains a very simple database for extension use. It can
2201currently store anything that can be serialised using Storable, which
2202excludes objects.
2203
2204The parameter C<$family> should best start with the name of the extension
2205using it, it should be unique.
2206
2207=over 4
2208
2209=item $value = cf::db_get $family => $key
2210
2211Returns a single value from the database.
2212
2213=item cf::db_put $family => $key => $value
2214
2215Stores the given C<$value> in the family.
2216
2217=cut
2218
2219our $DB;
2220
2221sub db_init {
2222 unless ($DB) {
2223 $DB = BDB::db_create $DB_ENV;
2224
2225 cf::sync_job {
2226 eval {
2227 $DB->set_flags (BDB::CHKSUM);
2228
2229 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2230 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2231 cf::cleanup "db_open(db): $!" if $!;
2232 };
2233 cf::cleanup "db_open(db): $@" if $@;
2234 };
2235
2236 my $path = cf::localdir . "/database.pst";
2237 if (stat $path) {
2238 cf::sync_job {
2239 my $pst = Storable::retrieve $path;
2240
2241 cf::db_put (board => data => $pst->{board});
2242 cf::db_put (guildrules => data => $pst->{guildrules});
2243 cf::db_put (rent => balance => $pst->{rent}{balance});
2244 BDB::db_env_txn_checkpoint $DB_ENV;
2245
2246 unlink $path;
2247 };
2248 }
2249 }
2250}
2251
2252sub db_get($$) {
2253 my $key = "$_[0]/$_[1]";
2254
2255 cf::sync_job {
2256 BDB::db_get $DB, undef, $key, my $data;
2257
2258 $! ? ()
2259 : Compress::LZF::sthaw $data
2260 }
2261}
2262
2263sub db_put($$$) {
2264 BDB::dbreq_pri 4;
2265 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2266}
2267
2268#############################################################################
2269# the server's init and main functions 2788# the server's init and main functions
2270 2789
2271sub init_resources { 2790sub load_facedata($) {
2272 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2791 my ($path) = @_;
2792
2793 warn "loading facedata from $path\n";
2794
2795 my $facedata;
2796 0 < aio_load $path, $facedata
2797 or die "$path: $!";
2798
2799 $facedata = Coro::Storable::thaw $facedata;
2800
2801 $facedata->{version} == 2
2802 or cf::cleanup "$path: version mismatch, cannot proceed.";
2803
2804 {
2805 my $faces = $facedata->{faceinfo};
2806
2807 while (my ($face, $info) = each %$faces) {
2808 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2809 cf::face::set_visibility $idx, $info->{visibility};
2810 cf::face::set_magicmap $idx, $info->{magicmap};
2811 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2812 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2813
2814 cf::cede_to_tick;
2815 }
2816
2817 while (my ($face, $info) = each %$faces) {
2818 next unless $info->{smooth};
2819 my $idx = cf::face::find $face
2820 or next;
2821 if (my $smooth = cf::face::find $info->{smooth}) {
2822 cf::face::set_smooth $idx, $smooth;
2823 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2824 } else {
2825 warn "smooth face '$info->{smooth}' not found for face '$face'";
2826 }
2827
2828 cf::cede_to_tick;
2829 }
2830 }
2831
2832 {
2833 my $anims = $facedata->{animinfo};
2834
2835 while (my ($anim, $info) = each %$anims) {
2836 cf::anim::set $anim, $info->{frames}, $info->{facings};
2837 cf::cede_to_tick;
2838 }
2839
2840 cf::anim::invalidate_all; # d'oh
2841 }
2842
2843 {
2844 # TODO: for gcfclient pleasure, we should give resources
2845 # that gcfclient doesn't grok a >10000 face index.
2846 my $res = $facedata->{resource};
2847 my $enc = JSON::XS->new->utf8->canonical;
2848
2849 while (my ($name, $info) = each %$res) {
2850 my $meta = $enc->encode ({
2851 name => $name,
2852 type => $info->{type},
2853 copyright => $info->{copyright}, #TODO#
2854 });
2855
2856 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2857
2858 if ($name =~ /\.jpg$/) {
2859 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2860 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2861 } else {
2862 my $data = pack "(w/a*)*", $meta, $info->{data};
2863 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2864
2865 cf::face::set_type $idx, 1;
2866 cf::face::set_data $idx, 0, $data, $chk;
2867 }
2868
2869 cf::cede_to_tick;
2870 }
2871 }
2872
2873 1
2874}
2875
2876sub reload_regions {
2877 load_resource_file "$MAPDIR/regions"
2273 or die "unable to load regions file\n";#d# 2878 or die "unable to load regions file\n";
2879
2880 for (cf::region::list) {
2881 $_->{match} = qr/$_->{match}/
2882 if exists $_->{match};
2883 }
2884}
2885
2886sub reload_facedata {
2887 load_facedata "$DATADIR/facedata"
2888 or die "unable to load facedata\n";
2889}
2890
2891sub reload_archetypes {
2892 load_resource_file "$DATADIR/archetypes"
2893 or die "unable to load archetypes\n";
2894 #d# NEED to laod twice to resolve forward references
2895 # this really needs to be done in an extra post-pass
2896 # (which needs to be synchronous, so solve it differently)
2897 load_resource_file "$DATADIR/archetypes"
2898 or die "unable to load archetypes\n";
2899}
2900
2901sub reload_treasures {
2902 load_resource_file "$DATADIR/treasures"
2903 or die "unable to load treasurelists\n";
2904}
2905
2906sub reload_resources {
2907 warn "reloading resource files...\n";
2908
2909 reload_regions;
2910 reload_facedata;
2911 #reload_archetypes;#d#
2912 reload_archetypes;
2913 reload_treasures;
2914
2915 warn "finished reloading resource files\n";
2916}
2917
2918sub init {
2919 reload_resources;
2274} 2920}
2275 2921
2276sub cfg_load { 2922sub cfg_load {
2277 open my $fh, "<:utf8", cf::confdir . "/config" 2923 open my $fh, "<:utf8", "$CONFDIR/config"
2278 or return; 2924 or return;
2279 2925
2280 local $/; 2926 local $/;
2281 *CFG = YAML::Syck::Load <$fh>; 2927 *CFG = YAML::Syck::Load <$fh>;
2282 2928
2290 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2936 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291 and die "WARNING: m(un)lockall failed: $!\n"; 2937 and die "WARNING: m(un)lockall failed: $!\n";
2292 }; 2938 };
2293 warn $@ if $@; 2939 warn $@ if $@;
2294 } 2940 }
2295}
2296
2297sub init {
2298 init_resources;
2299} 2941}
2300 2942
2301sub main { 2943sub main {
2302 # we must not ever block the main coroutine 2944 # we must not ever block the main coroutine
2303 local $Coro::idle = sub { 2945 local $Coro::idle = sub {
2331 }, 2973 },
2332 ); 2974 );
2333 } 2975 }
2334} 2976}
2335 2977
2978sub write_runtime {
2979 my $runtime = "$LOCALDIR/runtime";
2980
2981 # first touch the runtime file to show we are still running:
2982 # the fsync below can take a very very long time.
2983
2984 IO::AIO::aio_utime $runtime, undef, undef;
2985
2986 my $guard = cf::lock_acquire "write_runtime";
2987
2988 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2989 or return;
2990
2991 my $value = $cf::RUNTIME + 90 + 10;
2992 # 10 is the runtime save interval, for a monotonic clock
2993 # 60 allows for the watchdog to kill the server.
2994
2995 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2996 and return;
2997
2998 # always fsync - this file is important
2999 aio_fsync $fh
3000 and return;
3001
3002 # touch it again to show we are up-to-date
3003 aio_utime $fh, undef, undef;
3004
3005 close $fh
3006 or return;
3007
3008 aio_rename "$runtime~", $runtime
3009 and return;
3010
3011 warn "runtime file written.\n";
3012
3013 1
3014}
3015
2336sub emergency_save() { 3016sub emergency_save() {
2337 my $freeze_guard = cf::freeze_mainloop; 3017 my $freeze_guard = cf::freeze_mainloop;
2338 3018
2339 warn "enter emergency perl save\n"; 3019 warn "enter emergency perl save\n";
2340 3020
2371 3051
2372 warn Carp::longmess "post_cleanup backtrace" 3052 warn Carp::longmess "post_cleanup backtrace"
2373 if $make_core; 3053 if $make_core;
2374} 3054}
2375 3055
2376sub reload() { 3056sub do_reload_perl() {
2377 # can/must only be called in main 3057 # can/must only be called in main
2378 if ($Coro::current != $Coro::main) { 3058 if ($Coro::current != $Coro::main) {
2379 warn "can only reload from main coroutine"; 3059 warn "can only reload from main coroutine";
2380 return; 3060 return;
2381 } 3061 }
2406 Coro::cede; 3086 Coro::cede;
2407 last unless IO::AIO::nreqs || BDB::nreqs; 3087 last unless IO::AIO::nreqs || BDB::nreqs;
2408 warn "iterate..."; 3088 warn "iterate...";
2409 } 3089 }
2410 3090
3091 ++$RELOAD;
3092
2411 warn "cancelling all extension coros"; 3093 warn "cancelling all extension coros";
2412 $_->cancel for values %EXT_CORO; 3094 $_->cancel for values %EXT_CORO;
2413 %EXT_CORO = (); 3095 %EXT_CORO = ();
2414 3096
2415 warn "removing commands"; 3097 warn "removing commands";
2416 %COMMAND = (); 3098 %COMMAND = ();
2417 3099
2418 warn "removing ext commands"; 3100 warn "removing ext/exti commands";
2419 %EXTCMD = (); 3101 %EXTCMD = ();
3102 %EXTICMD = ();
2420 3103
2421 warn "unloading/nuking all extensions"; 3104 warn "unloading/nuking all extensions";
2422 for my $pkg (@EXTS) { 3105 for my $pkg (@EXTS) {
2423 warn "... unloading $pkg"; 3106 warn "... unloading $pkg";
2424 3107
2454 Symbol::delete_package "safe::$_" 3137 Symbol::delete_package "safe::$_"
2455 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3138 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2456 3139
2457 warn "unloading cf.pm \"a bit\""; 3140 warn "unloading cf.pm \"a bit\"";
2458 delete $INC{"cf.pm"}; 3141 delete $INC{"cf.pm"};
3142 delete $INC{"cf/pod.pm"};
2459 3143
2460 # don't, removes xs symbols, too, 3144 # don't, removes xs symbols, too,
2461 # and global variables created in xs 3145 # and global variables created in xs
2462 #Symbol::delete_package __PACKAGE__; 3146 #Symbol::delete_package __PACKAGE__;
2463 3147
2472 3156
2473 warn "loading extensions"; 3157 warn "loading extensions";
2474 cf::load_extensions; 3158 cf::load_extensions;
2475 3159
2476 warn "reattaching attachments to objects/players"; 3160 warn "reattaching attachments to objects/players";
2477 _global_reattach; 3161 _global_reattach; # objects, sockets
2478 warn "reattaching attachments to maps"; 3162 warn "reattaching attachments to maps";
2479 reattach $_ for values %MAP; 3163 reattach $_ for values %MAP;
2480 3164 warn "reattaching attachments to players";
2481 warn "loading reloadable resources"; 3165 reattach $_ for values %PLAYER;
2482 init_resources;
2483 3166
2484 warn "leaving sync_job"; 3167 warn "leaving sync_job";
2485 3168
2486 1 3169 1
2487 } or do { 3170 } or do {
2493 warn "reloaded"; 3176 warn "reloaded";
2494}; 3177};
2495 3178
2496our $RELOAD_WATCHER; # used only during reload 3179our $RELOAD_WATCHER; # used only during reload
2497 3180
3181sub reload_perl() {
3182 # doing reload synchronously and two reloads happen back-to-back,
3183 # coro crashes during coro_state_free->destroy here.
3184
3185 $RELOAD_WATCHER ||= Event->timer (
3186 reentrant => 0,
3187 after => 0,
3188 data => WF_AUTOCANCEL,
3189 cb => sub {
3190 do_reload_perl;
3191 undef $RELOAD_WATCHER;
3192 },
3193 );
3194}
3195
2498register_command "reload" => sub { 3196register_command "reload" => sub {
2499 my ($who, $arg) = @_; 3197 my ($who, $arg) = @_;
2500 3198
2501 if ($who->flag (FLAG_WIZ)) { 3199 if ($who->flag (FLAG_WIZ)) {
2502 $who->message ("reloading server."); 3200 $who->message ("reloading server.");
2503 3201 async { reload_perl };
2504 # doing reload synchronously and two reloads happen back-to-back,
2505 # coro crashes during coro_state_free->destroy here.
2506
2507 $RELOAD_WATCHER ||= Event->timer (
2508 reentrant => 0,
2509 after => 0,
2510 data => WF_AUTOCANCEL,
2511 cb => sub {
2512 reload;
2513 undef $RELOAD_WATCHER;
2514 },
2515 );
2516 } 3202 }
2517}; 3203};
2518 3204
2519unshift @INC, $LIBDIR; 3205unshift @INC, $LIBDIR;
2520 3206
2521my $bug_warning = 0; 3207my $bug_warning = 0;
2522 3208
3209our @WAIT_FOR_TICK;
3210our @WAIT_FOR_TICK_BEGIN;
3211
3212sub wait_for_tick {
3213 return unless $TICK_WATCHER->is_active;
3214 return if $Coro::current == $Coro::main;
3215
3216 my $signal = new Coro::Signal;
3217 push @WAIT_FOR_TICK, $signal;
3218 $signal->wait;
3219}
3220
3221sub wait_for_tick_begin {
3222 return unless $TICK_WATCHER->is_active;
3223 return if $Coro::current == $Coro::main;
3224
3225 my $signal = new Coro::Signal;
3226 push @WAIT_FOR_TICK_BEGIN, $signal;
3227 $signal->wait;
3228}
3229
3230 my $min = 1e6;#d#
3231 my $avg = 10;
2523$TICK_WATCHER = Event->timer ( 3232$TICK_WATCHER = Event->timer (
2524 reentrant => 0, 3233 reentrant => 0,
2525 parked => 1, 3234 parked => 1,
2526 prio => 0, 3235 prio => 0,
2527 at => $NEXT_TICK || $TICK, 3236 at => $NEXT_TICK || $TICK,
2531 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3240 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2532 unless ++$bug_warning > 10; 3241 unless ++$bug_warning > 10;
2533 return; 3242 return;
2534 } 3243 }
2535 3244
2536 $NOW = Event::time; 3245 $NOW = $tick_start = Event::time;
2537 3246
2538 cf::server_tick; # one server iteration 3247 cf::server_tick; # one server iteration
3248
3249 0 && sync_job {#d#
3250 for(1..10) {
3251 my $t = Event::time;
3252 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3253 or die;
3254
3255 $map->width (50);
3256 $map->height (50);
3257 $map->alloc;
3258 $map->_load_objects ("/tmp/x.map", 1);
3259 my $t = Event::time - $t;
3260
3261 #next unless $t < 0.0013;#d#
3262 if ($t < $min) {
3263 $min = $t;
3264 }
3265 $avg = $avg * 0.99 + $t * 0.01;
3266 }
3267 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3268 exit 0;
3269 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3270 };
3271
2539 $RUNTIME += $TICK; 3272 $RUNTIME += $TICK;
2540 $NEXT_TICK += $TICK; 3273 $NEXT_TICK += $TICK;
2541 3274
2542 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3275 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2543 $NEXT_RUNTIME_WRITE = $NOW + 10; 3276 $NEXT_RUNTIME_WRITE = $NOW + 10;
2545 write_runtime 3278 write_runtime
2546 or warn "ERROR: unable to write runtime file: $!"; 3279 or warn "ERROR: unable to write runtime file: $!";
2547 }; 3280 };
2548 } 3281 }
2549 3282
2550 $WAIT_FOR_TICK->broadcast;
2551 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2552
2553# my $AFTER = Event::time; 3283# my $AFTER = Event::time;
2554# warn $AFTER - $NOW;#d# 3284# warn $AFTER - $NOW;#d#
2555 3285
3286 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3287 $sig->send;
3288 }
3289 while (my $sig = shift @WAIT_FOR_TICK) {
3290 $sig->send;
3291 }
3292
3293 $NOW = Event::time;
3294
2556 # if we are delayed by four ticks or more, skip them all 3295 # if we are delayed by four ticks or more, skip them all
2557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3296 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2558 3297
2559 $TICK_WATCHER->at ($NEXT_TICK); 3298 $TICK_WATCHER->at ($NEXT_TICK);
2560 $TICK_WATCHER->start; 3299 $TICK_WATCHER->start;
3300
3301 $LOAD = ($NOW - $tick_start) / $TICK;
3302 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3303
3304 _post_tick;
3305
3306
2561 }, 3307 },
2562); 3308);
2563 3309
2564{ 3310{
2565 BDB::max_poll_time $TICK * 0.1; 3311 BDB::max_poll_time $TICK * 0.1;
2593 3339
2594 cf::sync_job { 3340 cf::sync_job {
2595 eval { 3341 eval {
2596 BDB::db_env_open 3342 BDB::db_env_open
2597 $DB_ENV, 3343 $DB_ENV,
2598 $BDB_ENV_DIR, 3344 $BDBDIR,
2599 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3345 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2600 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3346 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2601 0666; 3347 0666;
2602 3348
2603 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3349 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2604 3350
2605 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3351 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2606 $DB_ENV->set_lk_detect; 3352 $DB_ENV->set_lk_detect;
2607 }; 3353 };
2608 3354
2624 prio => 6, 3370 prio => 6,
2625 cb => \&IO::AIO::poll_cb, 3371 cb => \&IO::AIO::poll_cb,
2626 ); 3372 );
2627} 3373}
2628 3374
3375my $_log_backtrace;
3376
3377sub _log_backtrace {
3378 my ($msg, @addr) = @_;
3379
3380 $msg =~ s/\n//;
3381
3382 # limit the # of concurrent backtraces
3383 if ($_log_backtrace < 2) {
3384 ++$_log_backtrace;
3385 async {
3386 my @bt = fork_call {
3387 @addr = map { sprintf "%x", $_ } @addr;
3388 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3389 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3390 or die "addr2line: $!";
3391
3392 my @funcs;
3393 my @res = <$fh>;
3394 chomp for @res;
3395 while (@res) {
3396 my ($func, $line) = splice @res, 0, 2, ();
3397 push @funcs, "[$func] $line";
3398 }
3399
3400 @funcs
3401 };
3402
3403 LOG llevInfo, "[ABT] $msg\n";
3404 LOG llevInfo, "[ABT] $_\n" for @bt;
3405 --$_log_backtrace;
3406 };
3407 } else {
3408 LOG llevInfo, "[ABT] $msg\n";
3409 LOG llevInfo, "[ABT] [suppressed]\n";
3410 }
3411}
3412
3413# load additional modules
3414use cf::pod;
3415
2629END { cf::emergency_save } 3416END { cf::emergency_save }
2630 3417
26311 34181
2632 3419

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines