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.142 by root, Fri Jan 5 21:51:42 2007 UTC vs.
Revision 1.498 by elmex, Tue Jan 5 16:16:37 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines