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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.499 by root, Sun Jan 10 17:43:46 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 (2); # run main coroutine ("the server") with very high priority 72$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
73
74# make sure c-lzf reinitialises itself
75Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
76Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
77
78# strictly for debugging
79$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
32 80
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 81sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 82
35our %COMMAND = (); 83our %COMMAND = ();
36our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
85
86our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
89our %EXT_CORO = (); # coroutines bound to extensions
90our %EXT_MAP = (); # pluggable maps
38 91
92our $RELOAD; # number of reloads so far, non-zero while in reload
39our @EVENT; 93our @EVENT;
40our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
41 96
42our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
43our $TICK_WATCHER; 98our $DATADIR = datadir;
99our $LIBDIR = "$DATADIR/ext";
100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE;
112
113our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
114our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 115our $NEXT_TICK;
45our $NOW; 116our $USE_FSYNC = 1; # use fsync to write maps - default on
117
118our $BDB_DEADLOCK_WATCHER;
119our $BDB_CHECKPOINT_WATCHER;
120our $BDB_TRICKLE_WATCHER;
121our $DB_ENV;
122
123our @EXTRA_MODULES = qw(pod match mapscript);
46 124
47our %CFG; 125our %CFG;
48 126
49our $UPTIME; $UPTIME ||= time; 127our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 128our $RUNTIME;
129our $NOW;
51 130
52our %MAP; # all maps 131our (%PLAYER, %PLAYER_LOADING); # all users
53our $LINK_MAP; # the special {link} map 132our (%MAP, %MAP_LOADING ); # all maps
54our $FREEZE; 133our $LINK_MAP; # the special {link} map, which is always available
55our $RANDOM_MAPS = cf::localdir . "/random"; 134
56our %EXT_CORO; 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 :)
57 147
58binmode STDOUT; 148binmode STDOUT;
59binmode STDERR; 149binmode STDERR;
60 150
61# read virtual server time, if available 151# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 152unless ($RUNTIME || !-e $RUNTIMEFILE) {
63 open my $fh, "<", cf::localdir . "/runtime" 153 open my $fh, "<", $RUNTIMEFILE
64 or die "unable to read runtime file: $!"; 154 or die "unable to read $RUNTIMEFILE file: $!";
65 $RUNTIME = <$fh> + 0.; 155 $RUNTIME = <$fh> + 0.;
66} 156}
67 157
68mkdir cf::localdir; 158eval "sub TICK() { $TICK } 1" or die;
69mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 159
74# a special map that is always available 160mkdir $_
75our $LINK_MAP; 161 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
76 162
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 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::"} };
78 177
79############################################################################# 178#############################################################################
80 179
81=head2 GLOBAL VARIABLES 180=head2 GLOBAL VARIABLES
82 181
89=item $cf::RUNTIME 188=item $cf::RUNTIME
90 189
91The 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
92every server tick. 191every server tick.
93 192
94=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
95 196
96The perl library directory, where extensions and cf-specific modules can 197Various directories - "/etc", read-only install directory, perl-library
97be 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.
98 201
99=item $cf::NOW 202=item $cf::NOW
100 203
101The time of the last (current) server tick. 204The time of the last (current) server tick.
102 205
103=item $cf::TICK 206=item $cf::TICK
104 207
105The interval between server ticks, in seconds. 208The interval between server ticks, in seconds.
106 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
107=item %cf::CFG 220=item %cf::CFG
108 221
109Configuration for the server, loaded from C</etc/crossfire/config>, or 222Configuration for the server, loaded from C</etc/deliantra-server/config>, or
110from wherever your confdir points to. 223from wherever your confdir points to.
111 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
112=back 243=back
113 244
114=cut 245=cut
115 246
116BEGIN { 247$Coro::State::WARNHOOK = sub {
117 *CORE::GLOBAL::warn = sub {
118 my $msg = join "", @_; 248 my $msg = join "", @_;
119 utf8::encode $msg;
120 249
121 $msg .= "\n" 250 $msg .= "\n"
122 unless $msg =~ /\n$/; 251 unless $msg =~ /\n$/;
123 252
253 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
254
124 LOG llevError, "cfperl: $msg"; 255 LOG llevError, $msg;
125 }; 256};
126} 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};
127 271
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 272@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 273@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 274@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 275@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132@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';
133@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)
134 279
135# 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
136# within the Safe compartment. 281# within the Safe compartment.
137for my $pkg (qw( 282for my $pkg (qw(
138 cf::global cf::attachable 283 cf::global cf::attachable
139 cf::object cf::object::player 284 cf::object cf::object::player
140 cf::client cf::player 285 cf::client cf::player
141 cf::arch cf::living 286 cf::arch cf::living
287 cf::map cf::mapspace
142 cf::map cf::party cf::region 288 cf::party cf::region
143)) { 289)) {
144 no strict 'refs';
145 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 290 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
146} 291}
147 292
148$Event::DIED = sub { 293$EV::DIED = sub {
149 warn "error in event callback: @_"; 294 Carp::cluck "error in event callback: @_";
150}; 295};
151 296
152my %ext_pkg; 297#############################################################################
153my @exts;
154my @hook;
155 298
156=head2 UTILITY FUNCTIONS 299=head2 UTILITY FUNCTIONS
157 300
158=over 4 301=over 4
159 302
160=cut 303=item dumpval $ref
161 304
162use JSON::Syck (); # TODO# replace by JSON::PC once working 305=cut
163 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
164=item $ref = cf::from_json $json 326=item $ref = cf::decode_json $json
165 327
166Converts a JSON string into the corresponding perl data structure. 328Converts a JSON string into the corresponding perl data structure.
167 329
168=cut
169
170sub from_json($) {
171 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172 JSON::Syck::Load $_[0]
173}
174
175=item $json = cf::to_json $ref 330=item $json = cf::encode_json $ref
176 331
177Converts a perl data structure into its JSON representation. 332Converts a perl data structure into its JSON representation.
178 333
179=cut 334=cut
180 335
181sub to_json($) { 336our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183 JSON::Syck::Dump $_[0]
184}
185 337
186=item my $guard = cf::guard { BLOCK } 338sub encode_json($) { $json_coder->encode ($_[0]) }
339sub decode_json($) { $json_coder->decode ($_[0]) }
187 340
188Run the given callback when the guard object gets destroyed (useful for 341=item cf::post_init { BLOCK }
189coroutine cancellations).
190 342
191You can call C<< ->cancel >> on the guard object to stop the block from 343Execute the given codeblock, I<after> all extensions have been (re-)loaded,
192being executed. 344but I<before> the server starts ticking again.
193 345
194=cut 346The cdoeblock will have a single boolean argument to indicate whether this
347is a reload or not.
195 348
196sub guard(&) { 349=cut
197 bless \(my $cb = $_[0]), cf::guard::;
198}
199 350
200sub cf::guard::cancel { 351sub post_init(&) {
201 ${$_[0]} = sub { }; 352 push @POST_INIT, shift;
202}
203
204sub cf::guard::DESTROY {
205 ${$_[0]}->();
206} 353}
207 354
208=item cf::lock_wait $string 355=item cf::lock_wait $string
209 356
210Wait until the given lock is available. See cf::lock_acquire. 357Wait until the given lock is available. See cf::lock_acquire.
211 358
212=item my $lock = cf::lock_acquire $string 359=item my $lock = cf::lock_acquire $string
213 360
214Wait 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
215a 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,
216for example when the coroutine gets canceled), the lock is automatically 363for example when the coroutine gets canceled), the lock is automatically
217returned. 364returned.
218 365
366Locks are *not* recursive, locking from the same coro twice results in a
367deadlocked coro.
368
219Lock names should begin with a unique identifier (for example, find_map 369Lock names should begin with a unique identifier (for example, cf::map::find
220uses map_find and load_map uses map_load). 370uses map_find and cf::map::load uses map_load).
221 371
222=cut 372=item $locked = cf::lock_active $string
223 373
224our %LOCK; 374Return true if the lock is currently active, i.e. somebody has locked it.
375
376=cut
377
378our $LOCKS = new Coro::SemaphoreSet;
225 379
226sub lock_wait($) { 380sub lock_wait($) {
227 my ($key) = @_; 381 $LOCKS->wait ($_[0]);
228
229 # wait for lock, if any
230 while ($LOCK{$key}) {
231 push @{ $LOCK{$key} }, $Coro::current;
232 Coro::schedule;
233 }
234} 382}
235 383
236sub lock_acquire($) { 384sub lock_acquire($) {
237 my ($key) = @_; 385 $LOCKS->guard ($_[0])
238
239 # wait, to be sure we are not locked
240 lock_wait $key;
241
242 $LOCK{$key} = [];
243
244 cf::guard {
245 # wake up all waiters, to be on the safe side
246 $_->ready for @{ delete $LOCK{$key} };
247 }
248} 386}
387
388sub lock_active($) {
389 $LOCKS->count ($_[0]) < 1
390}
391
392sub freeze_mainloop {
393 tick_inhibit_inc;
394
395 &Guard::guard (\&tick_inhibit_dec);
396}
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;
471}
472
473=item cf::async { BLOCK }
474
475Currently the same as Coro::async_pool, meaning you cannot use
476C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
477thing you are allowed to do is call C<prio> on it.
478
479=cut
480
481BEGIN { *async = \&Coro::async_pool }
249 482
250=item cf::sync_job { BLOCK } 483=item cf::sync_job { BLOCK }
251 484
252The design of crossfire+ requires that the main coro ($Coro::main) is 485The design of Deliantra requires that the main coroutine ($Coro::main)
253always able to handle events or runnable, as crossfire+ is only partly 486is always able to handle events or runnable, as Deliantra is only
254reentrant. 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.
255 489
256If 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
257the given BLOCK in another coroutine while waiting for the result. The 491the given BLOCK in another coroutine while waiting for the result. The
258server 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
259fast or be very important. 493fast or be very important.
262 496
263sub sync_job(&) { 497sub sync_job(&) {
264 my ($job) = @_; 498 my ($job) = @_;
265 499
266 if ($Coro::current == $Coro::main) { 500 if ($Coro::current == $Coro::main) {
501 my $time = EV::time;
502
267 # this is the main coro, too bad, we have to block 503 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 504 # till the operation succeeds, freezing the server :/
269 505
270 # TODO: use suspend/resume instead 506 LOG llevError, Carp::longmess "sync job";#d#
271 # (but this is cancel-safe) 507
272 local $FREEZE = 1; 508 my $freeze_guard = freeze_mainloop;
273 509
274 my $busy = 1; 510 my $busy = 1;
275 my @res; 511 my @res;
276 512
277 (Coro::async { 513 (async {
514 $Coro::current->desc ("sync job coro");
278 @res = eval { $job->() }; 515 @res = eval { $job->() };
279 warn $@ if $@; 516 warn $@ if $@;
280 undef $busy; 517 undef $busy;
281 })->prio (Coro::PRIO_MAX); 518 })->prio (Coro::PRIO_MAX);
282 519
283 while ($busy) { 520 while ($busy) {
521 if (Coro::nready) {
284 Coro::cede_notself; 522 Coro::cede_notself;
285 Event::one_event unless Coro::nready; 523 } else {
524 EV::loop EV::LOOP_ONESHOT;
286 } 525 }
526 }
527
528 my $time = EV::time - $time;
529
530 $TICK_START += $time; # do not account sync jobs to server load
287 531
288 wantarray ? @res : $res[0] 532 wantarray ? @res : $res[0]
289 } else { 533 } else {
290 # we are in another coroutine, how wonderful, everything just works 534 # we are in another coroutine, how wonderful, everything just works
291 535
292 $job->() 536 $job->()
293 } 537 }
294} 538}
295 539
296=item $coro = cf::coro { BLOCK } 540=item $coro = cf::async_ext { BLOCK }
297 541
298Creates and returns a new coro. This coro is automcatially being canceled 542Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 543extension calling this is being unloaded.
300 544
301=cut 545=cut
302 546
303sub coro(&) { 547sub async_ext(&) {
304 my $cb = shift; 548 my $cb = shift;
305 549
306 my $coro; $coro = async { 550 my $coro = &Coro::async ($cb);
307 eval {
308 $cb->();
309 };
310 warn $@ if $@;
311 };
312 551
313 $coro->on_destroy (sub { 552 $coro->on_destroy (sub {
314 delete $EXT_CORO{$coro+0}; 553 delete $EXT_CORO{$coro+0};
315 }); 554 });
316 $EXT_CORO{$coro+0} = $coro; 555 $EXT_CORO{$coro+0} = $coro;
317 556
318 $coro 557 $coro
319} 558}
320 559
321sub write_runtime { 560=item fork_call { }, $args
322 my $runtime = cf::localdir . "/runtime";
323 561
324 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 562Executes the given code block with the given arguments in a seperate
325 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.
326 566
327 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 567=cut
328 (aio_write $fh, 0, (length $value), $value, 0) <= 0
329 and return;
330 568
331 aio_fsync $fh 569sub fork_call(&@) {
332 and return; 570 my ($cb, @args) = @_;
333 571
334 close $fh 572 # we seemingly have to make a local copy of the whole thing,
335 or return; 573 # otherwise perl prematurely frees the stuff :/
574 # TODO: investigate and fix (likely this will be rather laborious)
336 575
337 aio_rename "$runtime~", $runtime 576 my @res = Coro::Util::fork_eval {
338 and return; 577 reset_signals;
578 &$cb
579 }, @args;
339 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
340 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 });
341} 747}
342 748
343=back 749=back
344 750
345=cut 751=cut
346 752
347############################################################################# 753#############################################################################
348 754
349package cf::path;
350
351sub new {
352 my ($class, $path, $base) = @_;
353
354 $path = $path->as_string if ref $path;
355
356 my $self = bless { }, $class;
357
358 # {... are special paths that are not touched
359 # ?xxx/... are special absolute paths
360 # ?random/... random maps
361 # /! non-realised random map exit
362 # /... normal maps
363 # ~/... per-player maps without a specific player (DO NOT USE)
364 # ~user/... per-player map of a specific user
365
366 if ($path =~ /^{/) {
367 # fine as it is
368 } elsif ($path =~ s{^\?random/}{}) {
369 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370 $self->{random} = cf::from_json $data;
371 } else {
372 if ($path =~ s{^~([^/]+)?}{}) {
373 $self->{user_rel} = 1;
374
375 if (defined $1) {
376 $self->{user} = $1;
377 } elsif ($base =~ m{^~([^/]+)/}) {
378 $self->{user} = $1;
379 } else {
380 warn "cannot resolve user-relative path without user <$path,$base>\n";
381 }
382 } elsif ($path =~ /^\//) {
383 # already absolute
384 } else {
385 $base =~ s{[^/]+/?$}{};
386 return $class->new ("$base/$path");
387 }
388
389 for ($path) {
390 redo if s{/\.?/}{/};
391 redo if s{/[^/]+/\.\./}{/};
392 }
393 }
394
395 $self->{path} = $path;
396
397 $self
398}
399
400# the name / primary key / in-game path
401sub as_string {
402 my ($self) = @_;
403
404 $self->{user_rel} ? "~$self->{user}$self->{path}"
405 : $self->{random} ? "?random/$self->{path}"
406 : $self->{path}
407}
408
409# the displayed name, this is a one way mapping
410sub visible_name {
411 my ($self) = @_;
412
413# if (my $rmp = $self->{random}) {
414# # todo: be more intelligent about this
415# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416# } else {
417 $self->as_string
418# }
419}
420
421# escape the /'s in the path
422sub _escaped_path {
423 # ∕ is U+2215
424 (my $path = $_[0]{path}) =~ s/\//∕/g;
425 $path
426}
427
428# the original (read-only) location
429sub load_path {
430 my ($self) = @_;
431
432 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433}
434
435# the temporary/swap location
436sub save_path {
437 my ($self) = @_;
438
439 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442}
443
444# the unique path, might be eq to save_path
445sub uniq_path {
446 my ($self) = @_;
447
448 $self->{user_rel} || $self->{random}
449 ? undef
450 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451}
452
453# return random map parameters, or undef
454sub random_map_params {
455 my ($self) = @_;
456
457 $self->{random}
458}
459
460# this is somewhat ugly, but style maps do need special treatment
461sub is_style_map {
462 $_[0]{path} =~ m{^/styles/}
463}
464
465package cf;
466
467#############################################################################
468
469=head2 ATTACHABLE OBJECTS 755=head2 ATTACHABLE OBJECTS
470 756
471Many 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
472attach callbacks/event handlers (a collection of which is called an "attachment") 758attach callbacks/event handlers (a collection of which is called an "attachment")
473to it. All such attachable objects support the following methods. 759to it. All such attachable objects support the following methods.
474 760
475In 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>
476C<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
477crossfire+). 763Deliantra).
478 764
479=over 4 765=over 4
480 766
481=item $attachable->attach ($attachment, key => $value...) 767=item $attachable->attach ($attachment, key => $value...)
482 768
526=item cf::CLASS::attachment $name, ... 812=item cf::CLASS::attachment $name, ...
527 813
528Register an attachment by C<$name> through which attachable objects of the 814Register an attachment by C<$name> through which attachable objects of the
529given CLASS can refer to this attachment. 815given CLASS can refer to this attachment.
530 816
531Some classes such as crossfire maps and objects can specify attachments 817Some classes such as deliantra maps and objects can specify attachments
532that 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.
533 819
534These calls expect any number of the following handler/hook descriptions: 820These calls expect any number of the following handler/hook descriptions:
535 821
536=over 4 822=over 4
596our @CB_TYPE = (); # registry for type (cf-object class) based events 882our @CB_TYPE = (); # registry for type (cf-object class) based events
597our @CB_MAP = (); 883our @CB_MAP = ();
598 884
599my %attachment; 885my %attachment;
600 886
887sub cf::attachable::thawer_merge {
888 # simply override everything except _meta
889 local $_[0]{_meta};
890 %{$_[0]} = %{$_[1]};
891}
892
601sub _attach_cb($$$$) { 893sub _attach_cb($$$$) {
602 my ($registry, $event, $prio, $cb) = @_; 894 my ($registry, $event, $prio, $cb) = @_;
603 895
604 use sort 'stable'; 896 use sort 'stable';
605 897
639 $registry = $CB_TYPE[$object_type] ||= []; 931 $registry = $CB_TYPE[$object_type] ||= [];
640 932
641 } elsif ($type eq "subtype") { 933 } elsif ($type eq "subtype") {
642 defined $object_type or Carp::croak "subtype specified without type"; 934 defined $object_type or Carp::croak "subtype specified without type";
643 my $object_subtype = shift @arg; 935 my $object_subtype = shift @arg;
644 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 936 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
645 937
646 } elsif ($type eq "package") { 938 } elsif ($type eq "package") {
647 my $pkg = shift @arg; 939 my $pkg = shift @arg;
648 940
649 while (my ($name, $id) = each %cb_id) { 941 while (my ($name, $id) = each %cb_id) {
678 _attach $registry, $klass, @attach; 970 _attach $registry, $klass, @attach;
679 } 971 }
680 972
681 $obj->{$name} = \%arg; 973 $obj->{$name} = \%arg;
682 } else { 974 } else {
683 warn "object uses attachment '$name' that is not available, postponing.\n"; 975 warn "object uses attachment '$name' which is not available, postponing.\n";
684 } 976 }
685 977
686 $obj->{_attachment}{$name} = undef; 978 $obj->{_attachment}{$name} = undef;
687} 979}
688 980
690 if (ref $_[0]) { 982 if (ref $_[0]) {
691 _object_attach @_; 983 _object_attach @_;
692 } else { 984 } else {
693 _attach shift->_attach_registry, @_; 985 _attach shift->_attach_registry, @_;
694 } 986 }
987 _recalc_want;
695}; 988};
696 989
697# all those should be optimised 990# all those should be optimised
698sub cf::attachable::detach { 991sub cf::attachable::detach {
699 my ($obj, $name) = @_; 992 my ($obj, $name) = @_;
702 delete $obj->{_attachment}{$name}; 995 delete $obj->{_attachment}{$name};
703 reattach ($obj); 996 reattach ($obj);
704 } else { 997 } else {
705 Carp::croak "cannot, currently, detach class attachments"; 998 Carp::croak "cannot, currently, detach class attachments";
706 } 999 }
1000 _recalc_want;
707}; 1001};
708 1002
709sub cf::attachable::attached { 1003sub cf::attachable::attached {
710 my ($obj, $name) = @_; 1004 my ($obj, $name) = @_;
711 1005
726 "; 1020 ";
727 die if $@; 1021 die if $@;
728} 1022}
729 1023
730our $override; 1024our $override;
731our @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?
732 1026
733sub override { 1027sub override {
734 $override = 1; 1028 $override = 1;
735 @invoke_results = (); 1029 @INVOKE_RESULTS = (@_);
736} 1030}
737 1031
738sub do_invoke { 1032sub do_invoke {
739 my $event = shift; 1033 my $event = shift;
740 my $callbacks = shift; 1034 my $callbacks = shift;
741 1035
742 @invoke_results = (); 1036 @INVOKE_RESULTS = ();
743 1037
744 local $override; 1038 local $override;
745 1039
746 for (@$callbacks) { 1040 for (@$callbacks) {
747 eval { &{$_->[1]} }; 1041 eval { &{$_->[1]} };
756 } 1050 }
757 1051
758 0 1052 0
759} 1053}
760 1054
761=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1055=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
762 1056
763=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1057=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
764 1058
765Generate an object-specific event with the given arguments. 1059Generate an object-specific event with the given arguments.
766 1060
767This 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
768removed 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
769results (if you must, access C<@cf::invoke_results> directly). 1063results (if you must, access C<@cf::INVOKE_RESULTS> directly).
770 1064
771=back 1065=back
772 1066
773=cut 1067=cut
774 1068
775############################################################################# 1069#############################################################################
776# 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}
777 1113
778sub reattach { 1114sub reattach {
779 # basically do the same as instantiate, without calling instantiate 1115 # basically do the same as instantiate, without calling instantiate
780 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
781 1120
782 my $registry = $obj->registry; 1121 my $registry = $obj->registry;
783 1122
784 @$registry = (); 1123 @$registry = ();
785 1124
800cf::attachable->attach ( 1139cf::attachable->attach (
801 prio => -1000000, 1140 prio => -1000000,
802 on_instantiate => sub { 1141 on_instantiate => sub {
803 my ($obj, $data) = @_; 1142 my ($obj, $data) = @_;
804 1143
805 $data = from_json $data; 1144 $data = decode_json $data;
806 1145
807 for (@$data) { 1146 for (@$data) {
808 my ($name, $args) = @$_; 1147 my ($name, $args) = @$_;
809 1148
810 $obj->attach ($name, %{$args || {} }); 1149 $obj->attach ($name, %{$args || {} });
826sub object_freezer_save { 1165sub object_freezer_save {
827 my ($filename, $rdata, $objs) = @_; 1166 my ($filename, $rdata, $objs) = @_;
828 1167
829 sync_job { 1168 sync_job {
830 if (length $$rdata) { 1169 if (length $$rdata) {
1170 utf8::decode (my $decname = $filename);
831 warn sprintf "saving %s (%d,%d)\n", 1171 warn sprintf "saving %s (%d,%d)\n",
832 $filename, length $$rdata, scalar @$objs; 1172 $decname, length $$rdata, scalar @$objs;
833 1173
834 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1174 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835 chmod SAVE_MODE, $fh; 1175 aio_chmod $fh, SAVE_MODE;
836 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;
837 aio_fsync $fh; 1179 aio_fsync $fh;
1180 }
838 close $fh; 1181 aio_close $fh;
839 1182
840 if (@$objs) { 1183 if (@$objs) {
841 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) {
842 chmod SAVE_MODE, $fh; 1185 aio_chmod $fh, SAVE_MODE;
843 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1186 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
844 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;
845 aio_fsync $fh; 1190 aio_fsync $fh;
1191 }
846 close $fh; 1192 aio_close $fh;
847 aio_rename "$filename.pst~", "$filename.pst"; 1193 aio_rename "$filename.pst~", "$filename.pst";
848 } 1194 }
849 } else { 1195 } else {
850 aio_unlink "$filename.pst"; 1196 aio_unlink "$filename.pst";
851 } 1197 }
852 1198
853 aio_rename "$filename~", $filename; 1199 aio_rename "$filename~", $filename;
1200
1201 $filename =~ s%/[^/]+$%%;
1202 aio_pathsync $filename if $cf::USE_FSYNC;
854 } else { 1203 } else {
855 warn "FATAL: $filename~: $!\n"; 1204 warn "unable to save objects: $filename~: $!\n";
856 } 1205 }
857 } else { 1206 } else {
858 aio_unlink $filename; 1207 aio_unlink $filename;
859 aio_unlink "$filename.pst"; 1208 aio_unlink "$filename.pst";
860 } 1209 }
861 } 1210 };
862} 1211}
863 1212
864sub object_freezer_as_string { 1213sub object_freezer_as_string {
865 my ($rdata, $objs) = @_; 1214 my ($rdata, $objs) = @_;
866 1215
878 or return; 1227 or return;
879 1228
880 unless (aio_stat "$filename.pst") { 1229 unless (aio_stat "$filename.pst") {
881 (aio_load "$filename.pst", $av) >= 0 1230 (aio_load "$filename.pst", $av) >= 0
882 or return; 1231 or return;
1232
883 $av = eval { (Storable::thaw $av)->{objs} }; 1233 my $st = eval { Coro::Storable::thaw $av };
1234 $av = $st->{objs};
884 } 1235 }
885 1236
1237 utf8::decode (my $decname = $filename);
886 warn sprintf "loading %s (%d)\n", 1238 warn sprintf "loading %s (%d,%d)\n",
887 $filename, length $data, scalar @{$av || []};#d# 1239 $decname, length $data, scalar @{$av || []};
1240
888 return ($data, $av); 1241 ($data, $av)
889} 1242}
1243
1244=head2 COMMAND CALLBACKS
1245
1246=over 4
1247
1248=cut
890 1249
891############################################################################# 1250#############################################################################
892# command handling &c 1251# command handling &c
893 1252
894=item cf::register_command $name => \&callback($ob,$args); 1253=item cf::register_command $name => \&callback($ob,$args);
907 push @{ $COMMAND{$name} }, [$caller, $cb]; 1266 push @{ $COMMAND{$name} }, [$caller, $cb];
908} 1267}
909 1268
910=item cf::register_extcmd $name => \&callback($pl,$packet); 1269=item cf::register_extcmd $name => \&callback($pl,$packet);
911 1270
912Register 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.
913 1276
914If 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
915called. 1278called.
916 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
917=cut 1291=cut
918 1292
919sub register_extcmd { 1293sub register_extcmd {
920 my ($name, $cb) = @_; 1294 my ($name, $cb) = @_;
921 1295
922 my $caller = caller;
923 #warn "registering extcmd '$name' to '$caller'";
924
925 $EXTCMD{$name} = [$cb, $caller]; 1296 $EXTCMD{$name} = $cb;
926} 1297}
1298
1299sub register_exticmd {
1300 my ($name, $cb) = @_;
1301
1302 $EXTICMD{$name} = $cb;
1303}
1304
1305use File::Glob ();
927 1306
928cf::player->attach ( 1307cf::player->attach (
929 on_command => sub { 1308 on_command => sub {
930 my ($pl, $name, $params) = @_; 1309 my ($pl, $name, $params) = @_;
931 1310
939 cf::override; 1318 cf::override;
940 }, 1319 },
941 on_extcmd => sub { 1320 on_extcmd => sub {
942 my ($pl, $buf) = @_; 1321 my ($pl, $buf) = @_;
943 1322
944 my $msg = eval { from_json $buf }; 1323 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
945 1324
946 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
947 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1333 if (my $cb = $EXTCMD{$type}) {
948 if (my %reply = $cb->[0]->($pl, $msg)) { 1334 @reply = $cb->($pl, @payload);
949 $pl->ext_reply ($msg->{msgid}, %reply);
950 }
951 } 1335 }
1336
1337 $pl->ext_reply ($reply, @reply)
1338 if $reply;
1339
952 } else { 1340 } else {
953 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1341 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
954 } 1342 }
955 1343
956 cf::override; 1344 cf::override;
957 }, 1345 },
958); 1346);
959 1347
960sub register { 1348# "readahead" all extensions
961 my ($base, $pkg) = @_; 1349sub cache_extensions {
1350 my $grp = IO::AIO::aio_group;
962 1351
963 #TODO 1352 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
964} 1353 for (grep /\.ext$/, @{$_[0]}) {
1354 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
1355 }
1356 };
965 1357
1358 $grp
1359}
1360
966sub 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($) {
967 my ($path) = @_; 1716 my ($path) = @_;
968 1717
969 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1718 my ($match, $specificity);
970 my $base = $1;
971 my $pkg = $1;
972 $pkg =~ s/[^[:word:]]/_/g;
973 $pkg = "ext::$pkg";
974 1719
975 warn "loading '$path' into '$pkg'\n"; 1720 for my $region (list) {
976 1721 if ($region->{match} && $path =~ $region->{match}) {
977 open my $fh, "<:utf8", $path 1722 ($match, $specificity) = ($region, $region->specificity)
978 or die "$path: $!"; 1723 if $region->specificity > $specificity;
979 1724 }
980 my $source =
981 "package $pkg; use strict; use utf8;\n"
982 . "#line 1 \"$path\"\n{\n"
983 . (do { local $/; <$fh> })
984 . "\n};\n1";
985
986 eval $source
987 or die $@ ? "$path: $@\n"
988 : "extension disabled.\n";
989
990 push @exts, $pkg;
991 $ext_pkg{$base} = $pkg;
992
993# no strict 'refs';
994# @{"$pkg\::ISA"} = ext::;
995
996 register $base, $pkg;
997}
998
999sub unload_extension {
1000 my ($pkg) = @_;
1001
1002 warn "removing extension $pkg\n";
1003
1004 # remove hooks
1005 #TODO
1006# for my $idx (0 .. $#PLUGIN_EVENT) {
1007# delete $hook[$idx]{$pkg};
1008# } 1725 }
1009 1726
1010 # remove commands 1727 $match
1011 for my $name (keys %COMMAND) {
1012 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014 if (@cb) {
1015 $COMMAND{$name} = \@cb;
1016 } else {
1017 delete $COMMAND{$name};
1018 }
1019 }
1020
1021 # remove extcmds
1022 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1023 delete $EXTCMD{$name};
1024 }
1025
1026 if (my $cb = $pkg->can ("unload")) {
1027 eval {
1028 $cb->($pkg);
1029 1
1030 } or warn "$pkg unloaded, but with errors: $@";
1031 }
1032
1033 Symbol::delete_package $pkg;
1034}
1035
1036sub load_extensions {
1037 for my $ext (<$LIBDIR/*.ext>) {
1038 next unless -r $ext;
1039 eval {
1040 load_extension $ext;
1041 1
1042 } or warn "$ext not loaded: $@";
1043 }
1044}
1045
1046#############################################################################
1047# load/save/clean perl data associated with a map
1048
1049*cf::mapsupport::on_clean = sub {
1050 my ($map) = @_;
1051
1052 my $path = $map->tmpname;
1053 defined $path or return;
1054
1055 unlink "$path.pst";
1056};
1057
1058cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060#############################################################################
1061# load/save perl data associated with player->ob objects
1062
1063sub all_objects(@) {
1064 @_, map all_objects ($_->inv), @_
1065}
1066
1067# TODO: compatibility cruft, remove when no longer needed
1068cf::player->attach (
1069 on_load => sub {
1070 my ($pl, $path) = @_;
1071
1072 for my $o (all_objects $pl->ob) {
1073 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1074 $o->set_ob_key_value ("_perl_data");
1075
1076 %$o = %{ Storable::thaw pack "H*", $value };
1077 }
1078 }
1079 },
1080);
1081
1082#############################################################################
1083
1084=head2 CORE EXTENSIONS
1085
1086Functions and methods that extend core crossfire objects.
1087
1088=head3 cf::player
1089
1090=over 4
1091
1092=item cf::player::exists $login
1093
1094Returns true when the given account exists.
1095
1096=cut
1097
1098sub cf::player::exists($) {
1099 cf::player::find $_[0]
1100 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1101}
1102
1103=item $player->ext_reply ($msgid, $msgtype, %msg)
1104
1105Sends an ext reply to the player.
1106
1107=cut
1108
1109sub cf::player::ext_reply($$$%) {
1110 my ($self, $id, %msg) = @_;
1111
1112 $msg{msgid} = $id;
1113
1114 $self->send ("ext " . to_json \%msg);
1115} 1728}
1116 1729
1117=back 1730=back
1118
1119 1731
1120=head3 cf::map 1732=head3 cf::map
1121 1733
1122=over 4 1734=over 4
1123 1735
1126package cf::map; 1738package cf::map;
1127 1739
1128use Fcntl; 1740use Fcntl;
1129use Coro::AIO; 1741use Coro::AIO;
1130 1742
1743use overload
1744 '""' => \&as_string,
1745 fallback => 1;
1746
1131our $MAX_RESET = 7200; 1747our $MAX_RESET = 3600;
1132our $DEFAULT_RESET = 3600; 1748our $DEFAULT_RESET = 3000;
1133 1749
1134sub generate_random_map { 1750sub generate_random_map {
1135 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
1136 1754
1137 # mit "rum" bekleckern, nicht 1755 # mit "rum" bekleckern, nicht
1138 cf::map::_create_random_map 1756 $self->_create_random_map (
1139 $path,
1140 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1757 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1758 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1759 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143 $rmp->{exit_on_final_map}, 1760 $rmp->{exit_on_final_map},
1144 $rmp->{xsize}, $rmp->{ysize}, 1761 $rmp->{xsize}, $rmp->{ysize},
1145 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1762 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1763 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1764 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148 $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},
1149 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1766 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150 (cf::region::find $rmp->{region}) 1767 (cf::region::find $rmp->{region}), $rmp->{custom}
1768 )
1151} 1769}
1152 1770
1153# and all this just because we cannot iterate over 1771=item cf::map->register ($regex, $prio)
1154# all maps in C++...
1155sub change_all_map_light {
1156 my ($change) = @_;
1157 1772
1158 $_->change_map_light ($change) for values %cf::MAP; 1773Register a handler for the map path matching the given regex at the
1159} 1774givne priority (higher is better, built-in handlers have priority 0, the
1775default).
1160 1776
1161sub 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 {
1162 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) = @_;
1163 1916
1164 utf8::encode $path; 1917 utf8::encode $path;
1165 aio_open $path, O_RDONLY, 0 1918 my $f = new_from_file cf::object::thawer $path
1166 or return; 1919 or return;
1167 1920
1168 my $map = cf::map::new 1921 $self->_load_header ($f)
1169 or return; 1922 or return;
1170 1923
1171 $map->load_header ($path) 1924 local $MAP_LOADING{$self->{path}} = $self;
1925 $f->resolve_delayed_derefs;
1926
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
1172 or return; 1970 or return;
1971 $self->prepare_orig;
1972 }
1173 1973
1174 $map->{load_path} = $path; 1974 $self->{deny_reset} = 1
1975 if $self->no_reset;
1175 1976
1176 $map 1977 $self->default_region (cf::region::find_by_path $self->{path})
1177} 1978 unless $self->default_region;
1178 1979
1980 1
1981}
1982
1983sub find;
1179sub find_map { 1984sub find {
1180 my ($path, $origin) = @_; 1985 my ($path, $origin) = @_;
1181 1986
1182 #warn "find_map<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path; 1987 $path = normalise $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186 1988
1187 cf::lock_wait "map_find:$key"; 1989 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1188
1189 $cf::MAP{$key} || do {
1190 my $guard = cf::lock_acquire "map_find:$key"; 1990 my $guard2 = cf::lock_acquire "map_find:$path";
1191 1991
1192 # do it the slow way 1992 $cf::MAP{$path} || do {
1193 my $map = try_load_header $path->save_path; 1993 my $map = new_from_path cf::map $path
1194
1195 if ($map) {
1196 # safety
1197 $map->{instantiate_time} = $cf::RUNTIME
1198 if $map->{instantiate_time} > $cf::RUNTIME;
1199 } else {
1200 if (my $rmp = $path->random_map_params) {
1201 $map = generate_random_map $key, $rmp;
1202 } else {
1203 $map = try_load_header $path->load_path;
1204 }
1205
1206 $map or return; 1994 or return;
1207 1995
1208 $map->{load_original} = 1;
1209 $map->{instantiate_time} = $cf::RUNTIME;
1210 $map->instantiate;
1211
1212 # per-player maps become, after loading, normal maps
1213 $map->per_player (0) if $path->{user_rel};
1214 }
1215 #Coro::Timer::sleep 1;#d#
1216
1217 $map->path ($key);
1218 $map->{path} = $path;
1219 $map->{last_save} = $cf::RUNTIME; 1996 $map->{last_save} = $cf::RUNTIME;
1220 $map->last_access ($cf::RUNTIME);
1221 1997
1222 if ($map->should_reset) { 1998 $map->load_header
1999 or return;
2000
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;
1223 $map->reset; 2006 $map->reset;
1224 $map = find_map $path; 2007 return find $path;
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
2056 $f->resolve_delayed_derefs;
2057
2058 cf::cede_to_tick;
1256 # now do the right thing for maps 2059 # now do the right thing for maps
1257 $self->link_multipart_objects; 2060 $self->link_multipart_objects;
1258
1259 if ($self->{path}->is_style_map) {
1260 $self->{deny_save} = 1;
1261 $self->{deny_reset} = 1;
1262 } else {
1263 $self->fix_auto_apply;
1264 $self->decay_objects;
1265 $self->update_buttons;
1266 $self->set_darkness_map;
1267 $self->difficulty ($self->estimate_difficulty) 2061 $self->difficulty ($self->estimate_difficulty)
1268 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;
1269 $self->activate; 2070 $self->activate;
1270 } 2071 }
1271 2072
2073 $self->{last_save} = $cf::RUNTIME;
2074 $self->last_access ($cf::RUNTIME);
2075
1272 $self->in_memory (cf::MAP_IN_MEMORY); 2076 $self->in_memory (cf::MAP_ACTIVE);
1273} 2077 }
1274 2078
1275sub load_map_sync { 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 }
2118}
2119
2120sub find_sync {
1276 my ($path, $origin) = @_; 2121 my ($path, $origin) = @_;
1277 2122
1278 #warn "load_map_sync<$path, $origin>\n";#d# 2123 cf::sync_job { find $path, $origin }
2124}
1279 2125
1280 cf::sync_job { 2126sub do_load_sync {
1281 my $map = cf::map::find_map $path, $origin 2127 my ($map) = @_;
1282 or return; 2128
1283 $map->load; 2129 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1284 $map 2130 if $Coro::current == $Coro::main;
2131
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;
1285 } 2162 };
2163 $MAP_PREFETCHER->prio (6);
2164
2165 ()
1286} 2166}
1287 2167
1288sub save { 2168sub save {
1289 my ($self) = @_; 2169 my ($self) = @_;
1290 2170
2171 my $lock = cf::lock_acquire "map_data:$self->{path}";
2172
1291 $self->{last_save} = $cf::RUNTIME; 2173 $self->{last_save} = $cf::RUNTIME;
1292 2174
1293 return unless $self->dirty; 2175 return unless $self->dirty;
1294 2176
1295 my $save = $self->{path}->save_path; utf8::encode $save; 2177 my $save = $self->save_path; utf8::encode $save;
1296 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2178 my $uniq = $self->uniq_path; utf8::encode $uniq;
1297 2179
1298 $self->{load_path} = $save; 2180 $self->{load_path} = $save;
1299 2181
1300 return if $self->{deny_save}; 2182 return if $self->{deny_save};
1301 2183
2184 local $self->{last_access} = $self->last_access;#d#
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
1302 if ($uniq) { 2193 if ($uniq) {
1303 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2194 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1304 $self->save_objects ($uniq, cf::IO_UNIQUES); 2195 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1305 } else { 2196 } else {
1306 $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);
1307 } 2198 }
1308} 2199}
1309 2200
1310sub swap_out { 2201sub swap_out {
1311 my ($self) = @_; 2202 my ($self) = @_;
1312 2203
2204 # save first because save cedes
2205 $self->save;
2206
2207 my $lock = cf::lock_acquire "map_data:$self->{path}";
2208
1313 return if $self->players; 2209 return if $self->players;
1314 return if $self->in_memory != cf::MAP_IN_MEMORY; 2210 return if $self->in_memory != cf::MAP_ACTIVE;
1315 return if $self->{deny_save}; 2211 return if $self->{deny_save};
1316 2212
2213 $self->in_memory (cf::MAP_SWAPPED);
2214
1317 $self->save; 2215 $self->deactivate;
2216 $_->clear_links_to ($self) for values %cf::MAP;
1318 $self->clear; 2217 $self->clear;
1319 $self->in_memory (cf::MAP_SWAPPED);
1320} 2218}
1321 2219
1322sub reset_at { 2220sub reset_at {
1323 my ($self) = @_; 2221 my ($self) = @_;
1324 2222
1325 # TODO: safety, remove and allow resettable per-player maps 2223 # TODO: safety, remove and allow resettable per-player maps
1326 return 1e99 if $self->{path}{user_rel};
1327 return 1e99 if $self->{deny_reset}; 2224 return 1e99 if $self->{deny_reset};
1328 2225
1329 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2226 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1330 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;
1331 2228
1336 my ($self) = @_; 2233 my ($self) = @_;
1337 2234
1338 $self->reset_at <= $cf::RUNTIME 2235 $self->reset_at <= $cf::RUNTIME
1339} 2236}
1340 2237
1341sub unlink_save {
1342 my ($self) = @_;
1343
1344 utf8::encode (my $save = $self->{path}->save_path);
1345 aioreq_pri 3; IO::AIO::aio_unlink $save;
1346 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1347}
1348
1349sub rename {
1350 my ($self, $new_path) = @_;
1351
1352 $self->unlink_save;
1353
1354 delete $cf::MAP{$self->path};
1355 $self->{path} = new cf::path $new_path;
1356 $self->path ($self->{path}->as_string);
1357 $cf::MAP{$self->path} = $self;
1358
1359 $self->save;
1360}
1361
1362sub reset { 2238sub reset {
1363 my ($self) = @_; 2239 my ($self) = @_;
1364 2240
2241 my $lock = cf::lock_acquire "map_data:$self->{path}";
2242
1365 return if $self->players; 2243 return if $self->players;
1366 return if $self->{path}{user_rel};#d#
1367 2244
1368 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 }
1369 2256
1370 delete $cf::MAP{$self->path}; 2257 delete $cf::MAP{$self->path};
1371 2258
2259 $self->deactivate;
1372 $_->clear_links_to ($self) for values %cf::MAP; 2260 $_->clear_links_to ($self) for values %cf::MAP;
2261 $self->clear;
1373 2262
1374 $self->unlink_save; 2263 $self->unlink_save;
1375 $self->destroy; 2264 $self->destroy;
1376} 2265}
1377 2266
1378my $nuke_counter = "aaaa"; 2267my $nuke_counter = "aaaa";
1379 2268
1380sub nuke { 2269sub nuke {
1381 my ($self) = @_; 2270 my ($self) = @_;
1382 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};
1383 $self->{deny_save} = 1; 2281 $self->{deny_save} = 1;
1384 $self->reset_timeout (1); 2282 $self->reset_timeout (1);
1385 $self->rename ("{nuke}/" . ($nuke_counter++)); 2283 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2284
2285 $cf::MAP{$self->path} = $self;
2286 }
2287
1386 $self->reset; # polite request, might not happen 2288 $self->reset; # polite request, might not happen
1387} 2289}
1388 2290
1389sub customise_for { 2291=item $maps = cf::map::tmp_maps
1390 my ($map, $ob) = @_;
1391 2292
1392 if ($map->per_player) { 2293Returns an arrayref with all map paths of currently instantiated and saved
1393 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2294maps. May block.
2295
2296=cut
2297
2298sub tmp_maps() {
1394 } 2299 [
1395 2300 map {
1396 $map 2301 utf8::decode $_;
2302 /\.map$/
2303 ? normalise $_
2304 : ()
2305 } @{ aio_readdir $TMPDIR or [] }
2306 ]
1397} 2307}
1398 2308
1399sub emergency_save { 2309=item $maps = cf::map::random_maps
1400 local $cf::FREEZE = 1;
1401 2310
1402 warn "enter emergency map save\n"; 2311Returns an arrayref with all map paths of currently instantiated and saved
2312random maps. May block.
1403 2313
1404 cf::sync_job { 2314=cut
1405 warn "begin emergency map save\n"; 2315
1406 $_->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;
1407 }; 2373 }
1408 2374
1409 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 }
1410} 2430}
1411 2431
1412package cf; 2432package cf;
1413 2433
1414=back 2434=back
1415
1416 2435
1417=head3 cf::object::player 2436=head3 cf::object::player
1418 2437
1419=over 4 2438=over 4
1420 2439
1423Sends 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>
1424can 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
1425dialogue with the given NPC character. 2444dialogue with the given NPC character.
1426 2445
1427=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};
1428 2461
1429# rough implementation of a future "reply" method that works 2462# rough implementation of a future "reply" method that works
1430# with dialog boxes. 2463# with dialog boxes.
1431#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
1432sub cf::object::player::reply($$$;$) { 2465sub cf::object::player::reply($$$;$) {
1434 2467
1435 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2468 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1436 2469
1437 if ($self->{record_replies}) { 2470 if ($self->{record_replies}) {
1438 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2471 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2472
1439 } 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 {
1440 $msg = $npc->name . " says: $msg" if $npc; 2481 $msg = $npc->name . " says: $msg" if $npc;
1441 $self->message ($msg, $flags); 2482 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2483 }
1442 } 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 (@_);
1443} 2495}
1444 2496
1445=item $player_object->may ("access") 2497=item $player_object->may ("access")
1446 2498
1447Returns wether the given player is authorized to access resource "access" 2499Returns wether the given player is authorized to access resource "access"
1460 2512
1461=item $player_object->enter_link 2513=item $player_object->enter_link
1462 2514
1463Freezes 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}>).
1464 2516
1465The 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.
1466I<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.
1467 2523
1468=item $player_object->leave_link ($map, $x, $y) 2524=item $player_object->leave_link ($map, $x, $y)
1469 2525
1470Moves 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
1471map 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
1472location 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
1473to the emergency map position. 2529fails, to the emergency map position.
1474 2530
1475Might block. 2531Might block.
1476 2532
1477=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}
1478 2544
1479sub cf::object::player::enter_link { 2545sub cf::object::player::enter_link {
1480 my ($self) = @_; 2546 my ($self) = @_;
1481 2547
1482 $self->deactivate_recursive; 2548 $self->deactivate_recursive;
1483 2549
1484 return if $self->map == $LINK_MAP; 2550 return if UNIVERSAL::isa $self->map, "ext::map_link";
1485 2551
1486 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2552 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1487 if $self->map; 2553 if $self->map && $self->map->{path} ne "{link}";
1488 2554
1489 $self->enter_map ($LINK_MAP, 20, 20); 2555 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1490} 2556}
1491 2557
1492sub cf::object::player::leave_link { 2558sub cf::object::player::leave_link {
1493 my ($self, $map, $x, $y) = @_; 2559 my ($self, $map, $x, $y) = @_;
2560
2561 return unless $self->contr->active;
1494 2562
1495 my $link_pos = delete $self->{_link_pos}; 2563 my $link_pos = delete $self->{_link_pos};
1496 2564
1497 unless ($map) { 2565 unless ($map) {
1498 # restore original map position 2566 # restore original map position
1499 ($map, $x, $y) = @{ $link_pos || [] }; 2567 ($map, $x, $y) = @{ $link_pos || [] };
1500 $map = cf::map::find_map $map; 2568 $map = cf::map::find $map;
1501 2569
1502 unless ($map) { 2570 unless ($map) {
1503 ($map, $x, $y) = @$EMERGENCY_POSITION; 2571 ($map, $x, $y) = @$EMERGENCY_POSITION;
1504 $map = cf::map::find_map $map 2572 $map = cf::map::find $map
1505 or die "FATAL: cannot load emergency map\n"; 2573 or die "FATAL: cannot load emergency map\n";
1506 } 2574 }
1507 } 2575 }
1508 2576
1509 ($x, $y) = (-1, -1) 2577 ($x, $y) = (-1, -1)
1510 unless (defined $x) && (defined $y); 2578 unless (defined $x) && (defined $y);
1511 2579
1512 # use -1 or undef as default coordinates, not 0, 0 2580 # use -1 or undef as default coordinates, not 0, 0
1513 ($x, $y) = ($map->enter_x, $map->enter_y) 2581 ($x, $y) = ($map->enter_x, $map->enter_y)
1514 if $x <=0 && $y <= 0; 2582 if $x <= 0 && $y <= 0;
1515 2583
1516 $map->load; 2584 $map->load;
2585 $map->load_neighbours;
1517 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
1518 $self->activate_recursive; 2593 $self->activate_recursive;
1519 $self->enter_map ($map, $x, $y);
1520} 2594}
1521 2595
1522cf::player->attach ( 2596=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1523 on_logout => sub {
1524 my ($pl) = @_;
1525 2597
1526 # abort map switching before logout 2598Moves the player to the given map-path and coordinates by first freezing
1527 if ($pl->ob->{_link_pos}) { 2599her, loading and preparing them map, calling the provided $check callback
1528 cf::sync_job { 2600that has to return the map if sucecssful, and then unfreezes the player on
1529 $pl->ob->leave_link 2601the new (success) or old (failed) map position. In either case, $done will
1530 }; 2602be called at the end of this process.
1531 }
1532 },
1533 on_login => sub {
1534 my ($pl) = @_;
1535 2603
1536 # try to abort aborted map switching on player login :) 2604Note that $check will be called with a potentially non-loaded map, so if
1537 # should happen only on crashes 2605it needs a loaded map it has to call C<< ->load >>.
1538 if ($pl->ob->{_link_pos}) {
1539 $pl->ob->enter_link;
1540 Coro::async {
1541 # we need this sleep as the login has a concurrent enter_exit running
1542 # and this sleep increases chances of the player not ending up in scorn
1543 Coro::Timer::sleep 1;
1544 $pl->ob->leave_link;
1545 };
1546 }
1547 },
1548);
1549 2606
1550=item $player_object->goto_map ($path, $x, $y)
1551
1552=cut 2607=cut
1553 2608
2609our $GOTOGEN;
2610
1554sub cf::object::player::goto_map { 2611sub cf::object::player::goto {
1555 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;
1556 2616
1557 $self->enter_link; 2617 $self->enter_link;
1558 2618
1559 (Coro::async { 2619 (async {
1560 $path = new cf::path $path; 2620 $Coro::current->{desc} = "player::goto $path $x $y";
1561 2621
1562 my $map = cf::map::find_map $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) {
1563 $map = $map->customise_for ($self) if $map; 2645 $map = $map->customise_for ($self);
1564 2646 $map = $check->($map) if $check && $map;
1565# warn "entering ", $map->path, " at ($x, $y)\n" 2647 } else {
1566# if $map;
1567
1568 $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 }
1569 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};
1570 $self->leave_link ($map, $x, $y); 2661 $self->leave_link ($map, $x, $y);
2662 }
2663
2664 $done->() if $done;
1571 })->prio (1); 2665 })->prio (1);
1572} 2666}
1573 2667
1574=item $player_object->enter_exit ($exit_object) 2668=item $player_object->enter_exit ($exit_object)
1575 2669
1577 2671
1578sub parse_random_map_params { 2672sub parse_random_map_params {
1579 my ($spec) = @_; 2673 my ($spec) = @_;
1580 2674
1581 my $rmp = { # defaults 2675 my $rmp = { # defaults
1582 xsize => 10, 2676 xsize => (cf::rndm 15, 40),
1583 ysize => 10, 2677 ysize => (cf::rndm 15, 40),
2678 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2679 #layout => string,
1584 }; 2680 };
1585 2681
1586 for (split /\n/, $spec) { 2682 for (split /\n/, $spec) {
1587 my ($k, $v) = split /\s+/, $_, 2; 2683 my ($k, $v) = split /\s+/, $_, 2;
1588 2684
1600 # that depends on the exit object 2696 # that depends on the exit object
1601 2697
1602 my $rmp = parse_random_map_params $exit->msg; 2698 my $rmp = parse_random_map_params $exit->msg;
1603 2699
1604 if ($exit->map) { 2700 if ($exit->map) {
1605 $rmp->{region} = $exit->map->region_name; 2701 $rmp->{region} = $exit->region->name;
1606 $rmp->{origin_map} = $exit->map->path; 2702 $rmp->{origin_map} = $exit->map->path;
1607 $rmp->{origin_x} = $exit->x; 2703 $rmp->{origin_x} = $exit->x;
1608 $rmp->{origin_y} = $exit->y; 2704 $rmp->{origin_y} = $exit->y;
2705
2706 $exit->map->touch;
1609 } 2707 }
1610 2708
1611 $rmp->{random_seed} ||= $exit->random_seed; 2709 $rmp->{random_seed} ||= $exit->random_seed;
1612 2710
1613 my $data = cf::to_json $rmp; 2711 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1614 my $md5 = Digest::MD5::md5_hex $data; 2712 my $md5 = Digest::MD5::md5_hex $data;
2713 my $meta = "$RANDOMDIR/$md5.meta";
1615 2714
1616 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) {
1617 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;
1618 2719
2720 my $slaying = "?random/$md5";
2721
2722 if ($exit->valid) {
1619 $exit->slaying ("?random/$md5"); 2723 $exit->slaying ("?random/$md5");
1620 $exit->msg (undef); 2724 $exit->msg (undef);
2725 }
1621 } 2726 }
1622} 2727}
1623 2728
1624sub cf::object::player::enter_exit { 2729sub cf::object::player::enter_exit {
1625 my ($self, $exit) = @_; 2730 my ($self, $exit) = @_;
1626 2731
1627 return unless $self->type == cf::PLAYER; 2732 return unless $self->type == cf::PLAYER;
1628 2733
1629 $self->enter_link; 2734 $self->enter_link;
1630 2735
1631 (Coro::async { 2736 (async {
2737 $Coro::current->{desc} = "enter_exit";
2738
1632 unless (eval { 2739 unless (eval {
2740 $self->deactivate_recursive; # just to be sure
1633 2741
2742 # random map handling
2743 {
2744 my $guard = cf::lock_acquire "exit_prepare:$exit";
2745
1634 prepare_random_map $exit 2746 prepare_random_map $exit
1635 if $exit->slaying eq "/!"; 2747 if $exit->slaying eq "/!";
2748 }
1636 2749
1637 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;
1638 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp); 2751 my $x = $exit->stats->hp;
2752 my $y = $exit->stats->sp;
1639 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
1640 1; 2760 1
1641 }) { 2761 }) {
1642 $self->message ("Something went wrong deep within the crossfire server. " 2762 $self->message ("Something went wrong deep within the deliantra server. "
1643 . "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. "
1644 . "Please report this to the dungeon master", 2764 . "Please report this to the dungeon master!",
1645 cf::NDI_UNIQUE | cf::NDI_RED); 2765 cf::NDI_UNIQUE | cf::NDI_RED);
1646 2766
1647 warn "ERROR in enter_exit: $@"; 2767 warn "ERROR in enter_exit: $@";
1648 $self->leave_link; 2768 $self->leave_link;
1649 } 2769 }
1650 })->prio (1); 2770 })->prio (1);
1663 2783
1664sub cf::client::send_drawinfo { 2784sub cf::client::send_drawinfo {
1665 my ($self, $text, $flags) = @_; 2785 my ($self, $text, $flags) = @_;
1666 2786
1667 utf8::encode $text; 2787 utf8::encode $text;
1668 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2788 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1669} 2789}
1670 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}
1671 3012
1672=item $success = $client->query ($flags, "text", \&cb) 3013=item $success = $client->query ($flags, "text", \&cb)
1673 3014
1674Queues a query to the client, calling the given callback with 3015Queues a query to the client, calling the given callback with
1675the 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>,
1676C<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>.
1677 3018
1678Queries 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
1679reliable at some point in the future. 3020become reliable at some point in the future.
1680 3021
1681=cut 3022=cut
1682 3023
1683sub cf::client::query { 3024sub cf::client::query {
1684 my ($self, $flags, $text, $cb) = @_; 3025 my ($self, $flags, $text, $cb) = @_;
1692 utf8::encode $text; 3033 utf8::encode $text;
1693 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3034 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1694 3035
1695 $self->send_packet ($self->{query_queue}[0][0]) 3036 $self->send_packet ($self->{query_queue}[0][0])
1696 if @{ $self->{query_queue} } == 1; 3037 if @{ $self->{query_queue} } == 1;
3038
3039 1
1697} 3040}
1698 3041
1699cf::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 },
1700 on_reply => sub { 3048 on_reply => sub {
1701 my ($ns, $msg) = @_; 3049 my ($ns, $msg) = @_;
1702 3050
1703 # this weird shuffling is so that direct followup queries 3051 # this weird shuffling is so that direct followup queries
1704 # get handled first 3052 # get handled first
1705 my $queue = delete $ns->{query_queue}; 3053 my $queue = delete $ns->{query_queue}
3054 or return; # be conservative, not sure how that can happen, but we saw a crash here
1706 3055
1707 (shift @$queue)->[1]->($msg); 3056 (shift @$queue)->[1]->($msg);
3057 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1708 3058
1709 push @{ $ns->{query_queue} }, @$queue; 3059 push @{ $ns->{query_queue} }, @$queue;
1710 3060
1711 if (@{ $ns->{query_queue} } == @$queue) { 3061 if (@{ $ns->{query_queue} } == @$queue) {
1712 if (@$queue) { 3062 if (@$queue) {
1714 } else { 3064 } else {
1715 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3065 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1716 } 3066 }
1717 } 3067 }
1718 }, 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 },
1719); 3095);
1720 3096
1721=item $client->coro (\&cb) 3097=item $client->async (\&cb)
1722 3098
1723Create a new coroutine, running the specified callback. The coroutine will 3099Create a new coroutine, running the specified callback. The coroutine will
1724be automatically cancelled when the client gets destroyed (e.g. on logout, 3100be automatically cancelled when the client gets destroyed (e.g. on logout,
1725or loss of connection). 3101or loss of connection).
1726 3102
1727=cut 3103=cut
1728 3104
1729sub cf::client::coro { 3105sub cf::client::async {
1730 my ($self, $cb) = @_; 3106 my ($self, $cb) = @_;
1731 3107
1732 my $coro; $coro = async { 3108 my $coro = &Coro::async ($cb);
1733 eval {
1734 $cb->();
1735 };
1736 warn $@ if $@;
1737 };
1738 3109
1739 $coro->on_destroy (sub { 3110 $coro->on_destroy (sub {
1740 delete $self->{_coro}{$coro+0}; 3111 delete $self->{_coro}{$coro+0};
1741 }); 3112 });
1742 3113
1769our $safe = new Safe "safe"; 3140our $safe = new Safe "safe";
1770our $safe_hole = new Safe::Hole; 3141our $safe_hole = new Safe::Hole;
1771 3142
1772$SIG{FPE} = 'IGNORE'; 3143$SIG{FPE} = 'IGNORE';
1773 3144
1774$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));
1775 3150
1776# here we export the classes and methods available to script code 3151# here we export the classes and methods available to script code
1777 3152
1778=pod 3153=pod
1779 3154
1780The following fucntions and emthods are available within a safe environment: 3155The following functions and methods are available within a safe environment:
1781 3156
1782 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
1783 cf::object::player player 3162 cf::object::player
1784 cf::player peaceful 3163 player
1785 cf::map trigger 3164
3165 cf::player
3166 peaceful
3167
3168 cf::map
3169 trigger
1786 3170
1787=cut 3171=cut
1788 3172
1789for ( 3173for (
1790 ["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)],
1791 ["cf::object::player" => qw(player)], 3177 ["cf::object::player" => qw(player)],
1792 ["cf::player" => qw(peaceful)], 3178 ["cf::player" => qw(peaceful send_msg)],
1793 ["cf::map" => qw(trigger)], 3179 ["cf::map" => qw(trigger)],
1794) { 3180) {
1795 no strict 'refs'; 3181 no strict 'refs';
1796 my ($pkg, @funs) = @$_; 3182 my ($pkg, @funs) = @$_;
1797 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3183 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1815 3201
1816 my $qcode = $code; 3202 my $qcode = $code;
1817 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3203 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1818 $qcode =~ s/\n/\\n/g; 3204 $qcode =~ s/\n/\\n/g;
1819 3205
3206 %vars = (_dummy => 0) unless %vars;
3207
3208 my @res;
1820 local $_; 3209 local $_;
1821 local @safe::cf::_safe_eval_args = values %vars;
1822 3210
1823 my $eval = 3211 my $eval =
1824 "do {\n" 3212 "do {\n"
1825 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3213 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1826 . "#line 0 \"{$qcode}\"\n" 3214 . "#line 0 \"{$qcode}\"\n"
1827 . $code 3215 . $code
1828 . "\n}" 3216 . "\n}"
1829 ; 3217 ;
1830 3218
3219 if ($CFG{safe_eval}) {
1831 sub_generation_inc; 3220 sub_generation_inc;
3221 local @safe::cf::_safe_eval_args = values %vars;
1832 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3222 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1833 sub_generation_inc; 3223 sub_generation_inc;
3224 } else {
3225 local @cf::_safe_eval_args = values %vars;
3226 @res = wantarray ? eval eval : scalar eval $eval;
3227 }
1834 3228
1835 if ($@) { 3229 if ($@) {
1836 warn "$@"; 3230 warn "$@";
1837 warn "while executing safe code '$code'\n"; 3231 warn "while executing safe code '$code'\n";
1838 warn "with arguments " . (join " ", %vars) . "\n"; 3232 warn "with arguments " . (join " ", %vars) . "\n";
1866=back 3260=back
1867 3261
1868=cut 3262=cut
1869 3263
1870############################################################################# 3264#############################################################################
3265# the server's init and main functions
1871 3266
1872=head2 EXTENSION DATABASE SUPPORT 3267sub load_facedata($) {
3268 my ($path) = @_;
1873 3269
1874Crossfire maintains a very simple database for extension use. It can 3270 # HACK to clear player env face cache, we need some signal framework
1875currently store anything that can be serialised using Storable, which 3271 # for this (global event?)
1876excludes objects. 3272 %ext::player_env::MUSIC_FACE_CACHE = ();
1877 3273
1878The parameter C<$family> should best start with the name of the extension 3274 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1879using it, it should be unique.
1880 3275
1881=over 4 3276 warn "loading facedata from $path\n";
1882 3277
1883=item $hashref = cf::db_get $family 3278 my $facedata;
3279 0 < aio_load $path, $facedata
3280 or die "$path: $!";
1884 3281
1885Return a hashref for use by the extension C<$family>, which can be 3282 $facedata = Coro::Storable::thaw $facedata;
1886modified. After modifications, you have to call C<cf::db_dirty> or
1887C<cf::db_sync>.
1888 3283
1889=item $value = cf::db_get $family => $key 3284 $facedata->{version} == 2
3285 or cf::cleanup "$path: version mismatch, cannot proceed.";
1890 3286
1891Returns a single value from the database 3287 # patch in the exptable
1892 3288 $facedata->{resource}{"res/exp_table"} = {
1893=item cf::db_put $family => $hashref 3289 type => FT_RSRC,
1894 3290 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1895Stores the given family hashref into the database. Updates are delayed, if
1896you want the data to be synced to disk immediately, use C<cf::db_sync>.
1897
1898=item cf::db_put $family => $key => $value
1899
1900Stores the given C<$value> in the family hash. Updates are delayed, if you
1901want the data to be synced to disk immediately, use C<cf::db_sync>.
1902
1903=item cf::db_dirty
1904
1905Marks the database as dirty, to be updated at a later time.
1906
1907=item cf::db_sync
1908
1909Immediately write the database to disk I<if it is dirty>.
1910
1911=cut
1912
1913our $DB;
1914
1915{
1916 my $path = cf::localdir . "/database.pst";
1917
1918 sub db_load() {
1919 warn "loading database $path\n";#d# remove later
1920 $DB = stat $path ? Storable::retrieve $path : { };
1921 }
1922
1923 my $pid;
1924
1925 sub db_save() {
1926 warn "saving database $path\n";#d# remove later
1927 waitpid $pid, 0 if $pid;
1928 if (0 == ($pid = fork)) {
1929 $DB->{_meta}{version} = 1;
1930 Storable::nstore $DB, "$path~";
1931 rename "$path~", $path;
1932 cf::_exit 0 if defined $pid;
1933 }
1934 }
1935
1936 my $dirty;
1937
1938 sub db_sync() {
1939 db_save if $dirty;
1940 undef $dirty;
1941 }
1942
1943 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1944 db_sync;
1945 }); 3291 };
3292 cf::cede_to_tick;
1946 3293
1947 sub db_dirty() {
1948 $dirty = 1;
1949 $idle->start;
1950 } 3294 {
3295 my $faces = $facedata->{faceinfo};
1951 3296
1952 sub db_get($;$) { 3297 while (my ($face, $info) = each %$faces) {
1953 @_ >= 2 3298 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1954 ? $DB->{$_[0]}{$_[1]}
1955 : ($DB->{$_[0]} ||= { })
1956 }
1957 3299
1958 sub db_put($$;$) { 3300 cf::face::set_visibility $idx, $info->{visibility};
1959 if (@_ >= 3) { 3301 cf::face::set_magicmap $idx, $info->{magicmap};
1960 $DB->{$_[0]}{$_[1]} = $_[2]; 3302 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
1961 } else { 3303 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
1962 $DB->{$_[0]} = $_[1];
1963 }
1964 db_dirty;
1965 }
1966 3304
1967 cf::global->attach ( 3305 cf::cede_to_tick;
1968 prio => 10000,
1969 on_cleanup => sub {
1970 db_sync;
1971 }, 3306 }
1972 );
1973}
1974 3307
1975############################################################################# 3308 while (my ($face, $info) = each %$faces) {
1976# the server's main() 3309 next unless $info->{smooth};
1977 3310
1978sub cfg_load { 3311 my $idx = cf::face::find $face
3312 or next;
3313
3314 if (my $smooth = cf::face::find $info->{smooth}) {
3315 cf::face::set_smooth $idx, $smooth;
3316 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3317 } else {
3318 warn "smooth face '$info->{smooth}' not found for face '$face'";
3319 }
3320
3321 cf::cede_to_tick;
3322 }
3323 }
3324
3325 {
3326 my $anims = $facedata->{animinfo};
3327
3328 while (my ($anim, $info) = each %$anims) {
3329 cf::anim::set $anim, $info->{frames}, $info->{facings};
3330 cf::cede_to_tick;
3331 }
3332
3333 cf::anim::invalidate_all; # d'oh
3334 }
3335
3336 {
3337 my $res = $facedata->{resource};
3338
3339 while (my ($name, $info) = each %$res) {
3340 if (defined $info->{type}) {
3341 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3342
3343 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3344 cf::face::set_type $idx, $info->{type};
3345 } else {
3346 $RESOURCE{$name} = $info;
3347 }
3348
3349 cf::cede_to_tick;
3350 }
3351 }
3352
3353 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3354
3355 1
3356}
3357
3358cf::global->attach (on_resource_update => sub {
3359 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3360 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3361
3362 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3363 my $sound = $soundconf->{compat}[$_]
3364 or next;
3365
3366 my $face = cf::face::find "sound/$sound->[1]";
3367 cf::sound::set $sound->[0] => $face;
3368 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3369 }
3370
3371 while (my ($k, $v) = each %{$soundconf->{event}}) {
3372 my $face = cf::face::find "sound/$v";
3373 cf::sound::set $k => $face;
3374 }
3375 }
3376});
3377
3378register_exticmd fx_want => sub {
3379 my ($ns, $want) = @_;
3380
3381 while (my ($k, $v) = each %$want) {
3382 $ns->fx_want ($k, $v);
3383 }
3384};
3385
3386sub load_resource_file($) {
3387 my $guard = lock_acquire "load_resource_file";
3388
3389 my $status = load_resource_file_ $_[0];
3390 get_slot 0.1, 100;
3391 cf::arch::commit_load;
3392
3393 $status
3394}
3395
3396sub reload_regions {
3397 # HACK to clear player env face cache, we need some signal framework
3398 # for this (global event?)
3399 %ext::player_env::MUSIC_FACE_CACHE = ();
3400
3401 load_resource_file "$MAPDIR/regions"
3402 or die "unable to load regions file\n";
3403
3404 for (cf::region::list) {
3405 $_->{match} = qr/$_->{match}/
3406 if exists $_->{match};
3407 }
3408}
3409
3410sub reload_facedata {
3411 load_facedata "$DATADIR/facedata"
3412 or die "unable to load facedata\n";
3413}
3414
3415sub reload_archetypes {
3416 load_resource_file "$DATADIR/archetypes"
3417 or die "unable to load archetypes\n";
3418}
3419
3420sub reload_treasures {
3421 load_resource_file "$DATADIR/treasures"
3422 or die "unable to load treasurelists\n";
3423}
3424
3425sub reload_resources {
3426 warn "reloading resource files...\n";
3427
3428 reload_facedata;
3429 reload_archetypes;
3430 reload_regions;
3431 reload_treasures;
3432
3433 warn "finished reloading resource files\n";
3434}
3435
3436sub reload_config {
3437 warn "reloading config file...\n";
3438
1979 open my $fh, "<:utf8", cf::confdir . "/config" 3439 open my $fh, "<:utf8", "$CONFDIR/config"
1980 or return; 3440 or return;
1981 3441
1982 local $/; 3442 local $/;
1983 *CFG = YAML::Syck::Load <$fh>; 3443 *CFG = YAML::XS::Load scalar <$fh>;
3444
3445 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3446
3447 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3448 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3449
3450 if (exists $CFG{mlockall}) {
3451 eval {
3452 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3453 and die "WARNING: m(un)lockall failed: $!\n";
3454 };
3455 warn $@ if $@;
3456 }
3457
3458 warn "finished reloading resource files\n";
3459}
3460
3461sub pidfile() {
3462 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3463 or die "$PIDFILE: $!";
3464 flock $fh, &Fcntl::LOCK_EX
3465 or die "$PIDFILE: flock: $!";
3466 $fh
3467}
3468
3469# make sure only one server instance is running at any one time
3470sub atomic {
3471 my $fh = pidfile;
3472
3473 my $pid = <$fh>;
3474 kill 9, $pid if $pid > 0;
3475
3476 seek $fh, 0, 0;
3477 print $fh $$;
3478}
3479
3480sub main_loop {
3481 warn "EV::loop starting\n";
3482 if (1) {
3483 EV::loop;
3484 }
3485 warn "EV::loop returned\n";
3486 goto &main_loop unless $REALLY_UNLOOP;
1984} 3487}
1985 3488
1986sub main { 3489sub main {
3490 cf::init_globals; # initialise logging
3491
3492 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3493 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3494 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3495 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3496
3497 cf::init_experience;
3498 cf::init_anim;
3499 cf::init_attackmess;
3500 cf::init_dynamic;
3501
3502 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3503
1987 # we must not ever block the main coroutine 3504 # we must not ever block the main coroutine
1988 local $Coro::idle = sub { 3505 local $Coro::idle = sub {
1989 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3506 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1990 (Coro::unblock_sub { 3507 (async {
1991 Event::one_event; 3508 $Coro::current->{desc} = "IDLE BUG HANDLER";
1992 })->(); 3509 EV::loop EV::LOOP_ONESHOT;
3510 })->prio (Coro::PRIO_MAX);
1993 }; 3511 };
1994 3512
1995 cfg_load; 3513 evthread_start IO::AIO::poll_fileno;
1996 db_load; 3514
3515 cf::sync_job {
3516 cf::load_settings;
3517 cf::load_materials;
3518
3519 reload_resources;
3520 reload_config;
3521 db_init;
3522
3523 cf::init_uuid;
3524 cf::init_signals;
3525 cf::init_commands;
3526 cf::init_skills;
3527
3528 cf::init_beforeplay;
3529
3530 atomic;
3531
1997 load_extensions; 3532 load_extensions;
1998 Event::loop; 3533
3534 utime time, time, $RUNTIMEFILE;
3535
3536 # no (long-running) fork's whatsoever before this point(!)
3537 use POSIX ();
3538 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3539
3540 (pop @POST_INIT)->(0) while @POST_INIT;
3541 };
3542
3543 main_loop;
1999} 3544}
2000 3545
2001############################################################################# 3546#############################################################################
2002# initialisation 3547# initialisation and cleanup
2003 3548
3549# install some emergency cleanup handlers
3550BEGIN {
3551 our %SIGWATCHER = ();
3552 for my $signal (qw(INT HUP TERM)) {
3553 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3554 cf::cleanup "SIG$signal";
3555 };
3556 }
3557}
3558
3559sub write_runtime_sync {
3560 # first touch the runtime file to show we are still running:
3561 # the fsync below can take a very very long time.
3562
3563 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3564
3565 my $guard = cf::lock_acquire "write_runtime";
3566
3567 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3568 or return;
3569
3570 my $value = $cf::RUNTIME + 90 + 10;
3571 # 10 is the runtime save interval, for a monotonic clock
3572 # 60 allows for the watchdog to kill the server.
3573
3574 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3575 and return;
3576
3577 # always fsync - this file is important
3578 aio_fsync $fh
3579 and return;
3580
3581 # touch it again to show we are up-to-date
3582 aio_utime $fh, undef, undef;
3583
3584 close $fh
3585 or return;
3586
3587 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3588 and return;
3589
3590 warn "runtime file written.\n";
3591
3592 1
3593}
3594
3595our $uuid_lock;
3596our $uuid_skip;
3597
3598sub write_uuid_sync($) {
3599 $uuid_skip ||= $_[0];
3600
3601 return if $uuid_lock;
3602 local $uuid_lock = 1;
3603
3604 my $uuid = "$LOCALDIR/uuid";
3605
3606 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3607 or return;
3608
3609 my $value = uuid_seq uuid_cur;
3610
3611 unless ($value) {
3612 warn "cowardly refusing to write zero uuid value!\n";
3613 return;
3614 }
3615
3616 my $value = uuid_str $value + $uuid_skip;
3617 $uuid_skip = 0;
3618
3619 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3620 and return;
3621
3622 # always fsync - this file is important
3623 aio_fsync $fh
3624 and return;
3625
3626 close $fh
3627 or return;
3628
3629 aio_rename "$uuid~", $uuid
3630 and return;
3631
3632 warn "uuid file written ($value).\n";
3633
3634 1
3635
3636}
3637
3638sub write_uuid($$) {
3639 my ($skip, $sync) = @_;
3640
3641 $sync ? write_uuid_sync $skip
3642 : async { write_uuid_sync $skip };
3643}
3644
3645sub emergency_save() {
3646 my $freeze_guard = cf::freeze_mainloop;
3647
3648 warn "emergency_perl_save: enter\n";
3649
3650 cf::sync_job {
3651 # this is a trade-off: we want to be very quick here, so
3652 # save all maps without fsync, and later call a global sync
3653 # (which in turn might be very very slow)
3654 local $USE_FSYNC = 0;
3655
3656 # use a peculiar iteration method to avoid tripping on perl
3657 # refcount bugs in for. also avoids problems with players
3658 # and maps saved/destroyed asynchronously.
3659 warn "emergency_perl_save: begin player save\n";
3660 for my $login (keys %cf::PLAYER) {
3661 my $pl = $cf::PLAYER{$login} or next;
3662 $pl->valid or next;
3663 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3664 $pl->save;
3665 }
3666 warn "emergency_perl_save: end player save\n";
3667
3668 warn "emergency_perl_save: begin map save\n";
3669 for my $path (keys %cf::MAP) {
3670 my $map = $cf::MAP{$path} or next;
3671 $map->valid or next;
3672 $map->save;
3673 }
3674 warn "emergency_perl_save: end map save\n";
3675
3676 warn "emergency_perl_save: begin database checkpoint\n";
3677 BDB::db_env_txn_checkpoint $DB_ENV;
3678 warn "emergency_perl_save: end database checkpoint\n";
3679
3680 warn "emergency_perl_save: begin write uuid\n";
3681 write_uuid_sync 1;
3682 warn "emergency_perl_save: end write uuid\n";
3683 };
3684
3685 warn "emergency_perl_save: starting sync()\n";
3686 IO::AIO::aio_sync sub {
3687 warn "emergency_perl_save: finished sync()\n";
3688 };
3689
3690 warn "emergency_perl_save: leave\n";
3691}
3692
3693sub post_cleanup {
3694 my ($make_core) = @_;
3695
3696 warn Carp::longmess "post_cleanup backtrace"
3697 if $make_core;
3698
3699 my $fh = pidfile;
3700 unlink $PIDFILE if <$fh> == $$;
3701}
3702
3703# a safer delete_package, copied from Symbol
3704sub clear_package($) {
3705 my $pkg = shift;
3706
3707 # expand to full symbol table name if needed
3708 unless ($pkg =~ /^main::.*::$/) {
3709 $pkg = "main$pkg" if $pkg =~ /^::/;
3710 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3711 $pkg .= '::' unless $pkg =~ /::$/;
3712 }
3713
3714 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3715 my $stem_symtab = *{$stem}{HASH};
3716
3717 defined $stem_symtab and exists $stem_symtab->{$leaf}
3718 or return;
3719
3720 # clear all symbols
3721 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3722 for my $name (keys %$leaf_symtab) {
3723 _gv_clear *{"$pkg$name"};
3724# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3725 }
3726 warn "cleared package $pkg\n";#d#
3727}
3728
2004sub reload() { 3729sub do_reload_perl() {
2005 # can/must only be called in main 3730 # can/must only be called in main
2006 if ($Coro::current != $Coro::main) { 3731 if ($Coro::current != $Coro::main) {
2007 warn "can only reload from main coroutine\n"; 3732 warn "can only reload from main coroutine";
2008 return; 3733 return;
2009 } 3734 }
2010 3735
3736 return if $RELOAD++;
3737
3738 my $t1 = EV::time;
3739
3740 while ($RELOAD) {
2011 warn "reloading..."; 3741 warn "reloading...";
2012 3742
2013 local $FREEZE = 1; 3743 warn "entering sync_job";
3744
3745 cf::sync_job {
3746 cf::write_runtime_sync; # external watchdog should not bark
2014 cf::emergency_save; 3747 cf::emergency_save;
3748 cf::write_runtime_sync; # external watchdog should not bark
2015 3749
2016 eval { 3750 warn "syncing database to disk";
3751 BDB::db_env_txn_checkpoint $DB_ENV;
3752
2017 # if anything goes wrong in here, we should simply crash as we already saved 3753 # if anything goes wrong in here, we should simply crash as we already saved
2018 3754
2019 # cancel all watchers 3755 warn "flushing outstanding aio requests";
2020 for (Event::all_watchers) { 3756 while (IO::AIO::nreqs || BDB::nreqs) {
2021 $_->cancel if $_->data & WF_AUTOCANCEL; 3757 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2022 }
2023
2024 # cancel all extension coros
2025 $_->cancel for values %EXT_CORO;
2026 %EXT_CORO = ();
2027
2028 # unload all extensions
2029 for (@exts) {
2030 warn "unloading <$_>";
2031 unload_extension $_;
2032 }
2033
2034 # unload all modules loaded from $LIBDIR
2035 while (my ($k, $v) = each %INC) {
2036 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037
2038 warn "removing <$k>";
2039 delete $INC{$k};
2040
2041 $k =~ s/\.pm$//;
2042 $k =~ s/\//::/g;
2043
2044 if (my $cb = $k->can ("unload_module")) {
2045 $cb->();
2046 } 3758 }
2047 3759
2048 Symbol::delete_package $k; 3760 warn "cancelling all extension coros";
3761 $_->cancel for values %EXT_CORO;
3762 %EXT_CORO = ();
3763
3764 warn "removing commands";
3765 %COMMAND = ();
3766
3767 warn "removing ext/exti commands";
3768 %EXTCMD = ();
3769 %EXTICMD = ();
3770
3771 warn "unloading/nuking all extensions";
3772 for my $pkg (@EXTS) {
3773 warn "... unloading $pkg";
3774
3775 if (my $cb = $pkg->can ("unload")) {
3776 eval {
3777 $cb->($pkg);
3778 1
3779 } or warn "$pkg unloaded, but with errors: $@";
3780 }
3781
3782 warn "... clearing $pkg";
3783 clear_package $pkg;
2049 } 3784 }
2050 3785
2051 # sync database to disk 3786 warn "unloading all perl modules loaded from $LIBDIR";
2052 cf::db_sync; 3787 while (my ($k, $v) = each %INC) {
2053 IO::AIO::flush; 3788 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2054 3789
3790 warn "... unloading $k";
3791 delete $INC{$k};
3792
3793 $k =~ s/\.pm$//;
3794 $k =~ s/\//::/g;
3795
3796 if (my $cb = $k->can ("unload_module")) {
3797 $cb->();
3798 }
3799
3800 clear_package $k;
3801 }
3802
2055 # get rid of safe::, as good as possible 3803 warn "getting rid of safe::, as good as possible";
2056 Symbol::delete_package "safe::$_" 3804 clear_package "safe::$_"
2057 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3805 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2058 3806
2059 # remove register_script_function callbacks 3807 warn "unloading cf.pm \"a bit\"";
2060 # TODO
2061
2062 # unload cf.pm "a bit"
2063 delete $INC{"cf.pm"}; 3808 delete $INC{"cf.pm"};
3809 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2064 3810
2065 # don't, removes xs symbols, too, 3811 # don't, removes xs symbols, too,
2066 # and global variables created in xs 3812 # and global variables created in xs
2067 #Symbol::delete_package __PACKAGE__; 3813 #clear_package __PACKAGE__;
2068 3814
2069 # reload cf.pm 3815 warn "unload completed, starting to reload now";
3816
2070 warn "reloading cf.pm"; 3817 warn "reloading cf.pm";
2071 require cf; 3818 require cf;
2072 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3819 cf::_connect_to_perl_1;
2073 3820
2074 # load config and database again 3821 warn "loading config and database again";
2075 cf::cfg_load; 3822 cf::reload_config;
2076 cf::db_load;
2077 3823
2078 # load extensions
2079 warn "load extensions"; 3824 warn "loading extensions";
2080 cf::load_extensions; 3825 cf::load_extensions;
2081 3826
2082 # reattach attachments to objects 3827 if ($REATTACH_ON_RELOAD) {
3828 warn "reattaching attachments to objects/players";
3829 _global_reattach; # objects, sockets
3830 warn "reattaching attachments to maps";
3831 reattach $_ for values %MAP;
3832 warn "reattaching attachments to players";
3833 reattach $_ for values %PLAYER;
3834 }
3835
3836 warn "running post_init jobs";
3837 (pop @POST_INIT)->(1) while @POST_INIT;
3838
3839 warn "leaving sync_job";
3840
3841 1
3842 } or do {
3843 warn $@;
3844 cf::cleanup "error while reloading, exiting.";
3845 };
3846
2083 warn "reattach"; 3847 warn "reloaded";
2084 _global_reattach; 3848 --$RELOAD;
3849 }
3850
3851 $t1 = EV::time - $t1;
3852 warn "reload completed in ${t1}s\n";
3853};
3854
3855our $RELOAD_WATCHER; # used only during reload
3856
3857sub reload_perl() {
3858 # doing reload synchronously and two reloads happen back-to-back,
3859 # coro crashes during coro_state_free->destroy here.
3860
3861 $RELOAD_WATCHER ||= cf::async {
3862 Coro::AIO::aio_wait cache_extensions;
3863
3864 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3865 do_reload_perl;
3866 undef $RELOAD_WATCHER;
3867 };
2085 }; 3868 };
2086
2087 if ($@) {
2088 warn $@;
2089 warn "error while reloading, exiting.";
2090 exit 1;
2091 }
2092
2093 warn "reloaded successfully";
2094};
2095
2096#############################################################################
2097
2098unless ($LINK_MAP) {
2099 $LINK_MAP = cf::map::new;
2100
2101 $LINK_MAP->width (41);
2102 $LINK_MAP->height (41);
2103 $LINK_MAP->alloc;
2104 $LINK_MAP->path ("{link}");
2105 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2106 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2107
2108 # dirty hack because... archetypes are not yet loaded
2109 Event->timer (
2110 after => 2,
2111 cb => sub {
2112 $_[0]->w->cancel;
2113
2114 # provide some exits "home"
2115 my $exit = cf::object::new "exit";
2116
2117 $exit->slaying ($EMERGENCY_POSITION->[0]);
2118 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2119 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2120
2121 $LINK_MAP->insert ($exit->clone, 19, 19);
2122 $LINK_MAP->insert ($exit->clone, 19, 20);
2123 $LINK_MAP->insert ($exit->clone, 19, 21);
2124 $LINK_MAP->insert ($exit->clone, 20, 19);
2125 $LINK_MAP->insert ($exit->clone, 20, 21);
2126 $LINK_MAP->insert ($exit->clone, 21, 19);
2127 $LINK_MAP->insert ($exit->clone, 21, 20);
2128 $LINK_MAP->insert ($exit->clone, 21, 21);
2129
2130 $exit->destroy;
2131 });
2132
2133 $LINK_MAP->{deny_save} = 1;
2134 $LINK_MAP->{deny_reset} = 1;
2135
2136 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137} 3869}
2138
2139register "<global>", __PACKAGE__;
2140 3870
2141register_command "reload" => sub { 3871register_command "reload" => sub {
2142 my ($who, $arg) = @_; 3872 my ($who, $arg) = @_;
2143 3873
2144 if ($who->flag (FLAG_WIZ)) { 3874 if ($who->flag (FLAG_WIZ)) {
2145 $who->message ("start of reload.");
2146 reload;
2147 $who->message ("end of reload."); 3875 $who->message ("reloading server.");
3876 async {
3877 $Coro::current->{desc} = "perl_reload";
3878 reload_perl;
3879 };
2148 } 3880 }
2149}; 3881};
2150 3882
2151unshift @INC, $LIBDIR; 3883unshift @INC, $LIBDIR;
2152 3884
2153$TICK_WATCHER = Event->timer ( 3885my $bug_warning = 0;
2154 reentrant => 0, 3886
2155 prio => 0, 3887our @WAIT_FOR_TICK;
2156 at => $NEXT_TICK || $TICK, 3888our @WAIT_FOR_TICK_BEGIN;
2157 data => WF_AUTOCANCEL, 3889
2158 cb => sub { 3890sub wait_for_tick {
2159 unless ($FREEZE) { 3891 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3892
3893 my $signal = new Coro::Signal;
3894 push @WAIT_FOR_TICK, $signal;
3895 $signal->wait;
3896}
3897
3898sub wait_for_tick_begin {
3899 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3900
3901 my $signal = new Coro::Signal;
3902 push @WAIT_FOR_TICK_BEGIN, $signal;
3903 $signal->wait;
3904}
3905
3906sub tick {
3907 if ($Coro::current != $Coro::main) {
3908 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3909 unless ++$bug_warning > 10;
3910 return;
3911 }
3912
2160 cf::server_tick; # one server iteration 3913 cf::server_tick; # one server iteration
2161 $RUNTIME += $TICK;
2162 }
2163 3914
2164 $NEXT_TICK += $TICK; 3915 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2165 3916 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2166 # if we are delayed by four ticks or more, skip them all 3917 Coro::async_pool {
2167 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3918 $Coro::current->{desc} = "runtime saver";
2168
2169 $TICK_WATCHER->at ($NEXT_TICK);
2170 $TICK_WATCHER->start;
2171 },
2172);
2173
2174IO::AIO::max_poll_time $TICK * 0.2;
2175
2176Event->io (
2177 fd => IO::AIO::poll_fileno,
2178 poll => 'r',
2179 prio => 5,
2180 data => WF_AUTOCANCEL,
2181 cb => \&IO::AIO::poll_cb,
2182);
2183
2184Event->timer (
2185 data => WF_AUTOCANCEL,
2186 after => 0,
2187 interval => 10,
2188 cb => sub {
2189 (Coro::unblock_sub {
2190 write_runtime 3919 write_runtime_sync
2191 or warn "ERROR: unable to write runtime file: $!"; 3920 or warn "ERROR: unable to write runtime file: $!";
2192 })->(); 3921 };
2193 }, 3922 }
2194); 3923
3924 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3925 $sig->send;
3926 }
3927 while (my $sig = shift @WAIT_FOR_TICK) {
3928 $sig->send;
3929 }
3930
3931 $LOAD = ($NOW - $TICK_START) / $TICK;
3932 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3933
3934 if (0) {
3935 if ($NEXT_TICK) {
3936 my $jitter = $TICK_START - $NEXT_TICK;
3937 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3938 warn "jitter $JITTER\n";#d#
3939 }
3940 }
3941}
3942
3943{
3944 # configure BDB
3945
3946 BDB::min_parallel 8;
3947 BDB::max_poll_reqs $TICK * 0.1;
3948 $AnyEvent::BDB::WATCHER->priority (1);
3949
3950 unless ($DB_ENV) {
3951 $DB_ENV = BDB::db_env_create;
3952 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3953 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3954 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3955 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3956 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3957
3958 cf::sync_job {
3959 eval {
3960 BDB::db_env_open
3961 $DB_ENV,
3962 $BDBDIR,
3963 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3964 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3965 0666;
3966
3967 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3968 };
3969
3970 cf::cleanup "db_env_open(db): $@" if $@;
3971 };
3972 }
3973
3974 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3975 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3976 };
3977 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3978 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3979 };
3980 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3981 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3982 };
3983}
3984
3985{
3986 # configure IO::AIO
3987
3988 IO::AIO::min_parallel 8;
3989 IO::AIO::max_poll_time $TICK * 0.1;
3990 undef $AnyEvent::AIO::WATCHER;
3991}
3992
3993my $_log_backtrace;
3994
3995sub _log_backtrace {
3996 my ($msg, @addr) = @_;
3997
3998 $msg =~ s/\n//;
3999
4000 # limit the # of concurrent backtraces
4001 if ($_log_backtrace < 2) {
4002 ++$_log_backtrace;
4003 my $perl_bt = Carp::longmess $msg;
4004 async {
4005 $Coro::current->{desc} = "abt $msg";
4006
4007 my @bt = fork_call {
4008 @addr = map { sprintf "%x", $_ } @addr;
4009 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4010 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4011 or die "addr2line: $!";
4012
4013 my @funcs;
4014 my @res = <$fh>;
4015 chomp for @res;
4016 while (@res) {
4017 my ($func, $line) = splice @res, 0, 2, ();
4018 push @funcs, "[$func] $line";
4019 }
4020
4021 @funcs
4022 };
4023
4024 LOG llevInfo, "[ABT] $perl_bt\n";
4025 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4026 LOG llevInfo, "[ABT] $_\n" for @bt;
4027 --$_log_backtrace;
4028 };
4029 } else {
4030 LOG llevInfo, "[ABT] $msg\n";
4031 LOG llevInfo, "[ABT] [suppressed]\n";
4032 }
4033}
4034
4035# load additional modules
4036require "cf/$_.pm" for @EXTRA_MODULES;
4037cf::_connect_to_perl_2;
4038
4039END { cf::emergency_save }
2195 4040
21961 40411
2197 4042

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines