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.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.528 by root, Fri Apr 23 04:42:12 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines