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.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.525 by root, Wed Apr 21 03:34:26 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines