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.222 by root, Tue Mar 6 03:06:00 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 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[, $name]]
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
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
283=item cf::async { BLOCK } 383=item cf::async { BLOCK }
284 384
285Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
286C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
287thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
290 390
291BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
292 392
293=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
294 394
295The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
296always able to handle events or runnable, as crossfire+ is only partly 396is 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. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
298 399
299If it must be done, put the blocking parts into C<sync_job>. This will run 400If 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 401the given BLOCK in another coroutine while waiting for the result. The
301server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
302fast or be very important. 403fast or be very important.
305 406
306sub sync_job(&) { 407sub sync_job(&) {
307 my ($job) = @_; 408 my ($job) = @_;
308 409
309 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
310 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
311 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
312 415
313 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
314 # (but this is cancel-safe) 417 # (but this is cancel-safe)
325 428
326 while ($busy) { 429 while ($busy) {
327 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
328 } 431 }
329 432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
330 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
331 } else { 441 } else {
332 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
333 443
334 $job->() 444 $job->()
353 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
354 464
355 $coro 465 $coro
356} 466}
357 467
358sub write_runtime { 468=item fork_call { }, $args
359 my $guard = cf::lock_acquire "write_runtime";
360 469
361 my $runtime = cf::localdir . "/runtime"; 470Executes the given code block with the given arguments in a seperate
471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
362 474
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
364 or return;
365 476
366 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
367 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
368 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
369 480 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 481 close $fh;
378 or return;
379 482
380 aio_rename "$runtime~", $runtime 483 $buf
381 and return; 484}
382 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
383 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 655}
385 656
386=back 657=back
387 658
388=cut 659=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
397 668
398In the following description, CLASS can be any of C<global>, C<object> 669In 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 670C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 671Crossfire TRT).
401 672
402=over 4 673=over 4
403 674
404=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
405 676
568 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
569 840
570 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 845
575 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 847 my $pkg = shift @arg;
577 848
578 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
608 } 879 }
609 880
610 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
611 } else { 882 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 884 }
614 885
615 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
616} 887}
617 888
619 if (ref $_[0]) { 890 if (ref $_[0]) {
620 _object_attach @_; 891 _object_attach @_;
621 } else { 892 } else {
622 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
623 } 894 }
895 _recalc_want;
624}; 896};
625 897
626# all those should be optimised 898# all those should be optimised
627sub cf::attachable::detach { 899sub cf::attachable::detach {
628 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
632 reattach ($obj); 904 reattach ($obj);
633 } else { 905 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
635 } 907 }
908 _recalc_want;
636}; 909};
637 910
638sub cf::attachable::attached { 911sub cf::attachable::attached {
639 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
640 913
655 "; 928 ";
656 die if $@; 929 die if $@;
657} 930}
658 931
659our $override; 932our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661 934
662sub override { 935sub override {
663 $override = 1; 936 $override = 1;
664 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
665} 938}
666 939
667sub do_invoke { 940sub do_invoke {
668 my $event = shift; 941 my $event = shift;
669 my $callbacks = shift; 942 my $callbacks = shift;
670 943
671 @invoke_results = (); 944 @INVOKE_RESULTS = ();
672 945
673 local $override; 946 local $override;
674 947
675 for (@$callbacks) { 948 for (@$callbacks) {
676 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
693 966
694Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
695 968
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This 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 970removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 972
700=back 973=back
701 974
702=cut 975=cut
703 976
704############################################################################# 977#############################################################################
705# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
706 990
707sub reattach { 991sub reattach {
708 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_; 993 my ($obj) = @_;
710 994
813 or return; 1097 or return;
814 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
815 } 1099 }
816 1100
817 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
819 return ($data, $av); 1103 return ($data, $av);
820} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
821 1111
822############################################################################# 1112#############################################################################
823# command handling &c 1113# command handling &c
824 1114
825=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1129}
840 1130
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1132
843Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
844 1138
845If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
846called. 1140called.
847 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
848=cut 1153=cut
849 1154
850sub register_extcmd { 1155sub register_extcmd {
851 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
852 1157
853 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
854} 1165}
855 1166
856cf::player->attach ( 1167cf::player->attach (
857 on_command => sub { 1168 on_command => sub {
858 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
867 cf::override; 1178 cf::override;
868 }, 1179 },
869 on_extcmd => sub { 1180 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
871 1182
872 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1184
874 if (ref $msg) { 1185 if (ref $msg) {
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876 if (my %reply = $cb->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
877 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
883 1194
884 cf::override; 1195 cf::override;
885 }, 1196 },
886); 1197);
887 1198
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 { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
923 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1204 next unless -r $path;
925 eval { 1205
926 load_extension $ext; 1206 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1207 my $base = $1;
1208 my $pkg = $1;
1209 $pkg =~ s/[^[:word:]]/_/g;
1210 $pkg = "ext::$pkg";
1211
1212 open my $fh, "<:utf8", $path
1213 or die "$path: $!";
1214
1215 my $source = do { local $/; <$fh> };
1216
1217 my %ext = (
1218 path => $path,
1219 base => $base,
1220 pkg => $pkg,
1221 );
1222
1223 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1224 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1225
1226 $ext{source} =
1227 "package $pkg; use strict; use utf8;\n"
1228 . "#line 1 \"$path\"\n{\n"
1229 . $source
1230 . "\n};\n1";
1231
1232 $todo{$base} = \%ext;
1233 }
1234
1235 my %done;
1236 while (%todo) {
1237 my $progress;
1238
1239 while (my ($k, $v) = each %todo) {
1240 for (split /,\s*/, $v->{meta}{depends}) {
1241 goto skip
1242 unless exists $done{$_};
1243 }
1244
1245 warn "... loading '$k' into '$v->{pkg}'\n";
1246
1247 unless (eval $v->{source}) {
1248 my $msg = $@ ? "$v->{path}: $@\n"
1249 : "$v->{base}: extension inactive.\n";
1250
1251 if (exists $v->{meta}{mandatory}) {
1252 warn $msg;
1253 warn "mandatory extension failed to load, exiting.\n";
1254 exit 1;
1255 }
1256
1257 warn $msg;
1258 }
1259
1260 $done{$k} = delete $todo{$k};
1261 push @EXTS, $v->{pkg};
1262 $progress = 1;
927 1 1263 }
928 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
929 } 1269 };
930} 1270}
931 1271
932############################################################################# 1272#############################################################################
933 1273
1274=back
1275
934=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
935 1277
936Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
937 1279
938=cut 1280=cut
950Returns the given player object, loading it if necessary (might block). 1292Returns the given player object, loading it if necessary (might block).
951 1293
952=cut 1294=cut
953 1295
954sub playerdir($) { 1296sub playerdir($) {
955 cf::localdir 1297 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1298 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1299}
961 1300
962sub path($) { 1301sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1302 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1303
965 (playerdir $login) . "/$login.pl" 1304 (playerdir $login) . "/playerdata"
966} 1305}
967 1306
968sub find_active($) { 1307sub find_active($) {
969 $cf::PLAYER{$_[0]} 1308 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1309 and $cf::PLAYER{$_[0]}->active
983 my $login = $_[0]; 1322 my $login = $_[0];
984 1323
985 my $guard = cf::lock_acquire "user_find:$login"; 1324 my $guard = cf::lock_acquire "user_find:$login";
986 1325
987 $cf::PLAYER{$_[0]} || do { 1326 $cf::PLAYER{$_[0]} || do {
1327 # rename old playerfiles to new ones
1328 #TODO: remove when no longer required
1329 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1330 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1331 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1332 aio_unlink +(playerdir $login) . "/$login.pl";
1333
988 my $pl = load_pl path $login 1334 my $pl = load_pl path $login
989 or return; 1335 or return;
990 $cf::PLAYER{$login} = $pl 1336 $cf::PLAYER{$login} = $pl
991 } 1337 }
992 } 1338 }
1076while and may block, so not sync_job-capable, ever. 1422while and may block, so not sync_job-capable, ever.
1077 1423
1078=cut 1424=cut
1079 1425
1080sub list_logins { 1426sub list_logins {
1081 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1427 my $dirs = aio_readdir $PLAYERDIR
1082 or return []; 1428 or return [];
1083 1429
1084 my @logins; 1430 my @logins;
1085 1431
1086 for my $login (@$dirs) { 1432 for my $login (@$dirs) {
1121 } 1467 }
1122 1468
1123 \@paths 1469 \@paths
1124} 1470}
1125 1471
1472=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1473
1474Expand crossfire pod fragments into protocol xml.
1475
1476=cut
1477
1478sub expand_cfpod {
1479 ((my $self), (local $_)) = @_;
1480
1481 # escape & and <
1482 s/&/&amp;/g;
1483 s/(?<![BIUGH])</&lt;/g;
1484
1485 # this is buggy, it needs to properly take care of nested <'s
1486
1487 1 while
1488 # replace B<>, I<>, U<> etc.
1489 s/B<([^\>]*)>/<b>$1<\/b>/
1490 || s/I<([^\>]*)>/<i>$1<\/i>/
1491 || s/U<([^\>]*)>/<u>$1<\/u>/
1492 # replace G<male|female> tags
1493 || s{G<([^>|]*)\|([^>]*)>}{
1494 $self->gender ? $2 : $1
1495 }ge
1496 # replace H<hint text>
1497 || s{H<([^\>]*)>}
1498 {
1499 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1500 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1501 "")
1502 [$self->{hintmode}]
1503 }ge;
1504
1505 # create single paragraphs (very hackish)
1506 s/(?<=\S)\n(?=\w)/ /g;
1507
1508 # compress some whitespace
1509 s/\s+\n/\n/g; # ws line-ends
1510 s/\n\n+/\n/g; # double lines
1511 s/^\n+//; # beginning lines
1512 s/\n+$//; # ending lines
1513
1514 $_
1515}
1516
1517sub hintmode {
1518 $_[0]{hintmode} = $_[1] if @_ > 1;
1519 $_[0]{hintmode}
1520}
1521
1126=item $player->ext_reply ($msgid, $msgtype, %msg) 1522=item $player->ext_reply ($msgid, %msg)
1127 1523
1128Sends an ext reply to the player. 1524Sends an ext reply to the player.
1129 1525
1130=cut 1526=cut
1131 1527
1132sub ext_reply($$$%) { 1528sub ext_reply($$%) {
1133 my ($self, $id, %msg) = @_; 1529 my ($self, $id, %msg) = @_;
1134 1530
1135 $msg{msgid} = $id; 1531 $msg{msgid} = $id;
1136 1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1137 $self->send ("ext " . cf::to_json \%msg);
1138} 1533}
1139 1534
1140package cf; 1535=item $player->ext_event ($type, %msg)
1536
1537Sends an ext event to the client.
1538
1539=cut
1540
1541sub ext_event($$%) {
1542 my ($self, $type, %msg) = @_;
1543
1544 $self->ns->ext_event ($type, %msg);
1545}
1546
1547=head3 cf::region
1548
1549=over 4
1550
1551=cut
1552
1553package cf::region;
1554
1555=item cf::region::find_by_path $path
1556
1557Tries to decuce the likely region for a map knowing only its path.
1558
1559=cut
1560
1561sub find_by_path($) {
1562 my ($path) = @_;
1563
1564 my ($match, $specificity);
1565
1566 for my $region (list) {
1567 if ($region->{match} && $path =~ $region->{match}) {
1568 ($match, $specificity) = ($region, $region->specificity)
1569 if $region->specificity > $specificity;
1570 }
1571 }
1572
1573 $match
1574}
1141 1575
1142=back 1576=back
1143
1144 1577
1145=head3 cf::map 1578=head3 cf::map
1146 1579
1147=over 4 1580=over 4
1148 1581
1203 my ($self, $merge) = @_; 1636 my ($self, $merge) = @_;
1204 1637
1205 # we have to keep some variables in memory intact 1638 # we have to keep some variables in memory intact
1206 local $self->{path}; 1639 local $self->{path};
1207 local $self->{load_path}; 1640 local $self->{load_path};
1208 local $self->{deny_save};
1209 local $self->{deny_reset};
1210 1641
1211 $self->SUPER::thawer_merge ($merge); 1642 $self->SUPER::thawer_merge ($merge);
1212} 1643}
1213 1644
1214sub normalise { 1645sub normalise {
1261 $self->init; # pass $1 etc. 1692 $self->init; # pass $1 etc.
1262 return $self; 1693 return $self;
1263 } 1694 }
1264 } 1695 }
1265 1696
1266 Carp::carp "unable to resolve path '$path' (base '$base')."; 1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1267 () 1698 ()
1268} 1699}
1269 1700
1270sub init { 1701sub init {
1271 my ($self) = @_; 1702 my ($self) = @_;
1286 1717
1287# the original (read-only) location 1718# the original (read-only) location
1288sub load_path { 1719sub load_path {
1289 my ($self) = @_; 1720 my ($self) = @_;
1290 1721
1291 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1722 "$MAPDIR/$self->{path}.map"
1292} 1723}
1293 1724
1294# the temporary/swap location 1725# the temporary/swap location
1295sub save_path { 1726sub save_path {
1296 my ($self) = @_; 1727 my ($self) = @_;
1297 1728
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1729 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1730 "$TMPDIR/$path.map"
1300} 1731}
1301 1732
1302# the unique path, undef == no special unique path 1733# the unique path, undef == no special unique path
1303sub uniq_path { 1734sub uniq_path {
1304 my ($self) = @_; 1735 my ($self) = @_;
1305 1736
1306 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1737 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1307 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1738 "$UNIQUEDIR/$path"
1308} 1739}
1309 1740
1310# and all this just because we cannot iterate over 1741# and all this just because we cannot iterate over
1311# all maps in C++... 1742# all maps in C++...
1312sub change_all_map_light { 1743sub change_all_map_light {
1313 my ($change) = @_; 1744 my ($change) = @_;
1314 1745
1315 $_->change_map_light ($change) 1746 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP; 1747 for grep $_->outdoor, values %cf::MAP;
1748}
1749
1750sub decay_objects {
1751 my ($self) = @_;
1752
1753 return if $self->{deny_reset};
1754
1755 $self->do_decay_objects;
1317} 1756}
1318 1757
1319sub unlink_save { 1758sub unlink_save {
1320 my ($self) = @_; 1759 my ($self) = @_;
1321 1760
1379 $self->load_header_orig 1818 $self->load_header_orig
1380 or return; 1819 or return;
1381 $self->prepare_orig; 1820 $self->prepare_orig;
1382 } 1821 }
1383 1822
1823 $self->{deny_reset} = 1
1824 if $self->no_reset;
1825
1826 $self->default_region (cf::region::find_by_path $self->{path})
1827 unless $self->default_region;
1828
1384 1 1829 1
1385} 1830}
1386 1831
1387sub find; 1832sub find;
1388sub find { 1833sub find {
1400 $map->{last_save} = $cf::RUNTIME; 1845 $map->{last_save} = $cf::RUNTIME;
1401 1846
1402 $map->load_header 1847 $map->load_header
1403 or return; 1848 or return;
1404 1849
1405 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1406 # doing this can freeze the server in a sync job, obviously 1851 # doing this can freeze the server in a sync job, obviously
1407 #$cf::WAIT_FOR_TICK->wait; 1852 #$cf::WAIT_FOR_TICK->wait;
1408 $map->reset; 1853 $map->reset;
1409 undef $guard; 1854 undef $guard;
1410 return find $path; 1855 return find $path;
1421 my ($self) = @_; 1866 my ($self) = @_;
1422 1867
1423 local $self->{deny_reset} = 1; # loading can take a long time 1868 local $self->{deny_reset} = 1; # loading can take a long time
1424 1869
1425 my $path = $self->{path}; 1870 my $path = $self->{path};
1871
1872 {
1426 my $guard = cf::lock_acquire "map_load:$path"; 1873 my $guard = cf::lock_acquire "map_load:$path";
1427 1874
1428 return if $self->in_memory != cf::MAP_SWAPPED; 1875 return if $self->in_memory != cf::MAP_SWAPPED;
1429 1876
1430 $self->in_memory (cf::MAP_LOADING); 1877 $self->in_memory (cf::MAP_LOADING);
1431 1878
1432 $self->alloc; 1879 $self->alloc;
1433 1880
1434 $self->pre_load; 1881 $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; 1882 Coro::cede;
1460 $self->set_darkness_map; 1883
1884 $self->_load_objects ($self->{load_path}, 1)
1885 or return;
1886
1887 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1888 if delete $self->{load_original};
1889
1890 if (my $uniq = $self->uniq_path) {
1891 utf8::encode $uniq;
1892 if (aio_open $uniq, O_RDONLY, 0) {
1893 $self->clear_unique_items;
1894 $self->_load_objects ($uniq, 0);
1895 }
1896 }
1897
1898 Coro::cede;
1899 # now do the right thing for maps
1900 $self->link_multipart_objects;
1461 $self->difficulty ($self->estimate_difficulty) 1901 $self->difficulty ($self->estimate_difficulty)
1462 unless $self->difficulty; 1902 unless $self->difficulty;
1463 Coro::cede; 1903 Coro::cede;
1904
1905 unless ($self->{deny_activate}) {
1906 $self->decay_objects;
1907 $self->fix_auto_apply;
1908 $self->update_buttons;
1909 Coro::cede;
1910 $self->set_darkness_map;
1911 Coro::cede;
1464 $self->activate; 1912 $self->activate;
1913 }
1914
1915 $self->in_memory (cf::MAP_IN_MEMORY);
1465 } 1916 }
1466 1917
1467 $self->post_load; 1918 $self->post_load;
1468
1469 $self->in_memory (cf::MAP_IN_MEMORY);
1470} 1919}
1471 1920
1472sub customise_for { 1921sub customise_for {
1473 my ($self, $ob) = @_; 1922 my ($self, $ob) = @_;
1474 1923
1475 return find "~" . $ob->name . "/" . $self->{path} 1924 return find "~" . $ob->name . "/" . $self->{path}
1476 if $self->per_player; 1925 if $self->per_player;
1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1477 1929
1478 $self 1930 $self
1479} 1931}
1480 1932
1481# find and load all maps in the 3x3 area around a map 1933# find and load all maps in the 3x3 area around a map
1528 1980
1529 undef $MAP_PREFETCH{$path}; 1981 undef $MAP_PREFETCH{$path};
1530 $MAP_PREFETCHER ||= cf::async { 1982 $MAP_PREFETCHER ||= cf::async {
1531 while (%MAP_PREFETCH) { 1983 while (%MAP_PREFETCH) {
1532 for my $path (keys %MAP_PREFETCH) { 1984 for my $path (keys %MAP_PREFETCH) {
1533 my $map = find $path 1985 if (my $map = find $path) {
1534 or next;
1535 $map->load; 1986 $map->load;
1987 }
1536 1988
1537 delete $MAP_PREFETCH{$path}; 1989 delete $MAP_PREFETCH{$path};
1538 } 1990 }
1539 } 1991 }
1540 undef $MAP_PREFETCHER; 1992 undef $MAP_PREFETCHER;
1592 2044
1593sub reset_at { 2045sub reset_at {
1594 my ($self) = @_; 2046 my ($self) = @_;
1595 2047
1596 # TODO: safety, remove and allow resettable per-player maps 2048 # 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}; 2049 return 1e99 if $self->{deny_reset};
1599 2050
1600 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1601 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1602 2053
1613 my ($self) = @_; 2064 my ($self) = @_;
1614 2065
1615 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1616 2067
1617 return if $self->players; 2068 return if $self->players;
1618 return if $self->isa ("ext::map_per_player");#d#
1619 2069
1620 warn "resetting map ", $self->path;#d# 2070 warn "resetting map ", $self->path;
1621 2071
1622 $self->in_memory (cf::MAP_SWAPPED); 2072 $self->in_memory (cf::MAP_SWAPPED);
1623 2073
1624 # need to save uniques path 2074 # need to save uniques path
1625 unless ($self->{deny_save}) { 2075 unless ($self->{deny_save}) {
1657 $cf::MAP{$self->path} = $self; 2107 $cf::MAP{$self->path} = $self;
1658 2108
1659 $self->reset; # polite request, might not happen 2109 $self->reset; # polite request, might not happen
1660} 2110}
1661 2111
2112=item $maps = cf::map::tmp_maps
2113
2114Returns an arrayref with all map paths of currently instantiated and saved
2115maps. May block.
2116
2117=cut
2118
2119sub tmp_maps() {
2120 [
2121 map {
2122 utf8::decode $_;
2123 /\.map$/
2124 ? normalise $_
2125 : ()
2126 } @{ aio_readdir $TMPDIR or [] }
2127 ]
2128}
2129
2130=item $maps = cf::map::random_maps
2131
2132Returns an arrayref with all map paths of currently instantiated and saved
2133random maps. May block.
2134
2135=cut
2136
2137sub random_maps() {
2138 [
2139 map {
2140 utf8::decode $_;
2141 /\.map$/
2142 ? normalise "?random/$_"
2143 : ()
2144 } @{ aio_readdir $RANDOMDIR or [] }
2145 ]
2146}
2147
1662=item cf::map::unique_maps 2148=item cf::map::unique_maps
1663 2149
1664Returns an arrayref of paths of all shared maps that have 2150Returns an arrayref of paths of all shared maps that have
1665instantiated unique items. May block. 2151instantiated unique items. May block.
1666 2152
1667=cut 2153=cut
1668 2154
1669sub unique_maps() { 2155sub unique_maps() {
1670 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2156 [
1671 or return; 2157 map {
1672
1673 my @paths;
1674
1675 for (@$files) {
1676 utf8::decode $_; 2158 utf8::decode $_;
1677 next if /\.pst$/; 2159 /\.map$/
1678 next unless /^$PATH_SEP/o; 2160 ? normalise $_
1679 2161 : ()
1680 push @paths, cf::map::normalise $_; 2162 } @{ aio_readdir $UNIQUEDIR or [] }
1681 } 2163 ]
1682
1683 \@paths
1684} 2164}
1685 2165
1686package cf; 2166package cf;
1687 2167
1688=back 2168=back
1734 2214
1735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1736 2216
1737 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1738 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1739 } else { 2220 } else {
2221 my $pl = $self->contr;
2222
2223 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2224 my $diag = $pl->{npc_dialog};
2225 $diag->{pl}->ext_reply (
2226 $diag->{id},
2227 msgtype => "reply",
2228 msg => $diag->{pl}->expand_cfpod ($msg),
2229 add_topics => []
2230 );
2231
2232 } else {
1740 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1741 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1742 } 2236 }
1743} 2237}
1744 2238
1745=item $player_object->may ("access") 2239=item $player_object->may ("access")
1746 2240
1794 $self->deactivate_recursive; 2288 $self->deactivate_recursive;
1795 2289
1796 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2290 return if UNIVERSAL::isa $self->map, "ext::map_link";
1797 2291
1798 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2292 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1799 if $self->map; 2293 if $self->map && $self->map->{path} ne "{link}";
1800 2294
1801 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2295 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1802} 2296}
1803 2297
1804sub cf::object::player::leave_link { 2298sub cf::object::player::leave_link {
1805 my ($self, $map, $x, $y) = @_; 2299 my ($self, $map, $x, $y) = @_;
2300
2301 return unless $self->contr->active;
1806 2302
1807 my $link_pos = delete $self->{_link_pos}; 2303 my $link_pos = delete $self->{_link_pos};
1808 2304
1809 unless ($map) { 2305 unless ($map) {
1810 # restore original map position 2306 # restore original map position
1833 2329
1834 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1835 $self->enter_map ($map, $x, $y); 2331 $self->enter_map ($map, $x, $y);
1836} 2332}
1837 2333
1838cf::player->attach ( 2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1839 on_logout => sub {
1840 my ($pl) = @_;
1841 2335
1842 # abort map switching before logout 2336Moves the player to the given map-path and coordinates by first freezing
1843 if ($pl->ob->{_link_pos}) { 2337her, loading and preparing them map, calling the provided $check callback
1844 cf::sync_job { 2338that has to return the map if sucecssful, and then unfreezes the player on
1845 $pl->ob->leave_link 2339the new (success) or old (failed) map position. In either case, $done will
1846 }; 2340be called at the end of this process.
1847 }
1848 },
1849 on_login => sub {
1850 my ($pl) = @_;
1851 2341
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 2342=cut
2343
2344our $GOTOGEN;
1873 2345
1874sub cf::object::player::goto { 2346sub cf::object::player::goto {
1875 my ($self, $path, $x, $y) = @_; 2347 my ($self, $path, $x, $y, $check, $done) = @_;
2348
2349 # do generation counting so two concurrent goto's will be executed in-order
2350 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1876 2351
1877 $self->enter_link; 2352 $self->enter_link;
1878 2353
1879 (async { 2354 (async {
1880 my $map = eval { 2355 my $map = eval {
1881 my $map = cf::map::find $path; 2356 my $map = cf::map::find $path;
2357
2358 if ($map) {
1882 $map = $map->customise_for ($self) if $map; 2359 $map = $map->customise_for ($self);
2360 $map = $check->($map) if $check && $map;
2361 } else {
2362 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2363 }
2364
1883 $map 2365 $map
2366 };
2367
2368 if ($@) {
2369 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2370 LOG llevError | logBacktrace, Carp::longmess $@;
1884 } or 2371 }
1885 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1886 2372
2373 if ($gen == $self->{_goto_generation}) {
2374 delete $self->{_goto_generation};
1887 $self->leave_link ($map, $x, $y); 2375 $self->leave_link ($map, $x, $y);
2376 }
2377
2378 $done->() if $done;
1888 })->prio (1); 2379 })->prio (1);
1889} 2380}
1890 2381
1891=item $player_object->enter_exit ($exit_object) 2382=item $player_object->enter_exit ($exit_object)
1892 2383
1931 2422
1932 $rmp->{random_seed} ||= $exit->random_seed; 2423 $rmp->{random_seed} ||= $exit->random_seed;
1933 2424
1934 my $data = cf::to_json $rmp; 2425 my $data = cf::to_json $rmp;
1935 my $md5 = Digest::MD5::md5_hex $data; 2426 my $md5 = Digest::MD5::md5_hex $data;
1936 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2427 my $meta = "$RANDOMDIR/$md5.meta";
1937 2428
1938 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2429 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1939 aio_write $fh, 0, (length $data), $data, 0; 2430 aio_write $fh, 0, (length $data), $data, 0;
1940 undef $fh; 2431 undef $fh;
1941 aio_rename "$meta~", $meta; 2432 aio_rename "$meta~", $meta;
1950 2441
1951 return unless $self->type == cf::PLAYER; 2442 return unless $self->type == cf::PLAYER;
1952 2443
1953 if ($exit->slaying eq "/!") { 2444 if ($exit->slaying eq "/!") {
1954 #TODO: this should de-fi-ni-te-ly not be a sync-job 2445 #TODO: this should de-fi-ni-te-ly not be a sync-job
2446 # the problem is that $exit might not survive long enough
2447 # so it needs to be done right now, right here
1955 cf::sync_job { prepare_random_map $exit }; 2448 cf::sync_job { prepare_random_map $exit };
1956 } 2449 }
1957 2450
1958 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2451 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1959 my $hp = $exit->stats->hp; 2452 my $hp = $exit->stats->hp;
1960 my $sp = $exit->stats->sp; 2453 my $sp = $exit->stats->sp;
1961 2454
1962 $self->enter_link; 2455 $self->enter_link;
2456
2457 # if exit is damned, update players death & WoR home-position
2458 $self->contr->savebed ($slaying, $hp, $sp)
2459 if $exit->flag (FLAG_DAMNED);
1963 2460
1964 (async { 2461 (async {
1965 $self->deactivate_recursive; # just to be sure 2462 $self->deactivate_recursive; # just to be sure
1966 unless (eval { 2463 unless (eval {
1967 $self->goto ($slaying, $hp, $sp); 2464 $self->goto ($slaying, $hp, $sp);
1968 2465
1969 1; 2466 1;
1970 }) { 2467 }) {
1971 $self->message ("Something went wrong deep within the crossfire server. " 2468 $self->message ("Something went wrong deep within the crossfire server. "
1972 . "I'll try to bring you back to the map you were before. " 2469 . "I'll try to bring you back to the map you were before. "
1973 . "Please report this to the dungeon master!", 2470 . "Please report this to the dungeon master!",
1974 cf::NDI_UNIQUE | cf::NDI_RED); 2471 cf::NDI_UNIQUE | cf::NDI_RED);
1975 2472
1976 warn "ERROR in enter_exit: $@"; 2473 warn "ERROR in enter_exit: $@";
1977 $self->leave_link; 2474 $self->leave_link;
1978 } 2475 }
1979 })->prio (1); 2476 })->prio (1);
1992 2489
1993sub cf::client::send_drawinfo { 2490sub cf::client::send_drawinfo {
1994 my ($self, $text, $flags) = @_; 2491 my ($self, $text, $flags) = @_;
1995 2492
1996 utf8::encode $text; 2493 utf8::encode $text;
1997 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1998} 2495}
1999 2496
2497=item $client->send_msg ($channel, $msg, $color, [extra...])
2498
2499Send a drawinfo or msg packet to the client, formatting the msg for the
2500client if neccessary. C<$type> should be a string identifying the type of
2501the message, with C<log> being the default. If C<$color> is negative, suppress
2502the message unless the client supports the msg packet.
2503
2504=cut
2505
2506sub cf::client::send_msg {
2507 my ($self, $channel, $msg, $color, @extra) = @_;
2508
2509 $msg = $self->pl->expand_cfpod ($msg);
2510
2511 $color &= ~cf::NDI_UNIQUE; # just in case...
2512
2513 if (ref $channel) {
2514 # send meta info to client, if not yet sent
2515 unless (exists $self->{channel}{$channel->{id}}) {
2516 $self->{channel}{$channel->{id}} = $channel;
2517 $self->ext_event (channel_info => %$channel);
2518 }
2519
2520 $channel = $channel->{id};
2521 }
2522
2523 return unless @extra || length $msg;
2524
2525 if ($self->can_msg) {
2526 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2527 } else {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 if ($color >= 0) {
2539 if (0 && $msg =~ /\[/) {
2540 $self->send_packet ("drawextinfo $color 4 0 $msg")
2541 } else {
2542 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2543 $self->send_packet ("drawinfo $color $msg")
2544 }
2545 }
2546 }
2547}
2548
2549=item $client->ext_event ($type, %msg)
2550
2551Sends an ext event to the client.
2552
2553=cut
2554
2555sub cf::client::ext_event($$%) {
2556 my ($self, $type, %msg) = @_;
2557
2558 return unless $self->extcmd;
2559
2560 $msg{msgtype} = "event_$type";
2561 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2562}
2000 2563
2001=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
2002 2565
2003Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
2004the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2567the 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>. 2568C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2006 2569
2007Queries can fail, so check the return code. Or don't, as queries will become 2570Queries can fail, so check the return code. Or don't, as queries will
2008reliable at some point in the future. 2571become reliable at some point in the future.
2009 2572
2010=cut 2573=cut
2011 2574
2012sub cf::client::query { 2575sub cf::client::query {
2013 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
2021 utf8::encode $text; 2584 utf8::encode $text;
2022 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2023 2586
2024 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
2025 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
2026} 2591}
2027 2592
2028cf::client->attach ( 2593cf::client->attach (
2594 on_connect => sub {
2595 my ($ns) = @_;
2596
2597 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2598 },
2029 on_reply => sub { 2599 on_reply => sub {
2030 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
2031 2601
2032 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
2033 # get handled first 2603 # get handled first
2045 } else { 2615 } else {
2046 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2047 } 2617 }
2048 } 2618 }
2049 }, 2619 },
2620 on_exticmd => sub {
2621 my ($ns, $buf) = @_;
2622
2623 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2624
2625 if (ref $msg) {
2626 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2627 if (my %reply = $cb->($ns, $msg)) {
2628 $reply{msgid} = $msg->{msgid};
2629 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2630 }
2631 }
2632 } else {
2633 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2634 }
2635
2636 cf::override;
2637 },
2050); 2638);
2051 2639
2052=item $client->async (\&cb) 2640=item $client->async (\&cb)
2053 2641
2054Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
2101 2689
2102# here we export the classes and methods available to script code 2690# here we export the classes and methods available to script code
2103 2691
2104=pod 2692=pod
2105 2693
2106The following fucntions and emthods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
2107 2695
2108 cf::object contr pay_amount pay_player map 2696 cf::object
2697 contr pay_amount pay_player map x y force_find force_add
2698 insert remove
2699
2109 cf::object::player player 2700 cf::object::player
2110 cf::player peaceful 2701 player
2111 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
2112 2708
2113=cut 2709=cut
2114 2710
2115for ( 2711for (
2116 ["cf::object" => qw(contr pay_amount pay_player map)], 2712 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2713 insert remove)],
2117 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
2118 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
2119 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
2120) { 2717) {
2121 no strict 'refs'; 2718 no strict 'refs';
2192=back 2789=back
2193 2790
2194=cut 2791=cut
2195 2792
2196############################################################################# 2793#############################################################################
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 2794# the server's init and main functions
2270 2795
2271sub init_resources { 2796sub load_facedata($) {
2272 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2797 my ($path) = @_;
2798
2799 warn "loading facedata from $path\n";
2800
2801 my $facedata;
2802 0 < aio_load $path, $facedata
2803 or die "$path: $!";
2804
2805 $facedata = Coro::Storable::thaw $facedata;
2806
2807 $facedata->{version} == 2
2808 or cf::cleanup "$path: version mismatch, cannot proceed.";
2809
2810 {
2811 my $faces = $facedata->{faceinfo};
2812
2813 while (my ($face, $info) = each %$faces) {
2814 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2815 cf::face::set_visibility $idx, $info->{visibility};
2816 cf::face::set_magicmap $idx, $info->{magicmap};
2817 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2818 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2819
2820 cf::cede_to_tick;
2821 }
2822
2823 while (my ($face, $info) = each %$faces) {
2824 next unless $info->{smooth};
2825 my $idx = cf::face::find $face
2826 or next;
2827 if (my $smooth = cf::face::find $info->{smooth}) {
2828 cf::face::set_smooth $idx, $smooth;
2829 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2830 } else {
2831 warn "smooth face '$info->{smooth}' not found for face '$face'";
2832 }
2833
2834 cf::cede_to_tick;
2835 }
2836 }
2837
2838 {
2839 my $anims = $facedata->{animinfo};
2840
2841 while (my ($anim, $info) = each %$anims) {
2842 cf::anim::set $anim, $info->{frames}, $info->{facings};
2843 cf::cede_to_tick;
2844 }
2845
2846 cf::anim::invalidate_all; # d'oh
2847 }
2848
2849 {
2850 # TODO: for gcfclient pleasure, we should give resources
2851 # that gcfclient doesn't grok a >10000 face index.
2852 my $res = $facedata->{resource};
2853 my $enc = JSON::XS->new->utf8->canonical;
2854
2855 while (my ($name, $info) = each %$res) {
2856 my $meta = $enc->encode ({
2857 name => $name,
2858 type => $info->{type},
2859 copyright => $info->{copyright}, #TODO#
2860 });
2861
2862 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2863
2864 if ($name =~ /\.jpg$/) {
2865 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2866 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2867 } else {
2868 my $data = pack "(w/a*)*", $meta, $info->{data};
2869 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2870
2871 cf::face::set_type $idx, 1;
2872 cf::face::set_data $idx, 0, $data, $chk;
2873 }
2874
2875 cf::cede_to_tick;
2876 }
2877 }
2878
2879 1
2880}
2881
2882sub reload_regions {
2883 load_resource_file "$MAPDIR/regions"
2273 or die "unable to load regions file\n";#d# 2884 or die "unable to load regions file\n";
2885
2886 for (cf::region::list) {
2887 $_->{match} = qr/$_->{match}/
2888 if exists $_->{match};
2889 }
2890}
2891
2892sub reload_facedata {
2893 load_facedata "$DATADIR/facedata"
2894 or die "unable to load facedata\n";
2895}
2896
2897sub reload_archetypes {
2898 load_resource_file "$DATADIR/archetypes"
2899 or die "unable to load archetypes\n";
2900 #d# NEED to laod twice to resolve forward references
2901 # this really needs to be done in an extra post-pass
2902 # (which needs to be synchronous, so solve it differently)
2903 load_resource_file "$DATADIR/archetypes"
2904 or die "unable to load archetypes\n";
2905}
2906
2907sub reload_treasures {
2908 load_resource_file "$DATADIR/treasures"
2909 or die "unable to load treasurelists\n";
2910}
2911
2912sub reload_resources {
2913 warn "reloading resource files...\n";
2914
2915 reload_regions;
2916 reload_facedata;
2917 #reload_archetypes;#d#
2918 reload_archetypes;
2919 reload_treasures;
2920
2921 warn "finished reloading resource files\n";
2922}
2923
2924sub init {
2925 reload_resources;
2274} 2926}
2275 2927
2276sub cfg_load { 2928sub cfg_load {
2277 open my $fh, "<:utf8", cf::confdir . "/config" 2929 open my $fh, "<:utf8", "$CONFDIR/config"
2278 or return; 2930 or return;
2279 2931
2280 local $/; 2932 local $/;
2281 *CFG = YAML::Syck::Load <$fh>; 2933 *CFG = YAML::Syck::Load <$fh>;
2282 2934
2290 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2942 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291 and die "WARNING: m(un)lockall failed: $!\n"; 2943 and die "WARNING: m(un)lockall failed: $!\n";
2292 }; 2944 };
2293 warn $@ if $@; 2945 warn $@ if $@;
2294 } 2946 }
2295}
2296
2297sub init {
2298 init_resources;
2299} 2947}
2300 2948
2301sub main { 2949sub main {
2302 # we must not ever block the main coroutine 2950 # we must not ever block the main coroutine
2303 local $Coro::idle = sub { 2951 local $Coro::idle = sub {
2331 }, 2979 },
2332 ); 2980 );
2333 } 2981 }
2334} 2982}
2335 2983
2984sub write_runtime {
2985 my $runtime = "$LOCALDIR/runtime";
2986
2987 # first touch the runtime file to show we are still running:
2988 # the fsync below can take a very very long time.
2989
2990 IO::AIO::aio_utime $runtime, undef, undef;
2991
2992 my $guard = cf::lock_acquire "write_runtime";
2993
2994 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2995 or return;
2996
2997 my $value = $cf::RUNTIME + 90 + 10;
2998 # 10 is the runtime save interval, for a monotonic clock
2999 # 60 allows for the watchdog to kill the server.
3000
3001 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3002 and return;
3003
3004 # always fsync - this file is important
3005 aio_fsync $fh
3006 and return;
3007
3008 # touch it again to show we are up-to-date
3009 aio_utime $fh, undef, undef;
3010
3011 close $fh
3012 or return;
3013
3014 aio_rename "$runtime~", $runtime
3015 and return;
3016
3017 warn "runtime file written.\n";
3018
3019 1
3020}
3021
2336sub emergency_save() { 3022sub emergency_save() {
2337 my $freeze_guard = cf::freeze_mainloop; 3023 my $freeze_guard = cf::freeze_mainloop;
2338 3024
2339 warn "enter emergency perl save\n"; 3025 warn "enter emergency perl save\n";
2340 3026
2371 3057
2372 warn Carp::longmess "post_cleanup backtrace" 3058 warn Carp::longmess "post_cleanup backtrace"
2373 if $make_core; 3059 if $make_core;
2374} 3060}
2375 3061
2376sub reload() { 3062sub do_reload_perl() {
2377 # can/must only be called in main 3063 # can/must only be called in main
2378 if ($Coro::current != $Coro::main) { 3064 if ($Coro::current != $Coro::main) {
2379 warn "can only reload from main coroutine"; 3065 warn "can only reload from main coroutine";
2380 return; 3066 return;
2381 } 3067 }
2406 Coro::cede; 3092 Coro::cede;
2407 last unless IO::AIO::nreqs || BDB::nreqs; 3093 last unless IO::AIO::nreqs || BDB::nreqs;
2408 warn "iterate..."; 3094 warn "iterate...";
2409 } 3095 }
2410 3096
3097 ++$RELOAD;
3098
2411 warn "cancelling all extension coros"; 3099 warn "cancelling all extension coros";
2412 $_->cancel for values %EXT_CORO; 3100 $_->cancel for values %EXT_CORO;
2413 %EXT_CORO = (); 3101 %EXT_CORO = ();
2414 3102
2415 warn "removing commands"; 3103 warn "removing commands";
2416 %COMMAND = (); 3104 %COMMAND = ();
2417 3105
2418 warn "removing ext commands"; 3106 warn "removing ext/exti commands";
2419 %EXTCMD = (); 3107 %EXTCMD = ();
3108 %EXTICMD = ();
2420 3109
2421 warn "unloading/nuking all extensions"; 3110 warn "unloading/nuking all extensions";
2422 for my $pkg (@EXTS) { 3111 for my $pkg (@EXTS) {
2423 warn "... unloading $pkg"; 3112 warn "... unloading $pkg";
2424 3113
2454 Symbol::delete_package "safe::$_" 3143 Symbol::delete_package "safe::$_"
2455 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3144 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2456 3145
2457 warn "unloading cf.pm \"a bit\""; 3146 warn "unloading cf.pm \"a bit\"";
2458 delete $INC{"cf.pm"}; 3147 delete $INC{"cf.pm"};
3148 delete $INC{"cf/pod.pm"};
2459 3149
2460 # don't, removes xs symbols, too, 3150 # don't, removes xs symbols, too,
2461 # and global variables created in xs 3151 # and global variables created in xs
2462 #Symbol::delete_package __PACKAGE__; 3152 #Symbol::delete_package __PACKAGE__;
2463 3153
2478 warn "reattaching attachments to maps"; 3168 warn "reattaching attachments to maps";
2479 reattach $_ for values %MAP; 3169 reattach $_ for values %MAP;
2480 warn "reattaching attachments to players"; 3170 warn "reattaching attachments to players";
2481 reattach $_ for values %PLAYER; 3171 reattach $_ for values %PLAYER;
2482 3172
2483 warn "loading reloadable resources";
2484 init_resources;
2485
2486 warn "leaving sync_job"; 3173 warn "leaving sync_job";
2487 3174
2488 1 3175 1
2489 } or do { 3176 } or do {
2490 warn $@; 3177 warn $@;
2495 warn "reloaded"; 3182 warn "reloaded";
2496}; 3183};
2497 3184
2498our $RELOAD_WATCHER; # used only during reload 3185our $RELOAD_WATCHER; # used only during reload
2499 3186
3187sub reload_perl() {
3188 # doing reload synchronously and two reloads happen back-to-back,
3189 # coro crashes during coro_state_free->destroy here.
3190
3191 $RELOAD_WATCHER ||= Event->timer (
3192 reentrant => 0,
3193 after => 0,
3194 data => WF_AUTOCANCEL,
3195 cb => sub {
3196 do_reload_perl;
3197 undef $RELOAD_WATCHER;
3198 },
3199 );
3200}
3201
2500register_command "reload" => sub { 3202register_command "reload" => sub {
2501 my ($who, $arg) = @_; 3203 my ($who, $arg) = @_;
2502 3204
2503 if ($who->flag (FLAG_WIZ)) { 3205 if ($who->flag (FLAG_WIZ)) {
2504 $who->message ("reloading server."); 3206 $who->message ("reloading server.");
2505 3207 async { reload_perl };
2506 # doing reload synchronously and two reloads happen back-to-back,
2507 # coro crashes during coro_state_free->destroy here.
2508
2509 $RELOAD_WATCHER ||= Event->timer (
2510 reentrant => 0,
2511 after => 0,
2512 data => WF_AUTOCANCEL,
2513 cb => sub {
2514 reload;
2515 undef $RELOAD_WATCHER;
2516 },
2517 );
2518 } 3208 }
2519}; 3209};
2520 3210
2521unshift @INC, $LIBDIR; 3211unshift @INC, $LIBDIR;
2522 3212
2523my $bug_warning = 0; 3213my $bug_warning = 0;
2524 3214
3215our @WAIT_FOR_TICK;
3216our @WAIT_FOR_TICK_BEGIN;
3217
3218sub wait_for_tick {
3219 return unless $TICK_WATCHER->is_active;
3220 return if $Coro::current == $Coro::main;
3221
3222 my $signal = new Coro::Signal;
3223 push @WAIT_FOR_TICK, $signal;
3224 $signal->wait;
3225}
3226
3227sub wait_for_tick_begin {
3228 return unless $TICK_WATCHER->is_active;
3229 return if $Coro::current == $Coro::main;
3230
3231 my $signal = new Coro::Signal;
3232 push @WAIT_FOR_TICK_BEGIN, $signal;
3233 $signal->wait;
3234}
3235
3236 my $min = 1e6;#d#
3237 my $avg = 10;
2525$TICK_WATCHER = Event->timer ( 3238$TICK_WATCHER = Event->timer (
2526 reentrant => 0, 3239 reentrant => 0,
2527 parked => 1, 3240 parked => 1,
2528 prio => 0, 3241 prio => 0,
2529 at => $NEXT_TICK || $TICK, 3242 at => $NEXT_TICK || $TICK,
2533 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3246 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2534 unless ++$bug_warning > 10; 3247 unless ++$bug_warning > 10;
2535 return; 3248 return;
2536 } 3249 }
2537 3250
2538 $NOW = Event::time; 3251 $NOW = $tick_start = Event::time;
2539 3252
2540 cf::server_tick; # one server iteration 3253 cf::server_tick; # one server iteration
3254
3255 0 && sync_job {#d#
3256 for(1..10) {
3257 my $t = Event::time;
3258 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3259 or die;
3260
3261 $map->width (50);
3262 $map->height (50);
3263 $map->alloc;
3264 $map->_load_objects ("/tmp/x.map", 1);
3265 my $t = Event::time - $t;
3266
3267 #next unless $t < 0.0013;#d#
3268 if ($t < $min) {
3269 $min = $t;
3270 }
3271 $avg = $avg * 0.99 + $t * 0.01;
3272 }
3273 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3274 exit 0;
3275 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3276 };
3277
2541 $RUNTIME += $TICK; 3278 $RUNTIME += $TICK;
2542 $NEXT_TICK += $TICK; 3279 $NEXT_TICK += $TICK;
2543 3280
2544 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3281 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2545 $NEXT_RUNTIME_WRITE = $NOW + 10; 3282 $NEXT_RUNTIME_WRITE = $NOW + 10;
2547 write_runtime 3284 write_runtime
2548 or warn "ERROR: unable to write runtime file: $!"; 3285 or warn "ERROR: unable to write runtime file: $!";
2549 }; 3286 };
2550 } 3287 }
2551 3288
2552 $WAIT_FOR_TICK->broadcast;
2553 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2554
2555# my $AFTER = Event::time; 3289# my $AFTER = Event::time;
2556# warn $AFTER - $NOW;#d# 3290# warn $AFTER - $NOW;#d#
2557 3291
3292 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3293 $sig->send;
3294 }
3295 while (my $sig = shift @WAIT_FOR_TICK) {
3296 $sig->send;
3297 }
3298
3299 $NOW = Event::time;
3300
2558 # if we are delayed by four ticks or more, skip them all 3301 # if we are delayed by four ticks or more, skip them all
2559 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3302 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2560 3303
2561 $TICK_WATCHER->at ($NEXT_TICK); 3304 $TICK_WATCHER->at ($NEXT_TICK);
2562 $TICK_WATCHER->start; 3305 $TICK_WATCHER->start;
3306
3307 $LOAD = ($NOW - $tick_start) / $TICK;
3308 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3309
3310 _post_tick;
3311
3312
2563 }, 3313 },
2564); 3314);
2565 3315
2566{ 3316{
2567 BDB::max_poll_time $TICK * 0.1; 3317 BDB::max_poll_time $TICK * 0.1;
2595 3345
2596 cf::sync_job { 3346 cf::sync_job {
2597 eval { 3347 eval {
2598 BDB::db_env_open 3348 BDB::db_env_open
2599 $DB_ENV, 3349 $DB_ENV,
2600 $BDB_ENV_DIR, 3350 $BDBDIR,
2601 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3351 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2602 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3352 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2603 0666; 3353 0666;
2604 3354
2605 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3355 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2606 3356
2607 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3357 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2608 $DB_ENV->set_lk_detect; 3358 $DB_ENV->set_lk_detect;
2609 }; 3359 };
2610 3360
2626 prio => 6, 3376 prio => 6,
2627 cb => \&IO::AIO::poll_cb, 3377 cb => \&IO::AIO::poll_cb,
2628 ); 3378 );
2629} 3379}
2630 3380
3381my $_log_backtrace;
3382
3383sub _log_backtrace {
3384 my ($msg, @addr) = @_;
3385
3386 $msg =~ s/\n//;
3387
3388 # limit the # of concurrent backtraces
3389 if ($_log_backtrace < 2) {
3390 ++$_log_backtrace;
3391 async {
3392 my @bt = fork_call {
3393 @addr = map { sprintf "%x", $_ } @addr;
3394 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3395 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3396 or die "addr2line: $!";
3397
3398 my @funcs;
3399 my @res = <$fh>;
3400 chomp for @res;
3401 while (@res) {
3402 my ($func, $line) = splice @res, 0, 2, ();
3403 push @funcs, "[$func] $line";
3404 }
3405
3406 @funcs
3407 };
3408
3409 LOG llevInfo, "[ABT] $msg\n";
3410 LOG llevInfo, "[ABT] $_\n" for @bt;
3411 --$_log_backtrace;
3412 };
3413 } else {
3414 LOG llevInfo, "[ABT] $msg\n";
3415 LOG llevInfo, "[ABT] [suppressed]\n";
3416 }
3417}
3418
3419# load additional modules
3420use cf::pod;
3421
2631END { cf::emergency_save } 3422END { cf::emergency_save }
2632 3423
26331 34241
2634 3425

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines