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.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.319 by root, Tue Jul 24 15:56:45 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 $self->{random} = cf::from_json $path;
287 } else {
288 if ($path =~ s{^~([^/]+)?}{}) {
289 $self->{user_rel} = 1;
290
291 if (defined $1) {
292 $self->{user} = $1;
293 } elsif ($base =~ m{^~([^/]+)/}) {
294 $self->{user} = $1;
295 } else {
296 warn "cannot resolve user-relative path without user <$path,$base>\n";
297 }
298 } elsif ($path =~ /^\//) {
299 # already absolute
300 } else {
301 $base =~ s{[^/]+/?$}{};
302 return $class->new ("$base/$path");
303 }
304
305 for ($path) {
306 redo if s{/\.?/}{/};
307 redo if s{/[^/]+/\.\./}{/};
308 }
309 }
310
311 $self->{path} = $path;
312
313 $self
314}
315
316# the name / primary key / in-game path
317sub as_string {
318 my ($self) = @_;
319
320 $self->{user_rel} ? "~$self->{user}$self->{path}"
321 : $self->{random} ? "?random/$self->{path}"
322 : $self->{path}
323}
324
325# the displayed name, this is a one way mapping
326sub visible_name {
327 my ($self) = @_;
328
329 $self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
330 : $self->as_string
331}
332
333# escape the /'s in the path
334sub _escaped_path {
335 # ∕ is U+2215
336 (my $path = $_[0]{path}) =~ s/\//∕/g;
337 $path
338}
339
340# the original (read-only) location
341sub load_path {
342 my ($self) = @_;
343
344 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
345}
346
347# the temporary/swap location
348sub save_path {
349 my ($self) = @_;
350
351 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
352 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
353 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
354}
355
356# the unique path, might be eq to save_path
357sub uniq_path {
358 my ($self) = @_;
359
360 $self->{user_rel} || $self->{random}
361 ? undef
362 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
363}
364
365# return random map parameters, or undef
366sub random_map_params {
367 my ($self) = @_;
368
369 $self->{random}
370}
371
372# this is somewhat ugly, but style maps do need special treatment
373sub is_style_map {
374 $_[0]{path} =~ m{^/styles/}
375}
376
377package cf;
378 660
379############################################################################# 661#############################################################################
380 662
381=head2 ATTACHABLE OBJECTS 663=head2 ATTACHABLE OBJECTS
382 664
384attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
385to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
386 668
387In 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>
388C<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
389crossfire+). 671Crossfire TRT).
390 672
391=over 4 673=over 4
392 674
393=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
394 676
508our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
509our @CB_MAP = (); 791our @CB_MAP = ();
510 792
511my %attachment; 793my %attachment;
512 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
513sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
514 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
515 803
516 use sort 'stable'; 804 use sort 'stable';
517 805
551 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
552 840
553 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
554 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
555 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
556 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
557 845
558 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
559 my $pkg = shift @arg; 847 my $pkg = shift @arg;
560 848
561 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
590 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
591 } 879 }
592 880
593 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
594 } else { 882 } else {
595 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
596 } 884 }
597 885
598 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
599} 887}
600 888
602 if (ref $_[0]) { 890 if (ref $_[0]) {
603 _object_attach @_; 891 _object_attach @_;
604 } else { 892 } else {
605 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
606 } 894 }
895 _recalc_want;
607}; 896};
608 897
609# all those should be optimised 898# all those should be optimised
610sub cf::attachable::detach { 899sub cf::attachable::detach {
611 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
614 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
615 reattach ($obj); 904 reattach ($obj);
616 } else { 905 } else {
617 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
618 } 907 }
908 _recalc_want;
619}; 909};
620 910
621sub cf::attachable::attached { 911sub cf::attachable::attached {
622 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
623 913
638 "; 928 ";
639 die if $@; 929 die if $@;
640} 930}
641 931
642our $override; 932our $override;
643our @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?
644 934
645sub override { 935sub override {
646 $override = 1; 936 $override = 1;
647 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
648} 938}
649 939
650sub do_invoke { 940sub do_invoke {
651 my $event = shift; 941 my $event = shift;
652 my $callbacks = shift; 942 my $callbacks = shift;
653 943
654 @invoke_results = (); 944 @INVOKE_RESULTS = ();
655 945
656 local $override; 946 local $override;
657 947
658 for (@$callbacks) { 948 for (@$callbacks) {
659 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
676 966
677Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
678 968
679This 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
680removed 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
681results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
682 972
683=back 973=back
684 974
685=cut 975=cut
686 976
687############################################################################# 977#############################################################################
688# 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}
689 990
690sub reattach { 991sub reattach {
691 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
692 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
693 996
694 my $registry = $obj->registry; 997 my $registry = $obj->registry;
695 998
696 @$registry = (); 999 @$registry = ();
697 1000
744 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
745 1048
746 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
747 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
748 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
749 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
750 close $fh; 1053 close $fh;
751 1054
752 if (@$objs) { 1055 if (@$objs) {
753 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) {
754 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
755 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
756 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
757 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
758 close $fh; 1061 close $fh;
759 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
760 } 1063 }
761 } else { 1064 } else {
762 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
790 or return; 1093 or return;
791 1094
792 unless (aio_stat "$filename.pst") { 1095 unless (aio_stat "$filename.pst") {
793 (aio_load "$filename.pst", $av) >= 0 1096 (aio_load "$filename.pst", $av) >= 0
794 or return; 1097 or return;
795 $av = eval { (Storable::thaw <$av>)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
796 } 1099 }
797 1100
1101 warn sprintf "loading %s (%d)\n",
1102 $filename, length $data, scalar @{$av || []};
798 return ($data, $av); 1103 return ($data, $av);
799} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
800 1111
801############################################################################# 1112#############################################################################
802# command handling &c 1113# command handling &c
803 1114
804=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
817 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
818} 1129}
819 1130
820=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
821 1132
822Register 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.
823 1138
824If 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
825called. 1140called.
826 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
827=cut 1153=cut
828 1154
829sub register_extcmd { 1155sub register_extcmd {
830 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
831 1157
832 my $caller = caller;
833 #warn "registering extcmd '$name' to '$caller'";
834
835 $EXTCMD{$name} = [$cb, $caller]; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
836} 1165}
837 1166
838cf::player->attach ( 1167cf::player->attach (
839 on_command => sub { 1168 on_command => sub {
840 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
849 cf::override; 1178 cf::override;
850 }, 1179 },
851 on_extcmd => sub { 1180 on_extcmd => sub {
852 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
853 1182
854 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
855 1184
856 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
857 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
858 if (my %reply = $cb->[0]->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
859 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
860 } 1195 if $reply;
861 } 1196 }
862 } else { 1197 } else {
863 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
864 } 1199 }
865 1200
866 cf::override; 1201 cf::override;
867 }, 1202 },
868); 1203);
869 1204
1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
1209 for my $path (<$LIBDIR/*.ext>) {
1210 next unless -r $path;
1211
1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
1269 }
1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
1275 };
1276}
1277
1278#############################################################################
1279
1280=back
1281
1282=head2 CORE EXTENSIONS
1283
1284Functions and methods that extend core crossfire objects.
1285
1286=cut
1287
1288package cf::player;
1289
1290use Coro::AIO;
1291
1292=head3 cf::player
1293
1294=over 4
1295
1296=item cf::player::find $login
1297
1298Returns the given player object, loading it if necessary (might block).
1299
1300=cut
1301
1302sub playerdir($) {
1303 "$PLAYERDIR/"
1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1305}
1306
1307sub path($) {
1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1309
1310 (playerdir $login) . "/playerdata"
1311}
1312
1313sub find_active($) {
1314 $cf::PLAYER{$_[0]}
1315 and $cf::PLAYER{$_[0]}->active
1316 and $cf::PLAYER{$_[0]}
1317}
1318
1319sub exists($) {
1320 my ($login) = @_;
1321
1322 $cf::PLAYER{$login}
1323 or cf::sync_job { !aio_stat path $login }
1324}
1325
1326sub find($) {
1327 return $cf::PLAYER{$_[0]} || do {
1328 my $login = $_[0];
1329
1330 my $guard = cf::lock_acquire "user_find:$login";
1331
1332 $cf::PLAYER{$_[0]} || do {
1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
1340 my $pl = load_pl path $login
1341 or return;
1342 $cf::PLAYER{$login} = $pl
1343 }
1344 }
1345}
1346
1347sub save($) {
1348 my ($pl) = @_;
1349
1350 return if $pl->{deny_save};
1351
1352 my $path = path $pl;
1353 my $guard = cf::lock_acquire "user_save:$path";
1354
1355 return if $pl->{deny_save};
1356
1357 aio_mkdir playerdir $pl, 0770;
1358 $pl->{last_save} = $cf::RUNTIME;
1359
1360 $pl->save_pl ($path);
1361 Coro::cede;
1362}
1363
1364sub new($) {
1365 my ($login) = @_;
1366
1367 my $self = create;
1368
1369 $self->ob->name ($login);
1370 $self->{deny_save} = 1;
1371
1372 $cf::PLAYER{$login} = $self;
1373
1374 $self
1375}
1376
1377=item $pl->quit_character
1378
1379Nukes the player without looking back. If logged in, the connection will
1380be destroyed. May block for a long time.
1381
1382=cut
1383
1384sub quit_character {
1385 my ($pl) = @_;
1386
1387 my $name = $pl->ob->name;
1388
1389 $pl->{deny_save} = 1;
1390 $pl->password ("*"); # this should lock out the player until we nuked the dir
1391
1392 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1393 $pl->deactivate;
1394 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1395 $pl->ns->destroy if $pl->ns;
1396
1397 my $path = playerdir $pl;
1398 my $temp = "$path~$cf::RUNTIME~deleting~";
1399 aio_rename $path, $temp;
1400 delete $cf::PLAYER{$pl->ob->name};
1401 $pl->destroy;
1402
1403 my $prefix = qr<^~\Q$name\E/>;
1404
1405 # nuke player maps
1406 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1407
1408 IO::AIO::aio_rmtree $temp;
1409}
1410
1411=item $pl->kick
1412
1413Kicks a player out of the game. This destroys the connection.
1414
1415=cut
1416
1417sub kick {
1418 my ($pl, $kicker) = @_;
1419
1420 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1421 $pl->killer ("kicked");
1422 $pl->ns->destroy;
1423}
1424
1425=item cf::player::list_logins
1426
1427Returns am arrayref of all valid playernames in the system, can take a
1428while and may block, so not sync_job-capable, ever.
1429
1430=cut
1431
1432sub list_logins {
1433 my $dirs = aio_readdir $PLAYERDIR
1434 or return [];
1435
1436 my @logins;
1437
1438 for my $login (@$dirs) {
1439 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1440 aio_read $fh, 0, 512, my $buf, 0 or next;
1441 $buf !~ /^password -------------$/m or next; # official not-valid tag
1442
1443 utf8::decode $login;
1444 push @logins, $login;
1445 }
1446
1447 \@logins
1448}
1449
1450=item $player->maps
1451
1452Returns an arrayref of map paths that are private for this
1453player. May block.
1454
1455=cut
1456
1457sub maps($) {
1458 my ($pl) = @_;
1459
1460 $pl = ref $pl ? $pl->ob->name : $pl;
1461
1462 my $files = aio_readdir playerdir $pl
1463 or return;
1464
1465 my @paths;
1466
1467 for (@$files) {
1468 utf8::decode $_;
1469 next if /\.(?:pl|pst)$/;
1470 next unless /^$PATH_SEP/o;
1471
1472 push @paths, cf::map::normalise "~$pl/$_";
1473 }
1474
1475 \@paths
1476}
1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1528=item $player->ext_reply ($msgid, @msg)
1529
1530Sends an ext reply to the player.
1531
1532=cut
1533
1534sub ext_reply($$@) {
1535 my ($self, $id, @msg) = @_;
1536
1537 if ($self->ns->extcmd == 2) {
1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1544}
1545
1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1586
1587=back
1588
1589=head3 cf::map
1590
1591=over 4
1592
1593=cut
1594
1595package cf::map;
1596
1597use Fcntl;
1598use Coro::AIO;
1599
1600use overload
1601 '""' => \&as_string,
1602 fallback => 1;
1603
1604our $MAX_RESET = 3600;
1605our $DEFAULT_RESET = 3000;
1606
1607sub generate_random_map {
1608 my ($self, $rmp) = @_;
1609 # mit "rum" bekleckern, nicht
1610 $self->_create_random_map (
1611 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1612 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1613 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1614 $rmp->{exit_on_final_map},
1615 $rmp->{xsize}, $rmp->{ysize},
1616 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1617 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1618 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1619 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1620 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1621 (cf::region::find $rmp->{region}), $rmp->{custom}
1622 )
1623}
1624
1625=item cf::map->register ($regex, $prio)
1626
1627Register a handler for the map path matching the given regex at the
1628givne priority (higher is better, built-in handlers have priority 0, the
1629default).
1630
1631=cut
1632
870sub register { 1633sub register {
1634 my (undef, $regex, $prio) = @_;
1635 my $pkg = caller;
1636
1637 no strict;
1638 push @{"$pkg\::ISA"}, __PACKAGE__;
1639
1640 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1641}
1642
1643# also paths starting with '/'
1644$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1645
1646sub thawer_merge {
871 my ($base, $pkg) = @_; 1647 my ($self, $merge) = @_;
872 1648
873 #TODO 1649 # we have to keep some variables in memory intact
874} 1650 local $self->{path};
1651 local $self->{load_path};
875 1652
876sub load_extension { 1653 $self->SUPER::thawer_merge ($merge);
1654}
1655
1656sub normalise {
877 my ($path) = @_; 1657 my ($path, $base) = @_;
878 1658
879 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1659 $path = "$path"; # make sure its a string
880 my $base = $1;
881 my $pkg = $1;
882 $pkg =~ s/[^[:word:]]/_/g;
883 $pkg = "ext::$pkg";
884 1660
885 warn "loading '$path' into '$pkg'\n"; 1661 $path =~ s/\.map$//;
886 1662
887 open my $fh, "<:utf8", $path 1663 # map plan:
888 or die "$path: $!"; 1664 #
1665 # /! non-realised random map exit (special hack!)
1666 # {... are special paths that are not being touched
1667 # ?xxx/... are special absolute paths
1668 # ?random/... random maps
1669 # /... normal maps
1670 # ~user/... per-player map of a specific user
889 1671
890 my $source = 1672 $path =~ s/$PATH_SEP/\//go;
891 "package $pkg; use strict; use utf8;\n"
892 . "#line 1 \"$path\"\n{\n"
893 . (do { local $/; <$fh> })
894 . "\n};\n1";
895 1673
896 eval $source 1674 # treat it as relative path if it starts with
897 or die $@ ? "$path: $@\n" 1675 # something that looks reasonable
898 : "extension disabled.\n"; 1676 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1677 $base or Carp::carp "normalise called with relative path and no base: '$path'";
899 1678
900 push @exts, $pkg; 1679 $base =~ s{[^/]+/?$}{};
901 $ext_pkg{$base} = $pkg; 1680 $path = "$base/$path";
902
903# no strict 'refs';
904# @{"$pkg\::ISA"} = ext::;
905
906 register $base, $pkg;
907}
908
909sub unload_extension {
910 my ($pkg) = @_;
911
912 warn "removing extension $pkg\n";
913
914 # remove hooks
915 #TODO
916# for my $idx (0 .. $#PLUGIN_EVENT) {
917# delete $hook[$idx]{$pkg};
918# } 1681 }
919 1682
920 # remove commands 1683 for ($path) {
921 for my $name (keys %COMMAND) { 1684 redo if s{//}{/};
922 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1685 redo if s{/\.?/}{/};
1686 redo if s{/[^/]+/\.\./}{/};
1687 }
923 1688
924 if (@cb) { 1689 $path
925 $COMMAND{$name} = \@cb; 1690}
1691
1692sub new_from_path {
1693 my (undef, $path, $base) = @_;
1694
1695 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1696
1697 $path = normalise $path, $base;
1698
1699 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1700 if ($path =~ $EXT_MAP{$pkg}[1]) {
1701 my $self = bless cf::map::new, $pkg;
1702 $self->{path} = $path; $self->path ($path);
1703 $self->init; # pass $1 etc.
1704 return $self;
1705 }
1706 }
1707
1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1709 ()
1710}
1711
1712sub init {
1713 my ($self) = @_;
1714
1715 $self
1716}
1717
1718sub as_string {
1719 my ($self) = @_;
1720
1721 "$self->{path}"
1722}
1723
1724# the displayed name, this is a one way mapping
1725sub visible_name {
1726 &as_string
1727}
1728
1729# the original (read-only) location
1730sub load_path {
1731 my ($self) = @_;
1732
1733 "$MAPDIR/$self->{path}.map"
1734}
1735
1736# the temporary/swap location
1737sub save_path {
1738 my ($self) = @_;
1739
1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1741 "$TMPDIR/$path.map"
1742}
1743
1744# the unique path, undef == no special unique path
1745sub uniq_path {
1746 my ($self) = @_;
1747
1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1749 "$UNIQUEDIR/$path"
1750}
1751
1752# and all this just because we cannot iterate over
1753# all maps in C++...
1754sub change_all_map_light {
1755 my ($change) = @_;
1756
1757 $_->change_map_light ($change)
1758 for grep $_->outdoor, values %cf::MAP;
1759}
1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1767}
1768
1769sub unlink_save {
1770 my ($self) = @_;
1771
1772 utf8::encode (my $save = $self->save_path);
1773 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1774 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1775}
1776
1777sub load_header_from($) {
1778 my ($self, $path) = @_;
1779
1780 utf8::encode $path;
1781 #aio_open $path, O_RDONLY, 0
1782 # or return;
1783
1784 $self->_load_header ($path)
1785 or return;
1786
1787 $self->{load_path} = $path;
1788
1789 1
1790}
1791
1792sub load_header_orig {
1793 my ($self) = @_;
1794
1795 $self->load_header_from ($self->load_path)
1796}
1797
1798sub load_header_temp {
1799 my ($self) = @_;
1800
1801 $self->load_header_from ($self->save_path)
1802}
1803
1804sub prepare_temp {
1805 my ($self) = @_;
1806
1807 $self->last_access ((delete $self->{last_access})
1808 || $cf::RUNTIME); #d#
1809 # safety
1810 $self->{instantiate_time} = $cf::RUNTIME
1811 if $self->{instantiate_time} > $cf::RUNTIME;
1812}
1813
1814sub prepare_orig {
1815 my ($self) = @_;
1816
1817 $self->{load_original} = 1;
1818 $self->{instantiate_time} = $cf::RUNTIME;
1819 $self->last_access ($cf::RUNTIME);
1820 $self->instantiate;
1821}
1822
1823sub load_header {
1824 my ($self) = @_;
1825
1826 if ($self->load_header_temp) {
1827 $self->prepare_temp;
926 } else { 1828 } else {
927 delete $COMMAND{$name}; 1829 $self->load_header_orig
928 } 1830 or return;
1831 $self->prepare_orig;
1832 }
1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1839
929 } 1840 1
1841}
930 1842
931 # remove extcmds 1843sub find;
932 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1844sub find {
933 delete $EXTCMD{$name}; 1845 my ($path, $origin) = @_;
1846
1847 $path = normalise $path, $origin && $origin->path;
1848
1849 cf::lock_wait "map_find:$path";
1850
1851 $cf::MAP{$path} || do {
1852 my $guard = cf::lock_acquire "map_find:$path";
1853 my $map = new_from_path cf::map $path
1854 or return;
1855
1856 $map->{last_save} = $cf::RUNTIME;
1857
1858 $map->load_header
1859 or return;
1860
1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1862 # doing this can freeze the server in a sync job, obviously
1863 #$cf::WAIT_FOR_TICK->wait;
1864 $map->reset;
1865 undef $guard;
1866 return find $path;
1867 }
1868
1869 $cf::MAP{$path} = $map
1870 }
1871}
1872
1873sub pre_load { }
1874sub post_load { }
1875
1876sub load {
1877 my ($self) = @_;
1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1881 my $path = $self->{path};
1882
934 } 1883 {
1884 my $guard = cf::lock_acquire "map_load:$path";
935 1885
936 if (my $cb = $pkg->can ("unload")) { 1886 return if $self->in_memory != cf::MAP_SWAPPED;
937 eval { 1887
938 $cb->($pkg); 1888 $self->in_memory (cf::MAP_LOADING);
1889
1890 $self->alloc;
1891
1892 $self->pre_load;
1893 Coro::cede;
1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
939 1 1906 }
940 } or warn "$pkg unloaded, but with errors: $@"; 1907 }
941 }
942 1908
943 Symbol::delete_package $pkg; 1909 Coro::cede;
944} 1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1912 $self->difficulty ($self->estimate_difficulty)
1913 unless $self->difficulty;
1914 Coro::cede;
945 1915
946sub load_extensions { 1916 unless ($self->{deny_activate}) {
947 for my $ext (<$LIBDIR/*.ext>) { 1917 $self->decay_objects;
948 next unless -r $ext; 1918 $self->fix_auto_apply;
949 eval { 1919 $self->update_buttons;
950 load_extension $ext; 1920 Coro::cede;
951 1 1921 $self->set_darkness_map;
952 } or warn "$ext not loaded: $@"; 1922 Coro::cede;
953 } 1923 $self->activate;
954} 1924 }
955 1925
956############################################################################# 1926 $self->in_memory (cf::MAP_IN_MEMORY);
957# load/save/clean perl data associated with a map 1927 }
958 1928
959*cf::mapsupport::on_clean = sub { 1929 $self->post_load;
1930}
1931
1932sub customise_for {
1933 my ($self, $ob) = @_;
1934
1935 return find "~" . $ob->name . "/" . $self->{path}
1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1940
1941 $self
1942}
1943
1944# find and load all maps in the 3x3 area around a map
1945sub load_diag {
960 my ($map) = @_; 1946 my ($map) = @_;
961 1947
962 my $path = $map->tmpname; 1948 my @diag; # diagonal neighbours
963 defined $path or return;
964 1949
965 unlink "$path.pst"; 1950 for (0 .. 3) {
966}; 1951 my $neigh = $map->tile_path ($_)
1952 or next;
1953 $neigh = find $neigh, $map
1954 or next;
1955 $neigh->load;
967 1956
968cf::map->attach (prio => -10000, package => cf::mapsupport::); 1957 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1958 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1959 }
969 1960
970############################################################################# 1961 for (@diag) {
971# load/save perl data associated with player->ob objects 1962 my $neigh = find @$_
972 1963 or next;
973sub all_objects(@) { 1964 $neigh->load;
974 @_, map all_objects ($_->inv), @_ 1965 }
975} 1966}
976 1967
977# TODO: compatibility cruft, remove when no longer needed 1968sub find_sync {
978cf::player->attach ( 1969 my ($path, $origin) = @_;
979 on_load => sub {
980 my ($pl, $path) = @_;
981 1970
982 for my $o (all_objects $pl->ob) { 1971 cf::sync_job { find $path, $origin }
983 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1972}
984 $o->set_ob_key_value ("_perl_data");
985 1973
986 %$o = %{ Storable::thaw pack "H*", $value }; 1974sub do_load_sync {
1975 my ($map) = @_;
1976
1977 cf::sync_job { $map->load };
1978}
1979
1980our %MAP_PREFETCH;
1981our $MAP_PREFETCHER = undef;
1982
1983sub find_async {
1984 my ($path, $origin) = @_;
1985
1986 $path = normalise $path, $origin && $origin->{path};
1987
1988 if (my $map = $cf::MAP{$path}) {
1989 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1990 }
1991
1992 undef $MAP_PREFETCH{$path};
1993 $MAP_PREFETCHER ||= cf::async {
1994 while (%MAP_PREFETCH) {
1995 for my $path (keys %MAP_PREFETCH) {
1996 if (my $map = find $path) {
1997 $map->load;
1998 }
1999
2000 delete $MAP_PREFETCH{$path};
987 } 2001 }
988 } 2002 }
2003 undef $MAP_PREFETCHER;
2004 };
2005 $MAP_PREFETCHER->prio (6);
2006
2007 ()
2008}
2009
2010sub save {
2011 my ($self) = @_;
2012
2013 my $lock = cf::lock_acquire "map_data:" . $self->path;
2014
2015 $self->{last_save} = $cf::RUNTIME;
2016
2017 return unless $self->dirty;
2018
2019 my $save = $self->save_path; utf8::encode $save;
2020 my $uniq = $self->uniq_path; utf8::encode $uniq;
2021
2022 $self->{load_path} = $save;
2023
2024 return if $self->{deny_save};
2025
2026 local $self->{last_access} = $self->last_access;#d#
2027
2028 cf::async {
2029 $_->contr->save for $self->players;
2030 };
2031
2032 if ($uniq) {
2033 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2034 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2035 } else {
2036 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
989 }, 2037 }
990); 2038}
991 2039
992############################################################################# 2040sub swap_out {
2041 my ($self) = @_;
993 2042
994=head2 CORE EXTENSIONS 2043 # save first because save cedes
2044 $self->save;
995 2045
996Functions and methods that extend core crossfire objects. 2046 my $lock = cf::lock_acquire "map_data:" . $self->path;
997 2047
998=head3 cf::player 2048 return if $self->players;
2049 return if $self->in_memory != cf::MAP_IN_MEMORY;
2050 return if $self->{deny_save};
2051
2052 $self->clear;
2053 $self->in_memory (cf::MAP_SWAPPED);
2054}
2055
2056sub reset_at {
2057 my ($self) = @_;
2058
2059 # TODO: safety, remove and allow resettable per-player maps
2060 return 1e99 if $self->{deny_reset};
2061
2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2064
2065 $time + $to
2066}
2067
2068sub should_reset {
2069 my ($self) = @_;
2070
2071 $self->reset_at <= $cf::RUNTIME
2072}
2073
2074sub reset {
2075 my ($self) = @_;
2076
2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
2078
2079 return if $self->players;
2080
2081 warn "resetting map ", $self->path;
2082
2083 $self->in_memory (cf::MAP_SWAPPED);
2084
2085 # need to save uniques path
2086 unless ($self->{deny_save}) {
2087 my $uniq = $self->uniq_path; utf8::encode $uniq;
2088
2089 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2090 if $uniq;
2091 }
2092
2093 delete $cf::MAP{$self->path};
2094
2095 $self->clear;
2096
2097 $_->clear_links_to ($self) for values %cf::MAP;
2098
2099 $self->unlink_save;
2100 $self->destroy;
2101}
2102
2103my $nuke_counter = "aaaa";
2104
2105sub nuke {
2106 my ($self) = @_;
2107
2108 delete $cf::MAP{$self->path};
2109
2110 $self->unlink_save;
2111
2112 bless $self, "cf::map";
2113 delete $self->{deny_reset};
2114 $self->{deny_save} = 1;
2115 $self->reset_timeout (1);
2116 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2117
2118 $cf::MAP{$self->path} = $self;
2119
2120 $self->reset; # polite request, might not happen
2121}
2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
2159=item cf::map::unique_maps
2160
2161Returns an arrayref of paths of all shared maps that have
2162instantiated unique items. May block.
2163
2164=cut
2165
2166sub unique_maps() {
2167 [
2168 map {
2169 utf8::decode $_;
2170 /\.map$/
2171 ? normalise $_
2172 : ()
2173 } @{ aio_readdir $UNIQUEDIR or [] }
2174 ]
2175}
2176
2177package cf;
2178
2179=back
2180
2181=head3 cf::object
2182
2183=cut
2184
2185package cf::object;
999 2186
1000=over 4 2187=over 4
1001 2188
1002=item cf::player::exists $login 2189=item $ob->inv_recursive
1003 2190
1004Returns true when the given account exists. 2191Returns the inventory of the object _and_ their inventories, recursively.
1005 2192
1006=cut 2193=cut
1007 2194
1008sub cf::player::exists($) { 2195sub inv_recursive_;
1009 cf::player::find $_[0] 2196sub inv_recursive_ {
1010 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2197 map { $_, inv_recursive_ $_->inv } @_
1011} 2198}
1012 2199
1013=item $player->ext_reply ($msgid, $msgtype, %msg) 2200sub inv_recursive {
1014 2201 inv_recursive_ inv $_[0]
1015Sends an ext reply to the player.
1016
1017=cut
1018
1019sub cf::player::ext_reply($$$%) {
1020 my ($self, $id, %msg) = @_;
1021
1022 $msg{msgid} = $id;
1023
1024 $self->send ("ext " . to_json \%msg);
1025} 2202}
2203
2204package cf;
1026 2205
1027=back 2206=back
1028 2207
1029=head3 cf::object::player 2208=head3 cf::object::player
1030 2209
1046 2225
1047 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1048 2227
1049 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1050 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1051 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1052 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1053 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1054 } 2242 }
1055} 2243}
1056 2244
1057=item $player_object->may ("access") 2245=item $player_object->may ("access")
1058 2246
1068 (ref $cf::CFG{"may_$access"} 2256 (ref $cf::CFG{"may_$access"}
1069 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2257 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1070 : $cf::CFG{"may_$access"}) 2258 : $cf::CFG{"may_$access"})
1071} 2259}
1072 2260
2261=item $player_object->enter_link
2262
2263Freezes the player and moves him/her to a special map (C<{link}>).
2264
2265The player should be reasonably safe there for short amounts of time. You
2266I<MUST> call C<leave_link> as soon as possible, though.
2267
2268Will never block.
2269
2270=item $player_object->leave_link ($map, $x, $y)
2271
2272Moves the player out of the special C<{link}> map onto the specified
2273map. If the map is not valid (or omitted), the player will be moved back
2274to the location he/she was before the call to C<enter_link>, or, if that
2275fails, to the emergency map position.
2276
2277Might block.
2278
2279=cut
2280
2281sub link_map {
2282 unless ($LINK_MAP) {
2283 $LINK_MAP = cf::map::find "{link}"
2284 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2285 $LINK_MAP->load;
2286 }
2287
2288 $LINK_MAP
2289}
2290
2291sub cf::object::player::enter_link {
2292 my ($self) = @_;
2293
2294 $self->deactivate_recursive;
2295
2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
2297
2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2299 if $self->map && $self->map->{path} ne "{link}";
2300
2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2302}
2303
2304sub cf::object::player::leave_link {
2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
2308
2309 my $link_pos = delete $self->{_link_pos};
2310
2311 unless ($map) {
2312 # restore original map position
2313 ($map, $x, $y) = @{ $link_pos || [] };
2314 $map = cf::map::find $map;
2315
2316 unless ($map) {
2317 ($map, $x, $y) = @$EMERGENCY_POSITION;
2318 $map = cf::map::find $map
2319 or die "FATAL: cannot load emergency map\n";
2320 }
2321 }
2322
2323 ($x, $y) = (-1, -1)
2324 unless (defined $x) && (defined $y);
2325
2326 # use -1 or undef as default coordinates, not 0, 0
2327 ($x, $y) = ($map->enter_x, $map->enter_y)
2328 if $x <=0 && $y <= 0;
2329
2330 $map->load;
2331 $map->load_diag;
2332
2333 return unless $self->contr->active;
2334 $self->activate_recursive;
2335
2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2337 $self->enter_map ($map, $x, $y);
2338}
2339
2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2341
2342Moves the player to the given map-path and coordinates by first freezing
2343her, loading and preparing them map, calling the provided $check callback
2344that has to return the map if sucecssful, and then unfreezes the player on
2345the new (success) or old (failed) map position. In either case, $done will
2346be called at the end of this process.
2347
2348=cut
2349
2350our $GOTOGEN;
2351
2352sub cf::object::player::goto {
2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2357
2358 $self->enter_link;
2359
2360 (async {
2361 my $map = eval {
2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
2365 $map = $map->customise_for ($self);
2366 $map = $check->($map) if $check && $map;
2367 } else {
2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
2370
2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
2377 }
2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
2385 })->prio (1);
2386}
2387
2388=item $player_object->enter_exit ($exit_object)
2389
2390=cut
2391
2392sub parse_random_map_params {
2393 my ($spec) = @_;
2394
2395 my $rmp = { # defaults
2396 xsize => (cf::rndm 15, 40),
2397 ysize => (cf::rndm 15, 40),
2398 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2399 #layout => string,
2400 };
2401
2402 for (split /\n/, $spec) {
2403 my ($k, $v) = split /\s+/, $_, 2;
2404
2405 $rmp->{lc $k} = $v if (length $k) && (length $v);
2406 }
2407
2408 $rmp
2409}
2410
2411sub prepare_random_map {
2412 my ($exit) = @_;
2413
2414 my $guard = cf::lock_acquire "exit_prepare:$exit";
2415
2416 # all this does is basically replace the /! path by
2417 # a new random map path (?random/...) with a seed
2418 # that depends on the exit object
2419
2420 my $rmp = parse_random_map_params $exit->msg;
2421
2422 if ($exit->map) {
2423 $rmp->{region} = $exit->region->name;
2424 $rmp->{origin_map} = $exit->map->path;
2425 $rmp->{origin_x} = $exit->x;
2426 $rmp->{origin_y} = $exit->y;
2427 }
2428
2429 $rmp->{random_seed} ||= $exit->random_seed;
2430
2431 my $data = cf::to_json $rmp;
2432 my $md5 = Digest::MD5::md5_hex $data;
2433 my $meta = "$RANDOMDIR/$md5.meta";
2434
2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2436 aio_write $fh, 0, (length $data), $data, 0;
2437 undef $fh;
2438 aio_rename "$meta~", $meta;
2439
2440 $exit->slaying ("?random/$md5");
2441 $exit->msg (undef);
2442 }
2443}
2444
2445sub cf::object::player::enter_exit {
2446 my ($self, $exit) = @_;
2447
2448 return unless $self->type == cf::PLAYER;
2449
2450 if ($exit->slaying eq "/!") {
2451 #TODO: this should de-fi-ni-te-ly not be a sync-job
2452 # the problem is that $exit might not survive long enough
2453 # so it needs to be done right now, right here
2454 cf::sync_job { prepare_random_map $exit };
2455 }
2456
2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2458 my $hp = $exit->stats->hp;
2459 my $sp = $exit->stats->sp;
2460
2461 $self->enter_link;
2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
2466
2467 (async {
2468 $self->deactivate_recursive; # just to be sure
2469 unless (eval {
2470 $self->goto ($slaying, $hp, $sp);
2471
2472 1;
2473 }) {
2474 $self->message ("Something went wrong deep within the crossfire server. "
2475 . "I'll try to bring you back to the map you were before. "
2476 . "Please report this to the dungeon master!",
2477 cf::NDI_UNIQUE | cf::NDI_RED);
2478
2479 warn "ERROR in enter_exit: $@";
2480 $self->leave_link;
2481 }
2482 })->prio (1);
2483}
2484
1073=head3 cf::client 2485=head3 cf::client
1074 2486
1075=over 4 2487=over 4
1076 2488
1077=item $client->send_drawinfo ($text, $flags) 2489=item $client->send_drawinfo ($text, $flags)
1083 2495
1084sub cf::client::send_drawinfo { 2496sub cf::client::send_drawinfo {
1085 my ($self, $text, $flags) = @_; 2497 my ($self, $text, $flags) = @_;
1086 2498
1087 utf8::encode $text; 2499 utf8::encode $text;
1088 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1089} 2501}
1090 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => $channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2569 push @msg, msgtype => "event_$type";
2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2572}
1091 2573
1092=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
1093 2575
1094Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
1095the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1096C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1097 2579
1098Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
1099reliable at some point in the future. 2581become reliable at some point in the future.
1100 2582
1101=cut 2583=cut
1102 2584
1103sub cf::client::query { 2585sub cf::client::query {
1104 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
1112 utf8::encode $text; 2594 utf8::encode $text;
1113 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1114 2596
1115 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
1116 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
1117} 2601}
1118 2602
1119cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
1120 on_reply => sub { 2609 on_reply => sub {
1121 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
1122 2611
1123 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
1124 # get handled first 2613 # get handled first
1125 my $queue = delete $ns->{query_queue}; 2614 my $queue = delete $ns->{query_queue}
2615 or return; # be conservative, not sure how that can happen, but we saw a crash here
1126 2616
1127 (shift @$queue)->[1]->($msg); 2617 (shift @$queue)->[1]->($msg);
2618 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1128 2619
1129 push @{ $ns->{query_queue} }, @$queue; 2620 push @{ $ns->{query_queue} }, @$queue;
1130 2621
1131 if (@{ $ns->{query_queue} } == @$queue) { 2622 if (@{ $ns->{query_queue} } == @$queue) {
1132 if (@$queue) { 2623 if (@$queue) {
1134 } else { 2625 } else {
1135 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1136 } 2627 }
1137 } 2628 }
1138 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
1139); 2653);
1140 2654
1141=item $client->coro (\&cb) 2655=item $client->async (\&cb)
1142 2656
1143Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
1144be automatically cancelled when the client gets destroyed (e.g. on logout, 2658be automatically cancelled when the client gets destroyed (e.g. on logout,
1145or loss of connection). 2659or loss of connection).
1146 2660
1147=cut 2661=cut
1148 2662
1149sub cf::client::coro { 2663sub cf::client::async {
1150 my ($self, $cb) = @_; 2664 my ($self, $cb) = @_;
1151 2665
1152 my $coro; $coro = async { 2666 my $coro = &Coro::async ($cb);
1153 eval {
1154 $cb->();
1155 };
1156 warn $@ if $@;
1157 };
1158 2667
1159 $coro->on_destroy (sub { 2668 $coro->on_destroy (sub {
1160 delete $self->{_coro}{$coro+0}; 2669 delete $self->{_coro}{$coro+0};
1161 }); 2670 });
1162 2671
1195 2704
1196# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
1197 2706
1198=pod 2707=pod
1199 2708
1200The following fucntions and emthods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
1201 2710
1202 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
1203 cf::object::player player 2715 cf::object::player
1204 cf::player peaceful 2716 player
1205 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
1206 2723
1207=cut 2724=cut
1208 2725
1209for ( 2726for (
1210 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
1211 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
1212 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
1213 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
1214) { 2732) {
1215 no strict 'refs'; 2733 no strict 'refs';
1286=back 2804=back
1287 2805
1288=cut 2806=cut
1289 2807
1290############################################################################# 2808#############################################################################
2809# the server's init and main functions
1291 2810
1292=head2 EXTENSION DATABASE SUPPORT 2811sub load_facedata($) {
2812 my ($path) = @_;
1293 2813
1294Crossfire maintains a very simple database for extension use. It can 2814 warn "loading facedata from $path\n";
1295currently store anything that can be serialised using Storable, which
1296excludes objects.
1297 2815
1298The parameter C<$family> should best start with the name of the extension 2816 my $facedata;
1299using it, it should be unique. 2817 0 < aio_load $path, $facedata
2818 or die "$path: $!";
1300 2819
1301=over 4 2820 $facedata = Coro::Storable::thaw $facedata;
1302 2821
1303=item $hashref = cf::db_get $family 2822 $facedata->{version} == 2
2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
1304 2824
1305Return a hashref for use by the extension C<$family>, which can be
1306modified. After modifications, you have to call C<cf::db_dirty> or
1307C<cf::db_sync>.
1308
1309=item $value = cf::db_get $family => $key
1310
1311Returns a single value from the database
1312
1313=item cf::db_put $family => $hashref
1314
1315Stores the given family hashref into the database. Updates are delayed, if
1316you want the data to be synced to disk immediately, use C<cf::db_sync>.
1317
1318=item cf::db_put $family => $key => $value
1319
1320Stores the given C<$value> in the family hash. Updates are delayed, if you
1321want the data to be synced to disk immediately, use C<cf::db_sync>.
1322
1323=item cf::db_dirty
1324
1325Marks the database as dirty, to be updated at a later time.
1326
1327=item cf::db_sync
1328
1329Immediately write the database to disk I<if it is dirty>.
1330
1331=cut
1332
1333our $DB;
1334
1335{
1336 my $path = cf::localdir . "/database.pst";
1337
1338 sub db_load() {
1339 warn "loading database $path\n";#d# remove later
1340 $DB = stat $path ? Storable::retrieve $path : { };
1341 } 2825 {
2826 my $faces = $facedata->{faceinfo};
1342 2827
1343 my $pid; 2828 while (my ($face, $info) = each %$faces) {
2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1344 2834
1345 sub db_save() { 2835 cf::cede_to_tick;
1346 warn "saving database $path\n";#d# remove later
1347 waitpid $pid, 0 if $pid;
1348 if (0 == ($pid = fork)) {
1349 $DB->{_meta}{version} = 1;
1350 Storable::nstore $DB, "$path~";
1351 rename "$path~", $path;
1352 cf::_exit 0 if defined $pid;
1353 }
1354 }
1355
1356 my $dirty;
1357
1358 sub db_sync() {
1359 db_save if $dirty;
1360 undef $dirty;
1361 }
1362
1363 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1364 db_sync;
1365 });
1366
1367 sub db_dirty() {
1368 $dirty = 1;
1369 $idle->start;
1370 }
1371
1372 sub db_get($;$) {
1373 @_ >= 2
1374 ? $DB->{$_[0]}{$_[1]}
1375 : ($DB->{$_[0]} ||= { })
1376 }
1377
1378 sub db_put($$;$) {
1379 if (@_ >= 3) {
1380 $DB->{$_[0]}{$_[1]} = $_[2];
1381 } else {
1382 $DB->{$_[0]} = $_[1];
1383 }
1384 db_dirty;
1385 }
1386
1387 cf::global->attach (
1388 prio => 10000,
1389 on_cleanup => sub {
1390 db_sync;
1391 }, 2836 }
1392 );
1393}
1394 2837
1395############################################################################# 2838 while (my ($face, $info) = each %$faces) {
1396# the server's main() 2839 next unless $info->{smooth};
2840 my $idx = cf::face::find $face
2841 or next;
2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2845 } else {
2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2847 }
2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 while (my ($name, $info) = each %$res) {
2871 my $meta = $enc->encode ({
2872 name => $name,
2873 copyright => $info->{copyright}, #TODO#
2874 });
2875
2876 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2877
2878 if ($info->{type} & 1) {
2879 # prepend meta info
2880
2881 my $data = pack "(w/a*)*", $meta, $info->{data};
2882 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2883
2884 cf::face::set_data $idx, 0, $data, $chk;
2885 } else {
2886 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2887 }
2888
2889 cf::face::set_type $idx, $info->{type};
2890
2891 cf::cede_to_tick;
2892 }
2893 }
2894
2895 1
2896}
2897
2898register_exticmd fx_want => sub {
2899 my ($ns, $want) = @_;
2900
2901 while (my ($k, $v) = each %$want) {
2902 $ns->fx_want ($k, $v);
2903 }
2904};
2905
2906sub reload_regions {
2907 load_resource_file "$MAPDIR/regions"
2908 or die "unable to load regions file\n";
2909
2910 for (cf::region::list) {
2911 $_->{match} = qr/$_->{match}/
2912 if exists $_->{match};
2913 }
2914}
2915
2916sub reload_facedata {
2917 load_facedata "$DATADIR/facedata"
2918 or die "unable to load facedata\n";
2919}
2920
2921sub reload_archetypes {
2922 load_resource_file "$DATADIR/archetypes"
2923 or die "unable to load archetypes\n";
2924 #d# NEED to laod twice to resolve forward references
2925 # this really needs to be done in an extra post-pass
2926 # (which needs to be synchronous, so solve it differently)
2927 load_resource_file "$DATADIR/archetypes"
2928 or die "unable to load archetypes\n";
2929}
2930
2931sub reload_treasures {
2932 load_resource_file "$DATADIR/treasures"
2933 or die "unable to load treasurelists\n";
2934}
2935
2936sub reload_resources {
2937 warn "reloading resource files...\n";
2938
2939 reload_regions;
2940 reload_facedata;
2941 #reload_archetypes;#d#
2942 reload_archetypes;
2943 reload_treasures;
2944
2945 warn "finished reloading resource files\n";
2946}
2947
2948sub init {
2949 reload_resources;
2950}
1397 2951
1398sub cfg_load { 2952sub cfg_load {
1399 open my $fh, "<:utf8", cf::confdir . "/config" 2953 open my $fh, "<:utf8", "$CONFDIR/config"
1400 or return; 2954 or return;
1401 2955
1402 local $/; 2956 local $/;
1403 *CFG = YAML::Syck::Load <$fh>; 2957 *CFG = YAML::Syck::Load <$fh>;
2958
2959 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2960
2961 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2962 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2963
2964 if (exists $CFG{mlockall}) {
2965 eval {
2966 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2967 and die "WARNING: m(un)lockall failed: $!\n";
2968 };
2969 warn $@ if $@;
2970 }
1404} 2971}
1405 2972
1406sub main { 2973sub main {
1407 # we must not ever block the main coroutine 2974 # we must not ever block the main coroutine
1408 local $Coro::idle = sub { 2975 local $Coro::idle = sub {
1409 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2976 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1410 (Coro::unblock_sub { 2977 (async {
1411 Event::one_event; 2978 Event::one_event;
1412 })->(); 2979 })->prio (Coro::PRIO_MAX);
1413 }; 2980 };
1414 2981
1415 cfg_load; 2982 cfg_load;
1416 db_load; 2983 db_init;
1417 load_extensions; 2984 load_extensions;
2985
2986 $TICK_WATCHER->start;
1418 Event::loop; 2987 Event::loop;
1419} 2988}
1420 2989
1421############################################################################# 2990#############################################################################
1422# initialisation 2991# initialisation and cleanup
1423 2992
1424sub perl_reload() { 2993# install some emergency cleanup handlers
2994BEGIN {
2995 for my $signal (qw(INT HUP TERM)) {
2996 Event->signal (
2997 reentrant => 0,
2998 data => WF_AUTOCANCEL,
2999 signal => $signal,
3000 prio => 0,
3001 cb => sub {
3002 cf::cleanup "SIG$signal";
3003 },
3004 );
3005 }
3006}
3007
3008sub write_runtime {
3009 my $runtime = "$LOCALDIR/runtime";
3010
3011 # first touch the runtime file to show we are still running:
3012 # the fsync below can take a very very long time.
3013
3014 IO::AIO::aio_utime $runtime, undef, undef;
3015
3016 my $guard = cf::lock_acquire "write_runtime";
3017
3018 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3019 or return;
3020
3021 my $value = $cf::RUNTIME + 90 + 10;
3022 # 10 is the runtime save interval, for a monotonic clock
3023 # 60 allows for the watchdog to kill the server.
3024
3025 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3026 and return;
3027
3028 # always fsync - this file is important
3029 aio_fsync $fh
3030 and return;
3031
3032 # touch it again to show we are up-to-date
3033 aio_utime $fh, undef, undef;
3034
3035 close $fh
3036 or return;
3037
3038 aio_rename "$runtime~", $runtime
3039 and return;
3040
3041 warn "runtime file written.\n";
3042
3043 1
3044}
3045
3046sub emergency_save() {
3047 my $freeze_guard = cf::freeze_mainloop;
3048
3049 warn "enter emergency perl save\n";
3050
3051 cf::sync_job {
3052 # use a peculiar iteration method to avoid tripping on perl
3053 # refcount bugs in for. also avoids problems with players
3054 # and maps saved/destroyed asynchronously.
3055 warn "begin emergency player save\n";
3056 for my $login (keys %cf::PLAYER) {
3057 my $pl = $cf::PLAYER{$login} or next;
3058 $pl->valid or next;
3059 $pl->save;
3060 }
3061 warn "end emergency player save\n";
3062
3063 warn "begin emergency map save\n";
3064 for my $path (keys %cf::MAP) {
3065 my $map = $cf::MAP{$path} or next;
3066 $map->valid or next;
3067 $map->save;
3068 }
3069 warn "end emergency map save\n";
3070
3071 warn "begin emergency database checkpoint\n";
3072 BDB::db_env_txn_checkpoint $DB_ENV;
3073 warn "end emergency database checkpoint\n";
3074 };
3075
3076 warn "leave emergency perl save\n";
3077}
3078
3079sub post_cleanup {
3080 my ($make_core) = @_;
3081
3082 warn Carp::longmess "post_cleanup backtrace"
3083 if $make_core;
3084}
3085
3086sub do_reload_perl() {
1425 # can/must only be called in main 3087 # can/must only be called in main
1426 if ($Coro::current != $Coro::main) { 3088 if ($Coro::current != $Coro::main) {
1427 warn "can only reload from main coroutine\n"; 3089 warn "can only reload from main coroutine";
1428 return; 3090 return;
1429 } 3091 }
1430 3092
1431 warn "reloading..."; 3093 warn "reloading...";
1432 3094
1433 local $FREEZE = 1; 3095 warn "entering sync_job";
3096
3097 cf::sync_job {
3098 cf::write_runtime; # external watchdog should not bark
1434 cf::emergency_save; 3099 cf::emergency_save;
3100 cf::write_runtime; # external watchdog should not bark
1435 3101
1436 eval { 3102 warn "syncing database to disk";
3103 BDB::db_env_txn_checkpoint $DB_ENV;
3104
1437 # if anything goes wrong in here, we should simply crash as we already saved 3105 # if anything goes wrong in here, we should simply crash as we already saved
1438 3106
1439 # cancel all watchers 3107 warn "cancelling all WF_AUTOCANCEL watchers";
1440 for (Event::all_watchers) { 3108 for (Event::all_watchers) {
1441 $_->cancel if $_->data & WF_AUTOCANCEL; 3109 $_->cancel if $_->data & WF_AUTOCANCEL;
1442 } 3110 }
1443 3111
3112 warn "flushing outstanding aio requests";
3113 for (;;) {
3114 BDB::flush;
3115 IO::AIO::flush;
3116 Coro::cede;
3117 last unless IO::AIO::nreqs || BDB::nreqs;
3118 warn "iterate...";
3119 }
3120
3121 ++$RELOAD;
3122
1444 # cancel all extension coros 3123 warn "cancelling all extension coros";
1445 $_->cancel for values %EXT_CORO; 3124 $_->cancel for values %EXT_CORO;
1446 %EXT_CORO = (); 3125 %EXT_CORO = ();
1447 3126
1448 # unload all extensions 3127 warn "removing commands";
1449 for (@exts) { 3128 %COMMAND = ();
3129
3130 warn "removing ext/exti commands";
3131 %EXTCMD = ();
3132 %EXTICMD = ();
3133
3134 warn "unloading/nuking all extensions";
3135 for my $pkg (@EXTS) {
1450 warn "unloading <$_>"; 3136 warn "... unloading $pkg";
1451 unload_extension $_; 3137
3138 if (my $cb = $pkg->can ("unload")) {
3139 eval {
3140 $cb->($pkg);
3141 1
3142 } or warn "$pkg unloaded, but with errors: $@";
1452 } 3143 }
1453 3144
3145 warn "... nuking $pkg";
3146 Symbol::delete_package $pkg;
3147 }
3148
1454 # unload all modules loaded from $LIBDIR 3149 warn "unloading all perl modules loaded from $LIBDIR";
1455 while (my ($k, $v) = each %INC) { 3150 while (my ($k, $v) = each %INC) {
1456 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3151 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1457 3152
1458 warn "removing <$k>"; 3153 warn "... unloading $k";
1459 delete $INC{$k}; 3154 delete $INC{$k};
1460 3155
1461 $k =~ s/\.pm$//; 3156 $k =~ s/\.pm$//;
1462 $k =~ s/\//::/g; 3157 $k =~ s/\//::/g;
1463 3158
1466 } 3161 }
1467 3162
1468 Symbol::delete_package $k; 3163 Symbol::delete_package $k;
1469 } 3164 }
1470 3165
1471 # sync database to disk
1472 cf::db_sync;
1473 IO::AIO::flush;
1474
1475 # get rid of safe::, as good as possible 3166 warn "getting rid of safe::, as good as possible";
1476 Symbol::delete_package "safe::$_" 3167 Symbol::delete_package "safe::$_"
1477 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3168 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1478 3169
1479 # remove register_script_function callbacks
1480 # TODO
1481
1482 # unload cf.pm "a bit" 3170 warn "unloading cf.pm \"a bit\"";
1483 delete $INC{"cf.pm"}; 3171 delete $INC{"cf.pm"};
3172 delete $INC{"cf/pod.pm"};
1484 3173
1485 # don't, removes xs symbols, too, 3174 # don't, removes xs symbols, too,
1486 # and global variables created in xs 3175 # and global variables created in xs
1487 #Symbol::delete_package __PACKAGE__; 3176 #Symbol::delete_package __PACKAGE__;
1488 3177
1489 # reload cf.pm 3178 warn "unload completed, starting to reload now";
3179
1490 warn "reloading cf.pm"; 3180 warn "reloading cf.pm";
1491 require cf; 3181 require cf;
1492 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3182 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1493 3183
1494 # load config and database again 3184 warn "loading config and database again";
1495 cf::cfg_load; 3185 cf::cfg_load;
1496 cf::db_load;
1497 3186
1498 # load extensions
1499 warn "load extensions"; 3187 warn "loading extensions";
1500 cf::load_extensions; 3188 cf::load_extensions;
1501 3189
1502 # reattach attachments to objects 3190 warn "reattaching attachments to objects/players";
1503 warn "reattach"; 3191 _global_reattach; # objects, sockets
1504 _global_reattach; 3192 warn "reattaching attachments to maps";
1505 }; 3193 reattach $_ for values %MAP;
3194 warn "reattaching attachments to players";
3195 reattach $_ for values %PLAYER;
1506 3196
1507 if ($@) { 3197 warn "leaving sync_job";
3198
3199 1
3200 } or do {
1508 warn $@; 3201 warn $@;
1509 warn "error while reloading, exiting."; 3202 warn "error while reloading, exiting.";
1510 exit 1; 3203 exit 1;
1511 } 3204 };
1512 3205
1513 warn "reloaded successfully"; 3206 warn "reloaded";
1514}; 3207};
1515 3208
1516############################################################################# 3209our $RELOAD_WATCHER; # used only during reload
1517 3210
1518unless ($LINK_MAP) { 3211sub reload_perl() {
1519 $LINK_MAP = cf::map::new; 3212 # doing reload synchronously and two reloads happen back-to-back,
3213 # coro crashes during coro_state_free->destroy here.
1520 3214
1521 $LINK_MAP->width (41); 3215 $RELOAD_WATCHER ||= Event->timer (
1522 $LINK_MAP->height (41); 3216 reentrant => 0,
1523 $LINK_MAP->alloc; 3217 after => 0,
1524 $LINK_MAP->path ("{link}"); 3218 data => WF_AUTOCANCEL,
1525 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path"; 3219 cb => sub {
1526 $LINK_MAP->in_memory (MAP_IN_MEMORY); 3220 do_reload_perl;
3221 undef $RELOAD_WATCHER;
3222 },
3223 );
1527} 3224}
1528 3225
1529register "<global>", __PACKAGE__;
1530
1531register_command "perl-reload" => sub { 3226register_command "reload" => sub {
1532 my ($who, $arg) = @_; 3227 my ($who, $arg) = @_;
1533 3228
1534 if ($who->flag (FLAG_WIZ)) { 3229 if ($who->flag (FLAG_WIZ)) {
1535 $who->message ("start of reload.");
1536 perl_reload;
1537 $who->message ("end of reload."); 3230 $who->message ("reloading server.");
3231 async { reload_perl };
1538 } 3232 }
1539}; 3233};
1540 3234
1541unshift @INC, $LIBDIR; 3235unshift @INC, $LIBDIR;
1542 3236
3237my $bug_warning = 0;
3238
3239our @WAIT_FOR_TICK;
3240our @WAIT_FOR_TICK_BEGIN;
3241
3242sub wait_for_tick {
3243 return unless $TICK_WATCHER->is_active;
3244 return if $Coro::current == $Coro::main;
3245
3246 my $signal = new Coro::Signal;
3247 push @WAIT_FOR_TICK, $signal;
3248 $signal->wait;
3249}
3250
3251sub wait_for_tick_begin {
3252 return unless $TICK_WATCHER->is_active;
3253 return if $Coro::current == $Coro::main;
3254
3255 my $signal = new Coro::Signal;
3256 push @WAIT_FOR_TICK_BEGIN, $signal;
3257 $signal->wait;
3258}
3259
3260 my $min = 1e6;#d#
3261 my $avg = 10;
1543$TICK_WATCHER = Event->timer ( 3262$TICK_WATCHER = Event->timer (
1544 reentrant => 0, 3263 reentrant => 0,
3264 parked => 1,
1545 prio => 0, 3265 prio => 0,
1546 at => $NEXT_TICK || $TICK, 3266 at => $NEXT_TICK || $TICK,
1547 data => WF_AUTOCANCEL, 3267 data => WF_AUTOCANCEL,
1548 cb => sub { 3268 cb => sub {
1549 unless ($FREEZE) { 3269 if ($Coro::current != $Coro::main) {
3270 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3271 unless ++$bug_warning > 10;
3272 return;
3273 }
3274
3275 $NOW = $tick_start = Event::time;
3276
1550 cf::server_tick; # one server iteration 3277 cf::server_tick; # one server iteration
1551 $RUNTIME += $TICK; 3278
3279 0 && sync_job {#d#
3280 for(1..10) {
3281 my $t = Event::time;
3282 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3283 or die;
3284
3285 $map->width (50);
3286 $map->height (50);
3287 $map->alloc;
3288 $map->_load_objects ("/tmp/x.map", 1);
3289 my $t = Event::time - $t;
3290
3291 #next unless $t < 0.0013;#d#
3292 if ($t < $min) {
3293 $min = $t;
3294 }
3295 $avg = $avg * 0.99 + $t * 0.01;
3296 }
3297 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3298 exit 0;
3299 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1552 } 3300 };
1553 3301
3302 $RUNTIME += $TICK;
1554 $NEXT_TICK += $TICK; 3303 $NEXT_TICK += $TICK;
1555 3304
3305 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3306 $NEXT_RUNTIME_WRITE = $NOW + 10;
3307 Coro::async_pool {
3308 write_runtime
3309 or warn "ERROR: unable to write runtime file: $!";
3310 };
3311 }
3312
3313# my $AFTER = Event::time;
3314# warn $AFTER - $NOW;#d#
3315
3316 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3317 $sig->send;
3318 }
3319 while (my $sig = shift @WAIT_FOR_TICK) {
3320 $sig->send;
3321 }
3322
3323 $NOW = Event::time;
3324
1556 # if we are delayed by four ticks or more, skip them all 3325 # if we are delayed by four ticks or more, skip them all
1557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3326 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1558 3327
1559 $TICK_WATCHER->at ($NEXT_TICK); 3328 $TICK_WATCHER->at ($NEXT_TICK);
1560 $TICK_WATCHER->start; 3329 $TICK_WATCHER->start;
3330
3331 $LOAD = ($NOW - $tick_start) / $TICK;
3332 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3333
3334 _post_tick;
3335
3336
1561 }, 3337 },
1562); 3338);
1563 3339
3340{
1564IO::AIO::max_poll_time $TICK * 0.2; 3341 BDB::max_poll_time $TICK * 0.1;
1565 3342 $BDB_POLL_WATCHER = Event->io (
1566Event->io ( 3343 reentrant => 0,
1567 fd => IO::AIO::poll_fileno, 3344 fd => BDB::poll_fileno,
1568 poll => 'r', 3345 poll => 'r',
1569 prio => 5, 3346 prio => 0,
1570 data => WF_AUTOCANCEL,
1571 cb => \&IO::AIO::poll_cb,
1572);
1573
1574Event->timer (
1575 data => WF_AUTOCANCEL, 3347 data => WF_AUTOCANCEL,
1576 after => 0, 3348 cb => \&BDB::poll_cb,
1577 interval => 10, 3349 );
1578 cb => sub { 3350 BDB::min_parallel 8;
1579 (Coro::unblock_sub { 3351
1580 write_runtime 3352 BDB::set_sync_prepare {
1581 or warn "ERROR: unable to write runtime file: $!"; 3353 my $status;
3354 my $current = $Coro::current;
3355 (
3356 sub {
3357 $status = $!;
3358 $current->ready; undef $current;
3359 },
3360 sub {
3361 Coro::schedule while defined $current;
3362 $! = $status;
3363 },
3364 )
3365 };
3366
3367 unless ($DB_ENV) {
3368 $DB_ENV = BDB::db_env_create;
3369
3370 cf::sync_job {
3371 eval {
3372 BDB::db_env_open
3373 $DB_ENV,
3374 $BDBDIR,
3375 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3376 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3377 0666;
3378
3379 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3380
3381 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3382 $DB_ENV->set_lk_detect;
3383 };
3384
3385 cf::cleanup "db_env_open(db): $@" if $@;
1582 })->(); 3386 };
1583 }, 3387 }
1584); 3388}
3389
3390{
3391 IO::AIO::min_parallel 8;
3392
3393 undef $Coro::AIO::WATCHER;
3394 IO::AIO::max_poll_time $TICK * 0.1;
3395 $AIO_POLL_WATCHER = Event->io (
3396 reentrant => 0,
3397 data => WF_AUTOCANCEL,
3398 fd => IO::AIO::poll_fileno,
3399 poll => 'r',
3400 prio => 6,
3401 cb => \&IO::AIO::poll_cb,
3402 );
3403}
3404
3405my $_log_backtrace;
3406
3407sub _log_backtrace {
3408 my ($msg, @addr) = @_;
3409
3410 $msg =~ s/\n//;
3411
3412 # limit the # of concurrent backtraces
3413 if ($_log_backtrace < 2) {
3414 ++$_log_backtrace;
3415 async {
3416 my @bt = fork_call {
3417 @addr = map { sprintf "%x", $_ } @addr;
3418 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3419 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3420 or die "addr2line: $!";
3421
3422 my @funcs;
3423 my @res = <$fh>;
3424 chomp for @res;
3425 while (@res) {
3426 my ($func, $line) = splice @res, 0, 2, ();
3427 push @funcs, "[$func] $line";
3428 }
3429
3430 @funcs
3431 };
3432
3433 LOG llevInfo, "[ABT] $msg\n";
3434 LOG llevInfo, "[ABT] $_\n" for @bt;
3435 --$_log_backtrace;
3436 };
3437 } else {
3438 LOG llevInfo, "[ABT] $msg\n";
3439 LOG llevInfo, "[ABT] [suppressed]\n";
3440 }
3441}
3442
3443# load additional modules
3444use cf::pod;
3445
3446END { cf::emergency_save }
1585 3447
15861 34481
1587 3449

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines