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.106 by root, Sun Dec 31 17:29:22 2006 UTC vs.
Revision 1.351 by root, Sun Sep 2 00:57:38 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.64 ();
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;
24use Coro::Util ();
19 25
26use JSON::XS ();
27use BDB ();
28use Data::Dumper;
29use Digest::MD5;
20use Fcntl; 30use Fcntl;
21use IO::AIO 2.31 ();
22use YAML::Syck (); 31use YAML::Syck ();
32use IO::AIO 2.32 ();
23use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
24 36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
42
25use Event; $Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
26 44
27# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 45# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
28$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
29 47
30$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 48$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
31 49
32sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
33 51
34our %COMMAND = (); 52our %COMMAND = ();
35our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
54
55our @EXTS = (); # list of extension package names
36our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
58our %EXT_CORO = (); # coroutines bound to extensions
59our %EXT_MAP = (); # pluggable maps
37 60
61our $RELOAD; # number of reloads so far
38our @EVENT; 62our @EVENT;
39our $LIBDIR = datadir . "/ext";
40 63
41our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
42our $TICK_WATCHER; 77our $TICK_WATCHER;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
43our $NEXT_TICK; 80our $NEXT_TICK;
44our $NOW; 81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $DB_ENV;
45 86
46our %CFG; 87our %CFG;
47 88
48our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
49our $RUNTIME; 90our $RUNTIME;
50 91
92our %PLAYER; # all users
51our %MAP; # all maps 93our %MAP; # all maps
52our $LINK_MAP; # the special {link} map 94our $LINK_MAP; # the special {link} map, which is always available
53our $FREEZE; 95
96# used to convert map paths into valid unix filenames by replacing / by ∕
97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
54 102
55binmode STDOUT; 103binmode STDOUT;
56binmode STDERR; 104binmode STDERR;
57 105
58# read virtual server time, if available 106# read virtual server time, if available
59unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
60 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
61 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
62 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
63} 111}
64 112
65mkdir cf::localdir; 113mkdir $_
66mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
67mkdir cf::localdir . "/" . cf::tmpdir;
68mkdir cf::localdir . "/" . cf::uniquedir;
69 115
70our %EXT_CORO; 116our $EMERGENCY_POSITION;
117
118sub cf::map::normalise;
71 119
72############################################################################# 120#############################################################################
73 121
74=head2 GLOBAL VARIABLES 122=head2 GLOBAL VARIABLES
75 123
82=item $cf::RUNTIME 130=item $cf::RUNTIME
83 131
84The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
85every server tick. 133every server tick.
86 134
87=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
88 138
89The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
90be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
91 143
92=item $cf::NOW 144=item $cf::NOW
93 145
94The time of the last (current) server tick. 146The time of the last (current) server tick.
95 147
96=item $cf::TICK 148=item $cf::TICK
97 149
98The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
99 161
100=item %cf::CFG 162=item %cf::CFG
101 163
102Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
103from wherever your confdir points to. 165from wherever your confdir points to.
166
167=item cf::wait_for_tick, cf::wait_for_tick_begin
168
169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
170returns directly I<after> the tick processing (and consequently, can only wake one process
171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
104 178
105=back 179=back
106 180
107=cut 181=cut
108 182
109BEGIN { 183BEGIN {
110 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
111 my $msg = join "", @_; 185 my $msg = join "", @_;
112 utf8::encode $msg;
113 186
114 $msg .= "\n" 187 $msg .= "\n"
115 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
116 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
117 LOG llevError, "cfperl: $msg"; 193 LOG llevError, $msg;
118 }; 194 };
119} 195}
120 196
121@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
123@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
124@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
125@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
126@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
127 204
128# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
129# within the Safe compartment. 206# within the Safe compartment.
130for my $pkg (qw( 207for my $pkg (qw(
131 cf::global cf::attachable 208 cf::global cf::attachable
140 217
141$Event::DIED = sub { 218$Event::DIED = sub {
142 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
143}; 220};
144 221
145my %ext_pkg; 222#############################################################################
146my @exts;
147my @hook;
148 223
149=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
150 225
151=over 4 226=over 4
152 227
153=cut 228=item dumpval $ref
154 229
155use JSON::Syck (); # TODO# replace by JSON::PC once working 230=cut
231
232sub dumpval {
233 eval {
234 local $SIG{__DIE__};
235 my $d;
236 if (1) {
237 $d = new Data::Dumper([$_[0]], ["*var"]);
238 $d->Terse(1);
239 $d->Indent(2);
240 $d->Quotekeys(0);
241 $d->Useqq(1);
242 #$d->Bless(...);
243 $d->Seen($_[1]) if @_ > 1;
244 $d = $d->Dump();
245 }
246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
247 $d
248 } || "[unable to dump $_[0]: '$@']";
249}
156 250
157=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
158 252
159Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
160 254
161=cut
162
163sub from_json($) {
164 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
165 JSON::Syck::Load $_[0]
166}
167
168=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
169 256
170Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
171 258
172=cut 259=cut
173 260
174sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
175 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
176 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
265
266=item cf::lock_wait $string
267
268Wait until the given lock is available. See cf::lock_acquire.
269
270=item my $lock = cf::lock_acquire $string
271
272Wait until the given lock is available and then acquires it and returns
273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
274for example when the coroutine gets canceled), the lock is automatically
275returned.
276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
280Lock names should begin with a unique identifier (for example, cf::map::find
281uses map_find and cf::map::load uses map_load).
282
283=item $locked = cf::lock_active $string
284
285Return true if the lock is currently active, i.e. somebody has locked it.
286
287=cut
288
289our %LOCK;
290
291sub lock_wait($) {
292 my ($key) = @_;
293
294 # wait for lock, if any
295 while ($LOCK{$key}) {
296 push @{ $LOCK{$key} }, $Coro::current;
297 Coro::schedule;
298 }
177} 299}
300
301sub lock_acquire($) {
302 my ($key) = @_;
303
304 # wait, to be sure we are not locked
305 lock_wait $key;
306
307 $LOCK{$key} = [];
308
309 Coro::guard {
310 # wake up all waiters, to be on the safe side
311 $_->ready for @{ delete $LOCK{$key} };
312 }
313}
314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
321sub freeze_mainloop {
322 return unless $TICK_WATCHER->is_active;
323
324 my $guard = Coro::guard {
325 $TICK_WATCHER->start;
326 };
327 $TICK_WATCHER->stop;
328 $guard
329}
330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
385}
386
387=item cf::async { BLOCK }
388
389Currently the same as Coro::async_pool, meaning you cannot use
390C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
391thing you are allowed to do is call C<prio> on it.
392
393=cut
394
395BEGIN { *async = \&Coro::async_pool }
178 396
179=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
180 398
181The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
182always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
183reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
184 403
185If it must be done, put the blocking parts into C<sync_job>. This will run 404If it must be done, put the blocking parts into C<sync_job>. This will run
186the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
187server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
188fast or be very important. 407fast or be very important.
190=cut 409=cut
191 410
192sub sync_job(&) { 411sub sync_job(&) {
193 my ($job) = @_; 412 my ($job) = @_;
194 413
195 my $busy = 1;
196 my @res;
197
198 # TODO: use suspend/resume instead
199 local $FREEZE = 1;
200
201 my $coro = Coro::async {
202 @res = eval { $job->() };
203 warn $@ if $@;
204 undef $busy;
205 };
206
207 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
417 # this is the main coro, too bad, we have to block
418 # till the operation succeeds, freezing the server :/
419
420 # TODO: use suspend/resume instead
421 # (but this is cancel-safe)
422 my $freeze_guard = freeze_mainloop;
423
424 my $busy = 1;
425 my @res;
426
427 (async {
428 @res = eval { $job->() };
429 warn $@ if $@;
430 undef $busy;
208 $coro->prio (Coro::PRIO_MAX); 431 })->prio (Coro::PRIO_MAX);
432
209 while ($busy) { 433 while ($busy) {
210 Coro::cede_notself; 434 Coro::cede or Event::one_event;
211 Event::one_event unless Coro::nready;
212 } 435 }
436
437 $time = Event::time - $time;
438
439 LOG llevError | logBacktrace, Carp::longmess "long sync job"
440 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
441
442 $tick_start += $time; # do not account sync jobs to server load
443
444 wantarray ? @res : $res[0]
213 } else { 445 } else {
214 $coro->join; 446 # we are in another coroutine, how wonderful, everything just works
447
448 $job->()
215 } 449 }
216
217 wantarray ? @res : $res[0]
218} 450}
219 451
220=item $coro = cf::coro { BLOCK } 452=item $coro = cf::async_ext { BLOCK }
221 453
222Creates and returns a new coro. This coro is automcatially being canceled 454Like async, but this coro is automatically being canceled when the
223when the extension calling this is being unloaded. 455extension calling this is being unloaded.
224 456
225=cut 457=cut
226 458
227sub coro(&) { 459sub async_ext(&) {
228 my $cb = shift; 460 my $cb = shift;
229 461
230 my $coro; $coro = async { 462 my $coro = &Coro::async ($cb);
231 eval {
232 $cb->();
233 };
234 warn $@ if $@;
235 };
236 463
237 $coro->on_destroy (sub { 464 $coro->on_destroy (sub {
238 delete $EXT_CORO{$coro+0}; 465 delete $EXT_CORO{$coro+0};
239 }); 466 });
240 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
241 468
242 $coro 469 $coro
243} 470}
244 471
472=item fork_call { }, $args
473
474Executes the given code block with the given arguments in a seperate
475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
478
479=cut
480
481sub fork_call(&@) {
482 my ($cb, @args) = @_;
483
484 # we seemingly have to make a local copy of the whole thing,
485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
487
488 my @res = Coro::Util::fork_eval {
489 reset_signals;
490 &$cb
491 }, @args;
492
493 wantarray ? @res : $res[-1]
494}
495
496=item $value = cf::db_get $family => $key
497
498Returns a single value from the environment database.
499
500=item cf::db_put $family => $key => $value
501
502Stores the given C<$value> in the family. It can currently store binary
503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
504
505=cut
506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
610}
611
612=item cf::datalog type => key => value, ...
613
614Log a datalog packet of the given type with the given key-value pairs.
615
616=cut
617
618sub datalog($@) {
619 my ($type, %kv) = @_;
620 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
621}
622
245=back 623=back
246 624
247=cut 625=cut
248 626
249############################################################################# 627#############################################################################
254attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
255to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
256 634
257In the following description, CLASS can be any of C<global>, C<object> 635In the following description, CLASS can be any of C<global>, C<object>
258C<player>, C<client> or C<map> (i.e. the attachable objects in 636C<player>, C<client> or C<map> (i.e. the attachable objects in
259crossfire+). 637Crossfire TRT).
260 638
261=over 4 639=over 4
262 640
263=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
264 642
378our @CB_TYPE = (); # registry for type (cf-object class) based events 756our @CB_TYPE = (); # registry for type (cf-object class) based events
379our @CB_MAP = (); 757our @CB_MAP = ();
380 758
381my %attachment; 759my %attachment;
382 760
761sub cf::attachable::thawer_merge {
762 # simply override everything except _meta
763 local $_[0]{_meta};
764 %{$_[0]} = %{$_[1]};
765}
766
383sub _attach_cb($$$$) { 767sub _attach_cb($$$$) {
384 my ($registry, $event, $prio, $cb) = @_; 768 my ($registry, $event, $prio, $cb) = @_;
385 769
386 use sort 'stable'; 770 use sort 'stable';
387 771
421 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
422 806
423 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
424 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
425 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
426 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
427 811
428 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
429 my $pkg = shift @arg; 813 my $pkg = shift @arg;
430 814
431 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
460 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
461 } 845 }
462 846
463 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
464 } else { 848 } else {
465 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
466 } 850 }
467 851
468 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
469} 853}
470 854
472 if (ref $_[0]) { 856 if (ref $_[0]) {
473 _object_attach @_; 857 _object_attach @_;
474 } else { 858 } else {
475 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
476 } 860 }
861 _recalc_want;
477}; 862};
478 863
479# all those should be optimised 864# all those should be optimised
480sub cf::attachable::detach { 865sub cf::attachable::detach {
481 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
484 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
485 reattach ($obj); 870 reattach ($obj);
486 } else { 871 } else {
487 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
488 } 873 }
874 _recalc_want;
489}; 875};
490 876
491sub cf::attachable::attached { 877sub cf::attachable::attached {
492 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
493 879
508 "; 894 ";
509 die if $@; 895 die if $@;
510} 896}
511 897
512our $override; 898our $override;
513our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
514 900
515sub override { 901sub override {
516 $override = 1; 902 $override = 1;
517 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
518} 904}
519 905
520sub do_invoke { 906sub do_invoke {
521 my $event = shift; 907 my $event = shift;
522 my $callbacks = shift; 908 my $callbacks = shift;
523 909
524 @invoke_results = (); 910 @INVOKE_RESULTS = ();
525 911
526 local $override; 912 local $override;
527 913
528 for (@$callbacks) { 914 for (@$callbacks) {
529 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
546 932
547Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
548 934
549This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
550removed in future versions), and there is no public API to access override 936removed in future versions), and there is no public API to access override
551results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
552 938
553=back 939=back
554 940
555=cut 941=cut
556 942
557############################################################################# 943#############################################################################
558# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
559 956
560sub reattach { 957sub reattach {
561 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
562 my ($obj) = @_; 959 my ($obj) = @_;
960
961 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
563 962
564 my $registry = $obj->registry; 963 my $registry = $obj->registry;
565 964
566 @$registry = (); 965 @$registry = ();
567 966
614 $filename, length $$rdata, scalar @$objs; 1013 $filename, length $$rdata, scalar @$objs;
615 1014
616 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
617 chmod SAVE_MODE, $fh; 1016 chmod SAVE_MODE, $fh;
618 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
619 aio_fsync $fh; 1018 aio_fsync $fh if $cf::USE_FSYNC;
620 close $fh; 1019 close $fh;
621 1020
622 if (@$objs) { 1021 if (@$objs) {
623 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1022 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
624 chmod SAVE_MODE, $fh; 1023 chmod SAVE_MODE, $fh;
625 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
626 aio_write $fh, 0, (length $data), $data, 0; 1025 aio_write $fh, 0, (length $data), $data, 0;
627 aio_fsync $fh; 1026 aio_fsync $fh if $cf::USE_FSYNC;
628 close $fh; 1027 close $fh;
629 aio_rename "$filename.pst~", "$filename.pst"; 1028 aio_rename "$filename.pst~", "$filename.pst";
630 } 1029 }
631 } else { 1030 } else {
632 aio_unlink "$filename.pst"; 1031 aio_unlink "$filename.pst";
660 or return; 1059 or return;
661 1060
662 unless (aio_stat "$filename.pst") { 1061 unless (aio_stat "$filename.pst") {
663 (aio_load "$filename.pst", $av) >= 0 1062 (aio_load "$filename.pst", $av) >= 0
664 or return; 1063 or return;
665 $av = eval { (Storable::thaw <$av>)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
666 } 1065 }
667 1066
1067 warn sprintf "loading %s (%d)\n",
1068 $filename, length $data, scalar @{$av || []};
668 return ($data, $av); 1069 return ($data, $av);
669} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
670 1077
671############################################################################# 1078#############################################################################
672# command handling &c 1079# command handling &c
673 1080
674=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
687 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
688} 1095}
689 1096
690=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
691 1098
692Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
693 1104
694If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
695called. 1106called.
696 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
697=cut 1119=cut
698 1120
699sub register_extcmd { 1121sub register_extcmd {
700 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
701 1123
702 my $caller = caller;
703 #warn "registering extcmd '$name' to '$caller'";
704
705 $EXTCMD{$name} = [$cb, $caller]; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
706} 1131}
707 1132
708cf::player->attach ( 1133cf::player->attach (
709 on_command => sub { 1134 on_command => sub {
710 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
719 cf::override; 1144 cf::override;
720 }, 1145 },
721 on_extcmd => sub { 1146 on_extcmd => sub {
722 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
723 1148
724 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
725 1150
726 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
727 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
728 if (my %reply = $cb->[0]->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
729 $pl->ext_reply ($msg->{msgid}, %reply);
730 }
731 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
732 } else { 1166 } else {
733 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
734 } 1168 }
735 1169
736 cf::override; 1170 cf::override;
737 }, 1171 },
738); 1172);
739 1173
1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
1178 for my $path (<$LIBDIR/*.ext>) {
1179 next unless -r $path;
1180
1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
1238 }
1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
1244 };
1245}
1246
1247#############################################################################
1248
1249=back
1250
1251=head2 CORE EXTENSIONS
1252
1253Functions and methods that extend core crossfire objects.
1254
1255=cut
1256
1257package cf::player;
1258
1259use Coro::AIO;
1260
1261=head3 cf::player
1262
1263=over 4
1264
1265=item cf::player::find $login
1266
1267Returns the given player object, loading it if necessary (might block).
1268
1269=cut
1270
1271sub playerdir($) {
1272 "$PLAYERDIR/"
1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1274}
1275
1276sub path($) {
1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1278
1279 (playerdir $login) . "/playerdata"
1280}
1281
1282sub find_active($) {
1283 $cf::PLAYER{$_[0]}
1284 and $cf::PLAYER{$_[0]}->active
1285 and $cf::PLAYER{$_[0]}
1286}
1287
1288sub exists($) {
1289 my ($login) = @_;
1290
1291 $cf::PLAYER{$login}
1292 or cf::sync_job { !aio_stat path $login }
1293}
1294
1295sub find($) {
1296 return $cf::PLAYER{$_[0]} || do {
1297 my $login = $_[0];
1298
1299 my $guard = cf::lock_acquire "user_find:$login";
1300
1301 $cf::PLAYER{$_[0]} || do {
1302 # rename old playerfiles to new ones
1303 #TODO: remove when no longer required
1304 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1305 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1306 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1307 aio_unlink +(playerdir $login) . "/$login.pl";
1308
1309 my $pl = load_pl path $login
1310 or return;
1311 $cf::PLAYER{$login} = $pl
1312 }
1313 }
1314}
1315
1316sub save($) {
1317 my ($pl) = @_;
1318
1319 return if $pl->{deny_save};
1320
1321 my $path = path $pl;
1322 my $guard = cf::lock_acquire "user_save:$path";
1323
1324 return if $pl->{deny_save};
1325
1326 aio_mkdir playerdir $pl, 0770;
1327 $pl->{last_save} = $cf::RUNTIME;
1328
1329 $pl->save_pl ($path);
1330 cf::cede_to_tick;
1331}
1332
1333sub new($) {
1334 my ($login) = @_;
1335
1336 my $self = create;
1337
1338 $self->ob->name ($login);
1339 $self->{deny_save} = 1;
1340
1341 $cf::PLAYER{$login} = $self;
1342
1343 $self
1344}
1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1354}
1355
1356=item $pl->quit_character
1357
1358Nukes the player without looking back. If logged in, the connection will
1359be destroyed. May block for a long time.
1360
1361=cut
1362
1363sub quit_character {
1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1367
1368 $pl->{deny_save} = 1;
1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1370
1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1372 $pl->deactivate;
1373 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1374 $pl->ns->destroy if $pl->ns;
1375
1376 my $path = playerdir $pl;
1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1378 aio_rename $path, $temp;
1379 delete $cf::PLAYER{$pl->ob->name};
1380 $pl->destroy;
1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1387 IO::AIO::aio_rmtree $temp;
1388}
1389
1390=item $pl->kick
1391
1392Kicks a player out of the game. This destroys the connection.
1393
1394=cut
1395
1396sub kick {
1397 my ($pl, $kicker) = @_;
1398
1399 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1400 $pl->killer ("kicked");
1401 $pl->ns->destroy;
1402}
1403
1404=item cf::player::list_logins
1405
1406Returns am arrayref of all valid playernames in the system, can take a
1407while and may block, so not sync_job-capable, ever.
1408
1409=cut
1410
1411sub list_logins {
1412 my $dirs = aio_readdir $PLAYERDIR
1413 or return [];
1414
1415 my @logins;
1416
1417 for my $login (@$dirs) {
1418 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1419 aio_read $fh, 0, 512, my $buf, 0 or next;
1420 $buf !~ /^password -------------$/m or next; # official not-valid tag
1421
1422 utf8::decode $login;
1423 push @logins, $login;
1424 }
1425
1426 \@logins
1427}
1428
1429=item $player->maps
1430
1431Returns an arrayref of map paths that are private for this
1432player. May block.
1433
1434=cut
1435
1436sub maps($) {
1437 my ($pl) = @_;
1438
1439 $pl = ref $pl ? $pl->ob->name : $pl;
1440
1441 my $files = aio_readdir playerdir $pl
1442 or return;
1443
1444 my @paths;
1445
1446 for (@$files) {
1447 utf8::decode $_;
1448 next if /\.(?:pl|pst)$/;
1449 next unless /^$PATH_SEP/o;
1450
1451 push @paths, cf::map::normalise "~$pl/$_";
1452 }
1453
1454 \@paths
1455}
1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1507=item $player->ext_reply ($msgid, @msg)
1508
1509Sends an ext reply to the player.
1510
1511=cut
1512
1513sub ext_reply($$@) {
1514 my ($self, $id, @msg) = @_;
1515
1516 $self->ns->ext_reply ($id, @msg)
1517}
1518
1519=item $player->ext_msg ($type, @msg)
1520
1521Sends an ext event to the client.
1522
1523=cut
1524
1525sub ext_msg($$@) {
1526 my ($self, $type, @msg) = @_;
1527
1528 $self->ns->ext_msg ($type, @msg);
1529}
1530
1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
1546 my ($path) = @_;
1547
1548 my ($match, $specificity);
1549
1550 for my $region (list) {
1551 if ($region->{match} && $path =~ $region->{match}) {
1552 ($match, $specificity) = ($region, $region->specificity)
1553 if $region->specificity > $specificity;
1554 }
1555 }
1556
1557 $match
1558}
1559
1560=back
1561
1562=head3 cf::map
1563
1564=over 4
1565
1566=cut
1567
1568package cf::map;
1569
1570use Fcntl;
1571use Coro::AIO;
1572
1573use overload
1574 '""' => \&as_string,
1575 fallback => 1;
1576
1577our $MAX_RESET = 3600;
1578our $DEFAULT_RESET = 3000;
1579
1580sub generate_random_map {
1581 my ($self, $rmp) = @_;
1582 # mit "rum" bekleckern, nicht
1583 $self->_create_random_map (
1584 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1585 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1586 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1587 $rmp->{exit_on_final_map},
1588 $rmp->{xsize}, $rmp->{ysize},
1589 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1590 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1591 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1592 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1593 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1594 (cf::region::find $rmp->{region}), $rmp->{custom}
1595 )
1596}
1597
1598=item cf::map->register ($regex, $prio)
1599
1600Register a handler for the map path matching the given regex at the
1601givne priority (higher is better, built-in handlers have priority 0, the
1602default).
1603
1604=cut
1605
740sub register { 1606sub register {
1607 my (undef, $regex, $prio) = @_;
1608 my $pkg = caller;
1609
1610 no strict;
1611 push @{"$pkg\::ISA"}, __PACKAGE__;
1612
1613 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1614}
1615
1616# also paths starting with '/'
1617$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1618
1619sub thawer_merge {
741 my ($base, $pkg) = @_; 1620 my ($self, $merge) = @_;
742 1621
743 #TODO 1622 # we have to keep some variables in memory intact
744} 1623 local $self->{path};
1624 local $self->{load_path};
745 1625
746sub load_extension { 1626 $self->SUPER::thawer_merge ($merge);
1627}
1628
1629sub normalise {
747 my ($path) = @_; 1630 my ($path, $base) = @_;
748 1631
749 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1632 $path = "$path"; # make sure its a string
750 my $base = $1;
751 my $pkg = $1;
752 $pkg =~ s/[^[:word:]]/_/g;
753 $pkg = "ext::$pkg";
754 1633
755 warn "loading '$path' into '$pkg'\n"; 1634 $path =~ s/\.map$//;
756 1635
757 open my $fh, "<:utf8", $path 1636 # map plan:
758 or die "$path: $!"; 1637 #
1638 # /! non-realised random map exit (special hack!)
1639 # {... are special paths that are not being touched
1640 # ?xxx/... are special absolute paths
1641 # ?random/... random maps
1642 # /... normal maps
1643 # ~user/... per-player map of a specific user
759 1644
760 my $source = 1645 $path =~ s/$PATH_SEP/\//go;
761 "package $pkg; use strict; use utf8;\n"
762 . "#line 1 \"$path\"\n{\n"
763 . (do { local $/; <$fh> })
764 . "\n};\n1";
765 1646
766 eval $source 1647 # treat it as relative path if it starts with
767 or die $@ ? "$path: $@\n" 1648 # something that looks reasonable
768 : "extension disabled.\n"; 1649 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1650 $base or Carp::carp "normalise called with relative path and no base: '$path'";
769 1651
770 push @exts, $pkg; 1652 $base =~ s{[^/]+/?$}{};
771 $ext_pkg{$base} = $pkg; 1653 $path = "$base/$path";
772
773# no strict 'refs';
774# @{"$pkg\::ISA"} = ext::;
775
776 register $base, $pkg;
777}
778
779sub unload_extension {
780 my ($pkg) = @_;
781
782 warn "removing extension $pkg\n";
783
784 # remove hooks
785 #TODO
786# for my $idx (0 .. $#PLUGIN_EVENT) {
787# delete $hook[$idx]{$pkg};
788# } 1654 }
789 1655
790 # remove commands 1656 for ($path) {
791 for my $name (keys %COMMAND) { 1657 redo if s{//}{/};
792 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1658 redo if s{/\.?/}{/};
1659 redo if s{/[^/]+/\.\./}{/};
1660 }
793 1661
794 if (@cb) { 1662 $path
795 $COMMAND{$name} = \@cb; 1663}
1664
1665sub new_from_path {
1666 my (undef, $path, $base) = @_;
1667
1668 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1669
1670 $path = normalise $path, $base;
1671
1672 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1673 if ($path =~ $EXT_MAP{$pkg}[1]) {
1674 my $self = bless cf::map::new, $pkg;
1675 $self->{path} = $path; $self->path ($path);
1676 $self->init; # pass $1 etc.
1677 return $self;
1678 }
1679 }
1680
1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1682 ()
1683}
1684
1685sub init {
1686 my ($self) = @_;
1687
1688 $self
1689}
1690
1691sub as_string {
1692 my ($self) = @_;
1693
1694 "$self->{path}"
1695}
1696
1697# the displayed name, this is a one way mapping
1698sub visible_name {
1699 &as_string
1700}
1701
1702# the original (read-only) location
1703sub load_path {
1704 my ($self) = @_;
1705
1706 "$MAPDIR/$self->{path}.map"
1707}
1708
1709# the temporary/swap location
1710sub save_path {
1711 my ($self) = @_;
1712
1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1714 "$TMPDIR/$path.map"
1715}
1716
1717# the unique path, undef == no special unique path
1718sub uniq_path {
1719 my ($self) = @_;
1720
1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1722 "$UNIQUEDIR/$path"
1723}
1724
1725# and all this just because we cannot iterate over
1726# all maps in C++...
1727sub change_all_map_light {
1728 my ($change) = @_;
1729
1730 $_->change_map_light ($change)
1731 for grep $_->outdoor, values %cf::MAP;
1732}
1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1740}
1741
1742sub unlink_save {
1743 my ($self) = @_;
1744
1745 utf8::encode (my $save = $self->save_path);
1746 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1748}
1749
1750sub load_header_from($) {
1751 my ($self, $path) = @_;
1752
1753 utf8::encode $path;
1754 #aio_open $path, O_RDONLY, 0
1755 # or return;
1756
1757 $self->_load_header ($path)
1758 or return;
1759
1760 $self->{load_path} = $path;
1761
1762 1
1763}
1764
1765sub load_header_orig {
1766 my ($self) = @_;
1767
1768 $self->load_header_from ($self->load_path)
1769}
1770
1771sub load_header_temp {
1772 my ($self) = @_;
1773
1774 $self->load_header_from ($self->save_path)
1775}
1776
1777sub prepare_temp {
1778 my ($self) = @_;
1779
1780 $self->last_access ((delete $self->{last_access})
1781 || $cf::RUNTIME); #d#
1782 # safety
1783 $self->{instantiate_time} = $cf::RUNTIME
1784 if $self->{instantiate_time} > $cf::RUNTIME;
1785}
1786
1787sub prepare_orig {
1788 my ($self) = @_;
1789
1790 $self->{load_original} = 1;
1791 $self->{instantiate_time} = $cf::RUNTIME;
1792 $self->last_access ($cf::RUNTIME);
1793 $self->instantiate;
1794}
1795
1796sub load_header {
1797 my ($self) = @_;
1798
1799 if ($self->load_header_temp) {
1800 $self->prepare_temp;
796 } else { 1801 } else {
797 delete $COMMAND{$name}; 1802 $self->load_header_orig
798 } 1803 or return;
1804 $self->prepare_orig;
1805 }
1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1812
799 } 1813 1
1814}
800 1815
801 # remove extcmds 1816sub find;
802 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1817sub find {
803 delete $EXTCMD{$name}; 1818 my ($path, $origin) = @_;
1819
1820 $path = normalise $path, $origin && $origin->path;
1821
1822 cf::lock_wait "map_find:$path";
1823
1824 $cf::MAP{$path} || do {
1825 my $guard = cf::lock_acquire "map_find:$path";
1826 my $map = new_from_path cf::map $path
1827 or return;
1828
1829 $map->{last_save} = $cf::RUNTIME;
1830
1831 $map->load_header
1832 or return;
1833
1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1835 # doing this can freeze the server in a sync job, obviously
1836 #$cf::WAIT_FOR_TICK->wait;
1837 $map->reset;
1838 undef $guard;
1839 return find $path;
1840 }
1841
1842 $cf::MAP{$path} = $map
1843 }
1844}
1845
1846sub pre_load { }
1847sub post_load { }
1848
1849sub load {
1850 my ($self) = @_;
1851
1852 local $self->{deny_reset} = 1; # loading can take a long time
1853
1854 my $path = $self->{path};
1855
804 } 1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1858 my $guard2 = cf::lock_acquire "map_load:$path";
805 1859
806 if (my $cb = $pkg->can ("unload")) { 1860 return if $self->in_memory != cf::MAP_SWAPPED;
807 eval { 1861
808 $cb->($pkg); 1862 $self->in_memory (cf::MAP_LOADING);
1863
1864 $self->alloc;
1865
1866 $self->pre_load;
1867 cf::cede_to_tick;
1868
1869 $self->_load_objects ($self->{load_path}, 1)
1870 or return;
1871
1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1873 if delete $self->{load_original};
1874
1875 if (my $uniq = $self->uniq_path) {
1876 utf8::encode $uniq;
1877 if (aio_open $uniq, O_RDONLY, 0) {
1878 $self->clear_unique_items;
1879 $self->_load_objects ($uniq, 0);
809 1 1880 }
810 } or warn "$pkg unloaded, but with errors: $@"; 1881 }
811 }
812 1882
813 Symbol::delete_package $pkg; 1883 cf::cede_to_tick;
814} 1884 # now do the right thing for maps
1885 $self->link_multipart_objects;
1886 $self->difficulty ($self->estimate_difficulty)
1887 unless $self->difficulty;
1888 cf::cede_to_tick;
815 1889
816sub load_extensions { 1890 unless ($self->{deny_activate}) {
817 for my $ext (<$LIBDIR/*.ext>) { 1891 $self->decay_objects;
818 next unless -r $ext; 1892 $self->fix_auto_apply;
819 eval { 1893 $self->update_buttons;
820 load_extension $ext; 1894 cf::cede_to_tick;
821 1 1895 $self->set_darkness_map;
822 } or warn "$ext not loaded: $@"; 1896 cf::cede_to_tick;
823 } 1897 $self->activate;
824} 1898 }
825 1899
826############################################################################# 1900 $self->{last_save} = $cf::RUNTIME;
827# load/save/clean perl data associated with a map 1901 $self->last_access ($cf::RUNTIME);
828 1902
829*cf::mapsupport::on_clean = sub { 1903 $self->in_memory (cf::MAP_IN_MEMORY);
1904 }
1905
1906 $self->post_load;
1907}
1908
1909sub customise_for {
1910 my ($self, $ob) = @_;
1911
1912 return find "~" . $ob->name . "/" . $self->{path}
1913 if $self->per_player;
1914
1915# return find "?party/" . $ob->name . "/" . $self->{path}
1916# if $self->per_party;
1917
1918 $self
1919}
1920
1921# find and load all maps in the 3x3 area around a map
1922sub load_neighbours {
830 my ($map) = @_; 1923 my ($map) = @_;
831 1924
832 my $path = $map->tmpname; 1925 my @neigh; # diagonal neighbours
833 defined $path or return;
834 1926
835 unlink "$path.pst"; 1927 for (0 .. 3) {
836}; 1928 my $neigh = $map->tile_path ($_)
1929 or next;
1930 $neigh = find $neigh, $map
1931 or next;
1932 $neigh->load;
837 1933
838cf::map->attach (prio => -10000, package => cf::mapsupport::); 1934 push @neigh,
1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1937 }
839 1938
840############################################################################# 1939 for (grep defined $_->[0], @neigh) {
841# load/save perl data associated with player->ob objects 1940 my ($path, $origin) = @$_;
842 1941 my $neigh = find $path, $origin
843sub all_objects(@) { 1942 or next;
844 @_, map all_objects ($_->inv), @_ 1943 $neigh->load;
1944 }
845} 1945}
846 1946
847# TODO: compatibility cruft, remove when no longer needed 1947sub find_sync {
848cf::player->attach ( 1948 my ($path, $origin) = @_;
849 on_load => sub {
850 my ($pl, $path) = @_;
851 1949
852 for my $o (all_objects $pl->ob) { 1950 cf::sync_job { find $path, $origin }
853 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1951}
854 $o->set_ob_key_value ("_perl_data");
855 1952
856 %$o = %{ Storable::thaw pack "H*", $value }; 1953sub do_load_sync {
1954 my ($map) = @_;
1955
1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1957 if $Coro::current == $Coro::main;
1958
1959 cf::sync_job { $map->load };
1960}
1961
1962our %MAP_PREFETCH;
1963our $MAP_PREFETCHER = undef;
1964
1965sub find_async {
1966 my ($path, $origin, $load) = @_;
1967
1968 $path = normalise $path, $origin && $origin->{path};
1969
1970 if (my $map = $cf::MAP{$path}) {
1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1972 }
1973
1974 $MAP_PREFETCH{$path} |= $load;
1975
1976 $MAP_PREFETCHER ||= cf::async {
1977 while (%MAP_PREFETCH) {
1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1979 if (my $map = find $k) {
1980 $map->load if $v;
1981 }
1982
1983 delete $MAP_PREFETCH{$k};
857 } 1984 }
858 } 1985 }
1986 undef $MAP_PREFETCHER;
1987 };
1988 $MAP_PREFETCHER->prio (6);
1989
1990 ()
1991}
1992
1993sub save {
1994 my ($self) = @_;
1995
1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1997
1998 $self->{last_save} = $cf::RUNTIME;
1999
2000 return unless $self->dirty;
2001
2002 my $save = $self->save_path; utf8::encode $save;
2003 my $uniq = $self->uniq_path; utf8::encode $uniq;
2004
2005 $self->{load_path} = $save;
2006
2007 return if $self->{deny_save};
2008
2009 local $self->{last_access} = $self->last_access;#d#
2010
2011 cf::async {
2012 $_->contr->save for $self->players;
2013 };
2014
2015 if ($uniq) {
2016 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2017 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2018 } else {
2019 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
859 }, 2020 }
860); 2021}
861 2022
862############################################################################# 2023sub swap_out {
2024 my ($self) = @_;
863 2025
864=head2 CORE EXTENSIONS 2026 # save first because save cedes
2027 $self->save;
865 2028
866Functions and methods that extend core crossfire objects. 2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
867 2030
868=head3 cf::player 2031 return if $self->players;
2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
2033 return if $self->{deny_save};
2034
2035 $self->clear;
2036 $self->in_memory (cf::MAP_SWAPPED);
2037}
2038
2039sub reset_at {
2040 my ($self) = @_;
2041
2042 # TODO: safety, remove and allow resettable per-player maps
2043 return 1e99 if $self->{deny_reset};
2044
2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2047
2048 $time + $to
2049}
2050
2051sub should_reset {
2052 my ($self) = @_;
2053
2054 $self->reset_at <= $cf::RUNTIME
2055}
2056
2057sub reset {
2058 my ($self) = @_;
2059
2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
2061
2062 return if $self->players;
2063
2064 warn "resetting map ", $self->path;
2065
2066 $self->in_memory (cf::MAP_SWAPPED);
2067
2068 # need to save uniques path
2069 unless ($self->{deny_save}) {
2070 my $uniq = $self->uniq_path; utf8::encode $uniq;
2071
2072 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2073 if $uniq;
2074 }
2075
2076 delete $cf::MAP{$self->path};
2077
2078 $self->clear;
2079
2080 $_->clear_links_to ($self) for values %cf::MAP;
2081
2082 $self->unlink_save;
2083 $self->destroy;
2084}
2085
2086my $nuke_counter = "aaaa";
2087
2088sub nuke {
2089 my ($self) = @_;
2090
2091 {
2092 my $lock = cf::lock_acquire "map_data:$self->{path}";
2093
2094 delete $cf::MAP{$self->path};
2095
2096 $self->unlink_save;
2097
2098 bless $self, "cf::map";
2099 delete $self->{deny_reset};
2100 $self->{deny_save} = 1;
2101 $self->reset_timeout (1);
2102 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2103
2104 $cf::MAP{$self->path} = $self;
2105 }
2106
2107 $self->reset; # polite request, might not happen
2108}
2109
2110=item $maps = cf::map::tmp_maps
2111
2112Returns an arrayref with all map paths of currently instantiated and saved
2113maps. May block.
2114
2115=cut
2116
2117sub tmp_maps() {
2118 [
2119 map {
2120 utf8::decode $_;
2121 /\.map$/
2122 ? normalise $_
2123 : ()
2124 } @{ aio_readdir $TMPDIR or [] }
2125 ]
2126}
2127
2128=item $maps = cf::map::random_maps
2129
2130Returns an arrayref with all map paths of currently instantiated and saved
2131random maps. May block.
2132
2133=cut
2134
2135sub random_maps() {
2136 [
2137 map {
2138 utf8::decode $_;
2139 /\.map$/
2140 ? normalise "?random/$_"
2141 : ()
2142 } @{ aio_readdir $RANDOMDIR or [] }
2143 ]
2144}
2145
2146=item cf::map::unique_maps
2147
2148Returns an arrayref of paths of all shared maps that have
2149instantiated unique items. May block.
2150
2151=cut
2152
2153sub unique_maps() {
2154 [
2155 map {
2156 utf8::decode $_;
2157 /\.map$/
2158 ? normalise $_
2159 : ()
2160 } @{ aio_readdir $UNIQUEDIR or [] }
2161 ]
2162}
2163
2164package cf;
2165
2166=back
2167
2168=head3 cf::object
2169
2170=cut
2171
2172package cf::object;
869 2173
870=over 4 2174=over 4
871 2175
872=item cf::player::exists $login 2176=item $ob->inv_recursive
873 2177
874Returns true when the given account exists. 2178Returns the inventory of the object _and_ their inventories, recursively.
875 2179
876=cut 2180=cut
877 2181
878sub cf::player::exists($) { 2182sub inv_recursive_;
879 cf::player::find $_[0] 2183sub inv_recursive_ {
880 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2184 map { $_, inv_recursive_ $_->inv } @_
881} 2185}
882 2186
883=item $player->ext_reply ($msgid, $msgtype, %msg) 2187sub inv_recursive {
884 2188 inv_recursive_ inv $_[0]
885Sends an ext reply to the player.
886
887=cut
888
889sub cf::player::ext_reply($$$%) {
890 my ($self, $id, %msg) = @_;
891
892 $msg{msgid} = $id;
893
894 $self->send ("ext " . to_json \%msg);
895} 2189}
2190
2191package cf;
896 2192
897=back 2193=back
898 2194
899=head3 cf::object::player 2195=head3 cf::object::player
900 2196
916 2212
917 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2213 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
918 2214
919 if ($self->{record_replies}) { 2215 if ($self->{record_replies}) {
920 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2216 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2217
921 } else { 2218 } else {
2219 my $pl = $self->contr;
2220
2221 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2222 my $dialog = $pl->{npc_dialog};
2223 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2224
2225 } else {
922 $msg = $npc->name . " says: $msg" if $npc; 2226 $msg = $npc->name . " says: $msg" if $npc;
923 $self->message ($msg, $flags); 2227 $self->message ($msg, $flags);
2228 }
924 } 2229 }
2230}
2231
2232=item $object->send_msg ($channel, $msg, $color, [extra...])
2233
2234=cut
2235
2236sub cf::object::send_msg {
2237 my $pl = shift->contr
2238 or return;
2239 $pl->send_msg (@_);
925} 2240}
926 2241
927=item $player_object->may ("access") 2242=item $player_object->may ("access")
928 2243
929Returns wether the given player is authorized to access resource "access" 2244Returns wether the given player is authorized to access resource "access"
938 (ref $cf::CFG{"may_$access"} 2253 (ref $cf::CFG{"may_$access"}
939 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2254 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
940 : $cf::CFG{"may_$access"}) 2255 : $cf::CFG{"may_$access"})
941} 2256}
942 2257
2258=item $player_object->enter_link
2259
2260Freezes the player and moves him/her to a special map (C<{link}>).
2261
2262The player should be reasonably safe there for short amounts of time. You
2263I<MUST> call C<leave_link> as soon as possible, though.
2264
2265Will never block.
2266
2267=item $player_object->leave_link ($map, $x, $y)
2268
2269Moves the player out of the special C<{link}> map onto the specified
2270map. If the map is not valid (or omitted), the player will be moved back
2271to the location he/she was before the call to C<enter_link>, or, if that
2272fails, to the emergency map position.
2273
2274Might block.
2275
2276=cut
2277
2278sub link_map {
2279 unless ($LINK_MAP) {
2280 $LINK_MAP = cf::map::find "{link}"
2281 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2282 $LINK_MAP->load;
2283 }
2284
2285 $LINK_MAP
2286}
2287
2288sub cf::object::player::enter_link {
2289 my ($self) = @_;
2290
2291 $self->deactivate_recursive;
2292
2293 return if UNIVERSAL::isa $self->map, "ext::map_link";
2294
2295 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2296 if $self->map && $self->map->{path} ne "{link}";
2297
2298 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2299}
2300
2301sub cf::object::player::leave_link {
2302 my ($self, $map, $x, $y) = @_;
2303
2304 return unless $self->contr->active;
2305
2306 my $link_pos = delete $self->{_link_pos};
2307
2308 unless ($map) {
2309 # restore original map position
2310 ($map, $x, $y) = @{ $link_pos || [] };
2311 $map = cf::map::find $map;
2312
2313 unless ($map) {
2314 ($map, $x, $y) = @$EMERGENCY_POSITION;
2315 $map = cf::map::find $map
2316 or die "FATAL: cannot load emergency map\n";
2317 }
2318 }
2319
2320 ($x, $y) = (-1, -1)
2321 unless (defined $x) && (defined $y);
2322
2323 # use -1 or undef as default coordinates, not 0, 0
2324 ($x, $y) = ($map->enter_x, $map->enter_y)
2325 if $x <=0 && $y <= 0;
2326
2327 $map->load;
2328 $map->load_neighbours;
2329
2330 return unless $self->contr->active;
2331 $self->activate_recursive;
2332
2333 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2334 $self->enter_map ($map, $x, $y);
2335}
2336
2337=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2338
2339Moves the player to the given map-path and coordinates by first freezing
2340her, loading and preparing them map, calling the provided $check callback
2341that has to return the map if sucecssful, and then unfreezes the player on
2342the new (success) or old (failed) map position. In either case, $done will
2343be called at the end of this process.
2344
2345=cut
2346
2347our $GOTOGEN;
2348
2349sub cf::object::player::goto {
2350 my ($self, $path, $x, $y, $check, $done) = @_;
2351
2352 # do generation counting so two concurrent goto's will be executed in-order
2353 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2354
2355 $self->enter_link;
2356
2357 (async {
2358 my $map = eval {
2359 my $map = cf::map::find $path;
2360
2361 if ($map) {
2362 $map = $map->customise_for ($self);
2363 $map = $check->($map) if $check && $map;
2364 } else {
2365 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2366 }
2367
2368 $map
2369 };
2370
2371 if ($@) {
2372 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2373 LOG llevError | logBacktrace, Carp::longmess $@;
2374 }
2375
2376 if ($gen == $self->{_goto_generation}) {
2377 delete $self->{_goto_generation};
2378 $self->leave_link ($map, $x, $y);
2379 }
2380
2381 $done->() if $done;
2382 })->prio (1);
2383}
2384
2385=item $player_object->enter_exit ($exit_object)
2386
2387=cut
2388
2389sub parse_random_map_params {
2390 my ($spec) = @_;
2391
2392 my $rmp = { # defaults
2393 xsize => (cf::rndm 15, 40),
2394 ysize => (cf::rndm 15, 40),
2395 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2396 #layout => string,
2397 };
2398
2399 for (split /\n/, $spec) {
2400 my ($k, $v) = split /\s+/, $_, 2;
2401
2402 $rmp->{lc $k} = $v if (length $k) && (length $v);
2403 }
2404
2405 $rmp
2406}
2407
2408sub prepare_random_map {
2409 my ($exit) = @_;
2410
2411 my $guard = cf::lock_acquire "exit_prepare:$exit";
2412
2413 # all this does is basically replace the /! path by
2414 # a new random map path (?random/...) with a seed
2415 # that depends on the exit object
2416
2417 my $rmp = parse_random_map_params $exit->msg;
2418
2419 if ($exit->map) {
2420 $rmp->{region} = $exit->region->name;
2421 $rmp->{origin_map} = $exit->map->path;
2422 $rmp->{origin_x} = $exit->x;
2423 $rmp->{origin_y} = $exit->y;
2424 }
2425
2426 $rmp->{random_seed} ||= $exit->random_seed;
2427
2428 my $data = cf::to_json $rmp;
2429 my $md5 = Digest::MD5::md5_hex $data;
2430 my $meta = "$RANDOMDIR/$md5.meta";
2431
2432 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2433 aio_write $fh, 0, (length $data), $data, 0;
2434 undef $fh;
2435 aio_rename "$meta~", $meta;
2436
2437 $exit->slaying ("?random/$md5");
2438 $exit->msg (undef);
2439 }
2440}
2441
2442sub cf::object::player::enter_exit {
2443 my ($self, $exit) = @_;
2444
2445 return unless $self->type == cf::PLAYER;
2446
2447 if ($exit->slaying eq "/!") {
2448 #TODO: this should de-fi-ni-te-ly not be a sync-job
2449 # the problem is that $exit might not survive long enough
2450 # so it needs to be done right now, right here
2451 cf::sync_job { prepare_random_map $exit };
2452 }
2453
2454 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2455 my $hp = $exit->stats->hp;
2456 my $sp = $exit->stats->sp;
2457
2458 $self->enter_link;
2459
2460 # if exit is damned, update players death & WoR home-position
2461 $self->contr->savebed ($slaying, $hp, $sp)
2462 if $exit->flag (FLAG_DAMNED);
2463
2464 (async {
2465 $self->deactivate_recursive; # just to be sure
2466 unless (eval {
2467 $self->goto ($slaying, $hp, $sp);
2468
2469 1;
2470 }) {
2471 $self->message ("Something went wrong deep within the crossfire server. "
2472 . "I'll try to bring you back to the map you were before. "
2473 . "Please report this to the dungeon master!",
2474 cf::NDI_UNIQUE | cf::NDI_RED);
2475
2476 warn "ERROR in enter_exit: $@";
2477 $self->leave_link;
2478 }
2479 })->prio (1);
2480}
2481
943=head3 cf::client 2482=head3 cf::client
944 2483
945=over 4 2484=over 4
946 2485
947=item $client->send_drawinfo ($text, $flags) 2486=item $client->send_drawinfo ($text, $flags)
953 2492
954sub cf::client::send_drawinfo { 2493sub cf::client::send_drawinfo {
955 my ($self, $text, $flags) = @_; 2494 my ($self, $text, $flags) = @_;
956 2495
957 utf8::encode $text; 2496 utf8::encode $text;
958 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2497 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
959} 2498}
960 2499
2500=item $client->send_msg ($channel, $msg, $color, [extra...])
2501
2502Send a drawinfo or msg packet to the client, formatting the msg for the
2503client if neccessary. C<$type> should be a string identifying the type of
2504the message, with C<log> being the default. If C<$color> is negative, suppress
2505the message unless the client supports the msg packet.
2506
2507=cut
2508
2509our %CHANNEL = (
2510 "c/identify" => {
2511 id => "identify",
2512 title => "Identify",
2513 reply => undef,
2514 tooltip => "Items recently identified",
2515 },
2516);
2517
2518sub cf::client::send_msg {
2519 my ($self, $channel, $msg, $color, @extra) = @_;
2520
2521 $msg = $self->pl->expand_cfpod ($msg);
2522
2523 $color &= cf::NDI_CLIENT_MASK; # just in case...
2524
2525 # check predefined channels, for the benefit of C
2526 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2527
2528 if (ref $channel) {
2529 # send meta info to client, if not yet sent
2530 unless (exists $self->{channel}{$channel->{id}}) {
2531 $self->{channel}{$channel->{id}} = $channel;
2532 $self->ext_msg (channel_info => $channel);
2533 }
2534
2535 $channel = $channel->{id};
2536 }
2537
2538 return unless @extra || length $msg;
2539
2540 if ($self->can_msg) {
2541 # default colour, mask it out
2542 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2543 if $color & cf::NDI_DEF;
2544
2545 $self->send_packet ("msg " . $self->{json_coder}->encode (
2546 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2547 } else {
2548 if ($color >= 0) {
2549 # replace some tags by gcfclient-compatible ones
2550 for ($msg) {
2551 1 while
2552 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2553 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2554 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2555 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2556 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2557 }
2558
2559 $color &= cf::NDI_COLOR_MASK;
2560
2561 utf8::encode $msg;
2562
2563 if (0 && $msg =~ /\[/) {
2564 # COMMAND/INFO
2565 $self->send_packet ("drawextinfo $color 10 8 $msg")
2566 } else {
2567 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2568 $self->send_packet ("drawinfo $color $msg")
2569 }
2570 }
2571 }
2572}
2573
2574=item $client->ext_msg ($type, @msg)
2575
2576Sends an ext event to the client.
2577
2578=cut
2579
2580sub cf::client::ext_msg($$@) {
2581 my ($self, $type, @msg) = @_;
2582
2583 if ($self->extcmd == 2) {
2584 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2585 } elsif ($self->extcmd == 1) { # TODO: remove
2586 push @msg, msgtype => "event_$type";
2587 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2588 }
2589}
2590
2591=item $client->ext_reply ($msgid, @msg)
2592
2593Sends an ext reply to the client.
2594
2595=cut
2596
2597sub cf::client::ext_reply($$@) {
2598 my ($self, $id, @msg) = @_;
2599
2600 if ($self->extcmd == 2) {
2601 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2602 } elsif ($self->extcmd == 1) {
2603 #TODO: version 1, remove
2604 unshift @msg, msgtype => "reply", msgid => $id;
2605 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2606 }
2607}
961 2608
962=item $success = $client->query ($flags, "text", \&cb) 2609=item $success = $client->query ($flags, "text", \&cb)
963 2610
964Queues a query to the client, calling the given callback with 2611Queues a query to the client, calling the given callback with
965the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2612the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
966C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2613C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
967 2614
968Queries can fail, so check the return code. Or don't, as queries will become 2615Queries can fail, so check the return code. Or don't, as queries will
969reliable at some point in the future. 2616become reliable at some point in the future.
970 2617
971=cut 2618=cut
972 2619
973sub cf::client::query { 2620sub cf::client::query {
974 my ($self, $flags, $text, $cb) = @_; 2621 my ($self, $flags, $text, $cb) = @_;
982 utf8::encode $text; 2629 utf8::encode $text;
983 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2630 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
984 2631
985 $self->send_packet ($self->{query_queue}[0][0]) 2632 $self->send_packet ($self->{query_queue}[0][0])
986 if @{ $self->{query_queue} } == 1; 2633 if @{ $self->{query_queue} } == 1;
2634
2635 1
987} 2636}
988 2637
989cf::client->attach ( 2638cf::client->attach (
2639 on_connect => sub {
2640 my ($ns) = @_;
2641
2642 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2643 },
990 on_reply => sub { 2644 on_reply => sub {
991 my ($ns, $msg) = @_; 2645 my ($ns, $msg) = @_;
992 2646
993 # this weird shuffling is so that direct followup queries 2647 # this weird shuffling is so that direct followup queries
994 # get handled first 2648 # get handled first
995 my $queue = delete $ns->{query_queue}; 2649 my $queue = delete $ns->{query_queue}
2650 or return; # be conservative, not sure how that can happen, but we saw a crash here
996 2651
997 (shift @$queue)->[1]->($msg); 2652 (shift @$queue)->[1]->($msg);
2653 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
998 2654
999 push @{ $ns->{query_queue} }, @$queue; 2655 push @{ $ns->{query_queue} }, @$queue;
1000 2656
1001 if (@{ $ns->{query_queue} } == @$queue) { 2657 if (@{ $ns->{query_queue} } == @$queue) {
1002 if (@$queue) { 2658 if (@$queue) {
1004 } else { 2660 } else {
1005 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2661 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1006 } 2662 }
1007 } 2663 }
1008 }, 2664 },
2665 on_exticmd => sub {
2666 my ($ns, $buf) = @_;
2667
2668 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2669
2670 if (ref $msg) {
2671 my ($type, $reply, @payload) =
2672 "ARRAY" eq ref $msg
2673 ? @$msg
2674 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2675
2676 my @reply;
2677
2678 if (my $cb = $EXTICMD{$type}) {
2679 @reply = $cb->($ns, @payload);
2680 }
2681
2682 $ns->ext_reply ($reply, @reply)
2683 if $reply;
2684
2685 } else {
2686 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2687 }
2688
2689 cf::override;
2690 },
1009); 2691);
1010 2692
1011=item $client->coro (\&cb) 2693=item $client->async (\&cb)
1012 2694
1013Create a new coroutine, running the specified callback. The coroutine will 2695Create a new coroutine, running the specified callback. The coroutine will
1014be automatically cancelled when the client gets destroyed (e.g. on logout, 2696be automatically cancelled when the client gets destroyed (e.g. on logout,
1015or loss of connection). 2697or loss of connection).
1016 2698
1017=cut 2699=cut
1018 2700
1019sub cf::client::coro { 2701sub cf::client::async {
1020 my ($self, $cb) = @_; 2702 my ($self, $cb) = @_;
1021 2703
1022 my $coro; $coro = async { 2704 my $coro = &Coro::async ($cb);
1023 eval {
1024 $cb->();
1025 };
1026 warn $@ if $@;
1027 };
1028 2705
1029 $coro->on_destroy (sub { 2706 $coro->on_destroy (sub {
1030 delete $self->{_coro}{$coro+0}; 2707 delete $self->{_coro}{$coro+0};
1031 }); 2708 });
1032 2709
1059our $safe = new Safe "safe"; 2736our $safe = new Safe "safe";
1060our $safe_hole = new Safe::Hole; 2737our $safe_hole = new Safe::Hole;
1061 2738
1062$SIG{FPE} = 'IGNORE'; 2739$SIG{FPE} = 'IGNORE';
1063 2740
1064$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2741$safe->permit_only (Opcode::opset qw(
2742 :base_core :base_mem :base_orig :base_math
2743 grepstart grepwhile mapstart mapwhile
2744 sort time
2745));
1065 2746
1066# here we export the classes and methods available to script code 2747# here we export the classes and methods available to script code
1067 2748
1068=pod 2749=pod
1069 2750
1070The following fucntions and emthods are available within a safe environment: 2751The following functions and methods are available within a safe environment:
1071 2752
1072 cf::object contr pay_amount pay_player map 2753 cf::object
2754 contr pay_amount pay_player map x y force_find force_add
2755 insert remove name archname title slaying race decrease_ob_nr
2756
1073 cf::object::player player 2757 cf::object::player
1074 cf::player peaceful 2758 player
1075 cf::map trigger 2759
2760 cf::player
2761 peaceful
2762
2763 cf::map
2764 trigger
1076 2765
1077=cut 2766=cut
1078 2767
1079for ( 2768for (
1080 ["cf::object" => qw(contr pay_amount pay_player map)], 2769 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2770 insert remove inv name archname title slaying race
2771 decrease_ob_nr)],
1081 ["cf::object::player" => qw(player)], 2772 ["cf::object::player" => qw(player)],
1082 ["cf::player" => qw(peaceful)], 2773 ["cf::player" => qw(peaceful)],
1083 ["cf::map" => qw(trigger)], 2774 ["cf::map" => qw(trigger)],
1084) { 2775) {
1085 no strict 'refs'; 2776 no strict 'refs';
1156=back 2847=back
1157 2848
1158=cut 2849=cut
1159 2850
1160############################################################################# 2851#############################################################################
2852# the server's init and main functions
1161 2853
1162=head2 EXTENSION DATABASE SUPPORT 2854sub load_facedata($) {
2855 my ($path) = @_;
1163 2856
1164Crossfire maintains a very simple database for extension use. It can 2857 # HACK to clear player env face cache, we need some signal framework
1165currently store anything that can be serialised using Storable, which 2858 # for this (global event?)
1166excludes objects. 2859 %ext::player_env::MUSIC_FACE_CACHE = ();
1167 2860
1168The parameter C<$family> should best start with the name of the extension 2861 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1169using it, it should be unique.
1170 2862
1171=over 4 2863 warn "loading facedata from $path\n";
1172 2864
1173=item $hashref = cf::db_get $family 2865 my $facedata;
2866 0 < aio_load $path, $facedata
2867 or die "$path: $!";
1174 2868
1175Return a hashref for use by the extension C<$family>, which can be 2869 $facedata = Coro::Storable::thaw $facedata;
1176modified. After modifications, you have to call C<cf::db_dirty> or
1177C<cf::db_sync>.
1178 2870
1179=item $value = cf::db_get $family => $key 2871 $facedata->{version} == 2
2872 or cf::cleanup "$path: version mismatch, cannot proceed.";
1180 2873
1181Returns a single value from the database 2874 # patch in the exptable
1182 2875 $facedata->{resource}{"res/exp_table"} = {
1183=item cf::db_put $family => $hashref 2876 type => FT_RSRC,
1184 2877 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1185Stores the given family hashref into the database. Updates are delayed, if
1186you want the data to be synced to disk immediately, use C<cf::db_sync>.
1187
1188=item cf::db_put $family => $key => $value
1189
1190Stores the given C<$value> in the family hash. Updates are delayed, if you
1191want the data to be synced to disk immediately, use C<cf::db_sync>.
1192
1193=item cf::db_dirty
1194
1195Marks the database as dirty, to be updated at a later time.
1196
1197=item cf::db_sync
1198
1199Immediately write the database to disk I<if it is dirty>.
1200
1201=cut
1202
1203our $DB;
1204
1205{
1206 my $path = cf::localdir . "/database.pst";
1207
1208 sub db_load() {
1209 warn "loading database $path\n";#d# remove later
1210 $DB = stat $path ? Storable::retrieve $path : { };
1211 }
1212
1213 my $pid;
1214
1215 sub db_save() {
1216 warn "saving database $path\n";#d# remove later
1217 waitpid $pid, 0 if $pid;
1218 if (0 == ($pid = fork)) {
1219 $DB->{_meta}{version} = 1;
1220 Storable::nstore $DB, "$path~";
1221 rename "$path~", $path;
1222 cf::_exit 0 if defined $pid;
1223 }
1224 }
1225
1226 my $dirty;
1227
1228 sub db_sync() {
1229 db_save if $dirty;
1230 undef $dirty;
1231 }
1232
1233 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1234 db_sync;
1235 }); 2878 };
2879 cf::cede_to_tick;
1236 2880
1237 sub db_dirty() {
1238 $dirty = 1;
1239 $idle->start;
1240 } 2881 {
2882 my $faces = $facedata->{faceinfo};
1241 2883
1242 sub db_get($;$) { 2884 while (my ($face, $info) = each %$faces) {
1243 @_ >= 2 2885 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1244 ? $DB->{$_[0]}{$_[1]} 2886 cf::face::set_visibility $idx, $info->{visibility};
1245 : ($DB->{$_[0]} ||= { }) 2887 cf::face::set_magicmap $idx, $info->{magicmap};
1246 } 2888 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2889 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1247 2890
1248 sub db_put($$;$) { 2891 cf::cede_to_tick;
1249 if (@_ >= 3) {
1250 $DB->{$_[0]}{$_[1]} = $_[2];
1251 } else {
1252 $DB->{$_[0]} = $_[1];
1253 }
1254 db_dirty;
1255 }
1256
1257 cf::global->attach (
1258 prio => 10000,
1259 on_cleanup => sub {
1260 db_sync;
1261 }, 2892 }
1262 );
1263}
1264 2893
1265############################################################################# 2894 while (my ($face, $info) = each %$faces) {
1266# the server's main() 2895 next unless $info->{smooth};
2896 my $idx = cf::face::find $face
2897 or next;
2898 if (my $smooth = cf::face::find $info->{smooth}) {
2899 cf::face::set_smooth $idx, $smooth;
2900 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2901 } else {
2902 warn "smooth face '$info->{smooth}' not found for face '$face'";
2903 }
1267 2904
1268sub cfg_load { 2905 cf::cede_to_tick;
2906 }
2907 }
2908
2909 {
2910 my $anims = $facedata->{animinfo};
2911
2912 while (my ($anim, $info) = each %$anims) {
2913 cf::anim::set $anim, $info->{frames}, $info->{facings};
2914 cf::cede_to_tick;
2915 }
2916
2917 cf::anim::invalidate_all; # d'oh
2918 }
2919
2920 {
2921 # TODO: for gcfclient pleasure, we should give resources
2922 # that gcfclient doesn't grok a >10000 face index.
2923 my $res = $facedata->{resource};
2924
2925 my $soundconf = delete $res->{"res/sound.conf"};
2926
2927 while (my ($name, $info) = each %$res) {
2928 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2929 my $data;
2930
2931 if ($info->{type} & 1) {
2932 # prepend meta info
2933
2934 my $meta = $enc->encode ({
2935 name => $name,
2936 %{ $info->{meta} || {} },
2937 });
2938
2939 $data = pack "(w/a*)*", $meta, $info->{data};
2940 } else {
2941 $data = $info->{data};
2942 }
2943
2944 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2945 cf::face::set_type $idx, $info->{type};
2946
2947 cf::cede_to_tick;
2948 }
2949
2950 if ($soundconf) {
2951 $soundconf = $enc->decode (delete $soundconf->{data});
2952
2953 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2954 my $sound = $soundconf->{compat}[$_]
2955 or next;
2956
2957 my $face = cf::face::find "sound/$sound->[1]";
2958 cf::sound::set $sound->[0] => $face;
2959 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2960 }
2961
2962 while (my ($k, $v) = each %{$soundconf->{event}}) {
2963 my $face = cf::face::find "sound/$v";
2964 cf::sound::set $k => $face;
2965 }
2966 }
2967 }
2968
2969 1
2970}
2971
2972register_exticmd fx_want => sub {
2973 my ($ns, $want) = @_;
2974
2975 while (my ($k, $v) = each %$want) {
2976 $ns->fx_want ($k, $v);
2977 }
2978};
2979
2980sub reload_regions {
2981 # HACK to clear player env face cache, we need some signal framework
2982 # for this (global event?)
2983 %ext::player_env::MUSIC_FACE_CACHE = ();
2984
2985 load_resource_file "$MAPDIR/regions"
2986 or die "unable to load regions file\n";
2987
2988 for (cf::region::list) {
2989 $_->{match} = qr/$_->{match}/
2990 if exists $_->{match};
2991 }
2992}
2993
2994sub reload_facedata {
2995 load_facedata "$DATADIR/facedata"
2996 or die "unable to load facedata\n";
2997}
2998
2999sub reload_archetypes {
3000 load_resource_file "$DATADIR/archetypes"
3001 or die "unable to load archetypes\n";
3002 #d# NEED to laod twice to resolve forward references
3003 # this really needs to be done in an extra post-pass
3004 # (which needs to be synchronous, so solve it differently)
3005 load_resource_file "$DATADIR/archetypes"
3006 or die "unable to load archetypes\n";
3007}
3008
3009sub reload_treasures {
3010 load_resource_file "$DATADIR/treasures"
3011 or die "unable to load treasurelists\n";
3012}
3013
3014sub reload_resources {
3015 warn "reloading resource files...\n";
3016
3017 reload_regions;
3018 reload_facedata;
3019 #reload_archetypes;#d#
3020 reload_archetypes;
3021 reload_treasures;
3022
3023 warn "finished reloading resource files\n";
3024}
3025
3026sub init {
3027 reload_resources;
3028}
3029
3030sub reload_config {
1269 open my $fh, "<:utf8", cf::confdir . "/config" 3031 open my $fh, "<:utf8", "$CONFDIR/config"
1270 or return; 3032 or return;
1271 3033
1272 local $/; 3034 local $/;
1273 *CFG = YAML::Syck::Load <$fh>; 3035 *CFG = YAML::Syck::Load <$fh>;
3036
3037 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3038
3039 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3040 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3041
3042 if (exists $CFG{mlockall}) {
3043 eval {
3044 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3045 and die "WARNING: m(un)lockall failed: $!\n";
3046 };
3047 warn $@ if $@;
3048 }
1274} 3049}
1275 3050
1276sub main { 3051sub main {
1277 cfg_load; 3052 # we must not ever block the main coroutine
1278 db_load; 3053 local $Coro::idle = sub {
3054 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3055 (async {
3056 Event::one_event;
3057 })->prio (Coro::PRIO_MAX);
3058 };
3059
3060 reload_config;
3061 db_init;
1279 load_extensions; 3062 load_extensions;
3063
3064 $TICK_WATCHER->start;
1280 Event::loop; 3065 Event::loop;
1281} 3066}
1282 3067
1283############################################################################# 3068#############################################################################
1284# initialisation 3069# initialisation and cleanup
1285 3070
1286sub _perl_reload() { 3071# install some emergency cleanup handlers
3072BEGIN {
3073 for my $signal (qw(INT HUP TERM)) {
3074 Event->signal (
3075 reentrant => 0,
3076 data => WF_AUTOCANCEL,
3077 signal => $signal,
3078 prio => 0,
3079 cb => sub {
3080 cf::cleanup "SIG$signal";
3081 },
3082 );
3083 }
3084}
3085
3086sub write_runtime {
3087 my $runtime = "$LOCALDIR/runtime";
3088
3089 # first touch the runtime file to show we are still running:
3090 # the fsync below can take a very very long time.
3091
3092 IO::AIO::aio_utime $runtime, undef, undef;
3093
3094 my $guard = cf::lock_acquire "write_runtime";
3095
3096 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3097 or return;
3098
3099 my $value = $cf::RUNTIME + 90 + 10;
3100 # 10 is the runtime save interval, for a monotonic clock
3101 # 60 allows for the watchdog to kill the server.
3102
3103 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3104 and return;
3105
3106 # always fsync - this file is important
3107 aio_fsync $fh
3108 and return;
3109
3110 # touch it again to show we are up-to-date
3111 aio_utime $fh, undef, undef;
3112
3113 close $fh
3114 or return;
3115
3116 aio_rename "$runtime~", $runtime
3117 and return;
3118
3119 warn "runtime file written.\n";
3120
3121 1
3122}
3123
3124sub emergency_save() {
3125 my $freeze_guard = cf::freeze_mainloop;
3126
3127 warn "enter emergency perl save\n";
3128
3129 cf::sync_job {
3130 # use a peculiar iteration method to avoid tripping on perl
3131 # refcount bugs in for. also avoids problems with players
3132 # and maps saved/destroyed asynchronously.
3133 warn "begin emergency player save\n";
3134 for my $login (keys %cf::PLAYER) {
3135 my $pl = $cf::PLAYER{$login} or next;
3136 $pl->valid or next;
3137 $pl->save;
3138 }
3139 warn "end emergency player save\n";
3140
3141 warn "begin emergency map save\n";
3142 for my $path (keys %cf::MAP) {
3143 my $map = $cf::MAP{$path} or next;
3144 $map->valid or next;
3145 $map->save;
3146 }
3147 warn "end emergency map save\n";
3148
3149 warn "begin emergency database checkpoint\n";
3150 BDB::db_env_txn_checkpoint $DB_ENV;
3151 warn "end emergency database checkpoint\n";
3152 };
3153
3154 warn "leave emergency perl save\n";
3155}
3156
3157sub post_cleanup {
3158 my ($make_core) = @_;
3159
3160 warn Carp::longmess "post_cleanup backtrace"
3161 if $make_core;
3162}
3163
3164sub do_reload_perl() {
1287 # can/must only be called in main 3165 # can/must only be called in main
1288 if ($Coro::current != $Coro::main) { 3166 if ($Coro::current != $Coro::main) {
1289 warn "can only reload from main coroutine\n"; 3167 warn "can only reload from main coroutine";
1290 return; 3168 return;
1291 } 3169 }
1292 3170
1293 warn "reloading..."; 3171 warn "reloading...";
1294 3172
1295 local $FREEZE = 1; 3173 warn "entering sync_job";
3174
3175 cf::sync_job {
3176 cf::write_runtime; # external watchdog should not bark
1296 cf::emergency_save; 3177 cf::emergency_save;
3178 cf::write_runtime; # external watchdog should not bark
1297 3179
1298 eval { 3180 warn "syncing database to disk";
3181 BDB::db_env_txn_checkpoint $DB_ENV;
3182
1299 # if anything goes wrong in here, we should simply crash as we already saved 3183 # if anything goes wrong in here, we should simply crash as we already saved
1300 3184
1301 # cancel all watchers 3185 warn "cancelling all WF_AUTOCANCEL watchers";
1302 for (Event::all_watchers) { 3186 for (Event::all_watchers) {
1303 $_->cancel if $_->data & WF_AUTOCANCEL; 3187 $_->cancel if $_->data & WF_AUTOCANCEL;
1304 } 3188 }
1305 3189
3190 warn "flushing outstanding aio requests";
3191 for (;;) {
3192 BDB::flush;
3193 IO::AIO::flush;
3194 Coro::cede;
3195 last unless IO::AIO::nreqs || BDB::nreqs;
3196 warn "iterate...";
3197 }
3198
3199 ++$RELOAD;
3200
1306 # cancel all extension coros 3201 warn "cancelling all extension coros";
1307 $_->cancel for values %EXT_CORO; 3202 $_->cancel for values %EXT_CORO;
1308 %EXT_CORO = (); 3203 %EXT_CORO = ();
1309 3204
1310 # unload all extensions 3205 warn "removing commands";
1311 for (@exts) { 3206 %COMMAND = ();
3207
3208 warn "removing ext/exti commands";
3209 %EXTCMD = ();
3210 %EXTICMD = ();
3211
3212 warn "unloading/nuking all extensions";
3213 for my $pkg (@EXTS) {
1312 warn "unloading <$_>"; 3214 warn "... unloading $pkg";
1313 unload_extension $_; 3215
3216 if (my $cb = $pkg->can ("unload")) {
3217 eval {
3218 $cb->($pkg);
3219 1
3220 } or warn "$pkg unloaded, but with errors: $@";
1314 } 3221 }
1315 3222
3223 warn "... nuking $pkg";
3224 Symbol::delete_package $pkg;
3225 }
3226
1316 # unload all modules loaded from $LIBDIR 3227 warn "unloading all perl modules loaded from $LIBDIR";
1317 while (my ($k, $v) = each %INC) { 3228 while (my ($k, $v) = each %INC) {
1318 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3229 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1319 3230
1320 warn "removing <$k>"; 3231 warn "... unloading $k";
1321 delete $INC{$k}; 3232 delete $INC{$k};
1322 3233
1323 $k =~ s/\.pm$//; 3234 $k =~ s/\.pm$//;
1324 $k =~ s/\//::/g; 3235 $k =~ s/\//::/g;
1325 3236
1328 } 3239 }
1329 3240
1330 Symbol::delete_package $k; 3241 Symbol::delete_package $k;
1331 } 3242 }
1332 3243
1333 # sync database to disk
1334 cf::db_sync;
1335 IO::AIO::flush;
1336
1337 # get rid of safe::, as good as possible 3244 warn "getting rid of safe::, as good as possible";
1338 Symbol::delete_package "safe::$_" 3245 Symbol::delete_package "safe::$_"
1339 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3246 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1340 3247
1341 # remove register_script_function callbacks
1342 # TODO
1343
1344 # unload cf.pm "a bit" 3248 warn "unloading cf.pm \"a bit\"";
1345 delete $INC{"cf.pm"}; 3249 delete $INC{"cf.pm"};
3250 delete $INC{"cf/pod.pm"};
1346 3251
1347 # don't, removes xs symbols, too, 3252 # don't, removes xs symbols, too,
1348 # and global variables created in xs 3253 # and global variables created in xs
1349 #Symbol::delete_package __PACKAGE__; 3254 #Symbol::delete_package __PACKAGE__;
1350 3255
1351 # reload cf.pm 3256 warn "unload completed, starting to reload now";
3257
1352 warn "reloading cf.pm"; 3258 warn "reloading cf.pm";
1353 require cf; 3259 require cf;
1354 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3260 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1355 3261
1356 # load config and database again 3262 warn "loading config and database again";
1357 cf::cfg_load; 3263 cf::reload_config;
1358 cf::db_load;
1359 3264
1360 # load extensions
1361 warn "load extensions"; 3265 warn "loading extensions";
1362 cf::load_extensions; 3266 cf::load_extensions;
1363 3267
1364 # reattach attachments to objects 3268 warn "reattaching attachments to objects/players";
1365 warn "reattach"; 3269 _global_reattach; # objects, sockets
1366 _global_reattach; 3270 warn "reattaching attachments to maps";
1367 }; 3271 reattach $_ for values %MAP;
3272 warn "reattaching attachments to players";
3273 reattach $_ for values %PLAYER;
1368 3274
1369 if ($@) { 3275 warn "leaving sync_job";
3276
3277 1
3278 } or do {
1370 warn $@; 3279 warn $@;
1371 warn "error while reloading, exiting."; 3280 warn "error while reloading, exiting.";
1372 exit 1; 3281 exit 1;
1373 } 3282 };
1374 3283
1375 warn "reloaded successfully"; 3284 warn "reloaded";
1376}; 3285};
1377 3286
1378sub perl_reload() { 3287our $RELOAD_WATCHER; # used only during reload
1379 _perl_reload;
1380}
1381 3288
1382register "<global>", __PACKAGE__; 3289sub reload_perl() {
3290 # doing reload synchronously and two reloads happen back-to-back,
3291 # coro crashes during coro_state_free->destroy here.
1383 3292
3293 $RELOAD_WATCHER ||= Event->timer (
3294 reentrant => 0,
3295 after => 0,
3296 data => WF_AUTOCANCEL,
3297 cb => sub {
3298 do_reload_perl;
3299 undef $RELOAD_WATCHER;
3300 },
3301 );
3302}
3303
1384register_command "perl-reload" => sub { 3304register_command "reload" => sub {
1385 my ($who, $arg) = @_; 3305 my ($who, $arg) = @_;
1386 3306
1387 if ($who->flag (FLAG_WIZ)) { 3307 if ($who->flag (FLAG_WIZ)) {
1388 $who->message ("reloading..."); 3308 $who->message ("reloading server.");
1389 _perl_reload; 3309 async { reload_perl };
1390 } 3310 }
1391}; 3311};
1392 3312
1393unshift @INC, $LIBDIR; 3313unshift @INC, $LIBDIR;
1394 3314
3315my $bug_warning = 0;
3316
3317our @WAIT_FOR_TICK;
3318our @WAIT_FOR_TICK_BEGIN;
3319
3320sub wait_for_tick {
3321 return unless $TICK_WATCHER->is_active;
3322 return if $Coro::current == $Coro::main;
3323
3324 my $signal = new Coro::Signal;
3325 push @WAIT_FOR_TICK, $signal;
3326 $signal->wait;
3327}
3328
3329sub wait_for_tick_begin {
3330 return unless $TICK_WATCHER->is_active;
3331 return if $Coro::current == $Coro::main;
3332
3333 my $signal = new Coro::Signal;
3334 push @WAIT_FOR_TICK_BEGIN, $signal;
3335 $signal->wait;
3336}
3337
3338 my $min = 1e6;#d#
3339 my $avg = 10;
1395$TICK_WATCHER = Event->timer ( 3340$TICK_WATCHER = Event->timer (
1396 reentrant => 0, 3341 reentrant => 0,
3342 parked => 1,
1397 prio => 0, 3343 prio => 0,
1398 at => $NEXT_TICK || $TICK, 3344 at => $NEXT_TICK || $TICK,
1399 data => WF_AUTOCANCEL, 3345 data => WF_AUTOCANCEL,
1400 cb => sub { 3346 cb => sub {
1401 unless ($FREEZE) { 3347 if ($Coro::current != $Coro::main) {
3348 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3349 unless ++$bug_warning > 10;
3350 return;
3351 }
3352
3353 $NOW = $tick_start = Event::time;
3354
1402 cf::server_tick; # one server iteration 3355 cf::server_tick; # one server iteration
1403 $RUNTIME += $TICK; 3356
3357 0 && sync_job {#d#
3358 for(1..10) {
3359 my $t = Event::time;
3360 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3361 or die;
3362
3363 $map->width (50);
3364 $map->height (50);
3365 $map->alloc;
3366 $map->_load_objects ("/tmp/x.map", 1);
3367 my $t = Event::time - $t;
3368
3369 #next unless $t < 0.0013;#d#
3370 if ($t < $min) {
3371 $min = $t;
3372 }
3373 $avg = $avg * 0.99 + $t * 0.01;
3374 }
3375 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3376 exit 0;
3377 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1404 } 3378 };
1405 3379
3380 $RUNTIME += $TICK;
1406 $NEXT_TICK += $TICK; 3381 $NEXT_TICK += $TICK;
1407 3382
3383 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3384 $NEXT_RUNTIME_WRITE = $NOW + 10;
3385 Coro::async_pool {
3386 write_runtime
3387 or warn "ERROR: unable to write runtime file: $!";
3388 };
3389 }
3390
3391# my $AFTER = Event::time;
3392# warn $AFTER - $NOW;#d#
3393
3394 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3395 $sig->send;
3396 }
3397 while (my $sig = shift @WAIT_FOR_TICK) {
3398 $sig->send;
3399 }
3400
3401 $NOW = Event::time;
3402
1408 # if we are delayed by four ticks or more, skip them all 3403 # if we are delayed by four ticks or more, skip them all
1409 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3404 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1410 3405
1411 $TICK_WATCHER->at ($NEXT_TICK); 3406 $TICK_WATCHER->at ($NEXT_TICK);
1412 $TICK_WATCHER->start; 3407 $TICK_WATCHER->start;
3408
3409 $LOAD = ($NOW - $tick_start) / $TICK;
3410 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3411
3412 _post_tick;
3413
3414
1413 }, 3415 },
1414); 3416);
1415 3417
3418{
3419 BDB::max_poll_time $TICK * 0.1;
3420 $BDB_POLL_WATCHER = Event->io (
3421 reentrant => 0,
3422 fd => BDB::poll_fileno,
3423 poll => 'r',
3424 prio => 0,
3425 data => WF_AUTOCANCEL,
3426 cb => \&BDB::poll_cb,
3427 );
3428 BDB::min_parallel 8;
3429
3430 BDB::set_sync_prepare {
3431 my $status;
3432 my $current = $Coro::current;
3433 (
3434 sub {
3435 $status = $!;
3436 $current->ready; undef $current;
3437 },
3438 sub {
3439 Coro::schedule while defined $current;
3440 $! = $status;
3441 },
3442 )
3443 };
3444
3445 unless ($DB_ENV) {
3446 $DB_ENV = BDB::db_env_create;
3447
3448 cf::sync_job {
3449 eval {
3450 BDB::db_env_open
3451 $DB_ENV,
3452 $BDBDIR,
3453 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3454 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3455 0666;
3456
3457 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3458
3459 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3460 $DB_ENV->set_lk_detect;
3461 };
3462
3463 cf::cleanup "db_env_open(db): $@" if $@;
3464 };
3465 }
3466}
3467
3468{
3469 IO::AIO::min_parallel 8;
3470
3471 undef $Coro::AIO::WATCHER;
1416IO::AIO::max_poll_time $TICK * 0.2; 3472 IO::AIO::max_poll_time $TICK * 0.1;
1417 3473 $AIO_POLL_WATCHER = Event->io (
1418Event->io (fd => IO::AIO::poll_fileno, 3474 reentrant => 0,
1419 poll => 'r',
1420 prio => 5,
1421 data => WF_AUTOCANCEL, 3475 data => WF_AUTOCANCEL,
3476 fd => IO::AIO::poll_fileno,
3477 poll => 'r',
3478 prio => 6,
1422 cb => \&IO::AIO::poll_cb); 3479 cb => \&IO::AIO::poll_cb,
3480 );
3481}
1423 3482
1424# we must not ever block the main coroutine 3483my $_log_backtrace;
1425$Coro::idle = sub { 3484
1426 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3485sub _log_backtrace {
1427 warn "FATAL: Coro::idle was called, major BUG\n"; 3486 my ($msg, @addr) = @_;
1428 (Coro::unblock_sub { 3487
1429 Event::one_event; 3488 $msg =~ s/\n//;
1430 })->(); 3489
1431}; 3490 # limit the # of concurrent backtraces
3491 if ($_log_backtrace < 2) {
3492 ++$_log_backtrace;
3493 async {
3494 my @bt = fork_call {
3495 @addr = map { sprintf "%x", $_ } @addr;
3496 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3497 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3498 or die "addr2line: $!";
3499
3500 my @funcs;
3501 my @res = <$fh>;
3502 chomp for @res;
3503 while (@res) {
3504 my ($func, $line) = splice @res, 0, 2, ();
3505 push @funcs, "[$func] $line";
3506 }
3507
3508 @funcs
3509 };
3510
3511 LOG llevInfo, "[ABT] $msg\n";
3512 LOG llevInfo, "[ABT] $_\n" for @bt;
3513 --$_log_backtrace;
3514 };
3515 } else {
3516 LOG llevInfo, "[ABT] $msg\n";
3517 LOG llevInfo, "[ABT] [suppressed]\n";
3518 }
3519}
3520
3521# load additional modules
3522use cf::pod;
3523
3524END { cf::emergency_save }
1432 3525
14331 35261
1434 3527

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines