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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines