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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines