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.167 by root, Sat Jan 13 23:32:43 2007 UTC vs.
Revision 1.413 by root, Sun Apr 6 16:13:20 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines