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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.513 by root, Mon Apr 12 05:22:38 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines