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.206 by root, Sun Feb 11 22:27:05 2007 UTC vs.
Revision 1.434 by root, Thu May 29 03:27:37 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines