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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines