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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines