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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines