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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines