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.109 by root, Sun Dec 31 22:23:12 2006 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.3; 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 ();
26use BDB ();
27use Data::Dumper;
20use Digest::MD5; 28use Digest::MD5;
21use Fcntl; 29use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 30use YAML::Syck ();
31use IO::AIO 2.32 ();
24use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
25 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
40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
41
26use 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
27 43
28# 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?
29$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
30 46
31$Coro::main->prio (2); # 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
32 48
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 50
35our %COMMAND = (); 51our %COMMAND = ();
36our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
53
54our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
57our %EXT_CORO = (); # coroutines bound to extensions
58our %EXT_MAP = (); # pluggable maps
38 59
60our $RELOAD; # number of reloads so far
39our @EVENT; 61our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 62
42our $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(!)
43our $TICK_WATCHER; 76our $TICK_WATCHER;
77our $AIO_POLL_WATCHER;
78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 79our $NEXT_TICK;
45our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
46 85
47our %CFG; 86our %CFG;
48 87
49our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 89our $RUNTIME;
51 90
91our %PLAYER; # all users
52our %MAP; # all maps 92our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 93our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE; 94
55our $RANDOM_MAPS = cf::localdir . "/random"; 95# used to convert map paths into valid unix filenames by replacing / by ∕
56our %EXT_CORO; 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
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
57 101
58binmode STDOUT; 102binmode STDOUT;
59binmode STDERR; 103binmode STDERR;
60 104
61# read virtual server time, if available 105# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
66} 110}
67 111
68mkdir cf::localdir; 112mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 114
74# a special map that is always available 115our $EMERGENCY_POSITION;
75our $LINK_MAP; 116
117sub cf::map::normalise;
76 118
77############################################################################# 119#############################################################################
78 120
79=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
80 122
87=item $cf::RUNTIME 129=item $cf::RUNTIME
88 130
89The 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
90every server tick. 132every server tick.
91 133
92=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
93 137
94The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 142
97=item $cf::NOW 143=item $cf::NOW
98 144
99The time of the last (current) server tick. 145The time of the last (current) server tick.
100 146
101=item $cf::TICK 147=item $cf::TICK
102 148
103The 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.
104 160
105=item %cf::CFG 161=item %cf::CFG
106 162
107Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
108from wherever your confdir points to. 164from wherever your confdir points to.
165
166=item cf::wait_for_tick, cf::wait_for_tick_begin
167
168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
169returns directly I<after> the tick processing (and consequently, can only wake one process
170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
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.
109 177
110=back 178=back
111 179
112=cut 180=cut
113 181
114BEGIN { 182BEGIN {
115 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 184 my $msg = join "", @_;
117 utf8::encode $msg;
118 185
119 $msg .= "\n" 186 $msg .= "\n"
120 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
121 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
122 LOG llevError, "cfperl: $msg"; 192 LOG llevError, $msg;
123 }; 193 };
124} 194}
125 195
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 203
133# 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
134# within the Safe compartment. 205# within the Safe compartment.
135for my $pkg (qw( 206for my $pkg (qw(
136 cf::global cf::attachable 207 cf::global cf::attachable
145 216
146$Event::DIED = sub { 217$Event::DIED = sub {
147 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
148}; 219};
149 220
150my %ext_pkg; 221#############################################################################
151my @exts;
152my @hook;
153 222
154=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
155 224
156=over 4 225=over 4
157 226
158=cut 227=item dumpval $ref
159 228
160use JSON::Syck (); # TODO# replace by JSON::PC once working 229=cut
230
231sub dumpval {
232 eval {
233 local $SIG{__DIE__};
234 my $d;
235 if (1) {
236 $d = new Data::Dumper([$_[0]], ["*var"]);
237 $d->Terse(1);
238 $d->Indent(2);
239 $d->Quotekeys(0);
240 $d->Useqq(1);
241 #$d->Bless(...);
242 $d->Seen($_[1]) if @_ > 1;
243 $d = $d->Dump();
244 }
245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
246 $d
247 } || "[unable to dump $_[0]: '$@']";
248}
161 249
162=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
163 251
164Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
165 253
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
174 255
175Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
176 257
177=cut 258=cut
178 259
179sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
181 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
264
265=item cf::lock_wait $string
266
267Wait until the given lock is available. See cf::lock_acquire.
268
269=item my $lock = cf::lock_acquire $string
270
271Wait until the given lock is available and then acquires it and returns
272a Coro::guard object. If the guard object gets destroyed (goes out of scope,
273for example when the coroutine gets canceled), the lock is automatically
274returned.
275
276Lock names should begin with a unique identifier (for example, cf::map::find
277uses map_find and cf::map::load uses map_load).
278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
283=cut
284
285our %LOCK;
286
287sub lock_wait($) {
288 my ($key) = @_;
289
290 # wait for lock, if any
291 while ($LOCK{$key}) {
292 push @{ $LOCK{$key} }, $Coro::current;
293 Coro::schedule;
294 }
182} 295}
296
297sub lock_acquire($) {
298 my ($key) = @_;
299
300 # wait, to be sure we are not locked
301 lock_wait $key;
302
303 $LOCK{$key} = [];
304
305 Coro::guard {
306 # wake up all waiters, to be on the safe side
307 $_->ready for @{ delete $LOCK{$key} };
308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
317sub freeze_mainloop {
318 return unless $TICK_WATCHER->is_active;
319
320 my $guard = Coro::guard {
321 $TICK_WATCHER->start;
322 };
323 $TICK_WATCHER->stop;
324 $guard
325}
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
383=item cf::async { BLOCK }
384
385Currently the same as Coro::async_pool, meaning you cannot use
386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
387thing you are allowed to do is call C<prio> on it.
388
389=cut
390
391BEGIN { *async = \&Coro::async_pool }
183 392
184=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
185 394
186The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
187always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
188reentrant. 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.
189 399
190If 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
191the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
192server 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
193fast or be very important. 403fast or be very important.
195=cut 405=cut
196 406
197sub sync_job(&) { 407sub sync_job(&) {
198 my ($job) = @_; 408 my ($job) = @_;
199 409
200 my $busy = 1;
201 my @res;
202
203 # TODO: use suspend/resume instead
204 local $FREEZE = 1;
205
206 my $coro = Coro::async {
207 @res = eval { $job->() };
208 warn $@ if $@;
209 undef $busy;
210 };
211
212 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
413 # this is the main coro, too bad, we have to block
414 # till the operation succeeds, freezing the server :/
415
416 # TODO: use suspend/resume instead
417 # (but this is cancel-safe)
418 my $freeze_guard = freeze_mainloop;
419
420 my $busy = 1;
421 my @res;
422
423 (async {
424 @res = eval { $job->() };
425 warn $@ if $@;
426 undef $busy;
213 $coro->prio (Coro::PRIO_MAX); 427 })->prio (Coro::PRIO_MAX);
428
214 while ($busy) { 429 while ($busy) {
215 Coro::cede_notself; 430 Coro::cede or Event::one_event;
216 Event::one_event unless Coro::nready;
217 } 431 }
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
440 wantarray ? @res : $res[0]
218 } else { 441 } else {
219 $coro->join; 442 # we are in another coroutine, how wonderful, everything just works
443
444 $job->()
220 } 445 }
221
222 wantarray ? @res : $res[0]
223} 446}
224 447
225=item $coro = cf::coro { BLOCK } 448=item $coro = cf::async_ext { BLOCK }
226 449
227Creates and returns a new coro. This coro is automcatially being canceled 450Like async, but this coro is automatically being canceled when the
228when the extension calling this is being unloaded. 451extension calling this is being unloaded.
229 452
230=cut 453=cut
231 454
232sub coro(&) { 455sub async_ext(&) {
233 my $cb = shift; 456 my $cb = shift;
234 457
235 my $coro; $coro = async { 458 my $coro = &Coro::async ($cb);
236 eval {
237 $cb->();
238 };
239 warn $@ if $@;
240 };
241 459
242 $coro->on_destroy (sub { 460 $coro->on_destroy (sub {
243 delete $EXT_CORO{$coro+0}; 461 delete $EXT_CORO{$coro+0};
244 }); 462 });
245 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
246 464
247 $coro 465 $coro
248} 466}
249 467
250sub write_runtime { 468=item fork_call { }, $args
251 my $runtime = cf::localdir . "/runtime";
252 469
253 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
254 or return; 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.
255 474
256 my $value = $cf::RUNTIME; 475=cut
257 (aio_write $fh, 0, (length $value), $value, 0) <= 0
258 and return;
259 476
260 aio_fsync $fh 477sub _store_scalar {
261 and return; 478 open my $fh, ">", \my $buf
262 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
263 close $fh 481 close $fh;
264 or return;
265 482
266 aio_rename "$runtime~", $runtime 483 $buf
267 and return; 484}
268 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;
269 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 });
270} 655}
271 656
272=back 657=back
273 658
274=cut 659=cut
275
276#############################################################################
277
278package cf::path;
279
280sub new {
281 my ($class, $path, $base) = @_;
282
283 my $self = bless { }, $class;
284
285 if ($path =~ s{^\?random/}{}) {
286 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
287 $self->{random} = cf::from_json $data;
288 } else {
289 if ($path =~ s{^~([^/]+)?}{}) {
290 $self->{user_rel} = 1;
291
292 if (defined $1) {
293 $self->{user} = $1;
294 } elsif ($base =~ m{^~([^/]+)/}) {
295 $self->{user} = $1;
296 } else {
297 warn "cannot resolve user-relative path without user <$path,$base>\n";
298 }
299 } elsif ($path =~ /^\//) {
300 # already absolute
301 } else {
302 $base =~ s{[^/]+/?$}{};
303 return $class->new ("$base/$path");
304 }
305
306 for ($path) {
307 redo if s{/\.?/}{/};
308 redo if s{/[^/]+/\.\./}{/};
309 }
310 }
311
312 $self->{path} = $path;
313
314 $self
315}
316
317# the name / primary key / in-game path
318sub as_string {
319 my ($self) = @_;
320
321 $self->{user_rel} ? "~$self->{user}$self->{path}"
322 : $self->{random} ? "?random/$self->{path}"
323 : $self->{path}
324}
325
326# the displayed name, this is a one way mapping
327sub visible_name {
328 my ($self) = @_;
329
330# if (my $rmp = $self->{random}) {
331# # todo: be more intelligent about this
332# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
333# } else {
334 $self->as_string
335# }
336}
337
338# escape the /'s in the path
339sub _escaped_path {
340 # ∕ is U+2215
341 (my $path = $_[0]{path}) =~ s/\//∕/g;
342 $path
343}
344
345# the original (read-only) location
346sub load_path {
347 my ($self) = @_;
348
349 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
350}
351
352# the temporary/swap location
353sub save_path {
354 my ($self) = @_;
355
356 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
357 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
358 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
359}
360
361# the unique path, might be eq to save_path
362sub uniq_path {
363 my ($self) = @_;
364
365 $self->{user_rel} || $self->{random}
366 ? undef
367 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
368}
369
370# return random map parameters, or undef
371sub random_map_params {
372 my ($self) = @_;
373
374 $self->{random}
375}
376
377# this is somewhat ugly, but style maps do need special treatment
378sub is_style_map {
379 $_[0]{path} =~ m{^/styles/}
380}
381
382package cf;
383 660
384############################################################################# 661#############################################################################
385 662
386=head2 ATTACHABLE OBJECTS 663=head2 ATTACHABLE OBJECTS
387 664
389attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
390to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
391 668
392In 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>
393C<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
394crossfire+). 671Crossfire TRT).
395 672
396=over 4 673=over 4
397 674
398=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
399 676
513our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
514our @CB_MAP = (); 791our @CB_MAP = ();
515 792
516my %attachment; 793my %attachment;
517 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
518sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
519 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
520 803
521 use sort 'stable'; 804 use sort 'stable';
522 805
556 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
557 840
558 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
559 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
560 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
561 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
562 845
563 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
564 my $pkg = shift @arg; 847 my $pkg = shift @arg;
565 848
566 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
595 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
596 } 879 }
597 880
598 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
599 } else { 882 } else {
600 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
601 } 884 }
602 885
603 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
604} 887}
605 888
607 if (ref $_[0]) { 890 if (ref $_[0]) {
608 _object_attach @_; 891 _object_attach @_;
609 } else { 892 } else {
610 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
611 } 894 }
895 _recalc_want;
612}; 896};
613 897
614# all those should be optimised 898# all those should be optimised
615sub cf::attachable::detach { 899sub cf::attachable::detach {
616 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
619 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
620 reattach ($obj); 904 reattach ($obj);
621 } else { 905 } else {
622 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
623 } 907 }
908 _recalc_want;
624}; 909};
625 910
626sub cf::attachable::attached { 911sub cf::attachable::attached {
627 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
628 913
643 "; 928 ";
644 die if $@; 929 die if $@;
645} 930}
646 931
647our $override; 932our $override;
648our @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?
649 934
650sub override { 935sub override {
651 $override = 1; 936 $override = 1;
652 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
653} 938}
654 939
655sub do_invoke { 940sub do_invoke {
656 my $event = shift; 941 my $event = shift;
657 my $callbacks = shift; 942 my $callbacks = shift;
658 943
659 @invoke_results = (); 944 @INVOKE_RESULTS = ();
660 945
661 local $override; 946 local $override;
662 947
663 for (@$callbacks) { 948 for (@$callbacks) {
664 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
681 966
682Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
683 968
684This 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
685removed 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
686results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
687 972
688=back 973=back
689 974
690=cut 975=cut
691 976
692############################################################################# 977#############################################################################
693# 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}
694 990
695sub reattach { 991sub reattach {
696 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
697 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
698 996
699 my $registry = $obj->registry; 997 my $registry = $obj->registry;
700 998
701 @$registry = (); 999 @$registry = ();
702 1000
749 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
750 1048
751 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
752 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
753 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
754 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
755 close $fh; 1053 close $fh;
756 1054
757 if (@$objs) { 1055 if (@$objs) {
758 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1056 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
759 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
760 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
761 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
762 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
763 close $fh; 1061 close $fh;
764 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
765 } 1063 }
766 } else { 1064 } else {
767 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
795 or return; 1093 or return;
796 1094
797 unless (aio_stat "$filename.pst") { 1095 unless (aio_stat "$filename.pst") {
798 (aio_load "$filename.pst", $av) >= 0 1096 (aio_load "$filename.pst", $av) >= 0
799 or return; 1097 or return;
800 $av = eval { (Storable::thaw <$av>)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
801 } 1099 }
802 1100
1101 warn sprintf "loading %s (%d)\n",
1102 $filename, length $data, scalar @{$av || []};
803 return ($data, $av); 1103 return ($data, $av);
804} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
805 1111
806############################################################################# 1112#############################################################################
807# command handling &c 1113# command handling &c
808 1114
809=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
822 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
823} 1129}
824 1130
825=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
826 1132
827Register 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.
828 1138
829If 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
830called. 1140called.
831 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
832=cut 1153=cut
833 1154
834sub register_extcmd { 1155sub register_extcmd {
835 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
836 1157
837 my $caller = caller;
838 #warn "registering extcmd '$name' to '$caller'";
839
840 $EXTCMD{$name} = [$cb, $caller]; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
841} 1165}
842 1166
843cf::player->attach ( 1167cf::player->attach (
844 on_command => sub { 1168 on_command => sub {
845 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
854 cf::override; 1178 cf::override;
855 }, 1179 },
856 on_extcmd => sub { 1180 on_extcmd => sub {
857 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
858 1182
859 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860 1184
861 if (ref $msg) { 1185 if (ref $msg) {
862 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
863 if (my %reply = $cb->[0]->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
864 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
865 } 1189 }
866 } 1190 }
867 } else { 1191 } else {
868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1192 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
870 1194
871 cf::override; 1195 cf::override;
872 }, 1196 },
873); 1197);
874 1198
1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
1203 for my $path (<$LIBDIR/*.ext>) {
1204 next unless -r $path;
1205
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;
1263 }
1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
1269 };
1270}
1271
1272#############################################################################
1273
1274=back
1275
1276=head2 CORE EXTENSIONS
1277
1278Functions and methods that extend core crossfire objects.
1279
1280=cut
1281
1282package cf::player;
1283
1284use Coro::AIO;
1285
1286=head3 cf::player
1287
1288=over 4
1289
1290=item cf::player::find $login
1291
1292Returns the given player object, loading it if necessary (might block).
1293
1294=cut
1295
1296sub playerdir($) {
1297 "$PLAYERDIR/"
1298 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1299}
1300
1301sub path($) {
1302 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1303
1304 (playerdir $login) . "/playerdata"
1305}
1306
1307sub find_active($) {
1308 $cf::PLAYER{$_[0]}
1309 and $cf::PLAYER{$_[0]}->active
1310 and $cf::PLAYER{$_[0]}
1311}
1312
1313sub exists($) {
1314 my ($login) = @_;
1315
1316 $cf::PLAYER{$login}
1317 or cf::sync_job { !aio_stat path $login }
1318}
1319
1320sub find($) {
1321 return $cf::PLAYER{$_[0]} || do {
1322 my $login = $_[0];
1323
1324 my $guard = cf::lock_acquire "user_find:$login";
1325
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
1334 my $pl = load_pl path $login
1335 or return;
1336 $cf::PLAYER{$login} = $pl
1337 }
1338 }
1339}
1340
1341sub save($) {
1342 my ($pl) = @_;
1343
1344 return if $pl->{deny_save};
1345
1346 my $path = path $pl;
1347 my $guard = cf::lock_acquire "user_save:$path";
1348
1349 return if $pl->{deny_save};
1350
1351 aio_mkdir playerdir $pl, 0770;
1352 $pl->{last_save} = $cf::RUNTIME;
1353
1354 $pl->save_pl ($path);
1355 Coro::cede;
1356}
1357
1358sub new($) {
1359 my ($login) = @_;
1360
1361 my $self = create;
1362
1363 $self->ob->name ($login);
1364 $self->{deny_save} = 1;
1365
1366 $cf::PLAYER{$login} = $self;
1367
1368 $self
1369}
1370
1371=item $pl->quit_character
1372
1373Nukes the player without looking back. If logged in, the connection will
1374be destroyed. May block for a long time.
1375
1376=cut
1377
1378sub quit_character {
1379 my ($pl) = @_;
1380
1381 my $name = $pl->ob->name;
1382
1383 $pl->{deny_save} = 1;
1384 $pl->password ("*"); # this should lock out the player until we nuked the dir
1385
1386 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1387 $pl->deactivate;
1388 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1389 $pl->ns->destroy if $pl->ns;
1390
1391 my $path = playerdir $pl;
1392 my $temp = "$path~$cf::RUNTIME~deleting~";
1393 aio_rename $path, $temp;
1394 delete $cf::PLAYER{$pl->ob->name};
1395 $pl->destroy;
1396
1397 my $prefix = qr<^~\Q$name\E/>;
1398
1399 # nuke player maps
1400 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1401
1402 IO::AIO::aio_rmtree $temp;
1403}
1404
1405=item $pl->kick
1406
1407Kicks a player out of the game. This destroys the connection.
1408
1409=cut
1410
1411sub kick {
1412 my ($pl, $kicker) = @_;
1413
1414 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1415 $pl->killer ("kicked");
1416 $pl->ns->destroy;
1417}
1418
1419=item cf::player::list_logins
1420
1421Returns am arrayref of all valid playernames in the system, can take a
1422while and may block, so not sync_job-capable, ever.
1423
1424=cut
1425
1426sub list_logins {
1427 my $dirs = aio_readdir $PLAYERDIR
1428 or return [];
1429
1430 my @logins;
1431
1432 for my $login (@$dirs) {
1433 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1434 aio_read $fh, 0, 512, my $buf, 0 or next;
1435 $buf !~ /^password -------------$/m or next; # official not-valid tag
1436
1437 utf8::decode $login;
1438 push @logins, $login;
1439 }
1440
1441 \@logins
1442}
1443
1444=item $player->maps
1445
1446Returns an arrayref of map paths that are private for this
1447player. May block.
1448
1449=cut
1450
1451sub maps($) {
1452 my ($pl) = @_;
1453
1454 $pl = ref $pl ? $pl->ob->name : $pl;
1455
1456 my $files = aio_readdir playerdir $pl
1457 or return;
1458
1459 my @paths;
1460
1461 for (@$files) {
1462 utf8::decode $_;
1463 next if /\.(?:pl|pst)$/;
1464 next unless /^$PATH_SEP/o;
1465
1466 push @paths, cf::map::normalise "~$pl/$_";
1467 }
1468
1469 \@paths
1470}
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
1522=item $player->ext_reply ($msgid, %msg)
1523
1524Sends an ext reply to the player.
1525
1526=cut
1527
1528sub ext_reply($$%) {
1529 my ($self, $id, %msg) = @_;
1530
1531 $msg{msgid} = $id;
1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1533}
1534
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}
1575
1576=back
1577
1578=head3 cf::map
1579
1580=over 4
1581
1582=cut
1583
1584package cf::map;
1585
1586use Fcntl;
1587use Coro::AIO;
1588
1589use overload
1590 '""' => \&as_string,
1591 fallback => 1;
1592
1593our $MAX_RESET = 3600;
1594our $DEFAULT_RESET = 3000;
1595
1596sub generate_random_map {
1597 my ($self, $rmp) = @_;
1598 # mit "rum" bekleckern, nicht
1599 $self->_create_random_map (
1600 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1601 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1602 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1603 $rmp->{exit_on_final_map},
1604 $rmp->{xsize}, $rmp->{ysize},
1605 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1606 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1607 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1608 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1609 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1610 (cf::region::find $rmp->{region}), $rmp->{custom}
1611 )
1612}
1613
1614=item cf::map->register ($regex, $prio)
1615
1616Register a handler for the map path matching the given regex at the
1617givne priority (higher is better, built-in handlers have priority 0, the
1618default).
1619
1620=cut
1621
875sub register { 1622sub register {
1623 my (undef, $regex, $prio) = @_;
1624 my $pkg = caller;
1625
1626 no strict;
1627 push @{"$pkg\::ISA"}, __PACKAGE__;
1628
1629 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1630}
1631
1632# also paths starting with '/'
1633$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1634
1635sub thawer_merge {
876 my ($base, $pkg) = @_; 1636 my ($self, $merge) = @_;
877 1637
878 #TODO 1638 # we have to keep some variables in memory intact
879} 1639 local $self->{path};
1640 local $self->{load_path};
880 1641
881sub load_extension { 1642 $self->SUPER::thawer_merge ($merge);
1643}
1644
1645sub normalise {
882 my ($path) = @_; 1646 my ($path, $base) = @_;
883 1647
884 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1648 $path = "$path"; # make sure its a string
885 my $base = $1;
886 my $pkg = $1;
887 $pkg =~ s/[^[:word:]]/_/g;
888 $pkg = "ext::$pkg";
889 1649
890 warn "loading '$path' into '$pkg'\n"; 1650 $path =~ s/\.map$//;
891 1651
892 open my $fh, "<:utf8", $path 1652 # map plan:
893 or die "$path: $!"; 1653 #
1654 # /! non-realised random map exit (special hack!)
1655 # {... are special paths that are not being touched
1656 # ?xxx/... are special absolute paths
1657 # ?random/... random maps
1658 # /... normal maps
1659 # ~user/... per-player map of a specific user
894 1660
895 my $source = 1661 $path =~ s/$PATH_SEP/\//go;
896 "package $pkg; use strict; use utf8;\n"
897 . "#line 1 \"$path\"\n{\n"
898 . (do { local $/; <$fh> })
899 . "\n};\n1";
900 1662
901 eval $source 1663 # treat it as relative path if it starts with
902 or die $@ ? "$path: $@\n" 1664 # something that looks reasonable
903 : "extension disabled.\n"; 1665 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1666 $base or Carp::carp "normalise called with relative path and no base: '$path'";
904 1667
905 push @exts, $pkg; 1668 $base =~ s{[^/]+/?$}{};
906 $ext_pkg{$base} = $pkg; 1669 $path = "$base/$path";
907
908# no strict 'refs';
909# @{"$pkg\::ISA"} = ext::;
910
911 register $base, $pkg;
912}
913
914sub unload_extension {
915 my ($pkg) = @_;
916
917 warn "removing extension $pkg\n";
918
919 # remove hooks
920 #TODO
921# for my $idx (0 .. $#PLUGIN_EVENT) {
922# delete $hook[$idx]{$pkg};
923# } 1670 }
924 1671
925 # remove commands 1672 for ($path) {
926 for my $name (keys %COMMAND) { 1673 redo if s{//}{/};
927 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1674 redo if s{/\.?/}{/};
1675 redo if s{/[^/]+/\.\./}{/};
1676 }
928 1677
929 if (@cb) { 1678 $path
930 $COMMAND{$name} = \@cb; 1679}
1680
1681sub new_from_path {
1682 my (undef, $path, $base) = @_;
1683
1684 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1685
1686 $path = normalise $path, $base;
1687
1688 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1689 if ($path =~ $EXT_MAP{$pkg}[1]) {
1690 my $self = bless cf::map::new, $pkg;
1691 $self->{path} = $path; $self->path ($path);
1692 $self->init; # pass $1 etc.
1693 return $self;
1694 }
1695 }
1696
1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1698 ()
1699}
1700
1701sub init {
1702 my ($self) = @_;
1703
1704 $self
1705}
1706
1707sub as_string {
1708 my ($self) = @_;
1709
1710 "$self->{path}"
1711}
1712
1713# the displayed name, this is a one way mapping
1714sub visible_name {
1715 &as_string
1716}
1717
1718# the original (read-only) location
1719sub load_path {
1720 my ($self) = @_;
1721
1722 "$MAPDIR/$self->{path}.map"
1723}
1724
1725# the temporary/swap location
1726sub save_path {
1727 my ($self) = @_;
1728
1729 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1730 "$TMPDIR/$path.map"
1731}
1732
1733# the unique path, undef == no special unique path
1734sub uniq_path {
1735 my ($self) = @_;
1736
1737 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1738 "$UNIQUEDIR/$path"
1739}
1740
1741# and all this just because we cannot iterate over
1742# all maps in C++...
1743sub change_all_map_light {
1744 my ($change) = @_;
1745
1746 $_->change_map_light ($change)
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;
1756}
1757
1758sub unlink_save {
1759 my ($self) = @_;
1760
1761 utf8::encode (my $save = $self->save_path);
1762 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1763 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1764}
1765
1766sub load_header_from($) {
1767 my ($self, $path) = @_;
1768
1769 utf8::encode $path;
1770 #aio_open $path, O_RDONLY, 0
1771 # or return;
1772
1773 $self->_load_header ($path)
1774 or return;
1775
1776 $self->{load_path} = $path;
1777
1778 1
1779}
1780
1781sub load_header_orig {
1782 my ($self) = @_;
1783
1784 $self->load_header_from ($self->load_path)
1785}
1786
1787sub load_header_temp {
1788 my ($self) = @_;
1789
1790 $self->load_header_from ($self->save_path)
1791}
1792
1793sub prepare_temp {
1794 my ($self) = @_;
1795
1796 $self->last_access ((delete $self->{last_access})
1797 || $cf::RUNTIME); #d#
1798 # safety
1799 $self->{instantiate_time} = $cf::RUNTIME
1800 if $self->{instantiate_time} > $cf::RUNTIME;
1801}
1802
1803sub prepare_orig {
1804 my ($self) = @_;
1805
1806 $self->{load_original} = 1;
1807 $self->{instantiate_time} = $cf::RUNTIME;
1808 $self->last_access ($cf::RUNTIME);
1809 $self->instantiate;
1810}
1811
1812sub load_header {
1813 my ($self) = @_;
1814
1815 if ($self->load_header_temp) {
1816 $self->prepare_temp;
931 } else { 1817 } else {
932 delete $COMMAND{$name}; 1818 $self->load_header_orig
933 } 1819 or return;
1820 $self->prepare_orig;
1821 }
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
934 } 1829 1
1830}
935 1831
936 # remove extcmds 1832sub find;
937 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1833sub find {
938 delete $EXTCMD{$name}; 1834 my ($path, $origin) = @_;
1835
1836 $path = normalise $path, $origin && $origin->path;
1837
1838 cf::lock_wait "map_find:$path";
1839
1840 $cf::MAP{$path} || do {
1841 my $guard = cf::lock_acquire "map_find:$path";
1842 my $map = new_from_path cf::map $path
1843 or return;
1844
1845 $map->{last_save} = $cf::RUNTIME;
1846
1847 $map->load_header
1848 or return;
1849
1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1851 # doing this can freeze the server in a sync job, obviously
1852 #$cf::WAIT_FOR_TICK->wait;
1853 $map->reset;
1854 undef $guard;
1855 return find $path;
1856 }
1857
1858 $cf::MAP{$path} = $map
1859 }
1860}
1861
1862sub pre_load { }
1863sub post_load { }
1864
1865sub load {
1866 my ($self) = @_;
1867
1868 local $self->{deny_reset} = 1; # loading can take a long time
1869
1870 my $path = $self->{path};
1871
939 } 1872 {
1873 my $guard = cf::lock_acquire "map_load:$path";
940 1874
941 if (my $cb = $pkg->can ("unload")) { 1875 return if $self->in_memory != cf::MAP_SWAPPED;
942 eval { 1876
943 $cb->($pkg); 1877 $self->in_memory (cf::MAP_LOADING);
1878
1879 $self->alloc;
1880
1881 $self->pre_load;
1882 Coro::cede;
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);
944 1 1895 }
945 } or warn "$pkg unloaded, but with errors: $@"; 1896 }
946 }
947 1897
948 Symbol::delete_package $pkg; 1898 Coro::cede;
949} 1899 # now do the right thing for maps
1900 $self->link_multipart_objects;
1901 $self->difficulty ($self->estimate_difficulty)
1902 unless $self->difficulty;
1903 Coro::cede;
950 1904
951sub load_extensions { 1905 unless ($self->{deny_activate}) {
952 for my $ext (<$LIBDIR/*.ext>) { 1906 $self->decay_objects;
953 next unless -r $ext; 1907 $self->fix_auto_apply;
954 eval { 1908 $self->update_buttons;
955 load_extension $ext; 1909 Coro::cede;
956 1 1910 $self->set_darkness_map;
957 } or warn "$ext not loaded: $@"; 1911 Coro::cede;
958 } 1912 $self->activate;
959} 1913 }
960 1914
961############################################################################# 1915 $self->in_memory (cf::MAP_IN_MEMORY);
962# load/save/clean perl data associated with a map 1916 }
963 1917
964*cf::mapsupport::on_clean = sub { 1918 $self->post_load;
1919}
1920
1921sub customise_for {
1922 my ($self, $ob) = @_;
1923
1924 return find "~" . $ob->name . "/" . $self->{path}
1925 if $self->per_player;
1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1929
1930 $self
1931}
1932
1933# find and load all maps in the 3x3 area around a map
1934sub load_diag {
965 my ($map) = @_; 1935 my ($map) = @_;
966 1936
967 my $path = $map->tmpname; 1937 my @diag; # diagonal neighbours
968 defined $path or return;
969 1938
970 unlink "$path.pst"; 1939 for (0 .. 3) {
971}; 1940 my $neigh = $map->tile_path ($_)
1941 or next;
1942 $neigh = find $neigh, $map
1943 or next;
1944 $neigh->load;
972 1945
973cf::map->attach (prio => -10000, package => cf::mapsupport::); 1946 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1947 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1948 }
974 1949
975############################################################################# 1950 for (@diag) {
976# load/save perl data associated with player->ob objects 1951 my $neigh = find @$_
977 1952 or next;
978sub all_objects(@) { 1953 $neigh->load;
979 @_, map all_objects ($_->inv), @_ 1954 }
980} 1955}
981 1956
982# TODO: compatibility cruft, remove when no longer needed 1957sub find_sync {
983cf::player->attach ( 1958 my ($path, $origin) = @_;
984 on_load => sub {
985 my ($pl, $path) = @_;
986 1959
987 for my $o (all_objects $pl->ob) { 1960 cf::sync_job { find $path, $origin }
988 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1961}
989 $o->set_ob_key_value ("_perl_data");
990 1962
991 %$o = %{ Storable::thaw pack "H*", $value }; 1963sub do_load_sync {
1964 my ($map) = @_;
1965
1966 cf::sync_job { $map->load };
1967}
1968
1969our %MAP_PREFETCH;
1970our $MAP_PREFETCHER = undef;
1971
1972sub find_async {
1973 my ($path, $origin) = @_;
1974
1975 $path = normalise $path, $origin && $origin->{path};
1976
1977 if (my $map = $cf::MAP{$path}) {
1978 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1979 }
1980
1981 undef $MAP_PREFETCH{$path};
1982 $MAP_PREFETCHER ||= cf::async {
1983 while (%MAP_PREFETCH) {
1984 for my $path (keys %MAP_PREFETCH) {
1985 if (my $map = find $path) {
1986 $map->load;
1987 }
1988
1989 delete $MAP_PREFETCH{$path};
992 } 1990 }
993 } 1991 }
1992 undef $MAP_PREFETCHER;
1993 };
1994 $MAP_PREFETCHER->prio (6);
1995
1996 ()
1997}
1998
1999sub save {
2000 my ($self) = @_;
2001
2002 my $lock = cf::lock_acquire "map_data:" . $self->path;
2003
2004 $self->{last_save} = $cf::RUNTIME;
2005
2006 return unless $self->dirty;
2007
2008 my $save = $self->save_path; utf8::encode $save;
2009 my $uniq = $self->uniq_path; utf8::encode $uniq;
2010
2011 $self->{load_path} = $save;
2012
2013 return if $self->{deny_save};
2014
2015 local $self->{last_access} = $self->last_access;#d#
2016
2017 cf::async {
2018 $_->contr->save for $self->players;
2019 };
2020
2021 if ($uniq) {
2022 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2023 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2024 } else {
2025 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
994 }, 2026 }
995); 2027}
996 2028
997############################################################################# 2029sub swap_out {
2030 my ($self) = @_;
998 2031
999=head2 CORE EXTENSIONS 2032 # save first because save cedes
2033 $self->save;
1000 2034
1001Functions and methods that extend core crossfire objects. 2035 my $lock = cf::lock_acquire "map_data:" . $self->path;
1002 2036
1003=head3 cf::player 2037 return if $self->players;
2038 return if $self->in_memory != cf::MAP_IN_MEMORY;
2039 return if $self->{deny_save};
2040
2041 $self->clear;
2042 $self->in_memory (cf::MAP_SWAPPED);
2043}
2044
2045sub reset_at {
2046 my ($self) = @_;
2047
2048 # TODO: safety, remove and allow resettable per-player maps
2049 return 1e99 if $self->{deny_reset};
2050
2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2053
2054 $time + $to
2055}
2056
2057sub should_reset {
2058 my ($self) = @_;
2059
2060 $self->reset_at <= $cf::RUNTIME
2061}
2062
2063sub reset {
2064 my ($self) = @_;
2065
2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
2067
2068 return if $self->players;
2069
2070 warn "resetting map ", $self->path;
2071
2072 $self->in_memory (cf::MAP_SWAPPED);
2073
2074 # need to save uniques path
2075 unless ($self->{deny_save}) {
2076 my $uniq = $self->uniq_path; utf8::encode $uniq;
2077
2078 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2079 if $uniq;
2080 }
2081
2082 delete $cf::MAP{$self->path};
2083
2084 $self->clear;
2085
2086 $_->clear_links_to ($self) for values %cf::MAP;
2087
2088 $self->unlink_save;
2089 $self->destroy;
2090}
2091
2092my $nuke_counter = "aaaa";
2093
2094sub nuke {
2095 my ($self) = @_;
2096
2097 delete $cf::MAP{$self->path};
2098
2099 $self->unlink_save;
2100
2101 bless $self, "cf::map";
2102 delete $self->{deny_reset};
2103 $self->{deny_save} = 1;
2104 $self->reset_timeout (1);
2105 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2106
2107 $cf::MAP{$self->path} = $self;
2108
2109 $self->reset; # polite request, might not happen
2110}
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
2148=item cf::map::unique_maps
2149
2150Returns an arrayref of paths of all shared maps that have
2151instantiated unique items. May block.
2152
2153=cut
2154
2155sub unique_maps() {
2156 [
2157 map {
2158 utf8::decode $_;
2159 /\.map$/
2160 ? normalise $_
2161 : ()
2162 } @{ aio_readdir $UNIQUEDIR or [] }
2163 ]
2164}
2165
2166package cf;
2167
2168=back
2169
2170=head3 cf::object
2171
2172=cut
2173
2174package cf::object;
1004 2175
1005=over 4 2176=over 4
1006 2177
1007=item cf::player::exists $login 2178=item $ob->inv_recursive
1008 2179
1009Returns true when the given account exists. 2180Returns the inventory of the object _and_ their inventories, recursively.
1010 2181
1011=cut 2182=cut
1012 2183
1013sub cf::player::exists($) { 2184sub inv_recursive_;
1014 cf::player::find $_[0] 2185sub inv_recursive_ {
1015 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2186 map { $_, inv_recursive_ $_->inv } @_
1016} 2187}
1017 2188
1018=item $player->ext_reply ($msgid, $msgtype, %msg) 2189sub inv_recursive {
1019 2190 inv_recursive_ inv $_[0]
1020Sends an ext reply to the player.
1021
1022=cut
1023
1024sub cf::player::ext_reply($$$%) {
1025 my ($self, $id, %msg) = @_;
1026
1027 $msg{msgid} = $id;
1028
1029 $self->send ("ext " . to_json \%msg);
1030} 2191}
2192
2193package cf;
1031 2194
1032=back 2195=back
1033 2196
1034=head3 cf::object::player 2197=head3 cf::object::player
1035 2198
1051 2214
1052 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1053 2216
1054 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1055 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1056 } 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 {
1057 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1058 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1059 } 2236 }
1060} 2237}
1061 2238
1062=item $player_object->may ("access") 2239=item $player_object->may ("access")
1063 2240
1073 (ref $cf::CFG{"may_$access"} 2250 (ref $cf::CFG{"may_$access"}
1074 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2251 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1075 : $cf::CFG{"may_$access"}) 2252 : $cf::CFG{"may_$access"})
1076} 2253}
1077 2254
2255=item $player_object->enter_link
2256
2257Freezes the player and moves him/her to a special map (C<{link}>).
2258
2259The player should be reasonably safe there for short amounts of time. You
2260I<MUST> call C<leave_link> as soon as possible, though.
2261
2262Will never block.
2263
2264=item $player_object->leave_link ($map, $x, $y)
2265
2266Moves the player out of the special C<{link}> map onto the specified
2267map. If the map is not valid (or omitted), the player will be moved back
2268to the location he/she was before the call to C<enter_link>, or, if that
2269fails, to the emergency map position.
2270
2271Might block.
2272
2273=cut
2274
2275sub link_map {
2276 unless ($LINK_MAP) {
2277 $LINK_MAP = cf::map::find "{link}"
2278 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2279 $LINK_MAP->load;
2280 }
2281
2282 $LINK_MAP
2283}
2284
2285sub cf::object::player::enter_link {
2286 my ($self) = @_;
2287
2288 $self->deactivate_recursive;
2289
2290 return if UNIVERSAL::isa $self->map, "ext::map_link";
2291
2292 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2293 if $self->map && $self->map->{path} ne "{link}";
2294
2295 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2296}
2297
2298sub cf::object::player::leave_link {
2299 my ($self, $map, $x, $y) = @_;
2300
2301 return unless $self->contr->active;
2302
2303 my $link_pos = delete $self->{_link_pos};
2304
2305 unless ($map) {
2306 # restore original map position
2307 ($map, $x, $y) = @{ $link_pos || [] };
2308 $map = cf::map::find $map;
2309
2310 unless ($map) {
2311 ($map, $x, $y) = @$EMERGENCY_POSITION;
2312 $map = cf::map::find $map
2313 or die "FATAL: cannot load emergency map\n";
2314 }
2315 }
2316
2317 ($x, $y) = (-1, -1)
2318 unless (defined $x) && (defined $y);
2319
2320 # use -1 or undef as default coordinates, not 0, 0
2321 ($x, $y) = ($map->enter_x, $map->enter_y)
2322 if $x <=0 && $y <= 0;
2323
2324 $map->load;
2325 $map->load_diag;
2326
2327 return unless $self->contr->active;
2328 $self->activate_recursive;
2329
2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2331 $self->enter_map ($map, $x, $y);
2332}
2333
2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2335
2336Moves the player to the given map-path and coordinates by first freezing
2337her, loading and preparing them map, calling the provided $check callback
2338that has to return the map if sucecssful, and then unfreezes the player on
2339the new (success) or old (failed) map position. In either case, $done will
2340be called at the end of this process.
2341
2342=cut
2343
2344our $GOTOGEN;
2345
2346sub cf::object::player::goto {
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;
2351
2352 $self->enter_link;
2353
2354 (async {
2355 my $map = eval {
2356 my $map = cf::map::find $path;
2357
2358 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
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 $@;
2371 }
2372
2373 if ($gen == $self->{_goto_generation}) {
2374 delete $self->{_goto_generation};
2375 $self->leave_link ($map, $x, $y);
2376 }
2377
2378 $done->() if $done;
2379 })->prio (1);
2380}
2381
2382=item $player_object->enter_exit ($exit_object)
2383
2384=cut
2385
2386sub parse_random_map_params {
2387 my ($spec) = @_;
2388
2389 my $rmp = { # defaults
2390 xsize => (cf::rndm 15, 40),
2391 ysize => (cf::rndm 15, 40),
2392 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2393 #layout => string,
2394 };
2395
2396 for (split /\n/, $spec) {
2397 my ($k, $v) = split /\s+/, $_, 2;
2398
2399 $rmp->{lc $k} = $v if (length $k) && (length $v);
2400 }
2401
2402 $rmp
2403}
2404
2405sub prepare_random_map {
2406 my ($exit) = @_;
2407
2408 my $guard = cf::lock_acquire "exit_prepare:$exit";
2409
2410 # all this does is basically replace the /! path by
2411 # a new random map path (?random/...) with a seed
2412 # that depends on the exit object
2413
2414 my $rmp = parse_random_map_params $exit->msg;
2415
2416 if ($exit->map) {
2417 $rmp->{region} = $exit->region->name;
2418 $rmp->{origin_map} = $exit->map->path;
2419 $rmp->{origin_x} = $exit->x;
2420 $rmp->{origin_y} = $exit->y;
2421 }
2422
2423 $rmp->{random_seed} ||= $exit->random_seed;
2424
2425 my $data = cf::to_json $rmp;
2426 my $md5 = Digest::MD5::md5_hex $data;
2427 my $meta = "$RANDOMDIR/$md5.meta";
2428
2429 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2430 aio_write $fh, 0, (length $data), $data, 0;
2431 undef $fh;
2432 aio_rename "$meta~", $meta;
2433
2434 $exit->slaying ("?random/$md5");
2435 $exit->msg (undef);
2436 }
2437}
2438
2439sub cf::object::player::enter_exit {
2440 my ($self, $exit) = @_;
2441
2442 return unless $self->type == cf::PLAYER;
2443
2444 if ($exit->slaying eq "/!") {
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
2448 cf::sync_job { prepare_random_map $exit };
2449 }
2450
2451 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2452 my $hp = $exit->stats->hp;
2453 my $sp = $exit->stats->sp;
2454
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);
2460
2461 (async {
2462 $self->deactivate_recursive; # just to be sure
2463 unless (eval {
2464 $self->goto ($slaying, $hp, $sp);
2465
2466 1;
2467 }) {
2468 $self->message ("Something went wrong deep within the crossfire server. "
2469 . "I'll try to bring you back to the map you were before. "
2470 . "Please report this to the dungeon master!",
2471 cf::NDI_UNIQUE | cf::NDI_RED);
2472
2473 warn "ERROR in enter_exit: $@";
2474 $self->leave_link;
2475 }
2476 })->prio (1);
2477}
2478
1078=head3 cf::client 2479=head3 cf::client
1079 2480
1080=over 4 2481=over 4
1081 2482
1082=item $client->send_drawinfo ($text, $flags) 2483=item $client->send_drawinfo ($text, $flags)
1088 2489
1089sub cf::client::send_drawinfo { 2490sub cf::client::send_drawinfo {
1090 my ($self, $text, $flags) = @_; 2491 my ($self, $text, $flags) = @_;
1091 2492
1092 utf8::encode $text; 2493 utf8::encode $text;
1093 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1094} 2495}
1095 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}
1096 2563
1097=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
1098 2565
1099Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
1100the 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>,
1101C<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>.
1102 2569
1103Queries 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
1104reliable at some point in the future. 2571become reliable at some point in the future.
1105 2572
1106=cut 2573=cut
1107 2574
1108sub cf::client::query { 2575sub cf::client::query {
1109 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
1117 utf8::encode $text; 2584 utf8::encode $text;
1118 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1119 2586
1120 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
1121 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
1122} 2591}
1123 2592
1124cf::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 },
1125 on_reply => sub { 2599 on_reply => sub {
1126 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
1127 2601
1128 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
1129 # get handled first 2603 # get handled first
1130 my $queue = delete $ns->{query_queue}; 2604 my $queue = delete $ns->{query_queue}
2605 or return; # be conservative, not sure how that can happen, but we saw a crash here
1131 2606
1132 (shift @$queue)->[1]->($msg); 2607 (shift @$queue)->[1]->($msg);
2608 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1133 2609
1134 push @{ $ns->{query_queue} }, @$queue; 2610 push @{ $ns->{query_queue} }, @$queue;
1135 2611
1136 if (@{ $ns->{query_queue} } == @$queue) { 2612 if (@{ $ns->{query_queue} } == @$queue) {
1137 if (@$queue) { 2613 if (@$queue) {
1139 } else { 2615 } else {
1140 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1141 } 2617 }
1142 } 2618 }
1143 }, 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 },
1144); 2638);
1145 2639
1146=item $client->coro (\&cb) 2640=item $client->async (\&cb)
1147 2641
1148Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
1149be automatically cancelled when the client gets destroyed (e.g. on logout, 2643be automatically cancelled when the client gets destroyed (e.g. on logout,
1150or loss of connection). 2644or loss of connection).
1151 2645
1152=cut 2646=cut
1153 2647
1154sub cf::client::coro { 2648sub cf::client::async {
1155 my ($self, $cb) = @_; 2649 my ($self, $cb) = @_;
1156 2650
1157 my $coro; $coro = async { 2651 my $coro = &Coro::async ($cb);
1158 eval {
1159 $cb->();
1160 };
1161 warn $@ if $@;
1162 };
1163 2652
1164 $coro->on_destroy (sub { 2653 $coro->on_destroy (sub {
1165 delete $self->{_coro}{$coro+0}; 2654 delete $self->{_coro}{$coro+0};
1166 }); 2655 });
1167 2656
1200 2689
1201# here we export the classes and methods available to script code 2690# here we export the classes and methods available to script code
1202 2691
1203=pod 2692=pod
1204 2693
1205The following fucntions and emthods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
1206 2695
1207 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
1208 cf::object::player player 2700 cf::object::player
1209 cf::player peaceful 2701 player
1210 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
1211 2708
1212=cut 2709=cut
1213 2710
1214for ( 2711for (
1215 ["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)],
1216 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
1217 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
1218 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
1219) { 2717) {
1220 no strict 'refs'; 2718 no strict 'refs';
1291=back 2789=back
1292 2790
1293=cut 2791=cut
1294 2792
1295############################################################################# 2793#############################################################################
2794# the server's init and main functions
1296 2795
1297=head2 EXTENSION DATABASE SUPPORT 2796sub load_facedata($) {
2797 my ($path) = @_;
1298 2798
1299Crossfire maintains a very simple database for extension use. It can 2799 warn "loading facedata from $path\n";
1300currently store anything that can be serialised using Storable, which
1301excludes objects.
1302 2800
1303The parameter C<$family> should best start with the name of the extension 2801 my $facedata;
1304using it, it should be unique. 2802 0 < aio_load $path, $facedata
2803 or die "$path: $!";
1305 2804
1306=over 4 2805 $facedata = Coro::Storable::thaw $facedata;
1307 2806
1308=item $hashref = cf::db_get $family 2807 $facedata->{version} == 2
2808 or cf::cleanup "$path: version mismatch, cannot proceed.";
1309 2809
1310Return a hashref for use by the extension C<$family>, which can be
1311modified. After modifications, you have to call C<cf::db_dirty> or
1312C<cf::db_sync>.
1313
1314=item $value = cf::db_get $family => $key
1315
1316Returns a single value from the database
1317
1318=item cf::db_put $family => $hashref
1319
1320Stores the given family hashref into the database. Updates are delayed, if
1321you want the data to be synced to disk immediately, use C<cf::db_sync>.
1322
1323=item cf::db_put $family => $key => $value
1324
1325Stores the given C<$value> in the family hash. Updates are delayed, if you
1326want the data to be synced to disk immediately, use C<cf::db_sync>.
1327
1328=item cf::db_dirty
1329
1330Marks the database as dirty, to be updated at a later time.
1331
1332=item cf::db_sync
1333
1334Immediately write the database to disk I<if it is dirty>.
1335
1336=cut
1337
1338our $DB;
1339
1340{
1341 my $path = cf::localdir . "/database.pst";
1342
1343 sub db_load() {
1344 warn "loading database $path\n";#d# remove later
1345 $DB = stat $path ? Storable::retrieve $path : { };
1346 } 2810 {
2811 my $faces = $facedata->{faceinfo};
1347 2812
1348 my $pid; 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};
1349 2819
1350 sub db_save() { 2820 cf::cede_to_tick;
1351 warn "saving database $path\n";#d# remove later
1352 waitpid $pid, 0 if $pid;
1353 if (0 == ($pid = fork)) {
1354 $DB->{_meta}{version} = 1;
1355 Storable::nstore $DB, "$path~";
1356 rename "$path~", $path;
1357 cf::_exit 0 if defined $pid;
1358 }
1359 }
1360
1361 my $dirty;
1362
1363 sub db_sync() {
1364 db_save if $dirty;
1365 undef $dirty;
1366 }
1367
1368 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1369 db_sync;
1370 });
1371
1372 sub db_dirty() {
1373 $dirty = 1;
1374 $idle->start;
1375 }
1376
1377 sub db_get($;$) {
1378 @_ >= 2
1379 ? $DB->{$_[0]}{$_[1]}
1380 : ($DB->{$_[0]} ||= { })
1381 }
1382
1383 sub db_put($$;$) {
1384 if (@_ >= 3) {
1385 $DB->{$_[0]}{$_[1]} = $_[2];
1386 } else {
1387 $DB->{$_[0]} = $_[1];
1388 }
1389 db_dirty;
1390 }
1391
1392 cf::global->attach (
1393 prio => 10000,
1394 on_cleanup => sub {
1395 db_sync;
1396 }, 2821 }
1397 );
1398}
1399 2822
1400############################################################################# 2823 while (my ($face, $info) = each %$faces) {
1401# the server's main() 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"
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;
2926}
1402 2927
1403sub cfg_load { 2928sub cfg_load {
1404 open my $fh, "<:utf8", cf::confdir . "/config" 2929 open my $fh, "<:utf8", "$CONFDIR/config"
1405 or return; 2930 or return;
1406 2931
1407 local $/; 2932 local $/;
1408 *CFG = YAML::Syck::Load <$fh>; 2933 *CFG = YAML::Syck::Load <$fh>;
2934
2935 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2936
2937 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2938 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2939
2940 if (exists $CFG{mlockall}) {
2941 eval {
2942 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2943 and die "WARNING: m(un)lockall failed: $!\n";
2944 };
2945 warn $@ if $@;
2946 }
1409} 2947}
1410 2948
1411sub main { 2949sub main {
1412 # we must not ever block the main coroutine 2950 # we must not ever block the main coroutine
1413 local $Coro::idle = sub { 2951 local $Coro::idle = sub {
1414 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2952 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1415 (Coro::unblock_sub { 2953 (async {
1416 Event::one_event; 2954 Event::one_event;
1417 })->(); 2955 })->prio (Coro::PRIO_MAX);
1418 }; 2956 };
1419 2957
1420 cfg_load; 2958 cfg_load;
1421 db_load; 2959 db_init;
1422 load_extensions; 2960 load_extensions;
2961
2962 $TICK_WATCHER->start;
1423 Event::loop; 2963 Event::loop;
1424} 2964}
1425 2965
1426############################################################################# 2966#############################################################################
1427# initialisation 2967# initialisation and cleanup
1428 2968
1429sub perl_reload() { 2969# install some emergency cleanup handlers
2970BEGIN {
2971 for my $signal (qw(INT HUP TERM)) {
2972 Event->signal (
2973 reentrant => 0,
2974 data => WF_AUTOCANCEL,
2975 signal => $signal,
2976 prio => 0,
2977 cb => sub {
2978 cf::cleanup "SIG$signal";
2979 },
2980 );
2981 }
2982}
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
3022sub emergency_save() {
3023 my $freeze_guard = cf::freeze_mainloop;
3024
3025 warn "enter emergency perl save\n";
3026
3027 cf::sync_job {
3028 # use a peculiar iteration method to avoid tripping on perl
3029 # refcount bugs in for. also avoids problems with players
3030 # and maps saved/destroyed asynchronously.
3031 warn "begin emergency player save\n";
3032 for my $login (keys %cf::PLAYER) {
3033 my $pl = $cf::PLAYER{$login} or next;
3034 $pl->valid or next;
3035 $pl->save;
3036 }
3037 warn "end emergency player save\n";
3038
3039 warn "begin emergency map save\n";
3040 for my $path (keys %cf::MAP) {
3041 my $map = $cf::MAP{$path} or next;
3042 $map->valid or next;
3043 $map->save;
3044 }
3045 warn "end emergency map save\n";
3046
3047 warn "begin emergency database checkpoint\n";
3048 BDB::db_env_txn_checkpoint $DB_ENV;
3049 warn "end emergency database checkpoint\n";
3050 };
3051
3052 warn "leave emergency perl save\n";
3053}
3054
3055sub post_cleanup {
3056 my ($make_core) = @_;
3057
3058 warn Carp::longmess "post_cleanup backtrace"
3059 if $make_core;
3060}
3061
3062sub do_reload_perl() {
1430 # can/must only be called in main 3063 # can/must only be called in main
1431 if ($Coro::current != $Coro::main) { 3064 if ($Coro::current != $Coro::main) {
1432 warn "can only reload from main coroutine\n"; 3065 warn "can only reload from main coroutine";
1433 return; 3066 return;
1434 } 3067 }
1435 3068
1436 warn "reloading..."; 3069 warn "reloading...";
1437 3070
1438 local $FREEZE = 1; 3071 warn "entering sync_job";
3072
3073 cf::sync_job {
3074 cf::write_runtime; # external watchdog should not bark
1439 cf::emergency_save; 3075 cf::emergency_save;
3076 cf::write_runtime; # external watchdog should not bark
1440 3077
1441 eval { 3078 warn "syncing database to disk";
3079 BDB::db_env_txn_checkpoint $DB_ENV;
3080
1442 # if anything goes wrong in here, we should simply crash as we already saved 3081 # if anything goes wrong in here, we should simply crash as we already saved
1443 3082
1444 # cancel all watchers 3083 warn "cancelling all WF_AUTOCANCEL watchers";
1445 for (Event::all_watchers) { 3084 for (Event::all_watchers) {
1446 $_->cancel if $_->data & WF_AUTOCANCEL; 3085 $_->cancel if $_->data & WF_AUTOCANCEL;
1447 } 3086 }
1448 3087
3088 warn "flushing outstanding aio requests";
3089 for (;;) {
3090 BDB::flush;
3091 IO::AIO::flush;
3092 Coro::cede;
3093 last unless IO::AIO::nreqs || BDB::nreqs;
3094 warn "iterate...";
3095 }
3096
3097 ++$RELOAD;
3098
1449 # cancel all extension coros 3099 warn "cancelling all extension coros";
1450 $_->cancel for values %EXT_CORO; 3100 $_->cancel for values %EXT_CORO;
1451 %EXT_CORO = (); 3101 %EXT_CORO = ();
1452 3102
1453 # unload all extensions 3103 warn "removing commands";
1454 for (@exts) { 3104 %COMMAND = ();
3105
3106 warn "removing ext/exti commands";
3107 %EXTCMD = ();
3108 %EXTICMD = ();
3109
3110 warn "unloading/nuking all extensions";
3111 for my $pkg (@EXTS) {
1455 warn "unloading <$_>"; 3112 warn "... unloading $pkg";
1456 unload_extension $_; 3113
3114 if (my $cb = $pkg->can ("unload")) {
3115 eval {
3116 $cb->($pkg);
3117 1
3118 } or warn "$pkg unloaded, but with errors: $@";
1457 } 3119 }
1458 3120
3121 warn "... nuking $pkg";
3122 Symbol::delete_package $pkg;
3123 }
3124
1459 # unload all modules loaded from $LIBDIR 3125 warn "unloading all perl modules loaded from $LIBDIR";
1460 while (my ($k, $v) = each %INC) { 3126 while (my ($k, $v) = each %INC) {
1461 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3127 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1462 3128
1463 warn "removing <$k>"; 3129 warn "... unloading $k";
1464 delete $INC{$k}; 3130 delete $INC{$k};
1465 3131
1466 $k =~ s/\.pm$//; 3132 $k =~ s/\.pm$//;
1467 $k =~ s/\//::/g; 3133 $k =~ s/\//::/g;
1468 3134
1471 } 3137 }
1472 3138
1473 Symbol::delete_package $k; 3139 Symbol::delete_package $k;
1474 } 3140 }
1475 3141
1476 # sync database to disk
1477 cf::db_sync;
1478 IO::AIO::flush;
1479
1480 # get rid of safe::, as good as possible 3142 warn "getting rid of safe::, as good as possible";
1481 Symbol::delete_package "safe::$_" 3143 Symbol::delete_package "safe::$_"
1482 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);
1483 3145
1484 # remove register_script_function callbacks
1485 # TODO
1486
1487 # unload cf.pm "a bit" 3146 warn "unloading cf.pm \"a bit\"";
1488 delete $INC{"cf.pm"}; 3147 delete $INC{"cf.pm"};
3148 delete $INC{"cf/pod.pm"};
1489 3149
1490 # don't, removes xs symbols, too, 3150 # don't, removes xs symbols, too,
1491 # and global variables created in xs 3151 # and global variables created in xs
1492 #Symbol::delete_package __PACKAGE__; 3152 #Symbol::delete_package __PACKAGE__;
1493 3153
1494 # reload cf.pm 3154 warn "unload completed, starting to reload now";
3155
1495 warn "reloading cf.pm"; 3156 warn "reloading cf.pm";
1496 require cf; 3157 require cf;
1497 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3158 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1498 3159
1499 # load config and database again 3160 warn "loading config and database again";
1500 cf::cfg_load; 3161 cf::cfg_load;
1501 cf::db_load;
1502 3162
1503 # load extensions
1504 warn "load extensions"; 3163 warn "loading extensions";
1505 cf::load_extensions; 3164 cf::load_extensions;
1506 3165
1507 # reattach attachments to objects 3166 warn "reattaching attachments to objects/players";
1508 warn "reattach"; 3167 _global_reattach; # objects, sockets
1509 _global_reattach; 3168 warn "reattaching attachments to maps";
1510 }; 3169 reattach $_ for values %MAP;
3170 warn "reattaching attachments to players";
3171 reattach $_ for values %PLAYER;
1511 3172
1512 if ($@) { 3173 warn "leaving sync_job";
3174
3175 1
3176 } or do {
1513 warn $@; 3177 warn $@;
1514 warn "error while reloading, exiting."; 3178 warn "error while reloading, exiting.";
1515 exit 1; 3179 exit 1;
1516 } 3180 };
1517 3181
1518 warn "reloaded successfully"; 3182 warn "reloaded";
1519}; 3183};
1520 3184
1521############################################################################# 3185our $RELOAD_WATCHER; # used only during reload
1522 3186
1523unless ($LINK_MAP) { 3187sub reload_perl() {
1524 $LINK_MAP = cf::map::new; 3188 # doing reload synchronously and two reloads happen back-to-back,
3189 # coro crashes during coro_state_free->destroy here.
1525 3190
1526 $LINK_MAP->width (41); 3191 $RELOAD_WATCHER ||= Event->timer (
1527 $LINK_MAP->height (41); 3192 reentrant => 0,
1528 $LINK_MAP->alloc; 3193 after => 0,
1529 $LINK_MAP->path ("{link}"); 3194 data => WF_AUTOCANCEL,
1530 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path"; 3195 cb => sub {
1531 $LINK_MAP->in_memory (MAP_IN_MEMORY); 3196 do_reload_perl;
3197 undef $RELOAD_WATCHER;
3198 },
3199 );
1532} 3200}
1533 3201
1534register "<global>", __PACKAGE__;
1535
1536register_command "perl-reload" => sub { 3202register_command "reload" => sub {
1537 my ($who, $arg) = @_; 3203 my ($who, $arg) = @_;
1538 3204
1539 if ($who->flag (FLAG_WIZ)) { 3205 if ($who->flag (FLAG_WIZ)) {
1540 $who->message ("start of reload.");
1541 perl_reload;
1542 $who->message ("end of reload."); 3206 $who->message ("reloading server.");
3207 async { reload_perl };
1543 } 3208 }
1544}; 3209};
1545 3210
1546unshift @INC, $LIBDIR; 3211unshift @INC, $LIBDIR;
1547 3212
3213my $bug_warning = 0;
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;
1548$TICK_WATCHER = Event->timer ( 3238$TICK_WATCHER = Event->timer (
1549 reentrant => 0, 3239 reentrant => 0,
3240 parked => 1,
1550 prio => 0, 3241 prio => 0,
1551 at => $NEXT_TICK || $TICK, 3242 at => $NEXT_TICK || $TICK,
1552 data => WF_AUTOCANCEL, 3243 data => WF_AUTOCANCEL,
1553 cb => sub { 3244 cb => sub {
1554 unless ($FREEZE) { 3245 if ($Coro::current != $Coro::main) {
3246 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3247 unless ++$bug_warning > 10;
3248 return;
3249 }
3250
3251 $NOW = $tick_start = Event::time;
3252
1555 cf::server_tick; # one server iteration 3253 cf::server_tick; # one server iteration
1556 $RUNTIME += $TICK; 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
1557 } 3276 };
1558 3277
3278 $RUNTIME += $TICK;
1559 $NEXT_TICK += $TICK; 3279 $NEXT_TICK += $TICK;
1560 3280
3281 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3282 $NEXT_RUNTIME_WRITE = $NOW + 10;
3283 Coro::async_pool {
3284 write_runtime
3285 or warn "ERROR: unable to write runtime file: $!";
3286 };
3287 }
3288
3289# my $AFTER = Event::time;
3290# warn $AFTER - $NOW;#d#
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
1561 # 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
1562 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3302 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1563 3303
1564 $TICK_WATCHER->at ($NEXT_TICK); 3304 $TICK_WATCHER->at ($NEXT_TICK);
1565 $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
1566 }, 3313 },
1567); 3314);
1568 3315
3316{
1569IO::AIO::max_poll_time $TICK * 0.2; 3317 BDB::max_poll_time $TICK * 0.1;
1570 3318 $BDB_POLL_WATCHER = Event->io (
1571Event->io ( 3319 reentrant => 0,
1572 fd => IO::AIO::poll_fileno, 3320 fd => BDB::poll_fileno,
1573 poll => 'r', 3321 poll => 'r',
1574 prio => 5, 3322 prio => 0,
1575 data => WF_AUTOCANCEL,
1576 cb => \&IO::AIO::poll_cb,
1577);
1578
1579Event->timer (
1580 data => WF_AUTOCANCEL, 3323 data => WF_AUTOCANCEL,
1581 after => 0, 3324 cb => \&BDB::poll_cb,
1582 interval => 10, 3325 );
1583 cb => sub { 3326 BDB::min_parallel 8;
1584 (Coro::unblock_sub { 3327
1585 write_runtime 3328 BDB::set_sync_prepare {
1586 or warn "ERROR: unable to write runtime file: $!"; 3329 my $status;
3330 my $current = $Coro::current;
3331 (
3332 sub {
3333 $status = $!;
3334 $current->ready; undef $current;
3335 },
3336 sub {
3337 Coro::schedule while defined $current;
3338 $! = $status;
3339 },
3340 )
3341 };
3342
3343 unless ($DB_ENV) {
3344 $DB_ENV = BDB::db_env_create;
3345
3346 cf::sync_job {
3347 eval {
3348 BDB::db_env_open
3349 $DB_ENV,
3350 $BDBDIR,
3351 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3352 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3353 0666;
3354
3355 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3356
3357 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3358 $DB_ENV->set_lk_detect;
3359 };
3360
3361 cf::cleanup "db_env_open(db): $@" if $@;
1587 })->(); 3362 };
1588 }, 3363 }
1589); 3364}
3365
3366{
3367 IO::AIO::min_parallel 8;
3368
3369 undef $Coro::AIO::WATCHER;
3370 IO::AIO::max_poll_time $TICK * 0.1;
3371 $AIO_POLL_WATCHER = Event->io (
3372 reentrant => 0,
3373 data => WF_AUTOCANCEL,
3374 fd => IO::AIO::poll_fileno,
3375 poll => 'r',
3376 prio => 6,
3377 cb => \&IO::AIO::poll_cb,
3378 );
3379}
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
3422END { cf::emergency_save }
1590 3423
15911 34241
1592 3425

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines