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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.522 by root, Sat Apr 17 02:22:14 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines