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.230 by root, Mon Apr 2 18:04:46 2007 UTC vs.
Revision 1.444 by root, Mon Sep 8 11:27:25 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines