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.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
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[, $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
284=item cf::async { BLOCK } 383=item cf::async { BLOCK }
285 384
286Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
287C<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
288thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
291 390
292BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
293 392
294=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
295 394
296The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
297always able to handle events or runnable, as crossfire+ is only partly 396is 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. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
299 399
300If 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
301the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
302server 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
303fast or be very important. 403fast or be very important.
306 406
307sub sync_job(&) { 407sub sync_job(&) {
308 my ($job) = @_; 408 my ($job) = @_;
309 409
310 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
311 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
312 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
313 415
314 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
315 # (but this is cancel-safe) 417 # (but this is cancel-safe)
326 428
327 while ($busy) { 429 while ($busy) {
328 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
329 } 431 }
330 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
331 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
332 } else { 441 } else {
333 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
334 443
335 $job->() 444 $job->()
354 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
355 464
356 $coro 465 $coro
357} 466}
358 467
359sub write_runtime { 468=item fork_call { }, $args
360 my $guard = cf::lock_acquire "write_runtime";
361 469
362 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.
363 474
364 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
365 or return;
366 476
367 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
368 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
369 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
370 480 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 481 close $fh;
379 or return;
380 482
381 aio_rename "$runtime~", $runtime 483 $buf
382 and return; 484}
383 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;
384 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 });
385} 655}
386 656
387=back 657=back
388 658
389=cut 659=cut
396attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
397to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
398 668
399In 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>
400C<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
401crossfire+). 671Crossfire TRT).
402 672
403=over 4 673=over 4
404 674
405=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
406 676
569 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
570 840
571 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
572 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
573 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
574 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
575 845
576 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
577 my $pkg = shift @arg; 847 my $pkg = shift @arg;
578 848
579 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
608 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
609 } 879 }
610 880
611 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
612 } else { 882 } else {
613 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
614 } 884 }
615 885
616 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
617} 887}
618 888
620 if (ref $_[0]) { 890 if (ref $_[0]) {
621 _object_attach @_; 891 _object_attach @_;
622 } else { 892 } else {
623 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
624 } 894 }
895 _recalc_want;
625}; 896};
626 897
627# all those should be optimised 898# all those should be optimised
628sub cf::attachable::detach { 899sub cf::attachable::detach {
629 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
632 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
633 reattach ($obj); 904 reattach ($obj);
634 } else { 905 } else {
635 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
636 } 907 }
908 _recalc_want;
637}; 909};
638 910
639sub cf::attachable::attached { 911sub cf::attachable::attached {
640 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
641 913
656 "; 928 ";
657 die if $@; 929 die if $@;
658} 930}
659 931
660our $override; 932our $override;
661our @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?
662 934
663sub override { 935sub override {
664 $override = 1; 936 $override = 1;
665 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
666} 938}
667 939
668sub do_invoke { 940sub do_invoke {
669 my $event = shift; 941 my $event = shift;
670 my $callbacks = shift; 942 my $callbacks = shift;
671 943
672 @invoke_results = (); 944 @INVOKE_RESULTS = ();
673 945
674 local $override; 946 local $override;
675 947
676 for (@$callbacks) { 948 for (@$callbacks) {
677 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
694 966
695Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
696 968
697This 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
698removed 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
699results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
700 972
701=back 973=back
702 974
703=cut 975=cut
704 976
705############################################################################# 977#############################################################################
706# 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}
707 990
708sub reattach { 991sub reattach {
709 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
710 my ($obj) = @_; 993 my ($obj) = @_;
711 994
814 or return; 1097 or return;
815 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
816 } 1099 }
817 1100
818 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
819 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
820 return ($data, $av); 1103 return ($data, $av);
821} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
822 1111
823############################################################################# 1112#############################################################################
824# command handling &c 1113# command handling &c
825 1114
826=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
839 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
840} 1129}
841 1130
842=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
843 1132
844Register 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.
845 1138
846If 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
847called. 1140called.
848 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
849=cut 1153=cut
850 1154
851sub register_extcmd { 1155sub register_extcmd {
852 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
853 1157
854 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
855} 1165}
856 1166
857cf::player->attach ( 1167cf::player->attach (
858 on_command => sub { 1168 on_command => sub {
859 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
868 cf::override; 1178 cf::override;
869 }, 1179 },
870 on_extcmd => sub { 1180 on_extcmd => sub {
871 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
872 1182
873 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
874 1184
875 if (ref $msg) { 1185 if (ref $msg) {
876 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
877 if (my %reply = $cb->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
878 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
884 1194
885 cf::override; 1195 cf::override;
886 }, 1196 },
887); 1197);
888 1198
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 { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
924 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
925 next unless -r $ext; 1204 next unless -r $path;
926 eval { 1205
927 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;
928 1 1263 }
929 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
930 } 1269 };
931} 1270}
932 1271
933############################################################################# 1272#############################################################################
934 1273
1274=back
1275
935=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
936 1277
937Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
938 1279
939=cut 1280=cut
951Returns the given player object, loading it if necessary (might block). 1292Returns the given player object, loading it if necessary (might block).
952 1293
953=cut 1294=cut
954 1295
955sub playerdir($) { 1296sub playerdir($) {
956 cf::localdir 1297 "$PLAYERDIR/"
957 . "/"
958 . cf::playerdir
959 . "/"
960 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1298 . (ref $_[0] ? $_[0]->ob->name : $_[0])
961} 1299}
962 1300
963sub path($) { 1301sub path($) {
964 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1302 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
965 1303
966 (playerdir $login) . "/$login.pl" 1304 (playerdir $login) . "/playerdata"
967} 1305}
968 1306
969sub find_active($) { 1307sub find_active($) {
970 $cf::PLAYER{$_[0]} 1308 $cf::PLAYER{$_[0]}
971 and $cf::PLAYER{$_[0]}->active 1309 and $cf::PLAYER{$_[0]}->active
984 my $login = $_[0]; 1322 my $login = $_[0];
985 1323
986 my $guard = cf::lock_acquire "user_find:$login"; 1324 my $guard = cf::lock_acquire "user_find:$login";
987 1325
988 $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
989 my $pl = load_pl path $login 1334 my $pl = load_pl path $login
990 or return; 1335 or return;
991 $cf::PLAYER{$login} = $pl 1336 $cf::PLAYER{$login} = $pl
992 } 1337 }
993 } 1338 }
1077while and may block, so not sync_job-capable, ever. 1422while and may block, so not sync_job-capable, ever.
1078 1423
1079=cut 1424=cut
1080 1425
1081sub list_logins { 1426sub list_logins {
1082 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1427 my $dirs = aio_readdir $PLAYERDIR
1083 or return []; 1428 or return [];
1084 1429
1085 my @logins; 1430 my @logins;
1086 1431
1087 for my $login (@$dirs) { 1432 for my $login (@$dirs) {
1122 } 1467 }
1123 1468
1124 \@paths 1469 \@paths
1125} 1470}
1126 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
1127=item $player->ext_reply ($msgid, $msgtype, %msg) 1522=item $player->ext_reply ($msgid, %msg)
1128 1523
1129Sends an ext reply to the player. 1524Sends an ext reply to the player.
1130 1525
1131=cut 1526=cut
1132 1527
1133sub ext_reply($$$%) { 1528sub ext_reply($$%) {
1134 my ($self, $id, %msg) = @_; 1529 my ($self, $id, %msg) = @_;
1135 1530
1136 $msg{msgid} = $id; 1531 $msg{msgid} = $id;
1137 1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1138 $self->send ("ext " . cf::to_json \%msg);
1139} 1533}
1140 1534
1141package 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}
1142 1575
1143=back 1576=back
1144
1145 1577
1146=head3 cf::map 1578=head3 cf::map
1147 1579
1148=over 4 1580=over 4
1149 1581
1204 my ($self, $merge) = @_; 1636 my ($self, $merge) = @_;
1205 1637
1206 # we have to keep some variables in memory intact 1638 # we have to keep some variables in memory intact
1207 local $self->{path}; 1639 local $self->{path};
1208 local $self->{load_path}; 1640 local $self->{load_path};
1209 local $self->{deny_save};
1210 local $self->{deny_reset};
1211 1641
1212 $self->SUPER::thawer_merge ($merge); 1642 $self->SUPER::thawer_merge ($merge);
1213} 1643}
1214 1644
1215sub normalise { 1645sub normalise {
1262 $self->init; # pass $1 etc. 1692 $self->init; # pass $1 etc.
1263 return $self; 1693 return $self;
1264 } 1694 }
1265 } 1695 }
1266 1696
1267 Carp::carp "unable to resolve path '$path' (base '$base')."; 1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1268 () 1698 ()
1269} 1699}
1270 1700
1271sub init { 1701sub init {
1272 my ($self) = @_; 1702 my ($self) = @_;
1287 1717
1288# the original (read-only) location 1718# the original (read-only) location
1289sub load_path { 1719sub load_path {
1290 my ($self) = @_; 1720 my ($self) = @_;
1291 1721
1292 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1722 "$MAPDIR/$self->{path}.map"
1293} 1723}
1294 1724
1295# the temporary/swap location 1725# the temporary/swap location
1296sub save_path { 1726sub save_path {
1297 my ($self) = @_; 1727 my ($self) = @_;
1298 1728
1299 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1729 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1300 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1730 "$TMPDIR/$path.map"
1301} 1731}
1302 1732
1303# the unique path, undef == no special unique path 1733# the unique path, undef == no special unique path
1304sub uniq_path { 1734sub uniq_path {
1305 my ($self) = @_; 1735 my ($self) = @_;
1306 1736
1307 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1737 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1308 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1738 "$UNIQUEDIR/$path"
1309} 1739}
1310 1740
1311# and all this just because we cannot iterate over 1741# and all this just because we cannot iterate over
1312# all maps in C++... 1742# all maps in C++...
1313sub change_all_map_light { 1743sub change_all_map_light {
1314 my ($change) = @_; 1744 my ($change) = @_;
1315 1745
1316 $_->change_map_light ($change) 1746 $_->change_map_light ($change)
1317 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;
1318} 1756}
1319 1757
1320sub unlink_save { 1758sub unlink_save {
1321 my ($self) = @_; 1759 my ($self) = @_;
1322 1760
1380 $self->load_header_orig 1818 $self->load_header_orig
1381 or return; 1819 or return;
1382 $self->prepare_orig; 1820 $self->prepare_orig;
1383 } 1821 }
1384 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
1385 1 1829 1
1386} 1830}
1387 1831
1388sub find; 1832sub find;
1389sub find { 1833sub find {
1401 $map->{last_save} = $cf::RUNTIME; 1845 $map->{last_save} = $cf::RUNTIME;
1402 1846
1403 $map->load_header 1847 $map->load_header
1404 or return; 1848 or return;
1405 1849
1406 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1407 # doing this can freeze the server in a sync job, obviously 1851 # doing this can freeze the server in a sync job, obviously
1408 #$cf::WAIT_FOR_TICK->wait; 1852 #$cf::WAIT_FOR_TICK->wait;
1409 $map->reset; 1853 $map->reset;
1410 undef $guard; 1854 undef $guard;
1411 return find $path; 1855 return find $path;
1422 my ($self) = @_; 1866 my ($self) = @_;
1423 1867
1424 local $self->{deny_reset} = 1; # loading can take a long time 1868 local $self->{deny_reset} = 1; # loading can take a long time
1425 1869
1426 my $path = $self->{path}; 1870 my $path = $self->{path};
1871
1872 {
1427 my $guard = cf::lock_acquire "map_load:$path"; 1873 my $guard = cf::lock_acquire "map_load:$path";
1428 1874
1429 return if $self->in_memory != cf::MAP_SWAPPED; 1875 return if $self->in_memory != cf::MAP_SWAPPED;
1430 1876
1431 $self->in_memory (cf::MAP_LOADING); 1877 $self->in_memory (cf::MAP_LOADING);
1432 1878
1433 $self->alloc; 1879 $self->alloc;
1434 1880
1435 $self->pre_load; 1881 $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; 1882 Coro::cede;
1461 $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;
1462 $self->difficulty ($self->estimate_difficulty) 1901 $self->difficulty ($self->estimate_difficulty)
1463 unless $self->difficulty; 1902 unless $self->difficulty;
1464 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;
1465 $self->activate; 1912 $self->activate;
1913 }
1914
1915 $self->in_memory (cf::MAP_IN_MEMORY);
1466 } 1916 }
1467 1917
1468 $self->post_load; 1918 $self->post_load;
1469
1470 $self->in_memory (cf::MAP_IN_MEMORY);
1471} 1919}
1472 1920
1473sub customise_for { 1921sub customise_for {
1474 my ($self, $ob) = @_; 1922 my ($self, $ob) = @_;
1475 1923
1476 return find "~" . $ob->name . "/" . $self->{path} 1924 return find "~" . $ob->name . "/" . $self->{path}
1477 if $self->per_player; 1925 if $self->per_player;
1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1478 1929
1479 $self 1930 $self
1480} 1931}
1481 1932
1482# 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
1529 1980
1530 undef $MAP_PREFETCH{$path}; 1981 undef $MAP_PREFETCH{$path};
1531 $MAP_PREFETCHER ||= cf::async { 1982 $MAP_PREFETCHER ||= cf::async {
1532 while (%MAP_PREFETCH) { 1983 while (%MAP_PREFETCH) {
1533 for my $path (keys %MAP_PREFETCH) { 1984 for my $path (keys %MAP_PREFETCH) {
1534 my $map = find $path 1985 if (my $map = find $path) {
1535 or next;
1536 $map->load; 1986 $map->load;
1987 }
1537 1988
1538 delete $MAP_PREFETCH{$path}; 1989 delete $MAP_PREFETCH{$path};
1539 } 1990 }
1540 } 1991 }
1541 undef $MAP_PREFETCHER; 1992 undef $MAP_PREFETCHER;
1593 2044
1594sub reset_at { 2045sub reset_at {
1595 my ($self) = @_; 2046 my ($self) = @_;
1596 2047
1597 # TODO: safety, remove and allow resettable per-player maps 2048 # 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}; 2049 return 1e99 if $self->{deny_reset};
1600 2050
1601 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1602 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;
1603 2053
1614 my ($self) = @_; 2064 my ($self) = @_;
1615 2065
1616 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1617 2067
1618 return if $self->players; 2068 return if $self->players;
1619 return if $self->isa ("ext::map_per_player");#d#
1620 2069
1621 warn "resetting map ", $self->path;#d# 2070 warn "resetting map ", $self->path;
1622 2071
1623 $self->in_memory (cf::MAP_SWAPPED); 2072 $self->in_memory (cf::MAP_SWAPPED);
1624 2073
1625 # need to save uniques path 2074 # need to save uniques path
1626 unless ($self->{deny_save}) { 2075 unless ($self->{deny_save}) {
1658 $cf::MAP{$self->path} = $self; 2107 $cf::MAP{$self->path} = $self;
1659 2108
1660 $self->reset; # polite request, might not happen 2109 $self->reset; # polite request, might not happen
1661} 2110}
1662 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
1663=item cf::map::unique_maps 2148=item cf::map::unique_maps
1664 2149
1665Returns an arrayref of paths of all shared maps that have 2150Returns an arrayref of paths of all shared maps that have
1666instantiated unique items. May block. 2151instantiated unique items. May block.
1667 2152
1668=cut 2153=cut
1669 2154
1670sub unique_maps() { 2155sub unique_maps() {
1671 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2156 [
1672 or return; 2157 map {
1673
1674 my @paths;
1675
1676 for (@$files) {
1677 utf8::decode $_; 2158 utf8::decode $_;
1678 next if /\.pst$/; 2159 /\.map$/
1679 next unless /^$PATH_SEP/o; 2160 ? normalise $_
1680 2161 : ()
1681 push @paths, cf::map::normalise $_; 2162 } @{ aio_readdir $UNIQUEDIR or [] }
1682 } 2163 ]
1683
1684 \@paths
1685} 2164}
1686 2165
1687package cf; 2166package cf;
1688 2167
1689=back 2168=back
1735 2214
1736 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1737 2216
1738 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1739 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1740 } 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 {
1741 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1742 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1743 } 2236 }
1744} 2237}
1745 2238
1746=item $player_object->may ("access") 2239=item $player_object->may ("access")
1747 2240
1795 $self->deactivate_recursive; 2288 $self->deactivate_recursive;
1796 2289
1797 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2290 return if UNIVERSAL::isa $self->map, "ext::map_link";
1798 2291
1799 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2292 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1800 if $self->map; 2293 if $self->map && $self->map->{path} ne "{link}";
1801 2294
1802 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2295 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1803} 2296}
1804 2297
1805sub cf::object::player::leave_link { 2298sub cf::object::player::leave_link {
1806 my ($self, $map, $x, $y) = @_; 2299 my ($self, $map, $x, $y) = @_;
2300
2301 return unless $self->contr->active;
1807 2302
1808 my $link_pos = delete $self->{_link_pos}; 2303 my $link_pos = delete $self->{_link_pos};
1809 2304
1810 unless ($map) { 2305 unless ($map) {
1811 # restore original map position 2306 # restore original map position
1834 2329
1835 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1836 $self->enter_map ($map, $x, $y); 2331 $self->enter_map ($map, $x, $y);
1837} 2332}
1838 2333
1839cf::player->attach ( 2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1840 on_logout => sub {
1841 my ($pl) = @_;
1842 2335
1843 # abort map switching before logout 2336Moves the player to the given map-path and coordinates by first freezing
1844 if ($pl->ob->{_link_pos}) { 2337her, loading and preparing them map, calling the provided $check callback
1845 cf::sync_job { 2338that has to return the map if sucecssful, and then unfreezes the player on
1846 $pl->ob->leave_link 2339the new (success) or old (failed) map position. In either case, $done will
1847 }; 2340be called at the end of this process.
1848 }
1849 },
1850 on_login => sub {
1851 my ($pl) = @_;
1852 2341
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 2342=cut
2343
2344our $GOTOGEN;
1874 2345
1875sub cf::object::player::goto { 2346sub cf::object::player::goto {
1876 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;
1877 2351
1878 $self->enter_link; 2352 $self->enter_link;
1879 2353
1880 (async { 2354 (async {
1881 my $map = eval { 2355 my $map = eval {
1882 my $map = cf::map::find $path; 2356 my $map = cf::map::find $path;
2357
2358 if ($map) {
1883 $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
1884 $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 $@;
1885 } or 2371 }
1886 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1887 2372
2373 if ($gen == $self->{_goto_generation}) {
2374 delete $self->{_goto_generation};
1888 $self->leave_link ($map, $x, $y); 2375 $self->leave_link ($map, $x, $y);
2376 }
2377
2378 $done->() if $done;
1889 })->prio (1); 2379 })->prio (1);
1890} 2380}
1891 2381
1892=item $player_object->enter_exit ($exit_object) 2382=item $player_object->enter_exit ($exit_object)
1893 2383
1932 2422
1933 $rmp->{random_seed} ||= $exit->random_seed; 2423 $rmp->{random_seed} ||= $exit->random_seed;
1934 2424
1935 my $data = cf::to_json $rmp; 2425 my $data = cf::to_json $rmp;
1936 my $md5 = Digest::MD5::md5_hex $data; 2426 my $md5 = Digest::MD5::md5_hex $data;
1937 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2427 my $meta = "$RANDOMDIR/$md5.meta";
1938 2428
1939 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2429 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1940 aio_write $fh, 0, (length $data), $data, 0; 2430 aio_write $fh, 0, (length $data), $data, 0;
1941 undef $fh; 2431 undef $fh;
1942 aio_rename "$meta~", $meta; 2432 aio_rename "$meta~", $meta;
1951 2441
1952 return unless $self->type == cf::PLAYER; 2442 return unless $self->type == cf::PLAYER;
1953 2443
1954 if ($exit->slaying eq "/!") { 2444 if ($exit->slaying eq "/!") {
1955 #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
1956 cf::sync_job { prepare_random_map $exit }; 2448 cf::sync_job { prepare_random_map $exit };
1957 } 2449 }
1958 2450
1959 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;
1960 my $hp = $exit->stats->hp; 2452 my $hp = $exit->stats->hp;
1961 my $sp = $exit->stats->sp; 2453 my $sp = $exit->stats->sp;
1962 2454
1963 $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);
1964 2460
1965 (async { 2461 (async {
1966 $self->deactivate_recursive; # just to be sure 2462 $self->deactivate_recursive; # just to be sure
1967 unless (eval { 2463 unless (eval {
1968 $self->goto ($slaying, $hp, $sp); 2464 $self->goto ($slaying, $hp, $sp);
1969 2465
1970 1; 2466 1;
1971 }) { 2467 }) {
1972 $self->message ("Something went wrong deep within the crossfire server. " 2468 $self->message ("Something went wrong deep within the crossfire server. "
1973 . "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. "
1974 . "Please report this to the dungeon master!", 2470 . "Please report this to the dungeon master!",
1975 cf::NDI_UNIQUE | cf::NDI_RED); 2471 cf::NDI_UNIQUE | cf::NDI_RED);
1976 2472
1977 warn "ERROR in enter_exit: $@"; 2473 warn "ERROR in enter_exit: $@";
1978 $self->leave_link; 2474 $self->leave_link;
1979 } 2475 }
1980 })->prio (1); 2476 })->prio (1);
1993 2489
1994sub cf::client::send_drawinfo { 2490sub cf::client::send_drawinfo {
1995 my ($self, $text, $flags) = @_; 2491 my ($self, $text, $flags) = @_;
1996 2492
1997 utf8::encode $text; 2493 utf8::encode $text;
1998 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1999} 2495}
2000 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}
2001 2563
2002=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
2003 2565
2004Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
2005the 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>,
2006C<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>.
2007 2569
2008Queries 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
2009reliable at some point in the future. 2571become reliable at some point in the future.
2010 2572
2011=cut 2573=cut
2012 2574
2013sub cf::client::query { 2575sub cf::client::query {
2014 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
2022 utf8::encode $text; 2584 utf8::encode $text;
2023 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2024 2586
2025 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
2026 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
2027} 2591}
2028 2592
2029cf::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 },
2030 on_reply => sub { 2599 on_reply => sub {
2031 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
2032 2601
2033 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
2034 # get handled first 2603 # get handled first
2046 } else { 2615 } else {
2047 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2048 } 2617 }
2049 } 2618 }
2050 }, 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 },
2051); 2638);
2052 2639
2053=item $client->async (\&cb) 2640=item $client->async (\&cb)
2054 2641
2055Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
2102 2689
2103# here we export the classes and methods available to script code 2690# here we export the classes and methods available to script code
2104 2691
2105=pod 2692=pod
2106 2693
2107The following fucntions and emthods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
2108 2695
2109 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
2110 cf::object::player player 2700 cf::object::player
2111 cf::player peaceful 2701 player
2112 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
2113 2708
2114=cut 2709=cut
2115 2710
2116for ( 2711for (
2117 ["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)],
2118 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
2119 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
2120 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
2121) { 2717) {
2122 no strict 'refs'; 2718 no strict 'refs';
2193=back 2789=back
2194 2790
2195=cut 2791=cut
2196 2792
2197############################################################################# 2793#############################################################################
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 2794# the server's init and main functions
2271 2795
2272sub load_faces { 2796sub load_facedata($) {
2273 my $path = sprintf "%s/faces", cf::datadir; 2797 my ($path) = @_;
2274 2798
2275 warn "loading faces from $path\n"; 2799 warn "loading facedata from $path\n";
2276 2800
2277 my $faces; 2801 my $facedata;
2278 0 < aio_load $path, $faces 2802 0 < aio_load $path, $facedata
2279 or die "$path: $!"; 2803 or die "$path: $!";
2280 2804
2281 Coro::cede;
2282 $faces = Storable::thaw $faces; 2805 $facedata = Coro::Storable::thaw $facedata;
2283 Coro::cede;
2284 2806
2807 $facedata->{version} == 2
2808 or cf::cleanup "$path: version mismatch, cannot proceed.";
2809
2810 {
2811 my $faces = $facedata->{faceinfo};
2812
2285 while (my ($face, $info) = each %$faces) { 2813 while (my ($face, $info) = each %$faces) {
2286 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2814 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2287 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2815 cf::face::set_visibility $idx, $info->{visibility};
2816 cf::face::set_magicmap $idx, $info->{magicmap};
2288 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2817 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2289 Coro::cede; 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 }
2290 } 2877 }
2291 2878
2292 1 2879 1
2293} 2880}
2294 2881
2882sub reload_regions {
2883 load_resource_file "$MAPDIR/regions"
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
2295sub reload_resources { 2912sub reload_resources {
2296 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2913 warn "reloading resource files...\n";
2297 or die "unable to load regions file\n";#d# 2914
2915 reload_regions;
2298 load_faces 2916 reload_facedata;
2299 or die "unable to load faces\n";#d# 2917 #reload_archetypes;#d#
2918 reload_archetypes;
2919 reload_treasures;
2920
2921 warn "finished reloading resource files\n";
2300} 2922}
2301 2923
2302sub init { 2924sub init {
2303 reload_resources; 2925 reload_resources;
2304} 2926}
2305 2927
2306sub cfg_load { 2928sub cfg_load {
2307 open my $fh, "<:utf8", cf::confdir . "/config" 2929 open my $fh, "<:utf8", "$CONFDIR/config"
2308 or return; 2930 or return;
2309 2931
2310 local $/; 2932 local $/;
2311 *CFG = YAML::Syck::Load <$fh>; 2933 *CFG = YAML::Syck::Load <$fh>;
2312 2934
2357 }, 2979 },
2358 ); 2980 );
2359 } 2981 }
2360} 2982}
2361 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
2362sub emergency_save() { 3022sub emergency_save() {
2363 my $freeze_guard = cf::freeze_mainloop; 3023 my $freeze_guard = cf::freeze_mainloop;
2364 3024
2365 warn "enter emergency perl save\n"; 3025 warn "enter emergency perl save\n";
2366 3026
2397 3057
2398 warn Carp::longmess "post_cleanup backtrace" 3058 warn Carp::longmess "post_cleanup backtrace"
2399 if $make_core; 3059 if $make_core;
2400} 3060}
2401 3061
2402sub reload() { 3062sub do_reload_perl() {
2403 # can/must only be called in main 3063 # can/must only be called in main
2404 if ($Coro::current != $Coro::main) { 3064 if ($Coro::current != $Coro::main) {
2405 warn "can only reload from main coroutine"; 3065 warn "can only reload from main coroutine";
2406 return; 3066 return;
2407 } 3067 }
2441 %EXT_CORO = (); 3101 %EXT_CORO = ();
2442 3102
2443 warn "removing commands"; 3103 warn "removing commands";
2444 %COMMAND = (); 3104 %COMMAND = ();
2445 3105
2446 warn "removing ext commands"; 3106 warn "removing ext/exti commands";
2447 %EXTCMD = (); 3107 %EXTCMD = ();
3108 %EXTICMD = ();
2448 3109
2449 warn "unloading/nuking all extensions"; 3110 warn "unloading/nuking all extensions";
2450 for my $pkg (@EXTS) { 3111 for my $pkg (@EXTS) {
2451 warn "... unloading $pkg"; 3112 warn "... unloading $pkg";
2452 3113
2482 Symbol::delete_package "safe::$_" 3143 Symbol::delete_package "safe::$_"
2483 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);
2484 3145
2485 warn "unloading cf.pm \"a bit\""; 3146 warn "unloading cf.pm \"a bit\"";
2486 delete $INC{"cf.pm"}; 3147 delete $INC{"cf.pm"};
3148 delete $INC{"cf/pod.pm"};
2487 3149
2488 # don't, removes xs symbols, too, 3150 # don't, removes xs symbols, too,
2489 # and global variables created in xs 3151 # and global variables created in xs
2490 #Symbol::delete_package __PACKAGE__; 3152 #Symbol::delete_package __PACKAGE__;
2491 3153
2506 warn "reattaching attachments to maps"; 3168 warn "reattaching attachments to maps";
2507 reattach $_ for values %MAP; 3169 reattach $_ for values %MAP;
2508 warn "reattaching attachments to players"; 3170 warn "reattaching attachments to players";
2509 reattach $_ for values %PLAYER; 3171 reattach $_ for values %PLAYER;
2510 3172
2511 warn "loading reloadable resources";
2512 reload_resources;
2513
2514 warn "leaving sync_job"; 3173 warn "leaving sync_job";
2515 3174
2516 1 3175 1
2517 } or do { 3176 } or do {
2518 warn $@; 3177 warn $@;
2523 warn "reloaded"; 3182 warn "reloaded";
2524}; 3183};
2525 3184
2526our $RELOAD_WATCHER; # used only during reload 3185our $RELOAD_WATCHER; # used only during reload
2527 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
2528register_command "reload" => sub { 3202register_command "reload" => sub {
2529 my ($who, $arg) = @_; 3203 my ($who, $arg) = @_;
2530 3204
2531 if ($who->flag (FLAG_WIZ)) { 3205 if ($who->flag (FLAG_WIZ)) {
2532 $who->message ("reloading server."); 3206 $who->message ("reloading server.");
2533 3207 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 } 3208 }
2547}; 3209};
2548 3210
2549unshift @INC, $LIBDIR; 3211unshift @INC, $LIBDIR;
2550 3212
2551my $bug_warning = 0; 3213my $bug_warning = 0;
2552 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;
2553$TICK_WATCHER = Event->timer ( 3238$TICK_WATCHER = Event->timer (
2554 reentrant => 0, 3239 reentrant => 0,
2555 parked => 1, 3240 parked => 1,
2556 prio => 0, 3241 prio => 0,
2557 at => $NEXT_TICK || $TICK, 3242 at => $NEXT_TICK || $TICK,
2561 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"
2562 unless ++$bug_warning > 10; 3247 unless ++$bug_warning > 10;
2563 return; 3248 return;
2564 } 3249 }
2565 3250
2566 $NOW = Event::time; 3251 $NOW = $tick_start = Event::time;
2567 3252
2568 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
2569 $RUNTIME += $TICK; 3278 $RUNTIME += $TICK;
2570 $NEXT_TICK += $TICK; 3279 $NEXT_TICK += $TICK;
2571 3280
2572 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3281 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2573 $NEXT_RUNTIME_WRITE = $NOW + 10; 3282 $NEXT_RUNTIME_WRITE = $NOW + 10;
2575 write_runtime 3284 write_runtime
2576 or warn "ERROR: unable to write runtime file: $!"; 3285 or warn "ERROR: unable to write runtime file: $!";
2577 }; 3286 };
2578 } 3287 }
2579 3288
2580 $WAIT_FOR_TICK->broadcast;
2581 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2582
2583# my $AFTER = Event::time; 3289# my $AFTER = Event::time;
2584# warn $AFTER - $NOW;#d# 3290# warn $AFTER - $NOW;#d#
2585 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
2586 # 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
2587 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3302 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2588 3303
2589 $TICK_WATCHER->at ($NEXT_TICK); 3304 $TICK_WATCHER->at ($NEXT_TICK);
2590 $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
2591 }, 3313 },
2592); 3314);
2593 3315
2594{ 3316{
2595 BDB::max_poll_time $TICK * 0.1; 3317 BDB::max_poll_time $TICK * 0.1;
2623 3345
2624 cf::sync_job { 3346 cf::sync_job {
2625 eval { 3347 eval {
2626 BDB::db_env_open 3348 BDB::db_env_open
2627 $DB_ENV, 3349 $DB_ENV,
2628 $BDB_ENV_DIR, 3350 $BDBDIR,
2629 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
2630 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3352 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2631 0666; 3353 0666;
2632 3354
2633 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3355 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2634 3356
2635 $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);
2636 $DB_ENV->set_lk_detect; 3358 $DB_ENV->set_lk_detect;
2637 }; 3359 };
2638 3360
2654 prio => 6, 3376 prio => 6,
2655 cb => \&IO::AIO::poll_cb, 3377 cb => \&IO::AIO::poll_cb,
2656 ); 3378 );
2657} 3379}
2658 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
2659END { cf::emergency_save } 3422END { cf::emergency_save }
2660 3423
26611 34241
2662 3425

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines