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.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.522 by root, Sat Apr 17 02:22:14 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines