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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines