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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines