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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines