ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.536 by root, Thu Apr 29 08:26:38 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines