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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.312 by root, Sat Jul 21 18:01:26 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines