ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.204 by root, Fri Feb 2 19:59:22 2007 UTC vs.
Revision 1.440 by root, Mon Aug 11 23:23:41 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines