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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.448 by root, Fri Sep 19 05:30:23 2008 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18#
19# The authors can be reached via e-mail to <support@deliantra.net>
20#
21
1package cf; 22package cf;
23
24use 5.10.0;
25use utf8;
26use strict "vars", "subs";
2 27
3use Symbol; 28use Symbol;
4use List::Util; 29use List::Util;
5use Storable; 30use Socket;
31use EV;
6use Opcode; 32use Opcode;
7use Safe; 33use Safe;
8use Safe::Hole; 34use Safe::Hole;
35use Storable ();
9 36
37use Coro ();
38use Coro::State;
39use Coro::Handle;
40use Coro::EV;
41use Coro::AnyEvent;
42use Coro::Timer;
43use Coro::Signal;
44use Coro::Semaphore;
45use Coro::AnyEvent;
46use Coro::AIO;
47use Coro::BDB 1.6;
48use Coro::Storable;
49use Coro::Util ();
50
51use JSON::XS 2.01 ();
52use BDB ();
53use Data::Dumper;
54use Digest::MD5;
55use Fcntl;
56use YAML ();
10use IO::AIO (); 57use IO::AIO ();
11use YAML::Syck ();
12use Time::HiRes; 58use Time::HiRes;
13use Event; 59use Compress::LZF;
14$Event::Eval = 1; # no idea why this is required, but it is 60use Digest::MD5 ();
15 61
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 62AnyEvent::detect;
17$YAML::Syck::ImplicitUnicode = 1;
18 63
19use strict; 64# configure various modules to our taste
65#
66$Storable::canonical = 1; # reduce rsync transfers
67Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
68
69$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
70
71{
72 # very ugly, but ensure we acquire the storable lock
73
74 sub net_mstore {
75 my $guard = Coro::Storable::guard;
76 &Storable::net_mstore
77 }
78
79 sub mretrieve {
80 my $guard = Coro::Storable::guard;
81 &Storable::mretrieve
82 }
83
84 Compress::LZF::set_serializer "Coro::Storable", "cf::net_mstore", "cf::mretrieve";
85 Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
86}
20 87
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 88sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 89
23our %COMMAND = (); 90our %COMMAND = ();
24our %COMMAND_TIME = (); 91our %COMMAND_TIME = ();
92
93our @EXTS = (); # list of extension package names
25our %EXTCMD = (); 94our %EXTCMD = ();
95our %EXTICMD = ();
96our %EXT_CORO = (); # coroutines bound to extensions
97our %EXT_MAP = (); # pluggable maps
26 98
27_init_vars; 99our $RELOAD; # number of reloads so far
28
29our @EVENT; 100our @EVENT;
30our $LIBDIR = datadir . "/ext";
31 101
32our $TICK = MAX_TIME * 1e-6; 102our $CONFDIR = confdir;
33our $TICK_WATCHER; 103our $DATADIR = datadir;
104our $LIBDIR = "$DATADIR/ext";
105our $PODDIR = "$DATADIR/pod";
106our $MAPDIR = "$DATADIR/" . mapdir;
107our $LOCALDIR = localdir;
108our $TMPDIR = "$LOCALDIR/" . tmpdir;
109our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
110our $PLAYERDIR = "$LOCALDIR/" . playerdir;
111our $RANDOMDIR = "$LOCALDIR/random";
112our $BDBDIR = "$LOCALDIR/db";
113our $PIDFILE = "$LOCALDIR/pid";
114our $RUNTIMEFILE = "$LOCALDIR/runtime";
115
116our %RESOURCE;
117
118our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
119our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
34our $NEXT_TICK; 120our $NEXT_TICK;
121our $USE_FSYNC = 1; # use fsync to write maps - default off
122
123our $BDB_DEADLOCK_WATCHER;
124our $BDB_CHECKPOINT_WATCHER;
125our $BDB_TRICKLE_WATCHER;
126our $DB_ENV;
35 127
36our %CFG; 128our %CFG;
37 129
38our $UPTIME; $UPTIME ||= time; 130our $UPTIME; $UPTIME ||= time;
131our $RUNTIME;
132our $NOW;
133
134our (%PLAYER, %PLAYER_LOADING); # all users
135our (%MAP, %MAP_LOADING ); # all maps
136our $LINK_MAP; # the special {link} map, which is always available
137
138# used to convert map paths into valid unix filenames by replacing / by ∕
139our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
140
141our $LOAD; # a number between 0 (idle) and 1 (too many objects)
142our $LOADAVG; # same thing, but with alpha-smoothing
143our $JITTER; # average jitter
144our $TICK_START; # for load detecting purposes
145
146binmode STDOUT;
147binmode STDERR;
148
149# read virtual server time, if available
150unless ($RUNTIME || !-e $RUNTIMEFILE) {
151 open my $fh, "<", $RUNTIMEFILE
152 or die "unable to read $RUNTIMEFILE file: $!";
153 $RUNTIME = <$fh> + 0.;
154}
155
156mkdir $_
157 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
158
159our $EMERGENCY_POSITION;
160
161sub cf::map::normalise;
39 162
40############################################################################# 163#############################################################################
41 164
42=head2 GLOBAL VARIABLES 165=head2 GLOBAL VARIABLES
43 166
45 168
46=item $cf::UPTIME 169=item $cf::UPTIME
47 170
48The timestamp of the server start (so not actually an uptime). 171The timestamp of the server start (so not actually an uptime).
49 172
50=item $cf::LIBDIR 173=item $cf::RUNTIME
51 174
52The perl library directory, where extensions and cf-specific modules can 175The time this server has run, starts at 0 and is increased by $cf::TICK on
53be found. It will be added to C<@INC> automatically. 176every server tick.
177
178=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
179$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
180$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
181
182Various directories - "/etc", read-only install directory, perl-library
183directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
184unique-items directory, player file directory, random maps directory and
185database environment.
186
187=item $cf::NOW
188
189The time of the last (current) server tick.
54 190
55=item $cf::TICK 191=item $cf::TICK
56 192
57The interval between server ticks, in seconds. 193The interval between server ticks, in seconds.
58 194
195=item $cf::LOADAVG
196
197The current CPU load on the server (alpha-smoothed), as a value between 0
198(none) and 1 (overloaded), indicating how much time is spent on processing
199objects per tick. Healthy values are < 0.5.
200
201=item $cf::LOAD
202
203The raw value load value from the last tick.
204
59=item %cf::CFG 205=item %cf::CFG
60 206
61Configuration for the server, loaded from C</etc/crossfire/config>, or 207Configuration for the server, loaded from C</etc/deliantra-server/config>, or
62from wherever your confdir points to. 208from wherever your confdir points to.
209
210=item cf::wait_for_tick, cf::wait_for_tick_begin
211
212These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
213returns directly I<after> the tick processing (and consequently, can only wake one process
214per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
215
216=item @cf::INVOKE_RESULTS
217
218This array contains the results of the last C<invoke ()> call. When
219C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
220that call.
63 221
64=back 222=back
65 223
66=cut 224=cut
67 225
68BEGIN { 226BEGIN {
69 *CORE::GLOBAL::warn = sub { 227 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 228 my $msg = join "", @_;
229
71 $msg .= "\n" 230 $msg .= "\n"
72 unless $msg =~ /\n$/; 231 unless $msg =~ /\n$/;
73 232
74 print STDERR "cfperl: $msg"; 233 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
234
75 LOG llevError, "cfperl: $msg"; 235 LOG llevError, $msg;
76 }; 236 };
77} 237}
238
239$Coro::State::DIEHOOK = sub {
240 return unless $^S eq 0; # "eq", not "=="
241
242 if ($Coro::current == $Coro::main) {#d#
243 warn "DIEHOOK called in main context, Coro bug?\n";#d#
244 return;#d#
245 }#d#
246
247 # kill coroutine otherwise
248 warn Carp::longmess $_[0];
249 Coro::terminate
250};
251
252$SIG{__DIE__} = sub { }; #d#?
78 253
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 254@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 255@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
81@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 256@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
82@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 257@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
83@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 258@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
259@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 260@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
85 261
86# we bless all objects into (empty) derived classes to force a method lookup 262# we bless all objects into (empty) derived classes to force a method lookup
87# within the Safe compartment. 263# within the Safe compartment.
88for my $pkg (qw( 264for my $pkg (qw(
89 cf::global 265 cf::global cf::attachable
90 cf::object cf::object::player 266 cf::object cf::object::player
91 cf::client cf::player 267 cf::client cf::player
92 cf::arch cf::living 268 cf::arch cf::living
269 cf::map cf::mapspace
93 cf::map cf::party cf::region 270 cf::party cf::region
94)) { 271)) {
95 no strict 'refs';
96 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 272 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
97} 273}
98 274
99$Event::DIED = sub { 275$EV::DIED = sub {
100 warn "error in event callback: @_"; 276 warn "error in event callback: @_";
101}; 277};
102 278
103my %ext_pkg; 279#############################################################################
104my @exts;
105my @hook;
106 280
107=head2 UTILITY FUNCTIONS 281=head2 UTILITY FUNCTIONS
108 282
109=over 4 283=over 4
110 284
111=cut 285=item dumpval $ref
112 286
113use JSON::Syck (); # TODO# replace by JSON::PC once working 287=cut
114 288
289sub dumpval {
290 eval {
291 local $SIG{__DIE__};
292 my $d;
293 if (1) {
294 $d = new Data::Dumper([$_[0]], ["*var"]);
295 $d->Terse(1);
296 $d->Indent(2);
297 $d->Quotekeys(0);
298 $d->Useqq(1);
299 #$d->Bless(...);
300 $d->Seen($_[1]) if @_ > 1;
301 $d = $d->Dump();
302 }
303 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
304 $d
305 } || "[unable to dump $_[0]: '$@']";
306}
307
115=item $ref = cf::from_json $json 308=item $ref = cf::decode_json $json
116 309
117Converts a JSON string into the corresponding perl data structure. 310Converts a JSON string into the corresponding perl data structure.
118 311
119=cut
120
121sub from_json($) {
122 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
123 JSON::Syck::Load $_[0]
124}
125
126=item $json = cf::to_json $ref 312=item $json = cf::encode_json $ref
127 313
128Converts a perl data structure into its JSON representation. 314Converts a perl data structure into its JSON representation.
129 315
130=cut 316=cut
131 317
132sub to_json($) { 318our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 319
134 JSON::Syck::Dump $_[0] 320sub encode_json($) { $json_coder->encode ($_[0]) }
321sub decode_json($) { $json_coder->decode ($_[0]) }
322
323=item cf::lock_wait $string
324
325Wait until the given lock is available. See cf::lock_acquire.
326
327=item my $lock = cf::lock_acquire $string
328
329Wait until the given lock is available and then acquires it and returns
330a Coro::guard object. If the guard object gets destroyed (goes out of scope,
331for example when the coroutine gets canceled), the lock is automatically
332returned.
333
334Locks are *not* recursive, locking from the same coro twice results in a
335deadlocked coro.
336
337Lock names should begin with a unique identifier (for example, cf::map::find
338uses map_find and cf::map::load uses map_load).
339
340=item $locked = cf::lock_active $string
341
342Return true if the lock is currently active, i.e. somebody has locked it.
343
344=cut
345
346our %LOCK;
347our %LOCKER;#d#
348
349sub lock_wait($) {
350 my ($key) = @_;
351
352 if ($LOCKER{$key} == $Coro::current) {#d#
353 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
354 return;#d#
355 }#d#
356
357 # wait for lock, if any
358 while ($LOCK{$key}) {
359 push @{ $LOCK{$key} }, $Coro::current;
360 Coro::schedule;
361 }
362}
363
364sub lock_acquire($) {
365 my ($key) = @_;
366
367 # wait, to be sure we are not locked
368 lock_wait $key;
369
370 $LOCK{$key} = [];
371 $LOCKER{$key} = $Coro::current;#d#
372
373 Coro::guard {
374 delete $LOCKER{$key};#d#
375 # wake up all waiters, to be on the safe side
376 $_->ready for @{ delete $LOCK{$key} };
377 }
378}
379
380sub lock_active($) {
381 my ($key) = @_;
382
383 ! ! $LOCK{$key}
384}
385
386sub freeze_mainloop {
387 tick_inhibit_inc;
388
389 Coro::guard \&tick_inhibit_dec;
390}
391
392=item cf::periodic $interval, $cb
393
394Like EV::periodic, but randomly selects a starting point so that the actions
395get spread over timer.
396
397=cut
398
399sub periodic($$) {
400 my ($interval, $cb) = @_;
401
402 my $start = rand List::Util::min 180, $interval;
403
404 EV::periodic $start, $interval, 0, $cb
405}
406
407=item cf::get_slot $time[, $priority[, $name]]
408
409Allocate $time seconds of blocking CPU time at priority C<$priority>:
410This call blocks and returns only when you have at least C<$time> seconds
411of cpu time till the next tick. The slot is only valid till the next cede.
412
413The optional C<$name> can be used to identify the job to run. It might be
414used for statistical purposes and should identify the same time-class.
415
416Useful for short background jobs.
417
418=cut
419
420our @SLOT_QUEUE;
421our $SLOT_QUEUE;
422
423$SLOT_QUEUE->cancel if $SLOT_QUEUE;
424$SLOT_QUEUE = Coro::async {
425 $Coro::current->desc ("timeslot manager");
426
427 my $signal = new Coro::Signal;
428
429 while () {
430 next_job:
431 my $avail = cf::till_tick;
432 if ($avail > 0.01) {
433 for (0 .. $#SLOT_QUEUE) {
434 if ($SLOT_QUEUE[$_][0] < $avail) {
435 my $job = splice @SLOT_QUEUE, $_, 1, ();
436 $job->[2]->send;
437 Coro::cede;
438 goto next_job;
439 }
440 }
441 }
442
443 if (@SLOT_QUEUE) {
444 # we do not use wait_for_tick() as it returns immediately when tick is inactive
445 push @cf::WAIT_FOR_TICK, $signal;
446 $signal->wait;
447 } else {
448 Coro::schedule;
449 }
450 }
451};
452
453sub get_slot($;$$) {
454 return if tick_inhibit || $Coro::current == $Coro::main;
455
456 my ($time, $pri, $name) = @_;
457
458 $time = $TICK * .6 if $time > $TICK * .6;
459 my $sig = new Coro::Signal;
460
461 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
462 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
463 $SLOT_QUEUE->ready;
464 $sig->wait;
465}
466
467=item cf::async { BLOCK }
468
469Currently the same as Coro::async_pool, meaning you cannot use
470C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
471thing you are allowed to do is call C<prio> on it.
472
473=cut
474
475BEGIN { *async = \&Coro::async_pool }
476
477=item cf::sync_job { BLOCK }
478
479The design of Deliantra requires that the main coroutine ($Coro::main)
480is always able to handle events or runnable, as Deliantra is only
481partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
482acceptable.
483
484If it must be done, put the blocking parts into C<sync_job>. This will run
485the given BLOCK in another coroutine while waiting for the result. The
486server will be frozen during this time, so the block should either finish
487fast or be very important.
488
489=cut
490
491sub sync_job(&) {
492 my ($job) = @_;
493
494 if ($Coro::current == $Coro::main) {
495 my $time = EV::time;
496
497 # this is the main coro, too bad, we have to block
498 # till the operation succeeds, freezing the server :/
499
500 LOG llevError, Carp::longmess "sync job";#d#
501
502 my $freeze_guard = freeze_mainloop;
503
504 my $busy = 1;
505 my @res;
506
507 (async {
508 $Coro::current->desc ("sync job coro");
509 @res = eval { $job->() };
510 warn $@ if $@;
511 undef $busy;
512 })->prio (Coro::PRIO_MAX);
513
514 while ($busy) {
515 if (Coro::nready) {
516 Coro::cede_notself;
517 } else {
518 EV::loop EV::LOOP_ONESHOT;
519 }
520 }
521
522 my $time = EV::time - $time;
523
524 $TICK_START += $time; # do not account sync jobs to server load
525
526 wantarray ? @res : $res[0]
527 } else {
528 # we are in another coroutine, how wonderful, everything just works
529
530 $job->()
531 }
532}
533
534=item $coro = cf::async_ext { BLOCK }
535
536Like async, but this coro is automatically being canceled when the
537extension calling this is being unloaded.
538
539=cut
540
541sub async_ext(&) {
542 my $cb = shift;
543
544 my $coro = &Coro::async ($cb);
545
546 $coro->on_destroy (sub {
547 delete $EXT_CORO{$coro+0};
548 });
549 $EXT_CORO{$coro+0} = $coro;
550
551 $coro
552}
553
554=item fork_call { }, $args
555
556Executes the given code block with the given arguments in a seperate
557process, returning the results. Everything must be serialisable with
558Coro::Storable. May, of course, block. Note that the executed sub may
559never block itself or use any form of event handling.
560
561=cut
562
563sub fork_call(&@) {
564 my ($cb, @args) = @_;
565
566 # we seemingly have to make a local copy of the whole thing,
567 # otherwise perl prematurely frees the stuff :/
568 # TODO: investigate and fix (likely this will be rather laborious)
569
570 my @res = Coro::Util::fork_eval {
571 reset_signals;
572 &$cb
573 }, @args;
574
575 wantarray ? @res : $res[-1]
576}
577
578=item $coin = coin_from_name $name
579
580=cut
581
582our %coin_alias = (
583 "silver" => "silvercoin",
584 "silvercoin" => "silvercoin",
585 "silvercoins" => "silvercoin",
586 "gold" => "goldcoin",
587 "goldcoin" => "goldcoin",
588 "goldcoins" => "goldcoin",
589 "platinum" => "platinacoin",
590 "platinumcoin" => "platinacoin",
591 "platinumcoins" => "platinacoin",
592 "platina" => "platinacoin",
593 "platinacoin" => "platinacoin",
594 "platinacoins" => "platinacoin",
595 "royalty" => "royalty",
596 "royalties" => "royalty",
597);
598
599sub coin_from_name($) {
600 $coin_alias{$_[0]}
601 ? cf::arch::find $coin_alias{$_[0]}
602 : undef
603}
604
605=item $value = cf::db_get $family => $key
606
607Returns a single value from the environment database.
608
609=item cf::db_put $family => $key => $value
610
611Stores the given C<$value> in the family. It can currently store binary
612data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
613
614=item $db = cf::db_table "name"
615
616Create and/or open a new database table. The string must not be "db" and must be unique
617within each server.
618
619=cut
620
621sub db_table($) {
622 my ($name) = @_;
623 my $db = BDB::db_create $DB_ENV;
624
625 eval {
626 $db->set_flags (BDB::CHKSUM);
627
628 utf8::encode $name;
629 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
630 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
631 cf::cleanup "db_open(db): $!" if $!;
632 };
633 cf::cleanup "db_open(db): $@" if $@;
634
635 $db
636}
637
638our $DB;
639
640sub db_init {
641 cf::sync_job {
642 $DB ||= db_table "db";
643 };
644}
645
646sub db_get($$) {
647 my $key = "$_[0]/$_[1]";
648
649 cf::sync_job {
650 BDB::db_get $DB, undef, $key, my $data;
651
652 $! ? ()
653 : $data
654 }
655}
656
657sub db_put($$$) {
658 BDB::dbreq_pri 4;
659 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
660}
661
662=item cf::cache $id => [$paths...], $processversion => $process
663
664Generic caching function that returns the value of the resource $id,
665caching and regenerating as required.
666
667This function can block.
668
669=cut
670
671sub cache {
672 my ($id, $src, $processversion, $process) = @_;
673
674 my $meta =
675 join "\x00",
676 $processversion,
677 map {
678 aio_stat $_
679 and Carp::croak "$_: $!";
680
681 ($_, (stat _)[7,9])
682 } @$src;
683
684 my $dbmeta = db_get cache => "$id/meta";
685 if ($dbmeta ne $meta) {
686 # changed, we may need to process
687
688 my @data;
689 my $md5;
690
691 for (0 .. $#$src) {
692 0 <= aio_load $src->[$_], $data[$_]
693 or Carp::croak "$src->[$_]: $!";
694 }
695
696 # if processing is expensive, check
697 # checksum first
698 if (1) {
699 $md5 =
700 join "\x00",
701 $processversion,
702 map {
703 cf::cede_to_tick;
704 ($src->[$_], Digest::MD5::md5_hex $data[$_])
705 } 0.. $#$src;
706
707
708 my $dbmd5 = db_get cache => "$id/md5";
709 if ($dbmd5 eq $md5) {
710 db_put cache => "$id/meta", $meta;
711
712 return db_get cache => "$id/data";
713 }
714 }
715
716 my $t1 = Time::HiRes::time;
717 my $data = $process->(\@data);
718 my $t2 = Time::HiRes::time;
719
720 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
721
722 db_put cache => "$id/data", $data;
723 db_put cache => "$id/md5" , $md5;
724 db_put cache => "$id/meta", $meta;
725
726 return $data;
727 }
728
729 db_get cache => "$id/data"
730}
731
732=item cf::datalog type => key => value, ...
733
734Log a datalog packet of the given type with the given key-value pairs.
735
736=cut
737
738sub datalog($@) {
739 my ($type, %kv) = @_;
740 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
135} 741}
136 742
137=back 743=back
138 744
139=cut 745=cut
140 746
141############################################################################# 747#############################################################################
142 748
143=head2 ATTACHABLE OBJECTS 749=head2 ATTACHABLE OBJECTS
144 750
145You can define and attach attachments to each "attachable" object in 751Many objects in deliantra are so-called attachable objects. That means you can
146crossfire+ (objects, players, clients, maps and the special "global" 752attach callbacks/event handlers (a collection of which is called an "attachment")
753to it. All such attachable objects support the following methods.
754
147class). In the following description, CLASS can be any of C<global>, 755In the following description, CLASS can be any of C<global>, C<object>
148C<object> C<player>, C<client> or C<map>. 756C<player>, C<client> or C<map> (i.e. the attachable objects in
757Deliantra).
149 758
150=over 4 759=over 4
151 760
761=item $attachable->attach ($attachment, key => $value...)
762
763=item $attachable->detach ($attachment)
764
765Attach/detach a pre-registered attachment to a specific object and give it
766the specified key/value pairs as arguments.
767
768Example, attach a minesweeper attachment to the given object, making it a
76910x10 minesweeper game:
770
771 $obj->attach (minesweeper => width => 10, height => 10);
772
773=item $bool = $attachable->attached ($name)
774
775Checks wether the named attachment is currently attached to the object.
776
777=item cf::CLASS->attach ...
778
779=item cf::CLASS->detach ...
780
781Define an anonymous attachment and attach it to all objects of the given
782CLASS. See the next function for an explanation of its arguments.
783
784You can attach to global events by using the C<cf::global> class.
785
786Example, log all player logins:
787
788 cf::player->attach (
789 on_login => sub {
790 my ($pl) = @_;
791 ...
792 },
793 );
794
795Example, attach to the jeweler skill:
796
797 cf::object->attach (
798 type => cf::SKILL,
799 subtype => cf::SK_JEWELER,
800 on_use_skill => sub {
801 my ($sk, $ob, $part, $dir, $msg) = @_;
802 ...
803 },
804 );
805
152=item cf::CLASS::attachment $name, ... 806=item cf::CLASS::attachment $name, ...
153 807
154Register an attachment by name through which attachable objects can refer 808Register an attachment by C<$name> through which attachable objects of the
155to this attachment. 809given CLASS can refer to this attachment.
156 810
157=item $bool = $attachable->attached ($name) 811Some classes such as deliantra maps and objects can specify attachments
812that are attached at load/instantiate time, thus the need for a name.
158 813
159Checks wether the named attachment is currently attached to the object.
160
161=item $attachable->attach ($attachment, key => $value...)
162
163=item $attachable->detach ($attachment)
164
165Attach/detach a pre-registered attachment either to a specific object
166(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167class in a static method call).
168
169You can attach to global events by using the C<cf::global> class.
170
171These method calls expect any number of the following handler/hook 814These calls expect any number of the following handler/hook descriptions:
172descriptions:
173 815
174=over 4 816=over 4
175 817
176=item prio => $number 818=item prio => $number
177 819
203package and register them. Only handlers for eevents supported by the 845package and register them. Only handlers for eevents supported by the
204object/class are recognised. 846object/class are recognised.
205 847
206=back 848=back
207 849
850Example, define an attachment called "sockpuppet" that calls the given
851event handler when a monster attacks:
852
853 cf::object::attachment sockpuppet =>
854 on_skill_attack => sub {
855 my ($self, $victim) = @_;
856 ...
857 }
858 }
859
860=item $attachable->valid
861
862Just because you have a perl object does not mean that the corresponding
863C-level object still exists. If you try to access an object that has no
864valid C counterpart anymore you get an exception at runtime. This method
865can be used to test for existence of the C object part without causing an
866exception.
867
208=cut 868=cut
209 869
210# the following variables are defined in .xs and must not be re-created 870# the following variables are defined in .xs and must not be re-created
211our @CB_GLOBAL = (); # registry for all global events 871our @CB_GLOBAL = (); # registry for all global events
872our @CB_ATTACHABLE = (); # registry for all attachables
212our @CB_OBJECT = (); # all objects (should not be used except in emergency) 873our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213our @CB_PLAYER = (); 874our @CB_PLAYER = ();
214our @CB_CLIENT = (); 875our @CB_CLIENT = ();
215our @CB_TYPE = (); # registry for type (cf-object class) based events 876our @CB_TYPE = (); # registry for type (cf-object class) based events
216our @CB_MAP = (); 877our @CB_MAP = ();
217 878
218my %attachment; 879my %attachment;
880
881sub cf::attachable::thawer_merge {
882 # simply override everything except _meta
883 local $_[0]{_meta};
884 %{$_[0]} = %{$_[1]};
885}
219 886
220sub _attach_cb($$$$) { 887sub _attach_cb($$$$) {
221 my ($registry, $event, $prio, $cb) = @_; 888 my ($registry, $event, $prio, $cb) = @_;
222 889
223 use sort 'stable'; 890 use sort 'stable';
226 893
227 @{$registry->[$event]} = sort 894 @{$registry->[$event]} = sort
228 { $a->[0] cmp $b->[0] } 895 { $a->[0] cmp $b->[0] }
229 @{$registry->[$event] || []}, $cb; 896 @{$registry->[$event] || []}, $cb;
230} 897}
898
899# hack
900my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231 901
232# attach handles attaching event callbacks 902# attach handles attaching event callbacks
233# the only thing the caller has to do is pass the correct 903# the only thing the caller has to do is pass the correct
234# registry (== where the callback attaches to). 904# registry (== where the callback attaches to).
235sub _attach { 905sub _attach {
237 907
238 my $object_type; 908 my $object_type;
239 my $prio = 0; 909 my $prio = 0;
240 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 910 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241 911
912 #TODO: get rid of this hack
913 if ($attachable_klass{$klass}) {
914 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
915 }
916
242 while (@arg) { 917 while (@arg) {
243 my $type = shift @arg; 918 my $type = shift @arg;
244 919
245 if ($type eq "prio") { 920 if ($type eq "prio") {
246 $prio = shift @arg; 921 $prio = shift @arg;
250 $registry = $CB_TYPE[$object_type] ||= []; 925 $registry = $CB_TYPE[$object_type] ||= [];
251 926
252 } elsif ($type eq "subtype") { 927 } elsif ($type eq "subtype") {
253 defined $object_type or Carp::croak "subtype specified without type"; 928 defined $object_type or Carp::croak "subtype specified without type";
254 my $object_subtype = shift @arg; 929 my $object_subtype = shift @arg;
255 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 930 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
256 931
257 } elsif ($type eq "package") { 932 } elsif ($type eq "package") {
258 my $pkg = shift @arg; 933 my $pkg = shift @arg;
259 934
260 while (my ($name, $id) = each %cb_id) { 935 while (my ($name, $id) = each %cb_id) {
289 _attach $registry, $klass, @attach; 964 _attach $registry, $klass, @attach;
290 } 965 }
291 966
292 $obj->{$name} = \%arg; 967 $obj->{$name} = \%arg;
293 } else { 968 } else {
294 warn "object uses attachment '$name' that is not available, postponing.\n"; 969 warn "object uses attachment '$name' which is not available, postponing.\n";
295 } 970 }
296 971
297 $obj->{_attachment}{$name} = undef; 972 $obj->{_attachment}{$name} = undef;
298} 973}
299 974
301 if (ref $_[0]) { 976 if (ref $_[0]) {
302 _object_attach @_; 977 _object_attach @_;
303 } else { 978 } else {
304 _attach shift->_attach_registry, @_; 979 _attach shift->_attach_registry, @_;
305 } 980 }
981 _recalc_want;
306}; 982};
307 983
308# all those should be optimised 984# all those should be optimised
309sub cf::attachable::detach { 985sub cf::attachable::detach {
310 my ($obj, $name) = @_; 986 my ($obj, $name) = @_;
313 delete $obj->{_attachment}{$name}; 989 delete $obj->{_attachment}{$name};
314 reattach ($obj); 990 reattach ($obj);
315 } else { 991 } else {
316 Carp::croak "cannot, currently, detach class attachments"; 992 Carp::croak "cannot, currently, detach class attachments";
317 } 993 }
994 _recalc_want;
318}; 995};
319 996
320sub cf::attachable::attached { 997sub cf::attachable::attached {
321 my ($obj, $name) = @_; 998 my ($obj, $name) = @_;
322 999
323 exists $obj->{_attachment}{$name} 1000 exists $obj->{_attachment}{$name}
324} 1001}
325 1002
326for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 1003for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327 eval "#line " . __LINE__ . " 'cf.pm' 1004 eval "#line " . __LINE__ . " 'cf.pm'
328 sub cf::\L$klass\E::_attach_registry { 1005 sub cf::\L$klass\E::_attach_registry {
329 (\\\@CB_$klass, KLASS_$klass) 1006 (\\\@CB_$klass, KLASS_$klass)
330 } 1007 }
331 1008
337 "; 1014 ";
338 die if $@; 1015 die if $@;
339} 1016}
340 1017
341our $override; 1018our $override;
342our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1019our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
343 1020
344sub override { 1021sub override {
345 $override = 1; 1022 $override = 1;
346 @invoke_results = (); 1023 @INVOKE_RESULTS = (@_);
347} 1024}
348 1025
349sub do_invoke { 1026sub do_invoke {
350 my $event = shift; 1027 my $event = shift;
351 my $callbacks = shift; 1028 my $callbacks = shift;
352 1029
353 @invoke_results = (); 1030 @INVOKE_RESULTS = ();
354 1031
355 local $override; 1032 local $override;
356 1033
357 for (@$callbacks) { 1034 for (@$callbacks) {
358 eval { &{$_->[1]} }; 1035 eval { &{$_->[1]} };
367 } 1044 }
368 1045
369 0 1046 0
370} 1047}
371 1048
372=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 1049=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
373 1050
374=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
375
376=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) 1051=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379 1052
380=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382Generate a global/object/player/map-specific event with the given arguments. 1053Generate an object-specific event with the given arguments.
383 1054
384This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 1055This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
385removed in future versions), and there is no public API to access override 1056removed in future versions), and there is no public API to access override
386results (if you must, access C<@cf::invoke_results> directly). 1057results (if you must, access C<@cf::INVOKE_RESULTS> directly).
387
388=back
389
390=cut
391
392#############################################################################
393
394=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396Attachable objects includes objects, players, clients and maps.
397
398=over 4
399
400=item $object->valid
401
402Just because you have a perl object does not mean that the corresponding
403C-level object still exists. If you try to access an object that has no
404valid C counterpart anymore you get an exception at runtime. This method
405can be used to test for existence of the C object part without causing an
406exception.
407 1058
408=back 1059=back
409 1060
410=cut 1061=cut
411 1062
412############################################################################# 1063#############################################################################
413# object support 1064# object support
414 1065
415sub instantiate { 1066sub _object_equal($$);
1067sub _object_equal($$) {
1068 my ($a, $b) = @_;
1069
1070 return 0 unless (ref $a) eq (ref $b);
1071
1072 if ("HASH" eq ref $a) {
1073 my @ka = keys %$a;
1074 my @kb = keys %$b;
1075
1076 return 0 if @ka != @kb;
1077
1078 for (0 .. $#ka) {
1079 return 0 unless $ka[$_] eq $kb[$_];
1080 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1081 }
1082
1083 } elsif ("ARRAY" eq ref $a) {
1084
1085 return 0 if @$a != @$b;
1086
1087 for (0 .. $#$a) {
1088 return 0 unless _object_equal $a->[$_], $b->[$_];
1089 }
1090
1091 } elsif ($a ne $b) {
1092 return 0;
1093 }
1094
1095 1
1096}
1097
1098our $SLOW_MERGES;#d#
1099sub _can_merge {
416 my ($obj, $data) = @_; 1100 my ($ob1, $ob2) = @_;
417 1101
418 $data = from_json $data; 1102 ++$SLOW_MERGES;#d#
419 1103
420 for (@$data) { 1104 # we do the slow way here
421 my ($name, $args) = @$_; 1105 return _object_equal $ob1, $ob2
422
423 $obj->attach ($name, %{$args || {} });
424 }
425} 1106}
426 1107
427# basically do the same as instantiate, without calling instantiate
428sub reattach { 1108sub reattach {
1109 # basically do the same as instantiate, without calling instantiate
429 my ($obj) = @_; 1110 my ($obj) = @_;
1111
1112 # no longer needed after getting rid of delete_package?
1113 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
1114
430 my $registry = $obj->registry; 1115 my $registry = $obj->registry;
431 1116
432 @$registry = (); 1117 @$registry = ();
433 1118
434 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 1119 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
443 warn "object uses attachment '$name' that is not available, postponing.\n"; 1128 warn "object uses attachment '$name' that is not available, postponing.\n";
444 } 1129 }
445 } 1130 }
446} 1131}
447 1132
448sub object_freezer_save { 1133cf::attachable->attach (
449 my ($filename, $rdata, $objs) = @_;
450
451 if (length $$rdata) {
452 warn sprintf "saving %s (%d,%d)\n",
453 $filename, length $$rdata, scalar @$objs;
454
455 if (open my $fh, ">:raw", "$filename~") {
456 chmod SAVE_MODE, $fh;
457 syswrite $fh, $$rdata;
458 close $fh;
459
460 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
461 chmod SAVE_MODE, $fh;
462 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
463 close $fh;
464 rename "$filename.pst~", "$filename.pst";
465 } else {
466 unlink "$filename.pst";
467 }
468
469 rename "$filename~", $filename;
470 } else {
471 warn "FATAL: $filename~: $!\n";
472 }
473 } else {
474 unlink $filename;
475 unlink "$filename.pst";
476 }
477}
478
479sub object_freezer_as_string {
480 my ($rdata, $objs) = @_;
481
482 use Data::Dumper;
483
484 $$rdata . Dumper $objs
485}
486
487sub object_thawer_load {
488 my ($filename) = @_;
489
490 local $/;
491
492 my $av;
493
494 #TODO: use sysread etc.
495 if (open my $data, "<:raw:perlio", $filename) {
496 $data = <$data>;
497 if (open my $pst, "<:raw:perlio", "$filename.pst") {
498 $av = eval { (Storable::thaw <$pst>)->{objs} };
499 }
500 return ($data, $av);
501 }
502
503 ()
504}
505
506cf::object->attach (
507 prio => -1000000, 1134 prio => -1000000,
1135 on_instantiate => sub {
1136 my ($obj, $data) = @_;
1137
1138 $data = decode_json $data;
1139
1140 for (@$data) {
1141 my ($name, $args) = @$_;
1142
1143 $obj->attach ($name, %{$args || {} });
1144 }
1145 },
1146 on_reattach => \&reattach,
508 on_clone => sub { 1147 on_clone => sub {
509 my ($src, $dst) = @_; 1148 my ($src, $dst) = @_;
510 1149
511 @{$dst->registry} = @{$src->registry}; 1150 @{$dst->registry} = @{$src->registry};
512 1151
515 %{$dst->{_attachment}} = %{$src->{_attachment}} 1154 %{$dst->{_attachment}} = %{$src->{_attachment}}
516 if exists $src->{_attachment}; 1155 if exists $src->{_attachment};
517 }, 1156 },
518); 1157);
519 1158
1159sub object_freezer_save {
1160 my ($filename, $rdata, $objs) = @_;
1161
1162 sync_job {
1163 if (length $$rdata) {
1164 utf8::decode (my $decname = $filename);
1165 warn sprintf "saving %s (%d,%d)\n",
1166 $decname, length $$rdata, scalar @$objs;
1167
1168 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
1169 aio_chmod $fh, SAVE_MODE;
1170 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1171 aio_fsync $fh if $cf::USE_FSYNC;
1172 aio_close $fh;
1173
1174 if (@$objs) {
1175 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
1176 aio_chmod $fh, SAVE_MODE;
1177 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
1178 aio_write $fh, 0, (length $data), $data, 0;
1179 aio_fsync $fh if $cf::USE_FSYNC;
1180 aio_close $fh;
1181 aio_rename "$filename.pst~", "$filename.pst";
1182 }
1183 } else {
1184 aio_unlink "$filename.pst";
1185 }
1186
1187 aio_rename "$filename~", $filename;
1188 } else {
1189 warn "FATAL: $filename~: $!\n";
1190 }
1191 } else {
1192 aio_unlink $filename;
1193 aio_unlink "$filename.pst";
1194 }
1195 };
1196}
1197
1198sub object_freezer_as_string {
1199 my ($rdata, $objs) = @_;
1200
1201 use Data::Dumper;
1202
1203 $$rdata . Dumper $objs
1204}
1205
1206sub object_thawer_load {
1207 my ($filename) = @_;
1208
1209 my ($data, $av);
1210
1211 (aio_load $filename, $data) >= 0
1212 or return;
1213
1214 unless (aio_stat "$filename.pst") {
1215 (aio_load "$filename.pst", $av) >= 0
1216 or return;
1217
1218 my $st = eval { Coro::Storable::thaw $av };
1219 $av = $st->{objs};
1220 }
1221
1222 utf8::decode (my $decname = $filename);
1223 warn sprintf "loading %s (%d,%d)\n",
1224 $decname, length $data, scalar @{$av || []};
1225
1226 ($data, $av)
1227}
1228
1229=head2 COMMAND CALLBACKS
1230
1231=over 4
1232
1233=cut
1234
520############################################################################# 1235#############################################################################
521# command handling &c 1236# command handling &c
522 1237
523=item cf::register_command $name => \&callback($ob,$args); 1238=item cf::register_command $name => \&callback($ob,$args);
524 1239
536 push @{ $COMMAND{$name} }, [$caller, $cb]; 1251 push @{ $COMMAND{$name} }, [$caller, $cb];
537} 1252}
538 1253
539=item cf::register_extcmd $name => \&callback($pl,$packet); 1254=item cf::register_extcmd $name => \&callback($pl,$packet);
540 1255
541Register a callbackf ro execution when the client sends an extcmd packet. 1256Register a callback for execution when the client sends an (synchronous)
1257extcmd packet. Ext commands will be processed in the order they are
1258received by the server, like other user commands. The first argument is
1259the logged-in player. Ext commands can only be processed after a player
1260has logged in successfully.
542 1261
543If the callback returns something, it is sent back as if reply was being 1262If the callback returns something, it is sent back as if reply was being
544called. 1263called.
545 1264
1265=item cf::register_exticmd $name => \&callback($ns,$packet);
1266
1267Register a callback for execution when the client sends an (asynchronous)
1268exticmd packet. Exti commands are processed by the server as soon as they
1269are received, i.e. out of order w.r.t. other commands. The first argument
1270is a client socket. Exti commands can be received anytime, even before
1271log-in.
1272
1273If the callback returns something, it is sent back as if reply was being
1274called.
1275
546=cut 1276=cut
547 1277
548sub register_extcmd { 1278sub register_extcmd {
549 my ($name, $cb) = @_; 1279 my ($name, $cb) = @_;
550 1280
551 my $caller = caller;
552 #warn "registering extcmd '$name' to '$caller'";
553
554 $EXTCMD{$name} = [$cb, $caller]; 1281 $EXTCMD{$name} = $cb;
1282}
1283
1284sub register_exticmd {
1285 my ($name, $cb) = @_;
1286
1287 $EXTICMD{$name} = $cb;
555} 1288}
556 1289
557cf::player->attach ( 1290cf::player->attach (
558 on_command => sub { 1291 on_command => sub {
559 my ($pl, $name, $params) = @_; 1292 my ($pl, $name, $params) = @_;
568 cf::override; 1301 cf::override;
569 }, 1302 },
570 on_extcmd => sub { 1303 on_extcmd => sub {
571 my ($pl, $buf) = @_; 1304 my ($pl, $buf) = @_;
572 1305
573 my $msg = eval { from_json $buf }; 1306 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
574 1307
575 if (ref $msg) { 1308 if (ref $msg) {
1309 my ($type, $reply, @payload) =
1310 "ARRAY" eq ref $msg
1311 ? @$msg
1312 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1313
1314 my @reply;
1315
576 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1316 if (my $cb = $EXTCMD{$type}) {
577 if (my %reply = $cb->[0]->($pl, $msg)) { 1317 @reply = $cb->($pl, @payload);
578 $pl->ext_reply ($msg->{msgid}, %reply);
579 }
580 } 1318 }
1319
1320 $pl->ext_reply ($reply, @reply)
1321 if $reply;
1322
581 } else { 1323 } else {
582 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1324 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
583 } 1325 }
584 1326
585 cf::override; 1327 cf::override;
586 }, 1328 },
587); 1329);
588 1330
1331sub load_extensions {
1332 cf::sync_job {
1333 my %todo;
1334
1335 for my $path (<$LIBDIR/*.ext>) {
1336 next unless -r $path;
1337
1338 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1339 my $base = $1;
1340 my $pkg = $1;
1341 $pkg =~ s/[^[:word:]]/_/g;
1342 $pkg = "ext::$pkg";
1343
1344 open my $fh, "<:utf8", $path
1345 or die "$path: $!";
1346
1347 my $source = do { local $/; <$fh> };
1348
1349 my %ext = (
1350 path => $path,
1351 base => $base,
1352 pkg => $pkg,
1353 );
1354
1355 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1356 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1357
1358 $ext{source} =
1359 "package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
1360 . "#line 1 \"$path\"\n{\n"
1361 . $source
1362 . "\n};\n1";
1363
1364 $todo{$base} = \%ext;
1365 }
1366
1367 my %done;
1368 while (%todo) {
1369 my $progress;
1370
1371 while (my ($k, $v) = each %todo) {
1372 for (split /,\s*/, $v->{meta}{depends}) {
1373 goto skip
1374 unless exists $done{$_};
1375 }
1376
1377 warn "... loading '$k' into '$v->{pkg}'\n";
1378
1379 unless (eval $v->{source}) {
1380 my $msg = $@ ? "$v->{path}: $@\n"
1381 : "$v->{base}: extension inactive.\n";
1382
1383 if (exists $v->{meta}{mandatory}) {
1384 warn $msg;
1385 cf::cleanup "mandatory extension failed to load, exiting.";
1386 }
1387
1388 warn $msg;
1389 }
1390
1391 $done{$k} = delete $todo{$k};
1392 push @EXTS, $v->{pkg};
1393 $progress = 1;
1394 }
1395
1396 skip:
1397 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1398 unless $progress;
1399 }
1400 };
1401}
1402
1403#############################################################################
1404
1405=back
1406
1407=head2 CORE EXTENSIONS
1408
1409Functions and methods that extend core deliantra objects.
1410
1411=cut
1412
1413package cf::player;
1414
1415use Coro::AIO;
1416
1417=head3 cf::player
1418
1419=over 4
1420
1421=item cf::player::num_playing
1422
1423Returns the official number of playing players, as per the Crossfire metaserver rules.
1424
1425=cut
1426
1427sub num_playing {
1428 scalar grep
1429 $_->ob->map
1430 && !$_->hidden
1431 && !$_->ob->flag (cf::FLAG_WIZ),
1432 cf::player::list
1433}
1434
1435=item cf::player::find $login
1436
1437Returns the given player object, loading it if necessary (might block).
1438
1439=cut
1440
1441sub playerdir($) {
1442 "$PLAYERDIR/"
1443 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1444}
1445
1446sub path($) {
1447 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1448
1449 (playerdir $login) . "/playerdata"
1450}
1451
1452sub find_active($) {
1453 $cf::PLAYER{$_[0]}
1454 and $cf::PLAYER{$_[0]}->active
1455 and $cf::PLAYER{$_[0]}
1456}
1457
1458sub exists($) {
1459 my ($login) = @_;
1460
1461 $cf::PLAYER{$login}
1462 or cf::sync_job { !aio_stat path $login }
1463}
1464
1465sub find($) {
1466 return $cf::PLAYER{$_[0]} || do {
1467 my $login = $_[0];
1468
1469 my $guard = cf::lock_acquire "user_find:$login";
1470
1471 $cf::PLAYER{$_[0]} || do {
1472 # rename old playerfiles to new ones
1473 #TODO: remove when no longer required
1474 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1475 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1476 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1477 aio_unlink +(playerdir $login) . "/$login.pl";
1478
1479 my $f = new_from_file cf::object::thawer path $login
1480 or return;
1481
1482 my $pl = cf::player::load_pl $f
1483 or return;
1484
1485 local $cf::PLAYER_LOADING{$login} = $pl;
1486 $f->resolve_delayed_derefs;
1487 $cf::PLAYER{$login} = $pl
1488 }
1489 }
1490}
1491
1492sub save($) {
1493 my ($pl) = @_;
1494
1495 return if $pl->{deny_save};
1496
1497 my $path = path $pl;
1498 my $guard = cf::lock_acquire "user_save:$path";
1499
1500 return if $pl->{deny_save};
1501
1502 aio_mkdir playerdir $pl, 0770;
1503 $pl->{last_save} = $cf::RUNTIME;
1504
1505 cf::get_slot 0.01;
1506
1507 $pl->save_pl ($path);
1508 cf::cede_to_tick;
1509}
1510
1511sub new($) {
1512 my ($login) = @_;
1513
1514 my $self = create;
1515
1516 $self->ob->name ($login);
1517 $self->{deny_save} = 1;
1518
1519 $cf::PLAYER{$login} = $self;
1520
1521 $self
1522}
1523
1524=item $player->send_msg ($channel, $msg, $color, [extra...])
1525
1526=cut
1527
1528sub send_msg {
1529 my $ns = shift->ns
1530 or return;
1531 $ns->send_msg (@_);
1532}
1533
1534=item $pl->quit_character
1535
1536Nukes the player without looking back. If logged in, the connection will
1537be destroyed. May block for a long time.
1538
1539=cut
1540
1541sub quit_character {
1542 my ($pl) = @_;
1543
1544 my $name = $pl->ob->name;
1545
1546 $pl->{deny_save} = 1;
1547 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1548
1549 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1550 $pl->deactivate;
1551 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1552 $pl->ob->check_score;
1553 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1554 $pl->ns->destroy if $pl->ns;
1555
1556 my $path = playerdir $pl;
1557 my $temp = "$path~$cf::RUNTIME~deleting~";
1558 aio_rename $path, $temp;
1559 delete $cf::PLAYER{$pl->ob->name};
1560 $pl->destroy;
1561
1562 my $prefix = qr<^~\Q$name\E/>;
1563
1564 # nuke player maps
1565 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1566
1567 IO::AIO::aio_rmtree $temp;
1568}
1569
1570=item $pl->kick
1571
1572Kicks a player out of the game. This destroys the connection.
1573
1574=cut
1575
1576sub kick {
1577 my ($pl, $kicker) = @_;
1578
1579 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1580 $pl->killer ("kicked");
1581 $pl->ns->destroy;
1582}
1583
1584=item cf::player::list_logins
1585
1586Returns am arrayref of all valid playernames in the system, can take a
1587while and may block, so not sync_job-capable, ever.
1588
1589=cut
1590
1591sub list_logins {
1592 my $dirs = aio_readdir $PLAYERDIR
1593 or return [];
1594
1595 my @logins;
1596
1597 for my $login (@$dirs) {
1598 my $path = path $login;
1599
1600 # a .pst is a dead give-away for a valid player
1601 # if no pst file found, open and chekc for blocked users
1602 if (aio_stat "$path.pst") {
1603 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1604 aio_read $fh, 0, 512, my $buf, 0 or next;
1605 $buf !~ /^password -------------$/m or next; # official not-valid tag
1606 }
1607
1608 utf8::decode $login;
1609 push @logins, $login;
1610 }
1611
1612 \@logins
1613}
1614
1615=item $player->maps
1616
1617Returns an arrayref of map paths that are private for this
1618player. May block.
1619
1620=cut
1621
1622sub maps($) {
1623 my ($pl) = @_;
1624
1625 $pl = ref $pl ? $pl->ob->name : $pl;
1626
1627 my $files = aio_readdir playerdir $pl
1628 or return;
1629
1630 my @paths;
1631
1632 for (@$files) {
1633 utf8::decode $_;
1634 next if /\.(?:pl|pst)$/;
1635 next unless /^$PATH_SEP/o;
1636
1637 push @paths, cf::map::normalise "~$pl/$_";
1638 }
1639
1640 \@paths
1641}
1642
1643=item $protocol_xml = $player->expand_cfpod ($cfpod)
1644
1645Expand deliantra pod fragments into protocol xml.
1646
1647=item $player->ext_reply ($msgid, @msg)
1648
1649Sends an ext reply to the player.
1650
1651=cut
1652
1653sub ext_reply($$@) {
1654 my ($self, $id, @msg) = @_;
1655
1656 $self->ns->ext_reply ($id, @msg)
1657}
1658
1659=item $player->ext_msg ($type, @msg)
1660
1661Sends an ext event to the client.
1662
1663=cut
1664
1665sub ext_msg($$@) {
1666 my ($self, $type, @msg) = @_;
1667
1668 $self->ns->ext_msg ($type, @msg);
1669}
1670
1671=head3 cf::region
1672
1673=over 4
1674
1675=cut
1676
1677package cf::region;
1678
1679=item cf::region::find_by_path $path
1680
1681Tries to decuce the likely region for a map knowing only its path.
1682
1683=cut
1684
1685sub find_by_path($) {
1686 my ($path) = @_;
1687
1688 my ($match, $specificity);
1689
1690 for my $region (list) {
1691 if ($region->{match} && $path =~ $region->{match}) {
1692 ($match, $specificity) = ($region, $region->specificity)
1693 if $region->specificity > $specificity;
1694 }
1695 }
1696
1697 $match
1698}
1699
1700=back
1701
1702=head3 cf::map
1703
1704=over 4
1705
1706=cut
1707
1708package cf::map;
1709
1710use Fcntl;
1711use Coro::AIO;
1712
1713use overload
1714 '""' => \&as_string,
1715 fallback => 1;
1716
1717our $MAX_RESET = 3600;
1718our $DEFAULT_RESET = 3000;
1719
1720sub generate_random_map {
1721 my ($self, $rmp) = @_;
1722
1723 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1724
1725 # mit "rum" bekleckern, nicht
1726 $self->_create_random_map (
1727 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1728 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1729 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1730 $rmp->{exit_on_final_map},
1731 $rmp->{xsize}, $rmp->{ysize},
1732 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1733 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1734 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1735 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1736 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1737 (cf::region::find $rmp->{region}), $rmp->{custom}
1738 )
1739}
1740
1741=item cf::map->register ($regex, $prio)
1742
1743Register a handler for the map path matching the given regex at the
1744givne priority (higher is better, built-in handlers have priority 0, the
1745default).
1746
1747=cut
1748
589sub register { 1749sub register {
1750 my (undef, $regex, $prio) = @_;
1751 my $pkg = caller;
1752
1753 no strict;
1754 push @{"$pkg\::ISA"}, __PACKAGE__;
1755
1756 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1757}
1758
1759# also paths starting with '/'
1760$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1761
1762sub thawer_merge {
590 my ($base, $pkg) = @_; 1763 my ($self, $merge) = @_;
591 1764
592 #TODO 1765 # we have to keep some variables in memory intact
593} 1766 local $self->{path};
1767 local $self->{load_path};
594 1768
595sub load_extension { 1769 $self->SUPER::thawer_merge ($merge);
1770}
1771
1772sub normalise {
596 my ($path) = @_; 1773 my ($path, $base) = @_;
597 1774
598 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1775 $path = "$path"; # make sure its a string
599 my $base = $1;
600 my $pkg = $1;
601 $pkg =~ s/[^[:word:]]/_/g;
602 $pkg = "ext::$pkg";
603 1776
604 warn "loading '$path' into '$pkg'\n"; 1777 $path =~ s/\.map$//;
605 1778
606 open my $fh, "<:utf8", $path 1779 # map plan:
607 or die "$path: $!"; 1780 #
1781 # /! non-realised random map exit (special hack!)
1782 # {... are special paths that are not being touched
1783 # ?xxx/... are special absolute paths
1784 # ?random/... random maps
1785 # /... normal maps
1786 # ~user/... per-player map of a specific user
608 1787
609 my $source = 1788 $path =~ s/$PATH_SEP/\//go;
610 "package $pkg; use strict; use utf8;\n"
611 . "#line 1 \"$path\"\n{\n"
612 . (do { local $/; <$fh> })
613 . "\n};\n1";
614 1789
615 eval $source 1790 # treat it as relative path if it starts with
616 or die $@ ? "$path: $@\n" 1791 # something that looks reasonable
617 : "extension disabled.\n"; 1792 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1793 $base or Carp::carp "normalise called with relative path and no base: '$path'";
618 1794
619 push @exts, $pkg; 1795 $base =~ s{[^/]+/?$}{};
620 $ext_pkg{$base} = $pkg; 1796 $path = "$base/$path";
621
622# no strict 'refs';
623# @{"$pkg\::ISA"} = ext::;
624
625 register $base, $pkg;
626}
627
628sub unload_extension {
629 my ($pkg) = @_;
630
631 warn "removing extension $pkg\n";
632
633 # remove hooks
634 #TODO
635# for my $idx (0 .. $#PLUGIN_EVENT) {
636# delete $hook[$idx]{$pkg};
637# } 1797 }
638 1798
639 # remove commands 1799 for ($path) {
640 for my $name (keys %COMMAND) { 1800 redo if s{//}{/};
641 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1801 redo if s{/\.?/}{/};
1802 redo if s{/[^/]+/\.\./}{/};
1803 }
642 1804
643 if (@cb) { 1805 $path
644 $COMMAND{$name} = \@cb; 1806}
1807
1808sub new_from_path {
1809 my (undef, $path, $base) = @_;
1810
1811 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1812
1813 $path = normalise $path, $base;
1814
1815 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1816 if ($path =~ $EXT_MAP{$pkg}[1]) {
1817 my $self = bless cf::map::new, $pkg;
1818 $self->{path} = $path; $self->path ($path);
1819 $self->init; # pass $1 etc.
1820 return $self;
1821 }
1822 }
1823
1824 Carp::cluck "unable to resolve path '$path' (base '$base').";
1825 ()
1826}
1827
1828sub init {
1829 my ($self) = @_;
1830
1831 $self
1832}
1833
1834sub as_string {
1835 my ($self) = @_;
1836
1837 "$self->{path}"
1838}
1839
1840# the displayed name, this is a one way mapping
1841sub visible_name {
1842 &as_string
1843}
1844
1845# the original (read-only) location
1846sub load_path {
1847 my ($self) = @_;
1848
1849 "$MAPDIR/$self->{path}.map"
1850}
1851
1852# the temporary/swap location
1853sub save_path {
1854 my ($self) = @_;
1855
1856 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1857 "$TMPDIR/$path.map"
1858}
1859
1860# the unique path, undef == no special unique path
1861sub uniq_path {
1862 my ($self) = @_;
1863
1864 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1865 "$UNIQUEDIR/$path"
1866}
1867
1868# and all this just because we cannot iterate over
1869# all maps in C++...
1870sub change_all_map_light {
1871 my ($change) = @_;
1872
1873 $_->change_map_light ($change)
1874 for grep $_->outdoor, values %cf::MAP;
1875}
1876
1877sub decay_objects {
1878 my ($self) = @_;
1879
1880 return if $self->{deny_reset};
1881
1882 $self->do_decay_objects;
1883}
1884
1885sub unlink_save {
1886 my ($self) = @_;
1887
1888 utf8::encode (my $save = $self->save_path);
1889 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1890 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1891}
1892
1893sub load_header_from($) {
1894 my ($self, $path) = @_;
1895
1896 utf8::encode $path;
1897 my $f = new_from_file cf::object::thawer $path
1898 or return;
1899
1900 $self->_load_header ($f)
1901 or return;
1902
1903 local $MAP_LOADING{$self->{path}} = $self;
1904 $f->resolve_delayed_derefs;
1905
1906 $self->{load_path} = $path;
1907
1908 1
1909}
1910
1911sub load_header_orig {
1912 my ($self) = @_;
1913
1914 $self->load_header_from ($self->load_path)
1915}
1916
1917sub load_header_temp {
1918 my ($self) = @_;
1919
1920 $self->load_header_from ($self->save_path)
1921}
1922
1923sub prepare_temp {
1924 my ($self) = @_;
1925
1926 $self->last_access ((delete $self->{last_access})
1927 || $cf::RUNTIME); #d#
1928 # safety
1929 $self->{instantiate_time} = $cf::RUNTIME
1930 if $self->{instantiate_time} > $cf::RUNTIME;
1931}
1932
1933sub prepare_orig {
1934 my ($self) = @_;
1935
1936 $self->{load_original} = 1;
1937 $self->{instantiate_time} = $cf::RUNTIME;
1938 $self->last_access ($cf::RUNTIME);
1939 $self->instantiate;
1940}
1941
1942sub load_header {
1943 my ($self) = @_;
1944
1945 if ($self->load_header_temp) {
1946 $self->prepare_temp;
645 } else { 1947 } else {
646 delete $COMMAND{$name}; 1948 $self->load_header_orig
647 } 1949 or return;
1950 $self->prepare_orig;
1951 }
1952
1953 $self->{deny_reset} = 1
1954 if $self->no_reset;
1955
1956 $self->default_region (cf::region::find_by_path $self->{path})
1957 unless $self->default_region;
1958
648 } 1959 1
1960}
649 1961
650 # remove extcmds 1962sub find;
651 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1963sub find {
652 delete $EXTCMD{$name}; 1964 my ($path, $origin) = @_;
1965
1966 $path = normalise $path, $origin && $origin->path;
1967
1968 cf::lock_wait "map_data:$path";#d#remove
1969 cf::lock_wait "map_find:$path";
1970
1971 $cf::MAP{$path} || do {
1972 my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1973 my $guard2 = cf::lock_acquire "map_find:$path";
1974
1975 my $map = new_from_path cf::map $path
1976 or return;
1977
1978 $map->{last_save} = $cf::RUNTIME;
1979
1980 $map->load_header
1981 or return;
1982
1983 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1984 # doing this can freeze the server in a sync job, obviously
1985 #$cf::WAIT_FOR_TICK->wait;
1986 undef $guard2;
1987 undef $guard1;
1988 $map->reset;
1989 return find $path;
1990 }
1991
1992 $cf::MAP{$path} = $map
1993 }
1994}
1995
1996sub pre_load { }
1997sub post_load { }
1998
1999sub load {
2000 my ($self) = @_;
2001
2002 local $self->{deny_reset} = 1; # loading can take a long time
2003
2004 my $path = $self->{path};
2005
653 } 2006 {
2007 my $guard = cf::lock_acquire "map_data:$path";
654 2008
655 if (my $cb = $pkg->can ("unload")) { 2009 return unless $self->valid;
656 eval { 2010 return unless $self->in_memory == cf::MAP_SWAPPED;
657 $cb->($pkg); 2011
2012 $self->in_memory (cf::MAP_LOADING);
2013
2014 $self->alloc;
2015
2016 $self->pre_load;
2017 cf::cede_to_tick;
2018
2019 my $f = new_from_file cf::object::thawer $self->{load_path};
2020 $f->skip_block;
2021 $self->_load_objects ($f)
2022 or return;
2023
2024 $self->post_load_original
2025 if delete $self->{load_original};
2026
2027 if (my $uniq = $self->uniq_path) {
2028 utf8::encode $uniq;
2029 unless (aio_stat $uniq) {
2030 if (my $f = new_from_file cf::object::thawer $uniq) {
2031 $self->clear_unique_items;
2032 $self->_load_objects ($f);
2033 $f->resolve_delayed_derefs;
2034 }
658 1 2035 }
659 } or warn "$pkg unloaded, but with errors: $@"; 2036 }
660 }
661 2037
662 Symbol::delete_package $pkg; 2038 $f->resolve_delayed_derefs;
663}
664 2039
665sub load_extensions { 2040 cf::cede_to_tick;
666 for my $ext (<$LIBDIR/*.ext>) { 2041 # now do the right thing for maps
667 next unless -r $ext; 2042 $self->link_multipart_objects;
668 eval { 2043 $self->difficulty ($self->estimate_difficulty)
669 load_extension $ext; 2044 unless $self->difficulty;
670 1 2045 cf::cede_to_tick;
671 } or warn "$ext not loaded: $@";
672 }
673}
674 2046
675############################################################################# 2047 unless ($self->{deny_activate}) {
676# load/save/clean perl data associated with a map 2048 $self->decay_objects;
2049 $self->fix_auto_apply;
2050 $self->update_buttons;
2051 cf::cede_to_tick;
2052 $self->set_darkness_map;
2053 cf::cede_to_tick;
2054 $self->activate;
2055 }
677 2056
678*cf::mapsupport::on_clean = sub { 2057 $self->{last_save} = $cf::RUNTIME;
2058 $self->last_access ($cf::RUNTIME);
2059
2060 $self->in_memory (cf::MAP_ACTIVE);
2061 }
2062
2063 $self->post_load;
2064}
2065
2066sub customise_for {
2067 my ($self, $ob) = @_;
2068
2069 return find "~" . $ob->name . "/" . $self->{path}
2070 if $self->per_player;
2071
2072# return find "?party/" . $ob->name . "/" . $self->{path}
2073# if $self->per_party;
2074
2075 $self
2076}
2077
2078# find and load all maps in the 3x3 area around a map
2079sub load_neighbours {
679 my ($map) = @_; 2080 my ($map) = @_;
680 2081
681 my $path = $map->tmpname; 2082 my @neigh; # diagonal neighbours
682 defined $path or return;
683 2083
684 unlink "$path.pst"; 2084 for (0 .. 3) {
685}; 2085 my $neigh = $map->tile_path ($_)
2086 or next;
2087 $neigh = find $neigh, $map
2088 or next;
2089 $neigh->load;
686 2090
687cf::map->attach (prio => -10000, package => cf::mapsupport::); 2091 push @neigh,
2092 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2093 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2094 }
688 2095
689############################################################################# 2096 for (grep defined $_->[0], @neigh) {
690# load/save perl data associated with player->ob objects 2097 my ($path, $origin) = @$_;
691 2098 my $neigh = find $path, $origin
692sub all_objects(@) { 2099 or next;
693 @_, map all_objects ($_->inv), @_ 2100 $neigh->load;
2101 }
694} 2102}
695 2103
696# TODO: compatibility cruft, remove when no longer needed 2104sub find_sync {
697cf::player->attach ( 2105 my ($path, $origin) = @_;
698 on_load => sub {
699 my ($pl, $path) = @_;
700 2106
701 for my $o (all_objects $pl->ob) { 2107 cf::sync_job { find $path, $origin }
702 if (my $value = $o->get_ob_key_value ("_perl_data")) { 2108}
703 $o->set_ob_key_value ("_perl_data");
704 2109
705 %$o = %{ Storable::thaw pack "H*", $value }; 2110sub do_load_sync {
2111 my ($map) = @_;
2112
2113 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2114 if $Coro::current == $Coro::main;
2115
2116 cf::sync_job { $map->load };
2117}
2118
2119our %MAP_PREFETCH;
2120our $MAP_PREFETCHER = undef;
2121
2122sub find_async {
2123 my ($path, $origin, $load) = @_;
2124
2125 $path = normalise $path, $origin && $origin->{path};
2126
2127 if (my $map = $cf::MAP{$path}) {
2128 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2129 }
2130
2131 $MAP_PREFETCH{$path} |= $load;
2132
2133 $MAP_PREFETCHER ||= cf::async {
2134 $Coro::current->{desc} = "map prefetcher";
2135
2136 while (%MAP_PREFETCH) {
2137 while (my ($k, $v) = each %MAP_PREFETCH) {
2138 if (my $map = find $k) {
2139 $map->load if $v;
2140 }
2141
2142 delete $MAP_PREFETCH{$k};
706 } 2143 }
707 } 2144 }
2145 undef $MAP_PREFETCHER;
2146 };
2147 $MAP_PREFETCHER->prio (6);
2148
2149 ()
2150}
2151
2152sub save {
2153 my ($self) = @_;
2154
2155 my $lock = cf::lock_acquire "map_data:$self->{path}";
2156
2157 $self->{last_save} = $cf::RUNTIME;
2158
2159 return unless $self->dirty;
2160
2161 my $save = $self->save_path; utf8::encode $save;
2162 my $uniq = $self->uniq_path; utf8::encode $uniq;
2163
2164 $self->{load_path} = $save;
2165
2166 return if $self->{deny_save};
2167
2168 local $self->{last_access} = $self->last_access;#d#
2169
2170 cf::async {
2171 $Coro::current->{desc} = "map player save";
2172 $_->contr->save for $self->players;
2173 };
2174
2175 cf::get_slot 0.02;
2176
2177 if ($uniq) {
2178 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2179 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2180 } else {
2181 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
708 }, 2182 }
709); 2183}
710 2184
711############################################################################# 2185sub swap_out {
2186 my ($self) = @_;
712 2187
713=head2 CORE EXTENSIONS 2188 # save first because save cedes
2189 $self->save;
714 2190
715Functions and methods that extend core crossfire objects. 2191 my $lock = cf::lock_acquire "map_data:$self->{path}";
2192
2193 return if $self->players;
2194 return if $self->in_memory != cf::MAP_ACTIVE;
2195 return if $self->{deny_save};
2196
2197 $self->in_memory (cf::MAP_SWAPPED);
2198
2199 $self->deactivate;
2200 $_->clear_links_to ($self) for values %cf::MAP;
2201 $self->clear;
2202}
2203
2204sub reset_at {
2205 my ($self) = @_;
2206
2207 # TODO: safety, remove and allow resettable per-player maps
2208 return 1e99 if $self->{deny_reset};
2209
2210 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2211 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2212
2213 $time + $to
2214}
2215
2216sub should_reset {
2217 my ($self) = @_;
2218
2219 $self->reset_at <= $cf::RUNTIME
2220}
2221
2222sub reset {
2223 my ($self) = @_;
2224
2225 my $lock = cf::lock_acquire "map_data:$self->{path}";
2226
2227 return if $self->players;
2228
2229 warn "resetting map ", $self->path;
2230
2231 $self->in_memory (cf::MAP_SWAPPED);
2232
2233 # need to save uniques path
2234 unless ($self->{deny_save}) {
2235 my $uniq = $self->uniq_path; utf8::encode $uniq;
2236
2237 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2238 if $uniq;
2239 }
2240
2241 delete $cf::MAP{$self->path};
2242
2243 $self->deactivate;
2244 $_->clear_links_to ($self) for values %cf::MAP;
2245 $self->clear;
2246
2247 $self->unlink_save;
2248 $self->destroy;
2249}
2250
2251my $nuke_counter = "aaaa";
2252
2253sub nuke {
2254 my ($self) = @_;
2255
2256 {
2257 my $lock = cf::lock_acquire "map_data:$self->{path}";
2258
2259 delete $cf::MAP{$self->path};
2260
2261 $self->unlink_save;
2262
2263 bless $self, "cf::map";
2264 delete $self->{deny_reset};
2265 $self->{deny_save} = 1;
2266 $self->reset_timeout (1);
2267 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2268
2269 $cf::MAP{$self->path} = $self;
2270 }
2271
2272 $self->reset; # polite request, might not happen
2273}
2274
2275=item $maps = cf::map::tmp_maps
2276
2277Returns an arrayref with all map paths of currently instantiated and saved
2278maps. May block.
2279
2280=cut
2281
2282sub tmp_maps() {
2283 [
2284 map {
2285 utf8::decode $_;
2286 /\.map$/
2287 ? normalise $_
2288 : ()
2289 } @{ aio_readdir $TMPDIR or [] }
2290 ]
2291}
2292
2293=item $maps = cf::map::random_maps
2294
2295Returns an arrayref with all map paths of currently instantiated and saved
2296random maps. May block.
2297
2298=cut
2299
2300sub random_maps() {
2301 [
2302 map {
2303 utf8::decode $_;
2304 /\.map$/
2305 ? normalise "?random/$_"
2306 : ()
2307 } @{ aio_readdir $RANDOMDIR or [] }
2308 ]
2309}
2310
2311=item cf::map::unique_maps
2312
2313Returns an arrayref of paths of all shared maps that have
2314instantiated unique items. May block.
2315
2316=cut
2317
2318sub unique_maps() {
2319 [
2320 map {
2321 utf8::decode $_;
2322 s/\.map$//; # TODO future compatibility hack
2323 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2324 ? ()
2325 : normalise $_
2326 } @{ aio_readdir $UNIQUEDIR or [] }
2327 ]
2328}
2329
2330=back
2331
2332=head3 cf::object
2333
2334=cut
2335
2336package cf::object;
716 2337
717=over 4 2338=over 4
718 2339
719=item cf::player::exists $login 2340=item $ob->inv_recursive
720 2341
721Returns true when the given account exists. 2342Returns the inventory of the object I<and> their inventories, recursively,
2343but I<not> the object itself.
722 2344
723=cut 2345=cut
724 2346
725sub cf::player::exists($) { 2347sub inv_recursive_;
726 cf::player::find $_[0] 2348sub inv_recursive_ {
727 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2349 map { $_, inv_recursive_ $_->inv } @_
728} 2350}
2351
2352sub inv_recursive {
2353 inv_recursive_ inv $_[0]
2354}
2355
2356=item $ref = $ob->ref
2357
2358Creates and returns a persistent reference to an object that can be stored as a string.
2359
2360=item $ob = cf::object::deref ($refstring)
2361
2362returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2363even if the object actually exists. May block.
2364
2365=cut
2366
2367sub deref {
2368 my ($ref) = @_;
2369
2370 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2371 my ($uuid, $name) = ($1, $2);
2372 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2373 or return;
2374 $pl->ob->uuid eq $uuid
2375 or return;
2376
2377 $pl->ob
2378 } else {
2379 warn "$ref: cannot resolve object reference\n";
2380 undef
2381 }
2382}
2383
2384package cf;
2385
2386=back
2387
2388=head3 cf::object::player
2389
2390=over 4
729 2391
730=item $player_object->reply ($npc, $msg[, $flags]) 2392=item $player_object->reply ($npc, $msg[, $flags])
731 2393
732Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2394Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733can be C<undef>. Does the right thing when the player is currently in a 2395can be C<undef>. Does the right thing when the player is currently in a
734dialogue with the given NPC character. 2396dialogue with the given NPC character.
735 2397
736=cut 2398=cut
737 2399
2400our $SAY_CHANNEL = {
2401 id => "say",
2402 title => "Map",
2403 reply => "say ",
2404 tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
2405};
2406
2407our $CHAT_CHANNEL = {
2408 id => "chat",
2409 title => "Chat",
2410 reply => "chat ",
2411 tooltip => "Player chat and shouts, global to the server.",
2412};
2413
738# rough implementation of a future "reply" method that works 2414# rough implementation of a future "reply" method that works
739# with dialog boxes. 2415# with dialog boxes.
2416#TODO: the first argument must go, split into a $npc->reply_to ( method
740sub cf::object::player::reply($$$;$) { 2417sub cf::object::player::reply($$$;$) {
741 my ($self, $npc, $msg, $flags) = @_; 2418 my ($self, $npc, $msg, $flags) = @_;
742 2419
743 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2420 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744 2421
745 if ($self->{record_replies}) { 2422 if ($self->{record_replies}) {
746 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2423 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2424
747 } else { 2425 } else {
2426 my $pl = $self->contr;
2427
2428 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2429 my $dialog = $pl->{npc_dialog};
2430 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2431
2432 } else {
748 $msg = $npc->name . " says: $msg" if $npc; 2433 $msg = $npc->name . " says: $msg" if $npc;
749 $self->message ($msg, $flags); 2434 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2435 }
750 } 2436 }
751} 2437}
752 2438
753=item $player->ext_reply ($msgid, $msgtype, %msg) 2439=item $object->send_msg ($channel, $msg, $color, [extra...])
754 2440
755Sends an ext reply to the player.
756
757=cut 2441=cut
758 2442
759sub cf::player::ext_reply($$$%) { 2443sub cf::object::send_msg {
760 my ($self, $id, %msg) = @_; 2444 my $pl = shift->contr
761 2445 or return;
762 $msg{msgid} = $id; 2446 $pl->send_msg (@_);
763
764 $self->send ("ext " . to_json \%msg);
765} 2447}
766 2448
767=item $player_object->may ("access") 2449=item $player_object->may ("access")
768 2450
769Returns wether the given player is authorized to access resource "access" 2451Returns wether the given player is authorized to access resource "access"
778 (ref $cf::CFG{"may_$access"} 2460 (ref $cf::CFG{"may_$access"}
779 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2461 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780 : $cf::CFG{"may_$access"}) 2462 : $cf::CFG{"may_$access"})
781} 2463}
782 2464
783=cut 2465=item $player_object->enter_link
784 2466
785############################################################################# 2467Freezes the player and moves him/her to a special map (C<{link}>).
2468
2469The player should be reasonably safe there for short amounts of time (e.g.
2470for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2471though, as the palyer cannot control the character while it is on the link
2472map.
2473
2474Will never block.
2475
2476=item $player_object->leave_link ($map, $x, $y)
2477
2478Moves the player out of the special C<{link}> map onto the specified
2479map. If the map is not valid (or omitted), the player will be moved back
2480to the location he/she was before the call to C<enter_link>, or, if that
2481fails, to the emergency map position.
2482
2483Might block.
2484
2485=cut
2486
2487sub link_map {
2488 unless ($LINK_MAP) {
2489 $LINK_MAP = cf::map::find "{link}"
2490 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2491 $LINK_MAP->load;
2492 }
2493
2494 $LINK_MAP
2495}
2496
2497sub cf::object::player::enter_link {
2498 my ($self) = @_;
2499
2500 $self->deactivate_recursive;
2501
2502 return if UNIVERSAL::isa $self->map, "ext::map_link";
2503
2504 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2505 if $self->map && $self->map->{path} ne "{link}";
2506
2507 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2508}
2509
2510sub cf::object::player::leave_link {
2511 my ($self, $map, $x, $y) = @_;
2512
2513 return unless $self->contr->active;
2514
2515 my $link_pos = delete $self->{_link_pos};
2516
2517 unless ($map) {
2518 # restore original map position
2519 ($map, $x, $y) = @{ $link_pos || [] };
2520 $map = cf::map::find $map;
2521
2522 unless ($map) {
2523 ($map, $x, $y) = @$EMERGENCY_POSITION;
2524 $map = cf::map::find $map
2525 or die "FATAL: cannot load emergency map\n";
2526 }
2527 }
2528
2529 ($x, $y) = (-1, -1)
2530 unless (defined $x) && (defined $y);
2531
2532 # use -1 or undef as default coordinates, not 0, 0
2533 ($x, $y) = ($map->enter_x, $map->enter_y)
2534 if $x <=0 && $y <= 0;
2535
2536 $map->load;
2537 $map->load_neighbours;
2538
2539 return unless $self->contr->active;
2540 $self->flag (cf::FLAG_DEBUG, 0);#d# temp
2541 $self->activate_recursive;
2542
2543 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2544 $self->enter_map ($map, $x, $y);
2545}
2546
2547=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2548
2549Moves the player to the given map-path and coordinates by first freezing
2550her, loading and preparing them map, calling the provided $check callback
2551that has to return the map if sucecssful, and then unfreezes the player on
2552the new (success) or old (failed) map position. In either case, $done will
2553be called at the end of this process.
2554
2555Note that $check will be called with a potentially non-loaded map, so if
2556it needs a loaded map it has to call C<< ->load >>.
2557
2558=cut
2559
2560our $GOTOGEN;
2561
2562sub cf::object::player::goto {
2563 my ($self, $path, $x, $y, $check, $done) = @_;
2564
2565 # do generation counting so two concurrent goto's will be executed in-order
2566 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2567
2568 $self->enter_link;
2569
2570 (async {
2571 $Coro::current->{desc} = "player::goto $path $x $y";
2572
2573 # *tag paths override both path and x|y
2574 if ($path =~ /^\*(.*)$/) {
2575 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2576 my $ob = $obs[rand @obs];
2577
2578 # see if we actually can go there
2579 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2580 $ob = $obs[rand @obs];
2581 } else {
2582 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2583 }
2584 # else put us there anyways for now #d#
2585
2586 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2587 } else {
2588 ($path, $x, $y) = (undef, undef, undef);
2589 }
2590 }
2591
2592 my $map = eval {
2593 my $map = defined $path ? cf::map::find $path : undef;
2594
2595 if ($map) {
2596 $map = $map->customise_for ($self);
2597 $map = $check->($map) if $check && $map;
2598 } else {
2599 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2600 }
2601
2602 $map
2603 };
2604
2605 if ($@) {
2606 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2607 LOG llevError | logBacktrace, Carp::longmess $@;
2608 }
2609
2610 if ($gen == $self->{_goto_generation}) {
2611 delete $self->{_goto_generation};
2612 $self->leave_link ($map, $x, $y);
2613 }
2614
2615 $done->() if $done;
2616 })->prio (1);
2617}
2618
2619=item $player_object->enter_exit ($exit_object)
2620
2621=cut
2622
2623sub parse_random_map_params {
2624 my ($spec) = @_;
2625
2626 my $rmp = { # defaults
2627 xsize => (cf::rndm 15, 40),
2628 ysize => (cf::rndm 15, 40),
2629 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2630 #layout => string,
2631 };
2632
2633 for (split /\n/, $spec) {
2634 my ($k, $v) = split /\s+/, $_, 2;
2635
2636 $rmp->{lc $k} = $v if (length $k) && (length $v);
2637 }
2638
2639 $rmp
2640}
2641
2642sub prepare_random_map {
2643 my ($exit) = @_;
2644
2645 # all this does is basically replace the /! path by
2646 # a new random map path (?random/...) with a seed
2647 # that depends on the exit object
2648
2649 my $rmp = parse_random_map_params $exit->msg;
2650
2651 if ($exit->map) {
2652 $rmp->{region} = $exit->region->name;
2653 $rmp->{origin_map} = $exit->map->path;
2654 $rmp->{origin_x} = $exit->x;
2655 $rmp->{origin_y} = $exit->y;
2656
2657 $exit->map->touch;
2658 }
2659
2660 $rmp->{random_seed} ||= $exit->random_seed;
2661
2662 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2663 my $md5 = Digest::MD5::md5_hex $data;
2664 my $meta = "$RANDOMDIR/$md5.meta";
2665
2666 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2667 aio_write $fh, 0, (length $data), $data, 0;
2668 undef $fh;
2669 aio_rename "$meta~", $meta;
2670
2671 my $slaying = "?random/$md5";
2672
2673 if ($exit->valid) {
2674 $exit->slaying ("?random/$md5");
2675 $exit->msg (undef);
2676 }
2677 }
2678}
2679
2680sub cf::object::player::enter_exit {
2681 my ($self, $exit) = @_;
2682
2683 return unless $self->type == cf::PLAYER;
2684
2685 $self->enter_link;
2686
2687 (async {
2688 $Coro::current->{desc} = "enter_exit";
2689
2690 unless (eval {
2691 $self->deactivate_recursive; # just to be sure
2692
2693 # random map handling
2694 {
2695 my $guard = cf::lock_acquire "exit_prepare:$exit";
2696
2697 prepare_random_map $exit
2698 if $exit->slaying eq "/!";
2699 }
2700
2701 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2702 my $x = $exit->stats->hp;
2703 my $y = $exit->stats->sp;
2704
2705 $self->goto ($map, $x, $y);
2706
2707 # if exit is damned, update players death & WoR home-position
2708 $self->contr->savebed ($map, $x, $y)
2709 if $exit->flag (cf::FLAG_DAMNED);
2710
2711 1
2712 }) {
2713 $self->message ("Something went wrong deep within the deliantra server. "
2714 . "I'll try to bring you back to the map you were before. "
2715 . "Please report this to the dungeon master!",
2716 cf::NDI_UNIQUE | cf::NDI_RED);
2717
2718 warn "ERROR in enter_exit: $@";
2719 $self->leave_link;
2720 }
2721 })->prio (1);
2722}
2723
2724=head3 cf::client
2725
2726=over 4
2727
2728=item $client->send_drawinfo ($text, $flags)
2729
2730Sends a drawinfo packet to the client. Circumvents output buffering so
2731should not be used under normal circumstances.
2732
2733=cut
2734
2735sub cf::client::send_drawinfo {
2736 my ($self, $text, $flags) = @_;
2737
2738 utf8::encode $text;
2739 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2740}
2741
2742=item $client->send_msg ($channel, $msg, $color, [extra...])
2743
2744Send a drawinfo or msg packet to the client, formatting the msg for the
2745client if neccessary. C<$type> should be a string identifying the type of
2746the message, with C<log> being the default. If C<$color> is negative, suppress
2747the message unless the client supports the msg packet.
2748
2749=cut
2750
2751# non-persistent channels (usually the info channel)
2752our %CHANNEL = (
2753 "c/identify" => {
2754 id => "infobox",
2755 title => "Identify",
2756 reply => undef,
2757 tooltip => "Items recently identified",
2758 },
2759 "c/examine" => {
2760 id => "infobox",
2761 title => "Examine",
2762 reply => undef,
2763 tooltip => "Signs and other items you examined",
2764 },
2765 "c/book" => {
2766 id => "infobox",
2767 title => "Book",
2768 reply => undef,
2769 tooltip => "The contents of a note or book",
2770 },
2771 "c/lookat" => {
2772 id => "infobox",
2773 title => "Look",
2774 reply => undef,
2775 tooltip => "What you saw there",
2776 },
2777 "c/who" => {
2778 id => "infobox",
2779 title => "Players",
2780 reply => undef,
2781 tooltip => "Shows players who are currently online",
2782 },
2783 "c/body" => {
2784 id => "infobox",
2785 title => "Body Parts",
2786 reply => undef,
2787 tooltip => "Shows which body parts you posess and are available",
2788 },
2789 "c/uptime" => {
2790 id => "infobox",
2791 title => "Uptime",
2792 reply => undef,
2793 tooltip => "How long the server has been running since last restart",
2794 },
2795 "c/mapinfo" => {
2796 id => "infobox",
2797 title => "Map Info",
2798 reply => undef,
2799 tooltip => "Information related to the maps",
2800 },
2801 "c/party" => {
2802 id => "party",
2803 title => "Party",
2804 reply => "gsay ",
2805 tooltip => "Messages and chat related to your party",
2806 },
2807);
2808
2809sub cf::client::send_msg {
2810 my ($self, $channel, $msg, $color, @extra) = @_;
2811
2812 $msg = $self->pl->expand_cfpod ($msg)
2813 unless $color & cf::NDI_VERBATIM;
2814
2815 $color &= cf::NDI_CLIENT_MASK; # just in case...
2816
2817 # check predefined channels, for the benefit of C
2818 if ($CHANNEL{$channel}) {
2819 $channel = $CHANNEL{$channel};
2820
2821 $self->ext_msg (channel_info => $channel)
2822 if $self->can_msg;
2823
2824 $channel = $channel->{id};
2825
2826 } elsif (ref $channel) {
2827 # send meta info to client, if not yet sent
2828 unless (exists $self->{channel}{$channel->{id}}) {
2829 $self->{channel}{$channel->{id}} = $channel;
2830 $self->ext_msg (channel_info => $channel)
2831 if $self->can_msg;
2832 }
2833
2834 $channel = $channel->{id};
2835 }
2836
2837 return unless @extra || length $msg;
2838
2839 if ($self->can_msg) {
2840 # default colour, mask it out
2841 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2842 if $color & cf::NDI_DEF;
2843
2844 my $pkt = "msg "
2845 . $self->{json_coder}->encode (
2846 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2847 );
2848
2849 # try lzf for large packets
2850 $pkt = "lzf " . Compress::LZF::compress $pkt
2851 if 1024 <= length $pkt and $self->{can_lzf};
2852
2853 # split very large packets
2854 if (8192 < length $pkt and $self->{can_lzf}) {
2855 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2856 $pkt = "frag";
2857 }
2858
2859 $self->send_packet ($pkt);
2860 } else {
2861 if ($color >= 0) {
2862 # replace some tags by gcfclient-compatible ones
2863 for ($msg) {
2864 1 while
2865 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2866 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2867 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2868 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2869 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2870 }
2871
2872 $color &= cf::NDI_COLOR_MASK;
2873
2874 utf8::encode $msg;
2875
2876 if (0 && $msg =~ /\[/) {
2877 # COMMAND/INFO
2878 $self->send_packet ("drawextinfo $color 10 8 $msg")
2879 } else {
2880 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2881 $self->send_packet ("drawinfo $color $msg")
2882 }
2883 }
2884 }
2885}
2886
2887=item $client->ext_msg ($type, @msg)
2888
2889Sends an ext event to the client.
2890
2891=cut
2892
2893sub cf::client::ext_msg($$@) {
2894 my ($self, $type, @msg) = @_;
2895
2896 if ($self->extcmd == 2) {
2897 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2898 } elsif ($self->extcmd == 1) { # TODO: remove
2899 push @msg, msgtype => "event_$type";
2900 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2901 }
2902}
2903
2904=item $client->ext_reply ($msgid, @msg)
2905
2906Sends an ext reply to the client.
2907
2908=cut
2909
2910sub cf::client::ext_reply($$@) {
2911 my ($self, $id, @msg) = @_;
2912
2913 if ($self->extcmd == 2) {
2914 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2915 } elsif ($self->extcmd == 1) {
2916 #TODO: version 1, remove
2917 unshift @msg, msgtype => "reply", msgid => $id;
2918 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2919 }
2920}
2921
2922=item $success = $client->query ($flags, "text", \&cb)
2923
2924Queues a query to the client, calling the given callback with
2925the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2926C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2927
2928Queries can fail, so check the return code. Or don't, as queries will
2929become reliable at some point in the future.
2930
2931=cut
2932
2933sub cf::client::query {
2934 my ($self, $flags, $text, $cb) = @_;
2935
2936 return unless $self->state == ST_PLAYING
2937 || $self->state == ST_SETUP
2938 || $self->state == ST_CUSTOM;
2939
2940 $self->state (ST_CUSTOM);
2941
2942 utf8::encode $text;
2943 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2944
2945 $self->send_packet ($self->{query_queue}[0][0])
2946 if @{ $self->{query_queue} } == 1;
2947
2948 1
2949}
2950
2951cf::client->attach (
2952 on_connect => sub {
2953 my ($ns) = @_;
2954
2955 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2956 },
2957 on_reply => sub {
2958 my ($ns, $msg) = @_;
2959
2960 # this weird shuffling is so that direct followup queries
2961 # get handled first
2962 my $queue = delete $ns->{query_queue}
2963 or return; # be conservative, not sure how that can happen, but we saw a crash here
2964
2965 (shift @$queue)->[1]->($msg);
2966 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2967
2968 push @{ $ns->{query_queue} }, @$queue;
2969
2970 if (@{ $ns->{query_queue} } == @$queue) {
2971 if (@$queue) {
2972 $ns->send_packet ($ns->{query_queue}[0][0]);
2973 } else {
2974 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2975 }
2976 }
2977 },
2978 on_exticmd => sub {
2979 my ($ns, $buf) = @_;
2980
2981 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2982
2983 if (ref $msg) {
2984 my ($type, $reply, @payload) =
2985 "ARRAY" eq ref $msg
2986 ? @$msg
2987 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2988
2989 my @reply;
2990
2991 if (my $cb = $EXTICMD{$type}) {
2992 @reply = $cb->($ns, @payload);
2993 }
2994
2995 $ns->ext_reply ($reply, @reply)
2996 if $reply;
2997
2998 } else {
2999 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3000 }
3001
3002 cf::override;
3003 },
3004);
3005
3006=item $client->async (\&cb)
3007
3008Create a new coroutine, running the specified callback. The coroutine will
3009be automatically cancelled when the client gets destroyed (e.g. on logout,
3010or loss of connection).
3011
3012=cut
3013
3014sub cf::client::async {
3015 my ($self, $cb) = @_;
3016
3017 my $coro = &Coro::async ($cb);
3018
3019 $coro->on_destroy (sub {
3020 delete $self->{_coro}{$coro+0};
3021 });
3022
3023 $self->{_coro}{$coro+0} = $coro;
3024
3025 $coro
3026}
3027
3028cf::client->attach (
3029 on_destroy => sub {
3030 my ($ns) = @_;
3031
3032 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
3033 },
3034);
3035
3036=back
3037
786 3038
787=head2 SAFE SCRIPTING 3039=head2 SAFE SCRIPTING
788 3040
789Functions that provide a safe environment to compile and execute 3041Functions that provide a safe environment to compile and execute
790snippets of perl code without them endangering the safety of the server 3042snippets of perl code without them endangering the safety of the server
797our $safe = new Safe "safe"; 3049our $safe = new Safe "safe";
798our $safe_hole = new Safe::Hole; 3050our $safe_hole = new Safe::Hole;
799 3051
800$SIG{FPE} = 'IGNORE'; 3052$SIG{FPE} = 'IGNORE';
801 3053
802$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3054$safe->permit_only (Opcode::opset qw(
3055 :base_core :base_mem :base_orig :base_math
3056 grepstart grepwhile mapstart mapwhile
3057 sort time
3058));
803 3059
804# here we export the classes and methods available to script code 3060# here we export the classes and methods available to script code
805 3061
806=pod 3062=pod
807 3063
808The following fucntions and emthods are available within a safe environment: 3064The following functions and methods are available within a safe environment:
809 3065
810 cf::object contr pay_amount pay_player map 3066 cf::object
3067 contr pay_amount pay_player map x y force_find force_add destroy
3068 insert remove name archname title slaying race decrease split
3069
811 cf::object::player player 3070 cf::object::player
812 cf::player peaceful 3071 player
813 cf::map trigger 3072
3073 cf::player
3074 peaceful
3075
3076 cf::map
3077 trigger
814 3078
815=cut 3079=cut
816 3080
817for ( 3081for (
818 ["cf::object" => qw(contr pay_amount pay_player map)], 3082 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3083 insert remove inv nrof name archname title slaying race
3084 decrease split destroy change_exp)],
819 ["cf::object::player" => qw(player)], 3085 ["cf::object::player" => qw(player)],
820 ["cf::player" => qw(peaceful)], 3086 ["cf::player" => qw(peaceful)],
821 ["cf::map" => qw(trigger)], 3087 ["cf::map" => qw(trigger)],
822) { 3088) {
823 no strict 'refs'; 3089 no strict 'refs';
894=back 3160=back
895 3161
896=cut 3162=cut
897 3163
898############################################################################# 3164#############################################################################
3165# the server's init and main functions
899 3166
900=head2 EXTENSION DATABASE SUPPORT 3167sub load_facedata($) {
3168 my ($path) = @_;
901 3169
902Crossfire maintains a very simple database for extension use. It can 3170 # HACK to clear player env face cache, we need some signal framework
903currently store anything that can be serialised using Storable, which 3171 # for this (global event?)
904excludes objects. 3172 %ext::player_env::MUSIC_FACE_CACHE = ();
905 3173
906The parameter C<$family> should best start with the name of the extension 3174 my $enc = JSON::XS->new->utf8->canonical->relaxed;
907using it, it should be unique.
908 3175
909=over 4 3176 warn "loading facedata from $path\n";
910 3177
911=item $hashref = cf::db_get $family 3178 my $facedata;
3179 0 < aio_load $path, $facedata
3180 or die "$path: $!";
912 3181
913Return a hashref for use by the extension C<$family>, which can be 3182 $facedata = Coro::Storable::thaw $facedata;
914modified. After modifications, you have to call C<cf::db_dirty> or
915C<cf::db_sync>.
916 3183
917=item $value = cf::db_get $family => $key 3184 $facedata->{version} == 2
3185 or cf::cleanup "$path: version mismatch, cannot proceed.";
918 3186
919Returns a single value from the database 3187 # patch in the exptable
3188 $facedata->{resource}{"res/exp_table"} = {
3189 type => FT_RSRC,
3190 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
3191 };
3192 cf::cede_to_tick;
920 3193
921=item cf::db_put $family => $hashref 3194 {
3195 my $faces = $facedata->{faceinfo};
922 3196
923Stores the given family hashref into the database. Updates are delayed, if 3197 while (my ($face, $info) = each %$faces) {
924you want the data to be synced to disk immediately, use C<cf::db_sync>. 3198 my $idx = (cf::face::find $face) || cf::face::alloc $face;
925 3199
926=item cf::db_put $family => $key => $value 3200 cf::face::set_visibility $idx, $info->{visibility};
3201 cf::face::set_magicmap $idx, $info->{magicmap};
3202 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3203 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
927 3204
928Stores the given C<$value> in the family hash. Updates are delayed, if you 3205 cf::cede_to_tick;
929want the data to be synced to disk immediately, use C<cf::db_sync>. 3206 }
930 3207
931=item cf::db_dirty 3208 while (my ($face, $info) = each %$faces) {
3209 next unless $info->{smooth};
932 3210
933Marks the database as dirty, to be updated at a later time. 3211 my $idx = cf::face::find $face
3212 or next;
934 3213
935=item cf::db_sync 3214 if (my $smooth = cf::face::find $info->{smooth}) {
3215 cf::face::set_smooth $idx, $smooth;
3216 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3217 } else {
3218 warn "smooth face '$info->{smooth}' not found for face '$face'";
3219 }
936 3220
937Immediately write the database to disk I<if it is dirty>. 3221 cf::cede_to_tick;
3222 }
3223 }
938 3224
939=cut 3225 {
3226 my $anims = $facedata->{animinfo};
940 3227
941our $DB; 3228 while (my ($anim, $info) = each %$anims) {
3229 cf::anim::set $anim, $info->{frames}, $info->{facings};
3230 cf::cede_to_tick;
3231 }
3232
3233 cf::anim::invalidate_all; # d'oh
3234 }
3235
3236 {
3237 # TODO: for gcfclient pleasure, we should give resources
3238 # that gcfclient doesn't grok a >10000 face index.
3239 my $res = $facedata->{resource};
3240
3241 while (my ($name, $info) = each %$res) {
3242 if (defined $info->{type}) {
3243 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3244 my $data;
3245
3246 if ($info->{type} & 1) {
3247 # prepend meta info
3248
3249 my $meta = $enc->encode ({
3250 name => $name,
3251 %{ $info->{meta} || {} },
3252 });
3253
3254 $data = pack "(w/a*)*", $meta, $info->{data};
3255 } else {
3256 $data = $info->{data};
3257 }
3258
3259 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3260 cf::face::set_type $idx, $info->{type};
3261 } else {
3262 $RESOURCE{$name} = $info;
3263 }
3264
3265 cf::cede_to_tick;
3266 }
3267 }
3268
3269 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3270
3271 1
3272}
3273
3274cf::global->attach (on_resource_update => sub {
3275 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3276 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3277
3278 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3279 my $sound = $soundconf->{compat}[$_]
3280 or next;
3281
3282 my $face = cf::face::find "sound/$sound->[1]";
3283 cf::sound::set $sound->[0] => $face;
3284 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3285 }
3286
3287 while (my ($k, $v) = each %{$soundconf->{event}}) {
3288 my $face = cf::face::find "sound/$v";
3289 cf::sound::set $k => $face;
3290 }
3291 }
3292});
3293
3294register_exticmd fx_want => sub {
3295 my ($ns, $want) = @_;
3296
3297 while (my ($k, $v) = each %$want) {
3298 $ns->fx_want ($k, $v);
3299 }
3300};
3301
3302sub load_resource_file($) {
3303 my $guard = lock_acquire "load_resource_file";
3304
3305 my $status = load_resource_file_ $_[0];
3306 get_slot 0.1, 100;
3307 cf::arch::commit_load;
3308
3309 $status
3310}
3311
3312sub reload_regions {
3313 # HACK to clear player env face cache, we need some signal framework
3314 # for this (global event?)
3315 %ext::player_env::MUSIC_FACE_CACHE = ();
3316
3317 load_resource_file "$MAPDIR/regions"
3318 or die "unable to load regions file\n";
3319
3320 for (cf::region::list) {
3321 $_->{match} = qr/$_->{match}/
3322 if exists $_->{match};
3323 }
3324}
3325
3326sub reload_facedata {
3327 load_facedata "$DATADIR/facedata"
3328 or die "unable to load facedata\n";
3329}
3330
3331sub reload_archetypes {
3332 load_resource_file "$DATADIR/archetypes"
3333 or die "unable to load archetypes\n";
3334}
3335
3336sub reload_treasures {
3337 load_resource_file "$DATADIR/treasures"
3338 or die "unable to load treasurelists\n";
3339}
3340
3341sub reload_resources {
3342 warn "reloading resource files...\n";
3343
3344 reload_facedata;
3345 reload_archetypes;
3346 reload_regions;
3347 reload_treasures;
3348
3349 warn "finished reloading resource files\n";
3350}
3351
3352sub init {
3353 my $guard = freeze_mainloop;
3354
3355 evthread_start IO::AIO::poll_fileno;
3356
3357 reload_resources;
3358}
3359
3360sub reload_config {
3361 open my $fh, "<:utf8", "$CONFDIR/config"
3362 or return;
3363
3364 local $/;
3365 *CFG = YAML::Load <$fh>;
3366
3367 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3368
3369 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3370 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3371
3372 if (exists $CFG{mlockall}) {
3373 eval {
3374 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3375 and die "WARNING: m(un)lockall failed: $!\n";
3376 };
3377 warn $@ if $@;
3378 }
3379}
3380
3381sub pidfile() {
3382 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3383 or die "$PIDFILE: $!";
3384 flock $fh, &Fcntl::LOCK_EX
3385 or die "$PIDFILE: flock: $!";
3386 $fh
3387}
3388
3389# make sure only one server instance is running at any one time
3390sub atomic {
3391 my $fh = pidfile;
3392
3393 my $pid = <$fh>;
3394 kill 9, $pid if $pid > 0;
3395
3396 seek $fh, 0, 0;
3397 print $fh $$;
3398}
3399
3400sub main {
3401 atomic;
3402
3403 # we must not ever block the main coroutine
3404 local $Coro::idle = sub {
3405 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3406 (async {
3407 $Coro::current->{desc} = "IDLE BUG HANDLER";
3408 EV::loop EV::LOOP_ONESHOT;
3409 })->prio (Coro::PRIO_MAX);
3410 };
3411
3412 {
3413 my $guard = freeze_mainloop;
3414 reload_config;
3415 db_init;
3416 load_extensions;
3417
3418 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3419 }
3420
3421 utime time, time, $RUNTIMEFILE;
3422
3423 # no (long-running) fork's whatsoever before this point(!)
3424 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3425
3426 EV::loop;
3427}
3428
3429#############################################################################
3430# initialisation and cleanup
3431
3432# install some emergency cleanup handlers
3433BEGIN {
3434 our %SIGWATCHER = ();
3435 for my $signal (qw(INT HUP TERM)) {
3436 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3437 cf::cleanup "SIG$signal";
3438 };
3439 }
3440}
3441
3442sub write_runtime_sync {
3443 # first touch the runtime file to show we are still running:
3444 # the fsync below can take a very very long time.
3445
3446 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3447
3448 my $guard = cf::lock_acquire "write_runtime";
3449
3450 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3451 or return;
3452
3453 my $value = $cf::RUNTIME + 90 + 10;
3454 # 10 is the runtime save interval, for a monotonic clock
3455 # 60 allows for the watchdog to kill the server.
3456
3457 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3458 and return;
3459
3460 # always fsync - this file is important
3461 aio_fsync $fh
3462 and return;
3463
3464 # touch it again to show we are up-to-date
3465 aio_utime $fh, undef, undef;
3466
3467 close $fh
3468 or return;
3469
3470 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3471 and return;
3472
3473 warn "runtime file written.\n";
3474
3475 1
3476}
3477
3478our $uuid_lock;
3479our $uuid_skip;
3480
3481sub write_uuid_sync($) {
3482 $uuid_skip ||= $_[0];
3483
3484 return if $uuid_lock;
3485 local $uuid_lock = 1;
3486
3487 my $uuid = "$LOCALDIR/uuid";
3488
3489 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3490 or return;
3491
3492 my $value = uuid_str $uuid_skip + uuid_seq uuid_cur;
3493 $uuid_skip = 0;
3494
3495 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3496 and return;
3497
3498 # always fsync - this file is important
3499 aio_fsync $fh
3500 and return;
3501
3502 close $fh
3503 or return;
3504
3505 aio_rename "$uuid~", $uuid
3506 and return;
3507
3508 warn "uuid file written ($value).\n";
3509
3510 1
3511
3512}
3513
3514sub write_uuid($$) {
3515 my ($skip, $sync) = @_;
3516
3517 $sync ? write_uuid_sync $skip
3518 : async { write_uuid_sync $skip };
3519}
3520
3521sub emergency_save() {
3522 my $freeze_guard = cf::freeze_mainloop;
3523
3524 warn "enter emergency perl save\n";
3525
3526 cf::sync_job {
3527 # use a peculiar iteration method to avoid tripping on perl
3528 # refcount bugs in for. also avoids problems with players
3529 # and maps saved/destroyed asynchronously.
3530 warn "begin emergency player save\n";
3531 for my $login (keys %cf::PLAYER) {
3532 my $pl = $cf::PLAYER{$login} or next;
3533 $pl->valid or next;
3534 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3535 $pl->save;
3536 }
3537 warn "end emergency player save\n";
3538
3539 warn "begin emergency map save\n";
3540 for my $path (keys %cf::MAP) {
3541 my $map = $cf::MAP{$path} or next;
3542 $map->valid or next;
3543 $map->save;
3544 }
3545 warn "end emergency map save\n";
3546
3547 warn "begin emergency database checkpoint\n";
3548 BDB::db_env_txn_checkpoint $DB_ENV;
3549 warn "end emergency database checkpoint\n";
3550
3551 warn "begin write uuid\n";
3552 write_uuid_sync 1;
3553 warn "end write uuid\n";
3554 };
3555
3556 warn "leave emergency perl save\n";
3557}
3558
3559sub post_cleanup {
3560 my ($make_core) = @_;
3561
3562 warn Carp::longmess "post_cleanup backtrace"
3563 if $make_core;
3564
3565 my $fh = pidfile;
3566 unlink $PIDFILE if <$fh> == $$;
3567}
3568
3569# a safer delete_package, copied from Symbol
3570sub clear_package($) {
3571 my $pkg = shift;
3572
3573 # expand to full symbol table name if needed
3574 unless ($pkg =~ /^main::.*::$/) {
3575 $pkg = "main$pkg" if $pkg =~ /^::/;
3576 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3577 $pkg .= '::' unless $pkg =~ /::$/;
3578 }
3579
3580 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3581 my $stem_symtab = *{$stem}{HASH};
3582
3583 defined $stem_symtab and exists $stem_symtab->{$leaf}
3584 or return;
3585
3586 # clear all symbols
3587 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3588 for my $name (keys %$leaf_symtab) {
3589 _gv_clear *{"$pkg$name"};
3590# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3591 }
3592 warn "cleared package #$pkg\n";#d#
3593}
3594
3595our $RELOAD; # how many times to reload
3596
3597sub do_reload_perl() {
3598 # can/must only be called in main
3599 if ($Coro::current != $Coro::main) {
3600 warn "can only reload from main coroutine";
3601 return;
3602 }
3603
3604 return if $RELOAD++;
3605
3606 while ($RELOAD) {
3607 warn "reloading...";
3608
3609 warn "entering sync_job";
3610
3611 cf::sync_job {
3612 cf::write_runtime_sync; # external watchdog should not bark
3613 cf::emergency_save;
3614 cf::write_runtime_sync; # external watchdog should not bark
3615
3616 warn "syncing database to disk";
3617 BDB::db_env_txn_checkpoint $DB_ENV;
3618
3619 # if anything goes wrong in here, we should simply crash as we already saved
3620
3621 warn "flushing outstanding aio requests";
3622 while (IO::AIO::nreqs || BDB::nreqs) {
3623 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3624 }
3625
3626 warn "cancelling all extension coros";
3627 $_->cancel for values %EXT_CORO;
3628 %EXT_CORO = ();
3629
3630 warn "removing commands";
3631 %COMMAND = ();
3632
3633 warn "removing ext/exti commands";
3634 %EXTCMD = ();
3635 %EXTICMD = ();
3636
3637 warn "unloading/nuking all extensions";
3638 for my $pkg (@EXTS) {
3639 warn "... unloading $pkg";
3640
3641 if (my $cb = $pkg->can ("unload")) {
3642 eval {
3643 $cb->($pkg);
3644 1
3645 } or warn "$pkg unloaded, but with errors: $@";
3646 }
3647
3648 warn "... clearing $pkg";
3649 clear_package $pkg;
3650 }
3651
3652 warn "unloading all perl modules loaded from $LIBDIR";
3653 while (my ($k, $v) = each %INC) {
3654 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3655
3656 warn "... unloading $k";
3657 delete $INC{$k};
3658
3659 $k =~ s/\.pm$//;
3660 $k =~ s/\//::/g;
3661
3662 if (my $cb = $k->can ("unload_module")) {
3663 $cb->();
3664 }
3665
3666 clear_package $k;
3667 }
3668
3669 warn "getting rid of safe::, as good as possible";
3670 clear_package "safe::$_"
3671 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
3672
3673 warn "unloading cf.pm \"a bit\"";
3674 delete $INC{"cf.pm"};
3675 delete $INC{"cf/pod.pm"};
3676
3677 # don't, removes xs symbols, too,
3678 # and global variables created in xs
3679 #clear_package __PACKAGE__;
3680
3681 warn "unload completed, starting to reload now";
3682
3683 warn "reloading cf.pm";
3684 require cf;
3685 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
3686
3687 warn "loading config and database again";
3688 cf::reload_config;
3689
3690 warn "loading extensions";
3691 cf::load_extensions;
3692
3693 warn "reattaching attachments to objects/players";
3694 _global_reattach; # objects, sockets
3695 warn "reattaching attachments to maps";
3696 reattach $_ for values %MAP;
3697 warn "reattaching attachments to players";
3698 reattach $_ for values %PLAYER;
3699
3700 warn "leaving sync_job";
3701
3702 1
3703 } or do {
3704 warn $@;
3705 cf::cleanup "error while reloading, exiting.";
3706 };
3707
3708 warn "reloaded";
3709 --$RELOAD;
3710 }
3711};
3712
3713our $RELOAD_WATCHER; # used only during reload
3714
3715sub reload_perl() {
3716 # doing reload synchronously and two reloads happen back-to-back,
3717 # coro crashes during coro_state_free->destroy here.
3718
3719 $RELOAD_WATCHER ||= EV::timer 0, 0, sub {
3720 do_reload_perl;
3721 undef $RELOAD_WATCHER;
3722 };
3723}
3724
3725register_command "reload" => sub {
3726 my ($who, $arg) = @_;
3727
3728 if ($who->flag (FLAG_WIZ)) {
3729 $who->message ("reloading server.");
3730 async {
3731 $Coro::current->{desc} = "perl_reload";
3732 reload_perl;
3733 };
3734 }
3735};
3736
3737unshift @INC, $LIBDIR;
3738
3739my $bug_warning = 0;
3740
3741our @WAIT_FOR_TICK;
3742our @WAIT_FOR_TICK_BEGIN;
3743
3744sub wait_for_tick {
3745 return if tick_inhibit || $Coro::current == $Coro::main;
3746
3747 my $signal = new Coro::Signal;
3748 push @WAIT_FOR_TICK, $signal;
3749 $signal->wait;
3750}
3751
3752sub wait_for_tick_begin {
3753 return if tick_inhibit || $Coro::current == $Coro::main;
3754
3755 my $signal = new Coro::Signal;
3756 push @WAIT_FOR_TICK_BEGIN, $signal;
3757 $signal->wait;
3758}
3759
3760sub tick {
3761 if ($Coro::current != $Coro::main) {
3762 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3763 unless ++$bug_warning > 10;
3764 return;
3765 }
3766
3767 cf::server_tick; # one server iteration
3768
3769 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3770 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
3771 Coro::async_pool {
3772 $Coro::current->{desc} = "runtime saver";
3773 write_runtime_sync
3774 or warn "ERROR: unable to write runtime file: $!";
3775 };
3776 }
3777
3778 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3779 $sig->send;
3780 }
3781 while (my $sig = shift @WAIT_FOR_TICK) {
3782 $sig->send;
3783 }
3784
3785 $LOAD = ($NOW - $TICK_START) / $TICK;
3786 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3787
3788 if (0) {
3789 if ($NEXT_TICK) {
3790 my $jitter = $TICK_START - $NEXT_TICK;
3791 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3792 warn "jitter $JITTER\n";#d#
3793 }
3794 }
3795}
942 3796
943{ 3797{
944 my $path = cf::localdir . "/database.pst"; 3798 # configure BDB
945 3799
946 sub db_load() { 3800 BDB::min_parallel 8;
947 warn "loading database $path\n";#d# remove later 3801 BDB::max_poll_reqs $TICK * 0.1;
948 $DB = stat $path ? Storable::retrieve $path : { }; 3802 $AnyEvent::BDB::WATCHER->priority (1);
949 }
950 3803
951 my $pid; 3804 unless ($DB_ENV) {
3805 $DB_ENV = BDB::db_env_create;
3806 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3807 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3808 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3809 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3810 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
952 3811
953 sub db_save() { 3812 cf::sync_job {
954 warn "saving database $path\n";#d# remove later
955 waitpid $pid, 0 if $pid;
956 if (0 == ($pid = fork)) {
957 $DB->{_meta}{version} = 1;
958 Storable::nstore $DB, "$path~";
959 rename "$path~", $path;
960 cf::_exit 0 if defined $pid;
961 }
962 }
963
964 my $dirty;
965
966 sub db_sync() {
967 db_save if $dirty;
968 undef $dirty;
969 }
970
971 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
972 db_sync;
973 });
974
975 sub db_dirty() {
976 $dirty = 1;
977 $idle->start;
978 }
979
980 sub db_get($;$) {
981 @_ >= 2
982 ? $DB->{$_[0]}{$_[1]}
983 : ($DB->{$_[0]} ||= { })
984 }
985
986 sub db_put($$;$) {
987 if (@_ >= 3) {
988 $DB->{$_[0]}{$_[1]} = $_[2];
989 } else { 3813 eval {
990 $DB->{$_[0]} = $_[1]; 3814 BDB::db_env_open
991 } 3815 $DB_ENV,
992 db_dirty; 3816 $BDBDIR,
993 } 3817 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3818 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3819 0666;
994 3820
995 cf::global->attach ( 3821 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
996 prio => 10000,
997 on_cleanup => sub {
998 db_sync;
999 },
1000 );
1001}
1002
1003#############################################################################
1004# the server's main()
1005
1006sub cfg_load {
1007 open my $fh, "<:utf8", cf::confdir . "/config"
1008 or return;
1009
1010 local $/;
1011 *CFG = YAML::Syck::Load <$fh>;
1012}
1013
1014sub main {
1015 cfg_load;
1016 db_load;
1017 load_extensions;
1018 Event::loop;
1019}
1020
1021#############################################################################
1022# initialisation
1023
1024sub _perl_reload(&) {
1025 my ($msg) = @_;
1026
1027 $msg->("reloading...");
1028
1029 eval {
1030 # cancel all watchers
1031 for (Event::all_watchers) {
1032 $_->cancel if $_->data & WF_AUTOCANCEL;
1033 }
1034
1035 # unload all extensions
1036 for (@exts) {
1037 $msg->("unloading <$_>");
1038 unload_extension $_;
1039 }
1040
1041 # unload all modules loaded from $LIBDIR
1042 while (my ($k, $v) = each %INC) {
1043 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044
1045 $msg->("removing <$k>");
1046 delete $INC{$k};
1047
1048 $k =~ s/\.pm$//;
1049 $k =~ s/\//::/g;
1050
1051 if (my $cb = $k->can ("unload_module")) {
1052 $cb->();
1053 } 3822 };
1054 3823
1055 Symbol::delete_package $k; 3824 cf::cleanup "db_env_open(db): $@" if $@;
1056 } 3825 };
3826 }
1057 3827
1058 # sync database to disk 3828 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
1059 cf::db_sync; 3829 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
1060
1061 # get rid of safe::, as good as possible
1062 Symbol::delete_package "safe::$_"
1063 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1064
1065 # remove register_script_function callbacks
1066 # TODO
1067
1068 # unload cf.pm "a bit"
1069 delete $INC{"cf.pm"};
1070
1071 # don't, removes xs symbols, too,
1072 # and global variables created in xs
1073 #Symbol::delete_package __PACKAGE__;
1074
1075 # reload cf.pm
1076 $msg->("reloading cf.pm");
1077 require cf;
1078
1079 # load config and database again
1080 cf::cfg_load;
1081 cf::db_load;
1082
1083 # load extensions
1084 $msg->("load extensions");
1085 cf::load_extensions;
1086
1087 # reattach attachments to objects
1088 $msg->("reattach");
1089 _global_reattach;
1090 }; 3830 };
1091 $msg->($@) if $@; 3831 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
1092 3832 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
1093 $msg->("reloaded");
1094};
1095
1096sub perl_reload() {
1097 _perl_reload {
1098 warn $_[0];
1099 print "$_[0]\n";
1100 }; 3833 };
3834 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3835 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3836 };
1101} 3837}
1102 3838
1103register "<global>", __PACKAGE__; 3839{
3840 # configure IO::AIO
1104 3841
1105register_command "perl-reload" => sub { 3842 IO::AIO::min_parallel 8;
3843 IO::AIO::max_poll_time $TICK * 0.1;
3844 undef $AnyEvent::AIO::WATCHER;
3845}
3846
3847my $_log_backtrace;
3848
3849sub _log_backtrace {
1106 my ($who, $arg) = @_; 3850 my ($msg, @addr) = @_;
1107 3851
1108 if ($who->flag (FLAG_WIZ)) { 3852 $msg =~ s/\n//;
1109 _perl_reload { 3853
1110 warn $_[0]; 3854 # limit the # of concurrent backtraces
1111 $who->message ($_[0]); 3855 if ($_log_backtrace < 2) {
3856 ++$_log_backtrace;
3857 my $perl_bt = Carp::longmess $msg;
3858 async {
3859 $Coro::current->{desc} = "abt $msg";
3860
3861 my @bt = fork_call {
3862 @addr = map { sprintf "%x", $_ } @addr;
3863 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3864 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3865 or die "addr2line: $!";
3866
3867 my @funcs;
3868 my @res = <$fh>;
3869 chomp for @res;
3870 while (@res) {
3871 my ($func, $line) = splice @res, 0, 2, ();
3872 push @funcs, "[$func] $line";
3873 }
3874
3875 @funcs
3876 };
3877
3878 LOG llevInfo, "[ABT] $perl_bt\n";
3879 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3880 LOG llevInfo, "[ABT] $_\n" for @bt;
3881 --$_log_backtrace;
1112 }; 3882 };
1113 } 3883 } else {
1114}; 3884 LOG llevInfo, "[ABT] $msg\n";
1115 3885 LOG llevInfo, "[ABT] [suppressed]\n";
1116unshift @INC, $LIBDIR;
1117
1118$TICK_WATCHER = Event->timer (
1119 prio => 0,
1120 at => $NEXT_TICK || 1,
1121 data => WF_AUTOCANCEL,
1122 cb => sub {
1123 cf::server_tick; # one server iteration
1124
1125 my $NOW = Event::time;
1126 $NEXT_TICK += $TICK;
1127
1128 # if we are delayed by four ticks or more, skip them all
1129 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1130
1131 $TICK_WATCHER->at ($NEXT_TICK);
1132 $TICK_WATCHER->start;
1133 }, 3886 }
1134); 3887}
1135 3888
1136IO::AIO::max_poll_time $TICK * 0.2; 3889# load additional modules
3890use cf::pod;
1137 3891
1138Event->io (fd => IO::AIO::poll_fileno, 3892END { cf::emergency_save }
1139 poll => 'r',
1140 prio => 5,
1141 data => WF_AUTOCANCEL,
1142 cb => \&IO::AIO::poll_cb);
1143 3893
11441 38941
1145 3895

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines