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.142 by root, Fri Jan 5 21:51:42 2007 UTC vs.
Revision 1.526 by root, Wed Apr 21 05:48:35 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 (Coro::PRIO_MAX); # 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 $RANDOM_MAPS = cf::localdir . "/random"; 136our $LINK_MAP; # the special {link} map, which is always available
55our %EXT_CORO; 137
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 :)
56 150
57binmode STDOUT; 151binmode STDOUT;
58binmode STDERR; 152binmode STDERR;
59 153
60# read virtual server time, if available 154# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 155unless ($RUNTIME || !-e $RUNTIMEFILE) {
62 open my $fh, "<", cf::localdir . "/runtime" 156 open my $fh, "<", $RUNTIMEFILE
63 or die "unable to read runtime file: $!"; 157 or die "unable to read $RUNTIMEFILE file: $!";
64 $RUNTIME = <$fh> + 0.; 158 $RUNTIME = <$fh> + 0.;
65} 159}
66 160
67mkdir cf::localdir; 161eval "sub TICK() { $TICK } 1" or die;
68mkdir cf::localdir . "/" . cf::playerdir;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 162
73# a special map that is always available 163mkdir $_
74our $LINK_MAP; 164 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
165
75our $EMERGENCY_POSITION; 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::"} };
76 184
77############################################################################# 185#############################################################################
78 186
79=head2 GLOBAL VARIABLES 187=head2 GLOBAL VARIABLES
80 188
87=item $cf::RUNTIME 195=item $cf::RUNTIME
88 196
89The 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
90every server tick. 198every server tick.
91 199
92=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
93 203
94The perl library directory, where extensions and cf-specific modules can 204Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 208
97=item $cf::NOW 209=item $cf::NOW
98 210
99The time of the last (current) server tick. 211The time of the last (current) server tick.
100 212
101=item $cf::TICK 213=item $cf::TICK
102 214
103The interval between server ticks, in seconds. 215The interval between server ticks, in seconds.
104 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
105=item %cf::CFG 227=item %cf::CFG
106 228
107Configuration for the server, loaded from C</etc/crossfire/config>, or 229Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108from wherever your confdir points to. 230from wherever your confdir points to.
109 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
110=back 250=back
111 251
112=cut 252=cut
113 253
114BEGIN { 254$Coro::State::WARNHOOK = sub {
115 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 255 my $msg = join "", @_;
117 utf8::encode $msg;
118 256
119 $msg .= "\n" 257 $msg .= "\n"
120 unless $msg =~ /\n$/; 258 unless $msg =~ /\n$/;
121 259
260 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
261
122 LOG llevError, "cfperl: $msg"; 262 LOG llevError, $msg;
123 }; 263};
124} 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};
125 278
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 279@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 280@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 281@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 282@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 286
133# 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
134# within the Safe compartment. 288# within the Safe compartment.
135for my $pkg (qw( 289for my $pkg (qw(
136 cf::global cf::attachable 290 cf::global cf::attachable
137 cf::object cf::object::player 291 cf::object cf::object::player
138 cf::client cf::player 292 cf::client cf::player
139 cf::arch cf::living 293 cf::arch cf::living
294 cf::map cf::mapspace
140 cf::map cf::party cf::region 295 cf::party cf::region
141)) { 296)) {
142 no strict 'refs';
143 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 297 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144} 298}
145 299
146$Event::DIED = sub { 300$EV::DIED = sub {
147 warn "error in event callback: @_"; 301 Carp::cluck "error in event callback: @_";
148}; 302};
149 303
150my %ext_pkg; 304#############################################################################
151my @exts;
152my @hook;
153 305
154=head2 UTILITY FUNCTIONS 306=head2 UTILITY FUNCTIONS
155 307
156=over 4 308=over 4
157 309
158=cut 310=item dumpval $ref
159 311
160use JSON::Syck (); # TODO# replace by JSON::PC once working 312=cut
161 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
162=item $ref = cf::from_json $json 333=item $ref = cf::decode_json $json
163 334
164Converts a JSON string into the corresponding perl data structure. 335Converts a JSON string into the corresponding perl data structure.
165 336
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 337=item $json = cf::encode_json $ref
174 338
175Converts a perl data structure into its JSON representation. 339Converts a perl data structure into its JSON representation.
176 340
177=cut 341=cut
178 342
179sub to_json($) { 343our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 344
181 JSON::Syck::Dump $_[0] 345sub encode_json($) { $json_coder->encode ($_[0]) }
346sub decode_json($) { $json_coder->decode ($_[0]) }
347
348=item cf::post_init { BLOCK }
349
350Execute the given codeblock, I<after> all extensions have been (re-)loaded,
351but I<before> the server starts ticking again.
352
353The cdoeblock will have a single boolean argument to indicate whether this
354is a reload or not.
355
356=cut
357
358sub post_init(&) {
359 push @POST_INIT, shift;
182} 360}
183 361
184=item cf::lock_wait $string 362=item cf::lock_wait $string
185 363
186Wait until the given lock is available. See cf::lock_acquire. 364Wait until the given lock is available. See cf::lock_acquire.
187 365
188=item my $lock = cf::lock_acquire $string 366=item my $lock = cf::lock_acquire $string
189 367
190Wait 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
191a Coro::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,
192for example when the coroutine gets canceled), the lock is automatically 370for example when the coroutine gets canceled), the lock is automatically
193returned. 371returned.
194 372
373Locks are *not* recursive, locking from the same coro twice results in a
374deadlocked coro.
375
195Lock names should begin with a unique identifier (for example, cf::map::find 376Lock names should begin with a unique identifier (for example, cf::map::find
196uses map_find and cf::map::load uses map_load). 377uses map_find and cf::map::load uses map_load).
197 378
198=cut 379=item $locked = cf::lock_active $string
199 380
200our %LOCK; 381Return true if the lock is currently active, i.e. somebody has locked it.
382
383=cut
384
385our $LOCKS = new Coro::SemaphoreSet;
201 386
202sub lock_wait($) { 387sub lock_wait($) {
203 my ($key) = @_; 388 $LOCKS->wait ($_[0]);
204
205 # wait for lock, if any
206 while ($LOCK{$key}) {
207 push @{ $LOCK{$key} }, $Coro::current;
208 Coro::schedule;
209 }
210} 389}
211 390
212sub lock_acquire($) { 391sub lock_acquire($) {
213 my ($key) = @_; 392 $LOCKS->guard ($_[0])
393}
214 394
215 # wait, to be sure we are not locked 395sub lock_active($) {
216 lock_wait $key; 396 $LOCKS->count ($_[0]) < 1
217
218 $LOCK{$key} = [];
219
220 Coro::guard {
221 # wake up all waiters, to be on the safe side
222 $_->ready for @{ delete $LOCK{$key} };
223 }
224} 397}
225 398
226sub freeze_mainloop { 399sub freeze_mainloop {
227 return unless $TICK_WATCHER->is_active; 400 tick_inhibit_inc;
228 401
229 my $guard = Coro::guard { $TICK_WATCHER->start }; 402 &Guard::guard (\&tick_inhibit_dec);
230 $TICK_WATCHER->stop; 403}
231 $guard 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 }
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;
232} 485}
233 486
234=item cf::async { BLOCK } 487=item cf::async { BLOCK }
235 488
236Currently the same as Coro::async_pool, meaning you cannot use 489Currently the same as Coro::async_pool, meaning you cannot use
241 494
242BEGIN { *async = \&Coro::async_pool } 495BEGIN { *async = \&Coro::async_pool }
243 496
244=item cf::sync_job { BLOCK } 497=item cf::sync_job { BLOCK }
245 498
246The design of crossfire+ requires that the main coro ($Coro::main) is 499The design of Deliantra requires that the main coroutine ($Coro::main)
247always able to handle events or runnable, as crossfire+ is only partly 500is always able to handle events or runnable, as Deliantra is only
248reentrant. 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.
249 503
250If 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
251the given BLOCK in another coroutine while waiting for the result. The 505the given BLOCK in another coroutine while waiting for the result. The
252server 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
253fast or be very important. 507fast or be very important.
256 510
257sub sync_job(&) { 511sub sync_job(&) {
258 my ($job) = @_; 512 my ($job) = @_;
259 513
260 if ($Coro::current == $Coro::main) { 514 if ($Coro::current == $Coro::main) {
515 my $time = AE::time;
516
261 # this is the main coro, too bad, we have to block 517 # this is the main coro, too bad, we have to block
262 # till the operation succeeds, freezing the server :/ 518 # till the operation succeeds, freezing the server :/
263 519
264 # TODO: use suspend/resume instead 520 LOG llevError, Carp::longmess "sync job";#d#
265 # (but this is cancel-safe) 521
266 my $freeze_guard = freeze_mainloop; 522 my $freeze_guard = freeze_mainloop;
267 523
268 my $busy = 1; 524 my $busy = 1;
269 my @res; 525 my @res;
270 526
271 (async { 527 (async {
528 $Coro::current->desc ("sync job coro");
272 @res = eval { $job->() }; 529 @res = eval { $job->() };
273 warn $@ if $@; 530 warn $@ if $@;
274 undef $busy; 531 undef $busy;
275 })->prio (Coro::PRIO_MAX); 532 })->prio (Coro::PRIO_MAX);
276 533
277 while ($busy) { 534 while ($busy) {
278 Coro::cede or Event::one_event; 535 if (Coro::nready) {
536 Coro::cede_notself;
537 } else {
538 EV::loop EV::LOOP_ONESHOT;
279 } 539 }
540 }
541
542 my $time = AE::time - $time;
543
544 $TICK_START += $time; # do not account sync jobs to server load
280 545
281 wantarray ? @res : $res[0] 546 wantarray ? @res : $res[0]
282 } else { 547 } else {
283 # we are in another coroutine, how wonderful, everything just works 548 # we are in another coroutine, how wonderful, everything just works
284 549
286 } 551 }
287} 552}
288 553
289=item $coro = cf::async_ext { BLOCK } 554=item $coro = cf::async_ext { BLOCK }
290 555
291Like async, but this coro is automcatially being canceled when the 556Like async, but this coro is automatically being canceled when the
292extension calling this is being unloaded. 557extension calling this is being unloaded.
293 558
294=cut 559=cut
295 560
296sub async_ext(&) { 561sub async_ext(&) {
304 $EXT_CORO{$coro+0} = $coro; 569 $EXT_CORO{$coro+0} = $coro;
305 570
306 $coro 571 $coro
307} 572}
308 573
309sub write_runtime { 574=item fork_call { }, $args
310 my $runtime = cf::localdir . "/runtime";
311 575
312 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 576Executes the given code block with the given arguments in a seperate
313 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.
314 580
315 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 581=cut
316 (aio_write $fh, 0, (length $value), $value, 0) <= 0
317 and return;
318 582
319 aio_fsync $fh 583sub fork_call(&@) {
320 and return; 584 my ($cb, @args) = @_;
321 585
322 close $fh 586 # we seemingly have to make a local copy of the whole thing,
323 or return; 587 # otherwise perl prematurely frees the stuff :/
588 # TODO: investigate and fix (likely this will be rather laborious)
324 589
325 aio_rename "$runtime~", $runtime 590 my @res = Coro::Util::fork_eval {
326 and return; 591 reset_signals;
592 &$cb
593 }, @args;
327 594
595 wantarray ? @res : $res[-1]
596}
597
598sub objinfo {
328 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 });
329} 772}
330 773
331=back 774=back
332 775
333=cut 776=cut
334 777
335############################################################################# 778#############################################################################
336 779
337package cf::path;
338
339sub new {
340 my ($class, $path, $base) = @_;
341
342 $path = $path->as_string if ref $path;
343
344 my $self = bless { }, $class;
345
346 # {... are special paths that are not touched
347 # ?xxx/... are special absolute paths
348 # ?random/... random maps
349 # /! non-realised random map exit
350 # /... normal maps
351 # ~/... per-player maps without a specific player (DO NOT USE)
352 # ~user/... per-player map of a specific user
353
354 if ($path =~ /^{/) {
355 # fine as it is
356 } elsif ($path =~ s{^\?random/}{}) {
357 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
358 $self->{random} = cf::from_json $data;
359 } else {
360 if ($path =~ s{^~([^/]+)?}{}) {
361 $self->{user_rel} = 1;
362
363 if (defined $1) {
364 $self->{user} = $1;
365 } elsif ($base =~ m{^~([^/]+)/}) {
366 $self->{user} = $1;
367 } else {
368 warn "cannot resolve user-relative path without user <$path,$base>\n";
369 }
370 } elsif ($path =~ /^\//) {
371 # already absolute
372 } else {
373 $base =~ s{[^/]+/?$}{};
374 return $class->new ("$base/$path");
375 }
376
377 for ($path) {
378 redo if s{/\.?/}{/};
379 redo if s{/[^/]+/\.\./}{/};
380 }
381 }
382
383 $self->{path} = $path;
384
385 $self
386}
387
388# the name / primary key / in-game path
389sub as_string {
390 my ($self) = @_;
391
392 $self->{user_rel} ? "~$self->{user}$self->{path}"
393 : $self->{random} ? "?random/$self->{path}"
394 : $self->{path}
395}
396
397# the displayed name, this is a one way mapping
398sub visible_name {
399 my ($self) = @_;
400
401# if (my $rmp = $self->{random}) {
402# # todo: be more intelligent about this
403# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
404# } else {
405 $self->as_string
406# }
407}
408
409# escape the /'s in the path
410sub _escaped_path {
411 # ∕ is U+2215
412 (my $path = $_[0]{path}) =~ s/\//∕/g;
413 $path
414}
415
416# the original (read-only) location
417sub load_path {
418 my ($self) = @_;
419
420 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
421}
422
423# the temporary/swap location
424sub save_path {
425 my ($self) = @_;
426
427 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
428 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
429 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
430}
431
432# the unique path, might be eq to save_path
433sub uniq_path {
434 my ($self) = @_;
435
436 $self->{user_rel} || $self->{random}
437 ? undef
438 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
439}
440
441# return random map parameters, or undef
442sub random_map_params {
443 my ($self) = @_;
444
445 $self->{random}
446}
447
448# this is somewhat ugly, but style maps do need special treatment
449sub is_style_map {
450 $_[0]{path} =~ m{^/styles/}
451}
452
453package cf;
454
455#############################################################################
456
457=head2 ATTACHABLE OBJECTS 780=head2 ATTACHABLE OBJECTS
458 781
459Many 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
460attach callbacks/event handlers (a collection of which is called an "attachment") 783attach callbacks/event handlers (a collection of which is called an "attachment")
461to it. All such attachable objects support the following methods. 784to it. All such attachable objects support the following methods.
462 785
463In 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>
464C<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
465crossfire+). 788Deliantra).
466 789
467=over 4 790=over 4
468 791
469=item $attachable->attach ($attachment, key => $value...) 792=item $attachable->attach ($attachment, key => $value...)
470 793
514=item cf::CLASS::attachment $name, ... 837=item cf::CLASS::attachment $name, ...
515 838
516Register an attachment by C<$name> through which attachable objects of the 839Register an attachment by C<$name> through which attachable objects of the
517given CLASS can refer to this attachment. 840given CLASS can refer to this attachment.
518 841
519Some classes such as crossfire maps and objects can specify attachments 842Some classes such as deliantra maps and objects can specify attachments
520that 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.
521 844
522These calls expect any number of the following handler/hook descriptions: 845These calls expect any number of the following handler/hook descriptions:
523 846
524=over 4 847=over 4
584our @CB_TYPE = (); # registry for type (cf-object class) based events 907our @CB_TYPE = (); # registry for type (cf-object class) based events
585our @CB_MAP = (); 908our @CB_MAP = ();
586 909
587my %attachment; 910my %attachment;
588 911
912sub cf::attachable::thawer_merge {
913 # simply override everything except _meta
914 local $_[0]{_meta};
915 %{$_[0]} = %{$_[1]};
916}
917
589sub _attach_cb($$$$) { 918sub _attach_cb($$$$) {
590 my ($registry, $event, $prio, $cb) = @_; 919 my ($registry, $event, $prio, $cb) = @_;
591 920
592 use sort 'stable'; 921 use sort 'stable';
593 922
627 $registry = $CB_TYPE[$object_type] ||= []; 956 $registry = $CB_TYPE[$object_type] ||= [];
628 957
629 } elsif ($type eq "subtype") { 958 } elsif ($type eq "subtype") {
630 defined $object_type or Carp::croak "subtype specified without type"; 959 defined $object_type or Carp::croak "subtype specified without type";
631 my $object_subtype = shift @arg; 960 my $object_subtype = shift @arg;
632 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 961 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633 962
634 } elsif ($type eq "package") { 963 } elsif ($type eq "package") {
635 my $pkg = shift @arg; 964 my $pkg = shift @arg;
636 965
637 while (my ($name, $id) = each %cb_id) { 966 while (my ($name, $id) = each %cb_id) {
666 _attach $registry, $klass, @attach; 995 _attach $registry, $klass, @attach;
667 } 996 }
668 997
669 $obj->{$name} = \%arg; 998 $obj->{$name} = \%arg;
670 } else { 999 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 1000 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 1001 }
673 1002
674 $obj->{_attachment}{$name} = undef; 1003 $obj->{_attachment}{$name} = undef;
675} 1004}
676 1005
678 if (ref $_[0]) { 1007 if (ref $_[0]) {
679 _object_attach @_; 1008 _object_attach @_;
680 } else { 1009 } else {
681 _attach shift->_attach_registry, @_; 1010 _attach shift->_attach_registry, @_;
682 } 1011 }
1012 _recalc_want;
683}; 1013};
684 1014
685# all those should be optimised 1015# all those should be optimised
686sub cf::attachable::detach { 1016sub cf::attachable::detach {
687 my ($obj, $name) = @_; 1017 my ($obj, $name) = @_;
690 delete $obj->{_attachment}{$name}; 1020 delete $obj->{_attachment}{$name};
691 reattach ($obj); 1021 reattach ($obj);
692 } else { 1022 } else {
693 Carp::croak "cannot, currently, detach class attachments"; 1023 Carp::croak "cannot, currently, detach class attachments";
694 } 1024 }
1025 _recalc_want;
695}; 1026};
696 1027
697sub cf::attachable::attached { 1028sub cf::attachable::attached {
698 my ($obj, $name) = @_; 1029 my ($obj, $name) = @_;
699 1030
714 "; 1045 ";
715 die if $@; 1046 die if $@;
716} 1047}
717 1048
718our $override; 1049our $override;
719our @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?
720 1051
721sub override { 1052sub override {
722 $override = 1; 1053 $override = 1;
723 @invoke_results = (); 1054 @INVOKE_RESULTS = (@_);
724} 1055}
725 1056
726sub do_invoke { 1057sub do_invoke {
727 my $event = shift; 1058 my $event = shift;
728 my $callbacks = shift; 1059 my $callbacks = shift;
729 1060
730 @invoke_results = (); 1061 @INVOKE_RESULTS = ();
731 1062
732 local $override; 1063 local $override;
733 1064
734 for (@$callbacks) { 1065 for (@$callbacks) {
735 eval { &{$_->[1]} }; 1066 eval { &{$_->[1]} };
744 } 1075 }
745 1076
746 0 1077 0
747} 1078}
748 1079
749=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1080=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
750 1081
751=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1082=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
752 1083
753Generate an object-specific event with the given arguments. 1084Generate an object-specific event with the given arguments.
754 1085
755This 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
756removed 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
757results (if you must, access C<@cf::invoke_results> directly). 1088results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758 1089
759=back 1090=back
760 1091
761=cut 1092=cut
762 1093
763############################################################################# 1094#############################################################################
764# 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}
765 1138
766sub reattach { 1139sub reattach {
767 # basically do the same as instantiate, without calling instantiate 1140 # basically do the same as instantiate, without calling instantiate
768 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
769 1145
770 my $registry = $obj->registry; 1146 my $registry = $obj->registry;
771 1147
772 @$registry = (); 1148 @$registry = ();
773 1149
788cf::attachable->attach ( 1164cf::attachable->attach (
789 prio => -1000000, 1165 prio => -1000000,
790 on_instantiate => sub { 1166 on_instantiate => sub {
791 my ($obj, $data) = @_; 1167 my ($obj, $data) = @_;
792 1168
793 $data = from_json $data; 1169 $data = decode_json $data;
794 1170
795 for (@$data) { 1171 for (@$data) {
796 my ($name, $args) = @$_; 1172 my ($name, $args) = @$_;
797 1173
798 $obj->attach ($name, %{$args || {} }); 1174 $obj->attach ($name, %{$args || {} });
814sub object_freezer_save { 1190sub object_freezer_save {
815 my ($filename, $rdata, $objs) = @_; 1191 my ($filename, $rdata, $objs) = @_;
816 1192
817 sync_job { 1193 sync_job {
818 if (length $$rdata) { 1194 if (length $$rdata) {
1195 utf8::decode (my $decname = $filename);
819 warn sprintf "saving %s (%d,%d)\n", 1196 warn sprintf "saving %s (%d,%d)\n",
820 $filename, length $$rdata, scalar @$objs; 1197 $decname, length $$rdata, scalar @$objs;
821 1198
822 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1199 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
823 chmod SAVE_MODE, $fh; 1200 aio_chmod $fh, SAVE_MODE;
824 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;
825 aio_fsync $fh; 1204 aio_fsync $fh;
1205 }
826 close $fh; 1206 aio_close $fh;
827 1207
828 if (@$objs) { 1208 if (@$objs) {
829 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) {
830 chmod SAVE_MODE, $fh; 1210 aio_chmod $fh, SAVE_MODE;
831 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1211 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
832 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;
833 aio_fsync $fh; 1215 aio_fsync $fh;
1216 }
834 close $fh; 1217 aio_close $fh;
835 aio_rename "$filename.pst~", "$filename.pst"; 1218 aio_rename "$filename.pst~", "$filename.pst";
836 } 1219 }
837 } else { 1220 } else {
838 aio_unlink "$filename.pst"; 1221 aio_unlink "$filename.pst";
839 } 1222 }
840 1223
841 aio_rename "$filename~", $filename; 1224 aio_rename "$filename~", $filename;
1225
1226 $filename =~ s%/[^/]+$%%;
1227 aio_pathsync $filename if $cf::USE_FSYNC;
842 } else { 1228 } else {
843 warn "FATAL: $filename~: $!\n"; 1229 warn "unable to save objects: $filename~: $!\n";
844 } 1230 }
845 } else { 1231 } else {
846 aio_unlink $filename; 1232 aio_unlink $filename;
847 aio_unlink "$filename.pst"; 1233 aio_unlink "$filename.pst";
848 } 1234 }
849 } 1235 };
850} 1236}
851 1237
852sub object_freezer_as_string { 1238sub object_freezer_as_string {
853 my ($rdata, $objs) = @_; 1239 my ($rdata, $objs) = @_;
854 1240
866 or return; 1252 or return;
867 1253
868 unless (aio_stat "$filename.pst") { 1254 unless (aio_stat "$filename.pst") {
869 (aio_load "$filename.pst", $av) >= 0 1255 (aio_load "$filename.pst", $av) >= 0
870 or return; 1256 or return;
1257
871 $av = eval { (Storable::thaw $av)->{objs} }; 1258 my $st = eval { Coro::Storable::thaw $av };
1259 $av = $st->{objs};
872 } 1260 }
873 1261
1262 utf8::decode (my $decname = $filename);
874 warn sprintf "loading %s (%d)\n", 1263 warn sprintf "loading %s (%d,%d)\n",
875 $filename, length $data, scalar @{$av || []};#d# 1264 $decname, length $data, scalar @{$av || []};
1265
876 return ($data, $av); 1266 ($data, $av)
877} 1267}
1268
1269=head2 COMMAND CALLBACKS
1270
1271=over 4
1272
1273=cut
878 1274
879############################################################################# 1275#############################################################################
880# command handling &c 1276# command handling &c
881 1277
882=item cf::register_command $name => \&callback($ob,$args); 1278=item cf::register_command $name => \&callback($ob,$args);
895 push @{ $COMMAND{$name} }, [$caller, $cb]; 1291 push @{ $COMMAND{$name} }, [$caller, $cb];
896} 1292}
897 1293
898=item cf::register_extcmd $name => \&callback($pl,$packet); 1294=item cf::register_extcmd $name => \&callback($pl,$packet);
899 1295
900Register 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.
901 1301
902If 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
903called. 1303called.
904 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
905=cut 1316=cut
906 1317
907sub register_extcmd { 1318sub register_extcmd {
908 my ($name, $cb) = @_; 1319 my ($name, $cb) = @_;
909 1320
910 my $caller = caller;
911 #warn "registering extcmd '$name' to '$caller'";
912
913 $EXTCMD{$name} = [$cb, $caller]; 1321 $EXTCMD{$name} = $cb;
914} 1322}
1323
1324sub register_exticmd {
1325 my ($name, $cb) = @_;
1326
1327 $EXTICMD{$name} = $cb;
1328}
1329
1330use File::Glob ();
915 1331
916cf::player->attach ( 1332cf::player->attach (
917 on_command => sub { 1333 on_unknown_command => sub {
918 my ($pl, $name, $params) = @_; 1334 my ($pl, $name, $params) = @_;
919 1335
920 my $cb = $COMMAND{$name} 1336 my $cb = $COMMAND{$name}
921 or return; 1337 or return;
922 1338
927 cf::override; 1343 cf::override;
928 }, 1344 },
929 on_extcmd => sub { 1345 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1346 my ($pl, $buf) = @_;
931 1347
932 my $msg = eval { from_json $buf }; 1348 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1349
934 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
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1358 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->[0]->($pl, $msg)) { 1359 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1360 }
1361
1362 $pl->ext_reply ($reply, @reply)
1363 if $reply;
1364
940 } else { 1365 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1366 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1367 }
943 1368
944 cf::override; 1369 cf::override;
945 }, 1370 },
946); 1371);
947 1372
948sub register { 1373# "readahead" all extensions
949 my ($base, $pkg) = @_;
950
951 #TODO
952}
953
954sub load_extension { 1374sub cache_extensions {
955 my ($path) = @_; 1375 my $grp = IO::AIO::aio_group;
956 1376
957 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1377 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
958 my $base = $1; 1378 for (grep /\.ext$/, @{$_[0]}) {
959 my $pkg = $1; 1379 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
960 $pkg =~ s/[^[:word:]]/_/g;
961 $pkg = "ext::$pkg";
962
963 warn "loading '$path' into '$pkg'\n";
964
965 open my $fh, "<:utf8", $path
966 or die "$path: $!";
967
968 my $source =
969 "package $pkg; use strict; use utf8;\n"
970 . "#line 1 \"$path\"\n{\n"
971 . (do { local $/; <$fh> })
972 . "\n};\n1";
973
974 eval $source
975 or die $@ ? "$path: $@\n"
976 : "extension disabled.\n";
977
978 push @exts, $pkg;
979 $ext_pkg{$base} = $pkg;
980
981# no strict 'refs';
982# @{"$pkg\::ISA"} = ext::;
983
984 register $base, $pkg;
985}
986
987sub unload_extension {
988 my ($pkg) = @_;
989
990 warn "removing extension $pkg\n";
991
992 # remove hooks
993 #TODO
994# for my $idx (0 .. $#PLUGIN_EVENT) {
995# delete $hook[$idx]{$pkg};
996# }
997
998 # remove commands
999 for my $name (keys %COMMAND) {
1000 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1001
1002 if (@cb) {
1003 $COMMAND{$name} = \@cb;
1004 } else {
1005 delete $COMMAND{$name};
1006 } 1380 }
1007 } 1381 };
1008 1382
1009 # remove extcmds 1383 $grp
1010 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1011 delete $EXTCMD{$name};
1012 }
1013
1014 if (my $cb = $pkg->can ("unload")) {
1015 eval {
1016 $cb->($pkg);
1017 1
1018 } or warn "$pkg unloaded, but with errors: $@";
1019 }
1020
1021 Symbol::delete_package $pkg;
1022} 1384}
1023 1385
1024sub load_extensions { 1386sub load_extensions {
1387 cf::sync_job {
1388 my %todo;
1389
1025 for my $ext (<$LIBDIR/*.ext>) { 1390 for my $path (<$LIBDIR/*.ext>) {
1026 next unless -r $ext; 1391 next unless -r $path;
1027 eval { 1392
1028 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 }
1029 1 1456 }
1030 } 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 }
1031 } 1467 };
1032} 1468}
1033 1469
1034############################################################################# 1470#############################################################################
1035# load/save/clean perl data associated with a map
1036 1471
1037*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($) {
1038 my ($map) = @_; 1526 my ($login) = @_;
1039 1527
1040 my $path = $map->tmpname; 1528 $cf::PLAYER{$login}
1041 defined $path or return; 1529 or !aio_stat path $login
1042
1043 unlink "$path.pst";
1044};
1045
1046cf::map->attach (prio => -10000, package => cf::mapsupport::);
1047
1048#############################################################################
1049# load/save perl data associated with player->ob objects
1050
1051sub all_objects(@) {
1052 @_, map all_objects ($_->inv), @_
1053} 1530}
1054 1531
1055# 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
1056cf::player->attach ( 1559cf::player->attach (
1057 on_load => sub { 1560 on_load => sub {
1058 my ($pl, $path) = @_; 1561 my ($pl, $path) = @_;
1059 1562
1060 for my $o (all_objects $pl->ob) { 1563 # restore slots saved in save, below
1061 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1564 my $slots = delete $pl->{_slots};
1062 $o->set_ob_key_value ("_perl_data");
1063 1565
1064 %$o = %{ Storable::thaw pack "H*", $value }; 1566 $pl->ob->current_weapon ($slots->[0]);
1065 } 1567 $pl->combat_ob ($slots->[1]);
1066 } 1568 $pl->ranged_ob ($slots->[2]);
1067 }, 1569 },
1068); 1570);
1069 1571
1070############################################################################# 1572sub save($) {
1573 my ($pl) = @_;
1071 1574
1072=head2 CORE EXTENSIONS 1575 return if $pl->{deny_save};
1073 1576
1074Functions and methods that extend core crossfire objects. 1577 my $path = path $pl;
1578 my $guard = cf::lock_acquire "user_save:$path";
1075 1579
1076=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
1077 1757
1078=over 4 1758=over 4
1079 1759
1080=item cf::player::exists $login
1081
1082Returns true when the given account exists.
1083
1084=cut 1760=cut
1085 1761
1086sub cf::player::exists($) { 1762package cf::region;
1087 cf::player::find $_[0]
1088 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1089}
1090 1763
1091=item $player->ext_reply ($msgid, $msgtype, %msg) 1764=item cf::region::find_by_path $path
1092 1765
1093Sends an ext reply to the player. 1766Tries to decuce the likely region for a map knowing only its path.
1094 1767
1095=cut 1768=cut
1096 1769
1097sub cf::player::ext_reply($$$%) { 1770sub find_by_path($) {
1098 my ($self, $id, %msg) = @_; 1771 my ($path) = @_;
1099 1772
1100 $msg{msgid} = $id; 1773 $path =~ s/^~[^\/]*//; # skip ~login
1101 1774
1102 $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
1103} 1785}
1104 1786
1105=back 1787=back
1106
1107 1788
1108=head3 cf::map 1789=head3 cf::map
1109 1790
1110=over 4 1791=over 4
1111 1792
1114package cf::map; 1795package cf::map;
1115 1796
1116use Fcntl; 1797use Fcntl;
1117use Coro::AIO; 1798use Coro::AIO;
1118 1799
1800use overload
1801 '""' => \&as_string,
1802 fallback => 1;
1803
1119our $MAX_RESET = 3600; 1804our $MAX_RESET = 3600;
1120our $DEFAULT_RESET = 3000; 1805our $DEFAULT_RESET = 3000;
1121 1806
1122sub generate_random_map { 1807sub generate_random_map {
1123 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
1124 1811
1125 # mit "rum" bekleckern, nicht 1812 # mit "rum" bekleckern, nicht
1126 cf::map::_create_random_map 1813 $self->_create_random_map (
1127 $path,
1128 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1814 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1815 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1130 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1816 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{exit_on_final_map}, 1817 $rmp->{exit_on_final_map},
1132 $rmp->{xsize}, $rmp->{ysize}, 1818 $rmp->{xsize}, $rmp->{ysize},
1133 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1819 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1134 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1820 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1135 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1821 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1136 $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},
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1823 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (cf::region::find $rmp->{region}) 1824 (cf::region::find $rmp->{region}), $rmp->{custom}
1825 )
1139} 1826}
1140 1827
1141# and all this just because we cannot iterate over 1828=item cf::map->register ($regex, $prio)
1142# all maps in C++...
1143sub change_all_map_light {
1144 my ($change) = @_;
1145 1829
1146 $_->change_map_light ($change) 1830Register a handler for the map path matching the given regex at the
1147 for grep $_->outdoor, values %cf::MAP; 1831givne priority (higher is better, built-in handlers have priority 0, the
1148} 1832default).
1149 1833
1150sub 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 {
1151 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) = @_;
1152 1973
1153 utf8::encode $path; 1974 utf8::encode $path;
1154 aio_open $path, O_RDONLY, 0 1975 my $f = new_from_file cf::object::thawer $path
1155 or return; 1976 or return;
1156 1977
1157 my $map = cf::map::new 1978 $self->_load_header ($f)
1158 or return; 1979 or return;
1159 1980
1160 # for better error messages only, will be overwritten 1981 local $MAP_LOADING{$self->{path}} = $self;
1161 $map->path ($path); 1982 $f->resolve_delayed_derefs;
1162 1983
1163 $map->load_header ($path) 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
1164 or return; 2027 or return;
2028 $self->prepare_orig;
2029 }
1165 2030
1166 $map->{load_path} = $path; 2031 $self->{deny_reset} = 1
2032 if $self->no_reset;
1167 2033
1168 $map 2034 $self->default_region (cf::region::find_by_path $self->{path})
2035 unless $self->default_region;
2036
2037 1
1169} 2038}
1170 2039
1171sub find; 2040sub find;
1172sub find { 2041sub find {
1173 my ($path, $origin) = @_; 2042 my ($path, $origin) = @_;
1174 2043
1175 #warn "find<$path,$origin>\n";#d#
1176
1177 $path = new cf::path $path, $origin && $origin->path; 2044 $path = normalise $path, $origin && $origin->path;
1178 my $key = $path->as_string;
1179 2045
1180 cf::lock_wait "map_find:$key"; 2046 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1181
1182 $cf::MAP{$key} || do {
1183 my $guard = cf::lock_acquire "map_find:$key"; 2047 my $guard2 = cf::lock_acquire "map_find:$path";
1184 2048
1185 # do it the slow way 2049 $cf::MAP{$path} || do {
1186 my $map = try_load_header $path->save_path; 2050 my $map = new_from_path cf::map $path
1187
1188 Coro::cede;
1189
1190 if ($map) {
1191 $map->last_access ((delete $map->{last_access})
1192 || $cf::RUNTIME); #d#
1193 # safety
1194 $map->{instantiate_time} = $cf::RUNTIME
1195 if $map->{instantiate_time} > $cf::RUNTIME;
1196 } else {
1197 if (my $rmp = $path->random_map_params) {
1198 $map = generate_random_map $key, $rmp;
1199 } else {
1200 $map = try_load_header $path->load_path;
1201 }
1202
1203 $map or return; 2051 or return;
1204 2052
1205 $map->{load_original} = 1;
1206 $map->{instantiate_time} = $cf::RUNTIME;
1207 $map->last_access ($cf::RUNTIME);
1208 $map->instantiate;
1209
1210 # per-player maps become, after loading, normal maps
1211 $map->per_player (0) if $path->{user_rel};
1212 }
1213
1214 $map->path ($key);
1215 $map->{path} = $path;
1216 $map->{last_save} = $cf::RUNTIME; 2053 $map->{last_save} = $cf::RUNTIME;
1217 2054
1218 Coro::cede; 2055 $map->load_header
2056 or return;
1219 2057
1220 if ($map->should_reset) { 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;
1221 $map->reset; 2063 $map->reset;
1222 undef $guard;
1223 $map = find $path 2064 return find $path;
1224 or return;
1225 } 2065 }
1226 2066
1227 $cf::MAP{$key} = $map 2067 $cf::MAP{$path} = $map
1228 } 2068 }
1229} 2069}
2070
2071sub pre_load { }
2072#sub post_load { } # XS
1230 2073
1231sub load { 2074sub load {
1232 my ($self) = @_; 2075 my ($self) = @_;
1233 2076
2077 local $self->{deny_reset} = 1; # loading can take a long time
2078
1234 my $path = $self->{path}; 2079 my $path = $self->{path};
2080
2081 {
1235 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2082 my $guard = cf::lock_acquire "map_data:$path";
1236 2083
2084 return unless $self->valid;
1237 return if $self->in_memory != cf::MAP_SWAPPED; 2085 return unless $self->in_memory == cf::MAP_SWAPPED;
1238 2086
1239 $self->in_memory (cf::MAP_LOADING); 2087 $self->in_memory (cf::MAP_LOADING);
1240 2088
1241 $self->alloc; 2089 $self->alloc;
1242 $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)
1243 or return; 2097 or return;
1244 2098
1245 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2099 $self->post_load_original
1246 if delete $self->{load_original}; 2100 if delete $self->{load_original};
1247 2101
1248 if (my $uniq = $path->uniq_path) { 2102 if (my $uniq = $self->uniq_path) {
1249 utf8::encode $uniq; 2103 utf8::encode $uniq;
1250 if (aio_open $uniq, O_RDONLY, 0) { 2104 unless (aio_stat $uniq) {
2105 if (my $f = new_from_file cf::object::thawer $uniq) {
1251 $self->clear_unique_items; 2106 $self->clear_unique_items;
1252 $self->load_objects ($uniq, 0); 2107 $self->_load_objects ($f);
2108 $f->resolve_delayed_derefs;
2109 }
1253 } 2110 }
1254 } 2111 }
1255 2112
1256 Coro::cede; 2113 $f->resolve_delayed_derefs;
1257 2114
2115 cf::cede_to_tick;
1258 # now do the right thing for maps 2116 # now do the right thing for maps
1259 $self->link_multipart_objects; 2117 $self->link_multipart_objects;
1260
1261 if ($self->{path}->is_style_map) {
1262 $self->{deny_save} = 1;
1263 $self->{deny_reset} = 1;
1264 } else {
1265 $self->fix_auto_apply;
1266 $self->decay_objects;
1267 $self->update_buttons;
1268 $self->set_darkness_map;
1269 $self->difficulty ($self->estimate_difficulty) 2118 $self->difficulty ($self->estimate_difficulty)
1270 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;
1271 $self->activate; 2127 $self->activate;
1272 } 2128 }
1273 2129
1274 Coro::cede; 2130 $self->{last_save} = $cf::RUNTIME;
2131 $self->last_access ($cf::RUNTIME);
1275 2132
1276 $self->in_memory (cf::MAP_IN_MEMORY); 2133 $self->in_memory (cf::MAP_ACTIVE);
2134 }
2135
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 }
1277} 2178}
1278 2179
1279sub find_sync { 2180sub find_sync {
1280 my ($path, $origin) = @_; 2181 my ($path, $origin) = @_;
1281 2182
1282 cf::sync_job { cf::map::find $path, $origin } 2183 cf::sync_job { find $path, $origin }
1283} 2184}
1284 2185
1285sub do_load_sync { 2186sub do_load_sync {
1286 my ($map) = @_; 2187 my ($map) = @_;
1287 2188
2189 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2190 if $Coro::current == $Coro::main;
2191
1288 cf::sync_job { $map->load }; 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
2245 cf::async {
2246 $Coro::current->{desc} = "map player save";
2247 $_->contr->save for $self->players;
2248 };
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);
2257 }
1289} 2258}
1290 2259
1291sub save { 2260sub save {
1292 my ($self) = @_; 2261 my ($self) = @_;
1293 2262
1294 my $lock = cf::lock_acquire "map_data:" . $self->path; 2263 my $lock = cf::lock_acquire "map_data:$self->{path}";
1295 2264
1296 $self->{last_save} = $cf::RUNTIME; 2265 $self->_save;
1297
1298 return unless $self->dirty;
1299
1300 my $save = $self->{path}->save_path; utf8::encode $save;
1301 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1302
1303 $self->{load_path} = $save;
1304
1305 return if $self->{deny_save};
1306
1307 local $self->{last_access} = $self->last_access;#d#
1308
1309 if ($uniq) {
1310 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1311 $self->save_objects ($uniq, cf::IO_UNIQUES);
1312 } else {
1313 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1314 }
1315} 2266}
1316 2267
1317sub swap_out { 2268sub swap_out {
1318 my ($self) = @_; 2269 my ($self) = @_;
1319 2270
1320 # save first because save cedes
1321 $self->save;
1322
1323 my $lock = cf::lock_acquire "map_data:" . $self->path; 2271 my $lock = cf::lock_acquire "map_data:$self->{path}";
1324 2272
2273 return if $self->in_memory != cf::MAP_ACTIVE;
2274 return if $self->{deny_save};
1325 return if $self->players; 2275 return if $self->players;
1326 return if $self->in_memory != cf::MAP_IN_MEMORY;
1327 return if $self->{deny_save};
1328 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
2283 $self->_save;
2284
2285 # then free the map
1329 $self->clear; 2286 $self->clear;
1330 $self->in_memory (cf::MAP_SWAPPED);
1331} 2287}
1332 2288
1333sub reset_at { 2289sub reset_at {
1334 my ($self) = @_; 2290 my ($self) = @_;
1335 2291
1336 # TODO: safety, remove and allow resettable per-player maps 2292 # TODO: safety, remove and allow resettable per-player maps
1337 return 1e99 if $self->{path}{user_rel};
1338 return 1e99 if $self->{deny_reset}; 2293 return 1e99 if $self->{deny_reset};
1339 2294
1340 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2295 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1341 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;
1342 2297
1347 my ($self) = @_; 2302 my ($self) = @_;
1348 2303
1349 $self->reset_at <= $cf::RUNTIME 2304 $self->reset_at <= $cf::RUNTIME
1350} 2305}
1351 2306
1352sub unlink_save {
1353 my ($self) = @_;
1354
1355 utf8::encode (my $save = $self->{path}->save_path);
1356 aioreq_pri 3; IO::AIO::aio_unlink $save;
1357 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1358}
1359
1360sub rename {
1361 my ($self, $new_path) = @_;
1362
1363 $self->unlink_save;
1364
1365 delete $cf::MAP{$self->path};
1366 $self->{path} = new cf::path $new_path;
1367 $self->path ($self->{path}->as_string);
1368 $cf::MAP{$self->path} = $self;
1369
1370 $self->save;
1371}
1372
1373sub reset { 2307sub reset {
1374 my ($self) = @_; 2308 my ($self) = @_;
1375 2309
1376 my $lock = cf::lock_acquire "map_data:" . $self->path; 2310 my $lock = cf::lock_acquire "map_data:$self->{path}";
1377 2311
1378 return if $self->players; 2312 return if $self->players;
1379 return if $self->{path}{user_rel};#d#
1380 2313
1381 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 }
1382 2325
1383 delete $cf::MAP{$self->path}; 2326 delete $cf::MAP{$self->path};
1384 2327
2328 $self->deactivate;
1385 $_->clear_links_to ($self) for values %cf::MAP; 2329 $_->clear_links_to ($self) for values %cf::MAP;
2330 $self->clear;
1386 2331
1387 $self->unlink_save; 2332 $self->unlink_save;
1388 $self->destroy; 2333 $self->destroy;
1389} 2334}
1390 2335
1391my $nuke_counter = "aaaa"; 2336my $nuke_counter = "aaaa";
1392 2337
1393sub nuke { 2338sub nuke {
1394 my ($self) = @_; 2339 my ($self) = @_;
1395 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};
1396 $self->{deny_save} = 1; 2350 $self->{deny_save} = 1;
1397 $self->reset_timeout (1); 2351 $self->reset_timeout (1);
1398 $self->rename ("{nuke}/" . ($nuke_counter++)); 2352 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2353
2354 $cf::MAP{$self->path} = $self;
2355 }
2356
1399 $self->reset; # polite request, might not happen 2357 $self->reset; # polite request, might not happen
1400} 2358}
1401 2359
1402sub customise_for { 2360=item $maps = cf::map::tmp_maps
1403 my ($map, $ob) = @_;
1404 2361
1405 if ($map->per_player) { 2362Returns an arrayref with all map paths of currently instantiated and saved
1406 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2363maps. May block.
2364
2365=cut
2366
2367sub tmp_maps() {
1407 } 2368 [
1408 2369 map {
1409 $map 2370 utf8::decode $_;
2371 /\.map$/
2372 ? normalise $_
2373 : ()
2374 } @{ aio_readdir $TMPDIR or [] }
2375 ]
1410} 2376}
1411 2377
1412sub emergency_save { 2378=item $maps = cf::map::random_maps
1413 my $freeze_guard = cf::freeze_mainloop;
1414 2379
1415 warn "enter emergency map save\n"; 2380Returns an arrayref with all map paths of currently instantiated and saved
2381random maps. May block.
1416 2382
1417 cf::sync_job { 2383=cut
1418 warn "begin emergency map save\n"; 2384
1419 $_->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;
1420 }; 2442 }
1421 2443
1422 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 }
1423} 2499}
1424 2500
1425package cf; 2501package cf;
1426 2502
1427=back 2503=back
1428
1429 2504
1430=head3 cf::object::player 2505=head3 cf::object::player
1431 2506
1432=over 4 2507=over 4
1433 2508
1436Sends 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>
1437can 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
1438dialogue with the given NPC character. 2513dialogue with the given NPC character.
1439 2514
1440=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};
1441 2530
1442# rough implementation of a future "reply" method that works 2531# rough implementation of a future "reply" method that works
1443# with dialog boxes. 2532# with dialog boxes.
1444#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
1445sub cf::object::player::reply($$$;$) { 2534sub cf::object::player::reply($$$;$) {
1447 2536
1448 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2537 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1449 2538
1450 if ($self->{record_replies}) { 2539 if ($self->{record_replies}) {
1451 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2540 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2541
1452 } 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 {
1453 $msg = $npc->name . " says: $msg" if $npc; 2550 $msg = $npc->name . " says: $msg" if $npc;
1454 $self->message ($msg, $flags); 2551 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2552 }
1455 } 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 (@_);
1456} 2564}
1457 2565
1458=item $player_object->may ("access") 2566=item $player_object->may ("access")
1459 2567
1460Returns wether the given player is authorized to access resource "access" 2568Returns wether the given player is authorized to access resource "access"
1473 2581
1474=item $player_object->enter_link 2582=item $player_object->enter_link
1475 2583
1476Freezes 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}>).
1477 2585
1478The 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.
1479I<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.
1480 2592
1481=item $player_object->leave_link ($map, $x, $y) 2593=item $player_object->leave_link ($map, $x, $y)
1482 2594
1483Moves 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
1484map 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
1485location 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
1486to the emergency map position. 2598fails, to the emergency map position.
1487 2599
1488Might block. 2600Might block.
1489 2601
1490=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}
1491 2613
1492sub cf::object::player::enter_link { 2614sub cf::object::player::enter_link {
1493 my ($self) = @_; 2615 my ($self) = @_;
1494 2616
1495 $self->deactivate_recursive; 2617 $self->deactivate_recursive;
1496 2618
1497 return if $self->map == $LINK_MAP; 2619 return if UNIVERSAL::isa $self->map, "ext::map_link";
1498 2620
1499 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2621 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1500 if $self->map; 2622 if $self->map && $self->map->{path} ne "{link}";
1501 2623
1502 $self->enter_map ($LINK_MAP, 20, 20); 2624 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1503} 2625}
1504 2626
1505sub cf::object::player::leave_link { 2627sub cf::object::player::leave_link {
1506 my ($self, $map, $x, $y) = @_; 2628 my ($self, $map, $x, $y) = @_;
2629
2630 return unless $self->contr->active;
1507 2631
1508 my $link_pos = delete $self->{_link_pos}; 2632 my $link_pos = delete $self->{_link_pos};
1509 2633
1510 unless ($map) { 2634 unless ($map) {
1511 # restore original map position 2635 # restore original map position
1522 ($x, $y) = (-1, -1) 2646 ($x, $y) = (-1, -1)
1523 unless (defined $x) && (defined $y); 2647 unless (defined $x) && (defined $y);
1524 2648
1525 # use -1 or undef as default coordinates, not 0, 0 2649 # use -1 or undef as default coordinates, not 0, 0
1526 ($x, $y) = ($map->enter_x, $map->enter_y) 2650 ($x, $y) = ($map->enter_x, $map->enter_y)
1527 if $x <=0 && $y <= 0; 2651 if $x <= 0 && $y <= 0;
1528 2652
1529 $map->load; 2653 $map->load;
2654 $map->load_neighbours;
1530 2655
2656 return unless $self->contr->active;
2657
2658 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2659 $self->enter_map ($map, $x, $y);
2660
2661 # only activate afterwards, to support waiting in hooks
1531 $self->activate_recursive; 2662 $self->activate_recursive;
1532 $self->enter_map ($map, $x, $y); 2663# unless exists $self->{_link_pos}; # maybe we re in-flight again
1533} 2664}
1534 2665
1535cf::player->attach ( 2666=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1536 on_logout => sub {
1537 my ($pl) = @_;
1538 2667
1539 # abort map switching before logout 2668Moves the player to the given map-path and coordinates by first freezing
1540 if ($pl->ob->{_link_pos}) { 2669her, loading and preparing them map, calling the provided $check callback
1541 cf::sync_job { 2670that has to return the map if sucecssful, and then unfreezes the player on
1542 $pl->ob->leave_link 2671the new (success) or old (failed) map position. In either case, $done will
1543 }; 2672be called at the end of this process.
1544 }
1545 },
1546 on_login => sub {
1547 my ($pl) = @_;
1548 2673
1549 # try to abort aborted map switching on player login :) 2674Note that $check will be called with a potentially non-loaded map, so if
1550 # should happen only on crashes 2675it needs a loaded map it has to call C<< ->load >>.
1551 if ($pl->ob->{_link_pos}) {
1552 2676
1553 $pl->ob->enter_link;
1554 (async {
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 $pl->ob->reply (undef,
1558 "There was an internal problem at your last logout, "
1559 . "the server will try to bring you to your intended destination in a second.",
1560 cf::NDI_RED);
1561 Coro::Timer::sleep 1;
1562 $pl->ob->leave_link;
1563 })->prio (2);
1564 }
1565 },
1566);
1567
1568=item $player_object->goto ($path, $x, $y)
1569
1570=cut 2677=cut
2678
2679our $GOTOGEN;
1571 2680
1572sub cf::object::player::goto { 2681sub cf::object::player::goto {
1573 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;
1574 2686
1575 $self->enter_link; 2687 $self->enter_link;
1576 2688
1577 (async { 2689 (async {
1578 $path = new cf::path $path; 2690 $Coro::current->{desc} = "player::goto $path $x $y";
1579 2691
1580 my $map = cf::map::find $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) {
1581 $map = $map->customise_for ($self) if $map; 2715 $map = $map->customise_for ($self);
1582 2716 $map = $check->($map) if $check && $map;
1583# warn "entering ", $map->path, " at ($x, $y)\n" 2717 } else {
1584# if $map;
1585
1586 $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 }
1587 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};
1588 $self->leave_link ($map, $x, $y); 2731 $self->leave_link ($map, $x, $y);
2732 }
2733
2734 $done->() if $done;
1589 })->prio (1); 2735 })->prio (1);
1590} 2736}
1591 2737
1592=item $player_object->enter_exit ($exit_object) 2738=item $player_object->enter_exit ($exit_object)
1593 2739
1595 2741
1596sub parse_random_map_params { 2742sub parse_random_map_params {
1597 my ($spec) = @_; 2743 my ($spec) = @_;
1598 2744
1599 my $rmp = { # defaults 2745 my $rmp = { # defaults
1600 xsize => 10, 2746 xsize => (cf::rndm 15, 40),
1601 ysize => 10, 2747 ysize => (cf::rndm 15, 40),
2748 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2749 #layout => string,
1602 }; 2750 };
1603 2751
1604 for (split /\n/, $spec) { 2752 for (split /\n/, $spec) {
1605 my ($k, $v) = split /\s+/, $_, 2; 2753 my ($k, $v) = split /\s+/, $_, 2;
1606 2754
1618 # that depends on the exit object 2766 # that depends on the exit object
1619 2767
1620 my $rmp = parse_random_map_params $exit->msg; 2768 my $rmp = parse_random_map_params $exit->msg;
1621 2769
1622 if ($exit->map) { 2770 if ($exit->map) {
1623 $rmp->{region} = $exit->map->region_name; 2771 $rmp->{region} = $exit->region->name;
1624 $rmp->{origin_map} = $exit->map->path; 2772 $rmp->{origin_map} = $exit->map->path;
1625 $rmp->{origin_x} = $exit->x; 2773 $rmp->{origin_x} = $exit->x;
1626 $rmp->{origin_y} = $exit->y; 2774 $rmp->{origin_y} = $exit->y;
2775
2776 $exit->map->touch;
1627 } 2777 }
1628 2778
1629 $rmp->{random_seed} ||= $exit->random_seed; 2779 $rmp->{random_seed} ||= $exit->random_seed;
1630 2780
1631 my $data = cf::to_json $rmp; 2781 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1632 my $md5 = Digest::MD5::md5_hex $data; 2782 my $md5 = Digest::MD5::md5_hex $data;
2783 my $meta = "$RANDOMDIR/$md5.meta";
1633 2784
1634 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) {
1635 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;
1636 2789
2790 my $slaying = "?random/$md5";
2791
2792 if ($exit->valid) {
1637 $exit->slaying ("?random/$md5"); 2793 $exit->slaying ("?random/$md5");
1638 $exit->msg (undef); 2794 $exit->msg (undef);
2795 }
1639 } 2796 }
1640} 2797}
1641 2798
1642sub cf::object::player::enter_exit { 2799sub cf::object::player::enter_exit {
1643 my ($self, $exit) = @_; 2800 my ($self, $exit) = @_;
1645 return unless $self->type == cf::PLAYER; 2802 return unless $self->type == cf::PLAYER;
1646 2803
1647 $self->enter_link; 2804 $self->enter_link;
1648 2805
1649 (async { 2806 (async {
1650 $self->deactivate_recursive; # just to be sure 2807 $Coro::current->{desc} = "enter_exit";
2808
1651 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
1652 prepare_random_map $exit 2816 prepare_random_map $exit
1653 if $exit->slaying eq "/!"; 2817 if $exit->slaying eq "/!";
2818 }
1654 2819
1655 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;
1656 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2821 my $x = $exit->stats->hp;
2822 my $y = $exit->stats->sp;
1657 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
1658 1; 2830 1
1659 }) { 2831 }) {
1660 $self->message ("Something went wrong deep within the crossfire server. " 2832 $self->message ("Something went wrong deep within the deliantra server. "
1661 . "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. "
1662 . "Please report this to the dungeon master", 2834 . "Please report this to the dungeon master!",
1663 cf::NDI_UNIQUE | cf::NDI_RED); 2835 cf::NDI_UNIQUE | cf::NDI_RED);
1664 2836
1665 warn "ERROR in enter_exit: $@"; 2837 warn "ERROR in enter_exit: $@";
1666 $self->leave_link; 2838 $self->leave_link;
1667 } 2839 }
1668 })->prio (1); 2840 })->prio (1);
1681 2853
1682sub cf::client::send_drawinfo { 2854sub cf::client::send_drawinfo {
1683 my ($self, $text, $flags) = @_; 2855 my ($self, $text, $flags) = @_;
1684 2856
1685 utf8::encode $text; 2857 utf8::encode $text;
1686 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2858 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1687} 2859}
1688 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}
1689 3082
1690=item $success = $client->query ($flags, "text", \&cb) 3083=item $success = $client->query ($flags, "text", \&cb)
1691 3084
1692Queues a query to the client, calling the given callback with 3085Queues a query to the client, calling the given callback with
1693the 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>,
1694C<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>.
1695 3088
1696Queries 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
1697reliable at some point in the future. 3090become reliable at some point in the future.
1698 3091
1699=cut 3092=cut
1700 3093
1701sub cf::client::query { 3094sub cf::client::query {
1702 my ($self, $flags, $text, $cb) = @_; 3095 my ($self, $flags, $text, $cb) = @_;
1710 utf8::encode $text; 3103 utf8::encode $text;
1711 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3104 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1712 3105
1713 $self->send_packet ($self->{query_queue}[0][0]) 3106 $self->send_packet ($self->{query_queue}[0][0])
1714 if @{ $self->{query_queue} } == 1; 3107 if @{ $self->{query_queue} } == 1;
3108
3109 1
1715} 3110}
1716 3111
1717cf::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 },
1718 on_reply => sub { 3118 on_reply => sub {
1719 my ($ns, $msg) = @_; 3119 my ($ns, $msg) = @_;
1720 3120
1721 # this weird shuffling is so that direct followup queries 3121 # this weird shuffling is so that direct followup queries
1722 # get handled first 3122 # get handled first
1723 my $queue = delete $ns->{query_queue} 3123 my $queue = delete $ns->{query_queue}
1724 or return; # be conservative, not sure how that can happen, but we saw a crash here 3124 or return; # be conservative, not sure how that can happen, but we saw a crash here
1725 3125
1726 (shift @$queue)->[1]->($msg); 3126 (shift @$queue)->[1]->($msg);
3127 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1727 3128
1728 push @{ $ns->{query_queue} }, @$queue; 3129 push @{ $ns->{query_queue} }, @$queue;
1729 3130
1730 if (@{ $ns->{query_queue} } == @$queue) { 3131 if (@{ $ns->{query_queue} } == @$queue) {
1731 if (@$queue) { 3132 if (@$queue) {
1733 } else { 3134 } else {
1734 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3135 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1735 } 3136 }
1736 } 3137 }
1737 }, 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 },
1738); 3165);
1739 3166
1740=item $client->async (\&cb) 3167=item $client->async (\&cb)
1741 3168
1742Create a new coroutine, running the specified callback. The coroutine will 3169Create a new coroutine, running the specified callback. The coroutine will
1758 3185
1759 $coro 3186 $coro
1760} 3187}
1761 3188
1762cf::client->attach ( 3189cf::client->attach (
1763 on_destroy => sub { 3190 on_client_destroy => sub {
1764 my ($ns) = @_; 3191 my ($ns) = @_;
1765 3192
1766 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3193 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1767 }, 3194 },
1768); 3195);
1783our $safe = new Safe "safe"; 3210our $safe = new Safe "safe";
1784our $safe_hole = new Safe::Hole; 3211our $safe_hole = new Safe::Hole;
1785 3212
1786$SIG{FPE} = 'IGNORE'; 3213$SIG{FPE} = 'IGNORE';
1787 3214
1788$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));
1789 3220
1790# here we export the classes and methods available to script code 3221# here we export the classes and methods available to script code
1791 3222
1792=pod 3223=pod
1793 3224
1794The following fucntions and emthods are available within a safe environment: 3225The following functions and methods are available within a safe environment:
1795 3226
1796 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
1797 cf::object::player player 3232 cf::object::player
1798 cf::player peaceful 3233 player
1799 cf::map trigger 3234
3235 cf::player
3236 peaceful
3237
3238 cf::map
3239 trigger
1800 3240
1801=cut 3241=cut
1802 3242
1803for ( 3243for (
1804 ["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)],
1805 ["cf::object::player" => qw(player)], 3247 ["cf::object::player" => qw(player)],
1806 ["cf::player" => qw(peaceful)], 3248 ["cf::player" => qw(peaceful send_msg)],
1807 ["cf::map" => qw(trigger)], 3249 ["cf::map" => qw(trigger)],
1808) { 3250) {
1809 no strict 'refs'; 3251 no strict 'refs';
1810 my ($pkg, @funs) = @$_; 3252 my ($pkg, @funs) = @$_;
1811 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3253 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1829 3271
1830 my $qcode = $code; 3272 my $qcode = $code;
1831 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3273 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1832 $qcode =~ s/\n/\\n/g; 3274 $qcode =~ s/\n/\\n/g;
1833 3275
3276 %vars = (_dummy => 0) unless %vars;
3277
3278 my @res;
1834 local $_; 3279 local $_;
1835 local @safe::cf::_safe_eval_args = values %vars;
1836 3280
1837 my $eval = 3281 my $eval =
1838 "do {\n" 3282 "do {\n"
1839 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3283 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1840 . "#line 0 \"{$qcode}\"\n" 3284 . "#line 0 \"{$qcode}\"\n"
1841 . $code 3285 . $code
1842 . "\n}" 3286 . "\n}"
1843 ; 3287 ;
1844 3288
3289 if ($CFG{safe_eval}) {
1845 sub_generation_inc; 3290 sub_generation_inc;
3291 local @safe::cf::_safe_eval_args = values %vars;
1846 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3292 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1847 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 }
1848 3298
1849 if ($@) { 3299 if ($@) {
1850 warn "$@"; 3300 warn "$@";
1851 warn "while executing safe code '$code'\n"; 3301 warn "while executing safe code '$code'\n";
1852 warn "with arguments " . (join " ", %vars) . "\n"; 3302 warn "with arguments " . (join " ", %vars) . "\n";
1871=cut 3321=cut
1872 3322
1873sub register_script_function { 3323sub register_script_function {
1874 my ($fun, $cb) = @_; 3324 my ($fun, $cb) = @_;
1875 3325
1876 no strict 'refs'; 3326 $fun = "safe::$fun" if $CFG{safe_eval};
1877 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3327 *$fun = $safe_hole->wrap ($cb);
1878} 3328}
1879 3329
1880=back 3330=back
1881 3331
1882=cut 3332=cut
1883 3333
1884############################################################################# 3334#############################################################################
3335# the server's init and main functions
1885 3336
1886=head2 EXTENSION DATABASE SUPPORT 3337sub load_facedata($) {
3338 my ($path) = @_;
1887 3339
1888Crossfire maintains a very simple database for extension use. It can 3340 # HACK to clear player env face cache, we need some signal framework
1889currently store anything that can be serialised using Storable, which 3341 # for this (global event?)
1890excludes objects. 3342 %ext::player_env::MUSIC_FACE_CACHE = ();
1891 3343
1892The parameter C<$family> should best start with the name of the extension 3344 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1893using it, it should be unique.
1894 3345
1895=over 4 3346 warn "loading facedata from $path\n";
1896 3347
1897=item $hashref = cf::db_get $family 3348 my $facedata;
3349 0 < aio_load $path, $facedata
3350 or die "$path: $!";
1898 3351
1899Return a hashref for use by the extension C<$family>, which can be 3352 $facedata = Coro::Storable::thaw $facedata;
1900modified. After modifications, you have to call C<cf::db_dirty> or
1901C<cf::db_sync>.
1902 3353
1903=item $value = cf::db_get $family => $key 3354 $facedata->{version} == 2
3355 or cf::cleanup "$path: version mismatch, cannot proceed.";
1904 3356
1905Returns a single value from the database 3357 # patch in the exptable
1906 3358 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
1907=item cf::db_put $family => $hashref 3359 $facedata->{resource}{"res/exp_table"} = {
1908 3360 type => FT_RSRC,
1909Stores the given family hashref into the database. Updates are delayed, if 3361 data => $exp_table,
1910you want the data to be synced to disk immediately, use C<cf::db_sync>. 3362 hash => (Digest::MD5::md5 $exp_table),
1911
1912=item cf::db_put $family => $key => $value
1913
1914Stores the given C<$value> in the family hash. Updates are delayed, if you
1915want the data to be synced to disk immediately, use C<cf::db_sync>.
1916
1917=item cf::db_dirty
1918
1919Marks the database as dirty, to be updated at a later time.
1920
1921=item cf::db_sync
1922
1923Immediately write the database to disk I<if it is dirty>.
1924
1925=cut
1926
1927our $DB;
1928
1929{
1930 my $path = cf::localdir . "/database.pst";
1931
1932 sub db_load() {
1933 $DB = stat $path ? Storable::retrieve $path : { };
1934 }
1935
1936 my $pid;
1937
1938 sub db_save() {
1939 waitpid $pid, 0 if $pid;
1940 if (0 == ($pid = fork)) {
1941 $DB->{_meta}{version} = 1;
1942 Storable::nstore $DB, "$path~";
1943 rename "$path~", $path;
1944 cf::_exit 0 if defined $pid;
1945 }
1946 }
1947
1948 my $dirty;
1949
1950 sub db_sync() {
1951 db_save if $dirty;
1952 undef $dirty;
1953 }
1954
1955 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1956 db_sync;
1957 }); 3363 };
3364 cf::cede_to_tick;
1958 3365
1959 sub db_dirty() {
1960 $dirty = 1;
1961 $idle->start;
1962 } 3366 {
3367 my $faces = $facedata->{faceinfo};
1963 3368
1964 sub db_get($;$) { 3369 while (my ($face, $info) = each %$faces) {
1965 @_ >= 2 3370 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1966 ? $DB->{$_[0]}{$_[1]}
1967 : ($DB->{$_[0]} ||= { })
1968 }
1969 3371
1970 sub db_put($$;$) { 3372 cf::face::set_visibility $idx, $info->{visibility};
1971 if (@_ >= 3) { 3373 cf::face::set_magicmap $idx, $info->{magicmap};
1972 $DB->{$_[0]}{$_[1]} = $_[2]; 3374 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
1973 } else { 3375 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1974 $DB->{$_[0]} = $_[1];
1975 }
1976 db_dirty;
1977 }
1978 3376
1979 cf::global->attach ( 3377 cf::cede_to_tick;
1980 prio => 10000,
1981 on_cleanup => sub {
1982 db_sync;
1983 }, 3378 }
1984 );
1985}
1986 3379
1987############################################################################# 3380 while (my ($face, $info) = each %$faces) {
1988# the server's main() 3381 next unless $info->{smooth};
1989 3382
1990sub 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
1991 open my $fh, "<:utf8", cf::confdir . "/config" 3511 open my $fh, "<:utf8", "$CONFDIR/config"
1992 or return; 3512 or return;
1993 3513
1994 local $/; 3514 local $/;
1995 *CFG = YAML::Syck::Load <$fh>; 3515 *CFG = YAML::XS::Load scalar <$fh>;
1996 3516
1997 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3517 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1998 3518
1999 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3519 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2000 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3520 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2001 3521
2002 if (exists $CFG{mlockall}) { 3522 if (exists $CFG{mlockall}) {
2003 eval { 3523 eval {
2004 $CFG{mlockall} ? &mlockall : &munlockall 3524 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2005 and die "WARNING: m(un)lockall failed: $!\n"; 3525 and die "WARNING: m(un)lockall failed: $!\n";
2006 }; 3526 };
2007 warn $@ if $@; 3527 warn $@ if $@;
2008 } 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;
2009} 3559}
2010 3560
2011sub 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
2012 # we must not ever block the main coroutine 3571 # we must not ever block the main coroutine
2013 local $Coro::idle = sub { 3572 local $Coro::idle = sub {
2014 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#
2015 async { Event::one_event }; 3574 (async {
3575 $Coro::current->{desc} = "IDLE BUG HANDLER";
3576 EV::loop EV::LOOP_ONESHOT;
3577 })->prio (Coro::PRIO_MAX);
2016 }; 3578 };
2017 3579
2018 cfg_load; 3580 evthread_start IO::AIO::poll_fileno;
2019 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
2020 load_extensions; 3603 load_extensions;
2021 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;
2022} 3618}
2023 3619
2024############################################################################# 3620#############################################################################
2025# initialisation 3621# initialisation and cleanup
2026 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
2027sub reload() { 3804sub do_reload_perl() {
2028 # can/must only be called in main 3805 # can/must only be called in main
2029 if ($Coro::current != $Coro::main) { 3806 if (in_main) {
2030 warn "can only reload from main coroutine\n"; 3807 warn "can only reload from main coroutine";
2031 return; 3808 return;
2032 } 3809 }
2033 3810
3811 return if $RELOAD++;
3812
3813 my $t1 = AE::time;
3814
3815 while ($RELOAD) {
2034 warn "reloading..."; 3816 warn "reloading...";
2035 3817
2036 my $guard = freeze_mainloop; 3818 warn "entering sync_job";
3819
3820 cf::sync_job {
3821 cf::write_runtime_sync; # external watchdog should not bark
2037 cf::emergency_save; 3822 cf::emergency_save;
3823 cf::write_runtime_sync; # external watchdog should not bark
2038 3824
2039 eval { 3825 warn "syncing database to disk";
3826 BDB::db_env_txn_checkpoint $DB_ENV;
3827
2040 # 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
2041 3829
2042 # cancel all watchers 3830 warn "flushing outstanding aio requests";
2043 for (Event::all_watchers) { 3831 while (IO::AIO::nreqs || BDB::nreqs) {
2044 $_->cancel if $_->data & WF_AUTOCANCEL; 3832 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2045 }
2046
2047 # cancel all extension coros
2048 $_->cancel for values %EXT_CORO;
2049 %EXT_CORO = ();
2050
2051 # unload all extensions
2052 for (@exts) {
2053 warn "unloading <$_>";
2054 unload_extension $_;
2055 }
2056
2057 # unload all modules loaded from $LIBDIR
2058 while (my ($k, $v) = each %INC) {
2059 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2060
2061 warn "removing <$k>";
2062 delete $INC{$k};
2063
2064 $k =~ s/\.pm$//;
2065 $k =~ s/\//::/g;
2066
2067 if (my $cb = $k->can ("unload_module")) {
2068 $cb->();
2069 } 3833 }
2070 3834
2071 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;
2072 } 3859 }
2073 3860
2074 # sync database to disk 3861 warn "unloading all perl modules loaded from $LIBDIR";
2075 cf::db_sync; 3862 while (my ($k, $v) = each %INC) {
2076 IO::AIO::flush; 3863 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2077 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
2078 # get rid of safe::, as good as possible 3878 warn "getting rid of safe::, as good as possible";
2079 Symbol::delete_package "safe::$_" 3879 clear_package "safe::$_"
2080 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);
2081 3881
2082 # remove register_script_function callbacks 3882 warn "unloading cf.pm \"a bit\"";
2083 # TODO
2084
2085 # unload cf.pm "a bit"
2086 delete $INC{"cf.pm"}; 3883 delete $INC{"cf.pm"};
3884 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2087 3885
2088 # don't, removes xs symbols, too, 3886 # don't, removes xs symbols, too,
2089 # and global variables created in xs 3887 # and global variables created in xs
2090 #Symbol::delete_package __PACKAGE__; 3888 #clear_package __PACKAGE__;
2091 3889
2092 # reload cf.pm 3890 warn "unload completed, starting to reload now";
3891
2093 warn "reloading cf.pm"; 3892 warn "reloading cf.pm";
2094 require cf; 3893 require cf;
2095 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3894 cf::_connect_to_perl_1;
2096 3895
2097 # load config and database again 3896 warn "loading config and database again";
2098 cf::cfg_load; 3897 cf::reload_config;
2099 cf::db_load;
2100 3898
2101 # load extensions
2102 warn "load extensions"; 3899 warn "loading extensions";
2103 cf::load_extensions; 3900 cf::load_extensions;
2104 3901
2105 # 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
2106 warn "reattach"; 3922 warn "reloaded";
2107 _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 };
2108 }; 3943 };
2109
2110 if ($@) {
2111 warn $@;
2112 warn "error while reloading, exiting.";
2113 exit 1;
2114 }
2115
2116 warn "reloaded successfully";
2117};
2118
2119#############################################################################
2120
2121unless ($LINK_MAP) {
2122 $LINK_MAP = cf::map::new;
2123
2124 $LINK_MAP->width (41);
2125 $LINK_MAP->height (41);
2126 $LINK_MAP->alloc;
2127 $LINK_MAP->path ("{link}");
2128 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2129 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2130
2131 # dirty hack because... archetypes are not yet loaded
2132 Event->timer (
2133 after => 10,
2134 cb => sub {
2135 $_[0]->w->cancel;
2136
2137 # provide some exits "home"
2138 my $exit = cf::object::new "exit";
2139
2140 $exit->slaying ($EMERGENCY_POSITION->[0]);
2141 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2142 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2143
2144 $LINK_MAP->insert ($exit->clone, 19, 19);
2145 $LINK_MAP->insert ($exit->clone, 19, 20);
2146 $LINK_MAP->insert ($exit->clone, 19, 21);
2147 $LINK_MAP->insert ($exit->clone, 20, 19);
2148 $LINK_MAP->insert ($exit->clone, 20, 21);
2149 $LINK_MAP->insert ($exit->clone, 21, 19);
2150 $LINK_MAP->insert ($exit->clone, 21, 20);
2151 $LINK_MAP->insert ($exit->clone, 21, 21);
2152
2153 $exit->destroy;
2154 });
2155
2156 $LINK_MAP->{deny_save} = 1;
2157 $LINK_MAP->{deny_reset} = 1;
2158
2159 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2160} 3944}
2161
2162register "<global>", __PACKAGE__;
2163 3945
2164register_command "reload" => sub { 3946register_command "reload" => sub {
2165 my ($who, $arg) = @_; 3947 my ($who, $arg) = @_;
2166 3948
2167 if ($who->flag (FLAG_WIZ)) { 3949 if ($who->flag (FLAG_WIZ)) {
2168 $who->message ("start of reload.");
2169 reload;
2170 $who->message ("end of reload."); 3950 $who->message ("reloading server.");
3951 async {
3952 $Coro::current->{desc} = "perl_reload";
3953 reload_perl;
3954 };
2171 } 3955 }
2172}; 3956};
2173 3957
2174unshift @INC, $LIBDIR; 3958unshift @INC, $LIBDIR;
2175 3959
2176$TICK_WATCHER = Event->timer ( 3960my $bug_warning = 0;
2177 reentrant => 0, 3961
2178 prio => 0, 3962our @WAIT_FOR_TICK;
2179 at => $NEXT_TICK || $TICK, 3963our @WAIT_FOR_TICK_BEGIN;
2180 data => WF_AUTOCANCEL, 3964
2181 cb => sub { 3965sub wait_for_tick {
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
2182 cf::server_tick; # one server iteration 3988 cf::server_tick; # one server iteration
2183 $RUNTIME += $TICK;
2184 $NEXT_TICK += $TICK;
2185 3989
2186 # if we are delayed by four ticks or more, skip them all 3990 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2187 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2188 3991
2189 $TICK_WATCHER->at ($NEXT_TICK); 3992 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2190 $TICK_WATCHER->start; 3993 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2191 }, 3994 Coro::async_pool {
2192); 3995 $Coro::current->{desc} = "runtime saver";
2193
2194IO::AIO::max_poll_time $TICK * 0.2;
2195
2196Event->io (
2197 fd => IO::AIO::poll_fileno,
2198 poll => 'r',
2199 prio => 5,
2200 data => WF_AUTOCANCEL,
2201 cb => \&IO::AIO::poll_cb,
2202);
2203
2204Event->timer (
2205 data => WF_AUTOCANCEL,
2206 after => 0,
2207 interval => 10,
2208 cb => sub {
2209 (Coro::unblock_sub {
2210 write_runtime 3996 write_runtime_sync
2211 or warn "ERROR: unable to write runtime file: $!"; 3997 or warn "ERROR: unable to write runtime file: $!";
2212 })->(); 3998 };
2213 }, 3999 }
2214); 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;
2215 4115
2216END { cf::emergency_save } 4116END { cf::emergency_save }
2217 4117
22181 41181
2219 4119

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines