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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines