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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines