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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines