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.223 by root, Sun Mar 11 02:12:44 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
48our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
49our @EVENT; 61our @EVENT;
50our $LIBDIR = datadir . "/ext";
51 62
52our $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(!)
53our $TICK_WATCHER; 76our $TICK_WATCHER;
54our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
55our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
56our $NEXT_TICK; 79our $NEXT_TICK;
57our $NOW; 80our $NOW;
66our $RUNTIME; 89our $RUNTIME;
67 90
68our %PLAYER; # all users 91our %PLAYER; # all users
69our %MAP; # all maps 92our %MAP; # all maps
70our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
71our $RANDOM_MAPS = cf::localdir . "/random";
72our $BDB_ENV_DIR = cf::localdir . "/db";
73
74our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
75our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
76 94
77# 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 ∕
78our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
79 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
80binmode STDOUT; 102binmode STDOUT;
81binmode STDERR; 103binmode STDERR;
82 104
83# read virtual server time, if available 105# read virtual server time, if available
84unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
85 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
86 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
87 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
88} 110}
89 111
90mkdir cf::localdir; 112mkdir $_
91mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
92mkdir cf::localdir . "/" . cf::tmpdir;
93mkdir cf::localdir . "/" . cf::uniquedir;
94mkdir $RANDOM_MAPS;
95mkdir $BDB_ENV_DIR;
96 114
97our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
98 116
99sub cf::map::normalise; 117sub cf::map::normalise;
100 118
111=item $cf::RUNTIME 129=item $cf::RUNTIME
112 130
113The 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
114every server tick. 132every server tick.
115 133
116=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
117 137
118The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
119be 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.
120 142
121=item $cf::NOW 143=item $cf::NOW
122 144
123The time of the last (current) server tick. 145The time of the last (current) server tick.
124 146
125=item $cf::TICK 147=item $cf::TICK
126 148
127The 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.
128 160
129=item %cf::CFG 161=item %cf::CFG
130 162
131Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
132from wherever your confdir points to. 164from wherever your confdir points to.
133 165
134=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
135 167
136These 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
137or 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
138processing 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.
139window 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.
140 177
141=back 178=back
142 179
143=cut 180=cut
144 181
145BEGIN { 182BEGIN {
146 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
147 my $msg = join "", @_; 184 my $msg = join "", @_;
148 utf8::encode $msg;
149 185
150 $msg .= "\n" 186 $msg .= "\n"
151 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
152 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
153 LOG llevError, $msg; 192 LOG llevError, $msg;
154 }; 193 };
155} 194}
156 195
157@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
158@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
159@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
160@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
161@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';
162@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)
163 203
164# 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
165# within the Safe compartment. 205# within the Safe compartment.
166for my $pkg (qw( 206for my $pkg (qw(
167 cf::global cf::attachable 207 cf::global cf::attachable
175} 215}
176 216
177$Event::DIED = sub { 217$Event::DIED = sub {
178 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
179}; 219};
220
221#############################################################################
180 222
181=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
182 224
183=over 4 225=over 4
184 226
203 $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;
204 $d 246 $d
205 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
206} 248}
207 249
208use JSON::Syck (); # TODO# replace by JSON::PC once working
209
210=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
211 251
212Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
213 253
214=cut
215
216sub from_json($) {
217 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
218 JSON::Syck::Load $_[0]
219}
220
221=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
222 255
223Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
224 257
225=cut 258=cut
226 259
227sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
228 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
229 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
230} 263sub from_json ($) { $json_coder->decode ($_[0]) }
231 264
232=item cf::lock_wait $string 265=item cf::lock_wait $string
233 266
234Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
235 268
241returned. 274returned.
242 275
243Lock 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
244uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
245 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
246=cut 283=cut
247 284
248our %LOCK; 285our %LOCK;
249 286
250sub lock_wait($) { 287sub lock_wait($) {
267 304
268 Coro::guard { 305 Coro::guard {
269 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
270 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
271 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
272} 315}
273 316
274sub freeze_mainloop { 317sub freeze_mainloop {
275 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
276 319
279 }; 322 };
280 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
281 $guard 324 $guard
282} 325}
283 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
284=item cf::async { BLOCK } 377=item cf::async { BLOCK }
285 378
286Currently the same as Coro::async_pool, meaning you cannot use 379Currently the same as Coro::async_pool, meaning you cannot use
287C<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
288thing you are allowed to do is call C<prio> on it. 381thing you are allowed to do is call C<prio> on it.
291 384
292BEGIN { *async = \&Coro::async_pool } 385BEGIN { *async = \&Coro::async_pool }
293 386
294=item cf::sync_job { BLOCK } 387=item cf::sync_job { BLOCK }
295 388
296The design of crossfire+ requires that the main coro ($Coro::main) is 389The design of Crossfire TRT requires that the main coroutine ($Coro::main)
297always able to handle events or runnable, as crossfire+ is only partly 390is always able to handle events or runnable, as Crossfire TRT is only
298reentrant. 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.
299 393
300If 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
301the given BLOCK in another coroutine while waiting for the result. The 395the given BLOCK in another coroutine while waiting for the result. The
302server 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
303fast or be very important. 397fast or be very important.
306 400
307sub sync_job(&) { 401sub sync_job(&) {
308 my ($job) = @_; 402 my ($job) = @_;
309 403
310 if ($Coro::current == $Coro::main) { 404 if ($Coro::current == $Coro::main) {
405 my $time = Event::time;
406
311 # this is the main coro, too bad, we have to block 407 # this is the main coro, too bad, we have to block
312 # till the operation succeeds, freezing the server :/ 408 # till the operation succeeds, freezing the server :/
313 409
314 # TODO: use suspend/resume instead 410 # TODO: use suspend/resume instead
315 # (but this is cancel-safe) 411 # (but this is cancel-safe)
326 422
327 while ($busy) { 423 while ($busy) {
328 Coro::cede or Event::one_event; 424 Coro::cede or Event::one_event;
329 } 425 }
330 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
331 wantarray ? @res : $res[0] 434 wantarray ? @res : $res[0]
332 } else { 435 } else {
333 # we are in another coroutine, how wonderful, everything just works 436 # we are in another coroutine, how wonderful, everything just works
334 437
335 $job->() 438 $job->()
354 $EXT_CORO{$coro+0} = $coro; 457 $EXT_CORO{$coro+0} = $coro;
355 458
356 $coro 459 $coro
357} 460}
358 461
359sub write_runtime { 462=item fork_call { }, $args
360 my $guard = cf::lock_acquire "write_runtime";
361 463
362 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.
363 468
364 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 469=cut
365 or return;
366 470
367 my $value = $cf::RUNTIME + 90 + 10; 471sub _store_scalar {
368 # 10 is the runtime save interval, for a monotonic clock 472 open my $fh, ">", \my $buf
369 # 60 allows for the watchdog to kill the server. 473 or die "fork_call: cannot open fh-to-buf in child : $!";
370 474 Storable::store_fd $_[0], $fh;
371 (aio_write $fh, 0, (length $value), $value, 0) <= 0
372 and return;
373
374 # always fsync - this file is important
375 aio_fsync $fh
376 and return;
377
378 close $fh 475 close $fh;
379 or return;
380 476
381 aio_rename "$runtime~", $runtime 477 $buf
382 and return; 478}
383 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;
384 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 });
385} 649}
386 650
387=back 651=back
388 652
389=cut 653=cut
396attach callbacks/event handlers (a collection of which is called an "attachment") 660attach callbacks/event handlers (a collection of which is called an "attachment")
397to it. All such attachable objects support the following methods. 661to it. All such attachable objects support the following methods.
398 662
399In 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>
400C<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
401crossfire+). 665Crossfire TRT).
402 666
403=over 4 667=over 4
404 668
405=item $attachable->attach ($attachment, key => $value...) 669=item $attachable->attach ($attachment, key => $value...)
406 670
569 $registry = $CB_TYPE[$object_type] ||= []; 833 $registry = $CB_TYPE[$object_type] ||= [];
570 834
571 } elsif ($type eq "subtype") { 835 } elsif ($type eq "subtype") {
572 defined $object_type or Carp::croak "subtype specified without type"; 836 defined $object_type or Carp::croak "subtype specified without type";
573 my $object_subtype = shift @arg; 837 my $object_subtype = shift @arg;
574 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 838 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575 839
576 } elsif ($type eq "package") { 840 } elsif ($type eq "package") {
577 my $pkg = shift @arg; 841 my $pkg = shift @arg;
578 842
579 while (my ($name, $id) = each %cb_id) { 843 while (my ($name, $id) = each %cb_id) {
608 _attach $registry, $klass, @attach; 872 _attach $registry, $klass, @attach;
609 } 873 }
610 874
611 $obj->{$name} = \%arg; 875 $obj->{$name} = \%arg;
612 } else { 876 } else {
613 warn "object uses attachment '$name' that is not available, postponing.\n"; 877 warn "object uses attachment '$name' which is not available, postponing.\n";
614 } 878 }
615 879
616 $obj->{_attachment}{$name} = undef; 880 $obj->{_attachment}{$name} = undef;
617} 881}
618 882
620 if (ref $_[0]) { 884 if (ref $_[0]) {
621 _object_attach @_; 885 _object_attach @_;
622 } else { 886 } else {
623 _attach shift->_attach_registry, @_; 887 _attach shift->_attach_registry, @_;
624 } 888 }
889 _recalc_want;
625}; 890};
626 891
627# all those should be optimised 892# all those should be optimised
628sub cf::attachable::detach { 893sub cf::attachable::detach {
629 my ($obj, $name) = @_; 894 my ($obj, $name) = @_;
632 delete $obj->{_attachment}{$name}; 897 delete $obj->{_attachment}{$name};
633 reattach ($obj); 898 reattach ($obj);
634 } else { 899 } else {
635 Carp::croak "cannot, currently, detach class attachments"; 900 Carp::croak "cannot, currently, detach class attachments";
636 } 901 }
902 _recalc_want;
637}; 903};
638 904
639sub cf::attachable::attached { 905sub cf::attachable::attached {
640 my ($obj, $name) = @_; 906 my ($obj, $name) = @_;
641 907
656 "; 922 ";
657 die if $@; 923 die if $@;
658} 924}
659 925
660our $override; 926our $override;
661our @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?
662 928
663sub override { 929sub override {
664 $override = 1; 930 $override = 1;
665 @invoke_results = (); 931 @INVOKE_RESULTS = (@_);
666} 932}
667 933
668sub do_invoke { 934sub do_invoke {
669 my $event = shift; 935 my $event = shift;
670 my $callbacks = shift; 936 my $callbacks = shift;
671 937
672 @invoke_results = (); 938 @INVOKE_RESULTS = ();
673 939
674 local $override; 940 local $override;
675 941
676 for (@$callbacks) { 942 for (@$callbacks) {
677 eval { &{$_->[1]} }; 943 eval { &{$_->[1]} };
694 960
695Generate an object-specific event with the given arguments. 961Generate an object-specific event with the given arguments.
696 962
697This 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
698removed 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
699results (if you must, access C<@cf::invoke_results> directly). 965results (if you must, access C<@cf::INVOKE_RESULTS> directly).
700 966
701=back 967=back
702 968
703=cut 969=cut
704 970
705############################################################################# 971#############################################################################
706# 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}
707 984
708sub reattach { 985sub reattach {
709 # basically do the same as instantiate, without calling instantiate 986 # basically do the same as instantiate, without calling instantiate
710 my ($obj) = @_; 987 my ($obj) = @_;
711 988
814 or return; 1091 or return;
815 $av = eval { (Storable::thaw $av)->{objs} }; 1092 $av = eval { (Storable::thaw $av)->{objs} };
816 } 1093 }
817 1094
818 warn sprintf "loading %s (%d)\n", 1095 warn sprintf "loading %s (%d)\n",
819 $filename, length $data, scalar @{$av || []};#d# 1096 $filename, length $data, scalar @{$av || []};
820 return ($data, $av); 1097 return ($data, $av);
821} 1098}
1099
1100=head2 COMMAND CALLBACKS
1101
1102=over 4
1103
1104=cut
822 1105
823############################################################################# 1106#############################################################################
824# command handling &c 1107# command handling &c
825 1108
826=item cf::register_command $name => \&callback($ob,$args); 1109=item cf::register_command $name => \&callback($ob,$args);
839 push @{ $COMMAND{$name} }, [$caller, $cb]; 1122 push @{ $COMMAND{$name} }, [$caller, $cb];
840} 1123}
841 1124
842=item cf::register_extcmd $name => \&callback($pl,$packet); 1125=item cf::register_extcmd $name => \&callback($pl,$packet);
843 1126
844Register 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.
845 1132
846If 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
847called. 1134called.
848 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
849=cut 1147=cut
850 1148
851sub register_extcmd { 1149sub register_extcmd {
852 my ($name, $cb) = @_; 1150 my ($name, $cb) = @_;
853 1151
854 $EXTCMD{$name} = $cb; 1152 $EXTCMD{$name} = $cb;
1153}
1154
1155sub register_exticmd {
1156 my ($name, $cb) = @_;
1157
1158 $EXTICMD{$name} = $cb;
855} 1159}
856 1160
857cf::player->attach ( 1161cf::player->attach (
858 on_command => sub { 1162 on_command => sub {
859 my ($pl, $name, $params) = @_; 1163 my ($pl, $name, $params) = @_;
868 cf::override; 1172 cf::override;
869 }, 1173 },
870 on_extcmd => sub { 1174 on_extcmd => sub {
871 my ($pl, $buf) = @_; 1175 my ($pl, $buf) = @_;
872 1176
873 my $msg = eval { from_json $buf }; 1177 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874 1178
875 if (ref $msg) { 1179 if (ref $msg) {
876 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1180 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
877 if (my %reply = $cb->($pl, $msg)) { 1181 if (my %reply = $cb->($pl, $msg)) {
878 $pl->ext_reply ($msg->{msgid}, %reply); 1182 $pl->ext_reply ($msg->{msgid}, %reply);
884 1188
885 cf::override; 1189 cf::override;
886 }, 1190 },
887); 1191);
888 1192
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 { 1193sub load_extensions {
1194 cf::sync_job {
1195 my %todo;
1196
924 for my $ext (<$LIBDIR/*.ext>) { 1197 for my $path (<$LIBDIR/*.ext>) {
925 next unless -r $ext; 1198 next unless -r $path;
926 eval { 1199
927 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;
928 1 1257 }
929 } or warn "$ext not loaded: $@"; 1258
1259 skip:
1260 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1261 unless $progress;
1262 }
930 } 1263 };
931} 1264}
932 1265
933############################################################################# 1266#############################################################################
934 1267
1268=back
1269
935=head2 CORE EXTENSIONS 1270=head2 CORE EXTENSIONS
936 1271
937Functions and methods that extend core crossfire objects. 1272Functions and methods that extend core crossfire objects.
938 1273
939=cut 1274=cut
951Returns the given player object, loading it if necessary (might block). 1286Returns the given player object, loading it if necessary (might block).
952 1287
953=cut 1288=cut
954 1289
955sub playerdir($) { 1290sub playerdir($) {
956 cf::localdir 1291 "$PLAYERDIR/"
957 . "/"
958 . cf::playerdir
959 . "/"
960 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1292 . (ref $_[0] ? $_[0]->ob->name : $_[0])
961} 1293}
962 1294
963sub path($) { 1295sub path($) {
964 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1296 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
965 1297
966 (playerdir $login) . "/$login.pl" 1298 (playerdir $login) . "/playerdata"
967} 1299}
968 1300
969sub find_active($) { 1301sub find_active($) {
970 $cf::PLAYER{$_[0]} 1302 $cf::PLAYER{$_[0]}
971 and $cf::PLAYER{$_[0]}->active 1303 and $cf::PLAYER{$_[0]}->active
984 my $login = $_[0]; 1316 my $login = $_[0];
985 1317
986 my $guard = cf::lock_acquire "user_find:$login"; 1318 my $guard = cf::lock_acquire "user_find:$login";
987 1319
988 $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
989 my $pl = load_pl path $login 1328 my $pl = load_pl path $login
990 or return; 1329 or return;
991 $cf::PLAYER{$login} = $pl 1330 $cf::PLAYER{$login} = $pl
992 } 1331 }
993 } 1332 }
1077while and may block, so not sync_job-capable, ever. 1416while and may block, so not sync_job-capable, ever.
1078 1417
1079=cut 1418=cut
1080 1419
1081sub list_logins { 1420sub list_logins {
1082 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1421 my $dirs = aio_readdir $PLAYERDIR
1083 or return []; 1422 or return [];
1084 1423
1085 my @logins; 1424 my @logins;
1086 1425
1087 for my $login (@$dirs) { 1426 for my $login (@$dirs) {
1122 } 1461 }
1123 1462
1124 \@paths 1463 \@paths
1125} 1464}
1126 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
1127=item $player->ext_reply ($msgid, $msgtype, %msg) 1516=item $player->ext_reply ($msgid, %msg)
1128 1517
1129Sends an ext reply to the player. 1518Sends an ext reply to the player.
1130 1519
1131=cut 1520=cut
1132 1521
1133sub ext_reply($$$%) { 1522sub ext_reply($$%) {
1134 my ($self, $id, %msg) = @_; 1523 my ($self, $id, %msg) = @_;
1135 1524
1136 $msg{msgid} = $id; 1525 $msg{msgid} = $id;
1137 1526 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1138 $self->send ("ext " . cf::to_json \%msg);
1139} 1527}
1140 1528
1141package 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}
1142 1569
1143=back 1570=back
1144
1145 1571
1146=head3 cf::map 1572=head3 cf::map
1147 1573
1148=over 4 1574=over 4
1149 1575
1204 my ($self, $merge) = @_; 1630 my ($self, $merge) = @_;
1205 1631
1206 # we have to keep some variables in memory intact 1632 # we have to keep some variables in memory intact
1207 local $self->{path}; 1633 local $self->{path};
1208 local $self->{load_path}; 1634 local $self->{load_path};
1209 local $self->{deny_save};
1210 local $self->{deny_reset};
1211 1635
1212 $self->SUPER::thawer_merge ($merge); 1636 $self->SUPER::thawer_merge ($merge);
1213} 1637}
1214 1638
1215sub normalise { 1639sub normalise {
1262 $self->init; # pass $1 etc. 1686 $self->init; # pass $1 etc.
1263 return $self; 1687 return $self;
1264 } 1688 }
1265 } 1689 }
1266 1690
1267 Carp::carp "unable to resolve path '$path' (base '$base')."; 1691 Carp::cluck "unable to resolve path '$path' (base '$base').";
1268 () 1692 ()
1269} 1693}
1270 1694
1271sub init { 1695sub init {
1272 my ($self) = @_; 1696 my ($self) = @_;
1287 1711
1288# the original (read-only) location 1712# the original (read-only) location
1289sub load_path { 1713sub load_path {
1290 my ($self) = @_; 1714 my ($self) = @_;
1291 1715
1292 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1716 "$MAPDIR/$self->{path}.map"
1293} 1717}
1294 1718
1295# the temporary/swap location 1719# the temporary/swap location
1296sub save_path { 1720sub save_path {
1297 my ($self) = @_; 1721 my ($self) = @_;
1298 1722
1299 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1723 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1300 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1724 "$TMPDIR/$path.map"
1301} 1725}
1302 1726
1303# the unique path, undef == no special unique path 1727# the unique path, undef == no special unique path
1304sub uniq_path { 1728sub uniq_path {
1305 my ($self) = @_; 1729 my ($self) = @_;
1306 1730
1307 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1731 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1308 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1732 "$UNIQUEDIR/$path"
1309} 1733}
1310 1734
1311# and all this just because we cannot iterate over 1735# and all this just because we cannot iterate over
1312# all maps in C++... 1736# all maps in C++...
1313sub change_all_map_light { 1737sub change_all_map_light {
1314 my ($change) = @_; 1738 my ($change) = @_;
1315 1739
1316 $_->change_map_light ($change) 1740 $_->change_map_light ($change)
1317 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;
1318} 1750}
1319 1751
1320sub unlink_save { 1752sub unlink_save {
1321 my ($self) = @_; 1753 my ($self) = @_;
1322 1754
1380 $self->load_header_orig 1812 $self->load_header_orig
1381 or return; 1813 or return;
1382 $self->prepare_orig; 1814 $self->prepare_orig;
1383 } 1815 }
1384 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
1385 1 1823 1
1386} 1824}
1387 1825
1388sub find; 1826sub find;
1389sub find { 1827sub find {
1401 $map->{last_save} = $cf::RUNTIME; 1839 $map->{last_save} = $cf::RUNTIME;
1402 1840
1403 $map->load_header 1841 $map->load_header
1404 or return; 1842 or return;
1405 1843
1406 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1844 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1407 # doing this can freeze the server in a sync job, obviously 1845 # doing this can freeze the server in a sync job, obviously
1408 #$cf::WAIT_FOR_TICK->wait; 1846 #$cf::WAIT_FOR_TICK->wait;
1409 $map->reset; 1847 $map->reset;
1410 undef $guard; 1848 undef $guard;
1411 return find $path; 1849 return find $path;
1422 my ($self) = @_; 1860 my ($self) = @_;
1423 1861
1424 local $self->{deny_reset} = 1; # loading can take a long time 1862 local $self->{deny_reset} = 1; # loading can take a long time
1425 1863
1426 my $path = $self->{path}; 1864 my $path = $self->{path};
1865
1866 {
1427 my $guard = cf::lock_acquire "map_load:$path"; 1867 my $guard = cf::lock_acquire "map_load:$path";
1428 1868
1429 return if $self->in_memory != cf::MAP_SWAPPED; 1869 return if $self->in_memory != cf::MAP_SWAPPED;
1430 1870
1431 $self->in_memory (cf::MAP_LOADING); 1871 $self->in_memory (cf::MAP_LOADING);
1432 1872
1433 $self->alloc; 1873 $self->alloc;
1434 1874
1435 $self->pre_load; 1875 $self->pre_load;
1436
1437 $self->_load_objects ($self->{load_path}, 1)
1438 or return;
1439
1440 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1441 if delete $self->{load_original};
1442
1443 if (my $uniq = $self->uniq_path) {
1444 utf8::encode $uniq;
1445 if (aio_open $uniq, O_RDONLY, 0) {
1446 $self->clear_unique_items;
1447 $self->_load_objects ($uniq, 0);
1448 }
1449 }
1450
1451 Coro::cede;
1452
1453 # now do the right thing for maps
1454 $self->link_multipart_objects;
1455
1456 unless ($self->{deny_activate}) {
1457 $self->decay_objects;
1458 $self->fix_auto_apply;
1459 $self->update_buttons;
1460 Coro::cede; 1876 Coro::cede;
1461 $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;
1462 $self->difficulty ($self->estimate_difficulty) 1895 $self->difficulty ($self->estimate_difficulty)
1463 unless $self->difficulty; 1896 unless $self->difficulty;
1464 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;
1465 $self->activate; 1906 $self->activate;
1907 }
1908
1909 $self->in_memory (cf::MAP_IN_MEMORY);
1466 } 1910 }
1467 1911
1468 $self->post_load; 1912 $self->post_load;
1469
1470 $self->in_memory (cf::MAP_IN_MEMORY);
1471} 1913}
1472 1914
1473sub customise_for { 1915sub customise_for {
1474 my ($self, $ob) = @_; 1916 my ($self, $ob) = @_;
1475 1917
1476 return find "~" . $ob->name . "/" . $self->{path} 1918 return find "~" . $ob->name . "/" . $self->{path}
1477 if $self->per_player; 1919 if $self->per_player;
1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1478 1923
1479 $self 1924 $self
1480} 1925}
1481 1926
1482# 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
1529 1974
1530 undef $MAP_PREFETCH{$path}; 1975 undef $MAP_PREFETCH{$path};
1531 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1532 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1533 for my $path (keys %MAP_PREFETCH) { 1978 for my $path (keys %MAP_PREFETCH) {
1534 my $map = find $path 1979 if (my $map = find $path) {
1535 or next;
1536 $map->load; 1980 $map->load;
1981 }
1537 1982
1538 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$path};
1539 } 1984 }
1540 } 1985 }
1541 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1593 2038
1594sub reset_at { 2039sub reset_at {
1595 my ($self) = @_; 2040 my ($self) = @_;
1596 2041
1597 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1598 return 1e99 if $self->isa ("ext::map_per_player");#d#
1599 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1600 2044
1601 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1602 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;
1603 2047
1614 my ($self) = @_; 2058 my ($self) = @_;
1615 2059
1616 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1617 2061
1618 return if $self->players; 2062 return if $self->players;
1619 return if $self->isa ("ext::map_per_player");#d#
1620 2063
1621 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
1622 2065
1623 $self->in_memory (cf::MAP_SWAPPED); 2066 $self->in_memory (cf::MAP_SWAPPED);
1624 2067
1625 # need to save uniques path 2068 # need to save uniques path
1626 unless ($self->{deny_save}) { 2069 unless ($self->{deny_save}) {
1658 $cf::MAP{$self->path} = $self; 2101 $cf::MAP{$self->path} = $self;
1659 2102
1660 $self->reset; # polite request, might not happen 2103 $self->reset; # polite request, might not happen
1661} 2104}
1662 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
1663=item cf::map::unique_maps 2142=item cf::map::unique_maps
1664 2143
1665Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1666instantiated unique items. May block. 2145instantiated unique items. May block.
1667 2146
1668=cut 2147=cut
1669 2148
1670sub unique_maps() { 2149sub unique_maps() {
1671 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2150 [
1672 or return; 2151 map {
1673
1674 my @paths;
1675
1676 for (@$files) {
1677 utf8::decode $_; 2152 utf8::decode $_;
1678 next if /\.pst$/; 2153 /\.map$/
1679 next unless /^$PATH_SEP/o; 2154 ? normalise $_
1680 2155 : ()
1681 push @paths, cf::map::normalise $_; 2156 } @{ aio_readdir $UNIQUEDIR or [] }
1682 } 2157 ]
1683
1684 \@paths
1685} 2158}
1686 2159
1687package cf; 2160package cf;
1688 2161
1689=back 2162=back
1735 2208
1736 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1737 2210
1738 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1739 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1740 } 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 {
1741 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1742 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1743 } 2230 }
1744} 2231}
1745 2232
1746=item $player_object->may ("access") 2233=item $player_object->may ("access")
1747 2234
1795 $self->deactivate_recursive; 2282 $self->deactivate_recursive;
1796 2283
1797 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2284 return if UNIVERSAL::isa $self->map, "ext::map_link";
1798 2285
1799 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2286 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1800 if $self->map; 2287 if $self->map && $self->map->{path} ne "{link}";
1801 2288
1802 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2289 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1803} 2290}
1804 2291
1805sub cf::object::player::leave_link { 2292sub cf::object::player::leave_link {
1806 my ($self, $map, $x, $y) = @_; 2293 my ($self, $map, $x, $y) = @_;
2294
2295 return unless $self->contr->active;
1807 2296
1808 my $link_pos = delete $self->{_link_pos}; 2297 my $link_pos = delete $self->{_link_pos};
1809 2298
1810 unless ($map) { 2299 unless ($map) {
1811 # restore original map position 2300 # restore original map position
1834 2323
1835 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1836 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1837} 2326}
1838 2327
1839cf::player->attach ( 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1840 on_logout => sub {
1841 my ($pl) = @_;
1842 2329
1843 # abort map switching before logout 2330Moves the player to the given map-path and coordinates by first freezing
1844 if ($pl->ob->{_link_pos}) { 2331her, loading and preparing them map, calling the provided $check callback
1845 cf::sync_job { 2332that has to return the map if sucecssful, and then unfreezes the player on
1846 $pl->ob->leave_link 2333the new (success) or old (failed) map position. In either case, $done will
1847 }; 2334be called at the end of this process.
1848 }
1849 },
1850 on_login => sub {
1851 my ($pl) = @_;
1852 2335
1853 # try to abort aborted map switching on player login :)
1854 # should happen only on crashes
1855 if ($pl->ob->{_link_pos}) {
1856 $pl->ob->enter_link;
1857 (async {
1858 $pl->ob->reply (undef,
1859 "There was an internal problem at your last logout, "
1860 . "the server will try to bring you to your intended destination in a second.",
1861 cf::NDI_RED);
1862 # we need this sleep as the login has a concurrent enter_exit running
1863 # and this sleep increases chances of the player not ending up in scorn
1864 Coro::Timer::sleep 1;
1865 $pl->ob->leave_link;
1866 })->prio (2);
1867 }
1868 },
1869);
1870
1871=item $player_object->goto ($path, $x, $y)
1872
1873=cut 2336=cut
2337
2338our $GOTOGEN;
1874 2339
1875sub cf::object::player::goto { 2340sub cf::object::player::goto {
1876 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;
1877 2345
1878 $self->enter_link; 2346 $self->enter_link;
1879 2347
1880 (async { 2348 (async {
1881 my $map = eval { 2349 my $map = eval {
1882 my $map = cf::map::find $path; 2350 my $map = cf::map::find $path;
2351
2352 if ($map) {
1883 $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
1884 $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 $@;
1885 } or 2365 }
1886 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1887 2366
2367 if ($gen == $self->{_goto_generation}) {
2368 delete $self->{_goto_generation};
1888 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
2370 }
2371
2372 $done->() if $done;
1889 })->prio (1); 2373 })->prio (1);
1890} 2374}
1891 2375
1892=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1893 2377
1932 2416
1933 $rmp->{random_seed} ||= $exit->random_seed; 2417 $rmp->{random_seed} ||= $exit->random_seed;
1934 2418
1935 my $data = cf::to_json $rmp; 2419 my $data = cf::to_json $rmp;
1936 my $md5 = Digest::MD5::md5_hex $data; 2420 my $md5 = Digest::MD5::md5_hex $data;
1937 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2421 my $meta = "$RANDOMDIR/$md5.meta";
1938 2422
1939 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2423 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1940 aio_write $fh, 0, (length $data), $data, 0; 2424 aio_write $fh, 0, (length $data), $data, 0;
1941 undef $fh; 2425 undef $fh;
1942 aio_rename "$meta~", $meta; 2426 aio_rename "$meta~", $meta;
1951 2435
1952 return unless $self->type == cf::PLAYER; 2436 return unless $self->type == cf::PLAYER;
1953 2437
1954 if ($exit->slaying eq "/!") { 2438 if ($exit->slaying eq "/!") {
1955 #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
1956 cf::sync_job { prepare_random_map $exit }; 2442 cf::sync_job { prepare_random_map $exit };
1957 } 2443 }
1958 2444
1959 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;
1960 my $hp = $exit->stats->hp; 2446 my $hp = $exit->stats->hp;
1961 my $sp = $exit->stats->sp; 2447 my $sp = $exit->stats->sp;
1962 2448
1963 $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);
1964 2454
1965 (async { 2455 (async {
1966 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
1967 unless (eval { 2457 unless (eval {
1968 $self->goto ($slaying, $hp, $sp); 2458 $self->goto ($slaying, $hp, $sp);
1969 2459
1970 1; 2460 1;
1971 }) { 2461 }) {
1972 $self->message ("Something went wrong deep within the crossfire server. " 2462 $self->message ("Something went wrong deep within the crossfire server. "
1973 . "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. "
1974 . "Please report this to the dungeon master!", 2464 . "Please report this to the dungeon master!",
1975 cf::NDI_UNIQUE | cf::NDI_RED); 2465 cf::NDI_UNIQUE | cf::NDI_RED);
1976 2466
1977 warn "ERROR in enter_exit: $@"; 2467 warn "ERROR in enter_exit: $@";
1978 $self->leave_link; 2468 $self->leave_link;
1979 } 2469 }
1980 })->prio (1); 2470 })->prio (1);
1993 2483
1994sub cf::client::send_drawinfo { 2484sub cf::client::send_drawinfo {
1995 my ($self, $text, $flags) = @_; 2485 my ($self, $text, $flags) = @_;
1996 2486
1997 utf8::encode $text; 2487 utf8::encode $text;
1998 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1999} 2489}
2000 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}
2001 2557
2002=item $success = $client->query ($flags, "text", \&cb) 2558=item $success = $client->query ($flags, "text", \&cb)
2003 2559
2004Queues a query to the client, calling the given callback with 2560Queues a query to the client, calling the given callback with
2005the 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>,
2006C<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>.
2007 2563
2008Queries 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
2009reliable at some point in the future. 2565become reliable at some point in the future.
2010 2566
2011=cut 2567=cut
2012 2568
2013sub cf::client::query { 2569sub cf::client::query {
2014 my ($self, $flags, $text, $cb) = @_; 2570 my ($self, $flags, $text, $cb) = @_;
2022 utf8::encode $text; 2578 utf8::encode $text;
2023 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2579 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2024 2580
2025 $self->send_packet ($self->{query_queue}[0][0]) 2581 $self->send_packet ($self->{query_queue}[0][0])
2026 if @{ $self->{query_queue} } == 1; 2582 if @{ $self->{query_queue} } == 1;
2583
2584 1
2027} 2585}
2028 2586
2029cf::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 },
2030 on_reply => sub { 2593 on_reply => sub {
2031 my ($ns, $msg) = @_; 2594 my ($ns, $msg) = @_;
2032 2595
2033 # this weird shuffling is so that direct followup queries 2596 # this weird shuffling is so that direct followup queries
2034 # get handled first 2597 # get handled first
2046 } else { 2609 } else {
2047 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2610 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2048 } 2611 }
2049 } 2612 }
2050 }, 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 },
2051); 2632);
2052 2633
2053=item $client->async (\&cb) 2634=item $client->async (\&cb)
2054 2635
2055Create a new coroutine, running the specified callback. The coroutine will 2636Create a new coroutine, running the specified callback. The coroutine will
2102 2683
2103# here we export the classes and methods available to script code 2684# here we export the classes and methods available to script code
2104 2685
2105=pod 2686=pod
2106 2687
2107The following fucntions and emthods are available within a safe environment: 2688The following functions and methods are available within a safe environment:
2108 2689
2109 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
2110 cf::object::player player 2694 cf::object::player
2111 cf::player peaceful 2695 player
2112 cf::map trigger 2696
2697 cf::player
2698 peaceful
2699
2700 cf::map
2701 trigger
2113 2702
2114=cut 2703=cut
2115 2704
2116for ( 2705for (
2117 ["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)],
2118 ["cf::object::player" => qw(player)], 2708 ["cf::object::player" => qw(player)],
2119 ["cf::player" => qw(peaceful)], 2709 ["cf::player" => qw(peaceful)],
2120 ["cf::map" => qw(trigger)], 2710 ["cf::map" => qw(trigger)],
2121) { 2711) {
2122 no strict 'refs'; 2712 no strict 'refs';
2193=back 2783=back
2194 2784
2195=cut 2785=cut
2196 2786
2197############################################################################# 2787#############################################################################
2198
2199=head2 EXTENSION DATABASE SUPPORT
2200
2201Crossfire maintains a very simple database for extension use. It can
2202currently store anything that can be serialised using Storable, which
2203excludes objects.
2204
2205The parameter C<$family> should best start with the name of the extension
2206using it, it should be unique.
2207
2208=over 4
2209
2210=item $value = cf::db_get $family => $key
2211
2212Returns a single value from the database.
2213
2214=item cf::db_put $family => $key => $value
2215
2216Stores the given C<$value> in the family.
2217
2218=cut
2219
2220our $DB;
2221
2222sub db_init {
2223 unless ($DB) {
2224 $DB = BDB::db_create $DB_ENV;
2225
2226 cf::sync_job {
2227 eval {
2228 $DB->set_flags (BDB::CHKSUM);
2229
2230 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2231 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2232 cf::cleanup "db_open(db): $!" if $!;
2233 };
2234 cf::cleanup "db_open(db): $@" if $@;
2235 };
2236
2237 my $path = cf::localdir . "/database.pst";
2238 if (stat $path) {
2239 cf::sync_job {
2240 my $pst = Storable::retrieve $path;
2241
2242 cf::db_put (board => data => $pst->{board});
2243 cf::db_put (guildrules => data => $pst->{guildrules});
2244 cf::db_put (rent => balance => $pst->{rent}{balance});
2245 BDB::db_env_txn_checkpoint $DB_ENV;
2246
2247 unlink $path;
2248 };
2249 }
2250 }
2251}
2252
2253sub db_get($$) {
2254 my $key = "$_[0]/$_[1]";
2255
2256 cf::sync_job {
2257 BDB::db_get $DB, undef, $key, my $data;
2258
2259 $! ? ()
2260 : Compress::LZF::sthaw $data
2261 }
2262}
2263
2264sub db_put($$$) {
2265 BDB::dbreq_pri 4;
2266 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2267}
2268
2269#############################################################################
2270# the server's init and main functions 2788# the server's init and main functions
2271 2789
2272sub load_faces { 2790sub load_facedata($) {
2273 my $path = sprintf "%s/faces", cf::datadir; 2791 my ($path) = @_;
2274 2792
2275 warn "loading faces from $path\n"; 2793 warn "loading facedata from $path\n";
2276 2794
2277 my $faces; 2795 my $facedata;
2278 0 < aio_load $path, $faces 2796 0 < aio_load $path, $facedata
2279 or die "$path: $!"; 2797 or die "$path: $!";
2280 2798
2281 Coro::cede;
2282 $faces = Storable::thaw $faces; 2799 $facedata = Coro::Storable::thaw $facedata;
2283 Coro::cede;
2284 2800
2801 $facedata->{version} == 2
2802 or cf::cleanup "$path: version mismatch, cannot proceed.";
2803
2804 {
2805 my $faces = $facedata->{faceinfo};
2806
2285 while (my ($face, $info) = each %$faces) { 2807 while (my ($face, $info) = each %$faces) {
2286 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2808 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2287 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2809 cf::face::set_visibility $idx, $info->{visibility};
2810 cf::face::set_magicmap $idx, $info->{magicmap};
2288 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2811 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2289 Coro::cede; 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 }
2290 } 2871 }
2291 2872
2292 1 2873 1
2293} 2874}
2294 2875
2876sub reload_regions {
2877 load_resource_file "$MAPDIR/regions"
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
2295sub reload_resources { 2906sub reload_resources {
2296 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2907 warn "reloading resource files...\n";
2297 or die "unable to load regions file\n";#d# 2908
2909 reload_regions;
2298 load_faces 2910 reload_facedata;
2299 or die "unable to load faces\n";#d# 2911 #reload_archetypes;#d#
2912 reload_archetypes;
2913 reload_treasures;
2914
2915 warn "finished reloading resource files\n";
2300} 2916}
2301 2917
2302sub init { 2918sub init {
2303 reload_resources; 2919 reload_resources;
2304} 2920}
2305 2921
2306sub cfg_load { 2922sub cfg_load {
2307 open my $fh, "<:utf8", cf::confdir . "/config" 2923 open my $fh, "<:utf8", "$CONFDIR/config"
2308 or return; 2924 or return;
2309 2925
2310 local $/; 2926 local $/;
2311 *CFG = YAML::Syck::Load <$fh>; 2927 *CFG = YAML::Syck::Load <$fh>;
2312 2928
2357 }, 2973 },
2358 ); 2974 );
2359 } 2975 }
2360} 2976}
2361 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
2362sub emergency_save() { 3016sub emergency_save() {
2363 my $freeze_guard = cf::freeze_mainloop; 3017 my $freeze_guard = cf::freeze_mainloop;
2364 3018
2365 warn "enter emergency perl save\n"; 3019 warn "enter emergency perl save\n";
2366 3020
2397 3051
2398 warn Carp::longmess "post_cleanup backtrace" 3052 warn Carp::longmess "post_cleanup backtrace"
2399 if $make_core; 3053 if $make_core;
2400} 3054}
2401 3055
2402sub reload() { 3056sub do_reload_perl() {
2403 # can/must only be called in main 3057 # can/must only be called in main
2404 if ($Coro::current != $Coro::main) { 3058 if ($Coro::current != $Coro::main) {
2405 warn "can only reload from main coroutine"; 3059 warn "can only reload from main coroutine";
2406 return; 3060 return;
2407 } 3061 }
2441 %EXT_CORO = (); 3095 %EXT_CORO = ();
2442 3096
2443 warn "removing commands"; 3097 warn "removing commands";
2444 %COMMAND = (); 3098 %COMMAND = ();
2445 3099
2446 warn "removing ext commands"; 3100 warn "removing ext/exti commands";
2447 %EXTCMD = (); 3101 %EXTCMD = ();
3102 %EXTICMD = ();
2448 3103
2449 warn "unloading/nuking all extensions"; 3104 warn "unloading/nuking all extensions";
2450 for my $pkg (@EXTS) { 3105 for my $pkg (@EXTS) {
2451 warn "... unloading $pkg"; 3106 warn "... unloading $pkg";
2452 3107
2482 Symbol::delete_package "safe::$_" 3137 Symbol::delete_package "safe::$_"
2483 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);
2484 3139
2485 warn "unloading cf.pm \"a bit\""; 3140 warn "unloading cf.pm \"a bit\"";
2486 delete $INC{"cf.pm"}; 3141 delete $INC{"cf.pm"};
3142 delete $INC{"cf/pod.pm"};
2487 3143
2488 # don't, removes xs symbols, too, 3144 # don't, removes xs symbols, too,
2489 # and global variables created in xs 3145 # and global variables created in xs
2490 #Symbol::delete_package __PACKAGE__; 3146 #Symbol::delete_package __PACKAGE__;
2491 3147
2506 warn "reattaching attachments to maps"; 3162 warn "reattaching attachments to maps";
2507 reattach $_ for values %MAP; 3163 reattach $_ for values %MAP;
2508 warn "reattaching attachments to players"; 3164 warn "reattaching attachments to players";
2509 reattach $_ for values %PLAYER; 3165 reattach $_ for values %PLAYER;
2510 3166
2511 warn "loading reloadable resources";
2512 reload_resources;
2513
2514 warn "leaving sync_job"; 3167 warn "leaving sync_job";
2515 3168
2516 1 3169 1
2517 } or do { 3170 } or do {
2518 warn $@; 3171 warn $@;
2523 warn "reloaded"; 3176 warn "reloaded";
2524}; 3177};
2525 3178
2526our $RELOAD_WATCHER; # used only during reload 3179our $RELOAD_WATCHER; # used only during reload
2527 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
2528register_command "reload" => sub { 3196register_command "reload" => sub {
2529 my ($who, $arg) = @_; 3197 my ($who, $arg) = @_;
2530 3198
2531 if ($who->flag (FLAG_WIZ)) { 3199 if ($who->flag (FLAG_WIZ)) {
2532 $who->message ("reloading server."); 3200 $who->message ("reloading server.");
2533 3201 async { reload_perl };
2534 # doing reload synchronously and two reloads happen back-to-back,
2535 # coro crashes during coro_state_free->destroy here.
2536
2537 $RELOAD_WATCHER ||= Event->timer (
2538 reentrant => 0,
2539 after => 0,
2540 data => WF_AUTOCANCEL,
2541 cb => sub {
2542 reload;
2543 undef $RELOAD_WATCHER;
2544 },
2545 );
2546 } 3202 }
2547}; 3203};
2548 3204
2549unshift @INC, $LIBDIR; 3205unshift @INC, $LIBDIR;
2550 3206
2551my $bug_warning = 0; 3207my $bug_warning = 0;
2552 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;
2553$TICK_WATCHER = Event->timer ( 3232$TICK_WATCHER = Event->timer (
2554 reentrant => 0, 3233 reentrant => 0,
2555 parked => 1, 3234 parked => 1,
2556 prio => 0, 3235 prio => 0,
2557 at => $NEXT_TICK || $TICK, 3236 at => $NEXT_TICK || $TICK,
2561 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"
2562 unless ++$bug_warning > 10; 3241 unless ++$bug_warning > 10;
2563 return; 3242 return;
2564 } 3243 }
2565 3244
2566 $NOW = Event::time; 3245 $NOW = $tick_start = Event::time;
2567 3246
2568 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
2569 $RUNTIME += $TICK; 3272 $RUNTIME += $TICK;
2570 $NEXT_TICK += $TICK; 3273 $NEXT_TICK += $TICK;
2571 3274
2572 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3275 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2573 $NEXT_RUNTIME_WRITE = $NOW + 10; 3276 $NEXT_RUNTIME_WRITE = $NOW + 10;
2575 write_runtime 3278 write_runtime
2576 or warn "ERROR: unable to write runtime file: $!"; 3279 or warn "ERROR: unable to write runtime file: $!";
2577 }; 3280 };
2578 } 3281 }
2579 3282
2580 $WAIT_FOR_TICK->broadcast;
2581 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2582
2583# my $AFTER = Event::time; 3283# my $AFTER = Event::time;
2584# warn $AFTER - $NOW;#d# 3284# warn $AFTER - $NOW;#d#
2585 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
2586 # 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
2587 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3296 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2588 3297
2589 $TICK_WATCHER->at ($NEXT_TICK); 3298 $TICK_WATCHER->at ($NEXT_TICK);
2590 $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
2591 }, 3307 },
2592); 3308);
2593 3309
2594{ 3310{
2595 BDB::max_poll_time $TICK * 0.1; 3311 BDB::max_poll_time $TICK * 0.1;
2623 3339
2624 cf::sync_job { 3340 cf::sync_job {
2625 eval { 3341 eval {
2626 BDB::db_env_open 3342 BDB::db_env_open
2627 $DB_ENV, 3343 $DB_ENV,
2628 $BDB_ENV_DIR, 3344 $BDBDIR,
2629 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
2630 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3346 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2631 0666; 3347 0666;
2632 3348
2633 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3349 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2634 3350
2635 $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);
2636 $DB_ENV->set_lk_detect; 3352 $DB_ENV->set_lk_detect;
2637 }; 3353 };
2638 3354
2654 prio => 6, 3370 prio => 6,
2655 cb => \&IO::AIO::poll_cb, 3371 cb => \&IO::AIO::poll_cb,
2656 ); 3372 );
2657} 3373}
2658 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
2659END { cf::emergency_save } 3416END { cf::emergency_save }
2660 3417
26611 34181
2662 3419

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines