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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines