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.121 by root, Tue Jan 2 11:11:52 2007 UTC vs.
Revision 1.487 by root, Fri Oct 16 01:56:41 2009 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 ();
12 37
38use Guard ();
13use Coro 3.3; 39use Coro ();
40use Coro::State;
41use Coro::Handle;
42use Coro::EV;
14use Coro::Event; 43use Coro::AnyEvent;
15use Coro::Timer; 44use Coro::Timer;
16use Coro::Signal; 45use Coro::Signal;
17use Coro::Semaphore; 46use Coro::Semaphore;
47use Coro::SemaphoreSet;
48use Coro::AnyEvent;
18use Coro::AIO; 49use Coro::AIO;
50use Coro::BDB 1.6;
51use Coro::Storable;
52use Coro::Util ();
19 53
54use JSON::XS 2.01 ();
55use BDB ();
56use Data::Dumper;
20use Digest::MD5; 57use Digest::MD5;
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 warn "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
1216 $map->path ($key);
1217 $map->{path} = $path;
1218 $map->{last_save} = $cf::RUNTIME; 1996 $map->{last_save} = $cf::RUNTIME;
1219 $map->last_access ($cf::RUNTIME);
1220 1997
1221 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;
1222 $map->reset; 2006 $map->reset;
1223 $map = find_map $path; 2007 return find $path;
1224 } 2008 }
1225 2009
1226 $cf::MAP{$key} = $map 2010 $cf::MAP{$path} = $map
1227 } 2011 }
1228} 2012}
2013
2014sub pre_load { }
2015sub post_load { }
1229 2016
1230sub load { 2017sub load {
1231 my ($self) = @_; 2018 my ($self) = @_;
1232 2019
2020 local $self->{deny_reset} = 1; # loading can take a long time
2021
1233 my $path = $self->{path}; 2022 my $path = $self->{path};
2023
2024 {
1234 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2025 my $guard = cf::lock_acquire "map_data:$path";
1235 2026
2027 return unless $self->valid;
1236 return if $self->in_memory != cf::MAP_SWAPPED; 2028 return unless $self->in_memory == cf::MAP_SWAPPED;
1237 2029
1238 $self->in_memory (cf::MAP_LOADING); 2030 $self->in_memory (cf::MAP_LOADING);
1239 2031
1240 $self->alloc; 2032 $self->alloc;
1241 $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)
1242 or return; 2040 or return;
1243 2041
1244 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2042 $self->post_load_original
1245 if delete $self->{load_original}; 2043 if delete $self->{load_original};
1246 2044
1247 if (my $uniq = $path->uniq_path) { 2045 if (my $uniq = $self->uniq_path) {
1248 utf8::encode $uniq; 2046 utf8::encode $uniq;
1249 if (aio_open $uniq, O_RDONLY, 0) { 2047 unless (aio_stat $uniq) {
2048 if (my $f = new_from_file cf::object::thawer $uniq) {
1250 $self->clear_unique_items; 2049 $self->clear_unique_items;
1251 $self->load_objects ($uniq, 0); 2050 $self->_load_objects ($f);
2051 $f->resolve_delayed_derefs;
2052 }
1252 } 2053 }
1253 } 2054 }
1254 2055
2056 $f->resolve_delayed_derefs;
2057
2058 cf::cede_to_tick;
1255 # now do the right thing for maps 2059 # now do the right thing for maps
1256 $self->link_multipart_objects; 2060 $self->link_multipart_objects;
1257
1258 if ($self->{path}->is_style_map) {
1259 $self->{deny_save} = 1;
1260 $self->{deny_reset} = 1;
1261 } else {
1262 $self->fix_auto_apply;
1263 $self->decay_objects;
1264 $self->update_buttons;
1265 $self->set_darkness_map;
1266 $self->difficulty ($self->estimate_difficulty) 2061 $self->difficulty ($self->estimate_difficulty)
1267 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;
1268 $self->activate; 2070 $self->activate;
1269 } 2071 }
1270 2072
2073 $self->{last_save} = $cf::RUNTIME;
2074 $self->last_access ($cf::RUNTIME);
2075
1271 $self->in_memory (cf::MAP_IN_MEMORY); 2076 $self->in_memory (cf::MAP_ACTIVE);
1272} 2077 }
1273 2078
1274sub 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 {
1275 my ($path, $origin) = @_; 2121 my ($path, $origin) = @_;
1276 2122
1277 #warn "load_map_sync<$path, $origin>\n";#d# 2123 cf::sync_job { find $path, $origin }
2124}
1278 2125
1279 cf::sync_job { 2126sub do_load_sync {
1280 my $map = cf::map::find_map $path, $origin 2127 my ($map) = @_;
1281 or return; 2128
1282 $map->load; 2129 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1283 $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;
1284 } 2162 };
2163 $MAP_PREFETCHER->prio (6);
2164
2165 ()
1285} 2166}
1286 2167
1287sub save { 2168sub save {
1288 my ($self) = @_; 2169 my ($self) = @_;
1289 2170
2171 my $lock = cf::lock_acquire "map_data:$self->{path}";
2172
1290 $self->{last_save} = $cf::RUNTIME; 2173 $self->{last_save} = $cf::RUNTIME;
1291 2174
1292 return unless $self->dirty; 2175 return unless $self->dirty;
1293 2176
1294 my $save = $self->{path}->save_path; utf8::encode $save; 2177 my $save = $self->save_path; utf8::encode $save;
1295 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2178 my $uniq = $self->uniq_path; utf8::encode $uniq;
1296 2179
1297 $self->{load_path} = $save; 2180 $self->{load_path} = $save;
1298 2181
1299 return if $self->{deny_save}; 2182 return if $self->{deny_save};
1300 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
1301 if ($uniq) { 2193 if ($uniq) {
1302 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2194 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1303 $self->save_objects ($uniq, cf::IO_UNIQUES); 2195 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1304 } else { 2196 } else {
1305 $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);
1306 } 2198 }
1307} 2199}
1308 2200
1309sub swap_out { 2201sub swap_out {
1310 my ($self) = @_; 2202 my ($self) = @_;
1311 2203
2204 # save first because save cedes
2205 $self->save;
2206
2207 my $lock = cf::lock_acquire "map_data:$self->{path}";
2208
1312 return if $self->players; 2209 return if $self->players;
1313 return if $self->in_memory != cf::MAP_IN_MEMORY; 2210 return if $self->in_memory != cf::MAP_ACTIVE;
1314 return if $self->{deny_save}; 2211 return if $self->{deny_save};
1315 2212
2213 $self->in_memory (cf::MAP_SWAPPED);
2214
1316 $self->save; 2215 $self->deactivate;
2216 $_->clear_links_to ($self) for values %cf::MAP;
1317 $self->clear; 2217 $self->clear;
1318 $self->in_memory (cf::MAP_SWAPPED);
1319} 2218}
1320 2219
1321sub reset_at { 2220sub reset_at {
1322 my ($self) = @_; 2221 my ($self) = @_;
1323 2222
1324 # TODO: safety, remove and allow resettable per-player maps 2223 # TODO: safety, remove and allow resettable per-player maps
1325 return 1e99 if $self->{path}{user_rel};
1326 return 1e99 if $self->{deny_reset}; 2224 return 1e99 if $self->{deny_reset};
1327 2225
1328 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2226 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1329 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;
1330 2228
1335 my ($self) = @_; 2233 my ($self) = @_;
1336 2234
1337 $self->reset_at <= $cf::RUNTIME 2235 $self->reset_at <= $cf::RUNTIME
1338} 2236}
1339 2237
1340sub unlink_save {
1341 my ($self) = @_;
1342
1343 utf8::encode (my $save = $self->{path}->save_path);
1344 aioreq_pri 3; IO::AIO::aio_unlink $save;
1345 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1346}
1347
1348sub rename {
1349 my ($self, $new_path) = @_;
1350
1351 $self->unlink_save;
1352
1353 delete $cf::MAP{$self->path};
1354 $self->{path} = new cf::path $new_path;
1355 $self->path ($self->{path}->as_string);
1356 $cf::MAP{$self->path} = $self;
1357
1358 $self->save;
1359}
1360
1361sub reset { 2238sub reset {
1362 my ($self) = @_; 2239 my ($self) = @_;
1363 2240
2241 my $lock = cf::lock_acquire "map_data:$self->{path}";
2242
1364 return if $self->players; 2243 return if $self->players;
1365 return if $self->{path}{user_rel};#d#
1366 2244
1367 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 }
1368 2256
1369 delete $cf::MAP{$self->path}; 2257 delete $cf::MAP{$self->path};
1370 2258
2259 $self->deactivate;
1371 $_->clear_links_to ($self) for values %cf::MAP; 2260 $_->clear_links_to ($self) for values %cf::MAP;
2261 $self->clear;
1372 2262
1373 $self->unlink_save; 2263 $self->unlink_save;
1374 $self->destroy; 2264 $self->destroy;
1375} 2265}
1376 2266
1377my $nuke_counter = "aaaa"; 2267my $nuke_counter = "aaaa";
1378 2268
1379sub nuke { 2269sub nuke {
1380 my ($self) = @_; 2270 my ($self) = @_;
1381 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};
1382 $self->{deny_save} = 1; 2281 $self->{deny_save} = 1;
1383 $self->reset_timeout (1); 2282 $self->reset_timeout (1);
1384 $self->rename ("{nuke}/" . ($nuke_counter++)); 2283 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2284
2285 $cf::MAP{$self->path} = $self;
2286 }
2287
1385 $self->reset; # polite request, might not happen 2288 $self->reset; # polite request, might not happen
1386} 2289}
1387 2290
1388sub customise_for { 2291=item $maps = cf::map::tmp_maps
1389 my ($map, $ob) = @_;
1390 2292
1391 if ($map->per_player) { 2293Returns an arrayref with all map paths of currently instantiated and saved
1392 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2294maps. May block.
2295
2296=cut
2297
2298sub tmp_maps() {
1393 } 2299 [
1394 2300 map {
1395 $map 2301 utf8::decode $_;
2302 /\.map$/
2303 ? normalise $_
2304 : ()
2305 } @{ aio_readdir $TMPDIR or [] }
2306 ]
1396} 2307}
1397 2308
1398sub emergency_save { 2309=item $maps = cf::map::random_maps
1399 local $cf::FREEZE = 1;
1400 2310
1401 warn "enter emergency map save\n"; 2311Returns an arrayref with all map paths of currently instantiated and saved
2312random maps. May block.
1402 2313
1403 cf::sync_job { 2314=cut
1404 warn "begin emergency map save\n"; 2315
1405 $_->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=back
2347
2348=head3 cf::object
2349
2350=cut
2351
2352package cf::object;
2353
2354=over 4
2355
2356=item $ob->inv_recursive
2357
2358Returns the inventory of the object I<and> their inventories, recursively,
2359but I<not> the object itself.
2360
2361=cut
2362
2363sub inv_recursive_;
2364sub inv_recursive_ {
2365 map { $_, inv_recursive_ $_->inv } @_
2366}
2367
2368sub inv_recursive {
2369 inv_recursive_ inv $_[0]
2370}
2371
2372=item $ref = $ob->ref
2373
2374Creates and returns a persistent reference to an object that can be stored as a string.
2375
2376=item $ob = cf::object::deref ($refstring)
2377
2378returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2379even if the object actually exists. May block.
2380
2381=cut
2382
2383sub deref {
2384 my ($ref) = @_;
2385
2386 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2387 my ($uuid, $name) = ($1, $2);
2388 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2389 or return;
2390 $pl->ob->uuid eq $uuid
2391 or return;
2392
2393 $pl->ob
2394 } else {
2395 warn "$ref: cannot resolve object reference\n";
2396 undef
1406 }; 2397 }
1407
1408 warn "end emergency map save\n";
1409} 2398}
1410 2399
1411package cf; 2400package cf;
1412 2401
1413=back 2402=back
1414
1415 2403
1416=head3 cf::object::player 2404=head3 cf::object::player
1417 2405
1418=over 4 2406=over 4
1419 2407
1422Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2410Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1423can be C<undef>. Does the right thing when the player is currently in a 2411can be C<undef>. Does the right thing when the player is currently in a
1424dialogue with the given NPC character. 2412dialogue with the given NPC character.
1425 2413
1426=cut 2414=cut
2415
2416our $SAY_CHANNEL = {
2417 id => "say",
2418 title => "Map",
2419 reply => "say ",
2420 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2421};
2422
2423our $CHAT_CHANNEL = {
2424 id => "chat",
2425 title => "Chat",
2426 reply => "chat ",
2427 tooltip => "Player chat and shouts, global to the server.",
2428};
1427 2429
1428# rough implementation of a future "reply" method that works 2430# rough implementation of a future "reply" method that works
1429# with dialog boxes. 2431# with dialog boxes.
1430#TODO: the first argument must go, split into a $npc->reply_to ( method 2432#TODO: the first argument must go, split into a $npc->reply_to ( method
1431sub cf::object::player::reply($$$;$) { 2433sub cf::object::player::reply($$$;$) {
1433 2435
1434 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2436 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1435 2437
1436 if ($self->{record_replies}) { 2438 if ($self->{record_replies}) {
1437 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2439 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2440
1438 } else { 2441 } else {
2442 my $pl = $self->contr;
2443
2444 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2445 my $dialog = $pl->{npc_dialog};
2446 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2447
2448 } else {
1439 $msg = $npc->name . " says: $msg" if $npc; 2449 $msg = $npc->name . " says: $msg" if $npc;
1440 $self->message ($msg, $flags); 2450 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2451 }
1441 } 2452 }
2453}
2454
2455=item $object->send_msg ($channel, $msg, $color, [extra...])
2456
2457=cut
2458
2459sub cf::object::send_msg {
2460 my $pl = shift->contr
2461 or return;
2462 $pl->send_msg (@_);
1442} 2463}
1443 2464
1444=item $player_object->may ("access") 2465=item $player_object->may ("access")
1445 2466
1446Returns wether the given player is authorized to access resource "access" 2467Returns wether the given player is authorized to access resource "access"
1459 2480
1460=item $player_object->enter_link 2481=item $player_object->enter_link
1461 2482
1462Freezes the player and moves him/her to a special map (C<{link}>). 2483Freezes the player and moves him/her to a special map (C<{link}>).
1463 2484
1464The player should be reaosnably safe there for short amounts of time. You 2485The player should be reasonably safe there for short amounts of time (e.g.
1465I<MUST> call C<leave_link> as soon as possible, though. 2486for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2487though, as the palyer cannot control the character while it is on the link
2488map.
2489
2490Will never block.
1466 2491
1467=item $player_object->leave_link ($map, $x, $y) 2492=item $player_object->leave_link ($map, $x, $y)
1468 2493
1469Moves the player out of the specila link map onto the given map. If the 2494Moves the player out of the special C<{link}> map onto the specified
1470map is not valid (or omitted), the player will be moved back to the 2495map. If the map is not valid (or omitted), the player will be moved back
1471location he/she was before the call to C<enter_link>, or, if that fails, 2496to the location he/she was before the call to C<enter_link>, or, if that
1472to the emergency map position. 2497fails, to the emergency map position.
1473 2498
1474Might block. 2499Might block.
1475 2500
1476=cut 2501=cut
2502
2503sub link_map {
2504 unless ($LINK_MAP) {
2505 $LINK_MAP = cf::map::find "{link}"
2506 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2507 $LINK_MAP->load;
2508 }
2509
2510 $LINK_MAP
2511}
1477 2512
1478sub cf::object::player::enter_link { 2513sub cf::object::player::enter_link {
1479 my ($self) = @_; 2514 my ($self) = @_;
1480 2515
1481 $self->deactivate_recursive; 2516 $self->deactivate_recursive;
1482 2517
1483 return if $self->map == $LINK_MAP; 2518 return if UNIVERSAL::isa $self->map, "ext::map_link";
1484 2519
1485 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2520 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1486 if $self->map; 2521 if $self->map && $self->map->{path} ne "{link}";
1487 2522
1488 $self->enter_map ($LINK_MAP, 20, 20); 2523 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1489} 2524}
1490 2525
1491sub cf::object::player::leave_link { 2526sub cf::object::player::leave_link {
1492 my ($self, $map, $x, $y) = @_; 2527 my ($self, $map, $x, $y) = @_;
2528
2529 return unless $self->contr->active;
1493 2530
1494 my $link_pos = delete $self->{_link_pos}; 2531 my $link_pos = delete $self->{_link_pos};
1495 2532
1496 unless ($map) { 2533 unless ($map) {
1497 # restore original map position 2534 # restore original map position
1498 ($map, $x, $y) = @{ $link_pos || [] }; 2535 ($map, $x, $y) = @{ $link_pos || [] };
1499 $map = cf::map::find_map $map; 2536 $map = cf::map::find $map;
1500 2537
1501 unless ($map) { 2538 unless ($map) {
1502 ($map, $x, $y) = @$EMERGENCY_POSITION; 2539 ($map, $x, $y) = @$EMERGENCY_POSITION;
1503 $map = cf::map::find_map $map 2540 $map = cf::map::find $map
1504 or die "FATAL: cannot load emergency map\n"; 2541 or die "FATAL: cannot load emergency map\n";
1505 } 2542 }
1506 } 2543 }
1507 2544
1508 ($x, $y) = (-1, -1) 2545 ($x, $y) = (-1, -1)
1511 # use -1 or undef as default coordinates, not 0, 0 2548 # use -1 or undef as default coordinates, not 0, 0
1512 ($x, $y) = ($map->enter_x, $map->enter_y) 2549 ($x, $y) = ($map->enter_x, $map->enter_y)
1513 if $x <=0 && $y <= 0; 2550 if $x <=0 && $y <= 0;
1514 2551
1515 $map->load; 2552 $map->load;
2553 $map->load_neighbours;
1516 2554
2555 return unless $self->contr->active;
2556
2557 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2558 $self->enter_map ($map, $x, $y);
2559
2560 # only activate afterwards, to support waiting in hooks
1517 $self->activate_recursive; 2561 $self->activate_recursive;
1518 $self->enter_map ($map, $x, $y);
1519} 2562}
1520 2563
1521cf::player->attach ( 2564=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1522 on_logout => sub {
1523 my ($pl) = @_;
1524 2565
1525 # abort map switching before logout 2566Moves the player to the given map-path and coordinates by first freezing
1526 if ($pl->ob->{_link_pos}) { 2567her, loading and preparing them map, calling the provided $check callback
1527 cf::sync_job { 2568that has to return the map if sucecssful, and then unfreezes the player on
1528 $pl->ob->leave_link 2569the new (success) or old (failed) map position. In either case, $done will
1529 }; 2570be called at the end of this process.
1530 }
1531 },
1532 on_login => sub {
1533 my ($pl) = @_;
1534 2571
1535 # try to abort aborted map switching on player login :) 2572Note that $check will be called with a potentially non-loaded map, so if
1536 # should happen only on crashes 2573it needs a loaded map it has to call C<< ->load >>.
1537 if ($pl->ob->{_link_pos}) {
1538 $pl->ob->enter_link;
1539 Coro::async {
1540 # we need this sleep as the login has a concurrent enter_exit running
1541 # and this sleep increases chances of the player not ending up in scorn
1542 Coro::Timer::sleep 1;
1543 $pl->ob->leave_link;
1544 };
1545 }
1546 },
1547);
1548 2574
1549=item $player_object->goto_map ($path, $x, $y)
1550
1551=cut 2575=cut
1552 2576
2577our $GOTOGEN;
2578
1553sub cf::object::player::goto_map { 2579sub cf::object::player::goto {
1554 my ($self, $path, $x, $y) = @_; 2580 my ($self, $path, $x, $y, $check, $done) = @_;
2581
2582 # do generation counting so two concurrent goto's will be executed in-order
2583 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1555 2584
1556 $self->enter_link; 2585 $self->enter_link;
1557 2586
1558 (Coro::async { 2587 (async {
1559 $path = new cf::path $path; 2588 $Coro::current->{desc} = "player::goto $path $x $y";
1560 2589
1561 my $map = cf::map::find_map $path->as_string; 2590 # *tag paths override both path and x|y
2591 if ($path =~ /^\*(.*)$/) {
2592 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2593 my $ob = $obs[rand @obs];
2594
2595 # see if we actually can go there
2596 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2597 $ob = $obs[rand @obs];
2598 } else {
2599 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2600 }
2601 # else put us there anyways for now #d#
2602
2603 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2604 } else {
2605 ($path, $x, $y) = (undef, undef, undef);
2606 }
2607 }
2608
2609 my $map = eval {
2610 my $map = defined $path ? cf::map::find $path : undef;
2611
2612 if ($map) {
1562 $map = $map->customise_for ($self) if $map; 2613 $map = $map->customise_for ($self);
1563 2614 $map = $check->($map) if $check && $map;
1564# warn "entering ", $map->path, " at ($x, $y)\n" 2615 } else {
1565# if $map;
1566
1567 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2616 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2617 }
1568 2618
2619 $map
2620 };
2621
2622 if ($@) {
2623 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2624 LOG llevError | logBacktrace, Carp::longmess $@;
2625 }
2626
2627 if ($gen == $self->{_goto_generation}) {
2628 delete $self->{_goto_generation};
1569 $self->leave_link ($map, $x, $y); 2629 $self->leave_link ($map, $x, $y);
2630 }
2631
2632 $done->() if $done;
1570 })->prio (1); 2633 })->prio (1);
1571} 2634}
1572 2635
1573=item $player_object->enter_exit ($exit_object) 2636=item $player_object->enter_exit ($exit_object)
1574 2637
1576 2639
1577sub parse_random_map_params { 2640sub parse_random_map_params {
1578 my ($spec) = @_; 2641 my ($spec) = @_;
1579 2642
1580 my $rmp = { # defaults 2643 my $rmp = { # defaults
1581 xsize => 10, 2644 xsize => (cf::rndm 15, 40),
1582 ysize => 10, 2645 ysize => (cf::rndm 15, 40),
2646 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2647 #layout => string,
1583 }; 2648 };
1584 2649
1585 for (split /\n/, $spec) { 2650 for (split /\n/, $spec) {
1586 my ($k, $v) = split /\s+/, $_, 2; 2651 my ($k, $v) = split /\s+/, $_, 2;
1587 2652
1599 # that depends on the exit object 2664 # that depends on the exit object
1600 2665
1601 my $rmp = parse_random_map_params $exit->msg; 2666 my $rmp = parse_random_map_params $exit->msg;
1602 2667
1603 if ($exit->map) { 2668 if ($exit->map) {
1604 $rmp->{region} = $exit->map->region_name; 2669 $rmp->{region} = $exit->region->name;
1605 $rmp->{origin_map} = $exit->map->path; 2670 $rmp->{origin_map} = $exit->map->path;
1606 $rmp->{origin_x} = $exit->x; 2671 $rmp->{origin_x} = $exit->x;
1607 $rmp->{origin_y} = $exit->y; 2672 $rmp->{origin_y} = $exit->y;
2673
2674 $exit->map->touch;
1608 } 2675 }
1609 2676
1610 $rmp->{random_seed} ||= $exit->random_seed; 2677 $rmp->{random_seed} ||= $exit->random_seed;
1611 2678
1612 my $data = cf::to_json $rmp; 2679 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1613 my $md5 = Digest::MD5::md5_hex $data; 2680 my $md5 = Digest::MD5::md5_hex $data;
2681 my $meta = "$RANDOMDIR/$md5.meta";
1614 2682
1615 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2683 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1616 aio_write $fh, 0, (length $data), $data, 0; 2684 aio_write $fh, 0, (length $data), $data, 0;
2685 undef $fh;
2686 aio_rename "$meta~", $meta;
1617 2687
2688 my $slaying = "?random/$md5";
2689
2690 if ($exit->valid) {
1618 $exit->slaying ("?random/$md5"); 2691 $exit->slaying ("?random/$md5");
1619 $exit->msg (undef); 2692 $exit->msg (undef);
2693 }
1620 } 2694 }
1621} 2695}
1622 2696
1623sub cf::object::player::enter_exit { 2697sub cf::object::player::enter_exit {
1624 my ($self, $exit) = @_; 2698 my ($self, $exit) = @_;
1625 2699
1626 return unless $self->type == cf::PLAYER; 2700 return unless $self->type == cf::PLAYER;
1627 2701
1628 $self->enter_link; 2702 $self->enter_link;
1629 2703
1630 (Coro::async { 2704 (async {
2705 $Coro::current->{desc} = "enter_exit";
2706
1631 unless (eval { 2707 unless (eval {
2708 $self->deactivate_recursive; # just to be sure
1632 2709
2710 # random map handling
2711 {
2712 my $guard = cf::lock_acquire "exit_prepare:$exit";
2713
1633 prepare_random_map $exit 2714 prepare_random_map $exit
1634 if $exit->slaying eq "/!"; 2715 if $exit->slaying eq "/!";
2716 }
1635 2717
1636 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2718 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1637 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp); 2719 my $x = $exit->stats->hp;
2720 my $y = $exit->stats->sp;
1638 2721
2722 $self->goto ($map, $x, $y);
2723
2724 # if exit is damned, update players death & WoR home-position
2725 $self->contr->savebed ($map, $x, $y)
2726 if $exit->flag (cf::FLAG_DAMNED);
2727
1639 1; 2728 1
1640 }) { 2729 }) {
1641 $self->message ("Something went wrong deep within the crossfire server. " 2730 $self->message ("Something went wrong deep within the deliantra server. "
1642 . "I'll try to bring you back to the map you were before. " 2731 . "I'll try to bring you back to the map you were before. "
1643 . "Please report this to the dungeon master", 2732 . "Please report this to the dungeon master!",
1644 cf::NDI_UNIQUE | cf::NDI_RED); 2733 cf::NDI_UNIQUE | cf::NDI_RED);
1645 2734
1646 warn "ERROR in enter_exit: $@"; 2735 warn "ERROR in enter_exit: $@";
1647 $self->leave_link; 2736 $self->leave_link;
1648 } 2737 }
1649 })->prio (1); 2738 })->prio (1);
1662 2751
1663sub cf::client::send_drawinfo { 2752sub cf::client::send_drawinfo {
1664 my ($self, $text, $flags) = @_; 2753 my ($self, $text, $flags) = @_;
1665 2754
1666 utf8::encode $text; 2755 utf8::encode $text;
1667 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2756 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1668} 2757}
1669 2758
2759=item $client->send_msg ($channel, $msg, $color, [extra...])
2760
2761Send a drawinfo or msg packet to the client, formatting the msg for the
2762client if neccessary. C<$type> should be a string identifying the type of
2763the message, with C<log> being the default. If C<$color> is negative, suppress
2764the message unless the client supports the msg packet.
2765
2766=cut
2767
2768# non-persistent channels (usually the info channel)
2769our %CHANNEL = (
2770 "c/motd" => {
2771 id => "infobox",
2772 title => "MOTD",
2773 reply => undef,
2774 tooltip => "The message of the day",
2775 },
2776 "c/identify" => {
2777 id => "infobox",
2778 title => "Identify",
2779 reply => undef,
2780 tooltip => "Items recently identified",
2781 },
2782 "c/examine" => {
2783 id => "infobox",
2784 title => "Examine",
2785 reply => undef,
2786 tooltip => "Signs and other items you examined",
2787 },
2788 "c/shopinfo" => {
2789 id => "infobox",
2790 title => "Shop Info",
2791 reply => undef,
2792 tooltip => "What your bargaining skill tells you about the shop",
2793 },
2794 "c/book" => {
2795 id => "infobox",
2796 title => "Book",
2797 reply => undef,
2798 tooltip => "The contents of a note or book",
2799 },
2800 "c/lookat" => {
2801 id => "infobox",
2802 title => "Look",
2803 reply => undef,
2804 tooltip => "What you saw there",
2805 },
2806 "c/who" => {
2807 id => "infobox",
2808 title => "Players",
2809 reply => undef,
2810 tooltip => "Shows players who are currently online",
2811 },
2812 "c/body" => {
2813 id => "infobox",
2814 title => "Body Parts",
2815 reply => undef,
2816 tooltip => "Shows which body parts you posess and are available",
2817 },
2818 "c/statistics" => {
2819 id => "infobox",
2820 title => "Statistics",
2821 reply => undef,
2822 tooltip => "Shows your primary statistics",
2823 },
2824 "c/skills" => {
2825 id => "infobox",
2826 title => "Skills",
2827 reply => undef,
2828 tooltip => "Shows your experience per skill and item power",
2829 },
2830 "c/shopitems" => {
2831 id => "infobox",
2832 title => "Shop Items",
2833 reply => undef,
2834 tooltip => "Shows the items currently for sale in this shop",
2835 },
2836 "c/resistances" => {
2837 id => "infobox",
2838 title => "Resistances",
2839 reply => undef,
2840 tooltip => "Shows your resistances",
2841 },
2842 "c/pets" => {
2843 id => "infobox",
2844 title => "Pets",
2845 reply => undef,
2846 tooltip => "Shows information abotu your pets/a specific pet",
2847 },
2848 "c/perceiveself" => {
2849 id => "infobox",
2850 title => "Perceive Self",
2851 reply => undef,
2852 tooltip => "You gained detailed knowledge about yourself",
2853 },
2854 "c/uptime" => {
2855 id => "infobox",
2856 title => "Uptime",
2857 reply => undef,
2858 tooltip => "How long the server has been running since last restart",
2859 },
2860 "c/mapinfo" => {
2861 id => "infobox",
2862 title => "Map Info",
2863 reply => undef,
2864 tooltip => "Information related to the maps",
2865 },
2866 "c/party" => {
2867 id => "party",
2868 title => "Party",
2869 reply => "gsay ",
2870 tooltip => "Messages and chat related to your party",
2871 },
2872 "c/death" => {
2873 id => "death",
2874 title => "Death",
2875 reply => undef,
2876 tooltip => "Reason for and more info about your most recent death",
2877 },
2878 "c/say" => $SAY_CHANNEL,
2879 "c/chat" => $CHAT_CHANNEL,
2880);
2881
2882sub cf::client::send_msg {
2883 my ($self, $channel, $msg, $color, @extra) = @_;
2884
2885 $msg = $self->pl->expand_cfpod ($msg)
2886 unless $color & cf::NDI_VERBATIM;
2887
2888 $color &= cf::NDI_CLIENT_MASK; # just in case...
2889
2890 # check predefined channels, for the benefit of C
2891 if ($CHANNEL{$channel}) {
2892 $channel = $CHANNEL{$channel};
2893
2894 $self->ext_msg (channel_info => $channel);
2895 $channel = $channel->{id};
2896
2897 } elsif (ref $channel) {
2898 # send meta info to client, if not yet sent
2899 unless (exists $self->{channel}{$channel->{id}}) {
2900 $self->{channel}{$channel->{id}} = $channel;
2901 $self->ext_msg (channel_info => $channel);
2902 }
2903
2904 $channel = $channel->{id};
2905 }
2906
2907 return unless @extra || length $msg;
2908
2909 # default colour, mask it out
2910 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2911 if $color & cf::NDI_DEF;
2912
2913 my $pkt = "msg "
2914 . $self->{json_coder}->encode (
2915 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2916 );
2917
2918 # try lzf for large packets
2919 $pkt = "lzf " . Compress::LZF::compress $pkt
2920 if 1024 <= length $pkt and $self->{can_lzf};
2921
2922 # split very large packets
2923 if (8192 < length $pkt and $self->{can_lzf}) {
2924 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2925 $pkt = "frag";
2926 }
2927
2928 $self->send_packet ($pkt);
2929}
2930
2931=item $client->ext_msg ($type, @msg)
2932
2933Sends an ext event to the client.
2934
2935=cut
2936
2937sub cf::client::ext_msg($$@) {
2938 my ($self, $type, @msg) = @_;
2939
2940 if ($self->extcmd == 2) {
2941 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2942 } elsif ($self->extcmd == 1) { # TODO: remove
2943 push @msg, msgtype => "event_$type";
2944 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2945 }
2946}
2947
2948=item $client->ext_reply ($msgid, @msg)
2949
2950Sends an ext reply to the client.
2951
2952=cut
2953
2954sub cf::client::ext_reply($$@) {
2955 my ($self, $id, @msg) = @_;
2956
2957 if ($self->extcmd == 2) {
2958 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2959 } elsif ($self->extcmd == 1) {
2960 #TODO: version 1, remove
2961 unshift @msg, msgtype => "reply", msgid => $id;
2962 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2963 }
2964}
1670 2965
1671=item $success = $client->query ($flags, "text", \&cb) 2966=item $success = $client->query ($flags, "text", \&cb)
1672 2967
1673Queues a query to the client, calling the given callback with 2968Queues a query to the client, calling the given callback with
1674the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2969the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1675C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2970C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1676 2971
1677Queries can fail, so check the return code. Or don't, as queries will become 2972Queries can fail, so check the return code. Or don't, as queries will
1678reliable at some point in the future. 2973become reliable at some point in the future.
1679 2974
1680=cut 2975=cut
1681 2976
1682sub cf::client::query { 2977sub cf::client::query {
1683 my ($self, $flags, $text, $cb) = @_; 2978 my ($self, $flags, $text, $cb) = @_;
1691 utf8::encode $text; 2986 utf8::encode $text;
1692 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2987 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1693 2988
1694 $self->send_packet ($self->{query_queue}[0][0]) 2989 $self->send_packet ($self->{query_queue}[0][0])
1695 if @{ $self->{query_queue} } == 1; 2990 if @{ $self->{query_queue} } == 1;
2991
2992 1
1696} 2993}
1697 2994
1698cf::client->attach ( 2995cf::client->attach (
2996 on_connect => sub {
2997 my ($ns) = @_;
2998
2999 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3000 },
1699 on_reply => sub { 3001 on_reply => sub {
1700 my ($ns, $msg) = @_; 3002 my ($ns, $msg) = @_;
1701 3003
1702 # this weird shuffling is so that direct followup queries 3004 # this weird shuffling is so that direct followup queries
1703 # get handled first 3005 # get handled first
1704 my $queue = delete $ns->{query_queue}; 3006 my $queue = delete $ns->{query_queue}
3007 or return; # be conservative, not sure how that can happen, but we saw a crash here
1705 3008
1706 (shift @$queue)->[1]->($msg); 3009 (shift @$queue)->[1]->($msg);
3010 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1707 3011
1708 push @{ $ns->{query_queue} }, @$queue; 3012 push @{ $ns->{query_queue} }, @$queue;
1709 3013
1710 if (@{ $ns->{query_queue} } == @$queue) { 3014 if (@{ $ns->{query_queue} } == @$queue) {
1711 if (@$queue) { 3015 if (@$queue) {
1713 } else { 3017 } else {
1714 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3018 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1715 } 3019 }
1716 } 3020 }
1717 }, 3021 },
3022 on_exticmd => sub {
3023 my ($ns, $buf) = @_;
3024
3025 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3026
3027 if (ref $msg) {
3028 my ($type, $reply, @payload) =
3029 "ARRAY" eq ref $msg
3030 ? @$msg
3031 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3032
3033 my @reply;
3034
3035 if (my $cb = $EXTICMD{$type}) {
3036 @reply = $cb->($ns, @payload);
3037 }
3038
3039 $ns->ext_reply ($reply, @reply)
3040 if $reply;
3041
3042 } else {
3043 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3044 }
3045
3046 cf::override;
3047 },
1718); 3048);
1719 3049
1720=item $client->coro (\&cb) 3050=item $client->async (\&cb)
1721 3051
1722Create a new coroutine, running the specified callback. The coroutine will 3052Create a new coroutine, running the specified callback. The coroutine will
1723be automatically cancelled when the client gets destroyed (e.g. on logout, 3053be automatically cancelled when the client gets destroyed (e.g. on logout,
1724or loss of connection). 3054or loss of connection).
1725 3055
1726=cut 3056=cut
1727 3057
1728sub cf::client::coro { 3058sub cf::client::async {
1729 my ($self, $cb) = @_; 3059 my ($self, $cb) = @_;
1730 3060
1731 my $coro; $coro = async { 3061 my $coro = &Coro::async ($cb);
1732 eval {
1733 $cb->();
1734 };
1735 warn $@ if $@;
1736 };
1737 3062
1738 $coro->on_destroy (sub { 3063 $coro->on_destroy (sub {
1739 delete $self->{_coro}{$coro+0}; 3064 delete $self->{_coro}{$coro+0};
1740 }); 3065 });
1741 3066
1768our $safe = new Safe "safe"; 3093our $safe = new Safe "safe";
1769our $safe_hole = new Safe::Hole; 3094our $safe_hole = new Safe::Hole;
1770 3095
1771$SIG{FPE} = 'IGNORE'; 3096$SIG{FPE} = 'IGNORE';
1772 3097
1773$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3098$safe->permit_only (Opcode::opset qw(
3099 :base_core :base_mem :base_orig :base_math
3100 grepstart grepwhile mapstart mapwhile
3101 sort time
3102));
1774 3103
1775# here we export the classes and methods available to script code 3104# here we export the classes and methods available to script code
1776 3105
1777=pod 3106=pod
1778 3107
1779The following fucntions and emthods are available within a safe environment: 3108The following functions and methods are available within a safe environment:
1780 3109
1781 cf::object contr pay_amount pay_player map 3110 cf::object
3111 contr pay_amount pay_player map x y force_find force_add destroy
3112 insert remove name archname title slaying race decrease split
3113 value
3114
1782 cf::object::player player 3115 cf::object::player
1783 cf::player peaceful 3116 player
1784 cf::map trigger 3117
3118 cf::player
3119 peaceful
3120
3121 cf::map
3122 trigger
1785 3123
1786=cut 3124=cut
1787 3125
1788for ( 3126for (
1789 ["cf::object" => qw(contr pay_amount pay_player map)], 3127 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3128 insert remove inv nrof name archname title slaying race
3129 decrease split destroy change_exp value msg lore send_msg)],
1790 ["cf::object::player" => qw(player)], 3130 ["cf::object::player" => qw(player)],
1791 ["cf::player" => qw(peaceful)], 3131 ["cf::player" => qw(peaceful send_msg)],
1792 ["cf::map" => qw(trigger)], 3132 ["cf::map" => qw(trigger)],
1793) { 3133) {
1794 no strict 'refs'; 3134 no strict 'refs';
1795 my ($pkg, @funs) = @$_; 3135 my ($pkg, @funs) = @$_;
1796 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3136 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1813 my ($code, %vars) = @_; 3153 my ($code, %vars) = @_;
1814 3154
1815 my $qcode = $code; 3155 my $qcode = $code;
1816 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3156 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1817 $qcode =~ s/\n/\\n/g; 3157 $qcode =~ s/\n/\\n/g;
3158
3159 %vars = (_dummy => 0) unless %vars;
1818 3160
1819 local $_; 3161 local $_;
1820 local @safe::cf::_safe_eval_args = values %vars; 3162 local @safe::cf::_safe_eval_args = values %vars;
1821 3163
1822 my $eval = 3164 my $eval =
1865=back 3207=back
1866 3208
1867=cut 3209=cut
1868 3210
1869############################################################################# 3211#############################################################################
3212# the server's init and main functions
1870 3213
1871=head2 EXTENSION DATABASE SUPPORT 3214sub load_facedata($) {
3215 my ($path) = @_;
1872 3216
1873Crossfire maintains a very simple database for extension use. It can 3217 # HACK to clear player env face cache, we need some signal framework
1874currently store anything that can be serialised using Storable, which 3218 # for this (global event?)
1875excludes objects. 3219 %ext::player_env::MUSIC_FACE_CACHE = ();
1876 3220
1877The parameter C<$family> should best start with the name of the extension 3221 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1878using it, it should be unique.
1879 3222
1880=over 4 3223 warn "loading facedata from $path\n";
1881 3224
1882=item $hashref = cf::db_get $family 3225 my $facedata;
3226 0 < aio_load $path, $facedata
3227 or die "$path: $!";
1883 3228
1884Return a hashref for use by the extension C<$family>, which can be 3229 $facedata = Coro::Storable::thaw $facedata;
1885modified. After modifications, you have to call C<cf::db_dirty> or
1886C<cf::db_sync>.
1887 3230
1888=item $value = cf::db_get $family => $key 3231 $facedata->{version} == 2
3232 or cf::cleanup "$path: version mismatch, cannot proceed.";
1889 3233
1890Returns a single value from the database 3234 # patch in the exptable
1891 3235 $facedata->{resource}{"res/exp_table"} = {
1892=item cf::db_put $family => $hashref 3236 type => FT_RSRC,
1893 3237 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1894Stores the given family hashref into the database. Updates are delayed, if
1895you want the data to be synced to disk immediately, use C<cf::db_sync>.
1896
1897=item cf::db_put $family => $key => $value
1898
1899Stores the given C<$value> in the family hash. Updates are delayed, if you
1900want the data to be synced to disk immediately, use C<cf::db_sync>.
1901
1902=item cf::db_dirty
1903
1904Marks the database as dirty, to be updated at a later time.
1905
1906=item cf::db_sync
1907
1908Immediately write the database to disk I<if it is dirty>.
1909
1910=cut
1911
1912our $DB;
1913
1914{
1915 my $path = cf::localdir . "/database.pst";
1916
1917 sub db_load() {
1918 $DB = stat $path ? Storable::retrieve $path : { };
1919 }
1920
1921 my $pid;
1922
1923 sub db_save() {
1924 waitpid $pid, 0 if $pid;
1925 if (0 == ($pid = fork)) {
1926 $DB->{_meta}{version} = 1;
1927 Storable::nstore $DB, "$path~";
1928 rename "$path~", $path;
1929 cf::_exit 0 if defined $pid;
1930 }
1931 }
1932
1933 my $dirty;
1934
1935 sub db_sync() {
1936 db_save if $dirty;
1937 undef $dirty;
1938 }
1939
1940 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1941 db_sync;
1942 }); 3238 };
3239 cf::cede_to_tick;
1943 3240
1944 sub db_dirty() {
1945 $dirty = 1;
1946 $idle->start;
1947 } 3241 {
3242 my $faces = $facedata->{faceinfo};
1948 3243
1949 sub db_get($;$) { 3244 while (my ($face, $info) = each %$faces) {
1950 @_ >= 2 3245 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1951 ? $DB->{$_[0]}{$_[1]}
1952 : ($DB->{$_[0]} ||= { })
1953 }
1954 3246
1955 sub db_put($$;$) { 3247 cf::face::set_visibility $idx, $info->{visibility};
1956 if (@_ >= 3) { 3248 cf::face::set_magicmap $idx, $info->{magicmap};
1957 $DB->{$_[0]}{$_[1]} = $_[2]; 3249 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1958 } else { 3250 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1959 $DB->{$_[0]} = $_[1];
1960 }
1961 db_dirty;
1962 }
1963 3251
1964 cf::global->attach ( 3252 cf::cede_to_tick;
1965 prio => 10000,
1966 on_cleanup => sub {
1967 db_sync;
1968 }, 3253 }
1969 );
1970}
1971 3254
1972############################################################################# 3255 while (my ($face, $info) = each %$faces) {
1973# the server's main() 3256 next unless $info->{smooth};
1974 3257
1975sub cfg_load { 3258 my $idx = cf::face::find $face
3259 or next;
3260
3261 if (my $smooth = cf::face::find $info->{smooth}) {
3262 cf::face::set_smooth $idx, $smooth;
3263 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3264 } else {
3265 warn "smooth face '$info->{smooth}' not found for face '$face'";
3266 }
3267
3268 cf::cede_to_tick;
3269 }
3270 }
3271
3272 {
3273 my $anims = $facedata->{animinfo};
3274
3275 while (my ($anim, $info) = each %$anims) {
3276 cf::anim::set $anim, $info->{frames}, $info->{facings};
3277 cf::cede_to_tick;
3278 }
3279
3280 cf::anim::invalidate_all; # d'oh
3281 }
3282
3283 {
3284 # TODO: for gcfclient pleasure, we should give resources
3285 # that gcfclient doesn't grok a >10000 face index.
3286 my $res = $facedata->{resource};
3287
3288 while (my ($name, $info) = each %$res) {
3289 if (defined $info->{type}) {
3290 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3291 my $data;
3292
3293 if ($info->{type} & 1) {
3294 # prepend meta info
3295
3296 my $meta = $enc->encode ({
3297 name => $name,
3298 %{ $info->{meta} || {} },
3299 });
3300
3301 $data = pack "(w/a*)*", $meta, $info->{data};
3302 } else {
3303 $data = $info->{data};
3304 }
3305
3306 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3307 cf::face::set_type $idx, $info->{type};
3308 } else {
3309 $RESOURCE{$name} = $info;
3310 }
3311
3312 cf::cede_to_tick;
3313 }
3314 }
3315
3316 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3317
3318 1
3319}
3320
3321cf::global->attach (on_resource_update => sub {
3322 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3323 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3324
3325 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3326 my $sound = $soundconf->{compat}[$_]
3327 or next;
3328
3329 my $face = cf::face::find "sound/$sound->[1]";
3330 cf::sound::set $sound->[0] => $face;
3331 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3332 }
3333
3334 while (my ($k, $v) = each %{$soundconf->{event}}) {
3335 my $face = cf::face::find "sound/$v";
3336 cf::sound::set $k => $face;
3337 }
3338 }
3339});
3340
3341register_exticmd fx_want => sub {
3342 my ($ns, $want) = @_;
3343
3344 while (my ($k, $v) = each %$want) {
3345 $ns->fx_want ($k, $v);
3346 }
3347};
3348
3349sub load_resource_file($) {
3350 my $guard = lock_acquire "load_resource_file";
3351
3352 my $status = load_resource_file_ $_[0];
3353 get_slot 0.1, 100;
3354 cf::arch::commit_load;
3355
3356 $status
3357}
3358
3359sub reload_regions {
3360 # HACK to clear player env face cache, we need some signal framework
3361 # for this (global event?)
3362 %ext::player_env::MUSIC_FACE_CACHE = ();
3363
3364 load_resource_file "$MAPDIR/regions"
3365 or die "unable to load regions file\n";
3366
3367 for (cf::region::list) {
3368 $_->{match} = qr/$_->{match}/
3369 if exists $_->{match};
3370 }
3371}
3372
3373sub reload_facedata {
3374 load_facedata "$DATADIR/facedata"
3375 or die "unable to load facedata\n";
3376}
3377
3378sub reload_archetypes {
3379 load_resource_file "$DATADIR/archetypes"
3380 or die "unable to load archetypes\n";
3381}
3382
3383sub reload_treasures {
3384 load_resource_file "$DATADIR/treasures"
3385 or die "unable to load treasurelists\n";
3386}
3387
3388sub reload_resources {
3389 warn "reloading resource files...\n";
3390
3391 reload_facedata;
3392 reload_archetypes;
3393 reload_regions;
3394 reload_treasures;
3395
3396 warn "finished reloading resource files\n";
3397}
3398
3399sub reload_config {
3400 warn "reloading config file...\n";
3401
1976 open my $fh, "<:utf8", cf::confdir . "/config" 3402 open my $fh, "<:utf8", "$CONFDIR/config"
1977 or return; 3403 or return;
1978 3404
1979 local $/; 3405 local $/;
1980 *CFG = YAML::Syck::Load <$fh>; 3406 *CFG = YAML::XS::Load scalar <$fh>;
3407
3408 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3409
3410 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3411 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3412
3413 if (exists $CFG{mlockall}) {
3414 eval {
3415 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3416 and die "WARNING: m(un)lockall failed: $!\n";
3417 };
3418 warn $@ if $@;
3419 }
3420
3421 warn "finished reloading resource files\n";
3422}
3423
3424sub pidfile() {
3425 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3426 or die "$PIDFILE: $!";
3427 flock $fh, &Fcntl::LOCK_EX
3428 or die "$PIDFILE: flock: $!";
3429 $fh
3430}
3431
3432# make sure only one server instance is running at any one time
3433sub atomic {
3434 my $fh = pidfile;
3435
3436 my $pid = <$fh>;
3437 kill 9, $pid if $pid > 0;
3438
3439 seek $fh, 0, 0;
3440 print $fh $$;
3441}
3442
3443sub main_loop {
3444 warn "EV::loop starting\n";
3445 if (1) {
3446 EV::loop;
3447 }
3448 warn "EV::loop returned\n";
3449 goto &main_loop unless $REALLY_UNLOOP;
1981} 3450}
1982 3451
1983sub main { 3452sub main {
3453 cf::init_globals; # initialise logging
3454
3455 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3456 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3457 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3458 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3459
3460 cf::init_experience;
3461 cf::init_anim;
3462 cf::init_attackmess;
3463 cf::init_dynamic;
3464
3465 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3466
1984 # we must not ever block the main coroutine 3467 # we must not ever block the main coroutine
1985 local $Coro::idle = sub { 3468 local $Coro::idle = sub {
1986 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3469 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1987 (Coro::unblock_sub { 3470 (async {
1988 Event::one_event; 3471 $Coro::current->{desc} = "IDLE BUG HANDLER";
1989 })->(); 3472 EV::loop EV::LOOP_ONESHOT;
3473 })->prio (Coro::PRIO_MAX);
1990 }; 3474 };
1991 3475
1992 cfg_load; 3476 evthread_start IO::AIO::poll_fileno;
1993 db_load; 3477
3478 cf::sync_job {
3479 reload_resources;
3480 reload_config;
3481 db_init;
3482
3483 cf::load_settings;
3484 cf::load_materials;
3485 cf::init_uuid;
3486 cf::init_signals;
3487 cf::init_commands;
3488 cf::init_skills;
3489
3490 cf::init_beforeplay;
3491
3492 atomic;
3493
1994 load_extensions; 3494 load_extensions;
1995 Event::loop; 3495
3496 utime time, time, $RUNTIMEFILE;
3497
3498 # no (long-running) fork's whatsoever before this point(!)
3499 use POSIX ();
3500 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3501
3502 (pop @POST_INIT)->(0) while @POST_INIT;
3503 };
3504
3505 main_loop;
1996} 3506}
1997 3507
1998############################################################################# 3508#############################################################################
1999# initialisation 3509# initialisation and cleanup
2000 3510
3511# install some emergency cleanup handlers
3512BEGIN {
3513 our %SIGWATCHER = ();
3514 for my $signal (qw(INT HUP TERM)) {
3515 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3516 cf::cleanup "SIG$signal";
3517 };
3518 }
3519}
3520
3521sub write_runtime_sync {
3522 # first touch the runtime file to show we are still running:
3523 # the fsync below can take a very very long time.
3524
3525 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3526
3527 my $guard = cf::lock_acquire "write_runtime";
3528
3529 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3530 or return;
3531
3532 my $value = $cf::RUNTIME + 90 + 10;
3533 # 10 is the runtime save interval, for a monotonic clock
3534 # 60 allows for the watchdog to kill the server.
3535
3536 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3537 and return;
3538
3539 # always fsync - this file is important
3540 aio_fsync $fh
3541 and return;
3542
3543 # touch it again to show we are up-to-date
3544 aio_utime $fh, undef, undef;
3545
3546 close $fh
3547 or return;
3548
3549 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3550 and return;
3551
3552 warn "runtime file written.\n";
3553
3554 1
3555}
3556
3557our $uuid_lock;
3558our $uuid_skip;
3559
3560sub write_uuid_sync($) {
3561 $uuid_skip ||= $_[0];
3562
3563 return if $uuid_lock;
3564 local $uuid_lock = 1;
3565
3566 my $uuid = "$LOCALDIR/uuid";
3567
3568 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3569 or return;
3570
3571 my $value = uuid_seq uuid_cur;
3572
3573 unless ($value) {
3574 warn "cowardly refusing to write zero uuid value!\n";
3575 return;
3576 }
3577
3578 my $value = uuid_str $value + $uuid_skip;
3579 $uuid_skip = 0;
3580
3581 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3582 and return;
3583
3584 # always fsync - this file is important
3585 aio_fsync $fh
3586 and return;
3587
3588 close $fh
3589 or return;
3590
3591 aio_rename "$uuid~", $uuid
3592 and return;
3593
3594 warn "uuid file written ($value).\n";
3595
3596 1
3597
3598}
3599
3600sub write_uuid($$) {
3601 my ($skip, $sync) = @_;
3602
3603 $sync ? write_uuid_sync $skip
3604 : async { write_uuid_sync $skip };
3605}
3606
3607sub emergency_save() {
3608 my $freeze_guard = cf::freeze_mainloop;
3609
3610 warn "emergency_perl_save: enter\n";
3611
3612 cf::sync_job {
3613 # this is a trade-off: we want to be very quick here, so
3614 # save all maps without fsync, and later call a global sync
3615 # (which in turn might be very very slow)
3616 local $USE_FSYNC = 0;
3617
3618 # use a peculiar iteration method to avoid tripping on perl
3619 # refcount bugs in for. also avoids problems with players
3620 # and maps saved/destroyed asynchronously.
3621 warn "emergency_perl_save: begin player save\n";
3622 for my $login (keys %cf::PLAYER) {
3623 my $pl = $cf::PLAYER{$login} or next;
3624 $pl->valid or next;
3625 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3626 $pl->save;
3627 }
3628 warn "emergency_perl_save: end player save\n";
3629
3630 warn "emergency_perl_save: begin map save\n";
3631 for my $path (keys %cf::MAP) {
3632 my $map = $cf::MAP{$path} or next;
3633 $map->valid or next;
3634 $map->save;
3635 }
3636 warn "emergency_perl_save: end map save\n";
3637
3638 warn "emergency_perl_save: begin database checkpoint\n";
3639 BDB::db_env_txn_checkpoint $DB_ENV;
3640 warn "emergency_perl_save: end database checkpoint\n";
3641
3642 warn "emergency_perl_save: begin write uuid\n";
3643 write_uuid_sync 1;
3644 warn "emergency_perl_save: end write uuid\n";
3645 };
3646
3647 warn "emergency_perl_save: starting sync()\n";
3648 IO::AIO::aio_sync sub {
3649 warn "emergency_perl_save: finished sync()\n";
3650 };
3651
3652 warn "emergency_perl_save: leave\n";
3653}
3654
3655sub post_cleanup {
3656 my ($make_core) = @_;
3657
3658 warn Carp::longmess "post_cleanup backtrace"
3659 if $make_core;
3660
3661 my $fh = pidfile;
3662 unlink $PIDFILE if <$fh> == $$;
3663}
3664
3665# a safer delete_package, copied from Symbol
3666sub clear_package($) {
3667 my $pkg = shift;
3668
3669 # expand to full symbol table name if needed
3670 unless ($pkg =~ /^main::.*::$/) {
3671 $pkg = "main$pkg" if $pkg =~ /^::/;
3672 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3673 $pkg .= '::' unless $pkg =~ /::$/;
3674 }
3675
3676 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3677 my $stem_symtab = *{$stem}{HASH};
3678
3679 defined $stem_symtab and exists $stem_symtab->{$leaf}
3680 or return;
3681
3682 # clear all symbols
3683 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3684 for my $name (keys %$leaf_symtab) {
3685 _gv_clear *{"$pkg$name"};
3686# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3687 }
3688 warn "cleared package $pkg\n";#d#
3689}
3690
2001sub reload() { 3691sub do_reload_perl() {
2002 # can/must only be called in main 3692 # can/must only be called in main
2003 if ($Coro::current != $Coro::main) { 3693 if ($Coro::current != $Coro::main) {
2004 warn "can only reload from main coroutine\n"; 3694 warn "can only reload from main coroutine";
2005 return; 3695 return;
2006 } 3696 }
2007 3697
3698 return if $RELOAD++;
3699
3700 my $t1 = EV::time;
3701
3702 while ($RELOAD) {
2008 warn "reloading..."; 3703 warn "reloading...";
2009 3704
2010 local $FREEZE = 1; 3705 warn "entering sync_job";
3706
3707 cf::sync_job {
3708 cf::write_runtime_sync; # external watchdog should not bark
2011 cf::emergency_save; 3709 cf::emergency_save;
3710 cf::write_runtime_sync; # external watchdog should not bark
2012 3711
2013 eval { 3712 warn "syncing database to disk";
3713 BDB::db_env_txn_checkpoint $DB_ENV;
3714
2014 # if anything goes wrong in here, we should simply crash as we already saved 3715 # if anything goes wrong in here, we should simply crash as we already saved
2015 3716
2016 # cancel all watchers 3717 warn "flushing outstanding aio requests";
2017 for (Event::all_watchers) { 3718 while (IO::AIO::nreqs || BDB::nreqs) {
2018 $_->cancel if $_->data & WF_AUTOCANCEL; 3719 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2019 }
2020
2021 # cancel all extension coros
2022 $_->cancel for values %EXT_CORO;
2023 %EXT_CORO = ();
2024
2025 # unload all extensions
2026 for (@exts) {
2027 warn "unloading <$_>";
2028 unload_extension $_;
2029 }
2030
2031 # unload all modules loaded from $LIBDIR
2032 while (my ($k, $v) = each %INC) {
2033 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2034
2035 warn "removing <$k>";
2036 delete $INC{$k};
2037
2038 $k =~ s/\.pm$//;
2039 $k =~ s/\//::/g;
2040
2041 if (my $cb = $k->can ("unload_module")) {
2042 $cb->();
2043 } 3720 }
2044 3721
2045 Symbol::delete_package $k; 3722 warn "cancelling all extension coros";
3723 $_->cancel for values %EXT_CORO;
3724 %EXT_CORO = ();
3725
3726 warn "removing commands";
3727 %COMMAND = ();
3728
3729 warn "removing ext/exti commands";
3730 %EXTCMD = ();
3731 %EXTICMD = ();
3732
3733 warn "unloading/nuking all extensions";
3734 for my $pkg (@EXTS) {
3735 warn "... unloading $pkg";
3736
3737 if (my $cb = $pkg->can ("unload")) {
3738 eval {
3739 $cb->($pkg);
3740 1
3741 } or warn "$pkg unloaded, but with errors: $@";
3742 }
3743
3744 warn "... clearing $pkg";
3745 clear_package $pkg;
2046 } 3746 }
2047 3747
2048 # sync database to disk 3748 warn "unloading all perl modules loaded from $LIBDIR";
2049 cf::db_sync; 3749 while (my ($k, $v) = each %INC) {
2050 IO::AIO::flush; 3750 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2051 3751
3752 warn "... unloading $k";
3753 delete $INC{$k};
3754
3755 $k =~ s/\.pm$//;
3756 $k =~ s/\//::/g;
3757
3758 if (my $cb = $k->can ("unload_module")) {
3759 $cb->();
3760 }
3761
3762 clear_package $k;
3763 }
3764
2052 # get rid of safe::, as good as possible 3765 warn "getting rid of safe::, as good as possible";
2053 Symbol::delete_package "safe::$_" 3766 clear_package "safe::$_"
2054 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3767 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2055 3768
2056 # remove register_script_function callbacks 3769 warn "unloading cf.pm \"a bit\"";
2057 # TODO
2058
2059 # unload cf.pm "a bit"
2060 delete $INC{"cf.pm"}; 3770 delete $INC{"cf.pm"};
3771 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2061 3772
2062 # don't, removes xs symbols, too, 3773 # don't, removes xs symbols, too,
2063 # and global variables created in xs 3774 # and global variables created in xs
2064 #Symbol::delete_package __PACKAGE__; 3775 #clear_package __PACKAGE__;
2065 3776
2066 # reload cf.pm 3777 warn "unload completed, starting to reload now";
3778
2067 warn "reloading cf.pm"; 3779 warn "reloading cf.pm";
2068 require cf; 3780 require cf;
2069 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3781 cf::_connect_to_perl_1;
2070 3782
2071 # load config and database again 3783 warn "loading config and database again";
2072 cf::cfg_load; 3784 cf::reload_config;
2073 cf::db_load;
2074 3785
2075 # load extensions
2076 warn "load extensions"; 3786 warn "loading extensions";
2077 cf::load_extensions; 3787 cf::load_extensions;
2078 3788
2079 # reattach attachments to objects 3789 if ($REATTACH_ON_RELOAD) {
3790 warn "reattaching attachments to objects/players";
3791 _global_reattach; # objects, sockets
3792 warn "reattaching attachments to maps";
3793 reattach $_ for values %MAP;
3794 warn "reattaching attachments to players";
3795 reattach $_ for values %PLAYER;
3796 }
3797
3798 warn "running post_init jobs";
3799 (pop @POST_INIT)->(1) while @POST_INIT;
3800
3801 warn "leaving sync_job";
3802
3803 1
3804 } or do {
3805 warn $@;
3806 cf::cleanup "error while reloading, exiting.";
3807 };
3808
2080 warn "reattach"; 3809 warn "reloaded";
2081 _global_reattach; 3810 --$RELOAD;
3811 }
3812
3813 $t1 = EV::time - $t1;
3814 warn "reload completed in ${t1}s\n";
3815};
3816
3817our $RELOAD_WATCHER; # used only during reload
3818
3819sub reload_perl() {
3820 # doing reload synchronously and two reloads happen back-to-back,
3821 # coro crashes during coro_state_free->destroy here.
3822
3823 $RELOAD_WATCHER ||= cf::async {
3824 Coro::AIO::aio_wait cache_extensions;
3825
3826 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3827 do_reload_perl;
3828 undef $RELOAD_WATCHER;
3829 };
2082 }; 3830 };
2083
2084 if ($@) {
2085 warn $@;
2086 warn "error while reloading, exiting.";
2087 exit 1;
2088 }
2089
2090 warn "reloaded successfully";
2091};
2092
2093#############################################################################
2094
2095unless ($LINK_MAP) {
2096 $LINK_MAP = cf::map::new;
2097
2098 $LINK_MAP->width (41);
2099 $LINK_MAP->height (41);
2100 $LINK_MAP->alloc;
2101 $LINK_MAP->path ("{link}");
2102 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2103 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2104
2105 # dirty hack because... archetypes are not yet loaded
2106 Event->timer (
2107 after => 2,
2108 cb => sub {
2109 $_[0]->w->cancel;
2110
2111 # provide some exits "home"
2112 my $exit = cf::object::new "exit";
2113
2114 $exit->slaying ($EMERGENCY_POSITION->[0]);
2115 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2116 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2117
2118 $LINK_MAP->insert ($exit->clone, 19, 19);
2119 $LINK_MAP->insert ($exit->clone, 19, 20);
2120 $LINK_MAP->insert ($exit->clone, 19, 21);
2121 $LINK_MAP->insert ($exit->clone, 20, 19);
2122 $LINK_MAP->insert ($exit->clone, 20, 21);
2123 $LINK_MAP->insert ($exit->clone, 21, 19);
2124 $LINK_MAP->insert ($exit->clone, 21, 20);
2125 $LINK_MAP->insert ($exit->clone, 21, 21);
2126
2127 $exit->destroy;
2128 });
2129
2130 $LINK_MAP->{deny_save} = 1;
2131 $LINK_MAP->{deny_reset} = 1;
2132
2133 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2134} 3831}
2135
2136register "<global>", __PACKAGE__;
2137 3832
2138register_command "reload" => sub { 3833register_command "reload" => sub {
2139 my ($who, $arg) = @_; 3834 my ($who, $arg) = @_;
2140 3835
2141 if ($who->flag (FLAG_WIZ)) { 3836 if ($who->flag (FLAG_WIZ)) {
2142 $who->message ("start of reload.");
2143 reload;
2144 $who->message ("end of reload."); 3837 $who->message ("reloading server.");
3838 async {
3839 $Coro::current->{desc} = "perl_reload";
3840 reload_perl;
3841 };
2145 } 3842 }
2146}; 3843};
2147 3844
2148unshift @INC, $LIBDIR; 3845unshift @INC, $LIBDIR;
2149 3846
2150$TICK_WATCHER = Event->timer ( 3847my $bug_warning = 0;
2151 reentrant => 0, 3848
2152 prio => 0, 3849our @WAIT_FOR_TICK;
2153 at => $NEXT_TICK || $TICK, 3850our @WAIT_FOR_TICK_BEGIN;
2154 data => WF_AUTOCANCEL, 3851
2155 cb => sub { 3852sub wait_for_tick {
2156 unless ($FREEZE) { 3853 return if tick_inhibit || $Coro::current == $Coro::main;
3854
3855 my $signal = new Coro::Signal;
3856 push @WAIT_FOR_TICK, $signal;
3857 $signal->wait;
3858}
3859
3860sub wait_for_tick_begin {
3861 return if tick_inhibit || $Coro::current == $Coro::main;
3862
3863 my $signal = new Coro::Signal;
3864 push @WAIT_FOR_TICK_BEGIN, $signal;
3865 $signal->wait;
3866}
3867
3868sub tick {
3869 if ($Coro::current != $Coro::main) {
3870 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3871 unless ++$bug_warning > 10;
3872 return;
3873 }
3874
2157 cf::server_tick; # one server iteration 3875 cf::server_tick; # one server iteration
2158 $RUNTIME += $TICK;
2159 }
2160 3876
2161 $NEXT_TICK += $TICK; 3877 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2162 3878 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2163 # if we are delayed by four ticks or more, skip them all 3879 Coro::async_pool {
2164 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3880 $Coro::current->{desc} = "runtime saver";
2165
2166 $TICK_WATCHER->at ($NEXT_TICK);
2167 $TICK_WATCHER->start;
2168 },
2169);
2170
2171IO::AIO::max_poll_time $TICK * 0.2;
2172
2173Event->io (
2174 fd => IO::AIO::poll_fileno,
2175 poll => 'r',
2176 prio => 5,
2177 data => WF_AUTOCANCEL,
2178 cb => \&IO::AIO::poll_cb,
2179);
2180
2181Event->timer (
2182 data => WF_AUTOCANCEL,
2183 after => 0,
2184 interval => 10,
2185 cb => sub {
2186 (Coro::unblock_sub {
2187 write_runtime 3881 write_runtime_sync
2188 or warn "ERROR: unable to write runtime file: $!"; 3882 or warn "ERROR: unable to write runtime file: $!";
2189 })->(); 3883 };
2190 }, 3884 }
2191); 3885
3886 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3887 $sig->send;
3888 }
3889 while (my $sig = shift @WAIT_FOR_TICK) {
3890 $sig->send;
3891 }
3892
3893 $LOAD = ($NOW - $TICK_START) / $TICK;
3894 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3895
3896 if (0) {
3897 if ($NEXT_TICK) {
3898 my $jitter = $TICK_START - $NEXT_TICK;
3899 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3900 warn "jitter $JITTER\n";#d#
3901 }
3902 }
3903}
3904
3905{
3906 # configure BDB
3907
3908 BDB::min_parallel 8;
3909 BDB::max_poll_reqs $TICK * 0.1;
3910 $AnyEvent::BDB::WATCHER->priority (1);
3911
3912 unless ($DB_ENV) {
3913 $DB_ENV = BDB::db_env_create;
3914 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3915 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3916 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3917 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3918 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3919
3920 cf::sync_job {
3921 eval {
3922 BDB::db_env_open
3923 $DB_ENV,
3924 $BDBDIR,
3925 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3926 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3927 0666;
3928
3929 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3930 };
3931
3932 cf::cleanup "db_env_open(db): $@" if $@;
3933 };
3934 }
3935
3936 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3937 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3938 };
3939 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3940 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3941 };
3942 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3943 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3944 };
3945}
3946
3947{
3948 # configure IO::AIO
3949
3950 IO::AIO::min_parallel 8;
3951 IO::AIO::max_poll_time $TICK * 0.1;
3952 undef $AnyEvent::AIO::WATCHER;
3953}
3954
3955my $_log_backtrace;
3956
3957sub _log_backtrace {
3958 my ($msg, @addr) = @_;
3959
3960 $msg =~ s/\n//;
3961
3962 # limit the # of concurrent backtraces
3963 if ($_log_backtrace < 2) {
3964 ++$_log_backtrace;
3965 my $perl_bt = Carp::longmess $msg;
3966 async {
3967 $Coro::current->{desc} = "abt $msg";
3968
3969 my @bt = fork_call {
3970 @addr = map { sprintf "%x", $_ } @addr;
3971 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3972 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3973 or die "addr2line: $!";
3974
3975 my @funcs;
3976 my @res = <$fh>;
3977 chomp for @res;
3978 while (@res) {
3979 my ($func, $line) = splice @res, 0, 2, ();
3980 push @funcs, "[$func] $line";
3981 }
3982
3983 @funcs
3984 };
3985
3986 LOG llevInfo, "[ABT] $perl_bt\n";
3987 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3988 LOG llevInfo, "[ABT] $_\n" for @bt;
3989 --$_log_backtrace;
3990 };
3991 } else {
3992 LOG llevInfo, "[ABT] $msg\n";
3993 LOG llevInfo, "[ABT] [suppressed]\n";
3994 }
3995}
3996
3997# load additional modules
3998require "cf/$_.pm" for @EXTRA_MODULES;
3999cf::_connect_to_perl_2;
4000
4001END { cf::emergency_save }
2192 4002
21931 40031
2194 4004

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines