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.217 by root, Thu Feb 15 21:07:49 2007 UTC vs.
Revision 1.445 by root, Wed Sep 10 18:18:10 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines