ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines