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.207 by root, Sun Feb 11 22:42:09 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 ();
20use BDB (); 50use BDB ();
21use Data::Dumper; 51use Data::Dumper;
22use Digest::MD5; 52use Digest::MD5;
23use Fcntl; 53use Fcntl;
54use YAML ();
24use IO::AIO 2.32 (); 55use IO::AIO ();
25use YAML::Syck ();
26use Time::HiRes; 56use Time::HiRes;
57use Compress::LZF;
58use Digest::MD5 ();
27 59
28use Event; $Event::Eval = 1; # no idea why this is required, but it is 60AnyEvent::detect;
61
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
29 69
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 70sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31
32# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33$YAML::Syck::ImplicitUnicode = 1;
34
35$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36 71
37our %COMMAND = (); 72our %COMMAND = ();
38our %COMMAND_TIME = (); 73our %COMMAND_TIME = ();
39 74
40our @EXTS = (); # list of extension package names 75our @EXTS = (); # list of extension package names
41our %EXTCMD = (); 76our %EXTCMD = ();
77our %EXTICMD = ();
42our %EXT_CORO = (); # coroutines bound to extensions 78our %EXT_CORO = (); # coroutines bound to extensions
43our %EXT_MAP = (); # pluggable maps 79our %EXT_MAP = (); # pluggable maps
44 80
81our $RELOAD; # number of reloads so far
45our @EVENT; 82our @EVENT;
46our $LIBDIR = datadir . "/ext";
47 83
48our $TICK = MAX_TIME * 1e-6; 84our $CONFDIR = confdir;
49our $TICK_WATCHER; 85our $DATADIR = datadir;
50our $AIO_POLL_WATCHER; 86our $LIBDIR = "$DATADIR/ext";
51our $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
52our $NEXT_TICK; 99our $NEXT_TICK;
53our $NOW;
54our $USE_FSYNC = 1; # use fsync to write maps - default off 100our $USE_FSYNC = 1; # use fsync to write maps - default off
55 101
102our $BDB_DEADLOCK_WATCHER;
103our $BDB_CHECKPOINT_WATCHER;
56our $BDB_POLL_WATCHER; 104our $BDB_TRICKLE_WATCHER;
57our $DB_ENV; 105our $DB_ENV;
58 106
59our %CFG; 107our %CFG;
60 108
61our $UPTIME; $UPTIME ||= time; 109our $UPTIME; $UPTIME ||= time;
62our $RUNTIME; 110our $RUNTIME;
111our $NOW;
63 112
64our %PLAYER; # all users 113our (%PLAYER, %PLAYER_LOADING); # all users
65our %MAP; # all maps 114our (%MAP, %MAP_LOADING ); # all maps
66our $LINK_MAP; # the special {link} map, which is always available 115our $LINK_MAP; # the special {link} map, which is always available
67our $RANDOM_MAPS = cf::localdir . "/random";
68our $BDB_ENV_DIR = cf::localdir . "/db";
69
70our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72 116
73# 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 ∕
74our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 118our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75 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
76binmode STDOUT; 125binmode STDOUT;
77binmode STDERR; 126binmode STDERR;
78 127
79# read virtual server time, if available 128# read virtual server time, if available
80unless ($RUNTIME || !-e cf::localdir . "/runtime") { 129unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
81 open my $fh, "<", cf::localdir . "/runtime" 130 open my $fh, "<", "$LOCALDIR/runtime"
82 or die "unable to read runtime file: $!"; 131 or die "unable to read runtime file: $!";
83 $RUNTIME = <$fh> + 0.; 132 $RUNTIME = <$fh> + 0.;
84} 133}
85 134
86mkdir cf::localdir; 135mkdir $_
87mkdir cf::localdir . "/" . cf::playerdir; 136 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
88mkdir cf::localdir . "/" . cf::tmpdir;
89mkdir cf::localdir . "/" . cf::uniquedir;
90mkdir $RANDOM_MAPS;
91mkdir $BDB_ENV_DIR;
92 137
93our $EMERGENCY_POSITION; 138our $EMERGENCY_POSITION;
94 139
95sub cf::map::normalise; 140sub cf::map::normalise;
96 141
107=item $cf::RUNTIME 152=item $cf::RUNTIME
108 153
109The 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
110every server tick. 155every server tick.
111 156
112=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
113 160
114The perl library directory, where extensions and cf-specific modules can 161Various directories - "/etc", read-only install directory, perl-library
115be 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.
116 165
117=item $cf::NOW 166=item $cf::NOW
118 167
119The time of the last (current) server tick. 168The time of the last (current) server tick.
120 169
121=item $cf::TICK 170=item $cf::TICK
122 171
123The interval between server ticks, in seconds. 172The interval between server ticks, in seconds.
124 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
125=item %cf::CFG 184=item %cf::CFG
126 185
127Configuration for the server, loaded from C</etc/crossfire/config>, or 186Configuration for the server, loaded from C</etc/deliantra-server/config>, or
128from wherever your confdir points to. 187from wherever your confdir points to.
129 188
130=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 189=item cf::wait_for_tick, cf::wait_for_tick_begin
131 190
132These 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
133or 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
134processing 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.
135window 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.
136 200
137=back 201=back
138 202
139=cut 203=cut
140 204
141BEGIN { 205BEGIN {
142 *CORE::GLOBAL::warn = sub { 206 *CORE::GLOBAL::warn = sub {
143 my $msg = join "", @_; 207 my $msg = join "", @_;
144 utf8::encode $msg;
145 208
146 $msg .= "\n" 209 $msg .= "\n"
147 unless $msg =~ /\n$/; 210 unless $msg =~ /\n$/;
148 211
212 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
213
149 LOG llevError, $msg; 214 LOG llevError, $msg;
150 }; 215 };
151} 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#?
152 232
153@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 233@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 234@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 235@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 236@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157@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';
158@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)
159 240
160# 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
161# within the Safe compartment. 242# within the Safe compartment.
162for my $pkg (qw( 243for my $pkg (qw(
163 cf::global cf::attachable 244 cf::global cf::attachable
164 cf::object cf::object::player 245 cf::object cf::object::player
165 cf::client cf::player 246 cf::client cf::player
166 cf::arch cf::living 247 cf::arch cf::living
248 cf::map cf::mapspace
167 cf::map cf::party cf::region 249 cf::party cf::region
168)) { 250)) {
169 no strict 'refs'; 251 no strict 'refs';
170 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 252 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
171} 253}
172 254
173$Event::DIED = sub { 255$EV::DIED = sub {
174 warn "error in event callback: @_"; 256 warn "error in event callback: @_";
175}; 257};
258
259#############################################################################
176 260
177=head2 UTILITY FUNCTIONS 261=head2 UTILITY FUNCTIONS
178 262
179=over 4 263=over 4
180 264
199 $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;
200 $d 284 $d
201 } || "[unable to dump $_[0]: '$@']"; 285 } || "[unable to dump $_[0]: '$@']";
202} 286}
203 287
204use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206=item $ref = cf::from_json $json 288=item $ref = cf::decode_json $json
207 289
208Converts a JSON string into the corresponding perl data structure. 290Converts a JSON string into the corresponding perl data structure.
209 291
210=cut
211
212sub from_json($) {
213 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214 JSON::Syck::Load $_[0]
215}
216
217=item $json = cf::to_json $ref 292=item $json = cf::encode_json $ref
218 293
219Converts a perl data structure into its JSON representation. 294Converts a perl data structure into its JSON representation.
220 295
221=cut 296=cut
222 297
223sub to_json($) { 298our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 299
225 JSON::Syck::Dump $_[0] 300sub encode_json($) { $json_coder->encode ($_[0]) }
226} 301sub decode_json($) { $json_coder->decode ($_[0]) }
227 302
228=item cf::lock_wait $string 303=item cf::lock_wait $string
229 304
230Wait until the given lock is available. See cf::lock_acquire. 305Wait until the given lock is available. See cf::lock_acquire.
231 306
234Wait 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
235a 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,
236for example when the coroutine gets canceled), the lock is automatically 311for example when the coroutine gets canceled), the lock is automatically
237returned. 312returned.
238 313
314Locks are *not* recursive, locking from the same coro twice results in a
315deadlocked coro.
316
239Lock 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
240uses map_find and cf::map::load uses map_load). 318uses map_find and cf::map::load uses map_load).
241 319
320=item $locked = cf::lock_active $string
321
322Return true if the lock is currently active, i.e. somebody has locked it.
323
242=cut 324=cut
243 325
244our %LOCK; 326our %LOCK;
327our %LOCKER;#d#
245 328
246sub lock_wait($) { 329sub lock_wait($) {
247 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#
248 336
249 # wait for lock, if any 337 # wait for lock, if any
250 while ($LOCK{$key}) { 338 while ($LOCK{$key}) {
251 push @{ $LOCK{$key} }, $Coro::current; 339 push @{ $LOCK{$key} }, $Coro::current;
252 Coro::schedule; 340 Coro::schedule;
258 346
259 # wait, to be sure we are not locked 347 # wait, to be sure we are not locked
260 lock_wait $key; 348 lock_wait $key;
261 349
262 $LOCK{$key} = []; 350 $LOCK{$key} = [];
351 $LOCKER{$key} = $Coro::current;#d#
263 352
264 Coro::guard { 353 Coro::guard {
354 delete $LOCKER{$key};#d#
265 # wake up all waiters, to be on the safe side 355 # wake up all waiters, to be on the safe side
266 $_->ready for @{ delete $LOCK{$key} }; 356 $_->ready for @{ delete $LOCK{$key} };
267 } 357 }
268} 358}
269 359
360sub lock_active($) {
361 my ($key) = @_;
362
363 ! ! $LOCK{$key}
364}
365
270sub freeze_mainloop { 366sub freeze_mainloop {
271 return unless $TICK_WATCHER->is_active; 367 tick_inhibit_inc;
272 368
273 my $guard = Coro::guard { 369 Coro::guard \&tick_inhibit_dec;
274 $TICK_WATCHER->start; 370}
275 $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 }
276 }; 430 }
277 $WRITE_RUNTIME_WATCHER->stop; 431};
278 $TICK_WATCHER->stop; 432
279 $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;
280} 445}
281 446
282=item cf::async { BLOCK } 447=item cf::async { BLOCK }
283 448
284Currently the same as Coro::async_pool, meaning you cannot use 449Currently the same as Coro::async_pool, meaning you cannot use
289 454
290BEGIN { *async = \&Coro::async_pool } 455BEGIN { *async = \&Coro::async_pool }
291 456
292=item cf::sync_job { BLOCK } 457=item cf::sync_job { BLOCK }
293 458
294The design of crossfire+ requires that the main coro ($Coro::main) is 459The design of Deliantra requires that the main coroutine ($Coro::main)
295always able to handle events or runnable, as crossfire+ is only partly 460is always able to handle events or runnable, as Deliantra is only
296reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 461partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
462acceptable.
297 463
298If 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
299the given BLOCK in another coroutine while waiting for the result. The 465the given BLOCK in another coroutine while waiting for the result. The
300server 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
301fast or be very important. 467fast or be very important.
304 470
305sub sync_job(&) { 471sub sync_job(&) {
306 my ($job) = @_; 472 my ($job) = @_;
307 473
308 if ($Coro::current == $Coro::main) { 474 if ($Coro::current == $Coro::main) {
475 my $time = EV::time;
476
309 # this is the main coro, too bad, we have to block 477 # this is the main coro, too bad, we have to block
310 # till the operation succeeds, freezing the server :/ 478 # till the operation succeeds, freezing the server :/
311 479
312 # TODO: use suspend/resume instead 480 LOG llevError, Carp::longmess "sync job";#d#
313 # (but this is cancel-safe) 481
314 my $freeze_guard = freeze_mainloop; 482 my $freeze_guard = freeze_mainloop;
315 483
316 my $busy = 1; 484 my $busy = 1;
317 my @res; 485 my @res;
318 486
319 (async { 487 (async {
488 $Coro::current->desc ("sync job coro");
320 @res = eval { $job->() }; 489 @res = eval { $job->() };
321 warn $@ if $@; 490 warn $@ if $@;
322 undef $busy; 491 undef $busy;
323 })->prio (Coro::PRIO_MAX); 492 })->prio (Coro::PRIO_MAX);
324 493
325 while ($busy) { 494 while ($busy) {
326 Coro::cede or Event::one_event; 495 if (Coro::nready) {
496 Coro::cede_notself;
497 } else {
498 EV::loop EV::LOOP_ONESHOT;
327 } 499 }
500 }
501
502 my $time = EV::time - $time;
503
504 $TICK_START += $time; # do not account sync jobs to server load
328 505
329 wantarray ? @res : $res[0] 506 wantarray ? @res : $res[0]
330 } else { 507 } else {
331 # we are in another coroutine, how wonderful, everything just works 508 # we are in another coroutine, how wonderful, everything just works
332 509
352 $EXT_CORO{$coro+0} = $coro; 529 $EXT_CORO{$coro+0} = $coro;
353 530
354 $coro 531 $coro
355} 532}
356 533
357sub write_runtime { 534=item fork_call { }, $args
358 my $runtime = cf::localdir . "/runtime";
359 535
360 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 536Executes the given code block with the given arguments in a seperate
361 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.
362 540
363 my $value = $cf::RUNTIME + 90 + 10; 541=cut
364 # 10 is the runtime save interval, for a monotonic clock
365 # 60 allows for the watchdog to kill the server.
366 542
367 (aio_write $fh, 0, (length $value), $value, 0) <= 0 543sub fork_call(&@) {
368 and return; 544 my ($cb, @args) = @_;
369 545
370 # always fsync - this file is important 546 # we seemingly have to make a local copy of the whole thing,
371 aio_fsync $fh 547 # otherwise perl prematurely frees the stuff :/
372 and return; 548 # TODO: investigate and fix (likely this will be rather laborious)
373 549
374 close $fh 550 my @res = Coro::Util::fork_eval {
375 or return; 551 reset_signals;
552 &$cb
553 }, @args;
376 554
377 aio_rename "$runtime~", $runtime 555 wantarray ? @res : $res[-1]
378 and return; 556}
379 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
380 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 });
381} 721}
382 722
383=back 723=back
384 724
385=cut 725=cut
392attach callbacks/event handlers (a collection of which is called an "attachment") 732attach callbacks/event handlers (a collection of which is called an "attachment")
393to it. All such attachable objects support the following methods. 733to it. All such attachable objects support the following methods.
394 734
395In 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>
396C<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
397crossfire+). 737Deliantra).
398 738
399=over 4 739=over 4
400 740
401=item $attachable->attach ($attachment, key => $value...) 741=item $attachable->attach ($attachment, key => $value...)
402 742
565 $registry = $CB_TYPE[$object_type] ||= []; 905 $registry = $CB_TYPE[$object_type] ||= [];
566 906
567 } elsif ($type eq "subtype") { 907 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 908 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 909 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 910 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 911
572 } elsif ($type eq "package") { 912 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 913 my $pkg = shift @arg;
574 914
575 while (my ($name, $id) = each %cb_id) { 915 while (my ($name, $id) = each %cb_id) {
604 _attach $registry, $klass, @attach; 944 _attach $registry, $klass, @attach;
605 } 945 }
606 946
607 $obj->{$name} = \%arg; 947 $obj->{$name} = \%arg;
608 } else { 948 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 949 warn "object uses attachment '$name' which is not available, postponing.\n";
610 } 950 }
611 951
612 $obj->{_attachment}{$name} = undef; 952 $obj->{_attachment}{$name} = undef;
613} 953}
614 954
616 if (ref $_[0]) { 956 if (ref $_[0]) {
617 _object_attach @_; 957 _object_attach @_;
618 } else { 958 } else {
619 _attach shift->_attach_registry, @_; 959 _attach shift->_attach_registry, @_;
620 } 960 }
961 _recalc_want;
621}; 962};
622 963
623# all those should be optimised 964# all those should be optimised
624sub cf::attachable::detach { 965sub cf::attachable::detach {
625 my ($obj, $name) = @_; 966 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 969 delete $obj->{_attachment}{$name};
629 reattach ($obj); 970 reattach ($obj);
630 } else { 971 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 972 Carp::croak "cannot, currently, detach class attachments";
632 } 973 }
974 _recalc_want;
633}; 975};
634 976
635sub cf::attachable::attached { 977sub cf::attachable::attached {
636 my ($obj, $name) = @_; 978 my ($obj, $name) = @_;
637 979
652 "; 994 ";
653 die if $@; 995 die if $@;
654} 996}
655 997
656our $override; 998our $override;
657our @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?
658 1000
659sub override { 1001sub override {
660 $override = 1; 1002 $override = 1;
661 @invoke_results = (); 1003 @INVOKE_RESULTS = (@_);
662} 1004}
663 1005
664sub do_invoke { 1006sub do_invoke {
665 my $event = shift; 1007 my $event = shift;
666 my $callbacks = shift; 1008 my $callbacks = shift;
667 1009
668 @invoke_results = (); 1010 @INVOKE_RESULTS = ();
669 1011
670 local $override; 1012 local $override;
671 1013
672 for (@$callbacks) { 1014 for (@$callbacks) {
673 eval { &{$_->[1]} }; 1015 eval { &{$_->[1]} };
682 } 1024 }
683 1025
684 0 1026 0
685} 1027}
686 1028
687=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1029=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688 1030
689=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1031=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690 1032
691Generate an object-specific event with the given arguments. 1033Generate an object-specific event with the given arguments.
692 1034
693This 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
694removed 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
695results (if you must, access C<@cf::invoke_results> directly). 1037results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 1038
697=back 1039=back
698 1040
699=cut 1041=cut
700 1042
701############################################################################# 1043#############################################################################
702# 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}
703 1087
704sub reattach { 1088sub reattach {
705 # basically do the same as instantiate, without calling instantiate 1089 # basically do the same as instantiate, without calling instantiate
706 my ($obj) = @_; 1090 my ($obj) = @_;
707 1091
728cf::attachable->attach ( 1112cf::attachable->attach (
729 prio => -1000000, 1113 prio => -1000000,
730 on_instantiate => sub { 1114 on_instantiate => sub {
731 my ($obj, $data) = @_; 1115 my ($obj, $data) = @_;
732 1116
733 $data = from_json $data; 1117 $data = decode_json $data;
734 1118
735 for (@$data) { 1119 for (@$data) {
736 my ($name, $args) = @$_; 1120 my ($name, $args) = @$_;
737 1121
738 $obj->attach ($name, %{$args || {} }); 1122 $obj->attach ($name, %{$args || {} });
754sub object_freezer_save { 1138sub object_freezer_save {
755 my ($filename, $rdata, $objs) = @_; 1139 my ($filename, $rdata, $objs) = @_;
756 1140
757 sync_job { 1141 sync_job {
758 if (length $$rdata) { 1142 if (length $$rdata) {
1143 utf8::decode (my $decname = $filename);
759 warn sprintf "saving %s (%d,%d)\n", 1144 warn sprintf "saving %s (%d,%d)\n",
760 $filename, length $$rdata, scalar @$objs; 1145 $decname, length $$rdata, scalar @$objs;
761 1146
762 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1147 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
763 chmod SAVE_MODE, $fh; 1148 aio_chmod $fh, SAVE_MODE;
764 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1149 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
765 aio_fsync $fh if $cf::USE_FSYNC; 1150 aio_fsync $fh if $cf::USE_FSYNC;
766 close $fh; 1151 aio_close $fh;
767 1152
768 if (@$objs) { 1153 if (@$objs) {
769 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) {
770 chmod SAVE_MODE, $fh; 1155 aio_chmod $fh, SAVE_MODE;
771 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1156 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
772 aio_write $fh, 0, (length $data), $data, 0; 1157 aio_write $fh, 0, (length $data), $data, 0;
773 aio_fsync $fh if $cf::USE_FSYNC; 1158 aio_fsync $fh if $cf::USE_FSYNC;
774 close $fh; 1159 aio_close $fh;
775 aio_rename "$filename.pst~", "$filename.pst"; 1160 aio_rename "$filename.pst~", "$filename.pst";
776 } 1161 }
777 } else { 1162 } else {
778 aio_unlink "$filename.pst"; 1163 aio_unlink "$filename.pst";
779 } 1164 }
784 } 1169 }
785 } else { 1170 } else {
786 aio_unlink $filename; 1171 aio_unlink $filename;
787 aio_unlink "$filename.pst"; 1172 aio_unlink "$filename.pst";
788 } 1173 }
789
790 #d##TODO# nuke non .map-files if exist
791 if ($filename =~ s/\.map$//) {
792 aio_unlink $filename;
793 aio_unlink "$filename.pst";
794 }
795 } 1174 };
796} 1175}
797 1176
798sub object_freezer_as_string { 1177sub object_freezer_as_string {
799 my ($rdata, $objs) = @_; 1178 my ($rdata, $objs) = @_;
800 1179
805 1184
806sub object_thawer_load { 1185sub object_thawer_load {
807 my ($filename) = @_; 1186 my ($filename) = @_;
808 1187
809 my ($data, $av); 1188 my ($data, $av);
810
811 #d#TODO remove .map if file does not exist
812 aio_stat $filename and $filename =~ s/\.map$//;
813 1189
814 (aio_load $filename, $data) >= 0 1190 (aio_load $filename, $data) >= 0
815 or return; 1191 or return;
816 1192
817 unless (aio_stat "$filename.pst") { 1193 unless (aio_stat "$filename.pst") {
818 (aio_load "$filename.pst", $av) >= 0 1194 (aio_load "$filename.pst", $av) >= 0
819 or return; 1195 or return;
1196
820 $av = eval { (Storable::thaw $av)->{objs} }; 1197 my $st = eval { Coro::Storable::thaw $av };
1198 $av = $st->{objs};
821 } 1199 }
822 1200
1201 utf8::decode (my $decname = $filename);
823 warn sprintf "loading %s (%d)\n", 1202 warn sprintf "loading %s (%d,%d)\n",
824 $filename, length $data, scalar @{$av || []};#d# 1203 $decname, length $data, scalar @{$av || []};
1204
825 return ($data, $av); 1205 ($data, $av)
826} 1206}
1207
1208=head2 COMMAND CALLBACKS
1209
1210=over 4
1211
1212=cut
827 1213
828############################################################################# 1214#############################################################################
829# command handling &c 1215# command handling &c
830 1216
831=item cf::register_command $name => \&callback($ob,$args); 1217=item cf::register_command $name => \&callback($ob,$args);
844 push @{ $COMMAND{$name} }, [$caller, $cb]; 1230 push @{ $COMMAND{$name} }, [$caller, $cb];
845} 1231}
846 1232
847=item cf::register_extcmd $name => \&callback($pl,$packet); 1233=item cf::register_extcmd $name => \&callback($pl,$packet);
848 1234
849Register 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.
850 1240
851If 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
852called. 1242called.
853 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
854=cut 1255=cut
855 1256
856sub register_extcmd { 1257sub register_extcmd {
857 my ($name, $cb) = @_; 1258 my ($name, $cb) = @_;
858 1259
859 $EXTCMD{$name} = $cb; 1260 $EXTCMD{$name} = $cb;
1261}
1262
1263sub register_exticmd {
1264 my ($name, $cb) = @_;
1265
1266 $EXTICMD{$name} = $cb;
860} 1267}
861 1268
862cf::player->attach ( 1269cf::player->attach (
863 on_command => sub { 1270 on_command => sub {
864 my ($pl, $name, $params) = @_; 1271 my ($pl, $name, $params) = @_;
873 cf::override; 1280 cf::override;
874 }, 1281 },
875 on_extcmd => sub { 1282 on_extcmd => sub {
876 my ($pl, $buf) = @_; 1283 my ($pl, $buf) = @_;
877 1284
878 my $msg = eval { from_json $buf }; 1285 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879 1286
880 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
881 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1295 if (my $cb = $EXTCMD{$type}) {
882 if (my %reply = $cb->($pl, $msg)) { 1296 @reply = $cb->($pl, @payload);
883 $pl->ext_reply ($msg->{msgid}, %reply);
884 }
885 } 1297 }
1298
1299 $pl->ext_reply ($reply, @reply)
1300 if $reply;
1301
886 } else { 1302 } else {
887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1303 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888 } 1304 }
889 1305
890 cf::override; 1306 cf::override;
891 }, 1307 },
892); 1308);
893 1309
894sub load_extension {
895 my ($path) = @_;
896
897 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
898 my $base = $1;
899 my $pkg = $1;
900 $pkg =~ s/[^[:word:]]/_/g;
901 $pkg = "ext::$pkg";
902
903 warn "... loading '$path' into '$pkg'\n";
904
905 open my $fh, "<:utf8", $path
906 or die "$path: $!";
907
908 my $source =
909 "package $pkg; use strict; use utf8;\n"
910 . "#line 1 \"$path\"\n{\n"
911 . (do { local $/; <$fh> })
912 . "\n};\n1";
913
914 unless (eval $source) {
915 my $msg = $@ ? "$path: $@\n"
916 : "extension disabled.\n";
917 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918 warn $@;
919 warn "mandatory extension failed to load, exiting.\n";
920 exit 1;
921 }
922 die $@;
923 }
924
925 push @EXTS, $pkg;
926}
927
928sub load_extensions { 1310sub load_extensions {
1311 cf::sync_job {
1312 my %todo;
1313
929 for my $ext (<$LIBDIR/*.ext>) { 1314 for my $path (<$LIBDIR/*.ext>) {
930 next unless -r $ext; 1315 next unless -r $path;
931 eval { 1316
932 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;
933 1 1373 }
934 } or warn "$ext not loaded: $@"; 1374
1375 skip:
1376 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1377 unless $progress;
1378 }
935 } 1379 };
936} 1380}
937 1381
938############################################################################# 1382#############################################################################
939 1383
1384=back
1385
940=head2 CORE EXTENSIONS 1386=head2 CORE EXTENSIONS
941 1387
942Functions and methods that extend core crossfire objects. 1388Functions and methods that extend core crossfire objects.
943 1389
944=cut 1390=cut
949 1395
950=head3 cf::player 1396=head3 cf::player
951 1397
952=over 4 1398=over 4
953 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
954=item cf::player::find $login 1414=item cf::player::find $login
955 1415
956Returns the given player object, loading it if necessary (might block). 1416Returns the given player object, loading it if necessary (might block).
957 1417
958=cut 1418=cut
959 1419
960sub playerdir($) { 1420sub playerdir($) {
961 cf::localdir 1421 "$PLAYERDIR/"
962 . "/"
963 . cf::playerdir
964 . "/"
965 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1422 . (ref $_[0] ? $_[0]->ob->name : $_[0])
966} 1423}
967 1424
968sub path($) { 1425sub path($) {
969 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1426 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970 1427
971 (playerdir $login) . "/$login.pl" 1428 (playerdir $login) . "/playerdata"
972} 1429}
973 1430
974sub find_active($) { 1431sub find_active($) {
975 $cf::PLAYER{$_[0]} 1432 $cf::PLAYER{$_[0]}
976 and $cf::PLAYER{$_[0]}->active 1433 and $cf::PLAYER{$_[0]}->active
989 my $login = $_[0]; 1446 my $login = $_[0];
990 1447
991 my $guard = cf::lock_acquire "user_find:$login"; 1448 my $guard = cf::lock_acquire "user_find:$login";
992 1449
993 $cf::PLAYER{$_[0]} || do { 1450 $cf::PLAYER{$_[0]} || do {
994 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
995 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;
996 $cf::PLAYER{$login} = $pl 1466 $cf::PLAYER{$login} = $pl
997 } 1467 }
998 } 1468 }
999} 1469}
1000 1470
1009 return if $pl->{deny_save}; 1479 return if $pl->{deny_save};
1010 1480
1011 aio_mkdir playerdir $pl, 0770; 1481 aio_mkdir playerdir $pl, 0770;
1012 $pl->{last_save} = $cf::RUNTIME; 1482 $pl->{last_save} = $cf::RUNTIME;
1013 1483
1484 cf::get_slot 0.01;
1485
1014 $pl->save_pl ($path); 1486 $pl->save_pl ($path);
1015 Coro::cede; 1487 cf::cede_to_tick;
1016} 1488}
1017 1489
1018sub new($) { 1490sub new($) {
1019 my ($login) = @_; 1491 my ($login) = @_;
1020 1492
1026 $cf::PLAYER{$login} = $self; 1498 $cf::PLAYER{$login} = $self;
1027 1499
1028 $self 1500 $self
1029} 1501}
1030 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
1031=item $pl->quit_character 1513=item $pl->quit_character
1032 1514
1033Nukes the player without looking back. If logged in, the connection will 1515Nukes the player without looking back. If logged in, the connection will
1034be destroyed. May block for a long time. 1516be destroyed. May block for a long time.
1035 1517
1036=cut 1518=cut
1037 1519
1038sub quit_character { 1520sub quit_character {
1039 my ($pl) = @_; 1521 my ($pl) = @_;
1040 1522
1523 my $name = $pl->ob->name;
1524
1041 $pl->{deny_save} = 1; 1525 $pl->{deny_save} = 1;
1042 $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
1043 1527
1044 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1528 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1045 $pl->deactivate; 1529 $pl->deactivate;
1530 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1531 $pl->ob->check_score;
1046 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1532 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1047 $pl->ns->destroy if $pl->ns; 1533 $pl->ns->destroy if $pl->ns;
1048 1534
1049 my $path = playerdir $pl; 1535 my $path = playerdir $pl;
1050 my $temp = "$path~$cf::RUNTIME~deleting~"; 1536 my $temp = "$path~$cf::RUNTIME~deleting~";
1051 aio_rename $path, $temp; 1537 aio_rename $path, $temp;
1052 delete $cf::PLAYER{$pl->ob->name}; 1538 delete $cf::PLAYER{$pl->ob->name};
1053 $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
1054 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;
1055} 1561}
1056 1562
1057=item cf::player::list_logins 1563=item cf::player::list_logins
1058 1564
1059Returns 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
1060while and may block, so not sync_job-capable, ever. 1566while and may block, so not sync_job-capable, ever.
1061 1567
1062=cut 1568=cut
1063 1569
1064sub list_logins { 1570sub list_logins {
1065 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1571 my $dirs = aio_readdir $PLAYERDIR
1066 or return []; 1572 or return [];
1067 1573
1068 my @logins; 1574 my @logins;
1069 1575
1070 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") {
1071 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1582 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1072 aio_read $fh, 0, 512, my $buf, 0 or next; 1583 aio_read $fh, 0, 512, my $buf, 0 or next;
1073 $buf !~ /^password -------------$/m or next; # official not-valid tag 1584 $buf !~ /^password -------------$/m or next; # official not-valid tag
1585 }
1074 1586
1075 utf8::decode $login; 1587 utf8::decode $login;
1076 push @logins, $login; 1588 push @logins, $login;
1077 } 1589 }
1078 1590
1105 } 1617 }
1106 1618
1107 \@paths 1619 \@paths
1108} 1620}
1109 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
1110=item $player->ext_reply ($msgid, $msgtype, %msg) 1715=item $player->ext_reply ($msgid, @msg)
1111 1716
1112Sends an ext reply to the player. 1717Sends an ext reply to the player.
1113 1718
1114=cut 1719=cut
1115 1720
1116sub ext_reply($$$%) { 1721sub ext_reply($$@) {
1117 my ($self, $id, %msg) = @_; 1722 my ($self, $id, @msg) = @_;
1118 1723
1119 $msg{msgid} = $id; 1724 $self->ns->ext_reply ($id, @msg)
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122} 1725}
1123 1726
1124package 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}
1125 1767
1126=back 1768=back
1127
1128 1769
1129=head3 cf::map 1770=head3 cf::map
1130 1771
1131=over 4 1772=over 4
1132 1773
1144our $MAX_RESET = 3600; 1785our $MAX_RESET = 3600;
1145our $DEFAULT_RESET = 3000; 1786our $DEFAULT_RESET = 3000;
1146 1787
1147sub generate_random_map { 1788sub generate_random_map {
1148 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
1149 # mit "rum" bekleckern, nicht 1793 # mit "rum" bekleckern, nicht
1150 $self->_create_random_map ( 1794 $self->_create_random_map (
1151 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1795 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1796 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1797 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1187 my ($self, $merge) = @_; 1831 my ($self, $merge) = @_;
1188 1832
1189 # we have to keep some variables in memory intact 1833 # we have to keep some variables in memory intact
1190 local $self->{path}; 1834 local $self->{path};
1191 local $self->{load_path}; 1835 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194 1836
1195 $self->SUPER::thawer_merge ($merge); 1837 $self->SUPER::thawer_merge ($merge);
1196} 1838}
1197 1839
1198sub normalise { 1840sub normalise {
1245 $self->init; # pass $1 etc. 1887 $self->init; # pass $1 etc.
1246 return $self; 1888 return $self;
1247 } 1889 }
1248 } 1890 }
1249 1891
1250 Carp::carp "unable to resolve path '$path' (base '$base')."; 1892 Carp::cluck "unable to resolve path '$path' (base '$base').";
1251 () 1893 ()
1252} 1894}
1253 1895
1254sub init { 1896sub init {
1255 my ($self) = @_; 1897 my ($self) = @_;
1270 1912
1271# the original (read-only) location 1913# the original (read-only) location
1272sub load_path { 1914sub load_path {
1273 my ($self) = @_; 1915 my ($self) = @_;
1274 1916
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1917 "$MAPDIR/$self->{path}.map"
1276} 1918}
1277 1919
1278# the temporary/swap location 1920# the temporary/swap location
1279sub save_path { 1921sub save_path {
1280 my ($self) = @_; 1922 my ($self) = @_;
1281 1923
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1924 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1925 "$TMPDIR/$path.map"
1284} 1926}
1285 1927
1286# the unique path, undef == no special unique path 1928# the unique path, undef == no special unique path
1287sub uniq_path { 1929sub uniq_path {
1288 my ($self) = @_; 1930 my ($self) = @_;
1289 1931
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1932 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1933 "$UNIQUEDIR/$path"
1292} 1934}
1293 1935
1294# and all this just because we cannot iterate over 1936# and all this just because we cannot iterate over
1295# all maps in C++... 1937# all maps in C++...
1296sub change_all_map_light { 1938sub change_all_map_light {
1298 1940
1299 $_->change_map_light ($change) 1941 $_->change_map_light ($change)
1300 for grep $_->outdoor, values %cf::MAP; 1942 for grep $_->outdoor, values %cf::MAP;
1301} 1943}
1302 1944
1945sub decay_objects {
1946 my ($self) = @_;
1947
1948 return if $self->{deny_reset};
1949
1950 $self->do_decay_objects;
1951}
1952
1303sub unlink_save { 1953sub unlink_save {
1304 my ($self) = @_; 1954 my ($self) = @_;
1305 1955
1306 utf8::encode (my $save = $self->save_path); 1956 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1957 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1958 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310 #d#TODO remove .map and also nuke
1311 $save =~ s/\.map// or return;#d#
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314} 1959}
1315 1960
1316sub load_header_from($) { 1961sub load_header_from($) {
1317 my ($self, $path) = @_; 1962 my ($self, $path) = @_;
1318 1963
1319 utf8::encode $path; 1964 utf8::encode $path;
1320 #aio_open $path, O_RDONLY, 0 1965 my $f = new_from_file cf::object::thawer $path
1321 # or return;
1322
1323 $self->_load_header ($path)
1324 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;
1325 1973
1326 $self->{load_path} = $path; 1974 $self->{load_path} = $path;
1327 1975
1328 1 1976 1
1329} 1977}
1368 $self->load_header_orig 2016 $self->load_header_orig
1369 or return; 2017 or return;
1370 $self->prepare_orig; 2018 $self->prepare_orig;
1371 } 2019 }
1372 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
1373 1 2027 1
1374} 2028}
1375 2029
1376sub find; 2030sub find;
1377sub find { 2031sub find {
1378 my ($path, $origin) = @_; 2032 my ($path, $origin) = @_;
1379 2033
1380 $path = normalise $path, $origin && $origin->path; 2034 $path = normalise $path, $origin && $origin->path;
1381 2035
2036 cf::lock_wait "map_data:$path";#d#remove
1382 cf::lock_wait "map_find:$path"; 2037 cf::lock_wait "map_find:$path";
1383 2038
1384 $cf::MAP{$path} || do { 2039 $cf::MAP{$path} || do {
2040 my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1385 my $guard = cf::lock_acquire "map_find:$path"; 2041 my $guard2 = cf::lock_acquire "map_find:$path";
2042
1386 my $map = new_from_path cf::map $path 2043 my $map = new_from_path cf::map $path
1387 or return; 2044 or return;
1388 2045
1389 $map->{last_save} = $cf::RUNTIME; 2046 $map->{last_save} = $cf::RUNTIME;
1390 2047
1391 $map->load_header 2048 $map->load_header
1392 or return; 2049 or return;
1393 2050
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2051 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously 2052 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait; 2053 #$cf::WAIT_FOR_TICK->wait;
2054 undef $guard2;
2055 undef $guard1;
1397 $map->reset; 2056 $map->reset;
1398 undef $guard;
1399 return find $path; 2057 return find $path;
1400 } 2058 }
1401 2059
1402 $cf::MAP{$path} = $map 2060 $cf::MAP{$path} = $map
1403 } 2061 }
1410 my ($self) = @_; 2068 my ($self) = @_;
1411 2069
1412 local $self->{deny_reset} = 1; # loading can take a long time 2070 local $self->{deny_reset} = 1; # loading can take a long time
1413 2071
1414 my $path = $self->{path}; 2072 my $path = $self->{path};
2073
2074 {
1415 my $guard = cf::lock_acquire "map_load:$path"; 2075 my $guard = cf::lock_acquire "map_data:$path";
1416 2076
2077 return unless $self->valid;
1417 return if $self->in_memory != cf::MAP_SWAPPED; 2078 return unless $self->in_memory == cf::MAP_SWAPPED;
1418 2079
1419 $self->in_memory (cf::MAP_LOADING); 2080 $self->in_memory (cf::MAP_LOADING);
1420 2081
1421 $self->alloc; 2082 $self->alloc;
1422 2083
1423 $self->pre_load; 2084 $self->pre_load;
2085 cf::cede_to_tick;
1424 2086
1425 $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)
1426 or return; 2090 or return;
1427 2091
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2092 $self->post_load_original
1429 if delete $self->{load_original}; 2093 if delete $self->{load_original};
1430 2094
1431 if (my $uniq = $self->uniq_path) { 2095 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq; 2096 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) { 2097 unless (aio_stat $uniq) {
2098 if (my $f = new_from_file cf::object::thawer $uniq) {
1434 $self->clear_unique_items; 2099 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0); 2100 $self->_load_objects ($f);
2101 $f->resolve_delayed_derefs;
2102 }
1436 } 2103 }
1437 } 2104 }
1438 2105
1439 Coro::cede; 2106 $f->resolve_delayed_derefs;
1440 2107
2108 cf::cede_to_tick;
1441 # now do the right thing for maps 2109 # now do the right thing for maps
1442 $self->link_multipart_objects; 2110 $self->link_multipart_objects;
1443
1444 unless ($self->{deny_activate}) {
1445 $self->decay_objects;
1446 $self->fix_auto_apply;
1447 $self->update_buttons;
1448 Coro::cede;
1449 $self->set_darkness_map;
1450 $self->difficulty ($self->estimate_difficulty) 2111 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty; 2112 unless $self->difficulty;
1452 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;
1453 $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);
1454 } 2129 }
1455 2130
1456 $self->post_load; 2131 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459} 2132}
1460 2133
1461sub customise_for { 2134sub customise_for {
1462 my ($self, $ob) = @_; 2135 my ($self, $ob) = @_;
1463 2136
1464 return find "~" . $ob->name . "/" . $self->{path} 2137 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player; 2138 if $self->per_player;
1466 2139
2140# return find "?party/" . $ob->name . "/" . $self->{path}
2141# if $self->per_party;
2142
1467 $self 2143 $self
1468} 2144}
1469 2145
1470# 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
1471sub load_diag { 2147sub load_neighbours {
1472 my ($map) = @_; 2148 my ($map) = @_;
1473 2149
1474 my @diag; # diagonal neighbours 2150 my @neigh; # diagonal neighbours
1475 2151
1476 for (0 .. 3) { 2152 for (0 .. 3) {
1477 my $neigh = $map->tile_path ($_) 2153 my $neigh = $map->tile_path ($_)
1478 or next; 2154 or next;
1479 $neigh = find $neigh, $map 2155 $neigh = find $neigh, $map
1480 or next; 2156 or next;
1481 $neigh->load; 2157 $neigh->load;
1482 2158
2159 push @neigh,
1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2160 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2161 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 } 2162 }
1486 2163
1487 for (@diag) { 2164 for (grep defined $_->[0], @neigh) {
2165 my ($path, $origin) = @$_;
1488 my $neigh = find @$_ 2166 my $neigh = find $path, $origin
1489 or next; 2167 or next;
1490 $neigh->load; 2168 $neigh->load;
1491 } 2169 }
1492} 2170}
1493 2171
1498} 2176}
1499 2177
1500sub do_load_sync { 2178sub do_load_sync {
1501 my ($map) = @_; 2179 my ($map) = @_;
1502 2180
2181 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2182 if $Coro::current == $Coro::main;
2183
1503 cf::sync_job { $map->load }; 2184 cf::sync_job { $map->load };
1504} 2185}
1505 2186
1506our %MAP_PREFETCH; 2187our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef; 2188our $MAP_PREFETCHER = undef;
1508 2189
1509sub find_async { 2190sub find_async {
1510 my ($path, $origin) = @_; 2191 my ($path, $origin, $load) = @_;
1511 2192
1512 $path = normalise $path, $origin && $origin->{path}; 2193 $path = normalise $path, $origin && $origin->{path};
1513 2194
1514 if (my $map = $cf::MAP{$path}) { 2195 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2196 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1516 } 2197 }
1517 2198
1518 undef $MAP_PREFETCH{$path}; 2199 $MAP_PREFETCH{$path} |= $load;
2200
1519 $MAP_PREFETCHER ||= cf::async { 2201 $MAP_PREFETCHER ||= cf::async {
2202 $Coro::current->{desc} = "map prefetcher";
2203
1520 while (%MAP_PREFETCH) { 2204 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) { 2205 while (my ($k, $v) = each %MAP_PREFETCH) {
1522 my $map = find $path 2206 if (my $map = find $k) {
1523 or next;
1524 $map->load; 2207 $map->load if $v;
2208 }
1525 2209
1526 delete $MAP_PREFETCH{$path}; 2210 delete $MAP_PREFETCH{$k};
1527 } 2211 }
1528 } 2212 }
1529 undef $MAP_PREFETCHER; 2213 undef $MAP_PREFETCHER;
1530 }; 2214 };
1531 $MAP_PREFETCHER->prio (6); 2215 $MAP_PREFETCHER->prio (6);
1534} 2218}
1535 2219
1536sub save { 2220sub save {
1537 my ($self) = @_; 2221 my ($self) = @_;
1538 2222
1539 my $lock = cf::lock_acquire "map_data:" . $self->path; 2223 my $lock = cf::lock_acquire "map_data:$self->{path}";
1540 2224
1541 $self->{last_save} = $cf::RUNTIME; 2225 $self->{last_save} = $cf::RUNTIME;
1542 2226
1543 return unless $self->dirty; 2227 return unless $self->dirty;
1544 2228
1550 return if $self->{deny_save}; 2234 return if $self->{deny_save};
1551 2235
1552 local $self->{last_access} = $self->last_access;#d# 2236 local $self->{last_access} = $self->last_access;#d#
1553 2237
1554 cf::async { 2238 cf::async {
2239 $Coro::current->{desc} = "map player save";
1555 $_->contr->save for $self->players; 2240 $_->contr->save for $self->players;
1556 }; 2241 };
2242
2243 cf::get_slot 0.02;
1557 2244
1558 if ($uniq) { 2245 if ($uniq) {
1559 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2246 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1560 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2247 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1561 } else { 2248 } else {
1567 my ($self) = @_; 2254 my ($self) = @_;
1568 2255
1569 # save first because save cedes 2256 # save first because save cedes
1570 $self->save; 2257 $self->save;
1571 2258
1572 my $lock = cf::lock_acquire "map_data:" . $self->path; 2259 my $lock = cf::lock_acquire "map_data:$self->{path}";
1573 2260
1574 return if $self->players; 2261 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY; 2262 return if $self->in_memory != cf::MAP_ACTIVE;
1576 return if $self->{deny_save}; 2263 return if $self->{deny_save};
1577 2264
2265 $self->in_memory (cf::MAP_SWAPPED);
2266
2267 $self->deactivate;
2268 $_->clear_links_to ($self) for values %cf::MAP;
1578 $self->clear; 2269 $self->clear;
1579 $self->in_memory (cf::MAP_SWAPPED);
1580} 2270}
1581 2271
1582sub reset_at { 2272sub reset_at {
1583 my ($self) = @_; 2273 my ($self) = @_;
1584 2274
1585 # TODO: safety, remove and allow resettable per-player maps 2275 # TODO: safety, remove and allow resettable per-player maps
1586 return 1e99 if $self->isa ("ext::map_per_player");#d#
1587 return 1e99 if $self->{deny_reset}; 2276 return 1e99 if $self->{deny_reset};
1588 2277
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2278 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 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;
1591 2280
1602 my ($self) = @_; 2291 my ($self) = @_;
1603 2292
1604 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2293 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605 2294
1606 return if $self->players; 2295 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608 2296
1609 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 }
1610 2308
1611 delete $cf::MAP{$self->path}; 2309 delete $cf::MAP{$self->path};
1612 2310
1613 $self->in_memory (cf::MAP_SWAPPED); 2311 $self->deactivate;
2312 $_->clear_links_to ($self) for values %cf::MAP;
1614 $self->clear; 2313 $self->clear;
1615
1616 $_->clear_links_to ($self) for values %cf::MAP;
1617 2314
1618 $self->unlink_save; 2315 $self->unlink_save;
1619 $self->destroy; 2316 $self->destroy;
1620} 2317}
1621 2318
1622my $nuke_counter = "aaaa"; 2319my $nuke_counter = "aaaa";
1623 2320
1624sub nuke { 2321sub nuke {
1625 my ($self) = @_; 2322 my ($self) = @_;
1626 2323
2324 {
2325 my $lock = cf::lock_acquire "map_data:$self->{path}";
2326
1627 delete $cf::MAP{$self->path}; 2327 delete $cf::MAP{$self->path};
1628 2328
1629 $self->unlink_save; 2329 $self->unlink_save;
1630 2330
1631 bless $self, "cf::map"; 2331 bless $self, "cf::map";
1632 delete $self->{deny_reset}; 2332 delete $self->{deny_reset};
1633 $self->{deny_save} = 1; 2333 $self->{deny_save} = 1;
1634 $self->reset_timeout (1); 2334 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2335 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636 2336
1637 $cf::MAP{$self->path} = $self; 2337 $cf::MAP{$self->path} = $self;
2338 }
1638 2339
1639 $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 ]
1640} 2377}
1641 2378
1642=item cf::map::unique_maps 2379=item cf::map::unique_maps
1643 2380
1644Returns an arrayref of paths of all shared maps that have 2381Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block. 2382instantiated unique items. May block.
1646 2383
1647=cut 2384=cut
1648 2385
1649sub unique_maps() { 2386sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2387 [
1651 or return; 2388 map {
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_; 2389 utf8::decode $_;
1657 next if /\.pst$/; 2390 s/\.map$//; # TODO future compatibility hack
1658 next unless /^$PATH_SEP/o; 2391 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1659 2392 ? ()
1660 push @paths, cf::map::normalise $_; 2393 : normalise $_
2394 } @{ aio_readdir $UNIQUEDIR or [] }
1661 } 2395 ]
1662
1663 \@paths
1664} 2396}
1665
1666package cf;
1667 2397
1668=back 2398=back
1669 2399
1670=head3 cf::object 2400=head3 cf::object
1671 2401
1675 2405
1676=over 4 2406=over 4
1677 2407
1678=item $ob->inv_recursive 2408=item $ob->inv_recursive
1679 2409
1680Returns 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.
1681 2412
1682=cut 2413=cut
1683 2414
1684sub inv_recursive_; 2415sub inv_recursive_;
1685sub inv_recursive_ { 2416sub inv_recursive_ {
1688 2419
1689sub inv_recursive { 2420sub inv_recursive {
1690 inv_recursive_ inv $_[0] 2421 inv_recursive_ inv $_[0]
1691} 2422}
1692 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
1693package cf; 2452package cf;
1694 2453
1695=back 2454=back
1696 2455
1697=head3 cf::object::player 2456=head3 cf::object::player
1703Sends 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>
1704can 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
1705dialogue with the given NPC character. 2464dialogue with the given NPC character.
1706 2465
1707=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};
1708 2481
1709# rough implementation of a future "reply" method that works 2482# rough implementation of a future "reply" method that works
1710# with dialog boxes. 2483# with dialog boxes.
1711#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
1712sub cf::object::player::reply($$$;$) { 2485sub cf::object::player::reply($$$;$) {
1714 2487
1715 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2488 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716 2489
1717 if ($self->{record_replies}) { 2490 if ($self->{record_replies}) {
1718 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2491 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2492
1719 } 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 {
1720 $msg = $npc->name . " says: $msg" if $npc; 2501 $msg = $npc->name . " says: $msg" if $npc;
1721 $self->message ($msg, $flags); 2502 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2503 }
1722 } 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 (@_);
1723} 2515}
1724 2516
1725=item $player_object->may ("access") 2517=item $player_object->may ("access")
1726 2518
1727Returns wether the given player is authorized to access resource "access" 2519Returns wether the given player is authorized to access resource "access"
1774 $self->deactivate_recursive; 2566 $self->deactivate_recursive;
1775 2567
1776 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2568 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777 2569
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2570 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map; 2571 if $self->map && $self->map->{path} ne "{link}";
1780 2572
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2573 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1782} 2574}
1783 2575
1784sub cf::object::player::leave_link { 2576sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_; 2577 my ($self, $map, $x, $y) = @_;
2578
2579 return unless $self->contr->active;
1786 2580
1787 my $link_pos = delete $self->{_link_pos}; 2581 my $link_pos = delete $self->{_link_pos};
1788 2582
1789 unless ($map) { 2583 unless ($map) {
1790 # restore original map position 2584 # restore original map position
1804 # use -1 or undef as default coordinates, not 0, 0 2598 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y) 2599 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0; 2600 if $x <=0 && $y <= 0;
1807 2601
1808 $map->load; 2602 $map->load;
1809 $map->load_diag; 2603 $map->load_neighbours;
1810 2604
1811 return unless $self->contr->active; 2605 return unless $self->contr->active;
1812 $self->activate_recursive; 2606 $self->activate_recursive;
2607
2608 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2609 $self->enter_map ($map, $x, $y);
1814} 2610}
1815 2611
1816cf::player->attach ( 2612=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817 on_logout => sub {
1818 my ($pl) = @_;
1819 2613
1820 # abort map switching before logout 2614Moves the player to the given map-path and coordinates by first freezing
1821 if ($pl->ob->{_link_pos}) { 2615her, loading and preparing them map, calling the provided $check callback
1822 cf::sync_job { 2616that has to return the map if sucecssful, and then unfreezes the player on
1823 $pl->ob->leave_link 2617the new (success) or old (failed) map position. In either case, $done will
1824 }; 2618be called at the end of this process.
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2619
1830 # try to abort aborted map switching on player login :) 2620Note that $check will be called with a potentially non-loaded map, so if
1831 # should happen only on crashes 2621it needs a loaded map it has to call C<< ->load >>.
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 # we need this sleep as the login has a concurrent enter_exit running
1836 # and this sleep increases chances of the player not ending up in scorn
1837 $pl->ob->reply (undef,
1838 "There was an internal problem at your last logout, "
1839 . "the server will try to bring you to your intended destination in a second.",
1840 cf::NDI_RED);
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847 2622
1848=item $player_object->goto ($path, $x, $y)
1849
1850=cut 2623=cut
2624
2625our $GOTOGEN;
1851 2626
1852sub cf::object::player::goto { 2627sub cf::object::player::goto {
1853 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;
1854 2632
1855 $self->enter_link; 2633 $self->enter_link;
1856 2634
1857 (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
1858 my $map = eval { 2657 my $map = eval {
1859 my $map = cf::map::find $path; 2658 my $map = defined $path ? cf::map::find $path : undef;
2659
2660 if ($map) {
1860 $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
1861 $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 $@;
1862 } or 2673 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2674
2675 if ($gen == $self->{_goto_generation}) {
2676 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2677 $self->leave_link ($map, $x, $y);
2678 }
2679
2680 $done->() if $done;
1866 })->prio (1); 2681 })->prio (1);
1867} 2682}
1868 2683
1869=item $player_object->enter_exit ($exit_object) 2684=item $player_object->enter_exit ($exit_object)
1870 2685
1890} 2705}
1891 2706
1892sub prepare_random_map { 2707sub prepare_random_map {
1893 my ($exit) = @_; 2708 my ($exit) = @_;
1894 2709
1895 my $guard = cf::lock_acquire "exit_prepare:$exit";
1896
1897 # all this does is basically replace the /! path by 2710 # all this does is basically replace the /! path by
1898 # a new random map path (?random/...) with a seed 2711 # a new random map path (?random/...) with a seed
1899 # that depends on the exit object 2712 # that depends on the exit object
1900 2713
1901 my $rmp = parse_random_map_params $exit->msg; 2714 my $rmp = parse_random_map_params $exit->msg;
1903 if ($exit->map) { 2716 if ($exit->map) {
1904 $rmp->{region} = $exit->region->name; 2717 $rmp->{region} = $exit->region->name;
1905 $rmp->{origin_map} = $exit->map->path; 2718 $rmp->{origin_map} = $exit->map->path;
1906 $rmp->{origin_x} = $exit->x; 2719 $rmp->{origin_x} = $exit->x;
1907 $rmp->{origin_y} = $exit->y; 2720 $rmp->{origin_y} = $exit->y;
2721
2722 $exit->map->touch;
1908 } 2723 }
1909 2724
1910 $rmp->{random_seed} ||= $exit->random_seed; 2725 $rmp->{random_seed} ||= $exit->random_seed;
1911 2726
1912 my $data = cf::to_json $rmp; 2727 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1913 my $md5 = Digest::MD5::md5_hex $data; 2728 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2729 my $meta = "$RANDOMDIR/$md5.meta";
1915 2730
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2731 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2732 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2733 undef $fh;
1919 aio_rename "$meta~", $meta; 2734 aio_rename "$meta~", $meta;
1920 2735
2736 my $slaying = "?random/$md5";
2737
2738 if ($exit->valid) {
1921 $exit->slaying ("?random/$md5"); 2739 $exit->slaying ("?random/$md5");
1922 $exit->msg (undef); 2740 $exit->msg (undef);
2741 }
1923 } 2742 }
1924} 2743}
1925 2744
1926sub cf::object::player::enter_exit { 2745sub cf::object::player::enter_exit {
1927 my ($self, $exit) = @_; 2746 my ($self, $exit) = @_;
1928 2747
1929 return unless $self->type == cf::PLAYER; 2748 return unless $self->type == cf::PLAYER;
1930 2749
1931 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job
1933 cf::sync_job { prepare_random_map $exit };
1934 }
1935
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp;
1939
1940 $self->enter_link; 2750 $self->enter_link;
1941 2751
1942 (async { 2752 (async {
1943 $self->deactivate_recursive; # just to be sure 2753 $Coro::current->{desc} = "enter_exit";
2754
1944 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
1945 $self->goto ($slaying, $hp, $sp); 2770 $self->goto ($map, $x, $y);
1946 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
1947 1; 2776 1
1948 }) { 2777 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2778 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "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. "
1951 . "Please report this to the dungeon master!", 2780 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2781 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2782
1954 warn "ERROR in enter_exit: $@"; 2783 warn "ERROR in enter_exit: $@";
1955 $self->leave_link; 2784 $self->leave_link;
1956 } 2785 }
1957 })->prio (1); 2786 })->prio (1);
1970 2799
1971sub cf::client::send_drawinfo { 2800sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2801 my ($self, $text, $flags) = @_;
1973 2802
1974 utf8::encode $text; 2803 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2804 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2805}
1977 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}
1978 2971
1979=item $success = $client->query ($flags, "text", \&cb) 2972=item $success = $client->query ($flags, "text", \&cb)
1980 2973
1981Queues a query to the client, calling the given callback with 2974Queues a query to the client, calling the given callback with
1982the 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>,
1983C<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>.
1984 2977
1985Queries 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
1986reliable at some point in the future. 2979become reliable at some point in the future.
1987 2980
1988=cut 2981=cut
1989 2982
1990sub cf::client::query { 2983sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 2984 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 2992 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2993 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 2994
2002 $self->send_packet ($self->{query_queue}[0][0]) 2995 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 2996 if @{ $self->{query_queue} } == 1;
2997
2998 1
2004} 2999}
2005 3000
2006cf::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 },
2007 on_reply => sub { 3007 on_reply => sub {
2008 my ($ns, $msg) = @_; 3008 my ($ns, $msg) = @_;
2009 3009
2010 # this weird shuffling is so that direct followup queries 3010 # this weird shuffling is so that direct followup queries
2011 # get handled first 3011 # get handled first
2023 } else { 3023 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 3025 }
2026 } 3026 }
2027 }, 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 },
2028); 3054);
2029 3055
2030=item $client->async (\&cb) 3056=item $client->async (\&cb)
2031 3057
2032Create a new coroutine, running the specified callback. The coroutine will 3058Create a new coroutine, running the specified callback. The coroutine will
2073our $safe = new Safe "safe"; 3099our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 3100our $safe_hole = new Safe::Hole;
2075 3101
2076$SIG{FPE} = 'IGNORE'; 3102$SIG{FPE} = 'IGNORE';
2077 3103
2078$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));
2079 3109
2080# here we export the classes and methods available to script code 3110# here we export the classes and methods available to script code
2081 3111
2082=pod 3112=pod
2083 3113
2084The following fucntions and emthods are available within a safe environment: 3114The following functions and methods are available within a safe environment:
2085 3115
2086 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
2087 cf::object::player player 3120 cf::object::player
2088 cf::player peaceful 3121 player
2089 cf::map trigger 3122
3123 cf::player
3124 peaceful
3125
3126 cf::map
3127 trigger
2090 3128
2091=cut 3129=cut
2092 3130
2093for ( 3131for (
2094 ["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)],
2095 ["cf::object::player" => qw(player)], 3135 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 3136 ["cf::player" => qw(peaceful)],
2097 ["cf::map" => qw(trigger)], 3137 ["cf::map" => qw(trigger)],
2098) { 3138) {
2099 no strict 'refs'; 3139 no strict 'refs';
2170=back 3210=back
2171 3211
2172=cut 3212=cut
2173 3213
2174############################################################################# 3214#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $hashref = cf::db_get $family
2188
2189Return a hashref for use by the extension C<$family>, which can be
2190modified. After modifications, you have to call C<cf::db_dirty> or
2191C<cf::db_sync>.
2192
2193=item $value = cf::db_get $family => $key
2194
2195Returns a single value from the database
2196
2197=item cf::db_put $family => $hashref
2198
2199Stores the given family hashref into the database. Updates are delayed, if
2200you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202=item cf::db_put $family => $key => $value
2203
2204Stores the given C<$value> in the family hash. Updates are delayed, if you
2205want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207=item cf::db_dirty
2208
2209Marks the database as dirty, to be updated at a later time.
2210
2211=item cf::db_sync
2212
2213Immediately write the database to disk I<if it is dirty>.
2214
2215=cut
2216
2217our $DB;
2218
2219{
2220 my $path = cf::localdir . "/database.pst";
2221
2222 sub db_load() {
2223 $DB = stat $path ? Storable::retrieve $path : { };
2224 }
2225
2226 my $pid;
2227
2228 sub db_save() {
2229 waitpid $pid, 0 if $pid;
2230 if (0 == ($pid = fork)) {
2231 $DB->{_meta}{version} = 1;
2232 Storable::nstore $DB, "$path~";
2233 rename "$path~", $path;
2234 cf::_exit 0 if defined $pid;
2235 }
2236 }
2237
2238 my $dirty;
2239
2240 sub db_sync() {
2241 db_save if $dirty;
2242 undef $dirty;
2243 }
2244
2245 my $idle = Event->idle (
2246 reentrant => 0,
2247 min => 10,
2248 max => 20,
2249 repeat => 0,
2250 data => WF_AUTOCANCEL,
2251 cb => \&db_sync,
2252 );
2253
2254 sub db_dirty() {
2255 $dirty = 1;
2256 $idle->start;
2257 }
2258
2259 sub db_get($;$) {
2260 @_ >= 2
2261 ? $DB->{$_[0]}{$_[1]}
2262 : ($DB->{$_[0]} ||= { })
2263 }
2264
2265 sub db_put($$;$) {
2266 if (@_ >= 3) {
2267 $DB->{$_[0]}{$_[1]} = $_[2];
2268 } else {
2269 $DB->{$_[0]} = $_[1];
2270 }
2271 db_dirty;
2272 }
2273
2274 cf::global->attach (
2275 prio => 10000,
2276 on_cleanup => sub {
2277 db_sync;
2278 },
2279 );
2280}
2281
2282#############################################################################
2283# the server's init and main functions 3215# the server's init and main functions
2284 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
2285sub load_resources { 3352sub load_resource_file($) {
2286 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"
2287 or die "unable to load regions file\n";#d# 3368 or die "unable to load regions file\n";
2288}
2289 3369
2290sub 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 {
2291 open my $fh, "<:utf8", cf::confdir . "/config" 3411 open my $fh, "<:utf8", "$CONFDIR/config"
2292 or return; 3412 or return;
2293 3413
2294 local $/; 3414 local $/;
2295 *CFG = YAML::Syck::Load <$fh>; 3415 *CFG = YAML::Load <$fh>;
2296 3416
2297 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3417 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2298 3418
2299 $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};
2300 $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};
2306 }; 3426 };
2307 warn $@ if $@; 3427 warn $@ if $@;
2308 } 3428 }
2309} 3429}
2310 3430
2311sub init {
2312 load_resources;
2313}
2314
2315sub main { 3431sub main {
2316 # we must not ever block the main coroutine 3432 # we must not ever block the main coroutine
2317 local $Coro::idle = sub { 3433 local $Coro::idle = sub {
2318 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#
2319 (async { 3435 (async {
2320 Event::one_event; 3436 $Coro::current->{desc} = "IDLE BUG HANDLER";
3437 EV::loop EV::LOOP_ONESHOT;
2321 })->prio (Coro::PRIO_MAX); 3438 })->prio (Coro::PRIO_MAX);
2322 }; 3439 };
2323 3440
2324 cfg_load; 3441 {
2325 db_load; 3442 my $guard = freeze_mainloop;
3443 reload_config;
3444 db_init;
2326 load_extensions; 3445 load_extensions;
2327 3446
2328 $TICK_WATCHER->start; 3447 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3448 }
3449
2329 Event::loop; 3450 EV::loop;
2330} 3451}
2331 3452
2332############################################################################# 3453#############################################################################
2333# initialisation and cleanup 3454# initialisation and cleanup
2334 3455
2335# install some emergency cleanup handlers 3456# install some emergency cleanup handlers
2336BEGIN { 3457BEGIN {
3458 our %SIGWATCHER = ();
2337 for my $signal (qw(INT HUP TERM)) { 3459 for my $signal (qw(INT HUP TERM)) {
2338 Event->signal ( 3460 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2339 reentrant => 0,
2340 data => WF_AUTOCANCEL,
2341 signal => $signal,
2342 prio => 0,
2343 cb => sub {
2344 cf::cleanup "SIG$signal"; 3461 cf::cleanup "SIG$signal";
2345 },
2346 ); 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
2347 } 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 };
2348} 3545}
2349 3546
2350sub emergency_save() { 3547sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop; 3548 my $freeze_guard = cf::freeze_mainloop;
2352 3549
2358 # and maps saved/destroyed asynchronously. 3555 # and maps saved/destroyed asynchronously.
2359 warn "begin emergency player save\n"; 3556 warn "begin emergency player save\n";
2360 for my $login (keys %cf::PLAYER) { 3557 for my $login (keys %cf::PLAYER) {
2361 my $pl = $cf::PLAYER{$login} or next; 3558 my $pl = $cf::PLAYER{$login} or next;
2362 $pl->valid or next; 3559 $pl->valid or next;
3560 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2363 $pl->save; 3561 $pl->save;
2364 } 3562 }
2365 warn "end emergency player save\n"; 3563 warn "end emergency player save\n";
2366 3564
2367 warn "begin emergency map save\n"; 3565 warn "begin emergency map save\n";
2369 my $map = $cf::MAP{$path} or next; 3567 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next; 3568 $map->valid or next;
2371 $map->save; 3569 $map->save;
2372 } 3570 }
2373 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";
2374 }; 3580 };
2375 3581
2376 warn "leave emergency perl save\n"; 3582 warn "leave emergency perl save\n";
2377} 3583}
2378 3584
3585sub post_cleanup {
3586 my ($make_core) = @_;
3587
3588 warn Carp::longmess "post_cleanup backtrace"
3589 if $make_core;
3590}
3591
2379sub reload() { 3592sub do_reload_perl() {
2380 # can/must only be called in main 3593 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) { 3594 if ($Coro::current != $Coro::main) {
2382 warn "can only reload from main coroutine"; 3595 warn "can only reload from main coroutine";
2383 return; 3596 return;
2384 } 3597 }
2385 3598
2386 warn "reloading..."; 3599 warn "reloading...";
2387 3600
2388 warn "cancelling server ticker"; 3601 warn "entering sync_job";
2389 $TICK_WATCHER->cancel;
2390 3602
3603 cf::sync_job {
3604 cf::write_runtime_sync; # external watchdog should not bark
2391 cf::emergency_save; 3605 cf::emergency_save;
3606 cf::write_runtime_sync; # external watchdog should not bark
2392 3607
2393 eval { 3608 warn "syncing database to disk";
3609 BDB::db_env_txn_checkpoint $DB_ENV;
3610
2394 # 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
2395
2396 warn "syncing database to disk";
2397 cf::db_sync;
2398
2399 warn "cancelling all WF_AUTOCANCEL watchers";
2400 for (Event::all_watchers) {
2401 $_->cancel if $_->data & WF_AUTOCANCEL;
2402 }
2403 3612
2404 warn "flushing outstanding aio requests"; 3613 warn "flushing outstanding aio requests";
2405 for (;;) { 3614 for (;;) {
3615 BDB::flush;
2406 IO::AIO::flush; 3616 IO::AIO::flush;
2407 Coro::cede; 3617 Coro::cede_notself;
2408 last unless IO::AIO::nreqs; 3618 last unless IO::AIO::nreqs || BDB::nreqs;
2409 warn "iterate..."; 3619 warn "iterate...";
2410 } 3620 }
3621
3622 ++$RELOAD;
2411 3623
2412 warn "cancelling all extension coros"; 3624 warn "cancelling all extension coros";
2413 $_->cancel for values %EXT_CORO; 3625 $_->cancel for values %EXT_CORO;
2414 %EXT_CORO = (); 3626 %EXT_CORO = ();
2415 3627
2416 warn "removing commands"; 3628 warn "removing commands";
2417 %COMMAND = (); 3629 %COMMAND = ();
2418 3630
2419 warn "removing ext commands"; 3631 warn "removing ext/exti commands";
2420 %EXTCMD = (); 3632 %EXTCMD = ();
3633 %EXTICMD = ();
2421 3634
2422 warn "unloading/nuking all extensions"; 3635 warn "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) { 3636 for my $pkg (@EXTS) {
2424 warn "... unloading $pkg"; 3637 warn "... unloading $pkg";
2425 3638
2455 Symbol::delete_package "safe::$_" 3668 Symbol::delete_package "safe::$_"
2456 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);
2457 3670
2458 warn "unloading cf.pm \"a bit\""; 3671 warn "unloading cf.pm \"a bit\"";
2459 delete $INC{"cf.pm"}; 3672 delete $INC{"cf.pm"};
3673 delete $INC{"cf/pod.pm"};
2460 3674
2461 # don't, removes xs symbols, too, 3675 # don't, removes xs symbols, too,
2462 # and global variables created in xs 3676 # and global variables created in xs
2463 #Symbol::delete_package __PACKAGE__; 3677 #Symbol::delete_package __PACKAGE__;
2464 3678
2467 warn "reloading cf.pm"; 3681 warn "reloading cf.pm";
2468 require cf; 3682 require cf;
2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3683 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470 3684
2471 warn "loading config and database again"; 3685 warn "loading config and database again";
2472 cf::cfg_load; 3686 cf::reload_config;
2473 cf::db_load;
2474 3687
2475 warn "loading extensions"; 3688 warn "loading extensions";
2476 cf::load_extensions; 3689 cf::load_extensions;
2477 3690
2478 warn "reattaching attachments to objects/players"; 3691 warn "reattaching attachments to objects/players";
2479 _global_reattach; 3692 _global_reattach; # objects, sockets
2480 warn "reattaching attachments to maps"; 3693 warn "reattaching attachments to maps";
2481 reattach $_ for values %MAP; 3694 reattach $_ for values %MAP;
3695 warn "reattaching attachments to players";
3696 reattach $_ for values %PLAYER;
2482 3697
2483 warn "loading reloadable resources"; 3698 warn "leaving sync_job";
2484 load_resources;
2485 3699
2486 warn "restarting server ticker"; 3700 1
2487 3701 } or do {
2488 $TICK_WATCHER->start; 3702 warn $@;
3703 cf::cleanup "error while reloading, exiting.";
2489 }; 3704 };
2490
2491 if ($@) {
2492 warn $@;
2493 warn "error while reloading, exiting.";
2494 exit 1;
2495 }
2496 3705
2497 warn "reloaded"; 3706 warn "reloaded";
2498}; 3707};
2499 3708
2500our $RELOAD_WATCHER; # used only during reload 3709our $RELOAD_WATCHER; # used only during reload
2501 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
2502register_command "reload" => sub { 3721register_command "reload" => sub {
2503 my ($who, $arg) = @_; 3722 my ($who, $arg) = @_;
2504 3723
2505 if ($who->flag (FLAG_WIZ)) { 3724 if ($who->flag (FLAG_WIZ)) {
2506 $who->message ("reloading server."); 3725 $who->message ("reloading server.");
2507 3726 async {
2508 # doing reload synchronously and two reloads happen back-to-back, 3727 $Coro::current->{desc} = "perl_reload";
2509 # coro crashes during coro_state_free->destroy here.
2510
2511 $RELOAD_WATCHER ||= Event->timer (
2512 reentrant => 0,
2513 after => 0,
2514 data => WF_AUTOCANCEL,
2515 cb => sub {
2516 reload; 3728 reload_perl;
2517 undef $RELOAD_WATCHER;
2518 },
2519 ); 3729 };
2520 } 3730 }
2521}; 3731};
2522 3732
2523unshift @INC, $LIBDIR; 3733unshift @INC, $LIBDIR;
2524 3734
2525my $bug_warning = 0; 3735my $bug_warning = 0;
2526 3736
2527$TICK_WATCHER = Event->timer ( 3737our @WAIT_FOR_TICK;
2528 reentrant => 0, 3738our @WAIT_FOR_TICK_BEGIN;
2529 parked => 1, 3739
2530 prio => 0, 3740sub wait_for_tick {
2531 at => $NEXT_TICK || $TICK, 3741 return if tick_inhibit || $Coro::current == $Coro::main;
2532 data => WF_AUTOCANCEL, 3742
2533 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 {
2534 if ($Coro::current != $Coro::main) { 3757 if ($Coro::current != $Coro::main) {
2535 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"
2536 unless ++$bug_warning > 10; 3759 unless ++$bug_warning > 10;
2537 return; 3760 return;
2538 } 3761 }
2539 3762
2540 $NOW = Event::time;
2541
2542 cf::server_tick; # one server iteration 3763 cf::server_tick; # one server iteration
2543 $RUNTIME += $TICK;
2544 $NEXT_TICK += $TICK;
2545 3764
2546 $WAIT_FOR_TICK->broadcast; 3765 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3766 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
3767 Coro::async_pool {
3768 $Coro::current->{desc} = "runtime saver";
3769 write_runtime_sync
3770 or warn "ERROR: unable to write runtime file: $!";
3771 };
3772 }
2548 3773
2549 Event::sweep; 3774 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2550 Coro::cede_notself; 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#
2551 3789 }
2552# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d#
2554
2555 # if we are delayed by four ticks or more, skip them all
2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2557
2558 $TICK_WATCHER->at ($NEXT_TICK);
2559 $TICK_WATCHER->start;
2560 }, 3790 }
2561); 3791}
2562 3792
2563{ 3793{
2564 BDB::max_poll_time $TICK * 0.1; 3794 # configure BDB
2565 $BDB_POLL_WATCHER = Event->io ( 3795
2566 reentrant => 0,
2567 fd => BDB::poll_fileno,
2568 poll => 'r',
2569 prio => 0,
2570 data => WF_AUTOCANCEL,
2571 cb => \&BDB::poll_cb,
2572 );
2573 BDB::min_parallel 8; 3796 BDB::min_parallel 8;
2574 3797 BDB::max_poll_reqs $TICK * 0.1;
2575 BDB::set_sync_prepare { 3798 $AnyEvent::BDB::WATCHER->priority (1);
2576 my $status;
2577 my $current = $Coro::current;
2578 (
2579 sub {
2580 $status = $!;
2581 $current->ready; undef $current;
2582 },
2583 sub {
2584 Coro::schedule while defined $current;
2585 $! = $status;
2586 },
2587 )
2588 };
2589 3799
2590 unless ($DB_ENV) { 3800 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create; 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);
2592 3807
2593 cf::sync_job { 3808 cf::sync_job {
3809 eval {
2594 BDB::db_env_open 3810 BDB::db_env_open
2595 $DB_ENV, 3811 $DB_ENV,
2596 $BDB_ENV_DIR, 3812 $BDBDIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3813 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3814 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666; 3815 0666;
2600 3816
2601 cf::cleanup "$!" if $!; 3817 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602 3818 };
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3819
2604 $DB_ENV->set_lk_detect; 3820 cf::cleanup "db_env_open(db): $@" if $@;
2605 }; 3821 };
2606 } 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 };
2607} 3833}
2608 3834
2609{ 3835{
3836 # configure IO::AIO
3837
2610 IO::AIO::min_parallel 8; 3838 IO::AIO::min_parallel 8;
2611
2612 undef $Coro::AIO::WATCHER;
2613 IO::AIO::max_poll_time $TICK * 0.1; 3839 IO::AIO::max_poll_time $TICK * 0.1;
2614 $AIO_POLL_WATCHER = Event->io ( 3840 undef $AnyEvent::AIO::WATCHER;
2615 reentrant => 0,
2616 fd => IO::AIO::poll_fileno,
2617 poll => 'r',
2618 prio => 6,
2619 data => WF_AUTOCANCEL,
2620 cb => \&IO::AIO::poll_cb,
2621 );
2622} 3841}
2623 3842
2624$WRITE_RUNTIME_WATCHER = Event->timer ( 3843my $_log_backtrace;
2625 reentrant => 0, 3844
2626 data => WF_AUTOCANCEL, 3845sub _log_backtrace {
2627 after => 1, 3846 my ($msg, @addr) = @_;
2628 interval => 10, 3847
2629 prio => 6, # keep it lowest so it acts like a watchdog 3848 $msg =~ s/\n//;
2630 cb => Coro::unblock_sub { 3849
2631 write_runtime 3850 # limit the # of concurrent backtraces
2632 or warn "ERROR: unable to write runtime file: $!"; 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";
2633 }, 3880 }
2634); 3881}
3882
3883# load additional modules
3884use cf::pod;
2635 3885
2636END { cf::emergency_save } 3886END { cf::emergency_save }
2637 3887
26381 38881
2639 3889

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines