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.98 by root, Fri Dec 22 16:34:00 2006 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines