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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines