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.140 by root, Fri Jan 5 20:04:02 2007 UTC vs.
Revision 1.528 by root, Fri Apr 23 04:42:12 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines