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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines